@acmekit/workflow-engine-redis 2.13.1

package/dist/models/workflow-execution.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowExecution = void 0;
+const orchestration_1 = require("@acmekit/framework/orchestration");
+const utils_1 = require("@acmekit/framework/utils");
+exports.WorkflowExecution = utils_1.model
+    .define("workflow_execution", {
+    id: utils_1.model.id({ prefix: "wf_exec" }),
+    workflow_id: utils_1.model.text().primaryKey(),
+    transaction_id: utils_1.model.text().primaryKey(),
+    run_id: utils_1.model.text().primaryKey(),
+    execution: utils_1.model.json().nullable(),
+    context: utils_1.model.json().nullable(),
+    state: utils_1.model.enum(orchestration_1.TransactionState),
+    retention_time: utils_1.model.number().nullable(),
+})
+    .indexes([
+    {
+        on: ["id"],
+        where: "deleted_at IS NULL",
+    },
+    {
+        on: ["workflow_id"],
+        where: "deleted_at IS NULL",
+    },
+    {
+        on: ["transaction_id"],
+        where: "deleted_at IS NULL",
+    },
+    {
+        on: ["workflow_id", "transaction_id", "run_id"],
+        unique: true,
+        where: "deleted_at IS NULL",
+    },
+    {
+        on: ["state"],
+        where: "deleted_at IS NULL",
+    },
+    {
+        on: ["run_id"],
+        where: "deleted_at IS NULL",
+    },
+    {
+        on: ["workflow_id", "transaction_id"],
+        where: "deleted_at IS NULL",
+    },
+    {
+        on: ["state", "updated_at"],
+        where: "deleted_at IS NULL",
+    },
+    {
+        on: ["retention_time", "updated_at", "state"],
+        where: "deleted_at IS NULL AND retention_time IS NOT NULL",
+    },
+    {
+        on: ["updated_at", "retention_time"],
+        where: "deleted_at IS NULL AND retention_time IS NOT NULL AND state IN ('done', 'failed', 'reverted')",
+    },
+]);
+//# sourceMappingURL=workflow-execution.js.map

package/dist/models/workflow-execution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-execution.js","sourceRoot":"","sources":["../../src/models/workflow-execution.ts"],"names":[],"mappings":";;;AAAA,oEAAmE;AACnE,oDAAgD;AAEnC,QAAA,iBAAiB,GAAG,aAAK;KACnC,MAAM,CAAC,oBAAoB,EAAE;IAC5B,EAAE,EAAE,aAAK,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACnC,WAAW,EAAE,aAAK,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE;IACtC,cAAc,EAAE,aAAK,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE;IACzC,MAAM,EAAE,aAAK,CAAC,IAAI,EAAE,CAAC,UAAU,EAAE;IACjC,SAAS,EAAE,aAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,OAAO,EAAE,aAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,aAAK,CAAC,IAAI,CAAC,gCAAgB,CAAC;IACnC,cAAc,EAAE,aAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC1C,CAAC;KACD,OAAO,CAAC;IACP;QACE,EAAE,EAAE,CAAC,IAAI,CAAC;QACV,KAAK,EAAE,oBAAoB;KAC5B;IACD;QACE,EAAE,EAAE,CAAC,aAAa,CAAC;QACnB,KAAK,EAAE,oBAAoB;KAC5B;IACD;QACE,EAAE,EAAE,CAAC,gBAAgB,CAAC;QACtB,KAAK,EAAE,oBAAoB;KAC5B;IACD;QACE,EAAE,EAAE,CAAC,aAAa,EAAE,gBAAgB,EAAE,QAAQ,CAAC;QAC/C,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,oBAAoB;KAC5B;IACD;QACE,EAAE,EAAE,CAAC,OAAO,CAAC;QACb,KAAK,EAAE,oBAAoB;KAC5B;IACD;QACE,EAAE,EAAE,CAAC,QAAQ,CAAC;QACd,KAAK,EAAE,oBAAoB;KAC5B;IACD;QACE,EAAE,EAAE,CAAC,aAAa,EAAE,gBAAgB,CAAC;QACrC,KAAK,EAAE,oBAAoB;KAC5B;IACD;QACE,EAAE,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC;QAC3B,KAAK,EAAE,oBAAoB;KAC5B;IACD;QACE,EAAE,EAAE,CAAC,gBAAgB,EAAE,YAAY,EAAE,OAAO,CAAC;QAC7C,KAAK,EAAE,mDAAmD;KAC3D;IACD;QACE,EAAE,EAAE,CAAC,YAAY,EAAE,gBAAgB,CAAC;QACpC,KAAK,EACH,+FAA+F;KAClG;CACF,CAAC,CAAA"}

