@genesislcap/foundation-utils 14.408.0 → 14.409.0

package/docs/api/foundation-utils.genesis.md

@@ -1,79 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Genesis](./foundation-utils.genesis.md)
-
-## Genesis namespace
-
-
-**Signature:**
-
-```typescript
-export declare namespace Genesis 
-```
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[genesisFieldTypes](./foundation-utils.genesis.genesisfieldtypes.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[FieldJsonSchema](./foundation-utils.genesis.fieldjsonschema.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[GenesisFieldTypes](./foundation-utils.genesis.genesisfieldtypes.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[JSONSchema7](./foundation-utils.genesis.jsonschema7.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-utils.genesis_socket_url.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [GENESIS\_SOCKET\_URL](./foundation-utils.genesis_socket_url.md)
-
-## GENESIS\_SOCKET\_URL variable
-
-Genesis Socket URL
-
-**Signature:**
-
-```typescript
-GENESIS_SOCKET_URL: string
-```
-
-## Remarks
-
-Built from the current [https://developer.mozilla.org/en-US/docs/Web/API/Location](https://developer.mozilla.org/en-US/docs/Web/API/Location) object and [socket extension](./foundation-utils.socket_ext.md)<!-- -->.
-
-## Example
-
-
-```ts
-await this.connect.connect(GENESIS_SOCKET_URL); // < wss://localhost:6060/gwf/
-```
-

package/docs/api/foundation-utils.getallelements.md

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [getAllElements](./foundation-utils.getallelements.md)
-
-## getAllElements() function
-
-Recursively gather all elements including those in shadow DOM
-
-**Signature:**
-
-```typescript
-export declare function getAllElements(root: Element | Document): Element[];
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-root
-
-
-</td><td>
-
-Element \| Document
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Element\[\]
-

package/docs/api/foundation-utils.getcurrentdesignsystem.md

@@ -1,84 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [getCurrentDesignSystem](./foundation-utils.getcurrentdesignsystem.md)
-
-## getCurrentDesignSystem() function
-
-Get the current design system provider element and prefix by checking available providers. If no provider is found, falls back to the provided prefix.
-
-**Signature:**
-
-```typescript
-export declare function getCurrentDesignSystem(element: HTMLElement, fallbackPrefix: string): {
-    element: HTMLElement | null;
-    prefix: string;
-};
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-element
-
-
-</td><td>
-
-HTMLElement
-
-
-</td><td>
-
-The starting HTML element
-
-
-</td></tr>
-<tr><td>
-
-fallbackPrefix
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The prefix to fallback to if the provider is not available
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-{ element: HTMLElement \| null; prefix: string; }
-
-An object containing the current design system provider element and prefix
-
-## Example
-
-
-```ts
-const { element: providerElement, prefix } = getCurrentDesignSystem(myElement, 'default-prefix');
-logger.debug(prefix); // e.g., 'rapid' or 'default-prefix'
-logger.debug(providerElement); // The provider element or null
-```
-

package/docs/api/foundation-utils.getcurrentdesignsystemprefix.md

@@ -1,80 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [getCurrentDesignSystemPrefix](./foundation-utils.getcurrentdesignsystemprefix.md)
-
-## getCurrentDesignSystemPrefix() function
-
-Get the current design system prefix by checking available providers. If no provider is found, falls back to the provided prefix.
-
-**Signature:**
-
-```typescript
-export declare function getCurrentDesignSystemPrefix(element: HTMLElement, fallbackPrefix: string): string;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-element
-
-
-</td><td>
-
-HTMLElement
-
-
-</td><td>
-
-The starting HTML element
-
-
-</td></tr>
-<tr><td>
-
-fallbackPrefix
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The prefix to fallback to if the provider is not available
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-
-The current design system prefix
-
-## Example
-
-
-```ts
-const prefix = getCurrentDesignSystemPrefix(myElement, 'default-prefix');
-logger.debug(prefix); // e.g., 'rapid' or 'default-prefix'
-```
-

package/docs/api/foundation-utils.getdateformatter.md

@@ -1,69 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [getDateFormatter](./foundation-utils.getdateformatter.md)
-
-## getDateFormatter() function
-
-
-**Signature:**
-
-```typescript
-export declare function getDateFormatter(locale?: string, options?: Intl.DateTimeFormatOptions): (params: any) => string;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-locale
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-options
-
-
-</td><td>
-
-Intl.DateTimeFormatOptions
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-(params: any) =&gt; string
-

package/docs/api/foundation-utils.getfontmixin.md

@@ -1,88 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [getFontMixin](./foundation-utils.getfontmixin.md)
-
-## getFontMixin() function
-
-Generates a CSS mixin for the specified font family, style, and weight.
-
-**Signature:**
-
-```typescript
-getFontMixin: (family: string, style?: FontStyle, weight?: FontWeight) => string
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-family
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The font family.
-
-
-</td></tr>
-<tr><td>
-
-style
-
-
-</td><td>
-
-[FontStyle](./foundation-utils.fontstyle.md)
-
-
-</td><td>
-
-_(Optional)_ Optional. The font style. Defaults to FontStyle.Normal.
-
-
-</td></tr>
-<tr><td>
-
-weight
-
-
-</td><td>
-
-[FontWeight](./foundation-utils.fontweight.md)
-
-
-</td><td>
-
-_(Optional)_ Optional. The font weight. Defaults to FontWeight.Regular.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-
-The generated CSS mixin.
-

package/docs/api/foundation-utils.getnumberformatter.md

@@ -1,67 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [getNumberFormatter](./foundation-utils.getnumberformatter.md)
-
-## getNumberFormatter() function
-
-
-**Signature:**
-
-```typescript
-export declare function getNumberFormatter(format: string, locale?: string | null): (params: any) => any;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-format
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-locale
-
-
-</td><td>
-
-string \| null
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-(params: any) =&gt; any
-

package/docs/api/foundation-utils.http_config.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [HTTP\_CONFIG](./foundation-utils.http_config.md)
-
-## HTTP\_CONFIG variable
-
-Configuration settings for HTTP, used in http connect flow \[`genesislcap-foundation-comms.HttpConnectConfig`<!-- -->\](https://link-to-docs).
-
-**Signature:**
-
-```typescript
-_HTTP_CONFIG: string
-```
-
-## Remarks
-
-Optional.
-

package/docs/api/foundation-utils.inactivityconfig.md

@@ -1,71 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityConfig](./foundation-utils.inactivityconfig.md)
-
-## InactivityConfig interface
-
-**Signature:**
-
-```typescript
-export interface InactivityConfig 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[timeoutMinutes](./foundation-utils.inactivityconfig.timeoutminutes.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[warningMinutes](./foundation-utils.inactivityconfig.warningminutes.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-utils.inactivityconfig.timeoutminutes.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityConfig](./foundation-utils.inactivityconfig.md) &gt; [timeoutMinutes](./foundation-utils.inactivityconfig.timeoutminutes.md)
-
-## InactivityConfig.timeoutMinutes property
-
-**Signature:**
-
-```typescript
-timeoutMinutes: number;
-```

package/docs/api/foundation-utils.inactivityconfig.warningminutes.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityConfig](./foundation-utils.inactivityconfig.md) &gt; [warningMinutes](./foundation-utils.inactivityconfig.warningminutes.md)
-
-## InactivityConfig.warningMinutes property
-
-**Signature:**
-
-```typescript
-warningMinutes: number;
-```

package/docs/api/foundation-utils.inactivitydialog.configure.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialog](./foundation-utils.inactivitydialog.md) &gt; [configure](./foundation-utils.inactivitydialog.configure.md)
-
-## InactivityDialog.configure() method
-
-**Signature:**
-
-```typescript
-configure(options: InactivityDialogOptions): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-[InactivityDialogOptions](./foundation-utils.inactivitydialogoptions.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-