@aws-amplify/core 6.0.1-api-v6-models.8035dfc.0 → 6.0.1-api-v6-models.572a7b5.0

package/src/awsClients/cognitoIdentity/base.ts

@@ -19,6 +19,7 @@ import {
 } from '../../clients/middleware/retry';
 import { getAmplifyUserAgent } from '../../Platform';
 import { observeFrameworkChanges } from '../../Platform/detectFramework';
+import { AmplifyUrl } from '../../utils/amplifyUrl';
 
 /**
  * The service name used to sign requests if the API requires authentication.
@@ -29,7 +30,9 @@ const SERVICE_NAME = 'cognito-identity';
  * The endpoint resolver function that returns the endpoint URL for a given region.
  */
 const endpointResolver = ({ region }: EndpointResolverOptions) => ({
-	url: new URL(`https://cognito-identity.${region}.${getDnsSuffix(region)}`),
+	url: new AmplifyUrl(
+		`https://cognito-identity.${region}.${getDnsSuffix(region)}`
+	),
 });
 
 /**

package/src/awsClients/pinpoint/base.ts

@@ -9,6 +9,7 @@ import {
 import { parseJsonError } from '../../clients/serde/json';
 import type { EndpointResolverOptions, Headers } from '../../clients/types';
 import { getAmplifyUserAgent } from '../../Platform';
+import { AmplifyUrl } from '../../utils/amplifyUrl';
 
 /**
  * The service name used to sign requests if the API requires authentication.
@@ -19,7 +20,7 @@ const SERVICE_NAME = 'mobiletargeting';
  * The endpoint resolver function that returns the endpoint URL for a given region.
  */
 const endpointResolver = ({ region }: EndpointResolverOptions) => ({
-	url: new URL(`https://pinpoint.${region}.${getDnsSuffix(region)}`),
+	url: new AmplifyUrl(`https://pinpoint.${region}.${getDnsSuffix(region)}`),
 });
 
 /**

package/src/awsClients/pinpoint/getInAppMessages.ts

@@ -15,6 +15,7 @@ import type {
 	GetInAppMessagesCommandInput as GetInAppMessagesInput,
 	GetInAppMessagesCommandOutput as GetInAppMessagesOutput,
 } from './types';
+import { AmplifyUrl } from '../../utils/amplifyUrl';
 
 export type { GetInAppMessagesInput, GetInAppMessagesOutput };
 
@@ -23,7 +24,7 @@ const getInAppMessagesSerializer = (
 	endpoint: Endpoint
 ): HttpRequest => {
 	const headers = getSharedHeaders();
-	const url = new URL(endpoint.url);
+	const url = new AmplifyUrl(endpoint.url);
 	url.pathname = `v1/apps/${extendedEncodeURIComponent(
 		ApplicationId
 	)}/endpoints/${extendedEncodeURIComponent(EndpointId)}/inappmessages`;

package/src/awsClients/pinpoint/putEvents.ts

@@ -16,6 +16,7 @@ import type {
 	PutEventsCommandInput as PutEventsInput,
 	PutEventsCommandOutput as PutEventsOutput,
 } from './types';
+import { AmplifyUrl } from '../../utils/amplifyUrl';
 
 export type { PutEventsInput, PutEventsOutput };
 
@@ -25,7 +26,7 @@ const putEventsSerializer = (
 ): HttpRequest => {
 	assert(!!ApplicationId, PinpointValidationErrorCode.NoAppId);
 	const headers = getSharedHeaders();
-	const url = new URL(endpoint.url);
+	const url = new AmplifyUrl(endpoint.url);
 	url.pathname = `v1/apps/${extendedEncodeURIComponent(ApplicationId)}/events`;
 	const body = JSON.stringify(EventsRequest ?? {});
 	return { method: 'POST', headers, url, body };

package/src/awsClients/pinpoint/updateEndpoint.ts

@@ -15,6 +15,7 @@ import type {
 	UpdateEndpointCommandInput as UpdateEndpointInput,
 	UpdateEndpointCommandOutput as UpdateEndpointOutput,
 } from './types';
+import { AmplifyUrl } from '../../utils/amplifyUrl';
 
 export type { UpdateEndpointInput, UpdateEndpointOutput };
 
@@ -23,7 +24,7 @@ const updateEndpointSerializer = (
 	endpoint: Endpoint
 ): HttpRequest => {
 	const headers = getSharedHeaders();
-	const url = new URL(endpoint.url);
+	const url = new AmplifyUrl(endpoint.url);
 	url.pathname = `v1/apps/${extendedEncodeURIComponent(
 		ApplicationId
 	)}/endpoints/${extendedEncodeURIComponent(EndpointId)}`;

package/src/clients/middleware/signing/signer/signatureV4/index.ts

@@ -1,8 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import './polyfills';
-
 // TODO: V6 replace Signer
 export { signRequest } from './signRequest';
 export { presignUrl } from './presignUrl';

package/src/clients/middleware/signing/signer/signatureV4/presignUrl.ts

@@ -15,6 +15,7 @@ import {
 } from './constants';
 import { getSigningValues } from './utils/getSigningValues';
 import { getSignature } from './utils/getSignature';
+import { AmplifyUrl } from '../../../../../utils/amplifyUrl';
 
 /**
  * Given a `Presignable` object, returns a Signature Version 4 presigned `URL` object.
@@ -33,7 +34,7 @@ export const presignUrl = (
 
 	// create the request to sign
 	// @ts-ignore URL constructor accepts a URL object
-	const presignedUrl = new URL(url);
+	const presignedUrl = new AmplifyUrl(url);
 	Object.entries({
 		[ALGORITHM_QUERY_PARAM]: SHA256_ALGORITHM_IDENTIFIER,
 		[CREDENTIAL_QUERY_PARAM]: `${accessKeyId}/${credentialScope}`,

package/src/errors/errorHelpers.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { createAssertionFunction } from './createAssertionFunction';
+import { AmplifyErrorCode, AmplifyErrorMap, AssertionFunction } from '../types';
+
+const amplifyErrorMap: AmplifyErrorMap<AmplifyErrorCode> = {
+	[AmplifyErrorCode.NoEndpointId]: {
+		message: 'Endpoint ID was not found and was unable to be created.',
+	},
+	[AmplifyErrorCode.PlatformNotSupported]: {
+		message: 'Function not supported on current platform.',
+	},
+	[AmplifyErrorCode.Unknown]: {
+		message: 'An unknown error occurred.',
+	},
+};
+
+export const assert: AssertionFunction<AmplifyErrorCode> =
+	createAssertionFunction(amplifyErrorMap);

package/src/errors/index.ts

@@ -4,3 +4,4 @@
 export { AmplifyError } from './AmplifyError';
 export { createAssertionFunction } from './createAssertionFunction';
 export { PlatformNotSupportedError } from './PlatformNotSupportedError';
+export { assert } from './errorHelpers';

package/src/index.ts

@@ -60,10 +60,14 @@ export {
 export { KeyValueStorageInterface } from './types';
 
 // Cache exports
-import { BrowserStorageCache } from './Cache/BrowserStorageCache';
-export { InMemoryCache } from './Cache/InMemoryCache';
-export { BrowserStorageCache };
-export { BrowserStorageCache as Cache }; // Maintain interoperability with React Native
+export { Cache } from './Cache';
+export { CacheConfig } from './Cache/types';
 
 // Internationalization utilities
 export { I18n } from './I18n';
+
+// Logging utilities
+export { ConsoleLogger } from './Logger';
+
+// Service worker
+export { ServiceWorker } from './ServiceWorker';

package/src/libraryUtils.ts

@@ -20,6 +20,8 @@ export {
 } from './utils';
 export { parseAWSExports } from './parseAWSExports';
 export { LegacyConfig } from './singleton/types';
+export { amplifyUuid } from './utils/amplifyUuid';
+export { AmplifyUrl, AmplifyUrlSearchParams } from './utils/amplifyUrl';
 
 // Auth utilities
 export {
@@ -38,13 +40,10 @@ export {
 	JwtPayload,
 	AuthStandardAttributeKey,
 	AuthVerifiableAttributeKey,
+	AWSCredentials,
 } from './singleton/Auth/types';
 
-// Logging utilities
-export { ConsoleLogger, ConsoleLogger as Logger } from './Logger';
-
 // Platform & user-agent utilities
-export { ClientDevice } from './ClientDevice';
 export {
 	Platform,
 	getAmplifyUserAgentObject,
@@ -66,16 +65,14 @@ export {
 	PushNotificationAction,
 	StorageAction,
 	SetCustomUserAgentInput,
+	StorageUserAgentInput,
+	AuthUserAgentInput,
+	InAppMessagingUserAgentInput,
+	GeoUserAgentInput,
 } from './Platform/types';
 export { setCustomUserAgent } from './Platform/customUserAgent';
 
-// Service worker
-export { ServiceWorker } from './ServiceWorker';
-
-// Other utilities & constants
-export { BackgroundProcessManager } from './BackgroundProcessManager';
-export { Mutex } from './Mutex';
-export { Reachability } from './Reachability';
+// Error handling
 export {
 	AmplifyError,
 	PlatformNotSupportedError,
@@ -88,6 +85,11 @@ export {
 	AssertionFunction,
 	ServiceError,
 } from './types';
+
+// Other utilities & constants
+export { BackgroundProcessManager } from './BackgroundProcessManager';
+export { Mutex } from './Mutex';
+export { Reachability } from './Reachability';
 export {
 	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
 	USER_AGENT_HEADER,
@@ -99,3 +101,7 @@ export { getCrypto } from './utils/globalHelpers';
 
 // Hub
 export { HubInternal } from './Hub';
+
+// Session listener
+export { sessionListener } from './utils/sessionListener';
+export { SessionState } from './utils/sessionListener/types';

package/src/parseAWSExports.ts

@@ -6,6 +6,7 @@ import {
 	AuthStandardAttributeKey,
 	AuthConfigUserAttributes,
 } from './singleton/Auth/types';
+
 import { ResourcesConfig } from './singleton/types';
 
 const logger = new Logger('parseAWSExports');
@@ -36,6 +37,8 @@ export const parseAWSExports = (
 		aws_appsync_authenticationType,
 		aws_appsync_graphqlEndpoint,
 		aws_appsync_region,
+		aws_bots,
+		aws_bots_config,
 		aws_cognito_identity_pool_id,
 		aws_cognito_sign_up_verification_method,
 		aws_cognito_mfa_configuration,
@@ -71,20 +74,36 @@ export const parseAWSExports = (
 	}
 
 	// Notifications
-	if (Notifications) {
-		if (Notifications.InAppMessaging?.AWSPinpoint) {
-			const { appId, region } = Notifications.InAppMessaging.AWSPinpoint;
-			amplifyConfig.Notifications = {
-				InAppMessaging: {
-					Pinpoint: {
-						appId,
-						region,
-					},
+	const { InAppMessaging, Push } = Notifications ?? {};
+	if (InAppMessaging?.AWSPinpoint || Push?.AWSPinpoint) {
+		amplifyConfig.Notifications = {};
+		if (InAppMessaging?.AWSPinpoint) {
+			const { appId, region } = InAppMessaging.AWSPinpoint;
+			amplifyConfig.Notifications.InAppMessaging = {
+				Pinpoint: {
+					appId,
+					region,
+				},
+			};
+		}
+		if (Push?.AWSPinpoint) {
+			const { appId, region } = Push.AWSPinpoint;
+			amplifyConfig.Notifications.PushNotification = {
+				Pinpoint: {
+					appId,
+					region,
 				},
 			};
 		}
 	}
 
+	// Interactions
+	if (Array.isArray(aws_bots_config)) {
+		amplifyConfig.Interactions = {
+			LexV1: Object.fromEntries(aws_bots_config.map(bot => [bot.name, bot])),
+		};
+	}
+
 	// API
 	if (aws_appsync_graphqlEndpoint) {
 		const defaultAuthMode = authTypeMapping[aws_appsync_authenticationType];

package/src/providers/pinpoint/apis/flushEvents.ts

@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Credentials } from '@aws-sdk/types';
+import { AWSCredentials } from '../../../libraryUtils';
 import { getEventBuffer } from '../utils/getEventBuffer';
 import {
 	BUFFER_SIZE,
@@ -13,7 +13,7 @@ import {
 export const flushEvents = (
 	appId: string,
 	region: string,
-	credentials: Credentials,
+	credentials: AWSCredentials,
 	identityId?: string,
 	userAgentValue?: string
 ) => {

package/src/providers/pinpoint/apis/record.ts

@@ -1,18 +1,16 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { v4 as uuid } from 'uuid';
+import { amplifyUuid } from '../../../utils/amplifyUuid';
 import { PinpointRecordInput, PinpointSession } from '../types';
-import { getEndpointId } from '../utils';
+import { resolveEndpointId } from '../utils';
 import {
 	BUFFER_SIZE,
 	FLUSH_INTERVAL,
 	FLUSH_SIZE,
 	RESEND_LIMIT,
 } from '../utils/constants';
-import { updateEndpoint } from './updateEndpoint';
 import { getEventBuffer } from '../utils/getEventBuffer';
-import { AmplifyError } from '../../../errors';
 
 // TODO(v6) Refactor when we add support for session tracking & `autoTrack`
 let session: PinpointSession;
@@ -23,6 +21,7 @@ let session: PinpointSession;
 export const record = async ({
 	appId,
 	category,
+	channelType,
 	credentials,
 	event,
 	identityId,
@@ -30,8 +29,7 @@ export const record = async ({
 	userAgentValue,
 }: PinpointRecordInput): Promise<void> => {
 	const timestampISOString = new Date().toISOString();
-	const eventId = uuid();
-	let endpointId = await getEndpointId(appId, category);
+	const eventId = amplifyUuid();
 
 	// Prepare event buffer if required
 	const buffer = getEventBuffer({
@@ -46,31 +44,19 @@ export const record = async ({
 		userAgentValue,
 	});
 
-	// Prepare a Pinpoint endpoint via updateEndpoint if one does not already exist, which will generate and cache an
-	// endpoint ID between calls
-	if (!endpointId) {
-		await updateEndpoint({
-			appId,
-			category,
-			credentials,
-			identityId,
-			region,
-			userAgentValue,
-		});
-
-		endpointId = await getEndpointId(appId, category);
-	}
-
-	if (!endpointId) {
-		throw new AmplifyError({
-			name: 'ENDPOINT_NOT_CREATED',
-			message: 'Endpoint was not created.',
-		});
-	}
+	const endpointId = await resolveEndpointId({
+		appId,
+		category,
+		channelType,
+		credentials,
+		identityId,
+		region,
+		userAgentValue,
+	});
 
 	// Generate session if required
 	if (!session) {
-		const sessionId = uuid();
+		const sessionId = amplifyUuid();
 
 		session = {
 			Id: sessionId,

package/src/providers/pinpoint/apis/updateEndpoint.ts

@@ -1,8 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { v4 as uuidv4 } from 'uuid';
-import { ClientDevice } from '../../../ClientDevice';
+import { amplifyUuid } from '../../../utils/amplifyUuid';
+import { getClientInfo } from '../../../utils/getClientInfo';
 import {
 	updateEndpoint as clientUpdateEndpoint,
 	UpdateEndpointInput,
@@ -29,7 +29,7 @@ export const updateEndpoint = async ({
 }: PinpointUpdateEndpointInput): Promise<void> => {
 	const endpointId = await getEndpointId(appId, category);
 	// only generate a new endpoint id if one was not found in cache
-	const createdEndpointId = !endpointId ? uuidv4() : undefined;
+	const createdEndpointId = !endpointId ? amplifyUuid() : undefined;
 	const {
 		customProperties,
 		demographic,
@@ -39,7 +39,7 @@ export const updateEndpoint = async ({
 		name,
 		plan,
 	} = userProfile ?? {};
-	const clientInfo = ClientDevice.clientInfo();
+	const clientInfo = getClientInfo();
 	const mergedDemographic = {
 		appVersion: clientInfo.appVersion,
 		make: clientInfo.make,
@@ -59,7 +59,7 @@ export const updateEndpoint = async ({
 		ApplicationId: appId,
 		EndpointId: endpointId ?? createdEndpointId,
 		EndpointRequest: {
-			RequestId: uuidv4(),
+			RequestId: amplifyUuid(),
 			EffectiveDate: new Date().toISOString(),
 			ChannelType: channelType,
 			Address: address,
@@ -93,6 +93,6 @@ export const updateEndpoint = async ({
 	await clientUpdateEndpoint({ credentials, region, userAgentValue }, input);
 	// if we had to create an endpoint id, we need to now cache it
 	if (!!createdEndpointId) {
-		cacheEndpointId(appId, category, createdEndpointId);
+		return cacheEndpointId(appId, category, createdEndpointId);
 	}
 };

package/src/providers/pinpoint/index.ts

@@ -2,5 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export * from './apis';
-export { PinpointAnalyticsEvent, PinpointServiceOptions } from './types';
-export { getEndpointId } from './utils';
+export {
+	PinpointAnalyticsEvent,
+	PinpointServiceOptions,
+	UpdateEndpointException,
+} from './types';
+export { resolveEndpointId } from './utils';

package/src/providers/pinpoint/types/errors.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export enum UpdateEndpointException {
+	BadRequestException = 'BadRequestException',
+	ForbiddenException = 'ForbiddenException',
+	InternalServerErrorException = 'InternalServerErrorException',
+	MethodNotAllowedException = 'MethodNotAllowedException',
+	NotFoundException = 'NotFoundException',
+	PayloadTooLargeException = 'PayloadTooLargeException',
+	TooManyRequestsException = 'TooManyRequestsException',
+}

package/src/providers/pinpoint/types/index.ts

@@ -1,4 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+export { UpdateEndpointException } from './errors';
 export * from './pinpoint';

package/src/providers/pinpoint/types/pinpoint.ts

@@ -6,10 +6,11 @@ import { UserProfile } from '../../../types';
 
 export type SupportedCategory =
 	| 'Analytics'
+	| 'Core'
 	| 'InAppMessaging'
 	| 'PushNotification';
 
-export type SupportedChannelType = 'APNS' | 'APNS_SANDBOX' | 'GCM' | 'IN_APP';
+type SupportedChannelType = 'APNS' | 'APNS_SANDBOX' | 'GCM' | 'IN_APP';
 
 export type PinpointProviderConfig = {
 	Pinpoint?: {
@@ -39,6 +40,7 @@ export type PinpointAnalyticsEvent = {
 type PinpointCommonParameters = {
 	appId: string;
 	category: SupportedCategory;
+	channelType?: SupportedChannelType;
 	credentials: Required<AuthSession>['credentials'];
 	identityId?: AuthSession['identityId'];
 	region: string;
@@ -47,7 +49,6 @@ type PinpointCommonParameters = {
 
 export type PinpointUpdateEndpointInput = PinpointCommonParameters &
 	PinpointServiceOptions & {
-		channelType?: SupportedChannelType;
 		userId?: string;
 		userProfile?: UserProfile;
 	};

package/src/providers/pinpoint/utils/index.ts

@@ -4,3 +4,4 @@
 export { cacheEndpointId } from './cacheEndpointId';
 export { getCacheKey } from './getCacheKey';
 export { getEndpointId } from './getEndpointId';
+export { resolveEndpointId } from './resolveEndpointId';

package/src/providers/pinpoint/utils/resolveEndpointId.ts

@@ -0,0 +1,46 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { assert } from '../../../errors';
+import { AmplifyErrorCode } from '../../../types';
+import { updateEndpoint } from '../apis';
+import { PinpointUpdateEndpointInput } from '../types';
+import { getEndpointId } from './getEndpointId';
+
+/**
+ * Resolves an endpoint id from cache or prepare via updateEndpoint if one does not already exist,
+ * which will generate and cache an endpoint id between calls.
+ *
+ * @internal
+ */
+export const resolveEndpointId = async ({
+	address,
+	appId,
+	category,
+	channelType,
+	credentials,
+	identityId,
+	region,
+	userAgentValue,
+}: PinpointUpdateEndpointInput) => {
+	let endpointId = await getEndpointId(appId, category);
+
+	if (!endpointId) {
+		await updateEndpoint({
+			address,
+			appId,
+			category,
+			channelType,
+			credentials,
+			identityId,
+			region,
+			userAgentValue,
+		});
+
+		endpointId = await getEndpointId(appId, category);
+	}
+
+	assert(!!endpointId, AmplifyErrorCode.NoEndpointId);
+
+	return endpointId;
+};

