@genesislcap/foundation-utils 14.408.0 → 14.409.0-FUI-2495.2

package/README.md

@@ -1,36 +1,12 @@
-# Genesis Foundation Utils
+# @genesislcap/foundation-utils
 
-The `@genesislcap/foundation-utils` package provides a collection of utility services and helpers designed to facilitate common development tasks within Genesis applications. It aims to enhance productivity by offering reusable solutions for patterns and problems encountered across different projects.
+Documentation for this package is published on the Genesis docs site:
 
-## API Documentation
-
-For more detailed information on API and configurations, please refer to the [API documentation](docs/api/index.md) in the `docs/api` directory.
-
-## Features
-
-The library encompasses a broad range of features, including:
-
-- **[Data](src/data/README.md)** - Manages in-memory databases and data storage solutions.
-- **[Decorators](src/decorators/README.md)** - Provides decorators for enhancing class functionalities, such as rendering on change.
-- **[Design System](src/design-system/README.md)** - Holds the design system configurations and utilities.
-- **[Directives](src/directives/README.md)** - Offers Angular-like directives for DOM manipulations, including conditional rendering and synchronization functionalities.
-- **[ENV](src/env/README.md)** - Contains utilities for environment variable management and detection of development environments.
-- **[Error](src/error/README.md)** - Deals with error mapping and handling strategies.
-- **[Formatters](src/formatters/README.md)** - Includes functions for formatting dates and numbers according to locale settings.
-- **[Logger](src/logger/README.md)** - A simple logging utility for debugging and information tracking.
-- **[Mappers](src/mappers/README.md)** - Focuses on data transformation, especially for DTOs (Data Transfer Objects).
-- **[Mixins](src/mixins/README.md)** - Provides mixins for common functionalities like lifecycle hooks and state management.
-- **[Observer](src/observer/README.md)** - Implements the Observer pattern for reactive programming.
-- **[Resource](src/observer/README.md)** - Defines types and interfaces for resource management.
-- **[Serializers](src/serializers/README.md)** - Contains serializers, particularly for JSON data handling.
-- **[State](src/state/README.md)** - Manages reactive state and provides utilities for state observation.
-- **[Styles](src/styles/README.md)** - Includes utilities for styling, dealing with colors, typography, and DOM styles.
-- **[UUID](src/uuid/README.md)** - Utilities for generating and managing UUIDs.
-- **[Window](src/window/README.md)** - Provides abstractions and utilities for window object manipulations.
+**Docs: [Utility methods](https://docs.genesis.global/docs/develop/client-capabilities/utility-methods/)**
 
 ## Installation
 
-To include `@genesislcap/foundation-utils` in your project, add it as a dependency in your `package.json` file and follow your project's routine for dependency installation.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {

package/dist/custom-elements.json

@@ -209,6 +209,245 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/converters/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./string-array-converter"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/converters/string-array-converter.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "stringArrayConverter",
+          "type": {
+            "text": "ValueConverter"
+          },
+          "default": "{\n  fromView(v: string): string | string[] | undefined {\n    if (!v?.trim()) return undefined;\n    return v.includes(',') ? v.split(',').map((s) => s.trim()) : v.trim();\n  },\n  toView(v: string | string[] | undefined): string {\n    if (typeof v === 'string') return v;\n    if (Array.isArray(v)) return v.join(',');\n    return '';\n  },\n}",
+          "description": "A @microsoft/fast-element#ValueConverter that converts between comma-separated string attributes\nand `string | string[]` properties.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "stringArrayConverter",
+          "declaration": {
+            "name": "stringArrayConverter",
+            "module": "src/converters/string-array-converter.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/data/inMemoryDatabase.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "An in memory database of specific DatabaseRecord types.",
+          "name": "InMemoryDatabase",
+          "members": [
+            {
+              "kind": "field",
+              "name": "isWorking",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "records",
+              "type": {
+                "text": "Record<string, T>"
+              },
+              "privacy": "private",
+              "default": "{}"
+            },
+            {
+              "kind": "field",
+              "name": "beforeUpdateListeners",
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "afterUpdateListeners",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "create",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "Promise<DatabaseAccessResult.Create<T>>"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "newValue",
+                  "type": {
+                    "text": "Omit<T, 'id'>"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "read",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "Promise<DatabaseAccessResult.Read<T>>"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "id",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "update",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "Promise<DatabaseAccessResult.Update<T>>"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "id",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "newValue",
+                  "type": {
+                    "text": "Omit<Partial<T>, 'id'>"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "delete",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "Promise<DatabaseAccessResult.Delete>"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "id",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "visit",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "Promise<void>"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "visitor",
+                  "type": {
+                    "text": "(record: T) => void"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "onBeforeUpdate",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "() => void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "listener",
+                  "type": {
+                    "text": "Listener<DatabaseEvent.BeforeUpdate<T>>"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "onAfterUpdate",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "() => void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "listener",
+                  "type": {
+                    "text": "Listener<DatabaseEvent.AfterUpdate<T>>"
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "InMemoryDatabase",
+          "declaration": {
+            "name": "InMemoryDatabase",
+            "module": "src/data/inMemoryDatabase.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/data/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./inMemoryDatabase"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/design-system/design-system.ts",
@@ -331,7 +570,7 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/directives/index.ts",
+      "path": "src/decorators/index.ts",
       "declarations": [],
       "exports": [
         {
@@ -339,24 +578,77 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./sync"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./when-else"
+            "package": "./renderOnChange"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/encoding/index.ts",
-      "declarations": [],
-      "exports": [
+      "path": "src/decorators/renderOnChange.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "renderOnChange",
+          "parameters": [
+            {
+              "name": "target",
+              "type": {
+                "text": "FASTElement & { render(): void }"
+              },
+              "description": "The target to define the property change handler on."
+            },
+            {
+              "name": "name",
+              "type": {
+                "text": "string"
+              },
+              "description": "The property name."
+            }
+          ],
+          "description": "Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "renderOnChange",
+          "declaration": {
+            "name": "renderOnChange",
+            "module": "src/decorators/renderOnChange.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/directives/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./sync"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./when-else"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/encoding/index.ts",
+      "declarations": [],
+      "exports": [
         {
           "kind": "js",
           "name": "*",
@@ -842,298 +1134,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/converters/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./string-array-converter"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/converters/string-array-converter.ts",
-      "declarations": [
-        {
-          "kind": "variable",
-          "name": "stringArrayConverter",
-          "type": {
-            "text": "ValueConverter"
-          },
-          "default": "{\n  fromView(v: string): string | string[] | undefined {\n    if (!v?.trim()) return undefined;\n    return v.includes(',') ? v.split(',').map((s) => s.trim()) : v.trim();\n  },\n  toView(v: string | string[] | undefined): string {\n    if (typeof v === 'string') return v;\n    if (Array.isArray(v)) return v.join(',');\n    return '';\n  },\n}",
-          "description": "A @microsoft/fast-element#ValueConverter that converts between comma-separated string attributes\nand `string | string[]` properties.",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "stringArrayConverter",
-          "declaration": {
-            "name": "stringArrayConverter",
-            "module": "src/converters/string-array-converter.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/data/inMemoryDatabase.ts",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "An in memory database of specific DatabaseRecord types.",
-          "name": "InMemoryDatabase",
-          "members": [
-            {
-              "kind": "field",
-              "name": "isWorking",
-              "type": {
-                "text": "boolean"
-              },
-              "privacy": "public",
-              "default": "false"
-            },
-            {
-              "kind": "field",
-              "name": "records",
-              "type": {
-                "text": "Record<string, T>"
-              },
-              "privacy": "private",
-              "default": "{}"
-            },
-            {
-              "kind": "field",
-              "name": "beforeUpdateListeners",
-              "privacy": "private"
-            },
-            {
-              "kind": "field",
-              "name": "afterUpdateListeners",
-              "privacy": "private"
-            },
-            {
-              "kind": "method",
-              "name": "create",
-              "privacy": "public",
-              "return": {
-                "type": {
-                  "text": "Promise<DatabaseAccessResult.Create<T>>"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "newValue",
-                  "type": {
-                    "text": "Omit<T, 'id'>"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "read",
-              "privacy": "public",
-              "return": {
-                "type": {
-                  "text": "Promise<DatabaseAccessResult.Read<T>>"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "id",
-                  "type": {
-                    "text": "string"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "update",
-              "privacy": "public",
-              "return": {
-                "type": {
-                  "text": "Promise<DatabaseAccessResult.Update<T>>"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "id",
-                  "type": {
-                    "text": "string"
-                  }
-                },
-                {
-                  "name": "newValue",
-                  "type": {
-                    "text": "Omit<Partial<T>, 'id'>"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "delete",
-              "privacy": "public",
-              "return": {
-                "type": {
-                  "text": "Promise<DatabaseAccessResult.Delete>"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "id",
-                  "type": {
-                    "text": "string"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "visit",
-              "privacy": "public",
-              "return": {
-                "type": {
-                  "text": "Promise<void>"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "visitor",
-                  "type": {
-                    "text": "(record: T) => void"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "onBeforeUpdate",
-              "privacy": "public",
-              "return": {
-                "type": {
-                  "text": "() => void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "listener",
-                  "type": {
-                    "text": "Listener<DatabaseEvent.BeforeUpdate<T>>"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "onAfterUpdate",
-              "privacy": "public",
-              "return": {
-                "type": {
-                  "text": "() => void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "listener",
-                  "type": {
-                    "text": "Listener<DatabaseEvent.AfterUpdate<T>>"
-                  }
-                }
-              ]
-            }
-          ]
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "InMemoryDatabase",
-          "declaration": {
-            "name": "InMemoryDatabase",
-            "module": "src/data/inMemoryDatabase.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/data/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./inMemoryDatabase"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/decorators/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./renderOnChange"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/decorators/renderOnChange.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "renderOnChange",
-          "parameters": [
-            {
-              "name": "target",
-              "type": {
-                "text": "FASTElement & { render(): void }"
-              },
-              "description": "The target to define the property change handler on."
-            },
-            {
-              "name": "name",
-              "type": {
-                "text": "string"
-              },
-              "description": "The property name."
-            }
-          ],
-          "description": "Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "renderOnChange",
-          "declaration": {
-            "name": "renderOnChange",
-            "module": "src/decorators/renderOnChange.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/error/errorMap.ts",