@genesislcap/foundation-entity-management 14.214.1 → 14.214.2

package/dist/dts/entities/entities.d.ts

@@ -88,10 +88,6 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     readonly scrollHeight: number;
     scrollLeft: number;
     scrollTop: number;
-    /**
-     * GridOptions to be passed down from application
-     * @public
-     */
     readonly scrollWidth: number;
     readonly shadowRoot: ShadowRoot;
     slot: string;
@@ -103,6 +99,10 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     getAttribute(qualifiedName: string): string;
     getAttributeNS(namespace: string, localName: string): string;
     getAttributeNames(): string[];
+    /**
+     * GridOptions to be passed down from application
+     * @public
+     */
     getAttributeNode(qualifiedName: string): Attr;
     getAttributeNodeNS(namespace: string, localName: string): Attr;
     getBoundingClientRect(): DOMRect;
@@ -149,10 +149,6 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     readonly lastChild: ChildNode;
     readonly nextSibling: ChildNode;
     readonly nodeName: string;
-    /**
-     * Determines the style of the buttons
-     * @public
-     */
     readonly nodeType: number;
     nodeValue: string;
     readonly parentElement: HTMLElement;
@@ -167,7 +163,10 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     insertBefore<T_2 extends Node>(node: T_2, child: Node): T_2;
     isDefaultNamespace(namespace: string): boolean;
     isEqualNode(otherNode: Node): boolean;
-    isSameNode(otherNode: Node): boolean;
+    isSameNode(otherNode: Node): boolean; /**
+     * Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid
+     * * @public
+     */
     lookupNamespaceURI(prefix: string): string;
     lookupPrefix(namespace: string): string;
     normalize(): void;
@@ -188,6 +187,11 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     readonly ELEMENT_NODE: number;
     readonly ENTITY_NODE: number;
     readonly ENTITY_REFERENCE_NODE: number;
+    /**
+     * The helper function to determine the title of the modal form or button based on the action or type
+     * @param actionOrType - The crud action or modal form type
+     * @internal
+     */
     readonly NOTATION_NODE: number;
     readonly PROCESSING_INSTRUCTION_NODE: number;
     readonly TEXT_NODE: number;
@@ -205,7 +209,10 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     ariaExpanded: string;
     ariaHasPopup: string;
     ariaHidden: string;
-    ariaInvalid: string;
+    ariaInvalid: string; /**
+     * Getter for the title of the modal form
+     * @internal
+     */
     ariaKeyShortcuts: string;
     ariaLabel: string;
     ariaLevel: string;
@@ -299,7 +306,12 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
     onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
     onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
-    onload: (this: GlobalEventHandlers, ev: Event) => any;
+    onload: (this: GlobalEventHandlers, ev: Event) => any; /**
+     * Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
+     *
+     * @param e - CustomEvent which contains data about the selected entity. If the row is not selected then the reference will be set to an empty object.
+     * @internal
+     */
     onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
     onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
     onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
@@ -311,7 +323,12 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
     onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
     onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
-    onpause: (this: GlobalEventHandlers, ev: Event) => any;
+    onpause: (this: GlobalEventHandlers, ev: Event) => any; /**
+     * Opens the model to edit an entity. Added as an event listener on the class when receiving the `edit-entity` event.
+     *
+     * @param e - CustomEvent where `e.detail` is the entity to edit.
+     * @internal
+     */
     onplay: (this: GlobalEventHandlers, ev: Event) => any;
     onplaying: (this: GlobalEventHandlers, ev: Event) => any;
     onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any;
