traceflow-cron 1.0.0

package/README.md

@@ -0,0 +1,182 @@
+# Traceflow Cron
+
+Lightweight and simple cron scheduler for Node.js & TypeScript.
+
+Built on top of `node-cron` with a clean developer-friendly API.
+
+---
+
+## Installation
+
+```bash
+npm install traceflow-cron
+```
+
+---
+
+## Features
+
+* Simple cron scheduling
+* TypeScript support
+* Multiple job management
+* Start / Stop jobs
+* Lightweight
+* Easy integration
+
+---
+
+## Usage
+
+### Basic Example
+
+```ts
+import { TraceflowCron } from "traceflow-cron";
+
+const cron = new TraceflowCron();
+
+cron.schedule(
+  "daily-task",
+  "0 2 * * *",
+  () => {
+    console.log("Runs every day at 2 AM");
+  }
+);
+```
+
+---
+
+## Cron Expression Format
+
+```txt
+* * * * *
+| | | | |
+| | | | └─ Day of week
+| | | └── Month
+| | └──── Day
+| └────── Hour
+└──────── Minute
+```
+
+---
+
+## Examples
+
+### Every Day at 2 AM
+
+```ts
+cron.schedule(
+  "night-job",
+  "0 2 * * *",
+  () => {
+    console.log("Night task");
+  }
+);
+```
+
+---
+
+### Every 5 Seconds
+
+```ts
+cron.schedule(
+  "test-job",
+  "*/5 * * * * *",
+  () => {
+    console.log("Runs every 5 seconds");
+  }
+);
+```
+
+---
+
+### Every Monday at 9 AM
+
+```ts
+cron.schedule(
+  "weekly-report",
+  "0 9 * * 1",
+  () => {
+    console.log("Weekly report");
+  }
+);
+```
+
+---
+
+## API
+
+### schedule(name, expression, callback)
+
+Create a new cron job.
+
+```ts
+cron.schedule(
+  "backup",
+  "0 0 * * *",
+  () => {}
+);
+```
+
+| Parameter  | Type     | Description         |
+| ---------- | -------- | ------------------- |
+| name       | string   | Unique job name     |
+| expression | string   | Cron expression     |
+| callback   | function | Function to execute |
+
+---
+
+### stop(name)
+
+Stop a running job.
+
+```ts
+cron.stop("backup");
+```
+
+---
+
+### start(name)
+
+Restart a stopped job.
+
+```ts
+cron.start("backup");
+```
+
+---
+
+### destroy(name)
+
+Remove a job completely.
+
+```ts
+cron.destroy("backup");
+```
+
+---
+
+### getJobs()
+
+Get all registered jobs.
+
+```ts
+console.log(cron.getJobs());
+```
+
+---
+
+## TypeScript Support
+
+Fully typed with declaration files included.
+
+---
+
+## License
+
+MIT
+
+---
+
+## Author
+
+Built with ❤️ by Lokith

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+type JobCallback = () => void;
+declare class BossCron {
+    private jobs;
+    constructor();
+    /**
+     * Create a cron job
+     */
+    schedule(name: string, expression: string, callback: JobCallback): void;
+    /**
+     * Stop a specific job
+     */
+    stop(name: string): void;
+    /**
+     * Start a stopped job
+     */
+    start(name: string): void;
+    /**
+     * Delete a job
+     */
+    destroy(name: string): void;
+    /**
+     * Get all jobs
+     */
+    getJobs(): string[];
+}
+
+export { BossCron, type JobCallback };

package/dist/index.js

@@ -0,0 +1,100 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  BossCron: () => BossCron
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_cron = __toESM(require("node-cron"));
+var BossCron = class {
+  jobs;
+  constructor() {
+    this.jobs = /* @__PURE__ */ new Map();
+  }
+  /**
+   * Create a cron job
+   */
+  schedule(name, expression, callback) {
+    if (this.jobs.has(name)) {
+      throw new Error(`Job "${name}" already exists`);
+    }
+    const task = import_node_cron.default.schedule(expression, () => {
+      console.log(`[${name}] Job started`);
+      callback();
+    });
+    this.jobs.set(name, task);
+    console.log(`Job "${name}" scheduled with "${expression}"`);
+  }
+  /**
+   * Stop a specific job
+   */
+  stop(name) {
+    const job = this.jobs.get(name);
+    if (!job) {
+      throw new Error(`Job "${name}" not found`);
+    }
+    job.stop();
+    console.log(`Job "${name}" stopped`);
+  }
+  /**
+   * Start a stopped job
+   */
+  start(name) {
+    const job = this.jobs.get(name);
+    if (!job) {
+      throw new Error(`Job "${name}" not found`);
+    }
+    job.start();
+    console.log(`Job "${name}" started`);
+  }
+  /**
+   * Delete a job
+   */
+  destroy(name) {
+    const job = this.jobs.get(name);
+    if (!job) {
+      throw new Error(`Job "${name}" not found`);
+    }
+    job.stop();
+    this.jobs.delete(name);
+    console.log(`Job "${name}" destroyed`);
+  }
+  /**
+   * Get all jobs
+   */
+  getJobs() {
+    return [...this.jobs.keys()];
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BossCron
+});

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "traceflow-cron",
+  "version": "1.0.0",
+  "description": "Lightweight TypeScript cron scheduler",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "start": "npm run dev",
+    "dev": "tsup src/index.ts --format cjs --watch --dts",
+    "build": "tsup src/index.ts --format cjs --dts"
+  },
+  "keywords": [
+    "cron",
+    "scheduler",
+    "typescript",
+    "jobs"
+  ],
+  "author": "Lokith",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^25.9.1",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3"
+  },
+  "dependencies": {
+    "node-cron": "^4.2.1"
+  }
+}