@genesislcap/foundation-comms 14.184.0 → 14.186.0

package/dist/foundation-comms.d.ts

@@ -257,8 +257,20 @@ export declare interface Connect {
      * @returns An observable that emits messages received from the server.
      */
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
+    /**
+     * Starts listening for updates on the specified resource.
+     * @public
+     * @param resourceName - The name of the resource to listen for updates on.
+     * @param onMessage - A callback function to handle received messages.
+     * @param onError - A callback function to handle errors.
+     * @param params - Additional parameters to pass to the server.
+     * @param initialState - State of the list to start with, defaults to empty array.
+     * @returns An observable that emits latest state of the list it subscribes to.
+     */
+    streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
     /**
      * Starts listening for updates on the specified resource without auto-teardown.
+     * @deprecated - Use `stream` instead. Will be removed in v15.
      * @alpha
      * @param resourceName - The name of the resource to listen for updates on.
      * @param onMessage - A callback function to handle received messages.
@@ -346,6 +358,10 @@ export declare interface ConnectConfig {
      * Options for automatic reconnection on connection loss.
      */
     reconnect: SocketReconnectOptions;
+    /**
+     * Check for web socket url pattern.
+     */
+    isWebSocketExpression: RegExp;
 }
 
 /**
@@ -364,8 +380,9 @@ export declare interface ConnectEvents {
      * Add a stream listener.
      * @param listener - A listener callback function.
      * @param complete - A complete listener callback function.
+     * @param error - A error listener callback function.
      */
-    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
     /**
      * Add a commit listener.
      * @param listener - A listener callback function.
@@ -402,6 +419,13 @@ export declare interface ConnectEventsEmitter extends ConnectEvents {
      * @param functions - Any functions provided.
      */
     onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
+    /**
+     * Called by Connect.
+     * @param resourceName - The name of the resource.
+     * @param stream - The actual stream itself.
+     * @param error - The error that occurred.
+     */
+    onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
     /**
      * Called by Connect.
      * @param resourceName - The name of the resource.
@@ -456,6 +480,7 @@ export declare class ConnectMock implements Connect {
     nextJSONSchema: any;
     nextMessage: Message;
     requestParams: RequestParams;
+    nextListState: any[];
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
     connect(host: string): Promise<boolean>;
     disconnect(): void;
@@ -464,6 +489,7 @@ export declare class ConnectMock implements Connect {
     getAvailableResources(params?: RequestParams): Promise<Message>;
     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[]>;
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
     getMoreRows(sourceRef: string): Promise<Message<any>>;
     getMoreColumns(sourceRef: string): Promise<Message<any>>;
@@ -1140,7 +1166,7 @@ export declare class DefaultConnect implements Connect {
     get isConnected(): boolean;
     get isConnectedSubject(): BehaviorSubject<boolean>;
     get isConnected$(): Observable<boolean>;
-    constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config?: ConnectConfig);
+    constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
     httpMode(): boolean;
     /**
      * @deprecated - Please reference {@link @genesislcap/foundation-user#User} instead.',
@@ -1151,6 +1177,7 @@ export declare class DefaultConnect implements Connect {
     disconnect(): void;
     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[]>;
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
     getMoreRows(sourceRef: string): Promise<Message>;
     getMoreColumns(sourceRef: string): Promise<Message>;
@@ -1177,10 +1204,14 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter {
     protected streamListeners: Observer<StreamEvent>;
     /** @internal */
     protected streamCompleteListeners: Observer<StreamCompleteEvent>;
+    /** @internal */
+    protected streamErrorListeners: Observer<StreamErrorEvent>;
     /** {@inheritDoc ConnectEvents.addStreamListener} */
-    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
     /** {@inheritDoc ConnectEventsEmitter.onStreamEvent} */
     onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
+    /** {@inheritDoc ConnectEventsEmitter.onStreamErrorEvent} */
+    onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
     /** {@inheritDoc ConnectEventsEmitter.onStreamCompleteEvent} */
     onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
     /** @internal */
