@smartsoft001/nestjs 2.76.0 → 2.80.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartsoft001/nestjs",
-  "version": "2.76.0",
+  "version": "2.80.0",
   "type": "commonjs",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -13,4 +13,4 @@
     "@smartsoft001/domain-core": "2.76.0",
     "@smartsoft001/users": "2.76.0"
   }
-}
+}

package/src/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/shared.config"), exports);
+tslib_1.__exportStar(require("./lib/shared.module"), exports);
+tslib_1.__exportStar(require("./lib/filters"), exports);
+tslib_1.__exportStar(require("./lib/decorators"), exports);
+tslib_1.__exportStar(require("./lib/auth"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/shared/nestjs/src/index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC;AACpC,8DAAoC;AACpC,wDAA8B;AAC9B,2DAAiC;AACjC,qDAA2B"}

package/src/lib/auth/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./jwt.strategy"), exports);
+tslib_1.__exportStar(require("./permission.service"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/auth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/shared/nestjs/src/lib/auth/index.ts"],"names":[],"mappings":";;;AAAA,yDAA+B;AAC/B,+DAAqC"}

package/src/lib/auth/jwt.strategy.d.ts

@@ -0,0 +1,11 @@
+import { Strategy } from 'passport-jwt';
+import { SharedConfig } from '../shared.config';
+declare const JwtStrategy_base: new (...args: [opt: import("passport-jwt").StrategyOptionsWithRequest] | [opt: import("passport-jwt").StrategyOptionsWithoutRequest]) => Strategy & {
+    validate(...args: any[]): unknown;
+};
+export declare class JwtStrategy extends JwtStrategy_base {
+    private config;
+    constructor(config: SharedConfig);
+    validate(payload: any): Promise<any>;
+}
+export {};

package/src/lib/auth/jwt.strategy.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JwtStrategy = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const passport_1 = require("@nestjs/passport");
+const passport_jwt_1 = require("passport-jwt");
+const shared_config_1 = require("../shared.config");
+let JwtStrategy = class JwtStrategy extends (0, passport_1.PassportStrategy)(passport_jwt_1.Strategy) {
+    constructor(config) {
+        var _a;
+        super({
+            jwtFromRequest: passport_jwt_1.ExtractJwt.fromAuthHeaderAsBearerToken(),
+            ignoreExpiration: false,
+            secretOrKey: (_a = config.tokenConfig) === null || _a === void 0 ? void 0 : _a.secretOrPrivateKey,
+        });
+        this.config = config;
+    }
+    validate(payload) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return Object.assign(Object.assign({}, payload), { permissions: payload.permissions, username: payload.sub });
+        });
+    }
+};
+exports.JwtStrategy = JwtStrategy;
+exports.JwtStrategy = JwtStrategy = tslib_1.__decorate([
+    (0, common_1.Injectable)(),
+    tslib_1.__metadata("design:paramtypes", [shared_config_1.SharedConfig])
+], JwtStrategy);
+//# sourceMappingURL=jwt.strategy.js.map

package/src/lib/auth/jwt.strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jwt.strategy.js","sourceRoot":"","sources":["../../../../../../../packages/shared/nestjs/src/lib/auth/jwt.strategy.ts"],"names":[],"mappings":";;;;AAAA,2CAA4C;AAC5C,+CAAoD;AACpD,+CAAoD;AAEpD,oDAAgD;AAGzC,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,IAAA,2BAAgB,EAAC,uBAAQ,CAAC;IACzD,YAAoB,MAAoB;;QACtC,KAAK,CAAC;YACJ,cAAc,EAAE,yBAAU,CAAC,2BAA2B,EAAE;YACxD,gBAAgB,EAAE,KAAK;YACvB,WAAW,EAAE,MAAA,MAAM,CAAC,WAAW,0CAAE,kBAA4B;SAC9D,CAAC,CAAC;QALe,WAAM,GAAN,MAAM,CAAc;IAMxC,CAAC;IAEK,QAAQ,CAAC,OAAY;;YACzB,uCACK,OAAO,KACV,WAAW,EAAE,OAAO,CAAC,WAAW,EAChC,QAAQ,EAAE,OAAO,CAAC,GAAG,IACrB;QACJ,CAAC;KAAA;CACF,CAAA;AAhBY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;6CAEiB,4BAAY;GAD7B,WAAW,CAgBvB"}

package/src/lib/auth/permission.service.d.ts

@@ -0,0 +1,18 @@
+import { IUser } from '@smartsoft001/users';
+import { PermissionType, SharedConfig } from '../shared.config';
+/**
+ * Service to handle permission validation for users.
+ *
+ * @class PermissionService
+ */
+export declare class PermissionService {
+    private config;
+    constructor(config: SharedConfig);
+    /**
+     * Validates if the user has the required permissions for a given type.
+     * @param {PermissionType} type - The type of permission to validate.
+     * @param {IUser} user - The user object containing permissions.
+     * @throws {DomainForbiddenError} If the user does not have the required permissions.
+     */
+    valid(type: PermissionType, user: IUser): void;
+}

package/src/lib/auth/permission.service.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermissionService = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const domain_core_1 = require("@smartsoft001/domain-core");
+const shared_config_1 = require("../shared.config");
+/**
+ * Service to handle permission validation for users.
+ *
+ * @class PermissionService
+ */
+let PermissionService = class PermissionService {
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Validates if the user has the required permissions for a given type.
+     * @param {PermissionType} type - The type of permission to validate.
+     * @param {IUser} user - The user object containing permissions.
+     * @throws {DomainForbiddenError} If the user does not have the required permissions.
+     */
+    valid(type, user) {
+        if (!this.config.permissions)
+            return;
+        const typeConfig = this.config.permissions[type];
+        if (!typeConfig)
+            return;
+        if (!user.permissions)
+            throw new domain_core_1.DomainForbiddenError(`Context forbidden`);
+        if (!typeConfig.some((tc) => user.permissions.some((up) => tc === up)))
+            throw new domain_core_1.DomainForbiddenError(`Context forbidden`);
+    }
+};
+exports.PermissionService = PermissionService;
+exports.PermissionService = PermissionService = tslib_1.__decorate([
+    (0, common_1.Injectable)(),
+    tslib_1.__metadata("design:paramtypes", [shared_config_1.SharedConfig])
+], PermissionService);
+//# sourceMappingURL=permission.service.js.map

package/src/lib/auth/permission.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission.service.js","sourceRoot":"","sources":["../../../../../../../packages/shared/nestjs/src/lib/auth/permission.service.ts"],"names":[],"mappings":";;;;AAAA,2CAA4C;AAE5C,2DAAiE;AAGjE,oDAAgE;AAEhE;;;;GAIG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAC5B,YAAoB,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;IAAG,CAAC;IAE5C;;;;;OAKG;IACH,KAAK,CAAC,IAAoB,EAAE,IAAW;QACrC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW;YAAE,OAAO;QAErC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAEjD,IAAI,CAAC,UAAU;YAAE,OAAO;QAExB,IAAI,CAAC,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,kCAAoB,CAAC,mBAAmB,CAAC,CAAC;QAE3E,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YACpE,MAAM,IAAI,kCAAoB,CAAC,mBAAmB,CAAC,CAAC;IACxD,CAAC;CACF,CAAA;AArBY,8CAAiB;4BAAjB,iBAAiB;IAD7B,IAAA,mBAAU,GAAE;6CAEiB,4BAAY;GAD7B,iBAAiB,CAqB7B"}

package/src/lib/decorators/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./user/user.decorator"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/decorators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/shared/nestjs/src/lib/decorators/index.ts"],"names":[],"mappings":";;;AAAA,gEAAsC"}

