@genesislcap/foundation-comms 14.167.3-alpha-b40d1e5.0 → 14.167.3-alpha-69ba23f.0

package/dist/dts/networkMonitor/types.d.ts

@@ -1,133 +0,0 @@
-import Bowser from 'bowser';
-import type { StreamEventDetail } from '../connect/connect.events';
-import type { Message } from '../connect/message';
-import type { SocketObservable } from '../connect/socket';
-import type { SerializedSocketStatus } from '../connect/socket.status';
-/**
- * MonitoredResource.
- * @public
- */
-export type MonitoredResource = SocketObservable<any>;
-/**
- * MonitoredResourceChecksResult.
- * @public
- */
-export interface MonitoredResourceChecksResult {
-    isConnected: boolean;
-    lastUpdated: number;
-    lastMessage?: Message;
-    timeout?: boolean;
-}
-/**
- * MonitoredResourceChecks.
- * @param sourceRef - The resource source ref.
- * @param resource - The resource reference.
- * @public
- */
-export type MonitoredResourceChecks = (sourceRef: string, resource: MonitoredResource) => Promise<MonitoredResourceChecksResult>;
-/**
- * MonitoredResourceMetadata.
- * @public
- */
-export interface MonitoredResourceMetadata extends Partial<MonitoredResourceChecksResult>, Partial<StreamEventDetail> {
-}
-/**
- * MonitoredResourceDataLogon.
- * @param metadata - The resource metadata.
- * @public
- */
-export type MonitoredResourceDataLogon = (metadata: MonitoredResourceMetadata) => void;
-/**
- * ResourceHealth.
- * @public
- */
-export type ResourceHealth = MonitoredResourceChecksResult & {
-    name: string;
-    sourceRef: string;
-    lastError?: any;
-};
-/**
- * SystemHealthStatus.
- * @public
- */
-export type SystemHealthStatus = {
-    /**
-     * Is the browser or device working online.
-     */
-    isOnline: boolean;
-    /**
-     * Browser information.
-     */
-    browserInformation?: Bowser.Parser.ParsedResult;
-    /**
-     * Is the user authenticated.
-     */
-    isAuthenticated: boolean;
-    /**
-     * The username if authenticated.
-     */
-    username?: string;
-    /**
-     * Is everything online and connected.
-     */
-    isHealthy: boolean;
-    /**
-     * Socket status.
-     */
-    socket: SerializedSocketStatus;
-    /**
-     * Resource health information.
-     */
-    resources: Record<string, ResourceHealth>;
-    /**
-     * Resources are all connected flag.
-     */
-    resourcesAllConnected: boolean;
-    /**
-     * Last time the information was updated.
-     */
-    lastUpdated: number;
-    /**
-     * Next time the information will be updated.
-     *
-     * @privateRemarks
-     * Overlays may use deltas for a visual countdown to next update.
-     */
-    nextUpdate: number;
-    /**
-     * First time the information was updated.
-     *
-     * @remarks
-     * Can be used by applications to understand how-long it has been since the last refresh and to drive automations.
-     */
-    firstUpdated: number;
-    /**
-     * User requested run checks.
-     */
-    runAllChecks(): void;
-    /**
-     * User requested report stability to Genesis.
-     */
-    reportStabilityToGenesis(): Promise<boolean>;
-};
-/**
- * SystemHealthChanged.
- * @public
- */
-export declare const SystemHealthChanged = "system-health-changed";
-/**
- * SystemHealthChangedEvent.
- * @public
- */
-export type SystemHealthChangedEvent = CustomEvent<SystemHealthStatus>;
-/**
- * Genesis connect events that can be monitored to invoke resource checking.
- *
- * @remarks
- * 'steam' and 'commit' are monitored by default and will invoke resource checking. 'metadata' request failures are
- * monitored for the purpose of surfacing such errors to the console only. For now, 'metadata' errors are unrecoverable.
- *
- * @public
- */
-export type GenesisConnectEvents = 'stream' | 'commit';
-//# sourceMappingURL=types.d.ts.map

package/dist/dts/networkMonitor/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/networkMonitor/types.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,CACpC,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,iBAAiB,KACxB,OAAO,CAAC,6BAA6B,CAAC,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,yBACf,SAAQ,OAAO,CAAC,6BAA6B,CAAC,EAC5C,OAAO,CAAC,iBAAiB,CAAC;CAAG;AAEjC;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,QAAQ,EAAE,yBAAyB,KAAK,IAAI,CAAC;AAEvF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,6BAA6B,GAAG;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;IAChD;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC1C;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,IAAI,IAAI,CAAC;IACrB;;OAEG;IACH,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC9C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,0BAA0B,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC;AAEvE;;;;;;;;GAQG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,QAAQ,CAAC"}

package/dist/esm/connect/connect.events.js

