itlab-internal-services 2.2.2 → 2.4.0

package/dist/axios.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance } from 'axios';
+/**
+ * Options for creating an axios instance
+ * @interface CreateAxiosOptions
+ */
+interface CreateAxiosOptions {
+    baseUrl: string;
+    k8sToken: string;
+}
+/**
+ * Create an axios instance
+ * @param options - the options for the axios instance
+ * @returns {AxiosInstance} the created axios instance
+ */
+export declare const createAxios: (options: CreateAxiosOptions) => AxiosInstance;
+export {};

package/dist/{modules/services/services.module-utils.js → axios.js}

@@ -5,7 +5,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createAxios = void 0;
 const axios_1 = __importDefault(require("axios"));
-const internal_constants_1 = require("../authentication/internal/internal.constants");
+const internal_constants_1 = require("./modules/authentication/internal/internal.constants");
+/**
+ * Create an axios instance
+ * @param options - the options for the axios instance
+ * @returns {AxiosInstance} the created axios instance
+ */
 const createAxios = (options) => {
     return axios_1.default.create({
         baseURL: options.baseUrl,

package/dist/env.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Environment variables
+ *
+ * @exports
+ * ENV_K8S_TOKEN
+ * ENV_JWT_SECRET
+ * ENV_MONGO_SRV
+ * ENV_MONGO_USERNAME
+ * ENV_MONGO_PASSWORD
+ * ENV_MONGO_CERT_DIR
+ * ENV_MONGO_TLS_CA_CRT
+ * ENV_MONGO_TLS_TLS_CRT
+ * ENV_MONGO_TLS_TLS_KEY
+ */
 export declare const ENV_K8S_TOKEN = "K8S_TOKEN";
 export declare const ENV_JWT_SECRET = "JWT_SECRET";
 export declare const ENV_MONGO_SRV = "MONGO_SRV";

package/dist/env.js

@@ -1,4 +1,18 @@
 "use strict";
+/**
+ * Environment variables
+ *
+ * @exports
+ * ENV_K8S_TOKEN
+ * ENV_JWT_SECRET
+ * ENV_MONGO_SRV
+ * ENV_MONGO_USERNAME
+ * ENV_MONGO_PASSWORD
+ * ENV_MONGO_CERT_DIR
+ * ENV_MONGO_TLS_CA_CRT
+ * ENV_MONGO_TLS_TLS_CRT
+ * ENV_MONGO_TLS_TLS_KEY
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ENV_MONGO_TLS_TLS_KEY = exports.ENV_MONGO_TLS_TLS_CRT = exports.ENV_MONGO_TLS_CA_CRT = exports.ENV_MONGO_CERT_DIR = exports.ENV_MONGO_PASSWORD = exports.ENV_MONGO_USERNAME = exports.ENV_MONGO_SRV = exports.ENV_JWT_SECRET = exports.ENV_K8S_TOKEN = void 0;
 exports.ENV_K8S_TOKEN = 'K8S_TOKEN';

package/dist/exceptions/bad-body.exception.d.ts

@@ -1,5 +1,26 @@
-import { ErrorException } from '.';
+import { ErrorException, UseException } from '.';
+/**
+ * Custom exception for bad request body
+ * @class BadBodyException
+ * @extends {ErrorException}
+ */
 export declare class BadBodyException extends ErrorException {
+    /**
+     * Constructor for BadBodyException
+     * @param description - optional description for the exception
+     */
     constructor(description?: string);
 }
+/**
+ * Creates an ApiBadBody decorator with the given description
+ * @param description - optional description for the exception
+ * @returns A decorator that creates an API bad body
+ */
 export declare const ApiBadBody: (description?: string) => MethodDecorator & ClassDecorator;
+/**
+ * Creates a bad body exception with the given description and returns an array containing the Exception class and the ApiDecorator function.
+ *
+ * @param {string} description - The description for the bad body exception
+ * @return {UseException<typeof BadBodyException>} An array containing the Exception class and the ApiDecorator function
+ */
+export declare function useBadBodyException(description?: string): UseException<typeof BadBodyException>;

package/dist/exceptions/bad-body.exception.js

@@ -1,16 +1,57 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiBadBody = exports.BadBodyException = void 0;
+exports.useBadBodyException = exports.ApiBadBody = exports.BadBodyException = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const _1 = require(".");
+/** Status code for bad bodies */
 const status = common_1.HttpStatus.METHOD_NOT_ALLOWED;
+/** Description for bad bodies */
 const error = 'Bad Body';
+/**
+ * Custom exception for bad request body
+ * @class BadBodyException
+ * @extends {ErrorException}
+ */
 class BadBodyException extends _1.ErrorException {
+    /**
+     * Constructor for BadBodyException
+     * @param description - optional description for the exception
+     */
     constructor(description) {
         super(error, status, description);
     }
 }
 exports.BadBodyException = BadBodyException;
+/**
+ * Creates an ApiBadBody decorator with the given description
+ * @param description - optional description for the exception
+ * @returns A decorator that creates an API bad body
+ */
 const ApiBadBody = (description = error) => (0, swagger_1.ApiResponse)({ status, description });
 exports.ApiBadBody = ApiBadBody;
+/**
+ * Creates a bad body exception with the given description and returns an array containing the Exception class and the ApiDecorator function.
+ *
+ * @param {string} description - The description for the bad body exception
+ * @return {UseException<typeof BadBodyException>} An array containing the Exception class and the ApiDecorator function
+ */
+function useBadBodyException(description = error) {
+    /**
+     * Creates a bad body exception with the given description
+     * @class Exception
+     * @extends {BadBodyException}
+     */
+    class Exception extends BadBodyException {
+        /**
+         * Constructor for BadBodyException.
+         * @param desc - Description of the error.
+         */
+        constructor(desc = description) {
+            super(desc);
+        }
+    }
+    // Return an array containing the Exception class and the ApiDecorator function
+    return [Exception, () => (0, exports.ApiBadBody)(description)];
+}
+exports.useBadBodyException = useBadBodyException;

package/dist/exceptions/duplicate.exception.d.ts

@@ -1,5 +1,26 @@
-import { ErrorException } from '.';
+import { ErrorException, UseException } from '.';
+/**
+ * Represents an exception for duplicate errors.
+ * @class DuplicateException
+ * @extends {ErrorException}
+ */
 export declare class DuplicateException extends ErrorException {
+    /**
+     * Constructor for DuplicateException.
+     * @param description - Optional description for the exception.
+     */
     constructor(description?: string);
 }
+/**
+ * Creates an ApiDuplicate decorator with the given description
+ * @param description  - optional description for the exception
+ * @returns A decorator that creates an API duplicate
+ */
 export declare const ApiDuplicate: (description?: string) => MethodDecorator & ClassDecorator;
+/**
+ * Creates a duplicate exception with the given description and returns an array containing the Exception class and the ApiDecorator function.
+ *
+ * @param {string} description - The description for the duplicate exception
+ * @return {UseException<typeof DuplicateException>} An array containing the Exception class and the ApiDecorator function
+ */
+export declare function useDuplicateException(description?: string): UseException<typeof DuplicateException>;

package/dist/exceptions/duplicate.exception.js

@@ -1,16 +1,57 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiDuplicate = exports.DuplicateException = void 0;
+exports.useDuplicateException = exports.ApiDuplicate = exports.DuplicateException = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const _1 = require(".");
+/** Status code for duplicates */
 const status = common_1.HttpStatus.CONFLICT;
+/** Description for duplicates */
 const error = 'Duplicate';
+/**
+ * Represents an exception for duplicate errors.
+ * @class DuplicateException
+ * @extends {ErrorException}
+ */
 class DuplicateException extends _1.ErrorException {
+    /**
+     * Constructor for DuplicateException.
+     * @param description - Optional description for the exception.
+     */
     constructor(description) {
         super(error, status, description);
     }
 }
 exports.DuplicateException = DuplicateException;
+/**
+ * Creates an ApiDuplicate decorator with the given description
+ * @param description  - optional description for the exception
+ * @returns A decorator that creates an API duplicate
+ */
 const ApiDuplicate = (description = error) => (0, swagger_1.ApiResponse)({ status, description });
 exports.ApiDuplicate = ApiDuplicate;
+/**
+ * Creates a duplicate exception with the given description and returns an array containing the Exception class and the ApiDecorator function.
+ *
+ * @param {string} description - The description for the duplicate exception
+ * @return {UseException<typeof DuplicateException>} An array containing the Exception class and the ApiDecorator function
+ */
+function useDuplicateException(description = error) {
+    /**
+     * Creates a duplicate exception with the given description
+     * @class Exception
+     * @extends {DuplicateException}
+     */
+    class Exception extends DuplicateException {
+        /**
+         * Constructor for DuplicateException.
+         * @param desc - Description of the error.
+         */
+        constructor(desc = description) {
+            super(desc);
+        }
+    }
+    // Return an array containing the Exception class and the ApiDecorator function
+    return [Exception, () => (0, exports.ApiDuplicate)(description)];
+}
+exports.useDuplicateException = useDuplicateException;

package/dist/exceptions/index.d.ts

@@ -1,7 +1,25 @@
 import { HttpException } from '@nestjs/common';
+/**
+ * Custom error exception class
+ * @class ErrorException
+ * @extends {HttpException}
+ */
 export declare class ErrorException extends HttpException {
+    /**
+     * Constructor for ErrorException
+     * @param error - The error message
+     * @param status - The status code
+     * @param description - The description of the error
+     */
     constructor(error: string, status: number, description?: string);
 }
+/**
+ * Type representing the use of an exception
+ * @typedef {Array} UseException
+ * @property {typeof ErrorException} 0 - The type of error exception
+ * @property {Function} 1 - The method and class decorator
+ */
+export declare type UseException<T> = [T, () => MethodDecorator & ClassDecorator];
 export * from './bad-body.exception';
 export * from './duplicate.exception';
 export * from './not-found.exception';

package/dist/exceptions/index.js

@@ -16,7 +16,18 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorException = void 0;
 const common_1 = require("@nestjs/common");
+/**
+ * Custom error exception class
+ * @class ErrorException
+ * @extends {HttpException}
+ */
 class ErrorException extends common_1.HttpException {
+    /**
+     * Constructor for ErrorException
+     * @param error - The error message
+     * @param status - The status code
+     * @param description - The description of the error
+     */
     constructor(error, status, description) {
         super({ message: [description || error], status, error }, status);
     }

package/dist/exceptions/not-found.exception.d.ts

@@ -1,5 +1,26 @@
-import { ErrorException } from '.';
+import { ErrorException, UseException } from '.';
+/**
+ * Custom exception for not found errors.
+ * @class NotFoundException
+ * @extends {ErrorException}
+ */
 export declare class NotFoundException extends ErrorException {
+    /**
+     * Constructor for NotFoundException.
+     * @param description - Description of the error.
+     */
     constructor(description?: string);
 }
+/**
+ * Creates an ApiNotFound decorator with the given description
+ * @param description - Optional description for the exception
+ * @returns A decorator that creates an API not found
+ */
 export declare const ApiNotFound: (description?: string) => MethodDecorator & ClassDecorator;
+/**
+ * Creates a not found exception with the given description and returns an array containing the Exception class and the ApiDecorator function.
+ *
+ * @param {string} description - The description for the not found exception
+ * @return {UseException<typeof NotFoundException>} An array containing the Exception class and the ApiDecorator function
+ */
+export declare function useNotFoundException(description?: string): UseException<typeof NotFoundException>;

package/dist/exceptions/not-found.exception.js

@@ -1,16 +1,57 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiNotFound = exports.NotFoundException = void 0;
+exports.useNotFoundException = exports.ApiNotFound = exports.NotFoundException = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const _1 = require(".");
+/** Status code for not found */
 const status = common_1.HttpStatus.NOT_FOUND;
+/** Description for not found */
 const error = 'Not Found';
+/**
+ * Custom exception for not found errors.
+ * @class NotFoundException
+ * @extends {ErrorException}
+ */
 class NotFoundException extends _1.ErrorException {
+    /**
+     * Constructor for NotFoundException.
+     * @param description - Description of the error.
+     */
     constructor(description) {
         super(error, status, description);
     }
 }
 exports.NotFoundException = NotFoundException;
+/**
+ * Creates an ApiNotFound decorator with the given description
+ * @param description - Optional description for the exception
+ * @returns A decorator that creates an API not found
+ */
 const ApiNotFound = (description = error) => (0, swagger_1.ApiResponse)({ status, description });
 exports.ApiNotFound = ApiNotFound;
+/**
+ * Creates a not found exception with the given description and returns an array containing the Exception class and the ApiDecorator function.
+ *
+ * @param {string} description - The description for the not found exception
+ * @return {UseException<typeof NotFoundException>} An array containing the Exception class and the ApiDecorator function
+ */
+function useNotFoundException(description = error) {
+    /**
+     * Creates a not found exception with the given description
+     * @class Exception
+     * @extends {NotFoundException}
+     */
+    class Exception extends NotFoundException {
+        /**
+         * Constructor for NotFoundException.
+         * @param desc - Description of the error.
+         */
+        constructor(desc = description) {
+            super(desc);
+        }
+    }
+    // Return an array containing the Exception class and the ApiDecorator function
+    return [Exception, () => (0, exports.ApiNotFound)(description)];
+}
+exports.useNotFoundException = useNotFoundException;

package/dist/favicon.controller.d.ts

@@ -1,5 +1,17 @@
 import { Response } from 'express';
+/**
+ * The FaviconController class
+ *
+ * @class FaviconController
+ */
 export declare class FaviconController {
+    /** The Axios instance to make requests */
     private axios;
+    /**
+     * A function to asynchronously get the favicon and pipe the data to the response.
+     *
+     * @param {type} res - The response object to pipe the data to
+     * @return {Promise<void>} Promise that resolves when the data has been piped to the response
+     */
     getFavicon(res: Response): Promise<void>;
 }

package/dist/favicon.controller.js

@@ -28,11 +28,24 @@ exports.FaviconController = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const axios_1 = __importDefault(require("axios"));
+/** The URL of the favicon image */
 const favicon = 'https://file.svi-itlab.com/650d514c58cbe60df3494bc0';
+/**
+ * The FaviconController class
+ *
+ * @class FaviconController
+ */
 let FaviconController = class FaviconController {
     constructor() {
+        /** The Axios instance to make requests */
         this.axios = axios_1.default.create();
     }
+    /**
+     * A function to asynchronously get the favicon and pipe the data to the response.
+     *
+     * @param {type} res - The response object to pipe the data to
+     * @return {Promise<void>} Promise that resolves when the data has been piped to the response
+     */
     getFavicon(res) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.axios.get(favicon, { responseType: 'stream' });

package/dist/guards/perms.guard.d.ts

@@ -1,11 +1,39 @@
 import { CanActivate, ExecutionContext, HttpException } from '@nestjs/common';
 import { Reflector } from '@nestjs/core';
+/**
+ * Permissions guard
+ * @class PermsGuard
+ * @implements {CanActivate}
+ */
 export declare class PermsGuard implements CanActivate {
     private readonly reflector;
+    /**
+     * Constructor for the PermsGuard
+     * @param reflector - the reflector
+     */
     constructor(reflector: Reflector);
+    /**
+     * Checks if the user has the required permissions to access the resource.
+     *
+     * @param {ExecutionContext} ctx - the execution context
+     * @return {boolean} whether the user has the required permissions
+     */
     canActivate(ctx: ExecutionContext): boolean;
 }
+/**
+ * Insufficient permissions exception
+ * @class InsufficientPermissionsException
+ * @extends {HttpException}
+ */
 export declare class InsufficientPermissionsException extends HttpException {
+    /**
+     * Constructor for the InsufficientPermissionsException
+     */
     constructor();
 }
+/**
+ * Create an ApiPerms decorator with the given permissions
+ * @param perms - the permissions required
+ * @returns An ApiPerms decorator
+ */
 export declare const Perms: (...perms: string[]) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/dist/guards/perms.guard.js

@@ -13,23 +13,48 @@ exports.Perms = exports.InsufficientPermissionsException = exports.PermsGuard =
 const common_1 = require("@nestjs/common");
 const core_1 = require("@nestjs/core");
 const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
 const itlab_functions_1 = require("itlab-functions");
 const jwt_guard_1 = require("../modules/authentication/jwt/jwt.guard");
+/** Metadata key for permissions */
 const META = 'itlab-internal-perms-guard';
+/** Insufficient permissions */
 const description = 'Insufficient permissions';
+/** Insufficient permissions status */
 const status = common_1.HttpStatus.FORBIDDEN;
+/**
+ * Permissions guard
+ * @class PermsGuard
+ * @implements {CanActivate}
+ */
 let PermsGuard = class PermsGuard {
+    /**
+     * Constructor for the PermsGuard
+     * @param reflector - the reflector
+     */
     constructor(reflector) {
         this.reflector = reflector;
     }
+    /**
+     * Checks if the user has the required permissions to access the resource.
+     *
+     * @param {ExecutionContext} ctx - the execution context
+     * @return {boolean} whether the user has the required permissions
+     */
     canActivate(ctx) {
+        // Retrieve the permissions required for the handler from metadata
         let perms = this.reflector.get(META, ctx.getHandler());
+        // If no permissions are required, allow access
         if (!perms || !Array.isArray(perms) || perms.length === 0)
             return true;
+        // Retrieve the user from the request
         const { user } = ctx.switchToHttp().getRequest();
-        const _ = user && user.perms && Array.isArray(user.perms) && user.perms.length > 0;
-        if (_ && (0, itlab_functions_1.hasPermission)(perms, user.perms))
+        // Check if the user is valid and has at least one permission
+        const userValid = user && (0, class_validator_1.minLength)(user.perms, 1);
+        // If the user is valid and has the required permissions, allow access
+        if (userValid && (0, itlab_functions_1.hasPermission)(perms, user.perms))
             return true;
+        // If the user does not have the required permissions, throw an exception
         throw new InsufficientPermissionsException();
     }
 };
@@ -38,7 +63,15 @@ PermsGuard = __decorate([
     __metadata("design:paramtypes", [core_1.Reflector])
 ], PermsGuard);
 exports.PermsGuard = PermsGuard;
+/**
+ * Insufficient permissions exception
+ * @class InsufficientPermissionsException
+ * @extends {HttpException}
+ */
 let InsufficientPermissionsException = class InsufficientPermissionsException extends common_1.HttpException {
+    /**
+     * Constructor for the InsufficientPermissionsException
+     */
     constructor() {
         super(description, status);
     }
@@ -48,5 +81,10 @@ InsufficientPermissionsException = __decorate([
     __metadata("design:paramtypes", [])
 ], InsufficientPermissionsException);
 exports.InsufficientPermissionsException = InsufficientPermissionsException;
+/**
+ * Create an ApiPerms decorator with the given permissions
+ * @param perms - the permissions required
+ * @returns An ApiPerms decorator
+ */
 const Perms = (...perms) => (0, common_1.applyDecorators)((0, common_1.SetMetadata)(META, perms), (0, common_1.UseGuards)(jwt_guard_1.JwtGuard, PermsGuard), (0, swagger_1.ApiBearerAuth)(), (0, swagger_1.ApiResponse)({ description: `${description} (${perms.join(', ')})`, status }));
 exports.Perms = Perms;

package/dist/guards/puplic.guard.d.ts

@@ -1,2 +1,7 @@
+/** Metadata key for public routes */
 export declare const IS_PUBLIC_META = "itlab-public-guard";
+/**
+ * Marks a route as public and allows it to be accessed without authentication
+ * @returns An override of the ApiBearerAuth decorator
+ */
 export declare const Public: () => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/dist/guards/puplic.guard.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Public = exports.IS_PUBLIC_META = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
+/** Metadata key for public routes */
 exports.IS_PUBLIC_META = 'itlab-public-guard';
+/**
+ * Marks a route as public and allows it to be accessed without authentication
+ * @returns An override of the ApiBearerAuth decorator
+ */
 const Public = () => (0, common_1.applyDecorators)((0, common_1.SetMetadata)(exports.IS_PUBLIC_META, true), (0, swagger_1.ApiBearerAuth)(), (0, swagger_1.ApiUnauthorizedResponse)({ description: "Public endpoint, won't be thrown" }));
 exports.Public = Public;

package/dist/http.logger.d.ts

@@ -1,2 +1,8 @@
 import { INestApplication } from '@nestjs/common';
+/**
+ * Middleware for logging HTTP requests and responses.
+ *
+ * @param {INestApplication} app - the Nest application instance
+ * @return {void}
+ */
 export declare function useHttpLogger(app: INestApplication): void;

package/dist/http.logger.js

@@ -2,14 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useHttpLogger = void 0;
 const common_1 = require("@nestjs/common");
+/**
+ * Middleware for logging HTTP requests and responses.
+ *
+ * @param {INestApplication} app - the Nest application instance
+ * @return {void}
+ */
 function useHttpLogger(app) {
     app.use((req, res, next) => {
         const { method, url } = req;
+        // URLs to ignore from logging
         const ignore = ['/alive', '/favicon.ico'];
         if (url.includes('swagger') || url.startsWith('/api') || ignore.includes(url)) {
             next();
             return;
         }
+        // Log the response after it's finished
         res.on('finish', () => {
             const { statusCode, statusMessage } = res;
             const message = `${method} ${url} - ${statusCode} (${statusMessage})`;
@@ -17,7 +25,7 @@ function useHttpLogger(app) {
             if (!ignore.includes(url))
                 new common_1.Logger('HTTP')[level](message);
         });
-        next();
+        next(); // Continue to the next middleware
     });
 }
 exports.useHttpLogger = useHttpLogger;

package/dist/index.d.ts

@@ -4,7 +4,10 @@ export * from './guards';
 export * from './http.logger';
 export * from './interceptors';
 export * from './liveness.probe';
+export * from './models';
 export * from './modules';
 export * from './pipes';
+export * from './schema.transformer';
 export * from './swagger.config';
-export * from './virtuals';
+export * from './transform';
+export * from './virtuals.factory';

package/dist/index.js

@@ -20,7 +20,10 @@ __exportStar(require("./guards"), exports);
 __exportStar(require("./http.logger"), exports);
 __exportStar(require("./interceptors"), exports);
 __exportStar(require("./liveness.probe"), exports);
+__exportStar(require("./models"), exports);
 __exportStar(require("./modules"), exports);
 __exportStar(require("./pipes"), exports);
+__exportStar(require("./schema.transformer"), exports);
 __exportStar(require("./swagger.config"), exports);
-__exportStar(require("./virtuals"), exports);
+__exportStar(require("./transform"), exports);
+__exportStar(require("./virtuals.factory"), exports);