@jigs.design/runtime 0.1.0 → 0.1.2

package/README.md

@@ -6,10 +6,10 @@ The layer the server and the browser share: the program format, the types on the
 
 ## Entry points
 
-| Entry                        | What it holds                                                                                                                                                                         |
-| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `@jigs.design/runtime`       | `Program`, `SessionEvent`, `Message`, `Diagnostic` and the other shared types; the frame protocol; the JSON checks the browser runs; `createTreeStore`; the image and link allowlists |
-| `@jigs.design/runtime/frame` | The sandbox frame document, its content security policy, and the worker runtime. The server serves it                                                                                 |
+| Entry                        | What it holds                                                                                                                                                                                                                                                                   |
+| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `@jigs.design/runtime`       | `Program`, `SessionEvent`, `Message`, `Diagnostic` and the other shared types; the frame protocol (`HostMessage`, `FrameMessage`, `Op`); the JSON checks the browser runs; `createTreeStore` with its caps `MAX_NODES`, `MAX_OPS` and `MAX_TEXT`; the image and link allowlists |
+| `@jigs.design/runtime/frame` | The sandbox frame document, its content security policy, the worker runtime, and `WATCHDOG_MS` and `HEARTBEAT_MS`. The server serves it                                                                                                                                         |
 
 ## How a program runs
 
@@ -27,4 +27,4 @@ The server serves the frame document from its route. The frame starts a worker a
 
 ## Docs
 
-[Sandbox](../../apps/docs/docs/react/sandbox.mdx) and [Packages](../../apps/docs/docs/packages/index.mdx).
+[Sandbox](../../apps/docs/docs/react/sandbox.mdx), [Frame protocol](../../apps/docs/docs/renderers/protocol.mdx) and [Packages](../../apps/docs/docs/packages/index.mdx).

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { frameSecurityPolicy } from "./frame-policy.js";
-import { ChatBlock, ChatBlockStatus, ChildrenKind, ComponentSchema, Diagnostic, DiagnosticFix, Invalidation, JsonValue, Message, NumberPropSchema, PROGRAM_FORMAT, PickleErrorCode, PickleErrorData, ProcedureEntry, ProcedureKind, Program, PropSchema, SessionBody, SessionEvent, SessionOptions, Span, pickleErrorCodes } from "./types.js";
+import { ChatBlock, ChatBlockStatus, ChildrenKind, ComponentSchema, Diagnostic, DiagnosticFix, Invalidation, JigsErrorCode, JigsErrorData, JsonValue, Message, NumberPropSchema, PROGRAM_FORMAT, ProcedureEntry, ProcedureKind, Program, PropSchema, SessionBody, SessionEvent, SessionOptions, Span, jigsErrorCodes } from "./types.js";
 import { FrameMessage, HostMessage, MutationCall, MutationResult, Op, QueryRead, QueryResult, ROOT_ID, Row, RuntimeError, WireArg, WireValue, WorkerMessage } from "./protocol.js";
 import { parseErrorData, parseInvalidations, parseProgram, parseSessionEvent } from "./parse.js";
-import { TreeNode, TreeStore, createTreeStore } from "./tree-store.js";
+import { MAX_NODES, MAX_OPS, MAX_TEXT, TreeNode, TreeStore, createTreeStore } from "./tree-store.js";
 import { isAllowedImage, isAllowedLink, isImageHostEntry, normalizeImageHost } from "./urls.js";
