@sinequa/atomic-angular 1.8.0 → 1.9.0

package/fesm2022/sinequa-atomic-angular.mjs

@@ -3540,16 +3540,33 @@ class AggregationsService {
     }
     /* aggregations helpers fot the filters components */
     getAuthorizedFilters(aggregations, includedFilters = [], excludedFilters = [], homepageOnly = false) {
+        // An explicit list is a deliberate developer choice: it bypasses the `hidden`
+        // admin rule. The rule only applies to the default, config-driven path.
+        const explicit = aggregations !== undefined;
         const agg = aggregations || this.appStore.getAuthorizedFilters();
         const authorizedFilters = agg
             .filter((f) => this.getFilterCriteria()(f)) // filter only the filters present
             .filter((f) => !homepageOnly || this.getHomepageFilterCriteria()(f)) // when requested, keep only filters flagged `homepage: true`
             .filter((f) => !this.getLeftOnlyFilterCriteria()(f)) // exclude left-only filters (rendered in the left drawer, not the bar)
+            .filter((f) => explicit || !this.getHiddenFilterCriteria()(f)) // exclude admin-hidden filters (default path only)
             .filter((f) => !excludedFilters.includes(f.name))
             .filter((f) => !includedFilters.length || includedFilters.includes(f.name))
             .map((f) => ({ field: f.column, column: f.column, name: f.name })); // field is needed for filters constructions
         return authorizedFilters;
     }
+    /**
+     * Removes the aggregations flagged `hidden: true` in the `filters` custom JSON
+     * configuration (the administrator does not want them displayed).
+     *
+     * Exposed for consumers that build their own aggregation list without going through
+     * {@link getAuthorizedFilters} (e.g. the aside filters drawer).
+     *
+     * @param aggregations - The aggregations to filter.
+     * @returns The aggregations that are not flagged hidden.
+     */
+    rejectHidden(aggregations) {
+        return aggregations.filter((agg) => !this.getHiddenFilterCriteria()(agg));
+    }
     /**
      * Determines whether a custom JSON filter refers to the given aggregation.
      *
@@ -3593,6 +3610,10 @@ class AggregationsService {
         // `position: 'both'` (and an undefined position) stay in the bar.
         return (agg) => this.appStore.filters().some((filter) => filter.position === "left" && this.matchesAggregation(filter, agg));
     };
+    getHiddenFilterCriteria = () => {
+        // an aggregation is hidden when a matching filter in the custom JSON has `hidden: true`
+        return (agg) => this.appStore.filters().some((filter) => filter.hidden && this.matchesAggregation(filter, agg));
+    };
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: AggregationsService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: AggregationsService, providedIn: "root" });
 }
@@ -15392,28 +15413,55 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImpo
 class AsideFiltersComponent {
     cn = cn;
     class = input(...(ngDevMode ? [undefined, { debugName: "class" }] : []));
-    position = input(...(ngDevMode ? [undefined, { debugName: "position" }] : []));
+    /**
+     * Explicit, developer-defined list of aggregations to display.
+     *
+     * Each entry is an aggregation **name** (preferred) or **column** — e.g.
+     * `['Authors', 'Sources', 'Geo']`. Although typed as `string[]`, this is the list of
+     * aggregations to render, not a list of raw column keys.
+     *
+     * When provided, it fully bypasses the JSON `filters` configuration (neither
+     * `position`, `getAuthorized`, nor the admin `hidden` rule are applied): the listed
+     * aggregations are rendered as-is, in the given order, provided they exist in the
+     * {@link AggregationsStore}. When empty (default), the component falls back to the
+     * JSON-driven behavior (`position: 'left' | 'both'`, excluding `hidden` aggregations).
+     *
+     * Resolution tries by `name` first — the canonical, unambiguous identifier, since a
+     * `column` can be shared by several aggregations with distinct names — then falls back
+     * to the first aggregation matching the given column. Prefer passing names.
+     */
+    aggregations = input([], ...(ngDevMode ? [{ debugName: "aggregations" }] : []));
+    /**
+     * When `true` (default), every section shares the same `id`, producing a native
+     * `<details name>` accordion where a single section is open at a time. When `false`,
+     * each section gets a unique id (based on the aggregation `name`) and expands
+     * independently — closer to a typical SBA v2 "Facets List".
+     */
+    exclusive = input(true, ...(ngDevMode ? [{ debugName: "exclusive", transform: booleanAttribute }] : [{ transform: booleanAttribute }]));
     appStore = inject(AppStore);
