@algolia/ingestion 1.40.1 → 1.42.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
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +81 -2
  3. package/dist/builds/browser.js +51 -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 +51 -1
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +51 -1
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +51 -1
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/builds/worker.js +51 -1
  15. package/dist/builds/worker.js.map +1 -1
  16. package/dist/fetch.d.ts +81 -2
  17. package/dist/node.d.cts +81 -2
  18. package/dist/node.d.ts +81 -2
  19. package/dist/src/ingestionClient.cjs +51 -1
  20. package/dist/src/ingestionClient.cjs.map +1 -1
  21. package/dist/src/ingestionClient.js +51 -1
  22. package/dist/src/ingestionClient.js.map +1 -1
  23. package/dist/worker.d.ts +81 -2
  24. package/package.json +8 -8
package/README.md CHANGED
@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
40
40
  ### With a package manager
41
41
 
42
42
  ```bash
43
- yarn add @algolia/ingestion@1.40.1
43
+ yarn add @algolia/ingestion@1.42.0
44
44
  # or
45
- npm install @algolia/ingestion@1.40.1
45
+ npm install @algolia/ingestion@1.42.0
46
46
  # or
47
- pnpm add @algolia/ingestion@1.40.1
47
+ pnpm add @algolia/ingestion@1.42.0
48
48
  ```
49
49
 
50
50
  ### Without a package manager
@@ -52,7 +52,7 @@ pnpm add @algolia/ingestion@1.40.1
52
52
  Add the following JavaScript snippet to the <head> of your website:
53
53
 
54
54
  ```html
55
- <script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.40.1/dist/builds/browser.umd.js"></script>
55
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.42.0/dist/builds/browser.umd.js"></script>
56
56
  ```
57
57
 
58
58
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -507,6 +507,9 @@ type BigCommerceMetafield = {
507
507
  key: string;
508
508
  };
509
509
 
