@crowi/api 2.0.0-alpha.0

package/dist/plugin/plugin-manager.js

@@ -0,0 +1,328 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginManager = void 0;
+const debug_1 = __importDefault(require("debug"));
+const runner_1 = require("@crowi/runner");
+const config_sensitive_1 = require("../models/config-sensitive");
+const plugin_context_1 = require("./plugin-context");
+const plugin_namespace_1 = require("./plugin-namespace");
+const renderer_1 = require("../renderer");
+const registries_1 = require("./registries");
+const topo_sort_1 = require("./topo-sort");
+const debug = (0, debug_1.default)('crowi:plugin:manager');
+/**
+ * Loads the plugins listed in `crowi.config.json`, resolves their
+ * dependency order, runs each plugin's `register*` callbacks, and
+ * exposes the resulting registries to the rest of the application.
+ *
+ * Lifecycle:
+ *   1. `loadCrowiConfigFile()` reads the JSON.
+ *   2. For each plugin name, `await import(name)` pulls the package's
+ *      default export and validates it as a `CrowiPlugin`.
+ *   3. `topoSortPlugins()` orders by `requires`.
+ *   4. For each plugin in order:
+ *      a) build a `PluginContext` for it
+ *      b) if first time loaded, `await onInstall(ctx)` (idempotency
+ *         is the plugin's responsibility — we re-call on every boot
+ *         until the install-tracker is added in a follow-up step)
+ *      c) call each provided `register*` callback with the matching
+ *         registry scope
+ *   5. Resolve active drivers from `crowi.config.json:storage.driver`
+ *      / `search.driver`. All registered auth and notifier drivers
+ *      are active simultaneously.
+ *
+ * Errors at any step fail boot. The legacy boot path in `Crowi.init()`
+ * is unchanged when `crowi.config.json` is absent — defaults
+ * (`{ plugins: [], storage.driver: 'local', search.driver: 'mongo' }`)
+ * mean the manager runs with only the implicit-default plugins.
+ */
+class PluginManager {
+    crowi;
+    storage = new registries_1.DriverRegistry('storage');
+    search = new registries_1.DriverRegistry('search');
+    auth = new registries_1.DriverRegistry('auth');
+    notifier = new registries_1.DriverRegistry('notifier');
+    mail = new registries_1.DriverRegistry('mail');
+    loadedPlugins = [];
+    /** plugin name → set of plugin names that `requires` it */
+    dependents = new Map();
+    constructor(crowi) {
+        this.crowi = crowi;
+    }
+    /**
+     * Run the full lifecycle and return the resolved registries +
+     * active drivers. Call once during `Crowi.init()`.
+     */
+    async bootstrap(projectDir = process.cwd()) {
+        // `@crowi/runner` reads `crowi.config.json` and resolves each
+        // plugin npm name (plus transitive `requires`) against the project
+        // dir's `node_modules/`. Topological ordering, activation, and
+        // registry wiring stay here in the manager — runner is a pure
+        // config/loader library with no Crowi-runtime coupling.
+        const { config, plugins } = await (0, runner_1.resolvePlugins)(projectDir);
+        debug('loaded crowi.config.json from %s: plugins=%o', projectDir, config.plugins);
+        const ordered = (0, topo_sort_1.topoSortPlugins)(plugins);
+        this.loadedPlugins = ordered;
+        // Register every plugin's `@sensitive`-marked configSchema fields
+        // with the core sensitive-config registry so values written
+        // through `configService.saveConfig('crowi', { 'plugin:…': … })`
+        // are encrypted at rest just like legacy keys.
+        (0, config_sensitive_1.registerSensitiveConfigKeys)(this.listSensitiveKeys().map((k) => `crowi:${k}`));
+        for (const plugin of ordered) {
+            await this.activate(plugin);
+        }
+        this.buildDependentsMap();
+        this.crowi.getConfigService().onConfigChange((changedNamespaces, source) => this.handleConfigChange(changedNamespaces, source));
+        return {
+            storage: this.storage,
+            search: this.search,
+            auth: this.auth,
+            notifier: this.notifier,
+            mail: this.mail,
+            active: this.resolveActiveDrivers(config),
+        };
+    }
+    /**
+     * Walk the loaded plugins' `requires` arrays and invert them into
+     * `dependents: name → set of plugins that require it`. Used to fan
+     * out `reconfigure` calls when a base plugin's config changes (e.g.
+     * `@crowi/plugin-aws` credentials changing should reconfigure
+     * `@crowi/plugin-storage-aws-s3`).
+     */
+    buildDependentsMap() {
+        this.dependents.clear();
+        for (const plugin of this.loadedPlugins) {
+            for (const dep of plugin.requires ?? []) {
+                const set = this.dependents.get(dep) ?? new Set();
+                set.add(plugin.name);
+                this.dependents.set(dep, set);
+            }
+        }
+    }
+    /**
+     * Listener bound to ConfigService.onConfigChange. We only auto-fire
+     * reconfigure for `'remote'` changes (= another instance saved via
+     * Redis pub/sub). For `'local'` changes the admin save handler calls
+     * `reconfigureAffected` itself so it can include the result in the
+     * response body — running it here too would double-fire.
+     */
+    async handleConfigChange(changedNamespaces, source) {
+        if (source !== 'remote')
+            return;
+        const affected = this.affectedPluginsFromNamespaces(changedNamespaces);
+        if (affected.size === 0)
+            return;
+        await this.runReconfigure(affected);
+    }
+    /**
+     * Resolve `changedNamespaces` (e.g. `['plugin:@crowi/plugin-aws']`)
+     * to the concrete set of plugin names that need their `reconfigure`
+     * called: the changed plugin itself plus every plugin that has it in
+     * `requires`. The `'*'` sentinel (used by older pub/sub publishers)
+     * fans out to every loaded plugin.
+     */
+    affectedPluginsFromNamespaces(changedNamespaces) {
+        const out = new Set();
+        const queue = [];
+        for (const ns of changedNamespaces) {
+            if (ns === '*') {
+                for (const plugin of this.loadedPlugins)
+                    out.add(plugin.name);
+                continue;
+            }
+            const pluginName = (0, plugin_namespace_1.parsePluginNamespace)(ns);
+            if (pluginName)
+                queue.push(pluginName);
+        }
+        // BFS so transitive dependents are reached and a `requires` cycle
+        // (shouldn't happen, but isn't actively prevented) doesn't loop.
+        while (queue.length > 0) {
+            const name = queue.shift();
+            if (out.has(name))
+                continue;
+            out.add(name);
+            const dependents = this.dependents.get(name);
+            if (dependents)
+                for (const d of dependents)
+                    queue.push(d);
+        }
+        return out;
+    }
+    /**
+     * Call `reconfigure(ctx)` on each plugin in `affected` that
+     * implements it. Errors are logged + reported via the plugin's debug
+     * logger but never propagated — a single misconfigured plugin must
+     * not lock operators out of the admin UI.
+     *
+     * Returns whether any plugin both (a) implements reconfigure and
+     * (b) completed without throwing — used by the admin save handler
+     * to pick the right toast.
+     */
+    async runReconfigure(affected) {
+        let attempted = 0;
+        let succeeded = 0;
+        for (const name of affected) {
+            const plugin = this.getLoadedPlugin(name);
+            if (!plugin?.reconfigure)
+                continue;
+            attempted++;
+            const ctx = (0, plugin_context_1.createPluginContext)(plugin, this.crowi, this);
+            try {
+                await plugin.reconfigure(ctx);
+                succeeded++;
+                debug('reconfigure %s OK', name);
+            }
+            catch (err) {
+                const message = err instanceof Error ? err.message : String(err);
+                console.warn(`[crowi:plugin:${name}] reconfigure failed: ${message}`);
+                debug('reconfigure %s failed: %s', name, message);
+            }
+        }
+        return { attempted, succeeded };
+    }
+    /**
+     * Public entry-point used by the admin "save plugin config" handler
+     * to await reconfigure completion in the same request and surface
+     * the result in the response body.
+     */
+    async reconfigureAffected(changedNamespaces) {
+        const affected = this.affectedPluginsFromNamespaces(changedNamespaces);
+        return this.runReconfigure(affected);
+    }
+    /**
+     * Look up a plugin by npm name from the loaded set. Used by
+     * `PluginContext.dependencyConfig` to resolve another plugin's
+     * configSchema. Returns undefined when the name isn't loaded.
+     */
+    getLoadedPlugin(name) {
+        return this.loadedPlugins.find((p) => p.name === name);
+    }
+    /**
+     * The list of plugins the manager loaded, in topological order.
+     * Surfaced for `crowi plugin list` and admin UI.
+     */
+    getLoadedPlugins() {
+        return this.loadedPlugins;
+    }
+    /**
+     * Walk every loaded plugin's `configSchema` and return the union of
+     * field paths marked `@sensitive`. The "re-encrypt all" admin
+     * routine consults this list. See RFC-0001 §5.
+     */
+    listSensitiveKeys() {
+        const out = [];
+        for (const plugin of this.loadedPlugins) {
+            const schema = plugin.configSchema;
+            if (!schema)
+                continue;
+            for (const [fieldName, field] of Object.entries(schema.shape)) {
+                const description = field.description;
+                if (typeof description === 'string' && description.trimStart().startsWith('@sensitive')) {
+                    out.push((0, plugin_namespace_1.formatPluginConfigKey)(plugin.name, fieldName));
+                }
+            }
+        }
+        return out;
+    }
+    /**
+     * Deactivate a loaded plugin. Phase 4 only touches the render
+     * cache: every cached entry contributed by the named plugin is
+     * removed (`invalidatePlugin(name)`). Phase 5+ will broaden this
+     * to (a) drop the plugin from the loaded set + driver registries,
+     * (b) emit a deactivation event for dependents, (c) wire the
+     * `--purge` CLI path.
+     *
+     * Returns true when at least the render-cache invalidation ran
+     * (false when the plugin wasn't loaded). Failures are logged but
+     * never propagated — operators trigger deactivate from the admin
+     * UI or CLI and a partial cleanup is still better than no cleanup.
+     */
+    async deactivate(name) {
+        const plugin = this.getLoadedPlugin(name);
+        if (!plugin) {
+            debug('deactivate: plugin %s not loaded; nothing to do', name);
+            return false;
+        }
+        try {
+            const renderer = this.crowi.renderer;
+            if (renderer) {
+                await renderer.cache.invalidatePlugin(name);
+                debug('deactivate %s: render-cache invalidated', name);
+            }
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            console.warn(`[crowi:plugin:${name}] deactivate failed during render-cache invalidation: ${message}`);
+        }
+        return true;
+    }
+    async activate(plugin) {
+        debug('activating %s@%s', plugin.name, plugin.version);
+        const ctx = (0, plugin_context_1.createPluginContext)(plugin, this.crowi, this);
+        // onInstall runs unconditionally for now. A follow-up will track
+        // installed-once state in Mongo and skip on subsequent boots.
+        if (plugin.onInstall) {
+            await plugin.onInstall(ctx);
+        }
+        if (plugin.registerStorage)
+            plugin.registerStorage((0, registries_1.makeStorageScope)(this.storage, plugin.name), ctx);
+        if (plugin.registerSearch)
+            plugin.registerSearch((0, registries_1.makeSearchScope)(this.search, plugin.name), ctx);
+        if (plugin.registerAuth)
+            plugin.registerAuth((0, registries_1.makeAuthScope)(this.auth, plugin.name), ctx);
+        if (plugin.registerNotifier)
+            plugin.registerNotifier((0, registries_1.makeNotifierScope)(this.notifier, plugin.name), ctx);
+        if (plugin.registerMailSender)
+            plugin.registerMailSender((0, registries_1.makeMailScope)(this.mail, plugin.name), ctx);
+        if (plugin.registerRenderer) {
+            // Renderer is registered against `crowi.renderer.registry`; it
+            // already has the core 4 transforms in place when we get here
+            // (Crowi.init() runs setupRenderer before setupPlugins). External
+            // plugins append to the back — they cannot insert before core in
+            // v2.1 phase 2.
+            const renderer = this.crowi.getRenderer();
+            plugin.registerRenderer((0, renderer_1.makeRendererScope)(renderer.registry, plugin.name, ctx.log), ctx);
+        }
+        // registerHooks and registerRoutes are wired in a later step
+        // (the EventBus and PluginRouterScope instances are not yet
+        // constructed in v0.1).
+    }
+    resolveActiveDrivers(config) {
+        return {
+            storage: this.resolveOrWarn(this.storage, 'storage', config.storage.driver),
+            search: this.resolveOrWarn(this.search, 'search', config.search.driver),
+            auth: this.auth
+                .list()
+                .map(({ driverName }) => this.auth.get(driverName))
+                .filter((d) => !!d),
+            notifiers: this.notifier
+                .list()
+                .map(({ driverName }) => this.notifier.get(driverName))
+                .filter((d) => !!d),
+            mail: this.resolveOrWarn(this.mail, 'mail', config.mail.driver),
+        };
+    }
+    /**
+     * Look up `driverName` in `registry`. Returns null + logs a warning
+     * if absent. v2.0 transition behaviour: legacy in-core code keeps
+     * handling the concern when the active driver is null. After the
+     * Step 3+ plugin extractions land, missing-driver becomes a hard
+     * error.
+     */
+    resolveOrWarn(registry, kind, driverName) {
+        const driver = registry.get(driverName);
+        if (driver)
+            return driver;
+        const installed = registry
+            .list()
+            .map((d) => d.driverName)
+            .join(', ') || '(none)';
+        debug(`[warn] ${kind}.driver '${driverName}' not registered. Installed: ${installed}. Falling back to legacy in-core handling.`);
+        return null;
+    }
+}
+exports.PluginManager = PluginManager;
+//# sourceMappingURL=plugin-manager.js.map

