@memberjunction/queue 0.9.1

package/dist/drivers/AIActionQueue.d.ts

@@ -0,0 +1,8 @@
+import { QueueBase, TaskBase, TaskResult } from "../generic/QueueBase";
+export declare class AIActionQueue extends QueueBase {
+    protected ProcessTask(task: TaskBase): Promise<TaskResult>;
+    protected ProcessGeneric(task: TaskBase, entityAIAction: boolean): Promise<TaskResult>;
+}
+export declare class EntityAIActionQueue extends AIActionQueue {
+    protected ProcessTask(task: TaskBase): Promise<TaskResult>;
+}

package/dist/drivers/AIActionQueue.js

@@ -0,0 +1,56 @@
+"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.EntityAIActionQueue = exports.AIActionQueue = void 0;
+const QueueBase_1 = require("../generic/QueueBase");
+const global_1 = require("@memberjunction/global");
+const ai_1 = require("@memberjunction/ai");
+let AIActionQueue = class AIActionQueue extends QueueBase_1.QueueBase {
+    async ProcessTask(task) {
+        return this.ProcessGeneric(task, false);
+    }
+    async ProcessGeneric(task, entityAIAction) {
+        try {
+            await ai_1.AIEngine.LoadAIMetadata(this._contextUser);
+            const ai = new ai_1.AIEngine();
+            let result = null;
+            if (entityAIAction)
+                result = await ai.ExecuteEntityAIAction(task.Data);
+            else
+                result = await ai.ExecuteAIAction(task.Data);
+            return {
+                success: result ? result.success : false,
+                output: result ? (result.success ? null : result.errorMessage) : null,
+                userMessage: result ? result.errorMessage : null,
+                exception: null
+            };
+        }
+        catch (e) {
+            return {
+                success: false,
+                output: null,
+                userMessage: 'Execution Error: ' + e.message,
+                exception: e
+            };
+        }
+    }
+};
+AIActionQueue = __decorate([
+    (0, global_1.RegisterClass)(QueueBase_1.QueueBase, 'AI Action', 1)
+], AIActionQueue);
+exports.AIActionQueue = AIActionQueue;
+let EntityAIActionQueue = class EntityAIActionQueue extends AIActionQueue {
+    async ProcessTask(task) {
+        return this.ProcessGeneric(task, true);
+    }
+};
+EntityAIActionQueue = __decorate([
+    (0, global_1.RegisterClass)(QueueBase_1.QueueBase, 'Entity AI Action', 1)
+], EntityAIActionQueue);
+exports.EntityAIActionQueue = EntityAIActionQueue;
+//# sourceMappingURL=AIActionQueue.js.map

package/dist/drivers/AIActionQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AIActionQueue.js","sourceRoot":"","sources":["../../src/drivers/AIActionQueue.ts"],"names":[],"mappings":";;;;;;;;;AAAA,oDAAuE;AACvE,mDAAsD;AACtD,2CAA8C;AAG9C,IAAa,aAAa,GAA1B,MAAa,aAAc,SAAQ,qBAAS;IAC9B,KAAK,CAAC,WAAW,CAAC,IAAc;QACtC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IAC3C,CAAC;IAES,KAAK,CAAC,cAAc,CAAC,IAAc,EAAE,cAAuB;QAClE,IAAI;YACA,MAAM,aAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjD,MAAM,EAAE,GAAG,IAAI,aAAQ,EAAE,CAAC;YAC1B,IAAI,MAAM,GAAQ,IAAI,CAAC;YAEvB,IAAI,cAAc;gBACd,MAAM,GAAG,MAAM,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;gBAEnD,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEjD,OAAO;gBACH,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;gBACxC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI;gBACrE,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI;gBAChD,SAAS,EAAE,IAAI;aAClB,CAAA;SACJ;QACD,OAAO,CAAC,EAAE;YACN,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,IAAI;gBACZ,WAAW,EAAE,mBAAmB,GAAG,CAAC,CAAC,OAAO;gBAC5C,SAAS,EAAE,CAAC;aACf,CAAA;SACJ;IACL,CAAC;CACJ,CAAA;AAhCY,aAAa;IADzB,IAAA,sBAAa,EAAC,qBAAS,EAAE,WAAW,EAAE,CAAC,CAAC;GAC5B,aAAa,CAgCzB;AAhCY,sCAAa;AAmC1B,IAAa,mBAAmB,GAAhC,MAAa,mBAAoB,SAAQ,aAAa;IACxC,KAAK,CAAC,WAAW,CAAC,IAAc;QACtC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC1C,CAAC;CACJ,CAAA;AAJY,mBAAmB;IAD/B,IAAA,sBAAa,EAAC,qBAAS,EAAE,kBAAkB,EAAE,CAAC,CAAC;GACnC,mBAAmB,CAI/B;AAJY,kDAAmB"}

