@digital-alchemy/core 24.8.3 → 24.9.3

package/dist/services/logger.extension.js

@@ -0,0 +1,200 @@
+/* eslint-disable sonarjs/slow-regex */
+import chalk from "chalk";
+import dayjs from "dayjs";
+import { format, inspect } from "util";
+import { EVENT_UPDATE_LOG_LEVELS, FIRST, is, METHOD_COLORS, START, } from "..";
+const LOG_LEVEL_PRIORITY = {
+    debug: 20,
+    error: 50,
+    fatal: 60,
+    info: 30,
+    silent: 100,
+    trace: 10,
+    warn: 40,
+};
+const DECIMALS = 2;
+const LOG_LEVELS = Object.keys(LOG_LEVEL_PRIORITY);
+let logger = {};
+const MAX_CUTOFF = 2000;
+const frontDash = " - ";
+const SYMBOL_START = 1;
+const SYMBOL_END = -1;
+const LEVEL_MAX = 7;
+export async function Logger({ lifecycle, config, event, internal, als, }) {
+    let lastMessage = performance.now();
+    let logCounter = START;
+    let httpLogTarget;
+    const { loggerOptions = {} } = internal.boot?.options ?? {};
+    const timestampFormat = loggerOptions.timestampFormat ?? "ddd HH:mm:ss.SSS";
+    loggerOptions.mergeData ??= {};
+    const YELLOW_DASH = chalk.yellowBright(frontDash);
+    const BLUE_TICK = chalk.blue(`>`);
+    let prettyFormat = is.boolean(loggerOptions.pretty) ? loggerOptions.pretty : true;
+    function emitHttpLogs(data) {
+        if (is.empty(httpLogTarget)) {
+            return;
+        }
+        // validated with datadog, probably is fine elsewhere too
+        // https://http-intake.logs.datadoghq.com/v1/input/{API_KEY}
+        fetch(httpLogTarget, {
+            body: JSON.stringify(data),
+            headers: { "Content-Type": "application/json" },
+            method: "POST",
+        });
+    }
+    function mergeData(data) {
+        let out = { ...data, ...loggerOptions.mergeData };
+        if (loggerOptions.counter) {
+            const counter = data;
+            counter.logIdx = logCounter++;
+        }
+        if (loggerOptions.als) {
+            out = { ...out, ...als.getLogData() };
+        }
+        return out;
+    }
+    const prettyFormatMessage = (message) => {
+        if (!message) {
+            return ``;
+        }
+        if (!prettyFormat || message.length > MAX_CUTOFF) {
+            return message;
+        }
+        message = message
+            // ? partA#partB - highlight it all in yellow
+            .replaceAll(new RegExp("([^ ]+#[^ ]+)", "g"), i => chalk.yellow(i))
+            // ? [A] > [B] > [C] - highlight the >'s in blue
+            .replaceAll("] > [", `] ${BLUE_TICK} [`)
+            // ? [Text] - strip brackets, highlight magenta
+            .replaceAll(new RegExp(String.raw `(\[[^\]\[]+\])`, "g"), i => chalk.bold.magenta(i.slice(SYMBOL_START, SYMBOL_END)))
+            // ? {Text} - strip braces, highlight gray
+            .replaceAll(new RegExp(String.raw `(\{[^\]}]+\})`, "g"), i => chalk.bold.gray(i.slice(SYMBOL_START, SYMBOL_END)));
+        // ? " - Text" (line prefix with dash) - highlight dash
+        if (message.slice(START, frontDash.length) === frontDash) {
+            message = `${YELLOW_DASH}${message.slice(frontDash.length)}`;
+        }
+        return message;
+    };
+    if (is.empty(internal.boot.options?.customLogger)) {
+        // #region formatter
+        [...METHOD_COLORS.keys()].forEach(key => {
+            const level = `[${key.toUpperCase()}]`.padStart(LEVEL_MAX, " ");
+            logger[key] = (context, ...parameters) => {
+                const data = mergeData(is.object(parameters[FIRST])
+                    ? parameters.shift()
+                    : {});
+                const rawData = {
+                    ...data,
+                    level: key,
+                    timestamp: Date.now(),
+                };
+                const highlighted = chalk.bold[METHOD_COLORS.get(key)](`[${data.context || context}]`);
+                const name = is.object(data.name) || is.function(data.name) ? data.name.name : data.name;
+                delete data.context;
+                delete data.name;
+                const timestamp = chalk.white(`[${dayjs().format(timestampFormat)}]`);
+                let prettyMessage;
+                if (!is.empty(parameters)) {
+                    const text = parameters.shift();
+                    rawData.msg = format(text, ...parameters);
+                    prettyMessage = format(prettyFormatMessage(text), ...parameters);
+                }
+                let message = `${timestamp} ${level}${highlighted}`;
+                if (!is.empty(name)) {
+                    message += chalk.blue(` (${name})`);
+                }
+                if (loggerOptions.ms) {
+                    const now = performance.now();
+                    const diff = (now - lastMessage).toFixed(DECIMALS) + `ms`;
+                    lastMessage = now;
+                    rawData.ms = diff;
+                    message += prettyFormat ? chalk.green(diff) : diff;
+                }
+                emitHttpLogs(rawData);
+                if (!is.empty(prettyMessage)) {
+                    message += `: ${chalk.cyan(prettyMessage)}`;
+                }
+                if (!is.empty(data)) {
+                    message +=
+                        "\n" +
+                            inspect(data, {
+                                colors: true,
+                                compact: false,
+                                depth: 10,
+                                numericSeparator: true,
+                                sorted: true,
+                            })
+                                .split("\n")
+                                .slice(SYMBOL_START, SYMBOL_END)
+                                .join("\n");
+                }
+                if (["warn", "error", "fatal"].includes(key)) {
+                    global.console.error(message);
+                    return;
+                }
+                global.console.log(message);
+            };
+        });
+        // #endregion
+    }
+    else {
+        logger = internal.boot.options.customLogger;
+    }
+    // #region instance creation
+    // if bootstrap hard coded something specific, then start there
+    // otherwise, be noisy until config loads a user preference
+    //
+    // stored as separate variable to cut down on internal config lookups
+    let CURRENT_LOG_LEVEL = internal.utils.object.get(internal, "boot.options.configuration.boilerplate.LOG_LEVEL") ||
+        "trace";
+    function context(context) {
+        const name = context;
+        const shouldILog = {};
+        const [prefix] = context.split(".");
+        const update = () => LOG_LEVELS.forEach((key) => {
+            // global level
+            let target = LOG_LEVEL_PRIORITY[key];
+            // override directly
+            if (loggerOptions?.levelOverrides?.[name]) {
+                target = LOG_LEVEL_PRIORITY[loggerOptions?.levelOverrides?.[name]];
+                // module level override
+            }
+            else if (loggerOptions?.levelOverrides?.[prefix]) {
+                target = LOG_LEVEL_PRIORITY[loggerOptions?.levelOverrides?.[prefix]];
+            }
+            shouldILog[key] = target >= LOG_LEVEL_PRIORITY[CURRENT_LOG_LEVEL];
+        });
+        event.on(EVENT_UPDATE_LOG_LEVELS, update);
+        update();
+        return {
+            debug: (...params) => shouldILog.debug && logger.debug(context, ...params),
+            error: (...params) => shouldILog.error && logger.error(context, ...params),
+            fatal: (...params) => shouldILog.fatal && logger.fatal(context, ...params),
+            info: (...params) => shouldILog.info && logger.info(context, ...params),
+            trace: (...params) => shouldILog.trace && logger.trace(context, ...params),
+            warn: (...params) => shouldILog.warn && logger.warn(context, ...params),
+        };
+    }
+    const updateShouldLog = () => {
+        if (!is.empty(config.boilerplate.LOG_LEVEL)) {
+            CURRENT_LOG_LEVEL = config.boilerplate.LOG_LEVEL;
+        }
+        event.emit(EVENT_UPDATE_LOG_LEVELS);
+    };
+    // #MARK: lifecycle
+    lifecycle.onPostConfig(() => internal.boilerplate.logger.updateShouldLog());
+    internal.boilerplate.configuration.onUpdate(() => internal.boilerplate.logger.updateShouldLog(), "boilerplate", "LOG_LEVEL");
+    // #MARK: return object
+    return {
+        context,
+        getBaseLogger: () => logger,
+        getPrettyFormat: () => prettyFormat,
+        prettyFormatMessage,
+        setBaseLogger: base => (logger = base),
+        setHttpLogs: url => (httpLogTarget = url),
+        setPrettyFormat: state => (prettyFormat = state),
+        systemLogger: context("digital-alchemy:system-logger"),
+        updateShouldLog,
+    };
+}
+//# sourceMappingURL=logger.extension.js.map

