@luzmo/analytics-components-kit 1.0.1-alpha.26 → 1.0.1-alpha.27

package/utils/data-broker/index.d.ts

@@ -0,0 +1,173 @@
+/**
+ * Configuration options for the DataBroker
+ */
+export interface DataBrokerConfig {
+    apiVersion?: string;
+    apiUrl?: string;
+    authKey?: string;
+    authToken?: string;
+    staleTime?: number;
+    gcTime?: number;
+    retry?: number;
+    retryDelay?: (attempt: number) => number;
+}
+/**
+ * Pagination parameters for list requests
+ */
+export interface PaginationOptions {
+    offset?: number;
+    limit?: number;
+}
+/**
+ * Pagination result metadata
+ */
+export interface PaginationResult {
+    offset: number;
+    limit: number;
+    total: number;
+    pages: number;
+}
+/**
+ * Dataset query parameters
+ */
+export interface DatasetQueryParams {
+    filter?: Record<string, any>;
+    sort?: Record<string, 'asc' | 'desc'>;
+    page?: number;
+    limit?: number;
+    columns?: string[];
+}
+/**
+ * Dataset resource
+ */
+export interface Dataset {
+    id: string;
+    name: string;
+    description?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    [key: string]: any;
+}
+/**
+ * Dataset column
+ */
+export interface Column {
+    id: string;
+    name: string;
+    description?: string;
+    dataType: string;
+    category?: string;
+    hidden?: boolean;
+    [key: string]: any;
+}
+/**
+ * Performance metrics
+ */
+export interface PerformanceMetrics {
+    validating: number;
+    preparing: number;
+    queuing: number;
+    querying: number;
+    processing: number;
+    rows: number;
+}
+/**
+ * DataBroker service for Luzmo API
+ * Provides methods to fetch and manipulate data from Luzmo REST API
+ */
+export declare class DataBroker {
+    private apiUrl;
+    private apiVersion;
+    private authKey;
+    private authToken;
+    private queryClient;
+    private static instance;
+    constructor(config?: DataBrokerConfig);
+    /**
+     * Set API configuration
+     * @param config - API configuration
+     */
+    configure(config?: DataBrokerConfig): void;
+    /**
+     * Initialize network status listeners
+     */
+    private initNetworkListeners;
+    /**
+     * Get API headers
+     * @param additionalHeaders - Additional headers to include
+     * @returns Headers for API requests
+     */
+    getHeaders(additionalHeaders?: Record<string, string>): Record<string, string>;
+    /**
+     * Make API request with advanced error handling
+     * Default method is POST and supports an optional JSON body
+     * @param endpoint - API endpoint
+     * @param jsonBody - Optional JSON body to send with request
+     * @param options - Additional fetch options
+     * @returns API response
+     * @throws {Error} If API request fails
+     */
+    fetchApi<T>(endpoint: string, jsonBody?: Record<string, any> | any[], options?: RequestInit): Promise<T>;
+    /**
+     * Fetch all available datasets with pagination support
+     * @param options - Pagination options
+     * @returns Paginated list of datasets
+     */
+    fetchDatasets(options?: PaginationOptions): Promise<{
+        data: Dataset[];
+        pagination: PaginationResult;
+    }>;
+    /**
+     * Search datasets by name or description
+     * @param query - Search query
+     * @returns List of matching datasets
+     */
+    searchDatasets(query: string, options?: PaginationOptions): Promise<Dataset[]>;
+    /**
+     * Fetch a specific dataset by ID
+     * @param datasetId - Dataset ID
+     * @returns Dataset details
+     */
+    fetchDataset(datasetId: string): Promise<Dataset | null>;
+    /**
+     * Fetch data from a dataset with filtering
+     * @param datasetId - Dataset ID
+     * @param queryParams - Query parameters (filters, sort, etc.)
+     * @returns Dataset data
+     */
+    fetchData(query: {
+        dimensions?: any[];
+        measures?: any[];
+        where?: any[];
+        order?: any[];
+        limit?: {
+            by: number;
+            offset: number;
+        };
+        options?: any;
+    }): Promise<{
+        data: any[][];
+        performance: PerformanceMetrics;
+    }>;
+    /**
+     * Refresh all queries
+     */
+    refreshAll(): void;
+    /**
+     * Invalidate cached data for a dataset
+     * @param datasetId - Dataset ID (optional)
+     */
+    invalidateDatasetData(datasetId?: string): void;
+    /**
+     * Invalidate all cached data
+     */
+    invalidateAll(): void;
+    /**
+     * Create a singleton instance
+     * @param config - API configuration
+     * @returns Singleton instance
+     */
+    static getInstance(config?: DataBrokerConfig): DataBroker;
+}
+export declare const dataBroker: DataBroker;
+export default DataBroker;

package/utils/data-item-types/calculate-data-item-icon.d.ts

