itlab-internal-services 2.15.7 → 2.16.1

package/dist/modules/search/search.module.js

@@ -1,62 +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 SearchModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchModule = void 0;
-const common_1 = require("@nestjs/common");
-const search_module_definition_1 = require("./search.module-definition");
-const search_service_1 = require("./search.service");
-/**
- * SearchModule
- *
- * Provides search functionality through indexing, deletion, and similarity search.
- * Connects to an external Meilisearch-based service.
- */
-let SearchModule = SearchModule_1 = class SearchModule {
-    /**
-     * Internal utility to generate the module configuration.
-     *
-     * @param {boolean} isGlobal - Whether the module should be globally scoped.
-     * @param {HubResource} resource - The resource associated with the module.
-     * @returns {DynamicModule} - Configured dynamic module.
-     */
-    static createModule(isGlobal, resource) {
-        return {
-            global: isGlobal,
-            module: SearchModule_1,
-            providers: [search_service_1.SearchService, { provide: search_module_definition_1.SEARCH_MODULE_RESOURCE_TOKEN, useValue: resource }],
-            exports: [search_service_1.SearchService],
-        };
-    }
-    /**
-     * Registers the module globally, making SearchService accessible application-wide.
-     *
-     * @param {HubResource} resource - The resource associated with the module.
-     * @returns {DynamicModule} - Global dynamic module instance.
-     */
-    static forRoot(resource) {
-        return this.createModule(true, resource);
-    }
-    /**
-     * Registers the module locally (non-global), restricting SearchService
-     * to the importing module's scope.
-     *
-     * @param {HubResource} resource - The resource associated with the module.
-     * @returns {DynamicModule} - Local dynamic module instance.
-     */
-    static register(resource) {
-        return this.createModule(false, resource);
-    }
-};
-exports.SearchModule = SearchModule;
-exports.SearchModule = SearchModule = SearchModule_1 = __decorate([
-    (0, common_1.Module)({
-        providers: [search_service_1.SearchService],
-        exports: [search_service_1.SearchService],
-    })
-], SearchModule);

package/dist/modules/search/search.service.d.ts

@@ -1,49 +0,0 @@
-import { ConfigService } from '@nestjs/config';
-import { HubResource } from '../../hub-resource.enum';
-import { AuthenticationModuleOptions } from '../authentication';
-import { IndexSearchDocumentDto } from './dtos';
-import { SearchDocument } from './models';
-/**
- * SearchService
- *
- * Handles indexing, deindexing, and similarity search for specified resource types.
- * Acts as a bridge to an internal search microservice (e.g., Meilisearch).
- */
-export declare class SearchService {
-    private readonly resource;
-    private readonly authOptions;
-    private readonly configService;
-    private readonly logger;
-    private readonly axiosInstance;
-    /**
-     * Initializes the SearchService with appropriate API client and settings.
-     *
-     * @param {HubResource} resource - Resource type injected via DI
-     * @param {AuthenticationModuleOptions} authOptions - Contains Kubernetes service account token
-     * @param {ConfigService} configService - Configuration service for environment checks
-     */
-    constructor(resource: HubResource, authOptions: AuthenticationModuleOptions, configService: ConfigService);
-    /**
-     * Indexes or updates a searchable document in the search index.
-     * Useful for ensuring resource changes are discoverable via search.
-     *
-     * @param {string} resourceId - Unique identifier of the resource.
-     * @param {IndexSearchDocumentDto} document - Document containing searchable content.
-     */
-    indexDocument(resourceId: string, document: IndexSearchDocumentDto): void;
-    /**
-     * Removes a resource from the search index.
-     * Ideal when the resource is deleted or should no longer be discoverable.
-     *
-     * @param {string} resourceId - Identifier of the resource to be deindexed.
-     */
-    removeDocumentFromIndex(resourceId: string): void;
-    /**
-     * Retrieves documents similar to the provided resource from the search index.
-     * Helps with content discovery and recommendations.
-     *
-     * @param {string} resourceId - Identifier of the base resource for similarity matching.
-     * @returns {Promise<SearchDocument[]>} - Array of documents similar to the given resource.
-     */
-    findSimilarDocuments(resourceId: string): Promise<SearchDocument[]>;
-}

package/dist/modules/search/search.service.js

