@mondart/nestjs-common-module 2.8.0 → 2.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondart/nestjs-common-module",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "description": "",
   "author": {
     "name": "Mondart"
@@ -21,7 +21,7 @@
     "build:docs": "npx compodoc -p tsconfig.build.json -d docs -o -s --theme material"
   },
   "dependencies": {
-    "@keycloak/keycloak-admin-client": "^26.4.7",
+    "@keycloak/keycloak-admin-client": "~26.5.0",
     "@keyv/redis": "4.2.0",
     "@nestjs/axios": "^4.0.0",
     "@nestjs/cache-manager": "^3.0.0",
@@ -37,7 +37,7 @@
     "@sentry/nestjs": "^10.32.1",
     "@sentry/profiling-node": "^10.32.1",
     "@types/redis": "^4.0.11",
-    "axios": "1.13.2",
+    "axios": "~1.15.0",
     "bottleneck": "^2.19.5",
     "cache-manager": "6.4.0",
     "cache-manager-ioredis-yet": "^2.1.1",

package/.github/workflows/npm-publish.yml

@@ -1,34 +0,0 @@
-name: Build and Publish
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build-and-publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: '16' # Use the Node.js version your project requires
-
-      - name: Install dependencies
-        run: npm install --force
-
-      - name: Build project
-        run: npm run build # Adjust this if your build command is different
-
-      - name: Set NPM Token
-        run: npm config set _authToken=${{ secrets.NPM_TOKEN }}
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      - name: Publish to npm
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm publish --access public

package/.github/workflows/npm-unpublish.yml

@@ -1,35 +0,0 @@
-name: Unpublish
-
-on:
-  release:
-    types: [deleted]
-
-jobs:
-  unpublish-package:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Check out the repository
-        uses: actions/checkout@v3
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: '16'
-
-      - name: Set NPM Token
-        run: npm config set _authToken=${{ secrets.NPM_TOKEN }}
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      - name: Extract package name and version
-        id: extract-package-info
-        run: |
-          # Replace this logic with your specific way of determining the package name and version
-          echo "PACKAGE_NAME=@mondart/nestjs-common-module" >> $GITHUB_ENV
-          echo "PACKAGE_VERSION=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
-
-      - name: Unpublish the package
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm unpublish $PACKAGE_NAME@$PACKAGE_VERSION --force

package/dist/lib/captcha/captcha.decorator.d.ts

@@ -1,4 +0,0 @@
-import { CaptchaDecorators } from './enums/captcha-decorators.enum';
-export declare const Captcha: (params: {
-    executeAfter: number;
-}) => import("@nestjs/common").CustomDecorator<CaptchaDecorators>;

package/dist/lib/captcha/captcha.decorator.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Captcha = void 0;
-const common_1 = require("@nestjs/common");
-const captcha_decorators_enum_1 = require("./enums/captcha-decorators.enum");
-const Captcha = (params) => (0, common_1.SetMetadata)(captcha_decorators_enum_1.CaptchaDecorators.CAPTCHA, params);
-exports.Captcha = Captcha;

package/dist/lib/captcha/captcha.exception.d.ts

@@ -1,4 +0,0 @@
-import { UnauthorizedException } from '@nestjs/common';
-export declare class InvalidCaptcha extends UnauthorizedException {
-    constructor(cause?: string);
-}

package/dist/lib/captcha/captcha.exception.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidCaptcha = void 0;
-const common_1 = require("@nestjs/common");
-const captcha_messages_enum_1 = require("./enums/captcha-messages.enum");
-class InvalidCaptcha extends common_1.UnauthorizedException {
-    constructor(cause) {
-        super(captcha_messages_enum_1.CaptchaErrors.INVALID_CAPTCHA, { cause });
-    }
-}
-exports.InvalidCaptcha = InvalidCaptcha;

package/dist/lib/captcha/captcha.guard.d.ts

@@ -1,16 +0,0 @@
-import { CanActivate, ExecutionContext } from '@nestjs/common';
-import { CaptchaModuleOptions, IGoogleResponse } from './captcha.interface';
-import { RequestService } from '../request';
-import { Reflector } from '@nestjs/core';
-import { CachingService } from '../caching';
-export declare class CaptchaGuard implements CanActivate {
-    private reflector;
-    private captchaModuleOptions;
-    private readonly requestService;
-    private readonly cachingService;
-    constructor(reflector: Reflector, captchaModuleOptions: CaptchaModuleOptions, requestService: RequestService<IGoogleResponse>, cachingService: CachingService);
-    canActivate(context: ExecutionContext): Promise<boolean>;
-    private getCaptchaDetails;
-    private incExecutionTimes;
-    private isCaptchaValid;
-}

package/dist/lib/captcha/captcha.guard.js

@@ -1,86 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CaptchaGuard = void 0;
-const common_1 = require("@nestjs/common");
-const captcha_interface_1 = require("./captcha.interface");
-const request_1 = require("../request");
-const core_1 = require("@nestjs/core");
-const captcha_decorators_enum_1 = require("./enums/captcha-decorators.enum");
-const captcha_exception_1 = require("./captcha.exception");
-const request_2 = require("../request");
-const caching_1 = require("../caching");
-const decorators_1 = require("../../decorators");
-let CaptchaGuard = class CaptchaGuard {
-    constructor(reflector, captchaModuleOptions, requestService, cachingService) {
-        this.reflector = reflector;
-        this.captchaModuleOptions = captchaModuleOptions;
-        this.requestService = requestService;
-        this.cachingService = cachingService;
-    }
-    async canActivate(context) {
-        const captchaSettings = this.getCaptchaDetails(context);
-        const request = context.switchToHttp().getRequest();
-        const iamContext = (0, decorators_1.getIamContext)(request);
-        if (iamContext?.agentId || iamContext?.userId || !captchaSettings)
-            return true;
-        if (captchaSettings && captchaSettings.executeAfter) {
-            const ip = iamContext?.ip || null;
-            const result = await this.incExecutionTimes(ip, captchaSettings.executeAfter);
-            if (result)
-                return true;
-        }
-        const headers = typeof request?.headers === 'string'
-            ? JSON.parse(request?.headers)
-            : request?.headers;
-        const text = headers?.['captcha-token'];
-        if (!text)
-            throw new captcha_exception_1.InvalidCaptcha();
-        await this.isCaptchaValid(text);
-        return true;
-    }
-    getCaptchaDetails(context) {
-        const captchaDetailsForEndpoint = this.reflector.get(captcha_decorators_enum_1.CaptchaDecorators.CAPTCHA, context.getHandler());
-        const captchaDetailsForController = this.reflector.get(captcha_decorators_enum_1.CaptchaDecorators.CAPTCHA, context.getClass());
-        return captchaDetailsForEndpoint || captchaDetailsForController;
-    }
-    async incExecutionTimes(ip, executionCount) {
-        const cacheKey = `captcha-execution-count-${ip}`;
-        const executionTimes = await this.cachingService.get(cacheKey);
-        if (executionTimes < executionCount) {
-            await this.cachingService.set(cacheKey, (executionTimes || 0) + 1, this.captchaModuleOptions.executionAfterTtlSeconds);
-            return true;
-        }
-    }
-    async isCaptchaValid(text) {
-        const params = new URLSearchParams();
-        params.append('secret', this.captchaModuleOptions.secret);
-        params.append('response', text);
-        const result = await this.requestService.send({
-            path: this.captchaModuleOptions.verifyUrl,
-            headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-            params: params.toString(),
-            method: request_2.HttpMethods.POST,
-        });
-        if (!result.success)
-            throw new captcha_exception_1.InvalidCaptcha(result?.['error-codes']?.join(', '));
-    }
-};
-exports.CaptchaGuard = CaptchaGuard;
-exports.CaptchaGuard = CaptchaGuard = __decorate([
-    (0, common_1.Injectable)(),
-    __param(1, (0, common_1.Inject)(captcha_interface_1.CAPTCHA_MODULE_OPTIONS)),
-    __metadata("design:paramtypes", [core_1.Reflector, Object, request_1.RequestService,
-        caching_1.CachingService])
-], CaptchaGuard);

package/dist/lib/captcha/captcha.interface.d.ts

@@ -1,26 +0,0 @@
-import { ModuleMetadata, Type } from '@nestjs/common';
-export declare const CAPTCHA_MODULE_OPTIONS = "CAPTCHA_MODULE_OPTIONS";
-export interface CaptchaModuleOptions {
-    secret: string;
-    verifyUrl: string;
-    executionAfterTtlSeconds: number;
-}
-export interface CaptchaModuleFactory {
-    createModuleOptions: () => Promise<CaptchaModuleOptions> | CaptchaModuleOptions;
-}
-export interface CaptchaModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
-    inject?: any[];
-    useClass?: Type<CaptchaModuleFactory>;
-    useExisting?: Type<CaptchaModuleFactory>;
-    useFactory?: (...args: any[]) => Promise<CaptchaModuleOptions> | CaptchaModuleOptions;
-}
-export interface IGoogleResponse {
-    success: boolean;
-    challenge_ts: Date;
-    hostname?: string;
-    apk_package_name?: string;
-    error_codes: Array<string>;
-}
-export interface ICaptchaSettings {
-    executeAfter: number;
-}

