@suluk/cockpit 0.1.10 → 0.1.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suluk/cockpit",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "The pure cockpit core (cycle model · builder model · codegen · deploy planning · validate/audit/preview) shared by the vscode extension and the /superadmin web admin panel. CANDIDATE tooling.",
   "type": "module",
   "main": "src/index.ts",

package/src/builder.ts

@@ -8,6 +8,7 @@
 import type { OpenAPIv4Document, SchemaOrRef } from "@suluk/core";
 import { buildApp, toShadcnRegistry, type Entity, type BuiltApp, type DslDocument, type ParamSpec } from "@suluk/builder";
 import type { Registry } from "@suluk/builder";
+import { contractToD2, diagramViews } from "./diagram";
 
 export interface BuilderNode {
   tier: "page" | "section" | "block" | "component";
@@ -88,9 +89,27 @@ export function generateAppFiles(doc: OpenAPIv4Document): GeneratedFile[] {
   const reg = toShadcnRegistry(app, { name: (doc.info?.title ?? "app").toLowerCase().replace(/\s+/g, "-") });
   files.push({ path: "registry.json", content: JSON.stringify(reg.index, null, 2) });
   for (const item of reg.items) files.push({ path: `registry/${item.name}.json`, content: JSON.stringify(item, null, 2) });
+  // diagrams — another projection: the app ships D2 of its own data model, cycle, and operation surface
+  for (const v of diagramViews()) files.push({ path: `docs/${v.id}.d2`, content: contractToD2(doc, v.id) });
+  files.push({ path: "docs/README.md", content: diagramsReadme(doc) });
   return files;
 }
 
+function diagramsReadme(doc: OpenAPIv4Document): string {
+  const title = doc.info?.title ?? "this app";
+  return [
+    `# ${title} — diagrams`,
+    "",
+    "Generated from the v4 contract by Suluk. Each is [D2](https://d2lang.com) source — render with the d2 CLI",
+    "(`d2 erd.d2 erd.svg`), the D2 VS Code extension, or paste into <https://play.d2lang.com>.",
+    "",
+    ...diagramViews().map((v) => `- **[\`${v.id}.d2\`](./${v.id}.d2)** — ${v.description}`),
+    "",
+    "Regenerate after the contract changes: re-run **Generate full app** in the Suluk extension.",
+    "",
+  ].join("\n");
+}
+
 /** The shadcn registry (index + items) as a pretty JSON string — the "Export shadcn registry" action. */
 export function generateRegistryJson(doc: OpenAPIv4Document): string {
   const { app } = buildBuilderModel(doc);

package/test/diagram.test.ts

@@ -2,6 +2,7 @@ import { test, expect, describe } from "bun:test";
 import { parseDocument } from "@suluk/core";
 import { installModule, ECOMMERCE } from "@suluk/builder";
 import { contractToD2, diagramViews } from "../src/diagram";
+import { generateAppFiles } from "../src/builder";
 
 const host = () => parseDocument(`openapi: 4.0.0-candidate
 info: { title: Shop, version: 1.0.0 }
@@ -64,6 +65,14 @@ components: { schemas: { Box: { type: object, properties: { shape: { type: strin
     expect(d2).toContain("listProduct");
     expect(d2).toContain("POST"); // createProduct etc.
   });
+  test("the GENERATED APP ships the contract's diagrams (docs/*.d2 + a README)", () => {
+    const files = generateAppFiles(doc);
+    const paths = files.map((f) => f.path);
+    for (const v of diagramViews()) expect(paths).toContain(`docs/${v.id}.d2`);
+    expect(paths).toContain("docs/README.md");
+    const erd = files.find((f) => f.path === "docs/erd.d2")!;
+    expect(erd.content).toContain("shape: sql_table"); // the app's own data model, as D2
+  });
   test("an empty contract still produces valid (non-empty) D2 for every view", () => {
     const empty = parseDocument(`openapi: 4.0.0-candidate
 info: { title: E, version: 1.0.0 }