@aws-amplify/api-graphql 2.2.18 → 2.2.19-custom-pk.79

package/src/GraphQLAPI.ts

@@ -16,19 +16,25 @@ import {
 	print,
 	parse,
 	GraphQLError,
+	OperationTypeNode,
 } from 'graphql';
 import Observable from 'zen-observable-ts';
 import {
 	Amplify,
 	ConsoleLogger as Logger,
-	Constants,
 	Credentials,
+	getAmplifyUserAgent,
 	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
 } from '@aws-amplify/core';
 import PubSub from '@aws-amplify/pubsub';
 import Auth from '@aws-amplify/auth';
 import Cache from '@aws-amplify/cache';
-import { GraphQLAuthError, GraphQLOptions, GraphQLResult } from './types';
+import {
+	GraphQLAuthError,
+	GraphQLOptions,
+	GraphQLResult,
+	GraphQLOperation,
+} from './types';
 import { RestClient } from '@aws-amplify/api-rest';
 const USER_AGENT_HEADER = 'x-amz-user-agent';
 
@@ -37,11 +43,13 @@ const logger = new Logger('GraphQLAPI');
 export const graphqlOperation = (
 	query,
 	variables = {},
-	authToken?: string
+	authToken?: string,
+	userAgentSuffix?: string
 ) => ({
 	query,
 	variables,
 	authToken,
+	userAgentSuffix,
 });
 
 /**
@@ -124,10 +132,8 @@ export class GraphQLAPIClass {
 		defaultAuthenticationType?,
 		additionalHeaders: { [key: string]: string } = {}
 	) {
-		const {
-			aws_appsync_authenticationType,
-			aws_appsync_apiKey: apiKey,
-		} = this._options;
+		const { aws_appsync_authenticationType, aws_appsync_apiKey: apiKey } =
+			this._options;
 		const authenticationType =
 			defaultAuthenticationType || aws_appsync_authenticationType || 'AWS_IAM';
 		let headers = {};
@@ -203,11 +209,10 @@ export class GraphQLAPIClass {
 	 * to get the operation type
 	 * @param operation
 	 */
-	getGraphqlOperationType(operation) {
+	getGraphqlOperationType(operation: GraphQLOperation): OperationTypeNode {
 		const doc = parse(operation);
-		const definitions = doc.definitions as ReadonlyArray<
-			OperationDefinitionNode
-		>;
+		const definitions =
+			doc.definitions as ReadonlyArray<OperationDefinitionNode>;
 		const [{ operation: operationType }] = definitions;
 
 		return operationType;
@@ -216,14 +221,20 @@ export class GraphQLAPIClass {
 	/**
 	 * Executes a GraphQL operation
 	 *
-	 * @param {GraphQLOptions} GraphQL Options
-	 * @param {object} additionalHeaders headers to merge in after any `graphql_headers` set in the config
-	 * @returns {Promise<GraphQLResult> | Observable<object>}
+	 * @param options - GraphQL Options
+	 * @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(
-		{ query: paramQuery, variables = {}, authMode, authToken }: GraphQLOptions,
+	graphql<T = any>(
+		{
+			query: paramQuery,
+			variables = {},
+			authMode,
+			authToken,
+			userAgentSuffix,
+		}: GraphQLOptions,
 		additionalHeaders?: { [key: string]: string }
-	) {
+	): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>> {
 		const query =
 			typeof paramQuery === 'string'
 				? parse(paramQuery)
@@ -232,9 +243,8 @@ export class GraphQLAPIClass {
 		const [operationDef = {}] = query.definitions.filter(
 			def => def.kind === 'OperationDefinition'
 		);
-		const {
-			operation: operationType,
-		} = operationDef as OperationDefinitionNode;
+		const { operation: operationType } =
+			operationDef as OperationDefinitionNode;
 
 		const headers = additionalHeaders || {};
 
@@ -248,8 +258,8 @@ export class GraphQLAPIClass {
 			case 'mutation':
 				const cancellableToken = this._api.getCancellableToken();
 				const initParams = { cancellableToken };
-				const responsePromise = this._graphql(
-					{ query, variables, authMode },
+				const responsePromise = this._graphql<T>(
+					{ query, variables, authMode, userAgentSuffix },
 					headers,
 					initParams
 				);
@@ -260,16 +270,16 @@ export class GraphQLAPIClass {
 				return responsePromise;
 			case 'subscription':
 				return this._graphqlSubscribe({ query, variables, authMode }, headers);
+			default:
+				throw new Error(`invalid operation type: ${operationType}`);
 		}
-
-		throw new Error(`invalid operation type: ${operationType}`);
 	}
 
-	private async _graphql(
-		{ query, variables, authMode }: GraphQLOptions,
+	private async _graphql<T = any>(
+		{ query, variables, authMode, userAgentSuffix }: GraphQLOptions,
 		additionalHeaders = {},
 		initParams = {}
-	): Promise<GraphQLResult> {
+	): Promise<GraphQLResult<T>> {
 		if (!this._api) {
 			await this.createInstance();
 		}
@@ -292,7 +302,7 @@ export class GraphQLAPIClass {
 			...(await graphql_headers({ query, variables })),
 			...additionalHeaders,
 			...(!customGraphqlEndpoint && {
-				[USER_AGENT_HEADER]: Constants.userAgent,
+				[USER_AGENT_HEADER]: getAmplifyUserAgent(userAgentSuffix),
 			}),
 		};
 
@@ -367,6 +377,15 @@ export class GraphQLAPIClass {
 		return this._api.cancel(request, message);
 	}
 
+	/**
+	 * Check if the request has a corresponding cancel token in the WeakMap.
+	 * @params request - The request promise
+	 * @return if the request has a corresponding cancel token.
+	 */
+	hasCancelToken(request: Promise<any>) {
+		return this._api.hasCancelToken(request);
+	}
+
 	private _graphqlSubscribe(
 		{
 			query,

package/src/types/index.ts

@@ -10,23 +10,17 @@
  * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
  * and limitations under the License.
  */
-// @ts-ignore
-import { GraphQLError } from 'graphql/error/GraphQLError';
-import { DocumentNode } from 'graphql/language/ast';
+import { Source, DocumentNode, GraphQLError } from 'graphql';
+export { OperationTypeNode } from 'graphql';
+import { GRAPHQL_AUTH_MODE } from '@aws-amplify/auth';
+export { GRAPHQL_AUTH_MODE };
 
 export interface GraphQLOptions {
 	query: string | DocumentNode;
 	variables?: object;
 	authMode?: keyof typeof GRAPHQL_AUTH_MODE;
 	authToken?: string;
-}
-
-export enum GRAPHQL_AUTH_MODE {
-	API_KEY = 'API_KEY',
-	AWS_IAM = 'AWS_IAM',
-	OPENID_CONNECT = 'OPENID_CONNECT',
-	AMAZON_COGNITO_USER_POOLS = 'AMAZON_COGNITO_USER_POOLS',
-	AWS_LAMBDA = 'AWS_LAMBDA',
+	userAgentSuffix?: string;
 }
 
 export interface GraphQLResult<T = object> {
@@ -44,3 +38,9 @@ export enum GraphQLAuthError {
 	NO_FEDERATED_JWT = 'No federated jwt',
 	NO_AUTH_TOKEN = 'No auth token specified',
 }
+
+/**
+ * GraphQLSource or string, the type of the parameter for calling graphql.parse
+ * @see: https://graphql.org/graphql-js/language/#parse
+ */
+export type GraphQLOperation = Source | string;