@sera4/essentia 3.0.13 → 3.1.0-rc.1

package/dist/ts/task-scheduler/index.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Task function type definition
+ */
+export type TaskFunction = () => Promise<void> | void;
+/**
+ * Task options interface
+ */
+export interface TaskOptions {
+    scheduled?: boolean;
+    timezone?: string;
+}
+/**
+ * Scheduler initialization options
+ */
+export interface SchedulerOptions {
+    timezone?: string;
+    scheduled?: boolean;
+}
+/**
+ * Task information interface
+ */
+export interface TaskInfo {
+    name: string;
+    cronExpression: string;
+    isRunning: boolean;
+    createdAt: Date;
+    options: TaskOptions;
+}
+/**
+ * TaskScheduler - Singleton class for managing cron-based scheduled tasks
+ * Provides helper functions around node-cron for easy task scheduling
+ */
+export declare class TaskScheduler {
+    private static instance;
+    private readonly tasks;
+    private isInitialized;
+    private options;
+    private constructor();
+    /**
+     * Get the singleton instance of TaskScheduler
+     * @returns {TaskScheduler} The singleton instance
+     */
+    static getInstance(): TaskScheduler;
+    /**
+     * Initialize the task scheduler
+     * @param {SchedulerOptions} options - Configuration options
+     * @param {string} options.timezone - Timezone for cron jobs (default: 'UTC')
+     * @param {boolean} options.scheduled - Whether to start tasks immediately (default: true)
+     */
+    init(options?: SchedulerOptions): void;
+    /**
+     * Add a scheduled task
+     * @param {string} name - Unique name for the task
+     * @param {string} cronExpression - Cron expression (e.g., '0 0 * * *' for daily at midnight)
+     * @param {TaskFunction} taskFunction - Function to execute
+     * @param {TaskOptions} options - Additional options
+     * @param {boolean} options.scheduled - Whether to start the task immediately (default: true)
+     * @param {string} options.timezone - Timezone override for this task
+     * @returns {boolean} - Success status
+     */
+    addTask(name: string, cronExpression: string, taskFunction: TaskFunction, options?: TaskOptions): boolean;
+    /**
+     * Update an existing scheduled task
+     * @param {string} name - Name of the task to update
+     * @param {string} cronExpression - New cron expression
+     * @param {TaskFunction} taskFunction - New function to execute
+     * @param {TaskOptions} options - Additional options
+     * @returns {boolean} - Success status
+     */
+    updateTask(name: string, cronExpression: string, taskFunction: TaskFunction, options?: TaskOptions): boolean;
+    /**
+     * Remove a scheduled task
+     * @param {string} name - Name of the task to remove
+     * @returns {boolean} - Success status
+     */
+    removeTask(name: string): boolean;
+    /**
+     * Start a specific task
+     * @param {string} name - Name of the task to start
+     * @returns {boolean} - Success status
+     */
+    startTask(name: string): boolean;
+    /**
+     * Stop a specific task
+     * @param {string} name - Name of the task to stop
+     * @returns {boolean} - Success status
+     */
+    stopTask(name: string): boolean;
+    /**
+     * Start all tasks
+     */
+    startAll(): void;
+    /**
+     * Stop all tasks
+     */
+    stopAll(): void;
+    /**
+     * Get information about all scheduled tasks
+     * @returns {TaskInfo[]} - Array of task information objects
+     */
+    getTasks(): TaskInfo[];
+    /**
+     * Get information about a specific task
+     * @param {string} name - Name of the task
+     * @returns {TaskInfo | null} - Task information or null if not found
+     */
+    getTask(name: string): TaskInfo | null;
+    /**
+     * Validate a cron expression
+     * @param {string} cronExpression - Cron expression to validate
+     * @returns {boolean} - Whether the expression is valid
+     */
+    validateCronExpression(cronExpression: string): boolean;
+    /**
+     * Check if the scheduler is initialized
+     * @returns {boolean} - Whether the scheduler is initialized
+     */
+    isSchedulerInitialized(): boolean;
+    /**
+     * Get the number of active tasks
+     * @returns {number} - Number of active tasks
+     */
+    getTaskCount(): number;
+    /**
+     * Shutdown the scheduler and clean up all tasks
+     */
+    shutdown(): void;
+}
+declare const _default: TaskScheduler;
+export default _default;

