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

package/dist/utils/mfa-requirement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mfa-requirement.js","sourceRoot":"","sources":["../../src/utils/mfa-requirement.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAIvC,MAAM,UAAU,aAAa,CAC3B,cAAoD;IAEpD,OAAO,CACL,CAAC,CAAC,cAAc,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,cAAc,CAAC,gBAAgB,CAAC,CAC5E,CAAA;AACH,CAAC;AAID,MAAM,2BAA2B,GAAG,MAAM,CAAC,IAAI,CAAC;IAC9C,GAAG,EAAE,KAAK;IACV,gBAAgB,EAAE,KAAK;CACW,CAA2B,CAAA;AAE/D,MAAM,UAAU,+BAA+B,CAC7C,cAAoD;;IAEpD,MAAM,aAAa,GAAG;QACpB,GAAG,EAAE,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,GAAG,mCAAI,KAAK;QACjC,gBAAgB,EAAE,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,gBAAgB,mCAAI,KAAK;KAC5D,CAAA;IACD,MAAM,OAAO,GAA2B,EAAE,CAAA;IAE1C,IAAI,aAAa,CAAC,gBAAgB,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;IAClC,CAAC;IAED,IAAI,aAAa,CAAC,GAAG,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrB,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,MAAM,UAAU,kCAAkC,CAChD,OAA+B;IAE/B,OAAO;QACL,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC5B,gBAAgB,EAAE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;KACvD,CAAA;AACH,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,cAAoD;IAEpD,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;QACnC,OAAO,cAAc,CAAA;IACvB,CAAC;IAED,MAAM,eAAe,GAAG,+BAA+B,CAAC,cAAc,CAAC,CAAA;IAEvE,IAAI,eAAe,CAAC,MAAM,KAAK,2BAA2B,CAAC,MAAM,EAAE,CAAC;QAClE,OAAO,cAAc,CAAA;IACvB,CAAC;IAED,MAAM,UAAU,GAAG,SAAS,CAC1B,eAAe,CAAC,GAAG,CAAC,+BAA+B,CAAC,EACpD,aAAa,CACd,CAAA;IAED,OAAO,iBAAiB,UAAU,QAAQ,CAAA;AAC5C,CAAC;AAED,MAAM,UAAU,+BAA+B,CAC7C,MAA4B;IAE5B,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,KAAK;YACR,OAAO,KAAK,CAAA;QACd,KAAK,kBAAkB;YACrB,OAAO,mBAAmB,CAAA;QAC5B,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,CAAC,GAAU,MAAM,CAAA;YACvB,OAAO,CAAC,CAAA;QACV,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,cAAoD,EACpD,WAAwB;IAExB,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;QACnC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IACE,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,GAAG;QACnB,WAAW,CAAC,GAAG,CAAC,OAAO;QACvB,WAAW,CAAC,GAAG,CAAC,SAAS,EACzB,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IACE,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,gBAAgB;QAChC,WAAW,CAAC,aAAa,CAAC,OAAO;QACjC,WAAW,CAAC,aAAa,CAAC,SAAS,EACnC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAED,MAAM,UAAU,iCAAiC,CAC/C,MAA4B,EAC5B,cAAoD,EACpD,gBAAgB,GAAG,KAAK;IAExB,IAAI,CAAC,cAAc,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC;QACtD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,eAAe,GAAG,+BAA+B,CAAC,cAAc,CAAC,CAAA;IAEvE,MAAM,UAAU,GAAG,SAAS,CAC1B,eAAe,CAAC,GAAG,CAAC,+BAA+B,CAAC,EACpD,aAAa,CACd,CAAA;IAED,OAAO,oDAAoD,gBAAgB,CAAC,WAAW,EAAE,iCAAiC,UAAU,+BAA+B,CAAA;AACrK,CAAC;AAED,MAAM,UAAU,6BAA6B,CAC3C,cAAoD,EACpD,WAAwB,EACxB,gBAAgB,GAAG,SAAS;IAE5B,IACE,CAAC,aAAa,CAAC,cAAc,CAAC;QAC9B,uBAAuB,CAAC,cAAc,EAAE,WAAW,CAAC,EACpD,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,eAAe,GAAG,+BAA+B,CAAC,cAAc,CAAC,CAAA;IACvE,MAAM,gBAAgB,GACpB,WAAW,CAAC,aAAa,CAAC,OAAO,IAAI,WAAW,CAAC,GAAG,CAAC,OAAO,CAAA;IAE9D,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,WAAW,GAAG,+BAA+B,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;QAEvE,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO,YAAY,WAAW,sHAAsH,gBAAgB,CAAC,WAAW,EAAE,GAAG,CAAA;QACvL,CAAC;QAED,OAAO,YAAY,WAAW,uEAAuE,gBAAgB,GAAG,CAAA;IAC1H,CAAC;IAED,MAAM,UAAU,GAAG,SAAS,CAC1B,eAAe,CAAC,GAAG,CAAC,+BAA+B,CAAC,EACpD,aAAa,CACd,CAAA;IAED,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,YAAY,UAAU,kFAAkF,gBAAgB,CAAC,WAAW,EAAE,GAAG,CAAA;IAClJ,CAAC;IAED,OAAO,YAAY,UAAU,uEAAuE,gBAAgB,GAAG,CAAA;AACzH,CAAC","sourcesContent":["import { MiscTypes } from '@oneblink/types'\r\nimport type { MfaSettings } from '../apps/services/AWSCognitoClient'\r\nimport { joinArray } from './joinArray'\r\n\r\nexport type { MfaSettings }\r\n\r\nexport function isMfaRequired(\r\n  mfaRequirement: MiscTypes.MfaRequirement | undefined,\r\n): boolean {\r\n  return (\r\n    !!mfaRequirement && (mfaRequirement.sms || mfaRequirement.authenticatorApp)\r\n  )\r\n}\r\n\r\nexport type MfaRequirementMethod = keyof MiscTypes.MfaRequirement\r\n\r\nconst MFA_REQUIREMENT_METHOD_KEYS = Object.keys({\r\n  sms: false,\r\n  authenticatorApp: false,\r\n} satisfies MiscTypes.MfaRequirement) as MfaRequirementMethod[]\r\n\r\nexport function mfaRequirementToSelectedMethods(\r\n  mfaRequirement: MiscTypes.MfaRequirement | undefined,\r\n): MfaRequirementMethod[] {\r\n  const checkboxState = {\r\n    sms: mfaRequirement?.sms ?? false,\r\n    authenticatorApp: mfaRequirement?.authenticatorApp ?? false,\r\n  }\r\n  const methods: MfaRequirementMethod[] = []\r\n\r\n  if (checkboxState.authenticatorApp) {\r\n    methods.push('authenticatorApp')\r\n  }\r\n\r\n  if (checkboxState.sms) {\r\n    methods.push('sms')\r\n  }\r\n\r\n  return methods\r\n}\r\n\r\nexport function mfaSelectedMethodsToMfaRequirement(\r\n  methods: MfaRequirementMethod[],\r\n): MiscTypes.MfaRequirement {\r\n  return {\r\n    sms: methods.includes('sms'),\r\n    authenticatorApp: methods.includes('authenticatorApp'),\r\n  }\r\n}\r\n\r\nexport function formatMfaRequirementLabel(\r\n  mfaRequirement: MiscTypes.MfaRequirement | undefined,\r\n): string {\r\n  if (!isMfaRequired(mfaRequirement)) {\r\n    return 'MFA Optional'\r\n  }\r\n\r\n  const selectedMethods = mfaRequirementToSelectedMethods(mfaRequirement)\r\n\r\n  if (selectedMethods.length === MFA_REQUIREMENT_METHOD_KEYS.length) {\r\n    return 'MFA Required'\r\n  }\r\n\r\n  const methodList = joinArray(\r\n    selectedMethods.map(formatMfaRequirementMethodLabel),\r\n    'disjunction',\r\n  )\r\n\r\n  return `MFA Required (${methodList} only)`\r\n}\r\n\r\nexport function formatMfaRequirementMethodLabel(\r\n  method: MfaRequirementMethod,\r\n): string {\r\n  switch (method) {\r\n    case 'sms':\r\n      return 'SMS'\r\n    case 'authenticatorApp':\r\n      return 'Authenticator App'\r\n    default: {\r\n      const n: never = method\r\n      return n\r\n    }\r\n  }\r\n}\r\n\r\nexport function userMeetsMfaRequirement(\r\n  mfaRequirement: MiscTypes.MfaRequirement | undefined,\r\n  mfaSettings: MfaSettings,\r\n): boolean {\r\n  if (!isMfaRequired(mfaRequirement)) {\r\n    return true\r\n  }\r\n\r\n  if (\r\n    mfaRequirement?.sms &&\r\n    mfaSettings.sms.enabled &&\r\n    mfaSettings.sms.preferred\r\n  ) {\r\n    return true\r\n  }\r\n\r\n  if (\r\n    mfaRequirement?.authenticatorApp &&\r\n    mfaSettings.authenticator.enabled &&\r\n    mfaSettings.authenticator.preferred\r\n  ) {\r\n    return true\r\n  }\r\n\r\n  return false\r\n}\r\n\r\nexport function formatMfaMethodNotAcceptedMessage(\r\n  method: MfaRequirementMethod,\r\n  mfaRequirement: MiscTypes.MfaRequirement | undefined,\r\n  accessScopeLabel = 'app',\r\n): string | undefined {\r\n  if (!mfaRequirement || !isMfaRequired(mfaRequirement)) {\r\n    return undefined\r\n  }\r\n\r\n  if (mfaRequirement[method]) {\r\n    return undefined\r\n  }\r\n\r\n  const requiredMethods = mfaRequirementToSelectedMethods(mfaRequirement)\r\n\r\n  const methodList = joinArray(\r\n    requiredMethods.map(formatMfaRequirementMethodLabel),\r\n    'disjunction',\r\n  )\r\n\r\n  return `This MFA method is not sufficient for using this ${accessScopeLabel.toLowerCase()}. Your administrator requires ${methodList} multi factor authentication.`\r\n}\r\n\r\nexport function formatMfaSetupRequiredMessage(\r\n  mfaRequirement: MiscTypes.MfaRequirement | undefined,\r\n  mfaSettings: MfaSettings,\r\n  accessScopeLabel = 'Account',\r\n): string | undefined {\r\n  if (\r\n    !isMfaRequired(mfaRequirement) ||\r\n    userMeetsMfaRequirement(mfaRequirement, mfaSettings)\r\n  ) {\r\n    return undefined\r\n  }\r\n\r\n  const requiredMethods = mfaRequirementToSelectedMethods(mfaRequirement)\r\n  const hasAnyMfaEnabled =\r\n    mfaSettings.authenticator.enabled || mfaSettings.sms.enabled\r\n\r\n  if (requiredMethods.length === 1) {\r\n    const methodLabel = formatMfaRequirementMethodLabel(requiredMethods[0])\r\n\r\n    if (hasAnyMfaEnabled) {\r\n      return `requires ${methodLabel} multi factor authentication. You have a different MFA method configured, but that method is not accepted for this ${accessScopeLabel.toLowerCase()}.`\r\n    }\r\n\r\n    return `requires ${methodLabel} multi factor authentication to be configured before accessing this ${accessScopeLabel}.`\r\n  }\r\n\r\n  const methodList = joinArray(\r\n    requiredMethods.map(formatMfaRequirementMethodLabel),\r\n    'disjunction',\r\n  )\r\n\r\n  if (hasAnyMfaEnabled) {\r\n    return `requires ${methodList} multi factor authentication. Your current MFA method is not accepted for this ${accessScopeLabel.toLowerCase()}.`\r\n  }\r\n\r\n  return `requires ${methodList} multi factor authentication to be configured before accessing this ${accessScopeLabel}.`\r\n}\r\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.1",
+  "version": "11.0.0-beta.3",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/apps-react/issues"