@blinkk/root-cms 3.0.6 → 3.1.2

package/dist/browser-client.js

@@ -0,0 +1,377 @@
+import {
+  normalizeSlug
+} from "./chunk-J72JK4KR.js";
+import "./chunk-MLKGABMK.js";
+
+// shared/embed-protocol.ts
+var SaveState = /* @__PURE__ */ ((SaveState3) => {
+  SaveState3["NO_CHANGES"] = "NO_CHANGES";
+  SaveState3["UPDATES_PENDING"] = "UPDATE_PENDING";
+  SaveState3["SAVING"] = "SAVING";
+  SaveState3["SAVED"] = "SAVED";
+  SaveState3["ERROR"] = "ERROR";
+  return SaveState3;
+})(SaveState || {});
+var EMBED_MESSAGE_TYPES = ["ready", "saved", "published", "error"];
+function isRootEmbedMessage(data) {
+  const root = data?.root;
+  return typeof root === "object" && root !== null && EMBED_MESSAGE_TYPES.includes(root.type);
+}
+function isHighlightNodeMessage(data) {
+  const req = data?.highlightNode;
+  return typeof req === "object" && req !== null && (typeof req.deepKey === "string" || req.deepKey === null);
+}
+
+// browser-client/emitter.ts
+var Emitter = class {
+  constructor() {
+    this.listeners = /* @__PURE__ */ new Map();
+  }
+  /** Subscribes to an event. Returns an unsubscribe function. */
+  on(type, cb) {
+    let set = this.listeners.get(type);
+    if (!set) {
+      set = /* @__PURE__ */ new Set();
+      this.listeners.set(type, set);
+    }
+    set.add(cb);
+    return () => this.off(type, cb);
+  }
+  off(type, cb) {
+    this.listeners.get(type)?.delete(cb);
+  }
+  emit(type, payload) {
+    this.listeners.get(type)?.forEach((cb) => cb(payload));
+  }
+  removeAll() {
+    this.listeners.clear();
+  }
+};
+
+// browser-client/embed-window.ts
+var POPUP_POLL_INTERVAL = 500;
+var DEFAULT_POPUP_WIDTH = 480;
+var DEFAULT_POPUP_HEIGHT = 720;
+var EmbedWindow = class {
+  constructor(url, cmsOrigin, options) {
+    /** The iframe element (iframe mode only). */
+    this.element = null;
+    /** The pop-up window (popup mode only). */
+    this.window = null;
+    this.emitter = new Emitter();
+    this.ready = false;
+    this.closed = false;
+    this.outbox = [];
+    this.pollTimer = null;
+    this.onMessage = (event) => {
+      if (event.origin !== this.cmsOrigin) {
+        return;
+      }
+      if (!event.source || event.source !== this.contentWindow()) {
+        return;
+      }
+      if (!isRootEmbedMessage(event.data)) {
+        return;
+      }
+      const root = event.data.root;
+      if (root.type === "ready") {
+        this.ready = true;
+        const outbox = this.outbox;
+        this.outbox = [];
+        outbox.forEach((message) => this.post(message));
+      }
+      this.emitter.emit(root.type, root);
+    };
+    this.url = url;
+    this.cmsOrigin = cmsOrigin;
+    window.addEventListener("message", this.onMessage);
+    const mode = options?.mode || "popup";
+    if (mode === "iframe") {
+      if (!options?.container) {
+        throw new Error('`container` is required when mode is "iframe"');
+      }
+      const iframe = document.createElement("iframe");
+      iframe.className = "root-cms-embed";
+      iframe.src = url;
+      options.container.appendChild(iframe);
+      this.element = iframe;
+    } else {
+      const width = options?.width ?? DEFAULT_POPUP_WIDTH;
+      const height = options?.height ?? DEFAULT_POPUP_HEIGHT;
+      const popup = window.open(
+        url,
+        "_blank",
+        `popup,width=${width},height=${height}`
+      );
+      if (!popup) {
+        queueMicrotask(() => {
+          this.emitter.emit("error", {
+            error: "popup blocked (open the editor from a user gesture, e.g. a click handler)"
+          });
+          this.close();
+        });
+      } else {
+        this.window = popup;
+        this.pollTimer = setInterval(() => {
+          if (popup.closed) {
+            this.close();
+          }
+        }, POPUP_POLL_INTERVAL);
+      }
+    }
+  }
+  on(type, cb) {
+    return this.emitter.on(type, cb);
+  }
+  /**
+   * Posts a message to the embedded window, targeted at the CMS origin.
+   * Messages are buffered until the embedded page signals `ready`.
+   */
+  post(message) {
+    if (this.closed) {
+      return;
+    }
+    if (!this.ready) {
+      this.outbox.push(message);
+      return;
+    }
+    this.contentWindow()?.postMessage(message, this.cmsOrigin);
+  }
+  /** Reloads the embedded page. */
+  reload() {
+    if (this.closed) {
+      return;
+    }
+    this.ready = false;
+    if (this.element) {
+      this.element.src = this.url;
+    } else if (this.window) {
+      this.window.location.href = this.url;
+    }
+  }
+  /** Closes the embedded window. Safe to call multiple times. */
+  close() {
+    if (this.closed) {
+      return;
+    }
+    this.closed = true;
+    window.removeEventListener("message", this.onMessage);
+    if (this.pollTimer !== null) {
+      clearInterval(this.pollTimer);
+      this.pollTimer = null;
+    }
+    this.element?.remove();
+    if (this.window && !this.window.closed) {
+      this.window.close();
+    }
+    this.emitter.emit("close", void 0);
+    this.emitter.removeAll();
+  }
+  contentWindow() {
+    return this.element ? this.element.contentWindow : this.window;
+  }
+};
+
+// browser-client/browser-client.ts
+function isDotSegment(segment) {
+  return segment === "." || segment === "..";
+}
+var EmbeddedEditor = class {
+  constructor(docId, embedWindow) {
+    this.docId = docId;
+    this.embedWindow = embedWindow;
+  }
+  /** The iframe element (iframe mode only). */
+  get element() {
+    return this.embedWindow.element;
+  }
+  /** The pop-up window (popup mode only). */
+  get window() {
+    return this.embedWindow.window;
+  }
+  /** Subscribes to an editor event. Returns an unsubscribe function. */
+  on(type, cb) {
+    return this.embedWindow.on(type, cb);
+  }
+  /** Scrolls the editor to (focuses) a field, e.g. `hero.title`. */
+  focusField(deepKey) {
+    const message = { scrollToDeeplink: { deepKey } };
+    this.embedWindow.post(message);
+  }
+  /** Reloads the embedded editor. */
+  reload() {
+    this.embedWindow.reload();
+  }
+  /** Closes the embedded editor, discarding any unsaved changes. */
+  close() {
+    this.embedWindow.close();
+  }
+  /** Closes the embedded editor and reloads the host page. */
+  closeAndReload() {
+    this.close();
+    window.location.reload();
+  }
+};
+var EmbeddedAI = class {
+  constructor(embedWindow) {
+    this.embedWindow = embedWindow;
+  }
+  /** The iframe element (iframe mode only). */
+  get element() {
+    return this.embedWindow.element;
+  }
+  /** The pop-up window (popup mode only). */
+  get window() {
+    return this.embedWindow.window;
+  }
+  /** Subscribes to an event. Returns an unsubscribe function. */
+  on(type, cb) {
+    return this.embedWindow.on(type, cb);
+  }
+  /** Reloads the embedded chat (starts a fresh chat). */
+  reload() {
+    this.embedWindow.reload();
+  }
+  /** Closes the embedded chat. */
+  close() {
+    this.embedWindow.close();
+  }
+  /** Closes the embedded chat and reloads the host page. */
+  closeAndReload() {
+    this.close();
+    window.location.reload();
+  }
+};
+var PreviewConnection = class {
+  constructor() {
+    this.emitter = new Emitter();
+    this.onMessage = (event) => {
+      if (event.origin !== window.location.origin) {
+        return;
+      }
+      if (!isHighlightNodeMessage(event.data)) {
+        return;
+      }
+      const req = event.data.highlightNode;
+      this.emitter.emit("highlight", {
+        deepKey: req.deepKey,
+        scroll: req.options?.scroll ?? false
+      });
+    };
+    this.isEmbedded = RootCMSBrowserClient.isInPreviewIframe();
+    window.addEventListener("message", this.onMessage);
+  }
+  /**
+   * Requests that the doc editor scroll to (focus) a field, e.g.
+   * `hero.title`. Used to implement "click to edit".
+   */
+  focusField(deepKey) {
+    if (window.parent === window) {
+      return;
+    }
+    const message = { scrollToDeeplink: { deepKey } };
+    window.parent.postMessage(message, window.location.origin);
+  }
+  /**
+   * Subscribes to field highlight requests from the doc editor (sent when the
+   * user hovers/focuses a field). Returns an unsubscribe function.
+   */
+  on(type, cb) {
+    return this.emitter.on(type, cb);
+  }
+  /** Removes the message listener and all subscriptions. */
+  disconnect() {
+    window.removeEventListener("message", this.onMessage);
+    this.emitter.removeAll();
+  }
+};
+var RootCMSBrowserClient = class {
+  constructor(options) {
+    let url;
+    try {
+      url = new URL(options.cmsOrigin);
+    } catch {
+      throw new Error(
+        `invalid cmsOrigin: "${options?.cmsOrigin}" (expected e.g. "https://cms.example.com")`
+      );
+    }
+    if (url.protocol !== "https:" && url.protocol !== "http:") {
+      throw new Error(
+        `invalid cmsOrigin: "${options?.cmsOrigin}" (expected an http(s) origin, e.g. "https://cms.example.com")`
+      );
+    }
+    this.cmsOrigin = url.origin;
+  }
+  /**
+   * Opens the headless doc editor for a doc (e.g. `Pages/about`) in a pop-up
+   * or iframe. In popup mode, call from a user gesture (e.g. a click handler)
+   * to avoid pop-up blockers.
+   *
+   * The slug portion of the docId is normalized the same way the CMS
+   * normalizes slugs, so a URL-like path also works, e.g. `Pages/about/foo`
+   * -> `Pages/about--foo`.
+   */
+  openEditor(docId, options) {
+    const [collection, ...slugParts] = docId.split("/");
+    const slug = normalizeSlug(slugParts.join("/"));
+    if (!collection || !slug || isDotSegment(collection) || isDotSegment(slug)) {
+      throw new Error(
+        `invalid docId: "${docId}" (expected "<collection>/<slug>")`
+      );
+    }
+    const normalizedDocId = `${collection}/${slug}`;
+    const url = new URL(
+      `${this.cmsOrigin}/cms/embed/content/${encodeURIComponent(
+        collection
+      )}/${encodeURIComponent(slug)}`
+    );
+    if (options?.deeplink) {
+      url.searchParams.set("deeplink", options.deeplink);
+    }
+    const embedWindow = new EmbedWindow(
+      url.toString(),
+      this.cmsOrigin,
+      options
+    );
+    return new EmbeddedEditor(normalizedDocId, embedWindow);
+  }
+  /**
+   * Opens the headless Root AI chat in a pop-up or iframe, optionally with a
+   * doc as context. In popup mode, call from a user gesture (e.g. a click
+   * handler) to avoid pop-up blockers.
+   */
+  openRootAI(options) {
+    const url = new URL(`${this.cmsOrigin}/cms/embed/ai`);
+    if (options?.docId) {
+      url.searchParams.set("docId", options.docId);
+    }
+    const embedWindow = new EmbedWindow(
+      url.toString(),
+      this.cmsOrigin,
+      options
+    );
+    return new EmbeddedAI(embedWindow);
+  }
+  /**
+   * Connects to the doc editor from a site rendered inside the in-CMS preview
+   * pane, enabling "click to edit" ({@link PreviewConnection.focusField}) and
+   * field highlighting (`on('highlight', ...)`).
+   */
+  static connectPreview() {
+    return new PreviewConnection();
+  }
+  /** Returns whether this page is rendered inside the in-CMS preview pane. */
+  static isInPreviewIframe() {
+    if (window.parent === window) {
+      return false;
+    }
+    return document.referrer.startsWith(`${window.location.origin}/cms`);
+  }
+};
+export {
+  EmbeddedAI,
+  EmbeddedEditor,
+  PreviewConnection,
+  RootCMSBrowserClient,
+  SaveState
+};

