@supernova-studio/supernova-sdk-beta 2.2.52 → 2.4.6

package/build/{sdk-typescript/src → types}/core/data/SDKDataBridge.d.ts

@@ -3,12 +3,17 @@ type DataBridgeRequestHookResult = {
     skipDefaultAuth?: boolean;
 };
 export type FetchFunction = typeof fetch;
-export type DataBridgeRequestHook = (request: any) => void | DataBridgeRequestHookResult | Promise<void | DataBridgeRequestHookResult>;
+/** Request config passed to the request hook before a request is sent */
+type DataBridgeRequestConfig = {
+    method: string;
+    headers: Record<string, string>;
+};
+export type DataBridgeRequestHook = (request: DataBridgeRequestConfig) => void | DataBridgeRequestHookResult | Promise<void | DataBridgeRequestHookResult>;
 export type DebugResponseObserver = (info: {
     requestUrl: string;
-    response?: any;
+    response?: unknown;
     executionTime: number;
-    error?: any;
+    error?: unknown;
 }) => void;
 export type DebugRequestObserver = (info: {
     requestUrl: string;
@@ -20,10 +25,10 @@ export type DataBridgeConfiguration = {
     apiUrl: string;
     aiApiUrl: string;
     apiVersion: string;
-    accessToken: string;
+    accessToken: string | null;
     target: string | null;
-    customFetchLib: any | null;
-    customProxyLib: any | null;
+    customFetchLib?: FetchFunction | null;
+    customProxyLib?: unknown;
     requestHook: DataBridgeRequestHook | null;
     debugRequestObserver?: DebugRequestObserver | null;
     debugResponseObserver?: DebugResponseObserver | null;
@@ -31,34 +36,46 @@ export type DataBridgeConfiguration = {
     isPreview?: boolean;
 };
 export declare class DataBridge {
-    authToken: string;
+    authToken: string | null;
     apiUrl: string;
     aiApiUrl: string;
     apiVersion: string;
     target: string | null;
-    customFetchLib: any | null;
-    customProxyLib: any | null;
+    customFetchLib: FetchFunction | null;
+    customProxyLib: unknown;
     isPreview: boolean;
     jobId: string | null;
     requestHook: DataBridgeRequestHook | null;
     debugRequestObserver: DebugRequestObserver | null;
     debugResponseObserver: DebugResponseObserver | null;
     constructor(conf: DataBridgeConfiguration);
-    delete(endpoint: string, payload?: any | null): Promise<any>;
-    get<T = any>(endpoint: string): Promise<T>;
+    delete<T = unknown>(endpoint: string, payload?: unknown): Promise<T>;
+    get<T = unknown>(endpoint: string): Promise<T>;
     getStreamed(endpoint: string): Promise<ReadableStreamDefaultReader<Uint8Array>>;
-    getAsData(endpoint: string): Promise<any>;
-    put<T = any>(endpoint: string, payload: any | null): Promise<T>;
-    post(endpoint: string, payload: any | null): Promise<any>;
-    postStreamed(endpoint: string, payload: any | null): Promise<ReadableStreamDefaultReader<Uint8Array>>;
-    upload(endpoint: string, formData: FormData, method?: "PUT" | "POST"): Promise<any>;
+    getAsData<T = unknown>(endpoint: string): Promise<T>;
+    put<T = unknown>(endpoint: string, payload: unknown): Promise<T>;
+    post<T = unknown>(endpoint: string, payload: unknown): Promise<T>;
+    /** GET that unwraps the standard `{ result }` envelope */
+    getResult<T = unknown>(endpoint: string): Promise<T>;
+    /** GET (data scope) that unwraps the standard `{ result }` envelope */
+    getAsDataResult<T = unknown>(endpoint: string): Promise<T>;
+    /** POST that unwraps the standard `{ result }` envelope */
+    postResult<T = unknown>(endpoint: string, payload: unknown): Promise<T>;
+    /** PUT that unwraps the standard `{ result }` envelope */
+    putResult<T = unknown>(endpoint: string, payload: unknown): Promise<T>;
+    /** DELETE that unwraps the standard `{ result }` envelope */
+    deleteResult<T = unknown>(endpoint: string, payload?: unknown): Promise<T>;
+    /** Upload that unwraps the standard `{ result }` envelope */
+    uploadResult<T = unknown>(endpoint: string, formData: FormData, method?: "PUT" | "POST"): Promise<T>;
+    postStreamed(endpoint: string, payload: unknown): Promise<ReadableStreamDefaultReader<Uint8Array>>;
+    upload<T = unknown>(endpoint: string, formData: FormData, method?: "PUT" | "POST"): Promise<T>;
     private request;
     private streamedRequest;
     private handleResponse;
     private handleStreamedResponse;
     private buildRequestConfig;
     private getProxyAgent;
-    getFetchInvoker(): any;
+    getFetchInvoker(): FetchFunction;
     getAIEndpoint(fragment: string | null): string;
     getApiEndpoint(fragment: string | null): string;
     getBaseEndpoint(fragment: string | null): string;