@crowi/plugin-api 0.1.0-alpha.2 → 1.0.0-alpha.4

package/dist/index.d.mts

@@ -5,8 +5,36 @@ import { Context } from 'hono';
 /**
  * The context object passed to every plugin callback. It is the only
  * conduit through which a plugin reads core state (config, models,
- * crypto helpers, logging) — plugins must NOT import from
- * `@crowi/server` directly to keep the contract surface thin.
+ * logging) — plugins must NOT import from `@crowi/server` directly to
+ * keep the contract surface thin.
+ *
+ * Trust boundary: a plugin only reaches what it explicitly declares, and
+ * a plugin cannot reach another plugin's or core's secrets through
+ * `PluginContext`:
+ *
+ * - `model(name)` is gated by the plugin's own `CrowiPlugin.modelAccess`
+ *   allow-list (see `model()` below) — there is no ambient "any core
+ *   model" access. Credential-vault models (`Config`,
+ *   `PersonalAccessToken`, OAuth client/token/grant models, `Share`,
+ *   `ShareAccess`) can never be granted at all: declaring one in
+ *   `modelAccess` fails boot, and `model()` refuses to return one at
+ *   call time even if that check were somehow bypassed.
+ * - There is intentionally no symmetric encrypt/decrypt capability on
+ *   this context: the only legitimate secret-reading path is
+ *   `config<T>()`, which already hands back `@sensitive` fields
+ *   transparently decrypted for *this* plugin's own config.
+ * - `dependencyConfig<T>(name)` only returns another plugin's config —
+ *   `@sensitive` fields included — when that plugin has explicitly
+ *   opted in via `CrowiPlugin.exposesConfigToDependents: true`. Listing
+ *   a plugin in `requires` is not, by itself, enough to read its config.
+ *
+ * One caveat remains, intentionally out of scope for this trust
+ * boundary: a plugin granted `modelAccess: ['User']` gets the raw
+ * Mongoose document, password hash included — there is no field
+ * projection today. Field-level read/write proxying for `User` (and any
+ * other model) is deferred to a post-2.0 repository/HTTP layer
+ * separation; until then, only grant `User` `modelAccess` to plugins you
+ * trust with that document as a whole.
  */
 interface PluginContext {
     /**
@@ -21,13 +49,19 @@ interface PluginContext {
      * Read a typed dependency plugin's config. The target plugin must
      * be listed in this plugin's `requires` array — reading another
      * plugin's config without declaring the dependency is a contract
-     * violation and throws.
+     * violation and throws. In addition, the target plugin must have
+     * opted in with `CrowiPlugin.exposesConfigToDependents: true` —
+     * `requires` alone is only this plugin's side of the contract, not
+     * permission granted by the dependency. Throws when the dependency
+     * has not opted in.
      *
-     * Useful for shared-credential plugins like `@crowi/plugin-aws`:
-     * the base plugin owns `region` / `accessKeyId` / `secretAccessKey`,
-     * and dependents (`@crowi/plugin-storage-aws-s3`,
-     * `@crowi/plugin-mail-aws-ses`) read them through this method
-     * instead of duplicating the fields in their own configSchema.
+     * Useful for shared-credential plugins like `@crowi/plugin-aws`,
+     * which sets `exposesConfigToDependents: true` because sharing
+     * `region` / `accessKeyId` / `secretAccessKey` with dependents
+     * (`@crowi/plugin-storage-aws-s3`, `@crowi/plugin-mail-aws-ses`) is
+     * its entire purpose — they read them through this method instead of
+     * duplicating the fields in their own configSchema. Most plugins do
+     * not opt in, so most `dependencyConfig` calls against them throw.
      */
     dependencyConfig<T>(dependencyName: string): T;
     /**
@@ -42,19 +76,90 @@ interface PluginContext {
     /** Per-Page metadata accessor for this plugin's namespace. */
     pageMetadata: PageMetadataAccessor;
     /**
-     * Mongoose model accessor. Returns the named core model. Plugins
-     * touch core collections (Page, User, Comment, ...) through this
-     * accessor rather than importing model files directly.
+     * Mongoose model accessor, gated by this plugin's declared
+     * `CrowiPlugin.modelAccess` allow-list. Plugins touch core
+     * collections (Page, User, Comment, ...) through this accessor
+     * rather than importing model files directly.
+     *
+     * Throws when `name` is not listed in the plugin's `modelAccess` —
+     * a plugin must declare every core model it touches. A model name
+     * listed in `modelAccess` is returned with full (unrestricted)
+     * read/write access; there is no read-only proxying. Credential-vault
+     * models (`Config`, `PersonalAccessToken`, OAuth client/token/grant
+     * models, `Share`, `ShareAccess`) can never be listed in `modelAccess`
+     * at all — declaring one fails boot, and this method also refuses to
+     * return one at call time.
+     *
+     * Caveat: `modelAccess: ['User']` hands back the raw document,
+     * password hash included — there is no field projection today (see
+     * the trust-boundary note on this interface).
      *
      * Typed loosely (`unknown`) at this layer because the core model
      * types live in `@crowi/server`; plugins narrow the return type at
      * the call site.
      */
     model(name: string): unknown;
-    /** Symmetric encrypt / decrypt against the configured KeyProvider. */
-    crypto: PluginCrypto;
     /** Structured logger scoped to this plugin (auto-prefixed with name). */
     log: PluginLogger;
+    /**
+     * Hot-reload state primitive. Returns a {@link StateCell} that holds a
+     * mutable value — the driver-owned resource (an S3 client, an SMTP
+     * transport, a search client, ...) that `reconfigure` rebuilds when
+     * admin saves new config. Every call across every `PluginContext`
+     * instance for this plugin (the activation-time `ctx` passed to
+     * `registerStorage`/`registerSearch`/`registerMailSender` etc., and
+     * every later `reconfigure(ctx)` call) returns the **same** cell — the
+     * runtime keys it by plugin name, not by `ctx` instance. `initial` is
+     * only used the first time this plugin ever calls `state()`; later
+     * calls ignore it and just return the existing cell.
+     *
+     * Use this instead of a module-scope `let`/`const` — it protects
+     * in-flight `withValue()` callers from a concurrent `set()` swapping
+     * the value out from under them, and gives `set()`'s `dispose` option
+     * a correct place to tear down the previous value (close a client,
+     * end a connection pool, ...) once nothing is still using it.
+     */
+    state<T>(initial: T): StateCell<T>;
+}
+/**
+ * A hot-reload-safe mutable cell, returned by `PluginContext.state()`.
+ * Designed for driver plugins (storage / search / mail / ...) that
+ * `reconfigure()` rebuilds a stateful resource for: `withValue()` marks
+ * the current value "in use" for the duration of the callback so a
+ * concurrent `set()` cannot tear it down mid-call, and `set()`'s
+ * `dispose` option only runs once every such in-flight caller has
+ * settled.
+ */
+interface StateCell<T> {
+    /**
+     * Atomic snapshot of the current value. Safe to read once and reuse
+     * across `await`s in the caller — but prefer {@link withValue} when the
+     * value may be disposed (e.g. an SDK client that `dispose` closes),
+     * since `get()` gives no in-flight protection.
+     */
+    get(): T;
+    /**
+     * Run `fn` against the current value while marking it "in use", so a
+     * concurrent `set()`'s `dispose` waits for `fn` to settle (resolve or
+     * reject) before tearing down the value `fn` captured. This is the
+     * primary way driver methods should read the cell.
+     */
+    withValue<R>(fn: (value: T) => R | Promise<R>): Promise<R>;
+    /**
+     * Swap in `next`. If `opts.dispose` is given, it runs — asynchronously,
+     * never inline — once every `withValue()` call that was in flight
+     * against the previous value at the moment of the swap has settled
+     * (immediately, on the next microtask, if none were in flight).
+     *
+     * `dispose` must handle (and log, if relevant) its own errors — a
+     * rejected `dispose` is swallowed by the runtime rather than
+     * surfaced anywhere, since there is no caller left waiting on it by
+     * the time it runs. Wrap the teardown in its own `try`/`catch` (or
+     * `.catch()`) instead of letting it throw.
+     */
+    set(next: T, opts?: {
+        dispose?: (prev: T) => void | Promise<void>;
+    }): void;
 }
 /**
  * Read-only view of core application settings exposed to plugins via
@@ -94,10 +199,6 @@ interface PageMetadataAccessor {
     /** Remove this plugin's metadata for a specific page. */
     remove(pageId: string): Promise<void>;
 }
