eternal-timer 2.2.1 → 2.4.0

package/dist/esm/TimersManager/TimersManager.js

@@ -0,0 +1,205 @@
+import path from "path";
+import fs from "fs";
+import { v4 as uuidv4 } from "uuid";
+import searchRoot from "../searchRoot.js";
+import { TimersStore } from "../TimersStore/TimersStore.js";
+import { Log } from "../Log.js";
+/**
+ * TimersManager
+ * @description
+ * Manages timers stored in a file.
+ * (This is a abstract class)
+ *
+ * - Timers are persisted in a file
+ * - Expired timers are detected by polling
+ */
+export class TimersManager {
+    timerfiledir;
+    checkLock = false;
+    TimersStore = null;
+    queue = Promise.resolve();
+    runExclusive(fn) {
+        const p = this.queue.then(fn);
+        this.queue = p.then(() => { }, () => { });
+        return p;
+    }
+    /**
+      * constructor
+      * @description Initializes the TimersManager instance. If the timer file does not exist, an empty file is created.
+      * @param options (TimersManagerOptions | string, optional) Configuration object or timer file path. If a string is provided, it is treated as the timer file path. If an object is provided, `timerfiledir` can be specified.
+      * @throws If file access or creation fails
+      * @example
+      * const manager = new TimersManager(); // Uses default timer file path
+      * const manager = new TimersManager("/path/to/timers.txt"); // Uses specified timer file path
+      */
+    constructor(options) {
+        const rootDir = searchRoot();
+        this.timerfiledir = path.resolve(rootDir, options ?? this.getDefaultFilename());
+        if (!this.timerfiledir.startsWith(rootDir)) {
+            throw new Error(`Timer file path must be within the project directory`);
+        }
+        try {
+            fs.accessSync(this.timerfiledir);
+        }
+        catch {
+            fs.writeFileSync(this.timerfiledir, "");
+        }
+    }
+    /**
+     * createTimer
+     * @description Creates a new timer.
+     * @param length Timer duration in milliseconds
+     * @returns Promise that resolves to the timer ID (UUID)
+     * @throws If length is invalid(e.g. length < 0) or file operation fails
+     * @example
+     * const manager = new TimersManager();
+     * const newTimer = await manager.createTimer(5000);
+     * // newTimer will be id of the timer
+     */
+    async createTimer(options) {
+        return this.runExclusive(async () => {
+            this.TimersStore ??= await this.createTimersStore();
+            let length = typeof options === "object" ? options.length : options;
+            if (length < 0)
+                throw new Error(`Invalid length: ${length}`);
+            length = Math.trunc(length);
+            const id = uuidv4();
+            const now = Date.now();
+            const stopTime = now + Math.max(1, length);
+            const newTimerData = {
+                id,
+                start: now,
+                stop: stopTime,
+                ...(typeof options === "object" && options.title !== undefined && { title: options.title }),
+                ...(typeof options === "object" && options.description !== undefined && { description: options.description }),
+            };
+            await this.TimersStore.appendTimer(newTimerData);
+            return id;
+        });
+    }
+    /**
+     * removeTimer
+     * @description Removes a timer by ID.
+     * @param id ID of the timer to remove
+     * @returns void
+     * @throws If file operation fails
+     * @example
+     * await manager.removeTimer(id);
+     */
+    async removeTimer(id) {
+        return this.runExclusive(async () => {
+            this.TimersStore ??= await this.createTimersStore();
+            const timers = await this.TimersStore.loadTimers();
+            const index = timers.findIndex(t => t.id === id);
+            if (index === -1) {
+                throw new Error(`Timer with id ${id} not found`);
+            }
+            timers.splice(index, 1);
+            await this.TimersStore.saveTimers(timers);
+            return;
+        });
+    }
+    /**
+     * checkTimers
+     * @description Starts monitoring timers at the specified interval.
+     * When a timer expires, the provided `callback` is invoked with the timer.
+     * The callback is awaited before the next processing cycle continues.
+     * @param callback Function invoked when an expired timer is detected (called asynchronously)
+     * @param interval (number, optional): Check interval in milliseconds (default: 200ms)
+     * @throws If file operation fails
+     * @returns (Promise<NodeJS.Timeout>) intervalId interval id of checkTimers
+     * @example
+     * const interval = await manager.checkTimers((timer) => {
+     *     console.log(`A timer was stopped: ${timer.id}`);
+     * });
+     */
+    async checkTimers(callback, interval = 200) {
+        this.TimersStore ??= await this.createTimersStore();
+        const loop = async () => {
+            if (this.checkLock) {
+                return;
+            }
+            this.checkLock = true;
+            try {
+                const expiredTimers = await this.runExclusive(async () => {
+                    const allTimers = await this.TimersStore.loadTimers();
+                    const now = Date.now();
+                    const expired = [];
+                    const active = [];
+                    for (const timer of allTimers) {
+                        if (timer.stop <= now) {
+                            expired.push(timer);
+                        }
+                        else {
+                            active.push(timer);
+                        }
+                    }
+                    if (expired.length > 0) {
+                        await this.TimersStore.saveTimers(active);
+                    }
+                    return expired;
+                });
+                for (const timerData of expiredTimers) {
+                    try {
+                        await callback(timerData);
+                    }
+                    catch (e) {
+                        await Log.ensureLogger();
+                        Log.loggerInstance?.error(`Error in callback of checkTimers: ${e}`);
+                    }
+                }
+            }
+            catch (e) {
+                await Log.ensureLogger();
+                Log.loggerInstance?.error(`Error when checking timer: ${e}`);
+            }
+            finally {
+                this.checkLock = false;
+            }
+        };
+        return setInterval(loop, interval);
+    }
+    /**
+     * showTimers
+     * @description Retrieves all active timers.
+     * @returns Array of `Timer` objects
+     * @throws If file operation fails
+     * @example
+     * const timers = await manager.showTimers();
+     * console.log(JSON.stringify(timers))
+     */
+    async showTimers() {
+        return this.runExclusive(async () => {
+            this.TimersStore ??= await this.createTimersStore();
+            const timersData = await this.TimersStore.loadTimers();
+            return timersData;
+        });
+    }
+    /**
+      * adjustRemainingTime
+      * @description Adjusts the remaining time of a timer.
+      * @param id ID of the timer to modify
+      * @param delay Delay in milliseconds to add/subtract from the remaining time
+      * @returns Promise resolving when the operation is complete
+      * @throws If file operation fails
+      */
+    async adjustRemainingTime(id, delay) {
+        return this.runExclusive(async () => {
+            this.TimersStore ??= await this.createTimersStore();
+            const timers = await this.TimersStore.loadTimers();
+            const index = timers.findIndex(t => t.id === id);
+            if (index === -1) {
+                throw new Error(`Timer with id ${id} not found`);
+            }
+            const now = Date.now();
+            const timer = timers[index];
+            const remaining = Math.max(0, timer.stop - now);
+            const newRemaining = Math.max(0, remaining + delay);
+            timer.stop = now + newRemaining;
+            timers[index] = timer;
+            await this.TimersStore.saveTimers(timers);
+            return;
+        });
+    }
+}
+//# sourceMappingURL=TimersManager.js.map

