@cloudbase/js-sdk 2.28.8 → 2.29.0

package/types/analytics.d.ts

@@ -0,0 +1,51 @@
+// report 接口传参结构
+export interface IReportData {
+  report_type: string, // 上报场景  如电商 mall，游戏 game
+  report_data: {
+    action_time?: number, // 非必填  行为发生时，客户端的时间点，单位s
+    action_type: string, // 必填 行为类型 如 访问 visit_store，分享 share，加入购物车 add_to_cart等
+    click_id?: string, // 非必填  广告平台会在URL增加click_id
+    action_param?: { // 非必填
+      value?: number, // 非必填 行为所带的参数，转化行为价值（例如金额）
+      leads_type?: string // 非必填 行为来源，目前支持PHONE（电话直呼），RESERVE（表单预约）
+    },
+    product_param?: { // 非必填
+      product_yun_type?: string, // 非必填  商品 goods ，优惠券 coupon, 搜索词 search_term
+      product_yun_id?: string, // 非必填 商品id
+      product_yun_category?: string, // 非必填 商品类目 自定义
+      product_yun_keywords?: string, // 非必填 商品关键词
+      product_yun_price?: number, // 非必填 商品原价
+      product_yun_value?: number, // 非必填 商品成交价
+      product_yun_name?: string, // 非必填 商品名
+      product_yun_id_ad?: string, // 非必填 广告商品库中商品id
+      product_yun_category_ad?: string // 非必填 广告商品库中商品类目
+    }
+  }
+}
+
+// 上报数据结构
+export interface IAnalyticsDataItem {
+  analytics_scene: string, // 上报场景  如电商 mall，游戏 game
+  analytics_data: { // 场景模板内容，以电商模板举例
+    openid?: string, // 必填  用户openid
+    wechat_mini_program_appid?: string, // 必填小程序appid
+    action_time: number, // 必填  行为发生时，客户端的时间点，单位s
+    action_type: string, // 必填 行为类型 如 访问 visit_store，分享 share，加入购物车 add_to_cart等
+    click_id?: string, // 非必填  广告平台会在URL增加click_id
+    action_param?: { // 非必填
+      value?: number, // 非必填 行为所带的参数，转化行为价值（例如金额）
+      leads_type?: string // 非必填 行为来源，目前支持PHONE（电话直呼），RESERVE（表单预约）
+    },
+    product_param?: { // 非必填
+      product_yun_type?: string, // 非必填  商品 goods ，优惠券 coupon, 搜索词 search_term
+      product_yun_id?: string, // 非必填 商品id
+      product_yun_category?: string, // 非必填 商品类目 自定义
+      product_yun_keywords?: string, // 非必填 商品关键词
+      product_yun_price?: number, // 非必填 商品原价
+      product_yun_value?: number, // 非必填 商品成交价
+      product_yun_name?: string, // 非必填 商品名
+      product_yun_id_ad?: string, // 非必填 广告商品库中商品id
+      product_yun_category_ad?: string // 非必填 广告商品库中商品类目
+    }
+  }
+}

package/types/auth.d.ts

@@ -0,0 +1,99 @@
+import { ICloudbaseConfig, KV, ICloudbase } from '.'
+import { authModels, UserInfo } from '@cloudbase/oauth'
+import { ICloudbaseEventEmitter } from './events'
+
+export type ICloudbaseAuthConfig = Pick<
+ICloudbaseConfig,
+| 'env'
+| 'clientId'
+| 'region'
+| 'persistence'
+| 'debug'
+| '_fromApp'
+| 'oauthInstance'
+| 'wxCloud'
+| 'i18n'
+| 'accessKey'
+| 'useWxCloud'
+| 'auth'
+> &
+ICloudbaseConfig['auth']
+& {eventBus?: ICloudbaseEventEmitter}
+
+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
+  displayName?: 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: authModels.UserProfile) => Promise<void>
+  refresh: (params?: { version?: string }) => Promise<authModels.UserInfo>
+}
+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<UserInfo & IUser>
+  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
+  /** 当前登录用户，未登录时为 null */
+  currentUser: IUser | null
+}
+
+type IProvider = new (...args: any[]) => any
+
+export interface ICloudbaseAuthModule {
+  registerAuth: (app: ICloudbase) => void
+  registerProvider: (name: string, provider: IProvider) => void
+}

