@crowi/api 2.0.0-alpha.0

package/dist/renderer/core/url-inline-expand.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeUrlInlineExpandDispatch = void 0;
+const cache_1 = require("../cache");
+const registry_1 = require("../registry");
+const _mdast_walk_1 = require("./_mdast-walk");
+/**
+ * Phase 4 plugin-dispatch transform — async post-processor that finds
+ * bare URLs in paragraph-level content and, for each registered
+ * `UrlInlineExpansionRule`, tries to expand them inline.
+ *
+ * Bare URL identification: GFM autolink (`https://example.com`) is
+ * parsed by remark-gfm into a `link` node whose single text child has
+ * the same URL as the `link.url`. That shape — a link whose href ===
+ * its visible label — is what this transform targets. Inline-link
+ * targets with a different label (`[label](url)`) are NOT expanded
+ * (the author chose a label and we respect it).
+ *
+ * Expansion order: registered expanders are tried in registration
+ * order; the first `'replaced'` wins. All `'unchanged'` means no
+ * change.
+ *
+ * The expansion itself is routed through `cachedRender` so SWR + size
+ * limits + error caching all apply uniformly. We wrap each
+ * `UrlInlineExpansionRule` in an ephemeral `EmbedRenderer` shape so
+ * the same code path handles both `@[tag](url)` and bare-URL embeds.
+ */
+const URL_EXPAND_PSEUDO_TAG = '__url-inline-expand__';
+const makeUrlInlineExpandDispatch = (registry, ctx, deps) => async (tree) => {
+    const expanders = registry.getUrlInlineExpanders();
+    if (expanders.length === 0)
+        return;
+    const candidates = collectAutolinks(tree);
+    if (candidates.length === 0)
+        return;
+    await Promise.all(candidates.map(async (candidate) => {
+        for (let idx = 0; idx < expanders.length; idx++) {
+            const { plugin, rule } = expanders[idx];
+            if (!matchesRule(rule, candidate.url))
+                continue;
+            const adaptor = ruleAsRenderer(rule);
+            const scopedCtx = {
+                ...ctx,
+                cache: (0, cache_1.scopeForPlugin)(deps.cache, plugin),
+                auth: (0, registry_1.createAuthContextStub)(),
+            };
+            // Encode the expander index into the synthetic `tag` so two
+            // expanders from the same plugin (same cacheVersion + same
+            // pluginName) do NOT share a cache slot. Without this they
+            // would collide on `(pluginName, pluginCacheVersion, pageId,
+            // sha256({tag, url}))` and the second expander's call would
+            // be served from the first's cached output.
+            const input = {
+                tag: `${URL_EXPAND_PSEUDO_TAG}#${idx}`,
+                url: candidate.url,
+                pageId: deps.pageId,
+            };
+            // `cachedRender` resolves expand() through SWR + error
+            // cache. The returned html is empty when expand() said
+            // 'unchanged'; we fall through to the next expander in that
+            // case.
+            const rendered = await (0, cache_1.cachedRender)(deps.cache, plugin, adaptor, input, scopedCtx);
+            if (rendered.html && rendered.html.length > 0) {
+                candidate.replacementHtml = rendered.html;
+                return;
+            }
+        }
+    }));
+    for (const parent of (0, _mdast_walk_1.groupByParent)(candidates, (c) => c.linkIndex)) {
+        parent.parent.children = spliceLinks(parent.parent.children, parent.matches);
+    }
+};
+exports.makeUrlInlineExpandDispatch = makeUrlInlineExpandDispatch;
+function collectAutolinks(tree) {
+    const out = [];
+    (0, _mdast_walk_1.walkPhrasingTree)(tree, (node, insideLink) => {
+        if (insideLink)
+            return;
+        const children = node.children;
+        for (let i = 0; i < children.length; i++) {
+            const child = children[i];
+            if (child.type !== 'link')
+                continue;
+            const link = child;
+            if (!isAutolinkShape(link))
+                continue;
+            out.push({
+                parent: node,
+                linkIndex: i,
+                url: link.url,
+            });
+        }
+    });
+    return out;
+}
+/**
+ * A "bare URL" link is one where the visible label equals the href.
+ * GFM autolink produces exactly this shape (`https://example.com` →
+ * `link(url='https://example.com', children=[text('https://example.com')])`).
+ * Inline links with custom labels (`[label](url)`) have a different
+ * shape and are intentionally not expanded.
+ */
+function isAutolinkShape(link) {
+    if (!link.url)
+        return false;
+    const children = link.children ?? [];
+    if (children.length !== 1)
+        return false;
+    const only = children[0];
+    if (only.type !== 'text')
+        return false;
+    return only.value === link.url;
+}
+function matchesRule(rule, url) {
+    if (typeof rule.match === 'function')
+        return rule.match(url);
+    return rule.match.test(url);
+}
+/**
+ * Adapt a `UrlInlineExpansionRule` to the `EmbedRenderer` shape that
+ * `cachedRender` expects. The `RenderResult.html` is empty when
+ * `expand` returned `'unchanged'` — the caller falls through to the
+ * next expander in that case.
+ */
+function ruleAsRenderer(rule) {
+    return {
+        cacheVersion: rule.cacheVersion,
+        async render(input, ctx) {
+            const result = await rule.expand(input.url, ctx);
+            if (result.kind === 'unchanged') {
+                // Use a short fresh-TTL so a registered expander re-evaluates
+                // soon (its match function might depend on dynamic config).
+                return { html: '', ttlSec: 60 };
+            }
+            // `result` is RenderResult shape (minus `kind`).
+            const { kind: _ignored, ...renderResult } = result;
+            return renderResult;
+        },
+    };
+}
+function spliceLinks(children, matches) {
+    // Replace each matched link node with an html node containing the
+    // expanded html. Other children pass through untouched.
+    const byIndex = new Map(matches.map((m) => [m.linkIndex, m]));
+    const out = [];
+    for (let i = 0; i < children.length; i++) {
+        const match = byIndex.get(i);
+        if (!match) {
+            out.push(children[i]);
+            continue;
+        }
+        const html = { type: 'html', value: match.replacementHtml ?? '' };
+        out.push(html);
+    }
+    return out;
+}
+//# sourceMappingURL=url-inline-expand.js.map

