newo 1.5.0 → 1.5.2

package/.env.example

@@ -1,14 +1,25 @@
 # NEWO endpoints
 NEWO_BASE_URL=https://app.newo.ai
 
-# Project you want to sync (optional - leave blank to sync all accessible projects)
-# NEWO_PROJECT_ID=b78188ba-0df0-46a8-8713-f0d7cff0a06e
+# Multi-customer configuration - Array format
+# Define API keys as JSON array - customer IDN will be auto-detected from API response
+NEWO_API_KEYS=["api_key_1", "api_key_2", "api_key_3"]
+
+# Or with optional project IDs per API key
+# NEWO_API_KEYS=[{"key":"api_key_1","project_id":"project_uuid_1"}, {"key":"api_key_2","project_id":"project_uuid_2"}]
+
+# Optional: specify default customer IDN after keys are loaded
+# NEWO_DEFAULT_CUSTOMER=NEWO_ESd2BC95
 
-# Auth (choose one)
-# 1) Recommended: API key that can be exchanged for tokens:
-NEWO_API_KEY=put_api_key_here
+# Legacy format (still supported)
+# NEWO_CUSTOMER_[IDN]_API_KEY=api_key
+# NEWO_CUSTOMER_acme_API_KEY=put_acme_api_key_here
+
+# Legacy single-customer mode (still supported)
+# NEWO_API_KEY=put_api_key_here
+# NEWO_PROJECT_ID=b78188ba-0df0-46a8-8713-f0d7cff0a06e
 
-# 2) Optional bootstrap tokens (used if present)
+# Optional bootstrap tokens (for legacy mode or manual setup)
 NEWO_ACCESS_TOKEN=
 NEWO_REFRESH_TOKEN=
 

package/CHANGELOG.md

@@ -5,6 +5,97 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.2] - 2025-01-15
+
+### Enhanced
+- **Documentation Overhaul**: Complete README restructuring with professional presentation
+  - Added npm, license, TypeScript, and Node.js badges for credibility
+  - Enhanced project description highlighting multi-customer support capabilities
+  - Visual feature bullets with emojis for improved readability and engagement
+- **Multi-Customer Documentation**: Comprehensive guide for multi-customer workflows
+  - Three flexible configuration methods: JSON arrays, individual env vars, mixed approaches
+  - Clear migration path from single to multi-customer setup
+  - Command examples for multi-customer operations (`--customer` flag usage)
+- **Professional Documentation Structure**:
+  - Table format for command reference with improved readability
+  - Visual folder tree showing accurate `newo_customers/` structure
+  - Enhanced CI/CD integration examples for both single and multi-customer scenarios
+  - Contributing guidelines, API reference, and support channels
+- **Corrected File Organization**: Updated folder structure documentation to match actual implementation
+  - Fixed root folder from `projects/` to `newo_customers/` 
+  - Accurate customer folder hierarchy: `newo_customers/{customerIdn}/projects/{projectIdn}/`
+  - Customer-specific state management in `.newo/{customerIdn}/`
+
+### Fixed
+- **Folder Structure Documentation**: Corrected project structure examples to match actual code implementation
+- **Package Description**: Updated npm package description to reflect multi-customer capabilities
+
+### Developer Experience
+- **GitHub/npm Ready**: Professional presentation suitable for public package repository
+- **Clear Navigation**: Improved documentation structure with proper sectioning and examples
+- **Enhanced Onboarding**: Comprehensive quick-start guide and configuration examples
+
+## [1.5.1] - 2025-01-14
+
+### Added
+- **Comprehensive Test Coverage**: Added extensive test suites for all major modules
+  - `test/auth.test.js`: 500+ lines covering authentication, token management, multi-customer support
+  - `test/hash.test.js`: 400+ lines covering SHA256 hashing, hash storage, and cross-platform compatibility  
+  - `test/fsutil.test.js`: 400+ lines covering file system utilities and path handling
+  - `test/akb.test.js`: 600+ lines covering AKB article parsing and import workflows
+  - Added missing test dependencies: `chai`, `sinon`, `c8` for coverage reporting
+- **Enhanced Authentication Validation**:
+  - `validateApiKey()`: Comprehensive API key format and length validation
+  - `validateTokens()`: Token format and structure validation with detailed error messages
+  - `validateUrl()`: URL format validation for API endpoints
+  - Sensitive data sanitization in logs (API keys and tokens masked)
+- **Structured Logging System**:
+  - `logAuthEvent()`: Structured authentication event logging with metadata
+  - Automatic sensitive data sanitization (keys/tokens/secrets masked in logs)
+  - JSON-formatted logs with timestamp, level, module, and context information
+- **Enhanced Error Handling**:
+  - User-friendly CLI error messages with troubleshooting tips
+  - Specific error handling for authentication, network, environment, and file system errors
+  - Verbose mode support for detailed debugging information
+  - Context-aware error messages with suggested solutions
+
+### Enhanced
+- **Authentication Robustness** (`src/auth.ts`):
+  - Added comprehensive input validation with detailed error messages
+  - Enhanced network error handling with specific status code interpretation
+  - Added request timeouts (30 seconds) and retry logic for reliability
+  - Improved token expiry handling with 60-second buffer for refresh
+  - Better handling of connection errors, timeouts, and server errors
+- **CLI Error Experience** (`src/cli.ts`):
+  - Added `handleCliError()` function with categorized error types
+  - User-friendly error messages with emoji indicators and troubleshooting tips
+  - Verbose mode toggle for detailed technical information vs. clean user messages
+  - Specific guidance for common issues (API key, network, configuration)
+- **Testing Infrastructure**:
+  - Fixed ES module/CommonJS compatibility issues in test files
+  - Enhanced `TestEnvironment` class with comprehensive cleanup and mocking
+  - Added MockHttpClient, MockFileSystem, and MockLogger utilities
+  - Comprehensive assertion helpers and test data generators
+
+### Fixed
+- **Module System Compatibility**: Resolved ES module/CommonJS conflicts in test environment
+- **Test Dependencies**: Added missing testing dependencies that were imported but not declared
+- **Integration Test Paths**: Fixed paths from `src/cli.js` to `dist/cli.js` for proper compiled code testing
+- **Error Message Consistency**: Standardized error messages across authentication and CLI modules
+
+### Technical Details
+- **Validation Constants**: Added security-focused validation thresholds (API_KEY_MIN_LENGTH, TOKEN_MIN_LENGTH)
+- **Request Configuration**: Added proper timeout handling (30s) and user-agent headers
+- **Error Recovery**: Comprehensive fallback strategies for different failure scenarios
+- **Logging Standards**: JSON-structured logs with automatic PII/sensitive data protection
+- **Test Coverage**: Achieved comprehensive test coverage across all core modules with realistic scenarios
+
+### Developer Experience
+- **Enhanced Debugging**: Verbose mode provides detailed technical information for troubleshooting
+- **Better Error Messages**: Clear, actionable error messages instead of generic API errors
+- **Comprehensive Testing**: Full test suite covering authentication, file operations, hashing, and AKB import
+- **Type Safety**: All improvements maintain strict TypeScript compliance with proper error types
+
 ## [1.5.0] - 2025-09-03
 
 ### Changed