package/dist/plugin/plugin-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-manager.js","sourceRoot":"","sources":["../../src/plugin/plugin-manager.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,0CAAqE;AAErE,kEAA0E;AAE1E,qDAAuD;AACvD,yDAAiF;AACjF,2CAAiD;AACjD,6CAAkI;AAClI,2CAA8C;AAE9C,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,sBAAsB,CAAC,CAAC;AAiC5C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,aAAa;IAUK;IATrB,OAAO,GAAG,IAAI,2BAAc,CAAgB,SAAS,CAAC,CAAC;IACvD,MAAM,GAAG,IAAI,2BAAc,CAAe,QAAQ,CAAC,CAAC;IACpD,IAAI,GAAG,IAAI,2BAAc,CAAa,MAAM,CAAC,CAAC;IAC9C,QAAQ,GAAG,IAAI,2BAAc,CAAiB,UAAU,CAAC,CAAC;IAC1D,IAAI,GAAG,IAAI,2BAAc,CAAa,MAAM,CAAC,CAAC;IAC9C,aAAa,GAAkB,EAAE,CAAC;IAC1C,2DAA2D;IACnD,UAAU,GAAG,IAAI,GAAG,EAAuB,CAAC;IAEpD,YAA6B,KAAY;QAAZ,UAAK,GAAL,KAAK,CAAO;IAAG,CAAC;IAE7C;;;OAGG;IACH,KAAK,CAAC,SAAS,CAAC,aAAqB,OAAO,CAAC,GAAG,EAAE;QAChD,8DAA8D;QAC9D,mEAAmE;QACnE,+DAA+D;QAC/D,8DAA8D;QAC9D,wDAAwD;QACxD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAA,uBAAc,EAAC,UAAU,CAAC,CAAC;QAC7D,KAAK,CAAC,8CAA8C,EAAE,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAElF,MAAM,OAAO,GAAG,IAAA,2BAAe,EAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;QAE7B,kEAAkE;QAClE,4DAA4D;QAC5D,iEAAiE;QACjE,+CAA+C;QAC/C,IAAA,8CAA2B,EAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAE/E,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,cAAc,CAAC,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC,CAAC;QAEhI,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC;SAC1C,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACK,kBAAkB;QACxB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACxB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;gBACxC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,EAAU,CAAC;gBAC1D,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBACrB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,kBAAkB,CAAC,iBAA2B,EAAE,MAA0B;QACtF,IAAI,MAAM,KAAK,QAAQ;YAAE,OAAO;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,6BAA6B,CAAC,iBAAiB,CAAC,CAAC;QACvE,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO;QAChC,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACK,6BAA6B,CAAC,iBAA2B;QAC/D,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;QAC9B,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,MAAM,EAAE,IAAI,iBAAiB,EAAE,CAAC;YACnC,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;gBACf,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,aAAa;oBAAE,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC9D,SAAS;YACX,CAAC;YACD,MAAM,UAAU,GAAG,IAAA,uCAAoB,EAAC,EAAE,CAAC,CAAC;YAC5C,IAAI,UAAU;gBAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzC,CAAC;QACD,kEAAkE;QAClE,iEAAiE;QACjE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,EAAG,CAAC;YAC5B,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,SAAS;YAC5B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACd,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC7C,IAAI,UAAU;gBAAE,KAAK,MAAM,CAAC,IAAI,UAAU;oBAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAAC,QAAqB;QACxC,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,EAAE,WAAW;gBAAE,SAAS;YACnC,SAAS,EAAE,CAAC;YACZ,MAAM,GAAG,GAAG,IAAA,oCAAmB,EAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC1D,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC9B,SAAS,EAAE,CAAC;gBACZ,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;YACnC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjE,OAAO,CAAC,IAAI,CAAC,iBAAiB,IAAI,yBAAyB,OAAO,EAAE,CAAC,CAAC;gBACtE,KAAK,CAAC,2BAA2B,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QACD,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAC,iBAA2B;QACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,6BAA6B,CAAC,iBAAiB,CAAC,CAAC;QACvE,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,IAAY;QAC1B,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,iBAAiB;QACf,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC;YACnC,IAAI,CAAC,MAAM;gBAAE,SAAS;YACtB,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9D,MAAM,WAAW,GAAI,KAAkC,CAAC,WAAW,CAAC;gBACpE,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;oBACxF,GAAG,CAAC,IAAI,CAAC,IAAA,wCAAqB,EAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CAAC,IAAY;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,KAAK,CAAC,iDAAiD,EAAE,IAAI,CAAC,CAAC;YAC/D,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YACrC,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAC5C,KAAK,CAAC,yCAAyC,EAAE,IAAI,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjE,OAAO,CAAC,IAAI,CAAC,iBAAiB,IAAI,yDAAyD,OAAO,EAAE,CAAC,CAAC;QACxG,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,MAAmB;QACxC,KAAK,CAAC,kBAAkB,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,GAAG,GAAG,IAAA,oCAAmB,EAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAE1D,iEAAiE;QACjE,8DAA8D;QAC9D,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC9B,CAAC;QAED,IAAI,MAAM,CAAC,eAAe;YAAE,MAAM,CAAC,eAAe,CAAC,IAAA,6BAAgB,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACrG,IAAI,MAAM,CAAC,cAAc;YAAE,MAAM,CAAC,cAAc,CAAC,IAAA,4BAAe,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACjG,IAAI,MAAM,CAAC,YAAY;YAAE,MAAM,CAAC,YAAY,CAAC,IAAA,0BAAa,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACzF,IAAI,MAAM,CAAC,gBAAgB;YAAE,MAAM,CAAC,gBAAgB,CAAC,IAAA,8BAAiB,EAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACzG,IAAI,MAAM,CAAC,kBAAkB;YAAE,MAAM,CAAC,kBAAkB,CAAC,IAAA,0BAAa,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACrG,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC5B,+DAA+D;YAC/D,8DAA8D;YAC9D,kEAAkE;YAClE,iEAAiE;YACjE,gBAAgB;YAChB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,CAAC,gBAAgB,CAAC,IAAA,4BAAiB,EAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QAC3F,CAAC;QAED,6DAA6D;QAC7D,4DAA4D;QAC5D,wBAAwB;IAC1B,CAAC;IAEO,oBAAoB,CAAC,MAAuB;QAClD,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;YAC3E,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;YACvE,IAAI,EAAE,IAAI,CAAC,IAAI;iBACZ,IAAI,EAAE;iBACN,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;iBAClD,MAAM,CAAC,CAAC,CAAC,EAAmB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACtC,SAAS,EAAE,IAAI,CAAC,QAAQ;iBACrB,IAAI,EAAE;iBACN,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;iBACtD,MAAM,CAAC,CAAC,CAAC,EAAuB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SAChE,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACK,aAAa,CAAI,QAA2B,EAAE,IAAY,EAAE,UAAkB;QACpF,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACxC,IAAI,MAAM;YAAE,OAAO,MAAM,CAAC;QAC1B,MAAM,SAAS,GACb,QAAQ;aACL,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;aACxB,IAAI,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC;QAC5B,KAAK,CAAC,UAAU,IAAI,YAAY,UAAU,gCAAgC,SAAS,4CAA4C,CAAC,CAAC;QACjI,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/RD,sCA+RC"}