package/dist/services/logger.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.extension.js","sourceRoot":"","sources":["../../src/services/logger.extension.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,EAEL,uBAAuB,EACvB,KAAK,EAEL,EAAE,EAEF,aAAa,EAEb,KAAK,GAKN,MAAM,IAAI,CAAC;AAEZ,MAAM,kBAAkB,GAAG;IACzB,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;IACT,IAAI,EAAE,EAAE;IACR,MAAM,EAAE,GAAG;IACX,KAAK,EAAE,EAAE;IACT,IAAI,EAAE,EAAE;CACT,CAAC;AACF,MAAM,QAAQ,GAAG,CAAC,CAAC;AACnB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAsB,CAAC;AAExE,IAAI,MAAM,GAAG,EAGZ,CAAC;AAEF,MAAM,UAAU,GAAG,IAAI,CAAC;AACxB,MAAM,SAAS,GAAG,KAAK,CAAC;AACxB,MAAM,YAAY,GAAG,CAAC,CAAC;AACvB,MAAM,UAAU,GAAG,CAAC,CAAC,CAAC;AACtB,MAAM,SAAS,GAAG,CAAC,CAAC;AAEpB,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,EAC3B,SAAS,EACT,MAAM,EACN,KAAK,EACL,QAAQ,EACR,GAAG,GACY;IACf,IAAI,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,aAAqB,CAAC;IAE1B,MAAM,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC;IAE5D,MAAM,eAAe,GAAG,aAAa,CAAC,eAAe,IAAI,kBAAkB,CAAC;IAC5E,aAAa,CAAC,SAAS,KAAK,EAAE,CAAC;IAE/B,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAClD,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,YAAY,GAAG,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IAElF,SAAS,YAAY,CAAC,IAAY;QAChC,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5B,OAAO;QACT,CAAC;QACD,yDAAyD;QACzD,4DAA4D;QAC5D,KAAK,CAAC,aAAa,EAAE;YACnB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,SAAS,SAAS,CAAmB,IAAO;QAC1C,IAAI,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAC,SAAS,EAAE,CAAC;QAElD,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YAC1B,MAAM,OAAO,GAAG,IAA0B,CAAC;YAC3C,OAAO,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;QAChC,CAAC;QAED,IAAI,aAAa,CAAC,GAAG,EAAE,CAAC;YACtB,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,GAAG,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC;QACxC,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,mBAAmB,GAAG,CAAC,OAAe,EAAU,EAAE;QACtD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,CAAC,YAAY,IAAI,OAAO,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YACjD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,GAAG,OAAO;YACf,6CAA6C;aAC5C,UAAU,CAAC,IAAI,MAAM,CAAC,eAAe,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACnE,gDAAgD;aAC/C,UAAU,CAAC,OAAO,EAAE,KAAK,SAAS,IAAI,CAAC;YACxC,+CAA+C;aAC9C,UAAU,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,gBAAgB,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,CAC3D,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CACtD;YACD,0CAA0C;aACzC,UAAU,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAA,eAAe,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,CAC1D,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CACnD,CAAC;QACJ,uDAAuD;QACvD,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;YACzD,OAAO,GAAG,GAAG,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/D,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEF,IAAI,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;QAClD,oBAAoB;QACpB,CAAC,GAAG,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACtC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;YAChE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAiB,EAAE,GAAG,UAAuC,EAAE,EAAE;gBAC9E,MAAM,IAAI,GAAG,SAAS,CACpB,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;oBAC1B,CAAC,CAAE,UAAU,CAAC,KAAK,EAKf;oBACJ,CAAC,CAAC,EAAE,CACP,CAAC;gBAEF,MAAM,OAAO,GAAG;oBACd,GAAG,IAAI;oBACP,KAAK,EAAE,GAAG;oBACV,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;iBACK,CAAC;gBAE7B,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,CAAC;gBACvF,MAAM,IAAI,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;gBACzF,OAAO,IAAI,CAAC,OAAO,CAAC;gBACpB,OAAO,IAAI,CAAC,IAAI,CAAC;gBAEjB,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;gBACtE,IAAI,aAAqB,CAAC;gBAC1B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC1B,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,EAAY,CAAC;oBAC1C,OAAO,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,UAAU,CAAC,CAAC;oBAC1C,aAAa,GAAG,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,CAAC;gBACnE,CAAC;gBAED,IAAI,OAAO,GAAG,GAAG,SAAS,IAAI,KAAK,GAAG,WAAW,EAAE,CAAC;gBAEpD,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpB,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC;gBACtC,CAAC;gBAED,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;oBACrB,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;oBAC9B,MAAM,IAAI,GAAG,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;oBAC1D,WAAW,GAAG,GAAG,CAAC;oBAClB,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC;oBAElB,OAAO,IAAI,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBACrD,CAAC;gBACD,YAAY,CAAC,OAAO,CAAC,CAAC;gBAEtB,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;oBAC7B,OAAO,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC9C,CAAC;gBAED,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpB,OAAO;wBACL,IAAI;4BACJ,OAAO,CAAC,IAAI,EAAE;gCACZ,MAAM,EAAE,IAAI;gCACZ,OAAO,EAAE,KAAK;gCACd,KAAK,EAAE,EAAE;gCACT,gBAAgB,EAAE,IAAI;gCACtB,MAAM,EAAE,IAAI;6BACb,CAAC;iCACC,KAAK,CAAC,IAAI,CAAC;iCACX,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC;iCAC/B,IAAI,CAAC,IAAI,CAAC,CAAC;gBAClB,CAAC;gBACD,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC7C,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC9B,OAAO;gBACT,CAAC;gBAED,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,aAAa;IACf,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;IAC9C,CAAC;IAED,4BAA4B;IAC5B,+DAA+D;IAC/D,2DAA2D;IAC3D,EAAE;IACF,qEAAqE;IACrE,IAAI,iBAAiB,GACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,kDAAkD,CAAC;QACvF,OAAO,CAAC;IAEV,SAAS,OAAO,CAAC,OAA0B;QACzC,MAAM,IAAI,GAAG,OAAuB,CAAC;QACrC,MAAM,UAAU,GAAG,EAAsC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAwB,CAAC;QAC3D,MAAM,MAAM,GAAG,GAAG,EAAE,CAClB,UAAU,CAAC,OAAO,CAAC,CAAC,GAAoB,EAAE,EAAE;YAC1C,eAAe;YACf,IAAI,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;YAErC,oBAAoB;YACpB,IAAI,aAAa,EAAE,cAAc,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1C,MAAM,GAAG,kBAAkB,CAAC,aAAa,EAAE,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnE,wBAAwB;YAC1B,CAAC;iBAAM,IAAI,aAAa,EAAE,cAAc,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnD,MAAM,GAAG,kBAAkB,CAAC,aAAa,EAAE,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;YACvE,CAAC;YACD,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEL,KAAK,CAAC,EAAE,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;QAC1C,MAAM,EAAE,CAAC;QAET,OAAO;YACL,KAAK,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAChD,UAAU,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,OAAmB,EAAE,GAAG,MAAM,CAAC;YAClE,KAAK,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAChD,UAAU,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,OAAmB,EAAE,GAAG,MAAM,CAAC;YAClE,KAAK,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAChD,UAAU,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,OAAmB,EAAE,GAAG,MAAM,CAAC;YAClE,IAAI,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAC/C,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAmB,EAAE,GAAG,MAAM,CAAC;YAChE,KAAK,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAChD,UAAU,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,OAAmB,EAAE,GAAG,MAAM,CAAC;YAClE,IAAI,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAC/C,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAmB,EAAE,GAAG,MAAM,CAAC;SACtD,CAAC;IACf,CAAC;IAED,MAAM,eAAe,GAAG,GAAG,EAAE;QAC3B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5C,iBAAiB,GAAG,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC;QACnD,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;IACtC,CAAC,CAAC;IAEF,mBAAmB;IACnB,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;IAC5E,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,QAAQ,CACzC,GAAG,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,eAAe,EAAE,EACnD,aAAa,EACb,WAAW,CACZ,CAAC;IAEF,uBAAuB;IACvB,OAAO;QACL,OAAO;QACP,aAAa,EAAE,GAAG,EAAE,CAAC,MAAM;QAC3B,eAAe,EAAE,GAAG,EAAE,CAAC,YAAY;QACnC,mBAAmB;QACnB,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC;QACtC,WAAW,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,aAAa,GAAG,GAAG,CAAC;QACzC,eAAe,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,YAAY,GAAG,KAAK,CAAC;QAChD,YAAY,EAAE,OAAO,CAAC,+BAA+B,CAAC;QACtD,eAAe;KAChB,CAAC;AACJ,CAAC"}