package/dist/esm/TimersManager/TimersManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimersManager.js","sourceRoot":"","sources":["../../../src/TimersManager/TimersManager.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhC;;;;;;;;GAQG;AACH,MAAM,OAAgB,aAAa;IACf,YAAY,CAAS;IAChC,SAAS,GAAY,KAAK,CAAC;IAEzB,WAAW,GAA0B,IAAI,CAAC;IAE5C,KAAK,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;IACzC,YAAY,CAAI,EAAoB;QAC3C,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACxC,OAAO,CAAC,CAAC;IACV,CAAC;IAKD;;;;;;;;QAQO;IACP,YACC,OAAgB;QAEhB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,CAAC;YACJ,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC;YACR,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QACzC,CAAC;IACF,CAAC;IAED;;;;;;;;;;OAUM;IACC,KAAK,CAAC,WAAW,CAAC,OAA8B;QACtD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACnC,IAAI,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAEpD,IAAI,MAAM,GAAW,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YAC5E,IAAI,MAAM,GAAG,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;YAE7D,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAE5B,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAE3C,MAAM,YAAY,GAAa;gBAC9B,EAAE;gBACF,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,QAAQ;gBACd,GAAG,CAAC,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;gBAC3F,GAAG,CAAC,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;aAC7G,CAAC;YAEF,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACjD,OAAO,EAAE,CAAC;QACX,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQM;IACC,KAAK,CAAC,WAAW,CAAC,EAAU;QAClC,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACnC,IAAI,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;YAEnD,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YACjD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACxB,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,OAAO;QACR,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaM;IACC,KAAK,CAAC,WAAW,CAAC,QAAmD,EAAE,WAAmB,GAAG;QAEnG,IAAI,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEpD,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;YACvB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACpB,OAAO;YACR,CAAC;YAED,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC;gBACJ,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;oBACxD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAY,CAAC,UAAU,EAAE,CAAC;oBACvD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAEvB,MAAM,OAAO,GAAe,EAAE,CAAC;oBAC/B,MAAM,MAAM,GAAe,EAAE,CAAC;oBAE9B,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;wBAC/B,IAAI,KAAK,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;4BACvB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;wBACrB,CAAC;6BAAM,CAAC;4BACP,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;wBACpB,CAAC;oBACF,CAAC;oBAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACxB,MAAM,IAAI,CAAC,WAAY,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;oBAC5C,CAAC;oBAED,OAAO,OAAO,CAAC;gBAChB,CAAC,CAAC,CAAC;gBAEH,KAAK,MAAM,SAAS,IAAI,aAAa,EAAE,CAAC;oBACvC,IAAI,CAAC;wBACJ,MAAM,QAAQ,CAAC,SAAS,CAAC,CAAC;oBAC3B,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACZ,MAAM,GAAG,CAAC,YAAY,EAAE,CAAC;wBACzB,GAAG,CAAC,cAAc,EAAE,KAAK,CACxB,qCAAqC,CAAC,EAAE,CACxC,CAAC;oBACH,CAAC;gBACF,CAAC;YAEF,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACZ,MAAM,GAAG,CAAC,YAAY,EAAE,CAAC;gBACzB,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;YAC9D,CAAC;oBAAS,CAAC;gBACV,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACxB,CAAC;QACF,CAAC,CAAC;QACF,OAAO,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQM;IACC,KAAK,CAAC,UAAU;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACnC,IAAI,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACpD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;YACvD,OAAO,UAAU,CAAC;QACnB,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;QAOO;IACA,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,KAAa;QACzD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACnC,IAAI,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;YAEnD,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YACjD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEvB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;YAChD,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,CAAC;YAEpD,KAAK,CAAC,IAAI,GAAG,GAAG,GAAG,YAAY,CAAC;YAChC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;YACtB,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,OAAO;QACR,CAAC,CAAC,CAAC;IACH,CAAC;CACF"}

