@cloudbase/database 0.9.17-beta → 0.9.19

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);
-    end(): Promise<any>;
-    unwrap(): any[];
-    done(): {
-        [x: number]: any;
-    }[];
-    _pipe(stage: any, param: any): 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);
+    end(): Promise<any>;
+    unwrap(): any[];
+    done(): {
+        [x: number]: any;
+    }[];
+    _pipe(stage: any, param: any): 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,146 +1,156 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("./index");
-var bson_1 = require("bson");
-var query_1 = require("./serializer/query");
-var Aggregation = (function () {
-    function Aggregation(db, collectionName) {
-        this._stages = [];
-        if (db && collectionName) {
-            this._db = db;
-            this._request = new index_1.Db.reqClass(this._db.config);
-            this._collectionName = collectionName;
-        }
-    }
-    Aggregation.prototype.end = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!this._collectionName || !this._db) {
-                            throw new Error('Aggregation pipeline cannot send request');
-                        }
-                        return [4, this._request.send('database.aggregate', {
-                                collectionName: this._collectionName,
-                                stages: this._stages
-                            })];
-                    case 1:
-                        result = _a.sent();
-                        if (result && result.data && result.data.list) {
-                            return [2, {
-                                    requestId: result.requestId,
-                                    data: JSON.parse(result.data.list).map(bson_1.EJSON.parse)
-                                }];
-                        }
-                        return [2, result];
-                }
-            });
-        });
-    };
-    Aggregation.prototype.unwrap = function () {
-        return this._stages;
-    };
-    Aggregation.prototype.done = function () {
-        return this._stages.map(function (_a) {
-            var _b;
-            var stageKey = _a.stageKey, stageValue = _a.stageValue;
-            return _b = {},
-                _b[stageKey] = JSON.parse(stageValue),
-                _b;
-        });
-    };
-    Aggregation.prototype._pipe = function (stage, param) {
-        this._stages.push({
-            stageKey: "$" + stage,
-            stageValue: JSON.stringify(param)
-        });
-        return this;
-    };
-    Aggregation.prototype.addFields = function (param) {
-        return this._pipe('addFields', param);
-    };
-    Aggregation.prototype.bucket = function (param) {
-        return this._pipe('bucket', param);
-    };
-    Aggregation.prototype.bucketAuto = function (param) {
-        return this._pipe('bucketAuto', param);
-    };
-    Aggregation.prototype.count = function (param) {
-        return this._pipe('count', param);
-    };
-    Aggregation.prototype.geoNear = function (param) {
-        return this._pipe('geoNear', param);
-    };
-    Aggregation.prototype.group = function (param) {
-        return this._pipe('group', param);
-    };
-    Aggregation.prototype.limit = function (param) {
-        return this._pipe('limit', param);
-    };
-    Aggregation.prototype.match = function (param) {
-        return this._pipe('match', query_1.QuerySerializer.encode(param));
-    };
-    Aggregation.prototype.project = function (param) {
-        return this._pipe('project', param);
-    };
-    Aggregation.prototype.lookup = function (param) {
-        return this._pipe('lookup', param);
-    };
-    Aggregation.prototype.replaceRoot = function (param) {
-        return this._pipe('replaceRoot', param);
-    };
-    Aggregation.prototype.sample = function (param) {
-        return this._pipe('sample', param);
-    };
-    Aggregation.prototype.skip = function (param) {
-        return this._pipe('skip', param);
-    };
-    Aggregation.prototype.sort = function (param) {
-        return this._pipe('sort', param);
-    };
-    Aggregation.prototype.sortByCount = function (param) {
-        return this._pipe('sortByCount', param);
-    };
-    Aggregation.prototype.unwind = function (param) {
-        return this._pipe('unwind', param);
-    };
-    return Aggregation;
-}());
-exports.default = Aggregation;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var index_1 = require("./index");
+var bson_1 = require("bson");
+var query_1 = require("./serializer/query");
+var geo_1 = require("./geo");
+var Aggregation = (function () {
+    function Aggregation(db, collectionName) {
+        this._stages = [];
+        if (db && collectionName) {
+            this._db = db;
+            this._request = new index_1.Db.reqClass(this._db.config);
+            this._collectionName = collectionName;
+        }
+    }
+    Aggregation.prototype.end = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this._collectionName || !this._db) {
+                            throw new Error('Aggregation pipeline cannot send request');
+                        }
+                        return [4, this._request.send('database.aggregate', {
+                                collectionName: this._collectionName,
+                                stages: this._stages
+                            })];
+                    case 1:
+                        result = _a.sent();
+                        if (result && result.data && result.data.list) {
+                            return [2, {
+                                    requestId: result.requestId,
+                                    data: JSON.parse(result.data.list).map(bson_1.EJSON.parse)
+                                }];
+                        }
+                        return [2, result];
+                }
+            });
+        });
+    };
+    Aggregation.prototype.unwrap = function () {
+        return this._stages;
+    };
+    Aggregation.prototype.done = function () {
+        return this._stages.map(function (_a) {
+            var _b;
+            var stageKey = _a.stageKey, stageValue = _a.stageValue;
+            return _b = {},
+                _b[stageKey] = JSON.parse(stageValue),
+                _b;
+        });
+    };
+    Aggregation.prototype._pipe = function (stage, param) {
+        this._stages.push({
+            stageKey: "$" + stage,
+            stageValue: JSON.stringify(param)
+        });
+        return this;
+    };
+    Aggregation.prototype.addFields = function (param) {
+        return this._pipe('addFields', param);
+    };
+    Aggregation.prototype.bucket = function (param) {
+        return this._pipe('bucket', param);
+    };
+    Aggregation.prototype.bucketAuto = function (param) {
+        return this._pipe('bucketAuto', param);
+    };
+    Aggregation.prototype.count = function (param) {
+        return this._pipe('count', param);
+    };
+    Aggregation.prototype.geoNear = function (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 geo_1.Point(param.near.longitude, param.near.latitude).toJSON();
+        }
+        return this._pipe('geoNear', param);
+    };
+    Aggregation.prototype.group = function (param) {
+        return this._pipe('group', param);
+    };
+    Aggregation.prototype.limit = function (param) {
+        return this._pipe('limit', param);
+    };
+    Aggregation.prototype.match = function (param) {
+        return this._pipe('match', query_1.QuerySerializer.encode(param));
+    };
+    Aggregation.prototype.project = function (param) {
+        return this._pipe('project', param);
+    };
+    Aggregation.prototype.lookup = function (param) {
+        return this._pipe('lookup', param);
+    };
+    Aggregation.prototype.replaceRoot = function (param) {
+        return this._pipe('replaceRoot', param);
+    };
+    Aggregation.prototype.sample = function (param) {
+        return this._pipe('sample', param);
+    };
+    Aggregation.prototype.skip = function (param) {
+        return this._pipe('skip', param);
+    };
+    Aggregation.prototype.sort = function (param) {
+        return this._pipe('sort', param);
+    };
+    Aggregation.prototype.sortByCount = function (param) {
+        return this._pipe('sortByCount', param);
+    };
+    Aggregation.prototype.unwind = function (param) {
+        return this._pipe('unwind', param);
+    };
+    return Aggregation;
+}());
+exports.default = Aggregation;

