@eqproject/eqp-dynamic-module 1.1.8 → 2.0.0

package/README.md

@@ -19,25 +19,133 @@ Componente che visualizza la form dinamica.
 Input
 | Input | Descrizione |
 | ----- | ----------- |
-| context: Context | Contesto |
-| form: Form | oggetto form da visualizzare |
-| values: Array<Record> | Valori da visualizzare |
-| showButtons = true | Mostra i bottoni |
-| showTitle = true | Mostra il titolo |
-| baseServerUrl: string | Url del server da chiamare per recuperare, salvare o eliminare i record |
-| userToken: string | Token utente |
-| endPointConfiguration: EndPointConfiguration | Configurazione degli endpoint da chiamare per recuperare o salvare i dati. Può essere definita dall'utente oppure lasciata null, viene popolata con dei valori di default se viene valorizzata la proprietà "baseServerUrl" altrimenti viene lasciata null e non viene eseguita nessuna chiamata al server. |
-
-Note:
-- se non viene fornita una configurazione degli EndPoint si utilizza la configurazione standard
-
-
-
-
+| DynamicModuleConfig | an object that is a configurations container. It holds 4 objects: dynamicModuleGeneralConfig, dynamicModuleCompileConfig, dynamicModuleListConfig, dynamicModuleRepairConfig |
 
 ### eqp-dynamic-module-configurator
 Componente che permette la configurazione delle form dinamiche
+| Input | Descrizione |
+| ----- | ----------- |
+| DynamicModuleConfiguratorConfig | an object that is a configurations container. It holds 2 objects: dynamicModuleGeneralConfig, DynamicModuleConfiguratorSpecificConfig |
+
+## Models used
+
+### DynamicModuleConfiguratorConfig
+| Property | Type | Description | Examples | 
+| ------------- | ------------- | ------------- | ------------- |
+| dynamicModuleGeneralConfig | dynamicModuleGeneralConfig | contiene le informazioni generali comuni per la visualizzazione |
+| DynamicModuleConfiguratorSpecificConfig | dynamicModuleGeneralConfig | contiene le informazioni generali comuni per la visualizzazione |
+
+### DynamicModuleConfig
+| Property | Type | Description | Examples | 
+| ------------- | ------------- | ------------- | ------------- |
+| dynamicModuleGeneralConfig | dynamicModuleGeneralConfig | contiene le informazioni generali comuni per la visualizzazione |
+| dynamicModuleCompileConfig | dynamicModuleCompileConfig | contiene le informazioni specifiche per la visualizzazione della risposta |
+| dynamicModuleListConfig | dynamicModuleListConfig | contiene le informazioni specifiche per la visualizzazione della lista di risposte |
+| dynamicModuleRepairConfig | dynamicModuleRepairConfig | contiene le configurazioni specifiche per la modalità repair |
+
+
+### DynamicModuleConfiguratorSpecificConfig | contiene le informazioni generali comuni per la visualizzazione
+| Property | Type | Description | Examples | 
+| ------------- | ------------- | ------------- | ------------- |
+| form | Form | 
+| orgaID | string | 
+| UserID | number | 
+| innerFormManagment | boolean | 
+| innerFormRef | MatDialogRef<TemplateRef<any>> |
+
+### dynamicModuleGeneralConfig | contiene le informazioni generali comuni per la visualizzazione
+| Property | Type | Description | Examples | 
+| ------------- | ------------- | ------------- | ------------- |
+| baseServerUrl | string | server Url to call for API | "http://localhost:5015/api"
+| userToken | string | Token dell'utente |
+| endPointConfiguration | EndPointConfiguration | Configurazione degli endpoint da chiamare per recuperare o salvare i dati. Può essere definita dall'utente oppure lasciata null, viene popolata con dei valori di default se viene valorizzata la proprietà "baseServerUrl" altrimenti viene lasciata null e non viene eseguita nessuna chiamata al server. |
+| context | Context | Contesto |
+| formID | Form | la guID del form da visualizzare |
+| starterViewMode | DynamicMoDuleViewModeEnum | se impostato a true mostra i pulsanti di salva e annulla |
+
+Note:
+- starterViewMode è attualmente utilizzato solo da DynamicModuleConfig
+- se non viene fornita una configurazione degli EndPoint si utilizza la configurazione standard
 
+### dynamicModuleCompileConfig | contiene le informazioni specifiche per la visualizzazione della risposta
+| Property | Type | Description | Examples |
+| ------------- | ------------- | ------------- | ------------- |
+| showTitle | boolean | Show/Hide module name in COMPILE |
+| userMode | boolean | Show/Hide the buttons for "save" and "back" |
+| showSaveButton | boolean | Show/Hide form save button when userMode is true |
+| userID | string | Set user id for save |
+
+### dynamicModuleListConfig    | contiene le informazioni specifiche per la visualizzazione della lista di risposte
+| Property | Type | Description | Examples |
+| ------------- | ------------- | ------------- | ------------- |
+| showTitle | boolean | Show/Hide module name in LIST |
+| defaultListActions | listFormRecordActionsDefault | Lista delle azioni di default da mostrare per visualizzare/modificare/duplicare/eliminare in LIST MODE |
+| values | Array<Record> |Lista dei record da mostrare in LIST MODE |
+
+### dynamicModuleRepairConfig  | contiene le configurazioni specifiche per la modalità repair
+| Property | Type | Description | Examples |
+| ------------- | ------------- | ------------- | ------------- |
+| FormJSON | string | stringa rappresentante il json del form da revisionare in REPAIR MODE |
+
+
+
+
+### EndPointConfiguration
+
+example
+```js
+export class EndPointConfiguration {
+    Records: {
+        GetByFormIDEndPoint?: EndPointData;
+        GetAllByEntAndUserIDEndPoint?: EndPointData;
+        GetByIDEndPoint?: EndPointData;
+        SaveEndPoint?: EndPointData;
+        DuplicateEndPoint?: EndPointData;
+        DeleteEndPoint?: EndPointData;
+        RepairEndPoint?: EndPointData;
+    };
+    Forms: {
+        GetByIDEndPoint: EndPointData;
+        GetByIDAndVersionEndPoint: EndPointData;
+        SaveEndPoint: EndPointData;
+    }
+}
+```
+
+### EndPointData
+export class EndPointData {
+    Url: string;
+    Token?: string;
+    RequestMethod: RequestMethodEnum;
+    Params?: EndPointDataParams[];
+}
+
+### EndPointDataParams
+export class EndPointDataParams {
+    ParamName: string;
+    ParamValue: any = null;
+    ParamType: ParamTypeEnum;
+}
+
+### ParamTypeEnum
+```js
+export enum ParamTypeEnum {
+    "Query param" = 1,
+    "In route" = 2,
+    "In Body" = 3
+}
+```
+
+### RequestMethodEnum
+
+```js
+export enum RequestMethodEnum {
+    GET = 'GET',
+    POST = 'POST',
+    PUT = 'PUT',
+    DELETE = 'DELETE'
+}
+```
 
 ### Componenti privati