@mostra/protocol 0.0.0-placeholder → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,39 @@
 # @mostra/protocol
 
-A placeholder: the first Mostra release replaces it. https://github.com/mostra-dev/mostra
+The shared vocabulary of [Mostra](https://github.com/mostra-dev/mostra), the agent artifact
+runtime: the types every Mostra client, host and process agree on, as TypeScript types with Zod
+schemas and published JSON Schema. It has no I/O and runs in browsers, workers and Node alike.
+
+```sh
+npm install @mostra/protocol
+```
+
+## What it contains
+
+- **IDs.** One kind per entity (`ArtifactId`, `VersionId`, `ViewId`, `SubmissionId` and so on),
+  each a type and a value: `ArtifactId.parse(input)`, `MutationId.create()`, `ArtifactId.schema`
+  inside a Zod object. Version IDs are content-addressed: `VersionId.fromSha256(digest)`. Event
+  cursors are decimal strings (`Cursor`).
+- **Protocol revisions.** Dated revisions (`2026-10-10`) and `negotiateRevision(offered,
+  supported)`, which picks the newest common revision or returns the
+  `MOSTRA_HOST_REVISION_UNSUPPORTED` diagnostic.
+- **Diagnostics.** The one error shape of every Mostra interface (`Diagnostic`), the catalog of
+  stable codes with their docs (`diagnosticCatalog`) and `createDiagnostic(code, details)`.
+- **Protocol methods.** `defineMethod` and the registry of host protocol methods.
+- **JSON Schema.** `schemas/protocol.schema.json` (2020-12) and `schemas/protocol.draft-07.json`,
+  exported as `@mostra/protocol/schemas/*`.
+
+```ts
+import { ArtifactId, negotiateRevision } from "@mostra/protocol";
+
+const id = ArtifactId.parse("art_01J9ZQ3W4X5Y6Z7A8B9C0D1E2F");
+const outcome = negotiateRevision(["2026-10-10"]);
+if (!outcome.ok) console.error(outcome.diagnostic.message);
+```
+
+Interfaces change additively within a protocol revision; a breaking change needs a new revision.
+The package stays at 0.x until the host protocol freezes.
+
+## License
+
+Apache-2.0.

package/dist/actions.d.ts

@@ -0,0 +1,273 @@
+import { Frame, WireError } from "./serializer.js";
+import * as z from "zod";
+//#region src/actions.d.ts
+/** A value written by the serializer: its batches, in order (`serializeAll`). */
+export type Batches = readonly (readonly Frame[])[];
+/**
+ * The Zod schema of the `Batches` type: a list of batches, each a list of frames. The frames
+ * themselves are checked by the reader (`ValueReader`), which refuses anything malformed.
+ */
+export declare const Batches: z.ZodType<Batches>;
+/** An error as runs, calls and live sources report it. */
+export interface ActionError extends WireError {
+  /** The stack of the thrown error, kept in the run log and never sent to a page. */
+  readonly stack?: string;
+}
+/** The Zod schema of the `ActionError` type. */
+export declare const ActionError: z.ZodType<ActionError>;
+/** The largest serialized arguments a call or run takes, in characters of JSON. */
+export declare const ACTION_ARGS_MAX: number;
+/** The largest serialized result a run keeps, in characters of JSON (larger fails the run). */
+export declare const ACTION_RESULT_MAX: number;
+/** The cap of a run's log, in UTF-16 code units of its lines (D47's 1 MB). */
+export declare const RUN_LOG_MAX: number;
+/** The line a capped log ends with. */
+export declare const RUN_LOG_TRUNCATED = "[log truncated at 1 MB]";
+/** The longest run key, in characters. */
+export declare const RUN_KEY_MAX = 256;
+/**
+ * A run's state (D24, ARCHITECTURE §7). `queued`: recorded, not yet started in a worker.
+ * `running`: started. `waiting` is reserved for a remote server's run that waits for its owner's
+ * instance (WP-28, D117); a page that doesn't know it treats it like `queued`. The others are
+ * final.
+ */
+export type RunStatus = "queued" | "running" | "waiting" | "succeeded" | "failed" | "cancelled";
+/** Every run status. */
+export declare const RUN_STATUSES: readonly RunStatus[];
+/** Whether a run in `status` has ended. */
+export declare function isFinalRunStatus(status: RunStatus): boolean;
+/**
+ * Why a run ended the way it did, beside its status: `interrupted` (its worker or the instance
+ * stopped while it ran, D24), `threw` (the action threw), `unserializable` (its result is outside
+ * the type set), `too-large`, `parked` (its artifact's worker keeps crashing), `cancelled` (by a
+ * viewer), `unknown-function`. Later releases add reasons.
+ */
+export type RunReason = string;
+/** A run's progress, as the action last reported it. */
+export interface RunProgress {
+  /** From 0 to 1. */
+  readonly fraction?: number;
+  /** One short line for people. */
+  readonly message?: string;
+}
+/** The Zod schema of the `RunProgress` type. */
+export declare const RunProgress: z.ZodType<RunProgress>;
+/**
+ * One action run as a page reads it (D54): its state, progress, log and the result written so far.
+ * A result that is an async iterable grows item by item while the run is `running`.
+ */
+export interface RunState {
+  /** The run's `run_` ID. */
+  readonly runId: string;
+  /** The server function it runs: `<module path>#<export>`. */
+  readonly fnId: string;
+  /** The idempotency key it was started with, if any. */
+  readonly key?: string;
+  /** The run's state. */
+  readonly status: RunStatus;
+  /** Why it ended, for `failed` and `cancelled`. */
+  readonly reason?: RunReason;
+  /** Its latest progress. */
+  readonly progress?: RunProgress;
+  /** The log lines, capped at 1 MB with a marker line. */
+  readonly log: readonly string[];
+  /** The result's batches so far. */
+  readonly batches: Batches;
+  /** For `failed`: what went wrong, without the stack. */
+  readonly error?: WireError;
+  /** When it was recorded. */
+  readonly startedAt: string;
+  /** When it ended. */
+  readonly finishedAt?: string;
+  /** Whether this request joined a run that already existed (a key or a retried `clientKey`). */
+  readonly joined?: boolean;
+  /**
+   * The index of the first line in `log`, when the request said which lines the page holds
+   * (`RunAttachRequest.held`); absent: 0, the whole log.
+   */
+  readonly logFrom?: number;
+  /** The index of the first batch in `batches`, as `logFrom`; absent: 0. */
+  readonly batchFrom?: number;
+}
+/** The Zod schema of the `RunState` type. */
+export declare const RunState: z.ZodType<RunState>;
+/**
+ * What changed in a run since a page last heard: a lossy notification on the event stream. Lines
+ * start at `logFrom` and batches at `batchFrom`; a page that holds fewer reads the run again
+ * (`runs/attach`).
+ */
+export interface RunDelta {
+  /** The run's `run_` ID. */
+  readonly runId: string;
+  /** The run's state. */
+  readonly status: RunStatus;
+  /** Why it ended so, for `failed` and `cancelled`. */
+  readonly reason?: RunReason;
+  /** Its latest progress. */
+  readonly progress?: RunProgress;
+  /** The index of the first line in `log`. */
+  readonly logFrom: number;
+  /** Log lines, starting at `logFrom`. */
+  readonly log: readonly string[];
+  /** The index of the first batch in `batches`. */
+  readonly batchFrom: number;
+  /** Result batches, starting at `batchFrom`. */
+  readonly batches: Batches;
+  /** What went wrong. */
+  readonly error?: WireError;
+  /** When it ended. */
+  readonly finishedAt?: string;
+}
+/** A live source's value as a page reads it (D56). */
+export interface LiveState {
+  /** The idempotency key it was started with, if any. */
+  readonly key: string;
+  /** The value's revision, a decimal string that only grows; absent before any value. */
+  readonly revision?: string;
+  /** When the value was produced. */
+  readonly at?: string;
+  /** The latest value, serialized. */
+  readonly value?: Batches;
+  /**
+   * Append mode (`useLive(key, { mode: "append" })`): the values kept in the source's ring, oldest
+   * first, at most the window the page asked for.
+   */
+  readonly ring?: readonly {
+    readonly revision: string;
+    readonly at: string;
+    readonly value: Batches;
+  }[];
+  /** The producer's last failure, while the last good value stays (FAILURE_MODEL §6). */
+  readonly error?: WireError;
+}
+/** One live update on the event stream: never stored as an event (D63, LL-04). */
+export interface LiveUpdate {
+  /** The live source's key. */
+  readonly key: string;
+  /** The value's revision. */
+  readonly revision?: string;
+  /** When the value was produced. */
+  readonly at?: string;
+  /** The value, serialized. */
+  readonly value?: Batches;
+  /** What went wrong. */
+  readonly error?: WireError;
+}
+/**
+ * An ephemeral message on a page's event stream (SSE `event: run` or `event: live`, without an
+ * `id`, so a reconnect's cursor is untouched) or in a poll's `ephemeral`: lossy, coalesced, and
+ * never stored as an event.
+ */
+export type EphemeralMessage = {
+  readonly kind: "run";
+  readonly run: RunDelta;
+} | {
+  readonly kind: "live";
+  readonly live: LiveUpdate;
+};
+/** `POST …/call/{fnId}`: a plain server-function call, no durable record (D54). */
+export interface CallRequest {
+  /** The view the page was opened as (D104). */
+  readonly viewId: string;
+  /** The arguments, serialized as one array value. */
+  readonly args: Batches;
+}
+/** The Zod schema of the `CallRequest` type. */
+export declare const CallRequest: z.ZodType<CallRequest>;
+/**
+ * One line of a plain call's answer (`application/x-ndjson`): a batch of the result, then the end.
+ */
+export type CallLine = {
+  readonly batch: readonly Frame[];
+} | {
+  readonly end: {
+    readonly status: "succeeded";
+  };
+} | {
+  readonly end: {
+    readonly status: "failed";
+    readonly error: WireError;
+  };
+};
+/** `POST …/runs`: start a durable action run, or join one (D54, AC-02, AC-03). */
+export interface RunRequest {
+  /** The view the page was opened as (D104). */
+  readonly viewId: string;
+  /** `<module path>#<export>`. */
+  readonly fnId: string;
+  /** The arguments, serialized as one array value. */
+  readonly args: Batches;
+  /** The author's idempotency key: one run per artifact, function and key, ever. */
+  readonly key?: string;
+  /** A fresh ID per invocation, so a retried request joins the run it already started. */
+  readonly clientKey: string;
+}
+/** The Zod schema of the `RunRequest` type. */
+export declare const RunRequest: z.ZodType<RunRequest>;
+/**
+ * `POST …/runs/attach`: read runs and hear their changes on the event stream for the next minute
+ * (re-attach after a reload, AC-02). By ID, or by function and key.
+ */
+export interface RunAttachRequest {
+  /** The view the page was opened as (D104). */
+  readonly viewId: string;
+  /** Runs by ID. */
+  readonly runIds?: readonly string[];
+  /** Runs by function and key. */
+  readonly keyed?: readonly {
+    readonly fnId: string;
+    readonly key: string;
+  }[];
+  /**
+   * What the page already holds of runs it names by ID: so many log lines and batches. Each such
+   * run's answer starts there (`RunState.logFrom`, `batchFrom`), so a page renewing its interest
+   * doesn't read the whole run again (Opus review 14).
+   */
+  readonly held?: readonly {
+    readonly runId: string;
+    readonly log: number;
+    readonly batches: number;
+  }[];
+}
+/** The Zod schema of the `RunAttachRequest` type. */
+export declare const RunAttachRequest: z.ZodType<RunAttachRequest>;
+/** `POST …/runs/{id}/cancel`. */
+export interface RunCancelRequest {
+  /** The view the page was opened as (D104). */
+  readonly viewId: string;
+}
+/** The Zod schema of the `RunCancelRequest` type. */
+export declare const RunCancelRequest: z.ZodType<RunCancelRequest>;
+/** The keys of live sources: like JavaScript export names, which is what `live.ts` declares. */
+export declare const LIVE_KEY_PATTERN: RegExp;
+/** The largest live value, in characters of serialized JSON (DATA_MODEL §5's 4 MiB). */
+export declare const LIVE_VALUE_MAX: number;
+/** The ring size of a pushed source in append mode that no `defineLive` sized. */
+export declare const LIVE_RING_DEFAULT = 1024;
+/** The largest ring a source may keep. */
+export declare const LIVE_RING_MAX = 1e5;
+/**
+ * `POST …/live`: read live sources and keep their producers running for this view for the next
+ * minute (D56, LL-04); a page asks again while it shows them.
+ */
+export interface LiveRequest {
+  /** The view the page was opened as (D104). */
+  readonly viewId: string;
+  /**
+   * The sources, each with its append window; `refresh` asks the source's producer to load again
+   * now (`useLive`'s `refresh()`).
+   */
+  readonly keys: readonly {
+    readonly key: string;
+    readonly window?: number;
+    readonly refresh?: boolean;
+  }[];
+}
+/** The Zod schema of the `LiveRequest` type. */
+export declare const LiveRequest: z.ZodType<LiveRequest>;
+/** Secret names: letters, digits, `_`, `.` and `-`, starting with a letter or `_` (D44). */
+export declare const SECRET_NAME_PATTERN: RegExp;
+/** The largest secret value, in UTF-8 bytes. */
+export declare const SECRET_VALUE_MAX: number;
+//#endregion
+//# sourceMappingURL=actions.d.ts.map

package/dist/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","names":[],"sources":["../src/actions.ts"],"mappings":";;;;YAgBY,6BAA6B;;;;;qBAM5B,SAAS,EAAE,QAAQ;;iBASf,oBAAoB;;WAE1B;;;qBAIE,aAAa,EAAE,QAAQ;;qBAYvB;;qBAGA;;qBAGA;;qBAGA;;qBAGA;;;;;;;YAQD;;qBAGC,uBAAuB;;wBAUpB,iBAAiB,QAAQ;;;;;;;YAU7B;;iBAGK;;WAEN;;WAEA;;;qBAIE,aAAa,EAAE,QAAQ;;;;;iBAcnB;;WAEN;;WAEA;;WAEA;;WAEA,QAAQ;;WAER,SAAS;;WAET,WAAW;;WAEX;;WAEA,SAAS;;WAET,QAAQ;;WAER;;WAEA;;WAEA;;;;;WAKA;;WAEA;;;qBAIE,UAAU,EAAE,QAAQ;;;;;;iBA2BhB;;WAEN;;WAEA,QAAQ;;WAER,SAAS;;WAET,WAAW;;WAEX;;WAEA;;WAEA;;WAEA,SAAS;;WAET,QAAQ;;WAER;;;iBAIM;;WAEN;;WAEA;;WAEA;;WAEA,QAAQ;;;;;WAKR;aACE;aACA;aACA,OAAO;;;WAGT,QAAQ;;;iBAIF;;WAEN;;WAEA;;WAEA;;WAEA,QAAQ;;WAER,QAAQ;;;;;;;YAQP;WACG;WAAsB,KAAK;;WAC3B;WAAuB,MAAM;;;iBAG3B;;WAEN;;WAEA,MAAM;;;qBAIJ,aAAa,EAAE,QAAQ;;;;YAUxB;WACG,gBAAgB;;WAChB;aAAgB;;;WAChB;aAAgB;aAA2B,OAAO;;;;iBAGhD;;WAEN;;WAEA;;WAEA,MAAM;;WAEN;;WAEA;;;qBAIE,YAAY,EAAE,QAAQ;;;;;iBAiBlB;;WAEN;;WAEA;;WAEA;aAA4B;aAAuB;;;;;;;WAMnD;aACE;aACA;aACA;;;;qBAKA,kBAAkB,EAAE,QAAQ;;iBA6BxB;;WAEN;;;qBAIE,kBAAkB,EAAE,QAAQ;;qBAK5B,kBAAkB;;qBAGlB;;qBAGA;;qBAGA;;;;;iBAMI;;WAEN;;;;;WAKA;aACE;aACA;aACA;;;;qBAKA,aAAa,EAAE,QAAQ;;qBAoBvB,qBAAqB;;qBAGrB"}

package/dist/actions.js

@@ -0,0 +1,154 @@
+import { wireRegistry } from "./wire-registry.js";
+import { ViewId } from "./ids.js";
+import * as z from "zod";
+//#region src/actions.ts
+/**
+* Actions, live data and secrets (INTERFACES §2.4, §4, §6; D24, D44, D54, D56): the shapes the
+* browser protocol, the host protocol and the worker channel share. Server-function arguments and
+* results travel as the serializer's batches (`Batches`).
+*
+* ```ts
+* const run: RunState = await post("runs", { viewId, fnId: "actions.ts#sendReply", args, clientKey });
+* if (run.status === "succeeded") show(await deserializeAll(run.batches));
+* ```
+*/
+/**
+* The Zod schema of the `Batches` type: a list of batches, each a list of frames. The frames
+* themselves are checked by the reader (`ValueReader`), which refuses anything malformed.
+*/
+const Batches = z.array(z.array(z.record(z.string(), z.unknown())).readonly()).readonly().register(wireRegistry, {
+	id: "Batches",
+	description: "A serialized server-function value: its batches of frames, in order."
+});
+/** The Zod schema of the `ActionError` type. */
+const ActionError = z.object({
+	message: z.string(),
+	code: z.string().exactOptional(),
+	stack: z.string().exactOptional()
+}).register(wireRegistry, {
+	id: "ActionError",
+	description: "An error from server code: its message and diagnostic code."
+});
+/** The largest serialized arguments a call or run takes, in characters of JSON. */
+const ACTION_ARGS_MAX = 16777216;
+/** The largest serialized result a run keeps, in characters of JSON (larger fails the run). */
+const ACTION_RESULT_MAX = 16777216;
+/** The cap of a run's log, in UTF-16 code units of its lines (D47's 1 MB). */
+const RUN_LOG_MAX = 1048576;
+/** The line a capped log ends with. */
+const RUN_LOG_TRUNCATED = "[log truncated at 1 MB]";
+/** The longest run key, in characters. */
+const RUN_KEY_MAX = 256;
+/** Every run status. */
+const RUN_STATUSES = [
+	"queued",
+	"running",
+	"waiting",
+	"succeeded",
+	"failed",
+	"cancelled"
+];
+/** Whether a run in `status` has ended. */
+function isFinalRunStatus(status) {
+	return status === "succeeded" || status === "failed" || status === "cancelled";
+}
+/** The Zod schema of the `RunProgress` type. */
+const RunProgress = z.object({
+	fraction: z.number().min(0).max(1).exactOptional(),
+	message: z.string().max(1e3).exactOptional()
+}).register(wireRegistry, {
+	id: "RunProgress",
+	description: "A run's progress: fraction and message."
+});
+/** The Zod schema of the `RunState` type. */
+const RunState = z.object({
+	runId: z.string(),
+	fnId: z.string(),
+	key: z.string().exactOptional(),
+	status: z.enum(RUN_STATUSES),
+	reason: z.string().exactOptional(),
+	progress: RunProgress.exactOptional(),
+	log: z.array(z.string()).readonly(),
+	batches: Batches,
+	error: z.object({
+		message: z.string(),
+		code: z.string().exactOptional()
+	}).exactOptional(),
+	startedAt: z.string(),
+	finishedAt: z.string().exactOptional(),
+	joined: z.boolean().exactOptional(),
+	logFrom: z.number().int().nonnegative().exactOptional(),
+	batchFrom: z.number().int().nonnegative().exactOptional()
+}).register(wireRegistry, {
+	id: "RunState",
+	description: "An action run: status, progress, log and the result written so far."
+});
+/** The Zod schema of the `CallRequest` type. */
+const CallRequest = z.object({
+	viewId: ViewId.schema,
+	args: Batches
+}).register(wireRegistry, {
+	id: "CallRequest",
+	description: "A plain server-function call: the view and the serialized arguments."
+});
+/** The Zod schema of the `RunRequest` type. */
+const RunRequest = z.object({
+	viewId: ViewId.schema,
+	fnId: z.string().min(3).max(1024),
+	args: Batches,
+	key: z.string().min(1).max(256).exactOptional(),
+	clientKey: z.string().min(8).max(64)
+}).register(wireRegistry, {
+	id: "RunRequest",
+	description: "Start or join an action run: the function, its arguments and keys."
+});
+/** The Zod schema of the `RunAttachRequest` type. */
+const RunAttachRequest = z.object({
+	viewId: ViewId.schema,
+	runIds: z.array(z.string().max(64)).max(100).readonly().exactOptional(),
+	keyed: z.array(z.object({
+		fnId: z.string().min(3).max(1024),
+		key: z.string().min(1).max(256)
+	})).max(100).readonly().exactOptional(),
+	held: z.array(z.object({
+		runId: z.string().max(64),
+		log: z.number().int().nonnegative(),
+		batches: z.number().int().nonnegative()
+	})).max(100).readonly().exactOptional()
+}).register(wireRegistry, {
+	id: "RunAttachRequest",
+	description: "Runs a page reads and follows: by ID, or by function and key."
+});
+/** The Zod schema of the `RunCancelRequest` type. */
+const RunCancelRequest = z.object({ viewId: ViewId.schema }).register(wireRegistry, {
+	id: "RunCancelRequest",
+	description: "Cancel a run, from a view."
+});
+/** The keys of live sources: like JavaScript export names, which is what `live.ts` declares. */
+const LIVE_KEY_PATTERN = /^[A-Za-z_$][A-Za-z0-9_$]{0,127}$/;
+/** The largest live value, in characters of serialized JSON (DATA_MODEL §5's 4 MiB). */
+const LIVE_VALUE_MAX = 4194304;
+/** The ring size of a pushed source in append mode that no `defineLive` sized. */
+const LIVE_RING_DEFAULT = 1024;
+/** The largest ring a source may keep. */
+const LIVE_RING_MAX = 1e5;
+/** The Zod schema of the `LiveRequest` type. */
+const LiveRequest = z.object({
+	viewId: ViewId.schema,
+	keys: z.array(z.object({
+		key: z.string().regex(LIVE_KEY_PATTERN),
+		window: z.int().min(1).max(LIVE_RING_MAX).exactOptional(),
+		refresh: z.boolean().exactOptional()
+	})).max(256).readonly()
+}).register(wireRegistry, {
+	id: "LiveRequest",
+	description: "Live sources a page reads and keeps running: keys and append windows."
+});
+/** Secret names: letters, digits, `_`, `.` and `-`, starting with a letter or `_` (D44). */
+const SECRET_NAME_PATTERN = /^[A-Za-z_][A-Za-z0-9_.-]{0,127}$/;
+/** The largest secret value, in UTF-8 bytes. */
+const SECRET_VALUE_MAX = 65536;
+//#endregion
+export { ACTION_ARGS_MAX, ACTION_RESULT_MAX, ActionError, Batches, CallRequest, LIVE_KEY_PATTERN, LIVE_RING_DEFAULT, LIVE_RING_MAX, LIVE_VALUE_MAX, LiveRequest, RUN_KEY_MAX, RUN_LOG_MAX, RUN_LOG_TRUNCATED, RUN_STATUSES, RunAttachRequest, RunCancelRequest, RunProgress, RunRequest, RunState, SECRET_NAME_PATTERN, SECRET_VALUE_MAX, isFinalRunStatus };
+
+//# sourceMappingURL=actions.js.map