create-githat-app 1.8.10 → 1.8.12

package/dist/cli.js

@@ -21,7 +21,7 @@ var DEPS = {
       next: "^16.0.0",
       react: "^19.0.0",
       "react-dom": "^19.0.0",
-      "@githat/nextjs": "^0.13.7",
+      "@githat/nextjs": "^0.13.9",
       "@githat/ui": "^1.0.0"
     },
     devDependencies: {
@@ -36,7 +36,7 @@ var DEPS = {
       react: "^19.0.0",
       "react-dom": "^19.0.0",
       "react-router-dom": "^7.0.0",
-      "@githat/nextjs": "^0.13.7",
+      "@githat/nextjs": "^0.13.9",
       "@githat/ui": "^1.0.0"
     },
     devDependencies: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-githat-app",
-  "version": "1.8.10",
+  "version": "1.8.12",
   "description": "GitHat CLI — scaffold apps and manage the skills marketplace",
   "type": "module",
   "bin": {

package/templates/base/README.md.hbs

@@ -281,6 +281,131 @@ const { allowed, reasons } = await testPolicy({
 Manage policies visually at **Dashboard → Row-Level Security** or via `useRLS()`.
 If no policy is set, all authenticated users have access (backwards-compatible default).
 
+## Custom domains
+
+GitHat can host your app on a custom domain you already own (Bring Your Own Domain)
+or register a brand-new one for you through Route 53 Domains.
+
+### Bring Your Own Domain (BYOD)
+
+1. Go to **Dashboard → Domains** (or your app's **Domains** tab) and enter your domain.
+2. GitHat detects your DNS provider (Route 53, Cloudflare, GoDaddy, Namecheap, or generic)
+   and returns the CNAME and TXT records you need to add.
+3. If your domain is already in a Route 53 hosted zone GitHat manages, the records are
+   written automatically — no manual DNS steps needed.
+4. GitHat polls every 5 minutes and advances through the onboarding stages automatically:
+
+   `pending_dns` → `dns_verified` → `cert_pending` → `cert_issued` → `cf_attaching` → `live`
+
+You can embed the full wizard in your own UI using the SDK component:
+
+```tsx
+import { DomainOnboardingWizard } from '@githat/nextjs';
+
+<DomainOnboardingWizard
+  appId={appId}
+  onLive={(domain) => console.log(`${domain} is live!`)}
+/>
+```
+
+Or drive it programmatically with the hook:
+
+```ts
+import { useDomains } from '@githat/nextjs';
+
+const { addDomain, getStatus, checkDomain, removeDomain } = useDomains();
+
+// Start onboarding
+const result = await addDomain(appId, 'mystore.com');
+// result.dnsRecords — show these to the user
+// result.instructions.autoWrite — true if GitHat wrote DNS automatically
+
+// Poll status
+const status = await getStatus(appId, 'mystore.com');
+// status.status — one of the stages above
+
+// Trigger a manual DNS + cert poll cycle
+await checkDomain(appId, 'mystore.com');
+```
+
+### Register a new domain
+
+Check availability across multiple TLDs and register right from GitHat:
+
+```ts
+import { useDomains } from '@githat/nextjs';
+
+const { checkAvailability, registerDomain, getRegistration } = useDomains();
+
+// Check availability + pricing
+const { domains } = await checkAvailability('mystore', ['com', 'io', 'co']);
+// domains[0] → { domain, available, awsPriceUsd, platformFeeUsd, totalUsd }
+
+// Register (auto-starts BYOD onboarding after the domain propagates)
+const { operationId } = await registerDomain({
+  domain: 'mystore.com',
+  autoRenew: true,
+  contactInfo: {
+    firstName: 'Jane', lastName: 'Doe',
+    email: 'jane@example.com', phoneNumber: '+1.5555550100',
+    address: '123 Main St', city: 'Seattle',
+    state: 'WA', countryCode: 'US', zipCode: '98101',
+  },
+});
+
+// Poll registration status
+const reg = await getRegistration(operationId);
+// reg.status — 'SUBMITTED' | 'IN_PROGRESS' | 'SUCCESSFUL' | 'FAILED'
+```
+
+Registration is handled through AWS Route 53 Domains (backed by ICANN-accredited
+registrars). WHOIS privacy protection is enabled by default.
+
+## Built-in analytics
+
+Every GitHat app ships with a read-side analytics API. Surface it in your admin
+pages using the `useAnalytics()` hook — no additional setup required:
+
+```{{#if typescript}}tsx{{else}}jsx{{/if}}
+import { useAnalytics } from '@githat/nextjs';
+
+const { getOverview, getTimeSeries, getTopUsers, getFunnels } = useAnalytics(appId);
+
+// Last-30-days KPIs
+const { signups, signins, apiCalls, storageMb } = await getOverview();
+
+// Day-by-day sign-in trend
+const { points } = await getTimeSeries({ metric: 'signins', granularity: 'day' });
+
+// Top users by activity
+const { users } = await getTopUsers({ metric: 'signins', limit: 10 });
+
+// Conversion funnel: visitor → signup → email_verified → first_signin → mfa_enabled
+const { funnel } = await getFunnels();
+```
+
+Drop in the ready-made dashboard component (KPI cards + SVG chart + funnel + top-users
+table — zero external chart dependencies):
+
+```{{#if typescript}}tsx{{else}}jsx{{/if}}
+import { AnalyticsDashboard } from '@githat/nextjs';
+
+<AnalyticsDashboard appId={appId} />
+```
+
+For org-wide KPIs (number of apps, total API calls, billing tier):
+
+```{{#if typescript}}tsx{{else}}jsx{{/if}}
+import { useOrgAnalytics } from '@githat/nextjs';
+
+const { getOverview } = useOrgAnalytics(org.id);
+const { numApps, activeUsers, billingTier } = await getOverview();
+```
+
+Analytics endpoints live under `/analytics/*` and require an authenticated
+org-admin JWT. They are read-only and cache the overview for 60 seconds
+in Lambda memory — free-tier-safe with no extra infrastructure.
+
 ## Learn More
 
 - [GitHat Documentation](https://githat.io/docs)