@oneblink/apps-react 11.0.0-beta.8 → 11.0.0-beta.9

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

@@ -34,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

@@ -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,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;;;;;;;;;;;;;;;;;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} 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.\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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oneblink/apps-react",
   "description": "Helper functions for OneBlink apps in ReactJS.",
-  "version": "11.0.0-beta.8",
+  "version": "11.0.0-beta.9",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/apps-react/issues"