@aws-amplify/api-graphql 4.0.22 → 4.0.23

package/src/types/PubSub.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Observer } from 'rxjs';
+
 export interface SubscriptionObserver<T> {
 	closed: boolean;
 	next(value: T): void;

package/src/types/index.ts

@@ -2,22 +2,23 @@
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyClassV6, ResourcesConfig } from '@aws-amplify/core';
 import {
-	EnumTypes,
-	ModelTypes,
 	CustomHeaders,
-	CustomQueries,
 	CustomMutations,
+	CustomQueries,
+	CustomSubscriptions,
+	EnumTypes,
+	ModelTypes,
 } from '@aws-amplify/data-schema-types';
-import { Source, DocumentNode, GraphQLError } from 'graphql';
-export { OperationTypeNode } from 'graphql';
+import { DocumentNode, GraphQLError, Source } from 'graphql';
 import { Observable } from 'rxjs';
-
 import {
-	GraphQLAuthMode,
 	DocumentType,
+	GraphQLAuthMode,
 } from '@aws-amplify/core/internals/utils';
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
 
+export { OperationTypeNode } from 'graphql';
+
 export { CONTROL_MSG, ConnectionState } from './PubSub';
 
 export { SelectionSet } from '@aws-amplify/data-schema-types';
@@ -41,9 +42,7 @@ export interface GraphQLOptions {
 export interface GraphQLResult<T = object> {
 	data: T;
 	errors?: GraphQLError[];
-	extensions?: {
-		[key: string]: any;
-	};
+	extensions?: Record<string, any>;
 }
 
 // Opaque type used for determining the graphql query type
@@ -75,21 +74,22 @@ export type GraphQLSubscription<T> = T & {
  *
  * This util simply makes related model properties optional recursively.
  */
-export type GraphQLReturnType<T> = T extends {}
-	? {
-			[K in keyof T]?: GraphQLReturnType<T[K]>;
-		}
-	: T;
+export type GraphQLReturnType<T> =
+	T extends Record<string, unknown>
+		? {
+				[K in keyof T]?: GraphQLReturnType<T[K]>;
+			}
+		: T;
 
 /**
  * Describes a paged list result from AppSync, which can either
  * live at the top query or property (e.g., related model) level.
  */
-type PagedList<T, TYPENAME> = {
+interface PagedList<T, TYPENAME> {
 	__typename: TYPENAME;
 	nextToken?: string | null | undefined;
-	items: Array<T>;
-};
+	items: T[];
+}
 
 /**
  * Recursively looks through a result type and removes nulls and
@@ -102,7 +102,7 @@ type PagedList<T, TYPENAME> = {
 type WithListsFixed<T> =
 	T extends PagedList<infer IT, infer NAME>
 		? PagedList<Exclude<IT, null | undefined>, NAME>
-		: T extends {}
+		: T extends Record<string, unknown>
 			? {
 					[K in keyof T]: WithListsFixed<T[K]>;
 				}
@@ -169,9 +169,9 @@ export type GraphqlSubscriptionResult<T> = Observable<
  * })
  * ```
  */
-export type GraphqlSubscriptionMessage<T> = {
+export interface GraphqlSubscriptionMessage<T> {
 	data: T;
-};
+}
 
 export interface AWSAppSyncRealTimeProviderOptions {
 	appSyncGraphqlEndpoint?: string;
@@ -180,15 +180,15 @@ export interface AWSAppSyncRealTimeProviderOptions {
 	variables?: Record<string, unknown>;
 	apiKey?: string;
 	region?: string;
-	libraryConfigHeaders?: () => {} | (() => Promise<{}>);
+	libraryConfigHeaders?(): () => Promise<Record<string, unknown> | Headers>;
 	additionalHeaders?: CustomHeaders;
 }
 
-export type AWSAppSyncRealTimeProvider = {
+export interface AWSAppSyncRealTimeProvider {
 	subscribe(
 		options?: AWSAppSyncRealTimeProviderOptions,
 	): Observable<Record<string, unknown>>;
-};
+}
 
 export enum GraphQLAuthError {
 	NO_API_KEY = 'No api-key configured',
@@ -259,18 +259,18 @@ export type GraphQLResponseV6<
 	FALLBACK_TYPE = unknown,
 	TYPED_GQL_STRING extends string = string,
 > =
-	TYPED_GQL_STRING extends GeneratedQuery<infer IN, infer QUERY_OUT>
+	TYPED_GQL_STRING extends GeneratedQuery<infer _, infer QUERY_OUT>
 		? Promise<GraphQLResult<FixedQueryResult<QUERY_OUT>>>
-		: TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer MUTATION_OUT>
+		: TYPED_GQL_STRING extends GeneratedMutation<infer _, infer MUTATION_OUT>
 			? Promise<GraphQLResult<NeverEmpty<MUTATION_OUT>>>
-			: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer SUB_OUT>
+			: TYPED_GQL_STRING extends GeneratedSubscription<infer _, infer SUB_OUT>
 				? GraphqlSubscriptionResult<NeverEmpty<SUB_OUT>>
-				: FALLBACK_TYPE extends GraphQLQuery<infer T>
+				: FALLBACK_TYPE extends GraphQLQuery<infer _>
 					? Promise<GraphQLResult<FALLBACK_TYPE>>
-					: FALLBACK_TYPE extends GraphQLSubscription<infer T>
+					: FALLBACK_TYPE extends GraphQLSubscription<infer _>
 						? GraphqlSubscriptionResult<FALLBACK_TYPE>
 						: FALLBACK_TYPE extends GraphQLOperationType<
-									infer IN,
+									infer _,
 									infer CUSTOM_OUT
 							  >
 							? CUSTOM_OUT
@@ -294,10 +294,13 @@ export type GraphQLResponseV6<
  * })
  * ```
  */
-export type GraphQLOperationType<IN extends {}, OUT extends {}> = {
+export interface GraphQLOperationType<
+	IN extends Record<string, DocumentType>,
+	OUT extends Record<string, DocumentType>,
+> {
 	variables: IN;
 	result: OUT;
-};
+}
 
 /**
  * Nominal type for branding generated graphql query operation strings with
@@ -386,12 +389,13 @@ export type V6Client<T extends Record<any, any> = never> = ExcludeNeverFields<{
 	[__authToken]?: string;
 	[__headers]?: CustomHeaders;
 	graphql: GraphQLMethod;
-	cancel: (promise: Promise<any>, message?: string) => boolean;
-	isCancelError: (error: any) => boolean;
+	cancel(promise: Promise<any>, message?: string): boolean;
+	isCancelError(error: any): boolean;
 	models: ModelTypes<T>;
 	enums: EnumTypes<T>;
 	queries: CustomQueries<T>;
 	mutations: CustomMutations<T>;
+	subscriptions: CustomSubscriptions<T>;
 }>;
 
 export type V6ClientSSRRequest<T extends Record<any, any> = never> =
@@ -401,8 +405,8 @@ export type V6ClientSSRRequest<T extends Record<any, any> = never> =
 		[__authToken]?: string;
 		[__headers]?: CustomHeaders;
 		graphql: GraphQLMethodSSR;
-		cancel: (promise: Promise<any>, message?: string) => boolean;
-		isCancelError: (error: any) => boolean;
+		cancel(promise: Promise<any>, message?: string): boolean;
+		isCancelError(error: any): boolean;
 		models: ModelTypes<T, 'REQUEST'>;
 		enums: EnumTypes<T>;
 		queries: CustomQueries<T, 'REQUEST'>;
@@ -416,8 +420,8 @@ export type V6ClientSSRCookies<T extends Record<any, any> = never> =
 		[__authToken]?: string;
 		[__headers]?: CustomHeaders;
 		graphql: GraphQLMethod;
-		cancel: (promise: Promise<any>, message?: string) => boolean;
-		isCancelError: (error: any) => boolean;
+		cancel(promise: Promise<any>, message?: string): boolean;
+		isCancelError(error: any): boolean;
 		models: ModelTypes<T, 'COOKIES'>;
 		enums: EnumTypes<T>;
 		queries: CustomQueries<T, 'COOKIES'>;
@@ -446,30 +450,30 @@ export type GraphQLMethodSSR = <
  *
  * The knobs available for configuring `server/generateClient` internally.
  */
-export type ServerClientGenerationParams = {
+export interface ServerClientGenerationParams {
 	amplify:
 		| null // null expected when used with `generateServerClient`
 		// closure expected with `generateServerClientUsingCookies`
 		| ((fn: (amplify: AmplifyClassV6) => Promise<any>) => Promise<any>);
 	// global env-sourced config use for retrieving modelIntro
 	config: ResourcesConfig;
-};
+}
 
 export type QueryArgs = Record<string, unknown>;
 
-export type ListArgs = {
+export interface ListArgs extends Record<string, unknown> {
 	selectionSet?: string[];
-	filter?: {};
+	filter?: Record<string, unknown>;
 	headers?: CustomHeaders;
-};
+}
 
-export type AuthModeParams = {
+export interface AuthModeParams extends Record<string, unknown> {
 	authMode?: GraphQLAuthMode;
 	authToken?: string;
-};
+}
 
-export type GenerateServerClientParams = {
+export interface GenerateServerClientParams {
 	config: ResourcesConfig;
 	authMode?: GraphQLAuthMode;
 	authToken?: string;
-};
+}

package/src/utils/ConnectionStateMonitor.ts

@@ -1,19 +1,21 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Observable, Observer, SubscriptionLike, map, filter } from 'rxjs';
+import { Observable, Observer, SubscriptionLike, filter, map } from 'rxjs';
+
 import { ConnectionState } from '../types/PubSub';
+
 import { ReachabilityMonitor } from './ReachabilityMonitor';
 
 // Internal types for tracking different connection states
 type LinkedConnectionState = 'connected' | 'disconnected';
 type LinkedHealthState = 'healthy' | 'unhealthy';
-type LinkedConnectionStates = {
+interface LinkedConnectionStates {
 	networkState: LinkedConnectionState;
 	connectionState: LinkedConnectionState | 'connecting';
 	intendedConnectionState: LinkedConnectionState;
 	keepAliveState: LinkedHealthState;
-};
+}
 
 export const CONNECTION_CHANGE: {
 	[key in
@@ -53,6 +55,7 @@ export class ConnectionStateMonitor {
 	private _linkedConnectionStateObserver:
 		| Observer<LinkedConnectionStates>
 		| undefined;
+
 	private _networkMonitoringSubscription?: SubscriptionLike;
 	private _initialNetworkStateSubscription?: SubscriptionLike;
 
@@ -132,6 +135,7 @@ export class ConnectionStateMonitor {
 				filter(current => {
 					const toInclude = current !== previous;
 					previous = current;
+
 					return toInclude;
 				}),
 			);
@@ -196,6 +200,7 @@ export class ConnectionStateMonitor {
 		// All remaining states directly correspond to the connection state
 		if (connectionState === 'connecting') return ConnectionState.Connecting;
 		if (connectionState === 'disconnected') return ConnectionState.Disconnected;
+
 		return ConnectionState.Connected;
 	}
 }

package/src/utils/ReachabilityMonitor/index.native.ts

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Reachability } from '@aws-amplify/core/internals/utils';
-import { default as NetInfo } from '@react-native-community/netinfo';
+import NetInfo from '@react-native-community/netinfo';
 
 export const ReachabilityMonitor = () =>
 	new Reachability().networkMonitor(NetInfo);

package/src/utils/ReachabilityMonitor/index.ts

@@ -1,4 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Reachability } from '@aws-amplify/core/internals/utils';
+
 export const ReachabilityMonitor = () => new Reachability().networkMonitor();

package/src/utils/ReconnectionMonitor.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Observer } from 'rxjs';
+
 import { RECONNECT_DELAY, RECONNECT_INTERVAL } from '../Providers/constants';
 
 export enum ReconnectEvent {

package/src/utils/errors/repackageAuthError.ts

@@ -1,14 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import {
-	AmplifyErrorParams,
-	GraphQLAuthMode,
-} from '@aws-amplify/core/internals/utils';
+import { AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
 
-type ErrorObject = {
+interface ErrorObject {
 	errors: AmplifyErrorParams[];
-};
+}
 
 /**
  * Checks to see if the given response or subscription message contains an
@@ -27,12 +24,13 @@ export function repackageUnauthError<T extends ErrorObject>(content: T): T {
 			}
 		});
 	}
+
 	return content;
 }
 
 function isUnauthError(error: any): boolean {
 	// Error pattern corresponding to appsync calls
-	if (error?.['originalError']?.['name']?.startsWith('UnauthorizedException')) {
+	if (error?.originalError?.name?.startsWith('UnauthorizedException')) {
 		return true;
 	}
 	// Error pattern corresponding to appsync subscriptions
@@ -42,5 +40,6 @@ function isUnauthError(error: any): boolean {
 	) {
 		return true;
 	}
+
 	return false;
 }

package/src/utils/findIndexByFields.ts

@@ -11,7 +11,7 @@
 export function findIndexByFields<T>(
 	needle: T,
 	haystack: T[],
-	keyFields: Array<keyof T>,
+	keyFields: (keyof T)[],
 ): number {
 	const searchObject = Object.fromEntries(
 		keyFields.map(fieldName => [fieldName, needle[fieldName]]),

package/src/utils/resolveConfig.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { AmplifyClassV6, ConsoleLogger } from '@aws-amplify/core';
+
 import { APIValidationErrorCode, assertValidationError } from './errors';
 
 const logger = new ConsoleLogger('GraphQLAPI resolveConfig');

package/src/utils/resolveLibraryOptions.ts

@@ -9,5 +9,6 @@ import { AmplifyClassV6 } from '@aws-amplify/core';
 export const resolveLibraryOptions = (amplify: AmplifyClassV6) => {
 	const headers = amplify.libraryOptions?.API?.GraphQL?.headers;
 	const withCredentials = amplify.libraryOptions?.API?.GraphQL?.withCredentials;
+
 	return { headers, withCredentials };
 };

package/src/utils/resolveOwnerFields.ts

@@ -9,20 +9,25 @@ type ModelIntrospectionSchema = Exclude<
 >;
 type Model = ModelIntrospectionSchema['models'][string];
 
-type AuthAttribute = {
+interface AuthAttribute {
 	type: 'auth';
 	properties: {
 		rules: AuthRule[];
 	};
-};
+}
 
 /**
  * Only the portions of an Auth rule we care about.
  */
-type AuthRule = {
-	allow: string;
-	ownerField?: string;
-};
+type AuthRule =
+	| {
+			allow: 'owner';
+			ownerField?: string;
+	  }
+	| {
+			allow: 'groups';
+			groupsField: string;
+	  };
 
 /**
  * Given an introspection schema model, returns all owner fields.
@@ -37,10 +42,13 @@ export function resolveOwnerFields(model: Model): string[] {
 			for (const rule of attr.properties.rules) {
 				if (rule.allow === 'owner') {
 					ownerFields.add(rule.ownerField || 'owner');
+				} else if (rule.allow === 'groups') {
+					ownerFields.add(rule.groupsField);
 				}
 			}
 		}
 	}
+
 	return Array.from(ownerFields);
 }
 
@@ -55,11 +63,12 @@ function isAuthAttribute(attribute: any): attribute is AuthAttribute {
 	if (attribute?.type === 'auth') {
 		if (typeof attribute?.properties === 'object') {
 			if (Array.isArray(attribute?.properties?.rules)) {
-				return (attribute?.properties?.rules as Array<any>).every(
+				return (attribute?.properties?.rules as any[]).every(
 					rule => !!rule.allow,
 				);
 			}
 		}
 	}
+
 	return false;
 }

package/src/utils/resolvePKFields.ts

@@ -18,5 +18,6 @@ type SchemaModel = ModelIntrospectionSchema['models'][string];
  */
 export function resolvePKFields(model: SchemaModel) {
 	const { primaryKeyFieldName, sortKeyFieldNames } = model.primaryKeyInfo;
+
 	return [primaryKeyFieldName, ...sortKeyFieldNames];
 }