adding search query v1 to v2 conversion

AleksandrRogov · AleksandrRogov · commit c74307251ade · 2025-03-16T23:38:26.000-04:00
diff --git a/src/dynamics-web-api.ts b/src/dynamics-web-api.ts
@@ -930,7 +930,7 @@ export interface SearchQueryBase {
     /**The search parameter value contains the term to be searched for and has a 100-character limit. For suggestions, min 3 characters in addition. */
     search: string;
     /**The default table list searches across all Dataverse search–configured tables and columns. The default list is configured by your administrator when Dataverse search is enabled. */
-    entities?: string[] | SearchEntity[];
+    entities?: string[] | SearchEntity[] | string;
     /**Filters are applied while searching data and are specified in standard OData syntax. */
     filter?: string;
 }
@@ -941,7 +941,7 @@ export interface Query extends SearchQueryBase {
     /**Facets support the ability to drill down into data results after they've been retrieved. */
     facets?: string[];
     /**
-     * Specify true to return the total record count; otherwise false. The default is false. 
+     * V1. Specify true to return the total record count; otherwise false. The default is false. 
      * @deprecated Use "count".
      */
     returnTotalRecordCount?: boolean;
@@ -952,14 +952,14 @@ export interface Query extends SearchQueryBase {
     /**A list of comma-separated clauses where each clause consists of a column name followed by 'asc' (ascending, which is the default) or 'desc' (descending). This list specifies how to order the results in order of precedence. */
     orderBy?: string[];
     /**V2. Options are settings configured to search a search term. */
-    options?: SearchOptions[];
+    options?: SearchOptions;
     /**
-     * Specifies whether any or all the search terms must be matched to count the document as a match. The default is 'any'.
+     * V1. Specifies whether any or all the search terms must be matched to count the document as a match. The default is 'any'.
      * @deprecated Use "options.searchmode".
      */
     searchMode?: SearchMode;
     /**
-     * For V2, use "options.querytype". The search type specifies the syntax of a search query. Using 'simple' selects simple query syntax and 'full' selects Lucene query syntax. The default is 'simple'.
+     * V1. The search type specifies the syntax of a search query. Using 'simple' selects simple query syntax and 'full' selects Lucene query syntax. The default is 'simple'.
      * @deprecated Use "options.querytype".
      */
     searchType?: SearchType;
diff --git a/src/requests/search/autocomplete.ts b/src/requests/search/autocomplete.ts
@@ -1,27 +1,28 @@
 import type { IDataverseClient } from "../../client/dataverse";
 import type { AutocompleteRequest, AutocompleteResponse } from "../../dynamics-web-api";
-import { copyObject, isObject } from "../../utils/Utility";
+import { copyObject } from "../../utils/Utility";
 import { ErrorHelper } from "../../helpers/ErrorHelper";
 import { InternalRequest } from "../../types";
 import { LIBRARY_NAME } from "../constants";
+import { convertSearchQuery } from "./convertSearchQuery";
 
 const FUNCTION_NAME = "autocomplete";
 const REQUEST_NAME = `${LIBRARY_NAME}.${FUNCTION_NAME}`;
 
 export async function autocomplete(request: string | AutocompleteRequest, client: IDataverseClient): Promise<AutocompleteResponse> {
     ErrorHelper.parameterCheck(request, REQUEST_NAME, "request");
 
-    const _isObject = isObject(request);
+    const _isObject = typeof request !== "string";
     const parameterName = _isObject ? "request.query.search" : "term";
-    const internalRequest: InternalRequest = _isObject ? copyObject(request) : { query: { search: request as string } };
+    const internalRequest: InternalRequest = _isObject ? copyObject(request) : { query: { search: request } };
 
     if (_isObject) ErrorHelper.parameterCheck(internalRequest.query, REQUEST_NAME, "request.query");
     ErrorHelper.stringParameterCheck(internalRequest.query.search, REQUEST_NAME, parameterName);
     ErrorHelper.maxLengthStringParameterCheck(internalRequest.query.search, REQUEST_NAME, parameterName, 100);
 
-    internalRequest.functionName = internalRequest.collection = "autocomplete";
+    internalRequest.functionName = internalRequest.collection = FUNCTION_NAME;
     internalRequest.method = "POST";
-    internalRequest.data = internalRequest.query;
+    internalRequest.data = convertSearchQuery(internalRequest.query, FUNCTION_NAME, client.config);
     internalRequest.apiConfig = client.config.searchApi;
 
     delete internalRequest.query;
diff --git a/src/requests/search/convertSearchQuery.ts b/src/requests/search/convertSearchQuery.ts
@@ -0,0 +1,84 @@
+import type { Autocomplete, Suggest, Query, SearchEntity } from "../../dynamics-web-api";
+import { InternalConfig } from "../../utils/Config";
+
+export function convertSearchQuery(query: Query | Suggest | Autocomplete, functionName: string, config: InternalConfig) {
+    if (!query) return query;
+
+    query.entities = convertEntitiesProperty(query.entities, config.searchApi?.version);
+    if (functionName === "query") {
+        query = convertQuery(query as Query, config.searchApi?.version);
+    }
+
+    return query;
+}
+
+function convertEntitiesProperty(entities?: string | string[] | SearchEntity[], version: string = "1.0"): string | string[] | SearchEntity[] | undefined {
+    if (!entities) return entities;
+    if (typeof entities === "string") {
+        if (version !== "1.0") return entities;
+        throw new Error(
+            "The 'entities' property must be an array of strings in the Search API v1.0. It cannot be a string. Or set Search API version to v2.0.",
+        );
+    }
+
+    const toStringArray = (entity: string | SearchEntity) => {
+        if (typeof entity === "string") return entity;
+        return entity.name;
+    };
+
+    const toSearchEntity = (entity: string | SearchEntity) => {
+        if (typeof entity === "string") return { name: entity };
+        return entity;
+    };
+
+    return entities.map((entity: string | SearchEntity) => (version === "1.0" ? toStringArray(entity) : toSearchEntity(entity))) as string[] | SearchEntity[];
+}
+
+function convertQuery(query: Query, version: string = "1.0") {
+    const toV1 = (query: Query) => {
+        if (query.count != null) {
+            query.returnTotalRecordCount = query.count;
+            delete query.count;
+        }
+
+        if (query.options) {
+            if (!query.searchMode) {
+                query.searchMode = query.options.searchmode;
+            }
+
+            if (!query.searchType) {
+                query.searchType = query.options.querytype === "simple" ? "simple" : "full";
+            }
+
+            delete query.options;
+        }
+
+        return query;
+    };
+
+    const toV2 = (query: Query) => {
+        if (query.returnTotalRecordCount != null) {
+            query.count = query.returnTotalRecordCount;
+            delete query.returnTotalRecordCount;
+        }
+
+        if (query.searchMode || query.searchType) {
+            if (!query.options) query.options = {};
+
+            if (!query.options.searchmode) {
+                query.options.searchmode = query.searchMode;
+            }
+
+            if (!query.options.querytype) {
+                query.options.querytype = query.searchType === "simple" ? "simple" : "lucene";
+            }
+
+            delete query.searchMode;
+            delete query.searchType;
+        }
+
+        return query;
+    };
+
+    return version === "1.0" ? toV1(query) : toV2(query);
+}
diff --git a/src/requests/search/query.ts b/src/requests/search/query.ts
@@ -4,6 +4,7 @@ import { copyObject } from "../../utils/Utility";
 import { ErrorHelper } from "../../helpers/ErrorHelper";
 import { InternalRequest } from "../../types";
 import { LIBRARY_NAME } from "../constants";
+import { convertSearchQuery } from "./convertSearchQuery";
 
 const FUNCTION_NAME = "search";
 const REQUEST_NAME = `${LIBRARY_NAME}.${FUNCTION_NAME}`;
@@ -22,7 +23,7 @@ export async function query<TValue = any>(request: string | QueryRequest, client
     internalRequest.collection = "query";
     internalRequest.functionName = FUNCTION_NAME;
     internalRequest.method = "POST";
-    internalRequest.data = internalRequest.query;
+    internalRequest.data = convertSearchQuery(internalRequest.query, FUNCTION_NAME, client.config);
     internalRequest.apiConfig = client.config.searchApi;
 
     delete internalRequest.query;
diff --git a/src/requests/search/suggest.ts b/src/requests/search/suggest.ts
@@ -1,27 +1,28 @@
 import type { IDataverseClient } from "../../client/dataverse";
 import type { SuggestRequest, SuggestResponse } from "../../dynamics-web-api";
-import { copyObject, isObject } from "../../utils/Utility";
+import { copyObject } from "../../utils/Utility";
 import { ErrorHelper } from "../../helpers/ErrorHelper";
 import { InternalRequest } from "../../types";
 import { LIBRARY_NAME } from "../constants";
+import { convertSearchQuery } from "./convertSearchQuery";
 
 const FUNCTION_NAME = "suggest";
 const REQUEST_NAME = `${LIBRARY_NAME}.${FUNCTION_NAME}`;
 
 export async function suggest<TValueDocument = any>(request: string | SuggestRequest, client: IDataverseClient): Promise<SuggestResponse<TValueDocument>> {
     ErrorHelper.parameterCheck(request, REQUEST_NAME, "request");
 
-    const _isObject = isObject(request);
+    const _isObject = typeof request !== "string";
     const parameterName = _isObject ? "request.query.search" : "term";
-    const internalRequest: InternalRequest = _isObject ? copyObject(request) : { query: { search: request as string } };
+    const internalRequest: InternalRequest = _isObject ? copyObject(request) : { query: { search: request } };
 
     ErrorHelper.parameterCheck(internalRequest.query, REQUEST_NAME, "request.query");
     ErrorHelper.stringParameterCheck(internalRequest.query.search, REQUEST_NAME, parameterName);
     ErrorHelper.maxLengthStringParameterCheck(internalRequest.query.search, REQUEST_NAME, parameterName, 100);
 
-    internalRequest.functionName = internalRequest.collection = "suggest";
+    internalRequest.functionName = internalRequest.collection = FUNCTION_NAME;
     internalRequest.method = "POST";
-    internalRequest.data = internalRequest.query;
+    internalRequest.data = convertSearchQuery(internalRequest.query, FUNCTION_NAME, client.config);
     internalRequest.apiConfig = client.config.searchApi;
 
     delete internalRequest.query;
