@reverbia/sdk 1.0.0-next.20251208112742 → 1.0.0-next.20251209090511

package/dist/expo/index.d.mts

@@ -67,6 +67,96 @@ type LlmapiChoice = {
     index?: number;
     message?: LlmapiMessage;
 };
+/**
+ * ExtraFields contains additional metadata such as provider/model information.
+ */
+type LlmapiImageGenerationExtraFields = {
+    /**
+     * ModelRequested is the model identifier that the client asked for.
+     */
+    model_requested?: string;
+    /**
+     * Provider is the gateway that serviced this request.
+     */
+    provider?: string;
+    /**
+     * RequestType is always "image_generation".
+     */
+    request_type?: string;
+};
+type LlmapiImageGenerationImage = {
+    /**
+     * B64JSON is the base64 payload for models that can only return binary.
+     */
+    b64_json?: string;
+    /**
+     * URL is the signed URL to download the image.
+     */
+    url?: string;
+};
+type LlmapiImageGenerationRequest = {
+    /**
+     * Model is the model identifier to use for generation (e.g., "gpt-image-1").
+     */
+    model: string;
+    /**
+     * Prompt is the text description of the desired image.
+     */
+    prompt: string;
+    /**
+     * Quality targets a quality preset (e.g., "auto", "high").
+     */
+    quality?: string;
+    /**
+     * ResponseFormat controls how the generated image is returned (e.g., "url" or "b64_json").
+     */
+    response_format?: string;
+    /**
+     * Size controls the dimensions of the generated image (e.g., "1024x1024").
+     */
+    size?: string;
+};
+type LlmapiImageGenerationResponse = {
+    /**
+     * Created is the Unix timestamp when the image was generated.
+     */
+    created?: number;
+    extra_fields?: LlmapiImageGenerationExtraFields;
+    /**
+     * Images contains the generated images.
+     */
+    images?: Array<LlmapiImageGenerationImage>;
+    /**
+     * Model is the model identifier that generated the image.
+     */
+    model?: string;
+    /**
+     * Provider is the gateway that produced the image.
+     */
+    provider?: string;
+    usage?: LlmapiImageGenerationUsage;
+};
+/**
+ * Usage documents token usage (when available).
+ */
+type LlmapiImageGenerationUsage = {
+    /**
+     * CostMicroUSD is the inference cost for this image generation request
+     */
+    cost_micro_usd?: number;
+    /**
+     * InputTokens is the number of tokens sent in the prompt.
+     */
+    input_tokens?: number;
+    /**
+     * OutputTokens is the number of tokens returned by the model.
+     */
+    output_tokens?: number;
+    /**
+     * TotalTokens is the total number of tokens consumed.
+     */
+    total_tokens?: number;
+};
 /**
  * Message is the generated message
  */
