@cloudbase/database 1.4.2 → 1.4.3

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/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);
+    }
+}

package/dist/esm/command.d.ts

@@ -0,0 +1,175 @@
+import { QueryCommand } from './commands/query';
+import { LogicCommand } from './commands/logic';
+import { UpdateCommand } from './commands/update';
+import Aggregation from './aggregate';
+export declare type IQueryCondition = Record<string, any> | LogicCommand;
+export declare const Command: {
+    eq(val: any): QueryCommand;
+    neq(val: any): QueryCommand;
+    lt(val: any): QueryCommand;
+    lte(val: any): QueryCommand;
+    gt(val: any): QueryCommand;
+    gte(val: any): QueryCommand;
+    in(val: any): QueryCommand;
+    nin(val: any): QueryCommand;
+    all(val: any): QueryCommand;
+    elemMatch(val: any): QueryCommand;
+    exists(val: boolean): QueryCommand;
+    size(val: number): QueryCommand;
+    mod(): QueryCommand;
+    geoNear(val: any): QueryCommand;
+    geoWithin(val: any): QueryCommand;
+    geoIntersects(val: any): QueryCommand;
+    and(...__expressions__: import("./serializer/datatype").IQueryCondition[]): LogicCommand;
+    nor(...__expressions__: import("./serializer/datatype").IQueryCondition[]): LogicCommand;
+    or(...__expressions__: import("./serializer/datatype").IQueryCondition[]): LogicCommand;
+    not(...__expressions__: import("./serializer/datatype").IQueryCondition[]): LogicCommand;
+    set(val: any): UpdateCommand;
+    remove(): UpdateCommand;
+    inc(val: number): UpdateCommand;
+    mul(val: number): UpdateCommand;
+    push(...args: any[]): UpdateCommand;
+    pull(values: any): UpdateCommand;
+    pullAll(values: any): UpdateCommand;
+    pop(): UpdateCommand;
+    shift(): UpdateCommand;
+    unshift(...__values__: any[]): UpdateCommand;
+    addToSet(values: any): UpdateCommand;
+    rename(values: any): UpdateCommand;
+    bit(values: any): UpdateCommand;
+    max(values: any): UpdateCommand;
+    min(values: any): UpdateCommand;
+    expr(values: AggregationOperator): {
+        $expr: AggregationOperator;
+    };
+    jsonSchema(schema: any): {
+        $jsonSchema: any;
+    };
+    text(values: string | {
+        search: string;
+        language?: string;
+        caseSensitive?: boolean;
+        diacriticSensitive: boolean;
+    }): {
+        $search: {
+            (regexp: string | RegExp): number;
+            (searcher: {
+                [Symbol.search](string: string): number;
+            }): number;
+        };
+        $language?: undefined;
+        $caseSensitive?: undefined;
+        $diacriticSensitive?: undefined;
+    } | {
+        $search: string;
+        $language: string;
+        $caseSensitive: boolean;
+        $diacriticSensitive: boolean;
+    };
+    aggregate: {
+        pipeline(): Aggregation;
+        abs: (param: any) => AggregationOperator;
+        add: (param: any) => AggregationOperator;
+        ceil: (param: any) => AggregationOperator;
+        divide: (param: any) => AggregationOperator;
+        exp: (param: any) => AggregationOperator;
+        floor: (param: any) => AggregationOperator;
+        ln: (param: any) => AggregationOperator;
+        log: (param: any) => AggregationOperator;
+        log10: (param: any) => AggregationOperator;
+        mod: (param: any) => AggregationOperator;
+        multiply: (param: any) => AggregationOperator;
+        pow: (param: any) => AggregationOperator;
+        sqrt: (param: any) => AggregationOperator;
+        subtract: (param: any) => AggregationOperator;
+        trunc: (param: any) => AggregationOperator;
+        arrayElemAt: (param: any) => AggregationOperator;
+        arrayToObject: (param: any) => AggregationOperator;
+        concatArrays: (param: any) => AggregationOperator;
+        filter: (param: any) => AggregationOperator;
+        in: (param: any) => AggregationOperator;
+        indexOfArray: (param: any) => AggregationOperator;
+        isArray: (param: any) => AggregationOperator;
+        map: (param: any) => AggregationOperator;
+        range: (param: any) => AggregationOperator;
+        reduce: (param: any) => AggregationOperator;
+        reverseArray: (param: any) => AggregationOperator;
+        size: (param: any) => AggregationOperator;
+        slice: (param: any) => AggregationOperator;
+        zip: (param: any) => AggregationOperator;
+        and: (param: any) => AggregationOperator;
+        not: (param: any) => AggregationOperator;
+        or: (param: any) => AggregationOperator;
+        cmp: (param: any) => AggregationOperator;
+        eq: (param: any) => AggregationOperator;
+        gt: (param: any) => AggregationOperator;
+        gte: (param: any) => AggregationOperator;
+        lt: (param: any) => AggregationOperator;
+        lte: (param: any) => AggregationOperator;
+        neq: (param: any) => AggregationOperator;
+        cond: (param: any) => AggregationOperator;
+        ifNull: (param: any) => AggregationOperator;
+        switch: (param: any) => AggregationOperator;
+        dateFromParts: (param: any) => AggregationOperator;
+        dateFromString: (param: any) => AggregationOperator;
+        dayOfMonth: (param: any) => AggregationOperator;
+        dayOfWeek: (param: any) => AggregationOperator;
+        dayOfYear: (param: any) => AggregationOperator;
+        isoDayOfWeek: (param: any) => AggregationOperator;
+        isoWeek: (param: any) => AggregationOperator;
+        isoWeekYear: (param: any) => AggregationOperator;
+        millisecond: (param: any) => AggregationOperator;
+        minute: (param: any) => AggregationOperator;
+        month: (param: any) => AggregationOperator;
+        second: (param: any) => AggregationOperator;
+        hour: (param: any) => AggregationOperator;
+        week: (param: any) => AggregationOperator;
+        year: (param: any) => AggregationOperator;
+        literal: (param: any) => AggregationOperator;
+        mergeObjects: (param: any) => AggregationOperator;
+        objectToArray: (param: any) => AggregationOperator;
+        allElementsTrue: (param: any) => AggregationOperator;
+        anyElementTrue: (param: any) => AggregationOperator;
+        setDifference: (param: any) => AggregationOperator;
+        setEquals: (param: any) => AggregationOperator;
+        setIntersection: (param: any) => AggregationOperator;
+        setIsSubset: (param: any) => AggregationOperator;
+        setUnion: (param: any) => AggregationOperator;
+        concat: (param: any) => AggregationOperator;
+        dateToString: (param: any) => AggregationOperator;
+        indexOfBytes: (param: any) => AggregationOperator;
+        indexOfCP: (param: any) => AggregationOperator;
+        split: (param: any) => AggregationOperator;
+        strLenBytes: (param: any) => AggregationOperator;
+        strLenCP: (param: any) => AggregationOperator;
+        strcasecmp: (param: any) => AggregationOperator;
+        substr: (param: any) => AggregationOperator;
+        substrBytes: (param: any) => AggregationOperator;
+        substrCP: (param: any) => AggregationOperator;
+        toLower: (param: any) => AggregationOperator;
+        toUpper: (param: any) => AggregationOperator;
+        meta: (param: any) => AggregationOperator;
+        addToSet: (param: any) => AggregationOperator;
+        avg: (param: any) => AggregationOperator;
+        first: (param: any) => AggregationOperator;
+        last: (param: any) => AggregationOperator;
+        max: (param: any) => AggregationOperator;
+        min: (param: any) => AggregationOperator;
+        push: (param: any) => AggregationOperator;
+        stdDevPop: (param: any) => AggregationOperator;
+        stdDevSamp: (param: any) => AggregationOperator;
+        sum: (param: any) => AggregationOperator;
+        let: (param: any) => AggregationOperator;
+    };
+    project: {
+        slice: (param: any) => ProjectionOperator;
+        elemMatch: (param: any) => ProjectionOperator;
+    };
+};
+export declare class AggregationOperator {
+    constructor(name: any, param: any);
+}
+export declare class ProjectionOperator {
+    constructor(name: any, param: any);
+}
+export default Command;