@emuanalytics/flow-rdf-ui 4.0.5 → 4.0.6

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { FlowCoreMap } from '@emuanalytics/flow-rdf-core';
 import * as lit_html from 'lit-html';
 import * as lit from 'lit';
-import { LitElement, CSSResultGroup, TemplateResult, ReactiveController, ReactiveControllerHost, PropertyValueMap } from 'lit';
+import { LitElement, CSSResultGroup, ReactiveController, ReactiveControllerHost, TemplateResult, PropertyValueMap } from 'lit';
 import * as chartjs_chart_matrix from 'chartjs-chart-matrix';
 import * as chart_js from 'chart.js';
 import { ChartComponentLike, Chart, ChartTypeRegistry, ChartOptions, ChartData, Plugin } from 'chart.js';
@@ -600,6 +600,64 @@ declare function getEasingNames(): string[];
 declare function initializeChartJs(): void;
 declare function registerChartComponent(...components: ChartComponentLike[]): void;
 
+interface BaseColorStopOptions {
+    type: string;
+    label?: string;
+}
+interface StringColorStopOptions {
+    type: 'string';
+}
+interface NumberColorStopOptions {
+    type: 'number';
+    min?: number;
+    max?: number;
+    step?: number;
+    units?: string;
+}
+interface SelectColorStopOptions {
+    type: 'select';
+    options: Array<string | {
+        value: string;
+        name?: string;
+    }>;
+}
+type ColorStopOptions = StringColorStopOptions | NumberColorStopOptions | SelectColorStopOptions;
+interface ColorStopValue {
+    value: string | number;
+    color: string;
+    options?: {
+        regex: boolean;
+        caseSensitive: boolean;
+    };
+}
+interface BaseColorMapperField {
+    name?: string;
+    field: string;
+}
+interface StringColorMapperField extends StringColorStopOptions, BaseColorMapperField {
+    type: 'string';
+}
+interface NumberColorMapperField extends NumberColorStopOptions, BaseColorMapperField {
+    type: 'number';
+}
+interface SelectColorMapperField extends SelectColorStopOptions, BaseColorMapperField {
+    type: 'select';
+}
+type ColorMapperField = StringColorMapperField | NumberColorMapperField | SelectColorMapperField;
+interface ColorMapperOptions {
+    fields: Record<string, ColorMapperField>;
+}
+interface ColorMapperValue {
+    mode: 'fixed' | 'data-driven';
+    field: string | undefined;
+    type?: 'string' | 'number' | 'select';
+    defaultColor?: string;
+    colorStops: ColorStopValue[];
+}
+
+declare function colorMapperValueToMaplibreExpression(value: ColorMapperValue): string;
+declare function escapeMaplibreString(value: string): string;
+
 /**
  *
  * The following code shows how to import FontAwesome SVG icons from the `flow-rdf-ui/icons` package and add them to the
@@ -630,13 +688,13 @@ type IconLibraryResolver = (name: string) => string;
 type IconLibraryMutator = (svg: SVGElement) => void;
 /**
  *
- * Use this function to add a custom icon library to the registry or overrides an existing one.
+ * Use this function to add a custom icon library to the registry or override an existing one.
  * Provide a resolver function that returns the URL of the icon based on its name.
  * Optionally, provide a mutator function that modifies the SVG element of the icon.
  *
  * Two icon libraries are included by default:
  * - `system` (System icons used by `flow-rdf-ui` components)
- * - `default` (FontAwesome 5.15.4)
+ * - `default` (FontAwesome 6.4.2)
  *
  * To use a custom icon library, set the `library` property of the `<flow-ui-icon>` component
  * to the registered name of the library. If omitted, the `default` library is used.
@@ -694,6 +752,83 @@ declare function setDefaultLocale(locale: string): void;
  */
 declare function setDefaultTimeZone(timezone: string): void;
 
