itlab-internal-services 2.16.12 → 2.16.14

package/dist/modules/_old/like/like.module-definition.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LIKE_MODULE_OPTIONS_TOKEN = void 0;
-/**
- * Token used to inject LikeModule options into services or controllers if needed.
- * Symbol is used to avoid accidental naming collisions across modules.
- */
-exports.LIKE_MODULE_OPTIONS_TOKEN = Symbol('LIKE_MODULE_OPTIONS_TOKEN');

package/dist/modules/_old/like/like.module.d.ts

@@ -1,21 +0,0 @@
-import { DynamicModule } from '@nestjs/common';
-import { LikeModuleOptions } from './like.module-definition';
-/**
- * LikeModule dynamically registers controllers and services to handle "like" functionality
- * for different resources based on the provided model and optional suffix.
- *
- * This design enables modularity and reuse of like-related logic across various resource types.
- */
-export declare class LikeModule {
-    /**
-     * Registers and configures the LikeModule dynamically.
-     *
-     * - Automatically generates an endpoint path based on provided suffix.
-     * - Tags the controller in Swagger docs for better discoverability.
-     * - Inherits all business logic from the base LikeController.
-     *
-     * @param options - Configuration options including the model and route suffix.
-     * @returns A fully configured dynamic NestJS module.
-     */
-    static register(options: LikeModuleOptions): DynamicModule;
-}

package/dist/modules/_old/like/like.module.js

@@ -1,67 +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 LikeModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LikeModule = void 0;
-const common_1 = require("@nestjs/common");
-const swagger_1 = require("@nestjs/swagger");
-const itlab_functions_1 = require("itlab-functions");
-const like_controller_1 = require("./like.controller");
-const like_module_definition_1 = require("./like.module-definition");
-const like_service_1 = require("./like.service");
-/**
- * LikeModule dynamically registers controllers and services to handle "like" functionality
- * for different resources based on the provided model and optional suffix.
- *
- * This design enables modularity and reuse of like-related logic across various resource types.
- */
-let LikeModule = LikeModule_1 = class LikeModule {
-    /**
-     * Registers and configures the LikeModule dynamically.
-     *
-     * - Automatically generates an endpoint path based on provided suffix.
-     * - Tags the controller in Swagger docs for better discoverability.
-     * - Inherits all business logic from the base LikeController.
-     *
-     * @param options - Configuration options including the model and route suffix.
-     * @returns A fully configured dynamic NestJS module.
-     */
-    static register(options) {
-        const { routeScope = [] } = options;
-        // Transform suffixes into a readable Swagger tag (e.g., "Like Module - Posts")
-        const swaggerTag = ['Like Module', ...routeScope.map((scope) => (0, itlab_functions_1.capitalize)(scope))].join(' -');
-        // Build the controller route path (e.g., "/like/posts")
-        const controllerRoutePath = ['like', ...routeScope].join('/');
-        /**
-         * A dynamically scoped LikeController for a specific resource.
-         *
-         * This controller uses a generated route path and custom Swagger tag,
-         * but otherwise inherits all base LikeController behavior.
-         */
-        let LikeController = class LikeController extends like_controller_1.LikeController {
-        };
-        LikeController = __decorate([
-            (0, swagger_1.ApiTags)(swaggerTag),
-            (0, common_1.Controller)(controllerRoutePath)
-        ], LikeController);
-        return {
-            module: LikeModule_1,
-            controllers: [LikeController],
-            providers: [like_service_1.LikeService, { provide: like_module_definition_1.LIKE_MODULE_OPTIONS_TOKEN, useValue: options }],
-            exports: [like_service_1.LikeService],
-        };
-    }
-};
-exports.LikeModule = LikeModule;
-exports.LikeModule = LikeModule = LikeModule_1 = __decorate([
-    (0, common_1.Module)({
-        controllers: [like_controller_1.LikeController],
-        providers: [like_service_1.LikeService],
-        exports: [like_service_1.LikeService],
-    })
-], LikeModule);

package/dist/modules/_old/like/like.service.d.ts

@@ -1,61 +0,0 @@
-import { Connection } from 'mongoose';
-import { LikeModuleOptions } from './like.module-definition';
-/**
- * LikeService manages the "like" functionality for resources.
- *
- * It provides methods to add, remove, and verify likes on resource entities,
- * interacting with the underlying MongoDB collection configured by the module options.
- */
-export declare class LikeService {
-    private readonly moduleOptions;
-    private readonly connection;
-    private readonly logger;
-    private readonly likeModel;
-    /**
-     * Initializes LikeService with database connection and module configuration.
-     *
-     * @param {LikeModuleOptions} moduleOptions - The module options containing model info.
-     * @param {Connection} connection - The active MongoDB connection injected by Mongoose.
-     */
-    constructor(moduleOptions: LikeModuleOptions, connection: Connection);
-    /**
-     * Computes the number of likes for a given resource document.
-     *
-     * @param {Document & Likeable} [resource] - The resource document which contains _likedBy array.
-     * @returns {number} The count of likes, or zero if none exist.
-     */
-    private getLikeCount;
-    /**
-     * Adds a like to the specified resource by the given account.
-     *
-     * Uses MongoDB's `$addToSet` to avoid duplicate entries efficiently.
-     * Returns the updated count of likes after addition.
-     *
-     * @param {string} resourceId - The identifier of the resource to like.
-     * @param {string} accountId - The account identifier that likes the resource.
-     * @returns {Promise<number>} The updated like count.
-     */
-    addLike(resourceId: string, accountId: string): Promise<number>;
-    /**
-     * Removes a like from the specified resource by the given account.
-     *
-     * Uses MongoDB's `$pull` operator to remove the account ID from the liked list.
-     * Returns the updated count of likes after removal.
-     *
-     * @param {string} resourceId - The identifier of the resource to unlike.
-     * @param {string} accountId - The account identifier that removes the like.
-     * @returns {Promise<number>} The updated like count.
-     */
-    removeLike(resourceId: string, accountId: string): Promise<number>;
-    /**
-     * Checks whether the specified account has liked the resource.
-     *
-     * This method fetches the resource document and checks if the account ID
-     * exists in the `_likedBy` array.
-     *
-     * @param {string} resourceId - The resource to check.
-     * @param {string} accountId - The account to verify.
-     * @returns {Promise<boolean>} True if the account has liked the resource; false otherwise.
-     */
-    hasLiked(resourceId: string, accountId: string): Promise<boolean>;
-}

