@algolia/ingestion 1.3.0 → 1.3.2

package/dist/browser.d.ts

@@ -2262,7 +2262,7 @@ type TransformationUpdateResponse = {
     updatedAt: string;
 };
 
-declare const apiClientVersion = "1.3.0";
+declare const apiClientVersion = "1.3.2";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 /**

package/dist/builds/browser.js

@@ -11,7 +11,7 @@ import { createXhrRequester } from "@algolia/requester-browser-xhr";
 
 // src/ingestionClient.ts
 import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "1.3.0";
+var apiClientVersion = "1.3.2";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -35,25 +35,26 @@ function createIngestionClient({
   ...options
 }) {
   const auth = createAuth(appIdOption, apiKeyOption, authMode);
-  return {
-    transporter: createTransporter({
-      hosts: getDefaultHosts(regionOption),
-      ...options,
-      algoliaAgent: getAlgoliaAgent({
-        algoliaAgents,
-        client: "Ingestion",
-        version: apiClientVersion
-      }),
-      baseHeaders: {
-        "content-type": "text/plain",
-        ...auth.headers(),
-        ...options.baseHeaders
-      },
-      baseQueryParameters: {
-        ...auth.queryParameters(),
-        ...options.baseQueryParameters
-      }
+  const transporter = createTransporter({
+    hosts: getDefaultHosts(regionOption),
+    ...options,
+    algoliaAgent: getAlgoliaAgent({
+      algoliaAgents,
+      client: "Ingestion",
+      version: apiClientVersion
     }),
+    baseHeaders: {
+      "content-type": "text/plain",
+      ...auth.headers(),
+      ...options.baseHeaders
+    },
+    baseQueryParameters: {
+      ...auth.queryParameters(),
+      ...options.baseQueryParameters
+    }
+  });
+  return {
+    transporter,
     /**
      * The `appId` currently in use.
      */
@@ -62,15 +63,13 @@ function createIngestionClient({
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
     clearCache() {
-      return Promise.all([this.transporter.requestsCache.clear(), this.transporter.responsesCache.clear()]).then(
-        () => void 0
-      );
+      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => void 0);
     },
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua() {
-      return this.transporter.algoliaAgent.value;
+      return transporter.algoliaAgent.value;
     },
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
@@ -79,7 +78,7 @@ function createIngestionClient({
      * @param version - The version of the agent.
      */
     addAlgoliaAgent(segment, version) {
-      this.transporter.algoliaAgent.add({ segment, version });
+      transporter.algoliaAgent.add({ segment, version });
     },
     /**
      * Helper method to switch the API key used to authenticate the requests.
@@ -88,7 +87,11 @@ function createIngestionClient({
      * @param params.apiKey - The new API Key to use.
      */
     setClientApiKey({ apiKey }) {
-      this.transporter.baseHeaders["x-algolia-api-key"] = apiKey;
+      if (!authMode || authMode === "WithinHeaders") {
+        transporter.baseHeaders["x-algolia-api-key"] = apiKey;
+      } else {
+        transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
+      }
     },
     /**
      * Creates a new authentication resource.
@@ -124,7 +127,7 @@ function createIngestionClient({
         headers,
         data: authenticationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new destination.
@@ -160,7 +163,7 @@ function createIngestionClient({
         headers,
         data: destinationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new source.
@@ -193,7 +196,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task.
@@ -224,7 +227,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
@@ -258,7 +261,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Creates a new transformation.
@@ -286,7 +289,7 @@ function createIngestionClient({
         headers,
         data: transformationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -309,7 +312,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -332,7 +335,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -357,7 +360,7 @@ function createIngestionClient({
         headers,
         data: body ? body : {}
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -382,7 +385,7 @@ function createIngestionClient({
         headers,
         data: body ? body : {}
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
@@ -412,7 +415,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
@@ -442,7 +445,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
@@ -469,7 +472,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID.
@@ -491,7 +494,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
@@ -513,7 +516,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Deletes a transformation by its ID.
@@ -538,7 +541,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Disables a task.
@@ -565,7 +568,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Disables a task using the v1 endpoint, please use `disableTask` instead.
@@ -592,7 +595,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Enables a task.
@@ -619,7 +622,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Enables a task using the v1 endpoint, please use `enableTask` instead.
@@ -646,7 +649,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Generates code for the selected model based on the given prompt.
@@ -685,7 +688,7 @@ function createIngestionClient({
         headers,
         data: generateTransformationCodePayload
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves an authentication resource by its ID.
@@ -715,7 +718,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a destination by its ID.
@@ -745,7 +748,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a single task run event by its ID.
@@ -776,7 +779,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a single task run by its ID.
@@ -803,7 +806,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a source by its ID.
@@ -830,7 +833,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID.
@@ -857,7 +860,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
@@ -884,7 +887,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a transformation by its ID.
@@ -914,7 +917,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of all authentication resources.
@@ -961,7 +964,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of destinations.
@@ -1008,7 +1011,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of events for a task run, identified by it\'s ID.
@@ -1067,7 +1070,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a list of task runs.
@@ -1126,7 +1129,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of sources.
@@ -1173,7 +1176,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks.
@@ -1232,7 +1235,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
@@ -1291,7 +1294,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of existing LLM transformation helpers.
@@ -1313,7 +1316,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of transformations.
@@ -1352,7 +1355,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
@@ -1390,7 +1393,7 @@ function createIngestionClient({
         headers,
         data: pushTaskPayload
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
@@ -1419,7 +1422,7 @@ function createIngestionClient({
         headers,
         data: runSourcePayload ? runSourcePayload : {}
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Runs a task. You can check the status of task runs with the observability endpoints.
@@ -1446,7 +1449,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
@@ -1473,7 +1476,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for authentication resources.
@@ -1505,7 +1508,7 @@ function createIngestionClient({
         headers,
         data: authenticationSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for destinations.
@@ -1535,7 +1538,7 @@ function createIngestionClient({
         headers,
         data: destinationSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for sources.
@@ -1565,7 +1568,7 @@ function createIngestionClient({
         headers,
         data: sourceSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks.
@@ -1595,7 +1598,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
@@ -1625,7 +1628,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Searches for transformations.
@@ -1657,7 +1660,7 @@ function createIngestionClient({
         headers,
         data: transformationSearch
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
@@ -1684,7 +1687,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before creating it.
@@ -1717,7 +1720,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before updating it.
@@ -1760,7 +1763,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates an authentication resource.
@@ -1795,7 +1798,7 @@ function createIngestionClient({
         headers,
         data: authenticationUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates the destination by its ID.
@@ -1830,7 +1833,7 @@ function createIngestionClient({
         headers,
         data: destinationUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a source by its ID.
@@ -1862,7 +1865,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID.
@@ -1889,7 +1892,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
@@ -1916,7 +1919,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Updates a transformation by its ID.
@@ -1952,7 +1955,7 @@ function createIngestionClient({
         headers,
         data: transformationCreate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
@@ -1976,7 +1979,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate ? sourceCreate : {}
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     },
     /**
      * Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
@@ -2008,7 +2011,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return this.transporter.request(request, requestOptions);
+      return transporter.request(request, requestOptions);
     }
   };
 }