@blinkk/root-cms 1.3.11 → 2.0.0-rc.0

package/dist/{client-AoUqU1KV.d.ts → client-dBGLkauA.d.ts}

@@ -127,6 +127,7 @@ type CMSPlugin = Plugin & {
     getFirestore: () => Firestore;
 };
 declare function cmsPlugin(options: CMSPluginOptions): CMSPlugin;
+declare function getCmsPlugin(rootConfig: RootConfig): CMSPlugin;
 
 interface Doc<Fields = any> {
     /** The id of the doc, e.g. "Pages/foo-bar". */
@@ -154,6 +155,23 @@ interface Doc<Fields = any> {
     };
     fields: Fields;
 }
+interface TranslationsDoc {
+    id: string;
+    sys: {
+        modifiedAt: Timestamp;
+        modifiedBy: string;
+        publishedAt?: Timestamp;
+        publishedBy?: string;
+        linkedSheet?: {
+            spreadsheetId: string;
+            gid: number;
+            linkedAt: Timestamp;
+            linkedBy: string;
+        };
+        tags?: string[];
+    };
+    strings: TranslationsMap;
+}
 type DocMode = 'draft' | 'published';
 type UserRole = 'ADMIN' | 'EDITOR' | 'VIEWER';
 type HttpMethod = 'GET' | 'POST';
@@ -212,6 +230,11 @@ interface ListDocsOptions {
     orderBy?: string;
     orderByDirection?: 'asc' | 'desc';
     query?: (query: Query) => Query;
+    /**
+     * Whether to fetch the "raw" version of the doc (for use in conjunction with
+     * `setRawDoc()`).
+     */
+    raw?: boolean;
 }
 interface GetCountOptions {
     mode: DocMode;
@@ -289,6 +312,15 @@ declare class RootCMSClient {
      * what you are doing.
      */
     getRawDoc(collectionId: string, slug: string, options: GetDocOptions): Promise<any | null>;
+    dbCollectionDocsPath(collectionId: string, options: {
+        mode: 'draft' | 'published';
+    }): string;
+    dbDocPath(collectionId: string, slug: string, options: {
+        mode: 'draft' | 'published';
+    }): string;
+    dbDocRef(collectionId: string, slug: string, options: {
+        mode: 'draft' | 'published';
+    }): FirebaseFirestore.DocumentReference<FirebaseFirestore.DocumentData>;
     /**
      * Saves draft data to a doc.
      *
@@ -326,20 +358,24 @@ declare class RootCMSClient {
      * Publishes docs in scheduled releases.
      */
     publishScheduledReleases(): Promise<void>;
+    publishTranslationsDoc(translationsId: string, options?: {
+        batch?: WriteBatch;
+        publishedBy?: string;
+    }): Promise<void>;
     /**
      * Checks if a doc is currently "locked" for publishing.
      */
     testPublishingLocked(doc: Doc): boolean;
     /**
-     * Loads translations saved in the translations collection, optionally
-     * filtered by tag.
+     * Loads all published strings in the db.
      *
-     * Returns a map like:
      * ```
      * {
      *   "<hash>": {"source": "Hello", "es": "Hola", "fr": "Bonjour"},
      * }
      * ```
+     *
+     * @deprecated Use `createBatchRequest()` to fetch draft/published translations.
      */
     loadTranslations(options?: LoadTranslationsOptions): Promise<TranslationsMap>;
     /**
@@ -349,12 +385,22 @@ declare class RootCMSClient {
      *   "Hello": {"es": "Hola", "fr": "Bonjour"},
      * });
      * ```
+     *
+     * @deprecated Use `saveDraftTranslations()` and `publishTranslations()`
+     * instead.
      */
     saveTranslations(translations: {
         [source: string]: {
             [locale: string]: string;
         };
     }, tags?: string[]): Promise<void>;
+    saveDraftTranslations(translationsId: string, translations: {
+        [source: string]: {
+            [locale: string]: string;
+        };
+    }, options?: {
+        modifiedby?: string;
+    }): Promise<void>;
     /**
      * Returns the "key" used for a translation as stored in the db. Translations
      * are stored under `Projects/<project id>/Translations/<sha1 hash>`.
@@ -398,6 +444,18 @@ declare class RootCMSClient {
     getFromDataSource<T = any>(dataSourceId: string, options?: {
         mode?: 'draft' | 'published';
     }): Promise<DataSourceData<T> | null>;
+    dbDataSourceDataPath(dataSourceId: string, options: {
+        mode: 'draft' | 'published';
+    }): string;
+    dbDataSourceDataRef(dataSourceId: string, options: {
+        mode: 'draft' | 'published';
+    }): FirebaseFirestore.DocumentReference<FirebaseFirestore.DocumentData>;
+    dbTranslationsPath(translationsId: string, options: {
+        mode: 'draft' | 'published';
+    }): string;
+    dbTranslationsRef(translationsId: string, options: {
+        mode: 'draft' | 'published';
+    }): FirebaseFirestore.DocumentReference<FirebaseFirestore.DocumentData>;
     /**
      * Gets the user's role from the project's ACL.
      */
@@ -410,12 +468,90 @@ declare class RootCMSClient {
         by?: string;
         metadata?: any;
     }): Promise<void>;
+    createBatchRequest(options: BatchRequestOptions): BatchRequest;
+}
+interface BatchRequestOptions {
+    mode: 'draft' | 'published';
+    /**
+     * Whether to automatically fetch translations for the docs retrieved in the
+     * request.
+     */
+    translate?: boolean;
+}
+interface BatchRequestQuery {
+    queryId: string;
+    collectionId: string;
+    queryOptions?: BatchRequestQueryOptions;
+}
+interface BatchRequestQueryOptions {
+    offset?: number;
+    limit?: number;
+    orderBy?: string;
+    orderByDirection?: 'asc' | 'desc';
+    query?: (query: Query) => Query;
+}
+declare class BatchRequest {
+    cmsClient: RootCMSClient;
+    private options;
+    private db;
+    private docIds;
+    private dataSourceIds;
+    private queries;
+    private translationsIds;
+    constructor(cmsClient: RootCMSClient, options: BatchRequestOptions);
+    /**
+     * Adds a doc to the batch request.
+     */
+    addDoc(docId: string): void;
+    /**
+     * Adds a data source to the batch request.
+     */
+    addDataSource(dataSourceId: string): void;
+    /**
+     * Adds a collection-based query to the batch request.
+     */
+    addQuery(queryId: string, collectionId: string, queryOptions?: BatchRequestQueryOptions): void;
+    /**
+     * Adds a translation file to the request.
+     */
+    addTranslations(translationsId: string): void;
+    /**
+     * Fetches data from the DB.
+     */
+    fetch(): Promise<BatchResponse>;
+    private fetchDocs;
+    private fetchQueries;
+    private fetchDataSources;
+    private fetchTranslations;
+}
+declare class BatchResponse {
+    docs: Record<string, Doc>;
+    queries: Record<string, Doc[]>;
+    dataSources: Record<string, DataSourceData>;
+    translations: Record<string, TranslationsDoc>;
+    /**
+     * Returns a map of translations for a given locale or locale fallbacks.
+     *
+     * The input is either a single locale (e.g. "de") or an array of locales
+     * representing the fallback tree, e.g. ["en-CA", "en-GB", "en"].
+     *
+     * The returned value is a flat map of source string to translated string,
+     * e.g.:
+     * {"<source>": "<translation>"}
+     */
+    getTranslations(locale: string | string[]): LocaleTranslations;
+    /**
+     * Merges the strings from all translations files retrieved in the request.
+     * The returned value is a map of string to translations, e.g.:
+     *
+     * {"<hash>": {"source": "<source>", "<locale>": "<translation>"}}
+     */
+    private getTranslationsMap;
 }
 /**
  * Returns true if the `data` is a rich text data object.
  */
 declare function isRichTextData(data: any): boolean;
