eternal-timer 2.1.0 → 2.2.1

package/dist/esm/PlainTextTimersManager.js

@@ -0,0 +1,193 @@
+import fs from "fs";
+import { v4 as uuidv4 } from "uuid";
+import readline from "readline";
+import { TimersManager } from "./TimersManager.js";
+import { Log } from "./Log.js";
+export class PlainTextTimersManager extends TimersManager {
+    getDefaultFilename() {
+        return ".timers";
+    }
+    /**
+     * checkTimerfileSyntax
+     * @description Checks the syntax of the timer file.
+     * @param fileData
+     * @returns void
+     * @throws If syntax is invalid
+     */
+    async checkTimerfileSyntax(fileData) {
+        const throwing = () => {
+            throw new Error(`Timer file's syntax is wrong`);
+        };
+        const timersData = fileData
+            .split('\n')
+            .map(l => l.trim())
+            .filter(l => l !== "");
+        for (const timerData of timersData) {
+            const timerArray = timerData.split(/\s+/);
+            if (timerArray.length !== 3)
+                throwing();
+            if (timerArray[0]?.length !== 36)
+                throwing();
+            if (timerArray[1].trim() === "")
+                throwing();
+            if (timerArray[2].trim() === "")
+                throwing();
+        }
+        return;
+    }
+    /**
+     * createTimer
+     * @description Creates a new timer.
+     * @param length
+     * @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 PlainTextTimersManager();
+     * const newTimer = await manager.createTimer(5000);
+     * // newTimer will be id of the timer
+     */
+    async createTimer(length) {
+        try {
+            if (length < 0) {
+                throw new Error(`Invailed length: ${length}`);
+            }
+            const timersRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
+            await this.checkTimerfileSyntax(timersRaw);
+            length = Math.trunc(length);
+            // uuid, start, end
+            const id = uuidv4();
+            const now = Date.now();
+            const newTimerData = `${id} ${now.toString()} ${(now + length).toString()}`;
+            await fs.promises.appendFile(this.timerfiledir, newTimerData + "\n");
+            return id;
+        }
+        catch (e) {
+            throw new Error(`Error when creating timer: ${e}`);
+        }
+    }
+    /**
+     * 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) {
+        try {
+            const timersRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
+            await this.checkTimerfileSyntax(timersRaw);
+            const rl = readline.createInterface({
+                input: fs.createReadStream(this.timerfiledir),
+                crlfDelay: Infinity,
+            });
+            const newTimersDataLines = [];
+            let found = false;
+            for await (const line of rl) {
+                if (!line.trim())
+                    continue;
+                const [timerId] = line.split(" ");
+                if (timerId === id) {
+                    found = true;
+                    continue;
+                }
+                newTimersDataLines.push(line);
+            }
+            if (!found) {
+                throw new Error(`Timer with id ${id} not found`);
+            }
+            await fs.promises.writeFile(this.timerfiledir, newTimersDataLines.join("\n"), "utf-8");
+            return;
+        }
+        catch (e) {
+            throw new Error(`Error when removing timer: ${e}`);
+        }
+    }
+    /**
+     * checkTimers
+     * @description Starts monitoring expired timers asynchronously and returns immediately. The callback is invoked asynchronously when a timer expires.
+     * The callback is awaited before continuing.
+     * @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 (NodeJS.Timeout) intervalId interval id of checkTimers
+     * @example
+     * const interval = manager.checkTimers((timer) => {
+     *     console.log(`A timer was stopped: ${timer.id}`);
+     * });
+     */
+    checkTimers(callback, interval = 200) {
+        return setInterval(async () => {
+            if (this.checkLock)
+                return;
+            this.checkLock = true;
+            try {
+                const rl = readline.createInterface({
+                    input: fs.createReadStream(this.timerfiledir),
+                    crlfDelay: Infinity,
+                });
+                for await (const line of rl) {
+                    if (!line.trim())
+                        continue;
+                    const [id, startStr, stopStr] = line.split(" ");
+                    const timer = {
+                        id: id,
+                        start: Number(startStr),
+                        stop: Number(stopStr),
+                    };
+                    const now = Date.now();
+                    if (Number(timer.stop) <= now) {
+                        await this.removeTimer(timer.id);
+                        callback(timer).catch(async (e) => {
+                            await Log.ensureLogger();
+                            if (Log.loggerInstance) {
+                                Log.loggerInstance.error(`Error in timer callback: ${e}`);
+                            }
+                        });
+                    }
+                }
+            }
+            catch (e) {
+                await Log.ensureLogger();
+                if (Log.loggerInstance) {
+                    Log.loggerInstance.error(`Error when checking alarm: ${e}`);
+                }
+            }
+            finally {
+                this.checkLock = false;
+            }
+        }, 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() {
+        try {
+            const timersRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
+            const timersData = timersRaw.split(/\r?\n/);
+            const timersJSON = [];
+            for (const timerData of timersData) {
+                const splitedTimerData = timerData.split(" ");
+                if (!timerData.trim())
+                    continue;
+                timersJSON.push({
+                    id: splitedTimerData[0],
+                    start: Number(splitedTimerData[1]),
+                    stop: Number(splitedTimerData[2]),
+                });
+            }
+            return timersJSON;
+        }
+        catch (e) {
+            throw new Error(`Error when showing timers: ${e}`);
+        }
+    }
+}
+//# sourceMappingURL=PlainTextTimersManager.js.map

package/dist/esm/PlainTextTimersManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlainTextTimersManager.js","sourceRoot":"","sources":["../../src/PlainTextTimersManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,QAAQ,MAAM,UAAU,CAAC;AAGhC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,MAAM,OAAO,sBAAuB,SAAQ,aAAa;IAC9C,kBAAkB;QAC3B,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QACpD,MAAM,QAAQ,GAAG,GAAG,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,QAAQ;aACzB,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aAClB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QACxB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACpC,MAAM,UAAU,GAAa,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;gBAAE,QAAQ,EAAE,CAAC;YACxC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,EAAE;gBAAE,QAAQ,EAAE,CAAC;YAC7C,IAAI,UAAU,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,KAAK,EAAE;gBAAE,QAAQ,EAAE,CAAC;YAC7C,IAAI,UAAU,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,KAAK,EAAE;gBAAE,QAAQ,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO;IACR,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,WAAW,CAAC,MAAc;QACtC,IAAI,CAAC;YACJ,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,EAAE,CAAC,CAAC;YAC/C,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACzE,MAAM,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAE3C,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAE5B,mBAAmB;YACnB,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;YACpB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,YAAY,GAAG,GAAG,EAAE,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC5E,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC,CAAC;YACrE,OAAO,EAAE,CAAC;QACX,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;IACF,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,WAAW,CAAC,EAAU;QAClC,IAAI,CAAC;YACJ,MAAM,SAAS,GAAW,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACjF,MAAM,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAE3C,MAAM,EAAE,GAAG,QAAQ,CAAC,eAAe,CAAC;gBACnC,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC7C,SAAS,EAAE,QAAQ;aACnB,CAAC,CAAC;YACH,MAAM,kBAAkB,GAAa,EAAE,CAAC;YACxC,IAAI,KAAK,GAAG,KAAK,CAAC;YAClB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC;gBAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;oBAAE,SAAS;gBAC3B,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClC,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;oBACpB,KAAK,GAAG,IAAI,CAAC;oBACb,SAAS;gBACV,CAAC;gBACD,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;YAClD,CAAC;YACD,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YACvF,OAAO;QACR,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,WAAW,CAAC,QAAyC,EAAE,WAAmB,GAAG;QACnF,OAAO,WAAW,CAAC,KAAK,IAAI,EAAE;YAC7B,IAAI,IAAI,CAAC,SAAS;gBAAE,OAAO;YAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC;gBACJ,MAAM,EAAE,GAAG,QAAQ,CAAC,eAAe,CAAC;oBACnC,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC;oBAC7C,SAAS,EAAE,QAAQ;iBACnB,CAAC,CAAC;gBAEH,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC;oBAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;wBAAE,SAAS;oBAC3B,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAChD,MAAM,KAAK,GAAU;wBACpB,EAAE,EAAE,EAAG;wBACP,KAAK,EAAE,MAAM,CAAC,QAAS,CAAC;wBACxB,IAAI,EAAE,MAAM,CAAC,OAAQ,CAAC;qBACtB,CAAC;oBACF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBACvB,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;wBAC/B,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;wBACjC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;4BACjC,MAAM,GAAG,CAAC,YAAY,EAAE,CAAC;4BACzB,IAAI,GAAG,CAAC,cAAc,EAAE,CAAC;gCACxB,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,4BAA4B,CAAC,EAAE,CAAC,CAAC;4BAC3D,CAAC;wBACF,CAAC,CAAC,CAAC;oBACJ,CAAC;gBACF,CAAC;YACF,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACZ,MAAM,GAAG,CAAC,YAAY,EAAE,CAAC;gBACzB,IAAI,GAAG,CAAC,cAAc,EAAE,CAAC;oBACxB,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;gBAC7D,CAAC;YACF,CAAC;oBAAS,CAAC;gBACV,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACxB,CAAC;QACF,CAAC,EAAE,QAAQ,CAAC,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,UAAU;QACtB,IAAI,CAAC;YACJ,MAAM,SAAS,GAAW,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACjF,MAAM,UAAU,GAAa,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAEtD,MAAM,UAAU,GAAY,EAAE,CAAC;YAC/B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;gBACpC,MAAM,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC9C,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;oBAAE,SAAS;gBAChC,UAAU,CAAC,IAAI,CAAC;oBACf,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAE;oBACxB,KAAK,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAE,CAAC;oBACnC,IAAI,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAE,CAAC;iBAClC,CAAC,CAAC;YACJ,CAAC;YACD,OAAO,UAAU,CAAC;QACnB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;IACF,CAAC;CACD"}

package/dist/esm/TimersManager.d.ts

@@ -0,0 +1,75 @@
+import type { Timer } from "./types.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 declare abstract class TimersManager {
+    protected readonly timerfiledir: string;
+    protected checkLock: boolean;
+    protected abstract getDefaultFilename(): string;
+    /**
+     * constructor
+     * @param timerfiledir(string, optional)
+     * If omitted, `.timers.jsonl` under the project root is used.
+     */
+    constructor(timerfiledir?: string);
+    /**
+     * checkTimerfileSyntax
+     * @description Checks the syntax of the timer file.
+     * @param fileData
+     * @returns void
+     * @throws If syntax is invalid
+     */
+    protected abstract checkTimerfileSyntax(fileData: string): Promise<void>;
+    /**
+     * 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
+     */
+    abstract createTimer(length: number, title?: string, description?: string): Promise<string>;
+    /**
+     * 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);
+     */
+    abstract removeTimer(id: string): Promise<void>;
+    /**
+     * @description Starts monitoring expired timers asynchronously and returns immediately. The callback is invoked asynchronously when a timer expires.
+     * The callback is awaited before continuing.
+     * @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 (NodeJS.Timeout) intervalId interval id of checkTimers
+     * @example
+     * const interval = manager.checkTimers((timer) => {
+     *     console.log(`A timer was stopped: ${timer.id}`);
+     * });
+     */
+    abstract checkTimers(callback: (timer: Timer) => Promise<void>, interval?: number): NodeJS.Timeout;
+    /**
+     * 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))
+     */
+    abstract showTimers(): Promise<Timer[]>;
+}
+//# sourceMappingURL=TimersManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TimersManager.d.ts","sourceRoot":"","sources":["../../src/TimersManager.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;GAQG;AACH,8BAAsB,aAAa;IAClC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IACxC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAS;IAErC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,MAAM;IAE/C;;;;OAIM;gBAEL,YAAY,CAAC,EAAE,MAAM;IAYtB;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAExE;;;;;;;;;;OAUM;aACU,WAAW,CAAC,MAAM,EAAC,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAEjG;;;;;;;;OAQM;aACU,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtD;;;;;;;;;;;OAWM;aACU,WAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,OAAO;IAEzG;;;;;;;;OAQM;aACU,UAAU,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;CAC9C"}

package/dist/esm/TimersManager.js

@@ -0,0 +1,32 @@
+import path from "path";
+import fs from "fs";
+import searchRoot from "./searchRoot.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;
+    /**
+     * constructor
+     * @param timerfiledir(string, optional)
+     * If omitted, `.timers.jsonl` under the project root is used.
+     */
+    constructor(timerfiledir) {
+        this.timerfiledir =
+            timerfiledir ?? path.join(searchRoot(), this.getDefaultFilename());
+        try {
+            fs.accessSync(this.timerfiledir);
+        }
+        catch {
+            fs.writeFileSync(this.timerfiledir, "");
+        }
+    }
+}
+//# sourceMappingURL=TimersManager.js.map

