clever-queue 0.1.0

package/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+# You can override the included template(s) by including variable overrides
+# SAST customization: https://docs.gitlab.com/ee/user/application_security/sast/#customizing-the-sast-settings
+# Secret Detection customization: https://docs.gitlab.com/ee/user/application_security/secret_detection/pipeline/#customization
+# Dependency Scanning customization: https://docs.gitlab.com/ee/user/application_security/dependency_scanning/#customizing-the-dependency-scanning-settings
+# Container Scanning customization: https://docs.gitlab.com/ee/user/application_security/container_scanning/#customizing-the-container-scanning-settings
+# Note that environment variables can be set in several places
+# See https://docs.gitlab.com/ee/ci/variables/#cicd-variable-precedence
+stages:
+- test
+sast:
+  stage: test
+include:
+- template: Security/SAST.gitlab-ci.yml

package/.prettierrc.json

@@ -0,0 +1,4 @@
+{
+    "printWidth": 180,
+    "endOfLine": "auto"
+}

package/README.md

@@ -0,0 +1,15 @@
+# clever-queue
+
+
+
+## Purpose
+
+Queuing system for promises that handle concurring, throttling, weighting and prioritizing in a clever fashion.
+
+## Features - Tracking Work in Progree
+
+- [ ] Promises
+- [ ] Concurrency running
+- [ ] Priority & BestEffort queues
+- [ ] Throttling
+- [ ] Weighted Queue

package/dist/engine/index.d.ts

@@ -0,0 +1,21 @@
+import * as Queue from "../queue";
+import * as Runner from "../runner";
+import * as Task from "../task";
+type Status = "unknown" | "initialiazing" | "running" | "stopping" | "destroying";
+import { Options, Statistics } from "./interfaces";
+declare class Engine {
+    #private;
+    status: Status;
+    readonly runners: Runner.Runner[];
+    readonly queues: Queue.Queue[];
+    constructor(opt: Options);
+    start(): void;
+    stop(): void;
+    createQueue(options: Queue.Options): Queue.Queue;
+    createRunner(options: Runner.Options): Runner.Runner;
+    createTask(function_: Task.FunctionToExecute, options: Task.Options): Task.Task;
+    getNextTask(priorityGreaterOrEqualTo: number): Promise<Task.Task | undefined>;
+    statistics(): Statistics;
+}
+export { Options, Statistics, ErrorsList } from "./interfaces";
+export { Engine };

package/dist/engine/index.js

