@blinkk/root-cms 1.4.3 → 1.4.5

package/dist/app.js

@@ -7,7 +7,7 @@ import { render as renderToString } from "preact-render-to-string";
 // package.json
 var package_default = {
   name: "@blinkk/root-cms",
-  version: "1.4.3",
+  version: "1.4.5",
   author: "s@blinkk.com",
   license: "MIT",
   engines: {
@@ -79,6 +79,7 @@ var package_default = {
     "csv-parse": "5.5.2",
     "csv-stringify": "6.4.4",
     "dts-dom": "3.7.0",
+    "fnv-plus": "1.3.1",
     jsonwebtoken: "9.0.2",
     kleur: "4.1.5",
     sirv: "2.0.3",
@@ -108,6 +109,7 @@ var package_default = {
     "@preact/compat": "17.1.2",
     "@tabler/icons-preact": "2.47.0",
     "@types/body-parser": "1.19.3",
+    "@types/fnv-plus": "1.3.2",
     "@types/gapi": "0.0.47",
     "@types/gapi.client.drive-v3": "0.0.4",
     "@types/gapi.client.sheets-v4": "0.0.4",
@@ -138,7 +140,7 @@ var package_default = {
     vitest: "0.34.6"
   },
   peerDependencies: {
-    "@blinkk/root": "1.4.3",
+    "@blinkk/root": "1.4.5",
     "firebase-admin": ">=11",
     "firebase-functions": ">=4",
     preact: ">=10",
@@ -300,7 +302,10 @@ function serializeCollection(collection) {
     domain: collection.domain,
     url: collection.url,
     previewUrl: collection.previewUrl,
-    preview: collection.preview
+    preview: collection.preview,
+    slugRegex: collection.slugRegex,
+    autolock: collection.autolock,
+    autolockReason: collection.autolockReason
   };
 }
 function SignIn(props) {

package/dist/cli.js

@@ -294,10 +294,25 @@ import { loadRootConfig as loadRootConfig2 } from "@blinkk/root/node";
 
 // core/client.ts
 import crypto from "node:crypto";
+import {
+  FieldValue as FieldValue2,
+  Timestamp as Timestamp2
+} from "firebase-admin/firestore";
+
+// core/translations-manager.ts
 import {
   FieldValue,
   Timestamp
 } from "firebase-admin/firestore";
+
+// shared/strings.ts
+import fnv from "fnv-plus";
+
+// core/translations-manager.ts
+var TRANSLATIONS_DB_PATH_FORMAT = "/Projects/{project}/TranslationsManager/{mode}/Translations";
+var TRANSLATIONS_LOCALE_DOC_DB_PATH_FORMAT = `${TRANSLATIONS_DB_PATH_FORMAT}/{id}:{locale}`;
+
+// core/client.ts
 function getCmsPlugin(rootConfig) {
   const plugins = rootConfig.plugins || [];
   const plugin = plugins.find((plugin2) => plugin2.name === "root-cms");

package/dist/{client-98Le1XxF.d.ts → client-c_QAurxr.d.ts}

@@ -1,6 +1,6 @@
 import { Request, Plugin, RootConfig } from '@blinkk/root';
 import { App } from 'firebase-admin/app';
-import { Firestore, Timestamp, Query, WriteBatch } from 'firebase-admin/firestore';
+import { Firestore, WriteBatch, Timestamp, Query } from 'firebase-admin/firestore';
 
 interface CMSUser {
     email: string;
@@ -108,7 +108,14 @@ type CMSPluginOptions = {
      * Experimental config options. Note: these are subject to change at any time.
      */
     experiments?: {
+        /**
+         * Enables the Root CMS AI page.
+         */
         ai?: boolean | CMSAIConfig;
+        /**
+         * Enables the v2 `TranslationsManager`.
+         */
+        v2TranslationsManager?: boolean;
     };
     /**
      * Adjust console output verbosity. Default is `'info'`.
@@ -128,6 +135,191 @@ type CMSPlugin = Plugin & {
 };
 declare function cmsPlugin(options: CMSPluginOptions): CMSPlugin;
 
+type Locale = string;
+type SourceString = string;
+type TranslatedString = string;
+type TranslationsDocMode = 'draft' | 'published';
+interface TranslationsLocaleDocHashMap {
+    /**
+     * A hash map of a source string's hash fingerprint to the source string and
+     * translated string.
+     */
+    [hash: string]: TranslationsLocaleDocEntry;
+}
+interface TranslationsLocaleDocEntry {
+    source: SourceString;
+    translation: TranslatedString;
+}
+interface TranslationsDbPathOptions {
+    project: string;
+    mode: TranslationsDocMode;
+}
+type TranslationsLocaleDocDbPathOptions = TranslationsDbPathOptions & {
+    id: string;
+    locale: string;
+};
+/**
+ * A translations map containing translations for multiple locales.
+ *
+ * Example:
+ * ```
+ * {
+ *   "one": {"es": "uno", "fr": "un"},
+ *   "two": {"es": "dos", "fr": "deux"}
+ * }
+ * ```
+ */
+interface MultiLocaleTranslationsMap {
+    [source: SourceString]: {
+        [locale: Locale]: TranslatedString;
+    };
+}
+/**
+ * A translations map containing translations for a single locale.
+ *
+ * Example:
+ * ```
+ * {
+ *   "one": "uno",
+ *   "two": "dos"
+ * }
+ * ```
+ */
+interface SingleLocaleTranslationsMap {
+    [source: SourceString]: TranslatedString;
+}
+declare class TranslationsManager {
+    cmsClient: RootCMSClient;
+    constructor(cmsClient: RootCMSClient);
+    /**
+     * Saves draft translations for a translations doc id.
+     *
+     * Example:
+     * ```
+     * const strings = {
+     *   'one': {es: 'uno', fr: 'un'},
+     *   'two': {es: 'dos', fr: 'deux'},
+     * };
+     * await tm.saveTranslations('Pages/index', strings);
+     * ```
+     */
+    saveTranslations(id: string, strings: MultiLocaleTranslationsMap, options?: {
+        tags?: string[];
+        modifiedBy?: string;
+    }): Promise<void>;
+    /**
+     * Publishes a translations doc.
+     */
+    publishTranslations(id: string, options?: {
+        batch?: WriteBatch;
+        publishedBy?: string;
+    }): Promise<void>;
+    /**
+     * Fetches translations from one or more translations docs in the translations
+     * manager.
+     *
+     * Example:
+     * ```
+     * await tm.loadTranslations();
+     * // =>
+     * // {
+     * //   "one": {"es": "uno", "fr": "un"},
+     * //   "two": {"es": "dos", "fr": "deux"}
+     * // }
+     * ```
+     *
+     * To load a specific set of translations docs by id:
+     * ```
+     * const translationsToLoad = ['Global/strings', 'Global/header', 'Global/footer', 'Pages/index'];
+     * await tm.loadTranslations({ids: translationsToLoad});
+     * // =>
+     * // {
+     * //   "one": {"es": "uno", "fr": "un"},
+     * //   "two": {"es": "dos", "fr": "deux"}
+     * // }
+     * ```
+     *
+     * To load a subset of locales (more performant):
+     * ```
+     * await tm.loadTranslations({locales: ['es']});
+     * // =>
+     * // {
+     * //   "one": {"es": "uno"},
+     * //   "two": {"es": "dos"}
+     * // }
+     * ```
+     */
+    loadTranslations(options?: {
+        ids?: string[];
+        tags?: string[];
+        locales?: Locale[];
+        mode?: TranslationsDocMode;
+    }): Promise<MultiLocaleTranslationsMap>;
+    /**
+     * Fetches translations for a given locale, with optional fallbacks.
+     * The return value is a map of source string to translated string.
+     *
+     * Example:
+     * ```
+     * await translationsDoc.loadTranslationsForLocale('es');
+     * // =>
+     * // {
+     * //   "one": "uno",
+     * //   "two": "dos",
+     * // }
+     * ```
+     */
+    loadTranslationsForLocale(locale: Locale, options?: {
+        mode?: TranslationsDocMode;
+        fallbackLocales?: Locale[];
+    }): Promise<SingleLocaleTranslationsMap>;
+    /**
+     * Converts a multi-locale translations map to a flat single-locale map,
+     * with optional support for fallback locales.
+     *
+     * ```
+     * const multiLocaleStrings = {
+     *   'one': {es: 'uno', fr: 'un'},
+     *   'two': {es: 'dos', fr: 'deux'}
+     * };
+     * translationsDoc.toSingleLocaleMap(multiLocaleStrings, ['es']);
+     * // =>
+     * // {
+     * //   "one": "uno",
+     * //   "two": "dos",
+     * // }
+     * ```
+     */
+    private toSingleLocaleMap;
+    /**
+     * Converts a multi-locale translations map to a single-locale hashed version,
+     * used for storage in in the DB.
+     *
+     * ```
+     * const multiLocaleStrings = {
+     *   'one': {es: 'uno', fr: 'un'},
+     *   'two': {es: 'dos', fr: 'deux'}
+     * };
+     * translationsDoc.toLocaleDocHashMap(multiLocaleStrings, 'es');
+     * // =>
+     * // {
+     * //   "<hash1>": {"source": "one", "translation": "uno"},
+     * //   "<hash2>": {"source": "two", "translation": "dos"},
+     * // }
+     * ```
+     *
+     * One reason for using hashes is because the DB has limits on the number of
+     * chars that can be used as the "key" in a object map.
+     */
+    private toLocaleDocHashMap;
+    /**
+     * Import translations from the v1 system to the TranslationsManager.
+     */
+    importTranslationsFromV1(): Promise<void>;
+}
+declare function buildTranslationsDbPath(options: TranslationsDbPathOptions): string;
+declare function buildTranslationsLocaleDocDbPath(options: TranslationsLocaleDocDbPathOptions): string;
+
 interface Doc<Fields = any> {
     /** The id of the doc, e.g. "Pages/foo-bar". */
     id: string;
@@ -335,6 +527,21 @@ declare class RootCMSClient {
      * Checks if a doc is currently "locked" for publishing.
      */
     testPublishingLocked(doc: Doc): boolean;
+    /**
+     * Returns a `TranslationsManager` object for managing translations.
+     *
+     * To get translations:
+     * ```
+     * await tm.loadTranslations({
+     *   ids: ['Global/strings', 'Pages/index'],
+     *   locales: ['es'],
+     * });
+     * ```
+     *
+     * NOTE: The `TranslationsManager` is a v2 feature that will eventually
+     * replace the v1 translations system.
+     */
+    getTranslationsManager(): TranslationsManager;
     /**
      * Loads translations saved in the translations collection, optionally
      * filtered by tag.
@@ -485,4 +692,4 @@ declare function parseDocId(docId: string): {
     slug: string;
 };
 
-export { type Action as A, cmsPlugin as B, type CMSUser as C, type Doc as D, type GetDocOptions as G, type HttpMethod as H, type LoadTranslationsOptions as L, type Release as R, type SetDocOptions as S, type TranslationsMap as T, type UserRole as U, 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 CMSAIConfig as w, type CMSSidebarTool as x, type CMSPluginOptions as y, type CMSPlugin as z };
+export { type Action as A, type TranslationsLocaleDocHashMap as B, type TranslationsLocaleDocEntry as C, type Doc as D, type SingleLocaleTranslationsMap as E, TranslationsManager as F, type GetDocOptions as G, type HttpMethod as H, buildTranslationsDbPath as I, buildTranslationsLocaleDocDbPath as J, type CMSUser as K, type LoadTranslationsOptions as L, type MultiLocaleTranslationsMap as M, type CMSAIConfig as N, type CMSSidebarTool as O, type CMSPluginOptions as P, type CMSPlugin as Q, type Release as R, type SetDocOptions as S, type TranslationsMap as T, type UserRole as U, cmsPlugin as V, 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 Locale as w, type SourceString as x, type TranslatedString as y, type TranslationsDocMode 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, 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, 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-98Le1XxF.js';
+export { A as Action, p as ArrayObject, 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, 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-c_QAurxr.js';