@cloudbase/js-sdk 2.28.6 → 2.29.0

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

@@ -0,0 +1,38 @@
+export interface ICloudSDKError extends Error {
+    errCode: number;
+    errMsg: string;
+}
+export declare class CloudSDKError extends Error {
+    errCode: string;
+    errMsg: string;
+    requestID?: string;
+    constructor(options: IErrorConstructorOptions);
+    get message(): string;
+    set message(msg: string);
+}
+interface IErrorConstructorOptions {
+    errCode?: string;
+    errMsg: string;
+}
+export declare function isSDKError(error: any): error is CloudSDKError;
+export interface IGenericError<T extends string, P = any> extends Error {
+    type: T;
+    payload: P;
+    generic: boolean;
+}
+export declare const isGenericError: <T extends string, P>(e: any) => e is IGenericError<T, P>;
+export declare class TimeoutError extends Error implements IGenericError<'timeout', null> {
+    type: "timeout";
+    payload: any;
+    generic: boolean;
+    constructor(message: string);
+}
+export declare const isTimeoutError: (e: any) => e is TimeoutError;
+export declare class CancelledError extends Error implements IGenericError<'cancelled', null> {
+    type: "cancelled";
+    payload: any;
+    generic: boolean;
+    constructor(message: string);
+}
+export declare const isCancelledError: (e: any) => e is CancelledError;
+export {};

package/database/dist/commonjs/utils/error.js

