@jigs.design/client 0.1.1 → 0.2.0

package/README.md

@@ -1,11 +1,11 @@
 # @jigs.design/client
 
-`createPickleClient` is the browser's connection to a Pickle server: the transport and the query cache, on TanStack Query Core. `createViewController` is the framework-free half of the view: it owns the sandbox frame, keeps the tree and routes the program's queries, mutations and actions through the client, so a renderer for any framework builds on it as `PickleView` does. The package has no React and no schema library.
+`createJigsClient` is the browser's connection to a Jigs server: the transport and the query cache, on TanStack Query Core. `createViewController` is the framework-free half of the view: it owns the sandbox frame, keeps the tree and routes the program's queries, mutations and actions through the client, so a renderer for any framework builds on it as `JigsView` does. The package has no React and no schema library.
 
 ```ts
-import { createPickleClient } from "@jigs.design/client";
+import { createJigsClient } from "@jigs.design/client";
 
-export const client = createPickleClient({ endpoint: "/api/pickle" });
+export const client = createJigsClient({ endpoint: "/api/jigs" });
 ```
 
 Create one client per app, in its own module. Every view and session that imports it shares one query cache, so two views reading the same query make one request, and a mutation's invalidations reach both. The client retries network failures, aborts a query's request when nothing reads it any more, and refreshes the queries a mutation invalidates.
@@ -14,7 +14,7 @@ Create one client per app, in its own module. Every view and session that import
 
 | Export                                           | What it is                                                                                                                                       |
 | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `createPickleClient`                             | The client, with `observe`, `mutate`, `invalidate` and `session`                                                                                 |
+| `createJigsClient`                               | The client, with `observe`, `mutate`, `invalidate` and `session`                                                                                 |
 | `httpTransport`, `Transport`                     | The default HTTP transport, and the type to implement your own                                                                                   |
 | `TransportError`                                 | What a transport rejects with: `{ code, message }`                                                                                               |
 | `createViewController`, `ViewController`         | One view's page side: `start`, `load`, `subscribe`, `store`, `drawnProps`, `call`, `stop`, and the handlers for issues, actions and confirmation |
