@algolia/ingestion 1.40.1 → 1.42.0

package/dist/worker.d.ts

@@ -507,6 +507,9 @@ type BigCommerceMetafield = {
     key: string;
 };
 
+/**
+ * Specific configuration attributes of a `bigcommerce` source.
+ */
 type SourceBigCommerce = {
     /**
      * Store hash identifying your BigCommerce store.
@@ -520,6 +523,9 @@ type SourceBigCommerce = {
 
 type BigQueryDataType = 'ga4' | 'ga360';
 
+/**
+ * Specific configuration attributes of a `bigquery` source.
+ */
 type SourceBigQuery = {
     /**
      * Project ID of the BigQuery source.
@@ -555,6 +561,9 @@ type MappingTypeCSV = 'string' | 'integer' | 'float' | 'boolean' | 'json';
  */
 type MethodType = 'GET' | 'POST';
 
+/**
+ * Specific configuration attributes of a `csv` source.
+ */
 type SourceCSV = {
     /**
      * URL of the file.
@@ -595,6 +604,9 @@ type CommercetoolsCustomFields = {
     category?: Array<string> | null | undefined;
 };
 
+/**
+ * Specific configuration attributes of a `commercetools` source.
+ */
 type SourceCommercetools = {
     storeKeys?: Array<string> | undefined;
     /**
@@ -614,6 +626,9 @@ type SourceCommercetools = {
     customFields?: CommercetoolsCustomFields | undefined;
 };
 
+/**
+ * Specific configuration attributes of a `docker` source.
+ */
 type SourceDocker = {
     /**
      * Name of the connector.
@@ -625,6 +640,9 @@ type SourceDocker = {
     configuration: Record<string, unknown>;
 };
 
+/**
+ * Specific configuration attributes of a `ga4BigqueryExport` source.
+ */
 type SourceGA4BigQueryExport = {
     /**
      * GCP project ID that the BigQuery export writes to.
@@ -640,6 +658,9 @@ type SourceGA4BigQueryExport = {
     tablePrefix: string;
 };
 
+/**
+ * Specific configuration attributes of a `json` source.
+ */
 type SourceJSON = {
     /**
      * URL of the file.
@@ -659,6 +680,9 @@ type SourceShopifyBase = {
     shopURL: string;
 };
 
+/**
+ * Specific configuration attributes of a `shopify` source.
+ */
 type SourceUpdateShopify = {
     /**
      * Feature flags for the Shopify source.
@@ -1496,7 +1520,6 @@ type AuthenticationUpdate = {
      * Descriptive name for the resource.
      */
     name?: string | undefined;
-    platform?: Platform | null | undefined;
     input?: AuthInputPartial | undefined;
 };
 
@@ -1597,6 +1620,9 @@ type RunTaskPayload = {
  */
 type SourceSortKeys = 'name' | 'type' | 'updatedAt' | 'createdAt';
 
+/**
+ * Specific configuration attributes of a `commercetools` source.
+ */
 type SourceUpdateCommercetools = {
     storeKeys?: Array<string> | undefined;
     /**
@@ -1615,6 +1641,9 @@ type SourceUpdateCommercetools = {
     customFields?: CommercetoolsCustomFields | undefined;
 };
 
+/**
+ * Specific configuration attributes of a `docker` source.
+ */
 type SourceUpdateDocker = {
     /**
      * Configuration of the spec.
@@ -2457,7 +2486,7 @@ type ChunkedPushOptions = {
     objects: Array<Record<string, unknown>>;
 };
 
-declare const apiClientVersion = "1.40.1";
+declare const apiClientVersion = "1.42.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2567,6 +2596,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
     /**
      * Creates a new task.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param taskCreate - Request body for creating a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -2574,6 +2608,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
      *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
+     *
      * @deprecated
      * @param taskCreate - Request body for creating a task.
      * @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
     createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
     /**
      * Creates a new transformation.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param transformationCreate - Request body for creating a transformation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -2657,6 +2701,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * Deletes a task by its ID.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param deleteTask - The deleteTask object.
      * @param deleteTask.taskID - Unique identifier of a task.
      * @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
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
      *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
+     *
      * @deprecated
      * @param deleteTaskV1 - The deleteTaskV1 object.
      * @param deleteTaskV1.taskID - Unique identifier of a task.
@@ -2673,6 +2727,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * Deletes a transformation by its ID.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param deleteTransformation - The deleteTransformation object.
      * @param deleteTransformation.transformationID - Unique identifier of a transformation.
      * @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
     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.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param replaceTask - The replaceTask object.
      * @param replaceTask.taskID - Unique identifier of a task.
      * @param replaceTask.taskReplace - The taskReplace object.
@@ -3204,6 +3268,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
     /**
      * Partially updates a task by its ID.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param updateTask - The updateTask object.
      * @param updateTask.taskID - Unique identifier of a task.
      * @param updateTask.taskUpdate - The taskUpdate object.
@@ -3213,6 +3282,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
      *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
+     *
      * @deprecated
      * @param updateTaskV1 - The updateTaskV1 object.
      * @param updateTaskV1.taskID - Unique identifier of a task.
@@ -3222,6 +3296,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
      * Updates a transformation by its ID.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param updateTransformation - The updateTransformation object.
      * @param updateTransformation.transformationID - Unique identifier of a transformation.
      * @param updateTransformation.transformationCreate - The transformationCreate object.

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.40.1",
+  "version": "1.42.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,16 +49,16 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.40.1",
-    "@algolia/requester-browser-xhr": "5.40.1",
-    "@algolia/requester-fetch": "5.40.1",
-    "@algolia/requester-node-http": "5.40.1"
+    "@algolia/client-common": "5.42.0",
+    "@algolia/requester-browser-xhr": "5.42.0",
+    "@algolia/requester-fetch": "5.42.0",
+    "@algolia/requester-node-http": "5.42.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.2",
-    "@types/node": "22.18.10",
-    "publint": "0.3.14",
-    "rollup": "4.52.4",
+    "@types/node": "22.18.12",
+    "publint": "0.3.15",
+    "rollup": "4.52.5",
     "tsup": "8.5.0",
     "typescript": "5.9.3"
   },