@vecrea/oid4vc-core

A TypeScript library providing core utilities and modules for OID4VC (OpenID for Verifiable Credentials) implementations.

Features

- Utility Functions: Error handling and result management utilities
- DynamoDB Integration: Simplified DynamoDB operations with Cloudflare Workers compatibility
- TypeScript Support: Full TypeScript support with comprehensive type definitions
- Modular Design: Import only what you need with subpath exports

Installation

``bash
npm install @vecrea/oid4vc-core
`

Usage

$3

Error handling and result management utilities.

`typescript
import {
Result,
runCatching,
getErrorMessage,
convertToError,
} from '@vecrea/oid4vc-core/utils';

// Using Result for safe operations
const result = runCatching(() => {
// Your potentially throwing code here
return 'success';
});

if (result.isSuccess()) {
console.log(result.value); // 'success'
} else {
console.error(result.error.message);
}

// Error utilities
const message = getErrorMessage(new Error('Test error')); // 'Test error'
const error = convertToError('Something went wrong');
`

$3

Simplified DynamoDB operations with Cloudflare Workers compatibility.

`typescript
import { DynamoDB } from '@vecrea/oid4vc-core/dynamodb';
import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';

// Initialize
const client = new DynamoDBDocumentClient({ region: 'us-east-1' });
const dynamodb = new DynamoDB(client, 'your-table-name');

// Basic operations
await dynamodb.put('user:123', JSON.stringify({ name: 'John', age: 30 }));
const userData = await dynamodb.get('user:123');
await dynamodb.delete('user:123');
`

API Reference

$3

A monadic Result type for handling operations that can succeed or fail.

#### Static Methods

- Result.success(value: T): Result - Creates a successful result
- Result.failure(error: Error): Result - Creates a failure result

#### Instance Methods

- isSuccess(): this is { value: T } - Checks if the result is successful
- isFailure(): this is { error: Error } - Checks if the result is a failure
- getOrThrow(): T - Returns the value or throws the error
- getOrDefault(defaultValue: T): T - Returns the value or a default
- getOrElse(transfer: (error: Error) => T): T - Returns the value or a computed default
- onSuccess(f: (value: T) => void): Result - Executes a function on success
- onFailure(f: (error: Error) => void): Result - Executes a function on failure
- recover(transform: (error: Error) => T): Result - Recovers from failure
- recoverAsync(transform: (error: Error) => Promise): Promise> - Async recovery

$3

- runCatching(f: (...args: A) => T, ...args: A): Result - Safely executes a function
- runAsyncCatching(f: (...args: A) => Promise, ...args: A): Promise> - Safely executes an async function
- getErrorMessage(e: unknown): string - Converts any value to an error message
- convertToError(e: unknown): Error - Converts any value to an Error object

$3

A class for simplified DynamoDB operations.

#### Constructor

`typescript
constructor(client: DynamoDBDocumentClient, tableName: string)
`

#### Methods

- get(key: string): Promise - Retrieves a value by key
- put(key: string, value: string, options?: PutOptions): Promise - Stores a value
- delete(key: string): Promise - Deletes an item by key

#### Types

- DynamoDBItem - Interface for DynamoDB items
- PutOptions - Options for put operations, extending KVNamespacePutOptions

Development

$3

- Node.js 18+
- npm or yarn

$3

`bash
git clone
cd oid4vc-core
npm install
`

$3

- npm run build - Build the library
- npm test - Run tests

$3

The library uses Vitest for testing. Test files are located in __tests__ directories alongside the source files.

`bash
npm test
``

License

MIT License - see LICENSE file for details.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Run the test suite
6. Submit a pull request

Support

For issues and questions, please use the GitHub issue tracker.