@deenruv/core 1.0.0

package/dist/config/logger/deenruv-logger.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = exports.LogLevel = void 0;
+/**
+ * @description
+ * An enum of valid logging levels.
+ *
+ * @docsCategory Logger
+ */
+var LogLevel;
+(function (LogLevel) {
+    /**
+     * @description
+     * Log Errors only. These are usually indicative of some potentially
+     * serious issue, so should be acted upon.
+     */
+    LogLevel[LogLevel["Error"] = 0] = "Error";
+    /**
+     * @description
+     * Warnings indicate that some situation may require investigation
+     * and handling. But not as serious as an Error.
+     */
+    LogLevel[LogLevel["Warn"] = 1] = "Warn";
+    /**
+     * @description
+     * Logs general information such as startup messages.
+     */
+    LogLevel[LogLevel["Info"] = 2] = "Info";
+    /**
+     * @description
+     * Logs additional information
+     */
+    LogLevel[LogLevel["Verbose"] = 3] = "Verbose";
+    /**
+     * @description
+     * Logs detailed info useful in debug scenarios, including stack traces for
+     * all errors. In production this would probably generate too much noise.
+     */
+    LogLevel[LogLevel["Debug"] = 4] = "Debug";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+const noopLogger = {
+    error() {
+        /* */
+    },
+    warn() {
+        /* */
+    },
+    info() {
+        /* */
+    },
+    verbose() {
+        /* */
+    },
+    debug() {
+        /* */
+    },
+};
+/**
+ * @description
+ * The Logger is responsible for all logging in a Deenruv application.
+ *
+ * It is intended to be used as a static class:
+ *
+ * @example
+ * ```ts
+ * import { Logger } from '\@deenruv/core';
+ *
+ * Logger.info(`Some log message`, 'My Deenruv Plugin');
+ * ```
+ *
+ * The actual implementation - where the logs are written to - is defined by the {@link DeenruvLogger}
+ * instance configured in the {@link DeenruvConfig}. By default, the {@link DefaultLogger} is used, which
+ * logs to the console.
+ *
+ * ## Implementing a custom logger
+ *
+ * A custom logger can be passed to the `logger` config option by creating a class which implements the
+ * {@link DeenruvLogger} interface. For example, here is how you might go about implementing a logger which
+ * logs to a file:
+ *
+ * @example
+ * ```ts
+ * import { DeenruvLogger } from '\@deenruv/core';
+ * import fs from 'fs';
+ *
+ * // A simple custom logger which writes all logs to a file.
+ * export class SimpleFileLogger implements DeenruvLogger {
+ *     private logfile: fs.WriteStream;
+ *
+ *     constructor(logfileLocation: string) {
+ *         this.logfile = fs.createWriteStream(logfileLocation, { flags: 'w' });
+ *     }
+ *
+ *     error(message: string, context?: string) {
+ *         this.logfile.write(`ERROR: [${context}] ${message}\n`);
+ *     }
+ *     warn(message: string, context?: string) {
+ *         this.logfile.write(`WARN: [${context}] ${message}\n`);
+ *     }
+ *     info(message: string, context?: string) {
+ *         this.logfile.write(`INFO: [${context}] ${message}\n`);
+ *     }
+ *     verbose(message: string, context?: string) {
+ *         this.logfile.write(`VERBOSE: [${context}] ${message}\n`);
+ *     }
+ *     debug(message: string, context?: string) {
+ *         this.logfile.write(`DEBUG: [${context}] ${message}\n`);
+ *     }
+ * }
+ *
+ * // in the DeenruvConfig
+ * export const config = {
+ *     // ...
+ *     logger: new SimpleFileLogger('server.log'),
+ * }
+ * ```
+ *
+ * @docsCategory Logger
+ */
+class Logger {
+    static get logger() {
+        return this._logger || noopLogger;
+    }
+    get instance() {
+        const { _instance } = Logger;
+        return _instance;
+    }
+    /** @internal */
+    static useLogger(logger) {
+        Logger._logger = logger;
+    }
+    /** @internal */
+    error(message, trace, context) {
+        this.instance.error(message, context, trace);
+    }
+    /** @internal */
+    warn(message, context) {
+        this.instance.warn(message, context);
+    }
+    /** @internal */
+    log(message, context) {
+        this.instance.info(message, context);
+    }
+    /** @internal */
+    verbose(message, context) {
+        this.instance.verbose(message, context);
+    }
+    /** @internal */
+    debug(message, context) {
+        this.instance.debug(message, context);
+    }
+    static error(message, context, trace) {
+        Logger.logger.error(message, context, trace);
+    }
+    static warn(message, context) {
+        Logger.logger.warn(message, context);
+    }
+    static info(message, context) {
+        Logger.logger.info(message, context);
+    }
+    static verbose(message, context) {
+        Logger.logger.verbose(message, context);
+    }
+    static debug(message, context) {
+        Logger.logger.debug(message, context);
+    }
+}
+exports.Logger = Logger;
+Logger._instance = Logger;
+//# sourceMappingURL=deenruv-logger.js.map

package/dist/config/logger/deenruv-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deenruv-logger.js","sourceRoot":"","sources":["../../../src/config/logger/deenruv-logger.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,IAAY,QA6BX;AA7BD,WAAY,QAAQ;IAClB;;;;OAIG;IACH,yCAAS,CAAA;IACT;;;;OAIG;IACH,uCAAQ,CAAA;IACR;;;OAGG;IACH,uCAAQ,CAAA;IACR;;;OAGG;IACH,6CAAW,CAAA;IACX;;;;OAIG;IACH,yCAAS,CAAA;AACX,CAAC,EA7BW,QAAQ,wBAAR,QAAQ,QA6BnB;AAkBD,MAAM,UAAU,GAAkB;IAChC,KAAK;QACH,KAAK;IACP,CAAC;IACD,IAAI;QACF,KAAK;IACP,CAAC;IACD,IAAI;QACF,KAAK;IACP,CAAC;IACD,OAAO;QACL,KAAK;IACP,CAAC;IACD,KAAK;QACH,KAAK;IACP,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,MAAa,MAAM;IAIjB,MAAM,KAAK,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,IAAI,UAAU,CAAC;IACpC,CAAC;IAED,IAAY,QAAQ;QAClB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,gBAAgB;IAChB,MAAM,CAAC,SAAS,CAAC,MAAqB;QACpC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,OAAY,EAAE,KAAc,EAAE,OAAgB;QAClD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED,gBAAgB;IAChB,IAAI,CAAC,OAAY,EAAE,OAAgB;QACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,gBAAgB;IAChB,GAAG,CAAC,OAAY,EAAE,OAAgB;QAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,gBAAgB;IAChB,OAAO,CAAC,OAAY,EAAE,OAAgB;QACpC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,OAAY,EAAE,OAAgB;QAClC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,OAAgB,EAAE,KAAc;QAC5D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,OAAgB;QAC3C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,OAAgB;QAC3C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,OAAe,EAAE,OAAgB;QAC9C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,OAAgB;QAC5C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;;AA7DH,wBA8DC;AA7DgB,gBAAS,GAAkB,MAAM,CAAC"}

package/dist/config/logger/default-logger.d.ts

@@ -0,0 +1,60 @@
+import { LogLevel, DeenruvLogger } from "./deenruv-logger";
+/**
+ * @description
+ * The default logger, which logs to the console (stdout) with optional timestamps. Since this logger is part of the
+ * default Deenruv configuration, you do not need to specify it explicitly in your server config. You would only need
+ * to specify it if you wish to change the log level (which defaults to `LogLevel.Info`) or remove the timestamp.
+ *
+ * @example
+ * ```ts
+ * import { DefaultLogger, LogLevel, DeenruvConfig } from '\@deenruv/core';
+ *
+ * export config: DeenruvConfig = {
+ *     // ...
+ *     logger: new DefaultLogger({ level: LogLevel.Debug, timestamp: false }),
+ * }
+ * ```
+ *
+ * @docsCategory Logger
+ */
+export declare class DefaultLogger implements DeenruvLogger {
+    /** @internal */
+    level: LogLevel;
+    private readonly timestamp;
+    private defaultContext;
+    private readonly localeStringOptions;
+    private static originalLogLevel;
+    constructor(options?: {
+        level?: LogLevel;
+        timestamp?: boolean;
+    });
+    /**
+     * @description
+     * A work-around to hide the info-level logs generated by Nest when bootstrapping the AppModule.
+     * To be run directly before the `NestFactory.create()` call in the `bootstrap()` function.
+     *
+     * See https://github.com/nestjs/nest/issues/1838
+     * @internal
+     */
+    static hideNestBootstrapLogs(): void;
+    /**
+     * @description
+     * If the log level was changed by `hideNestBootstrapLogs()`, this method will restore the
+     * original log level. To be run directly after the `NestFactory.create()` call in the
+     * `bootstrap()` function.
+     *
+     * See https://github.com/nestjs/nest/issues/1838
+     * @internal
+     */
+    static restoreOriginalLogLevel(): void;
+    setDefaultContext(defaultContext: string): void;
+    error(message: string, context?: string, trace?: string | undefined): void;
+    warn(message: string, context?: string): void;
+    info(message: string, context?: string): void;
+    verbose(message: string, context?: string): void;
+    debug(message: string, context?: string): void;
+    private logMessage;
+    private logContext;
+    private logTimestamp;
+    private ensureString;
+}

package/dist/config/logger/default-logger.js

@@ -0,0 +1,142 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultLogger = void 0;
+const picocolors_1 = __importDefault(require("picocolors"));
+const deenruv_logger_1 = require("./deenruv-logger");
+const DEFAULT_CONTEXT = "Deenruv Server";
+/**
+ * @description
+ * The default logger, which logs to the console (stdout) with optional timestamps. Since this logger is part of the
+ * default Deenruv configuration, you do not need to specify it explicitly in your server config. You would only need
+ * to specify it if you wish to change the log level (which defaults to `LogLevel.Info`) or remove the timestamp.
+ *
+ * @example
+ * ```ts
+ * import { DefaultLogger, LogLevel, DeenruvConfig } from '\@deenruv/core';
+ *
+ * export config: DeenruvConfig = {
+ *     // ...
+ *     logger: new DefaultLogger({ level: LogLevel.Debug, timestamp: false }),
+ * }
+ * ```
+ *
+ * @docsCategory Logger
+ */
+class DefaultLogger {
+    constructor(options) {
+        /** @internal */
+        this.level = deenruv_logger_1.LogLevel.Info;
+        this.defaultContext = DEFAULT_CONTEXT;
+        this.localeStringOptions = {
+            year: "2-digit",
+            hour: "numeric",
+            minute: "numeric",
+            day: "numeric",
+            month: "numeric",
+        };
+        this.level =
+            options && options.level != null ? options.level : deenruv_logger_1.LogLevel.Info;
+        this.timestamp =
+            options && options.timestamp !== undefined ? options.timestamp : true;
+    }
+    /**
+     * @description
+     * A work-around to hide the info-level logs generated by Nest when bootstrapping the AppModule.
+     * To be run directly before the `NestFactory.create()` call in the `bootstrap()` function.
+     *
+     * See https://github.com/nestjs/nest/issues/1838
+     * @internal
+     */
+    static hideNestBootstrapLogs() {
+        const { logger } = deenruv_logger_1.Logger;
+        if (logger instanceof DefaultLogger) {
+            if (logger.level === deenruv_logger_1.LogLevel.Info) {
+                this.originalLogLevel = deenruv_logger_1.LogLevel.Info;
+                logger.level = deenruv_logger_1.LogLevel.Warn;
+            }
+        }
+    }
+    /**
+     * @description
+     * If the log level was changed by `hideNestBootstrapLogs()`, this method will restore the
+     * original log level. To be run directly after the `NestFactory.create()` call in the
+     * `bootstrap()` function.
+     *
+     * See https://github.com/nestjs/nest/issues/1838
+     * @internal
+     */
+    static restoreOriginalLogLevel() {
+        const { logger } = deenruv_logger_1.Logger;
+        if (logger instanceof DefaultLogger &&
+            DefaultLogger.originalLogLevel !== undefined) {
+            logger.level = DefaultLogger.originalLogLevel;
+        }
+    }
+    setDefaultContext(defaultContext) {
+        this.defaultContext = defaultContext;
+    }
+    error(message, context, trace) {
+        if (context === "ExceptionsHandler" && this.level < deenruv_logger_1.LogLevel.Verbose) {
+            // In Nest v7, there is an ExternalExceptionFilter which catches *all*
+            // errors and logs them, no matter the LogLevel attached to the error.
+            // This results in overly-noisy logger output (e.g. a failed login attempt
+            // will log a full stack trace). This check means we only let it log if
+            // we are in Verbose or Debug mode.
+            return;
+        }
+        if (this.level >= deenruv_logger_1.LogLevel.Error) {
+            this.logMessage(picocolors_1.default.red("error"), picocolors_1.default.red(this.ensureString(message) + (trace ? `\n${trace}` : "")), context);
+        }
+    }
+    warn(message, context) {
+        if (this.level >= deenruv_logger_1.LogLevel.Warn) {
+            this.logMessage(picocolors_1.default.yellow("warn"), picocolors_1.default.yellow(this.ensureString(message)), context);
+        }
+    }
+    info(message, context) {
+        if (this.level >= deenruv_logger_1.LogLevel.Info) {
+            this.logMessage(picocolors_1.default.blue("info"), this.ensureString(message), context);
+        }
+    }
+    verbose(message, context) {
+        if (this.level >= deenruv_logger_1.LogLevel.Verbose) {
+            this.logMessage(picocolors_1.default.magenta("verbose"), this.ensureString(message), context);
+        }
+    }
+    debug(message, context) {
+        if (this.level >= deenruv_logger_1.LogLevel.Debug) {
+            this.logMessage(picocolors_1.default.magenta("debug"), this.ensureString(message), context);
+        }
+    }
+    logMessage(prefix, message, context) {
+        process.stdout.write([
+            prefix,
+            this.logTimestamp(),
+            this.logContext(context),
+            message,
+            "\n",
+        ].join(" "));
+    }
+    logContext(context) {
+        return picocolors_1.default.cyan(`[${context || this.defaultContext}]`);
+    }
+    logTimestamp() {
+        if (this.timestamp) {
+            const timestamp = new Date(Date.now()).toLocaleString(undefined, this.localeStringOptions);
+            return picocolors_1.default.gray(timestamp + " -");
+        }
+        else {
+            return "";
+        }
+    }
+    ensureString(message) {
+        return typeof message === "string"
+            ? message
+            : JSON.stringify(message, null, 2);
+    }
+}
+exports.DefaultLogger = DefaultLogger;
+//# sourceMappingURL=default-logger.js.map

package/dist/config/logger/default-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-logger.js","sourceRoot":"","sources":["../../../src/config/logger/default-logger.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA4B;AAE5B,qDAAmE;AAEnE,MAAM,eAAe,GAAG,gBAAgB,CAAC;AAEzC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,aAAa;IAcxB,YAAY,OAAmD;QAb/D,gBAAgB;QAChB,UAAK,GAAa,yBAAQ,CAAC,IAAI,CAAC;QAExB,mBAAc,GAAG,eAAe,CAAC;QACxB,wBAAmB,GAAG;YACrC,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,SAAS;YACjB,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,SAAS;SACR,CAAC;QAIT,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,yBAAQ,CAAC,IAAI,CAAC;QACnE,IAAI,CAAC,SAAS;YACZ,OAAO,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1E,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,qBAAqB;QAC1B,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAM,CAAC;QAC1B,IAAI,MAAM,YAAY,aAAa,EAAE,CAAC;YACpC,IAAI,MAAM,CAAC,KAAK,KAAK,yBAAQ,CAAC,IAAI,EAAE,CAAC;gBACnC,IAAI,CAAC,gBAAgB,GAAG,yBAAQ,CAAC,IAAI,CAAC;gBACtC,MAAM,CAAC,KAAK,GAAG,yBAAQ,CAAC,IAAI,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,uBAAuB;QAC5B,MAAM,EAAE,MAAM,EAAE,GAAG,uBAAM,CAAC;QAC1B,IACE,MAAM,YAAY,aAAa;YAC/B,aAAa,CAAC,gBAAgB,KAAK,SAAS,EAC5C,CAAC;YACD,MAAM,CAAC,KAAK,GAAG,aAAa,CAAC,gBAAgB,CAAC;QAChD,CAAC;IACH,CAAC;IAED,iBAAiB,CAAC,cAAsB;QACtC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,OAAgB,EAAE,KAA0B;QACjE,IAAI,OAAO,KAAK,mBAAmB,IAAI,IAAI,CAAC,KAAK,GAAG,yBAAQ,CAAC,OAAO,EAAE,CAAC;YACrE,sEAAsE;YACtE,sEAAsE;YACtE,0EAA0E;YAC1E,uEAAuE;YACvE,mCAAmC;YACnC,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,IAAI,yBAAQ,CAAC,KAAK,EAAE,CAAC;YACjC,IAAI,CAAC,UAAU,CACb,oBAAE,CAAC,GAAG,CAAC,OAAO,CAAC,EACf,oBAAE,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAChE,OAAO,CACR,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,CAAC,OAAe,EAAE,OAAgB;QACpC,IAAI,IAAI,CAAC,KAAK,IAAI,yBAAQ,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,UAAU,CACb,oBAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EACjB,oBAAE,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,EACrC,OAAO,CACR,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,CAAC,OAAe,EAAE,OAAgB;QACpC,IAAI,IAAI,CAAC,KAAK,IAAI,yBAAQ,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,oBAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IACD,OAAO,CAAC,OAAe,EAAE,OAAgB;QACvC,IAAI,IAAI,CAAC,KAAK,IAAI,yBAAQ,CAAC,OAAO,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,CACb,oBAAE,CAAC,OAAO,CAAC,SAAS,CAAC,EACrB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAC1B,OAAO,CACR,CAAC;QACJ,CAAC;IACH,CAAC;IACD,KAAK,CAAC,OAAe,EAAE,OAAgB;QACrC,IAAI,IAAI,CAAC,KAAK,IAAI,yBAAQ,CAAC,KAAK,EAAE,CAAC;YACjC,IAAI,CAAC,UAAU,CAAC,oBAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAEO,UAAU,CAAC,MAAc,EAAE,OAAe,EAAE,OAAgB;QAClE,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB;YACE,MAAM;YACN,IAAI,CAAC,YAAY,EAAE;YACnB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACxB,OAAO;YACP,IAAI;SACL,CAAC,IAAI,CAAC,GAAG,CAAC,CACZ,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,OAAgB;QACjC,OAAO,oBAAE,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;IACxD,CAAC;IAEO,YAAY;QAClB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,cAAc,CACnD,SAAS,EACT,IAAI,CAAC,mBAAmB,CACzB,CAAC;YACF,OAAO,oBAAE,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAEO,YAAY,CAAC,OAAgC;QACnD,OAAO,OAAO,OAAO,KAAK,QAAQ;YAChC,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvC,CAAC;CACF;AA7ID,sCA6IC"}

package/dist/config/logger/noop-logger.d.ts

@@ -0,0 +1,11 @@
+import { DeenruvLogger } from "./deenruv-logger";
+/**
+ * A logger that does not log.
+ */
+export declare class NoopLogger implements DeenruvLogger {
+    debug(message: string, context?: string): void;
+    error(message: string, context?: string, trace?: string): void;
+    info(message: string, context?: string): void;
+    verbose(message: string, context?: string): void;
+    warn(message: string, context?: string): void;
+}

package/dist/config/logger/noop-logger.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoopLogger = void 0;
+/**
+ * A logger that does not log.
+ */
+class NoopLogger {
+    debug(message, context) {
+        // noop!
+    }
+    error(message, context, trace) {
+        // noop!
+    }
+    info(message, context) {
+        // noop!
+    }
+    verbose(message, context) {
+        // noop!
+    }
+    warn(message, context) {
+        // noop!
+    }
+}
+exports.NoopLogger = NoopLogger;
+//# sourceMappingURL=noop-logger.js.map

package/dist/config/logger/noop-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noop-logger.js","sourceRoot":"","sources":["../../../src/config/logger/noop-logger.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,UAAU;IACrB,KAAK,CAAC,OAAe,EAAE,OAAgB;QACrC,QAAQ;IACV,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,OAAgB,EAAE,KAAc;QACrD,QAAQ;IACV,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,OAAgB;QACpC,QAAQ;IACV,CAAC;IAED,OAAO,CAAC,OAAe,EAAE,OAAgB;QACvC,QAAQ;IACV,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,OAAgB;QACpC,QAAQ;IACV,CAAC;CACF;AApBD,gCAoBC"}

package/dist/config/logger/typeorm-logger.d.ts

@@ -0,0 +1,22 @@
+import { Logger as TypeOrmLoggerInterface, QueryRunner } from "typeorm";
+import { LoggerOptions } from "typeorm/logger/LoggerOptions";
+/**
+ * A custom logger for TypeORM which delegates to the Deenruv Logger service.
+ */
+export declare class TypeOrmLogger implements TypeOrmLoggerInterface {
+    private options;
+    constructor(options?: LoggerOptions);
+    log(level: "log" | "info" | "warn", message: any, queryRunner?: QueryRunner): any;
+    logMigration(message: string, queryRunner?: QueryRunner): any;
+    logQuery(query: string, parameters?: any[], queryRunner?: QueryRunner): any;
+    logQueryError(error: string, query: string, parameters?: any[], queryRunner?: QueryRunner): any;
+    logQuerySlow(time: number, query: string, parameters?: any[], queryRunner?: QueryRunner): any;
+    logSchemaBuild(message: string, queryRunner?: QueryRunner): any;
+    private shouldDisplay;
+    private formatQueryWithParams;
+    /**
+     * Converts parameters to a string.
+     * Sometimes parameters can have circular objects and therefor we are handle this case too.
+     */
+    private stringifyParams;
+}

package/dist/config/logger/typeorm-logger.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeOrmLogger = void 0;
+const deenruv_logger_1 = require("./deenruv-logger");
+const context = "TypeORM";
+const defaultLoggerOptions = [
+    "error",
+    "warn",
+    "schema",
+    "migration",
+];
+/**
+ * A custom logger for TypeORM which delegates to the Deenruv Logger service.
+ */
+class TypeOrmLogger {
+    constructor(options = defaultLoggerOptions) {
+        this.options = options;
+    }
+    log(level, message, queryRunner) {
+        switch (level) {
+            case "info":
+                if (this.shouldDisplay("info")) {
+                    deenruv_logger_1.Logger.info(message, context);
+                }
+                break;
+            case "log":
+                if (this.shouldDisplay("log")) {
+                    deenruv_logger_1.Logger.info(message, context);
+                }
+                break;
+            case "warn":
+                if (this.shouldDisplay("warn")) {
+                    deenruv_logger_1.Logger.warn(message, context);
+                }
+                break;
+        }
+    }
+    logMigration(message, queryRunner) {
+        deenruv_logger_1.Logger.info(message, context);
+    }
+    logQuery(query, parameters, queryRunner) {
+        if (this.shouldDisplay("query")) {
+            const sql = this.formatQueryWithParams(query, parameters);
+            deenruv_logger_1.Logger.debug(`Query: ${sql}`, context);
+        }
+    }
+    logQueryError(error, query, parameters, queryRunner) {
+        if (this.shouldDisplay("error")) {
+            const sql = this.formatQueryWithParams(query, parameters);
+            deenruv_logger_1.Logger.error(`Query error: ${sql}`, context);
+            deenruv_logger_1.Logger.verbose(error, context);
+        }
+    }
+    logQuerySlow(time, query, parameters, queryRunner) {
+        const sql = this.formatQueryWithParams(query, parameters);
+        deenruv_logger_1.Logger.warn("Query is slow: " + sql);
+        deenruv_logger_1.Logger.warn("Execution time: " + time.toString());
+    }
+    logSchemaBuild(message, queryRunner) {
+        if (this.shouldDisplay("schema")) {
+            deenruv_logger_1.Logger.info(message, context);
+        }
+    }
+    shouldDisplay(logType) {
+        return (this.options === "all" ||
+            this.options === true ||
+            (Array.isArray(this.options) && this.options.includes(logType)));
+    }
+    formatQueryWithParams(query, parameters) {
+        return (query +
+            ((parameters === null || parameters === void 0 ? void 0 : parameters.length)
+                ? " -- PARAMETERS: " + this.stringifyParams(parameters).toString()
+                : ""));
+    }
+    /**
+     * Converts parameters to a string.
+     * Sometimes parameters can have circular objects and therefor we are handle this case too.
+     */
+    stringifyParams(parameters) {
+        try {
+            return JSON.stringify(parameters);
+        }
+        catch (error) {
+            // most probably circular objects in parameters
+            return parameters;
+        }
+    }
+}
+exports.TypeOrmLogger = TypeOrmLogger;
+//# sourceMappingURL=typeorm-logger.js.map

package/dist/config/logger/typeorm-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeorm-logger.js","sourceRoot":"","sources":["../../../src/config/logger/typeorm-logger.ts"],"names":[],"mappings":";;;AAGA,qDAA0C;AAE1C,MAAM,OAAO,GAAG,SAAS,CAAC;AAI1B,MAAM,oBAAoB,GAAkB;IAC1C,OAAO;IACP,MAAM;IACN,QAAQ;IACR,WAAW;CACZ,CAAC;AAEF;;GAEG;AACH,MAAa,aAAa;IACxB,YAAoB,UAAyB,oBAAoB;QAA7C,YAAO,GAAP,OAAO,CAAsC;IAAG,CAAC;IAErE,GAAG,CACD,KAA8B,EAC9B,OAAY,EACZ,WAAyB;QAEzB,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,MAAM;gBACT,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC/B,uBAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAChC,CAAC;gBACD,MAAM;YACR,KAAK,KAAK;gBACR,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC9B,uBAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAChC,CAAC;gBACD,MAAM;YACR,KAAK,MAAM;gBACT,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC/B,uBAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAChC,CAAC;gBACD,MAAM;QACV,CAAC;IACH,CAAC;IAED,YAAY,CAAC,OAAe,EAAE,WAAyB;QACrD,uBAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IAED,QAAQ,CAAC,KAAa,EAAE,UAAkB,EAAE,WAAyB;QACnE,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;YAC1D,uBAAM,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,aAAa,CACX,KAAa,EACb,KAAa,EACb,UAAkB,EAClB,WAAyB;QAEzB,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;YAC1D,uBAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,EAAE,OAAO,CAAC,CAAC;YAC7C,uBAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,YAAY,CACV,IAAY,EACZ,KAAa,EACb,UAAkB,EAClB,WAAyB;QAEzB,MAAM,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC1D,uBAAM,CAAC,IAAI,CAAC,iBAAiB,GAAG,GAAG,CAAC,CAAC;QACrC,uBAAM,CAAC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,cAAc,CAAC,OAAe,EAAE,WAAyB;QACvD,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,uBAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAEO,aAAa,CAAC,OAAwB;QAC5C,OAAO,CACL,IAAI,CAAC,OAAO,KAAK,KAAK;YACtB,IAAI,CAAC,OAAO,KAAK,IAAI;YACrB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAChE,CAAC;IACJ,CAAC;IAEO,qBAAqB,CAAC,KAAa,EAAE,UAAkB;QAC7D,OAAO,CACL,KAAK;YACL,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MAAM;gBACjB,CAAC,CAAC,kBAAkB,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;gBAClE,CAAC,CAAC,EAAE,CAAC,CACR,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,eAAe,CAAC,UAAiB;QACvC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,+CAA+C;YAC/C,OAAO,UAAU,CAAC;QACpB,CAAC;IACH,CAAC;CACF;AAjGD,sCAiGC"}

package/dist/config/merge-config.d.ts

@@ -0,0 +1,26 @@
+import { PartialDeenruvConfig, DeenruvConfig } from "./deenruv-config";
+/**
+ * @description
+ * Performs a deep merge of two DeenruvConfig objects. Unlike `Object.assign()` the `target` object is
+ * not mutated, instead the function returns a new object which is the result of deeply merging the
+ * values of `source` into `target`.
+ *
+ * Arrays do not get merged, they are treated as a single value that will be replaced. So if merging the
+ * `plugins` array, you must explicitly concatenate the array.
+ *
+ * @example
+ * ```ts
+ * const result = mergeConfig(defaultConfig, {
+ *   assetOptions: {
+ *     uploadMaxFileSize: 5000,
+ *   },
+ *   plugins: [
+ *     ...defaultConfig.plugins,
+ *     MyPlugin,
+ *   ]
+ * };
+ * ```
+ *
+ * @docsCategory configuration
+ */
+export declare function mergeConfig<T extends DeenruvConfig>(target: T, source: PartialDeenruvConfig, depth?: number): T;

package/dist/config/merge-config.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeConfig = void 0;
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const simple_deep_clone_1 = require("@deenruv/common/lib/simple-deep-clone");
+/**
+ * @description
+ * Performs a deep merge of two DeenruvConfig objects. Unlike `Object.assign()` the `target` object is
+ * not mutated, instead the function returns a new object which is the result of deeply merging the
+ * values of `source` into `target`.
+ *
+ * Arrays do not get merged, they are treated as a single value that will be replaced. So if merging the
+ * `plugins` array, you must explicitly concatenate the array.
+ *
+ * @example
+ * ```ts
+ * const result = mergeConfig(defaultConfig, {
+ *   assetOptions: {
+ *     uploadMaxFileSize: 5000,
+ *   },
+ *   plugins: [
+ *     ...defaultConfig.plugins,
+ *     MyPlugin,
+ *   ]
+ * };
+ * ```
+ *
+ * @docsCategory configuration
+ */
+function mergeConfig(target, source, depth = 0) {
+    if (!source) {
+        return target;
+    }
+    if (depth === 0) {
+        target = (0, simple_deep_clone_1.simpleDeepClone)(target);
+    }
+    if ((0, shared_utils_1.isObject)(target) && (0, shared_utils_1.isObject)(source)) {
+        for (const key in source) {
+            if ((0, shared_utils_1.isObject)(source[key])) {
+                if (!target[key]) {
+                    Object.assign(target, { [key]: {} });
+                }
+                if (!(0, shared_utils_1.isClassInstance)(source[key])) {
+                    mergeConfig(target[key], source[key], depth + 1);
+                }
+                else {
+                    target[key] = source[key];
+                }
+            }
+            else {
+                Object.assign(target, { [key]: source[key] });
+            }
+        }
+    }
+    return target;
+}
+exports.mergeConfig = mergeConfig;
+//# sourceMappingURL=merge-config.js.map

package/dist/config/merge-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge-config.js","sourceRoot":"","sources":["../../src/config/merge-config.ts"],"names":[],"mappings":";;;AAAA,mEAA6E;AAC7E,6EAAwE;AAIxE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,WAAW,CACzB,MAAS,EACT,MAA4B,EAC5B,KAAK,GAAG,CAAC;IAET,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,MAAM,GAAG,IAAA,mCAAe,EAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,IAAA,uBAAQ,EAAC,MAAM,CAAC,IAAI,IAAA,uBAAQ,EAAC,MAAM,CAAC,EAAE,CAAC;QACzC,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,IAAA,uBAAQ,EAAE,MAAc,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACnC,IAAI,CAAE,MAAc,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC1B,MAAM,CAAC,MAAM,CAAC,MAAa,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC9C,CAAC;gBACD,IAAI,CAAC,IAAA,8BAAe,EAAE,MAAc,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBAC3C,WAAW,CAAE,MAAc,CAAC,GAAG,CAAC,EAAG,MAAc,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;gBACrE,CAAC;qBAAM,CAAC;oBACL,MAAc,CAAC,GAAG,CAAC,GAAI,MAAc,CAAC,GAAG,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,EAAG,MAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AA9BD,kCA8BC"}