itlab-internal-services 2.8.0 → 2.9.0

package/dist/hub-resource.enum.d.ts

@@ -18,6 +18,7 @@ export declare enum HubResource {
     HUB_COMMENT = "hub-comment",
     HUB_CONFLICT = "hub-conflict",
     HUB_IDEA = "hub-idea",
+    HUB_CHANGELOG = "hub-changelog",
     ANY = "any"
 }
 export declare enum FetchableHubResource {

package/dist/hub-resource.enum.js

@@ -22,6 +22,7 @@ var HubResource;
     HubResource["HUB_COMMENT"] = "hub-comment";
     HubResource["HUB_CONFLICT"] = "hub-conflict";
     HubResource["HUB_IDEA"] = "hub-idea";
+    HubResource["HUB_CHANGELOG"] = "hub-changelog";
     HubResource["ANY"] = "any";
 })(HubResource || (exports.HubResource = HubResource = {}));
 var FetchableHubResource;
@@ -61,5 +62,6 @@ exports.HUB_RESOURCES = [
     HubResource.HUB_COMMENT,
     HubResource.HUB_CONFLICT,
     HubResource.HUB_IDEA,
+    HubResource.HUB_CHANGELOG,
     HubResource.ANY,
 ];

package/dist/increment-views.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import { Document } from 'mongoose';
+/**
+ * Represents something viewable
+ *
+ * @interface Viewable
+ * @property {string[]} _viewedBy - Array of user IDs who have viewed the document
+ */
+export interface Viewable {
+    /** Array of user IDs who have viewed the document. */
+    _viewedBy: string[];
+    /** The number of views */
+    views: number;
+}
+export declare function incrementViews<T extends Document & Viewable>(target: T, accountId?: string): void;
+export declare const PropViewedBy: () => PropertyDecorator;
+export declare const ApiViewedBy: () => PropertyDecorator;
+export declare const ApiViews: () => PropertyDecorator;

package/dist/increment-views.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiViews = exports.ApiViewedBy = exports.PropViewedBy = exports.incrementViews = void 0;
+const common_1 = require("@nestjs/common");
+const mongoose_1 = require("@nestjs/mongoose");
+const swagger_1 = require("@nestjs/swagger");
+const increment_function_1 = require("./increment.function");
+const modules_1 = require("./modules");
+function incrementViews(target, accountId) {
+    if (!accountId)
+        return;
+    new common_1.Logger('ViewService').log(`Adding view to ${target._id} by ${accountId}`);
+    (0, increment_function_1.incrementAttr)(target, '_viewedBy', accountId);
+}
+exports.incrementViews = incrementViews;
+const PropViewedBy = () => (0, mongoose_1.Prop)({ required: true, default: () => [] });
+exports.PropViewedBy = PropViewedBy;
+const ApiViewedBy = () => (0, swagger_1.ApiProperty)({ default: [], name: 'viewedBy', type: [modules_1.LabAccount] });
+exports.ApiViewedBy = ApiViewedBy;
+const ApiViews = () => (0, swagger_1.ApiProperty)({ default: 0 });
+exports.ApiViews = ApiViews;

package/dist/increment.function.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import { Document } from 'mongoose';
+export declare function incrementAttr<I, T extends Document = Document>(target: T, attr: keyof I, accountId?: string): void;

package/dist/increment.function.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.incrementAttr = void 0;
+function incrementAttr(target, attr, accountId) {
+    if (!accountId)
+        return;
+    target.updateOne({ $addToSet: { [attr]: accountId } }, { timestamps: false }).then(() => {
+        /* noop  */
+    });
+}
+exports.incrementAttr = incrementAttr;

package/dist/index.d.ts

@@ -4,6 +4,8 @@ export * from './favicon.controller';
 export * from './guards';
 export * from './http.logger';
 export * from './hub-resource.enum';
+export * from './increment-views';
+export * from './increment.function';
 export * from './interceptors';
 export * from './liveness.probe';
 export * from './models';

package/dist/index.js

@@ -20,6 +20,8 @@ __exportStar(require("./favicon.controller"), exports);
 __exportStar(require("./guards"), exports);
 __exportStar(require("./http.logger"), exports);
 __exportStar(require("./hub-resource.enum"), exports);
+__exportStar(require("./increment-views"), exports);
+__exportStar(require("./increment.function"), exports);
 __exportStar(require("./interceptors"), exports);
 __exportStar(require("./liveness.probe"), exports);
 __exportStar(require("./models"), exports);

package/dist/modules/database/populate-service/populate.service.d.ts

