@aws-amplify/auth 4.6.11-unstable.2 → 4.6.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/auth",
-  "version": "4.6.11-unstable.2+89bdeb1e4",
+  "version": "4.6.11",
   "description": "Auth category of aws-amplify",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -41,9 +41,9 @@
   },
   "homepage": "https://aws-amplify.github.io/",
   "dependencies": {
-    "@aws-amplify/cache": "4.0.60-unstable.2+89bdeb1e4",
-    "@aws-amplify/core": "4.7.9-unstable.2+89bdeb1e4",
-    "amazon-cognito-identity-js": "5.2.12-unstable.5+89bdeb1e4",
+    "@aws-amplify/cache": "4.0.60",
+    "@aws-amplify/core": "4.7.9",
+    "amazon-cognito-identity-js": "5.2.12",
     "crypto-js": "^4.1.1"
   },
   "devDependencies": {
@@ -95,5 +95,5 @@
     ],
     "testSequencer": "./testSequencer.js"
   },
-  "gitHead": "89bdeb1e4ec45c1a34e7dfe960b341de99906ed3"
+  "gitHead": "be5bf2dc68c9c011c3876f003c14bc98b392c82d"
 }

package/lib/Auth.d.ts

@@ -1,301 +0,0 @@
-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, NodeCallback } from 'amazon-cognito-identity-js';
-import { AuthError } from './Errors';
-import { IAuthDevice } from './types/Auth';
-/**
- * Provide authentication steps
- */
-export declare class AuthClass {
-    private _config;
-    private userPool;
-    private user;
-    private _oAuthHandler;
-    private _storage;
-    private _storageSync;
-    private oAuthFlowInProgress;
-    private pendingSignIn;
-    private autoSignInInitiated;
-    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
-     * @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
-     * @param {String} code - The verification code
-     * @param {ConfirmSignUpOptions} options - other options for confirm signup
-     * @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
-     * @param {ClientMetadata} clientMetadata - Metadata to be passed to Cognito Lambda triggers
-     * @return - A promise resolves code delivery details if successful
-     */
-    resendSignUp(username: string, clientMetadata?: ClientMetaData): 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): 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
-     * how to setup and use MFA: https://docs.amplify.aws/lib/auth/mfa/q/platform/js
-     * @deprecated
-     * @param {CognitoUser} user - the current user
-     * @return - A promise resolves the current preferred mfa option if success
-     */
-    getMFAOptions(user: CognitoUser | any): Promise<MFAOption[]>;
-    /**
-     * get preferred mfa method
-     * @param {CognitoUser} user - the current cognito user
-     * @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
-     * @param {string} mfaMethod - preferred mfa method
-     * @return - A promise resolve if success
-     */
-    setPreferredMFA(user: CognitoUser | any, mfaMethod: 'TOTP' | 'SMS' | 'NOMFA' | 'SMS_MFA' | 'SOFTWARE_TOKEN_MFA'): Promise<string>;
-    /**
-     * disable SMS
-     * @deprecated
-     * @param {CognitoUser} user - the current user
-     * @return - A promise resolves is success
-     */
-    disableSMS(user: CognitoUser): Promise<string>;
-    /**
-     * enable SMS
-     * @deprecated
-     * @param {CognitoUser} user - the current user
-     * @return - A promise resolves is success
-     */
-    enableSMS(user: CognitoUser): Promise<string>;
-    /**
-     * Setup TOTP
-     * @param {CognitoUser} user - the current user
-     * @return - A promise resolves with the secret code if success
-     */
-    setupTOTP(user: CognitoUser | any): Promise<string>;
-    /**
-     * verify TOTP setup
-     * @param {CognitoUser} user - the current user
-     * @param {string} challengeAnswer - challenge answer
-     * @return - A promise resolves is success
-     */
-    verifyTotpToken(user: CognitoUser | any, challengeAnswer: string): Promise<CognitoUserSession>;
-    /**
-     * Send MFA code to confirm sign in
-     * @param {Object} user - The CognitoUser object
-     * @param {String} code - The confirmation code
-     */
-    confirmSignIn(user: CognitoUser | any, code: string, mfaType?: 'SMS_MFA' | 'SOFTWARE_TOKEN_MFA' | null, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>;
-    completeNewPassword(user: CognitoUser | any, password: string, requiredAttributes?: any, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>;
-    /**
-     * Send the answer to a custom challenge
-     * @param {CognitoUser} user - The CognitoUser object
-     * @param {String} challengeResponses - The confirmation code
-     */
-    sendCustomChallengeAnswer(user: CognitoUser | any, challengeResponses: string, clientMetadata?: ClientMetaData): Promise<CognitoUser | any>;
-    /**
-     * Delete an authenticated users' attributes
-     * @param {CognitoUser} - The currently logged in user object
-     * @return {Promise}
-     **/
-    deleteUserAttributes(user: CognitoUser | any, attributeNames: string[]): Promise<unknown>;
-    /**
-     * Delete the current authenticated user
-     * @return {Promise}
-     **/
-    deleteUser(): Promise<string | void>;
-    /**
-     * Update an authenticated users' attributes
-     * @param {CognitoUser} - The currently logged in user object
-     * @return {Promise}
-     **/
-    updateUserAttributes(user: CognitoUser | any, attributes: object, clientMetadata?: ClientMetaData): Promise<string>;
-    /**
-     * Return user attributes
-     * @param {Object} user - The CognitoUser object
-     * @return - A promise resolves to user attributes if success
-     */
-    userAttributes(user: CognitoUser | any): Promise<CognitoUserAttribute[]>;
-    verifiedContact(user: CognitoUser | any): Promise<{
-        verified: {};
-        unverified: {};
-    }>;
-    private isErrorWithMessage;
-    private isTokenRevokedError;
-    private isRefreshTokenRevokedError;
-    private isUserDisabledError;
-    private isUserDoesNotExistError;
-    private isRefreshTokenExpiredError;
-    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
-     * @return - A promise resolves to current authenticated CognitoUser if success
-     */
-    currentAuthenticatedUser(params?: CurrentUserOpts): Promise<CognitoUser | any>;
-    /**
-     * Get current user's session
-     * @return - A promise resolves to session object if success
-     */
-    currentSession(): Promise<CognitoUserSession>;
-    /**
-     * Get the corresponding user session
-     * @param {Object} user - The CognitoUser object
-     * @return - A promise resolves to the session
-     */
-    userSession(user: any): Promise<CognitoUserSession>;
-    /**
-     * Get authenticated credentials of current user.
-     * @return - A promise resolves to be current user's credentials
-     */
-    currentUserCredentials(): Promise<ICredentials>;
-    currentCredentials(): Promise<ICredentials>;
-    /**
-     * Initiate an attribute confirmation request
-     * @param {Object} user - The CognitoUser
-     * @param {Object} attr - The attributes to be verified
-     * @return - A promise resolves to callback data if success
-     */
-    verifyUserAttribute(user: CognitoUser | any, attr: string, clientMetadata?: ClientMetaData): Promise<void>;
-    /**
-     * 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
-     * @return - A promise resolves to callback data if success
-     */
-    verifyUserAttributeSubmit(user: CognitoUser | any, attr: string, code: string): Promise<string>;
-    verifyCurrentUserAttribute(attr: string): 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
-     * @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
-     * @param {String} oldPassword - the current password
-     * @param {String} newPassword - the requested new password
-     * @return - A promise resolves if success
-     */
-    changePassword(user: CognitoUser | any, oldPassword: string, newPassword: string, clientMetadata?: ClientMetaData): Promise<'SUCCESS'>;
-    /**
-     * Initiate a forgot password request
-     * @param {String} username - the username to change password
-     * @return - A promise resolves if success
-     */
-    forgotPassword(username: string, clientMetadata?: ClientMetaData): 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
-     * @return - A promise that resolves if success
-     */
-    forgotPasswordSubmit(username: string, code: string, password: string, clientMetadata?: ClientMetaData): Promise<string>;
-    /**
-     * Get user information
-     * @async
-     * @return {Object }- current User's information
-     */
-    currentUserInfo(): Promise<any>;
-    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[]>;
-}
-export declare const Auth: AuthClass;

package/lib/Errors.d.ts

@@ -1,9 +0,0 @@
-import { AuthErrorMessages, AuthErrorTypes } from './types';
-export declare class AuthError extends Error {
-    log: string;
-    constructor(type: AuthErrorTypes);
-}
-export declare class NoUserPoolError extends AuthError {
-    constructor(type: AuthErrorTypes);
-}
-export declare const authErrorMessages: AuthErrorMessages;

package/lib/OAuth/OAuth.d.ts

@@ -1,29 +0,0 @@
-import { OAuthOpts, CognitoHostedUIIdentityProvider } from '../types/Auth';
-export default class OAuth {
-    private _urlOpener;
-    private _config;
-    private _cognitoClientId;
-    private _scopes;
-    constructor({ config, cognitoClientId, scopes, }: {
-        scopes: string[];
-        config: OAuthOpts;
-        cognitoClientId: string;
-    });
-    private isValidScopes;
-    oauthSignIn(responseType: string, domain: string, redirectSignIn: string, clientId: string, provider?: CognitoHostedUIIdentityProvider | string, customState?: string): void;
-    private _handleCodeFlow;
-    private _handleImplicitFlow;
-    handleAuthResponse(currentUrl?: string): Promise<{
-        state: string;
-        accessToken: any;
-        refreshToken: any;
-        idToken: any;
-    }>;
-    private _validateState;
-    signOut(): Promise<any>;
-    private _generateState;
-    private _generateChallenge;
-    private _base64URL;
-    private _generateRandom;
-    private _bufferToString;
-}

package/lib/OAuth/oauthStorage.d.ts

@@ -1,5 +0,0 @@
-export declare const setState: (state: string) => void;
-export declare const getState: () => string;
-export declare const setPKCE: (private_key: string) => void;
-export declare const getPKCE: () => string;
-export declare const clearAll: () => void;

package/lib/OAuth/oauthStorage.native.d.ts

@@ -1,5 +0,0 @@
-export declare const setState: (state: string) => void;
-export declare const getState: () => string;
-export declare const setPKCE: (private_key: string) => void;
-export declare const getPKCE: () => string;
-export declare const clearAll: () => void;

package/lib/OAuth/urlOpener.d.ts

@@ -1 +0,0 @@
-export declare const launchUri: (url: string) => Promise<Window>;

package/lib/OAuth/urlOpener.native.d.ts

@@ -1 +0,0 @@
-export declare const launchUri: (url: any) => any;

package/lib/common/AuthErrorStrings.d.ts

@@ -1,17 +0,0 @@
-export declare enum AuthErrorStrings {
-    DEFAULT_MSG = "Authentication Error",
-    EMPTY_EMAIL = "Email cannot be empty",
-    EMPTY_PHONE = "Phone number cannot be empty",
-    EMPTY_USERNAME = "Username cannot be empty",
-    INVALID_USERNAME = "The username should either be a string or one of the sign in types",
-    EMPTY_PASSWORD = "Password cannot be empty",
-    EMPTY_CODE = "Confirmation code cannot be empty",
-    SIGN_UP_ERROR = "Error creating account",
-    NO_MFA = "No valid MFA method provided",
-    INVALID_MFA = "Invalid MFA type",
-    EMPTY_CHALLENGE = "Challenge response cannot be empty",
-    NO_USER_SESSION = "Failed to get the session because the user is empty",
-    NETWORK_ERROR = "Network Error",
-    DEVICE_CONFIG = "Device tracking has not been configured in this User Pool",
-    AUTOSIGNIN_ERROR = "Please use your credentials to sign in"
-}

package/lib/index.d.ts

@@ -1,9 +0,0 @@
-import { Auth } from './Auth';
-import { CognitoHostedUIIdentityProvider, SignUpParams, GRAPHQL_AUTH_MODE } from './types/Auth';
-import { CognitoUser, CookieStorage, appendToCognitoUserAgent } from 'amazon-cognito-identity-js';
-import { AuthErrorStrings } from './common/AuthErrorStrings';
-/**
- * @deprecated use named import
- */
-export default Auth;
-export { Auth, CognitoUser, CookieStorage, CognitoHostedUIIdentityProvider, SignUpParams, appendToCognitoUserAgent, AuthErrorStrings, GRAPHQL_AUTH_MODE, };

package/lib/types/Auth.d.ts

@@ -1,170 +0,0 @@
-import { ICookieStorageData, ICognitoStorage } from 'amazon-cognito-identity-js';
-/**
- * Parameters for user sign up
- */
-export interface SignUpParams {
-    username: string;
-    password: string;
-    attributes?: object;
-    validationData?: {
-        [key: string]: any;
-    };
-    clientMetadata?: {
-        [key: string]: string;
-    };
-    autoSignIn?: AutoSignInOptions;
-}
-export interface AuthCache {
-    setItem(): any;
-    getItem(): any;
-    removeItem(): any;
-}
-/**
- * Auth instance options
- */
-export interface AuthOptions {
-    userPoolId?: string;
-    userPoolWebClientId?: string;
-    identityPoolId?: string;
-    region?: string;
-    mandatorySignIn?: boolean;
-    cookieStorage?: ICookieStorageData;
-    oauth?: OAuthOpts;
-    refreshHandlers?: object;
-    storage?: ICognitoStorage;
-    authenticationFlowType?: string;
-    identityPoolRegion?: string;
-    clientMetadata?: any;
-    endpoint?: string;
-    signUpVerificationMethod?: 'code' | 'link';
-}
-export declare enum CognitoHostedUIIdentityProvider {
-    Cognito = "COGNITO",
-    Google = "Google",
-    Facebook = "Facebook",
-    Amazon = "LoginWithAmazon",
-    Apple = "SignInWithApple"
-}
-export declare type LegacyProvider = 'google' | 'facebook' | 'amazon' | 'developer' | string;
-export declare type FederatedSignInOptions = {
-    provider: CognitoHostedUIIdentityProvider;
-    customState?: string;
-};
-export declare type FederatedSignInOptionsCustom = {
-    customProvider: string;
-    customState?: string;
-};
-export declare function isFederatedSignInOptions(obj: any): obj is FederatedSignInOptions;
-export declare function isFederatedSignInOptionsCustom(obj: any): obj is FederatedSignInOptionsCustom;
-export declare function hasCustomState(obj: any): boolean;
-/**
- * Details for multi-factor authentication
- */
-export interface MfaRequiredDetails {
-    challengeName: any;
-    challengeParameters: any;
-}
-/**
- * interface for federatedResponse
- */
-export interface FederatedResponse {
-    token: string;
-    identity_id?: string;
-    expires_at: number;
-}
-/**
- * interface for federatedUser
- */
-export interface FederatedUser {
-    name: string;
-    email?: string;
-    picture?: string;
-}
-export interface AwsCognitoOAuthOpts {
-    domain: string;
-    scope: Array<string>;
-    redirectSignIn: string;
-    redirectSignOut: string;
-    responseType: string;
-    options?: object;
-    urlOpener?: (url: string, redirectUrl: string) => Promise<any>;
-}
-export declare function isCognitoHostedOpts(oauth: OAuthOpts): oauth is AwsCognitoOAuthOpts;
-export interface Auth0OAuthOpts {
-    domain: string;
-    clientID: string;
-    scope: string;
-    redirectUri: string;
-    audience: string;
-    responseType: string;
-    returnTo: string;
-    urlOpener?: (url: string, redirectUrl: string) => Promise<any>;
-}
-export declare type OAuthOpts = AwsCognitoOAuthOpts | Auth0OAuthOpts;
-export interface ConfirmSignUpOptions {
-    forceAliasCreation?: boolean;
-    clientMetadata?: ClientMetaData;
-}
-export interface SignOutOpts {
-    global?: boolean;
-}
-export interface CurrentUserOpts {
-    bypassCache: boolean;
-}
-export interface GetPreferredMFAOpts {
-    bypassCache: boolean;
-}
-export declare type UsernamePasswordOpts = {
-    username: string;
-    password: string;
-    validationData?: {
-        [key: string]: any;
-    };
-};
-export declare enum AuthErrorTypes {
-    NoConfig = "noConfig",
-    MissingAuthConfig = "missingAuthConfig",
-    EmptyUsername = "emptyUsername",
-    InvalidUsername = "invalidUsername",
-    EmptyPassword = "emptyPassword",
-    EmptyCode = "emptyCode",
-    SignUpError = "signUpError",
-    NoMFA = "noMFA",
-    InvalidMFA = "invalidMFA",
-    EmptyChallengeResponse = "emptyChallengeResponse",
-    NoUserSession = "noUserSession",
-    Default = "default",
-    DeviceConfig = "deviceConfig",
-    NetworkError = "networkError",
-    AutoSignInError = "autoSignInError"
-}
-export declare type AuthErrorMessages = {
-    [key in AuthErrorTypes]: AuthErrorMessage;
-};
-export interface AuthErrorMessage {
-    message: string;
-    log?: string;
-}
-export declare type SignInOpts = UsernamePasswordOpts;
-export declare type ClientMetaData = {
-    [key: string]: string;
-} | undefined;
-export declare function isUsernamePasswordOpts(obj: any): obj is UsernamePasswordOpts;
-export interface IAuthDevice {
-    id: string;
-    name: string;
-}
-export interface AutoSignInOptions {
-    enabled: boolean;
-    clientMetaData?: ClientMetaData;
-    validationData?: {
-        [key: string]: any;
-    };
-}
-export declare enum GRAPHQL_AUTH_MODE {
-    API_KEY = "API_KEY",
-    AWS_IAM = "AWS_IAM",
-    OPENID_CONNECT = "OPENID_CONNECT",
-    AMAZON_COGNITO_USER_POOLS = "AMAZON_COGNITO_USER_POOLS",
-    AWS_LAMBDA = "AWS_LAMBDA"
-}

package/lib/types/index.d.ts

@@ -1 +0,0 @@
-export * from './Auth';

package/lib/urlListener.d.ts

@@ -1,2 +0,0 @@
-declare const _default: (callback: any) => void;
-export default _default;

package/lib/urlListener.native.d.ts

@@ -1,2 +0,0 @@
-declare const _default: (callback: any) => Promise<void>;
-export default _default;