-interface PluginCrypto {
-    encrypt(plaintext: string): string;
-    decrypt(ciphertext: string): string;
-}
 interface PluginLogger {
     debug(message: string, ...args: unknown[]): void;
     info(message: string, ...args: unknown[]): void;
@@ -105,6 +206,66 @@ interface PluginLogger {
     error(message: string, ...args: unknown[]): void;
 }
 
+/**
+ * Domain events emitted by core. The full event payload shapes live in
+ * `@crowi/server`; this contract publishes only the event names so the
+ * type signature of `EventBus.on` stays type-safe at the plugin layer.
+ *
+ * `pluginHooks` are the v2.0 internal-use-only events. Community
+ * plugins should NOT subscribe — the surface is reserved while we
+ * stabilise it.
+ */
+interface PluginEvents {
+    'page:created': {
+        pageId: string;
+        path: string;
+    };
+    'page:updated': {
+        pageId: string;
+        path: string;
+    };
+    'page:deleted': {
+        pageId: string;
+        path: string;
+    };
+    'page:renamed': {
+        pageId: string;
+        oldPath: string;
+        newPath: string;
+    };
+    'comment:added': {
+        pageId: string;
+        commentId: string;
+    };
+    'comment:removed': {
+        pageId: string;
+        commentId: string;
+    };
+    'user:registered': {
+        userId: string;
+    };
+    'user:activated': {
+        userId: string;
+    };
+}
+interface EventBus {
+    on<K extends keyof PluginEvents>(event: K, listener: (payload: PluginEvents[K]) => void | Promise<void>): void;
+}
+
+/**
+ * HTML-emitting helper for renderer plugins.
+ *
+ * A renderer plugin that builds HTML from author-controlled or external
+ * strings (an OGP title, a math error message, …) must escape them, and
+ * that escape is a security primitive — a hardening change has to reach
+ * every plugin at once, not whichever local copies someone remembers.
+ * This is the SDK's single copy (`@crowi/plugin-renderer-katex` and
+ * `@crowi/plugin-renderer-link-card` each carried an identical local one
+ * before it was hoisted here).
+ */
+/** Escape `&` `<` `>` `"` `'` for interpolation into HTML text or double/single-quoted attribute values. */
+declare function escapeHtml(s: string): string;
+
 /**
  * Metadata accompanying a `put`. The runtime always provides
  * `contentType`; drivers are free to store additional fields under
@@ -463,52 +624,6 @@ interface MailSenderRegistry {
     register(driverName: string, driver: MailSender): void;
 }
 
-/**
- * Domain events emitted by core. The full event payload shapes live in
- * `@crowi/server`; this contract publishes only the event names so the
- * type signature of `EventBus.on` stays type-safe at the plugin layer.
- *
- * `pluginHooks` are the v2.0 internal-use-only events. Community
- * plugins should NOT subscribe — the surface is reserved while we
- * stabilise it.
- */
-interface PluginEvents {
-    'page:created': {
-        pageId: string;
-        path: string;
-    };
-    'page:updated': {
-        pageId: string;
-        path: string;
-    };
-    'page:deleted': {
-        pageId: string;
-        path: string;
-    };
-    'page:renamed': {
-        pageId: string;
-        oldPath: string;
-        newPath: string;
-    };
-    'comment:added': {
-        pageId: string;
-        commentId: string;
-    };
-    'comment:removed': {
-        pageId: string;
-        commentId: string;
-    };
-    'user:registered': {
-        userId: string;
-    };
-    'user:activated': {
-        userId: string;
-    };
-}
-interface EventBus {
-    on<K extends keyof PluginEvents>(event: K, listener: (payload: PluginEvents[K]) => void | Promise<void>): void;
-}
-
 /**
  * Renderer extension contract — type-only. Plugins contribute parse /
  * transform behaviour to the server-side markdown pipeline through
@@ -590,9 +705,64 @@ interface CodeBlockRenderer {
      * strip comments, etc.
      */
     computeEmbedKey?(info: CodeBlockInfo): string;
+    /**
+     * Opt into a CPU-bounded admission control pool (`render-admission.ts`,
+     * `packages/api/src/renderer/core/render-admission.ts`). When present,
+     * `cachedRenderOrPending` (`packages/api/src/renderer/cache/index.ts`)
+     * and `renderCodeBlockForPreview` acquire a ticket from the named pool
+     * (keyed per `pluginName`) immediately around the `render()` call and
+     * release it on completion; when absent (the default — PlantUML /
+     * KaTeX / emoji and existing embed/URL-expansion plugins), `render()`
+     * is called directly with no admission gate, matching today's
+     * behaviour. See spec §6 for the full design (global / per-user
+     * concurrency caps + priority queue).
+     */
+    admissionControl?: AdmissionControlConfig;
+    /**
+     * Opt into server-rendering during editor live preview
+     * (`POST /pages/preview`, which runs with no `pageId`). Default
+     * `'source'` (omitted) leaves the fenced block untouched in preview —
+     * today's behaviour for every existing `CodeBlockRenderer`. Plugins
+     * that declare `'server-render'` MUST be no-I/O and deterministic:
+     * `makePreviewCodeBlockDispatch` calls them outside the persisted-
+     * cache path (`packages/api/src/renderer/core/code-block-dispatch.ts`).
+     */
+    previewPolicy?: 'source' | 'server-render';
     /** Render a single code block. */
     render(info: CodeBlockInfo, ctx: RenderContext): EmbedFragment | RenderResult | Promise<EmbedFragment | RenderResult>;
 }
