nestjs-serverless-workflow 0.0.1

package/dist/workflow/utils/retry-backoff.d.ts

@@ -0,0 +1,35 @@
+import { type IBackoffRetryConfig } from '../types';
+/**
+ * Calculate delay for retry attempt using exponential backoff with optional jitter
+ */
+export declare class RetryBackoff {
+    /**
+     * Calculate delay based on retry strategy
+     * @param attempt Current attempt number (0-indexed)
+     * @param config Retry configuration
+     * @returns Delay in milliseconds
+     */
+    static calculateDelay(attempt: number, config: IBackoffRetryConfig): number;
+    /**
+     * Fixed delay - always returns the same delay
+     */
+    private static fixedDelay;
+    /**
+     * Exponential backoff without jitter
+     * delay = min(initialDelay * (backoffMultiplier ^ attempt), maxDelay)
+     */
+    private static exponentialBackoff;
+    /**
+     * Exponential backoff with jitter (AWS recommended approach)
+     * Uses "Full Jitter" strategy: delay = random(0, min(maxDelay, baseDelay * 2^attempt))
+     *
+     * Or partial jitter: delay = baseDelay + random(0, jitterAmount)
+     */
+    private static exponentialBackoffWithJitter;
+    /**
+     * Alternative: Decorrelated jitter (more aggressive)
+     * delay = random(initialDelay, previousDelay * 3)
+     */
+    static decorrelatedJitter(previousDelay: number, initialDelay: number, maxDelay: number): number;
+}
+//# sourceMappingURL=retry-backoff.d.ts.map

package/dist/workflow/utils/retry-backoff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry-backoff.d.ts","sourceRoot":"","sources":["../../../src/workflow/utils/retry-backoff.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEnE;;GAEG;AACH,qBAAa,YAAY;IACvB;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,MAAM;IAwB3E;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IAIzB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAUjC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAqB3C;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;CAKjG"}

package/dist/workflow/utils/retry-backoff.js

@@ -0,0 +1,68 @@
+import { RetryStrategy } from '../types';
+/**
+ * Calculate delay for retry attempt using exponential backoff with optional jitter
+ */
+export class RetryBackoff {
+    /**
+     * Calculate delay based on retry strategy
+     * @param attempt Current attempt number (0-indexed)
+     * @param config Retry configuration
+     * @returns Delay in milliseconds
+     */
+    static calculateDelay(attempt, config) {
+        const { strategy = RetryStrategy.EXPONENTIAL_JITTER, initialDelay = 1000, backoffMultiplier = 2, maxDelay = 60000, jitter = true, } = config;
+        switch (strategy) {
+            case RetryStrategy.FIXED:
+                return this.fixedDelay(initialDelay);
+            case RetryStrategy.EXPONENTIAL:
+                return this.exponentialBackoff(attempt, initialDelay, backoffMultiplier, maxDelay);
+            case RetryStrategy.EXPONENTIAL_JITTER:
+                return this.exponentialBackoffWithJitter(attempt, initialDelay, backoffMultiplier, maxDelay, jitter);
+            default:
+                return this.exponentialBackoffWithJitter(attempt, initialDelay, backoffMultiplier, maxDelay, jitter);
+        }
+    }
+    /**
+     * Fixed delay - always returns the same delay
+     */
+    static fixedDelay(delay) {
+        return delay;
+    }
+    /**
+     * Exponential backoff without jitter
+     * delay = min(initialDelay * (backoffMultiplier ^ attempt), maxDelay)
+     */
+    static exponentialBackoff(attempt, initialDelay, backoffMultiplier, maxDelay) {
+        const delay = initialDelay * Math.pow(backoffMultiplier, attempt);
+        return Math.min(delay, maxDelay);
+    }
+    /**
+     * Exponential backoff with jitter (AWS recommended approach)
+     * Uses "Full Jitter" strategy: delay = random(0, min(maxDelay, baseDelay * 2^attempt))
+     *
+     * Or partial jitter: delay = baseDelay + random(0, jitterAmount)
+     */
+    static exponentialBackoffWithJitter(attempt, initialDelay, backoffMultiplier, maxDelay, jitter) {
+        const baseDelay = this.exponentialBackoff(attempt, initialDelay, backoffMultiplier, maxDelay);
+        if (jitter === true) {
+            // Full jitter: random between 0 and baseDelay
+            return Math.random() * baseDelay;
+        }
+        else if (typeof jitter === 'number') {
+            // Partial jitter: baseDelay ± (jitter percentage)
+            const jitterAmount = baseDelay * jitter;
+            return baseDelay - jitterAmount + Math.random() * jitterAmount * 2;
+        }
+        return baseDelay;
+    }
+    /**
+     * Alternative: Decorrelated jitter (more aggressive)
+     * delay = random(initialDelay, previousDelay * 3)
+     */
+    static decorrelatedJitter(previousDelay, initialDelay, maxDelay) {
+        const min = initialDelay;
+        const max = Math.min(previousDelay * 3, maxDelay);
+        return min + Math.random() * (max - min);
+    }
+}
+//# sourceMappingURL=retry-backoff.js.map

