@blinkk/root-cms 2.2.1 → 2.2.3

package/dist/app.js

@@ -83,7 +83,7 @@ function convertOneOfTypes(collection) {
 // package.json
 var package_default = {
   name: "@blinkk/root-cms",
-  version: "2.2.1",
+  version: "2.2.3",
   author: "s@blinkk.com",
   license: "MIT",
   engines: {
@@ -232,7 +232,7 @@ var package_default = {
     yjs: "13.6.27"
   },
   peerDependencies: {
-    "@blinkk/root": "2.2.1",
+    "@blinkk/root": "2.2.3",
     "firebase-admin": ">=11",
     "firebase-functions": ">=4",
     preact: ">=10",

package/dist/{client-BKO9Ikqy.d.ts → client-Rka_a6jc.d.ts}

@@ -861,4 +861,4 @@ declare class BatchResponse {
     private getTranslationsMap;
 }
 
-export { cmsPlugin as $, type Action as A, type BatchRequestOptions as B, BatchResponse as C, type Doc as D, type Locale as E, type SourceString as F, type GetDocOptions as G, type HttpMethod as H, type TranslatedString as I, type TranslationsDocMode as J, type TranslationsLocaleDocHashMap as K, type LoadTranslationsOptions as L, type TranslationsLocaleDocEntry as M, type MultiLocaleTranslationsMap as N, type SingleLocaleTranslationsMap as O, TranslationsManager as P, buildTranslationsDbPath as Q, type Release as R, type SetDocOptions as S, type TranslationsMap as T, type UserRole as U, buildTranslationsLocaleDocDbPath as V, type CMSUser as W, type CMSAIConfig as X, type CMSSidebarTool as Y, type CMSPluginOptions as Z, type CMSPlugin as _, type LocaleTranslations as a, type DocMode as b, type DataSource as c, type DataSourceData as d, type DataSourceMode as e, type SaveDraftOptions as f, type ListDocsOptions as g, type GetCountOptions as h, type Translation as i, type ListActionsOptions as j, RootCMSClient as k, isRichTextData as l, getCmsPlugin as m, marshalData as n, normalizeData as o, type ArrayObject as p, marshalArray as q, unmarshalArray as r, translationsForLocale as s, toArrayObject as t, unmarshalData as u, parseDocId as v, type BatchRequestQuery as w, type BatchRequestQueryOptions as x, type TranslationsDoc as y, BatchRequest as z };
+export { cmsPlugin as $, type Action as A, type BatchRequestOptions as B, BatchResponse as C, type DocMode as D, type Locale as E, type SourceString as F, type GetDocOptions as G, type HttpMethod as H, type TranslatedString as I, type TranslationsDocMode as J, type TranslationsLocaleDocHashMap as K, type LoadTranslationsOptions as L, type TranslationsLocaleDocEntry as M, type MultiLocaleTranslationsMap as N, type SingleLocaleTranslationsMap as O, TranslationsManager as P, buildTranslationsDbPath as Q, RootCMSClient as R, type SetDocOptions as S, type TranslationsMap as T, type UserRole as U, buildTranslationsLocaleDocDbPath as V, type CMSUser as W, type CMSAIConfig as X, type CMSSidebarTool as Y, type CMSPluginOptions as Z, type CMSPlugin as _, type LocaleTranslations as a, type Doc as b, type DataSource as c, type DataSourceData as d, type DataSourceMode as e, type SaveDraftOptions as f, type ListDocsOptions as g, type GetCountOptions as h, type Translation as i, type Release as j, type ListActionsOptions as k, isRichTextData as l, getCmsPlugin as m, marshalData as n, normalizeData as o, type ArrayObject as p, marshalArray as q, unmarshalArray as r, translationsForLocale as s, toArrayObject as t, unmarshalData as u, parseDocId as v, type BatchRequestQuery as w, type BatchRequestQueryOptions as x, type TranslationsDoc as y, BatchRequest as z };

package/dist/client.d.ts

@@ -1,4 +1,4 @@
 import '@blinkk/root';
 import 'firebase-admin/app';
 import 'firebase-admin/firestore';
-export { A as Action, p as ArrayObject, z as BatchRequest, B as BatchRequestOptions, w as BatchRequestQuery, x as BatchRequestQueryOptions, C as BatchResponse, c as DataSource, d as DataSourceData, e as DataSourceMode, D as Doc, b as DocMode, h as GetCountOptions, G as GetDocOptions, H as HttpMethod, j as ListActionsOptions, g as ListDocsOptions, L as LoadTranslationsOptions, a as LocaleTranslations, R as Release, k as RootCMSClient, f as SaveDraftOptions, S as SetDocOptions, i as Translation, y as TranslationsDoc, T as TranslationsMap, U as UserRole, m as getCmsPlugin, l as isRichTextData, q as marshalArray, n as marshalData, o as normalizeData, v as parseDocId, t as toArrayObject, s as translationsForLocale, r as unmarshalArray, u as unmarshalData } from './client-BKO9Ikqy.js';
+export { A as Action, p as ArrayObject, z as BatchRequest, B as BatchRequestOptions, w as BatchRequestQuery, x as BatchRequestQueryOptions, C as BatchResponse, c as DataSource, d as DataSourceData, e as DataSourceMode, b as Doc, D as DocMode, h as GetCountOptions, G as GetDocOptions, H as HttpMethod, k as ListActionsOptions, g as ListDocsOptions, L as LoadTranslationsOptions, a as LocaleTranslations, j as Release, R as RootCMSClient, f as SaveDraftOptions, S as SetDocOptions, i as Translation, y as TranslationsDoc, T as TranslationsMap, U as UserRole, m as getCmsPlugin, l as isRichTextData, q as marshalArray, n as marshalData, o as normalizeData, v as parseDocId, t as toArrayObject, s as translationsForLocale, r as unmarshalArray, u as unmarshalData } from './client-Rka_a6jc.js';

package/dist/core.d.ts

@@ -1,10 +1,194 @@
-import { L as LoadTranslationsOptions, T as TranslationsMap, a as LocaleTranslations } from './client-BKO9Ikqy.js';
-export { A as Action, p as ArrayObject, z as BatchRequest, B as BatchRequestOptions, w as BatchRequestQuery, x as BatchRequestQueryOptions, C as BatchResponse, c as DataSource, d as DataSourceData, e as DataSourceMode, D as Doc, b as DocMode, h as GetCountOptions, G as GetDocOptions, H as HttpMethod, j as ListActionsOptions, g as ListDocsOptions, E as Locale, N as MultiLocaleTranslationsMap, R as Release, k as RootCMSClient, f as SaveDraftOptions, S as SetDocOptions, O as SingleLocaleTranslationsMap, F as SourceString, I as TranslatedString, i as Translation, y as TranslationsDoc, J as TranslationsDocMode, M as TranslationsLocaleDocEntry, K as TranslationsLocaleDocHashMap, P as TranslationsManager, U as UserRole, Q as buildTranslationsDbPath, V as buildTranslationsLocaleDocDbPath, m as getCmsPlugin, l as isRichTextData, q as marshalArray, n as marshalData, o as normalizeData, v as parseDocId, t as toArrayObject, s as translationsForLocale, r as unmarshalArray, u as unmarshalData } from './client-BKO9Ikqy.js';
-import { RootConfig } from '@blinkk/root';
+import { R as RootCMSClient, D as DocMode, L as LoadTranslationsOptions, T as TranslationsMap, a as LocaleTranslations } from './client-Rka_a6jc.js';
+export { A as Action, p as ArrayObject, z as BatchRequest, B as BatchRequestOptions, w as BatchRequestQuery, x as BatchRequestQueryOptions, C as BatchResponse, c as DataSource, d as DataSourceData, e as DataSourceMode, b as Doc, h as GetCountOptions, G as GetDocOptions, H as HttpMethod, k as ListActionsOptions, g as ListDocsOptions, E as Locale, N as MultiLocaleTranslationsMap, j as Release, f as SaveDraftOptions, S as SetDocOptions, O as SingleLocaleTranslationsMap, F as SourceString, I as TranslatedString, i as Translation, y as TranslationsDoc, J as TranslationsDocMode, M as TranslationsLocaleDocEntry, K as TranslationsLocaleDocHashMap, P as TranslationsManager, U as UserRole, Q as buildTranslationsDbPath, V as buildTranslationsLocaleDocDbPath, m as getCmsPlugin, l as isRichTextData, q as marshalArray, n as marshalData, o as normalizeData, v as parseDocId, t as toArrayObject, s as translationsForLocale, r as unmarshalArray, u as unmarshalData } from './client-Rka_a6jc.js';
+import { Request, RootConfig, Response, RouteParams, GetStaticProps, GetStaticPaths } from '@blinkk/root';
 import { Query } from 'firebase-admin/firestore';
-export { s as schema } from './schema-FB6Ck9sN.js';
+export { s as schema } from './schema-KYFRsBf5.js';
 import 'firebase-admin/app';
 
+/**
+ * Utility for creating Root filesystem routes that are connected to a CMS doc.
+ *
+ * Usage:
+ *
+ * ```
+ * // routes/blog/[slug].tsx
+ * import {createRoute} from '@blinkk/root-cms';
+ *
+ * export default function Page(props) { ... }
+ *
+ * export const {handle} = createRoute({collection: 'BlogPosts'});
+ * ```
+ *
+ * For SSG enabled sites, add `{ssg: true}`:
+ *
+ * ```
+ * // routes/blog/[slug].tsx
+ * import {createRoute} from '@blinkk/root-cms';
+ *
+ * export default function Page(props) { ... }
+ *
+ * export const {getStaticProps, getStaticPaths} = createRoute({collection: 'BlogPosts'});
+ * ```
+ */
+
+interface RootCMSDoc<Fields = any> {
+    /** The id of the doc, e.g. "Pages/foo-bar". */
+    id: string;
+    /** The collection id of the doc, e.g. "Pages". */
+    collection: string;
+    /** The slug of the doc, e.g. "foo-bar". */
+    slug: string;
+    /** System-level metadata. */
+    sys: {
+        createdAt: number;
+        createdBy: string;
+        modifiedAt: number;
+        modifiedBy: string;
+        firstPublishedAt?: number;
+        firstPublishedBy?: string;
+        publishedAt?: number;
+        publishedBy?: string;
+        locales?: string[];
+    };
+    /** User-entered field values from the CMS. */
+    fields?: Fields;
+}
+type RouteRequest = Request & {
+    rootConfig: RootConfig;
+    cmsClient: RootCMSClient;
+};
+type RouteResponse = Response;
+interface RouteContext {
+    /**
+     * HTTP request object. Only available in SSR mode.
+     */
+    req?: RouteRequest;
+    /**
+     * The slug of the page being requested.
+     */
+    slug: string;
+    /**
+     * Doc publishing mode.
+     */
+    mode: DocMode;
+    /**
+     * Client for interacting with Root CMS data.
+     */
+    cmsClient: RootCMSClient;
+    /**
+     * URL param map from filesystem routing.
+     */
+    params: RouteParams;
+}
+interface Route {
+    /**
+     * SSR handler.
+     */
+    handle: (req: RouteRequest, res: RouteResponse) => Promise<void>;
+    /**
+     * SSG handler props handler, enabled with `{ssg: true}`.
+     */
+    getStaticProps?: GetStaticProps;
+    /**
+     * SSG path params provider, enabled with `{ssg: true}`.
+     */
+    getStaticPaths?: GetStaticPaths;
+}
+interface CreateRouteOptions {
+    /**
+     * Collection mapped to the route.
+     */
+    collection: string;
+    /**
+     * Route param name used for the slug. Used for dynamic routes, e.g.
+     * `[...slug].tsx`. Defaults to "slug".
+     */
+    slugParam?: string;
+    /**
+     * Format pattern for slugs that use multiple param values to form the slug,
+     * e.g. for experiments you might have something like:
+     *
+     * Route: routes/ex/[experimentId]/[...page].tsx
+     * Doc ID: ExperimentPages/1234--about--foo
+     * URL path: /ex/1234/about/foo/
+     *
+     * To grab the correct doc, use `{slugFormat: '[experimentId]/[page]'}`.
+     *
+     */
+    slugFormat?: string;
+    /**
+     * Slug to use for the route. Used for non-dynamic, single-document routes.
+     */
+    slug?: string;
+    /**
+     * Callback function that returns a map of Promises that contain fetched data.
+     * Once the promise is resolved, the values are injected into page's props
+     * for rendering.
+     */
+    fetchData?: (context: RouteContext) => Record<string, Promise<any>>;
+    /**
+     * Hook that's called when the doc is not found. If not provided, the default
+     * 404 handler will be called.
+     */
+    notFoundHook?: (req: Request, res: Response) => void | Promise<void>;
+    /**
+     * Hook for amending any props values before being passed to the page
+     * component.
+     */
+    preRenderHook?: (props: any, context: RouteContext) => any | Promise<any>;
+    /**
+     * Hook for setting any response headers.
+     */
+    setResponseHeaders?: (req: Request, res: Response) => void;
+    /**
+     * Translations configuration.
+     */
+    translations?: (context: RouteContext) => {
+        tags?: string[];
+    };
+    /**
+     * Sets Cache-Control header to `private`.
+     */
+    disableCacheControl?: boolean;
+    /**
+     * Enables SSG mode for sites that serve on SCS or other static servers.
+     */
+    ssg?: boolean;
+    /**
+     * Overrides the "mode" (draft vs published) for SSG builds. Primarily
+     * intended for testing prior to launches.
+     */
+    ssgMode?: DocMode;
+    /**
+     * Whether the route should only be available with ?preview=true.
+     */
+    previewOnly?: boolean;
+    /**
+     * Overrides the default locale for the route.
+     */
+    defaultLocale?: string;
+}
+/**
+ * Utility for creating Root filesystem routes that are connected to a CMS doc.
+ */
+declare function createRoute(options: CreateRouteOptions): Route;
+declare function resolvePromisesMap(promisesMap: Record<string, Promise<any>>): Promise<Record<string, any>>;
+/**
+ * Returns the first query param value in a given request.
+ *
+ * For example, for a URL like `/?foo=bar&foo=baz`, calling
+ * `getFirstQueryParam(req, 'foo')` would return `"bar"`.
+ */
+declare function getFirstQueryParam(req: Request, key: string): string | null;
+/**
+ * Issues an HTTP redirect, preserving any query params from the original req.
+ */
+declare function redirectWithQuery(req: Request, res: Response, redirectCode: number, redirectPath: string): void;
+/**
+ * Returns the CMS document mode associated with the request.
+ */
+declare function getMode(req: Request): Promise<DocMode>;
+
 /** @deprecated Use client.ts instead. */
 
 /**
@@ -50,4 +234,4 @@ declare function loadTranslations(rootConfig: RootConfig, options?: LoadTranslat
  */
 declare function loadTranslationsForLocale(rootConfig: RootConfig, locale: string, options?: LoadTranslationsOptions): Promise<LocaleTranslations>;
 
-export { LoadTranslationsOptions, LocaleTranslations, TranslationsMap, getDoc, listDocs, loadTranslations, loadTranslationsForLocale, numDocs, publishScheduledDocs };
+export { type CreateRouteOptions, DocMode, LoadTranslationsOptions, LocaleTranslations, RootCMSClient, type RootCMSDoc, type Route, type RouteContext, type RouteRequest, type RouteResponse, TranslationsMap, createRoute, getDoc, getFirstQueryParam, getMode, listDocs, loadTranslations, loadTranslationsForLocale, numDocs, publishScheduledDocs, redirectWithQuery, resolvePromisesMap };

package/dist/core.js

@@ -1512,6 +1512,288 @@ var BatchResponse = class {
   }
 };
 
+// core/route.ts
+import {
+  replaceParams
+} from "@blinkk/root";
+function createRoute(options) {
+  let cmsClient;
+  function getSlug(params) {
+    if (options.slug) {
+      return options.slug;
+    }
+    if (options.slugFormat) {
+      return replaceParams(options.slugFormat, params);
+    }
+    const slugParam = options.slugParam || "slug";
+    const slug = params[slugParam] || "index";
+    return slug;
+  }
+  async function fetchData(fetchOptions) {
+    if (!options.fetchData) {
+      return {};
+    }
+    const promisesMap = options.fetchData(fetchOptions);
+    return resolvePromisesMap(promisesMap);
+  }
+  async function generateProps(routeContext, locale) {
+    const { slug, mode } = routeContext;
+    const translationsTags = [
+      "common",
+      `${options.collection}/${slug.replaceAll("/", "--")}`
+    ];
+    if (options.translations) {
+      const tags = options.translations(routeContext)?.tags || [];
+      translationsTags.push(...tags);
+    }
+    const [doc, translationsMap, data] = await Promise.all([
+      cmsClient.getDoc(options.collection, slug, {
+        mode
+      }),
+      cmsClient.loadTranslations({ tags: translationsTags }),
+      fetchData(routeContext)
+    ]);
+    if (!doc) {
+      return { notFound: true };
+    }
+    const docLocales = doc.sys.locales || [];
+    if (!docLocales.includes(locale)) {
+      return { notFound: true };
+    }
+    const translations = translationsForLocale(translationsMap, locale);
+    let props = { ...data, locale, mode, slug, doc };
+    if (options.preRenderHook) {
+      props = await options.preRenderHook(props, routeContext);
+    }
+    return { props, locale, translations };
+  }
+  const route = {
+    // SSR handler.
+    handle: async (req, res) => {
+      if (!cmsClient) {
+        cmsClient = new RootCMSClient(req.rootConfig);
+      }
+      req.cmsClient = cmsClient;
+      const ctx = req.handlerContext;
+      const slug = getSlug(ctx.params);
+      if (slug.includes(".") || slug.includes("--")) {
+        res.setHeader("cache-control", "private");
+        return ctx.render404();
+      }
+      const mode = await getMode(req);
+      const siteLocales = req.rootConfig?.i18n?.locales || ["en"];
+      if (options.previewOnly && mode !== "draft") {
+        return ctx.render404();
+      }
+      const routeContext = {
+        req,
+        slug,
+        mode,
+        cmsClient,
+        params: ctx.params
+      };
+      const translationsTags = [
+        "common",
+        `${options.collection}/${slug.replaceAll("/", "--")}`
+      ];
+      if (options.translations) {
+        const tags = options.translations(routeContext)?.tags || [];
+        translationsTags.push(...tags);
+      }
+      const [doc, translationsMap, data] = await Promise.all([
+        cmsClient.getDoc(options.collection, slug, {
+          mode
+        }),
+        // Only load translations for sites that have >1 locale configured.
+        siteLocales.length > 1 ? cmsClient.loadTranslations({ tags: translationsTags }) : Promise.resolve({}),
+        fetchData(routeContext)
+      ]);
+      if (!doc) {
+        if (options.notFoundHook) {
+          await options.notFoundHook(req, res);
+          return;
+        }
+        res.setHeader("cache-control", "private");
+        return ctx.render404();
+      }
+      const hl = getFirstQueryParam(req, "hl");
+      let country = getFirstQueryParam(req, "gl") || req.get("x-country-code") || req.get("x-appengine-country") || "";
+      if (country) {
+        country = country.toUpperCase();
+      }
+      function getFallbackLocale(docLocales2) {
+        const localesMap = {};
+        docLocales2.forEach((docLocale) => {
+          const lowerLocale = docLocale.toLowerCase();
+          localesMap[lowerLocale] = docLocale;
+        });
+        if (hl === "fr") {
+          if (country === "CA" && "fr-ca" in localesMap) {
+            return localesMap["fr-ca"];
+          }
+          if (country === "FR" && "fr-fr" in localesMap) {
+            return localesMap["fr-fr"];
+          }
+        }
+        if (hl === "pt") {
+          if (country === "BR" && "pt-br" in localesMap) {
+            return localesMap["pt-br"];
+          }
+          if (country === "PT" && "pt-pt" in localesMap) {
+            return localesMap["pt-pt"];
+          }
+        }
+        const preferredLocale = ctx.getPreferredLocale(docLocales2);
+        if (preferredLocale) {
+          const normalizedLocale = localesMap[preferredLocale] || preferredLocale;
+          if (preferredLocale === "en") {
+            if (["AU", "CA", "IN", "MY"].includes(country)) {
+              if (localesMap[`en-${country.toLowerCase()}`]) {
+                return localesMap[`en-${country.toLowerCase()}`];
+              }
+              if (localesMap["en-gb"]) {
+                return localesMap["en-gb"];
+              }
+            }
+          }
+          return normalizedLocale;
+        }
+        const defaultLocale = options.defaultLocale || req.rootConfig?.i18n?.defaultLocale || "en";
+        if (docLocales2.includes(defaultLocale)) {
+          return defaultLocale;
+        }
+        return docLocales2[0];
+      }
+      const sys = doc.sys;
+      const docLocales = sys.locales || ["en"];
+      let locale = ctx.route.locale;
+      if (ctx.route.isDefaultLocale) {
+        locale = getFallbackLocale(docLocales);
+      } else {
+        if (!docLocales.includes(locale)) {
+          if (options.notFoundHook) {
+            await options.notFoundHook(req, res);
+            return;
+          }
+          res.setHeader("cache-control", "private");
+          return ctx.render404();
+        }
+      }
+      const translations = translationsForLocale(translationsMap, locale);
+      let props = { ...data, req, locale, mode, slug, doc, country };
+      if (options.preRenderHook) {
+        props = await options.preRenderHook(props, routeContext);
+      }
+      if (props.$redirect) {
+        const redirectCode = props.$redirectCode || 302;
+        console.log(`redirecting to: ${props.$redirect} (${redirectCode})`);
+        redirectWithQuery(req, res, redirectCode, props.$redirect);
+        return;
+      }
+      if (options.disableCacheControl) {
+        res.setHeader("cache-control", "private");
+      } else if (mode === "published") {
+        res.setHeader("cache-control", "public, max-age=15, s-maxage=30");
+        if (ctx.route.isDefaultLocale) {
+          res.setHeader(
+            "vary",
+            "accept-language,x-appengine-country,x-country-code"
+          );
+        }
+      }
+      if (options.setResponseHeaders) {
+        options.setResponseHeaders(req, res);
+      }
+      return ctx.render(props, { locale, translations });
+    }
+  };
+  if (options.ssg) {
+    route.getStaticPaths = async (ctx) => {
+      if (!options.slugParam) {
+        return { paths: [] };
+      }
+      if (!cmsClient) {
+        cmsClient = new RootCMSClient(ctx.rootConfig);
+      }
+      const mode = options.ssgMode || "published";
+      const res = await cmsClient.listDocs(options.collection, {
+        mode
+      });
+      const ssgPaths = [];
+      const slugParam = options.slugParam || "slug";
+      res.docs.forEach((doc) => {
+        const params = {};
+        params[slugParam] = doc.slug.replaceAll("--", "/");
+        ssgPaths.push({ params });
+      });
+      return { paths: ssgPaths };
+    };
+    route.getStaticProps = async (ctx) => {
+      if (!cmsClient) {
+        cmsClient = new RootCMSClient(ctx.rootConfig);
+      }
+      const slug = getSlug(ctx.params);
+      const mode = options.ssgMode || "published";
+      const routeContext = {
+        req: void 0,
+        slug,
+        mode,
+        cmsClient,
+        params: ctx.params
+      };
+      return generateProps(routeContext, ctx.params.$locale);
+    };
+  }
+  return route;
+}
+async function resolvePromisesMap(promisesMap) {
+  const keys = Object.keys(promisesMap);
+  const promises = Object.values(promisesMap);
+  const results = await Promise.all(promises);
+  const resultMap = {};
+  keys.forEach((key, index) => {
+    resultMap[key] = results[index];
+  });
+  return resultMap;
+}
+function getFirstQueryParam(req, key) {
+  const val = req.query[key];
+  if (val === null || val === void 0) {
+    return null;
+  }
+  if (Array.isArray(val)) {
+    if (val.length === 0) {
+      return null;
+    }
+    return String(val[0]);
+  }
+  return String(val);
+}
+function redirectWithQuery(req, res, redirectCode, redirectPath) {
+  if (!redirectPath.startsWith("/")) {
+    res.redirect(redirectCode, redirectPath);
+    return;
+  }
+  const queryStr = getQueryStr(req);
+  const redirectUrl = queryStr ? `${redirectPath}?${queryStr}` : redirectPath;
+  res.redirect(redirectCode, redirectUrl);
+}
+function getQueryStr(req) {
+  const qIndex = req.originalUrl.indexOf("?");
+  if (qIndex === -1) {
+    return "";
+  }
+  return req.originalUrl.slice(qIndex + 1);
+}
+async function getMode(req) {
+  const isPreview = String(req.query.preview) === "true";
+  let mode = isPreview ? "draft" : "published";
+  if (isPreview && req.query.mode === "published") {
+    mode = "published";
+  }
+  return mode;
+}
+
 // core/runtime.ts
 import { FieldValue as FieldValue3 } from "firebase-admin/firestore";
 async function getDoc(rootConfig, collectionId, slug, options) {
@@ -1765,8 +2047,11 @@ export {
   TranslationsManager,
   buildTranslationsDbPath,
   buildTranslationsLocaleDocDbPath,
+  createRoute,
   getCmsPlugin,
   getDoc,
+  getFirstQueryParam,
+  getMode,
   isRichTextData,
   listDocs,
   loadTranslations,
@@ -1777,6 +2062,8 @@ export {
   numDocs,
   parseDocId,
   publishScheduledDocs,
+  redirectWithQuery,
+  resolvePromisesMap,
   schema_exports as schema,
   toArrayObject,
   translationsForLocale,

package/dist/plugin.d.ts

@@ -1,4 +1,4 @@
 import '@blinkk/root';
 import 'firebase-admin/app';
 import 'firebase-admin/firestore';
-export { X as CMSAIConfig, _ as CMSPlugin, Z as CMSPluginOptions, Y as CMSSidebarTool, W as CMSUser, $ as cmsPlugin } from './client-BKO9Ikqy.js';
+export { X as CMSAIConfig, _ as CMSPlugin, Z as CMSPluginOptions, Y as CMSSidebarTool, W as CMSUser, $ as cmsPlugin } from './client-Rka_a6jc.js';

package/dist/plugin.js

@@ -397,6 +397,51 @@ import { genkit } from "genkit";
 import { logger } from "genkit/logging";
 logger.setLogLevel("warn");
 var DEFAULT_MODEL = "vertexai/gemini-2.5-flash";
+async function summarizeDiff(cmsClient, options) {
+  const cmsPluginOptions = cmsClient.cmsPlugin.getConfig();
+  const firebaseConfig = cmsPluginOptions.firebaseConfig;
+  const model = (typeof cmsPluginOptions.experiments?.ai === "object" ? cmsPluginOptions.experiments.ai.model : void 0) || DEFAULT_MODEL;
+  const ai = genkit({
+    plugins: [
+      vertexAI({
+        projectId: firebaseConfig.projectId,
+        location: firebaseConfig.location || "us-central1"
+      })
+    ]
+  });
+  const beforeJson = JSON.stringify(options.before ?? null, null, 2);
+  const afterJson = JSON.stringify(options.after ?? null, null, 2);
+  const systemPrompt = [
+    "You are an assistant that summarizes changes made to CMS documents stored as JSON.",
+    "Provide a concise description of the most important updates using short bullet points.",
+    'If there are no meaningful differences, respond with "No significant changes."',
+    `Focus on just the content changes, ignore insignificant changes to richtext blocks and structure, such as updates to the richtext block's "timestamp" and "version" fields.`
+  ].join("\n");
+  const diffPrompt = [
+    "Previous version JSON:",
+    "```json",
+    beforeJson,
+    "```",
+    "",
+    "Updated version JSON:",
+    "```json",
+    afterJson,
+    "```",
+    "",
+    "Summarize the differences between the two payloads."
+  ].join("\n");
+  const res = await ai.generate({
+    model,
+    messages: [
+      {
+        role: "system",
+        content: [{ text: systemPrompt }]
+      }
+    ],
+    prompt: [{ text: diffPrompt }]
+  });
+  return res.text?.trim() || "";
+}
 var Chat = class {
   constructor(chatClient, id, options) {
     this.chatClient = chatClient;
@@ -2402,6 +2447,36 @@ function api(server, options) {
       res.status(500).json({ success: false, error: "UNKNOWN" });
     }
   });
+  server.use("/cms/api/ai.diff", async (req, res) => {
+    if (req.method !== "POST" || !String(req.get("content-type")).startsWith("application/json")) {
+      res.status(400).json({ success: false, error: "BAD_REQUEST" });
+      return;
+    }
+    if (!req.user?.email) {
+      res.status(401).json({ success: false, error: "UNAUTHORIZED" });
+      return;
+    }
+    const reqBody = req.body || {};
+    if (!Object.prototype.hasOwnProperty.call(reqBody, "after")) {
+      res.status(400).json({
+        success: false,
+        error: "MISSING_REQUIRED_FIELD",
+        field: "after"
+      });
+      return;
+    }
+    try {
+      const cmsClient = new RootCMSClient(req.rootConfig);
+      const summary = await summarizeDiff(cmsClient, {
+        before: reqBody.before ?? null,
+        after: reqBody.after ?? null
+      });
+      res.status(200).json({ success: true, summary });
+    } catch (err) {
+      console.error(err.stack || err);
+      res.status(500).json({ success: false, error: "UNKNOWN" });
+    }
+  });
   server.use("/cms/api/ai.list_chats", async (req, res) => {
     if (req.method !== "POST" || !String(req.get("content-type")).startsWith("application/json")) {
       res.status(400).json({ success: false, error: "BAD_REQUEST" });
@@ -2428,7 +2503,7 @@ function api(server, options) {
 // package.json
 var package_default = {
   name: "@blinkk/root-cms",
-  version: "2.2.1",
+  version: "2.2.3",
   author: "s@blinkk.com",
   license: "MIT",
   engines: {
@@ -2577,7 +2652,7 @@ var package_default = {
     yjs: "13.6.27"
   },
   peerDependencies: {
-    "@blinkk/root": "2.2.1",
+    "@blinkk/root": "2.2.3",
     "firebase-admin": ">=11",
     "firebase-functions": ">=4",
     preact: ">=10",

package/dist/project.d.ts

@@ -1,4 +1,4 @@
-import { S as Schema, C as Collection } from './schema-FB6Ck9sN.js';
+import { S as Schema, C as Collection } from './schema-KYFRsBf5.js';
 
 /**
  * Loads various files or configurations from the project.

package/dist/{schema-FB6Ck9sN.d.ts → schema-KYFRsBf5.d.ts}

@@ -240,9 +240,9 @@ type Collection = SchemaWithTypes & {
      */
     preview?: {
         /** The field that provides the document title. */
-        title?: string;
+        title?: string | string[];
         /** The field that provides the document image. */
-        image?: string;
+        image?: string | string[];
         /** A fallback image to display when the document image field is empty. */
         defaultImage?: {
             src: string;