@leancodepl/cqrs-client-base

Base types and interfaces for CQRS clients.

Installation

``bash
npm install @leancodepl/cqrs-client-base


or


yarn add @leancodepl/cqrs-client-base
`

API

$3

Interface for token providers used in CQRS clients.

Properties:

- getToken: () => Promise - Returns authentication token
- invalidateToken: () => Promise - Invalidates and refreshes token

$3

Represents validation errors from commands.

Properties:

- PropertyName: string - Property that failed validation
- ErrorMessage: string - Human-readable error message
- ErrorCode: TErrorCodes[keyof TErrorCodes] - Error code from provided map

$3

Union type for command results.

Types:

- SuccessfulCommandResult - When command succeeds
- FailedCommandResult - When command fails with validation errors

$3

Union type for API responses.

Types:

- ApiSuccess - Successful response with result
- ApiError - Error response

Usage Examples

$3

`typescript
import { TokenProvider } from "@leancodepl/cqrs-client-base"

const tokenProvider: TokenProvider = {
getToken: async () => {
return localStorage.getItem("authToken")
},
invalidateToken: async () => {
localStorage.removeItem("authToken")
return true
},
}
`

$3

`typescript
import { CommandResult, ValidationError } from "@leancodepl/cqrs-client-base"

interface UserErrorCodes {
EmailExists: 1
InvalidEmail: 2
}

function handleCommandResult(result: CommandResult) {
if (result.WasSuccessful) {
console.log("Command succeeded")
} else {
result.ValidationErrors.forEach((error: ValidationError) => {
console.log(${error.PropertyName}: ${error.ErrorMessage})
})
}
}
`

$3

`typescript
import { ApiResponse } from "@leancodepl/cqrs-client-base"

function handleApiResponse(response: ApiResponse) {
if (response.isSuccess) {
return response.result
} else {
throw new Error("API call failed")
}
}
``