@backmatter/core 0.0.12 → 0.0.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backmatter/core",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "Experimental Backmatter SDK. APIs will break. Not ready for production.",
   "type": "module",
   "publishConfig": {

package/src/block.ts

@@ -94,9 +94,8 @@ export function parseBlockSnapshot(input: unknown): BlockSnapshot {
   for (const [name, fieldRaw] of Object.entries(value.fields as Record<string, unknown>)) {
     try {
       fields[name] = parseFieldSnapshot(fieldRaw);
-    } catch (err) {
-      const msg = err instanceof Error ? err.message : "invalid field";
-      throw new Error(`block.fields.${name}: ${msg}`);
+    } catch {
+      // Drop unknown kinds so a stored snapshot still loads.
     }
   }
   return { name: value.name, fields };

package/src/fields.ts

@@ -2,7 +2,6 @@
 
 export type FieldKind =
   | "text"
-  | "slug"
   | "locale"
   | "image"
   | "relation"
@@ -46,7 +45,6 @@ function base<K extends FieldKind, R extends boolean, To extends string>(
 
 export const field = {
   text: <const R extends boolean = false>(opts?: Opts<R>) => base("text", opts),
-  slug: <const R extends boolean = false>(opts?: Opts<R>) => base("slug", opts),
   locale: <const R extends boolean = false>(opts?: Opts<R>) => base("locale", opts),
   image: <const R extends boolean = false>(opts?: Opts<R>) => base("image", opts),
   number: <const R extends boolean = false>(opts?: Opts<R>) => base("number", opts),
@@ -72,7 +70,6 @@ export function parseFieldSnapshot(input: unknown): FieldSnapshot {
   const kind = value.kind;
   const allowed: FieldKind[] = [
     "text",
-    "slug",
     "locale",
     "image",
     "relation",

package/src/model.ts

@@ -194,9 +194,8 @@ export function parseSchemaSnapshot(input: unknown): SchemaSnapshot {
     )) {
       try {
         fields[name] = parseFieldSnapshot(fieldRaw);
-      } catch (err) {
-        const msg = err instanceof Error ? err.message : "invalid field";
-        throw new Error(`schema.models[${i}].fields.${name}: ${msg}`);
+      } catch {
+        // Drop unknown kinds (e.g. leftover slug) so a stored snapshot still loads.
       }
     }
     const snapshot: ModelSnapshot = { type: m.type, path: m.path, fields };

package/src/node/create-backmatter.ts

@@ -22,6 +22,11 @@ export type CreateBackmatterOptions<Models extends readonly ModelDef[] = readonl
      * `@backmatter/next` turns this on.
      */
     taggedApiFetch?: boolean;
+    /**
+     * When false, skip the boot-time schema PUT. Query clients (catch-all,
+     * revalidate) set this; `.backmatter/sync` leaves the default.
+     */
+    sync?: boolean;
   };
 
 export type BackmatterClient<Models extends readonly ModelDef[] = readonly ModelDef[]> = {
@@ -59,7 +64,7 @@ function toSnapshots(models: readonly ModelDef[]): ModelSnapshot[] {
 export function createBackmatter<const Models extends readonly ModelDef[]>(
   options: CreateBackmatterOptions<Models>,
 ): BackmatterClient<Models> {
-  const { models: modelDefs, blocks: blockDefs, taggedApiFetch, ...rest } = options;
+  const { models: modelDefs, blocks: blockDefs, taggedApiFetch, sync = true, ...rest } = options;
   const config = resolveConfig(rest);
   const models = toSnapshots(modelDefs);
   const siteRoot = config.siteRoot ?? process.cwd();
@@ -73,7 +78,7 @@ export function createBackmatter<const Models extends readonly ModelDef[]>(
   }
 
   // backmatter CLI imports the config to read models; never sync from there.
-  if (apiUrl && hostToken && workspaceId) {
+  if (sync && apiUrl && hostToken && workspaceId) {
     if (process.env.BACKMATTER_CLI === "1") {
       console.warn("backmatter: schema sync skipped (BACKMATTER_CLI=1)");
     } else {

package/src/node/generate.ts

@@ -95,7 +95,7 @@ export function detectSdk(root: string): string {
 
 function renderCachedCmsClient(): string[] {
   return [
-    "const raw = createBackmatter({ ...config, models });",
+    "const raw = createBackmatter({ ...config, models, sync: false });",
     "",
     "async function getDoc(locale: string, type: string, slug: string) {",
     '  "use cache";',
@@ -180,7 +180,7 @@ export function renderSyncBarrel(input: {
   lines.push(`export const blocks = [${input.blocks.map((b) => b.name).join(", ")}] as const;`);
   lines.push("");
   lines.push("/** Typed content client: cms.query.{type}, cms.getDoc, cms.listDocs. */");
-  lines.push("export const cms = createBackmatter({ ...config, models, blocks });");
+  lines.push("export const cms = createBackmatter({ ...config, models, blocks, sync: true });");
   return `${lines.join("\n")}\n`;
 }
 

package/src/query.ts

@@ -19,7 +19,7 @@ type KeysOfKind<M extends ModelDef, K extends FieldKind> = {
   [N in keyof M["fields"]]: M["fields"][N]["kind"] extends K ? N : never;
 }[keyof M["fields"]];
 
-type ScalarKind = "text" | "slug" | "locale" | "number" | "boolean";
+type ScalarKind = "text" | "locale" | "number" | "boolean";
 
 /** Equality filters on slug and scalar frontmatter fields. */
 export type Where<M extends ModelDef> = Partial<

package/src/zod.ts

@@ -14,7 +14,6 @@ export function expectedTypeFor(kind: FieldKind): "string" | "number" | "boolean
     case "blocks":
       return "array";
     case "text":
-    case "slug":
     case "locale":
     case "image":
     case "relation":
@@ -37,8 +36,6 @@ export function exampleValueFor(kind: FieldKind): unknown {
       return [];
     case "image":
       return "https://example.com/image.jpg";
-    case "slug":
-      return "example-slug";
     case "locale":
       return "en";
     case "relation":