package/dist/plugin/plugin-namespace.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Single source of truth for the `plugin:<name>[:<field>]` key / namespace
+ * shape that's an inter-module contract between `service/config.ts` and
+ * `plugin/plugin-manager.ts` (and `plugin/plugin-context.ts`).
+ *
+ * Plugin names are npm package names (e.g. `@crowi/plugin-aws`) and may
+ * contain `/` but never `:` — npm package names allow `[a-z0-9-_./]`.
+ * Parse helpers therefore split on the first two `:` rather than greedy
+ * regex alternatives, so a future plugin name with extra characters
+ * doesn't silently break.
+ */
+export declare function formatPluginConfigKey(pluginName: string, field: string): string;
+export declare function formatPluginNamespace(pluginName: string): string;
+export declare function pluginConfigKeyPrefix(pluginName: string): string;
+/**
+ * Extract the plugin name from a `plugin:<name>` namespace string.
+ * Returns null when the namespace isn't plugin-shaped, so callers can
+ * `continue` cleanly on `crowi:*` / `notification:*` etc.
+ */
+export declare function parsePluginNamespace(ns: string): string | null;
+/**
+ * Extract the plugin name from a full `plugin:<name>:<field>` config
+ * key. Returns null when the key isn't plugin-shaped.
+ */
+export declare function parsePluginConfigKey(key: string): {
+    pluginName: string;
+    field: string;
+} | null;

