@genesislcap/foundation-login 14.408.0 → 14.409.0

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

@@ -1,33 +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; [SSOConfig](./foundation-login.ssoconfig.md)
-
-## SSOConfig type
-
-If you don't provide SSOConfig on the login config then SSO is disabled completely.
-
-**Signature:**
-
-```typescript
-export type SSOConfig = {
-    toggled?: boolean;
-    identityProvidersPath: string;
-};
-```
-
-## Remarks
-
-`toggled` - Optionally toggle the SSO journey on/off by default. If `toggled` is set to `true`<!-- -->, the SSO option is presented as enabled to the user (e.g., the SSO checkbox is checked, or SSO providers are immediately displayed). If `toggled` is set to `false` (or if the parameter is omitted entirely), the SSO option starts as disabled. The user would then need to explicitly enable it (e.g., by checking a checkbox) to initiate the SSO flow.
-
-`identityProvidersPath` - The identity providers path under the current host. This is a \*required\* string parameter. It specifies the URL path where the application can fetch the list of available Identity Providers (IDPs) for SSO. This path is relative to the `API_HOST` or the `host` you are setting in the parent component. The login component will make a request to this endpoint to retrieve the IDPs. The response from this endpoint is expected to be in a format that the component can understand (as defined by the `IDP` and `IDPResponse` types in your code). The response is expected to be a JSON object containing an array of identity providers. Example: If your `API_HOST` is `https://example.com/gwf` and `identityProvidersPath` is set to `'sso/list'`<!-- -->, the component will fetch the IDP list from `https://example.com/gwf/sso/list`<!-- -->. This endpoint should be implemented on your backend to return the available SSO providers.
-
-## Example
-
-
-```ts
-const config: SSOConfig = {
-  toggled: true,
-  identityProvidersPath: 'sso/list',
-}
-```
-

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