package/dist/generic/QueueBase.d.ts

@@ -0,0 +1,47 @@
+import { UserInfo, BaseEntity } from '@memberjunction/core';
+export declare class TaskResult {
+    success: boolean;
+    userMessage: string;
+    output: any;
+    exception: any;
+}
+export interface TaskOptions {
+    priority?: number;
+}
+export declare enum TaskStatus {
+    Pending = 1,
+    InProgress = 2,
+    Complete = 3,
+    Failed = 4,
+    Cancelled = 5
+}
+export declare class TaskBase {
+    private _options;
+    private _data;
+    private _taskRecord;
+    private _status;
+    get Options(): TaskOptions;
+    get Data(): any;
+    get ID(): number;
+    constructor(taskRecord: BaseEntity, data: any, options: TaskOptions);
+    get TaskRecord(): BaseEntity;
+    get Status(): TaskStatus;
+    set Status(value: TaskStatus);
+}
+export declare abstract class QueueBase {
+    private _queue;
+    private _queueTypeId;
+    protected _contextUser: UserInfo;
+    private _maxTasks;
+    private _checkInterval;
+    private _queueRecord;
+    constructor(QueueRecord: BaseEntity, QueueTypeID: number, ContextUser: UserInfo);
+    get QueueID(): number;
+    get QueueTypeID(): number;
+    private _processing;
+    protected ProcessTasks(): void;
+    AddTask(task: TaskBase): boolean;
+    protected abstract ProcessTask(task: TaskBase, contextUser: UserInfo): Promise<TaskResult>;
+    protected StartTask(task: TaskBase, contextUser: UserInfo): Promise<TaskResult>;
+    FindTask(ID: number): TaskBase;
+}