package/dist/plugin/plugin-namespace.js

@@ -0,0 +1,53 @@
+"use strict";
+/**
+ * Single source of truth for the `plugin:<name>[:<field>]` key / namespace
+ * shape that's an inter-module contract between `service/config.ts` and
+ * `plugin/plugin-manager.ts` (and `plugin/plugin-context.ts`).
+ *
+ * Plugin names are npm package names (e.g. `@crowi/plugin-aws`) and may
+ * contain `/` but never `:` — npm package names allow `[a-z0-9-_./]`.
+ * Parse helpers therefore split on the first two `:` rather than greedy
+ * regex alternatives, so a future plugin name with extra characters
+ * doesn't silently break.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatPluginConfigKey = formatPluginConfigKey;
+exports.formatPluginNamespace = formatPluginNamespace;
+exports.pluginConfigKeyPrefix = pluginConfigKeyPrefix;
+exports.parsePluginNamespace = parsePluginNamespace;
+exports.parsePluginConfigKey = parsePluginConfigKey;
+const PLUGIN_PREFIX = 'plugin:';
+function formatPluginConfigKey(pluginName, field) {
+    return `${PLUGIN_PREFIX}${pluginName}:${field}`;
+}
+function formatPluginNamespace(pluginName) {
+    return `${PLUGIN_PREFIX}${pluginName}`;
+}
+function pluginConfigKeyPrefix(pluginName) {
+    return `${PLUGIN_PREFIX}${pluginName}:`;
+}
+/**
+ * Extract the plugin name from a `plugin:<name>` namespace string.
+ * Returns null when the namespace isn't plugin-shaped, so callers can
+ * `continue` cleanly on `crowi:*` / `notification:*` etc.
+ */
+function parsePluginNamespace(ns) {
+    if (!ns.startsWith(PLUGIN_PREFIX))
+        return null;
+    const name = ns.slice(PLUGIN_PREFIX.length);
+    return name.length > 0 ? name : null;
+}
+/**
+ * Extract the plugin name from a full `plugin:<name>:<field>` config
+ * key. Returns null when the key isn't plugin-shaped.
+ */
+function parsePluginConfigKey(key) {
+    if (!key.startsWith(PLUGIN_PREFIX))
+        return null;
+    const rest = key.slice(PLUGIN_PREFIX.length);
+    const sep = rest.lastIndexOf(':');
+    if (sep <= 0 || sep === rest.length - 1)
+        return null;
+    return { pluginName: rest.slice(0, sep), field: rest.slice(sep + 1) };
+}
+//# sourceMappingURL=plugin-namespace.js.map

