@genesislcap/foundation-comms 14.184.0 → 14.186.0

package/docs/api-report.md

@@ -166,7 +166,8 @@ export interface Connect {
     setValidSession(valid: boolean): void;
     snapshot(resourceName: string, params?: any): Promise<Message>;
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
-    // @alpha
+    streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
+    // @alpha @deprecated
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
 }
 
@@ -178,6 +179,7 @@ export const Connect: InterfaceSymbol<Connect>;
 // @public
 export interface ConnectConfig {
     connect: SocketConnectOptions;
+    isWebSocketExpression: RegExp;
     reconnect: SocketReconnectOptions;
 }
 
@@ -190,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
@@ -203,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;
 }
 
@@ -247,6 +250,8 @@ export class ConnectMock implements Connect {
     // (undocumented)
     nextJSONSchema: any;
     // (undocumented)
+    nextListState: any[];
+    // (undocumented)
     nextMessage: Message;
     // (undocumented)
     nextMetadata: Metadata;
@@ -265,6 +270,8 @@ export class ConnectMock implements Connect {
     // (undocumented)
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
     // (undocumented)
+    streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
+    // (undocumented)
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
 }
 
@@ -518,7 +525,7 @@ export class DefaultAuth implements Auth {
 
 // @public
 export class DefaultConnect implements Connect {
-    constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config?: ConnectConfig);
+    constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
     // (undocumented)
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
     // (undocumented)
@@ -560,6 +567,8 @@ export class DefaultConnect implements Connect {
     // (undocumented)
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
     // (undocumented)
+    streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
+    // (undocumented)
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
 }
 
@@ -579,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)
@@ -599,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>;
 }
 
@@ -781,7 +796,8 @@ export class DefaultHttp implements Http {
 
 // @public
 export class DefaultHttpConnect implements Connect {
-    constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCache: MetaCache, serializer: JSONSerializer, config?: HttpConnectConfig);
+    // Warning: (ae-forgotten-export) The symbol "HttpConnectConfig" needs to be exported by the entry point index.d.ts
+    constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCache: MetaCache, serializer: JSONSerializer, config: HttpConnectConfig);
     // (undocumented)
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
     // (undocumented)
@@ -826,12 +842,11 @@ export class DefaultHttpConnect implements Connect {
     // (undocumented)
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
     // (undocumented)
+    streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
+    // (undocumented)
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message<any>>;
 }
 
-// @public
-export const defaultHttpConnectConfig: HttpConnectConfig;
-
 // @alpha
 export class DefaultKVStorage implements KVStorage {
     constructor(connect: Connect, user: User_2, kvStorageConfig?: KVStorageConfig);
@@ -1270,27 +1285,6 @@ export const Http: InterfaceSymbol<Http>;
 // @internal
 export const HttpConnect: InterfaceSymbol<Connect>;
 
-// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "HttpConnectConfig" because one of its declarations is marked as @internal
-//
-// @public
-export interface HttpConnectConfig {
-    polling: HttpPollingConfig;
-}
-
-// @internal
-export const HttpConnectConfig: InterfaceSymbol<HttpConnectConfig>;
-
-// @public
-export interface HttpPollingConfig {
-    POLLING_FREQUENCY?: number;
-    POLLING_INTERVAL_MAP?: {
-        [resource: string]: number;
-    };
-    POLLING_MAP?: {
-        [key: string]: PollingConfiguration;
-    };
-}
-
 // @public
 export interface HttpRequestInit extends RequestInit {
     serializer?: JSONSerializer;
@@ -1716,18 +1710,11 @@ 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;
 };
 
-// @public
-export interface PollingConfiguration {
-    AMOUNT_OF_POLLS: number;
-    QUERIES: string[];
-    TEMP_FREQUENCY: number;
-}
-
 // @public (undocumented)
 export type PongMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'USER_NAME'> & {
     IS_AUTHENTICATED?: boolean;
@@ -2070,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>;
 
@@ -2170,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.184.0",
+  "version": "14.186.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -44,6 +44,7 @@
     "build:rollup:stats": "genx analyze -b rollup",
     "build:webpack": "genx build",
     "build:webpack:stats": "genx analyze",
+    "circular": "npx -y madge --extensions ts --circular ./src",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
     "dev": "npm run dev:tsc",
     "dev:rollup": "genx dev -b rollup",
@@ -65,23 +66,30 @@
     "test:unit:watch": "genx test --watch",
     "test:debug": "genx test --debug"
   },
+  "madge": {
+    "detectiveOptions": {
+      "ts": {
+        "skipTypeImports": true
+      }
+    }
+  },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.184.0",
-    "@genesislcap/genx": "14.184.0",
-    "@genesislcap/rollup-builder": "14.184.0",
-    "@genesislcap/ts-builder": "14.184.0",
-    "@genesislcap/uvu-playwright-builder": "14.184.0",
-    "@genesislcap/vite-builder": "14.184.0",
-    "@genesislcap/webpack-builder": "14.184.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": "^3.0.2"
+    "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.184.0",
-    "@genesislcap/foundation-user": "14.184.0",
-    "@genesislcap/foundation-utils": "14.184.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",
@@ -101,5 +109,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8aef45b63f3c8b0336b3f8cc97ad79a36e9b5381"
+  "gitHead": "1ebc5549ab49ef3a3e6c08c8aab0886dbebb3400"
 }

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

@@ -1,13 +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; [defaultHttpConnectConfig](./foundation-comms.defaulthttpconnectconfig.md)
-
-## defaultHttpConnectConfig variable
-
-The default configuration for connecting to an HTTP service.
-
-**Signature:**
-
-```typescript
-defaultHttpConnectConfig: HttpConnectConfig
-```

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

