@algolia/ingestion 1.40.0 → 1.41.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.
- package/README.md +8 -9
- package/dist/browser.d.ts +32 -3
- package/dist/builds/browser.js +1 -1
- 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 +1 -1
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +1 -1
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +1 -1
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +1 -1
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +32 -3
- package/dist/node.d.cts +32 -3
- package/dist/node.d.ts +32 -3
- package/dist/src/ingestionClient.cjs +1 -1
- package/dist/src/ingestionClient.cjs.map +1 -1
- package/dist/src/ingestionClient.js +1 -1
- package/dist/src/ingestionClient.js.map +1 -1
- package/dist/worker.d.ts +32 -3
- package/package.json +8 -8
package/dist/fetch.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
|
/**
|
|
@@ -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.
|
|
2489
|
+
declare const apiClientVersion = "1.41.0";
|
|
2461
2490
|
declare const REGIONS: readonly ["eu", "us"];
|
|
2462
2491
|
type Region = (typeof REGIONS)[number];
|
|
2463
2492
|
type RegionOptions = {
|
package/dist/node.d.cts
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
|
/**
|
|
@@ -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.
|
|
2489
|
+
declare const apiClientVersion = "1.41.0";
|
|
2461
2490
|
declare const REGIONS: readonly ["eu", "us"];
|
|
2462
2491
|
type Region = (typeof REGIONS)[number];
|
|
2463
2492
|
type RegionOptions = {
|
package/dist/node.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
|
/**
|
|
@@ -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.
|
|
2489
|
+
declare const apiClientVersion = "1.41.0";
|
|
2461
2490
|
declare const REGIONS: readonly ["eu", "us"];
|
|
2462
2491
|
type Region = (typeof REGIONS)[number];
|
|
2463
2492
|
type RegionOptions = {
|
|
@@ -29,7 +29,7 @@ __export(ingestionClient_exports, {
|
|
|
29
29
|
});
|
|
30
30
|
module.exports = __toCommonJS(ingestionClient_exports);
|
|
31
31
|
var import_client_common = require("@algolia/client-common");
|
|
32
|
-
var apiClientVersion = "1.
|
|
32
|
+
var apiClientVersion = "1.41.0";
|
|
33
33
|
var REGIONS = ["eu", "us"];
|
|
34
34
|
function getDefaultHosts(region) {
|
|
35
35
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|