package/dist/plugin/plugin-namespace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-namespace.js","sourceRoot":"","sources":["../../src/plugin/plugin-namespace.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;AAIH,sDAEC;AAED,sDAEC;AAED,sDAEC;AAOD,oDAIC;AAMD,oDAMC;AAnCD,MAAM,aAAa,GAAG,SAAS,CAAC;AAEhC,SAAgB,qBAAqB,CAAC,UAAkB,EAAE,KAAa;IACrE,OAAO,GAAG,aAAa,GAAG,UAAU,IAAI,KAAK,EAAE,CAAC;AAClD,CAAC;AAED,SAAgB,qBAAqB,CAAC,UAAkB;IACtD,OAAO,GAAG,aAAa,GAAG,UAAU,EAAE,CAAC;AACzC,CAAC;AAED,SAAgB,qBAAqB,CAAC,UAAkB;IACtD,OAAO,GAAG,aAAa,GAAG,UAAU,GAAG,CAAC;AAC1C,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,EAAU;IAC7C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/C,MAAM,IAAI,GAAG,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC5C,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AACvC,CAAC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,GAAW;IAC9C,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC;QAAE,OAAO,IAAI,CAAC;IAChD,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACrD,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC;AACxE,CAAC"}

package/dist/plugin/registries.d.ts

