@sogni-ai/sogni-client 3.4.0-alpha.1 → 4.0.0-alpha.2

package/src/lib/{AuthManager.ts → AuthManager/TokenAuthManager.ts}

@@ -1,100 +1,117 @@
-import { decodeToken, decodeRefreshToken } from './utils';
-import { ApiError, ApiErrorResponse } from '../ApiClient';
-import { Logger } from './DefaultLogger';
-import isNodejs from './isNodejs';
+import { decodeToken, decodeRefreshToken } from '../utils';
+import { ApiError, ApiErrorResponse } from '../../ApiClient';
+import { Logger } from '../DefaultLogger';
+import isNodejs from '../isNodejs';
 import Cookie from 'js-cookie';
-import TypedEventEmitter from './TypedEventEmitter';
+import AuthManagerBase from './AuthManagerBase';
+import { ClientOptions } from 'ws';
 
 /**
- * Tokens object, containing the token and refresh token
- * @typedef {Object} Tokens
- * @property {string} [token] - The JWT token. Optonal, if missing it will be retrieved from the server
+ * Token object, containing the token and refresh token
+ * @property {string} token - The JWT token
  * @property {string} refreshToken - The refresh token
  */
-export interface Tokens {
-  token?: string;
+export interface TokenAuthData {
+  token: string;
   refreshToken: string;
 }
 
-export type AuthUpdatedEvent =
-  | { token: string; refreshToken: string; walletAddress: string }
-  | { token: null; refreshToken: null; walletAddress: null };
-
-interface AuthManagerEvents {
-  updated: AuthUpdatedEvent;
-  refreshFailed: ApiErrorResponse;
-}
-
-class AuthManager extends TypedEventEmitter<AuthManagerEvents> {
+class TokenAuthManager extends AuthManagerBase<TokenAuthData | null> {
   private _token?: string;
   private _tokenExpiresAt: Date = new Date(0);
   private _refreshToken?: string;
   private _refreshTokenExpiresAt: Date = new Date(0);
-  private _logger: Logger;
   private _baseUrl: string;
-  private _walletAddress?: string;
   private _renewTokenPromise?: Promise<string>;
 
   constructor(baseUrl: string, logger: Logger) {
-    super();
-    this._logger = logger;
+    super(logger);
     this._baseUrl = baseUrl;
   }
 
-  get refreshToken() {
-    return this._refreshToken;
-  }
-
-  get walletAddress() {
-    return this._walletAddress;
-  }
-
   get isAuthenticated() {
     return !!this._refreshToken && this._refreshTokenExpiresAt > new Date();
   }
 
-  private _updateCookies() {
-    if (isNodejs) {
-      return;
-    }
-    const token = this._token;
-    if (token) {
-      Cookie.set('authorization', token, {
-        domain: '.sogni.ai',
-        expires: 1
-      });
-    } else {
-      Cookie.remove('authorization', {
-        domain: '.sogni.ai'
-      });
+  async backup() {
+    if (this._token && this._refreshToken) {
+      return { token: this._token, refreshToken: this._refreshToken };
     }
+    return null;
   }
 
-  async setTokens({ refreshToken, token }: { refreshToken: string; token?: string }) {
+  async authenticate({ refreshToken, token }: TokenAuthData) {
+    // If there is a token, and it is not expired, authenticate with it
     if (token) {
-      this._updateTokens({ token, refreshToken });
-      return;
+      const { expiresAt } = decodeToken(token);
+      if (expiresAt > new Date()) {
+        this._updateTokens({ token, refreshToken });
+        this.emit('updated', true);
+        return;
+      }
     }
+    // If token is expired, try to renew it with the refresh token
     this._refreshToken = refreshToken;
     const { expiresAt: refreshExpiresAt } = decodeRefreshToken(refreshToken);
     this._refreshTokenExpiresAt = refreshExpiresAt;
-    await this.renewToken();
+    await this._renewTokenSafe();
+    this.emit('updated', true);
   }
 
-  async getToken(): Promise<string | undefined> {
+  clear() {
+    // Prevent duplicate events
+    if (!this._token && !this._refreshToken) {
+      return;
+    }
+    this._refreshToken = undefined;
+    this._refreshTokenExpiresAt = new Date(0);
+    this._token = undefined;
+    this._tokenExpiresAt = new Date(0);
+    this.emit('updated', false);
+  }
+
+  async authenticateRequest(option: RequestInit): Promise<RequestInit> {
     //If there is a token, and it is not expired, return it
+    if (this._token && this._tokenExpiresAt > new Date()) {
+      return { ...option, headers: { ...option.headers, Authorization: this._token } };
+    }
+    //If there is no refresh token, return undefined, to make unauthorized requests
+    if (!this._refreshToken) {
+      return option;
+    }
+    //If there is a refresh token, try to renew the token
+    const token = await this._renewTokenSafe();
+    return { ...option, headers: { ...option.headers, Authorization: token } };
+  }
+
+  async socketOptions(): Promise<ClientOptions | undefined> {
+    if (!isNodejs) {
+      return undefined;
+    }
+    const token = await this._getToken();
+    if (!token) {
+      return undefined;
+    }
+    return {
+      headers: {
+        Authorization: token
+      }
+    };
+  }
+
+  private async _getToken() {
     if (this._token && this._tokenExpiresAt > new Date()) {
       return this._token;
     }
     //If there is no refresh token, return undefined, to make unauthorized requests
     if (!this._refreshToken) {
-      return;
+      return undefined;
     }
     //If there is a refresh token, try to renew the token
-    return this.renewToken();
+    return this._renewTokenSafe();
   }
 
-  async renewToken(): Promise<string> {
+  private async _renewTokenSafe(): Promise<string> {
     if (this._renewTokenPromise) {
       return this._renewTokenPromise;
     }
@@ -105,33 +122,41 @@ class AuthManager extends TypedEventEmitter<AuthManagerEvents> {
     return this._renewTokenPromise;
   }
 
-  clear() {
-    // Prevent duplicate events
-    if (!this._token && !this._refreshToken) {
-      return;
-    }
-    this._refreshToken = undefined;
-    this._refreshTokenExpiresAt = new Date(0);
-    this._token = undefined;
-    this._tokenExpiresAt = new Date(0);
-    this._walletAddress = undefined;
-    this.emit('updated', { token: null, refreshToken: null, walletAddress: null });
-  }
-
   private _updateTokens({ token, refreshToken }: { token: string; refreshToken: string }) {
     // Prevent duplicate events
     if (this._token === token && this._refreshToken === refreshToken) {
       return;
     }
     this._token = token;
-    const { expiresAt, walletAddress } = decodeToken(token);
-    this._walletAddress = walletAddress;
+    const { expiresAt } = decodeToken(token);
     this._tokenExpiresAt = expiresAt;
     this._refreshToken = refreshToken;
     const { expiresAt: refreshExpiresAt } = decodeRefreshToken(refreshToken);
     this._refreshTokenExpiresAt = refreshExpiresAt;
     this._updateCookies();
-    this.emit('updated', { token, refreshToken, walletAddress });
+    this.emit('updated', true);
+  }
+
+  /**
+   * This is a fallback for browsers, where we can't set headers on WebSocket requests.
+   * Normally a browser should use CookieAuthManager
+   * @private
+   */
+  private _updateCookies() {
+    if (isNodejs) {
+      return;
+    }
+    const token = this._token;
+    if (token) {
+      Cookie.set('authorization', token, {
+        domain: '.sogni.ai',
+        expires: 1
+      });
+    } else {
+      Cookie.remove('authorization', {
+        domain: '.sogni.ai'
+      });
+    }
   }
 
   private async _renewToken(): Promise<string> {
@@ -150,16 +175,11 @@ class AuthManager extends TypedEventEmitter<AuthManagerEvents> {
     try {
       responseData = await response.json();
     } catch (e) {
-      this.emit('refreshFailed', {
-        status: 'error',
-        errorCode: 0,
-        message: 'Failed to parse response'
-      });
+      this.clear();
       this._logger.error('Failed to parse response:', e);
       throw new Error('Failed to parse response');
     }
     if (!response.ok) {
-      this.emit('refreshFailed', responseData);
       this.clear();
       throw new ApiError(response.status, responseData as ApiErrorResponse);
     }
@@ -169,4 +189,4 @@ class AuthManager extends TypedEventEmitter<AuthManagerEvents> {
   }
 }
 
-export default AuthManager;
+export default TokenAuthManager;

package/src/lib/AuthManager/index.ts

@@ -0,0 +1,8 @@
+import CookieAuthManager from './CookieAuthManager';
+import TokenAuthManager, { TokenAuthData } from './TokenAuthManager';
+
+export type { TokenAuthData };
+
+export { CookieAuthManager, TokenAuthManager };
+
+export type AuthManager = CookieAuthManager | TokenAuthManager;

package/src/lib/RestClient.ts

@@ -2,7 +2,7 @@ import { ApiError, ApiErrorResponse } from '../ApiClient';
 import TypedEventEmitter, { EventMap } from './TypedEventEmitter';
 import { JSONValue } from '../types/json';
 import { Logger } from './DefaultLogger';
-import AuthManager from './AuthManager';
+import { AuthManager } from './AuthManager';
 
 class RestClient<E extends EventMap = never> extends TypedEventEmitter<E> {
   readonly baseUrl: string;
@@ -29,15 +29,8 @@ class RestClient<E extends EventMap = never> extends TypedEventEmitter<E> {
   }
 
   private async request<T = JSONValue>(url: string, options: RequestInit = {}): Promise<T> {
-    const token = await this.auth.getToken();
-    return fetch(url, {
-      ...options,
-      credentials: 'include',
-      headers: {
-        ...(options.headers || {}),
-        ...(token ? { Authorization: token } : {})
-      }
-    }).then((r) => this.processResponse(r) as T);
+    const init = await this.auth.authenticateRequest(options);
+    return fetch(url, init).then((r) => this.processResponse(r) as T);
   }
 
   private async processResponse(response: Response): Promise<JSONValue> {
@@ -48,6 +41,10 @@ class RestClient<E extends EventMap = never> extends TypedEventEmitter<E> {
       this._logger.error('Failed to parse response:', e);
       throw new Error('Failed to parse response');
     }
+    // 401 means that the client instance is not authenticated, so we clear the authentication
+    if (response.status === 401 && this.auth.isAuthenticated) {
+      this.auth.clear();
+    }
     if (!response.ok) {
       throw new ApiError(response.status, responseData as ApiErrorResponse);
     }

package/dist/lib/AuthManager.d.ts

@@ -1,51 +0,0 @@
-import { ApiErrorResponse } from '../ApiClient';
-import { Logger } from './DefaultLogger';
-import TypedEventEmitter from './TypedEventEmitter';
-/**
- * Tokens object, containing the token and refresh token
- * @typedef {Object} Tokens
- * @property {string} [token] - The JWT token. Optonal, if missing it will be retrieved from the server
- * @property {string} refreshToken - The refresh token
- */
-export interface Tokens {
-    token?: string;
-    refreshToken: string;
-}
-export type AuthUpdatedEvent = {
-    token: string;
-    refreshToken: string;
-    walletAddress: string;
-} | {
-    token: null;
-    refreshToken: null;
-    walletAddress: null;
-};
-interface AuthManagerEvents {
-    updated: AuthUpdatedEvent;
-    refreshFailed: ApiErrorResponse;
-}
-declare class AuthManager extends TypedEventEmitter<AuthManagerEvents> {
-    private _token?;
-    private _tokenExpiresAt;
-    private _refreshToken?;
-    private _refreshTokenExpiresAt;
-    private _logger;
-    private _baseUrl;
-    private _walletAddress?;
-    private _renewTokenPromise?;
-    constructor(baseUrl: string, logger: Logger);
-    get refreshToken(): string | undefined;
-    get walletAddress(): string | undefined;
-    get isAuthenticated(): boolean;
-    private _updateCookies;
-    setTokens({ refreshToken, token }: {
-        refreshToken: string;
-        token?: string;
-    }): Promise<void>;
-    getToken(): Promise<string | undefined>;
-    renewToken(): Promise<string>;
-    clear(): void;
-    private _updateTokens;
-    private _renewToken;
-}
-export default AuthManager;

package/dist/lib/AuthManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AuthManager.js","sourceRoot":"","sources":["../../src/lib/AuthManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,mCAA0D;AAC1D,4CAA0D;AAE1D,0DAAkC;AAClC,0DAA+B;AAC/B,4EAAoD;AAsBpD,MAAM,WAAY,SAAQ,2BAAoC;IAU5D,YAAY,OAAe,EAAE,MAAc;QACzC,KAAK,EAAE,CAAC;QATF,oBAAe,GAAS,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;QAEpC,2BAAsB,GAAS,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;QAQjD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,sBAAsB,GAAG,IAAI,IAAI,EAAE,CAAC;IAC1E,CAAC;IAEO,cAAc;QACpB,IAAI,kBAAQ,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,KAAK,EAAE,CAAC;YACV,mBAAM,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,EAAE;gBACjC,MAAM,EAAE,WAAW;gBACnB,OAAO,EAAE,CAAC;aACX,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,mBAAM,CAAC,MAAM,CAAC,eAAe,EAAE;gBAC7B,MAAM,EAAE,WAAW;aACpB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEK,SAAS;6DAAC,EAAE,YAAY,EAAE,KAAK,EAA4C;YAC/E,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;gBAC5C,OAAO;YACT,CAAC;YACD,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;YAClC,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAG,IAAA,0BAAkB,EAAC,YAAY,CAAC,CAAC;YACzE,IAAI,CAAC,sBAAsB,GAAG,gBAAgB,CAAC;YAC/C,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAC1B,CAAC;KAAA;IAEK,QAAQ;;YACZ,uDAAuD;YACvD,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;gBACrD,OAAO,IAAI,CAAC,MAAM,CAAC;YACrB,CAAC;YACD,+EAA+E;YAC/E,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;gBACxB,OAAO;YACT,CAAC;YACD,qDAAqD;YACrD,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;QAC3B,CAAC;KAAA;IAEK,UAAU;;YACd,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC;YACjC,CAAC;YACD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YAC7C,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE;gBACnC,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;YACtC,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,CAAC,kBAAkB,CAAC;QACjC,CAAC;KAAA;IAED,KAAK;QACH,2BAA2B;QAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxC,OAAO;QACT,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,sBAAsB,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;QACnC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACjF,CAAC;IAEO,aAAa,CAAC,EAAE,KAAK,EAAE,YAAY,EAA2C;QACpF,2BAA2B;QAC3B,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,IAAI,IAAI,CAAC,aAAa,KAAK,YAAY,EAAE,CAAC;YACjE,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,IAAA,mBAAW,EAAC,KAAK,CAAC,CAAC;QACxD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAG,IAAA,0BAAkB,EAAC,YAAY,CAAC,CAAC;QACzE,IAAI,CAAC,sBAAsB,GAAG,gBAAgB,CAAC;QAC/C,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;IAC/D,CAAC;IAEa,WAAW;;YACvB,IAAI,IAAI,CAAC,sBAAsB,GAAG,IAAI,IAAI,EAAE,EAAE,CAAC;gBAC7C,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC3C,CAAC;YACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,2BAA2B,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC3E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAChC,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;aAC3D,CAAC,CAAC;YACH,IAAI,YAAiB,CAAC;YACtB,IAAI,CAAC;gBACH,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACvC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;oBACzB,MAAM,EAAE,OAAO;oBACf,SAAS,EAAE,CAAC;oBACZ,OAAO,EAAE,0BAA0B;iBACpC,CAAC,CAAC;gBACH,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,CAAC,CAAC,CAAC;gBACnD,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;YAC9C,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;gBACzC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,MAAM,IAAI,oBAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAgC,CAAC,CAAC;YACxE,CAAC;YACD,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC;YAClD,IAAI,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;YAC5C,OAAO,IAAI,CAAC,MAAO,CAAC;QACtB,CAAC;KAAA;CACF;AAED,kBAAe,WAAW,CAAC"}