@nakedcreativity/cee-ms-node 1.0.121 → 2.0.0-beta.0

package/README.md

@@ -0,0 +1,81 @@
+# @nakedcreativity/cee-ms-node
+
+Renders a Cee.ms site from its published files (`pages/site.json`, `pages/{id}.json`, `data/{id}.json`) with the
+site's Liquid templates, and serves verified editor drafts to the Cee.ms editor.
+
+```ts
+import { CacheSource, Ceems } from '@nakedcreativity/cee-ms-node';
+
+const ceems = new Ceems({
+    assets: './src',
+    cacheSource: CacheSource.S3,
+    cacheBucket: 'my-site',
+    viewsPath: './views/',
+    customHandler: true,
+    tags: [],
+    filters: [],
+});
+
+ceems.app.get(/(.*)/, async (req, res) => {
+    const page = await ceems.load(req, res, true);
+    ceems.render(page, req, res);
+});
+```
+
+## Draft previews
+
+The editor loads `GET /draft/{pageId}?token=…` in an iframe. The renderer verifies the token, fetches the draft from
+the Cee.ms API, and renders it with module markers and the editor bridge. `&module={id}` renders one module and
+`&region={key}` one region, so the editor can refresh just what changed.
+
+Set these in the site's environment (or `config.preview`). Without the first three, `/draft` returns 404.
+
+| Variable                 | Purpose                                                       |
+| ------------------------ | ------------------------------------------------------------- |
+| `CEEMS_PREVIEW_SECRET`   | The site's preview secret. Signs and verifies preview tokens. |
+| `CEEMS_API_URL`          | The Cee.ms API, e.g. `https://api.cee.ms`.                    |
+| `CEEMS_EDITOR_ORIGIN`    | The editor's origin; the only page allowed to frame drafts.   |
+| `CEEMS_BRIDGE_SRC`       | URL of the versioned editor bridge script.                    |
+| `CEEMS_BRIDGE_INTEGRITY` | Its Subresource Integrity hash.                               |
+
+Draft responses send `Cache-Control: no-store`, `X-Robots-Tag: noindex`, `frame-ancestors <editor origin>` and
+`Referrer-Policy: no-referrer` (the token is in the URL).
+
+## Upgrading a site from 1.x
+
+2.0 ships with Cee.ms v2. Upgrade a site when it moves to v2: the 1.x `POST /draft` that the old editor uses is gone.
+
+- **Node 22 or later.** Update the Lambda runtime.
+- **Set the preview variables** above.
+- **No code changes are needed for the common pattern** (`ceems.load(req, res, true)` then `ceems.render(page, …)`,
+  `ceems.site`, `ceems.loadS3File`, `ceems.loadLocalFile`, `context.globals` in custom tags). `ceems.site` is now
+  always the published site; it never holds draft data.
+- **`ceems.engine.options.globals.metadata = …` still works.** It can move to the new `globals` config option.
+- **Custom tags that call `engine.renderFile(file, scope)`** should pass `{ globals: context.globals }` as the third
+  argument (or use `context.getAll()` as the scope, as most do), so partials see the site data.
+- **`?edit` on a public URL no longer adds edit markup.** Only verified drafts do.
+- **`aws-sdk` v2 is no longer a dependency.** A site that imports it directly must add it itself, or move to v3.
+- **Edit mode no longer injects jQuery.**
+
+## What changed in 2.0
+
+- **Requests no longer share state.** 1.x kept the current page, site and pagination on the shared `Ceems` instance
+  and re-registered the navigation, blog and breadcrumb tags on every request with that request's page. When requests
+  overlapped, one could render with another's page or navigation, and a public visitor could be served draft
+  content. Each render now carries its own state, passed to templates and tags as render-time globals, and tags are
+  registered once.
+- **Drafts are authenticated** (above). The unauthenticated `POST /draft` is removed.
+- **The `{% image %}` tag** kept its arguments on the module, so every `image` tag in a site used the arguments of
+  whichever one was parsed last. Fixed.
+- **A blog page past the last article** is a 404, not a 500.
+- **Errors** return a generic message instead of `error.message`, and page data is no longer logged.
+- **Dependencies:** AWS SDK v3, cheerio 1.x, liquidjs 10.30, Express's own body parsers; underscore removed.
+
+## Development
+
+```sh
+npm install
+npm test        # Vitest
+npm run dev     # local server over test/fixtures/site on http://localhost:3030/
+npm run build   # lib/
+```

package/lib/draft.d.ts