@@ -0,0 +1,91 @@
+"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 (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCancelledError = exports.CancelledError = exports.isTimeoutError = exports.TimeoutError = exports.isGenericError = exports.isSDKError = exports.CloudSDKError = void 0;
+var type_1 = require("./type");
+var error_config_1 = require("../config/error.config");
+var CloudSDKError = (function (_super) {
+    __extends(CloudSDKError, _super);
+    function CloudSDKError(options) {
+        var _this = _super.call(this, options.errMsg) || this;
+        _this.errCode = 'UNKNOWN_ERROR';
+        Object.defineProperties(_this, {
+            message: {
+                get: function () {
+                    return ("errCode: ".concat(this.errCode, " ").concat(error_config_1.ERR_CODE[this.errCode] ||
+                        '', " | errMsg: ") + this.errMsg);
+                },
+                set: function (msg) {
+                    this.errMsg = msg;
+                }
+            }
+        });
+        _this.errCode = options.errCode || 'UNKNOWN_ERROR';
+        _this.errMsg = options.errMsg;
+        return _this;
+    }
+    Object.defineProperty(CloudSDKError.prototype, "message", {
+        get: function () {
+            return "errCode: ".concat(this.errCode, " | errMsg: ") + this.errMsg;
+        },
+        set: function (msg) {
+            this.errMsg = msg;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return CloudSDKError;
+}(Error));
+exports.CloudSDKError = CloudSDKError;
+function isSDKError(error) {
+    return (error && error instanceof Error && (0, type_1.isString)(error.errMsg));
+}
+exports.isSDKError = isSDKError;
+var isGenericError = function (e) { return e.generic; };
+exports.isGenericError = isGenericError;
+var TimeoutError = (function (_super) {
+    __extends(TimeoutError, _super);
+    function TimeoutError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.type = 'timeout';
+        _this.payload = null;
+        _this.generic = true;
+        return _this;
+    }
+    return TimeoutError;
+}(Error));
+exports.TimeoutError = TimeoutError;
+var isTimeoutError = function (e) {
+    return e.type === 'timeout';
+};
+exports.isTimeoutError = isTimeoutError;
+var CancelledError = (function (_super) {
+    __extends(CancelledError, _super);
+    function CancelledError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.type = 'cancelled';
+        _this.payload = null;
+        _this.generic = true;
+        return _this;
+    }
+    return CancelledError;
+}(Error));
+exports.CancelledError = CancelledError;
+var isCancelledError = function (e) {
+    return e.type === 'cancelled';
+};
+exports.isCancelledError = isCancelledError;

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

@@ -0,0 +1,8 @@
+declare class HiddenSymbol {
+    constructor(target: any);
+}
+export declare class InternalSymbol extends HiddenSymbol {
+    constructor(target: any, __mark__: any);
+    static for(target: any): InternalSymbol;
+}
+export default InternalSymbol;

package/database/dist/commonjs/utils/symbol.js

@@ -0,0 +1,58 @@
+"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 (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalSymbol = void 0;
+var _symbols = [];
+var __internalMark__ = {};
+var HiddenSymbol = (function () {
+    function HiddenSymbol(target) {
+        Object.defineProperties(this, {
+            target: {
+                enumerable: false,
+                writable: false,
+                configurable: false,
+                value: target,
+            },
+        });
+    }
+    return HiddenSymbol;
+}());
+var InternalSymbol = (function (_super) {
+    __extends(InternalSymbol, _super);
+    function InternalSymbol(target, __mark__) {
+        if (__mark__ !== __internalMark__) {
+            throw new TypeError('InternalSymbol cannot be constructed with new operator');
+        }
+        return _super.call(this, target) || this;
+    }
+    InternalSymbol.for = function (target) {
+        for (var i = 0, len = _symbols.length; i < len; i++) {
+            if (_symbols[i].target === target) {
+                return _symbols[i].instance;
+            }
+        }
+        var symbol = new InternalSymbol(target, __internalMark__);
+        _symbols.push({
+            target: target,
+            instance: symbol,
+        });
+        return symbol;
+    };
+    return InternalSymbol;
+}(HiddenSymbol));
+exports.InternalSymbol = InternalSymbol;
+exports.default = InternalSymbol;

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

@@ -0,0 +1,13 @@
+export declare const getType: (x: any) => string;
+export declare const isObject: <T extends object>(x: any) => x is T;
+export declare const isString: (x: any) => x is string;
+export declare const isNumber: (x: any) => x is number;
+export declare const isPromise: <T extends Promise<any> = Promise<any>>(x: any) => x is T;
+type AnyFn = (...args: any[]) => any;
+export declare const isFunction: <T extends AnyFn = AnyFn>(x: any) => x is T;
+export declare const isArray: <T extends any[] = any[]>(x: any) => x is T;
+export declare const isDate: (x: any) => x is Date;
+export declare const isRegExp: (x: any) => x is RegExp;
+export declare const isInternalObject: (x: any) => boolean;
+export declare const isPlainObject: (obj: any) => obj is object;
+export {};

package/database/dist/commonjs/utils/type.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPlainObject = exports.isInternalObject = exports.isRegExp = exports.isDate = exports.isArray = exports.isFunction = exports.isPromise = exports.isNumber = exports.isString = exports.isObject = exports.getType = void 0;
+var symbol_1 = require("./symbol");
+var getType = function (x) { return Object.prototype.toString.call(x).slice(8, -1).toLowerCase(); };
+exports.getType = getType;
+var isObject = function (x) { return (0, exports.getType)(x) === 'object'; };
+exports.isObject = isObject;
+var isString = function (x) { return (0, exports.getType)(x) === 'string'; };
+exports.isString = isString;
+var isNumber = function (x) { return (0, exports.getType)(x) === 'number'; };
+exports.isNumber = isNumber;
+var isPromise = function (x) { return (0, exports.getType)(x) === 'promise'; };
+exports.isPromise = isPromise;
+var isFunction = function (x) { return typeof x === 'function'; };
+exports.isFunction = isFunction;
+var isArray = function (x) { return Array.isArray(x); };
+exports.isArray = isArray;
+var isDate = function (x) { return (0, exports.getType)(x) === 'date'; };
+exports.isDate = isDate;
+var isRegExp = function (x) { return (0, exports.getType)(x) === 'regexp'; };
+exports.isRegExp = isRegExp;
+var isInternalObject = function (x) { return x && (x._internalType instanceof symbol_1.InternalSymbol); };
+exports.isInternalObject = isInternalObject;
+var isPlainObject = function (obj) {
+    if (typeof obj !== 'object' || obj === null)
+        return false;
+    var proto = obj;
+    while (Object.getPrototypeOf(proto) !== null) {
+        proto = Object.getPrototypeOf(proto);
+    }
+    return Object.getPrototypeOf(obj) === proto;
+};
+exports.isPlainObject = isPlainObject;

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

@@ -0,0 +1,4 @@
+import { Db } from '../';
+export declare const sleep: (ms?: number) => Promise<unknown>;
+export declare const autoCount: (domain?: string) => number;
+export declare function getWsInstance(db: Db): any;

package/database/dist/commonjs/utils/utils.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWsInstance = exports.autoCount = exports.sleep = void 0;
+var __1 = require("../");
+var sleep = function (ms) {
+    if (ms === void 0) { ms = 0; }
+    return new Promise(function (r) { return setTimeout(r, ms); });
+};
+exports.sleep = sleep;
+var counters = {};
+var autoCount = function (domain) {
+    if (domain === void 0) { domain = 'any'; }
+    if (!counters[domain]) {
+        counters[domain] = 0;
+    }
+    return counters[domain]++;
+};
+exports.autoCount = autoCount;
+var wsList = {};
+function getWsInstance(db) {
+    if (!__1.Db.wsClientClass) {
+        throw new Error('to use realtime you must import realtime module first');
+    }
+    var env = db.config.env;
+    if (!wsList[env]) {
+        wsList[env] = new __1.Db.wsClientClass({
+            context: {
+                appConfig: {
+                    docSizeLimit: 1000,
+                    realtimePingInterval: 10000,
+                    realtimePongWaitTimeout: 5000,
+                    request: __1.Db.createRequest(db.config)
+                }
+            }
+        });
+    }
+    return wsList[env];
+}
+exports.getWsInstance = getWsInstance;

package/database/dist/commonjs/validate.d.ts

@@ -0,0 +1 @@
+export {};

package/database/dist/commonjs/validate.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validate = void 0;
+var constant_1 = require("./constant");
+var util_1 = require("./util");
+var Validate = (function () {
+    function Validate() {
+    }
+    Validate.isGeopoint = function (point, degree) {
+        if (util_1.Util.whichType(degree) !== constant_1.FieldType.Number) {
+            throw new Error('Geo Point must be number type');
+        }
+        var degreeAbs = Math.abs(degree);
+        if (point === 'latitude' && degreeAbs > 90) {
+            throw new Error('latitude should be a number ranges from -90 to 90');
+        }
+        else if (point === 'longitude' && degreeAbs > 180) {
+            throw new Error('longitude should be a number ranges from -180 to 180');
+        }
+        return true;
+    };
+    Validate.isInteger = function (param, num) {
+        if (!Number.isInteger(num)) {
+            throw new Error(param + constant_1.ErrorCode.IntergerError);
+        }
+        return true;
+    };
+    Validate.isFieldOrder = function (direction) {
+        if (constant_1.OrderDirectionList.indexOf(direction) === -1) {
+            throw new Error(constant_1.ErrorCode.DirectionError);
+        }
+        return true;
+    };
+    Validate.isFieldPath = function (path) {
+        if (!/^[a-zA-Z0-9-_\.]/.test(path)) {
+            throw new Error();
+        }
+        return true;
+    };
+    Validate.isOperator = function (op) {
+        if (constant_1.WhereFilterOpList.indexOf(op) === -1) {
+            throw new Error(constant_1.ErrorCode.OpStrError);
+        }
+        return true;
+    };
+    Validate.isCollName = function (name) {
+        if (!/^[a-zA-Z0-9]([a-zA-Z0-9-_]){1,32}$/.test(name)) {
+            throw new Error(constant_1.ErrorCode.CollNameError);
+        }
+        return true;
+    };
+    Validate.isDocID = function (docId) {
+        if (!/^([a-fA-F0-9]){24}$/.test(docId)) {
+            throw new Error(constant_1.ErrorCode.DocIDError);
+        }
+        return true;
+    };
+    return Validate;
+}());
+exports.Validate = Validate;

package/database/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);
+    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/database/dist/esm/aggregate.js

