@genesislcap/foundation-utils 14.134.0 → 14.136.0

package/dist/custom-elements.json

@@ -117,6 +117,14 @@
             "package": "./serializers"
           }
         },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./state"
+          }
+        },
         {
           "kind": "js",
           "name": "*",
@@ -341,6 +349,56 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/design-system/design-system.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "assureDesignSystem",
+          "return": {
+            "type": {
+              "text": "DesignSystemModule"
+            }
+          },
+          "parameters": [
+            {
+              "name": "module",
+              "type": {
+                "text": "DesignSystemModule"
+              }
+            }
+          ],
+          "description": "assureDesignSystem.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "assureDesignSystem",
+          "declaration": {
+            "name": "assureDesignSystem",
+            "module": "src/design-system/design-system.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/design-system/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./design-system"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/decorators/index.ts",
@@ -417,56 +475,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/design-system/design-system.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "assureDesignSystem",
-          "return": {
-            "type": {
-              "text": "DesignSystemModule"
-            }
-          },
-          "parameters": [
-            {
-              "name": "module",
-              "type": {
-                "text": "DesignSystemModule"
-              }
-            }
-          ],
-          "description": "assureDesignSystem.",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "assureDesignSystem",
-          "declaration": {
-            "name": "assureDesignSystem",
-            "module": "src/design-system/design-system.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/design-system/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./design-system"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/env/index.ts",
@@ -1225,6 +1233,78 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/observer/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./observer"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/observer/observer.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "createObserver",
+          "return": {
+            "type": {
+              "text": "Observer<EventType>"
+            }
+          },
+          "description": "Creates a new event observer instance.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "respondToVisibility",
+          "parameters": [
+            {
+              "name": "element",
+              "type": {
+                "text": "HTMLElement"
+              },
+              "description": "HTMLElement to observe"
+            },
+            {
+              "name": "callback",
+              "type": {
+                "text": "(arg0: boolean) => any"
+              },
+              "description": "any function called when the visibility changes"
+            }
+          ],
+          "description": "Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "createObserver",
+          "declaration": {
+            "name": "createObserver",
+            "module": "src/observer/observer.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "respondToVisibility",
+          "declaration": {
+            "name": "respondToVisibility",
+            "module": "src/observer/observer.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/resource/index.ts",
@@ -1283,7 +1363,7 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/observer/index.ts",
+      "path": "src/state/index.ts",
       "declarations": [],
       "exports": [
         {
@@ -1291,64 +1371,118 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./observer"
+            "package": "./reactive"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./visitor"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/observer/observer.ts",
+      "path": "src/state/reactive.ts",
       "declarations": [
         {
           "kind": "function",
-          "name": "createObserver",
+          "name": "reactive",
           "return": {
             "type": {
-              "text": "Observer<EventType>"
+              "text": ""
             }
           },
-          "description": "Creates a new event observer instance.",
-          "privacy": "public"
-        },
-        {
-          "kind": "function",
-          "name": "respondToVisibility",
           "parameters": [
             {
-              "name": "element",
+              "name": "object",
               "type": {
-                "text": "HTMLElement"
+                "text": "T"
               },
-              "description": "HTMLElement to observe"
+              "description": "The object to make reactive."
             },
             {
-              "name": "callback",
-              "type": {
-                "text": "(arg0: boolean) => any"
-              },
-              "description": "any function called when the visibility changes"
+              "name": "deep",
+              "default": "false",
+              "description": "Indicates whether to deeply convert the object."
             }
           ],
-          "description": "Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen",
-          "privacy": "public"
+          "description": "Converts a plain object to a reactive, observable object."
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "createObserver",
+          "name": "reactive",
           "declaration": {
-            "name": "createObserver",
-            "module": "src/observer/observer.ts"
+            "name": "reactive",
+            "module": "src/state/reactive.ts"
           }
-        },
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/state/visitor.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "visitObject",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "object",
+              "type": {
+                "text": "any"
+              },
+              "description": "The object."
+            },
+            {
+              "name": "deep",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "A flag to indicate if a recursive visit of sub objects should occur."
+            },
+            {
+              "name": "visitor",
+              "type": {
+                "text": "ObjectVisitor<TVisitorData>"
+              },
+              "description": "The defined {@link ObjectVisitor}logic.\n * "
+            },
+            {
+              "name": "data",
+              "type": {
+                "text": "TVisitorData"
+              },
+              "description": "Visitor data."
+            },
+            {
+              "name": "traversed",
+              "type": {
+                "text": "WeakSet<any> | Set<any>"
+              },
+              "description": "The traversed object set."
+            }
+          ],
+          "description": "Visit object utility."
+        }
+      ],
+      "exports": [
         {
           "kind": "js",
-          "name": "respondToVisibility",
+          "name": "visitObject",
           "declaration": {
-            "name": "respondToVisibility",
-            "module": "src/observer/observer.ts"
+            "name": "visitObject",
+            "module": "src/state/visitor.ts"
           }
         }
       ]

package/dist/dts/index.d.ts

@@ -11,6 +11,7 @@ export * from './mixins';
 export * from './observer';
 export * from './resource';
 export * from './serializers';
+export * from './state';
 export * from './styles';
 export * from './uuid';
 export * from './window';

package/dist/dts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}

package/dist/dts/state/index.d.ts

@@ -0,0 +1,3 @@
+export * from './reactive';
+export * from './visitor';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/state/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/state/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/dist/dts/state/reactive.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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;
+//# sourceMappingURL=reactive.d.ts.map

package/dist/dts/state/reactive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reactive.d.ts","sourceRoot":"","sources":["../../../src/state/reactive.ts"],"names":[],"mappings":"AA6BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,UAAQ,GAAG,CAAC,CAGtD"}

package/dist/dts/state/visitor.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @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 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;
+}
+/**
+ * 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;
+//# sourceMappingURL=visitor.d.ts.map

package/dist/dts/state/visitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visitor.d.ts","sourceRoot":"","sources":["../../../src/state/visitor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,WAAW,aAAa,CAAC,YAAY;IACzC,WAAW,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI,CAAC;IACnD,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI,CAAC;IACnD,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI,CAAC;CACpF;AAMD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,WAAW,CAAC,YAAY,EACtC,MAAM,EAAE,GAAG,EACX,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC,EACpC,IAAI,EAAE,YAAY,EAClB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,GACjC,IAAI,CA8BN"}

package/dist/esm/index.js

@@ -11,6 +11,7 @@ export * from './mixins';
 export * from './observer';
 export * from './resource';
 export * from './serializers';
+export * from './state';
 export * from './styles';
 export * from './uuid';
 export * from './window';

package/dist/esm/state/index.js

@@ -0,0 +1,2 @@
+export * from './reactive';
+export * from './visitor';

package/dist/esm/state/reactive.js

@@ -0,0 +1,65 @@
+import { Observable } from '@microsoft/fast-element';
+import { visitObject } from './visitor.js';
+/**
+ * Code borrowed from fast-element v2. We can remove post upgrade.
+ */
+const noop = () => void 0;
+const observed = new WeakSet();
+const makeObserverVisitor = {
+    visitObject: noop,
+    visitArray: noop,
+    visitProperty(object, propertyName, value) {
+        Reflect.defineProperty(object, propertyName, {
+            enumerable: true,
+            get() {
+                Observable.track(object, propertyName);
+                return value;
+            },
+            set(newValue) {
+                if (value !== newValue) {
+                    value = newValue;
+                    Observable.notify(object, propertyName);
+                }
+            },
+        });
+    },
+};
+/**
+ * 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 function reactive(object, deep = false) {
+    visitObject(object, deep, makeObserverVisitor, void 0, observed);
+    return object;
+}

package/dist/esm/state/visitor.js

@@ -0,0 +1,53 @@
+function shouldTraverse(value, traversed) {
+    return value !== null && value !== void 0 && typeof value === 'object' && !traversed.has(value);
+}
+/**
+ * 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 function visitObject(object, deep, visitor, data, traversed) {
+    if (!shouldTraverse(object, traversed)) {
+        return;
+    }
+    traversed.add(object);
+    if (Array.isArray(object)) {
+        visitor.visitArray(object, data);
+        for (const item of object) {
+            visitObject(item, deep, visitor, data, traversed);
+        }
+    }
+    else {
+        visitor.visitObject(object, data);
+        for (const key in object) {
+            /**
+             * Added this hasOwnProperty guard
+             */
+            if (object.hasOwnProperty(key)) {
+                const value = object[key];
+                visitor.visitProperty(object, key, value, data);
+                if (deep) {
+                    visitObject(value, deep, visitor, data, traversed);
+                }
+            }
+        }
+    }
+}