@jigs.design/runtime 0.1.0 → 0.1.1

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

@@ -2,6 +2,6 @@ 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 { 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 JsonValue, MAX_NODES, MAX_OPS, MAX_TEXT, 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 };

package/dist/index.js

@@ -3,5 +3,5 @@ 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, normalizeImageHost, parseErrorData, parseInvalidations, parseProgram, parseSessionEvent, pickleErrorCodes };

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jigs.design/runtime",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "The program format, the types the server and the browser share, the sandboxed runtime, and the tree store.",
   "license": "MIT",
   "repository": {