Merge pull request #130 from jwulf/127-log-interface

Add ZBCustomLogger and ZBLogMessage interfaces

Author: s3than

src/lib/MockStdOut.ts

@@ -1,4 +1,5 @@
-export class MockStdOut {
+import { ZBCustomLogger } from './interfaces'
+export class MockStdOut implements ZBCustomLogger {
 	public messages: string[] = []
 
 	public info(message: string) {

src/lib/interfaces.ts

@@ -7,6 +7,15 @@ export interface BasicAuthConfig {
 	password: string
 	username: string
 }
+// The JSON-stringified version of this is sent to the ZBCustomLogger
+export interface ZBLogMessage {
+	timestamp: Date
+	context: string
+	id: string
+	level: Loglevel
+	message: string
+	time: string
+}
 
 export interface KeyedObject {
 	[key: string]: any
@@ -451,10 +460,21 @@ export interface CamundaCloudConfig {
 	cacheOnDisk?: boolean
 }
 
+export interface ZBCustomLogger {
+	/**
+	 * Receives a JSON-stringified ZBLogMessage
+	 */
+	info: (message: string) => void
+	/**
+	 * Receives a JSON-stringified ZBLogMessage
+	 */
+	error: (message: string) => void
+}
+
 export interface ZBClientOptions {
 	connectionTolerance?: number
 	loglevel?: Loglevel
-	stdout?: any
+	stdout?: ZBCustomLogger
 	retry?: boolean
 	maxRetries?: number
 	maxRetryTimeout?: number

src/zb/ZBClient.ts

@@ -47,7 +47,7 @@ export class ZBClient extends EventEmitter {
 	private oAuth?: OAuthProvider
 	private basicAuth?: ZB.BasicAuthConfig
 	private useTLS: boolean
-	private stdout: any
+	private stdout: ZB.ZBCustomLogger
 	private lastReady?: Date
 	private lastConnectionError?: Date