@unito/integration-sdk 2.0.2 → 2.1.0

package/dist/src/index.cjs

@@ -1301,6 +1301,33 @@ class Provider {
             },
         });
     }
+    /**
+     * Performs a PUT request to the provider with a Buffer body, typically used for sending binary data.
+     *
+     * IMPORTANT: This method should ONLY be used as a last resort when FormData cannot be used.
+     * It bypasses normal form handling and is used to **manually send chunked** binary data, which may not be appropriate
+     * for all providers. Always be mindful not to load entire binary files in memory!
+     *
+     * Uses the prepareRequest function to get the base URL and any specific headers to add to the request and by default
+     * adds the following headers:
+     * - Content-Type: application/octet-stream
+     * - Accept: application/json
+     *
+     * @param endpoint Path to the provider's resource. Will be added to the URL returned by the prepareRequest function.
+     * @param body The Buffer 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 putBuffer(endpoint, body, options) {
+        return this.fetchWrapper(endpoint, body, {
+            ...options,
+            method: 'PUT',
+            defaultHeaders: {
+                'Content-Type': 'application/octet-stream',
+                Accept: 'application/json',
+            },
+        });
+    }
     /**
      * Performs a PATCH request to the provider.
      *
@@ -1360,14 +1387,20 @@ class Provider {
         const { url: providerUrl, headers: providerHeaders } = await this.prepareRequest(options);
         const absoluteUrl = this.generateAbsoluteUrl(providerUrl, endpoint, options.queryParams);
         const headers = { ...options.defaultHeaders, ...providerHeaders, ...options.additionnalheaders };
-        let stringifiedBody = null;
+        let fetchBody = null;
         if (body) {
             if (headers['Content-Type'] === 'application/x-www-form-urlencoded') {
-                stringifiedBody = new URLSearchParams(body).toString();
+                fetchBody = new URLSearchParams(body).toString();
             }
             else if (headers['Content-Type'] === 'application/json' ||
                 headers['Content-Type'] === 'application/json-patch+json') {
-                stringifiedBody = JSON.stringify(body);
+                fetchBody = JSON.stringify(body);
+            }
+            else if (headers['Content-Type'] === 'application/octet-stream' && body instanceof Buffer) {
+                fetchBody = body;
+            }
+            else {
+                throw this.handleError(400, `Content type not supported: ${headers['Content-Type']}`, options);
             }
         }
         const callToProvider = async () => {
@@ -1376,7 +1409,7 @@ class Provider {
                 response = await fetch(absoluteUrl, {
                     method: options.method,
                     headers,
-                    body: stringifiedBody,
+                    body: fetchBody,
                     ...(options.signal ? { signal: options.signal } : {}),
                 });
             }

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

@@ -165,6 +165,24 @@ export declare class Provider {
      * @returns The {@link Response} extracted from the provider.
      */
     put<T>(endpoint: string, body: RequestBody, options: RequestOptions): Promise<Response<T>>;
