@luzmo/analytics-components-kit 1.0.5-beta.1 → 1.0.5-beta.2

package/react/utils/base/index.d.ts

@@ -1,5 +0,0 @@
-export { LuzmoElement, LuzmoMixin } from './base';
-export { Focusable } from './focusable';
-export { LocalizedMixin } from './localized-mixin';
-export { ElementSizes, SizedMixin } from './sized-mixin';
-export type { ElementSize } from './sized-mixin';

package/react/utils/base/localized-mixin.d.ts

@@ -1,22 +0,0 @@
-import { LitElement } from 'lit';
-type Constructor<T = {}> = new (...args: any[]) => T;
-/**
- * A mixin that provides locale synchronization for components using lit-localize.
- *
- * This mixin:
- * - Adds a `language` property (default: 'en')
- * - Syncs the global locale on first mount (handles case where language equals class default)
- * - Syncs the global locale when the language property changes
- *
- * Usage:
- * ```ts
- * @localized()
- * export class MyComponent extends LocalizedMixin(LitElement) {
- *   // language property and locale sync inherited
- * }
- * ```
- */
-export declare const LocalizedMixin: <T extends Constructor<LitElement>>(Base: T) => Constructor<{
-    language: string;
-}> & T;
-export {};

package/react/utils/base/sized-mixin.d.ts

@@ -1,17 +0,0 @@
-import { ReactiveElement } from 'lit';
-type Constructor<T = Record<string, unknown>> = {
-    new (...args: any[]): T;
-    prototype: T;
-};
-export type ElementSize = 'xxs' | 'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl';
-export declare const ElementSizes: Record<string, ElementSize>;
-export type DefaultElementSize = Exclude<ElementSize, 'xxs' | 'xs' | 'xxl'>;
-export interface SizedElementInterface {
-    size: ElementSize;
-}
-export declare function SizedMixin<T extends Constructor<ReactiveElement>>(constructor: T, { validSizes, noDefaultSize, defaultSize }?: {
-    validSizes?: ElementSize[];
-    noDefaultSize?: boolean;
-    defaultSize?: ElementSize;
-}): T & Constructor<SizedElementInterface>;
-export {};

package/react/utils/color/color-palettes.d.ts

@@ -1,17 +0,0 @@
-export type ColorValue = {
-    colors3?: string[];
-    colors4?: string[];
-    colors5?: string[];
-    colors6?: string[];
-    colors7?: string[];
-    colors8?: string[];
-    colors9?: string[];
-    colors10?: string[];
-    colors11?: string[];
-    colors12?: string[];
-    type: 'divergent' | 'qualitative' | 'sequential' | 'heat';
-};
-export type ColorMap = Record<ColorsClassKey, ColorValue>;
-export type ColorsClassKey = 'Spectral' | 'RdYlGn' | 'RdBu' | 'PiYG' | 'PRGn' | 'RdYlBu' | 'BrBG' | 'RdGy' | 'PuOr' | 'Paired' | 'Set1' | 'Set3' | 'OrRd' | 'PuBu' | 'BuPu' | 'Oranges' | 'BuGn' | 'GnBu' | 'YlOrBr' | 'YlGn' | 'Reds' | 'RdPu' | 'Greens' | 'YlGnBu' | 'Purples' | 'Greys' | 'YlOrRd' | 'PuRd' | 'Blues' | 'PuBuGn' | 'Spectrum' | 'BlueRed' | 'Plasma' | 'Viris' | 'Incan' | 'Fire' | 'Inferno' | 'Ocean' | 'Sunrise';
-export declare function getColorMaps(): ColorMap;
-export declare function getColorMapKeys(type?: 'divergent' | 'qualitative' | 'sequential' | 'heat'): string[];

package/react/utils/color/extrapolate-color.d.ts

@@ -1 +0,0 @@
-export declare const extrapolateNewColor: (colorStrings: string[], percent?: number) => string;

package/react/utils/data/load-data-fields-for-datasets.d.ts

