@genesislcap/foundation-utils 14.22.1 → 14.23.0

package/dist/custom-elements.json

@@ -333,59 +333,6 @@
         }
       ]
     },
-    {
-      "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/design-system/design-system.ts",
@@ -458,6 +405,59 @@
         }
       ]
     },
+    {
+      "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/env/index.ts",
@@ -487,7 +487,9 @@
       "declarations": [
         {
           "kind": "function",
-          "name": "isDev"
+          "name": "isDev",
+          "description": "Determines if the current environment is a development environment.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -517,7 +519,9 @@
           "name": "_API_HOST",
           "type": {
             "text": "string"
-          }
+          },
+          "description": "The Genesis Server (host0 to establish a connection (WebSocket or HTTP)).\nExample: wss://localhost:9064",
+          "privacy": "public"
         },
         {
           "kind": "variable",
@@ -531,7 +535,9 @@
           "name": "_FORCE_HTTP",
           "type": {
             "text": "string"
-          }
+          },
+          "description": "The path to a JSON config file for the HTTP mode.",
+          "privacy": "public"
         },
         {
           "kind": "variable",
@@ -545,7 +551,9 @@
           "name": "_HTTP_CONFIG",
           "type": {
             "text": "string"
-          }
+          },
+          "description": "Configuration settings for HTTP, used in http connect flow [`genesislcap-foundation-comms.HttpConnectConfig`](https://link-to-docs).",
+          "privacy": "public"
         },
         {
           "kind": "variable",
@@ -559,7 +567,9 @@
           "name": "_DEFAULT_ORGANISATION",
           "type": {
             "text": "string"
-          }
+          },
+          "description": "The default Organisation value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).",
+          "privacy": "public"
         },
         {
           "kind": "variable",
@@ -573,7 +583,9 @@
           "name": "_DEFAULT_PASSWORD",
           "type": {
             "text": "string"
-          }
+          },
+          "description": "The default Password value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).",
+          "privacy": "public"
         },
         {
           "kind": "variable",
@@ -587,7 +599,9 @@
           "name": "_DEFAULT_USER",
           "type": {
             "text": "string"
-          }
+          },
+          "description": "The default Username value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).",
+          "privacy": "public"
         },
         {
           "kind": "variable",
@@ -601,7 +615,9 @@
           "name": "_SOCKET_EXT",
           "type": {
             "text": "string"
-          }
+          },
+          "description": "The sub-path used for WebSocket connections.\nExample: API_HOST + '/' + SOCKET_EXT - wss://localhost:9064/gwf.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -800,14 +816,16 @@
           "type": {
             "text": "LoggerOptions"
           },
-          "default": "{\n  level: logLevelDebug,\n}"
+          "default": "{\n  level: logLevelDebug,\n}",
+          "description": "The default logger options.",
+          "privacy": "public"
         },
         {
           "kind": "function",
           "name": "createLogger",
           "return": {
             "type": {
-              "text": "Logger"
+              "text": ""
             }
           },
           "parameters": [
@@ -815,16 +833,20 @@
               "name": "name",
               "type": {
                 "text": "string"
-              }
+              },
+              "description": "The name to give the logger."
             },
             {
               "name": "options",
               "default": "defaultLoggerOptions",
               "type": {
                 "text": "LoggerOptions"
-              }
+              },
+              "description": "The options to use when creating the logger."
             }