package/dist/renderer/core/url-inline-expand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-inline-expand.js","sourceRoot":"","sources":["../../../src/renderer/core/url-inline-expand.ts"],"names":[],"mappings":";;;AAEA,oCAAgF;AAChF,0CAA+E;AAC/E,+CAAqF;AAErF;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,MAAM,qBAAqB,GAAG,uBAAuB,CAAC;AAO/C,MAAM,2BAA2B,GACtC,CAAC,QAA8B,EAAE,GAAkB,EAAE,IAA2B,EAAE,EAAE,CACpF,KAAK,EAAE,IAAU,EAAiB,EAAE;IAClC,MAAM,SAAS,GAAG,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IACnD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IAEnC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC1C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IAEpC,MAAM,OAAO,CAAC,GAAG,CACf,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACjC,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;YAChD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC;gBAAE,SAAS;YAChD,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;YACrC,MAAM,SAAS,GAAkB;gBAC/B,GAAG,GAAG;gBACN,KAAK,EAAE,IAAA,sBAAc,EAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC;gBACzC,IAAI,EAAE,IAAA,gCAAqB,GAAE;aAC9B,CAAC;YACF,4DAA4D;YAC5D,2DAA2D;YAC3D,2DAA2D;YAC3D,6DAA6D;YAC7D,4DAA4D;YAC5D,4CAA4C;YAC5C,MAAM,KAAK,GAAe;gBACxB,GAAG,EAAE,GAAG,qBAAqB,IAAI,GAAG,EAAE;gBACtC,GAAG,EAAE,SAAS,CAAC,GAAG;gBAClB,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC;YACF,uDAAuD;YACvD,uDAAuD;YACvD,4DAA4D;YAC5D,QAAQ;YACR,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAY,EAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;YACnF,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9C,SAAS,CAAC,eAAe,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAC1C,OAAO;YACT,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CACH,CAAC;IAEF,KAAK,MAAM,MAAM,IAAI,IAAA,2BAAa,EAAC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;QACnE,MAAM,CAAC,MAAM,CAAC,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;AACH,CAAC,CAAC;AA/CS,QAAA,2BAA2B,+BA+CpC;AAWJ,SAAS,gBAAgB,CAAC,IAAU;IAClC,MAAM,GAAG,GAAwB,EAAE,CAAC;IACpC,IAAA,8BAAgB,EAAC,IAAsB,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE;QAC5D,IAAI,UAAU;YAAE,OAAO;QACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAA6B,CAAC;QACpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC1B,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM;gBAAE,SAAS;YACpC,MAAM,IAAI,GAAG,KAAa,CAAC;YAC3B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;gBAAE,SAAS;YACrC,GAAG,CAAC,IAAI,CAAC;gBACP,MAAM,EAAE,IAAsB;gBAC9B,SAAS,EAAE,CAAC;gBACZ,GAAG,EAAE,IAAI,CAAC,GAAG;aACd,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,IAAU;IACjC,IAAI,CAAC,IAAI,CAAC,GAAG;QAAE,OAAO,KAAK,CAAC;IAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;IACrC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACxC,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC;IACvC,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,GAAG,CAAC;AACjC,CAAC;AAED,SAAS,WAAW,CAAC,IAA4B,EAAE,GAAW;IAC5D,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,UAAU;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,IAA4B;IAClD,OAAO;QACL,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG;YACrB,MAAM,MAAM,GAAoB,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAClE,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAChC,8DAA8D;gBAC9D,4DAA4D;gBAC5D,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YAClC,CAAC;YACD,iDAAiD;YACjD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;YACnD,OAAO,YAAY,CAAC;QACtB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,QAA2B,EAAE,OAA4B;IAC5E,kEAAkE;IAClE,wDAAwD;IACxD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,MAAM,GAAG,GAAsB,EAAE,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YACtB,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAS,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,eAAe,IAAI,EAAE,EAAE,CAAC;QACxE,GAAG,CAAC,IAAI,CAAC,IAAkC,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/renderer/core/wikilinks.d.ts

