eternal-timer 1.0.1 → 1.1.0

package/README.md

@@ -1,2 +1,107 @@
 # eternal-timer
-timer for node.js package
+
+A simple and persistent timer library for Node.js. Timers are saved to a file and maintain their state even after process restart.
+
+## Features
+
+- **Create Timers**: Create timers for a specified duration
+- **Remove Timers**: Delete timers by ID
+- **Monitor Timers**: Handle expired timers with callback functions
+- **List Timers**: Retrieve all active timers
+- **Persistence**: Save timer data to a file that persists across process restarts
+
+## Installation
+
+```bash
+npm install eternal-timer
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { createTimer, checkTimers, removeTimer, showTimers } from 'eternal-timer';
+
+// Create a timer (5 seconds)
+const timerId = await createTimer(5000);
+console.log('Timer created:', timerId);
+
+// Monitor timers (executes when timer expires)
+await checkTimers((timer) => {
+  console.log('Timer expired:', timer.id);
+});
+
+// Display all timers
+const timers = await showTimers();
+console.log('Active timers:', timers);
+
+// Remove a timer
+await removeTimer(timerId);
+```
+
+## API
+
+### `createTimer(length: number): Promise<string | null>`
+
+Creates a new timer.
+
+**Parameters:**
+- `length` (number): Timer duration in milliseconds
+
+**Returns:** Timer ID (UUID), or `null` on error
+
+### `removeTimer(id: string): Promise<boolean>`
+
+Removes a timer by ID.
+
+**Parameters:**
+- `id` (string): ID of the timer to remove
+
+**Returns:** `true` on success, `false` on failure
+
+### `checkTimers(callback: (timer: Timer) => void, interval?: number): Promise<void>`
+
+Monitors expired timers and executes the callback function.
+
+**Parameters:**
+- `callback`: Function to execute when expired timers are found
+- `interval` (number, optional): Check interval in milliseconds (default: 50ms)
+
+### `showTimers(): Promise<Timer[]>`
+
+Retrieves all active timers.
+
+**Returns:** Array of `Timer` objects
+
+## Type Definition
+
+```typescript
+type Timer = {
+    id: string;      // Unique timer identifier (UUID)
+    start: string;   // Timer start timestamp
+    stop: string;    // Timer end timestamp
+}
+```
+
+## Scripts
+
+- `npm run dev`: Run in development mode with nodemon
+- `npm run build`: Compile TypeScript
+- `npm start`: Run compiled JavaScript
+
+## Storage
+
+Timer data is stored in the `.timers` file in the project root. Each line follows this format:
+
+```
+{id} {start_timestamp} {stop_timestamp}
+```
+
+## License
+
+ISC
+
+## Repository
+
+https://github.com/SUKEsann2000/eternal-timer

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import type { Timer } from "types/timersData.ts";
+export declare function createTimer(length: number): Promise<string | null>;
+export declare function removeTimer(id: string): Promise<boolean>;
+export declare function checkTimers(callback: (timer: Timer) => void, interval?: number): Promise<void>;
+export declare function showTimers(): Promise<Timer[]>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAejD,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAaxE;AAED,wBAAsB,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAc9D;AAED,wBAAsB,WAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,EAAE,QAAQ,GAAE,MAAW,iBA+BxF;AAED,wBAAsB,UAAU,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,CAoBnD"}

package/dist/index.js

