@cloudbase/database 1.4.3 → 1.5.1

package/src/document.ts

@@ -4,9 +4,8 @@ import { UpdateSerializer } from './serializer/update'
 import { serialize } from './serializer/datatype'
 import { UpdateCommand } from './commands/update'
 import { IWatchOptions, DBRealtimeListener } from './typings/index'
-import { RealtimeWebSocketClient } from './realtime/websocket-client'
 import { QueryType } from './constant'
-import { getReqOpts, stringifyByEJSON, processReturn } from './utils/utils'
+import { getWsInstance, getReqOpts, stringifyByEJSON, processReturn, withCallback } from './utils/utils'
 import { ERRORS } from './const/code'
 import { EJSON } from 'bson'
 import { QueryOption, UpdateOption } from './query'
@@ -24,11 +23,6 @@ export class DocumentReference {
 
   readonly _transactionId: string
 
-  /**
-   *
-   */
-  readonly projection: Object
-
   /**
    * 数据库引用
    *
@@ -73,7 +67,7 @@ export class DocumentReference {
     this.id = docID
     this._transactionId = transactionId
     /* eslint-disable new-cap*/
-    this.request = new Db.reqClass(this._db.config)
+    this.request = Db.createRequest(this._db.config)
     this._apiOptions = apiOptions
   }
 
