@aws-amplify/api 4.0.33-unstable.7 → 4.0.33

package/lib-esm/types/index.d.ts

@@ -4,3 +4,10 @@
  * This will be removed in future release when CLI and customers moves to recommeneded import styles.
  */
 export { graphqlOperation, GraphQLAuthError, GraphQLResult, GRAPHQL_AUTH_MODE, } from '@aws-amplify/api-graphql';
+declare const queryType: unique symbol;
+export declare type GraphQLQuery<T> = T & {
+    readonly [queryType]: 'query';
+};
+export declare type GraphQLSubscription<T> = T & {
+    readonly [queryType]: 'subscription';
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/api",
-	"version": "4.0.33-unstable.7+a48ddbc3d",
+	"version": "4.0.33",
 	"description": "Api category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -51,8 +51,8 @@
 		"@types/zen-observable": "^0.8.0"
 	},
 	"dependencies": {
-		"@aws-amplify/api-graphql": "2.2.22-unstable.7+a48ddbc3d",
-		"@aws-amplify/api-rest": "2.0.33-unstable.7+a48ddbc3d"
+		"@aws-amplify/api-graphql": "2.2.22",
+		"@aws-amplify/api-rest": "2.0.33"
 	},
 	"jest": {
 		"globals": {
@@ -98,5 +98,5 @@
 			"lib-esm"
 		]
 	},
-	"gitHead": "a48ddbc3de1ce65536fe9467adb3c7dff5181680"
+	"gitHead": "163d74a08dfb6bb2c183f9af2bc32b56203ef67a"
 }

package/src/API.ts

@@ -12,11 +12,14 @@
  */
 import { Auth } from '@aws-amplify/auth';
 import Cache from '@aws-amplify/cache';