@@ -0,0 +1,187 @@
+"use strict";
+// clever-queue
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Engine = exports.ErrorsList = void 0;
+const _ = __importStar(require("../helpers"));
+const Queue = __importStar(require("../queue"));
+const Runner = __importStar(require("../runner"));
+const Task = __importStar(require("../task"));
+const TICK_START = 42;
+const interfaces_1 = require("./interfaces");
+const defaultOptions = {
+    bestEffortRunners: 1,
+    autostart: true,
+    logFunction: undefined,
+};
+class Engine {
+    status = "unknown";
+    runners = [];
+    queues = [];
+    constructor(opt) {
+        this.status = "initialiazing";
+        const options = { ...defaultOptions, ...opt };
+        this.#checkOptionsConsistancy(options);
+        // create runners
+        for (let index = 0; index < (options.bestEffortRunners ?? 0); index++)
+            this.createRunner({ priority: Runner.Priorities.BestEffort });
+        if (options.logFunction)
+            options.logFunction({ body: "engine has been initialized" });
+        if (options.autostart)
+            this.start();
+    }
+    start() {
+        this.status = "running";
+    }
+    stop() {
+        this.status = "stopping";
+        for (const queue of this.queues)
+            queue.stop();
+        for (const runner of this.runners)
+            runner.stop();
+    }
+    createQueue(options) {
+        const queue = new Queue.Queue({ logFunction: options.logFunction, ...options });
+        this.queues.push(queue);
+        this.#resetLastTick(options.priority);
+        return queue;
+    }
+    createRunner(options) {
+        const runner = new Runner.Runner({ logFunction: options.logFunction, ...options }, this);
+        this.runners.push(runner);
+        return runner;
+    }
+    createTask(function_, options) {
+        return new Task.Task(function_, { logFunction: options.logFunction, ...options });
+    }
+    #checkOptionsConsistancy(options) {
+        if (!options)
+            throw new _.Errors.CQError(interfaces_1.ErrorsList.NoOptionsOnEngineInitialization);
+        if (!options.bestEffortRunners || options.bestEffortRunners < 1)
+            throw new _.Errors.CQError(interfaces_1.ErrorsList.bestEffortRunnersOptionMustBeGreaterThanZero);
+    }
+    #getSumWeightFunction = (priority) => {
+        let result = 0;
+        for (const q of this.queues)
+            if (q.options.priority === priority)
+                result += q.options.weight;
+        return result;
+    };
+    #resetLastTick(priority) {
+        for (const q of this.queues)
+            if (q.options.priority === priority)
+                q.tick = TICK_START;
+    }
+    #getNextWeightedQueue(priority) {
+        let minTick = Infinity;
+        let result = undefined;
+        for (const q of this.queues)
+            if (q.options.priority === priority && q.tick <= minTick) {
+                minTick = q.tick;
+                result = q;
+            }
+        return result;
+    }
+    #howMuchTasksWaitingInQueues(priority) {
+        let result = 0;
+        for (const q of this.queues)
+            if (q.options.priority === priority)
+                result += q.tasks.length;
+        return result;
+    }
+    /*
+     async getNextTask(priorityGreaterOrEqualTo: number): Promise<Task.Task> {
+      for (let priority = Queue.Priorities.Absolute; priority <= priorityGreaterOrEqualTo; priority++) {
+        // Iterate on Each PriorityLevel From Absolute to param function
+        while (this.#howMuchTasksWaitingInQueues(priority) > 0) {
+          let task: Task.Task | undefined;
+          while (!task) {
+            const nextPriorityQueue = this.#getNextQueue(priority); // Find Next Priority Queue to process
+            if (nextPriorityQueue) {
+              nextPriorityQueue.tick += this.#getSumWeightFunction(priority) / nextPriorityQueue.options.weight; // Update tick with related weight
+              if (nextPriorityQueue.tasks.length > 0) {
+                task = nextPriorityQueue.tasks.shift(); // If queue is not empty, this is our next Task to process
+                if (task) task.runner();
+                console.log(nextPriorityQueue.options.name, nextPriorityQueue.tick);
+              }
+            }
+          }
+        }
+      }
+    }
+    */
+    async getNextTask(priorityGreaterOrEqualTo) {
+        let task = undefined;
+        // Iterate on Each PriorityLevel From Absolute to parameter
+        for (let priority = Queue.Priorities.Absolute; priority <= priorityGreaterOrEqualTo; priority++) {
+            // Check if there is task waiting of this priority level
+            while (this.#howMuchTasksWaitingInQueues(priority) > 0) {
+                // Find Next Weighted Queue of this priority level to check
+                const nextPriorityQueue = this.#getNextWeightedQueue(priority);
+                if (nextPriorityQueue) {
+                    // update Tick (next check) according to queue related weigth
+                    nextPriorityQueue.tick += this.#getSumWeightFunction(priority) / nextPriorityQueue.options.weight;
+                    // If queue is not empty, we've got our next Task to process
+                    if (nextPriorityQueue.tasks.length > 0) {
+                        // dequeue task from queue
+                        task = nextPriorityQueue.tasks.shift();
+                        if (task)
+                            return task;
+                    }
+                }
+            }
+        }
+        return undefined;
+    }
+    statistics() {
+        let taskCount = 0;
+        const runners = [];
+        const queues = [];
+        for (const runner of this.runners) {
+            if (runner.status == "running")
+                taskCount += 1;
+            runners.push(runner.statistics());
+        }
+        for (const queue of this.queues) {
+            taskCount += queue.tasks.length;
+            queues.push(queue.statistics());
+        }
+        const stat = {
+            engine: {
+                status: this.status,
+                runners: this.runners.length,
+                queues: this.queues.length,
+                tasks: taskCount,
+            },
+            runners,
+            queues,
+        };
+        return stat;
+    }
+}
+exports.Engine = Engine;
+var interfaces_2 = require("./interfaces");
+Object.defineProperty(exports, "ErrorsList", { enumerable: true, get: function () { return interfaces_2.ErrorsList; } });
+//# sourceMappingURL=index.js.map

