@genesislcap/foundation-comms 14.306.1 → 14.306.2-alpha-7a2d723.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 (38) hide show
  1. package/dist/dts/auth/auth.d.ts +19 -2
  2. package/dist/dts/auth/auth.d.ts.map +1 -1
  3. package/dist/dts/connect/connect.d.ts +14 -2
  4. package/dist/dts/connect/connect.d.ts.map +1 -1
  5. package/dist/dts/connect/message.d.ts +1 -0
  6. package/dist/dts/connect/message.d.ts.map +1 -1
  7. package/dist/dts/connect/socket.d.ts +6 -11
  8. package/dist/dts/connect/socket.d.ts.map +1 -1
  9. package/dist/dts/metadata/metadata.types.d.ts +1 -0
  10. package/dist/dts/metadata/metadata.types.d.ts.map +1 -1
  11. package/dist/dts/testing/mocks/connect/connect.d.ts +1 -0
  12. package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
  13. package/dist/dts/testing/mocks/connect/socket.d.ts +5 -2
  14. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  15. package/dist/esm/auth/auth.js +91 -5
  16. package/dist/esm/connect/connect.js +24 -4
  17. package/dist/esm/connect/socket.js +15 -86
  18. package/dist/esm/testing/mocks/connect/connect.js +2 -1
  19. package/dist/esm/testing/mocks/connect/socket.js +8 -1
  20. package/dist/foundation-comms.api.json +257 -2
  21. package/dist/foundation-comms.d.ts +52 -23
  22. package/docs/api/foundation-comms.connect.md +21 -0
  23. package/docs/api/foundation-comms.connect.sessionexpired_.md +13 -0
  24. package/docs/api/foundation-comms.defaultauth._constructor_.md +15 -1
  25. package/docs/api/foundation-comms.defaultauth.md +20 -1
  26. package/docs/api/foundation-comms.defaultauth.reauth_action_lock_key.md +11 -0
  27. package/docs/api/foundation-comms.defaultconnect._constructor_.md +15 -1
  28. package/docs/api/foundation-comms.defaultconnect.md +41 -1
  29. package/docs/api/foundation-comms.defaultconnect.sessionexpired_.md +13 -0
  30. package/docs/api/foundation-comms.defaultconnect.user.md +11 -0
  31. package/docs/api/foundation-comms.defaultsocket.md +12 -0
  32. package/docs/api/foundation-comms.defaultsocket.updatesessionandsubscriptions.md +50 -0
  33. package/docs/api/foundation-comms.messagedetails.loggedinsysteminfo.md +1 -0
  34. package/docs/api/foundation-comms.rawdataserverresult.md +1 -0
  35. package/docs/api/foundation-comms.socket.md +11 -0
  36. package/docs/api/foundation-comms.socket.updatesessionandsubscriptions.md +52 -0
  37. package/docs/api-report.md.api.md +32 -13
  38. package/package.json +13 -13
@@ -17,8 +17,8 @@ import { Listener } from '@genesislcap/foundation-utils';
17
17
  import { Logger } from '@genesislcap/foundation-logger';
18
18
  import type { LogLevel } from '@genesislcap/foundation-utils';
19
19
  import { Observable } from 'rxjs';
20
- import { Observer } from '@genesislcap/foundation-utils';
21
- import { Observer as Observer_2 } from 'rxjs';
20
+ import { Observer } from 'rxjs';
21
+ import { Observer as Observer_2 } from '@genesislcap/foundation-utils';
22
22
  import { SetUserProperties } from '@genesislcap/foundation-user';
23
23
  import { Subscription as SocketSubscription } from 'rxjs';
24
24
  import { Subject } from 'rxjs';
