@cloudbase/database 1.3.0 → 1.4.1

package/README.md

@@ -15,7 +15,7 @@ yarn add @cloudbase/database
 
 ## 使用
 
-使用 `@cloudbase/database` 时，需要提供发送请求的类 `reqClass`。 
+使用 `@cloudbase/database` 时，需要提供发送请求的类 `reqClass`。
 
 ```js
 // index.js
@@ -38,23 +38,23 @@ class Tcb {
 // request.js
 
 // 进一步处理，鉴权等...
-const requestHandler = require('requestHandler');
+const requestHandler = require('requestHandler')
 
 class Request {
   constructor(config) {
-    this.config = config;
+    this.config = config
   }
 
   async send(action, data) {
     const params = Object.assign({}, data, {
       action
-    });
+    })
 
     const slowQueryWarning = setTimeout(() => {
       console.warn(
         'Database operation is longer than 3s. Please check query performance and your network environment.'
-      );
-    }, 3000);
+      )
+    }, 3000)
 
     try {
       return await requestHandler({
@@ -65,14 +65,14 @@ class Request {
         headers: {
           'content-type': 'application/json'
         }
-      });
+      })
     } finally {
-      clearTimeout(slowQueryWarning);
+      clearTimeout(slowQueryWarning)
     }
   }
 }
 
-module.exports = Request;
+module.exports = Request
 ```
 
 请求数据样例
@@ -94,4 +94,26 @@ module.exports = Request;
   },
   "json": true
 }
-```
+```
+
+## 开发指南
+
+### 注意
+
+当前 database 库是通过分支来控制了两个不同的版本，主干版提供给@cloudbase/js-sdk 库使用，feature/support_db_2.0 分支提供给@cloudbase/node-sdk 库使用。
+
+两个分支区别：
+support_db_2.0 分支进行了数据库接口的升级，将原有的 json 协议转换为 mongo 支持的 bson 协议处理，目的是解决旧接口存在的问题，描述如下
+
+- 日期对象 是走约定协议处理，即转换为 {$date: timestamp}，这种方式应摒弃(EJSON 协议可解决)
+- 无法支持 null, NaN 等特殊类型处理(EJSON 协议可解决)
+- serverDate 这种自定义类型的实现，是继续保留 还是摒弃
+- 接口实现混杂，普通 CRUD 接口均走 flexdb，而聚合，事务又用 runcommand 方式
+- 原插入文档接口返回 docId 形式混杂
+
+目前仅针对服务端 sdk @cloudbase/node-sdk 完成了升级，而客户端 sdk @cloudbase/js-sdk 以及 小程序端 SDK 仍保留为旧接口形式。
+
+### 开发及发布事项
+
+1. 数据库接口的改动务必补充测试用例验证
+2. 发布时，约定 feature/support_db_2.0 分支上发布正式版（for @cloudbase/node-sdk）使用，master 分支上发布 beta 版 (for @cloudbase/js-sdk)使用。两 sdk 均通过锁版本方式依赖该库，不会受自动更新依赖影响。

package/dist/commonjs/ObjectId/index.d.ts

@@ -0,0 +1,11 @@
+export declare class ObjectId {
+    id: string;
+    constructor({ id }?: {
+        id?: string;
+    });
+    readonly _internalType: import("../utils/symbol").InternalSymbol;
+    parse(): {
+        $oid: string;
+    };
+}
+export declare function ObjectIdConstructor(opt: any): ObjectId;

package/dist/commonjs/ObjectId/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const symbol_1 = require("../helper/symbol");
+class ObjectId {
+    constructor({ id = '' } = {}) {
+        this.id = id;
+    }
+    get _internalType() {
+        return symbol_1.SYMBOL_OBJECTID;
+    }
+    parse() {
+        return {
+            $oid: this.id
+        };
+    }
+}
+exports.ObjectId = ObjectId;
+function ObjectIdConstructor(opt) {
+    return new ObjectId(opt);
+}
+exports.ObjectIdConstructor = ObjectIdConstructor;

package/dist/commonjs/aggregate.d.ts

