@camunda8/sdk 8.6.13 → 8.6.15

package/dist/c8/lib/C8Dto.js

@@ -0,0 +1,97 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublishMessageResponse = exports.CorrelateMessageResponse = exports.BroadcastSignalResponse = exports.CreateProcessInstanceResponse = exports.DeployResourceResponse = exports.DeployResourceResponseDto = exports.FormDeployment = exports.DecisionRequirementsDeployment = exports.DecisionDeployment = exports.ProcessDeployment = exports.RestApiJob = void 0;
+const lib_1 = require("../../lib");
+class RestApiJob extends lib_1.LosslessDto {
+}
+exports.RestApiJob = RestApiJob;
+__decorate([
+    lib_1.Int64String
+], RestApiJob.prototype, "jobKey", void 0);
+__decorate([
+    lib_1.Int64String
+], RestApiJob.prototype, "processInstanceKey", void 0);
+__decorate([
+    lib_1.Int64String
+], RestApiJob.prototype, "processDefinitionKey", void 0);
+__decorate([
+    lib_1.Int64String
+], RestApiJob.prototype, "elementInstanceKey", void 0);
+__decorate([
+    lib_1.Int64String
+], RestApiJob.prototype, "deadline", void 0);
+class ProcessDeployment extends lib_1.LosslessDto {
+}
+exports.ProcessDeployment = ProcessDeployment;
+__decorate([
+    lib_1.Int64String
+], ProcessDeployment.prototype, "processDefinitionKey", void 0);
+class DecisionDeployment extends lib_1.LosslessDto {
+}
+exports.DecisionDeployment = DecisionDeployment;
+__decorate([
+    lib_1.Int64String
+], DecisionDeployment.prototype, "decisionKey", void 0);
+__decorate([
+    lib_1.Int64String
+], DecisionDeployment.prototype, "dmnDecisionRequirementsKey", void 0);
+class DecisionRequirementsDeployment extends lib_1.LosslessDto {
+}
+exports.DecisionRequirementsDeployment = DecisionRequirementsDeployment;
+__decorate([
+    lib_1.Int64String
+], DecisionRequirementsDeployment.prototype, "dmnDecisionRequirementsKey", void 0);
+class FormDeployment {
+}
+exports.FormDeployment = FormDeployment;
+__decorate([
+    lib_1.Int64String
+], FormDeployment.prototype, "formKey", void 0);
+class DeployResourceResponseDto extends lib_1.LosslessDto {
+}
+exports.DeployResourceResponseDto = DeployResourceResponseDto;
+__decorate([
+    lib_1.Int64String
+], DeployResourceResponseDto.prototype, "deploymentKey", void 0);
+class DeployResourceResponse extends DeployResourceResponseDto {
+}
+exports.DeployResourceResponse = DeployResourceResponse;
+class CreateProcessInstanceResponse {
+}
+exports.CreateProcessInstanceResponse = CreateProcessInstanceResponse;
+__decorate([
+    lib_1.Int64String
+], CreateProcessInstanceResponse.prototype, "processDefinitionKey", void 0);
+__decorate([
+    lib_1.Int64String
+], CreateProcessInstanceResponse.prototype, "processInstanceKey", void 0);
+/** The signal was broadcast. */
+class BroadcastSignalResponse extends lib_1.LosslessDto {
+}
+exports.BroadcastSignalResponse = BroadcastSignalResponse;
+__decorate([
+    lib_1.Int64String
+    /** The unique ID of the signal that was broadcast. */
+], BroadcastSignalResponse.prototype, "signalKey", void 0);
+class CorrelateMessageResponse extends lib_1.LosslessDto {
+}
+exports.CorrelateMessageResponse = CorrelateMessageResponse;
+__decorate([
+    lib_1.Int64String
+], CorrelateMessageResponse.prototype, "key", void 0);
+__decorate([
+    lib_1.Int64String
+], CorrelateMessageResponse.prototype, "processInstanceKey", void 0);
+class PublishMessageResponse extends lib_1.LosslessDto {
+}
+exports.PublishMessageResponse = PublishMessageResponse;
+__decorate([
+    lib_1.Int64String
+], PublishMessageResponse.prototype, "key", void 0);
+//# sourceMappingURL=C8Dto.js.map

