nestjs-temporal-core 2.0.2 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +322 -134
- package/dist/client/index.js.map +1 -1
- package/dist/client/temporal-client.module.js +46 -19
- package/dist/client/temporal-client.module.js.map +1 -1
- package/dist/client/temporal-client.service.d.ts +7 -7
- package/dist/client/temporal-client.service.js +48 -6
- package/dist/client/temporal-client.service.js.map +1 -1
- package/dist/constants.d.ts +28 -1
- package/dist/constants.js +29 -2
- package/dist/constants.js.map +1 -1
- package/dist/decorators/activity-method.decorator.d.ts +2 -1
- package/dist/decorators/activity-method.decorator.js +21 -3
- package/dist/decorators/activity-method.decorator.js.map +1 -1
- package/dist/decorators/activity.decorator.d.ts +2 -1
- package/dist/decorators/activity.decorator.js +3 -3
- package/dist/decorators/activity.decorator.js.map +1 -1
- package/dist/decorators/index.d.ts +4 -0
- package/dist/decorators/index.js +4 -0
- package/dist/decorators/index.js.map +1 -1
- package/dist/decorators/query.decorator.d.ts +2 -0
- package/dist/decorators/query.decorator.js +26 -0
- package/dist/decorators/query.decorator.js.map +1 -0
- package/dist/decorators/scheduled-workflow.decorator.d.ts +13 -0
- package/dist/decorators/scheduled-workflow.decorator.js +28 -0
- package/dist/decorators/scheduled-workflow.decorator.js.map +1 -0
- package/dist/decorators/signal.decorator.d.ts +2 -0
- package/dist/decorators/signal.decorator.js +26 -0
- package/dist/decorators/signal.decorator.js.map +1 -0
- package/dist/decorators/workflow-method.decorator.d.ts +2 -0
- package/dist/decorators/workflow-method.decorator.js +29 -0
- package/dist/decorators/workflow-method.decorator.js.map +1 -0
- package/dist/decorators/workflow.decorator.d.ts +2 -2
- package/dist/decorators/workflow.decorator.js +12 -4
- package/dist/decorators/workflow.decorator.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/interfaces/activity.interface.d.ts +20 -0
- package/dist/interfaces/activity.interface.js +3 -0
- package/dist/interfaces/activity.interface.js.map +1 -0
- package/dist/interfaces/base.interface.d.ts +4 -2
- package/dist/interfaces/client.interface.d.ts +27 -1
- package/dist/interfaces/index.d.ts +3 -0
- package/dist/interfaces/index.js +3 -0
- package/dist/interfaces/index.js.map +1 -1
- package/dist/interfaces/schedule.interface.d.ts +17 -0
- package/dist/interfaces/schedule.interface.js +3 -0
- package/dist/interfaces/schedule.interface.js.map +1 -0
- package/dist/interfaces/worker.interface.d.ts +18 -3
- package/dist/interfaces/workflow.interface.d.ts +19 -0
- package/dist/interfaces/workflow.interface.js +3 -0
- package/dist/interfaces/workflow.interface.js.map +1 -0
- package/dist/schedule/index.d.ts +2 -0
- package/dist/schedule/index.js +19 -0
- package/dist/schedule/index.js.map +1 -0
- package/dist/schedule/temporal-schedule.module.d.ts +7 -0
- package/dist/schedule/temporal-schedule.module.js +94 -0
- package/dist/schedule/temporal-schedule.module.js.map +1 -0
- package/dist/schedule/temporal-schedule.service.d.ts +28 -0
- package/dist/schedule/temporal-schedule.service.js +230 -0
- package/dist/schedule/temporal-schedule.service.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/worker/temporal-metadata.accessor.d.ts +11 -0
- package/dist/worker/temporal-metadata.accessor.js +78 -1
- package/dist/worker/temporal-metadata.accessor.js.map +1 -1
- package/dist/worker/temporal-worker.module.d.ts +2 -1
- package/dist/worker/temporal-worker.module.js +17 -10
- package/dist/worker/temporal-worker.module.js.map +1 -1
- package/dist/worker/worker-manager.service.d.ts +8 -7
- package/dist/worker/worker-manager.service.js +116 -54
- package/dist/worker/worker-manager.service.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Signal = void 0;
|
|
4
|
+
const common_1 = require("@nestjs/common");
|
|
5
|
+
const constants_1 = require("../constants");
|
|
6
|
+
const Signal = (options) => {
|
|
7
|
+
return (_target, propertyKey, descriptor) => {
|
|
8
|
+
let signalName;
|
|
9
|
+
if (typeof options === 'string') {
|
|
10
|
+
signalName = options;
|
|
11
|
+
}
|
|
12
|
+
else if (options && typeof options === 'object') {
|
|
13
|
+
signalName = options.name || propertyKey.toString();
|
|
14
|
+
}
|
|
15
|
+
else {
|
|
16
|
+
signalName = propertyKey.toString();
|
|
17
|
+
}
|
|
18
|
+
Reflect.defineMetadata(constants_1.TEMPORAL_SIGNAL_METHOD, true, descriptor.value);
|
|
19
|
+
Reflect.defineMetadata(constants_1.TEMPORAL_SIGNAL_NAME, signalName, descriptor.value);
|
|
20
|
+
(0, common_1.SetMetadata)(constants_1.TEMPORAL_SIGNAL_METHOD, true)(descriptor.value);
|
|
21
|
+
(0, common_1.SetMetadata)(constants_1.TEMPORAL_SIGNAL_NAME, signalName)(descriptor.value);
|
|
22
|
+
return descriptor;
|
|
23
|
+
};
|
|
24
|
+
};
|
|
25
|
+
exports.Signal = Signal;
|
|
26
|
+
//# sourceMappingURL=signal.decorator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"signal.decorator.js","sourceRoot":"","sources":["../../src/decorators/signal.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,4CAA4E;AA0BrE,MAAM,MAAM,GAAG,CAAC,OAAsC,EAAmB,EAAE;IAC9E,OAAO,CAAC,OAAgB,EAAE,WAA4B,EAAE,UAA8B,EAAE,EAAE;QAEtF,IAAI,UAAkB,CAAC;QAEvB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC9B,UAAU,GAAG,OAAO,CAAC;QACzB,CAAC;aAAM,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChD,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;QACxD,CAAC;aAAM,CAAC;YACJ,UAAU,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;QACxC,CAAC;QAGD,OAAO,CAAC,cAAc,CAAC,kCAAsB,EAAE,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QACvE,OAAO,CAAC,cAAc,CAAC,gCAAoB,EAAE,UAAU,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QAG3E,IAAA,oBAAW,EAAC,kCAAsB,EAAE,IAAI,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAA,oBAAW,EAAC,gCAAoB,EAAE,UAAU,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAEhE,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAC;AAvBW,QAAA,MAAM,UAuBjB"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WorkflowMethod = void 0;
|
|
4
|
+
const common_1 = require("@nestjs/common");
|
|
5
|
+
const constants_1 = require("../constants");
|
|
6
|
+
const WorkflowMethod = (options) => {
|
|
7
|
+
return (_target, propertyKey, descriptor) => {
|
|
8
|
+
let methodName;
|
|
9
|
+
let methodOptions = {};
|
|
10
|
+
if (typeof options === 'string') {
|
|
11
|
+
methodName = options;
|
|
12
|
+
methodOptions = { name: options };
|
|
13
|
+
}
|
|
14
|
+
else if (options && typeof options === 'object') {
|
|
15
|
+
methodName = options.name || propertyKey.toString();
|
|
16
|
+
methodOptions = options;
|
|
17
|
+
}
|
|
18
|
+
else {
|
|
19
|
+
methodName = propertyKey.toString();
|
|
20
|
+
}
|
|
21
|
+
Reflect.defineMetadata(constants_1.TEMPORAL_WORKFLOW_METHOD, true, descriptor.value);
|
|
22
|
+
Reflect.defineMetadata(constants_1.TEMPORAL_WORKFLOW_METHOD_NAME, methodName, descriptor.value);
|
|
23
|
+
(0, common_1.SetMetadata)(constants_1.TEMPORAL_WORKFLOW_METHOD, true)(descriptor.value);
|
|
24
|
+
(0, common_1.SetMetadata)(constants_1.TEMPORAL_WORKFLOW_METHOD_NAME, methodName)(descriptor.value);
|
|
25
|
+
return descriptor;
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
exports.WorkflowMethod = WorkflowMethod;
|
|
29
|
+
//# sourceMappingURL=workflow-method.decorator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow-method.decorator.js","sourceRoot":"","sources":["../../src/decorators/workflow-method.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,4CAAuF;AAmBhF,MAAM,cAAc,GAAG,CAAC,OAAwC,EAAmB,EAAE;IACxF,OAAO,CAAC,OAAgB,EAAE,WAA4B,EAAE,UAA8B,EAAE,EAAE;QAEtF,IAAI,UAAkB,CAAC;QACvB,IAAI,aAAa,GAA0B,EAAE,CAAC;QAE9C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC9B,UAAU,GAAG,OAAO,CAAC;YACrB,aAAa,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QACtC,CAAC;aAAM,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChD,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;YACpD,aAAa,GAAG,OAAO,CAAC;QAC5B,CAAC;aAAM,CAAC;YACJ,UAAU,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;QACxC,CAAC;QAGD,OAAO,CAAC,cAAc,CAAC,oCAAwB,EAAE,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QACzE,OAAO,CAAC,cAAc,CAAC,yCAA6B,EAAE,UAAU,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QAGpF,IAAA,oBAAW,EAAC,oCAAwB,EAAE,IAAI,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC9D,IAAA,oBAAW,EAAC,yCAA6B,EAAE,UAAU,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAEzE,OAAO,UAAU,CAAC;IACtB,CAAC,CAAC;AACN,CAAC,CAAC;AA1BW,QAAA,cAAc,kBA0BzB"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { WorkflowOptions } from '
|
|
2
|
-
export declare function Workflow(options
|
|
1
|
+
import { WorkflowOptions } from '../interfaces/workflow.interface';
|
|
2
|
+
export declare function Workflow(options: WorkflowOptions): ClassDecorator;
|
|
@@ -1,13 +1,21 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Workflow =
|
|
3
|
+
exports.Workflow = Workflow;
|
|
4
4
|
const common_1 = require("@nestjs/common");
|
|
5
5
|
const constants_1 = require("../constants");
|
|
6
|
-
function Workflow(options
|
|
6
|
+
function Workflow(options) {
|
|
7
|
+
if (!options.taskQueue) {
|
|
8
|
+
throw new Error('taskQueue is required in Workflow decorator options');
|
|
9
|
+
}
|
|
7
10
|
return (target) => {
|
|
8
|
-
|
|
11
|
+
const workflowOptions = {
|
|
12
|
+
...options,
|
|
13
|
+
name: options.name || target.name,
|
|
14
|
+
};
|
|
15
|
+
Reflect.defineMetadata(constants_1.TEMPORAL_WORKFLOW, workflowOptions, target);
|
|
16
|
+
(0, common_1.SetMetadata)(constants_1.TEMPORAL_WORKFLOW, workflowOptions)(target);
|
|
17
|
+
(0, common_1.SetMetadata)(constants_1.TEMPORAL_WORKFLOW_OPTIONS, workflowOptions)(target);
|
|
9
18
|
return target;
|
|
10
19
|
};
|
|
11
20
|
}
|
|
12
|
-
exports.Workflow = Workflow;
|
|
13
21
|
//# sourceMappingURL=workflow.decorator.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflow.decorator.js","sourceRoot":"","sources":["../../src/decorators/workflow.decorator.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"workflow.decorator.js","sourceRoot":"","sources":["../../src/decorators/workflow.decorator.ts"],"names":[],"mappings":";;AAmBA,4BAsBC;AAzCD,2CAA6C;AAC7C,4CAA4E;AAkB5E,SAAgB,QAAQ,CAAC,OAAwB;IAE7C,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,CAAC,MAAW,EAAE,EAAE;QAEnB,MAAM,eAAe,GAAG;YACpB,GAAG,OAAO;YACV,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI;SACpC,CAAC;QAGF,OAAO,CAAC,cAAc,CAAC,6BAAiB,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;QAGnE,IAAA,oBAAW,EAAC,6BAAiB,EAAE,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;QACxD,IAAA,oBAAW,EAAC,qCAAyB,EAAE,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;QAEhE,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;AACN,CAAC"}
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -19,4 +19,5 @@ __exportStar(require("./worker"), exports);
|
|
|
19
19
|
__exportStar(require("./interfaces"), exports);
|
|
20
20
|
__exportStar(require("./decorators"), exports);
|
|
21
21
|
__exportStar(require("./constants"), exports);
|
|
22
|
+
__exportStar(require("./schedule"), exports);
|
|
22
23
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,2CAAyB;AACzB,+CAA6B;AAC7B,+CAA6B;AAC7B,8CAA4B"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,2CAAyB;AACzB,+CAA6B;AAC7B,+CAA6B;AAC7B,8CAA4B;AAC5B,6CAA2B"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export interface ActivityOptions {
|
|
2
|
+
name?: string;
|
|
3
|
+
description?: string;
|
|
4
|
+
}
|
|
5
|
+
export interface ActivityMethodOptions {
|
|
6
|
+
name?: string;
|
|
7
|
+
timeout?: {
|
|
8
|
+
startToClose?: string | number;
|
|
9
|
+
scheduleToStart?: string | number;
|
|
10
|
+
scheduleToClose?: string | number;
|
|
11
|
+
heartbeat?: string | number;
|
|
12
|
+
};
|
|
13
|
+
retry?: {
|
|
14
|
+
maximumAttempts?: number;
|
|
15
|
+
initialInterval?: string | number;
|
|
16
|
+
maximumInterval?: string | number;
|
|
17
|
+
backoffCoefficient?: number;
|
|
18
|
+
nonRetryableErrorTypes?: string[];
|
|
19
|
+
};
|
|
20
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"activity.interface.js","sourceRoot":"","sources":["../../src/interfaces/activity.interface.ts"],"names":[],"mappings":""}
|
|
@@ -1,13 +1,15 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
|
-
/// <reference types="node" />
|
|
3
1
|
export interface ClientCertPair {
|
|
4
2
|
crt: Buffer;
|
|
5
3
|
key: Buffer;
|
|
4
|
+
ca?: Buffer;
|
|
6
5
|
}
|
|
7
6
|
export interface TlsOptions {
|
|
8
7
|
clientCertPair: ClientCertPair;
|
|
8
|
+
serverName?: string;
|
|
9
|
+
verifyServer?: boolean;
|
|
9
10
|
}
|
|
10
11
|
export interface ConnectionOptions {
|
|
11
12
|
address: string;
|
|
12
13
|
tls?: TlsOptions;
|
|
14
|
+
connectionTimeout?: number;
|
|
13
15
|
}
|
|
@@ -1,8 +1,18 @@
|
|
|
1
1
|
import { ModuleMetadata, Type } from '@nestjs/common';
|
|
2
|
-
import {
|
|
2
|
+
import { RetryPolicy, WorkflowIdReusePolicy, WorkflowIdConflictPolicy } from '@temporalio/client';
|
|
3
|
+
import { Duration, SearchAttributes } from '@temporalio/common';
|
|
4
|
+
import { ConnectionOptions } from './base.interface';
|
|
3
5
|
export interface TemporalClientOptions {
|
|
4
6
|
connection: ConnectionOptions;
|
|
5
7
|
namespace?: string;
|
|
8
|
+
allowConnectionFailure?: boolean;
|
|
9
|
+
reconnect?: {
|
|
10
|
+
enabled?: boolean;
|
|
11
|
+
maxAttempts?: number;
|
|
12
|
+
initialDelayMs?: number;
|
|
13
|
+
maxDelayMs?: number;
|
|
14
|
+
backoffCoefficient?: number;
|
|
15
|
+
};
|
|
6
16
|
}
|
|
7
17
|
export interface TemporalClientOptionsFactory {
|
|
8
18
|
createClientOptions(): Promise<TemporalClientOptions> | TemporalClientOptions;
|
|
@@ -13,3 +23,19 @@ export interface TemporalClientAsyncOptions extends Pick<ModuleMetadata, 'import
|
|
|
13
23
|
useFactory?: (...args: any[]) => Promise<TemporalClientOptions> | TemporalClientOptions;
|
|
14
24
|
inject?: any[];
|
|
15
25
|
}
|
|
26
|
+
export interface StartWorkflowOptions {
|
|
27
|
+
taskQueue: string;
|
|
28
|
+
workflowId?: string;
|
|
29
|
+
signal?: string;
|
|
30
|
+
cronSchedule?: string;
|
|
31
|
+
retry?: RetryPolicy;
|
|
32
|
+
startDelay?: Duration;
|
|
33
|
+
workflowExecutionTimeout?: Duration;
|
|
34
|
+
workflowTaskTimeout?: Duration;
|
|
35
|
+
workflowRunTimeout?: Duration;
|
|
36
|
+
workflowIdReusePolicy?: WorkflowIdReusePolicy;
|
|
37
|
+
workflowIdConflictPolicy?: WorkflowIdConflictPolicy;
|
|
38
|
+
searchAttributes?: SearchAttributes;
|
|
39
|
+
followRuns?: boolean;
|
|
40
|
+
memo?: Record<string, unknown>;
|
|
41
|
+
}
|
package/dist/interfaces/index.js
CHANGED
|
@@ -17,4 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
__exportStar(require("./base.interface"), exports);
|
|
18
18
|
__exportStar(require("./client.interface"), exports);
|
|
19
19
|
__exportStar(require("./worker.interface"), exports);
|
|
20
|
+
__exportStar(require("./workflow.interface"), exports);
|
|
21
|
+
__exportStar(require("./activity.interface"), exports);
|
|
22
|
+
__exportStar(require("./schedule.interface"), exports);
|
|
20
23
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAQA,mDAAiC;AAGjC,qDAAmC;AAGnC,qDAAmC;AAGnC,uDAAqC;AAGrC,uDAAqC;AAGrC,uDAAqC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { ModuleMetadata, Type } from '@nestjs/common';
|
|
2
|
+
export interface TemporalScheduleOptions {
|
|
3
|
+
namespace?: string;
|
|
4
|
+
}
|
|
5
|
+
export interface TemporalScheduleOptionsFactory {
|
|
6
|
+
createScheduleOptions(): Promise<TemporalScheduleOptions> | TemporalScheduleOptions;
|
|
7
|
+
}
|
|
8
|
+
export interface TemporalScheduleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
|
|
9
|
+
useExisting?: Type<TemporalScheduleOptionsFactory>;
|
|
10
|
+
useClass?: Type<TemporalScheduleOptionsFactory>;
|
|
11
|
+
useFactory?: (...args: any[]) => Promise<TemporalScheduleOptions> | TemporalScheduleOptions;
|
|
12
|
+
inject?: any[];
|
|
13
|
+
}
|
|
14
|
+
export interface ListSchedulesOptions {
|
|
15
|
+
pageSize?: number;
|
|
16
|
+
query?: string;
|
|
17
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schedule.interface.js","sourceRoot":"","sources":["../../src/interfaces/schedule.interface.ts"],"names":[],"mappings":""}
|
|
@@ -2,12 +2,27 @@ import { ModuleMetadata, Type } from '@nestjs/common';
|
|
|
2
2
|
import { NativeConnectionOptions, RuntimeOptions } from '@temporalio/worker';
|
|
3
3
|
export interface TemporalWorkerOptions {
|
|
4
4
|
connection: NativeConnectionOptions;
|
|
5
|
-
namespace
|
|
5
|
+
namespace?: string;
|
|
6
6
|
taskQueue: string;
|
|
7
7
|
workflowsPath: string;
|
|
8
|
-
activityClasses?: Array<
|
|
8
|
+
activityClasses?: Array<Type<any>>;
|
|
9
9
|
runtimeOptions?: RuntimeOptions;
|
|
10
|
-
workerOptions?:
|
|
10
|
+
workerOptions?: Omit<TemporalWorkerOptions, 'taskQueue' | 'workflowsPath' | 'activities' | 'connection' | 'namespace'>;
|
|
11
|
+
autoStart?: {
|
|
12
|
+
enabled?: boolean;
|
|
13
|
+
delayMs?: number;
|
|
14
|
+
};
|
|
15
|
+
allowWorkerFailure?: boolean;
|
|
16
|
+
monitoring?: {
|
|
17
|
+
statsIntervalMs?: number;
|
|
18
|
+
metrics?: {
|
|
19
|
+
enabled?: boolean;
|
|
20
|
+
prometheus?: {
|
|
21
|
+
enabled?: boolean;
|
|
22
|
+
port?: number;
|
|
23
|
+
};
|
|
24
|
+
};
|
|
25
|
+
};
|
|
11
26
|
}
|
|
12
27
|
export interface TemporalWorkerOptionsFactory {
|
|
13
28
|
createWorkerOptions(): Promise<TemporalWorkerOptions> | TemporalWorkerOptions;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { RetryPolicy } from '@temporalio/common';
|
|
2
|
+
export interface WorkflowOptions {
|
|
3
|
+
name?: string;
|
|
4
|
+
description?: string;
|
|
5
|
+
taskQueue: string;
|
|
6
|
+
workflowExecutionTimeout?: string | number;
|
|
7
|
+
workflowRunTimeout?: string | number;
|
|
8
|
+
workflowTaskTimeout?: string | number;
|
|
9
|
+
retry?: RetryPolicy;
|
|
10
|
+
}
|
|
11
|
+
export interface WorkflowMethodOptions {
|
|
12
|
+
name?: string;
|
|
13
|
+
}
|
|
14
|
+
export interface QueryMethodOptions {
|
|
15
|
+
name?: string;
|
|
16
|
+
}
|
|
17
|
+
export interface SignalMethodOptions {
|
|
18
|
+
name?: string;
|
|
19
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow.interface.js","sourceRoot":"","sources":["../../src/interfaces/workflow.interface.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./temporal-schedule.module"), exports);
|
|
18
|
+
__exportStar(require("./temporal-schedule.service"), exports);
|
|
19
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schedule/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C;AAC3C,8DAA4C"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { DynamicModule } from '@nestjs/common';
|
|
2
|
+
import { TemporalScheduleOptions, TemporalScheduleAsyncOptions } from '../interfaces';
|
|
3
|
+
export declare class TemporalScheduleModule {
|
|
4
|
+
static register(options?: TemporalScheduleOptions): DynamicModule;
|
|
5
|
+
static registerAsync(options: TemporalScheduleAsyncOptions): DynamicModule;
|
|
6
|
+
private static createAsyncProviders;
|
|
7
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
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;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var TemporalScheduleModule_1;
|
|
9
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
+
exports.TemporalScheduleModule = void 0;
|
|
11
|
+
const common_1 = require("@nestjs/common");
|
|
12
|
+
const client_1 = require("../client");
|
|
13
|
+
const constants_1 = require("../constants");
|
|
14
|
+
const temporal_schedule_service_1 = require("./temporal-schedule.service");
|
|
15
|
+
let TemporalScheduleModule = TemporalScheduleModule_1 = class TemporalScheduleModule {
|
|
16
|
+
static register(options = {}) {
|
|
17
|
+
const scheduleOptions = {
|
|
18
|
+
namespace: options.namespace || constants_1.DEFAULT_NAMESPACE,
|
|
19
|
+
...options,
|
|
20
|
+
};
|
|
21
|
+
return {
|
|
22
|
+
module: TemporalScheduleModule_1,
|
|
23
|
+
imports: [client_1.TemporalClientModule],
|
|
24
|
+
providers: [
|
|
25
|
+
{
|
|
26
|
+
provide: constants_1.TEMPORAL_SCHEDULE_MODULE_OPTIONS,
|
|
27
|
+
useValue: scheduleOptions,
|
|
28
|
+
},
|
|
29
|
+
temporal_schedule_service_1.TemporalScheduleService,
|
|
30
|
+
],
|
|
31
|
+
exports: [temporal_schedule_service_1.TemporalScheduleService],
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
static registerAsync(options) {
|
|
35
|
+
return {
|
|
36
|
+
module: TemporalScheduleModule_1,
|
|
37
|
+
imports: [client_1.TemporalClientModule, ...(options.imports || [])],
|
|
38
|
+
providers: [...this.createAsyncProviders(options), temporal_schedule_service_1.TemporalScheduleService],
|
|
39
|
+
exports: [temporal_schedule_service_1.TemporalScheduleService],
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
static createAsyncProviders(options) {
|
|
43
|
+
if (options.useFactory) {
|
|
44
|
+
return [
|
|
45
|
+
{
|
|
46
|
+
provide: constants_1.TEMPORAL_SCHEDULE_MODULE_OPTIONS,
|
|
47
|
+
useFactory: options.useFactory,
|
|
48
|
+
inject: options.inject || [],
|
|
49
|
+
},
|
|
50
|
+
];
|
|
51
|
+
}
|
|
52
|
+
if (options.useClass) {
|
|
53
|
+
return [
|
|
54
|
+
{
|
|
55
|
+
provide: constants_1.TEMPORAL_SCHEDULE_MODULE_OPTIONS,
|
|
56
|
+
useFactory: async (optionsFactory) => {
|
|
57
|
+
const options = await optionsFactory.createScheduleOptions();
|
|
58
|
+
return {
|
|
59
|
+
namespace: options.namespace || constants_1.DEFAULT_NAMESPACE,
|
|
60
|
+
...options,
|
|
61
|
+
};
|
|
62
|
+
},
|
|
63
|
+
inject: [options.useClass],
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
provide: options.useClass,
|
|
67
|
+
useClass: options.useClass,
|
|
68
|
+
},
|
|
69
|
+
];
|
|
70
|
+
}
|
|
71
|
+
if (options.useExisting) {
|
|
72
|
+
return [
|
|
73
|
+
{
|
|
74
|
+
provide: constants_1.TEMPORAL_SCHEDULE_MODULE_OPTIONS,
|
|
75
|
+
useFactory: async (optionsFactory) => {
|
|
76
|
+
const options = await optionsFactory.createScheduleOptions();
|
|
77
|
+
return {
|
|
78
|
+
namespace: options.namespace || constants_1.DEFAULT_NAMESPACE,
|
|
79
|
+
...options,
|
|
80
|
+
};
|
|
81
|
+
},
|
|
82
|
+
inject: [options.useExisting],
|
|
83
|
+
},
|
|
84
|
+
];
|
|
85
|
+
}
|
|
86
|
+
throw new Error('Invalid module configuration. Please provide useFactory, useClass, or useExisting');
|
|
87
|
+
}
|
|
88
|
+
};
|
|
89
|
+
exports.TemporalScheduleModule = TemporalScheduleModule;
|
|
90
|
+
exports.TemporalScheduleModule = TemporalScheduleModule = TemporalScheduleModule_1 = __decorate([
|
|
91
|
+
(0, common_1.Global)(),
|
|
92
|
+
(0, common_1.Module)({})
|
|
93
|
+
], TemporalScheduleModule);
|
|
94
|
+
//# sourceMappingURL=temporal-schedule.module.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"temporal-schedule.module.js","sourceRoot":"","sources":["../../src/schedule/temporal-schedule.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAyE;AACzE,sCAAiD;AACjD,4CAAmF;AAMnF,2EAAsE;AAO/D,IAAM,sBAAsB,8BAA5B,MAAM,sBAAsB;IAuB/B,MAAM,CAAC,QAAQ,CAAC,UAAmC,EAAE;QACjD,MAAM,eAAe,GAAG;YACpB,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,6BAAiB;YACjD,GAAG,OAAO;SACb,CAAC;QAEF,OAAO;YACH,MAAM,EAAE,wBAAsB;YAC9B,OAAO,EAAE,CAAC,6BAAoB,CAAC;YAC/B,SAAS,EAAE;gBACP;oBACI,OAAO,EAAE,4CAAgC;oBACzC,QAAQ,EAAE,eAAe;iBAC5B;gBACD,mDAAuB;aAC1B;YACD,OAAO,EAAE,CAAC,mDAAuB,CAAC;SACrC,CAAC;IACN,CAAC;IAgCD,MAAM,CAAC,aAAa,CAAC,OAAqC;QACtD,OAAO;YACH,MAAM,EAAE,wBAAsB;YAC9B,OAAO,EAAE,CAAC,6BAAoB,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAC3D,SAAS,EAAE,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,mDAAuB,CAAC;YAC3E,OAAO,EAAE,CAAC,mDAAuB,CAAC;SACrC,CAAC;IACN,CAAC;IAMO,MAAM,CAAC,oBAAoB,CAAC,OAAqC;QACrE,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO;gBACH;oBACI,OAAO,EAAE,4CAAgC;oBACzC,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;iBAC/B;aACJ,CAAC;QACN,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACnB,OAAO;gBACH;oBACI,OAAO,EAAE,4CAAgC;oBACzC,UAAU,EAAE,KAAK,EAAE,cAA8C,EAAE,EAAE;wBACjE,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,qBAAqB,EAAE,CAAC;wBAC7D,OAAO;4BACH,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,6BAAiB;4BACjD,GAAG,OAAO;yBACb,CAAC;oBACN,CAAC;oBACD,MAAM,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;iBAC7B;gBACD;oBACI,OAAO,EAAE,OAAO,CAAC,QAAQ;oBACzB,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBAC7B;aACJ,CAAC;QACN,CAAC;QAED,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO;gBACH;oBACI,OAAO,EAAE,4CAAgC;oBACzC,UAAU,EAAE,KAAK,EAAE,cAA8C,EAAE,EAAE;wBACjE,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,qBAAqB,EAAE,CAAC;wBAC7D,OAAO;4BACH,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,6BAAiB;4BACjD,GAAG,OAAO;yBACb,CAAC;oBACN,CAAC;oBACD,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;iBAChC;aACJ,CAAC;QACN,CAAC;QAED,MAAM,IAAI,KAAK,CACX,mFAAmF,CACtF,CAAC;IACN,CAAC;CACJ,CAAA;AAzIY,wDAAsB;iCAAtB,sBAAsB;IAFlC,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,sBAAsB,CAyIlC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { OnModuleInit } from '@nestjs/common';
|
|
2
|
+
import { Client, ScheduleHandle, ScheduleSummary, ScheduleDescription, ScheduleOverlapPolicy } from '@temporalio/client';
|
|
3
|
+
import { TemporalScheduleOptions } from '../interfaces';
|
|
4
|
+
export declare class TemporalScheduleService implements OnModuleInit {
|
|
5
|
+
private readonly options;
|
|
6
|
+
private readonly client;
|
|
7
|
+
private readonly logger;
|
|
8
|
+
private scheduleClient;
|
|
9
|
+
constructor(options: TemporalScheduleOptions, client: Client | null);
|
|
10
|
+
onModuleInit(): Promise<void>;
|
|
11
|
+
private ensureClientInitialized;
|
|
12
|
+
createCronWorkflow(scheduleId: string, workflowType: string, cronExpression: string, taskQueue: string, args?: any[], description?: string): Promise<ScheduleHandle>;
|
|
13
|
+
createIntervalWorkflow(scheduleId: string, workflowType: string, interval: {
|
|
14
|
+
seconds?: number;
|
|
15
|
+
minutes?: number;
|
|
16
|
+
hours?: number;
|
|
17
|
+
days?: number;
|
|
18
|
+
}, taskQueue: string, args?: any[], description?: string): Promise<ScheduleHandle>;
|
|
19
|
+
getSchedule(scheduleId: string): Promise<ScheduleHandle>;
|
|
20
|
+
deleteSchedule(scheduleId: string): Promise<void>;
|
|
21
|
+
pauseSchedule(scheduleId: string, note?: string): Promise<void>;
|
|
22
|
+
resumeSchedule(scheduleId: string, note?: string): Promise<void>;
|
|
23
|
+
triggerNow(scheduleId: string, overlap?: ScheduleOverlapPolicy): Promise<void>;
|
|
24
|
+
backfill(scheduleId: string, startTime: Date, endTime: Date, overlap?: ScheduleOverlapPolicy): Promise<void>;
|
|
25
|
+
describeSchedule(scheduleId: string): Promise<ScheduleDescription>;
|
|
26
|
+
listSchedules(pageSize?: number): Promise<ScheduleSummary[]>;
|
|
27
|
+
private formatInterval;
|
|
28
|
+
}
|