@uns-kit/cron 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Aljoša Vister
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# @uns-kit/cron
+
+`@uns-kit/cron` adds cron-style scheduling to the UNS runtime. It registers a `createCrontabProxy` method on `UnsProxyProcess`, emitting `cronEvent` notifications that can be bridged to MQTT topics or any downstream integration.
+
+## Installation
+
+```bash
+pnpm add @uns-kit/cron
+# or
+npm install @uns-kit/cron
+```
+
+You will also need `@uns-kit/core` in your project because the plugin augments `UnsProxyProcess`.
+
+## Quick Start
+
+```ts
+import UnsProxyProcess from "@uns-kit/core/uns/uns-proxy-process";
+import unsCronPlugin, { type UnsProxyProcessWithCron } from "@uns-kit/cron";
+
+const process = new UnsProxyProcess("mqtt-broker:1883", { processName: "cron-demo" }) as UnsProxyProcessWithCron;
+unsCronPlugin;
+
+const cronProxy = await process.createCrontabProxy("* * * * * *");
+cronProxy.event.on("cronEvent", () => {
+  console.log("tick");
+});
+```
+
+## Scripts
+
+```bash
+pnpm run typecheck
+pnpm run build
+```
+
+`build` emits ESM JavaScript and type declarations into `dist/`.
+
+## License
+
+MIT © Aljoša Vister

package/dist/cron-example.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cron-example.js

@@ -0,0 +1,41 @@
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ */
+import UnsProxyProcess from "@uns-kit/core/uns/uns-proxy-process";
+import { ConfigFile } from "@uns-kit/core/config-file";
+import logger from "@uns-kit/core/logger";
+import { PhysicalMeasurements } from "@uns-kit/core/uns/uns-measurements";
+import { UnsPacket } from "@uns-kit/core/uns/uns-packet";
+import unsCronPlugin from "./uns-cron-plugin";
+/**
+ * Load the configuration from a file.
+ * On the server, this file is provided by the `uns-datahub-controller`.
+ * In the development environment, you are responsible for creating and maintaining this file and its contents.
+ */
+const config = await ConfigFile.loadConfig();
+/**
+ * Connect to the output broker and create a crontab proxy
+ */
+const unsProxyProcess = new UnsProxyProcess(config.infra.host, { processName: config.uns.processName });
+unsCronPlugin;
+const mqttOutput = await unsProxyProcess.createUnsMqttProxy(config.output.host, "templateUnsRttOutput", config.uns.instanceMode, config.uns.handover, { publishThrottlingDelay: 1000 });
+const cronInput = await unsProxyProcess.createCrontabProxy("* * * * * *");
+/**
+ * Event listener for cron events.
+ * On each cron event, publish a message to the MQTT output broker.
+ */
+cronInput.event.on("cronEvent", async (event) => {
+    try {
+        const time = UnsPacket.formatToISO8601(new Date());
+        const numberValue = 42;
+        const message = { data: { time, value: numberValue, uom: PhysicalMeasurements.MiliVolt } };
+        const topic = "sij/";
+        const tags = [];
+        const packet = await UnsPacket.unsPacketFromUnsMessage(message);
+        mqttOutput.publishMqttMessage({ topic, attribute: "data-number", packet, description: "Number value", tags });
+    }
+    catch (error) {
+        logger.error(`Error publishing message to MQTT: ${error.message}`);
+        throw error;
+    }
+});

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+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";

package/dist/index.js

@@ -0,0 +1,3 @@
+export { default } from "./uns-cron-plugin.js";
+export { UnsCronProxy } from "./uns-cron-plugin.js";
+export { default as UnsCronProxyClass } from "./uns-cron-proxy.js";

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

@@ -0,0 +1,9 @@
+import type { TaskOptions } from "node-cron";
+import UnsProxyProcess, { type UnsProxyProcessPlugin } from "@uns-kit/core/uns/uns-proxy-process";
+import UnsCronProxy 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>;
+};

package/dist/uns-cron-plugin.js

@@ -0,0 +1,24 @@
+import UnsProxyProcess from "@uns-kit/core/uns/uns-proxy-process";
+import UnsCronProxy from "./uns-cron-proxy.js";
+const cronProxyRegistry = new WeakMap();
+const getCronProxies = (instance) => {
+    let proxies = cronProxyRegistry.get(instance);
+    if (!proxies) {
+        proxies = [];
+        cronProxyRegistry.set(instance, proxies);
+    }
+    return proxies;
+};
+const unsCronPlugin = ({ define }) => {
+    define({
+        async createCrontabProxy(cronExpression, options) {
+            await this.waitForProcessConnection();
+            const unsCronProxy = new UnsCronProxy(cronExpression, options);
+            getCronProxies(this).push(unsCronProxy);
+            return unsCronProxy;
+        },
+    });
+};
+UnsProxyProcess.use(unsCronPlugin);
+export default unsCronPlugin;
+export { UnsCronProxy };

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

@@ -0,0 +1,8 @@
+import { TaskOptions } from "node-cron";
+import UnsProxy from "@uns-kit/core/uns/uns-proxy";
+export default class UnsCronProxy extends UnsProxy {
+    private readonly cronExpression;
+    private readonly task;
+    constructor(cronExpression: string, options?: TaskOptions);
+    stop(): Promise<void>;
+}

package/dist/uns-cron-proxy.js

@@ -0,0 +1,17 @@
+import cron from "node-cron";
+import UnsProxy from "@uns-kit/core/uns/uns-proxy";
+export default class UnsCronProxy extends UnsProxy {
+    cronExpression;
+    task;
+    constructor(cronExpression, options) {
+        super();
+        this.cronExpression = cronExpression;
+        this.task = cron.schedule(this.cronExpression, () => {
+            this.event.emit("cronEvent", {});
+        }, options);
+    }
+    async stop() {
+        await super.stop();
+        this.task.stop();
+    }
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@uns-kit/cron",
+  "version": "0.0.1",
+  "description": "Cron-driven plugin for UnsProxyProcess that emits UNS events on a schedule.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Aljoša Vister <aljosa.vister@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/uns-datahub/uns-kit.git",
+    "directory": "packages/uns-cron"
+  },
+  "keywords": [
+    "uns",
+    "cron",
+    "scheduler",
+    "mqtt",
+    "node-cron",
+    "typescript"
+  ],
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./*": "./dist/*"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@uns-kit/core": "^0.0.1",
+    "node-cron": "^4.2.1"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}