@@ -1,29 +1,29 @@
-export default class Aggregation {
-    _db: any;
-    _request: any;
-    _stages: any[];
-    _collectionName: string;
-    constructor(db?: any, collectionName?: any, rawPipeline?: any);
-    end(): Promise<any>;
-    unwrap(): any[];
-    done(): {
-        [x: number]: any;
-    }[];
-    _pipe(stage: any, param: any, raw?: boolean): this;
-    addFields(param: any): this;
-    bucket(param: any): this;
-    bucketAuto(param: any): this;
-    count(param: any): this;
-    geoNear(param: any): this;
-    group(param: any): this;
-    limit(param: any): this;
-    match(param: any): this;
-    project(param: any): this;
-    lookup(param: any): this;
-    replaceRoot(param: any): this;
-    sample(param: any): this;
-    skip(param: any): this;
-    sort(param: any): this;
-    sortByCount(param: any): this;
-    unwind(param: any): this;
-}
+export default class Aggregation {
+    _db: any;
+    _request: any;
+    _stages: any[];
+    _collectionName: string;
+    constructor(db?: any, collectionName?: any, rawPipeline?: any);
+    end(): Promise<any>;
+    unwrap(): any[];
+    done(): {
+        [x: number]: any;
+    }[];
+    _pipe(stage: any, param: any, raw?: boolean): this;
+    addFields(param: any): this;
+    bucket(param: any): this;
+    bucketAuto(param: any): this;
+    count(param: any): this;
+    geoNear(param: any): this;
+    group(param: any): this;
+    limit(param: any): this;
+    match(param: any): this;
+    project(param: any): this;
+    lookup(param: any): this;
+    replaceRoot(param: any): this;
+    sample(param: any): this;
+    skip(param: any): this;
+    sort(param: any): this;
+    sortByCount(param: any): this;
+    unwind(param: any): this;
+}

package/dist/commonjs/aggregate.js

@@ -1,124 +1,124 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = require("./index");
-const bson_1 = require("bson");
-const query_1 = require("./serializer/query");
-const utils_1 = require("./utils/utils");
-const type_1 = require("./utils/type");
-const validate_1 = require("./validate");
-const EARTH_RADIUS = 6378100;
-class Aggregation {
-    constructor(db, collectionName, rawPipeline) {
-        this._stages = [];
-        if (db && collectionName) {
-            this._db = db;
-            this._request = new index_1.Db.reqClass(this._db.config);
-            this._collectionName = collectionName;
-            if (rawPipeline && rawPipeline.length > 0) {
-                rawPipeline.forEach((stage) => {
-                    validate_1.Validate.isValidAggregation(stage);
-                    const stageName = Object.keys(stage)[0];
-                    this._pipe(stageName, stage[stageName], true);
-                });
-            }
-        }
-    }
-    async end() {
-        if (!this._collectionName || !this._db) {
-            throw new Error('Aggregation pipeline cannot send request');
-        }
-        const result = await this._request.send('database.aggregateDocuments', {
-            collectionName: this._collectionName,
-            stages: this._stages
-        });
-        if (result && result.data && result.data.list) {
-            return {
-                requestId: result.requestId,
-                data: result.data.list.map(bson_1.EJSON.parse)
-            };
-        }
-        return result;
-    }
-    unwrap() {
-        return this._stages;
-    }
-    done() {
-        return this._stages.map(({ stageKey, stageValue }) => {
-            return {
-                [stageKey]: JSON.parse(stageValue)
-            };
-        });
-    }
-    _pipe(stage, param, raw = false) {
-        let transformParam = '';
-        if (type_1.getType(param) === 'object') {
-            transformParam = utils_1.stringifyByEJSON(param);
-        }
-        else {
-            transformParam = JSON.stringify(param);
-        }
-        this._stages.push({
-            stageKey: raw ? stage : `$${stage}`,
-            stageValue: transformParam
-        });
-        return this;
-    }
-    addFields(param) {
-        return this._pipe('addFields', param);
-    }
-    bucket(param) {
-        return this._pipe('bucket', param);
-    }
-    bucketAuto(param) {
-        return this._pipe('bucketAuto', param);
-    }
-    count(param) {
-        return this._pipe('count', param);
-    }
-    geoNear(param) {
-        if (param.query) {
-            param.query = query_1.QuerySerializer.encode(param.query);
-        }
-        if (param.distanceMultiplier && typeof (param.distanceMultiplier) === 'number') {
-            param.distanceMultiplier = param.distanceMultiplier * EARTH_RADIUS;
-        }
-        else {
-            param.distanceMultiplier = EARTH_RADIUS;
-        }
-        return this._pipe('geoNear', param);
-    }
-    group(param) {
-        return this._pipe('group', param);
-    }
-    limit(param) {
-        return this._pipe('limit', param);
-    }
-    match(param) {
-        return this._pipe('match', query_1.QuerySerializer.encode(param));
-    }
-    project(param) {
-        return this._pipe('project', param);
-    }
-    lookup(param) {
-        return this._pipe('lookup', param);
-    }
-    replaceRoot(param) {
-        return this._pipe('replaceRoot', param);
-    }
-    sample(param) {
-        return this._pipe('sample', param);
-    }
-    skip(param) {
-        return this._pipe('skip', param);
-    }
-    sort(param) {
-        return this._pipe('sort', param);
-    }
-    sortByCount(param) {
-        return this._pipe('sortByCount', param);
-    }
-    unwind(param) {
-        return this._pipe('unwind', param);
-    }
-}
-exports.default = Aggregation;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const bson_1 = require("bson");
+const query_1 = require("./serializer/query");
+const utils_1 = require("./utils/utils");
+const type_1 = require("./utils/type");
+const validate_1 = require("./validate");
+const point_1 = require("./geo/point");
+class Aggregation {
+    constructor(db, collectionName, rawPipeline) {
+        this._stages = [];
+        if (db && collectionName) {
+            this._db = db;
+            this._request = new index_1.Db.reqClass(this._db.config);
+            this._collectionName = collectionName;
+            if (rawPipeline && rawPipeline.length > 0) {
+                rawPipeline.forEach((stage) => {
+                    validate_1.Validate.isValidAggregation(stage);
+                    const stageName = Object.keys(stage)[0];
+                    this._pipe(stageName, stage[stageName], true);
+                });
+            }
+        }
+    }
+    async end() {
+        if (!this._collectionName || !this._db) {
+            throw new Error('Aggregation pipeline cannot send request');
+        }
+        const result = await this._request.send('database.aggregateDocuments', {
+            collectionName: this._collectionName,
+            stages: this._stages
+        });
+        if (result && result.data && result.data.list) {
+            return {
+                requestId: result.requestId,
+                data: result.data.list.map(bson_1.EJSON.parse)
+            };
+        }
+        return result;
+    }
+    unwrap() {
+        return this._stages;
+    }
+    done() {
+        return this._stages.map(({ stageKey, stageValue }) => {
+            return {
+                [stageKey]: JSON.parse(stageValue)
+            };
+        });
+    }
+    _pipe(stage, param, raw = false) {
+        let transformParam = '';
+        if (type_1.getType(param) === 'object') {
+            transformParam = utils_1.stringifyByEJSON(param);
+        }
+        else {
+            transformParam = JSON.stringify(param);
+        }
+        this._stages.push({
+            stageKey: raw ? stage : `$${stage}`,
+            stageValue: transformParam
+        });
+        return this;
+    }
+    addFields(param) {
+        return this._pipe('addFields', param);
+    }
+    bucket(param) {
+        return this._pipe('bucket', param);
+    }
+    bucketAuto(param) {
+        return this._pipe('bucketAuto', param);
+    }
+    count(param) {
+        return this._pipe('count', param);
+    }
+    geoNear(param) {
+        if (param.query) {
+            param.query = query_1.QuerySerializer.encode(param.query);
+        }
+        if (param.distanceMultiplier && typeof (param.distanceMultiplier) === 'number') {
+            param.distanceMultiplier = param.distanceMultiplier;
+        }
+        if (param.near) {
+            param.near = new point_1.Point(param.near.longitude, param.near.latitude).toJSON();
+        }
+        return this._pipe('geoNear', param);
+    }
+    group(param) {
+        return this._pipe('group', param);
+    }
+    limit(param) {
+        return this._pipe('limit', param);
+    }
+    match(param) {
+        return this._pipe('match', query_1.QuerySerializer.encode(param));
+    }
+    project(param) {
+        return this._pipe('project', param);
+    }
+    lookup(param) {
+        return this._pipe('lookup', param);
+    }
+    replaceRoot(param) {
+        return this._pipe('replaceRoot', param);
+    }
+    sample(param) {
+        return this._pipe('sample', param);
+    }
+    skip(param) {
+        return this._pipe('skip', param);
+    }
+    sort(param) {
+        return this._pipe('sort', param);
+    }
+    sortByCount(param) {
+        return this._pipe('sortByCount', param);
+    }
+    unwind(param) {
+        return this._pipe('unwind', param);
+    }
+}
+exports.default = Aggregation;