@@ -1,22 +0,0 @@
-import { type DataBrokerConfig } from '../data-broker/index';
-import { DatasetWithDataFields } from '../transformations/convert-datasets-to-data-fields';
-export interface LoadDataFieldsOptions {
-    dataBrokerConfig: DataBrokerConfig;
-}
-/**
- * Convenience helper that configures the shared DataBroker instance,
- * loads the requested datasets with their metadata, and converts them into
- * data fields the UI components understand.
- *
- * @param datasetIds - Array of dataset IDs to fetch and convert
- * @param options.dataBrokerConfig - DataBroker configuration
- * @param options.dataBrokerConfig.apiUrl - Optional Luzmo API endpoint URL (defaults to https://api.luzmo.com)
- * @param options.dataBrokerConfig.authKey - Optional authentication key for Luzmo API access (required for private datasets)
- * @param options.dataBrokerConfig.authToken - Optional authentication token for Luzmo API access (required for private datasets)
- * @returns Promise that resolves to an array of datasets with their data fields
- * @throws {Error} When datasetIds is empty or invalid
- * @throws {Error} When dataBrokerConfig is missing
- * @throws {Error} When API authentication fails (for private datasets)
- * @throws {Error} When dataset fetching fails
- */
-export declare const loadDataFieldsForDatasets: (datasetIds: string[], options: LoadDataFieldsOptions) => Promise<DatasetWithDataFields[]>;

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