package/dist/ts/task-scheduler/index.js

@@ -0,0 +1,261 @@
+import cron from 'node-cron';
+import { S4Logger } from '../logger/index.js';
+const logger = new S4Logger();
+/**
+ * TaskScheduler - Singleton class for managing cron-based scheduled tasks
+ * Provides helper functions around node-cron for easy task scheduling
+ */
+export class TaskScheduler {
+    static instance;
+    tasks = new Map();
+    isInitialized = false;
+    options = {};
+    constructor() { }
+    /**
+     * Get the singleton instance of TaskScheduler
+     * @returns {TaskScheduler} The singleton instance
+     */
+    static getInstance() {
+        if (!TaskScheduler.instance) {
+            TaskScheduler.instance = new TaskScheduler();
+        }
+        return TaskScheduler.instance;
+    }
+    /**
+     * Initialize the task scheduler
+     * @param {SchedulerOptions} options - Configuration options
+     * @param {string} options.timezone - Timezone for cron jobs (default: 'UTC')
+     * @param {boolean} options.scheduled - Whether to start tasks immediately (default: true)
+     */
+    init(options = {}) {
+        if (this.isInitialized) {
+            logger.warn('TaskScheduler already initialized');
+            return;
+        }
+        this.options = {
+            timezone: options.timezone || 'UTC',
+            scheduled: options.scheduled !== false
+        };
+        this.isInitialized = true;
+        logger.info('TaskScheduler initialized', {
+            timezone: this.options.timezone,
+            scheduled: this.options.scheduled
+        });
+    }
+    /**
+     * Add a scheduled task
+     * @param {string} name - Unique name for the task
+     * @param {string} cronExpression - Cron expression (e.g., '0 0 * * *' for daily at midnight)
+     * @param {TaskFunction} taskFunction - Function to execute
+     * @param {TaskOptions} options - Additional options
+     * @param {boolean} options.scheduled - Whether to start the task immediately (default: true)
+     * @param {string} options.timezone - Timezone override for this task
+     * @returns {boolean} - Success status
+     */
+    addTask(name, cronExpression, taskFunction, options = {}) {
+        if (!this.isInitialized) {
+            logger.error('TaskScheduler not initialized. Call init() first.');
+            return false;
+        }
+        if (this.tasks.has(name)) {
+            logger.warn(`Task '${name}' already exists. Use updateTask() to modify it.`);
+            return false;
+        }
+        if (!cron.validate(cronExpression)) {
+            logger.error(`Invalid cron expression for task '${name}': ${cronExpression}`);
+            return false;
+        }
+        const scheduled = options.scheduled !== false ? (this.options.scheduled ?? true) : false;
+        const timezone = options.timezone ?? this.options.timezone;
+        const taskOptions = {
+            scheduled,
+            ...(timezone !== undefined && { timezone }),
+        };
+        try {
+            const task = cron.schedule(cronExpression, async () => {
+                const startTime = Date.now();
+                logger.info(`Starting scheduled task: ${name}`);
+                try {
+                    await taskFunction();
+                    const duration = Date.now() - startTime;
+                    logger.info(`Completed scheduled task: ${name} (${duration}ms)`);
+                }
+                catch (error) {
+                    const duration = Date.now() - startTime;
+                    logger.error(`Failed scheduled task: ${name} (${duration}ms)`, error);
+                }
+            }, taskOptions);
+            this.tasks.set(name, {
+                task,
+                cronExpression,
+                taskFunction,
+                options: taskOptions,
+                createdAt: new Date()
+            });
+            logger.info(`Added scheduled task: ${name}`, {
+                cronExpression,
+                scheduled: taskOptions.scheduled,
+                timezone: taskOptions.timezone
+            });
+            return true;
+        }
+        catch (error) {
+            logger.error(`Failed to add scheduled task: ${name}`, error);
+            return false;
+        }
+    }
+    /**
+     * Update an existing scheduled task
+     * @param {string} name - Name of the task to update
+     * @param {string} cronExpression - New cron expression
+     * @param {TaskFunction} taskFunction - New function to execute
+     * @param {TaskOptions} options - Additional options
+     * @returns {boolean} - Success status
+     */
+    updateTask(name, cronExpression, taskFunction, options = {}) {
+        if (!this.tasks.has(name)) {
+            logger.error(`Task '${name}' not found. Use addTask() to create it.`);
+            return false;
+        }
+        // Remove existing task
+        this.removeTask(name);
+        // Add updated task
+        return this.addTask(name, cronExpression, taskFunction, options);
+    }
+    /**
+     * Remove a scheduled task
+     * @param {string} name - Name of the task to remove
+     * @returns {boolean} - Success status
+     */
+    removeTask(name) {
+        if (!this.tasks.has(name)) {
+            logger.warn(`Task '${name}' not found`);
+            return false;
+        }
+        const taskInfo = this.tasks.get(name);
+        taskInfo.task.destroy();
+        this.tasks.delete(name);
+        logger.info(`Removed scheduled task: ${name}`);
+        return true;
+    }
+    /**
+     * Start a specific task
+     * @param {string} name - Name of the task to start
+     * @returns {boolean} - Success status
+     */
+    startTask(name) {
+        if (!this.tasks.has(name)) {
+            logger.error(`Task '${name}' not found`);
+            return false;
+        }
+        const taskInfo = this.tasks.get(name);
+        taskInfo.task.start();
+        logger.info(`Started scheduled task: ${name}`);
+        return true;
+    }
+    /**
+     * Stop a specific task
+     * @param {string} name - Name of the task to stop
+     * @returns {boolean} - Success status
+     */
+    stopTask(name) {
+        if (!this.tasks.has(name)) {
+            logger.error(`Task '${name}' not found`);
+            return false;
+        }
+        const taskInfo = this.tasks.get(name);
+        taskInfo.task.stop();
+        logger.info(`Stopped scheduled task: ${name}`);
+        return true;
+    }
+    /**
+     * Start all tasks
+     */
+    startAll() {
+        this.tasks.forEach((taskInfo, name) => {
+            taskInfo.task.start();
+        });
+        logger.info(`Started all scheduled tasks (${this.tasks.size} tasks)`);
+    }
+    /**
+     * Stop all tasks
+     */
+    stopAll() {
+        this.tasks.forEach((taskInfo, name) => {
+            taskInfo.task.stop();
+        });
+        logger.info(`Stopped all scheduled tasks (${this.tasks.size} tasks)`);
+    }
+    /**
+     * Get information about all scheduled tasks
+     * @returns {TaskInfo[]} - Array of task information objects
+     */
+    getTasks() {
+        const tasks = [];
+        this.tasks.forEach((taskInfo, name) => {
+            tasks.push({
+                name,
+                cronExpression: taskInfo.cronExpression,
+                isRunning: taskInfo.task.running || false,
+                createdAt: taskInfo.createdAt,
+                options: taskInfo.options
+            });
+        });
+        return tasks;
+    }
+    /**
+     * Get information about a specific task
+     * @param {string} name - Name of the task
+     * @returns {TaskInfo | null} - Task information or null if not found
+     */
+    getTask(name) {
+        if (!this.tasks.has(name)) {
+            return null;
+        }
+        const taskInfo = this.tasks.get(name);
+        return {
+            name,
+            cronExpression: taskInfo.cronExpression,
+            isRunning: taskInfo.task.running || false,
+            createdAt: taskInfo.createdAt,
+            options: taskInfo.options
+        };
+    }
+    /**
+     * Validate a cron expression
+     * @param {string} cronExpression - Cron expression to validate
+     * @returns {boolean} - Whether the expression is valid
+     */
+    validateCronExpression(cronExpression) {
+        return cron.validate(cronExpression);
+    }
+    /**
+     * Check if the scheduler is initialized
+     * @returns {boolean} - Whether the scheduler is initialized
+     */
+    isSchedulerInitialized() {
+        return this.isInitialized;
+    }
+    /**
+     * Get the number of active tasks
+     * @returns {number} - Number of active tasks
+     */
+    getTaskCount() {
+        return this.tasks.size;
+    }
+    /**
+     * Shutdown the scheduler and clean up all tasks
+     */
+    shutdown() {
+        logger.info('Shutting down TaskScheduler...');
+        this.tasks.forEach((taskInfo, name) => {
+            taskInfo.task.destroy();
+        });
+        this.tasks.clear();
+        this.isInitialized = false;
+        logger.info('TaskScheduler shutdown complete');
+    }
+}
+// Export singleton instance
+export default TaskScheduler.getInstance();
+//# sourceMappingURL=index.js.map

