@aws-amplify/api-graphql 4.4.1-events.619318.0 → 4.4.1

package/src/internals/events/appsyncRequest.ts

@@ -1,169 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import { AmplifyClassV6 } from '@aws-amplify/core';
-import {
-	AmplifyUrl,
-	CustomUserAgentDetails,
-	GraphQLAuthMode,
-	getAmplifyUserAgent,
-} from '@aws-amplify/core/internals/utils';
-import { post } from '@aws-amplify/api-rest/internals';
-import {
-	CustomHeaders,
-	RequestOptions,
-} from '@aws-amplify/data-schema/runtime';
-
-import { resolveLibraryOptions } from '../../utils';
-import { repackageUnauthorizedError } from '../../utils/errors/repackageAuthError';
-import { headerBasedAuth } from '../graphqlAuth';
-import { isGraphQLResponseWithErrors } from '../utils/runtimeTypeGuards/isGraphQLResponseWithErrors';
-
-const USER_AGENT_HEADER = 'x-amz-user-agent';
-
-interface GqlRequestOptions {
-	apiKey?: string;
-	region?: string;
-	appSyncGraphqlEndpoint: string;
-	authenticationType: GraphQLAuthMode;
-	query: string;
-	variables: string[];
-	authToken?: string;
-}
-
-// This is effectively a copy of InternalGraphQLAPI.ts._graphql(...)
-// Our existing unit tests are tightly coupled to the implementation, so i was unable to refactor
-// and extend _graphql() without having to change a bunch of tests as well... which in turn reduces confidence
-// that this feature will _not affect_ GQL behavior.
-export async function appsyncRequest<T = any>(
-	amplify: AmplifyClassV6,
-	options: GqlRequestOptions,
-	additionalHeaders: CustomHeaders = {},
-	abortController: AbortController,
-	customUserAgentDetails?: CustomUserAgentDetails,
-): Promise<T> {
-	const {
-		region,
-		appSyncGraphqlEndpoint: endpoint,
-		authenticationType: authMode,
-		query,
-		variables,
-	} = options;
-
-	if (!endpoint) {
-		throw new Error('No endpoint');
-	}
-
-	const { withCredentials } = resolveLibraryOptions(amplify);
-
-	const headers = await requestHeaders(
-		amplify,
-		options,
-		additionalHeaders,
-		customUserAgentDetails,
-	);
-
-	const body = {
-		channel: query as string,
-		events: variables,
-	};
-
-	const signingServiceInfo = ['apiKey', 'none'].includes(authMode)
-		? undefined
-		: {
-				service: 'appsync',
-				region,
-			};
-
-	const { body: responseBody } = await post(amplify, {
-		url: new AmplifyUrl(endpoint),
-		options: {
-			headers,
-			body,
-			signingServiceInfo,
-			withCredentials,
-		},
-		abortController,
-	});
-
-	const response = await responseBody.json();
-
-	if (isGraphQLResponseWithErrors(response)) {
-		throw repackageUnauthorizedError(response);
-	}
-
-	return response as T;
-}
-
-/**
- * Computes all the necessary HTTP headers for the request based on:
- * 1. Operation-level header options
- * 2. Amplify.configure custom headers
- * 3. AuthZ headers for explicit auth mode specified for operation ?? default auth mode in config
- *
- * @returns HTTP request headers key/value
- */
-async function requestHeaders(
-	amplify: AmplifyClassV6,
-	options: GqlRequestOptions,
-	additionalHeaders: CustomHeaders,
-	customUserAgentDetails?: CustomUserAgentDetails,
-) {
-	const {
-		apiKey,
-		appSyncGraphqlEndpoint: endpoint,
-		authenticationType: authMode,
-		query,
-		variables,
-		authToken,
-	} = options;
-
-	const { headers: customHeadersFn } = resolveLibraryOptions(amplify);
-
-	let additionalCustomHeaders: Record<string, string>;
-
-	if (typeof additionalHeaders === 'function') {
-		const requestOptions: RequestOptions = {
-			method: 'POST',
-			url: new AmplifyUrl(endpoint).toString(),
-			queryString: query,
-		};
-
-		additionalCustomHeaders = await additionalHeaders(requestOptions);
-	} else {
-		additionalCustomHeaders = additionalHeaders;
-	}
-
-	// if an authorization header is set, have the operation-level authToken take precedence
-	if (authToken) {
-		additionalCustomHeaders = {
-			...additionalCustomHeaders,
-			Authorization: authToken,
-		};
-	}
-
-	const authHeaders = await headerBasedAuth(
-		amplify,
-		authMode,
-		apiKey,
-		additionalCustomHeaders,
-	);
-
-	const customHeaders =
-		customHeadersFn &&
-		(await customHeadersFn({
-			query,
-			variables: variables as any,
-		}));
-
-	const headers = {
-		...authHeaders,
-		// Custom headers included in Amplify configuration options:
-		...customHeaders,
-		// Custom headers from individual requests or API client configuration:
-		...additionalCustomHeaders,
-		// User agent headers:
-		[USER_AGENT_HEADER]: getAmplifyUserAgent(customUserAgentDetails),
-	};
-
-	return headers;
-}

