@cloudbase/database 1.4.2 → 1.4.3-alpha.0

package/dist/commonjs/index.d.ts

@@ -22,6 +22,8 @@ interface ICloudBaseConfig {
     credentials?: ICredentialsInfo;
     _useFeature?: boolean;
     throwOnCode?: boolean;
+    instance?: string;
+    database?: string;
 }
 interface ICredentialsInfo {
     private_key_id: string;

package/dist/commonjs/lib/util.d.ts

@@ -0,0 +1 @@
+export declare const createPromiseCallback: () => any;

package/dist/commonjs/lib/util.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPromiseCallback = function () {
+    var cb;
+    if (!Promise) {
+        cb = function () { };
+        cb.promise = {};
+        var throwPromiseNotDefined = function () {
+            throw new Error('Your Node runtime does support ES6 Promises. ' +
+                'Set "global.Promise" to your preferred implementation of promises.');
+        };
+        Object.defineProperty(cb.promise, 'then', { get: throwPromiseNotDefined });
+        Object.defineProperty(cb.promise, 'catch', { get: throwPromiseNotDefined });
+        return cb;
+    }
+    var promise = new Promise(function (resolve, reject) {
+        cb = function (err, data) {
+            if (err)
+                return reject(err);
+            return resolve(data);
+        };
+    });
+    cb.promise = promise;
+    return cb;
+};

package/dist/commonjs/transaction/collection.d.ts

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

package/dist/commonjs/transaction/collection.js

@@ -0,0 +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 CollectionReference = (function (_super) {
+    __extends(CollectionReference, _super);
+    function CollectionReference(transaction, coll) {
+        return _super.call(this, transaction, 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._transaction, this._coll, docID);
+    };
+    CollectionReference.prototype.add = function (data) {
+        var docID;
+        if (data._id !== undefined) {
+            docID = data._id;
+        }
+        var docRef = new document_1.DocumentReference(this._transaction, this._coll, docID);
+        return docRef.create(data);
+    };
+    return CollectionReference;
+}(query_1.Query));
+exports.CollectionReference = CollectionReference;

package/dist/commonjs/transaction/document.d.ts

@@ -0,0 +1,27 @@
+interface GetResult {
+    requestId: string;
+    data: any;
+}
+interface UpdateResult {
+    requestId: string;
+    updated: number;
+}
+declare type JsonString = string;
+interface SetResult extends UpdateResult {
+    upserted: JsonString;
+}
+interface DeleteResult {
+    requestId: string;
+    deleted: number | string;
+}
+export declare class DocumentReference {
+    readonly id: string | number;
+    private _transaction;
+    private _transactionId;
+    create(data: any): Promise<any>;
+    get(): Promise<GetResult>;
+    set(data: Object): Promise<SetResult>;
+    update(data: Object): Promise<UpdateResult>;
+    delete(): Promise<DeleteResult>;
+}
+export {};

package/dist/commonjs/transaction/document.js

@@ -0,0 +1,205 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 bson_1 = require("bson");
+var code_1 = require("../const/code");
+var update_1 = require("../serializer/update");
+var datatype_1 = require("../serializer/datatype");
+var util_1 = require("../util");
+var GET_DOC = 'database.getInTransaction';
+var UPDATE_DOC = 'database.updateDocInTransaction';
+var DELETE_DOC = 'database.deleteDocInTransaction';
+var INSERT_DOC = 'database.insertDocInTransaction';
+var DocumentReference = (function () {
+    function DocumentReference(transaction, coll, docID) {
+        this._coll = coll;
+        this.id = docID;
+        this._transaction = transaction;
+        this._request = this._transaction.getRequestMethod();
+        this._transactionId = this._transaction.getTransactionId();
+    }
+    DocumentReference.prototype.create = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var params, res, inserted, ok;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        params = {
+                            collectionName: this._coll,
+                            transactionId: this._transactionId,
+                            data: bson_1.EJSON.stringify(datatype_1.serialize(data), { relaxed: false })
+                        };
+                        if (this.id) {
+                            params['_id'] = this.id;
+                        }
+                        return [4, this._request.send(INSERT_DOC, params)];
+                    case 1:
+                        res = _a.sent();
+                        if (res.code) {
+                            throw res;
+                        }
+                        inserted = bson_1.EJSON.parse(res.inserted);
+                        ok = bson_1.EJSON.parse(res.ok);
+                        if (ok == 1 && inserted == 1) {
+                            return [2, __assign(__assign({}, res), { ok: ok,
+                                    inserted: inserted })];
+                        }
+                        else {
+                            throw new Error(code_1.ERRORS.INSERT_DOC_FAIL.message);
+                        }
+                        return [2];
+                }
+            });
+        });
+    };
+    DocumentReference.prototype.get = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var param, res;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        param = {
+                            collectionName: this._coll,
+                            transactionId: this._transactionId,
+                            query: {
+                                _id: { $eq: this.id }
+                            }
+                        };
+                        return [4, this._request.send(GET_DOC, param)];
+                    case 1:
+                        res = _a.sent();
+                        if (res.code)
+                            throw res;
+                        return [2, {
+                                data: res.data !== 'null' ? util_1.Util.formatField(bson_1.EJSON.parse(res.data)) : bson_1.EJSON.parse(res.data),
+                                requestId: res.requestId
+                            }];
+                }
+            });
+        });
+    };
+    DocumentReference.prototype.set = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var param, res;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        param = {
+                            collectionName: this._coll,
+                            transactionId: this._transactionId,
+                            query: {
+                                _id: { $eq: this.id }
+                            },
+                            data: bson_1.EJSON.stringify(datatype_1.serialize(data), { relaxed: false }),
+                            upsert: true
+                        };
+                        return [4, this._request.send(UPDATE_DOC, param)];
+                    case 1:
+                        res = _a.sent();
+                        if (res.code)
+                            throw res;
+                        return [2, __assign(__assign({}, res), { updated: bson_1.EJSON.parse(res.updated), upserted: res.upserted
+                                    ? JSON.parse(res.upserted)
+                                    : null })];
+                }
+            });
+        });
+    };
+    DocumentReference.prototype.update = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var param, res;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        param = {
+                            collectionName: this._coll,
+                            transactionId: this._transactionId,
+                            query: {
+                                _id: { $eq: this.id }
+                            },
+                            data: bson_1.EJSON.stringify(update_1.UpdateSerializer.encode(data), {
+                                relaxed: false
+                            })
+                        };
+                        return [4, this._request.send(UPDATE_DOC, param)];
+                    case 1:
+                        res = _a.sent();
+                        if (res.code)
+                            throw res;
+                        return [2, __assign(__assign({}, res), { updated: bson_1.EJSON.parse(res.updated) })];
+                }
+            });
+        });
+    };
+    DocumentReference.prototype.delete = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var param, res;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        param = {
+                            collectionName: this._coll,
+                            transactionId: this._transactionId,
+                            query: {
+                                _id: { $eq: this.id }
+                            }
+                        };
+                        return [4, this._request.send(DELETE_DOC, param)];
+                    case 1:
+                        res = _a.sent();
+                        if (res.code)
+                            throw res;
+                        return [2, __assign(__assign({}, res), { deleted: bson_1.EJSON.parse(res.deleted) })];
+                }
+            });
+        });
+    };
+    return DocumentReference;
+}());
+exports.DocumentReference = DocumentReference;