@@ -0,0 +1,2 @@
+import type { UnifiedTransformPlugin } from './headings';
+export declare const remarkWikiLinks: UnifiedTransformPlugin;

package/dist/renderer/core/wikilinks.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.remarkWikiLinks = void 0;
+/**
+ * Core renderer transform — detect `[[…]]` inside text nodes, replace
+ * them with link nodes (so downstream renderers see proper links),
+ * and push canonical entries into `metadata.wikiLinks`.
+ *
+ * Supported shapes:
+ *   - `[[Page]]`              → link to `Page`, display `Page`
+ *   - `[[/path/to/page]]`     → link to `/path/to/page`, display same
+ *   - `[[Page|Display]]`      → link to `Page`, display `Display`
+ *   - `[[Page#section]]`      → link to `Page#section`, display `Page#section`
+ *
+ * Targets that don't start with `/` are kept as-is (Phase 3 will add
+ * resolved-wikilink endpoint to map names to paths). The link node
+ * carries `data.hProperties.className = 'wikilink-broken'` for
+ * non-absolute targets so the web renderer can dim them. `javascript:`
+ * and external `http(s)://` targets are stripped to broken-link too —
+ * they are never valid wikilink targets.
+ *
+ * The walker only descends into text nodes; code blocks and inline
+ * code (`code`, `inlineCode`) are skipped, matching the spec.
+ */
+// `[[…]]` capture. Disallow newlines and unbalanced brackets inside.
+// Greedy on the body but bounded to a reasonable length so a stray
+// `[[` doesn't eat the rest of the document.
+const WIKILINK_RE = /\[\[([^[\]\n]{1,256})\]\]/g;
+const remarkWikiLinks = (metadata) => (tree) => {
+    walk(tree);
+    function walk(node) {
+        if (node.type === 'code' || node.type === 'inlineCode')
+            return;
+        if (Array.isArray(node.children)) {
+            const replaced = transformChildren(node.children, metadata);
+            node.children = replaced;
+            for (const child of replaced)
+                walk(child);
+        }
+    }
+};
+exports.remarkWikiLinks = remarkWikiLinks;
+function transformChildren(children, metadata) {
+    const out = [];
+    for (const child of children) {
+        if (child.type !== 'text') {
+            out.push(child);
+            continue;
+        }
+        const expanded = expandText(child, metadata);
+        out.push(...expanded);
+    }
+    return out;
+}
+function expandText(textNode, metadata) {
+    const value = textNode.value;
+    if (!value || !value.includes('[['))
+        return [textNode];
+    const out = [];
+    let lastIndex = 0;
+    WIKILINK_RE.lastIndex = 0;
+    for (let m; (m = WIKILINK_RE.exec(value));) {
+        const [matched, raw] = m;
+        const start = m.index;
+        if (start > lastIndex) {
+            out.push({ type: 'text', value: value.slice(lastIndex, start) });
+        }
+        const parsed = parseWikiLink(raw);
+        metadata.wikiLinks.push(parsed);
+        out.push(toLinkNode(parsed));
+        lastIndex = start + matched.length;
+    }
+    if (lastIndex === 0)
+        return [textNode];
+    if (lastIndex < value.length) {
+        out.push({ type: 'text', value: value.slice(lastIndex) });
+    }
+    return out;
+}
+function parseWikiLink(raw) {
+    const trimmed = raw.trim();
+    const pipeAt = trimmed.indexOf('|');
+    if (pipeAt >= 0) {
+        return {
+            raw,
+            target: trimmed.slice(0, pipeAt).trim(),
+            displayText: trimmed.slice(pipeAt + 1).trim(),
+        };
+    }
+    return { raw, target: trimmed };
+}
+function toLinkNode(entry) {
+    const display = entry.displayText ?? entry.target;
+    const isValid = isValidTarget(entry.target);
+    const data = {};
+    if (!isValid) {
+        data.hProperties = { className: 'wikilink-broken' };
+    }
+    return {
+        type: 'link',
+        url: isValid ? entry.target : '#',
+        title: null,
+        children: [{ type: 'text', value: display }],
+        data,
+    };
+}
+/**
+ * Phase 2 valid-target rule: target must start with `/` (absolute
+ * path). Anything else (bare name, external URL, `javascript:`) gets
+ * `wikilink-broken` and a `#` href so it's visually distinct without
+ * leaving the page.
+ */
+function isValidTarget(target) {
+    if (!target)
+        return false;
+    return target.startsWith('/');
+}
+//# sourceMappingURL=wikilinks.js.map

