@aws-amplify/api-graphql 3.4.29 → 3.4.32

package/lib/types/index.d.ts

@@ -2,6 +2,11 @@ import { Source, DocumentNode, GraphQLError } from 'graphql';
 export { OperationTypeNode } from 'graphql';
 import { GRAPHQL_AUTH_MODE } from '@aws-amplify/auth';
 export { GRAPHQL_AUTH_MODE };
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface GraphQLOptions {
     query: string | DocumentNode;
     variables?: object;
@@ -12,6 +17,11 @@ export interface GraphQLOptions {
      */
     userAgentSuffix?: string;
 }
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface GraphQLResult<T = object> {
     data?: T;
     errors?: GraphQLError[];
@@ -19,6 +29,11 @@ export interface GraphQLResult<T = object> {
         [key: string]: any;
     };
 }
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export declare enum GraphQLAuthError {
     NO_API_KEY = "No api-key configured",
     NO_CURRENT_USER = "No current user",
@@ -29,5 +44,8 @@ export declare enum GraphQLAuthError {
 /**
  * GraphQLSource or string, the type of the parameter for calling graphql.parse
  * @see: https://graphql.org/graphql-js/language/#parse
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
  */
 export type GraphQLOperation = Source | string;

package/lib/types/index.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GraphQLAuthError = exports.GRAPHQL_AUTH_MODE = void 0;
 var auth_1 = require("@aws-amplify/auth");
 Object.defineProperty(exports, "GRAPHQL_AUTH_MODE", { enumerable: true, get: function () { return auth_1.GRAPHQL_AUTH_MODE; } });
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 var GraphQLAuthError;
 (function (GraphQLAuthError) {
     GraphQLAuthError["NO_API_KEY"] = "No api-key configured";
@@ -10,4 +15,4 @@ var GraphQLAuthError;
     GraphQLAuthError["NO_CREDENTIALS"] = "No credentials";
     GraphQLAuthError["NO_FEDERATED_JWT"] = "No federated jwt";
     GraphQLAuthError["NO_AUTH_TOKEN"] = "No auth token specified";
-})(GraphQLAuthError = exports.GraphQLAuthError || (exports.GraphQLAuthError = {}));
+})(GraphQLAuthError || (exports.GraphQLAuthError = GraphQLAuthError = {}));

package/lib-esm/GraphQLAPI.d.ts

@@ -1,6 +1,11 @@
 import { GraphQLOptions, GraphQLResult } from './types';
 import { InternalGraphQLAPIClass } from './internals';
 import Observable from 'zen-observable-ts';
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string) => {
     query: any;
     variables: {};
@@ -8,6 +13,9 @@ export declare const graphqlOperation: (query: any, variables?: {}, authToken?:
 };
 /**
  * Export Cloud Logic APIs
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
  */
 export declare class GraphQLAPIClass extends InternalGraphQLAPIClass {
     getModuleName(): string;
@@ -22,4 +30,9 @@ export declare class GraphQLAPIClass extends InternalGraphQLAPIClass {
         [key: string]: string;
     }): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>>;
 }
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export declare const GraphQLAPI: GraphQLAPIClass;

package/lib-esm/GraphQLAPI.js