package/dist/commonjs/collection.d.ts

@@ -1,9 +1,9 @@
-import { DocumentReference } from './document';
-import { Query } from './query';
-import Aggregation from './aggregate';
-export declare class CollectionReference extends Query {
-    readonly name: string;
-    doc(docID?: string | number): DocumentReference;
-    add(data: Object, callback?: any): Promise<any>;
-    aggregate(): Aggregation;
-}
+import { DocumentReference } from './document';
+import { Query } from './query';
+import Aggregation from './aggregate';
+export declare class CollectionReference extends Query {
+    readonly name: string;
+    doc(docID?: string | number): DocumentReference;
+    add(data: Object, callback?: any): Promise<any>;
+    aggregate(): Aggregation;
+}

package/dist/commonjs/collection.js

@@ -1,46 +1,46 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-var document_1 = require("./document");
-var query_1 = require("./query");
-var aggregate_1 = require("./aggregate");
-var CollectionReference = (function (_super) {
-    __extends(CollectionReference, _super);
-    function CollectionReference(db, coll) {
-        return _super.call(this, db, coll) || this;
-    }
-    Object.defineProperty(CollectionReference.prototype, "name", {
-        get: function () {
-            return this._coll;
-        },
-        enumerable: true,
-        configurable: true
-    });
-    CollectionReference.prototype.doc = function (docID) {
-        if (typeof docID !== 'string' && typeof docID !== 'number') {
-            throw new Error('docId必须为字符串或数字');
-        }
-        return new document_1.DocumentReference(this._db, this._coll, docID);
-    };
-    CollectionReference.prototype.add = function (data, callback) {
-        var docRef = new document_1.DocumentReference(this._db, this._coll, undefined);
-        return docRef.create(data, callback);
-    };
-    CollectionReference.prototype.aggregate = function () {
-        return new aggregate_1.default(this._db, this._coll);
-    };
-    return CollectionReference;
-}(query_1.Query));
-exports.CollectionReference = CollectionReference;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+var document_1 = require("./document");
+var query_1 = require("./query");
+var aggregate_1 = require("./aggregate");
+var CollectionReference = (function (_super) {
+    __extends(CollectionReference, _super);
+    function CollectionReference(db, coll) {
+        return _super.call(this, db, coll) || this;
+    }
+    Object.defineProperty(CollectionReference.prototype, "name", {
+        get: function () {
+            return this._coll;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    CollectionReference.prototype.doc = function (docID) {
+        if (typeof docID !== 'string' && typeof docID !== 'number') {
+            throw new Error('docId必须为字符串或数字');
+        }
+        return new document_1.DocumentReference(this._db, this._coll, docID);
+    };
+    CollectionReference.prototype.add = function (data, callback) {
+        var docRef = new document_1.DocumentReference(this._db, this._coll, undefined);
+        return docRef.create(data, callback);
+    };
+    CollectionReference.prototype.aggregate = function () {
+        return new aggregate_1.default(this._db, this._coll);
+    };
+    return CollectionReference;
+}(query_1.Query));
+exports.CollectionReference = CollectionReference;