@rango-dev/queue-manager-core 0.1.10-next.69

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './manager';
+export { default as Persistor } from './persistor';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./queue-manager-core.cjs.production.min.js')
+} else {
+  module.exports = require('./queue-manager-core.cjs.development.js')
+}

package/dist/manager.d.ts

@@ -0,0 +1,210 @@
+import Queue, { QueueEventHandlers, TaskEvent } from './queue';
+import { QueueStorage, Status } from './types';
+export declare type ManagerContext = object;
+export declare type QueueName = string;
+export declare type QueueID = string;
+export declare type BlockedTask = {
+    queue_id: string;
+    task_id: string;
+    action: string;
+    reason: Record<string, unknown>;
+    storage: {
+        get: () => QueueStorage;
+        set: (data: QueueStorage) => QueueStorage;
+    };
+};
+export declare type SetStorage<T> = (nextStorage: T) => T;
+export interface ExecuterActions<T extends QueueStorage = QueueStorage, V extends string = string, C = ManagerContext> {
+    next: () => void;
+    retry: () => void;
+    failed: () => void;
+    schedule: (actionName: V) => void;
+    setStorage: SetStorage<T>;
+    getStorage: () => T;
+    block: (reason: Record<string, unknown>) => void;
+    unblock: () => void;
+    context: C;
+}
+export interface QueueDef<T extends QueueStorage = QueueStorage, V extends string = string, C = ManagerContext> {
+    name: QueueName;
+    actions: {
+        [K in V]: (actions: ExecuterActions<T, V, C>) => void | Promise<void>;
+    };
+    events?: Partial<QueueEventHandlers>;
+    run: V[];
+    whenTaskBlocked?: (event: any, params: {
+        queue_id: string;
+        queue: Queue;
+        context: C;
+        getBlockedTasks: () => BlockedTask[];
+        forceExecute: (queue_id: string, data?: object) => void;
+        retry: () => void;
+        manager: Manager;
+    }) => void;
+}
+export interface Events {
+    onCreateQueue: (queue: QueueInfo & {
+        id: QueueID;
+    }) => void;
+    onUpdateQueue: (queue_id: QueueID, queue: QueueInfo) => void;
+    onCreateTask: (queue_id: QueueID, event: TaskEvent) => void;
+    onUpdateTask: (queue_id: QueueID, event: TaskEvent) => void;
+    onStorageUpdate: (queue_id: QueueID, data: QueueStorage) => void;
+    onTaskBlock: (queue_id: QueueID) => void;
+    onPersistedDataLoaded: (manager: Manager) => void;
+}
+interface ManagerOptions {
+    events?: Partial<Events>;
+    queuesDefs: QueueDef[];
+    context?: ManagerContext;
+    isPaused?: boolean;
+}
+export interface QueueInfo {
+    name: QueueName;
+    createdAt: number;
+    status: Status;
+    list: Queue;
+    actions: {
+        run: () => void;
+        cancel: () => void;
+        setStorage: SetStorage<any>;
+        getStorage: () => any;
+    };
+}
+declare class Manager {
+    private queuesDefs;
+    private queues;
+    private events;
+    private persistor;
+    private context;
+    private isPaused;
+    /**
+     *
+     * Making an instance, initilize events, setup a persistor and try to recover the last state of the manager.
+     *
+     * */
+    constructor(options: ManagerOptions);
+    /**
+     *
+     * Reading persisted data from storage then brings into memory.
+     *
+     * Notes:
+     *  - Reset the memory, so we can call this method whenever we want and not only on the initialize process.
+     *  - All the events will be tirggered (like onCreateQueue, onCreateTask, onBlock, ....)
+     *  - Try to `resume` if the status is `running`.
+     *  - Trigger `onPersistedDataLoaded` event when queues recovered from storage.
+     *
+     */
+    private sync;
+    /**
+     *
+     * Making a new instance from `Queue` and adds Manager's event handlers to it.
+     *
+     * @returns An instance of `Queue` with wrapped event handlers from Manager.
+     *
+     */
+    private createQueue;
+    /**
+     * Go through all tasks (from all queues) and return a list of blocked tasks
+     *
+     * @returns a list of blocked tasks including enough information to get the queue and mutate the storage.
+     *
+     */
+    private getBlockedTasks;
+    /**
+     *
+     * Add a queue to the manager to keep track of the queue and its state.
+     *
+     * @param id
+     * @param queue
+     * @returns
+     */
+    private add;
+    /**
+     *
+     * Create a new queue by client.
+     *
+     * It will do the internal things to make a queue from definitions, and running using Manager.
+     *
+     * Notes:
+     *  - After creating the queue, it will be run automatically.
+     *
+     * @returns an ID for queue so it can be used to get the created queue later by client.
+     *
+     */
+    create(name: QueueName, storage: QueueStorage): Promise<string>;
+    /**
+     * Get a queue by its ID.
+     *
+     * @returns An object includes queue and its state in `Manager`.
+     */
+    get(queue_id: QueueID): QueueInfo | undefined;
+    /**
+     * Get all queues from `Manager`
+     *
+     * @returns a list of queues includes all the queues and their states.
+     */
+    getAll(): Map<string, QueueInfo>;
+    /**
+     *
+     * Ask from manager to run pending queues.
+     *
+     * It only try to run queues with `PENDING` status and ignore all the other statuses.
+     *
+     */
+    execute(): void;
+    /**
+     *
+     * Try to find queues with `RUNNING` status to run them again.
+     *
+     * It's useful for recovering the queue at some certain points
+     * like running a currepted task (reloaded when it was running) or needs manual trigger from UI.
+     *
+     * @returns
+     */
+    resume(): void;
+    /**
+     *
+     * Run all `BLOCKED` queues once again.
+     *
+     * If a queue has `BLOCKED` status and the last task is `BLOCKED` as well,
+     * The task will be run one more time.
+     *
+     * Useful for scenarios like we are blocking the queue under some conditions in task,
+     * We can use this method to ask the queue to run the blocked task one more time and
+     * maybe this time condtions are met and the queue can be proceed.
+     *
+     * @returns
+     */
+    retry(): void;
+    /**
+     *
+     * Run a blocked task on a specific queue with the ability to pass more data.
+     *
+     * Useful when we have a custom logic for running queue and needs to pass some specific data
+     * to the task and try to run it manually with the provided data.
+     *
+     */
+    forceExecute(queue_id: string, data?: object): void;
+    /**
+     *
+     * Sync in-memory state (of `Manager`) with storage (persist).
+     *
+     * Usually we call this method after a change detected in the state of manager.
+     *
+     */
+    private handleUpdate;
+    /**
+     * Active readonly mode for manager, it means it doesn't run anythin,
+     * And only can be used to read the data.
+     */
+    pause(): void;
+    /**
+     * Activate normal mode which means it will be able to run the queuese as well.
+     */
+    run(): void;
+    private getContext;
+    private shouldExecute;
+}
+export { Manager };
+//# sourceMappingURL=manager.d.ts.map