package/dist/esm/TimersManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimersManager.js","sourceRoot":"","sources":["../../src/TimersManager.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,UAAU,MAAM,iBAAiB,CAAC;AAGzC;;;;;;;;GAQG;AACH,MAAM,OAAgB,aAAa;IACf,YAAY,CAAS;IAC9B,SAAS,GAAY,KAAK,CAAC;IAIrC;;;;OAIM;IACN,YACC,YAAqB;QAErB,IAAI,CAAC,YAAY;YACP,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;QAE7E,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;CA2DD"}

package/dist/esm/index.d.ts

@@ -1,73 +1,4 @@
-export type Timer = {
-    id: string;
-    start: number;
-    stop: number;
-    title?: string;
-    description?: string;
-};
-/**
- * TimersManager
- * @description
- * Manages timers stored in a file.
- * Each timer is stored as: `id start stop`.
- *
- * - Timers are persisted in a file
- * - Expired timers are detected by polling
- */
-export declare class TimersManager {
-    private readonly timerfiledir;
-    private readonly isJSONLines;
-    private checkLock;
-    /**
-     * constructor
-     * @param timerfiledir(string, optional)
-     * If omitted, `.timers.jsonl` under the project root is used.
-     */
-    constructor(timerfiledir?: string);
-    /**
-     * 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
-     */
-    createTimer(length: number, title?: string, description?: string): Promise<string>;
-    /**
-     * 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);
-     */
-    removeTimer(id: string): Promise<void>;
-    /**
-     * @description Starts monitoring expired timers asynchronously and returns immediately. The callback is invoked asynchronously when a timer expires.
-     * The callback is awaited before continuing.
-     * @param callback Function invoked when an expired timer is detected (called asynchronously)
-     * @param interval (number, optional): Check interval in milliseconds (default: 50ms)
-     * @throws If file operation fails
-     * @returns (NodeJS.Timeout) intervalId interval id of checkTimers
-     * @example
-     * const interval = manager.checkTimers((timer) => {
-     *     console.log(`A timer was stopped: ${timer.id}`);
-     * });
-     */
-    checkTimers(callback: (timer: Timer) => Promise<void>, interval?: number): NodeJS.Timeout;
-    /**
-     * 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))
-     */
-    showTimers(): Promise<Timer[]>;
-}
+export type { Timer } from "./types.js";
+export { JSONLTimersManager } from "./JSONLTimersManager.js";
+export { PlainTextTimersManager } from "./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":"AAKA,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;AA+BD;;;;;;;;GAQG;AACH,qBAAa,aAAa;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAU;IACtC,OAAO,CAAC,SAAS,CAAkB;IAEnC;;;;OAIM;gBAEL,YAAY,CAAC,EAAE,MAAM;IActB;;;;;;;;;;OAUM;IACO,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAuC/F;;;;;;;;OAQM;IACO,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiDnD;;;;;;;;;;;OAWM;IACC,WAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAE,MAAW,GAAG,MAAM,CAAC,OAAO;IA+CpG;;;;;;;;OAQM;IACO,UAAU,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;CA6B3C"}
+{"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"}

