@degenerate/events 0.0.1

package/README.md

@@ -0,0 +1,3 @@
+# @Degenerate/<new-package-name> Package
+
+This package contains the functions for <new-package-name>.  The package <what-the-purpose-of-the-package-is> in the SAFE environment.

package/dist/index.d.ts

@@ -0,0 +1 @@
+//# 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":""}

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+//#region Scheduler
+//#endregion Scheduler
+//#region Task
+//#endregion Task

package/dist/scheduler/index.d.ts

@@ -0,0 +1,2 @@
+export * from './scheduler';
+//# sourceMappingURL=index.d.ts.map

package/dist/scheduler/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/scheduler/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/dist/scheduler/index.js

@@ -0,0 +1,17 @@
+"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("./scheduler"), exports);

package/dist/scheduler/scheduler.d.ts

@@ -0,0 +1,35 @@
+/**
+ * This is a task scheduler for the safe network.
+ */
+export declare class SafeScheduler {
+    private tasks;
+    /**
+     * Add a new task to be executed at a specific date and time
+     *
+     * @param time the date and time to run the task
+     * @param callback the function to call
+     * @param interval the interval in milliseconds for repeating tasks
+     * @returns the task ID
+     */
+    scheduleTask(time: Date, callback: () => void, interval?: number | null): string;
+    /**
+     * Cancel a task by its ID and remove it from the scheduler
+     *
+     * @param taskId the ID of the task to remove
+     */
+    removeTask(taskId: string): void;
+    /**
+     * This function updates the time of a task by its ID.
+     *
+     * @param taskId the ID of the task to update
+     * @param newTime the new time to run the task
+     */
+    updateTaskTime(taskId: string, newTime: Date): void;
+    /**
+     * the function to schedule the next task based on the time.
+     * @param task the task to schedule or run right away.
+     */
+    private scheduleNextTask;
+    private runTask;
+}
+//# sourceMappingURL=scheduler.d.ts.map

package/dist/scheduler/scheduler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.d.ts","sourceRoot":"","sources":["../../src/scheduler/scheduler.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,qBAAa,aAAa;IACtB,OAAO,CAAC,KAAK,CAAkB;IAE/B;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,IAAI,EAAE,QAAQ,GAAE,MAAM,GAAG,IAAW,GAAG,MAAM;IAQtF;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAehC;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,GAAG,IAAI;IAcnD;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,OAAO;CAYlB"}

package/dist/scheduler/scheduler.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SafeScheduler = void 0;
+const generic_1 = require("@degenerate/generic");
+const task_1 = require("../task/task");
+/**
+ * This is a task scheduler for the safe network.
+ */
+class SafeScheduler {
+    constructor() {
+        this.tasks = []; // an array of tasks
+    }
+    /**
+     * Add a new task to be executed at a specific date and time
+     *
+     * @param time the date and time to run the task
+     * @param callback the function to call
+     * @param interval the interval in milliseconds for repeating tasks
+     * @returns the task ID
+     */
+    scheduleTask(time, callback, interval = null) {
+        const task = new task_1.SafeTask(time, callback, interval); // Create a new task
+        const taskId = task.id; // Get the task ID
+        this.tasks.push(task); // Add the task to the array
+        this.scheduleNextTask(task); // Schedule the task to run
+        return taskId;
+    }
+    /**
+     * Cancel a task by its ID and remove it from the scheduler
+     *
+     * @param taskId the ID of the task to remove
+     */
+    removeTask(taskId) {
+        const taskIndex = this.tasks.findIndex(task => task.id === taskId);
+        // make sure the task exists.
+        if (taskIndex !== -1) {
+            const task = this.tasks[taskIndex];
+            if (task.timeoutId) {
+                clearTimeout(task.timeoutId);
+            }
+            this.tasks.splice(taskIndex, 1); // Remove the task from the array
+            return;
+        }
+        // if the task does not exist, throw an error.
+        throw new generic_1.TaskNotFoundError(taskId.toString());
+    }
+    /**
+     * This function updates the time of a task by its ID.
+     *
+     * @param taskId the ID of the task to update
+     * @param newTime the new time to run the task
+     */
+    updateTaskTime(taskId, newTime) {
+        const task = this.tasks.find(task => task.id === taskId);
+        if (task) {
+            if (task.timeoutId) {
+                clearTimeout(task.timeoutId); // Clear the existing timeout
+            }
+            task.time = newTime; // Update the time
+            this.scheduleNextTask(task); // Reschedule the task
+            console.log(`Task ${taskId} rescheduled for ${newTime.toUTCString()}.`);
+        }
+        throw new generic_1.TaskNotFoundError(taskId);
+    }
+    // Helper to schedule the task based on date and time
+    /**
+     * the function to schedule the next task based on the time.
+     * @param task the task to schedule or run right away.
+     */
+    scheduleNextTask(task) {
+        const now = new Date().getTime();
+        const delay = task.time.getTime() - now;
+        if (delay <= 0) {
+            // If the time has already passed, execute the task immediately
+            this.runTask(task);
+        }
+        else {
+            // Schedule the task to run after the delay
+            task.timeoutId = setTimeout(() => {
+                this.runTask(task);
+            }, delay);
+        }
+    }
+    // Executes the task and reschedules it if it's a recurring task
+    runTask(task) {
+        task.callback();
+        if (task.interval !== null) {
+            // If the task is recurring, reschedule it based on the interval
+            task.time = new Date(new Date().getTime() + task.interval);
+            this.scheduleNextTask(task);
+        }
+        else {
+            // Remove the task once it has run if it's non-recurring
+            this.removeTask(task.id);
+        }
+    }
+}
+exports.SafeScheduler = SafeScheduler;