package/dist/c8/lib/C8Dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"C8Dto.js","sourceRoot":"","sources":["../../../src/c8/lib/C8Dto.ts"],"names":[],"mappings":";;;;;;;;;AAEA,mCAAoD;AAGpD,MAAa,UAGX,SAAQ,iBAAW;CAoBpB;AAvBD,gCAuBC;AAlBA;IADC,iBAAW;0CACG;AAGf;IADC,iBAAW;sDACe;AAI3B;IADC,iBAAW;wDACiB;AAG7B;IADC,iBAAW;sDACe;AAK3B;IADC,iBAAW;4CACK;AAuClB,MAAa,iBAAkB,SAAQ,iBAAW;CAOjD;AAPD,8CAOC;AAHA;IADC,iBAAW;+DACiB;AAK9B,MAAa,kBAAmB,SAAQ,iBAAW;CAUlD;AAVD,gDAUC;AANA;IADC,iBAAW;uDACQ;AAKpB;IADC,iBAAW;sEACuB;AAGpC,MAAa,8BAA+B,SAAQ,iBAAW;CAQ9D;AARD,wEAQC;AAFA;IADC,iBAAW;kFACuB;AAGpC,MAAa,cAAc;CAO1B;AAPD,wCAOC;AAHA;IADC,iBAAW;+CACI;AAKjB,MAAa,yBAA0B,SAAQ,iBAAW;CAUzD;AAVD,8DAUC;AARA;IADC,iBAAW;gEACU;AAUvB,MAAa,sBAAuB,SAAQ,yBAAyB;CAKpE;AALD,wDAKC;AAED,MAAa,6BAA6B;CAyBzC;AAzBD,sEAyBC;AAnBS;IADR,iBAAW;2EAC0B;AAU7B;IADR,iBAAW;yEACwB;AA8BrC,gCAAgC;AAChC,MAAa,uBAAwB,SAAQ,iBAAW;CAMvD;AAND,0DAMC;AAHA;IAFC,iBAAW;IACZ,sDAAsD;0DACpC;AA4BnB,MAAa,wBAAyB,SAAQ,iBAAW;CASxD;AATD,4DASC;AANA;IADC,iBAAW;qDACA;AAKZ;IADC,iBAAW;oEACe;AAG5B,MAAa,sBAAuB,SAAQ,iBAAW;CAMtD;AAND,wDAMC;AAHA;IADC,iBAAW;mDACA"}

package/dist/c8/lib/C8Logger.d.ts

@@ -0,0 +1,9 @@
+import { Camunda8ClientConfiguration } from '../../lib';
+export type Logger = {
+    info: (message: string | undefined, ...meta: any[]) => void;
+    warn: (message: string | undefined, ...meta: any[]) => void;
+    error: (message: string | undefined, ...meta: any[]) => void;
+    debug: (message: string | undefined, ...meta: any[]) => void;
+    trace: (message: string | undefined, ...meta: any[]) => void;
+};
+export declare function getLogger(config?: Camunda8ClientConfiguration): Logger;

package/dist/c8/lib/C8Logger.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLogger = void 0;
+const winston_1 = __importDefault(require("winston")); // Import Winston
+const lib_1 = require("../../lib");
+let defaultLogger;
+let cachedLogger;
+function getLogger(config) {
+    const configuration = lib_1.CamundaEnvironmentConfigurator.mergeConfigWithEnvironment(config ?? {});
+    // We assume that the SDK user uses a single winston instance for 100% of logging, or no logger at all (in which case we create our own)
+    if (config?.logger && cachedLogger !== config.logger) {
+        cachedLogger = config.logger;
+        config.logger.debug(`Using supplied logger`);
+    }
+    if (!defaultLogger) {
+        // Define the default logger
+        const logger = winston_1.default.createLogger({
+            level: configuration.CAMUNDA_LOG_LEVEL,
+            format: winston_1.default.format.combine(winston_1.default.format.timestamp(), winston_1.default.format.colorize(), winston_1.default.format.simple()),
+            transports: [new winston_1.default.transports.Console()],
+        }); // eslint-disable-line @typescript-eslint/no-explicit-any
+        logger.trace = logger.silly;
+        defaultLogger = logger;
+    }
+    if (!cachedLogger) {
+        defaultLogger.debug(`Using default winston logger`);
+        cachedLogger = defaultLogger;
+    }
+    return config?.logger ?? defaultLogger;
+}
+exports.getLogger = getLogger;
+//# sourceMappingURL=C8Logger.js.map

