@camunda8/sdk 8.4.0 → 8.4.1

package/dist/zeebe/lib/interfaces-published-contract.d.ts

@@ -0,0 +1,67 @@
+/// <reference types="node" />
+import { MaybeTimeDuration } from 'typed-duration';
+import { CustomSSL } from './GrpcClient';
+export interface OAuthProviderConfig {
+    /** OAuth Endpoint URL */
+    authServerUrl: string;
+    /** OAuth Audience */
+    audience: string;
+    clientId: string;
+    clientSecret: string;
+    /** Custom TLS certificate for OAuth */
+    customRootCert?: Buffer;
+    /** Cache token in memory and on filesystem? */
+    cacheOnDisk?: boolean;
+    /** Override default token cache directory */
+    cacheDir?: string;
+}
+export interface CamundaCloudConfig {
+    clusterId: string;
+    /**
+     * Defaults to `bru-2`
+     */
+    clusterRegion?: string;
+    /**
+     * Just the UUID of the cluster
+     */
+    clientId: string;
+    clientSecret: string;
+    cacheDir?: string;
+    cacheOnDisk?: boolean;
+}
+export type Loglevel = 'INFO' | 'DEBUG' | 'NONE' | 'ERROR';
+export interface ZBCustomLogger {
+    /**
+     * Receives a JSON-stringified ZBLogMessage
+     */
+    debug: (message: string) => void;
+    /**
+     * Receives a JSON-stringified ZBLogMessage
+     */
+    info: (message: string) => void;
+    /**
+     * Receives a JSON-stringified ZBLogMessage
+     */
+    error: (message: string) => void;
+}
+export interface ZBClientOptions {
+    connectionTolerance?: MaybeTimeDuration;
+    eagerConnection?: boolean;
+    loglevel?: Loglevel;
+    stdout?: ZBCustomLogger;
+    retry?: boolean;
+    maxRetries?: number;
+    maxRetryTimeout?: MaybeTimeDuration;
+    oAuth?: OAuthProviderConfig;
+    useTLS?: boolean;
+    logNamespace?: string;
+    longPoll: MaybeTimeDuration;
+    pollInterval: MaybeTimeDuration;
+    camundaCloud?: CamundaCloudConfig;
+    hostname?: string;
+    port?: string;
+    onReady?: () => void;
+    onConnectionError?: () => void;
+    customSSL?: CustomSSL;
+    tenantId?: string;
+}

package/dist/zeebe/lib/interfaces-published-contract.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interfaces-published-contract.js.map

package/dist/zeebe/lib/interfaces-published-contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces-published-contract.js","sourceRoot":"","sources":["../../../src/zeebe/lib/interfaces-published-contract.ts"],"names":[],"mappings":""}

package/dist/zeebe/lib/stringifyVariables.d.ts

@@ -0,0 +1,18 @@
+import { Job } from './interfaces-1.0';
+import { ActivatedJob } from './interfaces-grpc-1.0';
+export declare function parseVariables<T extends {
+    variables: string;
+}, V = JSONDoc>(input: T): Omit<T, 'variables'> & {
+    variables: V;
+};
+export declare function parseVariablesAndCustomHeadersToJSON<Variables, CustomHeaders>(response: ActivatedJob, inputVariableDto: new (...args: any[]) => Readonly<Variables>, customHeadersDto: new (...args: any[]) => Readonly<CustomHeaders>): Job<Variables, CustomHeaders>;
+export declare function stringifyVariables<K, T extends {
+    variables: K extends JSONDoc ? K : K;
+}, V extends T & {
+    variables: string;
+}>(request: T): V;
+type JSON = string | number | boolean | JSON[] | JSONDoc[];
+interface JSONDoc {
+    [key: string]: JSON;
+}
+export {};

