@voltro/workflow 0.84.0 → 0.85.0

package/dist/primitives.d.ts

@@ -1,13 +1,14 @@
-import { DurableClock as durableClock } from '@effect/workflow';
-import { DurableQueue as durableQueueModule } from '@effect/workflow';
-import { DurableRateLimiter as durableRateLimiterModule } from '@effect/workflow';
+import { Context } from 'effect';
+import { DurableClock as durableClock } from 'effect/workflow';
+import { DurableQueue as durableQueueModule } from 'effect/workflow';
 import { Duration } from 'effect';
 import { Effect } from 'effect';
-import { FiberRef } from 'effect';
+import { RateLimiter } from 'effect/persistence';
 import { Schema } from 'effect';
-import { Activity as stepModule } from '@effect/workflow';
+import { Activity as stepModule } from 'effect/workflow';
 import { WorkflowAccessOptions } from '@voltro/protocol';
-import { Workflow as workflowModule } from '@effect/workflow';
+import { WorkflowEngine } from 'effect/workflow';
+import { Workflow as workflowModule } from 'effect/workflow';
 
 /**
  * Assert every workflow sharing a `concurrency.pool` declares the SAME limit.
@@ -34,7 +35,7 @@ export declare const assertConsistentPools: (controls: ReadonlyArray<ResolvedFlo
  * whose row already exists). A first entry has no prior shape, so the whole
  * mechanism costs one `FiberRef` read per step and nothing else.
  */
-export declare const CurrentWorkflowReplayShape: FiberRef.FiberRef<ReplayShapeTracker | undefined>;
+export declare const CurrentWorkflowReplayShape: Context.Reference<ReplayShapeTracker | undefined>;
 
 /** The DECODED payload type. Mirrors `Workflow.make`'s own `idempotencyKey`
  *  parameter, so the two never disagree about what a payload is. */
