itlab-internal-services 2.15.6 → 2.16.0

package/dist/modules/comment/comment.service.js

@@ -11,123 +11,89 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-var CommentService_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommentService = void 0;
 const common_1 = require("@nestjs/common");
 const config_1 = require("@nestjs/config");
 const mongoose_1 = require("@nestjs/mongoose");
-const class_validator_1 = require("class-validator");
 const mongoose_2 = require("mongoose");
-const create_internal_axios_client_function_1 = require("../../functions/create-internal-axios-client.function");
 const authentication_1 = require("../authentication");
+const base_http_service_1 = require("../services/base-http.service");
 const comment_module_definition_1 = require("./comment.module-definition");
 /**
- * @class CommentService
- * @description
- * Handles business logic for posting and deleting comments associated with a resource.
- * Integrates with external/internal comment services and supports resource ownership validation.
+ * CommentService manages persistence and business logic
+ * for adding, comments on resource entities.
+ *
+ * Why: Encapsulates MongoDB operations and ensures consistent handling
+ * of comment-related behavior across all resources that support comments.
  */
-let CommentService = CommentService_1 = class CommentService {
+let CommentService = class CommentService extends base_http_service_1.BaseHttpService {
     /**
-     * Initializes the CommentService with injected dependencies and constructs
-     * an axios client for internal comment service communication.
+     * Constructs the CommentService with a configured model instance.
      *
-     * @param moduleOptions - Configuration for comment handling (resource, model, ownership fields)
-     * @param connection - Optional Mongoose connection for fetching resource documents
-     * @param authOptions - Auth options including Kubernetes token for service calls
-     * @param configService - Global config service for environment settings
+     * Why: Using the provided Mongoose connection and model options ensures
+     * that comments are tied to the correct resource collection dynamically.
+     *
+     * @param {CommentModuleOptions} moduleOptions - Config for the commentable resource model.
+     * @param {Connection} connection - Mongoose database connection.
      */
-    constructor(moduleOptions, connection, authOptions, configService) {
+    constructor(moduleOptions, connection, authenticationOptions, configService) {
+        super('Comment', [
+            'http://organisation-hub-comments-service.organisation-hub-services.svc.cluster.local:3000/',
+            'https://services.svi-itlab.com/comments/',
+        ], authenticationOptions, configService);
         this.moduleOptions = moduleOptions;
         this.connection = connection;
-        this.authOptions = authOptions;
-        this.configService = configService;
-        this.logger = new common_1.Logger(CommentService_1.name);
-        this.resource = this.moduleOptions.resource;
-        // If a model is provided, bind the commentModel to allow ownership lookup
-        if (this.moduleOptions.model) {
-            this.commentModel = this.connection.model(this.moduleOptions.model.name, this.moduleOptions.model.schema);
-        }
-        const isProduction = this.configService.get('NODE_ENV') === 'production';
-        // Construct base URL conditionally based on environment.
-        const baseUrl = isProduction
-            ? 'http://organisation-hub-comments-service.organisation-hub-services.svc.cluster.local:3000/internal/'
-            : 'https://services.svi-itlab.com/comments/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}/`,
-        });
+        const { name, schema } = this.moduleOptions.model;
+        this.commentModel = this.connection.model(name, schema);
     }
     /**
-     * Posts a comment to a given resource, with optional ownership metadata attached.
+     * Posts a comment to a given resource, optionally attaching ownership metadata.
      *
-     * - Validates that the resource exists if a model is defined.
-     * - Looks up `ownerId` or `ownerIds` for authorization use by downstream services.
+     * Why:
+     * - Ensures that the resource exists before attempting to save a comment.
+     * - Optionally extracts `ownerId` or `ownerIds` for downstream authorization or notifications.
+     * - Wraps the internal HTTP call in a promise with proper error handling and logging.
      *
-     * @param {string} resourceId - ID of the resource being commented on
-     * @param {string} accountId - ID of the user posting the comment
-     * @param {LabContentRichtext} comment - Comment content in rich-text format
-     * @returns {Promise<Comment>} - Resolves with the saved comment or throws an HTTP exception
+     * @param {string} resourceId - MongoDB ObjectId of the resource being commented on.
+     * @param {string} accountId - Authenticated user ID posting the comment.
+     * @param {LabContentRichtext} richtext - Comment content in rich-text format.
+     * @returns {Promise<LabCommentPopulated>} Resolves with the saved comment or throws an HTTP exception.
+     * @throws {NotFoundException} If the resource does not exist.
+     * @throws {HttpException} If the internal service call fails.
      */
-    async postComment(resourceId, accountId, comment) {
-        var _a, _b, _c;
-        // Exit early if no model is defined (e.g., management context)
-        if (!(0, class_validator_1.isDefined)(this.commentModel)) {
-            this.logger.error('Kommentare können nicht vom Management aus erstellt werden');
-            return;
-        }
-        // Ensure the referenced resource exists before allowing comments
-        const resourceDoc = await this.commentModel.findOne({ _id: resourceId });
-        if (!resourceDoc) {
+    async postComment(resourceId, accountId, richtext) {
+        const resourceType = this.commentModel.name.toLowerCase();
+        // Verify that the resource exists before posting a comment.
+        const resource = await this.commentModel.findOne({ _id: resourceId });
+        if (!resource) {
+            this.logger.error(`Cannot post comment: ${resourceType} ${resourceId} not found`);
             throw new common_1.NotFoundException('Kommentar konnte nicht erstellt werden');
         }
-        // Optionally extract ownerId or ownerIds from the resource document
-        const { ownerIdField, ownerIdsField } = this.moduleOptions;
-        const ownerId = ownerIdField ? resourceDoc[ownerIdField] : undefined;
-        const ownerIds = ownerIdsField ? resourceDoc[ownerIdsField] : undefined;
-        this.logger.log(`Posting comment for ${this.resource} (${resourceId}) by account ${accountId}`);
+        // Extract ownership metadata if configured for downstream use.
+        const ownerId = this.moduleOptions.ownerIdField ? resource[this.moduleOptions.ownerIdField] : undefined;
+        const ownerIds = this.moduleOptions.ownerIdsField ? resource[this.moduleOptions.ownerIdsField] : undefined;
+        const endpoint = `internal/${this.moduleOptions.resource}/${resourceId}/${accountId}`;
+        this.logger.log(`Account ${accountId} is posting a comment on ${resourceType} resource ${resourceId}`);
         try {
-            const response = await this.axiosInstance.post(`${resourceId}/${accountId}`, comment, {
+            const { data } = await this.client.post(endpoint, richtext, {
                 params: { ownerId, ownerIds },
             });
-            this.logger.log(`Comment for ${this.resource} (${resourceId}) posted`);
-            return response.data;
+            this.logger.log(`Account ${accountId} successfully posted a comment on ${resourceType} resource ${resourceId}`);
+            return data;
         }
         catch (error) {
-            const axiosError = error;
-            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-            this.logger.error(`Couldn't post comment for ${this.resource} (${resourceId}): ${(_a = axiosError.response) === null || _a === void 0 ? void 0 : _a.data}`);
-            throw new common_1.HttpException(((_b = axiosError.response) === null || _b === void 0 ? void 0 : _b.data) || 'Internal error', ((_c = axiosError.response) === null || _c === void 0 ? void 0 : _c.status) || 500);
+            const { status, data, message } = this.parseError(error);
+            this.logger.error(`Account ${accountId} failed to post comment on ${resourceType} resource ${resourceId}: ${message}`);
+            throw new common_1.HttpException(data, status);
         }
     }
-    /**
-     * Deletes all comments associated with the specified resource.
-     *
-     * - Primarily used for cleanup during resource deletion.
-     * - Logs success or failure, but does not throw exceptions on error.
-     *
-     * @param {string} resourceId - ID of the resource whose comments should be deleted
-     * @returns {void}
-     */
-    delete(resourceId) {
-        this.logger.log(`Deleting all comments for ${this.resource} (${resourceId})`);
-        this.axiosInstance
-            .delete(resourceId)
-            .then(() => {
-            this.logger.log(`All comments for ${this.resource} (${resourceId}) deleted`);
-        })
-            .catch(({ response }) => {
-            this.logger.error(`Couldn't delete all comments for ${this.resource} (${resourceId}): ${JSON.stringify(response === null || response === void 0 ? void 0 : response.data)}`);
-        });
-    }
 };
 exports.CommentService = CommentService;
-exports.CommentService = CommentService = CommentService_1 = __decorate([
+exports.CommentService = CommentService = __decorate([
     (0, common_1.Injectable)(),
     __param(0, (0, common_1.Inject)(comment_module_definition_1.COMMENT_MODULE_OPTIONS_TOKEN)),
     __param(1, (0, mongoose_1.InjectConnection)()),
-    __param(2, (0, authentication_1.InjectAuthOptions)()),
+    __param(2, (0, authentication_1.InjectAuthenticationOptions)()),
     __metadata("design:paramtypes", [Object, mongoose_2.Connection, Object, config_1.ConfigService])
 ], CommentService);

package/dist/modules/comment/index.d.ts

@@ -1,3 +1,2 @@
-export { Comment } from './comment.model';
-export { CommentModule } from './comment.module';
-export { CommentService } from './comment.service';
+export * from './comment-module-options.interface';
+export * from './comment.module';

package/dist/modules/comment/index.js

@@ -1,9 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommentService = exports.CommentModule = exports.Comment = void 0;
-var comment_model_1 = require("./comment.model");
-Object.defineProperty(exports, "Comment", { enumerable: true, get: function () { return comment_model_1.Comment; } });
-var comment_module_1 = require("./comment.module");
-Object.defineProperty(exports, "CommentModule", { enumerable: true, get: function () { return comment_module_1.CommentModule; } });
-var comment_service_1 = require("./comment.service");
-Object.defineProperty(exports, "CommentService", { enumerable: true, get: function () { return comment_service_1.CommentService; } });
+__exportStar(require("./comment-module-options.interface"), exports);
+__exportStar(require("./comment.module"), exports);

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

@@ -16,9 +16,6 @@ const mongoose_1 = require("@nestjs/mongoose");
 const mongoose_2 = __importDefault(require("mongoose"));
 const database_liveness_controller_1 = require("./database.liveness-controller");
 const lock_service_1 = require("./lock-service/lock.service");
-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");
 /**
  * DatabaseModule centralizes all database-related configuration and services.
  * It wraps Mongoose integration, model registration, liveness health checks,
@@ -90,8 +87,8 @@ let DatabaseModule = DatabaseModule_1 = class DatabaseModule {
 exports.DatabaseModule = DatabaseModule;
 exports.DatabaseModule = DatabaseModule = DatabaseModule_1 = __decorate([
     (0, common_1.Module)({
-        providers: [model_service_1.ModelService, populate_service_1.PopulateService, service_mapper_service_1.ServiceMapperService, lock_service_1.LockService],
-        exports: [model_service_1.ModelService, populate_service_1.PopulateService, service_mapper_service_1.ServiceMapperService, lock_service_1.LockService],
+        providers: [lock_service_1.LockService],
+        exports: [lock_service_1.LockService],
         controllers: [database_liveness_controller_1.DatabaseLivenessProbeController],
     })
 ], DatabaseModule);

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

@@ -1,6 +1,3 @@
-export { DatabaseModuleOptions } from './database-module-options.interface';
-export { DatabaseModule } from './database.module';
+export * from './database-module-options.interface';
+export * from './database.module';
 export { LockService } from './lock-service/lock.service';
-export { ModelService } from './model-service/model.service';
-export { PopulateService } from './populate-service/populate.service';
-export { ServiceMapperService } from './service-mapper-service/service-mapper.service';

package/dist/modules/database/index.js

@@ -1,13 +1,21 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceMapperService = exports.PopulateService = exports.ModelService = exports.LockService = exports.DatabaseModule = void 0;
-var database_module_1 = require("./database.module");
-Object.defineProperty(exports, "DatabaseModule", { enumerable: true, get: function () { return database_module_1.DatabaseModule; } });
+exports.LockService = void 0;
+__exportStar(require("./database-module-options.interface"), exports);
+__exportStar(require("./database.module"), exports);
 var lock_service_1 = require("./lock-service/lock.service");
 Object.defineProperty(exports, "LockService", { enumerable: true, get: function () { return lock_service_1.LockService; } });
-var model_service_1 = require("./model-service/model.service");
-Object.defineProperty(exports, "ModelService", { enumerable: true, get: function () { return model_service_1.ModelService; } });
-var populate_service_1 = require("./populate-service/populate.service");
-Object.defineProperty(exports, "PopulateService", { enumerable: true, get: function () { return populate_service_1.PopulateService; } });
-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; } });

package/dist/modules/index.d.ts

@@ -1,11 +1,7 @@
 export * from './authentication';
 export * from './cache';
 export * from './comment';
-export * from './content';
 export * from './database';
-export * from './fetch';
 export * from './like';
-export * from './mail';
-export * from './notification';
-export * from './pass';
-export * from './search';
+export * from './merge';
+export * from './services';

package/dist/modules/index.js

@@ -17,11 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./authentication"), exports);
 __exportStar(require("./cache"), exports);
 __exportStar(require("./comment"), exports);
-__exportStar(require("./content"), exports);
 __exportStar(require("./database"), exports);
-__exportStar(require("./fetch"), exports);
 __exportStar(require("./like"), exports);
-__exportStar(require("./mail"), exports);
-__exportStar(require("./notification"), exports);
-__exportStar(require("./pass"), exports);
-__exportStar(require("./search"), exports);
+__exportStar(require("./merge"), exports);
+__exportStar(require("./services"), exports);

package/dist/modules/like/index.d.ts

@@ -1 +1,2 @@
-export { LikeModule } from './like.module';
+export * from './like-module-options.interface';
+export * from './like.module';

package/dist/modules/like/index.js

@@ -1,5 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LikeModule = void 0;
-var like_module_1 = require("./like.module");
-Object.defineProperty(exports, "LikeModule", { enumerable: true, get: function () { return like_module_1.LikeModule; } });
+__exportStar(require("./like-module-options.interface"), exports);
+__exportStar(require("./like.module"), exports);

package/dist/modules/like/like-module-options.interface.d.ts

@@ -0,0 +1,21 @@
+import { ModelDefinition } from '@nestjs/mongoose';
+/**
+ * Module options for configuring and dynamically registering the LikeModule.
+ *
+ * This allows developers to specify the resource model that supports "likes"
+ * and optionally provide a custom route suffix. The modular design ensures
+ * consistent, reusable like functionality across multiple resource types
+ * (e.g. News, Events, Demos).
+ */
+export type LikeModuleOptions = {
+    /**
+     * Mongoose model definition representing the resource type
+     * that can receive likes.
+     */
+    model: ModelDefinition;
+    /**
+     * Optional suffix used to customize the controller route.
+     * For example, setting this to "news" will expose routes like `/like/news/:id`.
+     */
+    routeSuffix?: string;
+};

package/dist/modules/like/like.controller.d.ts

@@ -1,41 +1,49 @@
 import { LikeService } from './like.service';
 /**
- * LikeController handles all HTTP requests related to "like" interactions on resources.
+ * Factory function for creating a LikeController bound to a specific route suffix.
  *
- * It provides endpoints for users to add a like, remove a like, and check if they have liked a resource.
- * Authentication is enforced via JWT to ensure only authorized users can interact with these endpoints.
- * Resource IDs are validated as MongoDB ObjectIds to maintain data integrity.
+ * Why: Instead of writing separate controllers for each resource type,
+ * we generate one dynamically. This ensures DRY principles while still
+ * supporting custom routes (e.g. `/like/news` or `/like/event`).
+ *
+ * @param {string} [routeSuffix] - Optional suffix appended to the "like" route.
+ * @returns A dynamically generated controller class.
  */
-export declare class LikeController {
-    private readonly likeService;
-    /**
-     * Initializes LikeController with LikeService dependency.
-     *
-     * @param {LikeService} likeService - Service handling like operations.
-     */
-    constructor(likeService: LikeService);
-    /**
-     * Adds the authenticated user's like to the specified resource.
-     *
-     * @param {string} resourceId - MongoDB ObjectId of the resource to be liked.
-     * @param {string} accountId - The ID of the authenticated account performing the like.
-     * @returns {Promise<number>} The updated total number of likes after addition.
-     */
-    addLikeToResource(resourceId: string, accountId: string): Promise<number>;
-    /**
-     * Removes the authenticated user's like from the specified resource.
-     *
-     * @param {string} resourceId - MongoDB ObjectId of the resource to unlike.
-     * @param {string} accountId - The ID of the authenticated account removing the like.
-     * @returns {Promise<number>} The updated total number of likes after removal.
-     */
-    removeLikeFromResource(resourceId: string, accountId: string): Promise<number>;
-    /**
-     * Checks if the authenticated user has liked the given resource.
-     *
-     * @param {string} resourceId - MongoDB ObjectId of the resource.
-     * @param {string} accountId - The ID of the authenticated account to check.
-     * @returns {Promise<boolean>} True if the user has liked the resource, false otherwise.
-     */
-    isResourceLikedByUser(resourceId: string, accountId: string): Promise<boolean>;
-}
+export declare function createLikeController(routeSuffix?: string): {
+    new (likeService: LikeService): {
+        readonly likeService: LikeService;
+        /**
+         * Adds the authenticated user's like to a given resource.
+         *
+         * Why: Prevents duplicate likes using `$addToSet`,
+         * ensuring idempotency of repeated requests.
+         *
+         * @param {string} resourceId - The MongoDB ObjectId of the resource.
+         * @param {string} accountId - The authenticated account performing the like.
+         * @returns {Promise<number>} The updated like count.
+         */
+        addLikeToResource(resourceId: string, accountId: string): Promise<number>;
+        /**
+         * Removes the authenticated user's like from a given resource.
+         *
+         * Why: Uses `$pull` to ensure the user’s ID is removed only if present,
+         * maintaining database consistency without errors.
+         *
+         * @param {string} resourceId - The MongoDB ObjectId of the resource.
+         * @param {string} accountId - The authenticated account removing the like.
+         * @returns {Promise<number>} The updated like count.
+         */
+        removeLikeFromResource(resourceId: string, accountId: string): Promise<number>;
+        /**
+         * Determines whether the authenticated user has liked a given resource.
+         *
+         * Why: Useful for rendering UI states (e.g. "Like" vs. "Unlike" buttons)
+         * without fetching all likes.
+         *
+         * @param {string} resourceId - The MongoDB ObjectId of the resource.
+         * @param {string} accountId - The authenticated account to check.
+         * @returns {Promise<boolean>} True if the resource is liked by the user.
+         */
+        isResourceLikedByUser(resourceId: string, accountId: string): Promise<boolean>;
+    };
+};