package/dist/engine/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/engine/index.ts"],"names":[],"mappings":";AAAA,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;AAEf,8CAAgC;AAChC,gDAAkC;AAClC,kDAAoC;AACpC,8CAAgC;AAIhC,MAAM,UAAU,GAAG,EAAE,CAAC;AAEtB,6CAA+D;AAE/D,MAAM,cAAc,GAAY;IAC9B,iBAAiB,EAAE,CAAC;IACpB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,SAAS;CACvB,CAAC;AAEF,MAAM,MAAM;IACV,MAAM,GAAW,SAAS,CAAC;IAClB,OAAO,GAAoB,EAAE,CAAC;IAC9B,MAAM,GAAkB,EAAE,CAAC;IAEpC,YAAY,GAAY;QACtB,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC;QAC9B,MAAM,OAAO,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,GAAG,EAAE,CAAC;QAC9C,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;QAEvC,iBAAiB;QACjB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,OAAO,CAAC,iBAAiB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE;YAAE,IAAI,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;QACrI,IAAI,OAAO,CAAC,WAAW;YAAE,OAAO,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,6BAA6B,EAAE,CAAC,CAAC;QACtF,IAAI,OAAO,CAAC,SAAS;YAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;IAED,KAAK;QACH,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED,IAAI;QACF,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM;YAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QAC9C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO;YAAE,MAAM,CAAC,IAAI,EAAE,CAAC;IACnD,CAAC;IAED,WAAW,CAAC,OAAsB;QAChC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,YAAY,CAAC,OAAuB;QAClC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC;QACzF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,UAAU,CAAC,SAAiC,EAAE,OAAqB;QACjE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,wBAAwB,CAAC,OAAgB;QACvC,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAU,CAAC,+BAA+B,CAAC,CAAC;QACrF,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,GAAG,CAAC;YAAE,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAU,CAAC,4CAA4C,CAAC,CAAC;IACvJ,CAAC;IAED,qBAAqB,GAA+B,CAAC,QAAgB,EAAU,EAAE;QAC/E,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ;gBAAE,MAAM,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QAC7F,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,cAAc,CAAC,QAAgB;QAC7B,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ;gBAAE,CAAC,CAAC,IAAI,GAAG,UAAU,CAAC;IACxF,CAAC;IAED,qBAAqB,CAAC,QAAgB;QACpC,IAAI,OAAO,GAAG,QAAQ,CAAC;QACvB,IAAI,MAAM,GAA4B,SAAS,CAAC;QAChD,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM;YACzB,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;gBACzD,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC;gBACjB,MAAM,GAAG,CAAC,CAAC;YACb,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,4BAA4B,CAAC,QAAgB;QAC3C,IAAI,MAAM,GAAW,CAAC,CAAC;QACvB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ;gBAAE,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;QAC3F,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;;;;;;;;;;;;;;;;;MAoBE;IAEF,KAAK,CAAC,WAAW,CAAC,wBAAgC;QAChD,IAAI,IAAI,GAA0B,SAAS,CAAC;QAC5C,2DAA2D;QAC3D,KAAK,IAAI,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAQ,IAAI,wBAAwB,EAAE,QAAQ,EAAE,EAAE,CAAC;YAChG,wDAAwD;YACxD,OAAO,IAAI,CAAC,4BAA4B,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvD,2DAA2D;gBAC3D,MAAM,iBAAiB,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;gBAC/D,IAAI,iBAAiB,EAAE,CAAC;oBACtB,6DAA6D;oBAC7D,iBAAiB,CAAC,IAAI,IAAI,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,MAAM,CAAC;oBAClG,4DAA4D;oBAC5D,IAAI,iBAAiB,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACvC,0BAA0B;wBAC1B,IAAI,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;wBACvC,IAAI,IAAI;4BAAE,OAAO,IAAI,CAAC;oBACxB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,UAAU;QACR,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,MAAM,OAAO,GAAwB,EAAE,CAAC;QACxC,MAAM,MAAM,GAAuB,EAAE,CAAC;QACtC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,IAAI,MAAM,CAAC,MAAM,IAAI,SAAS;gBAAE,SAAS,IAAI,CAAC,CAAC;YAC/C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QACpC,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;QAClC,CAAC;QACD,MAAM,IAAI,GAAe;YACvB,MAAM,EAAE;gBACN,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;gBAC5B,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;gBAC1B,KAAK,EAAE,SAAS;aACjB;YACD,OAAO;YACP,MAAM;SACP,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAGQ,wBAAM;AADf,2CAA+D;AAAjC,wGAAA,UAAU,OAAA"}

