@algolia/ingestion 1.18.0 → 1.20.0

package/dist/worker.d.ts

@@ -604,27 +604,11 @@ type SourceCommercetools = {
     customFields?: CommercetoolsCustomFields;
 };
 
-/**
- * Image type.
- */
-type DockerImageType = 'singer' | 'custom' | 'airbyte';
-
-/**
- * Container registry name from where to pull the image.
- */
-type DockerRegistry = 'dockerhub' | 'ghcr';
-
 type SourceDocker = {
-    imageType: DockerImageType;
-    registry: DockerRegistry;
     /**
-     * Docker image name.
+     * Shortname of the image, as returned by the referential.
      */
     image: string;
-    /**
-     * Docker image version.
-     */
-    version?: string;
     /**
      * Configuration of the spec.
      */
@@ -712,6 +696,30 @@ type ListSourcesResponse = {
  */
 type ActionType = 'replace' | 'save' | 'partial' | 'append';
 
+type EmailNotifications = {
+    /**
+     * Whether to send email notifications, note that this doesn\'t prevent the task from being blocked.
+     */
+    enabled?: boolean;
+};
+
+/**
+ * Notifications settings for a task.
+ */
+type Notifications = {
+    email: EmailNotifications;
+};
+
+/**
+ * Set of rules for a task.
+ */
+type Policies = {
+    /**
+     * The number of critical failures in a row before blocking the task and sending a notification.
+     */
+    criticalThreshold?: number;
+};
+
 /**
  * The strategy to use to fetch the data.
  */
@@ -730,7 +738,7 @@ type DockerStreams = {
 };
 
 /**
- * The selected streams of a singer or airbyte connector.
+ * The selected streams of an airbyte connector.
  */
 type DockerStreamsInput = {
     streams: Array<DockerStreams>;
@@ -861,6 +869,8 @@ type Task = {
      * Date of the last cursor in RFC 3339 format.
      */
     cursor?: string;
+    notifications?: Notifications;
+    policies?: Policies;
     /**
      * Date of creation in RFC 3339 format.
      */
@@ -979,6 +989,8 @@ type TaskV1 = {
      * Date of the last cursor in RFC 3339 format.
      */
     cursor?: string;
+    notifications?: Notifications;
+    policies?: Policies;
     /**
      * Date of creation in RFC 3339 format.
      */
@@ -1039,11 +1051,11 @@ type ListTransformationsResponse = {
 /**
  * Task run outcome.
  */
-type RunOutcome = 'success' | 'failure' | 'processing';
+type RunOutcome = 'success' | 'failure';
 
 type RunProgress = {
-    expectedNbOfEvents?: number;
-    receivedNbOfEvents?: number;
+    expectedNbOfEvents: number;
+    receivedNbOfEvents: number;
 };
 
 /**
@@ -1208,6 +1220,8 @@ type TaskCreate = {
      * Date of the last cursor in RFC 3339 format.
      */
     cursor?: string;
+    notifications?: Notifications;
+    policies?: Policies;
 };
 
 /**
@@ -1518,15 +1532,6 @@ type SourceUpdateCommercetools = {
 };
 
 type SourceUpdateDocker = {
-    registry?: DockerRegistry;
-    /**
-     * Docker image name.
-     */
-    image?: string;
-    /**
-     * Docker image version.
-     */
-    version?: string;
     /**
      * Configuration of the spec.
      */
@@ -1573,6 +1578,8 @@ type TaskUpdate = {
      * Maximum accepted percentage of failures for a task run to finish successfully.
      */
     failureThreshold?: number;
+    notifications?: Notifications;
+    policies?: Policies;
 };
 
 /**
@@ -2058,6 +2065,10 @@ type ListTasksProps = {
      * Type of task trigger for filtering the list of tasks.
      */
     triggerType?: Array<TriggerType>;
+    /**
+     * If specified, the response only includes tasks with notifications.email.enabled set to this value.
+     */
+    withEmailNotifications?: boolean;
     /**
      * Property by which to sort the list of tasks.
      */
@@ -2267,7 +2278,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.18.0";
+declare const apiClientVersion = "1.20.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2300,6 +2311,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * The `appId` currently in use.
      */
     appId: string;
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: string;
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
@@ -2719,11 +2734,12 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param listTasks.sourceType - Filters the tasks with the specified source type.
      * @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
      * @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
+     * @param listTasks.withEmailNotifications - If specified, the response only includes tasks with notifications.email.enabled set to this value.
      * @param listTasks.sort - Property by which to sort the list of tasks.
      * @param listTasks.order - Sort order of the response, ascending or descending.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listTasks({ itemsPerPage, page, action, enabled, sourceID, sourceType, destinationID, triggerType, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
+    listTasks({ itemsPerPage, page, action, enabled, sourceID, sourceType, destinationID, triggerType, withEmailNotifications, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
     /**
      * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
      *
@@ -2877,7 +2893,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     searchTransformations(transformationSearch: TransformationSearch, requestOptions?: RequestOptions): Promise<Array<Transformation>>;
     /**
-     * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
+     * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -3012,4 +3028,4 @@ type IngestionClient = ReturnType<typeof createIngestionClient>;
 
 declare function ingestionClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): IngestionClient;
 
-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 };
+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 DockerStreams, type DockerStreamsInput, type DockerStreamsSyncMode, type EmailNotifications, 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 Notifications, type OnDemandTrigger, type OnDemandTriggerInput, type OnDemandTriggerType, type OrderKeys, type Pagination, type Platform, type PlatformNone, type PlatformWithNone, type Policies, 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/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.18.0",
+  "version": "1.20.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,18 +49,18 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.18.0",
-    "@algolia/requester-browser-xhr": "5.18.0",
-    "@algolia/requester-fetch": "5.18.0",
-    "@algolia/requester-node-http": "5.18.0"
+    "@algolia/client-common": "5.20.0",
+    "@algolia/requester-browser-xhr": "5.20.0",
+    "@algolia/requester-fetch": "5.20.0",
+    "@algolia/requester-node-http": "5.20.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.17.1",
-    "@types/node": "22.10.2",
-    "publint": "0.2.12",
-    "rollup": "4.28.1",
+    "@arethetypeswrong/cli": "0.17.3",
+    "@types/node": "22.10.7",
+    "publint": "0.3.2",
+    "rollup": "4.30.1",
     "tsup": "8.3.5",
-    "typescript": "5.7.2"
+    "typescript": "5.7.3"
   },
   "engines": {
     "node": ">= 14.0.0"