itlab-internal-services 2.4.3 → 2.4.5

package/dist/create-duplicate-checker.function.d.ts

@@ -0,0 +1,3 @@
+import { Document, Model } from 'mongoose';
+import { ErrorException } from './exceptions';
+export declare function createDuplicateChecker<D, T extends Document>(model: Model<T>, criticalKeys: (keyof D & keyof T)[], error?: new () => ErrorException): (dto: D, target?: T) => Promise<void>;

package/dist/create-duplicate-checker.function.js

@@ -0,0 +1,29 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDuplicateChecker = void 0;
+const exceptions_1 = require("./exceptions");
+function createDuplicateChecker(model, criticalKeys, error = exceptions_1.DuplicateException) {
+    return (dto, target) => __awaiter(this, void 0, void 0, function* () {
+        const fq = {};
+        for (const key of criticalKeys) {
+            if (dto && key in dto)
+                fq[key] = dto[key];
+            if (target && key in target)
+                fq[key] = target[key];
+        }
+        const found = yield model.findOne(fq);
+        const compareId = target ? String(target._id).toLowerCase() : undefined;
+        if (found && String(found._id).toLowerCase() !== compareId)
+            throw new error();
+    });
+}
+exports.createDuplicateChecker = createDuplicateChecker;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from './create-duplicate-checker.function';
 export * from './exceptions';
 export * from './favicon.controller';
 export * from './guards';

package/dist/index.js

@@ -14,6 +14,7 @@ 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("./create-duplicate-checker.function"), exports);
 __exportStar(require("./exceptions"), exports);
 __exportStar(require("./favicon.controller"), exports);
 __exportStar(require("./guards"), exports);

package/dist/modules/mail/mail.models.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Represents a MailToken
+ */
+export declare class MailToken {
+    /** The login token */
+    token: string;
+}
 /**
  * Represents a MailWeeklyDagoBERTSummary
  */
@@ -26,3 +33,12 @@ export declare class MailDagoBERTDowntime {
     /** The end time */
     end: string;
 }
+/**
+ * Represents a MailPasswordReset
+ */
+export declare class MailPasswordReset {
+    /** The name of the receiver */
+    name: string;
+    /** The URL from where to reset the password from */
+    url: string;
+}

package/dist/modules/mail/mail.models.js

@@ -9,8 +9,14 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MailDagoBERTDowntime = exports.MailWeeklyDagoBERTSummary = void 0;
+exports.MailPasswordReset = exports.MailDagoBERTDowntime = exports.MailWeeklyDagoBERTSummary = exports.MailToken = void 0;
 const swagger_1 = require("@nestjs/swagger");
+/**
+ * Represents a MailToken
+ */
+class MailToken {
+}
+exports.MailToken = MailToken;
 /**
  * Represents a MailWeeklyDagoBERTSummary
  */
@@ -59,3 +65,17 @@ __decorate([
     __metadata("design:type", String)
 ], MailDagoBERTDowntime.prototype, "end", void 0);
 exports.MailDagoBERTDowntime = MailDagoBERTDowntime;
+/**
+ * Represents a MailPasswordReset
+ */
+class MailPasswordReset {
+}
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    __metadata("design:type", String)
+], MailPasswordReset.prototype, "name", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    __metadata("design:type", String)
+], MailPasswordReset.prototype, "url", void 0);
+exports.MailPasswordReset = MailPasswordReset;

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

@@ -1,5 +1,12 @@
 import { ConfigService } from '@nestjs/config';
-import { MailDagoBERTDowntime, MailWeeklyDagoBERTSummary } from './mail.models';
+import { MailDagoBERTDowntime, MailPasswordReset, MailToken, MailWeeklyDagoBERTSummary } from './mail.models';
+declare type Data = MailToken | MailPasswordReset | MailWeeklyDagoBERTSummary | MailDagoBERTDowntime | Record<string, string>;
+export declare enum Endpoint {
+    Token = "token",
+    PasswordReset = "password-reset",
+    WeeklyDagoBERTSummary = "weekly-dagobert-summary",
+    DagoBERTDowntime = "dagobert-downtime"
+}
 /**
  * Mail service
  * @class MailService
@@ -16,27 +23,12 @@ export declare class MailService {
     /** The axios instance */
     private axios;
     /**
-     * Sends a signin token to a specified address.
-     *
-     * @param {string} token - the token to be sent
-     * @param {string} address - the address where the token will be sent to
-     * @return {void}
-     */
-    sendToken(token: string, address: string): void;
-    /**
-     * Sends the weekly DagoBERT summary via email.
-     *
-     * @param {MailWeeklyDagoBERTSummary} data - the data for the weekly summary
-     * @param {string} address - the email address to send the summary to
-     * @return {void}
-     */
-    sendWeeklyDagoBERTSummary(data: MailWeeklyDagoBERTSummary, address: string): void;
-    /**
-     * Send DagoBERT downtime data to the specified address.
+     * Send data to a specified address.
      *
-     * @param {MailDagoBERTDowntime} data - the data to send
-     * @param {string} address - the address to send the data to
-     * @return {void}
+     * @param {string} endpoint - the endpoint of the mail service
+     * @param {Data} data - the data to sent
+     * @param address - the addess where the data will be sent to
      */
