@aws-amplify/api-graphql 3.4.12-unstable.7762f1a.0 → 4.0.0

package/README.md

@@ -0,0 +1,3 @@
+> INTERNAL USE ONLY
+
+This package contains the AWS Amplify API GraphQL category and is intended for internal use only. To integrate Amplify into your app, please use [aws-amplify](https://www.npmjs.com/package/aws-amplify).

package/lib/GraphQLAPI.d.ts

@@ -1,10 +1,11 @@
+import { AmplifyClassV6 } from '@aws-amplify/core';
 import { GraphQLOptions, GraphQLResult } from './types';
 import { InternalGraphQLAPIClass } from './internals';
-import Observable from 'zen-observable-ts';
-export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string) => {
+import { Observable } from 'rxjs';
+export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string | undefined) => {
     query: any;
     variables: {};
-    authToken: string;
+    authToken: string | undefined;
 };
 /**
  * Export Cloud Logic APIs
@@ -18,8 +19,20 @@ export declare class GraphQLAPIClass extends InternalGraphQLAPIClass {
      * @param [additionalHeaders] - headers to merge in after any `graphql_headers` set in the config
      * @returns An Observable if the query is a subscription query, else a promise of the graphql result.
      */
-    graphql<T = any>(options: GraphQLOptions, additionalHeaders?: {
+    graphql<T = any>(amplify: AmplifyClassV6 | (() => Promise<AmplifyClassV6>), options: GraphQLOptions, additionalHeaders?: {
         [key: string]: string;
     }): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>>;
+    /**
+     * Checks to see if an error thrown is from an api request cancellation
+     * @param error - Any error
+     * @returns A boolean indicating if the error was from an api request cancellation
+     */
+    isCancelError(error: any): boolean;
+    /**
+     * Cancels an inflight request. Only applicable for graphql queries and mutations
+     * @param {any} request - request to cancel
+     * @returns A boolean indicating if the request was cancelled
+     */
+    cancel(request: Promise<any>, message?: string): boolean;
 }
 export declare const GraphQLAPI: GraphQLAPIClass;

package/lib/GraphQLAPI.js

@@ -1,29 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-var core_1 = require("@aws-amplify/core");
-var internals_1 = require("./internals");
-exports.graphqlOperation = function (query, variables, authToken) {
-    if (variables === void 0) { variables = {}; }
-    return ({
-        query: query,
-        variables: variables,
-        authToken: authToken,
-    });
-};
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const internals_1 = require("./internals");
+exports.graphqlOperation = (query, variables = {}, authToken) => ({
+    query,
+    variables,
+    authToken,
+});
 /**
  * Export Cloud Logic APIs
  */
-var GraphQLAPIClass = /** @class */ (function (_super) {
-    tslib_1.__extends(GraphQLAPIClass, _super);
-    function GraphQLAPIClass() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    GraphQLAPIClass.prototype.getModuleName = function () {
+class GraphQLAPIClass extends internals_1.InternalGraphQLAPIClass {
+    getModuleName() {
         return 'GraphQLAPI';
-    };
+    }
     /**
      * Executes a GraphQL operation
      *
@@ -31,12 +21,28 @@ var GraphQLAPIClass = /** @class */ (function (_super) {
      * @param [additionalHeaders] - headers to merge in after any `graphql_headers` set in the config
      * @returns An Observable if the query is a subscription query, else a promise of the graphql result.
      */
-    GraphQLAPIClass.prototype.graphql = function (options, additionalHeaders) {
-        return _super.prototype.graphql.call(this, options, additionalHeaders);
-    };
-    return GraphQLAPIClass;
-}(internals_1.InternalGraphQLAPIClass));
+    graphql(amplify, options, additionalHeaders) {
+        return super.graphql(amplify, options, additionalHeaders, {
+            category: utils_1.Category.API,
+            action: utils_1.ApiAction.GraphQl,
+        });
+    }
+    /**
+     * Checks to see if an error thrown is from an api request cancellation
+     * @param error - Any error
+     * @returns A boolean indicating if the error was from an api request cancellation
+     */
+    isCancelError(error) {
+        return super.isCancelError(error);
+    }
+    /**
+     * Cancels an inflight request. Only applicable for graphql queries and mutations
+     * @param {any} request - request to cancel
+     * @returns A boolean indicating if the request was cancelled
+     */
+    cancel(request, message) {
+        return super.cancel(request, message);
+    }
+}
 exports.GraphQLAPIClass = GraphQLAPIClass;
 exports.GraphQLAPI = new GraphQLAPIClass(null);
-core_1.Amplify.register(exports.GraphQLAPI);
-//# sourceMappingURL=GraphQLAPI.js.map

package/lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts

@@ -0,0 +1,64 @@
+import { Observable } from 'rxjs';
+import { GraphQLAuthMode, CustomUserAgentDetails, DocumentType } from '@aws-amplify/core/internals/utils';
+import { PubSubContentObserver } from '../../types/PubSub';
+import { SUBSCRIPTION_STATUS } from '../constants';
+export declare type ObserverQuery = {
+    observer: PubSubContentObserver;
+    query: string;
+    variables: Record<string, DocumentType>;
+    subscriptionState: SUBSCRIPTION_STATUS;
+    subscriptionReadyCallback?: Function;
+    subscriptionFailedCallback?: Function;
+    startAckTimeoutId?: ReturnType<typeof setTimeout>;
+};
+export interface AWSAppSyncRealTimeProviderOptions {
+    appSyncGraphqlEndpoint?: string;
+    authenticationType?: GraphQLAuthMode;
+    query?: string;
+    variables?: Record<string, DocumentType>;
+    apiKey?: string;
+    region?: string;
+    graphql_headers?: () => {} | (() => Promise<{}>);
+    additionalHeaders?: {
+        [key: string]: string;
+    };
+}
+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(options?: AWSAppSyncRealTimeProviderOptions);
+    /**
+     * Mark the socket closed and release all active listeners
+     */
+    close(): void;
+    getNewWebSocket(url: string, protocol: string): WebSocket;
+    getProviderName(): string;
+    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;
+    private _initializeWebSocketConnection;
+    private _initializeRetryableHandshake;
+    private _initializeHandshake;
+    private _awsRealTimeHeaderBasedAuth;
+    private _awsAuthTokenHeader;
+    private _awsRealTimeApiKeyHeader;
+    private _awsRealTimeIAMHeader;
+    private _customAuthHeader;
+}