Skip to content

CHANGELOG.md

Latest commit

 

History

History
283 lines (212 loc) · 14.5 KB

CHANGELOG.md

File metadata and controls

283 lines (212 loc) · 14.5 KB

Changelog

1.1.4

🎉 Released:

  • 30th March 2026

🔧 Improvements:

  • Updated XLKitFormatters/CSVUtils to adopt swift-textfile’s text / init(text:) APIs (replacing deprecated rawText / init(rawText:)) so builds stay warning-free on current swift-textfile
  • Updated Tests/XLKitTests/XLKitTestBase so makeUTCDate sets the calendar time zone via TimeZone(secondsFromGMT: 0) with a nil-coalescing fallback to GMT / UTC / TimeZone.current (documents the usual non-nil UTC case, avoids unreachable XCTFail branches, and avoids TimeZone.gmt, which requires iOS 16+ while the package supports iOS 15+)
  • Made cleanupTempFile(at:) and makeBorderedFormat(top:bottom:color:) internal on XLKitTestBase so subclasses can override temp-file cleanup and tests can reuse bordered-format construction across files

1.1.3

🎉 Released:

  • 29th March 2026

🔧 Improvements:

  • Reorganised user documentation into chapter-based manuals under Documentation/Manual/ (index, modules/source map, features, full API reference); Documentation/Manual.md is now a short pointer; updated Documentation/README.md, root README.md, AGENT.MD, and .cursorrules for contributor expectations
  • Expanded the manual API reference and aligned code examples with the real API (CellFormat, setRange, etc.)
  • Refactored XLKitFormatters/CSVUtils to remove duplicate CSV/TSV export table-building logic via a shared private helper (buildStringTable(from:maxRow:maxColumn:))
  • Improved TSV API docs for consistency by explicitly documenting tab-separated behaviour in exportToTSV, importFromTSV, and createWorkbookFromTSV
  • Improved test maintainability in CSVTests by introducing shared CSV/TSV fixtures and replacing escaped-quote inline strings with readable raw multiline string literals
  • Updated XLKitTestBase helpers to use a reusable static workbook builder and made temp-file cleanup resilient when files are already missing
  • Updated Swift package dependencies

1.1.2

🎉 Released:

  • 16th March 2026

🔧 Improvements:

  • Migrated CSV/TSV dependency from swift-textfile-tools to swift-textfile
  • Updated XLKitFormatters/CSVUtils to use import TextFile and the TextFile product
  • CSV and TSV are treated as defined formats (e.g. RFC 4180 for CSV) with standard quote/escape rules; all parsing and generation go through swift-textfile for spec compliance
  • Removed custom-delimiter boilerplate (generateCustomDelimitedText, parseCustomDelimitedText) to avoid non-standard formats and delimiter-vs-content collision pitfalls
  • Removed custom delimiter support from CSV import/export. Only CSV (comma) and TSV (tab) are now supported.
  • API changes: exportToCSV(separator:) → exportToCSV(); importCSV(_:into:separator:hasHeader:) → importCSV(_:into:hasHeader:); init(fromCSV:sheetName:separator:hasHeader:) → init(fromCSV:sheetName:hasHeader:); exportSheetToCSV(_:separator:) → exportSheetToCSV(_:). Same for CSVUtils static methods (no separator parameter).
  • Updated documentation and rules (.cursorrules, AGENT.MD, README, Manual) to reference swift-textfile and TextFile

1.1.1

🎉 Released:

  • 6th March 2026

🔧 Improvements:

  • Refactored XLKitTestBase to reduce duplicate helper code and improve maintainability
  • Updated sync and async test workbook helpers to use a shared setup/cleanup flow while preserving existing behavior
  • Simplified border format helper creation in XLKitTestBase so common border helpers now follow a single shared pattern

1.1.0

🎉 Released:

  • 16th February 2026

🔧 Improvements:

  • Added swift-textfile-tools integration for CSV/TSV parsing and generation
  • Updated XLKitFormatters/CSVUtils to use swift-textfile-tools for comma/tab, with safe fallback for custom separators
  • Updated XLKitTestRunner CSV handling to use XLKit’s public CSV import APIs (aligns runner behavior with library CSV/TSV support)
  • Refactored test suite from single 1,535-line file into 13 focused test files with shared XLKitTestBase class for better maintainability
  • Enhanced XLKitTestBase with improved error handling: replaced fatalError with XCTFail and deterministic fallback dates to prevent test suite crashes, added comprehensive error messages for date creation failures, improved cleanup error logging with XCTFail instead of silent failures
  • Improved test helper reliability: withSavedTempWorkbookSync() and withSavedTempWorkbookAsync() now save workbooks to disk before passing them to test closures, ensuring file operations work correctly
  • Added new CSV edge-case unit tests (quoted commas, escaped quotes, empty fields, export/import round-trip) and improved test quality (deterministic dates, UUID-based temp files, removed force unwraps, proper guard statements with descriptive error messages)
  • Increased test count from 55 to 59 with 100% API coverage maintained

