@bigbinary/neeto-custom-domains-frontend 3.2.1 → 3.3.0

package/README.md

@@ -68,30 +68,87 @@ end
 All common controller logic is extracted to the engine. However, we still need
 to load some records from the host app controller.
 
+If the custom domain is associated with `Organization`, add a
+`Api::V1::CustomDomainable` concern in the host app and include it in the
+controller. This keeps the loader reusable across controllers that need it.
+
 ```ruby
-class Api::V1::Admin::CustomDomainsController < NeetoCustomDomainsEngine::DomainsController
+# app/controllers/concerns/api/v1/custom_domainable.rb
+module Api::V1::CustomDomainable
+  extend ActiveSupport::Concern
+
   private
 
-    # If custom_domain is associated to Organization
     def load_custom_domainable!
       @custom_domainable = organization
     end
+end
+```
+
+```ruby
+class Api::V1::Admin::CustomDomainsController < NeetoCustomDomainsEngine::DomainsController
+  include Api::V1::CustomDomainable
+end
+```
+
+If the custom domain is associated with another resource (eg. `Site`), define
+`load_custom_domainable!` directly in the controller instead:
+
+```ruby
+class Api::V1::Admin::CustomDomainsController < NeetoCustomDomainsEngine::DomainsController
+  private
 
-    # If custom_domain is associated to other resources (eg: site)
     def load_custom_domainable!
       @custom_domainable = organization.sites.find(params[:site_id])
     end
 end
 ```
 
-3. Include the following module to your application's `config/routes.rb` file:
+3. Add a `CustomDomainConcern` model concern
+
+The engine's `NeetoCustomDomainsEngine::Domain` model needs `custom_domain_url`
+and `organization` to be available on the domain record — they are used, for
+example, when generating links in notification emails and when pushing the
+domain to NeetoTower.
+
+Define the concern in the host app at the exact path below. The engine
+auto-includes it via `include CustomDomainConcern if defined?(CustomDomainConcern)`,
+so no initializer or manual patching is needed — Rails autoloading handles it.
+
+The path returned by `custom_domain_url` is product-specific. Point it at
+wherever the custom domain settings page is mounted in your product's admin
+panel (the example below uses NeetoQuiz's path; replace it for your product).
+
+```ruby
+# app/models/concerns/custom_domain_concern.rb
+module CustomDomainConcern
+  extend ActiveSupport::Concern
+
+  def custom_domain_url
+    root_url = organization.root_url
+    # Replace this path with the route to the custom domain settings page
+    # in your product's admin panel.
+    "#{root_url}/admin/admin-panel/custom-domain"
+  end
+
+  def organization
+    custom_domainable
+  end
+end
+```
+
+If the `custom_domainable` is not the `Organization` itself (eg. `Site`),
+update `organization` to traverse to the owning organization (eg.
+`custom_domainable.organization`).
+
+4. Include the following module to your application's `config/routes.rb` file:
 
 ```ruby
 include NeetoCustomDomainsEngine::Routes::Draw
 
 ```
 
-4. Define required routes.
+5. Define required routes.
 
 ```ruby
 # config/routes.rb
@@ -101,7 +158,7 @@ custom_domains_routes :acme
 custom_domains_routes :domain
 ```
 
-5. Add frontend component. `url` should be the api to the custom domains
+6. Add frontend component. `url` should be the api to the custom domains
    controller.
 
 ```js
@@ -193,7 +250,7 @@ const CustomDomain = () => {
 export default CustomDomain;
 ```
 
-6. Mount the `CustomDomain` component at the desired apth.
+7. Mount the `CustomDomain` component at the desired path.
 
 ##### ENV variables
 
@@ -230,4 +287,4 @@ guide for details on how to publish.
 - NeetoInvoice
 - NeetoChat
 - NeetoRunner
-- NeetoWireframe
+  

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

@@ -32,10 +32,10 @@
     "notFound": "There are no custom domains to show.",
     "tooltipContent": "Delete currently added custom domain to add a new one.",
     "placeholder": "{{subdomainPlaceholder,anyCase}}.yourbusiness.com",
-    "activeTooltipDescription": "Your custom domain is active.",
-    "pendingTooltipDescription": "Your custom domain is pending validation.",
+    "activeTooltipDescription": "Your custom domain is verified and active.",
+    "pendingTooltipDescription": "Your custom domain has pending validation. DNS changes can take up to 48 hours to propagate.",
     "failedTooltipDescription": "Your custom domain is failed to validate. Please try again later.",
-    "redirectionTooltipDescription": "Your custom domain is active. Visiting <b>{{fromDomain}}</b> will redirect you to <b>{{toDomain}}</b>.",
+    "redirectionTooltipDescription": "Your custom domain is verified and active. Visiting <b>{{fromDomain}}</b> will redirect you to <b>{{toDomain}}</b>.",
     "cname": "CNAME",
     "label": "Domain name",
     "domainValidation": "Domain validation",
@@ -95,8 +95,10 @@
       "customDomain": "Add domain of your choice in case you do not prefer to use the default Neeto domain."
     },
     "noData": {
-      "title": "No custom domain has been added.",
-      "helpText": "Add your custom domain to have a personalized URL."
+      "title": "Setup your custom domain",
+      "helpTextDefault": "Add your custom domain to have a personalized URL.",
+      "helpTextDisconnected": "To learn how to set up a custom domain, visit this <Link>help article</Link>.",
+      "helpTextConnected": "To learn more about custom domains, visit this <Link>help article</Link>."
     }
   }
 }

package/dist/.ready

@@ -0,0 +1 @@
+Built at 2026-05-28T19:41:52.619Z