@genesislcap/foundation-entity-management 14.160.1 → 14.162.0

package/README.md

@@ -272,6 +272,26 @@ In contrast to Entity Management, we have a different way of displaying buttons
 For more information on `persist-column-state-key` see [the section in the Entity Management](#persist-column-state) page.
 :::
 
+## Installation
+
+To enable this module in your application, follow the steps below.
+
+1. Add `@genesislcap/foundation-entity-management` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+
+```json
+{
+  ...
+  "dependencies": {
+    ...
+    "@genesislcap/foundation-entity-management": "latest"
+    ...
+  },
+  ...
+}
+```
+
+## [API Docs](./docs/api/index.md)
+
 ## License
 
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.

package/dist/custom-elements.json

@@ -87,41 +87,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/components.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "loadRemotes"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "loadRemotes",
-          "declaration": {
-            "name": "loadRemotes",
-            "module": "src/components/components.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./components"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/entities/entities.styles.ts",
@@ -840,41 +805,27 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/layouts/default.ts",
+      "path": "src/components/components.ts",
       "declarations": [
         {
-          "kind": "variable",
-          "name": "loginLayout",
-          "default": "new FASTElementLayout(\n  html`\n    <div class=\"container\">\n      <div class=\"content\">\n        <slot></slot>\n      </div>\n    </div>\n  `,\n  baseLayoutCss,\n)"
-        },
-        {
-          "kind": "variable",
-          "name": "defaultLayout",
-          "default": "new FASTElementLayout(\n  html`\n    <div class=\"container\">\n      <div class=\"content\">\n        <slot></slot>\n      </div>\n    </div>\n  `,\n  css`\n    ${baseLayoutCss}\n  `,\n)"
+          "kind": "function",
+          "name": "loadRemotes"
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "loginLayout",
-          "declaration": {
-            "name": "loginLayout",
-            "module": "src/layouts/default.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "defaultLayout",
+          "name": "loadRemotes",
           "declaration": {
-            "name": "defaultLayout",
-            "module": "src/layouts/default.ts"
+            "name": "loadRemotes",
+            "module": "src/components/components.ts"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/layouts/index.ts",
+      "path": "src/components/index.ts",
       "declarations": [],
       "exports": [
         {
@@ -882,7 +833,7 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./default"
+            "package": "./components"
           }
         }
       ]
@@ -1460,6 +1411,55 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/layouts/default.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "loginLayout",
+          "default": "new FASTElementLayout(\n  html`\n    <div class=\"container\">\n      <div class=\"content\">\n        <slot></slot>\n      </div>\n    </div>\n  `,\n  baseLayoutCss,\n)"
+        },
+        {
+          "kind": "variable",
+          "name": "defaultLayout",
+          "default": "new FASTElementLayout(\n  html`\n    <div class=\"container\">\n      <div class=\"content\">\n        <slot></slot>\n      </div>\n    </div>\n  `,\n  css`\n    ${baseLayoutCss}\n  `,\n)"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "loginLayout",
+          "declaration": {
+            "name": "loginLayout",
+            "module": "src/layouts/default.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "defaultLayout",
+          "declaration": {
+            "name": "defaultLayout",
+            "module": "src/layouts/default.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/layouts/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./default"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/profiles/editProfileSchema.ts",
@@ -2611,6 +2611,7 @@
             "name": "FASTElement",
             "package": "@microsoft/fast-element"
           },
+          "deprecated": "- Use '\\@genesislcap/pbc-auth' instead. 'https://www.npmjs.com/package/\\@genesislcap/pbc-auth'",
           "tagName": "user-management",
           "customElement": true
         }

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

@@ -86,14 +86,14 @@ declare const Users_base: (new (...args: any[]) => {
     readonly shadowRoot: ShadowRoot;
     slot: string;
     readonly tagName: string;
-    attachShadow(init: ShadowRootInit): ShadowRoot; /**
-     * entityID used to control the definition of an optional entity column which is created with the {@link Users.entityColumn} function.
-     * @internal
-     */
+    attachShadow(init: ShadowRootInit): ShadowRoot;
     closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
     closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
     closest<E extends Element = Element>(selectors: string): E;
-    getAttribute(qualifiedName: string): string;
+    getAttribute(qualifiedName: string): string; /**
+     * Definition of the `DATASERVER` query which is used when managing Counterpartys
+     * @internal
+     */
     getAttributeNS(namespace: string, localName: string): string;
     getAttributeNames(): string[];
     getAttributeNode(qualifiedName: string): Attr;
@@ -363,7 +363,8 @@ declare const Users_base: (new (...args: any[]) => {
  *
  * Under the hood the user-management is the entity-management micro-frontend configured for use
  * with the `ALL_USERS` resource.
- *
+ * @deprecated - Use '\@genesislcap/pbc-auth' instead.
+ * 'https://www.npmjs.com/package/\@genesislcap/pbc-auth'
  * @public
  *
  * @example

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

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/users/users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAItD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAA4B,WAAW,EAAc,MAAM,yBAAyB,CAAC;AAC5F,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAQtD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;IAoC7B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oDA0LA;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA3LL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;;;OAGG;IACwD,eAAe,EAAE,OAAO,CAAS;IAE5F;;;OAGG;IACS,WAAW,EAAE,WAAW,CAAC;IAErC;;;;;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;IAe1B;;;OAGG;IACH,sBAAsB,CAAC,MAAM,KAAA;;;;;;;;IAW7B;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,KAAA;IAoCzB;;OAEG;IACG,YAAY,CAAC,IAAI,KAAA;;;;;;;;;;;;;;;CAwBxB"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/users/users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAItD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAA4B,WAAW,EAAc,MAAM,yBAAyB,CAAC;AAC5F,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAQtD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;IAoC7B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iDAiMA;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAlML;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;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;;;OAGG;IACwD,eAAe,EAAE,OAAO,CAAS;IAE5F;;;OAGG;IACS,WAAW,EAAE,WAAW,CAAC;IAErC;;;;;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;IAe1B;;;OAGG;IACH,sBAAsB,CAAC,MAAM,KAAA;;;;;;;;IAW7B;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,KAAA;IAoCzB;;OAEG;IACG,YAAY,CAAC,IAAI,KAAA;;;;;;;;;;;;;;;CAwBxB"}

package/dist/esm/users/users.js

@@ -39,7 +39,8 @@ export const UsersColumnConfig = [
  *
  * Under the hood the user-management is the entity-management micro-frontend configured for use
  * with the `ALL_USERS` resource.
- *
+ * @deprecated - Use '\@genesislcap/pbc-auth' instead.
+ * 'https://www.npmjs.com/package/\@genesislcap/pbc-auth'
  * @public
  *
  * @example

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

@@ -2419,7 +2419,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-entity-management!Users:class",
-          "docComment": "/**\n * Main class which defines the user management functionality\n *\n * @remarks\n *\n * Under the hood the user-management is the entity-management micro-frontend configured for use with the `ALL_USERS` resource.\n *\n * @example\n *\n * With no customisation required the user management micro-frontend can simply be dropped into the template as shown. However, it is advised to wrap it in an error boundary component.\n * ```javascript\n * <user-management></user-management>\n * ```\n *\n * With this default example above the columns will be the {@link UsersColumnConfig} as well as the entity and status columns. The entity and status columns are always added regardless of the other columns which are configured.\n *\n * You can add in additional customisation options. For example you can define a custom column and then mix-in with the standard columns\n * ```javascript\n * import { Users, UsersColumnConfig, } from '@genesislcap/foundation-entity-management';\n *\n * const userColumns = [\n *   {\n *     field: 'ACCESS_TYPE',\n *     headerName: 'Access Type',\n *   },\n * ];\n *\n * // Definition inside of the html template\n * <user-management :columns=${() => [...UsersColumnConfig, ...userColumns]}></user-management>\n * ```\n *\n * @public\n */\n",
+          "docComment": "/**\n * Main class which defines the user management functionality\n *\n * @remarks\n *\n * Under the hood the user-management is the entity-management micro-frontend configured for use with the `ALL_USERS` resource.\n *\n * @deprecated\n *\n * - Use '\\@genesislcap/pbc-auth' instead. 'https://www.npmjs.com/package/\\@genesislcap/pbc-auth'\n *\n * @example\n *\n * With no customisation required the user management micro-frontend can simply be dropped into the template as shown. However, it is advised to wrap it in an error boundary component.\n * ```javascript\n * <user-management></user-management>\n * ```\n *\n * With this default example above the columns will be the {@link UsersColumnConfig} as well as the entity and status columns. The entity and status columns are always added regardless of the other columns which are configured.\n *\n * You can add in additional customisation options. For example you can define a custom column and then mix-in with the standard columns\n * ```javascript\n * import { Users, UsersColumnConfig, } from '@genesislcap/foundation-entity-management';\n *\n * const userColumns = [\n *   {\n *     field: 'ACCESS_TYPE',\n *     headerName: 'Access Type',\n *   },\n * ];\n *\n * // Definition inside of the html template\n * <user-management :columns=${() => [...UsersColumnConfig, ...userColumns]}></user-management>\n * ```\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

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

@@ -757,7 +757,8 @@ declare type RouterSettings = {
  *
  * Under the hood the user-management is the entity-management micro-frontend configured for use
  * with the `ALL_USERS` resource.
- *
+ * @deprecated - Use '\@genesislcap/pbc-auth' instead.
+ * 'https://www.npmjs.com/package/\@genesislcap/pbc-auth'
  * @public
  *
  * @example
@@ -1021,14 +1022,14 @@ declare const Users_base: (new (...args: any[]) => {
     readonly shadowRoot: ShadowRoot;
     slot: string;
     readonly tagName: string;
-    attachShadow(init: ShadowRootInit): ShadowRoot; /**
-    * entityID used to control the definition of an optional entity column which is created with the {@link Users.entityColumn} function.
-    * @internal
-    */
+    attachShadow(init: ShadowRootInit): ShadowRoot;
     closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
     closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
     closest<E extends Element = Element>(selectors: string): E;
-    getAttribute(qualifiedName: string): string;
+    getAttribute(qualifiedName: string): string; /**
+    * Definition of the `DATASERVER` query which is used when managing Counterpartys
+    * @internal
+    */
     getAttributeNS(namespace: string, localName: string): string;
     getAttributeNames(): string[];
     getAttributeNode(qualifiedName: string): Attr;

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

@@ -4,6 +4,11 @@
 
 ## Users class
 
+> Warning: This API is now obsolete.
+> 
+> - Use '<!-- -->@<!-- -->genesislcap/pbc-auth' instead. 'https://www.npmjs.com/package/<!-- -->@<!-- -->genesislcap/pbc-auth'
+> 
+
 Main class which defines the user management functionality
 
 **Signature:**

package/docs/api-report.md

@@ -183,7 +183,7 @@ export class Profiles extends EntityManagement {
 
 // Warning: (ae-forgotten-export) The symbol "Users_base" needs to be exported by the entry point index.d.ts
 //
-// @public
+// @public @deprecated
 export class Users extends Users_base {
     constructor();
     // (undocumented)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-entity-management",
   "description": "Genesis Foundation Entity Management",
-  "version": "14.160.1",
+  "version": "14.162.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -43,29 +43,29 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.160.1",
-    "@genesislcap/genx": "14.160.1",
-    "@genesislcap/rollup-builder": "14.160.1",
-    "@genesislcap/ts-builder": "14.160.1",
-    "@genesislcap/uvu-playwright-builder": "14.160.1",
-    "@genesislcap/vite-builder": "14.160.1",
-    "@genesislcap/webpack-builder": "14.160.1",
+    "@genesislcap/foundation-testing": "14.162.0",
+    "@genesislcap/genx": "14.162.0",
+    "@genesislcap/rollup-builder": "14.162.0",
+    "@genesislcap/ts-builder": "14.162.0",
+    "@genesislcap/uvu-playwright-builder": "14.162.0",
+    "@genesislcap/vite-builder": "14.162.0",
+    "@genesislcap/webpack-builder": "14.162.0",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
     "@ag-grid-community/core": "29.2.0",
-    "@genesislcap/foundation-comms": "14.160.1",
-    "@genesislcap/foundation-errors": "14.160.1",
-    "@genesislcap/foundation-events": "14.160.1",
-    "@genesislcap/foundation-forms": "14.160.1",
-    "@genesislcap/foundation-logger": "14.160.1",
-    "@genesislcap/foundation-login": "14.160.1",
-    "@genesislcap/foundation-notifications": "14.160.1",
-    "@genesislcap/foundation-ui": "14.160.1",
-    "@genesislcap/foundation-utils": "14.160.1",
-    "@genesislcap/foundation-zero": "14.160.1",
-    "@genesislcap/foundation-zero-grid-pro": "14.160.1",
-    "@genesislcap/grid-pro": "14.160.1",
+    "@genesislcap/foundation-comms": "14.162.0",
+    "@genesislcap/foundation-errors": "14.162.0",
+    "@genesislcap/foundation-events": "14.162.0",
+    "@genesislcap/foundation-forms": "14.162.0",
+    "@genesislcap/foundation-logger": "14.162.0",
+    "@genesislcap/foundation-login": "14.162.0",
+    "@genesislcap/foundation-notifications": "14.162.0",
+    "@genesislcap/foundation-ui": "14.162.0",
+    "@genesislcap/foundation-utils": "14.162.0",
+    "@genesislcap/foundation-zero": "14.162.0",
+    "@genesislcap/foundation-zero-grid-pro": "14.162.0",
+    "@genesislcap/grid-pro": "14.162.0",
     "@microsoft/fast-components": "^2.30.6",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
@@ -81,5 +81,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "598e3599570a21709dfdc8e47adf5c77e5feff80"
+  "gitHead": "874e7ee403e4cfab01c6fb2542ae3264c7202831"
 }