@open-norantec/herbal 1.0.2-alpha.15 → 1.0.2-alpha.17

package/dist/core.d.ts

@@ -3,7 +3,7 @@ import { HeaderUtil } from '@open-norantec/utilities/dist/header-util.class';
 import { z } from 'zod';
 import { Request } from './types/request.type';
 export * from '@nestjs/core';
-export interface MethodContext<IS extends z.Schema<any>> {
+interface LegacyMethodContext<IS extends z.Schema<any>> {
     headers: ReturnType<typeof HeaderUtil.parse>;
     input: z.infer<IS>;
     request: Request;
@@ -13,6 +13,7 @@ export type MethodHandler<IS extends z.Schema<any>, OS extends z.Schema<any>> =
     response: z.infer<OS>;
 }>;
 export declare class HerbalController {
-    protected registerMethod: <IS extends z.ZodType<any, z.ZodTypeDef, any>, OS extends z.ZodType<any, z.ZodTypeDef, any>>(inputSchema: IS, outputSchema: OS, callback: (context: MethodContext<IS>) => Promise<z.TypeOf<OS>>) => MethodHandler<IS, OS>;
-    private handler;
+    protected registerMethod: <IS extends z.ZodType<any, z.ZodTypeDef, any>, OS extends z.ZodType<any, z.ZodTypeDef, any>>(inputSchema: IS, outputSchema: OS, callback: (context: LegacyMethodContext<IS>) => Promise<z.TypeOf<OS>>) => MethodHandler<IS, OS>;
+    private $handleRequest;
+    private $call;
 }

package/dist/core.js

@@ -69,6 +69,8 @@ var header_util_class_1 = require("@open-norantec/utilities/dist/header-util.cla
 var zod_1 = require("zod");
 var _ = require("lodash");
 var string_util_class_1 = require("@open-norantec/utilities/dist/string-util.class");
+var decorators_1 = require("./decorators");
+var utilities_1 = require("@open-norantec/utilities");
 __exportStar(require("@nestjs/core"), exports);
 var HerbalController = exports.HerbalController = (function () {
     function HerbalController() {
@@ -101,54 +103,71 @@ var HerbalController = exports.HerbalController = (function () {
             }); };
         };
     }
-    HerbalController.prototype.handler = function (request) {
-        var _a, _b, _c, _d, _e, _f;
+    HerbalController.prototype.$handleRequest = function (request) {
+        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function () {
-            var methodHandler, parsedBody, result, _g, _h, error_1;
-            var _j;
-            return __generator(this, function (_k) {
-                switch (_k.label) {
+            var result, error_1;
+            var _e;
+            var _this = this;
+            return __generator(this, function (_f) {
+                switch (_f.label) {
                     case 0:
-                        methodHandler = this[request === null || request === void 0 ? void 0 : request.methodName];
-                        parsedBody = _.attempt(function () { return JSON.parse((request === null || request === void 0 ? void 0 : request.rawBody) || ''); });
-                        _k.label = 1;
+                        _f.trys.push([0, 3, , 5]);
+                        _e = {};
+                        return [4, this.$call(request.methodName, {
+                                authenticateResult: request.authenticateResult,
+                                headers: header_util_class_1.HeaderUtil.parse((_a = request.headers) !== null && _a !== void 0 ? _a : {}),
+                                methodName: request.methodName,
+                                rawBody: request.rawBody,
+                                traceId: request.traceId,
+                                transaction: request.transaction,
+                                url: request.originalUrl,
+                                getProvider: function (token) { return request.moduleRef.get(token, { strict: false }); },
+                            })];
                     case 1:
-                        _k.trys.push([1, 12, , 13]);
-                        if (!(typeof methodHandler === 'function')) return [3, 7];
-                        _j = {};
-                        return [4, methodHandler(request, parsedBody instanceof Error ? undefined : parsedBody, header_util_class_1.HeaderUtil.parse((_a = request.headers) !== null && _a !== void 0 ? _a : {})).then(function (response) { return response === null || response === void 0 ? void 0 : response.response; })];
-                    case 2:
-                        result = (_j.data = _k.sent(),
-                            _j.token = string_util_class_1.StringUtil.isFalsyString((_b = request === null || request === void 0 ? void 0 : request.authenticateResult) === null || _b === void 0 ? void 0 : _b.nextToken)
+                        result = (_e.data = _f.sent(),
+                            _e.token = string_util_class_1.StringUtil.isFalsyString((_b = request === null || request === void 0 ? void 0 : request.authenticateResult) === null || _b === void 0 ? void 0 : _b.nextToken)
                                 ? null
                                 : request.authenticateResult.nextToken,
-                            _j);
-                        _k.label = 3;
-                    case 3:
-                        _k.trys.push([3, 5, , 6]);
+                            _e);
                         return [4, ((_d = (_c = request === null || request === void 0 ? void 0 : request.transaction) === null || _c === void 0 ? void 0 : _c.commit) === null || _d === void 0 ? void 0 : _d.call(_c))];
+                    case 2:
+                        _f.sent();
+                        return [2, result];
+                    case 3:
+                        error_1 = _f.sent();
+                        return [4, utilities_1.AttemptUtil.execPromise((function () { return __awaiter(_this, void 0, void 0, function () {
+                                var _a, _b;
+                                return __generator(this, function (_c) {
+                                    switch (_c.label) {
+                                        case 0: return [4, ((_b = (_a = request === null || request === void 0 ? void 0 : request.transaction) === null || _a === void 0 ? void 0 : _a.rollback) === null || _b === void 0 ? void 0 : _b.call(_a))];
+                                        case 1:
+                                            _c.sent();
+                                            return [2];
+                                    }
+                                });
+                            }); })())];
                     case 4:
-                        _k.sent();
-                        return [3, 6];
-                    case 5:
-                        _g = _k.sent();
-                        return [3, 6];
-                    case 6: return [2, result];
-                    case 7:
-                        _k.trys.push([7, 9, , 10]);
-                        return [4, ((_f = (_e = request === null || request === void 0 ? void 0 : request.transaction) === null || _e === void 0 ? void 0 : _e.rollback) === null || _f === void 0 ? void 0 : _f.call(_e))];
-                    case 8:
-                        _k.sent();
-                        return [3, 10];
-                    case 9:
-                        _h = _k.sent();
-                        return [3, 10];
-                    case 10: throw new common_1.NotFoundException();
-                    case 11: return [3, 13];
-                    case 12:
-                        error_1 = _k.sent();
+                        _f.sent();
                         throw error_1;
-                    case 13: return [2];
+                    case 5: return [2];
+                }
+            });
+        });
+    };
+    HerbalController.prototype.$call = function (name, context) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var methodConfig;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        methodConfig = (_b = (_a = decorators_1.Method.getPool(this)) === null || _a === void 0 ? void 0 : _a.getConfig) === null || _b === void 0 ? void 0 : _b.call(_a, name);
+                        if (methodConfig === null || typeof methodConfig === 'undefined') {
+                            throw new common_1.NotFoundException("Method ".concat(name, " not found"));
+                        }
+                        return [4, methodConfig.call(context)];
+                    case 1: return [2, _c.sent()];
                 }
             });
         });