@@ -1,120 +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); }
-};
-var SearchService_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchService = void 0;
-const common_1 = require("@nestjs/common");
-const config_1 = require("@nestjs/config");
-const create_internal_axios_client_function_1 = require("../../functions/create-internal-axios-client.function");
-const hub_resource_enum_1 = require("../../hub-resource.enum");
-const authentication_1 = require("../authentication");
-const search_module_definition_1 = require("./search.module-definition");
-/**
- * SearchService
- *
- * Handles indexing, deindexing, and similarity search for specified resource types.
- * Acts as a bridge to an internal search microservice (e.g., Meilisearch).
- */
-let SearchService = SearchService_1 = class SearchService {
-    /**
-     * Initializes the SearchService with appropriate API client and settings.
-     *
-     * @param {HubResource} resource - Resource type injected via DI
-     * @param {AuthenticationModuleOptions} authOptions - Contains Kubernetes service account token
-     * @param {ConfigService} configService - Configuration service for environment checks
-     */
-    constructor(resource, authOptions, configService) {
-        this.resource = resource;
-        this.authOptions = authOptions;
-        this.configService = configService;
-        this.logger = new common_1.Logger(SearchService_1.name);
-        const isProduction = this.configService.get('NODE_ENV') === 'production';
-        // Construct base URL conditionally based on environment.
-        const baseUrl = isProduction
-            ? 'http://organisation-hub-search-service.organisation-hub-services.svc.cluster.local:3000/internal/'
-            : 'https://services.svi-itlab.com/search/internal/';
-        // Initialize axios instance with k8s token and appropriate URL.
-        this.axiosInstance = (0, create_internal_axios_client_function_1.createInternalAxiosClient)({
-            k8sToken: this.authOptions.k8sToken,
-            baseUrl: `${baseUrl}${this.resource}/`,
-        });
-    }
-    // ─────────────────────────────────────────────
-    // Indexing Operations
-    // ─────────────────────────────────────────────
-    /**
-     * Indexes or updates a searchable document in the search index.
-     * Useful for ensuring resource changes are discoverable via search.
-     *
-     * @param {string} resourceId - Unique identifier of the resource.
-     * @param {IndexSearchDocumentDto} document - Document containing searchable content.
-     */
-    indexDocument(resourceId, document) {
-        this.logger.log(`Indexing resource "${this.resource}" with ID: ${resourceId}`);
-        this.axiosInstance
-            .post(`${resourceId}`, document)
-            .then(() => {
-            this.logger.log(`Indexed ${this.resource} (${resourceId}) successfully.`);
-        })
-            .catch(({ response }) => {
-            this.logger.error(`Failed to index ${this.resource} (${resourceId}): ${JSON.stringify(response === null || response === void 0 ? void 0 : response.data)}`);
-        });
-    }
-    /**
-     * Removes a resource from the search index.
-     * Ideal when the resource is deleted or should no longer be discoverable.
-     *
-     * @param {string} resourceId - Identifier of the resource to be deindexed.
-     */
-    removeDocumentFromIndex(resourceId) {
-        this.logger.log(`Deindexing resource "${this.resource}" with ID: ${resourceId}`);
-        this.axiosInstance
-            .delete(`${resourceId}`)
-            .then(() => {
-            this.logger.log(`Removed ${this.resource} (${resourceId}) from index.`);
-        })
-            .catch(({ response }) => {
-            this.logger.error(`Failed to remove ${this.resource} (${resourceId}) from index: ${JSON.stringify(response === null || response === void 0 ? void 0 : response.data)}`);
-        });
-    }
-    // ─────────────────────────────────────────────
-    // Similarity Search
-    // ─────────────────────────────────────────────
-    /**
-     * Retrieves documents similar to the provided resource from the search index.
-     * Helps with content discovery and recommendations.
-     *
-     * @param {string} resourceId - Identifier of the base resource for similarity matching.
-     * @returns {Promise<SearchDocument[]>} - Array of documents similar to the given resource.
-     */
-    async findSimilarDocuments(resourceId) {
-        this.logger.log(`Searching for documents similar to "${this.resource}" with ID: ${resourceId}`);
-        try {
-            const response = await this.axiosInstance.get(`${resourceId}/similar`);
-            this.logger.log(`Similar documents retrieved for ${this.resource} (${resourceId})`);
-            return response.data;
-        }
-        catch (error) {
-            this.logger.error(`Error retrieving similar documents for ${this.resource} (${resourceId}): ${error.message}`);
-            throw error;
-        }
-    }
-};
-exports.SearchService = SearchService;
-exports.SearchService = SearchService = SearchService_1 = __decorate([
-    (0, common_1.Injectable)(),
-    __param(0, (0, common_1.Inject)(search_module_definition_1.SEARCH_MODULE_RESOURCE_TOKEN)),
-    __param(1, (0, authentication_1.InjectAuthOptions)()),
-    __metadata("design:paramtypes", [String, Object, config_1.ConfigService])
-], SearchService);

