@riverbankcms/sdk 0.128.0 → 0.129.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/README.md +33 -0
  2. package/dist/{PreviewEditorSidebar-Dbvb7GIr.mjs → PreviewEditorSidebar-B43CJ0g_.mjs} +3 -3
  3. package/dist/{PreviewEditorUI-e9O9l20X.mjs → PreviewEditorUI-DHirVkeM.mjs} +2 -2
  4. package/dist/{SdkPreviewModeRuntime-BZHt6e9w.mjs → SdkPreviewModeRuntime-BJumZy1B.mjs} +495 -292
  5. package/dist/{SiteChromeCustomizeContext-CvuGbHJX.mjs → SiteChromeCustomizeContext-D9SlpwEj.mjs} +140 -140
  6. package/dist/_dts/blocks/src/PageRenderer.d.ts +20 -10
  7. package/dist/_dts/blocks/src/index.d.ts +2 -1
  8. package/dist/_dts/blocks/src/pageRendererBoundaries.d.ts +30 -0
  9. package/dist/_dts/blocks/src/pageRenderingMode.d.ts +37 -0
  10. package/dist/_dts/blocks/src/server.d.ts +1 -1
  11. package/dist/_dts/db/src/generated/supabase/database.types.d.ts +14 -0
  12. package/dist/_dts/preview-next/src/client/blocks/pageDesignRuntimePreview.d.ts +2 -0
  13. package/dist/_dts/preview-next/src/client/index.d.ts +47 -47
  14. package/dist/_dts/preview-next/src/client/preview/PreviewShell.d.ts +18 -6
  15. package/dist/_dts/preview-next/src/client/preview/PreviewShellLayout.d.ts +30 -21
  16. package/dist/_dts/preview-next/src/client/preview/PreviewThemedSiteDocument.d.ts +18 -5
  17. package/dist/_dts/preview-next/src/client/preview/themeRuntime.d.ts +9 -0
  18. package/dist/_dts/preview-next/src/client/sdk/SdkPreviewMode.d.ts +21 -6
  19. package/dist/_dts/preview-next/src/client/sdk-runtime.d.ts +8 -8
  20. package/dist/_dts/sdk/src/next/catch-all.d.ts +6 -0
  21. package/dist/_dts/sdk/src/next/index.d.ts +2 -1
  22. package/dist/_dts/sdk/src/next/renderSdkContent.d.ts +33 -0
  23. package/dist/_dts/sdk/src/next/types.d.ts +23 -9
  24. package/dist/_dts/sdk/src/preview-next/before-render.d.ts +4 -6
  25. package/dist/_dts/sdk/src/preview-next/client/index.d.ts +3 -3
  26. package/dist/_dts/sdk/src/preview-next/client/runtime.d.ts +1 -1
  27. package/dist/_dts/sdk/src/rendering/blocks-page-renderer.d.ts +25 -3
  28. package/dist/_dts/sdk/src/rendering/components/Block.shared.d.ts +13 -2
  29. package/dist/_dts/sdk/src/rendering/components/Layout.d.ts +31 -18
  30. package/dist/_dts/sdk/src/rendering/components/pageShared.d.ts +20 -9
  31. package/dist/_dts/sdk/src/rendering/index.d.ts +4 -2
  32. package/dist/_dts/sdk/src/rendering/renderingMode.d.ts +23 -0
  33. package/dist/_dts/sdk/src/rendering/server.d.ts +5 -3
  34. package/dist/_dts/sdk/src/rendering/themeRuntime.d.ts +6 -0
  35. package/dist/_dts/sdk/src/version.d.ts +1 -1
  36. package/dist/cli/index.mjs +237 -211
  37. package/dist/cli/init-docs/content/workflow-preview-mode.md +24 -11
  38. package/dist/client/client.mjs +420 -337
  39. package/dist/client/rendering.mjs +503 -358
  40. package/dist/preview-next/before-render.mjs +10 -3
  41. package/dist/preview-next/client/runtime.mjs +3 -3
  42. package/dist/{sdk-runtime-Cn_QSCOg.mjs → sdk-runtime-CfZd5pAm.mjs} +1 -1
  43. package/dist/{separator-CEoGABRc.mjs → separator-DkTe68HE.mjs} +1 -1
  44. package/dist/server/components.mjs +478 -351
  45. package/dist/server/index.mjs +1 -1
  46. package/dist/server/next.mjs +640 -500
  47. package/dist/server/prebuild.mjs +1 -1
  48. package/dist/server/rendering/server.mjs +499 -355
  49. package/dist/server/rendering.mjs +499 -355
  50. package/dist/server/server.mjs +1 -1
  51. package/package.json +1 -1
