@bigbinary/neeto-message-templates-frontend 0.1.0 → 0.2.0

package/README.md

@@ -21,10 +21,10 @@ the creation of SMS, Email and Whatsapp templates.
    bundle install
    ```
 
-3. Configure the organization model in the host application.
+3. Configure the owner model in the host application.
 
    ```ruby
-   has_many :message_templates, class_name: "NeetoMessageTemplatesEngine::MessageTemplate", dependent: :destroy
+   has_many :message_templates, as: :owner, class_name: "NeetoMessageTemplatesEngine::MessageTemplate", dependent: :destroy
    ```
 
 4. Add this line to your application's `config/routes.rb` file
@@ -55,6 +55,15 @@ the creation of SMS, Email and Whatsapp templates.
     end
    ```
 
+7. Create an initializer file in the host app under
+   `configs/initializers/neeto-message-templates.rb` & provide the name of owner
+   model for the message templates. The message_templates `belongs_to` this
+   `owner`.
+
+   ```ruby
+   NeetoMessageTemplatesEngine.owner_class = "Organization"
+   ```
+
 # Frontend Package Installation
 
 Install the latest `neetoMessageTemplates` package using the below command:
@@ -80,6 +89,10 @@ yarn add @bigbinary/neeto-message-templates-frontend
 
 - `templateVariables`: (optional) To add dynamic variables to form body field.
 
+- `ownerId`: (optional) To provide the `id` of the owner if it is not an
+  Organization model. If the owner is an Organization, this prop can be left
+  unspecified.
+
 ### Usage
 
 ```javascript
@@ -141,6 +154,10 @@ const App = () => {
 
 - `templateVariables`: (optional) To add dynamic variables to form body field.
 
+- `ownerId`: (optional) To provide the `id` of the owner if it is not an
+  Organization model. If the owner is an Organization, this prop can be left
+  unspecified.
+
 ### Usage
 
 ```js

package/dist/index.cjs.js

@@ -13,8 +13,8 @@ var ramda = require('ramda');
 var reactQuery = require('react-query');
 var devtools = require('react-query/devtools');
 var neetoIcons = require('@bigbinary/neeto-icons');
-var axios = require('axios');
 var reactUtils = require('@bigbinary/neeto-commons-frontend/react-utils');
+var axios = require('axios');
 var zustand = require('zustand');
 var neetoEditor = require('@bigbinary/neeto-editor');
 var formik$1 = require('@bigbinary/neetoui/formik');
@@ -5284,6 +5284,7 @@ var template = {
 	"delete": "Delete",
 	edit: "Edit",
 	saveChanges: "Save changes",
+	send: "Send",
 	cancel: "Cancel",
 	emailAddress: "Email address",
 	phoneNumber: "Phone number",
@@ -5426,18 +5427,31 @@ var fetchMessageTemplates = function fetchMessageTemplates(params) {
     params: params
   });
 };
