@cmssy/cli 10.10.0 → 11.1.0

package/assets/init/astro/src/cmssy/layout-slot.tsx

@@ -15,6 +15,13 @@ export interface LayoutSlotProps {
   enabledLocales: string[];
   /** Set on a VERIFIED editor request; the loader reports it as `isEdit`. */
   edit?: { editorOrigin: string | string[] };
+  /**
+   * The editor's block data, both halves, straight from the loader. Without
+   * `resolvedContent` the canvas shows a relation field as the raw ids it
+   * stores - the site looks right and the editor cannot fill the header.
+   */
+  data?: Record<string, unknown>;
+  resolvedContent?: Record<string, Record<string, unknown>>;
 }
 
 /**
@@ -34,6 +41,8 @@ export default function LayoutSlot({
   defaultLocale,
   enabledLocales,
   edit,
+  data,
+  resolvedContent,
 }: LayoutSlotProps) {
   if (edit) {
     return (
@@ -44,6 +53,8 @@ export default function LayoutSlot({
         defaultLocale={defaultLocale}
         enabledLocales={enabledLocales}
         edit={edit}
+        data={data}
+        resolvedContent={resolvedContent}
         load={() => import("./blocks")}
       />
     );

package/assets/init/astro/src/pages/[...path].astro

@@ -1,15 +1,19 @@
 ---
 import { loadCmssyPage } from "@cmssy/astro";
 import { cmssy } from "../cmssy.config";
+import { blocks } from "../cmssy/blocks";
 import { Blocks } from "../components/Blocks";
 import LayoutSlot from "../cmssy/layout-slot";
 
 export const prerender = false;
 
+// `blocks` is what lets the loader resolve the editor's layout data. Drop it
+// and the site still renders - the editor just cannot fill the header.
 const { page, layouts, locale, defaultLocale, enabledLocales } = await loadCmssyPage(
   cmssy,
   Astro.request,
   Astro.url,
+  { blocks },
 );
 
 if (!page) {

package/assets/init/astro/src/pages/cmssy-edit/[...path].astro

@@ -1,6 +1,7 @@
 ---
 import { loadCmssyPage } from "@cmssy/astro";
 import { cmssy } from "../../cmssy.config";
+import { blocks } from "../../cmssy/blocks";
 import CmssyEditor from "../../cmssy/editor";
 import LayoutSlot from "../../cmssy/layout-slot";
 
@@ -8,11 +9,10 @@ import LayoutSlot from "../../cmssy/layout-slot";
 // must be dynamic: a prerendered page never sees the query string.
 export const prerender = false;
 
-const { page, layouts, locale, defaultLocale, enabledLocales } = await loadCmssyPage(
-  cmssy,
-  Astro.request,
-  Astro.url,
-);
+// `blocks` is what resolves the editor's layout data. Without it the editor
+// can select the header and not fill it, and a relation field shows raw ids.
+const { page, layouts, locale, defaultLocale, enabledLocales, editorData } =
+  await loadCmssyPage(cmssy, Astro.request, Astro.url, { blocks });
 const editorOrigin = cmssy.editorOrigin ?? "*";
 ---
 
@@ -30,6 +30,8 @@ const editorOrigin = cmssy.editorOrigin ?? "*";
       defaultLocale={defaultLocale}
       enabledLocales={enabledLocales}
       edit={{ editorOrigin }}
+      data={editorData?.header?.data}
+      resolvedContent={editorData?.header?.resolvedContent}
     />
     <CmssyEditor
       client:load
@@ -47,6 +49,8 @@ const editorOrigin = cmssy.editorOrigin ?? "*";
       defaultLocale={defaultLocale}
       enabledLocales={enabledLocales}
       edit={{ editorOrigin }}
+      data={editorData?.footer?.data}
+      resolvedContent={editorData?.footer?.resolvedContent}
     />
   </body>
 </html>

package/assets/init/next/app/[[...path]]/page.tsx

@@ -3,12 +3,25 @@ import { cmssy } from "@/cmssy.config";
 import { blocks } from "@/cmssy/blocks";
 import { CmssyEditor } from "@/cmssy/editor";
 import { EditableLayout } from "@/cmssy/editable-layout";
+import { publishedPaths } from "@/services/pages";
 
 type PageProps = {
   params: Promise<{ path?: string[] }>;
   searchParams: Promise<Record<string, string | string[] | undefined>>;
 };
 
+// Three lines that decide whether this site is cached at all. Without
+// generateStaticParams a catch-all is rendered on demand every time and
+// `revalidate` is ignored - the build prints a blank Revalidate column, which is
+// the only warning you get. `dynamicParams` keeps pages published after the
+// build working: first request renders them, and they cache from then on.
+export const revalidate = 3600;
+export const dynamicParams = true;
+
+export function generateStaticParams() {
+  return publishedPaths();
+}
+
 const CmssyPage = createCmssyPage(cmssy, blocks, { editor: CmssyEditor });
 
 // The header and footer are layout blocks. They are mounted here rather than in
@@ -22,7 +35,8 @@ export default async function Page(props: PageProps) {
       config={cmssy}
       blocks={blocks}
       position={position}
-      path={path}
+      path={path ?? []}
+      editMode={false}
       editable={EditableLayout}
     />
   );

package/assets/init/next/app/cmssy-edit/[[...path]]/page.tsx

@@ -1,4 +1,8 @@
-import { createCmssyEditPage, CmssyLayoutSlot } from "@cmssy/next/server";
+import {
+  createCmssyEditPage,
+  CmssyLayoutSlot,
+  isCmssyEditMode,
+} from "@cmssy/next/server";
 import { cmssy } from "@/cmssy.config";
 import { blocks } from "@/cmssy/blocks";
 import { CmssyEditor } from "@/cmssy/editor";
@@ -24,12 +28,20 @@ const CmssyEditPage = createCmssyEditPage(cmssy, blocks, {
 // header missing here is a header missing in the editor.
 export default async function EditPage(props: PageProps) {
   const { path } = await props.params;
+
+  // Not a hard `true`: this route is reachable directly, and only the proxy's
+  // verified rewrite sets the edit header. Hard-coding it would fetch layouts
+  // with the draft secret for anyone who typed the URL. Reading a header costs
+  // nothing here - the route is force-dynamic either way.
+  const editMode = await isCmssyEditMode();
+
   const slot = (position: "header" | "footer") => (
     <CmssyLayoutSlot
       config={cmssy}
       blocks={blocks}
       position={position}
-      path={path}
+      path={path ?? []}
+      editMode={editMode}
       editable={EditableLayout}
     />
   );

package/assets/init/next/services/pages.ts

@@ -0,0 +1,58 @@
+import { createCmssyClient } from "@cmssy/core";
+import { cmssy } from "@/cmssy.config";
+
+// Your query, in your repo. The SDK does not mirror the graph - it gives you a
+// client and gets out of the way, so adding a field here is your call and not a
+// release of ours.
+const PUBLISHED_PAGES = `query PublishedPages($workspaceSlug: String!) {
+  public {
+    page {
+      list(workspaceSlug: $workspaceSlug) {
+        slug
+        publishedAt
+      }
+    }
+  }
+}`;
+
+type PublishedPages = {
+  public?: {
+    page?: { list?: { slug?: string | null; publishedAt?: string | null }[] | null } | null;
+  } | null;
+};
+
+const client = createCmssyClient({
+  apiUrl: cmssy.apiUrl,
+  org: cmssy.org,
+  workspaceSlug: cmssy.workspaceSlug,
+});
+
+/**
+ * The paths to prerender, as `generateStaticParams` wants them.
+ *
+ * A catch-all route with no params generated is served on demand and cached by
+ * nothing, whatever `revalidate` says - so this function is what makes the
+ * route cacheable at all, not an optimisation on top of it.
+ */
+export async function publishedPaths(): Promise<{ path: string[] }[]> {
+  const data = await client.query<PublishedPages>(
+    PUBLISHED_PAGES,
+    { workspaceSlug: cmssy.workspaceSlug },
+    {
+      // `public` routes through the org-scoped delivery path. Without it the
+      // request lands on the base endpoint, where an unauthenticated workspace
+      // lookup is by slug alone - across every org.
+      public: true,
+      // A build reads this once. A single 429 from the delivery API would fail
+      // the whole deploy, so retry - it is a read, nothing to double-apply.
+      retry: {},
+    },
+  );
+
+  const pages = data?.public?.page?.list ?? [];
+  return pages
+    .filter((page) => page.publishedAt)
+    .map((page) => ({
+      path: (page.slug ?? "").split("/").filter(Boolean),
+    }));
+}

