@backmatter/next 0.0.14 → 0.0.16

package/dist/config.cjs

@@ -85,7 +85,8 @@ var DEFAULT_DIRS = {
   models: "models",
   blocks: "blocks",
   mdx: "mdx",
-  layouts: "layouts"
+  layouts: "layouts",
+  objects: "objects"
 };
 
 // ../core/src/node/discover.ts
@@ -146,6 +147,9 @@ function listBlockFallbackFiles(root, blocksDir = "blocks") {
 function listLayoutFiles(root, layoutsDir = "layouts") {
   return listModelFiles(root, layoutsDir);
 }
+function listObjectFiles(root, objectsDir = "objects") {
+  return listModelFiles(root, objectsDir);
+}
 function listBlockFiles(root, blocksDir = "blocks") {
   const { files, skipped } = listPascalCaseFiles(root, blocksDir);
   return { blocks: files, skipped };
@@ -182,7 +186,7 @@ function detectSdk(root) {
 }
 function renderCachedCmsClient() {
   return [
-    "const raw = createBackmatter({ ...config, models });",
+    "const raw = createBackmatter({ ...config, models, sync: false });",
     "",
     "async function getDoc(locale: string, type: string, slug: string) {",
     '  "use cache";',
@@ -237,6 +241,7 @@ function renderModelsBarrel(input) {
 `;
 }
 function renderSyncBarrel(input) {
+  const objects = input.objects ?? [];
   const lines = [GENERATED_HEADER, `import { createBackmatter } from "${input.sdk}";`];
   if (input.configFile) {
     lines.push(`import config from "${importSpecifier(input.outDir, input.configFile)}";`);
@@ -249,14 +254,19 @@ function renderSyncBarrel(input) {
   for (const b of input.blocks) {
     lines.push(`import ${b.name} from "${importSpecifier(input.outDir, b.file)}";`);
   }
+  for (const object of objects) {
+    lines.push(`import ${object.importName} from "${importSpecifier(input.outDir, object.file)}";`);
+  }
   lines.push("");
   lines.push(`export const models = [${input.models.map((m) => m.importName).join(", ")}] as const;`);
   lines.push("export type Models = typeof models;");
   lines.push("");
   lines.push(`export const blocks = [${input.blocks.map((b) => b.name).join(", ")}] as const;`);
   lines.push("");
+  lines.push(`export const objects = [${objects.map((o) => o.importName).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, objects, sync: true });");
   return `${lines.join(`
 `)}
 `;
@@ -327,6 +337,7 @@ function generate(options) {
   const fallbacks = listBlockFallbackFiles(root, options.blocksDir ?? DEFAULT_DIRS.blocks);
   const { blocks: mdx, skipped: skippedMdx } = listMdxFiles(root, options.mdxDir ?? DEFAULT_DIRS.mdx);
   const layouts = listLayoutFiles(root, options.layoutsDir ?? DEFAULT_DIRS.layouts);
+  const objects = listObjectFiles(root, options.objectsDir ?? DEFAULT_DIRS.objects);
   const sdk = options.sdk ?? detectSdk(root);
   const configFile = findConfigFile(root);
   const write = options.write ?? true;
@@ -336,7 +347,7 @@ function generate(options) {
     "block-fallbacks.ts": renderBlockFallbacksBarrel({ outDir, fallbacks }),
     "mdx.ts": renderMdxBarrel({ outDir, mdx }),
     "layouts.ts": renderLayoutsBarrel({ outDir, layouts }),
-    "sync.ts": renderSyncBarrel({ outDir, models, blocks, configFile, sdk })
+    "sync.ts": renderSyncBarrel({ outDir, models, blocks, objects, configFile, sdk })
   };
   const outputs = REGISTRY_FILES.map((name) => {
     const file = import_node_path2.default.join(outDir, name);
@@ -356,6 +367,7 @@ function generate(options) {
     blocks,
     mdx,
     layouts,
+    objects,
     skippedBlocks,
     skippedMdx,
     configFile
@@ -393,6 +405,7 @@ function resolveLoaderOptions(options = {}) {
     blocksDir: options.blocksDir ?? DEFAULT_DIRS.blocks,
     mdxDir: options.mdxDir ?? DEFAULT_DIRS.mdx,
     layoutsDir: options.layoutsDir ?? DEFAULT_DIRS.layouts,
+    objectsDir: options.objectsDir ?? DEFAULT_DIRS.objects,
     sdk: SDK
   };
 }

package/dist/loader.cjs

@@ -79,7 +79,8 @@ var DEFAULT_DIRS = {
   models: "models",
   blocks: "blocks",
   mdx: "mdx",
-  layouts: "layouts"
+  layouts: "layouts",
+  objects: "objects"
 };
 
 // ../core/src/node/discover.ts
@@ -140,6 +141,9 @@ function listBlockFallbackFiles(root, blocksDir = "blocks") {
 function listLayoutFiles(root, layoutsDir = "layouts") {
   return listModelFiles(root, layoutsDir);
 }
+function listObjectFiles(root, objectsDir = "objects") {
+  return listModelFiles(root, objectsDir);
+}
 function listBlockFiles(root, blocksDir = "blocks") {
   const { files, skipped } = listPascalCaseFiles(root, blocksDir);
   return { blocks: files, skipped };
@@ -176,7 +180,7 @@ function detectSdk(root) {
 }
 function renderCachedCmsClient() {
   return [
-    "const raw = createBackmatter({ ...config, models });",
+    "const raw = createBackmatter({ ...config, models, sync: false });",
     "",
     "async function getDoc(locale: string, type: string, slug: string) {",
     '  "use cache";',
@@ -231,6 +235,7 @@ function renderModelsBarrel(input) {
 `;
 }
 function renderSyncBarrel(input) {
+  const objects = input.objects ?? [];
   const lines = [GENERATED_HEADER, `import { createBackmatter } from "${input.sdk}";`];
   if (input.configFile) {
     lines.push(`import config from "${importSpecifier(input.outDir, input.configFile)}";`);
@@ -243,14 +248,19 @@ function renderSyncBarrel(input) {
   for (const b of input.blocks) {
     lines.push(`import ${b.name} from "${importSpecifier(input.outDir, b.file)}";`);
   }
+  for (const object of objects) {
+    lines.push(`import ${object.importName} from "${importSpecifier(input.outDir, object.file)}";`);
+  }
   lines.push("");
   lines.push(`export const models = [${input.models.map((m) => m.importName).join(", ")}] as const;`);
   lines.push("export type Models = typeof models;");
   lines.push("");
   lines.push(`export const blocks = [${input.blocks.map((b) => b.name).join(", ")}] as const;`);
   lines.push("");
+  lines.push(`export const objects = [${objects.map((o) => o.importName).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, objects, sync: true });");
   return `${lines.join(`
 `)}
 `;
@@ -321,6 +331,7 @@ function generate(options) {
   const fallbacks = listBlockFallbackFiles(root, options.blocksDir ?? DEFAULT_DIRS.blocks);
   const { blocks: mdx, skipped: skippedMdx } = listMdxFiles(root, options.mdxDir ?? DEFAULT_DIRS.mdx);
   const layouts = listLayoutFiles(root, options.layoutsDir ?? DEFAULT_DIRS.layouts);
+  const objects = listObjectFiles(root, options.objectsDir ?? DEFAULT_DIRS.objects);
   const sdk = options.sdk ?? detectSdk(root);
   const configFile = findConfigFile(root);
   const write = options.write ?? true;
@@ -330,7 +341,7 @@ function generate(options) {
     "block-fallbacks.ts": renderBlockFallbacksBarrel({ outDir, fallbacks }),
     "mdx.ts": renderMdxBarrel({ outDir, mdx }),
     "layouts.ts": renderLayoutsBarrel({ outDir, layouts }),
-    "sync.ts": renderSyncBarrel({ outDir, models, blocks, configFile, sdk })
+    "sync.ts": renderSyncBarrel({ outDir, models, blocks, objects, configFile, sdk })
   };
   const outputs = REGISTRY_FILES.map((name) => {
     const file = import_node_path2.default.join(outDir, name);
@@ -350,6 +361,7 @@ function generate(options) {
     blocks,
     mdx,
     layouts,
+    objects,
     skippedBlocks,
     skippedMdx,
     configFile
@@ -364,10 +376,12 @@ function backmatterLoader(source) {
   const blocksDir = import_node_path3.default.resolve(root, options.blocksDir);
   const mdxDir = import_node_path3.default.resolve(root, options.mdxDir);
   const layoutsDir = import_node_path3.default.resolve(root, options.layoutsDir);
+  const objectsDir = import_node_path3.default.resolve(root, options.objectsDir);
   this.addContextDependency(modelsDir);
   this.addContextDependency(blocksDir);
   this.addContextDependency(mdxDir);
   this.addContextDependency(layoutsDir);
+  this.addContextDependency(objectsDir);
   this.cacheable?.(true);
   const result = generate({
     root,
@@ -376,6 +390,7 @@ function backmatterLoader(source) {
     blocksDir: options.blocksDir,
     mdxDir: options.mdxDir,
     layoutsDir: options.layoutsDir,
+    objectsDir: options.objectsDir,
     sdk: options.sdk
   });
   if (result.configFile)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backmatter/next",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "Experimental Next.js adapter for Backmatter. APIs will break. Not ready for production.",
   "type": "module",
   "publishConfig": {
@@ -38,7 +38,7 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@backmatter/core": "^0.0.13",
+    "@backmatter/core": "^0.0.15",
     "@mdx-js/mdx": "^3.1.1",
     "remark-gfm": "^4.0.1"
   },

package/src/config.ts

@@ -26,6 +26,7 @@ export type WithBackmatterOptions = {
   blocksDir?: string;
   mdxDir?: string;
   layoutsDir?: string;
+  objectsDir?: string;
   /** Called after the boot-time generation. Default: log what changed. */
   onGenerate?: (result: GenerateResult) => void;
 };
@@ -82,6 +83,7 @@ export function resolveLoaderOptions(options: WithBackmatterOptions = {}): Backm
     blocksDir: options.blocksDir ?? DEFAULT_DIRS.blocks,
     mdxDir: options.mdxDir ?? DEFAULT_DIRS.mdx,
     layoutsDir: options.layoutsDir ?? DEFAULT_DIRS.layouts,
+    objectsDir: options.objectsDir ?? DEFAULT_DIRS.objects,
     sdk: SDK,
   };
 }

package/src/loader.ts

@@ -17,6 +17,7 @@ export type BackmatterLoaderOptions = {
   blocksDir: string;
   mdxDir: string;
   layoutsDir: string;
+  objectsDir: string;
   sdk: string;
 };
 
@@ -36,11 +37,13 @@ export default function backmatterLoader(this: BackmatterLoaderContext, source:
   const blocksDir = path.resolve(root, options.blocksDir);
   const mdxDir = path.resolve(root, options.mdxDir);
   const layoutsDir = path.resolve(root, options.layoutsDir);
+  const objectsDir = path.resolve(root, options.objectsDir);
 
   this.addContextDependency(modelsDir);
   this.addContextDependency(blocksDir);
   this.addContextDependency(mdxDir);
   this.addContextDependency(layoutsDir);
+  this.addContextDependency(objectsDir);
   this.cacheable?.(true);
 
   const result = generate({
@@ -50,6 +53,7 @@ export default function backmatterLoader(this: BackmatterLoaderContext, source:
     blocksDir: options.blocksDir,
     mdxDir: options.mdxDir,
     layoutsDir: options.layoutsDir,
+    objectsDir: options.objectsDir,
     sdk: options.sdk,
   });
   if (result.configFile) this.addDependency(result.configFile);

package/src/routes.ts

@@ -4,7 +4,7 @@
 // `route` template (including `/` via indexSlug), loads it and renders MDX
 // or JSON pages. An optional catch-all is required so `/` is a CMS route.
 import { Fragment, Suspense, createElement, type ReactNode } from "react";
-import { matchRoute, modelFormat, PREVIEW_CHECKOUT_QUERY, PREVIEW_COOKIE, readPreviewCookie, routeSegments, type BackmatterDoc, type ModelDef } from "@backmatter/core";
+import { isRoutable, matchRoute, modelFormat, PREVIEW_CHECKOUT_QUERY, PREVIEW_COOKIE, readPreviewCookie, routeSegments, type BackmatterDoc, type ModelDef } from "@backmatter/core";
 import type { BackmatterClient } from "@backmatter/core/node/create-backmatter";
 import { fetchPreviewDoc } from "@backmatter/core/preview";
 import { renderDoc, type MdxComponents } from "./mdx-compile";
@@ -162,7 +162,7 @@ export function createCatchAll<Models extends readonly ModelDef[]>(
     const params: CatchAllParams[] = [];
     for (const doc of docs) {
       const model = byType.get(doc.type);
-      if (!model) continue;
+      if (!model || !isRoutable(model)) continue;
       params.push({ [CATCH_ALL_PARAM]: routeSegments(model, doc.locale, doc.slug) });
     }
     return params;