package/dist/commonjs/collection.d.ts

@@ -1,17 +1,17 @@
-import { DocumentReference } from './document';
-import { Query, QueryOption, UpdateOption } from './query';
-import Aggregation from './aggregate';
-export declare class CollectionReference extends Query {
-    protected _transactionId: string;
-    readonly name: string;
-    doc(docID: string | number): DocumentReference;
-    add(data: any): Promise<{
-        ids?: string[];
-        id?: string;
-        inserted?: number;
-        ok?: number;
-        requestId: string;
-    }>;
-    aggregate(rawPipeline?: object[]): Aggregation;
-    options(apiOptions: QueryOption | UpdateOption): CollectionReference;
-}
+import { DocumentReference } from './document';
+import { Query, QueryOption, UpdateOption } from './query';
+import Aggregation from './aggregate';
+export declare class CollectionReference extends Query {
+    protected _transactionId: string;
+    readonly name: string;
+    doc(docID: string | number): DocumentReference;
+    add(data: any): Promise<{
+        ids?: string[];
+        id?: string;
+        inserted?: number;
+        ok?: number;
+        requestId: string;
+    }>;
+    aggregate(rawPipeline?: object[]): Aggregation;
+    options(apiOptions: QueryOption | UpdateOption): CollectionReference;
+}

