@algolia/ingestion 1.16.0 → 1.17.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.
- package/README.md +4 -4
- package/dist/browser.d.ts +30 -25
- package/dist/builds/browser.js +6 -2
- 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 +6 -2
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +6 -2
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +6 -2
- package/dist/builds/node.js.map +1 -1
- package/dist/fetch.d.ts +30 -25
- package/dist/node.d.cts +30 -25
- package/dist/node.d.ts +30 -25
- package/dist/src/ingestionClient.cjs +6 -2
- package/dist/src/ingestionClient.cjs.map +1 -1
- package/dist/src/ingestionClient.js +6 -2
- package/dist/src/ingestionClient.js.map +1 -1
- package/package.json +5 -5
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.
|
|
44
|
+
yarn add @algolia/ingestion@1.17.1
|
|
45
45
|
# or
|
|
46
|
-
npm install @algolia/ingestion@1.
|
|
46
|
+
npm install @algolia/ingestion@1.17.1
|
|
47
47
|
# or
|
|
48
|
-
pnpm add @algolia/ingestion@1.
|
|
48
|
+
pnpm add @algolia/ingestion@1.17.1
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
### Without a package manager
|
|
@@ -53,7 +53,7 @@ pnpm add @algolia/ingestion@1.16.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.
|
|
56
|
+
<script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.17.1/dist/builds/browser.umd.js"></script>
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
### Usage
|
package/dist/browser.d.ts
CHANGED
|
@@ -1178,25 +1178,6 @@ type SourceUpdateResponse = {
|
|
|
1178
1178
|
updatedAt: string;
|
|
1179
1179
|
};
|
|
1180
1180
|
|
|
1181
|
-
type SourceWatchResponse = {
|
|
1182
|
-
/**
|
|
1183
|
-
* Universally unique identifier (UUID) of a task run.
|
|
1184
|
-
*/
|
|
1185
|
-
runID?: string;
|
|
1186
|
-
/**
|
|
1187
|
-
* depending on the source type, the validation returns sampling data of your source (JSON, CSV, BigQuery).
|
|
1188
|
-
*/
|
|
1189
|
-
data?: Array<Record<string, unknown>>;
|
|
1190
|
-
/**
|
|
1191
|
-
* in case of error, observability events will be added to the response, if any.
|
|
1192
|
-
*/
|
|
1193
|
-
events?: Array<Event>;
|
|
1194
|
-
/**
|
|
1195
|
-
* a message describing the outcome of a validate run.
|
|
1196
|
-
*/
|
|
1197
|
-
message: string;
|
|
1198
|
-
};
|
|
1199
|
-
|
|
1200
1181
|
/**
|
|
1201
1182
|
* API request body for creating a task.
|
|
1202
1183
|
*/
|
|
@@ -1398,6 +1379,25 @@ type TransformationUpdateResponse = {
|
|
|
1398
1379
|
updatedAt: string;
|
|
1399
1380
|
};
|
|
1400
1381
|
|
|
1382
|
+
type WatchResponse = {
|
|
1383
|
+
/**
|
|
1384
|
+
* Universally unique identifier (UUID) of a task run.
|
|
1385
|
+
*/
|
|
1386
|
+
runID?: string;
|
|
1387
|
+
/**
|
|
1388
|
+
* when used with discovering or validating sources, the sampled data of your source is returned.
|
|
1389
|
+
*/
|
|
1390
|
+
data?: Array<Record<string, unknown>>;
|
|
1391
|
+
/**
|
|
1392
|
+
* in case of error, observability events will be added to the response, if any.
|
|
1393
|
+
*/
|
|
1394
|
+
events?: Array<Event>;
|
|
1395
|
+
/**
|
|
1396
|
+
* a message describing the outcome of a validate run.
|
|
1397
|
+
*/
|
|
1398
|
+
message: string;
|
|
1399
|
+
};
|
|
1400
|
+
|
|
1401
1401
|
/**
|
|
1402
1402
|
* Property by which to sort the list of authentications.
|
|
1403
1403
|
*/
|
|
@@ -2141,6 +2141,10 @@ type PushTaskProps = {
|
|
|
2141
2141
|
* Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
2142
2142
|
*/
|
|
2143
2143
|
pushTaskPayload: PushTaskPayload;
|
|
2144
|
+
/**
|
|
2145
|
+
* When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
|
|
2146
|
+
*/
|
|
2147
|
+
watch?: boolean;
|
|
2144
2148
|
};
|
|
2145
2149
|
/**
|
|
2146
2150
|
* Properties for the `runSource` method.
|
|
@@ -2263,7 +2267,7 @@ type ValidateSourceBeforeUpdateProps = {
|
|
|
2263
2267
|
sourceUpdate: SourceUpdate;
|
|
2264
2268
|
};
|
|
2265
2269
|
|
|
2266
|
-
declare const apiClientVersion = "1.
|
|
2270
|
+
declare const apiClientVersion = "1.17.1";
|
|
2267
2271
|
declare const REGIONS: readonly ["eu", "us"];
|
|
2268
2272
|
type Region = (typeof REGIONS)[number];
|
|
2269
2273
|
type RegionOptions = {
|
|
@@ -2765,9 +2769,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2765
2769
|
* @param pushTask - The pushTask object.
|
|
2766
2770
|
* @param pushTask.taskID - Unique identifier of a task.
|
|
2767
2771
|
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
2772
|
+
* @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
|
|
2768
2773
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2769
2774
|
*/
|
|
2770
|
-
pushTask({ taskID, pushTaskPayload }: PushTaskProps, requestOptions?: RequestOptions): Promise<
|
|
2775
|
+
pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
|
|
2771
2776
|
/**
|
|
2772
2777
|
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
|
2773
2778
|
*
|
|
@@ -2882,7 +2887,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2882
2887
|
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
2883
2888
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2884
2889
|
*/
|
|
2885
|
-
triggerDockerSourceDiscover({ sourceID }: TriggerDockerSourceDiscoverProps, requestOptions?: RequestOptions): Promise<
|
|
2890
|
+
triggerDockerSourceDiscover({ sourceID }: TriggerDockerSourceDiscoverProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
|
|
2886
2891
|
/**
|
|
2887
2892
|
* Try a transformation before creating it.
|
|
2888
2893
|
*
|
|
@@ -2980,7 +2985,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2980
2985
|
* @param sourceCreate -
|
|
2981
2986
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2982
2987
|
*/
|
|
2983
|
-
validateSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions | undefined): Promise<
|
|
2988
|
+
validateSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions | undefined): Promise<WatchResponse>;
|
|
2984
2989
|
/**
|
|
2985
2990
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
2986
2991
|
*
|
|
@@ -2993,7 +2998,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2993
2998
|
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|
|
2994
2999
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2995
3000
|
*/
|
|
2996
|
-
validateSourceBeforeUpdate({ sourceID, sourceUpdate }: ValidateSourceBeforeUpdateProps, requestOptions?: RequestOptions): Promise<
|
|
3001
|
+
validateSourceBeforeUpdate({ sourceID, sourceUpdate }: ValidateSourceBeforeUpdateProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
|
|
2997
3002
|
};
|
|
2998
3003
|
|
|
2999
3004
|
/**
|
|
@@ -3006,4 +3011,4 @@ type ErrorBase = Record<string, any> & {
|
|
|
3006
3011
|
declare function ingestionClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): IngestionClient;
|
|
3007
3012
|
type IngestionClient = ReturnType<typeof createIngestionClient>;
|
|
3008
3013
|
|
|
3009
|
-
export { type Action, type ActionType, type AuthAPIKey, type AuthAPIKeyPartial, type AuthAlgolia, type AuthAlgoliaInsights, type AuthAlgoliaInsightsPartial, type AuthAlgoliaPartial, type AuthBasic, type AuthBasicPartial, type AuthGoogleServiceAccount, type AuthGoogleServiceAccountPartial, type AuthInput, type AuthInputPartial, type AuthOAuth, type AuthOAuthPartial, type Authentication, type AuthenticationCreate, type AuthenticationCreateResponse, type AuthenticationSearch, type AuthenticationSortKeys, type AuthenticationType, type AuthenticationUpdate, type AuthenticationUpdateResponse, type BigCommerceChannel, type BigCommerceMetafield, type BigQueryDataType, type CommercetoolsCustomFields, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteAuthenticationProps, type DeleteDestinationProps, type DeleteResponse, type DeleteSourceProps, type DeleteTaskProps, type DeleteTaskV1Props, type DeleteTransformationProps, type Destination, type DestinationCreate, type DestinationCreateResponse, type DestinationIndexName, type DestinationInput, type DestinationSearch, type DestinationSortKeys, type DestinationType, type DestinationUpdate, type DestinationUpdateResponse, type DisableTaskProps, type DisableTaskV1Props, type DockerImageType, type DockerRegistry, type DockerStreams, type DockerStreamsInput, type DockerStreamsSyncMode, type EnableTaskProps, type EnableTaskV1Props, type EntityType, type ErrorBase, type Event, type EventSortKeys, type EventStatus, type EventType, type GetAuthenticationProps, type GetDestinationProps, type GetEventProps, type GetRunProps, type GetSourceProps, type GetTaskProps, type GetTaskV1Props, type GetTransformationProps, type IngestionClient, type ListAuthenticationsProps, type ListAuthenticationsResponse, type ListDestinationsProps, type ListDestinationsResponse, type ListEventsProps, type ListEventsResponse, type ListRunsProps, type ListSourcesProps, type ListSourcesResponse, type ListTasksProps, type ListTasksResponse, type ListTasksResponseV1, type ListTasksV1Props, type ListTransformationsProps, type ListTransformationsResponse, type MappingFieldDirective, type MappingFormatSchema, type MappingInput, type MappingKitAction, type MappingTypeCSV, type MethodType, type OnDemandTrigger, type OnDemandTriggerInput, type OnDemandTriggerType, type OrderKeys, type Pagination, type Platform, type PlatformNone, type PlatformWithNone, type PushTaskPayload, type PushTaskProps, type PushTaskRecords, type RecordType, type Region, type RegionOptions, type Run, type RunListResponse, type RunOutcome, type RunProgress, type RunReasonCode, type RunResponse, type RunSortKeys, type RunSourcePayload, type RunSourceProps, type RunSourceResponse, type RunStatus, type RunTaskProps, type RunTaskV1Props, type RunType, type ScheduleTrigger, type ScheduleTriggerInput, type ScheduleTriggerType, type ShopifyInput, type ShopifyMarket, type ShopifyMetafield, type Source, type SourceBigCommerce, type SourceBigQuery, type SourceCSV, type SourceCommercetools, type SourceCreate, type SourceCreateResponse, type SourceDocker, type SourceGA4BigQueryExport, type SourceInput, type SourceJSON, type SourceSearch, type SourceShopify, type SourceShopifyBase, type SourceSortKeys, type SourceType, type SourceUpdate, type SourceUpdateCommercetools, type SourceUpdateDocker, type SourceUpdateInput, type SourceUpdateResponse, type SourceUpdateShopify, type
|
|
3014
|
+
export { type Action, type ActionType, type AuthAPIKey, type AuthAPIKeyPartial, type AuthAlgolia, type AuthAlgoliaInsights, type AuthAlgoliaInsightsPartial, type AuthAlgoliaPartial, type AuthBasic, type AuthBasicPartial, type AuthGoogleServiceAccount, type AuthGoogleServiceAccountPartial, type AuthInput, type AuthInputPartial, type AuthOAuth, type AuthOAuthPartial, type Authentication, type AuthenticationCreate, type AuthenticationCreateResponse, type AuthenticationSearch, type AuthenticationSortKeys, type AuthenticationType, type AuthenticationUpdate, type AuthenticationUpdateResponse, type BigCommerceChannel, type BigCommerceMetafield, type BigQueryDataType, type CommercetoolsCustomFields, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteAuthenticationProps, type DeleteDestinationProps, type DeleteResponse, type DeleteSourceProps, type DeleteTaskProps, type DeleteTaskV1Props, type DeleteTransformationProps, type Destination, type DestinationCreate, type DestinationCreateResponse, type DestinationIndexName, type DestinationInput, type DestinationSearch, type DestinationSortKeys, type DestinationType, type DestinationUpdate, type DestinationUpdateResponse, type DisableTaskProps, type DisableTaskV1Props, type DockerImageType, type DockerRegistry, type DockerStreams, type DockerStreamsInput, type DockerStreamsSyncMode, type EnableTaskProps, type EnableTaskV1Props, type EntityType, type ErrorBase, type Event, type EventSortKeys, type EventStatus, type EventType, type GetAuthenticationProps, type GetDestinationProps, type GetEventProps, type GetRunProps, type GetSourceProps, type GetTaskProps, type GetTaskV1Props, type GetTransformationProps, type IngestionClient, type ListAuthenticationsProps, type ListAuthenticationsResponse, type ListDestinationsProps, type ListDestinationsResponse, type ListEventsProps, type ListEventsResponse, type ListRunsProps, type ListSourcesProps, type ListSourcesResponse, type ListTasksProps, type ListTasksResponse, type ListTasksResponseV1, type ListTasksV1Props, type ListTransformationsProps, type ListTransformationsResponse, type MappingFieldDirective, type MappingFormatSchema, type MappingInput, type MappingKitAction, type MappingTypeCSV, type MethodType, type OnDemandTrigger, type OnDemandTriggerInput, type OnDemandTriggerType, type OrderKeys, type Pagination, type Platform, type PlatformNone, type PlatformWithNone, type PushTaskPayload, type PushTaskProps, type PushTaskRecords, type RecordType, type Region, type RegionOptions, type Run, type RunListResponse, type RunOutcome, type RunProgress, type RunReasonCode, type RunResponse, type RunSortKeys, type RunSourcePayload, type RunSourceProps, type RunSourceResponse, type RunStatus, type RunTaskProps, type RunTaskV1Props, type RunType, type ScheduleTrigger, type ScheduleTriggerInput, type ScheduleTriggerType, type ShopifyInput, type ShopifyMarket, type ShopifyMetafield, type Source, type SourceBigCommerce, type SourceBigQuery, type SourceCSV, type SourceCommercetools, type SourceCreate, type SourceCreateResponse, type SourceDocker, type SourceGA4BigQueryExport, type SourceInput, type SourceJSON, type SourceSearch, type SourceShopify, type SourceShopifyBase, type SourceSortKeys, type SourceType, type SourceUpdate, type SourceUpdateCommercetools, type SourceUpdateDocker, type SourceUpdateInput, type SourceUpdateResponse, type SourceUpdateShopify, type StreamingInput, type StreamingTrigger, type StreamingTriggerType, type SubscriptionTrigger, type SubscriptionTriggerType, type Task, type TaskCreate, type TaskCreateResponse, type TaskCreateTrigger, type TaskCreateV1, type TaskInput, type TaskSearch, type TaskSortKeys, type TaskUpdate, type TaskUpdateResponse, type TaskUpdateV1, type TaskV1, type Transformation, type TransformationCreate, type TransformationCreateResponse, type TransformationError, type TransformationSearch, type TransformationSortKeys, type TransformationTry, type TransformationTryResponse, type TransformationUpdateResponse, type Trigger, type TriggerDockerSourceDiscoverProps, type TriggerType, type TriggerUpdateInput, type TryTransformationBeforeUpdateProps, type UpdateAuthenticationProps, type UpdateDestinationProps, type UpdateSourceProps, type UpdateTaskProps, type UpdateTaskV1Props, type UpdateTransformationProps, type ValidateSourceBeforeUpdateProps, type WatchResponse, type Window, apiClientVersion, ingestionClient, isOnDemandTrigger, isScheduleTrigger, isSubscriptionTrigger };
|
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.
|
|
12
|
+
var apiClientVersion = "1.17.1";
|
|
13
13
|
var REGIONS = ["eu", "us"];
|
|
14
14
|
function getDefaultHosts(region) {
|
|
15
15
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -1287,9 +1287,10 @@ function createIngestionClient({
|
|
|
1287
1287
|
* @param pushTask - The pushTask object.
|
|
1288
1288
|
* @param pushTask.taskID - Unique identifier of a task.
|
|
1289
1289
|
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
1290
|
+
* @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
|
|
1290
1291
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1291
1292
|
*/
|
|
1292
|
-
pushTask({ taskID, pushTaskPayload }, requestOptions) {
|
|
1293
|
+
pushTask({ taskID, pushTaskPayload, watch }, requestOptions) {
|
|
1293
1294
|
if (!taskID) {
|
|
1294
1295
|
throw new Error("Parameter `taskID` is required when calling `pushTask`.");
|
|
1295
1296
|
}
|
|
@@ -1305,6 +1306,9 @@ function createIngestionClient({
|
|
|
1305
1306
|
const requestPath = "/2/tasks/{taskID}/push".replace("{taskID}", encodeURIComponent(taskID));
|
|
1306
1307
|
const headers = {};
|
|
1307
1308
|
const queryParameters = {};
|
|
1309
|
+
if (watch !== void 0) {
|
|
1310
|
+
queryParameters["watch"] = watch.toString();
|
|
1311
|
+
}
|
|
1308
1312
|
const request = {
|
|
1309
1313
|
method: "POST",
|
|
1310
1314
|
path: requestPath,
|