@digital-alchemy/core 0.1.0

package/dist/boilerplate/helpers/config-environment-loader.helper.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigLoaderEnvironment = void 0;
+const tslib_1 = require("tslib");
+const minimist_1 = tslib_1.__importDefault(require("minimist"));
+const object_path_1 = require("object-path");
+const __1 = require("../..");
+async function ConfigLoaderEnvironment({ configs, }) {
+    const environmentKeys = Object.keys(process.env);
+    const CLI_SWITCHES = (0, minimist_1.default)(process.argv);
+    const switchKeys = Object.keys(CLI_SWITCHES);
+    const out = {};
+    configs.forEach((configuration, project) => {
+        const cleanedProject = project.replaceAll("-", "_");
+        Object.keys(configuration).forEach(key => {
+            const noAppPath = `${cleanedProject}_${key}`;
+            const search = [noAppPath, key];
+            const configPath = `${project}.${key}`;
+            // Find an applicable switch
+            const flag = 
+            // Find an exact match (if available) first
+            search.find(line => switchKeys.includes(line)) ||
+                // Do case insensitive searches
+                search.find(line => {
+                    const match = new RegExp(`^${line.replaceAll(new RegExp("[-_]", "gi"), "[-_]?")}$`, "gi");
+                    return switchKeys.some(item => item.match(match));
+                });
+            if (flag) {
+                const formattedFlag = switchKeys.find(key => search.some(line => key.match(new RegExp(`^${line.replaceAll(new RegExp("[-_]", "gi"), "[-_]?")}$`, "gi"))));
+                if (__1.is.string(formattedFlag)) {
+                    (0, object_path_1.set)(out, configPath, CLI_SWITCHES[formattedFlag]);
+                }
+                return;
+            }
+            // Find an environment variable
+            const environment = 
+            // Find an exact match (if available) first
+            search.find(line => environmentKeys.includes(line)) ||
+                // Do case insensitive searches
+                search.find(line => {
+                    const match = new RegExp(`^${line.replaceAll(new RegExp("[-_]", "gi"), "[-_]?")}$`, "gi");
+                    return environmentKeys.some(item => item.match(match));
+                });
+            if (__1.is.empty(environment)) {
+                return;
+            }
+            const environmentName = environmentKeys.find(key => search.some(line => key.match(new RegExp(`^${line.replaceAll(new RegExp("[-_]", "gi"), "[-_]?")}$`, "gi"))));
+            if (__1.is.string(environmentName)) {
+                (0, object_path_1.set)(out, configPath, process.env[environmentName]);
+            }
+        });
+    });
+    return out;
+}
+exports.ConfigLoaderEnvironment = ConfigLoaderEnvironment;
+//# sourceMappingURL=config-environment-loader.helper.js.map

package/dist/boilerplate/helpers/config-environment-loader.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-environment-loader.helper.js","sourceRoot":"","sources":["../../../src/boilerplate/helpers/config-environment-loader.helper.ts"],"names":[],"mappings":";;;;AAAA,gEAAgC;AAChC,6CAAkC;AAElC,6BAA2B;AAOpB,KAAK,UAAU,uBAAuB,CAAC,EAC5C,OAAO,GACY;IACnB,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD,MAAM,YAAY,GAAG,IAAA,kBAAQ,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAE7C,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,OAAO,EAAE,EAAE;QACzC,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAEpD,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACvC,MAAM,SAAS,GAAG,GAAG,cAAc,IAAI,GAAG,EAAE,CAAC;YAC7C,MAAM,MAAM,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;YAChC,MAAM,UAAU,GAAG,GAAG,OAAO,IAAI,GAAG,EAAE,CAAC;YAEvC,4BAA4B;YAC5B,MAAM,IAAI;YACR,2CAA2C;YAC3C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC9C,+BAA+B;gBAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oBACjB,MAAM,KAAK,GAAG,IAAI,MAAM,CACtB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,EACzD,IAAI,CACL,CAAC;oBACF,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpD,CAAC,CAAC,CAAC;YACL,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAC1C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACjB,GAAG,CAAC,KAAK,CACP,IAAI,MAAM,CACR,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,EACzD,IAAI,CACL,CACF,CACF,CACF,CAAC;gBACF,IAAI,MAAE,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;oBAC7B,IAAA,iBAAG,EAAC,GAAG,EAAE,UAAU,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;gBACpD,CAAC;gBACD,OAAO;YACT,CAAC;YACD,+BAA+B;YAC/B,MAAM,WAAW;YACf,2CAA2C;YAC3C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACnD,+BAA+B;gBAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oBACjB,MAAM,KAAK,GAAG,IAAI,MAAM,CACtB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,EACzD,IAAI,CACL,CAAC;oBACF,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;gBACzD,CAAC,CAAC,CAAC;YACL,IAAI,MAAE,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC1B,OAAO;YACT,CAAC;YACD,MAAM,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACjD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACjB,GAAG,CAAC,KAAK,CACP,IAAI,MAAM,CACR,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,EACzD,IAAI,CACL,CACF,CACF,CACF,CAAC;YACF,IAAI,MAAE,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;gBAC/B,IAAA,iBAAG,EAAC,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AA3ED,0DA2EC"}

