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

package/react/utils/formula/config/build-datasets.d.ts

@@ -1,10 +0,0 @@
-import type { DatasetWithDataFields } from '../../transformations/convert-datasets-to-data-fields';
-import type { DatasetDataFields } from '../../../components/data-field-panel/types';
-import type { FormulaEditorDataset } from '../../../types/formula.types';
-/**
- * Normalizes datasets provided directly (`DatasetDataFields`) or fetched from the
- * Luzmo API (`DatasetWithDataFields`) into the {@link FormulaEditorDataset} shape
- * consumed by the formula input and store. When more than one dataset is present,
- * each gets an accent color from the shared palette.
- */
-export declare function buildFormulaEditorDatasets(input: (DatasetDataFields | DatasetWithDataFields)[]): FormulaEditorDataset[];

package/react/utils/formula/config/expression-helpers.d.ts

@@ -1,42 +0,0 @@
-import { type FormulaAggregationFunction, type FormulaAggregationFunctionData, type FormulaAggregationWidgetData } from '../../../types/formula.types';
-/**
- * Generates a unique id, preferring the native crypto API when available.
- */
-export declare function generateId(): string;
-/**
- * Returns the placeholder token for a new empty argument.
- */
-export declare function getEmptyArgumentDropExpression(): string;
-/**
- * Returns the placeholder token for an aggregation widget.
- */
-export declare function getAggregationWidgetExpression(aggregationWidgetId: string): string;
-/**
- * Renders the persisted aggregation widget state back into a formula expression.
- */
-export declare function getAggregationFunctionExpression(aggregationWidgetData: FormulaAggregationWidgetData | undefined, aggregationFunctionsDataMap: Record<FormulaAggregationFunction, FormulaAggregationFunctionData>): string;
-/**
- * Replaces the content of every string literal with spaces, keeping the quote
- * characters and the overall length (and thus every index) intact. Run a syntax
- * scan (e.g. an aggregation-function regex) against the masked string so matches
- * inside literals - like `'SUM(x)'` - are ignored, then slice the original.
- */
-export declare function maskStringLiterals(expression: string): string;
-/**
- * Finds the index of the closing parenthesis that matches the (implicit) open
- * parenthesis preceding `startIndex`. Returns -1 when no match is found.
- */
-export declare function getClosingParenthesisIndex(expression: string, startIndex?: number): number;
-/**
- * Parses the include / exclude column lists out of a `GROUPINEX(...)` tail
- * expression of the form `[<included>], [<excluded>]`.
- */
-export declare function getIncludeExcludeColumnsFromExpression(expression: string): {
-    includedColumns: string[];
-    excludedColumns: string[];
-};
-/**
- * Returns the color palette used to color-code datasets when more than one
- * dataset is present.
- */
-export declare function getColorPalette(theme?: 'dark' | 'light'): string[];

package/react/utils/formula/config/functions.d.ts

@@ -1,3 +0,0 @@
-import type { FormulaFunctionCategory, FormulaFunction, FormulaFunctionData } from '../../../types/formula.types';
-export declare function getFormulaFunctionCategories(): FormulaFunctionCategory[];
-export declare function getFormulaFunctionDataMap(): Record<FormulaFunction, FormulaFunctionData>;

package/react/utils/formula/config/groupings.d.ts

@@ -1,9 +0,0 @@
-import { FormulaAggregationGrouping, type FormulaAggregationGroupingData } from '../../../types/formula.types';
-/**
- * The grouping scopes shown in the aggregation widget grouping selector, in display order.
- */
-export declare const formulaAggregationGroupings: FormulaAggregationGrouping[];
-/**
- * Returns the localized metadata for every aggregation grouping scope.
- */
-export declare function getFormulaAggregationGroupingsDataMap(): Record<FormulaAggregationGrouping, FormulaAggregationGroupingData>;

package/react/utils/formula/config/regex.d.ts