package/src/lib/decorators/user/{user.decorator.ts → user.decorator.d.ts}

@@ -1,5 +1,3 @@
-import { createParamDecorator, ExecutionContext } from '@nestjs/common';
-
 /**
  * Custom decorator to extract the user object from the request.
  *
@@ -20,7 +18,4 @@ import { createParamDecorator, ExecutionContext } from '@nestjs/common';
  * }
  * ```
  */
-export const User = createParamDecorator((_, context: ExecutionContext) => {
-  const [req] = context.getArgs();
-  return req.user;
-});
+export declare const User: (...dataOrPipes: any[]) => ParameterDecorator;

package/src/lib/decorators/user/user.decorator.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.User = void 0;
+const common_1 = require("@nestjs/common");
+/**
+ * Custom decorator to extract the user object from the request.
+ *
+ * @example
+ * ```ts
+ * import { Controller, Get } from '@nestjs/common';
+ *
+ * import { IUser } from '@smartsoft001/users';
+ *
+ * import { User } from './user.decorator';
+ *
+ * @Controller('profile')
+ * export class ProfileController {
+ *   @Get()
+ *   getProfile(@User() user: IUser) {
+ *     return user;
+ *   }
+ * }
+ * ```
+ */
+exports.User = (0, common_1.createParamDecorator)((_, context) => {
+    const [req] = context.getArgs();
+    return req.user;
+});
+//# sourceMappingURL=user.decorator.js.map

