fastify-txstate 3.2.4 → 3.2.6

package/lib/error.d.ts

@@ -1,3 +1,4 @@
+import { type FastifySchemaValidationError } from 'fastify/types/schema';
 export declare class HttpError extends Error {
     statusCode: number;
     constructor(statusCode: number, message?: string);
@@ -7,4 +8,9 @@ export declare class FailedValidationError extends HttpError {
     errors: ValidationErrors;
     constructor(errors: ValidationErrors);
 }
+export declare function fstValidationToMessage(v: FastifySchemaValidationError): {
+    message: string | undefined;
+    path: string;
+    type: string;
+};
 export {};

package/lib/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FailedValidationError = exports.HttpError = void 0;
+exports.fstValidationToMessage = exports.FailedValidationError = exports.HttpError = void 0;
 const http_status_codes_1 = require("http-status-codes");
 class HttpError extends Error {
     constructor(statusCode, message) {
@@ -24,3 +24,8 @@ class FailedValidationError extends HttpError {
     }
 }
 exports.FailedValidationError = FailedValidationError;
+function fstValidationToMessage(v) {
+    const instancePath = v.keyword === 'required' ? v.instancePath + '/' + v.params.missingProperty : v.instancePath;
+    return { message: v.message, path: instancePath.substring(1).replace(/\//g, '.'), type: 'error' };
+}
+exports.fstValidationToMessage = fstValidationToMessage;

package/lib/index.d.ts

@@ -77,7 +77,7 @@ export interface FastifyTxStateOptions extends Partial<FastifyServerOptions> {
      *
      * If this function throws, the client will receive a 401 response.
      */
-    authenticate?: <T extends FastifyTxStateAuthInfo>(req: FastifyRequest) => Promise<T | undefined>;
+    authenticate?: (req: FastifyRequest) => Promise<FastifyTxStateAuthInfo | undefined>;
 }
 declare module 'fastify' {
     interface FastifyRequest {

package/lib/index.js

@@ -20,6 +20,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.prodLogger = exports.devLogger = void 0;
 const swagger_1 = __importDefault(require("@fastify/swagger"));
 const swagger_ui_1 = __importDefault(require("@fastify/swagger-ui"));
+const fastify_shared_1 = require("@txstate-mws/fastify-shared");
 const ajv_errors_1 = __importDefault(require("ajv-errors"));
 const ajv_formats_1 = __importDefault(require("ajv-formats"));
 const fastify_1 = require("fastify");
@@ -108,25 +109,10 @@ class Server {
             if (!((_a = route.schema) === null || _a === void 0 ? void 0 : _a.body))
                 return;
             const missingResponse = ((_b = route.schema) === null || _b === void 0 ? void 0 : _b.response) == null;
-            const newSchema = (0, txstate_utils_1.set)((_c = route.schema) !== null && _c !== void 0 ? _c : {}, 'response.422', {
-                description: 'Validation failure.',
-                type: 'object',
-                properties: {
-                    errors: {
-                        type: 'array',
-                        items: {
-                            type: 'object',
-                            properties: {
-                                type: { type: 'string', enum: ['error', 'warning', 'success', 'system'], example: 'error' },
-                                message: { type: 'string', example: 'must be an integer' },
-                                path: { type: 'string', example: 'cart.item.0.quantity', description: 'Dot-separated path to the field in the request body that caused the validation error.' }
-                            },
-                            required: ['type', 'message'],
-                            additionalProperties: false
-                        }
-                    }
-                }
-            });
+            const response400 = (0, txstate_utils_1.set)(fastify_shared_1.validatedResponse.properties.messages, 'description', 'Basic validation failure. This means that the UI provided input that failed validation as defined in the openapi specification published by the API. The UI is at fault and should be re-coded to avoid sending invalid data.');
+            let newSchema = (0, txstate_utils_1.set)((_c = route.schema) !== null && _c !== void 0 ? _c : {}, 'response.400', response400);
+            const response422 = (0, txstate_utils_1.set)(fastify_shared_1.validatedResponse, 'description', 'Validation failure. This means that the user provided an invalid object. The user should be shown their error so that they can correct it.');
+            newSchema = (0, txstate_utils_1.set)(newSchema, 'response.422', response422);
             if (missingResponse) {
                 newSchema.response['200'] = {
                     description: 'Success. Return type has not been specified.',
@@ -213,7 +199,7 @@ class Server {
             });
         this.app.setNotFoundHandler((req, res) => { void res.status(404).send('Not Found.'); });
         this.app.setErrorHandler(async (err, req, res) => {
-            var _a, _b;
+            var _a;
             req.log.warn(err);
             for (const errorHandler of this.errorHandlers) {
                 if (!res.sent)
@@ -227,7 +213,28 @@ class Server {
                     await res.status(err.statusCode).send(err.message);
                 }
                 else if (err.code === 'FST_ERR_VALIDATION') {
-                    await res.status(422).send({ errors: (_b = (_a = err.validation) === null || _a === void 0 ? void 0 : _a.map(err => ({ message: err.message, path: err.instancePath.substring(1).replace(/\//g, '.'), type: 'error' }))) !== null && _b !== void 0 ? _b : [] });
+                    const developerErrors = [];
+                    const userErrors = [];
+                    for (const v of (_a = err.validation) !== null && _a !== void 0 ? _a : []) {
+                        if (v.keyword === 'errorMessage') {
+                            for (const ov of v.params.errors) {
+                                if (['type', 'additionalProperties'].includes(ov.keyword))
+                                    developerErrors.push({ ...ov, message: v.message });
+                                else
+                                    userErrors.push({ ...ov, message: v.message });
+                            }
+                        }
+                        else {
+                            if (['type', 'additionalProperties'].includes(v.keyword))
+                                developerErrors.push(v);
+                            else
+                                userErrors.push(v);
+                        }
+                    }
+                    if (userErrors.length)
+                        await res.status(422).send({ success: false, messages: userErrors.map(error_1.fstValidationToMessage) });
+                    else
+                        await res.status(400).send(developerErrors.map(error_1.fstValidationToMessage));
                 }
                 else if (err.statusCode) {
                     await res.status(err.statusCode).send(new error_1.HttpError(err.statusCode).message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-txstate",
-  "version": "3.2.4",
+  "version": "3.2.6",
   "description": "A small wrapper for fastify providing a set of common conventions & utility functions we use.",
   "exports": {
     ".": {
@@ -22,7 +22,7 @@
     "@fastify/swagger": "^8.14.0",
     "@fastify/swagger-ui": "^3.0.0",
     "@fastify/type-provider-json-schema-to-ts": "^3.0.0",
-    "@txstate-mws/fastify-shared": "^1.0.4",
+    "@txstate-mws/fastify-shared": "^1.0.9",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^2.1.1",
     "fastify": "^4.9.2",