package/dist/generic/QueueBase.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueBase = exports.TaskBase = exports.TaskStatus = exports.TaskResult = void 0;
+//import { QueueTaskEntity, QueueEntity } from 'mj_generatedentities';
+class TaskResult {
+}
+exports.TaskResult = TaskResult;
+var TaskStatus;
+(function (TaskStatus) {
+    TaskStatus[TaskStatus["Pending"] = 1] = "Pending";
+    TaskStatus[TaskStatus["InProgress"] = 2] = "InProgress";
+    TaskStatus[TaskStatus["Complete"] = 3] = "Complete";
+    TaskStatus[TaskStatus["Failed"] = 4] = "Failed";
+    TaskStatus[TaskStatus["Cancelled"] = 5] = "Cancelled";
+})(TaskStatus = exports.TaskStatus || (exports.TaskStatus = {}));
+class TaskBase {
+    get Options() {
+        return this._options;
+    }
+    get Data() {
+        return this._data;
+    }
+    get ID() {
+        return this._taskRecord.ID;
+    }
+    constructor(taskRecord, data, options) {
+        this._status = TaskStatus.Pending;
+        this._taskRecord = taskRecord;
+        this._options = options;
+        this._data = data;
+    }
+    get TaskRecord() {
+        return this._taskRecord;
+    }
+    get Status() {
+        return this._status;
+    }
+    set Status(value) {
+        this._status = value;
+    }
+}
+exports.TaskBase = TaskBase;
+class QueueBase {
+    constructor(QueueRecord, QueueTypeID, ContextUser) {
+        this._queue = [];
+        this._maxTasks = 3; // move to metadata or config param
+        this._checkInterval = 250; // move to metadata or config param
+        this._processing = false;
+        this._queueRecord = QueueRecord;
+        this._queueTypeId = QueueTypeID;
+        this._contextUser = ContextUser;
+    }
+    get QueueID() {
+        return this._queueRecord.ID;
+    }
+    get QueueTypeID() {
+        return this._queueTypeId;
+    }
+    ProcessTasks() {
+        if (!this._processing) {
+            try {
+                this._processing = true;
+                // this method will be called upon instantiation of the queue and will check for pending tasks
+                // it will re-run itself with a timer to check for new tasks
+                // this will be the main loop for the queue
+                if (this._queue.length > 0) {
+                    let processing = this._queue.filter(t => t.Status === TaskStatus.InProgress);
+                    let pending = this._queue.filter(t => t.Status === TaskStatus.Pending);
+                    // we have room to process one or more additional tasks now
+                    while (processing.length < this._maxTasks && pending.length > 0) {
+                        let task = pending.shift();
+                        this.StartTask(task, this._contextUser); // INTENTIONAL - do not await as we want to fire off all the tasks we can do, and then move on
+                    }
+                }
+            }
+            catch (e) {
+                console.log(e);
+            }
+            finally {
+                this._processing = false;
+                setTimeout(() => {
+                    this.ProcessTasks();
+                }, this._checkInterval); // setup the next check
+            }
+        }
+    }
+    AddTask(task) {
+        try {
+            // Add a task to the queue
+            this._queue.push(task);
+            // fire off the process tasks function immediately but don't wait for it to finish
+            this.ProcessTasks();
+            return true;
+        }
+        catch (e) {
+            return false;
+        }
+    }
+    async StartTask(task, contextUser) {
+        // the process function is responsible for calling the processor function
+        try {
+            task.Status = TaskStatus.InProgress; // immediately flag this task so it isn't picked up again...
+            // run the task
+            let result = await this.ProcessTask(task, contextUser);
+            // now set the record data for the DB
+            task.TaskRecord.Status = result.success ? "Complete" : "Failed";
+            task.TaskRecord.Output = result.output;
+            task.TaskRecord.ErrorMessage = result.exception ? JSON.stringify(result.exception) : null;
+            await task.TaskRecord.Save();
+            // update the task status
+            task.Status = result.success ? TaskStatus.Complete : TaskStatus.Failed;
+            return result;
+        }
+        catch (e) {
+            console.log(e);
+            return {
+                success: false,
+                output: null,
+                userMessage: 'Execution Error: ' + e.message,
+                exception: e
+            };
+        }
+    }
+    FindTask(ID) {
+        return this._queue.find(t => t.ID === ID);
+    }
+}
+exports.QueueBase = QueueBase;
+//# sourceMappingURL=QueueBase.js.map