@@ -159,6 +178,6 @@ var HerbalController = exports.HerbalController = (function () {
         __metadata("design:type", Function),
         __metadata("design:paramtypes", [Object]),
         __metadata("design:returntype", Promise)
-    ], HerbalController.prototype, "handler", null);
+    ], HerbalController.prototype, "$handleRequest", null);
     return HerbalController;
 }());

package/dist/decorators/index.d.ts

@@ -1,3 +1,4 @@
 export * from './auth-adapter.decorator';
 export * from './client-groups.decorator';
 export * from './no-transaction.decorator';
+export * from './method.decorator';

package/dist/decorators/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./auth-adapter.decorator"), exports);
 __exportStar(require("./client-groups.decorator"), exports);
 __exportStar(require("./no-transaction.decorator"), exports);
+__exportStar(require("./method.decorator"), exports);

package/dist/decorators/method.decorator.d.ts

@@ -0,0 +1,41 @@
+import 'reflect-metadata';
+import { z } from 'zod';
+import { AuthAdapter } from '../abstracts';
+import { GroupsFactory } from './client-groups.decorator';
+import { HeaderUtil } from '@open-norantec/utilities/dist/header-util.class';
+import { Constructor } from 'type-fest';
+import { Type } from '@nestjs/common';
+import { RequestContext } from '../types';
+export interface MethodOptions<IS extends z.Schema<any>, OS extends z.Schema<any>> {
+    inputSchema: IS;
+    outputSchema: OS;
+    authAdapters?: AuthAdapter[];
+    clientGroups?: GroupsFactory | string[];
+    disableTransaction?: boolean;
+}
+export type DependencyGetter = <T>(dependency: Constructor<T>) => T;
+export interface MethodContext<IS extends z.Schema<any>> extends Omit<RequestContext, 'moduleRef'> {
+    headers: ReturnType<typeof HeaderUtil.parse>;
+    input: z.infer<IS>;
+    url: string;
+    getProvider: <TInput = any, TResult = TInput>(typeOrToken: Type<TInput> | Function | string | symbol) => TResult;
+}
+export type MethodCallContext<IS extends z.Schema<any>> = Omit<MethodContext<IS>, 'input'>;
+export type MethodCallback<IS extends z.Schema<any>, OS extends z.Schema<any>> = (context: MethodContext<IS>) => Promise<z.infer<OS>>;
+declare class MethodConfig<IS extends z.Schema<any>, OS extends z.Schema<any>> {
+    readonly name: string;
+    protected readonly options: MethodOptions<IS, OS>;
+    protected readonly callback: MethodCallback<IS, OS>;
+    constructor(name: string, options: MethodOptions<IS, OS>, callback: MethodCallback<IS, OS>);
+    call(callContext: MethodCallContext<IS>): Promise<z.TypeOf<OS>>;
+}
+declare class MethodPool {
+    protected readonly methods: Map<string, MethodConfig<any, any>>;
+    registerMethod<IS extends z.Schema<any>, OS extends z.Schema<any>>(name: string, options: MethodOptions<IS, OS>, callback: MethodCallback<IS, OS>): void;
+    getConfig(name: string): MethodConfig<any, any> | null;
+}
+export declare function Method<IS extends z.Schema<any>, OS extends z.Schema<any>>(...parameters: Parameters<typeof MethodPool.prototype.registerMethod<IS, OS>>): ClassDecorator;
+export declare namespace Method {
+    var getPool: (targetPrototype: object) => MethodPool | null;
+}
+export {};

