@oneblink/apps-react 9.0.0-beta.1 → 9.0.0-beta.3

package/dist/apps/services/api/submissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"submissions.js","sourceRoot":"","sources":["../../../../src/apps/services/api/submissions.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,6BAA6B,CAAA;AAC3D,OAAO,MAAM,MAAM,cAAc,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAE9D,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,wBAAwB,MAAM,6BAA6B,CAAA;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,0BAA0B,MAAM,+BAA+B,CAAA;AAEtE,MAAM,kBAAkB,GAAG,CAAC,KAA2B,EAAE,EAAE;IACzD,OAAO,IAAI,iBAAiB,CAAC,KAAK,CAAC,OAAO,EAAE;QAC1C,KAAK,EAAE,oBAAoB;QAC3B,cAAc,EAAE,KAAK,CAAC,cAAc;KACrC,CAAC,CAAA;AACJ,CAAC,CAAA;AACD,MAAM,uBAAuB,GAAG,CAAC,KAA2B,EAAE,EAAE;IAC9D,OAAO,IAAI,iBAAiB,CAC1B,8FAA8F,EAC9F;QACE,aAAa,EAAE,IAAI;QACnB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,KAAK,CAAC,cAAc;KACrC,CACF,CAAA;AACH,CAAC,CAAA;AACD,MAAM,oBAAoB,GAAG,CAAC,KAA2B,EAAE,EAAE;IAC3D,OAAO,IAAI,iBAAiB,CAC1B,sHAAsH,EACtH;QACE,qBAAqB,EAAE,IAAI;QAC3B,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,KAAK,CAAC,cAAc;KACrC,CACF,CAAA;AACH,CAAC,CAAA;AACD,MAAM,gBAAgB,GAAG,CAAC,KAA2B,EAAE,EAAE;IACvD,OAAO,IAAI,iBAAiB,CAC1B,sJAAsJ,EACtJ;QACE,KAAK,EAAE,cAAc;QACrB,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,KAAK,CAAC,cAAc;KACrC,CACF,CAAA;AACH,CAAC,CAAA;AACD,MAAM,eAAe,GAAG,CAAC,KAA2B,EAAE,EAAE;IACtD,OAAO,IAAI,iBAAiB,CAC1B,gFAAgF,EAChF;QACE,aAAa,EAAE,KAAK;QACpB,cAAc,EAAE,KAAK,CAAC,cAAc;KACrC,CACF,CAAA;AACH,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,KAA2B,EAAE,EAAE;IAClD,IAAI,iBAAiB,CAAC,IAAI,CAAE,KAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,iBAAiB,CACzB,mKAAmK,EACnK;YACE,KAAK,EAAE,qBAAqB;YAC5B,aAAa,EAAE,KAAc;YAC7B,SAAS,EAAE,IAAI;SAChB,CACF,CAAA;IACH,CAAC;IACD,QAAQ,KAAK,CAAC,cAAc,EAAE,CAAC;QAC7B,KAAK,GAAG,CAAC,CAAC,CAAC;YACT,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAA;QAClC,CAAC;QACD,KAAK,GAAG,CAAC,CAAC,CAAC;YACT,OAAO,uBAAuB,CAAC,KAAK,CAAC,CAAA;QACvC,CAAC;QACD,KAAK,GAAG,CAAC,CAAC,CAAC;YACT,OAAO,oBAAoB,CAAC,KAAK,CAAC,CAAA;QACpC,CAAC;QACD,KAAK,GAAG,CAAC,CAAC,CAAC;YACT,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAChC,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,eAAe,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,cAA8B;AAC9B;;;GAGG;AACH,mBAA2B,EAC3B,UAA6B,EAC7B,WAAyB;;IAEzB,IAAI,CAAC;QACH,MAAM,gBAAgB,GAAG,wBAAwB,EAAE,CAAA;QAEnD,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;QAEhC,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;QACnC,OAAO,MAAM,gBAAgB,CAAC,gBAAgB,CAAC;YAC7C,mBAAmB;YACnB,UAAU,EAAE,cAAc,CAAC,UAAU;YACrC,UAAU,EAAE,cAAc,CAAC,UAAU;YACrC,MAAM,EAAE,oBAAoB,EAAE;YAC9B,SAAS,EAAE,SAAS,IAAI,SAAS;YACjC,gCAAgC,EAC9B,cAAc,CAAC,gCAAgC;YACjD,KAAK,EAAE,cAAc,CAAC,KAAK,IAAI,SAAS;YACxC,UAAU,EAAE,cAAc,CAAC,UAAU;YACrC,UAAU,EAAE,cAAc,CAAC,UAAU,IAAI,SAAS;YAClD,MAAM,EAAE,CAAA,MAAA,cAAc,CAAC,cAAc,0CAAE,IAAI,CAAC,MAAM,KAAI,SAAS;YAC/D,YAAY,EAAE,MAAA,cAAc,CAAC,cAAc,0CAAE,UAAU,CAAC,YAAY;YACpE,mBAAmB,EACjB,MAAA,MAAA,cAAc,CAAC,cAAc,0CAAE,iBAAiB,0CAAE,mBAAmB;YACvE,UAAU,EAAE,cAAc,CAAC,UAAU;YACrC,UAAU;YACV,WAAW;YACX,qBAAqB,EAAE,cAAc,CAAC,qBAAqB;SAC5D,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,WAAW,CAAC,KAA6B,CAAC,CAAA;IAClD,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,EAC3C,MAAM,EACN,YAAY,EACZ,WAAW,GAKZ;IACC,IAAI,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,8CAA8C,EAAE;YAC1D,MAAM;YACN,YAAY;SACb,CAAC,CAAA;QACF,MAAM,kBAAkB,GAAG,0BAA0B,EAAE,CAAA;QACvD,MAAM,cAAc,GAAG,MAAM,kBAAkB,CAAC,kBAAkB,CAAC;YACjE,MAAM;YACN,YAAY;YACZ,WAAW;SACZ,CAAC,CAAA;QACF,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,iBAAiB,CACzB,kFAAkF,EAClF;gBACE,KAAK,EAAE,6BAA6B;aACrC,CACF,CAAA;QACH,CAAC;QACD,OAAO,cAAc,CAAA;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAA;QAE7D,IAAI,KAAK,YAAY,iBAAiB,EAAE,CAAC;YACvC,MAAM,KAAK,CAAA;QACb,CAAC;QAED,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAE9B,IAAI,SAAS,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,iBAAiB,CACzB,yEAAyE,EACzE;gBACE,aAAa,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;gBACzD,SAAS,EAAE,IAAI;aAChB,CACF,CAAA;QACH,CAAC;QAED,IAAI,KAAK,YAAY,oBAAoB,EAAE,CAAC;YAC1C,QAAQ,KAAK,CAAC,cAAc,EAAE,CAAC;gBAC7B,KAAK,GAAG,CAAC,CAAC,CAAC;oBACT,MAAM,IAAI,iBAAiB,CACzB,gGAAgG,EAChG;wBACE,aAAa,EAAE,KAAK;wBACpB,aAAa,EAAE,IAAI;wBACnB,cAAc,EAAE,KAAK,CAAC,cAAc;qBACrC,CACF,CAAA;gBACH,CAAC;gBACD,KAAK,GAAG,CAAC,CAAC,CAAC;oBACT,MAAM,IAAI,iBAAiB,CACzB,mHAAmH,EACnH;wBACE,aAAa,EAAE,KAAK;wBACpB,qBAAqB,EAAE,IAAI;wBAC3B,cAAc,EAAE,KAAK,CAAC,cAAc;qBACrC,CACF,CAAA;gBACH,CAAC;gBACD,KAAK,GAAG,CAAC;gBACT,KAAK,GAAG,CAAC,CAAC,CAAC;oBACT,MAAM,IAAI,iBAAiB,CAAC,KAAK,CAAC,OAAO,EAAE;wBACzC,KAAK,EAAE,iBAAiB;wBACxB,cAAc,EAAE,KAAK,CAAC,cAAc;qBACrC,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,IAAI,iBAAiB,CACzB,gFAAgF,EAChF;YACE,aAAa,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;YACzD,cAAc,EACZ,KAAK,YAAY,oBAAoB;gBACnC,CAAC,CAAC,KAAK,CAAC,cAAc;gBACtB,CAAC,CAAC,SAAS;SAChB,CACF,CAAA;IACH,CAAC;AACH,CAAC","sourcesContent":["import OneBlinkAppsError from '../errors/oneBlinkAppsError'\nimport Sentry from '../../Sentry'\nimport { isOffline } from '../../offline-service'\nimport { getDeviceInformation } from '../getDeviceInformation'\nimport { FormSubmission, ProgressListener } from '../../types/submissions'\nimport { getUserToken } from '../user-token'\nimport generateOneBlinkUploader from '../generateOneBlinkUploader'\nimport { OneBlinkStorageError } from '@oneblink/storage'\nimport generateOneBlinkDownloader from '../generateOneBlinkDownloader'\n\nconst getBadRequestError = (error: OneBlinkStorageError) => {\n  return new OneBlinkAppsError(error.message, {\n    title: 'Invalid Submission',\n    httpStatusCode: error.httpStatusCode,\n  })\n}\nconst getUnauthenticatedError = (error: OneBlinkStorageError) => {\n  return new OneBlinkAppsError(\n    'The form you are attempting to complete requires authentication. Please login and try again.',\n    {\n      requiresLogin: true,\n      originalError: error,\n      httpStatusCode: error.httpStatusCode,\n    },\n  )\n}\nconst getUnauthorisedError = (error: OneBlinkStorageError) => {\n  return new OneBlinkAppsError(\n    'You do not have access to complete this form. Please contact your administrator to gain the correct level of access.',\n    {\n      requiresAccessRequest: true,\n      originalError: error,\n      httpStatusCode: error.httpStatusCode,\n    },\n  )\n}\nconst getNotFoundError = (error: OneBlinkStorageError) => {\n  return new OneBlinkAppsError(\n    'We could not find the form you are looking for. Please contact your administrator to ensure your form configuration has been completed successfully.',\n    {\n      title: 'Unknown Form',\n      originalError: error,\n      httpStatusCode: error.httpStatusCode,\n    },\n  )\n}\nconst getDefaultError = (error: OneBlinkStorageError) => {\n  return new OneBlinkAppsError(\n    'An unknown error has occurred. Please contact support if the problem persists.',\n    {\n      originalError: error,\n      httpStatusCode: error.httpStatusCode,\n    },\n  )\n}\n\nconst handleError = (error: OneBlinkStorageError) => {\n  if (/Failed to fetch/.test((error as Error).message)) {\n    throw new OneBlinkAppsError(\n      'We encountered a network related issue. Please ensure you are connected to the internet before trying again. If the problem persists, contact your administrator.',\n      {\n        title: 'Connectivity Issues',\n        originalError: error as Error,\n        isOffline: true,\n      },\n    )\n  }\n  switch (error.httpStatusCode) {\n    case 400: {\n      return getBadRequestError(error)\n    }\n    case 401: {\n      return getUnauthenticatedError(error)\n    }\n    case 403: {\n      return getUnauthorisedError(error)\n    }\n    case 404: {\n      return getNotFoundError(error)\n    }\n    default: {\n      return getDefaultError(error)\n    }\n  }\n}\n\nexport async function uploadFormSubmission(\n  formSubmission: FormSubmission,\n  /**\n   * The date and time (in ISO format) the form was completed I.e. when the user\n   * clicked the submit button\n   */\n  completionTimestamp: string,\n  onProgress?: ProgressListener,\n  abortSignal?: AbortSignal,\n) {\n  try {\n    const oneblinkUploader = generateOneBlinkUploader()\n\n    const userToken = getUserToken()\n\n    console.log('Uploading submission')\n    return await oneblinkUploader.uploadSubmission({\n      completionTimestamp,\n      submission: formSubmission.submission,\n      definition: formSubmission.definition,\n      device: getDeviceInformation(),\n      userToken: userToken || undefined,\n      previousFormSubmissionApprovalId:\n        formSubmission.previousFormSubmissionApprovalId,\n      jobId: formSubmission.jobId || undefined,\n      formsAppId: formSubmission.formsAppId,\n      externalId: formSubmission.externalId || undefined,\n      taskId: formSubmission.taskCompletion?.task.taskId || undefined,\n      taskActionId: formSubmission.taskCompletion?.taskAction.taskActionId,\n      taskGroupInstanceId:\n        formSubmission.taskCompletion?.taskGroupInstance?.taskGroupInstanceId,\n      recaptchas: formSubmission.recaptchas,\n      onProgress,\n      abortSignal,\n      formSubmissionDraftId: formSubmission.formSubmissionDraftId,\n    })\n  } catch (error) {\n    throw handleError(error as OneBlinkStorageError)\n  }\n}\n\nexport async function downloadFormSubmission({\n  formId,\n  submissionId,\n  abortSignal,\n}: {\n  formId: number\n  submissionId: string\n  abortSignal?: AbortSignal\n}) {\n  try {\n    console.log('Attempting to download form submission data:', {\n      formId,\n      submissionId,\n    })\n    const oneblinkDownloader = generateOneBlinkDownloader()\n    const submissionData = await oneblinkDownloader.downloadSubmission({\n      formId,\n      submissionId,\n      abortSignal,\n    })\n    if (!submissionData) {\n      throw new OneBlinkAppsError(\n        \"This submission has been removed based on your administrator's retention policy.\",\n        {\n          title: 'Submission Data Unavailable',\n        },\n      )\n    }\n    return submissionData\n  } catch (error) {\n    console.error('Error retrieving form submission data', error)\n\n    if (error instanceof OneBlinkAppsError) {\n      throw error\n    }\n\n    Sentry.captureException(error)\n\n    if (isOffline()) {\n      throw new OneBlinkAppsError(\n        'You are currently offline, please connect to the internet and try again',\n        {\n          originalError: error instanceof Error ? error : undefined,\n          isOffline: true,\n        },\n      )\n    }\n\n    if (error instanceof OneBlinkStorageError) {\n      switch (error.httpStatusCode) {\n        case 401: {\n          throw new OneBlinkAppsError(\n            'The submission you are attempting to view requires authentication. Please login and try again.',\n            {\n              originalError: error,\n              requiresLogin: true,\n              httpStatusCode: error.httpStatusCode,\n            },\n          )\n        }\n        case 403: {\n          throw new OneBlinkAppsError(\n            'You do not have access to submission data. Please contact your administrator to gain the correct level of access.',\n            {\n              originalError: error,\n              requiresAccessRequest: true,\n              httpStatusCode: error.httpStatusCode,\n            },\n          )\n        }\n        case 400:\n        case 404: {\n          throw new OneBlinkAppsError(error.message, {\n            title: 'Invalid Request',\n            httpStatusCode: error.httpStatusCode,\n          })\n        }\n      }\n    }\n\n    throw new OneBlinkAppsError(\n      'An unknown error has occurred. Please contact support if the problem persists.',\n      {\n        originalError: error instanceof Error ? error : undefined,\n        httpStatusCode:\n          error instanceof OneBlinkStorageError\n            ? error.httpStatusCode\n            : undefined,\n      },\n    )\n  }\n}\n"]}

