pure-md5 0.2.0 → 0.2.1

package/planning/04-adapter-backend/11-tests-backend-web-crypto.md

@@ -1,191 +0,0 @@
-# Task 11: Web Crypto Backend Tests
-
-## Goal
-
-Создать комплексные тесты для Web Crypto backend адаптера.
-
-## Implementation
-
-### 1. Создать файл `__tests__/adapters/web-crypto.test.ts`
-
-```typescript
-import { WebCryptoBackend } from '../../src/adapters/web-crypto.js';
-
-describe('WebCryptoBackend', () => {
-  let backend: WebCryptoBackend;
-  
-  beforeAll(async () => {
-    const available = await WebCryptoBackend.isAvailable();
-    if (!available) {
-      console.log('Web Crypto API not available, skipping tests');
-      this.skip();
-      return;
-    }
-    backend = new WebCryptoBackend();
-  });
-  
-  describe('Basic hashing', () => {
-    it('should hash string correctly', async () => {
-      const result = await backend.hash('hello');
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-    
-    it('should hash empty string', async () => {
-      const result = await backend.hash('');
-      expect(result).toBe('d41d8cd98f00b204e9800998ecf8427e');
-    });
-    
-    it('should hash special characters', async () => {
-      const result = await backend.hash('!@#$%^&*()');
-      expect(result).toBe('903246b67e6a702cbb3749e376397578');
-    });
-    
-    it('should hash unicode characters', async () => {
-      const result = await backend.hash('Привет мир');
-      expect(result).toBe('8b7d1e6d8e6a702cbb3749e376397578'); // Expected hash
-    });
-    
-    it('should hash long string', async () => {
-      const longString = 'a'.repeat(10000);
-      const result = await backend.hash(longString);
-      expect(result.length).toBe(32); // MD5 always produces 32 char hex
-    });
-  });
-  
-  describe('Binary data', () => {
-    it('should hash Uint8Array', async () => {
-      const data = new Uint8Array([104, 101, 108, 108, 111]); // "hello"
-      const result = await backend.hashBinary(data);
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-    
-    it('should hash ArrayBuffer', async () => {
-      const data = new TextEncoder().encode('hello').buffer;
-      const result = await backend.hashBinary(data);
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-    
-    it('should hash empty Uint8Array', async () => {
-      const data = new Uint8Array(0);
-      const result = await backend.hashBinary(data);
-      expect(result).toBe('d41d8cd98f00b204e9800998ecf8427e');
-    });
-  });
-  
-  describe('Availability', () => {
-    it('should be available in modern browsers', async () => {
-      const available = await WebCryptoBackend.isAvailable();
-      // May be true or false depending on test environment
-      expect(typeof available).toBe('boolean');
-    });
-    
-    it('should throw error if not available', async () => {
-      // Mock isAvailable to return false
-      jest.spyOn(WebCryptoBackend, 'isAvailable').mockResolvedValue(false);
-      
-      await expect(backend.hash('test')).rejects.toThrow('Web Crypto API is not available');
-    });
-  });
-  
-  describe('Performance', () => {
-    it('should hash 1MB data efficiently', async () => {
-      const data = 'a'.repeat(1024 * 1024); // 1MB
-      
-      const start = performance.now();
-      const result = await backend.hash(data);
-      const duration = performance.now() - start;
-      
-      expect(result.length).toBe(32);
-      expect(duration).toBeLessThan(1000); // Should complete in under 1 second
-    });
-  });
-  
-  describe('Consistency', () => {
-    it('should produce same hash for same input', async () => {
-      const input = 'test input';
-      const result1 = await backend.hash(input);
-      const result2 = await backend.hash(input);
-      expect(result1).toBe(result2);
-    });
-    
-    it('should produce different hash for different inputs', async () => {
-      const result1 = await backend.hash('hello');
-      const result2 = await backend.hash('world');
-      expect(result1).not.toBe(result2);
-    });
-  });
-});
-```
-
-### 2. Tests интеграции
-
-Создать файл `__tests__/integration/web-crypto.test.ts`:
-
-```typescript
-import { md5 } from '../../src/adapters/unified.js';
-
-describe('WebCrypto Backend Integration', () => {
-  describe('Unified adapter with WebCrypto', () => {
-    it('should use WebCrypto if available', async () => {
-      const available = await md5.isAvailable('webcrypto');
-      if (!available) {
-        console.log('WebCrypto not available, skipping');
-        return;
-      }
-      
-      const result = await md5.hash('hello');
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-    
-    it('should accept backend override', async () => {
-      const result = await md5.hash('hello', { backend: 'webcrypto' });
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-  });
-});
-```
-
-### 3. Tests в Node.js с WebCrypto
-
-Создать файл `__tests__/adapters/web-crypto-node.test.ts`:
-
-```typescript
-// Only run in Node.js 15+ with WebCrypto
-const { isNode } = require('../detection/environment.js');
-
-if (!isNode()) {
-  console.log('Not in Node.js, skipping');
-  process.exit(0);
-}
-
-const nodeVersion = process.versions.node.split('.').map(Number);
-if (nodeVersion[0] < 15) {
-  console.log('Node.js version too low, skipping');
-  process.exit(0);
-}
-
-describe('WebCryptoBackend in Node.js', () => {
-  let backend: WebCryptoBackend;
-  
-  beforeAll(async () => {
-    const available = await WebCryptoBackend.isAvailable();
-    if (!available) {
-      console.log('WebCrypto not available in Node.js, skipping');
-      return;
-    }
-    backend = new WebCryptoBackend();
-  });
-  
-  it('should work in Node.js', async () => {
-    const result = await backend.hash('hello');
-    expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-  });
-});
-```
-
-## Ожидаемый результат
-
-- ✅ Все тесты проходят успешно
-- ✅ Покрытие кода >= 90%
-- ✅ Tests работают в браузерах и Node.js
-- ✅ Performance тесты включены

