itlab-internal-services 2.4.2 → 2.4.3

package/dist/models/filter/limit.property.js

@@ -4,8 +4,9 @@ exports.PropertyLimit = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const class_validator_1 = require("class-validator");
+const transform_1 = require("../../transform");
 /**
  * Creates a PropertyLimitDecorator with the given options.
  */
-const PropertyLimit = () => (0, common_1.applyDecorators)((0, swagger_1.ApiProperty)({ required: false, minimum: 0, example: 10, description: 'Die maximale Anzahl der Ergebnisse' }), (0, class_validator_1.IsOptional)(), (0, class_validator_1.Min)(0));
+const PropertyLimit = () => (0, common_1.applyDecorators)((0, swagger_1.ApiPropertyOptional)({ minimum: 0, default: 10, description: 'Die maximale Anzahl der Ergebnisse' }), (0, transform_1.TransformNumber)({ default: 10, min: 0 }), (0, class_validator_1.IsOptional)(), (0, class_validator_1.Min)(0));
 exports.PropertyLimit = PropertyLimit;

package/dist/models/filter/skip.property.js

@@ -4,13 +4,9 @@ exports.PropertySkip = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const class_validator_1 = require("class-validator");
+const transform_1 = require("../../transform");
 /**
  * Creates a PropertySkipDecorator with the given options.
  */
-const PropertySkip = () => (0, common_1.applyDecorators)((0, swagger_1.ApiProperty)({
-    required: false,
-    minimum: 0,
-    example: 0,
-    description: 'Die Anzahl der zu überspringenden Ergebnisse',
-}), (0, class_validator_1.IsOptional)(), (0, class_validator_1.Min)(0));
+const PropertySkip = () => (0, common_1.applyDecorators)((0, swagger_1.ApiPropertyOptional)({ minimum: 0, default: 0, description: 'Die Anzahl der zu überspringenden Ergebnisse' }), (0, transform_1.TransformNumber)({ default: 0, min: 0 }), (0, class_validator_1.IsOptional)(), (0, class_validator_1.Min)(0));
 exports.PropertySkip = PropertySkip;

package/dist/models/filter/sort-direction.property.js

@@ -4,13 +4,15 @@ exports.PropertySortDirection = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const class_validator_1 = require("class-validator");
+const transform_1 = require("../../transform");
 /**
  * Creates a PropertySortDirectionDecorator with the given options.
  */
-const PropertySortDirection = () => (0, common_1.applyDecorators)((0, swagger_1.ApiProperty)({
-    required: false,
-    description: 'Die Reihenfolge der Ergebnisse (1 = aufsteigend, -1 = absteigend)',
-    examples: [-1, 1],
-    default: -1,
-}), (0, class_validator_1.IsOptional)(), (0, class_validator_1.IsIn)([-1, 1]));
+const PropertySortDirection = () => (0, common_1.applyDecorators)((0, swagger_1.ApiPropertyOptional)({
+    description: 'Die Reihenfolge der Ergebnisse (1 = aufsteigend, -1 = absteigend [default])',
+    examples: {
+        asc: { value: 1, summary: 'Aufsteigend' },
+        desc: { value: -1, summary: 'Absteigend (Standard)' },
+    },
+}), (0, transform_1.TransformNumber)({ default: -1, min: -1, max: 1 }), (0, class_validator_1.IsOptional)(), (0, class_validator_1.IsIn)([-1, 1]));
 exports.PropertySortDirection = PropertySortDirection;

package/dist/models/filter/sort-field.property.js

@@ -7,11 +7,9 @@ const class_validator_1 = require("class-validator");
 /**
  * Creates a PropertySortFieldDecorator with the given options.
  */
