@aws-amplify/api-graphql 3.4.31 → 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";

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);