package/planning/04-adapter-backend/12-tests-backend-node-crypto.md

@@ -1,222 +0,0 @@
-# Task 12: Node.js Backend Tests
-
-## Goal
-
-Создать комплексные тесты для Node.js Crypto backend адаптера.
-
-## Implementation
-
-### 1. Создать файл `__tests__/adapters/node-crypto.test.ts`
-
-```typescript
-import { NodeCryptoBackend } from '../../src/adapters/node-crypto.js';
-
-describe('NodeCryptoBackend', () => {
-  let backend: NodeCryptoBackend;
-  
-  beforeAll(() => {
-    if (!NodeCryptoBackend.isAvailable()) {
-      console.log('Node.js Crypto not available, skipping tests');
-      this.skip();
-      return;
-    }
-    backend = new NodeCryptoBackend();
-  });
-  
-  describe('Basic hashing', () => {
-    it('should hash string correctly', () => {
-      const result = backend.hash('hello');
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-    
-    it('should hash empty string', () => {
-      const result = backend.hash('');
-      expect(result).toBe('d41d8cd98f00b204e9800998ecf8427e');
-    });
-    
-    it('should hash special characters', () => {
-      const result = backend.hash('!@#$%^&*()');
-      expect(result).toBe('903246b67e6a702cbb3749e376397578');
-    });
-    
-    it('should hash unicode characters', () => {
-      const result = backend.hash('Привет мир');
-      expect(result).toBe('expected_hash_here'); // Replace with actual expected hash
-    });
-    
-    it('should hash long string', () => {
-      const longString = 'a'.repeat(10000);
-      const result = backend.hash(longString);
-      expect(result.length).toBe(32);
-    });
-  });
-  
-  describe('Binary data', () => {
-    it('should hash Uint8Array', () => {
-      const data = new Uint8Array([104, 101, 108, 108, 111]); // "hello"
-      const result = backend.hashBinary(data);
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-    
-    it('should hash ArrayBuffer', () => {
-      const data = new TextEncoder().encode('hello').buffer;
-      const result = backend.hashBinary(data);
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-    
-    it('should hash empty Uint8Array', () => {
-      const data = new Uint8Array(0);
-      const result = backend.hashBinary(data);
-      expect(result).toBe('d41d8cd98f00b204e9800998ecf8427e');
-    });
-  });
-  
-  describe('Streaming', () => {
-    it('should support streaming via update/digest', () => {
-      backend.update('he');
-      backend.update('l');
-      backend.update('lo');
-      const result = backend.digest('hex');
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-    
-    it('should support streaming with binary data', () => {
-      backend.update(new Uint8Array([104, 101]));
-      backend.update(new Uint8Array([108, 108, 111]));
-      const result = backend.digest('hex');
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-    
-    it('should reset state', () => {
-      backend.update('hello');
-      backend.reset();
-      backend.update('world');
-      const result = backend.digest('hex');
-      expect(result).toBe('5d41402abc4b2a76b9719d911017c592');
-    });
-  });
-  
-  describe('Availability', () => {
-    it('should be available in Node.js', () => {
-      const available = NodeCryptoBackend.isAvailable();
-      expect(available).toBe(true);
-    });
-    
-    it('should throw error if not available', () => {
-      jest.spyOn(NodeCryptoBackend, 'isAvailable').mockReturnValue(false);
-      
-      expect(() => backend.hash('test')).toThrow('Node.js Crypto is not available');
-    });
-  });
-  
-  describe('Performance', () => {
-    it('should hash 1MB data efficiently', () => {
-      const data = 'a'.repeat(1024 * 1024); // 1MB
-      
-      const start = Date.now();
-      const result = backend.hash(data);
-      const duration = Date.now() - start;
-      
-      expect(result.length).toBe(32);
-      expect(duration).toBeLessThan(500); // Should complete in under 500ms
-    });
-  });
-  
-  describe('Consistency', () => {
-    it('should produce same hash for same input', () => {
-      const input = 'test input';
-      const result1 = backend.hash(input);
-      const result2 = backend.hash(input);
-      expect(result1).toBe(result2);
-    });
-    
-    it('should produce different hash for different inputs', () => {
-      const result1 = backend.hash('hello');
-      const result2 = backend.hash('world');
-      expect(result1).not.toBe(result2);
-    });
-  });
-});
-```
-
-### 2. Tests stream API
-
-Создать файл `__tests__/adapters/node-crypto-stream.test.ts`:
-
-```typescript
-import { NodeCryptoBackend } from '../../src/adapters/node-crypto.js';
-
-describe('NodeCryptoBackend Streaming', () => {
-  it('should handle incremental updates', () => {
-    const backend = new NodeCryptoBackend();
-    
-    const parts = ['Hello', ' ', 'World', '!'];
-    const fullString = parts.join('');
-    
-    parts.forEach(part => backend.update(part));
-    
-    const result = backend.digest('hex');
-    
-    // Compare with direct hash
-    const directResult = backend.hash(fullString);
-    expect(result).toBe(directResult);
-  });
-  
-  it('should handle empty updates', () => {
-    const backend = new NodeCryptoBackend();
-    backend.update('');
-    backend.update('');
-    const result = backend.digest('hex');
-    expect(result).toBe('d41d8cd98f00b204e9800998ecf8427e');
-  });
-  
-  it('should handle null bytes', () => {
-    const backend = new NodeCryptoBackend();
-    backend.update('test\x00data');
-    const result = backend.digest('hex');
-    expect(result.length).toBe(32);
-  });
-});
-```
-
-### 3. Tests с реальными файлами
-
-Создать файл `__tests__/integration/node-crypto-file.test.ts`:
-
-```typescript
-import fs from 'fs';
-import path from 'path';
-import { NodeCryptoBackend } from '../../src/adapters/node-crypto.js';
-
-describe('NodeCryptoBackend with Files', () => {
-  it('should hash a file', () => {
-    const backend = new NodeCryptoBackend();
-    const filePath = path.join(__dirname, 'fixtures', 'test-file.txt');
-    const content = fs.readFileSync(filePath);
-    
-    const result = backend.hashBinary(content);
-    expect(result.length).toBe(32);
-  });
-  
-  it('should handle large files', () => {
-    const backend = new NodeCryptoBackend();
-    const filePath = path.join(__dirname, 'fixtures', 'large-file.bin');
-    
-    if (!fs.existsSync(filePath)) {
-      console.log('Large file not found, skipping');
-      return;
-    }
-    
-    const content = fs.readFileSync(filePath);
-    const result = backend.hashBinary(content);
-    expect(result.length).toBe(32);
-  });
-});
-```
-
-## Ожидаемый результат
-
-- ✅ Все тесты проходят успешно
-- ✅ Покрытие кода >= 90%
-- ✅ Tests stream API работают
-- ✅ Интеграционные тесты с файлами

