@luzmo/analytics-components-kit 1.0.8 → 1.0.9-beta.10

package/angular/components/filter-value-picker-numeric.ts

@@ -0,0 +1,146 @@
+import { booleanAttribute, ChangeDetectionStrategy, Component, DestroyRef, ElementRef, inject, Input, OnChanges, output, Renderer2, SimpleChanges } from '@angular/core';
+import '@luzmo/analytics-components-kit/filter-value-picker-numeric';
+import type { LuzmoFilterValuePickerNumeric as LuzmoFilterValuePickerNumericHostElement } from '@luzmo/analytics-components-kit/filter-value-picker-numeric';
+
+@Component({
+  selector: 'luzmo-filter-value-picker-numeric',
+  exportAs: 'luzmoFilterValuePickerNumeric',
+  standalone: true,
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  template: '<ng-content />'
+})
+/**
+ * Angular wrapper component for <luzmo-filter-value-picker-numeric>
+ */
+export class LuzmoFilterValuePickerNumeric implements OnChanges {
+  private readonly elementRef = inject<ElementRef<LuzmoFilterValuePickerNumericHostElement>>(ElementRef);
+  private readonly renderer = inject<Renderer2>(Renderer2);
+  private readonly destroyRef = inject<DestroyRef>(DestroyRef);
+  private readonly host = this.elementRef.nativeElement;
+  private readonly listenerCleanup: Array<() => void> = [];
+
+  /** The underlying custom element instance. Use to call imperative methods. */
+  get nativeElement(): LuzmoFilterValuePickerNumericHostElement {
+    return this.host;
+  }
+
+  /** The API URL of the databroker */
+  @Input({ alias: 'apiUrl' })
+  apiUrl?: string;
+
+  /** The auth key of the databroker */
+  @Input({ alias: 'authKey' })
+  authKey?: string;
+
+  /** The auth token of the databroker */
+  @Input({ alias: 'authToken' })
+  authToken?: string;
+
+  /** The cache time of the databroker */
+  @Input({ alias: 'cacheTime' })
+  cacheTime?: number;
+
+  /** The language to use for locale-aware formatting and labels */
+  @Input({ alias: 'contentLanguage' })
+  contentLanguage?: string;
+
+  /** The filter used to retrieve the value */
+  @Input({ alias: 'filter' })
+  filter?: any;
+
+  /** The language for UI labels. Supported values: 'en', 'nl', 'fr', 'de', 'es' */
+  @Input({ alias: 'language' })
+  language?: string;
+
+  /** The size of the element */
+  @Input({ alias: 'size' })
+  size?: 's' | 'm' | 'l' | 'xl';
+
+  /** Disable this control. It will not receive focus or events */
+  @Input({ alias: 'disabled', transform: booleanAttribute })
+  disabled?: boolean;
+
+  /** When this control is rendered, focus it automatically */
+  @Input({ alias: 'autofocus', transform: booleanAttribute })
+  autofocus?: boolean;
+
+  /** The tab index to apply to this control. See general documentation about the tabindex HTML property */
+  @Input({ alias: 'tabIndex' })
+  tabIndex?: number;
+
+  /** Fired when the numeric filter value changes; `detail.value` holds the new number or range. */
+  readonly luzmoFilterValueChanged = output<CustomEvent<unknown>>({ alias: 'luzmoFilterValueChanged' });
+
+  constructor() {
+    this.bindEvents();
+    this.destroyRef.onDestroy(() => {
+      for (const cleanup of this.listenerCleanup) {
+        cleanup();
+      }
+    });
+  }
+
+  ngOnChanges(changes: SimpleChanges): void {
+    for (const key of Object.keys(changes)) {
+      switch (key) {
+        case 'apiUrl':
+          this.setHostProperty('apiUrl', changes['apiUrl'].currentValue);
+          break;
+        case 'authKey':
+          this.setHostProperty('authKey', changes['authKey'].currentValue);
+          break;
+        case 'authToken':
+          this.setHostProperty('authToken', changes['authToken'].currentValue);
+          break;
+        case 'cacheTime':
+          this.setHostProperty('cacheTime', changes['cacheTime'].currentValue);
+          break;
+        case 'contentLanguage':
+          this.setHostProperty('contentLanguage', changes['contentLanguage'].currentValue);
+          break;
+        case 'filter':
+          this.setHostProperty('filter', changes['filter'].currentValue);
+          break;
+        case 'language':
+          this.setHostProperty('language', changes['language'].currentValue);
+          break;
+        case 'size':
+          this.setHostProperty('size', changes['size'].currentValue);
+          break;
+        case 'disabled':
+          this.setHostProperty('disabled', changes['disabled'].currentValue);
+          break;
+        case 'autofocus':
+          this.setHostProperty('autofocus', changes['autofocus'].currentValue);
+          break;
+        case 'tabIndex':
+          this.setHostProperty('tabIndex', changes['tabIndex'].currentValue);
+          break;
+        default:
+          break;
+      }
+    }
+  }
+
+  /**
+   * Forward a wrapper @Input to the underlying host element via Renderer2 so
+   * the wrapper stays compatible with non-DOM Angular platforms (SSR, tests).
+   * Unlike a "skip undefined" guard, this lets consumers reset values back to
+   * undefined / null by clearing their bindings.
+   */
+  private setHostProperty(key: string, value: unknown): void {
+    this.renderer.setProperty(this.host, key, value);
+  }
+
+  private bindEvents(): void {
+    this.listenerCleanup.push(
+      this.renderer.listen(this.host, 'luzmo-filter-value-changed', (event: Event) => {
+        const typed = event as CustomEvent<unknown>;
+        this.luzmoFilterValueChanged.emit(typed);
+      })
+    );
+  }
+}
+
+/** The underlying custom element type for LuzmoFilterValuePickerNumeric */
+export type LuzmoFilterValuePickerNumericElement = LuzmoFilterValuePickerNumericHostElement;

