npm - @algolia/client-search - Versions diffs - 5.18.0 → 5.20.0 - Mend

@algolia/client-search 5.18.0 → 5.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

package/README.md +4 -4
package/dist/browser.d.ts +26 -17
package/dist/builds/browser.js +60 -47
package/dist/builds/browser.js.map +1 -1
package/dist/builds/browser.min.js +1 -1
package/dist/builds/browser.min.js.map +1 -1
package/dist/builds/browser.umd.js +1 -1
package/dist/builds/fetch.js +60 -47
package/dist/builds/fetch.js.map +1 -1
package/dist/builds/node.cjs +60 -47
package/dist/builds/node.cjs.map +1 -1
package/dist/builds/node.js +60 -47
package/dist/builds/node.js.map +1 -1
package/dist/builds/worker.js +60 -47
package/dist/builds/worker.js.map +1 -1
package/dist/fetch.d.ts +26 -17
package/dist/node.d.cts +26 -17
package/dist/node.d.ts +26 -17
package/dist/src/searchClient.cjs +60 -47
package/dist/src/searchClient.cjs.map +1 -1
package/dist/src/searchClient.js +60 -47
package/dist/src/searchClient.js.map +1 -1
package/dist/worker.d.ts +26 -17
package/package.json +10 -10

package/README.md CHANGED Viewed

@@ -41,11 +41,11 @@ All of our clients comes with type definition, and are available for both browse
 ### With a package manager
 ```bash
-yarn add @algolia/client-search@5.18.0
+yarn add @algolia/client-search@5.20.0
 # or
-npm install @algolia/client-search@5.18.0
+npm install @algolia/client-search@5.20.0
 # or
-pnpm add @algolia/client-search@5.18.0
+pnpm add @algolia/client-search@5.20.0
 ```
 ### Without a package manager
