@keeex/utils 7.1.0 → 7.2.0

package/README.md

@@ -9,13 +9,19 @@ This is a general feature list overview.
 
 ## Async utility
 
+Stuff related to promises and async operations.
+
 - `AsyncTrigger`, for easy debouncing
 - `DeferredPromise` to manipulate the usual `resolve()` and `reject()` functions outside of a
   promise block
 - `KeyCache` to create a basic key-value cache with asynchronous fetch
+- `Queues` to create parallel queues of tasks
 - `TimeCache` to create a cache that keeps a value for a given amount of time and can automatically
   refresh it
-- `Queues` to create parallel queues of tasks
+
+## CRON
+
+Time-based task scheduling.
 
 ## Marshalling
 
@@ -50,6 +56,7 @@ Helper wrapping JavaScript DataView into convenient functions.
 ## dict
 
 Functions to copy records with primitive types (deep copy).
+These functions can probably be replaced with `Object.assign()` or custom code.
 
 ## error
 
@@ -60,6 +67,10 @@ Coerce anything (`unknown`) into an `Error` object for easier error handling.
 Functions to use a JavaScript environment "global" dataset.
 Handles multiple environment somewhat gracefully.
 
+## hex
+
+Hex string manipulation.
+
 ## idx
 
 IDX check and manipulation functions
@@ -69,10 +80,9 @@ IDX check and manipulation functions
 JSON parsing with type safety.
 Also, a "canonical" JSON encoder that ensure property order is consistent.
 
-## log
+## line buffer
 
-Generic logging functionality.
-Supports various log level, timestamping, error chaining, stacktrace stripping.
+Buffer string inputs and output full lines only.
 
 ## number
 
@@ -90,6 +100,7 @@ Helpers around promises.
 - controlled async delay
 - retry a promise until it succeed (with max tries)
 - run an array of promise, stop at the first that succeed
+- silently drop a promise without crashing the VM
 
 ## starttime
 

package/lib/cron/scheduledtask.d.ts

@@ -13,59 +13,14 @@
  * 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.
  * 
  */
-import { TaskFunction, CompleteTaskOptions } from "./types.js";
-/**
- * Manage a single scheduled task
- */
+import * as log from "@keeex/log";
+import * as types from "./types.js";
+/** Manage a single scheduled task */
 export default class ScheduledTask {
-    private readonly _cronDefinition;
-    private readonly _func;
-    private readonly _opts;
-    /**
-     * Indicate that the task missed a previous tick
-     */
-    private readonly _restartImmediate;
-    /**
-     * If the task is canceled (prevent looping)
-     */
-    private _canceled;
-    /**
-     * Timeout handler
-     */
-    private _timeoutHandler;
-    /**
-     * Last run time (timestamp)
-     */
-    private _lastRun;
-    constructor(cronDefinition: string, func: TaskFunction, opts: CompleteTaskOptions);
-    /**
-     * Determine if the task should be running right now
-     */
+    #private;
+    constructor(cronDefinition: string, func: types.TaskFunction, opts: types.CompleteTaskOptions, logger?: log.Logger);
+    /** Determine if the task should be running right now */
     get runnable(): boolean;
-    /**
-     * Cancel the task from the scheduling
-     */
-    cancel(): void;
-    /**
-     * Run the task
-     *
-     * All special cases are handled there (task already running).
-     * Updating the next value is also handled here.
-     */
-    private _run;
-    /**
-     * Reschedule the task for the next occurrence
-     */
-    private _reschedule;
-    /**
-     * Return the timeout delay before the next task scheduling.
-     *
-     * This can return a lower value if the task is scheduled in the distant
-     * future.
-     */
-    private _getTimeoutDelay;
-    /**
-     * Return the next scheduled time starting from the given point in time
-     */
-    private _getNextSchedule;
+    /** Cancel the task from the scheduling */
+    cancel: () => void;
 }

package/lib/cron/scheduledtask.js

@@ -13,125 +13,104 @@
  * 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.
  * 
  */
+import * as log from "@keeex/log";
 import { CronExpressionParser } from "cron-parser";
+import { asError } from "../error.js";
 import { dropPromise } from "../promise.js";
-import { logError } from "./logger.js";
-import { Overrun } from "./types.js";
+import * as types from "./types.js";
 /**
  * Maximum delay for a timeout.
  * Done because setTimeout() sometimes can only accept a 32bit integer
  */
 // eslint-disable-next-line @typescript-eslint/no-magic-numbers
 const maxTimeoutDelay = 2 ** 31;
