@leancodepl/validation 8.4.0 → 8.5.1

package/README.md

@@ -0,0 +1,106 @@
+# @leancodepl/validation
+
+TypeScript library for handling validation errors in CQRS command responses with type-safe error code mapping.
+
+## Installation
+
+```bash
+npm install @leancodepl/validation
+# or
+yarn add @leancodepl/validation
+```
+
+## API
+
+### `handleValidationErrors(validationErrors, errorCodesMap, validationResults)`
+
+Creates a validation error handler that processes errors with type-safe error code mapping.
+
+**Parameters:**
+
+- `validationErrors: ValidationError<TAllErrors>[]` - Array of validation errors to process
+- `errorCodesMap: TAllErrors` - Mapping of error names to numeric codes
+- `validationResults?: TInResult[]` - Optional array of previous handler results
+
+**Returns:** Handler with `handle`, `handleAll`, and `check` methods
+
+### `handleResponse(response, errorCodesMap)`
+
+Handles CQRS command responses and transforms them into validation error handlers.
+
+**Parameters:**
+
+- `response: ApiResponse<CommandResult<TErrors>>` - API response containing command result
+- `errorCodesMap: TErrors` - Mapping of error names to numeric codes
+
+**Returns:** Validation error handler with success/failure support
+
+## Usage Examples
+
+### Basic Error Handling
+
+```typescript
+import { handleValidationErrors } from "@leancodepl/validation"
+
+const errorCodes = { EmailExists: 1, InvalidEmail: 2 } as const
+const errors = [
+    { ErrorCode: 1, ErrorMessage: "Email exists", PropertyName: "Email", AttemptedValue: "user@example.com" },
+]
+
+handleValidationErrors(errors, errorCodes)
+    .handle("EmailExists", () => console.log("Email already registered"))
+    .handle("InvalidEmail", () => console.log("Invalid email format"))
+    .check()
+```
+
+### Command Response Handling
+
+```typescript
+import { handleResponse } from "@leancodepl/validation"
+
+const errorCodes = { UserNotFound: 1 } as const
+const response = await fetch("/api/users/123", { method: "PUT", body: JSON.stringify({ name: "John" }) })
+
+handleResponse(response, errorCodes)
+    .handle("success", () => console.log("User updated"))
+    .handle("UserNotFound", () => console.log("User not found"))
+    .handle("failure", () => console.log("Request failed"))
+    .check()
+```
+
+### Multiple Error Handling
+
+```typescript
+import { handleValidationErrors } from "@leancodepl/validation"
+
+const errorCodes = { Required: 1, Invalid: 2 } as const
+const errors = [
+    { ErrorCode: 1, PropertyName: "email", ErrorMessage: "Email required" },
+    { ErrorCode: 2, PropertyName: "name", ErrorMessage: "Invalid name" },
+]
+
+handleValidationErrors(errors, errorCodes)
+    .handleAll(["Required", "Invalid"], errorGroups => {
+        errorGroups.forEach(({ errors }) => {
+            errors.forEach(error => console.log(`${error.PropertyName}: ${error.ErrorMessage}`))
+        })
+    })
+    .check()
+```
+
+### Success/Failure Result Processing
+
+```typescript
+import { handleResponse } from "@leancodepl/validation"
+
+const errorCodes = { InvalidData: 1 } as const
+const response = await fetch("/api/data")
+
+const isSuccess = handleResponse(response, errorCodes)
+    .handle("success", () => true)
+    .handle(["InvalidData", "failure"], () => false)
+    .check({
+        reducer: (prev, current) => prev && current,
+        initialValue: true,
+    })
+```

package/index.cjs.js

@@ -1,6 +1,25 @@
 'use strict';
 