package/src/lib/decorators/user/user.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.decorator.js","sourceRoot":"","sources":["../../../../../../../../packages/shared/nestjs/src/lib/decorators/user/user.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwE;AAExE;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,IAAI,GAAG,IAAA,6BAAoB,EAAC,CAAC,CAAC,EAAE,OAAyB,EAAE,EAAE;IACxE,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAChC,OAAO,GAAG,CAAC,IAAI,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/src/lib/filters/execution/exception.filter.d.ts

@@ -0,0 +1,37 @@
+import { ArgumentsHost, ExceptionFilter } from '@nestjs/common';
+/**
+ * Exception filter to handle and format exceptions thrown by the application.
+ *
+ * @class
+ * @implements {ExceptionFilter}
+ * @throws {HttpException} If the exception is an instance of HttpException.
+ * @throws {DomainValidationError} If the exception is of type DomainValidationError.
+ * @throws {DomainForbiddenError} If the exception is of type DomainForbiddenError.
+ *
+ * @example
+ * ```ts
+ * import { Module } from '@nestjs/common';
+ * import { APP_FILTER } from '@nestjs/core';
+ *
+ * import { AppExceptionFilter } from '@smartsoft001/nestjs';
+ *
+ * @Module({
+ *   providers: [
+ *     {
+ *       provide: APP_FILTER,
+ *       useClass: AppExceptionFilter,
+ *     },
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ */
+export declare class AppExceptionFilter implements ExceptionFilter {
+    /**
+     * Method to catch and handle exceptions.
+     *
+     * @param {any} exception - The exception thrown.
+     * @param {ArgumentsHost} host - The arguments host.
+     */
+    catch(exception: any, host: ArgumentsHost): void;
+}

package/src/lib/filters/execution/exception.filter.js

@@ -0,0 +1,87 @@
+"use strict";
+var AppExceptionFilter_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppExceptionFilter = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const domain_core_1 = require("@smartsoft001/domain-core");
+/**
+ * Exception filter to handle and format exceptions thrown by the application.
+ *
+ * @class
+ * @implements {ExceptionFilter}
+ * @throws {HttpException} If the exception is an instance of HttpException.
+ * @throws {DomainValidationError} If the exception is of type DomainValidationError.
+ * @throws {DomainForbiddenError} If the exception is of type DomainForbiddenError.
+ *
+ * @example
+ * ```ts
+ * import { Module } from '@nestjs/common';
+ * import { APP_FILTER } from '@nestjs/core';
+ *
+ * import { AppExceptionFilter } from '@smartsoft001/nestjs';
+ *
+ * @Module({
+ *   providers: [
+ *     {
+ *       provide: APP_FILTER,
+ *       useClass: AppExceptionFilter,
+ *     },
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ */
+let AppExceptionFilter = AppExceptionFilter_1 = class AppExceptionFilter {
+    /**
+     * Method to catch and handle exceptions.
+     *
+     * @param {any} exception - The exception thrown.
+     * @param {ArgumentsHost} host - The arguments host.
+     */
+    catch(exception, host) {
+        const ctx = host.switchToHttp();
+        const response = ctx.getResponse();
+        let status = common_1.HttpStatus.INTERNAL_SERVER_ERROR;
+        let message = null;
+        if (exception instanceof common_1.HttpException) {
+            status = exception.getStatus();
+            message = exception['message'];
+        }
+        else if (exception['type'] === domain_core_1.DomainValidationError) {
+            status = common_1.HttpStatus.BAD_REQUEST;
+            message = exception['message'];
+        }
+        else if (exception['type'] === domain_core_1.DomainForbiddenError) {
+            status = common_1.HttpStatus.FORBIDDEN;
+            message = exception['message'];
+        }
+        else {
+            status = common_1.HttpStatus.INTERNAL_SERVER_ERROR;
+            message = 'Internal server error';
+        }
+        common_1.Logger.error(exception['stack'] || exception['message'] || exception, AppExceptionFilter_1.name);
+        const result = response.status(status);
+        if (message && result.json) {
+            result.json({
+                details: message,
+            });
+        }
+        else if (!message && result.json) {
+            result.json();
+        }
+        else if (message && !result.json) {
+            result.send({
+                details: message,
+            });
+        }
+        else {
+            result.send();
+        }
+    }
+};
+exports.AppExceptionFilter = AppExceptionFilter;
+exports.AppExceptionFilter = AppExceptionFilter = AppExceptionFilter_1 = tslib_1.__decorate([
+    (0, common_1.Catch)()
+], AppExceptionFilter);
+//# sourceMappingURL=exception.filter.js.map

