@acorex-platform/framework-shared 0.0.10 → 0.0.15
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/background-job/src/index.d.ts +5 -0
- package/background-job/src/index.d.ts.map +1 -0
- package/background-job/src/index.js +8 -0
- package/background-job/src/index.js.map +1 -0
- package/background-job/src/lib/background-job-result.util.d.ts +12 -0
- package/background-job/src/lib/background-job-result.util.d.ts.map +1 -0
- package/background-job/src/lib/background-job-result.util.js +64 -0
- package/background-job/src/lib/background-job-result.util.js.map +1 -0
- package/background-job/src/lib/background-job.constants.d.ts +81 -0
- package/background-job/src/lib/background-job.constants.d.ts.map +1 -0
- package/background-job/src/lib/background-job.constants.js +98 -0
- package/background-job/src/lib/background-job.constants.js.map +1 -0
- package/background-job/src/lib/background-job.errors.d.ts +16 -0
- package/background-job/src/lib/background-job.errors.d.ts.map +1 -0
- package/background-job/src/lib/background-job.errors.js +14 -0
- package/background-job/src/lib/background-job.errors.js.map +1 -0
- package/background-job/src/lib/background-job.types.d.ts +268 -0
- package/background-job/src/lib/background-job.types.d.ts.map +1 -0
- package/background-job/src/lib/background-job.types.js +158 -0
- package/background-job/src/lib/background-job.types.js.map +1 -0
- package/core/src/lib/data/filter.types.d.ts +2 -0
- package/core/src/lib/data/filter.types.d.ts.map +1 -1
- package/core/src/lib/data/filter.types.js +3 -0
- package/core/src/lib/data/filter.types.js.map +1 -1
- package/core/src/lib/data/index.d.ts +1 -0
- package/core/src/lib/data/index.d.ts.map +1 -1
- package/core/src/lib/data/index.js +1 -0
- package/core/src/lib/data/index.js.map +1 -1
- package/core/src/lib/data/query-quick-search.util.d.ts +7 -0
- package/core/src/lib/data/query-quick-search.util.d.ts.map +1 -0
- package/core/src/lib/data/query-quick-search.util.js +56 -0
- package/core/src/lib/data/query-quick-search.util.js.map +1 -0
- package/core/src/lib/identifier/identifier-rule.types.d.ts +25 -0
- package/core/src/lib/identifier/identifier-rule.types.d.ts.map +1 -0
- package/core/src/lib/identifier/identifier-rule.types.js +8 -0
- package/core/src/lib/identifier/identifier-rule.types.js.map +1 -0
- package/core/src/lib/identifier/index.d.ts +2 -0
- package/core/src/lib/identifier/index.d.ts.map +1 -0
- package/core/src/lib/identifier/index.js +5 -0
- package/core/src/lib/identifier/index.js.map +1 -0
- package/core/src/lib/index.d.ts +2 -0
- package/core/src/lib/index.d.ts.map +1 -1
- package/core/src/lib/index.js +2 -0
- package/core/src/lib/index.js.map +1 -1
- package/core/src/lib/integration/constants/auth.constants.d.ts +8 -0
- package/core/src/lib/integration/constants/auth.constants.d.ts.map +1 -0
- package/core/src/lib/integration/constants/auth.constants.js +12 -0
- package/core/src/lib/integration/constants/auth.constants.js.map +1 -0
- package/core/src/lib/integration/constants/capability.constants.d.ts +16 -0
- package/core/src/lib/integration/constants/capability.constants.d.ts.map +1 -0
- package/core/src/lib/integration/constants/capability.constants.js +20 -0
- package/core/src/lib/integration/constants/capability.constants.js.map +1 -0
- package/core/src/lib/integration/constants/category.constants.d.ts +14 -0
- package/core/src/lib/integration/constants/category.constants.d.ts.map +1 -0
- package/core/src/lib/integration/constants/category.constants.js +18 -0
- package/core/src/lib/integration/constants/category.constants.js.map +1 -0
- package/core/src/lib/integration/constants/connection.constants.d.ts +18 -0
- package/core/src/lib/integration/constants/connection.constants.d.ts.map +1 -0
- package/core/src/lib/integration/constants/connection.constants.js +23 -0
- package/core/src/lib/integration/constants/connection.constants.js.map +1 -0
- package/core/src/lib/integration/constants/index.d.ts +5 -0
- package/core/src/lib/integration/constants/index.d.ts.map +1 -0
- package/core/src/lib/integration/constants/index.js +8 -0
- package/core/src/lib/integration/constants/index.js.map +1 -0
- package/core/src/lib/integration/index.d.ts +3 -1
- package/core/src/lib/integration/index.d.ts.map +1 -1
- package/core/src/lib/integration/index.js +3 -1
- package/core/src/lib/integration/index.js.map +1 -1
- package/core/src/lib/integration/integration-connection.safe-types.d.ts +14 -1
- package/core/src/lib/integration/integration-connection.safe-types.d.ts.map +1 -1
- package/core/src/lib/integration/integration-connection.safe-types.js.map +1 -1
- package/core/src/lib/integration/integration-domain.types.d.ts +27 -0
- package/core/src/lib/integration/integration-domain.types.d.ts.map +1 -0
- package/core/src/lib/integration/integration-domain.types.js +4 -0
- package/core/src/lib/integration/integration-domain.types.js.map +1 -0
- package/core/src/lib/integration/integration-reference.types.d.ts +24 -0
- package/core/src/lib/integration/integration-reference.types.d.ts.map +1 -0
- package/core/src/lib/integration/integration-reference.types.js +5 -0
- package/core/src/lib/integration/integration-reference.types.js.map +1 -0
- package/core/src/lib/integration/integration.types.d.ts +50 -3
- package/core/src/lib/integration/integration.types.d.ts.map +1 -1
- package/core/src/lib/integration/integration.types.js.map +1 -1
- package/core/src/lib/interaction/interactive.types.d.ts +12 -0
- package/core/src/lib/interaction/interactive.types.d.ts.map +1 -1
- package/core/src/lib/interaction/interactive.types.js.map +1 -1
- package/core/src/lib/interaction/view-query.types.d.ts +2 -0
- package/core/src/lib/interaction/view-query.types.d.ts.map +1 -1
- package/core/src/lib/interaction/view-query.types.js.map +1 -1
- package/core/src/lib/settings/index.d.ts +2 -0
- package/core/src/lib/settings/index.d.ts.map +1 -0
- package/core/src/lib/settings/index.js +5 -0
- package/core/src/lib/settings/index.js.map +1 -0
- package/core/src/lib/settings/settings-sync-keys.types.d.ts +6 -0
- package/core/src/lib/settings/settings-sync-keys.types.d.ts.map +1 -0
- package/core/src/lib/settings/settings-sync-keys.types.js +5 -0
- package/core/src/lib/settings/settings-sync-keys.types.js.map +1 -0
- package/domain/src/lib/definitions/command-registry.types.d.ts +1 -1
- package/domain/src/lib/definitions/command-registry.types.d.ts.map +1 -1
- package/domain/src/lib/definitions/entity-definition.types.d.ts +6 -0
- package/domain/src/lib/definitions/entity-definition.types.d.ts.map +1 -1
- package/domain/src/lib/definitions/module-definition.types.d.ts +6 -0
- package/domain/src/lib/definitions/module-definition.types.d.ts.map +1 -1
- package/domain/src/lib/definitions/plugin-registry.types.d.ts +23 -0
- package/domain/src/lib/definitions/plugin-registry.types.d.ts.map +1 -0
- package/domain/src/lib/definitions/plugin-registry.types.js +4 -0
- package/domain/src/lib/definitions/plugin-registry.types.js.map +1 -0
- package/domain/src/lib/definitions/storage-binding.types.d.ts +18 -0
- package/domain/src/lib/definitions/storage-binding.types.d.ts.map +1 -0
- package/domain/src/lib/definitions/storage-binding.types.js +5 -0
- package/domain/src/lib/definitions/storage-binding.types.js.map +1 -0
- package/domain/src/lib/definitions/widget-catalog.types.d.ts +3 -2
- package/domain/src/lib/definitions/widget-catalog.types.d.ts.map +1 -1
- package/domain/src/lib/definitions/widget-catalog.types.js +4 -1
- package/domain/src/lib/definitions/widget-catalog.types.js.map +1 -1
- package/domain/src/lib/definitions/widget-registry.types.d.ts +30 -0
- package/domain/src/lib/definitions/widget-registry.types.d.ts.map +1 -0
- package/domain/src/lib/definitions/widget-registry.types.js +4 -0
- package/domain/src/lib/definitions/widget-registry.types.js.map +1 -0
- package/domain/src/lib/index.d.ts +3 -0
- package/domain/src/lib/index.d.ts.map +1 -1
- package/domain/src/lib/index.js +3 -0
- package/domain/src/lib/index.js.map +1 -1
- package/entity/src/lib/helpers/entity-action.helpers.js +4 -4
- package/entity/src/lib/helpers/entity-action.helpers.js.map +1 -1
- package/entity/src/lib/types/entity-query-view.types.d.ts +2 -2
- package/entity/src/lib/types/entity-query-view.types.d.ts.map +1 -1
- package/entity/src/lib/types/lookup-widget.types.d.ts +1 -1
- package/entity/src/lib/types/lookup-widget.types.d.ts.map +1 -1
- package/entity/src/lib/utils/index.d.ts +1 -0
- package/entity/src/lib/utils/index.d.ts.map +1 -1
- package/entity/src/lib/utils/index.js +1 -0
- package/entity/src/lib/utils/index.js.map +1 -1
- package/entity/src/lib/utils/page-list-widget-name.util.d.ts +12 -0
- package/entity/src/lib/utils/page-list-widget-name.util.d.ts.map +1 -0
- package/entity/src/lib/utils/page-list-widget-name.util.js +24 -0
- package/entity/src/lib/utils/page-list-widget-name.util.js.map +1 -0
- package/package.json +9 -1
- package/rule-engine/src/index.d.ts +4 -0
- package/rule-engine/src/index.d.ts.map +1 -0
- package/rule-engine/src/index.js +7 -0
- package/rule-engine/src/index.js.map +1 -0
- package/rule-engine/src/lib/rule-engine.constants.d.ts +17 -0
- package/rule-engine/src/lib/rule-engine.constants.d.ts.map +1 -0
- package/rule-engine/src/lib/rule-engine.constants.js +22 -0
- package/rule-engine/src/lib/rule-engine.constants.js.map +1 -0
- package/rule-engine/src/lib/rule-engine.errors.d.ts +21 -0
- package/rule-engine/src/lib/rule-engine.errors.d.ts.map +1 -0
- package/rule-engine/src/lib/rule-engine.errors.js +50 -0
- package/rule-engine/src/lib/rule-engine.errors.js.map +1 -0
- package/rule-engine/src/lib/rule-engine.types.d.ts +144 -0
- package/rule-engine/src/lib/rule-engine.types.d.ts.map +1 -0
- package/rule-engine/src/lib/rule-engine.types.js +5 -0
- package/rule-engine/src/lib/rule-engine.types.js.map +1 -0
- package/runtime/src/catalog-sidecars.d.ts +2 -1
- package/runtime/src/catalog-sidecars.d.ts.map +1 -1
- package/runtime/src/catalog-sidecars.js +2 -3
- package/runtime/src/catalog-sidecars.js.map +1 -1
- package/runtime/src/lib/commands/entity-command-keys.d.ts +18 -0
- package/runtime/src/lib/commands/entity-command-keys.d.ts.map +1 -0
- package/runtime/src/lib/commands/entity-command-keys.js +50 -0
- package/runtime/src/lib/commands/entity-command-keys.js.map +1 -0
- package/runtime/src/lib/index.d.ts +7 -0
- package/runtime/src/lib/index.d.ts.map +1 -1
- package/runtime/src/lib/index.js +7 -0
- package/runtime/src/lib/index.js.map +1 -1
- package/runtime/src/lib/plugins/catalog-entity-plugin-definition.d.ts +8 -0
- package/runtime/src/lib/plugins/catalog-entity-plugin-definition.d.ts.map +1 -0
- package/runtime/src/lib/plugins/catalog-entity-plugin-definition.js +13 -0
- package/runtime/src/lib/plugins/catalog-entity-plugin-definition.js.map +1 -0
- package/runtime/src/lib/plugins/define-entity-plugin.d.ts +6 -0
- package/runtime/src/lib/plugins/define-entity-plugin.d.ts.map +1 -0
- package/runtime/src/lib/plugins/define-entity-plugin.js +12 -0
- package/runtime/src/lib/plugins/define-entity-plugin.js.map +1 -0
- package/runtime/src/lib/plugins/entity-plugin-definition.categories.d.ts +2 -0
- package/runtime/src/lib/plugins/entity-plugin-definition.categories.d.ts.map +1 -0
- package/runtime/src/lib/plugins/entity-plugin-definition.categories.js +11 -0
- package/runtime/src/lib/plugins/entity-plugin-definition.categories.js.map +1 -0
- package/runtime/src/lib/plugins/entity-plugin-definition.types.d.ts +105 -0
- package/runtime/src/lib/plugins/entity-plugin-definition.types.d.ts.map +1 -0
- package/runtime/src/lib/plugins/entity-plugin-definition.types.js +10 -0
- package/runtime/src/lib/plugins/entity-plugin-definition.types.js.map +1 -0
- package/runtime/src/lib/shared/catalog-definition-base.types.d.ts +1 -1
- package/runtime/src/lib/shared/catalog-definition-base.types.d.ts.map +1 -1
- package/runtime/src/lib/widgets/catalog-widget-definition.d.ts +8 -0
- package/runtime/src/lib/widgets/catalog-widget-definition.d.ts.map +1 -0
- package/runtime/src/lib/widgets/catalog-widget-definition.js +13 -0
- package/runtime/src/lib/widgets/catalog-widget-definition.js.map +1 -0
- package/runtime/src/lib/widgets/widget-definition.categories.d.ts +30 -0
- package/runtime/src/lib/widgets/widget-definition.categories.d.ts.map +1 -0
- package/runtime/src/lib/widgets/widget-definition.categories.js +148 -0
- package/runtime/src/lib/widgets/widget-definition.categories.js.map +1 -0
- package/core/src/lib/integration/integration-status.constants.d.ts +0 -49
- package/core/src/lib/integration/integration-status.constants.d.ts.map +0 -1
- package/core/src/lib/integration/integration-status.constants.js +0 -57
- package/core/src/lib/integration/integration-status.constants.js.map +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../libs/framework/shared/background-job/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,4BAA4B,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const tslib_1 = require("tslib");
|
|
4
|
+
tslib_1.__exportStar(require("./lib/background-job.constants"), exports);
|
|
5
|
+
tslib_1.__exportStar(require("./lib/background-job.errors"), exports);
|
|
6
|
+
tslib_1.__exportStar(require("./lib/background-job-result.util"), exports);
|
|
7
|
+
tslib_1.__exportStar(require("./lib/background-job.types"), exports);
|
|
8
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/framework/shared/background-job/src/index.ts"],"names":[],"mappings":";;;AAAA,yEAA+C;AAC/C,sEAA4C;AAC5C,2EAAiD;AACjD,qEAA2C"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { AXPBackgroundJobError, AXPBackgroundJobHandlerResult, AXPBackgroundJobResult } from './background-job.types';
|
|
2
|
+
export declare function buildBackgroundJobSuccessResult(data?: Record<string, unknown> | null, message?: string | null): AXPBackgroundJobResult | undefined;
|
|
3
|
+
export declare function buildBackgroundJobFailureResult(error: AXPBackgroundJobError, stack?: string): AXPBackgroundJobResult;
|
|
4
|
+
export declare function resolveBackgroundJobResultMessage(result: AXPBackgroundJobResult | undefined): string | undefined;
|
|
5
|
+
export declare function resolveBackgroundJobResultErrorCode(result: AXPBackgroundJobResult | undefined): string | undefined;
|
|
6
|
+
export declare function buildBackgroundJobHandlerResultFromCommand(commandResult: {
|
|
7
|
+
data?: unknown;
|
|
8
|
+
message?: {
|
|
9
|
+
text?: string | Record<string, string>;
|
|
10
|
+
};
|
|
11
|
+
}): AXPBackgroundJobHandlerResult | undefined;
|
|
12
|
+
//# sourceMappingURL=background-job-result.util.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"background-job-result.util.d.ts","sourceRoot":"","sources":["../../../../../../../libs/framework/shared/background-job/src/lib/background-job-result.util.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAM3H,wBAAgB,+BAA+B,CAC7C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,EACrC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GACtB,sBAAsB,GAAG,SAAS,CAYpC;AAED,wBAAgB,+BAA+B,CAC7C,KAAK,EAAE,qBAAqB,EAC5B,KAAK,CAAC,EAAE,MAAM,GACb,sBAAsB,CAmBxB;AAED,wBAAgB,iCAAiC,CAC/C,MAAM,EAAE,sBAAsB,GAAG,SAAS,GACzC,MAAM,GAAG,SAAS,CAGpB;AAED,wBAAgB,mCAAmC,CACjD,MAAM,EAAE,sBAAsB,GAAG,SAAS,GACzC,MAAM,GAAG,SAAS,CAGpB;AAED,wBAAgB,0CAA0C,CACxD,aAAa,EAAE;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CACtD,GACA,6BAA6B,GAAG,SAAS,CAqB3C"}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.buildBackgroundJobSuccessResult = buildBackgroundJobSuccessResult;
|
|
4
|
+
exports.buildBackgroundJobFailureResult = buildBackgroundJobFailureResult;
|
|
5
|
+
exports.resolveBackgroundJobResultMessage = resolveBackgroundJobResultMessage;
|
|
6
|
+
exports.resolveBackgroundJobResultErrorCode = resolveBackgroundJobResultErrorCode;
|
|
7
|
+
exports.buildBackgroundJobHandlerResultFromCommand = buildBackgroundJobHandlerResultFromCommand;
|
|
8
|
+
//#region ---- Result envelope helpers ----
|
|
9
|
+
const MAX_RESULT_STACK_LENGTH = 8192;
|
|
10
|
+
function buildBackgroundJobSuccessResult(data, message) {
|
|
11
|
+
const normalizedMessage = (message === null || message === void 0 ? void 0 : message.trim()) || undefined;
|
|
12
|
+
const normalizedData = data !== null && data !== void 0 ? data : undefined;
|
|
13
|
+
if (!normalizedData && !normalizedMessage) {
|
|
14
|
+
return undefined;
|
|
15
|
+
}
|
|
16
|
+
return Object.assign(Object.assign({}, (normalizedData ? { data: normalizedData } : {})), (normalizedMessage ? { message: normalizedMessage } : {}));
|
|
17
|
+
}
|
|
18
|
+
function buildBackgroundJobFailureResult(error, stack) {
|
|
19
|
+
const data = {};
|
|
20
|
+
if (error.code) {
|
|
21
|
+
data['code'] = error.code;
|
|
22
|
+
}
|
|
23
|
+
if (typeof error.retryable === 'boolean') {
|
|
24
|
+
data['retryable'] = error.retryable;
|
|
25
|
+
}
|
|
26
|
+
if (error.detail) {
|
|
27
|
+
data['detail'] = error.detail;
|
|
28
|
+
}
|
|
29
|
+
const trimmedStack = stack === null || stack === void 0 ? void 0 : stack.trim();
|
|
30
|
+
return Object.assign(Object.assign({ message: error.message }, (Object.keys(data).length > 0 ? { data } : {})), (trimmedStack ? { stack: trimmedStack.slice(0, MAX_RESULT_STACK_LENGTH) } : {}));
|
|
31
|
+
}
|
|
32
|
+
function resolveBackgroundJobResultMessage(result) {
|
|
33
|
+
var _a;
|
|
34
|
+
const message = (_a = result === null || result === void 0 ? void 0 : result.message) === null || _a === void 0 ? void 0 : _a.trim();
|
|
35
|
+
return message || undefined;
|
|
36
|
+
}
|
|
37
|
+
function resolveBackgroundJobResultErrorCode(result) {
|
|
38
|
+
var _a;
|
|
39
|
+
const code = (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a['code'];
|
|
40
|
+
return typeof code === 'string' ? code : undefined;
|
|
41
|
+
}
|
|
42
|
+
function buildBackgroundJobHandlerResultFromCommand(commandResult) {
|
|
43
|
+
var _a, _b, _c, _d;
|
|
44
|
+
const rawText = (_a = commandResult.message) === null || _a === void 0 ? void 0 : _a.text;
|
|
45
|
+
const message = typeof rawText === 'string'
|
|
46
|
+
? rawText.trim() || undefined
|
|
47
|
+
: rawText && typeof rawText === 'object'
|
|
48
|
+
? String((_d = (_c = (_b = rawText['en-US']) !== null && _b !== void 0 ? _b : rawText['en']) !== null && _c !== void 0 ? _c : Object.values(rawText)[0]) !== null && _d !== void 0 ? _d : '').trim() ||
|
|
49
|
+
undefined
|
|
50
|
+
: undefined;
|
|
51
|
+
let data;
|
|
52
|
+
if (commandResult.data !== undefined) {
|
|
53
|
+
if (typeof commandResult.data === 'object' && commandResult.data !== null) {
|
|
54
|
+
data = commandResult.data;
|
|
55
|
+
}
|
|
56
|
+
else {
|
|
57
|
+
data = { value: commandResult.data };
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
const result = buildBackgroundJobSuccessResult(data, message);
|
|
61
|
+
return result ? { result } : undefined;
|
|
62
|
+
}
|
|
63
|
+
//#endregion
|
|
64
|
+
//# sourceMappingURL=background-job-result.util.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"background-job-result.util.js","sourceRoot":"","sources":["../../../../../../../libs/framework/shared/background-job/src/lib/background-job-result.util.ts"],"names":[],"mappings":";;AAMA,0EAeC;AAED,0EAsBC;AAED,8EAKC;AAED,kFAKC;AAED,gGA0BC;AArFD,2CAA2C;AAE3C,MAAM,uBAAuB,GAAG,IAAI,CAAC;AAErC,SAAgB,+BAA+B,CAC7C,IAAqC,EACrC,OAAuB;IAEvB,MAAM,iBAAiB,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE,KAAI,SAAS,CAAC;IACvD,MAAM,cAAc,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,SAAS,CAAC;IAEzC,IAAI,CAAC,cAAc,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC1C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,uCACK,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAChD,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAC5D;AACJ,CAAC;AAED,SAAgB,+BAA+B,CAC7C,KAA4B,EAC5B,KAAc;IAEd,MAAM,IAAI,GAA4B,EAAE,CAAC;IACzC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC;IAC5B,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACzC,IAAI,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC;IACtC,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,IAAI,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;IAChC,CAAC;IAED,MAAM,YAAY,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,EAAE,CAAC;IAEnC,qCACE,OAAO,EAAE,KAAK,CAAC,OAAO,IACnB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAC9C,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,uBAAuB,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAClF;AACJ,CAAC;AAED,SAAgB,iCAAiC,CAC/C,MAA0C;;IAE1C,MAAM,OAAO,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,0CAAE,IAAI,EAAE,CAAC;IACxC,OAAO,OAAO,IAAI,SAAS,CAAC;AAC9B,CAAC;AAED,SAAgB,mCAAmC,CACjD,MAA0C;;IAE1C,MAAM,IAAI,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,0CAAG,MAAM,CAAC,CAAC;IACpC,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC;AAED,SAAgB,0CAA0C,CACxD,aAGC;;IAED,MAAM,OAAO,GAAG,MAAA,aAAa,CAAC,OAAO,0CAAE,IAAI,CAAC;IAC5C,MAAM,OAAO,GACX,OAAO,OAAO,KAAK,QAAQ;QACzB,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,SAAS;QAC7B,CAAC,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ;YACtC,CAAC,CAAC,MAAM,CAAC,MAAA,MAAA,MAAA,OAAO,CAAC,OAAO,CAAC,mCAAI,OAAO,CAAC,IAAI,CAAC,mCAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE;gBACnF,SAAS;YACX,CAAC,CAAC,SAAS,CAAC;IAElB,IAAI,IAAyC,CAAC;IAC9C,IAAI,aAAa,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACrC,IAAI,OAAO,aAAa,CAAC,IAAI,KAAK,QAAQ,IAAI,aAAa,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YAC1E,IAAI,GAAG,aAAa,CAAC,IAA+B,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,EAAE,KAAK,EAAE,aAAa,CAAC,IAAI,EAAE,CAAC;QACvC,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAG,+BAA+B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9D,OAAO,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AACzC,CAAC;AAED,YAAY"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
export declare const AXP_BACKGROUND_JOB_MODULE = "BackgroundJobManagement";
|
|
2
|
+
export declare const AXP_BACKGROUND_JOB_ENTITY = "BackgroundJobManagement.BackgroundJob";
|
|
3
|
+
export declare const AXP_BACKGROUND_JOB_ATTEMPT_ENTITY = "BackgroundJobManagement.BackgroundJobAttempt";
|
|
4
|
+
export declare const AXP_BACKGROUND_JOB_SCHEDULE_ENTITY = "BackgroundJobManagement.BackgroundJobSchedule";
|
|
5
|
+
/** Default lifecycle status for new schedules. */
|
|
6
|
+
export declare const AXP_BACKGROUND_JOB_SCHEDULE_STATUS_ACTIVE: "active";
|
|
7
|
+
/** Registered client status provider key for job schedules. */
|
|
8
|
+
export declare const AXP_BACKGROUND_JOB_SCHEDULE_STATUS_DEFINITION_KEY = "background-job-management.status.background-job-schedule";
|
|
9
|
+
/** Default lifecycle status for new logical jobs. */
|
|
10
|
+
export declare const AXP_BACKGROUND_JOB_STATUS_CREATED: "created";
|
|
11
|
+
/** Registered client status provider key for logical background jobs. */
|
|
12
|
+
export declare const AXP_BACKGROUND_JOB_STATUS_DEFINITION_KEY = "background-job-management.status.background-job";
|
|
13
|
+
/** Error message / abort reason used when a cooperative handler stops on cancellation. */
|
|
14
|
+
export declare const AXP_BACKGROUND_JOB_CANCELLATION_REQUESTED = "cancellation-requested";
|
|
15
|
+
/** Applied to new schedules when no failure policy is supplied. */
|
|
16
|
+
export declare const AXP_BACKGROUND_JOB_SCHEDULE_DEFAULT_FAILURE_POLICY: {
|
|
17
|
+
consecutiveFailureThreshold: number;
|
|
18
|
+
onThresholdExceeded: "pause";
|
|
19
|
+
resetAfterSuccess: boolean;
|
|
20
|
+
};
|
|
21
|
+
/** BullMQ queue name — separate from the workflow queue. */
|
|
22
|
+
export declare const AXP_BACKGROUND_JOBS_QUEUE = "background-jobs";
|
|
23
|
+
/** BullMQ job name for attempt execution. */
|
|
24
|
+
export declare const AXP_BACKGROUND_JOB_EXECUTE = "background-job.execute";
|
|
25
|
+
/** Only one node runs the schedule scanner. */
|
|
26
|
+
export declare const AXP_BACKGROUND_JOB_SCHEDULER_LEADER_LOCK = "bg-job:scheduler:leader";
|
|
27
|
+
/** Prevents duplicate creation of the same scheduled occurrence (short-lived). */
|
|
28
|
+
export declare function backgroundJobScheduleFireLockKey(scheduleId: string, scheduledOccurrence: string): string;
|
|
29
|
+
/** Prevents concurrent execution of the same business operation. */
|
|
30
|
+
export declare function backgroundJobRunLockKey(idempotencyKey: string): string;
|
|
31
|
+
export declare const AXPBackgroundJobCommandKeys: {
|
|
32
|
+
readonly JobCreate: "BackgroundJobManagement:Job:Create";
|
|
33
|
+
readonly JobCancel: "BackgroundJobManagement:Job:Cancel";
|
|
34
|
+
readonly JobPause: "BackgroundJobManagement:Job:Pause";
|
|
35
|
+
readonly JobResume: "BackgroundJobManagement:Job:Resume";
|
|
36
|
+
readonly JobRetry: "BackgroundJobManagement:Job:Retry";
|
|
37
|
+
readonly JobDelete: "BackgroundJobManagement:Job:Delete";
|
|
38
|
+
readonly JobReplayDeadLetter: "BackgroundJobManagement:Job:ReplayDeadLetter";
|
|
39
|
+
readonly ScheduleUpsert: "BackgroundJobManagement:Schedule:Upsert";
|
|
40
|
+
readonly ScheduleEnable: "BackgroundJobManagement:Schedule:Enable";
|
|
41
|
+
readonly ScheduleDisable: "BackgroundJobManagement:Schedule:Disable";
|
|
42
|
+
readonly ScheduleRunNow: "BackgroundJobManagement:Schedule:RunNow";
|
|
43
|
+
readonly ScheduleDelete: "BackgroundJobManagement:Schedule:Delete";
|
|
44
|
+
};
|
|
45
|
+
export declare const AXPBackgroundJobQueryKeys: {
|
|
46
|
+
readonly JobGetOne: "BackgroundJobManagement:Job:GetOne";
|
|
47
|
+
readonly JobList: "BackgroundJobManagement:Job:List";
|
|
48
|
+
readonly JobListActive: "BackgroundJobManagement:Job:ListActive";
|
|
49
|
+
readonly JobListDeadLetter: "BackgroundJobManagement:Job:ListDeadLetter";
|
|
50
|
+
readonly AttemptGetOne: "BackgroundJobManagement:Attempt:GetOne";
|
|
51
|
+
readonly AttemptListByJob: "BackgroundJobManagement:Attempt:ListByJob";
|
|
52
|
+
readonly ScheduleGetOne: "BackgroundJobManagement:Schedule:GetOne";
|
|
53
|
+
readonly ScheduleList: "BackgroundJobManagement:Schedule:List";
|
|
54
|
+
readonly ScheduleGetByScope: "BackgroundJobManagement:Schedule:GetByScope";
|
|
55
|
+
};
|
|
56
|
+
/** Server command keys invoked by the background-job engine or server API. */
|
|
57
|
+
export declare const AXPBackgroundJobServerCommands: {
|
|
58
|
+
readonly Create: "background-job.create";
|
|
59
|
+
readonly Cancel: "background-job.cancel";
|
|
60
|
+
readonly Pause: "background-job.pause";
|
|
61
|
+
readonly Resume: "background-job.resume";
|
|
62
|
+
readonly Retry: "background-job.retry";
|
|
63
|
+
readonly Delete: "background-job.delete";
|
|
64
|
+
readonly ReplayDeadLetter: "background-job.replay-dead-letter";
|
|
65
|
+
readonly ScheduleUpsert: "background-job.schedule.upsert";
|
|
66
|
+
readonly ScheduleEnable: "background-job.schedule.enable";
|
|
67
|
+
readonly ScheduleDisable: "background-job.schedule.disable";
|
|
68
|
+
readonly ScheduleRunNow: "background-job.schedule.run-now";
|
|
69
|
+
readonly ScheduleDelete: "background-job.schedule.delete";
|
|
70
|
+
readonly RetentionPurge: "background-job.retention.purge";
|
|
71
|
+
};
|
|
72
|
+
/** Leader lock for the retention trigger loop (creates purge jobs). */
|
|
73
|
+
export declare const AXP_BACKGROUND_JOB_RETENTION_LEADER_LOCK = "bg-job:retention:leader";
|
|
74
|
+
/**
|
|
75
|
+
* Platform-scope tenant used for system schedules and purge jobs.
|
|
76
|
+
* Matches the platform tenant seeded in tenant-management.
|
|
77
|
+
*/
|
|
78
|
+
export declare const AXP_BACKGROUND_JOB_PLATFORM_TENANT_ID = "f0000002-0000-4000-a000-000000000001";
|
|
79
|
+
/** Stable scope key for the global retention purge schedule. */
|
|
80
|
+
export declare const AXP_BACKGROUND_JOB_RETENTION_SCHEDULE_COMMAND_KEY = "background-job.retention.purge";
|
|
81
|
+
//# sourceMappingURL=background-job.constants.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"background-job.constants.d.ts","sourceRoot":"","sources":["../../../../../../../libs/framework/shared/background-job/src/lib/background-job.constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,yBAAyB,4BAA4B,CAAC;AAEnE,eAAO,MAAM,yBAAyB,0CAA0C,CAAC;AAEjF,eAAO,MAAM,iCAAiC,iDAAiD,CAAC;AAEhG,eAAO,MAAM,kCAAkC,kDAAkD,CAAC;AAElG,kDAAkD;AAClD,eAAO,MAAM,yCAAyC,EAAG,QAAiB,CAAC;AAE3E,+DAA+D;AAC/D,eAAO,MAAM,iDAAiD,6DACF,CAAC;AAE7D,qDAAqD;AACrD,eAAO,MAAM,iCAAiC,EAAG,SAAkB,CAAC;AAEpE,yEAAyE;AACzE,eAAO,MAAM,wCAAwC,oDACF,CAAC;AAEpD,0FAA0F;AAC1F,eAAO,MAAM,yCAAyC,2BAA2B,CAAC;AAElF,mEAAmE;AACnE,eAAO,MAAM,kDAAkD;;;;CAI9D,CAAC;AAMF,4DAA4D;AAC5D,eAAO,MAAM,yBAAyB,oBAAoB,CAAC;AAE3D,6CAA6C;AAC7C,eAAO,MAAM,0BAA0B,2BAA2B,CAAC;AAMnE,+CAA+C;AAC/C,eAAO,MAAM,wCAAwC,4BAA4B,CAAC;AAElF,kFAAkF;AAClF,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,EAClB,mBAAmB,EAAE,MAAM,GAC1B,MAAM,CAER;AAED,oEAAoE;AACpE,wBAAgB,uBAAuB,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM,CAEtE;AAMD,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;CAa9B,CAAC;AAEX,eAAO,MAAM,yBAAyB;;;;;;;;;;CAU5B,CAAC;AAEX,8EAA8E;AAC9E,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;CAcjC,CAAC;AAEX,uEAAuE;AACvE,eAAO,MAAM,wCAAwC,4BAA4B,CAAC;AAElF;;;GAGG;AACH,eAAO,MAAM,qCAAqC,yCAAyC,CAAC;AAE5F,gEAAgE;AAChE,eAAO,MAAM,iDAAiD,mCAAmC,CAAC"}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
//#region ---- Entity module keys ----
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.AXP_BACKGROUND_JOB_RETENTION_SCHEDULE_COMMAND_KEY = exports.AXP_BACKGROUND_JOB_PLATFORM_TENANT_ID = exports.AXP_BACKGROUND_JOB_RETENTION_LEADER_LOCK = exports.AXPBackgroundJobServerCommands = exports.AXPBackgroundJobQueryKeys = exports.AXPBackgroundJobCommandKeys = exports.AXP_BACKGROUND_JOB_SCHEDULER_LEADER_LOCK = exports.AXP_BACKGROUND_JOB_EXECUTE = exports.AXP_BACKGROUND_JOBS_QUEUE = exports.AXP_BACKGROUND_JOB_SCHEDULE_DEFAULT_FAILURE_POLICY = exports.AXP_BACKGROUND_JOB_CANCELLATION_REQUESTED = exports.AXP_BACKGROUND_JOB_STATUS_DEFINITION_KEY = exports.AXP_BACKGROUND_JOB_STATUS_CREATED = exports.AXP_BACKGROUND_JOB_SCHEDULE_STATUS_DEFINITION_KEY = exports.AXP_BACKGROUND_JOB_SCHEDULE_STATUS_ACTIVE = exports.AXP_BACKGROUND_JOB_SCHEDULE_ENTITY = exports.AXP_BACKGROUND_JOB_ATTEMPT_ENTITY = exports.AXP_BACKGROUND_JOB_ENTITY = exports.AXP_BACKGROUND_JOB_MODULE = void 0;
|
|
5
|
+
exports.backgroundJobScheduleFireLockKey = backgroundJobScheduleFireLockKey;
|
|
6
|
+
exports.backgroundJobRunLockKey = backgroundJobRunLockKey;
|
|
7
|
+
exports.AXP_BACKGROUND_JOB_MODULE = 'BackgroundJobManagement';
|
|
8
|
+
exports.AXP_BACKGROUND_JOB_ENTITY = 'BackgroundJobManagement.BackgroundJob';
|
|
9
|
+
exports.AXP_BACKGROUND_JOB_ATTEMPT_ENTITY = 'BackgroundJobManagement.BackgroundJobAttempt';
|
|
10
|
+
exports.AXP_BACKGROUND_JOB_SCHEDULE_ENTITY = 'BackgroundJobManagement.BackgroundJobSchedule';
|
|
11
|
+
/** Default lifecycle status for new schedules. */
|
|
12
|
+
exports.AXP_BACKGROUND_JOB_SCHEDULE_STATUS_ACTIVE = 'active';
|
|
13
|
+
/** Registered client status provider key for job schedules. */
|
|
14
|
+
exports.AXP_BACKGROUND_JOB_SCHEDULE_STATUS_DEFINITION_KEY = 'background-job-management.status.background-job-schedule';
|
|
15
|
+
/** Default lifecycle status for new logical jobs. */
|
|
16
|
+
exports.AXP_BACKGROUND_JOB_STATUS_CREATED = 'created';
|
|
17
|
+
/** Registered client status provider key for logical background jobs. */
|
|
18
|
+
exports.AXP_BACKGROUND_JOB_STATUS_DEFINITION_KEY = 'background-job-management.status.background-job';
|
|
19
|
+
/** Error message / abort reason used when a cooperative handler stops on cancellation. */
|
|
20
|
+
exports.AXP_BACKGROUND_JOB_CANCELLATION_REQUESTED = 'cancellation-requested';
|
|
21
|
+
/** Applied to new schedules when no failure policy is supplied. */
|
|
22
|
+
exports.AXP_BACKGROUND_JOB_SCHEDULE_DEFAULT_FAILURE_POLICY = {
|
|
23
|
+
consecutiveFailureThreshold: 5,
|
|
24
|
+
onThresholdExceeded: 'pause',
|
|
25
|
+
resetAfterSuccess: true,
|
|
26
|
+
};
|
|
27
|
+
//#endregion
|
|
28
|
+
//#region ---- Queue constants ----
|
|
29
|
+
/** BullMQ queue name — separate from the workflow queue. */
|
|
30
|
+
exports.AXP_BACKGROUND_JOBS_QUEUE = 'background-jobs';
|
|
31
|
+
/** BullMQ job name for attempt execution. */
|
|
32
|
+
exports.AXP_BACKGROUND_JOB_EXECUTE = 'background-job.execute';
|
|
33
|
+
//#endregion
|
|
34
|
+
//#region ---- Distributed lock key builders ----
|
|
35
|
+
/** Only one node runs the schedule scanner. */
|
|
36
|
+
exports.AXP_BACKGROUND_JOB_SCHEDULER_LEADER_LOCK = 'bg-job:scheduler:leader';
|
|
37
|
+
/** Prevents duplicate creation of the same scheduled occurrence (short-lived). */
|
|
38
|
+
function backgroundJobScheduleFireLockKey(scheduleId, scheduledOccurrence) {
|
|
39
|
+
return `bg-job:schedule-fire:${scheduleId}:${scheduledOccurrence}`;
|
|
40
|
+
}
|
|
41
|
+
/** Prevents concurrent execution of the same business operation. */
|
|
42
|
+
function backgroundJobRunLockKey(idempotencyKey) {
|
|
43
|
+
return `bg-job:run:${idempotencyKey}`;
|
|
44
|
+
}
|
|
45
|
+
//#endregion
|
|
46
|
+
//#region ---- Client / gateway command and query keys ----
|
|
47
|
+
exports.AXPBackgroundJobCommandKeys = {
|
|
48
|
+
JobCreate: 'BackgroundJobManagement:Job:Create',
|
|
49
|
+
JobCancel: 'BackgroundJobManagement:Job:Cancel',
|
|
50
|
+
JobPause: 'BackgroundJobManagement:Job:Pause',
|
|
51
|
+
JobResume: 'BackgroundJobManagement:Job:Resume',
|
|
52
|
+
JobRetry: 'BackgroundJobManagement:Job:Retry',
|
|
53
|
+
JobDelete: 'BackgroundJobManagement:Job:Delete',
|
|
54
|
+
JobReplayDeadLetter: 'BackgroundJobManagement:Job:ReplayDeadLetter',
|
|
55
|
+
ScheduleUpsert: 'BackgroundJobManagement:Schedule:Upsert',
|
|
56
|
+
ScheduleEnable: 'BackgroundJobManagement:Schedule:Enable',
|
|
57
|
+
ScheduleDisable: 'BackgroundJobManagement:Schedule:Disable',
|
|
58
|
+
ScheduleRunNow: 'BackgroundJobManagement:Schedule:RunNow',
|
|
59
|
+
ScheduleDelete: 'BackgroundJobManagement:Schedule:Delete',
|
|
60
|
+
};
|
|
61
|
+
exports.AXPBackgroundJobQueryKeys = {
|
|
62
|
+
JobGetOne: 'BackgroundJobManagement:Job:GetOne',
|
|
63
|
+
JobList: 'BackgroundJobManagement:Job:List',
|
|
64
|
+
JobListActive: 'BackgroundJobManagement:Job:ListActive',
|
|
65
|
+
JobListDeadLetter: 'BackgroundJobManagement:Job:ListDeadLetter',
|
|
66
|
+
AttemptGetOne: 'BackgroundJobManagement:Attempt:GetOne',
|
|
67
|
+
AttemptListByJob: 'BackgroundJobManagement:Attempt:ListByJob',
|
|
68
|
+
ScheduleGetOne: 'BackgroundJobManagement:Schedule:GetOne',
|
|
69
|
+
ScheduleList: 'BackgroundJobManagement:Schedule:List',
|
|
70
|
+
ScheduleGetByScope: 'BackgroundJobManagement:Schedule:GetByScope',
|
|
71
|
+
};
|
|
72
|
+
/** Server command keys invoked by the background-job engine or server API. */
|
|
73
|
+
exports.AXPBackgroundJobServerCommands = {
|
|
74
|
+
Create: 'background-job.create',
|
|
75
|
+
Cancel: 'background-job.cancel',
|
|
76
|
+
Pause: 'background-job.pause',
|
|
77
|
+
Resume: 'background-job.resume',
|
|
78
|
+
Retry: 'background-job.retry',
|
|
79
|
+
Delete: 'background-job.delete',
|
|
80
|
+
ReplayDeadLetter: 'background-job.replay-dead-letter',
|
|
81
|
+
ScheduleUpsert: 'background-job.schedule.upsert',
|
|
82
|
+
ScheduleEnable: 'background-job.schedule.enable',
|
|
83
|
+
ScheduleDisable: 'background-job.schedule.disable',
|
|
84
|
+
ScheduleRunNow: 'background-job.schedule.run-now',
|
|
85
|
+
ScheduleDelete: 'background-job.schedule.delete',
|
|
86
|
+
RetentionPurge: 'background-job.retention.purge',
|
|
87
|
+
};
|
|
88
|
+
/** Leader lock for the retention trigger loop (creates purge jobs). */
|
|
89
|
+
exports.AXP_BACKGROUND_JOB_RETENTION_LEADER_LOCK = 'bg-job:retention:leader';
|
|
90
|
+
/**
|
|
91
|
+
* Platform-scope tenant used for system schedules and purge jobs.
|
|
92
|
+
* Matches the platform tenant seeded in tenant-management.
|
|
93
|
+
*/
|
|
94
|
+
exports.AXP_BACKGROUND_JOB_PLATFORM_TENANT_ID = 'f0000002-0000-4000-a000-000000000001';
|
|
95
|
+
/** Stable scope key for the global retention purge schedule. */
|
|
96
|
+
exports.AXP_BACKGROUND_JOB_RETENTION_SCHEDULE_COMMAND_KEY = 'background-job.retention.purge';
|
|
97
|
+
//#endregion
|
|
98
|
+
//# sourceMappingURL=background-job.constants.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"background-job.constants.js","sourceRoot":"","sources":["../../../../../../../libs/framework/shared/background-job/src/lib/background-job.constants.ts"],"names":[],"mappings":";AAAA,sCAAsC;;;AAoDtC,4EAKC;AAGD,0DAEC;AA5DY,QAAA,yBAAyB,GAAG,yBAAyB,CAAC;AAEtD,QAAA,yBAAyB,GAAG,uCAAuC,CAAC;AAEpE,QAAA,iCAAiC,GAAG,8CAA8C,CAAC;AAEnF,QAAA,kCAAkC,GAAG,+CAA+C,CAAC;AAElG,kDAAkD;AACrC,QAAA,yCAAyC,GAAG,QAAiB,CAAC;AAE3E,+DAA+D;AAClD,QAAA,iDAAiD,GAC5D,0DAA0D,CAAC;AAE7D,qDAAqD;AACxC,QAAA,iCAAiC,GAAG,SAAkB,CAAC;AAEpE,yEAAyE;AAC5D,QAAA,wCAAwC,GACnD,iDAAiD,CAAC;AAEpD,0FAA0F;AAC7E,QAAA,yCAAyC,GAAG,wBAAwB,CAAC;AAElF,mEAAmE;AACtD,QAAA,kDAAkD,GAAG;IAChE,2BAA2B,EAAE,CAAC;IAC9B,mBAAmB,EAAE,OAAgB;IACrC,iBAAiB,EAAE,IAAI;CACxB,CAAC;AAEF,YAAY;AAEZ,mCAAmC;AAEnC,4DAA4D;AAC/C,QAAA,yBAAyB,GAAG,iBAAiB,CAAC;AAE3D,6CAA6C;AAChC,QAAA,0BAA0B,GAAG,wBAAwB,CAAC;AAEnE,YAAY;AAEZ,iDAAiD;AAEjD,+CAA+C;AAClC,QAAA,wCAAwC,GAAG,yBAAyB,CAAC;AAElF,kFAAkF;AAClF,SAAgB,gCAAgC,CAC9C,UAAkB,EAClB,mBAA2B;IAE3B,OAAO,wBAAwB,UAAU,IAAI,mBAAmB,EAAE,CAAC;AACrE,CAAC;AAED,oEAAoE;AACpE,SAAgB,uBAAuB,CAAC,cAAsB;IAC5D,OAAO,cAAc,cAAc,EAAE,CAAC;AACxC,CAAC;AAED,YAAY;AAEZ,2DAA2D;AAE9C,QAAA,2BAA2B,GAAG;IACzC,SAAS,EAAE,oCAAoC;IAC/C,SAAS,EAAE,oCAAoC;IAC/C,QAAQ,EAAE,mCAAmC;IAC7C,SAAS,EAAE,oCAAoC;IAC/C,QAAQ,EAAE,mCAAmC;IAC7C,SAAS,EAAE,oCAAoC;IAC/C,mBAAmB,EAAE,8CAA8C;IACnE,cAAc,EAAE,yCAAyC;IACzD,cAAc,EAAE,yCAAyC;IACzD,eAAe,EAAE,0CAA0C;IAC3D,cAAc,EAAE,yCAAyC;IACzD,cAAc,EAAE,yCAAyC;CACjD,CAAC;AAEE,QAAA,yBAAyB,GAAG;IACvC,SAAS,EAAE,oCAAoC;IAC/C,OAAO,EAAE,kCAAkC;IAC3C,aAAa,EAAE,wCAAwC;IACvD,iBAAiB,EAAE,4CAA4C;IAC/D,aAAa,EAAE,wCAAwC;IACvD,gBAAgB,EAAE,2CAA2C;IAC7D,cAAc,EAAE,yCAAyC;IACzD,YAAY,EAAE,uCAAuC;IACrD,kBAAkB,EAAE,6CAA6C;CACzD,CAAC;AAEX,8EAA8E;AACjE,QAAA,8BAA8B,GAAG;IAC5C,MAAM,EAAE,uBAAuB;IAC/B,MAAM,EAAE,uBAAuB;IAC/B,KAAK,EAAE,sBAAsB;IAC7B,MAAM,EAAE,uBAAuB;IAC/B,KAAK,EAAE,sBAAsB;IAC7B,MAAM,EAAE,uBAAuB;IAC/B,gBAAgB,EAAE,mCAAmC;IACrD,cAAc,EAAE,gCAAgC;IAChD,cAAc,EAAE,gCAAgC;IAChD,eAAe,EAAE,iCAAiC;IAClD,cAAc,EAAE,iCAAiC;IACjD,cAAc,EAAE,gCAAgC;IAChD,cAAc,EAAE,gCAAgC;CACxC,CAAC;AAEX,uEAAuE;AAC1D,QAAA,wCAAwC,GAAG,yBAAyB,CAAC;AAElF;;;GAGG;AACU,QAAA,qCAAqC,GAAG,sCAAsC,CAAC;AAE5F,gEAAgE;AACnD,QAAA,iDAAiD,GAAG,gCAAgC,CAAC;AAElG,YAAY"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Stable background job lifecycle error codes for client i18n mapping.
|
|
3
|
+
*/
|
|
4
|
+
export declare const AXP_BACKGROUND_JOB_ERROR_CODES: {
|
|
5
|
+
readonly NOT_FOUND: "BACKGROUND_JOB_NOT_FOUND";
|
|
6
|
+
readonly RETRY_INVALID_STATUS: "BACKGROUND_JOB_RETRY_INVALID_STATUS";
|
|
7
|
+
readonly NOT_DEAD_LETTERED: "BACKGROUND_JOB_NOT_DEAD_LETTERED";
|
|
8
|
+
};
|
|
9
|
+
export type AXPBackgroundJobErrorCode = (typeof AXP_BACKGROUND_JOB_ERROR_CODES)[keyof typeof AXP_BACKGROUND_JOB_ERROR_CODES];
|
|
10
|
+
export interface AXPBackgroundJobApiErrorPayload {
|
|
11
|
+
code: AXPBackgroundJobErrorCode;
|
|
12
|
+
jobId?: string;
|
|
13
|
+
status?: string;
|
|
14
|
+
scheduleId?: string;
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=background-job.errors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"background-job.errors.d.ts","sourceRoot":"","sources":["../../../../../../../libs/framework/shared/background-job/src/lib/background-job.errors.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,8BAA8B;;;;CAIjC,CAAC;AAEX,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,8BAA8B,CAAC,CAAC,MAAM,OAAO,8BAA8B,CAAC,CAAC;AAMvF,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,yBAAyB,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
//#region ---- Error codes ----
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.AXP_BACKGROUND_JOB_ERROR_CODES = void 0;
|
|
5
|
+
/**
|
|
6
|
+
* Stable background job lifecycle error codes for client i18n mapping.
|
|
7
|
+
*/
|
|
8
|
+
exports.AXP_BACKGROUND_JOB_ERROR_CODES = {
|
|
9
|
+
NOT_FOUND: 'BACKGROUND_JOB_NOT_FOUND',
|
|
10
|
+
RETRY_INVALID_STATUS: 'BACKGROUND_JOB_RETRY_INVALID_STATUS',
|
|
11
|
+
NOT_DEAD_LETTERED: 'BACKGROUND_JOB_NOT_DEAD_LETTERED',
|
|
12
|
+
};
|
|
13
|
+
//#endregion
|
|
14
|
+
//# sourceMappingURL=background-job.errors.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"background-job.errors.js","sourceRoot":"","sources":["../../../../../../../libs/framework/shared/background-job/src/lib/background-job.errors.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B;;GAEG;AACU,QAAA,8BAA8B,GAAG;IAC5C,SAAS,EAAE,0BAA0B;IACrC,oBAAoB,EAAE,qCAAqC;IAC3D,iBAAiB,EAAE,kCAAkC;CAC7C,CAAC;AAgBX,YAAY"}
|
|
@@ -0,0 +1,268 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Aggregate status of a durable logical job (`BackgroundJob`).
|
|
3
|
+
* `paused` applies only when cooperative pause is explicitly enabled.
|
|
4
|
+
*/
|
|
5
|
+
export type AXPBackgroundJobStatus = 'created' | 'scheduled' | 'queued' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled' | 'dead-lettered';
|
|
6
|
+
/** How the logical job was created. Retry is NOT a logical job trigger. */
|
|
7
|
+
export type AXPBackgroundJobTrigger = 'schedule' | 'manual' | 'event' | 'system';
|
|
8
|
+
/** Terminal + runtime status of a single execution attempt. */
|
|
9
|
+
export type AXPBackgroundJobAttemptStatus = 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'timed-out' | 'abandoned';
|
|
10
|
+
/** Why this attempt exists under its logical job. */
|
|
11
|
+
export type AXPBackgroundJobAttemptTrigger = 'initial' | 'automatic-retry' | 'manual-retry' | 'dead-letter-replay';
|
|
12
|
+
/** Who sees the job in the client tray. */
|
|
13
|
+
export type AXPBackgroundJobVisibility = 'initiator' | 'tenant-admin' | 'silent';
|
|
14
|
+
export declare const AXP_BACKGROUND_JOB_TERMINAL_STATUSES: readonly AXPBackgroundJobStatus[];
|
|
15
|
+
export declare const AXP_BACKGROUND_JOB_ATTEMPT_TERMINAL_STATUSES: readonly AXPBackgroundJobAttemptStatus[];
|
|
16
|
+
export declare function isBackgroundJobTerminal(status: AXPBackgroundJobStatus): boolean;
|
|
17
|
+
export declare function isBackgroundJobAttemptTerminal(status: AXPBackgroundJobAttemptStatus): boolean;
|
|
18
|
+
export interface AXPBackgroundJobError {
|
|
19
|
+
code?: string;
|
|
20
|
+
message: string;
|
|
21
|
+
detail?: string;
|
|
22
|
+
retryable?: boolean;
|
|
23
|
+
}
|
|
24
|
+
export interface AXPBackgroundJobCapabilities {
|
|
25
|
+
canCancelQueued?: boolean;
|
|
26
|
+
supportsCooperativeCancellation?: boolean;
|
|
27
|
+
supportsCooperativePause?: boolean;
|
|
28
|
+
supportsProgress?: boolean;
|
|
29
|
+
supportsEstimate?: boolean;
|
|
30
|
+
clickable?: boolean;
|
|
31
|
+
notifyOnComplete?: boolean;
|
|
32
|
+
notifyOnFailed?: boolean;
|
|
33
|
+
}
|
|
34
|
+
export type AXPBackgroundJobBackoffKind = 'fixed' | 'exponential';
|
|
35
|
+
export type AXPBackgroundJobExhaustedAction = 'fail' | 'dead-letter';
|
|
36
|
+
export type AXPBackgroundJobTimeoutPolicy = 'retry' | 'fail' | 'dead-letter';
|
|
37
|
+
/**
|
|
38
|
+
* Controls execution attempts for ONE logical job.
|
|
39
|
+
* Distinct from `AXPBackgroundJobScheduleFailurePolicy` (schedule reaction to repeated job failures).
|
|
40
|
+
*/
|
|
41
|
+
export interface AXPBackgroundJobRetryPolicy {
|
|
42
|
+
/** Includes the initial execution (maxAttempts = 3 → initial + 2 retries). */
|
|
43
|
+
maxAttempts: number;
|
|
44
|
+
backoff?: AXPBackgroundJobBackoffKind;
|
|
45
|
+
initialDelayMs?: number;
|
|
46
|
+
maxDelayMs?: number;
|
|
47
|
+
retryableErrorCodes?: string[];
|
|
48
|
+
nonRetryableErrorCodes?: string[];
|
|
49
|
+
onExhausted?: AXPBackgroundJobExhaustedAction;
|
|
50
|
+
timeoutPolicy?: AXPBackgroundJobTimeoutPolicy;
|
|
51
|
+
}
|
|
52
|
+
/** Error code assigned to attempts aborted by the per-attempt timeout controller. */
|
|
53
|
+
export declare const AXP_BACKGROUND_JOB_TIMEOUT_ERROR_CODE = "BACKGROUND_JOB_TIMEOUT";
|
|
54
|
+
export declare const AXP_BACKGROUND_JOB_DEFAULT_RETRY_POLICY: AXPBackgroundJobRetryPolicy;
|
|
55
|
+
export type AXPBackgroundJobScheduleSource = 'system' | 'integration' | 'user';
|
|
56
|
+
export type AXPBackgroundJobScheduleConcurrencyPolicy = 'skip-if-running' | 'queue';
|
|
57
|
+
export type AXPBackgroundJobScheduleMissedRunPolicy = 'skip' | 'catch-up-one';
|
|
58
|
+
export type AXPBackgroundJobScheduleStatus = 'active' | 'pause' | 'disabled';
|
|
59
|
+
export type AXPBackgroundJobScheduleThresholdAction = 'disable' | 'alert-only' | 'pause';
|
|
60
|
+
/**
|
|
61
|
+
* Controls how a SCHEDULE reacts to repeated job failures.
|
|
62
|
+
* Not a job retry policy — see `AXPBackgroundJobRetryPolicy`.
|
|
63
|
+
*/
|
|
64
|
+
export interface AXPBackgroundJobScheduleFailurePolicy {
|
|
65
|
+
consecutiveFailureThreshold?: number;
|
|
66
|
+
onThresholdExceeded?: AXPBackgroundJobScheduleThresholdAction;
|
|
67
|
+
resetAfterSuccess?: boolean;
|
|
68
|
+
alertRecipients?: string[];
|
|
69
|
+
cooldownMs?: number;
|
|
70
|
+
}
|
|
71
|
+
/** Structured outcome stored on a logical job when an attempt finishes. */
|
|
72
|
+
export interface AXPBackgroundJobResult {
|
|
73
|
+
/** Small structured payload (counts, ids, flags). */
|
|
74
|
+
data?: Record<string, unknown>;
|
|
75
|
+
/** Human-readable outcome — success summary or failure message. */
|
|
76
|
+
message?: string;
|
|
77
|
+
/** Optional stack trace for failures (truncated by the engine). */
|
|
78
|
+
stack?: string;
|
|
79
|
+
}
|
|
80
|
+
import type { AXPMultiLanguageString } from '@acorex-platform/framework-shared/core';
|
|
81
|
+
import type { AXPEntityModel, AXPRecordStateInfo } from '@acorex-platform/framework-shared/entity';
|
|
82
|
+
/**
|
|
83
|
+
* Durable logical job — the business request and aggregate status across all attempts.
|
|
84
|
+
* Runtime execution data lives on `AXPBackgroundJobAttempt`.
|
|
85
|
+
*/
|
|
86
|
+
export interface AXPBackgroundJob extends AXPEntityModel<string> {
|
|
87
|
+
command: AXPBackgroundJobScheduleCommand;
|
|
88
|
+
providerKey: string;
|
|
89
|
+
scheduleId?: string;
|
|
90
|
+
/** Exact intended scheduled occurrence (UTC-normalized ISO string); schedule-created jobs only. */
|
|
91
|
+
scheduledOccurrence?: string;
|
|
92
|
+
trigger: AXPBackgroundJobTrigger;
|
|
93
|
+
tenantId: string;
|
|
94
|
+
userId?: string;
|
|
95
|
+
applicationId?: string;
|
|
96
|
+
title: string;
|
|
97
|
+
status: AXPBackgroundJobStatus;
|
|
98
|
+
progress?: number;
|
|
99
|
+
statusText?: string;
|
|
100
|
+
currentStep?: string;
|
|
101
|
+
payloadReference?: string;
|
|
102
|
+
/** Outcome envelope — `{ data?, message?, stack? }`; see `AXPBackgroundJobResult`. */
|
|
103
|
+
result?: AXPBackgroundJobResult;
|
|
104
|
+
resultReference?: string;
|
|
105
|
+
capabilities: AXPBackgroundJobCapabilities;
|
|
106
|
+
retryPolicy: AXPBackgroundJobRetryPolicy;
|
|
107
|
+
/** Per-attempt timeout enforced by the engine. */
|
|
108
|
+
executionTimeoutMs?: number;
|
|
109
|
+
/** Aggregate pointer; 0 before first attempt. */
|
|
110
|
+
currentAttempt: number;
|
|
111
|
+
/** From policy; includes initial execution. */
|
|
112
|
+
maxAttempts: number;
|
|
113
|
+
idempotencyKey?: string;
|
|
114
|
+
priority?: number;
|
|
115
|
+
visibility: AXPBackgroundJobVisibility;
|
|
116
|
+
correlationId?: string;
|
|
117
|
+
/** Technical fan-out / bulk execution only — not orchestration. */
|
|
118
|
+
parentJobId?: string;
|
|
119
|
+
/** Set when created via ReplayDeadLetter. */
|
|
120
|
+
replayedFromJobId?: string;
|
|
121
|
+
cancellationRequestedAt?: string;
|
|
122
|
+
cancelledAt?: string;
|
|
123
|
+
cancellationReason?: string;
|
|
124
|
+
cancelledBy?: string;
|
|
125
|
+
createdAt: string;
|
|
126
|
+
queuedAt?: string;
|
|
127
|
+
firstStartedAt?: string;
|
|
128
|
+
/** When the job first started executing (same as firstStartedAt once running). */
|
|
129
|
+
executedAt?: string;
|
|
130
|
+
completedAt?: string;
|
|
131
|
+
totalDurationMs?: number;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* One execution attempt under a logical job.
|
|
135
|
+
* Created and updated internally by the execution engine — no public CRUD.
|
|
136
|
+
*/
|
|
137
|
+
export interface AXPBackgroundJobAttempt {
|
|
138
|
+
id: string;
|
|
139
|
+
jobId: string;
|
|
140
|
+
/** 1-based. */
|
|
141
|
+
attemptNumber: number;
|
|
142
|
+
trigger: AXPBackgroundJobAttemptTrigger;
|
|
143
|
+
status: AXPBackgroundJobAttemptStatus;
|
|
144
|
+
workerId?: string;
|
|
145
|
+
queueJobId?: string;
|
|
146
|
+
traceId?: string;
|
|
147
|
+
spanId?: string;
|
|
148
|
+
startedAt?: string;
|
|
149
|
+
heartbeatAt?: string;
|
|
150
|
+
completedAt?: string;
|
|
151
|
+
durationMs?: number;
|
|
152
|
+
error?: AXPBackgroundJobError;
|
|
153
|
+
createdAt: string;
|
|
154
|
+
}
|
|
155
|
+
/** Command bound to a background job schedule. */
|
|
156
|
+
export interface AXPBackgroundJobScheduleCommand {
|
|
157
|
+
key: string;
|
|
158
|
+
title?: string;
|
|
159
|
+
payload: Record<string, unknown>;
|
|
160
|
+
}
|
|
161
|
+
/** Recurrence rule that creates job instances over time. */
|
|
162
|
+
export interface AXPBackgroundJobSchedule extends AXPEntityModel<string> {
|
|
163
|
+
command: AXPBackgroundJobScheduleCommand;
|
|
164
|
+
providerKey: string;
|
|
165
|
+
title: AXPMultiLanguageString;
|
|
166
|
+
description?: AXPMultiLanguageString;
|
|
167
|
+
connectionId?: string;
|
|
168
|
+
/** IANA timezone code (e.g. `UTC`, `Asia/Tehran`). */
|
|
169
|
+
timezone?: string;
|
|
170
|
+
cron: string;
|
|
171
|
+
/** Lifecycle status — only `active` schedules are fired by the scanner. */
|
|
172
|
+
status: AXPBackgroundJobScheduleStatus;
|
|
173
|
+
source: AXPBackgroundJobScheduleSource;
|
|
174
|
+
priority?: number;
|
|
175
|
+
/** Copied to jobs created by this schedule. */
|
|
176
|
+
defaultVisibility: AXPBackgroundJobVisibility;
|
|
177
|
+
concurrencyPolicy: AXPBackgroundJobScheduleConcurrencyPolicy;
|
|
178
|
+
missedRunPolicy: AXPBackgroundJobScheduleMissedRunPolicy;
|
|
179
|
+
/** e.g. `simpro:pull:{tenantId}:{connectionId}` */
|
|
180
|
+
idempotencyKeyTemplate?: string;
|
|
181
|
+
failurePolicy?: AXPBackgroundJobScheduleFailurePolicy;
|
|
182
|
+
/** Copied to jobs created by this schedule. */
|
|
183
|
+
jobCapabilities?: AXPBackgroundJobCapabilities;
|
|
184
|
+
nextRunAt?: string;
|
|
185
|
+
lastTriggeredAt?: string;
|
|
186
|
+
lastSuccessAt?: string;
|
|
187
|
+
lastFailureAt?: string;
|
|
188
|
+
consecutiveFailures: number;
|
|
189
|
+
}
|
|
190
|
+
/** Resolves the server command key for a persisted job row. */
|
|
191
|
+
export declare function resolveBackgroundJobCommandKey(entity: Pick<AXPBackgroundJob, 'command'>): string;
|
|
192
|
+
/** Resolves the command payload for a persisted job row. */
|
|
193
|
+
export declare function resolveBackgroundJobCommandPayload(entity: Pick<AXPBackgroundJob, 'command'>): Record<string, unknown>;
|
|
194
|
+
/** Resolves the command key from a schedule row. */
|
|
195
|
+
export declare function resolveScheduleCommandKey(schedule: Pick<AXPBackgroundJobSchedule, 'command'>): string;
|
|
196
|
+
/** Resolves the command payload from a schedule row. */
|
|
197
|
+
export declare function resolveScheduleCommandPayload(schedule: Pick<AXPBackgroundJobSchedule, 'command'>): Record<string, unknown>;
|
|
198
|
+
/** Resolves tenant scope from a schedule row. */
|
|
199
|
+
export declare function resolveScheduleTenantId(schedule: Pick<AXPBackgroundJobSchedule, 'ownershipInfo'>): string;
|
|
200
|
+
/** Resolves application scope from a schedule row. */
|
|
201
|
+
export declare function resolveScheduleApplicationId(schedule: Pick<AXPBackgroundJobSchedule, 'ownershipInfo'>): string | undefined;
|
|
202
|
+
/** Resolves the IANA timezone code used by the schedule scanner. */
|
|
203
|
+
export declare function resolveScheduleTimezoneCode(schedule: {
|
|
204
|
+
timezone?: string | {
|
|
205
|
+
code?: string;
|
|
206
|
+
} | null;
|
|
207
|
+
}): string;
|
|
208
|
+
/** Resolves schedule status, including legacy rows that only stored `isDisabled`. */
|
|
209
|
+
export declare function resolveScheduleStatus(schedule: Partial<Pick<AXPBackgroundJobSchedule, 'status'>> & {
|
|
210
|
+
isDisabled?: boolean;
|
|
211
|
+
}): AXPBackgroundJobScheduleStatus;
|
|
212
|
+
/** Whether the schedule scanner should fire this row. */
|
|
213
|
+
export declare function isScheduleActive(schedule: Partial<Pick<AXPBackgroundJobSchedule, 'status'>> & {
|
|
214
|
+
isDisabled?: boolean;
|
|
215
|
+
}): boolean;
|
|
216
|
+
/** Resolves a plain string job title from a schedule row. */
|
|
217
|
+
export declare function resolveScheduleTitle(schedule: Pick<AXPBackgroundJobSchedule, 'title' | 'command'>): string;
|
|
218
|
+
/** Derives tray/provider grouping from a server command key. */
|
|
219
|
+
export declare function deriveBackgroundJobProviderKey(commandKey: string): string;
|
|
220
|
+
/** Runtime class so Nest/webpack can resolve `@Body()` decorator metadata. */
|
|
221
|
+
export declare class AXPCreateBackgroundJobRequest {
|
|
222
|
+
command?: AXPBackgroundJobScheduleCommand;
|
|
223
|
+
title?: string;
|
|
224
|
+
providerKey?: string;
|
|
225
|
+
trigger?: AXPBackgroundJobTrigger;
|
|
226
|
+
tenantId?: string;
|
|
227
|
+
userId?: string;
|
|
228
|
+
applicationId?: string;
|
|
229
|
+
idempotencyKey?: string;
|
|
230
|
+
visibility?: AXPBackgroundJobVisibility;
|
|
231
|
+
priority?: number;
|
|
232
|
+
executionTimeoutMs?: number;
|
|
233
|
+
capabilities?: AXPBackgroundJobCapabilities;
|
|
234
|
+
retryPolicy?: Partial<AXPBackgroundJobRetryPolicy>;
|
|
235
|
+
correlationId?: string;
|
|
236
|
+
parentJobId?: string;
|
|
237
|
+
scheduleId?: string;
|
|
238
|
+
scheduledOccurrence?: string;
|
|
239
|
+
payloadReference?: string;
|
|
240
|
+
stateInfo?: AXPRecordStateInfo;
|
|
241
|
+
}
|
|
242
|
+
export interface AXPCreateBackgroundJobResult {
|
|
243
|
+
jobId: string;
|
|
244
|
+
job: AXPBackgroundJob;
|
|
245
|
+
/** True when an existing non-terminal job with the same idempotency key was returned instead. */
|
|
246
|
+
deduplicated?: boolean;
|
|
247
|
+
}
|
|
248
|
+
export type AXPBackgroundJobCancellationStatus = 'cancellation-requested' | 'cancelled';
|
|
249
|
+
export interface AXPCancelBackgroundJobResult {
|
|
250
|
+
success: boolean;
|
|
251
|
+
status: AXPBackgroundJobCancellationStatus;
|
|
252
|
+
}
|
|
253
|
+
/** True when a handler aborted because the job was cancelled cooperatively. */
|
|
254
|
+
export declare function isBackgroundJobCancellationMessage(message: string | undefined): boolean;
|
|
255
|
+
/** True when a handler aborted because the job was cancelled cooperatively. */
|
|
256
|
+
export declare function isBackgroundJobCancellationError(error: unknown): boolean;
|
|
257
|
+
export interface AXPRetryBackgroundJobResult {
|
|
258
|
+
jobId: string;
|
|
259
|
+
attemptId: string;
|
|
260
|
+
attemptNumber: number;
|
|
261
|
+
}
|
|
262
|
+
/** Returned by a job handler on success; stored on the job per payload/result size rules. */
|
|
263
|
+
export interface AXPBackgroundJobHandlerResult {
|
|
264
|
+
result?: AXPBackgroundJobResult;
|
|
265
|
+
/** Pointer to large output (file, blob store). */
|
|
266
|
+
resultReference?: string;
|
|
267
|
+
}
|
|
268
|
+
//# sourceMappingURL=background-job.types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"background-job.types.d.ts","sourceRoot":"","sources":["../../../../../../../libs/framework/shared/background-job/src/lib/background-job.types.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC9B,SAAS,GACT,WAAW,GACX,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,WAAW,GACX,eAAe,CAAC;AAEpB,2EAA2E;AAC3E,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEjF,+DAA+D;AAC/D,MAAM,MAAM,6BAA6B,GACrC,QAAQ,GACR,SAAS,GACT,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,WAAW,CAAC;AAEhB,qDAAqD;AACrD,MAAM,MAAM,8BAA8B,GACtC,SAAS,GACT,iBAAiB,GACjB,cAAc,GACd,oBAAoB,CAAC;AAEzB,2CAA2C;AAC3C,MAAM,MAAM,0BAA0B,GAAG,WAAW,GAAG,cAAc,GAAG,QAAQ,CAAC;AAEjF,eAAO,MAAM,oCAAoC,EAAE,SAAS,sBAAsB,EAKjF,CAAC;AAEF,eAAO,MAAM,4CAA4C,EAAE,SAAS,6BAA6B,EACjC,CAAC;AAEjE,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAE/E;AAED,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAE7F;AAMD,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,4BAA4B;IAC3C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,MAAM,2BAA2B,GAAG,OAAO,GAAG,aAAa,CAAC;AAElE,MAAM,MAAM,+BAA+B,GAAG,MAAM,GAAG,aAAa,CAAC;AAErE,MAAM,MAAM,6BAA6B,GAAG,OAAO,GAAG,MAAM,GAAG,aAAa,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,2BAA2B,CAAC;IACtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;IAClC,WAAW,CAAC,EAAE,+BAA+B,CAAC;IAC9C,aAAa,CAAC,EAAE,6BAA6B,CAAC;CAC/C;AAED,qFAAqF;AACrF,eAAO,MAAM,qCAAqC,2BAA2B,CAAC;AAE9E,eAAO,MAAM,uCAAuC,EAAE,2BAMrD,CAAC;AAMF,MAAM,MAAM,8BAA8B,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;AAE/E,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,GAAG,OAAO,CAAC;AAEpF,MAAM,MAAM,uCAAuC,GAAG,MAAM,GAAG,cAAc,CAAC;AAE9E,MAAM,MAAM,8BAA8B,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;AAE7E,MAAM,MAAM,uCAAuC,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,CAAC;AAEzF;;;GAGG;AACH,MAAM,WAAW,qCAAqC;IACpD,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,mBAAmB,CAAC,EAAE,uCAAuC,CAAC;IAC9D,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD,2EAA2E;AAC3E,MAAM,WAAW,sBAAsB;IACrC,qDAAqD;IACrD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAMD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AACrF,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAEnG;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc,CAAC,MAAM,CAAC;IAC9D,OAAO,EAAE,+BAA+B,CAAC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mGAAmG;IACnG,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,uBAAuB,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,sBAAsB,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,sFAAsF;IACtF,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,4BAA4B,CAAC;IAC3C,WAAW,EAAE,2BAA2B,CAAC;IACzC,kDAAkD;IAClD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iDAAiD;IACjD,cAAc,EAAE,MAAM,CAAC;IACvB,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,0BAA0B,CAAC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mEAAmE;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kFAAkF;IAClF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,eAAe;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,8BAA8B,CAAC;IACxC,MAAM,EAAE,6BAA6B,CAAC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,kDAAkD;AAClD,MAAM,WAAW,+BAA+B;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,4DAA4D;AAC5D,MAAM,WAAW,wBAAyB,SAAQ,cAAc,CAAC,MAAM,CAAC;IACtE,OAAO,EAAE,+BAA+B,CAAC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,sBAAsB,CAAC;IAC9B,WAAW,CAAC,EAAE,sBAAsB,CAAC;IACrC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,MAAM,EAAE,8BAA8B,CAAC;IACvC,MAAM,EAAE,8BAA8B,CAAC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,iBAAiB,EAAE,0BAA0B,CAAC;IAC9C,iBAAiB,EAAE,yCAAyC,CAAC;IAC7D,eAAe,EAAE,uCAAuC,CAAC;IACzD,mDAAmD;IACnD,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,aAAa,CAAC,EAAE,qCAAqC,CAAC;IACtD,+CAA+C;IAC/C,eAAe,CAAC,EAAE,4BAA4B,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAMD,+DAA+D;AAC/D,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GACxC,MAAM,CAMR;AAED,4DAA4D;AAC5D,wBAAgB,kCAAkC,CAChD,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GACxC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzB;AAED,oDAAoD;AACpD,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,GAClD,MAAM,CAMR;AAED,wDAAwD;AACxD,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,GAClD,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzB;AAED,iDAAiD;AACjD,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,EAAE,eAAe,CAAC,GACxD,MAAM,CAMR;AAED,sDAAsD;AACtD,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,IAAI,CAAC,wBAAwB,EAAE,eAAe,CAAC,GACxD,MAAM,GAAG,SAAS,CAEpB;AAED,oEAAoE;AACpE,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE;IACpD,QAAQ,CAAC,EAAE,MAAM,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C,GAAG,MAAM,CAaT;AAED,qFAAqF;AACrF,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,QAAQ,CAAC,CAAC,GAAG;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GACrF,8BAA8B,CAMhC;AAED,yDAAyD;AACzD,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,QAAQ,CAAC,CAAC,GAAG;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GACrF,OAAO,CAET;AAED,6DAA6D;AAC7D,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,EAAE,OAAO,GAAG,SAAS,CAAC,GAC5D,MAAM,CAaR;AAED,gEAAgE;AAChE,wBAAgB,8BAA8B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAGzE;AAMD,8EAA8E;AAC9E,qBAAa,6BAA6B;IACxC,OAAO,CAAC,EAAE,+BAA+B,CAAC;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,uBAAuB,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,0BAA0B,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,4BAA4B,CAAC;IAC5C,WAAW,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,kBAAkB,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,gBAAgB,CAAC;IACtB,iGAAiG;IACjG,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,kCAAkC,GAAG,wBAAwB,GAAG,WAAW,CAAC;AAExF,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,kCAAkC,CAAC;CAC5C;AAED,+EAA+E;AAC/E,wBAAgB,kCAAkC,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAEvF;AAED,+EAA+E;AAC/E,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAcxE;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB;AAMD,6FAA6F;AAC7F,MAAM,WAAW,6BAA6B;IAC5C,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC,kDAAkD;IAClD,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B"}
|