@genesislcap/foundation-utils 14.187.1 → 14.188.0

package/dist/custom-elements.json

@@ -565,6 +565,13 @@
           "description": "The path to a JSON config file for the HTTP mode.",
           "privacy": "public"
         },
+        {
+          "kind": "variable",
+          "name": "GENESIS_SOCKET_URL",
+          "default": "`${location.protocol.replace('http', 'ws')}//${location.host}/${_SOCKET_EXT}/`",
+          "description": "Genesis Socket URL",
+          "privacy": "public"
+        },
         {
           "kind": "variable",
           "name": "API_HOST",
@@ -664,6 +671,14 @@
             "module": "src/env/variables.ts"
           }
         },
+        {
+          "kind": "js",
+          "name": "GENESIS_SOCKET_URL",
+          "declaration": {
+            "name": "GENESIS_SOCKET_URL",
+            "module": "src/env/variables.ts"
+          }
+        },
         {
           "kind": "js",
           "name": "API_HOST",
@@ -1425,6 +1440,132 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/state/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./reactive"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./visitor"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/state/reactive.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "reactive",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "parameters": [
+            {
+              "name": "object",
+              "type": {
+                "text": "T"
+              },
+              "description": "The object to make reactive."
+            },
+            {
+              "name": "deep",
+              "default": "false",
+              "description": "Indicates whether to deeply convert the object."
+            }
+          ],
+          "description": "Converts a plain object to a reactive, observable object."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "reactive",
+          "declaration": {
+            "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": "visitObject",
+          "declaration": {
+            "name": "visitObject",
+            "module": "src/state/visitor.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/styles/color.ts",
@@ -1774,7 +1915,7 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/uuid/index.ts",
+      "path": "src/utils/index.ts",
       "declarations": [],
       "exports": [
         {
@@ -1782,36 +1923,34 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./uuid"
+            "package": "./logger"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/uuid/uuid.ts",
+      "path": "src/utils/logger.ts",
       "declarations": [
         {
           "kind": "variable",
-          "name": "UUID",
-          "description": "A dependency injection token for the UUID interface.",
-          "privacy": "public"
+          "name": "logger"
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "UUID",
+          "name": "logger",
           "declaration": {
-            "name": "UUID",
-            "module": "src/uuid/uuid.ts"
+            "name": "logger",
+            "module": "src/utils/logger.ts"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/utils/index.ts",
+      "path": "src/uuid/index.ts",
       "declarations": [],
       "exports": [
         {
@@ -1819,27 +1958,29 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./logger"
+            "package": "./uuid"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/utils/logger.ts",
+      "path": "src/uuid/uuid.ts",
       "declarations": [
         {
           "kind": "variable",
-          "name": "logger"
+          "name": "UUID",
+          "description": "A dependency injection token for the UUID interface.",
+          "privacy": "public"
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "logger",
+          "name": "UUID",
           "declaration": {
-            "name": "logger",
-            "module": "src/utils/logger.ts"
+            "name": "UUID",
+            "module": "src/uuid/uuid.ts"
           }
         }
       ]
@@ -2081,6 +2222,71 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/directives/when-else/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./when-else"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/directives/when-else/when-else.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "whenElse",
+          "return": {
+            "type": {
+              "text": "CaptureType<TSource>"
+            }
+          },
+          "parameters": [
+            {
+              "name": "binding",
+              "type": {
+                "text": "Binding<TSource, TReturn>"
+              },
+              "description": "The condition to test for rendering."
+            },
+            {
+              "name": "trueTemplateOrTemplateBinding",
+              "type": {
+                "text": "WhenTemplate<TSource>"
+              },
+              "description": "The template or a binding that gets the template to render when the condition is true."
+            },
+            {
+              "name": "falseTemplateOrTemplateBinding",
+              "type": {
+                "text": "WhenTemplate<TSource>"
+              },
+              "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 https://www.fast.design/docs/api/fast-element.when/#when-function directive",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "whenElse",
+          "declaration": {
+            "name": "whenElse",
+            "module": "src/directives/when-else/when-else.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/mappers/dto/index.ts",
@@ -2181,71 +2387,6 @@
       "declarations": [],
       "exports": []
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/directives/when-else/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./when-else"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/directives/when-else/when-else.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "whenElse",
-          "return": {
-            "type": {
-              "text": "CaptureType<TSource>"
-            }
-          },
-          "parameters": [
-            {
-              "name": "binding",
-              "type": {
-                "text": "Binding<TSource, TReturn>"
-              },
-              "description": "The condition to test for rendering."
-            },
-            {
-              "name": "trueTemplateOrTemplateBinding",
-              "type": {
-                "text": "WhenTemplate<TSource>"
-              },
-              "description": "The template or a binding that gets the template to render when the condition is true."
-            },
-            {
-              "name": "falseTemplateOrTemplateBinding",
-              "type": {
-                "text": "WhenTemplate<TSource>"
-              },
-              "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 https://www.fast.design/docs/api/fast-element.when/#when-function directive",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "whenElse",
-          "declaration": {
-            "name": "whenElse",
-            "module": "src/directives/when-else/when-else.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/mixins/lifecycle/index.ts",
@@ -2457,132 +2598,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/state/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./reactive"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./visitor"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/state/reactive.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "reactive",
-          "return": {
-            "type": {
-              "text": ""
-            }
-          },
-          "parameters": [
-            {
-              "name": "object",
-              "type": {
-                "text": "T"
-              },
-              "description": "The object to make reactive."
-            },
-            {
-              "name": "deep",
-              "default": "false",
-              "description": "Indicates whether to deeply convert the object."
-            }
-          ],
-          "description": "Converts a plain object to a reactive, observable object."
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "reactive",
-          "declaration": {
-            "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": "visitObject",
-          "declaration": {
-            "name": "visitObject",
-            "module": "src/state/visitor.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/serializers/json/index.ts",

package/dist/dts/env/variables.d.ts

@@ -16,6 +16,17 @@ export { _SOCKET_EXT as SOCKET_EXT };
  */
 declare let _FORCE_HTTP: string;
 export { _FORCE_HTTP as FORCE_HTTP };
+/**
+ * Genesis Socket URL
+ * @remarks
+ * Built from the current {@link https://developer.mozilla.org/en-US/docs/Web/API/Location} object and {@link SOCKET_EXT | socket extension}.
+ * @example
+ * ```ts
+ * await this.connect.connect(GENESIS_SOCKET_URL); // < wss://localhost:6060/gwf/
+ * ```
+ * @public
+ */
+export declare const GENESIS_SOCKET_URL: string;
 /**
  * The Genesis Server URL (WebSocket or HTTP).
  * @remarks Optional.

package/dist/dts/env/variables.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../../src/env/variables.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,QAAA,IAAI,WAAW,EAAE,MAAc,CAAC;AAQhC,OAAO,EAAE,WAAW,IAAI,UAAU,EAAE,CAAC;AAGrC;;;;GAIG;AACH,QAAA,IAAI,WAAW,EAAE,MAAM,CAAC;AAMxB,OAAO,EAAE,WAAW,IAAI,UAAU,EAAE,CAAC;AAOrC;;;;;;GAMG;AACH,QAAA,IAAI,SAAS,EAAE,MAAwD,CAAC;AAQxE,OAAO,EAAE,SAAS,IAAI,QAAQ,EAAE,CAAC;AAGjC;;;;GAIG;AACH,QAAA,IAAI,YAAY,EAAE,MAAM,CAAC;AAMzB,OAAO,EAAE,YAAY,IAAI,WAAW,EAAE,CAAC;AAKvC;;;;GAIG;AACH,QAAA,IAAI,qBAAqB,EAAE,MAAM,CAAC;AAMlC,OAAO,EAAE,qBAAqB,IAAI,oBAAoB,EAAE,CAAC;AAGzD;;;;GAIG;AACH,QAAA,IAAI,iBAAiB,EAAE,MAAM,CAAC;AAM9B,OAAO,EAAE,iBAAiB,IAAI,gBAAgB,EAAE,CAAC;AAGjD;;;;GAIG;AACH,QAAA,IAAI,aAAa,EAAE,MAAM,CAAC;AAM1B,OAAO,EAAE,aAAa,IAAI,YAAY,EAAE,CAAC"}
+{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../../src/env/variables.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,QAAA,IAAI,WAAW,EAAE,MAAc,CAAC;AAQhC,OAAO,EAAE,WAAW,IAAI,UAAU,EAAE,CAAC;AAGrC;;;;GAIG;AACH,QAAA,IAAI,WAAW,EAAE,MAAM,CAAC;AAMxB,OAAO,EAAE,WAAW,IAAI,UAAU,EAAE,CAAC;AAErC;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,QAAiF,CAAC;AAOjH;;;;;;GAMG;AACH,QAAA,IAAI,SAAS,EAAE,MAAwD,CAAC;AAQxE,OAAO,EAAE,SAAS,IAAI,QAAQ,EAAE,CAAC;AAGjC;;;;GAIG;AACH,QAAA,IAAI,YAAY,EAAE,MAAM,CAAC;AAMzB,OAAO,EAAE,YAAY,IAAI,WAAW,EAAE,CAAC;AAKvC;;;;GAIG;AACH,QAAA,IAAI,qBAAqB,EAAE,MAAM,CAAC;AAMlC,OAAO,EAAE,qBAAqB,IAAI,oBAAoB,EAAE,CAAC;AAGzD;;;;GAIG;AACH,QAAA,IAAI,iBAAiB,EAAE,MAAM,CAAC;AAM9B,OAAO,EAAE,iBAAiB,IAAI,gBAAgB,EAAE,CAAC;AAGjD;;;;GAIG;AACH,QAAA,IAAI,aAAa,EAAE,MAAM,CAAC;AAM1B,OAAO,EAAE,aAAa,IAAI,YAAY,EAAE,CAAC"}

package/dist/esm/env/variables.js

@@ -27,6 +27,17 @@ try {
 }
 catch (_b) { }
 export { _FORCE_HTTP as FORCE_HTTP };
+/**
+ * Genesis Socket URL
+ * @remarks
+ * Built from the current {@link https://developer.mozilla.org/en-US/docs/Web/API/Location} object and {@link SOCKET_EXT | socket extension}.
+ * @example
+ * ```ts
+ * await this.connect.connect(GENESIS_SOCKET_URL); // < wss://localhost:6060/gwf/
+ * ```
+ * @public
+ */
+export const GENESIS_SOCKET_URL = `${location.protocol.replace('http', 'ws')}//${location.host}/${_SOCKET_EXT}/`;
 const PROTOCOL = _FORCE_HTTP === 'true' ? location.protocol : location.protocol.replace('http', 'ws');
 /**
  * The Genesis Server URL (WebSocket or HTTP).

package/dist/foundation-utils.api.json

@@ -3353,6 +3353,29 @@
           ],
           "name": "formatTimestamp"
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-utils!GENESIS_SOCKET_URL:var",
+          "docComment": "/**\n * Genesis Socket URL\n *\n * @remarks\n *\n * Built from the current {@link https://developer.mozilla.org/en-US/docs/Web/API/Location} object and {@link SOCKET_EXT | socket extension}.\n *\n * @example\n * ```ts\n * await this.connect.connect(GENESIS_SOCKET_URL); // < wss://localhost:6060/gwf/\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "GENESIS_SOCKET_URL: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            }
+          ],
+          "fileUrlPath": "src/env/variables.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "GENESIS_SOCKET_URL",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-utils!getFontMixin:var",

package/dist/foundation-utils.d.ts

@@ -439,6 +439,18 @@ export declare type FoundationLayoutContainer = {
     _key: 'foundation-layout';
 };
 
+/**
+ * Genesis Socket URL
+ * @remarks
+ * Built from the current {@link https://developer.mozilla.org/en-US/docs/Web/API/Location} object and {@link SOCKET_EXT | socket extension}.
+ * @example
+ * ```ts
+ * await this.connect.connect(GENESIS_SOCKET_URL); // < wss://localhost:6060/gwf/
+ * ```
+ * @public
+ */
+export declare const GENESIS_SOCKET_URL: string;
+
 /**
  * Generates a CSS mixin for the specified font family, style, and weight.
  * @param family - The font family.

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [GENESIS\_SOCKET\_URL](./foundation-utils.genesis_socket_url.md)
+
+## GENESIS\_SOCKET\_URL variable
+
+Genesis Socket URL
+
+**Signature:**
+
+```typescript
+GENESIS_SOCKET_URL: string
+```
+
+## Remarks
+
+Built from the current [https://developer.mozilla.org/en-US/docs/Web/API/Location](https://developer.mozilla.org/en-US/docs/Web/API/Location) object and [socket extension](./foundation-utils.socket_ext.md)<!-- -->.
+
+## Example
+
+
+```ts
+await this.connect.connect(GENESIS_SOCKET_URL); // < wss://localhost:6060/gwf/
+```
+

package/docs/api/foundation-utils.md

@@ -82,6 +82,7 @@
 |  [defaultJSONSerializerConfig](./foundation-utils.defaultjsonserializerconfig.md) | A Default JSONSerializer Config for serializing and deserializing functions. |
 |  [defaultLoggerOptions](./foundation-utils.defaultloggeroptions.md) | The default logger options. |
 |  [FORCE\_HTTP](./foundation-utils.force_http.md) | The path to a JSON config file for the HTTP mode. |
+|  [GENESIS\_SOCKET\_URL](./foundation-utils.genesis_socket_url.md) | Genesis Socket URL |
 |  [getFontMixin](./foundation-utils.getfontmixin.md) | Generates a CSS mixin for the specified font family, style, and weight. |
 |  [HTTP\_CONFIG](./foundation-utils.http_config.md) | Configuration settings for HTTP, used in http connect flow \[<code>genesislcap-foundation-comms.HttpConnectConfig</code>\](https://link-to-docs). |
 |  [inIFrame](./foundation-utils.iniframe.md) | Returns a boolean value indicating whether the current window is inside an iframe. |

package/docs/api-report.md

@@ -253,6 +253,9 @@ export type FoundationLayoutContainer = {
     _key: 'foundation-layout';
 };
 
+// @public
+export const GENESIS_SOCKET_URL: string;
+
 // @public
 export const getFontMixin: (family: string, style?: FontStyle, weight?: FontWeight) => string;
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.187.1",
+  "version": "14.188.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -27,17 +27,17 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.187.1",
-    "@genesislcap/genx": "14.187.1",
-    "@genesislcap/rollup-builder": "14.187.1",
-    "@genesislcap/ts-builder": "14.187.1",
-    "@genesislcap/uvu-playwright-builder": "14.187.1",
-    "@genesislcap/vite-builder": "14.187.1",
-    "@genesislcap/webpack-builder": "14.187.1",
+    "@genesislcap/foundation-testing": "14.188.0",
+    "@genesislcap/genx": "14.188.0",
+    "@genesislcap/rollup-builder": "14.188.0",
+    "@genesislcap/ts-builder": "14.188.0",
+    "@genesislcap/uvu-playwright-builder": "14.188.0",
+    "@genesislcap/vite-builder": "14.188.0",
+    "@genesislcap/webpack-builder": "14.188.0",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.187.1",
+    "@genesislcap/foundation-logger": "14.188.0",
     "@microsoft/fast-components": "^2.30.6",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
@@ -54,5 +54,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "ed7f2594a168c5d92f448fc0c65566a9f1074acb"
+  "gitHead": "c262f43925f3066a3d5515753ef3dd14b6945199"
 }