@unito/integrations-platform-client 1.0.0 → 1.0.2

package/dist/src/addons.d.ts

@@ -1,23 +1,54 @@
 import * as IntegrationApi from '@unito/integration-api';
 import * as Oazapfts from '@oazapfts/runtime';
+import { HttpError } from '@oazapfts/runtime';
+export { HttpError };
+import { Error } from './api.js';
 /**
+ * Provides a type guard for ItemResponse.
+ *
  * Return true if object has the shape of an item, false otherwise.
  * @param object
  */
 export declare function isItemResponse(object: unknown): object is Response<IntegrationApi.Item>;
 /**
- * Return true if object has the shape of an item, false otherwise.
+ * Provides a type guard for ItemSummaryResponse.
+ *
+ * Return true if object has the shape of an item summary, false otherwise.
  * @param object
  */
 export declare function isItemSummaryResponse(object: unknown): object is Response<IntegrationApi.ItemSummary>;
 /**
+ * Provides a type guard for CollectionResponse.
+ *
  * Return true if object has the shape of a collection, false otherwise.
  * @param object
  */
 export declare function isCollectionResponse(object: unknown): object is Response<IntegrationApi.Collection>;
+/**
+ * Provides a type guard for ErrorResponse.
+ *
+ * Return true if object has the shape of an error response, false otherwise.
+ * @param object
+ */
 export declare function isErrorResponse(object: unknown): object is ErrorResponse;
