@jigs.design/react 0.1.1 → 0.1.2

package/README.md

@@ -1,19 +1,19 @@
 # @jigs.design/react
 
-The web renderer. `PickleView` runs a compiled program in a sandboxed frame and draws it with your registry. `usePickleSession` holds a conversation with the server and streams its latest program.
+The web renderer. `JigsView` runs a compiled program in a sandboxed frame and draws it with your registry. `useJigsSession` holds a conversation with the server and streams its latest program.
 
 ```tsx
 import { components } from "@jigs.design/catalog/react";
-import { PickleView, usePickleSession } from "@jigs.design/react";
-import { client } from "./pickle-client";
+import { JigsView, useJigsSession } from "@jigs.design/react";
+import { client } from "./jigs-client";
 
 export function App() {
-	const session = usePickleSession(client);
+	const session = useJigsSession(client);
 	return (
 		<>
 			<button onClick={() => session.send("My open orders")}>Ask</button>
 			{session.program && (
-				<PickleView
+				<JigsView
 					client={client}
 					components={components}
 					documentId={session.documentId}
@@ -25,28 +25,28 @@ export function App() {
 }
 ```
 
-The program runs in a worker inside a frame served by your Pickle route. The frame has no network: queries and mutations go through the client, and every prop is checked against the program's schema before it reaches your component. A new `program` replaces the running one and keeps the state it still declares. `onAction` handles the program's actions after the server checked their input. The view drops an `autoFocus` prop unless you pass `allowAutoFocus`, so a pickle streaming into a chat cannot take the focus. It checks what the worker asks for against the program, since the worker is not trusted.
+The program runs in a worker inside a frame served by your Jigs route. The frame has no network: queries and mutations go through the client, and every prop is checked against the program's schema before it reaches your component. A new `program` replaces the running one and keeps the state it still declares. `onAction` handles the program's actions after the server checked their input. The view drops an `autoFocus` prop unless you pass `allowAutoFocus`, so a jig streaming into a chat cannot take the focus. It checks what the worker asks for against the program, since the worker is not trusted.
 
 ## Exports
 
-| Export                          | What it is                                                                                                               |
-| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| `PickleView`                    | Runs one program and draws it. Takes `client`, `components`, `program`, `onAction`, `showIssues`, `allowAutoFocus`       |
-| `usePickleSession`              | The conversation and its latest program. `initialMessages` resumes one                                                   |
-| `useHandlerSettled`             | For a registry control: changes once the program has answered its events, so it can drop an edit the program refused     |
-| `useLocalValue`, `controlled`   | For a controlled control: a local copy of the program's value that runs ahead of the round trip and drops a refused edit |
-| `Registry`, `RegistryFor`       | The type of a map from catalog names to React components                                                                 |
-| `SessionState`, `PickleSession` | The session's state and the hook's return value                                                                          |
-| `ViewIssue`                     | What `onIssue` receives                                                                                                  |
+| Export                        | What it is                                                                                                               |
+| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `JigsView`                    | Runs one program and draws it. Takes `client`, `components`, `program`, `onAction`, `showIssues`, `allowAutoFocus`       |
+| `useJigsSession`              | The conversation and its latest program. `initialMessages` resumes one                                                   |
+| `useHandlerSettled`           | For a registry control: changes once the program has answered its events, so it can drop an edit the program refused     |
+| `useLocalValue`, `controlled` | For a controlled control: a local copy of the program's value that runs ahead of the round trip and drops a refused edit |
+| `Registry`, `RegistryFor`     | The type of a map from catalog names to React components                                                                 |
+| `SessionState`, `JigsSession` | The session's state and the hook's return value                                                                          |
+| `ViewIssue`                   | What `onIssue` receives                                                                                                  |
 
-It re-exports the shared types from `@jigs.design/runtime`. The frame, its messages and the calls through the client are `createViewController` in `@jigs.design/client`, which `PickleView` is built on; a renderer for another framework starts there.
+It re-exports the shared types from `@jigs.design/runtime`. The frame, its messages and the calls through the client are `createViewController` in `@jigs.design/client`, which `JigsView` is built on; a renderer for another framework starts there.
 
 ## Source
 
-- `src/view/PickleView.tsx`: the view component, on the client's view controller.
+- `src/view/JigsView.tsx`: the view component, on the client's view controller.
 - `src/view/registry.ts`, `src/view/settled.ts`: the registry types and `useHandlerSettled`.
 - `src/view/local-value.ts`: `useLocalValue` and `controlled`, for controls.
-- `src/view/session.ts`, `src/view/usePickleSession.ts`: the session store and its hook.
+- `src/view/session.ts`, `src/view/useJigsSession.ts`: the session store and its hook.
 
 ## Docs
 

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import { controlled, useLocalValue } from "./view/local-value.js";
 import { Registry, RegistryFor } from "./view/registry.js";
-import { PickleView } from "./view/PickleView.js";
+import { JigsView } from "./view/JigsView.js";
 import { useHandlerSettled } from "./view/settled.js";
 import { SessionState } from "./view/session.js";