@@ -0,0 +1,3 @@
+import { IconDefinition } from '@luzmo/icons';
+import { ElementSize } from '@luzmo/lucero';
+export declare const calculateDataItemIcon: (data: any, size?: ElementSize) => IconDefinition;

package/utils/expressions/index.d.ts

@@ -0,0 +1,13 @@
+import { ColumnSubtype, ColumnType } from '../types/column.types';
+export type RichFilterExpression = {
+    key: FilterExpressionKey;
+    name: string;
+    description: string;
+    tiny: string;
+    type: ColumnType[];
+    subtype?: ColumnSubtype[];
+    unit?: number;
+};
+export type FilterExpressionKey = '? = ?' | '? != ?' | '? in ?' | '? not in ?' | '? like ?' | '? not like ?' | '? starts with ?' | '? not starts with ?' | '? ends with ?' | '? not ends with ?' | '? < ?' | '? <= ?' | '? > ?' | '? >= ?' | '? between ?' | 'last_now' | 'last_available' | 'last_completed' | 'next_now' | 'next_full' | 'WTD' | 'MTD' | 'QTD' | 'YTD' | '? is null' | '? is not null';
+export declare const filterExpressionsConfigurations: () => RichFilterExpression[];
+export declare const getValidExpressions: (type?: ColumnType, subtype?: ColumnSubtype, isFormula?: boolean) => RichFilterExpression[];

package/utils/index.d.ts

@@ -2,3 +2,4 @@ export { decomposeNumericFormat } from './formatter/decompose-numeric-format';
 export { formatter } from './formatter/formatter';
 export { localize } from './formatter/localize';
 export { switchItem } from './switch-item';
+export { themes } from './themes';

package/utils/themes/index.d.ts

@@ -0,0 +1,507 @@
+export declare const themes: {
+    default: {
+        name: string;
+        type: string;
+        background: string;
+        itemsBackground: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        font: {
+            fontFamily: string;
+            'font-style': string;
+            'font-weight': number;
+            fontSize: number;
+        };
+        colors: string[];
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        margins: number[];
+        mainColor: string;
+        axis: {};
+        legend: {
+            type: string;
+        };
+        tooltip: {
+            background: string;
+        };
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    default_dark: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        colors: string[];
+        mainColor: string;
+        tooltip: {
+            background: string;
+        };
+        type: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        font: {
+            fontFamily: string;
+            'font-style': string;
+            'font-weight': number;
+            fontSize: number;
+        };
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        margins: number[];
+        axis: {};
+        legend: {
+            type: string;
+        };
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    vivid: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        margins: number[];
+        mainColor: string;
+        legend: {
+            type: string;
+        };
+        tooltip: {};
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        axis: {};
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    seasonal: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        editModeBackground: string;
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        margins: number[];
+        mainColor: string;
+        tooltip: {};
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        axis: {};
+        legend: {
+            type: string;
+        };
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    orion: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        mainColor: string;
+        legend: {
+            type: string;
+        };
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        margins: number[];
+        axis: {};
+        tooltip: {
+            background: string;
+        };
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    royale: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        borders: {
+            'border-radius': string;
+        };
+        margins: number[];
+        mainColor: string;
+        legend: {
+            type: string;
+        };
+        tooltip: {};
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        axis: {};
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    urban: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        margins: number[];
+        mainColor: string;
+        legend: {
+            type: string;
+        };
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        axis: {};
+        tooltip: {
+            background: string;
+        };
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    pinky: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        margins: number[];
+        mainColor: string;
+        legend: {
+            type: string;
+        };
+        tooltip: {};
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        axis: {};
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    bliss: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        editModeBackground: string;
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        margins: number[];
+        mainColor: string;
+        axis: {};
+        legend: {
+            type: string;
+        };
+        tooltip: {};
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    radiant: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        margins: number[];
+        mainColor: string;
+        legend: {
+            type: string;
+        };
+        tooltip: {};
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        axis: {};
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    classic: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        editModeBackground: string;
+        borders: {
+            'border-color': string;
+            'border-style': string;
+            'border-radius': string;
+            'border-top-width': string;
+            'border-left-width': string;
+            'border-right-width': string;
+            'border-bottom-width': string;
+        };
+        margins: number[];
+        mainColor: string;
+        legend: {
+            type: string;
+        };
+        tooltip: {};
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        axis: {};
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+    classic_dark: {
+        name: string;
+        background: string;
+        itemsBackground: string;
+        title: {
+            align: string;
+            bold: boolean;
+            italic: boolean;
+            underline: boolean;
+            border: boolean;
+        };
+        borders: {};
+        margins: number[];
+        mainColor: string;
+        legend: {
+            type: string;
+        };
+        tooltip: {};
+        colors: string[];
+        font: {
+            fontFamily: string;
+            fontSize: number;
+        };
+        type: string;
+        boxShadow: {
+            size: string;
+            color: string;
+        };
+        axis: {};
+        itemSpecific: {
+            rounding: number;
+            padding: number;
+        };
+    };
+};