work-dispatcher 1.1.0 → 1.1.2

package/dist/index.d.ts

@@ -1,3 +1,13 @@
-declare function sayHello(name: string): string;
-export { sayHello };
+export { getDispatcherVersion } from './utils/version.js';
+export { fine, debug, info, warn, error } from './utils/logging.js';
+export { SPACE, QUOTATION, HASHTAG, AMPERSAND, APOSTROPHE, BRACKET_OPEN, BRACKET_CLOSE, SMALLER, EQUALS, TILDE, AE } from './utils/HTMLHelper.js';
+export { sleep, pad, waitSyncMS } from './utils/generalUtil.js';
+export { dateToIsoString, dateToICALString, dateToJQLString, getDateByDayAndSetPos, getNextWeekday, getPreviousWeekday, getDateFromString, getStringFromDate, cloneDate, minutesToString, dateToWeekNumber } from './utils/dateHelper.js';
+export { dispatcherConfig } from './config/config.js';
+export { _callUrl } from './utils/httpHelper.js';
+export { Feature, FEATURE_STATUS } from './work/featureClass.js';
+export { addFeaturesToQ, terminate, resetQ, addEventToList, getCurrentQ, getPastQ, getCurrentFeature, startWorking, setCurrentlyWorkingOn, currentlyWorkingOn, cancelFeatureRequested, setFeatureResult, addToFeatureResult, skipCurrentlyWorkingFeature, } from './work/workQ.js';
+export { getHealth } from './work/health.js';
+export { pauseFeature } from './work/pause.js';
+export declare function init(handlers: any, allFeatureSet: any[]): void;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,iBAAS,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEtC;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,uBAAuB,CAAC;AAClJ,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,eAAe,EAAE,qBAAqB,EAAE,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,SAAS,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC1O,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EACL,cAAc,EACd,SAAS,EACT,MAAM,EACN,cAAc,EACd,WAAW,EACX,QAAQ,EACR,iBAAiB,EACjB,YAAY,EACZ,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,GAC5B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,wBAAgB,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,QAiBvD"}

package/dist/index.js

