@2uinc/frontend-enterprise-logistration 9.2.1

package/LoginRedirect.js

@@ -0,0 +1,36 @@
+import PropTypes from 'prop-types';
+import { useParams } from 'react-router-dom';
+import { getAuthenticatedUser } from '@edx/frontend-platform/auth';
+import { getProxyLoginUrl } from './utils';
+
+/**
+ * This wrapper component redirects the user to the enterprise proxy login view with additional query
+ * parameters if they are not already authenticated. If the user is already authenticated, simply return
+ * the children to render the rest of the application.
+ *
+ * @param {node} children The child nodes to render if there is an authenticated user.
+ * @param {element} loadingDisplay A React element to display while authenticated user is loading
+ */
+var LoginRedirect = function LoginRedirect(_ref) {
+  var children = _ref.children,
+    LoadingDisplay = _ref.loadingDisplay;
+  var _useParams = useParams(),
+    enterpriseSlug = _useParams.enterpriseSlug,
+    enterpriseCustomerInviteKey = _useParams.enterpriseCustomerInviteKey;
+  var user = getAuthenticatedUser();
+  if (user) {
+    return children;
+  }
+  global.location.href = getProxyLoginUrl(enterpriseSlug, enterpriseCustomerInviteKey);
+  return LoadingDisplay;
+};
+LoginRedirect.propTypes = {
+  children: PropTypes.node,
+  loadingDisplay: PropTypes.element
+};
+LoginRedirect.defaultProps = {
+  children: null,
+  loadingDisplay: null
+};
+export default LoginRedirect;
+//# sourceMappingURL=LoginRedirect.js.map

package/LoginRedirect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LoginRedirect.js","names":["PropTypes","useParams","getAuthenticatedUser","getProxyLoginUrl","LoginRedirect","_ref","children","LoadingDisplay","loadingDisplay","_useParams","enterpriseSlug","enterpriseCustomerInviteKey","user","global","location","href","propTypes","node","element","defaultProps"],"sources":["../src/LoginRedirect.jsx"],"sourcesContent":["import PropTypes from 'prop-types';\nimport { useParams } from 'react-router-dom';\nimport { getAuthenticatedUser } from '@edx/frontend-platform/auth';\n\nimport { getProxyLoginUrl } from './utils';\n\n/**\n * This wrapper component redirects the user to the enterprise proxy login view with additional query\n * parameters if they are not already authenticated. If the user is already authenticated, simply return\n * the children to render the rest of the application.\n *\n * @param {node} children The child nodes to render if there is an authenticated user.\n * @param {element} loadingDisplay A React element to display while authenticated user is loading\n */\nconst LoginRedirect = ({ children, loadingDisplay: LoadingDisplay }) => {\n  const {\n    enterpriseSlug,\n    enterpriseCustomerInviteKey,\n  } = useParams();\n\n  const user = getAuthenticatedUser();\n\n  if (user) {\n    return children;\n  }\n\n  global.location.href = getProxyLoginUrl(enterpriseSlug, enterpriseCustomerInviteKey);\n\n  return LoadingDisplay;\n};\n\nLoginRedirect.propTypes = {\n  children: PropTypes.node,\n  loadingDisplay: PropTypes.element,\n};\n\nLoginRedirect.defaultProps = {\n  children: null,\n  loadingDisplay: null,\n};\n\nexport default LoginRedirect;\n"],"mappings":"AAAA,OAAOA,SAAS,MAAM,YAAY;AAClC,SAASC,SAAS,QAAQ,kBAAkB;AAC5C,SAASC,oBAAoB,QAAQ,6BAA6B;AAElE,SAASC,gBAAgB,QAAQ,SAAS;;AAE1C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,IAAMC,aAAa,GAAG,SAAhBA,aAAaA,CAAAC,IAAA,EAAqD;EAAA,IAA/CC,QAAQ,GAAAD,IAAA,CAARC,QAAQ;IAAkBC,cAAc,GAAAF,IAAA,CAA9BG,cAAc;EAC/C,IAAAC,UAAA,GAGIR,SAAS,CAAC,CAAC;IAFbS,cAAc,GAAAD,UAAA,CAAdC,cAAc;IACdC,2BAA2B,GAAAF,UAAA,CAA3BE,2BAA2B;EAG7B,IAAMC,IAAI,GAAGV,oBAAoB,CAAC,CAAC;EAEnC,IAAIU,IAAI,EAAE;IACR,OAAON,QAAQ;EACjB;EAEAO,MAAM,CAACC,QAAQ,CAACC,IAAI,GAAGZ,gBAAgB,CAACO,cAAc,EAAEC,2BAA2B,CAAC;EAEpF,OAAOJ,cAAc;AACvB,CAAC;AAEDH,aAAa,CAACY,SAAS,GAAG;EACxBV,QAAQ,EAAEN,SAAS,CAACiB,IAAI;EACxBT,cAAc,EAAER,SAAS,CAACkB;AAC5B,CAAC;AAEDd,aAAa,CAACe,YAAY,GAAG;EAC3Bb,QAAQ,EAAE,IAAI;EACdE,cAAc,EAAE;AAClB,CAAC;AAED,eAAeJ,aAAa","ignoreList":[]}

