@bigbinary/neeto-webhooks-frontend 2.2.8 → 2.2.10

package/README.md

@@ -116,6 +116,10 @@ This component is used to manage webhooks in your web application.
 ##### Optional Props
 
 - `breadcrumbs`: An array of objects that specify breadcrumbs for navigation.
+- `helpLinkUrls`: An object that specifies the URLs for the help links.
+  - `webhooks`: The URL for the webhooks help link.
+  - `secrets`: The URL for the secrets help link.
+  - `deliveries`: The URL for the deliveries help link.
 
 ##### Usage
 
@@ -144,6 +148,14 @@ const Main = () => (
                 },
                 { text: "Webhook" },
               ]}
+              helpLinkUrls={{
+                webhooks:
+                  "https://help.neetokb.com/articles/creating-a-webhook",
+                secrets:
+                  "https://help.neetokb.com/articles/securing-webhook-requests",
+                deliveries:
+                  "https://help.neetokb.com/articles/managing-webhook-deliveries",
+              }}
             />
           )}
         />

package/dist/NeetoWebhooks.js

@@ -1,4 +1,6 @@
+import { prop, pluck, assoc, mergeRight } from 'ramda';
 import { useRouteMatch, useHistory, useParams, Switch as Switch$1, Route } from 'react-router-dom';
+import { globalProps } from '@bigbinary/neeto-commons-frontend/initializers';
 import _toConsumableArray from '@babel/runtime/helpers/toConsumableArray';
 import { isPresent, removeBy, isNotEmpty, removeById, findBy } from '@bigbinary/neeto-cist';
 import { DEFAULT_STALE_TIME, SINGULAR, DEFAULT_PAGE_SIZE, DEFAULT_PAGE_INDEX, PLURAL } from '@bigbinary/neeto-commons-frontend/constants';
@@ -16,7 +18,6 @@ import { QueryClient, QueryCache, QueryClientProvider, useQuery, useQueryClient,
 import { ReactQueryDevtools } from '@tanstack/react-query-devtools';
 import { jsxs, jsx, Fragment } from 'react/jsx-runtime';
 import axios from 'axios';
-import { globalProps } from '@bigbinary/neeto-commons-frontend/initializers';
 import _asyncToGenerator from '@babel/runtime/helpers/asyncToGenerator';
 import _regeneratorRuntime from '@babel/runtime/regenerator';
 import DateFormat from '@bigbinary/neeto-molecules/DateFormat';
@@ -28,7 +29,6 @@ import Typography from '@bigbinary/neetoui/Typography';
 import Tab from '@bigbinary/neetoui/Tab';
 import Tag from '@bigbinary/neetoui/Tag';
 import { t as t$1 } from 'i18next';
-import { prop, pluck, assoc } from 'ramda';
 import Alert from '@bigbinary/neetoui/Alert';
 import Plus from '@bigbinary/neeto-icons/Plus';
 import HelpPopover from '@bigbinary/neeto-molecules/HelpPopover';
@@ -42,6 +42,12 @@ import Textarea from '@bigbinary/neetoui/formik/Textarea';
 import * as yup from 'yup';
 import SubHeader from '@bigbinary/neeto-molecules/SubHeader';
 
+var HELP_LINK_URLS = {
+  webhooks: "https://help.".concat(globalProps.appName, ".com/articles/creating-a-webhook"),
+  secrets: "https://help.".concat(globalProps.appName, ".com/articles/securing-webhook-requests"),
+  deliveries: "https://help.".concat(globalProps.appName, ".com/articles/managing-webhook-deliveries")
+};
+
 var getDeliveriesPath = function getDeliveriesPath(webhooksPath) {
   return "".concat(webhooksPath, "/:webhookId/deliveries");
 };
@@ -137,12 +143,6 @@ var useRedeliverWebhook = function useRedeliverWebhook(deliveryId, webhookSid) {
   });
 };
 
