@riverbankcms/sdk 0.128.0 → 0.129.1
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.
- package/README.md +52 -256
- package/dist/{PreviewEditorSidebar-Dbvb7GIr.mjs → PreviewEditorSidebar-DceRseRV.mjs} +3 -3
- package/dist/{PreviewEditorUI-e9O9l20X.mjs → PreviewEditorUI-BNunq3kk.mjs} +2 -2
- package/dist/{SdkPreviewModeRuntime-BZHt6e9w.mjs → SdkPreviewModeRuntime-Bt87-62u.mjs} +495 -292
- package/dist/{SiteChromeCustomizeContext-CvuGbHJX.mjs → SiteChromeCustomizeContext-BLl-OlL4.mjs} +600 -533
- package/dist/_dts/ai/src/contracts/commandExposure.d.ts +1 -1
- package/dist/_dts/ai/src/contracts/proposals.d.ts +4897 -4897
- package/dist/_dts/api/src/index.d.ts +2 -1
- package/dist/_dts/api/src/sdk-event-management.d.ts +53 -0
- package/dist/_dts/api/src/sdk-event-schedule.d.ts +3 -6
- package/dist/_dts/api/src/sdkContracts.d.ts +37 -50
- package/dist/_dts/api/src/sdkThemeWire.d.ts +2595 -0
- package/dist/_dts/api/src/sitePlatformEndpoints.d.ts +13 -29
- package/dist/_dts/blocks/src/PageRenderer.d.ts +20 -10
- package/dist/_dts/blocks/src/index.d.ts +2 -1
- package/dist/_dts/blocks/src/pageRendererBoundaries.d.ts +30 -0
- package/dist/_dts/blocks/src/pageRenderingMode.d.ts +37 -0
- package/dist/_dts/blocks/src/server.d.ts +1 -1
- package/dist/_dts/db/src/generated/supabase/database.types.d.ts +14 -0
- package/dist/_dts/media-core/src/index.d.ts +1 -0
- package/dist/_dts/preview-next/src/client/blocks/pageDesignRuntimePreview.d.ts +2 -0
- package/dist/_dts/preview-next/src/client/index.d.ts +47 -47
- package/dist/_dts/preview-next/src/client/preview/PreviewShell.d.ts +18 -6
- package/dist/_dts/preview-next/src/client/preview/PreviewShellLayout.d.ts +30 -21
- package/dist/_dts/preview-next/src/client/preview/PreviewThemedSiteDocument.d.ts +18 -5
- package/dist/_dts/preview-next/src/client/preview/themeRuntime.d.ts +9 -0
- package/dist/_dts/preview-next/src/client/sdk/SdkPreviewMode.d.ts +21 -6
- package/dist/_dts/preview-next/src/client/sdk-runtime.d.ts +8 -8
- package/dist/_dts/sdk/src/config/types.d.ts +4 -4
- package/dist/_dts/sdk/src/next/catch-all.d.ts +6 -0
- package/dist/_dts/sdk/src/next/index.d.ts +2 -1
- package/dist/_dts/sdk/src/next/renderSdkContent.d.ts +33 -0
- package/dist/_dts/sdk/src/next/types.d.ts +23 -9
- package/dist/_dts/sdk/src/preview-next/before-render.d.ts +4 -6
- package/dist/_dts/sdk/src/preview-next/client/index.d.ts +3 -3
- package/dist/_dts/sdk/src/preview-next/client/runtime.d.ts +1 -1
- package/dist/_dts/sdk/src/rendering/blocks-page-renderer.d.ts +25 -3
- package/dist/_dts/sdk/src/rendering/components/Block.shared.d.ts +13 -2
- package/dist/_dts/sdk/src/rendering/components/Layout.d.ts +31 -18
- package/dist/_dts/sdk/src/rendering/components/pageShared.d.ts +20 -9
- package/dist/_dts/sdk/src/rendering/index.d.ts +4 -2
- package/dist/_dts/sdk/src/rendering/renderingMode.d.ts +23 -0
- package/dist/_dts/sdk/src/rendering/server.d.ts +5 -3
- package/dist/_dts/sdk/src/rendering/themeRuntime.d.ts +6 -0
- package/dist/_dts/sdk/src/version.d.ts +1 -1
- package/dist/_dts/theme-core/src/buttons/index.d.ts +1 -0
- package/dist/_dts/theme-core/src/palette/index.d.ts +1 -0
- package/dist/_dts/theme-core/src/site-styles/headerLayoutStyleCatalog.d.ts +254 -0
- package/dist/_dts/theme-core/src/site-styles/headerLegacyLooks.d.ts +372 -0
- package/dist/_dts/theme-core/src/site-styles/headerLookBranding.d.ts +106 -0
- package/dist/_dts/theme-core/src/site-styles/headerLookSelection.d.ts +2 -0
- package/dist/_dts/theme-core/src/site-styles/headerLookTypes.d.ts +212 -0
- package/dist/_dts/theme-core/src/site-styles/headerLooks.d.ts +7 -841
- package/dist/_dts/theme-core/src/site-styles/headerStyleCompiler.d.ts +3 -0
- package/dist/_dts/theme-core/src/site-styles/headerStyleCompilerPrimitives.d.ts +23 -0
- package/dist/client/client.mjs +911 -762
- package/dist/client/hooks.mjs +59 -36
- package/dist/client/rendering/client.mjs +593 -547
- package/dist/client/rendering.mjs +994 -783
- package/dist/preview-next/before-render.mjs +10 -3
- package/dist/preview-next/client/runtime.mjs +3 -3
- package/dist/{sdk-runtime-Cn_QSCOg.mjs → sdk-runtime-C20CVWbb.mjs} +1 -1
- package/dist/{separator-CEoGABRc.mjs → separator-BE3NCquy.mjs} +1 -1
- package/dist/server/components.mjs +549 -399
- package/dist/server/config-validation.mjs +59 -36
- package/dist/server/config.mjs +59 -36
- package/dist/server/data.mjs +59 -36
- package/dist/server/index.mjs +1 -1
- package/dist/server/manifest.mjs +4966 -0
- package/dist/server/next.mjs +700 -537
- package/dist/server/page-converter.mjs +40 -36
- package/dist/server/prebuild.mjs +1 -1
- package/dist/server/rendering/server.mjs +571 -404
- package/dist/server/rendering.mjs +571 -404
- package/dist/server/routing.mjs +472 -402
- package/dist/server/server.mjs +60 -37
- package/dist/server/theme-bridge.mjs +70 -66
- package/package.json +9 -12
- package/dist/_dts/api/src/event-presentation.d.ts +0 -14
- package/dist/_dts/blocks/src/definitions.d.ts +0 -14
- package/dist/_dts/sdk/src/cli/canonical-entry-policy.d.ts +0 -53
- package/dist/_dts/sdk/src/cli/commands/audit.d.ts +0 -101
- package/dist/_dts/sdk/src/cli/commands/block.d.ts +0 -24
- package/dist/_dts/sdk/src/cli/commands/compare.d.ts +0 -62
- package/dist/_dts/sdk/src/cli/commands/content-type.d.ts +0 -10
- package/dist/_dts/sdk/src/cli/commands/content.d.ts +0 -56
- package/dist/_dts/sdk/src/cli/commands/delete.d.ts +0 -14
- package/dist/_dts/sdk/src/cli/commands/deploy.d.ts +0 -43
- package/dist/_dts/sdk/src/cli/commands/drafts.d.ts +0 -18
- package/dist/_dts/sdk/src/cli/commands/entry.d.ts +0 -55
- package/dist/_dts/sdk/src/cli/commands/env.d.ts +0 -31
- package/dist/_dts/sdk/src/cli/commands/event.d.ts +0 -23
- package/dist/_dts/sdk/src/cli/commands/eventOccurrenceSchedule.d.ts +0 -12
- package/dist/_dts/sdk/src/cli/commands/identifiers.d.ts +0 -10
- package/dist/_dts/sdk/src/cli/commands/init-docs.d.ts +0 -13
- package/dist/_dts/sdk/src/cli/commands/manifest.d.ts +0 -10
- package/dist/_dts/sdk/src/cli/commands/media-validation.d.ts +0 -3
- package/dist/_dts/sdk/src/cli/commands/migrate.d.ts +0 -11
- package/dist/_dts/sdk/src/cli/commands/navigation.d.ts +0 -12
- package/dist/_dts/sdk/src/cli/commands/page.d.ts +0 -14
- package/dist/_dts/sdk/src/cli/commands/publish-all.d.ts +0 -50
- package/dist/_dts/sdk/src/cli/commands/pull-dated-offering-scope.d.ts +0 -10
- package/dist/_dts/sdk/src/cli/commands/pull-dry-run.d.ts +0 -70
- package/dist/_dts/sdk/src/cli/commands/pull-scope-diff.d.ts +0 -8
- package/dist/_dts/sdk/src/cli/commands/pull.d.ts +0 -43
- package/dist/_dts/sdk/src/cli/commands/push/consts.d.ts +0 -3
- package/dist/_dts/sdk/src/cli/commands/push/execute/diff.d.ts +0 -19
- package/dist/_dts/sdk/src/cli/commands/push/execute/footer.d.ts +0 -42
- package/dist/_dts/sdk/src/cli/commands/push/execute/localMediaReporting.d.ts +0 -23
- package/dist/_dts/sdk/src/cli/commands/push/execute/media.d.ts +0 -22
- package/dist/_dts/sdk/src/cli/commands/push/execute/metadata.d.ts +0 -1
- package/dist/_dts/sdk/src/cli/commands/push/execute/reporting.d.ts +0 -7
- package/dist/_dts/sdk/src/cli/commands/push/execute/theme.d.ts +0 -63
- package/dist/_dts/sdk/src/cli/commands/push/filter.d.ts +0 -15
- package/dist/_dts/sdk/src/cli/commands/push/metadata.d.ts +0 -29
- package/dist/_dts/sdk/src/cli/commands/push/normalizeLocalContent.d.ts +0 -2
- package/dist/_dts/sdk/src/cli/commands/push/options.d.ts +0 -32
- package/dist/_dts/sdk/src/cli/commands/push/publishGuidance.d.ts +0 -15
- package/dist/_dts/sdk/src/cli/commands/push/pushAllExtras.d.ts +0 -25
- package/dist/_dts/sdk/src/cli/commands/push/scopes/commandBackedDatedOfferingScope.d.ts +0 -83
- package/dist/_dts/sdk/src/cli/commands/push/scopes/eventCategories.d.ts +0 -4
- package/dist/_dts/sdk/src/cli/commands/push/scopes/events.d.ts +0 -4
- package/dist/_dts/sdk/src/cli/commands/push/scopes/mediaPrep.d.ts +0 -14
- package/dist/_dts/sdk/src/cli/commands/push/scopes/pushScopeGeneric.d.ts +0 -6
- package/dist/_dts/sdk/src/cli/commands/push/scopes/types.d.ts +0 -87
- package/dist/_dts/sdk/src/cli/commands/push/scopes/venues.d.ts +0 -4
- package/dist/_dts/sdk/src/cli/commands/push/stale-resolution.d.ts +0 -48
- package/dist/_dts/sdk/src/cli/commands/push/stale.d.ts +0 -17
- package/dist/_dts/sdk/src/cli/commands/push/verification.d.ts +0 -56
- package/dist/_dts/sdk/src/cli/commands/push/workflowPlan.d.ts +0 -34
- package/dist/_dts/sdk/src/cli/commands/push-execute.d.ts +0 -54
- package/dist/_dts/sdk/src/cli/commands/push.d.ts +0 -40
- package/dist/_dts/sdk/src/cli/commands/setup.d.ts +0 -3
- package/dist/_dts/sdk/src/cli/commands/style.d.ts +0 -60
- package/dist/_dts/sdk/src/cli/commands/verify.d.ts +0 -11
- package/dist/_dts/sdk/src/cli/commands/webhooks.d.ts +0 -44
- package/dist/_dts/sdk/src/cli/config-loader.d.ts +0 -47
- package/dist/_dts/sdk/src/cli/content/collectionWriters.d.ts +0 -23
- package/dist/_dts/sdk/src/cli/content/edit/format.d.ts +0 -2
- package/dist/_dts/sdk/src/cli/content/edit/path.d.ts +0 -14
- package/dist/_dts/sdk/src/cli/content/edit/planner.d.ts +0 -46
- package/dist/_dts/sdk/src/cli/content/entryPaths.d.ts +0 -6
- package/dist/_dts/sdk/src/cli/content/footerFile.d.ts +0 -10
- package/dist/_dts/sdk/src/cli/content/fs-utils.d.ts +0 -39
- package/dist/_dts/sdk/src/cli/content/legacyEventScheduleShapeError.d.ts +0 -5
- package/dist/_dts/sdk/src/cli/content/localEventSchedule.d.ts +0 -17
- package/dist/_dts/sdk/src/cli/content/media-manifest.d.ts +0 -13
- package/dist/_dts/sdk/src/cli/content/metadataAfterPush.d.ts +0 -25
- package/dist/_dts/sdk/src/cli/content/metadataStore.d.ts +0 -29
- package/dist/_dts/sdk/src/cli/content/reader.d.ts +0 -488
- package/dist/_dts/sdk/src/cli/content/writer.d.ts +0 -142
- package/dist/_dts/sdk/src/cli/env-scope.d.ts +0 -2
- package/dist/_dts/sdk/src/cli/env.d.ts +0 -71
- package/dist/_dts/sdk/src/cli/errors.d.ts +0 -62
- package/dist/_dts/sdk/src/cli/helpers/ai-runtime.d.ts +0 -2
- package/dist/_dts/sdk/src/cli/helpers.d.ts +0 -399
- package/dist/_dts/sdk/src/cli/index.d.ts +0 -11
- package/dist/_dts/sdk/src/cli/init-docs/constants.d.ts +0 -16
- package/dist/_dts/sdk/src/cli/init-docs/index.d.ts +0 -12
- package/dist/_dts/sdk/src/cli/init-docs/templates.d.ts +0 -18
- package/dist/_dts/sdk/src/cli/init-docs/zod-to-markdown.d.ts +0 -28
- package/dist/_dts/sdk/src/cli/load-config.d.ts +0 -14
- package/dist/_dts/sdk/src/cli/media/identifiers.d.ts +0 -18
- package/dist/_dts/sdk/src/cli/media/local-media.d.ts +0 -14
- package/dist/_dts/sdk/src/cli/media/local-sync.d.ts +0 -91
- package/dist/_dts/sdk/src/cli/media/portable.d.ts +0 -11
- package/dist/_dts/sdk/src/cli/media/rich-text.d.ts +0 -12
- package/dist/_dts/sdk/src/cli/media/value-utils.d.ts +0 -15
- package/dist/_dts/sdk/src/cli/media/write-guard.d.ts +0 -52
- package/dist/_dts/sdk/src/cli/merge-remote/entryLocal.d.ts +0 -3
- package/dist/_dts/sdk/src/cli/merge-remote/entryMerge.d.ts +0 -78
- package/dist/_dts/sdk/src/cli/merge-remote/entryMergePlan.d.ts +0 -45
- package/dist/_dts/sdk/src/cli/merge-remote/entryMergePush.d.ts +0 -24
- package/dist/_dts/sdk/src/cli/merge-remote/entryMergeReport.d.ts +0 -18
- package/dist/_dts/sdk/src/cli/merge-remote/entryRemote.d.ts +0 -9
- package/dist/_dts/sdk/src/cli/merge-remote/entrySnapshots.d.ts +0 -48
- package/dist/_dts/sdk/src/cli/merge-remote/mergeFieldChanges.d.ts +0 -22
- package/dist/_dts/sdk/src/cli/merge-remote/pageLocal.d.ts +0 -3
- package/dist/_dts/sdk/src/cli/merge-remote/pageMerge.d.ts +0 -78
- package/dist/_dts/sdk/src/cli/merge-remote/pageMergePlan.d.ts +0 -36
- package/dist/_dts/sdk/src/cli/merge-remote/pageMergePush.d.ts +0 -23
- package/dist/_dts/sdk/src/cli/merge-remote/pageMergeReport.d.ts +0 -17
- package/dist/_dts/sdk/src/cli/merge-remote/pageSnapshots.d.ts +0 -46
- package/dist/_dts/sdk/src/cli/merge-remote/sharedBaseSnapshots.d.ts +0 -32
- package/dist/_dts/sdk/src/cli/merge-remote/sharedMergePlan.d.ts +0 -27
- package/dist/_dts/sdk/src/cli/merge-remote/sharedMergeReport.d.ts +0 -63
- package/dist/_dts/sdk/src/cli/migrations/entries.d.ts +0 -28
- package/dist/_dts/sdk/src/cli/migrations/events.d.ts +0 -73
- package/dist/_dts/sdk/src/cli/navigationIdentity.d.ts +0 -11
- package/dist/_dts/sdk/src/cli/output.d.ts +0 -133
- package/dist/_dts/sdk/src/cli/program.d.ts +0 -29
- package/dist/_dts/sdk/src/cli/push-config.d.ts +0 -49
- package/dist/_dts/sdk/src/cli/setup/setupPlan.d.ts +0 -51
- package/dist/_dts/sdk/src/cli/site-commands/commandKeys.d.ts +0 -13
- package/dist/_dts/sdk/src/cli/site-commands/commandRuntime.d.ts +0 -170
- package/dist/_dts/sdk/src/cli/site-commands/commandRuntimeCompat.d.ts +0 -21
- package/dist/_dts/sdk/src/cli/site-commands/commandSurfaceDispatch.d.ts +0 -32
- package/dist/_dts/sdk/src/cli/site-commands/datedOfferingCommands.d.ts +0 -53
- package/dist/_dts/sdk/src/cli/site-commands/entryCommands.d.ts +0 -65
- package/dist/_dts/sdk/src/cli/site-commands/eventScheduleCompiler.d.ts +0 -24
- package/dist/_dts/sdk/src/cli/site-commands/footerCommands.d.ts +0 -68
- package/dist/_dts/sdk/src/cli/site-commands/formCommands.d.ts +0 -53
- package/dist/_dts/sdk/src/cli/site-commands/index.d.ts +0 -8
- package/dist/_dts/sdk/src/cli/site-commands/localBlockManifestResolver.d.ts +0 -31
- package/dist/_dts/sdk/src/cli/site-commands/navigationCommands.d.ts +0 -57
- package/dist/_dts/sdk/src/cli/site-commands/oneOffCommands.d.ts +0 -82
- package/dist/_dts/sdk/src/cli/site-commands/pageCommands.d.ts +0 -84
- package/dist/_dts/sdk/src/cli/site-commands/pushExecution.d.ts +0 -39
- package/dist/_dts/sdk/src/cli/site-commands/pushExecutionPlan.d.ts +0 -8
- package/dist/_dts/sdk/src/cli/site-commands/pushExecutionTypes.d.ts +0 -97
- package/dist/_dts/sdk/src/cli/site-commands/residualSettingsTrimming.d.ts +0 -15
- package/dist/_dts/sdk/src/cli/sync/diff.d.ts +0 -222
- package/dist/_dts/sdk/src/cli/sync/executor.d.ts +0 -84
- package/dist/_dts/sdk/src/cli/sync/field-diff.d.ts +0 -39
- package/dist/_dts/sdk/src/cli/sync/index.d.ts +0 -10
- package/dist/_dts/sdk/src/cli/sync/mapper.d.ts +0 -41
- package/dist/_dts/sdk/src/cli/sync/media-sync.d.ts +0 -15
- package/dist/_dts/sdk/src/cli/sync/media.d.ts +0 -158
- package/dist/_dts/sdk/src/cli/sync/syncResultAggregation.d.ts +0 -4
- package/dist/_dts/sdk/src/cli/sync/validation.d.ts +0 -68
- package/dist/_dts/sdk/src/cli/utils/checksum.d.ts +0 -1
- package/dist/_dts/sdk/src/client/management/blocks.d.ts +0 -19
- package/dist/_dts/sdk/src/client/management/catalog.d.ts +0 -10
- package/dist/_dts/sdk/src/client/management/entries.d.ts +0 -6
- package/dist/_dts/sdk/src/client/management/eventCategories.d.ts +0 -6
- package/dist/_dts/sdk/src/client/management/events.d.ts +0 -7
- package/dist/_dts/sdk/src/client/management/footer.d.ts +0 -9
- package/dist/_dts/sdk/src/client/management/forms.d.ts +0 -6
- package/dist/_dts/sdk/src/client/management/http.d.ts +0 -79
- package/dist/_dts/sdk/src/client/management/identifiers.d.ts +0 -11
- package/dist/_dts/sdk/src/client/management/index.d.ts +0 -41
- package/dist/_dts/sdk/src/client/management/media.d.ts +0 -72
- package/dist/_dts/sdk/src/client/management/navigation.d.ts +0 -6
- package/dist/_dts/sdk/src/client/management/pages.d.ts +0 -6
- package/dist/_dts/sdk/src/client/management/pull.d.ts +0 -6
- package/dist/_dts/sdk/src/client/management/settings-branding.d.ts +0 -32
- package/dist/_dts/sdk/src/client/management/settings.d.ts +0 -6
- package/dist/_dts/sdk/src/client/management/theme.d.ts +0 -8
- package/dist/_dts/sdk/src/client/management/types.d.ts +0 -1069
- package/dist/_dts/sdk/src/client/management/venues.d.ts +0 -6
- package/dist/_dts/sdk/src/client/management/webhooks.d.ts +0 -3
- package/dist/_dts/sdk/src/test/env.d.ts +0 -4
- package/dist/_dts/site-commands/src/adapter.d.ts +0 -23
- package/dist/_dts/site-commands/src/appointmentCommandSchemas.d.ts +0 -100
- package/dist/_dts/site-commands/src/capabilityGaps.d.ts +0 -8
- package/dist/_dts/site-commands/src/commandContract.d.ts +0 -1277
- package/dist/_dts/site-commands/src/commandDomain.d.ts +0 -20
- package/dist/_dts/site-commands/src/commandIdentifiers.d.ts +0 -7
- package/dist/_dts/site-commands/src/commandValidation.d.ts +0 -10
- package/dist/_dts/site-commands/src/commands.d.ts +0 -1983
- package/dist/_dts/site-commands/src/domain.d.ts +0 -104
- package/dist/_dts/site-commands/src/eventCommandContent.d.ts +0 -11
- package/dist/_dts/site-commands/src/exposure.d.ts +0 -41
- package/dist/_dts/site-commands/src/guards.d.ts +0 -1
- package/dist/_dts/site-commands/src/index.d.ts +0 -18
- package/dist/_dts/site-commands/src/metadata.d.ts +0 -555
- package/dist/_dts/site-commands/src/pagePaths.d.ts +0 -6
- package/dist/_dts/site-commands/src/planner.d.ts +0 -58
- package/dist/_dts/site-commands/src/refContributions.d.ts +0 -11
- package/dist/_dts/site-commands/src/refs.d.ts +0 -90
- package/dist/_dts/site-commands/src/siteStyleCommandSchema.d.ts +0 -405
- package/dist/_dts/site-commands/src/siteStyleSelectionSchemaBuilder.d.ts +0 -46
- package/dist/_dts/site-commands/src/stableJson.d.ts +0 -5
- package/dist/_dts/site-commands/src/staticExecutionGaps.d.ts +0 -10
- package/dist/_dts/site-commands/src/venueCommandMapping.d.ts +0 -21
- package/dist/_dts/theme-core/src/data.d.ts +0 -12
- package/dist/_dts/theme-core/src/site-styles/headerStyleParts.d.ts +0 -4
- package/dist/cli/index.mjs +0 -162962
- package/dist/cli/init-docs/content/agents-section.md +0 -67
- package/dist/cli/init-docs/content/cli-reference.md +0 -1238
- package/dist/cli/init-docs/content/content-management.md +0 -792
- package/dist/cli/init-docs/content/context-brand.md +0 -125
- package/dist/cli/init-docs/content/context-brief.md +0 -77
- package/dist/cli/init-docs/content/context-knowledge.md +0 -111
- package/dist/cli/init-docs/content/getting-started.md +0 -171
- package/dist/cli/init-docs/content/site-workflows-readme.md +0 -96
- package/dist/cli/init-docs/content/workflow-add-block.md +0 -299
- package/dist/cli/init-docs/content/workflow-agent-safe-sync.md +0 -83
- package/dist/cli/init-docs/content/workflow-block-extensions.md +0 -370
- package/dist/cli/init-docs/content/workflow-cmsify-page.md +0 -357
- package/dist/cli/init-docs/content/workflow-content-types.md +0 -330
- package/dist/cli/init-docs/content/workflow-create-page.md +0 -212
- package/dist/cli/init-docs/content/workflow-custom-block.md +0 -470
- package/dist/cli/init-docs/content/workflow-editor-workflows.md +0 -130
- package/dist/cli/init-docs/content/workflow-isr-revalidation.md +0 -158
- package/dist/cli/init-docs/content/workflow-preview-mode.md +0 -239
- package/dist/cli/init-docs/content/workflow-publish.md +0 -285
- package/dist/cli/init-docs/content/workflow-remote-setup.md +0 -51
- package/dist/cli/init-docs/content/workflow-templates.md +0 -381
- /package/dist/_dts/{sdk/src/cli/utils/mime.d.ts → media-core/src/mimeType.d.ts} +0 -0
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import type { MediaAssetIndexItem } from
|
|
2
|
-
import type { SurfaceId } from
|
|
3
|
-
import type { PreviewRuntimeSession } from
|
|
4
|
-
import type { PreviewThemeRuntime } from
|
|
5
|
-
export { SdkPreviewModeRuntime as SdkPreviewMode } from
|
|
1
|
+
import type { MediaAssetIndexItem } from '../../../../blocks/src/index';
|
|
2
|
+
import type { SurfaceId } from '../../../../surfaces/src/index';
|
|
3
|
+
import type { PreviewRuntimeSession } from '../../auth-contract';
|
|
4
|
+
import type { PreviewRenderingMode, PreviewThemeRuntime } from '../preview/themeRuntime';
|
|
5
|
+
export { SdkPreviewModeRuntime as SdkPreviewMode } from './SdkPreviewModeRuntime';
|
|
6
6
|
export type SdkPreviewModeContent = {
|
|
7
7
|
page: unknown;
|
|
8
8
|
pageId: string;
|
|
@@ -18,7 +18,8 @@ export type SdkPreviewModeContent = {
|
|
|
18
18
|
supabaseUrl?: string;
|
|
19
19
|
mediaAssets?: MediaAssetIndexItem[];
|
|
20
20
|
};
|
|
21
|
-
export type
|
|
21
|
+
export type SdkPreviewRenderingMode = PreviewRenderingMode;
|
|
22
|
+
type SdkPreviewModeCommonProps = {
|
|
22
23
|
apiBaseUrl: string;
|
|
23
24
|
dashboardBaseUrl?: string | null;
|
|
24
25
|
siteId: string;
|
|
@@ -27,6 +28,20 @@ export type SdkPreviewModeProps = {
|
|
|
27
28
|
previewSession: PreviewRuntimeSession | null;
|
|
28
29
|
previewToken: string;
|
|
29
30
|
content: SdkPreviewModeContent;
|
|
31
|
+
};
|
|
32
|
+
type ThemedSdkPreviewModeProps = SdkPreviewModeCommonProps & {
|
|
33
|
+
rendering?: Extract<PreviewRenderingMode, {
|
|
34
|
+
kind: 'themed';
|
|
35
|
+
}>;
|
|
30
36
|
blockOverrides?: unknown;
|
|
31
37
|
themeRuntime?: PreviewThemeRuntime;
|
|
32
38
|
};
|
|
39
|
+
type OverrideOnlySdkPreviewModeProps = SdkPreviewModeCommonProps & {
|
|
40
|
+
rendering: Extract<PreviewRenderingMode, {
|
|
41
|
+
kind: 'overrides-only';
|
|
42
|
+
}>;
|
|
43
|
+
blockOverrides: unknown;
|
|
44
|
+
themeRuntime?: never;
|
|
45
|
+
};
|
|
46
|
+
export type SdkPreviewModeProps = ThemedSdkPreviewModeProps | OverrideOnlySdkPreviewModeProps;
|
|
47
|
+
export type SdkPreviewModePropsWithoutBlockOverrides = SdkPreviewModeProps extends infer Props ? Props extends unknown ? Omit<Props, 'blockOverrides'> : never : never;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export { PreviewLayoutProvider, usePreviewLayout, useOptionalPreviewLayout, } from
|
|
2
|
-
export { PreviewQueryProvider, createPreviewQueryClient, } from
|
|
3
|
-
export { PreviewShell } from
|
|
4
|
-
export type { PreviewShellProps } from
|
|
5
|
-
export { PreviewShellLayout } from
|
|
6
|
-
export type { PreviewShellLayoutProps } from
|
|
7
|
-
export type { SdkPreviewModeContent, SdkPreviewModeProps, } from
|
|
8
|
-
export { SdkPreviewMode } from
|
|
1
|
+
export { PreviewLayoutProvider, usePreviewLayout, useOptionalPreviewLayout, } from './layout/PreviewLayoutContext';
|
|
2
|
+
export { PreviewQueryProvider, createPreviewQueryClient, } from './preview/PreviewQueryProvider';
|
|
3
|
+
export { PreviewShell } from './preview/PreviewShell';
|
|
4
|
+
export type { PreviewShellProps } from './preview/PreviewShell';
|
|
5
|
+
export { PreviewShellLayout } from './preview/PreviewShellLayout';
|
|
6
|
+
export type { PreviewShellLayoutProps } from './preview/PreviewShellLayout';
|
|
7
|
+
export type { SdkPreviewModeContent, SdkPreviewModeProps, SdkPreviewModePropsWithoutBlockOverrides, } from './sdk/SdkPreviewMode';
|
|
8
|
+
export { SdkPreviewMode } from './sdk/SdkPreviewMode';
|
|
@@ -276,7 +276,7 @@ export type BlockFieldExtensionsMap = Record<string, BlockFieldExtension>;
|
|
|
276
276
|
/**
|
|
277
277
|
* Sync behavior configuration for CLI push operations.
|
|
278
278
|
*
|
|
279
|
-
* Controls how the
|
|
279
|
+
* Controls how the Riverbank CLI handles content synchronization.
|
|
280
280
|
* Status changes (draft/published) are synced based on local file status.
|
|
281
281
|
*/
|
|
282
282
|
export interface SyncConfig {
|
|
@@ -314,7 +314,7 @@ export interface DeployConfig {
|
|
|
314
314
|
* Top-level SDK site configuration.
|
|
315
315
|
*
|
|
316
316
|
* This is the complete configuration that SDK sites define in their
|
|
317
|
-
* `riverbank.config.ts` file and use it via the
|
|
317
|
+
* `riverbank.config.ts` file and use it via the Riverbank CLI.
|
|
318
318
|
*
|
|
319
319
|
* @example
|
|
320
320
|
* ```typescript
|
|
@@ -501,7 +501,7 @@ export interface RiverbankSiteConfig {
|
|
|
501
501
|
/**
|
|
502
502
|
* Sync behavior configuration for CLI push operations.
|
|
503
503
|
*
|
|
504
|
-
* Controls how the
|
|
504
|
+
* Controls how the Riverbank CLI handles content synchronization when
|
|
505
505
|
* pushing content from local files to the CMS.
|
|
506
506
|
* Status (draft/published) is synced based on local file status.
|
|
507
507
|
*
|
|
@@ -567,7 +567,7 @@ export interface RiverbankSiteConfig {
|
|
|
567
567
|
/**
|
|
568
568
|
* Dashboard configuration for CMS UI behavior.
|
|
569
569
|
*
|
|
570
|
-
* This is stored in `sites.sdk_config` and can be pushed via the
|
|
570
|
+
* This is stored in `sites.sdk_config` and can be pushed via the Riverbank CLI.
|
|
571
571
|
* It allows per-site customization of what the dashboard shows (navigation,
|
|
572
572
|
* experimental features, etc.).
|
|
573
573
|
*/
|
|
@@ -1,3 +1,9 @@
|
|
|
1
1
|
import type { CreateCatchAllPageOptions, CreateCatchAllPageResult } from './types';
|
|
2
|
+
type InvalidCatchAllRenderingOption = 'missing_block_overrides' | 'theme_option_in_overrides_only' | 'theme_runtime_in_overrides_only';
|
|
3
|
+
export declare class InvalidCatchAllRenderingOptionsError extends Error {
|
|
4
|
+
readonly code: InvalidCatchAllRenderingOption;
|
|
5
|
+
constructor(code: InvalidCatchAllRenderingOption);
|
|
6
|
+
}
|
|
2
7
|
/** Build a Next.js catch-all page and metadata generator for Riverbank content. */
|
|
3
8
|
export declare function createCatchAllPage(options: CreateCatchAllPageOptions): CreateCatchAllPageResult;
|
|
9
|
+
export {};
|
|
@@ -37,9 +37,10 @@
|
|
|
37
37
|
*
|
|
38
38
|
* @packageDocumentation
|
|
39
39
|
*/
|
|
40
|
-
export { createCatchAllPage } from './catch-all';
|
|
40
|
+
export { createCatchAllPage, InvalidCatchAllRenderingOptionsError, } from './catch-all';
|
|
41
41
|
export { RiverbankContentLoadError, SdkContentLoadError, classifyContentLoadError, isSdkContentLoadError, toContentLoadFailureLogFields, type CatchAllContentLoadFailureContext, type CatchAllRequestContext, type ClassifiedContentLoadError, type SdkContentLoadFailure, type SdkContentLoadFailureKind, type SdkContentLoadNotFound, } from './content-load-failure';
|
|
42
42
|
export type { CreateCatchAllPageOptions, CreateCatchAllPageResult, CatchAllPageProps, CatchAllContext, ThemeSwitchConfigV1, ThemeResolverContext, } from './types';
|
|
43
|
+
export type { SdkOverrideOnlyRendering, SdkOverrideOnlyRuntime, SdkRenderingMode, } from '../rendering/renderingMode';
|
|
43
44
|
export type { BlockLoaderMap, DataLoaderContext, DataLoaderFn, DataLoaderOverrides, DataLoaderPreviewStage, DataLoaderRenderTarget, DataLoaderSearchParams, DataLoaderValue, } from '../data/types';
|
|
44
45
|
export { createGenerateStaticParams, generateAllStaticParams, normalizeStaticRoutePath, validateStaticParamsEnv, pathToSlugArray, routesToStaticParams, type CreateGenerateStaticParamsOptions, type GenerateAllStaticParamsOptions, type StaticParam, type StaticParamsClient, type StaticParamsEnvResult, type StaticParamsFailureContext, type StaticParamsFailureMode, type StaticParamsRoute, } from './static-params';
|
|
45
46
|
export { createSitemap, type CreateSitemapOptions, type SitemapGenerator, } from './sitemap';
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { type LoadContentResult } from '../rendering/helpers/loadContent';
|
|
3
|
+
import type { BlockOverrideRegistrations } from '../rendering/overrides';
|
|
4
|
+
import type { SdkRenderingMode } from '../rendering/renderingMode';
|
|
5
|
+
import type { SdkThemeRuntime } from '../rendering/themeRuntime';
|
|
6
|
+
import type { Theme } from '../contracts';
|
|
7
|
+
import type { toEntrySubrouteContext } from './catch-all-utils';
|
|
8
|
+
type CommonRenderInput = Readonly<{
|
|
9
|
+
apiBaseUrl: string;
|
|
10
|
+
blockOverrides?: BlockOverrideRegistrations;
|
|
11
|
+
content: LoadContentResult;
|
|
12
|
+
entrySubrouteContext: ReturnType<typeof toEntrySubrouteContext>;
|
|
13
|
+
portalToken: string | null;
|
|
14
|
+
preview: boolean;
|
|
15
|
+
}>;
|
|
16
|
+
export type SdkContentRenderInput = CommonRenderInput & (Readonly<{
|
|
17
|
+
kind: 'themed';
|
|
18
|
+
theme: Theme;
|
|
19
|
+
themeRuntime: SdkThemeRuntime;
|
|
20
|
+
}> | Readonly<{
|
|
21
|
+
kind: 'overrides-only';
|
|
22
|
+
rendering: Extract<SdkRenderingMode, {
|
|
23
|
+
kind: 'overrides-only';
|
|
24
|
+
}>;
|
|
25
|
+
}>);
|
|
26
|
+
export type RenderSdkContentResult = Readonly<{
|
|
27
|
+
kind: 'rendered';
|
|
28
|
+
node: React.ReactNode;
|
|
29
|
+
}> | Readonly<{
|
|
30
|
+
kind: 'not-found';
|
|
31
|
+
}>;
|
|
32
|
+
export declare function renderSdkContent(input: SdkContentRenderInput): Promise<RenderSdkContentResult>;
|
|
33
|
+
export {};
|
|
@@ -9,6 +9,7 @@ import type { RiverbankClient } from '../client/types';
|
|
|
9
9
|
import type { RiverbankSiteConfig } from '../config/types';
|
|
10
10
|
import type { Theme } from '../contracts';
|
|
11
11
|
import type { SdkThemeRuntime } from '../rendering/themeRuntime';
|
|
12
|
+
import type { SdkOverrideOnlyRendering, SdkRenderingMode } from '../rendering/renderingMode';
|
|
12
13
|
import type { BlockOverrideRegistrations } from '../rendering/overrides';
|
|
13
14
|
import type { Metadata } from '../metadata/generatePageMetadata';
|
|
14
15
|
import type { LoadContentResult } from '../rendering/helpers/loadContent';
|
|
@@ -30,6 +31,8 @@ export interface CatchAllContext {
|
|
|
30
31
|
* visual theme/responsive infrastructure contract.
|
|
31
32
|
*/
|
|
32
33
|
themeRuntime: SdkThemeRuntime;
|
|
34
|
+
/** Explicit rendering capabilities selected for this request. */
|
|
35
|
+
rendering: SdkRenderingMode;
|
|
33
36
|
/** Search parameters from the URL (for filtering, pagination, etc.) */
|
|
34
37
|
searchParams: DataLoaderSearchParams;
|
|
35
38
|
}
|
|
@@ -138,7 +141,7 @@ type CatchAllThemeOptions = {
|
|
|
138
141
|
* });
|
|
139
142
|
* ```
|
|
140
143
|
*/
|
|
141
|
-
|
|
144
|
+
type CreateCatchAllPageBaseOptions = {
|
|
142
145
|
/**
|
|
143
146
|
* Function that returns the Riverbank client.
|
|
144
147
|
* Called fresh on each request to support different caching strategies.
|
|
@@ -186,7 +189,6 @@ export type CreateCatchAllPageOptions = {
|
|
|
186
189
|
* Wrap client-heavy dynamic imports with defineLazyBlockOverride(); raw
|
|
187
190
|
* promise-returning functions are not lazy override registrations.
|
|
188
191
|
*/
|
|
189
|
-
blockOverrides?: BlockOverrideRegistrations;
|
|
190
192
|
/**
|
|
191
193
|
* Server-only host data loaders for custom blocks.
|
|
192
194
|
*
|
|
@@ -286,12 +288,6 @@ export type CreateCatchAllPageOptions = {
|
|
|
286
288
|
wrapper?: (props: {
|
|
287
289
|
children: ReactNode;
|
|
288
290
|
}) => ReactNode | Promise<ReactNode>;
|
|
289
|
-
/**
|
|
290
|
-
* Controls the runtime wrapper around rendered page content.
|
|
291
|
-
*
|
|
292
|
-
* @default { kind: 'responsive-only' }
|
|
293
|
-
*/
|
|
294
|
-
themeRuntime?: SdkThemeRuntime;
|
|
295
291
|
/**
|
|
296
292
|
* Enable portal authentication for the reserved `/portal` customer route.
|
|
297
293
|
*
|
|
@@ -315,7 +311,25 @@ export type CreateCatchAllPageOptions = {
|
|
|
315
311
|
* ```
|
|
316
312
|
*/
|
|
317
313
|
enablePortal?: boolean;
|
|
318
|
-
}
|
|
314
|
+
};
|
|
315
|
+
type ThemedCatchAllOptions = CatchAllThemeOptions & {
|
|
316
|
+
/** Default theme-backed rendering behavior. */
|
|
317
|
+
rendering?: never;
|
|
318
|
+
blockOverrides?: BlockOverrideRegistrations;
|
|
319
|
+
/** @default { kind: 'responsive-only' } */
|
|
320
|
+
themeRuntime?: SdkThemeRuntime;
|
|
321
|
+
};
|
|
322
|
+
type OverrideOnlyCatchAllOptions = {
|
|
323
|
+
/** Render exclusively through host-provided block overrides. */
|
|
324
|
+
rendering: SdkOverrideOnlyRendering;
|
|
325
|
+
blockOverrides: BlockOverrideRegistrations;
|
|
326
|
+
themeRuntime?: never;
|
|
327
|
+
theme?: never;
|
|
328
|
+
themes?: never;
|
|
329
|
+
themeSwitch?: never;
|
|
330
|
+
getTheme?: never;
|
|
331
|
+
};
|
|
332
|
+
export type CreateCatchAllPageOptions = CreateCatchAllPageBaseOptions & (ThemedCatchAllOptions | OverrideOnlyCatchAllOptions);
|
|
319
333
|
/**
|
|
320
334
|
* Next.js page props for catch-all routes.
|
|
321
335
|
*
|
|
@@ -1,14 +1,13 @@
|
|
|
1
|
-
import type { ComponentType, ReactNode } from
|
|
2
|
-
import type { CatchAllContext } from
|
|
3
|
-
import type {
|
|
4
|
-
type PreviewModeClientProps = Omit<SdkPreviewModeProps, "blockOverrides">;
|
|
1
|
+
import type { ComponentType, ReactNode } from 'react';
|
|
2
|
+
import type { CatchAllContext } from '../next/types';
|
|
3
|
+
import type { SdkPreviewModePropsWithoutBlockOverrides } from './client';
|
|
5
4
|
export type CreatePreviewModeBeforeRenderOptions = {
|
|
6
5
|
getClient: () => {
|
|
7
6
|
getBaseUrl(): string;
|
|
8
7
|
};
|
|
9
8
|
siteId: string;
|
|
10
9
|
siteSlug: string;
|
|
11
|
-
PreviewModeClient: ComponentType<
|
|
10
|
+
PreviewModeClient: ComponentType<SdkPreviewModePropsWithoutBlockOverrides>;
|
|
12
11
|
/**
|
|
13
12
|
* When omitted, defaults to `process.env.RIVERBANK_PREVIEW_MODE === 'true'`.
|
|
14
13
|
* This mirrors the scaffolds and makes it easy to keep preview wiring committed
|
|
@@ -34,4 +33,3 @@ export type CreatePreviewModeBeforeRenderOptions = {
|
|
|
34
33
|
* (e.g. `SdkPreviewModeClient`) to avoid serializing functions over the RSC boundary.
|
|
35
34
|
*/
|
|
36
35
|
export declare function createPreviewModeBeforeRender(options: CreatePreviewModeBeforeRenderOptions): (context: CatchAllContext) => Promise<ReactNode | null>;
|
|
37
|
-
export {};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import React, { type ReactNode } from
|
|
2
|
-
import type { PreviewShellLayoutProps, PreviewShellProps, SdkPreviewModeProps } from
|
|
3
|
-
export type { SdkPreviewModeContent, SdkPreviewModeProps, PreviewThemeRuntime, PreviewThemeResponsiveMode, PreviewShellProps, PreviewShellLayoutProps, } from '../../../../preview-next/src/client/index';
|
|
1
|
+
import React, { type ReactNode } from 'react';
|
|
2
|
+
import type { PreviewShellLayoutProps, PreviewShellProps, SdkPreviewModeProps } from '../../../../preview-next/src/client/index';
|
|
3
|
+
export type { SdkPreviewModeContent, SdkPreviewModeProps, SdkPreviewModePropsWithoutBlockOverrides, PreviewThemeRuntime, PreviewThemeResponsiveMode, PreviewShellProps, PreviewShellLayoutProps, } from '../../../../preview-next/src/client/index';
|
|
4
4
|
type PreviewQueryProviderProps = Readonly<{
|
|
5
5
|
children: ReactNode;
|
|
6
6
|
}>;
|
|
@@ -2,7 +2,7 @@ import React from 'react';
|
|
|
2
2
|
import type { PreviewShellLayoutProps, PreviewShellProps, SdkPreviewModeProps } from '../../../../preview-next/src/client/sdk-runtime';
|
|
3
3
|
export { PreviewLayoutProvider, usePreviewLayout, useOptionalPreviewLayout, } from '../../../../preview-next/src/client/layout/PreviewLayoutContext';
|
|
4
4
|
export { PreviewQueryProvider, createPreviewQueryClient, } from '../../../../preview-next/src/client/preview/PreviewQueryProvider';
|
|
5
|
-
export type { PreviewShellProps, PreviewShellLayoutProps, SdkPreviewModeContent, SdkPreviewModeProps, } from '../../../../preview-next/src/client/sdk-runtime';
|
|
5
|
+
export type { PreviewShellProps, PreviewShellLayoutProps, SdkPreviewModeContent, SdkPreviewModeProps, SdkPreviewModePropsWithoutBlockOverrides, } from '../../../../preview-next/src/client/sdk-runtime';
|
|
6
6
|
export declare function SdkPreviewMode(props: SdkPreviewModeProps): React.JSX.Element;
|
|
7
7
|
export declare function PreviewShell(props: PreviewShellProps): React.JSX.Element;
|
|
8
8
|
export declare function PreviewShellLayout(props: PreviewShellLayoutProps): React.JSX.Element;
|
|
@@ -6,6 +6,15 @@ import type { SiteBookingOfferingPresetSummary } from '../public-api/contracts';
|
|
|
6
6
|
import { type BlocksImageResolveContextInput, type BlocksMediaAssetIndexItem } from './mediaAssets';
|
|
7
7
|
import type { EventPageSurfaceSubjectWire } from '../../../core/src/index';
|
|
8
8
|
export type ComponentRegistry = Record<string, React.ElementType>;
|
|
9
|
+
export type MissingBlockOverrideError = Error & Readonly<{
|
|
10
|
+
code: 'missing_block_override';
|
|
11
|
+
blockKind: string;
|
|
12
|
+
}>;
|
|
13
|
+
type MissingBlockOverrideErrorConstructor = Readonly<{
|
|
14
|
+
new (blockKind: string): MissingBlockOverrideError;
|
|
15
|
+
prototype: MissingBlockOverrideError;
|
|
16
|
+
}>;
|
|
17
|
+
export declare const MissingBlockOverrideError: MissingBlockOverrideErrorConstructor;
|
|
9
18
|
export type PageRendererDataContext = {
|
|
10
19
|
siteId?: string;
|
|
11
20
|
pageId?: string;
|
|
@@ -36,8 +45,7 @@ export type BlocksPageRendererDataContext = Omit<PageRendererDataContext, 'media
|
|
|
36
45
|
export type SdkConfigForRenderer = {
|
|
37
46
|
customBlocks?: SdkCustomBlock[];
|
|
38
47
|
};
|
|
39
|
-
|
|
40
|
-
theme: Theme;
|
|
48
|
+
type PageRendererCommonProps = {
|
|
41
49
|
page: PageOutline | null;
|
|
42
50
|
runtimeBoundaries?: readonly PageRuntimeBoundary[];
|
|
43
51
|
usePlaceholders?: boolean;
|
|
@@ -45,10 +53,24 @@ export type PageRendererProps = {
|
|
|
45
53
|
routeMap?: RouteMap;
|
|
46
54
|
wrapBlock?: (blockId: string, rendered: React.ReactNode) => React.ReactNode;
|
|
47
55
|
registry?: ComponentRegistry;
|
|
48
|
-
themeTokens?: ThemeTokens;
|
|
49
56
|
blockOverrides?: BlockOverrides;
|
|
50
57
|
sdkConfig?: SdkConfigForRenderer | null;
|
|
51
58
|
customBlocks?: SdkCustomBlock[];
|
|
52
59
|
};
|
|
60
|
+
type ThemedPageRendererProps = PageRendererCommonProps & {
|
|
61
|
+
rendering?: never;
|
|
62
|
+
theme: Theme;
|
|
63
|
+
themeTokens?: ThemeTokens;
|
|
64
|
+
};
|
|
65
|
+
type OverrideOnlyPageRendererProps = PageRendererCommonProps & {
|
|
66
|
+
rendering: {
|
|
67
|
+
kind: 'overrides-only';
|
|
68
|
+
};
|
|
69
|
+
theme?: never;
|
|
70
|
+
themeTokens?: never;
|
|
71
|
+
blockOverrides: BlockOverrides;
|
|
72
|
+
};
|
|
73
|
+
export type PageRendererProps = ThemedPageRendererProps | OverrideOnlyPageRendererProps;
|
|
53
74
|
export declare function toBlocksPageRendererDataContext(dataContext: PageRendererDataContext): BlocksPageRendererDataContext;
|
|
54
75
|
export declare function PageRenderer(props: PageRendererProps): React.ReactElement;
|
|
76
|
+
export {};
|
|
@@ -11,11 +11,10 @@ import type { RiverbankClient } from '../../client/types';
|
|
|
11
11
|
import type { BlockKind } from '../../types';
|
|
12
12
|
import type { BlockOverrideComponent } from '../overrides';
|
|
13
13
|
export type { BlockOverrideComponent } from '../overrides';
|
|
14
|
-
|
|
14
|
+
type BlockCommonProps = {
|
|
15
15
|
blockKind: BlockKind;
|
|
16
16
|
blockId?: string | null;
|
|
17
17
|
content: Record<string, unknown>;
|
|
18
|
-
theme: Theme;
|
|
19
18
|
siteId?: string;
|
|
20
19
|
/**
|
|
21
20
|
* Supabase storage URL for direct image access in SSR output and client
|
|
@@ -63,6 +62,18 @@ export type BlockProps = {
|
|
|
63
62
|
*/
|
|
64
63
|
override?: BlockOverrideComponent;
|
|
65
64
|
};
|
|
65
|
+
type ThemedBlockProps = BlockCommonProps & {
|
|
66
|
+
rendering?: never;
|
|
67
|
+
theme: Theme;
|
|
68
|
+
};
|
|
69
|
+
type OverrideOnlyBlockProps = BlockCommonProps & {
|
|
70
|
+
rendering: {
|
|
71
|
+
kind: 'overrides-only';
|
|
72
|
+
};
|
|
73
|
+
theme?: never;
|
|
74
|
+
override: BlockOverrideComponent;
|
|
75
|
+
};
|
|
76
|
+
export type BlockProps = ThemedBlockProps | OverrideOnlyBlockProps;
|
|
66
77
|
export type BlockHydrationBootstrapConfig = {
|
|
67
78
|
siteId?: string;
|
|
68
79
|
supabaseUrl?: string;
|
|
@@ -6,32 +6,34 @@
|
|
|
6
6
|
import { buildMenu, buildFooterMenu, buildFooterMenuForRole, buildLogo } from '../../navigation';
|
|
7
7
|
import type { RiverbankClient, SiteResponse } from '../../client/types';
|
|
8
8
|
import { type SdkThemeRuntime } from '../themeRuntime';
|
|
9
|
-
|
|
9
|
+
import { type SdkOverrideOnlyRendering } from '../renderingMode';
|
|
10
|
+
export type CustomHeaderData = {
|
|
10
11
|
menu: ReturnType<typeof buildMenu>;
|
|
11
12
|
logo: ReturnType<typeof buildLogo>;
|
|
12
13
|
site: SiteResponse['site'];
|
|
13
|
-
theme: SiteResponse['theme'];
|
|
14
14
|
routes: SiteResponse['routes'];
|
|
15
15
|
};
|
|
16
|
-
export type
|
|
16
|
+
export type CustomFooterData = {
|
|
17
17
|
menu: ReturnType<typeof buildMenu>;
|
|
18
18
|
footerMenu: ReturnType<typeof buildFooterMenu>;
|
|
19
19
|
legalFooterMenu: ReturnType<typeof buildFooterMenuForRole>;
|
|
20
20
|
logo: ReturnType<typeof buildLogo>;
|
|
21
21
|
site: SiteResponse['site'];
|
|
22
|
-
theme: SiteResponse['theme'];
|
|
23
22
|
routes: SiteResponse['routes'];
|
|
24
23
|
};
|
|
25
|
-
export type
|
|
24
|
+
export type HeaderData = CustomHeaderData & {
|
|
25
|
+
theme: SiteResponse['theme'];
|
|
26
|
+
};
|
|
27
|
+
export type FooterData = CustomFooterData & {
|
|
28
|
+
theme: SiteResponse['theme'];
|
|
29
|
+
};
|
|
30
|
+
type LayoutCommonProps = {
|
|
26
31
|
siteData?: SiteResponse;
|
|
27
32
|
client?: RiverbankClient;
|
|
28
33
|
siteId?: string;
|
|
29
34
|
slug?: string;
|
|
30
35
|
domain?: string;
|
|
31
36
|
children: React.ReactNode;
|
|
32
|
-
header?: boolean | ((data: HeaderData) => React.ReactNode);
|
|
33
|
-
footer?: boolean | ((data: FooterData) => React.ReactNode);
|
|
34
|
-
headerVariant?: 'classic' | 'centered' | 'transparent' | 'floating';
|
|
35
37
|
/**
|
|
36
38
|
* Whether the current request has an active portal session.
|
|
37
39
|
* Used to resolve portal navigation labels (e.g. "Login" vs "My account").
|
|
@@ -41,17 +43,27 @@ export type LayoutProps = {
|
|
|
41
43
|
hasPortalSession?: boolean;
|
|
42
44
|
/** Render stage for internal links and block transforms. */
|
|
43
45
|
previewStage?: 'published' | 'preview';
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
*
|
|
51
|
-
* @default { kind: 'cms-theme' }
|
|
52
|
-
*/
|
|
46
|
+
};
|
|
47
|
+
type ThemedLayoutProps = LayoutCommonProps & {
|
|
48
|
+
rendering?: never;
|
|
49
|
+
header?: boolean | ((data: HeaderData) => React.ReactNode);
|
|
50
|
+
footer?: boolean | ((data: FooterData) => React.ReactNode);
|
|
51
|
+
headerVariant?: 'classic' | 'centered' | 'transparent' | 'floating';
|
|
53
52
|
themeRuntime?: SdkThemeRuntime;
|
|
54
53
|
};
|
|
54
|
+
type OverrideOnlyLayoutProps = LayoutCommonProps & {
|
|
55
|
+
rendering: SdkOverrideOnlyRendering;
|
|
56
|
+
header: false | ((data: CustomHeaderData) => React.ReactNode);
|
|
57
|
+
footer: false | ((data: CustomFooterData) => React.ReactNode);
|
|
58
|
+
headerVariant?: never;
|
|
59
|
+
themeRuntime?: never;
|
|
60
|
+
};
|
|
61
|
+
export type LayoutProps = ThemedLayoutProps | OverrideOnlyLayoutProps;
|
|
62
|
+
export declare class UnsupportedOverrideOnlyLayoutChromeError extends Error {
|
|
63
|
+
readonly surface: 'header' | 'footer';
|
|
64
|
+
readonly code = "unsupported_override_only_layout_chrome";
|
|
65
|
+
constructor(surface: 'header' | 'footer');
|
|
66
|
+
}
|
|
55
67
|
/**
|
|
56
68
|
* Layout component that wraps content with site header and footer.
|
|
57
69
|
*
|
|
@@ -87,4 +99,5 @@ export type LayoutProps = {
|
|
|
87
99
|
* </Layout>
|
|
88
100
|
* ```
|
|
89
101
|
*/
|
|
90
|
-
export declare function Layout(
|
|
102
|
+
export declare function Layout(props: LayoutProps): Promise<import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>>>;
|
|
103
|
+
export {};
|
|
@@ -7,12 +7,11 @@ import { type ComponentRegistry } from '../blocks-page-renderer';
|
|
|
7
7
|
import { type SdkThemeRuntime } from '../themeRuntime';
|
|
8
8
|
import type { BlockOverrides } from '../overrides';
|
|
9
9
|
import type { SdkCustomBlock } from '../../config/types';
|
|
10
|
-
|
|
10
|
+
import type { SdkRenderingMode } from '../renderingMode';
|
|
11
|
+
type PageCommonProps = {
|
|
11
12
|
page: PageOutline;
|
|
12
13
|
runtimeBoundaries?: readonly PageRuntimeBoundary[];
|
|
13
|
-
theme: Theme;
|
|
14
14
|
siteId: string;
|
|
15
|
-
themeTokens?: ThemeTokens;
|
|
16
15
|
resolvedData?: ResolvedBlockData;
|
|
17
16
|
bookingOfferingPresets?: readonly SiteBookingOfferingPresetSummary[];
|
|
18
17
|
routeMap?: RouteMap;
|
|
@@ -82,17 +81,29 @@ export type PageProps = {
|
|
|
82
81
|
* Keys can be full block kind ("block.hero") or short form ("hero").
|
|
83
82
|
*/
|
|
84
83
|
blockOverrides?: BlockOverrides;
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
84
|
+
};
|
|
85
|
+
type ThemedPageProps = PageCommonProps & {
|
|
86
|
+
rendering?: never;
|
|
87
|
+
theme: Theme;
|
|
88
|
+
themeTokens?: ThemeTokens;
|
|
89
|
+
/** @default { kind: 'none' } */
|
|
90
90
|
themeRuntime?: SdkThemeRuntime;
|
|
91
91
|
};
|
|
92
|
+
type OverrideOnlyPageProps = PageCommonProps & {
|
|
93
|
+
rendering: Extract<SdkRenderingMode, {
|
|
94
|
+
kind: 'overrides-only';
|
|
95
|
+
}>;
|
|
96
|
+
theme?: never;
|
|
97
|
+
themeTokens?: never;
|
|
98
|
+
themeRuntime?: never;
|
|
99
|
+
blockOverrides: BlockOverrides;
|
|
100
|
+
};
|
|
101
|
+
export type PageProps = ThemedPageProps | OverrideOnlyPageProps;
|
|
92
102
|
export type PageHydrationBootstrapConfig = {
|
|
93
103
|
siteId: string;
|
|
94
104
|
supabaseUrl?: string;
|
|
95
105
|
mediaAssets?: readonly MediaAssetIndexItem[];
|
|
96
106
|
};
|
|
97
107
|
export declare function toPageHydrationBootstrapConfig(props: Pick<PageProps, 'siteId' | 'supabaseUrl' | 'mediaAssets'>): PageHydrationBootstrapConfig;
|
|
98
|
-
export declare function PageContent(
|
|
108
|
+
export declare function PageContent(props: PageProps): ReactElement;
|
|
109
|
+
export {};
|
|
@@ -7,8 +7,10 @@
|
|
|
7
7
|
export { Page } from './components/Page';
|
|
8
8
|
export type { PageProps } from './components/Page';
|
|
9
9
|
export { Layout } from './components/Layout';
|
|
10
|
-
export type { LayoutProps, HeaderData, FooterData } from './components/Layout';
|
|
10
|
+
export type { LayoutProps, HeaderData, FooterData, CustomHeaderData, CustomFooterData, } from './components/Layout';
|
|
11
|
+
export { UnsupportedOverrideOnlyLayoutChromeError } from './components/Layout';
|
|
11
12
|
export type { SdkThemeResponsiveMode, SdkThemeRuntime } from './themeRuntime';
|
|
13
|
+
export type { SdkOverrideOnlyRendering, SdkOverrideOnlyRuntime, SdkRenderingMode, } from './renderingMode';
|
|
12
14
|
export { Block } from './components/Block';
|
|
13
15
|
export type { BlockProps } from './components/Block';
|
|
14
16
|
export { loadPage } from './helpers/loadPage';
|
|
@@ -20,7 +22,7 @@ export type { AppointmentBookingContent, BlogListingContent, BlogPostContent, Bo
|
|
|
20
22
|
export { ImagePresets } from '../contracts';
|
|
21
23
|
export { RichText } from './primitives/RichText';
|
|
22
24
|
export { resolveImageUrl, resolveImageUrlWithContext, resolveImageSourceSetWithContext, } from './image';
|
|
23
|
-
export { PageRenderer, toBlocksPageRendererDataContext, } from './blocks-page-renderer';
|
|
25
|
+
export { MissingBlockOverrideError, PageRenderer, toBlocksPageRendererDataContext, } from './blocks-page-renderer';
|
|
24
26
|
export { ThemeScope } from './blocks-theme-scope';
|
|
25
27
|
export { buildThemeRuntime } from './blocks-theme-runtime';
|
|
26
28
|
export { toBlocksImageResolveContextInput, toBlocksMediaAssets, } from './mediaAssets';
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { SdkThemeRuntime } from './themeRuntime';
|
|
2
|
+
export type SdkOverrideOnlyRuntime = Extract<SdkThemeRuntime, {
|
|
3
|
+
kind: 'responsive-only' | 'none';
|
|
4
|
+
}>;
|
|
5
|
+
export type SdkOverrideOnlyRendering = Readonly<{
|
|
6
|
+
kind: 'overrides-only';
|
|
7
|
+
runtime?: SdkOverrideOnlyRuntime;
|
|
8
|
+
}>;
|
|
9
|
+
export type SdkRenderingMode = Readonly<{
|
|
10
|
+
kind: 'themed';
|
|
11
|
+
themeRuntime: SdkThemeRuntime;
|
|
12
|
+
}> | Readonly<{
|
|
13
|
+
kind: 'overrides-only';
|
|
14
|
+
runtime: SdkOverrideOnlyRuntime;
|
|
15
|
+
}>;
|
|
16
|
+
export declare const defaultOverrideOnlyRuntime: {
|
|
17
|
+
readonly kind: "responsive-only";
|
|
18
|
+
};
|
|
19
|
+
export declare function normalizeSdkRenderingMode(input: Readonly<{
|
|
20
|
+
rendering?: SdkOverrideOnlyRendering;
|
|
21
|
+
themeRuntime: SdkThemeRuntime;
|
|
22
|
+
}>): SdkRenderingMode;
|
|
23
|
+
export declare function themeRuntimeForRendering(rendering: SdkRenderingMode): SdkThemeRuntime;
|
|
@@ -4,11 +4,13 @@
|
|
|
4
4
|
*/
|
|
5
5
|
export { Page } from './components/Page.server';
|
|
6
6
|
export type { PageProps } from './components/Page.server';
|
|
7
|
-
export { Layout } from './components/Layout';
|
|
8
|
-
export type { LayoutProps, HeaderData, FooterData } from './components/Layout';
|
|
9
|
-
export type { SdkThemeResponsiveMode, SdkThemeRuntime
|
|
7
|
+
export { Layout, UnsupportedOverrideOnlyLayoutChromeError, } from './components/Layout';
|
|
8
|
+
export type { LayoutProps, HeaderData, FooterData, CustomHeaderData, CustomFooterData, } from './components/Layout';
|
|
9
|
+
export type { SdkThemeResponsiveMode, SdkThemeRuntime } from './themeRuntime';
|
|
10
|
+
export type { SdkOverrideOnlyRendering, SdkOverrideOnlyRuntime, SdkRenderingMode, } from './renderingMode';
|
|
10
11
|
export { Block } from './components/Block.server';
|
|
11
12
|
export type { BlockProps } from './components/Block.server';
|
|
13
|
+
export { MissingBlockOverrideError } from './blocks-page-renderer';
|
|
12
14
|
export { defineBlockOverrideRegistrations, defineBlockOverrides, defineLazyBlockOverride, } from './overrides';
|
|
13
15
|
export { buildPageBlockKindIndex, collectUsedBlockKindsFromPageOutline, resolveBlockOverridesForPage, } from './overrideResolution';
|
|
14
16
|
export type { PageBlockKindIndex } from './overrideResolution';
|
|
@@ -24,3 +24,9 @@ export declare function renderWithSdkThemeRuntime({ themeRuntime, theme, childre
|
|
|
24
24
|
theme: Theme;
|
|
25
25
|
children: React.ReactNode;
|
|
26
26
|
}): React.ReactElement;
|
|
27
|
+
export declare function renderWithOverrideOnlyRuntime({ runtime, children, }: {
|
|
28
|
+
runtime: Extract<SdkThemeRuntime, {
|
|
29
|
+
kind: 'responsive-only' | 'none';
|
|
30
|
+
}>;
|
|
31
|
+
children: React.ReactNode;
|
|
32
|
+
}): React.ReactElement;
|