@@ -333,6 +350,9 @@ declare const EntityManagement_base: (new (...args: any[]) => {
     onselect: (this: GlobalEventHandlers, ev: Event) => any;
     onselectionchange: (this: GlobalEventHandlers, ev: Event) => any;
     onselectstart: (this: GlobalEventHandlers, ev: Event) => any;
+    /**
+     * @internal
+     */
     onslotchange: (this: GlobalEventHandlers, ev: Event) => any;
     onstalled: (this: GlobalEventHandlers, ev: Event) => any;
     onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any;
@@ -406,6 +426,7 @@ export declare class EntityManagement extends EntityManagement_base {
      *
      * Requires {@link @genesislcap/foundation-comms#Connect | the connect class} to be registered with the
      * DI container
+     * @internal
      */
     protected connect: Connect;
     /**
@@ -418,8 +439,23 @@ export declare class EntityManagement extends EntityManagement_base {
      * @public
      */
     resourceName: string;
+    /**
+     * Name of the request on the Genesis server which fetches data for the form, example usage could
+     * include fetching additional data that is not available in the grid but required for the selected entity
+     * @public
+     */
     readEvent: string;
-    readEventFn: (...args: any[]) => {};
+    /**
+     * Similar to readEvent but allows to provide function that will be executed before
+     * opening the form and yields data to the form
+     * @param entity - selected entity from the grid
+     * @returns object with data which will be used to prefill the form similarly to `defaultEntityValues`
+     * @public
+     */
+    readEventFn: (entity: any) => any;
+    /**
+     * @internal
+     */
     readonly: boolean;
     /**
      * Name of the event handler on the Genesis server which handles updating the entity
@@ -442,26 +478,26 @@ export declare class EntityManagement extends EntityManagement_base {
      */
     title: string;
     /**
-     * Label for the entity which has usages such as being shown in the title of the modal wen editing the entity
+     * Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications
      * @public
      */
     entityLabel: string;
     /**
      * Whether to use the `applyTransactionAsync` function for *add* transactions
      * @remarks Defaults to false
-     * @public
+     * @internal
      */
     asyncAdd: boolean;
     /**
      * Whether to use the `applyTransactionAsync` function for *remove* transactions
      * @remarks Defaults to false
-     * @public
+     * @internal
      */
     asyncRemove: boolean;
     /**
      * Whether to use the `applyTransactionAsync` function for *update* transactions
      * @remarks Defaults to true
-     * @public
+     * @internal
      */
     asyncUpdate: boolean;
     /**
@@ -518,8 +554,19 @@ export declare class EntityManagement extends EntityManagement_base {
      * @public
      */
     datasourceConfig: DatasourceConfiguration;
+    /**
+     * @internal
+     */
     formUiSchema: UiSchema;
+    /**
+     * Enables you to supply a schema to configure an insert form.
+     * @public
+     */
     createFormUiSchema: UiSchema;
+    /**
+     * Enables you to supply a schema to configure an update form.
+     * @public
+     */
     updateFormUiSchema: UiSchema;
     /**
      * The name of the resource in the backend to interact with when dispatching actions from the update/create modal
@@ -537,12 +584,12 @@ export declare class EntityManagement extends EntityManagement_base {
      * @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
-     * @public
+     * @internal
      */
     selectedEntity: Record<string, unknown>;
     /**
      * Disables the form while enabled to stop the user dispatching a large number of duplicate events
-     * @public
+     * @internal
      */
     editedEntity: Record<string, unknown>;
     /**
@@ -550,17 +597,43 @@ export declare class EntityManagement extends EntityManagement_base {
      * @public
      */
     defaultEntityValues: Record<string, unknown>;
+    /**
+     * @internal
+     */
     submitting: boolean;
     /**
      * The type of form that is currently being displayed in the modal
+     * @internal
      */
     modalFormType: ModalFormType;
+    /**
+     * @internal
+     */
     editModalVisible: boolean;
-    editModalVisibleChanged(): void;
+    private editModalVisibleChanged;
+    /**
+     * @internal
+     */
     editEntityModal: Modal;
+    /**
+     * Resizes columns to take available space
+     * @public
+     */
     sizeColumnsToFit: boolean;
+    /**
+     * Enables filter bar component
+     * @public
+     */
     enableFilterBar: boolean;
+    /**
+     * Hides edit button
+     * @public
+     */
     hideEdit: boolean;
+    /**
+     * Hides delete button
+     * @public
+     */
     hideDelete: boolean;
     /**
      * This attribute controls whether to enable the search-bar.
@@ -573,6 +646,10 @@ export declare class EntityManagement extends EntityManagement_base {
      * @public
      */
     headerCaseType: GridProCaseType;
+    /**
+     * Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid
+     * * @public
+     */
     searchBarConfig: AvailableOption[];
     /**
      * Determines where the modal dialog will appear on screen
@@ -595,27 +672,33 @@ export declare class EntityManagement extends EntityManagement_base {
     crudActionMenuName: string;
     /**
      * The Id of the crud buttons wrapper element
+     * @internal
      */
     crudMenuWrapper: any;
     /**
      * The helper function to determine the title of the modal form or button based on the action or type
      * @param actionOrType - The crud action or modal form type
+     * @internal
      */
     getTitleBasedOnActionOrType(actionOrType: CrudAction | ModalFormType): string;
     /**
      * Getter for the title of the modal form
+     * @internal
      */
     get modalFormTitle(): string;
     /**
      * Determines whether the button edit should be hidden in the column
+     * @internal
      */
     get shouldHideEditInColumn(): boolean;
     /**
      * Determines whether the button delete should be hidden in the column
+     * @internal
      */
     get shouldHideDeleteInColumn(): boolean;
     /**
      * Determines whether there is a selected entity
+     * @internal
      */
     get hasSelectedEntity(): boolean;
     /**
@@ -623,7 +706,7 @@ export declare class EntityManagement extends EntityManagement_base {
      *
      * @param slotName - The name of the slot to check.
      * @returns True if the slot has content, otherwise false.
-     * @public
+     * @internal
      */
     hasContentInSlot(slotName: string): boolean;
     /**
@@ -631,6 +714,9 @@ export declare class EntityManagement extends EntityManagement_base {
      * @internal
      */
     connectedCallback(): Promise<void>;
+    /**
+     * @internal
+     */
     disconnectedCallback(): Promise<void>;
     /**
      * Gets the default searchBarConfig if the user has not created their own.
@@ -639,18 +725,15 @@ export declare class EntityManagement extends EntityManagement_base {
     private getDefaultSearchBarConfig;
     /**
      * Override the deepClone method to ensure that observable attributes are cloned
-     * @public
+     * @internal
      */
     deepClone(): Node;
     /**
      * 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
+     * @internal
      */
-    submitEntityChanges(e: CustomEvent): Promise<void>;
+    submitEntityChanges(): Promise<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.
      *
@@ -672,15 +755,27 @@ export declare class EntityManagement extends EntityManagement_base {
      */
     editEntity({ detail }: CustomEvent): Promise<void>;
     private readEntity;
+    /**
+     * @internal
+     */
     closeModal(): void;
+    /**
+     * @internal
+     */
     get headerTempalate(): import("@microsoft/fast-element").ViewTemplate<EntityManagement, any>;
+    /**
+     * @internal
+     */
     get isServerSideDatasource(): boolean;
+    /**
+     * @internal
+     */
     searchChanged(event: CustomEvent<Array<SelectedOption>>): void;
-    searchBarReqServer(options: SelectedOption<string>[]): void;
-    searchBarDataserver(options: SelectedOption<string>[]): void;
-    requestChanged(e: CustomEvent<string>): void;
-    criteriaChanged(e: CustomEvent<string>): void;
-    submitFailureNotification(e: CustomEvent): void;
+    private searchBarReqServer;
+    private searchBarDataserver;
+    private requestChanged;
+    private criteriaChanged;
+    private submitFailureNotification;
     private submitErrorHandler;
     /**
      * Handler for deleting the entity. Added as an event listener on the class when receiving the `delete-entity` event.
@@ -689,11 +784,15 @@ export declare class EntityManagement extends EntityManagement_base {
      * @internal
      */
     deleteEntity(e: CustomEvent): Promise<void>;
+    /**
+     * @internal
+     */
     confirmDelete(): Promise<void>;
     private showDeleteConfirmation;
     /**
      * Emit the CRUD event for the selected entity
      * @param action - the action to emit
+     * @internal
      */
     emitCrud(action: 'create' | 'edit' | 'delete'): void;
     /**
@@ -714,6 +813,7 @@ export declare class EntityManagement extends EntityManagement_base {
     private generateCrudActionsMenu;
     /**
      * The event handler for when the selection changes in the grid.
+     * @internal
      */
     selectionChanged(event: CustomEvent<SelectionChangedEvent>): void;
 }

package/dist/dts/entities/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/entities/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrF,OAAO,EACL,OAAO,EACP,iBAAiB,EAEjB,YAAY,EAEb,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAa,MAAM,+BAA+B,CAAC;AAEzE,OAAO,EAAE,KAAK,EAAe,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAE7E,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAIL,WAAW,EAGZ,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAMzF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2J5E;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2GH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA1QL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAKa,gBAAiB,SAAQ,qBAA2B;IAC/D;;;;;;;OAOG;IACM,SAAS,CAAC,OAAO,EAAG,OAAO,CAAC;IAErC;;;OAGG;IAC0C,MAAM,EAAE,MAAM,CAAU;IAErE;;;OAGG;IACG,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,CAAC,GAAG,IAAI,OAAA,KAAK,EAAE,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAE7C;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACG,KAAK,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACgD,QAAQ,UAAS;IAEpE;;;;OAIG;IACmD,WAAW,UAAS;IAE1E;;;;OAIG;IACmD,WAAW,UAAQ;IAEzE;;;;OAIG;IACmC,YAAY,SAAY;IAE9D;;;;OAIG;IAC2D,kBAAkB,UAAS;IAEzF;;;OAGG;IAC0D,iBAAiB,UAAS;IAEvF;;;;OAIG;IACqC,cAAc,EAAE,cAAc,CAAY;IAElF;;;;;;;;;;OAUG;IAC8C,qBAAqB,EAAE,MAAM,CAAC;IAE/E;;;OAGG;IACS,WAAW,EAAE,WAAW,CAAC;IAErC;;;OAGG;IACS,OAAO,EAAE,MAAM,EAAE,CAAC;IAE9B;;;;;;;OAOG;IACS,gBAAgB,EAAE,uBAAuB,CAAmC;IAC5E,YAAY,EAAE,QAAQ,CAAC;IACvB,kBAAkB,EAAE,QAAQ,CAAC;IAC7B,kBAAkB,EAAE,QAAQ,CAAC;IAEzC;;;OAGG;IACS,gBAAgB,EAAE,MAAM,CAAC;IAErC;;;OAGG;IACS,aAAa,EAAE,aAAa,EAAE,CAAa;IAEvD;;;;;;;OAOG;IACS,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAGpD;;;OAGG;IACS,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElD;;;OAGG;IACS,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE7C,UAAU,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACS,aAAa,EAAE,aAAa,CAAC;IAC7B,gBAAgB,EAAE,OAAO,CAAS;IAC9C,uBAAuB;IAShB,eAAe,EAAE,KAAK,CAAC;IAE+B,gBAAgB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACjC,QAAQ,EAAE,OAAO,CAAS;IACxB,UAAU,EAAE,OAAO,CAAS;IACjF;;;OAGG;IACwD,eAAe,EAAE,OAAO,CAAS;IAE5F;;;;OAIG;IACsC,cAAc,EAAE,eAAe,CAAC;IAE7D,eAAe,EAAE,eAAe,EAAE,CAAC;IAE/C;;;OAGG;IACoC,aAAa,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAW;IAE5F;;;OAGG;IACwC,gBAAgB,EAAE,gBAAgB,CACnD;IAE1B;;;OAGG;IACqC,aAAa,EAAE,gBAAgB,CAC5C;IAE3B;;OAEG;IAC2C,kBAAkB,EAAE,MAAM,CAAO;IAE/E;;OAEG;IACI,eAAe,MAAC;IAEvB;;;OAGG;IACI,2BAA2B,CAAC,YAAY,EAAE,UAAU,GAAG,aAAa;IAa3E;;OAEG;IACH,IAAI,cAAc,WAEjB;IAED;;OAEG;IACH,IAAI,sBAAsB,IAAI,OAAO,CAEpC;IAED;;OAEG;IACH,IAAI,wBAAwB,IAAI,OAAO,CAEtC;IAED;;OAEG;IACH,IAAI,iBAAiB,IAAI,OAAO,CAE/B;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAKlD;;;OAGG;IACG,iBAAiB;IAsBjB,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAmB3C;;;OAGG;YACW,yBAAyB;IAkBvC;;;OAGG;IACM,SAAS,IAAI,IAAI;IA4B1B;;;;;;;OAOG;IACU,mBAAmB,CAAC,CAAC,EAAE,WAAW;IAK/C;;;;;OAKG;IACH,OAAO,CAAC,YAAY,CAElB;IAEF;;;;OAIG;IACI,YAAY;IASnB;;;;;OAKG;IACU,UAAU,CAAC,EAAE,MAAM,EAAE,EAAE,WAAW;IA4B/C,OAAO,CAAC,UAAU;IAMX,UAAU;IAMjB,IACI,eAAe,0EAElB;IAED,IAAI,sBAAsB,IAAI,OAAO,CAEpC;IAEM,aAAa,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAe9D,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE;IAKpD,mBAAmB,CAAC,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE;IAiB9C,cAAc,CAAC,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC;IAIrC,eAAe,CAAC,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC;IAItC,yBAAyB,CAAC,CAAC,EAAE,WAAW;IAgC/C,OAAO,CAAC,kBAAkB;IAiB1B;;;;;OAKG;IACG,YAAY,CAAC,CAAC,EAAE,WAAW;IAK3B,aAAa;IAwBnB,OAAO,CAAC,sBAAsB;IAc9B;;;OAGG;IACI,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ;IAIpD;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,aAAa,GAAG,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,EAAE;IA8C1F;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAkC/B;;OAEG;IACI,gBAAgB,CAAC,KAAK,EAAE,WAAW,CAAC,qBAAqB,CAAC;CASlE"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/entities/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrF,OAAO,EACL,OAAO,EACP,iBAAiB,EAEjB,YAAY,EAEb,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAa,MAAM,+BAA+B,CAAC;AAEzE,OAAO,EAAE,KAAK,EAAe,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAE7E,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAIL,WAAW,EAGZ,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAMzF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2K5E;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0CA+HH;;;OAGG;;;;;;;;;;;;;;;;;;;;;IAkCH;;;;OAIG;;;;;;;;;;;;;;;;;;yBAcH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2DAwJH;;;;;OAKG;;;;;;;;;;;;4DAmBH;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;IAqDH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAjlBL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAKa,gBAAiB,SAAQ,qBAA2B;IAC/D;;;;;;;;OAQG;IACM,SAAS,CAAC,OAAO,EAAG,OAAO,CAAC;IAErC;;;OAGG;IAC0C,MAAM,EAAE,MAAM,CAAU;IAErE;;;OAGG;IACG,YAAY,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACG,SAAS,EAAE,MAAM,CAAC;IACxB;;;;;;OAMG;IACS,WAAW,EAAE,CAAC,MAAM,KAAA,KAAK,GAAG,CAAC;IACzC;;OAEG;IACwB,QAAQ,EAAE,OAAO,CAAC;IAE7C;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACG,KAAK,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACgD,QAAQ,UAAS;IAEpE;;;;OAIG;IACmD,WAAW,UAAS;IAE1E;;;;OAIG;IACmD,WAAW,UAAQ;IAEzE;;;;OAIG;IACmC,YAAY,SAAY;IAE9D;;;;OAIG;IAC2D,kBAAkB,UAAS;IAEzF;;;OAGG;IAC0D,iBAAiB,UAAS;IAEvF;;;;OAIG;IACqC,cAAc,EAAE,cAAc,CAAY;IAElF;;;;;;;;;;OAUG;IAC8C,qBAAqB,EAAE,MAAM,CAAC;IAE/E;;;OAGG;IACS,WAAW,EAAE,WAAW,CAAC;IAErC;;;OAGG;IACS,OAAO,EAAE,MAAM,EAAE,CAAC;IAE9B;;;;;;;OAOG;IACS,gBAAgB,EAAE,uBAAuB,CAAmC;IACxF;;OAEG;IACS,YAAY,EAAE,QAAQ,CAAC;IACnC;;;OAGG;IACS,kBAAkB,EAAE,QAAQ,CAAC;IACzC;;;OAGG;IACS,kBAAkB,EAAE,QAAQ,CAAC;IAEzC;;;OAGG;IACS,gBAAgB,EAAE,MAAM,CAAC;IAErC;;;OAGG;IACS,aAAa,EAAE,aAAa,EAAE,CAAa;IAEvD;;;;;;;OAOG;IACS,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpD;;;OAGG;IACS,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElD;;;OAGG;IACS,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD;;OAEG;IACS,UAAU,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACS,aAAa,EAAE,aAAa,CAAC;IACzC;;OAEG;IACS,gBAAgB,EAAE,OAAO,CAAS;IAC9C,OAAO,CAAC,uBAAuB;IAS/B;;OAEG;IACI,eAAe,EAAE,KAAK,CAAC;IAE9B;;;OAGG;IAC0D,gBAAgB,EAAE,OAAO,CAAC;IACvF;;;OAGG;IACwD,eAAe,EAAE,OAAO,CAAC;IACpF;;;OAGG;IACgD,QAAQ,EAAE,OAAO,CAAS;IAC7E;;;OAGG;IACkD,UAAU,EAAE,OAAO,CAAS;IACjF;;;OAGG;IACwD,eAAe,EAAE,OAAO,CAAS;IAE5F;;;;OAIG;IACsC,cAAc,EAAE,eAAe,CAAC;IAEzE;;;OAGG;IACS,eAAe,EAAE,eAAe,EAAE,CAAC;IAE/C;;;OAGG;IACoC,aAAa,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAW;IAE5F;;;OAGG;IACwC,gBAAgB,EAAE,gBAAgB,CACnD;IAE1B;;;OAGG;IACqC,aAAa,EAAE,gBAAgB,CAC5C;IAE3B;;OAEG;IAC2C,kBAAkB,EAAE,MAAM,CAAO;IAE/E;;;OAGG;IACI,eAAe,MAAC;IAEvB;;;;OAIG;IACI,2BAA2B,CAAC,YAAY,EAAE,UAAU,GAAG,aAAa;IAa3E;;;OAGG;IACH,IAAI,cAAc,WAEjB;IAED;;;OAGG;IACH,IAAI,sBAAsB,IAAI,OAAO,CAEpC;IAED;;;OAGG;IACH,IAAI,wBAAwB,IAAI,OAAO,CAEtC;IAED;;;OAGG;IACH,IAAI,iBAAiB,IAAI,OAAO,CAE/B;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAKlD;;;OAGG;IACG,iBAAiB;IAqBvB;;OAEG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAmB3C;;;OAGG;YACW,yBAAyB;IAkBvC;;;OAGG;IACM,SAAS,IAAI,IAAI;IA4B1B;;;;OAIG;IACU,mBAAmB;IAKhC;;;;;OAKG;IACH,OAAO,CAAC,YAAY,CAElB;IAEF;;;;OAIG;IACI,YAAY;IASnB;;;;;OAKG;IACU,UAAU,CAAC,EAAE,MAAM,EAAE,EAAE,WAAW;IA4B/C,OAAO,CAAC,UAAU;IAMlB;;OAEG;IACI,UAAU;IAMjB;;OAEG;IACH,IACI,eAAe,0EAElB;IAGD;;OAEG;IACH,IAAI,sBAAsB,IAAI,OAAO,CAEpC;IAED;;OAEG;IACI,aAAa,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAe9D,OAAO,CAAC,kBAAkB;IAK1B,OAAO,CAAC,mBAAmB;IAiB3B,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,yBAAyB;IAgCjC,OAAO,CAAC,kBAAkB;IAiB1B;;;;;OAKG;IACG,YAAY,CAAC,CAAC,EAAE,WAAW;IAKjC;;OAEG;IACG,aAAa;IAwBnB,OAAO,CAAC,sBAAsB;IAc9B;;;;OAIG;IACI,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ;IAIpD;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,aAAa,GAAG,UAAU,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,EAAE;IA8C1F;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAkC/B;;;OAGG;IACI,gBAAgB,CAAC,KAAK,EAAE,WAAW,CAAC,qBAAqB,CAAC;CASlE"}

package/dist/esm/entities/entities.js

@@ -52,19 +52,19 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
         /**
          * Whether to use the `applyTransactionAsync` function for *add* transactions
          * @remarks Defaults to false
-         * @public
+         * @internal
          */
         this.asyncAdd = false;
         /**
          * Whether to use the `applyTransactionAsync` function for *remove* transactions
          * @remarks Defaults to false
-         * @public
+         * @internal
          */
         this.asyncRemove = false;
         /**
          * Whether to use the `applyTransactionAsync` function for *update* transactions
          * @remarks Defaults to true
-         * @public
+         * @internal
          */
         this.asyncUpdate = true;
         /**
@@ -104,8 +104,19 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
          * @public
          */
         this.formRenderers = renderers;
+        /**
+         * @internal
+         */
         this.editModalVisible = false;
+        /**
+         * Hides edit button
+         * @public
+         */
         this.hideEdit = false;
+        /**
+         * Hides delete button
+         * @public
+         */
         this.hideDelete = false;
         /**
          * This attribute controls whether to enable the search-bar.
@@ -154,6 +165,7 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
     /**
      * The helper function to determine the title of the modal form or button based on the action or type
      * @param actionOrType - The crud action or modal form type
+     * @internal
      */
     getTitleBasedOnActionOrType(actionOrType) {
         switch (actionOrType) {
@@ -169,24 +181,28 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
     }
     /**
      * Getter for the title of the modal form
+     * @internal
      */
     get modalFormTitle() {
         return this.getTitleBasedOnActionOrType(this.modalFormType);
     }
     /**
      * Determines whether the button edit should be hidden in the column
+     * @internal
      */
     get shouldHideEditInColumn() {
         return this.hideEdit || this.crudMenuPosition !== CrudMenuPosition.Column;
     }
     /**
      * Determines whether the button delete should be hidden in the column
+     * @internal
      */
     get shouldHideDeleteInColumn() {
         return this.hideDelete || this.crudMenuPosition !== CrudMenuPosition.Column;
     }
     /**
      * Determines whether there is a selected entity
+     * @internal
      */
     get hasSelectedEntity() {
         return !!(this.selectedEntity && Object.keys(this.selectedEntity).length > 0);
@@ -196,7 +212,7 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
      *
      * @param slotName - The name of the slot to check.
      * @returns True if the slot has content, otherwise false.
-     * @public
+     * @internal
      */
     hasContentInSlot(slotName) {
         var _a;
@@ -230,6 +246,9 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
             }
         });
     }
+    /**
+     * @internal
+     */
     disconnectedCallback() {
         const _super = Object.create(null, {
             disconnectedCallback: { get: () => super.disconnectedCallback }
@@ -275,7 +294,7 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
     }
     /**
      * Override the deepClone method to ensure that observable attributes are cloned
-     * @public
+     * @internal
      */
     deepClone() {
         const copy = super.deepClone();
@@ -308,12 +327,9 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
     /**
      * 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
+     * @internal
      */
-    submitEntityChanges(e) {
+    submitEntityChanges() {
         return __awaiter(this, void 0, void 0, function* () {
             this.handleNotify(this.modalFormType);
             this.closeModal();
@@ -367,17 +383,30 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
         this.readonly = true;
         this.editEntity(e);
     }
+    /**
+     * @internal
+     */
     closeModal() {
         this.modalFormType = null;
         this.readonly = false;
         this.editModalVisible = false;
     }
+    /**
+     * @internal
+     */
     get headerTempalate() {
         return this.enableSearchBar ? searchBarHeader(this.prefix) : defaultHeader(this.prefix);
     }
+    // TODO: seems like a dead code, needs further review if it's needed
+    /**
+     * @internal
+     */
     get isServerSideDatasource() {
         return this.datasourceType === 'server';
     }
+    /**
+     * @internal
+     */
     searchChanged(event) {
         const selectedOptions = event.detail;
         if (!selectedOptions.length) {
@@ -469,6 +498,9 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
             this.showDeleteConfirmation();
         });
     }
+    /**
+     * @internal
+     */
     confirmDelete() {
         return __awaiter(this, void 0, void 0, function* () {
             const schema = yield this.connect.getJSONSchema(this.deleteEvent);
@@ -506,6 +538,7 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
     /**
      * Emit the CRUD event for the selected entity
      * @param action - the action to emit
+     * @internal
      */
     emitCrud(action) {
         this.$emit(`${action}-entity`, this.selectedEntity);
@@ -594,6 +627,7 @@ let EntityManagement = class EntityManagement extends LifecycleMixin(FASTElement
     }
     /**
      * The event handler for when the selection changes in the grid.
+     * @internal
      */
     selectionChanged(event) {
         const selectedRows = event.detail.api.getSelectedRows();

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

@@ -150,7 +150,7 @@ export const getPrefixedEntities = (prefix) => html `
               design-system-prefix=${prefix}
               :uischema=${(x) => x.formUiSchema}
               readonly=${(x) => x.readonly}
-              @submit-success=${(x, c) => x.submitEntityChanges(c.event)}
+              @submit-success=${(x, c) => x.submitEntityChanges()}
             ></foundation-form>
           `)}
       </slot>