-function handleValidationErrors(validationErrors, errorCodesMap, validationResults = []) {
+/**
+ * Creates a validation error handler that processes errors with type-safe error code mapping.
+ * 
+ * @template TAllErrors - Error codes map type extending Record<string, number>
+ * @template TInResult - Type of results accumulated from previous handlers
+ * @param validationErrors - Array of validation errors to process
+ * @param errorCodesMap - Mapping of error names to numeric codes
+ * @param validationResults - Optional array of previous handler results
+ * @returns Handler with handle, handleAll, and check methods
+ * @example
+ * ```typescript
+ * const errorCodes = { EmailExists: 1, InvalidEmail: 2 } as const;
+ * const errors = [{ ErrorCode: 1, ErrorMessage: 'Email exists', PropertyName: 'Email', AttemptedValue: 'test@example.com' }];
+ * 
+ * handleValidationErrors(errors, errorCodes)
+ *   .handle('EmailExists', () => console.warn('Email already registered'))
+ *   .handle('InvalidEmail', () => console.warn('Invalid email format'))
+ *   .check();
+ * ```
+ */ function handleValidationErrors(validationErrors, errorCodesMap, validationResults = []) {
     const handle = (validationErrorsToHandle, handler)=>{
         let result = undefined;
         for (const validationErrorToHandle of Array.isArray(validationErrorsToHandle) ? validationErrorsToHandle : [
@@ -63,7 +82,25 @@ function handleValidationErrors(validationErrors, errorCodesMap, validationResul
     };
 }
 
-function handleResponse(response, errorCodesMap) {
+/**
+ * Handles CQRS command responses and transforms them into validation error handlers.
+ * 
+ * @template TErrors - Error codes map type extending Record<string, number>
+ * @param response - API response containing command result
+ * @param errorCodesMap - Mapping of error names to numeric codes
+ * @returns Validation error handler with success/failure support
+ * @example
+ * ```typescript
+ * const errorCodes = { UserNotFound: 1 } as const;
+ * const response = await commandClient.execute(createUserCommand);
+ * 
+ * handleResponse(response, errorCodes)
+ *   .handle('success', () => console.log('User created'))
+ *   .handle('failure', () => console.log('Network error'))
+ *   .handle('UserNotFound', () => console.log('User not found'))
+ *   .check();
+ * ```
+ */ function handleResponse(response, errorCodesMap) {
     const newErrorCodesMap = {
         ...errorCodesMap,
         success: -1,

package/index.esm.js

@@ -1,4 +1,23 @@
-function handleValidationErrors(validationErrors, errorCodesMap, validationResults = []) {
+/**
+ * Creates a validation error handler that processes errors with type-safe error code mapping.
+ * 
+ * @template TAllErrors - Error codes map type extending Record<string, number>
+ * @template TInResult - Type of results accumulated from previous handlers
+ * @param validationErrors - Array of validation errors to process
+ * @param errorCodesMap - Mapping of error names to numeric codes
+ * @param validationResults - Optional array of previous handler results
+ * @returns Handler with handle, handleAll, and check methods
+ * @example
+ * ```typescript
+ * const errorCodes = { EmailExists: 1, InvalidEmail: 2 } as const;
+ * const errors = [{ ErrorCode: 1, ErrorMessage: 'Email exists', PropertyName: 'Email', AttemptedValue: 'test@example.com' }];
+ * 
+ * handleValidationErrors(errors, errorCodes)
+ *   .handle('EmailExists', () => console.warn('Email already registered'))
+ *   .handle('InvalidEmail', () => console.warn('Invalid email format'))
+ *   .check();
+ * ```
+ */ function handleValidationErrors(validationErrors, errorCodesMap, validationResults = []) {
     const handle = (validationErrorsToHandle, handler)=>{
         let result = undefined;
         for (const validationErrorToHandle of Array.isArray(validationErrorsToHandle) ? validationErrorsToHandle : [
@@ -61,7 +80,25 @@ function handleValidationErrors(validationErrors, errorCodesMap, validationResul
     };
 }
 
-function handleResponse(response, errorCodesMap) {
+/**
+ * Handles CQRS command responses and transforms them into validation error handlers.
+ * 
+ * @template TErrors - Error codes map type extending Record<string, number>
+ * @param response - API response containing command result
+ * @param errorCodesMap - Mapping of error names to numeric codes
+ * @returns Validation error handler with success/failure support
+ * @example
+ * ```typescript
+ * const errorCodes = { UserNotFound: 1 } as const;
+ * const response = await commandClient.execute(createUserCommand);
+ * 
+ * handleResponse(response, errorCodes)
+ *   .handle('success', () => console.log('User created'))
+ *   .handle('failure', () => console.log('Network error'))
+ *   .handle('UserNotFound', () => console.log('User not found'))
+ *   .check();
+ * ```
+ */ function handleResponse(response, errorCodesMap) {
     const newErrorCodesMap = {
         ...errorCodesMap,
         success: -1,

package/package.json

@@ -1,23 +1,54 @@
 {
   "name": "@leancodepl/validation",
-  "version": "8.4.0",
+  "version": "8.5.1",
   "license": "Apache-2.0",
   "dependencies": {
-    "@leancodepl/cqrs-client-base": "8.4.0"
+    "@leancodepl/cqrs-client-base": "8.5.1"
   },
   "devDependencies": {
     "sinon": "15.2.0"
   },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leancodepl/js_corelibrary.git",
+    "directory": "packages/validation"
+  },
+  "homepage": "https://github.com/leancodepl/js_corelibrary",
+  "bugs": {
+    "url": "https://github.com/leancodepl/js_corelibrary/issues"
+  },
+  "description": "CQRS validation helpers for command and query validation",
+  "keywords": [
+    "cqrs",
+    "validation",
+    "commands",
+    "queries",
+    "typescript",
+    "javascript",
+    "leancode"
+  ],
+  "author": {
+    "name": "LeanCode",
+    "url": "https://leancode.co"
+  },
+  "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "module": "./index.esm.js",
-      "types": "./index.esm.d.ts",
+      "types": "./index.d.ts",
       "import": "./index.cjs.mjs",
       "default": "./index.cjs.js"
     }
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "types": "./index.esm.d.ts"
+  "types": "./index.d.ts"
 }

package/src/lib/handleResponse.d.ts

@@ -3,6 +3,25 @@ export type SuccessOrFailureMarker = {
     success: -1;
     failure: -2;
 };
+/**
+ * Handles CQRS command responses and transforms them into validation error handlers.
+ *
+ * @template TErrors - Error codes map type extending Record<string, number>
+ * @param response - API response containing command result
+ * @param errorCodesMap - Mapping of error names to numeric codes
+ * @returns Validation error handler with success/failure support
+ * @example
+ * ```typescript
+ * const errorCodes = { UserNotFound: 1 } as const;
+ * const response = await commandClient.execute(createUserCommand);
+ *
+ * handleResponse(response, errorCodes)
+ *   .handle('success', () => console.log('User created'))
+ *   .handle('failure', () => console.log('Network error'))
+ *   .handle('UserNotFound', () => console.log('User not found'))
+ *   .check();
+ * ```
+ */
 export declare function handleResponse<TErrors extends Record<string, number>>(response: ApiResponse<CommandResult<TErrors>>, errorCodesMap: TErrors): import("./handleValidationErrors").ValidationErrorsHandler<TErrors & {
     readonly success: -1;
     readonly failure: -2;

package/src/lib/handleValidationErrors.d.ts

@@ -20,4 +20,24 @@ export interface ValidationErrorsHandler<TRemainingErrors extends Record<string,
     handleAll: ValidationErrorsHandleAllFunc<TRemainingErrors, TResult>;
     check: object extends TRemainingErrors ? <TReturnValue = void>(reducer?: ReducerDescription<TResult, TReturnValue>) => TReturnValue : unknown;
 }
+/**
+ * Creates a validation error handler that processes errors with type-safe error code mapping.
+ *
+ * @template TAllErrors - Error codes map type extending Record<string, number>
+ * @template TInResult - Type of results accumulated from previous handlers
+ * @param validationErrors - Array of validation errors to process
+ * @param errorCodesMap - Mapping of error names to numeric codes
+ * @param validationResults - Optional array of previous handler results
+ * @returns Handler with handle, handleAll, and check methods
+ * @example
+ * ```typescript
+ * const errorCodes = { EmailExists: 1, InvalidEmail: 2 } as const;
+ * const errors = [{ ErrorCode: 1, ErrorMessage: 'Email exists', PropertyName: 'Email', AttemptedValue: 'test@example.com' }];
+ *
+ * handleValidationErrors(errors, errorCodes)
+ *   .handle('EmailExists', () => console.warn('Email already registered'))
+ *   .handle('InvalidEmail', () => console.warn('Invalid email format'))
+ *   .check();
+ * ```
+ */
 export declare function handleValidationErrors<TAllErrors extends Record<string, number>, TInResult = never>(validationErrors: ValidationError<TAllErrors>[], errorCodesMap: TAllErrors, validationResults?: TInResult[]): ValidationErrorsHandler<TAllErrors, TInResult>;

package/index.esm.d.ts

@@ -1 +0,0 @@
-export * from "./src/index";