package/dist/boilerplate/helpers/config-file-loader.helper.d.ts

@@ -0,0 +1,4 @@
+import { ConfigLoaderParams, ConfigLoaderReturn } from "./config.helper";
+export declare const SUPPORTED_CONFIG_EXTENSIONS: string[];
+export declare function configFilePaths(name?: string): string[];
+export declare function ConfigLoaderFile({ application, }: ConfigLoaderParams): ConfigLoaderReturn;

package/dist/boilerplate/helpers/config-file-loader.helper.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigLoaderFile = exports.configFilePaths = exports.SUPPORTED_CONFIG_EXTENSIONS = void 0;
+const fs_1 = require("fs");
+const ini_1 = require("ini");
+const js_yaml_1 = require("js-yaml");
+const os_1 = require("os");
+const path_1 = require("path");
+const process_1 = require("process");
+const __1 = require("../..");
+const isWindows = process_1.platform === "win32";
+exports.SUPPORTED_CONFIG_EXTENSIONS = ["json", "ini", "yaml", "yml"];
+function withExtensions(path) {
+    return [path, ...exports.SUPPORTED_CONFIG_EXTENSIONS.map(i => `${path}.${i}`)];
+}
+function configFilePaths(name = "digital-alchemy") {
+    const out = [];
+    if (!isWindows) {
+        out.push(...withExtensions((0, path_1.join)(`/etc`, name, "config")), ...withExtensions((0, path_1.join)(`/etc`, `${name}`)));
+    }
+    let current = (0, process_1.cwd)();
+    let next;
+    while (!__1.is.empty(current)) {
+        out.push((0, path_1.join)(current, `.${name}`), ...withExtensions(current));
+        next = (0, path_1.join)(current, "..");
+        if (next === current) {
+            break;
+        }
+        current = next;
+    }
+    out.push(...withExtensions((0, path_1.join)((0, os_1.homedir)(), ".config", name)), ...withExtensions((0, path_1.join)((0, os_1.homedir)(), ".config", name, "config")));
+    return out;
+}
+exports.configFilePaths = configFilePaths;
+async function ConfigLoaderFile({ application, }) {
+    const files = configFilePaths(application.name);
+    const out = {};
+    files.forEach(file => loadConfigFromFile(out, file));
+    return out;
+}
+exports.ConfigLoaderFile = ConfigLoaderFile;
+function loadConfigFromFile(out, filePath) {
+    if (!(0, fs_1.existsSync)(filePath) || !(0, fs_1.statSync)(filePath).isFile()) {
+        return;
+    }
+    const fileContent = (0, fs_1.readFileSync)(filePath, "utf8").trim();
+    const hasExtension = exports.SUPPORTED_CONFIG_EXTENSIONS.some(extension => {
+        if (filePath.slice(extension.length * __1.INVERT_VALUE).toLowerCase() ===
+            extension) {
+            switch (extension) {
+                case "ini":
+                    (0, __1.deepExtend)(out, (0, ini_1.decode)(fileContent));
+                    return true;
+                case "yaml":
+                case "yml":
+                    (0, __1.deepExtend)(out, (0, js_yaml_1.load)(fileContent));
+                    return true;
+                case "json":
+                    (0, __1.deepExtend)(out, JSON.parse(fileContent));
+                    return true;
+            }
+        }
+        return false;
+    });
+    if (hasExtension) {
+        return;
+    }
+    // Guessing JSON
+    if (fileContent[__1.START] === "{") {
+        (0, __1.deepExtend)(out, JSON.parse(fileContent));
+        return;
+    }
+    // Guessing yaml
+    try {
+        const content = (0, js_yaml_1.load)(fileContent);
+        if (__1.is.object(content)) {
+            (0, __1.deepExtend)(out, content);
+            return;
+        }
+    }
+    catch {
+        // Is not a yaml file
+    }
+    // Final fallback: INI
+    (0, __1.deepExtend)(out, (0, ini_1.decode)(fileContent));
+}
+//# sourceMappingURL=config-file-loader.helper.js.map