-declare function getCmsPlugin(rootConfig: RootConfig): CMSPlugin;
 /**
  * Walks the data tree and converts any array of objects into "array objects"
  * for storage in firestore.
@@ -471,7 +607,7 @@ declare function unmarshalArray(arrObject: ArrayObject): any[];
  * }
  * ```
  */
-declare function translationsForLocale(translationsMap: TranslationsMap, locale: string): LocaleTranslations;
+declare function translationsForLocale(translationsMap: TranslationsMap, locale: string | string[]): LocaleTranslations;
 /**
  * Parses a docId (e.g. `Pages/foo`) and returns the `collection` and `slug`.
  */
@@ -480,4 +616,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, BatchRequest as B, parseDocId as C, type Doc as D, type CMSUser as E, type CMSAIConfig as F, type GetDocOptions as G, type HttpMethod as H, type CMSSidebarTool as I, type CMSPluginOptions as J, type CMSPlugin as K, type LoadTranslationsOptions as L, cmsPlugin as M, RootCMSClient as R, type SetDocOptions as S, type TranslationsMap as T, type UserRole as U, type LocaleTranslations as a, type TranslationsDoc as b, type DocMode as c, type DataSource as d, type DataSourceData as e, type DataSourceMode as f, getCmsPlugin as g, type SaveDraftOptions as h, type ListDocsOptions as i, type GetCountOptions as j, type Translation as k, type Release as l, type ListActionsOptions as m, type BatchRequestOptions as n, type BatchRequestQuery as o, type BatchRequestQueryOptions as p, BatchResponse as q, isRichTextData as r, marshalData as s, normalizeData as t, unmarshalData as u, type ArrayObject as v, toArrayObject as w, marshalArray as x, unmarshalArray as y, translationsForLocale 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-AoUqU1KV.js';
+export { A as Action, v as ArrayObject, B as BatchRequest, n as BatchRequestOptions, o as BatchRequestQuery, p as BatchRequestQueryOptions, q as BatchResponse, d as DataSource, e as DataSourceData, f as DataSourceMode, D as Doc, c as DocMode, j as GetCountOptions, G as GetDocOptions, H as HttpMethod, m as ListActionsOptions, i as ListDocsOptions, L as LoadTranslationsOptions, a as LocaleTranslations, l as Release, R as RootCMSClient, h as SaveDraftOptions, S as SetDocOptions, k as Translation, b as TranslationsDoc, T as TranslationsMap, U as UserRole, g as getCmsPlugin, r as isRichTextData, x as marshalArray, s as marshalData, t as normalizeData, C as parseDocId, w as toArrayObject, z as translationsForLocale, y as unmarshalArray, u as unmarshalData } from './client-dBGLkauA.js';