@unito/integration-sdk 2.3.13 → 2.3.14

package/dist/src/index.cjs

@@ -1359,7 +1359,7 @@ class Provider {
                                 if (body.error) {
                                     reject(this.handleError(400, body.error.message, options));
                                 }
-                                resolve({ status: 201, headers: response.headers, body: body });
+                                resolve({ status: 201, headers: response.headers, body });
                             }
                             catch (error) {
                                 reject(this.handleError(500, `Failed to parse response body: "${error}"`, options));
@@ -1378,6 +1378,100 @@ class Provider {
         };
         return this.rateLimiter ? this.rateLimiter(options, callToProvider) : callToProvider();
     }
+    /**
+     * Performs a POST request to the provider streaming a Readable directly without loading it into memory.
+     *
+     * @param endpoint Path to the provider's resource. Will be added to the URL returned by the prepareRequest function.
+     * @param stream The Readable stream containing the binary data to be sent.
+     * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
+     * @returns The {@link Response} extracted from the provider.
+     */
+    async postStream(endpoint, stream, options) {
+        const { url: providerUrl, headers: providerHeaders } = await this.prepareRequest(options);
+        const absoluteUrl = this.generateAbsoluteUrl(providerUrl, endpoint, options.queryParams);
+        const headers = {
+            'Content-Type': 'application/octet-stream',
+            Accept: 'application/json',
+            ...providerHeaders,
+            ...options.additionnalheaders,
+        };
+        const callToProvider = async () => {
+            return new Promise((resolve, reject) => {
+                let isSettled = false; // Prevent double rejection
+                const cleanup = () => {
+                    if (!stream.destroyed) {
+                        stream.destroy();
+                    }
+                };
+                const safeReject = (error) => {
+                    if (!isSettled) {
+                        isSettled = true;
+                        cleanup();
+                        reject(error);
+                    }
+                };
+                const safeResolve = (response) => {
+                    if (!isSettled) {
+                        isSettled = true;
+                        resolve(response);
+                    }
+                };
+                try {
+                    const urlObj = new URL(absoluteUrl);
+                    const requestOptions = {
+                        hostname: urlObj.hostname,
+                        path: urlObj.pathname + urlObj.search,
+                        method: 'POST',
+                        headers,
+                    };
+                    const request = https.request(requestOptions, response => {
+                        response.setEncoding('utf8');
+                        let responseBody = '';
+                        response.on('data', chunk => {
+                            responseBody += chunk;
+                        });
+                        response.on('error', error => {
+                            safeReject(this.handleError(500, `Response stream error: "${error}"`, options));
+                        });
+                        response.on('end', () => {
+                            try {
+                                if (response.statusCode && response.statusCode >= 400) {
+                                    safeReject(this.handleError(response.statusCode, responseBody, options));
+                                    return;
+                                }
+                                const body = responseBody ? JSON.parse(responseBody) : undefined;
+                                safeResolve({
+                                    status: response.statusCode || 200,
+                                    headers: response.headers,
+                                    body,
+                                });
+                            }
+                            catch (error) {
+                                safeReject(this.handleError(500, `Failed to parse response body: "${error}"`, options));
+                            }
+                        });
+                    });
+                    request.on('timeout', () => {
+                        request.destroy();
+                        safeReject(this.handleError(408, 'Request timeout', options));
+                    });
+                    request.on('error', error => {
+                        safeReject(this.handleError(500, `Error while calling the provider: "${error}"`, options));
+                    });
+                    stream.on('error', error => {
+                        request.destroy();
+                        safeReject(this.handleError(500, `Stream error: "${error}"`, options));
+                    });
+                    // Stream the data directly without buffering
+                    stream.pipe(request);
+                }
+                catch (error) {
+                    safeReject(this.handleError(500, `Unexpected error while calling the provider: "${error}"`, options));
+                }
+            });
+        };
+        return this.rateLimiter ? this.rateLimiter(options, callToProvider) : callToProvider();
+    }
     /**
      * Performs a PUT request to the provider.
      *

package/dist/src/resources/provider.d.ts

@@ -1,4 +1,6 @@
 import FormData from 'form-data';
+import * as stream from 'stream';
+import { IncomingHttpHeaders } from 'http';
 import * as HttpErrors from '../httpErrors.js';
 import { Credentials } from '../middlewares/credentials.js';
 import Logger from '../resources/logger.js';
@@ -54,7 +56,7 @@ export type RequestOptions = {
 export type Response<T> = {
     body: T;
     status: number;
-    headers: Headers;
+    headers: Headers | IncomingHttpHeaders;
 };
 export type PreparedRequest = {
     url: string;
@@ -152,6 +154,15 @@ export declare class Provider {
      */
     post<T>(endpoint: string, body: RequestBody, options: RequestOptions): Promise<Response<T>>;
     postForm<T>(endpoint: string, form: FormData, options: RequestOptions): Promise<Response<T>>;