package/dist/boilerplate/helpers/config-file-loader.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-file-loader.helper.js","sourceRoot":"","sources":["../../../src/boilerplate/helpers/config-file-loader.helper.ts"],"names":[],"mappings":";;;AAAA,2BAAwD;AACxD,6BAA6B;AAC7B,qCAA+B;AAC/B,2BAA6B;AAC7B,+BAA4B;AAC5B,qCAAwC;AAExC,6BAA4D;AAO5D,MAAM,SAAS,GAAG,kBAAQ,KAAK,OAAO,CAAC;AAE1B,QAAA,2BAA2B,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAC1E,SAAS,cAAc,CAAC,IAAY;IAClC,OAAO,CAAC,IAAI,EAAE,GAAG,mCAA2B,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,SAAgB,eAAe,CAAC,IAAI,GAAG,iBAAiB;IACtD,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,GAAG,CAAC,IAAI,CACN,GAAG,cAAc,CAAC,IAAA,WAAI,EAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,EAC/C,GAAG,cAAc,CAAC,IAAA,WAAI,EAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,CAC3C,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,GAAG,IAAA,aAAG,GAAE,CAAC;IACpB,IAAI,IAAY,CAAC;IACjB,OAAO,CAAC,MAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1B,GAAG,CAAC,IAAI,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QAChE,IAAI,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3B,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YACrB,MAAM;QACR,CAAC;QACD,OAAO,GAAG,IAAI,CAAC;IACjB,CAAC;IACD,GAAG,CAAC,IAAI,CACN,GAAG,cAAc,CAAC,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,EACnD,GAAG,cAAc,CAAC,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAC9D,CAAC;IACF,OAAO,GAAG,CAAC;AACb,CAAC;AAvBD,0CAuBC;AAEM,KAAK,UAAU,gBAAgB,CAAC,EACrC,WAAW,GACQ;IACnB,MAAM,KAAK,GAAG,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IACrD,OAAO,GAAG,CAAC;AACb,CAAC;AAPD,4CAOC;AAED,SAAS,kBAAkB,CAAC,GAA4B,EAAE,QAAgB;IACxE,IAAI,CAAC,IAAA,eAAU,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAA,aAAQ,EAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QAC1D,OAAO;IACT,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,iBAAY,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;IAC1D,MAAM,YAAY,GAAG,mCAA2B,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QAChE,IACE,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,gBAAY,CAAC,CAAC,WAAW,EAAE;YAC7D,SAAS,EACT,CAAC;YACD,QAAQ,SAAS,EAAE,CAAC;gBAClB,KAAK,KAAK;oBACR,IAAA,cAAU,EAAC,GAAG,EAAE,IAAA,YAAM,EAAC,WAAW,CAA8B,CAAC,CAAC;oBAClE,OAAO,IAAI,CAAC;gBACd,KAAK,MAAM,CAAC;gBACZ,KAAK,KAAK;oBACR,IAAA,cAAU,EAAC,GAAG,EAAE,IAAA,cAAI,EAAC,WAAW,CAAmB,CAAC,CAAC;oBACrD,OAAO,IAAI,CAAC;gBACd,KAAK,MAAM;oBACT,IAAA,cAAU,EAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAA8B,CAAC,CAAC;oBACtE,OAAO,IAAI,CAAC;YAChB,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;IACH,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO;IACT,CAAC;IACD,gBAAgB;IAChB,IAAI,WAAW,CAAC,SAAK,CAAC,KAAK,GAAG,EAAE,CAAC;QAC/B,IAAA,cAAU,EAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAA8B,CAAC,CAAC;QACtE,OAAO;IACT,CAAC;IACD,gBAAgB;IAChB,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAA,cAAI,EAAC,WAAW,CAAC,CAAC;QAClC,IAAI,MAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,IAAA,cAAU,EAAC,GAAG,EAAE,OAAoC,CAAC,CAAC;YACtD,OAAO;QACT,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,qBAAqB;IACvB,CAAC;IACD,sBAAsB;IACtB,IAAA,cAAU,EAAC,GAAG,EAAE,IAAA,YAAM,EAAC,WAAW,CAA8B,CAAC,CAAC;AACpE,CAAC"}