package/planning/04-adapter-backend/README.md

@@ -1,45 +0,0 @@
-# Phase 4: Adapter for Different Backends
-
-Эта фаза посвящена созданию системы адаптеров для поддержки различных криптографических API (Web Crypto API, Node.js Crypto, Pure JS) с интеллектуальным обнаружением и fallback механизмами.
-
-## Архитектурные задачи
-
-- [01-architecture-assessment](./01-architecture-assessment.md) - Анализ архитектуры: интеграция или отдельный пакет
-- [02-architecture-backend-api](./02-architecture-backend-api.md) - Проектирование универсального API для backend адаптеров
-
-## Implementation backend адаптеров
-
-- [03-backend-web-crypto](./03-backend-web-crypto.md) - Implementation Web Crypto API адаптера
-- [04-backend-node-crypto](./04-backend-node-crypto.md) - Implementation Node.js Crypto адаптера
-- [05-backend-pure-js](./05-backend-pure-js.md) - Рефакторинг существующего Pure JS кода в адаптер
-- [06-backend-ie11](./06-backend-ie11.md) - Support Internet Explorer 11 (msCrypto)
-
-## Интеллектуальное обнаружение backend
-
-- [07-detection-environment](./07-detection-environment.md) - Implementation обнаружения окружения и доступных backend'ов
-- [08-detection-backend](./08-detection-backend.md) - Implementation системы детекции оптимального backend'а
-
-## Unified adapter и fallback
-
-- [09-adapter-unified](./09-adapter-unified.md) - Создание unified adapter с единым интерфейсом
-- [10-fallback-mechanism](./10-fallback-mechanism.md) - Implementation fallback механизмов с порядком предпочтения
-
-## Testing и документация
-
-- [11-tests-backend-web-crypto](./11-tests-backend-web-crypto.md) - Tests Web Crypto backend
-- [12-tests-backend-node-crypto](./12-tests-backend-node-crypto.md) - Tests Node.js backend
-- [13-tests-backend-pure-js](./13-tests-backend-pure-js.md) - Tests Pure JS backend
-- [14-tests-detection](./14-tests-detection.md) - Tests системы детекции backend
-- [15-tests-fallback](./15-tests-fallback.md) - Tests fallback механизмов
-- [16-docs-adapter](./16-docs-adapter.md) - Documentation по использованию backend адаптеров
-
-## Optimization и бенчмарки
-
-- [17-optimization-tree-shaking](./17-optimization-tree-shaking.md) - Optimization для tree-shaking backend модулей
-- [18-benchmarks-performance](./18-benchmarks-performance.md) - Бенчмарки производительности各 backend
-
-## Integration в основной проект
-
-- [19-integration-main](./19-integration-main.md) - Integration backend адаптеров в основной пакет
-- [20-export-conditional](./20-export-conditional.md) - Setup conditional exports для разных backend'ов
-- [21-versioning](./21-versioning.md) - Планирование версии с backend адаптерами

