kb-server 0.0.1-beta.1 → 0.0.1-beta.2

package/README.md

@@ -2,4 +2,4 @@
 
 快速创建一个 Node 服务
 
-快速创建API、标准错误码、Server
+快速创建API、标准错误码、Server、支持统一鉴权函数（API级别）

package/dist/common/api-middleware.d.ts

@@ -1,5 +1,8 @@
 import express from "express";
-import { AnyAPIExecution } from "./create-api";
+import { APIs } from "./create-api";
+/**
+ * 正确响应
+ */
 export interface APIResponse {
     Response: {
         Data: {
@@ -8,6 +11,9 @@ export interface APIResponse {
         RequestId: string;
     };
 }
+/**
+ * 错误响应
+ */
 export interface APIErrorResponse {
     Response: {
         Error: {
@@ -17,9 +23,14 @@ export interface APIErrorResponse {
         RequestId: string;
     };
 }
+export type AuthFunction = (action: string, req: express.Request) => Promise<Record<string, any> | false>;
+interface IPackAPIOptions {
+    authFn?: AuthFunction;
+}
 /**
  * API包装函数
  * @param apis API列表
  * @returns
  */
-export declare const packAPI: (apis: Record<string, AnyAPIExecution>) => (req: express.Request, res: express.Response) => Promise<express.Response<any, Record<string, any>>>;
+export declare const packAPI: (apis: APIs, options?: IPackAPIOptions) => (req: express.Request, res: express.Response) => Promise<express.Response<any, Record<string, any>>>;
+export {};

package/dist/common/api-middleware.js

@@ -8,7 +8,8 @@ const uuid_1 = require("uuid");
  * @param apis API列表
  * @returns
  */
-const packAPI = (apis) => {
+const packAPI = (apis, options) => {
+    const { authFn } = options || {};
     return async (req, res) => {
         // 生成API映射
         const apiMap = new Map(Object.entries(apis).map(([action, execution]) => [action, execution]));
@@ -22,13 +23,24 @@ const packAPI = (apis) => {
             RequestId: requestId,
         };
         try {
-            console.log(req.body);
             // API 解析
             const { Action, ...params } = req.body || {};
             // 接口未定义
             if (!Action) {
                 throw new create_errors_1.CommonErrors.InvalidParameter.EmptyAPIRequest();
             }
+            // 处理鉴权函数
+            if (authFn !== null && authFn !== undefined) {
+                if (typeof authFn !== "function") {
+                    throw new create_errors_1.CommonErrors.ResourceNotFound.AuthFunctionNotFound();
+                }
+                const authResult = await authFn(Action, req);
+                if (!authResult) {
+                    throw new create_errors_1.CommonErrors.FailOperation.NoPermission();
+                }
+                // 把权限信息写入上下文
+                ctx.AuthInfo = authResult || {};
+            }
             // API 处理
             const execution = apiMap.get(Action);
             if (typeof execution !== "function") {

package/dist/common/create-api.d.ts

@@ -2,12 +2,13 @@ import { Class } from "utility-types";
 export interface ServerContext {
     /** 被调用方的 RequestId */
     RequestId: string;
-    /** 用户ID */
-    UserId?: number;
+    /** 权限信息 */
+    AuthInfo?: Record<string, any>;
 }
 export type API<P, R> = (param: P) => Promise<R>;
 export type APIExecution<P, R> = (params: P, ctx: ServerContext) => Promise<R>;
 export type AnyAPIExecution = APIExecution<any, any>;
+export type APIs = Record<string, AnyAPIExecution>;
 export declare function createAPI<P, R>(ParamsClass: Class<P>, execution: APIExecution<P, R>): API<P, R>;
 type StubParam<T> = T extends (params: infer P) => any ? P : never;
 export declare function implementAPI<A extends (params: any) => any>(_actionStub: A, ParamsClass: Class<StubParam<A>>, execution: APIExecution<StubParam<A>, ReturnType<A>>): API<StubParam<A>, ReturnType<A>>;

package/dist/common/create-errors.d.ts

@@ -24,6 +24,7 @@ declare const CommonErrorsMap: {
     };
     readonly ResourceNotFound: {
         readonly APINotFound: "不存在的API";
+        readonly AuthFunctionNotFound: "鉴权函数不存在";
     };
     readonly FailOperation: {
         readonly NoPermission: "无权操作";
@@ -79,6 +80,7 @@ declare function createErrorsClasses<T extends MessageMap = MessageMap>(messageM
     };
     readonly ResourceNotFound: {
         readonly APINotFound: "不存在的API";
+        readonly AuthFunctionNotFound: "鉴权函数不存在";
     };
     readonly FailOperation: {
         readonly NoPermission: "无权操作";
@@ -103,6 +105,7 @@ export declare const CommonErrors: ErrorClasses<MergeMessageMap<{
     };
     readonly ResourceNotFound: {
         readonly APINotFound: "不存在的API";
+        readonly AuthFunctionNotFound: "鉴权函数不存在";
     };
     readonly FailOperation: {
         readonly NoPermission: "无权操作";

package/dist/common/create-errors.js

@@ -26,6 +26,7 @@ const CommonErrorsMap = {
     },
     ResourceNotFound: {
         APINotFound: "不存在的API",
+        AuthFunctionNotFound: "鉴权函数不存在",
     },
     FailOperation: {
         NoPermission: "无权操作",

package/dist/common/create-server.d.ts

@@ -1,6 +1,8 @@
-import { AnyAPIExecution } from "./create-api";
+import { AuthFunction } from "./api-middleware";
+import { APIs } from "./create-api";
 export interface ICreateServerParams {
-    apis: Record<string, AnyAPIExecution>;
+    apis: APIs;
+    authFn?: AuthFunction;
 }
 export interface ICreateServerOptions {
     limit?: string | number | undefined;

package/dist/common/create-server.js

@@ -30,14 +30,14 @@ const api_middleware_1 = require("./api-middleware");
  * 创建 Server
  */
 function createServer(params, options) {
-    const { apis } = params || {};
+    const { apis, authFn } = params || {};
     const { limit = "10mb" } = options || {};
     const app = (0, express_1.default)();
     // POST 参数获取
     app.use((0, express_1.urlencoded)({ extended: true, limit }));
     app.use((0, express_1.json)({ limit }));
     // 注入API
-    app.use((0, api_middleware_1.packAPI)(apis));
+    app.use((0, api_middleware_1.packAPI)(apis, { authFn }));
     return app;
 }
 exports.createServer = createServer;

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { createServer } from "./common/create-server";
-export { createErrors, CommonErrors } from "./common/create-errors";
+export { createErrors } from "./common/create-errors";
 export { implementAPI } from "./common/create-api";

package/dist/index.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.implementAPI = exports.CommonErrors = exports.createErrors = exports.createServer = void 0;
+exports.implementAPI = exports.createErrors = exports.createServer = void 0;
 var create_server_1 = require("./common/create-server");
 Object.defineProperty(exports, "createServer", { enumerable: true, get: function () { return create_server_1.createServer; } });
 var create_errors_1 = require("./common/create-errors");
 Object.defineProperty(exports, "createErrors", { enumerable: true, get: function () { return create_errors_1.createErrors; } });
-Object.defineProperty(exports, "CommonErrors", { enumerable: true, get: function () { return create_errors_1.CommonErrors; } });
 var create_api_1 = require("./common/create-api");
 Object.defineProperty(exports, "implementAPI", { enumerable: true, get: function () { return create_api_1.implementAPI; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kb-server",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.2",
   "description": "A fast server for Node.JS,made by express.",
   "main": "dist/index.js",
   "scripts": {