npm - @algolia/ingestion - Versions diffs - 1.36.0 → 1.38.0 - Mend

@algolia/ingestion 1.36.0 → 1.38.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

package/README.md +4 -4
package/dist/browser.d.ts +60 -6
package/dist/builds/browser.js +40 -4
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 +2 -2
package/dist/builds/fetch.js +40 -4
package/dist/builds/fetch.js.map +1 -1
package/dist/builds/node.cjs +40 -4
package/dist/builds/node.cjs.map +1 -1
package/dist/builds/node.js +40 -4
package/dist/builds/node.js.map +1 -1
package/dist/builds/worker.js +40 -4
package/dist/builds/worker.js.map +1 -1
package/dist/fetch.d.ts +60 -6
package/dist/node.d.cts +60 -6
package/dist/node.d.ts +60 -6
package/dist/src/ingestionClient.cjs +40 -4
package/dist/src/ingestionClient.cjs.map +1 -1
package/dist/src/ingestionClient.js +45 -16
package/dist/src/ingestionClient.js.map +1 -1
package/dist/worker.d.ts +60 -6
package/package.json +7 -7

package/README.md CHANGED Viewed

@@ -41,11 +41,11 @@ All of our clients comes with type definition, and are available for both browse
 ### With a package manager
 ```bash
-yarn add @algolia/ingestion@1.36.0
+yarn add @algolia/ingestion@1.38.0
 # or
-npm install @algolia/ingestion@1.36.0
+npm install @algolia/ingestion@1.38.0
 # or
-pnpm add @algolia/ingestion@1.36.0
+pnpm add @algolia/ingestion@1.38.0
 ```
 ### Without a package manager