package/angular/components/filter-value-picker.ts

@@ -0,0 +1,160 @@
+import { booleanAttribute, ChangeDetectionStrategy, Component, DestroyRef, ElementRef, inject, Input, OnChanges, output, Renderer2, SimpleChanges } from '@angular/core';
+import '@luzmo/analytics-components-kit/filter-value-picker';
+import type { LuzmoFilterValuePicker as LuzmoFilterValuePickerHostElement } from '@luzmo/analytics-components-kit/filter-value-picker';
+
+@Component({
+  selector: 'luzmo-filter-value-picker',
+  exportAs: 'luzmoFilterValuePicker',
+  standalone: true,
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  template: '<ng-content />'
+})
+/**
+ * Angular wrapper component for <luzmo-filter-value-picker>
+ */
+export class LuzmoFilterValuePicker implements OnChanges {
+  private readonly elementRef = inject<ElementRef<LuzmoFilterValuePickerHostElement>>(ElementRef);
+  private readonly renderer = inject<Renderer2>(Renderer2);
+  private readonly destroyRef = inject<DestroyRef>(DestroyRef);
+  private readonly host = this.elementRef.nativeElement;
+  private readonly listenerCleanup: Array<() => void> = [];
+
+  /** The underlying custom element instance. Use to call imperative methods. */
+  get nativeElement(): LuzmoFilterValuePickerHostElement {
+    return this.host;
+  }
+
+  /** The API URL of the databroker */
+  @Input({ alias: 'apiUrl' })
+  apiUrl?: string;
+
+  /** The auth key of the databroker */
+  @Input({ alias: 'authKey' })
+  authKey?: string;
+
+  /** The auth token of the databroker */
+  @Input({ alias: 'authToken' })
+  authToken?: string;
+
+  /** The cache time of the databroker */
+  @Input({ alias: 'cacheTime' })
+  cacheTime?: number;
+
+  /** The language to use for locale-aware formatting and labels */
+  @Input({ alias: 'contentLanguage' })
+  contentLanguage?: string;
+
+  /** The time zone to use for the date picker */
+  @Input({ alias: 'timeZone' })
+  timeZone?: string;
+
+  /** The type value picker to render */
+  @Input({ alias: 'valueType' })
+  valueType?: 'hierarchy' | 'numeric' | 'datetime';
+
+  /** The filter for which to render the value picker */
+  @Input({ alias: 'filter' })
+  filter?: any;
+
+  /** The language for UI labels. Supported values: 'en', 'nl', 'fr', 'de', 'es' */
+  @Input({ alias: 'language' })
+  language?: string;
+
+  /** The size of the element */
+  @Input({ alias: 'size' })
+  size?: 's' | 'm' | 'l' | 'xl';
+
+  /** Disable this control. It will not receive focus or events */
+  @Input({ alias: 'disabled', transform: booleanAttribute })
+  disabled?: boolean;
+
+  /** When this control is rendered, focus it automatically */
+  @Input({ alias: 'autofocus', transform: booleanAttribute })
+  autofocus?: boolean;
+
+  /** The tab index to apply to this control. See general documentation about the tabindex HTML property */
+  @Input({ alias: 'tabIndex' })
+  tabIndex?: number;
+
+  /** Fired when the filter value changes; `detail.value` holds the new value. */
+  readonly luzmoFilterValueChanged = output<CustomEvent<unknown>>({ alias: 'luzmoFilterValueChanged' });
+
+  constructor() {
+    this.bindEvents();
+    this.destroyRef.onDestroy(() => {
+      for (const cleanup of this.listenerCleanup) {
+        cleanup();
+      }
+    });
+  }
+
+  ngOnChanges(changes: SimpleChanges): void {
+    for (const key of Object.keys(changes)) {
+      switch (key) {
+        case 'apiUrl':
+          this.setHostProperty('apiUrl', changes['apiUrl'].currentValue);
+          break;
+        case 'authKey':
+          this.setHostProperty('authKey', changes['authKey'].currentValue);
+          break;
+        case 'authToken':
+          this.setHostProperty('authToken', changes['authToken'].currentValue);
+          break;
+        case 'cacheTime':
+          this.setHostProperty('cacheTime', changes['cacheTime'].currentValue);
+          break;
+        case 'contentLanguage':
+          this.setHostProperty('contentLanguage', changes['contentLanguage'].currentValue);
+          break;
+        case 'timeZone':
+          this.setHostProperty('timeZone', changes['timeZone'].currentValue);
+          break;
+        case 'valueType':
+          this.setHostProperty('valueType', changes['valueType'].currentValue);
+          break;
+        case 'filter':
+          this.setHostProperty('filter', changes['filter'].currentValue);
+          break;
+        case 'language':
+          this.setHostProperty('language', changes['language'].currentValue);
+          break;
+        case 'size':
+          this.setHostProperty('size', changes['size'].currentValue);
+          break;
+        case 'disabled':
+          this.setHostProperty('disabled', changes['disabled'].currentValue);
+          break;
+        case 'autofocus':
+          this.setHostProperty('autofocus', changes['autofocus'].currentValue);
+          break;
+        case 'tabIndex':
+          this.setHostProperty('tabIndex', changes['tabIndex'].currentValue);
+          break;
+        default:
+          break;
+      }
+    }
+  }
+
+  /**
+   * Forward a wrapper @Input to the underlying host element via Renderer2 so
+   * the wrapper stays compatible with non-DOM Angular platforms (SSR, tests).
+   * Unlike a "skip undefined" guard, this lets consumers reset values back to
+   * undefined / null by clearing their bindings.
+   */
+  private setHostProperty(key: string, value: unknown): void {
+    this.renderer.setProperty(this.host, key, value);
+  }
+
+  private bindEvents(): void {
+    this.listenerCleanup.push(
+      this.renderer.listen(this.host, 'luzmo-filter-value-changed', (event: Event) => {
+        const typed = event as CustomEvent<unknown>;
+        this.luzmoFilterValueChanged.emit(typed);
+      })
+    );
+  }
+}
+
+/** The underlying custom element type for LuzmoFilterValuePicker */
+export type LuzmoFilterValuePickerElement = LuzmoFilterValuePickerHostElement;