package/src/lib/filters/execution/exception.filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exception.filter.js","sourceRoot":"","sources":["../../../../../../../../packages/shared/nestjs/src/lib/filters/execution/exception.filter.ts"],"names":[],"mappings":";;;;;AAAA,2CAOwB;AAExB,2DAGmC;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEI,IAAM,kBAAkB,0BAAxB,MAAM,kBAAkB;IAC7B;;;;;OAKG;IACH,KAAK,CAAC,SAAc,EAAE,IAAmB;QACvC,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QAEnC,IAAI,MAAM,GAAG,mBAAU,CAAC,qBAAqB,CAAC;QAC9C,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,SAAS,YAAY,sBAAa,EAAE,CAAC;YACvC,MAAM,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;YAC/B,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC;aAAM,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,mCAAqB,EAAE,CAAC;YACvD,MAAM,GAAG,mBAAU,CAAC,WAAW,CAAC;YAChC,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC;aAAM,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,kCAAoB,EAAE,CAAC;YACtD,MAAM,GAAG,mBAAU,CAAC,SAAS,CAAC;YAC9B,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,mBAAU,CAAC,qBAAqB,CAAC;YAC1C,OAAO,GAAG,uBAAuB,CAAC;QACpC,CAAC;QAED,eAAM,CAAC,KAAK,CACV,SAAS,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,EACvD,oBAAkB,CAAC,IAAI,CACxB,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,OAAO,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC;gBACV,OAAO,EAAE,OAAO;aACjB,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,CAAC;aAAM,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC;gBACV,OAAO,EAAE,OAAO;aACjB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,CAAC;IACH,CAAC;CACF,CAAA;AA/CY,gDAAkB;6BAAlB,kBAAkB;IAD9B,IAAA,cAAK,GAAE;GACK,kBAAkB,CA+C9B"}

package/src/lib/filters/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./execution/exception.filter"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/filters/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/shared/nestjs/src/lib/filters/index.ts"],"names":[],"mappings":";;;AAAA,uEAA6C"}

package/src/lib/shared.config.d.ts

@@ -0,0 +1,16 @@
+export interface ISharedPermissions {
+    create: Array<string>;
+    read: Array<string>;
+    update: Array<string>;
+    delete: Array<string>;
+    [key: string]: Array<string>;
+}
+export declare class SharedConfig {
+    tokenConfig?: {
+        secretOrPrivateKey: string;
+        expiredIn: number;
+    };
+    permissions?: ISharedPermissions;
+    type?: any;
+}
+export type PermissionType = 'create' | 'read' | 'update' | 'delete' | string;

package/src/lib/shared.config.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedConfig = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+let SharedConfig = class SharedConfig {
+};
+exports.SharedConfig = SharedConfig;
+exports.SharedConfig = SharedConfig = tslib_1.__decorate([
+    (0, common_1.Injectable)()
+], SharedConfig);
+//# sourceMappingURL=shared.config.js.map

package/src/lib/shared.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.config.js","sourceRoot":"","sources":["../../../../../../packages/shared/nestjs/src/lib/shared.config.ts"],"names":[],"mappings":";;;;AAAA,2CAA4C;AAWrC,IAAM,YAAY,GAAlB,MAAM,YAAY;CAOxB,CAAA;AAPY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,mBAAU,GAAE;GACA,YAAY,CAOxB"}

package/src/lib/shared.module.d.ts

@@ -0,0 +1,29 @@
+import { DynamicModule } from '@nestjs/common';
+import { SharedConfig } from './shared.config';
+/**
+ * SharedModule class provides methods to configure the module's core functionalities and database settings.
+ */
+export declare class SharedModule {
+    /**
+     * Configures the module's core functionalities.
+     *
+     * @param {SharedConfig} config - An object containing the module's configuration.
+     * @returns {DynamicModule} A DynamicModule object with providers and exports.
+     */
+    static forFeature(config: SharedConfig): DynamicModule;
+    /**
+     * Extends the forFeature() configuration by adding database settings. Use in AppModule.
+     *
+     * @param {SharedConfig & { db: { host: string; port: number; database: string; username?: string; password?: string; }}} config - An extended SharedConfig object that includes additional database settings.
+     * @returns {DynamicModule} A DynamicModule object that imports and exports the forFeature() configuration.
+     */
+    static forRoot(config: SharedConfig & {
+        db: {
+            host: string;
+            port: number;
+            database: string;
+            username?: string;
+            password?: string;
+        };
+    }): DynamicModule;
+}

