@cloudbase/database 0.9.21 → 0.10.0-alpha.0

package/dist/esm/utils/symbol.js

@@ -2,10 +2,12 @@ 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]; };
+            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 __());
@@ -29,12 +31,10 @@ var HiddenSymbol = (function () {
 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;
+        return _super.call(this, target) || this;
     }
     InternalSymbol.for = function (target) {
         for (var i = 0, len = _symbols.length; i < len; i++) {

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

@@ -3,7 +3,7 @@ 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;
+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;

package/dist/esm/utils/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/utils/type.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO,oBAAmF,CAAA;AAEvG,eAAO,MAAM,QAAQ,sCAAgE,CAAA;AAErF,eAAO,MAAM,QAAQ,yBAAmD,CAAA;AAExE,eAAO,MAAM,QAAQ,yBAAmD,CAAA;AAExE,eAAO,MAAM,SAAS,2DAAsF,CAAA;AAE5G,aAAK,KAAK,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;AACpC,eAAO,MAAM,UAAU,6CAAuE,CAAA;AAE9F,eAAO,MAAM,OAAO,6CAA+D,CAAA;AAEnF,eAAO,MAAM,MAAM,uBAA+C,CAAA;AAElE,eAAO,MAAM,QAAQ,yBAAmD,CAAA;AAExE,eAAO,MAAM,gBAAgB,qBAAwE,CAAA;AAErG,eAAO,MAAM,aAAa,6BASzB,CAAA"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/utils/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,KAAK,CAAC;AAEzB,eAAO,MAAM,KAAK,mCAA0D,CAAA;AAI5E,eAAO,MAAM,SAAS,6BAKrB,CAAA;AAMD,wBAAgB,aAAa,CAAC,EAAE,EAAE,EAAE,OAoBnC"}

package/dist/esm/utils/utils.js

@@ -24,7 +24,7 @@ export function getWsInstance(db) {
                     docSizeLimit: 1000,
                     realtimePingInterval: 10000,
                     realtimePongWaitTimeout: 5000,
-                    request: new Db.reqClass(db.config)
+                    request: Db.createRequest(db.config)
                 }
             }
         });

package/dist/esm/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/validate.ts"],"names":[],"mappings":""}

package/jest.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/tests/**/*.ts'],
+  moduleFileExtensions: ['ts', 'js'],
+  transform: {
+    '^.+\\.ts$': ['ts-jest', {
+      tsconfig: 'tsconfig.test.json'
+    }]
+  },
+  transformIgnorePatterns: [
+    '/node_modules/(?!@types)/'
+  ]
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/database",
-  "version": "0.9.21",
+  "version": "0.10.0-alpha.0",
   "description": "database for (node.)js sdk ",
   "main": "dist/commonjs/index.js",
   "module": "dist/esm/index.js",
@@ -10,25 +10,27 @@
   "scripts": {
     "eslint": "eslint \"./**/*.ts\"",
     "eslint-fix": "eslint --fix \"./**/*.ts\"",
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest",
     "build": "tsc -p tsconfig.json && tsc -p tsconfig.esm.json",
     "prepublishOnly": "npm run build"
   },
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@types/jest": "26.0.24",
+    "@types/node": "14.14.31",
     "eslint": "^5.15.3",
     "eslint-config-prettier": "^4.1.0",
     "eslint-plugin-prettier": "^3.0.1",
     "eslint-plugin-typescript": "^0.14.0",
-    "typescript": "^3.6.2",
+    "jest": "26.6.3",
+    "ts-jest": "26.5.6",
+    "typescript": "^4.1.0",
     "typescript-eslint-parser": "^22.0.0"
   },
   "sideEffects": false,
   "dependencies": {
-    "bson": "^4.0.2",
-    "lodash.clonedeep": "4.5.0",
-    "lodash.set": "4.3.2",
-    "lodash.unset": "4.5.2"
-  }
+    "bson": "^4.0.2"
+  },
+  "packageManager": "yarn@1.22.22"
 }

package/src/aggregate.ts

@@ -12,7 +12,7 @@ export default class Aggregation {
 
     if (db && collectionName) {
       this._db = db
-      this._request = new Db.reqClass(this._db.config)
+      this._request = Db.createRequest(this._db.config)
       this._collectionName = collectionName
     }
   }

package/src/document.ts

@@ -59,7 +59,7 @@ export class DocumentReference {
     this._coll = coll
     this.id = docID
     /* eslint-disable new-cap*/
-    this.request = new Db.reqClass(this._db.config)
+    this.request = Db.createRequest(this._db.config)
     this.projection = projection
   }
 

package/src/index.ts

