@optiaxiom/proteus 3.0.6 → 3.2.0

package/dist/esm/schema/runtime-schema.js

@@ -918,6 +918,7 @@ var definitions = {
 						{ "type": "number" },
 						{ "type": "boolean" },
 						{ "type": "null" },
+						{ "$ref": "#/definitions/ProteusDataTableRow" },
 						{ "$ref": "#/definitions/ProteusLength" },
 						{ "$ref": "#/definitions/ProteusMapIndex" },
 						{ "$ref": "#/definitions/ProteusValue" }
@@ -937,6 +938,7 @@ var definitions = {
 						{ "type": "number" },
 						{ "type": "boolean" },
 						{ "type": "null" },
+						{ "$ref": "#/definitions/ProteusDataTableRow" },
 						{ "$ref": "#/definitions/ProteusLength" },
 						{ "$ref": "#/definitions/ProteusMapIndex" },
 						{ "$ref": "#/definitions/ProteusValue" }
@@ -956,6 +958,7 @@ var definitions = {
 						{ "type": "number" },
 						{ "type": "boolean" },
 						{ "type": "null" },
+						{ "$ref": "#/definitions/ProteusDataTableRow" },
 						{ "$ref": "#/definitions/ProteusLength" },
 						{ "$ref": "#/definitions/ProteusMapIndex" },
 						{ "$ref": "#/definitions/ProteusValue" }
@@ -975,6 +978,7 @@ var definitions = {
 						{ "type": "number" },
 						{ "type": "boolean" },
 						{ "type": "null" },
+						{ "$ref": "#/definitions/ProteusDataTableRow" },
 						{ "$ref": "#/definitions/ProteusLength" },
 						{ "$ref": "#/definitions/ProteusMapIndex" },
 						{ "$ref": "#/definitions/ProteusValue" }
@@ -994,6 +998,7 @@ var definitions = {
 						{ "type": "number" },
 						{ "type": "boolean" },
 						{ "type": "null" },
+						{ "$ref": "#/definitions/ProteusDataTableRow" },
 						{ "$ref": "#/definitions/ProteusLength" },
 						{ "$ref": "#/definitions/ProteusMapIndex" },
 						{ "$ref": "#/definitions/ProteusValue" }
@@ -1013,6 +1018,7 @@ var definitions = {
 						{ "type": "number" },
 						{ "type": "boolean" },
 						{ "type": "null" },
+						{ "$ref": "#/definitions/ProteusDataTableRow" },
 						{ "$ref": "#/definitions/ProteusLength" },
 						{ "$ref": "#/definitions/ProteusMapIndex" },
 						{ "$ref": "#/definitions/ProteusValue" }
@@ -1031,6 +1037,7 @@ var definitions = {
 						{ "type": "number" },
 						{ "type": "boolean" },
 						{ "type": "null" },
+						{ "$ref": "#/definitions/ProteusDataTableRow" },
 						{ "$ref": "#/definitions/ProteusLength" },
 						{ "$ref": "#/definitions/ProteusMapIndex" },
 						{ "$ref": "#/definitions/ProteusValue" }
@@ -1047,6 +1054,7 @@ var definitions = {
 						{ "type": "number" },
 						{ "type": "boolean" },
 						{ "type": "null" },
+						{ "$ref": "#/definitions/ProteusDataTableRow" },
 						{ "$ref": "#/definitions/ProteusLength" },
 						{ "$ref": "#/definitions/ProteusMapIndex" },
 						{ "$ref": "#/definitions/ProteusValue" }
@@ -1197,6 +1205,32 @@ var definitions = {
 					"gap": "16"
 				}],
 				"title": "Create Test Plan"
+			},
+			{
+				"$type": "Document",
+				"actions": [{
+					"$type": "Action",
+					"appearance": "primary",
+					"children": "Greet",
+					"onClick": {
+						"params": { "name": {
+							"$type": "Value",
+							"path": "/name"
+						} },
+						"script": "main:greet"
+					}
+				}],
+				"appName": "Opal",
+				"body": [{
+					"$type": "Field",
+					"children": {
+						"$type": "Input",
+						"name": "name"
+					},
+					"label": "Your name"
+				}],
+				"scripts": { "main": "register('greet', (ctx) => ctx.emit({ message: `Hello, ${ctx.params.name}!` }))" },
+				"title": "Scripted Greeting"
 			}
 		],
 		"properties": {
@@ -1239,6 +1273,11 @@ var definitions = {
 				"type": "object"
 			},
 			"meta": { "description": "Additional metadata not directly consumed by Proteus. Use this to pass along any extra data." },
+			"scripts": {
+				"additionalProperties": { "type": "string" },
+				"description": "Map of module name to JavaScript source. Each module runs in a sandboxed Web Worker and registers named handlers via `register(name, fn)`. Trigger a handler from any event source with `{ script: 'module:handler', params }`; handlers receive a single `ctx` ({ emit, getValue, params }) and can only affect the document by emitting the existing Proteus events through `ctx.emit`.",
+				"type": "object"
+			},
 			"subtitle": {
 				"$ref": "#/definitions/ProteusNode",
 				"description": "A brief description or tagline that provides additional context about the Proteus document's purpose."
@@ -1270,6 +1309,7 @@ var definitions = {
 			{ "$ref": "#/definitions/ProteusChart" },
 			{ "$ref": "#/definitions/ProteusConcat" },
 			{ "$ref": "#/definitions/ProteusDataTable" },
+			{ "$ref": "#/definitions/ProteusDataTableRow" },
 			{ "$ref": "#/definitions/ProteusDateInput" },
 			{ "$ref": "#/definitions/ProteusDisclosure" },
 			{ "$ref": "#/definitions/ProteusDisclosureContent" },
@@ -1324,6 +1364,22 @@ var definitions = {
 				"required": ["interaction"],
 				"type": "object"
 			},
+			{
+				"description": "Scripted action - runs a named handler from the document's `scripts` map in a sandboxed Web Worker. The handler can emit the other Proteus events via `ctx.emit`.",
+				"properties": {
+					"params": {
+						"additionalProperties": {},
+						"description": "Parameters passed to the handler as `ctx.params`. Values can be ProteusExpressions that resolve at call time.",
+						"type": "object"
+					},
+					"script": {
+						"description": "Handler to run, addressed as `module:handler` (the module key comes from the document's `scripts` map).",
+						"type": "string"
+					}
+				},
+				"required": ["script"],
+				"type": "object"
+			},
 			{
 				"description": "Client-side message action",
 				"properties": { "message": {
@@ -1421,12 +1477,30 @@ var definitions = {
 				},
 				"required": ["action", "path"],
 				"type": "object"
+			},
+			{
+				"description": "Runtime data operation - writes `value` at `path` in form data, replacing any existing value (e.g. `/tags/2`). Path resolves like `Value` (absolute `/x`, relative to current parentPath, or `''` for parentPath itself).",
+				"properties": {
+					"action": {
+						"const": "setValue",
+						"description": "The action type",
+						"type": "string"
+					},
+					"path": {
+						"description": "JSON pointer path to write to",
+						"type": "string"
+					},
+					"value": { "description": "The value to write; primitives or objects" }
+				},
+				"required": ["action", "path"],
+				"type": "object"
 			}
 		],
 		"description": "Handler for user interactions - a server-side interaction call, client-side message, or client-side component action"
 	},
 	"ProteusExpression": {
 		"anyOf": [
+			{ "$ref": "#/definitions/ProteusDataTableRow" },
 			{ "$ref": "#/definitions/ProteusLength" },
 			{ "$ref": "#/definitions/ProteusMap" },
 			{ "$ref": "#/definitions/ProteusMapIndex" },
@@ -2447,6 +2521,10 @@ var definitions = {
 							"description": "Key in data objects",
 							"type": "string"
 						},
+						"cell": {
+							"$ref": "#/definitions/ProteusNode",
+							"description": "A Proteus node template rendered for each cell in this column. Read the current row with DataTableRow (e.g. { $type: 'DataTableRow', path: 'status' } reads the row's 'status', or omit 'path' for the whole row). Can be a single element or an array — use Show elements to conditionally render (e.g. a Badge whose intent depends on the row value). When set, takes precedence over 'format'."
+						},
 						"format": {
 							"anyOf": [{
 								"description": "Formatter name",
@@ -2489,6 +2567,21 @@ var definitions = {
 		"required": ["$type"],
 		"type": "object"
 	},
+	"ProteusDataTableRow": {
+		"examples": [{
+			"$type": "DataTableRow",
+			"path": "status"
+		}],
+		"properties": {
+			"$type": { "const": "DataTableRow" },
+			"path": {
+				"description": "JSON pointer path to a field within the current row (e.g. 'status' or '/status'). When omitted, resolves to the whole row object. Only meaningful inside a DataTable column's `cell`.",
+				"type": "string"
+			}
+		},
+		"required": ["$type"],
+		"type": "object"
+	},
 	"ProteusDateInput": {
 		"examples": [{
 			"$type": "DateInput",
@@ -4221,6 +4314,10 @@ var definitions = {
 				"$ref": "#/definitions/ProteusNode",
 				"description": "Content to show when condition is true"
 			},
+			"else": {
+				"$ref": "#/definitions/ProteusNode",
+				"description": "Content to render when the condition is false. Omitting it renders nothing. Chain nested Show/else to express multi-way choices (e.g. mapping a value to one of several outputs)."
+			},
 			"when": {
 				"anyOf": [{ "$ref": "#/definitions/ProteusCondition" }, {
 					"items": { "$ref": "#/definitions/ProteusCondition" },

package/dist/index.d.ts

@@ -64,6 +64,21 @@ declare namespace ProteusChart {
   var displayName: string;
 }
 //#endregion
+//#region src/proteus-data-table-row/ProteusDataTableRow.d.ts
+type ProteusDataTableRowProps = {
+  /**
+   * JSON pointer path to a field within the current row (e.g. `type` or
+   * `/type`). When omitted, resolves to the whole row object.
+   */
+  path?: string;
+};
+declare function ProteusDataTableRow({
+  path
+}: ProteusDataTableRowProps): string | null;
+declare namespace ProteusDataTableRow {
+  var displayName: string;
+}
+//#endregion
 //#region src/proteus-data-table/ProteusDataTable.d.ts
 type ProteusDataTableProps = {
   /**
@@ -77,6 +92,12 @@ type ProteusDataTableProps = {
 };
 type ColumnDef = {
   accessorKey: string;
+  /**
+   * Renders a cell for this column from the row's data. When set, takes
+   * precedence over `format`. Wired up from a Proteus `cell` template by
+   * `ProteusElement`.
+   */
+  cell?: (row: Record<string, unknown>) => ReactNode;
   format?: string | {
     options?: Record<string, unknown>;
     type: string;
@@ -348,6 +369,9 @@ type ProteusCondition = {
   or: ProteusCondition[];
 };
 type ComparisonValue = boolean | null | number | string | {
+  $type: "DataTableRow";
+  path?: string;
+} | {
   $type: "Length";
   path: string;
 } | {
@@ -360,6 +384,10 @@ type ComparisonValue = boolean | null | number | string | {
 //#region src/proteus-show/ProteusShow.d.ts
 type ProteusShowProps = {
   children?: ReactNode;
+  /**
+   * Content to render when the condition is false. Omitting it renders nothing.
+   */
+  else?: ReactNode;
   /**
    * Single condition or array of conditions (AND logic). Each condition is an
    * object with one operator key.
@@ -368,8 +396,9 @@ type ProteusShowProps = {
 };
 declare function ProteusShow({
   children,
+  else: fallback,
   when
-}: ProteusShowProps): import("react/jsx-runtime").JSX.Element | null;
+}: ProteusShowProps): import("react/jsx-runtime").JSX.Element;
 declare namespace ProteusShow {
   var displayName: string;
 }
@@ -432,6 +461,8 @@ type ProteusDocumentShellProps = Pick<ComponentPropsWithoutRef<typeof Disclosure
   element: ProteusDocument$2;
   /**
    * Map of icon name to React component. Referenced by `{ $type: "Icon", name }` elements.
+   * If `name` is not in the map but starts with `http(s)://` or `data:`, it is
+   * rendered as `<img src={name}>` instead.
    */
   icons?: ProteusIconMap;
   /**
@@ -492,6 +523,7 @@ type ProteusDocument$2 = {
   blocking?: boolean;
   body: ReactNode;
   compact?: boolean;
+  scripts?: Record<string, string>;
   subtitle?: ReactNode;
   title?: ReactNode;
   titleIcon?: string;
@@ -540,11 +572,18 @@ type ProteusEventHandler = {
 } | {
   action: "removeValue";
   path: string;
+} | {
+  action: "setValue";
+  path: string;
+  value?: unknown;
 } | {
   interaction: string;
   params?: Record<string, unknown>;
 } | {
   message: string | StructuredMessage;
+} | {
+  params?: Record<string, unknown>;
+  script: string;
 };
 type ProteusPreviewFile = {
   extension: string;
@@ -619,6 +658,7 @@ type ProteusDocument = {
   blocking?: boolean;
   body: unknown;
   compact?: boolean;
+  scripts?: Record<string, string>;
   subtitle?: unknown;
   title?: unknown;
   titleIcon?: string;
@@ -653,4 +693,4 @@ declare namespace ProteusTextarea {
 //#region src/use-proteus-value/useProteusValue.d.ts
 declare function useProteusValue(element: ProteusValueProps): any;
 //#endregion
-export { type FileUploadMetadata, ProteusAction, ProteusBridge, ProteusChart, ProteusDataTable, ProteusDateInput, ProteusDocumentRenderer, ProteusDocumentRendererProps, ProteusDocumentShell, ProteusDocumentShellProps, ProteusFederated, ProteusFileUpload, ProteusFileUploadProps, ProteusImage, ProteusImageCarousel, ProteusInput, ProteusLength, ProteusMap, ProteusMapIndex, ProteusMarkdown, ProteusPillMenu, ProteusPillMenuProps, type ProteusPreviewFile, ProteusRichTextEditor, ProteusSelect, ProteusShow, ProteusTextarea, type StructuredMessage, type UploadFile, safeParseDocument, useProteusValue };
+export { type FileUploadMetadata, ProteusAction, ProteusBridge, ProteusChart, ProteusDataTable, ProteusDataTableRow, ProteusDateInput, ProteusDocumentRenderer, ProteusDocumentRendererProps, ProteusDocumentShell, ProteusDocumentShellProps, ProteusFederated, ProteusFileUpload, ProteusFileUploadProps, ProteusImage, ProteusImageCarousel, ProteusInput, ProteusLength, ProteusMap, ProteusMapIndex, ProteusMarkdown, ProteusPillMenu, ProteusPillMenuProps, type ProteusPreviewFile, ProteusRichTextEditor, ProteusSelect, ProteusShow, ProteusTextarea, type StructuredMessage, type UploadFile, safeParseDocument, useProteusValue };

package/package.json

@@ -7,7 +7,7 @@
     "url": "git+https://github.com/optimizely-axiom/optiaxiom.git"
   },
   "type": "module",
-  "version": "3.0.6",
+  "version": "3.2.0",
   "files": [
     "dist/**",
     "LICENSE"
@@ -41,8 +41,8 @@
     "react-markdown": "^10.1.0",
     "recharts": "^3.8.1",
     "remark-gfm": "^4.0.1",
-    "@optiaxiom/icons": "^1.3.0",
-    "@optiaxiom/react": "^3.1.2"
+    "@optiaxiom/react": "^3.1.4",
+    "@optiaxiom/icons": "^1.3.0"
   },
   "devDependencies": {
     "@emotion/hash": "^0.9.2",