package/dist/engine/interfaces.d.ts

@@ -0,0 +1,28 @@
+import * as _ from "../helpers";
+import * as Runner from "../runner/interfaces";
+import * as Queue from "../runner/interfaces";
+interface Options {
+    autostart?: boolean;
+    bestEffortRunners?: number;
+    logFunction?: _.Logs.LogFunction;
+}
+interface Statistics {
+    engine: {
+        status: string;
+        runners: number;
+        queues: number;
+        tasks: number;
+    };
+    runners: Runner.Statistics[];
+    queues: Queue.Statistics[];
+}
+type ErrorListKeys = "NoOptionsOnEngineInitialization" | "bestEffortRunnersOptionMustBeGreaterThanZero";
+declare const ErrorsList: {
+    [index in ErrorListKeys]: {
+        name: string;
+        message: string;
+    };
+};
+export { LogFunction } from "../helpers/logs";
+export { TraceFunction } from "../helpers/traces";
+export { Options, Statistics, ErrorsList };

package/dist/engine/interfaces.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorsList = void 0;
+const ErrorsList = {
+    NoOptionsOnEngineInitialization: { name: "NoOptionsOnEngineInitialization", message: "You must provide an options parameter to Engine" },
+    bestEffortRunnersOptionMustBeGreaterThanZero: { name: "bestEffortRunnersOptionMustBeGreaterThanZero", message: "bestEffortRunners Option must be equal or superior to 1" },
+};
+exports.ErrorsList = ErrorsList;
+//# sourceMappingURL=interfaces.js.map

package/dist/engine/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/engine/interfaces.ts"],"names":[],"mappings":";;;AAuBA,MAAM,UAAU,GAEZ;IACF,+BAA+B,EAAE,EAAE,IAAI,EAAE,iCAAiC,EAAE,OAAO,EAAE,iDAAiD,EAAE;IACxI,4CAA4C,EAAE,EAAE,IAAI,EAAE,8CAA8C,EAAE,OAAO,EAAE,yDAAyD,EAAE;CAC3K,CAAC;AAI4B,gCAAU"}

package/dist/errors.d.ts

@@ -0,0 +1,13 @@
+declare const CQErrors: {
+    [index: string]: {
+        name: string;
+        message: string;
+    };
+};
+declare class CQError extends Error {
+    constructor(error: {
+        name: string;
+        message: string;
+    }, context?: object);
+}
+export { CQError, CQErrors };

package/dist/errors.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CQErrors = exports.CQError = void 0;
+const CQErrors = {
+    NoOptionsOnEngineInitialization: { name: "NoOptionsOnEngineInitialization", message: "You must provide an options parameter to Engine" },
+    defaultRunnersOptionMustBeGreaterThanZero: { name: "concurrentRunnersOptionMustBeGreaterThanZero", message: "concurrentRunners Option must be equal or superior to 1" },
+    priorityRunnersOptionMustBeZeroOrGreaterThanZero: {
+        name: "dedicatedPriorityRunnersOptionMustBeZeroOrGreaterThanZero",
+        message: "dedicatedPriorityRunners Option must be equal or superior to 0",
+    },
+    priorityRunnersOptionMustBeLessThanconcurrentRunners: {
+        name: "dedicatedPriorityRunnersOptionMustBeLessThanconcurrentRunners",
+        message: "dedicatedPriorityRunners Option must be less than concurrentRunners option",
+    },
+    BadPriorityOptionsOnQueueInitialization: {
+        name: "BadPriorityOptionsOnQueueInitialization",
+        message: "You must provide a 'priority' parameter for Queue initialization from 0 (absolute priority) to 255 (best effort priority), you may use CleverQueue.Priorities constants",
+    },
+    NoWeightOptionsOnQueueInitialization: {
+        name: "NoWeightOptionsOnQueueInitialization",
+        message: "You must provide a 'weight' parameter for Queue initialization",
+    },
+    NoOptionsOnQueueInitialization: { name: "NoOptionsOnQueueInitialization", message: "You must provide an options parameter to Queue" },
+};
+exports.CQErrors = CQErrors;
+class CQError extends Error {
+    constructor(error, context) {
+        if (!error) {
+            error = {
+                name: "undocumentedError",
+                message: "Undocumented Error, please raise an issue to developpers",
+            };
+        }
+        super(error.message);
+        this.name = error.name;
+        this.message = error.message;
+        if (context)
+            this.cause = JSON.stringify(context);
+    }
+}
+exports.CQError = CQError;
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA,MAAM,QAAQ,GAA2D;IACvE,+BAA+B,EAAE,EAAE,IAAI,EAAE,iCAAiC,EAAE,OAAO,EAAE,iDAAiD,EAAE;IACxI,yCAAyC,EAAE,EAAE,IAAI,EAAE,8CAA8C,EAAE,OAAO,EAAE,yDAAyD,EAAE;IACvK,gDAAgD,EAAE;QAChD,IAAI,EAAE,2DAA2D;QACjE,OAAO,EAAE,gEAAgE;KAC1E;IACD,oDAAoD,EAAE;QACpD,IAAI,EAAE,+DAA+D;QACrE,OAAO,EAAE,4EAA4E;KACtF;IAED,uCAAuC,EAAE;QACvC,IAAI,EAAE,yCAAyC;QAC/C,OAAO,EACL,yKAAyK;KAC5K;IACD,oCAAoC,EAAE;QACpC,IAAI,EAAE,sCAAsC;QAC5C,OAAO,EAAE,gEAAgE;KAC1E;IAED,8BAA8B,EAAE,EAAE,IAAI,EAAE,gCAAgC,EAAE,OAAO,EAAE,gDAAgD,EAAE;CACtI,CAAC;AAiBgB,4BAAQ;AAf1B,MAAM,OAAQ,SAAQ,KAAK;IACzB,YAAY,KAAwC,EAAE,OAAgB;QACpE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG;gBACN,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,0DAA0D;aACpE,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,OAAO;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;CACF;AAEQ,0BAAO"}