package/src/lib/shared.module.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedModule = void 0;
+const auth_1 = require("./auth");
+const shared_config_1 = require("./shared.config");
+/**
+ * SharedModule class provides methods to configure the module's core functionalities and database settings.
+ */
+class SharedModule {
+    /**
+     * Configures the module's core functionalities.
+     *
+     * @param {SharedConfig} config - An object containing the module's configuration.
+     * @returns {DynamicModule} A DynamicModule object with providers and exports.
+     */
+    static forFeature(config) {
+        return {
+            module: SharedModule,
+            providers: [
+                { provide: shared_config_1.SharedConfig, useValue: config },
+                auth_1.JwtStrategy,
+                auth_1.PermissionService,
+            ],
+            exports: [
+                { provide: shared_config_1.SharedConfig, useValue: config },
+                auth_1.PermissionService,
+                auth_1.JwtStrategy,
+            ],
+        };
+    }
+    /**
+     * Extends the forFeature() configuration by adding database settings. Use in AppModule.
+     *
+     * @param {SharedConfig & { db: { host: string; port: number; database: string; username?: string; password?: string; }}} config - An extended SharedConfig object that includes additional database settings.
+     * @returns {DynamicModule} A DynamicModule object that imports and exports the forFeature() configuration.
+     */
+    static forRoot(config) {
+        return {
+            module: SharedModule,
+            imports: [SharedModule.forFeature(config)],
+            exports: [SharedModule.forFeature(config)],
+        };
+    }
+}
+exports.SharedModule = SharedModule;
+//# sourceMappingURL=shared.module.js.map

package/src/lib/shared.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.module.js","sourceRoot":"","sources":["../../../../../../packages/shared/nestjs/src/lib/shared.module.ts"],"names":[],"mappings":";;;AAEA,iCAAwD;AACxD,mDAA+C;AAE/C;;GAEG;AACH,MAAa,YAAY;IACvB;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,OAAO;YACL,MAAM,EAAE,YAAY;YACpB,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,4BAAY,EAAE,QAAQ,EAAE,MAAM,EAAE;gBAC3C,kBAAW;gBACX,wBAAiB;aAClB;YACD,OAAO,EAAE;gBACP,EAAE,OAAO,EAAE,4BAAY,EAAE,QAAQ,EAAE,MAAM,EAAE;gBAC3C,wBAAiB;gBACjB,kBAAW;aACZ;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CACZ,MAQC;QAED,OAAO;YACL,MAAM,EAAE,YAAY;YACpB,OAAO,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,OAAO,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SAC3C,CAAC;IACJ,CAAC;CACF;AA9CD,oCA8CC"}

package/.eslintrc.json

@@ -1,36 +0,0 @@
-{
-  "extends": ["../../../.eslintrc.json"],
-  "ignorePatterns": ["!**/*"],
-  "rules": {},
-  "overrides": [
-    {
-      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.ts", "*.tsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.js", "*.jsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.json"],
-      "parser": "jsonc-eslint-parser",
-      "rules": {
-        "@nx/dependency-checks": [
-          "error",
-          {
-            "ignoredDependencies": [
-              "passport-jwt",
-              "@nestjs/passport",
-              "@nestjs/common",
-              "@nestjs/testing"
-            ]
-          }
-        ]
-      }
-    }
-  ]
-}

package/jest.config.ts

@@ -1,10 +0,0 @@
-export default {
-  displayName: 'nestjs',
-  preset: '../../../jest.preset.js',
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
-  },
-  moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: '../../../coverage/packages/shared/nestjs',
-};

package/project.json

@@ -1,37 +0,0 @@
-{
-  "name": "nestjs",
-  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/shared/nestjs/src",
-  "projectType": "library",
-  "tags": [],
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "dist/packages/shared/nestjs",
-        "main": "packages/shared/nestjs/src/index.ts",
-        "tsConfig": "packages/shared/nestjs/tsconfig.lib.json",
-        "assets": ["packages/shared/nestjs/*.md"]
-      }
-    },
-    "lint": {
-      "executor": "@nx/eslint:lint"
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "options": {
-        "jestConfig": "packages/shared/nestjs/jest.config.ts"
-      }
-    },
-    "deploy": {
-      "executor": "ngx-deploy-npm:deploy",
-      "options": {
-        "access": "public",
-        "distFolderPath": "dist/packages/shared/nestjs"
-      },
-      "dependsOn": ["build"]
-    }
-  }
-}