@@ -1,257 +0,0 @@
-import type { Column, Formula, JoinType } from '@luzmo/dashboard-contents-types';
-/**
- * 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;
-}
-export interface DatasetListItem {
-    id: string;
-    name: Record<string, string>;
-    description?: Record<string, string>;
-}
-export interface DatasetColumnMetadata extends Pick<Column, 'id' | 'name' | 'description' | 'type' | 'subtype' | 'format' | 'lowestLevel' | 'expression' | 'joins' | 'duration_levels' | 'duration_format' | 'hierarchyLevels' | 'currency'> {
-    hidden?: boolean;
-    highestLevel?: Column['highestLevel'];
-    hierarchy_enabled?: Column['hierarchy_enabled'];
-}
-export type DatasetFormulaMetadata = Partial<Formula> & Pick<Formula, 'id' | 'name' | 'expression'> & {
-    hidden?: boolean;
-};
-export interface DatasetMetadata extends DatasetListItem {
-    columns: DatasetColumnMetadata[];
-    formulas: DatasetFormulaMetadata[];
-    outgoingJoins?: JoinType[];
-    dateLoaded?: Date;
-}
-export type DatasetSummary = Pick<DatasetMetadata, 'id' | 'name' | 'columns'>;
-interface ApiRequestInclude {
-    model: string;
-    attributes?: string[];
-    include?: ApiRequestInclude[];
-    separate?: boolean;
-    order?: [string, 'asc' | 'desc'][];
-    as?: string;
-}
-interface ApiRequestFindClause {
-    where?: Record<string, unknown>;
-    limit?: number;
-    offset?: number;
-    attributes?: string[];
-    include?: ApiRequestInclude[];
-    queries?: unknown[];
-    search?: {
-        match_types: string[];
-        keyphrase: string;
-    };
-}
-interface ApiRequestPayload {
-    action: 'get';
-    version: string;
-    find?: ApiRequestFindClause;
-    key?: string;
-    token?: string;
-}
-/**
- * The resource types whose expressions can be validated by the backend.
- */
-export type ValidatableResource = 'column' | 'formula';
-/**
- * The properties sent when validating an expression.
- */
-export interface ExpressionValidationProperties {
-    expression: string;
-    explain_error?: boolean;
-}
-interface ValidateRequestPayload {
-    action: 'validate';
-    version: string;
-    properties: ExpressionValidationProperties;
-    key?: string;
-    token?: string;
-}
-/**
- * The normalized result of an expression validation call.
- */
-export interface ExpressionValidationResult {
-    valid: boolean;
-    reason?: string;
-    explanation?: string;
-    type?: Column['type'];
-}
-interface PaginatedApiResponse<T> {
-    data: T[];
-    pagination: PaginationResult;
-}
-interface DatasetSearchResult {
-    data: DatasetListItem[];
-    pagination?: PaginationResult;
-}
-interface PaginationOptions {
-    offset?: number;
-    limit?: number;
-}
-interface PaginationResult {
-    offset: number;
-    limit: number;
-    total: number;
-    pages: number;
-}
-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;
-    private availableDatasets;
-    constructor(config?: DataBrokerConfig);
-    /**
-     * Strips default ports (:443 for https, :80 for http) so
-     * 'https://api.luzmo.com:443' and 'https://api.luzmo.com' are treated as equal.
-     */
-    private _normalizeUrl;
-    /**
-     * Set API configuration
-     * @param config - API configuration
-     */
-    configure(config?: DataBrokerConfig): void;
-    /**
-     * Clear all locally cached data.
-     * Call this when a user logs out to prevent data from one user
-     * being shown to another user.
-     */
-    clearLocalCache(): 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?: ApiRequestPayload | ValidateRequestPayload, options?: RequestInit): Promise<T>;
-    /**
-     * Fetch all available datasets with pagination support
-     * @param options - Pagination options
-     * @returns Paginated list of datasets
-     */
-    fetchAllDatasets(options?: PaginationOptions): Promise<PaginatedApiResponse<DatasetListItem>>;
-    /**
-     * Search datasets by name or description
-     * @param query - Search query
-     * @returns List of matching datasets
-     */
-    searchDatasets(query: string, options?: PaginationOptions): Promise<DatasetSearchResult>;
-    /**
-     * Fetches lightweight dataset info (id, name, description only) for specific IDs.
-     * Use this for populating dataset pickers without loading column/formula data.
-     * @param datasetIds - Array of dataset IDs to fetch
-     * @returns Promise that resolves to an array of DatasetListItem objects
-     * @throws Error if datasetIds is empty or null, or if no valid UUIDs are provided
-     */
-    fetchDatasetNames(datasetIds: string[]): Promise<DatasetListItem[]>;
-    /**
-     * Fetches multiple datasets with their associated columns and formulas metadata
-     * @param datasetIds - Array of dataset IDs to fetch
-     * @returns Promise that resolves to an array of DatasetMetadata objects containing:
-     * - Basic dataset info (id, name, description)
-     * - Columns with metadata including joins, hierarchy levels, and currency info
-     * - Formulas with their expressions and currency associations
-     * @throws Error if datasetIds is empty or null, or if no valid UUIDs are provided
-     */
-    fetchDatasetsWithColumnsAndFormulas(datasetIds: string[]): Promise<DatasetMetadata[]>;
-    /**
-     * 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;
-    }>;
-    /**
-     * Validates a column or formula expression against the Luzmo API.
-     *
-     * This is the REST equivalent of the legacy socket `validate` action: it POSTs
-     * to `/{version}/{resource}` with `{ action: 'validate', properties }`.
-     *
-     * @param resource - The resource whose expression is validated ('column' or 'formula').
-     * @param properties - The expression and options to validate.
-     * @returns A normalized validation result. When the backend cannot be reached,
-     *   the error is thrown so callers can fall back to local-only validation.
-     */
-    validate(resource: ValidatableResource, properties: ExpressionValidationProperties): Promise<ExpressionValidationResult>;
-    /**
-     * Fetch theme by ID with caching
-     * @param themeId - Theme ID
-     * @returns Theme data
-     */
-    fetchTheme(themeId: string): Promise<any>;
-    /**
-     * 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;
-    fetchDatasetsRecursive(initialDatasetIds: string[]): Promise<DatasetMetadata[]>;
-    private postProcessDatasetMetadata;
-    getAvailableDatasets(): DatasetSummary[];
-    getLinkedDatasetsIds(datasetId: string): string[];
-}
-export declare const dataBroker: DataBroker;
-export default DataBroker;

package/react/utils/data-field-types/calculate-data-field-icon.d.ts

@@ -1,12 +0,0 @@
-import { IconDefinition } from '@luzmo/icons';
-import { ElementSize } from '@luzmo/lucero';
-import type { DatasetDataField } from '../../types/dataset-data-field.types';
-export type DataFieldIconType = 'array[hierarchy]' | 'array[datetime]' | 'array[numeric]' | 'array[currency]' | 'array[duration]' | 'coordinates' | 'currency' | 'date' | 'datetime' | 'derived' | 'duration' | 'hierarchy' | 'image' | 'numeric' | 'spatial' | 'topography' | 'ipaddress' | 'formula';
-export type IconSize = Extract<ElementSize, 's' | 'm' | 'l' | 'xl'>;
-export declare const dataIconTree: Record<DataFieldIconType, Record<IconSize, IconDefinition>>;
-export declare const dataIconSizeByElementSize: Record<ElementSize, IconSize>;
-export declare const normalizeDataIconSize: (size?: ElementSize) => IconSize;
-export declare const calculateDataFieldIcon: (data: Pick<DatasetDataField, "type" | "subtype" | "lowestLevel">, size?: ElementSize) => IconDefinition;
-export declare const calculateDataFieldSecondaryIcon: (data: Pick<DatasetDataField, "formulaId" | "columnId" | "expression"> & {
-    formula?: string;
-}, size?: ElementSize) => IconDefinition | undefined;

package/react/utils/data-field-types/default-acceptable-data-field-types.d.ts

@@ -1 +0,0 @@
-export declare const DEFAULT_ACCEPTABLE_DATA_FIELD_TYPES: readonly ["datetime", "hierarchy", "numeric", "spatial", "array[datetime]", "array[numeric]", "array[hierarchy]", "array[spatial]"];

package/react/utils/data-field-types/tests/calculate-data-field-icon.test.d.ts

@@ -1 +0,0 @@
-export {};

package/react/utils/drag/draggable.d.ts

@@ -1,13 +0,0 @@
-export interface DraggableOptions {
-    /** The element that will move */
-    element: HTMLElement;
-    /** Element that receives pointerdown to start drag */
-    handle: HTMLElement;
-    /** Optional element whose bounding box acts as clamp */
-    boundary?: HTMLElement | null;
-    /** Callback when drag starts */
-    onDragStart?: () => void;
-    /** Callback when drag ends */
-    onDragEnd?: () => void;
-}
-export declare function makeDraggable({ element, handle, boundary, onDragStart, onDragEnd }: DraggableOptions): () => void;