package/README.rst

@@ -0,0 +1,15 @@
+@edx/frontend-enterprise-logistration
+=============
+
+|Build Status| |npm_version| |npm_downloads| |license|
+
+This package exports a UI component related to logistration for Enterprise users. This package will be helpful for Enterprise micro-frontends to share logic related to redirecting enterprise users to the logistration page branded with their Enterprise Customer's logo and additional messaging.
+
+.. |Build Status| image:: https://github.com/openedx/frontend-enterprise/actions/workflows/release.yml/badge.svg
+   :target: https://github.com/openedx/frontend-enterprise/actions
+.. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-enterprise-logistration.svg
+   :target: @edx/frontend-enterprise-logistration
+.. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-enterprise-logistration.svg
+   :target: @edx/frontend-enterprise-logistration
+.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-enterprise-logistration.svg
+    :target: @edx/frontend-enterprise-logistration

package/index.js

@@ -0,0 +1,4 @@
+// eslint-disable-next-line import/prefer-default-export
+export { default as LoginRedirect } from './LoginRedirect';
+export { getProxyLoginUrl } from './utils';
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["default","LoginRedirect","getProxyLoginUrl"],"sources":["../src/index.js"],"sourcesContent":["// eslint-disable-next-line import/prefer-default-export\nexport { default as LoginRedirect } from './LoginRedirect';\nexport { getProxyLoginUrl } from './utils';\n"],"mappings":"AAAA;AACA,SAASA,OAAO,IAAIC,aAAa,QAAQ,iBAAiB;AAC1D,SAASC,gBAAgB,QAAQ,SAAS","ignoreList":[]}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@2uinc/frontend-enterprise-logistration",
+  "version": "9.2.1",
+  "description": "Enterprise-specific component(s) to ensure enterprise users are redirected to branded enterprise logistration flow.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/edx/frontend-enterprise.git"
+  },
+  "watch": {
+    "build": {
+      "patterns": [
+        "src"
+      ],
+      "extensions": "js,jsx"
+    }
+  },
+  "scripts": {
+    "dev": "npx npm-watch build",
+    "clean": "make clean",
+    "build": "make build",
+    "i18n_extract": "BABEL_ENV=i18n fedx-scripts babel src --quiet > /dev/null",
+    "lint": "fedx-scripts eslint --ext .js --ext .jsx .",
+    "lint:fix": "fedx-scripts eslint --fix --ext .js --ext .jsx .",
+    "snapshot": "fedx-scripts jest --updateSnapshot",
+    "test": "fedx-scripts jest --coverage --passWithNoTests",
+    "test:watch": "npm run test -- --watch"
+  },
+  "author": "edX",
+  "license": "AGPL-3.0",
+  "homepage": "https://github.com/edx/frontend-enterprise#readme",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "bugs": {
+    "url": "https://github.com/edx/frontend-enterprise/issues"
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@edx/frontend-enterprise-utils": "^10.0.0",
+    "prop-types": "^15.8.1"
+  },
+  "devDependencies": {
+    "@edx/browserslist-config": "^1.5.0",
+    "@edx/frontend-platform": "^8.2.1",
+    "@openedx/frontend-build": "^14.3.1",
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/jest-dom": "^5.17.0",
+    "@testing-library/react": "^16.2.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^6.29.0",
+    "react-test-renderer": "^18.3.1"
+  },
+  "peerDependencies": {
+    "@edx/frontend-platform": "^7.0.0 || ^8.0.0",
+    "react": "^16.12.0 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.12.0 || ^17.0.0 || ^18.0.0",
+    "react-router-dom": "^6.0.0"
+  }
+}

