@cmssy/cli 16.9.1 → 16.11.0

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

@@ -1,7 +1,5 @@
 import {
-  CmssyBlock,
-  buildBlockContext,
-  buildBlockMap,
+  CmssyLayoutRegion,
   type CmssyBlockPage,
   type CmssyLayoutGroup,
 } from "@cmssy/react";
@@ -50,36 +48,17 @@ export default function LayoutSlot({
     );
   }
 
-  const group = groups.find((candidate) => candidate.region === region);
-  if (!group) return null;
-
-  const blockMap = buildBlockMap(blocks);
-  const context = buildBlockContext(
-    locale,
-    defaultLocale,
-    enabledLocales,
-    false,
-    undefined,
-    { page },
-  );
-
   return (
-    <>
-      {[...group.blocks]
-        .filter((block) => block.isActive !== false)
-        .sort((a, b) => (a.order ?? 0) - (b.order ?? 0))
-        .map((block) => (
-          <CmssyBlock
-            key={block.id}
-            block={block}
-            blockMap={blockMap}
-            locale={locale}
-            defaultLocale={defaultLocale}
-            context={context}
-            resolvedContent={resolvedContent?.[block.id]}
-            data={data?.[block.id]}
-          />
-        ))}
-    </>
+    <CmssyLayoutRegion
+      groups={groups}
+      region={region}
+      blocks={blocks}
+      page={page}
+      locale={locale}
+      defaultLocale={defaultLocale}
+      enabledLocales={enabledLocales}
+      blockData={data}
+      blockContent={resolvedContent}
+    />
   );
 }

package/assets/init/astro/src/components/Blocks.tsx

@@ -1,4 +1,4 @@
-import { CmssyBlock, buildBlockMap, buildBlockContext } from "@cmssy/react";
+import { CmssyBlocks } from "@cmssy/react";
 import type { CmssyPageData } from "@cmssy/core";
 import { blocks } from "../cmssy/blocks";
 
@@ -17,23 +17,15 @@ export function Blocks({
   blockData: Record<string, unknown>;
   blockContent: Record<string, Record<string, unknown>>;
 }) {
-  const blockMap = buildBlockMap(blocks);
-  const context = buildBlockContext(locale, defaultLocale, enabledLocales);
-
   return (
-    <>
-      {(page.blocks ?? []).map((block) => (
-        <CmssyBlock
-          key={block.id}
-          block={block}
-          blockMap={blockMap}
-          locale={locale}
-          defaultLocale={defaultLocale}
-          context={context}
-          resolvedContent={blockContent[block.id]}
-          data={blockData[block.id]}
-        />
-      ))}
-    </>
+    <CmssyBlocks
+      page={page}
+      blocks={blocks}
+      locale={locale}
+      defaultLocale={defaultLocale}
+      enabledLocales={enabledLocales}
+      blockData={blockData}
+      blockContent={blockContent}
+    />
   );
 }

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

@@ -1,7 +1,5 @@
 import {
-  CmssyBlock,
-  buildBlockContext,
-  buildBlockMap,
+  CmssyLayoutRegion,
   type CmssyBlockPage,
   type CmssyLayoutGroup,
 } from "@cmssy/react";
@@ -50,36 +48,17 @@ export function LayoutSlot({
     );
   }
 
-  const group = groups.find((candidate) => candidate.region === region);
-  if (!group) return null;
-
-  const blockMap = buildBlockMap(blocks);
-  const context = buildBlockContext(
-    locale,
-    defaultLocale,
-    enabledLocales,
-    false,
-    undefined,
-    { page },
-  );
-
   return (
-    <>
-      {[...group.blocks]
-        .filter((block) => block.isActive !== false)
-        .sort((a, b) => (a.order ?? 0) - (b.order ?? 0))
-        .map((block) => (
-          <CmssyBlock
-            key={block.id}
-            block={block}
-            blockMap={blockMap}
-            locale={locale}
-            defaultLocale={defaultLocale}
-            context={context}
-            resolvedContent={resolvedContent?.[block.id]}
-            data={data?.[block.id]}
-          />
-        ))}
-    </>
+    <CmssyLayoutRegion
+      groups={groups}
+      region={region}
+      blocks={blocks}
+      page={page}
+      locale={locale}
+      defaultLocale={defaultLocale}
+      enabledLocales={enabledLocales}
+      blockData={data}
+      blockContent={resolvedContent}
+    />
   );
 }

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

