@riverbankcms/sdk 0.4.3 → 0.5.0

package/README.md

@@ -13,6 +13,7 @@ A lightweight TypeScript SDK for consuming Riverbank CMS content in React Server
 - ✅ **React Server Components** compatible
 - ✅ **Custom blocks** - Define site-specific blocks with full CMS editing support
 - ✅ **Content scaffolding** - Define content types, pages, entries, and navigation in code
+- ✅ **Site URLs** - Configure preview and live URLs for dashboard integration
 
 ## Installation
 
@@ -2173,6 +2174,89 @@ import {
 } from '@riverbankcms/sdk/config';
 ```
 
+## Site URLs (Preview & Live)
+
+SDK sites can configure custom preview and live URLs that appear in the dashboard. This allows the CMS to link to your staging and production environments.
+
+### Configuration
+
+Add `previewUrl` and `liveUrl` to your `riverbank.config.ts`:
+
+```typescript
+import { defineConfig } from '@riverbankcms/sdk/config';
+
+export default defineConfig({
+  siteId: 'your-site-id',
+
+  // Preview URL for staging/development environment
+  previewUrl: 'https://staging.mysite.com',
+
+  // Live URL for production environment
+  liveUrl: 'https://mysite.com',
+
+  // ... other config
+});
+```
+
+### How It Works
+
+When you push your SDK config with `riverbank push-config`:
+
+1. URLs are validated and stored in the CMS
+2. Dashboard "Preview" buttons redirect to your `previewUrl`
+3. "View live site" links redirect to your `liveUrl`
+4. If a URL isn't configured, the corresponding button/link is hidden
+
+### URL Requirements
+
+- **HTTPS required** for production URLs
+- **HTTP allowed** for local development (localhost, *.local, *.test, lvh.me)
+- **Trailing slashes** are automatically stripped
+
+### Examples
+
+**Full production setup:**
+```typescript
+export default defineConfig({
+  siteId: 'your-site-id',
+  previewUrl: 'https://staging.mysite.com',
+  liveUrl: 'https://mysite.com',
+});
+```
+
+**Development only:**
+```typescript
+export default defineConfig({
+  siteId: 'your-site-id',
+  previewUrl: 'http://localhost:3000',
+  // liveUrl omitted - "View live site" button hidden in dashboard
+});
+```
+
+**Preview only (no public site yet):**
+```typescript
+export default defineConfig({
+  siteId: 'your-site-id',
+  previewUrl: 'https://preview.mysite.com',
+  // liveUrl omitted until site launches
+});
+```
+
+### Behavior Summary
+
+| Configuration | Preview Button | View Live Site |
+|--------------|----------------|----------------|
+| Both URLs set | Links to `previewUrl` | Links to `liveUrl` |
+| Only `previewUrl` | Links to `previewUrl` | Hidden |
+| Only `liveUrl` | Hidden | Links to `liveUrl` |
+| Neither set | Hidden | Hidden |
+
+### Notes
+
+- SDK sites do **not** use the managed subdomain URLs (e.g., `yoursite.app.riverbankcms.com`)
+- Managed (non-SDK) sites continue to use subdomain URLs automatically
+- URLs are stored in `sdk_config` and synced when you push
+
 ## CLI
 
 The SDK includes a CLI for syncing your local config to the dashboard.