@ecodev/natural 48.0.3 → 49.0.0

package/lib/classes/abstract-list.d.ts

@@ -14,6 +14,7 @@ import { NaturalDataSource, PaginatedData } from './data-source';
 import { NaturalQueryVariablesManager, PaginationInput, QueryVariables, Sorting } from './query-variable-manager';
 import { ExtractTall, ExtractVall, Literal } from '../types/types';
 import { NavigableItem } from './abstract-navigable-list';
+import { AvailableColumn } from '../modules/columns-picker/types';
 import * as i0 from "@angular/core";
 type MaybeNavigable = Literal | NavigableItem<Literal>;
 /**
@@ -33,15 +34,21 @@ export declare class NaturalAbstractList<TService extends NaturalAbstractModelSe
      */
     persistSearch: boolean;
     /**
-     * Columns list after interaction with <natural-columns-picker>
+     * List of columns that are available to the end-user to select from, via `<natural-columns-picker>`
+     */
+    availableColumns: AvailableColumn[];
+    /**
+     * Columns list after interaction with `<natural-columns-picker>`
      */
     columnsForTable: string[];
     /**
-     * The default column selection that automatically happened after <natural-columns-picker> initialization
+     * The default column selection that automatically happened after `<natural-columns-picker>` initialization
      */
     private defaultSelectedColumns;
     /**
      * Visible (checked) columns
+     *
+     * Instead of using this, you should consider correctly configuring `AvailableColumn.checked`.
      */
     selectedColumns?: string[];
     /**
@@ -157,6 +164,7 @@ export declare class NaturalAbstractList<TService extends NaturalAbstractModelSe
      * Uses data provided by router such as:
      *
      * - `route.data.forcedVariables`
+     * - `route.data.availableColumns`
      * - `route.data.selectedColumns`
      */
     protected initFromRoute(): void;
@@ -175,6 +183,6 @@ export declare class NaturalAbstractList<TService extends NaturalAbstractModelSe
     private applyForcedVariables;
     selectColumns(columns: string[]): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<NaturalAbstractList<any, any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NaturalAbstractList<any, any>, never, never, { "persistSearch": "persistSearch"; "selectedColumns": "selectedColumns"; "forcedVariables": "forcedVariables"; }, {}, never, never, false, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<NaturalAbstractList<any, any>, never, never, { "persistSearch": "persistSearch"; "availableColumns": "availableColumns"; "selectedColumns": "selectedColumns"; "forcedVariables": "forcedVariables"; }, {}, never, never, false, never>;
 }
 export {};

package/lib/modules/columns-picker/columns-picker.component.d.ts

@@ -1,11 +1,15 @@
-import { AfterViewInit, ChangeDetectorRef, EventEmitter, OnDestroy, QueryList } from '@angular/core';
-import { NaturalColumnsPickerColumnDirective } from './columns-picker-column.directive';
+import { EventEmitter, OnChanges, OnDestroy, SimpleChanges } from '@angular/core';
+import { AvailableColumn } from './types';
 import * as i0 from "@angular/core";
