@aws-amplify/auth 5.6.4-user-agent-backup.c6dfb36.0 → 5.6.5-api-v6.26fa5d0.0

package/lib/Auth.d.ts

@@ -1,14 +1,32 @@
-import { FederatedResponse, SignUpParams, FederatedUser, ConfirmSignUpOptions, SignOutOpts, CurrentUserOpts, GetPreferredMFAOpts, SignInOpts, FederatedSignInOptionsCustom, LegacyProvider, FederatedSignInOptions, ClientMetaData } from './types';
+import { AuthOptions, FederatedResponse, SignUpParams, FederatedUser, ConfirmSignUpOptions, SignOutOpts, CurrentUserOpts, GetPreferredMFAOpts, SignInOpts, FederatedSignInOptionsCustom, LegacyProvider, FederatedSignInOptions, ClientMetaData } from './types';
 import { ICredentials } from '@aws-amplify/core';
-import { ISignUpResult, CognitoUser, MFAOption, CognitoUserSession, CognitoUserAttribute } from 'amazon-cognito-identity-js';
+import { ISignUpResult, CognitoUser, MFAOption, CognitoUserSession, CognitoUserAttribute, NodeCallback } from 'amazon-cognito-identity-js';
 import { AuthError } from './Errors';
 import { IAuthDevice } from './types/Auth';
-import { InternalAuthClass } from './internals/InternalAuth';
 /**
  * Provide authentication steps
  */
-export declare class AuthClass extends InternalAuthClass {
+export declare class AuthClass {
+    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
@@ -16,6 +34,10 @@ export declare class AuthClass extends InternalAuthClass {
      * @return - A promise resolves callback data if success
      */
     signUp(params: string | SignUpParams, ...restOfAttrs: string[]): 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
@@ -24,6 +46,7 @@ export declare class AuthClass extends InternalAuthClass {
      * @return - A promise resolves callback data if success
      */
     confirmSignUp(username: string, code: string, options?: ConfirmSignUpOptions): Promise<any>;
+    private isTrueStorageValue;
     /**
      * Resend the verification code
      * @param {String} username - The username to be confirmed
@@ -39,6 +62,28 @@ export declare class AuthClass extends InternalAuthClass {
      * @return - A promise resolves the CognitoUser
      */
     signIn(usernameOrSignInOpts: string | SignInOpts, pw?: string, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>;
+    /**
+     * Return an object with the authentication callbacks
+     * @param {CognitoUser} 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
+     * @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
+     * @return - A promise resolves the CognitoUser 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
@@ -54,6 +99,8 @@ export declare class AuthClass extends InternalAuthClass {
      * @param {GetPreferredMFAOpts} params - options for getting the current user preferred MFA
      */
     getPreferredMFA(user: CognitoUser | any, params?: GetPreferredMFAOpts): Promise<string>;
+    private _getMfaTypeFromUserData;
+    private _getUserData;
     /**
      * set preferred MFA method
      * @param {CognitoUser} user - the current Cognito user
@@ -118,6 +165,7 @@ export declare class AuthClass extends InternalAuthClass {
      * @return {Promise}
      **/
     updateUserAttributes(user: CognitoUser | any, attributes: object, clientMetadata?: ClientMetaData): Promise<string>;
+    private createUpdateAttributesResultList;
     /**
      * Return user attributes
      * @param {Object} user - The CognitoUser object
@@ -128,11 +176,22 @@ export declare class AuthClass extends InternalAuthClass {
         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
      * @return - A promise resolves to current authenticated CognitoUser if success
      */
     currentUserPoolUser(params?: CurrentUserOpts): Promise<CognitoUser | any>;
+    private isOAuthInProgress;
     /**
      * Get current authenticated user
      * @param {CurrentUserOpts} - options for getting the current user
@@ -144,6 +203,7 @@ export declare class AuthClass extends InternalAuthClass {
      * @return - A promise resolves to session object if success
      */
     currentSession(): Promise<CognitoUserSession>;
+    private _userSession;
     /**
      * Get the corresponding user session
      * @param {Object} user - The CognitoUser object
@@ -179,12 +239,17 @@ export declare class AuthClass extends InternalAuthClass {
      * @return - A promise resolves to callback data if success
      */
     verifyCurrentUserAttributeSubmit(attr: string, code: string): Promise<string>;
+    private cognitoIdentitySignOut;
+    private oAuthSignOutRedirect;
+    private oAuthSignOutAndResolve;
+    private oAuthSignOutRedirectOrReject;
     /**
      * Sign out method
      * @
      * @return - A promise resolved if success
      */
     signOut(opts?: SignOutOpts): Promise<any>;
+    private cleanCachedItems;
     /**
      * Change a password for an authenticated user
      * @param {Object} user - The CognitoUser object
@@ -216,12 +281,24 @@ export declare class AuthClass extends InternalAuthClass {
     federatedSignIn(options?: FederatedSignInOptions): Promise<ICredentials>;
     federatedSignIn(provider: LegacyProvider, response: FederatedResponse, user: FederatedUser): Promise<ICredentials>;
     federatedSignIn(options?: FederatedSignInOptionsCustom): 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(): Promise<string | AuthError>;
     forgetDevice(): Promise<void>;
     fetchDevices(): Promise<IAuthDevice[]>;