@genesislcap/foundation-utils 14.134.0 → 14.136.0

package/docs/api/foundation-utils.objectvisitor.visitobject.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; [visitObject](./foundation-utils.objectvisitor.visitobject.md)
+
+## ObjectVisitor.visitObject() 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
+visitObject(object: any, data: TVisitorData): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  object | any |  |
+|  data | TVisitorData |  |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,28 @@
+<!-- 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; [visitProperty](./foundation-utils.objectvisitor.visitproperty.md)
+
+## ObjectVisitor.visitProperty() 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
+visitProperty(object: any, key: PropertyKey, value: any, data: TVisitorData): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  object | any |  |
+|  key | PropertyKey |  |
+|  value | any |  |
+|  data | TVisitorData |  |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,59 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [reactive](./foundation-utils.reactive.md)
+
+## reactive() function
+
+> 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.
+> 
+
+Converts a plain object to a reactive, observable object.
+
+**Signature:**
+
+```typescript
+export declare function reactive<T>(object: T, deep?: boolean): T;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  object | T | The object to make reactive. |
+|  deep | boolean | _(Optional)_ Indicates whether to deeply convert the object. |
+
+**Returns:**
+
+T
+
+The converted object.
+
+## Example 1
+
+An array or reactive items.
+
+```ts
+this.todos = todosResponse.map((t) => reactive(t));
+```
+
+## Example 2
+
+Add item.
+
+```ts
+add(description: string) {
+   this.splice(this.todos.length, 0, reactive({ description, done: false }));
+}
+```
+
+## Example 3
+
+Remove item.
+
+```ts
+remove(todo: Todo) {
+   const index = this.todos.indexOf(todo);
+   index !== -1 && this.splice(index, 1);
+}
+```
+

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

@@ -0,0 +1,42 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [visitObject](./foundation-utils.visitobject.md)
+
+## visitObject() function
+
+> 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.
+> 
+
+Visit object utility.
+
+**Signature:**
+
+```typescript
+export declare function visitObject<TVisitorData>(object: any, deep: boolean, visitor: ObjectVisitor<TVisitorData>, data: TVisitorData, traversed: WeakSet<any> | Set<any>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  object | any | The object. |
+|  deep | boolean | A flag to indicate if a recursive visit of sub objects should occur. |
+|  visitor | [ObjectVisitor](./foundation-utils.objectvisitor.md)<!-- -->&lt;TVisitorData&gt; | The defined [ObjectVisitor](./foundation-utils.objectvisitor.md) logic. |
+|  data | TVisitorData | Visitor data. |
+|  traversed | WeakSet&lt;any&gt; \| Set&lt;any&gt; | The traversed object set. |
+
+**Returns:**
+
+void
+
+## Example
+
+Reactive example.
+
+```ts
+export function reactive<T>(object: T, deep = false): T {
+  visitObject(object, deep, makeObserverVisitor, void 0, observed);
+  return object;
+}
+```
+

package/docs/api-report.md

@@ -698,6 +698,16 @@ export class NumberParser {
     parse(localeNumber: string): number;
 }
 
+// @beta (undocumented)
+export interface ObjectVisitor<TVisitorData> {
+    // (undocumented)
+    visitArray(array: any[], data: TVisitorData): void;
+    // (undocumented)
+    visitObject(object: any, data: TVisitorData): void;
+    // (undocumented)
+    visitProperty(object: any, key: PropertyKey, value: any, data: TVisitorData): void;
+}
+
 // @public
 export interface Observer<EventType> {
     // (undocumented)
@@ -1060,6 +1070,9 @@ export const POPUP_DEFAULT_WIDTH = 483;
 // @public
 export type Publish<EventType> = (event: EventType) => void;
 
+// @beta
+export function reactive<T>(object: T, deep?: boolean): T;
+
 // @public
 export function renderOnChange(target: FASTElement & {
     render(): void;
@@ -1143,6 +1156,9 @@ export const UUID: InterfaceSymbol<UUID>;
 export interface UUIDConfig {
 }
 
+// @beta
+export function visitObject<TVisitorData>(object: any, deep: boolean, visitor: ObjectVisitor<TVisitorData>, data: TVisitorData, traversed: WeakSet<any> | Set<any>): void;
+
 // Warning: (ae-forgotten-export) The symbol "WhenTemplate" needs to be exported by the entry point index.d.ts
 //
 // @public

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.134.0",
+  "version": "14.136.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -19,12 +19,12 @@
     "test": "genx test"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.134.0",
-    "@genesislcap/genx": "14.134.0",
+    "@genesislcap/foundation-testing": "14.136.0",
+    "@genesislcap/genx": "14.136.0",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.134.0",
+    "@genesislcap/foundation-logger": "14.136.0",
     "@microsoft/fast-components": "^2.30.6",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
@@ -42,5 +42,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "2e07ccefac615ca60229b55ffed0da7ed23dfeca"
+  "gitHead": "0056e1c9602a30db4d30802cdfe48e7489d0abcd"
 }