@cloudbase/oauth 0.1.1-alpha.1 → 0.1.1-alpha.10

package/packages/container/node_modules/@cloudbase/types/auth.d.ts

@@ -0,0 +1,78 @@
+import { ICloudbaseConfig, KV, ICloudbase } from '.'
+
+export type ICloudbaseAuthConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'persistence' | 'debug' | '_fromApp' | 'oauthInstance'>;
+
+export interface IAccessTokenInfo {
+  accessToken: string;
+  env: string;
+}
+export interface ICredential {
+  // refreshToken: string;
+  accessToken?: string;
+  accessTokenExpire?: string;
+}
+export interface IAuthProvider {
+  signInWithRedirect: () => any;
+}
+export interface IUserInfo {
+  uid?: string;
+  loginType?: string;
+  openid?: string;
+  wxOpenId?: string;
+  wxPublicId?: string;
+  unionId?: string;
+  qqMiniOpenId?: string;
+  customUserId?: string;
+  name?: string;
+  gender?: string;
+  email?: string;
+  username?: string;
+  hasPassword?: boolean;
+  location?: {
+    country?: string;
+    province?: string;
+    city?: string;
+  };
+  country?: string;
+  province?: string;
+  city?: string;
+}
+export interface IUser extends IUserInfo {
+  checkLocalInfo: () => void;
+  checkLocalInfoAsync: () => Promise<void>;
+  linkWithTicket?: (ticket: string) => Promise<void>;
+  linkWithRedirect?: (provider: IAuthProvider) => void;
+  getLinkedUidList?: () => Promise<{ hasPrimaryUid: boolean, users: IUserInfo[] }>;
+  setPrimaryUid?: (uid: string) => Promise<void>;
+  unlink?: (loginType: 'CUSTOM' | 'WECHAT-OPEN' | 'WECHAT-PUBLIC' | 'WECHAT-UNION') => Promise<void>;
+  update: (userinfo: IUserInfo) => Promise<void>;
+  refresh: () => Promise<IUserInfo>;
+}
+export interface ILoginState {
+  user: IUser;
+}
+export interface ICloudbaseAuth {
+  config: ICloudbaseConfig;
+  loginType: string;
+  weixinAuthProvider: any;
+  anonymousAuthProvider: any;
+  customAuthProvider: any;
+  getAccessToken: () => IAccessTokenInfo;
+  getLoginState: () => Promise<ILoginState | null>;
+  hasLoginState: () => Promise<ILoginState | null>;
+  getUserInfo: () => Promise<any>;
+  getAuthHeader: () => Promise<KV<string>>;
+  onLoginStateChanged: (callback: Function) => void;
+  onLoginStateExpired: (callback: Function) => void;
+  onAccessTokenRefreshed: (callback: Function) => void;
+  onAnonymousConverted: (callback: Function) => void;
+  onLoginTypeChanged: (callback: Function) => void;
+  shouldRefreshAccessToken: (hook: Function) => void;
+}
+
+type IProvider = new (...args: any[]) => any;
+
+export interface ICloudbaseAuthModule {
+  registerAuth: (app: ICloudbase) => void,
+  registerProvider: (name: string, provider: IProvider) => void;
+}

package/packages/container/node_modules/@cloudbase/types/cache.d.ts

@@ -0,0 +1,26 @@
+import { ICloudbasePlatformInfo, KV, ICloudbaseConfig } from '.'
+
+export type ICacheConfig = Pick < ICloudbaseConfig, 'debug' | 'persistence' > & {
+  platformInfo?: ICloudbasePlatformInfo;
+  keys?: KV<string>;
+  alwaysLocalKeys?: string[];
+};
+
+export interface ICloudbaseCache {
+  keys: KV<string>;
+  mode: 'async' | 'sync';
+
+  setStore: (key: string, value: any, version?: string) => void;
+  setStoreAsync: (key: string, value: any, version?: string) => Promise<void>;
+
+  getStore: (key: string, version?: string) => any;
+  getStoreAsync: (key: string, version?: string) => Promise<any>;
+
+  removeStore: (key: string) => void;
+  removeStoreAsync: (key: string) => Promise<void>;
+
+  updatePersistence?: (persistence: string) => void;
+  updatePersistenceAsync?: (persistence: string) => Promise<void>;
+
+  clear?: () => void;
+}

