@genesislcap/foundation-entity-management 11.3.0

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.4"
+    }
+  ]
+}

package/docs/.gitattributes

@@ -0,0 +1,2 @@
+*.md -diff
+*.md linguist-generated

package/docs/api/foundation-entity-management.datasourceconfiguration.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md)
+
+## DatasourceConfiguration type
+
+The attribute which is set to configure the resource that the entity manager is working with
+
+**Signature:**
+
+```typescript
+export type DatasourceConfiguration = Omit<DatasourceOptions, 'resourceName' | 'request'>;
+```
+
+## Example
+
+
+```javascript
+type DatasourceConfiguration = {
+  criteria?: string;
+  fields?: string;
+  isSnapshot?: boolean;
+  maxRows?: number;
+  maxView?: number;
+  orderBy?: string;
+  reverse?: boolean;
+}
+```
+

package/docs/api/foundation-entity-management.entitymanagement.closemodal.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [closeModal](./foundation-entity-management.entitymanagement.closemodal.md)
+
+## EntityManagement.closeModal() method
+
+**Signature:**
+
+```typescript
+closeModal(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-entity-management.entitymanagement.columns.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [columns](./foundation-entity-management.entitymanagement.columns.md)
+
+## EntityManagement.columns property
+
+Array which holds the column definitions.
+
+**Signature:**
+
+```typescript
+columns: ColDef[];
+```

package/docs/api/foundation-entity-management.entitymanagement.connect.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [connect](./foundation-entity-management.entitymanagement.connect.md)
+
+## EntityManagement.connect property
+
+DI connect object which is used to interact with the backend.
+
+**Signature:**
+
+```typescript
+protected connect: Connect;
+```
+
+## Remarks
+
+Requires  to be registered with the DI container
+

package/docs/api/foundation-entity-management.entitymanagement.createevent.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [createEvent](./foundation-entity-management.entitymanagement.createevent.md)
+
+## EntityManagement.createEvent property
+
+Name of the event handler on the Genesis server which handles creating an entity
+
+**Signature:**
+
+```typescript
+createEvent: string;
+```

package/docs/api/foundation-entity-management.entitymanagement.createformuischema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [createFormUiSchema](./foundation-entity-management.entitymanagement.createformuischema.md)
+
+## EntityManagement.createFormUiSchema property
+
+**Signature:**
+
+```typescript
+createFormUiSchema: any;
+```

package/docs/api/foundation-entity-management.entitymanagement.datasourceconfig.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [datasourceConfig](./foundation-entity-management.entitymanagement.datasourceconfig.md)
+
+## EntityManagement.datasourceConfig property
+
+The configuration which is used when interacting with the resource on the backend
+
+**Signature:**
+
+```typescript
+datasourceConfig: DatasourceConfiguration;
+```
+
+## Remarks
+
+Handles the configuration such as how many rows of entities to fetch at a time
+

package/docs/api/foundation-entity-management.entitymanagement.deepclone.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [deepClone](./foundation-entity-management.entitymanagement.deepclone.md)
+
+## EntityManagement.deepClone() method
+
+Override the deepClone method to ensure that observable attributes are cloned
+
+**Signature:**
+
+```typescript
+deepClone(): Node;
+```
+**Returns:**
+
+Node
+

package/docs/api/foundation-entity-management.entitymanagement.deleteevent.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [deleteEvent](./foundation-entity-management.entitymanagement.deleteevent.md)
+
+## EntityManagement.deleteEvent property
+
+Name of the event handler on the Genesis server which handles deleting the entity
+
+**Signature:**
+
+```typescript
+deleteEvent: string;
+```

package/docs/api/foundation-entity-management.entitymanagement.editdialogtitle.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [editDialogTitle](./foundation-entity-management.entitymanagement.editdialogtitle.md)
+
+## EntityManagement.editDialogTitle property
+
+String which contains the text of the popup modal when the user is adding or editing an entity
+
+**Signature:**
+
+```typescript
+editDialogTitle: string;
+```

package/docs/api/foundation-entity-management.entitymanagement.editedentity.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [editedEntity](./foundation-entity-management.entitymanagement.editedentity.md)
+
+## EntityManagement.editedEntity property
+
+Disables the form while enabled to stop the user dispatching a large number of duplicate events
+
+**Signature:**
+
+```typescript
+editedEntity: any;
+```

package/docs/api/foundation-entity-management.entitymanagement.editentitymodal.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [editEntityModal](./foundation-entity-management.entitymanagement.editentitymodal.md)
+
+## EntityManagement.editEntityModal property
+
+**Signature:**
+
+```typescript
+editEntityModal: any;
+```

package/docs/api/foundation-entity-management.entitymanagement.editmodalvisible.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [editModalVisible](./foundation-entity-management.entitymanagement.editmodalvisible.md)
+
+## EntityManagement.editModalVisible property
+
+**Signature:**
+
+```typescript
+editModalVisible: boolean;
+```

package/docs/api/foundation-entity-management.entitymanagement.editmodalvisiblechanged.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [editModalVisibleChanged](./foundation-entity-management.entitymanagement.editmodalvisiblechanged.md)
+
+## EntityManagement.editModalVisibleChanged() method
+
+**Signature:**
+
+```typescript
+editModalVisibleChanged(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-entity-management.entitymanagement.enablecellflashing.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [enableCellFlashing](./foundation-entity-management.entitymanagement.enablecellflashing.md)
+
+## EntityManagement.enableCellFlashing property
+
+**Signature:**
+
+```typescript
+enableCellFlashing: boolean;
+```

package/docs/api/foundation-entity-management.entitymanagement.enablefilterbar.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [enableFilterBar](./foundation-entity-management.entitymanagement.enablefilterbar.md)
+
+## EntityManagement.enableFilterBar property
+
+**Signature:**
+
+```typescript
+enableFilterBar: boolean;
+```

package/docs/api/foundation-entity-management.entitymanagement.entitylabel.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [entityLabel](./foundation-entity-management.entitymanagement.entitylabel.md)
+
+## EntityManagement.entityLabel property
+
+Label for the entity which has usages such as being shown in the title of the modal wen editing the entity
+
+**Signature:**
+
+```typescript
+entityLabel: string;
+```

package/docs/api/foundation-entity-management.entitymanagement.errornotify.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [errorNotify](./foundation-entity-management.entitymanagement.errornotify.md)
+
+## EntityManagement.errorNotify() method
+
+Show notifications if the executed event returned an error.
+
+**Signature:**
+
+```typescript
+errorNotify(request: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  request | any |  |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-entity-management.entitymanagement.formuischema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [formUiSchema](./foundation-entity-management.entitymanagement.formuischema.md)
+
+## EntityManagement.formUiSchema property
+
+**Signature:**
+
+```typescript
+formUiSchema: any;
+```

package/docs/api/foundation-entity-management.entitymanagement.md

@@ -0,0 +1,74 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md)
+
+## EntityManagement class
+
+Main class which defines the entity management functionality
+
+**Signature:**
+
+```typescript
+export declare class EntityManagement extends EntityManagement_base 
+```
+**Extends:** EntityManagement\_base
+
+## Remarks
+
+Connects to a backend resource and wraps up a grid which is populated with entities from that resource. The different interactions that the user can perform with the entities can be configured, examples being able to update and delete entities.
+
+## Example
+
+Example of using the entity management system to handle counterparties
+
+```
+<entity-management
+  resourceName="ALL_COUNTERPARTYS"
+  title="Counterparty Management"
+  updateEvent="EVENT_COUNTERPARTY_MODIFY"
+  deleteEvent="EVENT_COUNTERPARTY_DELETE"
+  createEvent="EVENT_COUNTERPARTY_INSERT"
+></entity-management>
+```
+Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the name of the resource in the database to manage is `ALL_COUNTERPARTYS`<br /> - the name of the event handler for update events is `EVENT_COUNTERPARTY_MODIFY`<br /> - the name of the event handler for create events is `EVENT_COUNTERPARTY_INSERT`<br /> - the name of the event handler for delete events is `EVENT_COUNTERPARTY_DELETE`<br />
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [columns](./foundation-entity-management.entitymanagement.columns.md) |  | ColDef\[\] | Array which holds the column definitions. |
+|  [connect](./foundation-entity-management.entitymanagement.connect.md) | <code>protected</code> | Connect | DI connect object which is used to interact with the backend. |
+|  [createEvent](./foundation-entity-management.entitymanagement.createevent.md) |  | string | Name of the event handler on the Genesis server which handles creating an entity |
+|  [createFormUiSchema](./foundation-entity-management.entitymanagement.createformuischema.md) |  | any |  |
+|  [datasourceConfig](./foundation-entity-management.entitymanagement.datasourceconfig.md) |  | [DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md) | The configuration which is used when interacting with the resource on the backend |
+|  [deleteEvent](./foundation-entity-management.entitymanagement.deleteevent.md) |  | string | Name of the event handler on the Genesis server which handles deleting the entity |
+|  [editDialogTitle](./foundation-entity-management.entitymanagement.editdialogtitle.md) |  | string | String which contains the text of the popup modal when the user is adding or editing an entity |
+|  [editedEntity](./foundation-entity-management.entitymanagement.editedentity.md) |  | any | Disables the form while enabled to stop the user dispatching a large number of duplicate events |
+|  [editEntityModal](./foundation-entity-management.entitymanagement.editentitymodal.md) |  | any |  |
+|  [editModalVisible](./foundation-entity-management.entitymanagement.editmodalvisible.md) |  | boolean |  |
+|  [enableCellFlashing](./foundation-entity-management.entitymanagement.enablecellflashing.md) |  | boolean |  |
+|  [enableFilterBar](./foundation-entity-management.entitymanagement.enablefilterbar.md) |  | boolean |  |
+|  [entityLabel](./foundation-entity-management.entitymanagement.entitylabel.md) |  | string | Label for the entity which has usages such as being shown in the title of the modal wen editing the entity |
+|  [formUiSchema](./foundation-entity-management.entitymanagement.formuischema.md) |  | any |  |
+|  [persistColumnStateKey](./foundation-entity-management.entitymanagement.persistcolumnstatekey.md) |  | string | This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it. |
+|  [readEvent](./foundation-entity-management.entitymanagement.readevent.md) |  | string |  |
+|  [readEventFn](./foundation-entity-management.entitymanagement.readeventfn.md) |  | (...args: any\[\]) =&gt; {} |  |
+|  [readonly](./foundation-entity-management.entitymanagement.readonly.md) |  | boolean |  |
+|  [resourceName](./foundation-entity-management.entitymanagement.resourcename.md) |  | string | Name of the backend resource which contain the entities to manage |
+|  [selectedEntity](./foundation-entity-management.entitymanagement.selectedentity.md) |  | any | Reference to the currently selected entity from the grid. |
+|  [sizeColumnsToFit](./foundation-entity-management.entitymanagement.sizecolumnstofit.md) |  | boolean |  |
+|  [submitting](./foundation-entity-management.entitymanagement.submitting.md) |  | boolean |  |
+|  [title](./foundation-entity-management.entitymanagement.title.md) |  | string | Title of the grid |
+|  [updateEvent](./foundation-entity-management.entitymanagement.updateevent.md) |  | string | Name of the event handler on the Genesis server which handles updating the entity |
+|  [updateFormUiSchema](./foundation-entity-management.entitymanagement.updateformuischema.md) |  | any |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [closeModal()](./foundation-entity-management.entitymanagement.closemodal.md) |  |  |
+|  [deepClone()](./foundation-entity-management.entitymanagement.deepclone.md) |  | Override the deepClone method to ensure that observable attributes are cloned |
+|  [editModalVisibleChanged()](./foundation-entity-management.entitymanagement.editmodalvisiblechanged.md) |  |  |
+|  [errorNotify(request)](./foundation-entity-management.entitymanagement.errornotify.md) |  | Show notifications if the executed event returned an error. |
+|  [submitEntityChanges(e)](./foundation-entity-management.entitymanagement.submitentitychanges.md) |  | Event handler for when the user submits the action for the currently open form, either editing or adding the entity |
+

package/docs/api/foundation-entity-management.entitymanagement.persistcolumnstatekey.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [persistColumnStateKey](./foundation-entity-management.entitymanagement.persistcolumnstatekey.md)
+
+## EntityManagement.persistColumnStateKey property
+
+This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.
+
+**Signature:**
+
+```typescript
+persistColumnStateKey: string;
+```
+
+## Remarks
+
+Setting this value will set the entity manager to persist the column states through page refreshes etc. An example of what is stored is when the user resizes or reorders columns. This value must be unique for each table in your app otherwise the persisted data will be corrupted. There is an option on the grid for the user to reset the table to the default layout if they wish. If you omit this attribute then nothing is persisted
+

package/docs/api/foundation-entity-management.entitymanagement.readevent.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [readEvent](./foundation-entity-management.entitymanagement.readevent.md)
+
+## EntityManagement.readEvent property
+
+**Signature:**
+
+```typescript
+readEvent: string;
+```

package/docs/api/foundation-entity-management.entitymanagement.readeventfn.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [readEventFn](./foundation-entity-management.entitymanagement.readeventfn.md)
+
+## EntityManagement.readEventFn property
+
+**Signature:**
+
+```typescript
+readEventFn: (...args: any[]) => {};
+```

package/docs/api/foundation-entity-management.entitymanagement.readonly.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [readonly](./foundation-entity-management.entitymanagement.readonly.md)
+
+## EntityManagement.readonly property
+
+**Signature:**
+
+```typescript
+readonly: boolean;
+```

package/docs/api/foundation-entity-management.entitymanagement.resourcename.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [resourceName](./foundation-entity-management.entitymanagement.resourcename.md)
+
+## EntityManagement.resourceName property
+
+Name of the backend resource which contain the entities to manage
+
+**Signature:**
+
+```typescript
+resourceName: string;
+```

package/docs/api/foundation-entity-management.entitymanagement.selectedentity.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [selectedEntity](./foundation-entity-management.entitymanagement.selectedentity.md)
+
+## EntityManagement.selectedEntity property
+
+Reference to the currently selected entity from the grid.
+
+**Signature:**
+
+```typescript
+selectedEntity: any;
+```
+
+## Remarks
+
+When the user attempts to initiate functionality such as deleting or editing an entity, the entity which will be deleted/edited is the one which is referenced by this variable
+

package/docs/api/foundation-entity-management.entitymanagement.sizecolumnstofit.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [sizeColumnsToFit](./foundation-entity-management.entitymanagement.sizecolumnstofit.md)
+
+## EntityManagement.sizeColumnsToFit property
+
+**Signature:**
+
+```typescript
+sizeColumnsToFit: boolean;
+```

package/docs/api/foundation-entity-management.entitymanagement.submitentitychanges.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [submitEntityChanges](./foundation-entity-management.entitymanagement.submitentitychanges.md)
+
+## EntityManagement.submitEntityChanges() method
+
+Event handler for when the user submits the action for the currently open form, either editing or adding the entity
+
+**Signature:**
+
+```typescript
+submitEntityChanges(e: CustomEvent): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  e | CustomEvent | <p>CustomEvent which contains the payload for the entity to submit to the backend</p><p>Emits an event upon error</p> |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-entity-management.entitymanagement.submitting.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [submitting](./foundation-entity-management.entitymanagement.submitting.md)
+
+## EntityManagement.submitting property
+
+**Signature:**
+
+```typescript
+submitting: boolean;
+```

package/docs/api/foundation-entity-management.entitymanagement.title.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [title](./foundation-entity-management.entitymanagement.title.md)
+
+## EntityManagement.title property
+
+Title of the grid
+
+**Signature:**
+
+```typescript
+title: string;
+```

package/docs/api/foundation-entity-management.entitymanagement.updateevent.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [updateEvent](./foundation-entity-management.entitymanagement.updateevent.md)
+
+## EntityManagement.updateEvent property
+
+Name of the event handler on the Genesis server which handles updating the entity
+
+**Signature:**
+
+```typescript
+updateEvent: string;
+```

package/docs/api/foundation-entity-management.entitymanagement.updateformuischema.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [EntityManagement](./foundation-entity-management.entitymanagement.md) &gt; [updateFormUiSchema](./foundation-entity-management.entitymanagement.updateformuischema.md)
+
+## EntityManagement.updateFormUiSchema property
+
+**Signature:**
+
+```typescript
+updateFormUiSchema: any;
+```

package/docs/api/foundation-entity-management.geterrorformat.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md) &gt; [getErrorFormat](./foundation-entity-management.geterrorformat.md)
+
+## getErrorFormat variable
+
+Format the error as a string with a different format depending on whether `err` has a `FIELD` property or not
+
+**Signature:**
+
+```typescript
+getErrorFormat: (err: any) => string
+```

package/docs/api/foundation-entity-management.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-entity-management](./foundation-entity-management.md)
+
+## foundation-entity-management package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [EntityManagement](./foundation-entity-management.entitymanagement.md) | Main class which defines the entity management functionality |
+|  [Profiles](./foundation-entity-management.profiles.md) | Main class which defined the profile management functionality |
+|  [Users](./foundation-entity-management.users.md) | Main class which defines the user management functionality |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [getErrorFormat](./foundation-entity-management.geterrorformat.md) | Format the error as a string with a different format depending on whether <code>err</code> has a <code>FIELD</code> property or not |
+|  [UsersColumnConfig](./foundation-entity-management.userscolumnconfig.md) | Defines the default columns which are present on the user management component |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md) | The attribute which is set to configure the resource that the entity manager is working with |
+