package/dist/schema/index.d.ts

@@ -0,0 +1,3 @@
+declare const _default: "\nenum TransactionState {\n  NOT_STARTED\n  INVOKING\n  WAITING_TO_COMPENSATE\n  COMPENSATING\n  DONE\n  REVERTED\n  FAILED\n}\n\ntype WorkflowExecution {\n  id: ID!\n  created_at: DateTime!\n  updated_at: DateTime!\n  deleted_at: DateTime\n  workflow_id: string\n  transaction_id: string\n  execution: JSON\n  context: JSON\n  state: TransactionState\n}\n";
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/schema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schema/index.ts"],"names":[],"mappings":";AAAA,wBAsBC"}

package/dist/schema/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = `
+enum TransactionState {
+  NOT_STARTED
+  INVOKING
+  WAITING_TO_COMPENSATE
+  COMPENSATING
+  DONE
+  REVERTED
+  FAILED
+}
+
+type WorkflowExecution {
+  id: ID!
+  created_at: DateTime!
+  updated_at: DateTime!
+  deleted_at: DateTime
+  workflow_id: string
+  transaction_id: string
+  execution: JSON
+  context: JSON
+  state: TransactionState
+}
+`;
+//# sourceMappingURL=index.js.map

package/dist/schema/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schema/index.ts"],"names":[],"mappings":";;AAAA,kBAAe;;;;;;;;;;;;;;;;;;;;;;CAsBd,CAAA"}

package/dist/services/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./workflow-orchestrator";
+export * from "./workflows-module";
+//# sourceMappingURL=index.d.ts.map

package/dist/services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA"}

package/dist/services/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./workflow-orchestrator"), exports);
+__exportStar(require("./workflows-module"), exports);
+//# sourceMappingURL=index.js.map

package/dist/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAuC;AACvC,qDAAkC"}

package/dist/services/workflow-orchestrator.d.ts

