semola 0.5.3 → 0.6.0

package/dist/lib/workflow/index.d.cts

@@ -1,7 +1,150 @@
-import { StepHandler, Workflow, WorkflowError, WorkflowExecution, WorkflowHandlerContext, WorkflowMeta, WorkflowMetaField, WorkflowOptions, WorkflowStartOptions, WorkflowStartResult, WorkflowStatus } from "../../workflow/types.cjs";
-
+//#region src/lib/workflow/types.d.ts
+type WorkflowStatus = "pending" | "running" | "completed" | "failed" | "cancelled";
+type StepSnapshot = {
+  name: string;
+  completedAt: number;
+};
+type WorkflowExecution<TInput, TResult> = {
+  id: string;
+  name: string;
+  status: WorkflowStatus;
+  input: TInput;
+  result: TResult | null;
+  error: string | null;
+  createdAt: number;
+  updatedAt: number;
+  completedAt: number | null;
+  failedAt: number | null;
+  cancelledAt: number | null;
+  steps: StepSnapshot[];
+};
+type StepHandler<TInput, TStep> = (input: TInput, signal: AbortSignal) => TStep | Promise<TStep>;
+type WorkflowHandlerContext<TInput> = {
+  input: TInput;
+  executionId: string;
+  signal: AbortSignal;
+  step: <TStep>(name: string, handler: StepHandler<TInput, TStep>) => Promise<TStep>;
+};
+type SerializeValue<T> = (value: T) => string;
+type DeserializeValue<T> = (raw: string) => T;
+type WorkflowStepErrorRecord = {
+  attempt: number;
+  error: string;
+  timestamp: number;
+};
+type WorkflowStepRetryContext<TInput> = {
+  executionId: string;
+  input: TInput;
+  stepName: string;
+  error: string;
+  attempt: number;
+  nextRetryDelayMs: number;
+  retriesRemaining: number;
+};
+type WorkflowStepErrorContext<TInput> = {
+  executionId: string;
+  input: TInput;
+  stepName: string;
+  error: string;
+  totalAttempts: number;
+  errorHistory: WorkflowStepErrorRecord[];
+};
+type WorkflowHooks<TInput, TResult> = {
+  onStart?: (context: {
+    executionId: string;
+    input: TInput;
+  }) => void | Promise<void>;
+  onRetry?: (context: WorkflowStepRetryContext<TInput>) => void | Promise<void>;
+  onError?: (context: WorkflowStepErrorContext<TInput>) => void | Promise<void>;
+  onComplete?: (context: {
+    executionId: string;
+    input: TInput;
+    result: TResult;
+  }) => void | Promise<void>;
+  onCancel?: (context: {
+    executionId: string;
+    input: TInput;
+  }) => void | Promise<void>;
+};
+type WorkflowRetryBackoff = {
+  baseDelay?: number;
+  multiplier?: number;
+  maxDelay?: number;
+};
+type WorkflowOptions<TInput, TResult> = {
+  name: string;
+  redis: Bun.RedisClient;
+  handler: (context: WorkflowHandlerContext<TInput>) => TResult | Promise<TResult>;
+  retries?: number;
+  retryBackoff?: WorkflowRetryBackoff;
+  hooks?: WorkflowHooks<TInput, TResult>;
+  lockTTL?: number;
+  serializeInput?: SerializeValue<TInput>;
+  deserializeInput?: DeserializeValue<TInput>;
+  serializeResult?: SerializeValue<TResult>;
+  deserializeResult?: DeserializeValue<TResult>;
+  serializeStepOutput?: SerializeValue<unknown>;
+  deserializeStepOutput?: DeserializeValue<unknown>;
+};
+type WorkflowStartOptions = {
+  executionId?: string;
+};
+type WorkflowStartResult = {
+  executionId: string;
+  status: WorkflowStatus;
+};
+type WorkflowCancelResult = {
+  status: WorkflowStatus;
+  executionId: string;
+  updatedAt: number;
+  cancelledAt: number;
+  createdAt: number;
+};
+type WorkflowMeta = {
+  status: string;
+  input: string;
+  result: string;
+  error: string;
+  createdAt: string;
+  updatedAt: string;
+  completedAt: string;
+  failedAt: string;
+  cancelledAt: string;
+  steps: string;
+};
+type WorkflowMetaField = keyof WorkflowMeta;
+type Workflow<TInput, TResult> = {
+  start: (input: TInput, options?: WorkflowStartOptions) => Promise<WorkflowStartResult>;
+  run: (input: TInput, options?: WorkflowStartOptions) => Promise<TResult | null>;
+  resume: (executionId: string) => Promise<WorkflowStartResult>;
+  get: (executionId: string) => Promise<WorkflowExecution<TInput, TResult>>;
+  cancel: (executionId: string) => Promise<WorkflowCancelResult>;
+};
+//#endregion
+//#region src/lib/workflow/errors.d.ts
+declare class WorkflowError extends Error {
+  constructor(message: string);
+}
+declare class NotFoundError extends Error {
+  constructor(message: string);
+}
+declare class StateError extends Error {
+  constructor(message: string);
+}
+declare class SerializationError extends Error {
+  constructor(message: string);
+}
+declare class ExecutionError extends Error {
+  constructor(message: string);
+}
+declare class LockError extends Error {
+  constructor(message: string);
+}
+declare class CancelledError extends Error {
+  constructor(message: string);
+}
+//#endregion
 //#region src/lib/workflow/index.d.ts
 declare const defineWorkflow: <TInput, TResult = void>(options: WorkflowOptions<TInput, TResult>) => Workflow<TInput, TResult>;
 //#endregion