@@ -1,39 +0,0 @@
-/**
- * Regular expressions used to tokenize and transform formula expressions.
- *
- * Tokens used internally by the editor:
- * - `##EMPTYARG-<uuid>##`  -> an empty argument awaiting input
- * - `{<datasetId>:<columnId>}` -> a column reference
- * - `##AGGR-<uuid>##`  -> an aggregation widget placeholder
- */
-/**
- * Matches an empty argument, a column reference, or an aggregation widget placeholder.
- * Capture groups: 1 = emptyArgumentId, 2 = `datasetId:columnId`, 3 = aggregationWidgetId.
- */
-export declare const regexpToMatchEmptyArgumentOrColumnOrAggregationWidget: RegExp;
-/**
- * Matches an empty argument or a column reference (no aggregation widgets).
- * Capture groups: 1 = emptyArgumentId, 2 = `datasetId:columnId`.
- */
-export declare const regexpToMatchEmptyArgumentOrColumn: RegExp;
-/**
- * Matches the start of an aggregation function, optionally wrapped in a grouping function.
- * Capture groups: 1 = grouping wrapper incl. `(`, 2 = grouping name, 3 = aggregation function.
- */
-export declare const regexpToMatchAggregationFunctionStart: RegExp;
-/**
- * Matches an aggregation function that has no arguments (an empty aggregation).
- */
-export declare const regexpToMatchEmptyAggregationFunction: RegExp;
-/**
- * Matches a single aggregation widget placeholder. Capture group 1 = aggregationWidgetId.
- */
-export declare const regexpToMatchAggregationWidget: RegExp;
-/**
- * Matches array content (used to parse the include / exclude column lists).
- */
-export declare const regexpToMatchArrayContent: RegExp;
-/**
- * Matches a column reference `{datasetId:columnId}`.
- */
-export declare const regexpToMatchColumn: RegExp;

package/react/utils/formula/config/resolve-column-presentation.d.ts

@@ -1,19 +0,0 @@
-import type { IconDefinition } from '@luzmo/icons';
-import type { DatasetDataField } from '../../../types/dataset-data-field.types';
-/** The shared presentation (data-type icon + localized label) of a column reference. */
-export interface ColumnPresentation {
-    icon: IconDefinition;
-    label: string;
-}
-/**
- * Resolves how a column reference is presented in the formula surfaces: its
- * data-type icon and its localized label. Shared by the read-only display
- * (`luzmo-formula`) and the CodeMirror column-pill widget so both render columns
- * identically. Stays CodeMirror-free so the display path can use it too.
- *
- * @param column The resolved column (from the datasets), or `undefined` when it
- *   could not be resolved yet (datasets still loading / unknown id).
- * @param contentLanguage The locale used to pick the column name.
- * @param fallbackLabel The label to show when the column is unresolved (the column id).
- */
-export declare function resolveColumnPresentation(column: Pick<DatasetDataField, 'type' | 'subtype' | 'lowestLevel' | 'name'> | undefined, contentLanguage: string, fallbackLabel: string): ColumnPresentation;

package/react/utils/formula/config/tests/build-datasets.test.d.ts

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

package/react/utils/formula/config/validate-expression.d.ts

@@ -1,19 +0,0 @@
-import type { FormulaAggregationFunction, FormulaAggregationFunctionData, FormulaFunction, FormulaFunctionData } from '../../../types/formula.types';
-/**
- * Builds the set of word identifiers (upper-cased) that may legitimately appear
- * as bare text in a resolved formula expression: the function and aggregation
- * names, the grouping wrappers, the `CAST` target types and the literal
- * keywords. Columns are never bare (they are `{datasetId:columnId}` placeholders),
- * so any other word is unresolved free text.
- */
-export declare function getValidFormulaWordIdentifiers(functionDataMap: Record<FormulaFunction, FormulaFunctionData>, aggregationFunctionDataMap: Record<FormulaAggregationFunction, FormulaAggregationFunctionData>): Set<string>;
-/**
- * Scans a resolved (function-syntax) expression for the first bare word that is
- * not a known function, aggregation, grouping wrapper, cast type or literal -
- * i.e. unresolved free text such as a half-typed column name. Returns that word,
- * or `null` when every word resolves to a valid identifier.
- *
- * String literals and column placeholders are stripped first so their contents
- * are never mistaken for unresolved identifiers.
- */
-export declare function findUnresolvedToken(expression: string, validWordIdentifiers: Set<string>): string | null;

package/react/utils/formula/load-formula-codemirror.d.ts

@@ -1,4 +0,0 @@
-/** Loads (and registers) `luzmo-formula-codemirror` once, returning the same promise on repeat calls. */
-export declare function ensureFormulaCodeMirrorLoaded(): Promise<void>;
-/** Whether the formula CodeMirror module has finished loading. */
-export declare function isFormulaCodeMirrorLoaded(): boolean;

package/react/utils/formula/render-explanation-tooltip.d.ts

