npm - @genesislcap/foundation-comms - Versions diffs - 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.0 - Mend

@genesislcap/foundation-comms 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.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.

Files changed (384) hide show

package/docs/api/foundation-comms.auth.login.md CHANGED Viewed

@@ -14,39 +14,9 @@ login(credentials: AuthInfo): Promise<LoginResult>;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-credentials
-</td><td>
-[AuthInfo](./foundation-comms.authinfo.md)
-</td><td>
-The user's login credentials.
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  credentials | [AuthInfo](./foundation-comms.authinfo.md) | The user's login credentials. |
 **Returns:**

package/docs/api/foundation-comms.auth.md CHANGED Viewed

@@ -14,135 +14,17 @@ export interface Auth
 ## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[isLoggedIn](./foundation-comms.auth.isloggedin.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-A boolean value indicating whether or not the user is currently logged in.
-</td></tr>
-<tr><td>
-[isLoggedIn$?](./foundation-comms.auth.isloggedin_.md)
-</td><td>
-`readonly`
-</td><td>
-Observable&lt;boolean&gt;
-</td><td>
-_(Optional)_ An Observable that emits a boolean value indicating whether or not the user is currently logged in.
-</td></tr>
-<tr><td>
-[isWorking](./foundation-comms.auth.isworking.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Indicates whether Auth is working or is idle.
-</td></tr>
-</tbody></table>
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isLoggedIn](./foundation-comms.auth.isloggedin.md) | <code>readonly</code> | boolean | A boolean value indicating whether or not the user is currently logged in. |
+|  [isLoggedIn$?](./foundation-comms.auth.isloggedin_.md) | <code>readonly</code> | Observable&lt;boolean&gt; | _(Optional)_ An Observable that emits a boolean value indicating whether or not the user is currently logged in. |
+|  [isWorking](./foundation-comms.auth.isworking.md) |  | boolean | Indicates whether Auth is working or is idle. |
 ## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[login(credentials)](./foundation-comms.auth.login.md)
-</td><td>
-Logs in the user with the specified credentials.
-</td></tr>
-<tr><td>
-[logout()](./foundation-comms.auth.logout.md)
-</td><td>
-Logs out the current user, if any.
-</td></tr>
-<tr><td>
-[reAuthFromSession()](./foundation-comms.auth.reauthfromsession.md)
-</td><td>
-Attempts to re-authenticate the user using the existing session data.
-</td></tr>
-</tbody></table>
+|  Method | Description |
+|  --- | --- |
+|  [login(credentials)](./foundation-comms.auth.login.md) | Logs in the user with the specified credentials. |
+|  [logout()](./foundation-comms.auth.logout.md) | Logs out the current user, if any. |
+|  [reAuthFromSession()](./foundation-comms.auth.reauthfromsession.md) | Attempts to re-authenticate the user using the existing session data. |

package/docs/api/foundation-comms.autherror._constructor_.md CHANGED Viewed

@@ -14,67 +14,9 @@ constructor(sent: Message, received?: Message, message?: string);
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-sent
-</td><td>
-[Message](./foundation-comms.message.md)
-</td><td>
-</td></tr>
-<tr><td>
-received
-</td><td>
-[Message](./foundation-comms.message.md)
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-message
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sent | [Message](./foundation-comms.message.md) |  |
+|  received | [Message](./foundation-comms.message.md) | _(Optional)_ |
+|  message | string | _(Optional)_ |

package/docs/api/foundation-comms.autherror.haserrorcode.md CHANGED Viewed

@@ -12,37 +12,9 @@ hasErrorCode(code: string): boolean;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-code
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  code | string |  |
 **Returns:**

package/docs/api/foundation-comms.autherror.md CHANGED Viewed

@@ -15,188 +15,25 @@ export declare class AuthError extends Error
 ## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(sent, received, message)](./foundation-comms.autherror._constructor_.md)