package/dist/generic/QueueBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueueBase.js","sourceRoot":"","sources":["../../src/generic/QueueBase.ts"],"names":[],"mappings":";;;AACA,sEAAsE;AAEtE,MAAa,UAAU;CAKtB;AALD,gCAKC;AAOD,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,iDAAW,CAAA;IACX,uDAAc,CAAA;IACd,mDAAY,CAAA;IACZ,+CAAU,CAAA;IACV,qDAAa,CAAA;AACf,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAED,MAAa,QAAQ;IAMnB,IAAW,OAAO;QAEhB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IACD,IAAW,IAAI;QAEb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IACD,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;IAC7B,CAAC;IACD,YAAa,UAAsB,EAAE,IAAS,EAAE,OAAoB;QAb5D,YAAO,GAAe,UAAU,CAAC,OAAO,CAAC;QAc/C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IACD,IAAW,MAAM,CAAC,KAAiB;QACjC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;CAEF;AAlCD,4BAkCC;AAGD,MAAsB,SAAS;IAQ7B,YAAY,WAAuB,EAAE,WAAmB,EAAE,WAAqB;QAPvE,WAAM,GAAe,EAAE,CAAC;QAGxB,cAAS,GAAW,CAAC,CAAC,CAAC,mCAAmC;QAC1D,mBAAc,GAAW,GAAG,CAAC,CAAC,mCAAmC;QAiBjE,gBAAW,GAAY,KAAK,CAAC;QAbnC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;IAC9B,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAGS,YAAY;QACpB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,IAAI;gBACF,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;gBACxB,8FAA8F;gBAC9F,4DAA4D;gBAC5D,2CAA2C;gBAC3C,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC1B,IAAI,UAAU,GAAe,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC,UAAU,CAAC,CAAC;oBACzF,IAAI,OAAO,GAAe,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;oBAEnF,2DAA2D;oBAC3D,OAAO,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;wBAC/D,IAAI,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;wBAC3B,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,8FAA8F;qBACxI;iBACF;aACF;YACD,OAAO,CAAC,EAAE;gBACR,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aAChB;oBACO;gBACN,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;gBACzB,UAAU,CAAC,GAAG,EAAE;oBACd,IAAI,CAAC,YAAY,EAAE,CAAA;gBACrB,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,uBAAuB;aACjD;SACF;IACH,CAAC;IAED,OAAO,CAAC,IAAc;QACpB,IAAI;YACF,0BAA0B;YAC1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAEtB,kFAAkF;YAClF,IAAI,CAAC,YAAY,EAAE,CAAC;YAEpB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,CAAC,EAAE;YACR,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAIS,KAAK,CAAC,SAAS,CAAC,IAAc,EAAE,WAAqB;QAC7D,yEAAyE;QACzE,IAAI;YACF,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,4DAA4D;YAEjG,eAAe;YACf,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YAEvD,qCAAqC;YACrC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;YAChE,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;YACvC,IAAI,CAAC,UAAU,CAAC,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC1F,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YAE7B,yBAAyB;YACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;YAEvE,OAAO,MAAM,CAAC;SACf;QACD,OAAO,CAAC,EAAE;YACR,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,IAAI;gBACZ,WAAW,EAAE,mBAAmB,GAAG,CAAC,CAAC,OAAO;gBAC5C,SAAS,EAAE,CAAC;aACb,CAAA;SACF;IACH,CAAC;IAEM,QAAQ,CAAC,EAAU;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAvGD,8BAuGC"}

package/dist/generic/QueueManager.d.ts

@@ -0,0 +1,34 @@
+import { TaskBase, QueueBase } from "./QueueBase";
+import { UserInfo, BaseEntity } from "@memberjunction/core";
+/**
+ *QueueManager class is a generic manager of all active queues for the process.
+ *
+ *Whenever a new task is added, the queue manager will see if the TYPE of task already has a queue running
+ *or not. If that type of queue isn't running, it will start one up.
+ *
+ *Then, a new task is processed by logging into the database the new task and then it will be assigned
+ *to the queue that is responsible for processing that type of task.
+ *
+ *The queue manager is also responseible for updating all of its active Queues in the DB with heartbeat
+ *information. Heartbeat information is used to determine if a queue has crashed or not by other processes
+ *or not. After a heartbeat timeout is reached, other queues can pick up tasks from a crashed process.
+ */
+export declare class QueueManager {
+    private _queueTypes;
+    private _queues;
+    private static _instance;
+    private static _globalInstanceKey;
+    static get QueueTypes(): BaseEntity[];
+    static get Instance(): QueueManager;
+    private configPromise;
+    Config(contextUser: UserInfo): Promise<void>;
+    static Config(contextUser: UserInfo): Promise<void>;
+    protected loadQueueTypes(contextUser: UserInfo): Promise<void>;
+    constructor();
+    static AddTask(QueueType: string, data: any, options: any, contextUser: UserInfo): Promise<TaskBase | undefined>;
+    AddTask(QueueTypeID: number, data: any, options: any, contextUser: UserInfo): Promise<TaskBase | undefined>;
+    private ongoingQueueCreations;
+    protected CheckCreateQueue(queueType: BaseEntity, contextUser: UserInfo): Promise<QueueBase | undefined>;
+    protected CreateQueue(queueType: BaseEntity, contextUser: UserInfo): Promise<QueueBase | null | undefined>;
+    protected get Queues(): QueueBase[];
+}

package/dist/generic/QueueManager.js

