@campfire-interactive/cfi-ai-hub-client 2.0.2 → 2.0.3

package/dist/types.d.ts

@@ -0,0 +1,713 @@
+/** A file payload accepted by multipart upload methods. Pair a Blob with a filename when the Blob lacks one. */
+export type FileInput = Blob | File | {
+    blob: Blob;
+    filename: string;
+};
+export interface CfiAiHubClientConfig {
+    /**
+     * Full base URL including any root path and API version prefix.
+     * Example: `https://ai-hub.cfi2.net/cfi-ai-hub/api/v1`
+     */
+    baseUrl: string;
+    /** Async or sync provider that returns a platform-identity JWT. */
+    getToken: () => string | Promise<string>;
+    /** Request timeout in milliseconds. Defaults to 30_000. */
+    timeout?: number;
+}
+export interface ChatRequest {
+    message: string;
+    system_prompt?: string;
+    temperature?: number;
+    max_tokens?: number;
+}
+export interface ChatResponse {
+    response: string;
+    model: string;
+    tokens_used?: number | null;
+}
+export interface EmbeddingRequest {
+    text: string;
+    model?: string;
+}
+export interface EmbeddingResponse {
+    embedding: number[];
+    model: string;
+    dimensions: number;
+}
+export interface SentimentRequest {
+    text: string;
+}
+export interface SentimentResponse {
+    sentiment: string;
+    score: number;
+    reasoning: string;
+}
+export interface SummarizeRequest {
+    text: string;
+    max_length?: number;
+}
+export interface SummarizeResponse {
+    summary: string;
+    original_length: number;
+    summary_length: number;
+}
+export interface AttributeFilter {
+    attributeName: string;
+    attributeValue: string;
+}
+export interface BomProcessFileOptions {
+    sheetName?: string;
+    outputFilename?: string;
+    model?: string;
+    temperature?: number;
+    useDirectUpload?: boolean;
+    callbackUrl?: string;
+    backendBaseUrl?: string;
+    configId?: number;
+    progId?: number;
+}
+export interface BomSeedVectorDbFileOptions {
+    batchSize?: number;
+    startId?: number;
+    callbackUrl?: string;
+}
+export interface BomProcessResponse {
+    success: boolean;
+    progress_id: string;
+    progress_url?: string | null;
+    message: string;
+    data?: Array<Record<string, unknown>> | null;
+    error?: string | null;
+    output_file?: string | null;
+    item_count?: number | null;
+    method?: 'direct_upload' | 'csv_conversion' | string | null;
+    raw_response?: string | null;
+}
+export interface BomSearchRequest {
+    query: string;
+    limit?: number;
+    score_threshold?: number;
+    customer?: string;
+    program?: string;
+    level?: number;
+    exact_match_only?: boolean;
+    attributes?: AttributeFilter[];
+}
+export interface BomSearchResult {
+    id: string;
+    score: number;
+    part_number: string;
+    description: string;
+    customer: string;
+    program: string;
+    material: string;
+    cost?: number | null;
+    level?: number | null;
+    usage_context: string;
+    bom_data: Record<string, unknown>;
+}
+export interface BomSearchResponse {
+    success: boolean;
+    results: BomSearchResult[];
+    query: string;
+    total_results: number;
+    error?: string | null;
+}
+export interface BomStoreAttributesRequest {
+    query: string;
+    attributes?: AttributeFilter[];
+    item_name?: string;
+    item_number?: string;
+    item_type?: string;
+}
+export interface BomStoreAttributesResponse {
+    success: boolean;
+    message: string;
+    item_id?: number | null;
+    item_created: boolean;
+    item_name?: string | null;
+    item_number?: string | null;
+    item_type?: string | null;
+    error?: string | null;
+}
+export interface BomSeedVectorDbRequest {
+    data: Record<string, unknown>;
+    batch_size?: number;
+    start_id?: number;
+    collection_name?: string;
+}
+export interface VolumeAnalyzeResponse {
+    status: string;
+    session_id: string;
+    insights: string;
+    images: string[];
+}
+export interface FollowUpRequest {
+    session_id: string;
+    prompt: string;
+}
+export interface FollowUpResponse {
+    status: string;
+    session_id: string;
+    response: string;
+    images: string[];
+}
+export interface ColumnDetectionResponse {
+    columns: string[];
+    auto_detected: Record<string, string | null>;
+    month_columns: string[];
+    month_mapping: Record<string, string>;
+    grouping_columns: Record<string, string | null>;
+}
+/** ISO-8601 date string (YYYY-MM-DD). */
+export type IsoDate = string;
+export interface FileComparisonConfig {
+    key_col: string;
+    sop_col: string;
+    eop_col: string;
+    prog_col?: string;
+    lifetime_col?: string;
+    auto_detect_months?: boolean;
+    month_cols_manual?: string[];
+    start_date?: IsoDate;
+    end_date?: IsoDate;
+}
+export interface FileComparisonResponse {
+    merged_data: Array<Record<string, unknown>>;
+    data_quality: Record<string, number>;
+    timeframe: Record<string, unknown>;
+    statistics: Record<string, number>;
+}
+export interface VolumeDashboardResponse {
+    dashboard_data: Record<string, unknown>;
+}
+export interface OmsfHealthResponse {
+    api: string;
+    llm_available: boolean;
+    llm_provider: string;
+    code_interpreter: string;
+}
+export interface TenantConfigEntry {
+    fieldName: string;
+    weight: number;
+    isActive?: boolean;
+}
+export interface SegmentsInfo {
+    keySegments?: string[];
+    progCol?: string;
+    sopCol?: string;
+    eopCol?: string;
+}
+export interface CompareVendorFilesRequest {
+    vendorUploadId1: number;
+    vendorUploadId2: number;
+    fileDownloadUrl1: string;
+    fileDownloadUrl2: string;
+    fileName1: string;
+    fileName2: string;
+    callbackUrl?: string;
+    quoteOppCallbackUrl?: string;
+    tenantConfig?: TenantConfigEntry[];
+    backendBaseUrl?: string;
+    segmentsInfo?: SegmentsInfo;
+}
+export interface CompareVendorFilesResponse {
+    success: boolean;
+    progress_id: string;
+    message: string;
+}
+export declare const ProgressStatus: {
+    readonly PENDING: "pending";
+    readonly PROCESSING: "processing";
+    readonly DONE: "done";
+    readonly ABORT: "abort";
+    readonly ABORT_WITH_MESSAGE: "ABORT WITH MESSAGE";
+    readonly ERROR: "error";
+};
+export type ProgressStatusValue = (typeof ProgressStatus)[keyof typeof ProgressStatus];
+export interface ProgressResponse<TData = unknown> {
+    success: boolean;
+    progress_id: string;
+    status: ProgressStatusValue | string;
+    message: string;
+    percentage: number;
+    created_at: string;
+    updated_at: string;
+    data?: TData | null;
+    error?: string | null;
+    metadata?: Record<string, unknown> | null;
+}
+export interface AbortProgressInput {
+    message?: string;
+}
+export interface ActionResponse {
+    success: boolean;
+    message: string;
+}
+export interface PollProgressOptions {
+    /** Polling interval in milliseconds. Defaults to 1000. */
+    intervalMs?: number;
+    /** Max total wait time in milliseconds. Defaults to 30 minutes. */
+    timeoutMs?: number;
+    /** Callback invoked on each poll with the latest progress snapshot. */
+    onProgress?: (progress: ProgressResponse) => void;
+    /** AbortSignal to stop polling early. */
+    signal?: AbortSignal;
+}
+export interface CacheGetResponse<T = unknown> {
+    key: string;
+    value: T;
+}
+export interface CacheSetInput<T = unknown> {
+    value: T;
+    /** Expiration in seconds. */
+    expiration?: number;
+}
+export interface CacheSetResponse {
+    key: string;
+    status: string;
+}
+export interface CacheDeleteResponse {
+    key: string;
+    deleted: boolean;
+}
+export interface CacheTokenInvalidateResponse {
+    status: string;
+    message: string;
+}
+export type ForecastModelName = 'timesfm' | 'chronos' | 'moirai';
+/** A single week of volume input. `week` must be a Monday (YYYY-MM-DD). */
+export interface WeeklyDataPoint {
+    week: IsoDate;
+    value: number;
+}
+export interface ForecastRequest {
+    series_id: string;
+    /** Historical weekly volume data, ordered chronologically. Minimum 4 points. */
+    weekly_data: WeeklyDataPoint[];
+    /** Weeks to forecast beyond the last data point. Range 1–520. Default 52. */
+    forecast_horizon_weeks?: number;
+    /**
+     * Models to run. When omitted or empty the system auto-selects the best model
+     * by holding out a validation window, measuring WMAPE, and forecasting with the winner.
+     */
+    models?: ForecastModelName[];
+    /**
+     * When true, macro indicator data stored in the database is fetched and
+     * passed to models that support covariates (Chronos, Moirai).
+     */
+    use_external_factors?: boolean;
+}
+/** A single weekly point in the combined historical + forecast timeline. */
+export interface WeeklyForecastPoint {
+    week: IsoDate;
+    /** Volume value. null for missing historical weeks. */
+    value: number | null;
+    /** True for forecast rows, false for historical actuals. */
+    is_forecast: boolean;
+    lo_80?: number | null;
+    hi_80?: number | null;
+    lo_95?: number | null;
+    hi_95?: number | null;
+}
+/** Forecast result from one model. */
+export interface ModelForecastResult {
+    model: ForecastModelName;
+    timeline: WeeklyForecastPoint[];
+    /** WMAPE (%) over any verification window. null when no overlap exists. */
+    accuracy_wmape: number | null;
+    /** max(0, 100 − WMAPE). null when WMAPE is null. */
+    accuracy_pct: number | null;
+    /** True when macro covariates were actually used by this model. */
+    covariates_used: boolean;
+    /** Sanitized error message when this model failed; timeline will be empty. */
+    error?: string | null;
+    /** Correlate with server logs for root-cause details. */
+    error_id?: string | null;
+}
+/** Auto-model selection metadata — present when models was not specified. */
+export interface ModelSelectionInfo {
+    winner: ForecastModelName;
+    /** WMAPE (%) per model on the held-out validation window. null if model failed. */
+    validation_wmape: Record<string, number | null>;
+    /** Number of weeks held out from history for model comparison. */
+    validation_weeks: number;
+}
+export interface ForecastResponse {
+    series_id: string;
+    forecast_horizon_weeks: number;
+    /** Effective cutoff used — last week of weekly_data. */
+    cutoff_date: IsoDate;
+    /** One entry per requested or auto-selected model. */
+    results: ModelForecastResult[];
+    /** Present only when the system auto-selected the best model. */
+    model_selection?: ModelSelectionInfo | null;
+}
+export interface ForecastJobResponse {
+    progress_id: string;
+    /** Poll this URL to check job status. */
+    progress_url: string;
+    series_id: string;
+    message: string;
+}
+export interface BatchForecastRequest {
+    /** 1–500 forecast requests. */
+    series: ForecastRequest[];
+    /** Optional HTTPS URL to POST the completed result to when the job finishes. */
+    callback_url?: string;
+}
+export interface BatchForecastJobResponse {
+    progress_id: string;
+    progress_url: string;
+    total_series: number;
+    message: string;
+}
+export interface BatchForecastResult {
+    total: number;
+    completed: number;
+    failed: number;
+    results: ForecastResponse[];
+    errors: Array<{
+        series_id: string;
+        error: string;
+    }>;
+}
+export interface ForecastHealthResponse {
+    status: string;
+    models_enabled: ForecastModelName[];
+    device: string;
+    model_load_status: Record<ForecastModelName, boolean>;
+    checkpoints: Record<ForecastModelName, string>;
+}
+export type MacroIndicatorType = 'fed_funds_rate' | 'unemployment_rate' | 'consumer_satisfaction_index';
+export interface MacroMonthlyValue {
+    /** Any date within the target month (server normalises to the 1st). */
+    month: IsoDate;
+    value: number;
+}
+export interface MacroUpsertRequest {
+    indicator: MacroIndicatorType;
+    /** Monthly data points to upsert. Duplicate months are deduplicated (last value wins). */
+    data: MacroMonthlyValue[];
+    /** Optional label for the originating system, e.g. 'FRED', 'BLS', 'internal'. */
+    source?: string;
+}
+export interface MacroUpsertResponse {
+    indicator: MacroIndicatorType;
+    total_submitted: number;
+    inserted: number;
+    updated: number;
+    skipped: number;
+}
+export interface MacroDataPoint {
+    indicator: MacroIndicatorType;
+    month: IsoDate;
+    value: number;
+    source: string | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface MacroQueryResponse {
+    indicator: MacroIndicatorType;
+    total: number;
+    data: MacroDataPoint[];
+}
+export interface MacroQueryOptions {
+    /** First month to include (any day in that month, e.g. '2023-01-01'). */
+    start_month?: IsoDate;
+    /** Last month to include (any day in that month, e.g. '2023-12-01'). */
+    end_month?: IsoDate;
+}
+export interface MacroTypeInfo {
+    key: MacroIndicatorType;
+    label: string;
+    description: string;
+    unit: string;
+    /** Most recent month for which data is stored. null when no data loaded yet. */
+    latest_month: IsoDate | null;
+    /** Timestamp of the most recent write for this indicator. null when no data loaded yet. */
+    last_updated_at: string | null;
+}
+export interface MacroTypesResponse {
+    types: MacroTypeInfo[];
+}
+export interface HealthResponse {
+    status: string;
+    timestamp: string;
+    database_connected: boolean;
+    redis_connected: boolean;
+    llm_enabled: boolean;
+    version: string;
+}
+export interface TableInfoColumn {
+    column_name: string;
+    data_type: string;
+    is_nullable: string;
+    character_maximum_length: number | null;
+    numeric_precision: number | null;
+    numeric_scale: number | null;
+}
+export interface TableInfoResponse {
+    table_name: string;
+    columns: TableInfoColumn[];
+}
+export interface Tool {
+    name: string;
+    description: string;
+    parameters: Record<string, unknown>;
+}
+export interface ToolCall {
+    id: string;
+    name: string;
+    arguments: Record<string, unknown>;
+}
+export interface ToolResult {
+    tool_call_id: string;
+    content: string | Record<string, unknown>;
+    is_error?: boolean;
+}
+export type MessageRole = 'system' | 'user' | 'assistant' | 'tool';
+export interface ConversationMessage {
+    role: MessageRole;
+    content?: string | null;
+    tool_calls?: ToolCall[] | null;
+    tool_call_id?: string | null;
+}
+export interface StreamingChatRequest {
+    messages: ConversationMessage[];
+    system_prompt?: string | null;
+    model?: string | null;
+    temperature?: number | null;
+    max_tokens?: number | null;
+    tools?: Tool[] | null;
+}
+export type ChatChunkType = 'chunk' | 'tool_call' | 'done' | 'error';
+export interface ChatChunk {
+    type: ChatChunkType;
+    delta?: string;
+    tool_call?: ToolCall;
+    usage?: Record<string, unknown>;
+    stop_reason?: string;
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+export interface StructuredRequest {
+    messages: ConversationMessage[];
+    schema: Record<string, unknown>;
+    system_prompt?: string | null;
+    model?: string | null;
+    temperature?: number | null;
+    max_tokens?: number | null;
+    max_repair_retries?: number;
+}
+export interface StructuredResponse {
+    result: Record<string, unknown>;
+    model: string;
+    usage: Record<string, unknown>;
+    repair_attempts: number;
+}
+export type JobStatus = 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled';
+export interface SubmitJobRequest {
+    type: string;
+    input?: Record<string, unknown>;
+    correlation_id?: string;
+    callback_url?: string;
+}
+export interface JobResponse {
+    id: string;
+    tenant_id?: string | null;
+    type: string;
+    status: JobStatus;
+    input: Record<string, unknown>;
+    result?: Record<string, unknown> | null;
+    error?: Record<string, unknown> | null;
+    progress?: number | null;
+    progress_message?: string | null;
+    correlation_id?: string | null;
+    callback_url?: string | null;
+    created_at: string;
+    started_at?: string | null;
+    finished_at?: string | null;
+    cancelled_at?: string | null;
+}
+export interface JobListResponse {
+    jobs: JobResponse[];
+}
+export interface JobListOptions {
+    status?: JobStatus;
+    type?: string;
+    limit?: number;
+}
+export interface JobResultDoneResponse {
+    status: 'succeeded';
+    result: Record<string, unknown>;
+}
+export interface JobResultPendingResponse {
+    status: 'queued' | 'running';
+    progress?: number | null;
+    progress_message?: string | null;
+}
+export interface PromptVersion {
+    prompt_id: string;
+    version: number;
+    description?: string | null;
+    body: string;
+    variables: string[];
+    output_schema?: Record<string, unknown> | null;
+    created_by?: string | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface PromptListResponse {
+    prompt_ids: string[];
+}
+export interface PromptVersionsResponse {
+    prompt_id: string;
+    versions: PromptVersion[];
+}
+export interface CreatePromptVersionRequest {
+    body: string;
+    variables?: string[];
+    output_schema?: Record<string, unknown> | null;
+    description?: string | null;
+}
+export interface UpsertOverrideRequest {
+    body: string;
+    variables?: string[];
+    output_schema?: Record<string, unknown> | null;
+    description?: string | null;
+}
+export interface TenantPromptOverrideResponse {
+    tenant_id: string;
+    prompt_id: string;
+    body: string;
+    variables: string[];
+    output_schema?: Record<string, unknown> | null;
+    created_by?: string | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface RenderPromptRequest {
+    variables?: Record<string, unknown>;
+    tenant_id?: string;
+}
+export interface RenderPromptResponse {
+    rendered: string;
+    prompt_id: string;
+    version?: number | null;
+    source: 'override' | 'base';
+    output_schema?: Record<string, unknown> | null;
+}
+export interface RagUpsertItem {
+    id?: string;
+    text: string;
+    vector?: number[];
+    metadata?: Record<string, unknown>;
+}
+export interface RagUpsertRequest {
+    collection: string;
+    items: RagUpsertItem[];
+}
+export interface RagUpsertResponse {
+    upserted: number;
+    collection: string;
+}
+export interface RagRetrieveRequest {
+    collection: string;
+    query: string;
+    k?: number;
+    filters?: Record<string, unknown>;
+}
+export interface RagMatch {
+    id: string;
+    score: number;
+    text: string;
+    metadata: Record<string, unknown>;
+}
+export interface RagRetrieveResponse {
+    matches: RagMatch[];
+    collection: string;
+}
+export interface CreateConversationRequest {
+    title?: string | null;
+    metadata?: Record<string, unknown>;
+    model?: string | null;
+}
+export interface ConversationMessageResponse {
+    id: number;
+    role: MessageRole;
+    content?: string | null;
+    tool_calls?: ToolCall[] | null;
+    tool_call_id?: string | null;
+    usage?: Record<string, unknown> | null;
+    created_at: string;
+}
+export interface ConversationResponse {
+    id: string;
+    tenant_id: string;
+    user_id?: string | null;
+    title?: string | null;
+    metadata: Record<string, unknown>;
+    model?: string | null;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    messages?: ConversationMessageResponse[] | null;
+}
+export interface ConversationListResponse {
+    conversations: ConversationResponse[];
+}
+export interface ConversationListOptions {
+    user_only?: boolean;
+    include_deleted?: boolean;
+    limit?: number;
+    rfq_id?: string;
+    bom_id?: string;
+    program_id?: string;
+    feature?: string;
+}
+export interface AppendMessageRequest {
+    role?: MessageRole;
+    content?: string | null;
+    tool_calls?: ToolCall[] | null;
+    tool_call_id?: string | null;
+}
+export type DocumentFormat = 'docx' | 'pdf' | 'csv' | 'html';
+export interface GenerateDocumentRequest {
+    prompt_id: string;
+    format?: DocumentFormat;
+    filename?: string;
+    variables?: Record<string, unknown>;
+    correlation_id?: string;
+    callback_url?: string;
+}
+export interface GenerateDocumentResponse {
+    job_id: string;
+    status: JobStatus;
+    type: string;
+}
+/**
+ * Shape of `JobResponse.result` once a document_generate job succeeds.
+ * Fetch via `client.jobs.result(jobId)`.
+ */
+export interface DocumentJobResult {
+    url: string;
+    backend: 'local' | 's3';
+    storage_key: string;
+    expires_at?: string | null;
+    format: DocumentFormat;
+    filename: string;
+    size_bytes: number;
+    title?: string | null;
+    sections: string[];
+    model?: string | null;
+    usage?: Record<string, unknown>;
+    prompt: {
+        id: string;
+        version?: number | null;
+        source: 'override' | 'base';
+    };
+}
+//# sourceMappingURL=types.d.ts.map