@oneblink/apps-react 10.3.1 → 11.0.0-beta.10

package/dist/apps/auth-service.d.ts

@@ -1,8 +1,9 @@
 import { MiscTypes } from '@oneblink/types';
 import { getIdToken, getFormsKeyId, setFormsKeyToken } from './services/forms-key';
-import { registerAuthListener, isLoggedIn, loginHostedUI, loginUsernamePassword, changePassword, forgotPassword, handleAuthentication, logoutHostedUI, getUserProfile, getUserFriendlyName, LoginAttemptResponse, checkIsMfaEnabled, disableMfa, setupMfa, generateMfaQrCodeUrl } from './services/cognito';
+import { registerAuthListener, isLoggedIn, loginHostedUI, loginUsernamePassword, changePassword, forgotPassword, handleAuthentication, logoutHostedUI, getUserProfile, getUserFriendlyName } from './services/cognito';
 import { getUserToken, setUserToken } from './services/user-token';
-export { registerAuthListener, loginHostedUI, loginUsernamePassword, handleAuthentication, logoutHostedUI, changePassword, forgotPassword, isLoggedIn, getIdToken, getUserProfile, getFormsKeyId, setFormsKeyToken, getUserToken, setUserToken, getUserFriendlyName, LoginAttemptResponse, checkIsMfaEnabled, disableMfa, setupMfa, generateMfaQrCodeUrl, };
+export { registerAuthListener, loginHostedUI, loginUsernamePassword, handleAuthentication, logoutHostedUI, changePassword, forgotPassword, isLoggedIn, getIdToken, getUserProfile, getFormsKeyId, setFormsKeyToken, getUserToken, setUserToken, getUserFriendlyName, };
+export type { LoginAttemptResponse } from './services/cognito';
 /**
  * Log the current user out and remove an data stored locally by the user e.g.
  * drafts.
@@ -33,23 +34,30 @@ export declare function init({ oAuthClientId }: {
 }): void;
 /**
  * Determine if the current user is a OneBlink App User for a OneBlink Forms
- * App. Returns `false` if the current user is not logged in.
+ * App. Returns `false` if the current user is not logged in or not authorised
+ * for the given SAML groups.
  *
  * #### Example
  *
  * ```js
- * const formsAppId = 1
- * const isAuthorised = await authService.isAuthorised(formsAppId)
+ * const isAuthorised = await authService.isAuthorised({
+ *   formsAppId: 1,
+ *   samlGroups: ['group1', 'group2'],
+ * })
  * if (!isAuthorised) {
  *   // handle unauthorised user
  * }
  * ```
  *
- * @param formsAppId
+ * @param options.formsAppId
+ * @param options.samlGroups
  * @param abortSignal
  * @returns
  */
-export declare function isAuthorised(formsAppId: number, abortSignal?: AbortSignal): Promise<boolean>;
+export declare function isAuthorised({ formsAppId, samlGroups }: {
+    formsAppId: number;
+    samlGroups?: string[];
+}, abortSignal?: AbortSignal): Promise<boolean>;
 /**
  * Get the current user's App User details for a OneBlink Forms App. Returns
  * `undefined` if the current user is not logged in.

package/dist/apps/auth-service.js

@@ -1,11 +1,11 @@
 import OneBlinkAppsError from './services/errors/oneBlinkAppsError';
 import { getIdToken, getFormsKeyId, setFormsKeyToken, } from './services/forms-key';
-import { init as initCognito, registerAuthListener, isLoggedIn, loginHostedUI, loginUsernamePassword, changePassword, forgotPassword, handleAuthentication, logoutHostedUI, logout as logoutCognito, getUserProfile, getUsername, getUserFriendlyName, checkIsMfaEnabled, disableMfa, setupMfa, generateMfaQrCodeUrl, } from './services/cognito';
+import { init as initCognito, registerAuthListener, isLoggedIn, loginHostedUI, loginUsernamePassword, changePassword, forgotPassword, handleAuthentication, logoutHostedUI, logout as logoutCognito, getUserProfile, getUsername, getUserFriendlyName, } from './services/cognito';
 import { getRequest, postRequest } from './services/fetch';
 import tenants from './tenants';
 import { getUserToken, setUserToken } from './services/user-token';
 import utilsService from './services/utils';
-export { registerAuthListener, loginHostedUI, loginUsernamePassword, handleAuthentication, logoutHostedUI, changePassword, forgotPassword, isLoggedIn, getIdToken, getUserProfile, getFormsKeyId, setFormsKeyToken, getUserToken, setUserToken, getUserFriendlyName, checkIsMfaEnabled, disableMfa, setupMfa, generateMfaQrCodeUrl, };
+export { registerAuthListener, loginHostedUI, loginUsernamePassword, handleAuthentication, logoutHostedUI, changePassword, forgotPassword, isLoggedIn, getIdToken, getUserProfile, getFormsKeyId, setFormsKeyToken, getUserToken, setUserToken, getUserFriendlyName, };
 import Sentry from './Sentry';
 /**
  * Log the current user out and remove an data stored locally by the user e.g.
@@ -58,25 +58,35 @@ export function init({ oAuthClientId }) {
 }
 /**
  * Determine if the current user is a OneBlink App User for a OneBlink Forms
- * App. Returns `false` if the current user is not logged in.
+ * App. Returns `false` if the current user is not logged in or not authorised
+ * for the given SAML groups.
  *
  * #### Example
  *
  * ```js
- * const formsAppId = 1
- * const isAuthorised = await authService.isAuthorised(formsAppId)
+ * const isAuthorised = await authService.isAuthorised({
+ *   formsAppId: 1,
+ *   samlGroups: ['group1', 'group2'],
+ * })
  * if (!isAuthorised) {
  *   // handle unauthorised user
  * }
  * ```
  *
- * @param formsAppId
+ * @param options.formsAppId
+ * @param options.samlGroups
  * @param abortSignal
  * @returns
  */