package/dist/commonjs/collection.js

@@ -1,72 +1,72 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const document_1 = require("./document");
-const query_1 = require("./query");
-const aggregate_1 = require("./aggregate");
-const datatype_1 = require("./serializer/datatype");
-const utils_1 = require("./utils/utils");
-const validate_1 = require("./validate");
-const type_1 = require("./utils/type");
-class CollectionReference extends query_1.Query {
-    constructor(db, coll, apiOptions, transactionId) {
-        super(db, coll, '', apiOptions, transactionId);
-        if (transactionId) {
-            this._transactionId = transactionId;
-        }
-    }
-    get name() {
-        return this._coll;
-    }
-    doc(docID) {
-        if (typeof docID !== 'string' && typeof docID !== 'number') {
-            throw new Error('docId必须为字符串或数字');
-        }
-        return new document_1.DocumentReference(this._db, this._coll, this._apiOptions, docID, this._transactionId);
-    }
-    async add(data) {
-        let transformData = data;
-        if (!type_1.isArray(data)) {
-            transformData = [data];
-        }
-        transformData = transformData.map(item => {
-            return utils_1.stringifyByEJSON(datatype_1.serialize(item));
-        });
-        let params = {
-            collectionName: this._coll,
-            data: transformData
-        };
-        if (this._transactionId) {
-            params.transactionId = this._transactionId;
-        }
-        const res = await this._request.send('database.insertDocument', params, utils_1.getReqOpts(this._apiOptions));
-        if (res.code) {
-            return res;
-        }
-        if (!type_1.isArray(data)) {
-            if (this._transactionId) {
-                return {
-                    inserted: 1,
-                    ok: 1,
-                    id: res.data.insertedIds[0],
-                    requestId: res.requestId
-                };
-            }
-            return {
-                id: res.data.insertedIds[0],
-                requestId: res.requestId
-            };
-        }
-        return {
-            ids: res.data.insertedIds,
-            requestId: res.requestId
-        };
-    }
-    aggregate(rawPipeline = []) {
-        return new aggregate_1.default(this._db, this._coll, (this._apiOptions.raw || false) ? rawPipeline : []);
-    }
-    options(apiOptions) {
-        validate_1.Validate.isValidOptions(apiOptions);
-        return new CollectionReference(this._db, this._coll, apiOptions, this._transactionId);
-    }
-}
-exports.CollectionReference = CollectionReference;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const document_1 = require("./document");
+const query_1 = require("./query");
+const aggregate_1 = require("./aggregate");
+const datatype_1 = require("./serializer/datatype");
+const utils_1 = require("./utils/utils");
+const validate_1 = require("./validate");
+const type_1 = require("./utils/type");
+class CollectionReference extends query_1.Query {
+    constructor(db, coll, apiOptions, transactionId) {
+        super(db, coll, '', apiOptions, transactionId);
+        if (transactionId) {
+            this._transactionId = transactionId;
+        }
+    }
+    get name() {
+        return this._coll;
+    }
+    doc(docID) {
+        if (typeof docID !== 'string' && typeof docID !== 'number') {
+            throw new Error('docId必须为字符串或数字');
+        }
+        return new document_1.DocumentReference(this._db, this._coll, this._apiOptions, docID, this._transactionId);
+    }
+    async add(data) {
+        let transformData = data;
+        if (!type_1.isArray(data)) {
+            transformData = [data];
+        }
+        transformData = transformData.map(item => {
+            return utils_1.stringifyByEJSON(datatype_1.serialize(item));
+        });
+        let params = {
+            collectionName: this._coll,
+            data: transformData
+        };
+        if (this._transactionId) {
+            params.transactionId = this._transactionId;
+        }
+        const res = await this._request.send('database.insertDocument', params, utils_1.getReqOpts(this._apiOptions));
+        if (res.code) {
+            return res;
+        }
+        if (!type_1.isArray(data)) {
+            if (this._transactionId) {
+                return {
+                    inserted: 1,
+                    ok: 1,
+                    id: res.data.insertedIds[0],
+                    requestId: res.requestId
+                };
+            }
+            return {
+                id: res.data.insertedIds[0],
+                requestId: res.requestId
+            };
+        }
+        return {
+            ids: res.data.insertedIds,
+            requestId: res.requestId
+        };
+    }
+    aggregate(rawPipeline = []) {
+        return new aggregate_1.default(this._db, this._coll, (this._apiOptions.raw || false) ? rawPipeline : []);
+    }
+    options(apiOptions) {
+        validate_1.Validate.isValidOptions(apiOptions);
+        return new CollectionReference(this._db, this._coll, apiOptions, this._transactionId);
+    }
+}
+exports.CollectionReference = CollectionReference;