+/**
+ * Per-`pluginName` admission-control pool declaration (§6). Shared by
+ * `CodeBlockRenderer` and `EmbedRenderer` — `EmbedRenderer` carries it so
+ * `code-block-dispatch.ts`'s `codeBlockAsEmbedRenderer` adaptor can copy
+ * `CodeBlockRenderer.admissionControl` straight through to the
+ * `EmbedRenderer` shape `cachedRenderOrPending` actually consumes.
+ */
+interface AdmissionControlConfig {
+    /** Process-wide concurrent `render()` calls in flight for this plugin. */
+    maxConcurrentGlobal: number;
+    /** Concurrent `render()` calls in flight for a single `actor` (kind:'user' only). */
+    maxConcurrentPerUser: number;
+    /** Max jobs allowed to wait for a slot before new requests are rejected outright. */
+    queueDepth: number;
+}
+/**
+ * Who is driving this render call. Threaded through `RenderContext` so
+ * admission control (§6) can apply a per-user concurrency cap. Today
+ * every real call site is authenticated (`createJwtAuth` has no
+ * anonymous fallback), so `'user'` is the only variant actually
+ * produced — `'anonymous'` / `'system'` are reserved for future
+ * unauthenticated-read and offline-tooling call sites and must not be
+ * synthesised speculatively.
+ */
+type RenderActor = {
+    kind: 'user';
+    userId: string;
+} | {
+    kind: 'anonymous';
+} | {
+    kind: 'system';
+};
 interface CodeBlockInfo {
     /** The language tag from the fence (the `ts` in ```` ```ts ````). */
     lang: string;
@@ -636,6 +806,41 @@ interface EmbedRenderer {
      * volatility (`?utm_*`) or (b) include external state (Accept-Language).
      */
     computeEmbedKey?(input: EmbedInput): string;
+    /**
+     * Opt into admission control (§6). See `CodeBlockRenderer.admissionControl`
+     * for the full rationale — declared here too because `cachedRenderOrPending`
+     * (`packages/api/src/renderer/cache/index.ts`) is written against the
+     * `EmbedRenderer` shape (`code-block-dispatch.ts`'s
+     * `codeBlockAsEmbedRenderer` adaptor copies a `CodeBlockRenderer`'s
+     * declaration through unchanged). Native `EmbedRenderer` plugins
+     * (embed-tags / URL-inline-expansion) can also opt in if a future one
+     * turns out to be CPU-bound.
+     */
+    admissionControl?: AdmissionControlConfig;
+    /**
+     * Optional per-dispatch cache-bypass predicate
+     * (feature-renderer-plugin-boundary Phase 3). Checked by the generic
+     * embed-tag dispatcher (`packages/api/src/renderer/core/embed-tags.ts`)
+     * BEFORE it touches `CacheStorage` at all for this dispatch — no
+     * `get`, no `set`. When it returns `true`, the dispatcher calls
+     * `render()` directly (via the same `normalizeRenderResult` error
+     * normalisation the preview path uses) and never persists the
+     * result.
+     *
+     * This exists because a renderer whose behaviour is gated by a
+     * runtime policy toggle (e.g. link-card's admin
+     * `security:linkCardEnabled` switch) cannot enforce a literal
+     * zero-cache-access guarantee by checking the toggle only inside
+     * `render()` — a cache HIT from before the toggle flipped would
+     * short-circuit `render()` entirely and keep serving pre-toggle
+     * output (and, symmetrically, writing a toggled-off result to the
+     * cache would keep serving it for up to that entry's TTL after the
+     * toggle flips back). Declaring the check here instead makes the
+     * dispatcher skip the cache outright for that one call. Absent (the
+     * default) or returning `false` goes through the normal cached path
+     * unchanged.
+     */
+    shouldBypassCache?(input: EmbedInput): boolean;
     /** Render a single embed. */
     render(input: EmbedInput, ctx: RenderContext): RenderResult | Promise<RenderResult>;
     /**
@@ -689,19 +894,43 @@ interface RenderResult {
     ttlSec?: number;
     /**
      * When the render failed (network / auth / not_found / rate_limit /
-     * timeout / unknown), plugins should set `error` instead of building
-     * an html error frame. The core caches the error using `RENDER_ERROR_TTL`
-     * and substitutes a fixed placeholder when re-rendering the page.
+     * timeout / unknown / blocked), plugins should set `error` instead of
+     * building an html error frame. The core caches the error using
+     * `RENDER_ERROR_TTL` and, absent `errorHtml`, substitutes a fixed
+     * placeholder when re-rendering the page.
      */
     error?: RenderError;
+    /**
+     * Optional failure-display HTML, paired with `error`. When `error` is
+     * set and `errorHtml` is present, the core shows `errorHtml` instead of
+     * the generic `errorPlaceholder()` — e.g. a link-card plugin can keep
+     * its URL clickable even when the OGP fetch failed. Same trust
+     * contract as `html`: **pre-sanitised, the core does not re-escape it**.
+     *
+     * Deliberately a separate field rather than "non-empty `html` + `error`
+     * means show `html`" — that shape makes a plugin's stray/forgotten
+     * `html` leak into the error display by accident. An explicit opt-in
+     * field means a plugin that hasn't been updated for `errorHtml` keeps
+     * the current safe-by-default behaviour (placeholder).
+     *
+     * Ignored when `error` is unset.
+     */
+    errorHtml?: string;
 }
 /**
  * Error categories cached with their own per-code TTLs. See
  * `packages/api/src/renderer/cache/index.ts:RENDER_ERROR_TTL` for the
- * concrete numbers.
+ * concrete numbers. `blocked` is a policy-level permanent rejection
+ * (SSRF block, disallowed scheme, disallowed content-type) — distinct
+ * from `not_found` semantically but sharing its 1h persistent-failure
+ * TTL. `busy` is a transient renderer-admission rejection (e.g. a
+ * shared fetch/render concurrency semaphore's wait queue was full, or a
+ * queued request's wait deadline elapsed) — never a property of the
+ * embed's target, so it shares a short transient TTL with
+ * `network`/`timeout` rather than `blocked`'s persistent one.
  */
 interface RenderError {
-    code: 'auth' | 'rate_limit' | 'not_found' | 'network' | 'timeout' | 'unknown';
+    code: 'auth' | 'rate_limit' | 'not_found' | 'network' | 'timeout' | 'unknown' | 'blocked' | 'busy';
     /** Free-form text for log/debug — NOT inlined into the user-facing placeholder. */
     message?: string;
     /**
@@ -794,6 +1023,17 @@ interface CacheEntry {
     result: RenderResult;
     fetchedAt: Date;
     expiresAt: Date;
+    /**
+     * Present ⇔ this is a stale-if-error entry keeping a prior success on
+     * screen (see `packages/api/src/renderer/cache/index.ts:
+     * STALE_IF_ERROR_MAX_AGE_SEC`): the value is that ORIGINAL success's
+     * timestamp, carried forward unchanged across consecutive failed
+     * retries — never the failed attempt's `fetchedAt`. Success entries do
+     * not carry it (their `fetchedAt` IS the last-good time; readers use
+     * that directly, which also covers, value-identically, entries written
+     * while this field was still being set on success).
+     */
+    lastGoodFetchedAt?: Date;
 }
 /**
  * MongoDB-backed cache surface. Phase 4 ships exactly one
@@ -886,6 +1126,25 @@ interface RenderContext {
      * encrypted-config-backed implementation.
      */
     auth?: AuthContext;
+    /**
+     * Who is driving this render. Required so admission control (§6) can
+     * apply its per-user concurrency cap end-to-end — every entry point
+     * (`Renderer.run`/`runMetadata`/`runRender`, `packages/api/src/renderer/
+     * index.ts`) requires callers to supply this. See `RenderActor`'s doc
+     * comment for which variant real call sites actually produce today.
+     */
+    actor: RenderActor;
+    /**
+     * Optional cancellation signal, propagated from the originating HTTP
+     * request (`c.req.raw.signal` on `POST /pages/preview`). A waiting
+     * (not-yet-running) admission-control job is removed from its queue
+     * the instant this fires; an already-running child-process render is
+     * NOT force-killed (§6 — the cost of killing/respawning a worker
+     * outweighs letting an already-cheap render finish and discarding the
+     * result). Absent on the save / read call sites, which have no
+     * request to cancel against.
+     */
+    signal?: AbortSignal;
 }
 /**
  * The registry handed to every plugin's `registerRenderer(scope, ctx)`.
@@ -901,6 +1160,10 @@ interface RenderContext {
  *
  * Phase 4 stubs (warn-noop):
  *   - `addCodeBlockRenderer` (Phase 6 lights this up)
+ *
+ * feature-renderer-plugin-boundary Phase 1 adds `addStylesheet(path)` —
+ * the boot-time CSS-manifest extension point (see that method's own doc
+ * comment).
  */
 interface RendererRegistry {
     /**
@@ -939,6 +1202,30 @@ interface RendererRegistry {
      * preserved; the first match that returns `'replaced'` wins.
      */
     addUrlInlineExpander(rule: UrlInlineExpansionRule): void;
+    /**
+     * Declare a static CSS asset the plugin needs the browser to load
+     * (e.g. KaTeX's ~30KB math stylesheet). `path` MUST be an
+     * API-relative absolute path confined to the plugin's own
+     * `registerRoutes` namespace — `/api/v2/plugins/<this plugin's
+     * name>/<…>` — the same prefix `PluginRouterScope.route(...)` mounts
+     * that plugin's HTTP routes under. A URL scheme, protocol-relative
+     * `//host`, backslash, `..` traversal segment, or a path outside the
+     * plugin's own namespace all throw synchronously (boot-time reject —
+     * this is not an operator-configurable external URL; see spec
+     * §2.1's "不採用案").
+     *
+     * The call only stages the path in a per-plugin pending set: it is
+     * published to the public `GET /api/v2/app/info` `rendererStylesheets`
+     * manifest ONLY after this plugin's OWN `registerRoutes(scope, ctx)`
+     * completes without throwing (so the manifest never advertises a path
+     * whose route failed to mount). A plugin with no `registerRoutes` at
+     * all, or whose `registerRoutes` throws, never gets its pending
+     * stylesheets committed — dropped wholesale, not partially. Query /
+     * fragment are allowed; duplicate calls with the same path are a
+     * no-op. Call this from `registerRenderer`, not `registerRoutes` —
+     * commit timing depends on this method having already run.
+     */
+    addStylesheet(path: string): void;
 }
 
 /**
@@ -966,17 +1253,15 @@ type PluginRouteHandler = (c: Context) => Response | Promise<Response>;
 /** Per-route options passed alongside the handler. */
 interface PluginRouteOptions {
     /**
-     * When `true`, the route is mounted **without** `createJwtAuth`, so it
-     * is reachable by unauthenticated requests (Crowi-auth public). Use for
-     * inbound webhooks that authenticate themselves out-of-band — e.g. the
-     * Slack Events API endpoint, which is gated by Slack's request-signature
-     * check rather than a Crowi session (RFC-0013 §8).
-     *
-     * Omitted / `false` mounts the route under `createJwtAuth`, so it
-     * requires a valid Crowi JWT just like a core authenticated endpoint
-     * (admin "Test connection" / `@action` targets, OAuth callbacks).
+     * Authorization tier this route requires.
+     * - `'public'`: no auth (self-authenticating webhooks — Slack signature
+     *   check etc.).
+     * - `'user'` (default): any authenticated Crowi user (`createJwtAuth`).
+     * - `'admin'`: `user.admin === true` (`createJwtAdminRequired`) — use for
+     *   Test-connection / `@action` targets reached only from the admin
+     *   config form.
      */
-    public?: boolean;
+    auth?: 'public' | 'user' | 'admin';
 }
 /**
  * Scope passed to `registerRoutes(scope, ctx)`. Lets a plugin contribute
@@ -994,11 +1279,12 @@ interface PluginRouterScope {
      * Mount `handler` for `method` at `<path>` under this plugin's
      * namespace. `path` is relative to `/api/v2/plugins/<plugin-name>` and
      * should start with `/` (e.g. `route('POST', '/events', handler, {
-     * public: true })` → `POST /api/v2/plugins/<name>/events`).
+     * auth: 'public' })` → `POST /api/v2/plugins/<name>/events`).
      *
-     * Pass `{ public: true }` to bypass `createJwtAuth` for self-
-     * authenticating inbound webhooks; omit it for routes that require a
-     * Crowi session.
+     * Pass `{ auth: 'public' }` to bypass Crowi auth entirely for self-
+     * authenticating inbound webhooks, `{ auth: 'admin' }` to require
+     * `user.admin === true`, or omit `opts` for the `'user'` default (any
+     * authenticated Crowi user).
      */
     route(method: PluginRouteMethod, path: string, handler: PluginRouteHandler, opts?: PluginRouteOptions): void;
 }