package/src/singleton/Amplify.ts

@@ -4,24 +4,23 @@ import { AuthClass } from './Auth';
 import { Hub, AMPLIFY_SYMBOL } from '../Hub';
 import { LegacyConfig, LibraryOptions, ResourcesConfig } from './types';
 import { parseAWSExports } from '../parseAWSExports';
-
-// TODO(v6): add default AuthTokenStore for each platform
+import { deepFreeze } from '../utils';
 
 export class AmplifyClass {
 	resourcesConfig: ResourcesConfig;
 	libraryOptions: LibraryOptions;
+
 	/**
 	 * Cross-category Auth utilities.
 	 *
 	 * @internal
 	 */
 	public readonly Auth: AuthClass;
+
 	constructor() {
 		this.resourcesConfig = {};
-		this.Auth = new AuthClass();
-
-		// TODO(v6): add default providers for getting started
 		this.libraryOptions = {};
+		this.Auth = new AuthClass();
 	}
 
 	/**
@@ -55,6 +54,9 @@ export class AmplifyClass {
 			libraryOptions
 		);
 
+		// Make resource config immutable
+		this.resourcesConfig = deepFreeze(this.resourcesConfig);
+
 		this.Auth.configure(this.resourcesConfig.Auth!, this.libraryOptions.Auth);
 
 		Hub.dispatch(
@@ -71,10 +73,10 @@ export class AmplifyClass {
 	/**
 	 * Provides access to the current back-end resource configuration for the Library.
 	 *
-	 * @returns Returns the current back-end resource configuration.
+	 * @returns Returns the immutable back-end resource configuration.
 	 */
-	getConfig(): ResourcesConfig {
-		return JSON.parse(JSON.stringify(this.resourcesConfig));
+	getConfig(): Readonly<ResourcesConfig> {
+		return this.resourcesConfig;
 	}
 }
 

package/src/singleton/Auth/types.ts

@@ -113,12 +113,12 @@ export type AuthIdentityPoolConfig = {
 	Cognito: CognitoIdentityPoolConfig & {
 		userPoolClientId?: never;
 		userPoolId?: never;
+		userPoolEndpoint?: never;
 		loginWith?: never;
 		signUpVerificationMethod?: never;
 		userAttributes?: never;
 		mfa?: never;
 		passwordFormat?: never;
-		endpoint?: never;
 	};
 };
 
@@ -137,6 +137,7 @@ export type AuthUserPoolConfig = {
 export type CognitoUserPoolConfig = {
 	userPoolClientId: string;
 	userPoolId: string;
+	userPoolEndpoint?: string;
 	signUpVerificationMethod?: 'code' | 'link';
 	loginWith?: {
 		oauth?: OAuthConfig;
@@ -157,7 +158,6 @@ export type CognitoUserPoolConfig = {
 		requireNumbers?: boolean;
 		requireSpecialCharacters?: boolean;
 	};
-	endpoint?: string;
 };
 
 export type OAuthConfig = {
@@ -217,7 +217,7 @@ export type AWSCredentialsAndIdentityId = {
 	identityId?: string;
 };
 
-type AWSCredentials = {
+export type AWSCredentials = {
 	accessKeyId: string;
 	secretAccessKey: string;
 	sessionToken?: string;

package/src/singleton/Cache/types.ts

@@ -0,0 +1,27 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Cache instance options
+ */
+export interface CacheConfig {
+	/** Prepend to key to avoid conflicts */
+	keyPrefix: string;
+
+	/** Cache capacity, in bytes */
+	capacityInBytes: number;
+
+	/** Max size of one item */
+	itemMaxSize: number;
+
+	/** Time to live, in milliseconds */
+	defaultTTL: number;
+
+	/** Warn when over threshold percentage of capacity, maximum 1 */
+	warningThreshold: number;
+
+	/** default priority number put on cached items */
+	defaultPriority: number;
+
+	storage?: Storage;
+}