@digital-alchemy/core 0.1.0

package/dist/boilerplate/extensions/fetch.extension.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fetch = void 0;
+const tslib_1 = require("tslib");
+const bottleneck_1 = tslib_1.__importDefault(require("bottleneck"));
+const fs_1 = require("fs");
+const stream_1 = require("stream");
+const util_1 = require("util");
+const __1 = require("../..");
+const __2 = require("..");
+const streamPipeline = (0, util_1.promisify)(stream_1.pipeline);
+function Fetch({ logger, context: parentContext }) {
+    const createFetcher = ({ bottleneck, headers: baseHeaders, baseUrl, context: logContext,
+    // eslint-disable-next-line sonarjs/cognitive-complexity
+     }) => {
+        const extras = {};
+        if (!__1.is.empty(logContext)) {
+            extras["context"] = logContext;
+        }
+        let limiter;
+        const capabilities = [];
+        if (bottleneck) {
+            capabilities.push("bottleneck");
+            limiter = new bottleneck_1.default(bottleneck);
+        }
+        if (!__1.is.empty(capabilities)) {
+            logger.trace({ capabilities, ...extras }, `initialized fetcher`);
+        }
+        function checkForHttpErrors(maybeError) {
+            if (__1.is.object(maybeError) &&
+                maybeError !== null &&
+                __1.is.number(maybeError.statusCode) &&
+                __1.is.string(maybeError.error)) {
+                // Log the error if needed
+                logger.error({ error: maybeError, ...extras }, maybeError.message);
+                // Throw a FetchRequestError
+                // throw new FetchRequestError(maybeError);
+                throw new __2.FetchRequestError(maybeError.statusCode, maybeError.error, maybeError.message);
+            }
+            return maybeError;
+        }
+        async function fetchHandleResponse(process, response) {
+            if (process === false || process === "raw") {
+                return response;
+            }
+            const text = await response.text();
+            if (process === "text") {
+                return text;
+            }
+            if (!["{", "["].includes(text.charAt(__1.FIRST))) {
+                if (["OK"].includes(text)) {
+                    logger.debug({ text, ...extras }, "Full response text");
+                }
+                else {
+                    // It's probably a coding error error, and not something a user did.
+                    // Will try to keep the array up to date if any other edge cases pop up
+                    logger.warn({ text, ...extras }, `Unexpected API Response`);
+                }
+                return text;
+            }
+            const parsed = JSON.parse(text);
+            return checkForHttpErrors(parsed);
+        }
+        function fetchCreateUrl({ rawUrl, url, ...fetchWith }) {
+            let out = url || "";
+            if (!rawUrl) {
+                const base = fetchWith.baseUrl || baseUrl;
+                out = base + url;
+            }
+            if (!__1.is.empty(fetchWith.params)) {
+                out = `${out}?${(0, __2.buildFilterString)(fetchWith)}`;
+            }
+            return out;
+        }
+        async function MeasureRequest(label, context, exec) {
+            try {
+                const out = await exec();
+                if (!__1.is.empty(label)) {
+                    __2.FETCH_REQUESTS_SUCCESSFUL.labels(context, label).inc();
+                }
+                return out;
+            }
+            catch (error) {
+                logger.error({ error, ...extras }, `Request failed`);
+                if (!__1.is.empty(label)) {
+                    __2.FETCH_REQUESTS_FAILED.labels(context, label).inc();
+                }
+                throw error;
+            }
+        }
+        async function execFetch({ body, headers = {}, method = "get", process, label, context = logContext || parentContext, ...fetchWith }) {
+            const out = await MeasureRequest(label, context, async () => {
+                const contentType = __1.is.object(body)
+                    ? { "Content-Type": "application/json" }
+                    : {};
+                const result = await fetch(fetchCreateUrl(fetchWith), {
+                    body: __1.is.object(body) ? JSON.stringify(body) : body,
+                    headers: {
+                        ...contentType,
+                        ...baseHeaders,
+                        ...headers,
+                    },
+                    method,
+                });
+                return await fetchHandleResponse(process, result);
+            });
+            __2.FETCH_REQUESTS_SUCCESSFUL.labels(context, label).inc();
+            return out;
+        }
+        return {
+            download: async ({ destination, body, headers = {}, label, context = logContext || parentContext, method = "get", ...fetchWith }) => {
+                const url = await fetchCreateUrl(fetchWith);
+                const response = await fetch(url, {
+                    body: __1.is.object(body) ? JSON.stringify(body) : body,
+                    headers: {
+                        ...baseHeaders,
+                        ...headers,
+                    },
+                    method,
+                });
+                const stream = (0, fs_1.createWriteStream)(destination);
+                await streamPipeline(response.body, stream);
+                if (!__1.is.empty(label)) {
+                    __2.FETCH_DOWNLOAD_REQUESTS_SUCCESSFUL.labels(context, label).inc();
+                }
+            },
+            fetch: async (fetchWith) => {
+                if (!limiter) {
+                    return await execFetch(fetchWith);
+                }
+                let end;
+                if (!__1.is.empty(fetchWith.label)) {
+                    end = __2.FETCH_REQUEST_BOTTLENECK_DELAY.startTimer();
+                }
+                return limiter.schedule(async () => {
+                    if (end) {
+                        end({
+                            context: fetchWith.context || parentContext,
+                            label: fetchWith.label,
+                        });
+                    }
+                    return await execFetch(fetchWith);
+                });
+            },
+            setBaseUrl: (url) => (baseUrl = url),
+            setHeaders: (headers) => (baseHeaders = headers),
+        };
+    };
+    __1.ZCC.createFetcher = createFetcher;
+    __1.ZCC.fetch = createFetcher({ context: parentContext }).fetch;
+    return createFetcher;
+}
+exports.Fetch = Fetch;
+//# sourceMappingURL=fetch.extension.js.map