package/dist/boilerplate/helpers/config.helper.d.ts

@@ -0,0 +1,102 @@
+import { ApplicationDefinition, ServiceMap } from "./wiring.helper";
+export type CodeConfigDefinition = Record<string, AnyConfig>;
+export type ZccConfigTypes = "string" | "boolean" | "internal" | "number" | "record" | "string[]";
+export type AnyConfig = StringConfig<string> | BooleanConfig | InternalConfig<unknown> | NumberConfig | RecordConfig | StringArrayConfig;
+export interface BaseConfig {
+    /**
+     * If no other values are provided, what value should be injected?
+     * This ensures a value is always provided, and checks for undefined don't need to happen
+     */
+    default?: unknown;
+    /**
+     * Short descriptive text so humans can understand why this exists.
+     */
+    description?: string | string[];
+    /**
+     * Refuse to boot if user provided value is still undefined by `onPostConfig` lifecycle event
+     */
+    required?: boolean;
+    type: ZccConfigTypes;
+}
+export type KnownConfigs = Map<string, CodeConfigDefinition>;
+export interface StringConfig<STRING extends string> extends BaseConfig {
+    default?: STRING;
+    /**
+     * If provided, the value **MUST** appear in this list or the application will refuse to boot.
+     */
+    enum?: STRING[];
+    type: "string";
+}
+export interface BooleanConfig extends BaseConfig {
+    default?: boolean;
+    type: "boolean";
+}
+/**
+ * For configurations that just can't be expressed any other way.
+ * Make sure to add a helpful description on how to format the value,
+ * because `config-builder` won't be able to help.
+ *
+ * This can be used to take in a complex json object, and forward the information to another library.
+ *
+ * TODO: JSON schema magic for validation / maybe config builder help
+ */
+export type InternalConfig<VALUE extends unknown> = BaseConfig & {
+    default: VALUE;
+    type: "internal";
+};
+export interface NumberConfig extends BaseConfig {
+    default?: number;
+    type: "number";
+}
+/**
+ * key/value pairs
+ */
+export interface RecordConfig extends BaseConfig {
+    type: "record";
+}
+export interface StringArrayConfig extends BaseConfig {
+    default?: string[];
+    type: "string[]";
+}
+/**
+ * Used with config scanner
+ */
+export interface ConfigDefinitionDTO {
+    application: string;
+    bootstrapOverrides?: AbstractConfig;
+    config: ConfigTypeDTO[];
+}
+export interface ConfigTypeDTO<METADATA extends AnyConfig = AnyConfig> {
+    /**
+     * Name of project
+     */
+    library: string;
+    /**
+     * Description of a single config item as passed into the module
+     */
+    metadata: METADATA;
+    /**
+     * Property name
+     */
+    property: string;
+}
+/**
+ * Top level configuration object
+ *
+ * Extends the global common config, adding a section for the top level application to chuck in data without affecting things
+ * Also provides dedicated sections for libraries to store their own configuration options
+ */
+export interface AbstractConfig {
+}
+export type ConfigLoaderReturn = Promise<Partial<AbstractConfig>>;
+export type ConfigLoaderParams<S extends ServiceMap = ServiceMap, C extends OptionalModuleConfiguration = OptionalModuleConfiguration> = {
+    application: ApplicationDefinition<S, C>;
+    configs: KnownConfigs;
+};
+export type ConfigLoaderMethod = <S extends ServiceMap, C extends OptionalModuleConfiguration>(params: ConfigLoaderParams<S, C>) => ConfigLoaderReturn;
+export type ConfigLoader = [loader: ConfigLoaderMethod, priority: number];
+export declare function cast<T = unknown>(data: string | string[], type: string): T;
+export type ModuleConfiguration = {
+    [key: string]: AnyConfig;
+};
+export type OptionalModuleConfiguration = ModuleConfiguration | undefined;

