Merge pull request #18 from cybercoder-naj/type-safety

Added Type safety to onSuccess Method

Author: cybercoder-naj

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 ## [1.0.1] - 30-03-2024
+### Added
+- Type-safety to onSuccess method, based on attributes passed on `use`. ([#6](https://github.com/cybercoder-naj/logestic/issues/6))
+
 ### Fixed
 - Status of type `number` and not `any`. ([#5](https://github.com/cybercoder-naj/logestic/issues/5))
 

src/index.ts

@@ -6,7 +6,7 @@
 import Elysia from 'elysia';
 import {
   Attribute,
-  FormatObj,
+  Callback,
   LogLevelColour,
   LogesticOptions,
   Preset
@@ -23,10 +23,8 @@ export const chalk = c; // Re-export chalk for custom formatting
 /**
  * Logestic class provides methods to configure and perform logging.
  */
-export class Logestic {
-  private requestedAttrs: {
-    [key in keyof Attribute]: boolean;
-  };
+export class Logestic<K extends keyof Attribute = keyof Attribute> {
+  private requestedAttrs: K[];
   private dest!: BunFile;
   private showLevel: boolean;
   private logLevelColour: LogLevelColour;
@@ -40,7 +38,7 @@ export class Logestic {
    * @see LogesticOptions
    */
   constructor(options: LogesticOptions = {}) {
-    this.requestedAttrs = {};
+    this.requestedAttrs = [];
     this.showLevel = options.showLevel || false;
     this.logLevelColour = options.logLevelColour || {};
     this.httpLogging = options.httpLogging || true;
@@ -82,23 +80,23 @@ export class Logestic {
    * @param attrs - An attribute key or an array of attribute keys.
    * @returns The Logestic instance for chaining.
    */
-  use(attr: keyof Attribute): Logestic;
-  use(attrs: (keyof Attribute)[]): Logestic;
-  use(attrs: keyof Attribute | (keyof Attribute)[]): Logestic {
+  use<NK extends K>(attr: NK): Logestic<NK>;
+  use<NK extends K>(attrs: NK[]): Logestic<NK>;
+  use<NK extends K>(attrs: NK | NK[]): Logestic<NK> {
     if (Array.isArray(attrs)) {
       for (const attr of attrs) {
         this._use(attr);
       }
-      return this;
+      return this as unknown as Logestic<NK>;
     }
 
     // Single attribute
     this._use(attrs);
-    return this;
+    return this as unknown as Logestic<NK>;
   }
 
-  private _use(attr: keyof Attribute) {
-    this.requestedAttrs[attr] = true;
+  private _use(attr: K) {
+    this.requestedAttrs.push(attr);
   }
 
   /**
@@ -128,7 +126,7 @@ export class Logestic {
    * @param formatAttr - The format object containing functions to format successful and failed logs.
    * @returns Elysia instance with the logger plugged in.
    */
-  format(this: Logestic, formatAttr: FormatObj) {
+  format(this: Logestic, formatAttr: Callback<K>) {
     return this.build()
       .state('logestic_timeStart', 0n)
       .onRequest(({ store }) => {

src/types.ts

@@ -8,17 +8,17 @@
 import { BunFile } from 'bun';
 
 export type Attribute = {
-  ip?: string;
-  method?: string;
-  path?: string;
-  body?: any;
-  query?: Record<string, string | undefined>;
-  time?: Date;
-  contentLength?: number;
-  status?: number;
-  referer?: string;
-  userAgent?: string;
-  duration?: bigint;
+  ip: string;
+  method: string;
+  path: string;
+  body: any;
+  query: Record<string, string | undefined>;
+  time: Date;
+  contentLength: number;
+  status: number;
+  referer: string;
+  userAgent: string;
+  duration: bigint;
 };
 
 export type ErrorAttribute = {
@@ -28,23 +28,15 @@ export type ErrorAttribute = {
   datetime: Date;
 };
 
-/**
- * `AttributeMap` is a type that maps each key of `Attribute` to a boolean.
- * It is used to indicate which attributes are enabled or disabled.
- */
-export type AttributeMap = {
-  [key in keyof Attribute]: boolean;
-};
-
 /**
  * `Presets` is an object that contains preset configurations for the Logestic module.
  */
 export type Preset = 'common' | 'fancy';
 /**
- * `FormatObj` is an object that contains functions to format successful and failed logs.
+ * `Callback` is an object that contains functions to format successful and failed logs.
  */
-export type FormatObj = {
-  onSuccess: (attr: Attribute) => string;
+export type Callback<K extends keyof Attribute> = {
+  onSuccess: (attr: Pick<Attribute, K>) => string;
   onFailure: (attr: ErrorAttribute) => string;
 };
 

src/utils.ts

@@ -7,22 +7,22 @@
 
 import { StatusMap } from 'elysia';
 import { type Context } from 'elysia';
-import type { AttributeMap, Attribute, LogType, LogLevelColour } from './types';
+import type { Attribute, LogType, LogLevelColour } from './types';
 import chalk, { ChalkInstance } from 'chalk';
 
 /**
  * @param ctx Elysia context
  * @param reqAttrs A map of attributes to be built
  * @returns The built attributes
  */
-export const buildAttrs = (
+export const buildAttrs = <K extends keyof Attribute>(
   ctx: Context,
-  reqAttrs: AttributeMap,
+  reqAttrs: K[],
   timeStart: bigint
-): Attribute => {
+): Pick<Attribute, K> => {
   const { request, path, body, query, set } = ctx;
 
-  let attrs: Attribute = {};
+  let attrs: Partial<Attribute> = {};
   for (const key in reqAttrs) {
     const k = key as keyof Attribute;
     switch (k) {
@@ -76,7 +76,7 @@ export const buildAttrs = (
     }
   }
 
-  return attrs;
+  return attrs as Pick<Attribute, K>;
 };
 
 /**