nestjs-serverless-workflow 0.1.0 → 0.1.3

package/dist/core/types/shared.type.d.ts

@@ -1,9 +1,23 @@
+/**
+ * Helper that maps all keys unique to `T` (not in `U`) to `never`.
+ * Used internally by {@link TEither} to enforce mutually exclusive unions.
+ */
 export type TWithout<T, U> = {
     [P in Exclude<keyof T, keyof U>]?: never;
 };
+/**
+ * A true mutually exclusive union of two object types.
+ *
+ * Unlike `T | U`, this prevents accidentally mixing properties from both
+ * types in a single value — only one side is allowed at a time.
+ */
 export type TEither<T, U> = T extends object ? (U extends object ? (TWithout<T, U> & U) | (TWithout<U, T> & T) : U) : T;
 /**
- * Duration for timeout configuration (callback waits, retries, etc.)
+ * A human-readable duration used for timeout configuration throughout the
+ * library (callback waits, idle state timeouts, retry delays, etc.).
+ *
+ * At least one field should be set. Fields are additive when the consuming
+ * code converts them — e.g. `{ minutes: 1, seconds: 30 }` = 90 seconds.
  */
 export interface Duration {
     hours?: number;

package/dist/core/types/shared.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.type.d.ts","sourceRoot":"","sources":["../../../packages/core/types/shared.type.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI;KAAG,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK;CAAE,CAAC;AAG1E,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AAExH;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"shared.type.d.ts","sourceRoot":"","sources":["../../../packages/core/types/shared.type.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI;KAAG,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK;CAAE,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AAExH;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/core/types/transit-result.type.d.ts

@@ -1,5 +1,20 @@
 import type { Duration } from './shared.type.js';
 import type { IWorkflowEvent } from './workflow-event.interface.js';
+/**
+ * Discriminated union returned by {@link OrchestratorService.transit}.
+ *
+ * Each variant tells the caller what happened and what to do next:
+ *
+ * | Status          | Meaning                                            |
+ * |-----------------|----------------------------------------------------|
+ * | `final`         | Entity reached a terminal state — workflow done.   |
+ * | `idle`          | Entity is idle, waiting for an external callback.  |
+ * | `continued`     | Auto-transition found — feed `nextEvent` back in.  |
+ * | `no_transition` | No unambiguous next step — wait for explicit event.|
+ *
+ * Adapters consume this via `BaseWorkflowAdapter` handler methods or a
+ * manual `switch` on `result.status`.
+ */
 export type TransitResult = {
     status: 'final';
     state: string | number;

package/dist/core/types/transit-result.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transit-result.type.d.ts","sourceRoot":"","sources":["../../../packages/core/types/transit-result.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,QAAQ,CAAA;CAAE,GAC9D;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,SAAS,EAAE,cAAc,CAAA;CAAE,GAClD;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAC"}
+{"version":3,"file":"transit-result.type.d.ts","sourceRoot":"","sources":["../../../packages/core/types/transit-result.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEjE;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,aAAa,GACrB;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,QAAQ,CAAA;CAAE,GAC9D;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,SAAS,EAAE,cAAc,CAAA;CAAE,GAClD;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAC"}

package/dist/core/types/workflow-definition.interface.d.ts

@@ -10,17 +10,46 @@ import type { Duration, IBackoffRetryConfig, ITransitionEvent, IWorkflowEntity }
  * - `Entity`: An optional entity service or configuration for loading/updating entities.
  */
 /**
- * An idle state entry — either a bare state value or a state with per-state timeout.
+ * An idle state entry — either a bare state value or a state with a per-state
+ * callback timeout that overrides {@link IWorkflowDefinition.defaultCallbackTimeout}.
  */
 export type IdleStateEntry<State> = State | {
     state: State;
     timeout?: Duration;
 };
+/**
+ * Complete definition of a workflow, passed to the {@link Workflow} class decorator.
+ *
+ * @typeParam T     - Entity type (e.g. `Order`)
+ * @typeParam Event - Union of event names (e.g. `OrderEvent`)
+ * @typeParam State - Union of state values (e.g. `OrderStatus`)
+ *
+ * @example
+ * ```typescript
+ * @Workflow<Order, OrderEvent, OrderStatus>({
+ *   name: 'OrderWorkflow',
+ *   states: {
+ *     finals: [OrderStatus.Completed, OrderStatus.Cancelled],
+ *     idles:  [OrderStatus.Pending],
+ *     failed: OrderStatus.Failed,
+ *   },
+ *   transitions: [
+ *     { from: [OrderStatus.Pending], to: OrderStatus.Processing, event: OrderEvent.Submit },
+ *   ],
+ *   entityService: 'entity.order',
+ * })
+ * ```
+ */
 export interface IWorkflowDefinition<T, Event, State> {
+    /** Human-readable workflow name (used in logs). */
     name: string;
+    /** Categorised states that drive the orchestrator's routing behaviour. */
     states: {
+        /** Terminal states — reaching one ends the workflow. */
         finals: State[];
+        /** Idle states — the workflow pauses and waits for an external callback. */
         idles: IdleStateEntry<State>[];
+        /** The state to transition to when a handler throws an error. */
         failed: State;
     };
     /**
@@ -28,13 +57,21 @@ export interface IWorkflowDefinition<T, Event, State> {
      * Per-state timeouts in `idles` take precedence over this value.
      */
     defaultCallbackTimeout?: Duration;
+    /** Allowed transitions between states, guarded by optional conditions. */
     transitions: ITransitionEvent<T, Event, State, any>[];
+    /** Global conditions evaluated on every transition in this workflow. */
     conditions?: (<P>(entity: T, payload?: P | T | object | string) => boolean)[];
     /**
-     * Injection token refer to entity services that implements IWorkflowEntity<T>
+     * NestJS injection token for the {@link IWorkflowEntity} service that
+     * handles persistence for this workflow's entities.
      */
     entityService: string;
 }
+/**
+ * Internal route entry built by {@link OrchestratorService} during module
+ * initialisation. Maps an event name to everything needed to execute a transition.
+ * @internal
+ */
 export interface IWorkflowDefaultRoute {
     instance: any;
     definition: IWorkflowDefinition<any, string, string>;
@@ -44,10 +81,22 @@ export interface IWorkflowDefaultRoute {
     entityService: IWorkflowEntity;
     retryConfig?: IBackoffRetryConfig;
 }
+/**
+ * Metadata entry created by the {@link OnEvent} decorator.
+ * Stored on the workflow class via `Reflect.defineMetadata`.
+ * @internal
+ */
 export interface IWorkflowHandler {
+    /** The event name this handler responds to. */
     event: string;
+    /** The method name on the workflow class. */
     name: string;
+    /** Reference to the method itself. */
     handler: (...payload: any[]) => Promise<any>;
 }
+/**
+ * Signature for the fallback handler registered with {@link OnDefault}.
+ * Invoked when no transition matches the incoming event.
+ */
 export type TDefaultHandler<T, Event = string> = <P>(entity: T, event: Event, payload?: P | T | object | string) => Promise<T>;
 //# sourceMappingURL=workflow-definition.interface.d.ts.map

package/dist/core/types/workflow-definition.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-definition.interface.d.ts","sourceRoot":"","sources":["../../../packages/core/types/workflow-definition.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAE/F;;;;;;;;;GASG;AACH;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,IAAI,KAAK,GAAG;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,OAAO,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAC;AAEjF,MAAM,WAAW,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,MAAM,EAAE,KAAK,EAAE,CAAC;QAChB,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,EAAE,KAAK,CAAC;KACf,CAAC;IACF;;;OAGG;IACH,sBAAsB,CAAC,EAAE,QAAQ,CAAC;IAClC,WAAW,EAAE,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;IACtD,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,EAAE,CAAC;IAC9E;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,GAAG,CAAC;IACd,UAAU,EAAE,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7C,cAAc,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;IACtC,aAAa,EAAE,eAAe,CAAC;IAC/B,WAAW,CAAC,EAAE,mBAAmB,CAAC;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAC9C;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM,IAAI,CAAC,CAAC,EACjD,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,MAAM,KAC9B,OAAO,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"workflow-definition.interface.d.ts","sourceRoot":"","sources":["../../../packages/core/types/workflow-definition.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAE/F;;;;;;;;;GASG;AACH;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,IAAI,KAAK,GAAG;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,OAAO,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAC;AAEjF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK;IAClD,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,0EAA0E;IAC1E,MAAM,EAAE;QACN,0DAAwD;QACxD,MAAM,EAAE,KAAK,EAAE,CAAC;QAChB,8EAA4E;QAC5E,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,iEAAiE;QACjE,MAAM,EAAE,KAAK,CAAC;KACf,CAAC;IACF;;;OAGG;IACH,sBAAsB,CAAC,EAAE,QAAQ,CAAC;IAClC,0EAA0E;IAC1E,WAAW,EAAE,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;IACtD,wEAAwE;IACxE,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,MAAM,KAAK,OAAO,CAAC,EAAE,CAAC;IAC9E;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,GAAG,CAAC;IACd,UAAU,EAAE,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7C,cAAc,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC;IACtC,aAAa,EAAE,eAAe,CAAC;IAC/B,WAAW,CAAC,EAAE,mBAAmB,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM,IAAI,CAAC,CAAC,EACjD,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,KAAK,EACZ,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,MAAM,KAC9B,OAAO,CAAC,CAAC,CAAC,CAAC"}

package/dist/core/types/workflow-event.interface.d.ts

@@ -1,7 +1,27 @@
+/**
+ * The event object passed into {@link OrchestratorService.transit} to trigger
+ * a state transition.
+ *
+ * @typeParam T - Type of the optional payload data.
+ *
+ * @example
+ * ```typescript
+ * const event: IWorkflowEvent = {
+ *   event: 'order.submit',
+ *   urn: 'order-123',
+ *   payload: { items: [{ sku: 'ABC', qty: 2 }] },
+ *   attempt: 0,
+ * };
+ * ```
+ */
 export interface IWorkflowEvent<T = any> {
+    /** Event name that matches a transition's `event` field. */
     event: string;
+    /** Unique resource name identifying the entity instance. */
     urn: string | number;
+    /** Optional data forwarded to the handler and transition conditions. */
     payload?: T | object | string;
+    /** Zero-based retry attempt counter, managed by the adapter. */
     attempt: number;
 }
 //# sourceMappingURL=workflow-event.interface.d.ts.map

package/dist/core/types/workflow-event.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-event.interface.d.ts","sourceRoot":"","sources":["../../../packages/core/types/workflow-event.interface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,GAAG;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"workflow-event.interface.d.ts","sourceRoot":"","sources":["../../../packages/core/types/workflow-event.interface.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,GAAG;IACrC,4DAA4D;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB,wEAAwE;IACxE,OAAO,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC;IAC9B,gEAAgE;IAChE,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/core/workflow.module.d.ts

@@ -1,6 +1,34 @@
 import { type DynamicModule, type Provider } from '@nestjs/common';
 import type { IWorkflowEntity } from './types/index.js';
+/**
+ * Dynamic NestJS module that bootstraps the workflow engine.
+ *
+ * Call {@link WorkflowModule.register} to supply entity services, workflow
+ * classes, and any extra providers. The module sets up {@link OrchestratorService}
+ * and the {@link StateRouterHelperFactory} automatically.
+ *
+ * @example
+ * ```typescript
+ * @Module({
+ *   imports: [
+ *     WorkflowModule.register({
+ *       entities: [{ provide: 'entity.order', useClass: OrderEntityService }],
+ *       workflows: [OrderWorkflow],
+ *     }),
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ */
 export declare class WorkflowModule {
+    /**
+     * Register workflows with the module.
+     *
+     * @param options.imports   - Additional NestJS modules to import
+     * @param options.entities  - Providers for {@link IWorkflowEntity} implementations (keyed by injection token)
+     * @param options.workflows - Workflow classes decorated with {@link Workflow}
+     * @param options.providers - Extra providers to include in the module
+     */
     static register(options: {
         imports?: any[];
         entities: Provider<IWorkflowEntity>[];

package/dist/core/workflow.module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow.module.d.ts","sourceRoot":"","sources":["../../packages/core/workflow.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAU,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAI3E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,qBACa,cAAc;IACzB,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE;QACvB,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;QAChB,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;QACtC,SAAS,EAAE,QAAQ,EAAE,CAAC;QACtB,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;KACxB,GAAG,aAAa,CAiBhB;CACF"}
+{"version":3,"file":"workflow.module.d.ts","sourceRoot":"","sources":["../../packages/core/workflow.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAU,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAI3E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBACa,cAAc;IACzB;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE;QACvB,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;QAChB,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;QACtC,SAAS,EAAE,QAAQ,EAAE,CAAC;QACtB,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;KACxB,GAAG,aAAa,CAiBhB;CACF"}

package/dist/core/workflow.module.js

@@ -7,7 +7,35 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { Module } from '@nestjs/common';
 import { DiscoveryModule } from '@nestjs/core';
 import { OrchestratorService, StateRouterHelperFactory } from '../core/index.js';
+/**
+ * Dynamic NestJS module that bootstraps the workflow engine.
+ *
+ * Call {@link WorkflowModule.register} to supply entity services, workflow
+ * classes, and any extra providers. The module sets up {@link OrchestratorService}
+ * and the {@link StateRouterHelperFactory} automatically.
+ *
+ * @example
+ * ```typescript
+ * @Module({
+ *   imports: [
+ *     WorkflowModule.register({
+ *       entities: [{ provide: 'entity.order', useClass: OrderEntityService }],
+ *       workflows: [OrderWorkflow],
+ *     }),
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ */
 let WorkflowModule = class WorkflowModule {
+    /**
+     * Register workflows with the module.
+     *
+     * @param options.imports   - Additional NestJS modules to import
+     * @param options.entities  - Providers for {@link IWorkflowEntity} implementations (keyed by injection token)
+     * @param options.workflows - Workflow classes decorated with {@link Workflow}
+     * @param options.providers - Extra providers to include in the module
+     */
     static register(options) {
         const { imports, entities, workflows, providers: extraProviders } = options;
         const providers = [

package/dist/core/workflow.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflow.module.js","sourceRoot":"","sources":["../../packages/core/workflow.module.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAsB,MAAM,EAAiB,MAAM,gBAAgB,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAKvE,IAAa,cAAc,GAA3B,MAAa,cAAc;IACzB,MAAM,CAAC,QAAQ,CAAC,OAKf,EAAiB;QAChB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAE5E,MAAM,SAAS,GAAG;YAChB,GAAG,QAAQ;YACX,GAAG,SAAS;YACZ,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC;YACzB,wBAAwB;YACxB,mBAAmB;SACpB,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,cAAc;YACtB,OAAO,EAAE,CAAC,eAAe,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAC9C,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,SAAS;SACnB,CAAC;IAAA,CACH;CACF,CAAA;AAxBY,cAAc;IAD1B,MAAM,CAAC,EAAE,CAAC;GACE,cAAc,CAwB1B"}
+{"version":3,"file":"workflow.module.js","sourceRoot":"","sources":["../../packages/core/workflow.module.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAsB,MAAM,EAAiB,MAAM,gBAAgB,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAIvE;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,IAAa,cAAc,GAA3B,MAAa,cAAc;IACzB;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,OAKf,EAAiB;QAChB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAE5E,MAAM,SAAS,GAAG;YAChB,GAAG,QAAQ;YACX,GAAG,SAAS;YACZ,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC;YACzB,wBAAwB;YACxB,mBAAmB;SACpB,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,cAAc;YACtB,OAAO,EAAE,CAAC,eAAe,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAC9C,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,SAAS;SACnB,CAAC;IAAA,CACH;CACF,CAAA;AAhCY,cAAc;IAD1B,MAAM,CAAC,EAAE,CAAC;GACE,cAAc,CAgC1B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-serverless-workflow",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "private": false,
   "description": "Workflow and State Machines for NestJS",
   "license": "MIT",