@@ -0,0 +1,38 @@
+import type { AuthDriver, AuthRegistry, MailSender, MailSenderRegistry, NotifierDriver, NotifierRegistry, SearchDriver, SearchRegistry, StorageDriver, StorageRegistry } from '@crowi/plugin-api';
+/**
+ * Generic backing registry for all the typed registries below. Each
+ * registry stores `(driverName → driver)` and remembers which plugin
+ * registered each entry so the runtime can give clear error messages
+ * on collisions.
+ */
+export declare class DriverRegistry<T> {
+    private readonly kind;
+    private drivers;
+    constructor(kind: string);
+    register(driverName: string, driver: T, registeringPlugin: string): void;
+    get(driverName: string): T | undefined;
+    has(driverName: string): boolean;
+    /**
+     * Reverse lookup: the registered `(driverName, plugin)` for a driver
+     * instance, or undefined. Lets handlers report the active driver's
+     * name without re-implementing the identity scan.
+     */
+    entryOf(driver: T): {
+        driverName: string;
+        plugin: string;
+    } | undefined;
+    list(): {
+        driverName: string;
+        plugin: string;
+    }[];
+}
+/**
+ * Per-plugin scope handed to `registerStorage(scope, ctx)`. Closes
+ * over the registering plugin's name so we don't have to make plugins
+ * pass it themselves on every call.
+ */
+export declare const makeStorageScope: (registry: DriverRegistry<StorageDriver>, plugin: string) => StorageRegistry;
+export declare const makeSearchScope: (registry: DriverRegistry<SearchDriver>, plugin: string) => SearchRegistry;
+export declare const makeAuthScope: (registry: DriverRegistry<AuthDriver>, plugin: string) => AuthRegistry;
+export declare const makeNotifierScope: (registry: DriverRegistry<NotifierDriver>, plugin: string) => NotifierRegistry;
+export declare const makeMailScope: (registry: DriverRegistry<MailSender>, plugin: string) => MailSenderRegistry;