package/dist/modules/_old/like/like.service.js

@@ -1,103 +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 LikeService_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LikeService = void 0;
-const common_1 = require("@nestjs/common");
-const mongoose_1 = require("@nestjs/mongoose");
-const mongoose_2 = require("mongoose");
-const like_module_definition_1 = require("./like.module-definition");
-/**
- * LikeService manages the "like" functionality for resources.
- *
- * It provides methods to add, remove, and verify likes on resource entities,
- * interacting with the underlying MongoDB collection configured by the module options.
- */
-let LikeService = LikeService_1 = class LikeService {
-    /**
-     * Initializes LikeService with database connection and module configuration.
-     *
-     * @param {LikeModuleOptions} moduleOptions - The module options containing model info.
-     * @param {Connection} connection - The active MongoDB connection injected by Mongoose.
-     */
-    constructor(moduleOptions, connection) {
-        this.moduleOptions = moduleOptions;
-        this.connection = connection;
-        this.logger = new common_1.Logger(LikeService_1.name);
-        this.likeModel = this.connection.model(this.moduleOptions.model.name, this.moduleOptions.model.schema);
-    }
-    /**
-     * Computes the number of likes for a given resource document.
-     *
-     * @param {Document & Likeable} [resource] - The resource document which contains _likedBy array.
-     * @returns {number} The count of likes, or zero if none exist.
-     */
-    getLikeCount(resource) {
-        var _a, _b;
-        return (_b = (_a = resource === null || resource === void 0 ? void 0 : resource._likedBy) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0;
-    }
-    /**
-     * Adds a like to the specified resource by the given account.
-     *
-     * Uses MongoDB's `$addToSet` to avoid duplicate entries efficiently.
-     * Returns the updated count of likes after addition.
-     *
-     * @param {string} resourceId - The identifier of the resource to like.
-     * @param {string} accountId - The account identifier that likes the resource.
-     * @returns {Promise<number>} The updated like count.
-     */
-    async addLike(resourceId, accountId) {
-        this.logger.log(`Adding like to resource ${resourceId} by account ${accountId}`);
-        const updatedResource = await this.likeModel.findOneAndUpdate({ _id: resourceId }, { $addToSet: { _likedBy: accountId } }, { new: true, upsert: false, timestamps: false });
-        return this.getLikeCount(updatedResource);
-    }
-    /**
-     * Removes a like from the specified resource by the given account.
-     *
-     * Uses MongoDB's `$pull` operator to remove the account ID from the liked list.
-     * Returns the updated count of likes after removal.
-     *
-     * @param {string} resourceId - The identifier of the resource to unlike.
-     * @param {string} accountId - The account identifier that removes the like.
-     * @returns {Promise<number>} The updated like count.
-     */
-    async removeLike(resourceId, accountId) {
-        this.logger.log(`Removing like from resource ${resourceId} by account ${accountId}`);
-        const updatedResource = await this.likeModel.findOneAndUpdate({ _id: resourceId }, { $pull: { _likedBy: accountId } }, { new: true, upsert: false, timestamps: false });
-        return this.getLikeCount(updatedResource);
-    }
-    /**
-     * Checks whether the specified account has liked the resource.
-     *
-     * This method fetches the resource document and checks if the account ID
-     * exists in the `_likedBy` array.
-     *
-     * @param {string} resourceId - The resource to check.
-     * @param {string} accountId - The account to verify.
-     * @returns {Promise<boolean>} True if the account has liked the resource; false otherwise.
-     */
-    async hasLiked(resourceId, accountId) {
-        var _a;
-        this.logger.log(`Checking if account ${accountId} has liked resource ${resourceId}`);
-        const resource = await this.likeModel.findOne({ _id: resourceId });
-        return !!((_a = resource === null || resource === void 0 ? void 0 : resource._likedBy) === null || _a === void 0 ? void 0 : _a.includes(accountId));
-    }
-};
-exports.LikeService = LikeService;
-exports.LikeService = LikeService = LikeService_1 = __decorate([
-    (0, common_1.Injectable)(),
-    __param(0, (0, common_1.Inject)(like_module_definition_1.LIKE_MODULE_OPTIONS_TOKEN)),
-    __param(1, (0, mongoose_1.InjectConnection)()),
-    __metadata("design:paramtypes", [Object, mongoose_2.Connection])
-], LikeService);

package/dist/viewable.interface.d.ts

@@ -1,42 +0,0 @@
-/**
- * TODO: REMOVE
- * 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.Account],
-        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.',
-    });
-}