snap-on-openapi 1.0.1

package/dist/types/errors/responses/ValidationErrorResponse.d.ts

@@ -0,0 +1,89 @@
+import 'zod-openapi/extend';
+import { z } from 'zod';
+import { ErrorCode } from '../../../enums/ErrorCode.js';
+import { ValidationLocation } from '../../../enums/ValidationLocations.js';
+export declare const validationErrorResponseValidator: z.ZodObject<{
+    error: z.ZodObject<{
+        code: z.ZodLiteral<ErrorCode.ValidationFailed>;
+        fieldErrors: z.ZodArray<z.ZodObject<{
+            field: z.ZodString;
+            message: z.ZodString;
+        } & {
+            fieldErrors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                field: z.ZodString;
+                message: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                field: string;
+            }, {
+                message: string;
+                field: string;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            field: string;
+            fieldErrors?: {
+                message: string;
+                field: string;
+            }[] | undefined;
+        }, {
+            message: string;
+            field: string;
+            fieldErrors?: {
+                message: string;
+                field: string;
+            }[] | undefined;
+        }>, "many">;
+        location: z.ZodNativeEnum<typeof ValidationLocation>;
+    }, "strip", z.ZodTypeAny, {
+        code: ErrorCode.ValidationFailed;
+        fieldErrors: {
+            message: string;
+            field: string;
+            fieldErrors?: {
+                message: string;
+                field: string;
+            }[] | undefined;
+        }[];
+        location: ValidationLocation;
+    }, {
+        code: ErrorCode.ValidationFailed;
+        fieldErrors: {
+            message: string;
+            field: string;
+            fieldErrors?: {
+                message: string;
+                field: string;
+            }[] | undefined;
+        }[];
+        location: ValidationLocation;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    error: {
+        code: ErrorCode.ValidationFailed;
+        fieldErrors: {
+            message: string;
+            field: string;
+            fieldErrors?: {
+                message: string;
+                field: string;
+            }[] | undefined;
+        }[];
+        location: ValidationLocation;
+    };
+}, {
+    error: {
+        code: ErrorCode.ValidationFailed;
+        fieldErrors: {
+            message: string;
+            field: string;
+            fieldErrors?: {
+                message: string;
+                field: string;
+            }[] | undefined;
+        }[];
+        location: ValidationLocation;
+    };
+}>;
+export type ValidationErrorResponseValidator = typeof validationErrorResponseValidator;
+export type ValidationErrorResponse = z.TypeOf<ValidationErrorResponseValidator>;

package/dist/types/errors/responses/ValidationErrorResponse.js

@@ -0,0 +1,12 @@
+import 'zod-openapi/extend';
+import { z } from 'zod';
+import { ErrorCode } from '../../../enums/ErrorCode.js';
+import { fieldErrorValidator } from '../FieldError.js';
+import { ValidationLocation } from '../../../enums/ValidationLocations.js';
+export const validationErrorResponseValidator = z.object({
+    error: z.object({
+        code: z.literal(ErrorCode.ValidationFailed).openapi({ description: 'Code to handle on the frontend' }),
+        fieldErrors: fieldErrorValidator.array(),
+        location: z.nativeEnum(ValidationLocation),
+    }).openapi({ description: 'Error response' }),
+});

package/dist/vitest.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfig;
+export default _default;

package/dist/vitest.config.js

@@ -0,0 +1,25 @@
+import { defineConfig } from 'vitest/config';
+export default defineConfig({
+    test: {
+        reporters: ['verbose', 'html'],
+        coverage: {
+            exclude: [
+                'html/**',
+                'dist/**',
+                'vitest.config.ts',
+                'vitest',
+                'index.ts',
+                'eslint.config.mjs',
+                'overrides.d.ts',
+                'reset.d.ts',
+            ],
+            reportsDirectory: 'html/coverage',
+            reporter: [
+                ['html-spa', { subdir: 'spa' }],
+                ['html', { subdir: 'html' }],
+                ['text'],
+            ],
+            provider: 'v8',
+        },
+    },
+});

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "snap-on-openapi",
+  "author": "Alex Sarychev",
+  "version": "1.0.1",
+  "description": "Swiftly build type-checked OpenAPI applications with Zod and TypeScript",
+  "type": "module",
+  "license": "ISC",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": [
+      "./dist/index.js",
+      "./dist/index.d.ts"
+    ]
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc && tsc-alias && cp -R ./assets ./dist && cp ./README.md ./dist",
+    "check": "npm run test:typecheck && npm run lint && npm run test",
+    "test": "vitest --run",
+    "test:gha": "npx vitest --run --coverage --reporter=verbose",
+    "test:typecheck": "tsc  -p tsconfig.test.json",
+    "test:coverage": "npm run test:coverage:html ; npm run test:swap-html-coverage  ; vite preview --outDir html --open",
+    "test:coverage:html": "npm run test -- --coverage",
+    "test:swap-html-coverage": "rm -R ./html/coverage/html && mv ./html/coverage/spa ./html/coverage/html",
+    "lint": "eslint . --fix"
+  },
+  "dependencies": {
+    "@hey-api/client-axios": "^0.9.1",
+    "@hey-api/openapi-ts": "^0.76.0",
+    "yaml": "^2.8.0",
+    "zod": "^3.25.67",
+    "zod-openapi": "^4.2.4"
+  },
+  "devDependencies": {
+    "@total-typescript/ts-reset": "^0.6.1",
+    "@types/express": "^5.0.3",
+    "@types/node": "^24.0.3",
+    "@types/supertest": "^6.0.3",
+    "@vitest/coverage-istanbul": "^3.2.4",
+    "@vitest/coverage-v8": "^3.2.4",
+    "@vitest/ui": "^3.2.4",
+    "eslint": "^9.29.0",
+    "eslint-plugin-import": "^2.32.0",
+    "express": "^5.1.0",
+    "jest": "^30.0.2",
+    "supertest": "^7.1.1",
+    "tsc-alias": "^1.8.16",
+    "typescript-eslint": "^8.34.1",
+    "vite": "^7.0.0",
+    "vitest": "^3.2.4"
+  }
+}