npm - @genesislcap/foundation-comms - Versions diffs - 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.0 - Mend

@genesislcap/foundation-comms 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (384) hide show

package/docs/api/foundation-comms.socketstatus.md CHANGED Viewed

@@ -15,76 +15,14 @@ export interface SocketStatus extends SerializedSocketStatus
 ## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[isConnectedSubject](./foundation-comms.socketstatus.isconnectedsubject.md)
-</td><td>
-</td><td>
-BehaviorSubject&lt;boolean&gt;
-</td><td>
-</td></tr>
-</tbody></table>
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isConnectedSubject](./foundation-comms.socketstatus.isconnectedsubject.md) |  | BehaviorSubject&lt;boolean&gt; |  |
 ## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[onClose(closeEvent)](./foundation-comms.socketstatus.onclose.md)
-</td><td>
-</td></tr>
-<tr><td>
-[serialize()](./foundation-comms.socketstatus.serialize.md)
-</td><td>
-</td></tr>
-</tbody></table>
+|  Method | Description |
+|  --- | --- |
+|  [onClose(closeEvent)](./foundation-comms.socketstatus.onclose.md) |  |
+|  [serialize()](./foundation-comms.socketstatus.serialize.md) |  |

package/docs/api/foundation-comms.socketstatus.onclose.md CHANGED Viewed

@@ -12,37 +12,9 @@ onClose(closeEvent: CloseEvent): void;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-closeEvent
-</td><td>
-CloseEvent
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  closeEvent | CloseEvent |  |
 **Returns:**

package/docs/api/foundation-comms.socketsubject.md CHANGED Viewed

@@ -19,35 +19,7 @@ An alias to RxJS Subject.
 ## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)()](./foundation-comms.socketsubject._constructor_.md)
-</td><td>
-</td><td>
-Constructs a new instance of the `SocketSubject` class
-</td></tr>
-</tbody></table>
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)()](./foundation-comms.socketsubject._constructor_.md) |  | Constructs a new instance of the <code>SocketSubject</code> class |

package/docs/api/foundation-comms.tofieldmetadata.md CHANGED Viewed

@@ -2,7 +2,7 @@
 [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [toFieldMetadata](./foundation-comms.tofieldmetadata.md)
-## toFieldMetadata() function
+## toFieldMetadata variable
 Converts the field definitions to field metadata.
@@ -11,46 +11,3 @@ Converts the field definitions to field metadata.
 ```typescript
 toFieldMetadata: (fieldDef: MetadataDetail[]) => FieldMetadata[]
 ```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-fieldDef
-</td><td>
-[MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\]
-</td><td>
-The field definitions.
-</td></tr>
-</tbody></table>
-**Returns:**
-[FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\]
-An array of field metadata.

package/docs/api/foundation-comms.until.md CHANGED Viewed

@@ -14,55 +14,10 @@ export declare function until(conditionFunc: () => boolean, timeoutMs?: number):
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-conditionFunc
-</td><td>
-() =&gt; boolean
-</td><td>
-The condition function to poll.
-</td></tr>
-<tr><td>
-timeoutMs
-</td><td>
-number
-</td><td>
-_(Optional)_ The timeout in milliseconds. Defaults to 300.
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  conditionFunc | () =&gt; boolean | The condition function to poll. |
+|  timeoutMs | number | _(Optional)_ The timeout in milliseconds. Defaults to 300. |
 **Returns:**

package/docs/api/index.md CHANGED Viewed

@@ -6,25 +6,7 @@
 ## Packages
-<table><thead><tr><th>
-Package
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[@genesislcap/foundation-comms](./foundation-comms.md)
-</td><td>
-</td></tr>
-</tbody></table>
+|  Package | Description |
+|  --- | --- |
+|  [@genesislcap/foundation-comms](./foundation-comms.md) |  |

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-comms",
   "description": "Genesis Foundation UI Comms",
-  "version": "14.302.1-alpha-475e82d.0",
+  "version": "14.302.1-alpha-ecc0cfb.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -75,23 +75,24 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.302.1-alpha-475e82d.0",
-    "@genesislcap/genx": "14.302.1-alpha-475e82d.0",
-    "@genesislcap/rollup-builder": "14.302.1-alpha-475e82d.0",
-    "@genesislcap/ts-builder": "14.302.1-alpha-475e82d.0",
-    "@genesislcap/uvu-playwright-builder": "14.302.1-alpha-475e82d.0",
-    "@genesislcap/vite-builder": "14.302.1-alpha-475e82d.0",
-    "@genesislcap/webpack-builder": "14.302.1-alpha-475e82d.0",
+    "@genesislcap/foundation-testing": "14.302.1-alpha-ecc0cfb.0",
+    "@genesislcap/genx": "14.302.1-alpha-ecc0cfb.0",
+    "@genesislcap/rollup-builder": "14.302.1-alpha-ecc0cfb.0",
+    "@genesislcap/ts-builder": "14.302.1-alpha-ecc0cfb.0",
+    "@genesislcap/uvu-playwright-builder": "14.302.1-alpha-ecc0cfb.0",
+    "@genesislcap/vite-builder": "14.302.1-alpha-ecc0cfb.0",
+    "@genesislcap/webpack-builder": "14.302.1-alpha-ecc0cfb.0",
     "@types/js-cookie": "^3.0.2",
     "@types/json-schema": "^7.0.11",
     "@types/webappsec-credential-management": "^0.6.2",
+    "rimraf": "^5.0.0",
     "sinon": "^17.0.1"
   },
   "dependencies": {
-    "@genesislcap/foundation-broadcast-channel": "14.302.1-alpha-475e82d.0",
-    "@genesislcap/foundation-logger": "14.302.1-alpha-475e82d.0",
-    "@genesislcap/foundation-user": "14.302.1-alpha-475e82d.0",
-    "@genesislcap/foundation-utils": "14.302.1-alpha-475e82d.0",
+    "@genesislcap/foundation-broadcast-channel": "14.302.1-alpha-ecc0cfb.0",
+    "@genesislcap/foundation-logger": "14.302.1-alpha-ecc0cfb.0",
+    "@genesislcap/foundation-user": "14.302.1-alpha-ecc0cfb.0",
+    "@genesislcap/foundation-utils": "14.302.1-alpha-ecc0cfb.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
     "analytics": "^0.8.0",
@@ -100,7 +101,8 @@
     "http-status-codes": "^2.2.0",
     "js-cookie": "^3.0.1",
     "json-schema": "^0.4.0",
-    "rxjs": "^7.5.4"
+    "rxjs": "^7.5.4",
+    "tslib": "^2.3.1"
   },
   "repository": {
     "type": "git",
@@ -110,5 +112,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7ef53892e1de34f3e9c742e3ebd88d4880a27ca1"
+  "gitHead": "dad34f09069fa189f6d6855903eed9a431fdbab1"
 }