package/dist/helpers/errors.d.ts

@@ -0,0 +1,7 @@
+declare class CQError extends Error {
+    constructor(error: {
+        name: string;
+        message: string;
+    }, context?: object);
+}
+export { CQError };

package/dist/helpers/errors.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CQError = void 0;
+class CQError extends Error {
+    constructor(error, context) {
+        if (!error) {
+            error = {
+                name: "undocumentedError",
+                message: "Undocumented Error, please raise an issue to developpers",
+            };
+        }
+        super(error.message);
+        this.name = error.name;
+        this.message = error.message;
+        if (context)
+            this.cause = JSON.stringify(context);
+    }
+}
+exports.CQError = CQError;
+//# sourceMappingURL=errors.js.map

package/dist/helpers/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/helpers/errors.ts"],"names":[],"mappings":";;;AAAA,MAAM,OAAQ,SAAQ,KAAK;IACzB,YAAY,KAAwC,EAAE,OAAgB;QACpE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG;gBACN,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,0DAA0D;aACpE,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,OAAO;YAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;CACF;AAEQ,0BAAO"}

package/dist/helpers/index.d.ts

@@ -0,0 +1,3 @@
+export * as Errors from "./errors";
+export * as Logs from "./logs";
+export * as Traces from "./traces";

package/dist/helpers/index.js

@@ -0,0 +1,30 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Traces = exports.Logs = exports.Errors = void 0;
+exports.Errors = __importStar(require("./errors"));
+exports.Logs = __importStar(require("./logs"));
+exports.Traces = __importStar(require("./traces"));
+//# sourceMappingURL=index.js.map

package/dist/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAmC;AACnC,+CAA+B;AAC/B,mDAAmC"}

package/dist/helpers/logs.d.ts

