@quillsql/admin 1.8.3 → 1.8.5

package/dist/index.d.ts

@@ -1,7 +1,43 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import React, { CSSProperties } from 'react';
-import { EventTracking, QuillReport } from '@quillsql/react';
+import * as React$1 from 'react';
+import React__default, { CSSProperties, ForwardRefExoticComponent, RefAttributes } from 'react';
+import { EventTracking, InternalFilter, QuillReport as QuillReport$1, QuillTheme as QuillTheme$1 } from '@quillsql/react';
 
+type QuillTenant = {
+    name: string;
+    tenantField: string;
+    clientId: string;
+    id: string;
+    query?: string;
+    mappings?: {
+        [key: string]: {
+            query: string;
+        };
+    };
+    flags?: string[];
+    tenantIds?: {
+        id: string | number;
+        flag: string;
+        label: string;
+    }[];
+    scope: 'row' | 'schema' | 'database';
+    defaultId?: string | number;
+    fieldType?: 'string' | 'number';
+    tenantIdField?: string;
+    tenantLabelField?: string;
+    tenantFlagField?: string;
+} & ({
+    tenantTable?: string;
+    tenantTableQuery?: never;
+} | {
+    tenantTable?: never;
+    tenantTableQuery?: string;
+});
+
+interface ClientFeatures {
+    cloudCache?: boolean;
+    [key: string]: boolean | undefined;
+}
 interface QuillTheme {
     fontFamily?: string;
     backgroundColor?: string;
@@ -25,10 +61,32 @@ interface QuillTheme {
     barChartCornerRadius?: number;
     barChartCornerRadiusRatio?: number;
 }
+interface QuillProviderClient {
+    name: string;
+    clientId: string;
+    publicKey: string;
+    queryEndpoint: string;
+    queryHeaders?: HeadersInit;
+    withCredentials: boolean;
+    databaseType?: string;
+    features?: ClientFeatures;
+    featureFlags?: {
+        [key: string]: boolean;
+    };
+    customerFieldType?: string;
+    allTenantTypes?: QuillTenant[];
+    defaultDashboard?: {
+        name: string;
+        owner: string;
+    };
+    ownerTenantFields?: string[];
+    schemaNames?: string[];
+    adminCustomerId?: string | number;
+}
 
 interface BaseQuillProviderProps {
     publicKey?: string;
-    children?: React.ReactNode;
+    children?: React__default.ReactNode;
     /** @deprecated Use clerkOrgId instead */
     domainName?: string;
     clerkOrgId?: string | null;
@@ -38,9 +96,11 @@ interface BaseQuillProviderProps {
     theme?: QuillTheme;
     eventTracking?: EventTracking | null;
     onRequestAddVirtualTable?: () => void;
+    /** When set, managers hide their built-in environment dropdown (see `State.hideEnvDropdown`). */
+    hideEnvDropdown?: boolean;
 }
 interface QuillCloudProviderProps extends BaseQuillProviderProps {
-    queryEndpoint?: never;
+    queryEndpoint: never;
     queryHeaders?: never;
     withCredentials?: never;
 }
@@ -50,7 +110,398 @@ interface SelfHostedProviderProps extends BaseQuillProviderProps {
     withCredentials?: boolean;
 }
 type QuillProviderProps = QuillCloudProviderProps | SelfHostedProviderProps;
-declare function AdminProvider({ children, publicKey, queryEndpoint, queryHeaders, withCredentials, clerkOrgId, onOnboardComplete, flagsList, getAuthorizationToken, theme, eventTracking, onRequestAddVirtualTable, }: QuillProviderProps): react_jsx_runtime.JSX.Element;
+declare function AdminProvider({ children, publicKey, queryEndpoint, queryHeaders, withCredentials, clerkOrgId, onOnboardComplete, flagsList, getAuthorizationToken, theme, eventTracking, onRequestAddVirtualTable, hideEnvDropdown, }: QuillProviderProps): react_jsx_runtime.JSX.Element;
+
+interface QuillFetchOptions {
+    client: Pick<QuillProviderClient, 'clientId' | 'queryEndpoint' | 'queryHeaders' | 'withCredentials'>;
+    task: string;
+    method?: string;
+    metadata: any;
+    abortSignal?: AbortSignal;
+    credentials?: RequestCredentials;
+    urlParameters?: string;
+    getToken: () => Promise<string>;
+    adminMode?: boolean;
+}
+interface QuillResults {
+    data?: any;
+    queries?: any;
+    status?: string;
+    error?: string;
+    message?: string;
+}
+
+interface ColumnsByTable {
+    tableName: string;
+    displayName: string;
+    columns: {
+        columnName: string;
+        displayName: string;
+        fieldType: string;
+        dataTypeId: number;
+        field: string;
+    }[];
+}
+interface Column {
+    field: string;
+    label: string;
+    format: AxisFormat;
+    name?: string;
+}
+interface ColumnInternal extends Column {
+    fieldType: string;
+    dataTypeID: number;
+    jsType: string;
+    table?: string;
+}
+/**
+ * A set of valid format values for the x and y axes of dashboard items.
+ */
+type AxisFormat = 'percent' | 'dollar_amount' | 'dollar_cents' | 'whole_number' | 'one_decimal_place' | 'two_decimal_places' | 'percentage' | 'string' | 'yyyy' | 'MMM_dd' | 'MMM_yyyy' | 'MMM_dd_yyyy' | 'hh_ap_pm' | 'MMM_dd-MMM_dd' | 'MMM_dd_hh:mm_ap_pm' | 'wo, yyyy';
+type Table = {
+    _id: string;
+    isSelectStar: boolean;
+    displayName: string;
+    name: string;
+    columns: ColumnInternal[];
+    viewQuery: string;
+    customFieldInfo: any;
+    broken?: boolean;
+    error?: string;
+    ownerTenantFields?: string[];
+};
+type Pivot = SingleAggregationPivot | MultiAggregationPivot;
+interface BasePivot {
+    rowField?: string;
+    rowFieldType?: string;
+    columnField?: string;
+    columnFieldType?: string;
+    sort?: boolean;
+    sortDirection?: 'ASC' | 'DESC';
+    sortField?: string;
+    sortFieldType?: string;
+    title?: string;
+    triggerButtonText?: string;
+    rowLimit?: number;
+    columnValues?: string[];
+}
+interface SingleAggregationPivot extends BasePivot {
+    aggregationType: AggregationType;
+    valueField?: string;
+    valueField2?: string;
+    valueField2Type?: string;
+    valueFieldType?: string;
+    aggregations?: never;
+}
+interface MultiAggregationPivot extends BasePivot {
+    aggregationType?: never;
+    valueField?: never;
+    valueField2?: never;
+    valueField2Type?: never;
+    valueFieldType?: never;
+    aggregations: {
+        valueField?: string;
+        valueFieldType?: string;
+        valueField2?: string;
+        valueField2Type?: string;
+        aggregationType: AggregationType;
+    }[];
+}
+type AggregationType = 'sum' | 'average' | 'min' | 'max' | 'count' | 'avg' | 'percentage';
+interface Pagination {
+    rowsPerPage: number;
+    rowsPerRequest: number;
+    page?: number;
+}
+
+/**
+ * ## QuillReport
+ * Represents an individual item on a dashboard.
+ *
+ * Dashboard items can be charts, metric tiles, tables, etc. and can be styled
+ * however you'd like.
+ *
+ * ### API Reference
+ * @see https://docs.quillsql.com/components/quill-provider#quill-report
+ */
+interface QuillReport {
+    /** The report's unique id. */
+    id: string;
+    /** The name of the report. */
+    name: string;
+    /** The name of the dashboard this report belongs to. */
+    dashboardName: string;
+    /** The rows of data returned from this report's query. */
+    rows: {
+        [key: string]: string;
+    }[];
+    /** The columns data returned from this report's query. */
+    columns: Column[];
+    /** The type of this chart. */
+    chartType: string;
+    /** The table and field this report uses for date filtering, if any. */
+    dateField?: {
+        table: string;
+        field: string;
+    };
+    /** The pivot used in this query, if any. */
+    pivot: Pivot | null;
+    /** The label of the xAxis. */
+    xAxisLabel: string;
+    /** The field to use for this report's xAxis. */
+    xAxisField: string;
+    /** The format for this report's xAxis. */
+    xAxisFormat: AxisFormat;
+    /** The template flag for a report */
+    template?: boolean;
+    /**
+     * A list of metadata about the yAxes of this report.
+     */
+    yAxisFields: {
+        /** The field for this yAxis. */
+        field: string;
+        /** The label to use for this yAxis. */
+        label: string;
+        /** The format of the data in this yAxis. */
+        format: AxisFormat;
+    }[];
+    /**
+     * The relative ordering of this report in relation to its siblings. Ordering
+     * starts at 1 and counts up (eg. 1, 2, 3, etc.).
+     *
+     * Also note that reports in the same section are first grouped by `chartType`
+     * and then each group is sorted by `order`. Currently, the first group is the
+     * `metric` reports and the last group is the `table` reports with the rest of
+     * the reports in between.
+     */
+    order: number;
+    /**
+     * The rows of data returned from this report's query over the comparison date
+     * range as opposed to the primary date range.
+     */
+    compareRows: {
+        [key: string]: string;
+    }[];
+    /** An array of filters that have been applied to this query. */
+    filtersApplied?: InternalFilter[];
+    pagination?: Pagination;
+    sort?: {
+        field: string;
+        direction: string;
+    };
+    rowCount: number;
+    queryString: string;
+    filterMap?: {
+        [key: string]: {
+            table: string;
+            field: string;
+        };
+    };
+    /** The pivot row info. */
+    pivotRows?: {
+        [key: string]: string;
+    }[];
+    /**
+     * A list of metadata about the pivot yAxes of this report.
+     */
+    pivotColumns?: ColumnInternal[];
+}
+interface QuillReportInternal extends QuillReport {
+    /** An array of queries that are used to construct the unprocessed report  THIS WILL BE REMOVED SOON */
+    itemQuery?: string[];
+    /** An array of tables referenced by the report used */
+    referencedTables?: string[];
+    /** An mapping of table to the columns referenced in the table. */
+    referencedColumns?: {
+        [table: string]: string[];
+    };
+    /** An error message used for internal purposes */
+    error?: string;
+    /** An admin error message used for internal purposes */
+    adminError?: string;
+    /** An internal flag to force a report to trigger a reload from the backend */
+    triggerReload?: boolean;
+    /** An internal flag to force a report to trigger a reload from the backend */
+    columnInternal: ColumnInternal[];
+    /** Represents if the report is currently loading rows */
+    loading?: boolean;
+    /** Flags on this report */
+    flags?: {
+        [tenantField: string]: string[] | 'QUILL_ALL_TENANTS';
+    };
+}
+
+interface State {
+    loading: boolean;
+    publicKey: string;
+    queryEndpoint: string;
+    queryHeaders: object | undefined;
+    withCredentials: boolean | undefined;
+    client: any;
+    clients: any[];
+    activeQuery: string;
+    activeSavedQueryReportId: string;
+    activeEditItem: QuillReportInternal | undefined;
+    tables: Table[];
+    schema: any[];
+    databaseSchema: {
+        schema: ColumnsByTable[];
+        id: string;
+        loading: boolean;
+    } | undefined;
+    activeComponent: string;
+    reportId: any;
+    report: any;
+    theme: QuillTheme;
+    selectedDashboard: string | null;
+    dateFilter: any;
+    isSelfHosted: boolean;
+    navigateToDashboardManager?: () => void;
+    navigateToDashboardBuilder?: () => void;
+    navigateToVirtualTableBuilder?: (element: any) => void;
+    /** @deprecated Use clerkOrgId instead */
+    domainName?: string;
+    clerkOrgId?: string;
+    databaseTypeMismatch: {
+        show: boolean;
+        backendDatabaseType: string;
+    };
+    templateDashboard?: string;
+    selectedTenantField?: string;
+    selectedTenantValues?: (string | number)[];
+    selectedDashboardTenantIds?: (string | number)[];
+    mappableDashboardTenantIds?: (string | number)[];
+    mappableDashboardTenantIdsLoading?: boolean;
+    currentTenantIdentity?: {
+        tenantField: string;
+        tenantIds: (string | number)[];
+    }[] | (string | number)[];
+    activeSandboxId?: string | null;
+    /**
+     * When true, dashboard / virtual-table surfaces omit the in-page environment
+     * selector (e.g. when the host app renders env selection in a global header).
+     */
+    hideEnvDropdown?: boolean;
+}
+type Action = {
+    type: 'SET_CLIENT';
+    payload: any;
+} | {
+    type: 'SET_CLIENT_AND_TENANTS';
+    payload: any;
+} | {
+    type: 'SET_CLIENTS';
+    payload: any[];
+} | {
+    type: 'UPDATE_CLIENTS';
+    payload: any;
+} | {
+    type: 'SET_ACTIVE_QUERY';
+    payload: string;
+} | {
+    type: 'SET_ACTIVE_SAVED_QUERY_REPORT_ID';
+    payload: string;
+} | {
+    type: 'SET_ACTIVE_EDIT_ITEM';
+    payload: any;
+} | {
+    type: 'SET_TABLES';
+    payload: Table[];
+} | {
+    type: 'SET_ACTIVE_COMPONENT';
+    payload: string;
+} | {
+    type: 'SET_REPORT_ID';
+    payload: any;
+} | {
+    type: 'SET_SELECTED_DASHBOARD_NAME';
+    payload: {
+        dashboard: string | null;
+        reportId?: string | null;
+    } | null;
+} | {
+    type: 'SET_NAVIGATE_TO_DASHBOARD_MANAGER';
+    payload: () => void;
+} | {
+    type: 'SET_NAVIGATE_TO_DASHBOARD_BUILDER';
+    payload: () => void;
+} | {
+    type: 'SET_NAVIGATE_TO_VIRTUAL_TABLE_BUILDER';
+    payload: () => void;
+} | {
+    type: 'SET_DATABASE_TYPE_MISMATCH';
+    payload: {
+        show: boolean;
+        backendDatabaseType: string;
+    };
+} | {
+    type: 'SET_DATABASE_SCHEMA';
+    payload: {
+        schema: ColumnsByTable[];
+        id: string;
+        loading: boolean;
+    };
+} | {
+    type: 'SET_TEMPLATE_DASHBOARD';
+    payload: string;
+} | {
+    type: 'SET_SELECTED_TENANT_FOREIGN_KEY';
+    payload: string | undefined;
+} | {
+    type: 'SET_SELECTED_TENANT_VALUES';
+    payload: (string | number)[] | undefined;
+} | {
+    type: 'SET_SELECTED_DASHBOARD_TENANT_IDS';
+    payload: (string | number)[] | undefined;
+} | {
+    type: 'SET_MAPPABLE_DASHBOARD_TENANT_IDS';
+    payload: (string | number)[] | undefined;
+} | {
+    type: 'SET_MAPPABLE_DASHBOARD_TENANT_IDS_LOADING';
+    payload: boolean;
+} | {
+    type: 'SET_CURRENT_TENANT_IDENTITY';
+    payload: {
+        tenantField: string;
+        tenantIds: (string | number)[];
+    }[] | (string | number)[] | undefined;
+} | {
+    type: 'SET_QUERY_HEADERS';
+    payload: object | undefined;
+} | {
+    type: 'SET_PUBLIC_KEY';
+    payload: string;
+} | {
+    type: 'SET_CLERK_ORG_ID';
+    payload: string;
+} | {
+    type: 'SET_ALL_STATE';
+    payload: any;
+} | {
+    type: 'SET_ACTIVE_SANDBOX_ID';
+    payload: string | null;
+} | {
+    type: 'SET_HIDE_ENV_DROPDOWN';
+    payload: boolean;
+} | {
+    type: 'SET_ASK_AI_BUTTON';
+    payload: React.ComponentType<{
+        label: string;
+        prompt: string;
+    }> | undefined;
+};
+
+declare const useAdmin: () => {
+    state: State;
+    dispatch: React.Dispatch<Action>;
+    clientLoading: boolean;
+    setClient: (client: QuillProviderClient, fetchTenantInfo?: boolean, preserveSelectedDashboard?: boolean) => void;
+    getToken: () => Promise<string>;
+    quillFetchWithToken: (options: Omit<QuillFetchOptions, "getToken">) => Promise<QuillResults>;
+    eventTracking: EventTracking | null;
+    onOnboardComplete?: (client: any) => void;
+    onRequestAddVirtualTable?: () => void;
+};
 
 declare function DashboardManager({ navigateToVirtualTableManager: navigateToVirtualTableManager, containerStyle, }: {
     navigateToVirtualTableManager?: () => void;
@@ -59,7 +510,7 @@ declare function DashboardManager({ navigateToVirtualTableManager: navigateToVir
 
 declare function ChartQueryBuilder({ activeComponent, onExit, containerStyle, destinationDashboard, }: {
     activeComponent: string;
-    onExit?: (report?: QuillReport) => void;
+    onExit?: (report?: QuillReport$1) => void;
     containerStyle?: CSSProperties;
     destinationDashboard: string;
 }): react_jsx_runtime.JSX.Element;
@@ -75,4 +526,169 @@ declare function CreateEnvironment({ onOnboardComplete, containerStyle, }: {
     containerStyle?: CSSProperties;
 }): react_jsx_runtime.JSX.Element;
 
-export { AdminProvider, ChartQueryBuilder as ChartBuilder, CreateEnvironment, DashboardManager, VirtualTableManager };
+interface EnvSelectPopoverProps {
+    clients: any[];
+    setClient: (client: any) => void;
+    client: any;
+    theme: any;
+    onSelectedEditEnvironment?: (environment: string) => void;
+    parentRef: React.RefObject<HTMLDivElement | null>;
+    isLoading?: boolean;
+    onCreateNewEnvironment?: () => void;
+    hideLabel?: boolean;
+    triggerStyle?: React.CSSProperties;
+}
+declare function EnvSelectPopover({ clients, setClient, client, theme, onSelectedEditEnvironment, parentRef, isLoading, onCreateNewEnvironment, hideLabel, triggerStyle, }: EnvSelectPopoverProps): react_jsx_runtime.JSX.Element;
+
+declare function CreateEnvironmentModal({ showCreateEnvironmentModal, setShowCreateEnvironmentModal, }: {
+    showCreateEnvironmentModal: boolean;
+    setShowCreateEnvironmentModal: (show: boolean) => void;
+}): react_jsx_runtime.JSX.Element;
+
+interface TextInputPrimitiveProps {
+    onChange: (e: any) => void;
+    value: string;
+    placeholder?: string;
+    theme?: QuillTheme;
+    disabled?: boolean;
+    width?: string;
+    password?: boolean;
+    style?: React__default.CSSProperties;
+    number?: boolean;
+    min?: number;
+    max?: number;
+    step?: number;
+}
+declare const TextInputPrimitive: React__default.ForwardRefExoticComponent<TextInputPrimitiveProps & React__default.RefAttributes<HTMLInputElement>>;
+
+interface SelectComponentProps {
+    value: string | number | null | undefined;
+    label?: string;
+    width: number;
+    options: {
+        value: string | number;
+        label: string;
+    }[];
+    onChange: (event: React__default.ChangeEvent<HTMLSelectElement>) => void;
+    isLoading?: boolean;
+    hideEmptyOption?: boolean;
+    disabled?: boolean;
+    badge?: string;
+    mimicReactSelect?: boolean;
+    testLabel?: string;
+    displayValue?: boolean;
+    size?: 'default' | 'small';
+}
+/**
+ * A robust select component that implements the new minimal Select interface.
+ */
+declare function QuillSelectComponentWithCombo({ options, value, width, onChange, label, isLoading, hideEmptyOption, disabled, badge, mimicReactSelect, testLabel, displayValue, size, }: SelectComponentProps): react_jsx_runtime.JSX.Element;
+
+declare function EditEnvironmentModal({ isOpen, setIsOpen, onSave, ModalComponent, TextInputComponent, ButtonComponent, HeaderComponent, SecondaryButtonComponent, }: {
+    isOpen: boolean;
+    setIsOpen: (isOpen: boolean) => void;
+    onSave: () => void;
+    ModalComponent: any;
+    TextInputComponent: ForwardRefExoticComponent<TextInputPrimitiveProps & RefAttributes<HTMLInputElement>> | ((props: TextInputPrimitiveProps) => React__default.JSX.Element);
+    ButtonComponent: any;
+    SelectComponent: (props: SelectComponentProps) => React__default.JSX.Element;
+    HeaderComponent: any;
+    SecondaryButtonComponent: any;
+}): react_jsx_runtime.JSX.Element;
+
+type ButtonPrimitiveProps = {
+    onClick: (event: React__default.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
+    label: string;
+    theme?: QuillTheme;
+    style?: React__default.CSSProperties;
+    variant?: 'primary' | 'secondary' | 'danger';
+    disabled?: boolean;
+    type?: 'submit' | 'button' | 'reset';
+};
+declare const ButtonPrimitive: React__default.FC<ButtonPrimitiveProps & {
+    isLoading?: boolean;
+}>;
+
+type SecondaryButtonPrimitiveProps = {
+    onClick: (event: React__default.MouseEvent<HTMLButtonElement>) => void;
+    label: string;
+    theme?: QuillTheme;
+    disabled?: boolean;
+    style?: React__default.CSSProperties;
+};
+declare const SecondaryButtonPrimitive: React__default.FC<SecondaryButtonPrimitiveProps>;
+
+interface ModalComponentProps {
+    children: any;
+    isOpen: boolean;
+    onClose?: () => void;
+    title?: string;
+    theme?: QuillTheme$1;
+    style?: CSSProperties;
+    showHeaderBorder?: boolean;
+}
+
+declare const ModalPrimitive: React$1.ForwardRefExoticComponent<ModalComponentProps & React$1.RefAttributes<HTMLDivElement>>;
+
+type HeaderPrimitiveProps = {
+    label: string;
+    theme?: QuillTheme;
+};
+declare const HeaderPrimitive: React__default.FC<HeaderPrimitiveProps>;
+
+interface AgentChatProps {
+    sandboxClientId: string;
+    sourceClientId: string;
+    agentSessionId: string;
+    getToken: () => Promise<string>;
+}
+declare function AgentChat({ agentSessionId, sandboxClientId, sourceClientId, getToken, }: AgentChatProps): react_jsx_runtime.JSX.Element;
+
+declare function AgentChatPanel(): react_jsx_runtime.JSX.Element | null;
+
+interface ToolCall {
+    id: string;
+    type: 'function';
+    function: {
+        name: string;
+        arguments: string;
+    };
+}
+type ChatMessage = {
+    role: 'user' | 'assistant' | 'tool';
+    content: string | null;
+    isError?: boolean;
+    isWelcome?: boolean;
+    isHiddenContext?: boolean;
+    tool_calls?: ToolCall[];
+    tool_call_id?: string;
+};
+interface SessionInfo {
+    sessionId: string;
+    sourceClientId: string;
+    sourceClientName: string;
+    sandboxClientId: string;
+    sandboxClientName: string;
+    status: string;
+}
+interface AgentChatState {
+    messages: ChatMessage[];
+    setMessages: React.Dispatch<React.SetStateAction<ChatMessage[]>>;
+    session: SessionInfo | null;
+    setSession: React.Dispatch<React.SetStateAction<SessionInfo | null>>;
+    sessionInitializedForClientId: string | null;
+    setSessionInitializedForClientId: React.Dispatch<React.SetStateAction<string | null>>;
+    showToolOutputs: boolean;
+    setShowToolOutputs: React.Dispatch<React.SetStateAction<boolean>>;
+}
+declare function useAgentChat(): AgentChatState;
+
+declare function exportChatAsMarkdown(messages: ChatMessage[]): void;
+
+/**
+ * Environment selector plus create / edit environment modals.
+ * Used in GlobalHeader and can be mounted in host app nav when managers use hideEnvDropdown.
+ */
+declare function EnvironmentSwitcherWithModals(): react_jsx_runtime.JSX.Element;
+
+export { AdminProvider, AgentChat, AgentChatPanel, type AgentChatProps, ButtonPrimitive, ChartQueryBuilder as ChartBuilder, type ChatMessage, CreateEnvironment, CreateEnvironmentModal, DashboardManager, EditEnvironmentModal, EnvSelectPopover, EnvironmentSwitcherWithModals, HeaderPrimitive, ModalPrimitive, QuillSelectComponentWithCombo, SecondaryButtonPrimitive, type SessionInfo, TextInputPrimitive, type ToolCall, VirtualTableManager, exportChatAsMarkdown, useAdmin, useAgentChat };