@cloudbase/database 0.9.20 → 0.9.22

package/dist/esm/typings/realtime.d.ts

@@ -0,0 +1,219 @@
+import { DataType, QueueType } from './index';
+export declare type IRequestMsgType = 'LOGIN' | 'INIT_WATCH' | 'REBUILD_WATCH' | 'CHECK_LAST' | 'CLOSE_WATCH' | 'PING';
+export declare type IResponseMsgType = 'LOGIN_RES' | 'INIT_EVENT' | 'NEXT_EVENT' | 'CHECK_EVENT' | 'PONG' | 'ERROR';
+export interface IRequestMessageBase<W extends boolean = true> {
+    watchId: W extends true ? string : undefined;
+    requestId: string;
+    msgType: IRequestMsgType;
+    msgData: IRequestMessageMsgData;
+}
+export declare type IRequestMessageMsgData = IRequestMessageInitWatchData | IRequestMessageLoginData | IRequestMessageRebuildWatchData | IRequestMessageCheckLastData | IRequestMessageCloseWatchData | IRequestMessagePingData;
+export declare type IRequestMessage = IRequestMessageInitWatchMsg | IRequestMessageLoginMsg | IRequestMessageRebuildWatchMsg | IRequestMessageCheckLastMsg | IRequestMessageCloseWatchMsg | IRequestMessagePingMsg;
+export interface IRequestMessageLoginData {
+    envId: string;
+    accessToken: string;
+    referrer: 'web';
+    sdkVersion: string;
+    dataVersion: string;
+}
+export interface IRequestExtraMessageLoginData {
+    runtime: string;
+    signStr: string;
+    secretVersion: string;
+}
+export interface IRequestMessageLoginMsg extends IRequestMessageBase<false> {
+    msgType: 'LOGIN';
+    msgData: IRequestMessageLoginData;
+    exMsgData?: IRequestExtraMessageLoginData;
+}
+export interface IRequestMessageInitWatchData {
+    envId: string;
+    collName: string;
+    query: string;
+    limit?: number;
+    orderBy?: Record<string, string>;
+}
+export interface IRequestMessageInitWatchMsg extends IRequestMessageBase {
+    msgType: 'INIT_WATCH';
+    msgData: IRequestMessageInitWatchData;
+}
+export interface IRequestMessageRebuildWatchData {
+    envId: string;
+    collName: string;
+    queryID: string;
+    eventID: number;
+}
+export interface IRequestMessageRebuildWatchMsg extends IRequestMessageBase {
+    msgType: 'REBUILD_WATCH';
+    msgData: IRequestMessageRebuildWatchData;
+}
+export interface IRequestMessageCheckLastData {
+    queryID: string;
+    eventID: number;
+}
+export interface IRequestMessageCheckLastMsg extends IRequestMessageBase {
+    msgType: 'CHECK_LAST';
+    msgData: IRequestMessageCheckLastData;
+}
+export declare type IRequestMessageCloseWatchData = null;
+export interface IRequestMessageCloseWatchMsg extends IRequestMessageBase {
+    msgType: 'CLOSE_WATCH';
+    msgData: IRequestMessageCloseWatchData;
+}
+export declare type IRequestMessagePingData = null;
+export interface IRequestMessagePingMsg extends IRequestMessageBase<false> {
+    msgType: 'PING';
+    msgData: IRequestMessagePingData;
+}
+export interface IResponseMessageBase<W extends boolean = true> {
+    watchId: W extends true ? string : undefined;
+    requestId: string;
+    msgType: IResponseMsgType;
+    msgData: IResponseMessageMsgData;
+}
+export declare type IResponseMessageMsgData = IResponseMessageLoginResData | IResponseMessageInitEventData | IResponseMessageNextEventData | IResponseMessageCheckEventData | IResponseMessagePongData | IResponseMessageErrorData;
+export declare type IResponseMessage = IResponseMessageLoginResMsg | IResponseMessageInitEventMsg | IResponseMessageNextEventMsg | IResponseMessageCheckEventMsg | IResponseMessagePongMsg | IResponseMessageErrorMsg;
+export declare type IResponseMessageLoginResData = {
+    envId: string;
+} & Partial<IResponseMessageErrorData>;
+export interface IResponseMessageLoginResMsg extends IResponseMessageBase<false> {
+    msgType: 'LOGIN_RES';
+    msgData: IResponseMessageLoginResData;
+}
+export interface IResponseMessageInitEventData {
+    queryID: string;
+    currEvent: number;
+    events: IDBEvent[];
+}
+export interface IResponseMessageInitEventMsg extends IResponseMessageBase {
+    msgType: 'INIT_EVENT';
+    msgData: IResponseMessageInitEventData;
+}
+export interface IResponseMessageNextEventData {
+    queryID: string;
+    currEvent: number;
+    events: IDBEvent[];
+}
+export interface IResponseMessageNextEventMsg extends IResponseMessageBase {
+    msgType: 'NEXT_EVENT';
+    msgData: IResponseMessageNextEventData;
+}
+export interface IResponseMessageCheckEventData {
+    queryID: string;
+    currEvent: number;
+}
+export interface IResponseMessageCheckEventMsg extends IResponseMessageBase {
+    msgType: 'CHECK_EVENT';
+    msgData: IResponseMessageCheckEventData;
+}
+export declare type IResponseMessagePongData = null;
+export interface IResponseMessagePongMsg extends IResponseMessageBase {
+    msgType: 'PONG';
+    msgData: IResponseMessagePongData;
+}
+export declare type IResponseMessageErrorData = {
+    message: string;
+} & ({
+    code: 'SYS_ERR';
+} | {
+    code: 'CHECK_LOGIN_FAILED';
+} | {
+    code: 'SIGN_INVALID_ERROR';
+} | {
+    code: 'SIGN_EXPIRED_ERROR';
+} | {
+    code: 'INVALIID_ENV';
+} | {
+    code: 'SIGN_PARAM_INVALID';
+} | {
+    code: 'COLLECTION_PERMISSION_DENIED';
+} | {
+    code: 'QUERYID_INVALID_ERROR';
+});
+export interface IResponseMessageErrorMsg extends IResponseMessageBase {
+    msgType: 'ERROR';
+    msgData: IResponseMessageErrorData;
+}
+export declare type IDBEvent = IDBInitEvent | IDBNextEvent;
+export interface IDBEventBase {
+    ID: number;
+    DataType: DataType;
+    QueueType: QueueType;
+    DocID: string;
+    Doc: string;
+}
+export interface IDBInitEvent extends IDBEventBase {
+    DataType: 'init';
+    QueueType: 'init';
+    UpdatedFields?: any;
+    removedFields?: any;
+}
+export declare type IDBNextEvent = IDBNextEventDataUpdate | IDBNextEventDataReplace | IDBNextEventDataAdd | IDBNextEventDataRemove | IDBNextEventDataLimit;
+export declare type IDBNextEventDataUpdate = IDBNextEventDataUpdateQueueUpdate | IDBNextEventDataUpdateQueueEnqueue | IDBNextEventDataUpdateQueueDequeue;
+export declare type IDBNextEventDataReplace = IDBNextEventDataReplaceQueueUpdate | IDBNextEventDataReplaceQueueEnqueue | IDBNextEventDataReplaceQueueDequeue;
+export declare type IDBNextEventDataLimit = IDBNextEventDataLimitQueueEnqueue | IDBNextEventDataLimitQueueDequeue;
+export interface IDBNextEventDataUpdateQueueUpdate extends IDBEventBase {
+    DataType: 'update';
+    QueueType: 'update';
+    Doc: '';
+    UpdatedFields: string;
+    RemovedFields: string;
+}
+export interface IDBNextEventDataUpdateQueueEnqueue extends IDBEventBase {
+    DataType: 'update';
+    QueueType: 'enqueue';
+    Doc: string;
+    UpdatedFields: string;
+    RemovedFields: string;
+}
+export interface IDBNextEventDataUpdateQueueDequeue extends IDBEventBase {
+    DataType: 'update';
+    QueueType: 'dequeue';
+    Doc: '';
+    UpdatedFields: string;
+    RemovedFields: string;
+}
+export interface IDBNextEventDataReplaceQueueUpdate extends IDBEventBase {
+    DataType: 'replace';
+    QueueType: 'update';
+    Doc: string;
+    UpdatedFields: '';
+    RemovedFields: '';
+}
+export interface IDBNextEventDataReplaceQueueEnqueue extends IDBEventBase {
+    DataType: 'replace';
+    QueueType: 'enqueue';
+    Doc: string;
+    UpdatedFields: '';
+    RemovedFields: '';
+}
+export interface IDBNextEventDataReplaceQueueDequeue extends IDBEventBase {
+    DataType: 'replace';
+    QueueType: 'dequeue';
+    Doc: string;
+    UpdatedFields: '';
+    RemovedFields: '';
+}
+export interface IDBNextEventDataAdd extends IDBEventBase {
+    DataType: 'add';
+    QueueType: 'enqueue';
+}
+export interface IDBNextEventDataRemove extends IDBEventBase {
+    DataType: 'remove';
+    QueueType: 'dequeue';
+    Doc: '';
+}
+export interface IDBNextEventDataLimitQueueEnqueue extends IDBEventBase {
+    DataType: 'limit';
+    QueueType: 'enqueue';
+    Doc: string;
+    UpdatedFields: '';
+    RemovedFields: '';
+}
+export interface IDBNextEventDataLimitQueueDequeue extends IDBEventBase {
+    DataType: 'limit';
+    QueueType: 'dequeue';
+    Doc: '';
+    UpdatedFields: '';
+    RemovedFields: '';
+}