@@ -0,0 +1,189 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueManager = void 0;
+//import { QueueEntity, QueueTaskEntity, QueueTypeEntity } from "mj_generatedentities";
+const QueueBase_1 = require("./QueueBase");
+const core_1 = require("@memberjunction/core");
+const global_1 = require("@memberjunction/global");
+const os_1 = __importDefault(require("os"));
+/**
+ *QueueManager class is a generic manager of all active queues for the process.
+ *
+ *Whenever a new task is added, the queue manager will see if the TYPE of task already has a queue running
+ *or not. If that type of queue isn't running, it will start one up.
+ *
+ *Then, a new task is processed by logging into the database the new task and then it will be assigned
+ *to the queue that is responsible for processing that type of task.
+ *
+ *The queue manager is also responseible for updating all of its active Queues in the DB with heartbeat
+ *information. Heartbeat information is used to determine if a queue has crashed or not by other processes
+ *or not. After a heartbeat timeout is reached, other queues can pick up tasks from a crashed process.
+ */
+class QueueManager {
+    static get QueueTypes() {
+        return QueueManager.Instance._queueTypes;
+    }
+    static get Instance() {
+        if (QueueManager._instance === null)
+            QueueManager._instance = new QueueManager();
+        return QueueManager._instance;
+    }
+    async Config(contextUser) {
+        if (this._queueTypes.length === 0) {
+            if (!this.configPromise) {
+                this.configPromise = this.loadQueueTypes(contextUser);
+            }
+            try {
+                await this.configPromise;
+            }
+            finally {
+                this.configPromise = null;
+            }
+        }
+    }
+    static async Config(contextUser) {
+        await QueueManager.Instance.Config(contextUser);
+    }
+    async loadQueueTypes(contextUser) {
+        // load all of the queue types from the database
+        const rv = new core_1.RunView();
+        const queueTypes = await rv.RunView({
+            EntityName: 'Queue Types',
+        }, contextUser);
+        QueueManager.Instance._queueTypes = queueTypes.Results;
+    }
+    constructor() {
+        this._queueTypes = [];
+        this._queues = [];
+        this.configPromise = null;
+        // Initialize a map to hold ongoing queue creation promises
+        this.ongoingQueueCreations = new Map();
+        if (QueueManager._instance === null) {
+            // check the global object first to see if we have an instance there since multiple modules might load this code
+            // and the static instance colud be different for each module based on JS import paths
+            const g = global_1.MJGlobal.Instance.GetGlobalObjectStore();
+            if (g && g[QueueManager._globalInstanceKey]) {
+                QueueManager._instance = g[QueueManager._globalInstanceKey];
+            }
+            else {
+                if (g)
+                    g[QueueManager._globalInstanceKey] = this; // save the instance to the global object store if we have a global object store
+                QueueManager._instance = this; // and save our new instance to the static member for future use
+            }
+        }
+        return QueueManager._instance;
+    }
+    static async AddTask(QueueType, data, options, contextUser) {
+        await QueueManager.Config(contextUser);
+        const queueType = QueueManager.QueueTypes.find(qt => qt.Name == QueueType);
+        if (queueType == null)
+            throw new Error(`Queue Type ${QueueType} not found.`);
+        return QueueManager.Instance.AddTask(queueType.ID, data, options, contextUser);
+    }
+    async AddTask(QueueTypeID, data, options, contextUser) {
+        try {
+            // STEP 1: Find the queue type
+            const queueType = QueueManager.QueueTypes.find(qt => qt.ID == QueueTypeID);
+            if (queueType == null)
+                throw new Error(`Queue Type ID ${QueueTypeID} not found.`);
+            if (queueType.IsActive === false)
+                throw new Error(`Queue Type ID ${QueueTypeID} is not active.`);
+            // STEP 2: Find the queue for this type, create it if we don't have one running yet for the specified queue type
+            const queue = await this.CheckCreateQueue(queueType, contextUser);
+            if (queue) {
+                // STEP 3: Create a task in the database for this new task
+                const md = new core_1.Metadata();
+                const taskRecord = await md.GetEntityObject('Queue Tasks', contextUser);
+                taskRecord.Set('QueueID', queue.QueueID);
+                taskRecord.Set('Status', 'Pending');
+                taskRecord.Set('Data', JSON.stringify(data));
+                taskRecord.Set('Options', JSON.stringify(options));
+                if (await taskRecord.Save()) {
+                    // db save worked, now we can create a taskBase object
+                    const task = new QueueBase_1.TaskBase(taskRecord, data, options);
+                    queue.AddTask(task);
+                    return task;
+                }
+                else
+                    throw new Error(`Failed to save new task to the database.`);
+            }
+        }
+        catch (e) {
+            (0, core_1.LogError)(e.message);
+        }
+    }
+    async CheckCreateQueue(queueType, contextUser) {
+        let queue = this._queues.find(q => q.QueueTypeID == queueType.ID);
+        if (queue === null || queue === undefined) {
+            // If a queue creation for this type is not already in progress, start one
+            if (!this.ongoingQueueCreations.has(queueType.ID)) {
+                this.ongoingQueueCreations.set(queueType.ID, this.CreateQueue(queueType, contextUser));
+            }
+            try {
+                // Wait for the ongoing queue creation to finish
+                queue = await this.ongoingQueueCreations.get(queueType.ID);
+            }
+            catch (error) {
+                // If there's an error, remove the promise from the map and rethrow the error
+                this.ongoingQueueCreations.delete(queueType.ID);
+                throw error;
+            }
+            // Once the queue creation has completed successfully, remove the promise from the map
+            this.ongoingQueueCreations.delete(queueType.ID);
+        }
+        return queue;
+    }
+    async CreateQueue(queueType, contextUser) {
+        try {
+            // create a new queue, based on the Queue Type metadata and process info
+            const md = new core_1.Metadata();
+            const newQueueRecord = await md.GetEntityObject('Queues', contextUser);
+            newQueueRecord.NewRecord();
+            newQueueRecord.Set('QueueTypeID', queueType.ID);
+            newQueueRecord.Set('Name', queueType.Name);
+            newQueueRecord.Set('IsActive', true);
+            newQueueRecord.Set('ProcessPID', process.pid);
+            newQueueRecord.Set('ProcessPlatform', process.platform);
+            newQueueRecord.Set('ProcessVersion', process.version);
+            newQueueRecord.Set('ProcessCwd', process.cwd());
+            const networkInterfaces = os_1.default.networkInterfaces();
+            const interfaceNames = Object.keys(networkInterfaces);
+            if (interfaceNames.length > 0) {
+                const firstInterfaceName = interfaceNames[0];
+                const firstInterface = networkInterfaces[firstInterfaceName];
+                if (firstInterface && firstInterface.length > 0) {
+                    newQueueRecord.Set('ProcessIPAddress', firstInterface[0].address);
+                    newQueueRecord.Set('ProcessMacAddress', firstInterface[0].mac);
+                }
+            }
+            newQueueRecord.Set('ProcessOSName', os_1.default.type());
+            newQueueRecord.Set('ProcessOSVersion', os_1.default.release());
+            newQueueRecord.Set('ProcessHostName', os_1.default.hostname());
+            newQueueRecord.Set('ProcessUserID', os_1.default.userInfo().uid.toString());
+            newQueueRecord.Set('ProcessUserName', os_1.default.userInfo().username);
+            newQueueRecord.Set('LastHeartbeat', new Date());
+            if (await newQueueRecord.Save()) {
+                const newQueue = global_1.MJGlobal.Instance.ClassFactory.CreateInstance(QueueBase_1.QueueBase, queueType.Name, newQueueRecord, queueType.ID, contextUser);
+                if (newQueue)
+                    this._queues.push(newQueue);
+                return newQueue;
+            }
+            else
+                throw new Error(`Unable to create new queue for Queue Type ID ${queueType.ID}.`);
+        }
+        catch (e) {
+            (0, core_1.LogError)(e.message);
+            return null;
+        }
+    }
+    get Queues() {
+        return this._queues;
+    }
+}
+QueueManager._instance = null;
+QueueManager._globalInstanceKey = '__mj_queue_manager_instance__';
+exports.QueueManager = QueueManager;
+//# sourceMappingURL=QueueManager.js.map