package/dist/boilerplate/extensions/fetch.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.extension.js","sourceRoot":"","sources":["../../../src/boilerplate/extensions/fetch.extension.ts"],"names":[],"mappings":";;;;AAAA,oEAAoC;AACpC,2BAAuC;AACvC,mCAAkC;AAClC,+BAAiC;AAEjC,6BAAiD;AACjD,0BAeY;AAEZ,MAAM,cAAc,GAAG,IAAA,gBAAS,EAAC,iBAAQ,CAAC,CAAC;AAE3C,SAAgB,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAkB;IACtE,MAAM,aAAa,GAAG,CAAC,EACrB,UAAU,EACV,OAAO,EAAE,WAAW,EACpB,OAAO,EACP,OAAO,EAAE,UAAU;IACnB,wDAAwD;MACzC,EAAE,EAAE;QACnB,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,CAAC,MAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC;QACjC,CAAC;QACD,IAAI,OAAmB,CAAC;QACxB,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,IAAI,UAAU,EAAE,CAAC;YACf,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAChC,OAAO,GAAG,IAAI,oBAAU,CAAC,UAAU,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,MAAE,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YAC5B,MAAM,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,GAAG,MAAM,EAAE,EAAE,qBAAqB,CAAC,CAAC;QACnE,CAAC;QAED,SAAS,kBAAkB,CACzB,UAA0B;YAE1B,IACE,MAAE,CAAC,MAAM,CAAC,UAAU,CAAC;gBACrB,UAAU,KAAK,IAAI;gBACnB,MAAE,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC;gBAChC,MAAE,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAC3B,CAAC;gBACD,0BAA0B;gBAC1B,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;gBAEnE,4BAA4B;gBAC5B,2CAA2C;gBAC3C,MAAM,IAAI,qBAAiB,CACzB,UAAU,CAAC,UAAU,EACrB,UAAU,CAAC,KAAK,EAChB,UAAU,CAAC,OAAO,CACnB,CAAC;YACJ,CAAC;YAED,OAAO,UAAe,CAAC;QACzB,CAAC;QAED,KAAK,UAAU,mBAAmB,CAChC,OAA0B,EAC1B,QAAkB;YAElB,IAAI,OAAO,KAAK,KAAK,IAAI,OAAO,KAAK,KAAK,EAAE,CAAC;gBAC3C,OAAO,QAAa,CAAC;YACvB,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;gBACvB,OAAO,IAAoB,CAAC;YAC9B,CAAC;YACD,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,SAAK,CAAC,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC1B,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,EAAE,oBAAoB,CAAC,CAAC;gBAC1D,CAAC;qBAAM,CAAC;oBACN,oEAAoE;oBACpE,uEAAuE;oBACvE,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,EAAE,yBAAyB,CAAC,CAAC;gBAC9D,CAAC;gBACD,OAAO,IAAS,CAAC;YACnB,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAChC,OAAO,kBAAkB,CAAI,MAAM,CAAC,CAAC;QACvC,CAAC;QAED,SAAS,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,SAAS,EAAa;YAC9D,IAAI,GAAG,GAAG,GAAG,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,IAAI,OAAO,CAAC;gBAC1C,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC;YACnB,CAAC;YACD,IAAI,CAAC,MAAE,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChC,GAAG,GAAG,GAAG,GAAG,IAAI,IAAA,qBAAiB,EAAC,SAAS,CAAC,EAAE,CAAC;YACjD,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAED,KAAK,UAAU,cAAc,CAC3B,KAAa,EACb,OAAiB,EACjB,IAAsB;YAEtB,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,IAAI,EAAE,CAAC;gBACzB,IAAI,CAAC,MAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrB,6BAAyB,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;gBACzD,CAAC;gBACD,OAAO,GAAG,CAAC;YACb,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,EAAE,gBAAgB,CAAC,CAAC;gBACrD,IAAI,CAAC,MAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrB,yBAAqB,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;gBACrD,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QAED,KAAK,UAAU,SAAS,CAAyC,EAC/D,IAAI,EACJ,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,KAAK,EACd,OAAO,EACP,KAAK,EACL,OAAO,GAAG,UAAU,IAAI,aAAa,EACrC,GAAG,SAAS,EACkB;YAC9B,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,WAAW,GAAG,MAAE,CAAC,MAAM,CAAC,IAAI,CAAC;oBACjC,CAAC,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE;oBACxC,CAAC,CAAC,EAAE,CAAC;gBACP,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;oBACpD,IAAI,EAAE,MAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;oBACnD,OAAO,EAAE;wBACP,GAAG,WAAW;wBACd,GAAG,WAAW;wBACd,GAAG,OAAO;qBACX;oBACD,MAAM;iBACP,CAAC,CAAC;gBACH,OAAO,MAAM,mBAAmB,CAAI,OAAO,EAAE,MAAM,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;YACH,6BAAyB,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;YACvD,OAAO,GAAG,CAAC;QACb,CAAC;QAED,OAAO;YACL,QAAQ,EAAE,KAAK,EAAE,EACf,WAAW,EACX,IAAI,EACJ,OAAO,GAAG,EAAE,EACZ,KAAK,EACL,OAAO,GAAG,UAAU,IAAI,aAAa,EACrC,MAAM,GAAG,KAAK,EACd,GAAG,SAAS,EACI,EAAE,EAAE;gBACpB,MAAM,GAAG,GAAW,MAAM,cAAc,CAAC,SAAS,CAAC,CAAC;gBACpD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;oBAChC,IAAI,EAAE,MAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;oBACnD,OAAO,EAAE;wBACP,GAAG,WAAW;wBACd,GAAG,OAAO;qBACX;oBACD,MAAM;iBACP,CAAC,CAAC;gBAEH,MAAM,MAAM,GAAG,IAAA,sBAAiB,EAAC,WAAW,CAAC,CAAC;gBAC9C,MAAM,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAC5C,IAAI,CAAC,MAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrB,sCAAkC,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;gBAClE,CAAC;YACH,CAAC;YACD,KAAK,EAAE,KAAK,EACV,SAAwC,EAChB,EAAE;gBAC1B,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,OAAO,MAAM,SAAS,CAAC,SAAS,CAAC,CAAC;gBACpC,CAAC;gBACD,IAAI,GAAiE,CAAC;gBACtE,IAAI,CAAC,MAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC/B,GAAG,GAAG,kCAA8B,CAAC,UAAU,EAAE,CAAC;gBACpD,CAAC;gBACD,OAAO,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;oBACjC,IAAI,GAAG,EAAE,CAAC;wBACR,GAAG,CAAC;4BACF,OAAO,EAAE,SAAS,CAAC,OAAO,IAAI,aAAa;4BAC3C,KAAK,EAAE,SAAS,CAAC,KAAK;yBACvB,CAAC,CAAC;oBACL,CAAC;oBACD,OAAO,MAAM,SAAS,CAAC,SAAS,CAAC,CAAC;gBACpC,CAAC,CAAC,CAAC;YACL,CAAC;YACD,UAAU,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC;YAC5C,UAAU,EAAE,CAAC,OAA+B,EAAE,EAAE,CAAC,CAAC,WAAW,GAAG,OAAO,CAAC;SACzE,CAAC;IACJ,CAAC,CAAC;IACF,OAAG,CAAC,aAAa,GAAG,aAAa,CAAC;IAClC,OAAG,CAAC,KAAK,GAAG,aAAa,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC;IAC5D,OAAO,aAAa,CAAC;AACvB,CAAC;AAxLD,sBAwLC"}

