npm - @crowi/plugin-api - Versions diffs - 1.0.0-alpha.4 → 1.0.0-alpha.6 - Mend

@crowi/plugin-api 1.0.0-alpha.4 → 1.0.0-alpha.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/dist/index.d.mts CHANGED Viewed

@@ -477,8 +477,8 @@ type AuthVerifyResult = {
  * Auth provider driver. The login screen asks core for the list of
  * registered drivers and renders one button per driver
  * (`Sign in with Google`). Clicking redirects through the plugin's
- * registered routes (`/api/v2/plugins/<name>/oauth/start`); the
- * provider redirects back to `/api/v2/plugins/<name>/oauth/callback`,
+ * registered routes (`/api/plugins/<name>/oauth/start`); the
+ * provider redirects back to `/api/plugins/<name>/oauth/callback`,
  * which the plugin's contract handles.
  *
  * `verify` is the bridge: given whatever the plugin pulled out of the
@@ -872,9 +872,36 @@ interface EmbedInput {
  * background-refresh window (see
  * `packages/api/src/renderer/cache/index.ts:cachedRender`).
  */
+/**
+ * RFC-0023 (design doc §12) — the structured (typed) counterpart of a
+ * producer's `html` output. Additive and optional everywhere: a plugin
+ * that never sets it keeps today's behaviour byte-for-byte.
+ *
+ * `node` is the producer-shaped typed node (`type` selects the sidecar
+ * kind — `'crowiDiagram'` / `'crowiLinkCard'` / `'crowiPlaceholder'`).
+ * Deliberately loose (`Record<string, unknown>`) at this SDK layer:
+ * `@crowi/plugin-api` does not depend on `@crowi/api-contract`, so the
+ * authoritative shape lives in the api-contract sidecar schemas and the
+ * api-side dispatch mapper validates against them before stamping a
+ * sidecar onto the persisted AST (invalid payloads degrade to a plain
+ * `html` node, never poisoning what the web reads).
+ */
+interface StructuredRenderPayload {
+    node: Record<string, unknown>;
+}
 interface RenderResult {
-    /** Already-sanitised HTML the core will inline. */
+    /** Already-sanitised HTML the core will inline. Unchanged — the one and only web/legacy representation. */
     html: string;
+    /**
+     * RFC-0023 — optional structured payload paired with `html`. Both
+     * must describe the SAME render outcome: the dispatch layer stamps
+     * this (schema-validated) as a sidecar on the `html` node it splices,
+     * and the `X-Crowi-Ast-Version: 1` projection turns it into a typed
+     * node. On an `error` result, pair it with `errorHtml` when the
+     * error display carries real content (e.g. link-card's fallback
+     * card); leave it unset to get the generic structured placeholder.
+     */
+    structured?: StructuredRenderPayload;
     /**
      * Optional `<head>`-bound assets — Phase 4 records them on the
      * cache entry but the SSR layer does not yet inject them. Phase 7
@@ -993,6 +1020,8 @@ type InlineExpansion = {
 interface EmbedFragment {
     /** Pre-sanitised HTML fragment to inline at the source position. */
     html: string;
+    /** RFC-0023 — optional structured payload paired with `html` (see `RenderResult.structured`). */
+    structured?: StructuredRenderPayload;
     /** Optional `<head>`-bound assets (CSS / JS) keyed by URL. */
     assets?: {
         css?: string[];
@@ -1206,16 +1235,21 @@ interface RendererRegistry {
      * 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
+     * `registerRoutes` namespace — `/api/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 "不採用案").
+     * §2.1's "不採用案"). During the `feature-api-v2-path-removal`
+     * migration period the legacy `/api/v2/plugins/<name>/<…>` prefix is
+     * also accepted and silently normalised to the canonical `/api/plugins/`
+     * form before publication — a plugin package that hasn't bumped its own
+     * `addStylesheet(...)` call site yet still gets a working manifest
+     * entry; this dual-accept is transitional, not a permanent alias.
      *
      * The call only stages the path in a per-plugin pending set: it is
-     * published to the public `GET /api/v2/app/info` `rendererStylesheets`
+     * published to the public `GET /api/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
@@ -1266,7 +1300,7 @@ interface PluginRouteOptions {
 /**
  * Scope passed to `registerRoutes(scope, ctx)`. Lets a plugin contribute
  * HTTP routes that the runtime mounts at
- * `/api/v2/plugins/<plugin-name>/<path>` — the `<plugin-name>` path
+ * `/api/plugins/<plugin-name>/<path>` — the `<plugin-name>` path
  * segment guarantees that core endpoints and other plugins cannot
  * collide (RFC-0013 §4).
  *
@@ -1277,9 +1311,9 @@ interface PluginRouteOptions {
 interface PluginRouterScope {
     /**
      * Mount `handler` for `method` at `<path>` under this plugin's
-     * namespace. `path` is relative to `/api/v2/plugins/<plugin-name>` and
+     * namespace. `path` is relative to `/api/plugins/<plugin-name>` and
      * should start with `/` (e.g. `route('POST', '/events', handler, {
-     * auth: 'public' })` → `POST /api/v2/plugins/<name>/events`).
+     * auth: 'public' })` → `POST /api/plugins/<name>/events`).
      *
      * Pass `{ auth: 'public' }` to bypass Crowi auth entirely for self-
      * authenticating inbound webhooks, `{ auth: 'admin' }` to require
@@ -1289,6 +1323,32 @@ interface PluginRouterScope {
     route(method: PluginRouteMethod, path: string, handler: PluginRouteHandler, opts?: PluginRouteOptions): void;
 }
+/**
+ * Declares that, when a specific driver from a specific registry is
+ * selected (`crowi.config.json:<registry>.driver === driver`), this
+ * plugin's own config becomes required to actually work at runtime —
+ * even though the `configSchema` field itself is optional / defaults to
+ * `''` so `configSchema.parse()` alone can't detect "present but
+ * unusable" (see `@crowi/plugin-storage-aws-s3`'s `bucket` and
+ * `@crowi/plugin-search-elasticsearch` / `@crowi/plugin-search-opensearch`'s
+ * `url`, both `z.string().default('')`).
+ *
+ * This is metadata only — it never carries an actual config value.
+ * `registry` / `driver` / every name in `requiredConfigFields` must be
+ * non-empty. The runtime (`PluginManager.getReadinessIssues()`) reads
+ * this once per admin readiness check, cross-references it against the
+ * currently selected driver and the plugin's current config namespace,
+ * and reports which declared fields are still empty — never the values
+ * themselves. See RFC-none / feature-plugin-config-readiness.
+ */
+interface PluginReadinessDeclaration {
+    /** Which driver registry this declaration is scoped to. */
+    registry: 'storage' | 'search' | 'mail';
+    /** The driver name (as registered via `registry.register(name, …)`) this declaration applies to. */
+    driver: string;
+    /** `configSchema` field names that must be non-empty for `driver` to actually work once selected. */
+    requiredConfigFields: string[];
+}
 /**
  * The contract every Crowi plugin satisfies. Plugins export their
  * `CrowiPlugin` object as the package's default export; the runtime
@@ -1423,6 +1483,14 @@ interface CrowiPlugin {
         label?: string;
         description?: string;
     }>>;
+    /**
+     * Declares which of this plugin's own `configSchema` fields must be
+     * non-empty for a specific driver selection to actually work at
+     * runtime (see {@link PluginReadinessDeclaration}). Optional — a
+     * plugin with no readiness declaration is never surfaced by the
+     * admin readiness check, same as before this field existed.
+     */
+    readiness?: PluginReadinessDeclaration;
     /** Storage driver registration. Called once at boot. */
     registerStorage?: (registry: StorageRegistry, ctx: PluginContext) => void;
     /** Search backend registration. Called once at boot. */
@@ -1453,7 +1521,7 @@ interface CrowiPlugin {
     registerHooks?: (events: EventBus, ctx: PluginContext) => void;
     /**
      * HTTP routes the plugin contributes, mounted at
-     * `/api/v2/plugins/<name>/<path>` (the `<name>` path segment guarantees
+     * `/api/plugins/<name>/<path>` (the `<name>` path segment guarantees
      * that core endpoints and other plugins cannot collide). Used for
      * inbound webhooks (Slack events / slash / interactivity), "Test
      * connection" buttons, `@action` targets, OAuth callbacks, etc.
@@ -1533,7 +1601,7 @@ declare const SENSITIVE_FIELD_MARKER = "@sensitive";
  *
  * The admin form renders a button with the given label that calls the
  * plugin's contributed endpoint at the given verb / path (relative to
- * `/api/v2/plugins/<name>/`). Useful for "Test connection",
+ * `/api/plugins/<name>/`). Useful for "Test connection",
  * "Authorise with Google", etc. without forcing every plugin to ship
  * its own React component.
  */
@@ -1553,7 +1621,7 @@ interface ActionAnnotation {
     label: string;
     /** HTTP verb of the plugin endpoint to call. */
     method: PluginRouteMethod;
-    /** Path relative to `/api/v2/plugins/<name>/`, with leading slash. */
+    /** Path relative to `/api/plugins/<name>/`, with leading slash. */
     path: string;
 }
 /**
@@ -1573,4 +1641,126 @@ interface ActionAnnotation {
  */
 declare function getActionAnnotation(field: z.ZodTypeAny): ActionAnnotation | null;
-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 };
+/**
+ * Parses a root `<svg>` element's `viewBox` (`minX minY width height`) to
+ * derive intrinsic pixel dimensions. Shared by
+ * `@crowi/plugin-renderer-mermaid` (its original home — the `<img>`
+ * `width`/`height` intrinsic-size fix) and, since RFC-0023,
+ * `@crowi/plugin-renderer-plantuml`'s SVG sidecar path — both need the
+ * same derivation and both already bundle this package, so it lives
+ * here rather than being copied per plugin.
+ *
+ * Reads attributes off the sanitized SVG source string only — never
+ * decodes any `data:` payload.
+ */
+declare function extractSvgDimensions(svg: string): {
+    width: number;
+    height: number;
+} | null;
+/**
+ * Renderer-specific knobs for `sanitizeSvg`. The sanitizer itself is a
+ * single shared implementation (`sanitize.ts`) — per-renderer differences
+ * are expressed as parameters here, never as a second copy of the DOM
+ * walk (spec §9: "実装自体をrenderer間で複製しない").
+ */
+interface SanitizeSvgPolicy {
+    /**
+     * When `true`, `href` / `xlink:href` values pointing at an `https:`
+     * URL are preserved (PlantUML's existing "preserves href to a safe
+     * URL" behaviour, consumed starting Phase 3). When `false`, every
+     * `href` / `xlink:href` is stripped unless it is a local fragment
+     * reference (`#id`) — Mermaid's strict policy (spec §1 layer 1 already
+     * disables Mermaid's own click callbacks, so no link should survive
+     * either).
+     *
+     * Regardless of this flag, `javascript:`, `data:`, and
+     * protocol-relative (`//host/...`) URLs are ALWAYS stripped — no
+     * policy may re-allow those.
+     */
+    allowSafeHref: boolean;
+}
+type SanitizeSvgResult = {
+    ok: true;
+    svg: string;
+} | {
+    ok: false;
+    reason: string;
+};
+/**
+ * DOM-based SVG sanitizer shared by `@crowi/plugin-renderer-mermaid` and
+ * (from Phase 3) `@crowi/plugin-renderer-plantuml`. Spec §2 layer 2 / §9.
+ *
+ * Design: allowlist-first for elements (unknown/unexpected element names
+ * are dropped with their whole subtree — safer than trying to enumerate
+ * every dangerous tag), then a small set of attribute-level rules that
+ * apply uniformly to every surviving element. This is a from-scratch DOM
+ * walk, not a regex pass (`packages/plugin-renderer-plantuml/src/
+ * sanitize.ts`'s existing implementation is explicitly documented there
+ * as "not a substitute for DOMPurify" — this package is the replacement
+ * both renderers converge on, PlantUML starting Phase 3).
+ *
+ * What gets removed:
+ *   - Any element not in `ALLOWED_ELEMENTS` (`script`, `foreignObject`,
+ *     `iframe`, `object`, `embed`, SMIL `animate*`/`set`/`discard`, ...) —
+ *     dropped together with its entire subtree.
+ *   - `on*` event-handler attributes (any casing).
+ *   - The `style` attribute (inline styles). Mermaid/PlantUML's real
+ *     styling lives in the `<style>` *element* (class-based), which is
+ *     sanitized separately below rather than dropped — dropping inline
+ *     `style=""` is a deliberate hardening tradeoff (removes a CSS-value
+ *     injection vector) the regression tests confirm does not break
+ *     either renderer's *structural* output.
+ *   - `@import` at-rules and non-local-fragment `url(...)` function
+ *     values inside `<style>` element text content (external stylesheet
+ *     / font / image loads) — see `sanitizeStyleText` below for why the
+ *     element itself is not dropped wholesale.
+ *   - `xmlns` / `xmlns:*` declarations on any non-root element (namespace
+ *     declarations only ever legitimately live on the root `<svg>`).
+ *   - Any root-level `xmlns:*` declaration other than a correctly-bound
+ *     `xmlns:xlink` (see `isEssentialRootNamespaceDeclaration`). These are
+ *     already functionally inert under the strict unprefixed-SVG-element
+ *     invariant enforced elsewhere in this file, but are dropped anyway
+ *     as defence-in-depth against relying on that invariant alone.
+ *   - `xml:base` on any element (root or descendant). Left in place, it
+ *     would silently change the base URI every *local-fragment* `href` /
+ *     `xlink:href` / `url(#id)` reference in its subtree resolves
+ *     against — turning an in-document `#id` reference into an external
+ *     `https://evil.example/#id` fetch some SVG consumers follow,
+ *     defeating the local-fragment-only guarantees above even though
+ *     every individual `href`/`url()` value still looks safe in
+ *     isolation.
+ *   - `ProcessingInstruction` nodes anywhere in the tree
+ *     (`<?xml-stylesheet ...?>` etc).
+ *   - `href` / `xlink:href` values that are not a local fragment
+ *     reference (`#id`) and not allowed by `policy.allowSafeHref`.
+ *     `javascript:`, `data:`, and protocol-relative (`//...`) values are
+ *     ALWAYS stripped regardless of policy.
+ *   - `url(...)` references inside SVG *presentation attributes* that
+ *     accept a `<FuncIRI>` (`fill`, `stroke`, `filter`, `clip-path`,
+ *     `mask`, `cursor`, `marker-start`, `marker-mid`, `marker-end`) when
+ *     the reference target is not a local fragment (`#id`) — e.g.
+ *     `fill="url(https://evil.example/paint.svg)"` or
+ *     `filter="url(data:image/svg+xml;base64,...)"`. These are the same
+ *     class of external-resource load as `href`/`style` but reachable via
+ *     a different attribute name, so they get the same href-style
+ *     drop-the-attribute treatment. `url(#localId)` references (the
+ *     normal way Mermaid/PlantUML wire arrowhead markers and gradients)
+ *     are always preserved.
+ *
+ * What is explicitly preserved:
+ *   - `href` / `xlink:href` local fragment references (`#id`) — legitimate
+ *     internal `<use>` / gradient / clip-path wiring.
+ *   - `https:` `href` values when `policy.allowSafeHref` is `true`.
+ *   - `url(#id)` local fragment references in presentation attributes
+ *     (`fill="url(#gradient)"`, `marker-end="url(#arrowhead)"`, ...).
+ *
+ * A parse failure (malformed XML) or a sanitized result whose root is not
+ * a single `<svg>` element both return `{ ok: false }` — callers must
+ * treat that as "invalid output" (spec §2 layer 2), never fall back to
+ * the unsanitized input.
+ */
+declare function sanitizeSvg(input: string, policy: SanitizeSvgPolicy): SanitizeSvgResult;
+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 PluginReadinessDeclaration, 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 SanitizeSvgPolicy, type SanitizeSvgResult, 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 StructuredRenderPayload, type UrlInlineExpansionRule, escapeHtml, extractSvgDimensions, getActionAnnotation, isSensitiveField, sanitizeSvg };

package/dist/index.d.ts CHANGED Viewed

@@ -477,8 +477,8 @@ type AuthVerifyResult = {
  * Auth provider driver. The login screen asks core for the list of
  * registered drivers and renders one button per driver
  * (`Sign in with Google`). Clicking redirects through the plugin's
- * registered routes (`/api/v2/plugins/<name>/oauth/start`); the
- * provider redirects back to `/api/v2/plugins/<name>/oauth/callback`,
+ * registered routes (`/api/plugins/<name>/oauth/start`); the
+ * provider redirects back to `/api/plugins/<name>/oauth/callback`,
  * which the plugin's contract handles.
  *
  * `verify` is the bridge: given whatever the plugin pulled out of the
@@ -872,9 +872,36 @@ interface EmbedInput {
  * background-refresh window (see
  * `packages/api/src/renderer/cache/index.ts:cachedRender`).
  */
+/**
+ * RFC-0023 (design doc §12) — the structured (typed) counterpart of a
+ * producer's `html` output. Additive and optional everywhere: a plugin
+ * that never sets it keeps today's behaviour byte-for-byte.
+ *
+ * `node` is the producer-shaped typed node (`type` selects the sidecar
+ * kind — `'crowiDiagram'` / `'crowiLinkCard'` / `'crowiPlaceholder'`).
+ * Deliberately loose (`Record<string, unknown>`) at this SDK layer:
+ * `@crowi/plugin-api` does not depend on `@crowi/api-contract`, so the
+ * authoritative shape lives in the api-contract sidecar schemas and the
+ * api-side dispatch mapper validates against them before stamping a
+ * sidecar onto the persisted AST (invalid payloads degrade to a plain
+ * `html` node, never poisoning what the web reads).
+ */
+interface StructuredRenderPayload {
+    node: Record<string, unknown>;
+}
 interface RenderResult {
-    /** Already-sanitised HTML the core will inline. */
+    /** Already-sanitised HTML the core will inline. Unchanged — the one and only web/legacy representation. */
     html: string;
+    /**
+     * RFC-0023 — optional structured payload paired with `html`. Both
+     * must describe the SAME render outcome: the dispatch layer stamps
+     * this (schema-validated) as a sidecar on the `html` node it splices,
+     * and the `X-Crowi-Ast-Version: 1` projection turns it into a typed
+     * node. On an `error` result, pair it with `errorHtml` when the
+     * error display carries real content (e.g. link-card's fallback
+     * card); leave it unset to get the generic structured placeholder.
+     */
+    structured?: StructuredRenderPayload;
     /**
      * Optional `<head>`-bound assets — Phase 4 records them on the
      * cache entry but the SSR layer does not yet inject them. Phase 7
@@ -993,6 +1020,8 @@ type InlineExpansion = {
 interface EmbedFragment {
     /** Pre-sanitised HTML fragment to inline at the source position. */
     html: string;
+    /** RFC-0023 — optional structured payload paired with `html` (see `RenderResult.structured`). */
+    structured?: StructuredRenderPayload;
     /** Optional `<head>`-bound assets (CSS / JS) keyed by URL. */
     assets?: {
         css?: string[];
@@ -1206,16 +1235,21 @@ interface RendererRegistry {
      * 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
+     * `registerRoutes` namespace — `/api/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 "不採用案").
+     * §2.1's "不採用案"). During the `feature-api-v2-path-removal`
+     * migration period the legacy `/api/v2/plugins/<name>/<…>` prefix is
+     * also accepted and silently normalised to the canonical `/api/plugins/`
+     * form before publication — a plugin package that hasn't bumped its own
+     * `addStylesheet(...)` call site yet still gets a working manifest
+     * entry; this dual-accept is transitional, not a permanent alias.
      *
      * The call only stages the path in a per-plugin pending set: it is
-     * published to the public `GET /api/v2/app/info` `rendererStylesheets`
+     * published to the public `GET /api/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
@@ -1266,7 +1300,7 @@ interface PluginRouteOptions {
 /**
  * Scope passed to `registerRoutes(scope, ctx)`. Lets a plugin contribute
  * HTTP routes that the runtime mounts at
- * `/api/v2/plugins/<plugin-name>/<path>` — the `<plugin-name>` path
+ * `/api/plugins/<plugin-name>/<path>` — the `<plugin-name>` path
  * segment guarantees that core endpoints and other plugins cannot
  * collide (RFC-0013 §4).
  *
@@ -1277,9 +1311,9 @@ interface PluginRouteOptions {
 interface PluginRouterScope {
     /**
      * Mount `handler` for `method` at `<path>` under this plugin's
-     * namespace. `path` is relative to `/api/v2/plugins/<plugin-name>` and
+     * namespace. `path` is relative to `/api/plugins/<plugin-name>` and
      * should start with `/` (e.g. `route('POST', '/events', handler, {
-     * auth: 'public' })` → `POST /api/v2/plugins/<name>/events`).
+     * auth: 'public' })` → `POST /api/plugins/<name>/events`).
      *
      * Pass `{ auth: 'public' }` to bypass Crowi auth entirely for self-
      * authenticating inbound webhooks, `{ auth: 'admin' }` to require
@@ -1289,6 +1323,32 @@ interface PluginRouterScope {
     route(method: PluginRouteMethod, path: string, handler: PluginRouteHandler, opts?: PluginRouteOptions): void;
 }
+/**
+ * Declares that, when a specific driver from a specific registry is
+ * selected (`crowi.config.json:<registry>.driver === driver`), this
+ * plugin's own config becomes required to actually work at runtime —
+ * even though the `configSchema` field itself is optional / defaults to
+ * `''` so `configSchema.parse()` alone can't detect "present but
+ * unusable" (see `@crowi/plugin-storage-aws-s3`'s `bucket` and
+ * `@crowi/plugin-search-elasticsearch` / `@crowi/plugin-search-opensearch`'s
+ * `url`, both `z.string().default('')`).
+ *
+ * This is metadata only — it never carries an actual config value.
+ * `registry` / `driver` / every name in `requiredConfigFields` must be
+ * non-empty. The runtime (`PluginManager.getReadinessIssues()`) reads
+ * this once per admin readiness check, cross-references it against the
+ * currently selected driver and the plugin's current config namespace,
+ * and reports which declared fields are still empty — never the values
+ * themselves. See RFC-none / feature-plugin-config-readiness.
+ */
+interface PluginReadinessDeclaration {
+    /** Which driver registry this declaration is scoped to. */
+    registry: 'storage' | 'search' | 'mail';
+    /** The driver name (as registered via `registry.register(name, …)`) this declaration applies to. */
+    driver: string;
+    /** `configSchema` field names that must be non-empty for `driver` to actually work once selected. */
+    requiredConfigFields: string[];
+}
 /**
  * The contract every Crowi plugin satisfies. Plugins export their
  * `CrowiPlugin` object as the package's default export; the runtime
@@ -1423,6 +1483,14 @@ interface CrowiPlugin {
         label?: string;
         description?: string;
     }>>;
+    /**
+     * Declares which of this plugin's own `configSchema` fields must be
+     * non-empty for a specific driver selection to actually work at
+     * runtime (see {@link PluginReadinessDeclaration}). Optional — a
+     * plugin with no readiness declaration is never surfaced by the
+     * admin readiness check, same as before this field existed.
+     */
+    readiness?: PluginReadinessDeclaration;
     /** Storage driver registration. Called once at boot. */
     registerStorage?: (registry: StorageRegistry, ctx: PluginContext) => void;
     /** Search backend registration. Called once at boot. */
@@ -1453,7 +1521,7 @@ interface CrowiPlugin {
     registerHooks?: (events: EventBus, ctx: PluginContext) => void;
     /**
      * HTTP routes the plugin contributes, mounted at
-     * `/api/v2/plugins/<name>/<path>` (the `<name>` path segment guarantees
+     * `/api/plugins/<name>/<path>` (the `<name>` path segment guarantees
      * that core endpoints and other plugins cannot collide). Used for
      * inbound webhooks (Slack events / slash / interactivity), "Test
      * connection" buttons, `@action` targets, OAuth callbacks, etc.
@@ -1533,7 +1601,7 @@ declare const SENSITIVE_FIELD_MARKER = "@sensitive";
  *
  * The admin form renders a button with the given label that calls the
  * plugin's contributed endpoint at the given verb / path (relative to
- * `/api/v2/plugins/<name>/`). Useful for "Test connection",
+ * `/api/plugins/<name>/`). Useful for "Test connection",
  * "Authorise with Google", etc. without forcing every plugin to ship
  * its own React component.
  */
@@ -1553,7 +1621,7 @@ interface ActionAnnotation {
     label: string;
     /** HTTP verb of the plugin endpoint to call. */
     method: PluginRouteMethod;
-    /** Path relative to `/api/v2/plugins/<name>/`, with leading slash. */
+    /** Path relative to `/api/plugins/<name>/`, with leading slash. */
     path: string;
 }
 /**
@@ -1573,4 +1641,126 @@ interface ActionAnnotation {
  */
 declare function getActionAnnotation(field: z.ZodTypeAny): ActionAnnotation | null;
-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 };
+/**
+ * Parses a root `<svg>` element's `viewBox` (`minX minY width height`) to
+ * derive intrinsic pixel dimensions. Shared by
+ * `@crowi/plugin-renderer-mermaid` (its original home — the `<img>`
+ * `width`/`height` intrinsic-size fix) and, since RFC-0023,
+ * `@crowi/plugin-renderer-plantuml`'s SVG sidecar path — both need the
+ * same derivation and both already bundle this package, so it lives
+ * here rather than being copied per plugin.
+ *
+ * Reads attributes off the sanitized SVG source string only — never
+ * decodes any `data:` payload.
+ */
+declare function extractSvgDimensions(svg: string): {
+    width: number;
+    height: number;
+} | null;
+/**
+ * Renderer-specific knobs for `sanitizeSvg`. The sanitizer itself is a
+ * single shared implementation (`sanitize.ts`) — per-renderer differences
+ * are expressed as parameters here, never as a second copy of the DOM
+ * walk (spec §9: "実装自体をrenderer間で複製しない").
+ */
+interface SanitizeSvgPolicy {
+    /**
+     * When `true`, `href` / `xlink:href` values pointing at an `https:`
+     * URL are preserved (PlantUML's existing "preserves href to a safe
+     * URL" behaviour, consumed starting Phase 3). When `false`, every
+     * `href` / `xlink:href` is stripped unless it is a local fragment
+     * reference (`#id`) — Mermaid's strict policy (spec §1 layer 1 already
+     * disables Mermaid's own click callbacks, so no link should survive
+     * either).
+     *
+     * Regardless of this flag, `javascript:`, `data:`, and
+     * protocol-relative (`//host/...`) URLs are ALWAYS stripped — no
+     * policy may re-allow those.
+     */
+    allowSafeHref: boolean;
+}
+type SanitizeSvgResult = {
+    ok: true;
+    svg: string;
+} | {
+    ok: false;
+    reason: string;
+};
+/**
+ * DOM-based SVG sanitizer shared by `@crowi/plugin-renderer-mermaid` and
+ * (from Phase 3) `@crowi/plugin-renderer-plantuml`. Spec §2 layer 2 / §9.
+ *
+ * Design: allowlist-first for elements (unknown/unexpected element names
+ * are dropped with their whole subtree — safer than trying to enumerate
+ * every dangerous tag), then a small set of attribute-level rules that
+ * apply uniformly to every surviving element. This is a from-scratch DOM
+ * walk, not a regex pass (`packages/plugin-renderer-plantuml/src/
+ * sanitize.ts`'s existing implementation is explicitly documented there
+ * as "not a substitute for DOMPurify" — this package is the replacement
+ * both renderers converge on, PlantUML starting Phase 3).
+ *
+ * What gets removed:
+ *   - Any element not in `ALLOWED_ELEMENTS` (`script`, `foreignObject`,
+ *     `iframe`, `object`, `embed`, SMIL `animate*`/`set`/`discard`, ...) —
+ *     dropped together with its entire subtree.
+ *   - `on*` event-handler attributes (any casing).
+ *   - The `style` attribute (inline styles). Mermaid/PlantUML's real
+ *     styling lives in the `<style>` *element* (class-based), which is
+ *     sanitized separately below rather than dropped — dropping inline
+ *     `style=""` is a deliberate hardening tradeoff (removes a CSS-value
+ *     injection vector) the regression tests confirm does not break
+ *     either renderer's *structural* output.
+ *   - `@import` at-rules and non-local-fragment `url(...)` function
+ *     values inside `<style>` element text content (external stylesheet
+ *     / font / image loads) — see `sanitizeStyleText` below for why the
+ *     element itself is not dropped wholesale.
+ *   - `xmlns` / `xmlns:*` declarations on any non-root element (namespace
+ *     declarations only ever legitimately live on the root `<svg>`).
+ *   - Any root-level `xmlns:*` declaration other than a correctly-bound
+ *     `xmlns:xlink` (see `isEssentialRootNamespaceDeclaration`). These are
+ *     already functionally inert under the strict unprefixed-SVG-element
+ *     invariant enforced elsewhere in this file, but are dropped anyway
+ *     as defence-in-depth against relying on that invariant alone.
+ *   - `xml:base` on any element (root or descendant). Left in place, it
+ *     would silently change the base URI every *local-fragment* `href` /
+ *     `xlink:href` / `url(#id)` reference in its subtree resolves
+ *     against — turning an in-document `#id` reference into an external
+ *     `https://evil.example/#id` fetch some SVG consumers follow,
+ *     defeating the local-fragment-only guarantees above even though
+ *     every individual `href`/`url()` value still looks safe in
+ *     isolation.
+ *   - `ProcessingInstruction` nodes anywhere in the tree
+ *     (`<?xml-stylesheet ...?>` etc).
+ *   - `href` / `xlink:href` values that are not a local fragment
+ *     reference (`#id`) and not allowed by `policy.allowSafeHref`.
+ *     `javascript:`, `data:`, and protocol-relative (`//...`) values are
+ *     ALWAYS stripped regardless of policy.
+ *   - `url(...)` references inside SVG *presentation attributes* that
+ *     accept a `<FuncIRI>` (`fill`, `stroke`, `filter`, `clip-path`,
+ *     `mask`, `cursor`, `marker-start`, `marker-mid`, `marker-end`) when
+ *     the reference target is not a local fragment (`#id`) — e.g.
+ *     `fill="url(https://evil.example/paint.svg)"` or
+ *     `filter="url(data:image/svg+xml;base64,...)"`. These are the same
+ *     class of external-resource load as `href`/`style` but reachable via
+ *     a different attribute name, so they get the same href-style
+ *     drop-the-attribute treatment. `url(#localId)` references (the
+ *     normal way Mermaid/PlantUML wire arrowhead markers and gradients)
+ *     are always preserved.
+ *
+ * What is explicitly preserved:
+ *   - `href` / `xlink:href` local fragment references (`#id`) — legitimate
+ *     internal `<use>` / gradient / clip-path wiring.
+ *   - `https:` `href` values when `policy.allowSafeHref` is `true`.
+ *   - `url(#id)` local fragment references in presentation attributes
+ *     (`fill="url(#gradient)"`, `marker-end="url(#arrowhead)"`, ...).
+ *
+ * A parse failure (malformed XML) or a sanitized result whose root is not
+ * a single `<svg>` element both return `{ ok: false }` — callers must
+ * treat that as "invalid output" (spec §2 layer 2), never fall back to
+ * the unsanitized input.
+ */
+declare function sanitizeSvg(input: string, policy: SanitizeSvgPolicy): SanitizeSvgResult;
+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 PluginReadinessDeclaration, 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 SanitizeSvgPolicy, type SanitizeSvgResult, 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 StructuredRenderPayload, type UrlInlineExpansionRule, escapeHtml, extractSvgDimensions, getActionAnnotation, isSensitiveField, sanitizeSvg };

package/dist/index.js CHANGED Viewed

@@ -23,8 +23,10 @@ __export(index_exports, {
   ACTION_FIELD_MARKER: () => ACTION_FIELD_MARKER,
   SENSITIVE_FIELD_MARKER: () => SENSITIVE_FIELD_MARKER,
   escapeHtml: () => escapeHtml,
+  extractSvgDimensions: () => extractSvgDimensions,
   getActionAnnotation: () => getActionAnnotation,
-  isSensitiveField: () => isSensitiveField
+  isSensitiveField: () => isSensitiveField,
+  sanitizeSvg: () => sanitizeSvg
 });
 module.exports = __toCommonJS(index_exports);
@@ -66,12 +68,215 @@ function getActionAnnotation(field) {
   const [, label, method, path] = match;
   return { label, method, path };
 }
+// ../svg-sanitize/dist/index.mjs
+var import_xmldom = require("@xmldom/xmldom");
+var MAX_DIMENSION_PX = 1e6;
+function extractSvgDimensions(svg) {
+  const match = /\bviewBox\s*=\s*["']\s*([-\d.]+)[\s,]+([-\d.]+)[\s,]+([-\d.]+)[\s,]+([-\d.]+)\s*["']/.exec(svg);
+  if (!match) return null;
+  const width = Math.round(Number(match[3]));
+  const height = Math.round(Number(match[4]));
+  if (!Number.isFinite(width) || !Number.isFinite(height)) return null;
+  if (width <= 0 || height <= 0 || width > MAX_DIMENSION_PX || height > MAX_DIMENSION_PX) return null;
+  return { width, height };
+}
+function sanitizeSvg(input, policy) {
+  const doc = parseXml(input);
+  if (!doc) return { ok: false, reason: "malformed_xml" };
+  if (doc.doctype) {
+    return { ok: false, reason: "doctype_not_allowed" };
+  }
+  const root = doc.documentElement;
+  if (!isUnprefixedSvgElement(root)) {
+    return { ok: false, reason: "root_is_not_svg" };
+  }
+  sanitizeElementTree(root, policy, true);
+  const serializer = new import_xmldom.XMLSerializer();
+  const serialized = serializer.serializeToString(root);
+  const verifyDoc = parseXml(serialized);
+  if (!verifyDoc || !isUnprefixedSvgElement(verifyDoc.documentElement)) {
+    return { ok: false, reason: "sanitized_output_not_single_root_svg" };
+  }
+  return { ok: true, svg: serialized };
+}
+var SVG_NAMESPACE_URI = "http://www.w3.org/2000/svg";
+var XML_NAMESPACE_URI = "http://www.w3.org/XML/1998/namespace";
+var XLINK_NAMESPACE_URI = "http://www.w3.org/1999/xlink";
+function isSvgNamespaceElement(el) {
+  return el.namespaceURI === SVG_NAMESPACE_URI && el.prefix == null;
+}
+function isUnprefixedSvgElement(el) {
+  return el != null && el.localName === "svg" && isSvgNamespaceElement(el);
+}
+function parseXml(source) {
+  try {
+    return new import_xmldom.DOMParser({ onError: () => void 0 }).parseFromString(source, "image/svg+xml");
+  } catch {
+    return null;
+  }
+}
+var ALLOWED_ELEMENTS = /* @__PURE__ */ new Set([
+  "svg",
+  "g",
+  "defs",
+  "symbol",
+  "use",
+  "title",
+  "desc",
+  "metadata",
+  "path",
+  "rect",
+  "circle",
+  "ellipse",
+  "line",
+  "polyline",
+  "polygon",
+  "text",
+  "tspan",
+  "textPath",
+  "tref",
+  "marker",
+  "clipPath",
+  "mask",
+  "pattern",
+  "linearGradient",
+  "radialGradient",
+  "stop",
+  "image",
+  "style",
+  "a",
+  "switch",
+  "filter",
+  "feGaussianBlur",
+  "feOffset",
+  "feMerge",
+  "feMergeNode",
+  "feColorMatrix",
+  "feComposite",
+  "feFlood",
+  "feBlend",
+  "feDropShadow",
+  "feMorphology",
+  "feTurbulence",
+  "feDisplacementMap"
+]);
+var PROCESSING_INSTRUCTION_NODE = 7;
+var ELEMENT_NODE = 1;
+function sanitizeElementTree(el, policy, isRoot) {
+  sanitizeAttributes(el, policy, isRoot);
+  if (el.localName === "style") {
+    el.textContent = sanitizeStyleText(el.textContent ?? "");
+    return;
+  }
+  for (const child of Array.from(el.childNodes)) {
+    if (child.nodeType === PROCESSING_INSTRUCTION_NODE) {
+      el.removeChild(child);
+      continue;
+    }
+    if (child.nodeType !== ELEMENT_NODE) continue;
+    const childEl = child;
+    if (!isSvgNamespaceElement(childEl) || !ALLOWED_ELEMENTS.has(childEl.localName ?? childEl.nodeName)) {
+      el.removeChild(childEl);
+      continue;
+    }
+    sanitizeElementTree(childEl, policy, false);
+  }
+}
+function sanitizeAttributes(el, policy, isRoot) {
+  for (const attr of Array.from(el.attributes)) {
+    const localName = attr.localName ?? attr.name;
+    if (/^on/i.test(localName)) {
+      el.removeAttributeNode(attr);
+      continue;
+    }
+    if (localName === "style") {
+      el.removeAttributeNode(attr);
+      continue;
+    }
+    if (localName === "base" && attr.namespaceURI === XML_NAMESPACE_URI) {
+      el.removeAttributeNode(attr);
+      continue;
+    }
+    if (localName === "href") {
+      const sanitizedValue = sanitizeHrefValue(attr.value, policy);
+      if (sanitizedValue === null) {
+        el.removeAttributeNode(attr);
+      } else {
+        attr.value = sanitizedValue;
+      }
+      continue;
+    }
+    if (URL_VALUED_PRESENTATION_ATTRS.has(localName)) {
+      if (!isUrlFuncIriSafe(attr.value)) {
+        el.removeAttributeNode(attr);
+      }
+      continue;
+    }
+    if (attr.name === "xmlns" || attr.name.startsWith("xmlns:")) {
+      if (!isRoot || !isEssentialRootNamespaceDeclaration(attr)) {
+        el.removeAttributeNode(attr);
+      }
+    }
+  }
+}
+function isEssentialRootNamespaceDeclaration(attr) {
+  if (attr.name === "xmlns") return true;
+  return attr.name === "xmlns:xlink" && attr.value === XLINK_NAMESPACE_URI;
+}
+var URL_VALUED_PRESENTATION_ATTRS = /* @__PURE__ */ new Set([
+  "fill",
+  "stroke",
+  "filter",
+  "clip-path",
+  "mask",
+  "cursor",
+  "marker",
+  "marker-start",
+  "marker-mid",
+  "marker-end"
+]);
+var URL_FUNC_PATTERN = /url\(\s*(['"]?)([^'")]*)\1\s*\)/gi;
+function isUrlFuncIriSafe(rawValue) {
+  const matches = Array.from(cssUnescape(rawValue).matchAll(URL_FUNC_PATTERN));
+  if (matches.length === 0) return true;
+  return matches.every(([, , target]) => target.trim().startsWith("#"));
+}
+function sanitizeHrefValue(rawValue, policy) {
+  const value = rawValue.trim();
+  if (value.startsWith("#")) return value;
+  if (/^javascript:/i.test(value)) return null;
+  if (/^data:/i.test(value)) return null;
+  if (value.startsWith("//")) return null;
+  if (policy.allowSafeHref && /^https:\/\//i.test(value)) return value;
+  return null;
+}
+function sanitizeStyleText(css) {
+  const withoutComments = css.replace(/\/\*[\s\S]*?\*\//g, " ");
+  let out = cssUnescape(withoutComments);
+  out = out.replace(/@import\b[^;]*;?/gi, "");
+  out = out.replace(URL_FUNC_PATTERN, (match, _quote, target) => target.trim().startsWith("#") ? match : "none");
+  return out;
+}
+function cssUnescape(css) {
+  return css.replace(/\\([0-9a-fA-F]{1,6})[ \t\n\f\r]?|\\([^\r\n\f])|\\$/g, (_match, hex, literal) => {
+    if (hex !== void 0) {
+      const codePoint = Number.parseInt(hex, 16);
+      if (codePoint === 0 || codePoint > 1114111 || codePoint >= 55296 && codePoint <= 57343) return "\uFFFD";
+      return String.fromCodePoint(codePoint);
+    }
+    if (literal !== void 0) return literal;
+    return "\uFFFD";
+  });
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ACTION_FIELD_MARKER,
   SENSITIVE_FIELD_MARKER,
   escapeHtml,
+  extractSvgDimensions,
   getActionAnnotation,
-  isSensitiveField
+  isSensitiveField,
+  sanitizeSvg
 });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/index.ts","../src/html.ts","../src/schema-markers.ts"],"~~sourcesContent":["/*\n @crowi/plugin~~-~~api — type-only contract for Crowi 2.0 plugins.\n \n Plugins author against this package. The runtime (@crowi~~/server) loads\n * plugins listed in `crowi.config.json`, calls each plugin's\n * `register` callbacks, and routes all the side effects (storage,\n search, auth, notifications) through the typed registries declared\n * here.\n \n For the design rationale see `docs/~~rfcs/0001-plugin-architecture~~.md`\n * in the Crowi monorepo.\n /\n\nexport type { AppInfo, PageMetadataAccessor, PluginContext, PluginLogger, StateCell } from './context';\nexport type { EventBus, PluginEvents } from './events';\nexport { escapeHtml } from './html';\nexport type { CrowiPlugin } from './plugin';\n\nexport type { AuthDriver, AuthProfile, AuthRegistry, AuthVerifyResult } from './registries/auth';\nexport type { EmailMessage, MailSender, MailSenderRegistry } from './registries/mail';\nexport type { NotificationPayload, NotifierDriver, NotifierRegistry } from './registries/notifier';\nexport type {\n SearchableDoc,\n SearchDriver,\n SearchHit,\n SearchHits,\n SearchPageType,\n SearchQuery,\n SearchQueryGrants,\n SearchQueryViewer,\n SearchRegistry,\n} from './registries/search';\nexport type { StorageDriver, StoragePutMeta, StoragePutResult, StorageRegistry } from './registries/storage';\nexport type {\n AdmissionControlConfig,\n AuthContext,\n CacheEntry,\n CacheKey,\n CacheStorage,\n CodeBlockInfo,\n CodeBlockRenderer,\n EmbedFragment,\n EmbedInput,\n EmbedRenderer,\n InlineExpansion,\n NodeRenderer,\n RenderActor,\n RenderContext,\n RenderError,\n RendererRegistry,\n RenderPhase,\n RenderResult,\n Reservation,\n ScopedCacheStorage,\n UrlInlineExpansionRule,\n} from './renderer';\nexport type { PluginRouteHandler, PluginRouteMethod, PluginRouteOptions, PluginRouterScope } from './routes';\nexport { ACTION_FIELD_MARKER, getActionAnnotation, isSensitiveField, SENSITIVE_FIELD_MARKER } from './schema-markers';\n","~~/\n HTML~~-emitting helper for renderer plugins.\n \n A renderer plugin that builds HTML from author-controlled or external\n * strings (an OGP title, a math error message, …) must escape them, and\n * that escape is a security primitive — a hardening change has to reach\n * every plugin at once, not whichever local copies someone remembers.\n * This is the SDK's single copy (`@crowi/~~plugin-renderer-katex` and\n * `@crowi~~/plugin-renderer-link-card` each carried an identical local one\n * before it was hoisted here).\n /\n\n/* Escape `&` `<` `>` `\"` `'` for interpolation into HTML text or double/single-quoted attribute values. /\nexport function escapeHtml(s: string): string {\n return s.replace(/[&<>\"']/g, (c) => {\n switch (c) {\n case '&':\n return '&';\n case '<':\n return '<';\n case '>':\n return '>';\n case '\"':\n return '"';\n case \"'\":\n return ''';\n default:\n return c;\n }\n });\n}\n","import type { z } from 'zod/v3';\n\nimport type { PluginRouteMethod } from './routes';\n\n/\n `configSchema` description-string markers.\n \n The admin UI walks the schema and looks at each field's\n * `description` (set via `z.string().describe('@sensitive ...')`). A\n * description starting with one of these marker tokens unlocks special\n * UI behaviour without forcing every field to declare a custom Zod\n * type.\n /\n\n/\n Marker that flags a config field as sensitive (encrypted at rest).\n * Usage:\n \n z.string().describe('@sensitive AWS secret access key')\n \n The runtime auto-encrypts on write and decrypts on read, using the\n * same KeyProvider as core sensitive Config. The admin UI renders the\n * field via `<SecretField>` (saved badge / clear pending / undo).\n /\nexport const SENSITIVE_FIELD_MARKER = '@sensitive';\n\n/\n Marker that adds an action button next to a config field. Usage:\n \n z.string().describe('@action \"Test connection\" POST /test')\n \n The admin form renders a button with the given label that calls the\n * plugin's contributed endpoint at the given verb / path (relative to\n * `/api/v2/plugins/<name>/`). Useful for \"Test connection\",\n * \"Authorise with Google\", etc. without forcing every plugin to ship\n * its own React component.\n /\nexport const ACTION_FIELD_MARKER = '@action';\n\n/\n True if the schema field is marked `@sensitive`.\n \n `field` is `z.ZodTypeAny` (intentionally loose); call sites pass the\n * value type from `configSchema.shape[key]`.\n /\nexport function isSensitiveField(field: z.ZodTypeAny): boolean {\n const description = field.description;\n return typeof description === 'string' && description.trimStart().startsWith(SENSITIVE_FIELD_MARKER);\n}\n\n/\n Parsed `@action` annotation extracted from a field's `description`.\n /\nexport interface ActionAnnotation {\n /* Visible button label, e.g. \"Test connection\". /\n label: string;\n /* HTTP verb of the plugin endpoint to call. /\n method: PluginRouteMethod;\n /* Path relative to `/api/v2/plugins/<name>/`, with leading slash. /\n path: string;\n}\n\n/\n Parse an `@action` annotation off a field, or return null if absent.\n \n Format: `@action \"<label>\" <METHOD> <path>`\n * e.g. `@action \"Test connection\" POST /test`\n \n The label may include spaces when wrapped in double quotes; the method\n * must be one of `PluginRouteMethod` (`GET` / `POST` — the only verbs a\n * plugin route can actually be mounted on, see `routes.ts`); the path\n * begins with `/`. A description that starts with the `@action` marker\n * but declares an unsupported verb (e.g. `PUT` / `DELETE`) fails to match\n * and returns `null` here — callers that walk a plugin's `configSchema`\n * (e.g. `PluginManager.activate()`) are expected to warn on that case at\n * boot, since it would otherwise be a silent dead button.\n /\nexport function getActionAnnotation(field: z.ZodTypeAny): ActionAnnotation \| null {\n const description = field.description;\n if (typeof description !== 'string') return null;\n const trimmed = description.trimStart();\n if (!trimmed.startsWith(ACTION_FIELD_MARKER)) return null;\n\n const rest = trimmed.slice(ACTION_FIELD_MARKER.length).trimStart();\n // `\"~~<label>\" <METHOD> <path>`\n const match = rest.match(/^\"([^\"~~]~~+)\"\\s+(GET\|POST)\\s+(\\/\\S)/);\n if (!match) return null;\n\n const [~~, ~~label, method, path] = match;\n return { label, method: method as ActionAnnotation['method'], path };\n}\n~~"~~],"~~mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACaO,SAAS,WAAW,GAAmB;AAC5C,SAAO,EAAE,QAAQ,YAAY,CAAC,MAAM;AAClC,YAAQ,GAAG;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT;AACE,eAAO;AAAA,IACX;AAAA,EACF,CAAC;AACH;;;ACNO,IAAM,yBAAyB;AAa/B,IAAM,sBAAsB;AAQ5B,SAAS,iBAAiB,OAA8B;AAC7D,QAAM,cAAc,MAAM;AAC1B,SAAO,OAAO,gBAAgB,YAAY,YAAY,UAAU,EAAE,WAAW,sBAAsB;AACrG;AA6BO,SAAS,oBAAoB,OAA8C;AAChF,QAAM,cAAc,MAAM;AAC1B,MAAI,OAAO,gBAAgB,SAAU,QAAO;AAC5C,QAAM,UAAU,YAAY,UAAU;AACtC,MAAI,CAAC,QAAQ,WAAW,mBAAmB,EAAG,QAAO;AAErD,QAAM,OAAO,QAAQ,MAAM,oBAAoB,MAAM,EAAE,UAAU;AAEjE,QAAM,QAAQ,KAAK,MAAM,mCAAmC;AAC5D,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,CAAC,EAAE,OAAO,QAAQ,IAAI,IAAI;AAChC,SAAO,EAAE,OAAO,QAA8C,KAAK;AACrE;","names":[]}
1	+ {"version":3,"sources":["../src/index.ts","../src/html.ts","../src/schema-markers.ts","../../svg-sanitize/src/dimensions.ts","../../svg-sanitize/src/sanitize.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACaO,SAAS,WAAW,GAAmB;AAC5C,SAAO,EAAE,QAAQ,YAAY,CAAC,MAAM;AAClC,YAAQ,GAAG;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT;AACE,eAAO;AAAA,IACX;AAAA,EACF,CAAC;AACH;;;ACNO,IAAM,yBAAyB;AAa/B,IAAM,sBAAsB;AAQ5B,SAAS,iBAAiB,OAA8B;AAC7D,QAAM,cAAc,MAAM;AAC1B,SAAO,OAAO,gBAAgB,YAAY,YAAY,UAAU,EAAE,WAAW,sBAAsB;AACrG;AA6BO,SAAS,oBAAoB,OAA8C;AAChF,QAAM,cAAc,MAAM;AAC1B,MAAI,OAAO,gBAAgB,SAAU,QAAO;AAC5C,QAAM,UAAU,YAAY,UAAU;AACtC,MAAI,CAAC,QAAQ,WAAW,mBAAmB,EAAG,QAAO;AAErD,QAAM,OAAO,QAAQ,MAAM,oBAAoB,MAAM,EAAE,UAAU;AAEjE,QAAM,QAAQ,KAAK,MAAM,mCAAmC;AAC5D,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,CAAC,EAAE,OAAO,QAAQ,IAAI,IAAI;AAChC,SAAO,EAAE,OAAO,QAA8C,KAAK;AACrE;;;AEzFA,oBAAyC;ADqBzC,IAAM,mBAAmB;AAElB,SAAS,qBAAqB,KAAuD;AAC1F,QAAM,QAAQ,uFAAuF,KAAK,GAAG;AAC7G,MAAI,CAAC,MAAO,QAAO;AACnB,QAAM,QAAQ,KAAK,MAAM,OAAO,MAAM,CAAC,CAAC,CAAC;AACzC,QAAM,SAAS,KAAK,MAAM,OAAO,MAAM,CAAC,CAAC,CAAC;AAC1C,MAAI,CAAC,OAAO,SAAS,KAAK,KAAK,CAAC,OAAO,SAAS,MAAM,EAAG,QAAO;AAChE,MAAI,SAAS,KAAK,UAAU,KAAK,QAAQ,oBAAoB,SAAS,iBAAkB,QAAO;AAC/F,SAAO,EAAE,OAAO,OAAO;AACzB;AC+CO,SAAS,YAAY,OAAe,QAA8C;AACvF,QAAM,MAAM,SAAS,KAAK;AAC1B,MAAI,CAAC,IAAK,QAAO,EAAE,IAAI,OAAO,QAAQ,gBAAgB;AAEtD,MAAI,IAAI,SAAS;AAKf,WAAO,EAAE,IAAI,OAAO,QAAQ,sBAAsB;EACpD;AACA,QAAM,OAAO,IAAI;AACjB,MAAI,CAAC,uBAAuB,IAAI,GAAG;AACjC,WAAO,EAAE,IAAI,OAAO,QAAQ,kBAAkB;EAChD;AAEA,sBAAoB,MAAM,QAAQ,IAAI;AAEtC,QAAM,aAAa,IAAI,4BAAc;AACrC,QAAM,aAAa,WAAW,kBAAkB,IAAI;AAOpD,QAAM,YAAY,SAAS,UAAU;AACrC,MAAI,CAAC,aAAa,CAAC,uBAAuB,UAAU,eAAe,GAAG;AACpE,WAAO,EAAE,IAAI,OAAO,QAAQ,uCAAuC;EACrE;AAEA,SAAO,EAAE,IAAI,MAAM,KAAK,WAAW;AACrC;AAEA,IAAM,oBAAoB;AAW1B,IAAM,oBAAoB;AAU1B,IAAM,sBAAsB;AAgB5B,SAAS,sBAAsB,IAAsB;AACnD,SAAO,GAAG,iBAAiB,qBAAqB,GAAG,UAAU;AAC/D;AAUA,SAAS,uBAAuB,IAA+C;AAC7E,SAAO,MAAM,QAAQ,GAAG,cAAc,SAAS,sBAAsB,EAAE;AACzE;AAWA,SAAS,SAAS,QAAgB;AAChC,MAAI;AACF,WAAO,IAAI,wBAAU,EAAE,SAAS,MAAM,OAAU,CAAC,EAAE,gBAAgB,QAAQ,eAAe;EAC5F,QAAQ;AACN,WAAO;EACT;AACF;AAWA,IAAM,mBAAmB,oBAAI,IAAI;EAC/B;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;AACF,CAAC;AAED,IAAM,8BAA8B;AACpC,IAAM,eAAe;AAErB,SAAS,oBAAoB,IAAa,QAA2B,QAAuB;AAC1F,qBAAmB,IAAI,QAAQ,MAAM;AAErC,MAAI,GAAG,cAAc,SAAS;AAG5B,OAAG,cAAc,kBAAkB,GAAG,eAAe,EAAE;AACvD;EACF;AAEA,aAAW,SAAS,MAAM,KAAK,GAAG,UAAU,GAAG;AAC7C,QAAI,MAAM,aAAa,6BAA6B;AAClD,SAAG,YAAY,KAAK;AACpB;IACF;AACA,QAAI,MAAM,aAAa,aAAc;AACrC,UAAM,UAAU;AAMhB,QAAI,CAAC,sBAAsB,OAAO,KAAK,CAAC,iBAAiB,IAAI,QAAQ,aAAa,QAAQ,QAAQ,GAAG;AACnG,SAAG,YAAY,OAAO;AACtB;IACF;AACA,wBAAoB,SAAS,QAAQ,KAAK;EAC5C;AACF;AAEA,SAAS,mBAAmB,IAAa,QAA2B,QAAuB;AACzF,aAAW,QAAQ,MAAM,KAAK,GAAG,UAAU,GAAG;AAC5C,UAAM,YAAY,KAAK,aAAa,KAAK;AACzC,QAAI,OAAO,KAAK,SAAS,GAAG;AAC1B,SAAG,oBAAoB,IAAI;AAC3B;IACF;AACA,QAAI,cAAc,SAAS;AACzB,SAAG,oBAAoB,IAAI;AAC3B;IACF;AACA,QAAI,cAAc,UAAU,KAAK,iBAAiB,mBAAmB;AAcnE,SAAG,oBAAoB,IAAI;AAC3B;IACF;AACA,QAAI,cAAc,QAAQ;AACxB,YAAM,iBAAiB,kBAAkB,KAAK,OAAO,MAAM;AAC3D,UAAI,mBAAmB,MAAM;AAC3B,WAAG,oBAAoB,IAAI;MAC7B,OAAO;AACL,aAAK,QAAQ;MACf;AACA;IACF;AACA,QAAI,8BAA8B,IAAI,SAAS,GAAG;AAChD,UAAI,CAAC,iBAAiB,KAAK,KAAK,GAAG;AACjC,WAAG,oBAAoB,IAAI;MAC7B;AACA;IACF;AACA,QAAI,KAAK,SAAS,WAAW,KAAK,KAAK,WAAW,QAAQ,GAAG;AAC3D,UAAI,CAAC,UAAU,CAAC,oCAAoC,IAAI,GAAG;AACzD,WAAG,oBAAoB,IAAI;MAC7B;IACF;EACF;AACF;AAoBA,SAAS,oCAAoC,MAAqB;AAChE,MAAI,KAAK,SAAS,QAAS,QAAO;AAClC,SAAO,KAAK,SAAS,iBAAiB,KAAK,UAAU;AACvD;AAQA,IAAM,gCAAgC,oBAAI,IAAI;EAC5C;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;AACF,CAAC;AAED,IAAM,mBAAmB;AAWzB,SAAS,iBAAiB,UAA2B;AAOnD,QAAM,UAAU,MAAM,KAAK,YAAY,QAAQ,EAAE,SAAS,gBAAgB,CAAC;AAC3E,MAAI,QAAQ,WAAW,EAAG,QAAO;AACjC,SAAO,QAAQ,MAAM,CAAC,CAAC,EAAE,EAAE,MAAM,MAAM,OAAO,KAAK,EAAE,WAAW,GAAG,CAAC;AACtE;AAGA,SAAS,kBAAkB,UAAkB,QAA0C;AACrF,QAAM,QAAQ,SAAS,KAAK;AAC5B,MAAI,MAAM,WAAW,GAAG,EAAG,QAAO;AAClC,MAAI,gBAAgB,KAAK,KAAK,EAAG,QAAO;AACxC,MAAI,UAAU,KAAK,KAAK,EAAG,QAAO;AAClC,MAAI,MAAM,WAAW,IAAI,EAAG,QAAO;AACnC,MAAI,OAAO,iBAAiB,eAAe,KAAK,KAAK,EAAG,QAAO;AAC/D,SAAO;AACT;AA6CA,SAAS,kBAAkB,KAAqB;AAM9C,QAAM,kBAAkB,IAAI,QAAQ,qBAAqB,GAAG;AAC5D,MAAI,MAAM,YAAY,eAAe;AACrC,QAAM,IAAI,QAAQ,sBAAsB,EAAE;AAC1C,QAAM,IAAI,QAAQ,kBAAkB,CAAC,OAAO,QAAQ,WAAY,OAAO,KAAK,EAAE,WAAW,GAAG,IAAI,QAAQ,MAAO;AAC/G,SAAO;AACT;AAaA,SAAS,YAAY,KAAqB;AACxC,SAAO,IAAI,QAAQ,uDAAuD,CAAC,QAAQ,KAAyB,YAAgC;AAC1I,QAAI,QAAQ,QAAW;AACrB,YAAM,YAAY,OAAO,SAAS,KAAK,EAAE;AACzC,UAAI,cAAc,KAAK,YAAY,WAAa,aAAa,SAAU,aAAa,MAAS,QAAO;AACpG,aAAO,OAAO,cAAc,SAAS;IACvC;AACA,QAAI,YAAY,OAAW,QAAO;AAClC,WAAO;EACT,CAAC;AACH;","names":[]}

package/dist/index.mjs CHANGED Viewed

@@ -36,11 +36,214 @@ function getActionAnnotation(field) {
   const [, label, method, path] = match;
   return { label, method, path };
 }
+// ../svg-sanitize/dist/index.mjs
+import { DOMParser, XMLSerializer } from "@xmldom/xmldom";
+var MAX_DIMENSION_PX = 1e6;
+function extractSvgDimensions(svg) {
+  const match = /\bviewBox\s*=\s*["']\s*([-\d.]+)[\s,]+([-\d.]+)[\s,]+([-\d.]+)[\s,]+([-\d.]+)\s*["']/.exec(svg);
+  if (!match) return null;
+  const width = Math.round(Number(match[3]));
+  const height = Math.round(Number(match[4]));
+  if (!Number.isFinite(width) || !Number.isFinite(height)) return null;
+  if (width <= 0 || height <= 0 || width > MAX_DIMENSION_PX || height > MAX_DIMENSION_PX) return null;
+  return { width, height };
+}
+function sanitizeSvg(input, policy) {
+  const doc = parseXml(input);
+  if (!doc) return { ok: false, reason: "malformed_xml" };
+  if (doc.doctype) {
+    return { ok: false, reason: "doctype_not_allowed" };
+  }
+  const root = doc.documentElement;
+  if (!isUnprefixedSvgElement(root)) {
+    return { ok: false, reason: "root_is_not_svg" };
+  }
+  sanitizeElementTree(root, policy, true);
+  const serializer = new XMLSerializer();
+  const serialized = serializer.serializeToString(root);
+  const verifyDoc = parseXml(serialized);
+  if (!verifyDoc || !isUnprefixedSvgElement(verifyDoc.documentElement)) {
+    return { ok: false, reason: "sanitized_output_not_single_root_svg" };
+  }
+  return { ok: true, svg: serialized };
+}
+var SVG_NAMESPACE_URI = "http://www.w3.org/2000/svg";
+var XML_NAMESPACE_URI = "http://www.w3.org/XML/1998/namespace";
+var XLINK_NAMESPACE_URI = "http://www.w3.org/1999/xlink";
+function isSvgNamespaceElement(el) {
+  return el.namespaceURI === SVG_NAMESPACE_URI && el.prefix == null;
+}
+function isUnprefixedSvgElement(el) {
+  return el != null && el.localName === "svg" && isSvgNamespaceElement(el);
+}
+function parseXml(source) {
+  try {
+    return new DOMParser({ onError: () => void 0 }).parseFromString(source, "image/svg+xml");
+  } catch {
+    return null;
+  }
+}
+var ALLOWED_ELEMENTS = /* @__PURE__ */ new Set([
+  "svg",
+  "g",
+  "defs",
+  "symbol",
+  "use",
+  "title",
+  "desc",
+  "metadata",
+  "path",
+  "rect",
+  "circle",
+  "ellipse",
+  "line",
+  "polyline",
+  "polygon",
+  "text",
+  "tspan",
+  "textPath",
+  "tref",
+  "marker",
+  "clipPath",
+  "mask",
+  "pattern",
+  "linearGradient",
+  "radialGradient",
+  "stop",
+  "image",
+  "style",
+  "a",
+  "switch",
+  "filter",
+  "feGaussianBlur",
+  "feOffset",
+  "feMerge",
+  "feMergeNode",
+  "feColorMatrix",
+  "feComposite",
+  "feFlood",
+  "feBlend",
+  "feDropShadow",
+  "feMorphology",
+  "feTurbulence",
+  "feDisplacementMap"
+]);
+var PROCESSING_INSTRUCTION_NODE = 7;
+var ELEMENT_NODE = 1;
+function sanitizeElementTree(el, policy, isRoot) {
+  sanitizeAttributes(el, policy, isRoot);
+  if (el.localName === "style") {
+    el.textContent = sanitizeStyleText(el.textContent ?? "");
+    return;
+  }
+  for (const child of Array.from(el.childNodes)) {
+    if (child.nodeType === PROCESSING_INSTRUCTION_NODE) {
+      el.removeChild(child);
+      continue;
+    }
+    if (child.nodeType !== ELEMENT_NODE) continue;
+    const childEl = child;
+    if (!isSvgNamespaceElement(childEl) || !ALLOWED_ELEMENTS.has(childEl.localName ?? childEl.nodeName)) {
+      el.removeChild(childEl);
+      continue;
+    }
+    sanitizeElementTree(childEl, policy, false);
+  }
+}
+function sanitizeAttributes(el, policy, isRoot) {
+  for (const attr of Array.from(el.attributes)) {
+    const localName = attr.localName ?? attr.name;
+    if (/^on/i.test(localName)) {
+      el.removeAttributeNode(attr);
+      continue;
+    }
+    if (localName === "style") {
+      el.removeAttributeNode(attr);
+      continue;
+    }
+    if (localName === "base" && attr.namespaceURI === XML_NAMESPACE_URI) {
+      el.removeAttributeNode(attr);
+      continue;
+    }
+    if (localName === "href") {
+      const sanitizedValue = sanitizeHrefValue(attr.value, policy);
+      if (sanitizedValue === null) {
+        el.removeAttributeNode(attr);
+      } else {
+        attr.value = sanitizedValue;
+      }
+      continue;
+    }
+    if (URL_VALUED_PRESENTATION_ATTRS.has(localName)) {
+      if (!isUrlFuncIriSafe(attr.value)) {
+        el.removeAttributeNode(attr);
+      }
+      continue;
+    }
+    if (attr.name === "xmlns" || attr.name.startsWith("xmlns:")) {
+      if (!isRoot || !isEssentialRootNamespaceDeclaration(attr)) {
+        el.removeAttributeNode(attr);
+      }
+    }
+  }
+}
+function isEssentialRootNamespaceDeclaration(attr) {
+  if (attr.name === "xmlns") return true;
+  return attr.name === "xmlns:xlink" && attr.value === XLINK_NAMESPACE_URI;
+}
+var URL_VALUED_PRESENTATION_ATTRS = /* @__PURE__ */ new Set([
+  "fill",
+  "stroke",
+  "filter",
+  "clip-path",
+  "mask",
+  "cursor",
+  "marker",
+  "marker-start",
+  "marker-mid",
+  "marker-end"
+]);
+var URL_FUNC_PATTERN = /url\(\s*(['"]?)([^'")]*)\1\s*\)/gi;
+function isUrlFuncIriSafe(rawValue) {
+  const matches = Array.from(cssUnescape(rawValue).matchAll(URL_FUNC_PATTERN));
+  if (matches.length === 0) return true;
+  return matches.every(([, , target]) => target.trim().startsWith("#"));
+}
+function sanitizeHrefValue(rawValue, policy) {
+  const value = rawValue.trim();
+  if (value.startsWith("#")) return value;
+  if (/^javascript:/i.test(value)) return null;
+  if (/^data:/i.test(value)) return null;
+  if (value.startsWith("//")) return null;
+  if (policy.allowSafeHref && /^https:\/\//i.test(value)) return value;
+  return null;
+}
+function sanitizeStyleText(css) {
+  const withoutComments = css.replace(/\/\*[\s\S]*?\*\//g, " ");
+  let out = cssUnescape(withoutComments);
+  out = out.replace(/@import\b[^;]*;?/gi, "");
+  out = out.replace(URL_FUNC_PATTERN, (match, _quote, target) => target.trim().startsWith("#") ? match : "none");
+  return out;
+}
+function cssUnescape(css) {
+  return css.replace(/\\([0-9a-fA-F]{1,6})[ \t\n\f\r]?|\\([^\r\n\f])|\\$/g, (_match, hex, literal) => {
+    if (hex !== void 0) {
+      const codePoint = Number.parseInt(hex, 16);
+      if (codePoint === 0 || codePoint > 1114111 || codePoint >= 55296 && codePoint <= 57343) return "\uFFFD";
+      return String.fromCodePoint(codePoint);
+    }
+    if (literal !== void 0) return literal;
+    return "\uFFFD";
+  });
+}
 export {
   ACTION_FIELD_MARKER,
   SENSITIVE_FIELD_MARKER,
   escapeHtml,
+  extractSvgDimensions,
   getActionAnnotation,
-  isSensitiveField
+  isSensitiveField,
+  sanitizeSvg
 };
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/html.ts","../src/schema-markers.ts"],"~~sourcesContent":["/*\n HTML~~-emitting helper for renderer plugins.\n \n A renderer plugin that builds HTML from author-controlled or external\n * strings (an OGP title, a math error message, …) must escape them, and\n * that escape is a security primitive — a hardening change has to reach\n * every plugin at once, not whichever local copies someone remembers.\n * This is the SDK's single copy (`@crowi/~~plugin-renderer-katex` and\n * `@crowi~~/plugin-renderer-link-card` each carried an identical local one\n * before it was hoisted here).\n /\n\n/* Escape `&` `<` `>` `\"` `'` for interpolation into HTML text or double/single-quoted attribute values. /\nexport function escapeHtml(s: string): string {\n return s.replace(/[&<>\"~~']/g~~, ~~(c) => {\n switch (c) {\n case '&':\n return '&';\n case '<':\n return '<';\n case '>':\n return '>';\n case '\~~"':\n return '"';\n case \"'\":\n return ''';\n default:\n return c;\n }\n });\n}\n","import type { z } from 'zod/v3';\n\nimport type { PluginRouteMethod } from './routes';\n\n/\n `configSchema` description-string markers.\n \n The admin UI walks the schema and looks at each field's\n * `description` (set via `z.string().describe('@sensitive ...')`). A\n * description starting with one of these marker tokens unlocks special\n * UI behaviour without forcing every field to declare a custom Zod\n * type.\n /\n\n/\n Marker that flags a config field as sensitive (encrypted at rest).\n * Usage:\n \n z.string().describe('@sensitive AWS secret access key')\n \n The runtime auto-encrypts on write and decrypts on read, using the\n * same KeyProvider as core sensitive Config. The admin UI renders the\n * field via `<SecretField>` (saved badge / ~~clear pending~~ / ~~undo).\n /\nexport const SENSITIVE_FIELD_MARKER = '@sensitive';\n\n/\n Marker that adds an action button next to a config field~~. Usage:\n \n z.string().describe('@action \"Test connection\" POST /test')\n \n The admin form renders a button with the given label that calls the\n * plugin's contributed endpoint at the given verb / path (relative to\n * `/api/v2/plugins/<name>/`). Useful for \"Test connection\",\n * \"Authorise with Google\", etc. without forcing every plugin to ship\n * its own React component.\n /\nexport const ACTION_FIELD_MARKER = '@action';\n\n/\n True if the schema field is marked `@sensitive`.\n \n `field` is `z.ZodTypeAny` (intentionally loose); call sites pass the\n * value type from `configSchema.shape[key]`.\n /\nexport function isSensitiveField(field: z.ZodTypeAny): boolean {\n const description = field.description;\n return typeof description === 'string' && description.trimStart().startsWith(SENSITIVE_FIELD_MARKER);\n}\n\n/\n Parsed `@action` annotation extracted from a field's `description`.\n /\nexport interface ActionAnnotation {\n /* Visible button label, e.g. \"Test connection\". /\n label: string;\n /* HTTP verb of the plugin endpoint to call. /\n method: PluginRouteMethod;\n /* Path relative to `/api/v2/plugins/<name>/`, with leading slash. /\n path: string;\n}\n\n/\n Parse an `@action` annotation off a field, or return null if absent.\n \n Format: `@action \"<label>\" <METHOD> <path>`\n * e.g. `@action \"Test connection\" POST /test`\n \n The label may include spaces when wrapped in double quotes; the method\n * must be one of `PluginRouteMethod` (`GET` / `POST` — the only verbs a\n * plugin route can actually be mounted on, see `routes.ts`); the path\n * begins with `/`. A description that starts with the `@action` marker\n * but declares an unsupported verb (e.g. `PUT` / `DELETE`) fails to match\n * and returns `null` here — callers that walk a plugin's `configSchema`\n * (e.g. `PluginManager.activate()`) are expected to warn on that case at\n * boot, since it would otherwise be a silent dead button.\n /\nexport function getActionAnnotation(field: z.ZodTypeAny): ActionAnnotation \| null {\n const description = field.description;\n if (typeof description !== 'string') return null;\n const trimmed = description.trimStart();\n if (!trimmed.startsWith(ACTION_FIELD_MARKER)) return null;\n\n const rest = trimmed.slice(ACTION_FIELD_MARKER.length).trimStart();\n // `\"~~<label>\" <METHOD> <path>`\n const match = rest.match(/^\"([^\"~~]~~+)\"\\s+(GET\|POST)\\s+(\\/\\S)/);\n if (!match) return null;\n\n const [~~, ~~label, method, path] = match;\n return { label, method: method as ActionAnnotation['method'], path };\n}\n~~"~~],"~~mappings":";AAaO,SAAS,WAAW,GAAmB;AAC5C,SAAO,EAAE,QAAQ,YAAY,CAAC,MAAM;AAClC,YAAQ,GAAG;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT;AACE,eAAO;AAAA,IACX;AAAA,EACF,CAAC;AACH;;;ACNO,IAAM,yBAAyB;AAa/B,IAAM,sBAAsB;AAQ5B,SAAS,iBAAiB,OAA8B;AAC7D,QAAM,cAAc,MAAM;AAC1B,SAAO,OAAO,gBAAgB,YAAY,YAAY,UAAU,EAAE,WAAW,sBAAsB;AACrG;AA6BO,SAAS,oBAAoB,OAA8C;AAChF,QAAM,cAAc,MAAM;AAC1B,MAAI,OAAO,gBAAgB,SAAU,QAAO;AAC5C,QAAM,UAAU,YAAY,UAAU;AACtC,MAAI,CAAC,QAAQ,WAAW,mBAAmB,EAAG,QAAO;AAErD,QAAM,OAAO,QAAQ,MAAM,oBAAoB,MAAM,EAAE,UAAU;AAEjE,QAAM,QAAQ,KAAK,MAAM,mCAAmC;AAC5D,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,CAAC,EAAE,OAAO,QAAQ,IAAI,IAAI;AAChC,SAAO,EAAE,OAAO,QAA8C,KAAK;AACrE;","names":[]}
1	+ {"version":3,"sources":["../src/html.ts","../src/schema-markers.ts","../../svg-sanitize/src/dimensions.ts","../../svg-sanitize/src/sanitize.ts"],"mappings":";AAaO,SAAS,WAAW,GAAmB;AAC5C,SAAO,EAAE,QAAQ,YAAY,CAAC,MAAM;AAClC,YAAQ,GAAG;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT;AACE,eAAO;AAAA,IACX;AAAA,EACF,CAAC;AACH;;;ACNO,IAAM,yBAAyB;AAa/B,IAAM,sBAAsB;AAQ5B,SAAS,iBAAiB,OAA8B;AAC7D,QAAM,cAAc,MAAM;AAC1B,SAAO,OAAO,gBAAgB,YAAY,YAAY,UAAU,EAAE,WAAW,sBAAsB;AACrG;AA6BO,SAAS,oBAAoB,OAA8C;AAChF,QAAM,cAAc,MAAM;AAC1B,MAAI,OAAO,gBAAgB,SAAU,QAAO;AAC5C,QAAM,UAAU,YAAY,UAAU;AACtC,MAAI,CAAC,QAAQ,WAAW,mBAAmB,EAAG,QAAO;AAErD,QAAM,OAAO,QAAQ,MAAM,oBAAoB,MAAM,EAAE,UAAU;AAEjE,QAAM,QAAQ,KAAK,MAAM,mCAAmC;AAC5D,MAAI,CAAC,MAAO,QAAO;AAEnB,QAAM,CAAC,EAAE,OAAO,QAAQ,IAAI,IAAI;AAChC,SAAO,EAAE,OAAO,QAA8C,KAAK;AACrE;;;AEzFA,SAAS,WAAW,qBAAqB;ADqBzC,IAAM,mBAAmB;AAElB,SAAS,qBAAqB,KAAuD;AAC1F,QAAM,QAAQ,uFAAuF,KAAK,GAAG;AAC7G,MAAI,CAAC,MAAO,QAAO;AACnB,QAAM,QAAQ,KAAK,MAAM,OAAO,MAAM,CAAC,CAAC,CAAC;AACzC,QAAM,SAAS,KAAK,MAAM,OAAO,MAAM,CAAC,CAAC,CAAC;AAC1C,MAAI,CAAC,OAAO,SAAS,KAAK,KAAK,CAAC,OAAO,SAAS,MAAM,EAAG,QAAO;AAChE,MAAI,SAAS,KAAK,UAAU,KAAK,QAAQ,oBAAoB,SAAS,iBAAkB,QAAO;AAC/F,SAAO,EAAE,OAAO,OAAO;AACzB;AC+CO,SAAS,YAAY,OAAe,QAA8C;AACvF,QAAM,MAAM,SAAS,KAAK;AAC1B,MAAI,CAAC,IAAK,QAAO,EAAE,IAAI,OAAO,QAAQ,gBAAgB;AAEtD,MAAI,IAAI,SAAS;AAKf,WAAO,EAAE,IAAI,OAAO,QAAQ,sBAAsB;EACpD;AACA,QAAM,OAAO,IAAI;AACjB,MAAI,CAAC,uBAAuB,IAAI,GAAG;AACjC,WAAO,EAAE,IAAI,OAAO,QAAQ,kBAAkB;EAChD;AAEA,sBAAoB,MAAM,QAAQ,IAAI;AAEtC,QAAM,aAAa,IAAI,cAAc;AACrC,QAAM,aAAa,WAAW,kBAAkB,IAAI;AAOpD,QAAM,YAAY,SAAS,UAAU;AACrC,MAAI,CAAC,aAAa,CAAC,uBAAuB,UAAU,eAAe,GAAG;AACpE,WAAO,EAAE,IAAI,OAAO,QAAQ,uCAAuC;EACrE;AAEA,SAAO,EAAE,IAAI,MAAM,KAAK,WAAW;AACrC;AAEA,IAAM,oBAAoB;AAW1B,IAAM,oBAAoB;AAU1B,IAAM,sBAAsB;AAgB5B,SAAS,sBAAsB,IAAsB;AACnD,SAAO,GAAG,iBAAiB,qBAAqB,GAAG,UAAU;AAC/D;AAUA,SAAS,uBAAuB,IAA+C;AAC7E,SAAO,MAAM,QAAQ,GAAG,cAAc,SAAS,sBAAsB,EAAE;AACzE;AAWA,SAAS,SAAS,QAAgB;AAChC,MAAI;AACF,WAAO,IAAI,UAAU,EAAE,SAAS,MAAM,OAAU,CAAC,EAAE,gBAAgB,QAAQ,eAAe;EAC5F,QAAQ;AACN,WAAO;EACT;AACF;AAWA,IAAM,mBAAmB,oBAAI,IAAI;EAC/B;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;AACF,CAAC;AAED,IAAM,8BAA8B;AACpC,IAAM,eAAe;AAErB,SAAS,oBAAoB,IAAa,QAA2B,QAAuB;AAC1F,qBAAmB,IAAI,QAAQ,MAAM;AAErC,MAAI,GAAG,cAAc,SAAS;AAG5B,OAAG,cAAc,kBAAkB,GAAG,eAAe,EAAE;AACvD;EACF;AAEA,aAAW,SAAS,MAAM,KAAK,GAAG,UAAU,GAAG;AAC7C,QAAI,MAAM,aAAa,6BAA6B;AAClD,SAAG,YAAY,KAAK;AACpB;IACF;AACA,QAAI,MAAM,aAAa,aAAc;AACrC,UAAM,UAAU;AAMhB,QAAI,CAAC,sBAAsB,OAAO,KAAK,CAAC,iBAAiB,IAAI,QAAQ,aAAa,QAAQ,QAAQ,GAAG;AACnG,SAAG,YAAY,OAAO;AACtB;IACF;AACA,wBAAoB,SAAS,QAAQ,KAAK;EAC5C;AACF;AAEA,SAAS,mBAAmB,IAAa,QAA2B,QAAuB;AACzF,aAAW,QAAQ,MAAM,KAAK,GAAG,UAAU,GAAG;AAC5C,UAAM,YAAY,KAAK,aAAa,KAAK;AACzC,QAAI,OAAO,KAAK,SAAS,GAAG;AAC1B,SAAG,oBAAoB,IAAI;AAC3B;IACF;AACA,QAAI,cAAc,SAAS;AACzB,SAAG,oBAAoB,IAAI;AAC3B;IACF;AACA,QAAI,cAAc,UAAU,KAAK,iBAAiB,mBAAmB;AAcnE,SAAG,oBAAoB,IAAI;AAC3B;IACF;AACA,QAAI,cAAc,QAAQ;AACxB,YAAM,iBAAiB,kBAAkB,KAAK,OAAO,MAAM;AAC3D,UAAI,mBAAmB,MAAM;AAC3B,WAAG,oBAAoB,IAAI;MAC7B,OAAO;AACL,aAAK,QAAQ;MACf;AACA;IACF;AACA,QAAI,8BAA8B,IAAI,SAAS,GAAG;AAChD,UAAI,CAAC,iBAAiB,KAAK,KAAK,GAAG;AACjC,WAAG,oBAAoB,IAAI;MAC7B;AACA;IACF;AACA,QAAI,KAAK,SAAS,WAAW,KAAK,KAAK,WAAW,QAAQ,GAAG;AAC3D,UAAI,CAAC,UAAU,CAAC,oCAAoC,IAAI,GAAG;AACzD,WAAG,oBAAoB,IAAI;MAC7B;IACF;EACF;AACF;AAoBA,SAAS,oCAAoC,MAAqB;AAChE,MAAI,KAAK,SAAS,QAAS,QAAO;AAClC,SAAO,KAAK,SAAS,iBAAiB,KAAK,UAAU;AACvD;AAQA,IAAM,gCAAgC,oBAAI,IAAI;EAC5C;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;AACF,CAAC;AAED,IAAM,mBAAmB;AAWzB,SAAS,iBAAiB,UAA2B;AAOnD,QAAM,UAAU,MAAM,KAAK,YAAY,QAAQ,EAAE,SAAS,gBAAgB,CAAC;AAC3E,MAAI,QAAQ,WAAW,EAAG,QAAO;AACjC,SAAO,QAAQ,MAAM,CAAC,CAAC,EAAE,EAAE,MAAM,MAAM,OAAO,KAAK,EAAE,WAAW,GAAG,CAAC;AACtE;AAGA,SAAS,kBAAkB,UAAkB,QAA0C;AACrF,QAAM,QAAQ,SAAS,KAAK;AAC5B,MAAI,MAAM,WAAW,GAAG,EAAG,QAAO;AAClC,MAAI,gBAAgB,KAAK,KAAK,EAAG,QAAO;AACxC,MAAI,UAAU,KAAK,KAAK,EAAG,QAAO;AAClC,MAAI,MAAM,WAAW,IAAI,EAAG,QAAO;AACnC,MAAI,OAAO,iBAAiB,eAAe,KAAK,KAAK,EAAG,QAAO;AAC/D,SAAO;AACT;AA6CA,SAAS,kBAAkB,KAAqB;AAM9C,QAAM,kBAAkB,IAAI,QAAQ,qBAAqB,GAAG;AAC5D,MAAI,MAAM,YAAY,eAAe;AACrC,QAAM,IAAI,QAAQ,sBAAsB,EAAE;AAC1C,QAAM,IAAI,QAAQ,kBAAkB,CAAC,OAAO,QAAQ,WAAY,OAAO,KAAK,EAAE,WAAW,GAAG,IAAI,QAAQ,MAAO;AAC/G,SAAO;AACT;AAaA,SAAS,YAAY,KAAqB;AACxC,SAAO,IAAI,QAAQ,uDAAuD,CAAC,QAAQ,KAAyB,YAAgC;AAC1I,QAAI,QAAQ,QAAW;AACrB,YAAM,YAAY,OAAO,SAAS,KAAK,EAAE;AACzC,UAAI,cAAc,KAAK,YAAY,WAAa,aAAa,SAAU,aAAa,MAAS,QAAO;AACpG,aAAO,OAAO,cAAc,SAAS;IACvC;AACA,QAAI,YAAY,OAAW,QAAO;AAClC,WAAO;EACT,CAAC;AACH;","names":[]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@crowi/plugin-api",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.6",
   "description": "Type-only contract for Crowi 2.0 plugins. See docs/rfcs/0001-plugin-architecture.md.",
   "repository": {
     "type": "git",
@@ -25,20 +25,24 @@
     "access": "public"
   },
   "peerDependencies": {
-    "hono": "^4.12.25",
+    "hono": "^4.12.34",
     "zod": "^4"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
     "@types/node": "^24",
-    "hono": "^4.12.31",
+    "hono": "^4.12.34",
     "jest": "^29.7.0",
     "ts-jest": "^29.3.4",
     "tsup": "^8.3.5",
     "typescript": "^5.8.3",
     "zod": "^4.4.3",
+    "@crowi/svg-sanitize": "0.1.0-alpha.1",
     "@crowi/tsconfig": "0.1.0-alpha.0"
   },
+  "dependencies": {
+    "@xmldom/xmldom": "^0.9.10"
+  },
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch --no-clean",