@bigbinary/neeto-email-delivery-frontend 1.0.1

package/README.md

@@ -0,0 +1,150 @@
+# neeto-email-delivery-nano
+
+The `neeto-email-delivery-nano` acts as the source of truth for the new nano's
+structure, configs, data etc.
+
+## Contents
+
+1. [Development with Host Application](#development-with-host-application)
+   - [Engine](#engine)
+     - [Installation](#installation)
+     - [Usage](#usage)
+   - [Frontend package](#frontend-package)
+     - [Installation](#installation-1)
+     - [Instructions for development](#instructions-for-development)
+     - [Usage](#usage-1)
+2. [Instructions for Publishing](#instructions-for-publishing)
+
+## Development with Host Application
+
+### Engine
+
+#### Installation
+
+1. Add this line to your application's Gemfile:
+
+   ```ruby
+    source "NEETO_GEM_SERVER_URL" do
+      # ..existing gems
+
+      gem 'neeto-email-delivery-engine'
+    end
+   ```
+
+2. And then execute:
+
+   ```shell
+   bundle install
+   ```
+
+3. Add this line to your application's `config/routes.rb` file
+
+   ```ruby
+    mount NeetoEmailDeliveryEngine::Engine, at: "/neeto_email_delivery"
+   ```
+
+   **NOTE: The mount point must be `/neeto_email_delivery` and cannot be changed
+   to any other path.**
+
+4. Add required migrations in the `db/migrate` folder. Run the following
+   commands to copy the migrations from the engine to the host application.
+
+   ```shell
+   bundle exec rails neeto_email_delivery_engine:install:migrations
+   bundle exec rails db:migrate
+   ```
+
+5. Include NeetoEmailDeliveryEngine::DeliveryMethodSelector in the host's
+   application_mailer.rb
+
+````diff
+class ApplicationMailer < NeetoCommonsBackend::ApplicationMailer
++  include NeetoEmailDeliveryEngine::DeliveryMethodSelector
+
+  # ...
+end
+
+6. Include NeetoEmailDeliveryEngine::HasEmailIntegrations in the host's owner model
+
+```diff
+class Form < ApplicationRecord
+# ...
++  include NeetoEmailDeliveryEngine::HasEmailIntegrations
+# ...
+end
+````
+
+7. Add `config/initializers/neeto_email_delivery_engine.rb` and add the owner
+   class. Example:
+
+```ruby
+NeetoEmailDeliveryEngine.owner_class = "Form"
+```
+
+8. The following env variables need to be added to the host application.
+
+```
+GOOGLE_OAUTH_CLIENT_ID
+GOOGLE_OAUTH_CLIENT_SECRET
+MICROSOFT_OAUTH_CLIENT_ID
+MICROSOFT_OAUTH_CLIENT_SECRET
+SPARKPOST_SENDING_DOMAINS_KEY
+
+## The following are needed, but they should already be present in the host application. So ensure that they are present.
+APP_LOCAL_TO_INTERNET_PROXY_URL
+CONNECT_PRIVATE_KEY
+CONNECT_PUBLIC_KEY
+```
+
+### Frontend package
+
+#### Installation
+
+1. Add the `neeto-email-delivery-frontend` package to the `package.json`
+
+   ```shell
+   yarn add @bigbinary/neeto-email-delivery-frontend
+   ```
+
+### Instructions for development
+
+Check the
+[Frontend package development guide](https://neeto-engineering.neetokb.com/p/a-d34cb4b0)
+for step-by-step instructions to develop the frontend package.
+
+#### Usage
+
+##### Exported components
+
+###### EmailDeliveryScreen
+
+| Prop                    | Type        | Description                                                  |
+| ----------------------- | ----------- | ------------------------------------------------------------ |
+| `canManageIntegrations` | boolean     | Authorization/permission check for this feature.             |
+| `ownerId`               | uuid/string | ID of the owner record.                                      |
+| `indexRoute`            | string      | Index route for the email delivery page.                     |
+| `ownDomainSetupRoute`   | string      | Nested route for the SparkPost "Own Domain" setup component. |
+
+###### SparkpostDomainSetup
+
+| Prop                    | Type        | Description                                                                  |
+| ----------------------- | ----------- | ---------------------------------------------------------------------------- |
+| `canManageIntegrations` | boolean     | Authorization/permission check for this feature.                             |
+| `ownerId`               | uuid/string | ID of the owner record.                                                      |
+| `alreadyVerifiedRoute`  | string      | Route for the "already verified" page; typically the email delivery index.   |
+| `verifyRoute`           | string      | Route for the verification page that shows DKIM records.                     |
+| `onCancelRoute`         | string      | Route to redirect users on cancellation; typically the email delivery index. |
+
+###### SparkpostDomainVerify
+
+| Prop                      | Type        | Description                                      |
+| ------------------------- | ----------- | ------------------------------------------------ |
+| `canManageIntegrations`   | boolean     | Authorization/permission check for this feature. |
+| `ownerId`                 | uuid/string | ID of the owner record.                          |
+| `emailDeliveryIndexRoute` | string      | Index route for the email delivery page.         |
+
+## Instructions for Publishing
+
+Consult the
+[building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages)
+guide for details on how to publish.

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "مرحبًا بك في نيتو ويل نانو"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Добре дошли в neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Benvingut a neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Vítejte na neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Velkommen til neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Willkommen beim neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,80 @@
+{
+  "neetoEmailDelivery": {
+    "settings": "Settings",
+    "gmail": {
+      "title": "Gmail",
+      "description": "Connect your Gmail account so that all emails are sent from your Gmail account and not from Neeto.",
+      "permissionNotGiven": "You have not given permission to access your Gmail account.",
+      "connectGmail": "Connect Gmail",
+      "gmailConfigured": "Gmail is configured for sending emails."
+    },
+    "outlook": {
+      "title": "Outlook",
+      "description": "Connect your Outlook account so that all emails are sent from your Outlook account and not from Neeto.",
+      "permissionNotGiven": "You have not given permission to access your Outlook account.",
+      "invalidClient": "Invalid client error from Outlook.",
+      "nilJsonWebToken": "The account is not configured for sending emails from Outlook.",
+      "connectOutlook": "Connect Outlook",
+      "outlookConfigured": "Outlook is configured for sending emails."
+    },
+    "sparkpost": {
+      "ownDomainConfigured": "Own domain is configured for sending emails.",
+      "customDomain": "Custom domain",
+      "setup": {
+        "title": "Setup own domain for outgoing emails",
+        "description": "Enter the email address you want to use for sending emails",
+        "emailLabel": "Email address",
+        "emailPlaceholder": "notifications@example.com",
+        "emailHelp": "This email will be used as the sender address for outgoing emails. We'll automatically verify the domain ({{domain}}).",
+        "setupEmail": "Setup email",
+        "note": "Note: You'll need access to your domain's DNS settings to complete the verification process.",
+        "validation": {
+          "emailRequired": "Please enter an email address",
+          "emailInvalid": "Please enter a valid email address",
+          "setupFailed": "Failed to setup domain. Please try again."
+        }
+      },
+      "verify": {
+        "title": "Verify your domain",
+        "description": "Add these DNS records to verify <strong>{{domain}}</strong>",
+        "verifying": "Verifying...",
+        "verifyDomain": "Verify domain",
+        "cancel": "Cancel"
+      },
+      "dnsRecords": {
+        "title": "Required DNS Records",
+        "nameLabel": "Name",
+        "valueLabel": "Value",
+        "dkimSigning": "DKIM signing",
+        "alreadyVerified": "Domain is already verified!",
+        "loading": "Loading DNS records..."
+      },
+      "status": {
+        "successTitle": "Domain verified successfully!",
+        "successDescription": "Your domain is now configured for sending emails. Redirecting...",
+        "errorTitle": "Verification failed",
+        "errorDescription": "Could not verify your domain. Please check your DNS records and try again.",
+        "pendingTitle": "DNS records not found",
+        "pendingDescription": "We couldn't find the required DNS records. Please ensure they are properly configured and try again."
+      },
+      "instructions": {
+        "fullText": "Note: After adding these DNS records to your domain provider, it may take up to 48 hours for the changes to propagate. You can verify the records immediately or check back later.\n\nInstructions:\n1. Log in to your domain registrar or DNS provider\n2. Add the TXT records above to your DNS settings\n3. Wait for DNS propagation (can take up to 24 hours)\n4. Click \"Verify domain\" to check the configuration"
+      },
+      "emailDelivery": {
+        "ownDomainTitle": "Custom email provider",
+        "ownDomainDescription": "You need to configure your DKIM and your DNS settings to send emails from your custom email provider.",
+        "connectedEmail": "Connected email: {{email}}",
+        "connected": "Connected",
+        "disconnect": "Disconnect",
+        "setupDomain": "Setup domain"
+      },
+      "toasts": {
+        "domainVerifiedConnected": "Domain verified and connected successfully!",
+        "domainCreated": "Domain created! Please verify DNS records.",
+        "domainVerified": "Domain verified successfully!",
+        "verificationPending": "Verification in progress. DNS records propagation may take up to 24 hours.",
+        "domainDisconnected": "Domain disconnected successfully!"
+      }
+    }
+  }
+}

package/app/javascript/src/translations/es-MX.json

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Bienvenido a neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Bienvenido a neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Tere tulemast neeto ratta nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Tervetuloa neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Maligayang pagdating sa neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Bienvenue dans neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "नीटो व्हील नैनो में आपका स्वागत है"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Dobrodošli u neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Selamat datang di neeto wheel nano"
+  }
+}

package/app/javascript/src/translations/index.js

@@ -0,0 +1,3 @@
+import en from "./en.json";
+
+export { en };

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Benvenuto su neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "ネートホイールナノへようこそ"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "네이토 휠 나노에 오신 것을 환영합니다"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Welkom bij neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Witamy w neeto wheel nano"
+  }
+}

package/app/javascript/src/translations/pt-BR.json

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Bem-vindo ao neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Bem-vindo ao neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Bine ai venit la neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Добро пожаловать в neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Vitajte na neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Dobrodošli v neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Välkommen till neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "ยินดีต้อนรับสู่ neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Neeto Wheel Nano'ya Hoş Geldiniz"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Ласкаво просимо до neeto wheel nano"
+  }
+}

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

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "Chào mừng bạn đến với neeto wheel nano"
+  }
+}

package/app/javascript/src/translations/zh-CN.json

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "欢迎使用 neeto wheel nano"
+  }
+}

package/app/javascript/src/translations/zh-TW.json

@@ -0,0 +1,5 @@
+{
+  "neetoWheel": {
+    "welcomeScreen": "歡迎使用 neeto wheel nano"
+  }
+}