@algolia/ingestion 1.22.0 → 1.23.1

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
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +27 -1
  3. package/dist/builds/browser.js +19 -1
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +19 -1
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +19 -1
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +19 -1
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/builds/worker.js +19 -1
  15. package/dist/builds/worker.js.map +1 -1
  16. package/dist/fetch.d.ts +27 -1
  17. package/dist/node.d.cts +27 -1
  18. package/dist/node.d.ts +27 -1
  19. package/dist/src/ingestionClient.cjs +19 -1
  20. package/dist/src/ingestionClient.cjs.map +1 -1
  21. package/dist/src/ingestionClient.js +19 -1
  22. package/dist/src/ingestionClient.js.map +1 -1
  23. package/dist/worker.d.ts +27 -1
  24. package/package.json +7 -7
package/README.md CHANGED
@@ -41,11 +41,11 @@ All of our clients comes with type definition, and are available for both browse
41
41
  ### With a package manager
42
42
 
43
43
  ```bash
44
- yarn add @algolia/ingestion@1.22.0
44
+ yarn add @algolia/ingestion@1.23.1
45
45
  # or
46
- npm install @algolia/ingestion@1.22.0
46
+ npm install @algolia/ingestion@1.23.1
47
47
  # or
48
- pnpm add @algolia/ingestion@1.22.0
48
+ pnpm add @algolia/ingestion@1.23.1
49
49
  ```
50
50
 
51
51
  ### Without a package manager
@@ -53,7 +53,7 @@ pnpm add @algolia/ingestion@1.22.0
53
53
  Add the following JavaScript snippet to the <head> of your website:
54
54
 
55
55
  ```html
56
- <script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.22.0/dist/builds/browser.umd.js"></script>
56
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.23.1/dist/builds/browser.umd.js"></script>
57
57
  ```
58
58
 
59
59
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -609,6 +609,10 @@ type SourceCommercetools = {
609
609
  * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
610
610
  */
611
611
  fallbackIsInStockValue?: boolean;
612
+ /**
613
+ * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
614
+ */
615
+ productQueryPredicate?: string;
612
616
  customFields?: CommercetoolsCustomFields;
613
617
  };
614
618
 
@@ -1550,6 +1554,10 @@ type SourceUpdateCommercetools = {
1550
1554
  * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
1551
1555
  */
1552
1556
  fallbackIsInStockValue?: boolean;
1557
+ /**
1558
+ * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
1559
+ */
1560
+ productQueryPredicate?: string;
1553
1561
  customFields?: CommercetoolsCustomFields;
1554
1562
  };
1555
1563
 
@@ -2301,7 +2309,7 @@ type ValidateSourceBeforeUpdateProps = {
2301
2309
  sourceUpdate: SourceUpdate;
2302
2310
  };
2303
2311
 
2304
- declare const apiClientVersion = "1.22.0";
2312
+ declare const apiClientVersion = "1.23.1";
2305
2313
  declare const REGIONS: readonly ["eu", "us"];
2306
2314
  type Region = (typeof REGIONS)[number];
