eternal-timer 2.3.0 → 2.5.0

package/dist/cjs/TimersStore/PlainTextTimersStore.cjs

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlainTextTimersStore = void 0;
+const uuid_1 = require("uuid");
+const TimersStore_js_1 = require("./TimersStore.cjs");
+class PlainTextTimersStore extends TimersStore_js_1.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 (!(0, uuid_1.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),
+            };
+        });
+    }
+}
+exports.PlainTextTimersStore = PlainTextTimersStore;
+//# sourceMappingURL=PlainTextTimersStore.js.map

package/dist/cjs/TimersStore/PlainTextTimersStore.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlainTextTimersStore.js","sourceRoot":"","sources":["../../../src/TimersStore/PlainTextTimersStore.ts"],"names":[],"mappings":";;;AAAA,+BAAgC;AAGhC,qDAA+C;AAE/C,MAAa,oBAAqB,SAAQ,4BAAwB;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,IAAA,eAAQ,EAAC,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;AAjDD,oDAiDC"}

package/dist/cjs/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/cjs/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/cjs/TimersStore/TimersStore.cjs

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimersStore = void 0;
+const fs_1 = __importDefault(require("fs"));
+class TimersStore {
+    timerfile;
+    constructor(timerfile) {
+        this.timerfile = timerfile;
+    }
+    async loadTimers() {
+        try {
+            const data = await fs_1.default.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_1.default.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_1.default.promises.appendFile(this.timerfile, this.toStringifyTimers([timer]) + "\n");
+            return;
+        }
+        catch (e) {
+            throw new Error(`Error when appending timer data`, { cause: e });
+        }
+    }
+}
+exports.TimersStore = TimersStore;
+//# sourceMappingURL=TimersStore.js.map

package/dist/cjs/TimersStore/TimersStore.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimersStore.js","sourceRoot":"","sources":["../../../src/TimersStore/TimersStore.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AAIpB,MAAsB,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,YAAE,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,YAAE,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,YAAE,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;AA1CD,kCA0CC"}

package/dist/cjs/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/cjs/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/cjs/index.cjs

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlainTextTimersManager = exports.JSONLTimersManager = void 0;
-var JSONLTimersManager_js_1 = require("./JSONLTimersManager.cjs");
+var JSONLTimersManager_js_1 = require("./TimersManager/JSONLTimersManager.cjs");
 Object.defineProperty(exports, "JSONLTimersManager", { enumerable: true, get: function () { return JSONLTimersManager_js_1.JSONLTimersManager; } });
-var PlainTextTimersManager_js_1 = require("./PlainTextTimersManager.cjs");
+var PlainTextTimersManager_js_1 = require("./TimersManager/PlainTextTimersManager.cjs");
 Object.defineProperty(exports, "PlainTextTimersManager", { enumerable: true, get: function () { return PlainTextTimersManager_js_1.PlainTextTimersManager; } });
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AACA,iEAA6D;AAApD,2HAAA,kBAAkB,OAAA;AAC3B,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AACA,+EAA2E;AAAlE,2HAAA,kBAAkB,OAAA;AAC3B,uFAAmF;AAA1E,mIAAA,sBAAsB,OAAA"}

package/dist/cjs/index.d.ts

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

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

