docs: api docs for foudnation utils PTL-1548

docs/001_develop/03_client-capabilities/014_utility-methods/docs/_category_.yml

@@ -0,0 +1 @@
+className: 'hidden'

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.activecolorscheme.md

@@ -0,0 +1,16 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [activeColorScheme](./foundation-utils.activecolorscheme.md)
+
+## activeColorScheme variable
+
+A design token that represents the active color scheme (light or dark).
+
+**Signature:**
+
+```typescript
+activeColorScheme: import("@microsoft/fast-foundation").CSSDesignToken<string>
+```

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.api_host.md

@@ -0,0 +1,25 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [API\_HOST](./foundation-utils.api_host.md)
+
+## API\_HOST variable
+
+The Genesis Server URL (WebSocket or HTTP).
+
+**Signature:**
+
+```typescript
+_API_HOST: string
+```
+
+## Remarks
+
+Optional.
+
+## Example
+
+ws://localhost/gwf/, ws://localhost:9064
+

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.assuredesignsystem.md

@@ -0,0 +1,65 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [assureDesignSystem](./foundation-utils.assuredesignsystem.md)
+
+## assureDesignSystem() function
+
+assureDesignSystem.
+
+**Signature:**
+
+```typescript
+export declare function assureDesignSystem(module: DesignSystemModule): DesignSystemModule;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  module | [DesignSystemModule](./foundation-utils.designsystemmodule.md) |  |
+
+**Returns:**
+
+[DesignSystemModule](./foundation-utils.designsystemmodule.md)
+
+## Remarks
+
+Webpack caching strategies can backfill missing modules with placeholders in an attempt to prevent errors. In the case of offline remotes, we rely on the error to fall back to local versions. This utility assures we have a design system.
+
+## Example 1
+
+
+```ts
+async function zeroDesignSystemImport(): Promise<DesignSystemModule> {
+  let module: DesignSystemModule;
+  let type: ResourceType = ResourceType.remote;
+  try {
+    module = await import('foundationZero/ZeroDesignSystem');
+    return assureDesignSystem(module);
+  } catch (e) {
+    logger.info(
+      `Please note remoteEntry.js load errors are expected if module federated dependencies are offline. Falling back to locally bundled versions.`,
+    );
+    type = ResourceType.local;
+    module = await import('@genesislcap/foundation-zero');
+    return assureDesignSystem(module);
+  } finally {
+    logger.debug(`Using '${type}' version of foundation-zero`);
+  }
+}
+```
+
+## Example 2
+
+You should also instruct webpack to use strict module handling.
+
+```ts
+output: {
+  strictModuleErrorHandling: true,
+  strictModuleExceptionHandling: true,
+}
+```
+

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.constructablelifecyclehandler.md

@@ -0,0 +1,15 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ConstructableLifecycleHandler](./foundation-utils.constructablelifecyclehandler.md)
+
+## ConstructableLifecycleHandler type
+
+
+**Signature:**
+
+```typescript
+export type ConstructableLifecycleHandler = Constructable<FASTElement & HTMLElement>;
+```

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.constructablependingstate.md

@@ -0,0 +1,16 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ConstructablePendingState](./foundation-utils.constructablependingstate.md)
+
+## ConstructablePendingState type
+
+A mixin that provides functionality for raising `pending-state` events.
+
+**Signature:**
+
+```typescript
+export declare type ConstructablePendingState = Constructable<FASTElement & HTMLElement>;
+```

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.conversiontype.md

@@ -0,0 +1,16 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ConversionType](./foundation-utils.conversiontype.md)
+
+## ConversionType type
+
+Represents the possible types of value conversion for data synchronization.
+
+**Signature:**
+
+```typescript
+export type ConversionType = 'string' | 'number' | 'time' | 'boolean';
+```

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.createerrormap.md

@@ -0,0 +1,16 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [createErrorMap](./foundation-utils.createerrormap.md)
+
+## createErrorMap variable
+
+A factory to create the error map.
+
+**Signature:**
+
+```typescript
+createErrorMap: <TErrorDetailMap extends ErrorDetailMap>(logger: ErrorMapLogger) => ErrorMap<TErrorDetailMap>
+```

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.createlogger.md

@@ -0,0 +1,35 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [createLogger](./foundation-utils.createlogger.md)
+
+## createLogger() function
+
+> Warning: This API is now obsolete.
+> 
+> - Use `createLogger` from `@genesislcap/foundation-logger` instead.
+> 
+
+Creates a logger with the given name and options.
+
+**Signature:**
+
+```typescript
+export declare function createLogger(name: string, options?: LoggerOptions): Logger;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | string | The name to give the logger. |
+|  options | [LoggerOptions](./foundation-utils.loggeroptions.md) | _(Optional)_ The options to use when creating the logger. |
+
+**Returns:**
+
+[Logger](./foundation-utils.logger.md)
+
+The resulting logger.
+

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.createobserver.md