package/dist/c8/lib/C8Logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"C8Logger.js","sourceRoot":"","sources":["../../../src/c8/lib/C8Logger.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B,CAAC,iBAAiB;AAE/C,mCAGkB;AAYlB,IAAI,aAAqB,CAAA;AACzB,IAAI,YAAgC,CAAA;AAEpC,SAAgB,SAAS,CAAC,MAAoC;IAC7D,MAAM,aAAa,GAClB,oCAA8B,CAAC,0BAA0B,CAAC,MAAM,IAAI,EAAE,CAAC,CAAA;IACxE,wIAAwI;IACxI,IAAI,MAAM,EAAE,MAAM,IAAI,YAAY,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QACtD,YAAY,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;IAC7C,CAAC;IACD,IAAI,CAAC,aAAa,EAAE,CAAC;QACpB,4BAA4B;QAC5B,MAAM,MAAM,GAGR,iBAAO,CAAC,YAAY,CAAC;YACxB,KAAK,EAAE,aAAa,CAAC,iBAAiB;YACtC,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAC7B,iBAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAC1B,iBAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EACzB,iBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CACvB;YACD,UAAU,EAAE,CAAC,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;SAC9C,CAAQ,CAAA,CAAC,yDAAyD;QAEnE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QAC3B,aAAa,GAAG,MAAM,CAAA;IACvB,CAAC;IACD,IAAI,CAAC,YAAY,EAAE,CAAC;QACnB,aAAa,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAA;QACnD,YAAY,GAAG,aAAa,CAAA;IAC7B,CAAC;IACD,OAAO,MAAM,EAAE,MAAM,IAAI,aAAa,CAAA;AACvC,CAAC;AA/BD,8BA+BC"}

package/dist/c8/lib/CamundaJobWorker.d.ts

@@ -0,0 +1,52 @@
+import TypedEmitter from 'typed-emitter';
+import { LosslessDto } from '../../lib';
+import { ActivateJobsRequest, IProcessVariables, JobCompletionInterfaceRest, MustReturnJobActionAcknowledgement } from '../../zeebe/types';
+import { Ctor, RestJob } from './C8Dto';
+import { Logger } from './C8Logger';
+import { CamundaRestClient } from './CamundaRestClient';
+type CamundaJobWorkerEvents = {
+    pollError: (error: Error) => void;
+    start: () => void;
+    stop: () => void;
+    poll: ({ currentlyActiveJobCount, maxJobsToActivate, worker, }: {
+        currentlyActiveJobCount: number;
+        maxJobsToActivate: number;
+        worker: string;
+    }) => void;
+};
+export interface CamundaJobWorkerConfig<VariablesDto extends LosslessDto, CustomHeadersDto extends LosslessDto> extends ActivateJobsRequest {
+    inputVariableDto?: Ctor<VariablesDto>;
+    customHeadersDto?: Ctor<CustomHeadersDto>;
+    /** How often the worker will poll for new jobs. Defaults to 30s */
+    pollIntervalMs?: number;
+    jobHandler: (job: RestJob<VariablesDto, CustomHeadersDto> & JobCompletionInterfaceRest<IProcessVariables>, log: Logger) => MustReturnJobActionAcknowledgement;
+    logger?: Logger;
+    /** Default: true. Start the worker polling immediately. If set to `false`, call the worker's `start()` method to start polling for work. */
+    autoStart?: boolean;
+}
+declare const CamundaJobWorker_base: new () => TypedEmitter<CamundaJobWorkerEvents>;
+export declare class CamundaJobWorker<VariablesDto extends LosslessDto, CustomHeadersDto extends LosslessDto> extends CamundaJobWorker_base {
+    private readonly config;
+    private readonly restClient;
+    currentlyActiveJobCount: number;
+    capacity: number;
+    private loopHandle?;
+    private pollInterval;
+    log: Logger;
+    logMeta: () => {
+        worker: string;
+        type: string;
+        pollIntervalMs: number;
+        capacity: number;
+        currentload: number;
+    };
+    constructor(config: CamundaJobWorkerConfig<VariablesDto, CustomHeadersDto>, restClient: CamundaRestClient);
+    start(): void;
+    /** Stops the Job Worker polling for more jobs. If await this call, and it will return as soon as all currently active jobs are completed.
+     * The deadline for all currently active jobs to complete is 30s by default. If the active jobs do not complete by the deadline, this method will throw.
+     */
+    stop(deadlineMs?: number): Promise<unknown>;
+    private poll;
+    private handleJob;
+}
+export {};

