@genesislcap/foundation-login 14.408.0 → 14.409.0

package/README.md

@@ -1,141 +1,25 @@
-# Foundation Login
+# @genesislcap/foundation-login
 
-> **Warning**: This package is deprecated and no longer maintained. We recommend using [@genesislcap/pbc-auth](https://www.npmjs.com/package/@genesislcap/pbc-auth) instead.
+Documentation for this package is published on the Genesis docs site:
 
-[API](./docs/api/index.md)
-
-## Introduction
-
-This micro front-end includes a set of identity management functions, such as authentication (including via SSO) and password reset. Many of the features can be turned on and off as desired, and parts of the login screen (such as the logo) can be customised.
-
-Login uses the [Credential Management API](https://developer.mozilla.org/en-US/docs/Web/API/Credential_Management_API), falling back to cookies when unavailable.
-
-An example of the main login screen: <br/>
-![Main login screen example](./docs/img/foundation-login_login-standard.png)
-
-An example of authentication via SSO: <br/>
-![Main login screen example](./docs/img/foundation-login_login-sso.png)
-
-<!-- An example of the forgotten password screen: <br/>
-![Main login screen example](./docs/img/foundation-login_forgotten-password.png) -->
-
-An example of the change password screen: <br/>
-![Main login screen example](./docs/img/foundation-login_change-password.png)
-
-<!-- An example of the request account screen: <br/>
-![Main login screen example](./docs/img/foundation-login_request-account.png) -->
-
-## Login set-up
-
-:::info
-If you build a project upon one of the Genesis seed apps, then the `Login` micro front-end will already be set up for you.
-:::
-
-To enable this micro front-end in your application, follow the steps below.
-
-1. Add `@genesislcap/foundation-login` as a dependency in your **package.json** file. Whenever you change the dependencies of your project, always run the `$ npm run bootstrap` or `$ npm run bootstrap:ignore-scripts` command again. You can see more information on the [package.json basics](https://learn.genesis.global/secure/web/micro-front-ends/foundation-login/) page.
-
-```javascript
-{
-  ...
-  "dependencies": {
-    "@genesislcap/foundation-login": "latest"
-  },
-  ...
-}
-```
-
-:::note
-This page assumes you're using the routing systems that are part of `foundation-ui`, and will cover set-up as part of that routing system.
-:::
-
-Once installed, you can either use `Login` as is or re-configure it. As with all our micro front-ends, you also have the option of lazy loading it.
-
-### Basic usage
-
-[Basic usage example](./docs/api/foundation-login.login.md#example)
-
-### Advanced usage
-
-[Advanced usage example](./docs/api/foundation-login.configure.md#example)
-
-## Public and private routes
-
-You may need to set up a `NavigationContributor` in your application's router config class to handle `public` and `autoAuth` route settings.
-
-- `public`, which indicates that a route doesn't require the user to be authenticated to view it
-- `autoAuth`, where, if the user already has an authenticated session, they are automatically logged in again if they navigate away from a page and then return
-
-```ts
-{
-    path: 'info',
-    element: Info,
-    title: 'Info',
-    name: 'info',
-    settings: { public: true },
-},
-{
-    path: 'admin',
-    element: Admin,
-    title: 'Admin',
-    name: 'admin',
-    settings: { autoAuth: true },
-}
-```
-
-:::warning
-By default, a route that isn't marked public is not. However, a non-public route isn't automatically going to block non-authenticated users from viewing them. This must be implemented in a `NavigationContributor`; see [example](./docs/api/foundation-login.login.md#example).
-:::
-
-## Authentication
-
-For authentication, most configuration is set in the back end. You should familiarise yourself with the [authentication section of the back-end](docs/03_server/05_access-control/01_introduction.md).
-
-### Username & password
-
-The standard authentication method is the user supplying their username and password. Even when SSO is enabled as an authentication method, the user will still have the option to sign in with their normal credentials.
-
-:::note
-Setting the `DEFAULT_USER` and `DEFAULT_PASSWORD` environment variables automatically populates the credentials in the login form, which can be useful during development so developers don't need to write out their credentials continuously. However, the browser may also offer auto-filling if you have previously chosen to save your credentials, which can make setting these unnecessary.
-:::
-
-### SSO
-
-SSO functionality allows the `Login` micro front-end to work with your company's existing authentication system, enabling them to have a single set of credentials - including those built on the Genesis low-code platform. Genesis supports SSO with both JWT and SAML.
-
-Setting up SSO is primarily [a back-end task](docs/03_server/05_access-control/04_sso_jwt.md); however, there is a small amount of front-end [sso configuration](docs/api/foundation-login.loginconfig.sso.md) required.
-
-:::note
-The standard process of SSO is that the SSO authentication provider flow is opened via a redirect in the current page. However, many authentication providers block their system when running in an iframe to prevent [clickjacking attacks](https://owasp.org/www-community/attacks/Clickjacking). Because of this, if the `Login` micro front-end detects that it is running in an iframe, it opens up the authentication provider in a popup instead.
-:::
-
-## Customising login
-
-The `Login` micro front-end can be customised using an exported `configure` function. See [configure](docs/api/foundation-login.configure.md) in the API docs for more information.
+**Docs: [Login](https://docs.genesis.global/docs/develop/client-capabilities/login/)**
 
 ## Installation
 
-To enable this module in your application, follow the steps below.
-
-1. Add `@genesislcap/foundation-login` 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.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/foundation-login": "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.
 
 ### Licensed components
+
 Genesis low-code platform

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-login",
   "description": "Genesis Foundation Login",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/foundation-login.d.ts",
@@ -69,21 +69,21 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.408.0",
-    "@genesislcap/foundation-i18n": "14.408.0",
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-ui": "14.408.0",
-    "@genesislcap/foundation-utils": "14.408.0",
-    "@genesislcap/foundation-zero": "14.408.0",
+    "@genesislcap/foundation-comms": "14.409.0",
+    "@genesislcap/foundation-i18n": "14.409.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-ui": "14.409.0",
+    "@genesislcap/foundation-utils": "14.409.0",
+    "@genesislcap/foundation-zero": "14.409.0",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0",
@@ -100,5 +100,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/foundation-login.configure.md

@@ -1,113 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [configure](./foundation-login.configure.md)
-
-## configure() function
-
-> Warning: This API is now obsolete.
-> 
-> - Please use foundation-auth instead.
-> 
-
-Configure the login micro frontend settings.
-
-**Signature:**
-
-```typescript
-export declare function configure(container: Container, config: Partial<LoginConfig>): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-container
-
-
-</td><td>
-
-Container
-
-
-</td><td>
-
-DI container.
-
-
-</td></tr>
-<tr><td>
-
-config
-
-
-</td><td>
-
-Partial&lt;[LoginConfig](./foundation-login.loginconfig.md)<!-- -->&gt;
-
-
-</td><td>
-
-A partial LoginConfig.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Remarks
-
-This is primarily for general settings, rather than re-defining the element, static templating / style changes.
-
-## Example
-
-Configuring login on lazy load
-
-```ts
-name: 'login',
-path: 'login',
-title: 'Login',
-element: async () => {
-  const { configure, define, defaultLoginConfig } = await import('@genesislcap/foundation-login');
-  configure(this.container, {
-    autoConnect: true,
-    omitRoutes: ['request-account'],
-    fields: {
-      ...defaultLoginConfig.fields,
-      organisation: {
-        label: 'CompID',
-      },
-    },
-    hostPath: 'login',
-    defaultRedirectUrl: 'dashboard',
-    logo: loginLogo,
-    background: loginBG,
-  });
-  // You can import and return `Login` directly here or re-define it completely via `define`.
-  return define({
-    name: `nexus-login`,
-  });
-},
-layout: loginLayout,
-settings: { public: true },
-childRouters: true,
-```
-

package/docs/api/foundation-login.defaultapihost.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [defaultApiHost](./foundation-login.defaultapihost.md)
-
-## defaultApiHost variable
-
-
-**Signature:**
-
-```typescript
-defaultApiHost: string
-```

package/docs/api/foundation-login.defaultloginconfig.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [defaultLoginConfig](./foundation-login.defaultloginconfig.md)
-
-## defaultLoginConfig variable
-
-Default LoginConfig DI implementation.
-
-**Signature:**
-
-```typescript
-defaultLoginConfig: LoginConfig
-```

package/docs/api/foundation-login.defaultloginrouting.getroutepath.md

@@ -1,51 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [DefaultLoginRouting](./foundation-login.defaultloginrouting.md) &gt; [getRoutePath](./foundation-login.defaultloginrouting.getroutepath.md)
-
-## DefaultLoginRouting.getRoutePath() method
-
-
-**Signature:**
-
-```typescript
-getRoutePath(route: string): string;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-route
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-

package/docs/api/foundation-login.defaultloginrouting.md

@@ -1,61 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [DefaultLoginRouting](./foundation-login.defaultloginrouting.md)
-
-## DefaultLoginRouting class
-
-Default LoginRouting.
-
-**Signature:**
-
-```typescript
-export declare class DefaultLoginRouting implements LoginRouting 
-```
-**Implements:** [LoginRouting](./foundation-login.loginrouting.md)
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[getRoutePath(route)](./foundation-login.defaultloginrouting.getroutepath.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[navigateTo(route)](./foundation-login.defaultloginrouting.navigateto.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-login.defaultloginrouting.navigateto.md

@@ -1,51 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [DefaultLoginRouting](./foundation-login.defaultloginrouting.md) &gt; [navigateTo](./foundation-login.defaultloginrouting.navigateto.md)
-
-## DefaultLoginRouting.navigateTo() method
-
-
-**Signature:**
-
-```typescript
-navigateTo(route: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-route
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-login.defaultorganisation.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [defaultOrganisation](./foundation-login.defaultorganisation.md)
-
-## defaultOrganisation variable
-
-
-**Signature:**
-
-```typescript
-defaultOrganisation: string
-```

package/docs/api/foundation-login.defaultpassword.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [defaultPassword](./foundation-login.defaultpassword.md)
-
-## defaultPassword variable
-
-
-**Signature:**
-
-```typescript
-defaultPassword: string
-```

package/docs/api/foundation-login.defaultsocketext.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [defaultSocketExt](./foundation-login.defaultsocketext.md)
-
-## defaultSocketExt variable
-
-
-**Signature:**
-
-```typescript
-defaultSocketExt: string
-```

package/docs/api/foundation-login.defaulttemplateoptions.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [defaultTemplateOptions](./foundation-login.defaulttemplateoptions.md)
-
-## defaultTemplateOptions variable
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-The default template options this MF has been created with.
-
-**Signature:**
-
-```typescript
-defaultTemplateOptions: TemplateOptions
-```

package/docs/api/foundation-login.defaultuser.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [defaultUser](./foundation-login.defaultuser.md)
-
-## defaultUser variable
-
-
-**Signature:**
-
-```typescript
-defaultUser: string
-```

package/docs/api/foundation-login.define.md

@@ -1,38 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [define](./foundation-login.define.md)
-
-## define variable
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Re-define the login micro frontend.
-
-**Signature:**
-
-```typescript
-define: import("@genesislcap/foundation-ui").DefineFunction<typeof Login>
-```
-
-## Example
-
-
-```ts
-import { define, styles, template, defaultTemplateOptions } from '@genesislcap/foundation-login';
-const customTemplateOptions = {
-  ...defaultTemplateOptions,
-  ...customOptions,
-}
-export const AppLogin = define({
-  name: `nexus-login`,
-  template: template(customTemplateOptions),
-  styles: css`
-    ${styles(customTemplateOptions)}
-    some-element {
-      background-color: #ff00b4;
-    }
- `,
-});
-```
-

package/docs/api/foundation-login.definition.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [definition](./foundation-login.definition.md)
-
-## definition variable
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-definition: PartialFASTElementDefinition
-```
-
-## Remarks
-
-This is the main definition of this micro frontend which is exposed for user reconfiguration.
-