@@ -0,0 +1,16 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [createObserver](./foundation-utils.createobserver.md)
+
+## createObserver variable
+
+Creates a new event observer instance.
+
+**Signature:**
+
+```typescript
+createObserver: <EventType>() => Observer<EventType>
+```

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.customnumberparser.md

@@ -0,0 +1,27 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [customNumberParser](./foundation-utils.customnumberparser.md)
+
+## customNumberParser() function
+
+A Default Number Parser for deserializing objects.
+
+**Signature:**
+
+```typescript
+export declare function customNumberParser(value: any): number | bigint;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | any |  |
+
+**Returns:**
+
+number \| bigint
+

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.database.create.md

@@ -0,0 +1,25 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [create](./foundation-utils.database.create.md)
+
+## Database.create() method
+
+**Signature:**
+
+```typescript
+create(newValue: Omit<T, 'id'>): Promise<DatabaseAccessResult.Create<T>>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  newValue | Omit&lt;T, 'id'&gt; |  |
+
+**Returns:**
+
+Promise&lt;[DatabaseAccessResult.Create](./foundation-utils.databaseaccessresult.create.md)&lt;T&gt;&gt;
+

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.database.delete.md

@@ -0,0 +1,25 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [delete](./foundation-utils.database.delete.md)
+
+## Database.delete() method
+
+**Signature:**
+
+```typescript
+delete(id: string): Promise<DatabaseAccessResult.Delete>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  id | string |  |
+
+**Returns:**
+
+Promise&lt;[DatabaseAccessResult.Delete](./foundation-utils.databaseaccessresult.delete.md)&gt;
+

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.database.isworking.md

@@ -0,0 +1,14 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [isWorking](./foundation-utils.database.isworking.md)
+
+## Database.isWorking property
+
+**Signature:**
+
+```typescript
+isWorking: boolean;
+```

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.database.md

@@ -0,0 +1,35 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md)
+
+## Database interface
+
+Represents a database with basic CRUD operations.
+
+**Signature:**
+
+```typescript
+export interface Database<T extends DatabaseRecord> 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isWorking](./foundation-utils.database.isworking.md) |  | boolean |  |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [create(newValue)](./foundation-utils.database.create.md) |  |
+|  [delete(id)](./foundation-utils.database.delete.md) |  |
+|  [onAfterUpdate(listener)](./foundation-utils.database.onafterupdate.md) |  |
+|  [onBeforeUpdate(listener)](./foundation-utils.database.onbeforeupdate.md) |  |
+|  [read(id)](./foundation-utils.database.read.md) |  |
+|  [update(id, newValue)](./foundation-utils.database.update.md) |  |
+|  [visit(visitor)](./foundation-utils.database.visit.md) |  |
+

docs/001_develop/03_client-capabilities/014_utility-methods/docs/api/foundation-utils.database.onafterupdate.md

@@ -0,0 +1,25 @@
+---
+format: md
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [onAfterUpdate](./foundation-utils.database.onafterupdate.md)
+
+## Database.onAfterUpdate() method
+
+**Signature:**
+
+```typescript
+onAfterUpdate(listener: Listener<DatabaseEvent.AfterUpdate<T>>): () => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | [Listener](./foundation-utils.listener.md)&lt;[DatabaseEvent.AfterUpdate](./foundation-utils.databaseevent.afterupdate.md)&lt;T&gt;&gt; |  |
+
+**Returns:**
+
+() =&gt; void
+