package/dist/c8/lib/CamundaJobWorker.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CamundaJobWorker = void 0;
+const events_1 = require("events");
+const C8Logger_1 = require("./C8Logger");
+// Make this class extend event emitter and have a typed event 'pollError'
+class CamundaJobWorker extends events_1.EventEmitter {
+    constructor(config, restClient) {
+        super();
+        this.config = config;
+        this.restClient = restClient;
+        this.currentlyActiveJobCount = 0;
+        this.pollInterval = config.pollIntervalMs ?? 30000;
+        this.capacity = this.config.maxJobsToActivate;
+        this.log = (0, C8Logger_1.getLogger)({ logger: config.logger });
+        this.logMeta = () => ({
+            worker: this.config.worker,
+            type: this.config.type,
+            pollIntervalMs: this.pollInterval,
+            capacity: this.config.maxJobsToActivate,
+            currentload: this.currentlyActiveJobCount,
+        });
+        this.log.debug(`Created REST Job Worker`, this.logMeta());
+        if (config.autoStart ?? true) {
+            this.start();
+        }
+    }
+    start() {
+        this.log.debug(`Starting poll loop`, this.logMeta());
+        this.emit('start');
+        this.poll();
+        this.loopHandle = setInterval(() => this.poll(), this.pollInterval);
+    }
+    /** Stops the Job Worker polling for more jobs. If await this call, and it will return as soon as all currently active jobs are completed.
+     * The deadline for all currently active jobs to complete is 30s by default. If the active jobs do not complete by the deadline, this method will throw.
+     */
+    async stop(deadlineMs = 30000) {
+        this.log.debug(`Stop requested`, this.logMeta());
+        /** Stopping polling for new jobs */
+        clearInterval(this.loopHandle);
+        return new Promise((resolve, reject) => {
+            if (this.currentlyActiveJobCount === 0) {
+                this.log.debug(`All jobs drained. Worker stopped.`, this.logMeta());
+                this.emit('stop');
+                return resolve(null);
+            }
+            /** This is an error timeout - if we don't complete all active jobs before the specified deadline, we reject the Promise */
+            const timeout = setTimeout(() => {
+                clearInterval(wait);
+                this.log.debug(`Failed to drain all jobs in ${deadlineMs}ms`, this.logMeta());
+                return reject(`Failed to drain all jobs in ${deadlineMs}ms`);
+            }, deadlineMs);
+            /** Check every 500ms to see if our active job count has hit zero, i.e: all active work is stopped */
+            const wait = setInterval(() => {
+                if (this.currentlyActiveJobCount === 0) {
+                    this.log.debug(`All jobs drained. Worker stopped.`, this.logMeta());
+                    clearInterval(wait);
+                    clearTimeout(timeout);
+                    this.emit('stop');
+                    return resolve(null);
+                }
+                this.log.debug(`Stopping - waiting for active jobs to complete.`, this.logMeta());
+            }, 500);
+        });
+    }
+    poll() {
+        this.emit('poll', {
+            currentlyActiveJobCount: this.currentlyActiveJobCount,
+            maxJobsToActivate: this.config.maxJobsToActivate,
+            worker: this.config.worker,
+        });
+        if (this.currentlyActiveJobCount >= this.config.maxJobsToActivate) {
+            this.log.debug(`At capacity - not requesting more jobs`, this.logMeta());
+            return;
+        }
+        this.log.trace(`Polling for jobs`, this.logMeta());
+        const remainingJobCapacity = this.config.maxJobsToActivate - this.currentlyActiveJobCount;
+        this.restClient
+            .activateJobs({
+            ...this.config,
+            maxJobsToActivate: remainingJobCapacity,
+        })
+            .then((jobs) => {
+            const count = jobs.length;
+            this.currentlyActiveJobCount += count;
+            this.log.debug(`Activated ${count} jobs`, this.logMeta());
+            // The job handlers for the activated jobs will run in parallel
+            jobs.forEach((job) => this.handleJob(job));
+        })
+            .catch((e) => this.emit('pollError', e));
+    }
+    async handleJob(job) {
+        try {
+            this.log.debug(`Invoking job handler for job ${job.jobKey}`, this.logMeta());
+            await this.config.jobHandler(job, this.log);
+            this.log.debug(`Completed job handler for job ${job.jobKey}.`, this.logMeta());
+        }
+        catch (e) {
+            /** Unhandled exception in the job handler */
+            if (e instanceof Error) {
+                // If err is an instance of Error, we can safely access its properties
+                this.log.error(`Unhandled exception in job handler for job ${job.jobKey}`, this.logMeta());
+                this.log.error(`Error: ${e.message}`, {
+                    stack: e.stack,
+                    ...this.logMeta(),
+                });
+            }
+            else {
+                // If err is not an Error, log it as is
+                this.log.error('An unknown error occurred while executing a job handler', { error: e, ...this.logMeta() });
+            }
+            this.log.error(`Failing the job`, this.logMeta());
+            await job.fail({
+                errorMessage: e.toString(),
+                retries: job.retries - 1,
+            });
+        }
+        finally {
+            /** Decrement the active job count in all cases */
+            this.currentlyActiveJobCount--;
+        }
+    }
+}
+exports.CamundaJobWorker = CamundaJobWorker;
+//# sourceMappingURL=CamundaJobWorker.js.map