package/dist/boilerplate/extensions/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./cache.extension";
+export * from "./configuration.extension";
+export * from "./fetch.extension";
+export * from "./logger.extension";
+export * from "./scheduler.extension";
+export * from "./wiring.extension";

package/dist/boilerplate/extensions/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./cache.extension"), exports);
+tslib_1.__exportStar(require("./configuration.extension"), exports);
+tslib_1.__exportStar(require("./fetch.extension"), exports);
+tslib_1.__exportStar(require("./logger.extension"), exports);
+tslib_1.__exportStar(require("./scheduler.extension"), exports);
+tslib_1.__exportStar(require("./wiring.extension"), exports);
+//# sourceMappingURL=index.js.map

package/dist/boilerplate/extensions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/boilerplate/extensions/index.ts"],"names":[],"mappings":";;;AAAA,4DAAkC;AAClC,oEAA0C;AAC1C,4DAAkC;AAClC,6DAAmC;AACnC,gEAAsC;AACtC,6DAAmC"}

package/dist/boilerplate/extensions/logger.extension.d.ts

@@ -0,0 +1,39 @@
+import { pino } from "pino";
+import { TContext } from "../..";
+import { TServiceParams } from "..";
+export type TLoggerFunction = ((message: string, ...arguments_: unknown[]) => void) | ((object: object, message?: string, ...arguments_: unknown[]) => void);
+export interface ILogger {
+    debug(...arguments_: Parameters<TLoggerFunction>): void;
+    debug(message: string, ...arguments_: unknown[]): void;
+    debug(object: object, message?: string, ...arguments_: unknown[]): void;
+    error(...arguments_: Parameters<TLoggerFunction>): void;
+    error(message: string, ...arguments_: unknown[]): void;
+    error(object: object, message?: string, ...arguments_: unknown[]): void;
+    fatal(...arguments_: Parameters<TLoggerFunction>): void;
+    fatal(message: string, ...arguments_: unknown[]): void;
+    fatal(object: object, message?: string, ...arguments_: unknown[]): void;
+    info(...arguments_: Parameters<TLoggerFunction>): void;
+    info(message: string, ...arguments_: unknown[]): void;
+    info(object: object, message?: string, ...arguments_: unknown[]): void;
+    trace(...arguments_: Parameters<TLoggerFunction>): void;
+    trace(message: string, ...arguments_: unknown[]): void;
+    trace(object: object, message?: string, ...arguments_: unknown[]): void;
+    warn(...arguments_: Parameters<TLoggerFunction>): void;
+    warn(message: string, ...arguments_: unknown[]): void;
+    warn(object: object, message?: string, ...arguments_: unknown[]): void;
+}
+export declare const METHOD_COLORS: Map<pino.Level, CONTEXT_COLORS>;
+export type CONTEXT_COLORS = "grey" | "blue" | "yellow" | "red" | "green" | "magenta";
+export declare function Logger({ lifecycle, config }: TServiceParams): Promise<{
+    context: (context: string | TContext) => ILogger;
+    getBaseLogger: () => ILogger;
+    getLogLevel: () => pino.Level;
+    setBaseLogger: (base: ILogger) => ILogger;
+    setLogLevel: (level: pino.Level) => void;
+}>;
+declare module "../../utilities" {
+    interface ZCCDefinition {
+        logger: Awaited<ReturnType<typeof Logger>>;
+        systemLogger: ILogger;
+    }
+}

