claude-artifact-framework 0.10.0 → 0.12.0

package/README.md

@@ -394,6 +394,47 @@ The active tab and each accordion's open/closed state are framework-owned
 view state — they survive reload, per viewer. Tabs cannot nest inside tabs;
 `when` must be a function; both throw otherwise.
 
+### `records` as a block — a CRUD collection inside any screen
+
+The full records machinery (list, add-then-edit, detail, search, summary,
+compute, items, row actions) is also a **block**, embeddable wherever panel
+blocks go — a workspace pane, a document, a tab. Declare it with the same
+`records: {...}` spec plus one extra key: **`key`**, naming where the
+collection lives in the enclosing data pool (default `"records"`; two
+records blocks need distinct keys).
+
+```js
+// A task list per project: records INSIDE documents — each document gets
+// its own independent collection automatically.
+ArtifactKit.createApp({
+  title: "Proyectos",
+  layout: "documents",
+  documents: {
+    label: "proyecto",
+    title: (d) => d.nombre || "Sin nombre",
+    blocks: [
+      { fields: [{ key: "nombre", label: "Proyecto", type: "text" }] },
+      { records: {
+          key: "tareas",
+          label: "tarea",
+          fields: [
+            { key: "titulo", label: "Título", type: "text", required: true },
+            { key: "hecha", label: "Hecha", type: "check" },
+          ],
+          summary: (all) => [{ label: "Pendientes", value: all.filter((t) => !t.hecha).length, big: true }],
+      }},
+    ],
+  },
+})
+```
+
+Inside a `documents` layout the collection is per document; in `panel` or
+`workspace` it lives in the flat pool under `key`, where `output`/`chart`
+blocks and chat tools can read and write it (`d.tareas`). Which record is
+open is framework-owned view state per collection — it survives reload,
+and a deleted open record falls back to the list. A records block below a
+records *layout* throws (the layout already owns the collection).
+
 ### The `documents` layout — parallel documents, one per top tab
 
 `tabs` are views over ONE shared data pool. When the ask is "several