package/src/lib/auth/jwt.strategy.ts

@@ -1,24 +0,0 @@
-import { Injectable } from '@nestjs/common';
-import { PassportStrategy } from '@nestjs/passport';
-import { ExtractJwt, Strategy } from 'passport-jwt';
-
-import { SharedConfig } from '../shared.config';
-
-@Injectable()
-export class JwtStrategy extends PassportStrategy(Strategy) {
-  constructor(private config: SharedConfig) {
-    super({
-      jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
-      ignoreExpiration: false,
-      secretOrKey: config.tokenConfig?.secretOrPrivateKey as string,
-    });
-  }
-
-  async validate(payload: any) {
-    return {
-      ...payload,
-      permissions: payload.permissions,
-      username: payload.sub,
-    };
-  }
-}

package/src/lib/auth/permission.service.spec.ts

@@ -1,62 +0,0 @@
-import { Test, TestingModule } from '@nestjs/testing';
-
-import { DomainForbiddenError } from '@smartsoft001/domain-core';
-import { IUser } from '@smartsoft001/users';
-
-import { PermissionService } from './permission.service';
-import { SharedConfig } from '../shared.config';
-
-describe('shared-nestjs: PermissionService', () => {
-  let service: PermissionService;
-  let config: SharedConfig;
-
-  beforeEach(async () => {
-    config = {
-      permissions: {
-        create: ['admin', 'editor'],
-        read: ['admin', 'editor', 'viewer'],
-        update: ['admin', 'editor'],
-        delete: ['admin'],
-      },
-    };
-
-    const module: TestingModule = await Test.createTestingModule({
-      providers: [
-        PermissionService,
-        { provide: SharedConfig, useValue: config },
-      ],
-    }).compile();
-
-    service = module.get<PermissionService>(PermissionService);
-  });
-
-  it('should be defined', () => {
-    expect(service).toBeDefined();
-  });
-
-  it('should allow access if user has the required permission', () => {
-    const user: IUser = { username: 'testuser', permissions: ['admin'] };
-    expect(() => service.valid('create', user)).not.toThrow();
-  });
-
-  it('should throw DomainForbiddenError if user does not have the required permission', () => {
-    const user: IUser = { username: 'testuser', permissions: ['viewer'] };
-    expect(() => service.valid('create', user)).toThrow(DomainForbiddenError);
-  });
-
-  it('should not throw if permissions config is not defined', () => {
-    config.permissions = undefined;
-    const user: IUser = { username: 'testuser', permissions: ['admin'] };
-    expect(() => service.valid('create', user)).not.toThrow();
-  });
-
-  it('should not throw if permission type config is not defined', () => {
-    const user: IUser = { username: 'testuser', permissions: ['admin'] };
-    expect(() => service.valid('nonexistent', user)).not.toThrow();
-  });
-
-  it('should throw DomainForbiddenError if user permissions are not defined', () => {
-    const user: IUser = { username: 'testuser', permissions: [] };
-    expect(() => service.valid('create', user)).toThrow(DomainForbiddenError);
-  });
-});

package/src/lib/auth/permission.service.ts

@@ -1,35 +0,0 @@
-import { Injectable } from '@nestjs/common';
-
-import { DomainForbiddenError } from '@smartsoft001/domain-core';
-import { IUser } from '@smartsoft001/users';
-
-import { PermissionType, SharedConfig } from '../shared.config';
-
-/**
- * Service to handle permission validation for users.
- *
- * @class PermissionService
- */
-@Injectable()
-export class PermissionService {
-  constructor(private config: SharedConfig) {}
-
-  /**
-   * Validates if the user has the required permissions for a given type.
-   * @param {PermissionType} type - The type of permission to validate.
-   * @param {IUser} user - The user object containing permissions.
-   * @throws {DomainForbiddenError} If the user does not have the required permissions.
-   */
-  valid(type: PermissionType, user: IUser): void {
-    if (!this.config.permissions) return;
-
-    const typeConfig = this.config.permissions[type];
-
-    if (!typeConfig) return;
-
-    if (!user.permissions) throw new DomainForbiddenError(`Context forbidden`);
-
-    if (!typeConfig.some((tc) => user.permissions.some((up) => tc === up)))
-      throw new DomainForbiddenError(`Context forbidden`);
-  }
-}

package/src/lib/filters/execution/exception.filter.ts

