@uns-kit/cron 0.0.38 → 0.0.41

package/README.md

@@ -36,15 +36,33 @@ import "@uns-kit/cron";
 async function main() {
   const process = new UnsProxyProcess("mqtt-broker:1883", { processName: "cron-demo" }) as UnsProxyProcessWithCron;
 
-  const cronProxy = await process.createCrontabProxy("*/5 * * * *");
-  cronProxy.event.on("cronEvent", () => {
-    console.log("tick");
+  const cronProxy = await process.createCrontabProxy("*/5 * * * *", { event: "heartbeat" });
+  cronProxy.event.on("cronEvent", ({ event, cronExpression }) => {
+    console.log("tick", event, cronExpression);
   });
 }
 
 void main();
 ```
 
+## Multiple schedules
+
+```ts
+const cronProxy = await process.createCrontabProxy([
+  { cronExpression: "* * * * * *", event: "a" },
+  { cronExpression: "*/10 * * * * *", event: "b" },
+]);
+```
+
+You can also pass an array of cron strings and optional default options:
+
+```ts
+const cronProxy = await process.createCrontabProxy(
+  ["*/5 * * * *", "*/15 * * * *"],
+  { timezone: "UTC" },
+);
+```
+
 ## Scripts
 
 ```bash

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { default } from "./uns-cron-plugin.js";
 export { UnsCronProxy, type UnsProxyProcessWithCron } from "./uns-cron-plugin.js";
 export { default as UnsCronProxyClass } from "./uns-cron-proxy.js";
+export type { CronProxyOptions, CronSchedule, CronScheduleInput } from "./uns-cron-proxy.js";

package/dist/uns-cron-plugin.d.ts

@@ -1,9 +1,8 @@
-import type { TaskOptions } from "node-cron";
 import UnsProxyProcess, { type UnsProxyProcessPlugin } from "@uns-kit/core/uns/uns-proxy-process.js";
-import UnsCronProxy from "./uns-cron-proxy.js";
+import UnsCronProxy, { type CronProxyOptions, type CronScheduleInput } from "./uns-cron-proxy.js";
 declare const unsCronPlugin: UnsProxyProcessPlugin;
 export default unsCronPlugin;
 export { UnsCronProxy };
 export type UnsProxyProcessWithCron = UnsProxyProcess & {
-    createCrontabProxy(cronExpression: string, options?: TaskOptions): Promise<UnsCronProxy>;
+    createCrontabProxy(cronInput: CronScheduleInput, options?: CronProxyOptions): Promise<UnsCronProxy>;
 };

package/dist/uns-cron-plugin.js

@@ -11,9 +11,9 @@ const getCronProxies = (instance) => {
 };
 const unsCronPlugin = ({ define }) => {
     define({
-        async createCrontabProxy(cronExpression, options) {
+        async createCrontabProxy(cronInput, options) {
             await this.waitForProcessConnection();
-            const unsCronProxy = new UnsCronProxy(cronExpression, options);
+            const unsCronProxy = new UnsCronProxy(cronInput, options);
             getCronProxies(this).push(unsCronProxy);
             return unsCronProxy;
         },

package/dist/uns-cron-proxy.d.ts

@@ -1,8 +1,16 @@
 import { TaskOptions } from "node-cron";
 import UnsProxy from "@uns-kit/core/uns/uns-proxy.js";
+export type CronSchedule = {
+    cronExpression: string;
+    event?: string;
+    options?: TaskOptions;
+};
+export type CronScheduleInput = string | string[] | CronSchedule[];
+export type CronProxyOptions = TaskOptions & {
+    event?: string;
+};
 export default class UnsCronProxy extends UnsProxy {
-    private readonly cronExpression;
-    private readonly task;
-    constructor(cronExpression: string, options?: TaskOptions);
+    private readonly tasks;
+    constructor(cronInput: CronScheduleInput, options?: CronProxyOptions);
     stop(): Promise<void>;
 }

package/dist/uns-cron-proxy.js

@@ -1,17 +1,44 @@
 import cron from "node-cron";
 import UnsProxy from "@uns-kit/core/uns/uns-proxy.js";
+const normalizeTaskOptions = (options) => {
+    if (!options) {
+        return undefined;
+    }
+    const { event: _event, ...taskOptions } = options;
+    return Object.keys(taskOptions).length > 0 ? taskOptions : undefined;
+};
+const normalizeCronSchedules = (input, options) => {
+    const defaultEvent = options?.event;
+    const defaultOptions = normalizeTaskOptions(options);
+    const toSchedule = (cronExpression, event, scheduleOptions) => ({
+        cronExpression,
+        event,
+        options: scheduleOptions,
+    });
+    if (typeof input === "string") {
+        return [toSchedule(input, defaultEvent, defaultOptions)];
+    }
+    return input.map((entry) => {
+        if (typeof entry === "string") {
+            return toSchedule(entry, defaultEvent, defaultOptions);
+        }
+        return toSchedule(entry.cronExpression, entry.event ?? defaultEvent, entry.options ?? defaultOptions);
+    });
+};
 export default class UnsCronProxy extends UnsProxy {
-    cronExpression;
-    task;
-    constructor(cronExpression, options) {
+    tasks;
+    constructor(cronInput, options) {
         super();
-        this.cronExpression = cronExpression;
-        this.task = cron.schedule(this.cronExpression, () => {
-            this.event.emit("cronEvent", {});
-        }, options);
+        const schedules = normalizeCronSchedules(cronInput, options);
+        this.tasks = schedules.map((schedule) => cron.schedule(schedule.cronExpression, () => {
+            this.event.emit("cronEvent", {
+                event: schedule.event,
+                cronExpression: schedule.cronExpression,
+            });
+        }, schedule.options));
     }
     async stop() {
         await super.stop();
-        this.task.stop();
+        this.tasks.forEach((task) => task.stop());
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/cron",
-  "version": "0.0.38",
+  "version": "0.0.41",
   "description": "Cron-driven plugin for UnsProxyProcess that emits UNS events on a schedule.",
   "type": "module",
   "license": "MIT",
@@ -32,10 +32,11 @@
   "types": "dist/index.d.ts",
   "dependencies": {
     "node-cron": "^4.2.1",
-    "@uns-kit/core": "1.0.27"
+    "@uns-kit/core": "1.0.31"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "typecheck": "tsc -p tsconfig.json --noEmit"
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "postversion": "node ../../scripts/update-cli-package-version.cjs"
   }
 }