package/dist/lib/captcha/captcha.interface.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CAPTCHA_MODULE_OPTIONS = void 0;
-exports.CAPTCHA_MODULE_OPTIONS = 'CAPTCHA_MODULE_OPTIONS';

package/dist/lib/captcha/captcha.module.d.ts

@@ -1,8 +0,0 @@
-import { DynamicModule } from '@nestjs/common';
-import { CaptchaModuleAsyncOptions, CaptchaModuleOptions } from './captcha.interface';
-export declare class CaptchaModule {
-    static register(options: CaptchaModuleOptions): DynamicModule;
-    static registerAsync(options: CaptchaModuleAsyncOptions): DynamicModule;
-    private static createAsyncOptionsProvider;
-    private static createAsyncProviders;
-}

package/dist/lib/captcha/captcha.module.js

@@ -1,97 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var CaptchaModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CaptchaModule = void 0;
-const common_1 = require("@nestjs/common");
-const captcha_interface_1 = require("./captcha.interface");
-const core_1 = require("@nestjs/core");
-const captcha_guard_1 = require("./captcha.guard");
-const request_1 = require("../request");
-let CaptchaModule = CaptchaModule_1 = class CaptchaModule {
-    static register(options) {
-        return {
-            module: CaptchaModule_1,
-            imports: [request_1.RequestModule],
-            providers: [
-                {
-                    provide: core_1.APP_GUARD,
-                    useClass: captcha_guard_1.CaptchaGuard,
-                },
-                {
-                    provide: captcha_interface_1.CAPTCHA_MODULE_OPTIONS,
-                    useValue: options,
-                },
-            ],
-            controllers: [],
-            exports: [],
-        };
-    }
-    static registerAsync(options) {
-        const asyncOptionsProvider = this.createAsyncOptionsProvider(options);
-        return {
-            module: CaptchaModule_1,
-            imports: [...(options.imports || []), asyncOptionsProvider],
-            providers: [],
-            controllers: [],
-            exports: [],
-        };
-    }
-    static createAsyncOptionsProvider(options) {
-        const providers = this.createAsyncProviders(options);
-        return {
-            module: CaptchaModule_1,
-            imports: [request_1.RequestModule],
-            providers,
-            exports: [captcha_interface_1.CAPTCHA_MODULE_OPTIONS],
-        };
-    }
-    static createAsyncProviders(options) {
-        if (options.useFactory) {
-            return [
-                {
-                    provide: core_1.APP_GUARD,
-                    useClass: captcha_guard_1.CaptchaGuard,
-                },
-                {
-                    provide: captcha_interface_1.CAPTCHA_MODULE_OPTIONS,
-                    useFactory: options.useFactory,
-                    inject: options.inject || [],
-                },
-            ];
-        }
-        const useClass = options.useClass || options.useExisting;
-        if (useClass) {
-            return [
-                {
-                    provide: captcha_interface_1.CAPTCHA_MODULE_OPTIONS,
-                    useFactory: async (optionsFactory) => await optionsFactory.createModuleOptions(),
-                    inject: [options.useExisting || options.useClass],
-                },
-                {
-                    provide: core_1.APP_GUARD,
-                    useClass: captcha_guard_1.CaptchaGuard,
-                },
-                ...(options.useClass
-                    ? [
-                        {
-                            provide: options.useClass,
-                            useClass: options.useClass,
-                        },
-                    ]
-                    : []),
-            ];
-        }
-        throw new Error('Invalid CaptchaModuleAsyncOptions');
-    }
-};
-exports.CaptchaModule = CaptchaModule;
-exports.CaptchaModule = CaptchaModule = CaptchaModule_1 = __decorate([
-    (0, common_1.Global)(),
-    (0, common_1.Module)({})
-], CaptchaModule);