package/dist/zeebe/lib/stringifyVariables.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringifyVariables = exports.parseVariablesAndCustomHeadersToJSON = exports.parseVariables = void 0;
+const lib_1 = require("../../lib");
+function parseVariables(input) {
+    return Object.assign({}, input, {
+        variables: (0, lib_1.losslessParse)(input.variables || '{}'),
+    });
+}
+exports.parseVariables = parseVariables;
+function parseVariablesAndCustomHeadersToJSON(response, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+inputVariableDto, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+customHeadersDto) {
+    return Object.assign({}, response, {
+        customHeaders: (0, lib_1.losslessParse)(response.customHeaders, customHeadersDto),
+        variables: (0, lib_1.losslessParse)(response.variables, inputVariableDto),
+    });
+}
+exports.parseVariablesAndCustomHeadersToJSON = parseVariablesAndCustomHeadersToJSON;
+function stringifyVariables(request) {
+    const variables = request.variables || {};
+    const variablesString = (0, lib_1.losslessStringify)(variables);
+    return Object.assign({}, request, { variables: variablesString });
+}
+exports.stringifyVariables = stringifyVariables;
+//# sourceMappingURL=stringifyVariables.js.map

package/dist/zeebe/lib/stringifyVariables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringifyVariables.js","sourceRoot":"","sources":["../../../src/zeebe/lib/stringifyVariables.ts"],"names":[],"mappings":";;;AAAA,mCAA4D;AAK5D,SAAgB,cAAc,CAC7B,KAAQ;IAER,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE;QAC/B,SAAS,EAAE,IAAA,mBAAa,EAAC,KAAK,CAAC,SAAS,IAAI,IAAI,CAAM;KACtD,CAAC,CAAA;AACH,CAAC;AAND,wCAMC;AAED,SAAgB,oCAAoC,CACnD,QAAsB;AACtB,8DAA8D;AAC9D,gBAA6D;AAC7D,8DAA8D;AAC9D,gBAAiE;IAEjE,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE;QAClC,aAAa,EAAE,IAAA,mBAAa,EAC3B,QAAQ,CAAC,aAAa,EACtB,gBAAgB,CACC;QAClB,SAAS,EAAE,IAAA,mBAAa,EACvB,QAAQ,CAAC,SAAS,EAClB,gBAAgB,CACO;KACxB,CAAkC,CAAA;AACpC,CAAC;AAjBD,oFAiBC;AAED,SAAgB,kBAAkB,CAIhC,OAAU;IACX,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAA;IACzC,MAAM,eAAe,GAAG,IAAA,uBAAiB,EAAC,SAAS,CAAC,CAAA;IACpD,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,eAAe,EAAE,CAAM,CAAA;AACvE,CAAC;AARD,gDAQC"}

package/dist/zeebe/lib/utils.d.ts

@@ -0,0 +1,7 @@
+export declare class Utils {
+    /**
+     * Throw an Error if the variable passed is not a number
+     */
+    static validateNumber(variable: string | number, field: string): void;
+    static deepClone(obj: any, hash?: WeakMap<object, any>): any;
+}

package/dist/zeebe/lib/utils.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Utils = void 0;
+class Utils {
+    /**
+     * Throw an Error if the variable passed is not a number
+     */
+    static validateNumber(variable, field) {
+        const value = Number(variable);
+        if (!Number.isInteger(value)) {
+            throw new Error(`
+		  ${field} is malformed, value : ${variable}
+		  `);
+        }
+    }
+    static deepClone(obj, hash = new WeakMap()) {
+        if (obj === null || typeof obj !== 'object') {
+            return obj;
+        }
+        if (hash.has(obj)) {
+            return hash.get(obj);
+        }
+        let result;
+        if (obj instanceof Date) {
+            result = new Date(obj);
+        }
+        else if (obj instanceof RegExp) {
+            result = new RegExp(obj.source, obj.flags);
+        }
+        else if (obj instanceof Array) {
+            result = [];
+            hash.set(obj, result);
+            obj.forEach((item, index) => {
+                result[index] = Utils.deepClone(item, hash);
+            });
+        }
+        else {
+            result = {};
+            hash.set(obj, result);
+            Object.keys(obj).forEach((key) => {
+                result[key] = Utils.deepClone(obj[key], hash);
+            });
+        }
+        return result;
+    }
+}
+exports.Utils = Utils;
+//# sourceMappingURL=utils.js.map