package/dist/boilerplate/helpers/config.helper.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cast = void 0;
+const __1 = require("../..");
+function cast(data, type) {
+    switch (type) {
+        case "boolean": {
+            data ??= "";
+            return (__1.is.boolean(data)
+                ? data
+                : ["true", "y", "1"].includes(data.toLowerCase()));
+        }
+        case "number":
+            return Number(data);
+        case "string[]":
+            if (__1.is.undefined(data)) {
+                return [];
+            }
+            if (__1.is.array(data)) {
+                return data.map(String);
+            }
+            // This occurs with cli switches
+            // If only 1 is passed, it'll get the value
+            // ex: --foo=bar  ==== {foo:'bar'}
+            // If duplicates are passed, will receive array
+            // ex: --foo=bar --foo=baz === {foo:['bar','baz']}
+            return [String(data)];
+    }
+    return data;
+}
+exports.cast = cast;
+//# sourceMappingURL=config.helper.js.map

package/dist/boilerplate/helpers/config.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.helper.js","sourceRoot":"","sources":["../../../src/boilerplate/helpers/config.helper.ts"],"names":[],"mappings":";;;AAAA,6BAA2B;AAmI3B,SAAgB,IAAI,CAAc,IAAuB,EAAE,IAAY;IACrE,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,IAAI,KAAK,EAAE,CAAC;YACZ,OAAO,CACL,MAAE,CAAC,OAAO,CAAC,IAAI,CAAC;gBACd,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAE,IAAe,CAAC,WAAW,EAAE,CAAC,CAC3D,CAAC;QACT,CAAC;QACD,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC,IAAI,CAAM,CAAC;QAC3B,KAAK,UAAU;YACb,IAAI,MAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvB,OAAO,EAAO,CAAC;YACjB,CAAC;YACD,IAAI,MAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAM,CAAC;YAC/B,CAAC;YACD,gCAAgC;YAChC,2CAA2C;YAC3C,kCAAkC;YAClC,+CAA+C;YAC/C,kDAAkD;YAClD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAM,CAAC;IAC/B,CAAC;IACD,OAAO,IAAS,CAAC;AACnB,CAAC;AA3BD,oBA2BC"}

package/dist/boilerplate/helpers/errors.helper.d.ts

@@ -0,0 +1,39 @@
+import { TContext } from "../..";
+export type MaybeHttpError = {
+    error: string;
+    message: string;
+    statusCode: number;
+};
+export declare class BootstrapException extends Error {
+    context: TContext;
+    cause: string;
+    timestamp: Date;
+    constructor(context: TContext, cause: string, message: string);
+}
+export declare class InternalError extends Error {
+    context: TContext;
+    cause: string;
+    timestamp: Date;
+    constructor(context: TContext, cause: string, message: string);
+}
+export declare class FetchRequestError extends Error {
+    statusCode: number;
+    error: string;
+    timestamp: Date;
+    constructor(statusCode: number, error: string, message: string);
+}
+export declare class CacheError extends Error {
+    context: TContext;
+    timestamp: Date;
+    constructor(context: TContext, message: string);
+}
+export declare class ConfigError extends Error {
+    context: TContext;
+    timestamp: Date;
+    constructor(context: TContext, message: string);
+}
+export declare class CronError extends Error {
+    context: TContext;
+    timestamp: Date;
+    constructor(context: TContext, message: string);
+}

