@aws-amplify/core 6.0.16 → 6.0.17-unstable.0d2aa5d.0

package/src/singleton/Amplify.ts

@@ -1,21 +1,23 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { AuthClass } from './Auth';
-import { Hub, AMPLIFY_SYMBOL } from '../Hub';
+import { AMPLIFY_SYMBOL, Hub } from '../Hub';
+import { parseAWSExports } from '../parseAWSExports';
+import { deepFreeze } from '../utils';
+
 import {
 	AuthConfig,
 	LegacyConfig,
 	LibraryOptions,
 	ResourcesConfig,
 } from './types';
-import { parseAWSExports } from '../parseAWSExports';
-import { deepFreeze } from '../utils';
+import { AuthClass } from './Auth';
 import { ADD_OAUTH_LISTENER } from './constants';
 
 export class AmplifyClass {
 	private oAuthListener:
 		| ((authConfig: AuthConfig['Cognito']) => void)
 		| undefined = undefined;
+
 	resourcesConfig: ResourcesConfig;
 	libraryOptions: LibraryOptions;
 
@@ -47,7 +49,7 @@ export class AmplifyClass {
 	 */
 	configure(
 		resourcesConfig: ResourcesConfig | LegacyConfig,
-		libraryOptions?: LibraryOptions
+		libraryOptions?: LibraryOptions,
 	): void {
 		let resolvedResourceConfig: ResourcesConfig;
 
@@ -75,7 +77,7 @@ export class AmplifyClass {
 				data: this.resourcesConfig,
 			},
 			'Configure',
-			AMPLIFY_SYMBOL
+			AMPLIFY_SYMBOL,
 		);
 
 		this.notifyOAuthListener();

package/src/singleton/Auth/index.ts

@@ -1,10 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import {
-	CredentialsAndIdentityId,
 	AuthConfig,
 	AuthSession,
 	AuthTokens,
+	CredentialsAndIdentityId,
 	FetchAuthSessionOptions,
 	LibraryAuthOptions,
 } from './types';
@@ -17,6 +17,7 @@ export function isTokenExpired({
 	clockDrift: number;
 }): boolean {
 	const currentTime = Date.now();
+
 	return currentTime + clockDrift > expiresAt;
 }
 
@@ -24,8 +25,6 @@ export class AuthClass {
 	private authConfig?: AuthConfig;
 	private authOptions?: LibraryAuthOptions;
 
-	constructor() {}
-
 	/**
 	 * Configure Auth category
 	 *
@@ -38,7 +37,7 @@ export class AuthClass {
 	 */
 	configure(
 		authResourcesConfig: AuthConfig,
-		authOptions?: LibraryAuthOptions
+		authOptions?: LibraryAuthOptions,
 	): void {
 		this.authConfig = authResourcesConfig;
 		this.authOptions = authOptions;
@@ -54,14 +53,13 @@ export class AuthClass {
 	 * @returns Promise of current auth session {@link AuthSession}.
 	 */
 	async fetchAuthSession(
-		options: FetchAuthSessionOptions = {}
+		options: FetchAuthSessionOptions = {},
 	): Promise<AuthSession> {
-		let tokens: AuthTokens | undefined;
 		let credentialsAndIdentityId: CredentialsAndIdentityId | undefined;
 		let userSub: string | undefined;
 
 		// Get tokens will throw if session cannot be refreshed (network or service error) or return null if not available
-		tokens = await this.getTokens(options);
+		const tokens = await this.getTokens(options);
 
 		if (tokens) {
 			userSub = tokens.accessToken?.payload?.sub;
@@ -74,7 +72,7 @@ export class AuthClass {
 						tokens,
 						authenticated: true,
 						forceRefresh: options.forceRefresh,
-					}
+					},
 				);
 		} else {
 			// getCredentialsAndIdentityId will throw if cannot get credentials (network or service error)
@@ -84,7 +82,7 @@ export class AuthClass {
 						authConfig: this.authConfig,
 						authenticated: false,
 						forceRefresh: options.forceRefresh,
-					}
+					},
 				);
 		}
 
@@ -97,13 +95,11 @@ export class AuthClass {
 	}
 
 	async clearCredentials(): Promise<void> {
-		if (this.authOptions?.credentialsProvider) {
-			return await this.authOptions.credentialsProvider.clearCredentialsAndIdentityId();
-		}
+		await this.authOptions?.credentialsProvider?.clearCredentialsAndIdentityId();
 	}
 
 	async getTokens(
-		options: FetchAuthSessionOptions
+		options: FetchAuthSessionOptions,
 	): Promise<AuthTokens | undefined> {
 		return (
 			(await this.authOptions?.tokenProvider?.getTokens(options)) ?? undefined

package/src/singleton/Auth/types.ts

@@ -16,61 +16,65 @@ interface JwtPayloadStandardFields {
 	sub?: string; // JWT sub https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.2
 }
 
-/** JSON type */
-type Json = null | string | number | boolean | Json[] | JsonObject;
+type JsonPrimitive = null | string | number | boolean;
+
+/** JSON array type */
+type JsonArray = JsonPrimitive[];
 
 /** JSON Object type */
-type JsonObject = { [name: string]: Json };
+interface JsonObject {
+	[x: string]: JsonPrimitive | JsonArray | JsonObject;
+}
 
 export type JwtPayload = JwtPayloadStandardFields & JsonObject;
 
-export type JWT = {
+export interface JWT {
 	payload: JwtPayload;
-	toString: () => string;
-};
+	toString(): string;
+}
 
 export type JWTCreator = (stringJWT: string) => JWT;
 
-export type AuthSession = {
+export interface AuthSession {
 	tokens?: AuthTokens;
 	credentials?: AWSCredentials;
 	identityId?: string;
 	userSub?: string;
-};
+}
 
-export type LibraryAuthOptions = {
+export interface LibraryAuthOptions {
 	tokenProvider?: TokenProvider;
 	credentialsProvider?: CredentialsAndIdentityIdProvider;
-};
+}
 
-export type Identity = {
+export interface Identity {
 	id: string;
 	type: 'guest' | 'primary';
-};
+}
 
 export interface CredentialsAndIdentityIdProvider {
-	getCredentialsAndIdentityId: (
-		getCredentialsOptions: GetCredentialsOptions
-	) => Promise<CredentialsAndIdentityId | undefined>;
-	clearCredentialsAndIdentityId: () => void;
+	getCredentialsAndIdentityId(
+		getCredentialsOptions: GetCredentialsOptions,
+	): Promise<CredentialsAndIdentityId | undefined>;
+	clearCredentialsAndIdentityId(): void;
 }
 
-export type TokenProvider = {
-	getTokens: ({
+export interface TokenProvider {
+	getTokens({
 		forceRefresh,
 	}?: {
 		forceRefresh?: boolean;
-	}) => Promise<AuthTokens | null>;
-};
+	}): Promise<AuthTokens | null>;
+}
 
-export type FetchAuthSessionOptions = {
+export interface FetchAuthSessionOptions {
 	forceRefresh?: boolean;
-};
+}
 
-export type AuthTokens = {
+export interface AuthTokens {
 	idToken?: JWT;
 	accessToken: JWT;
-};
+}
 
 export type AuthStandardAttributeKey =
 	| 'address'
@@ -116,7 +120,7 @@ type StrictUnionHelper<T, TAll> = T extends any
 	: never;
 export type StrictUnion<T> = StrictUnionHelper<T, T>;
 
-export type AuthIdentityPoolConfig = {
+export interface AuthIdentityPoolConfig {
 	Cognito: CognitoIdentityPoolConfig & {
 		userPoolClientId?: never;
 		userPoolId?: never;
@@ -127,21 +131,21 @@ export type AuthIdentityPoolConfig = {
 		mfa?: never;
 		passwordFormat?: never;
 	};
-};
+}
 
-export type CognitoIdentityPoolConfig = {
+export interface CognitoIdentityPoolConfig {
 	identityPoolId: string;
 	allowGuestAccess?: boolean;
-};
+}
 
-export type AuthUserPoolConfig = {
+export interface AuthUserPoolConfig {
 	Cognito: CognitoUserPoolConfig & {
 		identityPoolId?: never;
 		allowGuestAccess?: never;
 	};
-};
+}
 
-export type CognitoUserPoolConfig = {
+export interface CognitoUserPoolConfig {
 	userPoolClientId: string;
 	userPoolId: string;
 	userPoolEndpoint?: string;
@@ -165,22 +169,26 @@ export type CognitoUserPoolConfig = {
 		requireNumbers?: boolean;
 		requireSpecialCharacters?: boolean;
 	};
-};
+}
 
-export type OAuthConfig = {
+export interface OAuthConfig {
 	domain: string;
-	scopes: Array<OAuthScope>;
-	redirectSignIn: Array<string>;
-	redirectSignOut: Array<string>;
+	scopes: OAuthScope[];
+	redirectSignIn: string[];
+	redirectSignOut: string[];
 	responseType: 'code' | 'token';
-	providers?: Array<OAuthProvider | CustomProvider>;
-};
+	providers?: (OAuthProvider | CustomProvider)[];
+}
 
 export type OAuthProvider = 'Google' | 'Facebook' | 'Amazon' | 'Apple';
-type CustomProvider = { custom: string };
+interface CustomProvider {
+	custom: string;
+}
 
-type CustomScope = string & {};
-type OAuthScope =
+// CustomScope is a non-nullish string, using `& NonNullable<unknown>` to ensure
+// `OAuthScope` is not resolved as a `string`
+type CustomScope = string & NonNullable<unknown>;
+export type OAuthScope =
 	| 'email'
 	| 'openid'
 	| 'phone'
@@ -194,9 +202,9 @@ export type CognitoUserPoolWithOAuthConfig = CognitoUserPoolConfig & {
 		oauth: OAuthConfig;
 	};
 };
-export type AuthUserPoolAndIdentityPoolConfig = {
+export interface AuthUserPoolAndIdentityPoolConfig {
 	Cognito: CognitoUserPoolAndIdentityPoolConfig;
-};
+}
 
 export type CognitoUserPoolAndIdentityPoolConfig = CognitoUserPoolConfig &
 	CognitoIdentityPoolConfig;
@@ -205,28 +213,28 @@ export type GetCredentialsOptions =
 	| GetCredentialsAuthenticatedUser
 	| GetCredentialsUnauthenticatedUser;
 
-type GetCredentialsAuthenticatedUser = {
+interface GetCredentialsAuthenticatedUser {
 	authenticated: true;
 	forceRefresh?: boolean;
 	authConfig: AuthConfig | undefined;
 	tokens: AuthTokens;
-};
+}
 
-type GetCredentialsUnauthenticatedUser = {
+interface GetCredentialsUnauthenticatedUser {
 	authenticated: false;
 	forceRefresh?: boolean;
 	authConfig: AuthConfig | undefined;
 	tokens?: never;
-};
+}
 
-export type CredentialsAndIdentityId = {
+export interface CredentialsAndIdentityId {
 	credentials: AWSCredentials;
 	identityId?: string;
-};
+}
 
-export type AWSCredentials = {
+export interface AWSCredentials {
 	accessKeyId: string;
 	secretAccessKey: string;
 	sessionToken?: string;
 	expiration?: Date;
-};
+}

package/src/singleton/Auth/utils/index.ts

@@ -1,24 +1,24 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { AuthConfigurationErrorCode, assert } from './errorHelpers';
 import { base64Decoder } from '../../../utils/convert';
 import {
 	AuthConfig,
-	JWT,
-	AuthUserPoolAndIdentityPoolConfig,
-	CognitoUserPoolConfig,
-	CognitoUserPoolAndIdentityPoolConfig,
 	CognitoIdentityPoolConfig,
-	StrictUnion,
+	CognitoUserPoolAndIdentityPoolConfig,
+	CognitoUserPoolConfig,
+	JWT,
 	OAuthConfig,
+	StrictUnion,
 } from '../types';
 
+import { AuthConfigurationErrorCode, assert } from './errorHelpers';
+
 export function assertTokenProviderConfig(
 	cognitoConfig?: StrictUnion<
 		| CognitoUserPoolConfig
 		| CognitoUserPoolAndIdentityPoolConfig
 		| CognitoIdentityPoolConfig
-	>
+	>,
 ): asserts cognitoConfig is
 	| CognitoUserPoolAndIdentityPoolConfig
 	| CognitoUserPoolConfig {
@@ -30,14 +30,11 @@ export function assertTokenProviderConfig(
 			!!cognitoConfig.userPoolId && !!cognitoConfig.userPoolClientId;
 	}
 
-	return assert(
-		assertionValid,
-		AuthConfigurationErrorCode.AuthUserPoolException
-	);
+	assert(assertionValid, AuthConfigurationErrorCode.AuthUserPoolException);
 }
 
 export function assertOAuthConfig(
-	cognitoConfig?: AuthConfig['Cognito']
+	cognitoConfig?: AuthConfig['Cognito'],
 ): asserts cognitoConfig is AuthConfig['Cognito'] & {
 	loginWith: {
 		oauth: OAuthConfig;
@@ -48,9 +45,10 @@ export function assertOAuthConfig(
 		!!cognitoConfig?.loginWith?.oauth?.redirectSignOut &&
 		!!cognitoConfig?.loginWith?.oauth?.redirectSignIn &&
 		!!cognitoConfig?.loginWith?.oauth?.responseType;
-	return assert(
+
+	assert(
 		validOAuthConfig,
-		AuthConfigurationErrorCode.OAuthNotConfigureException
+		AuthConfigurationErrorCode.OAuthNotConfigureException,
 	);
 }
 export function assertIdentityPoolIdConfig(
@@ -58,23 +56,13 @@ export function assertIdentityPoolIdConfig(
 		| CognitoUserPoolConfig
 		| CognitoUserPoolAndIdentityPoolConfig
 		| CognitoIdentityPoolConfig
-	>
+	>,
 ): asserts cognitoConfig is CognitoIdentityPoolConfig {
 	const validConfig = !!cognitoConfig?.identityPoolId;
-	return assert(
-		validConfig,
-		AuthConfigurationErrorCode.InvalidIdentityPoolIdException
-	);
-}
 
-function assertUserPoolAndIdentityPoolConfig(
-	authConfig: AuthConfig
-): asserts authConfig is AuthUserPoolAndIdentityPoolConfig {
-	const validConfig =
-		!!authConfig?.Cognito.identityPoolId && !!authConfig?.Cognito.userPoolId;
-	return assert(
+	assert(
 		validConfig,
-		AuthConfigurationErrorCode.AuthUserPoolAndIdentityPoolException
+		AuthConfigurationErrorCode.InvalidIdentityPoolIdException,
 	);
 }
 
@@ -93,7 +81,7 @@ export function decodeJWT(token: string): JWT {
 				.convert(base64)
 				.split('')
 				.map(char => `%${`00${char.charCodeAt(0).toString(16)}`.slice(-2)}`)
-				.join('')
+				.join(''),
 		);
 		const payload = JSON.parse(jsonStr);
 

package/src/singleton/Geo/types.ts

@@ -3,11 +3,11 @@
 
 import { AtLeastOne } from '../types';
 
-export type LocationServiceConfig = {
+export interface LocationServiceConfig {
 	LocationService: {
 		region: string;
 		maps?: {
-			items: {};
+			items: Record<string, unknown>;
 			default: string;
 		};
 		searchIndices?: {
@@ -19,6 +19,6 @@ export type LocationServiceConfig = {
 			default: string;
 		};
 	};
-};
+}
 
 export type GeoConfig = AtLeastOne<LocationServiceConfig>;

package/src/singleton/Interactions/types.ts

@@ -15,13 +15,13 @@ interface LexV2BotConfig {
 	region: string;
 }
 
-type InteractionsLexV1Config = {
+interface InteractionsLexV1Config {
 	LexV1: Record<string, LexV1BotConfig>;
-};
+}
 
-type InteractionsLexV2Config = {
+interface InteractionsLexV2Config {
 	LexV2: Record<string, LexV2BotConfig>;
-};
+}
 
 export type InteractionsConfig = AtLeastOne<
 	InteractionsLexV1Config & InteractionsLexV2Config

package/src/singleton/Notifications/types.ts

@@ -1,17 +1,18 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { AtLeastOne } from '../types';
+
 import { InAppMessagingConfig } from './InAppMessaging/types';
 import { PushNotificationConfig } from './PushNotification/types';
-import { AtLeastOne } from '../types';
 
-export type InAppMessagingProviderConfig = {
+export interface InAppMessagingProviderConfig {
 	InAppMessaging: InAppMessagingConfig;
-};
+}
 
-export type PushNotificationProviderConfig = {
+export interface PushNotificationProviderConfig {
 	PushNotification: PushNotificationConfig;
-};
+}
 
 export type NotificationsConfig = AtLeastOne<
 	InAppMessagingProviderConfig & PushNotificationProviderConfig

package/src/singleton/Predictions/types.ts

@@ -4,67 +4,67 @@
 import { AtLeastOne } from '../types';
 
 // Defaults for ConvertConfig
-type SpeechGeneratorDefaults = {
+interface SpeechGeneratorDefaults {
 	voiceId?: string;
-};
-type TranscriptionDefaults = {
+}
+interface TranscriptionDefaults {
 	language?: string;
-};
-type TranslateTextDefaults = {
+}
+interface TranslateTextDefaults {
 	sourceLanguage?: string;
 	targetLanguage?: string;
-};
+}
 
 // Defaults for IdentifyConfig
-type IdentifyEntitiesDefaults = {
+interface IdentifyEntitiesDefaults {
 	collectionId?: string;
 	maxEntities?: number;
-};
-type IdentityLabelsDefaults = {
+}
+interface IdentityLabelsDefaults {
 	type?: string;
-};
-type IdentifyTextDefaults = {
+}
+interface IdentifyTextDefaults {
 	format?: string;
-};
+}
 
 // Defaults for InterpretConfig
-type InterpretTextDefaults = {
+interface InterpretTextDefaults {
 	type?: string;
-};
+}
 
-type ConvertConfig = {
+interface ConvertConfig {
 	speechGenerator?: PredictionsProviderConfig<SpeechGeneratorDefaults>;
 	transcription?: PredictionsProviderConfig<TranscriptionDefaults>;
 	translateText?: PredictionsProviderConfig<TranslateTextDefaults>;
-};
+}
 
-type IdentifyConfig = {
+interface IdentifyConfig {
 	identifyEntities?: PredictionsProviderConfig<IdentifyEntitiesDefaults> & {
 		celebrityDetectionEnabled?: boolean;
 	};
 	identifyLabels?: PredictionsProviderConfig<IdentityLabelsDefaults>;
 	identifyText?: PredictionsProviderConfig<IdentifyTextDefaults>;
-};
+}
 
-type InterpretConfig = {
+interface InterpretConfig {
 	interpretText?: PredictionsProviderConfig<InterpretTextDefaults>;
-};
+}
 
-export type PredictionsProviderConfig<T> = {
+export interface PredictionsProviderConfig<T> {
 	region?: string;
 	proxy?: boolean;
 	defaults?: T;
-};
+}
 
-export type PredictionsConvertConfig = {
+export interface PredictionsConvertConfig {
 	convert: ConvertConfig;
-};
-export type PredictionsIdentifyConfig = {
+}
+export interface PredictionsIdentifyConfig {
 	identify: IdentifyConfig;
-};
-export type PredictionsInterpretConfig = {
+}
+export interface PredictionsInterpretConfig {
 	interpret: InterpretConfig;
-};
+}
 
 export type PredictionsConfig = AtLeastOne<
 	PredictionsConvertConfig &

package/src/singleton/Storage/types.ts

@@ -5,7 +5,7 @@ import { AtLeastOne } from '../types';
 
 export type StorageAccessLevel = 'guest' | 'protected' | 'private';
 
-export type S3ProviderConfig = {
+export interface S3ProviderConfig {
 	S3: {
 		bucket?: string;
 		region?: string;
@@ -16,7 +16,7 @@ export type S3ProviderConfig = {
 		 */
 		dangerouslyConnectToHttpEndpointForTesting?: string;
 	};
-};
+}
 
 export type StorageConfig = AtLeastOne<S3ProviderConfig>;
 

package/src/singleton/apis/fetchAuthSession.ts

@@ -1,10 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { fetchAuthSession as fetchAuthSessionInternal } from './internal/fetchAuthSession';
 import { Amplify } from '../Amplify';
 import { FetchAuthSessionOptions } from '../Auth/types';
 
+import { fetchAuthSession as fetchAuthSessionInternal } from './internal/fetchAuthSession';
+
 export const fetchAuthSession = (options?: FetchAuthSessionOptions) => {
 	return fetchAuthSessionInternal(Amplify, options);
 };

package/src/singleton/apis/internal/fetchAuthSession.ts

@@ -6,7 +6,7 @@ import { AuthSession, FetchAuthSessionOptions } from '../../Auth/types';
 
 export const fetchAuthSession = (
 	amplify: AmplifyClass,
-	options?: FetchAuthSessionOptions
+	options?: FetchAuthSessionOptions,
 ): Promise<AuthSession> => {
 	return amplify.Auth.fetchAuthSession(options);
 };

package/src/singleton/apis/server/fetchAuthSession.ts

@@ -7,10 +7,10 @@ import { fetchAuthSession as fetchAuthSessionInternal } from '../internal/fetchA
 
 export const fetchAuthSession = (
 	contextSpec: AmplifyServer.ContextSpec,
-	options?: FetchAuthSessionOptions
+	options?: FetchAuthSessionOptions,
 ): Promise<AuthSession> => {
 	return fetchAuthSessionInternal(
 		getAmplifyServerContext(contextSpec).amplify,
-		options
+		options,
 	);
 };