package/dist/zeebe/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/zeebe/lib/utils.ts"],"names":[],"mappings":";;;AAAA,MAAa,KAAK;IACjB;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,QAAyB,EAAE,KAAa;QACpE,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC9B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC;MACb,KAAK,0BAA0B,QAAQ;KACxC,CAAC,CAAA;QACJ,CAAC;IACF,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,GAAG,IAAI,OAAO,EAAE;QAChD,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC7C,OAAO,GAAG,CAAA;QACX,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACrB,CAAC;QAED,IAAI,MAAM,CAAA;QACV,IAAI,GAAG,YAAY,IAAI,EAAE,CAAC;YACzB,MAAM,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAA;QACvB,CAAC;aAAM,IAAI,GAAG,YAAY,MAAM,EAAE,CAAC;YAClC,MAAM,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAA;QAC3C,CAAC;aAAM,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACjC,MAAM,GAAG,EAAE,CAAA;YACX,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;YACrB,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBAC3B,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YAC5C,CAAC,CAAC,CAAA;QACH,CAAC;aAAM,CAAC;YACP,MAAM,GAAG,EAAE,CAAA;YACX,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;YACrB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAChC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;YAC9C,CAAC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,MAAM,CAAA;IACd,CAAC;CACD;AA1CD,sBA0CC"}

package/dist/zeebe/types.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/interfaces-1.0';
+export * from './lib/interfaces-grpc-1.0';
+export * from './lib/interfaces-published-contract';

package/dist/zeebe/types.js

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

package/dist/zeebe/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/zeebe/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAoC;AACpC,4DAAyC;AACzC,sEAAmD"}

package/dist/zeebe/zb/ZBWorker.d.ts

@@ -0,0 +1,7 @@
+import * as ZB from '../lib/interfaces-1.0';
+import { ZBWorkerBase, ZBWorkerConstructorConfig } from '../lib/ZBWorkerBase';
+export declare class ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> extends ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> {
+    constructor(config: ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>);
+    protected handleJobs(jobs: ZB.Job<WorkerInputVariables, CustomHeaderShape>[]): void;
+    protected handleJob(job: ZB.Job<WorkerInputVariables, CustomHeaderShape>): Promise<void>;
+}

package/dist/zeebe/zb/ZBWorker.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZBWorker = void 0;
+const ZBWorkerBase_1 = require("../lib/ZBWorkerBase");
+class ZBWorker extends ZBWorkerBase_1.ZBWorkerBase {
+    constructor(config) {
+        super(config);
+    }
+    handleJobs(jobs) {
+        // Call task handler for each new job
+        jobs.forEach(async (job) => this.handleJob(job));
+    }
+    async handleJob(job) {
+        try {
+            /**
+             * complete.success(variables?: object) and complete.failure(errorMessage: string, retries?: number)
+             *
+             * To halt execution of the business process and raise an incident in Operate, call
+             * complete.failure(errorMessage, 0)
+             */
+            const workerCallback = this.makeCompleteHandlers(job);
+            await this.taskHandler({
+                ...job,
+                cancelWorkflow: workerCallback.cancelWorkflow,
+                complete: workerCallback.complete,
+                fail: workerCallback.fail,
+                error: workerCallback.error,
+                forward: workerCallback.forward,
+            }, this);
+        }
+        catch (e) {
+            this.logger.logError(`Caught an unhandled exception in a task handler for process instance ${job.processInstanceKey}:`);
+            this.logger.logDebug(job);
+            this.logger.logError(e.message);
+            if (this.cancelWorkflowOnException) {
+                const { processInstanceKey } = job;
+                this.logger.logDebug(`Cancelling process instance ${processInstanceKey}`);
+                try {
+                    await this.zbClient.cancelProcessInstance(processInstanceKey);
+                }
+                finally {
+                    this.drainOne();
+                }
+            }
+            else {
+                this.logger.logInfo(`Failing job ${job.key}`);
+                const retries = job.retries - 1;
+                try {
+                    this.zbClient.failJob({
+                        errorMessage: `Unhandled exception in task handler ${e}`,
+                        jobKey: job.key,
+                        retries,
+                        retryBackOff: 0,
+                    });
+                }
+                catch (e) {
+                    this.logger.logDebug(e);
+                }
+                finally {
+                    this.drainOne();
+                    if (retries > 0) {
+                        this.logger.logDebug(`The Zeebe engine will handle the retry. Retries left: ${retries}`);
+                    }
+                    else {
+                        this.logger.logDebug('No retries left for this task');
+                    }
+                }
+            }
+        }
+    }
+}
+exports.ZBWorker = ZBWorker;
+//# sourceMappingURL=ZBWorker.js.map