package/dist/esm/util.d.ts

@@ -0,0 +1,9 @@
+interface DocumentModel {
+    _id: string;
+}
+export declare class Util {
+    static formatResDocumentData: (documents: DocumentModel[]) => {}[];
+    static whichType: (obj: any) => String;
+    static generateDocId: () => string;
+}
+export {};

package/dist/esm/util.js

@@ -0,0 +1,142 @@
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+import { FieldType } from './constant';
+import { Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon } from './geo/index';
+import { ServerDate } from './serverDate/index';
+var Util = (function () {
+    function Util() {
+    }
+    Util.formatResDocumentData = function (documents) {
+        return documents.map(function (document) {
+            return Util.formatField(document);
+        });
+    };
+    Util.formatField = function (document) {
+        var keys = Object.keys(document);
+        var protoField = {};
+        if (Array.isArray(document)) {
+            protoField = [];
+        }
+        keys.forEach(function (key) {
+            var item = document[key];
+            var type = Util.whichType(item);
+            var realValue;
+            switch (type) {
+                case FieldType.GeoPoint:
+                    realValue = new Point(item.coordinates[0], item.coordinates[1]);
+                    break;
+                case FieldType.GeoLineString:
+                    realValue = new LineString(item.coordinates.map(function (point) { return new Point(point[0], point[1]); }));
+                    break;
+                case FieldType.GeoPolygon:
+                    realValue = new Polygon(item.coordinates.map(function (line) { return new LineString(line.map(function (_a) {
+                        var _b = __read(_a, 2), lng = _b[0], lat = _b[1];
+                        return new Point(lng, lat);
+                    })); }));
+                    break;
+                case FieldType.GeoMultiPoint:
+                    realValue = new MultiPoint(item.coordinates.map(function (point) { return new Point(point[0], point[1]); }));
+                    break;
+                case FieldType.GeoMultiLineString:
+                    realValue = new MultiLineString(item.coordinates.map(function (line) { return new LineString(line.map(function (_a) {
+                        var _b = __read(_a, 2), lng = _b[0], lat = _b[1];
+                        return new Point(lng, lat);
+                    })); }));
+                    break;
+                case FieldType.GeoMultiPolygon:
+                    realValue = new MultiPolygon(item.coordinates.map(function (polygon) {
+                        return new Polygon(polygon.map(function (line) { return new LineString(line.map(function (_a) {
+                            var _b = __read(_a, 2), lng = _b[0], lat = _b[1];
+                            return new Point(lng, lat);
+                        })); }));
+                    }));
+                    break;
+                case FieldType.Timestamp:
+                    realValue = new Date(item.$timestamp * 1000);
+                    break;
+                case FieldType.Object:
+                case FieldType.Array:
+                    realValue = Util.formatField(item);
+                    break;
+                case FieldType.ServerDate:
+                    realValue = new Date(item.$date);
+                    break;
+                default:
+                    realValue = item;
+            }
+            if (Array.isArray(protoField)) {
+                protoField.push(realValue);
+            }
+            else {
+                protoField[key] = realValue;
+            }
+        });
+        return protoField;
+    };
+    Util.whichType = function (obj) {
+        var type = Object.prototype.toString.call(obj).slice(8, -1);
+        if (type === FieldType.Timestamp) {
+            return FieldType.BsonDate;
+        }
+        if (type === FieldType.Object) {
+            if (obj instanceof Point) {
+                return FieldType.GeoPoint;
+            }
+            else if (obj instanceof Date) {
+                return FieldType.Timestamp;
+            }
+            else if (obj instanceof ServerDate) {
+                return FieldType.ServerDate;
+            }
+            if (obj.$timestamp) {
+                type = FieldType.Timestamp;
+            }
+            else if (obj.$date) {
+                type = FieldType.ServerDate;
+            }
+            else if (Point.validate(obj)) {
+                type = FieldType.GeoPoint;
+            }
+            else if (LineString.validate(obj)) {
+                type = FieldType.GeoLineString;
+            }
+            else if (Polygon.validate(obj)) {
+                type = FieldType.GeoPolygon;
+            }
+            else if (MultiPoint.validate(obj)) {
+                type = FieldType.GeoMultiPoint;
+            }
+            else if (MultiLineString.validate(obj)) {
+                type = FieldType.GeoMultiLineString;
+            }
+            else if (MultiPolygon.validate(obj)) {
+                type = FieldType.GeoMultiPolygon;
+            }
+        }
+        return type;
+    };
+    Util.generateDocId = function () {
+        var chars = 'ABCDEFabcdef0123456789';
+        var autoId = '';
+        for (var i = 0; i < 24; i++) {
+            autoId += chars.charAt(Math.floor(Math.random() * chars.length));
+        }
+        return autoId;
+    };
+    return Util;
+}());
+export { Util };

