@nestjs/workflows 0.0.1

package/dist/workflows.module.d.ts

@@ -0,0 +1,24 @@
+import { type DynamicModule, type OnModuleInit } from '@nestjs/common';
+import { WorkflowStorage } from './storage/workflow.storage.js';
+import { ConfigurableModuleClass } from './workflows.module-definition.js';
+import type { WorkflowsModuleOptions } from './interfaces/workflows-module-options.interface.js';
+/**
+ * `WorkflowsModule.forRoot({ clock?, worker?, retry?, journal?, allowInMemoryStorage?, codec? })`, or
+ * `forRootAsync({ imports, inject, useFactory | useClass | useExisting })`. Global by default.
+ * `@Workflow()` classes are regular providers of any module. The store is not an option: a
+ * provider registers it with `WorkflowStorage.registerSource(this)`, and without one the
+ * module keeps its state in memory.
+ */
+export declare class WorkflowsModule extends ConfigurableModuleClass implements OnModuleInit {
+    private readonly storage;
+    static forRoot(options?: WorkflowsModuleOptions & {
+        isGlobal?: boolean;
+    }): DynamicModule;
+    constructor(storage: WorkflowStorage);
+    /**
+     * Every provider constructor has run (so every source has registered), and the worker
+     * starts later, in `onApplicationBootstrap`: the registry locks here (if a read in another
+     * module's `onModuleInit` hasn't locked it already).
+     */
+    onModuleInit(): void;
+}

package/dist/workflows.module.js

@@ -0,0 +1,68 @@
+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 __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Module } from '@nestjs/common';
+import { DiscoveryModule, ModuleRef } from '@nestjs/core';
+import { WorkflowEvents } from './events/workflow-events.service.js';
+import { LOCK_STORAGE, WorkflowStorage } from './storage/workflow.storage.js';
+import { WorkflowClient } from './services/workflow-client.service.js';
+import { WorkflowRegistry } from './services/workflow-registry.service.js';
+import { WorkflowScheduler } from './services/workflow-scheduler.service.js';
+import { WorkflowSchedules } from './services/workflow-schedules.service.js';
+import { WorkflowWorker } from './services/workflow-worker.service.js';
+import { ConfigurableModuleClass, WORKFLOWS_MODULE_OPTIONS } from './workflows.module-definition.js';
+import { WORKFLOW_PAYLOAD_CODECS } from './workflows.constants.js';
+/**
+ * `WorkflowsModule.forRoot({ clock?, worker?, retry?, journal?, allowInMemoryStorage?, codec? })`, or
+ * `forRootAsync({ imports, inject, useFactory | useClass | useExisting })`. Global by default.
+ * `@Workflow()` classes are regular providers of any module. The store is not an option: a
+ * provider registers it with `WorkflowStorage.registerSource(this)`, and without one the
+ * module keeps its state in memory.
+ */
+let WorkflowsModule = class WorkflowsModule extends ConfigurableModuleClass {
+    static forRoot(options = {}) {
+        return super.forRoot(options);
+    }
+    constructor(storage) {
+        super();
+        this.storage = storage;
+    }
+    /**
+     * Every provider constructor has run (so every source has registered), and the worker
+     * starts later, in `onApplicationBootstrap`: the registry locks here (if a read in another
+     * module's `onModuleInit` hasn't locked it already).
+     */
+    onModuleInit() {
+        this.storage[LOCK_STORAGE]();
+    }
+};
+WorkflowsModule = __decorate([
+    Module({
+        imports: [DiscoveryModule],
+        providers: [
+            { provide: WORKFLOW_PAYLOAD_CODECS, inject: [WORKFLOWS_MODULE_OPTIONS, ModuleRef], useFactory: payloadCodecs },
+            WorkflowStorage,
+            WorkflowRegistry,
+            WorkflowEvents,
+            WorkflowScheduler,
+            WorkflowWorker,
+            WorkflowSchedules,
+            WorkflowClient,
+        ],
+        // WorkflowRegistry is not public API (nor in the barrel): WorkflowsCqrsModule reads it.
+        exports: [WorkflowStorage, WorkflowClient, WorkflowSchedules, WorkflowWorker, WorkflowEvents, WorkflowRegistry],
+    }),
+    __metadata("design:paramtypes", [WorkflowStorage])
+], WorkflowsModule);
+export { WorkflowsModule };
+/** `codec`'s codecs, with the classes created by Nest (their dependencies from this module's scope). */
+function payloadCodecs(options, moduleRef) {
+    const codecs = options.codec === undefined ? [] : Array.isArray(options.codec) ? options.codec : [options.codec];
+    return Promise.all(codecs.map((codec) => (typeof codec === 'function' ? moduleRef.create(codec) : codec)));
+}