package/src/internals/events/index.ts

@@ -1,138 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { Subscription } from 'rxjs';
-import { Amplify } from '@aws-amplify/core';
-import { DocumentType } from '@aws-amplify/core/internals/utils';
-
-import { AppSyncEventProvider as eventProvider } from '../../Providers/AWSAppSyncEventsProvider';
-
-import { appsyncRequest } from './appsyncRequest';
-import { configure, normalizeAuth, serializeEvents } from './utils';
-import type {
-	EventsChannel,
-	EventsOptions,
-	PublishResponse,
-	PublishedEvent,
-	SubscriptionObserver,
-} from './types';
-
-/**
- * Establish a WebSocket connection to an Events channel
- *
- */
-async function connect(
-	channelName: string,
-	options?: EventsOptions,
-): Promise<EventsChannel> {
-	const providerOptions = configure();
-
-	providerOptions.authenticationType = normalizeAuth(
-		options?.authMode,
-		providerOptions.authenticationType,
-	);
-
-	await eventProvider.connect(providerOptions);
-
-	let _subscription: Subscription;
-
-	const sub = (
-		observer: SubscriptionObserver<any>,
-		subOptions?: EventsOptions,
-	): Subscription => {
-		const subscribeOptions = { ...providerOptions, query: channelName };
-		subscribeOptions.authenticationType = normalizeAuth(
-			subOptions?.authMode,
-			subscribeOptions.authenticationType,
-		);
-
-		_subscription = eventProvider
-			.subscribe(subscribeOptions)
-			.subscribe(observer);
-
-		return _subscription;
-	};
-
-	// WS publish is not enabled in the service yet. It will be a follow up feature
-	const _pub = async (
-		event: DocumentType,
-		pubOptions?: EventsOptions,
-	): Promise<any> => {
-		const publishOptions = {
-			...providerOptions,
-			query: channelName,
-			variables: event,
-		};
-		publishOptions.authenticationType = normalizeAuth(
-			pubOptions?.authMode,
-			publishOptions.authenticationType,
-		);
-
-		return eventProvider.publish(publishOptions);
-	};
-
-	const close = () => {
-		_subscription && _subscription.unsubscribe();
-	};
-
-	return {
-		/**
-		 * Subscribe to incoming events
-		 */
-		subscribe: sub,
-		/**
-		 * Close channel and any active subscriptions
-		 */
-		close,
-		// publish: pub,
-	};
-}
-
-/**
- * Publish events to a channel via REST request
- *
- * @param channelName - publish destination
- * @param event - JSON-serializable value or an array of values
- * @param options
- */
-async function post(
-	channelName: string,
-	event: DocumentType | DocumentType[],
-	options?: EventsOptions,
-): Promise<void | PublishedEvent[]> {
-	const providerOptions = configure();
-	providerOptions.authenticationType = normalizeAuth(
-		options?.authMode,
-		providerOptions.authenticationType,
-	);
-
-	// trailing slash required in publish
-	const normalizedChannelName =
-		channelName[0] === '/' ? channelName : `/${channelName}`;
-
-	const publishOptions = {
-		...providerOptions,
-		query: normalizedChannelName,
-		variables: serializeEvents(event),
-		authToken: options?.authToken,
-	};
-
-	const abortController = new AbortController();
-
-	const res = await appsyncRequest<PublishResponse>(
-		Amplify,
-		publishOptions,
-		{},
-		abortController,
-	);
-
-	if (res.failed?.length > 0) {
-		return res.failed;
-	}
-}
-
-function closeAll(): void {
-	eventProvider.close();
-}
-
-export { connect, post, closeAll };

package/src/internals/events/types.ts

