@cloudbase/database 1.4.3 → 1.5.0

package/dist/esm/realtime/ws-event.d.ts

@@ -1,126 +0,0 @@
-import { CloudSDKError } from '../utils/error';
-export declare const CLOSE_EVENT_CODE_INFO: {
-    1000: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1001: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1002: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1003: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1005: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1006: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1007: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1008: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1009: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1010: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1011: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1012: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1013: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1014: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    1015: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    3000: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    3001: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    3002: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    3003: {
-        code: number;
-        name: string;
-        description: string;
-    };
-    3050: {
-        code: number;
-        name: string;
-        description: string;
-    };
-};
-export declare enum CLOSE_EVENT_CODE {
-    NormalClosure = 1000,
-    GoingAway = 1001,
-    ProtocolError = 1002,
-    UnsupportedData = 1003,
-    NoStatusReceived = 1005,
-    AbnormalClosure = 1006,
-    InvalidFramePayloadData = 1007,
-    PolicyViolation = 1008,
-    MessageTooBig = 1009,
-    MissingExtension = 1010,
-    InternalError = 1011,
-    ServiceRestart = 1012,
-    TryAgainLater = 1013,
-    BadGateway = 1014,
-    TLSHandshake = 1015,
-    ReconnectWebSocket = 3000,
-    NoRealtimeListeners = 3001,
-    HeartbeatPingError = 3002,
-    HeartbeatPongTimeoutError = 3003,
-    NoAuthentication = 3050
-}
-export declare const getWSCloseError: (code: CLOSE_EVENT_CODE, reason?: string) => CloudSDKError;

package/dist/esm/realtime/ws-event.js