package/dist/renderer/core/wikilinks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wikilinks.js","sourceRoot":"","sources":["../../../src/renderer/core/wikilinks.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,qEAAqE;AACrE,mEAAmE;AACnE,6CAA6C;AAC7C,MAAM,WAAW,GAAG,4BAA4B,CAAC;AAE1C,MAAM,eAAe,GAA2B,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE;IAC5E,IAAI,CAAC,IAAI,CAAC,CAAC;IAEX,SAAS,IAAI,CAAC,IAA6C;QACzD,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY;YAAE,OAAO;QAC/D,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,QAA6B,EAAE,QAAQ,CAAC,CAAC;YACjF,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,KAAK,MAAM,KAAK,IAAI,QAAQ;gBAAE,IAAI,CAAC,KAAgD,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAXW,QAAA,eAAe,mBAW1B;AAEF,SAAS,iBAAiB,CAAC,QAA2B,EAAE,QAA0B;IAChF,MAAM,GAAG,GAAsB,EAAE,CAAC;IAClC,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAChB,SAAS;QACX,CAAC;QACD,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAa,EAAE,QAAQ,CAAC,CAAC;QACrD,GAAG,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,UAAU,CAAC,QAAc,EAAE,QAA0B;IAC5D,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IAC7B,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEvD,MAAM,GAAG,GAAsB,EAAE,CAAC;IAClC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,WAAW,CAAC,SAAS,GAAG,CAAC,CAAC;IAC1B,KAAK,IAAI,CAAyB,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAI,CAAC;QACpE,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;QACzB,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;QACtB,IAAI,KAAK,GAAG,SAAS,EAAE,CAAC;YACtB,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QAClC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAC7B,SAAS,GAAG,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC;IACrC,CAAC;IACD,IAAI,SAAS,KAAK,CAAC;QAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvC,IAAI,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAC7B,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;QAChB,OAAO;YACL,GAAG;YACH,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE;YACvC,WAAW,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE;SAC9C,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AAClC,CAAC;AAED,SAAS,UAAU,CAAC,KAAuB;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC;IAClD,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5C,MAAM,IAAI,GAA8C,EAAE,CAAC;IAC3D,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,CAAC,WAAW,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;IACtD,CAAC;IACD,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG;QACjC,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QAC5C,IAAI;KACL,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,MAAc;IACnC,IAAI,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAC1B,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC"}

package/dist/renderer/index.d.ts