package/assets/init/remix/app/cmssy/layout-slot.tsx

@@ -15,6 +15,13 @@ export interface LayoutSlotProps {
   enabledLocales: string[];
   /** Set on a VERIFIED editor request; the loader reports it as `isEdit`. */
   edit?: { editorOrigin: string | string[] };
+  /**
+   * The editor's block data, both halves, straight from the loader. Without
+   * `resolvedContent` the canvas shows a relation field as the raw ids it
+   * stores - the site looks right and the editor cannot fill the header.
+   */
+  data?: Record<string, unknown>;
+  resolvedContent?: Record<string, Record<string, unknown>>;
 }
 
 /**
@@ -31,6 +38,8 @@ export function LayoutSlot({
   defaultLocale,
   enabledLocales,
   edit,
+  data,
+  resolvedContent,
 }: LayoutSlotProps) {
   if (edit) {
     return (
@@ -41,6 +50,8 @@ export function LayoutSlot({
         defaultLocale={defaultLocale}
         enabledLocales={enabledLocales}
         edit={edit}
+        data={data}
+        resolvedContent={resolvedContent}
         load={() => import("./blocks")}
       />
     );

package/assets/init/remix/app/routes/page.tsx

@@ -6,7 +6,9 @@ import { CmssyEditor } from "../cmssy/editor";
 import { LayoutSlot } from "../cmssy/layout-slot";
 import type { Route } from "./+types/page";
 
-export const loader = createCmssyLoader(cmssy);
+// `blocks` is what lets the loader resolve the editor's layout data. Drop it
+// and the site still renders - the editor just cannot fill the header.
+export const loader = createCmssyLoader(cmssy, { blocks });
 
 // Without these the admin cannot frame the site, and the editor shows an empty
 // box with no error anywhere.
@@ -22,6 +24,7 @@ export default function CmssyPage({ loaderData }: Route.ComponentProps) {
     isEdit,
     editorOrigin,
     diagnostics,
+    editorData,
   } = loaderData;
 
   if (diagnostics) {
@@ -38,6 +41,8 @@ export default function CmssyPage({ loaderData }: Route.ComponentProps) {
       defaultLocale={defaultLocale}
       enabledLocales={enabledLocales}
       edit={isEdit ? { editorOrigin } : undefined}
+      data={editorData?.[position]?.data}
+      resolvedContent={editorData?.[position]?.resolvedContent}
     />
   );
 

package/dist/index.js

@@ -161,10 +161,11 @@ var FRAMEWORKS = [
     label: "Next.js",
     createCommand: "npx create-next-app@latest",
     detect: ["next"],
-    dependencies: ["@cmssy/next", "@cmssy/react"],
+    dependencies: ["@cmssy/next", "@cmssy/react", "@cmssy/core"],
     files: [
       "cmssy.config.ts",
       "proxy.ts",
+      "services/pages.ts",
       "cmssy/blocks.ts",
       "cmssy/editor.tsx",
       "cmssy/editable-layout.tsx",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmssy/cli",
-  "version": "10.10.0",
+  "version": "11.1.0",
   "description": "The cmssy CLI: `cmssy init` wires cmssy into an existing Next.js, Astro or React Router app; `cmssy link` connects it to a workspace and verifies the editor wiring.",
   "keywords": [
     "cmssy",
@@ -27,7 +27,7 @@
     "assets"
   ],
   "dependencies": {
-    "@cmssy/core": "10.10.0"
+    "@cmssy/core": "11.1.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",