package/dist/{chunk-RXWDB3K4.js → chunk-4VZTYUQ7.js}

@@ -1,6 +1,6 @@
 import {
   getCmsPlugin
-} from "./chunk-N4K6ICFR.js";
+} from "./chunk-AFBSITEO.js";
 
 // core/search-index.ts
 import fs from "node:fs";

package/dist/{chunk-N4K6ICFR.js → chunk-AFBSITEO.js}

@@ -1,3 +1,7 @@
+import {
+  normalizeSlug
+} from "./chunk-J72JK4KR.js";
+
 // core/client.ts
 import crypto from "node:crypto";
 import {
@@ -5,11 +9,6 @@ import {
   Timestamp as Timestamp2
 } from "firebase-admin/firestore";
 
-// shared/slug.ts
-function normalizeSlug(slug) {
-  return slug.replace(/^[\s/]*/g, "").replace(/[\s/]*$/g, "").replace(/^\/+|\/+$/g, "").replaceAll("/", "--");
-}
-
 // core/translations-manager.ts
 import {
   FieldValue,
@@ -2432,7 +2431,6 @@ var BatchResponse = class {
 };
 
 export {
-  normalizeSlug,
   TranslationsManager,
   buildTranslationsDbPath,
   buildTranslationsLocaleDocDbPath,

package/dist/{chunk-PNLLZXVY.js → chunk-AJDMNTZQ.js}

@@ -1,10 +1,10 @@
 import {
   SearchIndexService
-} from "./chunk-RXWDB3K4.js";
+} from "./chunk-4VZTYUQ7.js";
 import {
   RootCMSClient,
   getCmsPlugin
-} from "./chunk-N4K6ICFR.js";
+} from "./chunk-AFBSITEO.js";
 
 // core/cron.ts
 import { Timestamp as Timestamp2 } from "firebase-admin/firestore";

package/dist/chunk-J72JK4KR.js

@@ -0,0 +1,8 @@
+// shared/slug.ts
+function normalizeSlug(slug) {
+  return slug.replace(/^[\s/]*/g, "").replace(/[\s/]*$/g, "").replace(/^\/+|\/+$/g, "").replaceAll("/", "--");
+}
+
+export {
+  normalizeSlug
+};

package/dist/{chunk-7L5OI5ES.js → chunk-X5CNR4CK.js}

@@ -1,9 +1,9 @@
 import {
   SearchIndexService
-} from "./chunk-RXWDB3K4.js";
+} from "./chunk-4VZTYUQ7.js";
 import {
   normalizeSlug
-} from "./chunk-N4K6ICFR.js";
+} from "./chunk-J72JK4KR.js";
 
 // core/ai.ts
 import crypto from "node:crypto";