-export async function isAuthorised(formsAppId, abortSignal) {
+export async function isAuthorised({ formsAppId, samlGroups }, abortSignal) {
     return getCurrentFormsAppUser(formsAppId, abortSignal)
-        .then(() => true)
+        .then((userProfile) => {
+        // if no SAML groups are provided, then provided the user is authenticated then they're authorised
+        if (!samlGroups) {
+            return true;
+        }
+        return samlGroups.some((group) => userProfile === null || userProfile === void 0 ? void 0 : userProfile.groups.includes(group));
+    })
         .catch((error) => {
         if (error.status >= 400 && error.status < 500) {
             return false;

package/dist/apps/auth-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth-service.js","sourceRoot":"","sources":["../../src/apps/auth-service.ts"],"names":[],"mappings":"AACA,OAAO,iBAAiB,MAAM,qCAAqC,CAAA;AACnE,OAAO,EACL,UAAU,EACV,aAAa,EACb,gBAAgB,GACjB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EACL,IAAI,IAAI,WAAW,EACnB,oBAAoB,EACpB,UAAU,EACV,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,MAAM,IAAI,aAAa,EACvB,cAAc,EACd,WAAW,EACX,mBAAmB,EAEnB,iBAAiB,EACjB,UAAU,EACV,QAAQ,EACR,oBAAoB,GACrB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,UAAU,EAAE,WAAW,EAAa,MAAM,kBAAkB,CAAA;AACrE,OAAO,OAAO,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAClE,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EACL,oBAAoB,EACpB,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,cAAc,EACd,UAAU,EACV,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,mBAAmB,EAEnB,iBAAiB,EACjB,UAAU,EACV,QAAQ,EACR,oBAAoB,GACrB,CAAA;AACD,OAAO,MAAM,MAAM,UAAU,CAAA;AAE7B;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;IAE7B,IAAI,CAAC;QACH,MAAM,YAAY,CAAC,WAAW,CAAC,KAAK,EAAE,CAAA;IACxC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAA;IACvE,CAAC;IAED,MAAM,aAAa,EAAE,CAAA;AACvB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,IAAI,CAAC,EAAE,aAAa,EAA6B;IAC/D,WAAW,CAAC;QACV,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS;QACjC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW;QACxC,aAAa;QACb,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,WAAW;QACjD,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,SAAS;KAC9C,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,GAAG,EAAE;QACpB,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,SAAS,CAAC,CAAA;IACvD,CAAC,CAAA;IACD,QAAQ,EAAE,CAAA;IACV,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,UAAkB,EAClB,WAAyB;IAEzB,OAAO,sBAAsB,CAAC,UAAU,EAAE,WAAW,CAAC;SACnD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;SAChB,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YAC9C,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAC9B,OAAO,CAAC,GAAG,CACT,sEAAsE,EACtE,KAAK,CACN,CAAA;YACD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC,CAAC,CAAA;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,UAAkB,EAClB,WAAyB;IASzB,IAAI,aAAa,EAAE,EAAE,CAAC;QACpB,OAAO;YACL,UAAU;YACV,MAAM,EAAE,EAAE;SACX,CAAA;IACH,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,EAAE,CAAA;IAEpC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,oBAAoB,CAAA;IACrF,OAAO,MAAM,UAAU,CAIpB,GAAG,EAAE,WAAW,CAAC,CAAA;AACtB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,UAAkB;IACpD,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QAClB,MAAM,IAAI,iBAAiB,CACzB,6DAA6D,EAC7D;YACE,aAAa,EAAE,IAAI;SACpB,CACF,CAAA;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,iBAAiB,CAAA;QAClF,MAAM,WAAW,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAA;QAEjE,MAAM,IAAI,iBAAiB,CACzB,oJAAoJ,EACpJ;YACE,aAAa,EAAE,KAAc;YAC7B,KAAK,EAAE,yBAAyB;YAChC,cAAc,EAAG,KAAmB,CAAC,MAAM;SAC5C,CACF,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AAEH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,EAC3B,UAAU,EACV,KAAK,EACL,SAAS,EACT,QAAQ,GAMT;IACC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,UAAU,CAAA;QAC3E,OAAO,MAAM,WAAW,CAAC,GAAG,EAAE;YAC5B,KAAK;YACL,SAAS;YACT,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAA;QAE/D,MAAM,IAAI,iBAAiB,CACzB,4IAA4I,EAC5I;YACE,aAAa,EAAE,KAAc;YAC7B,KAAK,EAAE,kBAAkB;YACzB,cAAc,EAAG,KAAmB,CAAC,MAAM;SAC5C,CACF,CAAA;IACH,CAAC;AACH,CAAC","sourcesContent":["import { MiscTypes } from '@oneblink/types'\nimport OneBlinkAppsError from './services/errors/oneBlinkAppsError'\nimport {\n  getIdToken,\n  getFormsKeyId,\n  setFormsKeyToken,\n} from './services/forms-key'\nimport {\n  init as initCognito,\n  registerAuthListener,\n  isLoggedIn,\n  loginHostedUI,\n  loginUsernamePassword,\n  changePassword,\n  forgotPassword,\n  handleAuthentication,\n  logoutHostedUI,\n  logout as logoutCognito,\n  getUserProfile,\n  getUsername,\n  getUserFriendlyName,\n  LoginAttemptResponse,\n  checkIsMfaEnabled,\n  disableMfa,\n  setupMfa,\n  generateMfaQrCodeUrl,\n} from './services/cognito'\nimport { getRequest, postRequest, HTTPError } from './services/fetch'\nimport tenants from './tenants'\nimport { getUserToken, setUserToken } from './services/user-token'\nimport utilsService from './services/utils'\n\nexport {\n  registerAuthListener,\n  loginHostedUI,\n  loginUsernamePassword,\n  handleAuthentication,\n  logoutHostedUI,\n  changePassword,\n  forgotPassword,\n  isLoggedIn,\n  getIdToken,\n  getUserProfile,\n  getFormsKeyId,\n  setFormsKeyToken,\n  getUserToken,\n  setUserToken,\n  getUserFriendlyName,\n  LoginAttemptResponse,\n  checkIsMfaEnabled,\n  disableMfa,\n  setupMfa,\n  generateMfaQrCodeUrl,\n}\nimport Sentry from './Sentry'\n\n/**\n * Log the current user out and remove an data stored locally by the user e.g.\n * drafts.\n *\n * #### Example\n *\n * ```js\n * await authService.logout()\n * ```\n */\nexport async function logout() {\n  console.log('Logging out...')\n\n  try {\n    await utilsService.localForage.clear()\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Could not clear localForage before logging out', error)\n  }\n\n  await logoutCognito()\n}\n\n/**\n * Initialize the service with required configuration. **This must be done\n * before using before some of the function in this service.**\n *\n * #### Example\n *\n * ```js\n * authService.init({\n *   oAuthClientId: 'YOUR_OAUTH_CLIENT_ID',\n * })\n * ```\n *\n * @param options\n */\nexport function init({ oAuthClientId }: { oAuthClientId: string }) {\n  initCognito({\n    region: tenants.current.awsRegion,\n    loginDomain: tenants.current.loginDomain,\n    oAuthClientId,\n    redirectUri: window.location.origin + '/callback',\n    logoutUri: window.location.origin + '/logout',\n  })\n\n  const listener = () => {\n    Sentry.setTag('username', getUsername() || undefined)\n  }\n  listener()\n  registerAuthListener(listener)\n}\n\n/**\n * Determine if the current user is a OneBlink App User for a OneBlink Forms\n * App. Returns `false` if the current user is not logged in.\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const isAuthorised = await authService.isAuthorised(formsAppId)\n * if (!isAuthorised) {\n *   // handle unauthorised user\n * }\n * ```\n *\n * @param formsAppId\n * @param abortSignal\n * @returns\n */\nexport async function isAuthorised(\n  formsAppId: number,\n  abortSignal?: AbortSignal,\n): Promise<boolean> {\n  return getCurrentFormsAppUser(formsAppId, abortSignal)\n    .then(() => true)\n    .catch((error) => {\n      if (error.status >= 400 && error.status < 500) {\n        return false\n      } else {\n        Sentry.captureException(error)\n        console.log(\n          'Could not determine if the current user has access to this forms app',\n          error,\n        )\n        return false\n      }\n    })\n}\n\n/**\n * Get the current user's App User details for a OneBlink Forms App. Returns\n * `undefined` if the current user is not logged in.\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const formsAppUserDetails =\n *   await authService.getCurrentFormsAppUser(formsAppId)\n * if (!formsAppUserDetails) {\n *   // handle unauthorised user\n * }\n * ```\n *\n * @param formsAppId\n * @returns\n */\nexport async function getCurrentFormsAppUser(\n  formsAppId: number,\n  abortSignal?: AbortSignal,\n): Promise<\n  | {\n      userProfile?: MiscTypes.UserProfile\n      formsAppId: number\n      groups: string[]\n    }\n  | undefined\n> {\n  if (getFormsKeyId()) {\n    return {\n      formsAppId,\n      groups: [],\n    }\n  }\n\n  const userProfile = getUserProfile()\n\n  if (!userProfile) {\n    return undefined\n  }\n\n  const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/my-forms-app-user`\n  return await getRequest<{\n    userProfile?: MiscTypes.UserProfile\n    formsAppId: number\n    groups: string[]\n  }>(url, abortSignal)\n}\n\n/**\n * If the current user is not a Forms App User, this function will send a\n * request on behalf of the current user to the OneBlink Forms App\n * administrators to request access.\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * await authService.requestAccess(formsAppId)\n * // Display a message to user indicating a request has been sent to the application administrators\n * ```\n *\n * @param formsAppId\n */\nexport async function requestAccess(formsAppId: number): Promise<void> {\n  if (!isLoggedIn()) {\n    throw new OneBlinkAppsError(\n      'You must login before requesting access to this application',\n      {\n        requiresLogin: true,\n      },\n    )\n  }\n\n  try {\n    const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/request-access`\n    await postRequest(url)\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Error while requesting access to forms app', error)\n\n    throw new OneBlinkAppsError(\n      'Sorry, we could not request access automatically right now, please try again. If the problem persists, please contact your administrator yourself.',\n      {\n        originalError: error as Error,\n        title: 'Error Requesting Access',\n        httpStatusCode: (error as HTTPError).status,\n      },\n    )\n  }\n}\n\n/**\n * Allow a user to sign up to a forms app.\n *\n * #### Example\n *\n * ```js\n * await authService.signUp({\n *   formsAppId: 1,\n *   email: 'test@oneblink.io',\n *   firstName: 'first',\n *   lastName: 'last',\n * })\n * ```\n *\n * @param {formsAppId, email, generatePassword, firstName, lastName}\n * @returns\n */\n\nexport async function signUp({\n  formsAppId,\n  email,\n  firstName,\n  lastName,\n}: {\n  formsAppId: number\n  email: string\n  firstName?: string\n  lastName?: string\n}): Promise<void> {\n  try {\n    const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/sign-up`\n    return await postRequest(url, {\n      email,\n      firstName,\n      lastName,\n    })\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Error while calling sign-up to forms app', error)\n\n    throw new OneBlinkAppsError(\n      'Sorry, we could not create you a account right now, please try again. If the problem persists, please contact your administrator yourself.',\n      {\n        originalError: error as Error,\n        title: 'Error Signing up',\n        httpStatusCode: (error as HTTPError).status,\n      },\n    )\n  }\n}\n"]}
+{"version":3,"file":"auth-service.js","sourceRoot":"","sources":["../../src/apps/auth-service.ts"],"names":[],"mappings":"AACA,OAAO,iBAAiB,MAAM,qCAAqC,CAAA;AACnE,OAAO,EACL,UAAU,EACV,aAAa,EACb,gBAAgB,GACjB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EACL,IAAI,IAAI,WAAW,EACnB,oBAAoB,EACpB,UAAU,EACV,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,MAAM,IAAI,aAAa,EACvB,cAAc,EACd,WAAW,EACX,mBAAmB,GACpB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,UAAU,EAAE,WAAW,EAAa,MAAM,kBAAkB,CAAA;AACrE,OAAO,OAAO,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAClE,OAAO,YAAY,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EACL,oBAAoB,EACpB,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,cAAc,EACd,UAAU,EACV,UAAU,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,mBAAmB,GACpB,CAAA;AAED,OAAO,MAAM,MAAM,UAAU,CAAA;AAE7B;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;IAE7B,IAAI,CAAC;QACH,MAAM,YAAY,CAAC,WAAW,CAAC,KAAK,EAAE,CAAA;IACxC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAA;IACvE,CAAC;IAED,MAAM,aAAa,EAAE,CAAA;AACvB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,IAAI,CAAC,EAAE,aAAa,EAA6B;IAC/D,WAAW,CAAC;QACV,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS;QACjC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW;QACxC,aAAa;QACb,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,WAAW;QACjD,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,SAAS;KAC9C,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,GAAG,EAAE;QACpB,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,SAAS,CAAC,CAAA;IACvD,CAAC,CAAA;IACD,QAAQ,EAAE,CAAA;IACV,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,EAAE,UAAU,EAAE,UAAU,EAAiD,EACzE,WAAyB;IAEzB,OAAO,sBAAsB,CAAC,UAAU,EAAE,WAAW,CAAC;SACnD,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;QACpB,kGAAkG;QAClG,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;IACxE,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YAC9C,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAC9B,OAAO,CAAC,GAAG,CACT,sEAAsE,EACtE,KAAK,CACN,CAAA;YACD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC,CAAC,CAAA;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,UAAkB,EAClB,WAAyB;IASzB,IAAI,aAAa,EAAE,EAAE,CAAC;QACpB,OAAO;YACL,UAAU;YACV,MAAM,EAAE,EAAE;SACX,CAAA;IACH,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,EAAE,CAAA;IAEpC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,oBAAoB,CAAA;IACrF,OAAO,MAAM,UAAU,CAIpB,GAAG,EAAE,WAAW,CAAC,CAAA;AACtB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,UAAkB;IACpD,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QAClB,MAAM,IAAI,iBAAiB,CACzB,6DAA6D,EAC7D;YACE,aAAa,EAAE,IAAI;SACpB,CACF,CAAA;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,iBAAiB,CAAA;QAClF,MAAM,WAAW,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAA;QAEjE,MAAM,IAAI,iBAAiB,CACzB,oJAAoJ,EACpJ;YACE,aAAa,EAAE,KAAc;YAC7B,KAAK,EAAE,yBAAyB;YAChC,cAAc,EAAG,KAAmB,CAAC,MAAM;SAC5C,CACF,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AAEH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,EAC3B,UAAU,EACV,KAAK,EACL,SAAS,EACT,QAAQ,GAMT;IACC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,UAAU,CAAA;QAC3E,OAAO,MAAM,WAAW,CAAC,GAAG,EAAE;YAC5B,KAAK;YACL,SAAS;YACT,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAA;QAE/D,MAAM,IAAI,iBAAiB,CACzB,4IAA4I,EAC5I;YACE,aAAa,EAAE,KAAc;YAC7B,KAAK,EAAE,kBAAkB;YACzB,cAAc,EAAG,KAAmB,CAAC,MAAM;SAC5C,CACF,CAAA;IACH,CAAC;AACH,CAAC","sourcesContent":["import { MiscTypes } from '@oneblink/types'\nimport OneBlinkAppsError from './services/errors/oneBlinkAppsError'\nimport {\n  getIdToken,\n  getFormsKeyId,\n  setFormsKeyToken,\n} from './services/forms-key'\nimport {\n  init as initCognito,\n  registerAuthListener,\n  isLoggedIn,\n  loginHostedUI,\n  loginUsernamePassword,\n  changePassword,\n  forgotPassword,\n  handleAuthentication,\n  logoutHostedUI,\n  logout as logoutCognito,\n  getUserProfile,\n  getUsername,\n  getUserFriendlyName,\n} from './services/cognito'\nimport { getRequest, postRequest, HTTPError } from './services/fetch'\nimport tenants from './tenants'\nimport { getUserToken, setUserToken } from './services/user-token'\nimport utilsService from './services/utils'\n\nexport {\n  registerAuthListener,\n  loginHostedUI,\n  loginUsernamePassword,\n  handleAuthentication,\n  logoutHostedUI,\n  changePassword,\n  forgotPassword,\n  isLoggedIn,\n  getIdToken,\n  getUserProfile,\n  getFormsKeyId,\n  setFormsKeyToken,\n  getUserToken,\n  setUserToken,\n  getUserFriendlyName,\n}\nexport type { LoginAttemptResponse } from './services/cognito'\nimport Sentry from './Sentry'\n\n/**\n * Log the current user out and remove an data stored locally by the user e.g.\n * drafts.\n *\n * #### Example\n *\n * ```js\n * await authService.logout()\n * ```\n */\nexport async function logout() {\n  console.log('Logging out...')\n\n  try {\n    await utilsService.localForage.clear()\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Could not clear localForage before logging out', error)\n  }\n\n  await logoutCognito()\n}\n\n/**\n * Initialize the service with required configuration. **This must be done\n * before using before some of the function in this service.**\n *\n * #### Example\n *\n * ```js\n * authService.init({\n *   oAuthClientId: 'YOUR_OAUTH_CLIENT_ID',\n * })\n * ```\n *\n * @param options\n */\nexport function init({ oAuthClientId }: { oAuthClientId: string }) {\n  initCognito({\n    region: tenants.current.awsRegion,\n    loginDomain: tenants.current.loginDomain,\n    oAuthClientId,\n    redirectUri: window.location.origin + '/callback',\n    logoutUri: window.location.origin + '/logout',\n  })\n\n  const listener = () => {\n    Sentry.setTag('username', getUsername() || undefined)\n  }\n  listener()\n  registerAuthListener(listener)\n}\n\n/**\n * Determine if the current user is a OneBlink App User for a OneBlink Forms\n * App. Returns `false` if the current user is not logged in or not authorised\n * for the given SAML groups.\n *\n * #### Example\n *\n * ```js\n * const isAuthorised = await authService.isAuthorised({\n *   formsAppId: 1,\n *   samlGroups: ['group1', 'group2'],\n * })\n * if (!isAuthorised) {\n *   // handle unauthorised user\n * }\n * ```\n *\n * @param options.formsAppId\n * @param options.samlGroups\n * @param abortSignal\n * @returns\n */\nexport async function isAuthorised(\n  { formsAppId, samlGroups }: { formsAppId: number; samlGroups?: string[] },\n  abortSignal?: AbortSignal,\n): Promise<boolean> {\n  return getCurrentFormsAppUser(formsAppId, abortSignal)\n    .then((userProfile) => {\n      // if no SAML groups are provided, then provided the user is authenticated then they're authorised\n      if (!samlGroups) {\n        return true\n      }\n      return samlGroups.some((group) => userProfile?.groups.includes(group))\n    })\n    .catch((error) => {\n      if (error.status >= 400 && error.status < 500) {\n        return false\n      } else {\n        Sentry.captureException(error)\n        console.log(\n          'Could not determine if the current user has access to this forms app',\n          error,\n        )\n        return false\n      }\n    })\n}\n\n/**\n * Get the current user's App User details for a OneBlink Forms App. Returns\n * `undefined` if the current user is not logged in.\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const formsAppUserDetails =\n *   await authService.getCurrentFormsAppUser(formsAppId)\n * if (!formsAppUserDetails) {\n *   // handle unauthorised user\n * }\n * ```\n *\n * @param formsAppId\n * @returns\n */\nexport async function getCurrentFormsAppUser(\n  formsAppId: number,\n  abortSignal?: AbortSignal,\n): Promise<\n  | {\n      userProfile?: MiscTypes.UserProfile\n      formsAppId: number\n      groups: string[]\n    }\n  | undefined\n> {\n  if (getFormsKeyId()) {\n    return {\n      formsAppId,\n      groups: [],\n    }\n  }\n\n  const userProfile = getUserProfile()\n\n  if (!userProfile) {\n    return undefined\n  }\n\n  const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/my-forms-app-user`\n  return await getRequest<{\n    userProfile?: MiscTypes.UserProfile\n    formsAppId: number\n    groups: string[]\n  }>(url, abortSignal)\n}\n\n/**\n * If the current user is not a Forms App User, this function will send a\n * request on behalf of the current user to the OneBlink Forms App\n * administrators to request access.\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * await authService.requestAccess(formsAppId)\n * // Display a message to user indicating a request has been sent to the application administrators\n * ```\n *\n * @param formsAppId\n */\nexport async function requestAccess(formsAppId: number): Promise<void> {\n  if (!isLoggedIn()) {\n    throw new OneBlinkAppsError(\n      'You must login before requesting access to this application',\n      {\n        requiresLogin: true,\n      },\n    )\n  }\n\n  try {\n    const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/request-access`\n    await postRequest(url)\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Error while requesting access to forms app', error)\n\n    throw new OneBlinkAppsError(\n      'Sorry, we could not request access automatically right now, please try again. If the problem persists, please contact your administrator yourself.',\n      {\n        originalError: error as Error,\n        title: 'Error Requesting Access',\n        httpStatusCode: (error as HTTPError).status,\n      },\n    )\n  }\n}\n\n/**\n * Allow a user to sign up to a forms app.\n *\n * #### Example\n *\n * ```js\n * await authService.signUp({\n *   formsAppId: 1,\n *   email: 'test@oneblink.io',\n *   firstName: 'first',\n *   lastName: 'last',\n * })\n * ```\n *\n * @param {formsAppId, email, generatePassword, firstName, lastName}\n * @returns\n */\n\nexport async function signUp({\n  formsAppId,\n  email,\n  firstName,\n  lastName,\n}: {\n  formsAppId: number\n  email: string\n  firstName?: string\n  lastName?: string\n}): Promise<void> {\n  try {\n    const url = `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/sign-up`\n    return await postRequest(url, {\n      email,\n      firstName,\n      lastName,\n    })\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Error while calling sign-up to forms app', error)\n\n    throw new OneBlinkAppsError(\n      'Sorry, we could not create you a account right now, please try again. If the problem persists, please contact your administrator yourself.',\n      {\n        originalError: error as Error,\n        title: 'Error Signing up',\n        httpStatusCode: (error as HTTPError).status,\n      },\n    )\n  }\n}\n"]}

package/dist/apps/index.d.ts

@@ -21,6 +21,16 @@ export * as offlineService from './offline-service';
  * ```
  */
 export * as authService from './auth-service';
+/**
+ * ## MFA Service
+ *
+ * Helper functions for multi factor authentication and MFA requirements.
+ *
+ * ```js
+ * import { mfaService } from '@oneblink/apps-react'
+ * ```
+ */
+export * as mfaService from './mfa-service';
 /**
  * ## Draft Service
  *

package/dist/apps/index.js

@@ -21,6 +21,16 @@ export * as offlineService from './offline-service';
  * ```
  */
 export * as authService from './auth-service';
+/**
+ * ## MFA Service
+ *
+ * Helper functions for multi factor authentication and MFA requirements.
+ *
+ * ```js
+ * import { mfaService } from '@oneblink/apps-react'
+ * ```
+ */
+export * as mfaService from './mfa-service';
 /**
  * ## Draft Service
  *

package/dist/apps/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/apps/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAA;AACnD;;;;;;;;;;;GAWG;AACH,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAA;AAC7C;;;;;;;;GAQG;AACH,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAA;AAC/C;;;;;;;;GAQG;AACH,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAA;AACnD;;;;;;;;GAQG;AACH,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAA;AACnD;;;;;;;;GAQG;AACH,OAAO,KAAK,iBAAiB,MAAM,sBAAsB,CAAA;AACzD;;;;;;;;GAQG;AACH,OAAO,KAAK,UAAU,MAAM,eAAe,CAAA;AAC3C;;;;;;;;GAQG;AACH,OAAO,KAAK,iBAAiB,MAAM,sBAAsB,CAAA;AACzD;;;;;;;;GAQG;AACH,OAAO,KAAK,eAAe,MAAM,qBAAqB,CAAA;AACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,OAAO,KAAK,mBAAmB,MAAM,wBAAwB,CAAA;AAC7D;;;;;;;;GAQG;AACH,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAA;AAC7C;;;;;;;;GAQG;AACH,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAA;AACvD;;;;;;;;GAQG;AACH,OAAO,KAAK,eAAe,MAAM,qBAAqB,CAAA;AACtD;;;;;;;;GAQG;AACH,OAAO,KAAK,gBAAgB,MAAM,sBAAsB,CAAA;AACxD;;;;;;;;GAQG;AACH,OAAO,KAAK,mBAAmB,MAAM,wBAAwB,CAAA;AAC7D;;;;;;;;GAQG;AACH,OAAO,KAAK,kBAAkB,MAAM,uBAAuB,CAAA;AAC3D;;;;;;;;GAQG;AACH,OAAO,KAAK,qBAAqB,MAAM,2BAA2B,CAAA;AAClE;;;;;;;;GAQG;AACH,OAAO,KAAK,0BAA0B,MAAM,iCAAiC,CAAA;AAE7E,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qCAAqC,CAAA;AAClF,OAAO,OAAO,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,UAAU,CAAA;AAE5C,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,CAAA;AAC9D,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;AAC5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,CAAA","sourcesContent":["/**\n * ## Offline Service\n *\n * Helper functions for offline handling\n *\n * ```js\n * import { offlineService } from '@oneblink/apps-react'\n * ```\n */\nexport * as offlineService from './offline-service'\n/**\n * ## Authentication/Authorisation Service\n *\n * Helper functions for handling user authentication and authorisation.\n *\n * **NOTE: `init()` must be called before using some of the functions in this\n * service.**\n *\n * ```js\n * import { authService } from '@oneblink/apps-react'\n * ```\n */\nexport * as authService from './auth-service'\n/**\n * ## Draft Service\n *\n * Helper functions for handling drafts.\n *\n * ```js\n * import { draftService } from '@oneblink/apps-react'\n * ```\n */\nexport * as draftService from './draft-service'\n/**\n * ## Prefill Service\n *\n * Helper functions for offline handling\n *\n * ```js\n * import { prefillService } from '@oneblink/apps-react'\n * ```\n */\nexport * as prefillService from './prefill-service'\n/**\n * ## Payment Service\n *\n * Helper functions for payment handling\n *\n * ```js\n * import { paymentService } from '@oneblink/apps-react'\n * ```\n */\nexport * as paymentService from './payment-service'\n/**\n * ## Scheduling Service\n *\n * Helper functions for scheduling booking handling\n *\n * ```js\n * import { schedulingService } from '@oneblink/apps-react'\n * ```\n */\nexport * as schedulingService from './scheduling-service'\n/**\n * ## Job Service\n *\n * Helper functions for job handling\n *\n * ```js\n * import { jobService } from '@oneblink/apps-react'\n * ```\n */\nexport * as jobService from './job-service'\n/**\n * ## Submission Service\n *\n * Helper functions for handling form submissions\n *\n * ```js\n * import { submissionService } from '@oneblink/apps-react'\n * ```\n */\nexport * as submissionService from './submission-service'\n/**\n * ## Auto Save Service\n *\n * Helper functions for handling data while user is completing form.\n *\n * ```js\n * import { autoSaveService } from '@oneblink/apps-react'\n * ```\n */\nexport * as autoSaveService from './auto-save-service'\n/**\n * ## Notification Service\n *\n * Helper functions for notification handling\n *\n * ```js\n * import { notificationService } from '@oneblink/apps-react'\n * ```\n *\n * ### Service Worker\n *\n * To display push notifications and allow them to be clicked to open the\n * application, add the following JavaScript to your service worker (we\n * recommend using\n * [offline-plugin](https://www.npmjs.com/package/offline-plugin)):\n *\n * #### Example\n *\n * ```js\n * self.addEventListener('push', (event) => {\n *   console.log('push event', event)\n *\n *   if (!event.data) {\n *     console.log('Received push event without any data', event)\n *     return\n *   }\n *   const notification = event.data.json()\n *\n *   event.waitUntil(\n *     clients.matchAll().then((c) => {\n *       if (c.length === 0 || c.every((client) => !client.focused)) {\n *         // Show notification\n *         return self.registration.showNotification(\n *           notification.title,\n *           notification.options,\n *         )\n *       } else {\n *         console.log('Application is already open!')\n *       }\n *     }),\n *   )\n * })\n *\n * self.addEventListener('notificationclick', (event) => {\n *   console.log('notification click event', event)\n *\n *   const pathname =\n *     event.notification.data && event.notification.data.pathname\n *       ? event.notification.data.pathname\n *       : '/'\n *\n *   event.waitUntil(\n *     clients.matchAll().then((clis) => {\n *       const client = clis[0]\n *       if (client === undefined) {\n *         // there are no visible windows. Open one.\n *         clients.openWindow(pathname)\n *       } else {\n *         client.navigate(pathname)\n *         client.focus()\n *       }\n *\n *       return self.registration\n *         .getNotifications()\n *         .then((notifications) => {\n *           notifications.forEach((notification) => {\n *             notification.close()\n *           })\n *         })\n *     }),\n *   )\n * })\n * ```\n */\nexport * as notificationService from './notification-service'\n/**\n * ## Form Service\n *\n * Helper functions for form handling\n *\n * ```js\n * import { formService } from '@oneblink/apps-react'\n * ```\n */\nexport * as formService from './form-service'\n/**\n * ## Approvals Service\n *\n * Helper functions for handling approvals\n *\n * ```js\n * import { approvalsService } from '@oneblink/apps-react'\n * ```\n */\nexport * as approvalsService from './approvals-service'\n/**\n * ## Forms App Service\n *\n * Helper functions for forms apps\n *\n * ```js\n * import { formsAppService } from '@oneblink/apps-react'\n * ```\n */\nexport * as formsAppService from './forms-app-service'\n/**\n * ## Form Store Service\n *\n * Helper functions for handling Form Store Records\n *\n * ```js\n * import { formStoreService } from '@oneblink/apps-react'\n * ```\n */\nexport * as formStoreService from './form-store-service'\n/**\n * ## Localisation Service\n *\n * Helper functions for handling all things locale.\n *\n * ```js\n * import { localisationService } from '@oneblink/apps-react'\n * ```\n */\nexport * as localisationService from './localisation-service'\n/**\n * ## Attachments Service\n *\n * Helper functions for attachment handling\n *\n * ```js\n * import { attachmentsService } from '@oneblink/apps-react'\n * ```\n */\nexport * as attachmentsService from './attachments-service'\n/**\n * ## Scheduled Tasks Service\n *\n * Helper functions for scheduled tasks\n *\n * ```js\n * import { scheduledTasksService } from '@oneblink/apps-react'\n * ```\n */\nexport * as scheduledTasksService from './scheduled-tasks-service'\n/**\n * ## Forms App Environment Service\n *\n * Helper functions for forms app environments\n *\n * ```js\n * import { formsAppEnvironmentService } from '@oneblink/apps-react'\n * ```\n */\nexport * as formsAppEnvironmentService from './forms-app-environment-service'\n\nexport { default as OneBlinkAppsError } from './services/errors/oneBlinkAppsError'\nimport tenants from './tenants'\nexport { default as Sentry } from './Sentry'\n\nexport const useTenantCivicPlus = () => tenants.useCivicPlus()\nexport const useTenantOneBlink = () => tenants.useOneBlink()\nexport const useTenantOneBlinkUS = () => tenants.useOneBlinkUS()\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/apps/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAA;AACnD;;;;;;;;;;;GAWG;AACH,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAA;AAC7C;;;;;;;;GAQG;AACH,OAAO,KAAK,UAAU,MAAM,eAAe,CAAA;AAC3C;;;;;;;;GAQG;AACH,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAA;AAC/C;;;;;;;;GAQG;AACH,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAA;AACnD;;;;;;;;GAQG;AACH,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAA;AACnD;;;;;;;;GAQG;AACH,OAAO,KAAK,iBAAiB,MAAM,sBAAsB,CAAA;AACzD;;;;;;;;GAQG;AACH,OAAO,KAAK,UAAU,MAAM,eAAe,CAAA;AAC3C;;;;;;;;GAQG;AACH,OAAO,KAAK,iBAAiB,MAAM,sBAAsB,CAAA;AACzD;;;;;;;;GAQG;AACH,OAAO,KAAK,eAAe,MAAM,qBAAqB,CAAA;AACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,OAAO,KAAK,mBAAmB,MAAM,wBAAwB,CAAA;AAC7D;;;;;;;;GAQG;AACH,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAA;AAC7C;;;;;;;;GAQG;AACH,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAA;AACvD;;;;;;;;GAQG;AACH,OAAO,KAAK,eAAe,MAAM,qBAAqB,CAAA;AACtD;;;;;;;;GAQG;AACH,OAAO,KAAK,gBAAgB,MAAM,sBAAsB,CAAA;AACxD;;;;;;;;GAQG;AACH,OAAO,KAAK,mBAAmB,MAAM,wBAAwB,CAAA;AAC7D;;;;;;;;GAQG;AACH,OAAO,KAAK,kBAAkB,MAAM,uBAAuB,CAAA;AAC3D;;;;;;;;GAQG;AACH,OAAO,KAAK,qBAAqB,MAAM,2BAA2B,CAAA;AAClE;;;;;;;;GAQG;AACH,OAAO,KAAK,0BAA0B,MAAM,iCAAiC,CAAA;AAE7E,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qCAAqC,CAAA;AAClF,OAAO,OAAO,MAAM,WAAW,CAAA;AAC/B,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,UAAU,CAAA;AAE5C,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,CAAA;AAC9D,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;AAC5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,CAAA","sourcesContent":["/**\n * ## Offline Service\n *\n * Helper functions for offline handling\n *\n * ```js\n * import { offlineService } from '@oneblink/apps-react'\n * ```\n */\nexport * as offlineService from './offline-service'\n/**\n * ## Authentication/Authorisation Service\n *\n * Helper functions for handling user authentication and authorisation.\n *\n * **NOTE: `init()` must be called before using some of the functions in this\n * service.**\n *\n * ```js\n * import { authService } from '@oneblink/apps-react'\n * ```\n */\nexport * as authService from './auth-service'\n/**\n * ## MFA Service\n *\n * Helper functions for multi factor authentication and MFA requirements.\n *\n * ```js\n * import { mfaService } from '@oneblink/apps-react'\n * ```\n */\nexport * as mfaService from './mfa-service'\n/**\n * ## Draft Service\n *\n * Helper functions for handling drafts.\n *\n * ```js\n * import { draftService } from '@oneblink/apps-react'\n * ```\n */\nexport * as draftService from './draft-service'\n/**\n * ## Prefill Service\n *\n * Helper functions for offline handling\n *\n * ```js\n * import { prefillService } from '@oneblink/apps-react'\n * ```\n */\nexport * as prefillService from './prefill-service'\n/**\n * ## Payment Service\n *\n * Helper functions for payment handling\n *\n * ```js\n * import { paymentService } from '@oneblink/apps-react'\n * ```\n */\nexport * as paymentService from './payment-service'\n/**\n * ## Scheduling Service\n *\n * Helper functions for scheduling booking handling\n *\n * ```js\n * import { schedulingService } from '@oneblink/apps-react'\n * ```\n */\nexport * as schedulingService from './scheduling-service'\n/**\n * ## Job Service\n *\n * Helper functions for job handling\n *\n * ```js\n * import { jobService } from '@oneblink/apps-react'\n * ```\n */\nexport * as jobService from './job-service'\n/**\n * ## Submission Service\n *\n * Helper functions for handling form submissions\n *\n * ```js\n * import { submissionService } from '@oneblink/apps-react'\n * ```\n */\nexport * as submissionService from './submission-service'\n/**\n * ## Auto Save Service\n *\n * Helper functions for handling data while user is completing form.\n *\n * ```js\n * import { autoSaveService } from '@oneblink/apps-react'\n * ```\n */\nexport * as autoSaveService from './auto-save-service'\n/**\n * ## Notification Service\n *\n * Helper functions for notification handling\n *\n * ```js\n * import { notificationService } from '@oneblink/apps-react'\n * ```\n *\n * ### Service Worker\n *\n * To display push notifications and allow them to be clicked to open the\n * application, add the following JavaScript to your service worker (we\n * recommend using\n * [offline-plugin](https://www.npmjs.com/package/offline-plugin)):\n *\n * #### Example\n *\n * ```js\n * self.addEventListener('push', (event) => {\n *   console.log('push event', event)\n *\n *   if (!event.data) {\n *     console.log('Received push event without any data', event)\n *     return\n *   }\n *   const notification = event.data.json()\n *\n *   event.waitUntil(\n *     clients.matchAll().then((c) => {\n *       if (c.length === 0 || c.every((client) => !client.focused)) {\n *         // Show notification\n *         return self.registration.showNotification(\n *           notification.title,\n *           notification.options,\n *         )\n *       } else {\n *         console.log('Application is already open!')\n *       }\n *     }),\n *   )\n * })\n *\n * self.addEventListener('notificationclick', (event) => {\n *   console.log('notification click event', event)\n *\n *   const pathname =\n *     event.notification.data && event.notification.data.pathname\n *       ? event.notification.data.pathname\n *       : '/'\n *\n *   event.waitUntil(\n *     clients.matchAll().then((clis) => {\n *       const client = clis[0]\n *       if (client === undefined) {\n *         // there are no visible windows. Open one.\n *         clients.openWindow(pathname)\n *       } else {\n *         client.navigate(pathname)\n *         client.focus()\n *       }\n *\n *       return self.registration\n *         .getNotifications()\n *         .then((notifications) => {\n *           notifications.forEach((notification) => {\n *             notification.close()\n *           })\n *         })\n *     }),\n *   )\n * })\n * ```\n */\nexport * as notificationService from './notification-service'\n/**\n * ## Form Service\n *\n * Helper functions for form handling\n *\n * ```js\n * import { formService } from '@oneblink/apps-react'\n * ```\n */\nexport * as formService from './form-service'\n/**\n * ## Approvals Service\n *\n * Helper functions for handling approvals\n *\n * ```js\n * import { approvalsService } from '@oneblink/apps-react'\n * ```\n */\nexport * as approvalsService from './approvals-service'\n/**\n * ## Forms App Service\n *\n * Helper functions for forms apps\n *\n * ```js\n * import { formsAppService } from '@oneblink/apps-react'\n * ```\n */\nexport * as formsAppService from './forms-app-service'\n/**\n * ## Form Store Service\n *\n * Helper functions for handling Form Store Records\n *\n * ```js\n * import { formStoreService } from '@oneblink/apps-react'\n * ```\n */\nexport * as formStoreService from './form-store-service'\n/**\n * ## Localisation Service\n *\n * Helper functions for handling all things locale.\n *\n * ```js\n * import { localisationService } from '@oneblink/apps-react'\n * ```\n */\nexport * as localisationService from './localisation-service'\n/**\n * ## Attachments Service\n *\n * Helper functions for attachment handling\n *\n * ```js\n * import { attachmentsService } from '@oneblink/apps-react'\n * ```\n */\nexport * as attachmentsService from './attachments-service'\n/**\n * ## Scheduled Tasks Service\n *\n * Helper functions for scheduled tasks\n *\n * ```js\n * import { scheduledTasksService } from '@oneblink/apps-react'\n * ```\n */\nexport * as scheduledTasksService from './scheduled-tasks-service'\n/**\n * ## Forms App Environment Service\n *\n * Helper functions for forms app environments\n *\n * ```js\n * import { formsAppEnvironmentService } from '@oneblink/apps-react'\n * ```\n */\nexport * as formsAppEnvironmentService from './forms-app-environment-service'\n\nexport { default as OneBlinkAppsError } from './services/errors/oneBlinkAppsError'\nimport tenants from './tenants'\nexport { default as Sentry } from './Sentry'\n\nexport const useTenantCivicPlus = () => tenants.useCivicPlus()\nexport const useTenantOneBlink = () => tenants.useOneBlink()\nexport const useTenantOneBlinkUS = () => tenants.useOneBlinkUS()\n"]}

package/dist/apps/mfa-service.d.ts

@@ -0,0 +1,29 @@
+import { MiscTypes } from '@oneblink/types';
+import { getMfaSettings } from './services/cognito';
+export { getMfaSettings };
+export { updateUserPhoneNumber, removeUserPhoneNumber, verifyUserPhoneNumber, disableMfaMethod, setPreferredMfaMethod, setupMfaAuthenticatorApp, setupSmsMfa, generateMfaAuthenticatorAppQrCodeUrl, DEFAULT_MFA_SETTINGS, } from './services/cognito';
+export type { MfaMethod, MfaSettings } from './services/cognito';
+export { isMfaRequired, mfaRequirementToSelectedMethods, mfaSelectedMethodsToMfaRequirement, formatMfaRequirementLabel, formatMfaRequirementMethodLabel, userMeetsMfaRequirement, formatMfaSetupRequiredMessage, formatMfaMethodNotAcceptedMessage, } from '../utils/mfa-requirement';
+export type { MfaRequirementMethod } from '../utils/mfa-requirement';
+export type MfaRequirementCheckResult = {
+    mfaSettings: Awaited<ReturnType<typeof getMfaSettings>>;
+    userMeetsMfaRequirement: boolean;
+};
+/**
+ * Check if the current user meets an MFA requirement.
+ *
+ * #### Example
+ *
+ * ```js
+ * const { mfaSettings, userMeetsMfaRequirement } =
+ *   await mfaService.checkIsMfaEnabled('any')
+ * if (userMeetsMfaRequirement) {
+ *   // User has met the MFA requirement
+ * } else {
+ *   // Prompt user to set up MFA
+ * }
+ * ```
+ *
+ * @returns
+ */
+export declare function checkIsMfaEnabled(mfaRequirement: MiscTypes.MfaRequirement | undefined): Promise<MfaRequirementCheckResult>;

package/dist/apps/mfa-service.js

@@ -0,0 +1,30 @@
+import { getMfaSettings } from './services/cognito';
+import { userMeetsMfaRequirement } from '../utils/mfa-requirement';
+export { getMfaSettings };
+export { updateUserPhoneNumber, removeUserPhoneNumber, verifyUserPhoneNumber, disableMfaMethod, setPreferredMfaMethod, setupMfaAuthenticatorApp, setupSmsMfa, generateMfaAuthenticatorAppQrCodeUrl, DEFAULT_MFA_SETTINGS, } from './services/cognito';
+export { isMfaRequired, mfaRequirementToSelectedMethods, mfaSelectedMethodsToMfaRequirement, formatMfaRequirementLabel, formatMfaRequirementMethodLabel, userMeetsMfaRequirement, formatMfaSetupRequiredMessage, formatMfaMethodNotAcceptedMessage, } from '../utils/mfa-requirement';
+/**
+ * Check if the current user meets an MFA requirement.
+ *
+ * #### Example
+ *
+ * ```js
+ * const { mfaSettings, userMeetsMfaRequirement } =
+ *   await mfaService.checkIsMfaEnabled('any')
+ * if (userMeetsMfaRequirement) {
+ *   // User has met the MFA requirement
+ * } else {
+ *   // Prompt user to set up MFA
+ * }
+ * ```
+ *
+ * @returns
+ */
+export async function checkIsMfaEnabled(mfaRequirement) {
+    const mfaSettings = await getMfaSettings();
+    return {
+        mfaSettings,
+        userMeetsMfaRequirement: userMeetsMfaRequirement(mfaRequirement, mfaSettings),
+    };
+}
+//# sourceMappingURL=mfa-service.js.map

package/dist/apps/mfa-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mfa-service.js","sourceRoot":"","sources":["../../src/apps/mfa-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAA;AAElE,OAAO,EAAE,cAAc,EAAE,CAAA;AACzB,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,gBAAgB,EAChB,qBAAqB,EACrB,wBAAwB,EACxB,WAAW,EACX,oCAAoC,EACpC,oBAAoB,GACrB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EACL,aAAa,EACb,+BAA+B,EAC/B,kCAAkC,EAClC,yBAAyB,EACzB,+BAA+B,EAC/B,uBAAuB,EACvB,6BAA6B,EAC7B,iCAAiC,GAClC,MAAM,0BAA0B,CAAA;AAQjC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,cAAoD;IAEpD,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAA;IAE1C,OAAO;QACL,WAAW;QACX,uBAAuB,EAAE,uBAAuB,CAC9C,cAAc,EACd,WAAW,CACZ;KACF,CAAA;AACH,CAAC","sourcesContent":["import { MiscTypes } from '@oneblink/types'\r\nimport { getMfaSettings } from './services/cognito'\r\nimport { userMeetsMfaRequirement } from '../utils/mfa-requirement'\r\n\r\nexport { getMfaSettings }\r\nexport {\r\n  updateUserPhoneNumber,\r\n  removeUserPhoneNumber,\r\n  verifyUserPhoneNumber,\r\n  disableMfaMethod,\r\n  setPreferredMfaMethod,\r\n  setupMfaAuthenticatorApp,\r\n  setupSmsMfa,\r\n  generateMfaAuthenticatorAppQrCodeUrl,\r\n  DEFAULT_MFA_SETTINGS,\r\n} from './services/cognito'\r\nexport type { MfaMethod, MfaSettings } from './services/cognito'\r\nexport {\r\n  isMfaRequired,\r\n  mfaRequirementToSelectedMethods,\r\n  mfaSelectedMethodsToMfaRequirement,\r\n  formatMfaRequirementLabel,\r\n  formatMfaRequirementMethodLabel,\r\n  userMeetsMfaRequirement,\r\n  formatMfaSetupRequiredMessage,\r\n  formatMfaMethodNotAcceptedMessage,\r\n} from '../utils/mfa-requirement'\r\nexport type { MfaRequirementMethod } from '../utils/mfa-requirement'\r\n\r\nexport type MfaRequirementCheckResult = {\r\n  mfaSettings: Awaited<ReturnType<typeof getMfaSettings>>\r\n  userMeetsMfaRequirement: boolean\r\n}\r\n\r\n/**\r\n * Check if the current user meets an MFA requirement.\r\n *\r\n * #### Example\r\n *\r\n * ```js\r\n * const { mfaSettings, userMeetsMfaRequirement } =\r\n *   await mfaService.checkIsMfaEnabled('any')\r\n * if (userMeetsMfaRequirement) {\r\n *   // User has met the MFA requirement\r\n * } else {\r\n *   // Prompt user to set up MFA\r\n * }\r\n * ```\r\n *\r\n * @returns\r\n */\r\nexport async function checkIsMfaEnabled(\r\n  mfaRequirement: MiscTypes.MfaRequirement | undefined,\r\n): Promise<MfaRequirementCheckResult> {\r\n  const mfaSettings = await getMfaSettings()\r\n\r\n  return {\r\n    mfaSettings,\r\n    userMeetsMfaRequirement: userMeetsMfaRequirement(\r\n      mfaRequirement,\r\n      mfaSettings,\r\n    ),\r\n  }\r\n}\r\n"]}

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

@@ -1,7 +1,34 @@
 import { AuthenticationResultType, CognitoIdentityProviderClient, InitiateAuthResponse } from '@aws-sdk/client-cognito-identity-provider';
+export type MfaMethod = 'authenticator' | 'sms';
+export type MfaSettings = {
+    authenticator: {
+        enabled: boolean;
+        preferred: boolean;
+    };
+    sms: {
+        enabled: boolean;
+        preferred: boolean;
+        phoneNumber: string | undefined;
+        isPhoneNumberVerified: boolean;
+    };
+};
+export declare const DEFAULT_MFA_SETTINGS: MfaSettings;
+export declare function resolveMfaPreferredFlags({ authenticatorEnabled, smsEnabled, preferredMfaSetting, }: {
+    authenticatorEnabled: boolean;
+    smsEnabled: boolean;
+    preferredMfaSetting: string | undefined;
+}): {
+    authenticatorPreferred: boolean;
+    smsPreferred: boolean;
+};
+export type LoginAttemptMfa = {
+    method: MfaMethod;
+    codeCallback: (code: string) => Promise<LoginAttemptResponse>;
+    resendCodeCallback?: () => Promise<LoginAttemptResponse>;
+};
 export type LoginAttemptResponse = {
     resetPasswordCallback?: (newPassword: string) => Promise<LoginAttemptResponse>;
-    mfaCodeCallback?: (code: string) => Promise<LoginAttemptResponse>;
+    mfa?: LoginAttemptMfa;
 };
 export default class AWSCognitoClient {
     clientId: string;
@@ -32,7 +59,7 @@ export default class AWSCognitoClient {
     _isSessionValid(): boolean;
     _refreshSession(): Promise<void>;
     registerListener(listener: () => unknown): () => void;
-    responseToAuthChallenge(username: string, initiateAuthResponse: InitiateAuthResponse): Promise<LoginAttemptResponse>;
+    responseToAuthChallenge(username: string, initiateAuthResponse: InitiateAuthResponse, password?: string): Promise<LoginAttemptResponse>;
     loginUsernamePassword(username: string, password: string): Promise<LoginAttemptResponse>;
     loginHostedUI(identityProviderName?: string): Promise<void>;
     handleAuthentication(): Promise<void>;
@@ -46,9 +73,20 @@ export default class AWSCognitoClient {
     logout(): Promise<void>;
     getIdToken(): Promise<string | undefined>;
     getAccessToken(): Promise<string | undefined>;
-    checkIsMfaEnabled(): Promise<boolean>;
-    disableMfa(): Promise<void>;
-    setupMfa(): Promise<{
+    getMfaSettings(abortSignal?: AbortSignal): Promise<MfaSettings>;
+    updateUserPhoneNumber(phoneNumber: string): Promise<{
+        isPhoneNumberVerified: boolean;
+    }>;
+    removeUserPhoneNumber(): Promise<void>;
+    verifyUserPhoneNumber(code: string): Promise<void>;
+    setPreferredMfaMethod(method: MfaMethod): Promise<void>;
+    disableMfaMethod(method: MfaMethod): Promise<void>;
+    setupSmsMfa({ preferred }?: {
+        preferred?: boolean;
+    }): Promise<void>;
+    setupMfaAuthenticatorApp({ preferred }?: {
+        preferred?: boolean;
+    }): Promise<{
         secretCode: string | undefined;
         mfaCodeCallback: (code: string) => Promise<void>;
     } | undefined>;