@sudobility/types 1.8.29 → 1.8.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CLAUDE.md +26 -20
- package/package.json +1 -1
package/CLAUDE.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Project Overview
|
|
4
4
|
|
|
5
|
-
This is `@
|
|
5
|
+
This is `@sudobility/types` v1.8.29, a comprehensive TypeScript types library for the 0xmail.box ecosystem. It provides shared type definitions, interfaces, enums, and utility functions used across multiple projects in the 0xmail.box Web3 email platform.
|
|
6
6
|
|
|
7
7
|
## Key Architecture
|
|
8
8
|
|
|
@@ -66,7 +66,7 @@ npm run build
|
|
|
66
66
|
# Watch mode for development
|
|
67
67
|
npm run dev
|
|
68
68
|
|
|
69
|
-
# Run all
|
|
69
|
+
# Run all 219 tests
|
|
70
70
|
npm test
|
|
71
71
|
|
|
72
72
|
# Type checking
|
|
@@ -99,7 +99,7 @@ npm run ai:docs # Generate AI documentation
|
|
|
99
99
|
## Testing Strategy
|
|
100
100
|
|
|
101
101
|
- **Framework**: Vitest for fast unit testing
|
|
102
|
-
- **Coverage**:
|
|
102
|
+
- **Coverage**: 219 comprehensive tests covering all utilities and type guards
|
|
103
103
|
- **Structure**: Tests mirror source structure in `test/` directory
|
|
104
104
|
- **Focus**: Type guards, validation functions, utility functions, and API contracts
|
|
105
105
|
|
|
@@ -219,34 +219,40 @@ npm run test:coverage
|
|
|
219
219
|
- **Type safety**: Strict TypeScript with comprehensive checking
|
|
220
220
|
- **Documentation**: JSDoc comments on all public APIs
|
|
221
221
|
|
|
222
|
-
## Recent Changes (v1.
|
|
222
|
+
## Recent Changes (v1.8.29)
|
|
223
223
|
|
|
224
224
|
### Type System Improvements
|
|
225
|
-
- **
|
|
226
|
-
-
|
|
227
|
-
-
|
|
228
|
-
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
- **
|
|
232
|
-
- **
|
|
233
|
-
|
|
234
|
-
|
|
225
|
+
- **Enum Conversion**: Converted 11 string literal types to enums for better type safety
|
|
226
|
+
- KYC types: `KYCVerificationLevel`, `KYCApplicationStatus`, `SumsubReviewStatus`, `SumsubReviewAnswer`, `ApplicantType`, `ReviewRejectType`
|
|
227
|
+
- Mailer types: `ConfirmationStatus`, `ClaimType`, `FeeType`
|
|
228
|
+
- Infrastructure types: `ContractType`, `ProcessedEventName`
|
|
229
|
+
- WildDuck types: `MailboxSpecialUse`
|
|
230
|
+
- **Enhanced Type Safety**: Runtime validation capabilities with enums
|
|
231
|
+
- **Better IDE Support**: Improved autocomplete and IntelliSense
|
|
232
|
+
- **Iterability**: Can now iterate over enum values
|
|
233
|
+
|
|
234
|
+
### Dependency Updates
|
|
235
|
+
- Updated all devDependencies to latest stable versions (no breaking changes)
|
|
236
|
+
- `@eslint/js`: 9.36.0 → 9.38.0
|
|
237
|
+
- `@types/node`: 24.5.2 → 24.9.1
|
|
238
|
+
- `@typescript-eslint/*`: 8.44.0 → 8.46.2
|
|
239
|
+
- `eslint`: 9.36.0 → 9.38.0
|
|
240
|
+
- Fixed vite security vulnerability
|
|
235
241
|
|
|
236
242
|
### Documentation
|
|
237
243
|
- **AI-Optimized README**: Comprehensive examples and usage patterns
|
|
238
|
-
- **
|
|
239
|
-
- **Enhanced JSDoc**: Better documentation coverage across all APIs
|
|
244
|
+
- **Enhanced JSDoc**: Complete documentation coverage with examples
|
|
240
245
|
- **Development Guides**: Improved contributor documentation
|
|
246
|
+
- **Version Consistency**: Updated all documentation to reflect current version
|
|
241
247
|
|
|
242
248
|
## Migration Guidance
|
|
243
249
|
|
|
244
250
|
### For Type Consumers
|
|
245
251
|
```typescript
|
|
246
252
|
// Recommended patterns
|
|
247
|
-
import { Optional, Result, ValidationResult } from '@
|
|
248
|
-
import { ChainType, AuthStatus } from '@
|
|
249
|
-
import { isEvmAddress, formatWalletAddress } from '@
|
|
253
|
+
import { Optional, Result, ValidationResult } from '@sudobility/types';
|
|
254
|
+
import { ChainType, AuthStatus } from '@sudobility/types';
|
|
255
|
+
import { isEvmAddress, formatWalletAddress } from '@sudobility/types';
|
|
250
256
|
|
|
251
257
|
// Use Optional<T> for nullable values
|
|
252
258
|
const user: Optional<User> = getUser(); // instead of User | null | undefined
|
|
@@ -282,4 +288,4 @@ if (isEvmAddress(address)) {
|
|
|
282
288
|
|
|
283
289
|
---
|
|
284
290
|
|
|
285
|
-
*This configuration optimizes @
|
|
291
|
+
*This configuration optimizes @sudobility/types for AI-assisted development while maintaining enterprise-grade quality standards.*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sudobility/types",
|
|
3
|
-
"version": "1.8.
|
|
3
|
+
"version": "1.8.32",
|
|
4
4
|
"description": "Comprehensive TypeScript types, interfaces, and utilities for the 0xmail.box Web3 email ecosystem - optimized for AI-assisted development",
|
|
5
5
|
"main": "./dist/index.cjs",
|
|
6
6
|
"module": "./dist/index.js",
|