+    /**
+     * Performs a POST request to the provider streaming a Readable directly without loading it into memory.
+     *
+     * @param endpoint Path to the provider's resource. Will be added to the URL returned by the prepareRequest function.
+     * @param stream The Readable stream containing the binary data to be sent.
+     * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
+     * @returns The {@link Response} extracted from the provider.
+     */
+    postStream<T>(endpoint: string, stream: stream.Readable, options: RequestOptions): Promise<Response<T>>;
     /**
      * Performs a PUT request to the provider.
      *

package/dist/src/resources/provider.js

@@ -140,7 +140,7 @@ export class Provider {
                                 if (body.error) {
                                     reject(this.handleError(400, body.error.message, options));
                                 }
-                                resolve({ status: 201, headers: response.headers, body: body });
+                                resolve({ status: 201, headers: response.headers, body });
                             }
                             catch (error) {
                                 reject(this.handleError(500, `Failed to parse response body: "${error}"`, options));
@@ -159,6 +159,100 @@ export class Provider {
         };
         return this.rateLimiter ? this.rateLimiter(options, callToProvider) : callToProvider();
     }
+    /**
+     * Performs a POST request to the provider streaming a Readable directly without loading it into memory.
+     *
+     * @param endpoint Path to the provider's resource. Will be added to the URL returned by the prepareRequest function.
+     * @param stream The Readable stream containing the binary data to be sent.
+     * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
+     * @returns The {@link Response} extracted from the provider.
+     */
+    async postStream(endpoint, stream, options) {
+        const { url: providerUrl, headers: providerHeaders } = await this.prepareRequest(options);
+        const absoluteUrl = this.generateAbsoluteUrl(providerUrl, endpoint, options.queryParams);
+        const headers = {
+            'Content-Type': 'application/octet-stream',
+            Accept: 'application/json',
+            ...providerHeaders,
+            ...options.additionnalheaders,
+        };
+        const callToProvider = async () => {
+            return new Promise((resolve, reject) => {
+                let isSettled = false; // Prevent double rejection
+                const cleanup = () => {
+                    if (!stream.destroyed) {
+                        stream.destroy();
+                    }
+                };
+                const safeReject = (error) => {
+                    if (!isSettled) {
+                        isSettled = true;
+                        cleanup();
+                        reject(error);
+                    }
+                };
+                const safeResolve = (response) => {
+                    if (!isSettled) {
+                        isSettled = true;
+                        resolve(response);
+                    }
+                };
+                try {
+                    const urlObj = new URL(absoluteUrl);
+                    const requestOptions = {
+                        hostname: urlObj.hostname,
+                        path: urlObj.pathname + urlObj.search,
+                        method: 'POST',
+                        headers,
+                    };
+                    const request = https.request(requestOptions, response => {
+                        response.setEncoding('utf8');
+                        let responseBody = '';
+                        response.on('data', chunk => {
+                            responseBody += chunk;
+                        });
+                        response.on('error', error => {
+                            safeReject(this.handleError(500, `Response stream error: "${error}"`, options));
+                        });
+                        response.on('end', () => {
+                            try {
+                                if (response.statusCode && response.statusCode >= 400) {
+                                    safeReject(this.handleError(response.statusCode, responseBody, options));
+                                    return;
+                                }
+                                const body = responseBody ? JSON.parse(responseBody) : undefined;
+                                safeResolve({
+                                    status: response.statusCode || 200,
+                                    headers: response.headers,
+                                    body,
+                                });
+                            }
+                            catch (error) {
+                                safeReject(this.handleError(500, `Failed to parse response body: "${error}"`, options));
+                            }
+                        });
+                    });
+                    request.on('timeout', () => {
+                        request.destroy();
+                        safeReject(this.handleError(408, 'Request timeout', options));
+                    });
+                    request.on('error', error => {
+                        safeReject(this.handleError(500, `Error while calling the provider: "${error}"`, options));
+                    });
+                    stream.on('error', error => {
+                        request.destroy();
+                        safeReject(this.handleError(500, `Stream error: "${error}"`, options));
+                    });
+                    // Stream the data directly without buffering
+                    stream.pipe(request);
+                }
+                catch (error) {
+                    safeReject(this.handleError(500, `Unexpected error while calling the provider: "${error}"`, options));
+                }
+            });
+        };
+        return this.rateLimiter ? this.rateLimiter(options, callToProvider) : callToProvider();
+    }
     /**
      * Performs a PUT request to the provider.
      *

package/dist/test/resources/provider.test.js

@@ -1,5 +1,7 @@
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
+import { Readable } from 'stream';
+import nock from 'nock';
 import { Provider } from '../../src/resources/provider.js';
 import * as HttpErrors from '../../src/httpErrors.js';
 import Logger from '../../src/resources/logger.js';
@@ -29,7 +31,7 @@ describe('Provider', () => {
         const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const actualResponse = await provider.get('/endpoint', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1' },
         });
@@ -58,7 +60,7 @@ describe('Provider', () => {
         const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const actualResponse = await provider.get('/endpoint', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1', Accept: 'text/html; charset=UTF-8' },
         });
@@ -87,7 +89,7 @@ describe('Provider', () => {
         const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const actualResponse = await provider.get('/endpoint', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1', Accept: 'application/schema+json; charset=UTF-8' },
         });
@@ -116,7 +118,7 @@ describe('Provider', () => {
         const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const actualResponse = await provider.get('/endpoint', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1', Accept: 'application/swagger+json; charset=UTF-8' },
         });
@@ -145,7 +147,7 @@ describe('Provider', () => {
         const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const actualResponse = await provider.get('/endpoint', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1' },
         });
@@ -174,7 +176,7 @@ describe('Provider', () => {
         context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const providerResponse = await provider.streamingGet('/endpoint/123', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: {
                 Accept: 'application/json',
@@ -193,7 +195,7 @@ describe('Provider', () => {
         const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const actualResponse = await provider.get('https://my-cdn.my-domain.com/file.png', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
         });
         assert.equal(fetchMock.mock.calls.length, 1);
@@ -220,7 +222,7 @@ describe('Provider', () => {
         const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const actualResponse = await provider.get('', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
         });
         assert.equal(fetchMock.mock.calls.length, 1);
@@ -249,7 +251,7 @@ describe('Provider', () => {
             data: 'createdItemInfo',
         }, {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'Content-Type': 'application/x-www-form-urlencoded', 'X-Additional-Header': 'value1' },
         });
@@ -282,7 +284,7 @@ describe('Provider', () => {
             { data: '3', data2: '4' },
         ], {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'Content-Type': 'application/json-patch+json', 'X-Additional-Header': 'value1' },
         });
@@ -315,7 +317,7 @@ describe('Provider', () => {
             data: 'updatedItemInfo',
         }, {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1', 'Content-Type': 'application/json' },
         });
@@ -347,7 +349,7 @@ describe('Provider', () => {
         // What matters is that the body of put is a buffer
         const actualResponse = await provider.putBuffer('endpoint/123', buffer, {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1', 'Content-Type': 'application/octet-stream' },
         });
@@ -379,7 +381,7 @@ describe('Provider', () => {
             data: 'updatedItemInfo',
         }, {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             queryParams: { param1: 'value1', param2: 'value2' },
             additionnalheaders: { 'X-Additional-Header': 'value1' },
@@ -410,7 +412,7 @@ describe('Provider', () => {
         const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const actualResponse = await provider.delete('/endpoint/123', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1' },
         });
@@ -440,7 +442,7 @@ describe('Provider', () => {
         const requestBody = { webhookIds: [1, 2, 3] };
         const actualResponse = await provider.delete('/webhook', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1' },
         }, requestBody);
@@ -483,7 +485,7 @@ describe('Provider', () => {
         const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const options = {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1' },
         };
@@ -529,7 +531,7 @@ describe('Provider', () => {
         context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const options = {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1' },
         };
@@ -570,7 +572,7 @@ describe('Provider', () => {
         context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const options = {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1' },
         };
@@ -606,7 +608,7 @@ describe('Provider', () => {
         context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const options = {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
             additionnalheaders: { 'X-Additional-Header': 'value1' },
         };
@@ -628,7 +630,7 @@ describe('Provider', () => {
         context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const providerResponse = await provider.get('/endpoint/123', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
         });
         assert.ok(providerResponse);
@@ -642,7 +644,7 @@ describe('Provider', () => {
         context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const providerResponse = await provider.get('/endpoint/123', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
         });
         assert.ok(providerResponse);
@@ -656,7 +658,7 @@ describe('Provider', () => {
         context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const providerResponse = await provider.streamingGet('/endpoint/123', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
         });
         assert.ok(providerResponse);
@@ -670,7 +672,7 @@ describe('Provider', () => {
         context.mock.method(global, 'fetch', () => Promise.resolve(response));
         const providerResponse = await provider.post('/endpoint/123', {}, {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-            logger: logger,
+            logger,
             signal: new AbortController().signal,
         });
         assert.ok(providerResponse);
@@ -688,7 +690,7 @@ describe('Provider', () => {
         try {
             await provider.get('/endpoint/123', {
                 credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-                logger: logger,
+                logger,
                 signal: new AbortController().signal,
             });
         }
@@ -708,7 +710,7 @@ describe('Provider', () => {
         try {
             await provider.get('/endpoint/123', {
                 credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-                logger: logger,
+                logger,
                 signal: new AbortController().signal,
             });
         }
@@ -728,7 +730,7 @@ describe('Provider', () => {
             await provider.get('/endpoint/123', {
                 credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
                 signal: new AbortController().signal,
-                logger: logger,
+                logger,
             });
         }
         catch (e) {
@@ -748,7 +750,7 @@ describe('Provider', () => {
             await provider.get('/endpoint/123', {
                 credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
                 signal: new AbortController().signal,
-                logger: logger,
+                logger,
             });
         }
         catch (e) {
@@ -768,7 +770,7 @@ describe('Provider', () => {
             await provider.get('/endpoint/123', {
                 credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
                 signal: new AbortController().signal,
-                logger: logger,
+                logger,
             });
         }
         catch (e) {
@@ -786,7 +788,7 @@ describe('Provider', () => {
             await provider.get('/endpoint/123', {
                 credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
                 signal: new AbortController().signal,
-                logger: logger,
+                logger,
             });
         }
         catch (e) {
@@ -810,7 +812,7 @@ describe('Provider', () => {
             await provider.get('/endpoint/123', {
                 credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
                 signal: new AbortController().signal,
-                logger: logger,
+                logger,
             });
         }
         catch (e) {
@@ -826,9 +828,117 @@ describe('Provider', () => {
         await provider.get('/endpoint/123', {
             credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
             signal: new AbortController().signal,
-            logger: logger,
+            logger,
         });
         assert.equal(loggerStub.mock.callCount(), 1);
         assert.match(String(loggerStub.mock.calls[0]?.arguments[0]), /Connector API Request GET www.myApi.com\/endpoint\/123 201 - \d+ ms/);
     });
+    // Stream upload will not load the data in memory and sending a binary in the body
+    it('postStream streams data without buffering', async () => {
+        const streamProvider = new Provider({
+            prepareRequest: requestOptions => ({
+                url: `https://www.${requestOptions.credentials.domain ?? 'myApi.com'}`,
+                headers: {
+                    'X-Custom-Provider-Header': 'value',
+                    'X-Provider-Credential-Header': requestOptions.credentials.apiKey,
+                },
+            }),
+        });
+        const testData = 'test binary data for streaming';
+        const stream = Readable.from([testData]);
+        const scope = nock('https://www.myApi.com')
+            .post('/upload', testData)
+            .matchHeader('content-type', 'application/octet-stream')
+            .matchHeader('accept', 'application/json')
+            .matchHeader('x-custom-provider-header', 'value')
+            .matchHeader('x-provider-credential-header', 'apikey#1111')
+            .reply(201, { success: true, id: '12345' });
+        const response = await streamProvider.postStream('/upload', stream, {
+            credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+            logger,
+        });
+        assert.ok(scope.isDone(), 'HTTPS request should have been made');
+        assert.equal(response.status, 201);
+        assert.deepEqual(response.body, { success: true, id: '12345' });
+    });
+    it('postStream with query params', async () => {
+        const streamProvider = new Provider({
+            prepareRequest: requestOptions => ({
+                url: `https://www.myApi.com`,
+                headers: {
+                    'X-Custom-Provider-Header': 'value',
+                    'X-Provider-Credential-Header': requestOptions.credentials.apiKey,
+                },
+            }),
+        });
+        const testData = 'data with params';
+        const stream = Readable.from([testData]);
+        const scope = nock('https://www.myApi.com')
+            .post('/upload?key=value&format=json', testData)
+            .reply(200, { uploaded: true });
+        const response = await streamProvider.postStream('/upload', stream, {
+            credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+            logger,
+            queryParams: { key: 'value', format: 'json' },
+        });
+        assert.ok(scope.isDone());
+        assert.equal(response.status, 200);
+        assert.deepEqual(response.body, { uploaded: true });
+    });
+    it('postStream handles error responses', async () => {
+        const streamProvider = new Provider({
+            prepareRequest: requestOptions => ({
+                url: `https://www.myApi.com`,
+                headers: {
+                    'X-Custom-Provider-Header': 'value',
+                    'X-Provider-Credential-Header': requestOptions.credentials.apiKey,
+                },
+            }),
+        });
+        const stream = Readable.from(['error test data']);
+        nock('https://www.myApi.com').post('/upload').reply(400, 'Bad request error');
+        let error;
+        try {
+            await streamProvider.postStream('/upload', stream, {
+                credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+                logger,
+            });
+        }
+        catch (e) {
+            error = e;
+        }
+        assert.ok(error instanceof HttpErrors.BadRequestError);
+        assert.equal(error.message, 'Bad request error');
+    });
+    it('postStream with rate limiter', async () => {
+        let rateLimiterCalled = false;
+        let rateLimiterCredentials;
+        const mockRateLimiter = async (options, request) => {
+            rateLimiterCalled = true;
+            rateLimiterCredentials = options.credentials;
+            return request();
+        };
+        const rateLimitedProvider = new Provider({
+            prepareRequest: requestOptions => ({
+                url: `https://www.myApi.com`,
+                headers: {
+                    'X-Custom-Provider-Header': 'value',
+                    'X-Provider-Credential-Header': requestOptions.credentials.apiKey,
+                },
+            }),
+            rateLimiter: mockRateLimiter,
+        });
+        const testData = 'rate limited data';
+        const stream = Readable.from([testData]);
+        nock('https://www.myApi.com').post('/upload', testData).reply(201, { success: true });
+        await rateLimitedProvider.postStream('/upload', stream, {
+            credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+            logger,
+        });
+        assert.ok(rateLimiterCalled, 'Rate limiter should have been called');
+        assert.deepEqual(rateLimiterCredentials, {
+            apiKey: 'apikey#1111',
+            unitoCredentialId: '123',
+        });
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-sdk",
-  "version": "2.3.13",
+  "version": "2.3.14",
   "description": "Integration SDK",
   "type": "module",
   "types": "dist/src/index.d.ts",
@@ -44,6 +44,7 @@
     "@typescript-eslint/eslint-plugin": "7.x",
     "@typescript-eslint/parser": "7.x",
     "eslint": "8.x",
+    "nock": "14.x",
     "nodemon": "3.x",
     "prettier": "3.x",
     "rollup": "4.x",

package/src/resources/provider.ts

@@ -1,5 +1,7 @@
 import https from 'https';
 import FormData from 'form-data';
+import * as stream from 'stream';
+import { IncomingHttpHeaders } from 'http';
 
 import { buildHttpError } from '../errors.js';
 import * as HttpErrors from '../httpErrors.js';
@@ -56,7 +58,7 @@ export type RequestOptions = {
 export type Response<T> = {
   body: T;
   status: number;
-  headers: Headers;
+  headers: Headers | IncomingHttpHeaders;
 };
 
 export type PreparedRequest = {
@@ -230,7 +232,7 @@ export class Provider {
                 if (body.error) {
                   reject(this.handleError(400, body.error.message, options));
                 }
-                resolve({ status: 201, headers: response.headers as unknown as Headers, body: body as T });
+                resolve({ status: 201, headers: response.headers, body });
               } catch (error) {
                 reject(this.handleError(500, `Failed to parse response body: "${error}"`, options));
               }
@@ -251,6 +253,114 @@ export class Provider {
     return this.rateLimiter ? this.rateLimiter(options, callToProvider) : callToProvider();
   }
 
+  /**
+   * Performs a POST request to the provider streaming a Readable directly without loading it into memory.
+   *
+   * @param endpoint Path to the provider's resource. Will be added to the URL returned by the prepareRequest function.
+   * @param stream The Readable stream containing the binary data to be sent.
+   * @param options RequestOptions used to adjust the call made to the provider (use to override default headers).
+   * @returns The {@link Response} extracted from the provider.
+   */
+  public async postStream<T>(endpoint: string, stream: stream.Readable, options: RequestOptions): Promise<Response<T>> {
+    const { url: providerUrl, headers: providerHeaders } = await this.prepareRequest(options);
+    const absoluteUrl = this.generateAbsoluteUrl(providerUrl, endpoint, options.queryParams);
+    const headers = {
+      'Content-Type': 'application/octet-stream',
+      Accept: 'application/json',
+      ...providerHeaders,
+      ...options.additionnalheaders,
+    };
+
+    const callToProvider = async (): Promise<Response<T>> => {
+      return new Promise((resolve, reject) => {
+        let isSettled = false; // Prevent double rejection
+
+        const cleanup = () => {
+          if (!stream.destroyed) {
+            stream.destroy();
+          }
+        };
+
+        const safeReject = (error: HttpErrors.HttpError) => {
+          if (!isSettled) {
+            isSettled = true;
+            cleanup();
+            reject(error);
+          }
+        };
+
+        const safeResolve = (response: Response<T>) => {
+          if (!isSettled) {
+            isSettled = true;
+            resolve(response);
+          }
+        };
+
+        try {
+          const urlObj = new URL(absoluteUrl);
+          const requestOptions: https.RequestOptions = {
+            hostname: urlObj.hostname,
+            path: urlObj.pathname + urlObj.search,
+            method: 'POST',
+            headers,
+          };
+
+          const request = https.request(requestOptions, response => {
+            response.setEncoding('utf8');
+            let responseBody = '';
+
+            response.on('data', chunk => {
+              responseBody += chunk;
+            });
+
+            response.on('error', error => {
+              safeReject(this.handleError(500, `Response stream error: "${error}"`, options));
+            });
+
+            response.on('end', () => {
+              try {
+                if (response.statusCode && response.statusCode >= 400) {
+                  safeReject(this.handleError(response.statusCode, responseBody, options));
+                  return;
+                }
+
+                const body = responseBody ? JSON.parse(responseBody) : undefined;
+                safeResolve({
+                  status: response.statusCode || 200,
+                  headers: response.headers,
+                  body,
+                });
+              } catch (error) {
+                safeReject(this.handleError(500, `Failed to parse response body: "${error}"`, options));
+              }
+            });
+          });
+
+          request.on('timeout', () => {
+            request.destroy();
+            safeReject(this.handleError(408, 'Request timeout', options));
+          });
+
+          request.on('error', error => {
+            safeReject(this.handleError(500, `Error while calling the provider: "${error}"`, options));
+          });
+
+          stream.on('error', error => {
+            request.destroy();
+            safeReject(this.handleError(500, `Stream error: "${error}"`, options));
+          });
+
+          // Stream the data directly without buffering
+          stream.pipe(request);
+        } catch (error) {
+          safeReject(this.handleError(500, `Unexpected error while calling the provider: "${error}"`, options));
+        }
+      });
+    };
+
+    return this.rateLimiter ? this.rateLimiter(options, callToProvider) : callToProvider();
+  }
+
   /**
    * Performs a PUT request to the provider.
    *
@@ -409,7 +519,7 @@ export class Provider {
         response = await fetch(absoluteUrl, {
           method: options.method,
           headers,
-          body: fetchBody,
+          body: fetchBody as BodyInit | null,
           ...(options.signal ? { signal: options.signal } : {}),
         });
       } catch (error) {

package/test/resources/provider.test.ts

@@ -1,5 +1,7 @@
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
+import { Readable } from 'stream';
+import nock from 'nock';
 
 import { Provider } from '../../src/resources/provider.js';
 import * as HttpErrors from '../../src/httpErrors.js';
@@ -36,7 +38,7 @@ describe('Provider', () => {
 
     const actualResponse = await provider.get('/endpoint', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1' },
     });
@@ -69,7 +71,7 @@ describe('Provider', () => {
 
     const actualResponse = await provider.get('/endpoint', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1', Accept: 'text/html; charset=UTF-8' },
     });
@@ -104,7 +106,7 @@ describe('Provider', () => {
 
     const actualResponse = await provider.get('/endpoint', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1', Accept: 'application/schema+json; charset=UTF-8' },
     });
@@ -139,7 +141,7 @@ describe('Provider', () => {
 
     const actualResponse = await provider.get('/endpoint', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1', Accept: 'application/swagger+json; charset=UTF-8' },
     });
@@ -174,7 +176,7 @@ describe('Provider', () => {
 
     const actualResponse = await provider.get('/endpoint', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1' },
     });
@@ -209,7 +211,7 @@ describe('Provider', () => {
 
     const providerResponse = await provider.streamingGet('/endpoint/123', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: {
         Accept: 'application/json',
@@ -232,7 +234,7 @@ describe('Provider', () => {
 
     const actualResponse = await provider.get('https://my-cdn.my-domain.com/file.png', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
     });
 
@@ -263,7 +265,7 @@ describe('Provider', () => {
 
     const actualResponse = await provider.get('', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
     });
 
@@ -299,7 +301,7 @@ describe('Provider', () => {
       },
       {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-        logger: logger,
+        logger,
         signal: new AbortController().signal,
         additionnalheaders: { 'Content-Type': 'application/x-www-form-urlencoded', 'X-Additional-Header': 'value1' },
       },
@@ -340,7 +342,7 @@ describe('Provider', () => {
       ],
       {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-        logger: logger,
+        logger,
         signal: new AbortController().signal,
         additionnalheaders: { 'Content-Type': 'application/json-patch+json', 'X-Additional-Header': 'value1' },
       },
@@ -381,7 +383,7 @@ describe('Provider', () => {
       },
       {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-        logger: logger,
+        logger,
         signal: new AbortController().signal,
         additionnalheaders: { 'X-Additional-Header': 'value1', 'Content-Type': 'application/json' },
       },
@@ -419,7 +421,7 @@ describe('Provider', () => {
     // What matters is that the body of put is a buffer
     const actualResponse = await provider.putBuffer('endpoint/123', buffer, {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1', 'Content-Type': 'application/octet-stream' },
     });
@@ -458,7 +460,7 @@ describe('Provider', () => {
       },
       {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-        logger: logger,
+        logger,
         signal: new AbortController().signal,
         queryParams: { param1: 'value1', param2: 'value2' },
         additionnalheaders: { 'X-Additional-Header': 'value1' },
@@ -494,7 +496,7 @@ describe('Provider', () => {
 
     const actualResponse = await provider.delete('/endpoint/123', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1' },
     });
@@ -530,7 +532,7 @@ describe('Provider', () => {
       '/webhook',
       {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-        logger: logger,
+        logger,
         signal: new AbortController().signal,
         additionnalheaders: { 'X-Additional-Header': 'value1' },
       },
@@ -581,7 +583,7 @@ describe('Provider', () => {
 
     const options = {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1' },
     };
@@ -634,7 +636,7 @@ describe('Provider', () => {
 
     const options = {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1' },
     };
@@ -681,7 +683,7 @@ describe('Provider', () => {
 
     const options = {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1' },
     };
@@ -722,7 +724,7 @@ describe('Provider', () => {
 
     const options = {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
       additionnalheaders: { 'X-Additional-Header': 'value1' },
     };
@@ -748,7 +750,7 @@ describe('Provider', () => {
 
     const providerResponse = await provider.get<{ validJson: boolean }>('/endpoint/123', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
     });
 
@@ -766,7 +768,7 @@ describe('Provider', () => {
 
     const providerResponse = await provider.get<{ validJson: boolean }>('/endpoint/123', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
     });
 
@@ -784,7 +786,7 @@ describe('Provider', () => {
 
     const providerResponse = await provider.streamingGet('/endpoint/123', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-      logger: logger,
+      logger,
       signal: new AbortController().signal,
     });
 
@@ -805,7 +807,7 @@ describe('Provider', () => {
       {},
       {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-        logger: logger,
+        logger,
         signal: new AbortController().signal,
       },
     );
@@ -829,7 +831,7 @@ describe('Provider', () => {
     try {
       await provider.get('/endpoint/123', {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-        logger: logger,
+        logger,
         signal: new AbortController().signal,
       });
     } catch (e) {
@@ -853,7 +855,7 @@ describe('Provider', () => {
     try {
       await provider.get('/endpoint/123', {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
-        logger: logger,
+        logger,
         signal: new AbortController().signal,
       });
     } catch (e) {
@@ -877,7 +879,7 @@ describe('Provider', () => {
       await provider.get('/endpoint/123', {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
         signal: new AbortController().signal,
-        logger: logger,
+        logger,
       });
     } catch (e) {
       error = e;
@@ -900,7 +902,7 @@ describe('Provider', () => {
       await provider.get('/endpoint/123', {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
         signal: new AbortController().signal,
-        logger: logger,
+        logger,
       });
     } catch (e) {
       error = e;
@@ -923,7 +925,7 @@ describe('Provider', () => {
       await provider.get('/endpoint/123', {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
         signal: new AbortController().signal,
-        logger: logger,
+        logger,
       });
     } catch (e) {
       error = e;
@@ -944,7 +946,7 @@ describe('Provider', () => {
       await provider.get('/endpoint/123', {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
         signal: new AbortController().signal,
-        logger: logger,
+        logger,
       });
     } catch (e) {
       error = e;
@@ -972,7 +974,7 @@ describe('Provider', () => {
       await provider.get('/endpoint/123', {
         credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
         signal: new AbortController().signal,
-        logger: logger,
+        logger,
       });
     } catch (e) {
       error = e;
@@ -992,7 +994,7 @@ describe('Provider', () => {
     await provider.get('/endpoint/123', {
       credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
       signal: new AbortController().signal,
-      logger: logger,
+      logger,
     });
 
     assert.equal(loggerStub.mock.callCount(), 1);
@@ -1001,4 +1003,133 @@ describe('Provider', () => {
       /Connector API Request GET www.myApi.com\/endpoint\/123 201 - \d+ ms/,
     );
   });
+
+  // Stream upload will not load the data in memory and sending a binary in the body
+  it('postStream streams data without buffering', async () => {
+    const streamProvider = new Provider({
+      prepareRequest: requestOptions => ({
+        url: `https://www.${requestOptions.credentials.domain ?? 'myApi.com'}`,
+        headers: {
+          'X-Custom-Provider-Header': 'value',
+          'X-Provider-Credential-Header': requestOptions.credentials.apiKey as string,
+        },
+      }),
+    });
+
+    const testData = 'test binary data for streaming';
+    const stream = Readable.from([testData]);
+
+    const scope = nock('https://www.myApi.com')
+      .post('/upload', testData)
+      .matchHeader('content-type', 'application/octet-stream')
+      .matchHeader('accept', 'application/json')
+      .matchHeader('x-custom-provider-header', 'value')
+      .matchHeader('x-provider-credential-header', 'apikey#1111')
+      .reply(201, { success: true, id: '12345' });
+
+    const response = await streamProvider.postStream('/upload', stream, {
+      credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+      logger,
+    });
+
+    assert.ok(scope.isDone(), 'HTTPS request should have been made');
+    assert.equal(response.status, 201);
+    assert.deepEqual(response.body, { success: true, id: '12345' });
+  });
+
+  it('postStream with query params', async () => {
+    const streamProvider = new Provider({
+      prepareRequest: requestOptions => ({
+        url: `https://www.myApi.com`,
+        headers: {
+          'X-Custom-Provider-Header': 'value',
+          'X-Provider-Credential-Header': requestOptions.credentials.apiKey as string,
+        },
+      }),
+    });
+
+    const testData = 'data with params';
+    const stream = Readable.from([testData]);
+
+    const scope = nock('https://www.myApi.com')
+      .post('/upload?key=value&format=json', testData)
+      .reply(200, { uploaded: true });
+
+    const response = await streamProvider.postStream('/upload', stream, {
+      credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+      logger,
+      queryParams: { key: 'value', format: 'json' },
+    });
+
+    assert.ok(scope.isDone());
+    assert.equal(response.status, 200);
+    assert.deepEqual(response.body, { uploaded: true });
+  });
+
+  it('postStream handles error responses', async () => {
+    const streamProvider = new Provider({
+      prepareRequest: requestOptions => ({
+        url: `https://www.myApi.com`,
+        headers: {
+          'X-Custom-Provider-Header': 'value',
+          'X-Provider-Credential-Header': requestOptions.credentials.apiKey as string,
+        },
+      }),
+    });
+
+    const stream = Readable.from(['error test data']);
+
+    nock('https://www.myApi.com').post('/upload').reply(400, 'Bad request error');
+
+    let error;
+    try {
+      await streamProvider.postStream('/upload', stream, {
+        credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+        logger,
+      });
+    } catch (e) {
+      error = e;
+    }
+
+    assert.ok(error instanceof HttpErrors.BadRequestError);
+    assert.equal(error.message, 'Bad request error');
+  });
+
+  it('postStream with rate limiter', async () => {
+    let rateLimiterCalled = false;
+    let rateLimiterCredentials;
+
+    const mockRateLimiter = async (options: any, request: () => Promise<any>) => {
+      rateLimiterCalled = true;
+      rateLimiterCredentials = options.credentials;
+      return request();
+    };
+
+    const rateLimitedProvider = new Provider({
+      prepareRequest: requestOptions => ({
+        url: `https://www.myApi.com`,
+        headers: {
+          'X-Custom-Provider-Header': 'value',
+          'X-Provider-Credential-Header': requestOptions.credentials.apiKey as string,
+        },
+      }),
+      rateLimiter: mockRateLimiter,
+    });
+
+    const testData = 'rate limited data';
+    const stream = Readable.from([testData]);
+
+    nock('https://www.myApi.com').post('/upload', testData).reply(201, { success: true });
+
+    await rateLimitedProvider.postStream('/upload', stream, {
+      credentials: { apiKey: 'apikey#1111', unitoCredentialId: '123' },
+      logger,
+    });
+
+    assert.ok(rateLimiterCalled, 'Rate limiter should have been called');
+    assert.deepEqual(rateLimiterCredentials, {
+      apiKey: 'apikey#1111',
+      unitoCredentialId: '123',
+    });
+  });
 });