@unito/integration-sdk 1.4.1 → 1.4.3

package/dist/src/index.cjs

@@ -1184,6 +1184,7 @@ class Provider {
             defaultHeaders: {
                 Accept: 'application/octet-stream',
             },
+            rawBody: true,
         });
     }
     /**
@@ -1365,7 +1366,7 @@ class Provider {
                         case 'TimeoutError':
                             throw this.handleError(408, 'Request timeout', options);
                     }
-                    throw this.handleError(500, `Unexpected error while calling the provider: name: "${error.name}" \n message: "${error.message}" \n stack: ${error.stack}`, options);
+                    throw this.handleError(500, `Unexpected error while calling the provider. ErrorName: "${error.name}" \n message: "${error.message}" \n stack: ${error.stack} \n cause: ${error.cause} \n causeStack: ${error.cause?.stack}`, options);
                 }
                 throw this.handleError(500, 'Unexpected error while calling the provider - this is not normal, investigate', options);
             }
@@ -1375,7 +1376,11 @@ class Provider {
             }
             const responseContentType = response.headers.get('content-type');
             let body;
-            if (headers.Accept === 'application/json') {
+            if (options.rawBody || headers.Accept === 'application/octet-stream') {
+                // When we expect octet-stream, we accept any Content-Type the provider sends us, we just want to stream it
+                body = response.body;
+            }
+            else if (headers.Accept === 'application/json') {
                 // Validate that the response content type is at least similar to what we expect
                 // (Provider's response Content-Type might be more specific, e.g. application/json;charset=utf-8)
                 // Default to application/json if no Content-Type header is provided
@@ -1391,10 +1396,6 @@ class Provider {
                     throw this.handleError(500, `Invalid JSON response`, options);
                 }
             }
-            else if (headers.Accept == 'application/octet-stream') {
-                // When we expect octet-stream, we accept any Content-Type the provider sends us, we just want to stream it.
-                body = response.body;
-            }
             else if (headers.Accept?.includes('text/html')) {
                 // Accept text based content types
                 body = (await response.text());

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

@@ -29,6 +29,7 @@ export type RateLimiter = <T>(options: {
  * @property logger - The logger to use during the call.
  * @property queryParams - The query parameters to add when calling the provider.
  * @property additionnalheaders - The headers to add when calling the provider.
+ * @property rawBody - Whether to return the raw response body.
  */
 export type RequestOptions = {
     credentials: Credentials;
@@ -40,6 +41,7 @@ export type RequestOptions = {
     additionnalheaders?: {
         [key: string]: string;
     };
+    rawBody?: boolean;
 };
 /**
  * Response object returned by the Provider's method.

package/dist/src/resources/provider.js

@@ -85,6 +85,7 @@ export class Provider {
             defaultHeaders: {
                 Accept: 'application/octet-stream',
             },
+            rawBody: true,
         });
     }
     /**
@@ -266,7 +267,7 @@ export class Provider {
                         case 'TimeoutError':
                             throw this.handleError(408, 'Request timeout', options);
                     }
-                    throw this.handleError(500, `Unexpected error while calling the provider: name: "${error.name}" \n message: "${error.message}" \n stack: ${error.stack}`, options);
+                    throw this.handleError(500, `Unexpected error while calling the provider. ErrorName: "${error.name}" \n message: "${error.message}" \n stack: ${error.stack} \n cause: ${error.cause} \n causeStack: ${error.cause?.stack}`, options);
                 }
                 throw this.handleError(500, 'Unexpected error while calling the provider - this is not normal, investigate', options);
             }
@@ -276,7 +277,11 @@ export class Provider {
             }
             const responseContentType = response.headers.get('content-type');
             let body;
-            if (headers.Accept === 'application/json') {
+            if (options.rawBody || headers.Accept === 'application/octet-stream') {
+                // When we expect octet-stream, we accept any Content-Type the provider sends us, we just want to stream it
+                body = response.body;
+            }
+            else if (headers.Accept === 'application/json') {
                 // Validate that the response content type is at least similar to what we expect
                 // (Provider's response Content-Type might be more specific, e.g. application/json;charset=utf-8)
                 // Default to application/json if no Content-Type header is provided
@@ -292,10 +297,6 @@ export class Provider {
                     throw this.handleError(500, `Invalid JSON response`, options);
                 }
             }
-            else if (headers.Accept == 'application/octet-stream') {
-                // When we expect octet-stream, we accept any Content-Type the provider sends us, we just want to stream it.
-                body = response.body;
-            }
             else if (headers.Accept?.includes('text/html')) {
                 // Accept text based content types
                 body = (await response.text());

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

@@ -79,6 +79,25 @@ describe('Provider', () => {
         ]);
         assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: '' });
     });
+    it('should return the raw response body if specified', async (context) => {
+        const response = new Response(`IMAGINE A HUGE PAYLOAD`, {
+            status: 200,
+            headers: { 'Content-Type': 'image/png' },
+        });
+        context.mock.method(global, 'fetch', () => Promise.resolve(response));
+        const providerResponse = await provider.streamingGet('/endpoint/123', {
+            credentials: { apiKey: 'apikey#1111' },
+            logger: logger,
+            signal: new AbortController().signal,
+            additionnalheaders: {
+                Accept: 'application/json',
+            },
+            rawBody: true,
+        });
+        assert.ok(providerResponse);
+        // What matters: still returns a stream
+        assert.ok(providerResponse.body instanceof ReadableStream);
+    });
     it('gets an endpoint which is an absolute url', async (context) => {
         const response = new Response('{"data": "value"}', {
             status: 200,
@@ -534,7 +553,7 @@ describe('Provider', () => {
     });
     it('throws on unknown errors', async (context) => {
         context.mock.method(global, 'fetch', () => {
-            throw new Error('foo');
+            throw new TypeError('foo', { cause: new Error('bar') });
         });
         let error;
         try {
@@ -548,10 +567,12 @@ describe('Provider', () => {
             error = e;
         }
         assert.ok(error instanceof HttpErrors.HttpError);
-        assert.ok(error.message.startsWith('Unexpected error while calling the provider:'));
-        assert.ok(error.message.includes('name: "Error"'));
+        assert.ok(error.message.startsWith('Unexpected error while calling the provider.'));
+        assert.ok(error.message.includes('ErrorName: "TypeError"'));
         assert.ok(error.message.includes('message: "foo"'));
         assert.ok(error.message.includes('stack:'));
+        assert.ok(error.message.includes('cause:'));
+        assert.ok(error.message.includes('causeStack:'));
     });
     it('throws on status 429', async (context) => {
         const response = new Response('response body', {

package/package.json

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

package/src/resources/provider.ts

@@ -34,6 +34,7 @@ export type RateLimiter = <T>(
  * @property logger - The logger to use during the call.
  * @property queryParams - The query parameters to add when calling the provider.
  * @property additionnalheaders - The headers to add when calling the provider.
+ * @property rawBody - Whether to return the raw response body.
  */
 export type RequestOptions = {
   credentials: Credentials;
@@ -41,6 +42,7 @@ export type RequestOptions = {
   signal?: AbortSignal;
   queryParams?: { [key: string]: string };
   additionnalheaders?: { [key: string]: string };
+  rawBody?: boolean;
 };
 
 /**
@@ -166,6 +168,7 @@ export class Provider {
       defaultHeaders: {
         Accept: 'application/octet-stream',
       },
+      rawBody: true,
     });
   }
 
@@ -369,9 +372,10 @@ export class Provider {
             case 'TimeoutError':
               throw this.handleError(408, 'Request timeout', options);
           }
+
           throw this.handleError(
             500,
-            `Unexpected error while calling the provider: name: "${error.name}" \n message: "${error.message}" \n stack: ${error.stack}`,
+            `Unexpected error while calling the provider. ErrorName: "${error.name}" \n message: "${error.message}" \n stack: ${error.stack} \n cause: ${error.cause} \n causeStack: ${(error.cause as Error)?.stack}`,
             options,
           );
         }
@@ -391,7 +395,10 @@ export class Provider {
       const responseContentType = response.headers.get('content-type');
       let body: T;
 
-      if (headers.Accept === 'application/json') {
+      if (options.rawBody || headers.Accept === 'application/octet-stream') {
+        // When we expect octet-stream, we accept any Content-Type the provider sends us, we just want to stream it
+        body = response.body as T;
+      } else if (headers.Accept === 'application/json') {
         // Validate that the response content type is at least similar to what we expect
         // (Provider's response Content-Type might be more specific, e.g. application/json;charset=utf-8)
         // Default to application/json if no Content-Type header is provided
@@ -410,9 +417,6 @@ export class Provider {
         } catch (err) {
           throw this.handleError(500, `Invalid JSON response`, options);
         }
-      } else if (headers.Accept == 'application/octet-stream') {
-        // When we expect octet-stream, we accept any Content-Type the provider sends us, we just want to stream it.
-        body = response.body as T;
       } else if (headers.Accept?.includes('text/html')) {
         // Accept text based content types
         body = (await response.text()) as T;

package/test/resources/provider.test.ts

@@ -94,6 +94,29 @@ describe('Provider', () => {
     assert.deepEqual(actualResponse, { status: 200, headers: response.headers, body: '' });
   });
 
+  it('should return the raw response body if specified', async context => {
+    const response = new Response(`IMAGINE A HUGE PAYLOAD`, {
+      status: 200,
+      headers: { 'Content-Type': 'image/png' },
+    });
+
+    context.mock.method(global, 'fetch', () => Promise.resolve(response));
+
+    const providerResponse = await provider.streamingGet('/endpoint/123', {
+      credentials: { apiKey: 'apikey#1111' },
+      logger: logger,
+      signal: new AbortController().signal,
+      additionnalheaders: {
+        Accept: 'application/json',
+      },
+      rawBody: true,
+    });
+
+    assert.ok(providerResponse);
+    // What matters: still returns a stream
+    assert.ok(providerResponse.body instanceof ReadableStream);
+  });
+
   it('gets an endpoint which is an absolute url', async context => {
     const response = new Response('{"data": "value"}', {
       status: 200,
@@ -635,7 +658,7 @@ describe('Provider', () => {
 
   it('throws on unknown errors', async context => {
     context.mock.method(global, 'fetch', () => {
-      throw new Error('foo');
+      throw new TypeError('foo', { cause: new Error('bar') });
     });
 
     let error;
@@ -651,10 +674,12 @@ describe('Provider', () => {
     }
 
     assert.ok(error instanceof HttpErrors.HttpError);
-    assert.ok(error.message.startsWith('Unexpected error while calling the provider:'));
-    assert.ok(error.message.includes('name: "Error"'));
+    assert.ok(error.message.startsWith('Unexpected error while calling the provider.'));
+    assert.ok(error.message.includes('ErrorName: "TypeError"'));
     assert.ok(error.message.includes('message: "foo"'));
     assert.ok(error.message.includes('stack:'));
+    assert.ok(error.message.includes('cause:'));
+    assert.ok(error.message.includes('causeStack:'));
   });
 
   it('throws on status 429', async context => {