ankka 0.10.0 → 0.11.0

package/dist/workflow.d.ts

@@ -1,8 +1,9 @@
 import type { Shape } from "./codec.ts";
 import type { CommandContext } from "./context.ts";
 import type { HandlerTable } from "./handlers.ts";
-import type { ComponentClient } from "./client.ts";
+import { type ComponentClient, type Secrets } from "./client.ts";
 import { StepEffects, WorkflowEffects, type WorkflowSettings } from "./effects/workflow.ts";
+import { type Services } from "./services.ts";
 export declare abstract class Workflow<S> {
     #private;
     /** Inside a command handler. */
@@ -13,6 +14,22 @@ export declare abstract class Workflow<S> {
     get entityId(): string;
     get context(): CommandContext;
     get client(): ComponentClient;
+    /**
+     * The service's secret store, in a step. A command handler is refused: it would put a database read
+     * on the workflow's single-writer path, as an entity's would.
+     */
+    get secrets(): Secrets;
+    /** A unit test's store in place of the runtime's. */
+    set secrets(store: Secrets);
+    /**
+     * Other services, called as this one, in a step. A command handler is refused, as for the secret
+     * store: it would block the workflow's other commands behind another service.
+     */
+    get services(): Services;
+    /** A unit test's in place of the runtime's. */
+    set services(services: Services);
+    /** @internal The server marks a step's binding, which is how a step is told from a command. */
+    _enterStep(): void;
     /** @internal */
     get _kind(): "workflow";
     abstract emptyState(): S;

package/dist/workflow.js

@@ -5,7 +5,10 @@
 //
 //   static readonly steps = { reserve: step("reserve", (w: CheckoutWorkflow) => w.reserve()), charge: step("charge", s.int, (w, q) => w.charge(q)) }
 //   static readonly settings = workflowSettings({ steps: { charge: { recovery: { maxRetries: 1, failoverTo: "compensate" } } } })
+import { secretsFor } from "./client.js";
+import { CommandError } from "./effects/common.js";
 import { StepEffects, WorkflowEffects } from "./effects/workflow.js";
+import { servicesFor } from "./services.js";
 export class Workflow {
     /** Inside a command handler. */
     effects = new WorkflowEffects();
@@ -36,6 +39,41 @@ export class Workflow {
             throw new Error("client is only available inside a handler or a step");
         return this.#client;
     }
+    #inStep = false;
+    #secrets;
+    /**
+     * The service's secret store, in a step. A command handler is refused: it would put a database read
+     * on the workflow's single-writer path, as an entity's would.
+     */
+    get secrets() {
+        if (!this.#inStep) {
+            throw new CommandError({ message: "a workflow reads and keeps a service secret in a step, not in a command handler", code: "BAD_REQUEST" });
+        }
+        return this.#secrets ?? secretsFor(this.client);
+    }
+    /** A unit test's store in place of the runtime's. */
+    set secrets(store) {
+        this.#secrets = store;
+    }
+    #services;
+    /**
+     * Other services, called as this one, in a step. A command handler is refused, as for the secret
+     * store: it would block the workflow's other commands behind another service.
+     */
+    get services() {
+        if (!this.#inStep) {
+            throw new CommandError({ message: "a workflow calls another service in a step, not in a command handler", code: "BAD_REQUEST" });
+        }
+        return this.#services ?? servicesFor(this.client);
+    }
+    /** A unit test's in place of the runtime's. */
+    set services(services) {
+        this.#services = services;
+    }
+    /** @internal The server marks a step's binding, which is how a step is told from a command. */
+    _enterStep() {
+        this.#inStep = true;
+    }
     /** @internal */
     get _kind() {
         return "workflow";
@@ -57,5 +95,6 @@ export class Workflow {
         this.#context = undefined;
         this.#client = undefined;
         this.#bound = false;
+        this.#inStep = false;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ankka",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Build services on ankka in TypeScript: entities, views, workflows, agents and endpoints hosted by the ankka sidecar.",
   "license": "Apache-2.0",
   "type": "module",
@@ -50,7 +50,8 @@
   "dependencies": {
     "@bufbuild/protobuf": "^2.15.0",
     "@connectrpc/connect": "^2.2.0",
-    "@connectrpc/connect-node": "^2.2.0"
+    "@connectrpc/connect-node": "^2.2.0",
+    "canonicalize": "^2.1.0"
   },
   "peerDependencies": {
     "@testcontainers/postgresql": "^12.1.0",