@bigbinary/neeto-custom-domains-frontend 1.1.0 → 1.2.0-beta2

package/README.md

@@ -1,17 +1,14 @@
-# neeto-custom-domains-engine
+# neeto-custom-domains-nano
 
-The `neeto-custom-domains-engine` manages custom domains across neeto applications.
+The `neeto-custom-domains-nano` manages custom domains across neeto
+applications.
 
 ## Contents
-  1. [Development with Host application](#development-with-host-application)
-      - [Engine](#engine)
-        - [Installation](#installation)
-        - [Usage](#usage)
-  2. [Instructions for publishing](#instructions-for-publishing)
 
-## Development with Host application
+1. [Development with Host application](#development-with-host-application)
+2. [Instructions for publishing](#instructions-for-publishing)
 
-### Engine
+## Development with Host application
 
 The engine provides the backend setup for neetoCustomDomains.
 
@@ -33,13 +30,7 @@ end
 bundle install
 ```
 
-3. Add this line to your application's `config/routes.rb` file:
-
-```ruby
-mount NeetoCustomDomainsEngine::Engine => "/custom_domains"
-```
-
-4. Run migrations
+3. Run migrations
 
 ```
 rails neeto-custom-domains-engine:install:migrations
@@ -48,28 +39,21 @@ rails db:migrate
 
 #### Usage
 
-The steps below depend on the association that we use. In some cases, we need to attach multiple custom domains to a model, while in other cases, we only need a single custom domain. We have to make necessary configurations depending on this.
-
-Let's say we have a "Site" model, and we want to publish our site on a custom domain.
-
-##### Configure `has_one` association
-
-The site only needs to be published in a single custom domain, so we chose `has_one` association.
-
 1. Add association
 
 ```ruby
-class Site > ApplicationRecord
+class Organization > ApplicationRecord
   has_one :custom_domain, as: :custom_domainable, class_name:   "NeetoCustomDomainsEngine::Domain", dependent: :destroy
 end
 ```
 
 2. Add controller
 
-All common controller logic is extracted to the engine. However, we still need to load some records depending on the association that we use.
+All common controller logic is extracted to the engine. However, we still need
+to load some records from the host app controller.
 
 ```ruby
-class Api::V1::Sites::CustomDomainsController < NeetoCustomDomainsEngine::DomainsController
+class Api::V1::Admin::CustomDomainsController < NeetoCustomDomainsEngine::DomainsController
   private
 
     def load_custom_domainable!
@@ -82,78 +66,73 @@ class Api::V1::Sites::CustomDomainsController < NeetoCustomDomainsEngine::Domain
 end
 ```
 
-3. Add routes
+3. Include the following module to your application's `config/routes.rb` file:
 
 ```ruby
 include NeetoCustomDomainsEngine::Routes::Draw
 
-scope module: :sites do
-  custom_domains_routes(route: :custom_domain)
-end
-```
-4. Add front-end component
-
-```js
-import { CustomDomain } from "@bigbinary/neeto-molecules/CustomDomain";
 ```
-For more info related to front-end component: https://github.com/bigbinary/neeto-molecules/blob/main/docs/components.md#customdomain
 
-##### Configure `has_many` association
-
-The site needs to be published in multiple custom domains, so we chose `has_many` association.
-
-1. Add association
+4. Define required routes.
 
 ```ruby
-class Site > ApplicationRecord
-  has_many :custom_domain, as: :custom_domainable, class_name: "NeetoCustomDomainsEngine::Domain", dependent: :destroy
-end
-```
+# config/routes.rb
+custom_domains_routes :acme
 
-2. Add controller
-```ruby
-class Api::V1::Sites::CustomDomainsController < NeetoCustomDomainsEngine::DomainsController
-  private
-
-    def load_custom_domainable!
-      @custom_domainable = organization.sites.find(params[:site_id])
-    end
-
-    def load_custom_domain!
-      @custom_domain = @custom_domainable.custom_domains.find(params[:id])
-    end
-end
+# routes/admin.rb
+ custom_domains_routes :domain
 ```
 
-3. Add routes
-
-```ruby
-include NeetoCustomDomainsEngine::Routes::Draw
-
-scope module: :sites do
-  custom_domains_routes(route: :custom_domain)
-end
-```
-
-4. Add front-end component
+5. Add frontend component. `url` should be the api to the custom domains
+   controller.
 
 ```js
-import { CustomDomainDashBoard } from "@bigbinary/neeto-molecules/CustomDomainDashboard";
-```
-For more info related to front-end component: https://github.com/bigbinary/neeto-molecules/blob/main/docs/components.md#customdomainDashboard
-
-##### Loading site from custom domain
-Let's say we have attached the custom domain `test.neeto.com` to a site. Now, when the user tries to access `test.neeto.com` in the browser, we should display the corresponding site in the front-end. In order to achieve this, we need to load the site from the custom domain.
-
-```ruby
-custom_domain = NeetoCustomDomainsEngine::Domain.find_by(hostname: params[:custom_domain])
-if custom_domain.present?
-  @published_site = custom_domain.custom_domainable.published_site
-else
-  site = Site.find_by! subdomain: params[:subdomain]
-  @published_site = site.published_site
-end
-```
+import { CustomDomain as NeetoCustomDomainDashboard } from "@bigbinary/neeto-custom-domains-frontend";
+import { BASE_API_V1_URL, SINGULAR } from "neetocommons/constants";
+import HelpPopover from "neetomolecules/HelpPopover";
+import { useTranslation } from "react-i18next";
+
+import routes from "routes";
+import { EVENTS } from "src/constants";
+import { CUSTOM_DOMAIN_HELP_DOC_URL } from "src/constants/urls";
+
+const CustomDomain = () => {
+  const { t } = useTranslation();
+
+  const breadcrumbs = [
+    { link: routes.admin.settings.index, text: t("titles.settings") },
+    {
+      link: routes.admin.settings.customDomain,
+      text: t("neetoCustomDomains.customDomain", SINGULAR),
+    },
+  ];
+
+  const title = (
+    <div className="flex items-center gap-x-2">
+      {t("neetoCustomDomains.customDomain", SINGULAR)}
+      <HelpPopover
+        description={t("neetoCustomDomains.toolTips.customDomain")}
+        helpLinkProps={{ href: CUSTOM_DOMAIN_HELP_DOC_URL }}
+        popoverProps={{ position: "top" }}
+        title={t("neetoCustomDomains.customDomain", SINGULAR)}
+      />
+    </div>
+  );
+
+  return (
+    <div className="w-full">
+      <NeetoCustomDomainDashboard
+        headerProps={{ breadcrumbs, title }}
+        url={`${BASE_API_V1_URL}/custom_domain`}
+      />
+    </div>
+  );
+};
+
+export default CustomDomain;
+```
+
+6. Mount the `CustomDomain` component at the desired apth.
 
 ##### ENV variables
 
@@ -162,13 +141,13 @@ For the working of this engine we need the following env variables.
 ```
 LETS_ENCRYPT_PRIVATE_KEY: < For requesting SSL certificates >
 LETS_ENCRYPT_DIRECTORY_URL: < For requesting SSL certificates >
-LETS_ENCRYPT_VALIDATION_DOMAIN_ACCESS_TOKEN: < For domain authentication>
-LETS_ENCRYPT_VALIDATION_DOMAIN_ID: < For domain authentication>
-LETS_ENCRYPT_VALIDATION_DOMAIN_NAME: < For domain authentication>
 LETS_ENCRYPT_APP_NAME: < For pushing SSL certificate and custom domains >
-HEROKU_AUTH_TOKEN: < For pushing SSL certificate and custom domains >
+NEETO_DEPLOY_APP: < To identify in which platform the app is deployed NeetoDEploy/Heroku>
+NEETO_DEPLOY_AUTH_TOKEN: <For pushing SSL certificate and custom domains>
 ```
 
 ## 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.
+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/en.json

@@ -13,27 +13,33 @@
       "delete": "Delete",
       "edit": "Edit",
       "continue": "Continue",
-      "done": "Done"
+      "done": "Done",
+      "add": "Add {{what}}"
     },
     "customDomain_one": "Custom domain",
     "customDomain_other": "Custom domains",
     "customDomainWithCount_one": "{{count}} custom domain",
     "customDomainWithCount_other": "{{count}} custom domains",
     "settings": "Custom domain settings",
+    "connectionTitle": "Connected custom domain",
+    "noDomainConnected": "No custom domain connected",
+    "readHelpArticle": "<Link>Read more</Link> to learn more about setting up custom domain",
     "yourDomain": "Your domain",
-    "addNew": "Add new custom domain",
+    "addNew": "Add custom domain",
     "delete": "Delete custom domain?",
     "search": "Search custom domains",
     "notFound": "There are no custom domains to show.",
-    "placeholder": "help.neeto.com",
+    "placeholder": "Enter your domain",
     "cname": "CNAME",
-    "label": "Enter domain",
+    "label": "Domain name",
     "domainValidation": "Domain validation",
     "domainRedirection": "Domain redirection",
-    "cnameRecordInfo": "Go to your domain host's DNS settings to add the following CNAME record.{{proxyMessage, anyCase}}  <Link>View help article</Link> for more information.",
+    "cnameRecordTitle": " Add the DNS record to your DNS provider",
+    "cnameRecordInfo": "Go to your DNS provider and create the following DNS record by copying the exact settings listed below. Do not enable proxy for the record. View <Link>help article</Link> for more information.",
     "proxyMessage": " Do not enable proxy for the record.",
     "domainRedirectionInfo": "It can take up to 2-24 hours for your custom domain to start working. Please visit your site in 24 hours from now and if after 24 hours <strong>{{hostname}}</strong> is not working then please view <Link>help article</Link> for more information and contact us.",
-    "domainValidationInfo": "CNAME record not found, if you added CNAME record in last 24 hours then please wait sometime and try it again. Verifying your domain usually only takes a few hours, but in some cases can take up to 24-48 hours. View <Link>help article</Link> for more information.",
+    "domainValidationInfo": "CNAME record not found, if you added CNAME record in last 24 hours then please wait sometime and try it again. Verifying your domain usually only takes a few hours, but in some cases can take up to 24-48 hours.",
+    "certificateProvisionFailed": "CNAME record found but we are facing some issues with provisioning certificate for your domain. Please try again",
     "learnMoreMessage": "Learn about <button>how to setup custom domains</button>",
     "cnameAdded": "I have added redirection CNAME record",
     "validation": {
@@ -44,9 +50,9 @@
     },
     "status": {
       "domain": {
-        "active": "Domain validated",
-        "pendingCnameValidation": "Domain validated",
-        "pendingDomainValidation": "Domain validation pending"
+        "active": "Active",
+        "pending": "Pending",
+        "failed": "Failed"
       },
       "cname": {
         "active": "Domain redirected",
@@ -58,6 +64,9 @@
     "formikValidation": {
       "required": "Domain is required",
       "valid": "Please add valid domain or URL"
+    },
+    "toolTips":{
+      "customDomain": "Add domain of your choice in case you do not prefer to use the default neeto domain."
     }
   }
-}
+}