package/dist/lib/captcha/enums/captcha-decorators.enum.d.ts

@@ -1,3 +0,0 @@
-export declare enum CaptchaDecorators {
-    CAPTCHA = "captcha"
-}

package/dist/lib/captcha/enums/captcha-decorators.enum.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CaptchaDecorators = void 0;
-var CaptchaDecorators;
-(function (CaptchaDecorators) {
-    CaptchaDecorators["CAPTCHA"] = "captcha";
-})(CaptchaDecorators || (exports.CaptchaDecorators = CaptchaDecorators = {}));

package/dist/lib/captcha/enums/captcha-messages.enum.d.ts

@@ -1,3 +0,0 @@
-export declare enum CaptchaErrors {
-    INVALID_CAPTCHA = "captcha.INVALID_CAPTCHA"
-}

package/dist/lib/captcha/enums/captcha-messages.enum.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CaptchaErrors = void 0;
-var CaptchaErrors;
-(function (CaptchaErrors) {
-    CaptchaErrors["INVALID_CAPTCHA"] = "captcha.INVALID_CAPTCHA";
-})(CaptchaErrors || (exports.CaptchaErrors = CaptchaErrors = {}));

package/dist/lib/captcha/index.d.ts

@@ -1,5 +0,0 @@
-import { CAPTCHA_MODULE_OPTIONS } from './captcha.interface';
-import { CaptchaModule } from './captcha.module';
-import { CaptchaModuleOptions } from './captcha.interface';
-import { CaptchaGuard } from './captcha.guard';
-export { CaptchaGuard, CaptchaModule, CAPTCHA_MODULE_OPTIONS, CaptchaModuleOptions, };

package/dist/lib/captcha/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CAPTCHA_MODULE_OPTIONS = exports.CaptchaModule = exports.CaptchaGuard = void 0;
-const captcha_interface_1 = require("./captcha.interface");
-Object.defineProperty(exports, "CAPTCHA_MODULE_OPTIONS", { enumerable: true, get: function () { return captcha_interface_1.CAPTCHA_MODULE_OPTIONS; } });
-const captcha_module_1 = require("./captcha.module");
-Object.defineProperty(exports, "CaptchaModule", { enumerable: true, get: function () { return captcha_module_1.CaptchaModule; } });
-const captcha_guard_1 = require("./captcha.guard");
-Object.defineProperty(exports, "CaptchaGuard", { enumerable: true, get: function () { return captcha_guard_1.CaptchaGuard; } });