@aws-amplify/api 5.4.6-api-v6-models.b3abc9b.0 → 6.0.0

package/package.json

@@ -1,17 +1,10 @@
 {
 	"name": "@aws-amplify/api",
-	"version": "5.4.6-api-v6-models.b3abc9b.0+b3abc9b",
+	"version": "6.0.0",
 	"description": "Api category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
 	"typings": "./lib-esm/index.d.ts",
-	"typesVersions": {
-		"<3.8": {
-			"lib-esm/index.d.ts": [
-				"index.v37.d.ts"
-			]
-		}
-	},
 	"react-native": {
 		"./lib/index": "./lib-esm/index.js"
 	},
@@ -24,18 +17,17 @@
 	},
 	"scripts": {
 		"test": "npm run lint && jest -w 1 --coverage",
-		"test:size": "size-limit",
 		"build-with-test": "npm test && npm run build",
-		"build:cjs": "rimraf lib && tsc -p ./tsconfig.build.json -m commonjs --outDir lib && webpack && webpack --config ./webpack.config.dev.js",
-		"build:esm": "rimraf lib-esm && tsc -p ./tsconfig.build.json -m esnext --outDir lib-esm",
-		"build:cjs:watch": "rimraf lib && tsc -p ./tsconfig.build.json -m commonjs --outDir lib --watch",
-		"build:esm:watch": "rimraf lib-esm && tsc -p ./tsconfig.build.json -m esnext --outDir lib-esm --watch",
+		"build:cjs": "node ./build es5 && webpack && webpack --config ./webpack.config.dev.js",
+		"build:esm": "node ./build es6",
+		"build:cjs:watch": "node ./build es5 --watch",
+		"build:esm:watch": "node ./build es6 --watch",
 		"build": "npm run clean && npm run build:esm && npm run build:cjs",
 		"clean": "npm run clean:size && rimraf lib-esm lib dist",
 		"clean:size": "rimraf dual-publish-tmp tmp*",
 		"format": "echo \"Not implemented\"",
 		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
-		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 75"
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 88"
 	},
 	"repository": {
 		"type": "git",
@@ -48,7 +40,6 @@
 	},
 	"homepage": "https://aws-amplify.github.io/",
 	"devDependencies": {
-		"@types/zen-observable": "^0.8.0",
 		"typescript": "5.1.6"
 	},
 	"files": [
@@ -56,22 +47,14 @@
 		"lib-esm",
 		"src",
 		"index.*.d.ts",
-		"internals"
+		"internals",
+		"server"
 	],
 	"dependencies": {
-		"@aws-amplify/amplify-api-next-types-alpha": "^0.1.2",
-		"@aws-amplify/api-graphql": "3.4.12-api-v6-models.b3abc9b.0+b3abc9b",
-		"@aws-amplify/api-rest": "3.5.6-api-v6-models.b3abc9b.0+b3abc9b",
-		"tslib": "^2.6.1"
+		"@aws-amplify/api-graphql": "4.0.0",
+		"@aws-amplify/api-rest": "4.0.0",
+		"tslib": "^2.5.0"
 	},
-	"size-limit": [
-		{
-			"name": "API (top-level class)",
-			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, API }",
-			"limit": "93.82 kB"
-		}
-	],
 	"jest": {
 		"globals": {
 			"ts-jest": {
@@ -92,9 +75,6 @@
 			"^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
 		},
 		"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
-		"testPathIgnorePatterns": [
-			"assets"
-		],
 		"moduleFileExtensions": [
 			"ts",
 			"tsx",
@@ -119,5 +99,5 @@
 			"lib-esm"
 		]
 	},
-	"gitHead": "b3abc9b75f6f1353f4c2fbc10cd3369be498e9fc"
+	"gitHead": "d505105326d7f6214f6bd1e06eb20be3a3651377"
 }

package/server/package.json

@@ -0,0 +1,8 @@
+{
+	"name": "@aws-amplify/api/server",
+	"types": "../lib-esm/server.d.ts",
+	"main": "../lib/server.js",
+	"module": "../lib-esm/server.js",
+	"react-native": "../lib-esm/server.js",
+	"sideEffects": false
+}

package/src/API.ts

@@ -1,207 +1,23 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { AWSAppSyncRealTimeProvider } from '@aws-amplify/pubsub';
+import { __amplify, V6Client } from '@aws-amplify/api-graphql';
 import {
-	GraphQLOptions,
-	GraphQLResult,
-	GraphQLQuery,
-	GraphQLSubscription,
-} from '@aws-amplify/api-graphql';
-import { graphql as v6graphql } from '@aws-amplify/api-graphql/internals';
-import { Amplify, ConsoleLogger as Logger } from '@aws-amplify/core';
-import Observable from 'zen-observable-ts';
-import { InternalAPIClass } from './internals/InternalAPI';
-import {
-	initializeModel,
-	generateGraphQLDocument,
-	buildGraphQLVariables,
-	graphQLOperationsInfo,
-	ModelOperation,
-	flattenItems,
-} from './APIClient';
-import type { ModelTypes } from '@aws-amplify/amplify-api-next-types-alpha';
+	graphql as v6graphql,
+	cancel as v6cancel,
+	isCancelError as v6isCancelError,
+} from '@aws-amplify/api-graphql/internals';
+import { Amplify } from '@aws-amplify/core';
 
-const logger = new Logger('API');
 /**
- * @deprecated
- * Use RestApi or GraphQLAPI to reduce your application bundle size
- * Export Cloud Logic APIs
+ * Generates an API client that can work with models or raw GraphQL
  */