+    aggregationsStore = inject(AggregationsStore);
+    aggregationsService = inject(AggregationsService);
     asideFilters = computed(() => {
-        // `left` filters live only in the drawer, `both` filters live in the drawer and the bar
+        const explicit = this.aggregations();
+        // Explicit developer-defined list → render exactly as passed, bypassing the JSON config.
+        if (explicit.length > 0) {
+            return explicit
+                .map((key) => this.aggregationsStore.getAggregation(key, "name") ?? this.aggregationsStore.getAggregation(key, "column"))
+                .filter((agg) => !!agg)
+                .map((agg) => ({ name: agg.name, column: agg.column }));
+        }
+        // Default JSON-driven behavior:
+        // `left` filters live only in the drawer, `both` filters live in the drawer and the bar.
+        // Admin-hidden aggregations are excluded (the rule lives in the service).
         const asideFilters = this.appStore.filters().filter((f) => f.position === "left" || f.position === "both");
-        return this.appStore.getAuthorized(asideFilters);
+        return this.aggregationsService.rejectHidden(this.appStore.getAuthorized(asideFilters));
     }, ...(ngDevMode ? [{ debugName: "asideFilters" }] : []));
-    /**
-     * Checks if the specified column is a date filter.
-     *
-     * @param column The column name to check.
-     * @returns True if the column is a date filter, false otherwise.
-     */
-    isDate(column) {
-        return this.appStore.isDateColumn(column);
-    }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: AsideFiltersComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });
-    static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "20.3.25", type: AsideFiltersComponent, isStandalone: true, selector: "aside-filters, AsideFilters, asidefilters", inputs: { class: { classPropertyName: "class", publicName: "class", isSignal: true, isRequired: false, transformFunction: null }, position: { classPropertyName: "position", publicName: "position", isSignal: true, isRequired: false, transformFunction: null } }, host: { properties: { "class": "cn('flex flex-col gap-2 overflow-auto', class())" } }, ngImport: i0, template: `
+    static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "20.3.25", type: AsideFiltersComponent, isStandalone: true, selector: "aside-filters, AsideFilters, asidefilters", inputs: { class: { classPropertyName: "class", publicName: "class", isSignal: true, isRequired: false, transformFunction: null }, aggregations: { classPropertyName: "aggregations", publicName: "aggregations", isSignal: true, isRequired: false, transformFunction: null }, exclusive: { classPropertyName: "exclusive", publicName: "exclusive", isSignal: true, isRequired: false, transformFunction: null } }, host: { properties: { "class": "cn('flex flex-col gap-2 overflow-auto', class())" } }, ngImport: i0, template: `
   <div class="flex flex-col gap-2">
     @for (agg of asideFilters(); track agg.name) {
       <Aggregation
-        id="aside-filters"
+        [id]="exclusive() ? 'aside-filters' : 'aside-filters-' + agg.name"
         [name]="agg.name"
         [column]="agg.column"
         [collapsible]="true"
@@ -15432,7 +15480,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImpo
   <div class="flex flex-col gap-2">
     @for (agg of asideFilters(); track agg.name) {
       <Aggregation
-        id="aside-filters"
+        [id]="exclusive() ? 'aside-filters' : 'aside-filters-' + agg.name"
         [name]="agg.name"
         [column]="agg.column"
         [collapsible]="true"
@@ -15445,7 +15493,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImpo
                         "[class]": "cn('flex flex-col gap-2 overflow-auto', class())"
                     }
                 }]