package/package.json

@@ -0,0 +1,123 @@
+{
+  "name": "@nestjs/workflows",
+  "version": "0.0.1",
+  "description": "Nest - modern, fast, powerful node.js web framework (@workflows)",
+  "author": "Kamil Mysliwiec",
+  "license": "MIT",
+  "url": "https://github.com/nestjs/workflows#readme",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "nest-workflows": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "import": "./dist/testing/index.js",
+      "default": "./dist/testing/index.js"
+    },
+    "./cqrs": {
+      "types": "./dist/cqrs/index.d.ts",
+      "import": "./dist/cqrs/index.js",
+      "default": "./dist/cqrs/index.js"
+    },
+    "./postgres": {
+      "types": "./dist/postgres/index.d.ts",
+      "import": "./dist/postgres/index.js",
+      "default": "./dist/postgres/index.js"
+    },
+    "./mysql": {
+      "types": "./dist/mysql/index.d.ts",
+      "import": "./dist/mysql/index.js",
+      "default": "./dist/mysql/index.js"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core/index.js",
+      "default": "./dist/core/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "format": "prettier --write \"**/*.ts\"",
+    "lint": "oxlint lib/",
+    "generate:prisma": "prisma generate --config tests/fixtures/prisma/prisma.config.ts && prisma generate --config tests/fixtures/prisma-mysql/prisma.config.ts",
+    "prepublish:npm": "npm run build",
+    "publish:npm": "npm publish --access public",
+    "prepublish:next": "npm run build",
+    "publish:next": "npm publish --access public --tag next",
+    "test:e2e": "vitest run",
+    "test:e2e:dev": "vitest",
+    "prerelease": "npm run build",
+    "release": "release-it",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "@nestjs/store-kit": "^0.1.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "21.2.3",
+    "@commitlint/config-angular": "21.2.3",
+    "@electric-sql/pglite": "0.5.8",
+    "@nestjs/common": "12.1.0",
+    "@nestjs/core": "12.1.0",
+    "@nestjs/cqrs": "12.1.0",
+    "@nestjs/drizzle": "0.0.1",
+    "@nestjs/locks": "0.0.1",
+    "@nestjs/mail": "0.0.1",
+    "@nestjs/outbox": "0.0.1",
+    "@nestjs/platform-express": "12.1.0",
+    "@nestjs/platform-fastify": "12.1.0",
+    "@nestjs/testing": "12.1.0",
+    "@prisma/adapter-mariadb": "7.10.0",
+    "@prisma/adapter-pg": "7.10.0",
+    "@prisma/client": "7.10.0",
+    "@types/node": "24.13.6",
+    "@types/pg": "8.23.1",
+    "drizzle-orm": "0.45.3",
+    "husky": "9.1.7",
+    "kysely": "0.29.6",
+    "lint-staged": "17.5.1",
+    "mysql2": "3.24.5",
+    "oxlint": "1.85.0",
+    "pg": "8.23.0",
+    "prettier": "3.9.8",
+    "prisma": "7.10.0",
+    "reflect-metadata": "0.2.2",
+    "release-it": "21.1.0",
+    "rxjs": "7.8.2",
+    "typeorm": "1.1.1",
+    "typescript": "7.0.2",
+    "vite": "8.3.0",
+    "vitest": "5.0.1"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0 || ^12.0.0",
+    "@nestjs/core": "^11.0.0 || ^12.0.0",
+    "@nestjs/cqrs": "^11.0.0 || ^12.0.0",
+    "reflect-metadata": "^0.1.13 || ^0.2.0",
+    "rxjs": "^7.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/cqrs": {
+      "optional": true
+    }
+  },
+  "lint-staged": {
+    "**/*.{ts,json}": []
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nestjs/workflows"
+  }
+}