@byted-apaas/server-sdk-node 0.0.1-beta.3

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2022 byted-apaas authors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/NOTICE

@@ -0,0 +1,3 @@
+Authors:
+
+ByteDance Ltd. and/or its affiliates

package/README.md

@@ -0,0 +1 @@
+## aPaaS Server SDK 版本说明：

package/application/application.d.ts

@@ -0,0 +1,27 @@
+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";
+/**
+ * IApplication 为 OpenSDK 能力的核心接口
+ *   - data:     元数据相关能力
+ *   - resource: 资源相关能力
+ *   - tools:    工具相关能力
+ */
+export interface IApplication {
+    data: IDBSync;
+    resources: _IOpenSDKResources;
+    tools: ITool & IToolsExtra;
+    cloudfunction(funcName: string): IFunction;
+    env(platformEnvType: PlatformEnvType): IApplication;
+    localDebugMode(): IApplication;
+}
+export declare type AppMode = 'openSDK' | 'faasSDK';
+export interface AppCtx {
+    mode: AppMode;
+    env?: PlatformEnvType;
+    credential: AppCredential;
+    debugType?: "0" | "2";
+}

package/application/application.js

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

package/application/application.ts

@@ -0,0 +1,40 @@
+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";
+
+/**
+ * IApplication 为 OpenSDK 能力的核心接口
+ *   - data:     元数据相关能力
+ *   - resource: 资源相关能力
+ *   - tools:    工具相关能力
+ */
+export interface IApplication {
+    // data 相关能力
+    data: IDBSync;
+    // resource 相关能力
+    resources: _IOpenSDKResources;
+    // tools 相关能力
+    tools: ITool & IToolsExtra;
+
+    // 调用云函数能力
+    cloudfunction(funcName: string): IFunction;
+
+    // 设置平台环境类型
+    env(platformEnvType: PlatformEnvType): IApplication;
+
+    // 设置本地调试模式
+    localDebugMode(): IApplication;
+}
+
+export type AppMode = 'openSDK' | 'faasSDK';
+
+export interface AppCtx {
+    mode: AppMode
+    env?: PlatformEnvType
+    credential: AppCredential
+    debugType?: "0" | "2"
+}
+

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,21 @@
+"use strict";
+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;
+        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/function/function.ts

@@ -0,0 +1,37 @@
+import {AppCtx} from "../application";
+
+import {GetInstance} from "../../request/interface"
+import * as nodeClsCtx from "@byted-apaas/server-common-node/utils/nodeClsCtx";
+import * as utils from "@byted-apaas/server-common-node/utils/utils";
+import {InvalidParamError} from "@byted-apaas/server-common-node/utils/exceptions";
+import {setModeForOpenSDK} from "@byted-apaas/server-common-node/utils/utils";
+import {runCtxForOpenSDK} from "../impl/common";
+
+const crypto = require("crypto")
+
+export interface IFunction {
+    /**
+     * 调用函数
+     * @param params 函数入参
+     */
+    invoke(params: Record<string, any>): Promise<any>;
+}
+
+export class Function implements IFunction {
+    appCtx: AppCtx
+    apiName: string
+
+    constructor(appCtx: AppCtx, apiName: string) {
+        this.appCtx = appCtx
+        this.apiName = apiName;
+    }
+
+    async invoke(params: Record<string, any>): Promise<any> {
+        return await runCtxForOpenSDK(this.appCtx, async () => {
+            return await GetInstance().invokeFuncWithAuth({
+                APIName: this.apiName,
+                isInvokeByAPIName: true
+            }, params);
+        });
+    }
+}

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,50 @@
+"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");
+const crypto = require("crypto");
+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());
+            if (!utils.getLogID()) {
+                utils.setLogID(crypto.randomBytes(16).toString('hex'));
+            }
+            return await promise();
+        });
+    }
+    return await promise();
+}
+exports.runCtxForOpenSDK = runCtxForOpenSDK;

package/application/impl/common.ts

@@ -0,0 +1,50 @@
+import {AppCtx} from "../application";
+import * as utils from "@byted-apaas/server-common-node/utils/utils";
+import * as nodeClsCtx from "@byted-apaas/server-common-node/utils/nodeClsCtx";
+import {InvalidParamError} from "@byted-apaas/server-common-node/utils/exceptions";
+
+const crypto = require("crypto");
+
+export async function runCtxForOpenSDK(appCtx: AppCtx, promise: Function): Promise<any> {
+    if (appCtx && appCtx.mode === "openSDK") {
+        if (!appCtx.credential) {
+            throw new 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 InvalidParamError(`platformEnvType is invalid for ${appCtx.env}`);
+                }
+                utils.setInvokeFuncName("openSDK");
+                utils.setTenant(await appCtx.credential.getTenantInfo());
+                if (!utils.getLogID()) {
+                    utils.setLogID(crypto.randomBytes(16).toString('hex'));
+                }
+                return await promise();
+            }
+        )
+    }
+    return await promise();
+}

package/application/impl/impl.d.ts

@@ -0,0 +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";
+export declare class Application implements IApplication {
+    private appCtx;
+    data: IDBSync;
+    resources: _IOpenSDKResources;
+    tools: ITool & IToolsExtra;
+    constructor(clientID: string, clientSecret: string);
+    cloudfunction(funcName: string): IFunction;
+    env(platformEnvType: PlatformEnvType): IApplication;
+    localDebugMode(): IApplication;
+}

package/application/impl/impl.js

