@byted-apaas/server-sdk-node 1.0.17 → 1.1.0-beta.11

package/README.md

@@ -1,5 +1,16 @@
 ## aPaaS @byted-apaas/server-sdk-node 版本说明：
 
+### 版本：1.1.10｜兼容升级
+新功能：优化部分错误码
+
+-------
+### 版本：1.1.8｜兼容升级
+新功能：支持透传多分支标识
+
+-------
+### 版本：1.0.18｜兼容升级
+新功能：支持开发者获取飞书集成 app access token 及 tenant access token
+
 -------
 ### 版本：1.0.17｜兼容升级
 优化：废弃 flow.variables & flow.updateVariable 相关 API

package/application/application.d.ts

@@ -1,9 +1,10 @@
-import { _IOpenSDKResources } from "../context/resources/IResources";
-import { ITool, IToolsExtra } from "@byted-apaas/server-common-node/kunlun/tool/Itool";
-import { AppCredential } from "@byted-apaas/server-common-node/credential/credential";
-import { IDBSync } from "../context/db/db";
-import { IFunction } from "./function/function";
-import { PlatformEnvType } from "@byted-apaas/server-common-node/constants/constants";
+import { _IOpenSDKResources } from '../context/resources/IResources';
+import { ITool, IToolsExtra } from '@byted-apaas/server-common-node/kunlun/tool/Itool';
+import { AppCredential } from '@byted-apaas/server-common-node/credential/credential';
+import { IDBSync } from '../context/db/db';
+import { IFunction } from './function/function';
+import { PlatformEnvType } from '@byted-apaas/server-common-node/constants/constants';
+import { _IIntegration } from '../context/integration/IIntegration';
 /**
  * IApplication 为 OpenSDK 能力的核心接口
  *   - data:     元数据相关能力
@@ -14,6 +15,7 @@ export interface IApplication {
     data: IDBSync;
     resources: _IOpenSDKResources;
     tools: ITool & IToolsExtra;
+    integration: _IIntegration;
     cloudfunction(funcName: string): IFunction;
     env(platformEnvType: PlatformEnvType): IApplication;
     localDebugMode(): IApplication;
@@ -24,6 +26,6 @@ export interface AppCtx {
     mode: AppMode;
     env?: PlatformEnvType;
     credential: AppCredential;
-    debugType?: "0" | "2";
+    debugType?: '0' | '2';
     x_tt_env?: string;
 }

package/application/function/function.d.ts

@@ -1,4 +1,4 @@
-import { AppCtx } from "../application";
+import { AppCtx } from '../application';
 export interface IFunction {
     /**
      * 调用函数

package/application/function/function.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Function = void 0;
 const interface_1 = require("../../request/interface");
 const common_1 = require("../impl/common");
-const crypto = require("crypto");
 class Function {
     constructor(appCtx, apiName) {
         this.appCtx = appCtx;

package/application/impl/common.d.ts

@@ -1,2 +1,2 @@
-import { AppCtx } from "../application";
+import { AppCtx } from '../application';
 export declare function runCtxForOpenSDK(appCtx: AppCtx, promise: Function): Promise<any>;

package/application/impl/common.js

@@ -4,9 +4,10 @@ exports.runCtxForOpenSDK = void 0;
 const utils = require("@byted-apaas/server-common-node/utils/utils");
 const nodeClsCtx = require("@byted-apaas/server-common-node/utils/nodeClsCtx");
 const exceptions_1 = require("@byted-apaas/server-common-node/utils/exceptions");
-const crypto = require("crypto");
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const crypto = require('crypto'); //nolint:byted_s_ts_no_require_imports
 async function runCtxForOpenSDK(appCtx, promise) {
-    if (appCtx && appCtx.mode === "openSDK") {
+    if (appCtx && appCtx.mode === 'openSDK') {
         if (!appCtx.credential) {
             throw new exceptions_1.InvalidParamError(`credential is empty for openSDK`);
         }
@@ -16,28 +17,28 @@ async function runCtxForOpenSDK(appCtx, promise) {
             utils.setDebugType(appCtx.debugType);
             switch (appCtx.env) {
                 // @ts-ignore
-                case "developmentboe":
+                case 'developmentboe':
                     utils.setEnv('development');
-                    utils.setBoe("boe");
+                    utils.setBoe('boe');
                     break;
                 // @ts-ignore
-                case "stagingboe":
+                case 'stagingboe':
                     utils.setEnv('staging');
-                    utils.setBoe("boe");
+                    utils.setBoe('boe');
                     break;
-                case "staging":
+                case 'staging':
                     utils.setEnv('staging');
                     break;
-                case "gray":
-                    utils.setEnv("gray");
+                case 'gray':
+                    utils.setEnv('gray');
                     break;
-                case "online":
-                    utils.setEnv("online");
+                case 'online':
+                    utils.setEnv('online');
                     break;
                 default:
                     throw new exceptions_1.InvalidParamError(`platformEnvType is invalid for ${appCtx.env}`);
             }
-            utils.setInvokeFuncName("openSDK");
+            utils.setInvokeFuncName('openSDK');
             utils.setTenant(await appCtx.credential.getTenantInfo());
             utils.setXTTEnvOnlyDebug(appCtx.x_tt_env);
             if (!utils.getLogID()) {

package/application/impl/impl.d.ts

@@ -1,14 +1,16 @@
-import { ITool, IToolsExtra } from "@byted-apaas/server-common-node/kunlun/tool/Itool";
-import { IFunction } from "../function/function";
-import { IApplication } from "../application";
-import { _IOpenSDKResources } from "../../context/resources/IResources";
-import { IDBSync } from "../../context/db/db";
-import { PlatformEnvType } from "@byted-apaas/server-common-node/constants/constants";
+import { ITool, IToolsExtra } from '@byted-apaas/server-common-node/kunlun/tool/Itool';
+import { IFunction } from '../function/function';
+import { IApplication } from '../application';
+import { _IOpenSDKResources } from '../../context/resources/IResources';
+import { IDBSync } from '../../context/db/db';
+import { PlatformEnvType } from '@byted-apaas/server-common-node/constants/constants';
+import { _IIntegration } from '../../context/integration/IIntegration';
 export declare class Application implements IApplication {
     private appCtx;
     data: IDBSync;
     resources: _IOpenSDKResources;
     tools: ITool & IToolsExtra;
+    integration: _IIntegration;
     constructor(clientID: string, clientSecret: string);
     cloudfunction(funcName: string): IFunction;
     env(platformEnvType: PlatformEnvType): IApplication;

package/application/impl/impl.js

@@ -8,16 +8,18 @@ const function_1 = require("../function/function");
 const common_1 = require("../../request/common");
 const resources_1 = require("../../context/resources/impl/resources");
 const constants_1 = require("@byted-apaas/server-common-node/constants/constants");
+const integration_1 = require("../../context/integration/impl/integration");
 class Application {
     constructor(clientID, clientSecret) {
         this.appCtx = {
-            mode: "openSDK",
+            mode: 'openSDK',
             credential: new credential_1.AppCredential(clientID, clientSecret),
-            debugType: constants_1.DefaultDebugType ? constants_1.DefaultDebugType : "2",
-            env: "online"
+            debugType: constants_1.DefaultDebugType ? constants_1.DefaultDebugType : '2',
+            env: 'online',
         };
         this.data = new db_1.ApplicationDB(this.appCtx);
         this.resources = new resources_1._OpenSDKResources(this.appCtx);
+        this.integration = new integration_1._OpenSDKIntegration(this.appCtx);
         this.tools = new tool_1.Tool();
         this.tools.getTenantInfo = async () => {
             return await (0, common_1.getTenantInfo)(this.appCtx);
@@ -32,7 +34,7 @@ class Application {
     }
     // 设置本地调试模式
     localDebugMode() {
-        this.appCtx.debugType = "2";
+        this.appCtx.debugType = '2';
         return this;
     }
     setLaneName(laneName) {

package/common/structs.d.ts

@@ -0,0 +1,15 @@
+export interface BatchResult {
+    code: string;
+    msg: string;
+    data?: BatchResultData[];
+    hasError?: () => boolean;
+}
+export interface BatchResultData {
+    success: boolean;
+    _id: number;
+    errors?: BatchResultDataError[];
+}
+export interface BatchResultDataError {
+    code: string;
+}
+export declare function NewBatchResult(recordIDs: number[], errMap: Record<number, string>): BatchResult;

package/common/structs.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NewBatchResult = void 0;
+function NewBatchResult(recordIDs, errMap) {
+    const result = { code: "", msg: "success", data: [] };
+    let hasError = false;
+    recordIDs.forEach((id) => {
+        const d = { _id: id, success: true };
+        if (errMap && errMap[id]) {
+            hasError = true;
+            d.success = false;
+            d.errors = [{ code: errMap[id] }];
+        }
+        result.data.push(d);
+    });
+    result.hasError = () => {
+        return hasError;
+    };
+    return result;
+}
+exports.NewBatchResult = NewBatchResult;

package/constants/constants.js

@@ -4,15 +4,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.triggerType = exports.httpStatusCodes = exports.httpHeaderKeys = exports.notifyModel = void 0;
 exports.notifyModel = {
-    key: "ee.kunlun.cloudfunction.faas_buildin",
+    key: 'ee.kunlun.cloudfunction.faas_buildin',
 };
 exports.httpHeaderKeys = {
-    statusCode: "X-Kunlun-Status-Code",
-    location: "Location",
+    statusCode: 'X-Kunlun-Status-Code',
+    location: 'Location',
 };
 exports.httpStatusCodes = {
     redirect: 302,
 };
 exports.triggerType = {
-    defaultTrigger: "default-trigger"
+    defaultTrigger: 'default-trigger',
 };

package/context/context.d.ts

@@ -1,9 +1,10 @@
-import { _Resources } from "./resources/impl/resources";
-import { Tasks } from "./tasks/tasks";
-import { Message } from "./msg/msg";
-import { IDBGetter } from "./db/db";
+import { _Resources } from './resources/impl/resources';
+import { Tasks } from './tasks/tasks';
+import { Message } from './msg/msg';
+import { IDBGetter } from './db/db';
 import { Context as CommonContext } from '@byted-apaas/server-common-node';
-import { IMetaData } from "./metadata/metadata";
+import { IMetaData } from './metadata/metadata';
+import { _IIntegration } from './integration/IIntegration';
 export declare class Context<T, mt, cf, gv> extends CommonContext implements IContext<T, mt, cf, gv> {
     /**
      * 操作数据库中的记录数据
@@ -37,38 +38,7 @@ export declare class Context<T, mt, cf, gv> extends CommonContext implements ICo
      * @param apiName 全局变量的 API Name
      */
     getVar<Key extends keyof gv>(apiName: Key): Promise<gv[Key]>;
