itlab-internal-services 2.2.2 → 2.4.0

package/dist/modules/content/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentService = exports.ContentModule = void 0;
+var content_module_1 = require("./content.module");
+Object.defineProperty(exports, "ContentModule", { enumerable: true, get: function () { return content_module_1.ContentModule; } });
+var content_service_1 = require("./content.service");
+Object.defineProperty(exports, "ContentService", { enumerable: true, get: function () { return content_service_1.ContentService; } });

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; } });

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

@@ -34,10 +34,26 @@ import { NewsModel } from './schemas/hub-newsroom.schemas';
 import { PodcastModel } from './schemas/hub-podcasts.schemas';
 import { MemberModel } from './schemas/hub-team.schemas';
 import { BlipModel, RadarModel } from './schemas/hub-tech-radar.schemas';
+/**
+ * Model service
+ * @class ModelService
+ */
 export declare class ModelService {
     private readonly connection;
+    /**
+     * Constructor
+     * @param connection - the connection
+     */
     constructor(connection: Connection);
+    /**
+     * Returns a model for the given database, name and schema
+     * @param database - the database of the model
+     * @param name - the name of the model
+     * @param schema - the schema of the model
+     * @returns {Model<T>} the model
+     */
     private useModel;
+    /** Returns the account model */
     accountModel: () => import("mongoose").Model<AccountModel, {}, {}, {}, import("mongoose").Document<unknown, {}, AccountModel> & AccountModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<AccountModel, import("mongoose").Model<AccountModel, any, any, any, import("mongoose").Document<unknown, any, AccountModel> & AccountModel & {
@@ -45,6 +61,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, AccountModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<AccountModel>> & import("mongoose").FlatRecord<AccountModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the comment model */
     commentModel: () => import("mongoose").Model<CommentModel, {}, {}, {}, import("mongoose").Document<unknown, {}, CommentModel> & CommentModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<CommentModel, import("mongoose").Model<CommentModel, any, any, any, import("mongoose").Document<unknown, any, CommentModel> & CommentModel & {
@@ -52,6 +69,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, CommentModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<CommentModel>> & import("mongoose").FlatRecord<CommentModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the content model */
     contentModel: () => import("mongoose").Model<ContentModel, {}, {}, {}, import("mongoose").Document<unknown, {}, ContentModel> & ContentModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<ContentModel, import("mongoose").Model<ContentModel, any, any, any, import("mongoose").Document<unknown, any, ContentModel> & ContentModel & {
@@ -59,6 +77,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ContentModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ContentModel>> & import("mongoose").FlatRecord<ContentModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the book model */
     bookModel: () => import("mongoose").Model<BookModel, {}, {}, {}, import("mongoose").Document<unknown, {}, BookModel> & BookModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<BookModel, import("mongoose").Model<BookModel, any, any, any, import("mongoose").Document<unknown, any, BookModel> & BookModel & {
@@ -66,6 +85,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, BookModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<BookModel>> & import("mongoose").FlatRecord<BookModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the demo model */
     demoModel: () => import("mongoose").Model<DemoModel, {}, {}, {}, import("mongoose").Document<unknown, {}, DemoModel> & DemoModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<DemoModel, import("mongoose").Model<DemoModel, any, any, any, import("mongoose").Document<unknown, any, DemoModel> & DemoModel & {
@@ -73,6 +93,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, DemoModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<DemoModel>> & import("mongoose").FlatRecord<DemoModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the event model */
     eventModel: () => import("mongoose").Model<EventModel, {}, {}, {}, import("mongoose").Document<unknown, {}, EventModel> & EventModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<EventModel, import("mongoose").Model<EventModel, any, any, any, import("mongoose").Document<unknown, any, EventModel> & EventModel & {
@@ -80,6 +101,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, EventModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<EventModel>> & import("mongoose").FlatRecord<EventModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the hackschool course model */
     courseModel: () => import("mongoose").Model<CourseModel, {}, {}, {}, import("mongoose").Document<unknown, {}, CourseModel> & CourseModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<CourseModel, import("mongoose").Model<CourseModel, any, any, any, import("mongoose").Document<unknown, any, CourseModel> & CourseModel & {
@@ -87,6 +109,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, CourseModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<CourseModel>> & import("mongoose").FlatRecord<CourseModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the hackschool documentation model */
     docModel: () => import("mongoose").Model<DocModel, {}, {}, {}, import("mongoose").Document<unknown, {}, DocModel> & DocModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<DocModel, import("mongoose").Model<DocModel, any, any, any, import("mongoose").Document<unknown, any, DocModel> & DocModel & {
@@ -94,6 +117,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, DocModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<DocModel>> & import("mongoose").FlatRecord<DocModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the hackschool thread model */
     threadModel: () => import("mongoose").Model<ThreadModel, {}, {}, {}, import("mongoose").Document<unknown, {}, ThreadModel> & ThreadModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<ThreadModel, import("mongoose").Model<ThreadModel, any, any, any, import("mongoose").Document<unknown, any, ThreadModel> & ThreadModel & {
@@ -101,6 +125,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ThreadModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<ThreadModel>> & import("mongoose").FlatRecord<ThreadModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the news model */
     newsModel: () => import("mongoose").Model<NewsModel, {}, {}, {}, import("mongoose").Document<unknown, {}, NewsModel> & NewsModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<NewsModel, import("mongoose").Model<NewsModel, any, any, any, import("mongoose").Document<unknown, any, NewsModel> & NewsModel & {
@@ -108,6 +133,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, NewsModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<NewsModel>> & import("mongoose").FlatRecord<NewsModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the podcast model */
     podcastModel: () => import("mongoose").Model<PodcastModel, {}, {}, {}, import("mongoose").Document<unknown, {}, PodcastModel> & PodcastModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<PodcastModel, import("mongoose").Model<PodcastModel, any, any, any, import("mongoose").Document<unknown, any, PodcastModel> & PodcastModel & {
@@ -115,6 +141,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, PodcastModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<PodcastModel>> & import("mongoose").FlatRecord<PodcastModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the member model */
     memberModel: () => import("mongoose").Model<MemberModel, {}, {}, {}, import("mongoose").Document<unknown, {}, MemberModel> & MemberModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<MemberModel, import("mongoose").Model<MemberModel, any, any, any, import("mongoose").Document<unknown, any, MemberModel> & MemberModel & {
@@ -122,6 +149,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, MemberModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<MemberModel>> & import("mongoose").FlatRecord<MemberModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the tech radar blip model */
     blipModel: () => import("mongoose").Model<BlipModel, {}, {}, {}, import("mongoose").Document<unknown, {}, BlipModel> & BlipModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<BlipModel, import("mongoose").Model<BlipModel, any, any, any, import("mongoose").Document<unknown, any, BlipModel> & BlipModel & {
@@ -129,6 +157,7 @@ export declare class ModelService {
     }, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, BlipModel, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<BlipModel>> & import("mongoose").FlatRecord<BlipModel> & {
         _id: import("mongoose").Types.ObjectId;
     }>>;
+    /** Returns the tech radar radar model */
     radarModel: () => import("mongoose").Model<RadarModel, {}, {}, {}, import("mongoose").Document<unknown, {}, RadarModel> & RadarModel & {
         _id: import("mongoose").Types.ObjectId;
     }, Schema<RadarModel, import("mongoose").Model<RadarModel, any, any, any, import("mongoose").Document<unknown, any, RadarModel> & RadarModel & {

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

@@ -27,24 +27,55 @@ const hub_newsroom_schemas_1 = require("./schemas/hub-newsroom.schemas");
 const hub_podcasts_schemas_1 = require("./schemas/hub-podcasts.schemas");
 const hub_team_schemas_1 = require("./schemas/hub-team.schemas");
 const hub_tech_radar_schemas_1 = require("./schemas/hub-tech-radar.schemas");
+/**
+ * Model service
+ * @class ModelService
+ */
 let ModelService = class ModelService {
+    /**
+     * Constructor
+     * @param connection - the connection
+     */
     constructor(connection) {
         this.connection = connection;
+        // General
+        /** Returns the account model */
         this.accountModel = () => this.useModel(hub_account_schemas_1.AccountDB, hub_account_schemas_1.AccountModel.name, hub_account_schemas_1.AccountSchema);
+        /** Returns the comment model */
         this.commentModel = () => this.useModel(hub_comments_schemas_1.CommentDB, hub_comments_schemas_1.CommentModel.name, hub_comments_schemas_1.CommentSchema);
+        /** Returns the content model */
         this.contentModel = () => this.useModel(hub_content_schemas_1.ContentDB, hub_content_schemas_1.ContentModel.name, hub_content_schemas_1.ContentSchema);
+        // Services
+        /** Returns the book model */
         this.bookModel = () => this.useModel(hub_books_schemas_1.BooksDB, hub_books_schemas_1.BookModel.name, hub_books_schemas_1.BookSchema);
+        /** Returns the demo model */
         this.demoModel = () => this.useModel(hub_demo_hive_schemas_1.DemoHiveDB, hub_demo_hive_schemas_1.DemoModel.name, hub_demo_hive_schemas_1.DemoSchema);
+        /** Returns the event model */
         this.eventModel = () => this.useModel(hub_events_schemas_1.EventsDB, hub_events_schemas_1.EventModel.name, hub_events_schemas_1.EventSchema);
+        /** Returns the hackschool course model */
         this.courseModel = () => this.useModel(hub_hackschool_schemas_1.HackschoolDB, hub_hackschool_schemas_1.CourseModel.name, hub_hackschool_schemas_1.CourseSchema);
+        /** Returns the hackschool documentation model */
         this.docModel = () => this.useModel(hub_hackschool_schemas_1.HackschoolDB, hub_hackschool_schemas_1.DocModel.name, hub_hackschool_schemas_1.DocSchema);
+        /** Returns the hackschool thread model */
         this.threadModel = () => this.useModel(hub_hackschool_schemas_1.HackschoolDB, hub_hackschool_schemas_1.ThreadModel.name, hub_hackschool_schemas_1.ThreadSchema);
+        /** Returns the news model */
         this.newsModel = () => this.useModel(hub_newsroom_schemas_1.NewsroomDB, hub_newsroom_schemas_1.NewsModel.name, hub_newsroom_schemas_1.NewsSchema);
+        /** Returns the podcast model */
         this.podcastModel = () => this.useModel(hub_podcasts_schemas_1.PodcastsDB, hub_podcasts_schemas_1.PodcastModel.name, hub_podcasts_schemas_1.PodcastSchema);
+        /** Returns the member model */
         this.memberModel = () => this.useModel(hub_team_schemas_1.TeamDB, hub_team_schemas_1.MemberModel.name, hub_team_schemas_1.MemberSchema);
+        /** Returns the tech radar blip model */
         this.blipModel = () => this.useModel(hub_tech_radar_schemas_1.TechRadarDB, hub_tech_radar_schemas_1.BlipModel.name, hub_tech_radar_schemas_1.BlipSchema);
+        /** Returns the tech radar radar model */
         this.radarModel = () => this.useModel(hub_tech_radar_schemas_1.TechRadarDB, hub_tech_radar_schemas_1.RadarModel.name, hub_tech_radar_schemas_1.RadarSchema);
     }
+    /**
+     * Returns a model for the given database, name and schema
+     * @param database - the database of the model
+     * @param name - the name of the model
+     * @param schema - the schema of the model
+     * @returns {Model<T>} the model
+     */
     useModel(database, name, schema) {
         return this.connection.useDb(database).model(name, schema);
     }

package/dist/modules/database/model-service/schemas/hub-account.schemas.d.ts

@@ -23,9 +23,19 @@
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
 import { Document } from 'mongoose';
+/**
+ * Account avatar model
+ * @class AvatarModel
+ * @property {string} extension - The extension of the avatar
+ * @property {string} mimetype - The mimetype of the avatar
+ * @property {number} size - The size of the avatar
+ */
 declare class AvatarModel {
+    /** The extension of the avatar */
     extension: string;
+    /** The mimetype of the avatar */
     mimetype: string;
+    /** The size of the avatar */
     size: number;
 }
 declare class AccountModel extends Document {

package/dist/modules/database/model-service/schemas/hub-account.schemas.js

@@ -12,6 +12,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccountDB = exports.AccountSchema = exports.AccountModel = void 0;
 const mongoose_1 = require("@nestjs/mongoose");
 const mongoose_2 = require("mongoose");
+/**
+ * Account avatar model
+ * @class AvatarModel
+ * @property {string} extension - The extension of the avatar
+ * @property {string} mimetype - The mimetype of the avatar
+ * @property {number} size - The size of the avatar
+ */
 class AvatarModel {
 }
 const transform = {

package/dist/modules/database/model-service/schemas/hub-hackschool.schemas.js

@@ -35,6 +35,7 @@ CourseModel = __decorate([
 exports.CourseModel = CourseModel;
 const CourseSchema = mongoose_1.SchemaFactory.createForClass(CourseModel);
 exports.CourseSchema = CourseSchema;
+// ================================================================================
 const transformDoc = {
     virtuals: true,
     transform: (_, { title, _hid }) => {
@@ -58,6 +59,7 @@ DocModel = __decorate([
 exports.DocModel = DocModel;
 const DocSchema = mongoose_1.SchemaFactory.createForClass(DocModel);
 exports.DocSchema = DocSchema;
+// ================================================================================
 const transformThread = {
     virtuals: true,
     transform: (_, { title, _hid }) => {
@@ -81,5 +83,6 @@ ThreadModel = __decorate([
 exports.ThreadModel = ThreadModel;
 const ThreadSchema = mongoose_1.SchemaFactory.createForClass(ThreadModel);
 exports.ThreadSchema = ThreadSchema;
+// ================================================================================
 const HackschoolDB = 'hub-hackschool';
 exports.HackschoolDB = HackschoolDB;

package/dist/modules/database/model-service/schemas/hub-tech-radar.schemas.js

@@ -35,6 +35,7 @@ BlipModel = __decorate([
 exports.BlipModel = BlipModel;
 const BlipSchema = mongoose_1.SchemaFactory.createForClass(BlipModel);
 exports.BlipSchema = BlipSchema;
+// ================================================================================
 const toTitle = Intl.DateTimeFormat('de-DE', { month: 'long', year: 'numeric' }).format;
 const transformRadar = {
     virtuals: true,
@@ -65,5 +66,6 @@ RadarModel = __decorate([
 exports.RadarModel = RadarModel;
 const RadarSchema = mongoose_1.SchemaFactory.createForClass(RadarModel);
 exports.RadarSchema = RadarSchema;
+// ================================================================================
 const TechRadarDB = 'hub-tech-radar';
 exports.TechRadarDB = TechRadarDB;

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

@@ -1,12 +1,47 @@
 import { PopulateOptions } from 'mongoose';
 import { ModelService } from '../model-service/model.service';
+/**
+ * Populate service
+ * @class PopulateService
+ */
 export declare class PopulateService {
     private readonly modelService;
+    /**
+     * Constructor
+     * @param modelService - the model service
+     */
     constructor(modelService: ModelService);
+    /**
+     * Populates an account
+     * @param {string} path - the path to populate
+     * @returns {PopulateOptions} the populate options
+     */
     account: (path: string) => PopulateOptions;
+    /**
+     * Populates an array of accounts
+     * @param path - the path to populate
+     * @returns {PopulateOptions} the populate options
+     */
     accounts: (path: string) => PopulateOptions;
+    /**
+     * Populates the comments field of a document with its comments but without replies
+     * @returns {PopulateOptions} the populate options
+     */
     comments: () => PopulateOptions;
+    /**
+     * Populates the commentsCount field of a document with the number of comments
+     * @returns {PopulateOptions} the populate options
+     */
     commentsCount: () => PopulateOptions;
+    /**
+     * Populates the comments field of a document with its comments and replies
+     * @returns {PopulateOptions} the populate options
+     */
     commentsAndReplies: () => PopulateOptions;
+    /**
+     * Populates the content field of a document
+     * @param {string} contentAs - the format of the content
+     * @returns {PopulateOptions} the populate options
+     */
     content: (contentAs?: 'json' | 'text' | 'html') => PopulateOptions;
 }

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

@@ -12,29 +12,59 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PopulateService = void 0;
 const common_1 = require("@nestjs/common");
 const model_service_1 = require("../model-service/model.service");
+/**
+ * Populate service
+ * @class PopulateService
+ */
 let PopulateService = class PopulateService {
+    /**
+     * Constructor
+     * @param modelService - the model service
+     */
     constructor(modelService) {
         this.modelService = modelService;
+        /**
+         * Populates an account
+         * @param {string} path - the path to populate
+         * @returns {PopulateOptions} the populate options
+         */
         this.account = (path) => ({
             path,
             justOne: true,
             model: this.modelService.accountModel(),
         });
+        /**
+         * Populates an array of accounts
+         * @param path - the path to populate
+         * @returns {PopulateOptions} the populate options
+         */
         this.accounts = (path) => ({
             path,
             justOne: false,
             model: this.modelService.accountModel(),
         });
+        /**
+         * Populates the comments field of a document with its comments but without replies
+         * @returns {PopulateOptions} the populate options
+         */
         this.comments = () => ({
             path: 'comments',
             justOne: false,
             model: this.modelService.commentModel(),
             options: { populate: [this.account('author')] },
         });
+        /**
+         * Populates the commentsCount field of a document with the number of comments
+         * @returns {PopulateOptions} the populate options
+         */
         this.commentsCount = () => ({
             path: 'commentsCount',
             model: this.modelService.commentModel(),
         });
+        /**
+         * Populates the comments field of a document with its comments and replies
+         * @returns {PopulateOptions} the populate options
+         */
         this.commentsAndReplies = () => ({
             path: 'comments',
             justOne: false,
@@ -46,6 +76,11 @@ let PopulateService = class PopulateService {
                 ],
             },
         });
+        /**
+         * Populates the content field of a document
+         * @param {string} contentAs - the format of the content
+         * @returns {PopulateOptions} the populate options
+         */
         this.content = (contentAs = 'html') => ({
             path: 'content',
             justOne: true,

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

@@ -1,10 +1,33 @@
 import { PopulateOptions } from 'mongoose';
 import { ModelService } from '../model-service/model.service';
+/**
+ * Service mapper service
+ * @class ServiceMapperService
+ */
 export declare class ServiceMapperService {
     private readonly modelService;
+    /**
+     * Constructor
+     * @param modelService - the model service
+     */
     constructor(modelService: ModelService);
+    /** Map of Targets and their corresponding Model */
     private targets;
+    /**
+     * Transforms a target into a PopulateOptions
+     * @param {string} target - the target
+     * @param {Model<any>} model - the model
+     */
     private transformTarget;
+    /**
+     * Maps all targets to their corresponding PopulateOptions
+     * @returns {PopulateOptions[]} the populate options for all targets
+     */
     all: () => PopulateOptions[];
+    /**
+     * Maps filtered targets to their corresponding PopulateOptions
+     * @param {string[]} targets - the targets
+     * @returns {PopulateOptions[]} the populate options for filtered targets
+     */
     filtered: (targets?: string[]) => PopulateOptions[];
 }

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

@@ -12,9 +12,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServiceMapperService = void 0;
 const common_1 = require("@nestjs/common");
 const model_service_1 = require("../model-service/model.service");
+/**
+ * Service mapper service
+ * @class ServiceMapperService
+ */
 let ServiceMapperService = class ServiceMapperService {
+    /**
+     * Constructor
+     * @param modelService - the model service
+     */
     constructor(modelService) {
         this.modelService = modelService;
+        /** Map of Targets and their corresponding Model */
         this.targets = {
             book: this.modelService.bookModel(),
             demo: this.modelService.demoModel(),
@@ -28,11 +37,25 @@ let ServiceMapperService = class ServiceMapperService {
             'tech-radar-blip': this.modelService.blipModel(),
             'tech-radar-radar': this.modelService.radarModel(),
         };
+        /**
+         * Transforms a target into a PopulateOptions
+         * @param {string} target - the target
+         * @param {Model<any>} model - the model
+         */
         this.transformTarget = (target, model) => ({
             path: `ref-${target}`,
             model,
         });
+        /**
+         * Maps all targets to their corresponding PopulateOptions
+         * @returns {PopulateOptions[]} the populate options for all targets
+         */
         this.all = () => Object.entries(this.targets).map(([target, model]) => this.transformTarget(target, model));
+        /**
+         * Maps filtered targets to their corresponding PopulateOptions
+         * @param {string[]} targets - the targets
+         * @returns {PopulateOptions[]} the populate options for filtered targets
+         */
         this.filtered = (targets) => {
             if (!targets || !targets.length)
                 return this.all();

package/dist/modules/index.d.ts

@@ -1,3 +1,8 @@
+export * from './account';
 export * from './authentication';
+export * from './comment';
+export * from './content';
 export * from './database';
-export * from './services';
+export * from './like';
+export * from './mail';
+export * from './search';

package/dist/modules/index.js

@@ -14,6 +14,11 @@ 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 });
+__exportStar(require("./account"), exports);
 __exportStar(require("./authentication"), exports);
+__exportStar(require("./comment"), exports);
+__exportStar(require("./content"), exports);
 __exportStar(require("./database"), exports);
-__exportStar(require("./services"), exports);
+__exportStar(require("./like"), exports);
+__exportStar(require("./mail"), exports);
+__exportStar(require("./search"), exports);

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

@@ -0,0 +1 @@
+export { LikeModule } from './like.module';