@unito/integrations-platform-client 0.48.4 → 1.0.1

package/dist/src/addons.d.ts

@@ -0,0 +1,154 @@
+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>;
+/**
+ * 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;
+/**
+ * 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;
+};
+type ErrorResponse = ({
+    status: 400;
+} | {
+    status: 401;
+} | {
+    status: 403;
+} | {
+    status: 404;
+} | {
+    status: 406;
+} | {
+    status: 410;
+} | {
+    status: 422;
+} | {
+    status: 429;
+} | {
+    status: 500;
+}) & {
+    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>;
+/**
+ * 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

@@ -0,0 +1,182 @@
+// MANUAL ADDONS
+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
+ */
+export function isItemResponse(object) {
+    const data = object.data;
+    return !!object && !!data && typeof data === 'object' && 'fields' in data && 'relations' in data;
+}
+/**
+ * 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) {
+    const data = object.data;
+    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
+ */
+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,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isItemResponse(response) || isErrorResponse(response)) {
+        return response;
+    }
+    else {
+        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,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isCollectionResponse(response) || isErrorResponse(response)) {
+        return response;
+    }
+    else {
+        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,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isItemResponse(response) || isErrorResponse(response)) {
+        return response;
+    }
+    else {
+        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,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isItemSummaryResponse(response) || isErrorResponse(response)) {
+        return response;
+    }
+    else {
+        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,
+        }),
+    });
+}