+    integration: _IIntegration;
 }
-export interface IContext<T, mt = {}, cf = "", gv = {}> {
-    /**
-     * 操作数据库中的记录数据
-     */
-    db: IDBGetter<T, mt>;
-    /**
-     * 元数据读写
-     */
-    metadata: IMetaData<mt>;
-    /**
-     * 静态资源类操作
-     */
-    resources: _Resources;
-    /**
-     * 全局函数
-     * @param funcName 函数名
-     */
-    function(funcName: cf): {
-        invoke: (params: any) => Promise<any>;
-    };
-    /**
-     * 任务操作
-     */
-    tasks: Tasks<cf>;
-    /**
-     * 向消息中心推送及更新消息
-     */
-    msg: Message;
-    /**
-     * 根据 apiName 获取对应的全局变量
-     * @param apiName 全局变量的 API Name
-     */
-    getVar<Key extends keyof gv>(apiName: Key): Promise<gv[Key]>;
+export interface IContext<T, mt, cf, gv> {
 }

package/context/context.js

@@ -4,12 +4,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = void 0;
 const server_common_node_1 = require("@byted-apaas/server-common-node");
-// TODO MERGE cf
 class Context extends server_common_node_1.Context {
     /**
      * 全局函数
      * @param funcName 函数名
      */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     function(funcName) {
         return null;
     }
@@ -17,9 +17,9 @@ class Context extends server_common_node_1.Context {
      * 根据 apiName 获取对应的全局变量
      * @param apiName 全局变量的 API Name
      */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async getVar(apiName) {
         return null;
     }
-    ;
 }
 exports.Context = Context;

package/context/db/db.d.ts

@@ -1,12 +1,8 @@
-import { currentObjApiName } from '../../data';
 import { _IKAllEndpoint, _IKSyncEndpoint, _IKQuery } from './impl/IObject';
 import { ITransactionGetter } from './impl/transaction';
 import { IOql } from './impl/oql/ioql';
 /**
- * - IDBGetter 是声明 DB interface 的顶级入口，在使用时应该避免直接使用 IDB 和 IDBWithCurrentObject
- * 应该直接使用 IDBGetter。
- * - 目前 IDBGetter 支持的是 currentObject 方法的动态声明，使用泛型实现，期望传入的 T 是 Context 结构。
- * - 如果 Context 有 objectApiName 属性，则拥有 .db.currentObject 和 .db.transaction.currentObject
+ * IDBGetter 是声明 DB interface 的顶级入口
  */
 export type IDBGetter<T, mt> = T extends {
     'objectApiName': string;
@@ -20,8 +16,8 @@ export interface IDB<T, mt> {
      * @param objectApiName 指定对象的 ApiName
      * @example
      * ```
-     * context.db.object("_user").where({
-     *     gender: "male"
+     * application.data.object('_user').where({
+     *     gender: 'male'
      * }).find()
      * ```
      */
@@ -30,12 +26,12 @@ export interface IDB<T, mt> {
      * 创建一个新的空事务
      * @example
      * ```
-     * let tx = context.db.newTransaction();
-     * let user = tx.object("_user").registerCreate({
-     *     _name: new kunlun.type.Multilingual({ zh: "用户1", en: "user1" }),
+     * let tx = application.data.newTransaction();
+     * let user = tx.object('_user').registerCreate({
+     *     _name: new application.constants.type.Multilingual({ zh: '用户1', en: 'user1' }),
      * });
-     * let contract = tx.object("contract").registerCreate({
-     *     _name: new kunlun.type.Multilingual({ zh: "用户1的合同", en: "user1's contract" }),
+     * let contract = tx.object('contract').registerCreate({
+     *     _name: new application.constants.type.Multilingual({ zh: '用户1的合同', en: 'user1's contract' }),
      *     user: {id: user._id}
      * });
      * await tx.commit();
@@ -47,7 +43,7 @@ export interface IDB<T, mt> {
      * @param oql OQL 语句
      * @example
      * ```
-     * let users = await context.db.oql("select _email from _user").execute();
+     * let users = await application.data.oql('select _email from _user').execute();
      * ```
      */
     oql(oql: string): IOql;
@@ -57,8 +53,8 @@ export interface IDB<T, mt> {
      * @param nameArgs 用于替换 OQL 语句中的占位符
      * @example
      * ```
-     * let employees = await context.db.oql("select _email from _user where _type = $user_type",{
-     *     "user_type": "_employee",
+     * let employees = await application.data.oql('select _email from _user where _type = $user_type',{
+     *     'user_type': '_employee',
      * }).execute();
      * ```
      */
@@ -68,10 +64,6 @@ export interface IDB<T, mt> {
  * IDBWithCurrentObject 经由 IDBGetter 返回，是 DB 的动态增加的接口结构
  */
 export interface IDBWithCurrentObject<T, mt> {
-    /**
-     * 无需入参，操作当前对象的记录数据
-     */
-    currentObject(): _IKAllEndpoint<mt[currentObjApiName]> & _IKQuery<mt[currentObjApiName]>;
 }
 /**
  * IDBSync 仅包含同步调用接口，当前应用场景为 OpenSDK