@genesislcap/foundation-entity-management 14.24.4 → 14.25.0-bny.2

package/dist/esm/entities/entities.js

@@ -46,6 +46,11 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
          */
         this.entityLabel = '';
         this.editModalVisible = false;
+        /**
+         * Determines where the modal dialog will appear on screen
+         * @public
+         */
+        this.modalPosition = 'right';
         /**
          * Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
          *
@@ -82,6 +87,7 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
             }
             this.addEventListener('edit-entity', this.editEntity);
             this.addEventListener('read-entity', this.readEntity);
+            this.addEventListener('criteria-changed', this.criteriaChanged);
         });
     }
     /**
@@ -114,6 +120,13 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
             this.closeModal();
         });
     }
+    /**
+     * Show the entity create form
+     * @public
+     */
+    create() {
+        this.editEntity();
+    }
     /**
      * Sets up and opens the model to either edit or add an entity. Added as an event listener on the class when receiving the `edit-entity` event.
      *
@@ -122,10 +135,10 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
      */
     editEntity(e) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.editDialogTitle = `${e.detail ? 'Edit' : 'Add'} ${this.entityLabel}`;
-            this.formUiSchema = e.detail ? this.updateFormUiSchema : this.createFormUiSchema;
-            this.formResourceName = e.detail ? this.updateEvent : this.createEvent;
-            if (e.detail) {
+            this.editDialogTitle = `${(e === null || e === void 0 ? void 0 : e.detail) ? 'Edit' : 'Add'} ${this.entityLabel}`;
+            this.formUiSchema = (e === null || e === void 0 ? void 0 : e.detail) ? this.updateFormUiSchema : this.createFormUiSchema;
+            this.formResourceName = (e === null || e === void 0 ? void 0 : e.detail) ? this.updateEvent : this.createEvent;
+            if (e === null || e === void 0 ? void 0 : e.detail) {
                 const _a = e.detail, { ROW_REF } = _a, formData = __rest(_a, ["ROW_REF"]);
                 this.editedEntity = formData;
                 if (this.readEventFn) {
@@ -140,7 +153,7 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
                 }
             }
             else {
-                this.editedEntity = {};
+                this.editedEntity = Object.assign({}, this.defaultEntityValues);
             }
             this.editModalVisible = true;
         });
@@ -151,9 +164,13 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
         this.editDialogTitle = '';
     }
     closeModal() {
+        this.editEntityForm.reset();
         this.readonly = false;
         this.editModalVisible = false;
     }
