@genesislcap/foundation-entity-management 14.69.4 → 14.69.5

package/dist/custom-elements.json

@@ -1946,7 +1946,7 @@
           "type": {
             "text": "ViewTemplate"
           },
-          "default": "html<Users>`\n  <entity-management\n    resourceName=${(x) => x.resourceName}\n    title=\"User Management\"\n    entityLabel=\"User\"\n    createEvent=\"${(x) => x.createEvent}\"\n    :readEventFn=${(x) => (user) => x.readUserData(user)}\n    updateEvent=\"${(x) => x.updateEvent}\"\n    deleteEvent=\"${(x) => x.deleteEvent}\"\n    entityLabel=\"User Details\"\n    :updateFormUiSchema=${(x) =>\n      editUserSchema(\n        true,\n        x.allAccessType,\n        x.entityID,\n        x.entityLabel,\n        x.entityLabelKey,\n        x.availableEntitiesEndpoint,\n        x.additionalUpdateFields,\n      )}\n    :createFormUiSchema=${(x) =>\n      editUserSchema(\n        false,\n        x.allAccessType,\n        x.entityID,\n        x.entityLabel,\n        x.entityLabelKey,\n        x.availableEntitiesEndpoint,\n        x.additionalCreateFields,\n      )}\n    persist-column-state-key=\"entity_users_management\"\n    size-columns-to-fit\n    :columns=${(x) => [...x.columns, ...x.entityColumn(), x.statusColumn()]}\n    :datasourceConfig=${(x) => x.datasourceConfig}\n  ></entity-management>\n`"
+          "default": "html<Users>`\n  <entity-management\n    resourceName=${(x) => x.resourceName}\n    title=\"User Management\"\n    entityLabel=\"User\"\n    createEvent=\"${(x) => x.createEvent}\"\n    :readEventFn=${(x) => (user) => x.readUserData(user)}\n    updateEvent=\"${(x) => x.updateEvent}\"\n    deleteEvent=\"${(x) => x.deleteEvent}\"\n    entityLabel=\"User Details\"\n    :updateFormUiSchema=${(x) =>\n      editUserSchema(\n        true,\n        x.allAccessType,\n        x.entityID,\n        x.entityLabel,\n        x.entityLabelKey,\n        x.availableEntitiesEndpoint,\n        x.additionalUpdateFields,\n      )}\n    :createFormUiSchema=${(x) =>\n      editUserSchema(\n        false,\n        x.allAccessType,\n        x.entityID,\n        x.entityLabel,\n        x.entityLabelKey,\n        x.availableEntitiesEndpoint,\n        x.additionalCreateFields,\n      )}\n    persist-column-state-key=${(x) => x.persistColumnStateKey}\n    size-columns-to-fit\n    :columns=${(x) => [...x.columns, ...x.entityColumn(), x.statusColumn()]}\n    :datasourceConfig=${(x) => x.datasourceConfig}\n  ></entity-management>\n`"
         }
       ],
       "exports": [
@@ -1979,6 +1979,16 @@
           "description": "Main class which defines the user management functionality",
           "name": "Users",
           "members": [
+            {
+              "kind": "field",
+              "name": "persistColumnStateKey",
+              "type": {
+                "text": "string"
+              },
+              "default": "'entity_users_management'",
+              "description": "This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.",
+              "privacy": "public"
+            },
             {
               "kind": "field",
               "name": "columns",
@@ -2053,6 +2063,17 @@
               }
             }
           ],