package/dist/ts/task-scheduler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/task-scheduler/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;AA6C9B;;;GAGG;AACH,MAAM,OAAO,aAAa;IAChB,MAAM,CAAC,QAAQ,CAAgB;IACtB,KAAK,GAAkC,IAAI,GAAG,EAAE,CAAC;IAC1D,aAAa,GAAY,KAAK,CAAC;IAC/B,OAAO,GAAqB,EAAE,CAAC;IAEvC,gBAAuB,CAAC;IAExB;;;OAGG;IACI,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;YAC5B,aAAa,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;QAC/C,CAAC;QACD,OAAO,aAAa,CAAC,QAAQ,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,UAA4B,EAAE;QACxC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YACjD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,GAAG;YACb,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK;YACnC,SAAS,EAAE,OAAO,CAAC,SAAS,KAAK,KAAK;SACvC,CAAC;QAEF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE;YACvC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;YAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;SAClC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACI,OAAO,CACZ,IAAY,EACZ,cAAsB,EACtB,YAA0B,EAC1B,UAAuB,EAAE;QAEzB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;YAClE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,kDAAkD,CAAC,CAAC;YAC7E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YACnC,MAAM,CAAC,KAAK,CAAC,qCAAqC,IAAI,MAAM,cAAc,EAAE,CAAC,CAAC;YAC9E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACzF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC3D,MAAM,WAAW,GAAgB;YAC/B,SAAS;YACT,GAAG,CAAC,QAAQ,KAAK,SAAS,IAAI,EAAE,QAAQ,EAAE,CAAC;SAC5C,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;gBACpD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC7B,MAAM,CAAC,IAAI,CAAC,4BAA4B,IAAI,EAAE,CAAC,CAAC;gBAEhD,IAAI,CAAC;oBACH,MAAM,YAAY,EAAE,CAAC;oBACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;oBACxC,MAAM,CAAC,IAAI,CAAC,6BAA6B,IAAI,KAAK,QAAQ,KAAK,CAAC,CAAC;gBACnE,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;oBACxC,MAAM,CAAC,KAAK,CAAC,0BAA0B,IAAI,KAAK,QAAQ,KAAK,EAAE,KAAK,CAAC,CAAC;gBACxE,CAAC;YACH,CAAC,EAAE,WAAW,CAAC,CAAC;YAEhB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE;gBACnB,IAAI;gBACJ,cAAc;gBACd,YAAY;gBACZ,OAAO,EAAE,WAAW;gBACpB,SAAS,EAAE,IAAI,IAAI,EAAE;aACtB,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,yBAAyB,IAAI,EAAE,EAAE;gBAC3C,cAAc;gBACd,SAAS,EAAE,WAAW,CAAC,SAAS;gBAChC,QAAQ,EAAE,WAAW,CAAC,QAAQ;aAC/B,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,iCAAiC,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC;YAC7D,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,UAAU,CACf,IAAY,EACZ,cAAsB,EACtB,YAA0B,EAC1B,UAAuB,EAAE;QAEzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,0CAA0C,CAAC,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,uBAAuB;QACvB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEtB,mBAAmB;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,IAAY;QAC5B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,aAAa,CAAC,CAAC;YACxC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QACvC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAExB,MAAM,CAAC,IAAI,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,IAAY;QAC3B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,aAAa,CAAC,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QACvC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,IAAY;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,aAAa,CAAC,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QACvC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,MAAM,CAAC,IAAI,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;YACpC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,gCAAgC,IAAI,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;YACpC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,gCAAgC,IAAI,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,MAAM,KAAK,GAAe,EAAE,CAAC;QAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;YACpC,KAAK,CAAC,IAAI,CAAC;gBACT,IAAI;gBACJ,cAAc,EAAE,QAAQ,CAAC,cAAc;gBACvC,SAAS,EAAG,QAAQ,CAAC,IAAY,CAAC,OAAO,IAAI,KAAK;gBAClD,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,OAAO,EAAE,QAAQ,CAAC,OAAO;aAC1B,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,IAAY;QACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QACvC,OAAO;YACL,IAAI;YACJ,cAAc,EAAE,QAAQ,CAAC,cAAc;YACvC,SAAS,EAAG,QAAQ,CAAC,IAAY,CAAC,OAAO,IAAI,KAAK;YAClD,SAAS,EAAE,QAAQ,CAAC,SAAS;YAC7B,OAAO,EAAE,QAAQ,CAAC,OAAO;SAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,cAAsB;QAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,sBAAsB;QAC3B,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;YACpC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;IACjD,CAAC;CACF;AAED,4BAA4B;AAC5B,eAAe,aAAa,CAAC,WAAW,EAAE,CAAC"}