package/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/types/cloudrun.d.ts

@@ -0,0 +1,9 @@
+import { KV } from '.'
+
+export interface ICallContainerOptions {
+  name: string
+  data?: KV<any>
+  method?: string
+  path?: string
+  header?: KV<any>
+}

package/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/types/container.d.ts

@@ -0,0 +1,93 @@
+import { ICloudbaseConfig } from '.'
+
+export interface IContianerConfig {
+  /**
+   * wasm sdk 地址
+   */
+  wasmUrl?: string;
+  /**
+   * js sdk 地址
+   */
+  jsUrl?:
+  | string
+  | {
+    vender?: string;
+    vm?: string;
+  };
+  /**
+   * 账号ID
+   */
+  uin: string;
+  /**
+   * 网关id
+   */
+  gatewayId: string;
+  /**
+   * 网关请求 host port
+   */
+  host: string;
+  port: string;
+  /**
+   * 是否上报数据
+   */
+  report?: boolean | object;
+  /**
+   * public key
+   */
+  publicKey?: string;
+  i18n?: ICloudbaseConfig['i18n'];
+}
+
+export interface ICallContainerOptions {
+  /**
+   * 填入业务自定义url和参数
+   * 根目录，就是 /
+   */
+  url: string;
+  /**
+   * 请求网关api子路由
+   */
+  pathname?: string;
+  /**
+   * 按照自己的业务开发，选择对应的方法
+   * @default GET
+   */
+  method?: string;
+  /**
+   * 设置请求的 header，header 中不能设置 Referer
+   */
+  header?: Record<string, string>;
+  /**
+   * 请求参数
+   */
+  data?: Object;
+  /**
+   * 超时时间，单位毫秒，默认60000
+   */
+  timeout?: number;
+  /**
+   * 超时提示细腻系
+   */
+  timeoutMsg?: string;
+
+  /**
+   * 响应 parse 类型
+   */
+  dataType?: 'json' | string;
+  /**
+   * 响应类型
+   */
+  responseType?: 'text' | 'arrayBuffer';
+  /**
+   * 是否上报数据
+   */
+  report?: boolean;
+  /**
+   * 请求 withCredentials
+   */
+  withCredentials?: boolean;
+  /**
+   * 请求是否为透明模式
+   */
+  transparent?: boolean;
+}

package/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/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/types/functions.d.ts

@@ -0,0 +1,40 @@
+import { KV } from '.'
+
+export interface ICallFunctionOptions {
+  name: string
+  data?: KV<any>
+  query?: KV<any>
+  search?: string
+  parse?: boolean
+  // Used for 云函数2.0 CallContainer
+  type?: string
+  method?: string
+  path?: string
+  header?: KV<any>
+}
+
+export interface ICallFunctionResponse {
+  requestId: string
+  result: any
+}
+
+export type ICallFunction = (options: ICallFunctionOptions, callback?: Function) => Promise<ICallFunctionResponse>
+
+export interface IRetryOptions {
+  retries?: number
+  factor?: number
+  minTimeout?: number
+  maxTimeout?: number
+  randomize?: boolean
+  timeouts?: number[]
+  timeoutOps?: {
+    timeout: number
+    cb: function
+  }
+}
+
+export interface ICustomReqOpts {
+  timeout?: number
+  retryOptions?: IRetryOptions
+  from?: 'node-sdk'
+}

package/types/index.d.ts

