@aws-amplify/api-graphql 4.0.1-console-preview.b5a42af.0 → 4.0.1-console-preview.9607e4a.0

package/lib/GraphQLAPI.d.ts

@@ -1,10 +1,10 @@
 import { GraphQLOptions, GraphQLResult } from './types';
 import { InternalGraphQLAPIClass } from './internals';
 import { Observable } from 'rxjs';
-export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string) => {
+export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string | undefined) => {
     query: any;
     variables: {};
-    authToken: string;
+    authToken: string | undefined;
 };
 /**
  * Export Cloud Logic APIs
@@ -21,5 +21,17 @@ export declare class GraphQLAPIClass extends InternalGraphQLAPIClass {
     graphql<T = any>(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

@@ -31,6 +31,22 @@ var GraphQLAPIClass = /** @class */ (function (_super) {
     GraphQLAPIClass.prototype.graphql = function (options, additionalHeaders) {
         return _super.prototype.graphql.call(this, options, additionalHeaders);
     };
+    /**
+     * 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
+     */
+    GraphQLAPIClass.prototype.isCancelError = function (error) {
+        return _super.prototype.isCancelError.call(this, 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
+     */
+    GraphQLAPIClass.prototype.cancel = function (request, message) {
+        return _super.prototype.cancel.call(this, request, message);
+    };
     return GraphQLAPIClass;
 }(internals_1.InternalGraphQLAPIClass));
 exports.GraphQLAPIClass = GraphQLAPIClass;

package/lib/Providers/AWSAppSyncRealTimeProvider/index.js

@@ -781,6 +781,7 @@ var AWSAppSyncRealTimeProvider = /** @class */ (function () {
                             url: new URL(request.url),
                             body: request.data,
                         }, {
+                            // TODO: What do we need to do to remove these !'s?
                             credentials: creds,
                             signingRegion: endpointInfo.region,
                             signingService: endpointInfo.service,

package/lib/internals/InternalGraphQLAPI.d.ts

@@ -2,10 +2,10 @@ import { OperationTypeNode } from 'graphql';
 import { Observable } from 'rxjs';
 import { CustomUserAgentDetails } from '@aws-amplify/core/internals/utils';
 import { GraphQLResult, GraphQLOperation, GraphQLOptions } from '../types';
-export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string) => {
+export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string | undefined) => {
     query: any;
     variables: {};
-    authToken: string;
+    authToken: string | undefined;
 };
 /**
  * Export Cloud Logic APIs
@@ -41,6 +41,18 @@ export declare class InternalGraphQLAPIClass {
         [key: string]: string;
     }, customUserAgentDetails?: CustomUserAgentDetails): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>>;
     private _graphql;
+    /**
+     * Checks to see if an error thrown is from an api request cancellation
+     * @param {any} error - Any error
+     * @return {boolean} - 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;
     private _graphqlSubscribe;
 }
 export declare const InternalGraphQLAPI: InternalGraphQLAPIClass;

package/lib/internals/InternalGraphQLAPI.js

@@ -7,6 +7,7 @@ var graphql_1 = require("graphql");
 var core_1 = require("@aws-amplify/core");
 var utils_1 = require("@aws-amplify/core/internals/utils");
 var types_1 = require("../types");
+var api_rest_1 = require("@aws-amplify/api-rest");
 var internals_1 = require("@aws-amplify/api-rest/internals");
 var AWSAppSyncRealTimeProvider_1 = require("../Providers/AWSAppSyncRealTimeProvider");
 var USER_AGENT_HEADER = 'x-amz-user-agent';
@@ -29,26 +30,27 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
      */
     function InternalGraphQLAPIClass(options) {
         this.Cache = core_1.Cache;
-        this._api = { post: internals_1.post };
+        this._api = { post: internals_1.post, updateRequestToBeCancellable: internals_1.updateRequestToBeCancellable };
         this._options = options;
         logger.debug('API Options', this._options);
     }
     InternalGraphQLAPIClass.prototype.getModuleName = function () {
         return 'InternalGraphQLAPI';
     };
-    InternalGraphQLAPIClass.prototype._headerBasedAuth = function (defaultAuthenticationType, additionalHeaders, customUserAgentDetails) {
+    InternalGraphQLAPIClass.prototype._headerBasedAuth = function (authMode, additionalHeaders) {
         if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        var _a;
+        var _a, _b;
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var config, _b, region, appSyncGraphqlEndpoint, apiKey, defaultAuthMode, headers, _c, session, token, e_1;
-            return tslib_1.__generator(this, function (_d) {
-                switch (_d.label) {
+            var config, _c, region, appSyncGraphqlEndpoint, apiKey, defaultAuthMode, authenticationType, headers, _d, session, token, e_1;
+            return tslib_1.__generator(this, function (_e) {
+                switch (_e.label) {
                     case 0:
                         config = core_1.Amplify.getConfig();
-                        _b = config.API.GraphQL, region = _b.region, appSyncGraphqlEndpoint = _b.endpoint, apiKey = _b.apiKey, defaultAuthMode = _b.defaultAuthMode;
+                        _c = ((_a = config.API) === null || _a === void 0 ? void 0 : _a.GraphQL) || {}, region = _c.region, appSyncGraphqlEndpoint = _c.endpoint, apiKey = _c.apiKey, defaultAuthMode = _c.defaultAuthMode;
+                        authenticationType = authMode || defaultAuthMode || 'iam';
                         headers = {};
-                        _c = defaultAuthMode;
-                        switch (_c) {
+                        _d = authenticationType;
+                        switch (_d) {
                             case 'apiKey': return [3 /*break*/, 1];
                             case 'iam': return [3 /*break*/, 2];
                             case 'oidc': return [3 /*break*/, 4];
@@ -67,17 +69,17 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                         return [3 /*break*/, 11];
                     case 2: return [4 /*yield*/, core_1.fetchAuthSession()];
                     case 3:
-                        session = _d.sent();
+                        session = _e.sent();
                         if (session.credentials === undefined) {
                             throw new Error(types_1.GraphQLAuthError.NO_CREDENTIALS);
                         }
                         return [3 /*break*/, 11];
                     case 4:
-                        _d.trys.push([4, 6, , 7]);
+                        _e.trys.push([4, 6, , 7]);
                         token = void 0;
                         return [4 /*yield*/, core_1.fetchAuthSession()];
                     case 5:
-                        token = (_a = (_d.sent()).tokens) === null || _a === void 0 ? void 0 : _a.accessToken.toString();
+                        token = (_b = (_e.sent()).tokens) === null || _b === void 0 ? void 0 : _b.accessToken.toString();
                         if (!token) {
                             throw new Error(types_1.GraphQLAuthError.NO_FEDERATED_JWT);
                         }
@@ -86,7 +88,7 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                         };
                         return [3 /*break*/, 7];
                     case 6:
-                        e_1 = _d.sent();
+                        e_1 = _e.sent();
                         throw new Error(types_1.GraphQLAuthError.NO_CURRENT_USER);
                     case 7: return [3 /*break*/, 11];
                     case 8:
@@ -140,7 +142,9 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
         switch (operationType) {
             case 'query':
             case 'mutation':
-                var responsePromise = this._graphql({ query: query, variables: variables, authMode: authMode }, headers, customUserAgentDetails);
+                var abortController = new AbortController();
+                var responsePromise = this._graphql({ query: query, variables: variables, authMode: authMode }, headers, abortController, customUserAgentDetails);
+                this._api.updateRequestToBeCancellable(responsePromise, abortController);
                 return responsePromise;
             case 'subscription':
                 return this._graphqlSubscribe({ query: query, variables: variables, authMode: authMode }, headers, customUserAgentDetails);
@@ -148,48 +152,50 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                 throw new Error("invalid operation type: " + operationType);
         }
     };
-    InternalGraphQLAPIClass.prototype._graphql = function (_a, additionalHeaders, customUserAgentDetails) {
+    InternalGraphQLAPIClass.prototype._graphql = function (_a, additionalHeaders, abortController, customUserAgentDetails) {
         var query = _a.query, variables = _a.variables, authMode = _a.authMode;
         if (additionalHeaders === void 0) { additionalHeaders = {}; }
+        var _b;
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var config, _b, region, appSyncGraphqlEndpoint, customGraphqlEndpoint, customEndpointRegion, headers, _c, _d, _e, _f, _g, body, endpoint, error, response, responsePayload, err_1, errors;
-            var _h;
-            return tslib_1.__generator(this, function (_j) {
-                switch (_j.label) {
+            var config, _c, region, appSyncGraphqlEndpoint, customGraphqlEndpoint, customEndpointRegion, headers, _d, _e, _f, _g, _h, body, endpoint, error, response, responseBody, result, err_1, errors;
+            var _j;
+            return tslib_1.__generator(this, function (_k) {
+                switch (_k.label) {
                     case 0:
                         config = core_1.Amplify.getConfig();
-                        _b = config.API.GraphQL, region = _b.region, appSyncGraphqlEndpoint = _b.endpoint;
+                        _c = ((_b = config.API) === null || _b === void 0 ? void 0 : _b.GraphQL) || {}, region = _c.region, appSyncGraphqlEndpoint = _c.endpoint;
                         customGraphqlEndpoint = null;
                         customEndpointRegion = null;
-                        _c = [{}];
-                        _d = !customGraphqlEndpoint;
-                        if (!_d) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this._headerBasedAuth(authMode, additionalHeaders, customUserAgentDetails)];
+                        _d = [{}];
+                        _e = !customGraphqlEndpoint;
+                        if (!_e) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this._headerBasedAuth(authMode, additionalHeaders)];
                     case 1:
-                        _d = (_j.sent());
-                        _j.label = 2;
+                        _e = (_k.sent());
+                        _k.label = 2;
                     case 2:
-                        _e = [tslib_1.__assign.apply(void 0, _c.concat([(_d)]))];
-                        _f = customGraphqlEndpoint;
-                        if (!_f) return [3 /*break*/, 6];
+                        _f = [tslib_1.__assign.apply(void 0, _d.concat([(_e)]))];
+                        _g = customGraphqlEndpoint;
+                        if (!_g) return [3 /*break*/, 6];
                         if (!customEndpointRegion) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this._headerBasedAuth(authMode, additionalHeaders, customUserAgentDetails)];
+                        return [4 /*yield*/, this._headerBasedAuth(authMode, additionalHeaders)];
                     case 3:
-                        _g = _j.sent();
+                        _h = _k.sent();
                         return [3 /*break*/, 5];
                     case 4:
-                        _g = { Authorization: null };
-                        _j.label = 5;
+                        _h = { Authorization: null };
+                        _k.label = 5;
                     case 5:
-                        _f = (_g);
-                        _j.label = 6;
+                        _g = (_h);
+                        _k.label = 6;
                     case 6:
-                        headers = tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, _e.concat([(_f)])), additionalHeaders]), (!customGraphqlEndpoint && (_h = {},
-                                _h[USER_AGENT_HEADER] = utils_1.getAmplifyUserAgent(customUserAgentDetails),
-                                _h))]);
+                        headers = tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, _f.concat([((_g) ||
+                                        {})])), additionalHeaders]), (!customGraphqlEndpoint && (_j = {},
+                                _j[USER_AGENT_HEADER] = utils_1.getAmplifyUserAgent(customUserAgentDetails),
+                                _j))]);
                         body = {
                             query: graphql_1.print(query),
-                            variables: variables,
+                            variables: variables || null,
                         };
                         endpoint = customGraphqlEndpoint || appSyncGraphqlEndpoint;
                         if (!endpoint) {
@@ -199,9 +205,9 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                                 errors: [error],
                             };
                         }
-                        _j.label = 7;
+                        _k.label = 7;
                     case 7:
-                        _j.trys.push([7, 10, , 11]);
+                        _k.trys.push([7, 10, , 11]);
                         return [4 /*yield*/, this._api.post({
                                 url: new URL(endpoint),
                                 options: {
@@ -212,15 +218,23 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                                         region: region,
                                     },
                                 },
+                                abortController: abortController,
                             })];
                     case 8:
-                        responsePayload = (_j.sent()).body;
-                        return [4 /*yield*/, responsePayload.json()];
+                        responseBody = (_k.sent()).body;
+                        return [4 /*yield*/, responseBody.json()];
                     case 9:
-                        response = _j.sent();
+                        result = _k.sent();
+                        response = result;
                         return [3 /*break*/, 11];
                     case 10:
-                        err_1 = _j.sent();
+                        err_1 = _k.sent();
+                        // If the exception is because user intentionally
+                        // cancelled the request, do not modify the exception
+                        // so that clients can identify the exception correctly.
+                        if (api_rest_1.isCancelError(err_1)) {
+                            throw err_1;
+                        }
                         response = {
                             data: {},
                             errors: [new graphql_1.GraphQLError(err_1.message, null, null, null, null, err_1)],
@@ -236,8 +250,24 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Checks to see if an error thrown is from an api request cancellation
+     * @param {any} error - Any error
+     * @return {boolean} - A boolean indicating if the error was from an api request cancellation
+     */
+    InternalGraphQLAPIClass.prototype.isCancelError = function (error) {
+        return api_rest_1.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
+     */
+    InternalGraphQLAPIClass.prototype.cancel = function (request, message) {
+        return internals_1.cancel(request, message);
+    };
     InternalGraphQLAPIClass.prototype._graphqlSubscribe = function (_a, additionalHeaders, customUserAgentDetails) {
-        var query = _a.query, variables = _a.variables, defaultAuthenticationType = _a.authMode, authToken = _a.authToken;
+        var query = _a.query, variables = _a.variables, authMode = _a.authMode;
         if (additionalHeaders === void 0) { additionalHeaders = {}; }
         var _b;
         var GraphQL = ((_b = core_1.Amplify.getConfig().API) !== null && _b !== void 0 ? _b : {}).GraphQL;
@@ -249,9 +279,10 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
             variables: variables,
             appSyncGraphqlEndpoint: GraphQL === null || GraphQL === void 0 ? void 0 : GraphQL.endpoint,
             region: GraphQL === null || GraphQL === void 0 ? void 0 : GraphQL.region,
-            authenticationType: GraphQL === null || GraphQL === void 0 ? void 0 : GraphQL.defaultAuthMode,
+            authenticationType: authMode !== null && authMode !== void 0 ? authMode : GraphQL === null || GraphQL === void 0 ? void 0 : GraphQL.defaultAuthMode,
             apiKey: GraphQL === null || GraphQL === void 0 ? void 0 : GraphQL.apiKey,
-        });
+            additionalHeaders: additionalHeaders,
+        }, customUserAgentDetails);
     };
     return InternalGraphQLAPIClass;
 }());

