@dcc-bs/communication.bs.js 0.1.0 → 0.1.2

package/dist/communication.bs.d.ts

@@ -1,4 +1,5 @@
 import { default as default_2 } from 'zod';
+import { Ref } from 'vue';
 import { z } from 'zod';
 import { ZodType } from 'zod';
 
@@ -21,12 +22,19 @@ import { ZodType } from 'zod';
  */
 export declare type AfterResponseHook = (response: Response) => Promise<Response> | Response;
 
+export declare interface ApiClient {
+    apiFetch: ApiFetchFunction;
+    apiStreamFetch: (url: string, options?: ApiFetchOptions) => Promise<ApiResponse<ReadableStream<Uint8Array>>>;
+    apiFetchTextMany: (url: string, options?: ApiFetchOptions) => AsyncGenerator<string, void, void>;
+    apiFetchMany: <T extends ZodType>(url: string, options: ApiFetchOptionsWithSchema<T>) => AsyncGenerator<z.infer<T>, void, void>;
+}
+
 export declare class ApiError extends Error {
     $type: "ApiError";
-    errorId: ErrorId;
+    errorId: ErrorId_2;
     debugMessage?: string;
     status: number;
-    constructor(errorId: ErrorId, status: number, debugMessage?: string);
+    constructor(errorId: ErrorId_2, status: number, debugMessage?: string);
 }
 
 export declare const ApiErrorResponse: default_2.ZodObject<{
@@ -36,9 +44,14 @@ export declare const ApiErrorResponse: default_2.ZodObject<{
 
 export declare type ApiErrorResponse = default_2.infer<typeof ApiErrorResponse>;
 
-export declare function apiFetch<T extends ZodType>(url: string, options: ApiFetchOptionsWithSchema<T>): Promise<ApiResponse<z.infer<T>>>;
+export declare function apiFetch<T extends ZodType>(url: string, options: ApiFetchOptionsWithSchema<T>): Promise<ApiResponse_2<z.infer<T>>>;
+
+export declare function apiFetch<T extends object>(url: string, options?: ApiFetchOptions): Promise<ApiResponse_2<T>>;
 
-export declare function apiFetch<T extends object>(url: string, options?: ApiFetchOptions): Promise<ApiResponse<T>>;
+declare interface ApiFetchFunction {
+    <T extends ZodType>(url: string, options: ApiFetchOptionsWithSchema<T>): Promise<ApiResponse<z.infer<T>>>;
+    <T extends object>(url: string, options?: ApiFetchOptions): Promise<ApiResponse<T>>;
+}
 
 export declare function apiFetchMany<T extends ZodType>(url: string, options: ApiFetchOptionsWithSchema<T>): AsyncGenerator<z.infer<T>, void, void>;
 
@@ -52,9 +65,11 @@ export declare type ApiFetchOptionsWithSchema<T extends ZodType> = ApiFetchOptio
 
 export declare function apiFetchTextMany(url: string, options?: ApiFetchOptions): AsyncGenerator<string, void, void>;
 
-declare type ApiResponse<T> = T | ApiError;
+export declare type ApiResponse<T> = T | ApiError;
+
+declare type ApiResponse_2<T> = T | ApiError;
 
-export declare function apiStreamFetch(url: string, options?: ApiFetchOptions): Promise<ApiResponse<ReadableStream<Uint8Array>>>;
+export declare function apiStreamFetch(url: string, options?: ApiFetchOptions): Promise<ApiResponse_2<ReadableStream<Uint8Array>>>;
 
 /**
  * Authentication configuration for the fetcher.
@@ -102,6 +117,8 @@ declare type BearerAuthConfig = {
  */
 export declare type BeforeRequestHook = (url: string, options: RequestInit) => Promise<void> | void;
 
+export declare function createApiClient(fetcher?: Fetcher): ApiClient;
+
 /**
  * Creates a builder for configuring and creating a customized fetcher.
  * The builder allows you to chain configuration methods and then build a fetcher
@@ -395,7 +412,9 @@ export declare function createFetcherBuilder(options?: FetcherBuilderOptions): {
     build: () => Fetcher;
 };
 
-declare type ErrorId = "unexpected_error" | "fetch_failed" | string;
+export declare type ErrorId = "unexpected_error" | "fetch_failed" | string;
+
+declare type ErrorId_2 = "unexpected_error" | "fetch_failed" | string;
 
 export declare type Fetcher = (url: string, options: ApiFetchOptions) => Promise<Response>;
 
@@ -568,4 +587,24 @@ export declare function isApiError(response: unknown): response is ApiError;
  */
 export declare type OnErrorHook = (error: Error) => void;
 
+export declare function useApiFetch<T extends object>(url: string, options?: ApiFetchOptions, fetcher?: Fetcher): {
+    data: Ref<T | undefined, T | undefined>;
+    error: Ref<{
+        errorId: string;
+        debugMessage?: string | undefined;
+    } | undefined, {
+        errorId: string;
+        debugMessage?: string | undefined;
+    } | undefined>;
+    pending: Ref<boolean, boolean>;
+};
+
+export declare type UseApiFetchOutput<T> = {
+    data: Ref<T | undefined>;
+    error: Ref<ApiErrorResponse | undefined>;
+    pending: Ref<boolean>;
+};
+
+export declare function useApiFetchWithSchema<T extends ZodType>(url: string, options: ApiFetchOptionsWithSchema<T>, fetcher?: Fetcher): UseApiFetchOutput<z.infer<T>>;
+
 export { }