@aws-amplify/api-graphql 4.0.1-console-preview.5f040a2.0 → 4.0.1-console-preview.23dc225.0

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

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import { APIAuthMode, CustomUserAgentDetails, DocumentType } from '@aws-amplify/core/internals/utils';
+import { GraphQLAuthMode, CustomUserAgentDetails, DocumentType } from '@aws-amplify/core/internals/utils';
 import { PubSubContentObserver } from '../../types/PubSub';
 import { SUBSCRIPTION_STATUS } from '../constants';
 export declare type ObserverQuery = {
@@ -13,7 +13,7 @@ export declare type ObserverQuery = {
 };
 export interface AWSAppSyncRealTimeProviderOptions {
     appSyncGraphqlEndpoint?: string;
-    authenticationType?: APIAuthMode;
+    authenticationType?: GraphQLAuthMode;
     query?: string;
     variables?: Record<string, DocumentType>;
     apiKey?: string;

package/lib/Providers/AWSAppSyncRealTimeProvider/index.js

@@ -6,7 +6,6 @@ var tslib_1 = require("tslib");
 var rxjs_1 = require("rxjs");
 var graphql_1 = require("graphql");
 var url = tslib_1.__importStar(require("url"));
-var uuid_1 = require("uuid");
 var buffer_1 = require("buffer");
 var core_1 = require("@aws-amplify/core");
 var aws_client_utils_1 = require("@aws-amplify/core/internals/aws-client-utils");
@@ -97,7 +96,7 @@ var AWSAppSyncRealTimeProvider = /** @class */ (function () {
             }
             else {
                 var subscriptionStartActive_1 = false;
-                var subscriptionId_1 = uuid_1.v4();
+                var subscriptionId_1 = utils_1.amplifyUuid();
                 var startSubscription_1 = function () {
                     if (!subscriptionStartActive_1) {
                         subscriptionStartActive_1 = true;
@@ -778,7 +777,7 @@ var AWSAppSyncRealTimeProvider = /** @class */ (function () {
                         signed_params = aws_client_utils_1.signRequest({
                             headers: request.headers,
                             method: request.method,
-                            url: new URL(request.url),
+                            url: new utils_1.AmplifyUrl(request.url),
                             body: request.data,
                         }, {
                             // TODO: What do we need to do to remove these !'s?

package/lib/internals/InternalGraphQLAPI.js

@@ -9,6 +9,7 @@ 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 utils_2 = require("../utils");
 var USER_AGENT_HEADER = 'x-amz-user-agent';
 var logger = new utils_1.ConsoleLogger('GraphQLAPI');
 exports.graphqlOperation = function (query, variables, authToken) {
@@ -28,7 +29,12 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
      * @param {Object} options - Configuration object for API
      */
     function InternalGraphQLAPIClass(options) {
-        this._api = { post: internals_1.post, updateRequestToBeCancellable: internals_1.updateRequestToBeCancellable };
+        this._api = {
+            post: internals_1.post,
+            cancelREST: internals_1.cancel,
+            isCancelErrorREST: api_rest_1.isCancelError,
+            updateRequestToBeCancellable: internals_1.updateRequestToBeCancellable,
+        };
         this._options = options;
         logger.debug('API Options', this._options);
     }
@@ -37,18 +43,18 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
     };
     InternalGraphQLAPIClass.prototype._headerBasedAuth = function (amplify, authMode, additionalHeaders) {
         if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        var _a, _b;
+        var _a;
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var config, _c, region, appSyncGraphqlEndpoint, apiKey, defaultAuthMode, authenticationType, headers, _d, session, token, e_1;
-            return tslib_1.__generator(this, function (_e) {
-                switch (_e.label) {
+            var config, _b, region, appSyncGraphqlEndpoint, apiKey, defaultAuthMode, authenticationType, headers, _c, session, token, e_1;
+            return tslib_1.__generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         config = amplify.getConfig();
-                        _c = ((_a = config.API) === null || _a === void 0 ? void 0 : _a.GraphQL) || {}, region = _c.region, appSyncGraphqlEndpoint = _c.endpoint, apiKey = _c.apiKey, defaultAuthMode = _c.defaultAuthMode;
+                        _b = utils_2.resolveConfig(amplify), region = _b.region, appSyncGraphqlEndpoint = _b.endpoint, apiKey = _b.apiKey, defaultAuthMode = _b.defaultAuthMode;
                         authenticationType = authMode || defaultAuthMode || 'iam';
                         headers = {};
-                        _d = authenticationType;
-                        switch (_d) {
+                        _c = authenticationType;
+                        switch (_c) {
                             case 'apiKey': return [3 /*break*/, 1];
                             case 'iam': return [3 /*break*/, 2];
                             case 'oidc': return [3 /*break*/, 4];
@@ -67,17 +73,17 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                         return [3 /*break*/, 11];
                     case 2: return [4 /*yield*/, amplify.Auth.fetchAuthSession()];
                     case 3:
-                        session = _e.sent();
+                        session = _d.sent();
                         if (session.credentials === undefined) {
                             throw new Error(types_1.GraphQLAuthError.NO_CREDENTIALS);
                         }
                         return [3 /*break*/, 11];
                     case 4:
-                        _e.trys.push([4, 6, , 7]);
+                        _d.trys.push([4, 6, , 7]);
                         token = void 0;
                         return [4 /*yield*/, amplify.Auth.fetchAuthSession()];
                     case 5:
-                        token = (_b = (_e.sent()).tokens) === null || _b === void 0 ? void 0 : _b.accessToken.toString();
+                        token = (_a = (_d.sent()).tokens) === null || _a === void 0 ? void 0 : _a.accessToken.toString();
                         if (!token) {
                             throw new Error(types_1.GraphQLAuthError.NO_FEDERATED_JWT);
                         }
@@ -86,7 +92,7 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                         };
                         return [3 /*break*/, 7];
                     case 6:
-                        e_1 = _e.sent();
+                        e_1 = _d.sent();
                         throw new Error(types_1.GraphQLAuthError.NO_CURRENT_USER);
                     case 7: return [3 /*break*/, 11];
                     case 8:
@@ -98,11 +104,7 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                         };
                         return [3 /*break*/, 11];
                     case 9: return [3 /*break*/, 11];
-                    case 10:
-                        headers = {
-                            Authorization: null,
-                        };
-                        return [3 /*break*/, 11];
+                    case 10: return [3 /*break*/, 11];
                     case 11: return [2 /*return*/, headers];
                 }
             });
@@ -153,49 +155,77 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
     InternalGraphQLAPIClass.prototype._graphql = function (amplify, _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, _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) {
+            var _b, region, appSyncGraphqlEndpoint, customEndpoint, customEndpointRegion, _c, customHeaders, withCredentials, headers, _d, _e, _f, _g, _h, _j, _k, body, signingServiceInfo, endpoint, error, response, responseBody, result, err_1, errors;
+            var _l;
+            return tslib_1.__generator(this, function (_m) {
+                switch (_m.label) {
                     case 0:
-                        config = amplify.getConfig();
-                        _c = ((_b = config.API) === null || _b === void 0 ? void 0 : _b.GraphQL) || {}, region = _c.region, appSyncGraphqlEndpoint = _c.endpoint;
-                        customGraphqlEndpoint = null;
-                        customEndpointRegion = null;
+                        _b = utils_2.resolveConfig(amplify), region = _b.region, appSyncGraphqlEndpoint = _b.endpoint, customEndpoint = _b.customEndpoint, customEndpointRegion = _b.customEndpointRegion;
+                        _c = utils_2.resolveLibraryOptions(amplify), customHeaders = _c.headers, withCredentials = _c.withCredentials;
                         _d = [{}];
-                        _e = !customGraphqlEndpoint;
+                        _e = !customEndpoint;
                         if (!_e) return [3 /*break*/, 2];
                         return [4 /*yield*/, this._headerBasedAuth(amplify, authMode, additionalHeaders)];
                     case 1:
-                        _e = (_k.sent());
-                        _k.label = 2;
+                        _e = (_m.sent());
+                        _m.label = 2;
                     case 2:
                         _f = [tslib_1.__assign.apply(void 0, _d.concat([(_e)]))];
-                        _g = customGraphqlEndpoint;
+                        _g = customEndpoint;
                         if (!_g) return [3 /*break*/, 6];
                         if (!customEndpointRegion) return [3 /*break*/, 4];
                         return [4 /*yield*/, this._headerBasedAuth(amplify, authMode, additionalHeaders)];
                     case 3:
-                        _h = _k.sent();
+                        _h = _m.sent();
                         return [3 /*break*/, 5];
                     case 4:
-                        _h = { Authorization: null };
-                        _k.label = 5;
+                        _h = {};
+                        _m.label = 5;
                     case 5:
                         _g = (_h);
-                        _k.label = 6;
+                        _m.label = 6;
                     case 6:
-                        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))]);
+                        _j = [tslib_1.__assign.apply(void 0, _f.concat([((_g) ||
+                                    {})]))];
+                        _k = customHeaders;
+                        if (!_k) return [3 /*break*/, 8];
+                        return [4 /*yield*/, customHeaders({
+                                query: graphql_1.print(query),
+                                variables: variables,
+                            })];
+                    case 7:
+                        _k = (_m.sent());
+                        _m.label = 8;
+                    case 8:
+                        headers = tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, _j.concat([(_k)])), additionalHeaders]), (!customEndpoint && (_l = {},
+                                _l[USER_AGENT_HEADER] = utils_1.getAmplifyUserAgent(customUserAgentDetails),
+                                _l))]);
                         body = {
                             query: graphql_1.print(query),
                             variables: variables || null,
                         };
-                        endpoint = customGraphqlEndpoint || appSyncGraphqlEndpoint;
+                        /**
+                         * We do not send the signing service info to the REST API under the
+                         * following conditions (i.e. it will not sign the request):
+                         *   - there is a custom endpoint but no region
+                         *   - the auth mode is `none`, or `apiKey`
+                         *   - the auth mode is a type other than the types listed below
+                         */
+                        if ((customEndpoint && !customEndpointRegion) ||
+                            (authMode !== 'oidc' &&
+                                authMode !== 'userPool' &&
+                                authMode !== 'iam' &&
+                                authMode !== 'lambda')) {
+                            signingServiceInfo = null;
+                        }
+                        else {
+                            signingServiceInfo = {
+                                service: !customEndpointRegion ? 'appsync' : 'execute-api',
+                                region: !customEndpointRegion ? region : customEndpointRegion,
+                            };
+                        }
+                        endpoint = customEndpoint || appSyncGraphqlEndpoint;
                         if (!endpoint) {
                             error = new graphql_1.GraphQLError('No graphql endpoint provided.');
                             throw {
@@ -203,42 +233,40 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                                 errors: [error],
                             };
                         }
-                        _k.label = 7;
-                    case 7:
-                        _k.trys.push([7, 10, , 11]);
+                        _m.label = 9;
+                    case 9:
+                        _m.trys.push([9, 12, , 13]);
                         return [4 /*yield*/, this._api.post({
-                                url: new URL(endpoint),
+                                url: new utils_1.AmplifyUrl(endpoint),
                                 options: {
                                     headers: headers,
                                     body: body,
-                                    signingServiceInfo: {
-                                        service: 'appsync',
-                                        region: region,
-                                    },
+                                    signingServiceInfo: signingServiceInfo,
+                                    withCredentials: withCredentials,
                                 },
                                 abortController: abortController,
                             })];
-                    case 8:
-                        responseBody = (_k.sent()).body;
+                    case 10:
+                        responseBody = (_m.sent()).body;
                         return [4 /*yield*/, responseBody.json()];
-                    case 9:
-                        result = _k.sent();
+                    case 11:
+                        result = _m.sent();
                         response = result;
-                        return [3 /*break*/, 11];
-                    case 10:
-                        err_1 = _k.sent();
+                        return [3 /*break*/, 13];
+                    case 12:
+                        err_1 = _m.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)) {
+                        if (this._api.isCancelErrorREST(err_1)) {
                             throw err_1;
                         }
                         response = {
                             data: {},
                             errors: [new graphql_1.GraphQLError(err_1.message, null, null, null, null, err_1)],
                         };
-                        return [3 /*break*/, 11];
-                    case 11:
+                        return [3 /*break*/, 13];
+                    case 13:
                         errors = response.errors;
                         if (errors && errors.length) {
                             throw response;
@@ -254,7 +282,7 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
      * @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);
+        return this._api.isCancelErrorREST(error);
     };
     /**
      * Cancels an inflight request. Only applicable for graphql queries and mutations
@@ -262,23 +290,22 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
      * @returns - A boolean indicating if the request was cancelled
      */
     InternalGraphQLAPIClass.prototype.cancel = function (request, message) {
-        return internals_1.cancel(request, message);
+        return this._api.cancelREST(request, message);
     };
     InternalGraphQLAPIClass.prototype._graphqlSubscribe = function (amplify, _a, additionalHeaders, customUserAgentDetails) {
         var query = _a.query, variables = _a.variables, authMode = _a.authMode;
         if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        var _b;
-        var GraphQL = ((_b = amplify.getConfig().API) !== null && _b !== void 0 ? _b : {}).GraphQL;
+        var config = utils_2.resolveConfig(amplify);
         if (!this.appSyncRealTime) {
             this.appSyncRealTime = new AWSAppSyncRealTimeProvider_1.AWSAppSyncRealTimeProvider();
         }
         return this.appSyncRealTime.subscribe({
             query: graphql_1.print(query),
             variables: variables,
-            appSyncGraphqlEndpoint: GraphQL === null || GraphQL === void 0 ? void 0 : GraphQL.endpoint,
-            region: GraphQL === null || GraphQL === void 0 ? void 0 : GraphQL.region,
-            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,
+            appSyncGraphqlEndpoint: config === null || config === void 0 ? void 0 : config.endpoint,
+            region: config === null || config === void 0 ? void 0 : config.region,
+            authenticationType: config === null || config === void 0 ? void 0 : config.defaultAuthMode,
+            apiKey: config === null || config === void 0 ? void 0 : config.apiKey,
             additionalHeaders: additionalHeaders,
         }, customUserAgentDetails);
     };