@@ -0,0 +1,75 @@
+export declare type HrTime = [number, number];
+export declare type TimeInput = HrTime | number | Date;
+export type AnyValueScalar = string | number | boolean;
+export type AnyValueArray = Array<AnyValue>;
+/**
+ * AnyValueMap is a map from string to AnyValue (attribute value or a nested map)
+ */
+export interface AnyValueMap {
+    [attributeKey: string]: AnyValue;
+}
+/**
+ * AnyValue can be one of the following:
+ * - a scalar value
+ * - a byte array
+ * - array of any value
+ * - map from string to any value
+ * - empty value
+ */
+export type AnyValue = AnyValueScalar | Uint8Array | AnyValueArray | AnyValueMap | null | undefined;
+export type LogBody = AnyValue;
+export type LogAttributes = AnyValueMap;
+export declare enum SeverityNumber {
+    UNSPECIFIED = 0,
+    TRACE = 1,
+    TRACE2 = 2,
+    TRACE3 = 3,
+    TRACE4 = 4,
+    DEBUG = 5,
+    DEBUG2 = 6,
+    DEBUG3 = 7,
+    DEBUG4 = 8,
+    INFO = 9,
+    INFO2 = 10,
+    INFO3 = 11,
+    INFO4 = 12,
+    WARN = 13,
+    WARN2 = 14,
+    WARN3 = 15,
+    WARN4 = 16,
+    ERROR = 17,
+    ERROR2 = 18,
+    ERROR3 = 19,
+    ERROR4 = 20,
+    FATAL = 21,
+    FATAL2 = 22,
+    FATAL3 = 23,
+    FATAL4 = 24
+}
+export interface LogRecord {
+    /**
+     * The time when the log record occurred as UNIX Epoch time in nanoseconds.
+     */
+    timestamp?: TimeInput;
+    /**
+     * Time when the event was observed by the collection system.
+     */
+    observedTimestamp?: TimeInput;
+    /**
+     * Numerical value of the severity.
+     */
+    severityNumber?: SeverityNumber;
+    /**
+     * The severity text.
+     */
+    severityText?: string;
+    /**
+     * A value containing the body of the log record.
+     */
+    body?: LogBody;
+    /**
+     * Attributes that define the log record.
+     */
+    attributes?: LogAttributes;
+}
+export type LogFunction = (logRecord: LogRecord) => void;

