@crowi/api 2.0.0-alpha.0 → 2.0.0-alpha.1

package/dist/hono/handlers/adminCrypto.d.ts

@@ -6,18 +6,13 @@ export declare const registerAdminCryptoRoutes: <E extends OpenAPIHono<CrowiHono
         $get: {
             input: {};
             output: {
-                encryptionConfigured: boolean;
-                unencryptedCount: number;
-                encryptedCount: number;
-                entries: {
-                    ns: string;
-                    key: string;
-                    present: boolean;
-                    encrypted: boolean;
-                }[];
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
             };
             outputFormat: "json";
-            status: 200;
+            status: 500;
         } | {
             input: {};
             output: {
@@ -32,24 +27,29 @@ export declare const registerAdminCryptoRoutes: <E extends OpenAPIHono<CrowiHono
         } | {
             input: {};
             output: {
-                error: {
-                    code: "ADMIN_REQUIRED";
-                    message: "Admin permission required";
-                    redirectTo?: string | undefined;
-                };
+                encryptionConfigured: boolean;
+                unencryptedCount: number;
+                encryptedCount: number;
+                entries: {
+                    ns: string;
+                    key: string;
+                    present: boolean;
+                    encrypted: boolean;
+                }[];
             };
             outputFormat: "json";
-            status: 403;
+            status: 200;
         } | {
             input: {};
             output: {
                 error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
                 };
             };
             outputFormat: "json";
-            status: 500;
+            status: 403;
         };
     };
 } & {
@@ -57,12 +57,13 @@ export declare const registerAdminCryptoRoutes: <E extends OpenAPIHono<CrowiHono
         $post: {
             input: {};
             output: {
-                rewritten: number;
-                alreadyEncrypted: number;
-                missing: number;
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
             };
             outputFormat: "json";
-            status: 200;
+            status: 500;
         } | {
             input: {};
             output: {
@@ -77,24 +78,23 @@ export declare const registerAdminCryptoRoutes: <E extends OpenAPIHono<CrowiHono
         } | {
             input: {};
             output: {
-                error: {
-                    code: "ADMIN_REQUIRED";
-                    message: "Admin permission required";
-                    redirectTo?: string | undefined;
-                };
+                rewritten: number;
+                alreadyEncrypted: number;
+                missing: number;
             };
             outputFormat: "json";
-            status: 403;
+            status: 200;
         } | {
             input: {};
             output: {
                 error: {
-                    code: "INTERNAL_ERROR";
-                    message: "Internal server error";
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
                 };
             };
             outputFormat: "json";
-            status: 500;
+            status: 403;
         } | {
             input: {};
             output: {

package/dist/hono/handlers/app.d.ts

@@ -4,14 +4,6 @@ import type { CrowiHonoBindings } from '../app';
 export declare const registerAppRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
     "/app/info": {
         $get: {
-            input: {};
-            output: {
-                title: string | null;
-                confidential: string | null;
-            };
-            outputFormat: "json";
-            status: 200;
-        } | {
             input: {};
             output: {
                 error: {
@@ -21,6 +13,17 @@ export declare const registerAppRoutes: <E extends OpenAPIHono<CrowiHonoBindings
             };
             outputFormat: "json";
             status: 500;
+        } | {
+            input: {};
+            output: {
+                title: string | null;
+                confidential: string | null;
+                version: string;
+                apiVersion: string;
+                capabilities: string[];
+            };
+            outputFormat: "json";
+            status: 200;
         };
     };
 }, "/">;

package/dist/hono/handlers/app.js

@@ -16,6 +16,27 @@ exports.registerAppRoutes = void 0;
  * §11).
  */
 const api_contract_1 = require("@crowi/api-contract");
+/**
+ * Build the coarse capability list advertised at `GET /app/info`. Static
+ * always-on subsystems plus cheap, in-memory dynamic probes:
+ *   - `search` when a search driver is active (`getSearcher() !== null`);
+ *     otherwise `GET /search` returns 503 and the CLI can pre-empt it.
+ *   - `collab` always (Hocuspocus is library-attached unconditionally);
+ *     `collab:redis` additionally when `REDIS_URL` is set so multi-instance
+ *     pub/sub is wired up.
+ * No I/O — both probes read state already held on the Crowi instance.
+ */
+const buildCapabilities = (crowi) => {
+    const capabilities = [...api_contract_1.STATIC_CAPABILITIES];
+    if (crowi.getSearcher() != null) {
+        capabilities.push('search');
+    }
+    capabilities.push('collab');
+    if (crowi.redis != null) {
+        capabilities.push('collab:redis');
+    }
+    return capabilities;
+};
 const registerAppRoutes = (app, crowi) => app.openapi(api_contract_1.getAppInfoRoute, (c) => {
     const config = crowi.getConfig();
     const raw = config?.crowi?.['app:title'];
@@ -28,7 +49,16 @@ const registerAppRoutes = (app, crowi) => app.openapi(api_contract_1.getAppInfoR
     // Empty/missing collapses to null (banner hidden).
     const confidentialRaw = config?.crowi?.['app:confidential'];
     const confidential = confidentialRaw ? confidentialRaw : null;
-    return c.json({ title, confidential }, 200);
+    // Version-skew / feature-detection signal for the @crowi/cli end-user
+    // CLI (and any other client). `crowi.version` is the @crowi/api
+    // package.json version read at boot.
+    return c.json({
+        title,
+        confidential,
+        version: crowi.version,
+        apiVersion: api_contract_1.API_SURFACE_VERSION,
+        capabilities: buildCapabilities(crowi),
+    }, 200);
 });
 exports.registerAppRoutes = registerAppRoutes;
 //# sourceMappingURL=app.js.map

package/dist/hono/handlers/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../../../src/hono/handlers/app.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;GAaG;AACH,sDAAsD;AAO/C,MAAM,iBAAiB,GAAG,CAA2C,GAAM,EAAE,KAAY,EAAE,EAAE,CAClG,GAAG,CAAC,OAAO,CAAC,8BAAe,EAAE,CAAC,CAAC,EAAE,EAAE;IACjC,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC,WAAW,CAAuB,CAAC;IAC/D,kEAAkE;IAClE,oEAAoE;IACpE,4DAA4D;IAC5D,MAAM,KAAK,GAAG,GAAG,IAAI,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;IAClD,kEAAkE;IAClE,qEAAqE;IACrE,mDAAmD;IACnD,MAAM,eAAe,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC,kBAAkB,CAAuB,CAAC;IAClF,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9D,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,GAAG,CAAC,CAAC;AAC9C,CAAC,CAAC,CAAC;AAdQ,QAAA,iBAAiB,qBAczB"}
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../../src/hono/handlers/app.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;GAaG;AACH,sDAAgG;AAOhG;;;;;;;;;GASG;AACH,MAAM,iBAAiB,GAAG,CAAC,KAAY,EAAY,EAAE;IACnD,MAAM,YAAY,GAAa,CAAC,GAAG,kCAAmB,CAAC,CAAC;IACxD,IAAI,KAAK,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC;QAChC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IACD,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5B,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;QACxB,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEK,MAAM,iBAAiB,GAAG,CAA2C,GAAM,EAAE,KAAY,EAAE,EAAE,CAClG,GAAG,CAAC,OAAO,CAAC,8BAAe,EAAE,CAAC,CAAC,EAAE,EAAE;IACjC,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IACjC,MAAM,GAAG,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC,WAAW,CAAuB,CAAC;IAC/D,kEAAkE;IAClE,oEAAoE;IACpE,4DAA4D;IAC5D,MAAM,KAAK,GAAG,GAAG,IAAI,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;IAClD,kEAAkE;IAClE,qEAAqE;IACrE,mDAAmD;IACnD,MAAM,eAAe,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC,kBAAkB,CAAuB,CAAC;IAClF,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9D,sEAAsE;IACtE,gEAAgE;IAChE,qCAAqC;IACrC,OAAO,CAAC,CAAC,IAAI,CACX;QACE,KAAK;QACL,YAAY;QACZ,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,UAAU,EAAE,kCAAmB;QAC/B,YAAY,EAAE,iBAAiB,CAAC,KAAK,CAAC;KACvC,EACD,GAAG,CACJ,CAAC;AACJ,CAAC,CAAC,CAAC;AA1BQ,QAAA,iBAAiB,qBA0BzB"}