package/dist/pipes/hub-id.pipe.d.ts

@@ -1,22 +0,0 @@
-import { ValidationOptions } from 'class-validator';
-/**
- * Creates a parameter decorator that validates a route parameter as a HubId.
- *
- * @param {string} parameterName - Name of the parameter to validate.
- * @returns {ParameterDecorator}
- */
-export declare function HubIdParam(parameterName: string): ParameterDecorator;
-/**
- * Combines Swagger metadata and error response for HubId parameters.
- *
- * @param {string} parameterName - Name of the parameter for docs/errors.
- * @returns {MethodDecorator}
- */
-export declare function ApiHubId(parameterName: string): MethodDecorator;
-/**
- * Decorator for validating DTO properties as HubId using class-validator.
- *
- * @param {ValidationOptions} [options] - Optional validation settings.
- * @returns {PropertyDecorator}
- */
-export declare function IsHubId(options?: ValidationOptions): PropertyDecorator;

package/dist/pipes/hub-resource.pipe.d.ts

@@ -1,22 +0,0 @@
-import { HubResource } from '../hub-resource.enum';
-/**
- * Decorator to validate and transform a route parameter as a HubResource.
- *
- * @param {string} parameterName - Name of the parameter to validate.
- * @returns {ParameterDecorator}
- */
-export declare function HubResourceParam(parameterName: string): ParameterDecorator;
-/**
- * Adds Swagger metadata and error documentation for HubResource parameters.
- *
- * @param {string} parameterName - Parameter name for docs/errors.
- * @returns {MethodDecorator & ClassDecorator}
- */
-export declare function ApiHubResource(parameterName: string): MethodDecorator & ClassDecorator;
-/**
- * Determines if a value is a valid HubResource.
- *
- * @param {unknown} value - value to validate.
- * @returns {boolean} - True if valid.
- */
-export declare function isHubResource(value: unknown): value is HubResource;

package/dist/pipes/mongo-id.pipe.d.ts

@@ -1,14 +0,0 @@
-/**
- * Decorator to validate and transform a parameter as a MongoId.
- *
- * @param {string} parameterName - Parameter name to validate.
- * @returns {ParameterDecorator}
- */
-export declare function MongoIdParam(parameterName: string): ParameterDecorator;
-/**
- * Applies Swagger metadata and error handling for MongoId parameters.
- *
- * @param {string} parameterName - Parameter name for docs/errors.
- * @returns {MethodDecorator & ClassDecorator}
- */
-export declare function ApiMongoId(parameterName: string): MethodDecorator & ClassDecorator;