@@ -0,0 +1,154 @@
+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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+import { Db } from './index';
+import { EJSON } from 'bson';
+import { QuerySerializer } from './serializer/query';
+import { Point } from './geo';
+var Aggregation = (function () {
+    function Aggregation(db, collectionName) {
+        this._stages = [];
+        if (db && collectionName) {
+            this._db = db;
+            this._request = Db.createRequest(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(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: "$".concat(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 = 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);
+    };
+    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', 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;
+}());
+export default Aggregation;

package/database/dist/esm/collection.d.ts

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

package/database/dist/esm/collection.js

@@ -0,0 +1,46 @@
+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 (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+import { DocumentReference } from './document';
+import { Query } from './query';
+import Aggregation from './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: false,
+        configurable: true
+    });
+    CollectionReference.prototype.doc = function (docID) {
+        if (typeof docID !== 'string' && typeof docID !== 'number') {
+            throw new Error('docId必须为字符串或数字');
+        }
+        return new DocumentReference(this._db, this._coll, docID);
+    };
+    CollectionReference.prototype.add = function (data, callback) {
+        var docRef = new DocumentReference(this._db, this._coll, undefined);
+        return docRef.create(data, callback);
+    };
+    CollectionReference.prototype.aggregate = function () {
+        return new Aggregation(this._db, this._coll);
+    };
+    return CollectionReference;
+}(Query));
+export { CollectionReference };