package/dist/workflow/utils/retry-backoff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry-backoff.js","sourceRoot":"","sources":["../../../src/workflow/utils/retry-backoff.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAA4B,MAAM,UAAU,CAAC;AAEnE;;GAEG;AACH,MAAM,OAAO,YAAY;IACvB;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,OAAe,EAAE,MAA2B;QAChE,MAAM,EACJ,QAAQ,GAAG,aAAa,CAAC,kBAAkB,EAC3C,YAAY,GAAG,IAAI,EACnB,iBAAiB,GAAG,CAAC,EACrB,QAAQ,GAAG,KAAK,EAChB,MAAM,GAAG,IAAI,GACd,GAAG,MAAM,CAAC;QAEX,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,aAAa,CAAC,KAAK;gBACtB,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAEvC,KAAK,aAAa,CAAC,WAAW;gBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;YAErF,KAAK,aAAa,CAAC,kBAAkB;gBACnC,OAAO,IAAI,CAAC,4BAA4B,CAAC,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;YAEvG;gBACE,OAAO,IAAI,CAAC,4BAA4B,CAAC,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACzG,CAAC;IACH,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,UAAU,CAAC,KAAa;QACrC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,kBAAkB,CAC/B,OAAe,EACf,YAAoB,EACpB,iBAAyB,EACzB,QAAgB;QAEhB,MAAM,KAAK,GAAG,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,4BAA4B,CACzC,OAAe,EACf,YAAoB,EACpB,iBAAyB,EACzB,QAAgB,EAChB,MAAwB;QAExB,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAE9F,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,8CAA8C;YAC9C,OAAO,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACtC,kDAAkD;YAClD,MAAM,YAAY,GAAG,SAAS,GAAG,MAAM,CAAC;YACxC,OAAO,SAAS,GAAG,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,YAAY,GAAG,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,aAAqB,EAAE,YAAoB,EAAE,QAAgB;QACrF,MAAM,GAAG,GAAG,YAAY,CAAC;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;QAClD,OAAO,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;IAC3C,CAAC;CACF"}

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

@@ -0,0 +1,13 @@
+import type { IBrokerPublisher } from '@/event-bus';
+import { type DynamicModule, type Provider } from '@nestjs/common';
+import type { IWorkflowEntity } from './types';
+export declare class WorkflowModule {
+    static register(options: {
+        imports?: any[];
+        entities: Provider<IWorkflowEntity>[];
+        workflows: Provider[];
+        brokers: Provider<IBrokerPublisher>[];
+        providers?: Provider[];
+    }): DynamicModule;
+}
+//# sourceMappingURL=workflow.module.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.module.d.ts","sourceRoot":"","sources":["../../src/workflow/workflow.module.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,EAAE,KAAK,aAAa,EAAU,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE3E,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,OAAO,EAAE,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACtC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;KACxB,GAAG,aAAa;CAYlB"}

package/dist/workflow/workflow.module.js

@@ -0,0 +1,27 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var WorkflowModule_1;
+import { OrchestratorService, StateRouterHelperFactory } from '@/workflow';
+import { Module } from '@nestjs/common';
+import { DiscoveryModule } from '@nestjs/core';
+let WorkflowModule = WorkflowModule_1 = class WorkflowModule {
+    static register(options) {
+        const { imports, entities, workflows, brokers } = options;
+        const providers = [...entities, ...workflows, ...brokers, StateRouterHelperFactory, OrchestratorService];
+        return {
+            module: WorkflowModule_1,
+            imports: [DiscoveryModule, ...(imports ?? [])],
+            providers: providers,
+            exports: providers,
+        };
+    }
+};
+WorkflowModule = WorkflowModule_1 = __decorate([
+    Module({})
+], WorkflowModule);
+export { WorkflowModule };
+//# sourceMappingURL=workflow.module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.module.js","sourceRoot":"","sources":["../../src/workflow/workflow.module.ts"],"names":[],"mappings":";;;;;;;AACA,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,EAAsB,MAAM,EAAiB,MAAM,gBAAgB,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAIxC,IAAM,cAAc,sBAApB,MAAM,cAAc;IACzB,MAAM,CAAC,QAAQ,CAAC,OAMf;QACC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAE1D,MAAM,SAAS,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,SAAS,EAAE,GAAG,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;QAEzG,OAAO;YACL,MAAM,EAAE,gBAAc;YACtB,OAAO,EAAE,CAAC,eAAe,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAC9C,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;CACF,CAAA;AAnBY,cAAc;IAD1B,MAAM,CAAC,EAAE,CAAC;GACE,cAAc,CAmB1B"}