package/dist/decorators/method.decorator.js

@@ -0,0 +1,144 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Method = void 0;
+require("reflect-metadata");
+var zod_1 = require("zod");
+var utilities_1 = require("@open-norantec/utilities");
+var common_1 = require("@nestjs/common");
+var _ = require("lodash");
+var METHOD_POOL = Symbol();
+var MethodConfig = (function () {
+    function MethodConfig(name, options, callback) {
+        this.name = name;
+        this.options = options;
+        this.callback = callback;
+    }
+    MethodConfig.prototype.call = function (callContext) {
+        var _a, _b, _c, _d, _e, _f;
+        return __awaiter(this, void 0, void 0, function () {
+            var parsedBody_1, input, rawResponse_1, response, error_1;
+            var _this = this;
+            return __generator(this, function (_g) {
+                switch (_g.label) {
+                    case 0:
+                        _g.trys.push([0, 2, , 3]);
+                        parsedBody_1 = _.attempt(function () { return JSON.parse((callContext === null || callContext === void 0 ? void 0 : callContext.rawBody) || ''); });
+                        input = _.attempt(function () {
+                            return parsedBody_1 instanceof Error ? undefined : _this.options.inputSchema.parse(parsedBody_1);
+                        });
+                        if (input instanceof zod_1.ZodError) {
+                            throw new common_1.BadRequestException({
+                                from: 'request',
+                                invalidParams: (_c = (_b = (_a = input === null || input === void 0 ? void 0 : input.issues) === null || _a === void 0 ? void 0 : _a.map) === null || _b === void 0 ? void 0 : _b.call(_a, function (item) { var _a, _b; return (_b = (_a = item === null || item === void 0 ? void 0 : item.path) === null || _a === void 0 ? void 0 : _a.join) === null || _b === void 0 ? void 0 : _b.call(_a, '.'); })) !== null && _c !== void 0 ? _c : [],
+                            });
+                        }
+                        else if (input instanceof Error)
+                            throw input;
+                        return [4, this.callback(__assign(__assign({}, callContext), { input: input }))];
+                    case 1:
+                        rawResponse_1 = _g.sent();
+                        response = _.attempt(function () { return _this.options.outputSchema.parse(rawResponse_1); });
+                        if (response instanceof zod_1.ZodError) {
+                            throw new common_1.BadRequestException({
+                                from: 'response',
+                                invalidParams: (_f = (_e = (_d = response === null || response === void 0 ? void 0 : response.issues) === null || _d === void 0 ? void 0 : _d.map) === null || _e === void 0 ? void 0 : _e.call(_d, function (item) { var _a, _b; return (_b = (_a = item === null || item === void 0 ? void 0 : item.path) === null || _a === void 0 ? void 0 : _a.join) === null || _b === void 0 ? void 0 : _b.call(_a, '.'); })) !== null && _f !== void 0 ? _f : [],
+                            });
+                        }
+                        else if (response instanceof Error)
+                            throw response;
+                        return [2, response];
+                    case 2:
+                        error_1 = _g.sent();
+                        throw error_1;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    return MethodConfig;
+}());
+var MethodPool = (function () {
+    function MethodPool() {
+        this.methods = new Map();
+    }
+    MethodPool.prototype.registerMethod = function (name, options, callback) {
+        if (utilities_1.StringUtil.isFalsyString(name))
+            return;
+        if (name.includes('/'))
+            throw new Error("Method name cannot contain slashes: ".concat(name));
+        this.methods.set(name, new MethodConfig(name, options, callback));
+    };
+    MethodPool.prototype.getConfig = function (name) {
+        var config = this.methods.get(name);
+        return config instanceof MethodConfig ? config : null;
+    };
+    return MethodPool;
+}());
+function Method() {
+    var parameters = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        parameters[_i] = arguments[_i];
+    }
+    return function (target) {
+        var pool = Reflect.getMetadata(METHOD_POOL, target.prototype);
+        if (!(pool instanceof MethodPool)) {
+            pool = new MethodPool();
+            Reflect.defineMetadata(METHOD_POOL, pool, target.prototype);
+        }
+        pool.registerMethod.apply(pool, parameters);
+    };
+}
+exports.Method = Method;
+Method.getPool = function (targetPrototype) {
+    var pool = Reflect.getMetadata(METHOD_POOL, targetPrototype);
+    if (!(pool instanceof MethodPool))
+        return null;
+    return pool;
+};

package/dist/types/request.type.d.ts

@@ -1,10 +1,13 @@
 import { Request as ExpressRequest } from 'express';
 import { AuthenticateResult } from '../abstracts/auth-adapter.abstract.class';
 import { Transaction } from 'sequelize';
-export type Request = ExpressRequest & {
+import { ModuleRef } from '@nestjs/core';
+export interface RequestContext {
     methodName: string;
+    moduleRef: ModuleRef;
     rawBody: string | null;
     traceId: string;
     authenticateResult?: AuthenticateResult;
     transaction?: Transaction;
-};
+}
+export type Request = ExpressRequest & RequestContext;

package/dist/utilities/controller-util.class.d.ts

@@ -2,6 +2,7 @@ import 'reflect-metadata';
 import { Request as ExpressRequest } from 'express';
 import { Constructor } from 'type-fest';
 export declare function isHerbalController(target: Function): boolean;
+export declare function getControllerName(target: Function): any;
 export interface HerbalControllerOptions {
     prefix?: string;
     useHeadGuards?: Constructor<any>[];
@@ -16,5 +17,6 @@ export declare class ControllerUtil {
     static create(createOptions?: ControllerUtilCreateOptions): {
         (options?: HerbalControllerOptions): ClassDecorator;
         isHerbalController: typeof isHerbalController;
+        getControllerName: typeof getControllerName;
     };
 }

package/dist/utilities/controller-util.class.js

@@ -72,7 +72,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControllerUtil = exports.isHerbalController = void 0;
+exports.ControllerUtil = exports.getControllerName = exports.isHerbalController = void 0;
 require("reflect-metadata");
 var common_1 = require("@nestjs/common");
 var _ = require("lodash");
@@ -87,11 +87,16 @@ var operators_1 = require("rxjs/operators");
 var logger_service_1 = require("../modules/logger/logger.service");
 var sequelize_typescript_1 = require("sequelize-typescript");
 var decorators_1 = require("../decorators");
-var IS_CONTROLLER = Symbol();
+var IS_HERBAL_CONTROLLER = Symbol();
+var CONTROLLER_NAME = Symbol();
 function isHerbalController(target) {
-    return _.attempt(function () { return Reflect.getMetadata(IS_CONTROLLER, target.prototype); }) === true;
+    return _.attempt(function () { return Reflect.getMetadata(IS_HERBAL_CONTROLLER, target.prototype); }) === true;
 }
 exports.isHerbalController = isHerbalController;
+function getControllerName(target) {
+    return Reflect.getMetadata(CONTROLLER_NAME, target.prototype);
+}
+exports.getControllerName = getControllerName;
 var ControllerInterceptor = (function () {
     function ControllerInterceptor(ref) {
         this.ref = ref;
@@ -173,6 +178,7 @@ function HerbalGuard(options) {
                                 traceId = uuid_util_class_1.UUIDUtil.generateV4();
                             request.traceId = traceId;
                             request.methodName = request.url.split('/').pop();
+                            request.moduleRef = this.ref;
                             response.setHeader(headers_constant_1.HEADERS.TRACE_ID, traceId);
                             chunks = [];
                             _p.label = 1;
@@ -324,16 +330,19 @@ var ControllerUtil = (function () {
                         ? ''
                         : createOptions.prefix
                     : options.prefix;
-                finalPrefix += "".concat(((_a = finalPrefix === null || finalPrefix === void 0 ? void 0 : finalPrefix.endsWith) === null || _a === void 0 ? void 0 : _a.call(finalPrefix, '/')) ? '' : '/').concat(_.camelCase(target.name.replace(/Controller$/g, '')));
+                var controllerName = _.camelCase(target.name.replace(/Controller$/g, ''));
+                finalPrefix += "".concat(((_a = finalPrefix === null || finalPrefix === void 0 ? void 0 : finalPrefix.endsWith) === null || _a === void 0 ? void 0 : _a.call(finalPrefix, '/')) ? '' : '/').concat(controllerName);
                 if (!finalPrefix.startsWith('/'))
                     finalPrefix = "/".concat(finalPrefix);
-                Reflect.defineMetadata(IS_CONTROLLER, true, target.prototype);
+                Reflect.defineMetadata(IS_HERBAL_CONTROLLER, true, target.prototype);
+                Reflect.defineMetadata(CONTROLLER_NAME, controllerName, target.prototype);
                 (0, common_1.Controller)(finalPrefix)(target);
                 (0, common_1.UseInterceptors)(ControllerInterceptor)(target);
                 common_1.UseGuards.apply(void 0, __spreadArray(__spreadArray(__spreadArray([HerbalGuard(_.pick(createOptions, ['getTraceId']))], (Array.isArray(options === null || options === void 0 ? void 0 : options.useHeadGuards) ? options.useHeadGuards : []), false), (Array.isArray(createOptions === null || createOptions === void 0 ? void 0 : createOptions.useGuards) ? createOptions.useGuards : []), false), (Array.isArray(options === null || options === void 0 ? void 0 : options.useTailGuards) ? options.useTailGuards : []), false))(target);
             };
         }
         Controller.isHerbalController = isHerbalController;
+        Controller.getControllerName = getControllerName;
         return Controller;
     };
     return ControllerUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-norantec/herbal",
-    "version": "1.0.2-alpha.15",
+    "version": "1.0.2-alpha.17",
     "description": "Herbal is a builder and toolchain for Nest.js applications",
     "main": "dist/index.js",
     "scripts": {
@@ -45,6 +45,7 @@
         "lodash": "^4.17.21",
         "nest-winston": "^1.10.2",
         "nj-request-scope": "^1.0.10",
+        "openapi-types": "^12.1.3",
         "patch-package": "^8.0.1",
         "reflect-metadata": "^0.2.2",
         "rxjs": "^7.8.2",