@voyantjs/workflows 0.0.0 → 0.6.8

package/src/trigger.ts

@@ -1,12 +1,8 @@
 // Triggering workflows from server code, plus event filter declarations.
 // Authoritative contract in docs/sdk-surface.md §6.
 
-import type {
-  Duration,
-  EnvironmentName,
-  RunStatus,
-} from "./types.js";
-import type { WorkflowHandle, EnvironmentContext } from "./workflow.js";
+import type { Duration, EnvironmentName, RunStatus } from "./types.js"
+import type { EnvironmentContext, WorkflowHandle } from "./workflow.js"
 
 // ---- workflows.* ----
 
@@ -15,86 +11,86 @@ export interface WorkflowsClient {
     workflow: WorkflowHandle<TIn, TOut> | string,
     input: TIn,
     opts?: TriggerOptions,
-  ): Promise<Run<TOut>>;
+  ): Promise<Run<TOut>>
 
-  signal(runId: string, name: string, payload: unknown, opts?: { nonce?: string }): Promise<void>;
-  completeToken(tokenId: string, payload: unknown): Promise<void>;
+  signal(runId: string, name: string, payload: unknown, opts?: { nonce?: string }): Promise<void>
+  completeToken(tokenId: string, payload: unknown): Promise<void>
 
-  cancel(runId: string, opts?: { compensate?: boolean; reason?: string }): Promise<void>;
-  retry(runId: string, opts: { mode: "re-trigger" | "resume" }): Promise<Run>;
-  replay(runId: string, opts?: { fromStepId?: string; input?: unknown }): Promise<Run>;
+  cancel(runId: string, opts?: { compensate?: boolean; reason?: string }): Promise<void>
+  retry(runId: string, opts: { mode: "re-trigger" | "resume" }): Promise<Run>
+  replay(runId: string, opts?: { fromStepId?: string; input?: unknown }): Promise<Run>
 
-  get(runId: string): Promise<RunDetail>;
-  list(opts?: ListRunsOptions): Promise<{ runs: RunSummary[]; nextCursor?: string }>;
+  get(runId: string): Promise<RunDetail>
+  list(opts?: ListRunsOptions): Promise<{ runs: RunSummary[]; nextCursor?: string }>
 