package/dist/boilerplate/helpers/errors.helper.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CronError = exports.ConfigError = exports.CacheError = exports.FetchRequestError = exports.InternalError = exports.BootstrapException = void 0;
+class BootstrapException extends Error {
+    context;
+    cause;
+    timestamp;
+    constructor(context, cause, message) {
+        super(`[BootstrapException] Context: ${context}, Cause: ${cause}, Message: ${message} | Timestamp: ${new Date().toISOString()}`);
+        this.name = "BootstrapException";
+        this.context = context;
+        this.cause = cause;
+        this.timestamp = new Date();
+    }
+}
+exports.BootstrapException = BootstrapException;
+class InternalError extends Error {
+    context;
+    cause;
+    timestamp;
+    constructor(context, cause, message) {
+        super(`[InternalError] Context: ${context}, Cause: ${cause}, Message: ${message} | Timestamp: ${new Date().toISOString()}`);
+        this.name = "InternalError";
+        this.context = context;
+        this.cause = cause;
+        this.timestamp = new Date();
+    }
+}
+exports.InternalError = InternalError;
+class FetchRequestError extends Error {
+    statusCode;
+    error;
+    timestamp;
+    constructor(statusCode, error, message) {
+        super(`[FetchRequestError - ${statusCode}] Error: ${error}, Message: ${message} | Timestamp: ${new Date().toISOString()}`);
+        this.name = "FetchRequestError";
+        this.statusCode = statusCode;
+        this.error = error;
+        this.timestamp = new Date();
+    }
+}
+exports.FetchRequestError = FetchRequestError;
+class CacheError extends Error {
+    context;
+    timestamp;
+    constructor(context, message) {
+        super(`[CacheError] Context: ${context}, Message: ${message} | Timestamp: ${new Date().toISOString()}`);
+        this.name = "CacheError";
+        this.context = context;
+        this.timestamp = new Date();
+    }
+}
+exports.CacheError = CacheError;
+class ConfigError extends Error {
+    context;
+    timestamp;
+    constructor(context, message) {
+        super(`[ConfigError] Context: ${context}, Message: ${message} | Timestamp: ${new Date().toISOString()}`);
+        this.name = "ConfigError";
+        this.context = context;
+        this.timestamp = new Date();
+    }
+}
+exports.ConfigError = ConfigError;
+class CronError extends Error {
+    context;
+    timestamp;
+    constructor(context, message) {
+        super(`[CronError] Context: ${context}, Message: ${message} | Timestamp: ${new Date().toISOString()}`);
+        this.name = "CronError";
+        this.context = context;
+        this.timestamp = new Date();
+    }
+}
+exports.CronError = CronError;
+//# sourceMappingURL=errors.helper.js.map

package/dist/boilerplate/helpers/errors.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.helper.js","sourceRoot":"","sources":["../../../src/boilerplate/helpers/errors.helper.ts"],"names":[],"mappings":";;;AAQA,MAAa,kBAAmB,SAAQ,KAAK;IAC3C,OAAO,CAAW;IACT,KAAK,CAAS;IACvB,SAAS,CAAO;IAEhB,YAAY,OAAiB,EAAE,KAAa,EAAE,OAAe;QAC3D,KAAK,CACH,iCAAiC,OAAO,YAAY,KAAK,cAAc,OAAO,iBAAiB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAC1H,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;CACF;AAdD,gDAcC;AAED,MAAa,aAAc,SAAQ,KAAK;IACtC,OAAO,CAAW;IACT,KAAK,CAAS;IACvB,SAAS,CAAO;IAEhB,YAAY,OAAiB,EAAE,KAAa,EAAE,OAAe;QAC3D,KAAK,CACH,4BAA4B,OAAO,YAAY,KAAK,cAAc,OAAO,iBAAiB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CACrH,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;CACF;AAdD,sCAcC;AAED,MAAa,iBAAkB,SAAQ,KAAK;IAC1C,UAAU,CAAS;IACnB,KAAK,CAAS;IACd,SAAS,CAAO;IAEhB,YAAY,UAAkB,EAAE,KAAa,EAAE,OAAe;QAC5D,KAAK,CACH,wBAAwB,UAAU,YAAY,KAAK,cAAc,OAAO,iBAAiB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CACpH,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;CACF;AAdD,8CAcC;AAED,MAAa,UAAW,SAAQ,KAAK;IACnC,OAAO,CAAW;IAClB,SAAS,CAAO;IAEhB,YAAY,OAAiB,EAAE,OAAe;QAC5C,KAAK,CACH,yBAAyB,OAAO,cAAc,OAAO,iBAAiB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CACjG,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;CACF;AAZD,gCAYC;AAED,MAAa,WAAY,SAAQ,KAAK;IACpC,OAAO,CAAW;IAClB,SAAS,CAAO;IAEhB,YAAY,OAAiB,EAAE,OAAe;QAC5C,KAAK,CACH,0BAA0B,OAAO,cAAc,OAAO,iBAAiB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAClG,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;CACF;AAZD,kCAYC;AAED,MAAa,SAAU,SAAQ,KAAK;IAClC,OAAO,CAAW;IAClB,SAAS,CAAO;IAEhB,YAAY,OAAiB,EAAE,OAAe;QAC5C,KAAK,CACH,wBAAwB,OAAO,cAAc,OAAO,iBAAiB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAChG,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;CACF;AAZD,8BAYC"}

