@genesislcap/foundation-comms 14.372.0 → 14.373.0

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

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [onOtherTabReauthComplete](./foundation-comms.onothertabreauthcomplete.md)
+
+## onOtherTabReauthComplete() function
+
+Subscribes to storage events to detect when another tab has finished reauthenticating.
+
+**Signature:**
+
+```typescript
+export declare function onOtherTabReauthComplete(callback: () => void): () => void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+callback
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+Called when the other tab finishes reauthentication
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+() =&gt; void
+
+A function to unsubscribe from the storage events
+

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

@@ -0,0 +1,98 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SessionRefreshResult](./foundation-comms.sessionrefreshresult.md)
+
+## SessionRefreshResult enum
+
+Result of a session refresh attempt.
+
+**Signature:**
+
+```typescript
+export declare enum SessionRefreshResult 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+ALREADY\_VALID
+
+
+</td><td>
+
+`"ALREADY_VALID"`
+
+
+</td><td>
+
+Session was already valid
+
+
+</td></tr>
+<tr><td>
+
+FAILED
+
+
+</td><td>
+
+`"FAILED"`
+
+
+</td><td>
+
+Refresh failed - page will reload
+
+
+</td></tr>
+<tr><td>
+
+HANDLED\_BY\_OTHER\_TAB
+
+
+</td><td>
+
+`"HANDLED_BY_OTHER_TAB"`
+
+
+</td><td>
+
+Another tab is handling the refresh
+
+
+</td></tr>
+<tr><td>
+
+SUCCESS
+
+
+</td><td>
+
+`"SUCCESS"`
+
+
+</td><td>
+
+Session was successfully refreshed
+
+
+</td></tr>
+</tbody></table>
+

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

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [tryRefreshSession](./foundation-comms.tryrefreshsession.md)
+
+## tryRefreshSession() function
+
+Attempts to refresh the session when authentication has expired. Uses a localStorage-based lock mechanism to prevent multiple tabs from trying to reauthenticate simultaneously.
+
+**Signature:**
+
+```typescript
+export declare function tryRefreshSession(options?: {
+    reloadOnFailure?: boolean;
+}): Promise<SessionRefreshResult>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+{ reloadOnFailure?: boolean; }
+
+
+</td><td>
+
+_(Optional)_ Optional configuration
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[SessionRefreshResult](./foundation-comms.sessionrefreshresult.md)<!-- -->&gt;
+
+The result of the refresh attempt
+

package/docs/api-report.md.api.md

@@ -17,8 +17,8 @@ import { Listener } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
 import type { LogLevel } from '@genesislcap/foundation-utils';
 import { Observable } from 'rxjs';
-import { Observer } from '@genesislcap/foundation-utils';
-import { Observer as Observer_2 } from 'rxjs';
+import { Observer } from 'rxjs';
+import { Observer as Observer_2 } from '@genesislcap/foundation-utils';
 import { SetUserProperties } from '@genesislcap/foundation-user';
 import { Subscription as SocketSubscription } from 'rxjs';
 import { Subject } from 'rxjs';
@@ -1140,11 +1140,11 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
     // (undocumented)
     addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
     // @internal (undocumented)
-    protected commitListeners: Observer<CommitEvent>;
+    protected commitListeners: Observer_2<CommitEvent>;
     // @internal (undocumented)
-    protected commitResponseListeners: Observer<CommitResponseEvent>;
+    protected commitResponseListeners: Observer_2<CommitResponseEvent>;
     // @internal (undocumented)
-    protected metadataListeners: Observer<MetadataEvent>;
+    protected metadataListeners: Observer_2<MetadataEvent>;
     // 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)
@@ -1170,11 +1170,11 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
     // (undocumented)
     onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
     // @internal (undocumented)
-    protected streamCompleteListeners: Observer<StreamCompleteEvent>;
+    protected streamCompleteListeners: Observer_2<StreamCompleteEvent>;
     // @internal (undocumented)
-    protected streamErrorListeners: Observer<StreamErrorEvent>;
+    protected streamErrorListeners: Observer_2<StreamErrorEvent>;
     // @internal (undocumented)
-    protected streamListeners: Observer<StreamEvent>;
+    protected streamListeners: Observer_2<StreamEvent>;
 }
 
 // @public
@@ -1991,6 +1991,14 @@ export const Http: InterfaceSymbol<Http>;
 // @internal
 export const HttpConnect: InterfaceSymbol<Connect>;
 
+// @public
+export interface HttpError extends Error {
+    // (undocumented)
+    message: string;
+    // (undocumented)
+    status: number;
+}
+
 // @public
 export interface HttpRequestInit extends RequestInit {
     serializer?: JSONSerializer;
@@ -2426,6 +2434,9 @@ export const NetworkMonitorConfig: InterfaceSymbol<NetworkMonitorConfig>;
 // @public
 export function normaliseCriteria(criteria: string, delimiter?: string): string;
 
+// @public
+export function onOtherTabReauthComplete(callback: () => void): () => void;
+
 // @public (undocumented)
 export type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {
     VERBOSE?: boolean;
@@ -2660,6 +2671,14 @@ export class SessionMock implements Session {
     setStorageKeyPrefix(prefix: string): void;
 }
 
+// @public
+export enum SessionRefreshResult {
+    ALREADY_VALID = "ALREADY_VALID",
+    FAILED = "FAILED",
+    HANDLED_BY_OTHER_TAB = "HANDLED_BY_OTHER_TAB",
+    SUCCESS = "SUCCESS"
+}
+
 // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Socket" because one of its declarations is marked as @internal
 //
 // @public
@@ -2685,7 +2704,7 @@ export const Socket: InterfaceSymbol<Socket>;
 // @public
 export type SocketConnectOptions = {
     alwaysOn?: boolean;
-    connectObserver?: Observer_2<Message>;
+    connectObserver?: Observer<Message>;
     enableHeartbeat?: boolean;
     enableHeartbeatLogging?: boolean;
     enableMessageLogging?: boolean;
@@ -2756,7 +2775,7 @@ export class SocketObservable<T> extends Observable<T> {
 export type SocketReconnectOptions = {
     reconnectAttempts?: number;
     reconnectInterval?: number;
-    reconnectObserver?: Observer_2<any>;
+    reconnectObserver?: Observer<any>;
     reconnectStreams?: boolean;
     reconnectStrategy?: SocketReconnectStrategy;
 };
@@ -2876,6 +2895,11 @@ export type SystemHealthStatus = {
 // @public
 export const toFieldMetadata: (fieldDef: MetadataDetail[]) => FieldMetadata[];
 
+// @public
+export function tryRefreshSession(options?: {
+    reloadOnFailure?: boolean;
+}): Promise<SessionRefreshResult>;
+
 // @public
 export const TYPES_MAP: {
     STRING: FieldTypeEnum;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-comms",
   "description": "Genesis Foundation UI Comms",
-  "version": "14.372.0",
+  "version": "14.373.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -75,23 +75,24 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.372.0",
-    "@genesislcap/genx": "14.372.0",
-    "@genesislcap/rollup-builder": "14.372.0",
-    "@genesislcap/ts-builder": "14.372.0",
-    "@genesislcap/uvu-playwright-builder": "14.372.0",
-    "@genesislcap/vite-builder": "14.372.0",
-    "@genesislcap/webpack-builder": "14.372.0",
+    "@genesislcap/foundation-testing": "14.373.0",
+    "@genesislcap/genx": "14.373.0",
+    "@genesislcap/rollup-builder": "14.373.0",
+    "@genesislcap/ts-builder": "14.373.0",
+    "@genesislcap/uvu-playwright-builder": "14.373.0",
+    "@genesislcap/vite-builder": "14.373.0",
+    "@genesislcap/webpack-builder": "14.373.0",
     "@types/js-cookie": "^3.0.2",
     "@types/json-schema": "^7.0.11",
     "@types/webappsec-credential-management": "^0.6.2",
     "sinon": "^17.0.1"
   },
   "dependencies": {
-    "@genesislcap/foundation-broadcast-channel": "14.372.0",
-    "@genesislcap/foundation-logger": "14.372.0",
-    "@genesislcap/foundation-user": "14.372.0",
-    "@genesislcap/foundation-utils": "14.372.0",
+    "@genesislcap/foundation-broadcast-channel": "14.373.0",
+    "@genesislcap/foundation-logger": "14.373.0",
+    "@genesislcap/foundation-user": "14.373.0",
+    "@genesislcap/foundation-utils": "14.373.0",
+    "@genesislcap/web-core": "14.373.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
     "analytics": "0.8.16",
@@ -110,5 +111,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5687711a57e643a627b78f773f99fad4df1062e9"
+  "gitHead": "134490c6c8be9d443484692e1769bda61b00fa1e"
 }