@@ -1,7 +0,0 @@
-import { nothing, type TemplateResult } from 'lit';
-/**
- * Builds the rich tooltip body (description + optional formula example with
- * inline column-type icons) slotted into a `luzmo-formula-draggable-field`'s `tooltip`
- * slot. Returns `nothing` when there is no content to show.
- */
-export declare function renderExplanationTooltip(description: string, example: string, exampleHasIcons: boolean): TemplateResult | typeof nothing;

package/react/utils/formula/store/formula-display-store.d.ts

@@ -1,87 +0,0 @@
-import type { ElementSize } from '../../base';
-import { type FormulaAggregationFunction, type FormulaAggregationFunctionData, type FormulaAggregationWidgetData, type FormulaEditorDataset, type FormulaFunction, type FormulaFunctionData } from '../../../types/formula.types';
-/**
- * Display-safe core of the formula store, shared by the read-only `luzmo-formula`
- * display and (through {@link FormulaEditorStore}) the editable surfaces.
- *
- * It owns everything a static rendering needs - the persisted aggregation-widget
- * data, the operation data maps and the pure expression transforms - without any
- * dependency on CodeMirror. The editable surfaces add the CodeMirror editor
- * registry, expression insertion and autocompletion in the {@link FormulaEditorStore}
- * subclass, which is the only part of the formula family that pulls CodeMirror in.
- *
- * It extends `EventTarget` so pill widgets and the container can subscribe to
- * `widgets-changed` (aggregation widget state changed) updates.
- */
-export declare class FormulaDisplayStore extends EventTarget {
-    readonly functionDataMap: Record<FormulaFunction, FormulaFunctionData>;
-    readonly aggregationFunctionDataMap: Record<FormulaAggregationFunction, FormulaAggregationFunctionData>;
-    /** When true, aggregations are rendered as nested aggregation widgets. */
-    multiStageAggregation: boolean;
-    /** When true, aggregations can be dropped inside another aggregation. */
-    nestedAggregation: boolean;
-    /** When true, the editor is read-only: inline pills cannot be edited or opened. */
-    readonly: boolean;
-    /** Language used to localize column names (for autocomplete and pills). */
-    contentLanguage: string;
-    /** Editor size, threaded into pills so their detail dropdowns (e.g. the include/exclude panel) scale with the editor. */
-    size: ElementSize;
-    /** Datasets available to the editor (used by transforms and autocomplete). */
-    datasets: FormulaEditorDataset[];
-    /** True while the editor is fetching datasets from `datasetIds`; column pills show a loading state. */
-    loading: boolean;
-    /** Id of the aggregation widget whose editor was focused last (null = root). */
-    lastFocusedAggregationWidgetId: string | null;
-    /**
-     * Id of the empty-argument pill that was focused last. Inserting from the side
-     * lists (double-click / activate) blurs the pill before the insert runs, so the
-     * editor's caret is no longer inside it; remembering the pill lets the insert
-     * fill that argument instead of dropping at the (stale) caret. Set when a pill
-     * gains focus and cleared once the editor content itself is focused (i.e. a real
-     * caret is placed).
-     */
-    lastFocusedEmptyArgumentId: string | null;
-    /**
-     * Id of an aggregation widget that was just created (via a list insert or
-     * autocomplete) and whose nested input should grab focus once rendered, so the
-     * user can keep typing into it. Only set for aggregations that accept content
-     * (arity > 0) and cleared by the pill after it focuses.
-     */
-    pendingFocusAggregationWidgetId: string | null;
-    private _aggregationWidgets;
-    get aggregationWidgets(): FormulaAggregationWidgetData[];
-    addWidgets(widgets: FormulaAggregationWidgetData[]): void;
-    removeWidgets(widgetIds: string[]): void;
-    updateWidget(widget: FormulaAggregationWidgetData): void;
-    getWidget(widgetId: string): FormulaAggregationWidgetData | undefined;
-    clearWidgets(): void;
-    protected _notifyWidgetsChanged(): void;
-    /**
-     * Toggles read-only and notifies mounted pills so their (already-rendered)
-     * controls re-render disabled / enabled. Setting the field directly (e.g. at
-     * construction) is fine; use this when toggling after pills exist.
-     */
-    setReadonly(value: boolean): void;
-    /**
-     * Toggles the dataset-loading flag and asks any listeners to rebuild their pill
-     * decorations, so column pills can reflect the loading state (a spinner while
-     * the column label is being resolved).
-     */
-    setLoading(value: boolean): void;
-    /**
-     * Flags a just-created aggregation widget so its nested input grabs focus once
-     * rendered, but only when the aggregation accepts content (arity > 0); e.g.
-     * COUNTR (arity 0) has no input to type into.
-     */
-    protected _markAggregationForFocus(widgets: FormulaAggregationWidgetData[]): void;
-    /**
-     * Replaces every aggregation function in the expression with an aggregation
-     * widget placeholder (`##AGGR-<id>##`), registering the parsed widget data.
-     */
-    transformToAggregationWidgetSyntax(expression: string): string;
-    /**
-     * Replaces every aggregation widget placeholder with the rendered aggregation
-     * function expression, recursively resolving nested widgets.
-     */
-    transformToAggregationFunctionSyntax(expression: string): string;
-}

