index.d.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts	68.75%	93%	96	66	30

import Observable, { ZenObservable } from 'zen-observable-ts';
import { ProviderOptions } from '../../types/Provider';
import { GRAPHQL_AUTH_MODE } from '@aws-amplify/auth';
import { AbstractPubSubProvider } from '../PubSubProvider';
import { SUBSCRIPTION_STATUS } from '../constants';
export declare type ObserverQuery = {
    observer: ZenObservable.SubscriptionObserver<any>;
    query: string;
    variables: Record<string, unknown>;
    subscriptionState: SUBSCRIPTION_STATUS;
    subscriptionReadyCallback?: Function;
    subscriptionFailedCallback?: Function;
    startAckTimeoutId?: ReturnType<typeof setTimeout>;
};
declare type GraphqlAuthModes = keyof typeof GRAPHQL_AUTH_MODE;
export interface AWSAppSyncRealTimeProviderOptions extends ProviderOptions {
    appSyncGraphqlEndpoint?: string;
    authenticationType?: GraphqlAuthModes;
    query?: string;
    variables?: Record<string, unknown>;
    apiKey?: string;
    region?: string;
    graphql_headers?: () => {} | (() => Promise<{}>);
    additionalHeaders?: {
        [key: string]: string;
    };
}
export declare class AWSAppSyncRealTimeProvider extends AbstractPubSubProvider<AWSAppSyncRealTimeProviderOptions> {
    private awsRealTimeSocket?;
    private socketStatus;
    private keepAliveTimeoutId?;
    private keepAliveTimeout;
    private keepAliveAlertTimeoutId?;
    private subscriptionObserverMap;
    private promiseArray;
    private connectionState;
    private readonly connectionStateMonitor;
    private readonly reconnectionMonitor;
    private connectionStateMonitorSubscription;
    constructor(options?: ProviderOptions);
    /**
     * Mark the socket closed and release all active listeners
     */
    close(): void;
    getNewWebSocket(url: string, protocol: string): WebSocket;
    getProviderName(): string;
    newClient(): Promise<any>;
    publish(_topics: string[] | string, _msg: Record<string, unknown>, _options?: AWSAppSyncRealTimeProviderOptions): Promise<void>;
    private isCustomDomain;
    subscribe(_topics: string[] | string, options?: AWSAppSyncRealTimeProviderOptions): Observable<Record<string, unknown>>;
    protected get isSSLEnabled(): boolean;
    private _startSubscriptionWithAWSAppSyncRealTime;
    private _logStartSubscriptionError;
    private _waitForSubscriptionToBeConnected;
    private _sendUnsubscriptionMessage;
    private _removeSubscriptionObserver;
    private _closeSocketIfRequired;
    private _handleIncomingSubscriptionMessage;
    private _errorDisconnect;
    private _timeoutStartSubscriptionAck;
    private _initializeWebSocketConnection;
    private _initializeRetryableHandshake;
    private _initializeHandshake;
    private _awsRealTimeHeaderBasedAuth;
    private _awsRealTimeCUPHeader;
    private _awsRealTimeOPENIDHeader;
    private _awsRealTimeApiKeyHeader;
    private _awsRealTimeIAMHeader;
    private _customAuthHeader;
    /**
     * @private
     */
    _ensureCredentials(): any;
}
export {};

[{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":28,"character":12,"text":"awsRealTimeSocket","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":29,"character":12,"text":"socketStatus","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":30,"character":12,"text":"keepAliveTimeoutId","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":31,"character":12,"text":"keepAliveTimeout","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":32,"character":12,"text":"keepAliveAlertTimeoutId","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":33,"character":12,"text":"subscriptionObserverMap","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":34,"character":12,"text":"promiseArray","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":35,"character":12,"text":"connectionState","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":36,"character":21,"text":"connectionStateMonitor","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":37,"character":21,"text":"reconnectionMonitor","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":38,"character":12,"text":"connectionStateMonitorSubscription","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":48,"character":12,"text":"isCustomDomain","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":51,"character":12,"text":"_startSubscriptionWithAWSAppSyncRealTime","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":52,"character":12,"text":"_logStartSubscriptionError","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":53,"character":12,"text":"_waitForSubscriptionToBeConnected","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":54,"character":12,"text":"_sendUnsubscriptionMessage","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":55,"character":12,"text":"_removeSubscriptionObserver","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":56,"character":12,"text":"_closeSocketIfRequired","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":57,"character":12,"text":"_handleIncomingSubscriptionMessage","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":58,"character":12,"text":"_errorDisconnect","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":59,"character":12,"text":"_timeoutStartSubscriptionAck","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":60,"character":12,"text":"_initializeWebSocketConnection","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":61,"character":12,"text":"_initializeRetryableHandshake","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":62,"character":12,"text":"_initializeHandshake","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":63,"character":12,"text":"_awsRealTimeHeaderBasedAuth","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":64,"character":12,"text":"_awsRealTimeCUPHeader","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":65,"character":12,"text":"_awsRealTimeOPENIDHeader","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":66,"character":12,"text":"_awsRealTimeApiKeyHeader","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":67,"character":12,"text":"_awsRealTimeIAMHeader","kind":1},{"file":"lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts","line":68,"character":12,"text":"_customAuthHeader","kind":1}]

TypeScript coverage report