@@ -1198,7 +1198,7 @@ function extractJsonFromResponse(responseText) {
 // package.json
 var package_default = {
   name: "@blinkk/root-cms",
-  version: "3.0.6",
+  version: "3.1.2",
   author: "s@blinkk.com",
   license: "MIT",
   engines: {
@@ -1223,6 +1223,10 @@ var package_default = {
       types: "./dist/core/core.d.ts",
       import: "./dist/core.js"
     },
+    "./browser-client": {
+      types: "./dist/browser-client/browser-client.d.ts",
+      import: "./dist/browser-client.js"
+    },
     "./client": {
       types: "./dist/core/client.d.ts",
       import: "./dist/client.js"
@@ -1369,7 +1373,7 @@ var package_default = {
     yjs: "13.6.27"
   },
   peerDependencies: {
-    "@blinkk/root": "3.0.6",
+    "@blinkk/root": "3.1.2",
     "firebase-admin": ">=11",
     "firebase-functions": ">=4"
   },

package/dist/cli.js

@@ -5,7 +5,8 @@ import {
   RootCMSClient,
   getCmsPlugin,
   unmarshalData
-} from "./chunk-N4K6ICFR.js";
+} from "./chunk-AFBSITEO.js";
+import "./chunk-J72JK4KR.js";
 import "./chunk-MLKGABMK.js";
 
 // cli/cli.ts

package/dist/client.js

@@ -12,7 +12,8 @@ import {
   translationsForLocale,
   unmarshalArray,
   unmarshalData
-} from "./chunk-N4K6ICFR.js";
+} from "./chunk-AFBSITEO.js";
+import "./chunk-J72JK4KR.js";
 import "./chunk-MLKGABMK.js";
 export {
   BatchRequest,

package/dist/core/client.d.ts

@@ -27,6 +27,11 @@ export interface Doc<Fields = any> {
             until?: Timestamp;
         };
         locales?: string[];
+        /**
+         * Reverse index of asset library ids embedded in the doc's fields,
+         * (re)computed whenever the doc draft is saved in the CMS UI.
+         */
+        assets?: string[];
     };
     fields: Fields;
 }

package/dist/core/plugin.d.ts

@@ -12,7 +12,7 @@ export { translationsCheck } from './checks-translations.js';
 export type { TranslationsCheckOptions } from './checks-translations.js';
 export type { CMSService, CMSServiceContext } from './services.js';
 export type { CMSNotificationService, NotificationResult, NotificationServiceContext, } from './services-notifications.js';
-export type { CMSTranslationService, TranslationExportResult, TranslationImportResult, TranslationRow, TranslationServiceContext, } from './translations.js';
+export type { CMSTranslationService, RootLocale, TranslationExportResult, TranslationImportResult, TranslationLanguage, TranslationRow, TranslationServiceContext, } from './translations.js';
 /**
  * Built-in sidebar tools that can be toggled on/off in the CMS UI.
  */

package/dist/core/translations.d.ts

@@ -1,10 +1,17 @@
+import type { RootLocale, TranslationLanguage } from '../shared/translation-languages.js';
 import type { CMSService, CMSServiceContext } from './services.js';
-/** A row of translation data keyed by locale. */
+export type { RootLocale, TranslationLanguage };
+/** A row of translation data keyed by translation language. */
 export interface TranslationRow {
     /** The source string. */
     source: string;
-    /** Map of locale code to translated string. */
-    translations: Record<string, string>;
+    /**
+     * Map of translation language to translated string. Translation languages
+     * are derived from the project's locales via the `i18n.translationLanguages`
+     * config in root.config.ts; when no mapping is configured, the keys are the
+     * locale ids themselves.
+     */
+    translations: Record<TranslationLanguage, string>;
     /** Optional translator notes/context for the source string. */
     description?: string;
 }
@@ -17,7 +24,15 @@ export interface TranslationServiceContext extends CMSServiceContext {
     /** The slug, e.g. `index`. */
     slug: string;
     /** The locales configured for the project. */
-    locales: string[];
+    locales: RootLocale[];
+    /**
+     * The translation languages for the project, derived from `locales` via the
+     * `i18n.translationLanguages` config in root.config.ts (deduped, since
+     * multiple locales may share a translation language). Equal to `locales`
+     * when no mapping is configured. The `translations` keys in
+     * `TranslationRow` data use these languages.
+     */
+    translationLanguages: TranslationLanguage[];
     /** The email of the user performing the action. */
     user: {
         email: string;

package/dist/core.js

@@ -10,13 +10,15 @@ import {
   marshalArray,
   marshalData,
   normalizeData,
-  normalizeSlug,
   parseDocId,
   toArrayObject,
   translationsForLocale,
   unmarshalArray,
   unmarshalData
-} from "./chunk-N4K6ICFR.js";
+} from "./chunk-AFBSITEO.js";
+import {
+  normalizeSlug
+} from "./chunk-J72JK4KR.js";
 import {
   __export
 } from "./chunk-MLKGABMK.js";

package/dist/functions.js

@@ -1,8 +1,9 @@
 import {
   runCronJobs
-} from "./chunk-PNLLZXVY.js";
-import "./chunk-RXWDB3K4.js";
-import "./chunk-N4K6ICFR.js";
+} from "./chunk-AJDMNTZQ.js";
+import "./chunk-4VZTYUQ7.js";
+import "./chunk-AFBSITEO.js";
+import "./chunk-J72JK4KR.js";
 import "./chunk-MLKGABMK.js";
 
 // core/functions.ts

package/dist/plugin.js

@@ -13,18 +13,19 @@ import {
   serializeAiConfig,
   summarizeDiff,
   translateString
-} from "./chunk-7L5OI5ES.js";
+} from "./chunk-X5CNR4CK.js";
 import {
   runCronJobs
-} from "./chunk-PNLLZXVY.js";
+} from "./chunk-AJDMNTZQ.js";
 import {
   SearchIndexService
-} from "./chunk-RXWDB3K4.js";
+} from "./chunk-4VZTYUQ7.js";
 import {
   RootCMSClient,
   parseDocId,
   unmarshalData
-} from "./chunk-N4K6ICFR.js";
+} from "./chunk-AFBSITEO.js";
+import "./chunk-J72JK4KR.js";
 import "./chunk-MLKGABMK.js";
 
 // core/plugin.ts