package/package.json

@@ -0,0 +1,154 @@
+{
+  "name": "nestjs-serverless-workflow",
+  "version": "0.0.1",
+  "private": false,
+  "description": "Workflow and State Machines for NestJS",
+  "license": "MIT",
+  "author": "Thomas Do (tung-dnt)",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/workflow/index.js",
+  "types": "./dist/workflow/index.d.ts",
+  "exports": {
+    "./workflow": {
+      "types": "./dist/workflow/index.d.ts",
+      "import": "./dist/workflow/index.js",
+      "default": "./dist/workflow/index.js"
+    },
+    "./event-bus": {
+      "types": "./dist/event-bus/index.d.ts",
+      "import": "./dist/event-bus/index.js",
+      "default": "./dist/event-bus/index.js"
+    },
+    "./exception": {
+      "types": "./dist/exception/index.d.ts",
+      "import": "./dist/exception/index.js",
+      "default": "./dist/exception/index.js"
+    },
+    "./adapter": {
+      "types": "./dist/adapter/index.d.ts",
+      "import": "./dist/adapter/index.js",
+      "default": "./dist/adapter/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "NODE_ENV=production bun run scripts/build.ts",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "NODE_ENV=development tsgo && bun src/main.ts",
+    "start:dev": "NODE_ENV=development bun --watch src/main.ts",
+    "start:debug": "NODE_ENV=development bun --watch --inspect src/main.ts",
+    "start:prod": "NODE_ENV=production bun dist/main.js",
+    "test": "bun test",
+    "test:watch": "bun test --watch",
+    "test:cov": "bun test --coverage",
+    "test:debug": "bun --inspect-brk --runInBand",
+    "test:e2e": "bun test ./tests/app.e2e-spec.ts",
+    "typecheck": "tsgo --noEmit",
+    "prepublishOnly": "bun run build"
+  },
+  "dependencies": {
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.2"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "reflect-metadata": "^0.2.0",
+    "rxjs": "^7.8.0"
+  },
+  "peerDependenciesMeta": {
+    "@aws-sdk/client-sqs": {
+      "optional": true
+    },
+    "@aws-sdk/client-dynamodb": {
+      "optional": true
+    },
+    "@aws-sdk/lib-dynamodb": {
+      "optional": true
+    },
+    "@types/aws-lambda": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@aws-sdk/client-dynamodb": "^3.896.0",
+    "@aws-sdk/client-sqs": "^3.893.0",
+    "@aws-sdk/lib-dynamodb": "^3.896.0",
+    "@nestjs/cli": "^11.0.10",
+    "@nestjs/common": "^11.1.3",
+    "@nestjs/core": "^11.1.3",
+    "@nestjs/event-emitter": "^3.0.1",
+    "@nestjs/platform-express": "^11.0.1",
+    "@nestjs/swagger": "^11.0.2",
+    "@nestjs/testing": "^11.1.3",
+    "@types/aws-lambda": "8.10.152",
+    "@types/bun": "^1.3.4",
+    "@typescript/native-preview": "^7.0.0-dev.20251213.1",
+    "del-cli": "^6.0.0",
+    "dynamodb-toolbox": "^2.7.1",
+    "prettier": "^3.6.2",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.2",
+    "serverless-plugin-include-dependencies": "^6.1.1",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.1.1",
+    "typescript": "^5.8.3",
+    "uuidv7": "^1.0.2"
+  },
+  "typesVersions": {
+    "*": {
+      "workflow": [
+        "./dist/workflow/index.d.ts"
+      ],
+      "event-bus": [
+        "./dist/event-bus/index.d.ts"
+      ],
+      "exception": [
+        "./dist/exception/index.d.ts"
+      ],
+      "adapter": [
+        "./dist/adapter/index.d.ts"
+      ]
+    }
+  },
+  "_moduleAliases": {
+    "@/*": "*"
+  },
+  "engines": {
+    "bun": ">=1.3.4",
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "nestjs",
+    "workflow",
+    "state-machine",
+    "fsm",
+    "finite-state-machine",
+    "typescript",
+    "event-driven",
+    "process-automation",
+    "business-process",
+    "workflow-engine",
+    "state-management",
+    "transition",
+    "nodejs",
+    "serverless",
+    "orchestration",
+    "lambda",
+    "tree-shakable"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/@nestjs-serverless-workflow.git"
+  },
+  "bugs": {
+    "url": "https://github.com/@nestjs-serverless-workflow/issues"
+  },
+  "homepage": "https://github.com/@nestjs-serverless-workflow#readme"
+}