package/react/utils/drag/pragmatic-element-adapter.d.ts

@@ -1,2 +0,0 @@
-import * as elementAdapter from '@atlaskit/pragmatic-drag-and-drop/element/adapter';
-export declare const draggable: typeof elementAdapter.draggable, dropTargetForElements: (args: import("@atlaskit/pragmatic-drag-and-drop/dist/types/internal-types").DropTargetArgs<import("@atlaskit/pragmatic-drag-and-drop/dist/types/internal-types").ElementDragType>) => import("@atlaskit/pragmatic-drag-and-drop/dist/types/internal-types").CleanupFn, monitorForElements: (args: import("@atlaskit/pragmatic-drag-and-drop/dist/types/internal-types").MonitorArgs<import("@atlaskit/pragmatic-drag-and-drop/dist/types/internal-types").ElementDragType>) => import("@atlaskit/pragmatic-drag-and-drop/dist/types/internal-types").CleanupFn;

package/react/utils/drag/tests/pragmatic-element-adapter.first-import.test.d.ts

@@ -1 +0,0 @@
-export {};

package/react/utils/drag/tests/pragmatic-element-adapter.test.d.ts

@@ -1 +0,0 @@
-export {};

package/react/utils/filters/expressions.d.ts

@@ -1,15 +0,0 @@
-import { ColumnSubtype, ColumnType } from '@luzmo/dashboard-contents-types';
-export type FilterExpressionConfiguration = {
-    id: string;
-    key: FilterExpressionKey;
-    expression: FilterExpressionKey;
-    unit?: number;
-    name: string;
-    description: string;
-    tiny: string;
-    type: ColumnType[];
-    subtype?: ColumnSubtype[];
-};
-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' | 'more_than_ago' | 'or_more_ago' | 'next_full' | 'to_date' | '? is null' | '? is not null';
-export declare const filterExpressionsConfigurations: () => FilterExpressionConfiguration[];
-export declare const getValidExpressions: (type?: ColumnType, subtype?: ColumnSubtype, isFormula?: boolean) => FilterExpressionConfiguration[];

package/react/utils/filters/index.d.ts

@@ -1 +0,0 @@
-export * from './expressions';

package/react/utils/formatter/calculate-duration.d.ts

@@ -1,2 +0,0 @@
-export declare function calculateDuration(value: number, inputLevel: number, outputLevel: number): number | undefined;
-export declare function buildDurationString(value: number, content: any, selectedLevels: any, localFormats: any): string;

package/react/utils/formatter/decompose-numeric-format.d.ts

@@ -1,11 +0,0 @@
-export declare function decomposeNumericFormat(format: string): {
-    fill: string;
-    align: string;
-    sign: string;
-    symbol: string;
-    zfill: string;
-    width: unknown;
-    comma: string;
-    precision: string;
-    typeFormat: string;
-};

package/react/utils/formatter/default-local-formats.d.ts

@@ -1,20 +0,0 @@
-export declare const DEFAULT_LOCAL_FORMATS: {
-    decimal: string;
-    thousands: string;
-    grouping: number[];
-    currency: string[];
-    dateTime: string;
-    date: string;
-    dateSeparator: string;
-    time: string;
-    periods: string[];
-    days: string[];
-    shortDays: string[];
-    months: string[];
-    shortMonths: string[];
-    levels: string[];
-    shortLevels: string[];
-    durationLongSuffix: string[];
-    durationShortSuffix: string[];
-    multi: string[];
-};

package/react/utils/formatter/formats/cs.d.ts