package/dist/ts/utils/index.d.ts

@@ -0,0 +1,49 @@
+interface RecursiveIteratorMeta {
+    node: any;
+    parent: any;
+    path: string[];
+}
+export declare const utils: {
+    isValidUuidV4: (input?: any) => boolean;
+    convertToIntegerArray(input?: any): number[];
+    convertToArray: (input: any) => string[];
+    isBlank: (str: any) => boolean;
+    getRouteType: (domain: string) => number;
+    isWebRoute: (sessionType: any) => boolean;
+    isApiRoute: (sessionType: any) => boolean;
+    isMobileRoute: (sessionType: any) => boolean;
+    isOtherRoute: (sessionType: any) => boolean;
+    recursiveOmitBy: (object: any, callback: (meta: RecursiveIteratorMeta) => boolean, ...recursiveIteratorOpts: any[]) => any;
+    /**
+     * Helper function to safely update JSONB columns in Sequelize models
+     *
+     * @param model - The Sequelize model instance
+     * @param columnName - The name of the JSONB column to update
+     * @param obj - The object to merge with existing column data
+     *
+     * Features:
+     * - Merges new data with existing data
+     * - Removes null/undefined values recursively
+     * - Only updates if data actually changed
+     * - Handles errors gracefully
+     * - Triggers sequelize's changed method to mark the column as changed *** VERY IMPORTANT ***
+     *
+     * Usage:
+     *   // In a model prototype method
+     *   Account.prototype.setOptions = function(obj) {
+     *     utils.setJSONBOptionsForColumn(this, "options", obj);
+     *   };
+     *
+     *   // Direct usage
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: null }); // will remove the field
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: undefined }); // will remove the field
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: "value" }); // will set the field
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: "value" } }); // will set the subfield
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: null } }); // will remove the subfield
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: undefined } }); // will remove the subfield
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: "value" } }); // will set the subfield
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: null } }); // will remove the subfield
+     */
+    setJSONBOptionsForColumn: (model: any, columnName: string, obj: any) => void;
+};
+export {};

