@smthrs/gateway 0.34.0 → 1.0.0-rc.3

package/dist/esm/GatewayRpcs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatewayRpcs.d.ts","sourceRoot":"","sources":["../../src/GatewayRpcs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,YAAY,EAAE,WAAW,EAAiB,MAAM,iBAAiB,CAAA;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC/B,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,+CAAuC,CAAA;AAE5D;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;;IAG9B;;;;;;;;;;;;OAYG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,IAAI,CAAA;AAEjE;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;EAE/B,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC,IAAI,CAAA;AAoCnE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA1FtB;;;;;;;;;;;;OAYG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yKAsHgC,CAAA"}

package/dist/esm/GatewayRpcs.js

@@ -0,0 +1,145 @@
+/**
+ * The gateway's own remote procedures: the served read path, and the one
+ * composite mutation a product client cannot assemble safely on its own.
+ *
+ * Control mutations are not re-declared here. `@smthrs/control` `ControlRpcs`
+ * is the mutation contract and the gateway mounts it unchanged at `/rpc`, so
+ * there is exactly one wire definition of `Plan`, `Run`, `Approve`, `Deny`,
+ * `Cancel`, `Signal`, `Steer`, `Resume`, `List`, and `Watch`.
+ *
+ * The group shares `ControlRpcs.ControlAuth`, so one bearer credential
+ * authenticates both mounts and one server-stamped principal is recorded for
+ * whatever it authorizes.
+ *
+ * @since 1.0.0
+ */
+import { ControlError, ControlRpcs, ControlSchema } from "@smthrs/control";
+import { Schema } from "effect";
+import { Rpc, RpcGroup } from "effect/unstable/rpc";
+import { GatewayError } from "./GatewayError.js";
+import * as GatewaySchema from "./GatewaySchema.js";
+import * as RunHistory from "./RunHistory.js";
+/**
+ * The decision a client submits for one approval.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export const Decision = Schema.Literals(["approve", "deny"]);
+/**
+ * One approval decision, submitted with the exact payload the run published.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export const SubmitApprovalInput = Schema.Struct({
+    ...ControlSchema.ApprovalPayload.fields,
+    decision: Decision,
+    /**
+     * The answer to a question, for a gate that asks one.
+     *
+     * Most gates are a grant: approve or deny, and the decision IS the payload.
+     * A `HumanTask` gate asks for a value — prose, a choice, a JSON object — and
+     * the decision alone answers nothing. Present exactly when the row being
+     * submitted is one of those, in which case `target.requestId` names the wait
+     * point and this is what is delivered to it. A denial carries no answer: the
+     * question is refused, not answered.
+     *
+     * Additive on purpose: a client that never asks a person anything submits
+     * exactly what it submitted before.
+     */
+    answer: Schema.optional(Schema.Json)
+});
+/**
+ * What submitting an approval did.
+ *
+ * `decision` is the receipt for the grant or refusal. Control owns the
+ * decision and its durable resume delegation as one domain command.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export const SubmitApprovalOutput = Schema.Struct({
+    decision: ControlSchema.Receipt
+});
+/**
+ * The failures `Approval.Submit` can answer with: exactly the union
+ * `@smthrs/control` `Control.approve`, `Control.deny`, and — for a gate that
+ * asks a question — `Control.signal` declare, because the handler is a
+ * transport adapter over those commands and adds no failure of its own. A
+ * member none of them raises would be a recovery branch no client's code could
+ * ever reach.
+ *
+ * `NoMatchingWait` is the one an answer adds: the question was answered after
+ * the run moved on, or somebody else answered it first. `CodeDrift` is a node
+ * decision on a run whose flow changed since it started (#1807).
+ */
+const submitErrors = Schema.Union([
+    ControlError.NoMatchingWait,
+    ControlError.CodeDrift,
+    ControlError.PlanDigestMismatch,
+    ControlError.EnvelopeMismatch,
+    ControlError.AlreadyResolved,
+    ControlError.PlanNotFound,
+    ControlError.RunNotFound,
+    ControlError.InvalidInput,
+    ControlError.Unauthorized,
+    ControlError.PersistenceError,
+    ControlError.Unavailable,
+    ControlError.TransportError
+]);
+/**
+ * The failures `Run.Fork` and `Run.Verify` answer with: the history host's own
+ * refusal, `Unauthorized` for an anonymous loopback caller, or `Unavailable`
+ * from a gateway composed without a history host.
+ */
+const historyErrors = Schema.Union([RunHistory.HistoryRefused, ControlError.Unauthorized, ControlError.Unavailable]);
+/**
+ * The gateway read path, the composite approval mutation, and the run
+ * history procedures.
+ *
+ * `Approval.Submit` is the transport form of Control's single decision
+ * command. Control records the decision and durable resume delegation; the
+ * gateway never composes a second mutation.
+ *
+ * @since 1.0.0
+ * @category groups
+ */
+export const GatewayRpcs = RpcGroup.make(Rpc.make("Projection.Snapshot", {
+    defect: ControlRpcs.ControlDefect,
+    payload: Schema.Struct({
+        selector: GatewaySchema.ProjectionSelector,
+        after: Schema.optional(GatewaySchema.ProjectionCursor)
+    }),
+    success: GatewaySchema.ProjectionSnapshot,
+    error: GatewayError
+}), Rpc.make("Projection.Subscribe", {
+    defect: ControlRpcs.ControlDefect,
+    payload: Schema.Struct({
+        selector: GatewaySchema.ProjectionSelector,
+        after: Schema.optional(GatewaySchema.ProjectionCursor)
+    }),
+    success: GatewaySchema.GatewayFrame,
+    error: GatewayError,
+    stream: true
+}), Rpc.make("Approval.Submit", {
+    defect: ControlRpcs.ControlDefect,
+    payload: SubmitApprovalInput,
+    success: SubmitApprovalOutput,
+    error: submitErrors
+}), 
+/* Branches a run at a recorded frame into a parked child, as `smthrs runs fork`. */
+Rpc.make("Run.Fork", {
+    defect: ControlRpcs.ControlDefect,
+    payload: RunHistory.ForkInput,
+    success: RunHistory.ForkOutput,
+    error: historyErrors
+}), 
+/* Reports what a resume under the current flow code would replay, as `smthrs runs verify`. */
+Rpc.make("Run.Verify", {
+    defect: ControlRpcs.ControlDefect,
+    payload: RunHistory.VerifyInput,
+    success: RunHistory.VerifyReport,
+    error: historyErrors
+})).middleware(ControlRpcs.ControlAuth);
+//# sourceMappingURL=GatewayRpcs.js.map