@@ -1,90 +0,0 @@
-import {
-  ArgumentsHost,
-  Catch,
-  ExceptionFilter,
-  HttpException,
-  HttpStatus,
-  Logger,
-} from '@nestjs/common';
-
-import {
-  DomainForbiddenError,
-  DomainValidationError,
-} from '@smartsoft001/domain-core';
-
-/**
- * Exception filter to handle and format exceptions thrown by the application.
- *
- * @class
- * @implements {ExceptionFilter}
- * @throws {HttpException} If the exception is an instance of HttpException.
- * @throws {DomainValidationError} If the exception is of type DomainValidationError.
- * @throws {DomainForbiddenError} If the exception is of type DomainForbiddenError.
- *
- * @example
- * ```ts
- * import { Module } from '@nestjs/common';
- * import { APP_FILTER } from '@nestjs/core';
- *
- * import { AppExceptionFilter } from '@smartsoft001/nestjs';
- *
- * @Module({
- *   providers: [
- *     {
- *       provide: APP_FILTER,
- *       useClass: AppExceptionFilter,
- *     },
- *   ],
- * })
- * export class AppModule {}
- * ```
- */
-@Catch()
-export class AppExceptionFilter implements ExceptionFilter {
-  /**
-   * Method to catch and handle exceptions.
-   *
-   * @param {any} exception - The exception thrown.
-   * @param {ArgumentsHost} host - The arguments host.
-   */
-  catch(exception: any, host: ArgumentsHost) {
-    const ctx = host.switchToHttp();
-    const response = ctx.getResponse();
-
-    let status = HttpStatus.INTERNAL_SERVER_ERROR;
-    let message = null;
-    if (exception instanceof HttpException) {
-      status = exception.getStatus();
-      message = exception['message'];
-    } else if (exception['type'] === DomainValidationError) {
-      status = HttpStatus.BAD_REQUEST;
-      message = exception['message'];
-    } else if (exception['type'] === DomainForbiddenError) {
-      status = HttpStatus.FORBIDDEN;
-      message = exception['message'];
-    } else {
-      status = HttpStatus.INTERNAL_SERVER_ERROR;
-      message = 'Internal server error';
-    }
-
-    Logger.error(
-      exception['stack'] || exception['message'] || exception,
-      AppExceptionFilter.name,
-    );
-
-    const result = response.status(status);
-    if (message && result.json) {
-      result.json({
-        details: message,
-      });
-    } else if (!message && result.json) {
-      result.json();
-    } else if (message && !result.json) {
-      result.send({
-        details: message,
-      });
-    } else {
-      result.send();
-    }
-  }
-}

package/src/lib/filters/execution/execution.filter.spec.ts

@@ -1,108 +0,0 @@
-import { ArgumentsHost, HttpException, HttpStatus } from '@nestjs/common';
-import { Test, TestingModule } from '@nestjs/testing';
-
-import {
-  DomainForbiddenError,
-  DomainValidationError,
-} from '@smartsoft001/domain-core';
-
-import { AppExceptionFilter } from './exception.filter';
-
-describe('shared-nestjs: ExceptionFilter', () => {
-  let appExceptionFilter: AppExceptionFilter;
-
-  beforeEach(async () => {
-    const module: TestingModule = await Test.createTestingModule({
-      providers: [AppExceptionFilter],
-    }).compile();
-
-    appExceptionFilter = module.get<AppExceptionFilter>(AppExceptionFilter);
-  });
-
-  it('should handle HttpException', () => {
-    const mockResponse = {
-      status: jest.fn().mockReturnThis(),
-      json: jest.fn(),
-      send: jest.fn(),
-    };
-    const mockHost = {
-      switchToHttp: jest.fn().mockReturnValue({
-        getResponse: () => mockResponse,
-      }),
-    } as unknown as ArgumentsHost;
-    const exception = new HttpException('Forbidden', HttpStatus.FORBIDDEN);
-
-    appExceptionFilter.catch(exception, mockHost);
-
-    expect(mockResponse.status).toHaveBeenCalledWith(HttpStatus.FORBIDDEN);
-    expect(mockResponse.json).toHaveBeenCalledWith({ details: 'Forbidden' });
-  });
-
-  it('should handle DomainValidationError', () => {
-    const mockResponse = {
-      status: jest.fn().mockReturnThis(),
-      json: jest.fn(),
-      send: jest.fn(),
-    };
-    const mockHost = {
-      switchToHttp: jest.fn().mockReturnValue({
-        getResponse: () => mockResponse,
-      }),
-    } as unknown as ArgumentsHost;
-    const exception = {
-      type: DomainValidationError,
-      message: 'Validation failed',
-    };
-
-    appExceptionFilter.catch(exception, mockHost);
-
-    expect(mockResponse.status).toHaveBeenCalledWith(HttpStatus.BAD_REQUEST);
-    expect(mockResponse.json).toHaveBeenCalledWith({
-      details: 'Validation failed',
-    });
-  });
-
-  it('should handle DomainForbiddenError', () => {
-    const mockResponse = {
-      status: jest.fn().mockReturnThis(),
-      json: jest.fn(),
-      send: jest.fn(),
-    };
-    const mockHost = {
-      switchToHttp: jest.fn().mockReturnValue({
-        getResponse: () => mockResponse,
-      }),
-    } as unknown as ArgumentsHost;
-    const exception = { type: DomainForbiddenError, message: 'Access denied' };
-
-    appExceptionFilter.catch(exception, mockHost);
-
-    expect(mockResponse.status).toHaveBeenCalledWith(HttpStatus.FORBIDDEN);
-    expect(mockResponse.json).toHaveBeenCalledWith({
-      details: 'Access denied',
-    });
-  });
-
-  it('should handle internal server error', () => {
-    const mockResponse = {
-      status: jest.fn().mockReturnThis(),
-      json: jest.fn(),
-      send: jest.fn(),
-    };
-    const mockHost = {
-      switchToHttp: jest.fn().mockReturnValue({
-        getResponse: () => mockResponse,
-      }),
-    } as unknown as ArgumentsHost;
-    const exception = { message: 'Internal server error' };
-
-    appExceptionFilter.catch(exception, mockHost);
-
-    expect(mockResponse.status).toHaveBeenCalledWith(
-      HttpStatus.INTERNAL_SERVER_ERROR,
-    );
-    expect(mockResponse.json).toHaveBeenCalledWith({
-      details: 'Internal server error',
-    });
-  });
-});