package/dist/boilerplate/helpers/events.helper.d.ts

@@ -0,0 +1,3 @@
+export declare const DIGITAL_ALCHEMY_NODE_GLOBAL_ERROR = "DIGITAL_ALCHEMY_NODE_GLOBAL_ERROR";
+export declare const DIGITAL_ALCHEMY_APPLICATION_ERROR = "DIGITAL_ALCHEMY_APPLICATION_ERROR";
+export declare const DIGITAL_ALCHEMY_LIBRARY_ERROR: (library?: string) => string;

package/dist/boilerplate/helpers/events.helper.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DIGITAL_ALCHEMY_LIBRARY_ERROR = exports.DIGITAL_ALCHEMY_APPLICATION_ERROR = exports.DIGITAL_ALCHEMY_NODE_GLOBAL_ERROR = void 0;
+const __1 = require("../..");
+exports.DIGITAL_ALCHEMY_NODE_GLOBAL_ERROR = "DIGITAL_ALCHEMY_NODE_GLOBAL_ERROR";
+exports.DIGITAL_ALCHEMY_APPLICATION_ERROR = "DIGITAL_ALCHEMY_APPLICATION_ERROR";
+const DIGITAL_ALCHEMY_LIBRARY_ERROR = (library) => __1.is.empty(library)
+    ? "DIGITAL_ALCHEMY_LIBRARY_ERROR"
+    : `DIGITAL_ALCHEMY_LIBRARY_ERROR:${library}`;
+exports.DIGITAL_ALCHEMY_LIBRARY_ERROR = DIGITAL_ALCHEMY_LIBRARY_ERROR;
+//# sourceMappingURL=events.helper.js.map

package/dist/boilerplate/helpers/events.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.helper.js","sourceRoot":"","sources":["../../../src/boilerplate/helpers/events.helper.ts"],"names":[],"mappings":";;;AAAA,6BAA2B;AAEd,QAAA,iCAAiC,GAC5C,mCAAmC,CAAC;AACzB,QAAA,iCAAiC,GAC5C,mCAAmC,CAAC;AAC/B,MAAM,6BAA6B,GAAG,CAAC,OAAgB,EAAE,EAAE,CAChE,MAAE,CAAC,KAAK,CAAC,OAAO,CAAC;IACf,CAAC,CAAC,+BAA+B;IACjC,CAAC,CAAC,iCAAiC,OAAO,EAAE,CAAC;AAHpC,QAAA,6BAA6B,iCAGO"}

package/dist/boilerplate/helpers/fetch.helper.d.ts