package/utils.js

@@ -0,0 +1,23 @@
+/**
+ * Given either an `enterpriseSlug` or an `enterpriseCustomerInviteKey`, returns a
+ * URL to the enterprise proxy login page in the LMS. The proxy-login page appropriately
+ * redirects enterprise users to the enterprise-specific logistration flow.
+ *
+ * @param {string} enterpriseSlug Slug of an enterprise customer
+ * @param {string} enterpriseCustomerInviteKey UUID of an EnterpriseCustomerInviteKey
+ * @returns URL of the enterprise proxy login page in the LMS.
+ */
+// eslint-disable-next-line import/prefer-default-export
+export var getProxyLoginUrl = function getProxyLoginUrl(enterpriseSlug, enterpriseCustomerInviteKey) {
+  var queryParams = new URLSearchParams();
+  queryParams.append('next', global.location);
+  if (enterpriseSlug) {
+    queryParams.append('enterprise_slug', enterpriseSlug);
+  }
+  if (enterpriseCustomerInviteKey) {
+    queryParams.append('enterprise_customer_invite_key', enterpriseCustomerInviteKey);
+  }
+  var proxyLoginUrl = "".concat(process.env.LMS_BASE_URL, "/enterprise/proxy-login/?").concat(queryParams.toString());
+  return proxyLoginUrl;
+};
+//# sourceMappingURL=utils.js.map

package/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","names":["getProxyLoginUrl","enterpriseSlug","enterpriseCustomerInviteKey","queryParams","URLSearchParams","append","global","location","proxyLoginUrl","concat","process","env","LMS_BASE_URL","toString"],"sources":["../src/utils.js"],"sourcesContent":["/**\n * Given either an `enterpriseSlug` or an `enterpriseCustomerInviteKey`, returns a\n * URL to the enterprise proxy login page in the LMS. The proxy-login page appropriately\n * redirects enterprise users to the enterprise-specific logistration flow.\n *\n * @param {string} enterpriseSlug Slug of an enterprise customer\n * @param {string} enterpriseCustomerInviteKey UUID of an EnterpriseCustomerInviteKey\n * @returns URL of the enterprise proxy login page in the LMS.\n */\n// eslint-disable-next-line import/prefer-default-export\nexport const getProxyLoginUrl = (enterpriseSlug, enterpriseCustomerInviteKey) => {\n  const queryParams = new URLSearchParams();\n  queryParams.append('next', global.location);\n  if (enterpriseSlug) {\n    queryParams.append('enterprise_slug', enterpriseSlug);\n  }\n  if (enterpriseCustomerInviteKey) {\n    queryParams.append('enterprise_customer_invite_key', enterpriseCustomerInviteKey);\n  }\n  const proxyLoginUrl = `${process.env.LMS_BASE_URL}/enterprise/proxy-login/?${queryParams.toString()}`;\n  return proxyLoginUrl;\n};\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMA,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAIC,cAAc,EAAEC,2BAA2B,EAAK;EAC/E,IAAMC,WAAW,GAAG,IAAIC,eAAe,CAAC,CAAC;EACzCD,WAAW,CAACE,MAAM,CAAC,MAAM,EAAEC,MAAM,CAACC,QAAQ,CAAC;EAC3C,IAAIN,cAAc,EAAE;IAClBE,WAAW,CAACE,MAAM,CAAC,iBAAiB,EAAEJ,cAAc,CAAC;EACvD;EACA,IAAIC,2BAA2B,EAAE;IAC/BC,WAAW,CAACE,MAAM,CAAC,gCAAgC,EAAEH,2BAA2B,CAAC;EACnF;EACA,IAAMM,aAAa,MAAAC,MAAA,CAAMC,OAAO,CAACC,GAAG,CAACC,YAAY,+BAAAH,MAAA,CAA4BN,WAAW,CAACU,QAAQ,CAAC,CAAC,CAAE;EACrG,OAAOL,aAAa;AACtB,CAAC","ignoreList":[]}