@@ -0,0 +1,67 @@
+import type { RenderContext } from '@crowi/plugin-api';
+import type Crowi from '../crowi';
+import { type MongoCacheStorage } from './cache';
+import { type PipelineMetadata, type PipelineResult } from './pipeline';
+import { RendererRegistryImpl } from './registry';
+export type { PipelineMetadata, PipelineResult, PipelineEsmDeps, ShikiHighlighter } from './pipeline';
+export { RendererRegistryImpl, makeRendererScope, createAuthContextStub } from './registry';
+export { serializeMdast } from './serialize';
+/**
+ * The renderer surface attached to `Crowi.renderer` after
+ * `setupRenderer()` runs. The registry holds **external plugin
+ * additions** only — the bundled core 5 transforms are baked into
+ * `runPipeline` and prepended on every run. Plugins layer on top via
+ * `PluginManager.activate()`'s `registerRenderer` callback.
+ */
+export interface Renderer {
+    registry: RendererRegistryImpl;
+    /**
+     * Plugin cache storage. Phase 4 — MongoDB-backed. Plugins receive a
+     * per-plugin scoped view through `RenderContext.cache`; the raw
+     * storage is exposed here for admin-side `invalidateAll` /
+     * `invalidatePlugin` calls + pageEvent listeners.
+     */
+    cache: MongoCacheStorage;
+    /** Run the parse + transform pipeline against `body`. */
+    run(body: string, options?: {
+        mode?: RenderContext['mode'];
+        pageId?: string;
+    }): Promise<PipelineResult>;
+    /** Convenience: just the metadata (used by `prepareRevision` + on-the-fly fallback). */
+    runMetadata(body: string, options?: {
+        mode?: RenderContext['mode'];
+        pageId?: string;
+    }): Promise<PipelineMetadata>;
+    /**
+     * Convenience: run the pipeline and return both metadata and the
+     * JSON-serialisable rendered AST. Used by `prepareRevision` (save
+     * path) and by `computeRevisionRenderedAstAsync` (read-path on-the-
+     * fly fallback for legacy revisions).
+     */
+    runRender(body: string, options?: {
+        mode?: RenderContext['mode'];
+        pageId?: string;
+    }): Promise<{
+        metadata: PipelineMetadata;
+        renderedAst: unknown;
+    }>;
+    /**
+     * Eagerly initialise heavy ESM-only deps (shiki + unified). Fired
+     * fire-and-forget from `Crowi.init`'s `setupRenderer` so the first
+     * pipeline run doesn't pay the cold-load cost. Failures are logged
+     * but never rethrown — boot must not block on optional warmup.
+     */
+    warmup(): Promise<void>;
+}
+/**
+ * Build the renderer. Called once during `Crowi.init()` AFTER
+ * `setupModels` and BEFORE `setupPlugins` so PluginManager can call
+ * `registerRenderer(scope, ctx)` on every plugin against the same
+ * registry instance the pipeline uses.
+ *
+ * Takes the Crowi instance so the cache storage (which depends on the
+ * `PluginRenderCache` mongoose model) and per-plugin scopes can be
+ * built. Tests that don't need cache I/O can pass a stub object
+ * exposing a `PluginRenderCache` model.
+ */
+export declare function createRenderer(crowi: Crowi): Renderer;