package/dist/esm/TimersStore/JSONLTimersStore.d.ts

@@ -0,0 +1,16 @@
+import type { Timer } from "../types.js";
+import { TimersStore } from "./TimersStore.js";
+export declare class JSONLTimersStore extends TimersStore<"JSONL"> {
+    constructor(timerfile: string);
+    /**
+     * checkTimerfileSyntax
+     * @description Checks the syntax of the timer file.
+     * @param timers Array of timer objects to check
+     * @returns void
+     * @throws If syntax is invalid
+     */
+    protected checkTimerfileSyntax(timers: Timer<"JSONL">[]): Promise<void>;
+    toStringifyTimers(timers: Timer<"JSONL">[]): string;
+    parseTimers(data: string): Timer<"JSONL">[];
+}
+//# sourceMappingURL=JSONLTimersStore.d.ts.map

package/dist/esm/TimersStore/JSONLTimersStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONLTimersStore.d.ts","sourceRoot":"","sources":["../../../src/TimersStore/JSONLTimersStore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,qBAAa,gBAAiB,SAAQ,WAAW,CAAC,OAAO,CAAC;gBAGxD,SAAS,EAAE,MAAM;IAKlB;;;;;;OAMG;cACsB,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IActE,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,GAAG,MAAM;IAOnD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE;CAM3D"}

package/dist/esm/TimersStore/JSONLTimersStore.js