package/dist/boilerplate/extensions/logger.extension.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = exports.METHOD_COLORS = void 0;
+/* eslint-disable @typescript-eslint/no-magic-numbers */
+const pino_1 = require("pino");
+const util_1 = require("util");
+const __1 = require("../..");
+let logger = (0, pino_1.pino)({
+    level: "debug",
+    transport: {
+        options: {
+            colorize: true,
+            crlf: false,
+            customPrettifiers: {},
+            errorLikeObjectKeys: ["err", "error"],
+            errorProps: "",
+            hideObject: false,
+            ignore: "pid,hostname,level",
+            levelFirst: false,
+            levelKey: "level",
+            messageKey: "msg",
+            singleLine: false,
+            timestampKey: "time",
+            translateTime: "SYS:ddd hh:MM:ss.l",
+        },
+        target: "pino-pretty",
+    },
+}, pino_1.pino.destination({ sync: true }));
+const LOG_LEVEL_PRIORITY = {
+    debug: 20,
+    error: 50,
+    fatal: 60,
+    info: 30,
+    trace: 10,
+    warn: 40,
+};
+exports.METHOD_COLORS = new Map([
+    ["trace", "grey"],
+    ["debug", "blue"],
+    ["warn", "yellow"],
+    ["error", "red"],
+    ["info", "green"],
+    ["fatal", "magenta"],
+]);
+const MAX_CUTOFF = 2000;
+const frontDash = " - ";
+async function Logger({ lifecycle, config }) {
+    const chalk = (await import("chalk")).default;
+    function log(method, context, ...parameters) {
+        // standardLogger(method, context, ...parameters);
+        prettyLogger(method, context, ...parameters);
+    }
+    const YELLOW_DASH = chalk.yellowBright(frontDash);
+    const highlightContext = (context, level) => chalk.bold[level](`[${context}]`);
+    const prettyFormatMessage = (message) => {
+        if (!message) {
+            return ``;
+        }
+        if (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("] > [", chalk `] {blue >} [`)
+            // ? [Text] - strip brackets, highlight magenta
+            .replaceAll(new RegExp("(\\[[^\\]\\[]+\\])", "g"), i => chalk.bold.magenta(i.slice(1, -1)))
+            // ? {Text} - strip braces, highlight gray
+            .replaceAll(new RegExp("(\\{[^\\]}]+\\})", "g"), i => chalk.bold.gray(i.slice(1, -1)));
+        // ? " - Text" (line prefix with dash) - highlight dash
+        if (message.slice(0, frontDash.length) === frontDash) {
+            message = `${YELLOW_DASH}${message.slice(frontDash.length)}`;
+        }
+        return message;
+    };
+    function prettyLogger(method, context, ...parameters) {
+        // * If providing an object as the 1st arg
+        if (__1.is.object(parameters[0])) {
+            const data = parameters.shift();
+            // Extract the context property, and use it in place of generated
+            if (__1.is.string(data.context) && !__1.is.empty(data.context)) {
+                context = data.context;
+                delete data.context;
+            }
+            const message = [
+                highlightContext(context, exports.METHOD_COLORS.get(method)),
+                prettyFormatMessage(parameters.shift()),
+            ].join(" ");
+            if ("error" in data && data.error instanceof Error) {
+                // pino is doing something weird, not sure why it won't print useful stuff about the error
+                // this keeps the stack attach
+                data.stack = data.error.stack.trim().split("\n");
+            }
+            logger[method](data, message, ...parameters);
+            return;
+        }
+        // * Text only log
+        const message = [
+            highlightContext(context, exports.METHOD_COLORS.get(method)),
+            prettyFormatMessage(parameters.shift()),
+        ].join(" ");
+        logger[method](message, ...parameters);
+    }
+    // tuned to be most useful in debugging this
+    util_1.inspect.defaultOptions.colors = true;
+    util_1.inspect.defaultOptions.depth = 10;
+    util_1.inspect.defaultOptions.numericSeparator = true;
+    util_1.inspect.defaultOptions.compact = false;
+    util_1.inspect.defaultOptions.colors = true;
+    let logLevel = "debug";
+    const shouldLog = (level) => LOG_LEVEL_PRIORITY[level] >= LOG_LEVEL_PRIORITY[logLevel];
+    function createBaseLogger() {
+        logger = (0, pino_1.pino)({
+            level: config.boilerplate.LOG_LEVEL,
+            transport: {
+                options: {
+                    colorize: true,
+                    crlf: false,
+                    customPrettifiers: {},
+                    errorLikeObjectKeys: ["err", "error"],
+                    errorProps: "error",
+                    hideObject: false,
+                    ignore: "pid,hostname,level",
+                    levelFirst: false,
+                    levelKey: "level",
+                    messageKey: "msg",
+                    singleLine: false,
+                    timestampKey: "time",
+                    translateTime: "SYS:ddd hh:MM:ss.l",
+                },
+                target: "pino-pretty",
+            },
+        }, pino_1.pino.destination({ sync: true }));
+    }
+    lifecycle.onPostConfig(() => createBaseLogger());
+    const out = {
+        context: (context) => ({
+            debug: (...params) => shouldLog("debug") && log("debug", context, ...params),
+            error: (...params) => shouldLog("error") && log("error", context, ...params),
+            fatal: (...params) => shouldLog("fatal") && log("fatal", context, ...params),
+            info: (...params) => shouldLog("info") && log("info", context, ...params),
+            trace: (...params) => shouldLog("trace") && log("trace", context, ...params),
+            warn: (...params) => shouldLog("warn") && log("warn", context, ...params),
+        }),
+        getBaseLogger: () => logger,
+        getLogLevel: () => logLevel,
+        setBaseLogger: (base) => (logger = base),
+        setLogLevel: (level) => {
+            logLevel = level;
+            __1.ZCC.config.set("boilerplate", "LOG_LEVEL", level);
+        },
+    };
+    __1.ZCC.logger = out;
+    __1.ZCC.systemLogger = __1.ZCC.logger.context("digital-alchemy:system");
+    return out;
+}
+exports.Logger = Logger;
+//# sourceMappingURL=logger.extension.js.map

package/dist/boilerplate/extensions/logger.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.extension.js","sourceRoot":"","sources":["../../../src/boilerplate/extensions/logger.extension.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACxD,+BAA4B;AAC5B,+BAA+B;AAE/B,6BAA0C;AA4B1C,IAAI,MAAM,GAAG,IAAA,WAAI,EACf;IACE,KAAK,EAAE,OAAO;IACd,SAAS,EAAE;QACT,OAAO,EAAE;YACP,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,KAAK;YACX,iBAAiB,EAAE,EAAE;YACrB,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;YACrC,UAAU,EAAE,EAAE;YACd,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,oBAAoB;YAC5B,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,OAAO;YACjB,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,MAAM;YACpB,aAAa,EAAE,oBAAoB;SACpC;QACD,MAAM,EAAE,aAAa;KACtB;CACF,EACD,WAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CACtB,CAAC;AAEb,MAAM,kBAAkB,GAAG;IACzB,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;IACT,KAAK,EAAE,EAAE;IACT,IAAI,EAAE,EAAE;IACR,KAAK,EAAE,EAAE;IACT,IAAI,EAAE,EAAE;CACT,CAAC;AAEW,QAAA,aAAa,GAAG,IAAI,GAAG,CAA6B;IAC/D,CAAC,OAAO,EAAE,MAAM,CAAC;IACjB,CAAC,OAAO,EAAE,MAAM,CAAC;IACjB,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClB,CAAC,OAAO,EAAE,KAAK,CAAC;IAChB,CAAC,MAAM,EAAE,OAAO,CAAC;IACjB,CAAC,OAAO,EAAE,SAAS,CAAC;CACrB,CAAC,CAAC;AA8BH,MAAM,UAAU,GAAG,IAAI,CAAC;AACxB,MAAM,SAAS,GAAG,KAAK,CAAC;AAEjB,KAAK,UAAU,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,EAAkB;IAChE,MAAM,KAAK,GAAG,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;IAE9C,SAAS,GAAG,CACV,MAAkB,EAClB,OAAiB,EACjB,GAAG,UAAuC;QAE1C,kDAAkD;QAClD,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAClD,MAAM,gBAAgB,GAAG,CAAC,OAAiB,EAAE,KAAqB,EAAU,EAAE,CAC5E,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC;IAEpC,MAAM,mBAAmB,GAAG,CAAC,OAAe,EAAU,EAAE;QACtD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAChC,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,CAAA,cAAc,CAAC;YACzC,+CAA+C;aAC9C,UAAU,CAAC,IAAI,MAAM,CAAC,oBAAoB,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,CACrD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CACnC;YACD,0CAA0C;aACzC,UAAU,CAAC,IAAI,MAAM,CAAC,kBAAkB,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,CACnD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAChC,CAAC;QACJ,uDAAuD;QACvD,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;YACrD,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,SAAS,YAAY,CACnB,MAAkB,EAClB,OAAiB,EACjB,GAAG,UAAuC;QAE1C,0CAA0C;QAC1C,IAAI,MAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,EAI5B,CAAC;YAEF,iEAAiE;YACjE,IAAI,MAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBACvD,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;gBACvB,OAAO,IAAI,CAAC,OAAO,CAAC;YACtB,CAAC;YACD,MAAM,OAAO,GAAG;gBACd,gBAAgB,CAAC,OAAO,EAAE,qBAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpD,mBAAmB,CAAC,UAAU,CAAC,KAAK,EAAY,CAAC;aAClD,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEZ,IAAI,OAAO,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,YAAY,KAAK,EAAE,CAAC;gBACnD,0FAA0F;gBAC1F,8BAA8B;gBAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;YAC7C,OAAO;QACT,CAAC;QAED,kBAAkB;QAClB,MAAM,OAAO,GAAG;YACd,gBAAgB,CAAC,OAAO,EAAE,qBAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpD,mBAAmB,CAAC,UAAU,CAAC,KAAK,EAAY,CAAC;SAClD,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACZ,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IACzC,CAAC;IAED,4CAA4C;IAC5C,cAAO,CAAC,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC;IACrC,cAAO,CAAC,cAAc,CAAC,KAAK,GAAG,EAAE,CAAC;IAClC,cAAO,CAAC,cAAc,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC/C,cAAO,CAAC,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;IACvC,cAAO,CAAC,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC;IAErC,IAAI,QAAQ,GAAe,OAAO,CAAC;IACnC,MAAM,SAAS,GAAG,CAAC,KAAiB,EAAE,EAAE,CACtC,kBAAkB,CAAC,KAAK,CAAC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAE5D,SAAS,gBAAgB;QACvB,MAAM,GAAG,IAAA,WAAI,EACX;YACE,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,SAAS;YACnC,SAAS,EAAE;gBACT,OAAO,EAAE;oBACP,QAAQ,EAAE,IAAI;oBACd,IAAI,EAAE,KAAK;oBACX,iBAAiB,EAAE,EAAE;oBACrB,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;oBACrC,UAAU,EAAE,OAAO;oBACnB,UAAU,EAAE,KAAK;oBACjB,MAAM,EAAE,oBAAoB;oBAC5B,UAAU,EAAE,KAAK;oBACjB,QAAQ,EAAE,OAAO;oBACjB,UAAU,EAAE,KAAK;oBACjB,UAAU,EAAE,KAAK;oBACjB,YAAY,EAAE,MAAM;oBACpB,aAAa,EAAE,oBAAoB;iBACpC;gBACD,MAAM,EAAE,aAAa;aACtB;SACF,EACD,WAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CACtB,CAAC;IACf,CAAC;IACD,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACjD,MAAM,GAAG,GAAG;QACV,OAAO,EAAE,CAAC,OAA0B,EAAE,EAAE,CACtC,CAAC;YACC,KAAK,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAChD,SAAS,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,OAAmB,EAAE,GAAG,MAAM,CAAC;YACpE,KAAK,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAChD,SAAS,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,OAAmB,EAAE,GAAG,MAAM,CAAC;YACpE,KAAK,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAChD,SAAS,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,OAAmB,EAAE,GAAG,MAAM,CAAC;YACpE,IAAI,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAC/C,SAAS,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,OAAmB,EAAE,GAAG,MAAM,CAAC;YAClE,KAAK,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAChD,SAAS,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,OAAmB,EAAE,GAAG,MAAM,CAAC;YACpE,IAAI,EAAE,CAAC,GAAG,MAAmC,EAAE,EAAE,CAC/C,SAAS,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,OAAmB,EAAE,GAAG,MAAM,CAAC;SACnE,CAAY;QACf,aAAa,EAAE,GAAG,EAAE,CAAC,MAAM;QAC3B,WAAW,EAAE,GAAG,EAAE,CAAC,QAAQ;QAC3B,aAAa,EAAE,CAAC,IAAa,EAAE,EAAE,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC;QACjD,WAAW,EAAE,CAAC,KAAiB,EAAE,EAAE;YACjC,QAAQ,GAAG,KAAK,CAAC;YACjB,OAAG,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC;KACF,CAAC;IACF,OAAG,CAAC,MAAM,GAAG,GAAG,CAAC;IACjB,OAAG,CAAC,YAAY,GAAG,OAAG,CAAC,MAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEhE,OAAO,GAAG,CAAC;AACb,CAAC;AAtJD,wBAsJC"}

package/dist/boilerplate/extensions/scheduler.extension.d.ts

@@ -0,0 +1,21 @@
+import { Dayjs } from "dayjs";
+import { schedule } from "node-cron";
+import { Schedule, SchedulerOptions, TServiceParams } from "../helpers";
+export declare function Scheduler({ logger, lifecycle }: TServiceParams): {
+    cron: ({ context, exec, schedule: scheduleList, label, }: SchedulerOptions & {
+        schedule: Schedule | Schedule[];
+    }) => () => void;
+    interval: ({ context, exec, interval, label, }: SchedulerOptions & {
+        interval: number;
+    }) => () => void;
+    sliding: ({ context, exec, reset, next, label, }: SchedulerOptions & {
+        /**
+         * How often to run the `next` method, to retrieve the next scheduled execution time
+         */
+        reset: Schedule;
+        /**
+         * Return something time like. undefined = skip next
+         */
+        next: () => Dayjs | string | number | Date | undefined;
+    }) => () => void;
+};

package/dist/boilerplate/extensions/scheduler.extension.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Scheduler = void 0;
+const tslib_1 = require("tslib");
+/* eslint-disable sonarjs/cognitive-complexity */
+const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
+const node_cron_1 = require("node-cron");
+const __1 = require("../..");
+const helpers_1 = require("../helpers");
+function Scheduler({ logger, lifecycle }) {
+    const stop = new Set();
+    lifecycle.onShutdownStart(() => {
+        stop.forEach(stopFunctions => {
+            stopFunctions();
+            stop.delete(stopFunctions);
+        });
+    });
+    // node-cron
+    function cron({ context, exec, schedule: scheduleList, label, }) {
+        const stopFunctions = [];
+        [scheduleList].flat().forEach(cronSchedule => {
+            logger.trace({ context, label, schedule: cronSchedule }, `start schedule`);
+            const cronJob = (0, node_cron_1.schedule)(cronSchedule, async () => await __1.ZCC.safeExec({
+                duration: helpers_1.SCHEDULE_EXECUTION_TIME,
+                errors: helpers_1.SCHEDULE_ERRORS,
+                exec,
+                executions: helpers_1.SCHEDULE_EXECUTION_COUNT,
+                labels: { context, label },
+            }));
+            lifecycle.onReady(() => {
+                logger.trace({ context, schedule: cronSchedule }, "start cron");
+                cronJob.start();
+            });
+            const stopFunction = () => {
+                logger.trace({ context, label, schedule: cronSchedule }, `stop schedule`);
+                cronJob.stop();
+            };
+            stop.add(stopFunction);
+            stopFunctions.push(stopFunction);
+            return stopFunction;
+        });
+        return () => stopFunctions.forEach(stop => stop());
+    }
+    // setInterval
+    function interval({ context, exec, interval, label, }) {
+        let runningInterval;
+        lifecycle.onReady(() => {
+            logger.trace({ context }, "start interval");
+            runningInterval = setInterval(async () => await __1.ZCC.safeExec({
+                duration: helpers_1.SCHEDULE_EXECUTION_TIME,
+                errors: helpers_1.SCHEDULE_ERRORS,
+                exec,
+                executions: helpers_1.SCHEDULE_EXECUTION_COUNT,
+                labels: { context, label },
+            }), interval);
+        });
+        const stopFunction = () => {
+            if (runningInterval) {
+                clearInterval(runningInterval);
+            }
+        };
+        stop.add(stopFunction);
+        return stopFunction;
+    }
+    function sliding({ context, exec, reset, next, label, }) {
+        const scheduleStop = cron({
+            context,
+            exec: () => {
+                if (timeout) {
+                    logger.warn({ context }, `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 = (0, dayjs_1.default)(nextTime);
+                if ((0, dayjs_1.default)().isAfter(nextTime)) {
+                    logger.warn({ nextTime: nextTime.toISOString() }, `cannot schedule sliding schedules for the past`);
+                    // or anything else really
+                    // life sucks that way
+                    return;
+                }
+                if (nextTime) {
+                    timeout = setTimeout(async () => {
+                        await __1.ZCC.safeExec({
+                            duration: helpers_1.SCHEDULE_EXECUTION_TIME,
+                            errors: helpers_1.SCHEDULE_ERRORS,
+                            exec,
+                            executions: helpers_1.SCHEDULE_EXECUTION_COUNT,
+                            labels: { context, label },
+                        });
+                    }, Math.abs((0, dayjs_1.default)().diff(nextTime, "ms")));
+                }
+            },
+            label,
+            schedule: reset,
+        });
+        let timeout;
+        return () => {
+            scheduleStop();
+            if (timeout) {
+                clearTimeout(timeout);
+                timeout = undefined;
+            }
+        };
+    }
+    return {
+        cron,
+        interval,
+        sliding,
+    };
+}
+exports.Scheduler = Scheduler;
+//# sourceMappingURL=scheduler.extension.js.map

package/dist/boilerplate/extensions/scheduler.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.extension.js","sourceRoot":"","sources":["../../../src/boilerplate/extensions/scheduler.extension.ts"],"names":[],"mappings":";;;;AAAA,iDAAiD;AACjD,0DAAqC;AACrC,yCAAqC;AAErC,6BAAwC;AACxC,wCAOoB;AAEpB,SAAgB,SAAS,CAAC,EAAE,MAAM,EAAE,SAAS,EAAkB;IAC7D,MAAM,IAAI,GAAG,IAAI,GAAG,EAAoB,CAAC;IAEzC,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE;QAC7B,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,YAAY;IACZ,SAAS,IAAI,CAAC,EACZ,OAAO,EACP,IAAI,EACJ,QAAQ,EAAE,YAAY,EACtB,KAAK,GACkD;QACvD,MAAM,aAAa,GAAyB,EAAE,CAAC;QAC/C,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YAC3C,MAAM,CAAC,KAAK,CACV,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,EAC1C,gBAAgB,CACjB,CAAC;YACF,MAAM,OAAO,GAAG,IAAA,oBAAQ,EACtB,YAAY,EACZ,KAAK,IAAI,EAAE,CACT,MAAM,OAAG,CAAC,QAAQ,CAAC;gBACjB,QAAQ,EAAE,iCAAuB;gBACjC,MAAM,EAAE,yBAAe;gBACvB,IAAI;gBACJ,UAAU,EAAE,kCAAwB;gBACpC,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;aAC3B,CAAC,CACL,CAAC;YACF,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE;gBACrB,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,YAAY,CAAC,CAAC;gBAChE,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,CAAC,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,GAAG,EAAE;gBACxB,MAAM,CAAC,KAAK,CACV,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,EAC1C,eAAe,CAChB,CAAC;gBACF,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,CAAC,CAAC;YAEF,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACvB,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjC,OAAO,YAAY,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,cAAc;IACd,SAAS,QAAQ,CAAC,EAChB,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,KAAK,GACmC;QACxC,IAAI,eAA+C,CAAC;QACpD,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,gBAAgB,CAAC,CAAC;YAE5C,eAAe,GAAG,WAAW,CAC3B,KAAK,IAAI,EAAE,CACT,MAAM,OAAG,CAAC,QAAQ,CAAC;gBACjB,QAAQ,EAAE,iCAAuB;gBACjC,MAAM,EAAE,yBAAe;gBACvB,IAAI;gBACJ,UAAU,EAAE,kCAAwB;gBACpC,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;aAC3B,CAAC,EACJ,QAAQ,CACT,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,IAAI,eAAe,EAAE,CAAC;gBACpB,aAAa,CAAC,eAAe,CAAC,CAAC;YACjC,CAAC;QACH,CAAC,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACvB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,SAAS,OAAO,CAAC,EACf,OAAO,EACP,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,KAAK,GAUN;QACC,MAAM,YAAY,GAAG,IAAI,CAAC;YACxB,OAAO;YACP,IAAI,EAAE,GAAG,EAAE;gBACT,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,CAAC,IAAI,CACT,EAAE,OAAO,EAAE,EACX,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,IAAA,eAAK,EAAC,QAAQ,CAAC,CAAC;gBAC3B,IAAI,IAAA,eAAK,GAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC9B,MAAM,CAAC,IAAI,CACT,EAAE,QAAQ,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,EACpC,gDAAgD,CACjD,CAAC;oBACF,0BAA0B;oBAC1B,sBAAsB;oBACtB,OAAO;gBACT,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,OAAO,GAAG,UAAU,CAClB,KAAK,IAAI,EAAE;wBACT,MAAM,OAAG,CAAC,QAAQ,CAAC;4BACjB,QAAQ,EAAE,iCAAuB;4BACjC,MAAM,EAAE,yBAAe;4BACvB,IAAI;4BACJ,UAAU,EAAE,kCAAwB;4BACpC,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;yBAC3B,CAAC,CAAC;oBACL,CAAC,EACD,IAAI,CAAC,GAAG,CAAC,IAAA,eAAK,GAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CACvC,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,KAAK;YACL,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAC;QAEH,IAAI,OAAsC,CAAC;QAE3C,OAAO,GAAG,EAAE;YACV,YAAY,EAAE,CAAC;YACf,IAAI,OAAO,EAAE,CAAC;gBACZ,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,OAAO,GAAG,SAAS,CAAC;YACtB,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAED,OAAO;QACL,IAAI;QACJ,QAAQ;QACR,OAAO;KACR,CAAC;AACJ,CAAC;AApKD,8BAoKC"}

package/dist/boilerplate/extensions/wiring.extension.d.ts

@@ -0,0 +1,101 @@
+import { Counter, Summary } from "prom-client";
+import { TBlackHole, TContext } from "../..";
+import { ApplicationConfigurationOptions, ApplicationDefinition, LibraryConfigurationOptions, LibraryDefinition, OptionalModuleConfiguration, ServiceFunction, ServiceMap, StringConfig, TLifecycleBase, TModuleMappings, TResolvedModuleMappings, TServiceReturn } from "../helpers";
+import { Cache } from "./cache.extension";
+import { Configuration } from "./configuration.extension";
+import { Fetch } from "./fetch.extension";
+import { Logger } from "./logger.extension";
+import { Scheduler } from "./scheduler.extension";
+/**
+ * association of projects to { service : Declaration Function }
+ */
+declare let MODULE_MAPPINGS: Map<string, TModuleMappings>;
+/**
+ * association of projects to { service : Initialized Service }
+ */
+declare let LOADED_MODULES: Map<string, TResolvedModuleMappings>;
+/**
+ * Optimized reverse lookups: Declaration  Function => [project, service]
+ */
+declare let REVERSE_MODULE_MAPPING: Map<ServiceFunction, [project: string, service: string]>;
+export declare let LIB_BOILERPLATE: ReturnType<typeof CreateBoilerplate>;
+declare function CreateBoilerplate(): LibraryDefinition<{
+    cache: typeof Cache;
+    configuration: typeof Configuration;
+    fetch: typeof Fetch;
+    logger: typeof Logger;
+    scheduler: typeof Scheduler;
+}, {
+    CACHE_PREFIX: {
+        description: string;
+        type: "string";
+    };
+    CACHE_PROVIDER: StringConfig<"redis" | "memory">;
+    CACHE_TTL: {
+        default: number;
+        description: string;
+        type: "number";
+    };
+    CONFIG: {
+        description: string;
+        type: "string";
+    };
+    LOG_LEVEL: StringConfig<import("pino").default.Level>;
+    LOG_METRICS: {
+        default: true;
+        type: "boolean";
+    };
+    REDIS_URL: {
+        default: string;
+        description: string;
+        type: "string";
+    };
+}>;
+export declare function CreateLibrary<S extends ServiceMap, C extends OptionalModuleConfiguration>({ name: libraryName, configuration, priorityInit, services, }: LibraryConfigurationOptions<S, C>): LibraryDefinition<S, C>;
+export declare function CreateApplication<S extends ServiceMap, C extends OptionalModuleConfiguration>({ name, services, libraries, configuration, priorityInit, }: ApplicationConfigurationOptions<S, C>): ApplicationDefinition<S, C>;
+declare function WireService(project: string, service: string, definition: ServiceFunction, lifecycle: TLifecycleBase): Promise<TServiceReturn>;
+declare function Teardown(): Promise<void>;
+declare module "../../utilities" {
+    interface ZCCTestingDefinition {
+        FailFast: () => void;
+        Teardown: typeof Teardown;
+        /**
+         * exported helpers for unit testing, no use to applications
+         */
+        LOADED_MODULES: () => typeof LOADED_MODULES;
+        MODULE_MAPPINGS: () => typeof MODULE_MAPPINGS;
+        REVERSE_MODULE_MAPPING: () => typeof REVERSE_MODULE_MAPPING;
+        WiringReset: () => void;
+        WireService: typeof WireService;
+    }
+    interface ZCCDefinition {
+        /**
+         * In case something needs to grab details about the app
+         *
+         * Abnormal operation
+         */
+        application: ApplicationDefinition<ServiceMap, OptionalModuleConfiguration>;
+        safeExec: <LABELS extends BaseLabels>(options: (() => TBlackHole) | SafeExecOptions<LABELS>) => Promise<void>;
+    }
+}
+type SafeExecOptions<LABELS extends BaseLabels> = {
+    exec: () => TBlackHole;
+    labels: LABELS;
+    duration: Summary<Extract<keyof LABELS, string>>;
+    executions: Counter<Extract<keyof LABELS, string>>;
+    errors: Counter<Extract<keyof LABELS, string>>;
+};
+type BaseLabels = {
+    context: TContext;
+    /**
+     * ! if provided, specific metrics will be kept
+     *
+     * do not pass label if you do not want metrics to be kept, you may not want / need metrics to be kept on all instances
+     *
+     * - execution count
+     * - error count
+     * - summary of execution time
+     */
+    label?: string;
+};
+export {};