@riverbankcms/sdk 0.4.1 → 0.4.2

package/README.md

@@ -1987,6 +1987,46 @@ contentTypes: [
 ]
 ```
 
+### Singleton Content Types
+
+Singleton content types can only have one entry. Use them for unique content like homepage settings, site-wide configuration, or structured content that shouldn't be duplicated:
+
+```typescript
+contentTypes: [
+  {
+    key: 'homepage',
+    name: 'Homepage',
+    isSingleton: true,          // Only one entry allowed
+    hasPages: true,
+    routePattern: '/',          // Fixed path (no {slug} needed)
+    fields: [
+      { id: 'heroTitle', type: 'text', label: 'Hero Title', required: true, multiline: false },
+      { id: 'heroSubtitle', type: 'text', label: 'Hero Subtitle', required: false, multiline: false },
+      { id: 'heroImage', type: 'media', label: 'Hero Image', mediaKinds: ['image'] },
+    ],
+    titleField: 'heroTitle',
+  },
+  {
+    key: 'site-settings',
+    name: 'Site Settings',
+    isSingleton: true,
+    hasPages: false,            // Not routable
+    fields: [
+      { id: 'contactEmail', type: 'text', label: 'Contact Email', required: false, multiline: false },
+      { id: 'footerText', type: 'richText', label: 'Footer Text', required: false },
+    ],
+    titleField: 'contactEmail',
+  },
+]
+```
+
+**Singleton behavior:**
+
+- When the content type is created, an entry is automatically created
+- Attempting to create additional entries returns a 409 Conflict error
+- The entry can be deleted and will reappear when recreated
+- Routable singletons use a fixed path instead of `{slug}` pattern
+
 ### Pages
 
 Define pages with optional initial blocks:
@@ -2133,6 +2173,39 @@ import {
 } from '@riverbankcms/sdk/config';
 ```
 
+## CLI
+
+The SDK includes a CLI for syncing your local config to the dashboard.
+
+### push-config
+
+Push content types, custom blocks, and block field extensions to your CMS dashboard:
+
+```bash
+npx riverbankcms push-config --api-key <key> --dashboard <url>
+```
+
+**Options:**
+
+| Option | Description |
+|--------|-------------|
+| `--api-key <key>` | Dashboard API key (required) |
+| `--dashboard <url>` | Dashboard URL, or set `NEXT_PUBLIC_DASHBOARD_URL` env var |
+| `--config <path>` | Path to config file (default: `./riverbank.config.ts`) |
+
+**Example:**
+
+```bash
+# Using environment variables
+export NEXT_PUBLIC_DASHBOARD_URL=https://www.riverbankcms.com
+npx riverbankcms push-config --api-key $RIVERBANK_API_KEY
+
+# Or inline
+npx riverbankcms push-config \
+  --api-key abc123 \
+  --dashboard https://www.riverbankcms.com
+```
+
 ## Additional Exports
 
 - `@riverbankcms/sdk/rendering` - Low-level rendering components

package/dist/cli/index.js

@@ -4884,15 +4884,23 @@ var contentTypeConfigSchema = zod.z.object({
   routePattern: zod.z.string().optional(),
   // Fields are validated as any[] here - deep field validation happens in @riverbankcms/blocks
   fields: zod.z.array(zod.z.any()).min(1, "At least one field is required"),
-  titleField: zod.z.string().optional()
+  titleField: zod.z.string().optional(),
+  isSingleton: zod.z.boolean().optional().default(false)
 }).refine(
   (data) => {
     if (data.hasPages) {
-      return data.routePattern && data.routePattern.includes("{slug}");
+      if (!data.routePattern) {
+        return false;
+      }
+      if (!data.isSingleton && !data.routePattern.includes("{slug}")) {
+        return false;
+      }
     }
     return true;
   },
-  { message: "routePattern with {slug} is required when hasPages is true" }
+  {
+    message: "routePattern is required when hasPages is true. Non-singleton types must include {slug} placeholder."
+  }
 ).refine(
   (data) => {
     if (!data.hasPages && data.routePattern) {
@@ -5044,6 +5052,21 @@ var contentConfigSchema = contentConfigBaseSchema.superRefine((data, ctx) => {
       });
     }
   }
+  if (data.contentTypes && data.entries) {
+    const singletonKeys = new Set(
+      data.contentTypes.filter((ct) => ct.isSingleton).map((ct) => ct.key)
+    );
+    for (const singletonKey of singletonKeys) {
+      const entriesForType = data.entries.filter((e) => e.contentType === singletonKey);
+      if (entriesForType.length > 1) {
+        ctx.addIssue({
+          code: zod.z.ZodIssueCode.custom,
+          message: `Singleton content type "${singletonKey}" cannot have more than one entry. Found ${entriesForType.length} entries.`,
+          path: ["entries"]
+        });
+      }
+    }
+  }
 });
 
 // src/data/prefetchBlockData.ts
@@ -5351,7 +5374,19 @@ function resolveDashboardUrl(cliOption) {
   }
   return url;
 }
-var pushConfigCommand = new commander.Command("push-config").description("Push SDK config from riverbank.config.ts to dashboard").requiredOption("--api-key <key>", "Dashboard API key").option("--config <path>", "Path to riverbank.config.ts (default: ./riverbank.config.ts)").option("--dashboard <url>", "Dashboard API URL (or set NEXT_PUBLIC_DASHBOARD_URL)").action((options) => {
+var pushConfigCommand = new commander.Command("push-config").description("Push SDK config to dashboard").requiredOption("--api-key <key>", "Dashboard API key (required)").option("--dashboard <url>", "Dashboard URL (or set NEXT_PUBLIC_DASHBOARD_URL env var)").option("--config <path>", "Path to config file (default: ./riverbank.config.ts)").addHelpText("after", `
+Description:
+  Syncs your local riverbank.config.ts to the CMS dashboard, including:
+  - Custom blocks
+  - Block field extensions
+  - Block field options
+  - Content types, pages, entries, and navigation
+
+Examples:
+  $ npx riverbankcms push-config --api-key $RIVERBANK_API_KEY
+  $ npx riverbankcms push-config --api-key abc123 --dashboard https://www.riverbankcms.com
+  $ npx riverbankcms push-config --api-key $API_KEY --config ./src/riverbank.config.ts
+`).action((options) => {
   const dashboard = resolveDashboardUrl(options.dashboard);
   return pushConfigAction({ ...options, dashboard });
 });
@@ -5360,7 +5395,13 @@ var pushConfigCommand = new commander.Command("push-config").description("Push S
 dotenv.config({ path: ".env.local" });
 dotenv.config({ path: ".env" });
 var program = new commander.Command();
-program.name("riverbankcms").description("Builder SDK CLI tools").version("0.1.0");
+program.name("riverbankcms").description("Riverbank CMS SDK CLI - sync config to dashboard").version("0.1.0").addHelpText("after", `
+Examples:
+  $ npx riverbankcms push-config --api-key $RIVERBANK_API_KEY
+  $ npx riverbankcms push-config --api-key abc123 --dashboard https://www.riverbankcms.com
+
+Run 'riverbankcms <command> --help' for detailed options.
+`);
 program.addCommand(pushConfigCommand);
 program.parse();
 //# sourceMappingURL=index.js.map