@genesislcap/foundation-utils 14.67.5 → 14.68.0

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

@@ -1,11 +1,14 @@
 /**
- * The Genesis Server (host0 to establish a connection (WebSocket or HTTP)).
- * Example: wss://localhost:9064
- * @remarks Required.
+ * The sub-path used for WebSocket connections when API_HOST is not set
  * @public
+ * @defaultValue `'gwf'`
+ * @remarks Optional.
+ * @example
+ * If `API_HOST` is not set, `SOCKET_EXT` is set to `/custom` and UI is served on `https://localhost:1234`
+ * API host URL will be `wss://localhost:1234/custom`
  */
-declare let _API_HOST: string;
-export { _API_HOST as API_HOST };
+declare let _SOCKET_EXT: string;
+export { _SOCKET_EXT as SOCKET_EXT };
 /**
  * The path to a JSON config file for the HTTP mode.
  * @remarks Optional.
@@ -13,6 +16,8 @@ export { _API_HOST as API_HOST };
  */
 declare let _FORCE_HTTP: string;
 export { _FORCE_HTTP as FORCE_HTTP };
+declare let _API_HOST: string;
+export { _API_HOST as API_HOST };
 /**
  * Configuration settings for HTTP, used in http connect flow [`genesislcap-foundation-comms.HttpConnectConfig`](https://link-to-docs).
  * @remarks Optional.
@@ -41,12 +46,4 @@ export { _DEFAULT_PASSWORD as DEFAULT_PASSWORD };
  */
 declare let _DEFAULT_USER: string;
 export { _DEFAULT_USER as DEFAULT_USER };
-/**
- * The sub-path used for WebSocket connections.
- * Example: API_HOST + '/' + SOCKET_EXT - wss://localhost:9064/gwf.
- * @remarks Optional. Default is "API_HOST/gwf"
- * @public
- */
-declare let _SOCKET_EXT: string;
-export { _SOCKET_EXT as SOCKET_EXT };
 //# sourceMappingURL=variables.d.ts.map

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;;;;;GAKG;AACH,QAAA,IAAI,SAAS,EAAE,MAAM,CAAC;AAMtB,OAAO,EAAE,SAAS,IAAI,QAAQ,EAAE,CAAC;AAGjC;;;;GAIG;AACH,QAAA,IAAI,WAAW,EAAE,MAAM,CAAC;AAMxB,OAAO,EAAE,WAAW,IAAI,UAAU,EAAE,CAAC;AAGrC;;;;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;AAGzC;;;;;GAKG;AACH,QAAA,IAAI,WAAW,EAAE,MAAM,CAAC;AAMxB,OAAO,EAAE,WAAW,IAAI,UAAU,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;AAMhC,OAAO,EAAE,WAAW,IAAI,UAAU,EAAE,CAAC;AAGrC;;;;GAIG;AACH,QAAA,IAAI,WAAW,EAAE,MAAM,CAAC;AAMxB,OAAO,EAAE,WAAW,IAAI,UAAU,EAAE,CAAC;AAYrC,QAAA,IAAI,SAAS,EAAE,MAAwD,CAAC;AAMxE,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

@@ -1,16 +1,19 @@
 /* eslint-disable import/no-mutable-exports */
 /**
- * The Genesis Server (host0 to establish a connection (WebSocket or HTTP)).
- * Example: wss://localhost:9064
- * @remarks Required.
+ * The sub-path used for WebSocket connections when API_HOST is not set
  * @public
+ * @defaultValue `'gwf'`
+ * @remarks Optional.
+ * @example
+ * If `API_HOST` is not set, `SOCKET_EXT` is set to `/custom` and UI is served on `https://localhost:1234`
+ * API host URL will be `wss://localhost:1234/custom`
  */
-let _API_HOST;
+let _SOCKET_EXT = 'gwf';
 try {
-    _API_HOST = API_HOST;
+    _SOCKET_EXT = SOCKET_EXT;
 }
 catch (_a) { }