@@ -26,7 +26,7 @@ The view calls `observe` and `mutate`; app code calls `invalidate`. `mutate(name
 
 The controller trusts the program it loaded and nothing the worker says: it checks each read and mutation against the program's procedure table, has the tree store check each op against the program's prop schemas, and enforces the budgets on the page again. `drawnProps` turns a node's props into what a component takes, reading each prop's kind from the schema, never from the value.
 
-It re-exports the shared types from `@jigs.design/runtime`.
+It re-exports the shared types from `@jigs.design/protocol`.
 
 ## Source
 

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { HeadersOption, Transport } from "./transport.js";
-import { Message, MutationResult, QueryResult, SessionEvent, SessionOptions } from "@jigs.design/runtime";
+import { Message, MutationResult, QueryResult, SessionEvent, SessionOptions } from "@jigs.design/protocol";
 //#region src/client.d.ts
 interface CacheOptions {
   /**
@@ -28,7 +28,7 @@ interface ConfirmOptions {
   /**
    * Asks the user to approve a mutation whose policy is "confirm", in the
    * page's own UI, outside the sandbox. Without it, or when it resolves
-   * false or throws, the mutation fails with `DECLINED`. A `PickleView`'s
+   * false or throws, the mutation fails with `DECLINED`. A `JigsView`'s
    * `onConfirm` takes its place for that view.
    */
   confirm?: ConfirmFunction;
@@ -46,7 +46,7 @@ export type ClientOptions = CacheOptions & ConfirmOptions & ({
   headers?: never;
   transport: Transport;
 });
-export interface PickleClient {
+export interface JigsClient {
   /** URL of the sandbox frame document. */
   readonly frame: string;
   /** Refetches every query with this name, for every input. */
@@ -83,10 +83,10 @@ export interface PickleClient {
   }) => AsyncIterable<SessionEvent>;
 }
 /**
- * The browser's connection to a Pickle server. Create one per app, in its
+ * The browser's connection to a Jigs server. Create one per app, in its
  * own module: each client has its own query cache, so two clients share no
  * requests and no invalidations.
  */
-export declare function createPickleClient(options: ClientOptions): PickleClient;
+export declare function createJigsClient(options: ClientOptions): JigsClient;
 //#endregion
 export {};

package/dist/client.js

@@ -23,11 +23,11 @@ function toQueryResult(result) {
 	};
 }
 /**
-* The browser's connection to a Pickle server. Create one per app, in its
+* The browser's connection to a Jigs server. Create one per app, in its
 * own module: each client has its own query cache, so two clients share no
 * requests and no invalidations.
 */
-function createPickleClient(options) {
+function createJigsClient(options) {
 	const transport = options.transport === void 0 ? httpTransport(httpOptions(options)) : options.transport;
 	const queries = new QueryClient({ defaultOptions: {
 		mutations: { retry: false },
@@ -156,4 +156,4 @@ function httpOptions(options) {
 	return http;
 }
 //#endregion
-export { createPickleClient };
+export { createJigsClient };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { CallReply, HeadersOption, HttpTransportOptions, Transport, TransportError, httpTransport } from "./transport.js";
-import { ClientOptions, ConfirmFunction, PickleClient, createPickleClient } from "./client.js";
+import { ClientOptions, ConfirmFunction, JigsClient, createJigsClient } from "./client.js";
 import { ActionCall, ActionHandler, ViewController, ViewIssue, ViewStatus, createViewController, missingComponents } from "./view/controller.js";
-import { Diagnostic, Invalidation, Message, PickleErrorCode, PickleErrorData, Program, SessionEvent, Span } from "@jigs.design/runtime";
-export { type ActionCall, type ActionHandler, type CallReply, type ClientOptions, type ConfirmFunction, type Diagnostic, type HeadersOption, type HttpTransportOptions, type Invalidation, type Message, type PickleClient, type PickleErrorCode, type PickleErrorData, type Program, type SessionEvent, type Span, type Transport, TransportError, type ViewController, type ViewIssue, type ViewStatus, createPickleClient, createViewController, httpTransport, missingComponents };
+import { Diagnostic, Invalidation, JigsErrorCode, JigsErrorData, Message, Program, SessionEvent, Severity, Span } from "@jigs.design/protocol";
+export { type ActionCall, type ActionHandler, type CallReply, type ClientOptions, type ConfirmFunction, type Diagnostic, type HeadersOption, type HttpTransportOptions, type Invalidation, type JigsClient, type JigsErrorCode, type JigsErrorData, type Message, type Program, type SessionEvent, type Severity, type Span, type Transport, TransportError, type ViewController, type ViewIssue, type ViewStatus, createJigsClient, createViewController, httpTransport, missingComponents };

package/dist/index.js

@@ -1,4 +1,4 @@
 import { TransportError, httpTransport } from "./transport.js";
-import { createPickleClient } from "./client.js";
+import { createJigsClient } from "./client.js";
 import { createViewController, missingComponents } from "./view/controller.js";
-export { TransportError, createPickleClient, createViewController, httpTransport, missingComponents };
+export { TransportError, createJigsClient, createViewController, httpTransport, missingComponents };

package/dist/transport.d.ts

@@ -1,4 +1,4 @@
-import { Invalidation, Message, PickleErrorCode, PickleErrorData, ProcedureKind, SessionEvent, SessionOptions } from "@jigs.design/runtime";
+import { Invalidation, JigsErrorCode, JigsErrorData, Message, ProcedureKind, SessionEvent, SessionOptions } from "@jigs.design/protocol";
 //#region src/transport.d.ts
 /**
  * A call's reply: the procedure's data and, for a mutation, the queries the
@@ -16,7 +16,7 @@ export type CallReply = {
     token: string;
   };
 };
-/** How the browser reaches the server. Implement it to host Pickle behind another router. */
+/** How the browser reaches the server. Implement it to host Jigs behind another router. */
 export interface Transport {
   /**
    * Resolves with the reply, or rejects with a `TransportError`. `kind` is
@@ -43,18 +43,18 @@ export interface Transport {
   }) => AsyncIterable<SessionEvent>;
 }
 /** A failure with a code the spec can read. */
-export declare class TransportError extends Error implements PickleErrorData {
-  readonly code: PickleErrorCode;
-  constructor(data: PickleErrorData);
+export declare class TransportError extends Error implements JigsErrorData {
+  readonly code: JigsErrorCode;
+  constructor(data: JigsErrorData);
 }
 export type HeadersOption = HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
 export interface HttpTransportOptions {
   credentials?: RequestCredentials;
-  /** Path or URL where `pickle.handler` is mounted. */
+  /** Path or URL where `jigs.handler` is mounted. */
   endpoint: string;
   fetch?: typeof fetch;
   headers?: HeadersOption;
 }
-/** The default transport: `fetch` against `pickle.handler`. */
+/** The default transport: `fetch` against `jigs.handler`. */
 export declare function httpTransport(options: HttpTransportOptions): Transport;
 //#endregion

package/dist/transport.js

@@ -1,4 +1,4 @@
-import { parseErrorData, parseInvalidations, parseSessionEvent } from "@jigs.design/runtime";
+import { parseErrorData, parseInvalidations, parseSessionEvent } from "@jigs.design/protocol";
 //#region src/transport.ts
 /** A failure with a code the spec can read. */
 var TransportError = class extends Error {
@@ -9,7 +9,7 @@ var TransportError = class extends Error {
 		this.name = "TransportError";
 	}
 };
-const VERSION_HEADER = "pickle-version";
+const VERSION_HEADER = "jigs-version";
 const GATEWAY_STATUSES = /* @__PURE__ */ new Set([
 	502,
 	503,
@@ -23,7 +23,7 @@ const network = {
 	code: "NETWORK",
 	message: "Could not reach the server."
 };
-/** The error a reply carries, or `UNAVAILABLE` when the reply is not one of Pickle's. */
+/** The error a reply carries, or `UNAVAILABLE` when the reply is not one of Jigs's. */
 async function replyError(response) {
 	if (GATEWAY_STATUSES.has(response.status) || !response.headers.has(VERSION_HEADER)) return unavailable;
 	try {
@@ -40,7 +40,7 @@ function headersError(cause) {
 		message: `The request headers could not be built: ${cause instanceof Error ? cause.message : String(cause)}`
 	};
 }
-/** The default transport: `fetch` against `pickle.handler`. */
+/** The default transport: `fetch` against `jigs.handler`. */
 function httpTransport(options) {
 	const fetcher = options.fetch ?? globalThis.fetch.bind(globalThis);
 	const credentials = options.credentials ?? "same-origin";

package/dist/view/controller.d.ts

@@ -1,5 +1,6 @@
-import { ConfirmFunction, PickleClient } from "../client.js";
-import { Program, PropSchema, RuntimeError, TreeNode, TreeStore, WireArg } from "@jigs.design/runtime";
+import { ConfirmFunction, JigsClient } from "../client.js";
+import { Program, PropSchema, RuntimeError, WireArg } from "@jigs.design/protocol";
+import { TreeNode, TreeStore } from "@jigs.design/runtime";
 //#region src/view/controller.d.ts
 /** What the view shows beside the tree: a snapshot, replaced on each change. */
 export interface ViewStatus {
@@ -128,5 +129,5 @@ export declare function missingComponents(program: Program, registered: Readonly
  * procedure in the program, since the worker shares its realm with the
  * program and is not trusted either.
  */
-export declare function createViewController(client: PickleClient): ViewController;
+export declare function createViewController(client: JigsClient): ViewController;
 //#endregion

package/dist/view/controller.js

@@ -1,5 +1,6 @@
 import { frameProblem, unprotectedProblem } from "./frame-check.js";
-import { createTreeStore, parseErrorData, parseProgram } from "@jigs.design/runtime";
+import { parseErrorData, parseProgram } from "@jigs.design/protocol";
+import { createTreeStore } from "@jigs.design/runtime";
 //#region src/view/controller.ts
 const WATCHDOG_NOTICE = "Program stopped: it did not answer within a second. The sandbox was restarted.";
 const GAVE_UP_NOTICE = "Program stopped: it did not answer within a second, again after a restart. It will not run until a new program is loaded.";
@@ -163,7 +164,7 @@ function createViewController(client) {
 		clearStartup();
 		if (reported) return;
 		reported = true;
-		console.error(`Pickle: ${problem}`);
+		console.error(`Jigs: ${problem}`);
 		setStatus({
 			...status,
 			notice: problem
@@ -184,7 +185,7 @@ function createViewController(client) {
 		} catch {
 			if (!warnedClone) {
 				warnedClone = true;
-				console.warn("Pickle: an onAction handler returned a value structuredClone cannot copy (a function, a DOM node, a class with private fields), so the program's handle got null as its data.");
+				console.warn("Jigs: an onAction handler returned a value structuredClone cannot copy (a function, a DOM node, a class with private fields), so the program's handle got null as its data.");
 			}
 			return null;
 		}
@@ -398,7 +399,7 @@ function createViewController(client) {
 				if (culprit !== null) {
 					const before = hangs.get(culprit) ?? 0;
 					hangs.set(culprit, failed === void 0 ? before + 1 : 2);
-					if (before === 0) console.warn(`Pickle: ${WATCHDOG_NOTICE}`);
+					if (before === 0) console.warn(`Jigs: ${WATCHDOG_NOTICE}`);
 				}
 				const usable = (candidate) => candidate !== null && (hangs.get(candidate) ?? 0) < 2;
 				let recovery = null;

package/dist/view/frame-check.js

@@ -22,7 +22,7 @@ function frameProblem(frame, response, pageOrigin) {
 		if ((URL.canParse(frame, pageOrigin) ? new URL(frame, pageOrigin).origin : pageOrigin) !== pageOrigin) return `The sandbox frame at ${frame} did not start, and its response could not be read to say why. It is on another origin: check that the server's \`allowedOrigins\` lists ${pageOrigin}, which its frame-ancestors and CORS headers both need, and that nothing replaces the Content-Security-Policy it sends.`;
 		return `The sandbox frame at ${frame} did not start, and its response could not be read to say why. Check that nothing replaces the Content-Security-Policy it sends.`;
 	}