package/angular/components/filters.ts

@@ -0,0 +1,241 @@
+import { booleanAttribute, ChangeDetectionStrategy, Component, DestroyRef, ElementRef, inject, Input, OnChanges, output, Renderer2, SimpleChanges } from '@angular/core';
+import '@luzmo/analytics-components-kit/filters';
+import type { LuzmoFilters as LuzmoFiltersHostElement, FilterColumnDisplay, FilterParameter, FiltersChangedEventDetail, FiltersDisplay, FiltersFormat, FiltersInput } from '@luzmo/analytics-components-kit/filters';
+export type { CleanFilter, CleanFilterClauseGroup, CleanFilterGroup, CleanRetrievedFilterGroup, DashboardFilterOutput, DetectedFiltersFormat, FilterClause, FilterColumnDisplay, FilterCondition, FilterGroup, FilterParameter, FilterParameterEventDetail, FilterParameterType, FiltersChangedEventDetail, FiltersDisplay, FiltersFormat, FiltersInput, FiltersOutput, ItemFilterOutput, TransformFiltersOptions } from '@luzmo/analytics-components-kit/filters';
+
+@Component({
+  selector: 'luzmo-filters',
+  exportAs: 'luzmoFilters',
+  standalone: true,
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  template: '<ng-content />'
+})
+/**
+ * Angular wrapper component for <luzmo-filters>
+ *
+ * @csspart filters-text - The inline sentence shown when `display` is `text`.
+ * @csspart filters-outline - The bracket layout shown when `display` is `outline`.
+ * @csspart filters-outline-row - One filter row in the outline, including its delete button when shown.
+ */
+export class LuzmoFilters implements OnChanges {
+  private readonly elementRef = inject<ElementRef<LuzmoFiltersHostElement>>(ElementRef);
+  private readonly renderer = inject<Renderer2>(Renderer2);
+  private readonly destroyRef = inject<DestroyRef>(DestroyRef);
+  private readonly host = this.elementRef.nativeElement;
+  private readonly listenerCleanup: Array<() => void> = [];
+
+  /** The underlying custom element instance. Use to call imperative methods. */
+  get nativeElement(): LuzmoFiltersHostElement {
+    return this.host;
+  }
+
+  /** The API URL of the databroker */
+  @Input({ alias: 'apiUrl' })
+  apiUrl?: string;
+
+  /** The auth key of the databroker */
+  @Input({ alias: 'authKey' })
+  authKey?: string;
+
+  /** The auth token of the databroker */
+  @Input({ alias: 'authToken' })
+  authToken?: string;
+
+  /** The cache time of the databroker */
+  @Input({ alias: 'cacheTime' })
+  cacheTime?: number;
+
+  /** The language to use for locale-aware formatting and labels */
+  @Input({ alias: 'contentLanguage' })
+  contentLanguage?: string;
+
+  /** The time zone to use for the date picker */
+  @Input({ alias: 'timeZone' })
+  timeZone?: string;
+
+  /** The dataset ids to fetch columns & formulas */
+  @Input({ alias: 'datasetIds' })
+  datasetIds?: string[];
+
+  /** The filter groups to display.  Accepts both halves of the public `ItemFilterOutput` / `DashboardFilterOutput` unions: canonical `ItemFilterGroup[]` and clean clause groups with flattened leaves. Nested `and` / `or` groups are preserved either way. */
+  @Input({ alias: 'filters' })
+  filters?: FiltersInput;
+
+  /** Output format for the `luzmo-filters-changed` event.  `canonical` emits `ItemFilterGroup[]`; `clean` emits the clean clause groups that aligned hosts consume. A tree that cannot be represented cleanly falls back to canonical output, and the event says which format it carries. */
+  @Input({ alias: 'format' })
+  format?: FiltersFormat;
+
+  /** How the filters are presented. `rich` is the editable group editor. `text` is a read-only sentence, with parentheses around nested AND/OR groups. `outline` is one wrapping filter per line inside bracket rails, and can delete a filter unless `readonly` is set. */
+  @Input({ alias: 'display' })
+  display?: FiltersDisplay;
+
+  /** Presentation of column and formula references in text and outline displays. */
+  @Input({ alias: 'columnDisplay' })
+  columnDisplay?: FilterColumnDisplay;
+
+  /** Removes rich-editor control chrome while keeping the filters editable. */
+  @Input({ alias: 'quiet', transform: booleanAttribute })
+  quiet?: boolean;
+
+  /** Prevents changes while preserving the selected display and visual treatment. In `outline`, this hides the delete buttons. */
+  @Input({ alias: 'readonly', transform: booleanAttribute })
+  readonly?: boolean;
+
+  /** Whether parameter-backed filter values can be created and selected. */
+  @Input({ alias: 'allowParameters', transform: booleanAttribute })
+  allowParameters?: boolean;
+
+  /** Consumer-owned parameter definitions available to filter rows. */
+  @Input({ alias: 'parameters' })
+  parameters?: FilterParameter[];
+
+  /** Debounce time in milliseconds for the filters-changed event */
+  @Input({ alias: 'debounce' })
+  debounce?: number;
+
+  /** The language for UI labels. Supported values: 'en', 'nl', 'fr', 'de', 'es' */
+  @Input({ alias: 'language' })
+  language?: string;
+
+  /** The size of the element */
+  @Input({ alias: 'size' })
+  size?: 's' | 'm' | 'l' | 'xl';
+
+  /** Disable this control. It will not receive focus or events */
+  @Input({ alias: 'disabled', transform: booleanAttribute })
+  disabled?: boolean;
+
+  /** When this control is rendered, focus it automatically */
+  @Input({ alias: 'autofocus', transform: booleanAttribute })
+  autofocus?: boolean;
+
+  /** The tab index to apply to this control. See general documentation about the tabindex HTML property */
+  @Input({ alias: 'tabIndex' })
+  tabIndex?: number;
+
+  /** Announces that the filters have changed, carrying the emitted groups and the format they are in. `display="text"` never fires this. Outline fires it after a filter is deleted. */
+  readonly luzmoFiltersChanged = output<CustomEvent<FiltersChangedEventDetail>>({ alias: 'luzmoFiltersChanged' });
+
+  /** Announces that a parameter was created and added to `parameters`. */
+  readonly luzmoParameterCreated = output<CustomEvent<{ parameter: FilterParameter }>>({ alias: 'luzmoParameterCreated' });
+
+  /** Announces that a parameter was detached from a filter. */
+  readonly luzmoParameterRemoved = output<CustomEvent<{ parameter: FilterParameter }>>({ alias: 'luzmoParameterRemoved' });
+
+  constructor() {
+    this.bindEvents();
+    this.destroyRef.onDestroy(() => {
+      for (const cleanup of this.listenerCleanup) {
+        cleanup();
+      }
+    });
+  }
+
+  ngOnChanges(changes: SimpleChanges): void {
+    for (const key of Object.keys(changes)) {
+      switch (key) {
+        case 'apiUrl':
+          this.setHostProperty('apiUrl', changes['apiUrl'].currentValue);
+          break;
+        case 'authKey':
+          this.setHostProperty('authKey', changes['authKey'].currentValue);
+          break;
+        case 'authToken':
+          this.setHostProperty('authToken', changes['authToken'].currentValue);
+          break;
+        case 'cacheTime':
+          this.setHostProperty('cacheTime', changes['cacheTime'].currentValue);
+          break;
+        case 'contentLanguage':
+          this.setHostProperty('contentLanguage', changes['contentLanguage'].currentValue);
+          break;
+        case 'timeZone':
+          this.setHostProperty('timeZone', changes['timeZone'].currentValue);
+          break;
+        case 'datasetIds':
+          this.setHostProperty('datasetIds', changes['datasetIds'].currentValue);
+          break;
+        case 'filters':
+          this.setHostProperty('filters', changes['filters'].currentValue);
+          break;
+        case 'format':
+          this.setHostProperty('format', changes['format'].currentValue);
+          break;
+        case 'display':
+          this.setHostProperty('display', changes['display'].currentValue);
+          break;
+        case 'columnDisplay':
+          this.setHostProperty('columnDisplay', changes['columnDisplay'].currentValue);
+          break;
+        case 'quiet':
+          this.setHostProperty('quiet', changes['quiet'].currentValue);
+          break;
+        case 'readonly':
+          this.setHostProperty('readonly', changes['readonly'].currentValue);
+          break;
+        case 'allowParameters':
+          this.setHostProperty('allowParameters', changes['allowParameters'].currentValue);
+          break;
+        case 'parameters':
+          this.setHostProperty('parameters', changes['parameters'].currentValue);
+          break;
+        case 'debounce':
+          this.setHostProperty('debounce', changes['debounce'].currentValue);
+          break;
+        case 'language':
+          this.setHostProperty('language', changes['language'].currentValue);
+          break;
+        case 'size':
+          this.setHostProperty('size', changes['size'].currentValue);
+          break;
+        case 'disabled':
+          this.setHostProperty('disabled', changes['disabled'].currentValue);
+          break;
+        case 'autofocus':
+          this.setHostProperty('autofocus', changes['autofocus'].currentValue);
+          break;
+        case 'tabIndex':
+          this.setHostProperty('tabIndex', changes['tabIndex'].currentValue);
+          break;
+        default:
+          break;
+      }
+    }
+  }
+
+  /**
+   * Forward a wrapper @Input to the underlying host element via Renderer2 so
+   * the wrapper stays compatible with non-DOM Angular platforms (SSR, tests).
+   * Unlike a "skip undefined" guard, this lets consumers reset values back to
+   * undefined / null by clearing their bindings.
+   */
+  private setHostProperty(key: string, value: unknown): void {
+    this.renderer.setProperty(this.host, key, value);
+  }
+
+  private bindEvents(): void {
+    this.listenerCleanup.push(
+      this.renderer.listen(this.host, 'luzmo-filters-changed', (event: Event) => {
+        const typed = event as CustomEvent<FiltersChangedEventDetail>;
+        this.luzmoFiltersChanged.emit(typed);
+      })
+    );
+
+    this.listenerCleanup.push(
+      this.renderer.listen(this.host, 'luzmo-parameter-created', (event: Event) => {
+        const typed = event as CustomEvent<{ parameter: FilterParameter }>;
+        this.luzmoParameterCreated.emit(typed);
+      })
+    );
+
+    this.listenerCleanup.push(
+      this.renderer.listen(this.host, 'luzmo-parameter-removed', (event: Event) => {
+        const typed = event as CustomEvent<{ parameter: FilterParameter }>;
+        this.luzmoParameterRemoved.emit(typed);
+      })
+    );
+  }
+}
+
+/** The underlying custom element type for LuzmoFilters */
+export type LuzmoFiltersElement = LuzmoFiltersHostElement;