@@ -1,7 +1,5 @@
 import {
-  CmssyBlock,
-  buildBlockContext,
-  buildBlockMap,
+  CmssyBlocks,
   resolveEditorBlockData,
   resolveEditorLayoutBlockData,
   type EditorBlockData,
@@ -131,25 +129,19 @@ export default function CmssyPage({ loaderData }: Route.ComponentProps) {
       </>
     );
 
-  const blockMap = buildBlockMap(blocks);
-  const context = buildBlockContext(locale, defaultLocale, enabledLocales);
-
   return (
     <>
       {slot("header")}
       <main>
-        {(page.blocks ?? []).map((block) => (
-          <CmssyBlock
-            key={block.id}
-            block={block}
-            blockMap={blockMap}
-            locale={locale}
-            defaultLocale={defaultLocale}
-            context={context}
-            resolvedContent={blockContent[block.id]}
-            data={blockData[block.id]}
-          />
-        ))}
+        <CmssyBlocks
+          page={page}
+          blocks={blocks}
+          locale={locale}
+          defaultLocale={defaultLocale}
+          enabledLocales={enabledLocales}
+          blockData={blockData}
+          blockContent={blockContent}
+        />
       </main>
       {slot("footer")}
     </>

package/dist/index.js

@@ -23,10 +23,12 @@ var NEEDS_PAGES_EDIT_HINT = {
 };
 var CliError = class extends Error {
   fix;
-  constructor(message, fix) {
+  code;
+  constructor(message, fix, code) {
     super(message);
     this.name = "CliError";
     this.fix = fix;
+    this.code = code;
   }
 };
 function isDenied(errors, status) {
@@ -69,7 +71,9 @@ async function adminGraphql(query, variables, options) {
   }
   if (errors.length > 0) {
     throw new CliError(
-      `the cmssy API rejected the request - ${errors.map((error) => error.message ?? "GraphQL error").join("; ")}`
+      `the cmssy API rejected the request - ${errors.map((error) => error.message ?? "GraphQL error").join("; ")}`,
+      void 0,
+      errors.find((error) => error.extensions?.code)?.extensions?.code
     );
   }
   if (!response.ok || envelope?.data == null) {
@@ -102,9 +106,9 @@ var UPDATE_PREVIEW_URL_MUTATION = `mutation CliSetPreviewUrl($input: UpdateSiteC
     }
   }
 }`;
-var SAVE_BLOCK_MANIFEST_MUTATION = `mutation CliSaveBlockManifest($blocks: JSON!, $regions: JSON) {
+var SAVE_BLOCK_MANIFEST_MUTATION = `mutation CliSaveBlockManifest($blocks: JSON!, $regions: JSON, $expectedHash: String, $onlyIfAbsent: Boolean, $allowLossy: Boolean) {
   blockManifest {
-    save(blocks: $blocks, regions: $regions) {
+    save(blocks: $blocks, regions: $regions, expectedHash: $expectedHash, onlyIfAbsent: $onlyIfAbsent, allowLossy: $allowLossy) {
       hash
       updatedAt
     }
@@ -147,12 +151,42 @@ async function fetchBlockManifestHash(options) {
   );
   return data.blockManifest.get?.hash ?? null;
 }
-async function saveBlockManifest(manifest, options) {
-  const data = await adminGraphql(SAVE_BLOCK_MANIFEST_MUTATION, manifest, {
+async function saveBlockManifest(manifest, options, guard = {}) {
+  const data = await adminGraphql(
+    SAVE_BLOCK_MANIFEST_MUTATION,
+    { ...manifest, ...guard },
+    {
+      ...options,
+      denied: NEEDS_MANIFEST_WRITE_HINT
+    }
+  );
+  return data.blockManifest.save;
+}
+var BLOCK_MANIFEST_IMPACT_QUERY = `query CliBlockManifestImpact($blocks: JSON!, $regions: JSON) {
+  blockManifest {
+    impact(blocks: $blocks, regions: $regions) {
+      hash
+      activeHash
+      unchanged
+      addedTypes
+      removedTypes { type pages publishedPages }
+      changedTypes
+      removedFields { type fields }
+      removedRegions
+      changedRegions
+      moves
+      lossyMoves
+      documents
+      heldDocuments
+    }
+  }
+}`;
+async function fetchBlockManifestImpact(manifest, options) {
+  const data = await adminGraphql(BLOCK_MANIFEST_IMPACT_QUERY, manifest, {
     ...options,
     denied: NEEDS_MANIFEST_WRITE_HINT
   });
-  return data.blockManifest.save;
+  return data.blockManifest.impact;
 }
 
 // src/format.ts
@@ -1496,7 +1530,8 @@ var CONFIG_CANDIDATES = [
 ];
 var SYNC_MANIFEST_USAGE = [
   "  cmssy sync-manifest [--blocks <path>] [--config <path>] [--token <cs_...>]",
-  "                      [--org <slug>] [--workspace <slug>] [--dry-run] [--help]"
+  "                      [--org <slug>] [--workspace <slug>] [--dry-run]",
+  "                      [--allow-lossy] [--help]"
 ];
 function hasBlocksModule(cwd) {
   return BLOCKS_CANDIDATES.some(
@@ -1612,6 +1647,53 @@ function describe(manifest) {
   lines.push(`  regions: ${regions.join(", ") || "-"}`);
   return lines;
 }
+function plural(count, noun) {
+  return `${count} ${noun}${count === 1 ? "" : "s"}`;
+}
+function describeImpact(impact) {
+  const lines = [];
+  for (const removed of impact.removedTypes) {
+    lines.push(
+      removed.pages === 0 ? `  removes \`${removed.type}\`, not used on any page` : `  removes \`${removed.type}\`, used on ${plural(removed.pages, "page")} (${removed.publishedPages} published)`
+    );
+  }
+  for (const removed of impact.removedFields) {
+    lines.push(
+      `  removes fields from \`${removed.type}\`: ${removed.fields.join(", ")}`
+    );
+  }
+  const withRemovedFields = new Set(
+    impact.removedFields.map((removed) => removed.type)
+  );
+  for (const type of impact.changedTypes) {
+    if (withRemovedFields.has(type)) continue;
+    lines.push(
+      `  reshapes \`${type}\` - stored values may no longer match its fields`
+    );
+  }
+  if (impact.addedTypes.length > 0) {
+    lines.push(
+      `  adds ${impact.addedTypes.map((type) => `\`${type}\``).join(", ")}`
+    );
+  }
+  for (const region of impact.removedRegions) {
+    lines.push(`  removes region \`${region}\``);
+  }
+  for (const region of impact.changedRegions) {
+    lines.push(`  reshapes the settings of region \`${region}\``);
+  }
+  if (impact.moves > 0) {
+    lines.push(
+      `  moves ${plural(impact.moves, "stored value")} in ${plural(impact.documents, "document")}`
+    );
+  }
+  if (impact.lossyMoves > 0) {
+    lines.push(
+      `  ${plural(impact.lossyMoves, "move")} would drop stored values (a translation or a differing copy) in ${plural(impact.heldDocuments, "document")}`
+    );
+  }
+  return lines;
+}
 async function collectManifest(options, deps) {
   const load = deps.load ?? loadSiteModule;
   const blocksPath = findModule(
@@ -1659,11 +1741,17 @@ async function runSyncManifest(options, deps) {
     loadEnvFiles(deps.cwd, deps.env);
     const collected = await collectManifest(options, deps);
     const { manifest } = collected;
-    if (options.dryRun) {
-      deps.log(JSON.stringify(manifest, null, 2));
+    const count = `${plural(manifest.blocks.length, "block")}${manifest.regions ? ` and ${plural(manifest.regions.length, "region")}` : ""}`;
+    const sources = `(${collected.blocksPath}, ${collected.configPath})`;
+    const token = options.dryRun && !options.token?.trim() && !deps.env.CMSSY_API_TOKEN?.trim() ? null : resolveToken(options, deps.env);
+    if (token === null) {
+      deps.log(`cmssy: dry run - ${count} ${sources}`);
+      for (const line of describe(manifest)) deps.log(line);
+      deps.log(
+        "  impact not checked - set CMSSY_API_TOKEN to compare with the workspace"
+      );
       return 0;
     }
-    const token = resolveToken(options, deps.env);
     const org = resolveSlug(
       options.org,
       collected.org,
@@ -1683,22 +1771,58 @@ async function runSyncManifest(options, deps) {
       apiUrl: deps.env.CMSSY_API_URL,
       fetch: deps.fetch
     };
+    deps.log(
+      `cmssy: ${org}/${slug} at ${request2.apiUrl?.trim() || DEFAULT_ADMIN_API_URL}`
+    );
     const workspace = matchWorkspace(
       await fetchMyWorkspaces(request2),
       org,
       slug
     );
     const scoped = { ...request2, workspaceId: workspace.id };
-    const before = await fetchBlockManifestHash(scoped);
-    const saved = await saveBlockManifest(manifest, scoped);
-    const unchanged = before === saved.hash;
-    const count = `${manifest.blocks.length} block${manifest.blocks.length === 1 ? "" : "s"}${manifest.regions ? ` and ${manifest.regions.length} region${manifest.regions.length === 1 ? "" : "s"}` : ""}`;
+    const impact = await fetchBlockManifestImpact(manifest, scoped);
+    if (impact.unchanged) {
+      deps.log(
+        `cmssy: ${org}/${slug} already has this manifest - ${count} unchanged ${sources}`
+      );
+      for (const line of describe(manifest)) deps.log(line);
+      deps.log(`  manifest ${impact.hash.slice(0, 12)}`);
+      return 0;
+    }
+    const effects = describeImpact(impact);
     deps.log(
-      unchanged ? `cmssy: ${org}/${slug} already has this manifest - ${count} unchanged (${collected.blocksPath}, ${collected.configPath})` : `cmssy: pushed ${count} to ${org}/${slug} (${collected.blocksPath}, ${collected.configPath})`
+      options.dryRun ? `cmssy: dry run - pushing ${count} to ${org}/${slug} would ${effects.length > 0 ? "change:" : "change nothing stored"} ${sources}` : `cmssy: ${org}/${slug} - ${count} ${sources}`
     );
+    for (const line of effects) deps.log(line);
     for (const line of describe(manifest)) deps.log(line);
+    if (impact.lossyMoves > 0 && !options.allowLossy) {
+      deps.log(
+        `cmssy: not pushed - rerun with --allow-lossy to accept dropping those values`
+      );
+      return 1;
+    }
+    if (options.dryRun) {
+      deps.log("cmssy: dry run - nothing pushed");
+      return 0;
+    }
+    let saved;
+    try {
+      saved = await saveBlockManifest(manifest, scoped, {
+        ...impact.activeHash === null ? { onlyIfAbsent: true } : { expectedHash: impact.activeHash },
+        ...options.allowLossy ? { allowLossy: true } : {}
+      });
+    } catch (error) {
+      if (error instanceof CliError && error.code === "CONFLICT") {
+        throw new CliError(
+          `the block manifest of ${org}/${slug} changed while this ran - nothing pushed`,
+          "run cmssy sync-manifest again to compare with the new manifest"
+        );
+      }
+      throw error;
+    }
+    deps.log(`cmssy: pushed ${count} to ${org}/${slug}`);
     deps.log(
-      unchanged ? `  manifest ${saved.hash.slice(0, 12)} - last updated ${saved.updatedAt}` : `  manifest ${saved.hash.slice(0, 12)} - updated ${saved.updatedAt}`
+      `  manifest ${saved.hash.slice(0, 12)} - updated ${saved.updatedAt}`
     );
     return 0;
   } catch (error) {
@@ -1712,6 +1836,7 @@ async function runSyncManifest(options, deps) {
 }
 
 // src/link.ts
+var MANIFEST_KEPT = "block manifest left unchanged - the workspace already has one, and link never replaces it from a local checkout; run cmssy sync-manifest from the code your site is deployed from to replace it";
 function resolveToken2(options, deps) {
   const token = options.token?.trim() || deps.env.CMSSY_API_TOKEN?.trim();
   if (!token) {
@@ -1855,15 +1980,25 @@ function resolvePreviewUrl(options) {
 }
 async function pushBlockManifest(workspace, admin, deps) {
   if (!hasBlocksModule(deps.cwd)) return null;
+  const scoped = { ...admin, workspaceId: workspace.id };
   try {
+    if (await fetchBlockManifestHash(scoped) !== null) {
+      return {
+        status: "unknown",
+        message: MANIFEST_KEPT
+      };
+    }
     const { manifest, blocksPath } = await collectManifest({}, deps);
-    await saveBlockManifest(manifest, { ...admin, workspaceId: workspace.id });
+    await saveBlockManifest(manifest, scoped, { onlyIfAbsent: true });
     const count = manifest.blocks.length;
     return {
       status: "ok",
       message: `pushed the block manifest from ${blocksPath} (${count} block${count === 1 ? "" : "s"}) - the editor palette knows your blocks before the first deploy`
     };
   } catch (error) {
+    if (error instanceof CliError && error.code === "CONFLICT") {
+      return { status: "unknown", message: MANIFEST_KEPT };
+    }
     if (error instanceof CliError) {
       const fix = error.fix ?? "run cmssy sync-manifest once the blocks module loads";
       return {
@@ -2572,7 +2707,8 @@ async function main() {
         token: flagValue(args, "--token"),
         org: flagValue(args, "--org"),
         workspace: flagValue(args, "--workspace"),
-        dryRun: hasFlag(args, "--dry-run")
+        dryRun: hasFlag(args, "--dry-run"),
+        allowLossy: hasFlag(args, "--allow-lossy")
       },
       {
         cwd: process.cwd(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmssy/cli",
-  "version": "16.9.1",
+  "version": "16.11.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",
@@ -28,7 +28,7 @@
   ],
   "dependencies": {
     "esbuild": "^0.27.7",
-    "@cmssy/core": "16.9.1"
+    "@cmssy/core": "16.11.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",