@worker-protocol/hono 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Rowing Tech, S.A.
+
+   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/NOTICE

@@ -0,0 +1,9 @@
+worker-protocol
+Copyright 2026 Rowing Tech, S.A.
+
+This product includes software developed at Rowing Tech, S.A. (https://rowing.tech).
+
+Licensed under the Apache License, Version 2.0. See LICENSE for the full text.
+
+"worker-protocol" and any conformance claim made in its name are not licensed under Apache-2.0;
+see section 6 of the License.

package/dist/actions.d.ts

@@ -0,0 +1,200 @@
+/**
+ * The `actions` surface: the call, and everything the protocol fixes about one.
+ *
+ * A Worker knows what an Action DOES. Everything else on the way in is a rule — the name that is
+ * not declared, the body that will not parse, the input that does not match the schema the Worker
+ * published, the required idempotency key that is absent, the repeat under a key already recorded,
+ * and the key reused with another body.
+ *
+ * The input is declared as a Zod object and used twice: `mount()` generates the JSON Schema the
+ * Descriptor carries from it, and this validates against the same object. ACT-2 requires that a
+ * console can render a form from the declaration without being told anything else, and a Worker
+ * that wrote the schema by hand and the validation by hand had two places to disagree.
+ *
+ * **Nothing here knows whether an Action is answering a Task.** It used to: a holder named its
+ * Claim in a header and this refused a stale one before performing anything. The lease is
+ * withdrawn, so a Response and any other performance are the same request, which `spec/tasks.md`
+ * states rather than hides.
+ */
+import * as z from "zod";
+import type { Answer, Refusal } from "./worker.ts";
+/**
+ * What a Worker declares about one Action, and what it does.
+ *
+ * ACT-2's `input` and ACT-3's `result` are Zod objects here and JSON Schema in the Descriptor.
+ * `mount()` converts them, so nothing is declared twice and nothing can drift.
+ */
+export type Action = {
+    /** ACT-2. The whole of what a caller sends, and what a console renders a form from. */
+    input: z.ZodType;
+    /** ACT-3. What a performance answers, absent where it answers nothing (ACT-10's `204`). */
+    result?: z.ZodType;
+    /** ACT-4. Declared rather than discovered, because a caller decides whether it can wait. */
+    completesWithinCall?: boolean;
+    /** ACT-12, ENDP-15. Absent where the Action takes no key. */
+    idempotency?: {
+        required: boolean;
+        from: "header";
+        windowSeconds: number;
+    } | {
+        required: boolean;
+        from: "input";
+        member: string;
+        windowSeconds: number;
+    };
+    /**
+     * What this Action does. The input has already been validated against `input` above.
+     *
+     * A `Refusal` of `unprocessable_content` is ACT-9: schema-valid, and refused on the Worker's own
+     * rules. Anything returned that is not a refusal is the result, and `undefined` is ACT-10's
+     * `204` — the status comes from what the Action declared, never from what a handler chose.
+     */
+    run: (input: never, call: ActionCall) => unknown | Promise<unknown>;
+};
+/** What a performance knows about the call it arrived on, beyond its input. */
+export type ActionCall = {
+    /** The Action's own name, for a handler shared between several. */
+    name: string;
+    /** REG-3. The credential presented, for a Worker that splits its own facts by it. */
+    token: string | undefined;
+};
+export type ActionDeclarations = Record<string, Action>;
+/**
+ * Write an Action, and have `run` typed by the schema above it.
+ *
+ * `Action.input` is a Zod object and `Action.run` takes what it parses — but a record of Actions
+ * cannot carry one type parameter per entry, so annotating the record makes `run`'s argument
+ * `unknown` and the author writes the shape a second time, by hand, beside the schema that already
+ * states it. Two declarations of one thing, and the day they disagree the compiler says nothing.
+ *
+ * ```ts
+ * accepts: {
+ *   "record-check": action({
+ *     input: z.object({ vehicle: z.string(), reachable: z.boolean() }),
+ *     run: ({ vehicle }) => …,   // vehicle is a string, from the line above
+ *   }),
+ * }
+ * ```
+ *
+ * Like `defineWorker`, it returns its argument and no rule id can be cited for it. It is here
+ * because the alternative is every Worker author writing every input type twice.
+ */
+export declare const action: <I extends z.ZodType>(declaration: Omit<Action, "input" | "run"> & {
+    input: I;
+    run: (input: z.infer<I>, call: ActionCall) => unknown | Promise<unknown>;
+}) => Action;
+export type ActionFacts = {
+    /** ACT-16. Every Action this Worker accepts, keyed by name. */
+    accepts: ActionDeclarations;
+    /** ACT-15. The document `configure` would accept, where the Worker accepts settings. */
+    settings?: () => unknown | Promise<unknown>;
+    /**
+     * ENDP-16. Where the recorded outcomes live. **Required as soon as any Action declares a key.**
+     *
+     * There is no default, and the absence is the design. The obvious one is a Map, which is correct
+     * in exactly one place — a single long-lived process — and silently wrong everywhere that scales
+     * horizontally: a Worker across isolates has one Map per isolate, so a repeat under the same key
+     * reaches a process that recorded nothing, the Action is performed a second time *while the
+     * caller believes it is protected*, and both calls answer `200` so nobody sees two.
+     *
+     * A default would have made that the thing you get by not thinking about it, on the platform
+     * this protocol's architecture names first. So it is written, in one line, by whoever knows where
+     * their Worker runs: `memoryOutcomes()` in a process, a store over a durable object, a KV
+     * namespace or a table anywhere else.
+     */
+    outcomes?: OutcomeStore;
+};
+/**
+ * What `begin` answers: the outcome already recorded, somebody else performing it now, or the
+ * reservation — which is the only one of the three that performs anything.
+ */
+export type Reservation = 
+/** ENDP-16. Within the window, this key already has an outcome. It is answered, not performed. */
+{
+    held: Recorded;
+}
+/** Another request holds this key and has not finished. Nothing is performed; ENDP-29's `409`. */
+ | "in-flight"
+/** Nobody held it. This request performs the Action and calls `complete` or `release`. */
+ | "reserved";
+/**
+ * Where a Worker keeps what ENDP-16 promised, when a Map will not do.
+ *
+ * **It reserves rather than reads, and that is the whole shape of it.** A `get` then a `put` with
+ * the Action running in between is a check-then-act: two requests arriving at once under one key
+ * both find nothing recorded, both perform, and both record. A durable object does not fix it,
+ * because the Action runs outside the durable object — between the two calls, which is exactly
+ * where the window is. So the first call *takes* the key, and only whoever took it performs.
+ *
+ * Every store has this in one operation already. A durable object is single-threaded, so reading
+ * and writing in one method is atomic by construction. SQL is `insert … on conflict do nothing`,
+ * and the rows affected say which of the three happened. A Map is `has` then `set` with nothing
+ * between them, because JavaScript does not interleave.
+ *
+ * `until` travels on `begin` so that a store with its own time-to-live can set it when it reserves
+ * — a KV namespace, a durable object alarm — and one without may ignore it: `begin` is asked to
+ * treat a record whose window has passed as absent, and `mount()` never sees the difference.
+ */
+export type OutcomeStore = {
+    /**
+     * Take the key, or say what is already there. Nothing is performed unless this answers
+     * `"reserved"`, and whoever gets that calls `complete` or `release`.
+     *
+     * **A reservation expires at `until`, and that is a requirement and not a hint.** A request that
+     * dies between `begin` and `complete` — the process evicted, the isolate killed, the machine
+     * gone — calls neither, so nothing gives the key back. Without an expiry every later request
+     * under it would meet `in-flight` forever, and one crash would lock an Action out permanently
+     * over work that never finished. With one, it costs a window. A store treats a reservation whose
+     * `until` has passed exactly as it treats one that was never taken.
+     */
+    begin: (key: string, until: number) => Reservation | Promise<Reservation>;
+    /** The Action ran and this is what it answered. The reservation becomes the record. */
+    complete: (key: string, held: Recorded) => void | Promise<void>;
+    /**
+     * The Action did not run, or refused. The reservation is given up so the next caller may take
+     * it — a refusal is not an outcome, and a key held by a request that failed would lock the
+     * Action out for the whole window over something that never happened.
+     */
+    release: (key: string) => void | Promise<void>;
+    /** Set by `memoryOutcomes` alone, so `mount()` can tell one built per request from a durable one. */
+    readonly [IN_MEMORY]?: true;
+};
+/**
+ * What marks a store as living in this process and nowhere else.
+ *
+ * `mount()` uses it for one check it could not otherwise make: a store built INSIDE the function
+ * that answers the Worker is a fresh one on every request, which forgets everything between two
+ * calls and breaks ENDP-16 exactly as having no store does. Comparing identity would catch that and
+ * would also fail a perfectly correct Worker that builds a thin adapter per request over a durable
+ * backend — so only a memory store is compared, where a second object is unambiguously the mistake.
+ */
+export declare const IN_MEMORY: unique symbol;
+/**
+ * ENDP-16. One recorded outcome, for as long as the Action declared.
+ *
+ * `until` is epoch milliseconds on the Worker's own clock. Nothing compares it against a caller's:
+ * ENDP-16 is a promise the Worker makes about its own memory, and the caller only ever learns
+ * whether it was kept by sending the request again.
+ */
+export type Recorded = {
+    body: string;
+    answer: Answer;
+    until: number;
+};
+/**
+ * A store in memory: right in one long-lived process, and wrong everywhere else.
+ *
+ * It is exported rather than defaulted so that choosing it is a line somebody wrote. A Worker in a
+ * single Node or Bun process is the case it is right for, and that case is common enough to
+ * deserve the helper and not common enough to deserve the default.
+ */
+export declare const memoryOutcomes: () => OutcomeStore;
+export declare function actions(facts: ActionFacts): (name: string, raw: string, key: string | undefined, token: string | undefined) => Promise<Answer | Refusal>;
+/**
+ * ACT-2, ACT-3 — the JSON Schema the Descriptor carries, generated from the Zod object beside it.
+ *
+ * `io: "input"` is what makes a declaration with a default describe what a CALLER sends rather
+ * than what the Worker ends up holding, which is the document ACT-2 says a console renders a form
+ * from. The two differ exactly where a schema is most likely to have one.
+ */
+export declare const jsonSchema: (schema: z.ZodType) => Record<string, unknown>;

package/dist/actions.js

@@ -0,0 +1,203 @@
+/**
+ * The `actions` surface: the call, and everything the protocol fixes about one.
+ *
+ * A Worker knows what an Action DOES. Everything else on the way in is a rule — the name that is
+ * not declared, the body that will not parse, the input that does not match the schema the Worker
+ * published, the required idempotency key that is absent, the repeat under a key already recorded,
+ * and the key reused with another body.
+ *
+ * The input is declared as a Zod object and used twice: `mount()` generates the JSON Schema the
+ * Descriptor carries from it, and this validates against the same object. ACT-2 requires that a
+ * console can render a form from the declaration without being told anything else, and a Worker
+ * that wrote the schema by hand and the validation by hand had two places to disagree.
+ *
+ * **Nothing here knows whether an Action is answering a Task.** It used to: a holder named its
+ * Claim in a header and this refused a stale one before performing anything. The lease is
+ * withdrawn, so a Response and any other performance are the same request, which `spec/tasks.md`
+ * states rather than hides.
+ */
+import * as z from "zod";
+/**
+ * Write an Action, and have `run` typed by the schema above it.
+ *
+ * `Action.input` is a Zod object and `Action.run` takes what it parses — but a record of Actions
+ * cannot carry one type parameter per entry, so annotating the record makes `run`'s argument
+ * `unknown` and the author writes the shape a second time, by hand, beside the schema that already
+ * states it. Two declarations of one thing, and the day they disagree the compiler says nothing.
+ *
+ * ```ts
+ * accepts: {
+ *   "record-check": action({
+ *     input: z.object({ vehicle: z.string(), reachable: z.boolean() }),
+ *     run: ({ vehicle }) => …,   // vehicle is a string, from the line above
+ *   }),
+ * }
+ * ```
+ *
+ * Like `defineWorker`, it returns its argument and no rule id can be cited for it. It is here
+ * because the alternative is every Worker author writing every input type twice.
+ */
+export const action = (declaration) => declaration;
+/**
+ * What marks a store as living in this process and nowhere else.
+ *
+ * `mount()` uses it for one check it could not otherwise make: a store built INSIDE the function
+ * that answers the Worker is a fresh one on every request, which forgets everything between two
+ * calls and breaks ENDP-16 exactly as having no store does. Comparing identity would catch that and
+ * would also fail a perfectly correct Worker that builds a thin adapter per request over a durable
+ * backend — so only a memory store is compared, where a second object is unambiguously the mistake.
+ */
+export const IN_MEMORY = Symbol.for("worker-protocol.outcomes.in-memory");
+const refuse = (code, message) => ({ code, message });
+/**
+ * A store in memory: right in one long-lived process, and wrong everywhere else.
+ *
+ * It is exported rather than defaulted so that choosing it is a line somebody wrote. A Worker in a
+ * single Node or Bun process is the case it is right for, and that case is common enough to
+ * deserve the helper and not common enough to deserve the default.
+ */
+export const memoryOutcomes = () => {
+    /**
+     * A reservation and a record are one row, told apart by whether an answer arrived.
+     *
+     * Both carry `until`, and a row past it is treated as absent — which is what gives a reservation
+     * its expiry. In one process a crash takes the Map with it, so the expiry earns nothing here; it
+     * is written anyway because this is the shape every other store is being asked to implement, and
+     * one that quietly did less would be the wrong thing to copy.
+     */
+    const held = new Map();
+    return {
+        [IN_MEMORY]: true,
+        begin: (key, until) => {
+            const row = held.get(key);
+            const live = row !== undefined && row.until > Date.now();
+            if (live && row.answer !== undefined)
+                return { held: row.answer };
+            if (live)
+                return "in-flight";
+            // Nothing runs between the read and the write: a store on a real backend needs one operation
+            // for this — a durable object method, an `insert … on conflict do nothing` — and this one
+            // needs none, because JavaScript does not interleave here.
+            held.set(key, { until });
+            return "reserved";
+        },
+        complete: (key, record) => void held.set(key, { until: record.until, answer: record }),
+        release: (key) => void held.delete(key),
+    };
+};
+export function actions(facts) {
+    // ENDP-16 needs somewhere to record, and `mount()` has refused to build a Worker that declares a
+    // key without naming one — so by here it is either given or never asked for.
+    const recorded = facts.outcomes;
+    return async function perform(name, raw, key, token) {
+        // ACT-6: an Action the entry does not declare is a resource that does not exist.
+        const declaration = facts.accepts[name];
+        if (declaration === undefined) {
+            return refuse("not_found", `No Action named ${name} is declared.`);
+        }
+        // ENDP-4: the body is JSON. ENDP-18: a required key absent is `400`, and it is asked before
+        // the body, because an Action that needs protecting must not be performed by the request that
+        // forgot to ask for the protection.
+        const idempotency = declaration.idempotency;
+        if (idempotency?.required === true && idempotency.from === "header" && key === undefined) {
+            return refuse("idempotency_key_required", "This Action requires an Idempotency-Key.");
+        }
+        let parsed;
+        try {
+            parsed = JSON.parse(raw);
+        }
+        catch {
+            return refuse("malformed_request", "The body did not parse.");
+        }
+        // ACT-8: an input that does not match the schema this Worker published. `400` and not `422`,
+        // because ENDP-12 divides them at whether the Worker could READ it — and a caller fixes this
+        // one by re-reading the Descriptor, which ENDP-5's headers already told it had moved.
+        const input = declaration.input.safeParse(parsed);
+        if (!input.success) {
+            const issue = input.error.issues[0];
+            const where = issue?.path.join(".");
+            return refuse("schema_mismatch", `${where ? `\`${where}\`: ` : ""}${issue?.message ?? "The input does not match the schema."}`);
+        }
+        // ACT-12: a key read from a named member of the input, where the Action declares one. A
+        // payload that already carries its own identity needs no second key beside it.
+        const recordedKey = idempotency === undefined
+            ? undefined
+            : idempotency.from === "header"
+                ? key
+                : readMember(input.data, idempotency.member);
+        if (idempotency?.required === true && recordedKey === undefined) {
+            return refuse("idempotency_key_required", "This Action requires an idempotency key.");
+        }
+        const now = Date.now();
+        const keyed = recordedKey === undefined || recorded === undefined || idempotency === undefined
+            ? undefined
+            : { store: recorded, key: `${name}:${recordedKey}`, idempotency };
+        // ENDP-16: the key is TAKEN before the Action runs, not read. Reading and then writing with
+        // the Action in between is a check-then-act, and two callers under one key would both perform.
+        if (keyed !== undefined) {
+            const reservation = await keyed.store.begin(keyed.key, now + keyed.idempotency.windowSeconds * 1000);
+            if (reservation === "in-flight") {
+                // ENDP-32: `retry` and not `reject`, which is the whole point. The caller backs off and
+                // repeats under ENDP-30, and by then the first performance has recorded an outcome, so
+                // ENDP-16 answers it. A `reject` would have told the caller to stop — and ENDP-28 would
+                // have been right to make it, over a condition that resolves itself in a second.
+                return refuse("unavailable", "This idempotency key is being performed right now.");
+            }
+            if (reservation !== "reserved") {
+                // ENDP-17: a key reused with a different body is `409`. Only the caller can tell a retry
+                // from a genuine repeat, and this is the Worker declining to guess.
+                if (reservation.held.body !== raw) {
+                    return refuse("idempotency_key_reused", "That key was used with another body.");
+                }
+                // ENDP-16: within the window, a repeat is not a second performance.
+                return reservation.held.answer;
+            }
+        }
+        let produced;
+        try {
+            produced = await declaration.run(input.data, { name, token });
+        }
+        catch (thrown) {
+            // The key is given back before the failure travels: a reservation held by a request that
+            // threw would lock the Action out for the whole window over something that never happened.
+            if (keyed !== undefined)
+                await keyed.store.release(keyed.key);
+            throw thrown;
+        }
+        if (isRefusal(produced)) {
+            if (keyed !== undefined)
+                await keyed.store.release(keyed.key);
+            return produced;
+        }
+        // ACT-10, ACT-11: the status comes from what the Action DECLARED, so a caller knows which to
+        // expect before it sends and a handler never picks one.
+        const answer = declaration.completesWithinCall === false
+            ? { status: 202, body: null }
+            : declaration.result === undefined
+                ? { status: 204, body: null }
+                : { status: 200, body: produced };
+        if (keyed !== undefined) {
+            await keyed.store.complete(keyed.key, {
+                body: raw,
+                answer,
+                until: now + keyed.idempotency.windowSeconds * 1000,
+            });
+        }
+        return answer;
+    };
+}
+const isRefusal = (value) => typeof value === "object" && value !== null && "code" in value && "message" in value;
+const readMember = (input, member) => {
+    if (typeof input !== "object" || input === null)
+        return undefined;
+    const value = input[member];
+    return value === undefined ? undefined : String(value);
+};
+/**
+ * ACT-2, ACT-3 — the JSON Schema the Descriptor carries, generated from the Zod object beside it.
+ *
+ * `io: "input"` is what makes a declaration with a default describe what a CALLER sends rather
+ * than what the Worker ends up holding, which is the document ACT-2 says a console renders a form
+ * from. The two differ exactly where a schema is most likely to have one.
+ */
+export const jsonSchema = (schema) => z.toJSONSchema(schema, { io: "input", target: "draft-2020-12" });

package/dist/buckets.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Bucket boundaries, cut in the time zone a Worker declares.
+ *
+ * MET-20 cuts every boundary in the zone the `metrics` entry declares, MET-7 makes a week the ISO
+ * 8601 one beginning Monday, and MET-13 has each bucket carry an end rather than a duration —
+ * because a day across a daylight-saving transition is 23 or 25 hours and a reader comparing
+ * against its own clock would otherwise need a calendar.
+ *
+ * This is the clearest case in the whole SDK for the package carrying what the specification says.
+ * A Worker author who wrote this themselves would write it in UTC, it would work, and it would be
+ * silently wrong for every consumer in a zone that observes daylight saving — a class of bug that
+ * appears twice a year and is attributed to anything but the metric.
+ */
+import type { metricGranularity } from "@worker-protocol/schemas";
+import type * as z from "zod";
+export type Granularity = z.infer<typeof metricGranularity>;
+/** MET-20, MET-7 — the start of the bucket an instant falls in. */
+export declare function startOf(at: number, granularity: Granularity, zone: string): number;
+/** MET-13 — the end of a bucket, which is the start of the next one and is carried, not derived. */
+export declare function endOf(start: number, granularity: Granularity, zone: string): number;
+/**
+ * MET-11, MET-12 — the whole buckets a half-open interval covers.
+ *
+ * Whole or not at all: a read starting mid-bucket gets the buckets whose START falls in the
+ * interval, so two adjacent reads share a boundary instant and no bucket is answered twice.
+ */
+export declare function bucketsIn(from: number, to: number, granularity: Granularity, zone: string): {
+    start: number;
+    end: number;
+}[];
+/**
+ * An RFC 3339 instant carrying an offset, which is what MET-13, TASK-28, ALRT-3 and ACTV-3 travel
+ * as. It takes whichever of the two a caller already holds, so that reaching it never costs a
+ * `new Date` or a `.getTime()` at the call site.
+ */
+export declare const rfc3339: (at: number | Date) => string;