@firestitch/report 18.10.1 → 18.10.2

package/app/reports/components/component-text/component-text.component.d.ts

@@ -65,6 +65,7 @@ export declare class ComponentTextComponent {
     removeBlockedSelection(): void;
     undoValuesUnused(): void;
     dismissNotice(): void;
+    private _insertFieldEntries;
     private _openValuePopover;
     private _showNotice;
     private _clearNoticeTimer;

package/app/reports/components/component-text/value-embed.plugin.d.ts

@@ -1,5 +1,5 @@
 import { Plugin, PluginConfig } from '@firestitch/html-editor';
-import { TextValue } from '../../text';
+import { TextTokenContext, TextValue } from '../../text';
 export declare const VALUE_EMBED_ATTRIBUTES: string[];
 export interface ValueEmbedBlock {
     count: number;
@@ -10,10 +10,19 @@ export interface ValueEmbedRemoval {
     after: string[];
     undo: () => void;
 }
+export interface EmbedMenuEntry {
+    token: string;
+    name: string;
+}
 export interface ValueEmbedPluginConfig extends PluginConfig {
     host: () => HTMLElement;
     values: () => Record<string, TextValue>;
     scope: () => string;
+    fields: () => TextTokenContext;
+    menu: {
+        command: string;
+        entries: () => EmbedMenuEntry[];
+    };
     showNames: () => boolean;
     click: (key: string, chip: HTMLElement) => void;
     blocked: (block: ValueEmbedBlock) => void;
@@ -32,11 +41,15 @@ export declare class ValueEmbedPlugin extends Plugin {
     initialize(): void;
     destroy(): void;
     refresh(): void;
+    insert(token: string): void;
     hideToolbar(): void;
     undo(): void;
     removeKey(key: string): void;
     remove(chip: HTMLElement): void;
     private _chips;
+    private _fieldChips;
+    private _fillMenu;
+    private _menuItem;
     private _chipCounts;
     private _reportRemoved;
     private _watchCommands;
@@ -45,14 +58,21 @@ export declare class ValueEmbedPlugin extends Plugin {
     private _toChips;
     private _keepsPasted;
     private _splitText;
+    private _embedTokens;
+    private _tokenChip;
     private _toTokenText;
     private _createChip;
     private _label;
+    private _createFieldChip;
+    private _labelField;
     private _toTokens;
     private _onKeydown;
     private _onBeforeInput;
     private _guardSelection;
+    private _removeAdjacentField;
+    private _onCut;
     private _onCopy;
+    private _copyTokens;
     private _plainText;
     private _onClick;
     private _onChip;
@@ -61,7 +81,11 @@ export declare class ValueEmbedPlugin extends Plugin {
     private _changed;
     private _selection;
     private _range;
+    private _inBlocks;
+    private _edgeBlock;
     private _chipsIn;
+    private _fieldChipsIn;
     private _adjacentChip;
+    private _reach;
     private _granularity;
 }

package/app/reports/components/report-canvas/report-canvas.component.d.ts

@@ -55,6 +55,7 @@ export declare class ReportCanvasComponent implements OnChanges, AfterViewInit {
     readonly valueKeysElsewhere: (text: ReportComponent) => ReadonlySet<string>;
     private _reportData;
     private _filterState;
+    private _filterOptions;
     private _prompt;
     private _message;
     private _destroyRef;
@@ -69,6 +70,11 @@ export declare class ReportCanvasComponent implements OnChanges, AfterViewInit {
     private _pageValues;
     private _masterValues;
     private _valuesRevision;
+    private _filterRevision;
+    private _optionNames;
+    private _optionNamesAsked;
+    private _groupOptions;
+    private _selectPicks;
     private _valueKeysByLayer;
     constructor();
     ngOnChanges(changes: SimpleChanges): void;
@@ -84,6 +90,7 @@ export declare class ReportCanvasComponent implements OnChanges, AfterViewInit {
     onComponentRemoved(componentId: number): void;
     onTextSaved(text: ReportComponent, html: string): void;
     openValueSettings(text: ReportComponent, key: string): void;
+    componentTokens(component: ReportComponent): TextTokenContext;
     toggleMasterHidden(page: ReportPage): void;
     selectPage(index: number): void;
     addPage(): void;
@@ -103,6 +110,10 @@ export declare class ReportCanvasComponent implements OnChanges, AfterViewInit {
         componentId: number;
     } & Record<string, number>): void;
     private _init;
+    private _watchFilters;
+    private _filterValuesKey;
+    private _forgetUnreadNames;
+    private _watchOptionNames;
     private _valueLayer;
     private _watchValues;
     private _reloadIfChanged;
@@ -111,6 +122,7 @@ export declare class ReportCanvasComponent implements OnChanges, AfterViewInit {
     private _shownValues;
     private _loadValues;
     private _tokenContext;
+    private _filterFields;
     private _dropRemovedValueChips;
     private _isMasterComponent;
     private get _snapThreshold();

package/app/reports/components/report-component/report-component.component.d.ts

@@ -72,6 +72,7 @@ export declare class ReportComponentComponent implements OnInit, OnChanges {
     ngOnInit(): void;
     ngOnChanges(changes: SimpleChanges): void;
     get filterKey(): string;
+    get shownTitle(): string;
     get isText(): boolean;
     editText(): void;
     removeValue(key: string): void;

package/app/reports/data/report.data.d.ts

@@ -57,8 +57,8 @@ export declare class ReportData<T = any> {
     }>)[], config?: RequestConfig): Observable<T>;
     componentData(reportId: number, componentId: number, filters?: ResolvedFilterValue[], state?: ComponentDataState, isExport?: boolean, config?: RequestConfig): Observable<T>;
     pageValues(reportId: number, pageId: number, filters?: ResolvedFilterValue[], isExport?: boolean, config?: RequestConfig, matchAnyGroupIds?: number[]): Observable<ReportPageValue[]>;
-    exportComponent(reportId: number, componentId: number, filters?: ResolvedFilterValue[], state?: ComponentDataState, config?: RequestConfig): Observable<ComponentExportResponse>;
-    exportReport(reportId: number, filters?: ResolvedFilterValue[], pageId?: number | null, frequency?: ChartGranularity | null, filterLines?: ReportExportLine[], states?: Record<number, ComponentDataState>, viewId?: number | null, viewChanged?: boolean, config?: RequestConfig): Observable<T>;
+    exportComponent(reportId: number, componentId: number, filters?: ResolvedFilterValue[], state?: ComponentDataState, title?: string, config?: RequestConfig): Observable<ComponentExportResponse>;
+    exportReport(reportId: number, filters?: ResolvedFilterValue[], pageId?: number | null, frequency?: ChartGranularity | null, filterLines?: ReportExportLine[], states?: Record<number, ComponentDataState>, viewId?: number | null, viewChanged?: boolean, titles?: Record<number, string>, config?: RequestConfig): Observable<T>;
     filterOptions(reportId: number, filterId: number, config?: RequestConfig): Observable<T>;
     componentSql(reportId: number, componentId: number, config?: RequestConfig): Observable<ReportComponentSql>;
     componentColumns(reportId: number, componentId: number, config?: RequestConfig): Observable<T>;

package/app/reports/dialogs/component-settings/component-settings.component.d.ts

@@ -7,11 +7,17 @@ import { FilterBarPlacement } from '../../interfaces/filter-bar-placement.type';
 import { FilterComponentToggleState } from '../../interfaces/filter-component-toggle-state.interface';
 import { FilterSettingsOption } from '../../interfaces/filter-settings-option.interface';
 import { FilterTypeSelectState } from '../../interfaces/filter-type-select-state.interface';
+import { TextTokenContext } from '../../text';
 import * as i0 from "@angular/core";
 export interface ComponentSettingsResult {
     settings?: ComponentSettings;
     deleted?: boolean;
 }
+export interface ComponentSettingsDialogData {
+    report: Report;
+    component: ReportComponent;
+    tokens: TextTokenContext;
+}
 interface ComponentSettingsResponse {
     id: number;
     config?: Record<string, unknown> | null;
@@ -31,7 +37,10 @@ export declare class ComponentSettingsComponent implements OnInit {
     component: ReportComponent;
     report: Report;
     selectedTab: string;
-    title: string;
+    readonly title: import("@angular/core").WritableSignal<string>;
+    readonly titleFields: import("@angular/core").Signal<import("../../text").TextField[]>;
+    readonly titleShownAs: import("@angular/core").Signal<string>;
+    readonly heading: import("@angular/core").Signal<string>;
     paddingTop: number | string;
     paddingRight: number | string;
     paddingBottom: number | string;
@@ -72,6 +81,7 @@ export declare class ComponentSettingsComponent implements OnInit {
     private _pickedTypes;
     private readonly _typeLabels;
     private readonly _data;
+    private readonly _titleInput;
     private readonly _dialogRef;
     private readonly _reportData;
     private readonly _message;
@@ -80,6 +90,7 @@ export declare class ComponentSettingsComponent implements OnInit {
     ngOnInit(): void;
     typeLabel(type: ReportFilterType): string;
     delete(): void;
+    insertField(field: string): void;
     validateTarget: (control: AbstractControl) => void;
     save: () => Observable<ComponentSettingsResponse>;
     setType(row: FilterRow, type: ReportFilterType): void;
@@ -89,6 +100,7 @@ export declare class ComponentSettingsComponent implements OnInit {
     private _applyValueLevel;
     private _addFilter;
     private _patchRow;
+    private _shownTitle;
     private _formulaLine;
     private _dependentsNote;
     private _layerValues;

package/app/reports/export/report-export-collector.service.d.ts

@@ -4,7 +4,7 @@ import { ReportExportSnapshot } from '../interfaces/report-export-snapshot.inter
 import { ComponentData, ListColumn, Report, ReportComponent, ReportFormatContext, ReportLocaleTag, ReportPage } from '../interfaces/report.interface';
 import { KpiCardView } from '../kpi-card';
 import { ListOutputColumn } from '../list-config';
-import { TextTokenContext, TextValue } from '../text';
+import { TextFilterField, TextTokenContext, TextValue } from '../text';
 import * as i0 from "@angular/core";
 export interface CollectedComponent {
     component: ReportComponent;
@@ -25,9 +25,15 @@ export interface CollectedReport {
     masterValues: Record<string, TextValue>;
     masterFailedValues: string[];
     filterSummary: string[];
+    filterFields: Record<number, TextFilterField>;
     contextLines: string[];
     formatContext: ReportFormatContext;
 }
+export interface ReportExportWording {
+    lines: ReportExportLine[];
+    filterFields: Record<number, TextFilterField>;
+    titles: Record<number, string>;
+}
 export interface TextOverflow {
     componentId: number;
     page: string;
@@ -61,7 +67,7 @@ export interface KpiExportParts {
 }
 export declare const HEADER_FOOTER_NAME = "Header & footer";
 export declare function emptyLabel(item: CollectedComponent): string;
-export declare function exportTitle(component: ReportComponent, search?: string | null, crumbs?: readonly string[] | null): string;
+export declare function exportTitle(component: ReportComponent, tokens: TextTokenContext, search?: string | null, crumbs?: readonly string[] | null): string;
 export declare function isFailed(item: CollectedComponent): boolean;
 export declare function textOverflow(component: ReportComponent, page: string, tokens: TextTokenContext): TextOverflow;
 export declare function coverLines(collected: CollectedReport): string[];
@@ -79,7 +85,7 @@ export declare function scaledKpiHeights(heights: KpiExportHeights, scale: numbe
 export declare function kpiExportHeight(view: KpiCardView, parts: KpiExportParts, heights: KpiExportHeights): number;
 export declare function moreRowsNotice(remaining: number): string;
 export declare function failedPageNames(collected: CollectedReport): string[];
-export declare function coverFilterLines(snapshot: ReportExportSnapshot, lines: readonly ReportExportLine[], pages: readonly Pick<CollectedPage, 'components'>[]): string[];
+export declare function coverFilterLines(snapshot: ReportExportSnapshot, lines: readonly ReportExportLine[], pages: readonly Pick<CollectedPage, 'components'>[], titles?: Readonly<Record<number, string>>): string[];
 export declare function isExportSlot(component: ReportComponent): boolean;
 export declare class ReportExportCollectorService {
     private _reportData;
@@ -88,7 +94,8 @@ export declare class ReportExportCollectorService {
     private _views;
     collect(report: Report, listRows: number): Observable<CollectedReport>;
     snapshot(report: Report): ReportExportSnapshot;
-    filterLines(report: Report, snapshot: ReportExportSnapshot, pageId?: number | null): Observable<ReportExportLine[]>;
+    exportWording(report: Report, snapshot: ReportExportSnapshot, pageId?: number | null): Observable<ReportExportWording>;
+    private _exportTitles;
     private _jobs;
     private _valuesJobs;
     private _runJob;
@@ -98,7 +105,8 @@ export declare class ReportExportCollectorService {
     private _pageValues;
     private _file;
     private _contextLines;
-    private _pickNames;
+    private _filterFields;
+    private _pickNamer;
     static ɵfac: i0.ɵɵFactoryDeclaration<ReportExportCollectorService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ReportExportCollectorService>;
 }

package/app/reports/export/report-filter-lines.d.ts

@@ -11,6 +11,9 @@ export declare const MATCH_ANY_CHIP = "Match: any filter";
 export declare const MATCH_ANY_LINE = "Filters in the report bar: match any";
 export declare const MATCH_ALL_CHIP = "Match: all filters";
 export declare function filterLineText(group: Pick<ReportFilterGroup, 'label' | 'level'>, value: FilterGroupValue | null | undefined, context: ReportFilterLineContext, form: ReportFilterLineForm): string | null;
+export declare function filterChipValueText(value: FilterGroupValue | null | undefined, context: ReportFilterLineContext): string | null;
+export declare function excludes(value: FilterGroupValue | null | undefined): boolean;
+export declare function valuePicks(value: FilterGroupValue | null | undefined): unknown[];
 export declare function matchLineText(match: ReportFilterMatch | null | undefined, form: ReportFilterLineForm): string | null;
 export declare function drillLineText(component: Pick<ReportComponent, 'title'>, path: readonly ReportDrillStep[], formatContext: Pick<ReportFormatContext, 'locale'>): string;
 export declare function viewLineText(view: Pick<ReportViewSummary, 'name' | 'shared'> | null | undefined, changed: boolean): string | null;

package/app/reports/filter-text.d.ts

@@ -0,0 +1,8 @@
+import { FilterGroupValue, ReportFilterGroup, ReportLocaleTag } from './interfaces/report.interface';
+import { TextFilterField } from './text';
+export declare function layerFilterGroups(groups: ReportFilterGroup[], pageId: number | null): ReportFilterGroup[];
+export declare function layerFilterFields(fields: Record<number, TextFilterField>, groups: ReportFilterGroup[], pageId: number | null): Record<number, TextFilterField>;
+export declare function filterFieldName(group: Pick<ReportFilterGroup, 'label' | 'name'>): string;
+export declare function textFilterFields(groups: ReportFilterGroup[], value: (groupId: number) => FilterGroupValue | null | undefined, locale: ReportLocaleTag, names: (group: ReportFilterGroup, values: unknown[]) => readonly string[] | null | undefined): Record<number, TextFilterField>;
+export declare function filterFieldText(group: Pick<ReportFilterGroup, 'type'>, value: FilterGroupValue | null | undefined, locale: ReportLocaleTag, names?: readonly string[]): string;
+export declare function sameFilterFields(a: Record<number, TextFilterField> | undefined, b: Record<number, TextFilterField> | undefined): boolean;

package/app/reports/format.d.ts

@@ -62,6 +62,7 @@ export declare function formatDayWindow(meta: {
 }, timezone: string, locale: ReportLocaleTag): string;
 export declare function isReadOnOneDay(comparison: ComponentComparison | null | undefined): boolean;
 export declare function formatReadingDay(window: Pick<ComparisonWindow, 'end'>, locale: ReportLocaleTag, lead?: boolean): string;
+export declare function writeDayRange(first: Date, last: Date, locale: ReportLocaleTag, options: Intl.DateTimeFormatOptions): string;
 export declare function localeName(tag: ReportLocaleTag): string;
 export declare function currencyName(code: ReportCurrencyCode): string;
 export declare function comparisonOffsetLabel(offset: ComparisonOffset): string;

package/app/reports/interfaces/report-export-lines-input.interface.d.ts

@@ -6,4 +6,5 @@ export interface ReportExportLinesInput {
     snapshot: ReportExportSnapshot;
     pageId: number | null;
     names: (group: ReportFilterGroup, values: unknown[]) => Observable<string[]>;
+    titles?: Readonly<Record<number, string>>;
 }

package/app/reports/report-filter-items.d.ts

@@ -17,6 +17,15 @@ export declare function itemRangeName(name: string, end: ItemRangeEnd): string;
 export declare function groupItemName(group: Pick<ReportFilterGroup, 'id'>): string;
 export declare function loadGroupOptions(group: ReportFilterGroup, reportData: ReportData, reportId: number): Observable<ReportFilterOptionPair[]>;
 export declare function resolveOptionValues(options$: Observable<ReportFilterOptionPair[]>, values: unknown[], label?: (value: unknown) => string | null): Observable<ReportFilterOptionPair[]>;
+export type GroupOptionsReader = (group: ReportFilterGroup, reportId: number) => Observable<{
+    name: string;
+    value: unknown;
+}[]>;
+export declare function groupOptionsReader(reportData: ReportData): GroupOptionsReader;
+export declare function pickedOptionNames(options$: Observable<{
+    name: string;
+    value: unknown;
+}[]>, values: unknown[], label?: (value: unknown) => string | null): Observable<string[] | null>;
 export declare function matchOptions(options$: Observable<ReportFilterOptionPair[]>, keyword?: string): Observable<ReportFilterOptionPair[]>;
 export declare const OPTIONS_TRUNCATED_NOTE = "Showing the first 500. Type to narrow.";
 export declare const OPTIONS_FAILED_NOTE = "Could not load the list.";

package/app/reports/text.d.ts

@@ -14,14 +14,22 @@ export interface TextValue {
     loading?: boolean;
     reads?: string[];
 }
+export interface TextFilterField {
+    name: string;
+    order: number;
+    text?: string;
+    loading?: boolean;
+}
 export interface TextTokenContext {
     pageNumber: number;
     pageName: string;
     reportName: string;
     values?: Record<string, TextValue>;
+    filters?: Record<number, TextFilterField>;
     valuePageId?: number | null;
 }
 export declare const VALUE_TOKEN_PATTERN: RegExp;
+export declare const FIELD_TOKEN_PATTERN: RegExp;
 export declare const VALUE_EMPTY_TEXT = "\u2014";
 export declare const VALUE_LOADING_TEXT = "\u2026";
 export declare function valueToken(key: string): string;
@@ -69,7 +77,15 @@ export type TextBlock = {
     kind: 'table';
     table: TextTable;
 };
+export interface TextField {
+    field: string;
+    name: string;
+}
+export declare function textFields(context: TextTokenContext): TextField[];
+export declare function fieldToken(field: string): string;
 export declare function fillTextTokens(html: string, context: TextTokenContext): string;
+export declare function fillTitleTokens(title: string | null | undefined, context: TextTokenContext): string;
+export declare function fieldText(field: string, context: TextTokenContext): string;
 export declare function textBlocks(html: string, context: TextTokenContext): TextBlock[];
 export declare function textParagraphs(html: string, context: TextTokenContext): TextParagraph[];
 export declare function blockParagraphs(blocks: TextBlock[]): TextParagraph[];