@brightchain/brightchain-lib 0.20.0 → 0.21.0

package/brightchain-lib/DEPRECATIONS_REMOVED.md

@@ -1,160 +0,0 @@
-# Deprecated APIs Removed
-
-This document lists all deprecated APIs that have been removed from BrightChain as part of Phase 9: Deprecation Planning.
-
-## Summary
-
-All deprecated APIs have been removed from the codebase. This is a breaking change that requires code updates for any consumers of the library.
-
-## Removed Items
-
-### 1. Checksum Utility Functions
-
-**File Removed:** `brightchain-lib/src/lib/utils/checksumUtils.ts`
-
-All utility functions have been removed:
-- `checksumToBuffer()` - Use `checksum.toBuffer()` instead
-- `checksumToUint8Array()` - Use `checksum.toUint8Array()` instead
-- `checksumToHex()` - Use `checksum.toHex()` instead
-- `checksumFromHex()` - Use `Checksum.fromHex()` instead
-- `checksumFromBuffer()` - Use `Checksum.fromBuffer()` instead
-- `checksumFromUint8Array()` - Use `Checksum.fromUint8Array()` instead
-
-**Migration:** Use Checksum class methods directly.
-
-### 2. Deprecated Type Aliases
-
-**File:** `brightchain-lib/src/lib/types/checksum.ts`
-
-Removed type aliases:
-- `ChecksumBuffer` - Use `Checksum` class instead
-- `ChecksumUint8Array` - Use `Checksum` class instead
-
-**Migration:** Replace all usages with the `Checksum` class.
-
-### 3. ChecksumService Method Variants
-
-**File:** `brightchain-lib/src/lib/services/checksum.service.ts`
-
-All methods now return `Checksum` class instances. The `*AsClass` method variants have been removed:
-- `calculateChecksumAsClass()` - Now just `calculateChecksum()`
-- `calculateChecksumForBuffersAsClass()` - Now just `calculateChecksumForBuffers()`
-- `calculateChecksumForStringAsClass()` - Now just `calculateChecksumForString()`
-- `calculateChecksumForFileAsClass()` - Now just `calculateChecksumForFile()`
-- `calculateChecksumForStreamAsClass()` - Now just `calculateChecksumForStream()`
-- `hexStringToChecksumClass()` - Now just `hexStringToChecksum()`
-
-**Migration:** Remove the `AsClass` suffix from method calls. All methods now return `Checksum` instances.
-
-### 4. Deprecated i18n Functions
-
-**File:** `brightchain-lib/src/lib/i18n/index.ts`
-
-Removed functions:
-- `registerTranslation()` - No replacement, use `@digitaldefiance/i18n-lib` directly
-
-**Migration:** Use the `@digitaldefiance/i18n-lib` package directly for advanced i18n features.
-
-### 5. StringLanguages Enum
-
-**File Removed:** `brightchain-lib/src/lib/enumerations/stringLanguages.ts`
-
-The entire file has been removed.
-
-**Migration:** Use `LanguageCodes` from `@digitaldefiance/i18n-lib` instead:
-```typescript
-// Before
-import { StringLanguages } from 'brightchain-lib';
-const lang = StringLanguages.EnglishUS;
-
-// After
-import { LanguageCodes } from '@digitaldefiance/i18n-lib';
-const lang = LanguageCodes.EN_US;
-```
-
-### 6. Deprecated Types
-
-**File Removed:** `brightchain-lib/src/lib/types.ts`
-
-Removed types:
-- `EnumLanguageTranslation<T>` - No replacement
-- `createTranslations()` - No replacement
-
-**Migration:** Implement similar functionality in your own codebase if needed.
-
-### 7. IConstants Interface
-
-**File:** `brightchain-lib/src/lib/interfaces/constants.ts`
-
-Removed interface:
-- `IConstants` - Use specific constant interfaces instead
-
-**Migration:** Use specific constant interfaces like `ICBLConsts`, `IFECConsts`, `ITupleConsts`, etc.
-
-### 8. CBLService Static Property
-
-**File:** `brightchain-lib/src/lib/services/cblService.ts`
-
-Removed static property:
-- `CBLService.CreatorLength` - Use instance method `creatorLength` instead
-
-**Migration:**
-```typescript
-// Before
-const length = CBLService.CreatorLength;
-
-// After
-const cblService = new CBLService();
-const length = cblService.creatorLength;
-```
-
-## Impact
-
-### Breaking Changes
-
-All removed APIs are breaking changes. Code that uses these APIs will fail to compile or run.
-
-### Automatic Fixes Applied
-
-As part of the deprecation removal, the following automatic fixes were applied to the codebase:
-
-1. **StringLanguages imports** - All imports of `StringLanguages` and `StringLanguage` were automatically replaced with `LanguageCodes` and `LanguageCode` from `@digitaldefiance/i18n-lib`
-2. **Import paths** - All import paths pointing to the removed `stringLanguages.ts` file were updated to import from `@digitaldefiance/i18n-lib`
-
-### Test Failures
-
-The removal of deprecated APIs causes test failures in the codebase. These failures are expected and indicate places where the code needs to be updated to use the new APIs.
-
-Common test failures:
-1. Type mismatches where `Checksum` is expected but `ChecksumUint8Array` is provided (or vice versa)
-2. Missing methods on `Checksum` class (e.g., trying to use array methods like `every()`)
-3. Import errors for removed types and functions
-
-### Next Steps
-
-1. Update all code to use the new APIs
-2. Fix all test failures
-3. Update documentation and examples
-4. Verify all functionality works with the new APIs
-
-## Migration Guide
-
-See [MIGRATION.md](./MIGRATION.md) for detailed migration instructions and examples.
-
-## Requirements Satisfied
-
-This removal satisfies the following requirements:
-- **Requirement 15.5:** Mark deprecated APIs with clear deprecation warnings ✅ (Previously done)
-- **Requirement 15.6:** Maintain deprecated APIs for at least one major version ✅ (Now removed)
-
-## Timeline
-
-- **Phase 1-8:** Deprecated APIs marked and maintained for backward compatibility
-- **Phase 9:** All deprecated APIs removed (current phase)
-- **Next:** Update all code to use new APIs
-
----
-
-**Date:** January 2025
-**Version:** 2.0.0
-**Status:** Complete