@@ -0,0 +1,20 @@
+import type express from 'express';
+import type { CeemsPage, CeemsSite, PreviewConfig } from './interfaces';
+export type DraftResult = {
+    ok: true;
+    page: CeemsPage;
+    site: CeemsSite;
+} | {
+    ok: false;
+    status: 401 | 404 | 502;
+};
+export interface DraftService {
+    fetch(pageId: string, token: string): Promise<DraftResult>;
+    setHeaders(res: express.Response): void;
+    injectBridge(html: string): string;
+}
+/**
+ * Draft previews, or `null` when this site is not configured for them (they then 404). Needs the site's
+ * preview secret, the API URL and the editor origin.
+ */
+export declare function draftServiceFor(config?: PreviewConfig): DraftService | null;

package/lib/draft.js

@@ -0,0 +1,109 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.draftServiceFor = draftServiceFor;
+const cheerio = __importStar(require("cheerio"));
+const preview_token_1 = require("./preview-token");
+const DRAFT_QUERY = 'query Draft($token: String!) { draftRenderPayload(token: $token) { page site } }';
+/**
+ * Draft previews, or `null` when this site is not configured for them (they then 404). Needs the site's
+ * preview secret, the API URL and the editor origin.
+ */
+function draftServiceFor(config = {}) {
+    const secret = config.secret || process.env.CEEMS_PREVIEW_SECRET;
+    const apiUrl = config.apiUrl || process.env.CEEMS_API_URL;
+    const editorOrigin = config.editorOrigin || process.env.CEEMS_EDITOR_ORIGIN;
+    const bridge = config.bridge ||
+        (process.env.CEEMS_BRIDGE_SRC
+            ? { src: process.env.CEEMS_BRIDGE_SRC, integrity: process.env.CEEMS_BRIDGE_INTEGRITY }
+            : undefined);
+    if (!secret || !apiUrl || !editorOrigin)
+        return null;
+    const graphqlUrl = apiUrl.replace(/\/$/, '') + '/graphql';
+    return {
+        async fetch(pageId, token) {
+            if (!(0, preview_token_1.verifyPreviewToken)(secret, token, pageId).ok)
+                return { ok: false, status: 401 };
+            let body;
+            try {
+                const response = await fetch(graphqlUrl, {
+                    method: 'POST',
+                    headers: { 'content-type': 'application/json' },
+                    body: JSON.stringify({ query: DRAFT_QUERY, variables: { token } }),
+                    signal: AbortSignal.timeout(10_000),
+                });
+                body = await response.json();
+            }
+            catch (error) {
+                console.error('[ceems] draft fetch failed', error instanceof Error ? error.message : error);
+                return { ok: false, status: 502 };
+            }
+            const payload = body?.data?.draftRenderPayload;
+            if (!payload) {
+                const code = body?.errors?.[0]?.extensions?.code;
+                if (code === 'UNAUTHENTICATED' || code === 'FORBIDDEN')
+                    return { ok: false, status: 401 };
+                if (code === 'NOT_FOUND')
+                    return { ok: false, status: 404 };
+                return { ok: false, status: 502 };
+            }
+            return { ok: true, page: JSON.parse(payload.page), site: JSON.parse(payload.site) };
+        },
+        setHeaders(res) {
+            res.set({
+                'Cache-Control': 'no-store',
+                'X-Robots-Tag': 'noindex, nofollow',
+                'Content-Security-Policy': `frame-ancestors ${editorOrigin}`,
+                // The token is in the URL: never send it on to the page's assets and links.
+                'Referrer-Policy': 'no-referrer',
+                'X-Content-Type-Options': 'nosniff',
+            });
+        },
+        injectBridge(html) {
+            const $ = cheerio.load(html);
+            $('body').addClass('cee-ms-edit');
+            if (bridge) {
+                const script = $('<script defer></script>')
+                    .attr('src', bridge.src)
+                    .attr('data-editor-origin', editorOrigin);
+                if (bridge.integrity)
+                    script.attr('integrity', bridge.integrity).attr('crossorigin', 'anonymous');
+                $('body').append(script);
+            }
+            return $.html();
+        },
+    };
+}
+//# sourceMappingURL=draft.js.map

