@luzmo/analytics-components-kit 1.0.1-alpha.86 → 1.0.1-alpha.89

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

@@ -0,0 +1,191 @@
+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;
+}
+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;
+}
+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);
+    /**
+     * 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?: ApiRequestPayload, 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 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
+     */
+    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;
+    }>;
+    /**
+     * 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/angular/utils/data-item-types/calculate-data-item-icon.d.ts

@@ -0,0 +1,10 @@
+import { IconDefinition } from '@luzmo/icons';
+import { ElementSize } from '@luzmo/lucero';
+import type { DraggableDataItemData } from '../../components/draggable-data-item/types';
+export type DataItemIconType = '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<DataItemIconType, Record<IconSize, IconDefinition>>;
+export declare const dataIconSizeByElementSize: Record<ElementSize, IconSize>;
+export declare const normalizeDataIconSize: (size?: ElementSize) => IconSize;
+export declare const calculateDataItemIcon: (data: Pick<DraggableDataItemData, "type" | "subtype" | "lowestLevel">, size?: ElementSize) => IconDefinition;
+export declare const calculateDataItemSecondaryIcon: (data: Pick<DraggableDataItemData, "formulaId" | "columnId" | "expression">, size?: ElementSize) => IconDefinition | undefined;

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

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

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

@@ -0,0 +1,13 @@
+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/angular/utils/filters/expressions.d.ts

@@ -0,0 +1,15 @@
+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' | '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/angular/utils/filters/index.d.ts

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

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

@@ -0,0 +1,2 @@
+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/angular/utils/formatter/decompose-numeric-format.d.ts

@@ -0,0 +1,11 @@
+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/angular/utils/formatter/default-local-formats.d.ts

@@ -0,0 +1,20 @@
+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/angular/utils/formatter/formats/cs.d.ts

@@ -0,0 +1,20 @@
+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/angular/utils/formatter/formats/da.d.ts

@@ -0,0 +1,20 @@
+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/angular/utils/formatter/formats/de.d.ts

@@ -0,0 +1,21 @@
+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/angular/utils/formatter/formats/en-GB.d.ts

@@ -0,0 +1,21 @@
+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/angular/utils/formatter/formats/en-US.d.ts

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

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

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

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

@@ -0,0 +1,54 @@
+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/angular/utils/formatter/formats/fi.d.ts

@@ -0,0 +1,20 @@
+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/angular/utils/formatter/formats/fr.d.ts

@@ -0,0 +1,54 @@
+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/angular/utils/formatter/formats/he.d.ts

@@ -0,0 +1,20 @@
+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/angular/utils/formatter/formats/hu.d.ts

@@ -0,0 +1,20 @@
+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/angular/utils/formatter/formats/it.d.ts

@@ -0,0 +1,54 @@
+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/angular/utils/formatter/formats/ja.d.ts

@@ -0,0 +1,20 @@
+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/angular/utils/formatter/formats/ko.d.ts

@@ -0,0 +1,20 @@
+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/angular/utils/formatter/formats/mk.d.ts

@@ -0,0 +1,20 @@
+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/angular/utils/formatter/formats/nl.d.ts

@@ -0,0 +1,21 @@
+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;