@@ -1,113 +0,0 @@
-import { createObserver } from '@genesislcap/foundation-utils';
-import { DI } from '@microsoft/fast-foundation';
-/**
- * @public
- */
-export const CommitEventType = 'connect-commit-event';
-/**
- * @public
- */
-export const StreamEventType = 'connect-stream-event';
-/**
- * @public
- */
-export const StreamCompleteEventType = 'connect-stream-complete-event';
-/**
- * @public
- */
-export const MetadataEventType = 'connect-metadata-event';
-/**
- * Default ConnectEvents implementation.
- * @public
- */
-export class DefaultConnectEvents {
-    constructor() {
-        /** @internal */
-        this.streamListeners = createObserver();
-        /** @internal */
-        this.streamCompleteListeners = createObserver();
-        /** @internal */
-        this.commitListeners = createObserver();
-        /** @internal */
-        this.metadataListeners = createObserver();
-    }
-    /** {@inheritDoc ConnectEvents.addStreamListener} */
-    addStreamListener(listener, complete) {
-        var _a, _b;
-        const unsubscribe = (_a = this.streamListeners) === null || _a === void 0 ? void 0 : _a.subscribe(listener);
-        const completeUnsubscribe = (_b = this.streamCompleteListeners) === null || _b === void 0 ? void 0 : _b.subscribe(complete);
-        return () => {
-            unsubscribe();
-            completeUnsubscribe();
-        };
-    }
-    /** {@inheritDoc ConnectEventsEmitter.onStreamEvent} */
-    onStreamEvent(resourceName, message, stream, functions) {
-        var _a;
-        (_a = this.streamListeners) === null || _a === void 0 ? void 0 : _a.publish(new CustomEvent(StreamEventType, {
-            detail: {
-                functions,
-                message,
-                resourceName,
-                stream,
-            },
-        }));
-    }
-    /** {@inheritDoc ConnectEventsEmitter.onStreamCompleteEvent} */
-    onStreamCompleteEvent(stream) {
-        var _a;
-        (_a = this.streamCompleteListeners) === null || _a === void 0 ? void 0 : _a.publish(new CustomEvent(StreamCompleteEventType, {
-            detail: stream,
-        }));
-    }
-    /** {@inheritDoc ConnectEvents.addCommitListener} */
-    addCommitListener(listener) {
-        var _a;
-        return (_a = this.commitListeners) === null || _a === void 0 ? void 0 : _a.subscribe(listener);
-    }
-    /** {@inheritDoc ConnectEventsEmitter.onStreamEvent} */
-    onCommitEvent(eventName, message) {
-        var _a;
-        (_a = this.commitListeners) === null || _a === void 0 ? void 0 : _a.publish(new CustomEvent(CommitEventType, {
-            detail: {
-                eventName,
-                message,
-            },
-        }));
-    }
-    /** {@inheritDoc ConnectEvents.addMetadataListener} */
-    addMetadataListener(listener) {
-        var _a;
-        return (_a = this.metadataListeners) === null || _a === void 0 ? void 0 : _a.subscribe(listener);
-    }
-    /** {@inheritDoc ConnectEventsEmitter.onMetadataEvent} */
-    onMetadataEvent(resourceName, message, error) {
-        var _a;
-        (_a = this.metadataListeners) === null || _a === void 0 ? void 0 : _a.publish(new CustomEvent(MetadataEventType, {
-            detail: {
-                resourceName,
-                message,
-                error,
-            },
-        }));
-    }
-}
-/**
- * ConnectEvents DI key.
- *
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- *
- * @internal
- */
-export const ConnectEvents = DI.createInterface((x) => x.singleton(DefaultConnectEvents));
-/**
- * ConnectEventsEmitter DI key.
- *
- * @privateRemarks
- * ConnectEventsEmitter is used by Connect.
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- *
- * @internal
- */
-export const ConnectEventsEmitter = DI.createInterface((x) => x.aliasTo(ConnectEvents));

package/dist/esm/connect/socket.status.js