@@ -1,137 +0,0 @@
-import { CloudSDKError } from '../utils/error';
-import { ERR_CODE } from '../config/error.config';
-export const CLOSE_EVENT_CODE_INFO = {
-    1000: {
-        code: 1000,
-        name: 'Normal Closure',
-        description: 'Normal closure; the connection successfully completed whatever purpose for which it was created.'
-    },
-    1001: {
-        code: 1001,
-        name: 'Going Away',
-        description: 'The endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.'
-    },
-    1002: {
-        code: 1002,
-        name: 'Protocol Error',
-        description: 'The endpoint is terminating the connection due to a protocol error.'
-    },
-    1003: {
-        code: 1003,
-        name: 'Unsupported Data',
-        description: 'The connection is being terminated because the endpoint received data of a type it cannot accept (for example, a text-only endpoint received binary data).'
-    },
-    1005: {
-        code: 1005,
-        name: 'No Status Received',
-        description: 'Indicates that no status code was provided even though one was expected.'
-    },
-    1006: {
-        code: 1006,
-        name: 'Abnormal Closure',
-        description: 'Used to indicate that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.'
-    },
-    1007: {
-        code: 1007,
-        name: 'Invalid frame payload data',
-        description: 'The endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., non-UTF-8 data within a text message).'
-    },
-    1008: {
-        code: 1008,
-        name: 'Policy Violation',
-        description: 'The endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.'
-    },
-    1009: {
-        code: 1009,
-        name: 'Message too big',
-        description: 'The endpoint is terminating the connection because a data frame was received that is too large.'
-    },
-    1010: {
-        code: 1010,
-        name: 'Missing Extension',
-        description: "The client is terminating the connection because it expected the server to negotiate one or more extension, but the server didn't."
-    },
-    1011: {
-        code: 1011,
-        name: 'Internal Error',
-        description: 'The server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.'
-    },
-    1012: {
-        code: 1012,
-        name: 'Service Restart',
-        description: 'The server is terminating the connection because it is restarting.'
-    },
-    1013: {
-        code: 1013,
-        name: 'Try Again Later',
-        description: 'The server is terminating the connection due to a temporary condition, e.g. it is overloaded and is casting off some of its clients.'
-    },
-    1014: {
-        code: 1014,
-        name: 'Bad Gateway',
-        description: 'The server was acting as a gateway or proxy and received an invalid response from the upstream server. This is similar to 502 HTTP Status Code.'
-    },
-    1015: {
-        code: 1015,
-        name: 'TLS Handshake',
-        description: "Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified)."
-    },
-    3000: {
-        code: 3000,
-        name: 'Reconnect WebSocket',
-        description: 'The client is terminating the connection because it wants to reconnect'
-    },
-    3001: {
-        code: 3001,
-        name: 'No Realtime Listeners',
-        description: 'The client is terminating the connection because no more realtime listeners exist'
-    },
-    3002: {
-        code: 3002,
-        name: 'Heartbeat Ping Error',
-        description: 'The client is terminating the connection due to its failure in sending heartbeat messages'
-    },
-    3003: {
-        code: 3003,
-        name: 'Heartbeat Pong Timeout Error',
-        description: 'The client is terminating the connection because no heartbeat response is received from the server'
-    },
-    3050: {
-        code: 3050,
-        name: 'Server Close',
-        description: 'The client is terminating the connection because no heartbeat response is received from the server'
-    }
-};
-export var CLOSE_EVENT_CODE;
-(function (CLOSE_EVENT_CODE) {
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["NormalClosure"] = 1000] = "NormalClosure";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["GoingAway"] = 1001] = "GoingAway";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["ProtocolError"] = 1002] = "ProtocolError";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["UnsupportedData"] = 1003] = "UnsupportedData";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["NoStatusReceived"] = 1005] = "NoStatusReceived";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["AbnormalClosure"] = 1006] = "AbnormalClosure";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["InvalidFramePayloadData"] = 1007] = "InvalidFramePayloadData";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["PolicyViolation"] = 1008] = "PolicyViolation";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["MessageTooBig"] = 1009] = "MessageTooBig";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["MissingExtension"] = 1010] = "MissingExtension";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["InternalError"] = 1011] = "InternalError";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["ServiceRestart"] = 1012] = "ServiceRestart";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["TryAgainLater"] = 1013] = "TryAgainLater";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["BadGateway"] = 1014] = "BadGateway";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["TLSHandshake"] = 1015] = "TLSHandshake";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["ReconnectWebSocket"] = 3000] = "ReconnectWebSocket";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["NoRealtimeListeners"] = 3001] = "NoRealtimeListeners";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["HeartbeatPingError"] = 3002] = "HeartbeatPingError";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["HeartbeatPongTimeoutError"] = 3003] = "HeartbeatPongTimeoutError";
-    CLOSE_EVENT_CODE[CLOSE_EVENT_CODE["NoAuthentication"] = 3050] = "NoAuthentication";
-})(CLOSE_EVENT_CODE || (CLOSE_EVENT_CODE = {}));
-export const getWSCloseError = (code, reason) => {
-    const info = CLOSE_EVENT_CODE_INFO[code];
-    const errMsg = !info
-        ? `code ${code}`
-        : `${info.name}, code ${code}, reason ${reason || info.description}`;
-    return new CloudSDKError({
-        errCode: ERR_CODE.SDK_DATABASE_REALTIME_LISTENER_WEBSOCKET_CONNECTION_CLOSED,
-        errMsg
-    });
-};

package/dist/esm/transaction.d.ts

@@ -1,42 +0,0 @@
-import { DocumentReference } from './document';
-import { Db } from './index';
-declare class DocumentSnapshot {
-    private _data;
-    requestId: string;
-    constructor(data: any, requestId: any);
-    data(): any;
-}
-export declare class Transaction {
-    private _id;
-    private _db;
-    private _request;
-    constructor(db: Db);
-    init(): Promise<void>;
-    get(documentRef: DocumentReference): Promise<DocumentSnapshot>;
-    set(documentRef: DocumentReference, data: Object): Promise<SetResult>;
-    update(documentRef: DocumentReference, data: Object): Promise<UpdateResult>;
-    delete(documentRef: DocumentReference): Promise<DeleteResult>;
-    commit(): Promise<CommitResult>;
-    rollback(): Promise<RollbackResult>;
-}
-export declare function startTransaction(): Promise<Transaction>;
-export declare function runTransaction(callback: (transaction: Transaction) => void | Promise<any>, times?: number): Promise<void>;
-declare type JsonString = string;
-interface CommitResult {
-    requestId: string;
-}
-interface RollbackResult {
-    requestId: string;
-}
-interface UpdateResult {
-    requestId: string;
-    updated: number;
-}
-interface SetResult extends UpdateResult {
-    upserted: JsonString;
-}
-interface DeleteResult {
-    requestId: string;
-    deleted: number | string;
-}
-export {};