package/lib/internals/index.d.ts

@@ -1,2 +1,2 @@
 export { InternalGraphQLAPI, InternalGraphQLAPIClass, } from './InternalGraphQLAPI';
-export { graphql } from './v6';
+export { graphql, cancel, isCancelError } from './v6';

package/lib/internals/index.js

@@ -7,3 +7,5 @@ exports.InternalGraphQLAPI = InternalGraphQLAPI_1.InternalGraphQLAPI;
 exports.InternalGraphQLAPIClass = InternalGraphQLAPI_1.InternalGraphQLAPIClass;
 var v6_1 = require("./v6");
 exports.graphql = v6_1.graphql;
+exports.cancel = v6_1.cancel;
+exports.isCancelError = v6_1.isCancelError;

package/lib/internals/v6.d.ts

@@ -86,4 +86,16 @@ import { GraphQLOptionsV6, GraphQLResponseV6 } from '../types';
 export declare function graphql<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: {
     [key: string]: string;
 }): GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
+/**
+ * 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
+ */
+export declare function cancel(promise: Promise<any>, message?: string): boolean;
+/**
+ * Checks to see if an error thrown is from an api request cancellation
+ * @param {any} error - Any error
+ * @returns - A boolean indicating if the error was from an api request cancellation
+ */
+export declare function isCancelError(error: any): boolean;
 export { GraphQLOptionsV6, GraphQLResponseV6 };

package/lib/internals/v6.js

@@ -97,3 +97,21 @@ function graphql(options, additionalHeaders) {
     return result;
 }
 exports.graphql = graphql;
+/**
+ * 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
+ */
+function cancel(promise, message) {
+    return GraphQLAPI_1.GraphQLAPI.cancel(promise, message);
+}
+exports.cancel = cancel;
+/**
+ * Checks to see if an error thrown is from an api request cancellation
+ * @param {any} error - Any error
+ * @returns - A boolean indicating if the error was from an api request cancellation
+ */
+function isCancelError(error) {
+    return GraphQLAPI_1.GraphQLAPI.isCancelError(error);
+}
+exports.isCancelError = isCancelError;