package/dist/esm/GatewayRpcs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatewayRpcs.js","sourceRoot":"","sources":["../../src/GatewayRpcs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC/B,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AACnD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAA;AAU5D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,GAAG,aAAa,CAAC,eAAe,CAAC,MAAM;IACvC,QAAQ,EAAE,QAAQ;IAClB;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;CACrC,CAAC,CAAA;AAUF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC;IAChD,QAAQ,EAAE,aAAa,CAAC,OAAO;CAChC,CAAC,CAAA;AAUF;;;;;;;;;;;GAWG;AACH,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC;IAChC,YAAY,CAAC,cAAc;IAC3B,YAAY,CAAC,SAAS;IACtB,YAAY,CAAC,kBAAkB;IAC/B,YAAY,CAAC,gBAAgB;IAC7B,YAAY,CAAC,eAAe;IAC5B,YAAY,CAAC,YAAY;IACzB,YAAY,CAAC,WAAW;IACxB,YAAY,CAAC,YAAY;IACzB,YAAY,CAAC,YAAY;IACzB,YAAY,CAAC,gBAAgB;IAC7B,YAAY,CAAC,WAAW;IACxB,YAAY,CAAC,cAAc;CAC5B,CAAC,CAAA;AAEF;;;;GAIG;AACH,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,CAAA;AAEpH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CACtC,GAAG,CAAC,IAAI,CAAC,qBAAqB,EAAE;IAC9B,MAAM,EAAE,WAAW,CAAC,aAAa;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,QAAQ,EAAE,aAAa,CAAC,kBAAkB;QAC1C,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,gBAAgB,CAAC;KACvD,CAAC;IACF,OAAO,EAAE,aAAa,CAAC,kBAAkB;IACzC,KAAK,EAAE,YAAY;CACpB,CAAC,EACF,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE;IAC/B,MAAM,EAAE,WAAW,CAAC,aAAa;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,QAAQ,EAAE,aAAa,CAAC,kBAAkB;QAC1C,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,gBAAgB,CAAC;KACvD,CAAC;IACF,OAAO,EAAE,aAAa,CAAC,YAAY;IACnC,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,IAAI;CACb,CAAC,EACF,GAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE;IAC1B,MAAM,EAAE,WAAW,CAAC,aAAa;IACjC,OAAO,EAAE,mBAAmB;IAC5B,OAAO,EAAE,oBAAoB;IAC7B,KAAK,EAAE,YAAY;CACpB,CAAC;AACF,oFAAoF;AACpF,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE;IACnB,MAAM,EAAE,WAAW,CAAC,aAAa;IACjC,OAAO,EAAE,UAAU,CAAC,SAAS;IAC7B,OAAO,EAAE,UAAU,CAAC,UAAU;IAC9B,KAAK,EAAE,aAAa;CACrB,CAAC;AACF,8FAA8F;AAC9F,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE;IACrB,MAAM,EAAE,WAAW,CAAC,aAAa;IACjC,OAAO,EAAE,UAAU,CAAC,WAAW;IAC/B,OAAO,EAAE,UAAU,CAAC,YAAY;IAChC,KAAK,EAAE,aAAa;CACrB,CAAC,CACH,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA","sourcesContent":["/**\n * The gateway's own remote procedures: the served read path, and the one\n * composite mutation a product client cannot assemble safely on its own.\n *\n * Control mutations are not re-declared here. `@smthrs/control` `ControlRpcs`\n * is the mutation contract and the gateway mounts it unchanged at `/rpc`, so\n * there is exactly one wire definition of `Plan`, `Run`, `Approve`, `Deny`,\n * `Cancel`, `Signal`, `Steer`, `Resume`, `List`, and `Watch`.\n *\n * The group shares `ControlRpcs.ControlAuth`, so one bearer credential\n * authenticates both mounts and one server-stamped principal is recorded for\n * whatever it authorizes.\n *\n * @since 1.0.0\n */\n\nimport { ControlError, ControlRpcs, ControlSchema } from \"@smthrs/control\"\nimport { Schema } from \"effect\"\nimport { Rpc, RpcGroup } from \"effect/unstable/rpc\"\nimport { GatewayError } from \"./GatewayError.ts\"\nimport * as GatewaySchema from \"./GatewaySchema.ts\"\nimport * as RunHistory from \"./RunHistory.ts\"\n\n/**\n * The decision a client submits for one approval.\n *\n * @since 1.0.0\n * @category models\n */\nexport const Decision = Schema.Literals([\"approve\", \"deny\"])\n\n/**\n * The decision a client submits for one approval.\n *\n * @since 1.0.0\n * @category models\n */\nexport type Decision = typeof Decision.Type\n\n/**\n * One approval decision, submitted with the exact payload the run published.\n *\n * @since 1.0.0\n * @category models\n */\nexport const SubmitApprovalInput = Schema.Struct({\n  ...ControlSchema.ApprovalPayload.fields,\n  decision: Decision,\n  /**\n   * The answer to a question, for a gate that asks one.\n   *\n   * Most gates are a grant: approve or deny, and the decision IS the payload.\n   * A `HumanTask` gate asks for a value — prose, a choice, a JSON object — and\n   * the decision alone answers nothing. Present exactly when the row being\n   * submitted is one of those, in which case `target.requestId` names the wait\n   * point and this is what is delivered to it. A denial carries no answer: the\n   * question is refused, not answered.\n   *\n   * Additive on purpose: a client that never asks a person anything submits\n   * exactly what it submitted before.\n   */\n  answer: Schema.optional(Schema.Json)\n})\n\n/**\n * One approval decision, submitted with the exact payload the run published.\n *\n * @since 1.0.0\n * @category models\n */\nexport type SubmitApprovalInput = typeof SubmitApprovalInput.Type\n\n/**\n * What submitting an approval did.\n *\n * `decision` is the receipt for the grant or refusal. Control owns the\n * decision and its durable resume delegation as one domain command.\n *\n * @since 1.0.0\n * @category models\n */\nexport const SubmitApprovalOutput = Schema.Struct({\n  decision: ControlSchema.Receipt\n})\n\n/**\n * What submitting an approval did.\n *\n * @since 1.0.0\n * @category models\n */\nexport type SubmitApprovalOutput = typeof SubmitApprovalOutput.Type\n\n/**\n * The failures `Approval.Submit` can answer with: exactly the union\n * `@smthrs/control` `Control.approve`, `Control.deny`, and — for a gate that\n * asks a question — `Control.signal` declare, because the handler is a\n * transport adapter over those commands and adds no failure of its own. A\n * member none of them raises would be a recovery branch no client's code could\n * ever reach.\n *\n * `NoMatchingWait` is the one an answer adds: the question was answered after\n * the run moved on, or somebody else answered it first. `CodeDrift` is a node\n * decision on a run whose flow changed since it started (#1807).\n */\nconst submitErrors = Schema.Union([\n  ControlError.NoMatchingWait,\n  ControlError.CodeDrift,\n  ControlError.PlanDigestMismatch,\n  ControlError.EnvelopeMismatch,\n  ControlError.AlreadyResolved,\n  ControlError.PlanNotFound,\n  ControlError.RunNotFound,\n  ControlError.InvalidInput,\n  ControlError.Unauthorized,\n  ControlError.PersistenceError,\n  ControlError.Unavailable,\n  ControlError.TransportError\n])\n\n/**\n * The failures `Run.Fork` and `Run.Verify` answer with: the history host's own\n * refusal, `Unauthorized` for an anonymous loopback caller, or `Unavailable`\n * from a gateway composed without a history host.\n */\nconst historyErrors = Schema.Union([RunHistory.HistoryRefused, ControlError.Unauthorized, ControlError.Unavailable])\n\n/**\n * The gateway read path, the composite approval mutation, and the run\n * history procedures.\n *\n * `Approval.Submit` is the transport form of Control's single decision\n * command. Control records the decision and durable resume delegation; the\n * gateway never composes a second mutation.\n *\n * @since 1.0.0\n * @category groups\n */\nexport const GatewayRpcs = RpcGroup.make(\n  Rpc.make(\"Projection.Snapshot\", {\n    defect: ControlRpcs.ControlDefect,\n    payload: Schema.Struct({\n      selector: GatewaySchema.ProjectionSelector,\n      after: Schema.optional(GatewaySchema.ProjectionCursor)\n    }),\n    success: GatewaySchema.ProjectionSnapshot,\n    error: GatewayError\n  }),\n  Rpc.make(\"Projection.Subscribe\", {\n    defect: ControlRpcs.ControlDefect,\n    payload: Schema.Struct({\n      selector: GatewaySchema.ProjectionSelector,\n      after: Schema.optional(GatewaySchema.ProjectionCursor)\n    }),\n    success: GatewaySchema.GatewayFrame,\n    error: GatewayError,\n    stream: true\n  }),\n  Rpc.make(\"Approval.Submit\", {\n    defect: ControlRpcs.ControlDefect,\n    payload: SubmitApprovalInput,\n    success: SubmitApprovalOutput,\n    error: submitErrors\n  }),\n  /* Branches a run at a recorded frame into a parked child, as `smthrs runs fork`. */\n  Rpc.make(\"Run.Fork\", {\n    defect: ControlRpcs.ControlDefect,\n    payload: RunHistory.ForkInput,\n    success: RunHistory.ForkOutput,\n    error: historyErrors\n  }),\n  /* Reports what a resume under the current flow code would replay, as `smthrs runs verify`. */\n  Rpc.make(\"Run.Verify\", {\n    defect: ControlRpcs.ControlDefect,\n    payload: RunHistory.VerifyInput,\n    success: RunHistory.VerifyReport,\n    error: historyErrors\n  })\n).middleware(ControlRpcs.ControlAuth)\n"]}