package/packages/container/node_modules/@cloudbase/types/component.d.ts

@@ -0,0 +1,17 @@
+import { ICloudbaseEventEmitter } from './events'
+
+export interface ICloudbaseComponent {
+  name: string;
+  entity: any;
+  namespace?: string;
+  injectEvents?: {
+    bus: ICloudbaseEventEmitter,
+    events: string[];
+  };
+  IIFE?: boolean
+}
+
+export interface ICloudbaseHook {
+  entity: any;
+  target: string;
+}

package/packages/container/node_modules/@cloudbase/types/database.d.ts

@@ -0,0 +1,31 @@
+export type DataType = 'init' | 'update' | 'add' | 'remove' | 'replace' | 'limit'
+export type QueueType = 'init' | 'enqueue' | 'dequeue' | 'update'
+
+export interface ISingleDBEvent {
+  id: number
+  dataType: DataType
+  queueType: QueueType
+  docId: string
+  doc: Record<string, any>
+  updatedFields?: any
+  removedFields?: any
+}
+
+export interface IDatabaseServiceContext extends IServiceContext {
+  appConfig: IAppConfig
+  ws?: any
+}
+
+export interface IAppConfig {
+  docSizeLimit: number
+  realtimePingInterval: number
+  realtimePongWaitTimeout: number
+  request: any
+}
+
+export interface IServiceContext {
+  // name: string
+  // identifiers: IRuntimeIdentifiers
+  // debug: boolean
+  env?: string
+}

package/packages/container/node_modules/@cloudbase/types/events.d.ts

@@ -0,0 +1,13 @@
+export interface Listeners {
+  [key: string]: Function[];
+}
+export interface ICloudbaseEvent {
+  name: string;
+  target: any;
+  data: any;
+}
+export interface ICloudbaseEventEmitter {
+  on(name: string, listener: Function): this;
+  off(name: string, listener: Function): this;
+  fire(event: string | ICloudbaseEvent, data?: any): this;
+}

package/packages/container/node_modules/@cloudbase/types/functions.d.ts

@@ -0,0 +1,16 @@
+import { KV } from '.'
+
+export interface ICallFunctionOptions {
+  name: string;
+  data?: KV<any>;
+  query?: KV<any>;
+  search?: string;
+  parse?: boolean;
+}
+
+export interface ICallFunctionResponse {
+  requestId: string;
+  result: any;
+}
+
+export type ICallFunction = (options: ICallFunctionOptions, callback?: Function) => Promise<ICallFunctionResponse>;

package/packages/container/node_modules/@cloudbase/types/index.d.ts