-
-export class APIClass extends InternalAPIClass {
-	public getModuleName() {
-		return 'API';
-	}
-
-	/**
-	 * Executes a GraphQL operation
-	 *
-	 * @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<T>(
-		options: GraphQLOptions,
-		additionalHeaders?: { [key: string]: string }
-	): 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 super.graphql(options, additionalHeaders);
-	}
-
-	/**
-	 * Generates an API client that can work with models or raw GraphQL
-	 */
-	generateClient<T extends Record<any, any> = never>(): V6Client<T> {
-		const config = super.configure({});
-
-		const { modelIntrospection } = config;
-
-		const client: V6Client<any> = {
-			graphql: v6graphql,
-			models: {},
-		};
-
-		// TODO: refactor this to use separate methods for each CRUDL.
-		// Doesn't make sense to gen the methods dynamically given the different args and return values
-		for (const model of Object.values(modelIntrospection.models)) {
-			const { name } = model as any;
-
-			client.models[name] = {} as any;
-
-			Object.entries(graphQLOperationsInfo).forEach(
-				([key, { operationPrefix }]) => {
-					const operation = key as ModelOperation;
-
-					if (operation === 'LIST') {
-						client.models[name][operationPrefix] = async (args?: any) => {
-							const query = generateGraphQLDocument(
-								modelIntrospection.models,
-								name,
-								'LIST',
-								args
-							);
-							const variables = buildGraphQLVariables(
-								model,
-								'LIST',
-								args,
-								modelIntrospection
-							);
-
-							console.log('API list', query, variables);
-
-							const res = (await this.graphql({
-								query,
-								variables,
-							})) as any;
-
-							// flatten response
-							if (res.data !== undefined) {
-								const [key] = Object.keys(res.data);
-
-								if (res.data[key].items) {
-									const flattenedResult = flattenItems(res.data)[key];
-
-									// don't init if custom selection set
-									if (args?.selectionSet) {
-										return flattenedResult;
-									} else {
-										const initialized = initializeModel(
-											client,
-											name,
-											flattenedResult,
-											modelIntrospection
-										);
-
-										console.log('initialized', initialized);
-
-										return initialized;
-									}
-								}
-
-								return res.data[key];
-							}
-
-							return res as any;
-						};
-					} else {
-						client.models[name][operationPrefix] = async (
-							arg?: any,
-							options?: any
-						) => {
-							const query = generateGraphQLDocument(
-								modelIntrospection.models,
-								name,
-								operation,
-								options
-							);
-							const variables = buildGraphQLVariables(
-								model,
-								operation,
-								arg,
-								modelIntrospection
-							);
-
-							console.log(`API ${operationPrefix}`, query, variables);
-
-							const res = (await this.graphql({
-								query,
-								variables,
-							})) as any;
-
-							// flatten response
-							if (res.data !== undefined) {
-								const [key] = Object.keys(res.data);
-								const flattenedResult = flattenItems(res.data)[key];
-
-								if (options?.selectionSet) {
-									return flattenedResult;
-								} else {
-									// TODO: refactor to avoid destructuring here
-									const [initialized] = initializeModel(
-										client,
-										name,
-										[flattenedResult],
-										modelIntrospection
-									);
-
-									return initialized;
-								}
-							}
-
-							return res;
-						};
-					}
-				}
-			);
-		}
-
-		return client as V6Client<T>;
-	}
+export function generateClient<
+	T extends Record<any, any> = never
+>(): V6Client<T> {
+	return {
+		[__amplify]: Amplify,
+		graphql: v6graphql,
+		cancel: v6cancel,
+		isCancelError: v6isCancelError,
+	};
 }
-
-type FilteredKeys<T> = {
-	[P in keyof T]: T[P] extends never ? never : P;
-}[keyof T];
-
-type ExcludeNeverFields<O> = {
-	[K in FilteredKeys<O>]: O[K];
-};
-
-// If no T is passed, ExcludeNeverFields removes "models" from the client
-declare type V6Client<T extends Record<any, any> = never> = ExcludeNeverFields<{
-	graphql: typeof v6graphql;
-	models: ModelTypes<T>;
-}>;
-
-export const API = new APIClass(null);
-Amplify.register(API);

package/src/index.ts

@@ -1,12 +1,24 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+// TODO(v6): revisit exports
+
 export { GraphQLQuery, GraphQLSubscription } from './types';
-export { API, APIClass } from './API';
-export {
-	graphqlOperation,
-	GraphQLAuthError,
-	GRAPHQL_AUTH_MODE,
+export { generateClient } from './API';
+
+export { GraphQLAuthError } from '@aws-amplify/api-graphql';
+
+export type {
+	GraphQLResult,
+	GraphQLReturnType,
 } from '@aws-amplify/api-graphql';
 
-export type { GraphQLResult } from '@aws-amplify/api-graphql';
+export {
+	get,
+	put,
+	post,
+	del,
+	head,
+	patch,
+	isCancelError,
+} from '@aws-amplify/api-rest';

package/src/internals/InternalAPI.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import {
+	AWSAppSyncRealTimeProvider,
 	GraphQLOperation,
 	GraphQLOptions,
 	GraphQLResult,
@@ -9,21 +10,24 @@ import {
 	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';
+} 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
@@ -35,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
@@ -48,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);
 	}
@@ -57,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
@@ -275,6 +96,7 @@ export class InternalAPIClass {
 		};
 
 		return this._graphqlApi.graphql(
+			Amplify,
 			options,
 			additionalHeaders,
 			apiUserAgentDetails
@@ -283,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,8 +10,6 @@ export {
 	graphqlOperation,
 	GraphQLAuthError,
 	GraphQLResult,
-	GRAPHQL_AUTH_MODE,
 	GraphQLQuery,
 	GraphQLSubscription,
 } from '@aws-amplify/api-graphql';
-export { SelectionSet } from '@aws-amplify/amplify-api-next-types-alpha';

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;