[Search] Allow nested field names to be specified in select and searchField options (Azure#23627)

Author: dgetu

sdk/search/search-documents/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Release History
 
-## 11.3.0-beta.9 (Unreleased)
+## 12.0.0-beta.1 (2023-03-07)
 
 ### Features Added
 
@@ -9,13 +9,41 @@
 ### Breaking Changes
 
 - Update `SearchIndexerDataNoneIdentity.odatatype`. [#23495](https://github.com/Azure/azure-sdk-for-js/pull/23495)
+- Fix `SearchClient.getDocument` returning documents that contain fields which were not selected [#23627](https://github.com/Azure/azure-sdk-for-js/pull/23627)
+- Add type narrowing to returned documents [#23627](https://github.com/Azure/azure-sdk-for-js/pull/23627)
+  - Add breaking type parameters to these types:
+    - `AutocompleteOptions`
+    - `AutocompleteRequest`
+    - `GetDocumentOptions`
+    - `SearchIterator`
+    - `SearchOptions`
+    - `SearchRequestOptions`
+    - `SuggestOptions`
+    - `SuggestRequest`
 
 ### Bugs Fixed
 
+- Allow nested field names to be specified in `select` and `searchFields` options [#23627](https://github.com/Azure/azure-sdk-for-js/pull/23627)
+  - Affects these types:
+    - `AutocompleteRequest`
+    - `SearchRequestOptions`
+    - `SuggestRequest`
 - Fix discarded user-defined `onResponse` callback [#24479](https://github.com/Azure/azure-sdk-for-js/pull/24479)
 
 ### Other Changes
 
+- Add `object` type constraint to `IndexDocumentsClient` and its dependencies [#23627](https://github.com/Azure/azure-sdk-for-js/pull/23627)
+  - Affects these types:
+    - `IndexDocumentsClient`
+    - `SearchClient`
+    - `SearchDocumentsPageResult`
+    - `SearchDocumentsResult`
+    - `SearchIndexClient.getSearchClient`
+    - `SearchIndexingBufferedSender`
+    - `SearchResult`
+    - `SuggestDocumentsResult`
+    - `SuggestResult`
+
 ## 11.3.0-beta.8 (2022-09-06)
 
 - Added `core-http-compat` dependency

sdk/search/search-documents/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "js",
   "TagPrefix": "js/search/search-documents",
-  "Tag": "js/search/search-documents_ac717f12fa"
+  "Tag": "js/search/search-documents_edce456e12"
 }

sdk/search/search-documents/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/search-documents",
-  "version": "11.3.0-beta.9",
+  "version": "12.0.0-beta.1",
   "description": "Azure client library to use Cognitive Search for node.js and browser.",
   "sdk-type": "client",
   "main": "dist/index.js",

sdk/search/search-documents/review/search-documents.api.md

@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export const SDK_VERSION: string = "11.3.0-beta.9";
+export const SDK_VERSION: string = "12.0.0-beta.1";

sdk/search/search-documents/src/constants.ts

@@ -12,6 +12,8 @@ export {
   AutocompleteOptions,
   CountDocumentsOptions,
   DeleteDocumentsOptions,
+  ExcludedODataTypes,
+  ExtractDocumentKey,
   GetDocumentOptions,
   IndexDocumentsAction,
   ListSearchResultsPageSettings,
@@ -30,13 +32,18 @@ export {
   SuggestOptions,
   MergeDocumentsOptions,
   MergeOrUploadDocumentsOptions,
+  NarrowedModel,
   UploadDocumentsOptions,
   SearchIndexingBufferedSenderOptions,
   SearchIndexingBufferedSenderDeleteDocumentsOptions,
   SearchIndexingBufferedSenderFlushDocumentsOptions,
   SearchIndexingBufferedSenderMergeDocumentsOptions,
   SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions,
   SearchIndexingBufferedSenderUploadDocumentsOptions,
+  SearchPick,
+  SelectFields,
+  SuggestNarrowedModel,
+  UnionToIntersection,
 } from "./indexModels";
 export { SearchIndexingBufferedSender, IndexDocumentsClient } from "./searchIndexingBufferedSender";
 export { SearchIndexClient, SearchIndexClientOptions } from "./searchIndexClient";