package/dist/c8/lib/CamundaJobWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CamundaJobWorker.js","sourceRoot":"","sources":["../../../src/c8/lib/CamundaJobWorker.ts"],"names":[],"mappings":";;;AAAA,mCAAqC;AAarC,yCAA8C;AAmC9C,0EAA0E;AAC1E,MAAa,gBAGX,SAAS,qBAA+D;IAczE,YACkB,MAGhB,EACgB,UAA6B;QAE9C,KAAK,EAAE,CAAA;QANU,WAAM,GAAN,MAAM,CAGtB;QACgB,eAAU,GAAV,UAAU,CAAmB;QAlBxC,4BAAuB,GAAG,CAAC,CAAA;QAqBjC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,cAAc,IAAI,KAAK,CAAA;QAClD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAA;QAC7C,IAAI,CAAC,GAAG,GAAG,IAAA,oBAAS,EAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;QAC/C,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,CAAC;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACtB,cAAc,EAAE,IAAI,CAAC,YAAY;YACjC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,iBAAiB;YACvC,WAAW,EAAE,IAAI,CAAC,uBAAuB;SACzC,CAAC,CAAA;QACF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QACzD,IAAI,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC,KAAK,EAAE,CAAA;QACb,CAAC;IACF,CAAC;IAED,KAAK;QACJ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAClB,IAAI,CAAC,IAAI,EAAE,CAAA;QACX,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;IACpE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,KAAK;QAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QAChD,oCAAoC;QACpC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtC,IAAI,IAAI,CAAC,uBAAuB,KAAK,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;gBACnE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBACjB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAA;YACrB,CAAC;YACD,2HAA2H;YAC3H,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC/B,aAAa,CAAC,IAAI,CAAC,CAAA;gBACnB,IAAI,CAAC,GAAG,CAAC,KAAK,CACb,+BAA+B,UAAU,IAAI,EAC7C,IAAI,CAAC,OAAO,EAAE,CACd,CAAA;gBACD,OAAO,MAAM,CAAC,+BAA+B,UAAU,IAAI,CAAC,CAAA;YAC7D,CAAC,EAAE,UAAU,CAAC,CAAA;YACd,qGAAqG;YACrG,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,EAAE;gBAC7B,IAAI,IAAI,CAAC,uBAAuB,KAAK,CAAC,EAAE,CAAC;oBACxC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;oBACnE,aAAa,CAAC,IAAI,CAAC,CAAA;oBACnB,YAAY,CAAC,OAAO,CAAC,CAAA;oBACrB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;oBACjB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAA;gBACrB,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,KAAK,CACb,iDAAiD,EACjD,IAAI,CAAC,OAAO,EAAE,CACd,CAAA;YACF,CAAC,EAAE,GAAG,CAAC,CAAA;QACR,CAAC,CAAC,CAAA;IACH,CAAC;IAEO,IAAI;QACX,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACjB,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;YACrD,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,iBAAiB;YAChD,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;SAC1B,CAAC,CAAA;QACF,IAAI,IAAI,CAAC,uBAAuB,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;YACnE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wCAAwC,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YACxE,OAAM;QACP,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QAElD,MAAM,oBAAoB,GACzB,IAAI,CAAC,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC,uBAAuB,CAAA;QAC7D,IAAI,CAAC,UAAU;aACb,YAAY,CAAC;YACb,GAAG,IAAI,CAAC,MAAM;YACd,iBAAiB,EAAE,oBAAoB;SACvC,CAAC;aACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACd,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAA;YACzB,IAAI,CAAC,uBAAuB,IAAI,KAAK,CAAA;YACrC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,KAAK,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YACzD,+DAA+D;YAC/D,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;QAC3C,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAA;IAC1C,CAAC;IAEO,KAAK,CAAC,SAAS,CACtB,GAC8C;QAE9C,IAAI,CAAC;YACJ,IAAI,CAAC,GAAG,CAAC,KAAK,CACb,gCAAgC,GAAG,CAAC,MAAM,EAAE,EAC5C,IAAI,CAAC,OAAO,EAAE,CACd,CAAA;YACD,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;YAC3C,IAAI,CAAC,GAAG,CAAC,KAAK,CACb,iCAAiC,GAAG,CAAC,MAAM,GAAG,EAC9C,IAAI,CAAC,OAAO,EAAE,CACd,CAAA;QACF,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,6CAA6C;YAC7C,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;gBACxB,sEAAsE;gBACtE,IAAI,CAAC,GAAG,CAAC,KAAK,CACb,8CAA8C,GAAG,CAAC,MAAM,EAAE,EAC1D,IAAI,CAAC,OAAO,EAAE,CACd,CAAA;gBACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,EAAE;oBACrC,KAAK,EAAE,CAAC,CAAC,KAAK;oBACd,GAAG,IAAI,CAAC,OAAO,EAAE;iBACjB,CAAC,CAAA;YACH,CAAC;iBAAM,CAAC;gBACP,uCAAuC;gBACvC,IAAI,CAAC,GAAG,CAAC,KAAK,CACb,yDAAyD,EACzD,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,EAAE,CAC/B,CAAA;YACF,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YACjD,MAAM,GAAG,CAAC,IAAI,CAAC;gBACd,YAAY,EAAG,CAAW,CAAC,QAAQ,EAAE;gBACrC,OAAO,EAAE,GAAG,CAAC,OAAO,GAAG,CAAC;aACxB,CAAC,CAAA;QACH,CAAC;gBAAS,CAAC;YACV,kDAAkD;YAClD,IAAI,CAAC,uBAAuB,EAAE,CAAA;QAC/B,CAAC;IACF,CAAC;CACD;AAhKD,4CAgKC"}