@@ -1,35 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { Subscription } from 'rxjs';
-import type { GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
-
-export interface SubscriptionObserver<T> {
-	next(value: T): void;
-	error(errorValue: any): void;
-}
-
-export interface EventsChannel {
-	subscribe(
-		observer: SubscriptionObserver<any>,
-		subOptions?: EventsOptions,
-	): Subscription;
-	close(): void;
-}
-
-export type ResolvedGraphQLAuthModes = Exclude<GraphQLAuthMode, 'identityPool'>;
-
-export interface EventsOptions {
-	authMode?: GraphQLAuthMode;
-	authToken?: string;
-}
-
-export interface PublishedEvent {
-	identifier: string;
-	index: number;
-}
-
-export interface PublishResponse {
-	failed: PublishedEvent[];
-	successful: PublishedEvent[];
-}

package/src/internals/events/utils.ts

@@ -1,77 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import { Amplify } from '@aws-amplify/core';
-import {
-	DocumentType,
-	GraphQLAuthMode,
-} from '@aws-amplify/core/internals/utils';
-
-import type { ResolvedGraphQLAuthModes } from './types';
-
-export const normalizeAuth = (
-	explicitAuthMode: GraphQLAuthMode | undefined,
-	defaultAuthMode: ResolvedGraphQLAuthModes,
-): ResolvedGraphQLAuthModes => {
-	if (!explicitAuthMode) {
-		return defaultAuthMode;
-	}
-
-	if (explicitAuthMode === 'identityPool') {
-		return 'iam';
-	}
-
-	return explicitAuthMode;
-};
-
-export const configure = () => {
-	const config = Amplify.getConfig();
-
-	const eventsConfig = config.API?.Events;
-
-	if (!eventsConfig) {
-		throw new Error(
-			'Amplify configuration is missing. Have you called Amplify.configure()?',
-		);
-	}
-
-	const configAuthMode = normalizeAuth(eventsConfig.defaultAuthMode, 'apiKey');
-
-	const options = {
-		appSyncGraphqlEndpoint: eventsConfig.endpoint,
-		region: eventsConfig.region,
-		authenticationType: configAuthMode,
-		apiKey: eventsConfig.apiKey,
-	};
-
-	return options;
-};
-
-/**
- * Event API expects and array of JSON strings
- *
- * @param events - JSON-serializable value or an array of values
- * @returns array of JSON strings
- */
-export const serializeEvents = (
-	events: DocumentType | DocumentType[],
-): string[] => {
-	if (Array.isArray(events)) {
-		return events.map((ev, idx) => {
-			const eventJson = JSON.stringify(ev);
-			if (eventJson === undefined) {
-				throw new Error(
-					`Event must be a valid JSON value. Received ${ev} at index ${idx}`,
-				);
-			}
-
-			return eventJson;
-		});
-	}
-
-	const eventJson = JSON.stringify(events);
-	if (eventJson === undefined) {
-		throw new Error(`Event must be a valid JSON value. Received ${events}`);
-	}
-
-	return [eventJson];
-};

package/src/internals/graphqlAuth.ts

@@ -1,87 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
-import { AmplifyClassV6 } from '@aws-amplify/core';
-
-import { GraphQLApiError } from '../utils/errors';
-import {
-	NO_API_KEY,
-	NO_AUTH_TOKEN_HEADER,
-	NO_SIGNED_IN_USER,
-	NO_VALID_AUTH_TOKEN,
-	NO_VALID_CREDENTIALS,
-} from '../utils/errors/constants';
-
-export async function headerBasedAuth(
-	amplify: AmplifyClassV6,
-	authMode: GraphQLAuthMode,
-	apiKey: string | undefined,
-	additionalHeaders: Record<string, string> = {},
-) {
-	let headers = {};
-
-	switch (authMode) {
-		case 'apiKey':
-			if (!apiKey) {
-				throw new GraphQLApiError(NO_API_KEY);
-			}
-			headers = {
-				'X-Api-Key': apiKey,
-			};
-			break;
-		case 'iam': {
-			const session = await amplify.Auth.fetchAuthSession();
-			if (session.credentials === undefined) {
-				throw new GraphQLApiError(NO_VALID_CREDENTIALS);
-			}
-			break;
-		}
-		case 'oidc':
-		case 'userPool': {
-			let token: string | undefined;
-
-			try {
-				token = (
-					await amplify.Auth.fetchAuthSession()
-				).tokens?.accessToken.toString();
-			} catch (e) {
-				// fetchAuthSession failed
-				throw new GraphQLApiError({
-					...NO_SIGNED_IN_USER,
-					underlyingError: e,
-				});
-			}
-
-			// `fetchAuthSession()` succeeded but didn't return `tokens`.
-			// This may happen when unauthenticated access is enabled and there is
-			// no user signed in.
-			if (!token) {
-				throw new GraphQLApiError(NO_VALID_AUTH_TOKEN);
-			}
-
-			headers = {
-				Authorization: token,
-			};
-			break;
-		}
-		case 'lambda':
-			if (
-				typeof additionalHeaders === 'object' &&
-				!additionalHeaders.Authorization
-			) {
-				throw new GraphQLApiError(NO_AUTH_TOKEN_HEADER);
-			}
-
-			headers = {
-				Authorization: additionalHeaders.Authorization,
-			};
-			break;
-		case 'none':
-			break;
-		default:
-			break;
-	}
-
-	return headers;
-}

package/src/internals/graphqlRequest.ts

@@ -1,30 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
-import { AmplifyClassV6 } from '@aws-amplify/core';
-import {
-	// cancel as cancelREST,
-	post,
-	// updateRequestToBeCancellable,
-} from '@aws-amplify/api-rest/internals';
-
-export async function graphqlRequest(
-	amplify: AmplifyClassV6,
-	url: string,
-	options: any,
-	abortController: AbortController,
-	_post?: typeof post,
-) {
-	const p = _post ?? post;
-
-	const { body: responseBody } = await p(amplify, {
-		url: new AmplifyUrl(url),
-		options,
-		abortController,
-	});
-
-	const response = await responseBody.json();
-
-	return response;
-}