-var HELP_LINK_URLS = {
-  webhook: "https://help.".concat(globalProps.appName, ".com/articles/creating-a-webhook"),
-  secrets: "https://help.".concat(globalProps.appName, ".com/articles/securing-webhook-requests"),
-  deliveries: "https://help.".concat(globalProps.appName, ".com/articles/managing-webhook-deliveries")
-};
-
 var DELIVERY_TAB = {
   response: "response",
   request: "request"
@@ -428,7 +428,8 @@ var buildColumns$1 = function buildColumns(_ref) {
 
 var Deliveries = function Deliveries(_ref) {
   var webhooksUrl = _ref.webhooksUrl,
-    hostBreadcrumbs = _ref.breadcrumbs;
+    hostBreadcrumbs = _ref.breadcrumbs,
+    helpLink = _ref.helpLink;
   var _useRouteMatch = useRouteMatch(),
     deliveriesUrl = _useRouteMatch.url;
   var history = useHistory();
@@ -479,7 +480,7 @@ var Deliveries = function Deliveries(_ref) {
         title: t("neetoWebhooks.delivery.title"),
         description: t("neetoWebhooks.delivery.helpDescription"),
         helpLinkProps: {
-          href: HELP_LINK_URLS.deliveries
+          href: helpLink
         }
       }
     }), isNotEmpty(deliveries) ? /*#__PURE__*/jsx(TableWrapper, {
@@ -690,10 +691,12 @@ var getMenuItems = function getMenuItems(_ref) {
   return [{
     key: MENU_ITEMS.EDIT,
     label: t$1("neetoWebhooks.buttons.edit"),
+    "data-cy": "neeto-webhooks-edit-button",
     onClick: onEdit
   }, {
     key: MENU_ITEMS.DELETE,
     label: t$1("neetoWebhooks.buttons.delete"),
+    "data-cy": "neeto-webhooks-delete-button",
     onClick: onDelete
   }];
 };
@@ -806,7 +809,9 @@ var AddWebhookPane = function AddWebhookPane(_ref) {
     isOpen = _ref.isOpen,
     onClose = _ref.onClose,
     onCreate = _ref.onCreate,
-    webhooks = _ref.webhooks;
+    webhooks = _ref.webhooks,
+    webhooksHelpLink = _ref.webhooksHelpLink,
+    secretsHelpLink = _ref.secretsHelpLink;
   var _useTranslation = useTranslation(),
     t = _useTranslation.t;
   var _useState = useState(false),
@@ -886,7 +891,7 @@ var AddWebhookPane = function AddWebhookPane(_ref) {
       }), /*#__PURE__*/jsx(HelpPopover, {
         description: t("neetoWebhooks.webhook.helpDescription"),
         helpLinkProps: {
-          href: HELP_LINK_URLS.webhook
+          href: webhooksHelpLink
         },
         title: t("neetoWebhooks.webhook.title")
       })]
@@ -933,7 +938,7 @@ var AddWebhookPane = function AddWebhookPane(_ref) {
                   className: "flex items-center gap-x-2",
                   children: [t("neetoWebhooks.webhook.secret"), /*#__PURE__*/jsx(HelpPopover, {
                     helpLinkProps: {
-                      href: HELP_LINK_URLS.secrets
+                      href: secretsHelpLink
                     },
                     popoverProps: {
                       position: "bottom"
@@ -1009,7 +1014,8 @@ var Header = withT(function (_ref) {
     titleHelpPopoverProps = _ref.titleHelpPopoverProps,
     setIsAddWebhookPaneOpen = _ref.setIsAddWebhookPaneOpen,
     headerSize = _ref.headerSize,
-    webhooks = _ref.webhooks;
+    webhooks = _ref.webhooks,
+    webhooksHelpLink = _ref.webhooksHelpLink;
   return /*#__PURE__*/jsxs(Fragment, {
     children: [/*#__PURE__*/jsx(Header$2, {
       breadcrumbs: breadcrumbs,
@@ -1025,7 +1031,7 @@ var Header = withT(function (_ref) {
       titleHelpPopoverProps: _objectSpread({
         description: t("neetoWebhooks.webhook.helpDescription"),
         helpLinkProps: {
-          href: HELP_LINK_URLS.webhook
+          href: webhooksHelpLink
         },
         title: t("neetoWebhooks.webhook.title")
       }, titleHelpPopoverProps)
@@ -1053,7 +1059,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,
+    webhooksHelpLink = _ref.webhooksHelpLink,
+    secretsHelpLink = _ref.secretsHelpLink;
   var _useState = useState(null),
     _useState2 = _slicedToArray(_useState, 2),
     editingWebhookId = _useState2[0],
@@ -1122,7 +1130,8 @@ var Webhooks = function Webhooks(_ref) {
       setIsAddWebhookPaneOpen: setIsAddWebhookPaneOpen,
       title: title,
       titleHelpPopoverProps: titleHelpPopoverProps,
-      webhooks: webhooks
+      webhooks: webhooks,
+      webhooksHelpLink: webhooksHelpLink
     }), isNotEmpty(webhooks) ? /*#__PURE__*/jsx(TableWrapper, {
       hasPagination: totalCount > DEFAULT_PAGE_SIZE,
       children: /*#__PURE__*/jsx(Table, {
@@ -1161,7 +1170,9 @@ var Webhooks = function Webhooks(_ref) {
       entityId: entityId,
       entityType: entityType,
       onCreate: onCreate,
+      secretsHelpLink: secretsHelpLink,
       webhooks: webhooks,
+      webhooksHelpLink: webhooksHelpLink,
       isOpen: isAddWebhookPaneOpen,
       onClose: handlePaneClose
     }), /*#__PURE__*/jsx(Alert, {
@@ -1202,12 +1213,15 @@ var NeetoWebhooks = function NeetoWebhooks(_ref) {
     onCreate = _ref.onCreate,
     onDelete = _ref.onDelete,
     headerSize = _ref.headerSize,
-    containerClassName = _ref.containerClassName;
+    containerClassName = _ref.containerClassName,
+    _ref$helpLinkUrls = _ref.helpLinkUrls,
+    helpLinkUrls = _ref$helpLinkUrls === void 0 ? {} : _ref$helpLinkUrls;
   var _useRouteMatch = useRouteMatch(),
     webhooksPath = _useRouteMatch.path,
     webhooksUrl = _useRouteMatch.url;
   var deliveriesPath = getDeliveriesPath(webhooksUrl);
   var deliveryDetailsPath = getDeliveryDetailsPath(deliveriesPath);
+  var helpLinks = mergeRight(HELP_LINK_URLS, helpLinkUrls);
   return /*#__PURE__*/jsxs(Switch$1, {
     children: [/*#__PURE__*/jsx(Route, {
       exact: true,
@@ -1223,7 +1237,9 @@ var NeetoWebhooks = function NeetoWebhooks(_ref) {
           onCreate: onCreate,
           onDelete: onDelete,
           title: title,
-          titleHelpPopoverProps: titleHelpPopoverProps
+          titleHelpPopoverProps: titleHelpPopoverProps,
+          secretsHelpLink: helpLinks.secrets,
+          webhooksHelpLink: helpLinks.webhooks
         });
       }
     }), /*#__PURE__*/jsx(Route, {
@@ -1232,7 +1248,8 @@ var NeetoWebhooks = function NeetoWebhooks(_ref) {
       render: function render() {
         return /*#__PURE__*/jsx(Deliveries$1, {
           breadcrumbs: breadcrumbs,
-          webhooksUrl: webhooksUrl
+          webhooksUrl: webhooksUrl,
+          helpLink: helpLinks.deliveries
         });
       }
     }), /*#__PURE__*/jsx(Route, {
@@ -1240,7 +1257,8 @@ var NeetoWebhooks = function NeetoWebhooks(_ref) {
       render: function render() {
         return /*#__PURE__*/jsx(Deliveries$1, {
           breadcrumbs: breadcrumbs,
-          webhooksUrl: webhooksUrl
+          webhooksUrl: webhooksUrl,
+          helpLink: helpLinks.deliveries
         });
       }
     })]