@@ -0,0 +1,46 @@
+import { validate } from "uuid";
+import { TimersStore } from "./TimersStore.js";
+export class JSONLTimersStore extends TimersStore {
+    constructor(timerfile) {
+        super(timerfile);
+    }
+    /**
+     * checkTimerfileSyntax
+     * @description Checks the syntax of the timer file.
+     * @param timers Array of timer objects to check
+     * @returns void
+     * @throws If syntax is invalid
+     */
+    async checkTimerfileSyntax(timers) {
+        const throwing = () => {
+            throw new Error(`Timer file's syntax is wrong`);
+        };
+        for (const timer of timers) {
+            if (!timer.id || !validate(timer.id))
+                throwing();
+            if (!timer.start || typeof timer.start !== "number")
+                throwing();
+            if (!timer.stop || typeof timer.stop !== "number")
+                throwing();
+            if (timer.start > timer.stop)
+                throwing();
+            if (timer.title && typeof timer.title !== "string")
+                throwing();
+            if (timer.description && typeof timer.description !== "string")
+                throwing();
+        }
+    }
+    toStringifyTimers(timers) {
+        if (timers.length === 0) {
+            return "";
+        }
+        return timers.map(t => JSON.stringify(t)).join("\n");
+    }
+    parseTimers(data) {
+        return data
+            .split(/\r?\n/)
+            .filter((line) => line.trim())
+            .map((line) => JSON.parse(line));
+    }
+}
+//# sourceMappingURL=JSONLTimersStore.js.map

package/dist/esm/TimersStore/JSONLTimersStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONLTimersStore.js","sourceRoot":"","sources":["../../../src/TimersStore/JSONLTimersStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAGhC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,OAAO,gBAAiB,SAAQ,WAAoB;IAEzD,YACC,SAAiB;QAEjB,KAAK,CAAC,SAAS,CAAC,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACgB,KAAK,CAAC,oBAAoB,CAAC,MAAwB;QACrE,MAAM,QAAQ,GAAG,GAAG,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAAE,QAAQ,EAAE,CAAC;YACjD,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;gBAAE,QAAQ,EAAE,CAAC;YAChE,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;gBAAE,QAAQ,EAAE,CAAC;YAC9D,IAAI,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI;gBAAE,QAAQ,EAAE,CAAC;YACzC,IAAI,KAAK,CAAC,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;gBAAE,QAAQ,EAAE,CAAC;YAC/D,IAAI,KAAK,CAAC,WAAW,IAAI,OAAO,KAAK,CAAC,WAAW,KAAK,QAAQ;gBAAE,QAAQ,EAAE,CAAC;QAC5E,CAAC;IACF,CAAC;IAEe,iBAAiB,CAAC,MAAwB;QACzD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACX,CAAC;QACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAEe,WAAW,CAAC,IAAY;QACvC,OAAO,IAAI;aACT,KAAK,CAAC,OAAO,CAAC;aACd,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAmB,CAAC,CAAC;IACrD,CAAC;CACD"}

package/dist/esm/TimersStore/PlainTextTimersStore.d.ts

@@ -0,0 +1,16 @@
+import type { Timer } from "../types.js";
+import { TimersStore } from "./TimersStore.js";
+export declare class PlainTextTimersStore extends TimersStore<"PlainText"> {
+    constructor(timerfile: string);
+    /**
+     * checkTimerfileSyntax
+     * @description Checks the syntax of the timer file.
+     * @param fileData
+     * @returns void
+     * @throws If syntax is invalid
+     */
+    protected checkTimerfileSyntax(timers: Timer<"PlainText">[]): Promise<void>;
+    toStringifyTimers(timers: Timer<"PlainText">[]): string;
+    parseTimers(data: string): Timer<"PlainText">[];
+}
+//# sourceMappingURL=PlainTextTimersStore.d.ts.map

package/dist/esm/TimersStore/PlainTextTimersStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlainTextTimersStore.d.ts","sourceRoot":"","sources":["../../../src/TimersStore/PlainTextTimersStore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,qBAAa,oBAAqB,SAAQ,WAAW,CAAC,WAAW,CAAC;gBAGhE,SAAS,EAAE,MAAM;IAKlB;;;;;;OAMM;cACmB,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAc1E,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM;IAOvD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,EAAE;CAa/D"}

package/dist/esm/TimersStore/PlainTextTimersStore.js