@@ -1,20 +0,0 @@
-declare const _default: {
-    decimal: string;
-    thousands: string;
-    grouping: number[];
-    currency: string[];
-    dateTime: string;
-    date: string;
-    dateSeparator: string;
-    time: string;
-    periods: string[];
-    days: string[];
-    shortDays: string[];
-    months: string[];
-    shortMonths: string[];
-    levels: string[];
-    durationLongSuffix: string[];
-    durationShortSuffix: string[];
-    multi: string[];
-};
-export default _default;

package/react/utils/formatter/formats/da.d.ts

@@ -1,20 +0,0 @@
-declare const _default: {
-    decimal: string;
-    thousands: string;
-    grouping: number[];
-    currency: string[];
-    dateTime: string;
-    date: string;
-    dateSeparator: string;
-    time: string;
-    periods: string[];
-    days: string[];
-    shortDays: string[];
-    months: string[];
-    shortMonths: string[];
-    levels: string[];
-    durationLongSuffix: string[];
-    durationShortSuffix: string[];
-    multi: string[];
-};
-export default _default;

package/react/utils/formatter/formats/de.d.ts

@@ -1,21 +0,0 @@
-declare const _default: {
-    decimal: string;
-    thousands: string;
-    grouping: number[];
-    currency: string[];
-    dateTime: string;
-    date: string;
-    dateSeparator: string;
-    time: string;
-    periods: string[];
-    days: string[];
-    shortDays: string[];
-    months: string[];
-    shortMonths: string[];
-    levels: string[];
-    shortLevels: string[];
-    durationLongSuffix: string[];
-    durationShortSuffix: string[];
-    multi: string[];
-};
-export default _default;

package/react/utils/formatter/formats/en-GB.d.ts

@@ -1,21 +0,0 @@
-declare const _default: {
-    currency: string[];
-    date: string;
-    decimal: string;
-    thousands: string;
-    grouping: number[];
-    dateTime: string;
-    dateSeparator: string;
-    time: string;
-    periods: string[];
-    days: string[];
-    shortDays: string[];
-    months: string[];
-    shortMonths: string[];
-    levels: string[];
-    shortLevels: string[];
-    durationLongSuffix: string[];
-    durationShortSuffix: string[];
-    multi: string[];
-};
-export default _default;

package/react/utils/formatter/formats/en-US.d.ts

@@ -1 +0,0 @@
-export { DEFAULT_LOCAL_FORMATS as default } from '../default-local-formats';

package/react/utils/formatter/formats/en.d.ts

@@ -1 +0,0 @@
-export { DEFAULT_LOCAL_FORMATS as default } from '../default-local-formats';

package/react/utils/formatter/formats/es.d.ts

@@ -1,54 +0,0 @@
-declare const _default: {
-    decimal: string;
-    thousands: string;
-    grouping: number[];
-    currency: string[];
-    dateTime: string;
-    date: string;
-    dateSeparator: string;
-    time: string;
-    periods: string[];
-    days: string[];
-    shortDays: string[];
-    months: string[];
-    shortMonths: string[];
-    levels: string[];
-    shortLevels: string[];
-    durationLongSuffix: string[];
-    durationShortSuffix: string[];
-    multi: string[];
-    smartDateFormats: ({
-        key: string;
-        lev1: string;
-        lev2: string;
-        lev3: string;
-        lev4: string;
-        lev5: string;
-        monthType: string;
-        longText: boolean;
-        weekday: boolean;
-        mmdd?: undefined;
-        separator?: undefined;
-    } | {
-        key: string;
-        lev1: string;
-        lev2: string;
-        lev3: string;
-        lev4: string;
-        lev5: string;
-        monthType: string;
-        mmdd: boolean;
-        separator: string;
-        longText?: undefined;
-        weekday?: undefined;
-    })[];
-    smartTimeFormats: {
-        key: string;
-        lev6: string;
-        lev7: string;
-        lev8: string;
-        lev9: string;
-        ampm: boolean;
-    }[];
-};
-export default _default;

package/react/utils/formatter/formats/fi.d.ts

@@ -1,20 +0,0 @@
-declare const _default: {
-    decimal: string;
-    thousands: string;
-    grouping: number[];
-    currency: string[];
-    dateTime: string;
-    date: string;
-    dateSeparator: string;
-    time: string;
-    periods: string[];
-    days: string[];
-    shortDays: string[];
-    months: string[];
-    shortMonths: string[];
-    levels: string[];
-    durationLongSuffix: string[];
-    durationShortSuffix: string[];
-    multi: string[];
-};
-export default _default;