-          ]
+          ],
+          "description": "Creates a logger with the given name and options.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -892,46 +914,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/resource/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./types"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/resource/types.ts",
-      "declarations": [
-        {
-          "kind": "variable",
-          "name": "ResourceType",
-          "type": {
-            "text": "{\n  local: 'local',\n  remote: 'remote',\n}"
-          },
-          "default": "{\n  local: 'local',\n  remote: 'remote',\n}",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "ResourceType",
-          "declaration": {
-            "name": "ResourceType",
-            "module": "src/resource/types.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/observer/index.ts",
@@ -958,7 +940,9 @@
             "type": {
               "text": "Observer<EventType>"
             }
-          }
+          },
+          "description": "Creates a new event observer instance.",
+          "privacy": "public"
         },
         {
           "kind": "function",
@@ -976,7 +960,7 @@
               "type": {
                 "text": "(arg0: boolean) => any"
               },
-              "description": "(boolean) => any function called when the visibility changes"
+              "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",
@@ -1002,6 +986,47 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/resource/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./types"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/resource/types.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "ResourceType",
+          "type": {
+            "text": "{\n  local: 'local',\n  remote: 'remote',\n}"
+          },
+          "default": "{\n  local: 'local',\n  remote: 'remote',\n}",
+          "description": "An object that defines two resource types: \"local\" and \"remote\".",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ResourceType",
+          "declaration": {
+            "name": "ResourceType",
+            "module": "src/resource/types.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/serializers/index.ts",
@@ -1023,7 +1048,9 @@
       "declarations": [
         {
           "kind": "variable",
-          "name": "activeColorScheme"
+          "name": "activeColorScheme",
+          "description": "A design token that represents the active color scheme (light or dark).",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1046,7 +1073,7 @@
           "name": "insertDocumentCSSRule",
           "return": {
             "type": {
-              "text": "(() => void)"
+              "text": ""
             }
           },
           "parameters": [
@@ -1054,15 +1081,19 @@
               "name": "cssRule",
               "type": {
                 "text": "string"
-              }
+              },
+              "description": "The CSS rule to insert."
             },
             {
               "name": "styleElementId",
               "type": {
                 "text": "string"
-              }
+              },
+              "description": "The ID of the style element to use or create."
             }
-          ]
+          ],
+          "description": "Inserts a CSS rule into the document by creating a new style element or using an existing one with the specified ID.\nReturns a function that can be called to remove the rule from the document.",
+          "privacy": "public"
         },
         {
           "kind": "function",
@@ -1072,9 +1103,12 @@
               "name": "href",
               "type": {
                 "text": "string"
-              }
+              },
+              "description": "The URL of the CSS file to insert."
             }
-          ]
+          ],
+          "description": "Inserts a CSS link into the document if it doesn't already exist.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1141,7 +1175,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "",
+          "description": "A custom element that encapsulates a set of styles that can be applied to slotted elements.",
           "name": "SlottedStyles",
           "members": [
             {
@@ -1149,7 +1183,8 @@
               "name": "styles",
               "type": {
                 "text": "ElementStyles"
-              }
+              },
+              "description": "The styles to apply to slotted elements."
             },
             {
               "kind": "method",
@@ -1164,15 +1199,18 @@
                   "name": "prev",
                   "type": {
                     "text": "ElementStyles"
-                  }
+                  },
+                  "description": "The previous value of the `styles` property."
                 },
                 {
                   "name": "next",
                   "type": {
                     "text": "ElementStyles"
-                  }
+                  },
+                  "description": "The new value of the `styles` property."
                 }
-              ]
+              ],
+              "description": "Called when the `styles` property changes.\nRemoves the previous styles from the parent element's FAST controller and adds the new styles."
             }
           ],
           "superclass": {
@@ -1209,40 +1247,65 @@
         {
           "kind": "function",
           "name": "loadFontFaces",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
           "parameters": [
             {
-              "name": "fontFaceRules"
+              "name": "fontFaceRules",
+              "type": {
+                "text": "string"
+              },
+              "description": "The CSS rules for the font faces."
             },
             {
-              "name": "styleElementId"
+              "name": "styleElementId",
+              "type": {
+                "text": "string"
+              },
+              "description": "The ID of the style element to insert into the document."
             }
-          ]
+          ],
+          "description": "Loads font faces by inserting a style element with the specified font face rules into the document.",
+          "privacy": "public"
         },
         {
           "kind": "function",
           "name": "getFontMixin",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
           "parameters": [
             {
               "name": "family",
               "type": {
                 "text": "string"
-              }
+              },
+              "description": "The font family."
             },
             {
               "name": "style",
               "default": "FontStyle.Normal",
               "type": {
                 "text": "FontStyle"
-              }
+              },
+              "description": "Optional. The font style. Defaults to FontStyle.Normal."
             },
             {
               "name": "weight",
               "default": "FontWeight.Regular",
               "type": {
                 "text": "FontWeight"
-              }
+              },
+              "description": "Optional. The font weight. Defaults to FontWeight.Regular."
             }