@@ -61,7 +61,9 @@ export async function proxy(request: NextRequest) {
61
61
  }
62
62
 
63
63
  export const config = {
64
- matcher: ['/((?!_next/static|_next/image|api|favicon.ico|robots.txt|sitemap.xml).*)'],
64
+ matcher: [
65
+ '/((?!_next/static|_next/image|api|favicon.ico|robots.txt|sitemap.xml).*)',
66
+ ],
65
67
  }
66
68
  ```
67
69
 
@@ -102,13 +104,17 @@ Create `src/components/preview/SdkPreviewModeClient.tsx`:
102
104
  ```tsx
103
105
  'use client'
104
106
 
105
- import { PreviewQueryProvider, SdkPreviewMode, type SdkPreviewModeProps } from '@riverbankcms/sdk/preview-next/client'
107
+ import {
108
+ PreviewQueryProvider,
109
+ SdkPreviewMode,
110
+ type SdkPreviewModePropsWithoutBlockOverrides,
111
+ } from '@riverbankcms/sdk/preview-next/client'
106
112
 
107
113
  import { blockOverrides } from '@/lib/block-overrides'
108
114
 
109
- type SdkPreviewModeClientProps = Omit<SdkPreviewModeProps, 'blockOverrides'>
110
-
111
- export function SdkPreviewModeClient(props: SdkPreviewModeClientProps) {
115
+ export function SdkPreviewModeClient(
116
+ props: SdkPreviewModePropsWithoutBlockOverrides
117
+ ) {
112
118
  return (
113
119
  <PreviewQueryProvider>
114
120
  <SdkPreviewMode {...props} blockOverrides={blockOverrides} />
@@ -168,7 +174,11 @@ function SiteFooter() {
168
174
  return <footer>{/* your site footer */}</footer>
169
175
  }
170
176
 
171
- export default async function RootLayout({ children }: { children: ReactNode }) {
177
+ export default async function RootLayout({
178
+ children,
179
+ }: {
180
+ children: ReactNode
181
+ }) {
172
182
  const session = await getPreviewSession()
173
183
  const hasEditablePreviewSession = Boolean(session?.canEdit && session?.token)
174
184
  const headerNode = <SiteHeader />
@@ -178,7 +188,10 @@ export default async function RootLayout({ children }: { children: ReactNode })
178
188
  <html lang="en">
179
189
  <body>
180
190
  {hasEditablePreviewSession ? (
181
- <PreviewLayoutProvider headerNode={headerNode} footerNode={footerNode}>
191
+ <PreviewLayoutProvider
192
+ headerNode={headerNode}
193
+ footerNode={footerNode}
194
+ >
182
195
  {children}
183
196
  </PreviewLayoutProvider>
184
197
  ) : (
@@ -204,15 +217,15 @@ If your custom chrome needs CMS navigation data, build the `headerNode` and `foo
204
217
  For Tailwind sites, add this to `src/app/globals.css`:
205
218
 
206
219
  ```css
207
- @import "tailwindcss";
208
- @import "@riverbankcms/sdk/preview-next/tailwind-sources.css";
209
- @import "@riverbankcms/sdk/preview-next/chrome.css";
220
+ @import 'tailwindcss';
221
+ @import '@riverbankcms/sdk/preview-next/tailwind-sources.css';
222
+ @import '@riverbankcms/sdk/preview-next/chrome.css';
210
223
  ```
211
224
 
212
225
  For non-Tailwind sites, use the legacy single import:
213
226
 
214
227
  ```css
215
- @import "@riverbankcms/sdk/preview-next/styles.css";
228
+ @import '@riverbankcms/sdk/preview-next/styles.css';
216
229
  ```
217
230
 
218
231
  ## Environment Variables