package/dist/esm/utils/error.d.ts

@@ -0,0 +1,37 @@
+export interface ICloudSDKError extends Error {
+    errCode: number;
+    errMsg: string;
+}
+export declare class CloudSDKError extends Error {
+    errCode: string;
+    errMsg: string;
+    requestID?: string;
+    constructor(options: IErrorConstructorOptions);
+    message: 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/dist/esm/utils/error.js

@@ -0,0 +1,82 @@
+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 __());
+    };
+})();
+import { isString } from './type';
+import { ERR_CODE } from '../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: " + this.errCode + " " + (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: " + this.errCode + " | errMsg: " + this.errMsg;
+        },
+        set: function (msg) {
+            this.errMsg = msg;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    return CloudSDKError;
+}(Error));
+export { CloudSDKError };
+export function isSDKError(error) {
+    return (error && error instanceof Error && isString(error.errMsg));
+}
+export var isGenericError = function (e) { return e.generic; };
+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));
+export { TimeoutError };
+export var isTimeoutError = function (e) {
+    return e.type === 'timeout';
+};
+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));
+export { CancelledError };
+export var isCancelledError = function (e) {
+    return e.type === 'cancelled';
+};

package/dist/esm/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/dist/esm/utils/symbol.js

@@ -0,0 +1,55 @@
+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 __());
+    };
+})();
+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__) {
+        var _this = this;
+        if (__mark__ !== __internalMark__) {
+            throw new TypeError('InternalSymbol cannot be constructed with new operator');
+        }
+        _this = _super.call(this, target) || this;
+        return _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));
+export { InternalSymbol };
+export default InternalSymbol;

