@genesislcap/foundation-utils 14.22.1 → 14.23.0

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

@@ -0,0 +1,51 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [renderOnChange](./foundation-utils.renderonchange.md)
+
+## renderOnChange() function
+
+Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.
+
+**Signature:**
+
+```typescript
+export declare function renderOnChange(target: FASTElement & {
+    render(): void;
+}, name: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  target | FASTElement &amp; { render(): void; } | The target to define the property change handler on. |
+|  name | string | The property name. |
+
+**Returns:**
+
+void
+
+## Remarks
+
+This is useful if you have a lot of properties that all invalidate the internal state. See [https://www.fast.design/docs/fast-element/observables-and-state\#internal-observation](https://www.fast.design/docs/fast-element/observables-and-state#internal-observation) for more information.
+
+## Example
+
+
+```ts
+ @attr({ mode: 'boolean', attribute: 'line-numbers' })
+ @renderOnChange
+ lineNumbers: boolean = true;
+
+ @attr
+ @renderOnChange
+ indent: number | 'tab' = 2;
+
+ render() {
+   if (!this.$fastController.isConnected) {
+     return;
+   }
+   // Do something...
+ }
+```
+

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

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ResourceType](./foundation-utils.resourcetype.md)
+
+## ResourceType variable
+
+An object that defines two resource types: "local" and "remote".
+
+**Signature:**
+
+```typescript
+ResourceType: {
+    readonly local: "local";
+    readonly remote: "remote";
+}
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [respondToVisibility](./foundation-utils.respondtovisibility.md)
+
+## respondToVisibility variable
+
+Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen
+
+**Signature:**
+
+```typescript
+respondToVisibility: (element: HTMLElement, callback: (arg0: boolean) => any) => void
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ServerRowDTO](./foundation-utils.serverrowdto.md)
+
+## ServerRowDTO type
+
+The data for a server row DTO.
+
+**Signature:**
+
+```typescript
+export type ServerRowDTO = {
+    DETAILS: {
+        OPERATION: UppercaseOperation;
+        ROW_REF: string;
+    };
+};
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ServerRowDTOMapper](./foundation-utils.serverrowdtomapper.md)
+
+## ServerRowDTOMapper variable
+
+A DI token used to obtain a `ServerRowDTOMapper` instance.
+
+**Signature:**
+
+```typescript
+ServerRowDTOMapper: import("@microsoft/fast-foundation").InterfaceSymbol<ServerRowDTOMapper>
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ServerRowEntity](./foundation-utils.serverrowentity.md)
+
+## ServerRowEntity type
+
+The data for a server row entity.
+
+**Signature:**
+
+```typescript
+export type ServerRowEntity = {
+    serverRowMetadata: {
+        operation: LowercaseOperation;
+        rowRef: string;
+    };
+};
+```

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

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [SlottedStyles](./foundation-utils.slottedstyles.md)
+
+## SlottedStyles class
+
+A custom element that encapsulates a set of styles that can be applied to slotted elements.
+
+**Signature:**
+
+```typescript
+export declare class SlottedStyles extends FASTElement 
+```
+**Extends:** FASTElement
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [styles](./foundation-utils.slottedstyles.styles.md) |  | ElementStyles | The styles to apply to slotted elements. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [stylesChanged(prev, next)](./foundation-utils.slottedstyles.styleschanged.md) |  | Called when the <code>styles</code> property changes. Removes the previous styles from the parent element's FAST controller and adds the new styles. |
+

package/docs/api/foundation-utils.slottedstyles.styles.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [SlottedStyles](./foundation-utils.slottedstyles.md) &gt; [styles](./foundation-utils.slottedstyles.styles.md)
+
+## SlottedStyles.styles property
+
+The styles to apply to slotted elements.
+
+**Signature:**
+
+```typescript
+styles: ElementStyles;
+```

package/docs/api/foundation-utils.slottedstyles.styleschanged.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [SlottedStyles](./foundation-utils.slottedstyles.md) &gt; [stylesChanged](./foundation-utils.slottedstyles.styleschanged.md)
+
+## SlottedStyles.stylesChanged() method
+
+Called when the `styles` property changes. Removes the previous styles from the parent element's FAST controller and adds the new styles.
+
+**Signature:**
+
+```typescript
+stylesChanged(prev: ElementStyles, next: ElementStyles): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  prev | ElementStyles | The previous value of the <code>styles</code> property. |
+|  next | ElementStyles | The new value of the <code>styles</code> property. |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [SOCKET\_EXT](./foundation-utils.socket_ext.md)
+
+## SOCKET\_EXT variable
+
+The sub-path used for WebSocket connections. Example: API\_HOST + '/' + SOCKET\_EXT - wss://localhost:9064/gwf.
+
+**Signature:**
+
+```typescript
+_SOCKET_EXT: string
+```
+
+## Remarks
+
+Optional. Default is "API\_HOST/gwf"
+

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Subscribe](./foundation-utils.subscribe.md)
+
+## Subscribe type
+
+Subscribes a listener function to receive events of a specific type.
+
+**Signature:**
+
+```typescript
+export type Subscribe<EventType> = (listener: Listener<EventType>) => () => void;
+```
+**References:** [Listener](./foundation-utils.listener.md)
+

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

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [sync](./foundation-utils.sync.md)
+
+## sync() function
+
+Creates a synchronization directive that binds a data source to an HTML element,
+
+**Signature:**
+
+```typescript
+export declare function sync<TSource = any, TReturn = any>(binding: Binding<TSource, TReturn>, conversionType?: ConversionType, eventName?: EventName, keyAttr?: string): CaptureType<TSource>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  binding | Binding&lt;TSource, TReturn&gt; |  |
+|  conversionType | [ConversionType](./foundation-utils.conversiontype.md) | _(Optional)_ |
+|  eventName | [EventName](./foundation-utils.eventname.md) | _(Optional)_ |
+|  keyAttr | string | _(Optional)_ |
+
+**Returns:**
+
+CaptureType&lt;TSource&gt;
+

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [TypeRampValues](./foundation-utils.typerampvalues.md)
+
+## TypeRampValues variable
+
+An object containing type ramp values.
+
+**Signature:**
+
+```typescript
+TypeRampValues: {
+    readonly minusOne: -1;
+    readonly minusTwo: -2;
+    readonly plusOne: 1;
+    readonly plusTwo: 2;
+    readonly plusThree: 3;
+    readonly plusFour: 4;
+    readonly plusFive: 5;
+    readonly plusSix: 6;
+}
+```

package/docs/api/foundation-utils.uuid.createid.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [UUID](./foundation-utils.uuid.md) &gt; [createId](./foundation-utils.uuid.createid.md)
+
+## UUID.createId() method
+
+Generates a new UUID.
+
+**Signature:**
+
+```typescript
+createId(withLogging?: boolean): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  withLogging | boolean | _(Optional)_ Optional. Whether to log the generated UUID to the console. Defaults to false. |
+
+**Returns:**
+
+string
+
+The generated UUID.
+

