nuxeo-development-framework 5.3.6 → 5.3.7

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

@@ -1,7 +1,5 @@
 ---
-ModifiedDate: 2025-05-07 
-CreatedDate: 2025-05-06 
----
+ 
 
 # `NdfTableConfig` 
 Configuration type for the NDF Table component. Extends `TablePaginationOptions` and provides additional properties  for customizing table behavior, appearance, and data handling.
@@ -122,7 +120,7 @@ type HtmlDialogConfig = {
 | `options` | `Partial<MatDialogConfig>` | ❌        | Optional Angular Material dialog configuration overrides.               |
 
 ### Examples
- 
+
 
 ```yaml
 // Real-Time Search with Help Dialog
@@ -162,7 +160,7 @@ type HtmlDialogConfig = {
 
 ```
 
- 
+
  
 ---
 ---
@@ -514,7 +512,7 @@ type FieldConfigModel =
 | `roles`      | `string[]`                      | ❌        |               | List of roles required to view/use the field.                         |
 | `permission` | `string`                        | ❌        |               | Specific permission required to access the field.                     |
 
-### Predicate Field Config
+## Predicate Field Config
 
   ```ts
 type PredicateFieldConfig =
@@ -569,7 +567,7 @@ type PredicateFieldConfig =
 ---
 ---
 
-### Aggregation Field Config
+## Aggregation Field Config
 
 ```ts
 type AggregationFieldConfig = BaseFieldConfig & {
@@ -580,6 +578,7 @@ type AggregationFieldConfig = BaseFieldConfig & {
   dataTransformer?:  string;
   sendMode: FieldSendModeType;
   tooltip?: AggregationTooltipType;
+  condition?:EvaluatedString;
   render:
    | CheckboxOptions
    | SwitchOptions
@@ -593,17 +592,17 @@ type AggregationFieldConfig = BaseFieldConfig & {
 
 #### Property Descriptions
 
-| Property          | Type                                                                                                                             | Required | Description                                                                                              |
-|-------------------|----------------------------------------------------------------------------------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------|
-| `aggregation`     | `string`                                                                                                                         | ✅        | The name of the aggregation                                                                              |
-| `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.                                |
-| `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.                                  |
-| `render`          | `CheckboxOptions \| SwitchOptions \| RadioOptions \| DropdownOptions \| AutocompleteOptions \| CustomOptions \| DateListOptions` | ✅        | Specifies how the field will be rendered in the UI.                                                      |
-|                   |                                                                                                                                  |          |                                                                                                          |
+| Property          | Type                                                                                                                             | Required | Description                                                                                                                                                |
+| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `aggregation`     | `string`                                                                                                                         | ✅        | The name of the aggregation                                                                                                                                |
+| `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.                                                                                  |
+| `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`       | `EvaluatedString`                                                                                                                | ❌        | Assign a `boolean` value (`true` or `false`) to the `show` variable based on a custom condition using the provided `language`, `user`, and `aggregations`. |
+| `render`          | `CheckboxOptions \| SwitchOptions \| RadioOptions \| DropdownOptions \| AutocompleteOptions \| CustomOptions \| DateListOptions` | ✅        | Specifies how the field will be rendered in the UI.                                                                                                        |
 #### Example
 
 ```ts
@@ -627,7 +626,7 @@ type AggregationFieldConfig = BaseFieldConfig & {
 ```
 
 
-#### Aggregation Tooltip  
+#### Aggregation Tooltip
 **Type**: `AggregationTooltipType`
 
 ```ts
@@ -745,6 +744,50 @@ type TooltipTranslatedDate = {
 ---
 ---
 
+## Custom Field Config
+
+
+```ts
+ CustomFieldConfig = Prettify<  
+  BaseFieldConfig & {  
+   sendMode: Exclude<FieldSendModeType, 'custom'>;  
+   render: {type:string , options?: Record<string,any>};  
+  }  
+>;
+```
+
+The `CustomFieldConfig` type is used to define a custom field within a form configuration system. It extends the base field configuration (`BaseFieldConfig`) and introduces specific constraints and rendering behavior for custom fields.
+
+Properties
+
+| Property         | Type                                   | Description                                                                                                |
+| ---------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `sendMode`       | `Exclude<FieldSendModeType, 'custom'>` | Defines how the field data is sent. All modes except `'custom'` are allowed.                               |
+| `render.type`    | `string`                               | Identifier for the custom component to be used for rendering the field. Must match a registered component. |
+| `render.options` | `Record<string, any>` _(optional)_     | Optional configuration object passed to the custom component to control its behavior or appearance.        |
+
+Example
+
+```json
+{
+  "key": "customSlider",
+  "label": "Adjust Volume",
+  "sendMode": "onChange",
+  "render": {
+    "type": "sliderComponent",
+    "options": {
+      "min": 0,
+      "max": 100,
+      "step": 5
+    }
+  }
+}
+
+```
+
+
+---
+---
 
 
 
@@ -827,7 +870,7 @@ type InputOptions = {
 | `tooltip`  | `string`                                                                | Tooltip shown on hover.                                            |
 | `dialog`   | `HtmlDialogConfig`                                                      | Adds a supplementary dialog for user guidance or advanced options. |
 
-*Example* 
+*Example*
 
 ```yaml
 [
@@ -880,7 +923,7 @@ type InputOptions = {
 ```
 
 
- 
+
 #### *Date Input*
 
 ```ts
@@ -952,6 +995,7 @@ export type DateInputOptions = {
 ---
 
 ## Aggregation Field Render
+
 - **Type**: `CheckboxOptions` | `SwitchOptions`  | `RadioOptions`  | `DropdownOptions`  | `AutocompleteOptions`  | `CustomOptions`  | `DateListOptions`
 - **Description**: Defines the rendering configuration for an aggregation field. The render type determines how users interact with the filter or input—for example, as checkboxes, a dropdown, or a custom UI.
 
@@ -1114,26 +1158,52 @@ type CustomOptions = {
 | `type`    | `'custom'`                        | ✅        | Custom input component.                           |
 | `options` | `Record<string, any> & HideLabel` | ❌        | Arbitrary config props with optional `hideLabel`. |
 
+> [!note] NOTE
+>  This field type is designed to be used with a registered component in a host such as **`ndf-table`**, and expects a **custom content template** using `<ng-template>`.
+
+
+Here is an example template that will receive contextual variables from the table:
+
+```html
+<ndf-table>
+
+	<ng-template
+	  filterCustomTemplate
+	  let-options="options"
+	  let-field="field"
+	  let-value="value"
+	  let-aggregation="aggregation"
+	  let-updateValue="updateValue">	
+	  
+	   {{value}}
+	
+	  <button (click)="updateValue(updated value)">updateValue</button>
+	</ng-template>
+
+</ndf-table>
+
+```
+
 
 
 ---
 ---
 
 ## Custom Field Render
-- **Type**: `ActiveUserSwitcherOptions` 
+- **Type**: `ActiveUserSwitcherOptions`
 - **Description**: Defines the rendering configuration for a custom field.
 
 ###  Supported Types
 #### *Active user options*
 ```ts
-type ActiveUserSwitcherOptions = {  
-  type: 'activeUser';  
-  options?: Prettify<  
-   HideLabel & {  
-    bindValue?: string;  
-    text?: string;  
-   }  
-  >;  
+type ActiveUserSwitcherOptions = {
+  type: 'activeUser';
+  options?: Prettify<
+    HideLabel & {
+    bindValue?: string;
+    text?: string;
+  }
+  >;
 }
 ```
 
@@ -1173,7 +1243,7 @@ type MultipleConfig = { multiple?: boolean };
 type ShowTotalConfig = { showTotal?: boolean };
 
 type SortOptions = { sort?: boolean };
- 
+
 type SearchConfig = {
 
     search?: {
@@ -1207,8 +1277,8 @@ type SearchConfig = {
 
 ```ts
 type LabelValue<L, V> = {
-	label: L;
-	value: V;
+  label: L;
+  value: V;
 };
 ```
 
@@ -1216,11 +1286,11 @@ type LabelValue<L, V> = {
 
 ```ts
 type NdfRequestConfig = {
-	method: 'post' | 'get';
-	url: string;
-	payload?: Record<string, any>;
-	params?: Record<string, any>;
-	headers?: Record<string, any>;
+  method: 'post' | 'get';
+  url: string;
+  payload?: Record<string, any>;
+  params?: Record<string, any>;
+  headers?: Record<string, any>;
 };
 ```
 
@@ -1228,8 +1298,8 @@ type NdfRequestConfig = {
 
 ```ts
 type TableSortConfig = {
-	enabled: boolean;
-	frozenColumns?: string[];  // Specifies which columns should remain fixed (frozen) during column ordering
+  enabled: boolean;
+  frozenColumns?: string[];  // Specifies which columns should remain fixed (frozen) during column ordering
 };
 ```
 
@@ -1251,181 +1321,181 @@ type TranslateKey = string
 
 ```json
  {
-			"options": {
-				"columns": {
-					"toggle": true,
-					"sortable": {
-						"enabled": true
-					}
-				},
-				"filters": {
-					"mode": "payload",
-					"reload": {
-						"strategy": "always"
-					},
-					"panel": {
-						"visible": true,
-						"toggleButton": true
-					},
-					"fields": [
-						{
-							"type": "aggregation",
-							"config": {
-								"label": "rmAdvancedSearch.recDefintionSystemName",
-								"aggregation": "RecordDefinition_systemName_agg",
-								"fieldKey": "recdef:systemName",
-								"dataTransformer": "system",
-								"order": 0,
-								"sendMode": "queryParam",
-								"render": {
-									"type": "checkbox",
-									"options": {
-										"showTotal": true
-									}
-								}
-							}
-						},
-						{
-							"type": "predicate",
-							"config": {
-								"label": "FILTERS.gdocDocumentSubject",
-								"fieldKey": "gdoc:documentSubject",
-								"sendMode": "payload",
-								"valueType": "valueObject",
-								"render": {
-									"type": "input",
-									"options": {
-										"debounceTime": 400,
-										"mask": {
-											"mask": "00-00-00-00-000",
-											"dropSpecialCharacters": false,
-											"showMaskTyped": true
-										},
-										"suffix": {
-											"dropdown": {
-												"items": [
-													{
-														"key": "OPERATORS.equals",
-														"value": "="
-													},
-													{
-														"key": "OPERATORS.notEquals",
-														"value": "!="
-													},
-													{
-														"key": "OPERATORS.like",
-														"value": "LIKE"
-													},
-													{
-														"key": "OPERATORS.iLike",
-														"value": "ILIKE"
-													}
-												]
-											}
-										}
-									}
-								}
-							}
-						},
-						{
-							"type": "aggregation",
-							"config": {
-								"label": "rmAdvancedSearch.gdocGDocumentDate",
-								"aggregation": "generaldocument_gDocumentDate_agg",
-								"fieldKey": "gdoc:gDocumentDate",
-								"prefix": "search.buckets.",
-								"sendMode": "custom",
-								"valueType": "valueObject",
-								"render": {
-									"type": "dateList",
-									"view": "list",
-									"options": {
-										"showTotal": true,
-										"minMax": true
-									}
-								}
-							}
-						}
-					]
-				},
-				"search": {
-					"fieldKey": "ecm:fulltext",
-					"searchMode": "triggered",
-					"suffix": {
-						"dialog": {
-							"title": "INFO.dialogTitle",
-							"content": [
-								"##INFO.query_sequence##",
-								"##INFO.query_and##",
-								"##INFO.query_negation##",
-								"##INFO.query_prefix##",
-								"##INFO.query_historical##",
-								"##INFO.query_or##",
-								"##INFO.query_phrase##"
-							]
-						}
-					}
-				},
-				"tableMode": {
-					"mode": "list",
-					"componentName": "rms.components.advancedSearchCard",
-					"toggleMode": true,
-					"availableMode": [
-						{
-							"value": "list",
-							"icon": "table_rows"
-						},
-						{
-							"value": "custom",
-							"icon": "rectangle"
-						}
-					]
-				}
-			},
-			"scrollbarH": true,
-			"pageNumber": 1,
-			"pageSize": 10,
-			"prefix": "LISTING.",
-			"pageProvider": "PP_RM_Record",
-			"customUrl": {
-				"url": "/api/v1/custom-search/pp/PP_RM_Record/execute",
-				"method": "POST"
-			},
-			"headers": {
-				"properties": "dublincore, file"
-			},
-			"quickFilters": "After Archiving",
-			"fields": {
-				"systemName": "recdef:systemName",
-				"title": "dc:title"
-			},
-			"columns": [
-				{
-					"name": "systemName",
-					"prop": "properties.systemName",
-					"display": true,
-					"type": "custom",
-					"template": "common.components.systemName",
-					"translatePrefix": "search.buckets",
-					"isOrginalKey": true,
-					"sortable": false,
-					"headerClass": "recdef:systemName",
-					"defaultVisible": true,
-					"minWidth": 150
-				},
-				{
-					"name": "physicalOriginal",
-					"prop": "properties.physicalOriginal",
-					"display": true,
-					"type": "custom",
-					"template": "rms.components.TranslatedValueColumn",
-					"translatePrefix": "rmDocumentUpload.hasPhysicalOriginal",
-					"isBooleanValue": true,
-					"sortable": false,
-					"headerClass": "recdef:physicalOriginal",
-					"defaultVisible": false,
-					"minWidth": 150
-				}
-			]
-		}
+  "options": {
+    "columns": {
+      "toggle": true,
+      "sortable": {
+        "enabled": true
+      }
+    },
+    "filters": {
+      "mode": "payload",
+      "reload": {
+        "strategy": "always"
+      },
+      "panel": {
+        "visible": true,
+        "toggleButton": true
+      },
+      "fields": [
+        {
+          "type": "aggregation",
+          "config": {
+            "label": "rmAdvancedSearch.recDefintionSystemName",
+            "aggregation": "RecordDefinition_systemName_agg",
+            "fieldKey": "recdef:systemName",
+            "dataTransformer": "system",
+            "order": 0,
+            "sendMode": "queryParam",
+            "render": {
+              "type": "checkbox",
+              "options": {
+                "showTotal": true
+              }
+            }
+          }
+        },
+        {
+          "type": "predicate",
+          "config": {
+            "label": "FILTERS.gdocDocumentSubject",
+            "fieldKey": "gdoc:documentSubject",
+            "sendMode": "payload",
+            "valueType": "valueObject",
+            "render": {
+              "type": "input",
+              "options": {
+                "debounceTime": 400,
+                "mask": {
+                  "mask": "00-00-00-00-000",
+                  "dropSpecialCharacters": false,
+                  "showMaskTyped": true
+                },
+                "suffix": {
+                  "dropdown": {
+                    "items": [
+                      {
+                        "key": "OPERATORS.equals",
+                        "value": "="
+                      },
+                      {
+                        "key": "OPERATORS.notEquals",
+                        "value": "!="
+                      },
+                      {
+                        "key": "OPERATORS.like",
+                        "value": "LIKE"
+                      },
+                      {
+                        "key": "OPERATORS.iLike",
+                        "value": "ILIKE"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        {
+          "type": "aggregation",
+          "config": {
+            "label": "rmAdvancedSearch.gdocGDocumentDate",
+            "aggregation": "generaldocument_gDocumentDate_agg",
+            "fieldKey": "gdoc:gDocumentDate",
+            "prefix": "search.buckets.",
+            "sendMode": "custom",
+            "valueType": "valueObject",
+            "render": {
+              "type": "dateList",
+              "view": "list",
+              "options": {
+                "showTotal": true,
+                "minMax": true
+              }
+            }
+          }
+        }
+      ]
+    },
+    "search": {
+      "fieldKey": "ecm:fulltext",
+      "searchMode": "triggered",
+      "suffix": {
+        "dialog": {
+          "title": "INFO.dialogTitle",
+          "content": [
+            "##INFO.query_sequence##",
+            "##INFO.query_and##",
+            "##INFO.query_negation##",
+            "##INFO.query_prefix##",
+            "##INFO.query_historical##",
+            "##INFO.query_or##",
+            "##INFO.query_phrase##"
+          ]
+        }
+      }
+    },
+    "tableMode": {
+      "mode": "list",
+      "componentName": "rms.components.advancedSearchCard",
+      "toggleMode": true,
+      "availableMode": [
+        {
+          "value": "list",
+          "icon": "table_rows"
+        },
+        {
+          "value": "custom",
+          "icon": "rectangle"
+        }
+      ]
+    }
+  },
+  "scrollbarH": true,
+  "pageNumber": 1,
+  "pageSize": 10,
+  "prefix": "LISTING.",
+  "pageProvider": "PP_RM_Record",
+  "customUrl": {
+    "url": "/api/v1/custom-search/pp/PP_RM_Record/execute",
+    "method": "POST"
+  },
+  "headers": {
+    "properties": "dublincore, file"
+  },
+  "quickFilters": "After Archiving",
+  "fields": {
+    "systemName": "recdef:systemName",
+    "title": "dc:title"
+  },
+  "columns": [
+    {
+      "name": "systemName",
+      "prop": "properties.systemName",
+      "display": true,
+      "type": "custom",
+      "template": "common.components.systemName",
+      "translatePrefix": "search.buckets",
+      "isOrginalKey": true,
+      "sortable": false,
+      "headerClass": "recdef:systemName",
+      "defaultVisible": true,
+      "minWidth": 150
+    },
+    {
+      "name": "physicalOriginal",
+      "prop": "properties.physicalOriginal",
+      "display": true,
+      "type": "custom",
+      "template": "rms.components.TranslatedValueColumn",
+      "translatePrefix": "rmDocumentUpload.hasPhysicalOriginal",
+      "isBooleanValue": true,
+      "sortable": false,
+      "headerClass": "recdef:physicalOriginal",
+      "defaultVisible": false,
+      "minWidth": 150
+    }
+  ]
+}
 ```