package/planning/05-documentation-publishing/01-README-optimization.md

@@ -1,105 +0,0 @@
-# README.md Optimization
-
-## Overview
-
-Optimize the README.md to follow best practices and increase package adoption.
-
-## Current Issues
-
-- [ ] Outdated badges (Travis CI - deprecated)
-- [ ] Missing immediate value proposition
-- [ ] Missing features list
-- [ ] Missing installation examples
-- [ ] Missing quick start section
-- [ ] Missing badges for license, version, downloads
-- [ ] Missing table of contents for longer sections
-- [ ] Missing contribution guide link
-- [ ] Missing support/sponsorship section
-- [ ] Missing related packages link
-
-## Best Practices for README.md
-
-### 1. Essential Elements
-- [ ] Clear project title and description
-- [ ] Installation instructions
-- [ ] Quick start example
-- [ ] Features list
-- [ ] Usage examples
-- [ ] API documentation
-- [ ] Contributing guidelines
-- [ ] License information
-
-### 2. Visual Elements
-- [ ] Project logo/icon (if available)
-- [ ] Relevant badges (only working and necessary ones)
-- [ ] Code examples with proper syntax highlighting
-- [ ] Screenshots/diagrams if applicable
-
-### 3. Badges to Include
-- [x] npm version
-- [x] npm downloads
-- [ ] License badge
-- [ ] Build status (GitHub Actions)
-- [ ] Coverage badge
-- [ ] Bundle size badge
-- [ ] TypeScript support badge
-
-### 4. Structure
-```markdown
-# Project Name
-
-[Badges]
-
-## Features
-
-## Quick Start
-
-## Installation
-
-## Usage
-
-## API
-
-## Examples
-
-## Contributing
-
-## License
-```
-
-## Badges Evaluation
-
-### Keep (Working & Motivational)
-- [x] npm version - shows latest stable version
-- [x] npm downloads - shows popularity
-- [ ] GitHub Actions build status - shows current build state
-- [ ] Coverage - shows test quality
-- [ ] Bundle size - shows lightweight nature
-- [ ] TypeScript support - shows modern JS features
-
-### Remove (Deprecated/Unnecessary)
-- [ ] Travis CI - deprecated service
-- [ ] CodeClimate maintainability - replaced by GitHub
-- [ ] CodeClimate coverage - replaced by codecov
-
-## Implementation Tasks
-
-- [ ] Rewrite top section with immediate value proposition
-- [ ] Add features list with badges
-- [ ] Add quick start section
-- [ ] Update badges (remove Travis, add necessary ones)
-- [ ] Add table of contents
-- [ ] Add bundle size badge
-- [ ] Add license badge
-- [ ] Add contributing guide link
-- [ ] Add sponsorship section
-- [ ] Add "Why pure-md5?" section highlighting benefits
-
-## Success Criteria
-
-- [ ] README loads quickly and shows value in first screen
-- [ ] Installation instructions are clear
-- [ ] Quick start works immediately
-- [ ] All badges are functional
-- [ ] Documentation is in English and easy to understand
-- [ ] Includes comparison with alternatives (if applicable)

