@proteinjs/logger 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.3](https://github.com/proteinjs/util/compare/@proteinjs/logger@1.0.2...@proteinjs/logger@1.0.3) (2024-08-13)
+
+
+### Bug Fixes
+
+* `Logger` now queries the `SourceRepository` for a `DefaultLogWriter` lazily. This way, if a `Logger` happens to be instantiated outside of a function or class, it will still be able to get the `DefaultLogWriter` if logging is done within a function or class. ([f9e0e90](https://github.com/proteinjs/util/commit/f9e0e9008e8f13543adef27500142b91bc959c5f))
+
+
+
+
+
+## [1.0.2](https://github.com/proteinjs/util/compare/@proteinjs/logger@1.0.1...@proteinjs/logger@1.0.2) (2024-08-13)
+
+
+### Bug Fixes
+
+* `Logger` constructor arg now optional ([c85e337](https://github.com/proteinjs/util/commit/c85e3375d6a299d3d0b72fb0ba6d058e7798ab79))
+
+
+
+
+
 ## 1.0.1 (2024-08-13)
 
 **Note:** Version bump only for package @proteinjs/logger

package/dist/generated/index.js

@@ -17,7 +17,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 require("@proteinjs/reflection");
 /** Generate Source Graph */
-const sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"/'debug' | 'info' | 'warn' | 'error'\"},{\"v\":\"@proteinjs/logger/LogWriter\",\"value\":{\"packageName\":\"@proteinjs/logger\",\"name\":\"LogWriter\",\"filePath\":\"/home/runner/work/util/util/packages/logger/src/LogWriter.ts\",\"qualifiedName\":\"@proteinjs/logger/LogWriter\",\"properties\":[],\"methods\":[{\"name\":\"write\",\"returnType\":{\"packageName\":\"\",\"name\":\"void\",\"filePath\":null,\"qualifiedName\":\"/void\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"log\",\"type\":{\"packageName\":\"@proteinjs/logger\",\"name\":\"Log\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/logger/Log\",\"typeParameters\":null,\"directParents\":null}}]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"}],\"edges\":[{\"v\":\"@proteinjs/logger/LogWriter\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"}]}";
+const sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/logger/DefaultLogWriter\",\"value\":{\"packageName\":\"@proteinjs/logger\",\"name\":\"DefaultLogWriter\",\"filePath\":\"/home/runner/work/util/util/packages/logger/src/DefaultLogWriter.ts\",\"qualifiedName\":\"@proteinjs/logger/DefaultLogWriter\",\"properties\":[],\"methods\":[{\"name\":\"write\",\"returnType\":{\"packageName\":\"\",\"name\":\"void\",\"filePath\":null,\"qualifiedName\":\"/void\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"log\",\"type\":{\"packageName\":\"@proteinjs/logger\",\"name\":\"Log\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/logger/Log\",\"typeParameters\":null,\"directParents\":null}}]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"/'debug' | 'info' | 'warn' | 'error'\"}],\"edges\":[{\"v\":\"@proteinjs/logger/DefaultLogWriter\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"}]}";
 /** Generate Source Links */
 const sourceLinks = {};
 /** Load Source Graph and Links */

package/dist/generated/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;;;;;AAEpC,iCAA+B;AAG/B,4BAA4B;AAE5B,MAAM,WAAW,GAAG,szCAAszC,CAAC;AAG30C,4BAA4B;AAG5B,MAAM,WAAW,GAAG,EACnB,CAAC;AAGF,kCAAkC;AAElC,sDAAyD;AACzD,6BAAgB,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AAGjD,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;;;;;AAEpC,iCAA+B;AAG/B,4BAA4B;AAE5B,MAAM,WAAW,GAAG,y1CAAy1C,CAAC;AAG92C,4BAA4B;AAG5B,MAAM,WAAW,GAAG,EACnB,CAAC;AAGF,kCAAkC;AAElC,sDAAyD;AACzD,6BAAgB,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AAGjD,2CAAyB"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export * from './src/Logger';
 export * from './src/LogLevel';
-export * from './src/LogWriter';
+export * from './src/DefaultLogWriter';
 export * from './src/DevLogWriter';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC"}

package/dist/index.js

@@ -16,6 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./src/Logger"), exports);
 __exportStar(require("./src/LogLevel"), exports);