+import { AWSAppSyncRealTimeProvider } from '@aws-amplify/pubsub';
 import { RestAPIClass } from '@aws-amplify/api-rest';
 import {
 	GraphQLAPIClass,
 	GraphQLOptions,
 	GraphQLResult,
+	GraphQLOperation,
+	OperationTypeNode,
 } from '@aws-amplify/api-graphql';
 import {
 	Amplify,
@@ -24,6 +27,7 @@ import {
 	Credentials,
 } from '@aws-amplify/core';
 import Observable from 'zen-observable-ts';
+import { GraphQLQuery, GraphQLSubscription } from './types';
 
 const logger = new Logger('API');
 /**
@@ -38,7 +42,7 @@ export class APIClass {
 	 */
 	private _options;
 	private _restApi: RestAPIClass;
-	private _graphqlApi;
+	private _graphqlApi: GraphQLAPIClass;
 
 	Auth = Auth;
 	Cache = Cache;
@@ -82,93 +86,118 @@ export class APIClass {
 
 	/**
 	 * Make a GET request
-	 * @param {string} apiName - The api name of the request
-	 * @param {string} path - The path of the request
-	 * @param {json} [init] - Request extra params
-	 * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+	 * @param apiName - The api name of the request
+	 * @param path - The path of the request
+	 * @param [init] - Request extra params
+	 * @return A promise that resolves to an object with response status and JSON data, if successful.
 	 */
-	get(apiName, path, init): Promise<any> {
+	get(
+		apiName: string,
+		path: string,
+		init: { [key: string]: any }
+	): Promise<any> {
 		return this._restApi.get(apiName, path, init);
 	}
 
 	/**
 	 * Make a POST request
-	 * @param {string} apiName - The api name of the request
-	 * @param {string} path - The path of the request
-	 * @param {json} [init] - Request extra params
-	 * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+	 * @param apiName - The api name of the request
+	 * @param path - The path of the request
+	 * @param [init] - Request extra params
+	 * @return A promise that resolves to an object with response status and JSON data, if successful.
 	 */
-	post(apiName, path, init): Promise<any> {
+	post(
+		apiName: string,
+		path: string,
+		init: { [key: string]: any }
+	): Promise<any> {
 		return this._restApi.post(apiName, path, init);
 	}
 
 	/**
 	 * Make a PUT request
-	 * @param {string} apiName - The api name of the request
-	 * @param {string} path - The path of the request
-	 * @param {json} [init] - Request extra params
-	 * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+	 * @param apiName - The api name of the request
+	 * @param path - The path of the request
+	 * @param [init] - Request extra params
+	 * @return A promise that resolves to an object with response status and JSON data, if successful.
 	 */
-	put(apiName, path, init): Promise<any> {
+	put(
+		apiName: string,
+		path: string,
+		init: { [key: string]: any }
+	): Promise<any> {
 		return this._restApi.put(apiName, path, init);
 	}
 
 	/**
 	 * Make a PATCH request
-	 * @param {string} apiName - The api name of the request
-	 * @param {string} path - The path of the request
-	 * @param {json} [init] - Request extra params
-	 * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+	 * @param apiName - The api name of the request
+	 * @param path - The path of the request
+	 * @param [init] - Request extra params
+	 * @return A promise that resolves to an object with response status and JSON data, if successful.
 	 */
-	patch(apiName, path, init): Promise<any> {
+	patch(
+		apiName: string,
+		path: string,
+		init: { [key: string]: any }
+	): Promise<any> {
 		return this._restApi.patch(apiName, path, init);
 	}
 
 	/**
 	 * Make a DEL request
-	 * @param {string} apiName - The api name of the request
-	 * @param {string} path - The path of the request
-	 * @param {json} [init] - Request extra params
-	 * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+	 * @param apiName - The api name of the request
+	 * @param path - The path of the request
+	 * @param [init] - Request extra params
+	 * @return A promise that resolves to an object with response status and JSON data, if successful.
 	 */
-	del(apiName, path, init): Promise<any> {
+	del(
+		apiName: string,
+		path: string,
+		init: { [key: string]: any }
+	): Promise<any> {
 		return this._restApi.del(apiName, path, init);
 	}
 
 	/**
 	 * Make a HEAD request
-	 * @param {string} apiName - The api name of the request
-	 * @param {string} path - The path of the request
-	 * @param {json} [init] - Request extra params
-	 * @return {Promise} - A promise that resolves to an object with response status and JSON data, if successful.
+	 * @param apiName - The api name of the request
+	 * @param path - The path of the request
+	 * @param [init] - Request extra params
+	 * @return A promise that resolves to an object with response status and JSON data, if successful.
 	 */
-	head(apiName, path, init): Promise<any> {
+	head(
+		apiName: string,
+		path: string,
+		init: { [key: string]: any }
+	): Promise<any> {
 		return this._restApi.head(apiName, path, init);
 	}
 
 	/**
 	 * 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
+	 * @param error - Any error
+	 * @return If the error was from an api request cancellation
 	 */
-	isCancel(error) {
+	isCancel(error: any): boolean {
 		return this._restApi.isCancel(error);
 	}
 	/**
 	 * Cancels an inflight request
-	 * @param {any} request - request to cancel
-	 * @return {boolean} - A boolean indicating if the request was cancelled
+	 * @param request - request to cancel
+	 * @param [message] - custom error message
+	 * @return If the request was cancelled
 	 */
-	cancel(request: Promise<any>, message?: string) {
+	cancel(request: Promise<any>, message?: string): boolean {
 		return this._restApi.cancel(request, message);
 	}
 
 	/**
 	 * Getting endpoint for API
-	 * @param {string} apiName - The name of the api
-	 * @return {string} - The endpoint of the api
+	 * @param apiName - The name of the api
+	 * @return The endpoint of the api
 	 */
-	async endpoint(apiName) {
+	async endpoint(apiName: string): Promise<string> {
 		return this._restApi.endpoint(apiName);
 	}
 
@@ -176,21 +205,32 @@ export class APIClass {
 	 * to get the operation type
 	 * @param operation
 	 */
-	getGraphqlOperationType(operation) {
+	getGraphqlOperationType(operation: GraphQLOperation): OperationTypeNode {
 		return this._graphqlApi.getGraphqlOperationType(operation);
 	}
 
 	/**
 	 * 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 queryType is 'subscription', else a promise of the graphql result from the query.
 	 */
-	graphql(
+	graphql<T>(
 		options: GraphQLOptions,
 		additionalHeaders?: { [key: string]: string }
-	): Promise<GraphQLResult> | Observable<object> {
+	): T extends GraphQLQuery<T>
+		? Promise<GraphQLResult<T>>
+		: T extends GraphQLSubscription<T>
+		? Observable<{
+				provider: AWSAppSyncRealTimeProvider;
+				value: GraphQLResult<T>;
+		  }>
+		: Promise<GraphQLResult<any>> | Observable<object>;
+	graphql<T = any>(
+		options: GraphQLOptions,
+		additionalHeaders?: { [key: string]: string }
+	): Promise<GraphQLResult<any>> | Observable<object> {
 		return this._graphqlApi.graphql(options, additionalHeaders);
 	}
 }

package/src/index.ts

@@ -13,6 +13,7 @@
 
 import { API } from './API';
 
+export { GraphQLQuery, GraphQLSubscription } from './types';
 export { API, APIClass } from './API';
 export {
 	graphqlOperation,
@@ -21,6 +22,7 @@ export {
 } from '@aws-amplify/api-graphql';
 
 export type { GraphQLResult } from '@aws-amplify/api-graphql';
+
 /*
  * @deprecated use named import
  */

package/src/types/index.ts

@@ -22,3 +22,11 @@ export {
 	GraphQLResult,
 	GRAPHQL_AUTH_MODE,
 } from '@aws-amplify/api-graphql';
+
+// Opaque type used for determining the graphql query type
+declare const queryType: unique symbol;
+
+export type GraphQLQuery<T> = T & { readonly [queryType]: 'query' };
+export type GraphQLSubscription<T> = T & {
+	readonly [queryType]: 'subscription';
+};