package/src/lib/shared.config.ts

@@ -1,21 +0,0 @@
-import { Injectable } from '@nestjs/common';
-
-export interface ISharedPermissions {
-  create: Array<string>;
-  read: Array<string>;
-  update: Array<string>;
-  delete: Array<string>;
-  [key: string]: Array<string>;
-}
-
-@Injectable()
-export class SharedConfig {
-  tokenConfig?: {
-    secretOrPrivateKey: string;
-    expiredIn: number;
-  };
-  permissions?: ISharedPermissions;
-  type?: any;
-}
-
-export type PermissionType = 'create' | 'read' | 'update' | 'delete' | string;

package/src/lib/shared.module.ts

@@ -1,55 +0,0 @@
-import { DynamicModule } from '@nestjs/common';
-
-import { JwtStrategy, PermissionService } from './auth';
-import { SharedConfig } from './shared.config';
-
-/**
- * SharedModule class provides methods to configure the module's core functionalities and database settings.
- */
-export class SharedModule {
-  /**
-   * Configures the module's core functionalities.
-   *
-   * @param {SharedConfig} config - An object containing the module's configuration.
-   * @returns {DynamicModule} A DynamicModule object with providers and exports.
-   */
-  static forFeature(config: SharedConfig): DynamicModule {
-    return {
-      module: SharedModule,
-      providers: [
-        { provide: SharedConfig, useValue: config },
-        JwtStrategy,
-        PermissionService,
-      ],
-      exports: [
-        { provide: SharedConfig, useValue: config },
-        PermissionService,
-        JwtStrategy,
-      ],
-    };
-  }
-
-  /**
-   * Extends the forFeature() configuration by adding database settings. Use in AppModule.
-   *
-   * @param {SharedConfig & { db: { host: string; port: number; database: string; username?: string; password?: string; }}} config - An extended SharedConfig object that includes additional database settings.
-   * @returns {DynamicModule} A DynamicModule object that imports and exports the forFeature() configuration.
-   */
-  static forRoot(
-    config: SharedConfig & {
-      db: {
-        host: string;
-        port: number;
-        database: string;
-        username?: string;
-        password?: string;
-      };
-    },
-  ): DynamicModule {
-    return {
-      module: SharedModule,
-      imports: [SharedModule.forFeature(config)],
-      exports: [SharedModule.forFeature(config)],
-    };
-  }
-}

package/tsconfig.json

@@ -1,22 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "module": "commonjs",
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noImplicitOverride": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "noPropertyAccessFromIndexSignature": true
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../../dist/out-tsc",
-    "declaration": true,
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.spec.json

@@ -1,15 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../../dist/out-tsc",
-    "module": "commonjs",
-    "moduleResolution": "node10",
-    "types": ["jest", "node"]
-  },
-  "include": [
-    "jest.config.ts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.d.ts"
-  ]
-}