yaml-flow 4.0.0 → 5.0.0

package/browser/live-cards.schema.json

@@ -1,15 +1,13 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://nsreehari.github.io/boards/live-cards.schema.json",
-  "title": "LiveCards Node Schema",
-  "description": "Schema for Card and ExternalSource nodes in the LiveCards Board/Canvas engine",
 
   "definitions": {
 
     "bind_ref": {
-      "description": "A state path reference, e.g. 'state.raw_quotes' or 'requires.upstream'",
+      "description": "A card data path reference, e.g. 'card_data.raw_quotes' or 'requires.upstream'",
       "type": "string",
-      "pattern": "^(state|requires|computed_values)\\."
+      "pattern": "^(card_data|requires|fetched_sources|computed_values)(\\.|$)"
     },
 
     "bind_or_literal": {
@@ -46,7 +44,7 @@
           ]
         },
         "input": {
-          "description": "state.path, literal, array of inputs, or nested compute_expr",
+          "description": "card_data.path, literal, array of inputs, or nested compute_expr",
           "oneOf": [
             { "type": "string" },
             { "type": "number" },
@@ -85,19 +83,19 @@
         "required": ["bindTo", "src"],
         "properties": {
           "bindTo": { "type": "string", "description": "Token name published downstream" },
-          "src":    { "type": "string", "description": "Path to read value from (state.*, requires.*, computed_values.*)" }
+          "src":    { "type": "string", "description": "Path to read value from (card_data.*, requires.*, fetched_sources.*, computed_values.*)" }
         }
       },
-      "description": "Explicit bindings exposing computed/state values downstream as named tokens"
+      "description": "Explicit bindings exposing computed or card_data values downstream as named tokens"
     },
 
     "compute_step": {
-      "description": "A single ordered compute step: reads state.*/requires.*/computed_values.*, writes to computed_values[bindTo]",
+      "description": "A single ordered compute step: reads card_data.*/requires.*/computed_values.*, writes to computed_values[bindTo]",
       "type": "object",
       "required": ["bindTo", "expr"],
       "properties": {
         "bindTo": { "type": "string", "description": "Key in computed_values to write result" },
-        "expr":   { "type": "string", "description": "JSONata expression evaluated against { state, requires, sources, computed_values }" }
+        "expr":   { "type": "string", "description": "JSONata expression evaluated against { card_data, requires, fetched_sources, computed_values }" }
       }
     },
 
@@ -107,7 +105,7 @@
       "required": ["bindTo"],
       "additionalProperties": true,
       "properties": {
-        "bindTo":     { "type": "string",  "description": "Key under sources.* available in compute expressions" },
+        "bindTo":     { "type": "string",  "description": "Key under fetched_sources.* available in compute expressions" },
         "outputFile": { "type": "string",  "description": "Board-relative path the executor writes its JSON result to. Presence of this file signals delivery." },
         "optionalForCompletionGating":   { "type": "boolean", "default": false, "description": "When true this source does not gate card completion. Default false when absent, so sources are completion-gating by default." },
         "timeout":    { "type": "integer", "minimum": 0, "default": 120000, "description": "Executor/script timeout in ms. Default: 120 000 (2 min)." },
@@ -123,16 +121,16 @@
         "kind":      {
           "enum": ["metric", "table", "chart", "form", "filter", "list",
                    "notes", "todo", "alert", "narrative", "badge", "text",
-                   "markdown", "custom", "file-upload", "chat", "actions"]
+                   "markdown", "custom", "actions"]
         },
         "label":     { "type": "string", "description": "Heading above this element" },
         "className": { "type": "string", "description": "Bootstrap grid class, e.g. 'col-12 col-md-6'" },
-        "visible":   { "type": "string", "description": "state path — element shown only if truthy" },
+        "visible":   { "type": "string", "description": "card_data/requires/fetched_sources/computed_values path — element shown only if truthy" },
         "data": {
           "type": "object",
           "properties": {
-            "bind":        { "$ref": "#/definitions/bind_ref", "description": "state path to read data from" },
-            "writeTo":     { "$ref": "#/definitions/bind_ref", "description": "state path for user input (form, filter, todo, notes)" },
+            "bind":        { "$ref": "#/definitions/bind_ref", "description": "card_data/requires/fetched_sources/computed_values path to read data from" },
+            "writeTo":     { "$ref": "#/definitions/bind_ref", "description": "card_data path for user input (form, filter, todo, notes)" },
             "columns":     { "type": "array", "items": { "type": "string" }, "description": "table: visible columns" },
             "maxRows":     { "type": "integer", "description": "table/list: max rows to display" },
             "sortable":    { "type": "boolean", "default": true, "description": "table: enable click-to-sort" },
@@ -165,7 +163,7 @@
                   "label":    { "type": "string" },
                   "style":    { "type": "string", "description": "Bootstrap button variant, e.g. 'success', 'outline-danger'" },
                   "size":     { "type": "string", "default": "sm" },
-                  "disabled": { "oneOf": [{ "type": "boolean" }, { "type": "string", "description": "state path — truthy = disabled" }] }
+                  "disabled": { "oneOf": [{ "type": "boolean" }, { "type": "string", "description": "card_data/requires/fetched_sources/computed_values path — truthy = disabled" }] }
                 }
               }
             }
@@ -227,12 +225,39 @@
     "provides": { "$ref": "#/definitions/provides" },
     "meta":     { "$ref": "#/definitions/meta" },
     "view":     { "$ref": "#/definitions/view" },
-    "state":    { "type": "object", "additionalProperties": true,
+    "card_data": {
+      "type": "object",
+      "description": "Authored card data supplied in the card definition",
       "properties": {
-        "status":  { "enum": ["fresh", "stale", "loading", "error"] },
-        "lastRun": { "type": "string", "format": "date-time" },
-        "error":   { "type": "string" }
-      }
+        "files": {
+          "type": "array",
+          "description": "Optional uploaded-file metadata maintained by host handlers. Stored name is normalized and serial-prefixed (for example 001-my_file.pdf).",
+          "items": {
+            "type": "object",
+            "required": ["name", "stored_name"],
+            "properties": {
+              "name": { "type": "string", "minLength": 1 },
+              "stored_name": {
+                "type": "string",
+                "minLength": 5,
+                "maxLength": 32,
+                "pattern": "^[0-9]{3,}-[a-z0-9._-]+$"
+              },
+              "size": {
+                "oneOf": [
+                  { "type": "integer", "minimum": 0 },
+                  { "type": "null" }
+                ]
+              },
+              "mime_type": { "type": "string" },
+              "path": { "type": "string", "pattern": "^[^\\s]+/files/[0-9]{3,}-[a-z0-9._-]+$" },
+              "uploaded_at": { "type": "string", "format": "date-time" }
+            },
+            "additionalProperties": false
+          }
+        }
+      },
+      "additionalProperties": true
     },
     "sources": {
       "type": "array",
@@ -241,7 +266,7 @@
     },
     "compute": {
       "type": "array",
-      "description": "Ordered array of compute steps. Each reads state.*/requires.*/sources.*/computed_values.* and writes to ephemeral computed_values[bindTo].",
+      "description": "Ordered array of compute steps. Each reads card_data.*/requires.*/fetched_sources.*/computed_values.* and writes to ephemeral computed_values[bindTo].",
       "items": { "$ref": "#/definitions/compute_step" }
     }
   }