@privateaim/server-http-kit 0.7.0

package/src/validation/module.ts

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2022-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { BadRequestError } from '@ebec/http';
+import type { Result, ValidationError } from 'express-validator';
+import { buildHTTPValidationErrorMessage } from './message';
+
+export class HTTPValidationError extends BadRequestError {
+    constructor(validation: Result<ValidationError>) {
+        const errors : ValidationError[] = validation.array();
+
+        const parameterNames = [];
+        for (let i = 0; i < errors.length; i++) {
+            const item = errors[i];
+
+            switch (item.type) {
+                case 'field': {
+                    parameterNames.push(item.path);
+                    break;
+                }
+                case 'alternative': {
+                    parameterNames.push(item.nestedErrors.map(
+                        ((el) => el.path),
+                    ).join('|'));
+                    break;
+                }
+            }
+        }
+
+        let message : string;
+
+        if (parameterNames.length > 0) {
+            message = buildHTTPValidationErrorMessage(Array.from(new Set(parameterNames)));
+        } else {
+            message = 'An unexpected validation error occurred.';
+        }
+
+        super({
+            message,
+            data: {
+                errors,
+            },
+        });
+    }
+}

package/src/validation/result.ts

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2022-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { BadRequestError } from '@ebec/http';
+import { deleteUndefinedObjectProperties } from '@privateaim/kit';
+import type { MatchedDataOptions } from 'express-validator';
+import { matchedData, validationResult } from 'express-validator';
+import type { Request } from 'routup';
+import type { EntityTarget } from 'typeorm';
+import { useDataSource } from 'typeorm-extension';
+import { buildHTTPValidationErrorMessage } from './message';
+import { HTTPValidationError } from './module';
+import type { HTTPValidationExtendKeys, HTTPValidationResult } from './type';
+
+export function createHTTPValidationResult<
+    R extends Record<string, any>,
+    M extends Record<string, any> = Record<string, any>,
+>(req: Request, options: Partial<MatchedDataOptions> = {}) : HTTPValidationResult<R, M> {
+    const validation = validationResult(req);
+    if (!validation.isEmpty()) {
+        throw new HTTPValidationError(validation);
+    }
+
+    return {
+        data: deleteUndefinedObjectProperties(matchedData(req, {
+            includeOptionals: true,
+            ...options,
+        })) as R,
+        meta: {} as M,
+        relation: {},
+    };
+}
+
+export async function extendHTTPValidationResultWithRelation<
+    R extends Record<string, any>,
+    >(
+    result: HTTPValidationResult<R>,
+    target: EntityTarget<any>,
+    keys: HTTPValidationExtendKeys<R>,
+) : Promise<HTTPValidationResult<R>> {
+    if (result.data[keys.id]) {
+        const dataSource = await useDataSource();
+
+        const repository = dataSource.getRepository(target);
+        const entity = await repository.findOneBy({ id: result.data[keys.id] });
+        if (!entity) {
+            throw new BadRequestError(buildHTTPValidationErrorMessage(keys.id));
+        }
+
+        result.relation[keys.entity as keyof HTTPValidationResult<R>['relation']] = entity;
+    }
+
+    return result;
+}

package/src/validation/type.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2022-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export type HTTPValidationResultMetaKey<T extends Record<string, any>> = ({
+    [K in keyof T]?: T[K] extends Record<string, any> ?
+        T[K] extends Date ? never : K :
+        never
+})[keyof T];
+
+export type HTTPValidationResult<
+    T extends Record<string, any>,
+    M extends Record<string, any> = Record<string, any>,
+    > = {
+        data: Partial<T>,
+        relation: {
+            [K in HTTPValidationResultMetaKey<T>]?: T[K]
+        },
+        meta: M
+    };
+
+export type HTTPValidationExtendKeys<T extends Record<string, any>> = {
+    id: keyof T,
+    entity: HTTPValidationResultMetaKey<T>
+};

package/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+    "extends": "../../tsconfig.build.json",
+
+    "compilerOptions": {
+        "outDir": "./dist"
+    },
+
+    "include": [
+        "src/**/*.ts"
+    ]
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+        "paths": {
+            "@privateaim/kit": ["./packages/kit/src"],
+            "@privateaim/server-kit": ["./packages/server-kit/src"]
+        }
+    }
+}