@unito/integrations-platform-client 0.48.4 → 1.0.0

package/dist/src/addons.d.ts

@@ -0,0 +1,66 @@
+import * as IntegrationApi from '@unito/integration-api';
+import * as Oazapfts from '@oazapfts/runtime';
+/**
+ * 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.
+ * @param object
+ */
+export declare function isItemSummaryResponse(object: unknown): object is Response<IntegrationApi.ItemSummary>;
+/**
+ * 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>;
+export declare function isErrorResponse(object: unknown): object is ErrorResponse;
+type Response<T> = {
+    status: 200;
+    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;
+};
+export declare function getProxyGraphItem(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<Response<IntegrationApi.Item> | ErrorResponse>;
+export declare function getProxyGraphCollection(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<Response<IntegrationApi.Collection> | 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>;
+export declare function postProxyGraphCollection(xUnitoCredentialId: string, path: string, body?: object, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<Response<IntegrationApi.ItemSummary> | ErrorResponse>;
+export declare function deleteProxyGraphItem(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<void>;
+export {};

package/dist/src/addons.js

@@ -0,0 +1,84 @@
+// MANUAL ADDONS
+import { getProxyGraph, patchProxyGraph, postProxyGraph, deleteProxyGraph } from './api.js';
+/**
+ * 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;
+}
+/**
+ * Return true if object has the shape of an item, false otherwise.
+ * @param object
+ */
+export function isItemSummaryResponse(object) {
+    const data = object.data;
+    return !!object && !!data && typeof data === 'object' && 'path' in data;
+}
+/**
+ * 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);
+}
+export function isErrorResponse(object) {
+    const status = object.status;
+    return !!object && typeof object === 'object' && status && status >= 400 && 'data' in object && 'headers' in object;
+}
+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`);
+    }
+}
+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`);
+    }
+}
+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`);
+    }
+}
+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`);
+    }
+}
+export async function deleteProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    await deleteProxyGraph(xUnitoCredentialId, path, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+}