@lafken/state-machine 0.14.0 → 0.14.2

package/README.md

@@ -88,6 +88,22 @@ You can also start with a declarative state instead of a Lambda task:
 export class DelayedWorkflow {}
 ```
 
+Declarative states receive a generated name based on their type (e.g. `pass`, `wait`, `wait-2`).
+You can provide a custom name with the `name` option, which is used as the state name in the
+Step Functions definition while keeping names unique within the state machine:
+
+```typescript
+@StateMachine({
+  startAt: {
+    type: 'wait',
+    name: 'initial-delay',
+    seconds: 5,
+    next: { type: 'succeed', name: 'done' },
+  },
+})
+export class DelayedWorkflow {}
+```
+
 ### Lambda Tasks
 
 The `@State` decorator turns a method into a Lambda-backed task within the state machine. Step Functions will invoke the Lambda automatically during execution.
@@ -148,9 +164,9 @@ import {
   StateMachine,
   State,
   Event,
+  IntegrationOptions,
   type IntegrationOptionsParams,
 } from '@lafken/state-machine/main';
-import { IntegrationOptions } from '@lafken/api/main';
 
 @StateMachine({
   startAt: 'saveItem',

package/lib/main/state-machine/state-machine.types.d.ts

@@ -12,6 +12,23 @@ export type ResultOutputType = 'JSON' | 'JSONL';
 export type ResultTransformation = 'NONE' | 'COMPACT' | 'FLATTEN';
 export type IntegrationMode = 'sync' | 'async' | 'token';
 type ObjectOrJsonAta = Record<string, any> | JsonAtaString;
+export interface StateName {
+    /**
+     * Custom state name.
+     *
+     * Specifies a custom name for the state in the state machine definition.
+     * If not provided, a name is generated automatically based on the state
+     * type (e.g. `pass`, `pass-2`, `wait`). Names are kept unique within the
+     * state machine, appending a numeric suffix when duplicated.
+     *
+     * @example
+     * {
+     *   type: 'pass',
+     *   name: 'my-pass-state',
+     * }
+     */
+    name?: string;
+}
 /**
  * Attributes that can be exported from a Step Functions state machine resource.
  *
@@ -189,7 +206,7 @@ interface StateMachineProps<T> extends StateMachineBaseProps<T> {
      */
     ref?: StateMachineReferenceNames;
 }
-interface WaitStateBase<T> {
+interface WaitStateBase<T> extends StateName {
     /**
      * State type: Wait.
      *
@@ -303,7 +320,7 @@ interface ChoiceCondition<T> {
      */
     next: StateTypes<T>;
 }
-export interface ChoiceState<T> {
+export interface ChoiceState<T> extends StateName {
     /**
      * State type: Choice.
      *
@@ -348,7 +365,7 @@ export interface ChoiceState<T> {
      */
     default?: StateTypes<T>;
 }
-interface ParallelState<T> extends CatchAndRetry<T> {
+interface ParallelState<T> extends CatchAndRetry<T>, StateName {
     /**
      * State type: Parallel.
      *
@@ -438,7 +455,7 @@ interface ParallelState<T> extends CatchAndRetry<T> {
      */
     next?: StateTypes<T>;
 }
-interface FailState {
+interface FailState extends StateName {
     type: 'fail';
     /**
      * Description about error cause, you can use an jsonata expression
@@ -468,7 +485,7 @@ interface FailState {
      */
     error?: string;
 }
-interface SucceedState {
+interface SucceedState extends StateName {
     type: 'succeed';
     /**
      * State output transformation.
@@ -492,7 +509,7 @@ interface SucceedState {
      */
     output?: ObjectOrJsonAta;
 }
-interface PassState<T> {
+interface PassState<T> extends StateName {
     type: 'pass';
     /**
      * Next state to execute.
@@ -552,7 +569,7 @@ interface PassState<T> {
      */
     assign?: Record<string, any>;
 }
-export interface MapStateBase<T> extends CatchAndRetry<T> {
+export interface MapStateBase<T> extends CatchAndRetry<T>, StateName {
     /**
      * State type: Map.
      *

package/lib/resolver/state-machine/schema/schema.js

@@ -258,7 +258,7 @@ class Schema {
         if (typeof currentState === 'string') {
             return '';
         }
-        return this.stateNames.createName(currentState.type);
+        return this.stateNames.createName(currentState.name ?? currentState.type);
     }
     getIntegrationTask(handler) {
         const task = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lafken/state-machine",
-  "version": "0.14.0",
+  "version": "0.14.2",
   "private": false,
   "description": "Build Step Functions workflows with TypeScript decorators - declarative orchestration with Lafken",
   "keywords": [
@@ -50,7 +50,7 @@
   ],
   "dependencies": {
     "reflect-metadata": "^0.2.2",
-    "@lafken/resolver": "0.14.0"
+    "@lafken/resolver": "0.14.2"
   },
   "devDependencies": {
     "@cdktn/provider-aws": "^25.0.0",
@@ -63,13 +63,13 @@
     "typescript": "7.0.2",
     "unplugin-swc": "^1.5.10",
     "vitest": "^4.1.10",
-    "@lafken/common": "0.14.0"
+    "@lafken/common": "0.14.2"
   },
   "peerDependencies": {
     "@cdktn/provider-aws": ">=23.0.0",
     "cdktn": ">=0.22.0",
     "constructs": ">=10.7.0",
-    "@lafken/common": "0.14.0"
+    "@lafken/common": "0.14.2"
   },
   "engines": {
     "node": ">=20.19"