refine logging

Author: garredow

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nothing-special/kaiware-lib",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"type": "module",
 	"author": {
 		"name": "Garrett Downs",

src/lib/connection.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
-import { LogLevel, MessageType } from '../enums';
-import { Config, Log, Message } from '../types';
+import { MessageType } from '../enums';
+import { Config, Message } from '../types';
 import { isJson } from '../utils';
 
 export class Connection {
@@ -22,12 +22,6 @@ export class Connection {
 
 			this.socket.onopen = () => {
 				console.log('WebSocket connection established');
-				this.sendMessage<Omit<Log, 'id'>>(MessageType.NewLog, {
-					source: this.config.sourceId,
-					level: LogLevel.Info,
-					data: ['Connection established'],
-					timestamp: new Date().toISOString()
-				});
 				resolve();
 			};
 

src/lib/kaiware.ts

@@ -1,5 +1,6 @@
 import { LogLevel, MessageType } from '../enums';
-import { Config, Log } from '../types';
+import { Config, LogMessageData } from '../types';
+import { parseError } from '../utils';
 import { Connection } from './connection';
 
 export class Kaiware {
@@ -44,39 +45,21 @@ export class Kaiware {
 		const stringifiedData: string[] = data.map((a) => {
 			if (typeof a === 'string') {
 				return a;
-			} else if (a instanceof Error) {
-				return JSON.stringify(a, [
-					'message',
-					'type',
-					'name',
-					'stack',
-					'fileName',
-					'lineNumber',
-					'columnNumber'
-				]);
-			} else if (a instanceof ErrorEvent) {
-				return JSON.stringify(a, [
-					'message',
-					'type',
-					'name',
-					'stack',
-					'fileName',
-					'lineNumber',
-					'columnNumber'
-				]);
+			} else if (a instanceof Error || a instanceof ErrorEvent) {
+				return JSON.stringify(parseError(a));
 			} else {
 				return JSON.stringify(a);
 			}
 		});
 
-		const log: Omit<Log, 'id'> = {
+		const log: LogMessageData = {
 			source: this.config!.sourceId,
 			level: level,
 			data: stringifiedData,
 			timestamp: new Date().toISOString()
 		};
 
-		this.connection.sendMessage(MessageType.NewLog, log);
+		this.connection.sendMessage<LogMessageData>(MessageType.NewLog, log);
 	}
 
 	static log = {

src/types/Log.ts

@@ -4,6 +4,6 @@ export type Log = {
 	id: number;
 	source: string;
 	level: LogLevel;
-	data: string[];
+	data: unknown[];
 	timestamp: string;
 };

src/types/LogMessageData.ts

@@ -0,0 +1,8 @@
+import { LogLevel } from '../enums';
+
+export type LogMessageData = {
+	source: string;
+	level: LogLevel;
+	data: string[];
+	timestamp: string;
+};

src/types/index.ts

@@ -1,4 +1,5 @@
 export * from './Config';
 export * from './DeviceInfo';
 export * from './Log';
+export * from './LogMessageData';
 export * from './Message';

src/utils/index.ts

@@ -1 +1,2 @@
 export * from './isJson';
+export * from './parseError';

src/utils/isJson.ts

@@ -1,6 +1,6 @@
-export function isJson(data: string): boolean {
+export function isJson(data: unknown): boolean {
 	try {
-		JSON.parse(data);
+		JSON.parse(data as string);
 	} catch (error) {
 		return false;
 	}

src/utils/parseError.ts

@@ -0,0 +1,13 @@
+export function parseError(err: Error | ErrorEvent): object {
+	return JSON.parse(
+		JSON.stringify(err, [
+			'message',
+			'type',
+			'name',
+			'stack',
+			'fileName',
+			'lineNumber',
+			'columnNumber'
+		])
+	);
+}