@@ -1,62 +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; [styles](./foundation-login.styles.md)
-
-## styles() function
-
-**Signature:**
-
-```typescript
-styles: (options: TemplateOptions) => import("@microsoft/fast-element").ElementStyles
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-[TemplateOptions](./foundation-login.templateoptions.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-import("@microsoft/fast-element").ElementStyles
-
-## Example
-
-unknown target
-
-```
-const buttonTag = tagFor(options.button);
-...
-${buttonTag} {
-  width: 200px;
-}
-```
-

package/docs/api/foundation-login.template.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; [template](./foundation-login.template.md)
-
-## template() function
-
-
-**Signature:**
-
-```typescript
-template: (options: TemplateOptions) => import("@microsoft/fast-element").ViewTemplate<Login, any>
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-[TemplateOptions](./foundation-login.templateoptions.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-import("@microsoft/fast-element").ViewTemplate&lt;[Login](./foundation-login.login.md)<!-- -->, any&gt;
-

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

@@ -1,25 +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; [TemplateComponents](./foundation-login.templatecomponents.md)
-
-## TemplateComponents type
-
-> 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
-export type TemplateComponents = {
-    anchor: TemplateElementDependency;
-    button: TemplateElementDependency;
-    card: TemplateElementDependency;
-    checkbox: TemplateElementDependency;
-    listboxOption: TemplateElementDependency;
-    provider: TemplateElementDependency;
-    router: TemplateElementDependency;
-    select: TemplateElementDependency;
-    textField: TemplateElementDependency;
-};
-```

package/docs/api/foundation-login.templateoptions.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; [TemplateOptions](./foundation-login.templateoptions.md)
-
-## TemplateOptions type
-
-> 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
-export type TemplateOptions = TemplateComponents & {
-    somePartial?: string | SyntheticViewTemplate;
-};
-```
-**References:** [TemplateComponents](./foundation-login.templatecomponents.md)
-

package/docs/api/index.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[@genesislcap/foundation-login](./foundation-login.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api-report.md.api.md

@@ -1,446 +0,0 @@
-## API Report File for "@genesislcap/foundation-login"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { Auth } from '@genesislcap/foundation-comms';
-import { Binding } from '@microsoft/fast-element';
-import { Connect } from '@genesislcap/foundation-comms';
-import { Container } from '@microsoft/fast-foundation';
-import { CredentialManager } from '@genesislcap/foundation-comms';
-import { DefineFunction } from '@genesislcap/foundation-ui';
-import { ElementStyles } from '@microsoft/fast-element';
-import { FASTElement } from '@microsoft/fast-element';
-import { FoundationRouterConfiguration } from '@genesislcap/foundation-ui';
-import { I18next } from '@genesislcap/foundation-i18n';
-import { I18nextConfig } from '@genesislcap/foundation-i18n';
-import { InterfaceSymbol } from '@microsoft/fast-foundation';
-import { Message } from '@genesislcap/foundation-comms';
-import { MessageBuilder } from '@genesislcap/foundation-comms';
-import { PartialFASTElementDefinition } from '@microsoft/fast-element';
-import { Session } from '@genesislcap/foundation-comms';
-import { SyntheticViewTemplate } from '@microsoft/fast-element';
-import { TemplateElementDependency } from '@genesislcap/foundation-ui';
-import { ViewTemplate } from '@microsoft/fast-element';
-import { ZeroButtonAppearance } from '@genesislcap/foundation-zero';
-
-// Warning: (ae-internal-missing-underscore) The name "backButton" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const backButton: <T extends ConfigHost>(binding: Binding, label: string) => ViewTemplate<T, any>;
-
-// Warning: (ae-internal-missing-underscore) The name "BackgroundElement" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export class BackgroundElement extends ConfigHostElement {
-    // (undocumented)
-    connectedCallback(): void;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "BaseRoute" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export class BaseRoute extends ConfigHostElement {
-    // (undocumented)
-    auth: Auth;
-    // (undocumented)
-    autofill(): Promise<boolean>;
-    // (undocumented)
-    clearError(): void;
-    // (undocumented)
-    connect: Connect;
-    // (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    credentialManager: CredentialManager;
-    // (undocumented)
-    email: string;
-    // (undocumented)
-    ensureConnection(): Promise<boolean>;
-    // (undocumented)
-    hasErrors: boolean;
-    // (undocumented)
-    host: string;
-    // (undocumented)
-    isSubmitting: boolean;
-    // (undocumented)
-    message: string;
-    // (undocumented)
-    messageBuilder: MessageBuilder;
-    // (undocumented)
-    onBack: () => void;
-    // (undocumented)
-    onNavigate: (routeName: Routes, params?: Object, trigger?: boolean) => void;
-    // (undocumented)
-    onSubmit(): Promise<void>;
-    // (undocumented)
-    organisation: string;
-    // (undocumented)
-    get orgUsername(): string;
-    // (undocumented)
-    password: string;
-    // (undocumented)
-    password2: string;
-    // (undocumented)
-    queueOnBack(delay?: number): void;
-    // (undocumented)
-    sendMessage<T = any>(message: Message<T>, successFeedback?: string, successCallback?: (result: any) => void, delayBack?: number): Promise<void>;
-    // (undocumented)
-    session: Session;
-    // (undocumented)
-    setError(message: string): void;
-    // (undocumented)
-    showPassword: boolean;
-    // (undocumented)
-    storeCredentials(password?: string): void;
-    // (undocumented)
-    toLocalisedText(text: string): string;
-    // (undocumented)
-    username: string;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "ConfigHost" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export type ConfigHost = {
-    config: LoginConfig;
-};
-
-// Warning: (ae-internal-missing-underscore) The name "ConfigHostElement" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export class ConfigHostElement extends FASTElement implements ConfigHost {
-    // (undocumented)
-    config: LoginConfig;
-    // (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    container: Container;
-    i18next: I18next;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "configurableTextField" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const configurableTextField: <T extends ConfigHost>(name: keyof FieldConfigMap | [name: keyof FieldConfigMap, valueKey: string], type: string, autofocus?: boolean, autocomplete?: string, className?: string, labelOverride?: string, testIdOverride?: string, required?: boolean) => ViewTemplate<T, any>;
-
-// @public @deprecated
-export function configure(container: Container, config: Partial<LoginConfig>): void;
-
-// @public (undocumented)
-export const defaultApiHost: string;
-
-// @public
-export const defaultLoginConfig: LoginConfig;
-
-// @public
-export class DefaultLoginRouting implements LoginRouting {
-    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "LoginRouting" has more than one declaration; you need to add a TSDoc member reference selector
-    //
-    // (undocumented)
-    getRoutePath(route: string): string;
-    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "LoginRouting" has more than one declaration; you need to add a TSDoc member reference selector
-    //
-    // (undocumented)
-    navigateTo(route: string): void;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "defaultOnBackMS" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const defaultOnBackMS = 3000;
-
-// @public (undocumented)
-export const defaultOrganisation: string;
-
-// @public (undocumented)
-export const defaultPassword: string;
-
-// @public (undocumented)
-export const defaultSocketExt: string;
-
-// @beta
-export const defaultTemplateOptions: TemplateOptions;
-
-// @public (undocumented)
-export const defaultUser: string;
-
-// @beta
-export const define: DefineFunction<typeof Login>;
-
-// @beta (undocumented)
-export const definition: PartialFASTElementDefinition;
-
-// Warning: (ae-internal-missing-underscore) The name "emailField" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const emailField: <T extends BaseRoute>() => ViewTemplate<T, any>;
-
-// @public
-export const fetchIDPs: (path?: string, host?: string) => Promise<IDP[]>;
-
-// @public
-export type FieldConfig = {
-    label: string;
-    value?: any;
-    required?: boolean;
-    pattern?: string;
-    title?: string;
-};
-
-// @public (undocumented)
-export type FieldConfigMap = {
-    organisation: FieldConfig | null;
-    username: FieldConfig;
-    email: FieldConfig;
-    password: FieldConfig;
-};
-
-// @public
-export function getLoginRouting(): LoginRouting;
-
-// @public
-export const getSSOLoginURL: (idp: any, path?: string, host?: string) => string;
-
-// @public (undocumented)
-export const hostEnv: string;
-
-// @public (undocumented)
-export const hostUrl: string;
-
-// @public (undocumented)
-export interface IDP {
-    // (undocumented)
-    id: string;
-    // (undocumented)
-    type: string;
-}
-
-// @public (undocumented)
-export interface IDPResponse {
-    // (undocumented)
-    ID: string;
-    // (undocumented)
-    TYPE: string;
-}
-
-// @public
-export function isMFRoute(pathname?: string): boolean;
-
-// @public @deprecated
-export class Login extends FASTElement {
-    // @internal
-    checkForSSOToken(): void;
-    // @internal
-    config: MainRouterConfig;
-    // @internal (undocumented)
-    connectedCallback(): Promise<void>;
-    // @internal
-    container: Container;
-    // @internal
-    i18next: I18next;
-    // @internal
-    provider: FASTElement;
-    // @internal
-    ready: boolean;
-    // @internal
-    registerCommonComponents(): Promise<void>;
-    // @internal (undocumented)
-    protected registerDIDependencies(): void;
-    // @internal
-    session: Session;
-}
-
-// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "LoginConfig" because one of its declarations is marked as @internal
-//
-// @public
-export interface LoginConfig {
-    autoAuth: boolean;
-    autoConnect: boolean;
-    background: ElementStyles;
-    defaultRedirectUrl: string;
-    fields: FieldConfigMap;
-    hostPath: string;
-    localizationResources?: I18nextConfig['resources'];
-    logo: ElementStyles | null;
-    logoAltText: string;
-    messageDelays?: MessageDelays;
-    omitRedirectUrls: string[];
-    omitRoutes: Exclude<Routes, 'login' | 'not-found'>[];
-    redirectHandler?: (url: string) => void;
-    showConnectionIndicator: boolean;
-    showEnvironmentIndicator?: boolean;
-    sso: SSOConfig | null;
-    submitButtonAppearance?: ZeroButtonAppearance;
-    versionInformation?: string;
-}
-
-// @internal
-export const LoginConfig: InterfaceSymbol<LoginConfig>;
-
-// @beta @deprecated (undocumented)
-export class LoginHosted extends Login {
-    // (undocumented)
-    registerCommonComponents(): Promise<void>;
-}
-
-// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "LoginRouting" because one of its declarations is marked as @internal
-//
-// @public
-export interface LoginRouting {
-    // Warning: (ae-forgotten-export) The symbol "getRoutePath" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The package "@genesislcap/foundation-login" does not have an export "getRoutePath"
-    //
-    // (undocumented)
-    getRoutePath: typeof getRoutePath;
-    // Warning: (ae-forgotten-export) The symbol "navigateTo" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The package "@genesislcap/foundation-login" does not have an export "navigateTo"
-    //
-    // (undocumented)
-    navigateTo: typeof navigateTo;
-}
-
-// @internal
-export const LoginRouting: InterfaceSymbol<LoginRouting>;
-
-// Warning: (ae-internal-missing-underscore) The name "LogoElement" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export class LogoElement extends ConfigHostElement {
-}
-
-// Warning: (ae-internal-missing-underscore) The name "MainRouterConfig" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export class MainRouterConfig extends FoundationRouterConfiguration<Settings> {
-    constructor(auth: Auth, loginConfig?: LoginConfig);
-    // (undocumented)
-    configure(): void;
-}
-
-// @public (undocumented)
-export type MessageDelayKey = 'forgotPassword' | 'resetPassword' | 'base';
-
-// @public (undocumented)
-export type MessageDelays = Partial<Record<MessageDelayKey, number>>;
-
-// Warning: (ae-internal-missing-underscore) The name "MessageElement" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export class MessageElement extends FASTElement {
-    // (undocumented)
-    classNames: string;
-    // (undocumented)
-    message: string;
-    // (undocumented)
-    nonError: boolean;
-    // (undocumented)
-    nonErrorChanged(): void;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "organisationField" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const organisationField: <T extends BaseRoute>() => ViewTemplate<T, any>;
-
-// Warning: (ae-internal-missing-underscore) The name "password2Field" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const password2Field: <T extends BaseRoute>(type: "new" | "confirmation") => ViewTemplate<T, any>;
-
-// Warning: (ae-internal-missing-underscore) The name "passwordField" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const passwordField: <T extends BaseRoute>(label?: string) => ViewTemplate<T, any>;
-
-// @public (undocumented)
-export const Routes: {
-    readonly login: "login";
-    readonly 'request-account': "request-account";
-    readonly 'reset-password': "reset-password";
-    readonly 'forgot-password': "forgot-password";
-    readonly verify: "verify";
-    readonly 'mfa-mail-sent': "mfa-mail-sent";
-    readonly protected: "protected";
-    readonly 'not-found': "not-found";
-};
-
-// @public (undocumented)
-export type Routes = (typeof Routes)[keyof typeof Routes];
-
-// @public
-export type Settings = {
-    public?: boolean;
-};
-
-// Warning: (ae-internal-missing-underscore) The name "showEnvironmentIndicator" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const showEnvironmentIndicator: <T extends BaseRoute>() => ViewTemplate<T, any>;
-
-// Warning: (ae-internal-missing-underscore) The name "showPasswordCheckbox" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const showPasswordCheckbox: <T extends BaseRoute>() => ViewTemplate<T, any>;
-
-// @public
-export type SSOConfig = {
-    toggled?: boolean;
-    identityProvidersPath: string;
-};
-
-// Warning: (ae-internal-missing-underscore) The name "standaloneDefinition" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const standaloneDefinition: PartialFASTElementDefinition;
-
-// Warning: (ae-incompatible-release-tags) The symbol "styles" is marked as @public, but its signature references "TemplateOptions" which is marked as @beta
-//
-// @public (undocumented)
-export const styles: (options: TemplateOptions) => ElementStyles;
-
-// Warning: (ae-internal-missing-underscore) The name "submitButton" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const submitButton: <T extends ConfigHost>(label: string, dataTestId?: string, disabled?: boolean) => ViewTemplate<T, any>;
-
-// Warning: (ae-internal-missing-underscore) The name "SubmittingIndicator" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export class SubmittingIndicator extends FASTElement {
-    // (undocumented)
-    isSubmitting: boolean;
-}
-
-// Warning: (ae-incompatible-release-tags) The symbol "template" is marked as @public, but its signature references "TemplateOptions" which is marked as @beta
-//
-// @public (undocumented)
-export const template: (options: TemplateOptions) => ViewTemplate<Login, any>;
-
-// @beta (undocumented)
-export type TemplateComponents = {
-    anchor: TemplateElementDependency;
-    button: TemplateElementDependency;
-    card: TemplateElementDependency;
-    checkbox: TemplateElementDependency;
-    listboxOption: TemplateElementDependency;
-    provider: TemplateElementDependency;
-    router: TemplateElementDependency;
-    select: TemplateElementDependency;
-    textField: TemplateElementDependency;
-};
-
-// @beta (undocumented)
-export type TemplateOptions = TemplateComponents & {
-    somePartial?: string | SyntheticViewTemplate;
-};
-
-// Warning: (ae-internal-missing-underscore) The name "usernameField" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal (undocumented)
-export const usernameField: <T extends BaseRoute>() => ViewTemplate<T, any>;
-
-// (No @packageDocumentation comment for this package)
-
-```