@genesislcap/foundation-entity-management 14.461.2 → 14.461.3-alpha-5a8ece015.0

package/dist/custom-elements.json

@@ -89,41 +89,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/components.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "loadRemotes"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "loadRemotes",
-          "declaration": {
-            "name": "loadRemotes",
-            "module": "src/components/components.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./components"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/entities/entities.styles.ts",
@@ -342,6 +307,24 @@
               "description": "Notification config used for submit failures. Defaults to an error snackbar but can be\noverridden while keeping title/body unchanged.",
               "privacy": "public"
             },
+            {
+              "kind": "field",
+              "name": "successNotificationTitle",
+              "type": {
+                "text": "string"
+              },
+              "description": "Overrides the success notification title shown after a successful form submission.\nWhen not set, the default \"{label} Added / Updated / Deleted\" title is used.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "successNotificationBody",
+              "type": {
+                "text": "string"
+              },
+              "description": "Overrides the success notification body shown after a successful form submission.\nWhen not set, the default \"The {label} was successfully added/updated/deleted\" body is used.",
+              "privacy": "public"
+            },
             {
               "kind": "field",
               "name": "title",
@@ -360,6 +343,15 @@
               "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications",
               "privacy": "public"
             },
+            {
+              "kind": "field",
+              "name": "createLabel",
+              "type": {
+                "text": "string"
+              },
+              "description": "Custom label for the create button and modal title. When set, overrides the default \"Add {entityLabel}\" text.",
+              "privacy": "public"
+            },
             {
               "kind": "field",
               "name": "rowSelection",
@@ -990,6 +982,22 @@
               "description": "Name of the event handler on the Genesis server which handles creating an entity",
               "fieldName": "createEvent"
             },