@@ -0,0 +1,101 @@
+import { DistributedTransactionEvents, DistributedTransactionType, TransactionStep } from "@acmekit/framework/orchestration";
+import { ContainerLike, Context, AcmeKitContainer } from "@acmekit/framework/types";
+import { TransactionState } from "@acmekit/framework/utils";
+import { FlowCancelOptions, FlowRunOptions, ReturnWorkflow } from "@acmekit/framework/workflows-sdk";
+import Redis from "ioredis";
+import type { RedisDistributedTransactionStorage } from "../utils";
+export type WorkflowOrchestratorRunOptions<T> = Omit<FlowRunOptions<T>, "container"> & {
+    transactionId?: string;
+    runId?: string;
+    container?: ContainerLike;
+};
+export type WorkflowOrchestratorCancelOptions = Omit<FlowCancelOptions, "transaction" | "transactionId" | "container"> & {
+    transactionId: string;
+    runId?: string;
+    container?: ContainerLike;
+};
+type RegisterStepSuccessOptions<T> = Omit<WorkflowOrchestratorRunOptions<T>, "transactionId" | "input">;
+type RegisterStepFailureOptions<T> = Omit<WorkflowOrchestratorRunOptions<T>, "transactionId" | "input"> & {
+    forcePermanentFailure?: boolean;
+};
+type RetryStepOptions<T> = Omit<WorkflowOrchestratorRunOptions<T>, "transactionId" | "input" | "resultFrom">;
+type IdempotencyKeyParts = {
+    workflowId: string;
+    transactionId: string;
+    stepId: string;
+    action: "invoke" | "compensate";
+};
+type NotifyOptions = {
+    eventType: keyof DistributedTransactionEvents;
+    isFlowAsync: boolean;
+    workflowId: string;
+    transactionId?: string;
+    step?: TransactionStep;
+    response?: unknown;
+    result?: unknown;
+    errors?: unknown[];
+    state?: TransactionState;
+};
+type SubscriberHandler = {
+    (input: NotifyOptions): void;
+} & {
+    _id?: string;
+};
+type SubscribeOptions = {
+    workflowId: string;
+    transactionId?: string;
+    subscriber: SubscriberHandler;
+    subscriberId?: string;
+};
+type UnsubscribeOptions = {
+    workflowId: string;
+    transactionId?: string;
+    subscriberOrId: string | SubscriberHandler;
+};
+export declare class WorkflowOrchestratorService {
+    #private;
+    private instanceId;
+    protected redisPublisher: Redis;
+    protected redisSubscriber: Redis;
+    protected container_: AcmeKitContainer;
+    private static subscribers;
+    protected redisDistributedTransactionStorage_: RedisDistributedTransactionStorage;
+    constructor({ dataLoaderOnly, redisDistributedTransactionStorage, redisPublisher, redisSubscriber, sharedContainer, }: {
+        dataLoaderOnly: boolean;
+        redisDistributedTransactionStorage: RedisDistributedTransactionStorage;
+        workflowOrchestratorService: WorkflowOrchestratorService;
+        redisPublisher: Redis;
+        redisSubscriber: Redis;
+        sharedContainer: AcmeKitContainer;
+    });
+    onApplicationShutdown(): Promise<void>;
+    onApplicationPrepareShutdown(): Promise<void>;
+    onApplicationStart(): Promise<void>;
+    private triggerParentStep;
+    run<T = unknown>(workflowIdOrWorkflow: string | ReturnWorkflow<any, any, any>, options?: WorkflowOrchestratorRunOptions<T>): Promise<any>;
+    cancel(workflowIdOrWorkflow: string | ReturnWorkflow<any, any, any>, options?: WorkflowOrchestratorCancelOptions): Promise<any>;
+    getRunningTransaction(workflowId: string, transactionId: string, context?: Context): Promise<DistributedTransactionType>;
+    retryStep<T = unknown>({ idempotencyKey, options, }: {
+        idempotencyKey: string | IdempotencyKeyParts;
+        options?: RetryStepOptions<T>;
+    }): Promise<any>;
+    setStepSuccess<T = unknown>({ idempotencyKey, stepResponse, options, }: {
+        idempotencyKey: string | IdempotencyKeyParts;
+        stepResponse: unknown;
+        options?: RegisterStepSuccessOptions<T>;
+    }): Promise<any>;
+    setStepFailure<T = unknown>({ idempotencyKey, stepResponse, options, }: {
+        idempotencyKey: string | IdempotencyKeyParts;
+        stepResponse: unknown;
+        options?: RegisterStepFailureOptions<T>;
+    }): Promise<any>;
+    subscribe({ workflowId, transactionId, subscriber, subscriberId, }: SubscribeOptions): void;
+    unsubscribe({ workflowId, transactionId, subscriberOrId, }: UnsubscribeOptions): void;
+    private notify;
+    private processSubscriberNotifications;
+    private getChannelName;
+    private buildWorkflowEvents;
+    private buildIdempotencyKeyAndParts;
+}
+export {};
+//# sourceMappingURL=workflow-orchestrator.d.ts.map

