@cloudbase/oauth 1.2.0-beta → 2.2.0

package/src/oauth2client/consts.ts

@@ -0,0 +1,69 @@
+export enum Syntax {
+  CLIENT_ID = 'client_id',
+  CLIENT_SECRET = 'client_secret',
+  RESPONSE_TYPE = 'response_type',
+  SCOPE = 'scope',
+  STATE = 'state',
+  REDIRECT_URI = 'redirect_uri',
+  ERROR = 'error',
+  ERROR_DESCRIPTION = 'error_description',
+  ERROR_URI = 'error_uri',
+  GRANT_TYPE = 'grant_type',
+  CODE = 'code',
+  ACCESS_TOKEN = 'access_token',
+  TOKEN_TYPE = 'token_type',
+  EXPIRES_IN = 'expires_in',
+  USERNAME = 'username',
+  PASSWORD = 'password',
+  REFRESH_TOKEN = 'refresh_token',
+}
+
+export enum ErrorType {
+  UNREACHABLE = 'unreachable',
+  LOCAL = 'local',
+  CANCELLED = 'cancelled',
+  UNKNOWN = 'unknown',
+  INVALID_ARGUMENT = 'invalid_argument',
+  DEADLINE_EXCEEDED = 'deadline_exceeded',
+  NOT_FOUND = 'not_found',
+  ALREADY_EXISTS = 'already_exists',
+  PERMISSION_DENIED = 'permission_denied',
+  UNAUTHENTICATED = 'unauthenticated',
+  RESOURCE_EXHAUSTED = 'resource_exhausted',
+  FAILED_PRECONDITION = 'failed_precondition',
+  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',
+  INVALID_STATUS = 'invalid_status',
+  USER_PENDING = 'user_pending',
+  USER_BLOCKED = 'user_blocked',
+  INVALID_VERIFICATION_CODE = 'invalid_verification_code',
+  TWO_FACTOR_REQUIRED = 'two_factor_required',
+  INVALID_TWO_FACTOR = 'invalid_two_factor',
+  INVALID_TWO_FACTOR_RECOVERY = 'invalid_two_factor_recovery',
+  UNDER_REVIEW = 'under_review',
+  INVALID_REQUEST = 'invalid_request',
+  UNAUTHORIZED_CLIENT = 'unauthorized_client',
+  ACCESS_DENIED = 'access_denied',
+  UNSUPPORTED_RESPONSE_TYPE = 'unsupported_response_type',
+  INVALID_SCOPE = 'invalid_scope',
+  INVALID_GRANT = 'invalid_grant',
+  SERVER_ERROR = 'server_error',
+  TEMPORARILY_UNAVAILABLE = 'temporarily_unavailable',
+  INTERACTION_REQUIRED = 'interaction_required',
+  LOGIN_REQUIRED = 'login_required',
+  ACCOUNT_SELECTION_REQUIRED = 'account_selection_required',
+  CONSENT_REQUIRED = 'consent_required',
+  INVALID_REQUEST_URI = 'invalid_request_uri',
+  INVALID_REQUEST_OBJECT = 'invalid_request_object',
+  REQUEST_NOT_SUPPORTED = 'request_not_supported',
+  REQUEST_URI_NOT_SUPPORTED = 'request_uri_not_supported',
+  REGISTRATION_NOT_SUPPORTED = 'registration_not_supported',
+}

package/src/oauth2client/interface.ts

@@ -0,0 +1,57 @@
+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
+   * error:
+   *     - unreachable, the network error or response is not json
+   *     - unauthenticated: has no validate access token
+   */
+  abstract request: RequestFunction;
+
+  /**
+   * get the current accessToken from AuthClient, you can use this to detect login status
+   * error:
+   *    -  unauthenticated: has no validate access token
+   */
+  abstract getAccessToken(): Promise<string>;
+}
+
+export type RequestFunction = <T>(url: string, options?: AuthClientRequestOptions) => Promise<T>;
+
+/** An interface of the Simple  Web Storage API  */
+export interface SimpleStorage {
+  /**
+   * value = storage[key]
+   */
+  getItem: (key: string) => Promise<string | null>;
+  /**
+   * delete storage[key]
+   */
+  removeItem: (key: string) => Promise<void>;
+  /**
+   * storage[key] = value
+   */
+  setItem: (key: string, value: string) => Promise<void>;
+
+  /**
+   * value = storage[key]
+   */
+  getItemSync: (key: string) => string | null;
+  /**
+   * delete storage[key]
+   */
+  removeItemSync: (key: string) => void;
+  /**
+   * storage[key] = value
+   */
+  setItemSync: (key: string, value: string) => void;
+}

package/src/oauth2client/models.ts

@@ -0,0 +1,61 @@
+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;
+}
+
+/** An Error For all concern **/
+export interface ResponseError {
+    error: ErrorType;
+    error_description?: string | null;
+    error_uri?: string | null;
+    details?: any | null;
+}
+
+export interface RequestOptions {
+    body?: any | null;
+    headers?: any | null;
+    method?: string;
+
+    [key: string]: any;
+}
+
+export type RequestFunction = <T>(
+    url: string,
+    options?: RequestOptions,
+) => Promise<T>;
+
+export interface AuthClientRequestOptions extends RequestOptions {
+    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 };
+}