feat(javascript): add search wrappers to lite client (#3556)

Author: shortcuts

.github/workflows/check.yml

@@ -220,7 +220,6 @@ jobs:
         run: cd clients/algoliasearch-client-javascript && yarn test ${{ !contains(fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun, 'algoliasearch') && '--ignore algoliasearch' || '' }}
 
       - name: Test JavaScript bundle size
-        if: ${{ startsWith(env.head_ref, 'chore/prepare-release-') }}
         run: cd clients/algoliasearch-client-javascript && yarn test:size
 
       - name: Remove previous CTS output

clients/algoliasearch-client-javascript/bundlesize.config.json

@@ -2,15 +2,15 @@
   "files": [
     {
       "path": "packages/algoliasearch/dist/algoliasearch.umd.js",
-      "maxSize": "8.65KB"
+      "maxSize": "9.20KB"
     },
     {
       "path": "packages/algoliasearch/dist/lite/lite.umd.js",
-      "maxSize": "3.90KB"
+      "maxSize": "3.95KB"
     },
     {
       "path": "packages/client-abtesting/dist/client-abtesting.umd.js",
-      "maxSize": "4.05KB"
+      "maxSize": "4.10KB"
     },
     {
       "path": "packages/client-analytics/dist/client-analytics.umd.js",
@@ -30,11 +30,11 @@
     },
     {
       "path": "packages/client-search/dist/client-search.umd.js",
-      "maxSize": "7.05KB"
+      "maxSize": "7.15KB"
     },
     {
       "path": "packages/ingestion/dist/ingestion.umd.js",
-      "maxSize": "5.20KB"
+      "maxSize": "5.90KB"
     },
     {
       "path": "packages/monitoring/dist/monitoring.umd.js",

generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java

@@ -145,7 +145,7 @@ private void setDefaultGeneratorOptions() {
 
     additionalProperties.put("apiName", apiName);
     additionalProperties.put("algoliaAgent", Helpers.capitalize(CLIENT));
-    additionalProperties.put("isSearchClient", CLIENT.equals("search"));
+    additionalProperties.put("isSearchClient", CLIENT.equals("search") || isAlgoliasearchClient);
     additionalProperties.put("isIngestionClient", CLIENT.equals("ingestion"));
     additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
     additionalProperties.put("packageVersion", Helpers.getPackageJsonVersion(packageName));

templates/javascript/clients/client/api/helpers.mustache

@@ -1,3 +1,4 @@
+{{^isAlgoliasearchClient}}
 /**
  * Helper: Wait for a task to be published (completed) for a given `indexName` and `taskID`.
  *
@@ -275,36 +276,6 @@ browseSynonyms(
   });
 },
 
-/**
- * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
- * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
- *
- * @summary Search multiple indices for `hits`.
- * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
- */
-searchForHits<T>(
-  searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
-  requestOptions?: RequestOptions
-): Promise<{results: Array<SearchResponse<T>>}> {
-  return this.search(searchMethodParams, requestOptions) as Promise<{results: Array<SearchResponse<T>>}>;
-},
-
-/**
- * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
- * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
- *
- * @summary Search multiple indices for `facets`.
- * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
- */
-searchForFacets(
-  searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
-  requestOptions?: RequestOptions
-): Promise<{results: Array<SearchForFacetValuesResponse>}> {
-  return this.search(searchMethodParams, requestOptions) as Promise<{results: Array<SearchForFacetValuesResponse>}>;
-},
-
 /**
  * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
  *
@@ -476,4 +447,35 @@ async replaceAllObjects(
   });
 
   return { copyOperationResponse, batchResponses, moveOperationResponse };
+},
+{{/isAlgoliasearchClient}}
+
+/**
+ * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
+ * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
+ *
+ * @summary Search multiple indices for `hits`.
+ * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+ */
+searchForHits<T>(
+  searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
+  requestOptions?: RequestOptions
+): Promise<{results: Array<SearchResponse<T>>}> {
+  return this.search(searchMethodParams, requestOptions) as Promise<{results: Array<SearchResponse<T>>}>;
+},
+
+/**
+ * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
+ * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
+ *
+ * @summary Search multiple indices for `facets`.
+ * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+ */
+searchForFacets(
+  searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
+  requestOptions?: RequestOptions
+): Promise<{results: Array<SearchForFacetValuesResponse>}> {
+  return this.search(searchMethodParams, requestOptions) as Promise<{results: Array<SearchForFacetValuesResponse>}>;
 },

templates/javascript/clients/client/api/imports.mustache

@@ -58,6 +58,11 @@ import type {
   import type { BatchRequest } from '../model/batchRequest';
 {{/isSearchClient}}
 
+{{#isAlgoliasearchClient}}
+  import type { SearchResponse } from '../model/searchResponse';
+  import type { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse';
+{{/isAlgoliasearchClient}}
+
 {{#isIngestionClient}}
   import type { OnDemandTrigger } from '../model/onDemandTrigger';
   import type { ScheduleTrigger } from '../model/scheduleTrigger';

templates/javascript/clients/client/model/clientMethodProps.mustache

@@ -47,6 +47,7 @@ export type {{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Props = {
 {{/operations}}
 
 {{#isSearchClient}}
+{{^isAlgoliasearchClient}}
 /**
  * The `browseObjects`, `browseRules`, `browseSynonyms` options.
  */
@@ -175,6 +176,7 @@ export type ReplaceAllObjectsOptions = {
    */
   batchSize?: number;
 }
+{{/isAlgoliasearchClient}}
 {{/isSearchClient}}
 
 {{/apiInfo.apis.0}}