@crowi/api 2.0.0-alpha.0

package/dist/hono/handlers/page-preview.d.ts

@@ -0,0 +1,48 @@
+import type { OpenAPIHono } from '@hono/zod-openapi';
+import type Crowi from '../../crowi';
+import type { CrowiHonoBindings } from '../app';
+export declare const registerPagePreviewRoutes: <E extends OpenAPIHono<CrowiHonoBindings>>(app: E, crowi: Crowi) => OpenAPIHono<CrowiHonoBindings, {
+    "/pages/preview": {
+        $post: {
+            input: {
+                json: {
+                    body: string;
+                };
+            };
+            output: {
+                renderedAst: import("hono/utils/types").JSONValue;
+            };
+            outputFormat: "json";
+            status: 200;
+        } | {
+            input: {
+                json: {
+                    body: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "AUTHENTICATION_REQUIRED";
+                    message: "Authentication is required";
+                    redirectTo?: string | undefined;
+                };
+            };
+            outputFormat: "json";
+            status: 401;
+        } | {
+            input: {
+                json: {
+                    body: string;
+                };
+            };
+            output: {
+                error: {
+                    code: "INTERNAL_ERROR";
+                    message: "Internal server error";
+                };
+            };
+            outputFormat: "json";
+            status: 500;
+        };
+    };
+}, "/">;

package/dist/hono/handlers/page-preview.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerPagePreviewRoutes = void 0;
+/**
+ * RFC-0006 Phase 4 Batch 4 — `pagePreview` resource Hono port.
+ *
+ * Replaces `packages/api/src/routes/ts-rest/page-preview.ts`. Single
+ * endpoint:
+ *
+ *   POST /pages/preview — render arbitrary markdown to mdast
+ *
+ * Auth is shared with the `page` resource: the `revision` handler
+ * applies `createJwtAuth(crowi)` broadly to `/pages/*` (and bare
+ * `/pages`), so this handler relies on the established register order
+ * (`revision -> page -> page-preview` in `buildHonoApp`) and does NOT
+ * install jwtAuth itself. Hono does not dedupe middleware by reference;
+ * re-installing it would cost a second JWT verify + `User.findById`
+ * per request. See the page handler file header for the longer
+ * rationale.
+ *
+ * The renderer pipeline is shared with the save path so edit-preview
+ * and page-show produce byte-identical trees for the same input. We
+ * call `getRenderer().run()` (not `runRender()`) so we can intercept
+ * the raw mdast tree and stamp `data.hProperties['data-source-line']`
+ * on every top-level block before serialising — that's how the editor
+ * scroll-sync ties CodeMirror viewport positions to preview-pane
+ * blocks bidirectionally.
+ */
+const api_contract_1 = require("@crowi/api-contract");
+const debug_1 = __importDefault(require("debug"));
+const renderer_1 = require("../../renderer");
+const errors_1 = require("./_helpers/errors");
+const debug = (0, debug_1.default)('crowi:hono:handlers:page-preview');
+/**
+ * Attach `data-source-line="<1-based-line>"` to every top-level mdast
+ * child via `data.hProperties`. `mdast-util-to-hast` flows this onto
+ * the produced hast node's `properties`, and `hast-util-to-jsx-runtime`
+ * surfaces it as a real DOM attribute — giving the editor preview a
+ * way to bidirectionally scroll-sync with the CodeMirror viewport.
+ *
+ * Only top-level children are tagged: scroll sync anchors on block
+ * boundaries, and inline children inside a paragraph share the parent's
+ * source line.
+ */
+const injectSourceLineAnchors = (tree) => {
+    for (const child of tree.children) {
+        const line = child.position?.start?.line;
+        if (typeof line !== 'number')
+            continue;
+        const node = child;
+        const data = node.data ?? (node.data = {});
+        const hProperties = data.hProperties ?? (data.hProperties = {});
+        hProperties['data-source-line'] = line;
+    }
+};
+const registerPagePreviewRoutes = (app, crowi) => {
+    return app.openapi(api_contract_1.previewPageRoute, async (c) => {
+        const { body } = c.req.valid('json');
+        try {
+            // `mode: 'view'` mirrors what `computeRevisionRenderArtifactsAsync`
+            // uses for read-path on-the-fly fallback; the registered transforms
+            // decide whether to short-circuit based on it. No `pageId` is
+            // supplied — plugin-dispatch transforms degrade to plain text in
+            // that case, which is the right behaviour for preview content that
+            // may belong to no persisted page yet.
+            //
+            // `getRenderer()` throws if setup hasn't run; the catch maps it to
+            // 500 alongside any pipeline failure.
+            const { tree } = await crowi.getRenderer().run(body, { mode: 'view' });
+            injectSourceLineAnchors(tree);
+            return c.json({ renderedAst: (0, renderer_1.serializeMdast)(tree) }, 200);
+        }
+        catch (err) {
+            debug('preview pipeline failed:', err.message);
+            return c.json(errors_1.INTERNAL_ERROR_BODY, 500);
+        }
+    });
+};
+exports.registerPagePreviewRoutes = registerPagePreviewRoutes;
+//# sourceMappingURL=page-preview.js.map

package/dist/hono/handlers/page-preview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-preview.js","sourceRoot":"","sources":["../../../src/hono/handlers/page-preview.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,sDAAuD;AAEvD,kDAA0B;AAI1B,2CAA8C;AAI9C,8CAAwD;AAExD,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,kCAAkC,CAAC,CAAC;AAQxD;;;;;;;;;;GAUG;AACH,MAAM,uBAAuB,GAAG,CAAC,IAAU,EAAQ,EAAE;IACnD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;QACzC,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,SAAS;QACvC,MAAM,IAAI,GAAG,KAA4B,CAAC;QAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;QAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC;QAChE,WAAW,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;IACzC,CAAC;AACH,CAAC,CAAC;AAEK,MAAM,yBAAyB,GAAG,CAA2C,GAAM,EAAE,KAAY,EAAE,EAAE;IAC1G,OAAO,GAAG,CAAC,OAAO,CAAC,+BAAgB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAErC,IAAI,CAAC;YACH,oEAAoE;YACpE,oEAAoE;YACpE,8DAA8D;YAC9D,iEAAiE;YACjE,mEAAmE;YACnE,uCAAuC;YACvC,EAAE;YACF,mEAAmE;YACnE,sCAAsC;YACtC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;YACvE,uBAAuB,CAAC,IAAI,CAAC,CAAC;YAC9B,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,IAAA,yBAAc,EAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,KAAK,CAAC,0BAA0B,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;YAC1D,OAAO,CAAC,CAAC,IAAI,CAAC,4BAAmB,EAAE,GAAG,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAtBW,QAAA,yBAAyB,6BAsBpC"}