package/dist/helpers/logs.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeverityNumber = void 0;
+var SeverityNumber;
+(function (SeverityNumber) {
+    SeverityNumber[SeverityNumber["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+    SeverityNumber[SeverityNumber["TRACE"] = 1] = "TRACE";
+    SeverityNumber[SeverityNumber["TRACE2"] = 2] = "TRACE2";
+    SeverityNumber[SeverityNumber["TRACE3"] = 3] = "TRACE3";
+    SeverityNumber[SeverityNumber["TRACE4"] = 4] = "TRACE4";
+    SeverityNumber[SeverityNumber["DEBUG"] = 5] = "DEBUG";
+    SeverityNumber[SeverityNumber["DEBUG2"] = 6] = "DEBUG2";
+    SeverityNumber[SeverityNumber["DEBUG3"] = 7] = "DEBUG3";
+    SeverityNumber[SeverityNumber["DEBUG4"] = 8] = "DEBUG4";
+    SeverityNumber[SeverityNumber["INFO"] = 9] = "INFO";
+    SeverityNumber[SeverityNumber["INFO2"] = 10] = "INFO2";
+    SeverityNumber[SeverityNumber["INFO3"] = 11] = "INFO3";
+    SeverityNumber[SeverityNumber["INFO4"] = 12] = "INFO4";
+    SeverityNumber[SeverityNumber["WARN"] = 13] = "WARN";
+    SeverityNumber[SeverityNumber["WARN2"] = 14] = "WARN2";
+    SeverityNumber[SeverityNumber["WARN3"] = 15] = "WARN3";
+    SeverityNumber[SeverityNumber["WARN4"] = 16] = "WARN4";
+    SeverityNumber[SeverityNumber["ERROR"] = 17] = "ERROR";
+    SeverityNumber[SeverityNumber["ERROR2"] = 18] = "ERROR2";
+    SeverityNumber[SeverityNumber["ERROR3"] = 19] = "ERROR3";
+    SeverityNumber[SeverityNumber["ERROR4"] = 20] = "ERROR4";
+    SeverityNumber[SeverityNumber["FATAL"] = 21] = "FATAL";
+    SeverityNumber[SeverityNumber["FATAL2"] = 22] = "FATAL2";
+    SeverityNumber[SeverityNumber["FATAL3"] = 23] = "FATAL3";
+    SeverityNumber[SeverityNumber["FATAL4"] = 24] = "FATAL4";
+})(SeverityNumber || (exports.SeverityNumber = SeverityNumber = {}));
+//# sourceMappingURL=logs.js.map

package/dist/helpers/logs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs.js","sourceRoot":"","sources":["../../src/helpers/logs.ts"],"names":[],"mappings":";;;AAyBA,IAAY,cA0BX;AA1BD,WAAY,cAAc;IACxB,iEAAe,CAAA;IACf,qDAAS,CAAA;IACT,uDAAU,CAAA;IACV,uDAAU,CAAA;IACV,uDAAU,CAAA;IACV,qDAAS,CAAA;IACT,uDAAU,CAAA;IACV,uDAAU,CAAA;IACV,uDAAU,CAAA;IACV,mDAAQ,CAAA;IACR,sDAAU,CAAA;IACV,sDAAU,CAAA;IACV,sDAAU,CAAA;IACV,oDAAS,CAAA;IACT,sDAAU,CAAA;IACV,sDAAU,CAAA;IACV,sDAAU,CAAA;IACV,sDAAU,CAAA;IACV,wDAAW,CAAA;IACX,wDAAW,CAAA;IACX,wDAAW,CAAA;IACX,sDAAU,CAAA;IACV,wDAAW,CAAA;IACX,wDAAW,CAAA;IACX,wDAAW,CAAA;AACb,CAAC,EA1BW,cAAc,8BAAd,cAAc,QA0BzB"}

package/dist/helpers/traces.d.ts

@@ -0,0 +1 @@
+export type TraceFunction = () => void;

package/dist/helpers/traces.js

@@ -0,0 +1,24 @@
+"use strict";
+/*
+interface EventRecord {
+  // https://opentelemetry.io/docs/specs/otel/logs/data-model/
+  timestamp?: number; // Time when the event occurred.
+  observedTimestamp: number; // Time when the event was observed.
+  traceId?: string; // Request trace id.
+  spanId?: string; // Request span id.
+  traceFlags?: number; // W3C trace flag.
+  SeverityText; // The severity text (also known as log level).
+  SeverityNumber; // Numerical value of the severity.
+  Body; // The body of the log record.
+  Resource; // Describes the source of the log.
+  InstrumentationScope; // Describes the scope that emitted the log.
+  Attributes; // Additional information about the event.
+}
+
+declare type AttributeValue = string | number | boolean | Array<null | undefined | string> | Array<null | undefined | number> | Array<null | undefined | boolean>;
+interface Attributes {
+  [attributeKey: string]: AttributeValue | undefined;
+}
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=traces.js.map

package/dist/helpers/traces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traces.js","sourceRoot":"","sources":["../../src/helpers/traces.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;EAoBE"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import * as Engine from "./engine";
+declare function createEngine(options: Engine.Options): Engine.Engine;
+export * as Engine from "./engine/interfaces";
+export * as Runner from "./runner/interfaces";
+export * as Queue from "./queue/interfaces";
+export * as Task from "./task/interfaces";
+export { createEngine };

package/dist/index.js

@@ -0,0 +1,37 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Task = exports.Queue = exports.Runner = exports.Engine = void 0;
+exports.createEngine = createEngine;
+// clever-queue
+const Engine = __importStar(require("./engine"));
+function createEngine(options) {
+    return new Engine.Engine(options);
+}
+exports.Engine = __importStar(require("./engine/interfaces"));
+exports.Runner = __importStar(require("./runner/interfaces"));
+exports.Queue = __importStar(require("./queue/interfaces"));
+exports.Task = __importStar(require("./task/interfaces"));
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAYS,oCAAY;AAZrB,eAAe;AACf,iDAAmC;AAEnC,SAAS,YAAY,CAAC,OAAuB;IAC3C,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACpC,CAAC;AAED,8DAA8C;AAC9C,8DAA8C;AAC9C,4DAA4C;AAC5C,0DAA0C"}

package/dist/queue/index.d.ts

@@ -0,0 +1,19 @@
+import * as Task from "../task";
+import { Options, Statistics } from "./interfaces";
+type GetSumWeightFunction = (priority: number) => number;
+type Status = "unknown" | "initialiazing" | "running" | "stopping" | "destroying";
+declare class Queue {
+    #private;
+    status: Status;
+    readonly options: Options;
+    tick: number;
+    tasks: Task.Task[];
+    constructor(opt: Options);
+    start(): void;
+    stop(): void;
+    createTaskAndEnqueue(function_: Task.FunctionToExecute, options: Task.Options): Promise<unknown>;
+    enqueue(task: Task.Task): Promise<unknown>;
+    statistics(): Statistics;
+}
+export { Options, Statistics, ErrorsList, Priorities } from "./interfaces";
+export { Queue, GetSumWeightFunction };