📤 Export ConsoleLogger

Author: bdsoha

README.md

@@ -77,6 +77,21 @@ const count = await client.send(new Requests.RoomCount())
 
 ### Logging
 
+By default, all logs are sent to the `NullLogger`, which discards them.
+To log messages, you can use our `ConsoleLogger`
+*(which wraps the native `console` object)*, set below:
+
+```ts
+import { ConsoleLogger, VitreaClient } from 'vitrea-client'
+
+const client = VitreaClient.create(
+    { /* ... */ },
+    {
+        log: new ConsoleLogger()
+    }
+)
+```
+
 If you already have a *logger* that implements the interface below, you can integrate
 it as follows:
 
@@ -85,12 +100,7 @@ import { getLogger }    from '@/core/logger'
 import { VitreaClient } from 'vitrea-client'
 
 const client = VitreaClient.create(
-    {
-        host:     '192.168.1.111',
-        port:     1234,
-        username: 'admin',
-        password: 'secret',
-    },
+    { /* ... */ },
     {
         log: getLogger('vBox')
     }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitrea-client",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Vitrea Smart Home API Client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/core/ConsoleLogger.spec.ts

@@ -0,0 +1,45 @@
+import { ConsoleLogger } from './ConsoleLogger'
+
+describe('ConsoleLogger', () => {
+    const logger = new ConsoleLogger()
+
+    beforeEach(() => {
+        jest.spyOn(global.console, 'log').mockImplementation()
+        jest.spyOn(global.console, 'error').mockImplementation()
+        jest.spyOn(global.console, 'warn').mockImplementation()
+        jest.spyOn(global.console, 'info').mockImplementation()
+        jest.spyOn(global.console, 'debug').mockImplementation()
+    })
+
+    afterEach(() => jest.clearAllMocks())
+
+    it('[log] logs using console', () => {
+        logger.log('Test log message', 'any')
+
+        expect(console.log).toHaveBeenCalledWith('Test log message', { level: 'any' })
+    })
+
+    it('[error] logs using console', () => {
+        logger.error('Test error message', 'arg1', 'arg2')
+
+        expect(console.error).toHaveBeenCalledWith('Test error message', 'arg1', 'arg2')
+    })
+
+    it('[warn] logs using console', () => {
+        logger.warn('Test warn message', 'arg1', 'arg2')
+
+        expect(console.warn).toHaveBeenCalledWith('Test warn message', 'arg1', 'arg2')
+    })
+
+    it('[info] logs using console', () => {
+        logger.info('Test info message', 'arg1', 'arg2')
+
+        expect(console.info).toHaveBeenCalledWith('Test info message', 'arg1', 'arg2')
+    })
+
+    it('[debug] logs using console', () => {
+        logger.debug('Test debug message', 'arg1', 'arg2')
+
+        expect(console.debug).toHaveBeenCalledWith('Test debug message', 'arg1', 'arg2')
+    })
+})

src/core/index.ts

@@ -2,4 +2,5 @@ export { DataGram }       from './DataGram'
 export { NullLogger }     from './NullLogger'
 export { BaseRequest }    from './BaseRequest'
 export { BaseResponse }   from './BaseResponse'
+export { ConsoleLogger }  from './ConsoleLogger'
 export { LoggerContract } from './LoggerContract'

src/index.ts

@@ -1,4 +1,4 @@
-export { Events }          from './utilities/Events'
+export { ConsoleLogger }   from './core'
 export { VitreaClient }    from './VitreaClient'
 export { ProtocolVersion } from './utilities/ProtocolVersion'
 export * as Enums          from './utilities/Enums'