-const PropertySortField = () => (0, common_1.applyDecorators)((0, swagger_1.ApiProperty)({
-    required: false,
+const PropertySortField = () => (0, common_1.applyDecorators)((0, swagger_1.ApiPropertyOptional)({
     description: 'Das Feld, nach dem sortiert werden soll',
-    examples: ['title', 'timestamp', 'createdAt', 'updatedAt', '_id'],
-    example: 'title',
     default: '_id',
+    example: 'title',
 }), (0, class_validator_1.IsOptional)(), (0, class_validator_1.MinLength)(1));
 exports.PropertySortField = PropertySortField;

package/dist/models/search-result.d.ts

@@ -1,3 +1,4 @@
+import { Type } from '@nestjs/common';
 /**
  * Represents the result of a search operation.
  *
@@ -6,9 +7,10 @@
  * @property {T[]} results - Array of found objects.
  * @property {number} total - Total number of objects without pagination.
  */
-export declare class SearchResult<T> {
+export declare class SearchResult<TData> {
     /** Array of found objects. */
-    results: T[];
+    results: TData[];
     /** Total number of objects without pagination. */
     total: number;
 }
+export declare const ApiSearchResultResponse: <TModel extends Type<any>>(model: TModel) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/dist/models/search-result.js

@@ -9,7 +9,8 @@ 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.SearchResult = void 0;
+exports.ApiSearchResultResponse = exports.SearchResult = void 0;
+const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 /**
  * Represents the result of a search operation.
@@ -22,11 +23,29 @@ const swagger_1 = require("@nestjs/swagger");
 class SearchResult {
 }
 __decorate([
-    (0, swagger_1.ApiProperty)({ description: 'Gefundene Events', type: [Object] }),
+    (0, swagger_1.ApiProperty)({ description: 'Gefundene Elemente', type: [Object] }),
     __metadata("design:type", Array)
 ], SearchResult.prototype, "results", void 0);
 __decorate([
-    (0, swagger_1.ApiProperty)({ description: 'Insgesamt auffindbare Events', example: 17 }),
+    (0, swagger_1.ApiProperty)({ description: 'Insgesamt verfügbare Elemente', example: 17 }),
     __metadata("design:type", Number)
 ], SearchResult.prototype, "total", void 0);
 exports.SearchResult = SearchResult;
+const ApiSearchResultResponse = (model) => (0, common_1.applyDecorators)((0, swagger_1.ApiExtraModels)(SearchResult, model), (0, swagger_1.ApiOkResponse)({
+    description: 'Gefundene Elemente',
+    schema: {
+        title: `SearchResultOf${model.name}`,
+        allOf: [
+            { $ref: (0, swagger_1.getSchemaPath)(SearchResult) },
+            {
+                properties: {
+                    results: {
+                        type: 'array',
+                        items: { $ref: (0, swagger_1.getSchemaPath)(model) },
+                    },
+                },
+            },
+        ],
+    },
+}));
+exports.ApiSearchResultResponse = ApiSearchResultResponse;

package/dist/pipes/hid.pipe.js

@@ -58,14 +58,7 @@ exports.Hid = Hid;
  * @param {string} param - the parameter for the API HID
  * @return A decorator that creates an API HID with the given parameter
  */
-const ApiHid = (param) => (0, common_1.applyDecorators)((0, swagger_1.ApiParam)({
-    name: param,
-    example: 'hallo-welt',
-    examples: {
-        'Hallo Welt': { value: 'hallo-welt' },
-        'Heute ist ein toller Tag': { value: 'heute-ist-ein-toller-tag' },
-    },
-}), (0, swagger_1.ApiResponse)({ description, status }));
+const ApiHid = (param) => (0, common_1.applyDecorators)((0, swagger_1.ApiParam)({ name: param, example: 'hallo-welt' }), (0, swagger_1.ApiResponse)({ description, status }));
 exports.ApiHid = ApiHid;
 /**
  * Check if the given value is a valid hub ID.

package/dist/pipes/target.pipe.js

@@ -79,12 +79,5 @@ exports.Target = Target;
  * @param {string} param - the parameter for the API target
  * @return A decorator that creates an API target with the given parameter
  */
-const ApiTarget = (param) => (0, common_1.applyDecorators)((0, swagger_1.ApiParam)({
-    name: param,
-    example: Targets.NEWSROOM,
-    examples: Object.entries(Targets).reduce((map, [value, key]) => {
-        map[key] = { value };
-        return map;
-    }, {}),
-}), (0, swagger_1.ApiResponse)({ description, status }));
+const ApiTarget = (param) => (0, common_1.applyDecorators)((0, swagger_1.ApiParam)({ name: param, enum: Targets }), (0, swagger_1.ApiResponse)({ description, status }));
 exports.ApiTarget = ApiTarget;

package/dist/transform/index.d.ts

@@ -1,4 +1,6 @@
+export { TransformBoolean } from './transformBoolean';
 export { TransformImage } from './transformImage';
+export { TransformNumber } from './transformNumber';
 export { TransformString } from './transformString';
 export { TransformStringArray } from './transformStringArray';
 export { isStringLike, isStringLikeMin, TransformStringLike } from './transformStringLike';

package/dist/transform/index.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransformStringSet = exports.TransformStringLowerCase = exports.TransformStringLike = exports.isStringLikeMin = exports.isStringLike = exports.TransformStringArray = exports.TransformString = exports.TransformImage = void 0;
+exports.TransformStringSet = exports.TransformStringLowerCase = exports.TransformStringLike = exports.isStringLikeMin = exports.isStringLike = exports.TransformStringArray = exports.TransformString = exports.TransformNumber = exports.TransformImage = exports.TransformBoolean = void 0;
+var transformBoolean_1 = require("./transformBoolean");
+Object.defineProperty(exports, "TransformBoolean", { enumerable: true, get: function () { return transformBoolean_1.TransformBoolean; } });
 var transformImage_1 = require("./transformImage");
 Object.defineProperty(exports, "TransformImage", { enumerable: true, get: function () { return transformImage_1.TransformImage; } });
+var transformNumber_1 = require("./transformNumber");
+Object.defineProperty(exports, "TransformNumber", { enumerable: true, get: function () { return transformNumber_1.TransformNumber; } });
 var transformString_1 = require("./transformString");
 Object.defineProperty(exports, "TransformString", { enumerable: true, get: function () { return transformString_1.TransformString; } });
 var transformStringArray_1 = require("./transformStringArray");

package/dist/transform/transformBoolean.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 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 TransformBoolean(): PropertyDecorator;

package/dist/transform/transformBoolean.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformBoolean = void 0;
+const class_transformer_1 = require("class-transformer");
+const transformStringLike_1 = require("./transformStringLike");
+const _trim_1 = require("./_trim");
+/**
+ * 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 TransformBoolean() {
+    return (0, class_transformer_1.Transform)(({ value }) => {
+        if ((0, transformStringLike_1.isStringLike)(value))
+            value = (0, _trim_1.trimStringLike)(value).toLowerCase();
+        if (value === true || value === 'true' || value === 1 || value === '1')
+            return true;
+        if (value === false || value === 'false' || value === 0 || value === '0')
+            return false;
+        return value;
+    });
+}
+exports.TransformBoolean = TransformBoolean;

package/dist/transform/transformNumber.d.ts

@@ -0,0 +1,11 @@
+interface NumberOptions {
+    default?: number;
+    min?: number;
+    max?: number;
+}
+/**
+ * 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 TransformNumber(opts?: NumberOptions): PropertyDecorator;
+export {};

package/dist/transform/transformNumber.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformNumber = 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 TransformNumber(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;
+        return number;
+    });
+}
+exports.TransformNumber = TransformNumber;

package/package.json

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