package/lib/draft.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"draft.js","sourceRoot":"","sources":["../src/draft.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBA,0CAiEC;AAnFD,iDAAmC;AAEnC,mDAAqD;AAUrD,MAAM,WAAW,GAAG,kFAAkF,CAAC;AAEvG;;;GAGG;AACH,SAAgB,eAAe,CAAC,SAAwB,EAAE;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;IACjE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAC1D,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAC5E,MAAM,MAAM,GACR,MAAM,CAAC,MAAM;QACb,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB;YACzB,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE;YACtF,CAAC,CAAC,SAAS,CAAC,CAAC;IAErB,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,IAAI,CAAC,YAAY;QAAE,OAAO,IAAI,CAAC;IACrD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,UAAU,CAAC;IAE1D,OAAO;QACH,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK;YACrB,IAAI,CAAC,IAAA,kCAAkB,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,EAAE;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;YAErF,IAAI,IAAS,CAAC;YACd,IAAI,CAAC;gBACD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE;oBACrC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;oBAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC;oBAClE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;iBACtC,CAAC,CAAC;gBACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACjC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gBAC5F,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;YACtC,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,EAAE,IAAI,EAAE,kBAAkB,CAAC;YAC/C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACX,MAAM,IAAI,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC;gBACjD,IAAI,IAAI,KAAK,iBAAiB,IAAI,IAAI,KAAK,WAAW;oBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;gBAC1F,IAAI,IAAI,KAAK,WAAW;oBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;gBAC5D,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;YACtC,CAAC;YACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxF,CAAC;QAED,UAAU,CAAC,GAAG;YACV,GAAG,CAAC,GAAG,CAAC;gBACJ,eAAe,EAAE,UAAU;gBAC3B,cAAc,EAAE,mBAAmB;gBACnC,yBAAyB,EAAE,mBAAmB,YAAY,EAAE;gBAC5D,4EAA4E;gBAC5E,iBAAiB,EAAE,aAAa;gBAChC,wBAAwB,EAAE,SAAS;aACtC,CAAC,CAAC;QACP,CAAC;QAED,YAAY,CAAC,IAAI;YACb,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAClC,IAAI,MAAM,EAAE,CAAC;gBACT,MAAM,MAAM,GAAG,CAAC,CAAC,yBAAyB,CAAC;qBACtC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC;qBACvB,IAAI,CAAC,oBAAoB,EAAE,YAAY,CAAC,CAAC;gBAC9C,IAAI,MAAM,CAAC,SAAS;oBAAE,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;gBAClG,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC7B,CAAC;YACD,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;QACpB,CAAC;KACJ,CAAC;AACN,CAAC"}

package/lib/filters/active.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerActiveFilter = void 0;
+exports.registerActiveFilter = registerActiveFilter;
 function registerActiveFilter(engine) {
     engine.registerFilter('active', (path, match, cssClass) => {
         const regex = new RegExp('^' + match + '(?!([a-z0-9-_]+))');
@@ -12,5 +12,4 @@ function registerActiveFilter(engine) {
         }
     });
 }
-exports.registerActiveFilter = registerActiveFilter;
 //# sourceMappingURL=active.js.map

package/lib/filters/active.js.map