@@ -0,0 +1,93 @@
+import fs from "fs";
+import path from "path";
+import searchRoot from "./searchRoot.js";
+import { v4 as uuidv4 } from "uuid";
+// search root folder of project
+const rootdir = searchRoot();
+const timerfiledir = path.join(rootdir, ".timers");
+async function createFile() {
+    if (!fs.existsSync(timerfiledir)) {
+        fs.writeFile(timerfiledir, "", (data) => {
+            console.log("The file was created in ", timerfiledir);
+        });
+    }
+    return;
+}
+export async function createTimer(length) {
+    try {
+        await createFile();
+        // uuid, start, end
+        const id = uuidv4();
+        const newTimerData = `${id} ${Date.now().toString()} ${(Date.now() + length).toString()}`;
+        fs.appendFileSync(timerfiledir, newTimerData + "\n");
+        return id;
+    }
+    catch (e) {
+        console.error(`Error when creating timer: ${e}`);
+        return null;
+    }
+}
+export async function removeTimer(id) {
+    try {
+        const timersRaw = fs.readFileSync(timerfiledir, "utf-8");
+        const timersData = timersRaw.split(/\r?\n/);
+        const filteredTimers = timersData.filter(line => line.split(" ")[0] !== id);
+        fs.writeFileSync(timerfiledir, filteredTimers.join("\n"), "utf-8");
+        return true;
+    }
+    catch (e) {
+        console.error(`Error when removing timer: ${e}`);
+        return false;
+    }
+}
+export async function checkTimers(callback, interval = 50) {
+    try {
+        await createFile();
+        setInterval(() => {
+            const timersData = fs.readFileSync(timerfiledir, "utf-8").split(/\r?\n/);
+            const timersSet = new Set();
+            for (const timerData of timersData) {
+                if (!timerData.trim())
+                    continue;
+                const [id, startStr, stopStr] = timerData.split(" ");
+                timersSet.add({
+                    id: id,
+                    start: startStr,
+                    stop: stopStr
+                });
+            }
+            const now = Date.now();
+            for (const timer of timersSet) {
+                if (Number(timer.stop) <= now) {
+                    removeTimer(timer.id);
+                    callback(timer);
+                }
+            }
+        }, interval);
+    }
+    catch (e) {
+        throw new Error(`Error when checking alarm: ${e}`);
+    }
+}
+export async function showTimers() {
+    try {
+        await createFile();
+        const timersRaw = fs.readFileSync(timerfiledir, "utf-8");
+        const timersData = timersRaw.split(/\r?\n/);
+        let timersJSON = [];
+        for (const timerData of timersData) {
+            const splitedTimerData = timerData.split(" ");
+            timersJSON.push({
+                id: splitedTimerData[0],
+                start: splitedTimerData[1],
+                stop: splitedTimerData[2]
+            });
+        }
+        return timersJSON;
+    }
+    catch (e) {
+        console.error(`Error when removing timer: ${e}`);
+        return [];
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAGpC,gCAAgC;AAChC,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;AAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AAEnD,KAAK,UAAU,UAAU;IACrB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC/B,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;YACpC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,YAAY,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO;AACX,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAc;IAC5C,IAAI,CAAC;QACD,MAAM,UAAU,EAAE,CAAC;QAEnB,mBAAmB;QACnB,MAAM,EAAE,GAAG,MAAM,EAAE,CAAA;QACnB,MAAM,YAAY,GAAG,GAAG,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC1F,EAAE,CAAC,cAAc,CAAC,YAAY,EAAE,YAAY,GAAI,IAAI,CAAC,CAAC;QACtD,OAAO,EAAE,CAAC;IACd,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,EAAU;IACxC,IAAI,CAAC;QACD,MAAM,SAAS,GAAW,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACjE,MAAM,UAAU,GAAa,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtD,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAE5E,EAAE,CAAC,aAAa,CAAC,YAAY,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAEnE,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;QACjD,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,QAAgC,EAAE,WAAmB,EAAE;IACrF,IAAI,CAAC;QACD,MAAM,UAAU,EAAE,CAAC;QAEnB,WAAW,CAAC,GAAG,EAAE;YACb,MAAM,UAAU,GAAa,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnF,MAAM,SAAS,GAAG,IAAI,GAAG,EAAS,CAAC;YAEnC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;gBACjC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;oBAAE,SAAS;gBAChC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrD,SAAS,CAAC,GAAG,CAAC;oBACV,EAAE,EAAE,EAAG;oBACP,KAAK,EAAE,QAAS;oBAChB,IAAI,EAAE,OAAQ;iBACjB,CAAC,CAAC;YACP,CAAC;YAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;gBAC5B,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;oBAC5B,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;oBACtB,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACpB,CAAC;YACL,CAAC;QAEL,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEjB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;IACvD,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU;IAC5B,IAAI,CAAC;QACD,MAAM,UAAU,EAAE,CAAC;QACnB,MAAM,SAAS,GAAW,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACjE,MAAM,UAAU,GAAa,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtD,IAAI,UAAU,GAAY,EAAE,CAAC;QAC7B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,MAAM,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC7C,UAAU,CAAC,IAAI,CAAC;gBACZ,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAE;gBACxB,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAE;gBAC3B,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAE;aAC7B,CAAC,CAAA;QACN,CAAC;QACD,OAAO,UAAU,CAAC;IACtB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;QACjD,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC"}

package/dist/searchRoot.d.ts

@@ -0,0 +1,2 @@
+export default function searchRoot(): string;
+//# sourceMappingURL=searchRoot.d.ts.map

package/dist/searchRoot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchRoot.d.ts","sourceRoot":"","sources":["../src/searchRoot.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,UAAU,UAAU,WAQjC"}

package/dist/searchRoot.js

@@ -0,0 +1,13 @@
+import fs from "fs";
+import path from "path";
+export default function searchRoot() {
+    let dir = process.cwd();
+    while (!fs.existsSync(path.join(dir, "package.json"))) {
+        const parent = path.dirname(dir);
+        if (parent === dir)
+            break;
+        dir = parent;
+    }
+    return dir;
+}
+//# sourceMappingURL=searchRoot.js.map

package/dist/searchRoot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchRoot.js","sourceRoot":"","sources":["../src/searchRoot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,MAAM,CAAC,OAAO,UAAU,UAAU;IAC9B,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,MAAM,KAAK,GAAG;YAAE,MAAM;QACtB,GAAG,GAAG,MAAM,CAAC;IACrB,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eternal-timer",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "timer for node.js package",
   "main": "dist/index.js",
   "scripts": {
@@ -30,5 +30,9 @@
   "dependencies": {
     "uuid": "^13.0.0"
   },
-  "files": [ "dist" ]
+  "files": [ "dist" ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
 }