@aws-amplify/auth 5.6.4-user-agent-backup.c6dfb36.0 → 5.6.4

package/src/OAuth/OAuth.ts

@@ -117,7 +117,7 @@ export default class OAuth {
 		this._urlOpener(URL, redirectSignIn);
 	}
 
-	private async _handleCodeFlow(currentUrl: string, userAgentValue?: string) {
+	private async _handleCodeFlow(currentUrl: string) {
 		/* Convert URL into an object with parameters as keys
     { redirect_uri: 'http://localhost:3000/', response_type: 'code', ...} */
 		const { code } = (parse(currentUrl).query || '')
@@ -169,12 +169,17 @@ export default class OAuth {
 			.map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
 			.join('&');
 
+		const customUserAgentDetails: CustomUserAgentDetails = {
+			category: Category.Auth,
+			action: AuthAction.FederatedSignIn,
+		};
+
 		const { access_token, refresh_token, id_token, error } = await (
 			(await fetch(oAuthTokenEndpoint, {
 				method: 'POST',
 				headers: {
 					'Content-Type': 'application/x-www-form-urlencoded',
-					[USER_AGENT_HEADER]: userAgentValue,
+					[USER_AGENT_HEADER]: getAmplifyUserAgent(customUserAgentDetails),
 				},
 				body,
 			})) as any
@@ -212,10 +217,7 @@ export default class OAuth {
 		};
 	}
 
-	public async handleAuthResponse(
-		currentUrl?: string,
-		userAgentValue?: string
-	) {
+	public async handleAuthResponse(currentUrl?: string) {
 		try {
 			const urlParams = currentUrl
 				? ({
@@ -242,10 +244,7 @@ export default class OAuth {
 				`Starting ${this._config.responseType} flow with ${currentUrl}`
 			);
 			if (this._config.responseType === 'code') {
-				return {
-					...(await this._handleCodeFlow(currentUrl, userAgentValue)),
-					state,
-				};
+				return { ...(await this._handleCodeFlow(currentUrl)), state };
 			} else {
 				return { ...(await this._handleImplicitFlow(currentUrl)), state };
 			}

package/internals/package.json

@@ -1,8 +0,0 @@
-{
-	"name": "@aws-amplify/auth/internals",
-	"types": "../lib-esm/internals/index.d.ts",
-	"main": "../lib/internals/index.js",
-	"module": "../lib-esm/internals/index.js",
-	"react-native": "../lib-esm/internals/index.js",
-	"sideEffects": false
-}

package/lib/internals/InternalAuth.d.ts

@@ -1,353 +0,0 @@
-import { AuthOptions, FederatedResponse, SignUpParams, FederatedUser, ConfirmSignUpOptions, SignOutOpts, CurrentUserOpts, GetPreferredMFAOpts, SignInOpts, FederatedSignInOptionsCustom, LegacyProvider, FederatedSignInOptions, ClientMetaData } from '../types';
-import { CustomUserAgentDetails, ICredentials } from '@aws-amplify/core';
-import { ISignUpResult, CognitoUser, MFAOption, CognitoUserSession, CognitoUserAttribute, NodeCallback } from 'amazon-cognito-identity-js';
-import { AuthError } from '../Errors';
-import { IAuthDevice } from '../types/Auth';
-/**
- * Provide authentication steps
- */
-export declare class InternalAuthClass {
-    private _config;
-    private userPool;
-    private user;
-    private _oAuthHandler;
-    private _storage;
-    private _storageSync;
-    private oAuthFlowInProgress;
-    private pendingSignIn;
-    private autoSignInInitiated;
-    private inflightSessionPromise;
-    private inflightSessionPromiseCounter;
-    Credentials: import("@aws-amplify/core").CredentialsClass;
-    /**
-     * Initialize Auth with AWS configurations
-     * @param {Object} config - Configuration of the Auth
-     */
-    constructor(config: AuthOptions);
-    getModuleName(): string;
-    configure(config?: any): AuthOptions;
-    wrapRefreshSessionCallback: (callback: NodeCallback<Error, any>) => NodeCallback<Error, any>;
-    /**
-     * Sign up with username, password and other attributes like phone, email
-     * @param {String | object} params - The user attributes used for signin
-     * @param {String[]} restOfAttrs - for the backward compatability
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves callback data if success
-     */
-    signUp(params: string | SignUpParams, ...restOfAttrs: any): Promise<ISignUpResult>;
-    private handleAutoSignIn;
-    private handleCodeAutoSignIn;
-    private handleLinkAutoSignIn;
-    private signInAfterUserConfirmed;
-    /**
-     * Send the verification code to confirm sign up
-     * @param {String} username - The username to be confirmed
-     * @param {String} code - The verification code
-     * @param {ConfirmSignUpOptions} options - other options for confirm signup
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves callback data if success
-     */
-    confirmSignUp(username: string, code: string, options?: ConfirmSignUpOptions, customUserAgentDetails?: CustomUserAgentDetails): Promise<any>;
-    private isTrueStorageValue;
-    /**
-     * Resend the verification code
-     * @param {String} username - The username to be confirmed
-     * @param {ClientMetadata} clientMetadata - Metadata to be passed to Cognito Lambda triggers
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves code delivery details if successful
-     */
-    resendSignUp(username: string, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<any>;
-    /**
-     * Sign in
-     * @param {String | SignInOpts} usernameOrSignInOpts - The username to be signed in or the sign in options
-     * @param {String} pw - The password of the username
-     * @param {ClientMetaData} clientMetadata - Client metadata for custom workflows
-     * @return - A promise resolves the CognitoUser
-     */
-    signIn(usernameOrSignInOpts: string | SignInOpts, pw?: string, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUser | any>;
-    /**
-     * Return an object with the authentication callbacks
-     * @param {InternalCognitoUser} user - the cognito user object
-     * @param {} resolve - function called when resolving the current step
-     * @param {} reject - function called when rejecting the current step
-     * @return - an object with the callback methods for user authentication
-     */
-    private authCallbacks;
-    /**
-     * Sign in with a password
-     * @private
-     * @param {AuthenticationDetails} authDetails - the user sign in data
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves the CognitoUser object if success or mfa required
-     */
-    private signInWithPassword;
-    /**
-     * Sign in without a password
-     * @private
-     * @param {AuthenticationDetails} authDetails - the user sign in data
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves the InternalCognitoUser object if success or mfa required
-     */
-    private signInWithoutPassword;
-    /**
-     * This was previously used by an authenticated user to get MFAOptions,
-     * but no longer returns a meaningful response. Refer to the documentation for
-     * how to setup and use MFA: https://docs.amplify.aws/lib/auth/mfa/q/platform/js
-     * @deprecated
-     * @param {CognitoUser} user - the current user
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves the current preferred mfa option if success
-     */
-    getMFAOptions(user: CognitoUser | any, customUserAgentDetails?: CustomUserAgentDetails): Promise<MFAOption[]>;
-    /**
-     * get preferred mfa method
-     * @param {CognitoUser} user - the current cognito user
-     * @param {GetPreferredMFAOpts} params - options for getting the current user preferred MFA
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     */
-    getPreferredMFA(user: CognitoUser | any, params?: GetPreferredMFAOpts, customUserAgentDetails?: CustomUserAgentDetails): Promise<string>;
-    private _getMfaTypeFromUserData;
-    private _getUserData;
-    /**
-     * set preferred MFA method
-     * @param {CognitoUser} user - the current Cognito user
-     * @param {string} mfaMethod - preferred mfa method
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolve if success
-     */
-    setPreferredMFA(user: CognitoUser | any, mfaMethod: 'TOTP' | 'SMS' | 'NOMFA' | 'SMS_MFA' | 'SOFTWARE_TOKEN_MFA', customUserAgentDetails?: CustomUserAgentDetails): Promise<string>;
-    /**
-     * disable SMS
-     * @deprecated
-     * @param {CognitoUser} user - the current user
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves is success
-     */
-    disableSMS(user: CognitoUser, customUserAgentDetails?: CustomUserAgentDetails): Promise<string>;
-    /**
-     * enable SMS
-     * @deprecated
-     * @param {CognitoUser} user - the current user
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves is success
-     */
-    enableSMS(user: CognitoUser, customUserAgentDetails?: CustomUserAgentDetails): Promise<string>;
-    /**
-     * Setup TOTP
-     * @param {CognitoUser} user - the current user
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves with the secret code if success
-     */
-    setupTOTP(user: CognitoUser | any, customUserAgentDetails?: CustomUserAgentDetails): Promise<string>;
-    /**
-     * verify TOTP setup
-     * @param {CognitoUser} user - the current user
-     * @param {string} challengeAnswer - challenge answer
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves is success
-     */
-    verifyTotpToken(user: CognitoUser | any, challengeAnswer: string, customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUserSession>;
-    /**
-     * Send MFA code to confirm sign in
-     * @param {Object} user - The CognitoUser object
-     * @param {String} code - The confirmation code
-     * @param {string} mfaType - optional mfaType: 'SMS_MFA' | 'SOFTWARE_TOKEN_MFA'
-     * @param {ClientMetaData} clientMetadata - optional client metadata defaults to config
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     */
-    confirmSignIn(user: CognitoUser | any, code: string, mfaType?: 'SMS_MFA' | 'SOFTWARE_TOKEN_MFA' | null, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUser | any>;
-    completeNewPassword(user: CognitoUser | any, password: string, requiredAttributes?: any, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUser | any>;
-    /**
-     * Send the answer to a custom challenge
-     * @param {CognitoUser} user - The CognitoUser object
-     * @param {String} challengeResponses - The confirmation code
-     * @param {ClientMetaData} clientMetadata - optional client metadata defaults to config
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     *
-     */
-    sendCustomChallengeAnswer(user: CognitoUser | any, challengeResponses: string, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUser | any>;
-    /**
-     * Delete an authenticated users' attributes
-     * @param {CognitoUser} user - The currently logged in user object
-     * @param {string[]} attributeNames - Attributes to delete
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return {Promise}
-     **/
-    deleteUserAttributes(user: CognitoUser | any, attributeNames: string[], customUserAgentDetails?: CustomUserAgentDetails): Promise<unknown>;
-    /**
-     * Delete the current authenticated user
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return {Promise}
-     **/
-    deleteUser(customUserAgentDetails?: CustomUserAgentDetails): Promise<string | void>;
-    /**
-     * Update an authenticated users' attributes
-     * @param {CognitoUser} user - The currently logged in user object
-     * @param {object} attributes - attributes to update
-     * @param {ClientMetaData} clientMetadata - optional client metadata, defaults to config
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return {Promise}
-     **/
-    updateUserAttributes(user: CognitoUser | any, attributes: object, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<string>;
-    private createUpdateAttributesResultList;
-    /**
-     * Return user attributes
-     * @param {Object} user - The CognitoUser object
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves to user attributes if success
-     */
-    userAttributes(user: CognitoUser | any, customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUserAttribute[]>;
-    private _userAttributes;
-    verifiedContact(user: CognitoUser | any, customUserAgentDetails?: CustomUserAgentDetails): Promise<{
-        verified: {};
-        unverified: {};
-    }>;
-    private isErrorWithMessage;
-    private isTokenRevokedError;
-    private isRefreshTokenRevokedError;
-    private isUserDisabledError;
-    private isUserDoesNotExistError;
-    private isRefreshTokenExpiredError;
-    private isPasswordResetRequiredError;
-    private isSignedInHostedUI;
-    private isSessionInvalid;
-    private cleanUpInvalidSession;
-    /**
-     * Get current authenticated user
-     * @param {CurrentUserOpts} params - options for getting the current user
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves to current authenticated CognitoUser if success
-     */
-    currentUserPoolUser(params?: CurrentUserOpts, customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUser | any>;
-    private _currentUserPoolUser;
-    private isOAuthInProgress;
-    /**
-     * Get current authenticated user
-     * @param {CurrentUserOpts} - options for getting the current user
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves to current authenticated CognitoUser if success
-     */
-    currentAuthenticatedUser(params?: CurrentUserOpts, customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUser | any>;
-    private _currentAuthenticatedUser;
-    /**
-     * Get current user's session
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves to session object if success
-     */
-    currentSession(customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUserSession>;
-    private _currentSession;
-    private _userSession;
-    /**
-     * Get the corresponding user session
-     * @param {Object} user - The CognitoUser object
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves to the session
-     */
-    userSession(user: any, customUserAgentDetails?: CustomUserAgentDetails): Promise<CognitoUserSession>;
-    /**
-     * Get authenticated credentials of current user.
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves to be current user's credentials
-     */
-    currentUserCredentials(customUserAgentDetails?: CustomUserAgentDetails): Promise<ICredentials>;
-    currentCredentials(customUserAgentDetails?: CustomUserAgentDetails): Promise<ICredentials>;
-    /**
-     * Initiate an attribute confirmation request
-     * @param {Object} user - The CognitoUser
-     * @param {Object} attr - The attributes to be verified
-     * @param {ClientMetaData} clientMetadata - optional client metadata, defaults to config
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves to callback data if success
-     */
-    verifyUserAttribute(user: CognitoUser | any, attr: string, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<void>;
-    private _verifyUserAttribute;
-    /**
-     * Confirm an attribute using a confirmation code
-     * @param {Object} user - The CognitoUser
-     * @param {Object} attr - The attribute to be verified
-     * @param {String} code - The confirmation code
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves to callback data if success
-     */
-    verifyUserAttributeSubmit(user: CognitoUser | any, attr: string, code: string, customUserAgentDetails?: CustomUserAgentDetails): Promise<string>;
-    private _verifyUserAttributeSubmit;
-    verifyCurrentUserAttribute(attr: string, customUserAgentDetails?: CustomUserAgentDetails): Promise<void>;
-    /**
-     * Confirm current user's attribute using a confirmation code
-     * @param {Object} attr - The attribute to be verified
-     * @param {String} code - The confirmation code
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves to callback data if success
-     */
-    verifyCurrentUserAttributeSubmit(attr: string, code: string, customUserAgentDetails?: CustomUserAgentDetails): Promise<string>;
-    private cognitoIdentitySignOut;
-    private oAuthSignOutRedirect;
-    private oAuthSignOutAndResolve;
-    private oAuthSignOutRedirectOrReject;
-    /**
-     * Sign out method
-     * @param {SignOutOpts} opts - options for sign out
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolved if success
-     */
-    signOut(opts?: SignOutOpts, customUserAgentDetails?: CustomUserAgentDetails): Promise<any>;
-    private cleanCachedItems;
-    /**
-     * Change a password for an authenticated user
-     * @param {Object} user - The CognitoUser object
-     * @param {String} oldPassword - the current password
-     * @param {String} newPassword - the requested new password
-     * @param {ClientMetaData} clientMetadata - optional client metadata, defaults to config
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves if success
-     */
-    changePassword(user: CognitoUser | any, oldPassword: string, newPassword: string, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<'SUCCESS'>;
-    /**
-     * Initiate a forgot password request
-     * @param {String} username - the username to change password
-     * @param {ClientMetaData} clientMetadata - optional client metadata, defaults to config
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise resolves if success
-     */
-    forgotPassword(username: string, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<any>;
-    /**
-     * Confirm a new password using a confirmation Code
-     * @param {String} username - The username
-     * @param {String} code - The confirmation code
-     * @param {String} password - The new password
-     * @param {ClientMetaData} clientMetadata - optional client metadata, defaults to config
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return - A promise that resolves if success
-     */
-    forgotPasswordSubmit(username: string, code: string, password: string, clientMetadata?: ClientMetaData, customUserAgentDetails?: CustomUserAgentDetails): Promise<string>;
-    /**
-     * Get user information
-     * @async
-     * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-     * @return {Object }- current User's information
-     */
-    currentUserInfo(customUserAgentDetails?: CustomUserAgentDetails): Promise<any>;
-    federatedSignIn(providerOrOptions: LegacyProvider | FederatedSignInOptions | FederatedSignInOptionsCustom, response?: FederatedResponse, user?: FederatedUser, customUserAgentDetails?: CustomUserAgentDetails): Promise<ICredentials>;
-    /**
-     * Used to complete the OAuth flow with or without the Cognito Hosted UI
-     * @param {String} URL - optional parameter for customers to pass in the response URL
-     */
-    private _handleAuthResponse;
-    /**
-     * Compact version of credentials
-     * @param {Object} credentials
-     * @return {Object} - Credentials
-     */
-    essentialCredentials(credentials: any): ICredentials;
-    private attributesToObject;
-    private isTruthyString;
-    private createCognitoUser;
-    private _isValidAuthStorage;
-    private noUserPoolErrorHandler;
-    private rejectAuthError;
-    private rejectNoUserPool;
-    rememberDevice(customUserAgentDetails?: CustomUserAgentDetails): Promise<string | AuthError>;
-    forgetDevice(customUserAgentDetails?: CustomUserAgentDetails): Promise<void>;
-    fetchDevices(customUserAgentDetails?: CustomUserAgentDetails): Promise<IAuthDevice[]>;
-}
-export declare const InternalAuth: InternalAuthClass;