-          ]
+          ],
+          "description": "Generates a CSS mixin for the specified font family, style, and weight.",
+          "privacy": "public"
         },
         {
           "kind": "variable",
@@ -1250,7 +1313,9 @@
           "type": {
             "text": "{\n  minusOne: -1,\n  minusTwo: -2,\n  plusOne: 1,\n  plusTwo: 2,\n  plusThree: 3,\n  plusFour: 4,\n  plusFive: 5,\n  plusSix: 6,\n}"
           },
-          "default": "{\n  minusOne: -1,\n  minusTwo: -2,\n  plusOne: 1,\n  plusTwo: 2,\n  plusThree: 3,\n  plusFour: 4,\n  plusFive: 5,\n  plusSix: 6,\n}"
+          "default": "{\n  minusOne: -1,\n  minusTwo: -2,\n  plusOne: 1,\n  plusTwo: 2,\n  plusThree: 3,\n  plusFour: 4,\n  plusFive: 5,\n  plusSix: 6,\n}",
+          "description": "An object containing type ramp values.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1336,7 +1401,9 @@
       "declarations": [
         {
           "kind": "variable",
-          "name": "UUID"
+          "name": "UUID",
+          "description": "A dependency injection token for the UUID interface.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1371,11 +1438,25 @@
       "declarations": [
         {
           "kind": "function",
-          "name": "inIFrame"
+          "name": "inIFrame",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "description": "Returns a boolean value indicating whether the current window is inside an iframe.",
+          "privacy": "public"
         },
         {
           "kind": "function",
-          "name": "inSymphonyDesktop"
+          "name": "inSymphonyDesktop",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "description": "Returns a boolean value indicating whether the user is running the Symphony desktop app.",
+          "privacy": "public"
         },
         {
           "kind": "variable",
@@ -1383,7 +1464,9 @@
           "type": {
             "text": "number"
           },
-          "default": "483"
+          "default": "483",
+          "description": "The default width (in pixels) for pop-up windows.",
+          "privacy": "public"
         },
         {
           "kind": "variable",
@@ -1391,39 +1474,52 @@
           "type": {
             "text": "number"
           },
-          "default": "600"
+          "default": "600",
+          "description": "The default height (in pixels) for pop-up windows.",
+          "privacy": "public"
         },
         {
           "kind": "function",
           "name": "openPopup",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
           "parameters": [
             {
               "name": "urlNavigate",
               "type": {
                 "text": "string"
-              }
+              },
+              "description": "The URL to navigate to."
             },
             {
               "name": "target",
               "type": {
                 "text": "string"
-              }
+              },
+              "description": "The name of the new window."
             },
             {
               "name": "popUpWidth",
               "default": "POPUP_DEFAULT_WIDTH",
               "type": {
                 "text": "number"
-              }
+              },
+              "description": "The width of the new window (optional)."
             },
             {
               "name": "popUpHeight",
               "default": "POPUP_DEFAULT_HEIGHT",
               "type": {
                 "text": "number"
-              }
+              },
+              "description": "The height of the new window (optional)."
             }
-          ]
+          ],
+          "description": "Opens a new browser window with the specified URL, target, width, and height.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1494,7 +1590,9 @@
           "type": {
             "text": "Map<string, EventName>"
           },
