@clairejs/client 3.3.2 → 3.4.0

package/README.md

@@ -1,7 +1,12 @@
 ## Change Log
 
-#### 3.3.2:
+#### 3.4.0:
 
+-   apply LogHandler to some implementations
+
+#### 3.3.3:
+
+-   update claire core
 -   export getAPI utils
 -   remove webpack, change module to esm
 

package/dist/api/DefaultHttpClient.d.ts

@@ -1,5 +1,5 @@
 import { Method } from "axios";
-import { AbstractLogger } from "@clairejs/core";
+import { LogHandler } from "@clairejs/core";
 import { AbstractHttpClient, RequestOptions } from "./AbstractHttpClient";
 import { AbstractStorage } from "../system/AbstractStorage";
 export interface RequestData {
@@ -11,12 +11,12 @@ export interface RequestData {
 }
 export declare class DefaultHttpClient extends AbstractHttpClient {
     protected readonly apiServerUrl: string;
-    protected readonly logger: AbstractLogger;
+    protected readonly logger?: LogHandler | undefined;
     protected readonly maxRetryCount: number;
     protected readonly delayMsBetweenRetry: number;
     protected readonly storage?: AbstractStorage | undefined;
     private readonly api;
-    constructor(apiServerUrl: string, logger: AbstractLogger, maxRetryCount?: number, delayMsBetweenRetry?: number, storage?: AbstractStorage | undefined);
+    constructor(apiServerUrl: string, logger?: LogHandler | undefined, maxRetryCount?: number, delayMsBetweenRetry?: number, storage?: AbstractStorage | undefined);
     protected resolveUrl(url: string): Promise<string>;
     protected getAuthorization(): Promise<string>;
     protected errorHandler<T = any>(_operation: () => Promise<T>, err: any): Promise<T | undefined>;

package/dist/api/DefaultHttpClient.js

@@ -1,5 +1,5 @@
 import axios from "axios";
-import { Errors } from "@clairejs/core";
+import { Errors, LogLevel } from "@clairejs/core";
 import { AbstractHttpClient } from "./AbstractHttpClient";
 export class DefaultHttpClient extends AbstractHttpClient {
     apiServerUrl;
@@ -69,7 +69,7 @@ export class DefaultHttpClient extends AbstractHttpClient {
                 err.response.status === 503 ||
                 err.response.data?.message === "Service Unavailable") &&
                 retryCount < this.maxRetryCount) {
-                this.logger.debug(`unknown error encountered, retrying request ${retryCount + 1}/${this.maxRetryCount} after ${this.delayMsBetweenRetry}ms`);
+                this.logger?.log(LogLevel.DEBUG, `unknown error encountered, retrying request ${retryCount + 1}/${this.maxRetryCount} after ${this.delayMsBetweenRetry}ms`);
                 await new Promise((resolve) => setTimeout(resolve, this.delayMsBetweenRetry));
                 return await this.retry(apiCall, retryCount + 1);
             }

package/dist/api/RefreshHttpClient.d.ts

@@ -1,18 +1,18 @@
-import { AbstractLogger, AccessToken } from "@clairejs/core";
+import { AccessToken, LogHandler } from "@clairejs/core";
 import { AbstractStorage } from "../system/AbstractStorage";
 import { AbstractTokenManager } from "./AbstractTokenManager";
 import { DefaultHttpClient } from "./DefaultHttpClient";
 export declare class RefreshHttpClient extends DefaultHttpClient {
     protected readonly apiServerUrl: string;
-    protected readonly logger: AbstractLogger;
     protected readonly tokenManager: AbstractTokenManager;
+    protected readonly logger?: LogHandler | undefined;
     protected readonly maxRetryCount: number;
     protected readonly delayMsBetweenRetry: number;
     protected readonly storage?: AbstractStorage | undefined;
     private refreshing;
     private refreshQueue;
     private tokenQueue;
-    constructor(apiServerUrl: string, logger: AbstractLogger, tokenManager: AbstractTokenManager, maxRetryCount?: number, delayMsBetweenRetry?: number, storage?: AbstractStorage | undefined);
+    constructor(apiServerUrl: string, tokenManager: AbstractTokenManager, logger?: LogHandler | undefined, maxRetryCount?: number, delayMsBetweenRetry?: number, storage?: AbstractStorage | undefined);
     protected getRefreshedAccessToken(): Promise<AccessToken>;
     protected reauthenticate(): Promise<void>;
     protected getAuthorization(): Promise<string>;

package/dist/api/RefreshHttpClient.js

@@ -1,22 +1,22 @@
-import { Errors } from "@clairejs/core";
+import { Errors, LogLevel } from "@clairejs/core";
 import { DefaultHttpClient } from "./DefaultHttpClient";
 const tokenExpiredError = Errors.TOKEN_EXPIRED().name;
 const invalidTokenError = Errors.INVALID_TOKEN().name;
 export class RefreshHttpClient extends DefaultHttpClient {
     apiServerUrl;
-    logger;
     tokenManager;
+    logger;
     maxRetryCount;
     delayMsBetweenRetry;
     storage;
     refreshing = false;
     refreshQueue = [];
     tokenQueue = [];
-    constructor(apiServerUrl, logger, tokenManager, maxRetryCount = 2, delayMsBetweenRetry = 200, storage) {
+    constructor(apiServerUrl, tokenManager, logger, maxRetryCount = 2, delayMsBetweenRetry = 200, storage) {
         super(apiServerUrl, logger, maxRetryCount, delayMsBetweenRetry, storage);
         this.apiServerUrl = apiServerUrl;
-        this.logger = logger;
         this.tokenManager = tokenManager;
+        this.logger = logger;
         this.maxRetryCount = maxRetryCount;
         this.delayMsBetweenRetry = delayMsBetweenRetry;
         this.storage = storage;
@@ -41,7 +41,7 @@ export class RefreshHttpClient extends DefaultHttpClient {
     }
     async refreshToken(token) {
         if (this.refreshing) {
-            this.logger.debug("Awaiting refresh token, queued");
+            this.logger?.log(LogLevel.DEBUG, "Awaiting refresh token, queued");
             return await new Promise((resolver) => {
                 this.refreshQueue.push(resolver);
             });
@@ -56,7 +56,7 @@ export class RefreshHttpClient extends DefaultHttpClient {
             this.refreshing = true;
             token = await this.getRefreshedAccessToken();
             await this.tokenManager.setAccessToken(token);
-            this.logger.debug("Access token was refreshed");
+            this.logger?.log(LogLevel.DEBUG, "Access token was refreshed");
         }
         finally {
             this.refreshing = false;

package/dist/socket/DefaultClientSocketManager.d.ts

@@ -1,11 +1,11 @@
-import { AbstractLogger, DisconnectionHandler, IClientSocket, PlainMessageHandler, ReconnectionHandler } from "@clairejs/core";
+import { DisconnectionHandler, IClientSocket, PlainMessageHandler, ReconnectionHandler, LogHandler } from "@clairejs/core";
 import { AbstractClientSocketManager } from "./AbstractClientSocketManager";
 import { SocketConfig } from "./SocketConfig";
 import { DefaultClientSocket } from "./DefaultClientSocket";
 import { IWebSocket } from "./IWebSocket";
 export declare class DefaultClientSocketManager extends AbstractClientSocketManager {
     private readonly wsProvider;
-    private readonly logger;
+    private readonly logger?;
     private readonly config?;
     private socket?;
     private allSockets;
@@ -22,7 +22,7 @@ export declare class DefaultClientSocketManager extends AbstractClientSocketMana
         sentTimestamp: number;
         receivedTimestamp?: number;
     }[];
-    constructor(wsProvider: () => Promise<IWebSocket>, logger: AbstractLogger, config?: SocketConfig | undefined);
+    constructor(wsProvider: () => Promise<IWebSocket>, logger?: LogHandler | undefined, config?: SocketConfig | undefined);
     getPingMs(): number;
     subChannels(socket: IClientSocket, channels: string[]): void;
     unsubChannels(socket: IClientSocket, channels: string[]): void;

package/dist/socket/DefaultClientSocketManager.js

@@ -1,4 +1,4 @@
-import { Errors, MessageType, } from "@clairejs/core";
+import { LogLevel, Errors, MessageType, } from "@clairejs/core";
 import { AbstractClientSocketManager } from "./AbstractClientSocketManager";
 import { DefaultClientSocket } from "./DefaultClientSocket";
 const pingpongMaxCount = 10;
@@ -34,7 +34,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
     subChannels(socket, channels) {
         const info = this.allSockets.find((s) => s.socket === socket);
         if (!info) {
-            this.logger.debug("Socket not found");
+            this.logger?.log(LogLevel.DEBUG, "Socket not found");
             return;
         }
         //-- un-connected channels
@@ -53,7 +53,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
     unsubChannels(socket, channels) {
         const info = this.allSockets.find((s) => s.socket === socket);
         if (!info) {
-            this.logger.debug("Socket not found");
+            this.logger?.log(LogLevel.DEBUG, "Socket not found");
             return;
         }
         info.registeredChannels = info.registeredChannels.filter((c) => !channels.includes(c));
@@ -178,10 +178,10 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
             throw Errors.SYSTEM_ERROR("Socket not available");
         }
         this.socket.send(message);
-        this.logger.debug("Raw send", message);
+        this.logger?.log(LogLevel.DEBUG, "Raw send", message);
     }
     handleChannelJoin(channels) {
-        this.logger.debug("Joinning channels", channels);
+        this.logger?.log(LogLevel.DEBUG, "Joinning channels", channels);
         for (const channel of channels) {
             let foundChannel = this.allChannels.find((c) => c.channel === channel);
             if (!foundChannel) {
@@ -191,7 +191,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
             foundChannel.connected = true;
             //-- flush messages
             if (foundChannel.pendingMessages.length) {
-                this.logger.debug(`Flushing ${foundChannel.pendingMessages.length} message`);
+                this.logger?.log(LogLevel.DEBUG, `Flushing ${foundChannel.pendingMessages.length} message`);
                 for (const message of foundChannel.pendingMessages) {
                     this.sendPlainMessageToChannel(message, foundChannel.channel);
                 }
@@ -200,7 +200,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
         }
     }
     handleChannelLeave(channels) {
-        this.logger.debug("Leaving channels", channels);
+        this.logger?.log(LogLevel.DEBUG, "Leaving channels", channels);
         this.allChannels = this.allChannels.filter((c) => !channels.includes(c.channel));
     }
     handlePlainMessage(message, channel) {
@@ -209,7 +209,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
         }
     }
     handleConnect() {
-        this.logger.debug("Socket connected");
+        this.logger?.log(LogLevel.DEBUG, "Socket connected");
         //-- socket open, set interval
         if (this.pingIntervalId) {
             clearInterval(this.pingIntervalId);
@@ -242,7 +242,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
         if (err) {
             this.intendedDisconnection = true;
         }
-        this.logger.debug("Socket connnection closed, error: ", err);
+        this.logger?.log(LogLevel.DEBUG, "Socket connnection closed, error: ", err);
         if (this.pingIntervalId) {
             clearInterval(this.pingIntervalId);
         }
@@ -255,7 +255,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
             //-- remove all channels
             this.allSockets = [];
             this.allChannels = [];
-            this.logger.debug("Socket connection terminated");
+            this.logger?.log(LogLevel.DEBUG, "Socket connection terminated");
         }
         else {
             //-- disconnect all channels to be reconnected when the socket is connected again
@@ -267,7 +267,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
         }
     }
     handleMessage(message) {
-        this.logger.debug("Raw receive", message);
+        this.logger?.log(LogLevel.DEBUG, "Raw receive", message);
         switch (message.type) {
             case MessageType.READY:
                 this.handleConnect();
@@ -284,7 +284,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
                 break;
             case MessageType.CHANNEL_JOIN:
                 if (message.data?.error) {
-                    this.logger.error("Join channel error", message.data.error);
+                    this.logger?.log(LogLevel.ERROR, "Join channel error", message.data.error);
                 }
                 else {
                     this.handleChannelJoin(message.data);
@@ -337,7 +337,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
             this.socket = socket;
             this.socket.onopen(() => {
                 this.socketConnected = true;
-                this.logger.debug("Physic link connected, sending & waiting for READY message");
+                this.logger?.log(LogLevel.DEBUG, "Physic link connected, sending & waiting for READY message");
                 this.sendRawMessage({
                     type: MessageType.READY,
                     data: "",
@@ -346,7 +346,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
             this.socket.onmessage((data) => {
                 const message = JSON.parse(data);
                 if (!message || !message.type) {
-                    this.logger.debug("Invalid mesasge structure", data);
+                    this.logger?.log(LogLevel.DEBUG, "Invalid mesasge structure", data);
                     return;
                 }
                 this.handleMessage(message);
@@ -357,7 +357,7 @@ export class DefaultClientSocketManager extends AbstractClientSocketManager {
         });
     }
     retry() {
-        this.logger.debug(`Socket connection retrying in ${this.retryDelay}ms`);
+        this.logger?.log(LogLevel.DEBUG, `Socket connection retrying in ${this.retryDelay}ms`);
         this.physicConnect();
         this.retryDelay += this.config?.reconnectTimeDeltaMs || 3000;
         this.retryTimeoutId = setTimeout(() => {

package/dist/translation/Translator.d.ts

@@ -1,13 +1,13 @@
-import { AbstractLogger } from "@clairejs/core";
+import { LogHandler } from "@clairejs/core";
 export type TranslationObject = Record<string, string>;
 export type TranslationProvider = Promise<TranslationObject>;
 export type TranslationData = Record<string, string>;
 export declare class Translator {
-    readonly logger: AbstractLogger;
+    protected readonly logger?: LogHandler | undefined;
     private translationProviders?;
     private translations;
     private translationLoadings;
-    constructor(logger: AbstractLogger);
+    constructor(logger?: LogHandler | undefined);
     setTranslations(translationProviders: Record<string, TranslationProvider>): void;
     awaitingTranslations(lang: string): Promise<void>;
     translate(lang: string, template: string, data?: TranslationData): string;

package/dist/translation/Translator.js

@@ -1,15 +1,6 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-import { AbstractLogger, Injectable } from "@clairejs/core";
+import { LogLevel } from "@clairejs/core";
 const dataKeyRegex = /{([_a-zA-Z][a-zA-Z0-9_]*)}/g;
-let Translator = class Translator {
+export class Translator {
     logger;
     translationProviders;
     translations = {};
@@ -40,7 +31,7 @@ let Translator = class Translator {
                     }
                     catch (err) {
                         //-- error loading translation
-                        this.logger.error("Error loading translation", err);
+                        this.logger?.log(LogLevel.ERROR, "Error loading translation", err);
                         this.translations[lang] = undefined;
                     }
                 }
@@ -95,9 +86,4 @@ let Translator = class Translator {
         }
         return result;
     }
-};
-Translator = __decorate([
-    Injectable(),
-    __metadata("design:paramtypes", [AbstractLogger])
-], Translator);
-export { Translator };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@clairejs/client",
-    "version": "3.3.2",
+    "version": "3.4.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "type": "module",
@@ -13,7 +13,7 @@
         "axios": "^1.3.4"
     },
     "peerDependencies": {
-        "@clairejs/core": "^3.5.2"
+        "@clairejs/core": "^3.6.5"
     },
     "devDependencies": {
         "@types/mocha": "^10.0.1",