@indxsearch/intrface 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -5,6 +5,46 @@ All notable changes to @indxsearch/intrface 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).
 
+## [2.1.0] - 2026-01-21
+
+### Added
+- Added dependency on `@indxsearch/indx-types` for centralized API type definitions
+- Added `RequiredCoverageSetup` type for internal use (all properties guaranteed present)
+- Added new CoverageSetup properties: `truncateWordHitLimit`, `truncateWordHitTolerance`, `includePatternMatches`
+- Added "Include Pattern Matches" toggle to SearchSettingsPanel
+
+### Fixed
+- **BREAKING FIX**: Fixed `SystemStatus.state` → `systemStatus.systemState` to match actual API response
+- **BREAKING FIX**: Fixed `SearchResult.documentKey` type from `string` to `number` (Int32) to match API
+- Fixed SystemState enum usage with proper numeric comparisons
+- Updated CoverageSetup defaults to match IndxCloudApi v1.0.2 specification
+- Fixed `truncationScore` default value: 254 → 255
+
+### Changed
+- **BREAKING**: Updated CoverageSetup interface to match IndxCloudApi v1.0.2
+  - Removed obsolete properties: `coverageMinWordHitsAbs`, `coverageMinWordHitsRelative`, `coverageLcsErrorToleranceRelativeq`, `coverageQLimitForErrorTolerance`
+  - These properties no longer exist in the API specification
+- Updated SearchSettingsPanel UI to reflect new CoverageSetup parameters
+- Removed `truncationScore` input from SearchSettingsPanel UI (still sent to API with default value)
+- Now imports `CoverageSetup` and `ScoreEntry` types from `@indxsearch/indx-types`
+- Imports `SystemState` enum as value (not just type) for runtime comparisons
+
+### Technical Details
+This release aligns `@indxsearch/intrface` with the official IndxCloudApi v1.0.2 Swagger specification. The breaking changes fix discrepancies between the package and the actual API that could cause runtime errors or unexpected behavior.
+
+### Migration Guide
+If upgrading from 2.0.x:
+
+1. **SystemStatus access**: Change `statusData.state` to `statusData.systemState`
+2. **DocumentKey**: If you're manipulating `documentKey` values, they are now numbers instead of strings
+3. **CoverageSetup**: Remove any usage of the deleted properties listed above
+
+### Compatibility
+- Requires IndxCloudApi v1.0.2
+- Requires `@indxsearch/indx-types` ^1.0.0
+- React ^19.0.0
+- React DOM ^19.0.0
+
 ## [2.0.1] - 2026-01-16
 
 ### Fixed
@@ -59,5 +99,5 @@ npm install @indxsearch/intrface@latest
 Or with a specific version:
 
 ```bash
-npm install @indxsearch/intrface@2.0.1
+npm install @indxsearch/intrface@2.1.0
 ```

package/README.md

@@ -1,6 +1,6 @@
 # @indxsearch/intrface
 
-A powerful, flexible React search UI library for INDX Search API.
+A powerful, flexible React search UI library for Indx Search with [IndxCloudApi](https://github.com/indxSearch/IndxCloudApi).
 
 ## Features
 
@@ -16,12 +16,12 @@ A powerful, flexible React search UI library for INDX Search API.
 
 | Package | Version |
 |---------|---------|
-| **IndxCloudApi** | `1.0.0` |
+| **IndxCloudApi** | `1.0.2` |
 | **React** | `^19.0.0` |
 | **React DOM** | `^19.0.0` |
 | **Node.js** | `>=16.0.0` |
 
-> **Note:** This library is designed specifically for IndxCloudApi version 1.0.0. Different API versions may have incompatible changes.
+> **Note:** This library is designed specifically for IndxCloudApi version 1.0.2. Different API versions may have incompatible changes.
 
 ## Installation
 
@@ -29,6 +29,8 @@ A powerful, flexible React search UI library for INDX Search API.
 npm install @indxsearch/intrface @indxsearch/systm @indxsearch/pixl
 ```
 
+> **Note:** TypeScript type definitions for IndxCloudApi are automatically included via the `@indxsearch/indx-types` dependency.
+
 ## Quick Start
 
 ### 1. Set Up Environment Variables
@@ -373,10 +375,12 @@ export default function AdvancedSearch() {
 | `dataset` | `string` | ✅ | - | Dataset name |
 | `allowEmptySearch` | `boolean` | ❌ | `false` | Show results without query |
 | `enableFacets` | `boolean` | ❌ | `true` | Enable faceted search |
+| `enableCoverage` | `boolean` | ❌ | `true` | Enable coverage-based fuzzy matching |
 | `maxResults` | `number` | ❌ | `10` | Max results per search |
-| `facetDebounceDelayMillis` | `number` | ❌ | `500` | Debounce delay for facet updates |
+| `facetDebounceDelayMillis` | `number` | ❌ | `500` | Debounce delay for facet updates (ms) |
 | `coverageDepth` | `number` | ❌ | `500` | Search depth for fuzzy matching |
-| `removeDuplicates` | `boolean` | ❌ | `false` | Remove duplicate results |
+| `removeDuplicates` | `boolean` | ❌ | `true` | Remove duplicate results |
+| `initialCoverageSetup` | `Partial<CoverageSetup>` | ❌ | `{}` | Override default coverage settings |
 | `enableDebugLogs` | `boolean` | ❌ | `false` | Enable detailed console logging |
 
 ### SearchInput Props