+            {
+              "name": "success-notification-title",
+              "type": {
+                "text": "string"
+              },
+              "description": "Overrides the success notification title shown after a successful form submission.\nWhen not set, the default \"{label} Added / Updated / Deleted\" title is used.",
+              "fieldName": "successNotificationTitle"
+            },
+            {
+              "name": "success-notification-body",
+              "type": {
+                "text": "string"
+              },
+              "description": "Overrides the success notification body shown after a successful form submission.\nWhen not set, the default \"The {label} was successfully added/updated/deleted\" body is used.",
+              "fieldName": "successNotificationBody"
+            },
             {
               "name": "title",
               "type": {
@@ -1006,6 +1014,14 @@
               "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications",
               "fieldName": "entityLabel"
             },
+            {
+              "name": "create-label",
+              "type": {
+                "text": "string"
+              },
+              "description": "Custom label for the create button and modal title. When set, overrides the default \"Add {entityLabel}\" text.",
+              "fieldName": "createLabel"
+            },
             {
               "name": "row-selection",
               "type": {
@@ -1307,22 +1323,109 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "The Smart Form Modal element. Allows to open a modal with an auto-generated form based\non the resource schema.",
+          "description": "A focused form dialog component that renders a single trigger button which opens a modal\ncontaining an auto-generated form.",
           "name": "SmartFormModal",
+          "cssParts": [
+            {
+              "description": "The trigger button that opens the modal. Style via `::part(create-button)`.",
+              "name": "create-button"
+            }
+          ],
           "members": [
             {
               "kind": "field",
-              "name": "gridVisible",
+              "name": "event",
               "type": {
-                "text": "boolean"
+                "text": "string"
               },
-              "default": "false",
-              "description": "Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid\n* @internal",
+              "description": "The Genesis event handler that processes the form submission.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "eventChanged",
+              "parameters": [
+                {
+                  "name": "_",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "next",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "entityLabel",
+              "type": {
+                "text": "string"
+              },
+              "description": "Label appended to the default button text, producing \"Add {entity-label}\".",
+              "privacy": "public",
               "inheritedFrom": {
                 "name": "EntityManagement",
                 "module": "src/entities/entities.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "formUiSchema",
+              "type": {
+                "text": "UiSchema"
+              },
+              "description": "UI schema that controls the layout and visibility of form fields.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "formUiSchemaChanged",
+              "parameters": [
+                {
+                  "name": "_",
+                  "type": {
+                    "text": "UiSchema"
+                  }
+                },
+                {
+                  "name": "next",
+                  "type": {
+                    "text": "UiSchema"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "buttonLabel",
+              "type": {
+                "text": "string"
+              },
+              "description": "Text displayed on the trigger button and as the modal title.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "buttonLabelChanged",
+              "parameters": [
+                {
+                  "name": "_",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "next",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
             {
               "kind": "field",
               "name": "prefix",
@@ -1440,6 +1543,32 @@
                 "module": "src/entities/entities.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "successNotificationTitle",
+              "type": {
+                "text": "string"
+              },
+              "description": "Overrides the success notification title shown after a successful form submission.\nWhen not set, the default \"{label} Added / Updated / Deleted\" title is used.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "successNotificationBody",
+              "type": {
+                "text": "string"
+              },
+              "description": "Overrides the success notification body shown after a successful form submission.\nWhen not set, the default \"The {label} was successfully added/updated/deleted\" body is used.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "title",
@@ -1455,11 +1584,11 @@
             },
             {
               "kind": "field",
-              "name": "entityLabel",
+              "name": "createLabel",
               "type": {
                 "text": "string"
               },
-              "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications",
+              "description": "Custom label for the create button and modal title. When set, overrides the default \"Add {entityLabel}\" text.",
               "privacy": "public",
               "inheritedFrom": {
                 "name": "EntityManagement",
@@ -1850,6 +1979,19 @@
                 "module": "src/entities/entities.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "gridVisible",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "true",
+              "description": "Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid\n* @internal",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "enableFilters",
@@ -2203,13 +2345,129 @@
               }
             }
           ],
-          "superclass": {
-            "name": "EntityManagement",
-            "module": "/src/entities/entities"
-          },
-          "tagName": "smart-form-modal",
-          "customElement": true,
+          "events": [
+            {
+              "description": "Fired when the form is submitted successfully.",
+              "name": "submit-success",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when the form submission returns an error.",
+              "name": "submit-failure",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when the request is changed",
+              "name": "request-changed",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when the criteria is changed",
+              "name": "criteria-changed",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when an entity is created",
+              "name": "create-entity",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when an entity is edited",
+              "name": "edit-entity",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when an entity is deleted Bubbled events from the child entity-list component",
+              "name": "delete-entity",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when a row is clicked",
+              "name": "rowClick",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when a row is double clicked",
+              "name": "rowDblClick",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when a row is right clicked",
+              "name": "contextMenu",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when a row is selected",
+              "name": "rowSelected",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "description": "Fired when grid selection changes (bubbled from entity-list)",
+              "name": "selectionChanged",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            }
+          ],
           "attributes": [
+            {
+              "name": "event",
+              "type": {
+                "text": "string"
+              },
+              "description": "The Genesis event handler that processes the form submission.",
+              "fieldName": "event"
+            },
+            {
+              "name": "entity-label",
+              "type": {
+                "text": "string"
+              },
+              "description": "Label appended to the default button text, producing \"Add {entity-label}\".",
+              "fieldName": "entityLabel"
+            },
+            {
+              "name": "button-label",
+              "type": {
+                "text": "string"
+              },
+              "description": "Text displayed on the trigger button and as the modal title.",
+              "fieldName": "buttonLabel"
+            },
             {
               "name": "design-system-prefix",
               "type": {
@@ -2283,6 +2541,30 @@
                 "module": "src/entities/entities.ts"
               }
             },
+            {
+              "name": "success-notification-title",
+              "type": {
+                "text": "string"
+              },
+              "description": "Overrides the success notification title shown after a successful form submission.\nWhen not set, the default \"{label} Added / Updated / Deleted\" title is used.",
+              "fieldName": "successNotificationTitle",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
+            {
+              "name": "success-notification-body",
+              "type": {
+                "text": "string"
+              },
+              "description": "Overrides the success notification body shown after a successful form submission.\nWhen not set, the default \"The {label} was successfully added/updated/deleted\" body is used.",
+              "fieldName": "successNotificationBody",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
             {
               "name": "title",
               "type": {
@@ -2307,6 +2589,18 @@
                 "module": "src/entities/entities.ts"
               }
             },
+            {
+              "name": "create-label",
+              "type": {
+                "text": "string"
+              },
+              "description": "Custom label for the create button and modal title. When set, overrides the default \"Add {entityLabel}\" text.",
+              "fieldName": "createLabel",
+              "inheritedFrom": {
+                "name": "EntityManagement",
+                "module": "src/entities/entities.ts"
+              }
+            },
             {
               "name": "row-selection",
               "type": {
@@ -2622,104 +2916,12 @@
               }
             }
           ],
-          "events": [
-            {
-              "description": "Fired when the request is changed",
-              "name": "request-changed",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when the criteria is changed",
-              "name": "criteria-changed",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when an entity is created",
-              "name": "create-entity",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when an entity is edited",
-              "name": "edit-entity",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when an entity is deleted Bubbled events from the child entity-list component",
-              "name": "delete-entity",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when there is an error in a create, edit or delete operation",
-              "name": "submit-failure",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when a create, edit or delete operation is completed successfully",
-              "name": "submit-success",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when a row is clicked",
-              "name": "rowClick",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when a row is double clicked",
-              "name": "rowDblClick",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when a row is right clicked",
-              "name": "contextMenu",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when a row is selected",
-              "name": "rowSelected",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            },
-            {
-              "description": "Fired when grid selection changes (bubbled from entity-list)",
-              "name": "selectionChanged",
-              "inheritedFrom": {
-                "name": "EntityManagement",
-                "module": "src/entities/entities.ts"
-              }
-            }
-          ]
+          "superclass": {
+            "name": "EntityManagement",
+            "module": "/src/entities/entities"
+          },
+          "tagName": "smart-form-modal",
+          "customElement": true
         }
       ],
       "exports": [
@@ -2743,41 +2945,27 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/layouts/default.ts",
+      "path": "src/components/components.ts",
       "declarations": [
         {
-          "kind": "variable",
-          "name": "loginLayout",
-          "default": "new GenesisElementLayout(\n  html`\n    <div class=\"container\">\n      <div class=\"content\">\n        <slot></slot>\n      </div>\n    </div>\n  `,\n  baseLayoutCss,\n)"
-        },
-        {
-          "kind": "variable",
-          "name": "defaultLayout",
-          "default": "new GenesisElementLayout(\n  html`\n    <div class=\"container\">\n      <div class=\"content\">\n        <slot></slot>\n      </div>\n    </div>\n  `,\n  css`\n    ${baseLayoutCss}\n  `,\n)"
+          "kind": "function",
+          "name": "loadRemotes"
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "loginLayout",
-          "declaration": {
-            "name": "loginLayout",
-            "module": "src/layouts/default.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "defaultLayout",
+          "name": "loadRemotes",
           "declaration": {
-            "name": "defaultLayout",
-            "module": "src/layouts/default.ts"
+            "name": "loadRemotes",
+            "module": "src/components/components.ts"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/layouts/index.ts",
+      "path": "src/components/index.ts",
       "declarations": [],
       "exports": [
         {
@@ -2785,7 +2973,7 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./default"
+            "package": "./components"
           }
         }
       ]
@@ -3707,6 +3895,55 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/layouts/default.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "loginLayout",
+          "default": "new GenesisElementLayout(\n  html`\n    <div class=\"container\">\n      <div class=\"content\">\n        <slot></slot>\n      </div>\n    </div>\n  `,\n  baseLayoutCss,\n)"
+        },
+        {
+          "kind": "variable",
+          "name": "defaultLayout",
+          "default": "new GenesisElementLayout(\n  html`\n    <div class=\"container\">\n      <div class=\"content\">\n        <slot></slot>\n      </div>\n    </div>\n  `,\n  css`\n    ${baseLayoutCss}\n  `,\n)"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "loginLayout",
+          "declaration": {
+            "name": "loginLayout",
+            "module": "src/layouts/default.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "defaultLayout",
+          "declaration": {
+            "name": "defaultLayout",
+            "module": "src/layouts/default.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/layouts/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./default"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/routes/config.ts",