@norskvideo/ctl-sdk 0.1.21 → 0.1.22

package/docs-router.d.ts

@@ -0,0 +1,21 @@
+import { type Express } from "express";
+/**
+ * Where a product's docs bundle (dev-kit doc-guide `buildBundle`) is, given the
+ * backend's own directory — or null when the product shipped none.
+ *
+ * Two layouts, one relative path: the image bakes the bundle at `<app>/docs`
+ * beside `backend/` (Dockerfile.bundle), a repo checkout has it at
+ * `<repo>/docs/generated/bundle`; from `backend/dist` and `backend/src`
+ * respectively both are `../../docs`. The image's `docs/` exists even when
+ * empty, so presence is judged by `bundle.json`, not the directory.
+ */
+export declare function docsBundleDir(fromDir: string): string | null;
+/**
+ * Mount the docs bundle at `/docs`: `manual.html` as the index, `bundle.json`,
+ * `pages/*.md` and `captures/*` by path. Returns whether anything was mounted,
+ * so a product without a bundle boots exactly as before. `/docs` redirects to
+ * `/docs/` with a root-absolute Location, which the daemon's product proxy
+ * rewrites under `/products/<name>` — so the manual's hash routing works
+ * through the daemon too.
+ */
+export declare function serveDocs(app: Express, dir: string | null): boolean;

package/docs-router.js

@@ -0,0 +1,35 @@
+import { existsSync } from "node:fs";
+import { resolve } from "node:path";
+import express from "express";
+/**
+ * Where a product's docs bundle (dev-kit doc-guide `buildBundle`) is, given the
+ * backend's own directory — or null when the product shipped none.
+ *
+ * Two layouts, one relative path: the image bakes the bundle at `<app>/docs`
+ * beside `backend/` (Dockerfile.bundle), a repo checkout has it at
+ * `<repo>/docs/generated/bundle`; from `backend/dist` and `backend/src`
+ * respectively both are `../../docs`. The image's `docs/` exists even when
+ * empty, so presence is judged by `bundle.json`, not the directory.
+ */
+export function docsBundleDir(fromDir) {
+    const docs = resolve(fromDir, "../../docs");
+    for (const candidate of [docs, resolve(docs, "generated/bundle")]) {
+        if (existsSync(resolve(candidate, "bundle.json")))
+            return candidate;
+    }
+    return null;
+}
+/**
+ * Mount the docs bundle at `/docs`: `manual.html` as the index, `bundle.json`,
+ * `pages/*.md` and `captures/*` by path. Returns whether anything was mounted,
+ * so a product without a bundle boots exactly as before. `/docs` redirects to
+ * `/docs/` with a root-absolute Location, which the daemon's product proxy
+ * rewrites under `/products/<name>` — so the manual's hash routing works
+ * through the daemon too.
+ */
+export function serveDocs(app, dir) {
+    if (!dir)
+        return false;
+    app.use("/docs", express.static(dir, { index: "manual.html" }));
+    return true;
+}

package/index.d.ts

@@ -3,6 +3,7 @@ export * from "./capabilities-router.js";
 export * from "./cjs-interop.js";
 export * from "./dev-url.js";
 export * from "./docker-runner.js";
+export * from "./docs-router.js";
 export * from "./http-proxy.js";
 export * from "./license-registration.js";
 export * from "./license-staged.js";

package/index.js

@@ -5,6 +5,7 @@ export * from "./capabilities-router.js";
 export * from "./cjs-interop.js";
 export * from "./dev-url.js";
 export * from "./docker-runner.js";
+export * from "./docs-router.js";
 export * from "./http-proxy.js";
 export * from "./license-registration.js";
 export * from "./license-staged.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@norskvideo/ctl-sdk",
-  "version": "0.1.21",
+  "version": "0.1.22",
   "type": "module",
   "exports": {
     ".": {