-import { PickleSession, usePickleSession } from "./view/usePickleSession.js";
+import { JigsSession, useJigsSession } from "./view/useJigsSession.js";
 import { ConfirmFunction, ViewIssue } from "@jigs.design/client";
-import { Diagnostic, Message, PickleErrorCode, PickleErrorData, Program, SessionEvent, SessionOptions, Span } from "@jigs.design/runtime";
-export { type ConfirmFunction, type Diagnostic, type Message, type PickleErrorCode, type PickleErrorData, type PickleSession, PickleView, type Program, type Registry, type RegistryFor, type SessionEvent, type SessionOptions, type SessionState, type Span, type ViewIssue, controlled, useHandlerSettled, useLocalValue, usePickleSession };
+import { Diagnostic, JigsErrorCode, JigsErrorData, Message, Program, SessionEvent, SessionOptions, Span } from "@jigs.design/runtime";
+export { type ConfirmFunction, type Diagnostic, type JigsErrorCode, type JigsErrorData, type JigsSession, JigsView, type Message, type Program, type Registry, type RegistryFor, type SessionEvent, type SessionOptions, type SessionState, type Span, type ViewIssue, controlled, useHandlerSettled, useJigsSession, useLocalValue };

package/dist/index.js

@@ -1,5 +1,5 @@
 import { useHandlerSettled } from "./view/settled.js";
 import { controlled, useLocalValue } from "./view/local-value.js";
-import { PickleView } from "./view/PickleView.js";
-import { usePickleSession } from "./view/usePickleSession.js";
-export { PickleView, controlled, useHandlerSettled, useLocalValue, usePickleSession };
+import { JigsView } from "./view/JigsView.js";
+import { useJigsSession } from "./view/useJigsSession.js";
+export { JigsView, controlled, useHandlerSettled, useJigsSession, useLocalValue };

package/dist/view/{PickleView.d.ts → JigsView.d.ts}

@@ -1,7 +1,7 @@
 import { Registry } from "./registry.js";
-import { ConfirmFunction, PickleClient, ViewIssue } from "@jigs.design/client";
+import { ConfirmFunction, JigsClient, ViewIssue } from "@jigs.design/client";
 import { Program } from "@jigs.design/runtime";