1.0.12

🎉 Released:

  • 12th February 2026

🔧 Improvements:

  • Fixed RateLimiter: changed from struct to final class so rate limiting state persists
  • Fixed [Content_Types].xml for multi-sheet workbooks: register every worksheet and drawing via generateContentTypes(workbook:)
  • Fixed media files: include images from workbook and all sheets so embedImage(from url:) / embedImage(from path:) write to XLSX
  • Fixed CellCoordinate(excelAddress:) to accept lowercase (e.g. "a1"); added unit tests
  • Created Documentation folder with Manual.md and README; moved manual content from root README
  • Updated Error Handling section to use actual XLKitError cases; added CI/CD, Test Coverage, Code Style to Manual

1.0.11

🎉 Released:

  • 8th February 2026

🔧 Improvements:

  • Fixed documentation: replaced CellFormat.coloredText(color:) with CellFormat.text(color:) in README.md and AGENT.MD
  • Removed force unwraps in CoreTypes.swift (CellCoordinate init, columnLetter, columnNumber) for Swift 6 compliance
  • Removed force unwraps in XLSXEngine.generateCellXML() using optional binding
  • Updated unit tests to use FileManager.default.temporaryDirectory instead of NSTemporaryDirectory()

1.0.10

🎉 Released:

  • 18th October 2025

