@genesislcap/foundation-utils 14.65.2 → 14.66.0

package/docs/.gitattributes

@@ -0,0 +1,2 @@
+*.md -diff
+*.md linguist-generated

package/docs/api/foundation-utils.createerrormap.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; [createErrorMap](./foundation-utils.createerrormap.md)
+
+## createErrorMap variable
+
+A factory to create the error map.
+
+**Signature:**
+
+```typescript
+createErrorMap: <TErrorDetailMap extends ErrorDetailMap>(logger: ErrorMapLogger) => ErrorMap<TErrorDetailMap>
+```

package/docs/api/foundation-utils.defaulterrormap._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [(constructor)](./foundation-utils.defaulterrormap._constructor_.md)
+
+## DefaultErrorMap.(constructor)
+
+Constructs a new instance of the `DefaultErrorMap` class
+
+**Signature:**
+
+```typescript
+constructor(logger: ErrorMapLogger);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  logger | [ErrorMapLogger](./foundation-utils.errormaplogger.md) | A logger error method reference. |
+

package/docs/api/foundation-utils.defaulterrormap.clear.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [clear](./foundation-utils.defaulterrormap.clear.md)
+
+## DefaultErrorMap.clear() method
+
+Clear errors.
+
+**Signature:**
+
+```typescript
+clear(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaulterrormap.delete.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; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [delete](./foundation-utils.defaulterrormap.delete.md)
+
+## DefaultErrorMap.delete() method
+
+Delete an error.
+
+**Signature:**
+
+```typescript
+delete(key: keyof TErrorDetailMap): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | keyof TErrorDetailMap | The key. |
+
+**Returns:**
+
+boolean
+
+True if successful, otherwise false.
+

package/docs/api/foundation-utils.defaulterrormap.get.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; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [get](./foundation-utils.defaulterrormap.get.md)
+
+## DefaultErrorMap.get() method
+
+Get an error by key.
+
+**Signature:**
+
+```typescript
+get(key: keyof TErrorDetailMap): Error | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | keyof TErrorDetailMap | The key. |
+
+**Returns:**
+
+Error \| undefined
+
+The error if it exists, otherwise undefined.
+

package/docs/api/foundation-utils.defaulterrormap.has.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; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [has](./foundation-utils.defaulterrormap.has.md)
+
+## DefaultErrorMap.has() method
+
+Has an error for key.
+
+**Signature:**
+
+```typescript
+has(key: keyof TErrorDetailMap): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | keyof TErrorDetailMap | The key. |
+
+**Returns:**
+
+boolean
+
+True if it exists, otherwise false.
+

package/docs/api/foundation-utils.defaulterrormap.lasterror.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; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [lastError](./foundation-utils.defaulterrormap.lasterror.md)
+
+## DefaultErrorMap.lastError property
+
+The last set error if any.
+
+**Signature:**
+
+```typescript
+lastError: Error;
+```

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

@@ -0,0 +1,38 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md)
+
+## DefaultErrorMap class
+
+
+**Signature:**
+
+```typescript
+export declare class DefaultErrorMap<TErrorDetailMap extends ErrorDetailMap> implements ErrorMap<TErrorDetailMap> 
+```
+**Implements:** [ErrorMap](./foundation-utils.errormap.md)<!-- -->&lt;TErrorDetailMap&gt;
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(logger)](./foundation-utils.defaulterrormap._constructor_.md) |  | Constructs a new instance of the <code>DefaultErrorMap</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [lastError](./foundation-utils.defaulterrormap.lasterror.md) |  | Error | The last set error if any. |
+|  [messages](./foundation-utils.defaulterrormap.messages.md) | <code>readonly</code> | string | Error map as messages. |
+|  [size](./foundation-utils.defaulterrormap.size.md) | <code>readonly</code> | number | The size of the error map. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [clear()](./foundation-utils.defaulterrormap.clear.md) |  | Clear errors. |
+|  [delete(key)](./foundation-utils.defaulterrormap.delete.md) |  | Delete an error. |
+|  [get(key)](./foundation-utils.defaulterrormap.get.md) |  | Get an error by key. |
+|  [has(key)](./foundation-utils.defaulterrormap.has.md) |  | Has an error for key. |
+|  [set(key, error)](./foundation-utils.defaulterrormap.set.md) |  | Set an error by key. |
+

package/docs/api/foundation-utils.defaulterrormap.messages.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; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [messages](./foundation-utils.defaulterrormap.messages.md)
+
+## DefaultErrorMap.messages property
+
+Error map as messages.
+
+**Signature:**
+
+```typescript
+get messages(): string;
+```

package/docs/api/foundation-utils.defaulterrormap.set.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; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [set](./foundation-utils.defaulterrormap.set.md)
+
+## DefaultErrorMap.set() method
+
+Set an error by key.
+
+**Signature:**
+
+```typescript
+set(key: keyof TErrorDetailMap, error: Error): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | keyof TErrorDetailMap | The key. |
+|  error | Error | The error. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaulterrormap.size.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; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [size](./foundation-utils.defaulterrormap.size.md)
+
+## DefaultErrorMap.size property
+
+The size of the error map.
+
+**Signature:**
+
+```typescript
+get size(): number;
+```

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

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ErrorDetailMap](./foundation-utils.errordetailmap.md)
+
+## ErrorDetailMap type
+
+
+**Signature:**
+
+```typescript
+export type ErrorDetailMap = Record<string, unknown>;
+```

