@genesislcap/foundation-login 14.136.0 → 14.137.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -279,6 +279,8 @@ export declare const LoginConfig: import("@microsoft/fast-foundation").Interface
279
279
  * @public
280
280
  * @privateRemarks
281
281
  * We can tailor the spreading logic after we put it to use. Keeping it simple for now.
282
+ *
283
+ * @deprecated - Please use foundation-auth instead.
282
284
  */
283
285
  export declare function configure(container: Container, config: Partial<LoginConfig>): void;
284
286
  //# sourceMappingURL=config.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/main/config.ts"],"names":[],"mappings":"AAOA,OAAO,EAAO,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAoB,MAAM,4BAA4B,CAAC;AAIzE;;GAEG;AACH,eAAO,MAAM,mBAAmB,QAAuB,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,WAAW,QAAe,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,QAAmB,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,cAAc,QAAW,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,gBAAgB,QAAa,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,OAAO,QAAgB,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,OAAO,QAAW,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,MAAM;;;;;;;;CAQT,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC;AAE1D;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,QAAQ,GAAE,MAA0B,GAAG,OAAO,CAKvE;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,YAAY,EAAE,WAAW,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,WAAW,CAAC;IACtB,KAAK,EAAE,WAAW,CAAC;IACnB,QAAQ,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;;;OAOG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;IAC3B;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,aAAa,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,UAAU,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,WAAW,CAAC,EAAE,CAAC;IACrD;;;;;OAKG;IACH,MAAM,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;;;;;OAOG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B;;;;;OAKG;IACH,GAAG,EAAE,SAAS,GAAG,IAAI,CAAC;IACtB;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAmChC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,mEAAoC,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,QAO3E"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/main/config.ts"],"names":[],"mappings":"AAOA,OAAO,EAAO,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAoB,MAAM,4BAA4B,CAAC;AAKzE;;GAEG;AACH,eAAO,MAAM,mBAAmB,QAAuB,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,WAAW,QAAe,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,QAAmB,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,cAAc,QAAW,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,gBAAgB,QAAa,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,OAAO,QAAgB,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,OAAO,QAAW,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,MAAM;;;;;;;;CAQT,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC;AAE1D;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,QAAQ,GAAE,MAA0B,GAAG,OAAO,CAKvE;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,YAAY,EAAE,WAAW,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,WAAW,CAAC;IACtB,KAAK,EAAE,WAAW,CAAC;IACnB,QAAQ,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;;;OAOG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;IAC3B;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,aAAa,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,UAAU,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,WAAW,CAAC,EAAE,CAAC;IACrD;;;;;OAKG;IACH,MAAM,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;;;;;OAOG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B;;;;;OAKG;IACH,GAAG,EAAE,SAAS,GAAG,IAAI,CAAC;IACtB;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAmChC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,mEAAoC,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,wBAAgB,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,QAQ3E"}
@@ -100,6 +100,8 @@ import { MainRouterConfig } from '../routes';
100
100
  * }