510
+ /**
511
+ * Specific configuration attributes of a `bigcommerce` source.
512
+ */
510
513
  type SourceBigCommerce = {
511
514
  /**
512
515
  * Store hash identifying your BigCommerce store.
@@ -520,6 +523,9 @@ type SourceBigCommerce = {
520
523
 
521
524
  type BigQueryDataType = 'ga4' | 'ga360';
522
525
 
526
+ /**
527
+ * Specific configuration attributes of a `bigquery` source.
528
+ */
523
529
  type SourceBigQuery = {
524
530
  /**
525
531
  * Project ID of the BigQuery source.
@@ -555,6 +561,9 @@ type MappingTypeCSV = 'string' | 'integer' | 'float' | 'boolean' | 'json';
555
561
  */
556
562
  type MethodType = 'GET' | 'POST';
557
563
 
564
+ /**
565
+ * Specific configuration attributes of a `csv` source.
566
+ */
558
567
  type SourceCSV = {
559
568
  /**
560
569
  * URL of the file.
@@ -595,6 +604,9 @@ type CommercetoolsCustomFields = {
595
604
  category?: Array<string> | null | undefined;
596
605
  };
597
606
 
607
+ /**
608
+ * Specific configuration attributes of a `commercetools` source.
609
+ */
598
610
  type SourceCommercetools = {
599
611
  storeKeys?: Array<string> | undefined;
600
612
  /**
@@ -614,6 +626,9 @@ type SourceCommercetools = {
614
626
  customFields?: CommercetoolsCustomFields | undefined;
615
627
  };
616
628
 
629
+ /**
630
+ * Specific configuration attributes of a `docker` source.
631
+ */
617
632
  type SourceDocker = {
618
633
  /**
619
634
  * Name of the connector.
@@ -625,6 +640,9 @@ type SourceDocker = {
625
640
  configuration: Record<string, unknown>;
626
641
  };
627
642
 
643
+ /**
644
+ * Specific configuration attributes of a `ga4BigqueryExport` source.
645
+ */
628
646
  type SourceGA4BigQueryExport = {
629
647
  /**
630
648
  * GCP project ID that the BigQuery export writes to.
@@ -640,6 +658,9 @@ type SourceGA4BigQueryExport = {
640
658
  tablePrefix: string;
641
659
  };
642
660
 
661
+ /**
662
+ * Specific configuration attributes of a `json` source.
663
+ */
643
664
  type SourceJSON = {
644
665
  /**
645
666
  * URL of the file.
@@ -659,6 +680,9 @@ type SourceShopifyBase = {
659
680
  shopURL: string;
660
681
  };
661
682
 
683
+ /**
684
+ * Specific configuration attributes of a `shopify` source.
685
+ */
662
686
  type SourceUpdateShopify = {
663
687
  /**
664
688
  * Feature flags for the Shopify source.
@@ -1496,7 +1520,6 @@ type AuthenticationUpdate = {
1496
1520
  * Descriptive name for the resource.
1497
1521
  */
1498
1522
  name?: string | undefined;
1499
- platform?: Platform | null | undefined;
1500
1523
  input?: AuthInputPartial | undefined;
1501
1524
  };
1502
1525
 
@@ -1597,6 +1620,9 @@ type RunTaskPayload = {
1597
1620
  */
1598
1621
  type SourceSortKeys = 'name' | 'type' | 'updatedAt' | 'createdAt';
1599
1622
 
1623
+ /**
1624
+ * Specific configuration attributes of a `commercetools` source.
1625
+ */
1600
1626
  type SourceUpdateCommercetools = {
1601
1627
  storeKeys?: Array<string> | undefined;
1602
1628
  /**
@@ -1615,6 +1641,9 @@ type SourceUpdateCommercetools = {
1615
1641
  customFields?: CommercetoolsCustomFields | undefined;
1616
1642
  };
1617
1643
 
1644
+ /**
1645
+ * Specific configuration attributes of a `docker` source.
1646
+ */
1618
1647
  type SourceUpdateDocker = {
1619
1648
  /**
1620
1649
  * Configuration of the spec.
@@ -2457,7 +2486,7 @@ type ChunkedPushOptions = {
2457
2486
  objects: Array<Record<string, unknown>>;
2458
2487
  };
2459
2488
 
2460
- declare const apiClientVersion = "1.40.1";
2489
+ declare const apiClientVersion = "1.42.0";
2461
2490
  declare const REGIONS: readonly ["eu", "us"];
2462
2491
  type Region = (typeof REGIONS)[number];
2463
2492
  type RegionOptions = {
@@ -2567,6 +2596,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2567
2596
  createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
2568
2597
  /**
2569
2598
  * Creates a new task.
2599
+ *
2600
+ * Required API Key ACLs:
2601
+ * - addObject
2602
+ * - deleteIndex
2603
+ * - editSettings
2570
2604
  * @param taskCreate - Request body for creating a task.
2571
2605
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2572
2606
  */
@@ -2574,6 +2608,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2574
2608
  /**
2575
2609
  * Creates a new task using the v1 endpoint, please use `createTask` instead.
2576
2610
  *
2611
+ * Required API Key ACLs:
2612
+ * - addObject
2613
+ * - deleteIndex
2614
+ * - editSettings
2615
+ *
2577
2616
  * @deprecated
2578
2617
  * @param taskCreate - Request body for creating a task.
2579
2618
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2581,6 +2620,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2581
2620
  createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
2582
2621
  /**
2583
2622
  * Creates a new transformation.
2623
+ *
2624
+ * Required API Key ACLs:
2625
+ * - addObject
2626
+ * - deleteIndex
2627
+ * - editSettings
2584
2628
  * @param transformationCreate - Request body for creating a transformation.
2585
2629
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2586
2630
  */
@@ -2657,6 +2701,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2657
2701
  deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2658
2702
  /**
2659
2703
  * Deletes a task by its ID.
2704
+ *
2705
+ * Required API Key ACLs:
2706
+ * - addObject
2707
+ * - deleteIndex
2708
+ * - editSettings
2660
2709
  * @param deleteTask - The deleteTask object.
2661
2710
  * @param deleteTask.taskID - Unique identifier of a task.
2662
2711
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2665,6 +2714,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2665
2714
  /**
2666
2715
  * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
2667
2716
  *
2717
+ * Required API Key ACLs:
2718
+ * - addObject
2719
+ * - deleteIndex
2720
+ * - editSettings
2721
+ *
2668
2722
  * @deprecated
2669
2723
  * @param deleteTaskV1 - The deleteTaskV1 object.
2670
2724
  * @param deleteTaskV1.taskID - Unique identifier of a task.
@@ -2673,6 +2727,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2673
2727
  deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2674
2728
  /**
2675
2729
  * Deletes a transformation by its ID.
2730
+ *
2731
+ * Required API Key ACLs:
2732
+ * - addObject
2733
+ * - deleteIndex
2734
+ * - editSettings
2676
2735
  * @param deleteTransformation - The deleteTransformation object.
2677
2736
  * @param deleteTransformation.transformationID - Unique identifier of a transformation.
2678
2737
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3012,6 +3071,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3012
3071
  pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
3013
3072
  /**
3014
3073
  * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
3074
+ *
3075
+ * Required API Key ACLs:
3076
+ * - addObject
3077
+ * - deleteIndex
3078
+ * - editSettings
3015
3079
  * @param replaceTask - The replaceTask object.
3016
3080
  * @param replaceTask.taskID - Unique identifier of a task.
3017
3081
  * @param replaceTask.taskReplace - The taskReplace object.
@@ -3204,6 +3268,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3204
3268
  updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
3205
3269
  /**
3206
3270
  * Partially updates a task by its ID.
3271
+ *
3272
+ * Required API Key ACLs:
3273
+ * - addObject
3274
+ * - deleteIndex
3275
+ * - editSettings
3207
3276
  * @param updateTask - The updateTask object.
3208
3277
  * @param updateTask.taskID - Unique identifier of a task.
3209
3278
  * @param updateTask.taskUpdate - The taskUpdate object.
@@ -3213,6 +3282,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3213
3282
  /**
3214
3283
  * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
3215
3284
  *
3285
+ * Required API Key ACLs:
3286
+ * - addObject
3287
+ * - deleteIndex
3288
+ * - editSettings
3289
+ *
3216
3290
  * @deprecated
3217
3291
  * @param updateTaskV1 - The updateTaskV1 object.
3218
3292
  * @param updateTaskV1.taskID - Unique identifier of a task.
@@ -3222,6 +3296,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3222
3296
  updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
3223
3297
  /**
3224
3298
  * Updates a transformation by its ID.
3299
+ *
3300
+ * Required API Key ACLs:
3301
+ * - addObject
3302
+ * - deleteIndex
3303
+ * - editSettings
3225
3304
  * @param updateTransformation - The updateTransformation object.
3226
3305
  * @param updateTransformation.transformationID - Unique identifier of a transformation.
3227
3306
  * @param updateTransformation.transformationCreate - The transformationCreate object.
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.40.1";
12
+ var apiClientVersion = "1.42.0";
13
13
  var REGIONS = ["eu", "us"];
14
14
  function getDefaultHosts(region) {
15
15
  const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -265,6 +265,11 @@ function createIngestionClient({
265
265
  },
266
266
  /**
267
267
  * Creates a new task.
268
+ *
269
+ * Required API Key ACLs:
270
+ * - addObject
271
+ * - deleteIndex
272
+ * - editSettings
268
273
  * @param taskCreate - Request body for creating a task.
269
274
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
270
275
  */
@@ -296,6 +301,11 @@ function createIngestionClient({
296
301
  /**
297
302
  * Creates a new task using the v1 endpoint, please use `createTask` instead.
298
303
  *
304
+ * Required API Key ACLs:
305
+ * - addObject
306
+ * - deleteIndex
307
+ * - editSettings
308
+ *
299
309
  * @deprecated
300
310
  * @param taskCreate - Request body for creating a task.
301
311
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -330,6 +340,11 @@ function createIngestionClient({
330
340
  },
331
341
  /**
332
342
  * Creates a new transformation.
343
+ *
344
+ * Required API Key ACLs:
345
+ * - addObject
346
+ * - deleteIndex
347
+ * - editSettings
333
348
  * @param transformationCreate - Request body for creating a transformation.
334
349
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
335
350
  */
@@ -530,6 +545,11 @@ function createIngestionClient({
530
545
  },
531
546
  /**
532
547
  * Deletes a task by its ID.
548
+ *
549
+ * Required API Key ACLs:
550
+ * - addObject
551
+ * - deleteIndex
552
+ * - editSettings
533
553
  * @param deleteTask - The deleteTask object.
534
554
  * @param deleteTask.taskID - Unique identifier of a task.
535
555
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -552,6 +572,11 @@ function createIngestionClient({
552
572
  /**
553
573
  * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
554
574
  *
575
+ * Required API Key ACLs:
576
+ * - addObject
577
+ * - deleteIndex
578
+ * - editSettings
579
+ *
555
580
  * @deprecated
556
581
  * @param deleteTaskV1 - The deleteTaskV1 object.
557
582
  * @param deleteTaskV1.taskID - Unique identifier of a task.
@@ -574,6 +599,11 @@ function createIngestionClient({
574
599
  },
575
600
  /**
576
601
  * Deletes a transformation by its ID.
602
+ *
603
+ * Required API Key ACLs:
604
+ * - addObject
605
+ * - deleteIndex
606
+ * - editSettings
577
607
  * @param deleteTransformation - The deleteTransformation object.
578
608
  * @param deleteTransformation.transformationID - Unique identifier of a transformation.
579
609
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1469,6 +1499,11 @@ function createIngestionClient({
1469
1499
  },
1470
1500
  /**
1471
1501
  * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
1502
+ *
1503
+ * Required API Key ACLs:
1504
+ * - addObject
1505
+ * - deleteIndex
1506
+ * - editSettings
1472
1507
  * @param replaceTask - The replaceTask object.
1473
1508
  * @param replaceTask.taskID - Unique identifier of a task.
1474
1509
  * @param replaceTask.taskReplace - The taskReplace object.
@@ -1968,6 +2003,11 @@ function createIngestionClient({
1968
2003
  },
1969
2004
  /**
1970
2005
  * Partially updates a task by its ID.
2006
+ *
2007
+ * Required API Key ACLs:
2008
+ * - addObject
2009
+ * - deleteIndex
2010
+ * - editSettings
1971
2011
  * @param updateTask - The updateTask object.
1972
2012
  * @param updateTask.taskID - Unique identifier of a task.
1973
2013
  * @param updateTask.taskUpdate - The taskUpdate object.
@@ -1995,6 +2035,11 @@ function createIngestionClient({
1995
2035
  /**
1996
2036
  * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
1997
2037
  *
2038
+ * Required API Key ACLs:
2039
+ * - addObject
2040
+ * - deleteIndex
2041
+ * - editSettings
2042
+ *
1998
2043
  * @deprecated
1999
2044
  * @param updateTaskV1 - The updateTaskV1 object.
2000
2045
  * @param updateTaskV1.taskID - Unique identifier of a task.
@@ -2022,6 +2067,11 @@ function createIngestionClient({
2022
2067
  },
2023
2068
  /**
2024
2069
  * Updates a transformation by its ID.
2070
+ *
2071
+ * Required API Key ACLs:
2072
+ * - addObject
2073
+ * - deleteIndex
2074
+ * - editSettings
2025
2075
  * @param updateTransformation - The updateTransformation object.
2026
2076
  * @param updateTransformation.transformationID - Unique identifier of a transformation.
2027
2077
  * @param updateTransformation.transformationCreate - The transformationCreate object.