package/dist/generic/QueueManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueueManager.js","sourceRoot":"","sources":["../../src/generic/QueueManager.ts"],"names":[],"mappings":";;;;;;AAAA,uFAAuF;AACvF,2CAAkD;AAClD,+CAAyF;AACzF,mDAAkD;AAClD,4CAAoB;AAEpB;;;;;;;;;;;;GAYG;AACH,MAAa,YAAY;IAMhB,MAAM,KAAK,UAAU;QAC1B,OAAO,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC;IAC3C,CAAC;IAEM,MAAM,KAAK,QAAQ;QACxB,IAAI,YAAY,CAAC,SAAS,KAAK,IAAI;YACjC,YAAY,CAAC,SAAS,GAAG,IAAI,YAAY,EAAE,CAAC;QAE9C,OAAO,YAAY,CAAC,SAAS,CAAC;IAChC,CAAC;IAGM,KAAK,CAAC,MAAM,CAAC,WAAqB;QACvC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;gBACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;aACvD;YAED,IAAI;gBACF,MAAM,IAAI,CAAC,aAAa,CAAC;aAC1B;oBAAS;gBACR,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;aAC3B;SACF;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,WAAqB;QAC9C,MAAM,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IAES,KAAK,CAAC,cAAc,CAAC,WAAqB;QAClD,gDAAgD;QAChD,MAAM,EAAE,GAAG,IAAI,cAAO,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC;YAClC,UAAU,EAAE,aAAa;SAC1B,EAAE,WAAW,CAAC,CAAC;QAChB,YAAY,CAAC,QAAQ,CAAC,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC;IACzD,CAAC;IAED;QA5CQ,gBAAW,GAAiB,EAAE,CAAC;QAC/B,YAAO,GAAgB,EAAE,CAAC;QAe1B,kBAAa,GAAyB,IAAI,CAAC;QA4FnD,2DAA2D;QACnD,0BAAqB,GAAG,IAAI,GAAG,EAA8B,CAAC;QAhEpE,IAAI,YAAY,CAAC,SAAS,KAAK,IAAI,EAAE;YACnC,gHAAgH;YAChH,sFAAsF;YACtF,MAAM,CAAC,GAAG,iBAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;YACnD,IAAI,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,EAAE;gBAC3C,YAAY,CAAC,SAAS,GAAG,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;aAC7D;iBACI;gBACH,IAAI,CAAC;oBACH,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC,gFAAgF;gBAE7H,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,gEAAgE;aAChG;SACF;QAED,OAAO,YAAY,CAAC,SAAS,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,SAAiB,EAAE,IAAS,EAAE,OAAY,EAAE,WAAqB;QAC3F,MAAM,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACvC,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,IAAI,SAAS,CAAC,CAAC;QAC3E,IAAI,SAAS,IAAI,IAAI;YACnB,MAAM,IAAI,KAAK,CAAC,cAAc,SAAS,aAAa,CAAC,CAAA;QAEvD,OAAO,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IACjF,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,WAAmB,EAAE,IAAS,EAAE,OAAY,EAAE,WAAqB;QACtF,IAAI;YACF,8BAA8B;YAC9B,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,WAAW,CAAC,CAAC;YAC3E,IAAI,SAAS,IAAI,IAAI;gBACnB,MAAM,IAAI,KAAK,CAAC,iBAAiB,WAAW,aAAa,CAAC,CAAA;YAE5D,IAAI,SAAS,CAAC,QAAQ,KAAK,KAAK;gBAC9B,MAAM,IAAI,KAAK,CAAC,iBAAiB,WAAW,iBAAiB,CAAC,CAAA;YAEhE,gHAAgH;YAChH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAClE,IAAI,KAAK,EAAE;gBACT,0DAA0D;gBAC1D,MAAM,EAAE,GAAG,IAAI,eAAQ,EAAE,CAAC;gBAC1B,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;gBACxE,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;gBACzC,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;gBACpC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC7C,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;gBACnD,IAAI,MAAM,UAAU,CAAC,IAAI,EAAE,EAAE;oBAC3B,sDAAsD;oBACtD,MAAM,IAAI,GAAG,IAAI,oBAAQ,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;oBACrD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBACpB,OAAO,IAAI,CAAC;iBACb;;oBAEC,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;aAC/D;SACF;QACD,OAAO,CAAM,EAAE;YACb,IAAA,eAAQ,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC;SACrB;IACH,CAAC;IAMS,KAAK,CAAC,gBAAgB,CAAC,SAAqB,EAAE,WAAqB;QAC3E,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC;QAElE,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;YACzC,0EAA0E;YAC1E,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE;gBACjD,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;aACxF;YAED,IAAI;gBACF,gDAAgD;gBAChD,KAAK,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;aAC5D;YAAC,OAAO,KAAK,EAAE;gBACd,6EAA6E;gBAC7E,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBAChD,MAAM,KAAK,CAAC;aACb;YAED,sFAAsF;YACtF,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;SACjD;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAGS,KAAK,CAAC,WAAW,CAAC,SAAqB,EAAE,WAAqB;QACtE,IAAI;YACF,wEAAwE;YACxE,MAAM,EAAE,GAAG,IAAI,eAAQ,EAAE,CAAC;YAC1B,MAAM,cAAc,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACvE,cAAc,CAAC,SAAS,EAAE,CAAC;YAC3B,cAAc,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;YAChD,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;YAC3C,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACrC,cAAc,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;YAC9C,cAAc,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;YACxD,cAAc,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YACtD,cAAc,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YAEhD,MAAM,iBAAiB,GAAG,YAAE,CAAC,iBAAiB,EAAE,CAAC;YACjD,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAEtD,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC7B,MAAM,kBAAkB,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;gBAC7C,MAAM,cAAc,GAAG,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;gBAC7D,IAAI,cAAc,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC/C,cAAc,CAAC,GAAG,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;oBAClE,cAAc,CAAC,GAAG,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;iBAChE;aACF;YAED,cAAc,CAAC,GAAG,CAAC,eAAe,EAAE,YAAE,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/C,cAAc,CAAC,GAAG,CAAC,kBAAkB,EAAE,YAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YACrD,cAAc,CAAC,GAAG,CAAC,iBAAiB,EAAE,YAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;YACrD,cAAc,CAAC,GAAG,CAAC,eAAe,EAAE,YAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;YAClE,cAAc,CAAC,GAAG,CAAC,iBAAiB,EAAE,YAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC;YAE9D,cAAc,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;YAEhD,IAAI,MAAM,cAAc,CAAC,IAAI,EAAE,EAAE;gBAC/B,MAAM,QAAQ,GAAG,iBAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAAY,qBAAS,EAAE,SAAS,CAAC,IAAI,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC,CAAA;gBAC/I,IAAI,QAAQ;oBACV,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC9B,OAAO,QAAQ,CAAC;aACjB;;gBAEC,MAAM,IAAI,KAAK,CAAC,gDAAgD,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC;SACpF;QACD,OAAO,CAAM,EAAE;YACb,IAAA,eAAQ,EAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED,IAAc,MAAM;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;;AA1Lc,sBAAS,GAAwB,IAAI,AAA5B,CAA6B;AACtC,+BAAkB,GAAG,+BAA+B,AAAlC,CAAmC;AAJzD,oCAAY"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './generic/QueueBase';
+export * from './generic/QueueManager';
+export * from './drivers/AIActionQueue';

package/dist/index.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("./generic/QueueBase"), exports);
+__exportStar(require("./generic/QueueManager"), exports);
+__exportStar(require("./drivers/AIActionQueue"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,yDAAuC;AACvC,0DAAwC"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@memberjunction/queue",
+  "version": "0.9.1",
+  "description": "MemberJunction: Queue Library for managing server side queues",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "start": "ts-node-dev src/index.ts",
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "devDependencies": {
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.0.3"
+  },
+  "dependencies": {
+    "@memberjunction/ai": "^0.9.0",
+    "@memberjunction/core": "^0.9.0",
+    "@memberjunction/global": "^0.9.0",
+    "@types/uuid": "^9.0.1",
+    "uuid": "^9.0.0"
+  }
+}