-export { type ChatBlock, type ChatBlockStatus, type ChildrenKind, type ComponentSchema, type Diagnostic, type DiagnosticFix, type FrameMessage, type HostMessage, type Invalidation, type JsonValue, type Message, type MutationCall, type MutationResult, type NumberPropSchema, type Op, PROGRAM_FORMAT, type PickleErrorCode, type PickleErrorData, type ProcedureEntry, type ProcedureKind, type Program, type PropSchema, type QueryRead, type QueryResult, ROOT_ID, type Row, type RuntimeError, type SessionBody, type SessionEvent, type SessionOptions, type Span, type TreeNode, type TreeStore, type WireArg, type WireValue, type WorkerMessage, createTreeStore, frameSecurityPolicy, isAllowedImage, isAllowedLink, isImageHostEntry, normalizeImageHost, parseErrorData, parseInvalidations, parseProgram, parseSessionEvent, pickleErrorCodes };
+export { type ChatBlock, type ChatBlockStatus, type ChildrenKind, type ComponentSchema, type Diagnostic, type DiagnosticFix, type FrameMessage, type HostMessage, type Invalidation, type JigsErrorCode, type JigsErrorData, type JsonValue, MAX_NODES, MAX_OPS, MAX_TEXT, type Message, type MutationCall, type MutationResult, type NumberPropSchema, type Op, PROGRAM_FORMAT, type ProcedureEntry, type ProcedureKind, type Program, type PropSchema, type QueryRead, type QueryResult, ROOT_ID, type Row, type RuntimeError, type SessionBody, type SessionEvent, type SessionOptions, type Span, type TreeNode, type TreeStore, type WireArg, type WireValue, type WorkerMessage, createTreeStore, frameSecurityPolicy, isAllowedImage, isAllowedLink, isImageHostEntry, jigsErrorCodes, normalizeImageHost, parseErrorData, parseInvalidations, parseProgram, parseSessionEvent };

package/dist/index.js

@@ -1,7 +1,7 @@
-import { PROGRAM_FORMAT, pickleErrorCodes } from "./types.js";
+import { PROGRAM_FORMAT, jigsErrorCodes } from "./types.js";
 import { ROOT_ID } from "./protocol.js";
 import { frameSecurityPolicy } from "./frame-policy.js";
 import { parseErrorData, parseInvalidations, parseProgram, parseSessionEvent } from "./parse.js";
 import { isAllowedImage, isAllowedLink, isImageHostEntry, normalizeImageHost } from "./urls.js";
-import { createTreeStore } from "./tree-store.js";
-export { PROGRAM_FORMAT, ROOT_ID, createTreeStore, frameSecurityPolicy, isAllowedImage, isAllowedLink, isImageHostEntry, normalizeImageHost, parseErrorData, parseInvalidations, parseProgram, parseSessionEvent, pickleErrorCodes };
+import { MAX_NODES, MAX_OPS, MAX_TEXT, createTreeStore } from "./tree-store.js";
+export { MAX_NODES, MAX_OPS, MAX_TEXT, PROGRAM_FORMAT, ROOT_ID, createTreeStore, frameSecurityPolicy, isAllowedImage, isAllowedLink, isImageHostEntry, jigsErrorCodes, normalizeImageHost, parseErrorData, parseInvalidations, parseProgram, parseSessionEvent };

package/dist/parse.d.ts

@@ -1,6 +1,6 @@
-import { Invalidation, PickleErrorData, Program, SessionEvent } from "./types.js";
+import { Invalidation, JigsErrorData, Program, SessionEvent } from "./types.js";
 //#region src/parse.d.ts
-export declare function parseErrorData(value: unknown): PickleErrorData | null;
+export declare function parseErrorData(value: unknown): JigsErrorData | null;
 /** The `invalidate` list of a mutation's reply. */
 export declare function parseInvalidations(value: unknown): ReadonlyArray<Invalidation> | null;
 export declare function parseProgram(value: unknown): Program | null;

package/dist/parse.js

@@ -1,4 +1,4 @@
-import { pickleErrorCodes } from "./types.js";
+import { jigsErrorCodes } from "./types.js";
 //#region src/parse.ts
 const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 const isString = (value) => typeof value === "string";
@@ -13,7 +13,7 @@ function recordOf(value, item) {
 	}
 	return out;
 }