-        }], propDecorators: { class: [{ type: i0.Input, args: [{ isSignal: true, alias: "class", required: false }] }], position: [{ type: i0.Input, args: [{ isSignal: true, alias: "position", required: false }] }] } });
+        }], propDecorators: { class: [{ type: i0.Input, args: [{ isSignal: true, alias: "class", required: false }] }], aggregations: [{ type: i0.Input, args: [{ isSignal: true, alias: "aggregations", required: false }] }], exclusive: [{ type: i0.Input, args: [{ isSignal: true, alias: "exclusive", required: false }] }] } });
 
 class FilterButtonComponent {
     name = input(...(ngDevMode ? [undefined, { debugName: "name" }] : []));
@@ -15656,92 +15704,27 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImpo
 const FILTERS_BREAKPOINT = new InjectionToken('FILTERS_BREAKPOINT', { factory: () => 5 });
 
 class MoreComponent {
-    cn = cn;
     count = input(2, ...(ngDevMode ? [{ debugName: "count" }] : []));
     includedFilters = input([], ...(ngDevMode ? [{ debugName: "includedFilters" }] : []));
     excludedFilters = input([], ...(ngDevMode ? [{ debugName: "excludedFilters" }] : []));
     aggregations = input(...(ngDevMode ? [undefined, { debugName: "aggregations" }] : []));
     homepage = input(false, ...(ngDevMode ? [{ debugName: "homepage", transform: booleanAttribute }] : [{ transform: booleanAttribute }]));
-    appStore = inject(AppStore);
-    aggregationsStore = inject(AggregationsStore);
-    queryParamsStore = inject(QueryParamsStore);
     aggregationsService = inject(AggregationsService);
     /**
-     * Signal containing an array of extended filter objects.
+     * The overflow filters rendered as accordions: the authorized filters beyond the
+     * first `count` (which are already shown in the bar).
      *
      * @remarks
-     * This signal holds the current state of filters that can be applied to data.
-     * The filters are of type CFilterEx[], which extends the base filter functionality.
-     *
+     * Pure display wiring — authorization (and the admin `hidden` rule) is handled by
+     * {@link AggregationsService.getAuthorizedFilters}; `toSpliced` just drops the
+     * filters already shown in the bar.
      */
-    filters = signal([], ...(ngDevMode ? [{ debugName: "filters" }] : []));
-    /**
-     * Computed property that returns an array of filters that are currently visible.
-     * Filters out any filters where the `hidden` property is set to true.
-     *
-     * @returns An array of filters that are not hidden
-     */
-    visibleFilters = computed(() => {
-        const filters = this.filters().filter((f) => !f.hidden);
-        return filters;
-    }, ...(ngDevMode ? [{ debugName: "visibleFilters" }] : []));
-    constructor() {
-        effect(() => {
-            const count = this.count();
-            const authorizedFilters = this.aggregationsService
-                .getAuthorizedFilters(this.aggregations(), this.includedFilters(), this.excludedFilters(), this.homepage())
-                .toSpliced(0, count);
-            const f = authorizedFilters.map((agg) => {
-                const { icon = "far fa-list", hidden = false } = this.appStore.getAggregationCustomization(agg.column, agg.name) || {};
-                return {
-                    name: agg.name,
-                    column: agg.column,
-                    icon,
-                    count: 0,
-                    isTree: false,
-                    disabled: false,
-                    hidden
-                };
-            });
-            this.filters.set(f);
-            this.updateFilters();
-        });
-    }
-    clearFilter(field) {
-        this.queryParamsStore.removeFilter(field);
-    }
-    updateFilters() {
-        this.filters.update((filters) => {
-            return filters.map((filter) => {
-                const agg = this.aggregationsStore.getAggregation(filter.name);
-                const f = this.queryParamsStore.getFilter({ name: agg?.name, field: agg?.column });
-                const count = f?.count || 0;
-                const { display = agg?.isTree ? undefined : filter.display } = this.appStore.getAggregationCustomization(filter.column) || {};
-                return {
-                    ...filter,
-                    name: agg?.name || filter.name,
-                    display,
-                    isTree: agg?.isTree || false,
-                    count,
-                    disabled: !!(!agg?.items || agg.items?.length === 0) // Disable if no items
-                };
-            });
-        });
-    }
-    /**
-     * Checks whether there are active filters for the current aggregation column.
-     *
-     * if True, the clear button is shown.
-     *
-     * @returns {boolean} `true` if the filter count for the aggregation column is greater than 0, otherwise `false`.
-     */
-    hasFilters(aggregation) {
-        const { count = 0 } = this.queryParamsStore.getFilter({ field: aggregation.column, name: aggregation.name }) || {};
-        return count > 0;
-    }
+    filters = computed(() => this.aggregationsService
+        .getAuthorizedFilters(this.aggregations(), this.includedFilters(), this.excludedFilters(), this.homepage())
+        .toSpliced(0, this.count()), ...(ngDevMode ? [{ debugName: "filters" }] : []));
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: MoreComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });
     static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "20.3.25", type: MoreComponent, isStandalone: true, selector: "more, More", inputs: { count: { classPropertyName: "count", publicName: "count", isSignal: true, isRequired: false, transformFunction: null }, includedFilters: { classPropertyName: "includedFilters", publicName: "includedFilters", isSignal: true, isRequired: false, transformFunction: null }, excludedFilters: { classPropertyName: "excludedFilters", publicName: "excludedFilters", isSignal: true, isRequired: false, transformFunction: null }, aggregations: { classPropertyName: "aggregations", publicName: "aggregations", isSignal: true, isRequired: false, transformFunction: null }, homepage: { classPropertyName: "homepage", publicName: "homepage", isSignal: true, isRequired: false, transformFunction: null } }, host: { classAttribute: "divide-y divide-muted-foreground/18" }, ngImport: i0, template: `
-    @for (filter of visibleFilters(); track $index) {
+    @for (filter of filters(); track $index) {
       <Aggregation
         class="w-60 max-w-80 px-1 [--height:15lh]"
         id="more-filters"
@@ -15757,7 +15740,7 @@ class MoreComponent {
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImport: i0, type: MoreComponent, decorators: [{
             type: Component,
             args: [{ selector: "more, More", standalone: true, imports: [AggregationComponent, TranslocoPipe], template: `