package/dist/esm/index.js

@@ -1,275 +1,3 @@
-import fs from "fs";
-import path from "path";
-import searchRoot from "./searchRoot.js";
-import { v4 as uuidv4 } from "uuid";
-async function checkTimerfileSyntax(fileData, isJSONLines) {
-    const throwing = () => {
-        throw new Error(`Timer file's syntax is wrong`);
-    };
-    const timersData = fileData
-        .split('\n')
-        .map(l => l.trim())
-        .filter(l => l !== "");
-    if (isJSONLines) {
-        for (const timerData of timersData) {
-            const parsed = JSON.parse(timerData);
-            if (!parsed.id || typeof parsed.id !== "string" || parsed.id.length !== 36)
-                throwing();
-            if (!parsed.start || typeof parsed.start !== "number" || parsed.start.toString().trim() === "")
-                throwing();
-            if (!parsed.stop || typeof parsed.stop !== "number" || parsed.stop.toString().trim() === "")
-                throwing();
-            if (parsed.title && typeof parsed.title !== "string")
-                throwing();
-            if (parsed.description && typeof parsed.description !== "string")
-                throwing();
-        }
-    }
-    else {
-        for (const timerData of timersData) {
-            const timerArray = timerData.split(/\s+/);
-            if (timerArray.length !== 3)
-                throwing();
-            if (timerArray[0]?.length !== 36)
-                throwing();
-            if (timerArray[1].trim() === "")
-                throwing();
-            if (timerArray[2].trim() === "")
-                throwing();
-        }
-    }
-    return;
-}
-/**
- * TimersManager
- * @description
- * Manages timers stored in a file.
- * Each timer is stored as: `id start stop`.
- *
- * - Timers are persisted in a file
- * - Expired timers are detected by polling
- */
-export class TimersManager {
-    timerfiledir;
-    isJSONLines;
-    checkLock = false;
-    /**
-     * constructor
-     * @param timerfiledir(string, optional)
-     * If omitted, `.timers.jsonl` under the project root is used.
-     */
-    constructor(timerfiledir) {
-        this.timerfiledir =
-            timerfiledir ?? path.join(searchRoot(), ".timers.jsonl");
-        this.isJSONLines = this.timerfiledir.endsWith(".jsonl");
-        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(length, title, description) {
-        try {
-            if (length < 0) {
-                throw new Error(`Invailed length: ${length}`);
-            }
-            if (!this.isJSONLines) {
-                if (title || description) {
-                    // out warn
-                }
-            }
-            const timersRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
-            await checkTimerfileSyntax(timersRaw, this.isJSONLines);
-            length = Math.trunc(length);
-            // uuid, start, end
-            const id = uuidv4();
-            const now = Date.now();
-            let newTimerData;
-            if (this.isJSONLines) {
-                const json = {
-                    id,
-                    start: now,
-                    stop: (now + length),
-                    ...(title !== undefined && { title }),
-                    ...(description !== undefined && { description }),
-                };
-                newTimerData = JSON.stringify(json, null, 0);
-            }
-            else {
-                newTimerData = `${id} ${now.toString()} ${(now + length).toString()}`;
-            }
-            await fs.promises.appendFile(this.timerfiledir, newTimerData + "\n");
-            return id;
-        }
-        catch (e) {
-            throw new Error(`Error when creating timer: ${e}`);
-        }
-    }
-    /**
-     * 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) {
-        try {
-            const timersRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
-            await checkTimerfileSyntax(timersRaw, this.isJSONLines);
-            let newTimersData = "";
-            if (this.isJSONLines) {
-                const timersData = timersRaw
-                    .split(/\r?\n/)
-                    .filter(t => t.trim())
-                    .map(line => JSON.parse(line));
-                let found = false;
-                for (const timerData of timersData) {
-                    if (!timerData)
-                        continue;
-                    if (timerData.id === id) {
-                        found = true;
-                        continue;
-                    }
-                    newTimersData += `${JSON.stringify(timerData, null, 0)}\n`;
-                }
-                if (!found) {
-                    throw new Error(`Timer with id ${id} not found`);
-                }
-            }
-            else {
-                const timersData = timersRaw.split(/\r?\n/);
-                let found = false;
-                for (const timerData of timersData) {
-                    if (!timerData.trim())
-                        continue;
-                    const [timerId] = timerData.split(" ");
-                    if (timerId === id) {
-                        found = true;
-                        continue;
-                    }
-                    newTimersData += timerData + "\n";
-                }
-                if (!found) {
-                    throw new Error(`Timer with id ${id} not found`);
-                }
-            }
-            await fs.promises.writeFile(this.timerfiledir, newTimersData, "utf-8");
-            return;
-        }
-        catch (e) {
-            throw new Error(`Error when removing timer: ${e}`);
-        }
-    }
-    /**
-     * @description Starts monitoring expired timers asynchronously and returns immediately. The callback is invoked asynchronously when a timer expires.
-     * The callback is awaited before continuing.
-     * @param callback Function invoked when an expired timer is detected (called asynchronously)
-     * @param interval (number, optional): Check interval in milliseconds (default: 50ms)
-     * @throws If file operation fails
-     * @returns (NodeJS.Timeout) intervalId interval id of checkTimers
-     * @example
-     * const interval = manager.checkTimers((timer) => {
-     *     console.log(`A timer was stopped: ${timer.id}`);
-     * });
-     */
-    checkTimers(callback, interval = 50) {
-        return setInterval(async () => {
-            if (this.checkLock)
-                return;
-            this.checkLock = true;
-            try {
-                const timersDataRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
-                const timersSet = new Set();
-                if (this.isJSONLines) {
-                    const timersData = timersDataRaw
-                        .split(/\r?\n/)
-                        .filter(line => line.trim())
-                        .map(line => JSON.parse(line));
-                    for (const timer of timersData) {
-                        timersSet.add(timer);
-                    }
-                }
-                else {
-                    const timersData = timersDataRaw.split(/\r?\n/);
-                    for (const timerData of timersData) {
-                        if (!timerData.trim())
-                            continue;
-                        const [id, startStr, stopStr] = timerData.split(" ");
-                        timersSet.add({
-                            id: id,
-                            start: Number(startStr),
-                            stop: Number(stopStr),
-                        });
-                    }
-                }
-                const now = Date.now();
-                for (const timer of timersSet) {
-                    if (Number(timer.stop) <= now) {
-                        await this.removeTimer(timer.id);
-                        await callback(timer);
-                    }
-                }
-            }
-            catch (e) {
-                throw new Error(`Error when checking alarm: ${e}`);
-            }
-            finally {
-                this.checkLock = false;
-            }
-        }, 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() {
-        try {
-            const timersRaw = await fs.promises.readFile(this.timerfiledir, "utf-8");
-            if (this.isJSONLines) {
-                const timersData = timersRaw
-                    .split(/\r?\n/)
-                    .filter(t => t.trim())
-                    .map(line => JSON.parse(line));
-                return timersData;
-            }
-            else {
-                const timersData = timersRaw.split(/\r?\n/);
-                const timersJSON = [];
-                for (const timerData of timersData) {
-                    const splitedTimerData = timerData.split(" ");
-                    if (!timerData.trim())
-                        continue;
-                    timersJSON.push({
-                        id: splitedTimerData[0],
-                        start: Number(splitedTimerData[1]),
-                        stop: Number(splitedTimerData[2]),
-                    });
-                }
-                return timersJSON;
-            }
-        }
-        catch (e) {
-            throw new Error(`Error when showing timers: ${e}`);
-        }
-    }
-}
+export { JSONLTimersManager } from "./JSONLTimersManager.js";
+export { PlainTextTimersManager } from "./PlainTextTimersManager.js";
 //# sourceMappingURL=index.js.map