package/dist/c8/lib/CamundaRestClient.d.ts

@@ -0,0 +1,311 @@
+import { Camunda8ClientConfiguration, LosslessDto } from '../../lib';
+import { IOAuthProvider } from '../../oauth';
+import { ActivateJobsRequest, BroadcastSignalReq, CompleteJobRequest, ErrorJobWithVariables, FailJobRequest, IProcessVariables, JobCompletionInterfaceRest, JSONDoc, PublishMessageRequest, TopologyResponse } from '../../zeebe/types';
+import { BroadcastSignalResponse, CorrelateMessageResponse, CreateProcessInstanceReq, CreateProcessInstanceResponse, Ctor, DeployResourceResponse, JobUpdateChangeset, MigrationRequest, NewUserInfo, PatchAuthorizationRequest, PublishMessageResponse, RestJob, TaskChangeSet, UpdateElementVariableRequest } from './C8Dto';
+import { Logger } from './C8Logger';
+import { CamundaJobWorker, CamundaJobWorkerConfig } from './CamundaJobWorker';
+/**
+ * The client for the unified Camunda 8 REST API.
+ *
+ * Logging: to enable debug tracing during development, you can set `DEBUG=camunda:zeebe-rest`.
+ *
+ * For production, you can pass in an instance of [winston.Logger](https://github.com/winstonjs/winston) to the constructor as `logger`.
+ *
+ * `CAMUNDA_LOG_LEVEL` in the environment or the constructor options can be used to set the log level to one of 'error', 'warn', 'info', 'http', 'verbose', 'debug', or 'silly'.
+ *
+ * @since 8.6.0
+ * @experimental this API may be moved to an ESM package in a future release. Can you use ESM in your project? Comment [on this issue](https://github.com/camunda/camunda-8-js-sdk/issues/267).
+ */
+export declare class CamundaRestClient {
+    private userAgentString;
+    private oAuthProvider;
+    private rest;
+    private tenantId?;
+    log: Logger;
+    /**
+     * All constructor parameters for configuration are optional. If no configuration is provided, the SDK will use environment variables to configure itself.
+     */
+    constructor(options?: {
+        config?: Camunda8ClientConfiguration;
+        oAuthProvider?: IOAuthProvider;
+    });
+    private getHeaders;
+    /**
+     * Manage the permissions assigned to authorization.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/patch-authorization/
+     *
+     * @since 8.6.0
+     */
+    modifyAuthorization(req: PatchAuthorizationRequest): Promise<unknown>;
+    /**
+     * Broadcast a signal.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/broadcast-signal/
+     *
+     * @since 8.6.0
+     */
+    broadcastSignal(req: BroadcastSignalReq): Promise<BroadcastSignalResponse>;
+    getTopology(): Promise<TopologyResponse>;
+    /**
+     * Complete a user task with the given key. The method either completes the task or throws 400, 404, or 409.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/zeebe-api-rest/specifications/complete-a-user-task/
+     *
+     * @since 8.6.0
+     */
+    completeUserTask({ userTaskKey, variables, action, }: {
+        userTaskKey: string;
+        variables?: Record<string, unknown>;
+        action?: string;
+    }): Promise<unknown>;
+    /**
+     * Assign a user task with the given key to the given assignee.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/assign-user-task/
+     *
+     * @since 8.6.0
+     */
+    assignTask({ userTaskKey, assignee, allowOverride, action, }: {
+        /** The key of the user task to assign. */
+        userTaskKey: string;
+        /** The assignee for the user task. The assignee must not be empty or null. */
+        assignee: string;
+        /** By default, the task is reassigned if it was already assigned. Set this to false to return an error in such cases. The task must then first be unassigned to be assigned again. Use this when you have users picking from group task queues to prevent race conditions. */
+        allowOverride?: boolean;
+        /** A custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "assign". */
+        action: string;
+    }): Promise<unknown>;
+    /**
+     * Update a user task with the given key.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/update-user-task/
+     *
+     * @since 8.6.0
+     */
+    updateTask({ userTaskKey, changeset, }: {
+        userTaskKey: string;
+        changeset: TaskChangeSet;
+    }): Promise<unknown>;
+    /**
+     * Remove the assignee of a task with the given key.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/unassign-user-task/
+     *
+     * @since 8.6.0
+     */
+    unassignTask({ userTaskKey }: {
+        userTaskKey: string;
+    }): Promise<unknown>;
+    /**
+     * Create a user.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/create-user/
+     *
+     * @since 8.6.0
+     */
+    createUser(newUserInfo: NewUserInfo): Promise<unknown>;
+    /**
+     * Search for user tasks based on given criteria.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-alpha/
+     * @experimental
+     */
+    /**
+     * Publish a Message and correlates it to a subscription. If correlation is successful it will return the first process instance key the message correlated with.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/correlate-a-message/
+     *
+     * @since 8.6.0
+     */
+    correlateMessage(message: Pick<PublishMessageRequest, 'name' | 'correlationKey' | 'variables' | 'tenantId'>): Promise<CorrelateMessageResponse>;
+    /**
+     * Publish a single message. Messages are published to specific partitions computed from their correlation keys. This method does not wait for a correlation result. Use `correlateMessage` for such use cases.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/publish-a-message/
+     *
+     * @since 8.6.0
+     */
+    publishMessage(publishMessageRequest: PublishMessageRequest): Promise<PublishMessageResponse>;
+    /**
+     * Obtains the status of the current Camunda license.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/get-status-of-camunda-license/
+     *
+     * @since 8.6.0
+     */
+    getLicenseStatus(): Promise<{
+        vaildLicense: boolean;
+        licenseType: string;
+    }>;
+    /**
+     * Create a new polling Job Worker.
+     * You can pass in an optional winston.Logger instance as `logger`. This enables you to have distinct logging levels for different workers.
+     *
+     * @since 8.6.0
+     */
+    createJobWorker<Variables extends LosslessDto, CustomHeaders extends LosslessDto>(config: CamundaJobWorkerConfig<Variables, CustomHeaders>): CamundaJobWorker<Variables, CustomHeaders>;
+    /**
+     * Iterate through all known partitions and activate jobs up to the requested maximum.
+     *
+     * The parameter `inputVariablesDto` is a Dto to decode the job payload. The `customHeadersDto` parameter is a Dto to decode the custom headers.
+     * Pass in a Dto class that extends LosslessDto to provide both type information in your code,
+     * and safe interoperability with applications that use the `int64` type in variables.
+     *
+     * @since 8.6.0
+     */
+    activateJobs<VariablesDto extends LosslessDto, CustomHeadersDto extends LosslessDto>(request: ActivateJobsRequest & {
+        inputVariableDto?: Ctor<VariablesDto>;
+        customHeadersDto?: Ctor<CustomHeadersDto>;
+    }): Promise<(RestJob<VariablesDto, CustomHeadersDto> & JobCompletionInterfaceRest<IProcessVariables>)[]>;
+    /**
+     * Fails a job using the provided job key. This method sends a POST request to the endpoint '/jobs/{jobKey}/fail' with the failure reason and other details specified in the failJobRequest object.
+     *
+     * Documentation: https://docs.camunda.io/docs/next/apis-tools/camunda-api-rest/specifications/fail-job/
+     *
+     * @since 8.6.0
+     */
+    failJob(failJobRequest: FailJobRequest): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">;
+    /**
+     * Report a business error (i.e. non-technical) that occurs while processing a job.
+     *
+     * Documentation: https://docs.camunda.io/docs/next/apis-tools/camunda-api-rest/specifications/report-error-for-job/
+     *
+     * @since 8.6.0
+     */
+    errorJob(errorJobRequest: ErrorJobWithVariables & {
+        jobKey: string;
+    }): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">;
+    /**
+     * Complete a job with the given payload, which allows completing the associated service task.
+     *
+     * Documentation: https://docs.camunda.io/docs/next/apis-tools/camunda-api-rest/specifications/complete-job/
+     *
+     * @since 8.6.0
+     */
+    completeJob(completeJobRequest: CompleteJobRequest): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">;
+    /**
+     * Update a job with the given key.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/update-a-job/
+     *
+     * @since 8.6.0
+     */
+    updateJob(jobChangeset: JobUpdateChangeset & {
+        jobKey: string;
+    }): Promise<import("got").Response<string>>;
+    /**
+     * Marks the incident as resolved; most likely a call to Update job will be necessary to reset the job's retries, followed by this call.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/resolve-incident/
+     *
+     * @since 8.6.0
+     */
+    resolveIncident(incidentKey: string): Promise<import("got").Response<string>>;
+    /**
+     * Create and start a process instance. This method does not await the outcome of the process. For that, use `createProcessInstanceWithResult`.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/create-process-instance/
+     *
+     * @since 8.6.0
+     */
+    createProcessInstance<T extends JSONDoc | LosslessDto>(request: CreateProcessInstanceReq<T>): Promise<CreateProcessInstanceResponse<never>>;
+    /**
+     * Create and start a process instance. This method awaits the outcome of the process.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/create-process-instance/
+     *
+     * @since 8.6.0
+     */
+    createProcessInstanceWithResult<T extends JSONDoc | LosslessDto>(request: CreateProcessInstanceReq<T> & {
+        /** An array of variable names to fetch. If not supplied, all visible variables in the root scope will be returned  */
+        fetchVariables?: string[];
+    }): Promise<CreateProcessInstanceResponse<unknown>>;
+    createProcessInstanceWithResult<T extends JSONDoc | LosslessDto, V extends LosslessDto>(request: CreateProcessInstanceReq<T> & {
+        /** An array of variable names to fetch. If not supplied, all visible variables in the root scope will be returned  */
+        fetchVariables?: string[];
+        /** A Dto specifying the shape of the output variables. If not supplied, the output variables will be returned as a `LosslessDto` of type `unknown`. */
+        outputVariablesDto: Ctor<V>;
+    }): Promise<CreateProcessInstanceResponse<V>>;
+    /**
+     * Cancel an active process instance
+     */
+    cancelProcessInstance({ processInstanceKey, operationReference, }: {
+        processInstanceKey: string;
+        operationReference?: number;
+    }): Promise<import("got").Response<string>>;
+    /**
+     * Migrates a process instance to a new process definition.
+     * This request can contain multiple mapping instructions to define mapping between the active process instance's elements and target process definition elements.
+     * Use this to upgrade a process instance to a new version of a process or to a different process definition, e.g. to keep your running instances up-to-date with the latest process improvements.
+     *
+     * Documentation: https://docs.camunda.io/docs/next/apis-tools/camunda-api-rest/specifications/migrate-process-instance/
+     *
+     * @since 8.6.0
+     */
+    migrateProcessInstance(req: MigrationRequest): Promise<import("got").Response<string>>;
+    /**
+     * Deploy resources to the broker.
+     * @param resources - An array of binary data strings representing the resources to deploy.
+     * @param tenantId - Optional tenant ID to deploy the resources to. If not provided, the default tenant ID is used.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/deploy-resources/
+     *
+     * @since 8.6.0
+     */
+    deployResources(resources: {
+        content: string;
+        name: string;
+    }[], tenantId?: string): Promise<DeployResourceResponse>;
+    /**
+     * Deploy resources to Camunda 8 from files
+     * @param files an array of file paths
+     *
+     * @since 8.6.0
+     */
+    deployResourcesFromFiles(files: string[]): Promise<DeployResourceResponse>;
+    /**
+     * Deletes a deployed resource. This can be a process definition, decision requirements definition, or form definition deployed using the deploy resources endpoint. Specify the resource you want to delete in the resourceKey parameter.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/delete-resource/
+     *
+     * @since 8.6.0
+     */
+    deleteResource(req: {
+        resourceKey: string;
+        operationReference?: number;
+    }): Promise<import("got").Response<string>>;
+    /**
+     * Set a precise, static time for the Zeebe engine's internal clock.
+     * When the clock is pinned, it remains at the specified time and does not advance.
+     * To change the time, the clock must be pinned again with a new timestamp, or reset.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/pin-internal-clock/
+     *
+     * @since 8.6.0
+     */
+    pinInternalClock(epochMs: number): Promise<import("got").Response<string>>;
+    /**
+     * Resets the Zeebe engine's internal clock to the current system time, enabling it to tick in real-time.
+     * This operation is useful for returning the clock to normal behavior after it has been pinned to a specific time.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/reset-internal-clock/
+     *
+     * @since 8.6.0
+     */
+    resetClock(): Promise<import("got").Response<string>>;
+    /**
+     * Updates all the variables of a particular scope (for example, process instance, flow element instance) with the given variable data.
+     * Specify the element instance in the elementInstanceKey parameter.
+     *
+     * Documentation: https://docs.camunda.io/docs/apis-tools/camunda-api-rest/specifications/update-element-instance-variables/
+     *
+     * @since 8.6.0
+     */
+    updateElementInstanceVariables(req: UpdateElementVariableRequest): Promise<import("got").Response<string>>;
+    private addJobMethods;
+    /**
+     * Helper method to add the default tenantIds if we are not passed explicit tenantIds
+     */
+    private addDefaultTenantId;
+}