@@ -428,9 +469,39 @@ 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`.
-Inside `documents`, blocks work as in `panel`; `chat` blocks and `file`
-fields are not supported there (both are app-wide, not per-document) and
-throw at creation.
+
+Inside `documents`, blocks work as in `panel` — **including `chat` and
+`file`, which become per-document**:
+
+- A `chat` block inside `documents` gives **each document its own
+  conversation**, persisted with that document (`data.chat` is scoped). Its
+  `system` function receives the document's data, so the copilot talks
+  about THIS document. One chat block per document (a second throws).
+- A `file` field inside `documents` scopes `ctx.files[key]` to the active
+  document — two documents never collide on the same field key. As
+  everywhere, the live `File` is memory-only: metadata survives reload,
+  the file is re-picked per document.
+
+That combination — one file plus one conversation per tab — is the
+multi-document annotator shape (PDFs, images, CSVs) declared in full:
+
+```js
+ArtifactKit.createApp({
+  title: "Anotador de archivos",
+  layout: "documents",
+  documents: {
+    label: "archivo",
+    title: (d) => (d.archivo && d.archivo.name) || "Sin archivo",
+    blocks: [
+      { fields: [{ key: "archivo", label: "Archivo", type: "file" }] },
+      { custom: (ctx) => { /* render ctx.files.archivo */ }, fill: true },
+      { title: "Copiloto", chat: {
+          system: (d) => "Ayudás con el archivo " + ((d.archivo && d.archivo.name) || "(ninguno)"),
+      }},
+    ],
+  },
+})
+```
 
 ### External libraries, uploaded files, full-bleed custom, viewer identity
 

package/dist/index.esm.js

@@ -1072,6 +1072,13 @@ function Summary({ spec, records }) {
 function ListScreen({ spec, ctx }) {
   const label = spec.label || "item";
   const [query, setQuery] = useState("");
+  useEffect(() => {
+    if ((ctx.data.records || []).some((r) => r && !r.id)) {
+      ctx.update((d) => {
+        for (const r of d.records || []) if (r && !r.id) r.id = makeId();
+      });
+    }
+  });
   let records = ctx.data.records.map((r) => withComputed(spec, r));
   if (spec.sort) records = records.slice().sort(spec.sort);
   const total = records.length;
@@ -1253,6 +1260,38 @@ function ItemsEditor({ spec, ctx, record }) {
     )
   );
 }
+function aliasRecords(d, key) {
+  if (key === "records") return d;
+  return new Proxy(d, {
+    get: (t, p, r) => p === "records" ? t[key] : Reflect.get(t, p, r),
+    set: (t, p, v) => Reflect.set(t, p === "records" ? key : p, v),
+    has: (t, p) => p === "records" ? key in t : p in t
+  });
+}
+function RecordsBlock({ spec, ctx }) {
+  const rspec = spec.records;
+  const key = rspec.key || "records";
+  const arr = Array.isArray(ctx.data[key]) ? ctx.data[key] : [];
+  const stateKey = "caf:rec:" + key;
+  const openId = ctx.view.tabs ? ctx.view.tabs[stateKey] : void 0;
+  const scoped = {
+    ...ctx,
+    data: { ...ctx.data, records: arr },
+    update: (fn) => ctx.update((d) => fn(aliasRecords(d, key))),
+    go: (_screen, id) => ctx.setTab(stateKey, id),
+    back: () => ctx.setTab(stateKey, void 0)
+  };
+  const record = openId ? arr.find((r) => r.id === openId) : null;
+  return createElement(
+    "div",
+    { className: "caf-records-block" },
+    spec.title ? createElement("h2", { className: "caf-block-title" }, spec.title) : null,
+    record ? createElement(DetailScreen, { key: "d", spec: rspec, ctx: scoped, record }) : [
+      createElement(Summary, { key: "s", spec: rspec, records: arr.map((r) => withComputed(rspec, r)) }),
+      createElement(ListScreen, { key: "l", spec: rspec, ctx: scoped })
+    ]
+  );
+}
 function RecordsLayout({ spec, ctx }) {
   const rspec = spec.records;
   if (ctx.view.screen === "record") {
@@ -1358,6 +1397,8 @@ 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 RECORDS_KEYS = ["label", "fields", "title", "subtitle", "sort", "summary", "empty", "search", "compute", "items", "actions"];
+var ITEMS_KEYS = ["label", "fields", "empty"];
 function checkFields(fields, where) {
   for (const f of fields || []) {
     if (!f || !f.key) throw new Error(`claude-artifact-framework: every field in ${where} needs a \`key\`.`);
@@ -1419,10 +1460,10 @@ function checkBlocks(blocks) {
       throw new Error(`claude-artifact-framework: blocks[${i}] must be an object like { fields: [...] }.`);
     }
     const keys = Object.keys(block).filter((k) => !RESERVED.includes(k));
