nuxeo-development-framework 5.2.7 → 5.2.9

package/lib/components/tables/ndf-table/filters-panel/models/aggregation-field-config.d.ts

@@ -1,7 +1,7 @@
-import { BaseFiledConfig } from './base-field-config';
+import { BaseFieldConfig } from './base-field-config';
 import { AutocompleteOptions, CheckboxOptions, CustomOptions, DateListOptions, DropdownOptions, RadioOptions, SwitchOptions } from './field-options';
 import { FieldSendModeType, Prettify } from './types-helper';
-export declare type AggregationFieldConfig = Prettify<BaseFiledConfig & {
+export declare type AggregationFieldConfig = Prettify<BaseFieldConfig & {
     aggregation: string;
     propertyPath?: string;
     bindLabel?: {
@@ -9,8 +9,8 @@ export declare type AggregationFieldConfig = Prettify<BaseFiledConfig & {
         en: string;
     };
     bindValue?: string;
-    dataTransformer?: 'documentTypee' | 'format' | 'subject' | 'site' | 'store' | 'system' | string;
-    sendMode?: FieldSendModeType;
+    dataTransformer?: string;
+    sendMode: FieldSendModeType;
     tooltip?: AggregationTooltipType;
     render: CheckboxOptions | SwitchOptions | RadioOptions | DropdownOptions | AutocompleteOptions | CustomOptions | DateListOptions;
 }>;

package/lib/components/tables/ndf-table/filters-panel/models/base-field-config.d.ts

@@ -1,5 +1,5 @@
 import { ComparisonOperator, TranslateKey } from './types-helper';
-export declare type BaseFiledConfig = {
+export declare type BaseFieldConfig = {
     label: TranslateKey;
     fieldKey: string;
     values?: unknown;

package/lib/components/tables/ndf-table/filters-panel/models/custom-field-config.d.ts

@@ -1,7 +1,7 @@
 import { FieldSendModeType, Prettify } from './types-helper';
-import { BaseFiledConfig } from './base-field-config';
+import { BaseFieldConfig } from './base-field-config';
 import { ActiveUserSwitcherOptions } from './field-options/custom-fields-options';
-export declare type CustomFieldConfig = Prettify<BaseFiledConfig & {
-    sendMode?: Exclude<FieldSendModeType, 'custom'>;
+export declare type CustomFieldConfig = Prettify<BaseFieldConfig & {
+    sendMode: Exclude<FieldSendModeType, 'custom'>;
     render: ActiveUserSwitcherOptions;
 }>;

package/lib/components/tables/ndf-table/filters-panel/models/field-options/autocomplete-options.d.ts

@@ -1,6 +1,13 @@
-import { Prettify } from "../types-helper";
+import { Prettify } from '../types-helper';
 import { HideLabel, ShowTotalConfig } from './common-utils';
+/**
+ * Configuration options for an autocomplete field.
+ */
 export declare type AutocompleteOptions = {
     type: 'autocomplete';
+    /**
+     * Additional options for the autocomplete field, combining
+     * `ShowTotalConfig` and `HideLabel` properties.
+     */
     options?: Prettify<ShowTotalConfig & HideLabel>;
 };

package/lib/components/tables/ndf-table/filters-panel/models/field-options/checkbox-options.d.ts

@@ -1,6 +1,14 @@
-import { Prettify } from "../types-helper";
+import { Prettify } from '../types-helper';
 import { CollapseConfig, FilterConfig, HideLabel, SearchConfig, ShowTotalConfig, SortOptions } from './common-utils';
+/**
+ * Configuration options for a checkbox field.
+ */
 export declare type CheckboxOptions = {
     type: 'checkbox';
+    /**
+     * Additional options for the checkbox field, combining
+     * `ShowTotalConfig`, `FilterConfig`, `CollapseConfig`,
+     * `SearchConfig`, `HideLabel`, and `SortOptions` properties.
+     */
     options?: Prettify<ShowTotalConfig & FilterConfig & CollapseConfig & SearchConfig & HideLabel & SortOptions>;
 };

package/lib/components/tables/ndf-table/filters-panel/models/field-options/common-utils.d.ts

@@ -1,24 +1,55 @@
 import { ComparisonOperator, EvaluatedString, StringOrNumber } from '../types-helper';
-export declare type FilterConfig = {
-    filter?: boolean;
-};
-export declare type HideLabel = {
-    hideLabel?: boolean;
-};
+/**
+ * Configuration for search functionality.
+ */
 export declare type SearchConfig = {
     search?: {
+        /**
+         * Placeholder text for the search input.
+         */
         placeholder?: string;
+        /**
+         * Query configuration for the search.
+         */
         query: {
+            /**
+             * The field to be queried.
+             */
             field?: string;
+            /**
+             * HTTP method to use for the query.
+             * Can be either 'get' or 'post'.
+             */
             method?: 'get' | 'post';
+            /**
+             * The URL endpoint for the query.
+             */
             url: string;
+            /**
+             * Operator to use for comparison in the query.
+             */
             operator?: ComparisonOperator;
+            /**
+             * Template string for dynamic query generation.
+             */
             template?: EvaluatedString;
+            /**
+             * Query parameters as key-value pairs.
+             */
             params?: Record<StringOrNumber, StringOrNumber>;
+            /**
+             * HTTP headers as key-value pairs.
+             */
             headers?: Record<StringOrNumber, StringOrNumber>;
         };
     };
 };
+export declare type FilterConfig = {
+    filter?: boolean;
+};
+export declare type HideLabel = {
+    hideLabel?: boolean;
+};
 export declare type CollapseConfig = {
     collapse?: boolean;
     minVisibleCount?: number;

package/lib/components/tables/ndf-table/filters-panel/models/field-options/input-options.d.ts

@@ -1,7 +1,11 @@
 import { KeyValue } from '@angular/common';
 import { MatDialogConfig } from '@angular/material/dialog';
-import { Prettify } from '../types-helper';
+import { Prettify, TranslateKey } from '../types-helper';
 import { HideLabel } from './common-utils';
+/**
+ * Represents the configuration options for an input field.
+ *
+ */
 export declare type InputOptions = {
     type: 'input';
     options?: Prettify<HideLabel & {
@@ -26,13 +30,21 @@ export declare type InputOptions = {
             text?: string;
             dropdown?: {
                 selectedValue?: string;
-                items: KeyValue<string, string>[];
+                items: KeyValue<TranslateKey, string>[];
             };
             tooltip?: string;
             dialog?: HtmlDialogConfig;
         };
     }>;
 };
+/**
+ * Represents the configuration for an HTML dialog.
+ *
+ * @typedef {Object} HtmlDialogConfig
+ * @property {Array<string>} content - The content of the dialog.
+ * @property {string} [title] - The title of the dialog.
+ * @property {Partial<MatDialogConfig>} [options] - Additional configuration options for the dialog.
+ */
 export declare type HtmlDialogConfig = {
     content: string[];
     title?: string;

package/lib/components/tables/ndf-table/filters-panel/models/predicate-field-config.d.ts

@@ -1,7 +1,7 @@
-import { BaseFiledConfig } from './base-field-config';
+import { BaseFieldConfig } from './base-field-config';
 import { DateInputOptions, InputOptions } from './field-options';
 import { FieldSendModeType, Prettify } from './types-helper';
-export declare type PredicateFieldConfig = Prettify<BaseFiledConfig & {
-    sendMode?: Exclude<FieldSendModeType, 'custom'>;
+export declare type PredicateFieldConfig = Prettify<BaseFieldConfig & {
+    sendMode: Exclude<FieldSendModeType, 'custom'>;
     render: InputOptions | DateInputOptions;
 }>;

package/lib/components/tables/ndf-table/models/table-config.d.ts

@@ -1,43 +1,80 @@
 import { TableColumnAction, TableColumnConfig } from './table-column';
 import { NdfTableOptions } from './table-options';
 import { TableDefaultSortModel, TablePaginationOptions, TableSortingArray, TableSortOptions, TableTab } from './types';
+/**
+ * Configuration type for the NDF Table component.
+ * Extends `TablePaginationOptions` and provides additional properties
+ * for customizing table behavior, appearance, and data handling.
+ */
 export declare type NdfTableConfig = TablePaginationOptions & {
+    /** Indicates if the data is provided directly instead of being fetched. */
     isDataProvided?: boolean;
+    /** Options for configuring the table. */
     options?: NdfTableOptions;
+    /** Enables horizontal scrollbar if set to true. */
     scrollbarH?: boolean;
+    /** Defines the column mode: 'flex', 'fixed', or 'force'. */
     columnMode?: 'flex' | 'fixed' | 'force';
+    /** The page provider identifier for fetching data. */
     pageProvider: string;
+    /** A mapping of field names to their corresponding values. */
     fields: Record<string, string>;
+    /** Custom URL configuration for fetching data. */
     customUrl?: {
         url: string;
         method: 'POST' | 'GET';
         payload?: Record<string, any>;
         predicateKey?: string;
     };
+    /** Quick filter identifier for the table. */
     quickFilters?: string;
+    /** Configuration for table columns. */
     columns: TableColumnConfig[];
+    /** List of column identifiers with dynamic visibility. */
     columnsWithDynamicVisibiltiy?: string[];
+    /** List of column identifiers with dynamic display. */
     columnsWithDynamicDisplay?: string[];
+    /** List of filter identifiers with dynamic display. */
     filtersWithDynamicDisplay?: string[];
+    /** Configuration for responsive columns. */
     responsiveColumns?: TableColumnConfig[];
+    /** Specifies the full width of the table. */
     fullWidth?: string;
+    /** Prefix for table-related identifiers. */
     prefix?: string;
+    /** Sorting options for the table. */
     sortingBy?: TableSortOptions;
+    /** Default sorting configuration for the table. */
     defaultSort?: TableDefaultSortModel;
+    /** Custom headers for table requests. */
     headers?: Record<string, any>;
+    /** Query parameters for table requests. */
     queryParam?: Record<string, any>;
+    /** Actions available for table columns. */
     tableActions?: TableColumnAction[];
+    /** Highlights the selected card if set to true. */
     highlightSelectedCard?: boolean;
+    /** Tabs configuration for the table. */
     tabs?: TableTab[];
+    /** Array of sorting configurations. */
     sortingArray?: TableSortingArray[];
+    /** Determines when to skip aggregation: 'never' or 'onPageChange'. */
     skipAggregation?: 'never' | 'onPageChange';
+    /** Range configuration for the table. */
     range?: any;
+    /** Indicates if the table is used on a search page. */
     isSearchPage?: any;
+    /** Enables multi-select rows if set to true. */
     multiSelectRows?: boolean;
+    /** Adds a custom first row to the table if set to true. */
     customFirstRow?: boolean;
+    /** Displays actions as a menu if set to true. */
     showActionsAsMenu?: boolean;
+    /** Additional filter parameters for the table. */
     filterParams?: Record<string, any>;
+    /** Format configuration for the table. */
     format?: string;
+    /** Available page sizes for the table. */
     pageSizes?: {
         label: string;
         size: number;

package/lib/components/tables/ndf-table/models/table-mode.d.ts

@@ -1,4 +1,4 @@
-import { Prettify } from '../filters-panel';
+import { Prettify, TranslateKey } from '../filters-panel';
 declare type BaseTableModel = {
     toggleMode?: boolean;
     availableMode?: TableModeList;
@@ -12,7 +12,7 @@ declare type CustomTableMode = Prettify<BaseTableModel & {
 }>;
 export declare type TableViewMode = 'dynamicCard' | 'list' | 'card' | 'custom';
 export declare type TableToggleItem = {
-    key?: string;
+    key?: TranslateKey;
     value: TableViewMode;
     icon: string;
 };

package/lib/components/tables/ndf-table/models/types.d.ts

@@ -1,3 +1,4 @@
+import { TranslateKey } from '../filters-panel';
 export declare type TablePaginationOptions = {
     pageNumber: number;
     pageSize: number;
@@ -27,7 +28,7 @@ export declare type TableTab = {
     pageProvider: string;
 };
 export declare type SortTableItem = {
-    key: string;
+    key: TranslateKey;
     value: string;
     direction: 'asc' | 'desc';
     selected?: boolean;

package/lib/shared/models/index.d.ts

@@ -1,4 +1,3 @@
 export * from './mapper/index';
 export * from './nuxeo-response.model';
 export * from './task.model';
-export * from './types-helper';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxeo-development-framework",
-  "version": "5.2.7",
+  "version": "5.2.9",
   "peerDependencies": {
     "@angular/animations": "12.2.3",
     "@angular/common": "12.2.3",

package/esm2015/lib/shared/models/types-helper.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMtaGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vLi4vcHJvamVjdHMvbnV4ZW8tZGV2ZWxvcG1lbnQtZnJhbWV3b3JrL3NyYy9saWIvc2hhcmVkL21vZGVscy90eXBlcy1oZWxwZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB0eXBlIFRyYW5zbGF0ZWRLZXkgPSBzdHJpbmc7XHJcbiJdfQ==

package/lib/shared/models/types-helper.d.ts

@@ -1 +0,0 @@
-export declare type TranslatedKey = string;