package/dist/esm/transaction.js

@@ -1,121 +0,0 @@
-import { EJSON } from 'bson';
-import { Db } from './index';
-class DocumentSnapshot {
-    constructor(data, requestId) {
-        this._data = data;
-        this.requestId = requestId;
-    }
-    data() {
-        return this._data;
-    }
-}
-const START = 'database.startTransaction';
-const COMMIT = 'database.commitTransaction';
-const ABORT = 'database.abortTransaction';
-const GET_DOC = 'database.getInTransaction';
-const UPDATE_DOC = 'database.updateDocInTransaction';
-const DELETE_DOC = 'database.deleteDocInTransaction';
-export class Transaction {
-    constructor(db) {
-        this._db = db;
-        this._request = new Db.reqClass(this._db.config);
-    }
-    async init() {
-        const res = await this._request.send(START, {});
-        if (res.code) {
-            throw res;
-        }
-        this._id = res.transactionId;
-    }
-    async get(documentRef) {
-        const param = {
-            collectionName: documentRef._coll,
-            transactionId: this._id,
-            _id: documentRef.id
-        };
-        const res = await this._request.send(GET_DOC, param);
-        if (res.code)
-            throw res;
-        return new DocumentSnapshot(EJSON.parse(res.data), res.requestId);
-    }
-    async set(documentRef, data) {
-        const param = {
-            collectionName: documentRef._coll,
-            transactionId: this._id,
-            _id: documentRef.id,
-            data: EJSON.stringify(data, { relaxed: false }),
-            upsert: true
-        };
-        const res = await this._request.send(UPDATE_DOC, param);
-        if (res.code)
-            throw res;
-        return Object.assign(Object.assign({}, res), { updated: EJSON.parse(res.updated), upserted: res.upserted
-                ? JSON.parse(res.upserted)
-                : null });
-    }
-    async update(documentRef, data) {
-        const param = {
-            collectionName: documentRef._coll,
-            transactionId: this._id,
-            _id: documentRef.id,
-            data: EJSON.stringify({
-                $set: data
-            }, {
-                relaxed: false
-            })
-        };
-        const res = await this._request.send(UPDATE_DOC, param);
-        if (res.code)
-            throw res;
-        return Object.assign(Object.assign({}, res), { updated: EJSON.parse(res.updated) });
-    }
-    async delete(documentRef) {
-        const param = {
-            collectionName: documentRef._coll,
-            transactionId: this._id,
-            _id: documentRef.id
-        };
-        const res = await this._request.send(DELETE_DOC, param);
-        if (res.code)
-            throw res;
-        return Object.assign(Object.assign({}, res), { deleted: EJSON.parse(res.deleted) });
-    }
-    async commit() {
-        const param = {
-            transactionId: this._id
-        };
-        const res = await this._request.send(COMMIT, param);
-        if (res.code)
-            throw res;
-        return res;
-    }
-    async rollback() {
-        const param = {
-            transactionId: this._id
-        };
-        const res = await this._request.send(ABORT, param);
-        if (res.code)
-            throw res;
-        return res;
-    }
-}
-export async function startTransaction() {
-    const transaction = new Transaction(this);
-    await transaction.init();
-    return transaction;
-}
-export async function runTransaction(callback, times = 3) {
-    if (times <= 0) {
-        throw new Error('Transaction failed');
-    }
-    try {
-        const transaction = new Transaction(this);
-        await transaction.init();
-        await callback(transaction);
-        await transaction.commit();
-    }
-    catch (error) {
-        console.log(error);
-        return runTransaction.bind(this)(callback, --times);
-    }
-}

