Update CHANGELOG.md

Author: pdphilip

CHANGELOG.md

@@ -9,11 +9,6 @@ All notable changes to this `laravel-elasticsearch` package will be documented i
 - `Schema::compileMapping()` — compile a Blueprint callback into its resulting ES mapping structure without creating the index. Useful for debugging and previewing what `mappingDefinition()` will produce.
 - `Grammar::compileMapping()` — public access to the Blueprint-to-properties compilation pipeline.
 
-### Improved
-
-- `elastic:re-index` mapping analysis now uses `getMappings()` + `compileMapping()` for a proper apples-to-apples comparison, replacing the manual tree-building approach. Correctly handles nested types with properties, multi-field types with sub-fields, and any combination at any depth.
-- `elastic:re-index` output uses `dataList` depth rendering for both "Fields to Update" and "Unmapped Fields", showing nested structures with proper indentation.
-
 ### Fixed
 
 - `elastic:re-index` now correctly detects nested field mappings (e.g., `nested('tags')->properties(...)`) including their sub-fields and keyword sub-field changes.
@@ -30,14 +25,16 @@ This release is compatible with Laravel 10, 11 & 12
 
 #### Automated Re-indexing Command
 
-New `elastic:re-index` command that automates the entire re-indexing process when your field mappings change. Pass a model name and the command handles the rest — creating a temp index, copying data, verifying counts, swapping, and cleaning up across 9 interactive phases with confirmation prompts between each step. - [Docs](https://elasticsearch.pdphilip.com/schema/artisan-commands/#elasticre-index)
+New `elastic:re-index` command that automates the entire re-indexing process when your field mappings change. Pass a model name and the command handles the rest — creating a temp index, copying data, verifying counts, swapping, and cleaning
+up across 9 interactive phases with confirmation prompts between each step. - [Docs](https://elasticsearch.pdphilip.com/schema/artisan-commands/#elasticre-index)
 
 ```bash
 php artisan elastic:re-index UserLog
 php artisan elastic:re-index "App\Models\ES\UserLog"
 ```
 
 Features include:
+
 - Smart mapping analysis that detects type mismatches and sub-field changes (e.g., adding `hasKeyword: true`)
 - Resume capability — interrupted runs pick up where they left off
 - Configurable tolerance and retry settings
@@ -54,7 +51,8 @@ php artisan elastic:make ES/UserLog
 
 #### Mapping Definition on Models
 
-Define your index field mappings directly on the model by overriding `mappingDefinition()`. Uses the same Blueprint syntax as migrations. Powers the `elastic:re-index` command's mapping analysis. - [Docs](https://elasticsearch.pdphilip.com/eloquent/the-base-model/#mapping-definition)
+Define your index field mappings directly on the model by overriding `mappingDefinition()`. Uses the same Blueprint syntax as migrations. Powers the `elastic:re-index` command's mapping
+analysis. - [Docs](https://elasticsearch.pdphilip.com/eloquent/the-base-model/#mapping-definition)
 
 ```php
 public static function mappingDefinition(Blueprint $index): void
@@ -141,7 +139,8 @@ Why: Elasticsearch has no native upsert-by-field. This queries for existing docu
 
 #### Time-Ordered IDs
 
-New `GeneratesTimeOrderedIds` trait for sortable, chronologically-ordered IDs. 20 characters, URL-safe, lexicographic sort matches creation order across processes. - [Docs](https://elasticsearch.pdphilip.com/eloquent/the-base-model/#time-ordered-ids)
+New `GeneratesTimeOrderedIds` trait for sortable, chronologically-ordered IDs. 20 characters, URL-safe, lexicographic sort matches creation order across
+processes. - [Docs](https://elasticsearch.pdphilip.com/eloquent/the-base-model/#time-ordered-ids)
 
 ```php
 use PDPhilip\Elasticsearch\Eloquent\GeneratesTimeOrderedIds;
@@ -161,6 +160,7 @@ Safe for mixed datasets; returns `null` for pre-existing IDs not generated by th
 Why: When you need IDs that sort chronologically across multiple processes/workers, ideal for high-volume event tracking and time-sequenced analytics.
 
 ### Changed
+
 - Refactored Query Builder into focused concerns: `BuildsAggregations`, `BuildsSearchQueries`, `BuildsFieldQueries`, `BuildsGeoQueries`, `BuildsNestedQueries`, `HandlesScripts`, `ManagesPit`
 - Refactored Grammar into concerns: `CompilesAggregations`, `CompilesOrders`, `CompilesWheres`, `FieldUtilities`
 - Decomposed `ElasticsearchModel` trait into focused traits for clarity
@@ -174,6 +174,7 @@ Why: When you need IDs that sort chronologically across multiple processes/worke
 - Test suite expanded from 379 to 422 tests (2,548 assertions), all passing
 
 ### Fixed
+
 - `id` is now always present in serialized model output (`toArray()`, `toJson()`)
 - `_id` is no longer exposed in serialized output (internal metadata stays internal)
 - Removed dead debug code from Connection.php
@@ -201,6 +202,7 @@ UserLog::where('created_at', '>=', Carbon::now()->subDays(30))
 
 
 ```
+
 Why: You can now treat distinct aggregations like real Eloquent results, including relationships.
 
 #### Bulk Distinct Queries
@@ -215,19 +217,22 @@ $top3 = UserSession::where('created_at', '>=', Carbon::now()->subDays(30))
     ->bulkDistinct(['country', 'device', 'browser_name'], true);
 
 ```
+
 Why: Massive performance gains vs running sequential distinct queries.
 
 #### Group By Ranges
 
-`groupByRanges()` performs a [range aggregation](https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation) on the specified field. - [Docs](https://elasticsearch.pdphilip.com/eloquent/distinct/#groupby-ranges)
+`groupByRanges()` performs a [range aggregation](https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation) on the specified
+field. - [Docs](https://elasticsearch.pdphilip.com/eloquent/distinct/#groupby-ranges)
 
 `groupByRanges()->get()`  — return bucketed results - [Docs](https://elasticsearch.pdphilip.com/eloquent/distinct/#groupby-ranges)
 
-`groupByRanges()->agg()` -  apply metric aggregations per bucket -[Docs](https://elasticsearch.pdphilip.com/eloquent/distinct/#groupby-ranges-with-aggregations)
+`groupByRanges()->agg()` - apply metric aggregations per bucket -[Docs](https://elasticsearch.pdphilip.com/eloquent/distinct/#groupby-ranges-with-aggregations)
 
 #### Group By Date Ranges
 
-`groupByDateRanges()` performs a [date range aggregation](https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation) on the specified field. - [Docs](https://elasticsearch.pdphilip.com/eloquent/distinct/#groupby-date-ranges)
+`groupByDateRanges()` performs a [date range aggregation](https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation) on the specified
+field. - [Docs](https://elasticsearch.pdphilip.com/eloquent/distinct/#groupby-date-ranges)
 
 `groupByDateRanges()->get()` — bucketed date ranges
 
@@ -244,6 +249,7 @@ $product = Product::where('color', 'green')->first();
 $score = $product->getMetaValue('score');
 
 ```
+
 #### Bucket Values in Meta
 
 When a bucketed query is executed, the raw bucket data is now stored in model meta. -[Docs](https://elasticsearch.pdphilip.com/eloquent/distinct/#raw-bucket-values-from-meta)
@@ -255,6 +261,7 @@ $buckets = $products->map(function ($product) {
 });
 
 ```
+
 **Full Changelog**: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.2.0...v5.3.0
 
 ## v5.2.0 - 2025-10-24
@@ -286,6 +293,7 @@ Product::searchQueryString('vanilla +pizza -ice', function (QueryStringOptions $
 
 
 ```
+
 ### Ordering enhancement: unmapped_type
 
 - You can now add an `unmapped_type` flag to your ordering query #88
@@ -295,6 +303,7 @@ Product::query()->orderBy('name', 'desc', ['unmapped_type' => 'keyword'])->get()
 
 
 ```
+
 ### Bugfix
 
 - Fixed issue where limit values were being reset on bucket aggregations #84
@@ -316,6 +325,7 @@ $totalHits = $products->getQueryMeta()->getTotalHits();
 
 
 ```
+
 This can be set by default for all queries by updating the connection config in `database.php`:
 
 ```php
@@ -331,6 +341,7 @@ This can be set by default for all queries by updating the connection config in
 
 
 ```
+
 #### 2. New feature, `createOrFail(array $attributes)`
 
 By default, when using `create($attributes)` where `$attributes `has an `id` that exists, the operation will upsert. `createOrFail` will throw a `BulkInsertQueryException` with status code `409` if the `id` exists
@@ -345,6 +356,7 @@ Product::createOrFail([
 
 
 ```
+
 #### 3. New feature `withRefresh(bool|string $refresh)`
 
 By default, inserting documents will wait for the shards to refresh, ie: `withRefresh(true)`, you can set the refresh flag with the following (as per ES docs):
@@ -365,6 +377,7 @@ Product::withRefresh('wait_for')->create([
 
 
 ```
+
 ### PRS
 
 * Add withTrackTotalHits method to Builder class to add track_total_hits by @caufab in https://github.com/pdphilip/laravel-elasticsearch/pull/76
@@ -406,9 +419,9 @@ This release is compatible with Laravel 10, 11 & 12
 
 ### What's Changed
 
-* Merging in bug fixes  by @use-the-fork in https://github.com/pdphilip/laravel-elasticsearch/pull/65
+* Merging in bug fixes by @use-the-fork in https://github.com/pdphilip/laravel-elasticsearch/pull/65
 * Updated outstanding tests
-* Fixed bug in  relations`has()` method
+* Fixed bug in relations`has()` method
 
 **Full Changelog**: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.4...v5.0.5
 
@@ -475,6 +488,7 @@ People::bulkInsert([
 
 
 ```
+
 Returns:
 
 ```json
@@ -502,6 +516,7 @@ Returns:
 
 
 ```
+
 #### 2. Bug fix: `distinct()` aggregation now appends `searchAfter` key in meta
 
 **Full Changelog**: https://github.com/pdphilip/laravel-elasticsearch/compare/v5.0.1...v5.0.2
@@ -530,9 +545,8 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 ### Upgrading
 
 - Please take a look at the [upgrade guide](https://elasticsearch.pdphilip.com/upgrade-guide/) carefully, as there are several significant breaking changes.
-  
+
 - [New features are detailed here](https://elasticsearch.pdphilip.com/whats-new/)
-  
 
 ```json
 "pdphilip/elasticsearch": "^5",
@@ -544,6 +558,7 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 
 
 ```
+
 ### Breaking Changes
 
 #### 1. Connection
@@ -558,10 +573,10 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 - **Model ID Field**
   `$model->_id` is deprecated. Use `$model->id` instead.
   If your model had a separate `id` field, you must rename it.
-  
+
 - **Default Limit Constant**
   `MAX_SIZE` constant is removed. Use `$defaultLimit` property:
-  
+
   ```php
   use PDPhilip\Elasticsearch\Eloquent\Model;
 
@@ -582,9 +597,9 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 #### 3. Queries
 
 - `where()` Behavior Changed
-  
+
   Now uses term query instead of match.
-  
+
   ```php
   // Old:
   Product::where('name', 'John')->get(); // match query
@@ -600,13 +615,13 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 
   ```
 - `orderByRandom()` Removed
-  
+
   Replace with `functionScore()` [Docs](https://elasticsearch.pdphilip.com/upgrade-guide#queries)
-  
+
 - Full-text Search Options Updated
   Methods like `asFuzzy()`, `setMinShouldMatch()`, `setBoost()` removed.
   Use callback-based SearchOptions instead:
-  
+
   ```php
   Product::searchTerm('espresso time', function (SearchOptions $options) {
         $options->searchFuzzy();
@@ -623,19 +638,17 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
   ```
 - Legacy Search Methods Removed
   All `{xx}->search()` methods been removed. Use `{multi_match}->get()` instead.
-  
 
 #### 4. Distinct & GroupBy
 
 - `distinct()` and `groupBy()` behavior updated. [Docs](https://elasticsearch.pdphilip.com/eloquent/distinct/)
-  
+
   Review queries using them and refactor accordingly.
-  
 
 #### 5. Schema
 
 - `IndexBlueprint` and `AnalyzerBlueprint` has been removed and replaced with a single `Blueprint` class
-  
+
   ```diff
   -   use PDPhilip\Elasticsearch\Schema\IndexBlueprint;
   -   use PDPhilip\Elasticsearch\Schema\AnalyzerBlueprint;
@@ -649,25 +662,24 @@ with Laravel’s Eloquent. It lays a solid, future-proof foundation for everythi
 
   ```
 - `Schema::hasIndex` has been removed. Use `Schema::hasTable` or `Schema::indexExists` instead.
-  
+
 - `geo($field)` field property has been replaced with `geoPoint($field)`
-  
+
 - `{field}->index($bool)` field property has been replaced with `{field}->indexField($bool)`;
-  
+
 - `alias()` field type has been removed. Use `aliasField()` instead.
-  
+
 - `settings()` method has been replaced with `withSetting()`
-  
+
 - `map()` method has been replaced with `withMapping()`
-  
+
 - `analyzer()` method has been replaced with `addAnalyzer()`
-  
+
 - `tokenizer()` method has been replaced with `addTokenizer()`
-  
+
 - `charFilter()` method has been replaced with `addCharFilter()`
-  
+
 - `filter()` method has been replaced with `addFilter()`
-  
 
 #### 6. Dynamic Indices
 
@@ -719,6 +731,7 @@ Connection::on('elasticsearch')->elastic()->{clientMethod}();
 
 
 ```
+
 ### What's Changed
 
 * V5.0.0 by @use-the-fork in https://github.com/pdphilip/laravel-elasticsearch/pull/54