@aws-amplify/api-graphql 4.0.1-console-preview.d745d43.0 → 4.0.1-ssr-api.df60e41.0

package/lib/index.js

@@ -2,7 +2,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
+const tslib_1 = require("tslib");
 var GraphQLAPI_1 = require("./GraphQLAPI");
 exports.GraphQLAPI = GraphQLAPI_1.GraphQLAPI;
 exports.GraphQLAPIClass = GraphQLAPI_1.GraphQLAPIClass;

package/lib/internals/InternalGraphQLAPI.d.ts

@@ -37,7 +37,7 @@ export declare class 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>(amplify: AmplifyClassV6, { query: paramQuery, variables, authMode, authToken }: GraphQLOptions, additionalHeaders?: {
+    graphql<T = any>(amplify: AmplifyClassV6 | ((fn: (amplify: any) => Promise<any>) => Promise<AmplifyClassV6>), { query: paramQuery, variables, authMode, authToken }: GraphQLOptions, additionalHeaders?: {
         [key: string]: string;
     }, customUserAgentDetails?: CustomUserAgentDetails): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>>;
     private _graphql;

package/lib/internals/InternalGraphQLAPI.js

@@ -1,35 +1,34 @@
 "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 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 utils_2 = require("../utils");
-var USER_AGENT_HEADER = 'x-amz-user-agent';
-var logger = new core_1.ConsoleLogger('GraphQLAPI');
-exports.graphqlOperation = function (query, variables, authToken) {
-    if (variables === void 0) { variables = {}; }
-    return ({
-        query: query,
-        variables: variables,
-        authToken: authToken,
-    });
+const graphql_1 = require("graphql");
+const core_1 = require("@aws-amplify/core");
+const utils_1 = require("@aws-amplify/core/internals/utils");
+const types_1 = require("../types");
+const api_rest_1 = require("@aws-amplify/api-rest");
+const internals_1 = require("@aws-amplify/api-rest/internals");
+const AWSAppSyncRealTimeProvider_1 = require("../Providers/AWSAppSyncRealTimeProvider");
+const utils_2 = require("../utils");
+const USER_AGENT_HEADER = 'x-amz-user-agent';
+const logger = new core_1.ConsoleLogger('GraphQLAPI');
+exports.graphqlOperation = (query, variables = {}, authToken) => ({
+    query,
+    variables,
+    authToken,
+});
+const isAmplifyInstance = (amplify) => {
+    return typeof amplify !== 'function';
 };
 /**
  * Export Cloud Logic APIs
  */
-var InternalGraphQLAPIClass = /** @class */ (function () {
+class InternalGraphQLAPIClass {
     /**
      * Initialize GraphQL API with AWS configuration
      * @param {Object} options - Configuration object for API
      */
-    function InternalGraphQLAPIClass(options) {
+    constructor(options) {
         this._api = {
             post: internals_1.post,
             cancelREST: internals_1.cancel,
@@ -39,88 +38,70 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
         this._options = options;
         logger.debug('API Options', this._options);
     }
-    InternalGraphQLAPIClass.prototype.getModuleName = function () {
+    getModuleName() {
         return 'InternalGraphQLAPI';
-    };
-    InternalGraphQLAPIClass.prototype._headerBasedAuth = function (amplify, authMode, additionalHeaders) {
-        if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        var _a;
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            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();
-                        _b = utils_2.resolveConfig(amplify), region = _b.region, appSyncGraphqlEndpoint = _b.endpoint, apiKey = _b.apiKey, defaultAuthMode = _b.defaultAuthMode;
-                        authenticationType = authMode || defaultAuthMode || 'iam';
-                        headers = {};
-                        _c = authenticationType;
-                        switch (_c) {
-                            case 'apiKey': return [3 /*break*/, 1];
-                            case 'iam': return [3 /*break*/, 2];
-                            case 'oidc': return [3 /*break*/, 4];
-                            case 'userPool': return [3 /*break*/, 4];
-                            case 'lambda': return [3 /*break*/, 8];
-                            case 'none': return [3 /*break*/, 9];
-                        }
-                        return [3 /*break*/, 10];
-                    case 1:
-                        if (!apiKey) {
-                            throw new Error(types_1.GraphQLAuthError.NO_API_KEY);
-                        }
-                        headers = {
-                            'X-Api-Key': apiKey,
-                        };
-                        return [3 /*break*/, 11];
-                    case 2: return [4 /*yield*/, amplify.Auth.fetchAuthSession()];
-                    case 3:
-                        session = _d.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]);
-                        token = void 0;
-                        return [4 /*yield*/, amplify.Auth.fetchAuthSession()];
-                    case 5:
-                        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);
-                        }
-                        headers = {
-                            Authorization: token,
-                        };
-                        return [3 /*break*/, 7];
-                    case 6:
-                        e_1 = _d.sent();
-                        throw new Error(types_1.GraphQLAuthError.NO_CURRENT_USER);
-                    case 7: return [3 /*break*/, 11];
-                    case 8:
-                        if (!additionalHeaders.Authorization) {
-                            throw new Error(types_1.GraphQLAuthError.NO_AUTH_TOKEN);
-                        }
-                        headers = {
-                            Authorization: additionalHeaders.Authorization,
-                        };
-                        return [3 /*break*/, 11];
-                    case 9: return [3 /*break*/, 11];
-                    case 10: return [3 /*break*/, 11];
-                    case 11: return [2 /*return*/, headers];
+    }
+    async _headerBasedAuth(amplify, authMode, additionalHeaders = {}) {
+        const config = amplify.getConfig();
+        const { region: region, endpoint: appSyncGraphqlEndpoint, apiKey, defaultAuthMode, } = utils_2.resolveConfig(amplify);
+        const authenticationType = authMode || defaultAuthMode || 'iam';
+        let headers = {};
+        switch (authenticationType) {
+            case 'apiKey':
+                if (!apiKey) {
+                    throw new Error(types_1.GraphQLAuthError.NO_API_KEY);
                 }
-            });
-        });
-    };
+                headers = {
+                    'X-Api-Key': apiKey,
+                };
+                break;
+            case 'iam':
+                const session = await amplify.Auth.fetchAuthSession();
+                if (session.credentials === undefined) {
+                    throw new Error(types_1.GraphQLAuthError.NO_CREDENTIALS);
+                }
+                break;
+            case 'oidc':
+            case 'userPool':
+                try {
+                    let token;
+                    token = (await amplify.Auth.fetchAuthSession()).tokens?.accessToken.toString();
+                    if (!token) {
+                        throw new Error(types_1.GraphQLAuthError.NO_FEDERATED_JWT);
+                    }
+                    headers = {
+                        Authorization: token,
+                    };
+                }
+                catch (e) {
+                    throw new Error(types_1.GraphQLAuthError.NO_CURRENT_USER);
+                }
+                break;
+            case 'lambda':
+                if (!additionalHeaders.Authorization) {
+                    throw new Error(types_1.GraphQLAuthError.NO_AUTH_TOKEN);
+                }
+                headers = {
+                    Authorization: additionalHeaders.Authorization,
+                };
+                break;
+            case 'none':
+                break;
+            default:
+                break;
+        }
+        return headers;
+    }
     /**
      * to get the operation type
      * @param operation
      */