package/dist/plugin/registries.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeMailScope = exports.makeNotifierScope = exports.makeAuthScope = exports.makeSearchScope = exports.makeStorageScope = exports.DriverRegistry = void 0;
+/**
+ * Generic backing registry for all the typed registries below. Each
+ * registry stores `(driverName → driver)` and remembers which plugin
+ * registered each entry so the runtime can give clear error messages
+ * on collisions.
+ */
+class DriverRegistry {
+    kind;
+    drivers = new Map();
+    constructor(kind) {
+        this.kind = kind;
+    }
+    register(driverName, driver, registeringPlugin) {
+        const existing = this.drivers.get(driverName);
+        if (existing) {
+            throw new Error(`Plugin '${registeringPlugin}' tried to register ${this.kind} driver '${driverName}', but '${existing.plugin}' already did.`);
+        }
+        this.drivers.set(driverName, { plugin: registeringPlugin, driver });
+    }
+    get(driverName) {
+        return this.drivers.get(driverName)?.driver;
+    }
+    has(driverName) {
+        return this.drivers.has(driverName);
+    }
+    /**
+     * Reverse lookup: the registered `(driverName, plugin)` for a driver
+     * instance, or undefined. Lets handlers report the active driver's
+     * name without re-implementing the identity scan.
+     */
+    entryOf(driver) {
+        for (const [driverName, entry] of this.drivers) {
+            if (entry.driver === driver)
+                return { driverName, plugin: entry.plugin };
+        }
+        return undefined;
+    }
+    list() {
+        return Array.from(this.drivers.entries()).map(([driverName, { plugin }]) => ({ driverName, plugin }));
+    }
+}
+exports.DriverRegistry = DriverRegistry;
+/**
+ * Per-plugin scope handed to `registerStorage(scope, ctx)`. Closes
+ * over the registering plugin's name so we don't have to make plugins
+ * pass it themselves on every call.
+ */
+const makeStorageScope = (registry, plugin) => ({
+    register: (driverName, driver) => registry.register(driverName, driver, plugin),
+});
+exports.makeStorageScope = makeStorageScope;
+const makeSearchScope = (registry, plugin) => ({
+    register: (driverName, driver) => registry.register(driverName, driver, plugin),
+});
+exports.makeSearchScope = makeSearchScope;
+const makeAuthScope = (registry, plugin) => ({
+    register: (driverName, driver) => registry.register(driverName, driver, plugin),
+});
+exports.makeAuthScope = makeAuthScope;
+const makeNotifierScope = (registry, plugin) => ({
+    register: (driverName, driver) => registry.register(driverName, driver, plugin),
+});
+exports.makeNotifierScope = makeNotifierScope;
+const makeMailScope = (registry, plugin) => ({
+    register: (driverName, driver) => registry.register(driverName, driver, plugin),
+});
+exports.makeMailScope = makeMailScope;
+//# sourceMappingURL=registries.js.map