package/dist/task/index.d.ts

@@ -0,0 +1,2 @@
+export * from './task';
+//# sourceMappingURL=index.d.ts.map

package/dist/task/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/task/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC"}

package/dist/task/index.js

@@ -0,0 +1,17 @@
+"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("./task"), exports);

package/dist/task/task.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This is a task scheduler that allows you to schedule tasks to run at a
+ * specific time or at a specific interval.
+ */
+export declare class SafeTask {
+    private _id;
+    private _time;
+    private _callback;
+    private _interval;
+    private _timeoutId;
+    constructor(time: Date, callback: () => void, interval?: number | null, id?: string);
+    get id(): string;
+    get time(): Date;
+    set time(value: Date);
+    callback(): () => void;
+    get interval(): number | null;
+    get timeoutId(): NodeJS.Timeout | null;
+    set timeoutId(value: NodeJS.Timeout | null);
+    private generateId;
+}
+//# sourceMappingURL=task.d.ts.map

package/dist/task/task.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"task.d.ts","sourceRoot":"","sources":["../../src/task/task.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,qBAAa,QAAQ;IACjB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,KAAK,CAAO;IACpB,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,UAAU,CAAwB;gBAE9B,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,IAAI,EAAE,QAAQ,GAAE,MAAM,GAAG,IAAW,EAAE,EAAE,SAAK;IAarF,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,EAEnB;IAEM,QAAQ,IAAI,MAAM,IAAI;IAI7B,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAE5B;IAED,IAAI,SAAS,IAAI,MAAM,CAAC,OAAO,GAAG,IAAI,CAErC;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,EAEzC;IAID,OAAO,CAAC,UAAU;CAKrB"}

package/dist/task/task.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SafeTask = void 0;
+const generic_1 = require("@degenerate/generic");
+/**
+ * This is a task scheduler that allows you to schedule tasks to run at a
+ * specific time or at a specific interval.
+ */
+class SafeTask {
+    constructor(time, callback, interval = null, id = '') {
+        this._time = time;
+        this._callback = callback;
+        this._interval = interval;
+        this._timeoutId = null;
+        if (id) {
+            this._id = id; // use the provided id if available
+        }
+        else {
+            this._id = this.generateId(); // generate a unique id for the task based on the hash.
+        }
+    }
+    //#region Getters and Setters
+    get id() {
+        return this._id;
+    }
+    get time() {
+        return this._time;
+    }
+    set time(value) {
+        this._time = value;
+    }
+    callback() {
+        return this._callback;
+    }
+    get interval() {
+        return this._interval;
+    }
+    get timeoutId() {
+        return this._timeoutId;
+    }
+    set timeoutId(value) {
+        this._timeoutId = value;
+    }
+    // Setter methods to modify private properties if needed
+    generateId() {
+        const stringForId = this._time.toISOString() + JSON.stringify(this._callback);
+        const hashId = (0, generic_1.calculateHash)(stringForId, 'hex');
+        return hashId;
+    }
+}
+exports.SafeTask = SafeTask;

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@degenerate/events",
+  "version": "0.0.1",
+  "description": "This contains the ShareData Adaptive Framework Ecosystem (SAFE) network event code",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rm -rf dist/* && tsc -p tsconfig.pkg.json",
+    "compile": "rm -rf dist/* && tsc -p tsconfig.pkg.json",
+    "test": "jest --forceExit --detectOpenHandles --verbose --silent=false --env node --config tsconfig.pkg.json",
+    "test:coverage": "jest --forceExit --coverage --detectOpenHandles --verbose --silent=false --env node  --config tsconfig.pkg.json",
+    "test:clearCache": "jest --clearCache"
+  },
+  "keywords": [
+    "ShareData Adaptive Framework Ecosystem",
+    "SAFE EVENTS",
+    "SAFE",
+    "SAFE Generic",
+    "ShareData",
+    "ShareBlock"
+  ],
+  "author": "Degenerate Inc.",
+  "license": "ISC",
+  "dependencies": {
+    "@degenerate/generic": "^0.0.21"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.8.4",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.3"
+  },
+  "bugs": {
+    "url": "https://github.com/syncrude/safe/issues"
+  },
+  "homepage": "https://github.com/syncrude/safe#readme"
+}