@blinkk/root-cms 2.0.10 → 2.1.2-alpha.0

package/dist/plugin.js

@@ -51,21 +51,21 @@ __export(generate_types_exports, {
   generateSchemaDts: () => generateSchemaDts,
   generateTypes: () => generateTypes
 });
-import { promises as fs2 } from "node:fs";
-import path3 from "node:path";
-import { fileURLToPath } from "node:url";
+import { promises as fs3 } from "fs";
+import path4 from "path";
+import { fileURLToPath } from "url";
 import { loadRootConfig, viteSsrLoadModule } from "@blinkk/root/node";
 import * as dom from "dts-dom";
 async function generateTypes() {
   const rootDir = process.cwd();
   const rootConfig = await loadRootConfig(rootDir, { command: "root-cms" });
-  const modulePath = path3.resolve(__dirname, "./project.js");
+  const modulePath = path4.resolve(__dirname, "./project.js");
   const project = await viteSsrLoadModule(
     rootConfig,
     modulePath
   );
-  const schemas = project.getProjectSchemas();
-  const outputPath = path3.resolve(rootDir, "root-cms.d.ts");
+  const schemas = await project.getProjectSchemas();
+  const outputPath = path4.resolve(rootDir, "root-cms.d.ts");
   await generateSchemaDts(outputPath, schemas);
   console.log("saved root-cms.d.ts!");
 }
@@ -76,7 +76,7 @@ async function generateSchemaDts(outputPath, schemas) {
     dtsFormatter.addSchemaFile(fileId, schema);
   }
   const output = dtsFormatter.toString();