package/src/realtime/error.ts

@@ -1,19 +0,0 @@
-import { IResponseMessageErrorMsg } from '../typings/realtime'
-
-export class RealtimeErrorMessageError extends Error {
-  isRealtimeErrorMessageError = true
-  payload: IResponseMessageErrorMsg
-
-  constructor(serverErrorMsg: IResponseMessageErrorMsg) {
-    super(
-      `Watch Error ${JSON.stringify(serverErrorMsg.msgData)} (requestid: ${
-        serverErrorMsg.requestId
-      })`
-    )
-    this.payload = serverErrorMsg
-  }
-}
-
-export const isRealtimeErrorMessageError = (
-  e: any
-): e is RealtimeErrorMessageError => e && e.isRealtimeErrorMessageError

package/src/realtime/listener.ts

@@ -1,35 +0,0 @@
-import { VirtualWebSocketClient } from './virtual-websocket-client'
-import {
-  IRealtimeListenerConstructorOptions,
-  DBRealtimeListener
-} from '../typings/index'
-
-// =============== Realtime Listener (Public) ====================
-
-interface IRealtimeListenerOptions extends IRealtimeListenerConstructorOptions {
-  // init
-  close: () => void
-  // debug
-  debug?: boolean
-  virtualClient?: VirtualWebSocketClient
-}
-
-export class RealtimeListener implements DBRealtimeListener {
-  close: () => void
-  onChange: (res: any) => void
-  onError: (error: any) => void
-
-  constructor(options: IRealtimeListenerOptions) {
-    this.close = options.close
-    this.onChange = options.onChange
-    this.onError = options.onError
-
-    if (options.debug) {
-      Object.defineProperty(this, 'virtualClient', {
-        get: () => {
-          return options.virtualClient
-        }
-      })
-    }
-  }
-}

package/src/realtime/message.ts

@@ -1,14 +0,0 @@
-import {
-  IResponseMessage,
-  IResponseMessageInitEventMsg
-} from '../typings/realtime'
-
-export function genRequestId(prefix: string = '') {
-  return `${prefix ? `${prefix}_` : ''}${+new Date()}_${Math.random()}`
-}
-
-export function isInitEventMessage(
-  msg: IResponseMessage
-): msg is IResponseMessageInitEventMsg {
-  return msg.msgType === 'INIT_EVENT'
-}

package/src/realtime/snapshot.ts

@@ -1,60 +0,0 @@
-import { ISingleDBEvent, SnapshotType, ISnapshot } from '../typings/index'
-
-// =============== Realtime Snapshot / Change Event (Public) ====================
-
-interface ISnapshotConstructorOptions {
-  id: number
-  docChanges: ISingleDBEvent[]
-  docs: Record<string, any>[]
-  type?: SnapshotType
-  // EJSON: any
-  msgType?: String
-}
-
-export class Snapshot implements ISnapshot {
-  id!: number
-  docChanges!: ISingleDBEvent[]
-  docs!: Record<string, any>[]
-  type?: 'init'
-  // EJSON: any
-
-  constructor(options: ISnapshotConstructorOptions) {
-    const { id, docChanges, docs, msgType, type } = options
-
-    let cachedDocChanges: ISingleDBEvent[]
-    let cachedDocs: Record<string, any>[]
-
-    Object.defineProperties(this, {
-      id: {
-        get: () => id,
-        enumerable: true
-      },
-      docChanges: {
-        get: () => {
-          if (!cachedDocChanges) {
-            cachedDocChanges = JSON.parse(JSON.stringify(docChanges))
-          }
-          return cachedDocChanges
-        },
-        enumerable: true
-      },
-      docs: {
-        get: () => {
-          if (!cachedDocs) {
-            cachedDocs = JSON.parse(JSON.stringify(docs))
-          }
-          return cachedDocs
-        },
-        enumerable: true
-      },
-      msgType: {
-        get: () => msgType,
-        enumerable: true
-      },
-      type: {
-        get: () => type,
-        enumerable: true
-      }
-    })
-  }
-}