@@ -197,6 +197,7 @@ export interface Connect {
197
197
  request(resourceName: string, params?: RequestParams): Promise<Message>;
198
198
  // @internal
199
199
  send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
200
+ readonly sessionExpired$?: Subject<boolean>;
200
201
  // @internal
201
202
  setValidSession(valid: boolean): void;
202
203
  snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
@@ -346,6 +347,8 @@ export class ConnectMock implements Connect {
346
347
  // (undocumented)
347
348
  send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
348
349
  // (undocumented)
350
+ sessionExpired$: BehaviorSubject<boolean>;
351
+ // (undocumented)
349
352
  setValidSession(valid: boolean): void;
350
353
  // (undocumented)
351
354
  snapshot(resourceName: string, params?: any): Promise<Message>;
@@ -1030,7 +1033,7 @@ export interface Dataview {
1030
1033
 
1031
1034
  // @public
1032
1035
  export class DefaultAuth implements Auth {
1033
- constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User_2);
1036
+ constructor(session: Session, connect: Connect, messageBuilder: MessageBuilder, credentialManager: CredentialManager, currentUser: User_2, socket: Socket);
1034
1037
  // (undocumented)
1035
1038
  currentUser: User_2;
1036
1039
  // (undocumented)
@@ -1046,12 +1049,14 @@ export class DefaultAuth implements Auth {
1046
1049
  // (undocumented)
1047
1050
  logout(): Promise<LogoutResult>;
1048
1051
  // (undocumented)
1052
+ static REAUTH_ACTION_LOCK_KEY: string;
1053
+ // (undocumented)
1049
1054
  reAuthFromSession(): Promise<boolean>;
1050
1055
  }
1051
1056
 
1052
1057
  // @public
1053
1058
  export class DefaultConnect implements Connect {
1054
- constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
1059
+ constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig, user: User_2);
1055
1060
  // (undocumented)
1056
1061
  commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
1057
1062
  // (undocumented)
@@ -1086,6 +1091,7 @@ export class DefaultConnect implements Connect {
1086
1091
  request(resourceName: string, params?: RequestParams): Promise<Message>;
1087
1092
  // (undocumented)
1088
1093
  send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
1094
+ readonly sessionExpired$: BehaviorSubject<boolean>;
1089
1095
  // @deprecated (undocumented)
1090
1096
  setValidSession(valid: boolean): void;
1091
1097
  // (undocumented)
@@ -1098,6 +1104,8 @@ export class DefaultConnect implements Connect {
1098
1104
  streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
1099
1105
  // (undocumented)
1100
1106
  streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
1107
+ // (undocumented)
1108
+ protected user: User_2;
1101
1109
  }
1102
1110
 
1103
1111
  // @public
@@ -1122,11 +1130,11 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
1122
1130
  // (undocumented)
1123
1131
  addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
1124
1132
  // @internal (undocumented)
1125
- protected commitListeners: Observer<CommitEvent>;
1133
+ protected commitListeners: Observer_2<CommitEvent>;
1126
1134
  // @internal (undocumented)
1127
- protected commitResponseListeners: Observer<CommitResponseEvent>;
1135
+ protected commitResponseListeners: Observer_2<CommitResponseEvent>;
1128
1136
  // @internal (undocumented)
1129
- protected metadataListeners: Observer<MetadataEvent>;
1137
+ protected metadataListeners: Observer_2<MetadataEvent>;
1130
1138
  // 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
1131
1139
  //
1132
1140
  // (undocumented)
@@ -1152,11 +1160,11 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
1152
1160
  // (undocumented)
1153
1161
  onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
1154
1162
  // @internal (undocumented)
1155
- protected streamCompleteListeners: Observer<StreamCompleteEvent>;
1163
+ protected streamCompleteListeners: Observer_2<StreamCompleteEvent>;
1156
1164
  // @internal (undocumented)
1157
- protected streamErrorListeners: Observer<StreamErrorEvent>;
1165
+ protected streamErrorListeners: Observer_2<StreamErrorEvent>;
1158
1166
  // @internal (undocumented)
1159
- protected streamListeners: Observer<StreamEvent>;
1167
+ protected streamListeners: Observer_2<StreamEvent>;
1160
1168
  }
1161
1169
 
1162
1170
  // @public
@@ -1672,6 +1680,8 @@ export class DefaultSocket implements Socket {
1672
1680
  sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
1673
1681
  // (undocumented)
1674
1682
  socketMessages: () => SocketSubject<Message>;
1683
+ // (undocumented)
1684
+ updateSessionAndSubscriptions(refreshTokenResult: string): void;
1675
1685
  protected user: User_2;
1676
1686
  }
1677
1687
 
@@ -2195,6 +2205,7 @@ export namespace MessageDetails {
2195
2205
  NOTIFY_EXPIRY?: boolean;
2196
2206
  PRODUCT?: any[];
2197
2207
  SYSTEM?: any;
2208
+ SESSION_TIMEOUT_MINS?: number;
2198
2209
  };
2199
2210
  export type Login = LoginBasic | LoginSSO | LoginJWT;
2200
2211
  export type LoginBasic = {
@@ -2425,6 +2436,7 @@ export type RawDataServerResult = {
2425
2436
  MORE_ROWS: boolean;
2426
2437
  ROWS_COUNT: number;
2427
2438
  SEQUENCE_ID: number;
2439
+ LOGGED_OUT: boolean;
2428
2440
  };
2429
2441
 
2430
2442
  // @public
@@ -2650,6 +2662,7 @@ export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 're
2650
2662
  sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
2651
2663
  // (undocumented)
2652
2664
  socketMessages(): SocketSubject<Message>;
2665
+ updateSessionAndSubscriptions(refreshToken: string): void;
2653
2666
  }
2654
2667
 
2655
2668
  // @internal
@@ -2658,7 +2671,7 @@ export const Socket: InterfaceSymbol<Socket>;
2658
2671
  // @public
2659
2672
  export type SocketConnectOptions = {
2660
2673
  alwaysOn?: boolean;
2661
- connectObserver?: Observer_2<Message>;
2674
+ connectObserver?: Observer<Message>;
2662
2675
  enableHeartbeat?: boolean;
2663
2676
  enableHeartbeatLogging?: boolean;
2664
2677
  enableMessageLogging?: boolean;
@@ -2715,9 +2728,15 @@ export class SocketMock implements Socket {
2715
2728
  // (undocumented)
2716
2729
  sendForStreamWithoutTeardown<T>(message: Message<any>, onMessage: Function, onError: Function): Observable<Message>;
2717
2730
  // (undocumented)
2731
+ sessionExpired(): SocketObservable<PongMessage>;
2732
+ // (undocumented)
2733
+ sessionExpiredSubject: SocketSubject<PongMessage>;
2734
+ // (undocumented)
2718
2735
  socketMessages(): SocketSubject<Message>;
2719
2736
  // (undocumented)
2720
2737
  socketMessagesSubject: SocketSubject<Message>;
2738
+ // (undocumented)
2739
+ updateSessionAndSubscriptions(refreshToken: string): void;
2721
2740
  }
2722
2741
 
2723
2742
  // @public
@@ -2729,7 +2748,7 @@ export class SocketObservable<T> extends Observable<T> {
2729
2748
  export type SocketReconnectOptions = {
2730
2749
  reconnectAttempts?: number;
2731
2750
  reconnectInterval?: number;
2732
- reconnectObserver?: Observer_2<any>;
2751
+ reconnectObserver?: Observer<any>;
2733
2752
  reconnectStreams?: boolean;
2734
2753
  reconnectStrategy?: SocketReconnectStrategy;
2735
2754
  };
@@ -2902,7 +2921,7 @@ export const WSConnect: InterfaceSymbol<Connect>;
2902
2921
 
2903
2922
  // Warnings were encountered during analysis:
2904
2923
  //
2905
- // src/connect/message.ts:291:3 - (ae-forgotten-export) The symbol "RESOURCE_DETAILS" needs to be exported by the entry point index.d.ts
2924
+ // src/connect/message.ts:292:3 - (ae-forgotten-export) The symbol "RESOURCE_DETAILS" needs to be exported by the entry point index.d.ts
2906
2925
 
2907
2926
  // (No @packageDocumentation comment for this package)
2908
2927
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-comms",
3
3
  "description": "Genesis Foundation UI Comms",
4
- "version": "14.306.1",
4
+ "version": "14.306.2-alpha-7a2d723.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -75,23 +75,23 @@
75
75
  }
76
76
  },
77
77
  "devDependencies": {
78
- "@genesislcap/foundation-testing": "14.306.1",
79
- "@genesislcap/genx": "14.306.1",
80
- "@genesislcap/rollup-builder": "14.306.1",
81
- "@genesislcap/ts-builder": "14.306.1",
82
- "@genesislcap/uvu-playwright-builder": "14.306.1",
83
- "@genesislcap/vite-builder": "14.306.1",
84
- "@genesislcap/webpack-builder": "14.306.1",
78
+ "@genesislcap/foundation-testing": "14.306.2-alpha-7a2d723.0",
79
+ "@genesislcap/genx": "14.306.2-alpha-7a2d723.0",
80
+ "@genesislcap/rollup-builder": "14.306.2-alpha-7a2d723.0",
81
+ "@genesislcap/ts-builder": "14.306.2-alpha-7a2d723.0",
82
+ "@genesislcap/uvu-playwright-builder": "14.306.2-alpha-7a2d723.0",
83
+ "@genesislcap/vite-builder": "14.306.2-alpha-7a2d723.0",
84
+ "@genesislcap/webpack-builder": "14.306.2-alpha-7a2d723.0",
85
85
  "@types/js-cookie": "^3.0.2",
86
86
  "@types/json-schema": "^7.0.11",
87
87
  "@types/webappsec-credential-management": "^0.6.2",
88
88
  "sinon": "^17.0.1"
89
89
  },
90
90
  "dependencies": {
91
- "@genesislcap/foundation-broadcast-channel": "14.306.1",
92
- "@genesislcap/foundation-logger": "14.306.1",
93
- "@genesislcap/foundation-user": "14.306.1",
94
- "@genesislcap/foundation-utils": "14.306.1",
91
+ "@genesislcap/foundation-broadcast-channel": "14.306.2-alpha-7a2d723.0",
92
+ "@genesislcap/foundation-logger": "14.306.2-alpha-7a2d723.0",
93
+ "@genesislcap/foundation-user": "14.306.2-alpha-7a2d723.0",
94
+ "@genesislcap/foundation-utils": "14.306.2-alpha-7a2d723.0",
95
95
  "@microsoft/fast-element": "1.14.0",
96
96
  "@microsoft/fast-foundation": "2.49.6",
97
97
  "analytics": "0.8.16",
@@ -110,5 +110,5 @@
110
110
  "publishConfig": {
111
111
  "access": "public"
112
112
  },
113
- "gitHead": "796b1d47ed23c0c4036b8b5af79268f4b0355ce3"
113
+ "gitHead": "61fbdc9a3b045a1dbd46decec5925e7d09dcd525"
114
114
  }