package/docs/api/foundation-comms.connect.streamwithoutautoteardown.md DELETED Viewed

@@ -1,112 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Connect](./foundation-comms.connect.md) &gt; [streamWithoutAutoTeardown](./foundation-comms.connect.streamwithoutautoteardown.md)
-## Connect.streamWithoutAutoTeardown() method
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-> Warning: This API is now obsolete.
->
-> - Use `stream` instead. Will be removed in v15.
->
-Starts listening for updates on the specified resource without auto-teardown.
-**Signature:**
-```typescript
-streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-resourceName
-</td><td>
-string
-</td><td>
-The name of the resource to listen for updates on.
-</td></tr>
-<tr><td>
-onMessage
-</td><td>
-Function
-</td><td>
-A callback function to handle received messages.
-</td></tr>
-<tr><td>
-onError
-</td><td>
-Function
-</td><td>
-A callback function to handle errors.
-</td></tr>
-<tr><td>
-params
-</td><td>
-[DataserverParams](./foundation-comms.dataserverparams.md)
-</td><td>
-_(Optional)_ Additional parameters to pass to the server.
-</td></tr>
-</tbody></table>
-**Returns:**
-[SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
-An observable that emits messages received from the server.

package/docs/api/foundation-comms.defaultentitydatasource._initialized.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [\_initialized](./foundation-comms.defaultentitydatasource._initialized.md)
-## DefaultEntityDatasource.\_initialized property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-protected _initialized: boolean;
-```

package/docs/api/foundation-comms.defaultentitydatasource.cache.md DELETED Viewed

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [cache](./foundation-comms.defaultentitydatasource.cache.md)
-## DefaultEntityDatasource.cache property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-get cache(): TEntity[];
-```
-## Remarks
-In-memory entity cache.

package/docs/api/foundation-comms.defaultentitydatasource.disconnect.md DELETED Viewed

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [disconnect](./foundation-comms.defaultentitydatasource.disconnect.md)
-## DefaultEntityDatasource.disconnect property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-disconnect: () => void;
-```
-## Remarks
-Disconnect and reset cache.

package/docs/api/foundation-comms.defaultentitydatasource.entitycache.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [entityCache](./foundation-comms.defaultentitydatasource.entitycache.md)
-## DefaultEntityDatasource.entityCache property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-protected entityCache: TEntity[];
-```

package/docs/api/foundation-comms.defaultentitydatasource.entitymap.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [entityMap](./foundation-comms.defaultentitydatasource.entitymap.md)
-## DefaultEntityDatasource.entityMap property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-protected entityMap: Map<string, TEntity>;
-```

package/docs/api/foundation-comms.defaultentitydatasource.initialize.md DELETED Viewed

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [initialize](./foundation-comms.defaultentitydatasource.initialize.md)
-## DefaultEntityDatasource.initialize property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-initialize: (init: EntityDatasourceInit<TDTO, TEntity>) => Promise<boolean>;
-```
-## Remarks
-Initialize datasource.

package/docs/api/foundation-comms.defaultentitydatasource.initialized.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [initialized](./foundation-comms.defaultentitydatasource.initialized.md)
-## DefaultEntityDatasource.initialized property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-get initialized(): boolean;
-set initialized(value: boolean);
-```

package/docs/api/foundation-comms.defaultentitydatasource.isempty.md DELETED Viewed

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [isEmpty](./foundation-comms.defaultentitydatasource.isempty.md)
-## DefaultEntityDatasource.isEmpty property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-get isEmpty(): boolean;
-```
-## Remarks
-Cache is empty / awaiting first result.

package/docs/api/foundation-comms.defaultentitydatasource.mapper.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [mapper](./foundation-comms.defaultentitydatasource.mapper.md)
-## DefaultEntityDatasource.mapper property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-protected mapper: DTOMapper<TDTO, TEntity>;
-```