@aws-amplify/api 5.4.6-unstable.7762f1a.0 → 6.0.0

package/src/internals/InternalAPI.ts

@@ -1,28 +1,33 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import {
+	AWSAppSyncRealTimeProvider,
 	GraphQLOperation,
 	GraphQLOptions,
 	GraphQLResult,
 	OperationTypeNode,
+	GraphQLQuery,
+	GraphQLSubscription,
 } from '@aws-amplify/api-graphql';
 import { InternalGraphQLAPIClass } from '@aws-amplify/api-graphql/internals';
-import { RestAPIClass } from '@aws-amplify/api-rest';
-import { Auth } from '@aws-amplify/auth';
-import { Cache } from '@aws-amplify/cache';
+import { Amplify, Cache, ConsoleLogger } from '@aws-amplify/core';
 import {
-	Amplify,
 	ApiAction,
 	Category,
-	Credentials,
 	CustomUserAgentDetails,
-	ConsoleLogger as Logger,
-} from '@aws-amplify/core';
-import { AWSAppSyncRealTimeProvider } from '@aws-amplify/pubsub';
-import Observable from 'zen-observable-ts';
-import { GraphQLQuery, GraphQLSubscription } from '../types';
+} from '@aws-amplify/core/internals/utils';
+import { Observable } from 'rxjs';
 
-const logger = new Logger('API');
+/**
+ * NOTE!
+ *
+ * This is used only by DataStore.
+ *
+ * This can probably be pruned and/or removed. Just leaving it as much of the same
+ * state as possible for V6 to reduce number of potentially impactful changes to DataStore.
+ */
+
+const logger = new ConsoleLogger('API');
 /**
  * @deprecated
  * Use RestApi or GraphQLAPI to reduce your application bundle size
@@ -34,12 +39,9 @@ export class InternalAPIClass {
 	 * @param {Object} options - Configuration object for API
 	 */
 	private _options;
-	private _restApi: RestAPIClass;
 	private _graphqlApi: InternalGraphQLAPIClass;
 
-	Auth = Auth;
 	Cache = Cache;
-	Credentials = Credentials;
 
 	/**
 	 * Initialize API with AWS configuration
@@ -47,7 +49,6 @@ export class InternalAPIClass {
 	 */
 	constructor(options) {
 		this._options = options;
-		this._restApi = new RestAPIClass(options);
 		this._graphqlApi = new InternalGraphQLAPIClass(options);
 		logger.debug('API Options', this._options);
 	}
@@ -56,185 +57,6 @@ export class InternalAPIClass {
 		return 'InternalAPI';
 	}
 