-/**
- * Manage a single scheduled task
- */
+/** Manage a single scheduled task */
 export default class ScheduledTask {
-    _cronDefinition;
-    _func;
-    _opts;
-    /**
-     * Indicate that the task missed a previous tick
-     */
-    _restartImmediate = false;
-    /**
-     * If the task is canceled (prevent looping)
-     */
-    _canceled = false;
-    /**
-     * Timeout handler
-     */
-    _timeoutHandler;
-    /**
-     * Last run time (timestamp)
-     */
-    _lastRun;
-    constructor(cronDefinition, func, opts) {
-        this._cronDefinition = cronDefinition;
-        this._func = func;
-        this._opts = opts;
-        this._lastRun = Date.now();
-        this._timeoutHandler = setTimeout(() => dropPromise(this._run()), Math.max(0, this._getTimeoutDelay()));
+    #cronDefinition;
+    #func;
+    #opts;
+    /** If the task is canceled (prevent looping) */
+    #canceled = false;
+    /** Timeout handler */
+    #timeoutHandler;
+    /** Last run time (timestamp) */
+    #lastRun;
+    #logger;
+    constructor(cronDefinition, func, opts, logger = log.logger) {
+        this.#logger = logger;
+        this.#cronDefinition = cronDefinition;
+        this.#func = func;
+        this.#opts = opts;
+        this.#lastRun = Date.now();
+        this.#timeoutHandler = setTimeout(() => dropPromise(this.#run()), Math.max(0, this.#getTimeoutDelay()));
     }
-    /**
-     * Determine if the task should be running right now
-     */
+    /** Determine if the task should be running right now */
     get runnable() {
-        return this._getNextSchedule() <= Date.now();
+        return this.#getNextSchedule() <= Date.now();
     }
-    /**
-     * Cancel the task from the scheduling
-     */
-    cancel() {
-        if (this._timeoutHandler) {
-            clearTimeout(this._timeoutHandler);
-            this._timeoutHandler = null;
+    /** Cancel the task from the scheduling */
+    cancel = () => {
+        if (this.#timeoutHandler) {
+            clearTimeout(this.#timeoutHandler);
+            this.#timeoutHandler = null;
         }
-        this._canceled = true;
-    }
+        this.#canceled = true;
+    };
     /**
      * Run the task
      *
      * All special cases are handled there (task already running).
      * Updating the next value is also handled here.
      */
-    async _run() {
-        this._timeoutHandler = null;
+    #run = async () => {
+        this.#timeoutHandler = null;
         if (this.runnable) {
-            this._lastRun = Date.now();
+            this.#lastRun = Date.now();
             try {
-                await this._func();
+                await this.#func();
             }
             catch (error) {
-                if (error instanceof Error) {
-                    logError(error);
-                }
-                logError(new Error(`Unknown error: ${error.toString()}`));
+                this.#logger.error(asError(error));
             }
         }
-        this._reschedule();
-    }
-    /**
-     * Reschedule the task for the next occurrence
-     */
-    _reschedule() {
-        if (this._canceled) {
+        this.#reschedule();
+    };
+    /** Reschedule the task for the next occurrence */
+    #reschedule = () => {
+        if (this.#canceled)
             return;
-        }
-        let nextDelay = this._getTimeoutDelay();
+        let nextDelay = this.#getTimeoutDelay();
         if (nextDelay < 0) {
             // We overshot
-            switch (this._opts.overrun) {
-                case Overrun.AFTER:
+            switch (this.#opts.overrun) {
+                case types.Overrun.AFTER:
                     // Reschedule immediately
                     nextDelay = 0;
                     break;
-                case Overrun.SKIP:
+                case types.Overrun.SKIP:
                     // Reschedule for the next time slot
-                    this._lastRun = Date.now();
-                    nextDelay = this._getTimeoutDelay();
+                    this.#lastRun = Date.now();
+                    nextDelay = this.#getTimeoutDelay();
             }
         }
-        this._timeoutHandler = setTimeout(() => dropPromise(this._run()), Math.max(0, nextDelay));
-    }
+        this.#timeoutHandler = setTimeout(() => dropPromise(this.#run()), Math.max(0, nextDelay));
+    };
     /**
      * Return the timeout delay before the next task scheduling.
      *
      * This can return a lower value if the task is scheduled in the distant
      * future.
      */
-    _getTimeoutDelay() {
+    #getTimeoutDelay = () => {
         const current = Date.now();
-        const next = this._getNextSchedule();
+        const next = this.#getNextSchedule();
         return Math.min(next - current, maxTimeoutDelay);
-    }
-    /**
-     * Return the next scheduled time starting from the given point in time
-     */
-    _getNextSchedule() {
-        const nextOccurrence = CronExpressionParser.parse(this._cronDefinition, {
-            currentDate: this._lastRun,
+    };
+    /** Return the next scheduled time starting from the given point in time */
+    #getNextSchedule = () => {
+        const nextOccurrence = CronExpressionParser.parse(this.#cronDefinition, {
+            currentDate: this.#lastRun,
         }).next();
         return nextOccurrence.getTime();
-    }
+    };
 }

package/lib/cron/types.d.ts

@@ -20,7 +20,6 @@
  * promise didn't complete
  */
 export type TaskFunction = () => Promise<void> | void;
-export type LoggerFunction = (error: Error) => void;
 /**
  * Behavior when a task is scheduled to start while it's already running
  */

package/lib/cron.d.ts

@@ -13,17 +13,18 @@
  * 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.
  * 
  */
+import { Logger } from "@keeex/log";
 import ScheduledTask from "./cron/scheduledtask.js";
 import { TaskFunction, TaskOptions, Overrun, CompleteTaskOptions } from "./cron/types.js";
 export { Overrun };
 export type { ScheduledTask, TaskFunction, TaskOptions, CompleteTaskOptions };
-export declare const setLoggerFunction: (logFunc?: import("./cron/types.js").LoggerFunction) => void;
 /**
  * Schedule a task for execution
  *
  * @param cronDefinition - CRON timing for the task
  * @param task - The task function to run at the scheduled time
  * @param taskOptions - The behavior of the task
+ * @param logger - Logger for errors
  */
-export declare const schedule: (cronDefinition: string, task: TaskFunction, taskOptions?: TaskOptions) => ScheduledTask;
+export declare const schedule: (cronDefinition: string, task: TaskFunction, taskOptions?: TaskOptions, logger?: Logger) => ScheduledTask;
 export declare const stop: () => void;

package/lib/cron.js

@@ -13,12 +13,10 @@
  * 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.
  * 
  */
-import { setLoggerFunction as bitsSetLoggerFunction } from "./cron/logger.js";
 import ScheduledTask from "./cron/scheduledtask.js";
 import { Overrun } from "./cron/types.js";
 const scheduledTasks = [];
 export { Overrun };
-export const setLoggerFunction = bitsSetLoggerFunction;
 /**
  * Set default values for task options
  */
@@ -35,9 +33,10 @@ const getDefaultTaskOptions = (taskOptions) => {
  * @param cronDefinition - CRON timing for the task
  * @param task - The task function to run at the scheduled time
  * @param taskOptions - The behavior of the task
+ * @param logger - Logger for errors
  */
-export const schedule = (cronDefinition, task, taskOptions) => {
-    const newTask = new ScheduledTask(cronDefinition, task, getDefaultTaskOptions(taskOptions));
+export const schedule = (cronDefinition, task, taskOptions, logger) => {
+    const newTask = new ScheduledTask(cronDefinition, task, getDefaultTaskOptions(taskOptions), logger);
     scheduledTasks.push(newTask);
     return newTask;
 };

package/lib/{cron/logger.d.ts → linebuffer.d.ts}

@@ -13,10 +13,18 @@
  * 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.
  * 
  */
-import type { LoggerFunction } from "./types.js";
+/** Callback called on each line from `LineBuffer` */
+export type OutputCallback = (msg: string) => void;
 /**
- * Change the function used to log errors
- * @param logFunc - Callback that will receive errors
+ * Bufferize input and produce output on newlines.
+ *
+ * The provided callback will be called on all lines, but will not get the newline character.
  */
-export declare const setLoggerFunction: (logFunc?: LoggerFunction) => void;
-export declare const logError: (error: Error) => void;
+export declare class LineBuffer {
+    #private;
+    constructor(cb: OutputCallback, separator?: string);
+    /** Call this method to add data to the buffer, and output all complete lines */
+    feed: (msg: string) => void;
+    /** Call this method to purge all currently buffered data */
+    purge: () => void;
+}

package/{web/cron/logger.d.ts → lib/linebuffer.js}

@@ -13,10 +13,35 @@
  * 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.
  * 
  */
-import type { LoggerFunction } from "./types.js";
 /**
- * Change the function used to log errors
- * @param logFunc - Callback that will receive errors
+ * Bufferize input and produce output on newlines.
+ *
+ * The provided callback will be called on all lines, but will not get the newline character.
  */
-export declare const setLoggerFunction: (logFunc?: LoggerFunction) => void;
-export declare const logError: (error: Error) => void;
+export class LineBuffer {
+    #bufferedInput = "";
+    #callback;
+    #separator;
+    constructor(cb, separator = "\n") {
+        this.#callback = cb;
+        this.#separator = separator;
+    }
+    /** Call this method to add data to the buffer, and output all complete lines */
+    feed = (msg) => {
+        this.#bufferedInput += msg;
+        this.#processInput();
+    };
+    /** Call this method to purge all currently buffered data */
+    purge = () => {
+        this.#callback(this.#bufferedInput);
+        this.#bufferedInput = "";
+    };
+    /** Filter the buffer, and output all full lines */
+    #processInput = () => {
+        for (let i = this.#bufferedInput.indexOf(this.#separator); i !== -1; i = this.#bufferedInput.indexOf(this.#separator)) {
+            const line = this.#bufferedInput.substring(0, i);
+            this.#callback(line);
+            this.#bufferedInput = this.#bufferedInput.substring(i + this.#separator.length);
+        }
+    };
+}

package/package.json

@@ -1 +1 @@
-{"name":"@keeex/utils","version":"7.1.0","description":"Various utility functions for pure JavaScript","scripts":{},"author":"KeeeX SAS","contributors":[{"name":"Gabriel Paul \"Cley Faye\" Risterucci","email":"gabriel@keeex.net"}],"homepage":"https://keeex.me/oss","keywords":["utility"],"type":"module","license":"MIT","dependencies":{"@keeex/bubble_babble":"^3.0.1","@keeex/log":"^1.3.0","base64-arraybuffer":"^1.0.2","cron-parser":"^5.1.1","ms":"^2.1.3","text-encoding-shim":"^1.0.5"},"exports":{"./units.js":{"node":"./lib/units.js","browser":"./web/units.js","default":"./lib/units.js"},"./uint8array.js":{"node":"./lib/uint8array.js","browser":"./web/uint8array.js","default":"./lib/uint8array.js"},"./string.js":{"node":"./lib/string.js","browser":"./web/string.js","default":"./lib/string.js"},"./starttime.js":{"node":"./lib/starttime.js","browser":"./web/starttime.js","default":"./lib/starttime.js"},"./promise.js":{"node":"./lib/promise.js","browser":"./web/promise.js","default":"./lib/promise.js"},"./path.js":{"node":"./lib/path.js","browser":"./web/path.js","default":"./lib/path.js"},"./number.js":{"node":"./lib/number.js","browser":"./web/number.js","default":"./lib/number.js"},"./json.js":{"node":"./lib/json.js","browser":"./web/json.js","default":"./lib/json.js"},"./idx.js":{"node":"./lib/idx.js","browser":"./web/idx.js","default":"./lib/idx.js"},"./hex.js":{"node":"./lib/hex.js","browser":"./web/hex.js","default":"./lib/hex.js"},"./global.js":{"node":"./lib/global.js","browser":"./web/global.js","default":"./lib/global.js"},"./error.js":{"node":"./lib/error.js","browser":"./web/error.js","default":"./lib/error.js"},"./dict.js":{"node":"./lib/dict.js","browser":"./web/dict.js","default":"./lib/dict.js"},"./cron.js":{"node":"./lib/cron.js","browser":"./web/cron.js","default":"./lib/cron.js"},"./consts.js":{"node":"./lib/consts.js","browser":"./web/consts.js","default":"./lib/consts.js"},"./bytebuffer.js":{"node":"./lib/bytebuffer.js","browser":"./web/bytebuffer.js","default":"./lib/bytebuffer.js"},"./benchmark.js":{"node":"./lib/benchmark.js","browser":"./web/benchmark.js","default":"./lib/benchmark.js"},"./base64.js":{"node":"./lib/base64.js","browser":"./web/base64.js","default":"./lib/base64.js"},"./base58.js":{"node":"./lib/base58.js","browser":"./web/base58.js","default":"./lib/base58.js"},"./arraybuffer.js":{"node":"./lib/arraybuffer.js","browser":"./web/arraybuffer.js","default":"./lib/arraybuffer.js"},"./array.js":{"node":"./lib/array.js","browser":"./web/array.js","default":"./lib/array.js"},"./marshalling/unmarshaller.js":{"node":"./lib/marshalling/unmarshaller.js","browser":"./web/marshalling/unmarshaller.js","default":"./lib/marshalling/unmarshaller.js"},"./marshalling/marshaller.js":{"node":"./lib/marshalling/marshaller.js","browser":"./web/marshalling/marshaller.js","default":"./lib/marshalling/marshaller.js"},"./types/utils.js":{"node":"./lib/types/utils.js","browser":"./web/types/utils.js","default":"./lib/types/utils.js"},"./types/types.js":{"node":"./lib/types/types.js","browser":"./web/types/types.js","default":"./lib/types/types.js"},"./types/record.js":{"node":"./lib/types/record.js","browser":"./web/types/record.js","default":"./lib/types/record.js"},"./types/primitive.js":{"node":"./lib/types/primitive.js","browser":"./web/types/primitive.js","default":"./lib/types/primitive.js"},"./types/predicateerror.js":{"node":"./lib/types/predicateerror.js","browser":"./web/types/predicateerror.js","default":"./lib/types/predicateerror.js"},"./types/enum.js":{"node":"./lib/types/enum.js","browser":"./web/types/enum.js","default":"./lib/types/enum.js"},"./types/array.js":{"node":"./lib/types/array.js","browser":"./web/types/array.js","default":"./lib/types/array.js"},"./async/timecache.js":{"node":"./lib/async/timecache.js","browser":"./web/async/timecache.js","default":"./lib/async/timecache.js"},"./async/queues.js":{"node":"./lib/async/queues.js","browser":"./web/async/queues.js","default":"./lib/async/queues.js"},"./async/keycache.js":{"node":"./lib/async/keycache.js","browser":"./web/async/keycache.js","default":"./lib/async/keycache.js"},"./async/deferredpromise.js":{"node":"./lib/async/deferredpromise.js","browser":"./web/async/deferredpromise.js","default":"./lib/async/deferredpromise.js"},"./async/asynctrigger.js":{"node":"./lib/async/asynctrigger.js","browser":"./web/async/asynctrigger.js","default":"./lib/async/asynctrigger.js"}},"files":["/lib","/web"]}
+{"name":"@keeex/utils","version":"7.2.0","description":"Various utility functions for pure JavaScript","scripts":{},"author":"KeeeX SAS","contributors":[{"name":"Gabriel Paul \"Cley Faye\" Risterucci","email":"gabriel@keeex.net"}],"homepage":"https://keeex.me/oss","keywords":["utility"],"type":"module","license":"MIT","dependencies":{"@keeex/bubble_babble":"^3.0.1","@keeex/log":"^1.7.1","base64-arraybuffer":"^1.0.2","cron-parser":"^5.2.0","ms":"^2.1.3","text-encoding-shim":"^1.0.5"},"exports":{"./units.js":{"node":"./lib/units.js","browser":"./web/units.js","default":"./lib/units.js"},"./uint8array.js":{"node":"./lib/uint8array.js","browser":"./web/uint8array.js","default":"./lib/uint8array.js"},"./string.js":{"node":"./lib/string.js","browser":"./web/string.js","default":"./lib/string.js"},"./starttime.js":{"node":"./lib/starttime.js","browser":"./web/starttime.js","default":"./lib/starttime.js"},"./promise.js":{"node":"./lib/promise.js","browser":"./web/promise.js","default":"./lib/promise.js"},"./path.js":{"node":"./lib/path.js","browser":"./web/path.js","default":"./lib/path.js"},"./number.js":{"node":"./lib/number.js","browser":"./web/number.js","default":"./lib/number.js"},"./linebuffer.js":{"node":"./lib/linebuffer.js","browser":"./web/linebuffer.js","default":"./lib/linebuffer.js"},"./json.js":{"node":"./lib/json.js","browser":"./web/json.js","default":"./lib/json.js"},"./idx.js":{"node":"./lib/idx.js","browser":"./web/idx.js","default":"./lib/idx.js"},"./hex.js":{"node":"./lib/hex.js","browser":"./web/hex.js","default":"./lib/hex.js"},"./global.js":{"node":"./lib/global.js","browser":"./web/global.js","default":"./lib/global.js"},"./error.js":{"node":"./lib/error.js","browser":"./web/error.js","default":"./lib/error.js"},"./dict.js":{"node":"./lib/dict.js","browser":"./web/dict.js","default":"./lib/dict.js"},"./cron.js":{"node":"./lib/cron.js","browser":"./web/cron.js","default":"./lib/cron.js"},"./consts.js":{"node":"./lib/consts.js","browser":"./web/consts.js","default":"./lib/consts.js"},"./bytebuffer.js":{"node":"./lib/bytebuffer.js","browser":"./web/bytebuffer.js","default":"./lib/bytebuffer.js"},"./benchmark.js":{"node":"./lib/benchmark.js","browser":"./web/benchmark.js","default":"./lib/benchmark.js"},"./base64.js":{"node":"./lib/base64.js","browser":"./web/base64.js","default":"./lib/base64.js"},"./base58.js":{"node":"./lib/base58.js","browser":"./web/base58.js","default":"./lib/base58.js"},"./arraybuffer.js":{"node":"./lib/arraybuffer.js","browser":"./web/arraybuffer.js","default":"./lib/arraybuffer.js"},"./array.js":{"node":"./lib/array.js","browser":"./web/array.js","default":"./lib/array.js"},"./types/utils.js":{"node":"./lib/types/utils.js","browser":"./web/types/utils.js","default":"./lib/types/utils.js"},"./types/types.js":{"node":"./lib/types/types.js","browser":"./web/types/types.js","default":"./lib/types/types.js"},"./types/record.js":{"node":"./lib/types/record.js","browser":"./web/types/record.js","default":"./lib/types/record.js"},"./types/primitive.js":{"node":"./lib/types/primitive.js","browser":"./web/types/primitive.js","default":"./lib/types/primitive.js"},"./types/predicateerror.js":{"node":"./lib/types/predicateerror.js","browser":"./web/types/predicateerror.js","default":"./lib/types/predicateerror.js"},"./types/enum.js":{"node":"./lib/types/enum.js","browser":"./web/types/enum.js","default":"./lib/types/enum.js"},"./types/array.js":{"node":"./lib/types/array.js","browser":"./web/types/array.js","default":"./lib/types/array.js"},"./marshalling/unmarshaller.js":{"node":"./lib/marshalling/unmarshaller.js","browser":"./web/marshalling/unmarshaller.js","default":"./lib/marshalling/unmarshaller.js"},"./marshalling/marshaller.js":{"node":"./lib/marshalling/marshaller.js","browser":"./web/marshalling/marshaller.js","default":"./lib/marshalling/marshaller.js"},"./async/timecache.js":{"node":"./lib/async/timecache.js","browser":"./web/async/timecache.js","default":"./lib/async/timecache.js"},"./async/queues.js":{"node":"./lib/async/queues.js","browser":"./web/async/queues.js","default":"./lib/async/queues.js"},"./async/keycache.js":{"node":"./lib/async/keycache.js","browser":"./web/async/keycache.js","default":"./lib/async/keycache.js"},"./async/deferredpromise.js":{"node":"./lib/async/deferredpromise.js","browser":"./web/async/deferredpromise.js","default":"./lib/async/deferredpromise.js"},"./async/asynctrigger.js":{"node":"./lib/async/asynctrigger.js","browser":"./web/async/asynctrigger.js","default":"./lib/async/asynctrigger.js"}},"files":["/lib","/web"]}

package/web/cron/scheduledtask.d.ts

@@ -13,59 +13,14 @@
  * 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.
  * 
  */
-import { TaskFunction, CompleteTaskOptions } from "./types.js";
-/**
- * Manage a single scheduled task
- */
+import * as log from "@keeex/log";
+import * as types from "./types.js";
+/** Manage a single scheduled task */
 export default class ScheduledTask {
-    private readonly _cronDefinition;
-    private readonly _func;
-    private readonly _opts;
-    /**
-     * Indicate that the task missed a previous tick
-     */
-    private readonly _restartImmediate;
-    /**
-     * If the task is canceled (prevent looping)
-     */
-    private _canceled;
-    /**
-     * Timeout handler
-     */
-    private _timeoutHandler;
-    /**
-     * Last run time (timestamp)
-     */
-    private _lastRun;
-    constructor(cronDefinition: string, func: TaskFunction, opts: CompleteTaskOptions);
-    /**
-     * Determine if the task should be running right now
-     */
+    #private;
+    constructor(cronDefinition: string, func: types.TaskFunction, opts: types.CompleteTaskOptions, logger?: log.Logger);
+    /** Determine if the task should be running right now */
     get runnable(): boolean;
-    /**
-     * Cancel the task from the scheduling
-     */
-    cancel(): void;
-    /**
-     * Run the task
-     *
-     * All special cases are handled there (task already running).
-     * Updating the next value is also handled here.
-     */
-    private _run;
-    /**
-     * Reschedule the task for the next occurrence
-     */
-    private _reschedule;
-    /**
-     * Return the timeout delay before the next task scheduling.
-     *
-     * This can return a lower value if the task is scheduled in the distant
-     * future.
-     */
-    private _getTimeoutDelay;
-    /**
-     * Return the next scheduled time starting from the given point in time
-     */
-    private _getNextSchedule;
+    /** Cancel the task from the scheduling */
+    cancel: () => void;
 }

package/web/cron/scheduledtask.js

@@ -13,124 +13,102 @@
  * 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.
  * 
  */
+import * as log from "@keeex/log";
 import { CronExpressionParser } from "cron-parser";
+import { asError } from "../error.js";
 import { dropPromise } from "../promise.js";
-import { logError } from "./logger.js";
-import { Overrun } from "./types.js";
+import * as types from "./types.js";
 /**
  * Maximum delay for a timeout.
  * Done because setTimeout() sometimes can only accept a 32bit integer
  */
 // eslint-disable-next-line @typescript-eslint/no-magic-numbers
 const maxTimeoutDelay = 2 ** 31;
-/**
- * Manage a single scheduled task
- */
+/** Manage a single scheduled task */
 export default class ScheduledTask {
-  _cronDefinition;
-  _func;
-  _opts;
-  /**
-   * Indicate that the task missed a previous tick
-   */
-  _restartImmediate = false;
-  /**
-   * If the task is canceled (prevent looping)
-   */
-  _canceled = false;
-  /**
-   * Timeout handler
-   */
-  _timeoutHandler;
-  /**
-   * Last run time (timestamp)
-   */
-  _lastRun;
-  constructor(cronDefinition, func, opts) {
-    this._cronDefinition = cronDefinition;
-    this._func = func;
-    this._opts = opts;
-    this._lastRun = Date.now();
-    this._timeoutHandler = setTimeout(() => dropPromise(this._run()), Math.max(0, this._getTimeoutDelay()));
+  #cronDefinition;
+  #func;
+  #opts;
+  /** If the task is canceled (prevent looping) */
+  #canceled = false;
+  /** Timeout handler */
+  #timeoutHandler;
+  /** Last run time (timestamp) */
+  #lastRun;
+  #logger;
+  constructor(cronDefinition, func, opts, logger = log.logger) {
+    this.#logger = logger;
+    this.#cronDefinition = cronDefinition;
+    this.#func = func;
+    this.#opts = opts;
+    this.#lastRun = Date.now();
+    this.#timeoutHandler = setTimeout(() => dropPromise(this.#run()), Math.max(0, this.#getTimeoutDelay()));
   }
-  /**
-   * Determine if the task should be running right now
-   */
+  /** Determine if the task should be running right now */
   get runnable() {
-    return this._getNextSchedule() <= Date.now();
+    return this.#getNextSchedule() <= Date.now();
   }
-  /**
-   * Cancel the task from the scheduling
-   */
-  cancel() {
-    if (this._timeoutHandler) {
-      clearTimeout(this._timeoutHandler);
-      this._timeoutHandler = null;
+  /** Cancel the task from the scheduling */
+  cancel = () => {
+    if (this.#timeoutHandler) {
+      clearTimeout(this.#timeoutHandler);
+      this.#timeoutHandler = null;
     }
-    this._canceled = true;
-  }
+    this.#canceled = true;
+  };
   /**
    * Run the task
    *
    * All special cases are handled there (task already running).
    * Updating the next value is also handled here.
    */
-  async _run() {
-    this._timeoutHandler = null;
+  #run = async () => {
+    this.#timeoutHandler = null;
     if (this.runnable) {
-      this._lastRun = Date.now();
+      this.#lastRun = Date.now();
       try {
-        await this._func();
+        await this.#func();
       } catch (error) {
-        if (error instanceof Error) {
-          logError(error);
-        }
-        logError(new Error(`Unknown error: ${error.toString()}`));
+        this.#logger.error(asError(error));
       }
     }
-    this._reschedule();
-  }
-  /**
-   * Reschedule the task for the next occurrence
-   */
-  _reschedule() {
-    if (this._canceled) {
-      return;
-    }
-    let nextDelay = this._getTimeoutDelay();
+    this.#reschedule();
+  };
+  /** Reschedule the task for the next occurrence */
+  #reschedule = () => {
+    if (this.#canceled) return;
+    let nextDelay = this.#getTimeoutDelay();
     if (nextDelay < 0) {
       // We overshot
-      switch (this._opts.overrun) {
-        case Overrun.AFTER:
+      switch (this.#opts.overrun) {
+        case types.Overrun.AFTER:
           // Reschedule immediately
           nextDelay = 0;
           break;
-        case Overrun.SKIP:
+        case types.Overrun.SKIP:
           // Reschedule for the next time slot
-          this._lastRun = Date.now();
-          nextDelay = this._getTimeoutDelay();
+          this.#lastRun = Date.now();
+          nextDelay = this.#getTimeoutDelay();
       }
     }
-    this._timeoutHandler = setTimeout(() => dropPromise(this._run()), Math.max(0, nextDelay));
-  }
+    this.#timeoutHandler = setTimeout(() => dropPromise(this.#run()), Math.max(0, nextDelay));
+  };
   /**
    * Return the timeout delay before the next task scheduling.
    *
    * This can return a lower value if the task is scheduled in the distant
    * future.
    */
-  _getTimeoutDelay() {
+  #getTimeoutDelay = () => {
     const current = Date.now();
-    const next = this._getNextSchedule();
+    const next = this.#getNextSchedule();
     return Math.min(next - current, maxTimeoutDelay);
-  }
-  /**
-   * Return the next scheduled time starting from the given point in time
-   */
-  _getNextSchedule() {
-    const nextOccurrence = CronExpressionParser.parse(this._cronDefinition, {
-      currentDate: this._lastRun
+  };
+  /** Return the next scheduled time starting from the given point in time */
+  #getNextSchedule = () => {
+    const nextOccurrence = CronExpressionParser.parse(this.#cronDefinition, {
+      currentDate: this.#lastRun
     }).next();
     return nextOccurrence.getTime();
-  }
+  };
 }

package/web/cron/types.d.ts

@@ -20,7 +20,6 @@
  * promise didn't complete
  */
 export type TaskFunction = () => Promise<void> | void;
-export type LoggerFunction = (error: Error) => void;
 /**
  * Behavior when a task is scheduled to start while it's already running
  */

package/web/cron.d.ts

@@ -13,17 +13,18 @@
  * 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.
  * 
  */
+import { Logger } from "@keeex/log";
 import ScheduledTask from "./cron/scheduledtask.js";
 import { TaskFunction, TaskOptions, Overrun, CompleteTaskOptions } from "./cron/types.js";
 export { Overrun };
 export type { ScheduledTask, TaskFunction, TaskOptions, CompleteTaskOptions };
-export declare const setLoggerFunction: (logFunc?: import("./cron/types.js").LoggerFunction) => void;
 /**
  * Schedule a task for execution
  *
  * @param cronDefinition - CRON timing for the task
  * @param task - The task function to run at the scheduled time
  * @param taskOptions - The behavior of the task
+ * @param logger - Logger for errors
  */
-export declare const schedule: (cronDefinition: string, task: TaskFunction, taskOptions?: TaskOptions) => ScheduledTask;
+export declare const schedule: (cronDefinition: string, task: TaskFunction, taskOptions?: TaskOptions, logger?: Logger) => ScheduledTask;
 export declare const stop: () => void;

package/web/cron.js

@@ -13,12 +13,10 @@
  * 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.
  * 
  */
-import { setLoggerFunction as bitsSetLoggerFunction } from "./cron/logger.js";
 import ScheduledTask from "./cron/scheduledtask.js";
 import { Overrun } from "./cron/types.js";
 const scheduledTasks = [];
 export { Overrun };
-export const setLoggerFunction = bitsSetLoggerFunction;
 /**
  * Set default values for task options
  */
@@ -35,9 +33,10 @@ const getDefaultTaskOptions = taskOptions => {
  * @param cronDefinition - CRON timing for the task
  * @param task - The task function to run at the scheduled time
  * @param taskOptions - The behavior of the task
+ * @param logger - Logger for errors
  */
-export const schedule = (cronDefinition, task, taskOptions) => {
-  const newTask = new ScheduledTask(cronDefinition, task, getDefaultTaskOptions(taskOptions));
+export const schedule = (cronDefinition, task, taskOptions, logger) => {
+  const newTask = new ScheduledTask(cronDefinition, task, getDefaultTaskOptions(taskOptions), logger);
   scheduledTasks.push(newTask);
   return newTask;
 };

package/{lib/cron/logger.js → web/linebuffer.d.ts}

@@ -13,19 +13,18 @@
  * 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.
  * 
  */
-// eslint-disable-next-line no-console
-let loggerFunction = console.error;
+/** Callback called on each line from `LineBuffer` */
+export type OutputCallback = (msg: string) => void;
 /**
- * Change the function used to log errors
- * @param logFunc - Callback that will receive errors
+ * Bufferize input and produce output on newlines.
+ *
+ * The provided callback will be called on all lines, but will not get the newline character.
  */
-export const setLoggerFunction = (logFunc) => {
-    if (logFunc) {
-        loggerFunction = logFunc;
-    }
-    else {
-        // eslint-disable-next-line no-console
-        loggerFunction = console.error;
-    }
-};
-export const logError = (error) => loggerFunction(error);
+export declare class LineBuffer {
+    #private;
+    constructor(cb: OutputCallback, separator?: string);
+    /** Call this method to add data to the buffer, and output all complete lines */
+    feed: (msg: string) => void;
+    /** Call this method to purge all currently buffered data */
+    purge: () => void;
+}

package/web/{cron/logger.js → linebuffer.js}

@@ -13,18 +13,35 @@
  * 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.
  * 
  */
-// eslint-disable-next-line no-console
-let loggerFunction = console.error;
 /**
- * Change the function used to log errors
- * @param logFunc - Callback that will receive errors
+ * Bufferize input and produce output on newlines.
+ *
+ * The provided callback will be called on all lines, but will not get the newline character.
  */
-export const setLoggerFunction = logFunc => {
-  if (logFunc) {
-    loggerFunction = logFunc;
-  } else {
-    // eslint-disable-next-line no-console
-    loggerFunction = console.error;
+export class LineBuffer {
+  #bufferedInput = "";
+  #callback;
+  #separator;
+  constructor(cb, separator = "\n") {
+    this.#callback = cb;
+    this.#separator = separator;
   }
-};
-export const logError = error => loggerFunction(error);
+  /** Call this method to add data to the buffer, and output all complete lines */
+  feed = msg => {
+    this.#bufferedInput += msg;
+    this.#processInput();
+  };
+  /** Call this method to purge all currently buffered data */
+  purge = () => {
+    this.#callback(this.#bufferedInput);
+    this.#bufferedInput = "";
+  };
+  /** Filter the buffer, and output all full lines */
+  #processInput = () => {
+    for (let i = this.#bufferedInput.indexOf(this.#separator); i !== -1; i = this.#bufferedInput.indexOf(this.#separator)) {
+      const line = this.#bufferedInput.substring(0, i);
+      this.#callback(line);
+      this.#bufferedInput = this.#bufferedInput.substring(i + this.#separator.length);
+    }
+  };
+}