@@ -60,6 +61,28 @@ import { promises as fs } from "node:fs";
 import path from "node:path";
 import { multipartMiddleware } from "@blinkk/root/middleware";
 
+// shared/translation-languages.ts
+function getTranslationLanguage(i18nConfig, locale) {
+  const mapping = i18nConfig.translationLanguages || {};
+  const localeLower = String(locale).toLowerCase();
+  for (const [key, lang] of Object.entries(mapping)) {
+    if (key.toLowerCase() === localeLower) {
+      return lang;
+    }
+  }
+  return locale;
+}
+function toTranslationLanguages(i18nConfig, locales) {
+  const languages = [];
+  for (const locale of locales) {
+    const lang = getTranslationLanguage(i18nConfig, locale);
+    if (!languages.includes(lang)) {
+      languages.push(lang);
+    }
+  }
+  return languages;
+}
+
 // core/csv.ts
 import { parse as csvParse } from "csv-parse/sync";
 import { stringify as csvStringify } from "csv-stringify/sync";
@@ -1050,7 +1073,9 @@ function api(server, options) {
     }
     try {
       const cmsClient = new RootCMSClient(req.rootConfig);
-      const locales = req.rootConfig?.i18n?.locales || [];
+      const i18nConfig = req.rootConfig?.i18n || {};
+      const locales = i18nConfig.locales || [];
+      const translationLanguages = toTranslationLanguages(i18nConfig, locales);
       const result = await handler(
         {
           rootConfig: req.rootConfig,
@@ -1059,6 +1084,7 @@ function api(server, options) {
           collectionId,
           slug,
           locales,
+          translationLanguages,
           user: { email: req.user.email }
         },
         data
@@ -1091,8 +1117,13 @@ function sse(server) {
     }
     res.writeHead(200, {
       "Content-Type": "text/event-stream",
-      "Cache-Control": "no-cache",
-      Connection: "keep-alive"
+      // `no-transform` opts out of the `compression()` middleware (used by
+      // `root start` / `root preview`), which would otherwise hold SSE chunks
+      // in a gzip/brotli window and never deliver them incrementally.
+      "Cache-Control": "no-cache, no-transform",
+      Connection: "keep-alive",
+      // Disable buffering in nginx-style reverse proxies.
+      "X-Accel-Buffering": "no"
     });
     sseClients.add(res);
     const connectedMessage = formatMessage(