@@ -42,12 +42,32 @@ export declare class PopulateService {
      * @returns {PopulateOptions} the populate options
      */
     account: (path: string) => PopulateOptions;
+    /**
+     * Populates an author
+     * @returns {PopulateOptions} the populate options
+     */
+    author: () => PopulateOptions;
+    /**
+     * Populates a contact
+     * @returns {PopulateOptions} the populate options
+     */
+    contact: () => PopulateOptions;
     /**
      * Populates an array of accounts
      * @param path - the path to populate
      * @returns {PopulateOptions} the populate options
      */
     accounts: (path: string) => PopulateOptions;
+    /**
+     * Populates the _viewedBy array
+     * @returns {PopulateOptions} the populate options
+     */
+    viewedBy: () => PopulateOptions;
+    /**
+     * Populates the _likedBy array
+     * @returns {PopulateOptions} the populate options
+     */
+    likedBy: () => PopulateOptions;
     /**
      * Populates the comments field of a document with its comments but without replies
      * @returns {PopulateOptions} the populate options

package/dist/modules/database/populate-service/populate.service.js

@@ -33,6 +33,16 @@ let PopulateService = class PopulateService {
             justOne: true,
             model: this.modelService.accountModel(),
         });
+        /**
+         * Populates an author
+         * @returns {PopulateOptions} the populate options
+         */
+        this.author = () => this.account('author');
+        /**
+         * Populates a contact
+         * @returns {PopulateOptions} the populate options
+         */
+        this.contact = () => this.account('contact');
         /**
          * Populates an array of accounts
          * @param path - the path to populate
@@ -43,6 +53,16 @@ let PopulateService = class PopulateService {
             justOne: false,
             model: this.modelService.accountModel(),
         });
+        /**
+         * Populates the _viewedBy array
+         * @returns {PopulateOptions} the populate options
+         */
+        this.viewedBy = () => this.accounts('viewedBy');
+        /**
+         * Populates the _likedBy array
+         * @returns {PopulateOptions} the populate options
+         */
+        this.likedBy = () => this.accounts('likedBy');
         /**
          * Populates the comments field of a document with its comments but without replies
          * @returns {PopulateOptions} the populate options

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

@@ -1 +1,2 @@
 export { LikeModule } from './like.module';
+export { ApiLikedBy, ApiLikes, Likeable } from './like.module-options';

package/dist/modules/like/index.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LikeModule = void 0;
+exports.ApiLikes = exports.ApiLikedBy = exports.LikeModule = void 0;
 /*
  * Like Module
  */
 var like_module_1 = require("./like.module");
 Object.defineProperty(exports, "LikeModule", { enumerable: true, get: function () { return like_module_1.LikeModule; } });
+/*
+ * Like Module options
+ */
+var like_module_options_1 = require("./like.module-options");
+Object.defineProperty(exports, "ApiLikedBy", { enumerable: true, get: function () { return like_module_options_1.ApiLikedBy; } });
+Object.defineProperty(exports, "ApiLikes", { enumerable: true, get: function () { return like_module_options_1.ApiLikes; } });

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

@@ -1,42 +1,15 @@
-/// <reference types="mongoose/types/aggregate" />
-/// <reference types="mongoose/types/callback" />
-/// <reference types="mongoose/types/collection" />
-/// <reference types="mongoose/types/connection" />
-/// <reference types="mongoose/types/cursor" />
-/// <reference types="mongoose/types/document" />
-/// <reference types="mongoose/types/error" />
-/// <reference types="mongoose/types/expressions" />
-/// <reference types="mongoose/types/helpers" />
-/// <reference types="mongoose/types/middlewares" />
-/// <reference types="mongoose/types/indexes" />
-/// <reference types="mongoose/types/models" />
-/// <reference types="mongoose/types/mongooseoptions" />
-/// <reference types="mongoose/types/pipelinestage" />
-/// <reference types="mongoose/types/populate" />
-/// <reference types="mongoose/types/query" />
-/// <reference types="mongoose/types/schemaoptions" />
-/// <reference types="mongoose/types/schematypes" />
-/// <reference types="mongoose/types/session" />
-/// <reference types="mongoose/types/types" />
-/// <reference types="mongoose/types/utility" />
-/// <reference types="mongoose/types/validation" />
-/// <reference types="mongoose/types/virtuals" />
-/// <reference types="mongoose/types/inferschematype" />
-/// <reference types="mongoose/types/inferrawdoctype" />
-import { Document } from 'mongoose';
 /**
- * Represents a likeable document.
- *
- * @class LikeableDocument
- * @extends {Document}
- * @author Timo Scheuermann
+ * Represents something likeable
  *
+ * @interface Likeable
  * @property {string[]} _likedBy - Array of user IDs who have liked the document
- * @property {boolean} draft - Indicates if the document is a draft
  */
-export declare class LikeableDocument extends Document {
+export interface Likeable {
     /** Array of user IDs who have liked the document. */
     _likedBy: string[];
-    /** Indicates if the document is a draft. */
-    draft?: boolean;
+    /** The number of likes */
+    likes: number;
 }
+export declare const PropLikedBy: () => PropertyDecorator;
+export declare const ApiLikedBy: () => PropertyDecorator;
+export declare const ApiLikes: () => PropertyDecorator;

package/dist/modules/like/like.module-options.js

@@ -1,17 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LikeableDocument = void 0;
-const mongoose_1 = require("mongoose");
-/**
- * Represents a likeable document.
- *
- * @class LikeableDocument
- * @extends {Document}
- * @author Timo Scheuermann
- *
- * @property {string[]} _likedBy - Array of user IDs who have liked the document
- * @property {boolean} draft - Indicates if the document is a draft
- */
-class LikeableDocument extends mongoose_1.Document {
-}
-exports.LikeableDocument = LikeableDocument;
+exports.ApiLikes = exports.ApiLikedBy = exports.PropLikedBy = void 0;
+const mongoose_1 = require("@nestjs/mongoose");
+const swagger_1 = require("@nestjs/swagger");
+const authentication_1 = require("../authentication");
+const PropLikedBy = () => (0, mongoose_1.Prop)({ required: true, default: () => [] });
+exports.PropLikedBy = PropLikedBy;
+const ApiLikedBy = () => (0, swagger_1.ApiProperty)({ default: [], name: 'likedBy', type: [authentication_1.LabAccount] });
+exports.ApiLikedBy = ApiLikedBy;
+const ApiLikes = () => (0, swagger_1.ApiProperty)({ default: 0 });
+exports.ApiLikes = ApiLikes;

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

@@ -23,7 +23,8 @@
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
-import { Connection, Schema } from 'mongoose';
+import { Connection, Document, Schema } from 'mongoose';
+import { Likeable } from './like.module-options';
 /**
  * @class LikeService
  * @description The LikeService class is responsible for handling likes for a specified resource. It provides methods to add, remove, and check likes of a resource.
@@ -41,10 +42,7 @@ export declare class LikeService {
      * @param {string} model - the model name
      * @param {Schema} schema - the schema
      */
-    constructor(connection: Connection, model: string, schema: Schema<{
-        _likedBy: string[];
-        _id: string;
-    }>);
+    constructor(connection: Connection, model: string, schema: Schema<Document & Likeable>);
     /**
      * Retrieve the model from the connection based on the schema name.
      *
@@ -54,7 +52,7 @@ export declare class LikeService {
     /**
      * Get the number of likes for the specified resource
      *
-     * @param {LikeableDocument} resource - optional parameter for the resource
+     * @param {Document & Likeable} resource - optional parameter for the resource
      * @return {number} the number of likes for the resource
      */
     private likeCount;

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

@@ -58,7 +58,7 @@ let LikeService = LikeService_1 = class LikeService {
     /**
      * Get the number of likes for the specified resource
      *
-     * @param {LikeableDocument} resource - optional parameter for the resource
+     * @param {Document & Likeable} resource - optional parameter for the resource
      * @return {number} the number of likes for the resource
      */
     likeCount(resource) {
@@ -76,7 +76,7 @@ let LikeService = LikeService_1 = class LikeService {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.log(`Adding like to ${resourceId} by ${accountId}`);
             // Find the resource and update the likedBy array by adding the accountId
-            const resource = yield this.getModel().findOneAndUpdate({ _id: resourceId, draft: false }, { $addToSet: { _likedBy: accountId } }, { upsert: false, new: true });
+            const resource = yield this.getModel().findOneAndUpdate({ _id: resourceId }, { $addToSet: { _likedBy: accountId } }, { upsert: false, new: true, timestamps: false });
             // Return the like count after the addition
             return this.likeCount(resource);
         });
@@ -92,7 +92,7 @@ let LikeService = LikeService_1 = class LikeService {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.log(`Removing like from ${resourceId} by ${accountId}`);
             // Find the resource and update the _likedBy array by removing the accountId
-            const resource = yield this.getModel().findOneAndUpdate({ _id: resourceId, draft: false }, { $pull: { _likedBy: { $in: [accountId] } } }, { upsert: false, new: true });
+            const resource = yield this.getModel().findOneAndUpdate({ _id: resourceId }, { $pull: { _likedBy: { $in: [accountId] } } }, { upsert: false, new: true, timestamps: false });
             // Return the like count after the removal
             return this.likeCount(resource);
         });
@@ -107,8 +107,8 @@ let LikeService = LikeService_1 = class LikeService {
     hasLiked(resourceId, accountId) {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.log(`Check if ${accountId} has liked ${resourceId}`);
-            // Find the resource in the likeModel with the provided resourceId and ensure it's not a draft.
-            const resource = yield this.getModel().findOne({ _id: resourceId, draft: false });
+            // Find the resource in the likeModel with the provided resourceId.
+            const resource = yield this.getModel().findOne({ _id: resourceId });
             // Return true if the resource exists and has the account in its _likedBy array, otherwise return false.
             return resource && resource._likedBy ? resource._likedBy.includes(accountId) : false;
         });

package/dist/virtuals.factory.d.ts

@@ -47,6 +47,18 @@ export declare class VirtualsFactory {
      * @return {VirtualsFactory} the VirtualsFactory
      */
     account(name: string, localField: string): VirtualsFactory;
+    /**
+     * Creates a virtual author field on the given schema, linking it to the 'accounts' collection.
+     *
+     * @return {VirtualsFactory} the VirtualsFactory
+     */
+    author: () => VirtualsFactory;
+    /**
+     * Creates a virtual contact field on the given schema, linking it to the 'accounts' collection.
+     *
+     * @return {VirtualsFactory} the VirtualsFactory
+     */
+    contact: () => VirtualsFactory;
     /**
      * Creates a virtual accounts field on the given schema, linking it to the 'accounts' collection.
      *
@@ -55,6 +67,18 @@ export declare class VirtualsFactory {
      * @return {VirtualsFactory} the VirtualsFactory
      */
     accounts(name: string, localField: string): VirtualsFactory;
+    /**
+     * Creates a virtual viewedBy field on the given schema, linking it to the 'accounts' collection.
+     *
+     * @return {VirtualsFactory} the VirtualsFactory
+     */
+    views(): VirtualsFactory;
+    /**
+     * Creates a virtual likedBy field on the given schema, linking it to the 'accounts' collection.
+     *
+     * @return {VirtualsFactory} the VirtualsFactory
+     */
+    likes(): VirtualsFactory;
     /**
      * Creates virtual comments field on the given schema, linking it to the 'comments' collection.
      *

package/dist/virtuals.factory.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VirtualsFactory = void 0;
+const class_validator_1 = require("class-validator");
 const hub_resource_enum_1 = require("./hub-resource.enum");
 /**
  * Creates virtual fields on a schema.
@@ -16,6 +17,18 @@ class VirtualsFactory {
     constructor(schema, resource) {
         this.schema = schema;
         this.resource = resource;
+        /**
+         * Creates a virtual author field on the given schema, linking it to the 'accounts' collection.
+         *
+         * @return {VirtualsFactory} the VirtualsFactory
+         */
+        this.author = () => this.account('author', 'authorId');
+        /**
+         * Creates a virtual contact field on the given schema, linking it to the 'accounts' collection.
+         *
+         * @return {VirtualsFactory} the VirtualsFactory
+         */
+        this.contact = () => this.account('contact', 'contactId');
     }
     /**
      * Creates a virtual account field on the given schema, linking it to the 'accounts' collection.
@@ -49,6 +62,30 @@ class VirtualsFactory {
         });
         return this;
     }
+    /**
+     * Creates a virtual viewedBy field on the given schema, linking it to the 'accounts' collection.
+     *
+     * @return {VirtualsFactory} the VirtualsFactory
+     */
+    views() {
+        this.accounts('viewedBy', '_viewedBy');
+        this.schema.virtual('views').get(function () {
+            return (0, class_validator_1.isArray)(this._viewedBy) ? this._viewedBy.length : 0;
+        });
+        return this;
+    }
+    /**
+     * Creates a virtual likedBy field on the given schema, linking it to the 'accounts' collection.
+     *
+     * @return {VirtualsFactory} the VirtualsFactory
+     */
+    likes() {
+        this.accounts('likedBy', '_likedBy');
+        this.schema.virtual('likes').get(function () {
+            return (0, class_validator_1.isArray)(this._likedBy) ? this._likedBy.length : 0;
+        });
+        return this;
+    }
     /**
      * Creates virtual comments field on the given schema, linking it to the 'comments' collection.
      *

package/package.json

@@ -5,7 +5,7 @@
     "email": "timo.scheuermann@sv-informatik.de",
     "url": "https://timos.design"
   },
-  "version": "2.8.0",
+  "version": "2.9.0",
   "type": "commonjs",
   "files": [
     "dist"