npm - @genesislcap/foundation-auth - Versions diffs - 14.408.0 → 14.409.0-FUI-2495.2 - Mend

@genesislcap/foundation-auth 14.408.0 → 14.409.0-FUI-2495.2

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.

Files changed (328) hide show

package/docs/api/foundation-auth.authroutes.md DELETED Viewed

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthRoutes](./foundation-auth.authroutes.md)
-## AuthRoutes variable
-**Signature:**
-```typescript
-AuthRoutes: {
-    readonly login: "login";
-    readonly logout: "logout";
-    readonly 'request-account': "request-account";
-    readonly 'reset-password': "reset-password";
-    readonly 'forgot-password': "forgot-password";
-    readonly verify: "verify";
-    readonly protected: "protected";
-    readonly 'not-found': "not-found";
-    readonly 'terms-and-conditions': "terms-and-conditions";
-}
-```

package/docs/api/foundation-auth.authstore.authmachine.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [authMachine](./foundation-auth.authstore.authmachine.md)
-## AuthStore.authMachine property
-Auth workflows and transient state (context in xstate lingo).
-**Signature:**
-```typescript
-readonly authMachine: AuthMachine;
-```

package/docs/api/foundation-auth.authstore.errormessages.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [errorMessages](./foundation-auth.authstore.errormessages.md)
-## AuthStore.errorMessages property
-**Signature:**
-```typescript
-readonly errorMessages: string[];
-```

package/docs/api/foundation-auth.authstore.formentry.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [formEntry](./foundation-auth.authstore.formentry.md)
-## AuthStore.formEntry property
-**Signature:**
-```typescript
-readonly formEntry: AuthFormEntryStore;
-```

package/docs/api/foundation-auth.authstore.ispending.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [isPending](./foundation-auth.authstore.ispending.md)
-## AuthStore.isPending property
-**Signature:**
-```typescript
-readonly isPending: boolean;
-```

package/docs/api/foundation-auth.authstore.md DELETED Viewed

@@ -1,210 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md)
-## AuthStore interface
-AuthStore interface.
-**Signature:**
-```typescript
-export interface AuthStore extends StoreRoot
-```
-**Extends:** StoreRoot
-## Remarks
-This is the root store for the foundation-auth package.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[authMachine](./foundation-auth.authstore.authmachine.md)
-</td><td>
-`readonly`
-</td><td>
-[AuthMachine](./foundation-auth.authmachine.md)
-</td><td>
-Auth workflows and transient state (context in xstate lingo).
-</td></tr>
-<tr><td>
-[errorMessages](./foundation-auth.authstore.errormessages.md)
-</td><td>
-`readonly`
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[formEntry](./foundation-auth.authstore.formentry.md)
-</td><td>
-`readonly`
-</td><td>
-[AuthFormEntryStore](./foundation-auth.authformentrystore.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isPending](./foundation-auth.authstore.ispending.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[metaMessages](./foundation-auth.authstore.metamessages.md)
-</td><td>
-`readonly`
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[onChangePassword(event)](./foundation-auth.authstore.onchangepassword.md)
-</td><td>
-</td></tr>
-<tr><td>
-[onForgotPassword(event)](./foundation-auth.authstore.onforgotpassword.md)
-</td><td>
-</td></tr>
-<tr><td>
-[onLogin(event)](./foundation-auth.authstore.onlogin.md)
-</td><td>
-</td></tr>
-<tr><td>
-[onLogout(event)](./foundation-auth.authstore.onlogout.md)
-</td><td>
-</td></tr>
-<tr><td>
-[onMachineEvent(event)](./foundation-auth.authstore.onmachineevent.md)
-</td><td>
-</td></tr>
-<tr><td>
-[onResetPassword(event)](./foundation-auth.authstore.onresetpassword.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-auth.authstore.metamessages.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [metaMessages](./foundation-auth.authstore.metamessages.md)
-## AuthStore.metaMessages property
-**Signature:**
-```typescript
-readonly metaMessages: string[];
-```

package/docs/api/foundation-auth.authstore.onchangepassword.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [onChangePassword](./foundation-auth.authstore.onchangepassword.md)
-## AuthStore.onChangePassword() method
-**Signature:**
-```typescript
-onChangePassword(event: CustomEvent<ChangePasswordParams>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;[ChangePasswordParams](./foundation-auth.changepasswordparams.md)<!-- -->&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-auth.authstore.onforgotpassword.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [onForgotPassword](./foundation-auth.authstore.onforgotpassword.md)
-## AuthStore.onForgotPassword() method
-**Signature:**
-```typescript
-onForgotPassword(event: CustomEvent<ForgotPasswordParams>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;[ForgotPasswordParams](./foundation-auth.forgotpasswordparams.md)<!-- -->&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-auth.authstore.onlogin.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [onLogin](./foundation-auth.authstore.onlogin.md)
-## AuthStore.onLogin() method
-**Signature:**
-```typescript
-onLogin(event: CustomEvent<LoginParams>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;[LoginParams](./foundation-auth.loginparams.md)<!-- -->&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-auth.authstore.onlogout.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [onLogout](./foundation-auth.authstore.onlogout.md)
-## AuthStore.onLogout() method
-**Signature:**
-```typescript
-onLogout(event: CustomEvent<void>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;void&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-auth.authstore.onmachineevent.md DELETED Viewed

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [onMachineEvent](./foundation-auth.authstore.onmachineevent.md)
-## AuthStore.onMachineEvent() method
-**Signature:**
-```typescript
-onMachineEvent(event: CustomEvent<AuthEventMap['auth-machine-event']>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;[AuthEventMap](./foundation-auth.autheventmap.md)<!-- -->\['auth-machine-event'\]&gt;
-</td><td>
-The machine mediation event.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-auth.authstore.onresetpassword.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [onResetPassword](./foundation-auth.authstore.onresetpassword.md)
-## AuthStore.onResetPassword() method
-**Signature:**
-```typescript
-onResetPassword(event: CustomEvent<ResetPasswordParams>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;[ResetPasswordParams](./foundation-auth.resetpasswordparams.md)<!-- -->&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-auth.basiccredentials.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [BasicCredentials](./foundation-auth.basiccredentials.md)
-## BasicCredentials type
-**Signature:**
-```typescript
-export type BasicCredentials = {
-    type: CredentialType & CredentialType.BASIC;
-    username: string;
-    password: string;
-};
-```
-**References:** [CredentialType](./foundation-auth.credentialtype_2.md)<!-- -->, [CredentialType.BASIC](./foundation-auth.credentialtype_2.md)

package/docs/api/foundation-auth.changepasswordparams.md DELETED Viewed

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [ChangePasswordParams](./foundation-auth.changepasswordparams.md)
-## ChangePasswordParams type
-**Signature:**
-```typescript
-export type ChangePasswordParams = {
-    username: string;
-    oldPassword: string;
-    newPassword: string;
-    requester?: string;
-};
-```