@@ -0,0 +1,38 @@
+"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");
+class Application {
+    constructor(clientID, clientSecret) {
+        this.appCtx = {
+            mode: "openSDK",
+            credential: new credential_1.AppCredential(clientID, clientSecret),
+            debugType: "0",
+            env: "online"
+        };
+        this.data = new db_1.ApplicationDB(this.appCtx);
+        this.resources = new resources_1._OpenSDKResources(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;
+    }
+}
+exports.Application = Application;

package/application/impl/impl.ts

@@ -0,0 +1,48 @@
+import {ITool, IToolsExtra} from "@byted-apaas/server-common-node/kunlun/tool/Itool";
+import {AppCredential} from "@byted-apaas/server-common-node/credential/credential";
+import {ApplicationDB} from "../../context/db/impl/db";
+import {Tool} from "@byted-apaas/server-common-node/kunlun/tool/impl/tool";
+import {Function, IFunction} from "../function/function";
+import {AppCtx, IApplication} from "../application";
+import {getTenantInfo} from "../../request/common";
+import {_IOpenSDKResources} from "../../context/resources/IResources";
+import {IDBSync} from "../../context/db/db";
+import {_OpenSDKResources} from "../../context/resources/impl/resources";
+import {PlatformEnvType} from "@byted-apaas/server-common-node/constants/constants";
+
+export class Application implements IApplication {
+    private appCtx: AppCtx;
+    data: IDBSync;
+    resources: _IOpenSDKResources;
+    tools: ITool & IToolsExtra;
+
+    constructor(clientID: string, clientSecret: string) {
+        this.appCtx = {
+            mode: "openSDK",
+            credential: new AppCredential(clientID, clientSecret),
+            debugType: "0",
+            env: "online"
+        }
+        this.data = new ApplicationDB(this.appCtx);
+        this.resources = new _OpenSDKResources(this.appCtx);
+        this.tools = new Tool();
+        this.tools.getTenantInfo = async () => {
+            return await getTenantInfo(this.appCtx);
+        }
+    }
+
+    cloudfunction(funcName: string): IFunction {
+        return new Function(this.appCtx, funcName);
+    }
+
+    env(platformEnvType: PlatformEnvType): IApplication {
+        this.appCtx.env = platformEnvType;
+        return this;
+    }
+
+    // 设置本地调试模式
+    localDebugMode(): IApplication {
+        this.appCtx.debugType = "2";
+        return this;
+    }
+}

package/constants/constants.d.ts

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

package/constants/constants.js

@@ -0,0 +1,15 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+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,
+};

package/constants/constants.ts

@@ -0,0 +1,15 @@
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+
+export const notifyModel = {
+    key: "ee.kunlun.cloudfunction.faas_buildin",
+}
+
+export const httpHeaderKeys = {
+    statusCode: "X-Kunlun-Status-Code",
+    location: "Location",
+}
+
+export const httpStatusCodes = {
+    redirect: 302,
+}

package/context/context.d.ts

@@ -0,0 +1,74 @@
+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";
+export declare class Context<T, mt, cf, gv> extends CommonContext<T> 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]>;
+}
+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]>;
+}

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");
+// TODO MERGE cf
+class Context extends server_common_node_1.Context {
+    /**
+     * 全局函数
+     * @param funcName 函数名
+     */
+    function(funcName) {
+        return null;
+    }
+    /**
+     * 根据 apiName 获取对应的全局变量
+     * @param apiName 全局变量的 API Name
+     */
+    async getVar(apiName) {
+        return null;
+    }
+    ;
+}
+exports.Context = Context;

package/context/context.ts

@@ -0,0 +1,130 @@
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+
+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";
+// TODO MERGE cf
+
+export class Context<T, mt, cf, gv> extends CommonContext<T> 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>; } {
+        return null;
+    }
+
+    /**
+     * 任务操作
+     */
+    tasks: Tasks<cf>;
+    /**
+     * 向消息中心推送及更新消息
+     */
+    msg: Message;
+
+    /**
+     * 根据 apiName 获取对应的全局变量
+     * @param apiName 全局变量的 API Name
+     */
+    async getVar<Key extends keyof gv>(apiName: Key): Promise<gv[Key]> {
+        return null;
+    };
+
+    // /**
+    //  * 微服务
+    //  * @param apiName 微服务的名称
+    //  */
+    // microservice(apiName: string): {
+    //     /**
+    //      * 同步调用微服务
+    //      * @param path 请求路径，如：/ping
+    //      * @param method 请求方法，默认为 GET
+    //      * @param params 请求参数，默认为 undefined
+    //      */
+    //     invoke: (path: string, method?: string, params?: any) => Promise<any>;
+    //     /**
+    //      * 异步调用微服务
+    //      * @param path 请求路径，如：/ping
+    //      * @param method 请求方法，默认为 GET
+    //      * @param params 请求参数，默认为 undefined
+    //      */
+    //     invokeAsync: (path: string, method?: string, params?: any) => Promise<any>;
+    // } {
+    //     return undefined;
+    // };
+}
+
+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]>;
+
+    // /**
+    //  * 微服务
+    //  * @param apiName 微服务的名称
+    //  */
+    // microservice(apiName: string): {
+    //     /**
+    //      * 同步调用微服务
+    //      * @param path 请求路径，如：/ping
+    //      * @param method 请求方法，默认为 GET
+    //      * @param params 请求参数，默认为 undefined
+    //      */
+    //     invoke: (path: string, method?: string, params?: any) => Promise<any>;
+    //     /**
+    //      * 异步调用微服务
+    //      * @param path 请求路径，如：/ping
+    //      * @param method 请求方法，默认为 GET
+    //      * @param params 请求参数，默认为 undefined
+    //      */
+    //     invokeAsync: (path: string, method?: string, params?: any) => Promise<any>;
+    // };
+}