@blinkk/root-cms 1.4.7 → 1.4.9

package/dist/plugin.js

@@ -837,6 +837,35 @@ var RootCMSClient = class {
     }
     return null;
   }
+  /**
+   * Firestore path for a collection.
+   */
+  dbCollectionDocsPath(collectionId, options) {
+    let modeCollection = "";
+    if (options.mode === "draft") {
+      modeCollection = "Drafts";
+    } else if (options.mode === "published") {
+      modeCollection = "Published";
+    } else {
+      throw new Error(`unknown mode: ${options.mode}`);
+    }
+    return `Projects/${this.projectId}/Collections/${collectionId}/${modeCollection}`;
+  }
+  /**
+   * Firestore path for a content doc.
+   */
+  dbDocPath(collectionId, slug, options) {
+    const collectionDocsPath = this.dbCollectionDocsPath(collectionId, options);
+    const normalizedSlug = slug.replaceAll("/", "--");
+    return `${collectionDocsPath}/${normalizedSlug}`;
+  }
+  /**
+   * Firestore doc ref for a content doc.
+   */
+  dbDocRef(collectionId, slug, options) {
+    const docPath = this.dbDocPath(collectionId, slug, options);
+    return this.db.doc(docPath);
+  }
   /**
    * Saves draft data to a doc.
    *
@@ -1237,6 +1266,25 @@ var RootCMSClient = class {
     const translationsMap = await this.loadTranslations(options);
     return translationsForLocale(translationsMap, locale);
   }
+  /**
+   * Firestore path for a translations file.
+   */
+  dbTranslationsPath(translationsId, options) {
+    const mode = options.mode;
+    if (!(mode === "draft" || mode === "published")) {
+      throw new Error(`invalid mode: ${mode}`);
+    }
+    const slug = translationsId.replaceAll("/", "--");
+    const dbPath = `Projects/${this.projectId}/TranslationsManager/${mode}/Translations/${slug}`;
+    return dbPath;
+  }
+  /**
+   * Firestore doc ref for a translations file.
+   */
+  dbTranslationsRef(translationsId, options) {
+    const dbPath = this.dbTranslationsPath(translationsId, options);
+    return this.db.doc(dbPath);
+  }
   /**
    * Returns a data source configuration object.
    */
@@ -1359,14 +1407,34 @@ var RootCMSClient = class {
     if (!dataSourceId || dataSourceId.includes("/")) {
       throw new Error(`invalid data source id: ${dataSourceId}`);
     }
-    const dbPath = `Projects/${this.projectId}/DataSources/${dataSourceId}/Data/${mode}`;
-    const docRef = this.db.doc(dbPath);
+    const docRef = this.dbDataSourceDataRef(dataSourceId, { mode });
     const doc = await docRef.get();
     if (doc.exists) {
       return doc.data();
     }
     return null;
   }
+  /**
+   * Firestore path for a datasource data.
+   */
+  dbDataSourceDataPath(dataSourceId, options) {
+    if (!dataSourceId || dataSourceId.includes("/")) {
+      throw new Error(`invalid data source id: ${dataSourceId}`);
+    }
+    const mode = options.mode;
+    if (!(mode === "draft" || mode === "published")) {
+      throw new Error(`invalid mode: ${mode}`);
+    }
+    const dbPath = `Projects/${this.projectId}/DataSources/${dataSourceId}/Data/${mode}`;
+    return dbPath;
+  }
+  /**
+   * Firestore doc ref for a datasource data.
+   */
+  dbDataSourceDataRef(dataSourceId, options) {
+    const dbPath = this.dbDataSourceDataPath(dataSourceId, options);
+    return this.db.doc(dbPath);
+  }
   /**
    * Gets the user's role from the project's ACL.
    */
@@ -1438,6 +1506,13 @@ var RootCMSClient = class {
       }
     }
   }