package/docs/api/foundation-utils.errormap.lasterror.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; [ErrorMap](./foundation-utils.errormap.md) &gt; [lastError](./foundation-utils.errormap.lasterror.md)
+
+## ErrorMap.lastError property
+
+The last set error if any.
+
+**Signature:**
+
+```typescript
+readonly lastError: Error;
+```

package/docs/api/foundation-utils.errormap.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; [ErrorMap](./foundation-utils.errormap.md)
+
+## ErrorMap interface
+
+
+**Signature:**
+
+```typescript
+export interface ErrorMap<TErrorDetailMap extends ErrorDetailMap> extends Pick<Map<keyof TErrorDetailMap, Error>, 'get' | 'has' | 'delete' | 'clear' | 'size'> 
+```
+**Extends:** Pick&lt;Map&lt;keyof TErrorDetailMap, Error&gt;, 'get' \| 'has' \| 'delete' \| 'clear' \| 'size'&gt;
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [lastError](./foundation-utils.errormap.lasterror.md) | <code>readonly</code> | Error | The last set error if any. |
+|  [messages](./foundation-utils.errormap.messages.md) | <code>readonly</code> | string | Error map as messages. |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [set(key, error)](./foundation-utils.errormap.set.md) | Set an error by key. |
+

package/docs/api/foundation-utils.errormap.messages.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; [ErrorMap](./foundation-utils.errormap.md) &gt; [messages](./foundation-utils.errormap.messages.md)
+
+## ErrorMap.messages property
+
+Error map as messages.
+
+**Signature:**
+
+```typescript
+readonly messages: string;
+```

package/docs/api/foundation-utils.errormap.set.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; [ErrorMap](./foundation-utils.errormap.md) &gt; [set](./foundation-utils.errormap.set.md)
+
+## ErrorMap.set() method
+
+Set an error by key.
+
+**Signature:**
+
+```typescript
+set(key: keyof TErrorDetailMap, error: Error): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | keyof TErrorDetailMap | The key. |
+|  error | Error | The error. |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ErrorMapLogger](./foundation-utils.errormaplogger.md)
+
+## ErrorMapLogger type
+
+
+**Signature:**
+
+```typescript
+export type ErrorMapLogger = (...args: any[]) => void;
+```

package/docs/api/foundation-utils.jsonreplacer.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; [JSONReplacer](./foundation-utils.jsonreplacer.md)
+
+## JSONReplacer() function
+
+JSON replacer function.
+
+**Signature:**
+
+```typescript
+export declare function JSONReplacer(key: string, value: any): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | string | The object key. |
+|  value | any | The key value. |
+
+**Returns:**
+
+any
+
+The resulting value.
+