@@ -1,20 +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; [HttpConnectConfig](./foundation-comms.httpconnectconfig.md)
-
-## HttpConnectConfig interface
-
-Configuration options for the Connect (HTTP) instance.
-
-**Signature:**
-
-```typescript
-export interface HttpConnectConfig 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [polling](./foundation-comms.httpconnectconfig.polling.md) |  | [HttpPollingConfig](./foundation-comms.httppollingconfig.md) | Configuration options for http polling. |
-

package/docs/api/foundation-comms.httpconnectconfig.polling.md

@@ -1,13 +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; [HttpConnectConfig](./foundation-comms.httpconnectconfig.md) &gt; [polling](./foundation-comms.httpconnectconfig.polling.md)
-
-## HttpConnectConfig.polling property
-
-Configuration options for http polling.
-
-**Signature:**
-
-```typescript
-polling: HttpPollingConfig;
-```

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

@@ -1,22 +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; [HttpPollingConfig](./foundation-comms.httppollingconfig.md)
-
-## HttpPollingConfig interface
-
-Configuration options for http connection.
-
-**Signature:**
-
-```typescript
-export interface HttpPollingConfig 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [POLLING\_FREQUENCY?](./foundation-comms.httppollingconfig.polling_frequency.md) |  | number | _(Optional)_ The frequency of polling. |
-|  [POLLING\_INTERVAL\_MAP?](./foundation-comms.httppollingconfig.polling_interval_map.md) |  | { \[resource: string\]: number; } | _(Optional)_ The interval map of polling. |
-|  [POLLING\_MAP?](./foundation-comms.httppollingconfig.polling_map.md) |  | { \[key: string\]: [PollingConfiguration](./foundation-comms.pollingconfiguration.md)<!-- -->; } | _(Optional)_ The map of polling configuration. |
-

package/docs/api/foundation-comms.httppollingconfig.polling_frequency.md

@@ -1,13 +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; [HttpPollingConfig](./foundation-comms.httppollingconfig.md) &gt; [POLLING\_FREQUENCY](./foundation-comms.httppollingconfig.polling_frequency.md)
-
-## HttpPollingConfig.POLLING\_FREQUENCY property
-
-The frequency of polling.
-
-**Signature:**
-
-```typescript
-POLLING_FREQUENCY?: number;
-```

package/docs/api/foundation-comms.httppollingconfig.polling_interval_map.md

@@ -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; [HttpPollingConfig](./foundation-comms.httppollingconfig.md) &gt; [POLLING\_INTERVAL\_MAP](./foundation-comms.httppollingconfig.polling_interval_map.md)
-
-## HttpPollingConfig.POLLING\_INTERVAL\_MAP property
-
-The interval map of polling.
-
-**Signature:**
-
-```typescript
-POLLING_INTERVAL_MAP?: {
-        [resource: string]: number;
-    };
-```

package/docs/api/foundation-comms.httppollingconfig.polling_map.md

@@ -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; [HttpPollingConfig](./foundation-comms.httppollingconfig.md) &gt; [POLLING\_MAP](./foundation-comms.httppollingconfig.polling_map.md)
-
-## HttpPollingConfig.POLLING\_MAP property
-
-The map of polling configuration.
-
-**Signature:**
-
-```typescript
-POLLING_MAP?: {
-        [key: string]: PollingConfiguration;
-    };
-```

package/docs/api/foundation-comms.pollingconfiguration.amount_of_polls.md

@@ -1,18 +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; [PollingConfiguration](./foundation-comms.pollingconfiguration.md) &gt; [AMOUNT\_OF\_POLLS](./foundation-comms.pollingconfiguration.amount_of_polls.md)
-
-## PollingConfiguration.AMOUNT\_OF\_POLLS property
-
-The expected amount of HTTP polling attempts to be performed.
-
-**Signature:**
-
-```typescript
-AMOUNT_OF_POLLS: number;
-```
-
-## Remarks
-
-TEMP\_FREQUENCY \* AMOUNT\_OF\_POLLS = the total polling time/duration
-

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

@@ -1,22 +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; [PollingConfiguration](./foundation-comms.pollingconfiguration.md)
-
-## PollingConfiguration interface
-
-Configuration options for http polling.
-
-**Signature:**
-
-```typescript
-export interface PollingConfiguration 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [AMOUNT\_OF\_POLLS](./foundation-comms.pollingconfiguration.amount_of_polls.md) |  | number | The expected amount of HTTP polling attempts to be performed. |
-|  [QUERIES](./foundation-comms.pollingconfiguration.queries.md) |  | string\[\] | The queries to be polled. |
-|  [TEMP\_FREQUENCY](./foundation-comms.pollingconfiguration.temp_frequency.md) |  | number | The temporary polling frequency. |
-

package/docs/api/foundation-comms.pollingconfiguration.queries.md

@@ -1,13 +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; [PollingConfiguration](./foundation-comms.pollingconfiguration.md) &gt; [QUERIES](./foundation-comms.pollingconfiguration.queries.md)
-
-## PollingConfiguration.QUERIES property
-
-The queries to be polled.
-
-**Signature:**
-
-```typescript
-QUERIES: string[];
-```

package/docs/api/foundation-comms.pollingconfiguration.temp_frequency.md

@@ -1,13 +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; [PollingConfiguration](./foundation-comms.pollingconfiguration.md) &gt; [TEMP\_FREQUENCY](./foundation-comms.pollingconfiguration.temp_frequency.md)
-
-## PollingConfiguration.TEMP\_FREQUENCY property
-
-The temporary polling frequency.
-
-**Signature:**
-
-```typescript
-TEMP_FREQUENCY: number;
-```