package/dist/esm/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;
+declare 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/dist/esm/utils/type.js

@@ -0,0 +1,20 @@
+import { InternalSymbol } from './symbol';
+export var getType = function (x) { return Object.prototype.toString.call(x).slice(8, -1).toLowerCase(); };
+export var isObject = function (x) { return getType(x) === 'object'; };
+export var isString = function (x) { return getType(x) === 'string'; };
+export var isNumber = function (x) { return getType(x) === 'number'; };
+export var isPromise = function (x) { return getType(x) === 'promise'; };
+export var isFunction = function (x) { return typeof x === 'function'; };
+export var isArray = function (x) { return Array.isArray(x); };
+export var isDate = function (x) { return getType(x) === 'date'; };
+export var isRegExp = function (x) { return getType(x) === 'regexp'; };
+export var isInternalObject = function (x) { return x && (x._internalType instanceof InternalSymbol); };
+export 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;
+};

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

@@ -0,0 +1,33 @@
+import { Db } from '../';
+export var sleep = function (ms) {
+    if (ms === void 0) { ms = 0; }
+    return new Promise(function (r) { return setTimeout(r, ms); });
+};
+var counters = {};
+export var autoCount = function (domain) {
+    if (domain === void 0) { domain = 'any'; }
+    if (!counters[domain]) {
+        counters[domain] = 0;
+    }
+    return counters[domain]++;
+};
+var wsList = {};
+export function getWsInstance(db) {
+    if (!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 Db.wsClientClass({
+            context: {
+                appConfig: {
+                    docSizeLimit: 1000,
+                    realtimePingInterval: 10000,
+                    realtimePongWaitTimeout: 5000,
+                    request: new Db.reqClass(db.config)
+                }
+            }
+        });
+    }
+    return wsList[env];
+}

package/dist/esm/validate.d.ts

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