-    const known = keys.filter((k) => BLOCK_NAMES.includes(k) || k === "tabs");
+    const known = keys.filter((k) => BLOCK_NAMES.includes(k) || k === "tabs" || k === "records");
     if (known.length === 0) {
       throw new Error(
-        `claude-artifact-framework: blocks[${i}] has no recognised block type (found: ${keys.join(", ") || "nothing"}). Valid block types: ${BLOCK_NAMES.join(", ")}.`
+        `claude-artifact-framework: blocks[${i}] has no recognised block type (found: ${keys.join(", ") || "nothing"}). Valid block types: ${[...BLOCK_NAMES, "tabs", "records"].join(", ")}.`
       );
     }
     if (known.length > 1) {
@@ -1435,6 +1476,7 @@ function checkBlocks(blocks) {
     checkFields(block.fields, `blocks[${i}]`);
     if (known[0] === "actions") checkActions(block.actions, `blocks[${i}].actions`);
     if (known[0] === "chat") checkChatConfig(block.chat, `blocks[${i}].chat`);
+    if (known[0] === "records") checkRecordsSpec(block.records, `blocks[${i}].records`, true);
     if (known[0] === "tabs") {
       const tabs = block.tabs;
       if (!Array.isArray(tabs) || tabs.length === 0) {
@@ -1525,12 +1567,14 @@ function validate(spec) {
       }
       checkBlocks(spec.sidebar);
     }
-    const chats = flattenBlocks([...spec.main, ...spec.sidebar || []]).filter((b) => b && b.chat);
+    const wsFlat = flattenBlocks([...spec.main, ...spec.sidebar || []]);
+    const chats = wsFlat.filter((b) => b && b.chat);
     if (chats.length > 1) {
       throw new Error(
         "claude-artifact-framework: only one chat block per app \u2014 the conversation persists under data.chat and there is exactly one."
       );
     }
+    checkRecordsBlockKeys(wsFlat);
     return layout;
   }
   if (layout === "documents") {
@@ -1550,82 +1594,104 @@ function validate(spec) {
       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 flat = flattenBlocks(d.blocks);
-    if (flat.some((b) => b && b.chat)) {
-      throw new Error(
-        'claude-artifact-framework: a chat block inside "documents" is not supported \u2014 the conversation store is app-wide, not per document.'
-      );
-    }
-    if (flat.some((b) => (b.fields || []).some((f) => f.type === "file"))) {
+    const docFlat = flattenBlocks(d.blocks);
+    const chats = docFlat.filter((b) => b && b.chat);
+    if (chats.length > 1) {
       throw new Error(
-        "claude-artifact-framework: `file` fields live in the flat data pool \u2014 they are not supported inside documents (the live File cannot be scoped per document)."
+        "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."
       );
     }
+    checkRecordsBlockKeys(docFlat);
     return layout;
   }
   if (layout === "records") {
-    const r = spec.records;
-    if (!r || !Array.isArray(r.fields) || r.fields.length === 0) {
+    checkRecordsSpec(spec.records, "records", false);
+    if (spec.blocks) {
+      checkBlocks(spec.blocks);
+      if (flattenBlocks(spec.blocks).some((b) => b && b.records)) {
+        throw new Error(
+          "claude-artifact-framework: a records BLOCK below a records LAYOUT is ambiguous \u2014 the layout already owns the collection. Use panel/workspace/documents to embed records blocks."
+        );
+      }
+    }
+    return layout;
+  }
+  checkBlocks(spec.blocks || []);
+  checkRecordsBlockKeys(flattenBlocks(spec.blocks || []));
+  return layout;
+}
+function checkRecordsSpec(r, where, allowKey) {
+  if (!r || !Array.isArray(r.fields) || r.fields.length === 0) {
+    throw new Error(
+      `claude-artifact-framework: ${where} needs \`records: { fields: [...] }\` \u2014 the same field declarations the fields block uses.`
+    );
+  }
+  const valid = allowKey ? [...RECORDS_KEYS, "key"] : RECORDS_KEYS;
+  const unknownR = Object.keys(r).filter((k) => !valid.includes(k));
+  if (unknownR.length) {
+    throw new Error(
+      `claude-artifact-framework: ${where} has unknown keys (${unknownR.join(", ")}). Valid keys: ${valid.join(", ")}.`
+    );
+  }
+  if (allowKey && r.key !== void 0 && (typeof r.key !== "string" || !r.key)) {
+    throw new Error(`claude-artifact-framework: ${where}.key must be a non-empty string naming the collection in data.`);
+  }
+  checkFields(r.fields, where);
+  if (r.fields.some((f) => f.type === "file") || r.items && r.items.fields.some((f) => f.type === "file")) {
+    throw new Error(
+      "claude-artifact-framework: `file` fields live in the flat data pool (panel blocks or steps) \u2014 they are not supported inside records or items."
+    );
+  }
+  const seen = /* @__PURE__ */ new Set();
+  for (const f of r.fields) {
+    if (f.key === "id") throw new Error('claude-artifact-framework: "id" is reserved on records \u2014 the framework assigns it.');
+    if (seen.has(f.key)) throw new Error(`claude-artifact-framework: duplicate ${where} field key "${f.key}".`);
+    seen.add(f.key);
+  }
+  if (r.actions) checkActions(r.actions, `${where}.actions`);
+  if (r.items) {
+    const unknownI = Object.keys(r.items).filter((k) => !ITEMS_KEYS.includes(k));
+    if (unknownI.length) {
       throw new Error(
-        'claude-artifact-framework: layout "records" needs `records: { fields: [...] }` \u2014 the same field declarations the fields block uses.'
+        `claude-artifact-framework: ${where}.items has unknown keys (${unknownI.join(", ")}). Valid keys: ${ITEMS_KEYS.join(", ")}.`
       );
     }
-    const RECORDS_KEYS = ["label", "fields", "title", "subtitle", "sort", "summary", "empty", "search", "compute", "items", "actions"];
-    const unknownR = Object.keys(r).filter((k) => !RECORDS_KEYS.includes(k));
-    if (unknownR.length) {
+    if (!Array.isArray(r.items.fields) || r.items.fields.length === 0) {
+      throw new Error(`claude-artifact-framework: ${where}.items needs \`fields: [...]\` \u2014 the same field declarations as everywhere else.`);
+    }
+    checkFields(r.items.fields, `${where}.items`);
+    for (const f of r.items.fields) {
+      if (f.key === "id") throw new Error('claude-artifact-framework: "id" is reserved on items \u2014 the framework assigns it.');
+    }
+    if (seen.has("items") || r.fields.some((f) => f.key === "items")) {
+      throw new Error(`claude-artifact-framework: a ${where} field cannot be named "items" when \`items\` is declared \u2014 that key holds the child collection.`);
+    }
+  }
+  for (const [key, c] of Object.entries(r.compute || {})) {
+    if (seen.has(key) || key === "id" || r.items && key === "items") {
       throw new Error(
-        `claude-artifact-framework: records has unknown keys (${unknownR.join(", ")}). Valid keys: ${RECORDS_KEYS.join(", ")}.`
+        `claude-artifact-framework: compute key "${key}" collides with a field key \u2014 computed values are derived, never stored.`
       );
     }
-    checkFields(r.fields, "records");
-    if (r.fields.some((f) => f.type === "file") || r.items && r.items.fields.some((f) => f.type === "file")) {
+    if (typeof c !== "function" && typeof (c && c.value) !== "function") {
       throw new Error(
-        "claude-artifact-framework: `file` fields live in the flat data pool (panel blocks or steps) \u2014 they are not supported inside records or items."
+        `claude-artifact-framework: compute "${key}" must be a function of the record, or { label, format, value: (r) => ... }.`
       );
     }
-    const seen = /* @__PURE__ */ new Set();
-    for (const f of r.fields) {
-      if (f.key === "id") throw new Error('claude-artifact-framework: "id" is reserved on records \u2014 the framework assigns it.');
-      if (seen.has(f.key)) throw new Error(`claude-artifact-framework: duplicate records field key "${f.key}".`);
-      seen.add(f.key);
-    }
-    if (spec.blocks) checkBlocks(spec.blocks);
-    if (r.actions) checkActions(r.actions, "records.actions");
-    if (r.items) {
-      const ITEMS_KEYS = ["label", "fields", "empty"];
-      const unknownI = Object.keys(r.items).filter((k) => !ITEMS_KEYS.includes(k));
-      if (unknownI.length) {
-        throw new Error(
-          `claude-artifact-framework: records.items has unknown keys (${unknownI.join(", ")}). Valid keys: ${ITEMS_KEYS.join(", ")}.`
-        );
-      }
-      if (!Array.isArray(r.items.fields) || r.items.fields.length === 0) {
-        throw new Error("claude-artifact-framework: records.items needs `fields: [...]` \u2014 the same field declarations as everywhere else.");
-      }
-      checkFields(r.items.fields, "records.items");
-      for (const f of r.items.fields) {
-        if (f.key === "id") throw new Error('claude-artifact-framework: "id" is reserved on items \u2014 the framework assigns it.');
-      }
-      if (seen.has("items") || r.fields.some((f) => f.key === "items")) {
-        throw new Error('claude-artifact-framework: a records field cannot be named "items" when `items` is declared \u2014 that key holds the child collection.');
-      }
-    }
-    for (const [key, c] of Object.entries(r.compute || {})) {
-      if (seen.has(key) || key === "id" || r.items && key === "items") {
-        throw new Error(
-          `claude-artifact-framework: compute key "${key}" collides with a field key \u2014 computed values are derived, never stored.`
-        );
-      }
-      if (typeof c !== "function" && typeof (c && c.value) !== "function") {
-        throw new Error(
-          `claude-artifact-framework: compute "${key}" must be a function of the record, or { label, format, value: (r) => ... }.`
-        );
-      }
+  }
+}
+function checkRecordsBlockKeys(flatBlocks) {
+  const seen = /* @__PURE__ */ new Set();
+  for (const b of flatBlocks) {
+    if (!b || !b.records) continue;
+    const k = b.records.key || "records";
+    if (seen.has(k)) {
+      throw new Error(
+        `claude-artifact-framework: two records blocks share the collection key "${k}" \u2014 give each a distinct \`key\`.`
+      );
     }
-    return layout;
+    seen.add(k);
   }
-  checkBlocks(spec.blocks || []);
-  return layout;
 }
 function flattenBlocks(blocks) {
   const out = [];
@@ -1655,6 +1721,12 @@ function defaultsFrom(spec) {
       }
     }
   }
+  for (const b of allBlocks) {
+    if (b && b.records) {
+      const k = b.records.key || "records";
+      if (!Array.isArray(data[k])) data[k] = [];
+    }
+  }
   return data;
 }
 var BlockBoundary = null;
@@ -1716,8 +1788,8 @@ function TabsBlock({ spec, ctx }) {
     )
   );
 }
-var ALL_BLOCKS = { ...BLOCKS, tabs: TabsBlock };
-var ALL_NAMES = [...BLOCK_NAMES, "tabs"];
+var ALL_BLOCKS = { ...BLOCKS, tabs: TabsBlock, records: RecordsBlock };
+var ALL_NAMES = [...BLOCK_NAMES, "tabs", "records"];
 function Block({ block, ctx }) {
   if (typeof block.when === "function" && !block.when(ctx.data)) return null;
   const name = Object.keys(block).find((k) => ALL_NAMES.includes(k));
@@ -1800,6 +1872,10 @@ function docDefaults(dspec) {
         data[field.key] = field.value !== void 0 ? field.value : field.type === "check" ? false : "";
       }
     }
+    if (block.records) {
+      const k = block.records.key || "records";
+      if (!Array.isArray(data[k])) data[k] = [];
+    }
   }
   return data;
 }
@@ -1845,6 +1921,7 @@ function DocumentsLayout({ spec, ctx }) {
     ctx.update((d) => {
       d.docs = d.docs.filter((doc) => doc.id !== id);
     });
+    delete ctx.files["doc:" + id];
     if (active && active.id === id) {
       const next = docs[idx + 1] || docs[idx - 1];
       if (next) ctx.setTab(DOC_TAB_KEY, next.id);
@@ -1869,7 +1946,12 @@ function DocumentsLayout({ spec, ctx }) {
     update: (fn) => ctx.update((d) => {
       const doc = (d.docs || []).find((x) => x.id === active.id);
       if (doc) fn(doc.data);
-    })
+    }),
+    // Live File objects scoped per document: each doc gets its own sub-map,
+    // so two documents with the same file field never collide. Like the flat
+    // pool, the File itself is memory-only — metadata survives reload, the
+    // file is re-picked per document.
+    files: ctx.files["doc:" + active.id] = ctx.files["doc:" + active.id] || {}
   };
   return createElement(
     "div",
@@ -2208,6 +2290,7 @@ var BASE_CSS = `
 .caf-doc-close:hover { color: var(--caf-danger); }
 .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-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; }