package/dist/pipes/mongo-id.pipe.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MongoIdParam = MongoIdParam;
-exports.ApiMongoId = ApiMongoId;
-const common_1 = require("@nestjs/common");
-const swagger_1 = require("@nestjs/swagger");
-const class_validator_1 = require("class-validator");
-const exceptions_1 = require("../exceptions");
-/**
- * @class ParseMongoIdPipe
- *
- * Pipe to validate and transform a parameter into a valid MongoDB ObjectId string.
- * Throws a `BadParameterException` if the value is invalid.
- */
-class ParseMongoIdPipe {
-    constructor(parameterName) {
-        this.parameterName = parameterName;
-    }
-    /**
-     * @param {unknown} value - Route parameter value.
-     * @returns {string} - Validated Mongo ObjectId string.
-     * @throws {BadParameterException} - If not a valid Mongo ID.
-     */
-    transform(value) {
-        if ((0, class_validator_1.isMongoId)(value)) {
-            return String(value);
-        }
-        throw new exceptions_1.BadParameterException(this.parameterName);
-    }
-}
-/**
- * Decorator to validate and transform a parameter as a MongoId.
- *
- * @param {string} parameterName - Parameter name to validate.
- * @returns {ParameterDecorator}
- */
-function MongoIdParam(parameterName) {
-    return (0, common_1.Param)(parameterName, new ParseMongoIdPipe(parameterName));
-}
-/**
- * Applies Swagger metadata and error handling for MongoId parameters.
- *
- * @param {string} parameterName - Parameter name for docs/errors.
- * @returns {MethodDecorator & ClassDecorator}
- */
-function ApiMongoId(parameterName) {
-    return (0, common_1.applyDecorators)((0, swagger_1.ApiParam)({
-        name: parameterName,
-        example: '507f1f77bcf86cd799439011',
-        description: `A valid MongoDB ObjectId for the "${parameterName}" parameter.`,
-    }), (0, exceptions_1.ApiBadParameterResponse)(parameterName));
-}

package/dist/swagger.config.d.ts

@@ -1,36 +0,0 @@
-import { INestApplication } from '@nestjs/common';
-/**
- * @class SwaggerOptions
- * @description
- * Defines configurable options for setting up Swagger API documentation.
- * This includes optional authentication mechanisms like JWT or Kubernetes API keys.
- */
-export declare class SwaggerOptions {
-    /**
-     * Title of the API documentation displayed in Swagger UI
-     */
-    title: string;
-    /**
-     * Short description of the API's purpose or scope
-     */
-    description: string;
-    /**
-     * Enables JWT-based authentication documentation if true
-     */
-    jwt?: boolean;
-    /**
-     * Enables internal Kubernetes API key authentication if true
-     */
-    k8s?: boolean;
-}
-/**
- * @function initializeSwagger
- * @description
- * Initializes and mounts the Swagger UI on the NestJS application.
- * The UI is exposed at the `/api` route and configured based on the provided options.
- *
- * @param {INestApplication} app - The NestJS application instance.
- * @param {SwaggerOptions} [options] - Optional configuration to customize Swagger behavior.
- * @returns {void}
- */
-export declare function initializeSwagger(app: INestApplication, options?: SwaggerOptions): void;

package/dist/swagger.config.js

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SwaggerOptions = void 0;
-exports.initializeSwagger = initializeSwagger;
-const swagger_1 = require("@nestjs/swagger");
-const internal_guard_1 = require("./modules/authentication/guards/internal.guard");
-/**
- * @class SwaggerOptions
- * @description
- * Defines configurable options for setting up Swagger API documentation.
- * This includes optional authentication mechanisms like JWT or Kubernetes API keys.
- */
-class SwaggerOptions {
-}
-exports.SwaggerOptions = SwaggerOptions;
-/**
- * @function getSwaggerConfig
- * @description
- * Generates the base configuration for Swagger using provided options.
- * Excludes API paths to allow separation of path building logic.
- *
- * @param {SwaggerOptions} [options] - Optional configuration to customize Swagger.
- * @returns {SwaggerConfig} - The core Swagger configuration without paths.
- */
-function getSwaggerConfig(options) {
-    return buildSwaggerDocument(options).build();
-}
-/**
- * @function buildSwaggerDocument
- * @description
- * Creates and configures a `DocumentBuilder` for Swagger based on the provided options.
- *
- * @param {SwaggerOptions} options - User-defined options controlling Swagger behavior.
- * @returns {DocumentBuilder} - A configured Swagger `DocumentBuilder` instance.
- */
-function buildSwaggerDocument(options) {
-    const builder = new swagger_1.DocumentBuilder()
-        .setContact('Timo Scheuermann', '', 'timo.scheuermann@sv-informatik.de')
-        .setTitle(options.title)
-        .setDescription(options.description)
-        .addServer(process.env.SWAGGER_BASE_PATH || 'http://localhost:3000');
-    // Conditionally add JWT Bearer authentication schema
-    if (options.jwt) {
-        builder.addBearerAuth({
-            type: 'http',
-            in: 'header',
-            bearerFormat: 'JWT',
-            description: 'Gesicherter Login Token',
-        });
-    }
-    // Conditionally add Kubernetes internal API key authentication schema
-    if (options.k8s) {
-        builder.addApiKey({
-            type: 'apiKey',
-            in: 'header',
-            description: 'Token zur Authentifizierung interner Anrufe',
-        }, internal_guard_1.INTERNAL_HEADER_KEY);
-    }
-    return builder;
-}
-/**
- * @function initializeSwagger
- * @description
- * Initializes and mounts the Swagger UI on the NestJS application.
- * The UI is exposed at the `/api` route and configured based on the provided options.
- *
- * @param {INestApplication} app - The NestJS application instance.
- * @param {SwaggerOptions} [options] - Optional configuration to customize Swagger behavior.
- * @returns {void}
- */
-function initializeSwagger(app, options) {
-    const config = getSwaggerConfig(options);
-    const document = swagger_1.SwaggerModule.createDocument(app, config);
-    // Serve Swagger UI at '/api' endpoint
-    swagger_1.SwaggerModule.setup('api', app, document);
-}