-  await fs2.writeFile(outputPath, output, "utf-8");
+  await fs3.writeFile(outputPath, output, "utf-8");
 }
 function fieldProperty(field, options) {
   const prop = dom.create.property(
@@ -129,12 +129,19 @@ function fieldType(field, options) {
     if (field.types && Array.isArray(field.types)) {
       const unionTypes = [];
       field.types.forEach((schema) => {
-        if (!schema.name) {
+        let typeName;
+        if (typeof schema === "string") {
+          typeName = schema;
           return;
+        } else {
+          typeName = schema.name;
         }
-        const cleanName = alphanumeric(schema.name);
+        if (!typeName) {
+          return;
+        }
+        const cleanName = alphanumeric(typeName);
         const oneOfTypeId = `${cleanName}Fields`;
-        if (!options.oneOfTypes[oneOfTypeId]) {
+        if (typeof schema === "object" && !options.oneOfTypes[oneOfTypeId]) {
           const oneOfTypeInterface = dom.create.interface(
             oneOfTypeId,
             dom.DeclarationFlags.Export
@@ -150,7 +157,7 @@ function fieldType(field, options) {
         }
         const oneOfOption = dom.create.namedTypeReference("RootCMSOneOfOption");
         oneOfOption.typeArguments = [
-          dom.type.stringLiteral(schema.name),
+          dom.type.stringLiteral(typeName),
           dom.create.namedTypeReference(oneOfTypeId)
         ];
         unionTypes.push(oneOfOption);
@@ -165,6 +172,10 @@ function fieldType(field, options) {
     const referenceType = dom.create.namedTypeReference("RootCMSReference");
     return referenceType;
   }
+  if (field.type === "references") {
+    const referenceType = dom.create.namedTypeReference("RootCMSReference");
+    return dom.type.array(referenceType);
+  }
   if (field.type === "richtext") {
     const richtextType = dom.create.namedTypeReference("RootCMSRichText");
     return richtextType;
@@ -190,7 +201,7 @@ var __dirname, TEMPLATE, DtsFormatter;
 var init_generate_types = __esm({
   "cli/generate-types.ts"() {
     "use strict";
-    __dirname = path3.dirname(fileURLToPath(import.meta.url));
+    __dirname = path4.dirname(fileURLToPath(import.meta.url));
     TEMPLATE = `/* eslint-disable */
 /** Root.js CMS types. This file is autogenerated. */
 
@@ -264,7 +275,7 @@ export interface RootCMSDoc<Fields extends {}> {
       /** Adds the types for a `.schema.ts` file to the `.d.ts` file. */
       addSchemaFile(fileId, schema) {
         const jsdoc = `Generated from \`${fileId}\`.`;
-        const typeId = alphanumeric(path3.parse(fileId).name.split(".")[0]);
+        const typeId = alphanumeric(path4.parse(fileId).name.split(".")[0]);
         const oneOfTypes = {};
         const fieldsTypeId = `${typeId}Fields`;
         const fieldsType = dom.create.interface(
@@ -344,9 +355,10 @@ export interface RootCMSDoc<Fields extends {}> {
 });
 
 // core/plugin.ts
-import { promises as fs3 } from "node:fs";
-import path4 from "node:path";
-import { fileURLToPath as fileURLToPath2 } from "node:url";
+import { promises as fs4 } from "fs";
+import path5 from "path";
+import { fileURLToPath as fileURLToPath2 } from "url";
+import { viteSsrLoadModule as viteSsrLoadModule2 } from "@blinkk/root/node";
 import bodyParser from "body-parser";
 import {
   applicationDefault,
@@ -359,12 +371,14 @@ import * as jsonwebtoken from "jsonwebtoken";
 import sirv from "sirv";
 
 // core/api.ts
+import { promises as fs2 } from "fs";
+import path3 from "path";
 import { multipartMiddleware } from "@blinkk/root/middleware";
 
 // core/ai.ts
-import crypto from "node:crypto";
-import fs from "node:fs";
-import path from "node:path";
+import crypto from "crypto";
+import fs from "fs";
+import path from "path";
 import { vertexAI } from "@genkit-ai/vertexai";
 import { Timestamp } from "firebase-admin/firestore";
 import { genkit } from "genkit";
@@ -548,7 +562,7 @@ var ChatClient = class {
 };
 
 // core/client.ts
-import crypto2 from "node:crypto";
+import crypto2 from "crypto";
 import {
   FieldValue as FieldValue2,
   Timestamp as Timestamp3
@@ -2045,7 +2059,7 @@ var BatchResponse = class {
 };
 
 // core/versions.ts
-import path2 from "node:path";
+import path2 from "path";
 import { Timestamp as Timestamp4 } from "firebase-admin/firestore";
 import glob from "tiny-glob";
 var DOCUMENT_SAVE_OFFSET = 5 * 60 * 1e3;
@@ -2192,21 +2206,48 @@ function csvToArray(csvString) {
 }
 
 // core/api.ts
+function testValidCollectionId(id) {
+  return /^[A-Za-z0-9_-]+$/.test(id);
+}
 function api(server, options) {
+  async function getCollectionSchema(req, collectionId) {
+    if (req.viteServer) {
+      const app = await options.getRenderer(req);
+      return await app.getCollection(collectionId);
+    }
+    try {
+      const schemaPath = path3.join(
+        req.rootConfig.rootDir,
+        "dist",
+        "collections",
+        `${collectionId}.schema.json`
+      );
+      const contents = await fs2.readFile(schemaPath, "utf8");
+      return JSON.parse(contents);
+    } catch (err) {
+      if (err && err.code === "ENOENT") {
+        return null;
+      }
+      throw err;
+    }
+  }
   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) {
+    const collectionId = String(reqBody.collectionId || "");
+    if (!collectionId) {
       res.status(400).json({ success: false, error: "MISSING_COLLECTION_ID" });
       return;
     }
+    if (!testValidCollectionId(collectionId)) {
+      res.status(400).json({ success: false, error: "INVALID_COLLECTION_ID" });
+      return;
+    }
     try {
-      const app = await options.getRenderer(req);
-      const collections = app.getCollections();
-      const collection = collections[reqBody.collectionId];
+      const collection = await getCollectionSchema(req, collectionId);
       if (!collection) {
         res.status(404).json({ success: false, error: "NOT_FOUND" });
         return;
@@ -2373,7 +2414,31 @@ function api(server, options) {
 }
 
 // core/plugin.ts
-var __dirname2 = path4.dirname(fileURLToPath2(import.meta.url));
+var __dirname2 = path5.dirname(fileURLToPath2(import.meta.url));
+async function writeCollectionSchemasToJson(rootConfig) {
+  const modulePath = path5.resolve(__dirname2, "./project.js");
+  const project = await viteSsrLoadModule2(
+    rootConfig,
+    modulePath
+  );
+  const outDir = path5.join(rootConfig.rootDir, "dist", "collections");
+  await fs4.mkdir(outDir, { recursive: true });
+  const fileIds = Object.keys(project.SCHEMA_MODULES);
+  for (const fileId of fileIds) {
+    if (!fileId.startsWith("/collections/")) {
+      continue;
+    }
+    const collectionId = path5.basename(fileId).split(".")[0];
+    const schema = await project.getCollectionSchema(collectionId);
+    if (!schema) {
+      console.warn(`collection is missing a default export: ${fileId}`);
+      continue;
+    }
+    const jsonPath = path5.join(outDir, `${collectionId}.schema.json`);
+    const data = JSON.stringify(schema, null, 2);
+    await fs4.writeFile(jsonPath, data, "utf-8");
+  }
+}
 var SESSION_COOKIE_AUTH = "root-cms-auth";
 var NONCONF_STATIC_PATHS = [
   "/cms/static/signin.css",
@@ -2574,12 +2639,23 @@ function cmsPlugin(options) {
       const databaseId = firebaseConfig.databaseId || "(default)";
       return getFirestore(app, databaseId);
     },
+    hooks: {
+      /**
+       * Saves collection schema files from `collections/*.schema.ts` to
+       * `dist/collections/*.schema.json` for prod builds.
+       */
+      preBuild: async (rootConfig) => {
+        await writeCollectionSchemasToJson(rootConfig);
+      }
+    },
     /**
      * A map of ssr files to include when running `root build`.
      */
-    ssrInput: () => ({
-      cms: path4.resolve(__dirname2, "./app.js")
-    }),
+    ssrInput: () => {
+      return {
+        cms: path5.resolve(__dirname2, "./app.js")
+      };
+    },
     /**
      * Attaches CMS-specific middleware to the Root.js server.
      */
@@ -2587,13 +2663,13 @@ function cmsPlugin(options) {
       server.use(bodyParser.json());
       async function getRenderer(req) {
         if (serverOptions.type === "dev") {
-          const appFilePath = path4.resolve(__dirname2, "./app.js");
+          const appFilePath = path5.resolve(__dirname2, "./app.js");
           const app3 = await req.viteServer.ssrLoadModule(
             appFilePath
           );
           return app3;
         }
-        const appImportPath = path4.resolve(
+        const appImportPath = path5.resolve(
           req.rootConfig.rootDir,
           "dist/server/cms.js"
         );
@@ -2665,7 +2741,7 @@ function cmsPlugin(options) {
         }
         next();
       });
-      const staticDir = path4.resolve(__dirname2, "ui");
+      const staticDir = path5.resolve(__dirname2, "ui");
       server.use("/cms/static", sirv(staticDir, { dev: false }));
       api(server, { getRenderer });
       server.use("/cms", async (req, res) => {
@@ -2699,7 +2775,7 @@ function cmsPlugin(options) {
   return plugin;
 }
 function fileExists(filepath) {
-  return fs3.access(filepath).then(() => true).catch(() => false);
+  return fs4.access(filepath).then(() => true).catch(() => false);
 }
 export {
   cmsPlugin

package/dist/project.d.ts

@@ -1,5 +1,4 @@
-import { S as Schema } from './schema-KpQGOA1Z.js';
-import 'preact';
+import { S as Schema, C as Collection } from './schema-FB6Ck9sN.js';
 
 /**
  * Loads various files or configurations from the project.
@@ -11,6 +10,17 @@ import 'preact';
 interface SchemaModule {
     default: Schema;
 }
-declare function getProjectSchemas(): Record<string, Schema>;
+declare const SCHEMA_MODULES: Record<string, SchemaModule>;
+/**
+ * Returns a map of all `schema.ts` files defined in the project as
+ * fileId => schema. This is used by `generate-types.ts` to build the
+ * `root-cms.d.ts` file.
+ */
+declare function getProjectSchemas(): Promise<Record<string, Schema>>;
+/**
+ * Returns a collection's schema definition as defined in
+ * `/collections/<id>.schema.ts`.
+ */
+declare function getCollectionSchema(collectionId: string): Promise<Collection | null>;
 
-export { type SchemaModule, getProjectSchemas };
+export { SCHEMA_MODULES, type SchemaModule, getCollectionSchema, getProjectSchemas };

package/dist/project.js

@@ -1,14 +1,16 @@
 // core/project.ts
-var IGNORED_SCHEMA_FOLDERS = ["/appengine/", "/functions/", "/gae/"];
-var SCHEMA_MODULES = import.meta.glob("/**/*.schema.ts", {
-  eager: true
-});
-function getProjectSchemas() {
+var SCHEMA_MODULES = import.meta.glob(
+  [
+    "/**/*.schema.ts",
+    "!/appengine/**/*.schema.ts",
+    "!/functions/**/*.schema.ts",
+    "!/gae/**/*.schema.ts"
+  ],
+  { eager: true }
+);
+async 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;
@@ -16,6 +18,64 @@ function getProjectSchemas() {
   }
   return schemas;
 }
+async function getCollectionSchema(collectionId) {
+  if (!testValidCollectionId(collectionId)) {
+    throw new Error(`invalid collection id: ${collectionId}`);
+  }
+  const fileId = `/collections/${collectionId}.schema.ts`;
+  const module = SCHEMA_MODULES[fileId];
+  if (!module.default) {
+    console.warn(`collection schema not exported in: ${fileId}`);
+    return null;
+  }
+  const collection = module.default;
+  collection.id = collectionId;
+  return convertOneOfTypes(collection);
+}
+function testValidCollectionId(id) {
+  return /^[A-Za-z0-9_-]+$/.test(id);
+}
+function convertOneOfTypes(collection) {
+  const clone = structuredClone(collection);
+  const types = clone.types || {};
+  function handleOneOfField(field) {
+    const names = [];
+    (field.types || []).forEach((sub) => {
+      if (typeof sub === "string") {
+        names.push(sub);
+        return;
+      }
+      if (sub.name) {
+        names.push(sub.name);
+        if (!types[sub.name]) {
+          types[sub.name] = sub;
+          if (sub.fields) {
+            walk(sub);
+          }
+        }
+      }
+    });
+    field.types = names;
+  }
+  function handleField(field) {
+    if (field.type === "oneof") {
+      handleOneOfField(field);
+    } else if (field.type === "object") {
+      walk(field);
+    } else if (field.type === "array" && field.of) {
+      handleField(field.of);
+    }
+  }
+  function walk(schema) {
+    const fields = schema?.fields || [];
+    fields.forEach(handleField);
+  }
+  walk(clone);
+  clone.types = types;
+  return clone;
+}
 export {
+  SCHEMA_MODULES,
+  getCollectionSchema,
   getProjectSchemas
 };

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

@@ -1,5 +1,3 @@
-import { FunctionalComponent } from 'preact';
-
 interface CommonFieldProps {
     /** The type that defines the structure of the field and its UI component. */
     type: string;
@@ -140,7 +138,7 @@ type ArrayField = CommonFieldProps & {
 declare function array(field: Omit<ArrayField, 'type'>): ArrayField;
 type OneOfField = CommonFieldProps & {
     type: 'oneof';
-    types: Schema[];
+    types: Schema[] | string[];
 };
 declare function oneOf(field: Omit<OneOfField, 'type'>): OneOfField;
 type RichTextField = CommonFieldProps & {
@@ -159,7 +157,17 @@ type ReferenceField = CommonFieldProps & {
     buttonLabel?: string;
 };
 declare function reference(field: Omit<ReferenceField, 'type'>): ReferenceField;
-type Field = StringField | NumberField | DateField | DateTimeField | BooleanField | SelectField | MultiSelectField | ImageField | FileField | ObjectField | ArrayField | OneOfField | RichTextField | ReferenceField;
+type ReferencesField = CommonFieldProps & {
+    type: 'references';
+    /** List of collection ids the references can be chosen from. */
+    collections?: string[];
+    /** Initial collection to show when picking a reference. */
+    initialCollection?: string;
+    /** Label for the button. Defaults to "Select". */
+    buttonLabel?: string;
+};
+declare function references(field: Omit<ReferencesField, 'type'>): ReferencesField;
+type Field = StringField | NumberField | DateField | DateTimeField | BooleanField | SelectField | MultiSelectField | ImageField | FileField | ObjectField | ArrayField | OneOfField | RichTextField | ReferenceField | ReferencesField;
 /**
  * Similar to {@link Field} but with a required `id`.
  * TODO(stevenle): fix this.
@@ -198,10 +206,14 @@ interface Schema {
         image?: string | string[];
     };
 }
+type SchemaWithTypes = Schema & {
+    /** Reusable type definitions used by the schema, e.g. for oneOf() fields. */
+    types?: Record<string, Schema>;
+};
 declare function defineSchema(schema: Schema): Schema;
 /** Defines the schema for a collection or reusable component. */
 declare const define: typeof defineSchema;
-type Collection = Schema & {
+type Collection = SchemaWithTypes & {
     /**
      * The ID of the collection. This comes from the schema filename, e.g
      * `<id>.schema.ts`.
@@ -222,8 +234,6 @@ type Collection = Schema & {
      * editor to render instant previews. If blank, defaults to the `url` config.
      */
     previewUrl?: string;
-    /** Page component to render the collection for instant previews */
-    Component?: FunctionalComponent;
     /**
      * Defines the fields to use for document preview. Defaults to "title" and
      * "image". Use dot notation for nested fields, e.g. "meta.title".
@@ -249,6 +259,23 @@ type Collection = Schema & {
     autolock?: boolean;
     /** Reason for the automatic publishing lock. */
     autolockReason?: string;
+    /**
+     * Custom sort options available when listing documents in the CMS.
+     *
+     * NOTE: a new DB index may need to be created for the sort option. The first
+     * time using the sort option, you will get an error that provides a link for
+     * creating the index.
+     */
+    sortOptions?: Array<{
+        /** Unique identifier for the sort option. */
+        id: string;
+        /** Label displayed in the CMS UI. */
+        label: string;
+        /** DB field path to sort by, e.g. 'fields.meta.title'. */
+        field: string;
+        /** Sort direction. Defaults to ascending. */
+        direction?: 'asc' | 'desc';
+    }>;
 };
 declare function defineCollection(collection: Omit<Collection, 'id'>): Omit<Collection, 'id'>;
 declare const collection: typeof defineCollection;
@@ -269,8 +296,10 @@ type schema_ObjectField = ObjectField;
 type schema_ObjectLikeField = ObjectLikeField;
 type schema_OneOfField = OneOfField;
 type schema_ReferenceField = ReferenceField;
+type schema_ReferencesField = ReferencesField;
 type schema_RichTextField = RichTextField;
 type schema_Schema = Schema;
+type schema_SchemaWithTypes = SchemaWithTypes;
 type schema_SelectField = SelectField;
 type schema_StringField = StringField;
 declare const schema_array: typeof array;
@@ -288,11 +317,12 @@ declare const schema_number: typeof number;
 declare const schema_object: typeof object;
 declare const schema_oneOf: typeof oneOf;
 declare const schema_reference: typeof reference;
+declare const schema_references: typeof references;
 declare const schema_richtext: typeof richtext;
 declare const schema_select: typeof select;
 declare const schema_string: typeof string;
 declare namespace schema {
-  export { type schema_ArrayField as ArrayField, type schema_BooleanField as BooleanField, type schema_Collection as Collection, type schema_CommonFieldProps as CommonFieldProps, type schema_DateField as DateField, type schema_DateTimeField as DateTimeField, type schema_Field as Field, type schema_FieldWithId as FieldWithId, type schema_FileField as FileField, type schema_ImageField as ImageField, type schema_MultiSelectField as MultiSelectField, type schema_NumberField as NumberField, type schema_ObjectField as ObjectField, type schema_ObjectLikeField as ObjectLikeField, type schema_OneOfField as OneOfField, type schema_ReferenceField as ReferenceField, type schema_RichTextField as RichTextField, type schema_Schema as Schema, type schema_SelectField as SelectField, type schema_StringField as StringField, schema_array as array, schema_boolean as boolean, schema_collection as collection, schema_date as date, schema_datetime as datetime, schema_define as define, schema_defineCollection as defineCollection, schema_defineSchema as defineSchema, schema_file as file, schema_image as image, schema_multiselect as multiselect, schema_number as number, schema_object as object, schema_oneOf as oneOf, schema_reference as reference, schema_richtext as richtext, schema_select as select, schema_string as string };
+  export { type schema_ArrayField as ArrayField, type schema_BooleanField as BooleanField, type schema_Collection as Collection, type schema_CommonFieldProps as CommonFieldProps, type schema_DateField as DateField, type schema_DateTimeField as DateTimeField, type schema_Field as Field, type schema_FieldWithId as FieldWithId, type schema_FileField as FileField, type schema_ImageField as ImageField, type schema_MultiSelectField as MultiSelectField, type schema_NumberField as NumberField, type schema_ObjectField as ObjectField, type schema_ObjectLikeField as ObjectLikeField, type schema_OneOfField as OneOfField, type schema_ReferenceField as ReferenceField, type schema_ReferencesField as ReferencesField, type schema_RichTextField as RichTextField, type schema_Schema as Schema, type schema_SchemaWithTypes as SchemaWithTypes, type schema_SelectField as SelectField, type schema_StringField as StringField, schema_array as array, schema_boolean as boolean, schema_collection as collection, schema_date as date, schema_datetime as datetime, schema_define as define, schema_defineCollection as defineCollection, schema_defineSchema as defineSchema, schema_file as file, schema_image as image, schema_multiselect as multiselect, schema_number as number, schema_object as object, schema_oneOf as oneOf, schema_reference as reference, schema_references as references, schema_richtext as richtext, schema_select as select, schema_string as string };
 }
 
-export { type Schema as S, schema as s };
+export { type Collection as C, type Schema as S, schema as s };