{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.52.10", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "@genesislcap/foundation-login!", "docComment": "", "name": "@genesislcap/foundation-login", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "@genesislcap/foundation-login!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Function", "canonicalReference": "@genesislcap/foundation-login!configure:function(1)", "docComment": "/**\n * Configure the login micro frontend settings.\n *\n * @remarks\n *\n * This is primarily for general settings, rather than re-defining the element, static templating / style changes.\n *\n * @deprecated\n *\n * - Please use foundation-auth instead.\n *\n * @param container - DI container.\n *\n * @param config - A partial LoginConfig.\n *\n * @example\n *\n * Configuring login on lazy load\n * ```ts\n * name: 'login',\n * path: 'login',\n * title: 'Login',\n * element: async () => {\n * const { configure, define, defaultLoginConfig } = await import('@genesislcap/foundation-login');\n * configure(this.container, {\n * autoConnect: true,\n * omitRoutes: ['request-account'],\n * fields: {\n * ...defaultLoginConfig.fields,\n * organisation: {\n * label: 'CompID',\n * },\n * },\n * hostPath: 'login',\n * defaultRedirectUrl: 'dashboard',\n * logo: loginLogo,\n * background: loginBG,\n * });\n * // You can import and return `Login` directly here or re-define it completely via `define`.\n * return define({\n * name: `nexus-login`,\n * });\n * },\n * layout: loginLayout,\n * settings: { public: true },\n * childRouters: true,\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function configure(container: " }, { "kind": "Reference", "text": "Container", "canonicalReference": "@microsoft/fast-foundation!Container:interface" }, { "kind": "Content", "text": ", config: " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "LoginConfig", "canonicalReference": "@genesislcap/foundation-login!LoginConfig:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/config.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "container", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "isOptional": false } ], "name": "configure" }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!defaultApiHost:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultApiHost: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/main/config.ts", "isReadonly": true, "releaseTag": "Public", "name": "defaultApiHost", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!defaultLoginConfig:var", "docComment": "/**\n * Default LoginConfig DI implementation.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultLoginConfig: " }, { "kind": "Reference", "text": "LoginConfig", "canonicalReference": "@genesislcap/foundation-login!LoginConfig:interface" } ], "fileUrlPath": "src/main/config.ts", "isReadonly": true, "releaseTag": "Public", "name": "defaultLoginConfig", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Class", "canonicalReference": "@genesislcap/foundation-login!DefaultLoginRouting:class", "docComment": "/**\n * Default LoginRouting.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class DefaultLoginRouting implements " }, { "kind": "Reference", "text": "LoginRouting", "canonicalReference": "@genesislcap/foundation-login!LoginRouting:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/routes/routing.ts", "releaseTag": "Public", "isAbstract": false, "name": "DefaultLoginRouting", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "@genesislcap/foundation-login!DefaultLoginRouting#getRoutePath:member(1)", "docComment": "/**\n * {@inheritDoc LoginRouting.getRoutePath}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRoutePath(route: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "route", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getRoutePath" }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-login!DefaultLoginRouting#navigateTo:member(1)", "docComment": "/**\n * {@inheritDoc LoginRouting.navigateTo}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "navigateTo(route: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "route", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "navigateTo" } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!defaultOrganisation:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultOrganisation: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/main/config.ts", "isReadonly": true, "releaseTag": "Public", "name": "defaultOrganisation", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!defaultPassword:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultPassword: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/main/config.ts", "isReadonly": true, "releaseTag": "Public", "name": "defaultPassword", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!defaultSocketExt:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultSocketExt: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/main/config.ts", "isReadonly": true, "releaseTag": "Public", "name": "defaultSocketExt", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!defaultTemplateOptions:var", "docComment": "/**\n * The default template options this MF has been created with.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultTemplateOptions: " }, { "kind": "Reference", "text": "TemplateOptions", "canonicalReference": "@genesislcap/foundation-login!TemplateOptions:type" } ], "fileUrlPath": "src/main/main.definition.ts", "isReadonly": true, "releaseTag": "Beta", "name": "defaultTemplateOptions", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!defaultUser:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultUser: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/main/config.ts", "isReadonly": true, "releaseTag": "Public", "name": "defaultUser", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!define:var", "docComment": "/**\n * Re-define the login micro frontend.\n *\n * @example\n * ```ts\n * import { define, styles, template, defaultTemplateOptions } from '@genesislcap/foundation-login';\n * const customTemplateOptions = {\n * ...defaultTemplateOptions,\n * ...customOptions,\n * }\n * export const AppLogin = define({\n * name: `nexus-login`,\n * template: template(customTemplateOptions),\n * styles: css`\n * ${styles(customTemplateOptions)}\n * some-element {\n * background-color: #ff00b4;\n * }\n * `,\n * });\n * ```\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "define: " }, { "kind": "Content", "text": "import(\"@genesislcap/foundation-ui\")." }, { "kind": "Reference", "text": "DefineFunction", "canonicalReference": "@genesislcap/foundation-ui!DefineFunction:type" }, { "kind": "Content", "text": "" } ], "fileUrlPath": "src/main/define.ts", "isReadonly": true, "releaseTag": "Beta", "name": "define", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!definition:var", "docComment": "/**\n * @remarks\n *\n * This is the main definition of this micro frontend which is exposed for user reconfiguration.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "definition: " }, { "kind": "Reference", "text": "PartialFASTElementDefinition", "canonicalReference": "@microsoft/fast-element!PartialFASTElementDefinition:interface" } ], "fileUrlPath": "src/main/main.definition.ts", "isReadonly": true, "releaseTag": "Beta", "name": "definition", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-login!fetchIDPs:function(1)", "docComment": "/**\n * Request SSO identity provider list\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fetchIDPs: (path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", host?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IDP", "canonicalReference": "@genesislcap/foundation-login!IDP:interface" }, { "kind": "Content", "text": "[]>" } ], "fileUrlPath": "src/utils/sso.ts", "returnTypeTokenRange": { "startIndex": 5, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true }, { "parameterName": "host", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "name": "fetchIDPs" }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-login!FieldConfig:type", "docComment": "/**\n * Could be expanded to allow field ViewTemplates.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type FieldConfig = " }, { "kind": "Content", "text": "{\n label: string;\n value?: any;\n required?: boolean;\n pattern?: string;\n title?: string;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/config.ts", "releaseTag": "Public", "name": "FieldConfig", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-login!FieldConfigMap:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type FieldConfigMap = " }, { "kind": "Content", "text": "{\n organisation: " }, { "kind": "Reference", "text": "FieldConfig", "canonicalReference": "@genesislcap/foundation-login!FieldConfig:type" }, { "kind": "Content", "text": " | null;\n username: " }, { "kind": "Reference", "text": "FieldConfig", "canonicalReference": "@genesislcap/foundation-login!FieldConfig:type" }, { "kind": "Content", "text": ";\n email: " }, { "kind": "Reference", "text": "FieldConfig", "canonicalReference": "@genesislcap/foundation-login!FieldConfig:type" }, { "kind": "Content", "text": ";\n password: " }, { "kind": "Reference", "text": "FieldConfig", "canonicalReference": "@genesislcap/foundation-login!FieldConfig:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/config.ts", "releaseTag": "Public", "name": "FieldConfigMap", "typeTokenRange": { "startIndex": 1, "endIndex": 10 } }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-login!getLoginRouting:function(1)", "docComment": "/**\n * Gets LoginRouting from the DI container.\n *\n * @remarks\n *\n * A utility method for host applications that are not using decorators or the DI container.\n *\n * @example\n * ```ts\n * import { getloginRouting } from '@genesislcap/foundation-login';\n * ...\n * private loginRouting = getLoginRouting();\n * ...\n * this.loginRouting.navigateTo('logout');\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function getLoginRouting(): " }, { "kind": "Reference", "text": "LoginRouting", "canonicalReference": "@genesislcap/foundation-login!LoginRouting:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/routes/routing.ts", "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "getLoginRouting" }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-login!getSSOLoginURL:function(1)", "docComment": "/**\n * Get SSO identity provider login URL\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getSSOLoginURL: (idp: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", path?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", host?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ") => " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/utils/sso.ts", "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "idp", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true }, { "parameterName": "host", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "getSSOLoginURL" }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!hostEnv:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hostEnv: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/main/config.ts", "isReadonly": true, "releaseTag": "Public", "name": "hostEnv", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!hostUrl:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hostUrl: " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/main/config.ts", "isReadonly": true, "releaseTag": "Public", "name": "hostUrl", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-login!IDP:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IDP " } ], "fileUrlPath": "src/routes/types.ts", "releaseTag": "Public", "name": "IDP", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!IDP#id:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!IDP#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-login!IDPResponse:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IDPResponse " } ], "fileUrlPath": "src/routes/types.ts", "releaseTag": "Public", "name": "IDPResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!IDPResponse#ID:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "ID: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ID", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!IDPResponse#TYPE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "TYPE: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "TYPE", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-login!isMFRoute:function(1)", "docComment": "/**\n * A utility to check if a pathname is a route of this micro frontend.\n *\n * @param pathname - A pathname string to check, typically location.pathname, which is used when a value is omitted.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function isMFRoute(pathname?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/config.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "pathname", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "isMFRoute" }, { "kind": "Class", "canonicalReference": "@genesislcap/foundation-login!Login:class", "docComment": "/**\n * Defines the login class which handles account authentication from the front-end\n *\n * @remarks\n *\n * Add the Login class as a router element, and it will handle the account authentication for you. Requires use of `@genesislcap/foundation-comms` for the {@link @genesislcap/foundation-comms#Auth | Auth} and {@link @genesislcap/foundation#Session | Session} classes.\n *\n * There are a lot of configuration options available, and different authentication types (such as login via SSO). Use the modules exported `configure` and `define` functions for more power.\n *\n * @deprecated\n *\n * - Use '\\@genesislcap/pbc-auth' instead. 'https://www.npmjs.com/package/\\@genesislcap/pbc-auth'\n *\n * @example\n *\n * The following is an example of using it in your app, setting it up in the router configuration. This isn't a complete routes confutation, but it contains all required configuration in regard to adding Login functionality.\n * ```ts\n * // Import required dependencies from the foundation-login package\n * import { Login } from '@genesislcap/foundation-login';\n * // Import required dependencies from the foundation-comms package\n * // You could also import analytics events and set them up in the NavigationContributor\n * import { Auth, Session } from '@genesislcap/foundation-comms';\n *\n * type RouterSettings = {\n * public?: boolean;\n * autoAuth?: boolean;\n * }\n *\n * // Define your router config\n * export class MainRouterConfig extends RouterConfiguration {\n * // Ensure you inject in required dependencies\n * constructor(\n * @Auth private auth: Auth,\n * @Session private session: Session\n * ) {\n * super();\n * }\n *\n * // Add Login as a route\n * public configure() {\n * ...\n * this.routes.map(\n * { path: '', redirect: 'login' },\n * {\n * path: 'login',\n * element: Login,\n * title: 'Login',\n * name: 'login',\n * layout: loginLayout,\n * settings: { public: true },\n * childRouters: true,\n * },\n * ... // Other routes config here\n * );\n *\n * const session = this.session;\n * const auth = this.auth;\n *\n * // Example of a FallbackRouteDefinition\n * this.routes.fallback(() =>\n * auth.isLoggedIn ? { redirect: 'not-found' } : { redirect: 'login' }\n * );\n *\n * // Example of a NavigationContributor\n * this.contributors.push({\n * navigate: async (phase) => {\n * const settings = phase.route.settings;\n *\n * // Could add in processes such as analytics here\n *\n * // If public route don't block\n * if (settings && settings.public) {\n * return;\n * }\n *\n * // If logged in don't block\n * if (auth.isLoggedIn) {\n * return;\n * }\n *\n * // If autoAuth and session is valid try to connect+auto-login\n * if (settings && settings.autoAuth && (await auth.reAuthFromSession())) {\n * return;\n * }\n *\n * // Otherwise route them to login\n * phase.cancel(() => {\n * session.captureReturnUrl();\n * FoundationRouteNav.name.replace(phase.router, 'login');\n * });\n * },\n * });\n * }\n *\n * ... // Other configuration/methods\n *\n * }\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Login extends " }, { "kind": "Reference", "text": "FASTElement", "canonicalReference": "@microsoft/fast-element!FASTElement:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/main/main.ts", "releaseTag": "Public", "isAbstract": false, "name": "Login", "preserveMemberOrder": false, "members": [], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-login!LoginConfig:interface", "docComment": "/**\n * LoginConfig DI interface.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LoginConfig " } ], "fileUrlPath": "src/main/config.ts", "releaseTag": "Public", "name": "LoginConfig", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#autoAuth:member", "docComment": "/**\n * Login automatically or require user to click a login button after a connection is established.\n *\n * @remarks\n *\n * Needs to manually be enabled in the NavigationContributor (see [2] in the example in the {@link Login} class).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoAuth: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "autoAuth", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#autoConnect:member", "docComment": "/**\n * Connect automatically or require user to click a connect button.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "autoConnect: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "autoConnect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#background:member", "docComment": "/**\n * Background styles.\n *\n * @remarks\n *\n * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/background} for more information.\n *\n * @example\n *\n * Setting a custom background image\n * ```ts\n * background: css`\n * :host {\n * background-image: url(${customBGImport});\n * }\n * `,\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "background: " }, { "kind": "Reference", "text": "ElementStyles", "canonicalReference": "@microsoft/fast-element!ElementStyles:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "background", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#defaultRedirectUrl:member", "docComment": "/**\n * The default URL to route the user to after a successful login.\n *\n * @remarks\n *\n * Session.returnUrl set via Session.captureReturnUrl() trumps this value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultRedirectUrl: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultRedirectUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#fields:member", "docComment": "/**\n * Map of configuration for each of the primary form fields.\n *\n * @remarks\n *\n * Use to drive inclusion / exclusion, tailor labels etc.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "fields: " }, { "kind": "Reference", "text": "FieldConfigMap", "canonicalReference": "@genesislcap/foundation-login!FieldConfigMap:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "fields", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#hostPath:member", "docComment": "/**\n * The `path` of the micro frontend as defined in the parent / host route.\n *\n * @remarks\n *\n * Used to help resolve internal route links. Defaults to an empty string.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hostPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hostPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#localizationResources:member", "docComment": "/**\n * I18n resources.\n *\n * @remarks\n *\n * This property holds the localization resources needed for internationalization of the application. It should follow the structure defined by the I18nextConfig interface, which includes translations grouped by locale and namespace. Each locale can contain multiple namespaces, and each namespace includes key-value pairs for translation strings.\n *\n * @example\n * ```ts\n * resources: {\n * en: {\n * translation: {\n * key: 'Hello World'\n * }\n * },\n * es: {\n * translation: {\n * key: 'Hola Mundo'\n * }\n * }\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "localizationResources?: " }, { "kind": "Reference", "text": "I18nextConfig", "canonicalReference": "@genesislcap/foundation-i18n!I18nextConfig:interface" }, { "kind": "Content", "text": "['resources']" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "localizationResources", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#logo:member", "docComment": "/**\n * Logo styles.\n *\n * @remarks\n *\n * Providing `null` will hide the logo. Use content: url(...); to set source.\n *\n * @example\n *\n * Setting a custom logo\n * ```ts\n * logo: css`\n * content: url(${customLogoImport});\n * `,\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "logo: " }, { "kind": "Reference", "text": "ElementStyles", "canonicalReference": "@microsoft/fast-element!ElementStyles:class" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "logo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#logoAltText:member", "docComment": "/**\n * Logo alt text.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "logoAltText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "logoAltText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#messageDelays:member", "docComment": "/**\n * Delay configurations for various message-related actions.\n *\n * @remarks\n *\n * This property holds numeric values representing delays (in milliseconds) for specific message-related actions within the application. Each key in this object corresponds to a particular message action.\n *\n * @example\n * ```ts\n * messageDelays: {\n * forgotPassword: 1000, // Delay of 1000ms before processing forgot password action\n * resetPassword: 2000, // Delay of 2000ms for reset password action\n * base: 500 // Base delay used for generic message processing\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "messageDelays?: " }, { "kind": "Reference", "text": "MessageDelays", "canonicalReference": "@genesislcap/foundation-login!MessageDelays:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "messageDelays", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#omitRedirectUrls:member", "docComment": "/**\n * Omit certain return urls which the session service may have captured.\n *\n * @example\n * ```ts\n * omitRedirectUrls: ['/not-found'],\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "omitRedirectUrls: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "omitRedirectUrls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#omitRoutes:member", "docComment": "/**\n * Omit any of the internal routes except 'login' and 'not-found'.\n *\n * @remarks\n *\n * Routes specified here will not be configured nor will any internal cross-links to them be displayed.\n *\n * @example\n * ```ts\n * omitRoutes: ['request-account'],\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "omitRoutes: " }, { "kind": "Reference", "text": "Exclude", "canonicalReference": "!Exclude:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Routes", "canonicalReference": "@genesislcap/foundation-login!Routes:type" }, { "kind": "Content", "text": ", 'login' | 'not-found'>[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "omitRoutes", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#redirectHandler:member", "docComment": "/**\n * Handler that allows external apps own router to navigate after successful login\n */\n", "excerptTokens": [ { "kind": "Content", "text": "redirectHandler?: " }, { "kind": "Content", "text": "(url: string) => void" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "redirectHandler", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#showConnectionIndicator:member", "docComment": "/**\n * Show or hide the connection status indicator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showConnectionIndicator: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "showConnectionIndicator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#showEnvironmentIndicator:member", "docComment": "/**\n * Show or hide the environment indicator.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showEnvironmentIndicator?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "showEnvironmentIndicator", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#sso:member", "docComment": "/**\n * SSO configuration.\n *\n * @remarks\n *\n * Providing `null` excludes the SSO journey option completely.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sso: " }, { "kind": "Reference", "text": "SSOConfig", "canonicalReference": "@genesislcap/foundation-login!SSOConfig:type" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sso", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#submitButtonAppearance:member", "docComment": "/**\n * Custom appearance for submit buttons in `foundation-login`.\n *\n * @remarks\n *\n * This property holds a string representing the desired appearance for submit buttons in `foundation-login`. The value should be a valid `appearance` attribute of a Foundation button component.\n *\n * @example\n * ```ts\n * submitButtonAppearance: 'stealth'\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "submitButtonAppearance?: " }, { "kind": "Reference", "text": "ZeroButtonAppearance", "canonicalReference": "@genesislcap/foundation-zero!ZeroButtonAppearance:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "submitButtonAppearance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginConfig#versionInformation:member", "docComment": "/**\n * Display arbitrary version information.\n *\n * @remarks\n *\n * Applications may choose to set this to display their Application release version on the login form.\n *\n * @example\n * ```ts\n * versionInformation: 'Version 3.0.0',\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "versionInformation?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "versionInformation", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@genesislcap/foundation-login!LoginHosted:class", "docComment": "/**\n * @deprecated\n *\n * - Please use foundation-auth instead.\n *\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class LoginHosted extends " }, { "kind": "Reference", "text": "Login", "canonicalReference": "@genesislcap/foundation-login!Login:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/main/main.ts", "releaseTag": "Beta", "isAbstract": false, "name": "LoginHosted", "preserveMemberOrder": false, "members": [ { "kind": "Method", "canonicalReference": "@genesislcap/foundation-login!LoginHosted#registerCommonComponents:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "registerCommonComponents(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Beta", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "registerCommonComponents" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-login!LoginRouting:interface", "docComment": "/**\n * LoginRouting interface.\n *\n * @remarks\n *\n * A utility to navigate to a sub route of the login micro frontend without needing to know the full path in advance.\n *\n * @example\n *\n * Import the utility into any component or logic you wish to invoke from.\n * ```ts\n * import { LoginRouting } from '@genesislcap/foundation-login';\n * ...\n * @LoginRouting private loginRouting: LoginRouting;\n * ...\n * this.loginRouting.navigateTo('logout');\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface LoginRouting " } ], "fileUrlPath": "src/routes/routing.ts", "releaseTag": "Public", "name": "LoginRouting", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginRouting#getRoutePath:member", "docComment": "/**\n * {@inheritDoc getRoutePath}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getRoutePath: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "getRoutePath", "canonicalReference": "@genesislcap/foundation-login!~getRoutePath:function" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "getRoutePath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-login!LoginRouting#navigateTo:member", "docComment": "/**\n * {@inheritDoc navigateTo}\n */\n", "excerptTokens": [ { "kind": "Content", "text": "navigateTo: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "navigateTo", "canonicalReference": "@genesislcap/foundation-login!~navigateTo:function" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "navigateTo", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-login!MessageDelayKey:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type MessageDelayKey = " }, { "kind": "Content", "text": "'forgotPassword' | 'resetPassword' | 'base'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/config.ts", "releaseTag": "Public", "name": "MessageDelayKey", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-login!MessageDelays:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type MessageDelays = " }, { "kind": "Reference", "text": "Partial", "canonicalReference": "!Partial:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MessageDelayKey", "canonicalReference": "@genesislcap/foundation-login!MessageDelayKey:type" }, { "kind": "Content", "text": ", number>>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/config.ts", "releaseTag": "Public", "name": "MessageDelays", "typeTokenRange": { "startIndex": 1, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-login!Routes:type", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Routes = " }, { "kind": "Content", "text": "(typeof " }, { "kind": "Reference", "text": "Routes", "canonicalReference": "@genesislcap/foundation-login!Routes:var" }, { "kind": "Content", "text": ")[keyof typeof " }, { "kind": "Reference", "text": "Routes", "canonicalReference": "@genesislcap/foundation-login!Routes:var" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/config.ts", "releaseTag": "Public", "name": "Routes", "typeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-login!Routes:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "Routes: " }, { "kind": "Content", "text": "{\n readonly login: \"login\";\n readonly 'request-account': \"request-account\";\n readonly 'reset-password': \"reset-password\";\n readonly 'forgot-password': \"forgot-password\";\n readonly verify: \"verify\";\n readonly 'mfa-mail-sent': \"mfa-mail-sent\";\n readonly protected: \"protected\";\n readonly 'not-found': \"not-found\";\n}" } ], "fileUrlPath": "src/main/config.ts", "isReadonly": true, "releaseTag": "Public", "name": "Routes", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-login!Settings:type", "docComment": "/**\n * Defines the parameters you may set on the routes.\n *\n * @remarks\n *\n * See the example in the {@link Login} class in the router's `configure` method for usage. All parameters are Optional.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type Settings = " }, { "kind": "Content", "text": "{\n public?: boolean;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/routes/types.ts", "releaseTag": "Public", "name": "Settings", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-login!SSOConfig:type", "docComment": "/**\n * If you don't provide SSOConfig on the login config then SSO is disabled completely.\n *\n * @remarks\n *\n * `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.\n *\n * `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.\n *\n * @example\n * ```ts\n * const config: SSOConfig = {\n * toggled: true,\n * identityProvidersPath: 'sso/list',\n * }\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type SSOConfig = " }, { "kind": "Content", "text": "{\n toggled?: boolean;\n identityProvidersPath: string;\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/config.ts", "releaseTag": "Public", "name": "SSOConfig", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-login!styles:function(1)", "docComment": "/**\n * @example\n *\n * unknown target\n * ```\n * const buttonTag = tagFor(options.button);\n * ...\n * ${buttonTag} {\n * width: 200px;\n * }\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "styles: (options: " }, { "kind": "Reference", "text": "TemplateOptions", "canonicalReference": "@genesislcap/foundation-login!TemplateOptions:type" }, { "kind": "Content", "text": ") => " }, { "kind": "Content", "text": "import(\"@microsoft/fast-element\")." }, { "kind": "Reference", "text": "ElementStyles", "canonicalReference": "@microsoft/fast-element!ElementStyles:class" } ], "fileUrlPath": "src/main/main.styles.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "styles" }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-login!template:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "template: (options: " }, { "kind": "Reference", "text": "TemplateOptions", "canonicalReference": "@genesislcap/foundation-login!TemplateOptions:type" }, { "kind": "Content", "text": ") => " }, { "kind": "Content", "text": "import(\"@microsoft/fast-element\")." }, { "kind": "Reference", "text": "ViewTemplate", "canonicalReference": "@microsoft/fast-element!ViewTemplate:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Login", "canonicalReference": "@genesislcap/foundation-login!Login:class" }, { "kind": "Content", "text": ", any>" } ], "fileUrlPath": "src/main/main.template.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "template" }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-login!TemplateComponents:type", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TemplateComponents = " }, { "kind": "Content", "text": "{\n anchor: " }, { "kind": "Reference", "text": "TemplateElementDependency", "canonicalReference": "@genesislcap/foundation-ui!TemplateElementDependency:type" }, { "kind": "Content", "text": ";\n button: " }, { "kind": "Reference", "text": "TemplateElementDependency", "canonicalReference": "@genesislcap/foundation-ui!TemplateElementDependency:type" }, { "kind": "Content", "text": ";\n card: " }, { "kind": "Reference", "text": "TemplateElementDependency", "canonicalReference": "@genesislcap/foundation-ui!TemplateElementDependency:type" }, { "kind": "Content", "text": ";\n checkbox: " }, { "kind": "Reference", "text": "TemplateElementDependency", "canonicalReference": "@genesislcap/foundation-ui!TemplateElementDependency:type" }, { "kind": "Content", "text": ";\n listboxOption: " }, { "kind": "Reference", "text": "TemplateElementDependency", "canonicalReference": "@genesislcap/foundation-ui!TemplateElementDependency:type" }, { "kind": "Content", "text": ";\n provider: " }, { "kind": "Reference", "text": "TemplateElementDependency", "canonicalReference": "@genesislcap/foundation-ui!TemplateElementDependency:type" }, { "kind": "Content", "text": ";\n router: " }, { "kind": "Reference", "text": "TemplateElementDependency", "canonicalReference": "@genesislcap/foundation-ui!TemplateElementDependency:type" }, { "kind": "Content", "text": ";\n select: " }, { "kind": "Reference", "text": "TemplateElementDependency", "canonicalReference": "@genesislcap/foundation-ui!TemplateElementDependency:type" }, { "kind": "Content", "text": ";\n textField: " }, { "kind": "Reference", "text": "TemplateElementDependency", "canonicalReference": "@genesislcap/foundation-ui!TemplateElementDependency:type" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/main.definition.ts", "releaseTag": "Beta", "name": "TemplateComponents", "typeTokenRange": { "startIndex": 1, "endIndex": 20 } }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-login!TemplateOptions:type", "docComment": "/**\n * @beta\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type TemplateOptions = " }, { "kind": "Reference", "text": "TemplateComponents", "canonicalReference": "@genesislcap/foundation-login!TemplateComponents:type" }, { "kind": "Content", "text": " & {\n somePartial?: string | " }, { "kind": "Reference", "text": "SyntheticViewTemplate", "canonicalReference": "@microsoft/fast-element!SyntheticViewTemplate:interface" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/main/main.definition.ts", "releaseTag": "Beta", "name": "TemplateOptions", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } } ] } ] }