@@ -0,0 +1,52 @@
+import { validate } from "uuid";
+import { TimersStore } from "./TimersStore.js";
+export class PlainTextTimersStore extends TimersStore {
+    constructor(timerfile) {
+        super(timerfile);
+    }
+    /**
+     * checkTimerfileSyntax
+     * @description Checks the syntax of the timer file.
+     * @param fileData
+     * @returns void
+     * @throws If syntax is invalid
+     */
+    async checkTimerfileSyntax(timers) {
+        const throwing = () => {
+            throw new Error(`Timer file's syntax is wrong`);
+        };
+        for (const timer of timers) {
+            if (Object.keys(timer).length !== 3)
+                throwing();
+            if (!validate(timer.id))
+                throwing();
+            if (isNaN(Number(timer.start)))
+                throwing();
+            if (isNaN(Number(timer.stop)))
+                throwing();
+            if (Number(timer.start) > Number(timer.stop))
+                throwing();
+        }
+        return;
+    }
+    toStringifyTimers(timers) {
+        if (timers.length === 0) {
+            return "";
+        }
+        return timers.map(timer => `${timer.id} ${timer.start} ${timer.stop}`).join("\n");
+    }
+    parseTimers(data) {
+        return data
+            .split(/\r?\n/)
+            .filter((line) => line.trim())
+            .map((line) => {
+            const [id, startStr, stopStr] = line.split(" ");
+            return {
+                id: id,
+                start: Number(startStr),
+                stop: Number(stopStr),
+            };
+        });
+    }
+}
+//# sourceMappingURL=PlainTextTimersStore.js.map

package/dist/esm/TimersStore/PlainTextTimersStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlainTextTimersStore.js","sourceRoot":"","sources":["../../../src/TimersStore/PlainTextTimersStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAGhC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,OAAO,oBAAqB,SAAQ,WAAwB;IAEjE,YACC,SAAiB;QAEjB,KAAK,CAAC,SAAS,CAAC,CAAC;IAClB,CAAC;IAED;;;;;;OAMM;IACa,KAAK,CAAC,oBAAoB,CAAC,MAA4B;QACzE,MAAM,QAAQ,GAAG,GAAG,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC;gBAAE,QAAQ,EAAE,CAAC;YAChD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAAE,QAAQ,EAAE,CAAC;YACpC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAAE,QAAQ,EAAE,CAAC;YAC3C,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAAE,QAAQ,EAAE,CAAC;YAC1C,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;gBAAE,QAAQ,EAAE,CAAC;QAC1D,CAAC;QACD,OAAO;IACR,CAAC;IAEe,iBAAiB,CAAC,MAA4B;QAC7D,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACX,CAAC;QACD,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnF,CAAC;IAEe,WAAW,CAAC,IAAY;QACvC,OAAO,IAAI;aACT,KAAK,CAAC,OAAO,CAAC;aACd,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACb,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAChD,OAAO;gBACN,EAAE,EAAE,EAAG;gBACP,KAAK,EAAE,MAAM,CAAC,QAAS,CAAC;gBACxB,IAAI,EAAE,MAAM,CAAC,OAAQ,CAAC;aACA,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC;CACD"}

package/dist/esm/TimersStore/TimersStore.d.ts

@@ -0,0 +1,12 @@
+import type { StorageType, Timer } from "../types.js";
+export declare abstract class TimersStore<T extends StorageType> {
+    protected readonly timerfile: string;
+    protected constructor(timerfile: string);
+    loadTimers(): Promise<Timer<T>[]>;
+    saveTimers(timers: Timer<T>[]): Promise<void>;
+    appendTimer(timer: Timer<T>): Promise<void>;
+    protected abstract checkTimerfileSyntax(timers: Timer<T>[]): Promise<void>;
+    abstract toStringifyTimers(timers: Timer<T>[]): string;
+    abstract parseTimers(data: string): Timer<T>[];
+}
+//# sourceMappingURL=TimersStore.d.ts.map

package/dist/esm/TimersStore/TimersStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimersStore.d.ts","sourceRoot":"","sources":["../../../src/TimersStore/TimersStore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEtD,8BAAsB,WAAW,CAAC,CAAC,SAAS,WAAW;IACtD,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAErC,SAAS,aACR,SAAS,EAAE,MAAM;IAKL,UAAU,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAWjC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAU7C,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IASrD,SAAS,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;aAC1D,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM;aAChD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE;CACrD"}

package/dist/esm/TimersStore/TimersStore.js

@@ -0,0 +1,37 @@
+import fs from "fs";
+export class TimersStore {
+    timerfile;
+    constructor(timerfile) {
+        this.timerfile = timerfile;
+    }
+    async loadTimers() {
+        try {
+            const data = await fs.promises.readFile(this.timerfile, "utf-8");
+            const timersData = this.parseTimers(data);
+            await this.checkTimerfileSyntax(timersData);
+            return timersData;
+        }
+        catch (e) {
+            throw new Error("Error when loading timer data", { cause: e });
+        }
+    }
+    async saveTimers(timers) {
+        const data = this.toStringifyTimers(timers);
+        try {
+            await fs.promises.writeFile(this.timerfile, data, "utf-8");
+        }
+        catch (e) {
+            throw new Error(`Error when saving timer data`, { cause: e });
+        }
+    }
+    async appendTimer(timer) {
+        try {
+            await fs.promises.appendFile(this.timerfile, this.toStringifyTimers([timer]) + "\n");
+            return;
+        }
+        catch (e) {
+            throw new Error(`Error when appending timer data`, { cause: e });
+        }
+    }
+}
+//# sourceMappingURL=TimersStore.js.map