-export { _API_HOST as API_HOST };
+export { _SOCKET_EXT as SOCKET_EXT };
 /**
  * The path to a JSON config file for the HTTP mode.
  * @remarks Optional.
@@ -22,6 +25,20 @@ try {
 }
 catch (_b) { }
 export { _FORCE_HTTP as FORCE_HTTP };
+/**
+ * The Genesis Server URL (WebSocket or HTTP).
+ * @remarks Optional.
+ * @defaultValue `${PROTOCOL}//${location.host}/${_SOCKET_EXT}/`
+ * @example ws://localhost/gwf/, ws://localhost:9064
+ * @public
+ */
+const PROTOCOL = _FORCE_HTTP === 'true' ? location.protocol : location.protocol.replace('http', 'ws');
+let _API_HOST = `${PROTOCOL}//${location.host}/${_SOCKET_EXT}/`;
+try {
+    _API_HOST = API_HOST;
+}
+catch (_c) { }
+export { _API_HOST as API_HOST };
 /**
  * Configuration settings for HTTP, used in http connect flow [`genesislcap-foundation-comms.HttpConnectConfig`](https://link-to-docs).
  * @remarks Optional.
@@ -31,7 +48,7 @@ let _HTTP_CONFIG;
 try {
     _HTTP_CONFIG = HTTP_CONFIG;
 }
-catch (_c) { }
+catch (_d) { }
 export { _HTTP_CONFIG as HTTP_CONFIG };
 /**
  * The default Organisation value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
@@ -42,7 +59,7 @@ let _DEFAULT_ORGANISATION;
 try {
     _DEFAULT_ORGANISATION = DEFAULT_ORGANISATION;
 }
-catch (_d) { }
+catch (_e) { }
 export { _DEFAULT_ORGANISATION as DEFAULT_ORGANISATION };
 /**
  * The default Password value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
@@ -53,7 +70,7 @@ let _DEFAULT_PASSWORD;
 try {
     _DEFAULT_PASSWORD = DEFAULT_PASSWORD;
 }
-catch (_e) { }
+catch (_f) { }
 export { _DEFAULT_PASSWORD as DEFAULT_PASSWORD };
 /**
  * The default Username value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
@@ -64,17 +81,5 @@ let _DEFAULT_USER;
 try {
     _DEFAULT_USER = DEFAULT_USER;
 }
-catch (_f) { }
-export { _DEFAULT_USER as DEFAULT_USER };
-/**
- * The sub-path used for WebSocket connections.
- * Example: API_HOST + '/' + SOCKET_EXT - wss://localhost:9064/gwf.
- * @remarks Optional. Default is "API_HOST/gwf"
- * @public
- */
-let _SOCKET_EXT;
-try {
-    _SOCKET_EXT = SOCKET_EXT;
-}
 catch (_g) { }
-export { _SOCKET_EXT as SOCKET_EXT };
+export { _DEFAULT_USER as DEFAULT_USER };

package/dist/foundation-utils.api.json

@@ -207,7 +207,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-utils!API_HOST:var",
-          "docComment": "/**\n * The Genesis Server (host0 to establish a connection (WebSocket or HTTP)). Example: wss://localhost:9064\n *\n * @remarks\n *\n * Required.\n *\n * @public\n */\n",
+          "docComment": "",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -11443,7 +11443,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-utils!SOCKET_EXT:var",
-          "docComment": "/**\n * The sub-path used for WebSocket connections. Example: API_HOST + '/' + SOCKET_EXT - wss://localhost:9064/gwf.\n *\n * @remarks\n *\n * Optional. Default is \"API_HOST/gwf\"\n *\n * @public\n */\n",
+          "docComment": "/**\n * The sub-path used for WebSocket connections when API_HOST is not set\n *\n * @remarks\n *\n * Optional.\n *\n * @defaultValue\n *\n * `'gwf'`\n *\n * @example\n *\n * If `API_HOST` is not set, `SOCKET_EXT` is set to `/custom` and UI is served on `https://localhost:1234` API host URL will be `wss://localhost:1234/custom`\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/dist/foundation-utils.d.ts

@@ -18,12 +18,6 @@ import { SyntheticViewTemplate } from '@microsoft/fast-element';
  */
 export declare const activeColorScheme: CSSDesignToken<string>;
 