package/docs/api/foundation-utils.jsonreviver.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; [JSONReviver](./foundation-utils.jsonreviver.md)
+
+## JSONReviver() function
+
+JSON reviver function.
+
+**Signature:**
+
+```typescript
+export declare function JSONReviver(key: string, value: any): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | string | The object key. |
+|  value | any | The key value. |
+
+**Returns:**
+
+any
+
+The resulting value.
+

package/docs/api/foundation-utils.md

@@ -8,6 +8,7 @@
 
 |  Class | Description |
 |  --- | --- |
+|  [DefaultErrorMap](./foundation-utils.defaulterrormap.md) |  |
 |  [DefaultServerRowDTOMapper](./foundation-utils.defaultserverrowdtomapper.md) | The default <code>ServerRowDTOMapper</code>. |
 |  [InMemoryDatabase](./foundation-utils.inmemorydatabase.md) | An in memory database of specific DatabaseRecord types. |
 |  [NumberParser](./foundation-utils.numberparser.md) |  |
@@ -30,6 +31,8 @@
 |  [formatDateTimestamp(timestamp)](./foundation-utils.formatdatetimestamp.md) | Formats \[DATE\] UNIX Timestamps (without time) to readable strings |
 |  [formatDateTimeTimestamp(timestamp)](./foundation-utils.formatdatetimetimestamp.md) | Formats \[DATETIME\] UNIX Timestamps (with time) to readable strings |
 |  [formatTimestamp(timestamp, withTime)](./foundation-utils.formattimestamp.md) | Formats \[DATE\|DATETIME\] Unix Timestamps to readable strings |
+|  [JSONReplacer(key, value)](./foundation-utils.jsonreplacer.md) | JSON replacer function. |
+|  [JSONReviver(key, value)](./foundation-utils.jsonreviver.md) | JSON reviver function. |
 |  [renderOnChange(target, name)](./foundation-utils.renderonchange.md) | Defines a property changed handler that calls a render() method on the target as an internal observation enhancement. |
 |  [sync(binding, conversionType, eventName, keyAttr)](./foundation-utils.sync.md) | Creates a synchronization directive that binds a data source to an HTML element, |
 |  [whenElse(binding, trueTemplateOrTemplateBinding, falseTemplateOrTemplateBinding)](./foundation-utils.whenelse.md) | 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 |
@@ -42,6 +45,7 @@
 |  [DatabaseRecord](./foundation-utils.databaserecord.md) | Represents a database record. |
 |  [DesignSystemModule](./foundation-utils.designsystemmodule.md) |  |
 |  [DTOMapper](./foundation-utils.dtomapper.md) |  |
+|  [ErrorMap](./foundation-utils.errormap.md) |  |
 |  [JSONSerializer](./foundation-utils.jsonserializer.md) | An interface representing a JSON serializer. |
 |  [Logger](./foundation-utils.logger.md) | A logger that extends the <code>Consola</code> logger. |
 |  [LoggerOptions](./foundation-utils.loggeroptions.md) | Options for creating a logger. |
@@ -63,6 +67,7 @@
 |  --- | --- |
 |  [activeColorScheme](./foundation-utils.activecolorscheme.md) | A design token that represents the active color scheme (light or dark). |
 |  [API\_HOST](./foundation-utils.api_host.md) | The Genesis Server (host0 to establish a connection (WebSocket or HTTP)). Example: wss://localhost:9064 |
+|  [createErrorMap](./foundation-utils.createerrormap.md) | A factory to create the error map. |
 |  [createObserver](./foundation-utils.createobserver.md) | Creates a new event observer instance. |
 |  [DEFAULT\_ORGANISATION](./foundation-utils.default_organisation.md) | The default Organisation value, used in auth/login flow \[<code>genesislcap-foundation-login</code>\](https://link-to-docs). |
 |  [DEFAULT\_PASSWORD](./foundation-utils.default_password.md) | The default Password value, used in auth/login flow \[<code>genesislcap-foundation-login</code>\](https://link-to-docs). |
@@ -100,6 +105,8 @@
 |  [ConstructablePendingState](./foundation-utils.constructablependingstate.md) | A mixin that provides functionality for raising <code>pending-state</code> events. |
 |  [ConversionType](./foundation-utils.conversiontype.md) | Represents the possible types of value conversion for data synchronization. |
 |  [DesignSystemResource](./foundation-utils.designsystemresource.md) |  |
+|  [ErrorDetailMap](./foundation-utils.errordetailmap.md) |  |
+|  [ErrorMapLogger](./foundation-utils.errormaplogger.md) |  |
 |  [EventName](./foundation-utils.eventname.md) | Represents the possible event names for data synchronization. |
 |  [Listener](./foundation-utils.listener.md) | Creates an observer that facilitates the subscription and publication of events. |
 |  [PendingStateErrorEvent](./foundation-utils.pendingstateerrorevent.md) | A custom event that represents a <code>pending-state-error</code> event. |

package/docs/api-report.md

@@ -36,6 +36,9 @@ export type ConstructablePendingState = Constructable<FASTElement & HTMLElement>
 // @public
 export type ConversionType = 'string' | 'number' | 'time' | 'boolean';
 
+// @public
+export const createErrorMap: <TErrorDetailMap extends ErrorDetailMap>(logger: ErrorMapLogger) => ErrorMap<TErrorDetailMap>;
+
 // @public
 export function createLogger(name: string, options?: LoggerOptions): Logger;
 
@@ -121,6 +124,19 @@ export let DEFAULT_PASSWORD: string;
 // @public
 export let DEFAULT_USER: string;
 
+// @public (undocumented)
+export class DefaultErrorMap<TErrorDetailMap extends ErrorDetailMap> implements ErrorMap<TErrorDetailMap> {
+    constructor(logger: ErrorMapLogger);
+    clear(): void;
+    delete(key: keyof TErrorDetailMap): boolean;
+    get(key: keyof TErrorDetailMap): Error | undefined;
+    has(key: keyof TErrorDetailMap): boolean;
+    lastError: Error;
+    get messages(): string;
+    set(key: keyof TErrorDetailMap, error: Error): void;
+    get size(): number;
+}
+
 // @public
 export const defaultEventMap: Map<string, EventName>;
 
@@ -161,6 +177,19 @@ export interface DTOMapper<TDTO, TEntity> {
     toDTO: (entity: Partial<TEntity>) => TDTO;
 }
 
+// @public (undocumented)
+export type ErrorDetailMap = Record<string, unknown>;
+
+// @public (undocumented)
+export interface ErrorMap<TErrorDetailMap extends ErrorDetailMap> extends Pick<Map<keyof TErrorDetailMap, Error>, 'get' | 'has' | 'delete' | 'clear' | 'size'> {
+    readonly lastError: Error;
+    readonly messages: string;
+    set(key: keyof TErrorDetailMap, error: Error): void;
+}
+
+// @public (undocumented)
+export type ErrorMapLogger = (...args: any[]) => void;
+
 // @public
 export type EventName = 'input' | 'change' | 'default';
 
@@ -251,6 +280,12 @@ export const inSymphonyDesktop: () => boolean;
 // @public
 export const isDev: () => boolean;
 
+// @public
+export function JSONReplacer(key: string, value: any): any;
+
+// @public
+export function JSONReviver(key: string, value: any): any;
+
 // @public
 export interface JSONSerializer {
     deserialize<T = any>(response: Response): Promise<T>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.65.2",
+  "version": "14.66.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -10,11 +10,15 @@
     "PORT": 3040
   },
   "scripts": {
-    "build": "npm run clean && tsc -b ./tsconfig.json",
+    "api:extract": "api-extractor run --local",
+    "api:document": "api-documenter markdown -i dist -o docs/api",
+    "build": "npm run clean && tsc -b ./tsconfig.json && npm run api:extract && npm run api:document",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
     "dev": "tsc -b ./tsconfig.json -w"
   },
   "devDependencies": {
+    "@microsoft/api-documenter": "^7.19.13",
+    "@microsoft/api-extractor": "7.34.9",
     "rimraf": "^3.0.2",
     "typescript": "^4.5.5"
   },
@@ -35,5 +39,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "81839d85755a99ca03bc641c4c61e7546cee2194"
+  "gitHead": "5db6eb3195619a1d3e2cc2fcdb201748c778c62f"
 }