@keeex/utils 7.0.1

package/lib/bits/base64.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+/** @internal */
+export declare const B64_CHARBLOCK = 4;
+/** @internal */
+export declare const B64_PAD2 = 2;
+/** @internal */
+export declare const B64_PAD1 = 1;
+/** @internal */
+export declare const B64_PAD0 = 0;
+/**
+ * Return the canonical data from a b64 string
+ *
+ * @public
+ */
+export declare const b64EffectiveData: (data: string, strict?: boolean) => string;
+/**
+ * Return the length of the data in a b64 string.
+ *
+ * @public
+ */
+export declare const b64Len: (data: string, strict: boolean) => number;

package/lib/bits/base64.js

@@ -0,0 +1,70 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+/** @internal */
+export const B64_CHARBLOCK = 4;
+const B64_PAD3 = 3;
+/** @internal */
+export const B64_PAD2 = 2;
+/** @internal */
+export const B64_PAD1 = 1;
+/** @internal */
+export const B64_PAD0 = 0;
+/**
+ * Return the canonical data from a b64 string
+ *
+ * @public
+ */
+export const b64EffectiveData = (data, strict = false) => {
+    let effectiveData = data.indexOf("\n") === data.indexOf("\r") ? data : data.replace(/[\n\r]/gu, "");
+    if (effectiveData.length % B64_CHARBLOCK !== 0) {
+        if (strict)
+            throw new Error("Invalid input length");
+        const extraSize = effectiveData.length % B64_CHARBLOCK;
+        switch (extraSize) {
+            case B64_PAD1:
+                effectiveData = effectiveData.substring(0, Math.floor(effectiveData.length / B64_CHARBLOCK) * B64_CHARBLOCK);
+                break;
+            case B64_PAD2:
+                effectiveData = `${effectiveData}==`;
+                break;
+            case B64_PAD3:
+                effectiveData = `${effectiveData}=`;
+                break;
+        }
+    }
+    return effectiveData;
+};
+/**
+ * Return the length of the data in a b64 string.
+ *
+ * @public
+ */
+export const b64Len = (data, strict) => {
+    const effectiveData = b64EffectiveData(data, strict);
+    // eslint-disable-next-line @typescript-eslint/init-declarations
+    let padding;
+    if (effectiveData.endsWith("==")) {
+        padding = B64_PAD2;
+    }
+    else if (effectiveData.endsWith("=")) {
+        padding = B64_PAD1;
+    }
+    else {
+        padding = B64_PAD0;
+    }
+    const outputLength = (effectiveData.length / B64_CHARBLOCK) * (B64_CHARBLOCK - 1) - padding;
+    return outputLength;
+};

package/lib/bits/hex.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+/** Clean an hex string input; make it even and remove 0x prefix if present */
+export declare const clearHexInput: (input: string) => string;

package/lib/bits/hex.js

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+const CHARACTER_PER_BYTE = 2;
+const HEX_PREFIX = "0x";
+const HEX_PREFIX_LENGTH = HEX_PREFIX.length;
+/** Clean an hex string input; make it even and remove 0x prefix if present */
+export const clearHexInput = (input) => {
+    const noprefix = !input.startsWith(HEX_PREFIX);
+    const even = input.length % CHARACTER_PER_BYTE === 0;
+    if (noprefix && even)
+        return input;
+    if (noprefix)
+        return `0${input}`;
+    if (even)
+        return input.substring(HEX_PREFIX_LENGTH);
+    return `0${input.substring(HEX_PREFIX_LENGTH)}`;
+};

package/lib/bits/uint8array.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+/**
+ * Return a Uint8Array view on the provided ArrayBuffer.
+ *
+ * If clone is set to true, return a clone of the source array. Otherwise a view is returned.
+ *
+ @public
+ */
+export declare const getUint8Array: (arrayBuffer: ArrayBuffer | Uint8Array, offset?: number, length?: number, clone?: boolean) => Uint8Array;
+export declare const pureBuf82B64: (buf8: Uint8Array) => string;
+/**
+ * Convert an Uint8Array to a B64 string
+ */
+export declare const buf82b64: (buf8: Uint8Array) => string;

package/lib/bits/uint8array.js

@@ -0,0 +1,42 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+import { bufferBuf82B64, haveBufferBase64 } from "../utils/buffer.js";
+import { getArrayBuffer, ab2b64 } from "./arraybuffer.js";
+/**
+ * Return a Uint8Array view on the provided ArrayBuffer.
+ *
+ * If clone is set to true, return a clone of the source array. Otherwise a view is returned.
+ *
+ @public
+ */
+export const getUint8Array = (arrayBuffer, offset = 0, length = -1, clone = false) => {
+    const realLength = length === -1 ? arrayBuffer.byteLength - offset : length;
+    if (arrayBuffer instanceof ArrayBuffer) {
+        if (clone) {
+            const copyBuffer = arrayBuffer.slice(offset, offset + realLength);
+            return new Uint8Array(copyBuffer);
+        }
+        return new Uint8Array(arrayBuffer, offset, realLength);
+    }
+    if (clone)
+        return arrayBuffer.slice(offset, realLength + offset);
+    return new Uint8Array(arrayBuffer.buffer, offset + arrayBuffer.byteOffset, realLength);
+};
+export const pureBuf82B64 = (buf8) => ab2b64(getArrayBuffer(buf8));
+/**
+ * Convert an Uint8Array to a B64 string
+ */
+export const buf82b64 = haveBufferBase64() ? bufferBuf82B64 : pureBuf82B64;