package/dist/services/workflow-orchestrator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-orchestrator.d.ts","sourceRoot":"","sources":["../../src/services/workflow-orchestrator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,4BAA4B,EAC5B,0BAA0B,EAE1B,eAAe,EAEhB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,aAAa,EACb,OAAO,EAEP,gBAAgB,EACjB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAIL,gBAAgB,EACjB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,iBAAiB,EACjB,cAAc,EAGd,cAAc,EACf,MAAM,kCAAkC,CAAA;AACzC,OAAO,KAAK,MAAM,SAAS,CAAA;AAE3B,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,UAAU,CAAA;AAElE,MAAM,MAAM,8BAA8B,CAAC,CAAC,IAAI,IAAI,CAClD,cAAc,CAAC,CAAC,CAAC,EACjB,WAAW,CACZ,GAAG;IACF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,aAAa,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,iCAAiC,GAAG,IAAI,CAClD,iBAAiB,EACjB,aAAa,GAAG,eAAe,GAAG,WAAW,CAC9C,GAAG;IACF,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,aAAa,CAAA;CAC1B,CAAA;AAED,KAAK,0BAA0B,CAAC,CAAC,IAAI,IAAI,CACvC,8BAA8B,CAAC,CAAC,CAAC,EACjC,eAAe,GAAG,OAAO,CAC1B,CAAA;AAED,KAAK,0BAA0B,CAAC,CAAC,IAAI,IAAI,CACvC,8BAA8B,CAAC,CAAC,CAAC,EACjC,eAAe,GAAG,OAAO,CAC1B,GAAG;IACF,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAED,KAAK,gBAAgB,CAAC,CAAC,IAAI,IAAI,CAC7B,8BAA8B,CAAC,CAAC,CAAC,EACjC,eAAe,GAAG,OAAO,GAAG,YAAY,CACzC,CAAA;AAED,KAAK,mBAAmB,GAAG;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAA;CAChC,CAAA;AAED,KAAK,aAAa,GAAG;IACnB,SAAS,EAAE,MAAM,4BAA4B,CAAA;IAC7C,WAAW,EAAE,OAAO,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAA;IAClB,KAAK,CAAC,EAAE,gBAAgB,CAAA;CACzB,CAAA;AAKD,KAAK,iBAAiB,GAAG;IACvB,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAA;CAC7B,GAAG;IACF,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED,KAAK,gBAAgB,GAAG;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,iBAAiB,CAAA;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,KAAK,kBAAkB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,cAAc,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAC3C,CAAA;AAOD,qBAAa,2BAA2B;;IACtC,OAAO,CAAC,UAAU,CAAS;IAC3B,SAAS,CAAC,cAAc,EAAE,KAAK,CAAA;IAC/B,SAAS,CAAC,eAAe,EAAE,KAAK,CAAA;IAChC,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAA;IACtC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAyB;IAInD,SAAS,CAAC,mCAAmC,EAAE,kCAAkC,CAAA;gBAErE,EACV,cAAc,EACd,kCAAkC,EAClC,cAAc,EACd,eAAe,EACf,eAAe,GAChB,EAAE;QACD,cAAc,EAAE,OAAO,CAAA;QACvB,kCAAkC,EAAE,kCAAkC,CAAA;QACtE,2BAA2B,EAAE,2BAA2B,CAAA;QACxD,cAAc,EAAE,KAAK,CAAA;QACrB,eAAe,EAAE,KAAK,CAAA;QACtB,eAAe,EAAE,gBAAgB,CAAA;KAClC;IA+BK,qBAAqB;IAIrB,4BAA4B;IAK5B,kBAAkB;YAIV,iBAAiB;IAsCzB,GAAG,CAAC,CAAC,GAAG,OAAO,EACnB,oBAAoB,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC5D,OAAO,CAAC,EAAE,8BAA8B,CAAC,CAAC,CAAC;IA8FvC,MAAM,CACV,oBAAoB,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAC5D,OAAO,CAAC,EAAE,iCAAiC;IA6GvC,qBAAqB,CACzB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,0BAA0B,CAAC;IAuBhC,SAAS,CAAC,CAAC,GAAG,OAAO,EAAE,EAC3B,cAAc,EACd,OAAO,GACR,EAAE;QACD,cAAc,EAAE,MAAM,GAAG,mBAAmB,CAAA;QAC5C,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAA;KAC9B;IA4DK,cAAc,CAAC,CAAC,GAAG,OAAO,EAAE,EAChC,cAAc,EACd,YAAY,EACZ,OAAO,GACR,EAAE;QACD,cAAc,EAAE,MAAM,GAAG,mBAAmB,CAAA;QAC5C,YAAY,EAAE,OAAO,CAAA;QACrB,OAAO,CAAC,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAA;KACxC;IA+DK,cAAc,CAAC,CAAC,GAAG,OAAO,EAAE,EAChC,cAAc,EACd,YAAY,EACZ,OAAO,GACR,EAAE;QACD,cAAc,EAAE,MAAM,GAAG,mBAAmB,CAAA;QAC5C,YAAY,EAAE,OAAO,CAAA;QACrB,OAAO,CAAC,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAA;KACxC;IAiED,SAAS,CAAC,EACR,UAAU,EACV,aAAa,EACb,UAAU,EACV,YAAY,GACb,EAAE,gBAAgB;IAwCnB,WAAW,CAAC,EACV,UAAU,EACV,aAAa,EACb,cAAc,GACf,EAAE,kBAAkB;YA8CP,MAAM;YA+BN,8BAA8B;IAyC5C,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,mBAAmB;IA4J3B,OAAO,CAAC,2BAA2B;CA+BpC"}