package/dist/plugin/registries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registries.js","sourceRoot":"","sources":["../../src/plugin/registries.ts"],"names":[],"mappings":";;;AAaA;;;;;GAKG;AACH,MAAa,cAAc;IAGI;IAFrB,OAAO,GAAG,IAAI,GAAG,EAAyC,CAAC;IAEnE,YAA6B,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAE7C,QAAQ,CAAC,UAAkB,EAAE,MAAS,EAAE,iBAAyB;QAC/D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,WAAW,iBAAiB,uBAAuB,IAAI,CAAC,IAAI,YAAY,UAAU,WAAW,QAAQ,CAAC,MAAM,gBAAgB,CAAC,CAAC;QAChJ,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,GAAG,CAAC,UAAkB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC9C,CAAC;IAED,GAAG,CAAC,UAAkB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAS;QACf,KAAK,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;QAC3E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACxG,CAAC;CACF;AApCD,wCAoCC;AAED;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,QAAuC,EAAE,MAAc,EAAmB,EAAE,CAAC,CAAC;IAC7G,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC;CAChF,CAAC,CAAC;AAFU,QAAA,gBAAgB,oBAE1B;AAEI,MAAM,eAAe,GAAG,CAAC,QAAsC,EAAE,MAAc,EAAkB,EAAE,CAAC,CAAC;IAC1G,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC;CAChF,CAAC,CAAC;AAFU,QAAA,eAAe,mBAEzB;AAEI,MAAM,aAAa,GAAG,CAAC,QAAoC,EAAE,MAAc,EAAgB,EAAE,CAAC,CAAC;IACpG,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC;CAChF,CAAC,CAAC;AAFU,QAAA,aAAa,iBAEvB;AAEI,MAAM,iBAAiB,GAAG,CAAC,QAAwC,EAAE,MAAc,EAAoB,EAAE,CAAC,CAAC;IAChH,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC;CAChF,CAAC,CAAC;AAFU,QAAA,iBAAiB,qBAE3B;AAEI,MAAM,aAAa,GAAG,CAAC,QAAoC,EAAE,MAAc,EAAsB,EAAE,CAAC,CAAC;IAC1G,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC;CAChF,CAAC,CAAC;AAFU,QAAA,aAAa,iBAEvB"}

package/dist/plugin/schema-serializer.d.ts

@@ -0,0 +1,34 @@
+import { type ZodTypeAny, z } from 'zod/v3';
+/**
+ * Serialised shape of a single plugin config field. The web admin
+ * form renders one input per field, picking the control by `kind`.
+ *
+ * Sensitive fields (`@sensitive` description marker) are NOT present
+ * in `defaultValue` even when the schema declares one — secrets are
+ * never echoed back from the server. Use the separate values payload
+ * with `{ hasValue: true }` to render the "currently saved" badge.
+ */
+export interface SerializedPluginField {
+    name: string;
+    kind: 'string' | 'secret' | 'number' | 'boolean' | 'enum' | 'string-array';
+    description?: string;
+    defaultValue?: unknown;
+    /** Enum options when `kind === 'enum'`. */
+    options?: string[];
+    /** Action button annotation (parsed from `@action ...` description). */
+    action?: {
+        label: string;
+        method: string;
+        path: string;
+    };
+    /** True when the field was declared as optional (`z.…optional()`). */
+    optional: boolean;
+}
+/**
+ * Walk a plugin's `configSchema` (assumed to be a `z.object({...})`)
+ * and produce a flat list of fields the admin form can render. Only
+ * the field shapes the plugin RFC committed to are recognised:
+ * string / number / boolean / enum / string[]. Anything else falls
+ * back to `kind: 'string'` (with a descriptive log on the server).
+ */
+export declare function serializeConfigSchema(schema: z.ZodObject<Record<string, ZodTypeAny>>): SerializedPluginField[];