package/react/utils/formula/store/formula-editor-context.d.ts

@@ -1,8 +0,0 @@
-import type { FormulaEditorStore } from './formula-editor-store';
-/**
- * Context used to share a single {@link FormulaEditorStore} instance from the
- * root `luzmo-formula-editor` down to nested inputs and pill widgets.
- */
-export declare const formulaEditorContext: {
-    __context__: FormulaEditorStore;
-};

package/react/utils/formula/store/formula-editor-store.d.ts

@@ -1,46 +0,0 @@
-import type { Completion } from '@codemirror/autocomplete';
-import type { EditorView } from '@codemirror/view';
-import { FormulaDisplayStore } from './formula-display-store';
-import { type ExtendExpressionPayload, type ExtendExpressionType, type FormulaAggregationWidgetData, type FormulaEditorDataset } from '../../../types/formula.types';
-/** Key used to register the root (top-level) editor. */
-export declare const ROOT_EDITOR_ID = "__root__";
-/**
- * The editable formula store: extends the display-safe {@link FormulaDisplayStore}
- * with everything the CodeMirror-backed surfaces need - the registry of editor
- * views (root + nested aggregation widgets), expression insertion and the
- * autocompletion list.
- *
- * This is the only part of the formula family that depends on CodeMirror, so the
- * read-only `luzmo-formula` display (which uses {@link FormulaDisplayStore}) never
- * pulls it in.
- */
-export declare class FormulaEditorStore extends FormulaDisplayStore {
-    private readonly _editors;
-    registerEditor(id: string | null, view: EditorView): void;
-    unregisterEditor(id: string | null): void;
-    getEditor(id?: string | null): EditorView | undefined;
-    /**
-     * Builds the expression fragment for a dropped / inserted item and any new
-     * aggregation widgets that need to be registered.
-     */
-    getDropExpression(type: ExtendExpressionType, id: string | null, datasetId?: string | null, textContent?: string): {
-        expression: string;
-        aggregationWidgets: FormulaAggregationWidgetData[];
-    };
-    /**
-     * Inserts the requested item into the targeted editor (root or aggregation
-     * widget), either at the cursor or by filling a specific empty argument.
-     */
-    onExtendExpression(payload: ExtendExpressionPayload): void;
-    /**
-     * Builds the CodeMirror autocompletion list from the functions, aggregations
-     * (when enabled) and the columns of the provided datasets.
-     */
-    getAutoCompletionList(datasets: FormulaEditorDataset[], showAggregations: boolean): Completion[];
-    /**
-     * Builds the autocompletion info (hint) tooltip for a function / aggregation:
-     * the example expression (with `⟨type⟩` markers rendered as column-type icons)
-     * followed by the description, mirroring the description region.
-     */
-    private _buildOperationInfo;
-}

package/react/utils/formula/store/tests/formula-editor-store.test.d.ts

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

package/react/utils/formula/tests/validate-expression.test.d.ts

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

package/react/utils/get-css-variable.d.ts

@@ -1 +0,0 @@
-export declare const getCssVariableValue: (element: HTMLElement, variable: string) => string;

package/react/utils/index.d.ts

@@ -1,10 +0,0 @@
-export { loadDataFieldsForDatasets } from './data/load-data-fields-for-datasets';
-export { decomposeNumericFormat } from './formatter/decompose-numeric-format';
-export { formatter } from './formatter/formatter';
-export { localize } from './formatter/localize';
-export { getLocale, setLocale, targetLocales } from './localize/set-locale';
-export { switchItem } from './switch-item';
-export * from './themes';
-export { convertDatasetsToDataFields } from './transformations/convert-datasets-to-data-fields';
-export { PeriodOverPeriodCondition } from './time/period-over-period-condition.const';
-export { DATE_LEVEL_AND_ABOVE, getValueForFormatter, transformDateToTimezone } from './timezone/datetime-timezone';

