@cloudbase/auth 2.5.47-beta.0 → 2.5.48-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/auth",
-  "version": "2.5.47-beta.0",
+  "version": "2.5.48-beta.0",
   "description": "cloudbase javascript sdk auth componets",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -28,9 +28,9 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "@cloudbase/oauth": "^2.5.47-beta.0",
-    "@cloudbase/types": "^2.5.47-beta.0",
-    "@cloudbase/utilities": "^2.5.47-beta.0"
+    "@cloudbase/oauth": "^2.5.48-beta.0",
+    "@cloudbase/types": "^2.5.48-beta.0",
+    "@cloudbase/utilities": "^2.5.48-beta.0"
   },
-  "gitHead": "5eff80cfe47e3cf6e3067f1d9bba8753565e5b79"
+  "gitHead": "5e97c7a104dabec77e18d2237b02432f2270b3f5"
 }

package/src/adapter.ts

@@ -0,0 +1,161 @@
+import adapterForWxMp from 'cloudbase-adapter-wx_mp'
+import { AuthOptions } from '@cloudbase/oauth'
+
+declare const wx: any
+
+class OauthClientStorageBase {
+  public readonly localStorage
+  constructor(config?: { localStorage: any /* StorageInterface */ }) {
+    this.localStorage = config?.localStorage || (globalThis as any).localStorage
+  }
+  /**
+   * Get Item
+   * @param {string} key
+   * @return {Promise<string | null>}
+   */
+  async getItem(key: string): Promise<string | null> {
+    return this.localStorage.getItem(key)
+  }
+
+  /**
+   * Remove Item.
+   * @param {string} key
+   * @return {Promise<void>}
+   */
+  async removeItem(key: string) {
+    this.localStorage.removeItem(key)
+  }
+
+  /**
+   * Set Item.
+   * @param {string} key
+   * @param {string} value
+   * @return {Promise<void>}
+   */
+  async setItem(key: string, value: string): Promise<void> {
+    this.localStorage.setItem(key, value)
+  }
+
+  getItemSync(key: string): string | null {
+    return this.localStorage.getItem(key)
+  }
+
+  setItemSync(key: string, value: string) {
+    this.localStorage.setItem(key, value)
+  }
+
+  removeItemSync(key: string) {
+    this.localStorage.removeItem(key)
+  }
+}
+
+/**
+ * copy to git@git.woa.com:QBase/lcap/datasource.git/packages/cloud-sdk/common
+ * 同步修改
+ */
+const URL_REG = /^[^:]+:\/\/[^/]+(\/[^?#]+)/
+
+function generateOauthClientRequest(reqClass) {
+  return async function (
+    url: string,
+    options?: {
+      body?: any | null
+      headers?: any | null
+      method?: string
+      [key: string]: any
+    },
+  ) {
+    const requestId = options?.headers?.['x-request-id']
+
+    return new Promise((resolve, reject) => {
+      // Objects must be copied to prevent modification of data such as body.
+      const copyOptions = Object.assign({}, options)
+      if (copyOptions.body && typeof copyOptions.body !== 'string') {
+        copyOptions.body = JSON.stringify(copyOptions.body)
+      }
+
+      const task = wx.request({
+        url,
+        data: copyOptions.body,
+        timeout: reqClass._timeout,
+        method: copyOptions.method || 'GET',
+        header: copyOptions.headers,
+        success(res) {
+          if (res.code) {
+            res = {
+              error: res.code,
+              error_description: res.message || res.code,
+              request_id: res.requestId,
+            }
+          }
+
+          if (!res.request_id) {
+            res.request_id = res.request_id || requestId
+          }
+
+          if (res.error) {
+            res.error_uri = getUrlPath(url)
+            reject(res)
+          }
+          resolve(res.data || {})
+        },
+        fail(err) {
+          reject({
+            error: 'unreachable',
+            error_description: (err as Error).message,
+          })
+        },
+        complete(err) {
+          if (!err || !err.errMsg) {
+            return
+          }
+          if (!reqClass._timeout || reqClass._restrictedMethods.indexOf('request') === -1) {
+            return
+          }
+          const { errMsg } = err
+          if (errMsg === 'request:fail timeout') {
+            console.warn(reqClass._timeoutMsg)
+            try {
+              task.abort()
+            } catch (e) {}
+          }
+        },
+      })
+    })
+  }
+}
+
+/**
+ * Get url path.
+ * @param {string} url
+ * @return {string}
+ */
+function getUrlPath(url: string) {
+  // return path if matched, or original url
+  return URL_REG.test(url) ? RegExp.$1 : url
+}
+
+export const useAuthAdapter = (config: AuthOptions) => {
+  if (!adapterForWxMp.isMatch() || (config.storage && config.baseRequest)) return config
+
+  const authOptions: any = {}
+  try {
+    const { localStorage, reqClass: ReqClass } = adapterForWxMp.genAdapter()
+    if (localStorage) {
+      authOptions.storage = new OauthClientStorageBase({ localStorage })
+    }
+    if (ReqClass) {
+      const reqClass = new ReqClass({
+        timeout: 10000,
+        restrictedMethods: ['get', 'post', 'upload', 'download', 'request'],
+      })
+      authOptions.request = generateOauthClientRequest(reqClass)
+    }
+
+    return { ...config, ...authOptions }
+  } catch (e) {
+    console.error('adapter generate fail:', e)
+  }
+
+  return config
+}

package/src/index.ts

@@ -6,9 +6,12 @@ import { ICloudbaseAuthConfig, IUser, IUserInfo, ILoginState } from '@cloudbase/
 import { ICloudbaseComponent } from '@cloudbase/types/component'
 
 import { authModels, CloudbaseOAuth, AuthOptions, Credentials } from '@cloudbase/oauth'
-import { ProviderSubType } from '@cloudbase/oauth/dist/cjs/auth/models'
+import { GrantProviderTokenResponse, ProviderSubType } from '@cloudbase/oauth/dist/cjs/auth/models'
+import { useAuthAdapter } from './adapter'
+import adapterForWxMp from 'cloudbase-adapter-wx_mp'
 
 declare const cloudbase: ICloudbase
+declare const wx: any
 
 const { printWarn, throwError } = utils
 const { ERRORS, COMMUNITY_SITE_URL } = constants
@@ -442,6 +445,307 @@ class Auth {
     return this.createLoginState()
   }
 
+  /**
+   * 小程序openId静默登录
+   * @returns {Promise<LoginState>}
+   * @memberof Auth
+   */
+  @catchErrorsDecorator({
+    title: '小程序openId静默登录失败',
+    messages: [
+      '请确认以下各项：',
+      '  1 - 当前环境是否开启了小程序openId静默登录',
+      '  2 - 调用 auth().signInWithOpenId() 的语法或参数是否正确',
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
+  })
+  public async signInWithOpenId({ useWxCloud = true } = {}): Promise<LoginState> {
+    if (!adapterForWxMp.isMatch()) {
+      throw Error('wx api undefined')
+    }
+
+    if (useWxCloud) {
+      const wxInfo = wx.getAccountInfoSync().miniProgram
+      let result: GrantProviderTokenResponse | undefined = undefined
+      let credentials: Credentials | undefined = undefined
+      try {
+        result = await this.oauthInstance.authApi.grantProviderToken(
+          {
+            provider_id: wxInfo?.appId,
+            provider_params: {
+              provider_code_type: 'open_id',
+            },
+          },
+          true,
+        )
+
+        if ((result as any)?.error_code) {
+          throw result
+        }
+
+        credentials = await this.oauthInstance.authApi.signInWithProvider(
+          { provider_token: result.provider_token },
+          true,
+        )
+
+        if ((credentials as any)?.error_code) {
+          throw credentials
+        }
+      } catch (error) {
+        throw error
+      }
+
+      await this.oauthInstance.oauth2client.setCredentials(credentials as Credentials)
+    } else {
+      await new Promise((resolve, reject) => {
+        const wxInfo = wx.getAccountInfoSync().miniProgram
+        wx.login({
+          success: async (res: { code: string }) => {
+            const providerId = wxInfo?.appId
+            try {
+              const result = await this.oauthInstance.authApi.grantProviderToken({
+                provider_code: res.code,
+                provider_id: providerId,
+                provider_params: {
+                  provider_code_type: 'open_id',
+                  appid: wxInfo?.appId,
+                },
+              })
+
+              const { provider_token: providerToken } = result
+
+              if (!providerToken) {
+                reject(result)
+                return
+              }
+
+              const signInRes = await this.oauthInstance.authApi.signInWithProvider({
+                provider_token: providerToken,
+              })
+
+              if ((signInRes as any)?.error_code) {
+                reject(signInRes)
+                return
+              }
+
+              resolve(true)
+            } catch (error) {
+              reject(error)
+            }
+          },
+          fail: (res: any) => {
+            const error = new Error(res?.errMsg)
+            ;(error as any).code = res?.errno
+            reject(error)
+          },
+        })
+      })
+    }
+
+    return this.createLoginState()
+  }
+
+  /**
+   * 小程序unionId静默登录
+   * @returns {Promise<LoginState>}
+   * @memberof Auth
+   */
+  @catchErrorsDecorator({
+    title: '小程序unionId静默登录失败',
+    messages: [
+      '请确认以下各项：',
+      '  1 - 当前环境是否开启了小程序unionId静默登录',
+      '  2 - 调用 auth().signInWithUnionId() 的语法或参数是否正确',
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
+  })
+  public async signInWithUnionId(): Promise<LoginState> {
+    if (!adapterForWxMp.isMatch()) {
+      throw Error('wx api undefined')
+    }
+    try {
+      await new Promise((resolve, reject) => {
+        const wxInfo = wx.getAccountInfoSync().miniProgram
+        wx.login({
+          success: async (res: { code: string }) => {
+            const providerId = wxInfo?.appId
+            try {
+              const result = await this.oauthInstance.authApi.grantProviderToken({
+                provider_code: res.code,
+                provider_id: providerId,
+                provider_params: {
+                  provider_code_type: 'union_id',
+                  appid: wxInfo?.appId,
+                },
+              })
+
+              const { provider_token: providerToken } = result
+
+              if (!providerToken) {
+                reject(result)
+                return
+              }
+
+              const signInRes = await this.oauthInstance.authApi.signInWithProvider({
+                provider_id: providerId,
+                provider_token: providerToken,
+              })
+
+              if ((signInRes as any)?.error_code) {
+                reject(signInRes)
+                return
+              }
+              resolve(true)
+            } catch (error) {
+              reject(error)
+            }
+          },
+          fail: (res: any) => {
+            const error = new Error(res?.errMsg)
+            ;(error as any).code = res?.errno
+            reject(error)
+          },
+        })
+      })
+    } catch (error) {
+      throw error
+    }
+
+    return this.createLoginState()
+  }
+
+  /**
+   * 小程序手机号授权登录
+   * @returns {Promise<LoginState>}
+   * @memberof Auth
+   */
+  @catchErrorsDecorator({
+    title: '小程序手机号授权登录失败',
+    messages: [
+      '请确认以下各项：',
+      '  1 - 当前环境是否开启了小程序手机号授权登录',
+      '  2 - 调用 auth().signInWithPhoneAuth() 的语法或参数是否正确',
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
+  })
+  public async signInWithPhoneAuth({ phoneCode = '' }): Promise<LoginState> {
+    if (!adapterForWxMp.isMatch()) {
+      throw Error('wx api undefined')
+    }
+    const wxInfo = wx.getAccountInfoSync().miniProgram
+    const providerInfo = {
+      provider_params: { provider_code_type: 'phone' },
+      provider_id: wxInfo.appId,
+    }
+
+    const { code } = await wx.login()
+    ;(providerInfo as any).provider_code = code
+
+    try {
+      let providerToken = await this.oauthInstance.authApi.grantProviderToken(providerInfo)
+      if (providerToken.error_code) {
+        throw providerToken
+      }
+
+      providerToken = await this.oauthInstance.authApi.patchProviderToken({
+        provider_token: providerToken.provider_token,
+        provider_id: wxInfo.appId,
+        provider_params: {
+          code: phoneCode,
+          provider_code_type: 'phone',
+        },
+      })
+      if (providerToken.error_code) {
+        throw providerToken
+      }
+
+      const signInRes = await this.oauthInstance.authApi.signInWithProvider({
+        provider_token: providerToken.provider_token,
+      })
+
+      if ((signInRes as any)?.error_code) {
+        throw signInRes
+      }
+    } catch (error) {
+      throw error
+    }
+
+    return this.createLoginState()
+  }
+
+  /**
+   * 小程序短信验证码登陆
+   * @returns {Promise<LoginState>}
+   * @memberof Auth
+   */
+  @catchErrorsDecorator({
+    title: '小程序短信验证码登陆',
+    messages: [
+      '请确认以下各项：',
+      '  1 - 当前环境是否开启了小程序短信验证码登陆',
+      '  2 - 调用 auth().signInWithSms() 的语法或参数是否正确',
+      `如果问题依然存在，建议到官方问答社区提问或寻找帮助：${COMMUNITY_SITE_URL}`,
+    ],
+  })
+  public async signInWithSms({
+    verificationInfo = { id: '', isUser: false },
+    verificationCode = '',
+    phoneNum = '',
+    bindInfo = undefined,
+  }): Promise<LoginState> {
+    try {
+      // 1. 验证验证码
+      const verifyRes = await this.oauthInstance.authApi.verify({
+        verification_id: verificationInfo.id,
+        verification_code: verificationCode,
+      })
+
+      if ((verifyRes as any)?.error_code) {
+        throw verifyRes
+      }
+
+      const { verification_token } = verifyRes
+
+      // 2. 根据是否已经是用户，分别走登录或注册逻辑
+      if (verificationInfo.isUser) {
+        // 私有化环境或者自定义应用走v1版本的老逻辑
+        const signInRes = await this.oauthInstance.authApi.signIn({
+          username: `+86 ${phoneNum}`,
+          verification_token,
+        })
+
+        if ((signInRes as any)?.error_code) {
+          throw signInRes
+        }
+
+        if (bindInfo) {
+          const bindRes = await this.oauthInstance.authApi.bindWithProvider({
+            provider_token: (bindInfo as any)?.providerToken,
+          })
+
+          if ((bindRes as any)?.error_code) {
+            throw bindRes
+          }
+        }
+      } else {
+        // 自定义应用走signUp逻辑
+        const signUpRes = await this.oauthInstance.authApi.signUp({
+          phone_number: `+86 ${phoneNum}`,
+          verification_token,
+          provider_token: (bindInfo as any)?.providerId,
+        })
+
+        if ((signUpRes as any)?.error_code) {
+          throw signUpRes
+        }
+      }
+
+      return this.createLoginState()
+    } catch (error) {
+      throw error
+    }
+  }
+
   /**
    * 设置获取自定义登录 ticket 函数
    * @param {authModels.GetCustomSignTicketFn} getTickFn
@@ -826,8 +1130,9 @@ const component: ICloudbaseComponent = {
       this.updateConfig({ persistence: newPersistence })
     }
 
-    const { env, persistence, debug, clientId, storage } = this.config
-    const oauthInstance = new CloudbaseOAuth({
+    const { env, persistence, debug, clientId, storage, wxCloud } = this.config
+    const oauthInstance = new CloudbaseOAuth(useAuthAdapter({
+      env,
       clientId,
       apiOrigin: this.request.getBaseEndPoint(),
       // @todo 以下最好走adaptor处理，目前oauth模块没按adaptor接口设计
@@ -836,7 +1141,8 @@ const component: ICloudbaseComponent = {
       request: config?.request,
       anonymousSignInFunc: config?.anonymousSignInFunc,
       captchaOptions: config?.captchaOptions,
-    })
+      wxCloud: config?.wxCloud || wxCloud,
+    }),)
 
     this.oauthInstance = oauthInstance