@@ -0,0 +1,170 @@
+import Bottleneck from "bottleneck";
+import { MergeExclusive } from "type-fest";
+import { TContext } from "../..";
+/**
+ * Defines the types of parameters that can be used in fetch requests.
+ */
+export type FetchParameterTypes = string | boolean | Date | number | Array<string | Date | number>;
+/**
+ * Enumerates HTTP methods used in fetch requests.
+ */
+export declare enum HTTP_METHODS {
+    get = "get",
+    delete = "delete",
+    put = "put",
+    patch = "patch",
+    post = "post"
+}
+type NoBodyMethods = "get" | "delete";
+type BodyMethods = "put" | "patch" | "post";
+/**
+ * Represents a fetch request with additional properties and body content.
+ */
+export type FetchWith<EXTRA extends Record<never, string> = Record<never, string>, BODY extends TFetchBody = undefined> = Partial<FetchArguments<BODY>> & EXTRA;
+export type FetchProcessTypes = boolean | "text" | "json" | "raw" | undefined;
+type BaseFetchArguments = {
+    /**
+     * Headers to append
+     */
+    headers?: Record<string, string>;
+    /**
+     * Query params to send
+     */
+    params?: Record<string, FetchParameterTypes>;
+    /**
+     * Built in post-processing
+     *
+     * - true / "json" = attempt to decode as json
+     * - false / "raw" = return the node-fetch response object without processing
+     * - "text" = return result as text, no additional processing
+     *
+     * ? boolean values are deprecated
+     */
+    process?: FetchProcessTypes;
+    /**
+     * If provided, metrics will be kept for this request, and associated with labels
+     */
+    label?: string;
+    /**
+     * Defaults to global fetch context
+     */
+    context?: TContext;
+};
+type BaseFetchUrl = {
+    /**
+     * URL to send request to
+     */
+    url: string;
+} & MergeExclusive<{
+    /**
+     * Frequently filled in by wrapper services
+     */
+    baseUrl?: string;
+}, {
+    /**
+     * URL is the full path (includes http://...)
+     *
+     * Ignores baseUrl if set
+     */
+    rawUrl?: boolean;
+}>;
+type BaseFetchBody<BODY extends TFetchBody = undefined> = MergeExclusive<{
+    /**
+     * POSTDATA
+     */
+    body?: BODY;
+    /**
+     * HTTP method
+     */
+    method: BodyMethods;
+}, {
+    /**
+     * HTTP method
+     */
+    method?: NoBodyMethods;
+}>;
+/**
+ * Defines the structure and types for arguments passed to fetch requests.
+ */
+export type FetchArguments<BODY extends TFetchBody = undefined> = BaseFetchUrl & BaseFetchArguments & BaseFetchBody<BODY>;
+/**
+ * Represents a subset of FetchArguments for specific use cases.
+ */
+export type FilteredFetchArguments<BODY extends TFetchBody = undefined> = BaseFetchBody<BODY> & Pick<BaseFetchUrl, "url"> & Pick<BaseFetchArguments, "process" | "params">;
+/**
+ * Same thing as FetchWith, but the function doesn't need any args
+ *
+ * This is a work around, for some reason the default value approach isn't work as I had hoped
+ */
+export type BaseFetch = Partial<FetchArguments>;
+/**
+ * Defines the types of values that can be used in filter operations.
+ */
+export type FilterValueType = string | boolean | number | Date | RegExp | unknown | Record<string, string>;
+/**
+ * Enumerates the types of operations available for data filtering.
+ */
+export declare enum FILTER_OPERATIONS {
+    elem = "elem",
+    regex = "regex",
+    in = "in",
+    nin = "nin",
+    lt = "lt",
+    lte = "lte",
+    gt = "gt",
+    gte = "gte",
+    exists = "exists",
+    empty = "empty",
+    ne = "ne",
+    eq = "eq"
+}
+export interface ComparisonDTO {
+    operation?: FILTER_OPERATIONS | `${FILTER_OPERATIONS}`;
+    value?: FilterValueType | FilterValueType[];
+}
+export interface Filter<FIELDS = string> extends ComparisonDTO {
+    empty?: boolean;
+    exists?: boolean;
+    field?: FIELDS;
+}
+export interface ResultControl {
+    filters?: Set<Filter>;
+    limit?: number;
+    select?: string[];
+    skip?: number;
+    sort?: string[];
+}
+export declare function controlToQuery(value: Readonly<ResultControl>): Record<string, string>;
+export declare function buildFilter(key: string, value: FilterValueType | FilterValueType[]): Filter;
+export declare function queryToControl(value: Readonly<Record<string, string>>): ResultControl;
+/**
+ * Properties that alter the way that fetcher works.
+ */
+export type FetcherOptions = {
+    /**
+     * typically domain names with scheme, added to the front of urls if the individual request doesn't override
+     */
+    baseUrl?: string;
+    /**
+     * if provided, then requests will be rate limited via the bottleneck library
+     */
+    bottleneck?: Bottleneck.ConstructorOptions;
+    /**
+     * merged into every request
+     */
+    headers?: Record<string, string>;
+    /**
+     * Alter the context attached to the log statements emitted from the fetcher
+     */
+    context?: TContext;
+};
+export type DownloadOptions<BODY extends TFetchBody = undefined> = Partial<FetchArguments<BODY>> & {
+    destination: string;
+};
+export declare function fetchCast(item: FetchParameterTypes): string;
+export type TFetchBody = object | undefined;
+export declare function buildFilterString(fetchWith: FetchWith<{
+    filters?: Readonly<ResultControl>;
+    params?: Record<string, FetchParameterTypes>;
+}>): string;
+export {};