@genesislcap/foundation-utils 14.68.2 → 14.68.3-alpha-47419ab.0

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

@@ -16,6 +16,13 @@ export { _SOCKET_EXT as SOCKET_EXT };
  */
 declare let _FORCE_HTTP: string;
 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
+ */
 declare let _API_HOST: string;
 export { _API_HOST as API_HOST };
 /**

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;AAYrC,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;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"}

package/dist/esm/env/variables.js

@@ -27,6 +27,7 @@ try {
 }
 catch (_b) { }
 export { _FORCE_HTTP as FORCE_HTTP };
+const PROTOCOL = _FORCE_HTTP === 'true' ? location.protocol : location.protocol.replace('http', 'ws');
 /**
  * The Genesis Server URL (WebSocket or HTTP).
  * @remarks Optional.
@@ -34,7 +35,6 @@ export { _FORCE_HTTP as FORCE_HTTP };
  * @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 {
     if (typeof API_HOST !== 'undefined') {

package/dist/foundation-utils.api.json

@@ -207,7 +207,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-utils!API_HOST:var",
-          "docComment": "",
+          "docComment": "/**\n * The Genesis Server URL (WebSocket or HTTP).\n *\n * @remarks\n *\n * Optional.\n *\n * @defaultValue\n *\n * `${PROTOCOL}//${location.host}/${_SOCKET_EXT}/`\n *\n * @example\n *\n * ws://localhost/gwf/, ws://localhost:9064\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/dist/foundation-utils.d.ts

@@ -18,6 +18,13 @@ import { SyntheticViewTemplate } from '@microsoft/fast-element';
  */
 export declare const activeColorScheme: CSSDesignToken<string>;
 
+/**
+ * The Genesis Server URL (WebSocket or HTTP).
+ * @remarks Optional.
+ * @defaultValue `${PROTOCOL}//${location.host}/${_SOCKET_EXT}/`
+ * @example ws://localhost/gwf/, ws://localhost:9064
+ * @public
+ */
 export declare let API_HOST: string;
 
 /**

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

@@ -4,8 +4,19 @@
 
 ## API\_HOST variable
 
+The Genesis Server URL (WebSocket or HTTP).
+
 **Signature:**
 
 ```typescript
 _API_HOST: string
 ```
+
+## Remarks
+
+Optional.
+
+## Example
+
+ws://localhost/gwf/, ws://localhost:9064
+

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) |  |
+|  [API\_HOST](./foundation-utils.api_host.md) | The Genesis Server URL (WebSocket or HTTP). |
 |  [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). |

package/docs/api-report.md

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.68.2",
+  "version": "14.68.3-alpha-47419ab.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -10,7 +10,7 @@
     "PORT": 3040
   },
   "scripts": {
-    "api:extract": "api-extractor run --local",
+    "api:extract": "api-extractor run",
     "api:document": "api-documenter markdown -i dist -o docs/api",
     "build": "npm run clean && tsc -b ./tsconfig.json && npm run api:extract && npm run api:document",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
@@ -39,5 +39,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "5366046018e36151b75f74ec6a088aed80b12686"
+  "gitHead": "eb4e1c824271f307514848d091e0918a6e5058df"
 }