nuxeo-development-framework 5.4.3 → 5.4.5

package/lib/components/reports/ndf-reports/services/reports-data-transformers.service.d.ts

@@ -0,0 +1,48 @@
+import { ApiResponseModel } from '../../../../core/models';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+export declare type ReportDataTransformer<TEntry extends Record<string, any> = Record<string, any>> = (data: ApiResponseModel<TEntry>) => Observable<ApiResponseModel<TEntry>>;
+export declare class ReportsDataTransformers<TEntry extends Record<string, any> = Record<string, any>> {
+    private readonly _transformations;
+    /**
+     * Registers one or multiple transformer functions.
+     *
+     * @param {Record<string, ReportDataTransformer> | string} keys - A record of key-function pairs or a single key.
+     * @param {ReportDataTransformer} [arg2] - A transformer function if registering a single key.
+     */
+    register(keys: Record<string, ReportDataTransformer<TEntry>>): void;
+    register(key: string, fn: ReportDataTransformer<TEntry>): void;
+    /**
+     * Retrieves a transformer function by its key.
+     *
+     * @param {string} key - The key of the transformer function.
+     * @returns {ReportDataTransformer | undefined} - The transformer function or undefined if not found.
+     */
+    get(key: string): ReportDataTransformer<TEntry> | undefined;
+    /**
+     * Retrieves all registered transformer functions.
+     *
+     * @returns {Map<string, ReportDataTransformer>} - A map of all transformer functions.
+     */
+    getAll(): Map<string, ReportDataTransformer<TEntry>>;
+    /**
+     * Clears all registered transformer functions.
+     */
+    clear(): void;
+    /**
+     * Checks if a transformer function is registered for a specific key.
+     *
+     * @param {string} key - The key to check.
+     * @returns {boolean} - True if the key exists, false otherwise.
+     */
+    has(key: string): boolean;
+    /**
+     * Removes a transformer function by its key.
+     *
+     * @param {string} key - The key of the transformer function to remove.
+     */
+    remove(key: string): void;
+    transform(key: string, data: ApiResponseModel<TEntry>): Observable<ApiResponseModel<TEntry>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ReportsDataTransformers<any>, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ReportsDataTransformers<any>>;
+}

package/lib/shared/evaluator/types.d.ts

@@ -13,4 +13,4 @@ export declare type TemplateSettings = {
     escape: RegExp;
 };
 export declare type InterpolateString = `${string}{{${string | number}}}${string}`;
-export declare type EvaluatedString<VAR extends string = string> = `${VAR}=${string | number}`;
+export declare type EvaluatedString<VAR extends string = string> = `${string}${VAR}=${string | number}${string}`;

package/package.json

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

package/src/docs/ndf-table.doc.md

@@ -1,6 +1,5 @@
 ---
  
-
 # `NdfTableConfig` 
 Configuration type for the NDF Table component. Extends `TablePaginationOptions` and provides additional properties  for customizing table behavior, appearance, and data handling.
 
@@ -578,7 +577,7 @@ type AggregationFieldConfig = BaseFieldConfig & {
   dataTransformer?:  string;
   sendMode: FieldSendModeType;
   tooltip?: AggregationTooltipType;
-  condition?:InterpolateString;
+  condition?:EvaluatedString;
   render:
    | CheckboxOptions
    | SwitchOptions
@@ -598,10 +597,10 @@ type AggregationFieldConfig = BaseFieldConfig & {
 | `propertyPath`    | `string`                                                                                                                         | ❌        | Path to the property used in aggregation (if different from `fieldKey`).                                                                                                                                                      |
 | `bindLabel`       | `{ ar: string; en: string }`                                                                                                     | ❌        | Property name to use as Label                                                                                                                                                                                                 |
 | `bindValue`       | `string`                                                                                                                         | ❌        | Property name to use as the value                                                                                                                                                                                             |
-| `dataTransformer` | `string`                                                                                                                         | ❌        | Optional name of a transformer function to apply on the aggregation data.                                                                                                                                                     |
+| `dataTransformer` | `string`                                                                                                                         | ❌        | Optional name of a transformer function to apply to the aggregation data. This function must be registered with the `NdfTransformService` in the core or app module.`                                                         |
 | `sendMode`        | `FieldSendModeType`                                                                                                              | ✅        | Defines how the selected value should be sent in the request (e.g., `payload`, `queryParam` , `custom`).                                                                                                                      |
 | `tooltip`         | `AggregationTooltipType`                                                                                                         | ❌        | Tooltip text or configuration to display additional info for the field.                                                                                                                                                       |
-| `condition`       | `InterpolateString`                                                                                                                | ❌        | Assign a `boolean` value (`true` or `false`) to the `show` variable based on a custom condition using the provided `language`, `user`, and `aggregations`, in order to determine whether the field should be shown or hidden. |
+| `condition`       | `EvaluatedString`                                                                                                                | ❌        | Assign a `boolean` value (`true` or `false`) to the `show` variable based on a custom condition using the provided `language`, `user`, and `aggregations`, in order to determine whether the field should be shown or hidden. |
 | `render`          | `CheckboxOptions \| SwitchOptions \| RadioOptions \| DropdownOptions \| AutocompleteOptions \| CustomOptions \| DateListOptions` | ✅        | Specifies how the field will be rendered in the UI.                                                                                                                                                                           |
 |                   |                                                                                                                                  |          |                                                                                                                                                                                                                               |
 #### Example
@@ -1255,7 +1254,7 @@ type SearchConfig = {
             method?: 'get' | 'post';
             url: string;
             operator?: ComparisonOperator;
-            template?: InterpolateString;
+            template?: EvaluatedString;
             params?: Record<StringOrNumber, StringOrNumber>;
             headers?: Record<StringOrNumber, StringOrNumber>;
         };