🔧 Improvements:

  • Fixed critical column ordering bug for sheets with more than 26 columns (A-Z, AA, AB, etc.) (#14)
  • Resolved Excel compatibility issue where generated files were rejected or repaired due to invalid column ordering
  • Implemented proper numeric column sorting in XLSXEngine.generateWorksheetXML() to ensure Excel-compliant column order
  • Fixed lexicographic string sorting that caused AA1 to appear before B1 in generated XML
  • Increased test count from 53 to 55 tests with 100% API coverage including column ordering validation
  • Enhanced XLKitTestRunner with column ordering validation for continuous testing

1.0.9

🎉 Released:

  • 25th September 2025

🔧 Improvements:

  • Fixed text wrapping functionality that was defined in CellFormat but not being used in XLSX generation (#12)
  • Added text wrapping support to XLSXEngine alignment XML generation with proper wrapText attribute
  • Enhanced formatToKey function to include text wrapping in format key generation for proper format caching
  • Increased test count from 51 to 53 tests with 100% API coverage including text wrapping validation
  • Implemented proper Excel XML structure with alignment elements containing wrapText attribute

1.0.8

🎉 Released:

  • 5th August 2025

🔧 Improvements:

  • Added comprehensive border and merge functionality with full Excel compliance (#7)
  • Implemented border support with thin, medium, and thick styles with custom colours
  • Added merged cells support with complex range scenarios and proper XML generation
  • Enhanced CellFormat struct with border properties (borderTop, borderBottom, borderLeft, borderRight, borderColor)
  • Added bordered() factory method for easy border formatting creation
  • Implemented proper border XML generation in styles.xml with dynamic border definitions
  • Added mergeCells() functionality with proper range validation and storage
  • Enhanced XLSXEngine to generate mergeCells XML section in worksheet files
  • Added comprehensive border and merge testing with 6 new test functions
  • Increased test count from 45 to 51 tests with 100% API coverage including border and merge validation
  • Added border and merge combinations with other formatting options (font, alignment, background)
  • Validated border and merge functionality with CoreXLSX to ensure full Excel compliance

1.0.7

🎉 Released:

  • 4th August 2025

🔧 Improvements:

  • Fixed custom number formats being silently ignored by Excel in generated XLSX files (#8)
  • Implemented proper <numFmts> section in styles.xml with dynamic number format ID assignment
  • Added applyNumberFormat="1" attribute to cell format (xf) elements for Excel compliance
  • Updated formatToKey function to include number format information for unique style generation
  • Added comprehensive number formatting tests with 5 new test functions covering currency, percentage, and custom formats
  • Increased test count from 40 to 45 tests with 100% API coverage including number formatting validation
  • Added number-formats test type to XLKitTestRunner for end-to-end number formatting validation
  • Enhanced comprehensive demo with number formatting examples for currency and percentage display
  • Ensured all generated Excel files correctly display thousands grouping, currency symbols, and custom formats
  • Fixed Excel "Format Cells" dialog to properly reflect custom number formats instead of showing "General"
  • Validated number formatting fix with CoreXLSX to ensure full Excel compliance and compatibility

1.0.6

🎉 Released:

  • 18th July 2025

🔧 Improvements:

  • Fixed iOS "ZIP creation error" issue where users couldn't save Excel files on iOS (#5)
  • Implemented iOS-specific file operations using copy instead of move for better sandbox compatibility
  • Added CoreUtils.safeFileURL() helper method for iOS-safe file paths
  • Updated file path validation to be more permissive on iOS while maintaining security on macOS
  • Added iOS compatibility test to XLKitTestRunner for continuous validation

1.0.5

🎉 Released:

  • 15th July 2025

🔧 Improvements:

  • Added comprehensive text alignment testing with 5 new test functions covering all Excel alignment options
  • Increased test count from 35 to 40 tests with 100% API coverage including all text alignment options
  • Optimised code comments throughout the codebase for better maintainability and readability
  • Preserved essential API documentation and implementation details while removing unnecessary verbosity
  • Added detailed Text Alignment Support section in README.md with practical examples and usage patterns

1.0.4

🎉 Released:

  • 14th July 2025

🔧 Improvements:

  • Added iOS platform support with iOS 15+ targeting and cross-platform compatibility
  • Fixed iOS build error: 'homeDirectoryForCurrentUser' is unavailable in iOS
  • Implemented platform-specific conditionals for file system operations using #if os(macOS)
  • Updated allowedDirectories in CoreTypes.swift to use platform-specific home directory access
  • Added iOS job to GitHub Actions workflow for continuous testing on iOS simulators
  • Added CodeQL security scanning workflow with Swift 6.0 support
  • Fixed comprehensive demo test with duplicate relationship IDs causing Excel file corruption
  • Implemented dynamic relationship ID generation to prevent conflicts in workbook.xml.rels and drawing1.xml.rels
  • Ensured all generated Excel files pass CoreXLSX validation and open without errors
  • Fixed async/await warnings by removing unnecessary await keywords from synchronous operations
  • Updated API documentation to show instance methods on Workbook and Sheet classes
  • Updated API documentation to use proper Swift naming conventions and parameter patterns
  • Fixed concurrency handling in test runner with proper Task and semaphore usage
  • Added font colour support with proper XML generation in XLSXEngine
  • Updated CellFormat to properly apply font colours in Excel output
  • Added font colour formatting tests to XLKitTests with comprehensive validation
  • Enhanced comprehensive demo with font colour examples for all supported colours
  • Fixed Image column header formatting inconsistency in embed test output
  • Ensured all generated Excel files maintain consistent header styling across all columns
  • Enhanced codebase with modern Swift 6.0 idioms and improved type safety
  • Improved error handling with more specific XLKitError types and meaningful error messages
  • Enhanced test suite organisation with better test categorisation and coverage documentation
  • Resolved test count discrepancies and ensured accurate documentation across all files
  • Improved code maintainability with consistent formatting and documentation standards

1.0.3

🎉 Released:

  • 12th July 2025

🔧 Improvements:

  • Identified and resolved scaling inconsistencies between XLKit test and MarkersExtractor integration
  • Fixed XLKit test to use default parameters instead of manual overrides for consistent behaviour
  • Established consistent API usage pattern: let XLKit handle sizing automatically
  • Documented scale parameter options and best practices for image embeddings
  • Updated documentation (AGENT.MD and .cursorrules) with scaling API details and integration guidelines

1.0.2

🎉 Released:

  • 9th July 2025

🔧 Improvements:

  • Updated Security defaults

1.0.1

🎉 Released:

  • 9th July 2025

🔧 Improvements:

  • Added SecurityManager with rate limiting, security logging, file quarantine, and checksums
  • Integrated security features throughout XLSXEngine, ImageUtils, and XLKit API
  • Added comprehensive input validation for all user inputs
  • Replaced system zip command with pure Swift ZIP library to eliminate command injection risk
  • Fixed Swift 6.0 concurrency issues with @MainActor and throws propagation
  • Enhanced XLKitTestRunner with security integration and better error handling
  • Updated documentation (AGENT.MD and .cursorrules) with security features
  • Fixed test runner hanging issues and build errors
  • Expanded from 9 to all 17 professional video and cinema aspect ratios with pixel-perfect preservation
  • Added comprehensive security requirements and validation processes to development guidelines

1.0.0

🎉 Released:

  • 7th July 2025

This is the first public release of XLKit!