+type FunctionParams<T> = T extends (...args: infer U) => string ? U : [];
+interface Translation$1 {
+    $code: string;
+    $name: string;
+    $dir: 'ltr' | 'rtl';
+}
+interface DefaultTranslation extends Translation$1 {
+    $code: string;
+    $name: string;
+    $dir: 'ltr' | 'rtl';
+    [key: string]: any;
+}
+interface ExistsOptions {
+    lang: string;
+    includeFallback: boolean;
+}
+/** Registers one or more translations */
+declare function registerTranslation(...translation: Translation$1[]): void;
+/** @internal */
+declare class LocalizeController$1<UserTranslation extends Translation$1 = DefaultTranslation> implements ReactiveController {
+    host: ReactiveControllerHost & HTMLElement;
+    constructor(host: ReactiveControllerHost & HTMLElement);
+    hostConnected(): void;
+    hostDisconnected(): void;
+    /**
+     * Gets the host element's directionality as determined by the `dir` attribute. The return value is transformed to
+     * lowercase.
+     */
+    dir(): string;
+    /**
+     * Gets the host element's language as determined by the `lang` attribute. The return value is transformed to
+     * lowercase.
+     */
+    lang(): string;
+    private getTranslationData;
+    /** Determines if the specified term exists, optionally checking the fallback translation. */
+    exists<K extends keyof UserTranslation>(key: K, options: Partial<ExistsOptions>): boolean;
+    /** Outputs a translated term. */
+    term<K extends keyof UserTranslation>(key: K, ...args: FunctionParams<UserTranslation[K]>): string;
+    /** Outputs a localized date in the specified format. */
+    date(dateToFormat: Date | string, options?: Intl.DateTimeFormatOptions): string;
+    /** Outputs a localized number in the specified format. */
+    number(numberToFormat: number | string, options?: Intl.NumberFormatOptions): string;
+    /** Outputs a localized time in relative format. */
+    relativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options?: Intl.RelativeTimeFormatOptions): string;
+}
+
+/** @internal */
+declare class LocalizeController extends LocalizeController$1<Translation> {
+}
+
+interface Translation extends Translation$1 {
+    $code: string;
+    $name: string;
+    $dir: 'ltr' | 'rtl';
+    carousel: string;
+    clearEntry: string;
+    close: string;
+    copy: string;
+    currentValue: string;
+    goToSlide: (slide: number, count: number) => string;
+    hidePassword: string;
+    loading: string;
+    nextSlide: string;
+    numOptionsSelected: (num: number) => string;
+    previousSlide: string;
+    progress: string;
+    remove: string;
+    resize: string;
+    scrollToEnd: string;
+    scrollToStart: string;
+    selectAColorFromTheScreen: string;
+    showPassword: string;
+    slideNum: (slide: number) => string;
+    toggleColorFormat: string;
+}
+
 interface VirtualElement {
     getBoundingClientRect: () => DOMRect;
     contextElement?: Element;
@@ -1042,6 +1177,7 @@ type NoUnion<T, U = T> = T extends U ? ([U] extends [T] ? T : never) : never;
  * @dependency flow-ui-date-time-picker
  * @dependency flow-ui-tooltip
  *
+ * @event flow-ui-input - Emitted when the control's value changes.
  * @event flow-ui-change - Emitted when the control's value changes.
  *
  * @slot label - The component's label. Alternatively, you can use the `label` attribute.
@@ -1299,83 +1435,6 @@ declare const converter: FlowQueryBuilderConverter;
  */
 declare function registerComponents(): Promise<void>;
 
-type FunctionParams<T> = T extends (...args: infer U) => string ? U : [];
-interface Translation$1 {
-    $code: string;
-    $name: string;
-    $dir: 'ltr' | 'rtl';
-}
-interface DefaultTranslation extends Translation$1 {
-    $code: string;
-    $name: string;
-    $dir: 'ltr' | 'rtl';
-    [key: string]: any;
-}
-interface ExistsOptions {
-    lang: string;
-    includeFallback: boolean;
-}
-/** Registers one or more translations */
-declare function registerTranslation(...translation: Translation$1[]): void;
-/** @internal */
-declare class LocalizeController$1<UserTranslation extends Translation$1 = DefaultTranslation> implements ReactiveController {
-    host: ReactiveControllerHost & HTMLElement;
-    constructor(host: ReactiveControllerHost & HTMLElement);
-    hostConnected(): void;
-    hostDisconnected(): void;
-    /**
-     * Gets the host element's directionality as determined by the `dir` attribute. The return value is transformed to
-     * lowercase.
-     */
-    dir(): string;
-    /**
-     * Gets the host element's language as determined by the `lang` attribute. The return value is transformed to
-     * lowercase.
-     */
-    lang(): string;
-    private getTranslationData;
-    /** Determines if the specified term exists, optionally checking the fallback translation. */
-    exists<K extends keyof UserTranslation>(key: K, options: Partial<ExistsOptions>): boolean;
-    /** Outputs a translated term. */
-    term<K extends keyof UserTranslation>(key: K, ...args: FunctionParams<UserTranslation[K]>): string;
-    /** Outputs a localized date in the specified format. */
-    date(dateToFormat: Date | string, options?: Intl.DateTimeFormatOptions): string;
-    /** Outputs a localized number in the specified format. */
-    number(numberToFormat: number | string, options?: Intl.NumberFormatOptions): string;
-    /** Outputs a localized time in relative format. */
-    relativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options?: Intl.RelativeTimeFormatOptions): string;
-}
-
-/** @internal */
-declare class LocalizeController extends LocalizeController$1<Translation> {
-}
-
-interface Translation extends Translation$1 {
-    $code: string;
-    $name: string;
-    $dir: 'ltr' | 'rtl';
-    carousel: string;
-    clearEntry: string;
-    close: string;
-    copy: string;
-    currentValue: string;
-    goToSlide: (slide: number, count: number) => string;
-    hidePassword: string;
-    loading: string;
-    nextSlide: string;
-    numOptionsSelected: (num: number) => string;
-    previousSlide: string;
-    progress: string;
-    remove: string;
-    resize: string;
-    scrollToEnd: string;
-    scrollToStart: string;
-    selectAColorFromTheScreen: string;
-    showPassword: string;
-    slideNum: (slide: number) => string;
-    toggleColorFormat: string;
-}
-
 /**
  * Initializes the the `flow-rdf-ui` library.
  *
@@ -2239,57 +2298,6 @@ declare global {
     }
 }
 
-interface StringColorStopOptions {
-    type: 'string';
-}
-interface NumberColorStopOptions {
-    type: 'number';
-    min?: number;
-    max?: number;
-    step?: number;
-    units?: string;
-}
-interface SelectColorStopOptions {
-    type: 'select';
-    options: Array<string | {
-        value: string;
-        name?: string;
-    }>;
-}
-type ColorStopOptions = StringColorStopOptions | NumberColorStopOptions | SelectColorStopOptions;
-interface ColorStopValue {
-    value: string | number;
-    color: string;
-    options?: {
-        regex: boolean;
-        caseSensitive: boolean;
-    };
-}
-interface BaseColorMapperField {
-    name?: string;
-    field: string;
-}
-interface StringColorMapperField extends StringColorStopOptions, BaseColorMapperField {
-    type: 'string';
-}
-interface NumberColorMapperField extends NumberColorStopOptions, BaseColorMapperField {
-    type: 'number';
-}
-interface SelectColorMapperField extends SelectColorStopOptions, BaseColorMapperField {
-    type: 'select';
-}
-type ColorMapperField = StringColorMapperField | NumberColorMapperField | SelectColorMapperField;
-interface ColorMapperOptions {
-    fields: Record<string, ColorMapperField>;
-}
-interface ColorMapperValue {
-    mode: 'fixed' | 'data-driven';
-    field: string | undefined;
-    type?: 'string' | 'number' | 'select';
-    defaultColor?: string;
-    colorStops: ColorStopValue[];
-}
-
 /**
  * @tagname flow-ui-color-mapper
  * @summary A component for defining mappings between data values and colors.
@@ -5584,6 +5592,7 @@ declare global {
  * @tagname flow-ui-tree
  * @summary Trees allow you to display a hierarchical list of selectable [tree items](./flow-ui-tree-item). Items with children can be expanded and collapsed as desired by the user.
  *
+ * @event flow-ui-input - Emitted when a tree item is selected or deselected.
  * @event flow-ui-change - Emitted when a tree item is selected or deselected.
  *
  * @slot - The default slot.
@@ -5675,4 +5684,4 @@ declare global {
     }
 }
 
-export { type FlowQueryBuilderConfig, type FlowQueryBuilderConverter, type FlowQueryBuilderConverterOptions, type FlowQueryBuilderDateField, type FlowQueryBuilderDateTimeField, type FlowQueryBuilderDateTimeFieldBase, type FlowQueryBuilderField, type FlowQueryBuilderFieldBase, type FlowQueryBuilderFieldDefinition, type FlowQueryBuilderFieldMap, type FlowQueryBuilderFieldType, type FlowQueryBuilderFieldTypeMap, type FlowQueryBuilderNumberField, type FlowQueryBuilderOption, type FlowQueryBuilderRule, type FlowQueryBuilderRuleSet, type FlowQueryBuilderSelectField, type FlowQueryBuilderStringField, type FlowQueryBuilderTemplateFn, type FlowQueryBuilderTimeField, type FlowAfterCollapseEvent as FlowUiAfterCollapseEvent, type FlowAfterExpandEvent as FlowUiAfterExpandEvent, type FlowAfterHideEvent as FlowUiAfterHideEvent, type FlowAfterShowEvent as FlowUiAfterShowEvent, FlowUiAlert, FlowUiAnimation, FlowUiAvatar, FlowUiBadge, type FlowBlurEvent as FlowUiBlurEvent, FlowUiBreadcrumb, FlowUiBreadcrumbItem, FlowUiButton, FlowUiButtonGroup, FlowUiCalendar, type FlowCancelEvent as FlowUiCancelEvent, FlowUiCard, FlowUiCarousel, FlowUiCarouselItem, type FlowChangeEvent as FlowUiChangeEvent, FlowUiChart, FlowUiCheckbox, type FlowClearEvent as FlowUiClearEvent, type FlowCloseEvent as FlowUiCloseEvent, type FlowCollapseEvent as FlowUiCollapseEvent, FlowUiColorMapper, FlowUiColorPicker, FlowUiColorStop, FlowUiDateTimePicker, FlowUiDetails, FlowUiDialog, FlowUiDivider, type FlowDragEvent as FlowUiDragEvent, type FlowDragStartEvent as FlowUiDragStartEvent, FlowUiDrawer, FlowUiDropdown, type FlowErrorEvent as FlowUiErrorEvent, type FlowExpandEvent as FlowUiExpandEvent, type FlowFinishEvent as FlowUiFinishEvent, type FlowFocusEvent as FlowUiFocusEvent, FlowUiGauge, type FlowHideEvent as FlowUiHideEvent, type FlowHoverEvent as FlowUiHoverEvent, FlowUiIcon, FlowUiIconButton, type FlowInitialFocusEvent as FlowUiInitialFocusEvent, FlowUiInput, type FlowInputEvent as FlowUiInputEvent, type FlowInvalidEvent as FlowUiInvalidEvent, type FlowLazyChangeEvent as FlowUiLazyChangeEvent, type FlowLazyLoadEvent as FlowUiLazyLoadEvent, type FlowLoadEvent as FlowUiLoadEvent, FlowUiMap, type FlowMapLoadEvent as FlowUiMapLoadEvent, FlowUiMenu, FlowUiMenuItem, FlowUiMenuLabel, type FlowMutationEvent as FlowUiMutationEvent, FlowUiMutationObserver, FlowUiOption, FlowUiPanel, FlowUiPanelHeader, type FlowPanelToggleEvent as FlowUiPanelToggleEvent, FlowUiPopup, FlowUiProgressBar, FlowUiProgressRing, FlowUiQueryBuilder, FlowUiRadio, FlowUiRadioGroup, FlowUiRange, type FlowRemoveEvent as FlowUiRemoveEvent, type FlowRepositionEvent as FlowUiRepositionEvent, type FlowRequestCloseEvent as FlowUiRequestCloseEvent, type FlowResizeEvent as FlowUiResizeEvent, FlowUiResizeObserver, FlowUiScrollView, FlowUiSelect, type FlowSelectEvent as FlowUiSelectEvent, type FlowShowEvent as FlowUiShowEvent, type FlowSlideChange as FlowUiSlideChange, FlowUiSpinner, FlowUiSplitView, FlowUiSplitViewDivider, FlowUiSplitViewPane, FlowUiSplitViewToggleButton, type FlowStartEvent as FlowUiStartEvent, FlowUiStepper, FlowUiStepperPanel, FlowUiSwitch, FlowUiTab, FlowUiTabGroup, type FlowTabHideEvent as FlowUiTabHideEvent, FlowUiTabPanel, type FlowTabShowEvent as FlowUiTabShowEvent, FlowUiTag, FlowUiTextarea, FlowUiTimer, FlowUiToolButton, FlowUiToolButtonGroup, FlowUiTooltip, FlowUiTree, FlowUiTreeItem, type FlowDragEndEvent as FlowUiUiDragEndEvent, FlowUiVisuallyHidden, LocalizeController, type Translation, addIcons, filterRuleSet, converter$1 as flowQueryConverter, getAnimationNames, getEasingNames, initialize, initializeChartJs, isRule, isRuleOrRuleset, isRuleSet, converter as mapLayerFilterConverter, registerChartComponent, registerComponents, registerIconLibrary, registerTranslation, renameRuleSetFields, setDefaultLocale, setDefaultTimeZone, transformRuleSet, unregisterIconLibrary };
+export { type BaseColorMapperField, type BaseColorStopOptions, type ColorMapperField, type ColorMapperOptions, type ColorMapperValue, type ColorStopOptions, type ColorStopValue, type FlowQueryBuilderConfig, type FlowQueryBuilderConverter, type FlowQueryBuilderConverterOptions, type FlowQueryBuilderDateField, type FlowQueryBuilderDateTimeField, type FlowQueryBuilderDateTimeFieldBase, type FlowQueryBuilderField, type FlowQueryBuilderFieldBase, type FlowQueryBuilderFieldDefinition, type FlowQueryBuilderFieldMap, type FlowQueryBuilderFieldType, type FlowQueryBuilderFieldTypeMap, type FlowQueryBuilderNumberField, type FlowQueryBuilderOption, type FlowQueryBuilderRule, type FlowQueryBuilderRuleSet, type FlowQueryBuilderSelectField, type FlowQueryBuilderStringField, type FlowQueryBuilderTemplateFn, type FlowQueryBuilderTimeField, type FlowAfterCollapseEvent as FlowUiAfterCollapseEvent, type FlowAfterExpandEvent as FlowUiAfterExpandEvent, type FlowAfterHideEvent as FlowUiAfterHideEvent, type FlowAfterShowEvent as FlowUiAfterShowEvent, FlowUiAlert, FlowUiAnimation, FlowUiAvatar, FlowUiBadge, type FlowBlurEvent as FlowUiBlurEvent, FlowUiBreadcrumb, FlowUiBreadcrumbItem, FlowUiButton, FlowUiButtonGroup, FlowUiCalendar, type FlowCancelEvent as FlowUiCancelEvent, FlowUiCard, FlowUiCarousel, FlowUiCarouselItem, type FlowChangeEvent as FlowUiChangeEvent, FlowUiChart, FlowUiCheckbox, type FlowClearEvent as FlowUiClearEvent, type FlowCloseEvent as FlowUiCloseEvent, type FlowCollapseEvent as FlowUiCollapseEvent, FlowUiColorMapper, FlowUiColorPicker, FlowUiColorStop, FlowUiDateTimePicker, FlowUiDetails, FlowUiDialog, FlowUiDivider, type FlowDragEvent as FlowUiDragEvent, type FlowDragStartEvent as FlowUiDragStartEvent, FlowUiDrawer, FlowUiDropdown, type FlowErrorEvent as FlowUiErrorEvent, type FlowExpandEvent as FlowUiExpandEvent, type FlowFinishEvent as FlowUiFinishEvent, type FlowFocusEvent as FlowUiFocusEvent, FlowUiGauge, type FlowHideEvent as FlowUiHideEvent, type FlowHoverEvent as FlowUiHoverEvent, FlowUiIcon, FlowUiIconButton, type FlowInitialFocusEvent as FlowUiInitialFocusEvent, FlowUiInput, type FlowInputEvent as FlowUiInputEvent, type FlowInvalidEvent as FlowUiInvalidEvent, type FlowLazyChangeEvent as FlowUiLazyChangeEvent, type FlowLazyLoadEvent as FlowUiLazyLoadEvent, type FlowLoadEvent as FlowUiLoadEvent, FlowUiMap, type FlowMapLoadEvent as FlowUiMapLoadEvent, FlowUiMenu, FlowUiMenuItem, FlowUiMenuLabel, type FlowMutationEvent as FlowUiMutationEvent, FlowUiMutationObserver, FlowUiOption, FlowUiPanel, FlowUiPanelHeader, type FlowPanelToggleEvent as FlowUiPanelToggleEvent, FlowUiPopup, FlowUiProgressBar, FlowUiProgressRing, FlowUiQueryBuilder, FlowUiRadio, FlowUiRadioGroup, FlowUiRange, type FlowRemoveEvent as FlowUiRemoveEvent, type FlowRepositionEvent as FlowUiRepositionEvent, type FlowRequestCloseEvent as FlowUiRequestCloseEvent, type FlowResizeEvent as FlowUiResizeEvent, FlowUiResizeObserver, FlowUiScrollView, FlowUiSelect, type FlowSelectEvent as FlowUiSelectEvent, type FlowShowEvent as FlowUiShowEvent, type FlowSlideChange as FlowUiSlideChange, FlowUiSpinner, FlowUiSplitView, FlowUiSplitViewDivider, FlowUiSplitViewPane, FlowUiSplitViewToggleButton, type FlowStartEvent as FlowUiStartEvent, FlowUiStepper, FlowUiStepperPanel, FlowUiSwitch, FlowUiTab, FlowUiTabGroup, type FlowTabHideEvent as FlowUiTabHideEvent, FlowUiTabPanel, type FlowTabShowEvent as FlowUiTabShowEvent, FlowUiTag, FlowUiTextarea, FlowUiTimer, FlowUiToolButton, FlowUiToolButtonGroup, FlowUiTooltip, FlowUiTree, FlowUiTreeItem, type FlowDragEndEvent as FlowUiUiDragEndEvent, FlowUiVisuallyHidden, LocalizeController, type NumberColorMapperField, type NumberColorStopOptions, type SelectColorMapperField, type SelectColorStopOptions, type StringColorMapperField, type StringColorStopOptions, type Translation, addIcons, colorMapperValueToMaplibreExpression, escapeMaplibreString, filterRuleSet, converter$1 as flowQueryConverter, getAnimationNames, getEasingNames, initialize, initializeChartJs, isRule, isRuleOrRuleset, isRuleSet, converter as mapLayerFilterConverter, registerChartComponent, registerComponents, registerIconLibrary, registerTranslation, renameRuleSetFields, setDefaultLocale, setDefaultTimeZone, transformRuleSet, unregisterIconLibrary };