package/dist/services/scheduler.extension.d.ts

@@ -0,0 +1,2 @@
+import { SchedulerBuilder, TServiceParams } from "../helpers";
+export declare function Scheduler({ logger, lifecycle, internal }: TServiceParams): SchedulerBuilder;

package/dist/services/scheduler.extension.js

@@ -0,0 +1,108 @@
+import dayjs from "dayjs";
+import { schedule } from "node-cron";
+import { is } from "..";
+import { BootstrapException, } from "../helpers";
+export function Scheduler({ logger, lifecycle, internal }) {
+    const stop = new Set();
+    // #MARK: lifecycle events
+    lifecycle.onPreShutdown(function onPreShutdown() {
+        if (is.empty(stop)) {
+            return;
+        }
+        logger.info({ name: onPreShutdown }, `removing [%s] schedules`, stop.size);
+        stop.forEach(stopFunctions => {
+            stopFunctions();
+            stop.delete(stopFunctions);
+        });
+    });
+    return (context) => {
+        // #MARK: cron
+        function cron({ exec, schedule: scheduleList }) {
+            const stopFunctions = [];
+            [scheduleList].flat().forEach(cronSchedule => {
+                logger.trace({ context, name: cron, schedule: cronSchedule }, `init`);
+                const cronJob = schedule(cronSchedule, async () => await internal.safeExec(exec));
+                lifecycle.onReady(() => {
+                    logger.trace({ context, name: cron, schedule: cronSchedule }, "starting");
+                    cronJob.start();
+                });
+                const stopFunction = () => {
+                    logger.trace({ context, name: cron, schedule: cronSchedule }, `stopping`);
+                    cronJob.stop();
+                };
+                stop.add(stopFunction);
+                stopFunctions.push(stopFunction);
+                return stopFunction;
+            });
+            return () => stopFunctions.forEach(stop => stop());
+        }
+        // #MARK: interval
+        function interval({ exec, interval }) {
+            let runningInterval;
+            lifecycle.onReady(() => {
+                logger.trace({ context, name: interval }, "starting");
+                runningInterval = setInterval(async () => await internal.safeExec(exec), interval);
+            });
+            const stopFunction = () => {
+                if (runningInterval) {
+                    clearInterval(runningInterval);
+                }
+            };
+            stop.add(stopFunction);
+            return stopFunction;
+        }
+        // #MARK: sliding
+        function sliding({ exec, reset, next }) {
+            if (!is.function(next)) {
+                throw new BootstrapException(context, "BAD_NEXT", "Did not provide next function to schedule.sliding");
+            }
+            if (!is.function(exec)) {
+                throw new BootstrapException(context, "BAD_NEXT", "Did not provide exec function to schedule.sliding");
+            }
+            let timeout;
+            const waitForNext = () => {
+                if (timeout) {
+                    logger.warn({ context, name: sliding }, `sliding schedule retrieving next execution time before previous ran`);
+                    clearTimeout(timeout);
+                }
+                let nextTime = next();
+                if (!nextTime) {
+                    // nothing to do?
+                    // will try again next schedule
+                    return;
+                }
+                nextTime = dayjs(nextTime);
+                if (dayjs().isAfter(nextTime)) {
+                    // probably a result of boot
+                    // ignore
+                    return;
+                }
+                if (nextTime) {
+                    timeout = setTimeout(async () => {
+                        await internal.safeExec(exec);
+                    }, Math.abs(dayjs().diff(nextTime, "ms")));
+                }
+            };
+            // reset on schedule
+            const scheduleStop = cron({
+                exec: waitForNext,
+                schedule: reset,
+            });
+            // find value for now (boot)
+            lifecycle.onReady(() => waitForNext());
+            return () => {
+                scheduleStop();
+                if (timeout) {
+                    clearTimeout(timeout);
+                    timeout = undefined;
+                }
+            };
+        }
+        return {
+            cron,
+            interval,
+            sliding,
+        };
+    };
+}
+//# sourceMappingURL=scheduler.extension.js.map