package/planning/05-documentation-publishing/02-VitePress-site-evaluation.md

@@ -1,136 +0,0 @@
-# VitePress Documentation Site Evaluation
-
-## Overview
-
-Evaluate whether creating a VitePress documentation site is worthwhile for this project.
-
-## Current Documentation State
-
-- README.md - Basic documentation
-- No dedicated documentation site
-- Some markdown files in repository root
-- Streaming API documentation (STREAM_*.md)
-- Migration guides
-
-## VitePress Advantages
-
-### Benefits
-- ✅ Modern, clean documentation interface
-- ✅ Search functionality
-- ✅ Multi-language support (future-proofing)
-- ✅ Built-in versioning support
-- ✅ MDX support for interactive examples
-- ✅ Theme customization
-- ✅ SEO-friendly
-- ✅ Fast with Vue-based rendering
-- ✅ GitHub Pages friendly
-
-### For This Project
-- ✅ Multiple APIs (core, stream, adapters) need clear documentation
-- ✅ Examples are important for understanding usage
-- ✅ Migration guides need proper organization
-- ✅ Streaming API docs are currently in separate files
-- ✅ Could show interactive examples with CDN
-- ✅ Bundle size and performance metrics could be showcased
-
-## VitePress Disadvantages
-
-### Overhead
-- ⚠️ Requires maintenance of documentation site
-- ⚠️ Learning curve for contributors
-- ⚠️ Additional build step
-- ⚠️ Potential for docs to become outdated
-
-### For This Project
-- ⚠️ Project is relatively small (single function + utilities)
-- ⚠️ Documentation is mostly complete in README
-- ⚠️ May be overkill for simple API reference
-- ⚠️ Smaller projects often just use README
-
-## Alternative Options
-
-### 1. Improve README (Recommended)
-- Keep current approach
-- Optimize README with better structure
-- Use markdown anchors for navigation
-- Add table of contents
-- Link to examples directly
-
-### 2. GitHub Wiki
-- Free and simple
-- GitHub integrated
-- Less control over design
-- Limited search
-
-### 3. VitePress (Consider if)
-- Project grows significantly
-- Add more adapters or features
-- Plan to support multiple versions with breaking changes
-- Want to showcase performance benchmarks visually
-- Need interactive API documentation
-
-### 4. Other Static Site Generators
-- Docusaurus (more features, heavier)
-- Slate (Ruby-based, API-focused)
-- MkDocs (Python-based)
-
-## Recommendation
-
-### For Current State: Improve README ✅
-
-**Reasoning:**
-1. Package is relatively small and focused
-2. Documentation is mostly complete
-3. Overhead not justified yet
-4. README can be optimized sufficiently
-
-### For Future Growth: VitePress 📅
-
-**Trigger Points:**
-- Add more adapters or features
-- Add extensive examples gallery
-- Plan to support multiple versions with breaking changes
-- Want to showcase performance benchmarks visually
-- Need interactive API documentation
-
-## Implementation Plan (If Choosing VitePress)
-
-### Phase 1: Setup
-```bash
-npm create vitepress@latest
-# or
-pnpm create vitepress
-```
-
-### Phase 2: Configuration
-- Configure theme and styling
-- Set up GitHub Actions deployment
-- Configure sidebar navigation
-- Add versioning
-
-### Phase 3: Content Migration
-- Move README to home page
-- Split documentation into sections
-- Add examples gallery
-- Add API reference
-- Add migration guides
-
-### Phase 4: Maintenance
-- Document how to update docs
-- Add CI/CD for deployment
-- Set up preview deployments
-
-## Decision: ✅ Improve README Only
-
-**Current recommendation is to focus on README.md optimization only.**
-
-**When to reconsider:** When project grows beyond current scope or when user feedback indicates need for more comprehensive documentation.
-
-## Alternative: Hybrid Approach
-
-**Create lightweight documentation site later:**
-- Keep README as quick start and overview
-- Create VitePress site for detailed documentation
-- Link to VitePress from README
-- Use VitePress for API reference and examples
-- Use README for installation and basic usage