Merge pull request #21 from tclxshunquan-wang/feat/fix_typing

refactor: 💡 update logger interface and tests for improved setup function handling

Author: tianyingchun

.changeset/big-masks-cry.md

@@ -0,0 +1,5 @@
+---
+"@hyperse/logger": patch
+---
+
+refactor: update logger interface and tests for improved setup function handling

packages/logger/src/types/type-logger.ts

@@ -140,7 +140,7 @@ export interface LoggerBuilderWithRequired<
    * @returns The Logger type.
    */
   build(
-    setup: SetupContext<InitialContext, PluginContext>
+    setup: StrictSetupFunction<InitialContext, PluginContext>
   ): Logger<MergedLoggerContext<InitialContext, PluginContext>>;
 
   /**
@@ -153,12 +153,12 @@ export interface LoggerBuilderWithRequired<
   ): Logger<MergedLoggerContext<InitialContext, PluginContext>>;
 
   /**
-   * Build the logger with a function parameters.
-   * @param setup The setup function.
+   *  Build the logger with a context object.
+   * @param setup The setup context object.
    * @returns The Logger type.
    */
   build(
-    setup: StrictSetupFunction<InitialContext, PluginContext>
+    setup: SetupContext<InitialContext, PluginContext>
   ): Logger<MergedLoggerContext<InitialContext, PluginContext>>;
 }
 
@@ -171,7 +171,7 @@ export interface LoggerBuilderWithRequired<
 export interface LoggerBuilderNoRequired<
   InitialContext extends object = object,
   PluginContext extends object = object,
-> extends LoggerBuilderWithRequired<InitialContext, PluginContext> {
+> {
   /**
    * Build the logger without parameters.
    * @returns The Logger type.
@@ -190,7 +190,8 @@ export type LoggerBuilder<
   PluginContext extends object = object,
 > =
   HasRequiredProperties<PluginContext> extends false
-    ? LoggerBuilderNoRequired<InitialContext, PluginContext>
+    ? LoggerBuilderNoRequired<InitialContext, PluginContext> &
+        LoggerBuilderWithRequired<InitialContext, PluginContext>
     : LoggerBuilderWithRequired<InitialContext, PluginContext>;
 
 /**

packages/logger/tests/ctx.spec.ts

@@ -9,6 +9,8 @@ describe('Logger Context Setup', () => {
 
     type NewLoggerContext = {
       env?: string;
+      platform?: 'android' | 'ios';
+      agent?: string;
     };
 
     const consolePlugin = definePlugin<NewLoggerContext>({
@@ -21,12 +23,10 @@ describe('Logger Context Setup', () => {
       name: 'sampleLogger',
     })
       .use(consolePlugin)
-      .build(() => {
-        return {
-          platform: 'android',
-          agent: 'chrome 123',
-          env: 'node',
-        };
+      .build({
+        env: 'node',
+        platform: 'android',
+        agent: 'chrome 123',
       });
 
     logger.info('info message');

packages/logger/tests/logger.spec.ts

@@ -195,7 +195,7 @@ describe('Logger Basic Functionality', () => {
 
     type AppContext = {
       userId: string;
-      environment: string;
+      environment?: string;
     };
 
     const consolePlugin = definePlugin<AppContext>({
@@ -300,7 +300,10 @@ describe('Logger Basic Functionality', () => {
       version: '1.0.0',
     })
       .use(consolePlugin)
-      .build();
+      .build({
+        env: 'production',
+        version: '1.0.0',
+      });
 
     // Function message - string
     logger.info((ctx) => `App v${ctx.version} running in ${ctx.env}`);