-__exportStar(require("./src/LogWriter"), exports);
+__exportStar(require("./src/DefaultLogWriter"), exports);
 __exportStar(require("./src/DevLogWriter"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,iDAA+B;AAC/B,kDAAgC;AAChC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,iDAA+B;AAC/B,yDAAuC;AACvC,qDAAmC"}

package/dist/src/{LogWriter.d.ts → DefaultLogWriter.d.ts}

@@ -2,7 +2,7 @@
 import { Loadable } from '@proteinjs/reflection';
 import { LogLevel } from './LogLevel';
 import { InspectOptions } from 'util';
-export declare const getLogWriter: () => LogWriter;
+export declare const getDefaultLogWriter: () => DefaultLogWriter;
 export type Log = {
     /** The name of the logger creating this log */
     loggerName?: string;
@@ -19,7 +19,17 @@ export type Log = {
     /** Object formatting options */
     inspectOptions?: InspectOptions;
 };
-export interface LogWriter extends Loadable {
+/**
+ * Every `Logger` instance will use the implementation of `DefaultLogWriter` unless
+ * a log writer is explicitly passed in when instantiating `Logger`.
+ *
+ * If this is not implemented, and no `LogWriter` is passed into `Logger`, `Logger`
+ * will default to using `DevLogWriter`.
+ *
+ * Note: this should only be implemented once. If there are multiple implementations,
+ * `Logger` will choose the first one that shows up in the package dependency tree.
+ * */
+export interface DefaultLogWriter extends Loadable {
     write(log: Log): void;
 }
-//# sourceMappingURL=LogWriter.d.ts.map
+//# sourceMappingURL=DefaultLogWriter.d.ts.map

package/dist/src/DefaultLogWriter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultLogWriter.d.ts","sourceRoot":"","sources":["../../src/DefaultLogWriter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAEtC,eAAO,MAAM,mBAAmB,wBACuD,CAAC;AAExF,MAAM,MAAM,GAAG,GAAG;IAChB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,QAAQ,EAAE,QAAQ,CAAC;IACnB,mCAAmC;IACnC,SAAS,EAAE,IAAI,CAAC;IAChB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,6BAA6B;IAC7B,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,gCAAgC;IAChC,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF;;;;;;;;;KASK;AACL,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAChD,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;CACvB"}

package/dist/src/DefaultLogWriter.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultLogWriter = void 0;
+const reflection_1 = require("@proteinjs/reflection");
+const getDefaultLogWriter = () => reflection_1.SourceRepository.get().object('@proteinjs/logger/DefaultLogWriter');
+exports.getDefaultLogWriter = getDefaultLogWriter;
+//# sourceMappingURL=DefaultLogWriter.js.map

package/dist/src/DefaultLogWriter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultLogWriter.js","sourceRoot":"","sources":["../../src/DefaultLogWriter.ts"],"names":[],"mappings":";;;AAAA,sDAAmE;AAI5D,MAAM,mBAAmB,GAAG,GAAG,EAAE,CACtC,6BAAgB,CAAC,GAAG,EAAE,CAAC,MAAM,CAAmB,oCAAoC,CAAC,CAAC;AAD3E,QAAA,mBAAmB,uBACwD"}

package/dist/src/DevLogWriter.d.ts

@@ -1,4 +1,4 @@
-import { Log } from './LogWriter';
+import { Log } from './DefaultLogWriter';
 export declare class DevLogWriter {
     private static COLORS;
     write({ loggerName, logLevel, timestamp, message, obj, inspectOptions, error }: Log): void;

package/dist/src/DevLogWriter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DevLogWriter.d.ts","sourceRoot":"","sources":["../../src/DevLogWriter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAElC,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,MAAM,CAMnB;IAEF,KAAK,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,GAAG,GAAG,IAAI;IAkC1F,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,UAAU;IAclB,OAAO,CAAC,YAAY;CAQrB"}
+{"version":3,"file":"DevLogWriter.d.ts","sourceRoot":"","sources":["../../src/DevLogWriter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAEzC,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,MAAM,CAMnB;IAEF,KAAK,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,GAAG,GAAG,IAAI;IAkC1F,OAAO,CAAC,MAAM;IAMd,OAAO,CAAC,UAAU;IAclB,OAAO,CAAC,YAAY;CAQrB"}

package/dist/src/Logger.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="node" />
 import { InspectOptions } from 'util';
 import { LogLevel } from './LogLevel';
-import { LogWriter } from './LogWriter';
+import { DefaultLogWriter } from './DefaultLogWriter';
 type LoggerParams = {
     name?: string;
     logLevel?: LogLevel;
-    logWriter?: LogWriter;
+    logWriter?: DefaultLogWriter;
 };
 type Log = {
     message?: string;
@@ -18,8 +18,9 @@ type ErrorLog = Log & {
 export declare class Logger {
     private name?;
     private logLevel;
-    private logWriter;
-    constructor({ name, logLevel, logWriter }: LoggerParams);
+    private logWriter?;
+    constructor({ name, logLevel, logWriter }?: LoggerParams);
+    private getLogWriter;
     log({ message, obj, inspectOptions }: Log): void;
     debug({ message, obj, inspectOptions }: Log): void;
     info({ message, obj, inspectOptions }: Log): void;

package/dist/src/Logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,KAAK,YAAY,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAAC,SAAS,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAClF,KAAK,GAAG,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,GAAG,CAAC;IAAC,cAAc,CAAC,EAAE,cAAc,CAAA;CAAE,CAAC;AAC5E,KAAK,QAAQ,GAAG,GAAG,GAAG;IAAE,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAExC,qBAAa,MAAM;IACjB,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,SAAS,CAAY;gBAEjB,EAAE,IAAI,EAAE,QAAiB,EAAE,SAA8B,EAAE,EAAE,YAAY;IAMrF,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,GAAG;IAWzC,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,GAAG;IAe3C,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,GAAG;IAe1C,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,GAAG;IAe1C,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,QAAQ;CAWxD"}
+{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAuB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAG3E,KAAK,YAAY,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAAC,SAAS,CAAC,EAAE,gBAAgB,CAAA;CAAE,CAAC;AACzF,KAAK,GAAG,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,GAAG,CAAC;IAAC,cAAc,CAAC,EAAE,cAAc,CAAA;CAAE,CAAC;AAC5E,KAAK,QAAQ,GAAG,GAAG,GAAG;IAAE,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAExC,qBAAa,MAAM;IACjB,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,SAAS,CAAC,CAAmB;gBAEzB,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAE,YAAiB;IAQ5D,OAAO,CAAC,YAAY;IAQpB,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,GAAG;IAWzC,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,GAAG;IAe3C,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,GAAG;IAe1C,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,GAAG;IAe1C,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,QAAQ;CAWxD"}

package/dist/src/Logger.js

@@ -1,15 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = void 0;
+const DefaultLogWriter_1 = require("./DefaultLogWriter");
 const DevLogWriter_1 = require("./DevLogWriter");
 class Logger {
-    constructor({ name, logLevel = 'info', logWriter = new DevLogWriter_1.DevLogWriter() }) {
-        this.name = name;
-        this.logLevel = logLevel;
+    constructor({ name, logLevel, logWriter } = {}) {
+        if (name) {
+            this.name = name;
+        }
+        this.logLevel = logLevel !== null && logLevel !== void 0 ? logLevel : 'info';
         this.logWriter = logWriter;
     }
+    getLogWriter() {
+        var _a;
+        if (!this.logWriter) {
+            this.logWriter = (_a = (0, DefaultLogWriter_1.getDefaultLogWriter)()) !== null && _a !== void 0 ? _a : new DevLogWriter_1.DevLogWriter();
+        }
+        return this.logWriter;
+    }
     log({ message, obj, inspectOptions }) {
-        this.logWriter.write({
+        this.getLogWriter().write({
             loggerName: this.name,
             logLevel: 'info',
             timestamp: new Date(),
@@ -22,7 +32,7 @@ class Logger {
         if (this.logLevel == 'info' || this.logLevel == 'warn' || this.logLevel == 'error') {
             return;
         }
-        this.logWriter.write({
+        this.getLogWriter().write({
             loggerName: this.name,
             logLevel: 'debug',
             timestamp: new Date(),
@@ -35,7 +45,7 @@ class Logger {
         if (this.logLevel == 'warn' || this.logLevel == 'error') {
             return;
         }
-        this.logWriter.write({
+        this.getLogWriter().write({
             loggerName: this.name,
             logLevel: 'info',
             timestamp: new Date(),
@@ -48,7 +58,7 @@ class Logger {
         if (this.logLevel == 'error') {
             return;
         }
-        this.logWriter.write({
+        this.getLogWriter().write({
             loggerName: this.name,
             logLevel: 'warn',
             timestamp: new Date(),
@@ -58,7 +68,7 @@ class Logger {
         });
     }
     error({ message, obj, inspectOptions, error }) {
-        this.logWriter.write({
+        this.getLogWriter().write({
             loggerName: this.name,
             logLevel: 'error',
             timestamp: new Date(),

package/dist/src/Logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":";;;AAGA,iDAA8C;AAM9C,MAAa,MAAM;IAKjB,YAAY,EAAE,IAAI,EAAE,QAAQ,GAAG,MAAM,EAAE,SAAS,GAAG,IAAI,2BAAY,EAAE,EAAgB;QACnF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAO;QACvC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YACnB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,MAAM;YAChB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAO;QACzC,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,EAAE;YAClF,OAAO;SACR;QAED,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YACnB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAO;QACxC,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,EAAE;YACvD,OAAO;SACR;QAED,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YACnB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,MAAM;YAChB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAO;QACxC,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,EAAE;YAC5B,OAAO;SACR;QAED,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YACnB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,MAAM;YAChB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAY;QACrD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YACnB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;YACd,KAAK;SACN,CAAC,CAAC;IACL,CAAC;CACF;AA9ED,wBA8EC"}
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../src/Logger.ts"],"names":[],"mappings":";;;AAEA,yDAA2E;AAC3E,iDAA8C;AAM9C,MAAa,MAAM;IAKjB,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,KAAmB,EAAE;QAC1D,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;QACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,MAAM,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAEO,YAAY;;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,SAAS,GAAG,MAAA,IAAA,sCAAmB,GAAE,mCAAI,IAAI,2BAAY,EAAE,CAAC;SAC9D;QAED,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAO;QACvC,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC;YACxB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,MAAM;YAChB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAO;QACzC,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,EAAE;YAClF,OAAO;SACR;QAED,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC;YACxB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAO;QACxC,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,EAAE;YACvD,OAAO;SACR;QAED,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC;YACxB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,MAAM;YAChB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAO;QACxC,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,EAAE;YAC5B,OAAO;SACR;QAED,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC;YACxB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,MAAM;YAChB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAY;QACrD,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC;YACxB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO;YACP,GAAG;YACH,cAAc;YACd,KAAK;SACN,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,wBAwFC"}

package/generated/index.ts

@@ -5,7 +5,7 @@ import '@proteinjs/reflection';
 /** Generate Source Graph */
 
 const sourceGraph =
-  '{"options":{"directed":true,"multigraph":false,"compound":false},"nodes":[{"v":"/\'debug\' | \'info\' | \'warn\' | \'error\'"},{"v":"@proteinjs/logger/LogWriter","value":{"packageName":"@proteinjs/logger","name":"LogWriter","filePath":"/home/runner/work/util/util/packages/logger/src/LogWriter.ts","qualifiedName":"@proteinjs/logger/LogWriter","properties":[],"methods":[{"name":"write","returnType":{"packageName":"","name":"void","filePath":null,"qualifiedName":"/void","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"log","type":{"packageName":"@proteinjs/logger","name":"Log","filePath":null,"qualifiedName":"@proteinjs/logger/Log","typeParameters":null,"directParents":null}}]}],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/reflection","name":"Loadable","filePath":null,"qualifiedName":"@proteinjs/reflection/Loadable","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/reflection/Loadable"}],"edges":[{"v":"@proteinjs/logger/LogWriter","w":"@proteinjs/reflection/Loadable","value":"extends interface"}]}';
+  '{"options":{"directed":true,"multigraph":false,"compound":false},"nodes":[{"v":"@proteinjs/logger/DefaultLogWriter","value":{"packageName":"@proteinjs/logger","name":"DefaultLogWriter","filePath":"/home/runner/work/util/util/packages/logger/src/DefaultLogWriter.ts","qualifiedName":"@proteinjs/logger/DefaultLogWriter","properties":[],"methods":[{"name":"write","returnType":{"packageName":"","name":"void","filePath":null,"qualifiedName":"/void","typeParameters":null,"directParents":null},"isAsync":false,"isOptional":false,"isAbstract":true,"isStatic":false,"visibility":"public","parameters":[{"name":"log","type":{"packageName":"@proteinjs/logger","name":"Log","filePath":null,"qualifiedName":"@proteinjs/logger/Log","typeParameters":null,"directParents":null}}]}],"typeParameters":[],"directParents":[{"packageName":"@proteinjs/reflection","name":"Loadable","filePath":null,"qualifiedName":"@proteinjs/reflection/Loadable","properties":[],"methods":[],"typeParameters":[],"directParents":[]}],"sourceType":3}},{"v":"@proteinjs/reflection/Loadable"},{"v":"/\'debug\' | \'info\' | \'warn\' | \'error\'"}],"edges":[{"v":"@proteinjs/logger/DefaultLogWriter","w":"@proteinjs/reflection/Loadable","value":"extends interface"}]}';
 
 /** Generate Source Links */
 

package/index.ts

@@ -1,4 +1,4 @@
 export * from './src/Logger';
 export * from './src/LogLevel';
-export * from './src/LogWriter';
+export * from './src/DefaultLogWriter';
 export * from './src/DevLogWriter';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteinjs/logger",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A simple logger",
   "main": "./dist/generated/index.js",
   "types": "./dist/generated/index.d.ts",
@@ -38,5 +38,5 @@
     "ts-jest": "29.1.1",
     "typescript": "5.2.2"
   },
-  "gitHead": "f14c87eefacbcfcb708dbaf711316519482a8923"
+  "gitHead": "a5d651a78b57502774d7c20c59a1d6cbdb14470b"
 }

package/src/DefaultLogWriter.ts

@@ -0,0 +1,37 @@
+import { Loadable, SourceRepository } from '@proteinjs/reflection';
+import { LogLevel } from './LogLevel';
+import { InspectOptions } from 'util';
+
+export const getDefaultLogWriter = () =>
+  SourceRepository.get().object<DefaultLogWriter>('@proteinjs/logger/DefaultLogWriter');
+
+export type Log = {
+  /** The name of the logger creating this log */
+  loggerName?: string;
+  /** The log level of this log */
+  logLevel: LogLevel;
+  /** The time the log was created */
+  timestamp: Date;
+  /** The log message */
+  message?: string;
+  /** The object being logged */
+  obj?: any;
+  /** The error being logged */
+  error?: Error;
+  /** Object formatting options */
+  inspectOptions?: InspectOptions;
+};
+
+/**
+ * Every `Logger` instance will use the implementation of `DefaultLogWriter` unless
+ * a log writer is explicitly passed in when instantiating `Logger`.
+ *
+ * If this is not implemented, and no `LogWriter` is passed into `Logger`, `Logger`
+ * will default to using `DevLogWriter`.
+ *
+ * Note: this should only be implemented once. If there are multiple implementations,
+ * `Logger` will choose the first one that shows up in the package dependency tree.
+ * */
+export interface DefaultLogWriter extends Loadable {
+  write(log: Log): void;
+}

package/src/DevLogWriter.ts

@@ -1,6 +1,6 @@
 import { inspect, InspectOptions } from 'util';
 import { LogLevel } from './LogLevel';
-import { Log } from './LogWriter';
+import { Log } from './DefaultLogWriter';
 
 export class DevLogWriter {
   private static COLORS = {

package/src/Logger.ts

@@ -1,25 +1,35 @@
 import { InspectOptions } from 'util';
 import { LogLevel } from './LogLevel';
-import { LogWriter } from './LogWriter';
+import { getDefaultLogWriter, DefaultLogWriter } from './DefaultLogWriter';
 import { DevLogWriter } from './DevLogWriter';
 
-type LoggerParams = { name?: string; logLevel?: LogLevel; logWriter?: LogWriter };
+type LoggerParams = { name?: string; logLevel?: LogLevel; logWriter?: DefaultLogWriter };
 type Log = { message?: string; obj?: any; inspectOptions?: InspectOptions };
 type ErrorLog = Log & { error?: Error };
 
 export class Logger {
   private name?: string;
   private logLevel: LogLevel;
-  private logWriter: LogWriter;
+  private logWriter?: DefaultLogWriter;
 
-  constructor({ name, logLevel = 'info', logWriter = new DevLogWriter() }: LoggerParams) {
-    this.name = name;
-    this.logLevel = logLevel;
+  constructor({ name, logLevel, logWriter }: LoggerParams = {}) {
+    if (name) {
+      this.name = name;
+    }
+    this.logLevel = logLevel ?? 'info';
     this.logWriter = logWriter;
   }
 
+  private getLogWriter() {
+    if (!this.logWriter) {
+      this.logWriter = getDefaultLogWriter() ?? new DevLogWriter();
+    }
+
+    return this.logWriter;
+  }
+
   log({ message, obj, inspectOptions }: Log) {
-    this.logWriter.write({
+    this.getLogWriter().write({
       loggerName: this.name,
       logLevel: 'info',
       timestamp: new Date(),
@@ -34,7 +44,7 @@ export class Logger {
       return;
     }
 
-    this.logWriter.write({
+    this.getLogWriter().write({
       loggerName: this.name,
       logLevel: 'debug',
       timestamp: new Date(),
@@ -49,7 +59,7 @@ export class Logger {
       return;
     }
 
-    this.logWriter.write({
+    this.getLogWriter().write({
       loggerName: this.name,
       logLevel: 'info',
       timestamp: new Date(),
@@ -64,7 +74,7 @@ export class Logger {
       return;
     }
 
-    this.logWriter.write({
+    this.getLogWriter().write({
       loggerName: this.name,
       logLevel: 'warn',
       timestamp: new Date(),
@@ -75,7 +85,7 @@ export class Logger {
   }
 
   error({ message, obj, inspectOptions, error }: ErrorLog) {
-    this.logWriter.write({
+    this.getLogWriter().write({
       loggerName: this.name,
       logLevel: 'error',
       timestamp: new Date(),

package/dist/src/LogWriter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LogWriter.d.ts","sourceRoot":"","sources":["../../src/LogWriter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAEtC,eAAO,MAAM,YAAY,iBAAgF,CAAC;AAE1G,MAAM,MAAM,GAAG,GAAG;IAChB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,QAAQ,EAAE,QAAQ,CAAC;IACnB,mCAAmC;IACnC,SAAS,EAAE,IAAI,CAAC;IAChB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,6BAA6B;IAC7B,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,gCAAgC;IAChC,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,MAAM,WAAW,SAAU,SAAQ,QAAQ;IACzC,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAAC;CACvB"}

package/dist/src/LogWriter.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLogWriter = void 0;
-const reflection_1 = require("@proteinjs/reflection");
-const getLogWriter = () => reflection_1.SourceRepository.get().object('@proteinjs/logger/LogWriter');
-exports.getLogWriter = getLogWriter;
-//# sourceMappingURL=LogWriter.js.map

package/dist/src/LogWriter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LogWriter.js","sourceRoot":"","sources":["../../src/LogWriter.ts"],"names":[],"mappings":";;;AAAA,sDAAmE;AAI5D,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,6BAAgB,CAAC,GAAG,EAAE,CAAC,MAAM,CAAY,6BAA6B,CAAC,CAAC;AAA7F,QAAA,YAAY,gBAAiF"}

package/src/LogWriter.ts

@@ -1,26 +0,0 @@
-import { Loadable, SourceRepository } from '@proteinjs/reflection';
-import { LogLevel } from './LogLevel';
-import { InspectOptions } from 'util';
-
-export const getLogWriter = () => SourceRepository.get().object<LogWriter>('@proteinjs/logger/LogWriter');
-
-export type Log = {
-  /** The name of the logger creating this log */
-  loggerName?: string;
-  /** The log level of this log */
-  logLevel: LogLevel;
-  /** The time the log was created */
-  timestamp: Date;
-  /** The log message */
-  message?: string;
-  /** The object being logged */
-  obj?: any;
-  /** The error being logged */
-  error?: Error;
-  /** Object formatting options */
-  inspectOptions?: InspectOptions;
-};
-
-export interface LogWriter extends Loadable {
-  write(log: Log): void;
-}