@genesislcap/foundation-utils 14.134.0 → 14.136.0

package/dist/foundation-utils.api.json

@@ -8166,6 +8166,253 @@
           ],
           "implementsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-utils!ObjectVisitor:interface",
+          "docComment": "/**\n * @example\n *\n * Reactive visitor example.\n * ```ts\n * const makeObserverVisitor: ObjectVisitor<undefined> = {\n *   visitObject: noop,\n *   visitArray: noop,\n *   visitProperty(object: any, propertyName: string, value: any): void {\n *     Reflect.defineProperty(object, propertyName, {\n *       enumerable: true,\n *       get() {\n *         Observable.track(object, propertyName);\n *         return value;\n *       },\n *       set(newValue: any) {\n *         if (value !== newValue) {\n *           value = newValue;\n *           Observable.notify(object, propertyName);\n *         }\n *       },\n *     });\n *   },\n * };\n * ```\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface ObjectVisitor<TVisitorData> "
+            }
+          ],
+          "fileUrlPath": "src/state/visitor.ts",
+          "releaseTag": "Beta",
+          "typeParameters": [
+            {
+              "typeParameterName": "TVisitorData",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "ObjectVisitor",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-utils!ObjectVisitor#visitArray:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "visitArray(array: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", data: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "TVisitorData"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Beta",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "array",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "data",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "visitArray"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-utils!ObjectVisitor#visitObject:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "visitObject(object: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", data: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "TVisitorData"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Beta",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "object",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "data",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "visitObject"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-utils!ObjectVisitor#visitProperty:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "visitProperty(object: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", key: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PropertyKey",
+                  "canonicalReference": "!PropertyKey:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", value: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", data: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "TVisitorData"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 10
+              },
+              "releaseTag": "Beta",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "object",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "key",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "value",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "data",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "visitProperty"
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-utils!Observer:interface",
@@ -11424,6 +11671,80 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-utils!reactive:function(1)",
+          "docComment": "/**\n * Converts a plain object to a reactive, observable object.\n *\n * @param object - The object to make reactive.\n *\n * @param deep - Indicates whether to deeply convert the object.\n *\n * @returns The converted object.\n *\n * @example\n *\n * An array or reactive items.\n * ```ts\n * this.todos = todosResponse.map((t) => reactive(t));\n * ```\n *\n * @example\n *\n * Add item.\n * ```ts\n * add(description: string) {\n *    this.splice(this.todos.length, 0, reactive({ description, done: false }));\n * }\n * ```\n *\n * @example\n *\n * Remove item.\n * ```ts\n * remove(todo: Todo) {\n *    const index = this.todos.indexOf(todo);\n *    index !== -1 && this.splice(index, 1);\n * }\n * ```\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function reactive<T>(object: "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": ", deep?: "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/state/reactive.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Beta",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "object",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "deep",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "reactive"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-utils!renderOnChange:function(1)",
@@ -12352,6 +12673,147 @@
           "members": [],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-utils!visitObject:function(1)",
+          "docComment": "/**\n * Visit object utility.\n *\n * @param object - The object.\n *\n * @param deep - A flag to indicate if a recursive visit of sub objects should occur.\n *\n * @param visitor - The defined {@link ObjectVisitor} logic.\n *\n * @param data - Visitor data.\n *\n * @param traversed - The traversed object set.\n *\n * @example\n *\n * Reactive example.\n * ```ts\n * export function reactive<T>(object: T, deep = false): T {\n *   visitObject(object, deep, makeObserverVisitor, void 0, observed);\n *   return object;\n * }\n * ```\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function visitObject<TVisitorData>(object: "
+            },
+            {
+              "kind": "Content",
+              "text": "any"
+            },
+            {
+              "kind": "Content",
+              "text": ", deep: "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            },
+            {
+              "kind": "Content",
+              "text": ", visitor: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ObjectVisitor",
+              "canonicalReference": "@genesislcap/foundation-utils!ObjectVisitor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<TVisitorData>"
+            },
+            {
+              "kind": "Content",
+              "text": ", data: "
+            },
+            {
+              "kind": "Content",
+              "text": "TVisitorData"
+            },
+            {
+              "kind": "Content",
+              "text": ", traversed: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WeakSet",
+              "canonicalReference": "!WeakSet:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<any> | "
+            },
+            {
+              "kind": "Reference",
+              "text": "Set",
+              "canonicalReference": "!Set:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<any>"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/state/visitor.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 15,
+            "endIndex": 16
+          },
+          "releaseTag": "Beta",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "object",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "deep",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "visitor",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 7
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "data",
+              "parameterTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 9
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "traversed",
+              "parameterTypeTokenRange": {
+                "startIndex": 10,
+                "endIndex": 14
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "TVisitorData",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "visitObject"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-utils!whenElse:function(1)",

package/dist/foundation-utils.d.ts

@@ -1077,6 +1077,42 @@ export declare class NumberParser {
     hasSeparator(localeNumber: string): boolean;
 }
 
+/**
+ * @privateRemarks
+ * Code borrowed from fast-element v2. We can remove post upgrade.
+ *
+ * @example
+ * Reactive visitor example.
+ * ```ts
+ * const makeObserverVisitor: ObjectVisitor<undefined> = {
+ *   visitObject: noop,
+ *   visitArray: noop,
+ *   visitProperty(object: any, propertyName: string, value: any): void {
+ *     Reflect.defineProperty(object, propertyName, {
+ *       enumerable: true,
+ *       get() {
+ *         Observable.track(object, propertyName);
+ *         return value;
+ *       },
+ *       set(newValue: any) {
+ *         if (value !== newValue) {
+ *           value = newValue;
+ *           Observable.notify(object, propertyName);
+ *         }
+ *       },
+ *     });
+ *   },
+ * };
+ * ```
+ *
+ * @beta
+ */
+export declare interface ObjectVisitor<TVisitorData> {
+    visitObject(object: any, data: TVisitorData): void;
+    visitArray(array: any[], data: TVisitorData): void;
+    visitProperty(object: any, key: PropertyKey, value: any, data: TVisitorData): void;
+}
+
 /**
  * Represents an event observer that manages the subscription and publication of events.
  * @public
@@ -1509,6 +1545,43 @@ export declare const POPUP_DEFAULT_WIDTH = 483;
  */
 export declare type Publish<EventType> = (event: EventType) => void;
 
+/**
+ * Converts a plain object to a reactive, observable object.
+ *
+ * @privateRemarks
+ * Code borrowed from fast-element v2. We can remove post upgrade.
+ *
+ * @example
+ * An array or reactive items.
+ * ```ts
+ * this.todos = todosResponse.map((t) => reactive(t));
+ * ```
+ *
+ * @example
+ * Add item.
+ * ```ts
+ * add(description: string) {
+ *    this.splice(this.todos.length, 0, reactive({ description, done: false }));
+ * }
+ * ```
+ *
+ * @example
+ * Remove item.
+ * ```ts
+ * remove(todo: Todo) {
+ *    const index = this.todos.indexOf(todo);
+ *    index !== -1 && this.splice(index, 1);
+ * }
+ *```
+ *
+ * @param object - The object to make reactive.
+ * @param deep - Indicates whether to deeply convert the object.
+ * @returns The converted object.
+ *
+ * @beta
+ */
+export declare function reactive<T>(object: T, deep?: boolean): T;
+
 /**
  * Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.
  *
@@ -1705,6 +1778,31 @@ export declare const UUID: InterfaceSymbol<UUID>;
 export declare interface UUIDConfig {
 }
 
+/**
+ * Visit object utility.
+ *
+ * @privateRemarks
+ * Code borrowed from fast-element v2. We can remove post upgrade.
+ *
+ * @example
+ * Reactive example.
+ * ```ts
+ * export function reactive<T>(object: T, deep = false): T {
+ *   visitObject(object, deep, makeObserverVisitor, void 0, observed);
+ *   return object;
+ * }
+ * ```
+ *
+ * @param object - The object.
+ * @param deep - A flag to indicate if a recursive visit of sub objects should occur.
+ * @param visitor - The defined {@link ObjectVisitor} logic.
+ * @param data - Visitor data.
+ * @param traversed - The traversed object set.
+ *
+ * @beta
+ */
+export declare function visitObject<TVisitorData>(object: any, deep: boolean, visitor: ObjectVisitor<TVisitorData>, data: TVisitorData, traversed: WeakSet<any> | Set<any>): void;
+
 /**
  * Directive that allows supplying an "else" template to the traditional {@link https://www.fast.design/docs/api/fast-element.when/#when-function} directive
  *

package/docs/api/foundation-utils.md

@@ -34,9 +34,11 @@
 |  [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. |
+|  [reactive(object, deep)](./foundation-utils.reactive.md) | **_(BETA)_** Converts a plain object to a reactive, observable object. |
 |  [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, |
 |  [toElementStyles(styles)](./foundation-utils.toelementstyles.md) | toElementStyles. |
+|  [visitObject(object, deep, visitor, data, traversed)](./foundation-utils.visitobject.md) | **_(BETA)_** Visit object utility. |
 |  [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 |
 
 ## Interfaces
@@ -52,6 +54,7 @@
 |  [JSONSerializerConfig](./foundation-utils.jsonserializerconfig.md) | Configuration options for the JSONSerializer Config instance. |
 |  [Logger](./foundation-utils.logger.md) | A logger that extends the <code>Consola</code> logger. |
 |  [LoggerOptions](./foundation-utils.loggeroptions.md) | Options for creating a logger. |
+|  [ObjectVisitor](./foundation-utils.objectvisitor.md) | **_(BETA)_** |
 |  [Observer](./foundation-utils.observer.md) | Represents an event observer that manages the subscription and publication of events. |
 |  [ServerRowDTOMapper](./foundation-utils.serverrowdtomapper.md) | A mapper for converting between server row DTOs and entities. Provides methods to get/set a ServerRow DTO entity mapping. |
 |  [UUID](./foundation-utils.uuid.md) | An interface for generating UUIDs. |

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

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [ObjectVisitor](./foundation-utils.objectvisitor.md)
+
+## ObjectVisitor interface
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+export interface ObjectVisitor<TVisitorData> 
+```
+
+## Example
+
+Reactive visitor example.
+
+```ts
+const makeObserverVisitor: ObjectVisitor<undefined> = {
+  visitObject: noop,
+  visitArray: noop,
+  visitProperty(object: any, propertyName: string, value: any): void {
+    Reflect.defineProperty(object, propertyName, {
+      enumerable: true,
+      get() {
+        Observable.track(object, propertyName);
+        return value;
+      },
+      set(newValue: any) {
+        if (value !== newValue) {
+          value = newValue;
+          Observable.notify(object, propertyName);
+        }
+      },
+    });
+  },
+};
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [visitArray(array, data)](./foundation-utils.objectvisitor.visitarray.md) | **_(BETA)_** |
+|  [visitObject(object, data)](./foundation-utils.objectvisitor.visitobject.md) | **_(BETA)_** |
+|  [visitProperty(object, key, value, data)](./foundation-utils.objectvisitor.visitproperty.md) | **_(BETA)_** |
+

package/docs/api/foundation-utils.objectvisitor.visitarray.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; [ObjectVisitor](./foundation-utils.objectvisitor.md) &gt; [visitArray](./foundation-utils.objectvisitor.visitarray.md)
+
+## ObjectVisitor.visitArray() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+visitArray(array: any[], data: TVisitorData): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  array | any\[\] |  |
+|  data | TVisitorData |  |
+
+**Returns:**
+
+void
+