-/**
- * The Genesis Server (host0 to establish a connection (WebSocket or HTTP)).
- * Example: wss://localhost:9064
- * @remarks Required.
- * @public
- */
 export declare let API_HOST: string;
 
 /**
@@ -1513,10 +1507,13 @@ export declare class SlottedStyles extends FASTElement {
 }
 
 /**
- * The sub-path used for WebSocket connections.
- * Example: API_HOST + '/' + SOCKET_EXT - wss://localhost:9064/gwf.
- * @remarks Optional. Default is "API_HOST/gwf"
+ * The sub-path used for WebSocket connections when API_HOST is not set
  * @public
+ * @defaultValue `'gwf'`
+ * @remarks Optional.
+ * @example
+ * If `API_HOST` is not set, `SOCKET_EXT` is set to `/custom` and UI is served on `https://localhost:1234`
+ * API host URL will be `wss://localhost:1234/custom`
  */
 export declare let SOCKET_EXT: string;
 

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

@@ -4,15 +4,8 @@
 
 ## API\_HOST variable
 
-The Genesis Server (host0 to establish a connection (WebSocket or HTTP)). Example: wss://localhost:9064
-
 **Signature:**
 
 ```typescript
 _API_HOST: string
 ```
-
-## Remarks
-
-Required.
-

package/docs/api/foundation-utils.md

@@ -66,7 +66,7 @@
 |  Variable | Description |
 |  --- | --- |
 |  [activeColorScheme](./foundation-utils.activecolorscheme.md) | A design token that represents the active color scheme (light or dark). |
-|  [API\_HOST](./foundation-utils.api_host.md) | The Genesis Server (host0 to establish a connection (WebSocket or HTTP)). Example: wss://localhost:9064 |
+|  [API\_HOST](./foundation-utils.api_host.md) |  |
 |  [createErrorMap](./foundation-utils.createerrormap.md) | A factory to create the error map. |
 |  [createObserver](./foundation-utils.createobserver.md) | Creates a new event observer instance. |
 |  [DEFAULT\_ORGANISATION](./foundation-utils.default_organisation.md) | The default Organisation value, used in auth/login flow \[<code>genesislcap-foundation-login</code>\](https://link-to-docs). |
@@ -93,7 +93,7 @@
 |  [ResourceType](./foundation-utils.resourcetype.md) | An object that defines two resource types: "local" and "remote". |
 |  [respondToVisibility](./foundation-utils.respondtovisibility.md) | Setup an <code>IntersectionObserver</code> which will activate a callback function when an element becomes visible on screen |
 |  [ServerRowDTOMapper](./foundation-utils.serverrowdtomapper.md) | A DI token used to obtain a <code>ServerRowDTOMapper</code> instance. |
-|  [SOCKET\_EXT](./foundation-utils.socket_ext.md) | The sub-path used for WebSocket connections. Example: API\_HOST + '/' + SOCKET\_EXT - wss://localhost:9064/gwf. |
+|  [SOCKET\_EXT](./foundation-utils.socket_ext.md) | The sub-path used for WebSocket connections when API\_HOST is not set |
 |  [TypeRampValues](./foundation-utils.typerampvalues.md) | An object containing type ramp values. |
 |  [UUID](./foundation-utils.uuid.md) | A dependency injection token for the UUID interface. |
 

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

@@ -4,7 +4,7 @@
 
 ## SOCKET\_EXT variable
 
-The sub-path used for WebSocket connections. Example: API\_HOST + '/' + SOCKET\_EXT - wss://localhost:9064/gwf.
+The sub-path used for WebSocket connections when API\_HOST is not set
 
 **Signature:**
 
@@ -14,5 +14,9 @@ _SOCKET_EXT: string
 
 ## Remarks
 
-Optional. Default is "API\_HOST/gwf"
+Optional.
+
+## Example
+
+If `API_HOST` is not set, `SOCKET_EXT` is set to `/custom` and UI is served on `https://localhost:1234` API host URL will be `wss://localhost:1234/custom`
 

package/docs/api-report.md

@@ -21,7 +21,7 @@ import { SyntheticViewTemplate } from '@microsoft/fast-element';
 // @public
 export const activeColorScheme: CSSDesignToken<string>;
 
-// @public
+// @public (undocumented)
 export let API_HOST: string;
 
 // @public (undocumented)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.67.5",
+  "version": "14.68.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -39,5 +39,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "e6b35381e1991f74ecfb1e3ed59043a59985ffcf"
+  "gitHead": "7d9d99e30e5f1b77e1ece7d72f9657d6a801795d"
 }