+          "attributes": [
+            {
+              "name": "persist-column-state-key",
+              "type": {
+                "text": "string"
+              },
+              "default": "'entity_users_management'",
+              "description": "This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.",
+              "fieldName": "persistColumnStateKey"
+            }
+          ],
           "mixins": [
             {
               "name": "LifecycleMixin",

package/dist/dts/users/users.d.ts

@@ -66,9 +66,7 @@ declare const Users_base: (new (...args: any[]) => {
     readonly attributes: NamedNodeMap;
     readonly classList: DOMTokenList;
     className: string;
-    readonly clientHeight: number; /**
-     * Column definition, default to the UsersColumnConfig
-     */
+    readonly clientHeight: number;
     readonly clientLeft: number;
     readonly clientTop: number;
     readonly clientWidth: number;
@@ -93,7 +91,9 @@ declare const Users_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;
+    getAttributeNS(namespace: string, localName: string): string; /**
+     * String which contains event if we have permission to delete user of empty string if not
+     */
     getAttributeNames(): string[];
     getAttributeNode(qualifiedName: string): Attr;
     getAttributeNodeNS(namespace: string, localName: string): Attr;
@@ -147,6 +147,15 @@ declare const Users_base: (new (...args: any[]) => {
     readonly parentNode: ParentNode;
     readonly previousSibling: ChildNode;
     textContent: string;
+    /**
+     * Changes the status of an entity
+     *
+     * @remarks
+     *
+     * The action which is run on the status button from {@link Users.statusRendererSelector}
+     *
+     * @internal
+     */
     appendChild<T_1 extends Node>(node: T_1): T_1;
     compareDocumentPosition(other: Node): number;
     contains(other: Node): boolean;
@@ -427,6 +436,17 @@ export declare class Users extends Users_base {
      * @internal
      */
     resourceName: string;
+    /**
+     * This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.
+     *
+     * @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.
+     * @public
+     */
+    persistColumnStateKey: string;
     /**
      * Returns a configuration for an optional status column
      *

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

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/users/users.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAA4B,WAAW,EAAc,MAAM,yBAAyB,CAAC;AAC5F,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAWtD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;IAoC7B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mCA2HA;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA3HL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBASa,KAAM,SAAQ,UAA2B;IACpD;;;;;;;;OAQG;IACM,OAAO,CAAC,OAAO,CAAU;IAElC;;;;;;;;OAQG;IACG,OAAO,CAAC,IAAI,CAAO;IAEzB;;;;;;;OAOG;IACS,gBAAgB,EAAE,uBAAuB,CAAC;IAEtD;;;OAGG;IACG,YAAY,SAAe;IAEjC;;;;;OAKG;IACI,YAAY;;;;;;;;;;;;IAYnB;;;;;OAKG;IACI,YAAY;;;;;;;;IAYnB;;OAEG;IACS,OAAO,EAAE,GAAG,CAAqB;IAEjC,sBAAsB,EAAE,GAAG,CAAM;IACjC,sBAAsB,EAAE,GAAG,CAAM;IAEjC,aAAa,EAAE,OAAO,CAAC;IACnC,OAAO,CAAC,aAAa,CAAS;IAE9B;;OAEG;IACS,WAAW,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACS,WAAW,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACS,WAAW,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACG,QAAQ,EAAE,MAAM,CAAqB;IAE3C;;;OAGG;IACG,cAAc,EAAE,MAAM,CAAU;IAEtC;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAkB;IAE3C;;;OAGG;IACG,yBAAyB,EAAE,MAAM,CAAuB;IAE9D;;OAEG;;IAaG,iBAAiB;IAcd,SAAS,IAAI,IAAI;IAc1B;;;OAGG;IACH,sBAAsB,CAAC,MAAM,KAAA;;;;;;;;IAW7B;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,KAAA;IAwCzB;;OAEG;IACG,YAAY,CAAC,IAAI,KAAA;;;;;;;;;;;;;;;CAwBxB"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/users/users.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAA4B,WAAW,EAAc,MAAM,yBAAyB,CAAC;AAC5F,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAWtD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;IAoC7B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kEAwJA;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0FH;;;;;;;;OAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA1PL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBASa,KAAM,SAAQ,UAA2B;IACpD;;;;;;;;OAQG;IACM,OAAO,CAAC,OAAO,CAAU;IAElC;;;;;;;;OAQG;IACG,OAAO,CAAC,IAAI,CAAO;IAEzB;;;;;;;OAOG;IACS,gBAAgB,EAAE,uBAAuB,CAAC;IAEtD;;;OAGG;IACG,YAAY,SAAe;IAEjC;;;;;;;;;OASG;IAC8C,qBAAqB,EAAE,MAAM,CAClD;IAE5B;;;;;OAKG;IACI,YAAY;;;;;;;;;;;;IAYnB;;;;;OAKG;IACI,YAAY;;;;;;;;IAYnB;;OAEG;IACS,OAAO,EAAE,GAAG,CAAqB;IAEjC,sBAAsB,EAAE,GAAG,CAAM;IACjC,sBAAsB,EAAE,GAAG,CAAM;IAEjC,aAAa,EAAE,OAAO,CAAC;IACnC,OAAO,CAAC,aAAa,CAAS;IAE9B;;OAEG;IACS,WAAW,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACS,WAAW,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACS,WAAW,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACG,QAAQ,EAAE,MAAM,CAAqB;IAE3C;;;OAGG;IACG,cAAc,EAAE,MAAM,CAAU;IAEtC;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAkB;IAE3C;;;OAGG;IACG,yBAAyB,EAAE,MAAM,CAAuB;IAE9D;;OAEG;;IAaG,iBAAiB;IAcd,SAAS,IAAI,IAAI;IAc1B;;;OAGG;IACH,sBAAsB,CAAC,MAAM,KAAA;;;;;;;;IAW7B;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,KAAA;IAwCzB;;OAEG;IACG,YAAY,CAAC,IAAI,KAAA;;;;;;;;;;;;;;;CAwBxB"}

package/dist/esm/users/users.js

@@ -105,6 +105,17 @@ let Users = class Users extends LifecycleMixin(FASTElement) {
          * @internal
          */
         this.resourceName = 'ALL_USERS';
+        /**
+         * This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.
+         *
+         * @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.
+         * @public
+         */
+        this.persistColumnStateKey = 'entity_users_management';
         /**
          * Column definition, default to the UsersColumnConfig
          */
@@ -254,6 +265,9 @@ __decorate([
 __decorate([
     attr
 ], Users.prototype, "resourceName", void 0);
+__decorate([
+    attr({ attribute: 'persist-column-state-key' })
+], Users.prototype, "persistColumnStateKey", void 0);
 __decorate([
     observable
 ], Users.prototype, "columns", void 0);

package/dist/esm/users/users.template.js

@@ -82,7 +82,7 @@ export const UsersTemplate = html `
     entityLabel="User Details"
     :updateFormUiSchema=${(x) => editUserSchema(true, x.allAccessType, x.entityID, x.entityLabel, x.entityLabelKey, x.availableEntitiesEndpoint, x.additionalUpdateFields)}
     :createFormUiSchema=${(x) => editUserSchema(false, x.allAccessType, x.entityID, x.entityLabel, x.entityLabelKey, x.availableEntitiesEndpoint, x.additionalCreateFields)}
-    persist-column-state-key="entity_users_management"
+    persist-column-state-key=${(x) => x.persistColumnStateKey}
     size-columns-to-fit
     :columns=${(x) => [...x.columns, ...x.entityColumn(), x.statusColumn()]}
     :datasourceConfig=${(x) => x.datasourceConfig}

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

@@ -2285,6 +2285,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-entity-management!Users#persistColumnStateKey:member",
+              "docComment": "/**\n * This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.\n *\n * @remarks\n *\n * 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.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "persistColumnStateKey: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "persistColumnStateKey",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-entity-management!Users#updateEvent:member",

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

@@ -774,6 +774,17 @@ export declare class Users extends Users_base {
      * @internal
      */
     resourceName: string;
+    /**
+     * This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`.
+     *
+     * @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.
+     * @public
+     */
+    persistColumnStateKey: string;
     /**
      * Returns a configuration for an optional status column
      *
@@ -933,9 +944,7 @@ declare const Users_base: (new (...args: any[]) => {
     readonly attributes: NamedNodeMap;
     readonly classList: DOMTokenList;
     className: string;
-    readonly clientHeight: number; /**
-    * Column definition, default to the UsersColumnConfig
-    */
+    readonly clientHeight: number;
     readonly clientLeft: number;
     readonly clientTop: number;
     readonly clientWidth: number;
@@ -960,7 +969,9 @@ declare const Users_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;
+    getAttributeNS(namespace: string, localName: string): string; /**
+    * String which contains event if we have permission to delete user of empty string if not
+    */
     getAttributeNames(): string[];
     getAttributeNode(qualifiedName: string): Attr;
     getAttributeNodeNS(namespace: string, localName: string): Attr;
@@ -1014,6 +1025,15 @@ declare const Users_base: (new (...args: any[]) => {
     readonly parentNode: ParentNode;
     readonly previousSibling: ChildNode;
     textContent: string;
+    /**
+     * Changes the status of an entity
+     *
+     * @remarks
+     *
+     * The action which is run on the status button from {@link Users.statusRendererSelector}
+     *
+     * @internal
+     */
     appendChild<T_1 extends Node>(node: T_1): T_1;
     compareDocumentPosition(other: Node): number;
     contains(other: Node): boolean;

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

@@ -58,6 +58,7 @@ const userColumns = [
 |  [columns](./foundation-entity-management.users.columns.md) |  | any | Column definition, default to the UsersColumnConfig |
 |  [createEvent](./foundation-entity-management.users.createevent.md) |  | string | String which contains event if we have permission to insert user of empty string if not |
 |  [deleteEvent](./foundation-entity-management.users.deleteevent.md) |  | string | String which contains event if we have permission to delete user of empty string if not |
+|  [persistColumnStateKey](./foundation-entity-management.users.persistcolumnstatekey.md) |  | string | This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to <code>entity_users_management</code>. |
 |  [updateEvent](./foundation-entity-management.users.updateevent.md) |  | string | String which contains event if we have permission to update user of empty string if not |
 
 ## Methods

package/docs/api/foundation-entity-management.users.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; [Users](./foundation-entity-management.users.md) &gt; [persistColumnStateKey](./foundation-entity-management.users.persistcolumnstatekey.md)
+
+## Users.persistColumnStateKey property
+
+This attribute controls whether and how the user manager stores the state of the columns when the user edits them. Defaulted to `entity_users_management`<!-- -->.
+
+**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.
+

package/docs/api-report.md

@@ -205,6 +205,7 @@ export class Users extends Users_base {
     entityLabel: string;
     // @internal
     entityLabelKey: string;
+    persistColumnStateKey: string;
     // @internal (undocumented)
     readUserData(user: any): Promise<{
         USER_PROFILES: any[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-entity-management",
   "description": "Genesis Foundation Entity Management",
-  "version": "14.69.4",
+  "version": "14.69.5",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -41,21 +41,21 @@
   },
   "devDependencies": {
     "@genesislcap/foundation-login": "^14.40.0",
-    "@genesislcap/foundation-testing": "14.69.4",
-    "@genesislcap/genx": "14.69.4",
+    "@genesislcap/foundation-testing": "14.69.5",
+    "@genesislcap/genx": "14.69.5",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
     "@ag-grid-community/core": "29.2.0",
-    "@genesislcap/foundation-comms": "14.69.4",
-    "@genesislcap/foundation-errors": "14.69.4",
-    "@genesislcap/foundation-forms": "14.69.4",
-    "@genesislcap/foundation-login": "14.69.4",
-    "@genesislcap/foundation-ui": "14.69.4",
-    "@genesislcap/foundation-utils": "14.69.4",
-    "@genesislcap/foundation-zero": "14.69.4",
-    "@genesislcap/foundation-zero-grid-pro": "14.69.4",
-    "@genesislcap/grid-pro": "14.69.4",
+    "@genesislcap/foundation-comms": "14.69.5",
+    "@genesislcap/foundation-errors": "14.69.5",
+    "@genesislcap/foundation-forms": "14.69.5",
+    "@genesislcap/foundation-login": "14.69.5",
+    "@genesislcap/foundation-ui": "14.69.5",
+    "@genesislcap/foundation-utils": "14.69.5",
+    "@genesislcap/foundation-zero": "14.69.5",
+    "@genesislcap/foundation-zero-grid-pro": "14.69.5",
+    "@genesislcap/grid-pro": "14.69.5",
     "@microsoft/fast-components": "^2.21.3",
     "@microsoft/fast-element": "^1.7.0",
     "@microsoft/fast-foundation": "^2.33.2",
@@ -71,5 +71,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "925fcce3220054f613f3ddf3c2455c1a0ad3c208"
+  "gitHead": "0b36b06226cbf24f2809b3292f8f60ca44c6c549"
 }