@@ -0,0 +1,211 @@
+import { CloudbaseAdapter, SDKAdapterInterface, ResponseObject } from '@cloudbase/adapter-interface'
+import { ICloudbaseComponent, ICloudbaseHook } from './component'
+import { ICloudbaseRequest } from './request'
+import { ICloudbaseCache } from './cache'
+import { ICloudbaseAuth } from './auth'
+import { ICallFunctionOptions, ICallFunctionResponse } from './functions'
+import {
+  ICloudbaseUploadFileParams,
+  ICloudbaseUploadFileResult,
+  ICloudbaseDeleteFileParams,
+  ICloudbaseDeleteFileResult,
+  ICloudbaseGetTempFileURLParams,
+  ICloudbaseGetTempFileURLResult,
+  ICloudbaseDownloadFileParams,
+  ICloudbaseDownloadFileResult,
+  ICloudbaseCopyFileParams,
+  ICloudbaseCopyFileResult,
+} from './storage'
+import { cloudbase } from '../cloudbase/index'
+
+export enum LANGS {
+  ZH = 'zh-CN',
+  EN = 'en-US',
+}
+
+export type Persistence = 'local' | 'session' | 'none'
+
+export interface KV<T> {
+  [key: string]: T
+}
+
+export interface KVstring {
+  [key: string]: string
+}
+
+export type EndPointKey = 'CLOUD_API' | 'GATEWAY'
+
+/** 自定义登录凭证信息（从控制台下载的私钥文件） */
+export interface ICredentialsInfo {
+  /** 私钥 ID */
+  private_key_id: string;
+  /** RSA 私钥内容 */
+  private_key: string;
+  /** 所属环境 ID */
+  env_id: string;
+}
+
+export interface ICloudbaseConfig {
+  env: string
+  intl?: boolean,
+  region?: string
+  timeout?: number
+  persistence?: Persistence
+  oauthClient?: any
+  debug?: boolean
+  _fromApp?: ICloudbase
+  clientId?: string
+  oauthInstance?: any
+  wxCloud?: any
+  i18n?: {
+    t: (text: string) => string
+    LANG_HEADER_KEY: string
+    lang: LANGS
+  }
+  accessKey?: string
+  endPointMode?: EndPointKey // auth请求域名模式，默认CLOUD_API
+  useWxCloud?: boolean // 是否使用微信云开发链路
+  auth?: {
+    detectSessionInUrl?: boolean
+    secretId?: string
+    secretKey?: string
+    sessionToken?: string
+    secretType?: 'SESSION_SECRET' | 'SECRET'
+    credentials?: ICredentialsInfo // 自定义登录私钥信息，node端使用
+  }
+  // @cloudbase/functions-framework 函数上下文，只要求部分字段，只在云函数或云托管中有效
+  context?: Readonly<{
+    eventID: string
+    extendedContext?: {
+      envId: string // 环境 ID
+      // uin: string             // 请求的 UIN
+      source: string // 请求来源，如 wx
+      accessToken?: string // 调用请求时的 AccessToken
+      userId?: string // 请求的用户 ID
+      tmpSecret?: {
+        // 临时凭证
+        secretId: string // secretId
+        secretKey: string // secretKey
+        token: string // token
+      }
+    }
+  }>
+}
+// 可更新的配置字段
+export type ICloudbaseUpgradedConfig = Pick<ICloudbaseConfig, 'persistence' | 'region' | 'debug'>
+
+export interface ICloudbaseExtension {
+  name: string
+  invoke: (opts: any, app: ICloudbase) => Promise<any>
+}
+
+declare type MethodType = 'request' | 'post' | 'get' | 'head' | 'patch' | 'delete' | 'put'
+export interface ICloudbaseApis {
+  [apiName: string]: {
+    [method in MethodType]: (callApiOptions: ICallApiOptions, opts?: KV<any>) => Promise<ResponseObject['data']>
+  }
+}
+
+export interface ICloudbase {
+  config: ICloudbaseConfig
+  platform: ICloudbasePlatformInfo
+  cache: ICloudbaseCache
+  request: ICloudbaseRequest
+  oauthClient: any
+  localCache: ICloudbaseCache
+  authInstance?: ICloudbaseAuth
+  oauthInstance?: any
+  apis: ICloudbaseApis
+  init: (config: ICloudbaseConfig & { lang?: LANGS }) => cloudbase.app
+  updateConfig: (config: ICloudbaseUpgradedConfig) => void
+  registerExtension: (ext: ICloudbaseExtension) => void
+  invokeExtension: (name: string, opts: any) => Promise<any>
+  useAdapters: (adapters: CloudbaseAdapter | CloudbaseAdapter[], options?: any) => void
+  registerComponent: (component: ICloudbaseComponent) => void
+  registerHook: (hook: ICloudbaseHook) => void
+  registerVersion: (version: string) => void
+  fire?: (...args: any[]) => void
+  updateLang?: (lang: LANGS) => void
+  /**
+   * 检查当前 Cloudbase 实例是否已完成初始化
+   * @returns 是否已初始化
+   */
+  isInitialized?: () => boolean
+  getEndPointWithKey?: (key: EndPointKey) => {
+    BASE_URL: string
+    PROTOCOL: string
+  }
+  auth?: (options?: { persistence: cloudbase.auth.Persistence }) => cloudbase.auth.App
+
+  // ---- 云函数 ----
+  /** 调用云函数 */
+  callFunction?: (options: ICallFunctionOptions, callback?: Function) => Promise<ICallFunctionResponse>
+
+  // ---- 数据库 ----
+  /** 获取数据库实例 */
+  database?: (dbConfig?: { instance?: string; database?: string }) => cloudbase.database.App
+
+  // ---- 云存储 ----
+  /** Storage 命名空间实例（from 分流 + Bucket 管理） */
+  storage?: cloudbase.storage.StorageClient
+  /** 上传文件 */
+  uploadFile?: (params: ICloudbaseUploadFileParams, callback?: Function) => Promise<ICloudbaseUploadFileResult>
+  /** 下载文件 */
+  downloadFile?: (params: ICloudbaseDownloadFileParams, callback?: Function) => Promise<ICloudbaseDownloadFileResult>
+  /** 删除云端文件 */
+  deleteFile?: (params: ICloudbaseDeleteFileParams, callback?: Function) => Promise<ICloudbaseDeleteFileResult>
+  /** 获取文件临时下载链接 */
+  getTempFileURL?: (params: ICloudbaseGetTempFileURLParams, callback?: Function) => Promise<ICloudbaseGetTempFileURLResult>
+  /** 复制/移动文件 */
+  copyFile?: (params: ICloudbaseCopyFileParams, callback?: Function) => Promise<ICloudbaseCopyFileResult>
+}
+
+/**
+ * Node.js 端适配器扩展方法
+ */
+export interface INodeAdapterExtend {
+  /**
+   * 从环境变量中获取腾讯云临时密钥信息
+   * 用于 API 请求签名
+   */
+  getSecretInfo?: (config?: ICloudbaseConfig) => {
+    env: string
+    secretId: string
+    secretKey: string
+    sessionToken: string
+    accessKey: string
+    secretType: string
+  }
+  /**
+   * 初始化 Node.js 端工具方法，挂载到 js-sdk app 实例上
+   * 包含：auth 相关方法、模板消息推送、context 解析
+   */
+  nodeTool?: (
+    /** js-sdk cloudbase 实例 */
+    app: any,
+    /** 配置信息，包含认证凭证和环境 ID */
+    config: ICloudbaseConfig,
+  ) => void
+}
+export interface ICloudbasePlatformInfo {
+  adapter?: SDKAdapterInterface & INodeAdapterExtend
+  runtime?: string
+}
+
+export interface IGenericError<T extends string, P = any> extends Error {
+  type: T
+  payload: P
+  generic: boolean
+}
+
+export interface ICallApiOptions {
+  /** api标识 */
+  name?: string
+  /** 请求的path */
+  path?: string
+  method?: string
+  headers?: KV<any>
+  /** 请求体，根据content-type可以是不同类型 */
+  body?: KV<any> | string
+  token?: string
+}

package/types/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@cloudbase/types",
+  "version": "2.29.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",
+    "cloudrun.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.7.1"
+  },
+  "gitHead": "859557576897d4778857c12fb8d7fe8ca1f3a052"
+}