-</td><td>
-</td><td>
-Constructs a new instance of the `AuthError` class
-</td></tr>
-</tbody></table>
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(sent, received, message)](./foundation-comms.autherror._constructor_.md) |  | Constructs a new instance of the <code>AuthError</code> class |
 ## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[received?](./foundation-comms.autherror.received.md)
-</td><td>
-</td><td>
-[Message](./foundation-comms.message.md)
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-[sent](./foundation-comms.autherror.sent.md)
-</td><td>
-</td><td>
-[Message](./foundation-comms.message.md)
-</td><td>
-</td></tr>
-</tbody></table>
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [received?](./foundation-comms.autherror.received.md) |  | [Message](./foundation-comms.message.md) | _(Optional)_ |
+|  [sent](./foundation-comms.autherror.sent.md) |  | [Message](./foundation-comms.message.md) |  |
 ## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[getDetailsError()](./foundation-comms.autherror.getdetailserror.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[getMessageError()](./foundation-comms.autherror.getmessageerror.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[hasErrorCode(code)](./foundation-comms.autherror.haserrorcode.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[hasMFAError()](./foundation-comms.autherror.hasmfaerror.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[hasPasswordExpiredError()](./foundation-comms.autherror.haspasswordexpirederror.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[isIgnorableError()](./foundation-comms.autherror.isignorableerror.md)
-</td><td>
-</td><td>
-</td></tr>
-</tbody></table>
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getDetailsError()](./foundation-comms.autherror.getdetailserror.md) |  |  |
+|  [getMessageError()](./foundation-comms.autherror.getmessageerror.md) |  |  |
+|  [hasErrorCode(code)](./foundation-comms.autherror.haserrorcode.md) |  |  |
+|  [hasMFAError()](./foundation-comms.autherror.hasmfaerror.md) |  |  |
+|  [hasPasswordExpiredError()](./foundation-comms.autherror.haspasswordexpirederror.md) |  |  |
+|  [isIgnorableError()](./foundation-comms.autherror.isignorableerror.md) |  |  |

package/docs/api/foundation-comms.authtype.md CHANGED Viewed

@@ -14,77 +14,10 @@ export declare enum AuthType
 ## Enumeration Members
-<table><thead><tr><th>
-Member
-</th><th>
-Value
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-BASIC
-</td><td>
-`"BASIC"`
-</td><td>
-</td></tr>
-<tr><td>
-JWT
-</td><td>
-`"JWT"`
-</td><td>
-</td></tr>
-<tr><td>
-REFRESH
-</td><td>
-`"REFRESH"`
-</td><td>
-</td></tr>
-<tr><td>
-SSO
-</td><td>
-`"SSO"`
-</td><td>
-</td></tr>
-</tbody></table>
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  BASIC | <code>&quot;BASIC&quot;</code> |  |
+|  JWT | <code>&quot;JWT&quot;</code> |  |
+|  REFRESH | <code>&quot;REFRESH&quot;</code> |  |
+|  SSO | <code>&quot;SSO&quot;</code> |  |

package/docs/api/foundation-comms.connect.commitevent.md CHANGED Viewed

@@ -14,53 +14,10 @@ commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-eventName
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-params
-</td><td>
-[CommitParams](./foundation-comms.commitparams.md)
-</td><td>
-_(Optional)_ An object containing optional parameters to include in the request.
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  eventName | string |  |
+|  params | [CommitParams](./foundation-comms.commitparams.md) | _(Optional)_ An object containing optional parameters to include in the request. |
 **Returns:**

package/docs/api/foundation-comms.connect.connect.md CHANGED Viewed

@@ -14,39 +14,9 @@ connect(host?: string): Promise<boolean>;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-host
-</td><td>
-string
-</td><td>
-_(Optional)_ The host to connect to. Defaults to GENESIS\_SOCKET\_URL.
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  host | string | _(Optional)_ The host to connect to. Defaults to GENESIS\_SOCKET\_URL. |
 **Returns:**