@cloudbase/oauth 2.4.5-beta.0 → 2.5.1-beta.0

package/src/captcha/captcha.ts

@@ -1,6 +1,6 @@
-import { SimpleStorage, RequestFunction } from '../oauth2client/interface';
-import { AuthClientRequestOptions } from "../oauth2client/models";
-import { defaultStorage } from "../oauth2client/oauth2client";
+import { SimpleStorage, RequestFunction } from '../oauth2client/interface'
+import { AuthClientRequestOptions } from '../oauth2client/models'
+import { defaultStorage } from '../oauth2client/oauth2client'
 
 export interface CaptchaOptions {
   clientId: string
@@ -31,8 +31,8 @@ export interface GetCaptchaResponse {
 const GET_CAPTCHA_URL = '/auth/v1/captcha/init'
 
 export class Captcha {
-  private _config: CaptchaOptions;
-  private _tokenSectionName: string;
+  private config: CaptchaOptions
+  private tokenSectionName: string
 
   /**
    * constructor
@@ -40,13 +40,13 @@ export class Captcha {
    */
   constructor(opts: CaptchaOptions) {
     if (!opts.openURIWithCallback) {
-      opts.openURIWithCallback = this._getDefaultOpenURIWithCallback()
+      opts.openURIWithCallback = this.getDefaultOpenURIWithCallback()
     }
     if (!opts.storage) {
       opts.storage = defaultStorage
     }
-    this._config = opts
-    this._tokenSectionName = 'captcha_' + opts.clientId
+    this.config = opts
+    this.tokenSectionName = `captcha_${opts.clientId}`
   }
 
   /**
@@ -59,110 +59,107 @@ export class Captcha {
     options?: CaptchaRequestOptions,
   ): Promise<T> {
     if (!options) {
-      options = {};
+      options = {}
     }
     if (!options.method) {
       options.method = 'GET'
     }
-    const state = options.method + ":" + url
-    let reqURL = url;
+    const state = `${options.method}:${url}`
+    let reqURL = url
     if (options.withCaptcha) {
-      reqURL = await this._appendCaptchaTokenToURL(url, state, false);
+      reqURL = await this.appendCaptchaTokenToURL(url, state, false)
     }
 
-    let resp: T;
+    let resp: T
     try {
-      resp = await this._config.request<T>(reqURL, options)
+      resp = await this.config.request<T>(reqURL, options)
     } catch (err) {
       if (err.error === 'captcha_required' || err.error === 'captcha_invalid') {
-        url = await this._appendCaptchaTokenToURL(url, state, err.error === 'captcha_invalid')
-        return this._config.request<T>(url, options)
-      } else {
-        return Promise.reject(err)
+        url = await this.appendCaptchaTokenToURL(url, state, err.error === 'captcha_invalid')
+        return this.config.request<T>(url, options)
       }
+      return Promise.reject(err)
     }
     return resp
   }
 
-  private _getDefaultOpenURIWithCallback(): OpenURIWithCallbackFuction {
+  private getDefaultOpenURIWithCallback(): OpenURIWithCallbackFuction {
     if (window.location.search.indexOf('__captcha') > 0) {
-      document.body.style.display = 'none';
+      document.body.style.display = 'none'
     }
     if (document.getElementById('captcha_panel_wrap') === null) {
-      var elementDiv = document.createElement('div');
-      elementDiv.style.cssText =
-        'background-color: rgba(0, 0, 0, 0.7);position: fixed;left: 0px;right: 0px;top: 0px;bottom: 0px;padding: 9vw 0 0 0;display: none;z-index:100;';
-      elementDiv.setAttribute('id', 'captcha_panel_wrap');
+      const elementDiv = document.createElement('div')
+      elementDiv.style.cssText =        'background-color: rgba(0, 0, 0, 0.7);position: fixed;left: 0px;right: 0px;top: 0px;bottom: 0px;padding: 9vw 0 0 0;display: none;z-index:100;'
+      elementDiv.setAttribute('id', 'captcha_panel_wrap')
       setTimeout(() => {
-        document.body.appendChild(elementDiv);
+        document.body.appendChild(elementDiv)
       }, 0)
     }
-    return this._defaultOpenURIWithCallback
+    return this.defaultOpenURIWithCallback
   }
 
   /**
    * 默认通过浏览器打开网页并获取回调
    */
-  private async _defaultOpenURIWithCallback(url: string): Promise<CaptchaToken> {
-    const target = document.getElementById('captcha_panel_wrap'),
-      iframe = document.createElement('iframe')
-    target.innerHTML = '';
+  private async defaultOpenURIWithCallback(url: string): Promise<CaptchaToken> {
+    const target = document.getElementById('captcha_panel_wrap')
+    const iframe = document.createElement('iframe')
+    target.innerHTML = ''
     iframe.setAttribute('src', url)
     iframe.setAttribute('id', 'review-panel-iframe')
-    iframe.style.cssText = 'min-width:355px;display:block;height:355px;margin:0 auto;background-color: rgb(255, 255, 255);border: none;';
-    target.appendChild(iframe);
-    target.style.display = 'block';
+    iframe.style.cssText = 'min-width:355px;display:block;height:355px;margin:0 auto;background-color: rgb(255, 255, 255);border: none;'
+    target.appendChild(iframe)
+    target.style.display = 'block'
     return new Promise<CaptchaToken>((resolve, reject) => {
       iframe.onload = function () {
         try {
-          var windowLocation = window.location;
-          var iframeLocation = iframe.contentWindow.location;
+          const windowLocation = window.location
+          const iframeLocation = iframe.contentWindow.location
           if (
-            iframeLocation.host +
-            iframeLocation.pathname ===
-            windowLocation.host +
-            windowLocation.pathname
+            iframeLocation.host
+            + iframeLocation.pathname
+            === windowLocation.host
+            + windowLocation.pathname
           ) {
-            target.style.display = 'none';
-            const iframeUrlParams = new URLSearchParams(iframeLocation.search);
-            const captchToken = iframeUrlParams.get('captcha_token');
+            target.style.display = 'none'
+            const iframeUrlParams = new URLSearchParams(iframeLocation.search)
+            const captchToken = iframeUrlParams.get('captcha_token')
             if (captchToken) {
               return resolve({
                 captcha_token: captchToken,
-                expires_in: Number(iframeUrlParams.get('expires_in'))
+                expires_in: Number(iframeUrlParams.get('expires_in')),
               })
             }
             return reject({
               error: iframeUrlParams.get('error'),
-              error_description: iframeUrlParams.get('error_description')
+              error_description: iframeUrlParams.get('error_description'),
             })
-          } else {
-            target.style.display = 'block';
           }
+          target.style.display = 'block'
         } catch (error) {
-          target.style.display = 'block';
+          target.style.display = 'block'
         }
-      };
+      }
     })
   }
   /**
-   * _getCaptchaToken 获取captchaToken
+   * getCaptchaToken 获取captchaToken
    */
-  private async _getCaptchaToken(forceNewToken: boolean, state: string): Promise<string> {
+  private async getCaptchaToken(forceNewToken: boolean, state: string): Promise<string> {
     if (!forceNewToken) {
       // 如果本地存在，则直接返回
-      const captchaToken = await this._findCaptchaToken()
+      const captchaToken = await this.findCaptchaToken()
       if (captchaToken) {
         return captchaToken
       }
     }
-    const redirectURL = window.location.origin + window.location.pathname + "?__captcha=on"
-    const captchaTokenResp = await this._config.request<GetCaptchaResponse>(GET_CAPTCHA_URL, {
+    const redirectURL = `${window.location.origin + window.location.pathname}?__captcha=on`
+    const captchaTokenResp = await this.config.request<GetCaptchaResponse>(GET_CAPTCHA_URL, {
       method: 'POST',
       body: {
-        client_id: this._config.clientId,
+        client_id: this.config.clientId,
         redirect_uri: redirectURL,
-        state: state
+        state,
       },
       withCredentials: false,
     })
@@ -171,52 +168,48 @@ export class Captcha {
         captcha_token: captchaTokenResp.captcha_token,
         expires_in: captchaTokenResp.expires_in,
       }
-      this._saveCaptchaToken(captchaToken)
+      this.saveCaptchaToken(captchaToken)
       return captchaTokenResp.captcha_token
     }
-    const captchaToken = await this._config.openURIWithCallback(captchaTokenResp.url)
-    this._saveCaptchaToken(captchaToken)
+    const captchaToken = await this.config.openURIWithCallback(captchaTokenResp.url)
+    this.saveCaptchaToken(captchaToken)
     return captchaToken.captcha_token
   }
 
-  private async _appendCaptchaTokenToURL(url: string, state: string, forceNewToken: boolean): Promise<string> {
-    const captchaToken = await this._getCaptchaToken(forceNewToken, state);
-    if (url.indexOf("?") > 0) {
-      url += "&captcha_token=" + captchaToken
+  private async appendCaptchaTokenToURL(url: string, state: string, forceNewToken: boolean): Promise<string> {
+    const captchaToken = await this.getCaptchaToken(forceNewToken, state)
+    if (url.indexOf('?') > 0) {
+      url += `&captcha_token=${captchaToken}`
     } else {
-      url += "?captcha_token=" + captchaToken
+      url += `?captcha_token=${captchaToken}`
     }
     return url
   }
 
-  private async _saveCaptchaToken(token: CaptchaToken) {
-    token.expires_at = new Date(
-      Date.now() + (token.expires_in - 10) * 1000,
-    );
-    const tokenStr: string = JSON.stringify(token);
-    await this._config.storage.setItem(this._tokenSectionName, tokenStr);
+  private async saveCaptchaToken(token: CaptchaToken) {
+    token.expires_at = new Date(Date.now() + (token.expires_in - 10) * 1000,)
+    const tokenStr: string = JSON.stringify(token)
+    await this.config.storage.setItem(this.tokenSectionName, tokenStr)
   }
 
-  private async _findCaptchaToken(): Promise<string> {
-    const tokenStr: string = await this._config.storage.getItem(
-      this._tokenSectionName,
-    );
+  private async findCaptchaToken(): Promise<string> {
+    const tokenStr: string = await this.config.storage.getItem(this.tokenSectionName,)
     if (tokenStr !== undefined && tokenStr !== null) {
       try {
-        const captchaToken = JSON.parse(tokenStr);
+        const captchaToken = JSON.parse(tokenStr)
         if (captchaToken?.expires_at) {
-          captchaToken.expires_at = new Date(captchaToken.expires_at);
+          captchaToken.expires_at = new Date(captchaToken.expires_at)
         }
-        const isExpired = captchaToken.expires_at < new Date();
+        const isExpired = captchaToken.expires_at < new Date()
         if (isExpired) {
           return null
         }
         return captchaToken.captcha_token
       } catch (error) {
-        await this._config.storage.removeItem(this._tokenSectionName);
+        await this.config.storage.removeItem(this.tokenSectionName)
         return null
       }
     }
     return null
   }
-}
+}

package/src/index.ts

@@ -1,7 +1,11 @@
-export { Syntax, ErrorType } from './oauth2client/consts';
-
 import { OAuth2Client } from './oauth2client/oauth2client'
 
+import { AuthOptions, Auth } from './auth/apis'
+
+import * as authModels from './auth/models'
+
+export { Syntax, ErrorType } from './oauth2client/consts'
+
 export {
   defaultStorage,
   defaultRequest,
@@ -9,24 +13,19 @@ export {
   toResponseError,
   generateRequestId,
   OAuth2Client,
-} from './oauth2client/oauth2client';
+} from './oauth2client/oauth2client'
 
-export { AuthClient, SimpleStorage } from './oauth2client/interface';
+export { AuthClient, SimpleStorage } from './oauth2client/interface'
 
-// import { Credentials } from './oauth2client/models'
 export {
   Credentials,
   ResponseError,
   OAuth2ClientOptions,
   AuthClientRequestOptions,
-} from './oauth2client/models';
-
-import { AuthOptions, Auth } from './auth/apis'
-
-export { AuthOptions, Auth } from './auth/apis';
+} from './oauth2client/models'
 
-import * as authModels from './auth/models';
-export { authModels };
+export { AuthOptions, Auth } from './auth/apis'
+export { authModels }
 
 
 export class CloudbaseOAuth {
@@ -37,12 +36,12 @@ export class CloudbaseOAuth {
     const { apiOrigin, clientId } = authOptions
     this.oauth2client = new OAuth2Client({
       apiOrigin,
-      clientId
+      clientId,
     })
 
     this.authApi = new Auth({
       credentialsClient: this.oauth2client,
-      ...authOptions
+      ...authOptions,
     })
   }
 }

package/src/oauth2client/interface.ts

@@ -1,13 +1,9 @@
-import { Credentials, AuthClientRequestOptions } from './models';
+import { Credentials, AuthClientRequestOptions } from './models'
 
 /**
  * the interface for the Oauth2Client
  */
 export abstract class AuthClient {
-  /**
-   * Sets the auth credentials.
-   */
-  abstract setCredentials(credentials?: Credentials): void;
   /**
    * Provides an alternative fetch api request implementation with auth credentials
    * if options.withCredentials:true, the request will auto add Authorization: Bearer <AccessToken> in the request
@@ -16,6 +12,10 @@ export abstract class AuthClient {
    *     - unauthenticated: has no validate access token
    */
   abstract request: RequestFunction;
+  /**
+   * Sets the auth credentials.
+   */
+  abstract setCredentials(credentials?: Credentials): void;
 
   /**
    * get the current accessToken from AuthClient, you can use this to detect login status

package/src/oauth2client/models.ts

@@ -1,32 +1,32 @@
-import {SimpleStorage} from './interface';
-import {ErrorType} from './consts';
+import { SimpleStorage } from './interface'
+import { ErrorType } from './consts'
 
 /** Credentials **/
 export interface Credentials {
-    token_type?: string | null;
-    access_token?: string | null;
-    refresh_token?: string | null;
-    scope?: string | null;
-    expires_in?: number | null;
-    expires_at?: Date | null;
-    sub?: string | null;
-    groups?: string[] | null;
+  token_type?: string | null;
+  access_token?: string | null;
+  refresh_token?: string | null;
+  scope?: string | null;
+  expires_in?: number | null;
+  expires_at?: Date | null;
+  sub?: string | null;
+  groups?: string[] | null;
 }
 
 /** An Error For all concern **/
 export interface ResponseError {
-    error: ErrorType;
-    error_description?: string | null;
-    error_uri?: string | null;
-    details?: any | null;
+  error: ErrorType;
+  error_description?: string | null;
+  error_uri?: string | null;
+  details?: any | null;
 }
 
 export interface RequestOptions {
-    body?: any | null;
-    headers?: any | null;
-    method?: string;
+  body?: any | null;
+  headers?: any | null;
+  method?: string;
 
-    [key: string]: any;
+  [key: string]: any;
 }
 
 export type RequestFunction = <T>(
@@ -35,28 +35,28 @@ export type RequestFunction = <T>(
 ) => Promise<T>;
 
 export interface AuthClientRequestOptions extends RequestOptions {
-    headers?: {
-        'x-request-id'?: string;
-        [key: string]: any;
-    } | null;
-    withCredentials?: boolean;
-    retry?: number;
-
+  headers?: {
+    'x-request-id'?: string;
     [key: string]: any;
+  } | null;
+  withCredentials?: boolean;
+  retry?: number;
+
+  [key: string]: any;
 }
 
 export interface OAuth2ClientOptions {
-    devMode?: boolean;
-    apiOrigin: string;
-    clientId: string;
-    // default value is 1,min value is 0, max value is 5
-    retry?: number;
-    baseRequest?: <T>(url: string, options?: RequestOptions) => Promise<T>;
-    // Storage, default is localStorage, setItem(k, v), getItem(k),removeItem(k)
-    storage?: SimpleStorage;
-    clientSecret?: string;
-    refreshTokenFunc?: (refreshToken?: string) => Promise<Credentials>;
-    // set the token in url query instead of header
-    tokenInURL?: boolean;
-    headers?: { [key: string]: string };
+  devMode?: boolean;
+  apiOrigin: string;
+  clientId: string;
+  // default value is 1,min value is 0, max value is 5
+  retry?: number;
+  baseRequest?: <T>(url: string, options?: RequestOptions) => Promise<T>;
+  // Storage, default is localStorage, setItem(k, v), getItem(k),removeItem(k)
+  storage?: SimpleStorage;
+  clientSecret?: string;
+  refreshTokenFunc?: (refreshToken?: string) => Promise<Credentials>;
+  // set the token in url query instead of header
+  tokenInURL?: boolean;
+  headers?: { [key: string]: string };
 }