@byted-apaas/server-sdk-node 0.0.2-beta.1

package/context/db/impl/db.d.ts

@@ -0,0 +1,61 @@
+import { _IKAllEndpoint, _IKSyncEndpoint, _IKQuery } from './IObject';
+import { ITransactionGetter } from './transaction';
+import { IDB, IDBSync, IDBWithCurrentObject } from '../db';
+import { currentObjApiName, metadataMap } from '../../../data/index';
+import { IOql } from "./oql/ioql";
+import { AppCtx } from "../../../application/application";
+export declare class DB<T, mt = metadataMap> implements IDB<T, mt> {
+    objectApiName: string;
+    constructor(objectApiName?: string);
+    /**
+     * 操作指定对象的记录数据
+     * @param objectApiName 指定对象的 ApiName
+     * @example
+     * ```
+     * context.db.object("_user").where({
+     *     gender: "male"
+     * }).find()
+     * ```
+     */
+    object<K extends keyof mt>(objectApiName: K): _IKAllEndpoint<mt[K]> & _IKQuery<mt[K]>;
+    /**
+     * 创建一个新的空事务
+     * @example
+     * ```
+     * let tx = context.db.newTransaction();
+     * let user = tx.object("_user").registerCreate({
+     *     _name: new kunlun.type.Multilingual({ zh: "用户1", en: "user1" }),
+     * });
+     * let contract = tx.object("contract").registerCreate({
+     *     _name: new kunlun.type.Multilingual({ zh: "用户1的合同", en: "user1's contract" }),
+     *     user: {id: user._id}
+     * });
+     * await tx.commit();
+     * ```
+     */
+    newTransaction(): ITransactionGetter<T, mt>;
+    /**
+     * OQL 操作
+     * @param oql 指定 OQL 语句
+     * @example
+     * ```
+     * let users = await context.db.oql("select _email from _user").execute();
+     * ```
+     */
+    oql(oql: string): IOql;
+}
+export declare class DBWithCurrentObject<T, mt = metadataMap> extends DB<T, mt> implements IDB<T, mt>, IDBWithCurrentObject<T, mt> {
+    /**
+     * 无需入参，操作当前对象的记录数据
+     */
+    currentObject(): _IKAllEndpoint<mt[currentObjApiName]> & _IKQuery<mt[currentObjApiName]>;
+    constructor(objectApiName: string);
+}
+/**
+ * ApplicationDB: 用于支持 OpenSDK 相关能力的 DB 相关类，目前仅实现 DB 同步操作接口
+ */
+export declare class ApplicationDB implements IDBSync {
+    appCtx: AppCtx;
+    constructor(appCtx: AppCtx);
+    object(objectApiName: string): _IKSyncEndpoint<{}> & _IKQuery<{}>;
+}

package/context/db/impl/db.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationDB = exports.DBWithCurrentObject = exports.DB = void 0;
+const object_1 = require("./object");
+const server_common_node_1 = require("@byted-apaas/server-common-node");
+const index_1 = require("./transaction/index");
+const oql_1 = require("./oql/oql");
+class DB {
+    constructor(objectApiName) {
+        this.objectApiName = objectApiName;
+    }
+    /**
+     * 操作指定对象的记录数据
+     * @param objectApiName 指定对象的 ApiName
+     * @example
+     * ```
+     * context.db.object("_user").where({
+     *     gender: "male"
+     * }).find()
+     * ```
+     */
+    object(objectApiName) {
+        return new object_1._KObject(objectApiName);
+    }
+    ;
+    /**
+     * 创建一个新的空事务
+     * @example
+     * ```
+     * let tx = context.db.newTransaction();
+     * let user = tx.object("_user").registerCreate({
+     *     _name: new kunlun.type.Multilingual({ zh: "用户1", en: "user1" }),
+     * });
+     * let contract = tx.object("contract").registerCreate({
+     *     _name: new kunlun.type.Multilingual({ zh: "用户1的合同", en: "user1's contract" }),
+     *     user: {id: user._id}
+     * });
+     * await tx.commit();
+     * ```
+     */
+    newTransaction() {
+        return new index_1.Transaction(this.objectApiName);
+    }
+    ;
+    /**
+     * OQL 操作
+     * @param oql 指定 OQL 语句
+     * @example
+     * ```
+     * let users = await context.db.oql("select _email from _user").execute();
+     * ```
+     */
+    oql(oql) {
+        return new oql_1.Oql(oql);
+    }
+}
+exports.DB = DB;
+class DBWithCurrentObject extends DB {
+    /**
+     * 无需入参，操作当前对象的记录数据
+     */
+    // @ts-ignore
+    currentObject() {
+        if (!this.objectApiName) {
+            throw new server_common_node_1.exceptions.InternalError(`context.objectApiName is empty`);
+        }
+        return new object_1._KObject(this.objectApiName);
+    }
+    ;
+    constructor(objectApiName) {
+        super(objectApiName);
+    }
+}
+exports.DBWithCurrentObject = DBWithCurrentObject;
+/**
+ * ApplicationDB: 用于支持 OpenSDK 相关能力的 DB 相关类，目前仅实现 DB 同步操作接口
+ */
+class ApplicationDB {
+    constructor(appCtx) {
+        this.appCtx = appCtx;
+    }
+    object(objectApiName) {
+        return new object_1._KApplicationObject(objectApiName, this.appCtx);
+    }
+}
+exports.ApplicationDB = ApplicationDB;
+//# sourceMappingURL=db.js.map