101
101
  * ```
102
102
  *
103
+ * @deprecated - Please use foundation-auth instead.
104
+ *
103
105
  * @public
104
106
  */
105
107
  export declare class Login extends FASTElement {
@@ -172,6 +174,8 @@ export declare class Login extends FASTElement {
172
174
  * @privateRemarks
173
175
  * A hosted version of the MF that doesn't set up a design system or components. This is what apps would use to truly
174
176
  * customise the MF for their needs via define.ts.
177
+ *
178
+ * @deprecated - Please use foundation-auth instead.
175
179
  */
176
180
  export declare class LoginHosted extends Login {
177
181
  registerCommonComponents(): Promise<void>;
@@ -1 +1 @@
1
- {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuC,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAC7F,OAAO,EAAiB,WAAW,EAAc,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,SAAS,EAAwB,MAAM,4BAA4B,CAAC;AAG7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAG7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmGG;AACH,qBACa,KAAM,SAAQ,WAAW;IACpC;;;;;OAKG;IACuB,MAAM,EAAG,gBAAgB,CAAC;IAEpD;;;OAGG;IACQ,SAAS,EAAG,SAAS,CAAC;IAEjC;;;OAGG;IACM,OAAO,EAAG,OAAO,CAAC;IAE3B;;;OAGG;IACS,KAAK,EAAE,OAAO,CAAS;IAEnC;;;OAGG;IACS,QAAQ,EAAG,WAAW,CAAC;IAEnC;;OAEG;IACG,iBAAiB;IAOvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,gBAAgB;IAchB;;;OAGG;IACG,wBAAwB;IAa9B;;OAEG;IACH,SAAS,CAAC,sBAAsB;CAgBjC;AAED;;;;;GAKG;AACH,qBAIa,WAAY,SAAQ,KAAK;IAC9B,wBAAwB;CAG/B"}
1
+ {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuC,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAC7F,OAAO,EAAiB,WAAW,EAAc,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,SAAS,EAAwB,MAAM,4BAA4B,CAAC;AAG7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAI7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqGG;AACH,qBACa,KAAM,SAAQ,WAAW;IACpC;;;;;OAKG;IACuB,MAAM,EAAG,gBAAgB,CAAC;IAEpD;;;OAGG;IACQ,SAAS,EAAG,SAAS,CAAC;IAEjC;;;OAGG;IACM,OAAO,EAAG,OAAO,CAAC;IAE3B;;;OAGG;IACS,KAAK,EAAE,OAAO,CAAS;IAEnC;;;OAGG;IACS,QAAQ,EAAG,WAAW,CAAC;IAEnC;;OAEG;IACG,iBAAiB;IAQvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,gBAAgB;IAchB;;;OAGG;IACG,wBAAwB;IAa9B;;OAEG;IACH,SAAS,CAAC,sBAAsB;CAgBjC;AAED;;;;;;;GAOG;AACH,qBAIa,WAAY,SAAQ,KAAK;IAC9B,wBAAwB;CAG/B"}
@@ -3,6 +3,7 @@ import { css } from '@microsoft/fast-element';
3
3
  import { DI, Registration } from '@microsoft/fast-foundation';
4
4
  import defaultBackgroundSrc from '../assets/bg.jpg';
5
5
  import defaultLogoSrc from '../assets/genesis-logo-light.svg';
6
+ import { logger } from '../utils';
6
7
  /**
7
8
  * @public
8
9
  */
@@ -149,7 +150,10 @@ export const LoginConfig = DI.createInterface();
149
150
  * @public
150
151
  * @privateRemarks
151
152
  * We can tailor the spreading logic after we put it to use. Keeping it simple for now.
153
+ *
154
+ * @deprecated - Please use foundation-auth instead.
152
155
  */
153
156
  export function configure(container, config) {
157
+ logger.deprecated('configure', 'Please use foundation-auth instead');
154
158
  container.register(Registration.instance(LoginConfig, Object.assign(Object.assign({}, defaultLoginConfig), config)));
155
159
  }
@@ -5,6 +5,7 @@ import { Container, inject, Registration } from '@microsoft/fast-foundation';
5
5
  import { DefaultRouteRecognizer } from '@microsoft/fast-router';
6
6
  import * as Components from '../components';
7
7
  import { MainRouterConfig } from '../routes';
8
+ import { logger } from '../utils';
8
9
  import { definition, standaloneDefinition } from './main.definition';
9
10
  /**
10
11
  * Defines the login class which handles account authentication from the front-end
@@ -104,6 +105,8 @@ import { definition, standaloneDefinition } from './main.definition';
104
105
  * }
105
106
  * ```
106
107
  *
108
+ * @deprecated - Please use foundation-auth instead.
109
+ *
107
110
  * @public
108
111
  */
109
112
  let Login = class Login extends FASTElement {
@@ -123,6 +126,7 @@ let Login = class Login extends FASTElement {
123
126
  connectedCallback: { get: () => super.connectedCallback }
124
127
  });