-export declare class NaturalColumnsPickerComponent implements AfterViewInit, OnDestroy {
-    private readonly changeDetectorRef;
+export declare class NaturalColumnsPickerComponent implements OnChanges, OnDestroy {
     private _selections?;
+    private _availableColumns;
     /**
-     * Set the columns that are wanted but might be unavailable.
+     * Set all the columns that are available.
+     */
+    set availableColumns(columns: Readonly<Readonly<AvailableColumn>[]> | undefined);
+    /**
+     * Set the columns that we would like to select but might be unavailable.
      *
      * If a column is unavailable it will be ignored silently. To know what columns were actually applied
      * you should use `selectionChange`.
@@ -17,20 +21,15 @@ export declare class NaturalColumnsPickerComponent implements AfterViewInit, OnD
      * Emit a list of valid and selected column keys whenever the selection changes
      */
     readonly selectionChange: EventEmitter<string[]>;
-    /**
-     * Available columns are defined by options in the template
-     */
-    availableColumns: QueryList<NaturalColumnsPickerColumnDirective> | null;
     /**
      * Displayed options in the dropdown menu
      */
-    displayedColumns: NaturalColumnsPickerColumnDirective[];
-    private ngUnsubscribe;
-    constructor(changeDetectorRef: ChangeDetectorRef);
-    ngAfterViewInit(): void;
+    displayedColumns: Required<AvailableColumn>[];
+    private readonly ngUnsubscribe;
     private initColumns;
     updateColumns(): void;
     ngOnDestroy(): void;
+    ngOnChanges(changes: SimpleChanges): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<NaturalColumnsPickerComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NaturalColumnsPickerComponent, "natural-columns-picker", never, { "selections": "selections"; }, { "selectionChange": "selectionChange"; }, ["availableColumns"], never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NaturalColumnsPickerComponent, "natural-columns-picker", never, { "availableColumns": "availableColumns"; "selections": "selections"; }, { "selectionChange": "selectionChange"; }, never, never, false, never>;
 }

package/lib/modules/columns-picker/columns-picker.module.d.ts

@@ -1,16 +1,15 @@
 import * as i0 from "@angular/core";
-import * as i1 from "./columns-picker-column.directive";
-import * as i2 from "./columns-picker.component";
-import * as i3 from "@angular/common";
-import * as i4 from "@angular/forms";
-import * as i5 from "@angular/material/menu";
-import * as i6 from "@angular/material/button";
-import * as i7 from "@angular/material/checkbox";
-import * as i8 from "../icon/icon.module";
-import * as i9 from "@angular/material/tooltip";
-import * as i10 from "@angular/material/icon";
+import * as i1 from "./columns-picker.component";
+import * as i2 from "@angular/common";
+import * as i3 from "@angular/forms";
+import * as i4 from "@angular/material/menu";
+import * as i5 from "@angular/material/button";
+import * as i6 from "@angular/material/checkbox";
+import * as i7 from "../icon/icon.module";
+import * as i8 from "@angular/material/tooltip";
+import * as i9 from "@angular/material/icon";
 export declare class NaturalColumnsPickerModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<NaturalColumnsPickerModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NaturalColumnsPickerModule, [typeof i1.NaturalColumnsPickerColumnDirective, typeof i2.NaturalColumnsPickerComponent], [typeof i3.CommonModule, typeof i4.FormsModule, typeof i5.MatMenuModule, typeof i6.MatButtonModule, typeof i7.MatCheckboxModule, typeof i8.NaturalIconModule, typeof i9.MatTooltipModule, typeof i10.MatIconModule], [typeof i1.NaturalColumnsPickerColumnDirective, typeof i2.NaturalColumnsPickerComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NaturalColumnsPickerModule, [typeof i1.NaturalColumnsPickerComponent], [typeof i2.CommonModule, typeof i3.FormsModule, typeof i4.MatMenuModule, typeof i5.MatButtonModule, typeof i6.MatCheckboxModule, typeof i7.NaturalIconModule, typeof i8.MatTooltipModule, typeof i9.MatIconModule], [typeof i1.NaturalColumnsPickerComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<NaturalColumnsPickerModule>;
 }

package/lib/modules/columns-picker/public-api.d.ts

@@ -1,3 +1,3 @@
-export * from './columns-picker-column.directive';
+export { AvailableColumn } from './types';
 export * from './columns-picker.component';
 export * from './columns-picker.module';

package/lib/modules/columns-picker/types.d.ts

@@ -0,0 +1,30 @@
+export type AvailableColumn = {
+    /**
+     * This must be the column ID as defined in `matColumnDef`
+     *
+     * Implementation details:
+     *
+     * Unfortunately, we cannot use a `Record<AvailableColumn>` where keys would implicitly be unique and would replace
+     * this ID property, because only ES2020 guarantee the order of object keys, and we must still support ES2015 for
+     * iPhone 6. So, instead of `Record<AvailableColumn>`, we use `AvailableColumn[]` for now. But this could be
+     * revisited once we drop support of ES2015.
+     *
+     * @see https://stackoverflow.com/questions/30076219/does-es6-introduce-a-well-defined-order-of-enumeration-for-object-properties
+     */
+    id: string;
+    /**
+     * Localized label of column for human
+     */
+    label: string;
+    /**
+     * Initial checked state, defaults to `true`.
+     */
+    checked?: boolean;
+    /**
+     * Initial visibility state, defaults to `false`.
+     *
+     * A column that is hidden will not appear in the list of choice,
+     * but it will be included in the result of selected columns.
+     */
+    hidden?: boolean;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ecodev/natural",
-  "version": "48.0.3",
+  "version": "49.0.0",
   "license": "MIT",
   "repository": "github:Ecodev/natural",
   "sideEffects": false,

package/esm2020/lib/modules/columns-picker/columns-picker-column.directive.mjs

@@ -1,47 +0,0 @@
-import { Directive, Input } from '@angular/core';
-import * as i0 from "@angular/core";
-export class NaturalColumnsPickerColumnDirective {
-    constructor(elementRef) {
-        this.elementRef = elementRef;
-        /**
-         * Initial checked state
-         */
-        this.checked = true;
-        /**
-         * Initial visibility state
-         */
-        this.hidden = false;
-        /**
-         * Localized label of column, if absent default to key
-         */
-        this.label = '';
-    }
-    /**
-     * This must be the column key as defined in matColumnDef
-     */
-    set naturalColumnsPickerColumn(value) {
-        this.key = value;
-    }
-    ngOnInit() {
-        // Default label to key before real label is accessible
-        this.label = this.key;
-    }
-    ngAfterViewInit() {
-        this.label = this.elementRef.nativeElement.textContent ?? '';
-    }
-}
-NaturalColumnsPickerColumnDirective.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.1.2", ngImport: i0, type: NaturalColumnsPickerColumnDirective, deps: [{ token: i0.ElementRef }], target: i0.ɵɵFactoryTarget.Directive });
-NaturalColumnsPickerColumnDirective.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.1.2", type: NaturalColumnsPickerColumnDirective, selector: "[naturalColumnsPickerColumn]", inputs: { checked: "checked", hidden: "hidden", naturalColumnsPickerColumn: "naturalColumnsPickerColumn" }, ngImport: i0 });
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.1.2", ngImport: i0, type: NaturalColumnsPickerColumnDirective, decorators: [{
-            type: Directive,
-            args: [{
-                    selector: '[naturalColumnsPickerColumn]',
-                }]
-        }], ctorParameters: function () { return [{ type: i0.ElementRef }]; }, propDecorators: { checked: [{
-                type: Input
-            }], hidden: [{
-                type: Input
-            }], naturalColumnsPickerColumn: [{
-                type: Input
-            }] } });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29sdW1ucy1waWNrZXItY29sdW1uLmRpcmVjdGl2ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3Byb2plY3RzL25hdHVyYWwvc3JjL2xpYi9tb2R1bGVzL2NvbHVtbnMtcGlja2VyL2NvbHVtbnMtcGlja2VyLWNvbHVtbi5kaXJlY3RpdmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFnQixTQUFTLEVBQWMsS0FBSyxFQUFTLE1BQU0sZUFBZSxDQUFDOztBQUtsRixNQUFNLE9BQU8sbUNBQW1DO0lBa0I1QyxZQUFvQyxVQUFtQztRQUFuQyxlQUFVLEdBQVYsVUFBVSxDQUF5QjtRQWZ2RTs7V0FFRztRQUNhLFlBQU8sR0FBRyxJQUFJLENBQUM7UUFFL0I7O1dBRUc7UUFDYSxXQUFNLEdBQUcsS0FBSyxDQUFDO1FBRS9COztXQUVHO1FBQ0ksVUFBSyxHQUFHLEVBQUUsQ0FBQztJQUV3RCxDQUFDO0lBRTNFOztPQUVHO0lBQ0gsSUFDVywwQkFBMEIsQ0FBQyxLQUFhO1FBQy9DLElBQUksQ0FBQyxHQUFHLEdBQUcsS0FBSyxDQUFDO0lBQ3JCLENBQUM7SUFFTSxRQUFRO1FBQ1gsdURBQXVEO1FBQ3ZELElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFDLEdBQUcsQ0FBQztJQUMxQixDQUFDO0lBRU0sZUFBZTtRQUNsQixJQUFJLENBQUMsS0FBSyxHQUFHLElBQUksQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLFdBQVcsSUFBSSxFQUFFLENBQUM7SUFDakUsQ0FBQzs7Z0lBbkNRLG1DQUFtQztvSEFBbkMsbUNBQW1DOzJGQUFuQyxtQ0FBbUM7a0JBSC9DLFNBQVM7bUJBQUM7b0JBQ1AsUUFBUSxFQUFFLDhCQUE4QjtpQkFDM0M7aUdBT21CLE9BQU87c0JBQXRCLEtBQUs7Z0JBS1UsTUFBTTtzQkFBckIsS0FBSztnQkFhSywwQkFBMEI7c0JBRHBDLEtBQUsiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQge0FmdGVyVmlld0luaXQsIERpcmVjdGl2ZSwgRWxlbWVudFJlZiwgSW5wdXQsIE9uSW5pdH0gZnJvbSAnQGFuZ3VsYXIvY29yZSc7XG5cbkBEaXJlY3RpdmUoe1xuICAgIHNlbGVjdG9yOiAnW25hdHVyYWxDb2x1bW5zUGlja2VyQ29sdW1uXScsXG59KVxuZXhwb3J0IGNsYXNzIE5hdHVyYWxDb2x1bW5zUGlja2VyQ29sdW1uRGlyZWN0aXZlIGltcGxlbWVudHMgQWZ0ZXJWaWV3SW5pdCwgT25Jbml0IHtcbiAgICBwdWJsaWMga2V5ITogc3RyaW5nO1xuXG4gICAgLyoqXG4gICAgICogSW5pdGlhbCBjaGVja2VkIHN0YXRlXG4gICAgICovXG4gICAgQElucHV0KCkgcHVibGljIGNoZWNrZWQgPSB0cnVlO1xuXG4gICAgLyoqXG4gICAgICogSW5pdGlhbCB2aXNpYmlsaXR5IHN0YXRlXG4gICAgICovXG4gICAgQElucHV0KCkgcHVibGljIGhpZGRlbiA9IGZhbHNlO1xuXG4gICAgLyoqXG4gICAgICogTG9jYWxpemVkIGxhYmVsIG9mIGNvbHVtbiwgaWYgYWJzZW50IGRlZmF1bHQgdG8ga2V5XG4gICAgICovXG4gICAgcHVibGljIGxhYmVsID0gJyc7XG5cbiAgICBwdWJsaWMgY29uc3RydWN0b3IocHJpdmF0ZSByZWFkb25seSBlbGVtZW50UmVmOiBFbGVtZW50UmVmPEhUTUxFbGVtZW50Pikge31cblxuICAgIC8qKlxuICAgICAqIFRoaXMgbXVzdCBiZSB0aGUgY29sdW1uIGtleSBhcyBkZWZpbmVkIGluIG1hdENvbHVtbkRlZlxuICAgICAqL1xuICAgIEBJbnB1dCgpXG4gICAgcHVibGljIHNldCBuYXR1cmFsQ29sdW1uc1BpY2tlckNvbHVtbih2YWx1ZTogc3RyaW5nKSB7XG4gICAgICAgIHRoaXMua2V5ID0gdmFsdWU7XG4gICAgfVxuXG4gICAgcHVibGljIG5nT25Jbml0KCk6IHZvaWQge1xuICAgICAgICAvLyBEZWZhdWx0IGxhYmVsIHRvIGtleSBiZWZvcmUgcmVhbCBsYWJlbCBpcyBhY2Nlc3NpYmxlXG4gICAgICAgIHRoaXMubGFiZWwgPSB0aGlzLmtleTtcbiAgICB9XG5cbiAgICBwdWJsaWMgbmdBZnRlclZpZXdJbml0KCk6IHZvaWQge1xuICAgICAgICB0aGlzLmxhYmVsID0gdGhpcy5lbGVtZW50UmVmLm5hdGl2ZUVsZW1lbnQudGV4dENvbnRlbnQgPz8gJyc7XG4gICAgfVxufVxuIl19

package/lib/modules/columns-picker/columns-picker-column.directive.d.ts

@@ -1,27 +0,0 @@
-import { AfterViewInit, ElementRef, OnInit } from '@angular/core';
-import * as i0 from "@angular/core";
-export declare class NaturalColumnsPickerColumnDirective implements AfterViewInit, OnInit {
-    private readonly elementRef;
-    key: string;
-    /**
-     * Initial checked state
-     */
-    checked: boolean;
-    /**
-     * Initial visibility state
-     */
-    hidden: boolean;
-    /**
-     * Localized label of column, if absent default to key
-     */
-    label: string;
-    constructor(elementRef: ElementRef<HTMLElement>);
-    /**
-     * This must be the column key as defined in matColumnDef
-     */
-    set naturalColumnsPickerColumn(value: string);
-    ngOnInit(): void;
-    ngAfterViewInit(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NaturalColumnsPickerColumnDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NaturalColumnsPickerColumnDirective, "[naturalColumnsPickerColumn]", never, { "checked": "checked"; "hidden": "hidden"; "naturalColumnsPickerColumn": "naturalColumnsPickerColumn"; }, {}, never, never, false, never>;
-}