-	/**
-	 * Configure API part with aws configurations
-	 * @param {Object} config - Configuration of the API
-	 * @return {Object} - The current configuration
-	 */
-	configure(options) {
-		this._options = Object.assign({}, this._options, options);
-
-		// Share Amplify instance with client for SSR
-		this._restApi.Credentials = this.Credentials;
-
-		this._graphqlApi.Auth = this.Auth;
-		this._graphqlApi.Cache = this.Cache;
-		this._graphqlApi.Credentials = this.Credentials;
-
-		const restAPIConfig = this._restApi.configure(this._options);
-		const graphQLAPIConfig = this._graphqlApi.configure(this._options);
-
-		return { ...restAPIConfig, ...graphQLAPIConfig };
-	}
-
-	/**
-	 * Make a GET request
-	 * @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: string,
-		path: string,
-		init: { [key: string]: any }
-	): Promise<any> {
-		return this._restApi.get(
-			apiName,
-			path,
-			this.getInitWithCustomUserAgentDetails(init, ApiAction.Get)
-		);
-	}
-
-	/**
-	 * Make a POST request
-	 * @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: string,
-		path: string,
-		init: { [key: string]: any }
-	): Promise<any> {
-		return this._restApi.post(
-			apiName,
-			path,
-			this.getInitWithCustomUserAgentDetails(init, ApiAction.Post)
-		);
-	}
-
-	/**
-	 * Make a PUT request
-	 * @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: string,
-		path: string,
-		init: { [key: string]: any }
-	): Promise<any> {
-		return this._restApi.put(
-			apiName,
-			path,
-			this.getInitWithCustomUserAgentDetails(init, ApiAction.Put)
-		);
-	}
-
-	/**
-	 * Make a PATCH request
-	 * @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: string,
-		path: string,
-		init: { [key: string]: any }
-	): Promise<any> {
-		return this._restApi.patch(
-			apiName,
-			path,
-			this.getInitWithCustomUserAgentDetails(init, ApiAction.Patch)
-		);
-	}
-
-	/**
-	 * Make a DEL request
-	 * @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: string,
-		path: string,
-		init: { [key: string]: any }
-	): Promise<any> {
-		return this._restApi.del(
-			apiName,
-			path,
-			this.getInitWithCustomUserAgentDetails(init, ApiAction.Del)
-		);
-	}
-
-	/**
-	 * Make a HEAD request
-	 * @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: string,
-		path: string,
-		init: { [key: string]: any }
-	): Promise<any> {
-		return this._restApi.head(
-			apiName,
-			path,
-			this.getInitWithCustomUserAgentDetails(init, ApiAction.Head)
-		);
-	}
-
-	/**
-	 * Checks to see if an error thrown is from an api request cancellation
-	 * @param error - Any error
-	 * @return If the error was from an api request cancellation
-	 */
-	isCancel(error: any): boolean {
-		return this._restApi.isCancel(error);
-	}
-	/**
-	 * Cancels an inflight request for either a GraphQL request or a Rest API request.
-	 * @param request - request to cancel
-	 * @param [message] - custom error message
-	 * @return If the request was cancelled
-	 */
-	cancel(request: Promise<any>, message?: string): boolean {
-		if (this._restApi.hasCancelToken(request)) {
-			return this._restApi.cancel(request, message);
-		} else if (this._graphqlApi.hasCancelToken(request)) {
-			return this._graphqlApi.cancel(request, message);
-		}
-		return false;
-	}
-
-	private getInitWithCustomUserAgentDetails(
-		init: { [key: string]: any },
-		action: ApiAction
-	) {
-		const customUserAgentDetails: CustomUserAgentDetails = {
-			category: Category.API,
-			action,
-		};
-		const initParams = { ...init, customUserAgentDetails };
-		return initParams;
-	}
-
-	/**
-	 * Getting endpoint for API
-	 * @param apiName - The name of the api
-	 * @return The endpoint of the api
-	 */
-	async endpoint(apiName: string): Promise<string> {
-		return this._restApi.endpoint(apiName);
-	}
-
 	/**
 	 * to get the operation type
 	 * @param operation
@@ -274,6 +96,7 @@ export class InternalAPIClass {
 		};
 
 		return this._graphqlApi.graphql(
+			Amplify,
 			options,
 			additionalHeaders,
 			apiUserAgentDetails
@@ -282,4 +105,3 @@ export class InternalAPIClass {
 }
 
 export const InternalAPI = new InternalAPIClass(null);
-Amplify.register(InternalAPI);

package/src/server.ts

@@ -0,0 +1,59 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { GraphQLQuery, GraphQLSubscription } from './types';
+import {
+	graphql,
+	cancel,
+	isCancelError,
+} from '@aws-amplify/api-graphql/internals';
+import {
+	AmplifyServer,
+	getAmplifyServerContext,
+} from '@aws-amplify/core/internals/adapter-core';
+
+import {
+	__amplify,
+	V6Client,
+	V6ClientSSR,
+	ServerClientGenerationParams,
+} from '@aws-amplify/api-graphql';
+
+export type {
+	GraphQLResult,
+	GraphQLReturnType,
+} from '@aws-amplify/api-graphql';
+
+/**
+ * @private
+ *
+ * Creates a client that can be used to make GraphQL requests, using a provided `AmplifyClassV6`
+ * compatible context object for config and auth fetching.
+ *
+ * @param params
+ * @returns
+ */
+export function generateClient<
+	T extends Record<any, any> = never,
+	ClientType extends V6ClientSSR<T> | V6Client<T> = V6ClientSSR<T>
+>(params: ServerClientGenerationParams): ClientType {
+	const client = {
+		[__amplify]: params.amplify,
+		graphql,
+		cancel,
+		isCancelError,
+		models: {},
+	} as any;
+
+	return client as ClientType;
+}
+
+export {
+	get,
+	put,
+	post,
+	del,
+	head,
+	patch,
+	isCancelError,
+} from '@aws-amplify/api-rest/server';

package/src/types/index.ts

@@ -10,13 +10,6 @@ export {
 	graphqlOperation,
 	GraphQLAuthError,
 	GraphQLResult,
-	GRAPHQL_AUTH_MODE,
+	GraphQLQuery,
+	GraphQLSubscription,
 } 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';
-};

package/index.v37.d.ts

@@ -1,12 +0,0 @@
-// the original ts3.7 version declaration file, used by "typesVersions" field in package.json
-// https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#file-redirects
-// can consider using third-party tool like downlevel-dts in the build process to automate this.
-import { API } from './lib-esm/API';
-export { API, APIClass } from './lib-esm/API';
-export {
-	graphqlOperation,
-	GraphQLAuthError,
-	GRAPHQL_AUTH_MODE,
-	GraphQLResult,
-} from '@aws-amplify/api-graphql';
-export default API;