@@ -65,18 +66,16 @@ export declare const deferringControlsOf: (control: ResolvedFlowControl | undefi
 export { durableClock }
 
 /** Define a durable queue for concurrency-controlled side work. */
-export declare const durableQueue: typeof durableQueueModule.make & (<Options extends Parameters<typeof durableQueueModule.make>[0] & {
+export declare const durableQueue: <Payload extends Schema.Top | Schema.Struct.Fields, Success extends Schema.Top = typeof Schema.Void, Error extends Schema.Top = typeof Schema.Never>(options: Parameters<typeof durableQueueModule.make<Payload, Success, Error>>[0] & {
     readonly encrypted?: boolean;
-}>(options: Options) => ReturnType<typeof durableQueueModule.make>);
+}) => ReturnType<typeof durableQueueModule.make<Payload, Success, Error>>;
 
 export { durableQueueModule }
 
-export { durableRateLimiterModule }
-
 /** A duration in any shape Effect accepts: `'15 minutes'`, `900_000`,
  *  `Duration.minutes(15)`. Same input type `sleep({ duration })` takes, so
  *  there is one duration vocabulary in the whole workflow surface. */
-export declare type FlowDuration = Duration.DurationInput;
+export declare type FlowDuration = Duration.Input;
 
 /** The resolved flow-control declaration attached to a workflow definition, or
  *  `undefined` when it declares none — in which case every start takes exactly
@@ -102,6 +101,10 @@ export declare const hasCancelOn: (control: ResolvedFlowControl | undefined) =>
  *  two writes per start for a decision that is always "admit". */
 export declare const hasFlowControl: (control: ResolvedFlowControl | undefined) => boolean;
 
+/** A value that can carry definition metadata: a workflow definition is a
+ *  callable in v4 (`Workflow.make` returns a function), a queue is an object. */
+export declare const isCarrier: (value: unknown) => value is object;
+
 export declare const isWorkflowWorkerLayer: (value: unknown) => value is WorkflowWorkerLayerBrand;
 
 /**
@@ -135,7 +138,7 @@ export declare type NondeterminismKind = 'unreached-step' | 'extra-step-occurren
 declare type NormaliseWorkflowMessages<M extends WorkflowMessageSchemas | undefined> = {
     readonly signals: M extends {
         readonly signals: infer Signals;
-    } ? NonNullable<Signals> & Readonly<Record<string, Schema.Schema.Any>> : {};
+    } ? NonNullable<Signals> & Readonly<Record<string, Schema.Top>> : {};
     readonly updates: M extends {
         readonly updates: infer Updates;
     } ? NonNullable<Updates> & Readonly<Record<string, WorkflowMessagePairSchemas>> : {};
@@ -176,7 +179,7 @@ declare type NormaliseWorkflowMessages<M extends WorkflowMessageSchemas | undefi
  * however many times it replays and whatever the deployed code says — which is
  * the property that makes the branch deterministic across a redeploy.
  *
- * Under `@effect/workflow` the naive implementation does the opposite: an
+ * Under `effect/workflow` the naive implementation does the opposite: an
  * activity that is ABSENT from an old run's journal EXECUTES on replay (the
  * journal is keyed name/attempt), so a marker journaled by an activity would
  * answer `true` for exactly the old runs it must answer `false` for. Reading
@@ -214,8 +217,26 @@ export declare const processQueue: typeof durableQueueModule.process;
  *  inferred type) is what emits in the `.d.ts`, so it stays portable. */
 export declare const queueWorker: typeof durableQueueModule.worker;
 
-/** Durable rate limiter activity. Delays through the workflow clock. */
-export declare const rateLimit: typeof durableRateLimiterModule.rateLimit;
+/**
+ * Durable rate limit. Consumes from the shared limiter; when the window is
+ * exhausted the wait is a durable clock sleep under `name`, so a deploy or a
+ * worker crash does not lose the delay and a replay does not consume twice.
+ */
+export declare const rateLimit: (options: RateLimitOptions) => Effect.Effect<void, RateLimiter.RateLimiterError, RateLimiter.RateLimiter | WorkflowEngine.WorkflowEngine | WorkflowEngine.WorkflowInstance>;
+
+/** What `rateLimit` admits: one unit of work under `limit` per `window` for
+ *  `key`, counted by the `RateLimiter` service the boot provides. */
+export declare interface RateLimitOptions {
+    /** Names this ADMISSION within the run: the decision is journaled under it, so a
+     *  replay reads it back instead of consuming again. Two calls with the same name
+     *  in one run share one decision — give each call its own (`send/${i}` in a loop). */
+    readonly name: string;
+    readonly window: Duration.Input;
+    readonly limit: number;
+    readonly key: string;
+    readonly algorithm?: 'fixed-window' | 'token-bucket' | undefined;
+    readonly tokens?: number | undefined;
+}
 
 /** The slice of a `_voltro_workflow_run_steps` row this needs. */
 export declare interface RecordedStepShape {
@@ -256,7 +277,7 @@ export declare const reportNondeterminism: (findings: ReadonlyArray<Nondetermini
  *  event at all". */
 export declare interface ResolvedCancelOn {
     readonly event: string;
-    readonly schema: Schema.Schema.Any;
+    readonly schema: Schema.Top;
     readonly match: (event: unknown, payload: unknown) => boolean;
     readonly withinMs?: number;
     readonly reason: string;
@@ -370,7 +391,7 @@ export declare const sleepUntil: (options: {
     readonly until: Date | number;
 }) => Effect.Effect<void, never, never>;
 
-export declare const step: <R, Success extends Schema.Schema.Any = typeof Schema.Void, Error extends Schema.Schema.All = typeof Schema.Never>(options: StepOptions<R, Success, Error>) => ReturnType<typeof stepModule.make<R, Success, Error>>;
+export declare const step: <R, Success extends Schema.Top = typeof Schema.Void, Error extends Schema.Top = typeof Schema.Never>(options: StepOptions<R, Success, Error>) => ReturnType<typeof stepModule.make<R, Success, Error>>;
 
 /**
  * Derive a deterministic idempotency key for the current workflow run,
@@ -389,7 +410,7 @@ export { stepModule }
 /**
  * Define a checkpointed step (activity) inside a workflow body.
  *
- * Wraps `@effect/workflow`'s `Activity.make` to record every
+ * Wraps `effect/workflow`'s `Activity.make` to record every
  * invocation in `_voltro_workflow_run_steps`. The wrapping is
  * transparent — accepts everything `Activity.make` accepts, plus an
  * optional `input` field whose value is persisted to the step row
@@ -408,7 +429,7 @@ export { stepModule }
  * Without the recorder service in scope (unit tests, etc.) the input
  * is dropped and the wrap is a no-op.
  */
-declare type StepOptions<R, Success extends Schema.Schema.Any, Error extends Schema.Schema.All> = {
+declare type StepOptions<R, Success extends Schema.Top, Error extends Schema.Top> = {
     readonly name: string;
     readonly success?: Success | undefined;
     readonly error?: Error | undefined;
@@ -518,7 +539,9 @@ export declare const withCompensation: typeof workflowModule.withCompensation;
 
 export declare const workflow: WorkflowFn;
 
-declare type WorkflowBaseOptions = Parameters<WorkflowMake>[0];
+declare type WorkflowBaseOptions = Parameters<WorkflowMake>[1] & {
+    readonly name: Parameters<WorkflowMake>[0];
+};
 
 /**
  * Collect many starts into ONE run over an array of items.
@@ -577,7 +600,7 @@ export declare interface WorkflowBatch<Item> {
  * }],
  * ```
  */
-export declare interface WorkflowCancelOn<EventSchema extends Schema.Schema.Any, Payload> {
+export declare interface WorkflowCancelOn<EventSchema extends Schema.Top, Payload> {
     /** The event NAME, exactly as `ctx.events.publish` writes it. */
     readonly event: string;
     /** Decoded before `match` sees it, so the predicate reads the domain type
@@ -611,7 +634,7 @@ export declare interface WorkflowCancelOn<EventSchema extends Schema.Schema.Any,
  *  the per-entry-inferred {@link WorkflowCancelOnList}; this is what survives
  *  erasure, and it is deliberately not the public spelling. */
 export declare interface WorkflowCancelOnDeclared {
-    readonly cancelOn?: ReadonlyArray<WorkflowCancelOn<Schema.Schema.Any, never>>;
+    readonly cancelOn?: ReadonlyArray<WorkflowCancelOn<Schema.Top, never>>;
 }
 
 /** The `cancelOn` array as declared, with each entry's event type inferred
@@ -619,7 +642,7 @@ export declare interface WorkflowCancelOnDeclared {
  *  per-entry inference work — a plain `ReadonlyArray<WorkflowCancelOn<…>>`
  *  collapses every entry's event to the constraint (`any`), which is how the
  *  predicate silently stops being checked. */
-export declare type WorkflowCancelOnList<Cancels extends ReadonlyArray<Schema.Schema.Any>, Payload> = {
+export declare type WorkflowCancelOnList<Cancels extends ReadonlyArray<Schema.Top>, Payload> = {
     readonly [I in keyof Cancels]: WorkflowCancelOn<Cancels[I], Payload>;
 };
 
@@ -820,7 +843,7 @@ export declare const WorkflowFlowControlProperty = "__voltroWorkflowFlowControl"
  * meaning anything if this ever regresses to `any` — which is precisely what
  * all three failed attempts did.
  */
-declare type WorkflowFn = <const Name extends string, Payload extends WorkflowPayloadInput, Success extends Schema.Schema.Any = typeof Schema.Void, Error extends Schema.Schema.All = typeof Schema.Never, const Messages extends WorkflowMessageSchemas | undefined = undefined, Cancels extends ReadonlyArray<Schema.Schema.Any> = readonly []>(options: {
+declare type WorkflowFn = <const Name extends string, Payload extends WorkflowPayloadInput, Success extends Schema.Top = typeof Schema.Void, Error extends Schema.Top = typeof Schema.Never, const Messages extends WorkflowMessageSchemas | undefined = undefined, Cancels extends ReadonlyArray<Schema.Top> = readonly []>(options: {
     readonly name: Name;
     readonly payload: Payload;
     readonly idempotencyKey: (payload: DecodedPayload<Payload>) => string;
@@ -838,13 +861,15 @@ declare type WorkflowFn = <const Name extends string, Payload extends WorkflowPa
     readonly schedule?: WorkflowScheduleDeclaration<DecodedPayload<Payload>>;
 } & Omit<WorkflowBaseOptions, 'name' | 'payload' | 'idempotencyKey' | 'success' | 'error'> & WorkflowVersionOptions & {
     readonly messages?: Messages;
-} & WorkflowFlowControl<DecodedPayload<Payload>> & WorkflowAccessOptions<DecodedPayload<Payload>>) => workflowModule.Workflow<Name, PayloadSchemaOf<Payload>, Success, Error> & WorkflowMessagesCarrier<NormaliseWorkflowMessages<Messages>>;
+} & WorkflowFlowControl<DecodedPayload<Payload>> & WorkflowAccessOptions<DecodedPayload<Payload>>) => workflowModule.Workflow<Name, PayloadSchemaOf<Payload>, Success, Error> & {
+    readonly name: Name;
+} & WorkflowMessagesCarrier<NormaliseWorkflowMessages<Messages>>;
 
 declare type WorkflowMake = typeof workflowModule.make;
 
 export declare interface WorkflowMessagePairSchemas {
-    readonly payload: Schema.Schema.Any;
-    readonly success: Schema.Schema.Any;
+    readonly payload: Schema.Top;
+    readonly success: Schema.Top;
 }
 
 export declare interface WorkflowMessagesCarrier<M extends WorkflowMessagesMetadata = WorkflowMessagesMetadata> {
@@ -862,12 +887,12 @@ export declare interface WorkflowMessagesCarrier<M extends WorkflowMessagesMetad
  * and updates (synchronous, with a result) are the channels that exist.
  */
 export declare interface WorkflowMessageSchemas {
-    readonly signals?: Readonly<Record<string, Schema.Schema.Any>>;
+    readonly signals?: Readonly<Record<string, Schema.Top>>;
     readonly updates?: Readonly<Record<string, WorkflowMessagePairSchemas>>;
 }
 
 export declare interface WorkflowMessagesMetadata {
-    readonly signals: Readonly<Record<string, Schema.Schema.Any>>;
+    readonly signals: Readonly<Record<string, Schema.Top>>;
     readonly updates: Readonly<Record<string, WorkflowMessagePairSchemas>>;
 }
 
@@ -1049,7 +1074,7 @@ export declare interface WorkflowVersionOptions {
      * suspended-on-failure run shows up under `--status suspended`, NOT in the
      * dead-letter view — it is recoverable, not dead.
      *
-     * Maps to `@effect/workflow`'s `SuspendOnFailure` annotation.
+     * Maps to `effect/workflow`'s `SuspendOnFailure` annotation.
      */
     readonly suspendOnFailure?: boolean;
 }

package/dist/primitives.js

@@ -1,2 +1,2 @@
-import { A as e, C as t, D as n, E as r, G as i, J as a, K as o, O as s, S as c, T as l, U as u, W as d, _ as f, a as p, b as m, c as h, d as g, f as _, g as v, h as y, i as b, j as x, k as S, l as C, m as w, n as T, o as E, p as D, q as O, r as k, s as A, t as j, u as M, v as N, w as P, x as F, y as I } from "./primitives-Btjhjm8P.js";
-export { P as CurrentWorkflowReplayShape, s as DEFAULT_WORKFLOW_SCHEDULE_MAX_RUNTIME_MS, u as DEFERRING_CONTROLS, j as WorkflowFlowControlProperty, T as WorkflowMessagesProperty, S as WorkflowScheduleProperty, k as WorkflowVersionTypeId, b as WorkflowWorkerLayerTypeId, d as assertConsistentPools, i as deferringControlsOf, p as durableClock, E as durableQueue, A as durableQueueModule, h as durableRateLimiterModule, C as getWorkflowFlowControl, e as getWorkflowSchedule, M as getWorkflowVersionMetadata, o as hasCancelOn, O as hasFlowControl, g as isWorkflowWorkerLayer, l as makeReplayShapeTracker, r as nondeterminismEventPayload, _ as patch, D as processQueue, w as queueWorker, y as rateLimit, n as reportNondeterminism, v as sleep, f as sleepUntil, N as step, I as stepIdempotencyKey, m as stepModule, a as validateFlowControl, x as validateWorkflowSchedule, F as withCompensation, c as workflow, t as workflowModule };
+import { A as e, C as t, D as n, E as r, G as i, J as a, K as o, O as s, S as c, T as l, U as u, W as d, _ as f, a as p, b as m, c as h, d as g, f as _, g as v, h as y, i as b, j as x, k as S, l as C, m as w, n as T, o as E, p as D, q as O, r as k, s as A, t as j, u as M, v as N, w as P, x as F, y as I } from "./primitives-DX04WTWh.js";
+export { P as CurrentWorkflowReplayShape, s as DEFAULT_WORKFLOW_SCHEDULE_MAX_RUNTIME_MS, u as DEFERRING_CONTROLS, j as WorkflowFlowControlProperty, T as WorkflowMessagesProperty, S as WorkflowScheduleProperty, k as WorkflowVersionTypeId, b as WorkflowWorkerLayerTypeId, d as assertConsistentPools, i as deferringControlsOf, p as durableClock, E as durableQueue, A as durableQueueModule, h as getWorkflowFlowControl, e as getWorkflowSchedule, C as getWorkflowVersionMetadata, o as hasCancelOn, O as hasFlowControl, M as isCarrier, g as isWorkflowWorkerLayer, l as makeReplayShapeTracker, r as nondeterminismEventPayload, _ as patch, D as processQueue, w as queueWorker, y as rateLimit, n as reportNondeterminism, v as sleep, f as sleepUntil, N as step, I as stepIdempotencyKey, m as stepModule, a as validateFlowControl, x as validateWorkflowSchedule, F as withCompensation, c as workflow, t as workflowModule };