npm - @algolia/client-search - Versions diffs - 5.10.2 → 5.12.0 - Mend

@algolia/client-search 5.10.2 → 5.12.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 (21) hide show

package/README.md +4 -4
package/dist/browser.d.ts +15 -8
package/dist/builds/browser.js +12 -7
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 +12 -7
package/dist/builds/fetch.js.map +1 -1
package/dist/builds/node.cjs +12 -7
package/dist/builds/node.cjs.map +1 -1
package/dist/builds/node.js +12 -7
package/dist/builds/node.js.map +1 -1
package/dist/fetch.d.ts +15 -8
package/dist/node.d.cts +15 -8
package/dist/node.d.ts +15 -8
package/dist/src/searchClient.cjs +12 -7
package/dist/src/searchClient.cjs.map +1 -1
package/dist/src/searchClient.js +12 -7
package/dist/src/searchClient.js.map +1 -1
package/package.json +9 -9

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.10.2
+yarn add @algolia/client-search@5.12.0
 # or
-npm install @algolia/client-search@5.10.2
+npm install @algolia/client-search@5.12.0
 # or
-pnpm add @algolia/client-search@5.10.2
+pnpm add @algolia/client-search@5.12.0
 ```
 ### Without a package manager
@@ -53,7 +53,7 @@ pnpm add @algolia/client-search@5.10.2
 Add the following JavaScript snippet to the <head> of your website:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.10.2/dist/builds/browser.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.12.0/dist/builds/browser.umd.js"></script>
 ```
 ### Usage

package/dist/browser.d.ts CHANGED Viewed

@@ -755,6 +755,10 @@ type GetObjectsParams = {
 };
 type GetObjectsResponse<T = Record<string, unknown>> = {
+    /**
+     * An optional status message.
+     */
+    message?: string;
     /**
      * Retrieved records.
      */
@@ -1791,7 +1795,7 @@ type SearchRulesResponse = {
 /**
  * Synonym type.
  */
-type SynonymType = 'synonym' | 'onewaysynonym' | 'altcorrection1' | 'altcorrection2' | 'placeholder';
+type SynonymType = 'synonym' | 'onewaysynonym' | 'altcorrection1' | 'altcorrection2' | 'placeholder' | 'oneWaySynonym' | 'altCorrection1' | 'altCorrection2';
 /**
  * Synonym object.
@@ -2999,19 +3003,19 @@ type SearchClientNodeHelpers = {
     generateSecuredApiKey: (opts: GenerateSecuredApiKeyOptions) => string;
     getSecuredApiKeyRemainingValidity: (opts: GetSecuredApiKeyRemainingValidityOptions) => number;
 };
-type DeleteObjectsOptions = Pick<ChunkedBatchOptions, 'indexName'> & {
+type DeleteObjectsOptions = Pick<ChunkedBatchOptions, 'indexName' | 'waitForTasks'> & {
     /**
      * The objectIDs to delete.
      */
     objectIDs: string[];
 };
-type PartialUpdateObjectsOptions = Pick<ChunkedBatchOptions, 'indexName' | 'objects'> & {
+type PartialUpdateObjectsOptions = Pick<ChunkedBatchOptions, 'indexName' | 'objects' | 'waitForTasks'> & {
     /**
      *To be provided if non-existing objects are passed, otherwise, the call will fail.
      */
     createIfNotExists?: boolean;
 };
-type SaveObjectsOptions = Pick<ChunkedBatchOptions, 'indexName' | 'objects'>;
+type SaveObjectsOptions = Pick<ChunkedBatchOptions, 'indexName' | 'objects' | 'waitForTasks'>;
 type ChunkedBatchOptions = ReplaceAllObjectsOptions & {
     /**
      * The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
@@ -3037,7 +3041,7 @@ type ReplaceAllObjectsOptions = {
     batchSize?: number;
 };
-declare const apiClientVersion = "5.10.2";
+declare const apiClientVersion = "5.12.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3160,9 +3164,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param saveObjects - The `saveObjects` object.
      * @param saveObjects.indexName - The `indexName` to save `objects` in.
      * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
+     * @param saveObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
-    saveObjects({ indexName, objects }: SaveObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
+    saveObjects({ indexName, objects, waitForTasks }: SaveObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
     /**
      * Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
      *
@@ -3170,9 +3175,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param deleteObjects - The `deleteObjects` object.
      * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
      * @param deleteObjects.objectIDs - The objectIDs to delete.
+     * @param deleteObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
-    deleteObjects({ indexName, objectIDs }: DeleteObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
+    deleteObjects({ indexName, objectIDs, waitForTasks }: DeleteObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
     /**
      * Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
      *
@@ -3181,9 +3187,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
      * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
      * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
+     * @param partialUpdateObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
-    partialUpdateObjects({ indexName, objects, createIfNotExists }: PartialUpdateObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
+    partialUpdateObjects({ indexName, objects, createIfNotExists, waitForTasks }: PartialUpdateObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
     /**
      * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.

package/dist/builds/browser.js CHANGED Viewed

@@ -19,7 +19,7 @@ import {
   getAlgoliaAgent,
   shuffle
 } from "@algolia/client-common";
-var apiClientVersion = "5.10.2";
+var apiClientVersion = "5.12.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -375,10 +375,11 @@ function createSearchClient({
      * @param saveObjects - The `saveObjects` object.
      * @param saveObjects.indexName - The `indexName` to save `objects` in.
      * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
+     * @param saveObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
-    async saveObjects({ indexName, objects }, requestOptions) {
-      return await this.chunkedBatch({ indexName, objects, action: "addObject" }, requestOptions);
+    async saveObjects({ indexName, objects, waitForTasks }, requestOptions) {
+      return await this.chunkedBatch({ indexName, objects, action: "addObject", waitForTasks }, requestOptions);
     },
     /**
      * Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
@@ -387,14 +388,16 @@ function createSearchClient({
      * @param deleteObjects - The `deleteObjects` object.
      * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
      * @param deleteObjects.objectIDs - The objectIDs to delete.
+     * @param deleteObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
-    async deleteObjects({ indexName, objectIDs }, requestOptions) {
+    async deleteObjects({ indexName, objectIDs, waitForTasks }, requestOptions) {
       return await this.chunkedBatch(
         {
           indexName,
           objects: objectIDs.map((objectID) => ({ objectID })),
-          action: "deleteObject"
+          action: "deleteObject",
+          waitForTasks
         },
         requestOptions
       );
@@ -407,14 +410,16 @@ function createSearchClient({
      * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
      * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
      * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
+     * @param partialUpdateObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
-    async partialUpdateObjects({ indexName, objects, createIfNotExists }, requestOptions) {
+    async partialUpdateObjects({ indexName, objects, createIfNotExists, waitForTasks }, requestOptions) {
       return await this.chunkedBatch(
         {
           indexName,
           objects,
-          action: createIfNotExists ? "partialUpdateObject" : "partialUpdateObjectNoCreate"
+          action: createIfNotExists ? "partialUpdateObject" : "partialUpdateObjectNoCreate",
+          waitForTasks
         },
         requestOptions
       );