@genesislcap/foundation-entity-management 14.200.1-alpha-e974201.0 → 14.202.0

package/dist/foundation-entity-management.d.ts

@@ -27,6 +27,12 @@ import { Session } from '@genesislcap/foundation-comms';
 import { UiSchema } from '@genesislcap/foundation-forms';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+declare enum ActionsMenuStyle {
+    Default = "default",
+    ActionsVertical = "actions-vertical",
+    ActionsHorizontal = "actions-horizontal"
+}
+
 declare type AdditionalEntry = string | UiSchema | {
     type: 'Control';
     scope: string;
@@ -45,6 +51,14 @@ declare type AdditionalEntry = string | UiSchema | {
  */
 export declare const buttonCellRenderer: (title: any, clickHandler: any, contentTemplate: any) => ColDef;
 
+declare enum CrudMenuPosition {
+    Column = "column",
+    Top = "top",
+    Bottom = "bottom",
+    Action = "action",
+    None = "none"
+}
+
 /**
  * The attribute which is set to configure the resource that the entity manager is working with
  *
@@ -284,6 +298,44 @@ export declare class EntityManagement extends EntityManagement_base {
      * @public
      */
     modalPosition: 'centre' | 'left' | 'right';
+    /**
+     * Determines where the buttons will appear
+     * @public
+     */
+    crudMenuPosition: CrudMenuPosition;
+    /**
+     * Determines the style of the buttons
+     * @public
+     */
+    crudMenuStyle: ActionsMenuStyle;
+    /**
+     * The label of the crud action menu
+     */
+    crudActionMenuName: string;
+    /**
+     * The Id of the crud buttons wrapper element
+     */
+    crudMenuWrapper: any;
+    /**
+     * Determines whether the button edit should be hidden in the column
+     */
+    get shouldHideEditInColumn(): boolean;
+    /**
+     * Determines whether the button delete should be hidden in the column
+     */
+    get shouldHideDeleteInColumn(): boolean;
+    /**
+     * Determines whether there is a selected entity
+     */
+    get hasSelectedEntity(): boolean;
+    /**
+     * Checks if a slot contains any content.
+     *
+     * @param slotName - The name of the slot to check.
+     * @returns True if the slot has content, otherwise false.
+     * @public
+     */
+    hasContentInSlot(slotName: string): boolean;
     /**
      * Set up the web component
      * @internal
@@ -328,7 +380,7 @@ export declare class EntityManagement extends EntityManagement_base {
      * @param e - CustomEvent where `e.detail` is the entity to edit.
      * @internal
      */
-    private editEntity;
+    editEntity({ detail }: CustomEvent): Promise<void>;
     private readEntity;
     closeModal(): void;
     get headerTempalate(): ViewTemplate<EntityManagement, any>;
@@ -348,11 +400,27 @@ export declare class EntityManagement extends EntityManagement_base {
     deleteEntity(e: CustomEvent): Promise<void>;
     confirmDelete(): Promise<void>;
     private showDeleteConfirmation;
+    /**
+     * Emit the CRUD event for the selected entity
+     * @param action - the action to emit
+     */
+    emitCrud(action: 'create' | 'edit' | 'delete'): void;
     /**
      * Show notifications if the executed event returned an error.
      * @internal
      */
     errorNotify(request: any): void;
+    /**
+     * Clear the selected entity
+     * @internal
+     */
+    private clearSelectedEntity;
+    /**
+     * Helper to generate the CRUD actions menu
+     *
+     * @internal
+     */
+    private generateCrudActionsMenu;
 }
 
 declare const EntityManagement_base: (new (...args: any[]) => {
@@ -371,7 +439,11 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     readonly $fastController: Controller;
     $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
     disconnectedCallback(): void;
-    attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
+    attributeChangedCallback(name: string, oldValue: string, newValue: string): void; /**
+    * This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.
+    * @remarks Defaults to single
+    * @public
+    */
     accessKey: string;
     readonly accessKeyLabel: string;
     autocapitalize: string;
@@ -389,6 +461,10 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     outerText: string;
     spellcheck: boolean;
     title: string;
+    /**
+     * If true, will enable row flashing for all rows for `add` transactions
+     * @public
+     */
     translate: boolean;
     attachInternals(): ElementInternals;
     click(): void;
@@ -424,10 +500,7 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
     closest<E extends Element = Element>(selectors: string): E;
     getAttribute(qualifiedName: string): string;
-    getAttributeNS(namespace: string, localName: string): string; /**
-    * Array with renderers used by foundation-forms
-    * @public
-    */
+    getAttributeNS(namespace: string, localName: string): string;
     getAttributeNames(): string[];
     getAttributeNode(qualifiedName: string): Attr;
     getAttributeNodeNS(namespace: string, localName: string): Attr;
@@ -550,14 +623,6 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     ariaSetSize: string;
     ariaSort: string;
     ariaValueMax: string;
-    /**
-     * Event handler for when the user submits the action for the currently open form, either editing or adding the entity
-     *
-     * @param e - CustomEvent which contains the payload for the entity to submit to the backend
-     *
-     * Emits an event upon error
-     * @public
-     */
     ariaValueMin: string;
     ariaValueNow: string;
     ariaValueText: string;

package/docs/api/foundation-entity-management.entitymanagement.crudactionmenuname.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; [crudActionMenuName](./foundation-entity-management.entitymanagement.crudactionmenuname.md)
+
+## EntityManagement.crudActionMenuName property
+
+The label of the crud action menu
+
+**Signature:**
+
+```typescript
+crudActionMenuName: string;
+```

package/docs/api/foundation-entity-management.entitymanagement.crudmenuposition.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; [crudMenuPosition](./foundation-entity-management.entitymanagement.crudmenuposition.md)
+
+## EntityManagement.crudMenuPosition property
+
+Determines where the buttons will appear
+
+**Signature:**
+
+```typescript
+crudMenuPosition: CrudMenuPosition;
+```

package/docs/api/foundation-entity-management.entitymanagement.crudmenustyle.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; [crudMenuStyle](./foundation-entity-management.entitymanagement.crudmenustyle.md)
+
+## EntityManagement.crudMenuStyle property
+
+Determines the style of the buttons
+
+**Signature:**
+
+```typescript
+crudMenuStyle: ActionsMenuStyle;
+```

package/docs/api/foundation-entity-management.entitymanagement.crudmenuwrapper.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; [crudMenuWrapper](./foundation-entity-management.entitymanagement.crudmenuwrapper.md)
+
+## EntityManagement.crudMenuWrapper property
+
+The Id of the crud buttons wrapper element
+
+**Signature:**
+
+```typescript
+crudMenuWrapper: any;
+```

package/docs/api/foundation-entity-management.entitymanagement.emitcrud.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; [emitCrud](./foundation-entity-management.entitymanagement.emitcrud.md)
+
+## EntityManagement.emitCrud() method
+
+Emit the CRUD event for the selected entity
+
+**Signature:**
+
+```typescript
+emitCrud(action: 'create' | 'edit' | 'delete'): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  action | 'create' \| 'edit' \| 'delete' | the action to emit |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,26 @@
+<!-- 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; [hasContentInSlot](./foundation-entity-management.entitymanagement.hascontentinslot.md)
+
+## EntityManagement.hasContentInSlot() method
+
+Checks if a slot contains any content.
+
+**Signature:**
+
+```typescript
+hasContentInSlot(slotName: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  slotName | string | The name of the slot to check. |
+
+**Returns:**
+
+boolean
+
+True if the slot has content, otherwise false.
+

package/docs/api/foundation-entity-management.entitymanagement.hasselectedentity.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; [hasSelectedEntity](./foundation-entity-management.entitymanagement.hasselectedentity.md)
+
+## EntityManagement.hasSelectedEntity property
+
+Determines whether there is a selected entity
+
+**Signature:**
+
+```typescript
+get hasSelectedEntity(): boolean;
+```

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

@@ -43,6 +43,10 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
 |  [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) |  | UiSchema |  |
+|  [crudActionMenuName](./foundation-entity-management.entitymanagement.crudactionmenuname.md) |  | string | The label of the crud action menu |
+|  [crudMenuPosition](./foundation-entity-management.entitymanagement.crudmenuposition.md) |  | CrudMenuPosition | Determines where the buttons will appear |
+|  [crudMenuStyle](./foundation-entity-management.entitymanagement.crudmenustyle.md) |  | ActionsMenuStyle | Determines the style of the buttons |
+|  [crudMenuWrapper](./foundation-entity-management.entitymanagement.crudmenuwrapper.md) |  | any | The Id of the crud buttons wrapper element |
 |  [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 |
 |  [datasourceType](./foundation-entity-management.entitymanagement.datasourcetype.md) |  | DatasourceType | If set to 'server' it will enable Server-Side Row Model and use <code>grid-pro-server-side-datasource</code> for the grid of the <code>entity-list</code> sub-component. By default <code>grid-pro-client-side-datasource</code> will be used. |
 |  [defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md) |  | Record&lt;string, unknown&gt; | The default values to populate the form with when the user is adding an entity |
@@ -59,6 +63,7 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
 |  [formRenderers](./foundation-entity-management.entitymanagement.formrenderers.md) |  | RendererEntry\[\] | Array with renderers used by foundation-forms |
 |  [formUiSchema](./foundation-entity-management.entitymanagement.formuischema.md) |  | UiSchema |  |
 |  [gridOptions](./foundation-entity-management.entitymanagement.gridoptions.md) |  | GridOptions | GridOptions to be passed down from application |
+|  [hasSelectedEntity](./foundation-entity-management.entitymanagement.hasselectedentity.md) | <code>readonly</code> | boolean | Determines whether there is a selected entity |
 |  [headerCaseType](./foundation-entity-management.entitymanagement.headercasetype.md) |  | GridProCaseType | The case type to use for the header names. If not set, the default CONSTANT\_CASE will be used. |
 |  [headerTempalate](./foundation-entity-management.entitymanagement.headertempalate.md) | <code>readonly</code> | import("@microsoft/fast-element").ViewTemplate&lt;[EntityManagement](./foundation-entity-management.entitymanagement.md)<!-- -->, any&gt; |  |
 |  [hideDelete](./foundation-entity-management.entitymanagement.hidedelete.md) |  | boolean |  |
@@ -74,6 +79,8 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
 |  [rowSelection](./foundation-entity-management.entitymanagement.rowselection.md) |  | string | This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows. |
 |  [searchBarConfig](./foundation-entity-management.entitymanagement.searchbarconfig.md) |  | AvailableOption\[\] |  |
 |  [selectedEntity](./foundation-entity-management.entitymanagement.selectedentity.md) |  | Record&lt;string, unknown&gt; | Reference to the currently selected entity from the grid. |
+|  [shouldHideDeleteInColumn](./foundation-entity-management.entitymanagement.shouldhidedeleteincolumn.md) | <code>readonly</code> | boolean | Determines whether the button delete should be hidden in the column |
+|  [shouldHideEditInColumn](./foundation-entity-management.entitymanagement.shouldhideeditincolumn.md) | <code>readonly</code> | boolean | Determines whether the button edit should be hidden in the column |
 |  [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 |
@@ -90,6 +97,8 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
 |  [deepClone()](./foundation-entity-management.entitymanagement.deepclone.md) |  | Override the deepClone method to ensure that observable attributes are cloned |
 |  [disconnectedCallback()](./foundation-entity-management.entitymanagement.disconnectedcallback.md) |  |  |
 |  [editModalVisibleChanged()](./foundation-entity-management.entitymanagement.editmodalvisiblechanged.md) |  |  |
+|  [emitCrud(action)](./foundation-entity-management.entitymanagement.emitcrud.md) |  | Emit the CRUD event for the selected entity |
+|  [hasContentInSlot(slotName)](./foundation-entity-management.entitymanagement.hascontentinslot.md) |  | Checks if a slot contains any content. |
 |  [requestChanged(e)](./foundation-entity-management.entitymanagement.requestchanged.md) |  |  |
 |  [searchBarDataserver(options)](./foundation-entity-management.entitymanagement.searchbardataserver.md) |  |  |
 |  [searchBarReqServer(options)](./foundation-entity-management.entitymanagement.searchbarreqserver.md) |  |  |

package/docs/api/foundation-entity-management.entitymanagement.shouldhidedeleteincolumn.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; [shouldHideDeleteInColumn](./foundation-entity-management.entitymanagement.shouldhidedeleteincolumn.md)
+
+## EntityManagement.shouldHideDeleteInColumn property
+
+Determines whether the button delete should be hidden in the column
+
+**Signature:**
+
+```typescript
+get shouldHideDeleteInColumn(): boolean;
+```

package/docs/api/foundation-entity-management.entitymanagement.shouldhideeditincolumn.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; [shouldHideEditInColumn](./foundation-entity-management.entitymanagement.shouldhideeditincolumn.md)
+
+## EntityManagement.shouldHideEditInColumn property
+
+Determines whether the button edit should be hidden in the column
+
+**Signature:**
+
+```typescript
+get shouldHideEditInColumn(): boolean;
+```

package/docs/api-report.md

@@ -66,6 +66,12 @@ export class EntityManagement extends EntityManagement_base {
     createFormUiSchema: UiSchema;
     // (undocumented)
     criteriaChanged(e: CustomEvent<string>): void;
+    crudActionMenuName: string;
+    // Warning: (ae-forgotten-export) The symbol "CrudMenuPosition" needs to be exported by the entry point index.d.ts
+    crudMenuPosition: CrudMenuPosition;
+    // Warning: (ae-forgotten-export) The symbol "ActionsMenuStyle" needs to be exported by the entry point index.d.ts
+    crudMenuStyle: ActionsMenuStyle;
+    crudMenuWrapper: any;
     datasourceConfig: DatasourceConfiguration;
     datasourceType: DatasourceType_2;
     deepClone(): Node;
@@ -77,12 +83,15 @@ export class EntityManagement extends EntityManagement_base {
     disconnectedCallback(): Promise<void>;
     editDialogTitle: string;
     editedEntity: Record<string, unknown>;
+    // @internal
+    editEntity({ detail }: CustomEvent): Promise<void>;
     // (undocumented)
     editEntityModal: Modal;
     // (undocumented)
     editModalVisible: boolean;
     // (undocumented)
     editModalVisibleChanged(): void;
+    emitCrud(action: 'create' | 'edit' | 'delete'): void;
     enableCellFlashing: boolean;
     // (undocumented)
     enableFilterBar: boolean;
@@ -97,6 +106,8 @@ export class EntityManagement extends EntityManagement_base {
     // (undocumented)
     formUiSchema: UiSchema;
     gridOptions: GridOptions;
+    hasContentInSlot(slotName: string): boolean;
+    get hasSelectedEntity(): boolean;
     headerCaseType: GridProCaseType;
     // (undocumented)
     get headerTempalate(): ViewTemplate<EntityManagement, any>;
@@ -128,6 +139,8 @@ export class EntityManagement extends EntityManagement_base {
     // (undocumented)
     searchChanged(event: CustomEvent<Array<SelectedOption>>): void;
     selectedEntity: Record<string, unknown>;
+    get shouldHideDeleteInColumn(): boolean;
+    get shouldHideEditInColumn(): boolean;
     // (undocumented)
     sizeColumnsToFit: boolean;
     submitEntityChanges(e: CustomEvent): Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-entity-management",
   "description": "Genesis Foundation Entity Management",
-  "version": "14.200.1-alpha-e974201.0",
+  "version": "14.202.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -52,29 +52,29 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.200.1-alpha-e974201.0",
-    "@genesislcap/genx": "14.200.1-alpha-e974201.0",
-    "@genesislcap/rollup-builder": "14.200.1-alpha-e974201.0",
-    "@genesislcap/ts-builder": "14.200.1-alpha-e974201.0",
-    "@genesislcap/uvu-playwright-builder": "14.200.1-alpha-e974201.0",
-    "@genesislcap/vite-builder": "14.200.1-alpha-e974201.0",
-    "@genesislcap/webpack-builder": "14.200.1-alpha-e974201.0",
+    "@genesislcap/foundation-testing": "14.202.0",
+    "@genesislcap/genx": "14.202.0",
+    "@genesislcap/rollup-builder": "14.202.0",
+    "@genesislcap/ts-builder": "14.202.0",
+    "@genesislcap/uvu-playwright-builder": "14.202.0",
+    "@genesislcap/vite-builder": "14.202.0",
+    "@genesislcap/webpack-builder": "14.202.0",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@ag-grid-community/core": "32.0.0",
-    "@genesislcap/foundation-comms": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-errors": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-events": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-forms": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-logger": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-login": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-notifications": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-ui": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-utils": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-zero": "14.200.1-alpha-e974201.0",
-    "@genesislcap/foundation-zero-grid-pro": "14.200.1-alpha-e974201.0",
-    "@genesislcap/grid-pro": "14.200.1-alpha-e974201.0",
+    "@ag-grid-community/core": "29.2.0",
+    "@genesislcap/foundation-comms": "14.202.0",
+    "@genesislcap/foundation-errors": "14.202.0",
+    "@genesislcap/foundation-events": "14.202.0",
+    "@genesislcap/foundation-forms": "14.202.0",
+    "@genesislcap/foundation-logger": "14.202.0",
+    "@genesislcap/foundation-login": "14.202.0",
+    "@genesislcap/foundation-notifications": "14.202.0",
+    "@genesislcap/foundation-ui": "14.202.0",
+    "@genesislcap/foundation-utils": "14.202.0",
+    "@genesislcap/foundation-zero": "14.202.0",
+    "@genesislcap/foundation-zero-grid-pro": "14.202.0",
+    "@genesislcap/grid-pro": "14.202.0",
     "@microsoft/fast-components": "^2.30.6",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
@@ -90,5 +90,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "a42390bcae28079e43be4926f54c6504e42ba8b7"
+  "gitHead": "73a2550f84344266438432d5c18a567885de548e"
 }