package/context/db/impl/db.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"db.js","sourceRoot":"","sources":["db.ts"],"names":[],"mappings":";;;AAAA,qCAAwD;AAKxD,wEAA4D;AAC5D,+CAAiD;AAEjD,mCAAgC;AAGhC,MAAa,EAAE;IAGX,YAAY,aAAsB;QAC9B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;IACtC,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAqB,aAAgB;QACvC,OAAO,IAAI,iBAAQ,CAAQ,aAAuB,CAAC,CAAA;IACvD,CAAC;IAAA,CAAC;IAEF;;;;;;;;;;;;;;OAcG;IACH,cAAc;QACV,OAAO,IAAI,mBAAW,CAAC,IAAI,CAAC,aAAa,CAAyC,CAAA;IACtF,CAAC;IAAA,CAAC;IAEF;;;;;;;OAOG;IACH,GAAG,CAAC,GAAW;QACX,OAAO,IAAI,SAAG,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;CACJ;AAnDD,gBAmDC;AAED,MAAa,mBAAyC,SAAQ,EAAS;IACnE;;OAEG;IACH,aAAa;IACb,aAAa;QACT,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACrB,MAAM,IAAI,+BAAU,CAAC,aAAa,CAAC,gCAAgC,CAAC,CAAC;SACxE;QACD,OAAO,IAAI,iBAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5C,CAAC;IAAA,CAAC;IAEF,YAAY,aAAqB;QAC7B,KAAK,CAAC,aAAa,CAAC,CAAA;IACxB,CAAC;CACJ;AAfD,kDAeC;AAED;;GAEG;AACH,MAAa,aAAa;IAGtB,YAAY,MAAc;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,aAAqB;QACxB,OAAO,IAAI,4BAAmB,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;CACJ;AAVD,sCAUC"}

package/context/db/impl/db.ts

@@ -0,0 +1,95 @@
+import { _KObject, _KApplicationObject } from './object'
+import { _IKAllEndpoint, _IKSyncEndpoint, _IKQuery } from './IObject'
+import { ITransactionGetter } from './transaction'
+import { IDB, IDBSync, IDBWithCurrentObject } from '../db'
+import { currentObjApiName, metadataMap } from '../../../data/index'
+import { exceptions } from '@byted-apaas/server-common-node'
+import { Transaction } from './transaction/index'
+import { IOql } from "./oql/ioql";
+import { Oql } from "./oql/oql";
+import { AppCtx } from "../../../application/application";
+
+export class DB<T, mt = metadataMap> implements IDB<T, mt> {
+    objectApiName: string
+
+    constructor(objectApiName?: string) {
+        this.objectApiName = objectApiName
+    }
+
+    /**
+     * 操作指定对象的记录数据
+     * @param objectApiName 指定对象的 ApiName
+     * @example
+     * ```
+     * context.db.object("_user").where({
+     *     gender: "male"
+     * }).find()
+     * ```
+     */
+    object<K extends keyof mt>(objectApiName: K): _IKAllEndpoint<mt[K]> & _IKQuery<mt[K]> {
+        return new _KObject<mt[K]>(objectApiName as string)
+    };
+
+    /**
+     * 创建一个新的空事务
+     * @example
+     * ```
+     * let tx = context.db.newTransaction();
+     * let user = tx.object("_user").registerCreate({
+     *     _name: new kunlun.type.Multilingual({ zh: "用户1", en: "user1" }),
+     * });
+     * let contract = tx.object("contract").registerCreate({
+     *     _name: new kunlun.type.Multilingual({ zh: "用户1的合同", en: "user1's contract" }),
+     *     user: {id: user._id}
+     * });
+     * await tx.commit();
+     * ```
+     */
+    newTransaction(): ITransactionGetter<T, mt> {
+        return new Transaction(this.objectApiName) as unknown as ITransactionGetter<T, mt>
+    };
+
+    /**
+     * OQL 操作
+     * @param oql 指定 OQL 语句
+     * @example
+     * ```
+     * let users = await context.db.oql("select _email from _user").execute();
+     * ```
+     */
+    oql(oql: string): IOql {
+        return new Oql(oql);
+    }
+}
+
+export class DBWithCurrentObject<T, mt = metadataMap> extends DB<T, mt> implements IDB<T, mt>, IDBWithCurrentObject<T, mt> {
+    /**
+     * 无需入参，操作当前对象的记录数据
+     */
+    // @ts-ignore
+    currentObject(): _IKAllEndpoint<mt[currentObjApiName]> & _IKQuery<mt[currentObjApiName]> {
+        if (!this.objectApiName) {
+            throw new exceptions.InternalError(`context.objectApiName is empty`);
+        }
+        return new _KObject(this.objectApiName);
+    };
+
+    constructor(objectApiName: string) {
+        super(objectApiName)
+    }
+}
+
+/**
+ * ApplicationDB: 用于支持 OpenSDK 相关能力的 DB 相关类，目前仅实现 DB 同步操作接口
+ */
+export class ApplicationDB implements IDBSync {
+    appCtx: AppCtx
+
+    constructor(appCtx: AppCtx) {
+        this.appCtx = appCtx
+    }
+
+    object(objectApiName: string): _IKSyncEndpoint<{}> & _IKQuery<{}> {
+        return new _KApplicationObject(objectApiName, this.appCtx);
+    }
+}