package/react/utils/localize/set-locale.d.ts

@@ -1,7 +0,0 @@
-declare const getLocale: (() => string) & {
-    _LIT_LOCALIZE_GET_LOCALE_?: never;
-}, setLocale: ((newLocale: string) => Promise<void>) & {
-    _LIT_LOCALIZE_SET_LOCALE_?: never;
-};
-export { targetLocales } from './../../generated/locale-codes.js';
-export { getLocale, setLocale };

package/react/utils/map-tile-providers/index.d.ts

@@ -1,93 +0,0 @@
-export declare const mapVectorTileProviders: {
-    'No Tiles': {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Basic: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Bright: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Dark: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Fiord: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Liberty: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Pastel: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Positron: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Streets: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Toner: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Topographique: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    Voyager: {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-    '3D buildings': {
-        name: string;
-        id: string;
-        url: string;
-        attribution: string;
-        rasterName: string;
-    };
-};

package/react/utils/slot-content/ad-hoc-slot-content.d.ts

@@ -1,7 +0,0 @@
-import type { SlotConfig } from '@luzmo/dashboard-contents-types';
-import type { SlotContent } from '../../types/slot.types';
-export declare const isAdHocFormula: (content: SlotContent | undefined) => boolean;
-export declare const isAdHocExpression: (content: SlotContent | undefined) => boolean;
-export declare const getAdHocExpression: (content: SlotContent | undefined) => string | undefined;
-export declare const getSlotContentIdentityKey: (content: SlotContent | undefined) => string | undefined;
-export declare const shouldSurfaceAsFormula: (content: SlotContent | undefined, slotConfiguration: SlotConfig) => boolean;

package/react/utils/slot-content/render-calculation-label.d.ts

@@ -1,7 +0,0 @@
-import { type TemplateResult } from 'lit';
-import type { SlotContent } from '../../types/slot.types';
-/**
- * Renders the compact ad-hoc calculation label (icon + "Formula"/"Expression")
- * shared by the slot picker, drop target and slot menu surfaces.
- */
-export declare const renderAdHocCalculationLabel: (content: SlotContent | undefined) => TemplateResult;

package/react/utils/slot-content/tests/ad-hoc-slot-content.test.d.ts

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

package/react/utils/slot-state/slot-context.d.ts

@@ -1,4 +0,0 @@
-import type { SlotStore } from './slot-store';
-export declare const slotContext: {
-    __context__: SlotStore;
-};

package/react/utils/slot-state/slot-store.d.ts

@@ -1,39 +0,0 @@
-import { SlotName, VizItemSlot, VizItemType } from '@luzmo/dashboard-contents-types';
-import type { SlotContent } from '../../types/slot.types';
-import { PeriodOverPeriodCondition } from '../time/period-over-period-condition.const';
-export declare class SlotStore {
-    /**
-     * Holds all contents for this item slot drop target.
-     */
-    readonly slotContents: import("signal-polyfill").Signal.State<SlotContent[]>;
-    readonly slotsContents: import("signal-polyfill").Signal.State<VizItemSlot[]>;
-    readonly periodOverPeriodUiType: import("signal-polyfill").Signal.State<PeriodOverPeriodCondition | null>;
-    readonly linkedDataset: import("signal-polyfill").Signal.State<{
-        name: any;
-        id: string;
-        columns: any[];
-    }[]>;
-    private readonly _popEnabledChartTypes;
-    readonly activeSlotContents: import("signal-polyfill").Signal.Computed<SlotContent>;
-    /**
-     * Index of the content currently selected / active in a slot menu.
-     */
-    readonly activeIndex: import("signal-polyfill").Signal.State<number>;
-    private isArrayColumnType;
-    setPeriodOverPeriodCondition(itemType: VizItemType, currentSlotContents: SlotContent): void;
-    private getUiConditionToApply;
-    private oldConditionalLogic;
-    /**
-     * Detects if there's a datetime column on Category or X-axis slots
-     */
-    private hasDatetimeColumnOnCategoryOrXAxis;
-    /** Replace the full list (e.g. after dropping or re-ordering). */
-    setContents(contents: SlotContent[], slotName?: SlotName): void;
-    setFullContents(fullSlotsContents: VizItemSlot[]): void;
-    /** Change which item is considered active (e.g. user clicked in list). */
-    updateActive(index: number): void;
-    /** Update / overwrite a single content entry. */
-    updateContent(content: SlotContent, index?: number): void;
-    /** Remove one content entry by index. */
-    removeContent(index: number): void;
-}