-    sendDagoBERTDowntime(data: MailDagoBERTDowntime, address: string): void;
+    send<T = Data>(endpoint: string, data: T, address: string): void;
 }
+export {};

package/dist/modules/mail/mail.service.js

@@ -10,11 +10,18 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 var MailService_1;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MailService = void 0;
+exports.MailService = exports.Endpoint = void 0;
 const common_1 = require("@nestjs/common");
 const config_1 = require("@nestjs/config");
 const axios_1 = require("../../axios");
 const env_1 = require("../../env");
+var Endpoint;
+(function (Endpoint) {
+    Endpoint["Token"] = "token";
+    Endpoint["PasswordReset"] = "password-reset";
+    Endpoint["WeeklyDagoBERTSummary"] = "weekly-dagobert-summary";
+    Endpoint["DagoBERTDowntime"] = "dagobert-downtime";
+})(Endpoint = exports.Endpoint || (exports.Endpoint = {}));
 /**
  * Mail service
  * @class MailService
@@ -35,46 +42,18 @@ let MailService = MailService_1 = class MailService {
         });
     }
     /**
-     * Sends a signin token to a specified address.
+     * Send data to a specified address.
      *
-     * @param {string} token - the token to be sent
-     * @param {string} address - the address where the token will be sent to
-     * @return {void}
+     * @param {string} endpoint - the endpoint of the mail service
+     * @param {Data} data - the data to sent
+     * @param address - the addess where the data will be sent to
      */