package/dist/services/scheduler.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.extension.js","sourceRoot":"","sources":["../../src/services/scheduler.extension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,OAAO,EAAE,EAAE,EAAY,MAAM,IAAI,CAAC;AAClC,OAAO,EACL,kBAAkB,GAOnB,MAAM,YAAY,CAAC;AAEpB,MAAM,UAAU,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAkB;IACvE,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEvC,0BAA0B;IAC1B,SAAS,CAAC,aAAa,CAAC,SAAS,aAAa;QAC5C,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,OAAO;QACT,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,yBAAyB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;YAC3B,aAAa,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,OAAiB,EAAE,EAAE;QAC3B,cAAc;QACd,SAAS,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAwB;YAClE,MAAM,aAAa,GAAqB,EAAE,CAAC;YAC3C,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;gBAC3C,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,MAAM,CAAC,CAAC;gBACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;gBAClF,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE;oBACrB,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,UAAU,CAAC,CAAC;oBAC1E,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,CAAC,CAAC,CAAC;gBAEH,MAAM,YAAY,GAAG,GAAG,EAAE;oBACxB,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,UAAU,CAAC,CAAC;oBAC1E,OAAO,CAAC,IAAI,EAAE,CAAC;gBACjB,CAAC,CAAC;gBAEF,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBACvB,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACjC,OAAO,YAAY,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QACrD,CAAC;QAED,kBAAkB;QAClB,SAAS,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAA4B;YAC5D,IAAI,eAA+C,CAAC;YACpD,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE;gBACrB,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;gBAEtD,eAAe,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;YACrF,CAAC,CAAC,CAAC;YACH,MAAM,YAAY,GAAG,GAAG,EAAE;gBACxB,IAAI,eAAe,EAAE,CAAC;oBACpB,aAAa,CAAC,eAAe,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC,CAAC;YACF,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACvB,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,iBAAiB;QACjB,SAAS,OAAO,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAA2B;YAC7D,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,kBAAkB,CAC1B,OAAO,EACP,UAAU,EACV,mDAAmD,CACpD,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,kBAAkB,CAC1B,OAAO,EACP,UAAU,EACV,mDAAmD,CACpD,CAAC;YACJ,CAAC;YACD,IAAI,OAAsC,CAAC;YAE3C,MAAM,WAAW,GAAG,GAAG,EAAE;gBACvB,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,CAAC,IAAI,CACT,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,EAC1B,qEAAqE,CACtE,CAAC;oBACF,YAAY,CAAC,OAAO,CAAC,CAAC;gBACxB,CAAC;gBACD,IAAI,QAAQ,GAAG,IAAI,EAAE,CAAC;gBACtB,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,iBAAiB;oBACjB,+BAA+B;oBAC/B,OAAO;gBACT,CAAC;gBACD,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC3B,IAAI,KAAK,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC9B,4BAA4B;oBAC5B,SAAS;oBACT,OAAO;gBACT,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,OAAO,GAAG,UAAU,CAClB,KAAK,IAAI,EAAE;wBACT,MAAM,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBAChC,CAAC,EACD,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CACvC,CAAC;gBACJ,CAAC;YACH,CAAC,CAAC;YACF,oBAAoB;YACpB,MAAM,YAAY,GAAG,IAAI,CAAC;gBACxB,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,KAAK;aAChB,CAAC,CAAC;YACH,4BAA4B;YAC5B,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YAEvC,OAAO,GAAG,EAAE;gBACV,YAAY,EAAE,CAAC;gBACf,IAAI,OAAO,EAAE,CAAC;oBACZ,YAAY,CAAC,OAAO,CAAC,CAAC;oBACtB,OAAO,GAAG,SAAS,CAAC;gBACtB,CAAC;YACH,CAAC,CAAC;QACJ,CAAC;QAED,OAAO;YACL,IAAI;YACJ,QAAQ;YACR,OAAO;SACR,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/dist/services/wiring.extension.d.ts