@@ -1,6 +1,35 @@
-console.log('Work Dispatcher Module Loaded');
-function sayHello(name) {
-    return `Hello, ${name}! Sam says`;
+import { dispatcherConfig } from './config/config.js';
+import { error, info } from './utils/logging.js';
+import { getDispatcherVersion } from './utils/version.js';
+export { getDispatcherVersion } from './utils/version.js';
+export { fine, debug, info, warn, error } from './utils/logging.js';
+export { SPACE, QUOTATION, HASHTAG, AMPERSAND, APOSTROPHE, BRACKET_OPEN, BRACKET_CLOSE, SMALLER, EQUALS, TILDE, AE } from './utils/HTMLHelper.js';
+export { sleep, pad, waitSyncMS } from './utils/generalUtil.js';
+export { dateToIsoString, dateToICALString, dateToJQLString, getDateByDayAndSetPos, getNextWeekday, getPreviousWeekday, getDateFromString, getStringFromDate, cloneDate, minutesToString, dateToWeekNumber } from './utils/dateHelper.js';
+export { dispatcherConfig } from './config/config.js';
+export { _callUrl } from './utils/httpHelper.js';
+export { Feature, FEATURE_STATUS } from './work/featureClass.js';
+export { addFeaturesToQ, terminate, resetQ, addEventToList, getCurrentQ, getPastQ, getCurrentFeature, startWorking, setCurrentlyWorkingOn, currentlyWorkingOn, cancelFeatureRequested, setFeatureResult, addToFeatureResult, skipCurrentlyWorkingFeature, } from './work/workQ.js';
+export { getHealth } from './work/health.js';
+export { pauseFeature } from './work/pause.js';
+export function init(handlers, allFeatureSet) {
+    info('DISPATCHER.JS', 'Now initializing');
+    info('DISPATCHER.JS', 'Currently running with work-dispatcher version', getDispatcherVersion());
+    if (!handlers.errorHandler) {
+        error('DISPATCHER.JS', 'No errorHandler was provided which is needed for dispatcher.js to start. Application will now exit');
+        process.exit(1);
+    }
+    if (!handlers.emptyQHandler) {
+        handlers.emptyQHandler = doNothing;
+    }
+    dispatcherConfig.handlers = handlers;
+    dispatcherConfig.allFeatureSet = allFeatureSet;
+    if (process.env['DOCKER_ENV'] === 'ci-test') {
+        info('DISPATCHER.JS', 'Running in CI test mode, not starting server or cron jobs.');
+        process.exit(0);
+    }
+}
+async function doNothing() {
+    // intentionally empty
 }
-export { sayHello };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;AAE7C,SAAS,QAAQ,CAAC,IAAY;IAC5B,OAAO,UAAU,IAAI,YAAY,CAAC;AACpC,CAAC;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,uBAAuB,CAAC;AAClJ,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,eAAe,EAAE,qBAAqB,EAAE,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,SAAS,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC1O,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EACL,cAAc,EACd,SAAS,EACT,MAAM,EACN,cAAc,EACd,WAAW,EACX,QAAQ,EACR,iBAAiB,EACjB,YAAY,EACZ,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,GAC5B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,UAAU,IAAI,CAAC,QAAa,EAAE,aAAoB;IACtD,IAAI,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC;IAC1C,IAAI,CAAC,eAAe,EAAE,gDAAgD,EAAE,oBAAoB,EAAE,CAAC,CAAC;IAChG,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;QAC3B,KAAK,CAAC,eAAe,EAAE,oGAAoG,CAAC,CAAC;QAC7H,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;QAC5B,QAAQ,CAAC,aAAa,GAAG,SAAS,CAAC;IACrC,CAAC;IACD,gBAAgB,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACrC,gBAAgB,CAAC,aAAa,GAAG,aAAa,CAAC;IAE/C,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,eAAe,EAAE,4DAA4D,CAAC,CAAC;QACpF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,SAAS;IACtB,sBAAsB;AACxB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "work-dispatcher",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Typescript library to handle task or work scheduling",
   "keywords": [
     "typescript"
@@ -16,10 +16,11 @@
   "license": "GPL-3.0",
   "author": "PhilippAuch",
   "type": "module",
-  "main": "index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "test": "NODE_ENV=TEST vitest"
+    "test": "NODE_ENV=TEST vitest --coverage"
   },
   "release": {
     "branches": [
@@ -28,6 +29,7 @@
   },
   "devDependencies": {
     "@types/node": "^25.0.3",
+    "@vitest/coverage-v8": "^4.0.16",
     "semantic-release": "^25.0.2",
     "typescript": "^5.9.3",
     "vitest": "^4.0.16"

package/res/views/index.ejs

@@ -0,0 +1,129 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title><%= pageTitle; %></title>
+    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Condensed" />
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.0.0/dist/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous" />
+    <link rel="stylesheet" href="status.css" />
+    <script>
+      document.addEventListener('DOMContentLoaded', function (event) {
+        var scrollpos = localStorage.getItem('scrollpos');
+        if (scrollpos) window.scrollTo(0, scrollpos);
+
+        setTimeout(function () {
+          localStorage.setItem('scrollpos', window.scrollY);
+          window.location.href = window.location.pathname; // This removes query parameters
+        }, 2000); // 2 seconds, same as your meta refresh
+      });
+
+      window.onbeforeunload = function (e) {
+        localStorage.setItem('scrollpos', window.scrollY);
+      };
+    </script>
+  </head>
+
+  <body>
+    <p style="text-align: center"><%= pageTitle; %> <%= softwareVersion; %> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Startup: <%= startupTime; %> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Dispatcher.js <%= dispatcherVersion; %></p>
+
+    <div style="display: flex; justify-content: center; gap: 2em">
+      <div>
+        <form action="/trigger" method="get" id="triggerForm">
+          <button type="submit" class="btn btn-outline-primary btn-sm" form="triggerForm">TRIGGER</button>
+        </form>
+      </div>
+      <div>
+        <form action="/skip" method="get" id="skipForm">
+          <button type="submit" class="btn btn-outline-primary btn-sm" form="skipForm">SKIP</button>
+        </form>
+      </div>
+      <div>
+        <form action="/pause" method="get" id="pauseForm">
+          <button type="submit" class="btn btn-outline-primary btn-sm" form="pauseForm">PAUSE</button>
+        </form>
+      </div>
+      <div>
+        <form action="/reset" method="get" id="resetForm">
+          <button type="submit" class="btn btn-outline-primary btn-sm" form="resetForm">RESET</button>
+        </form>
+      </div>
+      <div>
+        <form action="/reboot" method="get" id="rebootForm">
+          <button type="submit" class="btn btn-outline-primary btn-sm" form="rebootForm">REBOOT</button>
+        </form>
+      </div>
+    </div>
+
+    <br />
+
+    <!-- current feature -->
+    <% if (currentFeature) { %>
+    <div class="flexContainer currentFeature">
+      <%= currentFeature.name; %>
+      <b> <%= currentFeature.getDurationString(); %> </b>
+      <% if (currentFeature.params) { %>
+      <br /><span>Params: <%= currentFeature.params; %></span>
+      <% } %>
+      <span style="font-size: 0.5rem">Added: <%= currentFeature.timeAdded.toLocaleDateString(undefined, dateOptions); %></span>
+
+      <% if (currentlyWorkingOn.length> 0) { %>
+      <br /><span>CWO: <%= currentlyWorkingOn; %></span>
+      <% } %> <% if (currentFeature.result && currentFeature.result.length> 0) { %>
+      <br /><span
+        ><b>Result</b><br />
+        <%- currentFeature.result; %></span
+      >
+      <% } %>
+    </div>
+    <% } %>
+
+    <div class="leftHalf">
+      <span class="counter">Counter: <%= currentQ.length; %></span>
+      <ul>
+        <% for(var i=0; i < currentQ.length; i++) { %>
+        <li class="flexContainer currentQ<%= (currentQ[i].type === 'EVENT') ? ' eventType' : '' %>">
+          <span style="flex: 1 0 45%"> <%= currentQ[i].name; %> </span>
+          <% if (currentQ[i].params) { %>
+          <br /><span>Params: <%= currentQ[i].params; %></span>
+          <% } %>
+          <span style="flex: 1 0 45%; font-size: 0.5rem; text-align: right">Added: <%= currentQ[i].timeAdded.toLocaleDateString( undefined, dateOptions); %></span>
+        </li>
+        <% } %>
+      </ul>
+    </div>
+
+    <div class="rightHalf">
+      <span class="counter">Counter: <%= pastQ.length; %></span>
+      <ul>
+        <% for(var i=0; i < pastQ.length; i++) { %>
+        <li
+          class="flexContainer <%= (pastQ[i].errorForFeature && pastQ[i].errorForFeature.length > 0) ? 'pastError' : (pastQ[i].result && pastQ[i].result.length > 0) ? 'pastResult' : 'pastQ' %> <%= (pastQ[i].type === 'EVENT') ? ' eventType' : '' %>"
+        >
+          <span style="flex: 2 0 40%"> <%= pastQ[i].name; %> </span>
+          <span style="flex: 1 0 20%; text-align: right"><b> <%= pastQ[i].durationString; %> </b></span>
+          <% if (pastQ[i].params) { %>
+          <br /><span>Params: <%= pastQ[i].params; %></span>
+          <% } %>
+
+          <span style="flex: 1 0 20%; font-size: 0.5rem; text-align: right">
+            Added: <%= pastQ[i].timeAdded.toLocaleDateString( undefined, dateOptions); %> <br />
+            Finished: <%= new Date(pastQ[i].startDate).toLocaleDateString(undefined, dateOptions); %>
+          </span>
+          <% if (pastQ[i].result && pastQ[i].result.length> 0) { %>
+          <span>
+            <b>Result</b><br />
+            <%- pastQ[i].result; %>
+          </span>
+          <% } %> <% if (pastQ[i].errorForFeature && pastQ[i].errorForFeature.length > 0) { %>
+          <span>
+            <b>Error</b><br />
+            <%- pastQ[i].errorForFeature; %>
+          </span>
+          <% } %>
+        </li>
+        <% } %>
+      </ul>
+    </div>
+  </body>
+</html>