package/dist/manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["src/manager.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAE/C,oBAAY,cAAc,GAAG,MAAM,CAAC;AACpC,oBAAY,SAAS,GAAG,MAAM,CAAC;AAC/B,oBAAY,OAAO,GAAG,MAAM,CAAC;AAC7B,oBAAY,WAAW,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,YAAY,CAAC;QACxB,GAAG,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,YAAY,CAAC;KAC3C,CAAC;CACH,CAAC;AAEF,oBAAY,UAAU,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;AAElD,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,YAAY,GAAG,YAAY,EACrC,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,CAAC,GAAG,cAAc;IAElB,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,QAAQ,EAAE,CAAC,UAAU,EAAE,CAAC,KAAK,IAAI,CAAC;IAClC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC,CAAC;IACpB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;IACjD,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,OAAO,EAAE,CAAC,CAAC;CACZ;AAED,MAAM,WAAW,QAAQ,CACvB,CAAC,SAAS,YAAY,GAAG,YAAY,EACrC,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,CAAC,GAAG,cAAc;IAElB,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE;SACN,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;KACtE,CAAC;IACF,MAAM,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACrC,GAAG,EAAE,CAAC,EAAE,CAAC;IACT,eAAe,CAAC,EAAE,CAChB,KAAK,EAAE,GAAG,EACV,MAAM,EAAE;QACN,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,KAAK,CAAC;QACb,OAAO,EAAE,CAAC,CAAC;QACX,eAAe,EAAE,MAAM,WAAW,EAAE,CAAC;QACrC,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;QACxD,KAAK,EAAE,MAAM,IAAI,CAAC;QAClB,OAAO,EAAE,OAAO,CAAC;KAClB,KACE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,MAAM;IACrB,aAAa,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG;QAAE,EAAE,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC;IAC5D,aAAa,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IAC7D,YAAY,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IAC5D,YAAY,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IAC5D,eAAe,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;IACjE,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;IACzC,qBAAqB,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;CACnD;AAED,UAAU,cAAc;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,KAAK,CAAC;IACZ,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,IAAI,CAAC;QAChB,MAAM,EAAE,MAAM,IAAI,CAAC;QACnB,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;QAC5B,UAAU,EAAE,MAAM,GAAG,CAAC;KACvB,CAAC;CACH;AAED,cAAM,OAAO;IACX,OAAO,CAAC,UAAU,CAAkC;IACpD,OAAO,CAAC,MAAM,CAAiC;IAC/C,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,QAAQ,CAAkB;IAElC;;;;SAIK;gBACO,OAAO,EAAE,cAAc;IA+CnC;;;;;;;;;;OAUG;YACW,IAAI;IAsDlB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;IAqFnB;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IA4BvB;;;;;;;OAOG;IACH,OAAO,CAAC,GAAG;IASX;;;;;;;;;;;OAWG;IACU,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY;IA4D1D;;;;OAIG;IACI,GAAG,CAAC,QAAQ,EAAE,OAAO;IAI5B;;;;OAIG;IACI,MAAM;IAIb;;;;;;OAMG;IACI,OAAO;IAad;;;;;;;;OAQG;IACI,MAAM;IAiBb;;;;;;;;;;;;OAYG;IACI,KAAK;IAiBZ;;;;;;;OAOG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAenD;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAgBpB;;;OAGG;IACI,KAAK;IAIZ;;OAEG;IACI,GAAG;IAQV,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,aAAa;CAMtB;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/persistor.d.ts

@@ -0,0 +1,19 @@
+import { DBSchema, IDBPDatabase } from 'idb';
+import { QueueID } from './manager';
+import { PersistedQueue } from './types';
+declare type UpdatePersistedQueue = Partial<Pick<PersistedQueue, 'status' | 'state' | 'tasks' | 'storage'>>;
+interface Database extends DBSchema {
+    queues: {
+        value: PersistedQueue;
+        key: string;
+    };
+}
+declare class Persistor {
+    db: Promise<IDBPDatabase<Database>>;
+    constructor();
+    insertQueue(queue: PersistedQueue): Promise<void>;
+    updateQueue(id: QueueID, queue: UpdatePersistedQueue): Promise<void>;
+    getAll(): Promise<PersistedQueue[]>;
+}
+export default Persistor;
+//# sourceMappingURL=persistor.d.ts.map

package/dist/persistor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"persistor.d.ts","sourceRoot":"","sources":["src/persistor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,QAAQ,EAAE,YAAY,EAAE,MAAM,KAAK,CAAC;AAErD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAMzC,aAAK,oBAAoB,GAAG,OAAO,CACjC,IAAI,CAAC,cAAc,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC,CAC/D,CAAC;AAEF,UAAU,QAAS,SAAQ,QAAQ;IACjC,MAAM,EAAE;QACN,KAAK,EAAE,cAAc,CAAC;QACtB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED,cAAM,SAAS;IACb,EAAE,EAAE,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;;IAQ9B,WAAW,CAAC,KAAK,EAAE,cAAc;IAUjC,WAAW,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,oBAAoB;IAepD,MAAM;CAMb;AAED,eAAe,SAAS,CAAC"}