package/docs/api/foundation-utils.uuid.createremoteid.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [UUID](./foundation-utils.uuid.md) &gt; [createRemoteId](./foundation-utils.uuid.createremoteid.md)
+
+## UUID.createRemoteId() method
+
+Generates a new UUID for a remote object.
+
+**Signature:**
+
+```typescript
+createRemoteId(withLogging?: boolean): Promise<string>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  withLogging | boolean | _(Optional)_ Optional. Whether to log the generated UUID to the console. Defaults to false. |
+
+**Returns:**
+
+Promise&lt;string&gt;
+
+A promise that resolves to the generated UUID.
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [UUID](./foundation-utils.uuid.md)
+
+## UUID variable
+
+A dependency injection token for the UUID interface.
+
+**Signature:**
+
+```typescript
+UUID: import("@microsoft/fast-foundation").InterfaceSymbol<UUID>
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [UUIDConfig](./foundation-utils.uuidconfig.md)
+
+## UUIDConfig interface
+
+A configuration object for customizing UUID generation.
+
+**Signature:**
+
+```typescript
+export interface UUIDConfig 
+```

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [whenElse](./foundation-utils.whenelse.md)
+
+## whenElse() function
+
+Directive that allows supplying an "else" template to the traditional [https://www.fast.design/docs/api/fast-element.when/\#when-function](https://www.fast.design/docs/api/fast-element.when/#when-function) directive
+
+**Signature:**
+
+```typescript
+export declare function whenElse<TSource = any, TReturn = any>(binding: Binding<TSource, TReturn>, trueTemplateOrTemplateBinding: WhenTemplate<TSource>, falseTemplateOrTemplateBinding: WhenTemplate<TSource>): CaptureType<TSource>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  binding | Binding&lt;TSource, TReturn&gt; | The condition to test for rendering. |
+|  trueTemplateOrTemplateBinding | WhenTemplate&lt;TSource&gt; | The template or a binding that gets the template to render when the condition is true. |
+|  falseTemplateOrTemplateBinding | WhenTemplate&lt;TSource&gt; | The template or a binding that gets the template to render when the condition is false. |
+
+**Returns:**
+
+CaptureType&lt;TSource&gt;
+

package/docs/api/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [@genesislcap/foundation-utils](./foundation-utils.md) |  |
+