+    /**
+     * Performs a PUT request to the provider with a Buffer body, typically used for sending binary data.
+     *
+     * IMPORTANT: This method should ONLY be used as a last resort when FormData cannot be used.
+     * It bypasses normal form handling and is used to **manually send chunked** binary data, which may not be appropriate
+     * for all providers. Always be mindful not to load entire binary files in memory!
+     *
+     * Uses the prepareRequest function to get the base URL and any specific headers to add to the request and by default
+     * adds the following headers:
+     * - Content-Type: application/octet-stream
+     * - Accept: application/json
+     *
+     * @param endpoint Path to the provider's resource. Will be added to the URL returned by the prepareRequest function.
+     * @param body The Buffer 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.
+     */
+    putBuffer<T>(endpoint: string, body: Buffer, options: RequestOptions): Promise<Response<T>>;
     /**
      * Performs a PATCH request to the provider.
      *

package/dist/src/resources/provider.js

@@ -181,6 +181,33 @@ export class Provider {
             },
         });
     }
+    /**
+     * Performs a PUT request to the provider with a Buffer body, typically used for sending binary data.
+     *
+     * IMPORTANT: This method should ONLY be used as a last resort when FormData cannot be used.
+     * It bypasses normal form handling and is used to **manually send chunked** binary data, which may not be appropriate
+     * for all providers. Always be mindful not to load entire binary files in memory!
+     *
+     * Uses the prepareRequest function to get the base URL and any specific headers to add to the request and by default
+     * adds the following headers:
+     * - Content-Type: application/octet-stream
+     * - Accept: application/json
+     *
+     * @param endpoint Path to the provider's resource. Will be added to the URL returned by the prepareRequest function.
+     * @param body The Buffer 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 putBuffer(endpoint, body, options) {
+        return this.fetchWrapper(endpoint, body, {
+            ...options,
+            method: 'PUT',
+            defaultHeaders: {
+                'Content-Type': 'application/octet-stream',
+                Accept: 'application/json',
+            },
+        });
+    }
     /**
      * Performs a PATCH request to the provider.
      *
@@ -240,14 +267,20 @@ export class Provider {
         const { url: providerUrl, headers: providerHeaders } = await this.prepareRequest(options);
         const absoluteUrl = this.generateAbsoluteUrl(providerUrl, endpoint, options.queryParams);
         const headers = { ...options.defaultHeaders, ...providerHeaders, ...options.additionnalheaders };
-        let stringifiedBody = null;
+        let fetchBody = null;
         if (body) {
             if (headers['Content-Type'] === 'application/x-www-form-urlencoded') {
-                stringifiedBody = new URLSearchParams(body).toString();
+                fetchBody = new URLSearchParams(body).toString();
             }
             else if (headers['Content-Type'] === 'application/json' ||
                 headers['Content-Type'] === 'application/json-patch+json') {
-                stringifiedBody = JSON.stringify(body);
+                fetchBody = JSON.stringify(body);
+            }
+            else if (headers['Content-Type'] === 'application/octet-stream' && body instanceof Buffer) {
+                fetchBody = body;
+            }
+            else {
+                throw this.handleError(400, `Content type not supported: ${headers['Content-Type']}`, options);
             }
         }
         const callToProvider = async () => {
@@ -256,7 +289,7 @@ export class Provider {
                 response = await fetch(absoluteUrl, {
                     method: options.method,
                     headers,
-                    body: stringifiedBody,
+                    body: fetchBody,
                     ...(options.signal ? { signal: options.signal } : {}),
                 });
             }

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

@@ -310,6 +310,38 @@ describe('Provider', () => {
         ]);
         assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
     });
+    it('putBuffer with Buffer body', async (context) => {
+        const response = new Response('{"data": "value"}', {
+            status: 201,
+            headers: { 'Content-Type': 'application/json' },
+        });
+        const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
+        const buffer = Buffer.from('binary data content');
+        // What matters is that the body of put is a buffer
+        const actualResponse = await provider.putBuffer('endpoint/123', buffer, {
+            credentials: { apiKey: 'apikey#1111' },
+            logger: logger,
+            signal: new AbortController().signal,
+            additionnalheaders: { 'X-Additional-Header': 'value1', 'Content-Type': 'application/octet-stream' },
+        });
+        assert.equal(fetchMock.mock.calls.length, 1);
+        assert.deepEqual(fetchMock.mock.calls[0]?.arguments, [
+            'www.myApi.com/endpoint/123',
+            {
+                method: 'PUT',
+                body: buffer,
+                signal: new AbortController().signal,
+                headers: {
+                    'Content-Type': 'application/octet-stream',
+                    Accept: 'application/json',
+                    'X-Custom-Provider-Header': 'value',
+                    'X-Provider-Credential-Header': 'apikey#1111',
+                    'X-Additional-Header': 'value1',
+                },
+            },
+        ]);
+        assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
+    });
     it('patch with query params', async (context) => {
         const response = new Response('{"data": "value"}', {
             status: 201,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-sdk",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Integration SDK",
   "type": "module",
   "types": "dist/src/index.d.ts",

package/src/resources/provider.ts

@@ -274,6 +274,34 @@ export class Provider {
     });
   }
 
+  /**
+   * Performs a PUT request to the provider with a Buffer body, typically used for sending binary data.
+   *
+   * IMPORTANT: This method should ONLY be used as a last resort when FormData cannot be used.
+   * It bypasses normal form handling and is used to **manually send chunked** binary data, which may not be appropriate
+   * for all providers. Always be mindful not to load entire binary files in memory!
+   *
+   * Uses the prepareRequest function to get the base URL and any specific headers to add to the request and by default
+   * adds the following headers:
+   * - Content-Type: application/octet-stream
+   * - Accept: application/json
+   *
+   * @param endpoint Path to the provider's resource. Will be added to the URL returned by the prepareRequest function.
+   * @param body The Buffer 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 putBuffer<T>(endpoint: string, body: Buffer, options: RequestOptions): Promise<Response<T>> {
+    return this.fetchWrapper<T>(endpoint, body, {
+      ...options,
+      method: 'PUT',
+      defaultHeaders: {
+        'Content-Type': 'application/octet-stream',
+        Accept: 'application/json',
+      },
+    });
+  }
+
   /**
    * Performs a PATCH request to the provider.
    *
@@ -335,23 +363,27 @@ export class Provider {
 
   private async fetchWrapper<T>(
     endpoint: string,
-    body: RequestBody | null,
+    body: RequestBody | Buffer | null,
     options: RequestOptions & { defaultHeaders: { 'Content-Type'?: string; Accept?: string }; method: string },
   ): Promise<Response<T>> {
     const { url: providerUrl, headers: providerHeaders } = await this.prepareRequest(options);
     const absoluteUrl = this.generateAbsoluteUrl(providerUrl, endpoint, options.queryParams);
     const headers = { ...options.defaultHeaders, ...providerHeaders, ...options.additionnalheaders };
 
-    let stringifiedBody: string | null = null;
+    let fetchBody: string | Buffer | null = null;
 
     if (body) {
       if (headers['Content-Type'] === 'application/x-www-form-urlencoded') {
-        stringifiedBody = new URLSearchParams(body as Record<string, string>).toString();
+        fetchBody = new URLSearchParams(body as Record<string, string>).toString();
       } else if (
         headers['Content-Type'] === 'application/json' ||
         headers['Content-Type'] === 'application/json-patch+json'
       ) {
-        stringifiedBody = JSON.stringify(body);
+        fetchBody = JSON.stringify(body);
+      } else if (headers['Content-Type'] === 'application/octet-stream' && body instanceof Buffer) {
+        fetchBody = body;
+      } else {
+        throw this.handleError(400, `Content type not supported: ${headers['Content-Type']}`, options);
       }
     }
 
@@ -362,7 +394,7 @@ export class Provider {
         response = await fetch(absoluteUrl, {
           method: options.method,
           headers,
-          body: stringifiedBody,
+          body: fetchBody,
           ...(options.signal ? { signal: options.signal } : {}),
         });
       } catch (error) {

package/test/resources/provider.test.ts

@@ -375,6 +375,43 @@ describe('Provider', () => {
     assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
   });
 
+  it('putBuffer with Buffer body', async context => {
+    const response = new Response('{"data": "value"}', {
+      status: 201,
+      headers: { 'Content-Type': 'application/json' },
+    });
+
+    const fetchMock = context.mock.method(global, 'fetch', () => Promise.resolve(response));
+
+    const buffer = Buffer.from('binary data content');
+
+    // What matters is that the body of put is a buffer
+    const actualResponse = await provider.putBuffer('endpoint/123', buffer, {
+      credentials: { apiKey: 'apikey#1111' },
+      logger: logger,
+      signal: new AbortController().signal,
+      additionnalheaders: { 'X-Additional-Header': 'value1', 'Content-Type': 'application/octet-stream' },
+    });
+
+    assert.equal(fetchMock.mock.calls.length, 1);
+    assert.deepEqual(fetchMock.mock.calls[0]?.arguments, [
+      'www.myApi.com/endpoint/123',
+      {
+        method: 'PUT',
+        body: buffer,
+        signal: new AbortController().signal,
+        headers: {
+          'Content-Type': 'application/octet-stream',
+          Accept: 'application/json',
+          'X-Custom-Provider-Header': 'value',
+          'X-Provider-Credential-Header': 'apikey#1111',
+          'X-Additional-Header': 'value1',
+        },
+      },
+    ]);
+    assert.deepEqual(actualResponse, { status: 201, headers: response.headers, body: { data: 'value' } });
+  });
+
   it('patch with query params', async context => {
     const response = new Response('{"data": "value"}', {
       status: 201,