-  mintAccessToken(opts: MintAccessTokenOptions): Promise<PublicAccessToken>;
+  mintAccessToken(opts: MintAccessTokenOptions): Promise<PublicAccessToken>
 }
 
 export interface TriggerOptions {
-  idempotencyKey?: string;
-  delay?: Duration | Date;
-  debounce?: { key: string; delay: Duration; mode?: "leading" | "trailing" };
-  ttl?: Duration;
-  tags?: string[];
-  priority?: number;
-  concurrencyKey?: string;
-  lockToVersion?: string;
-  environment?: EnvironmentName;
-  issuePublicAccessToken?: boolean;
+  idempotencyKey?: string
+  delay?: Duration | Date
+  debounce?: { key: string; delay: Duration; mode?: "leading" | "trailing" }
+  ttl?: Duration
+  tags?: string[]
+  priority?: number
+  concurrencyKey?: string
+  lockToVersion?: string
+  environment?: EnvironmentName
+  issuePublicAccessToken?: boolean
 }
 
 export interface Run<TOut = unknown> {
-  id: string;
-  workflowId: string;
-  status: RunStatus;
-  startedAt: number;
-  accessToken?: string;
+  id: string
+  workflowId: string
+  status: RunStatus
+  startedAt: number
+  accessToken?: string
   /** Phantom; used only for TypeScript inference. */
-  readonly __output?: TOut;
+  readonly __output?: TOut
 }
 
 export interface RunSummary {
-  id: string;
-  workflowId: string;
-  status: RunStatus;
-  startedAt: number;
-  completedAt?: number;
-  tags: string[];
-  environment: EnvironmentName;
+  id: string
+  workflowId: string
+  status: RunStatus
+  startedAt: number
+  completedAt?: number
+  tags: string[]
+  environment: EnvironmentName
 }
 
 export interface RunDetail<TOut = unknown> extends RunSummary {
-  version: string;
-  input: unknown;
-  output?: TOut;
-  error?: unknown;
-  durationMs?: number;
+  version: string
+  input: unknown
+  output?: TOut
+  error?: unknown
+  durationMs?: number
   // ... full shape in docs/runtime-protocol.md §4.2
 }
 
 export interface ListRunsOptions {
-  workflowId?: string;
-  status?: RunStatus | RunStatus[];
-  environment?: EnvironmentName;
-  tag?: string;
-  since?: Date | number;
-  until?: Date | number;
-  cursor?: string;
-  limit?: number;
+  workflowId?: string
+  status?: RunStatus | RunStatus[]
+  environment?: EnvironmentName
+  tag?: string
+  since?: Date | number
+  until?: Date | number
+  cursor?: string
+  limit?: number
 }
 
 export interface MintAccessTokenOptions {
   target:
     | { kind: "run"; runId: string }
     | { kind: "workflow"; workflowId: string }
-    | { kind: "tag"; tag: string };
-  scope: ("read" | "trigger" | "cancel")[];
-  ttl?: Duration;
+    | { kind: "tag"; tag: string }
+  scope: ("read" | "trigger" | "cancel")[]
+  ttl?: Duration
 }
 
 export interface PublicAccessToken {
-  token: string;
-  exp: number;
+  token: string
+  exp: number
 }
 
 /**
@@ -109,30 +105,27 @@ export const workflows: WorkflowsClient = new Proxy({} as WorkflowsClient, {
       throw new Error(
         `@voyantjs/workflows: workflows.${method}() requires the Voyant Cloud client. ` +
           `Install + configure it via @voyantjs/client, or see docs/sdk-surface.md §6.`,
-      );
-    };
+      )
+    }
   },
-});
+})
 
 // ---- trigger.on ----
 
 export interface EventFilterHandle {
-  readonly id: string;
-  readonly event: string;
+  readonly id: string
+  readonly event: string
 }
 
 export interface EventFilterDeclaration<T> {
-  target: WorkflowHandle<T, unknown>;
-  match?: (
-    payload: T,
-    ctx: { environment: EnvironmentContext; project: { id: string } },
-  ) => boolean;
-  scope?: string;
-  input?: (payload: T) => unknown;
+  target: WorkflowHandle<T, unknown>
+  match?: (payload: T, ctx: { environment: EnvironmentContext; project: { id: string } }) => boolean
+  scope?: string
+  input?: (payload: T) => unknown
 }
 
 export interface TriggerApi {
-  on<T = unknown>(event: string, filter: EventFilterDeclaration<T>): EventFilterHandle;
+  on<T = unknown>(event: string, filter: EventFilterDeclaration<T>): EventFilterHandle
 }
 
 export const trigger: TriggerApi = {
@@ -141,6 +134,6 @@ export const trigger: TriggerApi = {
       "@voyantjs/workflows: trigger.on() must be collected by `voyant workflows build` and " +
         "registered with the orchestrator at deploy time; it has no runtime behavior when " +
         "called directly. See docs/sdk-surface.md §6.2.",
-    );
+    )
   },
-};
+}

package/src/types.ts

@@ -1,9 +1,7 @@
 // Core type aliases used across the SDK.
 // Authoritative definitions in docs/sdk-surface.md §0 and §2.
 
-export type Duration =
-  | number
-  | `${number}${"ms" | "s" | "m" | "h" | "d" | "w"}`;
+export type Duration = number | `${number}${"ms" | "s" | "m" | "h" | "d" | "w"}`
 
 /**
  * Cloudflare Container instance types — the set Voyant Cloud honors
@@ -31,9 +29,9 @@ export type MachineType =
   | "standard-2"
   | "standard-3"
   | "standard-4"
-  | (string & {});
+  | (string & {})
 
-export type EnvironmentName = "production" | "preview" | "development";
+export type EnvironmentName = "production" | "preview" | "development"
 
 export type RunStatus =
   | "pending"
@@ -46,7 +44,7 @@ export type RunStatus =
   | "cancelled_by_version_sunset"
   | "compensated"
   | "compensation_failed"
-  | "timed_out";
+  | "timed_out"
 
 export type ExecutionStatus =
   | "CREATED"
@@ -55,27 +53,27 @@ export type ExecutionStatus =
   | "EXECUTING_WITH_WAITPOINTS"
   | "SUSPENDED"
   | "PENDING_CANCEL"
-  | "FINISHED";
+  | "FINISHED"
 
-export type WaitpointKind = "DATETIME" | "EVENT" | "SIGNAL" | "RUN" | "MANUAL";
+export type WaitpointKind = "DATETIME" | "EVENT" | "SIGNAL" | "RUN" | "MANUAL"
 
 export interface RetryPolicy {
-  max?: number;
-  backoff?: "exponential" | "linear" | "fixed";
-  initial?: Duration;
-  maxDelay?: Duration;
+  max?: number
+  backoff?: "exponential" | "linear" | "fixed"
+  initial?: Duration
+  maxDelay?: Duration
 }
 
 export interface RateLimitSpec {
-  key: string | ((input: unknown, ctx: { run: { id: string }; project: { id: string } }) => string);
-  limit: number | ((input: unknown) => number);
-  units?: number | ((input: unknown) => number);
-  window: Duration;
-  onLimit?: "queue" | "fail";
+  key: string | ((input: unknown, ctx: { run: { id: string }; project: { id: string } }) => string)
+  limit: number | ((input: unknown) => number)
+  units?: number | ((input: unknown) => number)
+  window: Duration
+  onLimit?: "queue" | "fail"
 }
 
 export type RunTrigger =
   | { kind: "api"; actor?: string; accessTokenId?: string }
   | { kind: "schedule"; scheduleId: string }
   | { kind: "event"; eventId: string; eventType: string; filterId: string }
-  | { kind: "parent"; parentRunId: string; parentStepId: string };
+  | { kind: "parent"; parentRunId: string; parentStepId: string }