@byted-apaas/server-sdk-node 1.1.23 → 1.1.24

package/application/application.d.ts

@@ -0,0 +1,33 @@
+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:     元数据相关能力
+ *   - resource: 资源相关能力
+ *   - tools:    工具相关能力
+ */
+export interface IApplication {
+    data: IDBSync;
+    resources: _IOpenSDKResources;
+    tools: ITool & IToolsExtra;
+    integration: _IIntegration;
+    cloudfunction(funcName: string): IFunction;
+    env(platformEnvType: PlatformEnvType): IApplication;
+    localDebugMode(): IApplication;
+    setLaneName(laneName: string): IApplication;
+}
+export type AppMode = 'openSDK' | 'faasSDK';
+export type DataVersion = 'v1' | 'v2' | 'v3';
+export interface AppCtx {
+    mode?: AppMode;
+    env?: PlatformEnvType;
+    credential?: AppCredential;
+    debugType?: '0' | '2';
+    x_tt_env?: string;
+    dataVersion?: DataVersion;
+}

package/application/application.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/application/function/function.d.ts

@@ -0,0 +1,14 @@
+import { AppCtx } from '../application';
+export interface IFunction {
+    /**
+     * 调用函数
+     * @param params 函数入参
+     */
+    invoke(params: Record<string, any>): Promise<any>;
+}
+export declare class Function implements IFunction {
+    appCtx: AppCtx;
+    apiName: string;
+    constructor(appCtx: AppCtx, apiName: string);
+    invoke(params: Record<string, any>): Promise<any>;
+}

package/application/function/function.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Function = void 0;
+const interface_1 = require("../../request/interface");
+const common_1 = require("../impl/common");
+class Function {
+    constructor(appCtx, apiName) {
+        this.appCtx = appCtx;
+        this.apiName = apiName;
+    }
+    async invoke(params) {
+        return await (0, common_1.runCtxForOpenSDK)(this.appCtx, async () => {
+            return await (0, interface_1.GetInstance)().invokeFuncWithAuth({
+                APIName: this.apiName,
+                isInvokeByAPIName: true
+            }, params);
+        });
+    }
+}
+exports.Function = Function;

package/application/impl/common.d.ts

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

package/application/impl/common.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+// 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.credential) {
+            throw new exceptions_1.InvalidParamError(`credential is empty for openSDK`);
+        }
+        return nodeClsCtx.getReqCtx().run(async () => {
+            utils.setModeForOpenSDK(appCtx.mode);
+            utils.setCredential(appCtx.credential);
+            utils.setDebugType(appCtx.debugType);
+            switch (appCtx.env) {
+                // @ts-ignore
+                case 'developmentboe':
+                    utils.setEnv('development');
+                    utils.setBoe('boe');
+                    break;
+                // @ts-ignore
+                case 'stagingboe':
+                    utils.setEnv('staging');
+                    utils.setBoe('boe');
+                    break;
+                case 'staging':
+                    utils.setEnv('staging');
+                    break;
+                case 'gray':
+                    utils.setEnv('gray');
+                    break;
+                case 'online':
+                    utils.setEnv('online');
+                    break;
+                default:
+                    throw new exceptions_1.InvalidParamError(`platformEnvType is invalid for ${appCtx.env}`);
+            }
+            utils.setInvokeFuncName('openSDK');
+            utils.setTenant(await appCtx.credential.getTenantInfo());
+            utils.setXTTEnvOnlyDebug(appCtx.x_tt_env);
+            if (!utils.getLogID()) {
+                utils.setLogID(crypto.randomBytes(16).toString('hex'));
+            }
+            return await promise();
+        });
+    }
+    return await promise();
+}
+exports.runCtxForOpenSDK = runCtxForOpenSDK;

package/application/impl/impl.d.ts

@@ -0,0 +1,19 @@
+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;
+    localDebugMode(): IApplication;
+    setLaneName(laneName: string): IApplication;
+}