@@ -0,0 +1,66 @@
+import { CloudbaseAdapter, SDKAdapterInterface } from '@cloudbase/adapter-interface'
+import { ICloudbaseComponent, ICloudbaseHook } from './component'
+import { ICloudbaseRequest } from './request'
+import { ICloudbaseCache } from './cache'
+import { ICloudbaseAuth } from './auth'
+
+export type Persistence = 'local' | 'session' | 'none';
+
+export interface KV<T> {
+  [key: string]: T;
+}
+
+export interface KVstring {
+  [key: string]: string;
+}
+
+
+export interface ICloudbaseConfig {
+  env: string;
+  region?: string;
+  timeout?: number;
+  persistence?: Persistence;
+  oauthClient?: any
+  debug?: boolean;
+  _fromApp?: ICloudbase;
+  clientId?: string
+  oauthInstance?: any;
+}
+// 可更新的配置字段
+export type ICloudbaseUpgradedConfig = Pick<ICloudbaseConfig, 'persistence' | 'region' | 'debug'>;
+
+export interface ICloudbaseExtension {
+  name: string;
+  invoke: (opts: any, app: ICloudbase) => Promise<any>;
+}
+
+export interface ICloudbase {
+  config: ICloudbaseConfig;
+  platform: ICloudbasePlatformInfo;
+  cache: ICloudbaseCache;
+  request: ICloudbaseRequest;
+  oauthClient: any;
+  localCache: ICloudbaseCache;
+  authInstance?: ICloudbaseAuth;
+  oauthInstance?: any;
+  init: (config: ICloudbaseConfig) => ICloudbase;
+  updateConfig: (config: ICloudbaseUpgradedConfig) => void;
+  registerExtension: (ext: ICloudbaseExtension) => void;
+  invokeExtension: (name: string, opts: any) => Promise<any>;
+  useAdapters: (adapters: CloudbaseAdapter | CloudbaseAdapter[]) => void;
+  registerComponent: (component: ICloudbaseComponent) => void;
+  registerHook: (hook: ICloudbaseHook) => void;
+  registerVersion: (version: string) => void;
+  fire?: (...args: any[]) => void;
+}
+
+export interface ICloudbasePlatformInfo {
+  adapter?: SDKAdapterInterface;
+  runtime?: string;
+}
+
+export interface IGenericError<T extends string, P = any> extends Error {
+  type: T
+  payload: P
+  generic: boolean
+}

package/packages/container/node_modules/@cloudbase/types/index.js

@@ -0,0 +1 @@
+// 兼容微信小程序npm构建方式，勿删

package/packages/container/node_modules/@cloudbase/types/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@cloudbase/types",
+  "version": "2.5.25-beta.0",
+  "description": "cloudbase javascript sdk types",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "cache.d.ts",
+    "events.d.ts",
+    "request.d.ts",
+    "auth.d.ts",
+    "component.d.ts",
+    "functions.d.ts",
+    "storage.d.ts",
+    "realtime.d.ts",
+    "database.d.ts"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TencentCloudBase/cloudbase-js-sdk"
+  },
+  "keywords": [
+    "cloudbase",
+    "Cloudbase",
+    "CloudBase",
+    "tcb",
+    "TCB",
+    "serverless",
+    "Serverless",
+    "javascript",
+    "typescript"
+  ],
+  "author": "",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@cloudbase/adapter-interface": "^0.4.1"
+  },
+  "scripts": {
+    "lint": "eslint --fix \"./**/*.ts\"",
+    "precommit": "npm run lint"
+  },
+  "gitHead": "96936d2b1965452c2f7f73eb8e6c0c8f8ec5cb5b"
+}

package/packages/container/node_modules/@cloudbase/types/realtime.d.ts