@@ -1,119 +0,0 @@
-import { __decorate } from "tslib";
-import { observable } from '@microsoft/fast-element';
-import { DI } from '@microsoft/fast-foundation';
-import { BehaviorSubject } from 'rxjs';
-/**
- * Default SocketStatus implementation.
- * @public
- */
-export class DefaultSocketStatus {
-    constructor() {
-        this.isConfigured = false;
-        this.isConnecting = false;
-        this.isConnected = false;
-        this.isReconnecting = false;
-        this.reconnectionLimitReached = false;
-        this.hasValidSession = false;
-        this.isConnectedSubject = new BehaviorSubject(this.isConnected);
-    }
-    get isDisconnected() {
-        return !this.isConnected;
-    }
-    get isDisconnectedByServer() {
-        return this.closedClean !== undefined ? !this.closedClean : false;
-    }
-    isConnectedChanged() {
-        var _a;
-        if (this.isConnected) {
-            this.resetClosedState();
-        }
-        this.isConnecting = false;
-        this.isReconnecting = false;
-        (_a = this.isConnectedSubject) === null || _a === void 0 ? void 0 : _a.next(this.isConnected);
-    }
-    isReconnectingChanged() {
-        if (this.isReconnecting) {
-            this.reconnectionLimitReached = false;
-        }
-    }
-    resetClosedState() {
-        this.closedCode = undefined;
-        this.closedReason = undefined;
-        this.closedClean = undefined;
-    }
-    serialize() {
-        return {
-            isConfigured: this.isConfigured,
-            isConnecting: this.isConnecting,
-            isConnected: this.isConnected,
-            isDisconnected: this.isDisconnected,
-            isDisconnectedByServer: this.isDisconnectedByServer,
-            isReconnecting: this.isReconnecting,
-            reconnectionLimitReached: this.reconnectionLimitReached,
-            hasValidSession: this.hasValidSession,
-            closedCode: this.closedCode,
-            closedReason: this.closedReason,
-            closedClean: this.closedClean,
-        };
-    }
-    onClose(event) {
-        this.isConnected = false;
-        this.closedCode = event.code;
-        this.closedReason = event.reason;
-        this.closedClean = event.wasClean;
-    }
-}
-__decorate([
-    observable
-], DefaultSocketStatus.prototype, "isConfigured", void 0);
-__decorate([
-    observable
-], DefaultSocketStatus.prototype, "isConnecting", void 0);
-__decorate([
-    observable
-], DefaultSocketStatus.prototype, "isConnected", void 0);
-__decorate([
-    observable
-], DefaultSocketStatus.prototype, "isReconnecting", void 0);
-__decorate([
-    observable
-], DefaultSocketStatus.prototype, "reconnectionLimitReached", void 0);
-__decorate([
-    observable
-], DefaultSocketStatus.prototype, "hasValidSession", void 0);
-__decorate([
-    observable
-], DefaultSocketStatus.prototype, "closedCode", void 0);
-__decorate([
-    observable
-], DefaultSocketStatus.prototype, "closedReason", void 0);
-__decorate([
-    observable
-], DefaultSocketStatus.prototype, "closedClean", void 0);
-/**
- * SocketStatus DI key.
- *
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- *
- * @internal
- */
-export const SocketStatus = DI.createInterface((x) => x.singleton(DefaultSocketStatus));
-/**
- * Gets SocketStatus from the DI container.
- *
- * @remarks
- * A utility method for host applications that are not using decorators or the DI container.
- *
- * @example
- * ```ts
- * import { getSocketStatus } from '@genesislcap/foundation-comms';
- * ...
- * private socketStatus = getSocketStatus();
- * ```
- *
- * @public
- */
-export function getSocketStatus() {
-    return DI.getOrCreateDOMContainer().get(SocketStatus);
-}

package/dist/esm/networkMonitor/config.js

@@ -1,46 +0,0 @@
-import { __awaiter } from "tslib";
-import { DI } from '@microsoft/fast-foundation';
-import { getConnect, getSocket } from '../connect';
-import { MessageType } from '../connect/message';
-/**
- * Default NetworkMonitorConfig DI implementation.
- * @public
- */
-export const defaultNetworkMonitorConfig = {
-    windowEvents: ['online', 'offline', 'pageshow'],
-    documentEvents: ['visibilitychange'],
-    genesisConnectEvents: ['stream', 'commit'],
-    checkInterval: 10000,
-    checkTimeout: 3000,
-    /**
-     * The default when a custom check function is not explicitly provided for a resource.
-     */
-    resourceChecks: (sourceRef) => __awaiter(void 0, void 0, void 0, function* () {
-        var _a;
-        const connect = getConnect();
-        const message = yield connect.getMoreColumns(sourceRef);
-        const lastUpdated = Date.now();
-        const lastMessage = message;
-        const isConnected = (_a = (message === null || message === void 0 ? void 0 : message.MESSAGE_TYPE) === MessageType.MORE_COLUMNS_ACK) !== null && _a !== void 0 ? _a : false;
-        return {
-            isConnected,
-            lastUpdated,
-            lastMessage,
-        };
-    }),
-    /**
-     * The default when a custom data logon function is not explicitly provided for a resource.
-     */
-    resourceDataLogon: ({ message, functions }) => {
-        const { onMessage, onError } = functions;
-        getSocket().sendForStream(message, onMessage, onError);
-    },
-};
-/**
- * NetworkMonitorConfig DI key.
- *
- * @internal
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- */
-export const NetworkMonitorConfig = DI.createInterface((x) => x.instance(defaultNetworkMonitorConfig));

package/dist/esm/networkMonitor/index.js

@@ -1,3 +0,0 @@
-export * from './types';
-export * from './config';
-export * from './service';