package/dist/zeebe/zb/ZBWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZBWorker.js","sourceRoot":"","sources":["../../../src/zeebe/zb/ZBWorker.ts"],"names":[],"mappings":";;;AACA,sDAA6E;AAE7E,MAAa,QAIX,SAAQ,2BAIT;IACA,YACC,MAIC;QAED,KAAK,CAAC,MAAM,CAAC,CAAA;IACd,CAAC;IAES,UAAU,CACnB,IAAuD;QAEvD,qCAAqC;QACrC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;IACjD,CAAC;IAES,KAAK,CAAC,SAAS,CACxB,GAAoD;QAEpD,IAAI,CAAC;YACJ;;;;;eAKG;YAEH,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAA;YAErD,MACC,IAAI,CAAC,WAKL,CACA;gBACC,GAAG,GAAG;gBACN,cAAc,EAAE,cAAc,CAAC,cAAc;gBAC7C,QAAQ,EAAE,cAAc,CAAC,QAAQ;gBACjC,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,KAAK,EAAE,cAAc,CAAC,KAAK;gBAC3B,OAAO,EAAE,cAAc,CAAC,OAAO;aAC/B,EACD,IAAI,CACJ,CAAA;QACF,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,CAAC,QAAQ,CACnB,wEAAwE,GAAG,CAAC,kBAAkB,GAAG,CACjG,CAAA;YACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;YACzB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAE,CAAW,CAAC,OAAO,CAAC,CAAA;YAC1C,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACpC,MAAM,EAAE,kBAAkB,EAAE,GAAG,GAAG,CAAA;gBAClC,IAAI,CAAC,MAAM,CAAC,QAAQ,CACnB,+BAA+B,kBAAkB,EAAE,CACnD,CAAA;gBACD,IAAI,CAAC;oBACJ,MAAM,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAA;gBAC9D,CAAC;wBAAS,CAAC;oBACV,IAAI,CAAC,QAAQ,EAAE,CAAA;gBAChB,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,CAAC,GAAG,EAAE,CAAC,CAAA;gBAC7C,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,GAAG,CAAC,CAAA;gBAC/B,IAAI,CAAC;oBACJ,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;wBACrB,YAAY,EAAE,uCAAuC,CAAC,EAAE;wBACxD,MAAM,EAAE,GAAG,CAAC,GAAG;wBACf,OAAO;wBACP,YAAY,EAAE,CAAC;qBACf,CAAC,CAAA;gBACH,CAAC;gBAAC,OAAO,CAAU,EAAE,CAAC;oBACrB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;gBACxB,CAAC;wBAAS,CAAC;oBACV,IAAI,CAAC,QAAQ,EAAE,CAAA;oBACf,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;wBACjB,IAAI,CAAC,MAAM,CAAC,QAAQ,CACnB,yDAAyD,OAAO,EAAE,CAClE,CAAA;oBACF,CAAC;yBAAM,CAAC;wBACP,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,+BAA+B,CAAC,CAAA;oBACtD,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;CACD;AAjGD,4BAiGC"}