@@ -83,16 +77,23 @@ export class DocumentReference {
    * @param data - 文档数据
    * @internal
    */
-  async create(data: any): Promise<any> {
+  create(data: any, callback?: any): Promise<any> {
+    return withCallback(this._create(data), callback)
+  }
+
+  private async _create(data: any): Promise<any> {
+    const isBatch = Array.isArray(data)
+
     // 存在docid 则放入data
-    if (this.id) {
+    if (!isBatch && this.id) {
       data['_id'] = this.id
     }
 
     let params = {
       collectionName: this._coll,
-      // data: Util.encodeDocumentDataForReq(data, false, false)
-      data: [stringifyByEJSON(serialize(data))],
+      data: isBatch
+        ? data.map((item: any) => stringifyByEJSON(serialize(item)))
+        : [stringifyByEJSON(serialize(data))],
       transactionId: this._transactionId
     }
 
@@ -116,11 +117,18 @@ export class DocumentReference {
       }
     }
 
+    // 批量创建，返回 ids
+    if (isBatch) {
+      return {
+        ids: (res.data && res.data.insertedIds) || [],
+        requestId: res.requestId
+      }
+    }
+
     return {
       id: res.data.insertedIds[0],
       requestId: res.requestId
     }
-    // }
   }
 
   /**
@@ -132,7 +140,11 @@ export class DocumentReference {
    * @param data - 文档数据
    * @param opts - 可选项
    */
-  async set(data: Object): Promise<any> {
+  set(data: Object, callback?: any): Promise<any> {
+    return withCallback(this._set(data), callback)
+  }
+
+  private async _set(data: Object): Promise<any> {
     if (!this.id) {
       return processReturn(this._db.config.throwOnCode, {
         ...ERRORS.INVALID_PARAM,
@@ -226,7 +238,11 @@ export class DocumentReference {
    * @param data - 文档数据
    * @param opts - 可选项
    */
-  async update(data: Object): Promise<any> {
+  update(data: Object, callback?: any): Promise<any> {
+    return withCallback(this._update(data), callback)
+  }
+
+  private async _update(data: Object): Promise<any> {
     if (!data || typeof data !== 'object') {
       return processReturn(this._db.config.throwOnCode, {
         ...ERRORS.INVALID_PARAM,
@@ -277,14 +293,18 @@ export class DocumentReference {
   /**
    * 删除文档（事务兼容delete接口）
    */
-  async delete(): Promise<any> {
-    return this.remove()
+  delete(callback?: any): Promise<any> {
+    return this.remove(callback)
   }
 
   /**
    * 删除文档
    */
-  async remove(): Promise<any> {
+  remove(callback?: any): Promise<any> {
+    return withCallback(this._remove(), callback)
+  }
+
+  private async _remove(): Promise<any> {
     const query = stringifyByEJSON({ _id: this.id })
     const param = {
       collectionName: this._coll,
@@ -317,7 +337,11 @@ export class DocumentReference {
   /**
    * 返回选中的文档（_id）
    */
-  async get(): Promise<any> {
+  get(callback?: any): Promise<any> {
+    return withCallback(this._get(), callback)
+  }
+
+  private async _get(): Promise<any> {
     const query = stringifyByEJSON({ _id: this.id })
     const { projection } = this._apiOptions as QueryOption
     const param: any = {
@@ -327,7 +351,6 @@ export class DocumentReference {
       queryType: QueryType.DOC,
       multi: false
     }
-
     if (projection) {
       param.projection = stringifyByEJSON(projection)
     }
@@ -387,20 +410,9 @@ export class DocumentReference {
    * 监听单个文档
    */
   watch = (options: IWatchOptions): DBRealtimeListener => {
-    if (!Db.ws) {
-      Db.ws = new RealtimeWebSocketClient({
-        context: {
-          appConfig: {
-            docSizeLimit: 1000,
-            realtimePingInterval: 10000,
-            realtimePongWaitTimeout: 5000,
-            request: this.request
-          }
-        }
-      })
-    }
+    const ws = getWsInstance(this._db)
 
-    return (Db.ws as RealtimeWebSocketClient).watch({
+    return ws.watch({
       ...options,
       envId: this._db.config.env,
       collectionName: this._coll,
@@ -409,6 +421,5 @@ export class DocumentReference {
         _id: this.id
       })
     })
-    // })
   }
 }

package/src/index.ts

@@ -5,8 +5,16 @@ import { Command } from './command'
 import { ServerDateConstructor } from './serverDate/index'
 import { RegExpConstructor } from './regexp/index'
 import { startTransaction, runTransaction } from './transaction/index'
+import { LogicCommand } from './commands/logic'
+import { QueryCommand } from './commands/query'
+import { UpdateCommand } from './commands/update'
 import { ObjectIdConstructor } from './ObjectId/index'
 
+/**
+ * 数据库配置接口（兼容旧名，实际为完整的 CloudBase 配置）
+ */
+export type IDbConfig = ICloudBaseConfig
+
 /**
  * 地理位置类型
  */
@@ -18,7 +26,7 @@ export { Query } from './query'
 export { CollectionReference } from './collection'
 export { DocumentReference } from './document'
 
-interface ICloudBaseConfig {
+export interface ICloudBaseConfig {
   timeout?: number
   isHttp?: boolean
   secretId?: string
@@ -68,12 +76,18 @@ export class Db {
 
   runTransaction: any
 
+  logicCommand: any
+
+  updateCommand: any
+
+  queryCommand: any
+
   /**
    * 初始化
    *
    * 默认是 `default` 数据库，为今后扩展使用
    *
-   * @param config
+   * @param config - 数据库配置
    */
   config: ICloudBaseConfig
 
@@ -83,6 +97,8 @@ export class Db {
 
   static wsClass: any
 
+  static wsClientClass: any
+
   // 创建签名的工具函数，由jssdk传入
   static createSign: Function
 
@@ -94,7 +110,33 @@ export class Db {
   // 应用签名信息，由jssdk传入
   static appSecretInfo: any
 
-  constructor(config?: any) {
+  // 创建请求实例的包装方法，自动添加instance和database参数
+  static createRequest(config: ICloudBaseConfig): any {
+    const request = new Db.reqClass(config)
+    const originalSend = request.send
+
+    // 包装send方法，自动添加instance和database参数；
+    // 剩余参数（如 2.0 引擎的 getReqOpts，含 per-request timeout）原样透传
+    request.send = function(action: string, data: any, ...args: any[]): any {
+      // data 可能为空（如事务 startTransaction 不带参数），注入前需防护
+      if (data) {
+        // 如果配置中包含instance或database参数，添加到请求数据中
+        if (config.instance) {
+          data.instance = config.instance
+        }
+        if (config.database) {
+          data.database = config.database
+        }
+      }
+
+      // 调用原始的send方法
+      return originalSend.call(this, action, data, ...args)
+    }
+
+    return request
+  }
+
+  constructor(config?: ICloudBaseConfig) {
     this.config = config
     this.Geo = Geo
     this.serverDate = ServerDateConstructor
@@ -103,6 +145,11 @@ export class Db {
     this.ObjectId = ObjectIdConstructor
     this.startTransaction = startTransaction
     this.runTransaction = runTransaction
+
+    // 暴露command类 给新sdk灰度兼容用
+    this.logicCommand = LogicCommand
+    this.updateCommand = UpdateCommand
+    this.queryCommand = QueryCommand
   }
 
   /**
@@ -121,7 +168,7 @@ export class Db {
    * 创建集合
    */
   createCollection(collName: string) {
-    let request = new Db.reqClass(this.config)
+    let request = Db.createRequest(this.config)
 
     const params = {
       collectionName: collName

package/src/query.ts

@@ -9,9 +9,8 @@ import { QuerySerializer } from './serializer/query'
 import { UpdateSerializer } from './serializer/update'
 // import { WSClient } from "./websocket/wsclient"
 import { IWatchOptions, DBRealtimeListener } from './typings/index'
-import { RealtimeWebSocketClient } from './realtime/websocket-client'
 import { ErrorCode } from './constant'
-import { getReqOpts, stringifyByEJSON, processReturn } from './utils/utils'
+import { getWsInstance, getReqOpts, stringifyByEJSON, toWatchQuery, processReturn, withCallback } from './utils/utils'
 import { ERRORS } from './const/code'
 import { EJSON } from 'bson'
 
@@ -35,8 +34,8 @@ export interface QueryOption extends BaseOption {
   offset?: number
   // 指定显示或者不显示哪些字段
   projection?: Object
-  // 结果排序
-  order?: Record<string, any>[]
+  // 结果排序（orderBy() 存为 { field: 1 | -1 }）
+  order?: Record<string, any>
 }
 
 export interface UpdateOption extends BaseOption {
@@ -156,7 +155,7 @@ export class Query {
     this._fieldFilters = fieldFilters
     this._apiOptions = apiOptions || {}
     /* eslint-disable new-cap */
-    this._request = new Db.reqClass(this._db.config)
+    this._request = Db.createRequest(this._db.config)
     this._transactionId = transactionId
   }
 
@@ -166,7 +165,11 @@ export class Query {
    * - 默认获取集合下全部文档数据
    * - 可以把通过 `orderBy`、`where`、`skip`、`limit`设置的数据添加请求参数上
    */
-  public async get(): Promise<GetRes> {
+  public get(callback?: any): Promise<GetRes> {
+    return withCallback(this._get(), callback) as Promise<GetRes>
+  }
+
+  private async _get(): Promise<GetRes> {
     /* eslint-disable no-param-reassign */
 
     const order = (this._apiOptions as QueryOption).order
@@ -176,7 +179,7 @@ export class Query {
       transactionId?: string
       query?: Object
       queryType: QueryType
-      order?: string[]
+      order?: string
       offset?: number
       limit?: number
       projection?: Object
@@ -200,14 +203,8 @@ export class Query {
     if (offset) {
       param.offset = offset
     }
-
     const limit = (this._apiOptions as QueryOption).limit
 
-    // if (this._queryOptions.limit) {
-    //   param.limit = this._queryOptions.limit < 1000 ? this._queryOptions.limit : 1000
-    // } else {
-    //   param.limit = 100
-    // }
     if (limit) {
       param.limit = limit < 1000 ? limit : 1000
     } else {
@@ -252,7 +249,11 @@ export class Query {
   /**
    * 获取总数
    */
-  public async count() {
+  public count(callback?: any) {
+    return withCallback(this._count(), callback)
+  }
+
+  private async _count() {
     interface Param {
       collectionName: string
       query?: Object
@@ -348,7 +349,6 @@ export class Query {
     const order = (this._apiOptions as QueryOption).order || {}
 
     const newApiOption = Object.assign({}, this._apiOptions, {
-      // order: order.concat(newOrder)
       order: Object.assign({}, order, newOrder)
     })
 
@@ -390,7 +390,11 @@ export class Query {
    *
    * @param data 数据
    */
-  public async update(data: Object): Promise<any> {
+  public update(data: Object, callback?: any): Promise<any> {
+    return withCallback(this._update(data), callback)
+  }
+
+  private async _update(data: Object): Promise<any> {
     if (!data || typeof data !== 'object') {
       return processReturn(this._db.config.throwOnCode, {
         ...ERRORS.INVALID_PARAM,
@@ -419,6 +423,10 @@ export class Query {
       data: UpdateSerializer.encodeEJSON(data, this._apiOptions.raw || false)
     }
 
+    if (this._transactionId) {
+      param.transactionId = this._transactionId
+    }
+
     if (this._fieldFilters) {
       param.query = this._fieldFilters
     }
@@ -481,7 +489,11 @@ export class Query {
   /**
    * 条件删除文档
    */
-  public async remove() {
+  public remove(callback?: any) {
+    return withCallback(this._remove(), callback)
+  }
+
+  private async _remove() {
     // if (Object.keys(this._queryOptions).length > 0) {
     //   console.warn('`offset`, `limit` and `projection` are not supported in remove() operation')
     // }
@@ -504,12 +516,15 @@ export class Query {
     let { multiple } = this._apiOptions as UpdateOption
     const multi = multiple === undefined ? true : multiple // where remove 不传multi默认为true
 
-    const param = {
+    const param: any = {
       collectionName: this._coll,
       query: this._fieldFilters,
       queryType: QueryType.WHERE,
       multi
     }
+    if (this._transactionId) {
+      param.transactionId = this._transactionId
+    }
     const res = await this._request.send(
       'database.removeDocument',
       param,
@@ -579,33 +594,28 @@ export class Query {
    * 监听query对应的doc变化
    */
   watch = (options: IWatchOptions): DBRealtimeListener => {
-    if (!Db.ws) {
-      Db.ws = new RealtimeWebSocketClient({
-        context: {
-          appConfig: {
-            docSizeLimit: 1000,
-            realtimePingInterval: 10000,
-            realtimePongWaitTimeout: 5000,
-            request: this._request
-          }
-        }
-      })
-    }
+    const ws = getWsInstance(this._db)
 
     const { limit, order } = this._apiOptions as QueryOption
 
-    return (Db.ws as RealtimeWebSocketClient).watch({
+    // order 由 orderBy() 存为 { field: 1 | -1 }，实时推送协议要求 'asc' | 'desc'
+    const orderBy = order
+      ? Object.entries(order).reduce<Record<string, string>>((acc, [field, direction]) => {
+          acc[field] = direction === -1 ? 'desc' : 'asc'
+          return acc
+        }, {})
+      : undefined
+
+    return ws.watch({
       ...options,
       envId: this._db.config.env,
       collectionName: this._coll,
-      query: JSON.stringify(this._fieldFilters), // 实时推送这里需要换成ejson协议，todo
+      // where() 产出 canonical EJSON 字符串，但 watch 协议要求 legacy 内部编码
+      // （数字裸值、$date 为 epoch 毫秒数字）——canonical 形态服务端虽接受但会静默匹配不到文档，
+      // 且不可再 JSON.stringify（否则双重编码，线上 100003 事故根因）
+      query: toWatchQuery(this._fieldFilters),
       limit,
-      orderBy: order
-        ? order.reduce<Record<string, string>>((acc, cur) => {
-            acc[cur.field] = cur.direction
-            return acc
-          }, {})
-        : undefined
+      orderBy
     })
   }
 }

package/src/serializer/query.ts

@@ -4,15 +4,27 @@ import {
   QUERY_COMMANDS_LITERAL,
   QueryCommand
 } from '../commands/query'
-import { isLogicCommand, LOGIC_COMMANDS_LITERAL, LogicCommand } from '../commands/logic'
+import {
+  isLogicCommand,
+  LOGIC_COMMANDS_LITERAL,
+  LogicCommand
+} from '../commands/logic'
 import { SYMBOL_UNSET_FIELD_NAME, SYMBOL_GEO_POINT } from '../helper/symbol'
 import { getType, isObject, isArray, isRegExp, isDate } from '../utils/type'
 import { operatorToString } from '../operator-map'
-import { flattenQueryObject, isConversionRequired, encodeInternalDataType } from './common'
-import { IGeoNearOptions, IGeoWithinOptions, IGeoIntersectsOptions } from '../commands/query'
+import {
+  flattenQueryObject,
+  isConversionRequired,
+  encodeInternalDataType
+} from './common'
+import {
+  IGeoNearOptions,
+  IGeoWithinOptions,
+  IGeoIntersectsOptions
+} from '../commands/query'
 import { stringifyByEJSON } from '../utils/utils'
 import { Validate } from '../validate'
-import { Point } from '../geo'
+import { Point } from '../geo/index'
 
 export type IQueryCondition = Record<string, any> | LogicCommand
 
@@ -39,10 +51,10 @@ class QueryEncoder {
       } else if (isQueryCommand(query)) {
         return this.encodeQueryCommand(query)
       } else if (isRegExp(query)) {
-        //  /xxx/ 形式
+        // /xxx/ 形式
         return { [key]: this.encodeRegExp(query) }
       } else if (isDate(query)) {
-        return { [key]: query }
+        return { [key]: encodeInternalDataType(query) }
       } else {
         return { [key]: this.encodeQueryObject(query) }
       }

package/src/transaction/index.ts

@@ -27,7 +27,7 @@ export class Transaction {
 
   public constructor(db: Db) {
     this._db = db
-    this._request = new Db.reqClass(this._db.config)
+    this._request = Db.createRequest(this._db.config)
     this.aborted = false
     this.commited = false
     this.inited = false

package/src/typings/index.ts

@@ -1,10 +1,6 @@
 /**
  * Common interfaces and types
  */
-
-/**
- * Database Watch
- */
 import { Point } from '../geo/index'
 
 export type DataType = 'init' | 'update' | 'add' | 'remove' | 'replace' | 'limit'

package/src/utils/utils.ts

@@ -1,9 +1,29 @@
+import { Db } from '../'
 import { QueryOption, UpdateOption } from '../query'
 import { EJSON } from 'bson'
 import { isObject } from './type'
 
 export const sleep = (ms: number = 0) => new Promise(r => setTimeout(r, ms))
 
+/**
+ * 兼容旧版 callback 调用风格（对齐 0.12.x 行为）：
+ * - 传入 callback：成功时 callback(0, result)、失败时 callback(err)，方法返回 undefined
+ * - 不传 callback：原样返回 promise
+ *
+ * 注意用 then(f, g) 而非 then(f).catch(g)，保证派生 promise 为 resolved，
+ * 避免 callback 模式下产生 unhandled rejection。
+ */
+export function withCallback<T>(promise: Promise<T>, callback?: any): Promise<T> | undefined {
+  if (typeof callback === 'function') {
+    promise.then(
+      (res: any) => callback(0, res),
+      (err: any) => callback(err)
+    )
+    return undefined
+  }
+  return promise
+}
+
 const counters: Record<string, number> = {}
 
 export const autoCount = (domain: string = 'any'): number => {
@@ -13,6 +33,32 @@ export const autoCount = (domain: string = 'any'): number => {
   return counters[domain]++
 }
 
+/**
+ * 工厂模式创建 ws 实例
+ */
+const wsList = {}
+export function getWsInstance(db: Db) {
+  if(!Db.wsClientClass){
+    throw new Error('to use realtime you must import realtime module first')
+  }
+  const { env } = db.config
+
+  if (!wsList[env]) {
+    wsList[env] = new Db.wsClientClass({
+      context: {
+        appConfig: {
+          docSizeLimit: 1000,
+          realtimePingInterval: 10000,
+          realtimePongWaitTimeout: 5000,
+          request: Db.createRequest(db.config)
+        }
+      }
+    })
+  }
+
+  return wsList[env]
+}
+
 export const getReqOpts = (apiOptions: QueryOption | UpdateOption): any => {
   // 影响底层request的暂时只有timeout
   if (apiOptions.timeout !== undefined) {
@@ -53,6 +99,65 @@ export const parseByEJSON = params => {
   return EJSON.parse(params)
 }
 
+/**
+ * 将 EJSON 值递归转为实时推送 watch 协议要求的 legacy 内部编码（0.12.x 形态）
+ * - Date → { $date: <epoch 毫秒数字> }
+ * - ObjectId → { $oid }、BSONRegExp/原生 RegExp → { $regex, $options }
+ * - 数字/字符串/布尔等基本值保持裸值
+ *
+ * bson 类型用 _bsontype 字符串判断而非 instanceof：EJSON.parse 产出的实例
+ * 来自运行时实际加载的 bson（可能与编译时版本/副本不同），instanceOf 跨副本
+ * 会失效，_bsontype 是 bson 各版本稳定的类型标记。
+ */
+const toWatchLegacyValue = (val: any): any => {
+  if (val instanceof Date) {
+    return { $date: +val }
+  }
+  if (val instanceof RegExp) {
+    // 原生 RegExp 兜底（正常链路编码器已转 $regularExpression，raw 模式等可能漏过）
+    return { $regex: val.source, $options: val.flags }
+  }
+  if (val && typeof val === 'object') {
+    if (val._bsontype === 'ObjectId') {
+      return { $oid: val.toHexString() }
+    }
+    if (val._bsontype === 'BSONRegExp') {
+      return { $regex: val.pattern, $options: val.options }
+    }
+    if (Array.isArray(val)) {
+      return val.map(toWatchLegacyValue)
+    }
+    const ret: Record<string, any> = {}
+    for (const key of Object.keys(val)) {
+      ret[key] = toWatchLegacyValue(val[key])
+    }
+    return ret
+  }
+  return val
+}
+
+/**
+ * 实时推送 watch 协议的 query 编码
+ *
+ * where() 产出的 _fieldFilters 是 canonical EJSON 字符串（relaxed:false），
+ * 但服务端 watch 查询引擎只认 0.12.x 的 legacy 内部编码：
+ * - 数字必须裸值（{$numberInt}/{$numberLong} 会被静默匹配不到文档，实测 0 命中）
+ * - 日期必须是 { $date: <epoch 毫秒数字> }（ISO 串与 {$date:{$numberLong}} 均不命中）
+ * 此处 parse 后转成 legacy 形态再序列化。
+ */
+export const toWatchQuery = (ejsonStr: string): string => {
+  if (!ejsonStr) {
+    return '{}'
+  }
+  try {
+    const parsed = EJSON.parse(ejsonStr)
+    return JSON.stringify(toWatchLegacyValue(parsed))
+  } catch (e) {
+    // 非 EJSON 文本（EJSON.parse 兼容普通 JSON，走到这说明确实解析不了），原样透传由调用方保证格式
+    return ejsonStr
+  }
+}
+
 export class TcbError extends Error {
   readonly code: string
   readonly message: string

package/src/validate.ts

@@ -11,9 +11,8 @@ import { QueryOption, UpdateOption } from './query'
 import { ERRORS } from './const/code'
 import { E } from './utils/utils'
 import { getType } from './utils/type'
-import { Point } from './geo'
+import { Point } from './geo/index'
 import { CenterSphere } from './typings'
-
 import { SYMBOL_GEO_POINT } from './helper/symbol'
 
 const validOptionsKeys = ['limit', 'offset', 'projection', 'order', 'multiple', 'timeout', 'raw']
@@ -243,11 +242,9 @@ export class Validate {
   }
 
   /**
+   * 校验 centerSphere 结构
    *
-   * @static
-   * @param {[Point, number]} param
-   * @returns {Boolean}
-   * @memberof Validate
+   * @param param - [Point, number] 或 [[number, number], number]
    */
   static isCentersPhere(param: CenterSphere): Boolean {
     if (Array.isArray(param) && param.length === 2) {