logixlysia 3.0.0 → 3.0.2

package/CHANGELOG.md

@@ -1,11 +1,26 @@
 # Changelog
 
+## [3.0.2](https://github.com/PunGrumpy/logixlysia/compare/v3.0.1...v3.0.2) (2024-04-08)
+
+
+### Bug Fixes
+
+* **logger:** add `config` property for logging configuration ([27d80eb](https://github.com/PunGrumpy/logixlysia/commit/27d80eb6b0c3a4a40a96738b235d9bc6b117c804))
+
+## [3.0.1](https://github.com/PunGrumpy/logixlysia/compare/v3.0.0...v3.0.1) (2024-04-08)
+
+
+### Bug Fixes
+
+* **logger:** use correct status code in error log message ([a3ec49c](https://github.com/PunGrumpy/logixlysia/commit/a3ec49cd3fc1dc7f01a29b21e4de9cf543329c43)), closes [#33](https://github.com/PunGrumpy/logixlysia/issues/33)
+
 ## [3.0.0](https://github.com/PunGrumpy/logixlysia/compare/v2.3.1...v3.0.0) (2024-04-08)
 
 
 ### ⚠ BREAKING CHANGES
 
-* **options:** 
+* Added support for custom log format in the logger
+* Enhanced flexibility for define thier preferred log message structure
 
 ### Features
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logixlysia",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "🦊 Logixlysia is a logger for Elysia",
   "type": "module",
   "module": "src/index.ts",

package/src/index.ts

@@ -2,7 +2,7 @@ import Elysia from 'elysia'
 import { createLogger, handleHttpError } from './logger'
 import startString from './utils/start'
 import { Server } from 'bun'
-import { Options } from './types'
+import { HttpError, Options } from './types'
 
 /**
  * Creates a logger.
@@ -35,7 +35,12 @@ export const logger = (options?: Options): Elysia => {
       log.log('INFO', request, { status: 200 }, store as { beforeTime: bigint })
     })
     .onError({ as: 'global' }, ({ request, error, store }) => {
-      handleHttpError(request, error, store as { beforeTime: bigint })
+      handleHttpError(
+        request,
+        error as HttpError,
+        store as { beforeTime: bigint },
+        options
+      )
     })
 
   return elysia

package/src/logger.ts

@@ -4,8 +4,15 @@ import methodString from './utils/method'
 import logString from './utils/log'
 import pathString from './utils/path'
 import statusString from './utils/status'
-import { HttpError, RequestInfo } from './types'
-import { LogLevel, LogData, Logger, StoreData, Options } from './types'
+import {
+  LogLevel,
+  LogData,
+  Logger,
+  StoreData,
+  Options,
+  RequestInfo,
+  HttpError
+} from './types'
 
 /**
  * Logs a message.
@@ -52,12 +59,12 @@ function buildLogMessage(
   const statusStr = statusString(data.status || 200)
   const messageStr = data.message || ''
   const ipStr =
-    options?.ip && request.headers.get('x-forwarded-for')
+    options?.config?.ip && request.headers.get('x-forwarded-for')
       ? `IP: ${request.headers.get('x-forwarded-for')}`
       : ''
 
   const logFormat =
-    options?.customLogFormat ||
+    options?.config?.customLogFormat ||
     '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}'
   const logMessage = logFormat
     .replace('{now}', nowStr)
@@ -81,24 +88,24 @@ function buildLogMessage(
 export const createLogger = (options?: Options): Logger => ({
   log: (level, request, data, store) =>
     log(level, request, data, store, options),
-  customLogFormat: options?.customLogFormat
+  customLogFormat: options?.config?.customLogFormat
 })
 
 /**
  * Handles an HTTP error.
  *
  * @param {RequestInfo} request The request.
- * @param {Error} error The error.
+ * @param {HttpError} error The HTTP error.
  * @param {StoreData} store The store data.
  * @param {Options} options The options.
  */
 export const handleHttpError = (
   request: RequestInfo,
-  error: Error,
+  error: HttpError,
   store: StoreData,
   options?: Options
 ): void => {
-  const statusCode = error instanceof HttpError ? error.status : 500
+  const statusCode = error.status || 500
   const logMessage = buildLogMessage(
     'ERROR',
     request,

package/src/types.ts

@@ -45,8 +45,10 @@ class HttpError extends Error {
 }
 
 interface Options {
-  ip?: boolean
-  customLogFormat?: string
+  config?: {
+    ip?: boolean
+    customLogFormat?: string
+  }
 }
 
 export {

package/test/logixlysia.test.ts

@@ -12,9 +12,11 @@ describe('Logixlysia with IP logging enabled', () => {
     server = new Elysia()
       .use(
         logger({
-          ip: true,
-          customLogFormat:
-            '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+          config: {
+            ip: true,
+            customLogFormat:
+              '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+          }
         })
       )
       .get('/', ctx => {
@@ -69,9 +71,11 @@ describe('Logixlysia with IP logging disabled', () => {
     server = new Elysia()
       .use(
         logger({
-          ip: false,
-          customLogFormat:
-            '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+          config: {
+            ip: false,
+            customLogFormat:
+              '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+          }
         })
       )
       .get('/', () => '🦊 Logixlysia Getting')