@leancodepl/cqrs-client-base 8.4.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/package.json

@@ -1,17 +1,47 @@
 {
   "name": "@leancodepl/cqrs-client-base",
-  "version": "8.4.0",
+  "version": "8.5.1",
   "license": "Apache-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/cqrs-clients/cqrs-client-base"
+  },
+  "homepage": "https://github.com/leancodepl/js_corelibrary",
+  "bugs": {
+    "url": "https://github.com/leancodepl/js_corelibrary/issues"
+  },
+  "description": "Base types and interfaces for CQRS client implementations",
+  "keywords": [
+    "cqrs",
+    "types",
+    "interfaces",
+    "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/index.d.ts

@@ -23,5 +23,6 @@ export type ApiSuccess<TResult> = {
 export type ApiError = {
     readonly isSuccess: false;
     readonly error: any;
+    readonly isAborted?: boolean;
 };
 export type ApiResponse<TResult> = ApiError | ApiSuccess<TResult>;

package/index.esm.d.ts

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