@cloudbase/oauth 0.0.3-alpha.0 → 1.0.0-alpha.0

package/src/auth/consts.ts

@@ -17,8 +17,12 @@ export enum ApiUrls {
   PROVIDER_LIST = '/auth/v1/user/provider',
   PROVIDER_UNBIND_URL = '/auth/v1/user/provider',
   CHECK_PWD_URL = '/auth/v1/user/sudo',
-  BIND_PHONE_URL = '/auth/v1/user/contact',
+  SUDO_URL = '/auth/v1/user/sudo',
+  BIND_CONTACT_URL = '/auth/v1/user/contact',
   AUTH_SET_PASSWORD = '/auth/v1/user/password',
+  AUTH_RESET_PASSWORD = '/auth/v1/reset',
+  AUTH_GET_DEVICE_CODE = '/auth/v1/device/code',
+  CHECK_USERNAME = '/auth/v1/checkUsername'
 }
 
 export enum VerificationUsages {
@@ -28,3 +32,25 @@ export enum VerificationUsages {
   EMAIL_ADDRESS_CHANGE = 'EMAIL_ADDRESS_CHANGE',
   PHONE_NUMBER_CHANGE = 'PHONE_NUMBER_CHANGE',
 }
+
+export enum ErrorType {
+  INVALID_ARGUMENT = 'invalid_argument',
+  DEADLINE_EXCEEDED = 'deadline_exceeded',
+  NOT_FOUND = 'not_found',
+  ALREADY_EXISTS = 'already_exists',
+  PERMISSION_DENIED = 'permission_denied',
+  ABORTED = 'aborted',
+  OUT_OF_RANGE = 'out_of_range',
+  UNIMPLEMENTED = 'unimplemented',
+  INTERNAL = 'internal',
+  UNAVAILABLE = 'unavailable',
+  DATA_LOSS = 'data_loss',
+  // CommonError
+  CAPTCHA_REQUIRED = 'captcha_required',
+  CAPTCHA_INVALID = 'captcha_invalid',
+  INVALID_PASSWORD = 'invalid_password',
+  PASSWORD_NOT_SET = 'password_not_set',
+  INVALID_STATUS = 'invalid_status',
+  USER_PENDING = 'user_pending',
+  USER_BLOCKED = 'user_blocked',
+}

package/src/auth/models.ts

@@ -2,10 +2,11 @@ interface BaseRequest {
   client_id?: string;
 }
 
+export type GetCustomSignTicketFn = () => Promise<string>;
+
 export interface SignInRequest extends BaseRequest {
   username?: string;
   password?: string;
-  verification_code?: string;
   verification_token?: string;
 }
 
@@ -111,6 +112,7 @@ export interface UserProfileProvider {
 export interface UserProfile {
   name?: string;
   picture?: string;
+  avatarUrl?: string;
   username?: string;
   email?: string;
   email_verified?: boolean;
@@ -121,6 +123,20 @@ export interface UserProfile {
   zoneinfo?: string;
   locale?: string;
   created_from?: string;
+  sub?: string
+  uid?: string
+  address?: {
+    formatted?: string,
+    street_address?: string,
+    locality?: string,
+    region?: string,
+    postal_code?: string,
+    country?: string
+  }
+  nickName?: string // TODO:
+  province?: string // TODO:
+  country?: string // TODO:
+  city?: string // TODO:
 }
 
 export type UserInfo = UserProfile;
@@ -173,3 +189,244 @@ export type ChangeBindedProviderResponse = BaseRequest
 export interface QueryUserProfileReq extends BaseRequest {
   appended_params: string;
 }
+
+export interface SignInWithProviderRequest {
+  provider_token: string;
+  provider_id?: string;
+}
+
+export interface SignUpRequest {
+  phone_number?: string;
+  email?: string;
+
+  verification_code?: string;
+  verification_token?: string;
+  provider_token?: string;
+
+  password?: string;
+  name?: string;
+  gender?: string;
+  picture?: string;
+  locale?: string;
+}
+
+export interface GetVerificationRequest {
+  phone_number?: string;
+  email?: string;
+  target?: string | 'ANY';
+  usage?: string;
+}
+
+export interface GetVerificationResponse {
+  verification_id?: string;
+  is_user?: boolean | false;
+}
+
+export interface VerifyResponse {
+  verification_token?: string;
+}
+
+export interface VerifyRequest {
+  verification_code: string;
+  verification_id?: string;
+}
+
+export interface ProviderBindRequest {
+  provider_token: string;
+}
+
+export interface GrantProviderTokenRequest {
+  provider_id: string;
+  provider_redirect_uri?: string;
+  provider_code?: string;
+  provider_access_token?: string;
+  provider_id_token?: string;
+}
+
+export interface GrantProviderTokenResponse {
+  provider_token: string;
+  expires_in: number;
+}
+
+export interface PatchProviderTokenRequest {
+  provider_token: string;
+  provider_params: {
+    encryptedData: string;
+    iv: string;
+  };
+}
+
+export interface PatchProviderTokenResponse {
+  provider_token: string;
+  expires_in: number;
+  provider_profile: ProviderProfile;
+}
+
+export interface GenProviderRedirectUriRequest {
+  provider_id: string;
+  provider_redirect_uri: string;
+  state: string;
+  other_params?: {
+    sign_out_uri?: string;
+  };
+}
+
+export interface GenProviderRedirectUriResponse {
+  uri: string;
+  signout_uri?: string;
+}
+
+export interface BindWithProviderRequest {
+  provider_token: string;
+}
+
+export interface BindWithProviderRequest {
+  provider_token: string;
+}
+
+export interface UserProfileProvider {
+  id?: string;
+  provider_user_id?: string;
+  name?: string;
+}
+
+export interface UserProfile {
+  name?: string;
+  picture?: string;
+  username?: string;
+  email?: string;
+  email_verified?: boolean;
+  phone_number?: string;
+  providers?: [UserProfileProvider];
+  gender?: string;
+  birthdate?: string;
+  zoneinfo?: string;
+  locale?: string;
+  created_from?: string;
+}
+
+export interface ProviderProfile {
+  provider_id: string;
+  phone_number?: string;
+}
+
+export interface TransByProviderRequest {
+  provider_token: string;
+}
+
+export interface GrantTokenRequest {
+  client_secret?: string;
+  code?: string;
+  grant_type?: string;
+  redirect_uri?: string;
+  nonce?: string;
+  refresh_token?: string;
+  scope?: string;
+}
+
+export interface UnbindProviderRequest {
+  provider_id: string;
+}
+
+export interface CheckPasswordrRequest {
+  password: string;
+}
+
+export interface BindPhoneRequest {
+  phone_number: string;
+  sudo_token: string;
+  verification_token: string;
+  conflict_resolution: string
+  // 1. DEFAULT 0, 默认提示用户手机号已被绑定
+  // 2. DELETE_ACCOUNT_TRANSFER 1, 标记原账号已被注销，并将手机换绑给自己
+  // 3. TRANSFER 2, 仅换绑手机号，不注销原有账号（换绑后原账号无法登录时，则自动注销原账号）
+}
+
+export interface BindEmailRequest {
+  email: string;
+  sudo_token: string;
+  verification_token: string;
+}
+
+export interface SetPasswordRequest {
+  new_password: string;
+  sudo_token: string;
+}
+
+
+export interface SetPasswordRequest {
+  new_password: string;
+  sudo_token: string;
+}
+
+export interface UpdatePasswordRequest {
+  old_password: string;
+  new_password: string;
+}
+
+// password 和 verification_token 而选一，如果绑定了手机号，则必须使用verification_token 进行sudo
+export interface SudoRequest {
+  password?: string;
+  verification_token?: string
+}
+
+export interface SudoResponse {
+  sudo_token?: string
+}
+
+
+export interface ChangeBoundProviderRequest {
+  trans_token: string;
+  provider_id: string;
+}
+
+export interface ChangeBoundProviderResponse {
+  client_id: string;
+}
+
+export interface QueryUserProfileRequest {
+  id?: [string];
+  username?: string;
+  email?: string;
+  phone_number?: string;
+}
+
+export interface QueryUserProfileResponse {
+  total: string;
+  data: SimpleUserProfile[]
+}
+
+export interface ResetPasswordRequest extends BaseRequest {
+  email: string
+  phone_number: string
+  new_password: string
+  verification_token: string
+}
+
+export interface DeviceAuthorizeRequest extends BaseRequest {
+  scope?: string
+}
+
+export interface DeviceAuthorizeResponse {
+  device_code: string
+  user_code: string
+  expires_in: number
+  interval: number
+  verification_url: string
+  verification_uri_complete: string
+}
+
+// 简化版用户信息
+export interface SimpleUserProfile {
+  sub: string;
+  name: string;
+  picture?: string;
+  gender?: string;
+  locale?: string;
+  email?: string;
+  phone_number?: string;
+}
+
+export interface CheckUsernameRequest {
+  username: string
+}