+  /**
+   * Creates a batch request that is capable of fetching one or more docs,
+   * corresponding translations, and dataSources.
+   */
+  createBatchRequest(options) {
+    return new BatchRequest(this, options);
+  }
 };
 function isRichTextData(data) {
   return Boolean(
@@ -1572,6 +1647,210 @@ function parseDocId(docId) {
   }
   return { collection, slug };
 }
+var BatchRequest = class {
+  constructor(cmsClient, options) {
+    this.docIds = [];
+    this.dataSourceIds = [];
+    this.queries = [];
+    this.translationsIds = [];
+    this.cmsClient = cmsClient;
+    this.db = cmsClient.db;
+    this.options = options;
+  }
+  /**
+   * Adds a doc to the batch request.
+   */
+  addDoc(docId) {
+    this.docIds.push(docId);
+  }
+  /**
+   * Adds a data source to the batch request.
+   */
+  addDataSource(dataSourceId) {
+    this.dataSourceIds.push(dataSourceId);
+  }
+  /**
+   * Adds a collection-based query to the batch request.
+   */
+  addQuery(queryId, collectionId, queryOptions) {
+    this.queries.push({
+      queryId,
+      collectionId,
+      queryOptions
+    });
+  }
+  /**
+   * Adds a translation file to the request.
+   */
+  addTranslations(translationsId) {
+    this.translationsIds.push(translationsId);
+  }
+  /**
+   * Fetches data from the DB.
+   */
+  async fetch() {
+    const res = new BatchResponse();
+    const promises = [
+      this.fetchDocs(res),
+      this.fetchQueries(res),
+      this.fetchDataSources(res)
+    ];
+    if (!this.options.translate && this.translationsIds.length > 0) {
+      promises.push(this.fetchTranslations(res));
+    }
+    await Promise.all(promises);
+    if (this.translationsIds.length > 0) {
+      await this.fetchTranslations(res);
+    }
+    return res;
+  }
+  async fetchDocs(res) {
+    if (this.docIds.length === 0) {
+      return;
+    }
+    const docRefs = this.docIds.map((docId) => {
+      const [collectionId, slug] = docId.split("/");
+      return this.cmsClient.dbDocRef(collectionId, slug, {
+        mode: this.options.mode
+      });
+    });
+    const docs = await this.db.getAll(...docRefs);
+    this.docIds.forEach((docId, i) => {
+      const doc = docs[i];
+      if (!doc.exists) {
+        console.warn(`doc "${docId}" does not exist`);
+        return;
+      }
+      const docData = unmarshalData(doc.data());
+      res.docs[docId] = docData;
+      if (this.options.translate) {
+        this.addTranslations(docId);
+      }
+    });
+  }
+  async fetchQueries(res) {
+    if (this.queries.length === 0) {
+      return;
+    }
+    const mode = this.options.mode;
+    const handleQuery = async (queryItem) => {
+      const docsPath = this.cmsClient.dbCollectionDocsPath(
+        queryItem.collectionId,
+        { mode }
+      );
+      const queryOptions = queryItem.queryOptions || {};
+      let query = this.db.collection(docsPath);
+      if (queryOptions.limit) {
+        query = query.limit(queryOptions.limit);
+      }
+      if (queryOptions.offset) {
+        query = query.offset(queryOptions.offset);
+      }
+      if (queryOptions.orderBy) {
+        query = query.orderBy(
+          queryOptions.orderBy,
+          queryOptions.orderByDirection
+        );
+      }
+      if (queryOptions.query) {
+        query = queryOptions.query(query);
+      }
+      const results = await query.get();
+      const docs = [];
+      results.forEach((result) => {
+        const doc = unmarshalData(result.data());
+        docs.push(doc);
+      });
+      res.queries[queryItem.queryId] = docs;
+    };
+    await Promise.all(this.queries.map((queryItem) => handleQuery(queryItem)));
+  }
+  async fetchDataSources(res) {
+    if (this.dataSourceIds.length === 0) {
+      return;
+    }
+    const docRefs = this.dataSourceIds.map((dataSourceId) => {
+      return this.cmsClient.dbDataSourceDataRef(dataSourceId, {
+        mode: this.options.mode
+      });
+    });
+    const docs = await this.db.getAll(...docRefs);
+    this.dataSourceIds.forEach((dataSourceId, i) => {
+      const doc = docs[i];
+      if (!doc.exists) {
+        console.warn(`"data source "${dataSourceId}" does not exist`);
+        return;
+      }
+      res.dataSources[dataSourceId] = doc.data();
+    });
+  }
+  async fetchTranslations(res) {
+    if (this.translationsIds.length === 0) {
+      return;
+    }
+    const docRefs = this.translationsIds.map((translationsId) => {
+      return this.cmsClient.dbTranslationsRef(translationsId, {
+        mode: this.options.mode
+      });
+    });
+    const docs = await this.db.getAll(...docRefs);
+    this.translationsIds.forEach((translationsId, i) => {
+      const doc = docs[i];
+      if (!doc.exists) {
+        return;
+      }
+      res.translations[translationsId] = doc.data();
+    });
+  }
+};
+var BatchResponse = class {
+  constructor() {
+    this.docs = {};
+    this.queries = {};
+    this.dataSources = {};
+    this.translations = {};
+  }
+  /**
+   * 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"].
+   *
+   * TODO(stevenle): support the locale fallback tree.
+   *
+   * The returned value is a flat map of source string to translated string,
+   * e.g.:
+   * {"<source>": "<translation>"}
+   */
+  getTranslations(locale) {
+    const translationsMap = this.getTranslationsMap();
+    const translations = translationsForLocale(translationsMap, locale);
+    return translations;
+  }
+  /**
+   * 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>"}}
+   */
+  getTranslationsMap() {
+    const translationsDocs = Object.values(this.translations).reverse();
+    const translationsMap = {};
+    for (const translationsDoc of translationsDocs) {
+      const strings = translationsDoc.strings || {};
+      for (const hash in strings) {
+        const translations = strings[hash];
+        translationsMap[hash] ??= { source: translations.source };
+        for (const locale in translations) {
+          if (locale !== "source" && translations[locale]) {
+            translationsMap[hash][locale] = translations[locale];
+          }
+        }
+      }
+    }
+    return translationsMap;
+  }
+};
 
 // core/versions.ts
 import path from "node:path";

package/dist/project.d.ts

@@ -1,4 +1,4 @@
-import { S as Schema } from './schema-hlZc-G1f.js';
+import { S as Schema } from './schema-tTvlPgCa.js';
 import 'preact';
 
 /**

package/dist/{schema-hlZc-G1f.d.ts → schema-tTvlPgCa.d.ts}

@@ -50,6 +50,7 @@ type SelectField = CommonFieldProps & {
         label?: string;
     }> | string[];
     translate?: boolean;
+    searchable?: boolean;
 };
 declare function select(field: Omit<SelectField, 'type'>): SelectField;
 type MultiSelectField = Omit<SelectField, 'type'> & {
@@ -68,6 +69,8 @@ type ImageField = CommonFieldProps & {
      * Cache-control header to set on the GCS object.
      */
     cacheControl?: string;
+    /** Set to `false` to disable the alt text input. */
+    alt?: boolean;
 };
 declare function image(field: Omit<ImageField, 'type'>): ImageField;
 type FileField = CommonFieldProps & {
@@ -83,6 +86,8 @@ type FileField = CommonFieldProps & {
      * Cache-control header to set on the GCS object.
      */
     cacheControl?: string;
+    /** Set to `false` to disable the alt text input. */
+    alt?: boolean;
 };
 declare function file(field: Omit<FileField, 'type'>): FileField;
 type ObjectField = CommonFieldProps & {