125
128
  return __awaiter(this, void 0, void 0, function* () {
129
+ logger.deprecated('foundation-login', 'Please use foundation-auth instead');
126
130
  this.registerDIDependencies();
127
131
  _super.connectedCallback.call(this);
128
132
  yield this.registerCommonComponents();
@@ -219,6 +223,8 @@ export { Login };
219
223
  * @privateRemarks
220
224
  * A hosted version of the MF that doesn't set up a design system or components. This is what apps would use to truly
221
225
  * customise the MF for their needs via define.ts.
226
+ *
227
+ * @deprecated - Please use foundation-auth instead.
222
228
  */
223
229
  let LoginHosted = class LoginHosted extends Login {
224
230
  registerCommonComponents() {
@@ -175,7 +175,7 @@
175
175
  {
176
176
  "kind": "Function",
177
177
  "canonicalReference": "@genesislcap/foundation-login!configure:function(1)",
178
- "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 * @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",
178
+ "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",
179
179
  "excerptTokens": [
180
180
  {
181
181
  "kind": "Content",
@@ -866,7 +866,7 @@
866
866
  {
867
867
  "kind": "Class",
868
868
  "canonicalReference": "@genesislcap/foundation-login!Login:class",
869
- "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 * @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<RouterSettings> {\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 * Route.name.replace(phase.router, 'login');\n * });\n * },\n * });\n * }\n *\n * ... // Other configuration/methods\n *\n * }\n * ```\n *\n * @public\n */\n",
869
+ "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 * - Please use foundation-auth instead.\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<RouterSettings> {\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 * Route.name.replace(phase.router, 'login');\n * });\n * },\n * });\n * }\n *\n * ... // Other configuration/methods\n *\n * }\n * ```\n *\n * @public\n */\n",
870
870
  "excerptTokens": [
871
871
  {
872
872
  "kind": "Content",
@@ -1265,7 +1265,7 @@
1265
1265
  {
1266
1266
  "kind": "Class",
1267
1267
  "canonicalReference": "@genesislcap/foundation-login!LoginHosted:class",
1268
- "docComment": "/**\n * @beta\n */\n",
1268
+ "docComment": "/**\n * @deprecated\n *\n * - Please use foundation-auth instead.\n *\n * @beta\n */\n",
1269
1269
  "excerptTokens": [
1270
1270
  {
1271
1271
  "kind": "Content",
@@ -136,6 +136,8 @@ export declare const configurableTextField: <T extends ConfigHost>(name: keyof F
136
136
  * @public
137
137
  * @privateRemarks
138
138
  * We can tailor the spreading logic after we put it to use. Keeping it simple for now.
139
+ *
140
+ * @deprecated - Please use foundation-auth instead.
139
141
  */
140
142
  export declare function configure(container: Container, config: Partial<LoginConfig>): void;
141
143
 
@@ -416,6 +418,8 @@ export declare function isMFRoute(pathname?: string): boolean;
416
418
  * }
417
419
  * ```
418
420
  *
421
+ * @deprecated - Please use foundation-auth instead.
422
+ *
419
423
  * @public
420
424
  */
421
425
  export declare class Login extends FASTElement {
@@ -612,6 +616,8 @@ export declare const LoginConfig: InterfaceSymbol<LoginConfig>;
612
616
  * @privateRemarks
613
617
  * A hosted version of the MF that doesn't set up a design system or components. This is what apps would use to truly
614
618
  * customise the MF for their needs via define.ts.
619
+ *
620
+ * @deprecated - Please use foundation-auth instead.
615
621
  */
616
622
  export declare class LoginHosted extends Login {
617
623
  registerCommonComponents(): Promise<void>;
@@ -4,6 +4,11 @@
4
4
 
5
5
  ## configure() function
6
6
 
7
+ > Warning: This API is now obsolete.
8
+ >
9
+ > - Please use foundation-auth instead.
10
+ >
11
+
7
12
  Configure the login micro frontend settings.
8
13
 
9
14
  **Signature:**
@@ -4,6 +4,11 @@
4
4
 
5
5
  ## Login class
6
6
 
7
+ > Warning: This API is now obsolete.
8
+ >
9
+ > - Please use foundation-auth instead.
10
+ >
11
+
7
12
  Defines the login class which handles account authentication from the front-end
8
13
 
9
14
  **Signature:**
@@ -7,6 +7,10 @@
7
7
  > 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.
8
8
  >
9
9
 
10
+ > Warning: This API is now obsolete.
11
+ >
12
+ > - Please use foundation-auth instead.
13
+ >
10
14
 
11
15
  **Signature:**
12
16
 
@@ -123,7 +123,7 @@ export class ConfigHostElement extends FASTElement implements ConfigHost {
123
123
  // @internal (undocumented)
124
124
  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>;
125
125
 
126
- // @public
126
+ // @public @deprecated
127
127
  export function configure(container: Container, config: Partial<LoginConfig>): void;
128
128
 
129
129
  // @public (undocumented)
@@ -211,7 +211,7 @@ export interface IDPResponse {
211
211
  // @public
212
212
  export function isMFRoute(pathname?: string): boolean;
213
213
 
214
- // @public
214
+ // @public @deprecated
215
215
  export class Login extends FASTElement {
216
216
  // @internal
217
217
  checkForSSOToken(): void;
@@ -254,7 +254,7 @@ export interface LoginConfig {
254
254
  // @internal
255
255
  export const LoginConfig: InterfaceSymbol<LoginConfig>;
256
256
 
257
- // @beta (undocumented)
257
+ // @beta @deprecated (undocumented)
258
258
  export class LoginHosted extends Login {
259
259
  // (undocumented)
260
260
  registerCommonComponents(): Promise<void>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-login",
3
3
  "description": "Genesis Foundation Login",
4
- "version": "14.136.0",
4
+ "version": "14.137.0",
5
5
  "license": "SEE LICENSE IN license.txt",
6
6
  "main": "dist/esm/index.js",
7
7
  "types": "dist/foundation-login.d.ts",
@@ -59,16 +59,16 @@
59
59
  "test:debug": "genx test --debug"
60
60
  },
61
61
  "devDependencies": {
62
- "@genesislcap/foundation-testing": "14.136.0",
63
- "@genesislcap/genx": "14.136.0",
62
+ "@genesislcap/foundation-testing": "14.137.0",
63
+ "@genesislcap/genx": "14.137.0",
64
64
  "rimraf": "^3.0.2"
65
65
  },
66
66
  "dependencies": {
67
- "@genesislcap/foundation-comms": "14.136.0",
68
- "@genesislcap/foundation-logger": "14.136.0",
69
- "@genesislcap/foundation-ui": "14.136.0",
70
- "@genesislcap/foundation-utils": "14.136.0",
71
- "@genesislcap/foundation-zero": "14.136.0",
67
+ "@genesislcap/foundation-comms": "14.137.0",
68
+ "@genesislcap/foundation-logger": "14.137.0",
69
+ "@genesislcap/foundation-ui": "14.137.0",
70
+ "@genesislcap/foundation-utils": "14.137.0",
71
+ "@genesislcap/foundation-zero": "14.137.0",
72
72
  "@microsoft/fast-components": "^2.30.6",
73
73
  "@microsoft/fast-element": "^1.12.0",
74
74
  "@microsoft/fast-foundation": "^2.49.4",
@@ -85,5 +85,5 @@
85
85
  "access": "public"
86
86
  },
87
87
  "customElements": "dist/custom-elements.json",
88
- "gitHead": "0056e1c9602a30db4d30802cdfe48e7489d0abcd"
88
+ "gitHead": "e858204084c3ab29fa83c92dd9532c539e113f16"
89
89
  }