@@ -0,0 +1,111 @@
+import { ApplicationConfigurationOptions, ApplicationDefinition, OptionalModuleConfiguration, ServiceMap, StringConfig, TConfigLogLevel } from "../helpers";
+import { ALS } from ".";
+import { Configuration } from "./configuration.extension";
+import { Logger } from "./logger.extension";
+import { Scheduler } from "./scheduler.extension";
+export interface DeclaredEnvironments {
+    prod: true;
+    test: true;
+    local: true;
+}
+declare function createBoilerplate(): import("..").LibraryDefinition<{
+    /**
+     * [AsyncLocalStorage](https://nodejs.org/api/async_context.html) hooks
+     *
+     * Use to pass data around bypassing business logic and insert data into logs
+     */
+    als: typeof ALS;
+    /**
+     * @internal
+     *
+     * Exposed via `internal.boilerplate.configuration`
+     *
+     * Used to directly modify application configuration
+     */
+    configuration: typeof Configuration;
+    /**
+     * @internal
+     *
+     * Exposed via `internal.boilerplate.logger`
+     *
+     * Used to modify the way the logger works at runtime
+     */
+    logger: typeof Logger;
+    /**
+     * @internal
+     *
+     * Used to generate the scheduler that will get injected into other services
+     */
+    scheduler: typeof Scheduler;
+}, {
+    ALS_ENABLED: {
+        type: "string";
+    };
+    /**
+     * Only usable by **cli switch**.
+     * Pass path to a config file for loader
+     *
+     * ```bash
+     * node dist/app.js --config ~/.config/my_app.ini
+     * ```
+     */
+    CONFIG: {
+        description: string;
+        type: "string";
+    };
+    /**
+     * > by default true when:
+     *
+     * ```typescript
+     * NODE_ENV === "test*"
+     * ```
+     *
+     * ---
+     *
+     * When set
+     */
+    IS_TEST: {
+        default: boolean;
+        description: string;
+        type: "boolean";
+    };
+    /**
+     * ### `trace`
+     *
+     * Very noisy, contains extra details about what's going on in the internals.
+     *
+     * ### `debug`
+     *
+     * Additional diagnostic information about operations being form. `"did a thing w/ {name}"` is common.
+     *
+     * ### `info`
+     *
+     * Notifications for high level events, and app code.
+     *
+     * ### `warn`
+     *
+     * Notification that an non-critical issue happened.
+     *
+     * ### `error`
+     *
+     * Error logs are produced from unexpected situations.
+     *
+     * When an external API sends back an error messages, or tools are being used in a detectably wrong way.
+     *
+     * ### `fatal`
+     *
+     * Produce a log at the highest importance level, not common
+     *
+     * ### `silent`
+     *
+     * Emit no logs at all
+     */
+    LOG_LEVEL: StringConfig<TConfigLogLevel>;
+    /**
+     * Reference to `process.env.NODE_ENV` by default, `"local"` if not provided
+     */
+    NODE_ENV: StringConfig<keyof DeclaredEnvironments>;
+}>;
+export declare let LIB_BOILERPLATE: ReturnType<typeof createBoilerplate>;
+export declare function CreateApplication<S extends ServiceMap, C extends OptionalModuleConfiguration>({ name, services, configurationLoaders, libraries, configuration, priorityInit, }: ApplicationConfigurationOptions<S, C>): ApplicationDefinition<S, C>;
+export {};