deepspotscreen-sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,146 @@
+export declare interface ComponentConfig {
+    id: string;
+    type: ComponentType;
+    title: string;
+    position: ComponentPosition;
+    tabId: string;
+    pageId: string;
+    properties?: {
+        xAxis?: string;
+        yAxis?: string | string[];
+        selectedYAxisColumn?: any;
+        columns?: string[];
+        metric?: string;
+        aggregation?: string;
+        prefix?: string;
+        suffix?: string;
+        currencySymbol?: string;
+        backgroundColor?: string;
+        textColor?: string;
+        colors?: Record<string, string>;
+        showLegend?: boolean;
+        xAxisLabel?: string;
+        yAxisLabel?: string;
+        content?: string;
+        style?: Record<string, any>;
+    };
+}
+
+declare interface ComponentPosition {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+
+declare type ComponentType = 'bar' | 'line' | 'pie' | 'donut' | 'area' | 'table' | 'number-card' | 'filter' | 'text';
+
+export declare interface DashboardPage {
+    pageId: string;
+    title: string;
+    backgroundColor?: string;
+    tabs: PageTab[];
+}
+
+export declare class DeepspotSDK {
+    private readonly apiClient;
+    constructor(config: SDKConfig);
+    embedDashboard(options: EmbedDashboardOptions): Promise<EmbedInstance>;
+    embedReport(options: EmbedReportOptions): Promise<EmbedInstance>;
+    private createRoot;
+    private showLoading;
+    private showError;
+}
+
+export declare interface EmbedDashboardOptions {
+    dashboardId: string;
+    container: string | HTMLElement;
+    /** Controls what navigation is visible and what gets lazy-loaded */
+    embedLevel?: EmbedLevel;
+    userId?: string;
+    tenantId?: string;
+    theme?: 'light' | 'dark';
+    filters?: Record<string, any>;
+    /** Initial page to show — required for embedLevel 'tab' and 'page' */
+    pageId?: string;
+    /** Initial tab to show — required for embedLevel 'tab' */
+    tabId?: string;
+    hideFilters?: boolean;
+    hideExport?: boolean;
+    height?: string;
+    onReady?: () => void;
+    onFilterChange?: (filters: Record<string, any>) => void;
+    onTabSwitch?: (pageId: string, tabId: string) => void;
+    onPageSwitch?: (pageId: string) => void;
+    onError?: (error: string) => void;
+}
+
+export declare interface EmbedInstance {
+    setFilter(field: string, value: any): void;
+    setFilters(filters: Record<string, any>): void;
+    goToPage(pageId: string): void;
+    goToTab(pageId: string, tabId: string): void;
+    refresh(): void;
+    exportPDF(): void;
+    destroy(): void;
+}
+
+declare type EmbedLevel = 'report' | 'tab' | 'page' | 'dashboard';
+
+export declare interface EmbedReportOptions {
+    dashboardId: string;
+    componentId: string;
+    container: string | HTMLElement;
+    userId?: string;
+    tenantId?: string;
+    theme?: 'light' | 'dark';
+    filters?: Record<string, any>;
+    height?: string;
+    onReady?: () => void;
+    onError?: (error: string) => void;
+}
+
+export declare interface FilterDefinition {
+    filterId: string;
+    label: string;
+    type: 'dropdown' | 'multi-select' | 'date-range' | 'text-input' | 'number-input';
+    options?: string[];
+    defaultValue?: any;
+    targetComponents: string[];
+    filterOperator?: string;
+    applyToField?: string;
+}
+
+export declare interface PageTab {
+    id: string;
+    title: string;
+    tabOrder?: number;
+    isDefault?: boolean;
+}
+
+export declare interface RenderResponse {
+    embedType: 'dashboard' | 'report';
+    embedLevel: EmbedLevel;
+    dashboard: {
+        name: string;
+        theme: 'light' | 'dark';
+        /** ALL pages + tabs metadata — always returned for building navigation */
+        pages: DashboardPage[];
+    };
+    /** Currently active page ID */
+    activePage: string;
+    /** Currently active tab ID */
+    activeTab: string;
+    /** ONLY components belonging to the active page + tab */
+    components: ComponentConfig[];
+    /** Pre-executed SQL results — only for active tab's components */
+    data: Record<string, Record<string, any>[]>;
+    filters: FilterDefinition[];
+}
+
+export declare interface SDKConfig {
+    apiKey: string;
+    baseUrl: string;
+}
+
+export { }