@lowerdeck/cron 1.0.0

package/.turbo/turbo-build.log

@@ -0,0 +1,12 @@
+
+$ microbundle
+No name was provided for external module '@lowerdeck/redis' in output.globals – guessing 'redis'
+Build "@lowerdeck/cron" to dist:
+        496 B: index.cjs.gz
+        427 B: index.cjs.br
+        441 B: index.module.js.gz
+        381 B: index.module.js.br
+        510 B: index.module.js.gz
+        429 B: index.module.js.br
+        594 B: index.umd.js.gz
+        497 B: index.umd.js.br

package/.turbo/turbo-test.log

@@ -0,0 +1,11 @@
+
+$ vitest run --passWithNoTests
+[?25l
+ RUN  v3.2.4 /Users/tobias/code/metorial/metorial-enterprise/oss/src/packages/backend/cron
+
+No test files found, exiting with code 0
+
+include: **/*.{test,spec}.?(c|m)[jt]s?(x)
+exclude:  **/node_modules/**, **/dist/**, **/cypress/**, **/.{idea,git,cache,output,temp}/**, **/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build,eslint,prettier}.config.*
+
+[?25h

package/README.md

@@ -0,0 +1,69 @@
+# `@lowerdeck/cron`
+
+Distributed cron job scheduler using BullMQ and Redis. Schedule recurring tasks with cron expressions that run reliably across multiple instances.
+
+## Installation
+
+```bash
+npm install @lowerdeck/cron
+yarn add @lowerdeck/cron
+bun add @lowerdeck/cron
+pnpm add @lowerdeck/cron
+```
+
+## Usage
+
+```typescript
+import { createCron } from '@lowerdeck/cron';
+
+// Create a cron job that runs every minute
+const cronJob = createCron(
+  {
+    name: 'cleanup-task',
+    cron: '*/1 * * * *', // every minute
+    redisUrl: 'redis://localhost:6379'
+  },
+  async () => {
+    console.log('Running cleanup task');
+    // Your task logic here
+  }
+);
+
+// Start the cron job
+const processor = await cronJob.start();
+
+// Later, stop the cron job
+await processor.close();
+
+// Run every day at midnight
+const dailyJob = createCron(
+  {
+    name: 'daily-report',
+    cron: '0 0 * * *',
+    redisUrl: process.env.REDIS_URL
+  },
+  async () => {
+    await generateDailyReport();
+  }
+);
+
+// Run every 15 minutes
+const frequentJob = createCron(
+  {
+    name: 'sync-data',
+    cron: '*/15 * * * *',
+    redisUrl: process.env.REDIS_URL
+  },
+  async () => {
+    await syncDataFromAPI();
+  }
+);
+```
+
+## License
+
+This project is licensed under the Apache License 2.0.
+
+<div align="center">
+  <sub>Built with ❤️ by <a href="https://metorial.com">Metorial</a></sub>
+</div>

package/dist/index.cjs

@@ -0,0 +1,2 @@
+var e=require("@lowerdeck/redis"),r=require("bullmq"),n=function(){var e;return(e=console).log.apply(e,["[CRON MANAGER]:"].concat([].slice.call(arguments)))},o=new Set;exports.createCron=function(t,c){if(o.has(t.name))throw new Error("Cron with name "+t.name+" already exists");var i=e.parseRedisUrl(t.redisUrl),a=new r.Queue(t.name,{connection:i,defaultJobOptions:{removeOnComplete:!0,removeOnFail:!0}});return{start:function(){try{return n("Starting cron job "+t.name+" to run every "+t.cron+" using bullmq"),Promise.resolve(a.upsertJobScheduler("cron",{pattern:t.cron},{opts:{removeDependencyOnFailure:!0,removeOnComplete:!0,removeOnFail:!0,keepLogs:0}})).then(function(){var e=new r.Worker(t.name,function(){try{return n("Running cron job "+t.name),Promise.resolve(c()).then(function(){})}catch(e){return Promise.reject(e)}},{connection:i});return{close:e.close.bind(e)}})}catch(e){return Promise.reject(e)}}}};
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import { IQueueProcessor } from '@lowerdeck/queue';\nimport { parseRedisUrl } from '@lowerdeck/redis';\nimport { Queue, Worker } from 'bullmq';\n\nlet log = (...any: any[]) => console.log('[CRON MANAGER]:', ...any);\n\nlet seenNames = new Set<string>();\n\nexport let createCron = (\n  opts: {\n    name: string;\n    cron: string;\n    redisUrl: string;\n  },\n  handler: () => Promise<void>\n): IQueueProcessor => {\n  if (seenNames.has(opts.name)) {\n    throw new Error(`Cron with name ${opts.name} already exists`);\n  }\n\n  let connection = parseRedisUrl(opts.redisUrl);\n  let queue = new Queue(opts.name, {\n    connection,\n    defaultJobOptions: {\n      removeOnComplete: true,\n      removeOnFail: true\n    }\n  });\n\n  return {\n    start: async () => {\n      log(`Starting cron job ${opts.name} to run every ${opts.cron} using bullmq`);\n\n      await queue.upsertJobScheduler(\n        'cron',\n        {\n          pattern: opts.cron\n        },\n        {\n          opts: {\n            removeDependencyOnFailure: true,\n            removeOnComplete: true,\n            removeOnFail: true,\n            keepLogs: 0\n          }\n        }\n      );\n\n      let worker = new Worker(\n        opts.name,\n        async () => {\n          log(`Running cron job ${opts.name}`);\n          await handler();\n        },\n        { connection }\n      );\n\n      return {\n        close: worker.close.bind(worker)\n      };\n    }\n  };\n};\n"],"names":["log","_console","console","apply","concat","slice","call","arguments","seenNames","Set","opts","handler","has","name","Error","connection","parseRedisUrl","redisUrl","queue","Queue","defaultJobOptions","removeOnComplete","removeOnFail","start","cron","Promise","resolve","upsertJobScheduler","pattern","removeDependencyOnFailure","keepLogs","then","worker","Worker","e","reject","close","bind"],"mappings":"sDAIIA,EAAM,WAAH,IAAAC,EAAA,OAAsBA,EAAAC,SAAQF,IAAGG,MAAAF,EAAA,CAAC,mBAAiBG,OAAA,GAAAC,MAAAC,KAAAC,YAAS,EAE/DC,EAAY,IAAIC,uBAEI,SACtBC,EAKAC,GAEA,GAAIH,EAAUI,IAAIF,EAAKG,MACrB,UAAUC,MAAwBJ,kBAAAA,EAAKG,KAAqB,mBAG9D,IAAIE,EAAaC,EAAaA,cAACN,EAAKO,UAChCC,EAAQ,IAAIC,EAAKA,MAACT,EAAKG,KAAM,CAC/BE,WAAAA,EACAK,kBAAmB,CACjBC,kBAAkB,EAClBC,cAAc,KAIlB,MAAO,CACLC,MAAK,WAAA,IAC0E,OAA7EvB,EAAyBU,qBAAAA,EAAKG,KAAqBH,iBAAAA,EAAKc,sBAAqBC,QAAAC,QAEvER,EAAMS,mBACV,OACA,CACEC,QAASlB,EAAKc,MAEhB,CACEd,KAAM,CACJmB,2BAA2B,EAC3BR,kBAAkB,EAClBC,cAAc,EACdQ,SAAU,MAGfC,KAAA,WAED,IAAIC,EAAS,IAAIC,EAAAA,OACfvB,EAAKG,KACM,WAAA,IAC4B,OAArCb,EAAG,oBAAqBU,EAAKG,MAAQY,QAAAC,QAC/Bf,KAASoB,KACjB,WAAA,EAAA,CAAC,MAAAG,GAAAT,OAAAA,QAAAU,OAAAD,EAAA,CAAA,EACD,CAAEnB,WAAAA,IAGJ,MAAO,CACLqB,MAAOJ,EAAOI,MAAMC,KAAKL,GACzB,EACJ,CAAC,MAAAE,GAAA,OAAAT,QAAAU,OAAAD,EAAA,CAAA,EAEL"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { IQueueProcessor } from '@lowerdeck/queue';
+export declare let createCron: (opts: {
+    name: string;
+    cron: string;
+    redisUrl: string;
+}, handler: () => Promise<void>) => IQueueProcessor;
+//# 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":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAQnD,eAAO,IAAI,UAAU,GACnB,MAAM;IACJ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB,EACD,SAAS,MAAM,OAAO,CAAC,IAAI,CAAC,KAC3B,eA+CF,CAAC"}

package/dist/index.module.js

@@ -0,0 +1,2 @@
+import{parseRedisUrl as e}from"@lowerdeck/redis";import{Queue as n,Worker as r}from"bullmq";var o=function(){var e;return(e=console).log.apply(e,["[CRON MANAGER]:"].concat([].slice.call(arguments)))},t=new Set,c=function(c,i){if(t.has(c.name))throw new Error("Cron with name "+c.name+" already exists");var a=e(c.redisUrl),l=new n(c.name,{connection:a,defaultJobOptions:{removeOnComplete:!0,removeOnFail:!0}});return{start:function(){try{return o("Starting cron job "+c.name+" to run every "+c.cron+" using bullmq"),Promise.resolve(l.upsertJobScheduler("cron",{pattern:c.cron},{opts:{removeDependencyOnFailure:!0,removeOnComplete:!0,removeOnFail:!0,keepLogs:0}})).then(function(){var e=new r(c.name,function(){try{return o("Running cron job "+c.name),Promise.resolve(i()).then(function(){})}catch(e){return Promise.reject(e)}},{connection:a});return{close:e.close.bind(e)}})}catch(e){return Promise.reject(e)}}}};export{c as createCron};
+//# sourceMappingURL=index.module.js.map

package/dist/index.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.module.js","sources":["../src/index.ts"],"sourcesContent":["import { IQueueProcessor } from '@lowerdeck/queue';\nimport { parseRedisUrl } from '@lowerdeck/redis';\nimport { Queue, Worker } from 'bullmq';\n\nlet log = (...any: any[]) => console.log('[CRON MANAGER]:', ...any);\n\nlet seenNames = new Set<string>();\n\nexport let createCron = (\n  opts: {\n    name: string;\n    cron: string;\n    redisUrl: string;\n  },\n  handler: () => Promise<void>\n): IQueueProcessor => {\n  if (seenNames.has(opts.name)) {\n    throw new Error(`Cron with name ${opts.name} already exists`);\n  }\n\n  let connection = parseRedisUrl(opts.redisUrl);\n  let queue = new Queue(opts.name, {\n    connection,\n    defaultJobOptions: {\n      removeOnComplete: true,\n      removeOnFail: true\n    }\n  });\n\n  return {\n    start: async () => {\n      log(`Starting cron job ${opts.name} to run every ${opts.cron} using bullmq`);\n\n      await queue.upsertJobScheduler(\n        'cron',\n        {\n          pattern: opts.cron\n        },\n        {\n          opts: {\n            removeDependencyOnFailure: true,\n            removeOnComplete: true,\n            removeOnFail: true,\n            keepLogs: 0\n          }\n        }\n      );\n\n      let worker = new Worker(\n        opts.name,\n        async () => {\n          log(`Running cron job ${opts.name}`);\n          await handler();\n        },\n        { connection }\n      );\n\n      return {\n        close: worker.close.bind(worker)\n      };\n    }\n  };\n};\n"],"names":["log","_console","console","apply","concat","slice","call","arguments","seenNames","Set","createCron","opts","handler","has","name","Error","connection","parseRedisUrl","redisUrl","queue","Queue","defaultJobOptions","removeOnComplete","removeOnFail","start","cron","Promise","resolve","upsertJobScheduler","pattern","removeDependencyOnFailure","keepLogs","then","worker","Worker","e","reject","close","bind"],"mappings":"4FAIA,IAAIA,EAAM,WAAH,IAAAC,EAAA,OAAsBA,EAAAC,SAAQF,IAAGG,MAAAF,EAAA,CAAC,mBAAiBG,OAAA,GAAAC,MAAAC,KAAAC,YAAS,EAE/DC,EAAY,IAAIC,IAETC,EAAa,SACtBC,EAKAC,GAEA,GAAIJ,EAAUK,IAAIF,EAAKG,MACrB,UAAUC,MAAwBJ,kBAAAA,EAAKG,KAAqB,mBAG9D,IAAIE,EAAaC,EAAcN,EAAKO,UAChCC,EAAQ,IAAIC,EAAMT,EAAKG,KAAM,CAC/BE,WAAAA,EACAK,kBAAmB,CACjBC,kBAAkB,EAClBC,cAAc,KAIlB,MAAO,CACLC,MAAK,WAAA,IAC0E,OAA7ExB,EAAyBW,qBAAAA,EAAKG,KAAqBH,iBAAAA,EAAKc,sBAAqBC,QAAAC,QAEvER,EAAMS,mBACV,OACA,CACEC,QAASlB,EAAKc,MAEhB,CACEd,KAAM,CACJmB,2BAA2B,EAC3BR,kBAAkB,EAClBC,cAAc,EACdQ,SAAU,MAGfC,KAAA,WAED,IAAIC,EAAS,IAAIC,EACfvB,EAAKG,KACM,WAAA,IAC4B,OAArCd,EAAG,oBAAqBW,EAAKG,MAAQY,QAAAC,QAC/Bf,KAASoB,KACjB,WAAA,EAAA,CAAC,MAAAG,GAAAT,OAAAA,QAAAU,OAAAD,EAAA,CAAA,EACD,CAAEnB,WAAAA,IAGJ,MAAO,CACLqB,MAAOJ,EAAOI,MAAMC,KAAKL,GACzB,EACJ,CAAC,MAAAE,GAAA,OAAAT,QAAAU,OAAAD,EAAA,CAAA,EAEL"}

package/dist/index.umd.js

@@ -0,0 +1,2 @@
+!function(e,n){"object"==typeof exports&&"undefined"!=typeof module?n(exports,require("@lowerdeck/redis"),require("bullmq")):"function"==typeof define&&define.amd?define(["exports","@lowerdeck/redis","bullmq"],n):n((e||self).cron={},e.redis,e.bullmq)}(this,function(e,n,r){var o=function(){var e;return(e=console).log.apply(e,["[CRON MANAGER]:"].concat([].slice.call(arguments)))},t=new Set;e.createCron=function(e,i){if(t.has(e.name))throw new Error("Cron with name "+e.name+" already exists");var c=n.parseRedisUrl(e.redisUrl),l=new r.Queue(e.name,{connection:c,defaultJobOptions:{removeOnComplete:!0,removeOnFail:!0}});return{start:function(){try{return o("Starting cron job "+e.name+" to run every "+e.cron+" using bullmq"),Promise.resolve(l.upsertJobScheduler("cron",{pattern:e.cron},{opts:{removeDependencyOnFailure:!0,removeOnComplete:!0,removeOnFail:!0,keepLogs:0}})).then(function(){var n=new r.Worker(e.name,function(){try{return o("Running cron job "+e.name),Promise.resolve(i()).then(function(){})}catch(e){return Promise.reject(e)}},{connection:c});return{close:n.close.bind(n)}})}catch(e){return Promise.reject(e)}}}}});
+//# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.js","sources":["../src/index.ts"],"sourcesContent":["import { IQueueProcessor } from '@lowerdeck/queue';\nimport { parseRedisUrl } from '@lowerdeck/redis';\nimport { Queue, Worker } from 'bullmq';\n\nlet log = (...any: any[]) => console.log('[CRON MANAGER]:', ...any);\n\nlet seenNames = new Set<string>();\n\nexport let createCron = (\n  opts: {\n    name: string;\n    cron: string;\n    redisUrl: string;\n  },\n  handler: () => Promise<void>\n): IQueueProcessor => {\n  if (seenNames.has(opts.name)) {\n    throw new Error(`Cron with name ${opts.name} already exists`);\n  }\n\n  let connection = parseRedisUrl(opts.redisUrl);\n  let queue = new Queue(opts.name, {\n    connection,\n    defaultJobOptions: {\n      removeOnComplete: true,\n      removeOnFail: true\n    }\n  });\n\n  return {\n    start: async () => {\n      log(`Starting cron job ${opts.name} to run every ${opts.cron} using bullmq`);\n\n      await queue.upsertJobScheduler(\n        'cron',\n        {\n          pattern: opts.cron\n        },\n        {\n          opts: {\n            removeDependencyOnFailure: true,\n            removeOnComplete: true,\n            removeOnFail: true,\n            keepLogs: 0\n          }\n        }\n      );\n\n      let worker = new Worker(\n        opts.name,\n        async () => {\n          log(`Running cron job ${opts.name}`);\n          await handler();\n        },\n        { connection }\n      );\n\n      return {\n        close: worker.close.bind(worker)\n      };\n    }\n  };\n};\n"],"names":["log","_console","console","apply","concat","slice","call","arguments","seenNames","Set","opts","handler","has","name","Error","connection","parseRedisUrl","redisUrl","queue","Queue","defaultJobOptions","removeOnComplete","removeOnFail","start","cron","Promise","resolve","upsertJobScheduler","pattern","removeDependencyOnFailure","keepLogs","then","worker","Worker","e","reject","close","bind"],"mappings":"6TAIA,IAAIA,EAAM,WAAH,IAAAC,EAAA,OAAsBA,EAAAC,SAAQF,IAAGG,MAAAF,EAAA,CAAC,mBAAiBG,OAAA,GAAAC,MAAAC,KAAAC,YAAS,EAE/DC,EAAY,IAAIC,iBAEI,SACtBC,EAKAC,GAEA,GAAIH,EAAUI,IAAIF,EAAKG,MACrB,UAAUC,MAAwBJ,kBAAAA,EAAKG,KAAqB,mBAG9D,IAAIE,EAAaC,EAAaA,cAACN,EAAKO,UAChCC,EAAQ,IAAIC,EAAKA,MAACT,EAAKG,KAAM,CAC/BE,WAAAA,EACAK,kBAAmB,CACjBC,kBAAkB,EAClBC,cAAc,KAIlB,MAAO,CACLC,MAAK,WAAA,IAC0E,OAA7EvB,EAAyBU,qBAAAA,EAAKG,KAAqBH,iBAAAA,EAAKc,sBAAqBC,QAAAC,QAEvER,EAAMS,mBACV,OACA,CACEC,QAASlB,EAAKc,MAEhB,CACEd,KAAM,CACJmB,2BAA2B,EAC3BR,kBAAkB,EAClBC,cAAc,EACdQ,SAAU,MAGfC,KAAA,WAED,IAAIC,EAAS,IAAIC,EAAAA,OACfvB,EAAKG,KACM,WAAA,IAC4B,OAArCb,EAAG,oBAAqBU,EAAKG,MAAQY,QAAAC,QAC/Bf,KAASoB,KACjB,WAAA,EAAA,CAAC,MAAAG,GAAAT,OAAAA,QAAAU,OAAAD,EAAA,CAAA,EACD,CAAEnB,WAAAA,IAGJ,MAAO,CACLqB,MAAOJ,EAAOI,MAAMC,KAAKL,GACzB,EACJ,CAAC,MAAAE,GAAA,OAAAT,QAAAU,OAAAD,EAAA,CAAA,EAEL"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@lowerdeck/cron",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Tobias Herber",
+  "license": "Apache 2",
+  "type": "module",
+  "source": "src/index.ts",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "require": "./dist/index.cjs",
+    "import": "./dist/index.module.js",
+    "default": "./dist/index.modern.js"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.module.js",
+  "types": "dist/index.d.ts",
+  "unpkg": "./dist/index.umd.js",
+  "scripts": {
+    "test": "vitest run --passWithNoTests",
+    "lint": "prettier src/**/*.ts --check",
+    "build": "microbundle"
+  },
+  "dependencies": {
+    "@lowerdeck/queue": "^1.0.0",
+    "@lowerdeck/redis": "^1.0.0",
+    "bullmq": "^5.34.3"
+  },
+  "devDependencies": {
+    "@lowerdeck/tsconfig": "^1.0.0",
+    "typescript": "5.8.2",
+    "microbundle": "^0.15.1",
+    "vitest": "^3.1.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,63 @@
+import { IQueueProcessor } from '@lowerdeck/queue';
+import { parseRedisUrl } from '@lowerdeck/redis';
+import { Queue, Worker } from 'bullmq';
+
+let log = (...any: any[]) => console.log('[CRON MANAGER]:', ...any);
+
+let seenNames = new Set<string>();
+
+export let createCron = (
+  opts: {
+    name: string;
+    cron: string;
+    redisUrl: string;
+  },
+  handler: () => Promise<void>
+): IQueueProcessor => {
+  if (seenNames.has(opts.name)) {
+    throw new Error(`Cron with name ${opts.name} already exists`);
+  }
+
+  let connection = parseRedisUrl(opts.redisUrl);
+  let queue = new Queue(opts.name, {
+    connection,
+    defaultJobOptions: {
+      removeOnComplete: true,
+      removeOnFail: true
+    }
+  });
+
+  return {
+    start: async () => {
+      log(`Starting cron job ${opts.name} to run every ${opts.cron} using bullmq`);
+
+      await queue.upsertJobScheduler(
+        'cron',
+        {
+          pattern: opts.cron
+        },
+        {
+          opts: {
+            removeDependencyOnFailure: true,
+            removeOnComplete: true,
+            removeOnFail: true,
+            keepLogs: 0
+          }
+        }
+      );
+
+      let worker = new Worker(
+        opts.name,
+        async () => {
+          log(`Running cron job ${opts.name}`);
+          await handler();
+        },
+        { connection }
+      );
+
+      return {
+        close: worker.close.bind(worker)
+      };
+    }
+  };
+};

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "@lowerdeck/tsconfig/base.json",
+  "exclude": ["dist"],
+  "include": ["src"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "lib": ["es2021"],
+    "target": "ES2019"
+  }
+}