-const isErrorCode = (value) => pickleErrorCodes.some((code) => code === value);
+const isErrorCode = (value) => jigsErrorCodes.some((code) => code === value);
 function parseErrorData(value) {
 	if (!isRecord(value) || !isErrorCode(value.code) || !isString(value.message)) return null;
 	return {

package/dist/protocol.d.ts

@@ -1,4 +1,4 @@
-import { PickleErrorData, ProcedureEntry } from "./types.js";
+import { JigsErrorData, ProcedureEntry } from "./types.js";
 //#region src/protocol.d.ts
 /**
  * Prop value on the wire. Functions never leave the worker; they travel as
@@ -56,7 +56,7 @@ export type QueryResult = {
   status: "success";
 } | {
   data: null;
-  error: PickleErrorData;
+  error: JigsErrorData;
   status: "error";
 };
 /** How a mutation settled. */
@@ -64,7 +64,7 @@ export type MutationResult = {
   data: unknown;
   status: "success";
 } | {
-  error: PickleErrorData;
+  error: JigsErrorData;
   status: "error";
 };
 /** A query the program read during a render. `key` is stable for a name and input. */

package/dist/runtime-core.d.ts

@@ -11,7 +11,7 @@ export interface Runtime {
  * and fine). `FunctionCtor` is passed in because the worker removes dynamic
  * code evaluation from its globals before any program runs.
  *
- * A small React-style reconciler: programs build a tree with `__pickle.jsx`,
+ * A small React-style reconciler: programs build a tree with `__jigs.jsx`,
  * the runtime diffs it against the previous render by position and type, and
  * posts the differences as `Op`s. Each render also reports the queries it read
  * and the mutations its handlers called; the page runs those through the

package/dist/runtime-core.js

@@ -7,7 +7,7 @@
 * and fine). `FunctionCtor` is passed in because the worker removes dynamic
 * code evaluation from its globals before any program runs.
 *
-* A small React-style reconciler: programs build a tree with `__pickle.jsx`,
+* A small React-style reconciler: programs build a tree with `__jigs.jsx`,
 * the runtime diffs it against the previous render by position and type, and
 * posts the differences as `Op`s. Each render also reports the queries it read
 * and the mutations its handlers called; the page runs those through the
@@ -244,7 +244,7 @@ function createRuntime(post, FunctionCtor) {
 			status: state.status
 		});
 	};