package/lib/bytebuffer.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+/** @public */
+export declare const readInt32LE: (byteArray: ArrayBuffer | Uint8Array, offset: number) => number;
+/** @public */
+export declare const readUint32LE: (byteArray: ArrayBuffer | Uint8Array, offset: number) => number;
+/** @public */
+export declare const readUint32BE: (byteArray: ArrayBuffer | Uint8Array, offset: number) => number;
+/** @public */
+export declare const writeUint32LE: (byteArray: ArrayBuffer | Uint8Array, offset: number, value: number) => void;
+/** @public */
+export declare const writeInt32LE: (byteArray: ArrayBuffer | Uint8Array, offset: number, value: number) => void;
+/** @public */
+export declare const writeUint32BE: (byteArray: ArrayBuffer | Uint8Array, offset: number, value: number) => void;

package/lib/bytebuffer.js

@@ -0,0 +1,29 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+const getDataView = (byteArray, offset, length) => new DataView(byteArray instanceof Uint8Array ? byteArray.buffer : byteArray, byteArray instanceof Uint8Array ? byteArray.byteOffset + offset : offset, length);
+const BYTES_32BIT = 4;
+/** @public */
+export const readInt32LE = (byteArray, offset) => getDataView(byteArray, offset, BYTES_32BIT).getInt32(0, true);
+/** @public */
+export const readUint32LE = (byteArray, offset) => getDataView(byteArray, offset, BYTES_32BIT).getUint32(0, true);
+/** @public */
+export const readUint32BE = (byteArray, offset) => getDataView(byteArray, offset, BYTES_32BIT).getUint32(0, false);
+/** @public */
+export const writeUint32LE = (byteArray, offset, value) => getDataView(byteArray, offset, BYTES_32BIT).setUint32(0, value, true);
+/** @public */
+export const writeInt32LE = (byteArray, offset, value) => getDataView(byteArray, offset, BYTES_32BIT).setInt32(0, value, true);
+/** @public */
+export const writeUint32BE = (byteArray, offset, value) => getDataView(byteArray, offset, BYTES_32BIT).setUint32(0, value, false);

package/lib/consts.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+/**
+ * Number of bytes in the hex-representation of a byte.
+ *
+ * @internal
+ */
+export declare const HEXBYTE_CHR_COUNT = 2;
+/**
+ * Number of digits in hex.
+ *
+ * @internal
+ */
+export declare const HEX_DIGITS = 16;
+/**
+ * Maximum radix for a number to string conversion.
+ *
+ * @internal
+ */
+export declare const MAX_RADIX = 36;

package/lib/consts.js

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+/**
+ * Number of bytes in the hex-representation of a byte.
+ *
+ * @internal
+ */
+export const HEXBYTE_CHR_COUNT = 2;
+/**
+ * Number of digits in hex.
+ *
+ * @internal
+ */
+export const HEX_DIGITS = 16;
+/**
+ * Maximum radix for a number to string conversion.
+ *
+ * @internal
+ */
+export const MAX_RADIX = 36;

package/lib/cron/logger.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+import type { LoggerFunction } from "./types.js";
+/**
+ * Change the function used to log errors
+ * @param logFunc - Callback that will receive errors
+ */
+export declare const setLoggerFunction: (logFunc?: LoggerFunction) => void;
+export declare const logError: (error: Error) => void;

package/lib/cron/logger.js

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+// eslint-disable-next-line no-console
+let loggerFunction = console.error;
+/**
+ * Change the function used to log errors
+ * @param logFunc - Callback that will receive errors
+ */
+export const setLoggerFunction = (logFunc) => {
+    if (logFunc) {
+        loggerFunction = logFunc;
+    }
+    else {
+        // eslint-disable-next-line no-console
+        loggerFunction = console.error;
+    }
+};
+export const logError = (error) => loggerFunction(error);

package/lib/cron/scheduledtask.d.ts

@@ -0,0 +1,71 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+import { TaskFunction, CompleteTaskOptions } 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
+     */
+    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;
+}

package/lib/cron/scheduledtask.js

@@ -0,0 +1,137 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+import { CronExpressionParser } from "cron-parser";
+import { dropPromise } from "../promise.js";
+import { logError } from "./logger.js";
+import { Overrun } 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
+ */
+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()));
+    }
+    /**
+     * Determine if the task should be running right now
+     */
+    get runnable() {
+        return this._getNextSchedule() <= Date.now();
+    }
+    /**
+     * Cancel the task from the scheduling
+     */
+    cancel() {
+        if (this._timeoutHandler) {
+            clearTimeout(this._timeoutHandler);
+            this._timeoutHandler = null;
+        }
+        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;
+        if (this.runnable) {
+            this._lastRun = Date.now();
+            try {
+                await this._func();
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    logError(error);
+                }
+                logError(new Error(`Unknown error: ${error.toString()}`));
+            }
+        }
+        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:
+                    // Reschedule immediately
+                    nextDelay = 0;
+                    break;
+                case Overrun.SKIP:
+                    // Reschedule for the next time slot
+                    this._lastRun = Date.now();
+                    nextDelay = this._getTimeoutDelay();
+            }
+        }
+        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() {
+        const current = Date.now();
+        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,
+        }).next();
+        return nextOccurrence.getTime();
+    }
+}