@algolia/ingestion 1.39.0 → 1.40.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 +8 -9
  2. package/dist/browser.d.ts +3 -3
  3. package/dist/builds/browser.js +2 -2
  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 +2 -2
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +2 -2
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +2 -2
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/builds/worker.js +2 -2
  15. package/dist/builds/worker.js.map +1 -1
  16. package/dist/fetch.d.ts +3 -3
  17. package/dist/node.d.cts +3 -3
  18. package/dist/node.d.ts +3 -3
  19. package/dist/src/ingestionClient.cjs +2 -2
  20. package/dist/src/ingestionClient.cjs.map +1 -1
  21. package/dist/src/ingestionClient.js +2 -2
  22. package/dist/src/ingestionClient.js.map +1 -1
  23. package/dist/worker.d.ts +3 -3
  24. package/package.json +9 -9
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
  <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
7
7
 
8
8
  <p align="center">
9
- <a href="https://npmjs.org/package/@algolia/ingestion"><img src="https://img.shields.io/npm/v/@algolia/ingestion.svg?style=flat-square" alt="NPM version"></img></a>
9
+ <a href="https://npmjs.com/package/@algolia/ingestion"><img src="https://img.shields.io/npm/v/@algolia/ingestion.svg?style=flat-square" alt="NPM version"></img></a>
10
10
  <a href="http://npm-stat.com/charts.html?package=@algolia/ingestion"><img src="https://img.shields.io/npm/dm/@algolia/ingestion.svg?style=flat-square" alt="NPM downloads"></a>
11
11
  <a href="https://www.jsdelivr.com/package/npm/@algolia/ingestion"><img src="https://data.jsdelivr.com/v1/package/npm/@algolia/ingestion/badge" alt="jsDelivr Downloads"></img></a>
12
12
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
@@ -14,12 +14,11 @@
14
14
  </p>
15
15
 
16
16
  <p align="center">
17
- <a href="https://www.algolia.com/doc/libraries/javascript/" target="_blank">Documentation</a> •
17
+ <a href="https://www.algolia.com/doc/libraries/sdk/install#javascript" target="_blank">Documentation</a> •
18
18
  <a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a> •
19
19
  <a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
20
20
  <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
21
21
  <a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a> •
22
- <a href="https://www.algolia.com/doc/libraries/javascript/v5/" target="_blank">FAQ</a> •
23
22
  <a href="https://alg.li/support" target="_blank">Support</a>
24
23
  </p>
25
24
 
@@ -41,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
41
40
  ### With a package manager
42
41
 
43
42
  ```bash
44
- yarn add @algolia/ingestion@1.39.0
43
+ yarn add @algolia/ingestion@1.40.1
45
44
  # or
46
- npm install @algolia/ingestion@1.39.0
45
+ npm install @algolia/ingestion@1.40.1
47
46
  # or
48
- pnpm add @algolia/ingestion@1.39.0
47
+ pnpm add @algolia/ingestion@1.40.1
49
48
  ```
50
49
 
51
50
  ### Without a package manager
@@ -53,7 +52,7 @@ pnpm add @algolia/ingestion@1.39.0
53
52
  Add the following JavaScript snippet to the <head> of your website:
54
53
 
55
54
  ```html
56
- <script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.39.0/dist/builds/browser.umd.js"></script>
55
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.40.1/dist/builds/browser.umd.js"></script>
57
56
  ```
58
57
 
59
58
  ### Usage
@@ -66,11 +65,11 @@ import { ingestionClient } from '@algolia/ingestion';
66
65
  const client = ingestionClient('YOUR_APP_ID', 'YOUR_API_KEY');
67
66
  ```
68
67
 
69
- For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/ingestion/)**.
68
+ For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/sdk/methods/ingestion/)**.
70
69
 
71
70
  ## ❓ Troubleshooting
72
71
 
73
- Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/libraries/javascript/v5/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
72
+ Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://support.algolia.com/hc/en-us/sections/15061037630609-API-Client-FAQs) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
74
73
 
75
74
  ## 📄 License
76
75
 
package/dist/browser.d.ts CHANGED
@@ -407,7 +407,7 @@ type EventStatus = 'created' | 'started' | 'retried' | 'failed' | 'succeeded' |
407
407
  type EventType = 'fetch' | 'record' | 'log' | 'transform';
408
408
 
409
409
  /**
410
- * An event describe a step of the task execution flow..
410
+ * An event describe a step of the task execution flow.
411
411
  */
412
412
  type Event = {
413
413
  /**
@@ -2457,7 +2457,7 @@ type ChunkedPushOptions = {
2457
2457
  objects: Array<Record<string, unknown>>;
2458
2458
  };
2459
2459
 
2460
- declare const apiClientVersion = "1.39.0";
2460
+ declare const apiClientVersion = "1.40.1";
2461
2461
  declare const REGIONS: readonly ["eu", "us"];
2462
2462
  type Region = (typeof REGIONS)[number];
2463
2463
  type RegionOptions = {
@@ -2982,7 +2982,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2982
2982
  */
2983
2983
  listTransformations({ itemsPerPage, page, sort, order, type }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
2984
2984
  /**
2985
- * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
2985
+ * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
2986
2986
  *
2987
2987
  * Required API Key ACLs:
2988
2988
  * - addObject
package/dist/builds/browser.js CHANGED
@@ -9,7 +9,7 @@ import {
9
9
 
10
10
  // src/ingestionClient.ts
11
11
  import { createAuth, createIterablePromise, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
12
- var apiClientVersion = "1.39.0";
12
+ var apiClientVersion = "1.40.1";
13
13
  var REGIONS = ["eu", "us"];
14
14
  function getDefaultHosts(region) {
15
15
  const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -1366,7 +1366,7 @@ function createIngestionClient({
1366
1366
  return transporter.request(request, requestOptions);
1367
1367
  },
1368
1368
  /**
1369
- * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
1369
+ * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
1370
1370
  *
1371
1371
  * Required API Key ACLs:
1372
1372
  * - addObject