-	if (response.status !== 200) return `The sandbox frame at ${frame} answered ${response.status}, so the view cannot start. Check that the route hands GET requests to \`pickle.handler\`.`;
+	if (response.status !== 200) return `The sandbox frame at ${frame} answered ${response.status}, so the view cannot start. Check that the route hands GET requests to \`jigs.handler\`.`;
 	const policies = (response.headers.get("content-security-policy") ?? "").split(",").map((policy) => policy.trim()).filter((policy) => policy !== "");
 	if (!policies.some((policy) => policy.startsWith(frameSecurityPolicy))) return `The page's Content-Security-Policy replaced the sandbox frame's on ${frame}, so the sandbox will not run. ${ADVICE}`;
 	if (policies.length > 1) return `A second Content-Security-Policy is added to the sandbox frame's response on ${frame}, and it stops the frame from starting. ${ADVICE}`;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@jigs.design/client",
-  "version": "0.1.1",
-  "description": "createPickleClient: the browser's transport and query cache. No React.",
+  "version": "0.2.0",
+  "description": "createJigsClient: the browser's transport and query cache. No React.",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/yoamomonstruos/pickle.git",
+    "url": "git+https://github.com/yoamomonstruos/jigs.git",
     "directory": "packages/client"
   },
   "type": "module",
@@ -26,6 +26,7 @@
   },
   "dependencies": {
     "@tanstack/query-core": "5.104.4",
-    "@jigs.design/runtime": "0.1.1"
+    "@jigs.design/protocol": "0.2.0",
+    "@jigs.design/runtime": "0.2.0"
   }
 }