@genesislcap/foundation-comms 14.185.0 → 14.186.0

package/docs/api/foundation-comms.pingmessage.md

@@ -8,7 +8,7 @@
 **Signature:**
 
 ```typescript
-export type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS'> & {
+export type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {
     VERBOSE?: boolean;
     [key: string]: any;
 };

package/docs/api/foundation-comms.streamerrorevent.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamErrorEvent](./foundation-comms.streamerrorevent.md)
+
+## StreamErrorEvent type
+
+
+**Signature:**
+
+```typescript
+export type StreamErrorEvent = CustomEvent<StreamErrorEventDetail>;
+```
+**References:** [StreamErrorEventDetail](./foundation-comms.streamerroreventdetail.md)
+

package/docs/api/foundation-comms.streamerroreventdetail.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamErrorEventDetail](./foundation-comms.streamerroreventdetail.md)
+
+## StreamErrorEventDetail type
+
+
+**Signature:**
+
+```typescript
+export type StreamErrorEventDetail = Pick<StreamEventDetail, 'resourceName' | 'stream'> & {
+    error: any;
+};
+```
+**References:** [StreamEventDetail](./foundation-comms.streameventdetail.md)
+

package/docs/api/foundation-comms.streamerroreventtype.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamErrorEventType](./foundation-comms.streamerroreventtype.md)
+
+## StreamErrorEventType variable
+
+
+**Signature:**
+
+```typescript
+StreamErrorEventType = "connect-stream-error-event"
+```

package/docs/api-report.md

@@ -167,7 +167,7 @@ export interface Connect {
     snapshot(resourceName: string, params?: any): Promise<Message>;
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
     streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
-    // @alpha
+    // @alpha @deprecated
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
 }
 
@@ -192,7 +192,7 @@ export const ConnectConfig: InterfaceSymbol<ConnectConfig>;
 export interface ConnectEvents {
     addCommitListener(listener: Listener<CommitEvent>): () => void;
     addMetadataListener(listener: Listener<MetadataEvent>): () => void;
-    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
 }
 
 // @internal
@@ -205,6 +205,7 @@ export interface ConnectEventsEmitter extends ConnectEvents {
     onCommitEvent(eventName: string, message: Message): void;
     onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
     onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
+    onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
     onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
 }
 
@@ -587,7 +588,7 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
-    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
     // @internal (undocumented)
     protected commitListeners: Observer<CommitEvent>;
     // @internal (undocumented)
@@ -607,10 +608,16 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
+    onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
     onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
     // @internal (undocumented)
     protected streamCompleteListeners: Observer<StreamCompleteEvent>;
     // @internal (undocumented)
+    protected streamErrorListeners: Observer<StreamErrorEvent>;
+    // @internal (undocumented)
     protected streamListeners: Observer<StreamEvent>;
 }
 
@@ -1703,7 +1710,7 @@ export const NetworkMonitorConfig: InterfaceSymbol<NetworkMonitorConfig>;
 export function normaliseCriteria(criteria: string, delimiter?: string): string;
 
 // @public (undocumented)
-export type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS'> & {
+export type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {
     VERBOSE?: boolean;
     [key: string]: any;
 };
@@ -2050,6 +2057,17 @@ export type StreamCompleteEventDetail = Pick<StreamEventDetail, 'resourceName' |
 // @public (undocumented)
 export const StreamCompleteEventType = "connect-stream-complete-event";
 
+// @public (undocumented)
+export type StreamErrorEvent = CustomEvent<StreamErrorEventDetail>;
+
+// @public (undocumented)
+export type StreamErrorEventDetail = Pick<StreamEventDetail, 'resourceName' | 'stream'> & {
+    error: any;
+};
+
+// @public (undocumented)
+export const StreamErrorEventType = "connect-stream-error-event";
+
 // @public (undocumented)
 export type StreamEvent = CustomEvent<StreamEventDetail>;
 
@@ -2150,7 +2168,7 @@ export const WSConnect: InterfaceSymbol<Connect>;
 
 // Warnings were encountered during analysis:
 //
-// src/connect/message.ts:283:3 - (ae-forgotten-export) The symbol "RESOURCE_DETAILS" needs to be exported by the entry point index.d.ts
+// src/connect/message.ts:286:3 - (ae-forgotten-export) The symbol "RESOURCE_DETAILS" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-comms",
   "description": "Genesis Foundation UI Comms",
-  "version": "14.185.0",
+  "version": "14.186.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -74,22 +74,22 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.185.0",
-    "@genesislcap/genx": "14.185.0",
-    "@genesislcap/rollup-builder": "14.185.0",
-    "@genesislcap/ts-builder": "14.185.0",
-    "@genesislcap/uvu-playwright-builder": "14.185.0",
-    "@genesislcap/vite-builder": "14.185.0",
-    "@genesislcap/webpack-builder": "14.185.0",
+    "@genesislcap/foundation-testing": "14.186.0",
+    "@genesislcap/genx": "14.186.0",
+    "@genesislcap/rollup-builder": "14.186.0",
+    "@genesislcap/ts-builder": "14.186.0",
+    "@genesislcap/uvu-playwright-builder": "14.186.0",
+    "@genesislcap/vite-builder": "14.186.0",
+    "@genesislcap/webpack-builder": "14.186.0",
     "@types/js-cookie": "^3.0.2",
     "@types/json-schema": "^7.0.11",
     "@types/webappsec-credential-management": "^0.6.2",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.185.0",
-    "@genesislcap/foundation-user": "14.185.0",
-    "@genesislcap/foundation-utils": "14.185.0",
+    "@genesislcap/foundation-logger": "14.186.0",
+    "@genesislcap/foundation-user": "14.186.0",
+    "@genesislcap/foundation-utils": "14.186.0",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
     "analytics": "^0.8.0",
@@ -109,5 +109,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "839487e6a0b1168d0ad6bf32c9e3a50504c775a0"
+  "gitHead": "1ebc5549ab49ef3a3e6c08c8aab0886dbebb3400"
 }