-var createMessageTemplate = function createMessageTemplate(params) {
+var createMessageTemplate = function createMessageTemplate(_ref) {
+  var messageTemplate = _ref.messageTemplate,
+    ownerId = _ref.ownerId;
   return axios__default["default"].post(MESSAGE_TEMPLATE_BASE_URL, {
-    messageTemplate: params
+    messageTemplate: messageTemplate,
+    ownerId: ownerId
   });
 };
-var updateMessageTemplate = function updateMessageTemplate(id, params) {
+var updateMessageTemplate = function updateMessageTemplate(_ref2) {
+  var id = _ref2.id,
+    messageTemplate = _ref2.messageTemplate,
+    ownerId = _ref2.ownerId;
   return axios__default["default"].patch("".concat(MESSAGE_TEMPLATE_BASE_URL, "/").concat(id), {
-    messageTemplate: params
+    messageTemplate: messageTemplate,
+    ownerId: ownerId
   });
 };
-var deleteMessageTemplate = function deleteMessageTemplate(id) {
-  return axios__default["default"]["delete"]("".concat(MESSAGE_TEMPLATE_BASE_URL, "/").concat(id));
+var deleteMessageTemplate = function deleteMessageTemplate(_ref3) {
+  var id = _ref3.id,
+    ownerId = _ref3.ownerId;
+  return axios__default["default"]["delete"]("".concat(MESSAGE_TEMPLATE_BASE_URL, "/").concat(id), {
+    data: {
+      ownerId: ownerId
+    }
+  });
 };
 var messageTemplatesApi = {
   fetchAll: fetchMessageTemplates,
@@ -5450,42 +5464,46 @@ var QUERY_KEYS = {
   MESSAGE_TEMPLATE: "message-templates"
 };
 
+var ownerIdValue = function ownerIdValue(ownerId) {
+  return ramda.isEmpty(ownerId) ? undefined : ownerId;
+};
 var useFetchTemplates = function useFetchTemplates(params) {
   return reactQuery.useQuery([QUERY_KEYS.MESSAGE_TEMPLATE, params], function () {
     return messageTemplatesApi.fetchAll(params);
   });
 };
-var useCreateTemplate = function useCreateTemplate(options) {
-  var queryClient = reactQuery.useQueryClient();
-  return reactQuery.useMutation(function (payload) {
-    return messageTemplatesApi.create(payload);
+var useCreateTemplate = function useCreateTemplate(ownerId, options) {
+  return reactUtils.useMutationWithInvalidation(function (messageTemplate) {
+    return messageTemplatesApi.create({
+      messageTemplate: messageTemplate,
+      ownerId: ownerIdValue(ownerId)
+    });
   }, {
-    onSuccess: function onSuccess() {
-      queryClient.invalidateQueries(QUERY_KEYS.MESSAGE_TEMPLATE);
-      options === null || options === void 0 ? void 0 : options.onSuccess();
-    }
+    keysToInvalidate: [QUERY_KEYS.MESSAGE_TEMPLATE],
+    onSuccess: options === null || options === void 0 ? void 0 : options.onSuccess
   });
 };
-var useUpdateTemplate = function useUpdateTemplate() {
-  var queryClient = reactQuery.useQueryClient();
-  return reactQuery.useMutation(function (_ref) {
+var useUpdateTemplate = function useUpdateTemplate(ownerId) {
+  return reactUtils.useMutationWithInvalidation(function (_ref) {
     var id = _ref.id,
       payload = _ref.payload;
-    return messageTemplatesApi.update(id, payload);
+    return messageTemplatesApi.update({
+      id: id,
+      messageTemplate: payload,
+      ownerId: ownerIdValue(ownerId)
+    });
   }, {
-    onSuccess: function onSuccess() {
-      queryClient.invalidateQueries(QUERY_KEYS.MESSAGE_TEMPLATE);
-    }
+    keysToInvalidate: [QUERY_KEYS.MESSAGE_TEMPLATE]
   });
 };
-var useDeleteTemplate = function useDeleteTemplate() {
-  var queryClient = reactQuery.useQueryClient();
-  return reactQuery.useMutation(function (id) {
-    return messageTemplatesApi["delete"](id);
+var useDeleteTemplate = function useDeleteTemplate(ownerId) {
+  return reactUtils.useMutationWithInvalidation(function (id) {
+    return messageTemplatesApi["delete"]({
+      id: id,
+      ownerId: ownerIdValue(ownerId)
+    });
   }, {
-    onSuccess: function onSuccess() {
-      queryClient.invalidateQueries(QUERY_KEYS.MESSAGE_TEMPLATE);
-    }
+    keysToInvalidate: [QUERY_KEYS.MESSAGE_TEMPLATE]
   });
 };
 
@@ -5501,10 +5519,11 @@ function ownKeys$3(object, enumerableOnly) { var keys = Object.keys(object); if
 function _objectSpread$3(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys$3(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys$3(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var RowActions = function RowActions(_ref) {
   var template = _ref.template,
-    setManageTemplatePane = _ref.setManageTemplatePane;
+    setManageTemplatePane = _ref.setManageTemplatePane,
+    ownerId = _ref.ownerId;
   var _useTranslation = useTranslation(),
     t = _useTranslation.t;
-  var _useUpdateTemplate = useUpdateTemplate(),
+  var _useUpdateTemplate = useUpdateTemplate(ownerId),
     update = _useUpdateTemplate.mutate;
   var Menu = neetoui.Dropdown.Menu,
     MenuItem = neetoui.Dropdown.MenuItem;
@@ -5562,7 +5581,7 @@ var renderSearchProps = function renderSearchProps(label, setSearchTerm, searchT
     value: searchTerm
   };
 };
-var buildTableColumnData = function buildTableColumnData(setManageTemplatePane) {
+var buildTableColumnData = function buildTableColumnData(setManageTemplatePane, ownerId) {
   return [{
     dataIndex: "name",
     key: "name",
@@ -5576,6 +5595,7 @@ var buildTableColumnData = function buildTableColumnData(setManageTemplatePane)
       }, /*#__PURE__*/React__default["default"].createElement(neetoui.Typography, {
         style: "body2"
       }, name), /*#__PURE__*/React__default["default"].createElement(RowActions, {
+        ownerId: ownerId,
         setManageTemplatePane: setManageTemplatePane,
         template: template
       }));
@@ -6240,7 +6260,7 @@ var useFilters = function useFilters() {
   };
 };
 
-var useTemplates = function useTemplates(type) {
+var useTemplates = function useTemplates(type, ownerId) {
   var _useState = React.useState(neetoFiltersFrontend.buildFiltersFromURL(buildTableColumnData().filter(ramda.prop("node")))),
     _useState2 = _slicedToArray(_useState, 2),
     filters = _useState2[0],
@@ -6255,16 +6275,17 @@ var useTemplates = function useTemplates(type) {
     pageIndex: pageIndex,
     pageSize: pageSize,
     filters: JSON.stringify(filters),
-    templateType: MESSAGE_TEMPLATES[type].value
+    templateType: MESSAGE_TEMPLATES[type].value,
+    ownerId: ramda.isEmpty(ownerId) ? undefined : ownerId
   };
   var _useFetchTemplates = useFetchTemplates(templateParams),
     _useFetchTemplates$da = _useFetchTemplates.data,
     templatesData = _useFetchTemplates$da === void 0 ? {} : _useFetchTemplates$da,
     isLoadingTemplates = _useFetchTemplates.isLoading,
     isFetching = _useFetchTemplates.isFetching;
-  var _useCreateTemplate = useCreateTemplate(),
+  var _useCreateTemplate = useCreateTemplate(ownerId),
     create = _useCreateTemplate.mutate;
-  var _useUpdateTemplate = useUpdateTemplate(),
+  var _useUpdateTemplate = useUpdateTemplate(ownerId),
     update = _useUpdateTemplate.mutate;
   var createUpdateTemplate = function createUpdateTemplate(_ref, options) {
     var isEdit = _ref.isEdit,
@@ -6298,10 +6319,11 @@ var List = function List(_ref) {
     pageProperties = _ref.pageProperties,
     label = _ref.label,
     addText = _ref.addText,
-    isFilterApplied = _ref.isFilterApplied;
+    isFilterApplied = _ref.isFilterApplied,
+    ownerId = _ref.ownerId;
   var _useTranslation = useTranslation(),
     t = _useTranslation.t;
-  var _useDeleteTemplate = useDeleteTemplate(),
+  var _useDeleteTemplate = useDeleteTemplate(ownerId),
     deleteTemplate = _useDeleteTemplate.mutate,
     isDeleting = _useDeleteTemplate.isLoading;
   var templates = templatesData.templates,
@@ -6322,7 +6344,7 @@ var List = function List(_ref) {
   }, !ramda.isEmpty(templates) ? /*#__PURE__*/React__default["default"].createElement(TableWrapper__default["default"], {
     hasPagination: totalCount > pageSize
   }, /*#__PURE__*/React__default["default"].createElement(neetoui.Table, {
-    columnData: buildTableColumnData(setManageTemplatePane),
+    columnData: buildTableColumnData(setManageTemplatePane, ownerId),
     currentPageNumber: pageIndex,
     defaultPageSize: pageSize,
     loading: isLoading,
@@ -6384,7 +6406,9 @@ var MessageTemplates = function MessageTemplates(_ref) {
     _ref$shouldIncludeTes = _ref.shouldIncludeTestTemplate,
     shouldIncludeTestTemplate = _ref$shouldIncludeTes === void 0 ? true : _ref$shouldIncludeTes,
     _ref$templateVariable = _ref.templateVariables,
-    templateVariables = _ref$templateVariable === void 0 ? {} : _ref$templateVariable;
+    templateVariables = _ref$templateVariable === void 0 ? {} : _ref$templateVariable,
+    _ref$ownerId = _ref.ownerId,
+    ownerId = _ref$ownerId === void 0 ? "" : _ref$ownerId;
   var _useState = React.useState(MESSAGE_TEMPLATE_INITIAL_STATE),
     _useState2 = _slicedToArray(_useState, 2),
     manageTemplatePane = _useState2[0],
@@ -6398,7 +6422,7 @@ var MessageTemplates = function MessageTemplates(_ref) {
     filterColumns = _useFilters.filterColumns,
     setSearchTerm = _useFilters.setSearchTerm,
     searchTerm = _useFilters.searchTerm;
-  var _useTemplates = useTemplates(type),
+  var _useTemplates = useTemplates(type, ownerId),
     isLoading = _useTemplates.isLoading,
     templatesData = _useTemplates.templatesData,
     createUpdateTemplate = _useTemplates.createUpdateTemplate,
@@ -6459,6 +6483,7 @@ var MessageTemplates = function MessageTemplates(_ref) {
     label: label,
     labelSingular: labelSingular,
     manageTemplatePane: manageTemplatePane,
+    ownerId: ownerId,
     pageProperties: pageProperties,
     setManageTemplatePane: setManageTemplatePane,
     setPageProperties: setPageProperties,
@@ -6582,7 +6607,7 @@ var EmailAndSms = function EmailAndSms(_ref) {
       className: "absolute bottom-0 left-0 flex gap-x-2"
     }, /*#__PURE__*/React__default["default"].createElement(neetoui.Button, {
       disabled: !dirty || isSubmitting,
-      label: t("template.saveChanges"),
+      label: t("template.send"),
       loading: isSubmitting,
       type: "submit"
     }), /*#__PURE__*/React__default["default"].createElement(neetoui.Button, {
@@ -6701,7 +6726,7 @@ var Whatsapp = function Whatsapp(_ref) {
       className: "absolute bottom-0 left-0 flex gap-x-2"
     }, /*#__PURE__*/React__default["default"].createElement(formik$1.Button, {
       disabled: !dirty || isSubmitting,
-      label: t("template.saveChanges"),
+      label: t("template.send"),
       loading: isSubmitting,
       type: "submit"
     }), /*#__PURE__*/React__default["default"].createElement(formik$1.Button, {
@@ -6729,7 +6754,9 @@ var SendMessagePane = function SendMessagePane(_ref) {
     _ref$customFieldsVali = _ref.customFieldsValidationSchema,
     customFieldsValidationSchema = _ref$customFieldsVali === void 0 ? {} : _ref$customFieldsVali,
     _ref$templateVariable = _ref.templateVariables,
-    templateVariables = _ref$templateVariable === void 0 ? {} : _ref$templateVariable;
+    templateVariables = _ref$templateVariable === void 0 ? {} : _ref$templateVariable,
+    _ref$ownerId = _ref.ownerId,
+    ownerId = _ref$ownerId === void 0 ? "" : _ref$ownerId;
   var _useTranslation = useTranslation(),
     t = _useTranslation.t;
   var initialFocusField = React.useRef();
@@ -6739,7 +6766,8 @@ var SendMessagePane = function SendMessagePane(_ref) {
   var value = MESSAGE_TEMPLATES[type].value;
   var templateParams = {
     status: "active",
-    templateType: value
+    templateType: value,
+    ownerId: ownerId
   };
   var _useFetchTemplates = useFetchTemplates(templateParams),
     _useFetchTemplates$da = _useFetchTemplates.data,