-	const Pickle = Object.freeze({
+	const Jigs = Object.freeze({
 		render: (element) => {
 			rootElement = element;
 		},
@@ -325,7 +325,7 @@ function createRuntime(post, FunctionCtor) {
 			componentDepth--;
 		}
 	};
-	const pickle = Object.freeze({
+	const jigs = Object.freeze({
 		call: callComponent,
 		each,
 		Fragment: FRAGMENT,
@@ -335,7 +335,7 @@ function createRuntime(post, FunctionCtor) {
 			type
 		})
 	});
-	const pickleSafe = (evaluate, fallback, line) => {
+	const jigsSafe = (evaluate, fallback, line) => {
 		try {
 			return evaluate();
 		} catch (error) {
@@ -591,7 +591,7 @@ function createRuntime(post, FunctionCtor) {
 		reads = /* @__PURE__ */ new Map();
 		const next = [];
 		try {
-			run(Pickle, pickle, pickleSafe);
+			run(Jigs, jigs, jigsSafe);
 			expand(rootElement, next);
 		} catch (error) {
 			reads = previousReads;
@@ -682,7 +682,7 @@ function createRuntime(post, FunctionCtor) {
 				unstableSites.clear();
 				querySites = /* @__PURE__ */ new Map();
 				try {
-					candidate = new FunctionCtor("Pickle", "__pickle", "__pickleSafe", message.code);
+					candidate = new FunctionCtor("Jigs", "__jigs", "__jigsSafe", message.code);
 				} catch (error) {
 					prose = previousProse;
 					procedures = previousProcedures;

package/dist/tree-store.d.ts

@@ -22,6 +22,23 @@ export interface TreeStore {
   setSchemas: (schemas: TreeSchemas) => void;
   subscribe: (listener: () => void) => () => void;
 }
+/**
+ * Most nodes a tree may hold, the root aside. The runtime refuses to render
+ * more (it keeps its own copy of the number), so only a worker that broke out
+ * of the runtime gets past it here, and the store drops the creates over it.
+ * The count is what a whole message leaves: the runtime may create a row's
+ * new nodes before it removes the old ones further on, so mid-message the
+ * store may hold up to twice this (`MAX_DRAFT_NODES`).
+ */
+export declare const MAX_NODES = 10000;
+/**
+ * Most ops one message may carry. A render of `MAX_NODES` nodes needs at most
+ * three per node (remove the old one, create and place the new one), so the
+ * runtime stays under it; a message over it is dropped whole.
+ */
+export declare const MAX_OPS: number;
+/** Longest text a text node may hold, in UTF-16 code units, as for a string prop. */
+export declare const MAX_TEXT = 10000;
 /**
  * The page's copy of the sandboxed UI, built from worker ops. Ops are
  * untrusted: components the program did not declare and props that fail

package/dist/types.d.ts

@@ -5,11 +5,11 @@
  */
 /** The version of the program format. The runtime refuses any other. */
 export declare const PROGRAM_FORMAT = 1;
-export declare const pickleErrorCodes: readonly ["BAD_INPUT", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "RATE_LIMITED", "INTERNAL", "UNKNOWN_PROCEDURE", "UNAVAILABLE", "NETWORK", "DECLINED"];
-export type PickleErrorCode = (typeof pickleErrorCodes)[number];
+export declare const jigsErrorCodes: readonly ["BAD_INPUT", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "RATE_LIMITED", "INTERNAL", "UNKNOWN_PROCEDURE", "UNAVAILABLE", "NETWORK", "DECLINED"];
+export type JigsErrorCode = (typeof jigsErrorCodes)[number];
 /** A failure as the spec and the browser see it. */
-export interface PickleErrorData {
-  code: PickleErrorCode;
+export interface JigsErrorData {
+  code: JigsErrorCode;
   message: string;
 }
 /**
@@ -125,7 +125,7 @@ export type SessionEvent = {
   source: string;
   type: "done";
 } | {
-  error: PickleErrorData;
+  error: JigsErrorData;
   type: "error";
 };
 /**
@@ -134,7 +134,7 @@ export type SessionEvent = {
  */
 export type ChatBlockStatus = "done" | "repairing" | "streaming";
 /**
- * A pickle in a chat reply: one fenced `pickle` block, compiled on its own.
+ * A jig in a chat reply: one fenced `jigs` block, compiled on its own.
  * The server sends it again whenever its program changes, under the same
  * `key`.
  */
@@ -142,7 +142,7 @@ export interface ChatBlock {
   /** Lines refer to `source`, which starts with its pragma line. */
   diagnostics: ReadonlyArray<Diagnostic>;
   /** Set when the block could not be built, e.g. an edit to a missing UI. */
-  error?: PickleErrorData;
+  error?: JigsErrorData;
   /** The id the model gave the block, e.g. "monthly-spending". */
   id: string;
   /** `${id}@${version}`: unique in a conversation. */

package/dist/types.js

@@ -5,7 +5,7 @@
 */
 /** The version of the program format. The runtime refuses any other. */
 const PROGRAM_FORMAT = 1;
-const pickleErrorCodes = [
+const jigsErrorCodes = [
 	"BAD_INPUT",
 	"UNAUTHORIZED",
 	"FORBIDDEN",
@@ -19,4 +19,4 @@ const pickleErrorCodes = [
 	"DECLINED"
 ];
 //#endregion
-export { PROGRAM_FORMAT, pickleErrorCodes };
+export { PROGRAM_FORMAT, jigsErrorCodes };

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@jigs.design/runtime",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "The program format, the types the server and the browser share, the sandboxed runtime, and the tree store.",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/yoamomonstruos/pickle.git",
+    "url": "git+https://github.com/yoamomonstruos/jigs.git",
     "directory": "packages/runtime"
   },
   "type": "module",