-export { type StepHandler, type Workflow, type WorkflowError, type WorkflowExecution, type WorkflowHandlerContext, type WorkflowMeta, type WorkflowMetaField, type WorkflowOptions, type WorkflowStartOptions, type WorkflowStartResult, type WorkflowStatus, defineWorkflow };
-//# sourceMappingURL=index.d.cts.map
+export { CancelledError, ExecutionError, LockError, NotFoundError, SerializationError, StateError, type StepHandler, type Workflow, WorkflowError, type WorkflowExecution, type WorkflowHandlerContext, type WorkflowHooks, type WorkflowMeta, type WorkflowMetaField, type WorkflowOptions, type WorkflowRetryBackoff, type WorkflowStartOptions, type WorkflowStartResult, type WorkflowStatus, type WorkflowStepErrorContext, type WorkflowStepErrorRecord, type WorkflowStepRetryContext, defineWorkflow };

package/dist/lib/workflow/index.d.mts

@@ -1,7 +1,150 @@
-import { StepHandler, Workflow, WorkflowError, WorkflowExecution, WorkflowHandlerContext, WorkflowMeta, WorkflowMetaField, WorkflowOptions, WorkflowStartOptions, WorkflowStartResult, WorkflowStatus } from "../../workflow/types.mjs";
-
+//#region src/lib/workflow/types.d.ts
+type WorkflowStatus = "pending" | "running" | "completed" | "failed" | "cancelled";
+type StepSnapshot = {
+  name: string;
+  completedAt: number;
+};
+type WorkflowExecution<TInput, TResult> = {
+  id: string;
+  name: string;
+  status: WorkflowStatus;
+  input: TInput;
+  result: TResult | null;
+  error: string | null;
+  createdAt: number;
+  updatedAt: number;
+  completedAt: number | null;
+  failedAt: number | null;
+  cancelledAt: number | null;
+  steps: StepSnapshot[];
+};
+type StepHandler<TInput, TStep> = (input: TInput, signal: AbortSignal) => TStep | Promise<TStep>;
+type WorkflowHandlerContext<TInput> = {
+  input: TInput;
+  executionId: string;
+  signal: AbortSignal;
+  step: <TStep>(name: string, handler: StepHandler<TInput, TStep>) => Promise<TStep>;
+};
+type SerializeValue<T> = (value: T) => string;
+type DeserializeValue<T> = (raw: string) => T;
+type WorkflowStepErrorRecord = {
+  attempt: number;
+  error: string;
+  timestamp: number;
+};
+type WorkflowStepRetryContext<TInput> = {
+  executionId: string;
+  input: TInput;
+  stepName: string;
+  error: string;
+  attempt: number;
+  nextRetryDelayMs: number;
+  retriesRemaining: number;
+};
+type WorkflowStepErrorContext<TInput> = {
+  executionId: string;
+  input: TInput;
+  stepName: string;
+  error: string;
+  totalAttempts: number;
+  errorHistory: WorkflowStepErrorRecord[];
+};
+type WorkflowHooks<TInput, TResult> = {
+  onStart?: (context: {
+    executionId: string;
+    input: TInput;
+  }) => void | Promise<void>;
+  onRetry?: (context: WorkflowStepRetryContext<TInput>) => void | Promise<void>;
+  onError?: (context: WorkflowStepErrorContext<TInput>) => void | Promise<void>;
+  onComplete?: (context: {
+    executionId: string;
+    input: TInput;
+    result: TResult;
+  }) => void | Promise<void>;
+  onCancel?: (context: {
+    executionId: string;
+    input: TInput;
+  }) => void | Promise<void>;
+};
+type WorkflowRetryBackoff = {
+  baseDelay?: number;
+  multiplier?: number;
+  maxDelay?: number;
+};
+type WorkflowOptions<TInput, TResult> = {
+  name: string;
+  redis: Bun.RedisClient;
+  handler: (context: WorkflowHandlerContext<TInput>) => TResult | Promise<TResult>;
+  retries?: number;
+  retryBackoff?: WorkflowRetryBackoff;
+  hooks?: WorkflowHooks<TInput, TResult>;
+  lockTTL?: number;
+  serializeInput?: SerializeValue<TInput>;
+  deserializeInput?: DeserializeValue<TInput>;
+  serializeResult?: SerializeValue<TResult>;
+  deserializeResult?: DeserializeValue<TResult>;
+  serializeStepOutput?: SerializeValue<unknown>;
+  deserializeStepOutput?: DeserializeValue<unknown>;
+};
+type WorkflowStartOptions = {
+  executionId?: string;
+};
+type WorkflowStartResult = {
+  executionId: string;
+  status: WorkflowStatus;
+};
+type WorkflowCancelResult = {
+  status: WorkflowStatus;
+  executionId: string;
+  updatedAt: number;
+  cancelledAt: number;
+  createdAt: number;
+};
+type WorkflowMeta = {
+  status: string;
+  input: string;
+  result: string;
+  error: string;
+  createdAt: string;
+  updatedAt: string;
+  completedAt: string;
+  failedAt: string;
+  cancelledAt: string;
+  steps: string;
+};
+type WorkflowMetaField = keyof WorkflowMeta;
+type Workflow<TInput, TResult> = {
+  start: (input: TInput, options?: WorkflowStartOptions) => Promise<WorkflowStartResult>;
+  run: (input: TInput, options?: WorkflowStartOptions) => Promise<TResult | null>;
+  resume: (executionId: string) => Promise<WorkflowStartResult>;
+  get: (executionId: string) => Promise<WorkflowExecution<TInput, TResult>>;
+  cancel: (executionId: string) => Promise<WorkflowCancelResult>;
+};
+//#endregion
+//#region src/lib/workflow/errors.d.ts
+declare class WorkflowError extends Error {
+  constructor(message: string);
+}
+declare class NotFoundError extends Error {
+  constructor(message: string);
+}
+declare class StateError extends Error {
+  constructor(message: string);
+}
+declare class SerializationError extends Error {
+  constructor(message: string);
+}
+declare class ExecutionError extends Error {
+  constructor(message: string);
+}
+declare class LockError extends Error {
+  constructor(message: string);
+}
+declare class CancelledError extends Error {
+  constructor(message: string);
+}
+//#endregion
 //#region src/lib/workflow/index.d.ts
 declare const defineWorkflow: <TInput, TResult = void>(options: WorkflowOptions<TInput, TResult>) => Workflow<TInput, TResult>;
 //#endregion
-export { type StepHandler, type Workflow, type WorkflowError, type WorkflowExecution, type WorkflowHandlerContext, type WorkflowMeta, type WorkflowMetaField, type WorkflowOptions, type WorkflowStartOptions, type WorkflowStartResult, type WorkflowStatus, defineWorkflow };
-//# sourceMappingURL=index.d.mts.map
+export { CancelledError, ExecutionError, LockError, NotFoundError, SerializationError, StateError, type StepHandler, type Workflow, WorkflowError, type WorkflowExecution, type WorkflowHandlerContext, type WorkflowHooks, type WorkflowMeta, type WorkflowMetaField, type WorkflowOptions, type WorkflowRetryBackoff, type WorkflowStartOptions, type WorkflowStartResult, type WorkflowStatus, type WorkflowStepErrorContext, type WorkflowStepErrorRecord, type WorkflowStepRetryContext, defineWorkflow };