@@ -9,6 +9,20 @@ import { LogicCommand } from './commands/logic'
 import { QueryCommand } from './commands/query'
 import { UpdateCommand } from './commands/update'
 
+/**
+ * 数据库配置接口
+ */
+export interface IDbConfig {
+  /** 数据库环境 ID */
+  env?: string;
+  /** 实例 ID（可选） */
+  instance?: string;
+  /** 数据库名称（可选） */
+  database?: string;
+  /** 可能的其他配置属性（用于扩展） */
+  [key: string]: any;
+}
+
 /**
  * 地理位置类型
  */
@@ -55,9 +69,9 @@ export class Db {
    *
    * 默认是 `default` 数据库，为今后扩展使用
    *
-   * @param config
+   * @param config - 数据库配置
    */
-  config: any
+  config: IDbConfig
 
   static ws: any
 
@@ -78,7 +92,29 @@ export class Db {
   // 应用签名信息，由jssdk传入
   static appSecretInfo: any
 
-  constructor(config?: any) {
+  // 创建请求实例的包装方法，自动添加instance和database参数
+  static createRequest(config: IDbConfig): any {
+    const request = new Db.reqClass(config)
+    const originalSend = request.send
+    
+    // 包装send方法，自动添加instance和database参数
+    request.send = function(action: string, data: any): any {
+      // 如果配置中包含instance或database参数，添加到请求数据中
+      if (config.instance) {
+        data.instance = config.instance
+      }
+      if (config.database) {
+        data.database = config.database
+      }
+      
+      // 调用原始的send方法
+      return originalSend.call(this, action, data)
+    }
+    
+    return request
+  }
+
+  constructor(config?: IDbConfig) {
     this.config = config
     this.Geo = Geo
     this.serverDate = ServerDateConstructor
@@ -109,7 +145,7 @@ export class Db {
    * 创建集合
    */
   createCollection(collName: string) {
-    let request = new Db.reqClass(this.config)
+    let request = Db.createRequest(this.config)
 
     const params = {
       collectionName: collName

package/src/lib/util.ts

@@ -1,7 +1,6 @@
 export const createPromiseCallback = () => {
-  let cb: any
+  let cb: any = () => {}
   if (!Promise) {
-    cb = () => {}
     cb.promise = {}
 
     const throwPromiseNotDefined = () => {

package/src/query.ts

@@ -144,7 +144,7 @@ export class Query {
     // this._wsURL = "ws://localhost:3000"
 
     /* eslint-disable new-cap */
-    this._request = new Db.reqClass(this._db.config)
+    this._request = Db.createRequest(this._db.config)
   }
 
   /**
@@ -204,9 +204,9 @@ export class Query {
             data: documents,
             requestId: res.requestId
           }
-          if (res.total) result.total = res.total
-          if (res.limit) result.limit = res.limit
-          if (res.offset) result.offset = res.offset
+          if (res.total !== undefined) result.total = res.total
+          if (res.limit !== undefined) result.limit = res.limit
+          if (res.offset !== undefined) result.offset = res.offset
           callback(0, result)
         }
       })

package/src/transaction/index.ts

@@ -27,7 +27,7 @@ export class Transaction {
 
   public constructor(db: Db) {
     this._db = db
-    this._request = new Db.reqClass(this._db.config)
+    this._request = Db.createRequest(this._db.config)
     this.aborted = false
     this.commited = false
     this.inited = false

package/src/utils/utils.ts

@@ -28,7 +28,7 @@ export function getWsInstance(db: Db) {
           docSizeLimit: 1000,
           realtimePingInterval: 10000,
           realtimePongWaitTimeout: 5000,
-          request: new Db.reqClass(db.config)
+          request: Db.createRequest(db.config)
         }
       }
     })

package/tests/index.test.ts

@@ -0,0 +1,111 @@
+import { Db } from '../src/index'
+
+describe('数据库请求参数测试', function() {
+  // 模拟请求类，用于捕获和验证请求参数
+  class MockRequest {
+    private config: any;
+    
+    constructor(config: any) {
+      this.config = config;
+    }
+
+    async send(action: string, data: any) {
+      // 验证 instance 和 database 参数是否正确传递
+      if (this.config.instance) {
+        expect(data).toHaveProperty('instance', this.config.instance);
+      }
+      if (this.config.database) {
+        expect(data).toHaveProperty('database', this.config.database);
+      }
+
+      // 返回符合各操作期望的数据结构
+      switch (action) {
+        case 'database.queryDocument':
+          return {
+            data: {
+              list: [
+                { _id: 'doc1', name: '测试文档1', value: 100 },
+                { _id: 'doc2', name: '测试文档2', value: 200 }
+              ]
+            },
+            requestId: 'mock-request-id-123456',
+            total: 2,
+            limit: 100,
+            offset: 0
+          };
+        default:
+          return { data: { ok: 1 } };
+      }
+    }
+  }
+
+  // 测试配置
+  const testConfig = { 
+    env: 'test-env', 
+    instance: 'test-instance', 
+    database: 'test-database' 
+  };
+
+  // 在每个测试前配置
+  beforeEach(function() {
+    Db.reqClass = MockRequest;
+  });
+
+  it('集合查询操作应包含 instance 和 database 参数', async function() {
+    const db = new Db(testConfig);
+    const coll = db.collection('test-collection');
+    await coll.where({}).get();
+  });
+
+  it('集合添加操作应包含 instance 和 database 参数', async function() {
+    const db = new Db(testConfig);
+    const coll = db.collection('test-collection');
+    await coll.add({ name: '新文档', value: 300 });
+  });
+
+  it('文档更新操作应包含 instance 和 database 参数', async function() {
+    const db = new Db(testConfig);
+    const coll = db.collection('test-collection');
+    const doc = coll.doc('doc1');
+    await doc.update({ value: 150 });
+  });
+
+  it('聚合操作应包含 instance 和 database 参数', async function() {
+    const db = new Db(testConfig);
+    const coll = db.collection('test-collection');
+    const aggregate = coll
+      .aggregate()
+      .match({ value: { $gt: 50 } })
+      .group({ _id: null, total: { $sum: '$value' } });
+    await aggregate.end();
+  });
+
+  it('创建集合操作应包含 instance 和 database 参数', async function() {
+    const db = new Db(testConfig);
+    await db.createCollection('new-collection');
+  });
+
+  it('应支持 const res = await db.collection(\'xxx\').get() 方式调用', async function() {
+    const db = new Db(testConfig);
+    const coll = db.collection('test-collection');
+    
+    // 测试直接调用 get() 而不传递 where 条件
+    const res = await coll.get();
+    console.log(res)
+    
+    // 验证返回结果的结构
+    expect(res).toHaveProperty('data');
+    expect(res).toHaveProperty('requestId');
+    expect(res).toHaveProperty('total');
+    expect(res).toHaveProperty('limit');
+    expect(res).toHaveProperty('offset');
+    
+    // 验证返回的数据
+    expect(Array.isArray(res.data)).toBe(true);
+    expect(res.data.length).toBe(2);
+    expect(res.data[0]).toHaveProperty('_id', 'doc1');
+    expect(res.data[0]).toHaveProperty('name', '测试文档1');
+    expect(res.data[1]).toHaveProperty('_id', 'doc2');
+    expect(res.data[1]).toHaveProperty('name', '测试文档2');
+  });
+});

package/tsconfig.esm.json

@@ -36,6 +36,7 @@
   ],
   "exclude": [
     // "node_modules",
-    "test"
+    "test",
+    "tests"
   ]
 }

package/tsconfig.json

@@ -4,7 +4,6 @@
     "allowJs": false,
     "allowUnreachableCode": false,
     "allowUnusedLabels": false,
-    "charset": "utf8",
     "declaration": true,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
@@ -24,8 +23,18 @@
     "downlevelIteration": true,
     "skipLibCheck": true,
     "target": "es5",
-    "lib": ["es2015", "es6", "dom"]
+    "lib": [
+      "es2015",
+      "es6",
+      "dom"
+    ]
   },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "test"]
-}
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "test",
+    "tests"
+  ]
+}

package/tsconfig.test.json

@@ -0,0 +1,15 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "isolatedModules": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "allowJs": true
+  },
+  "include": ["tests/**/*.ts", "src/**/*.ts"],
+  "exclude": ["node_modules"]
+}

package/.trunk/configs/.markdownlint.yaml

@@ -1,10 +0,0 @@
-# Autoformatter friendly markdownlint config (all formatting rules disabled)
-default: true
-blank_lines: false
-bullet: false
-html: false
-indentation: false
-line_length: false
-spaces: false
-url: false
-whitespace: false

package/.trunk/trunk.yaml

@@ -1,26 +0,0 @@
-version: 0.1
-cli:
-  version: 1.4.1
-plugins:
-  sources:
-    - id: trunk
-      ref: v0.0.10
-      uri: https://github.com/trunk-io/plugins
-lint:
-  enabled:
-    - eslint@8.33.0
-    - markdownlint@0.33.0
-    - git-diff-check
-    - gitleaks@8.15.3
-    - prettier@2.8.4
-runtimes:
-  enabled:
-    - go@1.18.3
-    - node@18.12.1
-actions:
-  disabled:
-    - trunk-announce
-    - trunk-check-pre-push
-    - trunk-fmt-pre-commit
-  enabled:
-    - trunk-upgrade-available