package/dist/viewable.interface.d.ts

@@ -1,41 +0,0 @@
-/**
- * Interface for entities that track user views. This allows the system to monitor
- * which accounts have viewed an item and how many total views it has received.
- *
- * Used to enable features such as view analytics, popularity ranking, or recommendation systems.
- */
-export interface Viewable {
-    /**
-     * List of account IDs who have viewed this entity.
-     */
-    _viewedBy: string[];
-    /**
-     * Count of total views.
-     */
-    views: number;
-}
-/**
- * Mongoose schema decorator for the `_viewedBy` field, which tracks unique viewer IDs.
- * Initialized as an empty array to ensure a consistent schema across documents.
- *
- * @returns {PropertyDecorator} - Mongoose configuration for tracking viewers.
- */
-export declare function PropertyViewedBy(): PropertyDecorator;
-/**
- * Swagger schema decorator for the `_viewedBy` field. Used in OpenAPI documentation
- * to describe which users have viewed the entity.
- *
- * It enhances API clarity for clients consuming entities that support view tracking.
- *
- * @returns {PropertyDecorator} - Swagger metadata for the `viewedBy` field.
- */
-export declare function ApiViewedBy(): PropertyDecorator;
-/**
- * Swagger schema decorator for the `views` field. Communicates to API consumers
- * the meaning and default value of the view count.
- *
- * Helps visualize popularity or engagement metrics in API tooling.
- *
- * @returns {PropertyDecorator} - Swagger metadata for the `views` field.
- */
-export declare function ApiViews(): PropertyDecorator;

package/dist/viewable.interface.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyViewedBy = PropertyViewedBy;
-exports.ApiViewedBy = ApiViewedBy;
-exports.ApiViews = ApiViews;
-const mongoose_1 = require("@nestjs/mongoose");
-const swagger_1 = require("@nestjs/swagger");
-const models_1 = require("./models");
-/**
- * Mongoose schema decorator for the `_viewedBy` field, which tracks unique viewer IDs.
- * Initialized as an empty array to ensure a consistent schema across documents.
- *
- * @returns {PropertyDecorator} - Mongoose configuration for tracking viewers.
- */
-function PropertyViewedBy() {
-    return (0, mongoose_1.Prop)({ required: true, default: () => [] });
-}
-/**
- * Swagger schema decorator for the `_viewedBy` field. Used in OpenAPI documentation
- * to describe which users have viewed the entity.
- *
- * It enhances API clarity for clients consuming entities that support view tracking.
- *
- * @returns {PropertyDecorator} - Swagger metadata for the `viewedBy` field.
- */
-function ApiViewedBy() {
-    return (0, swagger_1.ApiProperty)({
-        name: 'viewedBy',
-        type: [models_1.AccountEntity],
-        default: [],
-        description: 'Accounts that have viewed this entity.',
-    });
-}
-/**
- * Swagger schema decorator for the `views` field. Communicates to API consumers
- * the meaning and default value of the view count.
- *
- * Helps visualize popularity or engagement metrics in API tooling.
- *
- * @returns {PropertyDecorator} - Swagger metadata for the `views` field.
- */
-function ApiViews() {
-    return (0, swagger_1.ApiProperty)({
-        type: Number,
-        default: 0,
-        description: 'Total number of views this entity has received.',
-    });
-}