package/dist/renderer/index.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeMdast = exports.createAuthContextStub = exports.makeRendererScope = exports.RendererRegistryImpl = void 0;
+exports.createRenderer = createRenderer;
+const debug_1 = __importDefault(require("debug"));
+const cache_1 = require("./cache");
+const pipeline_1 = require("./pipeline");
+const registry_1 = require("./registry");
+const serialize_1 = require("./serialize");
+var registry_2 = require("./registry");
+Object.defineProperty(exports, "RendererRegistryImpl", { enumerable: true, get: function () { return registry_2.RendererRegistryImpl; } });
+Object.defineProperty(exports, "makeRendererScope", { enumerable: true, get: function () { return registry_2.makeRendererScope; } });
+Object.defineProperty(exports, "createAuthContextStub", { enumerable: true, get: function () { return registry_2.createAuthContextStub; } });
+var serialize_2 = require("./serialize");
+Object.defineProperty(exports, "serializeMdast", { enumerable: true, get: function () { return serialize_2.serializeMdast; } });
+const debug = (0, debug_1.default)('crowi:renderer');
+const coreLogger = {
+    debug: (msg, ...args) => debug(msg, ...args),
+    info: (msg, ...args) => debug(`[info] ${msg}`, ...args),
+    warn: (msg, ...args) => console.warn(`[crowi:renderer] ${msg}`, ...args),
+    error: (msg, ...args) => console.error(`[crowi:renderer] ${msg}`, ...args),
+};
+/**
+ * Build the renderer. Called once during `Crowi.init()` AFTER
+ * `setupModels` and BEFORE `setupPlugins` so PluginManager can call
+ * `registerRenderer(scope, ctx)` on every plugin against the same
+ * registry instance the pipeline uses.
+ *
+ * Takes the Crowi instance so the cache storage (which depends on the
+ * `PluginRenderCache` mongoose model) and per-plugin scopes can be
+ * built. Tests that don't need cache I/O can pass a stub object
+ * exposing a `PluginRenderCache` model.
+ */
+function createRenderer(crowi) {
+    const registry = new registry_1.RendererRegistryImpl();
+    // Per-instance ESM-deps loader. Sharing a module-level cache breaks
+    // under jest where each test file boots a fresh `Crowi` and a torn
+    // down test environment leaves cached ESM modules pointing at a
+    // dead VM realm.
+    const loadDeps = (0, pipeline_1.createPipelineEsmDepsLoader)();
+    const cache = (0, cache_1.createMongoCacheStorage)(crowi);
+    // Phase 2 mention existence resolver — batch-checks `@username`
+    // mentions against the `User` collection in a single `$in` query (no
+    // per-mention N+1). `runPipeline` only invokes this in `mode: 'save'`,
+    // so the resolved AST is persisted once and reused on read / view.
+    // The `User` model is looked up lazily per call: `createRenderer` runs
+    // during `Crowi.init` before all models are guaranteed registered.
+    const resolveMentionUsernames = async (usernames) => {
+        if (usernames.length === 0)
+            return new Set();
+        const User = crowi.model('User');
+        const found = await User.find({ username: { $in: usernames } })
+            .select('username')
+            .exec();
+        return new Set(found.map((u) => u.username));
+    };
+    // RenderContext for the core pipeline (not for plugins). `cache` and
+    // `auth` are intentionally absent — the bundled core transforms
+    // (headings / wikilinks / mentions / code-blocks / syntax-highlight)
+    // never consult either. The dispatch layer (embed-tags /
+    // url-inline-expand) attaches a per-plugin `cache` + `auth` before
+    // calling into plugin code.
+    const buildCtx = (options = {}) => ({
+        mode: options.mode ?? 'save',
+        log: coreLogger,
+    });
+    return {
+        registry,
+        cache,
+        async run(body, options = {}) {
+            const ctx = buildCtx(options);
+            return (0, pipeline_1.runPipeline)(body, registry, ctx, loadDeps, { cache, pageId: options.pageId ?? null, resolveMentionUsernames });
+        },
+        async runMetadata(body, options = {}) {
+            const result = await this.run(body, options);
+            return result.metadata;
+        },
+        async runRender(body, options = {}) {
+            const result = await this.run(body, options);
+            return {
+                metadata: result.metadata,
+                renderedAst: (0, serialize_1.serializeMdast)(result.tree),
+            };
+        },
+        async warmup() {
+            try {
+                await loadDeps();
+            }
+            catch (err) {
+                const message = err instanceof Error ? err.message : String(err);
+                console.warn(`[crowi:renderer] warmup failed (will retry on first run): ${message}`);
+            }
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/renderer/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/renderer/index.ts"],"names":[],"mappings":";;;;;;AAsEA,wCA8DC;AApID,kDAA0B;AAI1B,mCAA0E;AAE1E,yCAA4I;AAC5I,yCAAkD;AAClD,2CAA6C;AAG7C,uCAA4F;AAAnF,gHAAA,oBAAoB,OAAA;AAAE,6GAAA,iBAAiB,OAAA;AAAE,iHAAA,qBAAqB,OAAA;AACvE,yCAA6C;AAApC,2GAAA,cAAc,OAAA;AAsCvB,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,gBAAgB,CAAC,CAAC;AAEtC,MAAM,UAAU,GAAiB;IAC/B,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;IAC5C,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;IACvD,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;IACxE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,oBAAoB,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;CAC3E,CAAC;AAEF;;;;;;;;;;GAUG;AACH,SAAgB,cAAc,CAAC,KAAY;IACzC,MAAM,QAAQ,GAAG,IAAI,+BAAoB,EAAE,CAAC;IAC5C,oEAAoE;IACpE,mEAAmE;IACnE,gEAAgE;IAChE,iBAAiB;IACjB,MAAM,QAAQ,GAAwB,IAAA,sCAA2B,GAAE,CAAC;IACpE,MAAM,KAAK,GAAG,IAAA,+BAAuB,EAAC,KAAK,CAAC,CAAC;IAE7C,gEAAgE;IAChE,qEAAqE;IACrE,uEAAuE;IACvE,mEAAmE;IACnE,uEAAuE;IACvE,mEAAmE;IACnE,MAAM,uBAAuB,GAA4B,KAAK,EAAE,SAAS,EAAE,EAAE;QAC3E,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,GAAG,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAc,CAAC;QAC9C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC;aAC5D,MAAM,CAAC,UAAU,CAAC;aAClB,IAAI,EAAE,CAAC;QACV,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/C,CAAC,CAAC;IAEF,qEAAqE;IACrE,gEAAgE;IAChE,qEAAqE;IACrE,yDAAyD;IACzD,mEAAmE;IACnE,4BAA4B;IAC5B,MAAM,QAAQ,GAAG,CAAC,UAA6D,EAAE,EAAiB,EAAE,CAAC,CAAC;QACpG,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,MAAM;QAC5B,GAAG,EAAE,UAAU;KAChB,CAAC,CAAC;IAEH,OAAO;QACL,QAAQ;QACR,KAAK;QACL,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE;YAC1B,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC9B,OAAO,IAAA,sBAAW,EAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAC;QACxH,CAAC;QACD,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE;YAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC7C,OAAO,MAAM,CAAC,QAAQ,CAAC;QACzB,CAAC;QACD,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE;YAChC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC7C,OAAO;gBACL,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,WAAW,EAAE,IAAA,0BAAc,EAAC,MAAM,CAAC,IAAI,CAAC;aACzC,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,MAAM;YACV,IAAI,CAAC;gBACH,MAAM,QAAQ,EAAE,CAAC;YACnB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjE,OAAO,CAAC,IAAI,CAAC,6DAA6D,OAAO,EAAE,CAAC,CAAC;YACvF,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/renderer/pipeline.d.ts

@@ -0,0 +1,134 @@
+import type { RenderContext } from '@crowi/plugin-api';
+import type { Root } from 'mdast';
+import type { TocEntryResponse, WikiLinkResponse, MentionResponse } from '@crowi/api-contract';
+import type { MongoCacheStorage } from './cache';
+import { type MentionUsernameResolver } from './core/mention-resolve';
+import { RendererRegistryImpl } from './registry';
+/**
+ * Output of a single pipeline run. The mdast tree itself is currently
+ * only consumed by the pipeline (and discarded after metadata
+ * extraction); Phase 3 will start using it for SSR HTML generation.
+ */
+export interface PipelineResult {
+    tree: Root;
+    metadata: PipelineMetadata;
+}
+/** Metadata collected during the transform phase. */
+export interface PipelineMetadata {
+    toc: TocEntryResponse[];
+    wikiLinks: WikiLinkResponse[];
+    mentions: MentionResponse[];
+    codeBlockLanguages: string[];
+}
+/**
+ * Lazily-resolved ESM-only handles needed by the pipeline + core
+ * plugins. unified, remark-parse, remark-gfm, github-slugger,
+ * mdast-util-to-string, and shiki are all ESM-only; they are loaded
+ * from CJS Express via a wrapped `Function('return import(...)')` call
+ * so TypeScript with `module: commonjs` doesn't downlevel the import
+ * to `require()` (which fails on ESM packages with `ERR_REQUIRE_ESM`).
+ *
+ * Loaded once and cached process-wide for the lifetime of the
+ * Crowi instance.
+ */
+export interface PipelineEsmDeps {
+    unified: () => UnifiedProcessor;
+    remarkParse: unknown;
+    remarkGfm: unknown;
+    /**
+     * GFM-compatible single-newline → `<br>` conversion. Crowi default;
+     * matches GitHub's rendering. Plugged in between the core 4 and the
+     * registry transforms so heading slugs (computed via `mdastToString`
+     * in the headings transform) are unaffected by injected `break`
+     * nodes — anchors stay byte-identical to the GFM-only build.
+     */
+    remarkBreaks: unknown;
+    GithubSlugger: new () => {
+        slug(text: string): string;
+    };
+    mdastToString: (node: unknown) => string;
+    /**
+     * Pre-warmed shiki highlighter bound to a **dual theme** (`github-light`
+     * + `github-dark`) and the bundled language set. Lazily initialised on
+     * first pipeline run; subsequent runs share the same instance.
+     *
+     * Emitted markup uses shiki's `defaultColor: false` mode, so each token
+     * carries `--shiki-light` / `--shiki-dark` CSS variables (and the `<pre>`
+     * carries `--shiki-light-bg` / `--shiki-dark-bg`) instead of a single
+     * inlined colour. The web side (`globals.css` `.shiki` rules) then picks
+     * the light or dark variable per `.dark` class — see the dark-mode
+     * feature. Dynamic language loading is deferred to a later phase.
+     */
+    shikiHighlighter: ShikiHighlighter;
+}
+/**
+ * Subset of shiki's `Highlighter` we actually use. Bound to a
+ * single theme so callers don't have to re-pass it at every call.
+ */
+export interface ShikiHighlighter {
+    /** Synchronously render `code` to themed `<pre><code>...</code></pre>` HTML. */
+    codeToHtml(code: string, lang: string): string;
+    /** Best-effort check; cheap, does NOT throw on unknown langs. */
+    hasLang(lang: string): boolean;
+}
+interface UnifiedProcessor {
+    use(plugin: unknown, options?: unknown): UnifiedProcessor;
+    parse(input: string): Root;
+    runSync(tree: Root): Root;
+}
+/**
+ * Loader for the ESM-only pipeline deps. Node 22 supports synchronous
+ * `require()` of ESM modules natively (`--experimental-require-module`
+ * default-on since 22.12), so from a CJS module we can just `require`
+ * unified, remark-parse, remark-gfm, github-slugger, and
+ * mdast-util-to-string. The `Function('return require(...)')` wrapper
+ * dodges the `transformIgnorePatterns` jest cache that sometimes
+ * routes plain require() into ts-jest's resolver.
+ *
+ * Each `Renderer` instance owns its own cache (via
+ * `createPipelineEsmDepsLoader()` in renderer/index.ts); sharing a
+ * module-level cache across Crowi instances breaks under jest where
+ * each test file boots a fresh `Crowi`.
+ */
+export type LoadPipelineEsmDeps = () => Promise<PipelineEsmDeps>;
+export declare function createPipelineEsmDepsLoader(): LoadPipelineEsmDeps;
+/**
+ * Run the parse → transform pipeline against `body` and return the
+ * mdast tree plus the collected metadata. The transform order is
+ * fixed: registry-stored plugins run AFTER core registrations, in
+ * registration order; node renderers fire after each transformer-driven
+ * plugin completes.
+ *
+ * Phase 2 does NOT render to HTML — callers receive `metadata` and
+ * (optionally) the tree. The body's HTML is still generated by
+ * react-markdown on the web client.
+ */
+/**
+ * Phase 4 plugin-dispatch options. Threaded through `runPipeline` so
+ * the embed-tag + url-inline-expand transforms can reach the cache
+ * storage and know which page they are rendering for.
+ *
+ * - `cache`: MongoDB-backed `CacheStorage`. The dispatch transforms
+ *   per-plugin scope this internally.
+ * - `pageId`: the embed cache key is `(pluginName, pluginCacheVersion,
+ *   pageId, embedKey)`. When unknown (e.g. on-the-fly fallback for an
+ *   orphan revision body or unit tests bypassing Mongo), the dispatch
+ *   transforms degrade to no-op — `@[tag](url)` stays as plain text.
+ */
+export interface PipelinePluginDispatch {
+    cache: MongoCacheStorage;
+    pageId: string | null;
+    /**
+     * Phase 2 mention existence resolver — batch-checks which `@username`
+     * mentions belong to real users. Built from the `User` model by
+     * `createRenderer`'s `crowi` closure. When supplied AND the render is
+     * in `mode: 'save'`, the mention-resolve transform demotes unknown-user
+     * mention link nodes to plain text. Absent (unit tests, non-save runs)
+     * → every `@username` keeps its link node, matching pre-Phase-2
+     * behaviour. This is `pageId`-independent (orphan revision bodies are
+     * still resolved).
+     */
+    resolveMentionUsernames?: MentionUsernameResolver;
+}
+export declare function runPipeline(body: string, registry: RendererRegistryImpl, ctx: RenderContext, loadDeps: LoadPipelineEsmDeps, dispatch?: PipelinePluginDispatch): Promise<PipelineResult>;
+export {};