@bigbinary/neeto-webhooks-frontend 2.0.0 → 2.0.2

package/app/javascript/src/translations/en.json

@@ -41,6 +41,7 @@
       "payload": "Payload",
       "deliveryId": "Delivery ID",
       "sid": "ID",
+      "helpDescription": "Details related to the response received when the product interacts with the endpoint specified in the webhook.",
       "empty": {
         "title": "There are no deliveries to show.",
         "description": "No events have been sent to this webhook"

package/dist/index.cjs.js

@@ -3,12 +3,14 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var React = require('react');
+var ramda = require('ramda');
 var reactRouterDom = require('react-router-dom');
 var neetoCist = require('@bigbinary/neeto-cist');
 var constants = require('@bigbinary/neeto-commons-frontend/constants');
-var utils = require('@bigbinary/neeto-commons-frontend/utils');
+var reactUtils = require('@bigbinary/neeto-commons-frontend/react-utils');
 var Container = require('@bigbinary/neeto-molecules/Container');
 var Header$2 = require('@bigbinary/neeto-molecules/Header');
+var HelpPopover = require('@bigbinary/neeto-molecules/HelpPopover');
 var PageLoader = require('@bigbinary/neeto-molecules/PageLoader');
 var TableWrapper = require('@bigbinary/neeto-molecules/TableWrapper');
 var NoData = require('@bigbinary/neetoui/NoData');
@@ -25,11 +27,9 @@ var Typography = require('@bigbinary/neetoui/Typography');
 var Tab = require('@bigbinary/neetoui/Tab');
 var Tag = require('@bigbinary/neetoui/Tag');
 var i18next = require('i18next');
-var ramda = require('ramda');
+var utils = require('@bigbinary/neeto-commons-frontend/utils');
 var Alert = require('@bigbinary/neetoui/Alert');
-var reactUtils = require('@bigbinary/neeto-commons-frontend/react-utils');
 var Plus = require('@bigbinary/neeto-icons/Plus');
-var HelpPopover = require('@bigbinary/neeto-molecules/HelpPopover');
 var MoreDropdown = require('@bigbinary/neeto-molecules/MoreDropdown');
 var Spinner = require('@bigbinary/neetoui/Spinner');
 var Input = require('@bigbinary/neetoui/formik/Input');
@@ -63,6 +63,7 @@ function _interopNamespace(e) {
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var Container__default = /*#__PURE__*/_interopDefaultLegacy(Container);
 var Header__default = /*#__PURE__*/_interopDefaultLegacy(Header$2);
+var HelpPopover__default = /*#__PURE__*/_interopDefaultLegacy(HelpPopover);
 var PageLoader__default = /*#__PURE__*/_interopDefaultLegacy(PageLoader);
 var TableWrapper__default = /*#__PURE__*/_interopDefaultLegacy(TableWrapper);
 var NoData__default = /*#__PURE__*/_interopDefaultLegacy(NoData);
@@ -76,7 +77,6 @@ var Tab__default = /*#__PURE__*/_interopDefaultLegacy(Tab);
 var Tag__default = /*#__PURE__*/_interopDefaultLegacy(Tag);
 var Alert__default = /*#__PURE__*/_interopDefaultLegacy(Alert);
 var Plus__default = /*#__PURE__*/_interopDefaultLegacy(Plus);
-var HelpPopover__default = /*#__PURE__*/_interopDefaultLegacy(HelpPopover);
 var MoreDropdown__default = /*#__PURE__*/_interopDefaultLegacy(MoreDropdown);
 var Spinner__default = /*#__PURE__*/_interopDefaultLegacy(Spinner);
 var Input__default = /*#__PURE__*/_interopDefaultLegacy(Input);
@@ -87,6 +87,12 @@ var Switch__default = /*#__PURE__*/_interopDefaultLegacy(Switch);
 var Textarea__default = /*#__PURE__*/_interopDefaultLegacy(Textarea);
 var yup__namespace = /*#__PURE__*/_interopNamespace(yup);
 
+var HELP_LINK_URLS = {
+  webhook: "https://neetocalhelp.neetokb.com/p/a-4bb6c2a2",
+  secrets: "https://neetocalhelp.neetokb.com/p/a-80de90bd",
+  deliveries: "https://help.neetocal.com/articles/managing-webhook-deliveries"
+};
+
 var getDeliveriesPath = function getDeliveriesPath(webhooksPath) {
   return "".concat(webhooksPath, "/:webhookId/deliveries");
 };
@@ -125,46 +131,6 @@ function _toConsumableArray(arr) {
   return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
 }
 
-function _arrayWithHoles(arr) {
-  if (Array.isArray(arr)) return arr;
-}
-
-function _iterableToArrayLimit(r, l) {
-  var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];
-  if (null != t) {
-    var e,
-      n,
-      i,
-      u,
-      a = [],
-      f = !0,
-      o = !1;
-    try {
-      if (i = (t = t.call(r)).next, 0 === l) {
-        if (Object(t) !== t) return;
-        f = !1;
-      } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);
-    } catch (r) {
-      o = !0, n = r;
-    } finally {
-      try {
-        if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return;
-      } finally {
-        if (o) throw n;
-      }
-    }
-    return a;
-  }
-}
-
-function _nonIterableRest() {
-  throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
-}
-
-function _slicedToArray(arr, i) {
-  return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
-}
-
 function _typeof$1(o) {
   "@babel/helpers - typeof";
 
@@ -678,6 +644,46 @@ try {
 
 var _regeneratorRuntime = /*@__PURE__*/getDefaultExportFromCjs(regenerator);
 
+function _arrayWithHoles(arr) {
+  if (Array.isArray(arr)) return arr;
+}
+
+function _iterableToArrayLimit(r, l) {
+  var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];
+  if (null != t) {
+    var e,
+      n,
+      i,
+      u,
+      a = [],
+      f = !0,
+      o = !1;
+    try {
+      if (i = (t = t.call(r)).next, 0 === l) {
+        if (Object(t) !== t) return;
+        f = !1;
+      } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);
+    } catch (r) {
+      o = !0, n = r;
+    } finally {
+      try {
+        if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return;
+      } finally {
+        if (o) throw n;
+      }
+    }
+    return a;
+  }
+}
+
+function _nonIterableRest() {
+  throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+
+function _slicedToArray(arr, i) {
+  return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
+}
+
 var DELIVERY_TAB = {
   response: "response",
   request: "request"
@@ -961,11 +967,8 @@ var buildColumns$1 = function buildColumns(_ref) {
 
 var Deliveries = function Deliveries(_ref) {
   var webhooksUrl = _ref.webhooksUrl,
-    hostBreadcrumbs = _ref.breadcrumbs;
-  var _useState = React.useState(1),
-    _useState2 = _slicedToArray(_useState, 2),
-    pageNumber = _useState2[0],
-    setPageNumber = _useState2[1];
+    hostBreadcrumbs = _ref.breadcrumbs,
+    helpLink = _ref.helpLink;
   var _useRouteMatch = reactRouterDom.useRouteMatch(),
     deliveriesUrl = _useRouteMatch.url;
   var history = reactRouterDom.useHistory();
@@ -974,10 +977,12 @@ var Deliveries = function Deliveries(_ref) {
   var _useParams = reactRouterDom.useParams(),
     webhookId = _useParams.webhookId,
     deliveryId = _useParams.deliveryId;
-  var deliveriesPath = getDeliveriesPath(webhooksUrl);
+  var _useQueryParams = reactUtils.useQueryParams(),
+    _useQueryParams$page = _useQueryParams.page,
+    page = _useQueryParams$page === void 0 ? constants.DEFAULT_PAGE_INDEX : _useQueryParams$page;
   var deliveryDetailsPath = getDeliveryDetailsPath(deliveriesUrl);
   var _useFetchDeliveries = useFetchDeliveries(webhookId, {
-      page: pageNumber,
+      page: page,
       pageSize: constants.DEFAULT_PAGE_SIZE
     }),
     isLoading = _useFetchDeliveries.isLoading,
@@ -998,17 +1003,21 @@ var Deliveries = function Deliveries(_ref) {
     link: window.location.pathname,
     text: endpoint
   }]);
-  var handleClose = function handleClose() {
-    history.push(utils.buildUrl(deliveriesPath, {
-      webhookId: webhookId
-    }));
-  };
   if (isLoading) return /*#__PURE__*/jsxRuntime.jsx(PageLoader__default["default"], {});
   return /*#__PURE__*/jsxRuntime.jsxs(Container__default["default"], {
     className: "w-full",
     children: [/*#__PURE__*/jsxRuntime.jsx(Header__default["default"], {
       breadcrumbs: breadcrumbs,
-      title: t("neetoWebhooks.delivery.title")
+      title: /*#__PURE__*/jsxRuntime.jsxs("div", {
+        className: "flex items-center gap-x-2",
+        children: [t("neetoWebhooks.delivery.title"), /*#__PURE__*/jsxRuntime.jsx(HelpPopover__default["default"], {
+          description: t("neetoWebhooks.delivery.helpDescription"),
+          helpLinkProps: {
+            href: helpLink
+          },
+          title: t("neetoWebhooks.delivery.title")
+        })]
+      })
     }), neetoCist.isNotEmpty(deliveries) ? /*#__PURE__*/jsxRuntime.jsx(TableWrapper__default["default"], {
       hasPagination: totalCount > constants.DEFAULT_PAGE_SIZE,
       children: /*#__PURE__*/jsxRuntime.jsx(Table__default["default"], {
@@ -1017,9 +1026,8 @@ var Deliveries = function Deliveries(_ref) {
         columnData: buildColumns$1({
           deliveryDetailsPath: deliveryDetailsPath
         }),
-        currentPageNumber: pageNumber,
+        currentPageNumber: page,
         defaultPageSize: constants.DEFAULT_PAGE_SIZE,
-        handlePageChange: setPageNumber,
         loading: isFetching,
         rowData: deliveries
       })
@@ -1032,7 +1040,9 @@ var Deliveries = function Deliveries(_ref) {
     }), /*#__PURE__*/jsxRuntime.jsx(Details, {
       deliveryId: deliveryId,
       webhookSid: webhookId,
-      onClose: handleClose
+      onClose: function onClose() {
+        return history.goBack();
+      }
     })]
   });
 };
@@ -1119,9 +1129,6 @@ var useDestroyWebhook = function useDestroyWebhook(options) {
   });
 };
 
-var WEBHOOK_HELP_URL = "https://neetocalhelp.neetokb.com/p/a-4bb6c2a2";
-var WEBHOOK_SECRETS_HELP_URL = "https://neetocalhelp.neetokb.com/p/a-80de90bd";
-
 var baseUrl = "/webhooks/events/all";
 var all = function all() {
   return axios__default["default"].get(baseUrl);
@@ -1326,7 +1333,9 @@ var AddWebhookPane = function AddWebhookPane(_ref) {
     isOpen = _ref.isOpen,
     onClose = _ref.onClose,
     onCreate = _ref.onCreate,
-    webhooks = _ref.webhooks;
+    webhooks = _ref.webhooks,
+    webhookHelpLink = _ref.webhookHelpLink,
+    secretsHelpLink = _ref.secretsHelpLink;
   var _useTranslation = reactI18next.useTranslation(),
     t = _useTranslation.t;
   var _useState = React.useState(false),
@@ -1406,7 +1415,7 @@ var AddWebhookPane = function AddWebhookPane(_ref) {
       }), /*#__PURE__*/jsxRuntime.jsx(HelpPopover__default["default"], {
         description: t("neetoWebhooks.webhook.helpDescription"),
         helpLinkProps: {
-          href: WEBHOOK_HELP_URL
+          href: webhookHelpLink
         },
         title: t("neetoWebhooks.webhook.title")
       })]
@@ -1454,7 +1463,7 @@ var AddWebhookPane = function AddWebhookPane(_ref) {
                     className: "flex items-center gap-x-2",
                     children: [t("neetoWebhooks.webhook.secret"), /*#__PURE__*/jsxRuntime.jsx(HelpPopover__default["default"], {
                       helpLinkProps: {
-                        href: WEBHOOK_SECRETS_HELP_URL
+                        href: secretsHelpLink
                       },
                       description: t("neetoWebhooks.webhook.secretkeyHelpDescription"),
                       title: t("neetoWebhooks.webhook.secretkeyHelpTitle")
@@ -1512,7 +1521,8 @@ var Header = reactUtils.withT(function (_ref) {
     breadcrumbs = _ref.breadcrumbs,
     title = _ref.title,
     setIsAddWebhookPaneOpen = _ref.setIsAddWebhookPaneOpen,
-    headerSize = _ref.headerSize;
+    headerSize = _ref.headerSize,
+    webhookHelpLink = _ref.webhookHelpLink;
   return /*#__PURE__*/jsxRuntime.jsxs(jsxRuntime.Fragment, {
     children: [/*#__PURE__*/jsxRuntime.jsx(Header__default["default"], {
       breadcrumbs: breadcrumbs,
@@ -1529,7 +1539,7 @@ var Header = reactUtils.withT(function (_ref) {
         children: [t("neetoWebhooks.webhook.title"), /*#__PURE__*/jsxRuntime.jsx(HelpPopover__default["default"], {
           description: t("neetoWebhooks.webhook.helpDescription"),
           helpLinkProps: {
-            href: WEBHOOK_HELP_URL
+            href: webhookHelpLink
           },
           title: t("neetoWebhooks.webhook.title")
         })]
@@ -1555,7 +1565,9 @@ var Webhooks = function Webhooks(_ref) {
     onDelete = _ref.onDelete,
     headerSize = _ref.headerSize,
     _ref$containerClassNa = _ref.containerClassName,
-    containerClassName = _ref$containerClassNa === void 0 ? "" : _ref$containerClassNa;
+    containerClassName = _ref$containerClassNa === void 0 ? "" : _ref$containerClassNa,
+    webhookHelpLink = _ref.webhookHelpLink,
+    secretsHelpLink = _ref.secretsHelpLink;
   var _useState = React.useState(null),
     _useState2 = _slicedToArray(_useState, 2),
     editingWebhookId = _useState2[0],
@@ -1572,15 +1584,14 @@ var Webhooks = function Webhooks(_ref) {
     _useState8 = _slicedToArray(_useState7, 2),
     isDeleteAlertOpen = _useState8[0],
     setIsDeleteAlertOpen = _useState8[1];
-  var _useState9 = React.useState(1),
-    _useState10 = _slicedToArray(_useState9, 2),
-    pageNumber = _useState10[0],
-    setPageNumber = _useState10[1];
   var _useTranslation = reactI18next.useTranslation(),
     t = _useTranslation.t;
+  var _useQueryParams = reactUtils.useQueryParams(),
+    _useQueryParams$page = _useQueryParams.page,
+    page = _useQueryParams$page === void 0 ? constants.DEFAULT_PAGE_INDEX : _useQueryParams$page;
   var _useFetchWebhooks = useFetchWebhooks({
       entityId: entityId,
-      page: pageNumber,
+      page: page,
       pageSize: constants.DEFAULT_PAGE_SIZE
     }),
     isLoading = _useFetchWebhooks.isLoading,
@@ -1620,15 +1631,15 @@ var Webhooks = function Webhooks(_ref) {
       breadcrumbs: breadcrumbs,
       headerSize: headerSize,
       setIsAddWebhookPaneOpen: setIsAddWebhookPaneOpen,
-      title: title
+      title: title,
+      webhookHelpLink: webhookHelpLink
     }), neetoCist.isNotEmpty(webhooks) ? /*#__PURE__*/jsxRuntime.jsx(TableWrapper__default["default"], {
       hasPagination: totalCount > constants.DEFAULT_PAGE_SIZE,
       children: /*#__PURE__*/jsxRuntime.jsx(Table__default["default"], {
         totalCount: totalCount,
         fixedHeight: true,
-        currentPageNumber: pageNumber,
+        currentPageNumber: page,
         defaultPageSize: constants.DEFAULT_PAGE_SIZE,
-        handlePageChange: setPageNumber,
         loading: isFetching,
         rowData: webhooks,
         columnData: buildColumns({
@@ -1642,7 +1653,7 @@ var Webhooks = function Webhooks(_ref) {
       children: /*#__PURE__*/jsxRuntime.jsx(NoData__default["default"], {
         title: t("neetoWebhooks.webhook.empty"),
         helpText: /*#__PURE__*/jsxRuntime.jsx(Button__default["default"], {
-          href: WEBHOOK_HELP_URL,
+          href: webhookHelpLink,
           label: t("neetoWebhooks.webhook.emptyHelpText"),
           rel: "noreferrer",
           style: "link",
@@ -1660,6 +1671,8 @@ var Webhooks = function Webhooks(_ref) {
       entityId: entityId,
       entityType: entityType,
       onCreate: onCreate,
+      secretsHelpLink: secretsHelpLink,
+      webhookHelpLink: webhookHelpLink,
       webhooks: webhooks,
       isOpen: isAddWebhookPaneOpen,
       onClose: handlePaneClose
@@ -1695,12 +1708,15 @@ var NeetoWebhooks = function NeetoWebhooks(_ref) {
     onCreate = _ref.onCreate,
     onDelete = _ref.onDelete,
     headerSize = _ref.headerSize,
+    _ref$helpLinkUrls = _ref.helpLinkUrls,
+    helpLinkUrls = _ref$helpLinkUrls === void 0 ? {} : _ref$helpLinkUrls,
     containerClassName = _ref.containerClassName;
   var _useRouteMatch = reactRouterDom.useRouteMatch(),
     webhooksPath = _useRouteMatch.path,
     webhooksUrl = _useRouteMatch.url;
   var deliveriesPath = getDeliveriesPath(webhooksUrl);
   var deliveryDetailsPath = getDeliveryDetailsPath(deliveriesPath);
+  var helpLinks = ramda.mergeRight(HELP_LINK_URLS, helpLinkUrls);
   return /*#__PURE__*/jsxRuntime.jsxs(reactRouterDom.Switch, {
     children: [/*#__PURE__*/jsxRuntime.jsx(reactRouterDom.Route, {
       exact: true,
@@ -1715,7 +1731,9 @@ var NeetoWebhooks = function NeetoWebhooks(_ref) {
           headerSize: headerSize,
           onCreate: onCreate,
           onDelete: onDelete,
-          title: title
+          title: title,
+          secretsHelpLink: helpLinks.secrets,
+          webhookHelpLink: helpLinks.webhook
         });
       }
     }), /*#__PURE__*/jsxRuntime.jsx(reactRouterDom.Route, {
@@ -1724,17 +1742,19 @@ var NeetoWebhooks = function NeetoWebhooks(_ref) {
       render: function render() {
         return /*#__PURE__*/jsxRuntime.jsx(Deliveries$1, {
           breadcrumbs: breadcrumbs,
-          webhooksUrl: webhooksUrl
+          webhooksUrl: webhooksUrl,
+          helpLink: helpLinks.deliveries
         });
       }
     }), /*#__PURE__*/jsxRuntime.jsx(reactRouterDom.Route, {
+      path: deliveriesPath,
       component: function component() {
         return /*#__PURE__*/jsxRuntime.jsx(Deliveries$1, {
           breadcrumbs: breadcrumbs,
-          webhooksUrl: webhooksUrl
+          webhooksUrl: webhooksUrl,
+          helpLink: helpLinks.deliveries
         });
-      },
-      path: deliveriesPath
+      }
     })]
   });
 };