@@ -0,0 +1,350 @@
+import { DataType, QueueType, ISingleDBEvent } from './database'
+
+export type IRequestMsgType =
+  | 'LOGIN' // 鉴权（环境维度）
+  | 'INIT_WATCH' // 初始化监听
+  | 'REBUILD_WATCH' // 重建监听，1）数据失序时 2）checkLast 不一致时
+  | 'CHECK_LAST' // 检查是否有未收到的消息
+  | 'CLOSE_WATCH' // 取消监听
+  | 'PING' // 心跳 ping
+
+export type IResponseMsgType =
+  | 'LOGIN_RES' // LOGIN 回包
+  | 'INIT_EVENT' // INIT_WATCH 回包
+  | 'NEXT_EVENT' // 服务端主动推变更事件
+  | 'CHECK_EVENT' // CHECK_LAST 回包
+  | 'PONG' // 心跳 PING 回包
+  | 'ERROR' // 错误异常
+
+export interface IRequestMessageBase<W extends boolean = true> {
+  watchId: W extends true ? string : undefined
+  requestId: string
+  msgType: IRequestMsgType
+  msgData: IRequestMessageMsgData
+}
+
+export type IRequestMessageMsgData =
+  | IRequestMessageInitWatchData
+  | IRequestMessageLoginData
+  | IRequestMessageRebuildWatchData
+  | IRequestMessageCheckLastData
+  | IRequestMessageCloseWatchData
+  | IRequestMessagePingData
+
+export type IRequestMessage =
+  | IRequestMessageInitWatchMsg
+  | IRequestMessageLoginMsg
+  | IRequestMessageRebuildWatchMsg
+  | IRequestMessageCheckLastMsg
+  | IRequestMessageCloseWatchMsg
+  | IRequestMessagePingMsg
+
+export interface IRequestMessageLoginData {
+  envId: string
+  accessToken: string
+  referrer: 'web'
+  sdkVersion: string
+  dataVersion: string
+}
+
+export interface IRequestExtraMessageLoginData {
+  runtime: string
+  signStr: string
+  secretVersion: string
+}
+export interface IRequestMessageLoginMsg extends IRequestMessageBase<false> {
+  msgType: 'LOGIN'
+  msgData: IRequestMessageLoginData
+  exMsgData?: IRequestExtraMessageLoginData
+}
+
+export interface IRequestMessageInitWatchData {
+  envId: string
+  collName: string // collection name
+  query: string // query that is stringified
+  limit?: number
+  orderBy?: Record<string, string>
+}
+
+export interface IRequestMessageInitWatchMsg extends IRequestMessageBase {
+  msgType: 'INIT_WATCH'
+  msgData: IRequestMessageInitWatchData
+}
+
+export interface IRequestMessageRebuildWatchData {
+  envId: string
+  collName: string
+  queryID: string
+  eventID: number
+}
+
+export interface IRequestMessageRebuildWatchMsg extends IRequestMessageBase {
+  msgType: 'REBUILD_WATCH'
+  msgData: IRequestMessageRebuildWatchData
+}
+
+export interface IRequestMessageCheckLastData {
+  queryID: string
+  eventID: number
+}
+
+export interface IRequestMessageCheckLastMsg extends IRequestMessageBase {
+  msgType: 'CHECK_LAST'
+  msgData: IRequestMessageCheckLastData
+}
+
+export type IRequestMessageCloseWatchData = null
+
+export interface IRequestMessageCloseWatchMsg extends IRequestMessageBase {
+  msgType: 'CLOSE_WATCH'
+  msgData: IRequestMessageCloseWatchData
+}
+
+export type IRequestMessagePingData = null
+
+export interface IRequestMessagePingMsg extends IRequestMessageBase<false> {
+  msgType: 'PING'
+  msgData: IRequestMessagePingData
+}
+
+// export interface IResponseMessageBase {
+
+export interface IResponseMessageBase<W extends boolean = true> {
+  watchId: W extends true ? string : undefined
+  // watchId: string
+  requestId: string
+  msgType: IResponseMsgType
+  msgData: IResponseMessageMsgData
+}
+
+export type IResponseMessageMsgData =
+  | IResponseMessageLoginResData
+  | IResponseMessageInitEventData
+  | IResponseMessageNextEventData
+  | IResponseMessageCheckEventData
+  | IResponseMessagePongData
+  | IResponseMessageErrorData
+
+export type IResponseMessage =
+  | IResponseMessageLoginResMsg
+  | IResponseMessageInitEventMsg
+  | IResponseMessageNextEventMsg
+  | IResponseMessageCheckEventMsg
+  | IResponseMessagePongMsg
+  | IResponseMessageErrorMsg
+
+export type IResponseMessageLoginResData = {
+  envId: string
+} & Partial<IResponseMessageErrorData>
+
+export interface IResponseMessageLoginResMsg
+  extends IResponseMessageBase<false> {
+  msgType: 'LOGIN_RES'
+  msgData: IResponseMessageLoginResData
+}
+
+export interface IResponseMessageInitEventData {
+  queryID: string
+  currEvent: number
+  events: IDBEvent[]
+}
+
+export interface IResponseMessageInitEventMsg extends IResponseMessageBase {
+  msgType: 'INIT_EVENT'
+  msgData: IResponseMessageInitEventData
+}
+
+export interface IResponseMessageNextEventData {
+  queryID: string
+  currEvent: number
+  events: IDBEvent[]
+}
+
+export interface IResponseMessageNextEventMsg extends IResponseMessageBase {
+  msgType: 'NEXT_EVENT'
+  msgData: IResponseMessageNextEventData
+}
+
+export interface IResponseMessageCheckEventData {
+  queryID: string
+  currEvent: number
+}
+
+export interface IResponseMessageCheckEventMsg extends IResponseMessageBase {
+  msgType: 'CHECK_EVENT'
+  msgData: IResponseMessageCheckEventData
+}
+
+export type IResponseMessagePongData = null
+
+export interface IResponseMessagePongMsg extends IResponseMessageBase {
+  msgType: 'PONG'
+  msgData: IResponseMessagePongData
+}
+
+export type IResponseMessageErrorData = {
+  message: string
+} & (
+  | { code: 'SYS_ERR' } // 服务器系统错误
+  | { code: 'CHECK_LOGIN_FAILED' } // 登陆校验失败
+  | { code: 'SIGN_INVALID_ERROR' } // ws签名无效
+  | { code: 'SIGN_EXPIRED_ERROR' } // 签名过期
+  | { code: 'INVALIID_ENV' } // 环境无效
+  | { code: 'SIGN_PARAM_INVALID' } // cam签名无效
+  | { code: 'COLLECTION_PERMISSION_DENIED' } // 没有集合操作权限
+  | { code: 'QUERYID_INVALID_ERROR' }) // queryID 无效
+
+export interface IResponseMessageErrorMsg extends IResponseMessageBase {
+  msgType: 'ERROR'
+  msgData: IResponseMessageErrorData
+}
+
+export type IDBEvent = IDBInitEvent | IDBNextEvent
+
+export interface IDBEventBase {
+  ID: number // event id
+  DataType: DataType
+  QueueType: QueueType
+  DocID: string
+  Doc: string
+}
+
+export interface IDBInitEvent extends IDBEventBase {
+  DataType: 'init'
+  QueueType: 'init'
+  UpdatedFields?: any
+  removedFields?: any
+}
+
+// <DataType, QueueType>
+// * <update, update>
+// * <update, enqueue>
+// * <update, dequeue>
+// * <add, enqueue>
+// * <remove, dequeue>
+
+// export interface IDBNextEvent extends IDBEventBase {
+//   DocID: string
+//   Doc: string
+//   UpdatedFields?: any
+//   removedFields?: any
+// }
+
+export type IDBNextEvent =
+  | IDBNextEventDataUpdate
+  | IDBNextEventDataReplace
+  | IDBNextEventDataAdd
+  | IDBNextEventDataRemove
+  | IDBNextEventDataLimit
+
+export type IDBNextEventDataUpdate =
+  | IDBNextEventDataUpdateQueueUpdate
+  | IDBNextEventDataUpdateQueueEnqueue
+  | IDBNextEventDataUpdateQueueDequeue
+
+export type IDBNextEventDataReplace =
+  | IDBNextEventDataReplaceQueueUpdate
+  | IDBNextEventDataReplaceQueueEnqueue
+  | IDBNextEventDataReplaceQueueDequeue
+
+export type IDBNextEventDataLimit =
+  | IDBNextEventDataLimitQueueEnqueue
+  | IDBNextEventDataLimitQueueDequeue
+
+export interface IDBNextEventDataUpdateQueueUpdate extends IDBEventBase {
+  DataType: 'update'
+  QueueType: 'update'
+  Doc: ''
+  UpdatedFields: string
+  RemovedFields: string
+}
+
+export interface IDBNextEventDataUpdateQueueEnqueue extends IDBEventBase {
+  DataType: 'update'
+  QueueType: 'enqueue'
+  Doc: string // full doc
+  UpdatedFields: string
+  RemovedFields: string
+}
+
+export interface IDBNextEventDataUpdateQueueDequeue extends IDBEventBase {
+  DataType: 'update'
+  QueueType: 'dequeue'
+  Doc: ''
+  UpdatedFields: string
+  RemovedFields: string
+}
+
+export interface IDBNextEventDataReplaceQueueUpdate extends IDBEventBase {
+  DataType: 'replace'
+  QueueType: 'update'
+  Doc: string
+  UpdatedFields: ''
+  RemovedFields: ''
+}
+
+export interface IDBNextEventDataReplaceQueueEnqueue extends IDBEventBase {
+  DataType: 'replace'
+  QueueType: 'enqueue'
+  Doc: string
+  UpdatedFields: ''
+  RemovedFields: ''
+}
+
+export interface IDBNextEventDataReplaceQueueDequeue extends IDBEventBase {
+  DataType: 'replace'
+  QueueType: 'dequeue'
+  Doc: string
+  UpdatedFields: ''
+  RemovedFields: ''
+}
+
+export interface IDBNextEventDataAdd extends IDBEventBase {
+  DataType: 'add'
+  QueueType: 'enqueue'
+}
+
+export interface IDBNextEventDataRemove extends IDBEventBase {
+  DataType: 'remove'
+  QueueType: 'dequeue'
+  Doc: ''
+}
+
+export interface IDBNextEventDataLimitQueueEnqueue extends IDBEventBase {
+  DataType: 'limit'
+  QueueType: 'enqueue'
+  Doc: string
+  UpdatedFields: ''
+  RemovedFields: ''
+}
+
+export interface IDBNextEventDataLimitQueueDequeue extends IDBEventBase {
+  DataType: 'limit'
+  QueueType: 'dequeue'
+  Doc: ''
+  UpdatedFields: ''
+  RemovedFields: ''
+}
+
+export interface IWatchOptions {
+  // server realtime data init & change event
+  onChange: (snapshot: ISnapshot) => void
+  // error while connecting / listening
+  onError: (error: any) => void
+}
+
+export interface ISnapshot {
+  id: number
+  docChanges: ISingleDBEvent[]
+  docs: Record<string, any>
+  type?: SnapshotType
+}
+
+export interface DBRealtimeListener {
+  // "And Now His Watch Is Ended"
+  close: () => void
+}
+
+export type IRealtimeListenerConstructorOptions = IWatchOptions
+
+export type SnapshotType = 'init'