package/application/impl/impl.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Application = void 0;
+const credential_1 = require("@byted-apaas/server-common-node/credential/credential");
+const db_1 = require("../../context/db/impl/db");
+const tool_1 = require("@byted-apaas/server-common-node/kunlun/tool/impl/tool");
+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',
+            credential: new credential_1.AppCredential(clientID, clientSecret),
+            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);
+        };
+    }
+    cloudfunction(funcName) {
+        return new function_1.Function(this.appCtx, funcName);
+    }
+    env(platformEnvType) {
+        this.appCtx.env = platformEnvType;
+        return this;
+    }
+    // 设置本地调试模式
+    localDebugMode() {
+        this.appCtx.debugType = '2';
+        return this;
+    }
+    setLaneName(laneName) {
+        this.appCtx.x_tt_env = laneName;
+        return this;
+    }
+}
+exports.Application = Application;

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 | string;
+    errors?: BatchResultDataError[];
+}
+export interface BatchResultDataError {
+    code: string;
+}
+export declare function NewBatchResult(recordIDs: number[] | string[], errMap: Record<number | string, 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.d.ts

@@ -0,0 +1,13 @@
+export declare const notifyModel: {
+    key: string;
+};
+export declare const httpHeaderKeys: {
+    statusCode: string;
+    location: string;
+};
+export declare const httpStatusCodes: {
+    redirect: number;
+};
+export declare const triggerType: {
+    defaultTrigger: string;
+};

package/constants/constants.js

@@ -0,0 +1,18 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.triggerType = exports.httpStatusCodes = exports.httpHeaderKeys = exports.notifyModel = void 0;
+exports.notifyModel = {
+    key: 'ee.kunlun.cloudfunction.faas_buildin',
+};
+exports.httpHeaderKeys = {
+    statusCode: 'X-Kunlun-Status-Code',
+    location: 'Location',
+};
+exports.httpStatusCodes = {
+    redirect: 302,
+};
+exports.triggerType = {
+    defaultTrigger: 'default-trigger',
+};

package/context/context.d.ts

@@ -0,0 +1,44 @@
+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 { _IIntegration } from './integration/IIntegration';
+export declare class Context<T, mt, cf, gv> extends CommonContext implements 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]>;
+    integration: _IIntegration;
+}
+export interface IContext<T, mt, cf, gv> {
+}

package/context/context.js

@@ -0,0 +1,25 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Context = void 0;
+const server_common_node_1 = require("@byted-apaas/server-common-node");
+class Context extends server_common_node_1.Context {
+    /**
+     * 全局函数
+     * @param funcName 函数名
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    function(funcName) {
+        return null;
+    }
+    /**
+     * 根据 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

@@ -0,0 +1,110 @@
+import { _IKAllEndpoint, _IKSyncEndpoint, _IKQuery } from './impl/IObject';
+import { ITransactionGetter } from './impl/transaction';
+import { IOql } from './impl/oql/ioql';
+import { _IKAllEndpointV3, _IKQueryV3 } from './impl/IObjectV3';
+/**
+ * IDBGetter 是声明 DB interface 的顶级入口
+ */
+export type IDBGetter<T, mt> = T extends {
+    'objectApiName': string;
+} ? IDB<T, mt> & IDBWithCurrentObject<{}, mt> : IDB<{}, mt>;
+/**
+ * IDB 经由 IDBGetter 返回，是 DB 的基础接口结构
+ */
+export interface IDB<T, mt> {
+    /**
+     * 操作指定对象的记录数据
+     * @param objectApiName 指定对象的 ApiName
+     * @example
+     * ```
+     * application.data.object('_user').where({
+     *     gender: 'male'
+     * }).find()
+     * ```
+     */
+    object<T extends keyof mt>(objectApiName: T): _IKAllEndpoint<mt[T]> & _IKQuery<mt[T]>;
+    /**
+     * 创建一个新的空事务
+     * @example
+     * ```
+     * 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 application.constants.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 application.data.oql('select _email from _user').execute();
+     * ```
+     */
+    oql(oql: string): IOql;
+    /**
+     * OQL 操作
+     * @param oql OQL 语句
+     * @param nameArgs 用于替换 OQL 语句中的占位符
+     * @example
+     * ```
+     * let employees = await application.data.oql('select _email from _user where _type = $user_type',{
+     *     'user_type': '_employee',
+     * }).execute();
+     * ```
+     */
+    oql(oql: string, nameArgs: Record<string, any>): IOql;
+}
+/**
+ * IDB3 经由 IDBGetter 返回，是 DBV3 的基础接口结构
+ */
+export interface IDBV3<T, mt> {
+    /**
+     * 操作指定对象的记录数据
+     * @param objectApiName 指定对象的 ApiName
+     * @example
+     * ```
+     * application.data.object('_user').where({
+     *     gender: 'male'
+     * }).find()
+     * ```
+     */
+    object: <T extends keyof mt>(objectApiName: T) => _IKAllEndpointV3<mt[T]> & _IKQueryV3<mt[T]>;
+    /**
+     * 创建一个新的空事务
+     * @example
+     * ```
+     * 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 application.constants.type.Multilingual({ zh: '用户1的合同', en: 'user1's contract' }),
+     *     user: {id: user._id}
+     * });
+     * await tx.commit();
+     * ```
+     */
+    newTransaction(): ITransactionGetter<T, mt>;
+}
+/**
+ * IDBWithCurrentObject 经由 IDBGetter 返回，是 DB 的动态增加的接口结构
+ */
+export interface IDBWithCurrentObject<T, mt> {
+}
+/**
+ * IDBSync 仅包含同步调用接口，当前应用场景为 OpenSDK
+ */
+export interface IDBSync<mt = Record<string, never>> {
+    /**
+     * 操作指定对象的记录数据
+     * @param objectApiName 指定对象的 ApiName
+     */
+    object(objectApiName: string): _IKSyncEndpoint<mt> & _IKQuery<mt>;
+}

package/context/db/db.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });