@aws-amplify/core 5.8.2 → 6.0.1-console-preview.7919075.0

package/src/singleton/index.ts

@@ -0,0 +1,144 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AuthClass } from './Auth';
+import { Hub } from '../Hub';
+import { LibraryOptions, ResourcesConfig } from './types';
+import { AmplifyError } from '../Errors';
+import { FetchAuthSessionOptions } from './Auth/types';
+
+// TODO(v6): add default AuthTokenStore for each platform
+
+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 = {
+			Auth: {
+				tokenProvider: {
+					getTokens: () => {
+						throw new AmplifyError({
+							message: 'No tokenProvider provided',
+							name: 'MissingTokenProvider',
+							recoverySuggestion:
+								'Make sure to call Amplify.configure in your app with a tokenProvider',
+						});
+					},
+				},
+			},
+		};
+	}
+
+	/**
+	 * Configures Amplify for use with your back-end resources.
+	 *
+	 * @remarks
+	 * `configure` can be used to specify additional library options where available for supported categories.
+	 *
+	 * @param resourceConfig - Back-end resource configuration. Typically provided via the `aws-exports.js` file.
+	 * @param libraryOptions - Additional options for customizing the behavior of the library.
+	 */
+	configure(
+		resourcesConfig: ResourcesConfig,
+		libraryOptions: LibraryOptions = {}
+	): void {
+		this.resourcesConfig = mergeResourceConfig(
+			this.resourcesConfig,
+			resourcesConfig
+		);
+
+		this.libraryOptions = mergeLibraryOptions(
+			this.libraryOptions,
+			libraryOptions
+		);
+
+		this.Auth.configure(this.resourcesConfig.Auth!, this.libraryOptions.Auth);
+
+		Hub.dispatch(
+			'core',
+			{
+				event: 'configure',
+				data: resourcesConfig,
+			},
+			'Configure'
+		);
+	}
+
+	/**
+	 * Provides access to the current back-end resource configuration for the Library.
+	 *
+	 * @returns Returns the current back-end resource configuration.
+	 */
+	getConfig(): ResourcesConfig {
+		return JSON.parse(JSON.stringify(this.resourcesConfig));
+	}
+}
+
+/**
+ * The `Amplify` utility is used to configure the library.
+ *
+ * @remarks
+ * `Amplify` is responsible for orchestrating cross-category communication within the library.
+ */
+export const AmplifyV6 = new AmplifyClass();
+
+/**
+ * Returns current session tokens and credentials
+ *
+ * @param options{FetchAuthSessionOptions} - Options for fetching session.
+ *
+ * @returns Returns a promise that will resolve with fresh authentication tokens.
+ */
+export const fetchAuthSession = (options: FetchAuthSessionOptions) => {
+	return AmplifyV6.Auth.fetchAuthSession(options);
+};
+
+// TODO(v6): validate until which level this will nested, during Amplify.configure API review.
+function mergeResourceConfig(
+	existingConfig: ResourcesConfig,
+	newConfig: ResourcesConfig
+): ResourcesConfig {
+	const resultConfig: Record<string, any> = {};
+
+	for (const category of Object.keys(existingConfig)) {
+		resultConfig[category] = existingConfig[category as keyof ResourcesConfig];
+	}
+
+	for (const category of Object.keys(newConfig)) {
+		resultConfig[category] = {
+			...resultConfig[category],
+			...newConfig[category as keyof ResourcesConfig],
+		};
+	}
+
+	return resultConfig;
+}
+
+function mergeLibraryOptions(
+	existingConfig: LibraryOptions,
+	newConfig: LibraryOptions
+): LibraryOptions {
+	const resultConfig: Record<string, any> = {};
+
+	for (const category of Object.keys(existingConfig)) {
+		resultConfig[category] = existingConfig[category as keyof LibraryOptions];
+	}
+
+	for (const category of Object.keys(newConfig)) {
+		resultConfig[category] = {
+			...resultConfig[category],
+			...newConfig[category as keyof LibraryOptions],
+		};
+	}
+
+	return resultConfig;
+}

package/src/singleton/types.ts

@@ -0,0 +1,48 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AuthConfig,
+	LibraryAuthOptions,
+	UserPoolConfig,
+	IdentityPoolConfig,
+	UserPoolConfigAndIdentityPoolConfig,
+	GetCredentialsOptions,
+} from './Auth/types';
+import {
+	LibraryStorageOptions,
+	StorageAccessLevel,
+	StorageConfig,
+} from './Storage/types';
+import {
+	CacheConfig
+} from '../Cache/types';
+import { I18nOptions } from '../I18n/types';
+
+export type ResourcesConfig = {
+	API?: {};
+	Analytics?: {};
+	Auth?: AuthConfig;
+	Cache?: CacheConfig;
+	DataStore?: {};
+	I18n?: I18nOptions;
+	Interactions?: {};
+	Notifications?: {};
+	Predictions?: {};
+	Storage?: StorageConfig;
+};
+
+export type LibraryOptions = {
+	Auth?: LibraryAuthOptions;
+	Storage?: LibraryStorageOptions;
+};
+
+export {
+	AuthConfig,
+	UserPoolConfig,
+	IdentityPoolConfig,
+	UserPoolConfigAndIdentityPoolConfig,
+	GetCredentialsOptions,
+	StorageAccessLevel,
+	StorageConfig,
+};

package/src/types/types.ts

@@ -1,5 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+
 import { InputLogEvent, LogGroup } from '@aws-sdk/client-cloudwatch-logs';
 import { Credentials } from '@aws-sdk/types';
 
@@ -35,7 +36,7 @@ export interface ICredentials {
 export type DelayFunction = (
 	attempt: number,
 	args?: any[],
-	error?: Error
+	error?: unknown
 ) => number | false;
 
 export interface LoggingProvider {
@@ -65,3 +66,39 @@ export interface CloudWatchDataTracker {
 	logEvents: InputLogEvent[];
 	verifiedLogGroup?: LogGroup;
 }
+
+export type ErrorParams = {
+	message: string;
+	name: string;
+	recoverySuggestion?: string;
+	underlyingError?: Error | unknown;
+};
+
+export type AmplifyErrorMap<ErrorCode extends string> = {
+	[name in ErrorCode]: {
+		message: string;
+		recoverySuggestion?: string;
+	};
+};
+
+export type ServiceError = {
+	name: string;
+	message: string;
+};
+
+export interface KeyValueStorageInterface {
+	setItem(key: string, value: string): Promise<void>;
+	getItem(key: string): Promise<string | null>;
+	removeItem(key: string): Promise<void>;
+	clear(): Promise<void>;
+}
+
+export type SameSite = 'strict' | 'lax' | 'none';
+
+export type CookieStorageData = {
+	domain?: string;
+	path?: string;
+	expires?: number;
+	secure?: boolean;
+	sameSite?: SameSite;
+};