itlab-internal-services 2.2.1 → 2.3.0

package/dist/modules/authentication/authentication.module.d.ts

@@ -1,7 +1,21 @@
 import { DynamicModule } from '@nestjs/common';
 export interface AuthenticationModuleOptions {
+    /**
+     * If "true", registers `AuthenticationModule` as a global module.
+     * See: https://docs.nestjs.com/modules#global-modules
+     */
     isGlobal?: boolean;
 }
+/**
+ * Authentication module
+ * @class AuthenticationModule
+ */
 export declare class AuthenticationModule {
+    /**
+     * Create a new module with the provided options.
+     *
+     * @param {AuthenticationModuleOptions} options - optional options for the authentication module
+     * @return {DynamicModule} the newly created dynamic module
+     */
     static forRoot(options?: AuthenticationModuleOptions): DynamicModule;
 }

package/dist/modules/authentication/authentication.module.js

@@ -11,7 +11,17 @@ exports.AuthenticationModule = void 0;
 const common_1 = require("@nestjs/common");
 const internal_strategy_1 = require("./internal/internal.strategy");
 const jwt_strategy_1 = require("./jwt/jwt.strategy");
+/**
+ * Authentication module
+ * @class AuthenticationModule
+ */
 let AuthenticationModule = AuthenticationModule_1 = class AuthenticationModule {
+    /**
+     * Create a new module with the provided options.
+     *
+     * @param {AuthenticationModuleOptions} options - optional options for the authentication module
+     * @return {DynamicModule} the newly created dynamic module
+     */
     static forRoot(options) {
         return {
             global: options ? options.isGlobal : false,

package/dist/modules/authentication/internal/internal.constants.d.ts

@@ -1,5 +1,9 @@
 import { HttpStatus } from '@nestjs/common';
+/** Header key for internal authentication */
 export declare const INTERNAL_HEADER_KEY = "X-itlab-k8s-auth";
+/** Internal authentication strategy name */
 export declare const INTERNAL_STRATEGY_NAME = "itlab-internal-auth";
+/** Internal authentication description on error */
 export declare const INTERNAL_DESCRIPTION = "Application unauthorized";
+/** Internal authentication status on error */
 export declare const INTERNAL_STATUS = HttpStatus.FORBIDDEN;

package/dist/modules/authentication/internal/internal.constants.js

@@ -2,7 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.INTERNAL_STATUS = exports.INTERNAL_DESCRIPTION = exports.INTERNAL_STRATEGY_NAME = exports.INTERNAL_HEADER_KEY = void 0;
 const common_1 = require("@nestjs/common");
+/** Header key for internal authentication */
 exports.INTERNAL_HEADER_KEY = 'X-itlab-k8s-auth';
+/** Internal authentication strategy name */
 exports.INTERNAL_STRATEGY_NAME = 'itlab-internal-auth';
+/** Internal authentication description on error */
 exports.INTERNAL_DESCRIPTION = 'Application unauthorized';
+/** Internal authentication status on error */
 exports.INTERNAL_STATUS = common_1.HttpStatus.FORBIDDEN;

package/dist/modules/authentication/internal/internal.decorators.d.ts

@@ -1 +1,5 @@
+/**
+ * Creates an ApiBasicAuth decorator
+ * @returns An ApiBasicAuth decorator
+ */
 export declare const Internal: () => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/dist/modules/authentication/internal/internal.decorators.js

@@ -5,5 +5,9 @@ const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const internal_constants_1 = require("./internal.constants");
 const internal_guard_1 = require("./internal.guard");
+/**
+ * Creates an ApiBasicAuth decorator
+ * @returns An ApiBasicAuth decorator
+ */
 const Internal = () => (0, common_1.applyDecorators)((0, swagger_1.ApiBasicAuth)(internal_constants_1.INTERNAL_HEADER_KEY), (0, common_1.UseGuards)(internal_guard_1.InternalGuard), (0, swagger_1.ApiResponse)({ description: internal_constants_1.INTERNAL_DESCRIPTION, status: internal_constants_1.INTERNAL_STATUS }));
 exports.Internal = Internal;

package/dist/modules/authentication/internal/internal.guard.d.ts

@@ -1,4 +1,9 @@
 declare const InternalGuard_base: import("@nestjs/passport").Type<import("@nestjs/passport").IAuthGuard>;
+/**
+ * Internal authentication guard
+ * @class InternalGuard
+ * @extends {AuthGuard}
+ */
 export declare class InternalGuard extends InternalGuard_base {
 }
 export {};

package/dist/modules/authentication/internal/internal.guard.js

@@ -10,6 +10,11 @@ exports.InternalGuard = void 0;
 const common_1 = require("@nestjs/common");
 const passport_1 = require("@nestjs/passport");
 const internal_constants_1 = require("./internal.constants");
+/**
+ * Internal authentication guard
+ * @class InternalGuard
+ * @extends {AuthGuard}
+ */
 let InternalGuard = class InternalGuard extends (0, passport_1.AuthGuard)(internal_constants_1.INTERNAL_STRATEGY_NAME) {
 };
 InternalGuard = __decorate([

package/dist/modules/authentication/internal/internal.strategy.d.ts

@@ -2,9 +2,26 @@ import { ConfigService } from '@nestjs/config';
 import { Request } from 'express';
 import { Strategy, VerifiedCallback } from 'passport-custom';
 declare const InternalStrategy_base: new (...args: any[]) => Strategy;
+/**
+ * Internal authentication strategy
+ * @class InternalStrategy
+ * @extends {PassportStrategy}
+ */
 export declare class InternalStrategy extends InternalStrategy_base {
     private readonly configService;
+    /**
+     * Constructor for initializing the ConfigService.
+     *
+     * @param {ConfigService} configService - the configuration service
+     */
     constructor(configService: ConfigService);
+    /**
+     * Check if requester is allowed to access the route by comparing the token
+     *
+     * @param {Request} req - the request object
+     * @param {VerifiedCallback} done - callback function for when the validation is done
+     * @return {void} no return value
+     */
     validate(req: Request, done: VerifiedCallback): void;
 }
 export {};

package/dist/modules/authentication/internal/internal.strategy.js

@@ -16,11 +16,28 @@ const passport_1 = require("@nestjs/passport");
 const passport_custom_1 = require("passport-custom");
 const env_1 = require("../../../env");
 const internal_constants_1 = require("./internal.constants");
+/**
+ * Internal authentication strategy
+ * @class InternalStrategy
+ * @extends {PassportStrategy}
+ */
 let InternalStrategy = class InternalStrategy extends (0, passport_1.PassportStrategy)(passport_custom_1.Strategy, internal_constants_1.INTERNAL_STRATEGY_NAME) {
+    /**
+     * Constructor for initializing the ConfigService.
+     *
+     * @param {ConfigService} configService - the configuration service
+     */
     constructor(configService) {
         super();
         this.configService = configService;
     }
+    /**
+     * Check if requester is allowed to access the route by comparing the token
+     *
+     * @param {Request} req - the request object
+     * @param {VerifiedCallback} done - callback function for when the validation is done
+     * @return {void} no return value
+     */
     validate(req, done) {
         const headerToken = req.header(internal_constants_1.INTERNAL_HEADER_KEY);
         const token = this.configService.getOrThrow(env_1.ENV_K8S_TOKEN);

package/dist/modules/authentication/jwt/jwt.constants.d.ts

@@ -1,8 +1,28 @@
 import { HttpStatus } from '@nestjs/common';
+/** The name of the JWT strategy */
 export declare const JWT_STRATEGY_NAME = "itlab-jwt-auth";
+/** The description of a failed JWT strategy */
 export declare const JWT_DESCRIPTION = "Unauthorized";
+/** The status code of a failed JWT strategy */
 export declare const JWT_STATUS = HttpStatus.UNAUTHORIZED;
+/**
+ * Represents a lab account with id and permissions.
+ * @class LabAccount
+ * @property {string} id - The unique identifier for the account.
+ * @property {string[]} perms - The array of permissions for the account.
+ * @property {string} [username] - Optional: The username for the account.
+ * @property {string} [email] - Optional: The email for the account.
+ * @property {string} [avatar] - Optional: The avatar for the account.
+ */
 export declare class LabAccount {
+    /** The unique identifier for the account. */
     id: string;
+    /** The array of permissions for the account. */
     perms: string[];
+    /** Optional: The username for the account. */
+    username?: string;
+    /** Optional: The email for the account. */
+    email?: string;
+    /** Optional: The avatar for the account. */
+    avatar?: string;
 }

package/dist/modules/authentication/jwt/jwt.constants.js

@@ -2,9 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LabAccount = exports.JWT_STATUS = exports.JWT_DESCRIPTION = exports.JWT_STRATEGY_NAME = void 0;
 const common_1 = require("@nestjs/common");
+/** The name of the JWT strategy */
 exports.JWT_STRATEGY_NAME = 'itlab-jwt-auth';
+/** The description of a failed JWT strategy */
 exports.JWT_DESCRIPTION = 'Unauthorized';
+/** The status code of a failed JWT strategy */
 exports.JWT_STATUS = common_1.HttpStatus.UNAUTHORIZED;
+/**
+ * Represents a lab account with id and permissions.
+ * @class LabAccount
+ * @property {string} id - The unique identifier for the account.
+ * @property {string[]} perms - The array of permissions for the account.
+ * @property {string} [username] - Optional: The username for the account.
+ * @property {string} [email] - Optional: The email for the account.
+ * @property {string} [avatar] - Optional: The avatar for the account.
+ */
 class LabAccount {
 }
 exports.LabAccount = LabAccount;

package/dist/modules/authentication/jwt/jwt.decorators.d.ts

@@ -1,5 +1,17 @@
+import { LabAccount } from './jwt.constants';
+/**
+ * Creates an ApiJwt decorator
+ * @returns A decorator that creates an API JWT
+ */
 export declare const Jwt: () => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
-export declare const Account: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;
-export declare const AccountId: () => ParameterDecorator;
-export declare const AccountPerms: () => ParameterDecorator;
+/**
+ * Used to parse a authorized account from the request header
+ * @param {string} attr - Optional: The attribute of the account to extract
+ * @returns The extracted account or attr of the account
+ */
+export declare const Account: (...dataOrPipes: (keyof LabAccount | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;
+/**
+ * Used to parse a JWT token from the request header
+ * @returns The extracted JWT token
+ */
 export declare const JwtToken: (...dataOrPipes: any[]) => ParameterDecorator;

package/dist/modules/authentication/jwt/jwt.decorators.js

@@ -1,20 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JwtToken = exports.AccountPerms = exports.AccountId = exports.Account = exports.Jwt = void 0;
+exports.JwtToken = exports.Account = exports.Jwt = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const jwt_constants_1 = require("./jwt.constants");
 const jwt_guard_1 = require("./jwt.guard");
+/**
+ * Creates an ApiJwt decorator
+ * @returns A decorator that creates an API JWT
+ */
 const Jwt = () => (0, common_1.applyDecorators)((0, swagger_1.ApiBearerAuth)(), (0, common_1.UseGuards)(jwt_guard_1.JwtGuard), (0, swagger_1.ApiUnauthorizedResponse)({ description: jwt_constants_1.JWT_DESCRIPTION, status: jwt_constants_1.JWT_STATUS }));
 exports.Jwt = Jwt;
-exports.Account = (0, common_1.createParamDecorator)((param, ctx) => {
+/**
+ * Used to parse a authorized account from the request header
+ * @param {string} attr - Optional: The attribute of the account to extract
+ * @returns The extracted account or attr of the account
+ */
+exports.Account = (0, common_1.createParamDecorator)((attr, ctx) => {
     const { user } = ctx.switchToHttp().getRequest();
-    return param ? user === null || user === void 0 ? void 0 : user[param] : user;
+    return attr ? user === null || user === void 0 ? void 0 : user[attr] : user;
 });
-const AccountId = () => (0, exports.Account)('id');
-exports.AccountId = AccountId;
-const AccountPerms = () => (0, exports.Account)('perms');
-exports.AccountPerms = AccountPerms;
+/**
+ * Used to parse a JWT token from the request header
+ * @returns The extracted JWT token
+ */
 exports.JwtToken = (0, common_1.createParamDecorator)((_, ctx) => {
     const h = ctx.switchToHttp().getRequest().header('Authorization');
     return h.replace('Bearer ', '');

package/dist/modules/authentication/jwt/jwt.guard.d.ts

@@ -1,9 +1,24 @@
 import { ExecutionContext } from '@nestjs/common';
 import { Reflector } from '@nestjs/core';
 declare const JwtGuard_base: import("@nestjs/passport").Type<import("@nestjs/passport").IAuthGuard>;
+/**
+ * JWT authentication guard
+ * @class JwtGuard
+ * @extends {AuthGuard}
+ */
 export declare class JwtGuard extends JwtGuard_base {
     private readonly reflector;
+    /**
+     * Constructor for the JwtGuard.
+     *
+     * @param {Reflector} reflector - the reflector object
+     */
     constructor(reflector: Reflector);
+    /**
+     * Check if requester is allowed to access the route
+     * @param context - The execution context
+     * @returns A boolean indicating if the route is allowed to be accessed
+     */
     canActivate(context: ExecutionContext): boolean | Promise<boolean> | import("rxjs").Observable<boolean>;
 }
 export {};

package/dist/modules/authentication/jwt/jwt.guard.js

@@ -15,18 +15,35 @@ const core_1 = require("@nestjs/core");
 const passport_1 = require("@nestjs/passport");
 const puplic_guard_1 = require("../../../guards/puplic.guard");
 const jwt_constants_1 = require("./jwt.constants");
+/**
+ * JWT authentication guard
+ * @class JwtGuard
+ * @extends {AuthGuard}
+ */
 let JwtGuard = class JwtGuard extends (0, passport_1.AuthGuard)(jwt_constants_1.JWT_STRATEGY_NAME) {
+    /**
+     * Constructor for the JwtGuard.
+     *
+     * @param {Reflector} reflector - the reflector object
+     */
     constructor(reflector) {
         super();
         this.reflector = reflector;
     }
+    /**
+     * Check if requester is allowed to access the route
+     * @param context - The execution context
+     * @returns A boolean indicating if the route is allowed to be accessed
+     */
     canActivate(context) {
+        // Check if the route is marked as public
         const isPublic = this.reflector.getAllAndOverride(puplic_guard_1.IS_PUBLIC_META, [
             context.getHandler(),
             context.getClass(),
         ]);
         if (isPublic)
             return true;
+        // If not marked as public, use the parent canActivate method
         return super.canActivate(context);
     }
 };

package/dist/modules/authentication/jwt/jwt.strategy.d.ts

@@ -1,9 +1,24 @@
 import { ConfigService } from '@nestjs/config';
 import { LabAccount } from './jwt.constants';
 declare const JwtStrategy_base: new (...args: any[]) => any;
+/**
+ * JWT authentication strategy
+ * @class JwtStrategy
+ * @extends {PassportStrategy}
+ */
 export declare class JwtStrategy extends JwtStrategy_base {
-    private readonly configService;
+    /**
+     * Constructor for creating a new instance of JwtStrategy
+     *
+     * @param {ConfigService} configService - the configuration service
+     */
     constructor(configService: ConfigService);
+    /**
+     * Validate the payload and return a LabAccount object.
+     *
+     * @param {any} payload - the payload to validate
+     * @return {LabAccount} the validated LabAccount object
+     */
     validate(payload: any): LabAccount;
 }
 export {};

package/dist/modules/authentication/jwt/jwt.strategy.js

@@ -16,14 +16,29 @@ const passport_1 = require("@nestjs/passport");
 const passport_jwt_1 = require("passport-jwt");
 const env_1 = require("../../../env");
 const jwt_constants_1 = require("./jwt.constants");
+/**
+ * JWT authentication strategy
+ * @class JwtStrategy
+ * @extends {PassportStrategy}
+ */
 let JwtStrategy = class JwtStrategy extends (0, passport_1.PassportStrategy)(passport_jwt_1.Strategy, jwt_constants_1.JWT_STRATEGY_NAME) {
+    /**
+     * Constructor for creating a new instance of JwtStrategy
+     *
+     * @param {ConfigService} configService - the configuration service
+     */
     constructor(configService) {
         super({
             jwtFromRequest: passport_jwt_1.ExtractJwt.fromAuthHeaderAsBearerToken(),
             secretOrKey: configService.getOrThrow(env_1.ENV_JWT_SECRET),
         });
-        this.configService = configService;
     }
+    /**
+     * Validate the payload and return a LabAccount object.
+     *
+     * @param {any} payload - the payload to validate
+     * @return {LabAccount} the validated LabAccount object
+     */
     validate(payload) {
         return { id: payload.id, perms: payload.perms || [] };
     }

package/dist/modules/database/database.module-options.d.ts

@@ -1,4 +1,10 @@
+/**
+ * Database module options
+ * @interface DatabaseModuleOptions
+ */
 export interface DatabaseModuleOptions {
+    /** The name of the application */
     appName: string;
+    /** The name of the database */
     dbName: string;
 }

package/dist/modules/database/database.module.d.ts

@@ -1,6 +1,25 @@
 import { DynamicModule } from '@nestjs/common';
+import { ModelDefinition } from '@nestjs/mongoose';
 import { DatabaseModuleOptions } from './database.module-options';
+/**
+ * Database module
+ * @class DatabaseModule
+ */
 export declare class DatabaseModule {
+    /** The Logger instance */
     private static logger;
+    /**
+     * Register mongodb models to use in the module
+     *
+     * @param {ModelDefinition[]} models - array of model definitions
+     * @return {DynamicModule} Module with registered models
+     */
+    static forFeature(...models: ModelDefinition[]): DynamicModule;
+    /**
+     * Creates a DatabaseModule for the root, with the provided options
+     *
+     * @param {DatabaseModuleOptions} options - the options for the DatabaseModule
+     * @return {DynamicModule} the DatabaseModule
+     */
     static forRoot(options: DatabaseModuleOptions): DynamicModule;
 }

package/dist/modules/database/database.module.js

@@ -57,7 +57,26 @@ const env_1 = require("../../env");
 const model_service_1 = require("./model-service/model.service");
 const populate_service_1 = require("./populate-service/populate.service");
 const service_mapper_service_1 = require("./service-mapper-service/service-mapper.service");
+/**
+ * Database module
+ * @class DatabaseModule
+ */
 let DatabaseModule = DatabaseModule_1 = class DatabaseModule {
+    /**
+     * Register mongodb models to use in the module
+     *
+     * @param {ModelDefinition[]} models - array of model definitions
+     * @return {DynamicModule} Module with registered models
+     */
+    static forFeature(...models) {
+        return mongoose_1.MongooseModule.forFeature(models);
+    }
+    /**
+     * Creates a DatabaseModule for the root, with the provided options
+     *
+     * @param {DatabaseModuleOptions} options - the options for the DatabaseModule
+     * @return {DynamicModule} the DatabaseModule
+     */
     static forRoot(options) {
         return {
             global: true,
@@ -76,6 +95,7 @@ let DatabaseModule = DatabaseModule_1 = class DatabaseModule {
                         const tlsDir = (0, path_1.join)(process.cwd(), configService.get(env_1.ENV_MONGO_CERT_DIR, 'mongo-tls'));
                         const tlsCAFile = (0, path_1.join)(tlsDir, 'hub-services-mongodb.ca.pem');
                         const tlsCertificateKeyFile = (0, path_1.join)(tlsDir, 'hub-services-mongodb.cert-key.pem');
+                        // Production
                         if (production) {
                             this.logger.log('Running in production mode... Creating certificates');
                             (0, fs_1.mkdirSync)(tlsDir, { recursive: true });
@@ -89,6 +109,7 @@ let DatabaseModule = DatabaseModule_1 = class DatabaseModule {
                             (0, fs_1.writeFileSync)(tlsCertificateKeyFile, `${tlsCrt}\n${tlsKey}`);
                             this.logger.log('Created Client Certificate and Key (.pem)');
                         }
+                        // Development
                         else {
                             this.logger.log(`Running in development mode... Using local certificates in ${tlsDir}`);
                             if (!(0, fs_1.existsSync)(tlsCAFile))
@@ -117,30 +138,50 @@ let DatabaseModule = DatabaseModule_1 = class DatabaseModule {
         };
     }
 };
+/** The Logger instance */
 DatabaseModule.logger = new common_1.Logger(DatabaseModule_1.name);
 DatabaseModule = DatabaseModule_1 = __decorate([
     (0, common_1.Module)({})
 ], DatabaseModule);
 exports.DatabaseModule = DatabaseModule;
+/**
+ * Controller for kubernetes liveness probe
+ * @class DatabaseLivenessProbe
+ */
 let DatabaseLivenessProbe = class DatabaseLivenessProbe {
+    /**
+     * Constructor
+     * @param connection - The connection to the database
+     */
     constructor(connection) {
         this.connection = connection;
     }
+    /**
+     * Checks if the database is connected
+     *
+     * @param {Response} response - The response object
+     * @return {Promise<void>} Promise that resolves to void
+     */
     getAlive(response) {
         return __awaiter(this, void 0, void 0, function* () {
+            // If the database is not connected, return an error
             if (!this.connection || this.connection.readyState !== 1) {
                 response.status(500).send('Not connected to MongoDB');
                 return;
             }
             try {
+                // Ping the database
                 const result = yield this.connection.db.admin().ping();
+                // If the ping was successful, return 200
                 if (!!((result === null || result === void 0 ? void 0 : result.ok) === 1)) {
                     response.status(200).send({ ok: 1, db: 1 });
                     return;
                 }
+                // Otherwise, return an error
                 throw new Error('Could not connect to MongoDB');
             }
             catch (error) {
+                // If the ping failed, return an error
                 response.status(500).send("Couldn't connect to MongoDB");
             }
         });

package/dist/modules/database/index.js

@@ -1,11 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServiceMapperService = exports.PopulateService = exports.ModelService = exports.DatabaseModule = void 0;
+/*
+ * Database Module
+ */
 var database_module_1 = require("./database.module");
 Object.defineProperty(exports, "DatabaseModule", { enumerable: true, get: function () { return database_module_1.DatabaseModule; } });
+/*
+ * Model Service
+ */
 var model_service_1 = require("./model-service/model.service");
 Object.defineProperty(exports, "ModelService", { enumerable: true, get: function () { return model_service_1.ModelService; } });
+/*
+ * Populate Service
+ */
 var populate_service_1 = require("./populate-service/populate.service");
 Object.defineProperty(exports, "PopulateService", { enumerable: true, get: function () { return populate_service_1.PopulateService; } });
+/*
+ * ServiceMapper Service
+ */
 var service_mapper_service_1 = require("./service-mapper-service/service-mapper.service");
 Object.defineProperty(exports, "ServiceMapperService", { enumerable: true, get: function () { return service_mapper_service_1.ServiceMapperService; } });