@bigbinary/neeto-email-notifications-frontend 1.2.0 → 1.3.0

package/README.md

@@ -1,7 +1,83 @@
 # neeto-email-notifications-nano
 
-This repo acts as the source of truth for the new nano's structure, configs,
-data etc.
+[![BuildStatus](https://neeto-engineering.neetoci.com/badges/neeto-email-notifications-nano/workflows/branch.svg)](https://neeto-engineering.neetoci.com/projects/neeto-email-notifications-nano)
+![package version](https://img.shields.io/npm/v/@bigbinary/neeto-email-notifications-frontend?color=greenyellow)
+![npm downloads](https://img.shields.io/npm/dw/@bigbinary/neeto-email-notifications-frontend?color=greenyellow)
+
+neeto-email-notifications-nano enables the management of email notifications
+across neeto products
+
+# Installation
+
+[Engine and package installation](./docs/engine-and-package-installation.md)
+
+# Usage
+
+### Backend
+
+1. Create required email notification models inherited from
+   `NeetoEmailNotificationsEngine::EmailNotification`. For example,
+
+   ```ruby
+   class PushEmailNotification < ::NeetoEmailNotificationsEngine::EmailNotification
+     default_scope { where("custom_fields -> 'notification_type' ? :value", value: "Push") }
+     after_initialize :set_custom_field
+
+     def set_custom_field
+       self.custom_fields ||= {}
+       self.custom_fields[custom_field_key] = "Push"
+     end
+
+     def custom_field_key
+       "notification_type"
+     end
+   end
+   ```
+
+2. Add the required associations to the polymorphic model. For example,
+
+   ```ruby
+   class Form < ApplicationRecord
+   ....
+
+   has_many :email_notifications, as: :notification_holder, class_name: "::NeetoEmailNotificationsEngine::EmailNotification", dependent: :destroy
+   has_one :push_email_notification, as: :notification_holder
+
+   ....
+   end
+   ```
+
+### Frontend
+
+1. Add the component to the host application. For example,
+   ```js
+   <NeetoEmailNotificationForm
+     title="Email notification"
+     subtitle="Send an email notification when a new event occurred"
+     emailPreviewProps={{ productName: "Product" }}
+     emailNotificationParams={{
+       notificationHolderType: "Form",
+       notificationHolderId: formId,
+       customFields: { notificationType: "Push" },
+     }}
+   />
+   ```
+
+<img width="1318" alt="NeetoEmailNotificationForm component" src="https://github.com/bigbinary/neeto-email-notifications-nano/assets/89389135/bbe89fce-98ad-4974-9617-2a69d9baa61a">
+
+| Prop                    | Type    | Default Value                                          | Description                                                                                                                      |
+| ----------------------- | ------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
+| title                   | String  | "Email notification"                                   | The title of the component.                                                                                                      |
+| subtitle                | String  | "Send an email notification when a new event occurred" | The subtitle of the component.                                                                                                   |
+| disabled                | Boolean | false                                                  | Disables the component                                                                                                           |
+| emailFormikProps        | Object  | {}                                                     | Props for [`<EmailFormProvider />`](https://github.com/bigbinary/neeto-molecules/blob/main/docs/components.md#emailformprovider) |
+| emailFormProps          | Object  | {}                                                     | Props for [`<EmailForm />`](https://github.com/bigbinary/neeto-molecules/blob/main/docs/components.md#emailform)                 |
+| emailPreviewProps       | Object  | {}                                                     | Props for [`<EmailPreview />`](https://github.com/bigbinary/neeto-molecules/blob/main/docs/components.md#emailpreview)           |
+| emailNotificationParams | Object  | {}                                                     | Contains params required for fetching email notification                                                                         |
+| tooltipProps            | Object  | {}                                                     | Props for `<Tooltip>` for showing toolTip content when disabled                                                                  |
+| children                | Node    | undefined                                              | Additional content to be displayed inside the component                                                                          |
+
+<!-- TODO: Add references  -->
 
 # Local Development Setup
 
@@ -15,5 +91,4 @@ data etc.
 
 # Publish instructions
 
-1. [Engine and package installation](./docs/engine-and-package-installation.md)
-2. [Building and releasing](./docs/building-and-releasing.md)
+1. [Building and releasing](./docs/building-and-releasing.md)

package/dist/index.cjs.js

@@ -2580,7 +2580,7 @@ var errors = {
 };
 var emailNotification = {
 	title: "Email notification",
-	subTitle: "Send an email notification when a new event occured"
+	subTitle: "Send an email notification when a new event occurred"
 };
 var en = {
 	welcomeScreen: welcomeScreen,
@@ -2800,7 +2800,7 @@ var renderText = function renderText(text, fallbackTranslation) {
 
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-var NeetoEmailNotification = function NeetoEmailNotification(_ref) {
+var NeetoEmailNotificationForm = function NeetoEmailNotificationForm(_ref) {
   var _ref$emailNotificatio = _ref.emailNotificationParams,
     emailNotificationParams = _ref$emailNotificatio === void 0 ? {} : _ref$emailNotificatio,
     _ref$emailPreviewProp = _ref.emailPreviewProps,
@@ -2888,5 +2888,5 @@ var NeetoEmailNotification = function NeetoEmailNotification(_ref) {
   }));
 };
 
-exports.NeetoEmailNotification = NeetoEmailNotification;
+exports.NeetoEmailNotificationForm = NeetoEmailNotificationForm;
 //# sourceMappingURL=index.cjs.js.map