@@ -1033,10 +1319,55 @@ interface CrowiPlugin {
      * at boot and loads `requires` first; cycles fail boot.
      */
     requires?: string[];
+    /**
+     * Core Mongoose model names (e.g. `['Page', 'Bookmark']`) this plugin
+     * is allowed to reach via `ctx.model(name)`. The PluginManager
+     * validates every entry against the set of registered core model
+     * names at boot — an unknown name fails boot with a descriptive
+     * error. `ctx.model(name)` throws at call time for any `name` not
+     * listed here.
+     *
+     * A model listed here is granted full (unrestricted) read/write
+     * access — there is no read-only mode. Omit or leave empty for a
+     * plugin that never calls `ctx.model()`.
+     *
+     * Credential-bearing core models (`Config`, `PersonalAccessToken`,
+     * OAuth client/token/grant models, `Share`, `ShareAccess`) can never
+     * be listed here — declaring one fails boot, and `ctx.model()` also
+     * refuses to return one at call time as defense-in-depth. There is no
+     * legitimate plugin use case for touching those collections directly.
+     */
+    modelAccess?: string[];
+    /**
+     * Opt in to letting *other* plugins read this plugin's config through
+     * their `ctx.dependencyConfig<T>(this.name)` (they must also list this
+     * plugin in their own `requires`). Defaults to `false` — a plugin's
+     * config, including `@sensitive` fields, is private to itself unless
+     * it explicitly declares this flag.
+     *
+     * Set this on a plugin that exists specifically to hold credentials
+     * shared by other plugins — e.g. `@crowi/plugin-aws` sets it so
+     * `@crowi/plugin-storage-aws-s3` and `@crowi/plugin-mail-aws-ses` can
+     * read its `region` / `accessKeyId` / `secretAccessKey` without
+     * duplicating them in their own `configSchema`. Most plugins should
+     * leave this unset.
+     */
+    exposesConfigToDependents?: boolean;
     /**
      * Zod schema describing this plugin's *global* configurable values.
      * The admin UI generates a config form by walking this schema.
      *
+     * Build this with `import { z } from 'zod/v3'` — NOT the top-level
+     * `import { z } from 'zod'` (v4). `peerDependencies: { zod: "^4" }`
+     * only says which npm package to install; the v4 package ships a
+     * `zod/v3` compat subpath, and that subpath's runtime shape is what
+     * every introspection helper here (`schema-serializer.ts`,
+     * `schema-markers.ts`, `PluginManager.listSensitiveKeys()`) actually
+     * walks. A schema built from the top-level v4 API fails boot with an
+     * explicit error (`PluginManager.activate()`'s config-schema guard —
+     * see this package's README) rather than silently losing
+     * `@sensitive` detection.
+     *
      * Mark sensitive fields with the `@sensitive` description marker
      * (see `SENSITIVE_FIELD_MARKER`); they are encrypted at rest via the
      * same KeyProvider used by core's sensitive Config.
@@ -1131,9 +1462,10 @@ interface CrowiPlugin {
      * (c) => Response, opts?)`. The handler receives the raw `Context`, so
      * `c.req.text()` / `c.req.raw` give the exact request bytes (no
      * validator consumes the body ahead of it — the Slack signature check
-     * relies on this). Pass `{ public: true }` to bypass `createJwtAuth`
-     * for self-authenticating webhooks; omit it for Crowi-session-gated
-     * routes.
+     * relies on this). Pass `{ auth: 'public' }` to bypass Crowi auth for
+     * self-authenticating webhooks, `{ auth: 'admin' }` for routes that
+     * require `user.admin === true`, or omit `opts` for the `'user'`
+     * default (any authenticated Crowi user).
      *
      * Called once at boot — but unlike the other `register*` hooks, this
      * runs inside `buildHonoApp` (the Hono app does not exist yet when
@@ -1220,7 +1552,7 @@ interface ActionAnnotation {
     /** Visible button label, e.g. "Test connection". */
     label: string;
     /** HTTP verb of the plugin endpoint to call. */
-    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    method: PluginRouteMethod;
     /** Path relative to `/api/v2/plugins/<name>/`, with leading slash. */
     path: string;
 }