package/context/db/impl/object.d.ts

@@ -0,0 +1,92 @@
+import { _Cond, _Record, _WhereCond } from '../../../types/types';
+import { _IKAsyncEndpoint, _IKQuery, _IKSyncEndpoint } from './IObject';
+import { AppCtx } from '../../../application/application';
+/**
+ * _KObject is kunlun object, every method new a _KQuery object to deal.
+ */
+export interface _KObject<T> extends _KObjectSync<T>, _KObjectAsync<T>, _KObjectQuery<T> {
+}
+export declare class _KObject<T> {
+    apiName: string;
+    constructor(objectApiName: string);
+}
+/**
+ * _KApplicationObject is open sdk object implement.
+ */
+export interface _KApplicationObject<T> extends _KObjectSync<T>, _KObjectQuery<T> {
+}
+export declare class _KApplicationObject<T> {
+    apiName: string;
+    appCtx: AppCtx;
+    constructor(objectApiName: string, appCtx: AppCtx);
+}
+declare class _KObjectSync<T> implements _IKSyncEndpoint<T> {
+    apiName: string;
+    appCtx: AppCtx;
+    create(recordMap: _Cond<T>): Promise<{
+        _id: number;
+    }>;
+    delete(recordID: number): Promise<void>;
+    delete(record: _Cond<T>): Promise<void>;
+    update(_id: number, recordMap: _Cond<T>): Promise<void>;
+    update(recordMap: _Cond<T>): Promise<void>;
+    batchCreate(recordMapList: _Cond<T>[]): Promise<number[]>;
+    batchDelete(recordIdList: number[]): Promise<void>;
+    batchDelete(recordList: _Cond<T>[]): Promise<void>;
+    batchUpdate(recordMapList: _Cond<T>[]): Promise<void>;
+}
+declare class _KObjectAsync<T> implements _IKAsyncEndpoint<T> {
+    apiName: string;
+    batchCreateAsync(recordMapList: _Cond<T>[]): Promise<{
+        taskID: number;
+    }>;
+    batchDeleteAsync(recordIDList: number[]): Promise<{
+        taskID: number;
+    }>;
+    batchDeleteAsync(recordList: _Cond<T>[]): Promise<{
+        taskID: number;
+    }>;
+    batchUpdateAsync(recordMapList: _Cond<T>[]): Promise<{
+        taskID: number;
+    }>;
+}
+declare class _KObjectQuery<T> implements _IKQuery<T> {
+    apiName: string;
+    appCtx: AppCtx;
+    find(): Promise<_Record<T>[]>;
+    findOne(): Promise<_Record<T>>;
+    findAll(): Promise<_Record<T>[]>;
+    orderBy<K extends keyof T>(fieldApiNames: K[]): _KQuery<T>;
+    orderBy<K extends keyof T>(...fieldApiNames: K[]): _KQuery<T>;
+    orderByDesc<K extends keyof T>(fieldApiNames: K[]): _KQuery<T>;
+    orderByDesc<K extends keyof T>(...fieldApiNames: K[]): _KQuery<T>;
+    select<K extends keyof T>(fieldApiNames: K[]): _KQuery<T>;
+    select<K extends keyof T>(...fieldApiNames: K[]): _KQuery<T>;
+    where(conditionMap: _WhereCond<T>): _KQuery<T>;
+    where(): _KQuery<T>;
+    limit(limit: number): _KQuery<T>;
+    offset(offset: number): _KQuery<T>;
+    count(): Promise<number>;
+}
+/**
+ * _KQuery is kunlun query implement, implements ORM operations.
+ */
+declare class _KQuery<T> implements _IKQuery<T> {
+    constructor(objectApiName: string, appCtx?: AppCtx);
+    find(): Promise<_Record<T>[]>;
+    findOne(): Promise<_Record<T>>;
+    findAll(): Promise<_Record<T>[]>;
+    private getRecordsByPage;
+    orderBy<K extends keyof T>(fieldApiNames: K[]): this;
+    orderBy<K extends keyof T>(...fieldApiNames: K[]): this;
+    orderByDesc<K extends keyof T>(fieldApiNames: K[]): this;
+    orderByDesc<K extends keyof T>(...fieldApiNames: K[]): this;
+    select<K extends keyof T>(fieldApiNames: K[]): this;
+    select<K extends keyof T>(...fieldApiNames: K[]): this;
+    where(conditionMap: _WhereCond<T>): this;
+    where(): this;
+    limit(limit: number): this;
+    offset(offset: number): this;
+    count(): Promise<number>;
+}
+export {};