@@ -1 +1 @@
-{"version":3,"file":"active.js","sourceRoot":"","sources":["../../src/filters/active.ts"],"names":[],"mappings":";;;AAEA,SAAgB,oBAAoB,CAAC,MAAc;IAC/C,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;QACtD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,GAAG,GAAG,KAAK,GAAG,mBAAmB,CAAC,CAAC;QAE5D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAClB,OAAO,QAAQ,CAAC;SACnB;aAAM;YACH,OAAO,EAAE,CAAC;SACb;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAVD,oDAUC"}
+{"version":3,"file":"active.js","sourceRoot":"","sources":["../../src/filters/active.ts"],"names":[],"mappings":";;AAEA,oDAUC;AAVD,SAAgB,oBAAoB,CAAC,MAAc;IAC/C,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;QACtD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,GAAG,GAAG,KAAK,GAAG,mBAAmB,CAAC,CAAC;QAE5D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,OAAO,QAAQ,CAAC;QACpB,CAAC;aAAM,CAAC;YACJ,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}

package/lib/filters/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/filters/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/filters/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyB;AACzB,4CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/filters/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,4CAA0B"}

package/lib/filters/slugify.js

@@ -3,16 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerSlugifyFilter = void 0;
+exports.registerSlugifyFilter = registerSlugifyFilter;
 const slugify_1 = __importDefault(require("slugify"));
 function registerSlugifyFilter(engine) {
     engine.registerFilter('slugify', (string, replacement) => {
-        return slugify_1.default(string, {
+        return (0, slugify_1.default)(string, {
             lower: true,
             strict: true,
-            replacement: replacement || '-'
+            replacement: replacement || '-',
         });
     });
 }
-exports.registerSlugifyFilter = registerSlugifyFilter;
 //# sourceMappingURL=slugify.js.map

package/lib/filters/slugify.js.map

@@ -1 +1 @@
-{"version":3,"file":"slugify.js","sourceRoot":"","sources":["../../src/filters/slugify.ts"],"names":[],"mappings":";;;;;;AACA,sDAA6B;AAE7B,SAAgB,qBAAqB,CAAC,MAAc;IAChD,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,MAAc,EAAE,WAAoB,EAAE,EAAE;QACtE,OAAO,iBAAO,CAAC,MAAM,EAAE;YACnB,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,IAAI;YACZ,WAAW,EAAE,WAAW,IAAI,GAAG;SAClC,CAAC,CAAA;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AARD,sDAQC"}
+{"version":3,"file":"slugify.js","sourceRoot":"","sources":["../../src/filters/slugify.ts"],"names":[],"mappings":";;;;;AAGA,sDAQC;AAVD,sDAA8B;AAE9B,SAAgB,qBAAqB,CAAC,MAAc;IAChD,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;QACrD,OAAO,IAAA,iBAAO,EAAC,MAAM,EAAE;YACnB,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,IAAI;YACZ,WAAW,EAAE,WAAW,IAAI,GAAG;SAClC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC"}

package/lib/index.d.ts

@@ -1,20 +1,61 @@
 import express from 'express';
 import { Liquid } from 'liquidjs';
-import { S3 } from 'aws-sdk';
-import { CeemsConfig, CeemsPage, CeemsRequest } from './interfaces';
+import { CeemsConfig, CeemsPage, CeemsRequest, CeemsSite, RenderState } from './interfaces';
+import { Storage } from './storage';
+export * from './interfaces';
+export { signPreviewToken, verifyPreviewToken } from './preview-token';
+export { renderState } from './state';
+/**
+ * A Cee.ms site renderer: an Express app that renders published pages, and verified editor drafts, with the
+ * site's Liquid templates.
+ *
+ * One instance serves every request, so nothing about a request is stored on it. Each render carries its own
+ * `RenderState` (site, page, edit mode), passed to templates and tags as render-time globals.
+ */
 export declare class Ceems {
-    app: express.Server;
+    app: express.Express;
     engine: Liquid;
-    site: any;
-    pagination: number;
     config: CeemsConfig;
-    s3: S3;
+    /** The latest published `site.json`, refreshed on every public request. Never holds draft data. */
+    site: CeemsSite | undefined;
+    storage: Storage;
+    private drafts;
     constructor(config: CeemsConfig);
-    loadSite(draft?: any): Promise<void>;
+    private registerTags;
+    /** Loads the published `site.json`, remembers it as `this.site`, and returns it. */
+    loadSite(): Promise<CeemsSite>;
+    /**
+     * Loads the published page for the request's path (or the `404` page), ready for `render`. With
+     * `loadPage` false, returns `page` as given (for custom routes that build their own page object).
+     */
     load(req: CeemsRequest, res: express.Response, loadPage?: boolean, page?: CeemsPage): Promise<CeemsPage>;
-    loadLocalFile(filename: any): any;
-    loadS3File(filename: any): Promise<any>;
+    /** Reads `pages/<id>.json`. */
+    loadPageFile(id: string): Promise<CeemsPage>;
+    /** Synchronous local read, kept for custom tags. `filename` is a full path. */
+    loadLocalFile(filename: string): any;
+    /** Reads and parses a published JSON file, kept for custom tags. `filename` is relative to the bucket. */
+    loadS3File(filename: string): Promise<any>;
+    /** The site path for a request (`home` for `/`), and the blog page number if the URL ends in one. */
+    parsePath(req: CeemsRequest): {
+        path: string;
+        pagination: number | null;
+    };
+    /** @deprecated Use `parsePath`. */
     getPath(req: CeemsRequest): string;
+    /** The Liquid globals for one render: the site data, static globals, and the render state. */
+    private globalsFor;
+    private renderModule;
+    private renderRegion;
+    /** Renders a full page with its layout template. */
+    renderPage(state: RenderState): Promise<string>;
+    /**
+     * Renders a page from `load`. Sends the HTML, or returns it when `send` is false. On failure, sends a
+     * generic error (404 for a blog page past the last article) and resolves to undefined.
+     */
     render(page: CeemsPage, req: CeemsRequest, res: express.Response, send?: boolean): Promise<string | void>;
-    postDraft(req: CeemsRequest, res: express.Response): Promise<void>;
+    /**
+     * `GET /draft/:pageId?token=…[&module=<id>|&region=<key>]`: a verified editor draft, as a full page, one
+     * module, or one region. The token is checked here, then used to fetch the draft from the Cee.ms API.
+     */
+    handleDraft(req: CeemsRequest, res: express.Response): Promise<void>;
 }