@@ -3,6 +3,11 @@ import { __extends } from "tslib";
 // SPDX-License-Identifier: Apache-2.0
 import { Amplify } from '@aws-amplify/core';
 import { InternalGraphQLAPIClass } from './internals';
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export var graphqlOperation = function (query, variables, authToken) {
     if (variables === void 0) { variables = {}; }
     return ({
@@ -13,6 +18,9 @@ export var graphqlOperation = function (query, variables, authToken) {
 };
 /**
  * Export Cloud Logic APIs
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
  */
 var GraphQLAPIClass = /** @class */ (function (_super) {
     __extends(GraphQLAPIClass, _super);
@@ -35,5 +43,10 @@ var GraphQLAPIClass = /** @class */ (function (_super) {
     return GraphQLAPIClass;
 }(InternalGraphQLAPIClass));
 export { GraphQLAPIClass };
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export var GraphQLAPI = new GraphQLAPIClass(null);
 Amplify.register(GraphQLAPI);

package/lib-esm/internals/InternalGraphQLAPI.js

@@ -77,10 +77,10 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
             return Promise.reject('API not configured');
         }
     };
-    InternalGraphQLAPIClass.prototype._headerBasedAuth = function (defaultAuthenticationType, additionalHeaders) {
-        if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        return __awaiter(this, void 0, void 0, function () {
+    InternalGraphQLAPIClass.prototype._headerBasedAuth = function (defaultAuthenticationType_1) {
+        return __awaiter(this, arguments, void 0, function (defaultAuthenticationType, additionalHeaders) {
             var _a, aws_appsync_authenticationType, apiKey, authenticationType, headers, _b, credentialsOK, token, federatedInfo, currentUser, e_1, session, e_2;
+            if (additionalHeaders === void 0) { additionalHeaders = {}; }
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -218,47 +218,47 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                 throw new Error("invalid operation type: ".concat(operationType));
         }
     };
-    InternalGraphQLAPIClass.prototype._graphql = function (_a, additionalHeaders, initParams, customUserAgentDetails) {
-        var query = _a.query, variables = _a.variables, authMode = _a.authMode;
-        if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        if (initParams === void 0) { initParams = {}; }
-        return __awaiter(this, void 0, void 0, function () {
-            var _b, region, appSyncGraphqlEndpoint, _c, graphql_headers, customGraphqlEndpoint, customEndpointRegion, headers, _d, _e, _f, _g, _h, _j, body, init, endpoint, error, response, err_1, errors;
-            var _k;
-            return __generator(this, function (_l) {
-                switch (_l.label) {
+    InternalGraphQLAPIClass.prototype._graphql = function (_a) {
+        return __awaiter(this, arguments, void 0, function (_b, additionalHeaders, initParams, customUserAgentDetails) {
+            var _c, region, appSyncGraphqlEndpoint, _d, graphql_headers, customGraphqlEndpoint, customEndpointRegion, headers, _e, _f, _g, _h, _j, _k, body, init, endpoint, error, response, err_1, errors;
+            var _l;
+            var query = _b.query, variables = _b.variables, authMode = _b.authMode;
+            if (additionalHeaders === void 0) { additionalHeaders = {}; }
+            if (initParams === void 0) { initParams = {}; }
+            return __generator(this, function (_m) {
+                switch (_m.label) {
                     case 0:
                         this.createInstanceIfNotCreated();
-                        _b = this._options, region = _b.aws_appsync_region, appSyncGraphqlEndpoint = _b.aws_appsync_graphqlEndpoint, _c = _b.graphql_headers, graphql_headers = _c === void 0 ? function () { return ({}); } : _c, customGraphqlEndpoint = _b.graphql_endpoint, customEndpointRegion = _b.graphql_endpoint_iam_region;
-                        _d = [{}];
-                        _e = !customGraphqlEndpoint;
-                        if (!_e) return [3 /*break*/, 2];
+                        _c = this._options, region = _c.aws_appsync_region, appSyncGraphqlEndpoint = _c.aws_appsync_graphqlEndpoint, _d = _c.graphql_headers, graphql_headers = _d === void 0 ? function () { return ({}); } : _d, customGraphqlEndpoint = _c.graphql_endpoint, customEndpointRegion = _c.graphql_endpoint_iam_region;
+                        _e = [{}];
+                        _f = !customGraphqlEndpoint;
+                        if (!_f) return [3 /*break*/, 2];
                         return [4 /*yield*/, this._headerBasedAuth(authMode, additionalHeaders)];
                     case 1:
-                        _e = (_l.sent());
-                        _l.label = 2;
+                        _f = (_m.sent());
+                        _m.label = 2;
                     case 2:
-                        _f = [__assign.apply(void 0, _d.concat([(_e)]))];
-                        _g = customGraphqlEndpoint;
-                        if (!_g) return [3 /*break*/, 6];
+                        _g = [__assign.apply(void 0, _e.concat([(_f)]))];
+                        _h = customGraphqlEndpoint;
+                        if (!_h) return [3 /*break*/, 6];
                         if (!customEndpointRegion) return [3 /*break*/, 4];
                         return [4 /*yield*/, this._headerBasedAuth(authMode, additionalHeaders)];
                     case 3:
-                        _h = _l.sent();
+                        _j = _m.sent();
                         return [3 /*break*/, 5];
                     case 4:
-                        _h = { Authorization: null };
-                        _l.label = 5;
+                        _j = { Authorization: null };
+                        _m.label = 5;
                     case 5:
-                        _g = (_h);
-                        _l.label = 6;
+                        _h = (_j);
+                        _m.label = 6;
                     case 6:
-                        _j = [__assign.apply(void 0, _f.concat([(_g)]))];
+                        _k = [__assign.apply(void 0, _g.concat([(_h)]))];
                         return [4 /*yield*/, graphql_headers({ query: query, variables: variables })];
                     case 7:
-                        headers = __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _j.concat([(_l.sent())])), additionalHeaders]), (!customGraphqlEndpoint && (_k = {},
-                                _k[USER_AGENT_HEADER] = getAmplifyUserAgent(customUserAgentDetails),
-                                _k))]);
+                        headers = __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _k.concat([(_m.sent())])), additionalHeaders]), (!customGraphqlEndpoint && (_l = {},
+                                _l[USER_AGENT_HEADER] = getAmplifyUserAgent(customUserAgentDetails),
+                                _l))]);
                         body = {
                             query: print(query),
                             variables: variables,
@@ -279,15 +279,15 @@ var InternalGraphQLAPIClass = /** @class */ (function () {
                                 errors: [error],
                             };
                         }
-                        _l.label = 8;
+                        _m.label = 8;
                     case 8:
-                        _l.trys.push([8, 10, , 11]);
+                        _m.trys.push([8, 10, , 11]);
                         return [4 /*yield*/, this._api.post(endpoint, init)];
                     case 9:
-                        response = _l.sent();
+                        response = _m.sent();
                         return [3 /*break*/, 11];
                     case 10:
-                        err_1 = _l.sent();
+                        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.