@@ -1230,10 +1562,15 @@ interface ActionAnnotation {
  * Format: `@action "<label>" <METHOD> <path>`
  *   e.g. `@action "Test connection" POST /test`
  *
- * The label may include spaces when wrapped in double quotes; the
- * method is one of `GET` / `POST` / `PUT` / `DELETE`; the path begins
- * with `/`.
+ * The label may include spaces when wrapped in double quotes; the method
+ * must be one of `PluginRouteMethod` (`GET` / `POST` — the only verbs a
+ * plugin route can actually be mounted on, see `routes.ts`); the path
+ * begins with `/`. A description that starts with the `@action` marker
+ * but declares an unsupported verb (e.g. `PUT` / `DELETE`) fails to match
+ * and returns `null` here — callers that walk a plugin's `configSchema`
+ * (e.g. `PluginManager.activate()`) are expected to warn on that case at
+ * boot, since it would otherwise be a silent dead button.
  */
 declare function getActionAnnotation(field: z.ZodTypeAny): ActionAnnotation | null;
 
-export { ACTION_FIELD_MARKER, type AppInfo, type AuthContext, type AuthDriver, type AuthProfile, type AuthRegistry, type AuthVerifyResult, type CacheEntry, type CacheKey, type CacheStorage, type CodeBlockInfo, type CodeBlockRenderer, type CrowiPlugin, type EmailMessage, type EmbedFragment, type EmbedInput, type EmbedRenderer, type EventBus, type InlineExpansion, type MailSender, type MailSenderRegistry, type NodeRenderer, type NotificationPayload, type NotifierDriver, type NotifierRegistry, type PageMetadataAccessor, type PluginContext, type PluginCrypto, type PluginEvents, type PluginLogger, type PluginRouteHandler, type PluginRouteMethod, type PluginRouteOptions, type PluginRouterScope, type RenderContext, type RenderError, type RenderPhase, type RenderResult, type RendererRegistry, type Reservation, SENSITIVE_FIELD_MARKER, type ScopedCacheStorage, type SearchDriver, type SearchHit, type SearchHits, type SearchPageType, type SearchQuery, type SearchQueryGrants, type SearchQueryViewer, type SearchRegistry, type SearchableDoc, type StorageDriver, type StoragePutMeta, type StoragePutResult, type StorageRegistry, type UrlInlineExpansionRule, getActionAnnotation, isSensitiveField };
+export { ACTION_FIELD_MARKER, type AdmissionControlConfig, type AppInfo, type AuthContext, type AuthDriver, type AuthProfile, type AuthRegistry, type AuthVerifyResult, type CacheEntry, type CacheKey, type CacheStorage, type CodeBlockInfo, type CodeBlockRenderer, type CrowiPlugin, type EmailMessage, type EmbedFragment, type EmbedInput, type EmbedRenderer, type EventBus, type InlineExpansion, type MailSender, type MailSenderRegistry, type NodeRenderer, type NotificationPayload, type NotifierDriver, type NotifierRegistry, type PageMetadataAccessor, type PluginContext, type PluginEvents, type PluginLogger, type PluginRouteHandler, type PluginRouteMethod, type PluginRouteOptions, type PluginRouterScope, type RenderActor, type RenderContext, type RenderError, type RenderPhase, type RenderResult, type RendererRegistry, type Reservation, SENSITIVE_FIELD_MARKER, type ScopedCacheStorage, type SearchDriver, type SearchHit, type SearchHits, type SearchPageType, type SearchQuery, type SearchQueryGrants, type SearchQueryViewer, type SearchRegistry, type SearchableDoc, type StateCell, type StorageDriver, type StoragePutMeta, type StoragePutResult, type StorageRegistry, type UrlInlineExpansionRule, escapeHtml, getActionAnnotation, isSensitiveField };