@@ -1367,7 +1398,7 @@ export declare class DefaultHttpConnect implements Connect {
      * @internal
      */
     private streams;
-    constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCache: MetaCache, serializer: JSONSerializer, config?: HttpConnectConfig);
+    constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCache: MetaCache, serializer: JSONSerializer, config: HttpConnectConfig);
     /**
      * Checks if the host is available by sending a heartbeat ping message and waiting for the response.
      * @internal
@@ -1381,6 +1412,7 @@ export declare class DefaultHttpConnect implements Connect {
     disconnect(): void;
     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[]>;
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message<any>>;
     private getMessage;
     getMoreRows(sourceRef: string): Promise<Message>;
@@ -1398,12 +1430,6 @@ export declare class DefaultHttpConnect implements Connect {
     private static getUrl;
 }
 
-/**
- * The default configuration for connecting to an HTTP service.
- * @public
- */
-export declare const defaultHttpConnectConfig: HttpConnectConfig;
-
 /**
  * The default implementation for the KVStorage interface.
  * @alpha
@@ -2217,7 +2243,7 @@ export declare const HttpConnect: InterfaceSymbol<Connect>;
  * Configuration options for the Connect (HTTP) instance.
  * @public
  */
-export declare interface HttpConnectConfig {
+declare interface HttpConnectConfig {
     /**
      * Configuration options for http polling.
      */
@@ -2228,13 +2254,13 @@ export declare interface HttpConnectConfig {
  * Configuration options for the Connect (HTTP) instance.
  * @internal
  */
-export declare const HttpConnectConfig: InterfaceSymbol<HttpConnectConfig>;
+declare const HttpConnectConfig: InterfaceSymbol<HttpConnectConfig>;
 
 /**
  * Configuration options for http connection.
  * @public
  */
-export declare interface HttpPollingConfig {
+declare interface HttpPollingConfig {
     /**
      * The frequency of polling.
      */
@@ -2535,6 +2561,10 @@ export declare type Message<T = void | any> = {
 
 /**
  * A utility class for building different types of messages.
+ *
+ * @privateRemarks
+ * The SESSION_AUTH_TOKEN etc in messages should probably be removed with the move to cookies.
+ *
  * @public
  */
 export declare interface MessageBuilder {
@@ -2848,7 +2878,7 @@ export declare type MessageError = {
 /**
  * Check if the message contains an error code.
  * @param message - The message object.
- * @param code - The error code.
+ * @param code - The error code. Either a {@link http-status-codes#StatusCodes | StatusCodes} number or an entire status code string.
  * @public
  */
 export declare const messageHasErrorCode: (message: Message, code: string | number) => boolean;
@@ -3136,7 +3166,7 @@ export declare function normaliseCriteria(criteria: string, delimiter?: string):
 /**
  * @public
  */
-export declare type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS'> & {
+export declare type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {
     VERBOSE?: boolean;
     [key: string]: any;
 };
@@ -3145,7 +3175,7 @@ export declare type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' |
  * Configuration options for http polling.
  * @public
  */
-export declare interface PollingConfiguration {
+declare interface PollingConfiguration {
     /**
      * The temporary polling frequency.
      */
@@ -3766,6 +3796,23 @@ export declare type StreamCompleteEventDetail = Pick<StreamEventDetail, 'resourc
  */
 export declare const StreamCompleteEventType = "connect-stream-complete-event";
 
+/**
+ * @public
+ */
+export declare type StreamErrorEvent = CustomEvent<StreamErrorEventDetail>;
+
+/**
+ * @public
+ */
+export declare type StreamErrorEventDetail = Pick<StreamEventDetail, 'resourceName' | 'stream'> & {
+    error: any;
+};
+
+/**
+ * @public
+ */
+export declare const StreamErrorEventType = "connect-stream-error-event";
+
 /**
  * @public
  */

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

@@ -37,4 +37,5 @@ export interface Connect
 |  [request(resourceName, params)](./foundation-comms.connect.request.md) | Sends a request to the server to retrieve data or perform an action. |
 |  [snapshot(resourceName, params)](./foundation-comms.connect.snapshot.md) | Retrieves a snapshot of data for the specified resource. |
 |  [stream(resourceName, onMessage, onError, params)](./foundation-comms.connect.stream.md) | Starts listening for updates on the specified resource. |
+|  [streamState(resourceName, onMessage, onError, params, initialState)](./foundation-comms.connect.streamstate.md) | Starts listening for updates on the specified resource. |
 

package/docs/api/foundation-comms.connect.streamstate.md

@@ -0,0 +1,30 @@
+<!-- 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; [streamState](./foundation-comms.connect.streamstate.md)
+
+## Connect.streamState() method
+
+Starts listening for updates on the specified resource.
+
+**Signature:**
+
+```typescript
+streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource to listen for updates on. |
+|  onMessage | Function | A callback function to handle received messages. |
+|  onError | Function | A callback function to handle errors. |
+|  params | any | _(Optional)_ Additional parameters to pass to the server. |
+|  initialState | any\[\] | _(Optional)_ State of the list to start with, defaults to empty array. |
+
+**Returns:**
+
+Observable&lt;any\[\]&gt;
+
+An observable that emits latest state of the list it subscribes to.
+

package/docs/api/foundation-comms.connectconfig.iswebsocketexpression.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ConnectConfig](./foundation-comms.connectconfig.md) &gt; [isWebSocketExpression](./foundation-comms.connectconfig.iswebsocketexpression.md)
+
+## ConnectConfig.isWebSocketExpression property
+
+Check for web socket url pattern.
+
+**Signature:**
+
+```typescript
+isWebSocketExpression: RegExp;
+```

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

@@ -17,5 +17,6 @@ export interface ConnectConfig
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [connect](./foundation-comms.connectconfig.connect.md) |  | [SocketConnectOptions](./foundation-comms.socketconnectoptions.md) | Options for the initial connection. |
+|  [isWebSocketExpression](./foundation-comms.connectconfig.iswebsocketexpression.md) |  | RegExp | Check for web socket url pattern. |
 |  [reconnect](./foundation-comms.connectconfig.reconnect.md) |  | [SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) | Options for automatic reconnection on connection loss. |
 

package/docs/api/foundation-comms.connectevents.addstreamlistener.md

@@ -9,7 +9,7 @@ Add a stream listener.
 **Signature:**
 
 ```typescript
-addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
 ```
 
 ## Parameters
@@ -18,6 +18,7 @@ addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamComp
 |  --- | --- | --- |
 |  listener | Listener&lt;[StreamEvent](./foundation-comms.streamevent.md)<!-- -->&gt; | A listener callback function. |
 |  complete | Listener&lt;[StreamCompleteEvent](./foundation-comms.streamcompleteevent.md)<!-- -->&gt; | A complete listener callback function. |
+|  error | Listener&lt;[StreamErrorEvent](./foundation-comms.streamerrorevent.md)<!-- -->&gt; | A error listener callback function. |
 
 **Returns:**
 

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

@@ -18,5 +18,5 @@ export interface ConnectEvents
 |  --- | --- |
 |  [addCommitListener(listener)](./foundation-comms.connectevents.addcommitlistener.md) | Add a commit listener. |
 |  [addMetadataListener(listener)](./foundation-comms.connectevents.addmetadatalistener.md) | Add a metadata listener. |
-|  [addStreamListener(listener, complete)](./foundation-comms.connectevents.addstreamlistener.md) | Add a stream listener. |
+|  [addStreamListener(listener, complete, error)](./foundation-comms.connectevents.addstreamlistener.md) | Add a stream listener. |
 

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

@@ -20,5 +20,6 @@ export interface ConnectEventsEmitter extends ConnectEvents
 |  [onCommitEvent(eventName, message)](./foundation-comms.connecteventsemitter.oncommitevent.md) | Called by Connect. |
 |  [onMetadataEvent(resourceName, message, error)](./foundation-comms.connecteventsemitter.onmetadataevent.md) | Called by Connect. |
 |  [onStreamCompleteEvent(resourceName, stream)](./foundation-comms.connecteventsemitter.onstreamcompleteevent.md) | Called by Connect. |
+|  [onStreamErrorEvent(resourceName, stream, error)](./foundation-comms.connecteventsemitter.onstreamerrorevent.md) | Called by Connect. |
 |  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.connecteventsemitter.onstreamevent.md) | Called by Connect. |
 

package/docs/api/foundation-comms.connecteventsemitter.onstreamerrorevent.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) &gt; [onStreamErrorEvent](./foundation-comms.connecteventsemitter.onstreamerrorevent.md)
+
+## ConnectEventsEmitter.onStreamErrorEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
+|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
+|  error | any | The error that occurred. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.defaultconnect._constructor_.md

@@ -9,7 +9,7 @@ Constructs a new instance of the `DefaultConnect` class
 **Signature:**
 
 ```typescript
-constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config?: ConnectConfig);
+constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
 ```
 
 ## Parameters
@@ -20,5 +20,5 @@ constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache
 |  messageBuilder | [MessageBuilder](./foundation-comms.messagebuilder.md) |  |
 |  metaCache | [MetaCache](./foundation-comms.metacache.md) |  |
 |  events | [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) |  |
-|  config | [ConnectConfig](./foundation-comms.connectconfig.md) | _(Optional)_ |
+|  config | [ConnectConfig](./foundation-comms.connectconfig.md) |  |
 

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

@@ -48,5 +48,6 @@ export declare class DefaultConnect implements Connect
 |  [setValidSession(valid)](./foundation-comms.defaultconnect.setvalidsession.md) |  |  |
 |  [snapshot(resourceName, params)](./foundation-comms.defaultconnect.snapshot.md) |  |  |
 |  [stream(resourceName, onMessage, onError, params)](./foundation-comms.defaultconnect.stream.md) |  |  |
+|  [streamState(resourceName, onMessage, onError, params, initialState)](./foundation-comms.defaultconnect.streamstate.md) |  |  |
 |  [streamWithoutAutoTeardown(resourceName, onMessage, onError, params)](./foundation-comms.defaultconnect.streamwithoutautoteardown.md) |  |  |
 

package/docs/api/foundation-comms.defaultconnect.streamstate.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnect](./foundation-comms.defaultconnect.md) &gt; [streamState](./foundation-comms.defaultconnect.streamstate.md)
+
+## DefaultConnect.streamState() method
+
+**Signature:**
+
+```typescript
+streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string |  |
+|  onMessage | Function | _(Optional)_ |
+|  onError | Function | _(Optional)_ |
+|  params | any | _(Optional)_ |
+|  initialState | any\[\] | _(Optional)_ |
+
+**Returns:**
+
+Observable&lt;any\[\]&gt;
+

package/docs/api/foundation-comms.defaultconnectevents.addstreamlistener.md

@@ -9,7 +9,7 @@ Add a stream listener.
 **Signature:**
 
 ```typescript
-addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
 ```
 
 ## Parameters
@@ -18,6 +18,7 @@ addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamComp
 |  --- | --- | --- |
 |  listener | Listener&lt;[StreamEvent](./foundation-comms.streamevent.md)<!-- -->&gt; | A listener callback function. |
 |  complete | Listener&lt;[StreamCompleteEvent](./foundation-comms.streamcompleteevent.md)<!-- -->&gt; | A complete listener callback function. |
+|  error | Listener&lt;[StreamErrorEvent](./foundation-comms.streamerrorevent.md)<!-- -->&gt; | A error listener callback function. |
 
 **Returns:**
 

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

@@ -19,9 +19,10 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter
 |  --- | --- | --- |
 |  [addCommitListener(listener)](./foundation-comms.defaultconnectevents.addcommitlistener.md) |  | Add a commit listener. |
 |  [addMetadataListener(listener)](./foundation-comms.defaultconnectevents.addmetadatalistener.md) |  | Add a metadata listener. |
-|  [addStreamListener(listener, complete)](./foundation-comms.defaultconnectevents.addstreamlistener.md) |  | Add a stream listener. |
+|  [addStreamListener(listener, complete, error)](./foundation-comms.defaultconnectevents.addstreamlistener.md) |  | Add a stream listener. |
 |  [onCommitEvent(eventName, message)](./foundation-comms.defaultconnectevents.oncommitevent.md) |  | Called by Connect. |
 |  [onMetadataEvent(resourceName, message, error)](./foundation-comms.defaultconnectevents.onmetadataevent.md) |  | Called by Connect. |
 |  [onStreamCompleteEvent(resourceName, stream)](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md) |  | Called by Connect. |
+|  [onStreamErrorEvent(resourceName, stream, error)](./foundation-comms.defaultconnectevents.onstreamerrorevent.md) |  | Called by Connect. |
 |  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.defaultconnectevents.onstreamevent.md) |  | Called by Connect. |
 

package/docs/api/foundation-comms.defaultconnectevents.onstreamerrorevent.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onStreamErrorEvent](./foundation-comms.defaultconnectevents.onstreamerrorevent.md)
+
+## DefaultConnectEvents.onStreamErrorEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
+|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
+|  error | any | The error that occurred. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.defaulthttpconnect._constructor_.md

@@ -9,7 +9,7 @@ Constructs a new instance of the `DefaultHttpConnect` class
 **Signature:**
 
 ```typescript
-constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCache: MetaCache, serializer: JSONSerializer, config?: HttpConnectConfig);
+constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCache: MetaCache, serializer: JSONSerializer, config: HttpConnectConfig);
 ```
 
 ## Parameters
@@ -21,5 +21,5 @@ constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCa
 |  session | [Session](./foundation-comms.session.md) |  |
 |  metaCache | [MetaCache](./foundation-comms.metacache.md) |  |
 |  serializer | JSONSerializer |  |
-|  config | [HttpConnectConfig](./foundation-comms.httpconnectconfig.md) | _(Optional)_ |
+|  config | HttpConnectConfig |  |
 

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

@@ -49,5 +49,6 @@ export declare class DefaultHttpConnect implements Connect
 |  [setValidSession(valid)](./foundation-comms.defaulthttpconnect.setvalidsession.md) |  |  |
 |  [snapshot(resourceName, params)](./foundation-comms.defaulthttpconnect.snapshot.md) |  |  |
 |  [stream(resourceName, onMessage, onError, params)](./foundation-comms.defaulthttpconnect.stream.md) |  |  |
+|  [streamState(resourceName, onMessage, onError, params, initialState)](./foundation-comms.defaulthttpconnect.streamstate.md) |  |  |
 |  [streamWithoutAutoTeardown(resourceName, onMessage, onError, params)](./foundation-comms.defaulthttpconnect.streamwithoutautoteardown.md) |  |  |
 

package/docs/api/foundation-comms.defaulthttpconnect.streamstate.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultHttpConnect](./foundation-comms.defaulthttpconnect.md) &gt; [streamState](./foundation-comms.defaulthttpconnect.streamstate.md)
+
+## DefaultHttpConnect.streamState() method
+
+**Signature:**
+
+```typescript
+streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string |  |
+|  onMessage | Function | _(Optional)_ |
+|  onError | Function | _(Optional)_ |
+|  params | any | _(Optional)_ |
+|  initialState | any\[\] | _(Optional)_ |
+
+**Returns:**
+
+Observable&lt;any\[\]&gt;
+

package/docs/api/foundation-comms.md

@@ -76,8 +76,6 @@
 |  [Dataview](./foundation-comms.dataview.md) | Dataview object |
 |  [FoundationAnalytics](./foundation-comms.foundationanalytics.md) | Represents an analytics tracking system. |
 |  [Http](./foundation-comms.http.md) | An interface representing an HTTP client that can make GET and POST requests and return a promise with the response data. |
-|  [HttpConnectConfig](./foundation-comms.httpconnectconfig.md) | Configuration options for the Connect (HTTP) instance. |
-|  [HttpPollingConfig](./foundation-comms.httppollingconfig.md) | Configuration options for http connection. |
 |  [HttpRequestInit](./foundation-comms.httprequestinit.md) | The options object used when making an HTTP request. |
 |  [JsonSchemaCache](./foundation-comms.jsonschemacache.md) | A JSON schema cache definition |
 |  [LogoutResult](./foundation-comms.logoutresult.md) | Represents the result of a user logout operation. |
@@ -87,7 +85,6 @@
 |  [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md) | MonitoredResourceMetadata. |
 |  [NetworkMonitor](./foundation-comms.networkmonitor.md) | <code>NetworkMonitor</code> monitors network and resource availability and health. |
 |  [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) | NetworkMonitorConfig DI interface. |
-|  [PollingConfiguration](./foundation-comms.pollingconfiguration.md) | Configuration options for http polling. |
 |  [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) | <code>SerializedSocketStatus</code> provides the serialize state of the web socket. |
 |  [Serializer](./foundation-comms.serializer.md) | A Serializer interface for serializing and deserializing objects. |
 |  [Session](./foundation-comms.session.md) | Represents a session storage and its capabilities. Provides methods to set and get items from the specified storage. |
@@ -112,7 +109,6 @@
 |  [defaultCredentialManagerConfig](./foundation-comms.defaultcredentialmanagerconfig.md) | The default configuration for the CredentialManager service. |
 |  [defaultCredentialRequestOptions](./foundation-comms.defaultcredentialrequestoptions.md) | The default request options for the CredentialManager service. |
 |  [defaultDatasourceConfig](./foundation-comms.defaultdatasourceconfig.md) | The default configuration for the Datasource service. |
-|  [defaultHttpConnectConfig](./foundation-comms.defaulthttpconnectconfig.md) | The default configuration for connecting to an HTTP service. |
 |  [defaultNetworkMonitorConfig](./foundation-comms.defaultnetworkmonitorconfig.md) | Default NetworkMonitorConfig DI implementation. |
 |  [exponentialScheduler](./foundation-comms.exponentialscheduler.md) | Expontential Interval scheduler for reconnect |
 |  [extractFieldDefinitions](./foundation-comms.extractfielddefinitions.md) | Extracts the field definitions from the metadata. |
@@ -126,6 +122,7 @@
 |  [networkLogger](./foundation-comms.networklogger.md) |  |
 |  [retryInterval](./foundation-comms.retryinterval.md) | Generate reconnect interval based on scheduler |
 |  [StreamCompleteEventType](./foundation-comms.streamcompleteeventtype.md) |  |
+|  [StreamErrorEventType](./foundation-comms.streamerroreventtype.md) |  |
 |  [StreamEventType](./foundation-comms.streameventtype.md) |  |
 |  [SystemHealthChanged](./foundation-comms.systemhealthchanged.md) | SystemHealthChanged. |
 |  [toFieldMetadata](./foundation-comms.tofieldmetadata.md) | Converts the field definitions to field metadata. |
@@ -179,6 +176,8 @@
 |  [StorageType](./foundation-comms.storagetype.md) | The available browser storage types. |
 |  [StreamCompleteEvent](./foundation-comms.streamcompleteevent.md) |  |
 |  [StreamCompleteEventDetail](./foundation-comms.streamcompleteeventdetail.md) |  |
+|  [StreamErrorEvent](./foundation-comms.streamerrorevent.md) |  |
+|  [StreamErrorEventDetail](./foundation-comms.streamerroreventdetail.md) |  |
 |  [StreamEvent](./foundation-comms.streamevent.md) |  |
 |  [StreamEventDetail](./foundation-comms.streameventdetail.md) |  |
 |  [StreamEventFunctions](./foundation-comms.streameventfunctions.md) |  |

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"
+```