adding an option to disable search api response compatibility to save memory

Author: AleksandrRogov

.github/README.md

@@ -340,7 +340,8 @@ Both `dataApi` and `searchApi` can be omitted from a configuration. Their defaul
 **SearchApiOptions** properties:
 | Property Name | Type | Description |
 |--------|--------|--------|
-| escapeSpecialCharacters | `boolean` | **Works only with Search API 2.0**. Optional. Escapes special characters in the search string. |
+| escapeSpecialCharacters | `boolean` | `v2.3.0+` **Works only with Search API 2.0**. Optional. Escapes special characters in the search string. |
+| disableResponseCompatibility | `boolean` | `v2.3.0+`. Disables forced compatibility of the responses between v1 and v2. It's highly recommended to enable this option, because all response properties are duplicated by default for compatibility reasons. |
 
 ## Request Examples
 

dist/browser/esm/dynamics-web-api.js

@@ -983,8 +983,16 @@ export interface AutocompleteRequest extends BaseRequest {
     query: Autocomplete;
 }
 export type SearchApiOptions = {
-    /**Escapes the search string. Special characters that require escaping include the following: + - & | ! ( ) { } [ ] ^ " ~ * ? : \ /. */
+    /**
+     * Escapes the search string.
+     * Special characters that require escaping include the following: + - & | ! ( ) { } [ ] ^ " ~ * ? : \ /.
+     */
     escapeSpecialCharacters?: boolean;
+    /**
+     * Disables compatibility of the responses between v1 and v2.
+     * Enabling this option is highly recommended, because all response properties are duplicated by default for compatibility reasons.
+     */
+    disableResponseCompatibility?: boolean;
 };
 export interface ApiConfig<TOptions = any> {
     /** API Version to use, for example: "9.2" or "1.0". */