package/packages/container/node_modules/@cloudbase/types/request.d.ts

@@ -0,0 +1,28 @@
+import {
+  IRequestOptions, IUploadRequestOptions, ResponseObject,
+} from '@cloudbase/adapter-interface'
+
+import { ICloudbaseConfig, KV } from '.'
+
+export interface IGetAccessTokenResult {
+  accessToken: string;
+  accessTokenExpire: number;
+}
+
+export type ICloudbaseRequestConfig = Pick<ICloudbaseConfig, 'env' | 'region' | 'timeout' | 'oauthClient' | '_fromApp'>;
+
+export interface IAppendedRequestInfo {
+  data: KV<any>;
+  headers: KV<string>;
+}
+export type IRequestBeforeHook = (...args: any[]) => IAppendedRequestInfo;
+export interface ICloudbaseRequest {
+  // fetch: (urlOrPath: string, init?: RequestInit) => Promise<Response>;
+  post: (options: IRequestOptions) => Promise<ResponseObject>;
+  upload: (options: IUploadRequestOptions) => Promise<ResponseObject>;
+  download: (options: IRequestOptions) => Promise<ResponseObject>;
+  // refreshAccessToken: () => Promise<IGetAccessTokenResult>;
+  // getAccessToken: () => Promise<IGetAccessTokenResult>;
+  request: (action: string, params: KV<any>, options?: KV<any>) => Promise<ResponseObject>;
+  send: (action: string, data: KV<any>) => Promise<any>;
+}