package/dist/apps/services/cognito.d.ts

@@ -0,0 +1,302 @@
+import { LoginAttemptResponse } from './AWSCognitoClient';
+import { MiscTypes } from '@oneblink/types';
+interface CognitoServiceData {
+    oAuthClientId: string;
+    loginDomain: string;
+    region: string;
+    redirectUri: string;
+    logoutUri: string;
+}
+declare function init(cognitoServiceData: CognitoServiceData): void;
+/**
+ * Register a listener function that will be call when authentication tokens are
+ * updated or removed.
+ *
+ * #### Example
+ *
+ * ```js
+ * const listener = async () => {
+ *   // Check if the user is logged in still
+ *   const isLoggedIn = authService.isLoggedIn()
+ * }
+ * const deregister = await authService.registerAuthListener(listener)
+ *
+ * // When no longer needed, remember to deregister the listener
+ * deregister()
+ * ```
+ *
+ * @param listener
+ * @returns
+ */
+declare function registerAuthListener(listener: () => unknown): () => void;
+/**
+ * Create a session for a user by entering a username and password. If the user
+ * requires a password reset, the "resetPasswordCallback" property will be
+ * returned. This function should be called with the new password once entered
+ * by the user. If the user requires an MFA token, the "mfaCodeCallback"
+ * property will be returned. This function should be called with a one-time
+ * token generated from an authenticator app. The functions returned are
+ * recursive and the result from each of them is the same result from the
+ * loginUsernamePassword() function. Each time the response includes a callback,
+ * you will need to begin the process again until all callbacks are handled.
+ *
+ * #### Example
+ *
+ * ```js
+ * async function handleLoginAttemptResponse({
+ *   resetPasswordCallback,
+ *   mfaCodeCallback,
+ * }) {
+ *   // "resetPasswordCallback" will be undefined if a password reset was not required.
+ *   if (resetPasswordCallback) {
+ *     // Prompt the user to enter a new password
+ *     const newPassword = prompt(
+ *       'The password you entered was only temporary, and must be reset for security purposes. Please enter your new password below to continue.',
+ *     )
+ *     const resetPasswordResponse =
+ *       await resetPasswordCallback(newPassword)
+ *     return await handleLoginAttemptResponse(resetPasswordResponse)
+ *   }
+ *
+ *   // "mfaCodeCallback" will be undefined if MFA is not setup.
+ *   if (mfaCodeCallback) {
+ *     // Prompt the user to enter an MFA code
+ *     const code = prompt(
+ *       'Please enter a one-time code from your MFA app.',
+ *     )
+ *     const mfaCodeResponse = await mfaCodeCallback(code)
+ *     return await handleLoginAttemptResponse(mfaCodeResponse)
+ *   }
+ * }
+ *
+ * const username = 'user@email.io'
+ * const password = 'P@$5w0rd'
+ *
+ * const loginAttemptResponse = await authService.loginUsernamePassword(
+ *   username,
+ *   password,
+ * )
+ *
+ * await handleLoginAttemptResponse(loginAttemptResponse)
+ * ```
+ *
+ * @param username
+ * @param password
+ * @returns
+ */
+declare function loginUsernamePassword(username: string, password: string): Promise<LoginAttemptResponse>;
+/**
+ * Redirect the user to the login screen. Passing an `identityProvider` is
+ * optionally, it will allow users to skip the login page and be directed
+ * straight to that providers login page
+ *
+ * #### Example
+ *
+ * ```js
+ * // OPtionally pass a
+ * const identityProvider = 'Google'
+ * await authService.loginHostedUI(identityProvider)
+ * // User will be redirected to login page or promise will resolve
+ * ```
+ *
+ * @param identityProviderName
+ * @returns
+ */
+declare function loginHostedUI(identityProviderName?: string): Promise<void>;
+/**
+ * This function should be called when the user is redirected back to your app
+ * after a login attempt. It will use the query string add the redirect URL to
+ * create a session for the current user. It will return a URL as a `string`
+ * that should be redirected to within your app.
+ *
+ * #### Example
+ *
+ * ```js
+ * try {
+ *   const continueTo = await authService.handleAuthentication()
+ *   // Redirect the user back to where they were before attempting to login
+ *   window.location.href = continueTo
+ * } catch (error) {
+ *   // handle failed login attempts here.
+ * }
+ * ```
+ *
+ * @returns
+ */
+declare function handleAuthentication(): Promise<string>;
+/**
+ * Allow the currently logged in user to change their password by passing their
+ * existing password and a new password.
+ *
+ * #### Example
+ *
+ * ```js
+ * const currentPassword = 'P@$5w0rd'
+ * const newPassword = 'P@$5w0rD'
+ * await authService.changePassword(currentPassword, newPassword)
+ * ```
+ *
+ * @param existingPassword
+ * @param newPassword
+ * @returns
+ */
+declare function changePassword(existingPassword: string, newPassword: string): Promise<void>;
+/**
+ * Allow a user to start the forgot password process. The user will be emailed a
+ * temporary code that must be passed with a new password to the function
+ * returned.
+ *
+ * #### Example
+ *
+ * ```js
+ * const username = 'user@email.io'
+ * const finishForgotPassword = await authService.forgotPassword(username)
+ *
+ * // Prompt the user to enter the code and a new password
+ * const code = prompt(
+ *   'You have been emailed a verification code, please enter it here.',
+ * )
+ * const newPassword = prompt('Please enter a new password to continue.')
+ * await finishForgotPassword(code, newPassword)
+ * ```
+ *
+ * @param username
+ * @param formsAppId Used to give the resulting email sent to the user
+ *   associated forms app branding and sending address
+ * @returns
+ */
+declare function forgotPassword(username: string, 
+/**
+ * Used to give the resulting email sent to the user associated forms app
+ * branding and sending address
+ */
+formsAppId?: number): Promise<(code: string, password: string) => Promise<void>>;
+/**
+ * Redirect the user to the logout screen to clear the users session on the
+ * hosted login page. User will then be redirected to `/logout`. After being
+ * redirected back to the application, the `logout()` function should be called
+ * to clear the session data from browser storage.
+ *
+ * #### Example
+ *
+ * ```js
+ * authService.logoutHostedUI()
+ * ```
+ */
+declare function logoutHostedUI(): void;
+declare function logout(): Promise<void>;
+/**
+ * Check if the user is currently logged in
+ *
+ * #### Example
+ *
+ * ```js
+ * const isLoggedIn = authService.isLoggedIn()
+ * // handle user being logged in or not
+ * ```
+ *
+ * @returns
+ */
+declare function isLoggedIn(): boolean;
+declare function getCognitoIdToken(): Promise<string | undefined>;
+/**
+ * Get current users profile based on there Id Token payload. This will return
+ * `null` if the the current user is not logged in.
+ *
+ * #### Example
+ *
+ * ```js
+ * const profile = authService.getUserProfile()
+ * if (profile) {
+ *   // Use profile here
+ * }
+ * ```
+ *
+ * @returns
+ */
+declare function getUserProfile(): MiscTypes.UserProfile | null;
+export declare function getUsername(): string | undefined;
+/**
+ * A friendly `string` that represents the current user. Uses first name, last
+ * name, full name and username. This will return `null` the current user is not
+ * logged in.
+ *
+ * #### Example
+ *
+ * ```js
+ * const name = authService.getUserFriendlyName()
+ * if (name) {
+ *   // Display current user's name
+ * }
+ * ```
+ *
+ * @returns
+ */
+declare function getUserFriendlyName(): string | undefined;
+/**
+ * Generate a QR code link to display to a user after they have initiated MFA
+ * setup.
+ *
+ * #### Example
+ *
+ * ```js
+ * const mfaSetupQrCodeUrl = authService.generateMfaQrCodeUrl()
+ * if (mfaSetupQrCodeUrl) {
+ *   // use mfaSetupQrCodeUrl to display QR code to user
+ * }
+ * ```
+ *
+ * @returns
+ */
+declare function generateMfaQrCodeUrl(mfaSetupConfiguration: Awaited<ReturnType<typeof setupMfa>>): string | undefined;
+/**
+ * Check if MFA is enabled for this current user.
+ *
+ * #### Example
+ *
+ * ```js
+ * const isMfaEnabled = await authService.checkIsMfaEnabled()
+ * if (isMfaEnabled) {
+ *   // Allow disabling MFA
+ * } else {
+ *   // Allow enabling MFA
+ * }
+ * ```
+ *
+ * @returns
+ */
+declare function checkIsMfaEnabled(): Promise<boolean>;
+/**
+ * Disable MFA for the current user.
+ *
+ * #### Example
+ *
+ * ```js
+ * await authService.disableMfa()
+ * ```
+ *
+ * @returns
+ */
+declare function disableMfa(): Promise<void>;
+/**
+ * Setup MFA for the current user. The result will include a callback that
+ * should be called with the valid TOTP from an authenticator app.
+ *
+ * #### Example
+ *
+ * ```js
+ * const { secretCode, mfaCodeCallback } = await authService.setupMfa()
+ * // Prompt the user to enter an MFA code
+ * const code = prompt(
+ *   `Please enter a one-time code from your MFA app after creating a new entry with secret: ${secretCode}.`,
+ * )
+ * await mfaCodeCallback(code)
+ * ```
+ *
+ * @returns
+ */
+declare function setupMfa(): Promise<{
+    secretCode: string | undefined;
+    mfaCodeCallback: (code: string) => Promise<void>;
+} | undefined>;
+export { init, registerAuthListener, loginUsernamePassword, loginHostedUI, handleAuthentication, changePassword, forgotPassword, logoutHostedUI, logout, isLoggedIn, getCognitoIdToken, getUserProfile, getUserFriendlyName, LoginAttemptResponse, checkIsMfaEnabled, disableMfa, setupMfa, generateMfaQrCodeUrl, };