-    sendToken(token, address) {
-        this.logger.log('Sending token');
+    send(endpoint, data, address) {
+        this.logger.log('Sending E-Mail');
         this.axios
-            .post(`token`, { token, address })
-            .then(() => this.logger.log('Token sent'))
-            .catch(({ response }) => this.logger.error("Couldn't send token...", response.data));
-    }
-    /**
-     * Sends the weekly DagoBERT summary via email.
-     *
-     * @param {MailWeeklyDagoBERTSummary} data - the data for the weekly summary
-     * @param {string} address - the email address to send the summary to
-     * @return {void}
-     */
-    sendWeeklyDagoBERTSummary(data, address) {
-        this.logger.log('Sending weekly DagoBERT summary');
-        this.axios
-            .post(`weekly-dagobert-summary`, Object.assign(Object.assign({}, data), { address }))
-            .then(() => this.logger.log('Weekly DagoBERT summary sent'))
-            .catch(({ response }) => this.logger.error("Couldnt't send weekly DagoBERT summary...", response.data));
-    }
-    /**
-     * Send DagoBERT downtime data to the specified address.
-     *
-     * @param {MailDagoBERTDowntime} data - the data to send
-     * @param {string} address - the address to send the data to
-     * @return {void}
-     */
-    sendDagoBERTDowntime(data, address) {
-        this.logger.log('Sending DagoBERT downtime');
-        this.axios
-            .post(`dagobert-downtime`, Object.assign(Object.assign({}, data), { address }))
-            .then(() => this.logger.log('DagoBERT downtime sent'))
-            .catch(({ response }) => this.logger.error("Couldnt't send DagoBERT downtime...", response.data));
+            .post(endpoint, Object.assign(Object.assign({}, data), { address }))
+            .then(() => this.logger.log('E-Mail sent'))
+            .catch(({ response }) => this.logger.error("Couldn't send E-Mail...", response.data));
     }
 };
 MailService = MailService_1 = __decorate([

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

@@ -1,3 +1,3 @@
-export { SearchableDocument } from './search.models';
+export { SearchableDocument, SearchDocument } from './search.models';
 export { SearchModule } from './search.module';
 export { SearchService } from './search.service';

package/dist/modules/search/index.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchService = exports.SearchModule = exports.SearchableDocument = void 0;
+exports.SearchService = exports.SearchModule = exports.SearchDocument = exports.SearchableDocument = void 0;
 var search_models_1 = require("./search.models");
 Object.defineProperty(exports, "SearchableDocument", { enumerable: true, get: function () { return search_models_1.SearchableDocument; } });
+Object.defineProperty(exports, "SearchDocument", { enumerable: true, get: function () { return search_models_1.SearchDocument; } });
 var search_module_1 = require("./search.module");
 Object.defineProperty(exports, "SearchModule", { enumerable: true, get: function () { return search_module_1.SearchModule; } });
 var search_service_1 = require("./search.service");

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

@@ -17,3 +17,10 @@ export declare class SearchableDocument {
     /** The data of the searchable document. */
     data: object;
 }
+export declare class SearchDocument {
+    id: string;
+    type: string;
+    label: string;
+    url: string;
+    highlight?: string;
+}

package/dist/modules/search/search.models.js

@@ -9,8 +9,9 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchableDocument = void 0;
+exports.SearchDocument = exports.SearchableDocument = void 0;
 const swagger_1 = require("@nestjs/swagger");
+const pipes_1 = require("../../pipes");
 /**
  * Represents a searchable document.
  *
@@ -39,3 +40,26 @@ __decorate([
     __metadata("design:type", Object)
 ], SearchableDocument.prototype, "data", void 0);
 exports.SearchableDocument = SearchableDocument;
+class SearchDocument {
+}
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Id des Ergebnisses' }),
+    __metadata("design:type", String)
+], SearchDocument.prototype, "id", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Typ des Ergebnisses', enum: pipes_1.Targets }),
+    __metadata("design:type", String)
+], SearchDocument.prototype, "type", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Anzeigename des Ergebnisses' }),
+    __metadata("design:type", String)
+], SearchDocument.prototype, "label", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Link zum Ergebnis' }),
+    __metadata("design:type", String)
+], SearchDocument.prototype, "url", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Anzeigename des Ergebnisses mit Highlights (<mark>)' }),
+    __metadata("design:type", String)
+], SearchDocument.prototype, "highlight", void 0);
+exports.SearchDocument = SearchDocument;

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

@@ -1,6 +1,6 @@
 import { ConfigService } from '@nestjs/config';
 import { Targets } from '../../pipes';
-import { SearchableDocument } from './search.models';
+import { SearchableDocument, SearchDocument } from './search.models';
 /**
  * Search service
  * @class SearchService
@@ -32,4 +32,11 @@ export declare class SearchService {
      * @return {void}
      */
     remove(targetId: string): void;
+    /**
+     * Find similar documents from elasticsaech
+     *
+     * @param {string} targetId - the ID of the target to find similar documents of
+     * @returns {Promise<SearchDocument[]>} Promise containing similar documents
+     */
+    similar(targetId: string): Promise<SearchDocument[]>;
 }

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

@@ -11,6 +11,15 @@ 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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var SearchService_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchService = void 0;
@@ -66,6 +75,19 @@ let SearchService = SearchService_1 = class SearchService {
             .then(() => this.logger.log(`Sucessfully removed ${this.target} (${targetId})`))
             .catch(({ response }) => this.logger.error(`Couldn't remove ${this.target} (${targetId})`, response.data));
     }
+    /**
+     * Find similar documents from elasticsaech
+     *
+     * @param {string} targetId - the ID of the target to find similar documents of
+     * @returns {Promise<SearchDocument[]>} Promise containing similar documents
+     */
+    similar(targetId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.logger.log(`Finding similar documents for ${this.target} (${targetId})`);
+            const response = yield this.axios.get(`${this.target}/${targetId}/similar`);
+            return response.data;
+        });
+    }
 };
 SearchService = SearchService_1 = __decorate([
     (0, common_1.Injectable)(),

package/dist/transform/castToArray.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This function casts the input value to an array if it's not an
+ * array, otherwise it returns the original value.
+ */
+export declare function CastToArray(): PropertyDecorator;

package/dist/transform/castToArray.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CastToArray = void 0;
+const class_transformer_1 = require("class-transformer");
+/**
+ * This function casts the input value to an array if it's not an
+ * array, otherwise it returns the original value.
+ */
+function CastToArray() {
+    return (0, class_transformer_1.Transform)(({ value }) => (Array.isArray(value) ? value : [value]));
+}
+exports.CastToArray = CastToArray;

package/dist/transform/index.d.ts

@@ -1,3 +1,4 @@
+export { CastToArray } from './castToArray';
 export { TransformBoolean } from './transformBoolean';
 export { TransformImage } from './transformImage';
 export { TransformNumber } from './transformNumber';
@@ -6,3 +7,4 @@ export { TransformStringArray } from './transformStringArray';
 export { isStringLike, isStringLikeMin, TransformStringLike } from './transformStringLike';
 export { TransformStringLowerCase } from './transformStringLowerCase';
 export { TransformStringSet } from './transformStringSet';
+export { TransformTimestamp } from './transformTimestamp';

package/dist/transform/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransformStringSet = exports.TransformStringLowerCase = exports.TransformStringLike = exports.isStringLikeMin = exports.isStringLike = exports.TransformStringArray = exports.TransformString = exports.TransformNumber = exports.TransformImage = exports.TransformBoolean = void 0;
+exports.TransformTimestamp = exports.TransformStringSet = exports.TransformStringLowerCase = exports.TransformStringLike = exports.isStringLikeMin = exports.isStringLike = exports.TransformStringArray = exports.TransformString = exports.TransformNumber = exports.TransformImage = exports.TransformBoolean = exports.CastToArray = void 0;
+var castToArray_1 = require("./castToArray");
+Object.defineProperty(exports, "CastToArray", { enumerable: true, get: function () { return castToArray_1.CastToArray; } });
 var transformBoolean_1 = require("./transformBoolean");
 Object.defineProperty(exports, "TransformBoolean", { enumerable: true, get: function () { return transformBoolean_1.TransformBoolean; } });
 var transformImage_1 = require("./transformImage");
@@ -19,3 +21,5 @@ var transformStringLowerCase_1 = require("./transformStringLowerCase");
 Object.defineProperty(exports, "TransformStringLowerCase", { enumerable: true, get: function () { return transformStringLowerCase_1.TransformStringLowerCase; } });
 var transformStringSet_1 = require("./transformStringSet");
 Object.defineProperty(exports, "TransformStringSet", { enumerable: true, get: function () { return transformStringSet_1.TransformStringSet; } });
+var transformTimestamp_1 = require("./transformTimestamp");
+Object.defineProperty(exports, "TransformTimestamp", { enumerable: true, get: function () { return transformTimestamp_1.TransformTimestamp; } });

package/dist/transform/transformNumber.d.ts

@@ -1,6 +1,9 @@
 interface NumberOptions {
+    /** Default value if value isnt a number */
     default?: number;
+    /** Maximum value */
     min?: number;
+    /** Minimum value */
     max?: number;
 }
 /**

package/dist/transform/transformTimestamp.d.ts

@@ -0,0 +1,16 @@
+interface NumberOptions {
+    /** Default value if value isnt a number */
+    default?: number;
+    /** Maximum value */
+    min?: number;
+    /** Minimum value */
+    max?: number;
+    /** Round the timestamp to the nearest <unit> */
+    roundTo?: 'ms' | 's' | 'm' | 'h';
+}
+/**
+ * This function transforms the input value to a trimmed number if it's a string
+ * or a number, otherwise it returns the original value.
+ */
+export declare function TransformTimestamp(opts?: NumberOptions): PropertyDecorator;
+export {};

package/dist/transform/transformTimestamp.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformTimestamp = void 0;
+const class_transformer_1 = require("class-transformer");
+/**
+ * This function transforms the input value to a trimmed number if it's a string
+ * or a number, otherwise it returns the original value.
+ */
+function TransformTimestamp(opts = {}) {
+    return (0, class_transformer_1.Transform)(({ value }) => {
+        let number = Number.parseInt(value || String(opts.default), 10);
+        if (Number.isNaN(number) && !opts.default)
+            return value;
+        if (Number.isNaN(number))
+            number = opts.default;
+        if (opts.min && number < opts.min)
+            number = opts.min;
+        if (opts.max && number > opts.max)
+            number = opts.max;
+        if (opts.roundTo === 'h')
+            return new Date(number).setHours(0, 0, 0, 0);
+        if (opts.roundTo === 'm')
+            return new Date(number).setMinutes(0, 0, 0);
+        if (opts.roundTo === 's')
+            return new Date(number).setSeconds(0, 0);
+        if (opts.roundTo === 'ms')
+            return new Date(number).setMilliseconds(0);
+        return number;
+    });
+}
+exports.TransformTimestamp = TransformTimestamp;

package/package.json

@@ -5,7 +5,7 @@
     "email": "timo.scheuermann@sv-informatik.de",
     "url": "https://timos.design"
   },
-  "version": "2.4.3",
+  "version": "2.4.5",
   "type": "commonjs",
   "files": [
     "dist"
@@ -70,5 +70,6 @@
   },
   "lint-staged": {
     "**/*.{ts,json}": []
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610"
 }