Update the logger creation to override level priorities

.nsprc

@@ -2,6 +2,6 @@
   "1092330": {
     "active": true,
     "notes": "The latest version of word-wrap was published 6 years ago",
-    "expiry": "2023-11-01"
+    "expiry": "2024-06-01"
   }
 }

src/index.spec.ts

@@ -0,0 +1,44 @@
+import { createLogger } from './index'
+import TransportStream from 'winston-transport'
+
+describe('logger', () => {
+  it('verbose logs are screened out when level is debug', () => {
+    const transport = new InMemoryTransport({})
+    const logger = createLogger({ loggerOptions: { level: 'debug' }, transports: [transport] })
+    logger.debug('test a')
+    logger.verbose('test b')
+    expect(transport.logs.length).toBe(1)
+    expect(transport.logs[0].message).toBe('test a')
+  })
+
+  it('debug logs are not screened out when level is verbose', () => {
+    const transport = new InMemoryTransport({})
+    const logger = createLogger({ loggerOptions: { level: 'verbose' }, transports: [transport] })
+    logger.debug('test a')
+    logger.verbose('test b')
+    expect(transport.logs.length).toBe(2)
+    expect(transport.logs[0].message).toBe('test a')
+    expect(transport.logs[1].message).toBe('test b')
+  })
+})
+
+class InMemoryTransport extends TransportStream {
+  logs: {
+    level: string
+    message: string
+  }[]
+
+  constructor(opts: TransportStream.TransportStreamOptions) {
+    super(opts)
+    this.logs = []
+  }
+
+  //eslint-disable-next-line @typescript-eslint/no-explicit-any
+  log(info: any, next: () => void): void {
+    const { level, message } = info
+    this.logs.push({ level, message })
+    next()
+  }
+
+  close(): void {}
+}

src/index.ts

@@ -24,13 +24,23 @@ export type Logger = Pick<
   | 'log'
 >
 
+// winstonjs' default levels have debug and verbose reversed, which is confusing and causes filtering issues with Seq,
+// CloudWatch etc (given they assume Verbose/Trace should be the lowest/noisiest log level)
+const levels = {
+  error: 0,
+  warn: 1,
+  info: 3,
+  debug: 4,
+  verbose: 5,
+}
+
 export interface CreateLoggerOptions {
   consoleFormat?: 'pretty' | 'json'
   transports?: Transport[]
   consoleOptions?: Omit<ConsoleTransportOptions, 'format'>
   consoleFormats?: Format[]
   omitPaths?: string[]
-  loggerOptions?: LoggerOptions
+  loggerOptions?: Omit<LoggerOptions, 'transports'>
 }
 
 export const createConsoleTransport = ({ consoleFormat = 'json', consoleOptions, consoleFormats, omitPaths }: CreateLoggerOptions) => {
@@ -61,6 +71,7 @@ export const createLogger = (options: CreateLoggerOptions): Logger => {
 
   // create logger options using supplied options + transports
   const loggerOptions: LoggerOptions = {
+    levels, // loggerOptions should still be allowed to override our defaults
     ...options.loggerOptions,
     transports,
   }