+    criteriaChanged(e) {
+        this.datasourceConfig = Object.assign(Object.assign({}, this.datasourceConfig), { criteria: e.detail });
+    }
     /**
      * Handler for deleting the entity. Added as an event listener on the class when receiving the `delete-entity` event.
      *
@@ -292,6 +309,9 @@ __decorate([
 __decorate([
     observable
 ], EntityManagement.prototype, "submitting", void 0);
+__decorate([
+    observable
+], EntityManagement.prototype, "defaultEntityValues", void 0);
 __decorate([
     observable
 ], EntityManagement.prototype, "editDialogTitle", void 0);
@@ -307,6 +327,9 @@ __decorate([
 __decorate([
     attr({ mode: 'boolean', attribute: 'enable-cell-flashing' })
 ], EntityManagement.prototype, "enableCellFlashing", void 0);
+__decorate([
+    attr({ attribute: 'modal-position' })
+], EntityManagement.prototype, "modalPosition", void 0);
 EntityManagement = __decorate([
     customElement({
         name: 'entity-management',

package/dist/esm/entities/entities.styles.js

@@ -29,4 +29,10 @@ export const styles = css `
   .title {
     margin-left: 1px;
   }
+
+  :host::part(header) {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+  }
 `;

package/dist/esm/entities/entities.template.js

@@ -3,28 +3,40 @@ import { html, ref, when } from '@microsoft/fast-element';
 import { List } from '../list';
 List;
 Form;
+/**
+ * Default header for Entity Management screen
+ * @internal
+ */
+const defaultHeader = html `
+  <h3>${(x) => x.title}</h3>
+  ${when((x) => x.createEvent, html `
+      <zero-button appearance="accent" @click=${(x, y) => x.create()}>Add</zero-button>
+    `)}
+`;
 /**
  * Defines the html of the entity component as a ViewTemplate object
  * @typeParam EntityManagement - the {@link EntityManagement | class} the template is defined for
  */
 export const template = html `
   <div class="container">
+    <slot name="header" part="header">${defaultHeader}</slot>
     <entity-list
       title=${(x) => x.title}
       persist-column-state-key=${(x) => x.persistColumnStateKey}
       size-columns-to-fit=${(x) => x.sizeColumnsToFit}
       enable-filter-bar=${(x) => x.enableFilterBar}
       resourceName=${(x) => x.resourceName}
-      :createEvent=${(x) => x.createEvent}
       :deleteEvent=${(x) => x.deleteEvent}
       :updateEvent=${(x) => x.updateEvent}
       :columns=${(x) => x.columns}
       :datasourceConfig=${(x) => x.datasourceConfig}
       data-test-id="entity-list"
-    ></entity-list>
+    >
+      <slot name="header" slot="header">${defaultHeader}</slot>
+    </entity-list>
     <zero-modal
       ${ref('editEntityModal')}
-      position="right"
+      position=${(x) => x.modalPosition}
       :onCloseCallback=${(x) => x.closeModal.bind(x)}
       data-test-id="edit-entity-modal"
     >
@@ -33,6 +45,8 @@ export const template = html `
       <slot name="edit">
         ${when((x) => x.editModalVisible, html `
             <foundation-form
+              part="form"
+              ${ref('editEntityForm')}
               resourceName=${(x) => x.formResourceName}
               :data=${(x) => x.editedEntity}
               :uischema=${(x) => x.formUiSchema}

package/dist/esm/list/list.js

@@ -1,8 +1,9 @@
 import { __awaiter, __decorate } from "tslib";
 import { Events } from '@ag-grid-community/core';
 import { attr, customElement, FASTElement, observable } from '@microsoft/fast-element';
+import { buttonCellRenderer } from '../utils';
 import { listStyles } from './list.styles';
-import { buttonCellRenderer, listTemplate } from './list.template';
+import { listTemplate } from './list.template';
 let List = class List extends FASTElement {
     constructor() {
         super(...arguments);
@@ -56,9 +57,6 @@ let List = class List extends FASTElement {
     select(e) {
         this.$emit('rowSelected', e);
     }
-    create() {
-        this.$emit('edit-entity');
-    }
     delete(e) {
         return __awaiter(this, void 0, void 0, function* () {
             this.$emit('delete-entity', e);
@@ -92,9 +90,6 @@ __decorate([
 __decorate([
     observable
 ], List.prototype, "actionButtonsConfig", void 0);
-__decorate([
-    observable
-], List.prototype, "createEvent", void 0);
 __decorate([
     observable
 ], List.prototype, "deleteEvent", void 0);

package/dist/esm/list/list.styles.js

@@ -18,10 +18,4 @@ export const listStyles = css `
     height: inherit;
     width: 100%;
   }
-
-  .heading {
-    display: flex;
-    justify-content: space-between;
-    align-items: center;
-  }
 `;

package/dist/esm/list/list.template.js

@@ -1,40 +1,5 @@
 import { html, ref, repeat, when } from '@microsoft/fast-element';
-export const buttonCellRenderer = (title, clickHandler) => ({
-    width: 100,
-    pinned: 'right',
-    enableCellChangeFlash: false,
-    cellStyle: { padding: '0', lineHeight: '25px' },
-    filter: false,
-    suppressFiltersToolPanel: true,
-    suppressColumnsToolPanel: true,
-    headerName: '',
-    minWidth: 100,
-    maxWidth: 100,
-    cellRendererSelector: (params) => params.node.group
-        ? undefined
-        : {
-            component: 'action',
-            params: {
-                actionClick: clickHandler,
-                actionName: title,
-                appearance: 'accent',
-            },
-        },
-});
 export const listTemplate = html `
-  <div class="heading">
-    <h3 data-test-id="title">${(x) => x.title}</h3>
-    ${when((x) => x.createEvent, html `
-        <zero-button
-          appearance="accent"
-          @click=${(x) => x.create()}
-          ?disabled="${(x) => x.addDisabled}"
-          data-test-id="button-create"
-        >
-          Add
-        </zero-button>
-      `)}
-  </div>
   <div class="container">
     ${when((x) => x.enableFilterBar, html `
         <zero-filter-bar

package/dist/esm/utils/index.js

@@ -1,2 +1,27 @@
 export * from './formatting';
 export * from './logger';
+/**
+ * @public
+ */
+export const buttonCellRenderer = (title, clickHandler) => ({
+    width: 100,
+    pinned: 'right',
+    enableCellChangeFlash: false,
+    cellStyle: { padding: '0', lineHeight: '25px' },
+    filter: false,
+    suppressFiltersToolPanel: true,
+    suppressColumnsToolPanel: true,
+    headerName: '',
+    minWidth: 100,
+    maxWidth: 100,
+    cellRendererSelector: (params) => params.node.group
+        ? undefined
+        : {
+            component: 'action',
+            params: {
+                actionClick: clickHandler,
+                actionName: title,
+                appearance: 'accent',
+            },
+        },
+});

package/dist/foundation-entity-management.api.json

@@ -172,6 +172,29 @@
       "name": "",
       "preserveMemberOrder": false,
       "members": [
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-entity-management!buttonCellRenderer:var",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "buttonCellRenderer: "
+            },
+            {
+              "kind": "Content",
+              "text": "(title: any, clickHandler: any) => {\n    width: number;\n    pinned: string;\n    enableCellChangeFlash: boolean;\n    cellStyle: {\n        padding: string;\n        lineHeight: string;\n    };\n    filter: boolean;\n    suppressFiltersToolPanel: boolean;\n    suppressColumnsToolPanel: boolean;\n    headerName: string;\n    minWidth: number;\n    maxWidth: number;\n    cellRendererSelector: (params: any) => {\n        component: string;\n        params: {\n            actionClick: any;\n            actionName: any;\n            appearance: string;\n        };\n    };\n}"
+            }
+          ],
+          "fileUrlPath": "src/utils/index.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "buttonCellRenderer",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-entity-management!DatasourceConfiguration:type",
@@ -370,6 +393,37 @@
               "isProtected": true,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#create:member(1)",
+              "docComment": "/**\n * Show the entity create form\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "create(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "create"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#createEvent:member",
@@ -430,6 +484,59 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#criteriaChanged:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "criteriaChanged(e: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "CustomEvent",
+                  "canonicalReference": "!CustomEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string>"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 4,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "e",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "criteriaChanged"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#datasourceConfig:member",
@@ -493,6 +600,36 @@
               "isAbstract": false,
               "name": "deepClone"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#defaultEntityValues:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "defaultEntityValues: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "defaultEntityValues",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#deleteEvent:member",
@@ -583,6 +720,37 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editEntityForm:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "editEntityForm: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Form",
+                  "canonicalReference": "@genesislcap/foundation-forms!Form:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "editEntityForm",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editEntityModal:member",
@@ -794,6 +962,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#modalPosition:member",
+              "docComment": "/**\n * Determines where the modal dialog will appear on screen\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "modalPosition: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "'centre' | 'left' | 'right'"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "modalPosition",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#persistColumnStateKey:member",

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

@@ -7,6 +7,7 @@ import { Controller } from '@microsoft/fast-element';
 import { DatasourceOptions } from '@genesislcap/foundation-comms';
 import { DOMContainer } from '@genesislcap/foundation-utils';
 import { FASTElement } from '@microsoft/fast-element';
+import { Form } from '@genesislcap/foundation-forms';
 import { FoundationAnalytics } from '@genesislcap/foundation-comms';
 import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
 import { GridProRendererTypes } from '@genesislcap/grid-pro';
@@ -18,6 +19,33 @@ import { RouterConfiguration } from '@microsoft/fast-router';
 import { Session } from '@genesislcap/foundation-comms';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+/**
+ * @public
+ */
+export declare const buttonCellRenderer: (title: any, clickHandler: any) => {
+    width: number;
+    pinned: string;
+    enableCellChangeFlash: boolean;
+    cellStyle: {
+        padding: string;
+        lineHeight: string;
+    };
+    filter: boolean;
+    suppressFiltersToolPanel: boolean;
+    suppressColumnsToolPanel: boolean;
+    headerName: string;
+    minWidth: number;
+    maxWidth: number;
+    cellRendererSelector: (params: any) => {
+        component: string;
+        params: {
+            actionClick: any;
+            actionName: any;
+            appearance: string;
+        };
+    };
+};
+
 /**
  * The attribute which is set to configure the resource that the entity manager is working with
  *
@@ -166,6 +194,7 @@ export declare class EntityManagement extends EntityManagement_base {
      */
     editedEntity: any;
     submitting: boolean;
+    defaultEntityValues: any;
     /**
      * String which contains the text of the popup modal when the user is adding or editing an entity
      */
@@ -173,9 +202,15 @@ export declare class EntityManagement extends EntityManagement_base {
     editModalVisible: boolean;
     editModalVisibleChanged(): void;
     editEntityModal: any;
+    editEntityForm: Form;
     sizeColumnsToFit: boolean;
     enableFilterBar: boolean;
     enableCellFlashing: boolean;
+    /**
+     * Determines where the modal dialog will appear on screen
+     * @public
+     */
+    modalPosition: 'centre' | 'left' | 'right';
     /**
      * Set up the web component
      * @internal
@@ -195,6 +230,11 @@ export declare class EntityManagement extends EntityManagement_base {
      * @public
      */
     submitEntityChanges(e: CustomEvent): Promise<void>;
+    /**
+     * Show the entity create form
+     * @public
+     */
+    create(): void;
     /**
      * Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
      *
@@ -211,6 +251,7 @@ export declare class EntityManagement extends EntityManagement_base {
     private editEntity;
     private readEntity;
     closeModal(): void;
+    criteriaChanged(e: CustomEvent<string>): void;
     /**
      * Handler for deleting the entity. Added as an event listener on the class when receiving the `delete-entity` event.
      *
@@ -239,10 +280,7 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     readonly shouldRunConnect: boolean;
     "__#1@#_tryFindContainingLayout"(e: Element): FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
     connectedCallback(): void;
-    readonly $fastController: Controller; /**
-    * Label for the entity which has usages such as being shown in the title of the modal wen editing the entity
-    * @public
-    */
+    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;
@@ -341,6 +379,12 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     webkitMatchesSelector(selectors: string): boolean;
     readonly baseURI: string;
     readonly childNodes: NodeListOf<ChildNode>;
+    /**
+     * Sets up and opens the model to either edit or add an entity. Added as an event listener on the class when receiving the `edit-entity` event.
+     *
+     * @param e - CustomEvent where `e.detail` is used to deduce whether to edit or add an entity.
+     * @internal
+     */
     readonly firstChild: ChildNode;
     readonly isConnected: boolean;
     readonly lastChild: ChildNode;

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

@@ -0,0 +1,34 @@
+<!-- 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; [buttonCellRenderer](./foundation-entity-management.buttoncellrenderer.md)
+
+## buttonCellRenderer variable
+
+
+**Signature:**
+
+```typescript
+buttonCellRenderer: (title: any, clickHandler: any) => {
+    width: number;
+    pinned: string;
+    enableCellChangeFlash: boolean;
+    cellStyle: {
+        padding: string;
+        lineHeight: string;
+    };
+    filter: boolean;
+    suppressFiltersToolPanel: boolean;
+    suppressColumnsToolPanel: boolean;
+    headerName: string;
+    minWidth: number;
+    maxWidth: number;
+    cellRendererSelector: (params: any) => {
+        component: string;
+        params: {
+            actionClick: any;
+            actionName: any;
+            appearance: string;
+        };
+    };
+}
+```

package/docs/api/foundation-entity-management.entitymanagement.create.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; [create](./foundation-entity-management.entitymanagement.create.md)
+
+## EntityManagement.create() method
+
+Show the entity create form
+
+**Signature:**
+
+```typescript
+create(): void;
+```
+**Returns:**
+
+void
+