2307
2315
  type RegionOptions = {
@@ -2403,6 +2411,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2403
2411
  createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
2404
2412
  /**
2405
2413
  * Creates a new task using the v1 endpoint, please use `createTask` instead.
2414
+ *
2415
+ * @deprecated
2406
2416
  * @param taskCreate - Request body for creating a task.
2407
2417
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2408
2418
  */
@@ -2492,6 +2502,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2492
2502
  deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2493
2503
  /**
2494
2504
  * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
2505
+ *
2506
+ * @deprecated
2495
2507
  * @param deleteTaskV1 - The deleteTaskV1 object.
2496
2508
  * @param deleteTaskV1.taskID - Unique identifier of a task.
2497
2509
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2523,6 +2535,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2523
2535
  * - addObject
2524
2536
  * - deleteIndex
2525
2537
  * - editSettings
2538
+ *
2539
+ * @deprecated
2526
2540
  * @param disableTaskV1 - The disableTaskV1 object.
2527
2541
  * @param disableTaskV1.taskID - Unique identifier of a task.
2528
2542
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2547,6 +2561,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2547
2561
  * - addObject
2548
2562
  * - deleteIndex
2549
2563
  * - editSettings
2564
+ *
2565
+ * @deprecated
2550
2566
  * @param enableTaskV1 - The enableTaskV1 object.
2551
2567
  * @param enableTaskV1.taskID - Unique identifier of a task.
2552
2568
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2632,6 +2648,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2632
2648
  * - addObject
2633
2649
  * - deleteIndex
2634
2650
  * - editSettings
2651
+ *
2652
+ * @deprecated
2635
2653
  * @param getTaskV1 - The getTaskV1 object.
2636
2654
  * @param getTaskV1.taskID - Unique identifier of a task.
2637
2655
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2770,6 +2788,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2770
2788
  * - addObject
2771
2789
  * - deleteIndex
2772
2790
  * - editSettings
2791
+ *
2792
+ * @deprecated
2773
2793
  * @param listTasksV1 - The listTasksV1 object.
2774
2794
  * @param listTasksV1.itemsPerPage - Number of items per page.
2775
2795
  * @param listTasksV1.page - Page number of the paginated API response.
@@ -2844,6 +2864,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2844
2864
  * - addObject
2845
2865
  * - deleteIndex
2846
2866
  * - editSettings
2867
+ *
2868
+ * @deprecated
2847
2869
  * @param runTaskV1 - The runTaskV1 object.
2848
2870
  * @param runTaskV1.taskID - Unique identifier of a task.
2849
2871
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2900,6 +2922,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2900
2922
  * - addObject
2901
2923
  * - deleteIndex
2902
2924
  * - editSettings
2925
+ *
2926
+ * @deprecated
2903
2927
  * @param taskSearch - The taskSearch object.
2904
2928
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2905
2929
  */
@@ -3000,6 +3024,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3000
3024
  updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
3001
3025
  /**
3002
3026
  * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
3027
+ *
3028
+ * @deprecated
3003
3029
  * @param updateTaskV1 - The updateTaskV1 object.
3004
3030
  * @param updateTaskV1.taskID - Unique identifier of a task.
3005
3031
  * @param updateTaskV1.taskUpdate - The taskUpdate object.
package/dist/builds/browser.js CHANGED
@@ -9,7 +9,7 @@ import {
9
9
 
10
10
  // src/ingestionClient.ts
11
11
  import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
12
- var apiClientVersion = "1.22.0";
12
+ var apiClientVersion = "1.23.1";
13
13
  var REGIONS = ["eu", "us"];
14
14
  function getDefaultHosts(region) {
15
15
  const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -229,6 +229,8 @@ function createIngestionClient({
229
229
  },
230
230
  /**
231
231
  * Creates a new task using the v1 endpoint, please use `createTask` instead.
232
+ *
233
+ * @deprecated
232
234
  * @param taskCreate - Request body for creating a task.
233
235
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
234
236
  */
@@ -486,6 +488,8 @@ function createIngestionClient({
486
488
  },
487
489
  /**
488
490
  * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
491
+ *
492
+ * @deprecated
489
493
  * @param deleteTaskV1 - The deleteTaskV1 object.
490
494
  * @param deleteTaskV1.taskID - Unique identifier of a task.
491
495
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -562,6 +566,8 @@ function createIngestionClient({
562
566
  * - addObject
563
567
  * - deleteIndex
564
568
  * - editSettings
569
+ *
570
+ * @deprecated
565
571
  * @param disableTaskV1 - The disableTaskV1 object.
566
572
  * @param disableTaskV1.taskID - Unique identifier of a task.
567
573
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -614,6 +620,8 @@ function createIngestionClient({
614
620
  * - addObject
615
621
  * - deleteIndex
616
622
  * - editSettings
623
+ *
624
+ * @deprecated
617
625
  * @param enableTaskV1 - The enableTaskV1 object.
618
626
  * @param enableTaskV1.taskID - Unique identifier of a task.
619
627
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -806,6 +814,8 @@ function createIngestionClient({
806
814
  * - addObject
807
815
  * - deleteIndex
808
816
  * - editSettings
817
+ *
818
+ * @deprecated
809
819
  * @param getTaskV1 - The getTaskV1 object.
810
820
  * @param getTaskV1.taskID - Unique identifier of a task.
811
821
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1197,6 +1207,8 @@ function createIngestionClient({
1197
1207
  * - addObject
1198
1208
  * - deleteIndex
1199
1209
  * - editSettings
1210
+ *
1211
+ * @deprecated
1200
1212
  * @param listTasksV1 - The listTasksV1 object.
1201
1213
  * @param listTasksV1.itemsPerPage - Number of items per page.
1202
1214
  * @param listTasksV1.page - Page number of the paginated API response.
@@ -1396,6 +1408,8 @@ function createIngestionClient({
1396
1408
  * - addObject
1397
1409
  * - deleteIndex
1398
1410
  * - editSettings
1411
+ *
1412
+ * @deprecated
1399
1413
  * @param runTaskV1 - The runTaskV1 object.
1400
1414
  * @param runTaskV1.taskID - Unique identifier of a task.
1401
1415
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1540,6 +1554,8 @@ function createIngestionClient({
1540
1554
  * - addObject
1541
1555
  * - deleteIndex
1542
1556
  * - editSettings
1557
+ *
1558
+ * @deprecated
1543
1559
  * @param taskSearch - The taskSearch object.
1544
1560
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1545
1561
  */
@@ -1828,6 +1844,8 @@ function createIngestionClient({
1828
1844
  },
1829
1845
  /**
1830
1846
  * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
1847
+ *
1848
+ * @deprecated
1831
1849
  * @param updateTaskV1 - The updateTaskV1 object.
1832
1850
  * @param updateTaskV1.taskID - Unique identifier of a task.
1833
1851
  * @param updateTaskV1.taskUpdate - The taskUpdate object.