@reverbia/sdk 1.0.0-next.20251208162906 → 1.0.0-next.20251209143100

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
  */
@@ -101,6 +191,99 @@ type LlmapiMessageContentPart = {
      */
     type?: string;
 };
+type LlmapiModel = {
+    architecture?: LlmapiModelArchitecture;
+    /**
+     * CanonicalSlug is the canonical slug for the model
+     */
+    canonical_slug?: string;
+    /**
+     * ContextLength is the maximum context length in tokens
+     */
+    context_length?: number;
+    /**
+     * Created is the Unix timestamp of when the model was created
+     */
+    created?: number;
+    /**
+     * DefaultParameters contains default parameter values
+     */
+    default_parameters?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Description describes the model and its capabilities
+     */
+    description?: string;
+    /**
+     * HuggingFaceID is the Hugging Face model identifier
+     */
+    hugging_face_id?: string;
+    /**
+     * ID is the model identifier (e.g., "openai/gpt-4")
+     */
+    id?: string;
+    /**
+     * MaxInputTokens is the maximum input tokens
+     */
+    max_input_tokens?: number;
+    /**
+     * MaxOutputTokens is the maximum output tokens
+     */
+    max_output_tokens?: number;
+    /**
+     * Name is the human-readable model name (optional)
+     */
+    name?: string;
+    /**
+     * OwnedBy is the organization that owns the model
+     */
+    owned_by?: string;
+    per_request_limits?: LlmapiModelPerRequestLimits;
+    pricing?: LlmapiModelPricing;
+    /**
+     * SupportedMethods is a list of supported API methods
+     */
+    supported_methods?: Array<string>;
+    /**
+     * SupportedParameters is a list of supported parameter names
+     */
+    supported_parameters?: Array<string>;
+    top_provider?: LlmapiModelTopProvider;
+};
+/**
+ * Architecture describes the model's technical capabilities
+ */
+type LlmapiModelArchitecture = {
+    instruct_type?: string;
+    modality?: string;
+    prompt_formatting?: string;
+    tokenizer?: string;
+};
+/**
+ * PerRequestLimits contains rate limiting information
+ */
+type LlmapiModelPerRequestLimits = {
+    completion_tokens?: number;
+    prompt_tokens?: number;
+};
+/**
+ * Pricing contains the pricing structure for using this model
+ */
+type LlmapiModelPricing = {
+    completion?: string;
+    image?: string;
+    prompt?: string;
+    request?: string;
+};
+/**
+ * TopProvider contains configuration details for the primary provider
+ */
+type LlmapiModelTopProvider = {
+    context_length?: number;
+    is_moderated?: boolean;
+    max_completion_tokens?: number;
+};
 /**
  * Role is the message role (system, user, assistant)
  */
@@ -214,4 +397,70 @@ type UseChatResult = BaseUseChatResult & {
  */
 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;
+
+type UseModelsOptions = {
+    /**
+     * Custom function to get auth token for API calls
+     */
+    getToken?: () => Promise<string | null>;
+    /**
+     * Optional base URL for the API requests.
+     */
+    baseUrl?: string;
+    /**
+     * Optional filter for specific provider (e.g. "openai")
+     */
+    provider?: string;
+    /**
+     * Whether to fetch models automatically on mount (default: true)
+     */
+    autoFetch?: boolean;
+};
+type UseModelsResult = {
+    models: LlmapiModel[];
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+};
+/**
+ * React hook for fetching available LLM models.
+ * Automatically fetches all available models.
+ */
+declare function useModels(options?: UseModelsOptions): UseModelsResult;
+
+export { type UseModelsOptions, type UseModelsResult, useChat, useImageGeneration, useModels };

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
  */
@@ -101,6 +191,99 @@ type LlmapiMessageContentPart = {
      */
     type?: string;
 };
+type LlmapiModel = {
+    architecture?: LlmapiModelArchitecture;
+    /**
+     * CanonicalSlug is the canonical slug for the model
+     */
+    canonical_slug?: string;
+    /**
+     * ContextLength is the maximum context length in tokens
+     */
+    context_length?: number;
+    /**
+     * Created is the Unix timestamp of when the model was created
+     */
+    created?: number;
+    /**
+     * DefaultParameters contains default parameter values
+     */
+    default_parameters?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Description describes the model and its capabilities
+     */
+    description?: string;
+    /**
+     * HuggingFaceID is the Hugging Face model identifier
+     */
+    hugging_face_id?: string;
+    /**
+     * ID is the model identifier (e.g., "openai/gpt-4")
+     */
+    id?: string;
+    /**
+     * MaxInputTokens is the maximum input tokens
+     */
+    max_input_tokens?: number;
+    /**
+     * MaxOutputTokens is the maximum output tokens
+     */
+    max_output_tokens?: number;
+    /**
+     * Name is the human-readable model name (optional)
+     */
+    name?: string;
+    /**
+     * OwnedBy is the organization that owns the model
+     */
+    owned_by?: string;
+    per_request_limits?: LlmapiModelPerRequestLimits;
+    pricing?: LlmapiModelPricing;
+    /**
+     * SupportedMethods is a list of supported API methods
+     */
+    supported_methods?: Array<string>;
+    /**
+     * SupportedParameters is a list of supported parameter names
+     */
+    supported_parameters?: Array<string>;
+    top_provider?: LlmapiModelTopProvider;
+};
+/**
+ * Architecture describes the model's technical capabilities
+ */
+type LlmapiModelArchitecture = {
+    instruct_type?: string;
+    modality?: string;
+    prompt_formatting?: string;
+    tokenizer?: string;
+};
+/**
+ * PerRequestLimits contains rate limiting information
+ */
+type LlmapiModelPerRequestLimits = {
+    completion_tokens?: number;
+    prompt_tokens?: number;
+};
+/**
+ * Pricing contains the pricing structure for using this model
+ */
+type LlmapiModelPricing = {
+    completion?: string;
+    image?: string;
+    prompt?: string;
+    request?: string;
+};
+/**
+ * TopProvider contains configuration details for the primary provider
+ */
+type LlmapiModelTopProvider = {
+    context_length?: number;
+    is_moderated?: boolean;
+    max_completion_tokens?: number;
+};
 /**
  * Role is the message role (system, user, assistant)
  */
@@ -214,4 +397,70 @@ type UseChatResult = BaseUseChatResult & {
  */
 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;
+
+type UseModelsOptions = {
+    /**
+     * Custom function to get auth token for API calls
+     */
+    getToken?: () => Promise<string | null>;
+    /**
+     * Optional base URL for the API requests.
+     */
+    baseUrl?: string;
+    /**
+     * Optional filter for specific provider (e.g. "openai")
+     */
+    provider?: string;
+    /**
+     * Whether to fetch models automatically on mount (default: true)
+     */
+    autoFetch?: boolean;
+};
+type UseModelsResult = {
+    models: LlmapiModel[];
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+};
+/**
+ * React hook for fetching available LLM models.
+ * Automatically fetches all available models.
+ */
+declare function useModels(options?: UseModelsOptions): UseModelsResult;
+
+export { type UseModelsOptions, type UseModelsResult, useChat, useImageGeneration, useModels };