@cloudbase/database 1.3.0 → 1.4.1

package/dist/esm/validate.js

@@ -1,152 +1,152 @@
-import { ErrorCode, WhereFilterOpList, OrderDirectionList, FieldType } from './constant';
-import { Util } from './util';
-import { ERRORS } from './const/code';
-import { E } from './utils/utils';
-import { getType } from './utils/type';
-import { SYMBOL_GEO_POINT } from './helper/symbol';
-const validOptionsKeys = ['limit', 'offset', 'projection', 'order', 'multiple', 'timeout', 'raw'];
-export class Validate {
-    static isGeopoint(point, degree) {
-        if (Util.whichType(degree) !== FieldType.Number) {
-            throw new Error('Geo Point must be number type');
-        }
-        const 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;
-    }
-    static isInteger(param, num) {
-        if (!Number.isInteger(num)) {
-            throw new Error(param + ErrorCode.IntergerError);
-        }
-        return true;
-    }
-    static mustBeBoolean(param, bool) {
-        if (typeof bool !== 'boolean') {
-            throw new Error(param + ErrorCode.BooleanError);
-        }
-        return true;
-    }
-    static isProjection(param, value) {
-        if (getType(value) !== 'object') {
-            throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `${param} projection must be an object` }));
-        }
-        for (const key in value) {
-            const subValue = value[key];
-            if (getType(subValue) === 'number') {
-                if (subValue !== 0 && subValue !== 1) {
-                    throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `if the value in projection is of number, it must be 0 or 1` }));
-                }
-            }
-            else if (getType(subValue) === 'object') {
-            }
-            else {
-                throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: 'invalid projection' }));
-            }
-        }
-        return true;
-    }
-    static isOrder(param, value) {
-        if (getType(value) !== 'object') {
-            throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `${param} order must be an object` }));
-        }
-        for (let key in value) {
-            const subValue = value[key];
-            if (subValue !== 1 && subValue !== -1) {
-                throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `order value must be 1 or -1` }));
-            }
-        }
-        return true;
-    }
-    static isFieldOrder(direction) {
-        if (OrderDirectionList.indexOf(direction) === -1) {
-            throw new Error(ErrorCode.DirectionError);
-        }
-        return true;
-    }
-    static isFieldPath(path) {
-        if (!/^[a-zA-Z0-9-_\.]/.test(path)) {
-            throw new Error();
-        }
-        return true;
-    }
-    static isOperator(op) {
-        if (WhereFilterOpList.indexOf(op) === -1) {
-            throw new Error(ErrorCode.OpStrError);
-        }
-        return true;
-    }
-    static isCollName(name) {
-        if (!/^[a-zA-Z0-9]([a-zA-Z0-9-_]){1,32}$/.test(name)) {
-            throw new Error(ErrorCode.CollNameError);
-        }
-        return true;
-    }
-    static isDocID(docId) {
-        if (!/^([a-fA-F0-9]){24}$/.test(docId)) {
-            throw new Error(ErrorCode.DocIDError);
-        }
-        return true;
-    }
-    static isValidOptions(options = {}) {
-        if (getType(options) !== 'object') {
-            throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `options must be an object` }));
-        }
-        const keys = Object.keys(options);
-        for (const index in keys) {
-            if (validOptionsKeys.indexOf(keys[index]) < 0) {
-                throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `${keys[index]} is invalid options key` }));
-            }
-        }
-        const { limit, offset, projection, order } = options;
-        const { multiple } = options;
-        if (limit !== undefined) {
-            Validate.isInteger('limit', limit);
-        }
-        if (offset !== undefined) {
-            Validate.isInteger('offset', offset);
-        }
-        if (projection !== undefined) {
-            Validate.isProjection('projection', projection);
-        }
-        if (order !== undefined) {
-            Validate.isOrder('order', order);
-        }
-        if (multiple !== undefined) {
-            Validate.mustBeBoolean('multiple', multiple);
-        }
-        if (options.timeout !== undefined) {
-            Validate.isInteger('timeout', options.timeout);
-        }
-        return true;
-    }
-    static isValidAggregation(stage) {
-        if (Object.keys(stage).length !== 1) {
-            throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `aggregation stage must have one key` }));
-        }
-        return true;
-    }
-    static isCentersPhere(param) {
-        if (Array.isArray(param) && param.length === 2) {
-            if (getType(param[0]) === 'object' &&
-                param[0]._internalType === SYMBOL_GEO_POINT &&
-                typeof param[1] === 'number') {
-                return true;
-            }
-            if (Array.isArray(param[0]) && param[0].length === 2) {
-                const longitude = param[0][0];
-                const latitude = param[0][1];
-                Validate.isGeopoint('longitude', longitude);
-                Validate.isGeopoint('latitude', latitude);
-                if (typeof param[1] === 'number') {
-                    return true;
-                }
-            }
-        }
-        throw new Error(`${ErrorCode.CentersPhereError}`);
-    }
-}
+import { ErrorCode, WhereFilterOpList, OrderDirectionList, FieldType } from './constant';
+import { Util } from './util';
+import { ERRORS } from './const/code';
+import { E } from './utils/utils';
+import { getType } from './utils/type';
+import { SYMBOL_GEO_POINT } from './helper/symbol';
+const validOptionsKeys = ['limit', 'offset', 'projection', 'order', 'multiple', 'timeout', 'raw'];
+export class Validate {
+    static isGeopoint(point, degree) {
+        if (Util.whichType(degree) !== FieldType.Number) {
+            throw new Error('Geo Point must be number type');
+        }
+        const 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;
+    }
+    static isInteger(param, num) {
+        if (!Number.isInteger(num)) {
+            throw new Error(param + ErrorCode.IntergerError);
+        }
+        return true;
+    }
+    static mustBeBoolean(param, bool) {
+        if (typeof bool !== 'boolean') {
+            throw new Error(param + ErrorCode.BooleanError);
+        }
+        return true;
+    }
+    static isProjection(param, value) {
+        if (getType(value) !== 'object') {
+            throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `${param} projection must be an object` }));
+        }
+        for (const key in value) {
+            const subValue = value[key];
+            if (getType(subValue) === 'number') {
+                if (subValue !== 0 && subValue !== 1) {
+                    throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `if the value in projection is of number, it must be 0 or 1` }));
+                }
+            }
+            else if (getType(subValue) === 'object') {
+            }
+            else {
+                throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: 'invalid projection' }));
+            }
+        }
+        return true;
+    }
+    static isOrder(param, value) {
+        if (getType(value) !== 'object') {
+            throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `${param} order must be an object` }));
+        }
+        for (let key in value) {
+            const subValue = value[key];
+            if (subValue !== 1 && subValue !== -1) {
+                throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `order value must be 1 or -1` }));
+            }
+        }
+        return true;
+    }
+    static isFieldOrder(direction) {
+        if (OrderDirectionList.indexOf(direction) === -1) {
+            throw new Error(ErrorCode.DirectionError);
+        }
+        return true;
+    }
+    static isFieldPath(path) {
+        if (!/^[a-zA-Z0-9-_\.]/.test(path)) {
+            throw new Error();
+        }
+        return true;
+    }
+    static isOperator(op) {
+        if (WhereFilterOpList.indexOf(op) === -1) {
+            throw new Error(ErrorCode.OpStrError);
+        }
+        return true;
+    }
+    static isCollName(name) {
+        if (!/^[a-zA-Z0-9]([a-zA-Z0-9-_]){1,32}$/.test(name)) {
+            throw new Error(ErrorCode.CollNameError);
+        }
+        return true;
+    }
+    static isDocID(docId) {
+        if (!/^([a-fA-F0-9]){24}$/.test(docId)) {
+            throw new Error(ErrorCode.DocIDError);
+        }
+        return true;
+    }
+    static isValidOptions(options = {}) {
+        if (getType(options) !== 'object') {
+            throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `options must be an object` }));
+        }
+        const keys = Object.keys(options);
+        for (const index in keys) {
+            if (validOptionsKeys.indexOf(keys[index]) < 0) {
+                throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `${keys[index]} is invalid options key` }));
+            }
+        }
+        const { limit, offset, projection, order } = options;
+        const { multiple } = options;
+        if (limit !== undefined) {
+            Validate.isInteger('limit', limit);
+        }
+        if (offset !== undefined) {
+            Validate.isInteger('offset', offset);
+        }
+        if (projection !== undefined) {
+            Validate.isProjection('projection', projection);
+        }
+        if (order !== undefined) {
+            Validate.isOrder('order', order);
+        }
+        if (multiple !== undefined) {
+            Validate.mustBeBoolean('multiple', multiple);
+        }
+        if (options.timeout !== undefined) {
+            Validate.isInteger('timeout', options.timeout);
+        }
+        return true;
+    }
+    static isValidAggregation(stage) {
+        if (Object.keys(stage).length !== 1) {
+            throw E(Object.assign(Object.assign({}, ERRORS.INVALID_PARAM), { message: `aggregation stage must have one key` }));
+        }
+        return true;
+    }
+    static isCentersPhere(param) {
+        if (Array.isArray(param) && param.length === 2) {
+            if (getType(param[0]) === 'object' &&
+                param[0]._internalType === SYMBOL_GEO_POINT &&
+                typeof param[1] === 'number') {
+                return true;
+            }
+            if (Array.isArray(param[0]) && param[0].length === 2) {
+                const longitude = param[0][0];
+                const latitude = param[0][1];
+                Validate.isGeopoint('longitude', longitude);
+                Validate.isGeopoint('latitude', latitude);
+                if (typeof param[1] === 'number') {
+                    return true;
+                }
+            }
+        }
+        throw new Error(`${ErrorCode.CentersPhereError}`);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/database",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "database for (node.)js sdk ",
   "main": "dist/commonjs/index.js",
   "module": "dist/esm/index.js",

package/src/ObjectId/index.ts

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

package/src/aggregate.ts

@@ -4,8 +4,9 @@ import { QuerySerializer } from './serializer/query'
 import { stringifyByEJSON } from './utils/utils'
 import { getType } from './utils/type'
 import { Validate } from './validate'
+import { Point } from './geo/point'
 
-const EARTH_RADIUS = 6378100
+// const EARTH_RADIUS = 6378100
 
 export default class Aggregation {
   _db: any
@@ -97,12 +98,14 @@ export default class Aggregation {
     if (param.query) {
       param.query = QuerySerializer.encode(param.query)
     }
-
+    
     // 判断是否有 distanceMultiplier 参数
     if (param.distanceMultiplier && typeof (param.distanceMultiplier) === 'number') {
-      param.distanceMultiplier = param.distanceMultiplier * EARTH_RADIUS
-    } else {
-      param.distanceMultiplier = EARTH_RADIUS
+      param.distanceMultiplier = param.distanceMultiplier
+    }
+    
+    if(param.near) {
+      param.near = new Point(param.near.longitude, param.near.latitude).toJSON()
     }
     return this._pipe('geoNear', param)
   }

package/src/helper/symbol.ts

@@ -17,3 +17,5 @@ export const SYMBOL_GEO_MULTI_POLYGON = InternalSymbol.for('SYMBOL_GEO_MULTI_POL
 export const SYMBOL_SERVER_DATE = InternalSymbol.for('SERVER_DATE')
 
 export const SYMBOL_REGEXP = InternalSymbol.for('REGEXP')
+
+export const SYMBOL_OBJECTID = InternalSymbol.for('OBJECTID')

package/src/index.ts

@@ -5,6 +5,7 @@ import { Command } from './command'
 import { ServerDateConstructor } from './serverDate/index'
 import { RegExpConstructor } from './regexp/index'
 import { startTransaction, runTransaction } from './transaction/index'
+import { ObjectIdConstructor } from './ObjectId/index'
 
 /**
  * 地理位置类型
@@ -59,6 +60,8 @@ export class Db {
 
   serverDate: any
 
+  ObjectId: any
+
   startTransaction: any
 
   runTransaction: any
@@ -95,6 +98,7 @@ export class Db {
     this.serverDate = ServerDateConstructor
     this.command = Command
     this.RegExp = RegExpConstructor
+    this.ObjectId = ObjectIdConstructor
     this.startTransaction = startTransaction
     this.runTransaction = runTransaction
   }

package/src/serializer/datatype.ts

@@ -1,5 +1,5 @@
 // transpile internal data type
-import { SYMBOL_GEO_POINT, SYMBOL_SERVER_DATE, SYMBOL_REGEXP } from '../helper/symbol'
+import { SYMBOL_GEO_POINT, SYMBOL_SERVER_DATE, SYMBOL_OBJECTID, SYMBOL_REGEXP } from '../helper/symbol'
 import {
   getType,
   isObject,
@@ -13,6 +13,7 @@ import { Point } from '../geo/index'
 import { ServerDate } from '../serverDate/index'
 import { RegExp } from '../regexp/index'
 import { LogicCommand } from '../commands/logic'
+import { ObjectId } from '../ObjectId/index'
 
 export type IQueryCondition = Record<string, any> | LogicCommand
 
@@ -36,6 +37,9 @@ function serializeHelper(val: any, visited: object[]): Record<string, any> {
       case SYMBOL_REGEXP: {
         return (val as RegExp).parse()
       }
+      case SYMBOL_OBJECTID: {
+        return (val as ObjectId).parse()
+      }
       default: {
         return val.toJSON ? val.toJSON() : val
       }

package/dist/commonjs/decimal128/index.d.ts

@@ -1,8 +0,0 @@
-export declare class Decimal128Type {
-    readonly decimalStr: string;
-    constructor(decimalStr?: string);
-    readonly _internalType: import("../utils/symbol").InternalSymbol;
-    parse(): any;
-    toJSON(): any;
-}
-export declare function Decimal128TypeConstructor(decimalStr: any): Decimal128Type;

package/dist/commonjs/decimal128/index.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const bson_1 = require("bson");
-const symbol_1 = require("../helper/symbol");
-class Decimal128Type {
-    constructor(decimalStr = '') {
-        if (typeof decimalStr !== 'string') {
-            throw new TypeError(`Decimal128Type 入参必须为 string!`);
-        }
-        this.decimalStr = decimalStr;
-    }
-    get _internalType() {
-        return symbol_1.SYMBOL_DECIMAL128;
-    }
-    parse() {
-        return bson_1.Decimal128.fromString(this.decimalStr);
-    }
-    toJSON() {
-        return bson_1.Decimal128.fromString(this.decimalStr);
-    }
-}
-exports.Decimal128Type = Decimal128Type;
-function Decimal128TypeConstructor(decimalStr) {
-    return new Decimal128Type(decimalStr);
-}
-exports.Decimal128TypeConstructor = Decimal128TypeConstructor;

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

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

package/dist/commonjs/lib/util.js

@@ -1,25 +0,0 @@
-"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

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

@@ -1,46 +0,0 @@
-"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

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