@@ -1 +1 @@
-{"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,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/cjs/types.d.ts

@@ -1,12 +1,15 @@
 export type StorageType = "JSONL" | "PlainText";
-export type Timer<T extends StorageType> = {
+export type Timer<T extends StorageType> = T extends "JSONL" ? {
     id: string;
     start: number;
     stop: number;
-} & (T extends "JSONL" ? {
     title?: string;
     description?: string;
-} : object);
+} : {
+    id: string;
+    start: number;
+    stop: number;
+};
 export type CreateTimerOptions<T extends StorageType> = T extends "JSONL" ? {
     length: number;
     title?: string;

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

@@ -1 +1 @@
-{"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,IAAI;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CAChB,GAAG,CAAC,CAAC,SAAS,OAAO,GAAG;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,CAAC;AAE5E,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"}
+{"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/dist/esm/TimersManager/JSONLTimersManager.d.ts

@@ -0,0 +1,19 @@
+import { TimersManager } from "./TimersManager.js";
+import { JSONLTimersStore } from "../TimersStore/JSONLTimersStore.js";
+/**
+ * JSONLTimersManager
+ * @description
+ * Manages timers stored in a  JSONL file.
+ * (This is a abstract class)
+ *
+ * - Timers are persisted in a file
+ * - Expired timers are detected by polling
+ */
+export declare class JSONLTimersManager extends TimersManager<"JSONL"> {
+    protected TimersStore: JSONLTimersStore | null;
+    protected getDefaultFilename(): string;
+    protected createTimersStore(): Promise<JSONLTimersStore>;
+    changeTitle(id: string, newTitle: string): Promise<void>;
+    changeDescription(id: string, newDescription: string): Promise<void>;
+}
+//# sourceMappingURL=JSONLTimersManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"JSONLTimersManager.d.ts","sourceRoot":"","sources":["../../../src/TimersManager/JSONLTimersManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE;;;;;;;;GAQG;AACH,qBAAa,kBAAmB,SAAQ,aAAa,CAAC,OAAO,CAAC;IAC7D,UAAmB,WAAW,EAAE,gBAAgB,GAAG,IAAI,CAAQ;cAE5C,kBAAkB,IAAI,MAAM;cAItB,iBAAiB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAI1D,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBxD,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAkBjF"}

package/dist/esm/TimersManager/JSONLTimersManager.js

@@ -0,0 +1,55 @@
+import { TimersManager } from "./TimersManager.js";
+import { JSONLTimersStore } from "../TimersStore/JSONLTimersStore.js";
+/**
+ * JSONLTimersManager
+ * @description
+ * Manages timers stored in a  JSONL file.
+ * (This is a abstract class)
+ *
+ * - Timers are persisted in a file
+ * - Expired timers are detected by polling
+ */
+export class JSONLTimersManager extends TimersManager {
+    TimersStore = null;
+    getDefaultFilename() {
+        return ".timers.jsonl";
+    }
+    async createTimersStore() {
+        return new JSONLTimersStore(this.timerfiledir);
+    }
+    async changeTitle(id, newTitle) {
+        return this.runExclusive(async () => {
+            this.TimersStore ??= await this.createTimersStore();
+            try {
+                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[index].title = newTitle;
+                await this.TimersStore.saveTimers(timers);
+            }
+            catch (e) {
+                throw new Error(`Error when changing title`, { cause: e });
+            }
+        });
+    }
+    async changeDescription(id, newDescription) {
+        return this.runExclusive(async () => {
+            this.TimersStore ??= await this.createTimersStore();
+            try {
+                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[index].description = newDescription;
+                await this.TimersStore.saveTimers(timers);
+            }
+            catch (e) {
+                throw new Error(`Error when changing description`, { cause: e });
+            }
+        });
+    }
+}
+//# sourceMappingURL=JSONLTimersManager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"JSONLTimersManager.js","sourceRoot":"","sources":["../../../src/TimersManager/JSONLTimersManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE;;;;;;;;GAQG;AACH,MAAM,OAAO,kBAAmB,SAAQ,aAAsB;IAC1C,WAAW,GAA4B,IAAI,CAAC;IAE5C,kBAAkB;QACpC,OAAO,eAAe,CAAC;IACxB,CAAC;IAEkB,KAAK,CAAC,iBAAiB;QACzC,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,EAAU,EAAE,QAAgB;QACpD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACnC,IAAI,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACpD,IAAI,CAAC;gBACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;gBAEnD,MAAM,KAAK,GAAG,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBAClD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;oBAClB,MAAM,IAAI,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;gBAClD,CAAC;gBAED,MAAM,CAAC,KAAK,CAAE,CAAC,KAAK,GAAG,QAAQ,CAAC;gBAChC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC3C,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YAC5D,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,EAAU,EAAE,cAAsB;QAChE,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACnC,IAAI,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACpD,IAAI,CAAC;gBACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;gBAEnD,MAAM,KAAK,GAAG,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBAClD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;oBAClB,MAAM,IAAI,KAAK,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;gBAClD,CAAC;gBAED,MAAM,CAAC,KAAK,CAAE,CAAC,WAAW,GAAG,cAAc,CAAC;gBAC5C,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC3C,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YAClE,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;CACD"}

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

@@ -0,0 +1,17 @@
+import { TimersManager } from "./TimersManager.js";
+import { PlainTextTimersStore } from "../TimersStore/PlainTextTimersStore.js";
+/**
+ * PlainTextTimersManager
+ * @description
+ * Manages timers stored in a PlainText file.
+ * (This is a abstract class)
+ *
+ * - Timers are persisted in a file
+ * - Expired timers are detected by polling
+ */
+export declare class PlainTextTimersManager extends TimersManager<"PlainText"> {
+    protected TimersStore: PlainTextTimersStore | null;
+    protected getDefaultFilename(): string;
+    protected createTimersStore(): Promise<PlainTextTimersStore>;
+}
+//# sourceMappingURL=PlainTextTimersManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlainTextTimersManager.d.ts","sourceRoot":"","sources":["../../../src/TimersManager/PlainTextTimersManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAE9E;;;;;;;;GAQG;AACH,qBAAa,sBAAuB,SAAQ,aAAa,CAAC,WAAW,CAAC;IACrE,UAAmB,WAAW,EAAE,oBAAoB,GAAG,IAAI,CAAQ;cAEhD,kBAAkB,IAAI,MAAM;cAI/B,iBAAiB,IAAI,OAAO,CAAC,oBAAoB,CAAC;CAGlE"}

package/dist/esm/TimersManager/PlainTextTimersManager.js

@@ -0,0 +1,21 @@
+import { TimersManager } from "./TimersManager.js";
+import { PlainTextTimersStore } from "../TimersStore/PlainTextTimersStore.js";
+/**
+ * PlainTextTimersManager
+ * @description
+ * Manages timers stored in a PlainText file.
+ * (This is a abstract class)
+ *
+ * - Timers are persisted in a file
+ * - Expired timers are detected by polling
+ */
+export class PlainTextTimersManager extends TimersManager {
+    TimersStore = null;
+    getDefaultFilename() {
+        return ".timers";
+    }
+    async createTimersStore() {
+        return new PlainTextTimersStore(this.timerfiledir);
+    }
+}
+//# sourceMappingURL=PlainTextTimersManager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlainTextTimersManager.js","sourceRoot":"","sources":["../../../src/TimersManager/PlainTextTimersManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAE9E;;;;;;;;GAQG;AACH,MAAM,OAAO,sBAAuB,SAAQ,aAA0B;IAClD,WAAW,GAAgC,IAAI,CAAC;IAEhD,kBAAkB;QACpC,OAAO,SAAS,CAAC;IAClB,CAAC;IAES,KAAK,CAAC,iBAAiB;QAChC,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACpD,CAAC;CACD"}

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

@@ -0,0 +1,87 @@
+import type { CreateTimerOptions, StorageType, Timer } from "../types.js";
+import { TimersStore } from "../TimersStore/TimersStore.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<T extends StorageType> {
+    protected readonly timerfiledir: string;
+    private checkLock;
+    protected TimersStore: TimersStore<T> | null;
+    private queue;
+    protected runExclusive<T>(fn: () => Promise<T>): Promise<T>;
+    protected abstract getDefaultFilename(): string;
+    protected abstract createTimersStore(): Promise<TimersStore<T>>;
+    /**
+      * 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?: 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(options: CreateTimerOptions<T>): 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>;
+    /**
+     * 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}`);
+     * });
+     */
+    checkTimers(callback: (timer: Timer<T>) => void | Promise<void>, interval?: number): Promise<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<T>[]>;
+    /**
+      * 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
+      */
+    adjustRemainingTime(id: string, delay: number): Promise<void>;
+}
+//# sourceMappingURL=TimersManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TimersManager.d.ts","sourceRoot":"","sources":["../../../src/TimersManager/TimersManager.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAG5D;;;;;;;;GAQG;AACH,8BAAsB,aAAa,CAAC,CAAC,SAAS,WAAW;IACxD,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IACxC,OAAO,CAAC,SAAS,CAAkB;IAEnC,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAQ;IAEpD,OAAO,CAAC,KAAK,CAAoC;IACjD,SAAS,CAAC,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAM9C,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,MAAM;IAC/C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAE/D;;;;;;;;QAQO;gBAEN,OAAO,CAAC,EAAE,MAAM;IAcjB;;;;;;;;;;OAUM;IACO,WAAW,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IA0BzE;;;;;;;;OAQM;IACO,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBnD;;;;;;;;;;;;;OAaM;IACO,WAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAE,MAAY,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;IAuD9H;;;;;;;;OAQM;IACO,UAAU,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAQ9C;;;;;;;QAOO;IACM,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAsB1E"}

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