@crowi/api 2.0.0-alpha.0

package/dist/hono/handlers/admin/mail.d.ts

@@ -0,0 +1,168 @@
+import type { OpenAPIHono } from '@hono/zod-openapi';
+import type Crowi from '../../../crowi';
+import type { CrowiHonoBindings } from '../../app';
+export declare const registerAdminMailRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
+    "/admin/mail": {
+        $get: {
+            input: {};
+            output: {
+                from: string;
+                activeDriver: string;
+                activePlugin: string;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {};
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {};
+            output: {
+                error: {
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 403;
+        };
+    };
+} & {
+    "/admin/mail": {
+        $put: {
+            input: {
+                json: {
+                    from?: string | undefined;
+                };
+            };
+            output: {
+                ok: true;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: {
+                    from?: string | undefined;
+                };
+            };
+            output: {
+                bodyResult: {
+                    issues: {
+                        path: (string | number)[];
+                        message: string;
+                    }[];
+                    name?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                json: {
+                    from?: string | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                json: {
+                    from?: string | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 403;
+        };
+    };
+} & {
+    "/admin/mail/test": {
+        $post: {
+            input: {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                ok: true;
+                to: string;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                bodyResult: {
+                    issues: {
+                        path: (string | number)[];
+                        message: string;
+                    }[];
+                    name?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 400;
+        } | {
+            input: {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "MAIL_TEST_FAILED";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 502;
+        };
+    };
+}, "/">;

package/dist/hono/handlers/admin/mail.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerAdminMailRoutes = void 0;
+/**
+ * `admin.mail` resource — sender-independent mail settings.
+ *
+ * Email transport is plugin-based: each sender (`@crowi/plugin-mail-smtp`,
+ * `-resend`, `-aws-ses`) registers a driver and is selected by
+ * `crowi.config.json:mail.driver`. Per-sender credentials are edited
+ * under `/admin/plugins`. This resource only owns the sender-independent
+ * `from` address plus a read-only view of which sender is active.
+ *
+ *   GET  /admin/mail        — read `from` + active sender driver name
+ *   PUT  /admin/mail        — update `from`
+ *   POST /admin/mail/test   — send a test mail to the calling admin via
+ *                             the active sender
+ *
+ * Auth:
+ *   - Admin-only via `createJwtAdminRequired(crowi)` on `/admin/mail/*`
+ *     plus the bare `/admin/mail` path.
+ */
+const api_contract_1 = require("@crowi/api-contract");
+const debug_1 = __importDefault(require("debug"));
+const admin_config_1 = require("../../../util/admin-config");
+const admin_1 = require("../../middleware/admin");
+const debug = (0, debug_1.default)('crowi:hono:handlers:admin:mail');
+const KEY_FROM = 'mail:from';
+/** Resolve the registered driver + plugin name of the active mail sender. */
+const resolveActiveSender = (crowi) => {
+    const plugins = crowi.getPlugins();
+    const active = plugins.active.mail;
+    const entry = active ? plugins.mail.entryOf(active) : undefined;
+    return { driver: entry?.driverName ?? '', plugin: entry?.plugin ?? '' };
+};
+const registerAdminMailRoutes = (app, crowi) => {
+    app.use('/admin/mail/*', (0, admin_1.createJwtAdminRequired)(crowi));
+    app.use('/admin/mail', (0, admin_1.createJwtAdminRequired)(crowi));
+    return app
+        .openapi(api_contract_1.adminMailRoutes.getMailSettingsRoute, async (c) => {
+        const ns = (0, admin_config_1.getCrowiConfigNamespace)(crowi);
+        const active = resolveActiveSender(crowi);
+        return c.json({
+            from: (0, admin_config_1.coerceString)(ns[KEY_FROM]),
+            activeDriver: active.driver,
+            activePlugin: active.plugin,
+        }, 200);
+    })
+        .openapi(api_contract_1.adminMailRoutes.updateMailSettingsRoute, async (c) => {
+        const body = c.req.valid('json');
+        if (body.from !== undefined) {
+            debug('updateMailSettings from=%s', body.from);
+            await crowi.getConfigService().saveConfig('crowi', { [KEY_FROM]: body.from });
+        }
+        return c.json({ ok: true }, 200);
+    })
+        .openapi(api_contract_1.adminMailRoutes.sendTestMailRoute, async (c) => {
+        const user = c.get('user');
+        if (!user?.email) {
+            return c.json({ error: { code: 'MAIL_TEST_FAILED', message: 'No email address on the calling user' } }, 502);
+        }
+        try {
+            await crowi.getMailer().sendTest(user.email, user.lang);
+        }
+        catch (err) {
+            const error = err;
+            debug('sendTestMail failed: %s', error.message);
+            return c.json({ error: { code: 'MAIL_TEST_FAILED', message: error.message } }, 502);
+        }
+        return c.json({ ok: true, to: user.email }, 200);
+    });
+};
+exports.registerAdminMailRoutes = registerAdminMailRoutes;
+//# sourceMappingURL=mail.js.map

package/dist/hono/handlers/admin/mail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mail.js","sourceRoot":"","sources":["../../../../src/hono/handlers/admin/mail.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,sDAAsD;AAEtD,kDAA0B;AAG1B,wDAA8E;AAG9E,kDAAgE;AAEhE,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,gCAAgC,CAAC,CAAC;AAEtD,MAAM,QAAQ,GAAG,WAAW,CAAC;AAE7B,6EAA6E;AAC7E,MAAM,mBAAmB,GAAG,CAAC,KAAY,EAAsC,EAAE;IAC/E,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;IACnC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,IAAI,EAAE,EAAE,CAAC;AAC1E,CAAC,CAAC;AAEK,MAAM,uBAAuB,GAAG,CAA2C,GAAM,EAAE,KAAY,EAAE,EAAE;IACxG,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,IAAA,8BAAsB,EAAC,KAAK,CAAC,CAAC,CAAC;IACxD,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,IAAA,8BAAsB,EAAC,KAAK,CAAC,CAAC,CAAC;IAEtD,OAAO,GAAG;SACP,OAAO,CAAC,8BAAe,CAAC,oBAAoB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACzD,MAAM,EAAE,GAAG,IAAA,sCAAuB,EAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAC1C,OAAO,CAAC,CAAC,IAAI,CACX;YACE,IAAI,EAAE,IAAA,2BAAY,EAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;YAChC,YAAY,EAAE,MAAM,CAAC,MAAM;YAC3B,YAAY,EAAE,MAAM,CAAC,MAAM;SAC5B,EACD,GAAG,CACJ,CAAC;IACJ,CAAC,CAAC;SACD,OAAO,CAAC,8BAAe,CAAC,uBAAuB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QAC5D,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,KAAK,CAAC,4BAA4B,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,MAAM,KAAK,CAAC,gBAAgB,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAChF,CAAC;QAED,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAa,EAAE,EAAE,GAAG,CAAC,CAAC;IAC5C,CAAC,CAAC;SACD,OAAO,CAAC,8BAAe,CAAC,iBAAiB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACtD,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;YACjB,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,kBAA2B,EAAE,OAAO,EAAE,sCAAsC,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;QACxH,CAAC;QAED,IAAI,CAAC;YACH,MAAM,KAAK,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,GAAY,CAAC;YAC3B,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAChD,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,kBAA2B,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;QAC/F,CAAC;QAED,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAa,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,GAAG,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AA3CW,QAAA,uBAAuB,2BA2ClC"}

package/dist/hono/handlers/admin/plugins.d.ts

@@ -0,0 +1,409 @@
+import type { OpenAPIHono } from '@hono/zod-openapi';
+import type Crowi from '../../../crowi';
+import type { CrowiHonoBindings } from '../../app';
+export declare const registerAdminPluginsRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
+    "/admin/plugins": {
+        $get: {
+            input: {};
+            output: {
+                plugins: {
+                    name: string;
+                    version: string;
+                    hasConfig: boolean;
+                    registers: string[];
+                    adminPlacement: {
+                        section: "search" | "auth" | "notification" | "settings" | "shared" | "storage" | "mail" | "renderer";
+                        label: string;
+                        icon?: string | undefined;
+                    };
+                    supportsHotReload: boolean;
+                    requires?: string[] | undefined;
+                }[];
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {};
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {};
+            output: {
+                error: {
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {};
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/admin/plugins/config": {
+        $get: {
+            input: {
+                query: {
+                    name: string;
+                    locale?: string | undefined;
+                };
+            };
+            output: {
+                name: string;
+                fields: {
+                    name: string;
+                    kind: "string" | "number" | "boolean" | "enum" | "secret" | "string-array";
+                    optional: boolean;
+                    label?: string | undefined;
+                    description?: string | undefined;
+                    defaultValue?: import("hono/utils/types").JSONValue | undefined;
+                    options?: string[] | undefined;
+                    action?: {
+                        label: string;
+                        method: string;
+                        path: string;
+                    } | undefined;
+                }[];
+                values: {
+                    [x: string]: import("hono/utils/types").JSONValue;
+                };
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                    locale?: string | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                    locale?: string | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                    locale?: string | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "PLUGIN_NOT_FOUND";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                    locale?: string | undefined;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/admin/plugins/config": {
+        $put: {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: {
+                    values: Record<string, unknown>;
+                };
+            };
+            output: {
+                ok: true;
+                hotReloaded: boolean;
+                reconfigureFailed: boolean;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: {
+                    values: Record<string, unknown>;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: {
+                    values: Record<string, unknown>;
+                };
+            };
+            output: {
+                error: {
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: {
+                    values: Record<string, unknown>;
+                };
+            };
+            output: {
+                error: {
+                    code: "PLUGIN_NOT_FOUND";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: {
+                    values: Record<string, unknown>;
+                };
+            };
+            output: {
+                error: {
+                    code: "PLUGIN_CONFIG_VALIDATION_FAILED";
+                    message: string;
+                    issues: {
+                        path: (string | number)[];
+                        message: string;
+                    }[];
+                };
+            };
+            outputFormat: "json";
+            status: 422;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: {
+                    values: Record<string, unknown>;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/admin/plugins/render-cache/clear-all": {
+        $post: {
+            input: {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                ok: true;
+                clearedAt: string;
+                removedCount: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+} & {
+    "/admin/plugins/render-cache/clear-plugin": {
+        $post: {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                ok: true;
+                clearedAt: string;
+                removedCount: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "ADMIN_REQUIRED";
+                    message: "Admin permission required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 403;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "PLUGIN_NOT_FOUND";
+                    message: string;
+                };
+            };
+            outputFormat: "json";
+            status: 404;
+        } | {
+            input: {
+                query: {
+                    name: string;
+                };
+            } & {
+                json: Record<string, never> | undefined;
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+}, "/">;