package/dist/ts/utils/index.js

@@ -0,0 +1,162 @@
+import _ from "lodash";
+import RecursiveIterator from "recursive-iterator";
+import { TWS_ROUTE_TYPES } from "../constants/index.js";
+const { merge, isEqual } = _;
+import logger from "../logger/s4-logger.js";
+// Helper function to delete object properties by path
+const delObjectPath = (obj, path) => {
+    const keys = path.split(".");
+    const lastKey = keys.pop();
+    const target = keys.reduce((current, key) => current?.[key], obj);
+    if (target && Object.hasOwn(target, lastKey)) {
+        delete target[lastKey];
+    }
+};
+export const utils = {
+    isValidUuidV4: (input) => {
+        if (!input) {
+            return false;
+        }
+        else {
+            return /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(input);
+        }
+    },
+    // convert a regular string or Array to array (ie, "[1,2,3, 0xA]", "1,2,3,10")
+    // useful for controller inputs
+    // - also accepts hex
+    convertToIntegerArray(input) {
+        return this.convertToArray(input)
+            .filter((el) => /^[0-9]+/.test(el))
+            .map((el) => parseInt(el, 10))
+            .filter((el) => Number.isInteger(el));
+    },
+    convertToArray: (input) => {
+        if (Array.isArray(input)) {
+            return input;
+        }
+        else {
+            if (input) {
+                if (typeof input === "number") {
+                    return [input.toString()];
+                }
+                const matches = input.match(/\[(.*?)\]/);
+                if (matches) {
+                    input = matches[1];
+                }
+                input = input.replace(/[[\]]/, "");
+                return input
+                    .replace(/\s+/, "")
+                    .split(",")
+                    .filter((el) => /^[0-9A-Za-z-.]+/.test(el));
+            }
+            else {
+                return [];
+            }
+        }
+    },
+    isBlank: (str) => {
+        return str === null || str === undefined || /^\s*$/.test(str);
+    },
+    getRouteType: (domain) => {
+        if (!domain)
+            return -1;
+        let routeType;
+        switch (true) {
+            case /^(tws-web|local-gateway)/i.test(domain):
+                routeType = TWS_ROUTE_TYPES.web;
+                break;
+            case /^tws-mob/i.test(domain):
+                routeType = TWS_ROUTE_TYPES.mobile;
+                break;
+            case /^(tws-api-)/i.test(domain):
+                routeType = TWS_ROUTE_TYPES.api;
+                break;
+            default:
+                routeType = TWS_ROUTE_TYPES.other;
+        }
+        return routeType;
+    },
+    isWebRoute: (sessionType) => parseInt(sessionType, 10) === TWS_ROUTE_TYPES.web,
+    isApiRoute: (sessionType) => parseInt(sessionType, 10) === TWS_ROUTE_TYPES.api,
+    isMobileRoute: (sessionType) => parseInt(sessionType, 10) === TWS_ROUTE_TYPES.mobile,
+    isOtherRoute: (sessionType) => {
+        const value = parseInt(sessionType, 10);
+        return !!(value === TWS_ROUTE_TYPES.other || Number.isNaN(value));
+    },
+    recursiveOmitBy: (object, callback, ...recursiveIteratorOpts) => {
+        const results = merge({}, object);
+        for (const meta of new RecursiveIterator(object, ...recursiveIteratorOpts)) {
+            const shouldOmit = callback(meta);
+            if (shouldOmit) {
+                // Check if this is an array element
+                const pathParts = meta.path;
+                const lastPart = pathParts[pathParts.length - 1];
+                if (!Number.isNaN(Number(lastPart)) && Array.isArray(meta.parent)) {
+                    // This is an array element, remove it from the array
+                    const parentPath = pathParts.slice(0, -1).join(".");
+                    const parent = parentPath
+                        ? pathParts.slice(0, -1).reduce((current, key) => current?.[key], results)
+                        : results;
+                    if (parent && Array.isArray(parent[pathParts[pathParts.length - 2]])) {
+                        const arrayIndex = parseInt(lastPart, 10);
+                        parent[pathParts[pathParts.length - 2]].splice(arrayIndex, 1);
+                    }
+                }
+                else {
+                    // This is an object property, delete it
+                    delObjectPath(results, meta.path.join("."));
+                }
+            }
+        }
+        return results;
+    },
+    /**
+     * Helper function to safely update JSONB columns in Sequelize models
+     *
+     * @param model - The Sequelize model instance
+     * @param columnName - The name of the JSONB column to update
+     * @param obj - The object to merge with existing column data
+     *
+     * Features:
+     * - Merges new data with existing data
+     * - Removes null/undefined values recursively
+     * - Only updates if data actually changed
+     * - Handles errors gracefully
+     * - Triggers sequelize's changed method to mark the column as changed *** VERY IMPORTANT ***
+     *
+     * Usage:
+     *   // In a model prototype method
+     *   Account.prototype.setOptions = function(obj) {
+     *     utils.setJSONBOptionsForColumn(this, "options", obj);
+     *   };
+     *
+     *   // Direct usage
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: null }); // will remove the field
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: undefined }); // will remove the field
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: "value" }); // will set the field
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: "value" } }); // will set the subfield
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: null } }); // will remove the subfield
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: undefined } }); // will remove the subfield
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: "value" } }); // will set the subfield
+     *   utils.setJSONBOptionsForColumn(account, "auth_options", { field: { subfield: null } }); // will remove the subfield
+     */
+    setJSONBOptionsForColumn: (model, columnName, obj) => {
+        try {
+            if (!model[columnName])
+                model[columnName] = {};
+            // Merge incoming options
+            const newOptions = merge({}, model[columnName], obj);
+            // Clean null/undefined values
+            const cleaned = utils.recursiveOmitBy(newOptions, ({ node }) => node === undefined || node === null);
+            const isEqualResult = isEqual(model[columnName], cleaned);
+            if (!isEqualResult) {
+                model.set(columnName, JSON.parse(JSON.stringify(cleaned)));
+            }
+        }
+        catch (e) {
+            logger.warn(`Error setting ${columnName}:`, e);
+            throw e;
+        }
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/ts/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,iBAAiB,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;AAE7B,OAAO,MAAM,MAAM,wBAAwB,CAAC;AAE5C,sDAAsD;AACtD,MAAM,aAAa,GAAG,CAAC,GAAQ,EAAE,IAAY,EAAQ,EAAE;IACrD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAG,CAAC;IAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,OAAY,EAAE,GAAW,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/E,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;QAC7C,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;AACH,CAAC,CAAC;AAQF,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,aAAa,EAAE,CAAC,KAAW,EAAW,EAAE;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,+EAA+E,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrG,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,+BAA+B;IAC/B,qBAAqB;IACrB,qBAAqB,CAAC,KAAW;QAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;aAC9B,MAAM,CAAC,CAAC,EAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACvC,GAAG,CAAC,CAAC,EAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;aAClC,MAAM,CAAC,CAAC,EAAO,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,cAAc,EAAE,CAAC,KAAU,EAAY,EAAE;QACvC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC9B,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC5B,CAAC;gBACD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBACzC,IAAI,OAAO,EAAE,CAAC;oBACZ,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;gBACrB,CAAC;gBACD,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAEnC,OAAO,KAAK;qBACT,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;qBAClB,KAAK,CAAC,GAAG,CAAC;qBACV,MAAM,CAAC,CAAC,EAAO,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACrD,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,EAAE,CAAC,GAAQ,EAAW,EAAE;QAC7B,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,CAAC;IAED,YAAY,EAAE,CAAC,MAAc,EAAU,EAAE;QACvC,IAAI,CAAC,MAAM;YAAE,OAAO,CAAC,CAAC,CAAC;QAEvB,IAAI,SAAiB,CAAC;QAEtB,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC;gBAC3C,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC;gBAChC,MAAM;YACR,KAAK,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;gBAC3B,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC;gBACnC,MAAM;YACR,KAAK,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC;gBAC9B,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC;gBAChC,MAAM;YACR;gBACE,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC;QACtC,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,UAAU,EAAE,CAAC,WAAgB,EAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,KAAK,eAAe,CAAC,GAAG;IAC5F,UAAU,EAAE,CAAC,WAAgB,EAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,KAAK,eAAe,CAAC,GAAG;IAC5F,aAAa,EAAE,CAAC,WAAgB,EAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,KAAK,eAAe,CAAC,MAAM;IAClG,YAAY,EAAE,CAAC,WAAgB,EAAW,EAAE;QAC1C,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACxC,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,eAAe,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,eAAe,EAAE,CACf,MAAW,EACX,QAAkD,EAClD,GAAG,qBAA4B,EAC1B,EAAE;QACP,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAElC,KAAK,MAAM,IAAI,IAAI,IAAI,iBAAiB,CAAC,MAAM,EAAE,GAAG,qBAAqB,CAAC,EAAE,CAAC;YAC3E,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAElC,IAAI,UAAU,EAAE,CAAC;gBACf,oCAAoC;gBACpC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC;gBAC5B,MAAM,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAEjD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;oBAClE,qDAAqD;oBACrD,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACpD,MAAM,MAAM,GAAG,UAAU;wBACvB,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAY,EAAE,GAAW,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;wBACvF,CAAC,CAAC,OAAO,CAAC;oBACZ,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;wBACrE,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;wBAC1C,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;oBAChE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,wCAAwC;oBACxC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,wBAAwB,EAAE,CAAC,KAAU,EAAE,UAAkB,EAAE,GAAQ,EAAQ,EAAE;QAC3E,IAAI,CAAC;YACH,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBAAE,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;YAE/C,yBAAyB;YACzB,MAAM,UAAU,GAAG,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAC;YAErD,8BAA8B;YAC9B,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,CACnC,UAAU,EACV,CAAC,EAAE,IAAI,EAAyB,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,CACzE,CAAC;YAEF,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;YAE1D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,KAAK,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,IAAI,CAAC,iBAAiB,UAAU,GAAG,EAAE,CAAC,CAAC,CAAC;YAC/C,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;CACF,CAAC"}

package/last-commit.ts

@@ -0,0 +1,12 @@
+import lastCommit from "./ts/last-commit/index.js";
+
+lastCommit
+  .writeLastCommit()
+  .then((c) => {
+    console.debug("Last commit written");
+    console.debug(c);
+  })
+  .catch((e) => {
+    console.error("Failed to write last commit");
+    console.error(e);
+  });