@leancodepl/cqrs-client-base 8.5.0 → 8.5.1

package/README.md

@@ -0,0 +1,100 @@
+# @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
+
+### `TokenProvider`
+
+Interface for token providers used in CQRS clients.
+
+**Properties:**
+- `getToken: () => Promise<string | undefined>` - Returns authentication token
+- `invalidateToken: () => Promise<boolean>` - Invalidates and refreshes token
+
+### `ValidationError<TErrorCodes>`
+
+Represents validation errors from commands.
+
+**Properties:**
+- `PropertyName: string` - Property that failed validation
+- `ErrorMessage: string` - Human-readable error message
+- `AttemptedValue: unknown` - Value that was attempted
+- `ErrorCode: TErrorCodes[keyof TErrorCodes]` - Error code from provided map
+
+### `CommandResult<TErrorCodes>`
+
+Union type for command results.
+
+**Types:**
+- `SuccessfulCommandResult` - When command succeeds
+- `FailedCommandResult<TErrorCodes>` - When command fails with validation errors
+
+### `ApiResponse<TResult>`
+
+Union type for API responses.
+
+**Types:**
+- `ApiSuccess<TResult>` - Successful response with result
+- `ApiError` - Error response
+
+## Usage Examples
+
+### Token Provider Implementation
+
+```typescript
+import { TokenProvider } from '@leancodepl/cqrs-client-base';
+
+const tokenProvider: TokenProvider = {
+  getToken: async () => {
+    return localStorage.getItem('authToken');
+  },
+  invalidateToken: async () => {
+    localStorage.removeItem('authToken');
+    return true;
+  }
+};
+```
+
+### Command Error Handling
+
+```typescript
+import { CommandResult, ValidationError } from '@leancodepl/cqrs-client-base';
+
+interface UserErrorCodes {
+  EmailExists: 1;
+  InvalidEmail: 2;
+}
+
+function handleCommandResult(result: CommandResult<UserErrorCodes>) {
+  if (result.WasSuccessful) {
+    console.log('Command succeeded');
+  } else {
+    result.ValidationErrors.forEach((error: ValidationError<UserErrorCodes>) => {
+      console.log(`${error.PropertyName}: ${error.ErrorMessage}`);
+    });
+  }
+}
+```
+
+### API Response Handling
+
+```typescript
+import { ApiResponse } from '@leancodepl/cqrs-client-base';
+
+function handleApiResponse<T>(response: ApiResponse<T>) {
+  if (response.isSuccess) {
+    return response.result;
+  } else {
+    throw new Error('API call failed');
+  }
+}
+``` 

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,2 @@
+'use strict';
+

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.d.ts

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

package/index.esm.js

@@ -0,0 +1 @@
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leancodepl/cqrs-client-base",
-  "version": "8.5.0",
+  "version": "8.5.1",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",
@@ -31,11 +31,6 @@
     "name": "LeanCode",
     "url": "https://leancode.co"
   },
-  "files": [
-    "dist",
-    "README.md",
-    "CHANGELOG.md"
-  ],
   "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",

package/src/index.d.ts

@@ -0,0 +1,28 @@
+export type TokenProvider = {
+    getToken: () => Promise<string | undefined>;
+    invalidateToken: () => Promise<boolean>;
+};
+export type ValidationError<TErrorCodes extends Record<string, number>> = {
+    readonly PropertyName: string;
+    readonly ErrorMessage: string;
+    readonly AttemptedValue: unknown;
+    readonly ErrorCode: TErrorCodes[keyof TErrorCodes];
+};
+export type CommandResult<TErrorCodes extends Record<string, number>> = FailedCommandResult<TErrorCodes> | SuccessfulCommandResult;
+export type FailedCommandResult<TErrorCodes extends Record<string, number>> = {
+    readonly WasSuccessful: false;
+    readonly ValidationErrors: ValidationError<TErrorCodes>[];
+};
+export type SuccessfulCommandResult = {
+    readonly WasSuccessful: true;
+};
+export type ApiSuccess<TResult> = {
+    readonly isSuccess: true;
+    readonly result: TResult;
+};
+export type ApiError = {
+    readonly isSuccess: false;
+    readonly error: any;
+    readonly isAborted?: boolean;
+};
+export type ApiResponse<TResult> = ApiError | ApiSuccess<TResult>;