@@ -53,7 +53,7 @@ pnpm add @algolia/client-search@5.18.0
 Add the following JavaScript snippet to the <head> of your website:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.18.0/dist/builds/browser.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.20.0/dist/builds/browser.umd.js"></script>
 ```
 ### Usage

package/dist/browser.d.ts CHANGED Viewed

@@ -217,14 +217,14 @@ type RedirectURL = {
 };
 /**
- * url for a search banner image.
+ * URL for an image to show inside a banner.
  */
 type BannerImageUrl = {
     url?: string;
 };
 /**
- * image of a search banner.
+ * Image to show inside a banner.
  */
 type BannerImage = {
     urls?: Array<BannerImageUrl>;
@@ -232,14 +232,14 @@ type BannerImage = {
 };
 /**
- * link for a banner defined in merchandising studio.
+ * Link for a banner defined in the Merchandising Studio.
  */
 type BannerLink = {
     url?: string;
 };
 /**
- * a search banner with image and url.
+ * Banner with image and link to redirect users.
  */
 type Banner = {
     image?: BannerImage;
@@ -247,11 +247,11 @@ type Banner = {
 };
 /**
- * widgets returned from any rules that are applied to the current search.
+ * Widgets returned from any rules that are applied to the current search.
  */
 type Widgets = {
     /**
-     * banners defined in the merchandising studio for the given search.
+     * Banners defined in the Merchandising Studio for a given search.
      */
     banners?: Array<Banner>;
 };
@@ -1056,7 +1056,7 @@ type InsideBoundingBox = string | Array<Array<number>>;
 type NumericFilters = Array<NumericFilters> | string;
 /**
- * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
+ * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)). - Optional filters don\'t work with numeric attributes.
  */
 type OptionalFilters = Array<OptionalFilters> | string;
@@ -1253,10 +1253,6 @@ type IndexSettingsAsSearchParams = {
      * Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
      */
     ranking?: Array<string>;
-    /**
-     * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive.  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order.  - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
-     */
-    customRanking?: Array<string>;
     /**
      * Relevancy threshold below which less relevant results aren\'t included in the results.  You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
      */
@@ -1308,10 +1304,6 @@ type IndexSettingsAsSearchParams = {
     disableTypoToleranceOnAttributes?: Array<string>;
     ignorePlurals?: IgnorePlurals;
     removeStopWords?: RemoveStopWords;
-    /**
-     * Characters for which diacritics should be preserved.  By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
-     */
-    keepDiacriticsOnCharacters?: string;
     /**
      * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**.  **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
      */
@@ -1991,6 +1983,14 @@ type BaseIndexSettings = {
      * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
      */
     maxFacetHits?: number;
+    /**
+     * Characters for which diacritics should be preserved.  By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
+     */
+    keepDiacriticsOnCharacters?: string;
+    /**
+     * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive.  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order.  - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
+     */
+    customRanking?: Array<string>;
 };
 /**
@@ -3019,15 +3019,23 @@ type ReplaceAllObjectsOptions = {
      * The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      */
     batchSize?: number;
+    /**
+     * The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
+     */
+    scopes?: Array<ScopeType>;
 };
-declare const apiClientVersion = "5.18.0";
+declare const apiClientVersion = "5.20.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
      * The `appId` currently in use.
      */
     appId: string;
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: string;
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
@@ -3183,9 +3191,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
      * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
+     * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
      */
-    replaceAllObjects({ indexName, objects, batchSize }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
+    replaceAllObjects({ indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
     indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.

package/dist/builds/browser.js CHANGED Viewed

@@ -16,7 +16,7 @@ import {
   getAlgoliaAgent,
   shuffle
 } from "@algolia/client-common";
-var apiClientVersion = "5.18.0";
+var apiClientVersion = "5.20.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -81,6 +81,10 @@ function createSearchClient({
      * The `appId` currently in use.
      */
     appId: appIdOption,
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
@@ -439,57 +443,66 @@ function createSearchClient({
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
      * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
+     * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
      */
-    async replaceAllObjects({ indexName, objects, batchSize }, requestOptions) {
+    async replaceAllObjects({ indexName, objects, batchSize, scopes }, requestOptions) {
       const randomSuffix = Math.floor(Math.random() * 1e6) + 1e5;
       const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
-      let copyOperationResponse = await this.operationIndex(
-        {
-          indexName,
-          operationIndexParams: {
-            operation: "copy",
-            destination: tmpIndexName,
-            scope: ["settings", "rules", "synonyms"]
-          }
-        },
-        requestOptions
-      );
-      const batchResponses = await this.chunkedBatch(
-        { indexName: tmpIndexName, objects, waitForTasks: true, batchSize },
-        requestOptions
-      );
-      await this.waitForTask({
-        indexName: tmpIndexName,
-        taskID: copyOperationResponse.taskID
-      });
-      copyOperationResponse = await this.operationIndex(
-        {
-          indexName,
-          operationIndexParams: {
-            operation: "copy",
-            destination: tmpIndexName,
-            scope: ["settings", "rules", "synonyms"]
-          }
-        },
-        requestOptions
-      );
-      await this.waitForTask({
-        indexName: tmpIndexName,
-        taskID: copyOperationResponse.taskID
-      });
-      const moveOperationResponse = await this.operationIndex(
-        {
+      if (scopes === void 0) {
+        scopes = ["settings", "rules", "synonyms"];
+      }
+      try {
+        let copyOperationResponse = await this.operationIndex(
+          {
+            indexName,
+            operationIndexParams: {
+              operation: "copy",
+              destination: tmpIndexName,
+              scope: scopes
+            }
+          },
+          requestOptions
+        );
+        const batchResponses = await this.chunkedBatch(
+          { indexName: tmpIndexName, objects, waitForTasks: true, batchSize },
+          requestOptions
+        );
+        await this.waitForTask({
           indexName: tmpIndexName,
-          operationIndexParams: { operation: "move", destination: indexName }
-        },
-        requestOptions
-      );
-      await this.waitForTask({
-        indexName: tmpIndexName,
-        taskID: moveOperationResponse.taskID
-      });
-      return { copyOperationResponse, batchResponses, moveOperationResponse };
+          taskID: copyOperationResponse.taskID
+        });
+        copyOperationResponse = await this.operationIndex(
+          {
+            indexName,
+            operationIndexParams: {
+              operation: "copy",
+              destination: tmpIndexName,
+              scope: scopes
+            }
+          },
+          requestOptions
+        );
+        await this.waitForTask({
+          indexName: tmpIndexName,
+          taskID: copyOperationResponse.taskID
+        });
+        const moveOperationResponse = await this.operationIndex(
+          {
+            indexName: tmpIndexName,
+            operationIndexParams: { operation: "move", destination: indexName }
+          },
+          requestOptions
+        );
+        await this.waitForTask({
+          indexName: tmpIndexName,
+          taskID: moveOperationResponse.taskID
+        });
+        return { copyOperationResponse, batchResponses, moveOperationResponse };
+      } catch (error) {
+        await this.deleteIndex({ indexName: tmpIndexName });
+        throw error;
+      }
     },
     async indexExists({ indexName }) {
       try {