-//#region src/view/PickleView.d.ts
+//#region src/view/JigsView.d.ts
 /** An action as `onAction` receives it; type it with `ActionEvent<typeof host>`. */
 interface ActionLike {
   input: unknown;
@@ -13,14 +13,14 @@ interface ActionLike {
  * keeps its value, unless `documentId` changed with it. A new `client`
  * starts the program over on that client.
  */
-export declare function PickleView<TAction extends ActionLike = ActionLike>(props: {
+export declare function JigsView<TAction extends ActionLike = ActionLike>(props: {
   /**
    * Let the program focus a control when it appears, through the
    * `autoFocus` prop. Default false: in a chat, a UI that streams in would
    * otherwise take the focus from the composer while the user types.
    */
   allowAutoFocus?: boolean;
-  client: PickleClient;
+  client: JigsClient;
   components: Registry;
   /**
    * Which UI `program` is a version of. When it changes, the program starts

package/dist/view/{PickleView.js → JigsView.js}

@@ -3,7 +3,7 @@ import { useEffect, useState, useSyncExternalStore } from "react";
 import { createViewController, missingComponents } from "@jigs.design/client";
 import { ROOT_ID } from "@jigs.design/runtime";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
-//#region src/view/PickleView.tsx
+//#region src/view/JigsView.tsx
 function TreeNodeView(props) {
 	const { components, controller } = props;
 	const getNode = () => controller.store.get(props.id);
@@ -37,7 +37,7 @@ const missingFromRegistry = (program, components) => missingComponents(program,
 * keeps its value, unless `documentId` changed with it. A new `client`
 * starts the program over on that client.
 */
-function PickleView(props) {
+function JigsView(props) {
 	const { program } = props;
 	const [view, setView] = useState(() => ({
 		client: props.client,
@@ -92,15 +92,15 @@ function PickleView(props) {
 			id: ROOT_ID
 		}),
 		showIssues && status.notice !== null && /* @__PURE__ */ jsx("p", {
-			className: "pickle-view-notice",
+			className: "jigs-view-notice",
 			role: "status",
 			children: status.notice
 		}),
 		errors.length + issues.length > 0 && /* @__PURE__ */ jsxs("ul", {
-			className: "pickle-view-errors",
+			className: "jigs-view-errors",
 			children: [errors.map((error, index) => /* @__PURE__ */ jsxs("li", { children: [error.line === null ? "" : `Line ${error.line}: `, error.message] }, `error:${index}:${error.message}`)), issues.map((issue) => /* @__PURE__ */ jsx("li", { children: issue }, `issue:${issue}`))]
 		})
 	] });
 }
 //#endregion
-export { PickleView };
+export { JigsView };

package/dist/view/session.d.ts

@@ -1,5 +1,5 @@
-import { PickleClient } from "@jigs.design/client";
-import { Diagnostic, Message, PickleErrorData, Program, SessionOptions } from "@jigs.design/runtime";
+import { JigsClient } from "@jigs.design/client";
+import { Diagnostic, JigsErrorData, Message, Program, SessionOptions } from "@jigs.design/runtime";
 //#region src/view/session.d.ts
 export interface SessionState {
   diagnostics: ReadonlyArray<Diagnostic>;
@@ -7,11 +7,11 @@ export interface SessionState {
    * Which UI `program` is a version of. It goes up when the model writes a
    * new UI rather than editing the last one, or a stored one is restored,
    * and goes back with the program when a turn is stopped. Pass it to
-   * `PickleView` as `documentId`, so a new UI starts from fresh state.
+   * `JigsView` as `documentId`, so a new UI starts from fresh state.
    */
   documentId: number;
   /** `{ code, message }` when `status` is "error". */
-  error: PickleErrorData | null;
+  error: JigsErrorData | null;
   /** The conversation, to store or render. Assistant entries hold checked source. */
   messages: ReadonlyArray<Message>;
   /** The latest program, or null before the first one arrives. */

package/dist/view/settled.d.ts

@@ -5,7 +5,7 @@
  * component's latest events and its answer is on screen. A control that
  * runs ahead of the program, such as a text field showing what was typed,
  * can then go back to its value prop if the program kept another value.
- * Always 0 outside `PickleView`.
+ * Always 0 outside `JigsView`.
  */
 export declare function useHandlerSettled(): number;
 //#endregion

package/dist/view/settled.js

@@ -8,7 +8,7 @@ const SettledContext = createContext(0);
 * component's latest events and its answer is on screen. A control that
 * runs ahead of the program, such as a text field showing what was typed,
 * can then go back to its value prop if the program kept another value.
-* Always 0 outside `PickleView`.
+* Always 0 outside `JigsView`.
 */
 function useHandlerSettled() {
 	return useContext(SettledContext);

package/dist/view/{usePickleSession.d.ts → useJigsSession.d.ts}

@@ -1,8 +1,8 @@
 import { SessionState } from "./session.js";
-import { PickleClient } from "@jigs.design/client";
+import { JigsClient } from "@jigs.design/client";
 import { Message, SessionOptions } from "@jigs.design/runtime";
-//#region src/view/usePickleSession.d.ts
-export interface PickleSession<TOptions extends SessionOptions = SessionOptions> extends SessionState {
+//#region src/view/useJigsSession.d.ts
+export interface JigsSession<TOptions extends SessionOptions = SessionOptions> extends SessionState {
   /**
    * Stops any turn and starts over with `messages` (default none). Like
    * `initialMessages`, messages that end with an assistant message are
@@ -25,7 +25,7 @@ export interface PickleSession<TOptions extends SessionOptions = SessionOptions>
  * conversation later, call `reset(messages)`. A new `client` stops the turn
  * in flight and compiles the conversation's last answer again through it.
  */
-export declare function usePickleSession<TOptions extends SessionOptions = SessionOptions>(client: PickleClient, options?: {
+export declare function useJigsSession<TOptions extends SessionOptions = SessionOptions>(client: JigsClient, options?: {
   initialMessages?: ReadonlyArray<Message>;
-}): PickleSession<TOptions>;
+}): JigsSession<TOptions>;
 //#endregion

package/dist/view/{usePickleSession.js → useJigsSession.js}

@@ -1,6 +1,6 @@
 import { createSessionStore } from "./session.js";
 import { useEffect, useState, useSyncExternalStore } from "react";
-//#region src/view/usePickleSession.ts
+//#region src/view/useJigsSession.ts
 const NO_MESSAGES = [];
 /**
 * Holds a conversation with the server and its latest program. Pass
@@ -10,7 +10,7 @@ const NO_MESSAGES = [];
 * conversation later, call `reset(messages)`. A new `client` stops the turn
 * in flight and compiles the conversation's last answer again through it.
 */
-function usePickleSession(client, options) {
+function useJigsSession(client, options) {
 	const [store] = useState(() => createSessionStore(client, options?.initialMessages ?? NO_MESSAGES));
 	const state = useSyncExternalStore(store.subscribe, store.getState, store.getState);
 	useEffect(() => {
@@ -26,4 +26,4 @@ function usePickleSession(client, options) {
 	};
 }
 //#endregion
-export { usePickleSession };
+export { useJigsSession };

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@jigs.design/react",
-  "version": "0.1.1",
-  "description": "The web renderer: PickleView runs a compiled program in a sandbox and draws it with your registry; usePickleSession streams programs from the server.",
+  "version": "0.1.2",
+  "description": "The web renderer: JigsView runs a compiled program in a sandbox and draws it with your registry; useJigsSession streams programs from the server.",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/yoamomonstruos/pickle.git",
+    "url": "git+https://github.com/yoamomonstruos/jigs.git",
     "directory": "packages/react"
   },
   "type": "module",
@@ -25,8 +25,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@jigs.design/runtime": "0.1.1",
-    "@jigs.design/client": "0.1.1"
+    "@jigs.design/client": "0.1.2",
+    "@jigs.design/runtime": "0.1.2"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"