@@ -106,7 +196,10 @@ type LlmapiMessageContentPart = {
  */
 type LlmapiRole = string;
 
-type SendMessageArgs = {
+/**
+ * Base arguments for sending a message
+ */
+type BaseSendMessageArgs = {
     messages: LlmapiMessage[];
     model?: string;
     /**
@@ -117,14 +210,20 @@ type SendMessageArgs = {
      */
     onData?: (chunk: string) => void;
 };
-type SendMessageResult = {
+/**
+ * Base result type for sendMessage
+ */
+type BaseSendMessageResult = {
     data: LlmapiChatCompletionResponse;
     error: null;
 } | {
     data: null;
     error: string;
 };
-type UseChatOptions = {
+/**
+ * Base options for useChat hook
+ */
+type BaseUseChatOptions = {
     getToken?: () => Promise<string | null>;
     baseUrl?: string;
     /**
@@ -147,9 +246,11 @@ type UseChatOptions = {
      */
     onError?: (error: Error) => void;
 };
-type UseChatResult = {
+/**
+ * Base result type for useChat hook
+ */
+type BaseUseChatResult = {
     isLoading: boolean;
-    sendMessage: (args: SendMessageArgs) => Promise<SendMessageResult>;
     /**
      * Aborts the current streaming request if one is in progress.
      *
@@ -159,6 +260,13 @@ type UseChatResult = {
      */
     stop: () => void;
 };
+
+type SendMessageArgs = BaseSendMessageArgs;
+type SendMessageResult = BaseSendMessageResult;
+type UseChatOptions = BaseUseChatOptions;
+type UseChatResult = BaseUseChatResult & {
+    sendMessage: (args: SendMessageArgs) => Promise<SendMessageResult>;
+};
 /**
  * A React hook for managing chat completions with authentication.
  *
@@ -196,4 +304,40 @@ type UseChatResult = {
  */
 declare function useChat(options?: UseChatOptions): UseChatResult;
 
-export { useChat };
+type UseImageGenerationOptions = {
+    /**
+     * Custom function to get auth token for API calls
+     */
+    getToken?: () => Promise<string | null>;
+    /**
+     * Optional base URL for the API requests.
+     */
+    baseUrl?: string;
+    /**
+     * Callback function to be called when the generation finishes successfully.
+     */
+    onFinish?: (response: LlmapiImageGenerationResponse) => void;
+    /**
+     * Callback function to be called when an unexpected error is encountered.
+     */
+    onError?: (error: Error) => void;
+};
+type GenerateImageArgs = LlmapiImageGenerationRequest;
+type GenerateImageResult = {
+    data: LlmapiImageGenerationResponse;
+    error: null;
+} | {
+    data: null;
+    error: string;
+};
+type UseImageGenerationResult = {
+    isLoading: boolean;
+    generateImage: (args: GenerateImageArgs) => Promise<GenerateImageResult>;
+    stop: () => void;
+};
+/**
+ * React hook for generating images using the LLM API.
+ */
+declare function useImageGeneration(options?: UseImageGenerationOptions): UseImageGenerationResult;
+
+export { useChat, useImageGeneration };

package/dist/expo/index.d.ts

@@ -67,6 +67,96 @@ type LlmapiChoice = {
     index?: number;
     message?: LlmapiMessage;
 };
+/**
+ * ExtraFields contains additional metadata such as provider/model information.
+ */
+type LlmapiImageGenerationExtraFields = {
+    /**
+     * ModelRequested is the model identifier that the client asked for.
+     */
+    model_requested?: string;
+    /**
+     * Provider is the gateway that serviced this request.
+     */
+    provider?: string;
+    /**
+     * RequestType is always "image_generation".
+     */
+    request_type?: string;
+};
+type LlmapiImageGenerationImage = {
+    /**
+     * B64JSON is the base64 payload for models that can only return binary.
+     */
+    b64_json?: string;
+    /**
+     * URL is the signed URL to download the image.
+     */
+    url?: string;
+};
+type LlmapiImageGenerationRequest = {
+    /**
+     * Model is the model identifier to use for generation (e.g., "gpt-image-1").
+     */
+    model: string;
+    /**
+     * Prompt is the text description of the desired image.
+     */
+    prompt: string;
+    /**
+     * Quality targets a quality preset (e.g., "auto", "high").
+     */
+    quality?: string;
+    /**
+     * ResponseFormat controls how the generated image is returned (e.g., "url" or "b64_json").
+     */
+    response_format?: string;
+    /**
+     * Size controls the dimensions of the generated image (e.g., "1024x1024").
+     */
+    size?: string;
+};
+type LlmapiImageGenerationResponse = {
+    /**
+     * Created is the Unix timestamp when the image was generated.
+     */
+    created?: number;
+    extra_fields?: LlmapiImageGenerationExtraFields;
+    /**
+     * Images contains the generated images.
+     */
+    images?: Array<LlmapiImageGenerationImage>;
+    /**
+     * Model is the model identifier that generated the image.
+     */
+    model?: string;
+    /**
+     * Provider is the gateway that produced the image.
+     */
+    provider?: string;
+    usage?: LlmapiImageGenerationUsage;
+};
+/**
+ * Usage documents token usage (when available).
+ */
+type LlmapiImageGenerationUsage = {
+    /**
+     * CostMicroUSD is the inference cost for this image generation request
+     */
+    cost_micro_usd?: number;
+    /**
+     * InputTokens is the number of tokens sent in the prompt.
+     */
+    input_tokens?: number;
+    /**
+     * OutputTokens is the number of tokens returned by the model.
+     */
+    output_tokens?: number;
+    /**
+     * TotalTokens is the total number of tokens consumed.
+     */
+    total_tokens?: number;
+};
 /**
  * Message is the generated message
  */
@@ -106,7 +196,10 @@ type LlmapiMessageContentPart = {
  */
 type LlmapiRole = string;
 
-type SendMessageArgs = {
+/**
+ * Base arguments for sending a message
+ */
+type BaseSendMessageArgs = {
     messages: LlmapiMessage[];
     model?: string;
     /**
@@ -117,14 +210,20 @@ type SendMessageArgs = {
      */
     onData?: (chunk: string) => void;
 };
-type SendMessageResult = {
+/**
+ * Base result type for sendMessage
+ */
+type BaseSendMessageResult = {
     data: LlmapiChatCompletionResponse;
     error: null;
 } | {
     data: null;
     error: string;
 };
-type UseChatOptions = {
+/**
+ * Base options for useChat hook
+ */
+type BaseUseChatOptions = {
     getToken?: () => Promise<string | null>;
     baseUrl?: string;
     /**
@@ -147,9 +246,11 @@ type UseChatOptions = {
      */
     onError?: (error: Error) => void;
 };
-type UseChatResult = {
+/**
+ * Base result type for useChat hook
+ */
+type BaseUseChatResult = {
     isLoading: boolean;
-    sendMessage: (args: SendMessageArgs) => Promise<SendMessageResult>;
     /**
      * Aborts the current streaming request if one is in progress.
      *
@@ -159,6 +260,13 @@ type UseChatResult = {
      */
     stop: () => void;
 };
+
+type SendMessageArgs = BaseSendMessageArgs;
+type SendMessageResult = BaseSendMessageResult;
+type UseChatOptions = BaseUseChatOptions;
+type UseChatResult = BaseUseChatResult & {
+    sendMessage: (args: SendMessageArgs) => Promise<SendMessageResult>;
+};
 /**
  * A React hook for managing chat completions with authentication.
  *
@@ -196,4 +304,40 @@ type UseChatResult = {
  */
 declare function useChat(options?: UseChatOptions): UseChatResult;
 
-export { useChat };
+type UseImageGenerationOptions = {
+    /**
+     * Custom function to get auth token for API calls
+     */
+    getToken?: () => Promise<string | null>;
+    /**
+     * Optional base URL for the API requests.
+     */
+    baseUrl?: string;
+    /**
+     * Callback function to be called when the generation finishes successfully.
+     */
+    onFinish?: (response: LlmapiImageGenerationResponse) => void;
+    /**
+     * Callback function to be called when an unexpected error is encountered.
+     */
+    onError?: (error: Error) => void;
+};
+type GenerateImageArgs = LlmapiImageGenerationRequest;
+type GenerateImageResult = {
+    data: LlmapiImageGenerationResponse;
+    error: null;
+} | {
+    data: null;
+    error: string;
+};
+type UseImageGenerationResult = {
+    isLoading: boolean;
+    generateImage: (args: GenerateImageArgs) => Promise<GenerateImageResult>;
+    stop: () => void;
+};
+/**
+ * React hook for generating images using the LLM API.
+ */
+declare function useImageGeneration(options?: UseImageGenerationOptions): UseImageGenerationResult;
+
+export { useChat, useImageGeneration };