-type Response<T> = {
+/**
+ * Opt-in optimistic mode.
+ *
+ * Returns the typed response's data if it's a success, otherwise throws an HttpError.
+ *
+ * @param response received from the Integrations Platform Client
+ * @returns the response's data, typed, if it's a success
+ */
+export declare function optimistic<T>(asyncResponse: Promise<Response<T> | ErrorResponse>): Promise<T>;
+type Response<T> = ({
     status: 200;
+} | {
+    status: 201;
+} | {
+    status: 202;
+} | {
+    status: 204;
+}) & {
     data: T;
     headers: Headers;
 };
@@ -43,24 +74,81 @@ type ErrorResponse = ({
     data: Error;
     headers: Headers;
 };
+/**
+ * Wrapper of getProxyGraph that returns a typed response containing an Item upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an Item, or an ErrorResponse
+ */
 export declare function getProxyGraphItem(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
     xUnitoCorrelationId?: string;
     xUnitoAdditionalLoggingContext?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Response<IntegrationApi.Item> | ErrorResponse>;
+/**
+ * Wrapper of getProxyGraph that returns a typed response containing a Collection upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an Collection, or an ErrorResponse
+ */
 export declare function getProxyGraphCollection(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
     xUnitoCorrelationId?: string;
     xUnitoAdditionalLoggingContext?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Response<IntegrationApi.Collection> | ErrorResponse>;
+/**
+ * Wrapper of patchProxyGraph that returns a typed response containing the updated Item upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an Item, or an ErrorResponse
+ */
 export declare function patchProxyGraphItem(xUnitoCredentialId: string, path: string, body?: object, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
     xUnitoCorrelationId?: string;
     xUnitoAdditionalLoggingContext?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Response<IntegrationApi.Item> | ErrorResponse>;
+/**
+ * Wrapper of postProxyGraph that returns a typed response containing the created ItemSummary upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an ItemSummary, or an ErrorResponse
+ */
 export declare function postProxyGraphCollection(xUnitoCredentialId: string, path: string, body?: object, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
     xUnitoCorrelationId?: string;
     xUnitoAdditionalLoggingContext?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Response<IntegrationApi.ItemSummary> | ErrorResponse>;
+/**
+ * Wrapper of deleteProxyGraph added for uniformity, doesn't provide much typing help.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ */
 export declare function deleteProxyGraphItem(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
     xUnitoCorrelationId?: string;
     xUnitoAdditionalLoggingContext?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<void>;
-export {};
+/**
+ * Call an integration's graph and returns the fetch response directly to enable streaming of the body as it comes in.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers Base headers to add to the request
+ * @param additionalHeaders Additional headers to add to the request
+ * @returns fetch's response
+ */
+export declare function fetchProxyGraph(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, accept, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+    accept?: string;
+}, init?: RequestInit): Promise<globalThis.Response>;

package/dist/src/addons.js

@@ -1,6 +1,13 @@
 // MANUAL ADDONS
-import { getProxyGraph, patchProxyGraph, postProxyGraph, deleteProxyGraph } from './api.js';
+import * as Oazapfts from '@oazapfts/runtime';
+import * as QS from '@oazapfts/runtime/query';
+import { HttpError } from '@oazapfts/runtime';
+export { HttpError };
+import { defaults, getProxyGraph, patchProxyGraph, postProxyGraph, deleteProxyGraph } from './api.js';
+const oazapfts = Oazapfts.runtime(defaults);
 /**
+ * Provides a type guard for ItemResponse.
+ *
  * Return true if object has the shape of an item, false otherwise.
  * @param object
  */
@@ -9,7 +16,9 @@ export function isItemResponse(object) {
     return !!object && !!data && typeof data === 'object' && 'fields' in data && 'relations' in data;
 }
 /**
- * Return true if object has the shape of an item, false otherwise.
+ * Provides a type guard for ItemSummaryResponse.
+ *
+ * Return true if object has the shape of an item summary, false otherwise.
  * @param object
  */
 export function isItemSummaryResponse(object) {
@@ -17,6 +26,8 @@ export function isItemSummaryResponse(object) {
     return !!object && !!data && typeof data === 'object' && 'path' in data;
 }
 /**
+ * Provides a type guard for CollectionResponse.
+ *
  * Return true if object has the shape of a collection, false otherwise.
  * @param object
  */
@@ -24,10 +35,40 @@ export function isCollectionResponse(object) {
     const data = object.data;
     return !!object && !!data && typeof data === 'object' && 'info' in data && 'data' in data && Array.isArray(data.data);
 }
+/**
+ * Provides a type guard for ErrorResponse.
+ *
+ * Return true if object has the shape of an error response, false otherwise.
+ * @param object
+ */
 export function isErrorResponse(object) {
     const status = object.status;
     return !!object && typeof object === 'object' && status && status >= 400 && 'data' in object && 'headers' in object;
 }
+/**
+ * Opt-in optimistic mode.
+ *
+ * Returns the typed response's data if it's a success, otherwise throws an HttpError.
+ *
+ * @param response received from the Integrations Platform Client
+ * @returns the response's data, typed, if it's a success
+ */
+export async function optimistic(asyncResponse) {
+    const response = await asyncResponse;
+    if (isErrorResponse(response)) {
+        throw new HttpError(response.status, response.data, response.headers);
+    }
+    return response.data;
+}
+/**
+ * Wrapper of getProxyGraph that returns a typed response containing an Item upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an Item, or an ErrorResponse
+ */
 export async function getProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     const response = await getProxyGraph(xUnitoCredentialId, path, {
         xUnitoCorrelationId,
@@ -40,6 +81,15 @@ export async function getProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrel
         throw new Error(`Response does not match expected Item shape`);
     }
 }
+/**
+ * Wrapper of getProxyGraph that returns a typed response containing a Collection upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an Collection, or an ErrorResponse
+ */
 export async function getProxyGraphCollection(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     const response = await getProxyGraph(xUnitoCredentialId, path, {
         xUnitoCorrelationId,
@@ -52,6 +102,15 @@ export async function getProxyGraphCollection(xUnitoCredentialId, path, { xUnito
         throw new Error(`Response does not match expected Collection shape`);
     }
 }
+/**
+ * Wrapper of patchProxyGraph that returns a typed response containing the updated Item upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an Item, or an ErrorResponse
+ */
 export async function patchProxyGraphItem(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     const response = await patchProxyGraph(xUnitoCredentialId, path, body, {
         xUnitoCorrelationId,
@@ -64,6 +123,15 @@ export async function patchProxyGraphItem(xUnitoCredentialId, path, body, { xUni
         throw new Error(`Response does not match expected Item shape`);
     }
 }
+/**
+ * Wrapper of postProxyGraph that returns a typed response containing the created ItemSummary upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an ItemSummary, or an ErrorResponse
+ */
 export async function postProxyGraphCollection(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     const response = await postProxyGraph(xUnitoCredentialId, path, body, {
         xUnitoCorrelationId,
@@ -76,9 +144,39 @@ export async function postProxyGraphCollection(xUnitoCredentialId, path, body, {
         throw new Error(`Response does not match expected ItemSummary shape`);
     }
 }
+/**
+ * Wrapper of deleteProxyGraph added for uniformity, doesn't provide much typing help.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ */
 export async function deleteProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     await deleteProxyGraph(xUnitoCredentialId, path, {
         xUnitoCorrelationId,
         xUnitoAdditionalLoggingContext,
     }, opts);
 }
+/**
+ * Call an integration's graph and returns the fetch response directly to enable streaming of the body as it comes in.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers Base headers to add to the request
+ * @param additionalHeaders Additional headers to add to the request
+ * @returns fetch's response
+ */
+export async function fetchProxyGraph(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, accept, } = {}, init) {
+    return fetch(`${defaults.baseUrl}/proxy/graph${QS.query(QS.explode({ path }))}`, {
+        ...(init ?? {}),
+        headers: oazapfts.mergeHeaders({
+            ...defaults.headers,
+            ...(init?.headers ?? {}),
+            'X-Unito-Credential-Id': xUnitoCredentialId,
+            'X-Unito-Correlation-Id': xUnitoCorrelationId,
+            'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
+            Accept: accept,
+        }),
+    });
+}

package/dist/src/api.d.ts

@@ -906,9 +906,15 @@ export declare function getProxyMe(xUnitoCredentialId: string, { xUnitoCorrelati
 } | {
     status: 404;
     data: Error;
+} | {
+    status: 410;
+    data: Error;
 } | {
     status: 422;
     data: Error;
+} | {
+    status: 423;
+    data: Error;
 } | {
     status: 500;
     data: Error;
@@ -939,9 +945,15 @@ export declare function updateWebhookSubscription(xUnitoCredentialId: string, bo
 } | {
     status: 404;
     data: Error;
+} | {
+    status: 410;
+    data: Error;
 } | {
     status: 422;
     data: Error;
+} | {
+    status: 423;
+    data: Error;
 } | {
     status: 500;
     data: Error;
@@ -977,6 +989,9 @@ export declare function getProxyGraph(xUnitoCredentialId: string, path: string,
 } | {
     status: 422;
     data: Error;
+} | {
+    status: 423;
+    data: Error;
 } | {
     status: 500;
     data: Error;
@@ -1012,6 +1027,9 @@ export declare function patchProxyGraph(xUnitoCredentialId: string, path: string
 } | {
     status: 422;
     data: Error;
+} | {
+    status: 423;
+    data: Error;
 } | {
     status: 500;
     data: Error;
@@ -1047,6 +1065,9 @@ export declare function postProxyGraph(xUnitoCredentialId: string, path: string,
 } | {
     status: 422;
     data: Error;
+} | {
+    status: 423;
+    data: Error;
 } | {
     status: 500;
     data: Error;
@@ -1081,6 +1102,9 @@ export declare function deleteProxyGraph(xUnitoCredentialId: string, path: strin
 } | {
     status: 422;
     data: Error;
+} | {
+    status: 423;
+    data: Error;
 } | {
     status: 500;
     data: Error;

package/dist/src/index.cjs

@@ -33,7 +33,7 @@ const defaults = {
     headers: {},
     baseUrl: 'http://localhost:9000',
 };
-const oazapfts = Oazapfts__namespace.runtime(defaults);
+const oazapfts$1 = Oazapfts__namespace.runtime(defaults);
 const servers = {
     local: 'http://localhost:9000',
     staging: 'https://staging-integrations-platform.unito.io',
@@ -43,7 +43,7 @@ const servers = {
  * Get all the integrations
  */
 function getIntegrations({ pagination, unitoOrganizationId, search, } = {}, opts) {
-    return oazapfts.fetchJson(`/integrations${QS__namespace.query(QS__namespace.explode({
+    return oazapfts$1.fetchJson(`/integrations${QS__namespace.query(QS__namespace.explode({
         pagination,
         unitoOrganizationId,
         search,
@@ -55,7 +55,7 @@ function getIntegrations({ pagination, unitoOrganizationId, search, } = {}, opts
  * Create an integration
  */
 function createIntegration(body, opts) {
-    return oazapfts.fetchJson('/integrations', oazapfts.json({
+    return oazapfts$1.fetchJson('/integrations', oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
@@ -65,7 +65,7 @@ function createIntegration(body, opts) {
  * Publish an integration
  */
 function publishIntegration(body, opts) {
-    return oazapfts.fetchJson('/integrations/publish', oazapfts.multipart({
+    return oazapfts$1.fetchJson('/integrations/publish', oazapfts$1.multipart({
         ...opts,
         method: 'POST',
         body,
@@ -75,7 +75,7 @@ function publishIntegration(body, opts) {
  * Find an integration by exact name
  */
 function getIntegrationByName(integrationName, opts) {
-    return oazapfts.fetchJson(`/integrations/find/${encodeURIComponent(integrationName)}`, {
+    return oazapfts$1.fetchJson(`/integrations/find/${encodeURIComponent(integrationName)}`, {
         ...opts,
     });
 }
@@ -83,7 +83,7 @@ function getIntegrationByName(integrationName, opts) {
  * Invite a user to an integration
  */
 function inviteUser(integrationId, body, opts) {
-    return oazapfts.fetchJson(`/integrations/${encodeURIComponent(integrationId)}/users/invite`, oazapfts.json({
+    return oazapfts$1.fetchJson(`/integrations/${encodeURIComponent(integrationId)}/users/invite`, oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
@@ -93,7 +93,7 @@ function inviteUser(integrationId, body, opts) {
  * Invite a unito organization to an integration
  */
 function inviteOrganization(integrationId, body, opts) {
-    return oazapfts.fetchJson(`/integrations/${encodeURIComponent(integrationId)}/organizations/invite`, oazapfts.json({
+    return oazapfts$1.fetchJson(`/integrations/${encodeURIComponent(integrationId)}/organizations/invite`, oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
@@ -103,7 +103,7 @@ function inviteOrganization(integrationId, body, opts) {
  * Get an integration
  */
 function getIntegrationById(integrationId, opts) {
-    return oazapfts.fetchJson(`/integrations/${encodeURIComponent(integrationId)}`, {
+    return oazapfts$1.fetchJson(`/integrations/${encodeURIComponent(integrationId)}`, {
         ...opts,
     });
 }
@@ -111,7 +111,7 @@ function getIntegrationById(integrationId, opts) {
  * Update an integration
  */
 function updateIntegration(integrationId, body, opts) {
-    return oazapfts.fetchJson(`/integrations/${encodeURIComponent(integrationId)}`, oazapfts.json({
+    return oazapfts$1.fetchJson(`/integrations/${encodeURIComponent(integrationId)}`, oazapfts$1.json({
         ...opts,
         method: 'PATCH',
         body,
@@ -121,7 +121,7 @@ function updateIntegration(integrationId, body, opts) {
  * Delete an integration
  */
 function deleteIntegration(integrationId, name, opts) {
-    return oazapfts.fetchJson(`/integrations/${encodeURIComponent(integrationId)}${QS__namespace.query(QS__namespace.explode({
+    return oazapfts$1.fetchJson(`/integrations/${encodeURIComponent(integrationId)}${QS__namespace.query(QS__namespace.explode({
         name,
     }))}`, {
         ...opts,
@@ -132,7 +132,7 @@ function deleteIntegration(integrationId, name, opts) {
  * Get the events associated with this integration.
  */
 function getIntegrationEvents(integrationId, { search, $from, limit, } = {}, opts) {
-    return oazapfts.fetchJson(`/integrations/${encodeURIComponent(integrationId)}/events${QS__namespace.query(QS__namespace.explode({
+    return oazapfts$1.fetchJson(`/integrations/${encodeURIComponent(integrationId)}/events${QS__namespace.query(QS__namespace.explode({
         search,
         from: $from,
         limit,
@@ -144,7 +144,7 @@ function getIntegrationEvents(integrationId, { search, $from, limit, } = {}, opt
  * Get the logo of the integration, in SVG format.
  */
 function getIntegrationLogo(integrationName, opts) {
-    return oazapfts.fetchJson(`/public/${encodeURIComponent(integrationName)}/logo.svg`, {
+    return oazapfts$1.fetchJson(`/public/${encodeURIComponent(integrationName)}/logo.svg`, {
         ...opts,
     });
 }
@@ -152,7 +152,7 @@ function getIntegrationLogo(integrationName, opts) {
  * Get all the credentials
  */
 function getCredentials({ pagination, filters, } = {}, opts) {
-    return oazapfts.fetchJson(`/credentials${QS__namespace.query(QS__namespace.explode({
+    return oazapfts$1.fetchJson(`/credentials${QS__namespace.query(QS__namespace.explode({
         pagination,
         filters,
     }))}`, {
@@ -163,7 +163,7 @@ function getCredentials({ pagination, filters, } = {}, opts) {
  * Create a credential
  */
 function createCredential(body, opts) {
-    return oazapfts.fetchJson('/credentials', oazapfts.json({
+    return oazapfts$1.fetchJson('/credentials', oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
@@ -173,7 +173,7 @@ function createCredential(body, opts) {
  * Get a credential
  */
 function getCredentialById(credentialId, opts) {
-    return oazapfts.fetchJson(`/credentials/${encodeURIComponent(credentialId)}`, {
+    return oazapfts$1.fetchJson(`/credentials/${encodeURIComponent(credentialId)}`, {
         ...opts,
     });
 }
@@ -181,7 +181,7 @@ function getCredentialById(credentialId, opts) {
  * Update a credential
  */
 function updateCredential(credentialId, body, opts) {
-    return oazapfts.fetchJson(`/credentials/${encodeURIComponent(credentialId)}`, oazapfts.json({
+    return oazapfts$1.fetchJson(`/credentials/${encodeURIComponent(credentialId)}`, oazapfts$1.json({
         ...opts,
         method: 'PATCH',
         body,
@@ -191,7 +191,7 @@ function updateCredential(credentialId, body, opts) {
  * Delete a credential
  */
 function deleteCredential(credentialId, opts) {
-    return oazapfts.fetchJson(`/credentials/${encodeURIComponent(credentialId)}`, {
+    return oazapfts$1.fetchJson(`/credentials/${encodeURIComponent(credentialId)}`, {
         ...opts,
         method: 'DELETE',
     });
@@ -200,9 +200,9 @@ function deleteCredential(credentialId, opts) {
  * Returns the credentialAccount either from the integration's /me endpoint, if available, or the credential's latestCredentialAccount
  */
 function getCredentialAccount(xUnitoCredentialId, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
-    return oazapfts.fetchJson('/credentialAccount', {
+    return oazapfts$1.fetchJson('/credentialAccount', {
         ...opts,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
+        headers: oazapfts$1.mergeHeaders(opts?.headers, {
             'X-Unito-Credential-Id': xUnitoCredentialId,
             'X-Unito-Correlation-Id': xUnitoCorrelationId,
             'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
@@ -213,7 +213,7 @@ function getCredentialAccount(xUnitoCredentialId, { xUnitoCorrelationId, xUnitoA
  * Used by the frontend to send analytics data
  */
 function postTrack(body, opts) {
-    return oazapfts.fetchJson('/track', oazapfts.json({
+    return oazapfts$1.fetchJson('/track', oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
@@ -223,7 +223,7 @@ function postTrack(body, opts) {
  * Encrypt data
  */
 function encryptData(body, opts) {
-    return oazapfts.fetchJson('/encryptions/encrypt', oazapfts.json({
+    return oazapfts$1.fetchJson('/encryptions/encrypt', oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
@@ -233,7 +233,7 @@ function encryptData(body, opts) {
  * Decrypt data
  */
 function decryptData(body, opts) {
-    return oazapfts.fetchJson('/encryptions/decrypt', oazapfts.json({
+    return oazapfts$1.fetchJson('/encryptions/decrypt', oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
@@ -243,7 +243,7 @@ function decryptData(body, opts) {
  * Decrypt and encrypt data
  */
 function reencryptData(body, opts) {
-    return oazapfts.fetchJson('/encryptions/reencrypt', oazapfts.json({
+    return oazapfts$1.fetchJson('/encryptions/reencrypt', oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
@@ -253,7 +253,7 @@ function reencryptData(body, opts) {
  * Get my profile
  */
 function getProfile(opts) {
-    return oazapfts.fetchJson('/profile', {
+    return oazapfts$1.fetchJson('/profile', {
         ...opts,
     });
 }
@@ -261,7 +261,7 @@ function getProfile(opts) {
  * Update my profile
  */
 function updateProfile(body, opts) {
-    return oazapfts.fetchJson('/profile', oazapfts.json({
+    return oazapfts$1.fetchJson('/profile', oazapfts$1.json({
         ...opts,
         method: 'PATCH',
         body,
@@ -271,9 +271,9 @@ function updateProfile(body, opts) {
  * Call an integration's me
  */
 function getProxyMe(xUnitoCredentialId, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
-    return oazapfts.fetchJson('/proxy/me', {
+    return oazapfts$1.fetchJson('/proxy/me', {
         ...opts,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
+        headers: oazapfts$1.mergeHeaders(opts?.headers, {
             'X-Unito-Credential-Id': xUnitoCredentialId,
             'X-Unito-Correlation-Id': xUnitoCorrelationId,
             'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
@@ -284,11 +284,11 @@ function getProxyMe(xUnitoCredentialId, { xUnitoCorrelationId, xUnitoAdditionalL
  * Update a webhook subscription
  */
 function updateWebhookSubscription(xUnitoCredentialId, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
-    return oazapfts.fetchJson('/proxy/webhooks/subscriptions', oazapfts.json({
+    return oazapfts$1.fetchJson('/proxy/webhooks/subscriptions', oazapfts$1.json({
         ...opts,
         method: 'PUT',
         body,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
+        headers: oazapfts$1.mergeHeaders(opts?.headers, {
             'X-Unito-Credential-Id': xUnitoCredentialId,
             'X-Unito-Correlation-Id': xUnitoCorrelationId,
             'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
@@ -299,11 +299,11 @@ function updateWebhookSubscription(xUnitoCredentialId, body, { xUnitoCorrelation
  * Call an integration's graph
  */
 function getProxyGraph(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, accept, } = {}, opts) {
-    return oazapfts.fetchJson(`/proxy/graph${QS__namespace.query(QS__namespace.explode({
+    return oazapfts$1.fetchJson(`/proxy/graph${QS__namespace.query(QS__namespace.explode({
         path,
     }))}`, {
         ...opts,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
+        headers: oazapfts$1.mergeHeaders(opts?.headers, {
             'X-Unito-Credential-Id': xUnitoCredentialId,
             'X-Unito-Correlation-Id': xUnitoCorrelationId,
             'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
@@ -315,13 +315,13 @@ function getProxyGraph(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAd
  * Call an integration's graph
  */
 function patchProxyGraph(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, contentType, } = {}, opts) {
-    return oazapfts.fetchJson(`/proxy/graph${QS__namespace.query(QS__namespace.explode({
+    return oazapfts$1.fetchJson(`/proxy/graph${QS__namespace.query(QS__namespace.explode({
         path,
-    }))}`, oazapfts.json({
+    }))}`, oazapfts$1.json({
         ...opts,
         method: 'PATCH',
         body,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
+        headers: oazapfts$1.mergeHeaders(opts?.headers, {
             'X-Unito-Credential-Id': xUnitoCredentialId,
             'X-Unito-Correlation-Id': xUnitoCorrelationId,
             'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
@@ -333,13 +333,13 @@ function patchProxyGraph(xUnitoCredentialId, path, body, { xUnitoCorrelationId,
  * Call an integration's graph
  */
 function postProxyGraph(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, contentType, } = {}, opts) {
-    return oazapfts.fetchJson(`/proxy/graph${QS__namespace.query(QS__namespace.explode({
+    return oazapfts$1.fetchJson(`/proxy/graph${QS__namespace.query(QS__namespace.explode({
         path,
-    }))}`, oazapfts.json({
+    }))}`, oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
-        headers: oazapfts.mergeHeaders(opts?.headers, {
+        headers: oazapfts$1.mergeHeaders(opts?.headers, {
             'X-Unito-Credential-Id': xUnitoCredentialId,
             'X-Unito-Correlation-Id': xUnitoCorrelationId,
             'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
@@ -351,12 +351,12 @@ function postProxyGraph(xUnitoCredentialId, path, body, { xUnitoCorrelationId, x
  * Call an integration's graph
  */
 function deleteProxyGraph(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
-    return oazapfts.fetchJson(`/proxy/graph${QS__namespace.query(QS__namespace.explode({
+    return oazapfts$1.fetchJson(`/proxy/graph${QS__namespace.query(QS__namespace.explode({
         path,
     }))}`, {
         ...opts,
         method: 'DELETE',
-        headers: oazapfts.mergeHeaders(opts?.headers, {
+        headers: oazapfts$1.mergeHeaders(opts?.headers, {
             'X-Unito-Credential-Id': xUnitoCredentialId,
             'X-Unito-Correlation-Id': xUnitoCorrelationId,
             'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
@@ -367,7 +367,7 @@ function deleteProxyGraph(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnit
  * Get all the users
  */
 function getUsers({ pagination, } = {}, opts) {
-    return oazapfts.fetchJson(`/users${QS__namespace.query(QS__namespace.explode({
+    return oazapfts$1.fetchJson(`/users${QS__namespace.query(QS__namespace.explode({
         pagination,
     }))}`, {
         ...opts,
@@ -377,7 +377,7 @@ function getUsers({ pagination, } = {}, opts) {
  * Create a user
  */
 function createUser(body, opts) {
-    return oazapfts.fetchJson('/users', oazapfts.json({
+    return oazapfts$1.fetchJson('/users', oazapfts$1.json({
         ...opts,
         method: 'POST',
         body,
@@ -387,7 +387,7 @@ function createUser(body, opts) {
  * Get a user
  */
 function getUserById(userId, opts) {
-    return oazapfts.fetchJson(`/users/${encodeURIComponent(userId)}`, {
+    return oazapfts$1.fetchJson(`/users/${encodeURIComponent(userId)}`, {
         ...opts,
     });
 }
@@ -395,7 +395,7 @@ function getUserById(userId, opts) {
  * Update a user
  */
 function updateUser(userId, body, opts) {
-    return oazapfts.fetchJson(`/users/${encodeURIComponent(userId)}`, oazapfts.json({
+    return oazapfts$1.fetchJson(`/users/${encodeURIComponent(userId)}`, oazapfts$1.json({
         ...opts,
         method: 'PATCH',
         body,
@@ -405,7 +405,7 @@ function updateUser(userId, body, opts) {
  * Regenerate the api key of a user
  */
 function regenerateApiKey(userId, opts) {
-    return oazapfts.fetchJson(`/users/${encodeURIComponent(userId)}/apiKey`, {
+    return oazapfts$1.fetchJson(`/users/${encodeURIComponent(userId)}/apiKey`, {
         ...opts,
         method: 'POST',
     });
@@ -414,13 +414,16 @@ function regenerateApiKey(userId, opts) {
  * Get a user by its email address
  */
 function getUserByEmail(email, opts) {
-    return oazapfts.fetchJson(`/users/find/${encodeURIComponent(email)}`, {
+    return oazapfts$1.fetchJson(`/users/find/${encodeURIComponent(email)}`, {
         ...opts,
     });
 }
 
 // MANUAL ADDONS
+const oazapfts = Oazapfts__namespace.runtime(defaults);
 /**
+ * Provides a type guard for ItemResponse.
+ *
  * Return true if object has the shape of an item, false otherwise.
  * @param object
  */
@@ -429,7 +432,9 @@ function isItemResponse(object) {
     return !!object && !!data && typeof data === 'object' && 'fields' in data && 'relations' in data;
 }
 /**
- * Return true if object has the shape of an item, false otherwise.
+ * Provides a type guard for ItemSummaryResponse.
+ *
+ * Return true if object has the shape of an item summary, false otherwise.
  * @param object
  */
 function isItemSummaryResponse(object) {
@@ -437,6 +442,8 @@ function isItemSummaryResponse(object) {
     return !!object && !!data && typeof data === 'object' && 'path' in data;
 }
 /**
+ * Provides a type guard for CollectionResponse.
+ *
  * Return true if object has the shape of a collection, false otherwise.
  * @param object
  */
@@ -444,10 +451,40 @@ function isCollectionResponse(object) {
     const data = object.data;
     return !!object && !!data && typeof data === 'object' && 'info' in data && 'data' in data && Array.isArray(data.data);
 }
+/**
+ * Provides a type guard for ErrorResponse.
+ *
+ * Return true if object has the shape of an error response, false otherwise.
+ * @param object
+ */
 function isErrorResponse(object) {
     const status = object.status;
     return !!object && typeof object === 'object' && status && status >= 400 && 'data' in object && 'headers' in object;
 }
+/**
+ * Opt-in optimistic mode.
+ *
+ * Returns the typed response's data if it's a success, otherwise throws an HttpError.
+ *
+ * @param response received from the Integrations Platform Client
+ * @returns the response's data, typed, if it's a success
+ */
+async function optimistic(asyncResponse) {
+    const response = await asyncResponse;
+    if (isErrorResponse(response)) {
+        throw new Oazapfts.HttpError(response.status, response.data, response.headers);
+    }
+    return response.data;
+}
+/**
+ * Wrapper of getProxyGraph that returns a typed response containing an Item upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an Item, or an ErrorResponse
+ */
 async function getProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     const response = await getProxyGraph(xUnitoCredentialId, path, {
         xUnitoCorrelationId,
@@ -460,6 +497,15 @@ async function getProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId
         throw new Error(`Response does not match expected Item shape`);
     }
 }
+/**
+ * Wrapper of getProxyGraph that returns a typed response containing a Collection upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an Collection, or an ErrorResponse
+ */
 async function getProxyGraphCollection(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     const response = await getProxyGraph(xUnitoCredentialId, path, {
         xUnitoCorrelationId,
@@ -472,6 +518,15 @@ async function getProxyGraphCollection(xUnitoCredentialId, path, { xUnitoCorrela
         throw new Error(`Response does not match expected Collection shape`);
     }
 }
+/**
+ * Wrapper of patchProxyGraph that returns a typed response containing the updated Item upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an Item, or an ErrorResponse
+ */
 async function patchProxyGraphItem(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     const response = await patchProxyGraph(xUnitoCredentialId, path, body, {
         xUnitoCorrelationId,
@@ -484,6 +539,15 @@ async function patchProxyGraphItem(xUnitoCredentialId, path, body, { xUnitoCorre
         throw new Error(`Response does not match expected Item shape`);
     }
 }
+/**
+ * Wrapper of postProxyGraph that returns a typed response containing the created ItemSummary upon success.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ * @returns A successful response containing an ItemSummary, or an ErrorResponse
+ */
 async function postProxyGraphCollection(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     const response = await postProxyGraph(xUnitoCredentialId, path, body, {
         xUnitoCorrelationId,
@@ -496,12 +560,42 @@ async function postProxyGraphCollection(xUnitoCredentialId, path, body, { xUnito
         throw new Error(`Response does not match expected ItemSummary shape`);
     }
 }
+/**
+ * Wrapper of deleteProxyGraph added for uniformity, doesn't provide much typing help.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers The headers to include in the request
+ * @param opts Additional options
+ */
 async function deleteProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
     await deleteProxyGraph(xUnitoCredentialId, path, {
         xUnitoCorrelationId,
         xUnitoAdditionalLoggingContext,
     }, opts);
 }
+/**
+ * Call an integration's graph and returns the fetch response directly to enable streaming of the body as it comes in.
+ *
+ * @param xUnitoCredentialId The credential ID to use for the request
+ * @param path The path to the item to fetch
+ * @param headers Base headers to add to the request
+ * @param additionalHeaders Additional headers to add to the request
+ * @returns fetch's response
+ */
+async function fetchProxyGraph(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, accept, } = {}, init) {
+    return fetch(`${defaults.baseUrl}/proxy/graph${QS__namespace.query(QS__namespace.explode({ path }))}`, {
+        ...(init ?? {}),
+        headers: oazapfts.mergeHeaders({
+            ...defaults.headers,
+            ...(init?.headers ?? {}),
+            'X-Unito-Credential-Id': xUnitoCredentialId,
+            'X-Unito-Correlation-Id': xUnitoCorrelationId,
+            'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
+            Accept: accept,
+        }),
+    });
+}
 
 Object.defineProperty(exports, "HttpError", {
     enumerable: true,
@@ -517,6 +611,7 @@ exports.deleteIntegration = deleteIntegration;
 exports.deleteProxyGraph = deleteProxyGraph;
 exports.deleteProxyGraphItem = deleteProxyGraphItem;
 exports.encryptData = encryptData;
+exports.fetchProxyGraph = fetchProxyGraph;
 exports.getCredentialAccount = getCredentialAccount;
 exports.getCredentialById = getCredentialById;
 exports.getCredentials = getCredentials;
@@ -539,6 +634,7 @@ exports.isCollectionResponse = isCollectionResponse;
 exports.isErrorResponse = isErrorResponse;
 exports.isItemResponse = isItemResponse;
 exports.isItemSummaryResponse = isItemSummaryResponse;
+exports.optimistic = optimistic;
 exports.patchProxyGraph = patchProxyGraph;
 exports.patchProxyGraphItem = patchProxyGraphItem;
 exports.postProxyGraph = postProxyGraph;
@@ -553,4 +649,3 @@ exports.updateIntegration = updateIntegration;
 exports.updateProfile = updateProfile;
 exports.updateUser = updateUser;
 exports.updateWebhookSubscription = updateWebhookSubscription;
-module.exports.default = api;

package/dist/src/index.d.ts

@@ -1,4 +1,2 @@
-import { HttpError } from '@oazapfts/runtime';
-export { HttpError };
 export * from './api.js';
 export * from './addons.js';

package/dist/src/index.js

@@ -1,4 +1,2 @@
-import { HttpError } from '@oazapfts/runtime';
-export { HttpError };
 export * from './api.js';
 export * from './addons.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integrations-platform-client",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "The Unito Integrations Platform Client",
   "type": "module",
   "types": "./dist/src/index.d.ts",
@@ -15,7 +15,7 @@
     "dist/src/**/*"
   ],
   "engines": {
-    "node": ">=18",
+    "node": ">=20",
     "npm": ">=9.5.0"
   },
   "scripts": {
@@ -23,7 +23,7 @@
     "prepare": "npm run compile",
     "lint": "eslint --fix src test --ext .ts && prettier --write src test",
     "compile:esm": "tsc",
-    "compile:cjs": "rollup dist/src/index.js --file dist/src/index.cjs --format cjs --no-freeze && echo \"module.exports.default = api;\" >> dist/src/index.cjs",
+    "compile:cjs": "rollup dist/src/index.js --file dist/src/index.cjs --format cjs --no-freeze",
     "compile": "rm -rf dist && npm run compile:esm && npm run compile:cjs",
     "test": "NODE_ENV=test node --loader ts-node/esm --test ./test/*.test.ts",
     "test:debug": "NODE_ENV=test node --loader ts-node/esm --inspect-brk --test ./test/*.test.ts",
@@ -35,7 +35,7 @@
   },
   "license": "LicenseRef-LICENSE",
   "devDependencies": {
-    "@types/node": "18.x",
+    "@types/node": "20.x",
     "@types/sinon": "17.x",
     "@typescript-eslint/eslint-plugin": "7.x",
     "@typescript-eslint/parser": "7.x",