@algolia/ingestion 1.2.5 → 1.3.0

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.2.5";
+var apiClientVersion = "1.3.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -35,26 +35,25 @@ function createIngestionClient({
   ...options
 }) {
   const auth = createAuth(appIdOption, apiKeyOption, authMode);
-  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,
+    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
+      }
+    }),
     /**
      * The `appId` currently in use.
      */
@@ -63,13 +62,15 @@ function createIngestionClient({
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
     clearCache() {
-      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => void 0);
+      return Promise.all([this.transporter.requestsCache.clear(), this.transporter.responsesCache.clear()]).then(
+        () => void 0
+      );
     },
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua() {
-      return transporter.algoliaAgent.value;
+      return this.transporter.algoliaAgent.value;
     },
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
@@ -78,7 +79,16 @@ function createIngestionClient({
      * @param version - The version of the agent.
      */
     addAlgoliaAgent(segment, version) {
-      transporter.algoliaAgent.add({ segment, version });
+      this.transporter.algoliaAgent.add({ segment, version });
+    },
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }) {
+      this.transporter.baseHeaders["x-algolia-api-key"] = apiKey;
     },
     /**
      * Creates a new authentication resource.
@@ -114,7 +124,7 @@ function createIngestionClient({
         headers,
         data: authenticationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new destination.
@@ -150,7 +160,7 @@ function createIngestionClient({
         headers,
         data: destinationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new source.
@@ -183,7 +193,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task.
@@ -214,7 +224,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
@@ -248,7 +258,7 @@ function createIngestionClient({
         headers,
         data: taskCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Creates a new transformation.
@@ -276,7 +286,7 @@ function createIngestionClient({
         headers,
         data: transformationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -299,7 +309,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -322,7 +332,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -347,7 +357,7 @@ function createIngestionClient({
         headers,
         data: body ? body : {}
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -372,7 +382,7 @@ function createIngestionClient({
         headers,
         data: body ? body : {}
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
@@ -402,7 +412,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
@@ -432,7 +442,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
@@ -459,7 +469,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID.
@@ -481,7 +491,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
@@ -503,7 +513,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Deletes a transformation by its ID.
@@ -528,7 +538,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Disables a task.
@@ -555,7 +565,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Disables a task using the v1 endpoint, please use `disableTask` instead.
@@ -582,7 +592,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Enables a task.
@@ -609,7 +619,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Enables a task using the v1 endpoint, please use `enableTask` instead.
@@ -636,7 +646,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Generates code for the selected model based on the given prompt.
@@ -675,7 +685,7 @@ function createIngestionClient({
         headers,
         data: generateTransformationCodePayload
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves an authentication resource by its ID.
@@ -705,7 +715,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a destination by its ID.
@@ -735,7 +745,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a single task run event by its ID.
@@ -766,7 +776,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a single task run by its ID.
@@ -793,7 +803,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a source by its ID.
@@ -820,7 +830,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID.
@@ -847,7 +857,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
@@ -874,7 +884,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a transformation by its ID.
@@ -904,7 +914,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of all authentication resources.
@@ -951,7 +961,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of destinations.
@@ -998,7 +1008,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of events for a task run, identified by it\'s ID.
@@ -1057,7 +1067,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieve a list of task runs.
@@ -1116,7 +1126,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of sources.
@@ -1163,7 +1173,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks.
@@ -1222,7 +1232,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
@@ -1281,7 +1291,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of existing LLM transformation helpers.
@@ -1303,7 +1313,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves a list of transformations.
@@ -1342,7 +1352,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
@@ -1380,7 +1390,7 @@ function createIngestionClient({
         headers,
         data: pushTaskPayload
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
@@ -1409,7 +1419,7 @@ function createIngestionClient({
         headers,
         data: runSourcePayload ? runSourcePayload : {}
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Runs a task. You can check the status of task runs with the observability endpoints.
@@ -1436,7 +1446,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.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.
@@ -1463,7 +1473,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for authentication resources.
@@ -1495,7 +1505,7 @@ function createIngestionClient({
         headers,
         data: authenticationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for destinations.
@@ -1525,7 +1535,7 @@ function createIngestionClient({
         headers,
         data: destinationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for sources.
@@ -1555,7 +1565,7 @@ function createIngestionClient({
         headers,
         data: sourceSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks.
@@ -1585,7 +1595,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
@@ -1615,7 +1625,7 @@ function createIngestionClient({
         headers,
         data: taskSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Searches for transformations.
@@ -1647,7 +1657,7 @@ function createIngestionClient({
         headers,
         data: transformationSearch
       };
-      return transporter.request(request, requestOptions);
+      return this.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`.
@@ -1674,7 +1684,7 @@ function createIngestionClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before creating it.
@@ -1707,7 +1717,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Try a transformation before updating it.
@@ -1750,7 +1760,7 @@ function createIngestionClient({
         headers,
         data: transformationTry
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates an authentication resource.
@@ -1785,7 +1795,7 @@ function createIngestionClient({
         headers,
         data: authenticationUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates the destination by its ID.
@@ -1820,7 +1830,7 @@ function createIngestionClient({
         headers,
         data: destinationUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a source by its ID.
@@ -1852,7 +1862,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID.
@@ -1879,7 +1889,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
@@ -1906,7 +1916,7 @@ function createIngestionClient({
         headers,
         data: taskUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Updates a transformation by its ID.
@@ -1942,7 +1952,7 @@ function createIngestionClient({
         headers,
         data: transformationCreate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
@@ -1966,7 +1976,7 @@ function createIngestionClient({
         headers,
         data: sourceCreate ? sourceCreate : {}
       };
-      return transporter.request(request, requestOptions);
+      return this.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.
@@ -1998,7 +2008,7 @@ function createIngestionClient({
         headers,
         data: sourceUpdate
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     }
   };
 }