@@ -53,7 +53,7 @@ pnpm add @algolia/ingestion@1.36.0
 Add the following JavaScript snippet to the <head> of your website:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.36.0/dist/builds/browser.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.38.0/dist/builds/browser.umd.js"></script>
 ```
 ### Usage

package/dist/browser.d.ts CHANGED Viewed

@@ -1636,13 +1636,44 @@ type SourceUpdate = {
     authenticationID?: string | undefined;
 };
+/**
+ * API request body for updating a task.
+ */
+type TaskReplace = {
+    /**
+     * Universally unique identifier (UUID) of a destination resource.
+     */
+    destinationID: string;
+    action: ActionType;
+    subscriptionAction?: ActionType | undefined;
+    /**
+     * Cron expression for the task\'s schedule.
+     */
+    cron?: string | undefined;
+    /**
+     * Whether the task is enabled.
+     */
+    enabled?: boolean | undefined;
+    /**
+     * Maximum accepted percentage of failures for a task run to finish successfully.
+     */
+    failureThreshold?: number | undefined;
+    input?: TaskInput | undefined;
+    /**
+     * Date of the last cursor in RFC 3339 format.
+     */
+    cursor?: string | undefined;
+    notifications?: Notifications | undefined;
+    policies?: Policies | undefined;
+};
 /**
  * Property by which to sort the list of tasks.
  */
 type TaskSortKeys = 'enabled' | 'triggerType' | 'action' | 'updatedAt' | 'createdAt';
 /**
- * API request body for updating a task.
+ * API request body for partially updating a task.
  */
 type TaskUpdate = {
     /**
@@ -2224,6 +2255,10 @@ type ListTransformationsProps = {
      * Sort order of the response, ascending or descending.
      */
     order?: OrderKeys | undefined;
+    /**
+     * Whether to filter the list of transformations by the type of transformation.
+     */
+    type?: TransformationType | undefined;
 };
 /**
  * Properties for the `push` method.
@@ -2257,6 +2292,16 @@ type PushTaskProps = {
      */
     watch?: boolean | undefined;
 };
+/**
+ * Properties for the `replaceTask` method.
+ */
+type ReplaceTaskProps = {
+    /**
+     * Unique identifier of a task.
+     */
+    taskID: string;
+    taskReplace: TaskReplace;
+};
 /**
  * Properties for the `runSource` method.
  */
@@ -2412,7 +2457,7 @@ type ChunkedPushOptions = {
     objects: Array<Record<string, unknown>>;
 };
-declare const apiClientVersion = "1.36.0";
+declare const apiClientVersion = "1.38.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2932,9 +2977,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param listTransformations.page - Page number of the paginated API response.
      * @param listTransformations.sort - Property by which to sort the list of transformations.
      * @param listTransformations.order - Sort order of the response, ascending or descending.
+     * @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listTransformations({ itemsPerPage, page, sort, order }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
+    listTransformations({ itemsPerPage, page, sort, order, type }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
     /**
      * 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.
      *
@@ -2951,7 +2997,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     push({ indexName, pushTaskPayload, watch, referenceIndexName }: PushProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
     /**
-     * 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 `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
+     * 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 or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -2964,6 +3010,14 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
+    /**
+     * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+     * @param replaceTask - The replaceTask object.
+     * @param replaceTask.taskID - Unique identifier of a task.
+     * @param replaceTask.taskReplace - The taskReplace object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    replaceTask({ taskID, taskReplace }: ReplaceTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
      * Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
      *
@@ -3149,7 +3203,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      */
     updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
     /**
-     * Updates a task by its ID.
+     * Partially updates a task by its ID.
      * @param updateTask - The updateTask object.
      * @param updateTask.taskID - Unique identifier of a task.
      * @param updateTask.taskUpdate - The taskUpdate object.
@@ -3210,4 +3264,4 @@ type ErrorBase = Record<string, any> & {
 declare function ingestionClient(appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined): IngestionClient;
 type IngestionClient = ReturnType<typeof createIngestionClient>;
-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 ChunkedPushOptions, 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 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 PushProps, 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 RunTaskPayload, 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 TransformationCode, type TransformationCreate, type TransformationCreateResponse, type TransformationError, type TransformationInput, type TransformationNoCode, type TransformationSearch, type TransformationSortKeys, type TransformationTry, type TransformationTryResponse, type TransformationType, 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 ChunkedPushOptions, 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 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 PushProps, type PushTaskPayload, type PushTaskProps, type PushTaskRecords, type RecordType, type Region, type RegionOptions, type ReplaceTaskProps, type Run, type RunListResponse, type RunOutcome, type RunProgress, type RunReasonCode, type RunResponse, type RunSortKeys, type RunSourcePayload, type RunSourceProps, type RunSourceResponse, type RunStatus, type RunTaskPayload, 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 TaskReplace, type TaskSearch, type TaskSortKeys, type TaskUpdate, type TaskUpdateResponse, type TaskUpdateV1, type TaskV1, type Transformation, type TransformationCode, type TransformationCreate, type TransformationCreateResponse, type TransformationError, type TransformationInput, type TransformationNoCode, type TransformationSearch, type TransformationSortKeys, type TransformationTry, type TransformationTryResponse, type TransformationType, 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 Viewed

@@ -9,7 +9,7 @@ import {
 // src/ingestionClient.ts
 import { createAuth, createIterablePromise, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "1.36.0";
+var apiClientVersion = "1.38.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -1335,9 +1335,10 @@ function createIngestionClient({
      * @param listTransformations.page - Page number of the paginated API response.
      * @param listTransformations.sort - Property by which to sort the list of transformations.
      * @param listTransformations.order - Sort order of the response, ascending or descending.
+     * @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listTransformations({ itemsPerPage, page, sort, order } = {}, requestOptions = void 0) {
+    listTransformations({ itemsPerPage, page, sort, order, type } = {}, requestOptions = void 0) {
       const requestPath = "/1/transformations";
       const headers = {};
       const queryParameters = {};
@@ -1353,6 +1354,9 @@ function createIngestionClient({
       if (order !== void 0) {
         queryParameters["order"] = order.toString();
       }
+      if (type !== void 0) {
+        queryParameters["type"] = type.toString();
+      }
       const request = {
         method: "GET",
         path: requestPath,
@@ -1415,7 +1419,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * 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 `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
+     * 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 or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -1463,6 +1467,38 @@ function createIngestionClient({
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+     * @param replaceTask - The replaceTask object.
+     * @param replaceTask.taskID - Unique identifier of a task.
+     * @param replaceTask.taskReplace - The taskReplace object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    replaceTask({ taskID, taskReplace }, requestOptions) {
+      if (!taskID) {
+        throw new Error("Parameter `taskID` is required when calling `replaceTask`.");
+      }
+      if (!taskReplace) {
+        throw new Error("Parameter `taskReplace` is required when calling `replaceTask`.");
+      }
+      if (!taskReplace.destinationID) {
+        throw new Error("Parameter `taskReplace.destinationID` is required when calling `replaceTask`.");
+      }
+      if (!taskReplace.action) {
+        throw new Error("Parameter `taskReplace.action` is required when calling `replaceTask`.");
+      }
+      const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "PUT",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: taskReplace
+      };
+      return transporter.request(request, requestOptions);
+    },
     /**
      * Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
      *
@@ -1931,7 +1967,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Updates a task by its ID.
+     * Partially updates a task by its ID.
      * @param updateTask - The updateTask object.
      * @param updateTask.taskID - Unique identifier of a task.
      * @param updateTask.taskUpdate - The taskUpdate object.