-    @for (filter of visibleFilters(); track $index) {
+    @for (filter of filters(); track $index) {
       <Aggregation
         class="w-60 max-w-80 px-1 [--height:15lh]"
         id="more-filters"
@@ -15771,7 +15754,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.3.25", ngImpo
   `, host: {
                         class: "divide-y divide-muted-foreground/18"
                     }, styles: [":host{scrollbar-width:none}\n"] }]
-        }], ctorParameters: () => [], propDecorators: { count: [{ type: i0.Input, args: [{ isSignal: true, alias: "count", required: false }] }], includedFilters: [{ type: i0.Input, args: [{ isSignal: true, alias: "includedFilters", required: false }] }], excludedFilters: [{ type: i0.Input, args: [{ isSignal: true, alias: "excludedFilters", required: false }] }], aggregations: [{ type: i0.Input, args: [{ isSignal: true, alias: "aggregations", required: false }] }], homepage: [{ type: i0.Input, args: [{ isSignal: true, alias: "homepage", required: false }] }] } });
+        }], propDecorators: { count: [{ type: i0.Input, args: [{ isSignal: true, alias: "count", required: false }] }], includedFilters: [{ type: i0.Input, args: [{ isSignal: true, alias: "includedFilters", required: false }] }], excludedFilters: [{ type: i0.Input, args: [{ isSignal: true, alias: "excludedFilters", required: false }] }], aggregations: [{ type: i0.Input, args: [{ isSignal: true, alias: "aggregations", required: false }] }], homepage: [{ type: i0.Input, args: [{ isSignal: true, alias: "homepage", required: false }] }] } });
 
 class MoreButtonComponent {
     appStore = inject(AppStore);