@aws-amplify/api-graphql 4.3.4-events.81620c6.0 → 4.3.4-storage-browser.4db9fef.0

package/dist/esm/Providers/AWSAppSyncRealTimeProvider/index.d.ts

@@ -1,12 +1,23 @@
+import { Observable } from 'rxjs';
 import { CustomUserAgentDetails, DocumentType, GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
 import { CustomHeaders } from '@aws-amplify/data-schema/runtime';
-import { AWSWebSocketProvider } from '../AWSWebSocketProvider';
+import { PubSubContentObserver } from '../../types/PubSub';
+import { SUBSCRIPTION_STATUS } from '../constants';
 type ResolvedGraphQLAuthModes = Exclude<GraphQLAuthMode, 'identityPool'>;
+export interface ObserverQuery {
+    observer: PubSubContentObserver;
+    query: string;
+    variables: Record<string, DocumentType>;
+    subscriptionState: SUBSCRIPTION_STATUS;
+    subscriptionReadyCallback?(): void;
+    subscriptionFailedCallback?(reason?: any): void;
+    startAckTimeoutId?: ReturnType<typeof setTimeout>;
+}
 export interface AWSAppSyncRealTimeProviderOptions {
     appSyncGraphqlEndpoint?: string;
     authenticationType?: ResolvedGraphQLAuthModes;
     query?: string;
-    variables?: DocumentType;
+    variables?: Record<string, DocumentType>;
     apiKey?: string;
     region?: string;
     libraryConfigHeaders?(): Promise<Record<string, unknown> | Headers>;
@@ -14,25 +25,65 @@ export interface AWSAppSyncRealTimeProviderOptions {
     additionalCustomHeaders?: Record<string, string>;
     authToken?: string;
 }
-interface DataObject extends Record<string, unknown> {
-    data: Record<string, unknown>;
-}
-interface DataPayload {
-    id: string;
-    payload: DataObject;
-    type: string;
-}
-export declare class AWSAppSyncRealTimeProvider extends AWSWebSocketProvider {
+export declare class AWSAppSyncRealTimeProvider {
+    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();
-    subscribe(options?: AWSAppSyncRealTimeProviderOptions, customUserAgentDetails?: CustomUserAgentDetails): import("rxjs").Observable<Record<string, unknown>>;
+    /**
+     * Mark the socket closed and release all active listeners
+     */
+    close(): void;
+    getNewWebSocket(url: string, protocol: string[]): WebSocket;
     getProviderName(): string;
-    protected _prepareSubscriptionPayload({ options, subscriptionId, customUserAgentDetails, additionalCustomHeaders, libraryConfigHeaders, }: {
-        options: AWSAppSyncRealTimeProviderOptions;
-        subscriptionId: string;
-        customUserAgentDetails: CustomUserAgentDetails | undefined;
-        additionalCustomHeaders: Record<string, string>;
-        libraryConfigHeaders: Record<string, string>;
-    }): Promise<string>;
-    protected _handleSubscriptionData(message: MessageEvent): [boolean, DataPayload];
+    private isCustomDomain;
+    subscribe(options?: AWSAppSyncRealTimeProviderOptions, customUserAgentDetails?: CustomUserAgentDetails): Observable<Record<string, unknown>>;
+    private _startSubscriptionWithAWSAppSyncRealTime;
+    private _logStartSubscriptionError;
+    private _waitForSubscriptionToBeConnected;
+    private _sendUnsubscriptionMessage;
+    private _removeSubscriptionObserver;
+    private _closeSocketIfRequired;
+    private _handleIncomingSubscriptionMessage;
+    private _errorDisconnect;
+    private _timeoutStartSubscriptionAck;
+    /**
+     * Strips out `Authorization` header if present
+     */
+    private _extractNonAuthHeaders;
+    /**
+     *
+     * @param headers - http headers
+     * @returns uri-encoded query parameters derived from custom headers
+     */
+    private _queryParamsFromCustomHeaders;
+    /**
+     * Normalizes AppSync realtime endpoint URL
+     *
+     * @param appSyncGraphqlEndpoint - AppSync endpointUri from config
+     * @param urlParams - URLSearchParams
+     * @returns fully resolved string realtime endpoint URL
+     */
+    private _realtimeUrlWithQueryString;
+    private _initializeWebSocketConnection;
+    private _initializeRetryableHandshake;
+    /**
+     *
+     * @param subprotocol -
+     */
+    private _initializeHandshake;
+    private _awsRealTimeHeaderBasedAuth;
+    private _awsAuthTokenHeader;
+    private _awsRealTimeApiKeyHeader;
+    private _awsRealTimeIAMHeader;
+    private _customAuthHeader;
 }
 export {};