package/dist/esm/TimersStore/TimersStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimersStore.js","sourceRoot":"","sources":["../../../src/TimersStore/TimersStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AAIpB,MAAM,OAAgB,WAAW;IACb,SAAS,CAAS;IAErC,YACC,SAAiB;QAEjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,UAAU;QACtB,IAAI,CAAC;YACJ,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACjE,MAAM,UAAU,GAAe,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACtD,MAAM,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;YAC5C,OAAO,UAAU,CAAC;QACnB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAChE,CAAC;IACF,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,MAAkB;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAE5C,IAAI,CAAC;YACJ,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC/D,CAAC;IACF,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,KAAe;QACvC,IAAI,CAAC;YACJ,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;YACrF,OAAO;QACR,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAClE,CAAC;IACF,CAAC;CAKD"}

package/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
-export type { Timer } from "./types.js";
-export { JSONLTimersManager } from "./JSONLTimersManager.js";
-export { PlainTextTimersManager } from "./PlainTextTimersManager.js";
+export type { Timer, CreateTimerOptions, StorageType } from "./types.js";
+export { JSONLTimersManager } from "./TimersManager/JSONLTimersManager.js";
+export { PlainTextTimersManager } from "./TimersManager/PlainTextTimersManager.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,2CAA2C,CAAC"}

package/dist/esm/index.js

@@ -1,3 +1,3 @@
-export { JSONLTimersManager } from "./JSONLTimersManager.js";
-export { PlainTextTimersManager } from "./PlainTextTimersManager.js";
+export { JSONLTimersManager } from "./TimersManager/JSONLTimersManager.js";
+export { PlainTextTimersManager } from "./TimersManager/PlainTextTimersManager.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,2CAA2C,CAAC"}

package/dist/esm/types.d.ts

@@ -1,8 +1,18 @@
-export type Timer = {
+export type StorageType = "JSONL" | "PlainText";
+export type Timer<T extends StorageType> = T extends "JSONL" ? {
     id: string;
     start: number;
     stop: number;
     title?: string;
     description?: string;
+} : {
+    id: string;
+    start: number;
+    stop: number;
 };
+export type CreateTimerOptions<T extends StorageType> = T extends "JSONL" ? {
+    length: number;
+    title?: string;
+    description?: string;
+} | number : T extends "PlainText" ? number : never;
 //# sourceMappingURL=types.d.ts.map

package/dist/esm/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,KAAK,GAAG;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,WAAW,CAAC;AAEhD,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,WAAW,IACnC,CAAC,SAAS,OAAO,GACX;IACI,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,GACD;IACI,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEZ,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,OAAO,GACnE;IACI,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,GAAG,MAAM,GACV,CAAC,SAAS,WAAW,GACnB,MAAM,GACN,KAAK,CAAC"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "eternal-timer",
-  "version": "2.2.1",
+  "version": "2.4.0",
   "description": "timer for node.js package",
   "scripts": {
     "dev": "nodemon --watch src --exec ts-node src/index.ts",
     "build": "tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && node scripts/rename-cjs.js",
     "start": "npm run build && node dist/esm/index.js",
     "lint": "npx eslint --fix --config ./eslint/eslint.config.ts",
-    "test": "node test/index.js"
+    "test": "npm run build && node test/index.js"
   },
   "repository": {
     "type": "git",
@@ -40,10 +40,13 @@
     ".": {
       "import": "./dist/esm/index.js",
       "require": "./dist/cjs/index.cjs",
-      "types": "./dist/esm/index.d.ts"
+      "types": {
+        "import": "./dist/esm/index.d.ts",
+        "require": "./dist/cjs/index.d.ts"
+      }
     }
   },
-  "types": "dist/esm/index.d.ts",
+  "types": "dist/cjs/index.d.ts",
   "dependencies": {
     "uuid": "^13.0.0"
   },