-          "default": "new Map([\n  ['FAST-TEXT-AREA', 'input'],\n  ['FAST-TEXT-FIELD', 'input'],\n  ['FOUNDATION-TEXT-AREA', 'input'],\n  ['FOUNDATION-TEXT-FIELD', 'input'],\n  ['INPUT', 'input'],\n  ['ZERO-TEXT-FIELD', 'input'],\n])"
+          "default": "new Map([\n  ['FAST-TEXT-AREA', 'input'],\n  ['FAST-TEXT-FIELD', 'input'],\n  ['FOUNDATION-TEXT-AREA', 'input'],\n  ['FOUNDATION-TEXT-FIELD', 'input'],\n  ['INPUT', 'input'],\n  ['ZERO-TEXT-FIELD', 'input'],\n])",
+          "description": "A map that associates specific HTML element tags with their corresponding default event names.",
+          "privacy": "public"
         },
         {
           "kind": "function",
@@ -1532,7 +1630,9 @@
                 "text": "string"
               }
             }
-          ]
+          ],
+          "description": "Creates a synchronization directive that binds a data source to an HTML element,",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1604,7 +1704,7 @@
               "description": "The template or a binding that gets the template to render when the condition is false."
             }
           ],
-          "description": "Directive that allows supplying an \"else\" template to the traditional @link @microsoft/fast-element#when directive",
+          "description": "Directive that allows supplying an \"else\" template to the traditional https://www.fast.design/docs/api/fast-element.when/#when-function directive",
           "privacy": "public"
         }
       ],
@@ -1648,22 +1748,50 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "",
+          "description": "The default `ServerRowDTOMapper`.",
           "name": "DefaultServerRowDTOMapper",
           "members": [
             {
               "kind": "field",
-              "name": "fromDTO"
+              "name": "fromDTO",
+              "description": "Converts a server row DTO to an entity.",
+              "parameters": [
+                {
+                  "description": "The DTO to convert.",
+                  "name": "dto"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "privacy": "public"
             },
             {
               "kind": "field",
-              "name": "toDTO"
+              "name": "toDTO",
+              "description": "Converts a server row entity to a DTO.",
+              "parameters": [
+                {
+                  "description": "The entity to convert.",
+                  "name": "entity"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "privacy": "public"
             }
           ]
         },
         {
           "kind": "variable",
-          "name": "ServerRowDTOMapper"
+          "name": "ServerRowDTOMapper",
+          "description": "A DI token used to obtain a `ServerRowDTOMapper` instance.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1819,7 +1947,7 @@
       "declarations": [
         {
           "kind": "mixin",
-          "description": "",
+          "description": "The `PendingState` mixin.",
           "name": "PendingState",
           "members": [
             {
@@ -1829,7 +1957,8 @@
                 "text": "number"
               },
               "privacy": "public",
-              "default": "0"
+              "default": "0",
+              "description": "The number of promises that are currently pending."
             },
             {
               "kind": "field",
@@ -1838,7 +1967,8 @@
                 "text": "number"
               },
               "privacy": "public",
-              "default": "0"
+              "default": "0",
+              "description": "The number of promises that have been resolved."
             },
             {
               "kind": "field",
@@ -1847,7 +1977,8 @@
                 "text": "boolean"
               },
               "privacy": "public",
-              "default": "false"
+              "default": "false",
+              "description": "A boolean indicating whether there are any pending children."
             },
             {
               "kind": "field",
@@ -1856,25 +1987,8 @@
                 "text": "number"
               },
               "privacy": "public",
+              "description": "Gets the progress of the pending promises as a percentage between 0 and 1.",
               "readonly": true
-            },
-            {
-              "kind": "method",
-              "name": "onPendingState",
-              "privacy": "public",
-              "return": {
-                "type": {
-                  "text": "Promise<void>"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "{ detail }",
-                  "type": {
-                    "text": "PendingStateEvent"
-                  }
-                }
-              ]
             }
           ],
           "parameters": [
@@ -1884,7 +1998,8 @@
                 "text": "TBase"
               }
             }
-          ]
+          ],
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1919,7 +2034,9 @@
       "declarations": [
         {
           "kind": "variable",
-          "name": "JSONSerializer"
+          "name": "JSONSerializer",
+          "description": "A DI token for the JSON serializer.",
+          "privacy": "public"
         }
       ],
       "exports": [