claude-artifact-framework 0.12.0 → 0.13.0

package/README.md

@@ -468,7 +468,50 @@ close it (closing the open document falls back to a neighbour, never a
 blank pane), the per-document data pools (`d` inside any block, `output`,
 `custom`, or `when` is THAT document's data; `ctx.update` writes there),
 the empty state, and persistence — all documents and which one is open
-survive reload. Documents keys: `label`, `title`, `blocks`, `empty`.
+survive reload. Documents keys: `label`, `title`, `blocks`, `empty`,
+`types`.
+
+**Typed documents** — when tabs are not all the same kind of thing, declare
+`types` instead of `blocks` (one or the other, not both). Each type has its
+own `label`, optional `title` function, and its own `blocks`; the **+** tab
+asks which kind to create when there is more than one. Each document
+remembers its type forever; an untitled document shows its type label in
+the tab.
+
+```js
+ArtifactKit.createApp({
+  title: "Cuaderno",
+  layout: "documents",
+  documents: {
+    label: "página",
+    types: {
+      nota: {
+        label: "Nota",
+        title: (d) => d.titulo || "",
+        blocks: [{ fields: [
+          { key: "titulo", label: "Título", type: "text" },
+          { key: "texto", label: "Texto", type: "textarea", rows: 12 },
+        ]}],
+      },
+      compras: {
+        label: "Lista de compras",
+        blocks: [
+          { records: { key: "items", label: "producto", fields: [
+            { key: "producto", label: "Producto", type: "text", required: true },
+            { key: "comprado", label: "Comprado", type: "check" },
+          ]}},
+        ],
+      },
+    },
+  },
+})
+```
+
+When the variation is smaller than "a different kind of document" — the
+same document showing or hiding sections by its own state — prefer one
+`blocks` set with `when:` conditions (`when: (d) => d.modo === "avanzado"`)
+over `types`: one schema with conditional blocks keeps every document
+migratable and searchable as the same shape.
 
 Inside `documents`, blocks work as in `panel` — **including `chat` and
 `file`, which become per-document**:

package/dist/index.esm.js

@@ -1396,7 +1396,7 @@ function StepsLayout({ spec, ctx }) {
 var LAYOUTS = ["panel", "records", "steps", "chat", "workspace", "documents"];
 var RESERVED = ["title", "empty", "wide", "onSelect", "subtitle", "when", "collapsible", "fill"];
 var TOP_KEYS = ["title", "subtitle", "theme", "layout", "blocks", "records", "steps", "chat", "data", "shared", "main", "sidebar", "libs", "documents"];
-var DOCUMENTS_KEYS = ["label", "title", "blocks", "empty"];
+var DOCUMENTS_KEYS = ["label", "title", "blocks", "empty", "types"];
 var RECORDS_KEYS = ["label", "fields", "title", "subtitle", "sort", "summary", "empty", "search", "compute", "items", "actions"];
 var ITEMS_KEYS = ["label", "fields", "empty"];
 function checkFields(fields, where) {
@@ -1579,9 +1579,14 @@ function validate(spec) {
   }
   if (layout === "documents") {
     const d = spec.documents;
-    if (!d || !Array.isArray(d.blocks) || d.blocks.length === 0) {
+    if (!d || typeof d !== "object" || !d.blocks && !d.types) {
       throw new Error(
-        'claude-artifact-framework: layout "documents" needs `documents: { blocks: [...] }` \u2014 the blocks every document repeats, each with its own data.'
+        'claude-artifact-framework: layout "documents" needs `documents: { blocks: [...] }` (every document repeats the same blocks) or `documents: { types: {...} }` (each document is one of several kinds).'
+      );
+    }
+    if (d.blocks && d.types) {
+      throw new Error(
+        "claude-artifact-framework: documents takes `blocks` (uniform documents) OR `types` (typed documents) \u2014 not both."
       );
     }
     const unknownD = Object.keys(d).filter((k) => !DOCUMENTS_KEYS.includes(k));
@@ -1593,15 +1598,44 @@ function validate(spec) {
     if (d.title !== void 0 && typeof d.title !== "function") {
       throw new Error("claude-artifact-framework: documents.title must be a function of the document's data returning the tab label.");
     }
-    checkBlocks(d.blocks);
-    const docFlat = flattenBlocks(d.blocks);
-    const chats = docFlat.filter((b) => b && b.chat);
-    if (chats.length > 1) {
-      throw new Error(
-        "claude-artifact-framework: only one chat block per document \u2014 each document's conversation persists under its own data.chat and there is exactly one."
-      );
+    const checkDocBlocks = (blocks, where) => {
+      checkBlocks(blocks);
+      const flat = flattenBlocks(blocks);
+      if (flat.filter((b) => b && b.chat).length > 1) {
+        throw new Error(
+          `claude-artifact-framework: only one chat block per document (${where}) \u2014 each document's conversation persists under its own data.chat and there is exactly one.`
+        );
+      }
+      checkRecordsBlockKeys(flat);
+    };
+    if (d.blocks) {
+      if (!Array.isArray(d.blocks) || d.blocks.length === 0) {
+        throw new Error("claude-artifact-framework: documents.blocks must be a non-empty array of blocks.");
+      }
+      checkDocBlocks(d.blocks, "documents.blocks");
+    } else {
+      const names = Object.keys(d.types || {});
+      if (!names.length) {
+        throw new Error("claude-artifact-framework: documents.types needs at least one type, e.g. `types: { nota: { blocks: [...] } }`.");
+      }
+      for (const name of names) {
+        const t = d.types[name];
+        const TYPE_KEYS = ["label", "title", "blocks", "empty"];
+        const unknownT = Object.keys(t || {}).filter((k) => !TYPE_KEYS.includes(k));
+        if (unknownT.length) {
+          throw new Error(
+            `claude-artifact-framework: documents.types.${name} has unknown keys (${unknownT.join(", ")}). Valid keys: ${TYPE_KEYS.join(", ")}.`
+          );
+        }
+        if (!t || !Array.isArray(t.blocks) || t.blocks.length === 0) {
+          throw new Error(`claude-artifact-framework: documents.types.${name} needs a non-empty \`blocks\` array.`);
+        }
+        if (t.title !== void 0 && typeof t.title !== "function") {
+          throw new Error(`claude-artifact-framework: documents.types.${name}.title must be a function of the document's data.`);
+        }
+        checkDocBlocks(t.blocks, `documents.types.${name}`);
+      }
     }
-    checkRecordsBlockKeys(docFlat);
     return layout;
   }
   if (layout === "records") {
@@ -1883,7 +1917,7 @@ function docId() {
   return "d" + Date.now().toString(36) + Math.random().toString(36).slice(2, 8);
 }
 var DOC_TAB_KEY = "caf:doc";
-function docTitle(dspec, data) {
+function docTitle(dspec, data, untitled) {
   if (dspec.title) {
     try {
       const t = dspec.title(data);
@@ -1896,25 +1930,36 @@ function docTitle(dspec, data) {
       if (!f.type || f.type === "text" || f.type === "textarea" || f.type === "select") {
         const v = data[f.key];
         if (v !== "" && v !== void 0 && v !== null) return String(v);
-        return "(untitled)";
+        return untitled || "(untitled)";
       }
     }
   }
-  return "(untitled)";
+  return untitled || "(untitled)";
 }
 function DocumentsLayout({ spec, ctx }) {
   const dspec = spec.documents;
   const label = dspec.label || "document";
   const docs = Array.isArray(ctx.data.docs) ? ctx.data.docs : [];
-  const defaults = docDefaults(dspec);
+  const types = dspec.types || null;
+  const typeNames = types ? Object.keys(types) : [];
+  const specFor = (doc) => types ? types[doc.type] : dspec;
+  const typeLabel = (name) => types[name] && types[name].label || name;
+  const [picking, setPicking] = useState(false);
   const storedId = ctx.view.tabs ? ctx.view.tabs[DOC_TAB_KEY] : void 0;
   const active = docs.find((doc) => doc.id === storedId) || docs[0];
-  function add() {
-    const doc = { id: docId(), data: docDefaults(dspec) };
+  function add(typeName) {
+    const tspec = types ? types[typeName] : dspec;
+    const doc = { id: docId(), ...types ? { type: typeName } : {}, data: docDefaults(tspec) };
     ctx.update((d) => {
       d.docs = [...d.docs || [], doc];
     });
     ctx.setTab(DOC_TAB_KEY, doc.id);
+    setPicking(false);
+  }
+  function onAdd() {
+    if (!types) return add();
+    if (typeNames.length === 1) return add(typeNames[0]);
+    setPicking((p) => !p);
   }
   function close(id) {
     const idx = docs.findIndex((doc) => doc.id === id);
@@ -1927,6 +1972,13 @@ function DocumentsLayout({ spec, ctx }) {
       if (next) ctx.setTab(DOC_TAB_KEY, next.id);
     }
   }
+  const typePicker = types && picking ? createElement(
+    "div",
+    { className: "caf-doc-typemenu" },
+    typeNames.map(
+      (name) => createElement("button", { key: name, type: "button", className: "caf-btn caf-btn-sm", onClick: () => add(name) }, typeLabel(name))
+    )
+  ) : null;
   if (!active) {
     return createElement(
       "div",
@@ -1935,10 +1987,32 @@ function DocumentsLayout({ spec, ctx }) {
         "div",
         { className: "caf-block caf-empty" },
         createElement("p", null, dspec.empty || `No ${label}s yet. Create the first one.`),
-        createElement("button", { type: "button", className: "caf-btn caf-btn-primary", onClick: add }, `New ${label}`)
+        types ? createElement(
+          "div",
+          { className: "caf-doc-typemenu" },
+          typeNames.map(
+            (name) => createElement("button", { key: name, type: "button", className: "caf-btn caf-btn-primary", onClick: () => add(name) }, `New ${typeLabel(name)}`)
+          )
+        ) : createElement("button", { type: "button", className: "caf-btn caf-btn-primary", onClick: () => add() }, `New ${label}`)
+      )
+    );
+  }
+  const aspec = specFor(active);
+  if (!aspec) {
+    return createElement(
+      "div",
+      { className: "caf-documents" },
+      createElement(DocTabbar, { docs, active, dspec, types, close, onAdd, label, ctx }),
+      typePicker,
+      createElement(
+        "div",
+        { className: "caf-block caf-block-error" },
+        createElement("strong", null, `This ${label}'s type "${active.type}" no longer exists`),
+        createElement("code", null, `valid types: ${typeNames.join(", ")}`)
       )
     );
   }
+  const defaults = docDefaults(aspec);
   const activeData = { ...defaults, ...active.data };
   const scoped = {
     ...ctx,
@@ -1956,39 +2030,50 @@ function DocumentsLayout({ spec, ctx }) {
   return createElement(
     "div",
     { className: "caf-documents" },
-    createElement(
-      "div",
-      { className: "caf-tabbar", role: "tablist" },
-      docs.map(
-        (doc) => createElement(
-          "span",
-          { key: doc.id, className: "caf-doc-tab" },
-          createElement(
-            "button",
-            {
-              type: "button",
-              role: "tab",
-              "aria-selected": doc.id === active.id,
-              className: doc.id === active.id ? "caf-tab caf-tab-active" : "caf-tab",
-              onClick: () => ctx.setTab(DOC_TAB_KEY, doc.id)
-            },
-            docTitle(dspec, { ...defaults, ...doc.data })
-          ),
-          createElement(
-            "button",
-            {
-              type: "button",
-              className: "caf-doc-close",
-              "aria-label": `Close ${label}`,
-              onClick: () => close(doc.id)
-            },
-            "\u2715"
-          )
+    createElement(DocTabbar, { docs, active, dspec, types, close, onAdd, label, ctx }),
+    typePicker,
+    createElement(Panel, { spec: { blocks: aspec.blocks }, ctx: scoped })
+  );
+}
+function DocTabbar({ docs, active, dspec, types, close, onAdd, label, ctx }) {
+  const tabTitle = (doc) => {
+    const tspec = types ? types[doc.type] : dspec;
+    if (!tspec) return doc.type;
+    const merged = { ...docDefaults(tspec), ...doc.data };
+    const fallback = types ? tspec.label || doc.type : void 0;
+    return docTitle(tspec, merged, fallback);
+  };
+  return createElement(
+    "div",
+    { className: "caf-tabbar", role: "tablist" },
+    docs.map(
+      (doc) => createElement(
+        "span",
+        { key: doc.id, className: "caf-doc-tab" },
+        createElement(
+          "button",
+          {
+            type: "button",
+            role: "tab",
+            "aria-selected": doc.id === active.id,
+            className: doc.id === active.id ? "caf-tab caf-tab-active" : "caf-tab",
+            onClick: () => ctx.setTab(DOC_TAB_KEY, doc.id)
+          },
+          tabTitle(doc)
+        ),
+        createElement(
+          "button",
+          {
+            type: "button",
+            className: "caf-doc-close",
+            "aria-label": `Close ${label}`,
+            onClick: () => close(doc.id)
+          },
+          "\u2715"
         )
-      ),
-      createElement("button", { type: "button", className: "caf-tab caf-doc-add", "aria-label": `New ${label}`, onClick: add }, "+")
+      )
     ),
-    createElement(Panel, { spec: { blocks: dspec.blocks }, ctx: scoped })
+    createElement("button", { type: "button", className: "caf-tab caf-doc-add", "aria-label": `New ${label}`, onClick: onAdd }, "+")
   );
 }
 var LAYOUT_COMPONENTS = { panel: Panel, records: RecordsWithBlocks, steps: StepsLayout, chat: ChatLayout, workspace: WorkspaceLayout, documents: DocumentsLayout };
@@ -2291,6 +2376,7 @@ var BASE_CSS = `
 .caf-doc-add { font-size: 1rem; font-weight: 650; }
 .caf-empty .caf-btn { margin-top: 0.6rem; }
 .caf-records-block { display: flex; flex-direction: column; gap: 1rem; min-width: 0; }
+.caf-doc-typemenu { display: flex; gap: 0.5rem; flex-wrap: wrap; }
 .caf-chevron-closed { transform: rotate(-90deg); }
 .caf-block-fill { border: none; background: transparent; padding: 0; overflow: auto; min-height: 320px; }
 .caf-empty, .caf-loading { color: var(--caf-muted); font-size: 0.9rem; text-align: center; padding: 1.6rem 1rem; }