@flink-app/flink 0.14.2 → 0.14.3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @flink-app/flink
 
+## 0.14.3
+
+### Patch Changes
+
+-   52eba74: Fix Query type constraint to allow user-defined interfaces without explicit index signatures. The Query type now uses explicit index signature syntax, making it easier for developers to define query parameter interfaces for their handlers without TypeScript compilation errors.
+-   b37faa5: Improve schema validation error messages to show specific additional property names. When validation fails due to additional properties, the error now displays which properties are not allowed instead of a generic message.
+
 ## 0.14.2
 
 ### Patch Changes

package/dist/src/FlinkApp.js

@@ -364,7 +364,7 @@ var FlinkApp = /** @class */ (function () {
                                             error: {
                                                 id: (0, uuid_1.v4)(),
                                                 title: "Bad request",
-                                                detail: "Schema did not validate ".concat(JSON.stringify(validateReq_1.errors)),
+                                                detail: formattedErrors,
                                             },
                                         })];
                                 }
@@ -442,7 +442,7 @@ var FlinkApp = /** @class */ (function () {
                                             error: {
                                                 id: (0, uuid_1.v4)(),
                                                 title: "Bad response",
-                                                detail: "Schema did not validate ".concat(JSON.stringify(validateRes_1.errors)),
+                                                detail: formattedErrors,
                                             },
                                         })];
                                 }

package/dist/src/FlinkHttpHandler.d.ts

@@ -15,8 +15,13 @@ type Params = Request["params"];
  * Query type for request query parameters.
  * Does currently not allow nested objects, although
  * underlying express Request does allow it.
+ *
+ * Uses index signature to allow both Record types and interface types
+ * to be assignable to Query without requiring explicit index signatures.
  */
-type Query = Record<string, string | string[] | undefined>;
+type Query = {
+    [x: string]: string | string[] | undefined;
+};
 /**
  * Flink request extends express Request but adds reqId and user object.
  */

package/dist/src/utils.js

@@ -223,6 +223,9 @@ function formatValidationErrors(errors, data, maxDataLength) {
             else if (error.keyword === "type") {
                 formatted.push("  - Invalid type at ".concat(error.schemaPath, ": expected ").concat(error.params.type, ", got ").concat(typeof dataAtPath));
             }
+            else if (error.keyword === "additionalProperties") {
+                formatted.push("  - Additional property not allowed: ".concat(error.params.additionalProperty));
+            }
             else if (error.keyword === "anyOf" || error.keyword === "oneOf") {
                 formatted.push("  - ".concat(error.message));
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/flink",
-  "version": "0.14.2",
+  "version": "0.14.3",
   "description": "Typescript only framework for creating REST-like APIs on top of Express and mongodb",
   "types": "dist/src/index.d.ts",
   "main": "dist/src/index.js",

package/spec/utils.spec.ts

@@ -148,6 +148,33 @@ describe("Utils", () => {
             expect(formatted).toContain('Missing required property: email');
             expect(formatted).toContain('Missing required property: age');
         });
+
+        it("should show specific additional property names", () => {
+            const errors = [
+                {
+                    instancePath: "",
+                    schemaPath: "#/additionalProperties",
+                    keyword: "additionalProperties",
+                    params: { additionalProperty: "extraField1" },
+                    message: "must NOT have additional properties",
+                },
+                {
+                    instancePath: "",
+                    schemaPath: "#/additionalProperties",
+                    keyword: "additionalProperties",
+                    params: { additionalProperty: "extraField2" },
+                    message: "must NOT have additional properties",
+                },
+            ];
+            const data = { name: "John", age: 30, extraField1: "value1", extraField2: "value2" };
+
+            const formatted = formatValidationErrors(errors, data);
+
+            // This formatted output is used in HTTP error responses (400/500) in the error.detail field
+            expect(formatted).toContain('Path: /');
+            expect(formatted).toContain('Additional property not allowed: extraField1');
+            expect(formatted).toContain('Additional property not allowed: extraField2');
+        });
     });
 });
 

package/src/FlinkApp.ts

@@ -562,7 +562,7 @@ export class FlinkApp<C extends FlinkContext> {
                             error: {
                                 id: v4(),
                                 title: "Bad request",
-                                detail: `Schema did not validate ${JSON.stringify(validateReq.errors)}`,
+                                detail: formattedErrors,
                             },
                         });
                     }
@@ -645,7 +645,7 @@ export class FlinkApp<C extends FlinkContext> {
                             error: {
                                 id: v4(),
                                 title: "Bad response",
-                                detail: `Schema did not validate ${JSON.stringify(validateRes.errors)}`,
+                                detail: formattedErrors,
                             },
                         });
                     }

package/src/FlinkHttpHandler.ts

@@ -18,8 +18,13 @@ type Params = Request["params"];
  * Query type for request query parameters.
  * Does currently not allow nested objects, although
  * underlying express Request does allow it.
+ *
+ * Uses index signature to allow both Record types and interface types
+ * to be assignable to Query without requiring explicit index signatures.
  */
-type Query = Record<string, string | string[] | undefined>;
+type Query = {
+    [x: string]: string | string[] | undefined;
+};
 
 /**
  * Flink request extends express Request but adds reqId and user object.

package/src/utils.ts

@@ -165,6 +165,8 @@ export function formatValidationErrors(errors: any[] | null | undefined, data: a
                 formatted.push(`  - Missing required property: ${error.params.missingProperty}`);
             } else if (error.keyword === "type") {
                 formatted.push(`  - Invalid type at ${error.schemaPath}: expected ${error.params.type}, got ${typeof dataAtPath}`);
+            } else if (error.keyword === "additionalProperties") {
+                formatted.push(`  - Additional property not allowed: ${error.params.additionalProperty}`);
             } else if (error.keyword === "anyOf" || error.keyword === "oneOf") {
                 formatted.push(`  - ${error.message}`);
             } else {