-    InternalGraphQLAPIClass.prototype.getGraphqlOperationType = function (operation) {
-        var doc = graphql_1.parse(operation);
-        var definitions = doc.definitions;
-        var _a = tslib_1.__read(definitions, 1), operationType = _a[0].operation;
+    getGraphqlOperationType(operation) {
+        const doc = graphql_1.parse(operation);
+        const definitions = doc.definitions;
+        const [{ operation: operationType }] = definitions;
         return operationType;
-    };
+    }
     /**
      * Executes a GraphQL operation
      *
@@ -128,14 +109,13 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
      * @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.
      */
-    InternalGraphQLAPIClass.prototype.graphql = function (amplify, _a, additionalHeaders, customUserAgentDetails) {
-        var paramQuery = _a.query, _b = _a.variables, variables = _b === void 0 ? {} : _b, authMode = _a.authMode, authToken = _a.authToken;
-        var query = typeof paramQuery === 'string'
+    graphql(amplify, { query: paramQuery, variables = {}, authMode, authToken }, additionalHeaders, customUserAgentDetails) {
+        const query = typeof paramQuery === 'string'
             ? graphql_1.parse(paramQuery)
             : graphql_1.parse(graphql_1.print(paramQuery));
-        var _c = tslib_1.__read(query.definitions.filter(function (def) { return def.kind === 'OperationDefinition'; }), 1), _d = _c[0], operationDef = _d === void 0 ? {} : _d;
-        var operationType = operationDef.operation;
-        var headers = additionalHeaders || {};
+        const [operationDef = {}] = query.definitions.filter(def => def.kind === 'OperationDefinition');
+        const { operation: operationType } = operationDef;
+        const headers = additionalHeaders || {};
         // if an authorization header is set, have the explicit authToken take precedence
         if (authToken) {
             headers.Authorization = authToken;
@@ -143,174 +123,152 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
         switch (operationType) {
             case 'query':
             case 'mutation':
-                var abortController = new AbortController();
-                var responsePromise = this._graphql(amplify, { query: query, variables: variables, authMode: authMode }, headers, abortController, customUserAgentDetails);
+                const abortController = new AbortController();
+                let responsePromise;
+                if (isAmplifyInstance(amplify)) {
+                    responsePromise = this._graphql(amplify, { query, variables, authMode }, headers, abortController, customUserAgentDetails);
+                }
+                else {
+                    const wrapper = amplifyInstance => this._graphql(amplifyInstance, { query, variables, authMode }, headers, abortController, customUserAgentDetails);
+                    responsePromise = amplify(wrapper);
+                }
                 this._api.updateRequestToBeCancellable(responsePromise, abortController);
                 return responsePromise;
             case 'subscription':
-                return this._graphqlSubscribe(amplify, { query: query, variables: variables, authMode: authMode }, headers, customUserAgentDetails);
+                return this._graphqlSubscribe(amplify, { query, variables, authMode }, headers, customUserAgentDetails);
             default:
-                throw new Error("invalid operation type: " + operationType);
+                throw new Error(`invalid operation type: ${operationType}`);
         }
-    };
-    InternalGraphQLAPIClass.prototype._graphql = function (amplify, _a, additionalHeaders, abortController, customUserAgentDetails) {
-        var query = _a.query, variables = _a.variables, authMode = _a.authMode;
-        if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            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:
-                        _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 = !customEndpoint;
-                        if (!_e) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this._headerBasedAuth(amplify, authMode, additionalHeaders)];
-                    case 1:
-                        _e = (_m.sent());
-                        _m.label = 2;
-                    case 2:
-                        _f = [tslib_1.__assign.apply(void 0, _d.concat([(_e)]))];
-                        _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 = _m.sent();
-                        return [3 /*break*/, 5];
-                    case 4:
-                        _h = {};
-                        _m.label = 5;
-                    case 5:
-                        _g = (_h);
-                        _m.label = 6;
-                    case 6:
-                        _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,
-                        };
-                        /**
-                         * 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 {
-                                data: {},
-                                errors: [error],
-                            };
-                        }
-                        _m.label = 9;
-                    case 9:
-                        _m.trys.push([9, 12, , 13]);
-                        return [4 /*yield*/, this._api.post({
-                                url: new utils_1.AmplifyUrl(endpoint),
-                                options: {
-                                    headers: headers,
-                                    body: body,
-                                    signingServiceInfo: signingServiceInfo,
-                                    withCredentials: withCredentials,
-                                },
-                                abortController: abortController,
-                            })];
-                    case 10:
-                        responseBody = (_m.sent()).body;
-                        return [4 /*yield*/, responseBody.json()];
-                    case 11:
-                        result = _m.sent();
-                        response = result;
-                        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 (this.isCancelError(err_1)) {
-                            throw err_1;
-                        }
-                        response = {
-                            data: {},
-                            errors: [new graphql_1.GraphQLError(err_1.message, null, null, null, null, err_1)],
-                        };
-                        return [3 /*break*/, 13];
-                    case 13:
-                        errors = response.errors;
-                        if (errors && errors.length) {
-                            throw response;
-                        }
-                        return [2 /*return*/, response];
-                }
+    }
+    async _graphql(amplify, { query, variables, authMode }, additionalHeaders = {}, abortController, customUserAgentDetails) {
+        const { region: region, endpoint: appSyncGraphqlEndpoint, customEndpoint, customEndpointRegion, } = utils_2.resolveConfig(amplify);
+        // Retrieve library options from Amplify configuration
+        const { headers: customHeaders, withCredentials } = utils_2.resolveLibraryOptions(amplify);
+        // TODO: Figure what we need to do to remove `!`'s.
+        const headers = {
+            ...(!customEndpoint &&
+                (await this._headerBasedAuth(amplify, authMode, additionalHeaders))),
+            /**
+             * Custom endpoint headers.
+             * If there is both a custom endpoint and custom region present, we get the headers.
+             * If there is a custom endpoint but no region, we return an empty object.
+             * If neither are present, we return an empty object.
+             */
+            ...((customEndpoint &&
+                (customEndpointRegion
+                    ? await this._headerBasedAuth(amplify, authMode, additionalHeaders)
+                    : {})) ||
+                {}),
+            // Custom headers included in Amplify configuration options:
+            ...(customHeaders &&
+                (await customHeaders({
+                    query: graphql_1.print(query),
+                    variables,
+                }))),
+            // Headers from individual calls to `graphql`:
+            ...additionalHeaders,
+            // User agent headers:
+            ...(!customEndpoint && {
+                [USER_AGENT_HEADER]: utils_1.getAmplifyUserAgent(customUserAgentDetails),
+            }),
+        };
+        const body = {
+            query: graphql_1.print(query),
+            variables: variables || null,
+        };
+        let signingServiceInfo;
+        /**
+         * 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,
+            };
+        }
+        const endpoint = customEndpoint || appSyncGraphqlEndpoint;
+        if (!endpoint) {
+            const error = new graphql_1.GraphQLError('No graphql endpoint provided.');
+            throw {
+                data: {},
+                errors: [error],
+            };
+        }
+        let response;
+        try {
+            const { body: responseBody } = await this._api.post({
+                url: new utils_1.AmplifyUrl(endpoint),
+                options: {
+                    headers,
+                    body,
+                    signingServiceInfo,
+                    withCredentials,
+                },
+                abortController,
             });
-        });
-    };
+            const result = await responseBody.json();
+            response = result;
+        }
+        catch (err) {
+            // If the exception is because user intentionally
+            // cancelled the request, do not modify the exception
+            // so that clients can identify the exception correctly.
+            if (this.isCancelError(err)) {
+                throw err;
+            }
+            response = {
+                data: {},
+                errors: [new graphql_1.GraphQLError(err.message, null, null, null, null, err)],
+            };
+        }
+        const { errors } = response;
+        if (errors && errors.length) {
+            throw response;
+        }
+        return response;
+    }
     /**
      * 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) {
+    isCancelError(error) {
         return this._api.isCancelErrorREST(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) {
+    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 config = utils_2.resolveConfig(amplify);
+    }
+    _graphqlSubscribe(amplify, { query, variables, authMode }, additionalHeaders = {}, customUserAgentDetails) {
+        const 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: 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,
+            variables,
+            appSyncGraphqlEndpoint: config?.endpoint,
+            region: config?.region,
+            authenticationType: authMode ?? config?.defaultAuthMode,
+            apiKey: config?.apiKey,
+            additionalHeaders,
         }, customUserAgentDetails);
-    };
-    return InternalGraphQLAPIClass;
-}());
+    }
+}
 exports.InternalGraphQLAPIClass = InternalGraphQLAPIClass;
 exports.InternalGraphQLAPI = new InternalGraphQLAPIClass(null);

package/lib/internals/v6.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-var GraphQLAPI_1 = require("../GraphQLAPI");
-var types_1 = require("../types");
+const GraphQLAPI_1 = require("../GraphQLAPI");
+const types_1 = require("../types");
 /**
  * Invokes graphql operations against a graphql service, providing correct input and
  * output types if Amplify-generated graphql from a recent version of the CLI/codegen
@@ -94,7 +94,7 @@ function graphql(options, additionalHeaders) {
      * Neither of these can actually be validated at runtime. Hence, we don't perform
      * any validation or type-guarding here.
      */
-    var result = GraphQLAPI_1.GraphQLAPI.graphql(this[types_1.__amplify], options, additionalHeaders);
+    const result = GraphQLAPI_1.GraphQLAPI.graphql(this[types_1.__amplify], options, additionalHeaders);
     return result;
 }
 exports.graphql = graphql;