package/dist/commonjs/transaction/query.d.ts

@@ -0,0 +1,5 @@
+import { Transaction } from './index';
+export declare class Query {
+    protected _transaction: Transaction;
+    constructor(transaction: Transaction, coll: string);
+}

package/dist/commonjs/transaction/query.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Query = (function () {
+    function Query(transaction, coll) {
+        this._coll = coll;
+        this._transaction = transaction;
+    }
+    return Query;
+}());
+exports.Query = Query;

package/dist/commonjs/utils/utils.d.ts

@@ -1,11 +1,10 @@
 import { QueryOption, UpdateOption } from '../query';
-import { EJSON } from 'bson';
 export declare const sleep: (ms?: number) => Promise<unknown>;
 export declare const autoCount: (domain?: string) => number;
 export declare const getReqOpts: (apiOptions: QueryOption | UpdateOption) => any;
 export declare const filterUndefined: (o: any) => any;
-export declare const stringifyByEJSON: (params: any) => string;
-export declare const parseByEJSON: (params: any) => EJSON.SerializableTypes;
+export declare const stringifyByEJSON: (params: any) => any;
+export declare const parseByEJSON: (params: any) => any;
 export declare class TcbError extends Error {
     readonly code: string;
     readonly message: string;

package/dist/esm/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/esm/ObjectId/index.js

@@ -0,0 +1,17 @@
+import { SYMBOL_OBJECTID } from '../helper/symbol';
+export class ObjectId {
+    constructor({ id = '' } = {}) {
+        this.id = id;
+    }
+    get _internalType() {
+        return SYMBOL_OBJECTID;
+    }
+    parse() {
+        return {
+            $oid: this.id
+        };
+    }
+}
+export function ObjectIdConstructor(opt) {
+    return new ObjectId(opt);
+}

package/dist/esm/aggregate.d.ts

@@ -0,0 +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;
+}

package/dist/esm/aggregate.js

@@ -0,0 +1,121 @@
+import { Db } from './index';
+import { EJSON } from 'bson';
+import { QuerySerializer } from './serializer/query';
+import { stringifyByEJSON } from './utils/utils';
+import { getType } from './utils/type';
+import { Validate } from './validate';
+import { Point } from './geo/point';
+export default class Aggregation {
+    constructor(db, collectionName, rawPipeline) {
+        this._stages = [];
+        if (db && collectionName) {
+            this._db = db;
+            this._request = new Db.reqClass(this._db.config);
+            this._collectionName = collectionName;
+            if (rawPipeline && rawPipeline.length > 0) {
+                rawPipeline.forEach((stage) => {
+                    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(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 (getType(param) === 'object') {
+            transformParam = 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 = QuerySerializer.encode(param.query);
+        }
+        if (param.distanceMultiplier && typeof (param.distanceMultiplier) === 'number') {
+            param.distanceMultiplier = param.distanceMultiplier;
+        }
+        if (param.near) {
+            param.near = new 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', 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);
+    }
+}

package/dist/esm/collection.d.ts

@@ -0,0 +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;
+}

package/dist/esm/collection.js

@@ -0,0 +1,69 @@
+import { DocumentReference } from './document';
+import { Query } from './query';
+import Aggregation from './aggregate';
+import { serialize } from './serializer/datatype';
+import { getReqOpts, stringifyByEJSON } from './utils/utils';
+import { Validate } from './validate';
+import { isArray } from './utils/type';
+export class CollectionReference extends 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 DocumentReference(this._db, this._coll, this._apiOptions, docID, this._transactionId);
+    }
+    async add(data) {
+        let transformData = data;
+        if (!isArray(data)) {
+            transformData = [data];
+        }
+        transformData = transformData.map(item => {
+            return stringifyByEJSON(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, getReqOpts(this._apiOptions));
+        if (res.code) {
+            return res;
+        }
+        if (!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 Aggregation(this._db, this._coll, (this._apiOptions.raw || false) ? rawPipeline : []);
+    }
+    options(apiOptions) {
+        Validate.isValidOptions(apiOptions);
+        return new CollectionReference(this._db, this._coll, apiOptions, this._transactionId);
+    }
+}