@blinkk/root-cms 1.3.26 → 1.4.1

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.3.26",
+  version: "1.4.1",
   author: "s@blinkk.com",
   license: "MIT",
   engines: {
@@ -138,7 +138,7 @@ var package_default = {
     vitest: "0.34.6"
   },
   peerDependencies: {
-    "@blinkk/root": "1.3.26",
+    "@blinkk/root": "1.4.1",
     "firebase-admin": ">=11",
     "firebase-functions": ">=4",
     preact: ">=10",
@@ -151,6 +151,25 @@ var package_default = {
   }
 };
 
+// core/project.ts
+var IGNORED_SCHEMA_FOLDERS = ["/appengine/", "/functions/", "/gae/"];
+var SCHEMA_MODULES = import.meta.glob("/**/*.schema.ts", {
+  eager: true
+});
+function getProjectSchemas() {
+  const schemas = {};
+  for (const fileId in SCHEMA_MODULES) {
+    if (IGNORED_SCHEMA_FOLDERS.some((prefix) => fileId.startsWith(prefix))) {
+      continue;
+    }
+    const schemaModule = SCHEMA_MODULES[fileId];
+    if (schemaModule.default) {
+      schemas[fileId] = schemaModule.default;
+    }
+  }
+  return schemas;
+}
+
 // core/app.tsx
 import { jsx, jsxs } from "preact/jsx-runtime";
 var __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -223,15 +242,9 @@ function App(props) {
 }
 async function renderApp(req, res, options) {
   var _a;
-  const collectionModules = import.meta.glob("/collections/*.schema.ts", {
-    eager: true
-  });
   const collections = {};
-  Object.keys(collectionModules).forEach((moduleId) => {
-    const collectionId = path.parse(moduleId).base.split(".")[0];
-    const module = collectionModules[moduleId];
-    const collection = module.default;
-    collections[collectionId] = collection;
+  Object.entries(getCollections()).forEach(([collectionId, collection]) => {
+    collections[collectionId] = serializeCollection(collection);
   });
   const rootConfig = options.rootConfig || {};
   const cmsConfig = options.cmsConfig || {};
@@ -279,6 +292,16 @@ ${mainHtml}`;
   setSecurityHeaders(options, req, res, nonce);
   res.send(html);
 }
+function serializeCollection(collection) {
+  return {
+    name: collection.name,
+    description: collection.description,
+    domain: collection.domain,
+    url: collection.url,
+    previewUrl: collection.previewUrl,
+    preview: collection.preview
+  };
+}
 function SignIn(props) {
   return /* @__PURE__ */ jsxs("html", { children: [
     /* @__PURE__ */ jsxs("head", { children: [
@@ -357,6 +380,16 @@ ${mainHtml}`;
   res.status(403);
   res.send(html);
 }
+function getCollections() {
+  const collections = {};
+  const schemas = getProjectSchemas();
+  Object.entries(schemas).forEach(([fileId, schema]) => {
+    if (fileId.startsWith("/collections/")) {
+      collections[schema.name] = schema;
+    }
+  });
+  return collections;
+}
 function generateNonce() {
   return crypto.randomBytes(16).toString("base64");
 }
@@ -397,6 +430,7 @@ function cachebust(req, url) {
   return `${url}?c=${value}`;
 }
 export {
+  getCollections,
   renderApp,
   renderSignIn
 };

package/dist/cli.js

@@ -22,7 +22,8 @@ async function generateTypes() {
   await generateSchemaDts(outputPath, schemas);
   console.log("saved root-cms.d.ts!");
 }
-var TEMPLATE = `/** Root.js CMS types. This file is autogenerated. */
+var TEMPLATE = `/* eslint-disable */
+/** Root.js CMS types. This file is autogenerated. */
 
 export interface RootCMSFile {
   src: string;
@@ -35,6 +36,8 @@ export type RootCMSImage = RootCMSFile;
 
 export type RootCMSOneOf<T = any> = T;
 
+export type RootCMSOneOfOption<T, Base> = Base & {_type: T};
+
 export interface RootCMSRichTextBlock {
   type: string;
   data: any;
@@ -75,13 +78,106 @@ export interface RootCMSDoc<Fields extends {}> {
   /** User-entered field values from the CMS. */
   fields?: Fields;
 }`;
+var DtsFormatter = class {
+  constructor() {
+    /**
+     * Field types defined in either `.schema.ts` files or used by `oneOf()`
+     * fields.
+     */
+    this.fieldsTypes = {};
+    /**
+     * For `collections/*.schema.ts` files, output a corresponding "RootCMSDoc"
+     * type. For example, `collections/BlogPosts.schema.ts` would output a type
+     * called `BlogPostsDoc`.
+     */
+    this.docTypes = {};
+  }
+  /** Adds the types for a `.schema.ts` file to the `.d.ts` file. */
+  addSchemaFile(fileId, schema) {
+    const jsdoc = `Generated from \`${fileId}\`.`;
+    const typeId = alphanumeric(path.parse(fileId).name.split(".")[0]);
+    const oneOfTypes = {};
+    const fieldsTypeId = `${typeId}Fields`;
+    const fieldsType = dom.create.interface(
+      fieldsTypeId,
+      dom.DeclarationFlags.Export
+    );
+    fieldsType.jsDocComment = jsdoc;
+    for (const field of schema.fields) {
+      if (!field.id) {
+        continue;
+      }
+      fieldsType.members.push(fieldProperty(field, { typeId, oneOfTypes }));
+    }
+    for (const oneOfTypeId in oneOfTypes) {
+      if (!this.fieldsTypes[fieldsTypeId]) {
+        this.fieldsTypes[oneOfTypeId] = oneOfTypes[oneOfTypeId];
+      }
+    }
+    this.fieldsTypes[fieldsTypeId] = fieldsType;
+    if (fileId.startsWith("/collections/")) {
+      const docTypeId = `${typeId}Doc`;
+      const baseType = dom.create.namedTypeReference("RootCMSDoc");
+      baseType.typeArguments.push(dom.create.namedTypeReference(fieldsTypeId));
+      const docType = dom.create.alias(
+        docTypeId,
+        baseType,
+        dom.DeclarationFlags.Export
+      );
+      docType.jsDocComment = jsdoc;
+      this.docTypes[docTypeId] = docType;
+    }
+  }
+  /** Generates the `.d.ts` output as a string. */
+  toString() {
+    const results = [TEMPLATE];
+    const sortedFieldsTypes = Object.keys(this.fieldsTypes).sort();
+    for (const fieldsTypeId of sortedFieldsTypes) {
+      const fieldsType = this.fieldsTypes[fieldsTypeId];
+      results.push(this.typeToString(fieldsType));
+      const docTypeId = this.fieldsTypeToDocType(fieldsTypeId);
+      const docType = this.docTypes[docTypeId];
+      if (docType) {
+        results.push(this.typeToString(docType));
+      }
+    }
+    const output = results.join("\n\n").replaceAll("/**  ", "/** ").replaceAll("  */", " */").replace(/\r\n|\r|\n/g, "\n") + "\n";
+    return output;
+  }
+  /**
+   * Converts "<Name>Fields" to "<Name>Doc".
+   */
+  fieldsTypeToDocType(fieldsTypeId) {
+    if (!fieldsTypeId.endsWith("Fields")) {
+      throw new Error(`"${fieldsTypeId}" should be suffixed with "Fields"`);
+    }
+    const name = fieldsTypeId.slice(0, -6);
+    return `${name}Doc`;
+  }
+  typeToString(type2) {
+    return this.reformatOutput(dom.emit(type2, { singleLineJsDocComments: true }));
+  }
+  /**
+   * Formats the output to Google style conventions, e.g. 2-space indents and
+   * single quote strings.
+   */
+  reformatOutput(input) {
+    const lines = input.trim().split("\n");
+    const results = [];
+    for (const line of lines) {
+      const convertedLine = line.replace(/ {4}/g, "  ").replaceAll('"', "'");
+      results.push(convertedLine);
+    }
+    return results.join("\n");
+  }
+};
 async function generateSchemaDts(outputPath, schemas) {
-  const results = [TEMPLATE];
+  const dtsFormatter = new DtsFormatter();
   for (const fileId in schemas) {
     const schema = schemas[fileId];
-    results.push(renderSchema(fileId, schema));
+    dtsFormatter.addSchemaFile(fileId, schema);
   }
-  const output = results.join("\n\n").replaceAll("/**  ", "/** ").replaceAll("  */", " */").replace(/\r\n|\r|\n/g, "\n") + "\n";
+  const output = dtsFormatter.toString();
   await fs.writeFile(outputPath, output, "utf-8");
 }
 function fieldProperty(field, options) {
@@ -139,26 +235,27 @@ function fieldType(field, options) {
           return;
         }
         const cleanName = alphanumeric(schema.name);
-        const oneOfTypeId = `${options.typeId}_${cleanName}`;
+        const oneOfTypeId = `${cleanName}Fields`;
         if (!options.oneOfTypes[oneOfTypeId]) {
           const oneOfTypeInterface = dom.create.interface(
             oneOfTypeId,
             dom.DeclarationFlags.Export
           );
-          oneOfTypeInterface.members.push(
-            dom.create.property(
-              "_type",
-              dom.type.stringLiteral(schema.name),
-              dom.DeclarationFlags.None
-            )
-          );
+          if (schema.description) {
+            oneOfTypeInterface.jsDocComment = schema.description;
+          }
           const oneOfTypeFields = schema.fields || [];
           oneOfTypeFields.forEach((f) => {
             oneOfTypeInterface.members.push(fieldProperty(f, options));
           });
           options.oneOfTypes[oneOfTypeId] = oneOfTypeInterface;
         }
-        unionTypes.push(dom.create.namedTypeReference(oneOfTypeId));
+        const oneOfOption = dom.create.namedTypeReference("RootCMSOneOfOption");
+        oneOfOption.typeArguments = [
+          dom.type.stringLiteral(schema.name),
+          dom.create.namedTypeReference(oneOfTypeId)
+        ];
+        unionTypes.push(oneOfOption);
       });
       if (unionTypes.length > 0) {
         oneOf.typeArguments = [dom.create.union(unionTypes)];
@@ -188,55 +285,6 @@ function fieldType(field, options) {
   }
   return dom.type.unknown;
 }
-function renderSchema(fileId, schema) {
-  const jsdoc = `Generated from \`${fileId}\`.`;
-  const typeId = alphanumeric(path.parse(fileId).name.split(".")[0]);
-  const oneOfTypes = {};
-  const fieldsInterface = `${typeId}Fields`;
-  const fieldsType = dom.create.interface(
-    fieldsInterface,
-    dom.DeclarationFlags.Export
-  );
-  fieldsType.jsDocComment = jsdoc;
-  for (const field of schema.fields) {
-    if (!field.id) {
-      continue;
-    }
-    fieldsType.members.push(fieldProperty(field, { typeId, oneOfTypes }));
-  }
-  const typesOutput = [];
-  Object.values(oneOfTypes).forEach((oneOfTypeDef) => {
-    oneOfTypeDef.jsDocComment = jsdoc;
-    typesOutput.push(
-      dom.emit(oneOfTypeDef, { singleLineJsDocComments: true }).trim()
-    );
-  });
-  typesOutput.push(
-    dom.emit(fieldsType, { singleLineJsDocComments: true }).trim()
-  );
-  if (fileId.startsWith("/collections/")) {
-    const baseType = dom.create.namedTypeReference("RootCMSDoc");
-    baseType.typeArguments.push(dom.create.namedTypeReference(fieldsInterface));
-    const docType = dom.create.alias(
-      `${typeId}Doc`,
-      baseType,
-      dom.DeclarationFlags.Export
-    );
-    docType.jsDocComment = jsdoc;
-    const docTypeOutput = dom.emit(docType, { singleLineJsDocComments: true }).trim();
-    typesOutput.push(docTypeOutput);
-  }
-  return reformatOutput(typesOutput.join("\n\n"));
-}
-function reformatOutput(input) {
-  const lines = input.split("\n");
-  const results = [];
-  for (const line of lines) {
-    const convertedLine = line.replace(/ {4}/g, "  ").replaceAll('"', "'");
-    results.push(convertedLine);
-  }
-  return results.join("\n");
-}
 function alphanumeric(input) {
   return input.replace(/[^a-zA-Z0-9]/g, "");
 }

package/dist/plugin.js

@@ -33,12 +33,12 @@ async function generateTypes() {
   console.log("saved root-cms.d.ts!");
 }
 async function generateSchemaDts(outputPath, schemas) {
-  const results = [TEMPLATE];
+  const dtsFormatter = new DtsFormatter();
   for (const fileId in schemas) {
     const schema = schemas[fileId];
-    results.push(renderSchema(fileId, schema));
+    dtsFormatter.addSchemaFile(fileId, schema);
   }
-  const output = results.join("\n\n").replaceAll("/**  ", "/** ").replaceAll("  */", " */").replace(/\r\n|\r|\n/g, "\n") + "\n";
+  const output = dtsFormatter.toString();
   await fs.writeFile(outputPath, output, "utf-8");
 }
 function fieldProperty(field, options) {
@@ -96,26 +96,27 @@ function fieldType(field, options) {
           return;
         }
         const cleanName = alphanumeric(schema.name);
-        const oneOfTypeId = `${options.typeId}_${cleanName}`;
+        const oneOfTypeId = `${cleanName}Fields`;
         if (!options.oneOfTypes[oneOfTypeId]) {
           const oneOfTypeInterface = dom.create.interface(
             oneOfTypeId,
             dom.DeclarationFlags.Export
           );
-          oneOfTypeInterface.members.push(
-            dom.create.property(
-              "_type",
-              dom.type.stringLiteral(schema.name),
-              dom.DeclarationFlags.None
-            )
-          );
+          if (schema.description) {
+            oneOfTypeInterface.jsDocComment = schema.description;
+          }
           const oneOfTypeFields = schema.fields || [];
           oneOfTypeFields.forEach((f) => {
             oneOfTypeInterface.members.push(fieldProperty(f, options));
           });
           options.oneOfTypes[oneOfTypeId] = oneOfTypeInterface;
         }
-        unionTypes.push(dom.create.namedTypeReference(oneOfTypeId));
+        const oneOfOption = dom.create.namedTypeReference("RootCMSOneOfOption");
+        oneOfOption.typeArguments = [
+          dom.type.stringLiteral(schema.name),
+          dom.create.namedTypeReference(oneOfTypeId)
+        ];
+        unionTypes.push(oneOfOption);
       });
       if (unionTypes.length > 0) {
         oneOf.typeArguments = [dom.create.union(unionTypes)];
@@ -145,64 +146,16 @@ function fieldType(field, options) {
   }
   return dom.type.unknown;
 }
-function renderSchema(fileId, schema) {
-  const jsdoc = `Generated from \`${fileId}\`.`;
-  const typeId = alphanumeric(path2.parse(fileId).name.split(".")[0]);
-  const oneOfTypes = {};
-  const fieldsInterface = `${typeId}Fields`;
-  const fieldsType = dom.create.interface(
-    fieldsInterface,
-    dom.DeclarationFlags.Export
-  );
-  fieldsType.jsDocComment = jsdoc;
-  for (const field of schema.fields) {
-    if (!field.id) {
-      continue;
-    }
-    fieldsType.members.push(fieldProperty(field, { typeId, oneOfTypes }));
-  }
-  const typesOutput = [];
-  Object.values(oneOfTypes).forEach((oneOfTypeDef) => {
-    oneOfTypeDef.jsDocComment = jsdoc;
-    typesOutput.push(
-      dom.emit(oneOfTypeDef, { singleLineJsDocComments: true }).trim()
-    );
-  });
-  typesOutput.push(
-    dom.emit(fieldsType, { singleLineJsDocComments: true }).trim()
-  );
-  if (fileId.startsWith("/collections/")) {
-    const baseType = dom.create.namedTypeReference("RootCMSDoc");
-    baseType.typeArguments.push(dom.create.namedTypeReference(fieldsInterface));
-    const docType = dom.create.alias(
-      `${typeId}Doc`,
-      baseType,
-      dom.DeclarationFlags.Export
-    );
-    docType.jsDocComment = jsdoc;
-    const docTypeOutput = dom.emit(docType, { singleLineJsDocComments: true }).trim();
-    typesOutput.push(docTypeOutput);
-  }
-  return reformatOutput(typesOutput.join("\n\n"));
-}
-function reformatOutput(input) {
-  const lines = input.split("\n");
-  const results = [];
-  for (const line of lines) {
-    const convertedLine = line.replace(/ {4}/g, "  ").replaceAll('"', "'");
-    results.push(convertedLine);
-  }
-  return results.join("\n");
-}
 function alphanumeric(input) {
   return input.replace(/[^a-zA-Z0-9]/g, "");
 }
-var __dirname, TEMPLATE;
+var __dirname, TEMPLATE, DtsFormatter;
 var init_generate_types = __esm({
   "cli/generate-types.ts"() {
     "use strict";
     __dirname = path2.dirname(fileURLToPath(import.meta.url));
-    TEMPLATE = `/** Root.js CMS types. This file is autogenerated. */
+    TEMPLATE = `/* eslint-disable */
+/** Root.js CMS types. This file is autogenerated. */
 
 export interface RootCMSFile {
   src: string;
@@ -215,6 +168,8 @@ export type RootCMSImage = RootCMSFile;
 
 export type RootCMSOneOf<T = any> = T;
 
+export type RootCMSOneOfOption<T, Base> = Base & {_type: T};
+
 export interface RootCMSRichTextBlock {
   type: string;
   data: any;
@@ -255,6 +210,99 @@ export interface RootCMSDoc<Fields extends {}> {
   /** User-entered field values from the CMS. */
   fields?: Fields;
 }`;
+    DtsFormatter = class {
+      constructor() {
+        /**
+         * Field types defined in either `.schema.ts` files or used by `oneOf()`
+         * fields.
+         */
+        this.fieldsTypes = {};
+        /**
+         * For `collections/*.schema.ts` files, output a corresponding "RootCMSDoc"
+         * type. For example, `collections/BlogPosts.schema.ts` would output a type
+         * called `BlogPostsDoc`.
+         */
+        this.docTypes = {};
+      }
+      /** Adds the types for a `.schema.ts` file to the `.d.ts` file. */
+      addSchemaFile(fileId, schema) {
+        const jsdoc = `Generated from \`${fileId}\`.`;
+        const typeId = alphanumeric(path2.parse(fileId).name.split(".")[0]);
+        const oneOfTypes = {};
+        const fieldsTypeId = `${typeId}Fields`;
+        const fieldsType = dom.create.interface(
+          fieldsTypeId,
+          dom.DeclarationFlags.Export
+        );
+        fieldsType.jsDocComment = jsdoc;
+        for (const field of schema.fields) {
+          if (!field.id) {
+            continue;
+          }
+          fieldsType.members.push(fieldProperty(field, { typeId, oneOfTypes }));
+        }
+        for (const oneOfTypeId in oneOfTypes) {
+          if (!this.fieldsTypes[fieldsTypeId]) {
+            this.fieldsTypes[oneOfTypeId] = oneOfTypes[oneOfTypeId];
+          }
+        }
+        this.fieldsTypes[fieldsTypeId] = fieldsType;
+        if (fileId.startsWith("/collections/")) {
+          const docTypeId = `${typeId}Doc`;
+          const baseType = dom.create.namedTypeReference("RootCMSDoc");
+          baseType.typeArguments.push(dom.create.namedTypeReference(fieldsTypeId));
+          const docType = dom.create.alias(
+            docTypeId,
+            baseType,
+            dom.DeclarationFlags.Export
+          );
+          docType.jsDocComment = jsdoc;
+          this.docTypes[docTypeId] = docType;
+        }
+      }
+      /** Generates the `.d.ts` output as a string. */
+      toString() {
+        const results = [TEMPLATE];
+        const sortedFieldsTypes = Object.keys(this.fieldsTypes).sort();
+        for (const fieldsTypeId of sortedFieldsTypes) {
+          const fieldsType = this.fieldsTypes[fieldsTypeId];
+          results.push(this.typeToString(fieldsType));
+          const docTypeId = this.fieldsTypeToDocType(fieldsTypeId);
+          const docType = this.docTypes[docTypeId];
+          if (docType) {
+            results.push(this.typeToString(docType));
+          }
+        }
+        const output = results.join("\n\n").replaceAll("/**  ", "/** ").replaceAll("  */", " */").replace(/\r\n|\r|\n/g, "\n") + "\n";
+        return output;
+      }
+      /**
+       * Converts "<Name>Fields" to "<Name>Doc".
+       */
+      fieldsTypeToDocType(fieldsTypeId) {
+        if (!fieldsTypeId.endsWith("Fields")) {
+          throw new Error(`"${fieldsTypeId}" should be suffixed with "Fields"`);
+        }
+        const name = fieldsTypeId.slice(0, -6);
+        return `${name}Doc`;
+      }
+      typeToString(type2) {
+        return this.reformatOutput(dom.emit(type2, { singleLineJsDocComments: true }));
+      }
+      /**
+       * Formats the output to Google style conventions, e.g. 2-space indents and
+       * single quote strings.
+       */
+      reformatOutput(input) {
+        const lines = input.trim().split("\n");
+        const results = [];
+        for (const line of lines) {
+          const convertedLine = line.replace(/ {4}/g, "  ").replaceAll('"', "'");
+          results.push(convertedLine);
+        }
+        return results.join("\n");
+      }
+    };
   }
 });
 
@@ -1298,7 +1346,31 @@ function csvToArray(csvString) {
 }
 
 // core/api.ts
-function api(server) {
+function api(server, options) {
+  server.use("/cms/api/collection.get", 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;
+    }
+    const reqBody = req.body || {};
+    if (!reqBody.collectionId) {
+      res.status(400).json({ success: false, error: "MISSING_COLLECTION_ID" });
+      return;
+    }
+    try {
+      const app = await options.getRenderer(req);
+      const collections = app.getCollections();
+      const collection = collections[reqBody.collectionId];
+      if (!collection) {
+        res.status(404).json({ success: false, error: "NOT_FOUND" });
+        return;
+      }
+      res.status(200).json({ success: true, data: collection });
+    } catch (err) {
+      console.error(err.stack || err);
+      res.status(500).json({ success: false, error: "UNKNOWN" });
+    }
+  });
   server.use("/cms/api/cron.run", async (req, res) => {
     try {
       await runCronJobs(req.rootConfig);
@@ -1752,7 +1824,7 @@ function cmsPlugin(options) {
       });
       const staticDir = path3.resolve(__dirname2, "ui");
       server.use("/cms/static", sirv(staticDir, { dev: false }));
-      api(server);
+      api(server, { getRenderer });
       server.use("/cms", async (req, res) => {
         try {
           if (!req.user) {

package/dist/project.js

@@ -1,11 +1,12 @@
 // core/project.ts
+var IGNORED_SCHEMA_FOLDERS = ["/appengine/", "/functions/", "/gae/"];
 var SCHEMA_MODULES = import.meta.glob("/**/*.schema.ts", {
   eager: true
 });
 function getProjectSchemas() {
   const schemas = {};
   for (const fileId in SCHEMA_MODULES) {
-    if (fileId.startsWith("/functions/")) {
+    if (IGNORED_SCHEMA_FOLDERS.some((prefix) => fileId.startsWith(prefix))) {
       continue;
     }
     const schemaModule = SCHEMA_MODULES[fileId];