@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,1069 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Management Client Types
|
|
3
|
-
*
|
|
4
|
-
* Type definitions for the SDK management client used for write operations.
|
|
5
|
-
*/
|
|
6
|
-
import type { LinkPayload, NavigationLinkInput } from '../../public-api/contracts';
|
|
7
|
-
import type { APIEndpoints } from '../../../../api/src/index';
|
|
8
|
-
import type { SiteCommandOf } from '../../../../site-commands/src/index';
|
|
9
|
-
import type { SdkEventPricing, SdkEventPricingInput, SdkEventTicketTypeInput } from '../../../../api/src/sdk-event-pricing';
|
|
10
|
-
import type { SdkEventPaymentTerms, SdkEventPaymentTermsInput } from '../../../../api/src/sdk-event-payment-terms';
|
|
11
|
-
import type { SdkEventUpsertBody } from '../../../../api/src/sdk-event-upsert';
|
|
12
|
-
import type { SdkAddEventOccurrenceRequest, SdkEventOccurrenceCapacityIntent, SdkEventOccurrenceScheduleInput, SdkManagementEventOccurrence, SdkManagementEventSeries, SdkFooterContent, SdkPullEventSeries } from '../../../../api/src/sdkContracts';
|
|
13
|
-
import type { SdkPullTruncationMeta } from '../../../../api/src/sdkContracts';
|
|
14
|
-
import type { SdkCapabilitiesResponse, SdkCatalogBlocksResponse, SdkCatalogContentTypesResponse, SdkCatalogThemeResponse, SdkDemoContentResponse } from '../../../../api/src/sdkContracts';
|
|
15
|
-
import type { SdkEntryPublishErrorCode, SdkPagePublishErrorCode, SdkPublicationOutcome } from '../../../../api/src/sdkContracts';
|
|
16
|
-
import type { ButtonStyleSelection } from '../../../../theme-core/src/buttons/index';
|
|
17
|
-
import type { Theme } from '../../contracts';
|
|
18
|
-
import type { RichTextDoc } from '../../../../core/src/index';
|
|
19
|
-
export type SdkDeletePageResponse = NonNullable<APIEndpoints['sdkDeletePage']['response']>;
|
|
20
|
-
export type SdkGetPageBlockResponse = NonNullable<APIEndpoints['sdkGetPageBlock']['response']>;
|
|
21
|
-
export type SdkPatchPageBlockBody = NonNullable<APIEndpoints['sdkPatchPageBlock']['body']>;
|
|
22
|
-
export type SdkPatchPageBlockResponse = NonNullable<APIEndpoints['sdkPatchPageBlock']['response']>;
|
|
23
|
-
export type SdkPullEntriesAllResponse = NonNullable<APIEndpoints['sdkPullEntriesAll']['response']>;
|
|
24
|
-
export type SdkUpsertEntryResponse = NonNullable<APIEndpoints['sdkUpsertEntry']['response']>;
|
|
25
|
-
export type SdkUpsertPageResponse = NonNullable<APIEndpoints['sdkUpsertPage']['response']>;
|
|
26
|
-
export interface ManagementClientConfig {
|
|
27
|
-
/**
|
|
28
|
-
* Dashboard URL (e.g., http://localhost:4000 or https://dashboard.riverbankcms.com)
|
|
29
|
-
*/
|
|
30
|
-
dashboardUrl: string;
|
|
31
|
-
/**
|
|
32
|
-
* Management API key (format: bld_mgmt_sk_...)
|
|
33
|
-
*/
|
|
34
|
-
managementApiKey: string;
|
|
35
|
-
/**
|
|
36
|
-
* Site ID to operate on
|
|
37
|
-
*/
|
|
38
|
-
siteId: string;
|
|
39
|
-
/**
|
|
40
|
-
* Request timeout in milliseconds
|
|
41
|
-
* @default 30000
|
|
42
|
-
*/
|
|
43
|
-
timeout?: number;
|
|
44
|
-
}
|
|
45
|
-
export interface ManagementEntry {
|
|
46
|
-
id: string;
|
|
47
|
-
identifier: string;
|
|
48
|
-
contentType: string;
|
|
49
|
-
/** Slug for URL routing - only present for routable content types */
|
|
50
|
-
slug?: string;
|
|
51
|
-
title: string;
|
|
52
|
-
data: Record<string, unknown>;
|
|
53
|
-
publishedData: Record<string, unknown> | null;
|
|
54
|
-
status: 'draft' | 'published';
|
|
55
|
-
hasUnpublishedChanges: boolean;
|
|
56
|
-
createdAt: string;
|
|
57
|
-
updatedAt: string;
|
|
58
|
-
publishedAt: string | null;
|
|
59
|
-
manualOrder: number;
|
|
60
|
-
blocks?: EntrySlotBlocks;
|
|
61
|
-
}
|
|
62
|
-
export interface EntrySlotBlock {
|
|
63
|
-
identifier: string | null;
|
|
64
|
-
kind: string;
|
|
65
|
-
content: Record<string, unknown>;
|
|
66
|
-
}
|
|
67
|
-
export type EntrySlotBlocks = Record<string, EntrySlotBlock[]>;
|
|
68
|
-
export interface EntrySlotBlockInput {
|
|
69
|
-
identifier?: string | null;
|
|
70
|
-
kind: string;
|
|
71
|
-
content: Record<string, unknown>;
|
|
72
|
-
}
|
|
73
|
-
export type EntrySlotBlocksInput = Record<string, EntrySlotBlockInput[]>;
|
|
74
|
-
export interface EntryUpsertInput {
|
|
75
|
-
identifier: string;
|
|
76
|
-
contentType: string;
|
|
77
|
-
data: Record<string, unknown>;
|
|
78
|
-
slug?: string;
|
|
79
|
-
manualOrder?: number;
|
|
80
|
-
blocks?: EntrySlotBlocksInput;
|
|
81
|
-
/**
|
|
82
|
-
* Publication intent. 'draft' (default) writes a draft only; 'publish' runs
|
|
83
|
-
* the publish operation after a successful save. Save and publish are not
|
|
84
|
-
* atomic — a publish that fails after a successful save is reported in-band on
|
|
85
|
-
* the response, not as an error.
|
|
86
|
-
*/
|
|
87
|
-
publication?: 'draft' | 'publish';
|
|
88
|
-
}
|
|
89
|
-
/**
|
|
90
|
-
* The entry shape upsert responses carry — the wire envelope omits
|
|
91
|
-
* `publishedData` (the caller just wrote the draft; fetch with `get` when the
|
|
92
|
-
* published side is needed).
|
|
93
|
-
*/
|
|
94
|
-
export type UpsertedManagementEntry = Omit<ManagementEntry, 'publishedData'>;
|
|
95
|
-
/**
|
|
96
|
-
* Result of an entry upsert with `publication: 'publish'`. The promise resolves
|
|
97
|
-
* even when the publish stage failed — the save succeeded and the entry exists
|
|
98
|
-
* as a draft; branch on `publication.published`.
|
|
99
|
-
*/
|
|
100
|
-
export interface EntryPublishUpsertResult {
|
|
101
|
-
entry: UpsertedManagementEntry;
|
|
102
|
-
publication: SdkPublicationOutcome<SdkEntryPublishErrorCode>;
|
|
103
|
-
}
|
|
104
|
-
export interface ManagementPage {
|
|
105
|
-
id: string;
|
|
106
|
-
identifier: string | null;
|
|
107
|
-
title: string;
|
|
108
|
-
path: string;
|
|
109
|
-
status: 'draft' | 'published';
|
|
110
|
-
hasUnpublishedChanges: boolean;
|
|
111
|
-
createdAt: string;
|
|
112
|
-
updatedAt: string;
|
|
113
|
-
publishedAt: string | null;
|
|
114
|
-
}
|
|
115
|
-
export interface PageUpsertInput {
|
|
116
|
-
identifier: string;
|
|
117
|
-
title: string;
|
|
118
|
-
path: string;
|
|
119
|
-
seoTitle?: string;
|
|
120
|
-
seoDescription?: string;
|
|
121
|
-
/**
|
|
122
|
-
* Publication intent. 'draft' (default) writes a draft only; 'publish' runs
|
|
123
|
-
* page publish after a successful save. Save and publish are non-atomic; a
|
|
124
|
-
* publish failure after a successful save is reported in-band, not as an error.
|
|
125
|
-
*/
|
|
126
|
-
publication?: 'draft' | 'publish';
|
|
127
|
-
}
|
|
128
|
-
/**
|
|
129
|
-
* Result of a page upsert with `publication: 'publish'`. Resolves even when the
|
|
130
|
-
* publish stage failed — the save succeeded; branch on `publication.published`.
|
|
131
|
-
*/
|
|
132
|
-
export interface PagePublishUpsertResult {
|
|
133
|
-
page: ManagementPage;
|
|
134
|
-
publication: SdkPublicationOutcome<SdkPagePublishErrorCode>;
|
|
135
|
-
}
|
|
136
|
-
export interface ManagementBlock {
|
|
137
|
-
id: string;
|
|
138
|
-
identifier: string | null;
|
|
139
|
-
kind: string;
|
|
140
|
-
position: number;
|
|
141
|
-
data: Record<string, unknown>;
|
|
142
|
-
createdAt: string;
|
|
143
|
-
updatedAt: string;
|
|
144
|
-
}
|
|
145
|
-
export interface BlockUpsertInput {
|
|
146
|
-
identifier: string;
|
|
147
|
-
kind: string;
|
|
148
|
-
data: Record<string, unknown>;
|
|
149
|
-
position?: number;
|
|
150
|
-
}
|
|
151
|
-
export interface ManagementNavigationMenu {
|
|
152
|
-
id: string;
|
|
153
|
-
identifier: string | null;
|
|
154
|
-
name: string;
|
|
155
|
-
isPrimary: boolean;
|
|
156
|
-
isFooter: boolean;
|
|
157
|
-
footerRole: 'main' | 'legal-policy' | null;
|
|
158
|
-
items: ManagementNavigationItem[];
|
|
159
|
-
createdAt: string;
|
|
160
|
-
updatedAt: string;
|
|
161
|
-
}
|
|
162
|
-
export interface ManagementNavigationItem {
|
|
163
|
-
id: string;
|
|
164
|
-
label: string;
|
|
165
|
-
link: LinkPayload | null;
|
|
166
|
-
/** Whether this item should render as a CTA-style navigation action. */
|
|
167
|
-
isCta?: boolean;
|
|
168
|
-
position: number;
|
|
169
|
-
children?: ManagementNavigationItem[];
|
|
170
|
-
/** Resolved identifier for internal links (populated on pull) */
|
|
171
|
-
resolvedIdentifier?: string | null;
|
|
172
|
-
/** Resolved content type key for entry links (populated on pull) */
|
|
173
|
-
resolvedContentType?: string | null;
|
|
174
|
-
}
|
|
175
|
-
export interface PulledNavigationItem {
|
|
176
|
-
id: string;
|
|
177
|
-
menuId: string;
|
|
178
|
-
label: string;
|
|
179
|
-
link: LinkPayload | null;
|
|
180
|
-
/** Whether this item should render as a CTA-style navigation action. */
|
|
181
|
-
isCta?: boolean;
|
|
182
|
-
position: number;
|
|
183
|
-
parentId: string | null;
|
|
184
|
-
children?: PulledNavigationItem[];
|
|
185
|
-
/** Resolved identifier for internal links (populated on pull) */
|
|
186
|
-
resolvedIdentifier?: string | null;
|
|
187
|
-
/** Resolved content type key for entry links (populated on pull) */
|
|
188
|
-
resolvedContentType?: string | null;
|
|
189
|
-
}
|
|
190
|
-
export interface PulledNavigationMenu {
|
|
191
|
-
id: string;
|
|
192
|
-
siteId: string;
|
|
193
|
-
identifier: string | null;
|
|
194
|
-
name: string;
|
|
195
|
-
isPrimary: boolean;
|
|
196
|
-
isFooter: boolean;
|
|
197
|
-
footerRole: 'main' | 'legal-policy' | null;
|
|
198
|
-
items: PulledNavigationItem[];
|
|
199
|
-
createdAt: string;
|
|
200
|
-
updatedAt: string;
|
|
201
|
-
}
|
|
202
|
-
export interface NavigationMenuUpsertInput {
|
|
203
|
-
identifier?: string;
|
|
204
|
-
name: string;
|
|
205
|
-
isPrimary?: boolean;
|
|
206
|
-
isFooter?: boolean;
|
|
207
|
-
footerRole?: 'main' | 'legal-policy' | null;
|
|
208
|
-
items: NavigationItemInput[];
|
|
209
|
-
}
|
|
210
|
-
export interface NavigationItemInput {
|
|
211
|
-
label: string;
|
|
212
|
-
/** Link configuration. Required for non-dropdown items. */
|
|
213
|
-
link?: NavigationLinkInput;
|
|
214
|
-
/** Whether this item should render as a CTA-style navigation action. */
|
|
215
|
-
isCta?: boolean;
|
|
216
|
-
children?: NavigationItemInput[];
|
|
217
|
-
}
|
|
218
|
-
export interface ManagementSettings {
|
|
219
|
-
homepageId: string | null;
|
|
220
|
-
seoDefaults: {
|
|
221
|
-
title?: string;
|
|
222
|
-
description?: string;
|
|
223
|
-
ogImage?: string;
|
|
224
|
-
allowIndexingInProduction?: boolean;
|
|
225
|
-
} | null;
|
|
226
|
-
logoIdentifier?: string | null;
|
|
227
|
-
faviconIdentifier?: string | null;
|
|
228
|
-
}
|
|
229
|
-
export interface SettingsUpdateInput {
|
|
230
|
-
homepageId?: string | null;
|
|
231
|
-
seoDefaults?: {
|
|
232
|
-
title?: string;
|
|
233
|
-
description?: string;
|
|
234
|
-
ogImage?: string;
|
|
235
|
-
allowIndexingInProduction?: boolean;
|
|
236
|
-
} | null;
|
|
237
|
-
logoIdentifier?: string | null;
|
|
238
|
-
faviconIdentifier?: string | null;
|
|
239
|
-
}
|
|
240
|
-
export interface ManagementWebhookEndpoint {
|
|
241
|
-
id: string;
|
|
242
|
-
name: string;
|
|
243
|
-
url: string;
|
|
244
|
-
events: string[];
|
|
245
|
-
enabled: boolean;
|
|
246
|
-
hasSecret: boolean;
|
|
247
|
-
createdAt: string;
|
|
248
|
-
updatedAt: string;
|
|
249
|
-
siteId: string;
|
|
250
|
-
failureCount: number;
|
|
251
|
-
lastFailureAt: string | null;
|
|
252
|
-
lastSuccessAt: string | null;
|
|
253
|
-
lastTriggeredAt: string | null;
|
|
254
|
-
}
|
|
255
|
-
export interface SetupRevalidationWebhookInput {
|
|
256
|
-
url: string;
|
|
257
|
-
name?: string;
|
|
258
|
-
rotateSecret?: boolean;
|
|
259
|
-
dryRun?: boolean;
|
|
260
|
-
vercel?: boolean;
|
|
261
|
-
}
|
|
262
|
-
export interface RevalidationWebhookPlannedEndpoint {
|
|
263
|
-
name: string;
|
|
264
|
-
url: string;
|
|
265
|
-
events: string[];
|
|
266
|
-
enabled: boolean;
|
|
267
|
-
rotateSecret: boolean;
|
|
268
|
-
}
|
|
269
|
-
export type SetupRevalidationWebhookResult = {
|
|
270
|
-
dryRun: true;
|
|
271
|
-
action: 'would_create' | 'would_update' | 'would_rotate' | 'would_leave_unchanged';
|
|
272
|
-
endpoint: ManagementWebhookEndpoint | null;
|
|
273
|
-
plannedEndpoint: RevalidationWebhookPlannedEndpoint;
|
|
274
|
-
message: string;
|
|
275
|
-
checklist: string[];
|
|
276
|
-
} | {
|
|
277
|
-
dryRun: false;
|
|
278
|
-
action: 'created' | 'rotated';
|
|
279
|
-
endpoint: ManagementWebhookEndpoint;
|
|
280
|
-
plannedEndpoint: RevalidationWebhookPlannedEndpoint;
|
|
281
|
-
secret: string;
|
|
282
|
-
message: string;
|
|
283
|
-
checklist: string[];
|
|
284
|
-
} | {
|
|
285
|
-
dryRun: false;
|
|
286
|
-
action: 'updated' | 'unchanged';
|
|
287
|
-
endpoint: ManagementWebhookEndpoint;
|
|
288
|
-
plannedEndpoint: RevalidationWebhookPlannedEndpoint;
|
|
289
|
-
message: string;
|
|
290
|
-
checklist: string[];
|
|
291
|
-
};
|
|
292
|
-
/**
|
|
293
|
-
* Form field definition.
|
|
294
|
-
*/
|
|
295
|
-
export interface ManagementFormField {
|
|
296
|
-
id: string;
|
|
297
|
-
label: string;
|
|
298
|
-
type: string;
|
|
299
|
-
required?: boolean;
|
|
300
|
-
placeholder?: string;
|
|
301
|
-
helpText?: string;
|
|
302
|
-
layout?: {
|
|
303
|
-
width?: 'full' | 'half';
|
|
304
|
-
};
|
|
305
|
-
options?: Array<{
|
|
306
|
-
value: string;
|
|
307
|
-
label: string;
|
|
308
|
-
}>;
|
|
309
|
-
multiple?: boolean;
|
|
310
|
-
minLength?: number;
|
|
311
|
-
maxLength?: number;
|
|
312
|
-
pattern?: string;
|
|
313
|
-
min?: number;
|
|
314
|
-
max?: number;
|
|
315
|
-
}
|
|
316
|
-
/**
|
|
317
|
-
* Form schema structure containing field definitions.
|
|
318
|
-
*/
|
|
319
|
-
export interface ManagementFormSchema {
|
|
320
|
-
version?: string;
|
|
321
|
-
fields: ManagementFormField[];
|
|
322
|
-
}
|
|
323
|
-
/**
|
|
324
|
-
* Form settings - generic object to support all form types.
|
|
325
|
-
*/
|
|
326
|
-
export type ManagementFormSettings = Record<string, unknown>;
|
|
327
|
-
/**
|
|
328
|
-
* Form entity for SDK management operations.
|
|
329
|
-
*/
|
|
330
|
-
export interface ManagementForm {
|
|
331
|
-
id: string;
|
|
332
|
-
slug: string;
|
|
333
|
-
name: string;
|
|
334
|
-
schema: ManagementFormSchema;
|
|
335
|
-
settings: ManagementFormSettings;
|
|
336
|
-
createdAt: string;
|
|
337
|
-
updatedAt: string;
|
|
338
|
-
}
|
|
339
|
-
/**
|
|
340
|
-
* Input for creating or updating a form.
|
|
341
|
-
*/
|
|
342
|
-
export interface FormUpsertInput {
|
|
343
|
-
slug: string;
|
|
344
|
-
name: string;
|
|
345
|
-
schema: ManagementFormSchema;
|
|
346
|
-
settings?: ManagementFormSettings;
|
|
347
|
-
}
|
|
348
|
-
/**
|
|
349
|
-
* Venue address structure.
|
|
350
|
-
*/
|
|
351
|
-
export interface VenueAddress {
|
|
352
|
-
line1?: string;
|
|
353
|
-
line2?: string;
|
|
354
|
-
city?: string;
|
|
355
|
-
region?: string;
|
|
356
|
-
postcode?: string;
|
|
357
|
-
country?: string;
|
|
358
|
-
}
|
|
359
|
-
/**
|
|
360
|
-
* Venue location coordinates.
|
|
361
|
-
*/
|
|
362
|
-
export interface VenueLocation {
|
|
363
|
-
lat?: number;
|
|
364
|
-
lng?: number;
|
|
365
|
-
}
|
|
366
|
-
/**
|
|
367
|
-
* Venue entity for SDK management operations.
|
|
368
|
-
*/
|
|
369
|
-
export interface ManagementVenue {
|
|
370
|
-
id: string;
|
|
371
|
-
slug: string;
|
|
372
|
-
title: string;
|
|
373
|
-
description: string | null;
|
|
374
|
-
timezone: string | null;
|
|
375
|
-
capacity: number | null;
|
|
376
|
-
address: VenueAddress;
|
|
377
|
-
location: VenueLocation | null;
|
|
378
|
-
mapEmbed: string | null;
|
|
379
|
-
createdAt: string;
|
|
380
|
-
updatedAt: string;
|
|
381
|
-
}
|
|
382
|
-
/**
|
|
383
|
-
* Input for creating or updating a venue.
|
|
384
|
-
*/
|
|
385
|
-
export interface VenueUpsertInput {
|
|
386
|
-
slug: string;
|
|
387
|
-
title: string;
|
|
388
|
-
description?: string | null;
|
|
389
|
-
timezone?: string | null;
|
|
390
|
-
capacity?: number | null;
|
|
391
|
-
address?: VenueAddress;
|
|
392
|
-
location?: VenueLocation | null;
|
|
393
|
-
mapEmbed?: string | null;
|
|
394
|
-
}
|
|
395
|
-
/**
|
|
396
|
-
* Event category entity for SDK management operations.
|
|
397
|
-
*/
|
|
398
|
-
export interface ManagementEventCategory {
|
|
399
|
-
id: string;
|
|
400
|
-
identifier: string;
|
|
401
|
-
name: string;
|
|
402
|
-
description: string | null;
|
|
403
|
-
color: string | null;
|
|
404
|
-
sortOrder: number;
|
|
405
|
-
createdAt: string;
|
|
406
|
-
updatedAt: string;
|
|
407
|
-
}
|
|
408
|
-
/**
|
|
409
|
-
* Input for creating or updating an event category.
|
|
410
|
-
*/
|
|
411
|
-
export interface EventCategoryUpsertInput {
|
|
412
|
-
identifier: string;
|
|
413
|
-
name: string;
|
|
414
|
-
description?: string | null;
|
|
415
|
-
color?: string | null;
|
|
416
|
-
sortOrder?: number;
|
|
417
|
-
}
|
|
418
|
-
/**
|
|
419
|
-
* Schedule configuration for an event series.
|
|
420
|
-
*/
|
|
421
|
-
export interface EventSchedule {
|
|
422
|
-
recurrenceRule: string | null;
|
|
423
|
-
/** Date used for the first occurrence; required for one-off SDK-managed events. */
|
|
424
|
-
startDate?: string | null;
|
|
425
|
-
defaultStartTime: string;
|
|
426
|
-
durationMinutes: number;
|
|
427
|
-
}
|
|
428
|
-
export interface EventStartEndSchedule {
|
|
429
|
-
/** Start/end schedules are currently supported for one-off SDK-managed events only. */
|
|
430
|
-
recurrenceRule?: null;
|
|
431
|
-
/** ISO datetime. Local datetime strings are treated as event-local wall time by the API. */
|
|
432
|
-
startsAt: string;
|
|
433
|
-
/** ISO datetime. Must be after startsAt and no more than the shared event duration maximum. */
|
|
434
|
-
endsAt: string;
|
|
435
|
-
durationMinutes?: never;
|
|
436
|
-
}
|
|
437
|
-
export interface EventStartDurationSchedule {
|
|
438
|
-
/** Start/duration schedules are currently supported for one-off SDK-managed events only. */
|
|
439
|
-
recurrenceRule?: null;
|
|
440
|
-
/** ISO datetime. Local datetime strings are treated as event-local wall time by the API. */
|
|
441
|
-
startsAt: string;
|
|
442
|
-
/** Must be no more than the shared event duration maximum. */
|
|
443
|
-
durationMinutes: number;
|
|
444
|
-
endsAt?: never;
|
|
445
|
-
}
|
|
446
|
-
export type EventScheduleUpsertInput = EventSchedule | EventStartEndSchedule | EventStartDurationSchedule;
|
|
447
|
-
export type EventTicketTypeInput = SdkEventTicketTypeInput;
|
|
448
|
-
/**
|
|
449
|
-
* Pricing configuration for an event series.
|
|
450
|
-
*/
|
|
451
|
-
export type EventPricing = SdkEventPricing;
|
|
452
|
-
export type EventPricingInput = SdkEventPricingInput;
|
|
453
|
-
export type EventPaymentTerms = SdkEventPaymentTerms;
|
|
454
|
-
export type EventPaymentTermsInput = SdkEventPaymentTermsInput;
|
|
455
|
-
/**
|
|
456
|
-
* Event content data (embedded from content_entry).
|
|
457
|
-
*/
|
|
458
|
-
export interface EventContent {
|
|
459
|
-
summary?: string;
|
|
460
|
-
body?: string | RichTextDoc;
|
|
461
|
-
image?: Record<string, unknown> & {
|
|
462
|
-
identifier: string;
|
|
463
|
-
};
|
|
464
|
-
[key: string]: unknown;
|
|
465
|
-
}
|
|
466
|
-
export type ManagementEventSeries = SdkManagementEventSeries;
|
|
467
|
-
export type ManagementEventOccurrence = SdkManagementEventOccurrence;
|
|
468
|
-
export type EventOccurrenceScheduleInput = SdkEventOccurrenceScheduleInput;
|
|
469
|
-
export type AddEventOccurrenceInput = SdkAddEventOccurrenceRequest;
|
|
470
|
-
export type EventOccurrenceCapacityIntent = SdkEventOccurrenceCapacityIntent;
|
|
471
|
-
export type EventSeriesUpsertInput = SdkEventUpsertBody;
|
|
472
|
-
export interface ManagementMediaAsset {
|
|
473
|
-
id: string;
|
|
474
|
-
siteId: string;
|
|
475
|
-
identifier: string | null;
|
|
476
|
-
storageBucket: string;
|
|
477
|
-
storagePath: string;
|
|
478
|
-
filename: string;
|
|
479
|
-
mimeType: string;
|
|
480
|
-
width: number | null;
|
|
481
|
-
height: number | null;
|
|
482
|
-
bytes: number | null;
|
|
483
|
-
checksumSha256: string | null;
|
|
484
|
-
createdAt: string;
|
|
485
|
-
updatedAt: string;
|
|
486
|
-
}
|
|
487
|
-
export interface MediaResolveResponse {
|
|
488
|
-
assets: ManagementMediaAsset[];
|
|
489
|
-
missingIdentifiers: string[];
|
|
490
|
-
missingAssetIds: string[];
|
|
491
|
-
}
|
|
492
|
-
/**
|
|
493
|
-
* Explicitly separates an existing-theme update from first-theme provisioning.
|
|
494
|
-
* Initialization never accepts a separately authoritative Theme payload.
|
|
495
|
-
*/
|
|
496
|
-
export type ThemeUpsertInput = NonNullable<APIEndpoints['sdkUpsertTheme']['body']>;
|
|
497
|
-
/** Updates an existing theme selection with a caller-supplied theme. */
|
|
498
|
-
export type ThemeUpsertUpdateInput = Extract<ThemeUpsertInput, {
|
|
499
|
-
kind: 'update';
|
|
500
|
-
}>;
|
|
501
|
-
/** Creates the first theme by compiling this complete style-selection command. */
|
|
502
|
-
export type ThemeUpsertInitializeInput = Extract<ThemeUpsertInput, {
|
|
503
|
-
kind: 'initialize';
|
|
504
|
-
}>;
|
|
505
|
-
/**
|
|
506
|
-
* Response from theme upsert operation.
|
|
507
|
-
*/
|
|
508
|
-
export interface ThemeUpsertResult {
|
|
509
|
-
themeId: string;
|
|
510
|
-
selectionId: string;
|
|
511
|
-
savedAt: string;
|
|
512
|
-
}
|
|
513
|
-
export type SiteStyleSelectionApplyCommand = SiteCommandOf<'applySiteStyleSelection'>;
|
|
514
|
-
export type SiteStyleSelectionApplyCommandInput = SiteStyleSelectionApplyCommand['input'];
|
|
515
|
-
/**
|
|
516
|
-
* Public SDK delta contract. `siteStyleRef` is command orchestration identity;
|
|
517
|
-
* semantic style changes live only in the `changes` batch.
|
|
518
|
-
*/
|
|
519
|
-
export type ThemeStyleSelectionApplyInput = Omit<SiteStyleSelectionApplyCommandInput, 'changes'> & Readonly<{
|
|
520
|
-
siteStyleRef: string;
|
|
521
|
-
baseSelectionVersion: number;
|
|
522
|
-
selectionId?: string | null;
|
|
523
|
-
changes: readonly [
|
|
524
|
-
SiteStyleSelectionApplyCommandInput['changes'][number],
|
|
525
|
-
...SiteStyleSelectionApplyCommandInput['changes'][number][]
|
|
526
|
-
];
|
|
527
|
-
}>;
|
|
528
|
-
export interface ThemeStyleSelectionApplyResult {
|
|
529
|
-
success: boolean;
|
|
530
|
-
themeId: string;
|
|
531
|
-
selectionId: string;
|
|
532
|
-
selectionVersion: number;
|
|
533
|
-
selectionUpdatedAt: string | null;
|
|
534
|
-
savedAt: string;
|
|
535
|
-
theme: Theme;
|
|
536
|
-
siteStyleId: string;
|
|
537
|
-
buttonStyleSelection: ButtonStyleSelection;
|
|
538
|
-
headerLookId: string | null;
|
|
539
|
-
headerLayoutId: string | null;
|
|
540
|
-
headerStyleId: string | null;
|
|
541
|
-
footerLookId: string | null;
|
|
542
|
-
}
|
|
543
|
-
/**
|
|
544
|
-
* Footer content for SDK management operations.
|
|
545
|
-
* The footer sync boundary carries the complete composition and its optimistic
|
|
546
|
-
* concurrency revision.
|
|
547
|
-
*/
|
|
548
|
-
export type FooterContent = ManagementFooterContent;
|
|
549
|
-
/**
|
|
550
|
-
* Footer content as returned from CMS.
|
|
551
|
-
*/
|
|
552
|
-
export type ManagementFooterContent = SdkFooterContent;
|
|
553
|
-
/**
|
|
554
|
-
* Input for upserting footer content.
|
|
555
|
-
*/
|
|
556
|
-
export type FooterContentUpsertInput = NonNullable<APIEndpoints['sdkUpsertFooter']['body']>;
|
|
557
|
-
export interface PulledFooter {
|
|
558
|
-
footer: ManagementFooterContent | null;
|
|
559
|
-
meta: {
|
|
560
|
-
pulledAt: string;
|
|
561
|
-
updatedAt: string | null;
|
|
562
|
-
};
|
|
563
|
-
}
|
|
564
|
-
export interface PulledEntries {
|
|
565
|
-
contentType: string;
|
|
566
|
-
entries: Array<{
|
|
567
|
-
identifier: string;
|
|
568
|
-
data: Record<string, unknown>;
|
|
569
|
-
status: 'draft' | 'published';
|
|
570
|
-
hasUnpublishedChanges: boolean;
|
|
571
|
-
/** Slug for URL routing - only present for routable content types */
|
|
572
|
-
slug?: string;
|
|
573
|
-
/**
|
|
574
|
-
* Canonical entry title (route title for routable content types).
|
|
575
|
-
*/
|
|
576
|
-
title: string;
|
|
577
|
-
manualOrder?: number;
|
|
578
|
-
blocks?: EntrySlotBlocks;
|
|
579
|
-
}>;
|
|
580
|
-
meta: {
|
|
581
|
-
pulledAt: string;
|
|
582
|
-
manualOrder?: string[];
|
|
583
|
-
entries: Record<string, {
|
|
584
|
-
createdAt: string;
|
|
585
|
-
updatedAt: string;
|
|
586
|
-
publishedAt: string | null;
|
|
587
|
-
}>;
|
|
588
|
-
truncation?: SdkPullTruncationMeta;
|
|
589
|
-
};
|
|
590
|
-
pagination: {
|
|
591
|
-
page: number;
|
|
592
|
-
limit: number;
|
|
593
|
-
total: number;
|
|
594
|
-
hasMore: boolean;
|
|
595
|
-
};
|
|
596
|
-
}
|
|
597
|
-
export interface PulledPages {
|
|
598
|
-
pages: Array<{
|
|
599
|
-
id: string;
|
|
600
|
-
identifier: string;
|
|
601
|
-
title: string;
|
|
602
|
-
path: string;
|
|
603
|
-
status: 'draft' | 'published';
|
|
604
|
-
hasUnpublishedChanges: boolean;
|
|
605
|
-
updatedAt: string;
|
|
606
|
-
createdAt: string;
|
|
607
|
-
publishedAt: string | null;
|
|
608
|
-
blocks: Array<{
|
|
609
|
-
id: string;
|
|
610
|
-
identifier: string;
|
|
611
|
-
kind: string;
|
|
612
|
-
position: number;
|
|
613
|
-
data: Record<string, unknown>;
|
|
614
|
-
createdAt: string;
|
|
615
|
-
updatedAt: string;
|
|
616
|
-
}>;
|
|
617
|
-
}>;
|
|
618
|
-
meta: {
|
|
619
|
-
pulledAt: string;
|
|
620
|
-
};
|
|
621
|
-
}
|
|
622
|
-
export interface PulledNavigation {
|
|
623
|
-
menus: PulledNavigationMenu[];
|
|
624
|
-
meta: {
|
|
625
|
-
pulledAt: string;
|
|
626
|
-
};
|
|
627
|
-
}
|
|
628
|
-
/**
|
|
629
|
-
* Cross-type overview of everything with pending (unpublished) changes.
|
|
630
|
-
* Mirrors `SdkPullDraftsResponse` in `@riverbankcms/api`; kept structurally in
|
|
631
|
-
* sync by the API↔SDK typetest.
|
|
632
|
-
*/
|
|
633
|
-
export interface PulledDrafts {
|
|
634
|
-
pages: Array<{
|
|
635
|
-
identifier: string;
|
|
636
|
-
hasUnpublishedChanges: boolean;
|
|
637
|
-
status: 'draft' | 'published';
|
|
638
|
-
}>;
|
|
639
|
-
entries: Array<{
|
|
640
|
-
contentType: string;
|
|
641
|
-
identifier: string;
|
|
642
|
-
status: 'draft' | 'published';
|
|
643
|
-
}>;
|
|
644
|
-
summary: {
|
|
645
|
-
pageCount: number;
|
|
646
|
-
entryCount: number;
|
|
647
|
-
};
|
|
648
|
-
meta: {
|
|
649
|
-
pulledAt: string;
|
|
650
|
-
};
|
|
651
|
-
}
|
|
652
|
-
export interface PulledSettings {
|
|
653
|
-
settings: ManagementSettings;
|
|
654
|
-
warnings?: string[];
|
|
655
|
-
meta: {
|
|
656
|
-
pulledAt: string;
|
|
657
|
-
updatedAt: string | null;
|
|
658
|
-
};
|
|
659
|
-
}
|
|
660
|
-
export interface PulledForms {
|
|
661
|
-
forms: Array<{
|
|
662
|
-
slug: string;
|
|
663
|
-
name: string;
|
|
664
|
-
schema: ManagementFormSchema;
|
|
665
|
-
settings: ManagementFormSettings;
|
|
666
|
-
updatedAt: string;
|
|
667
|
-
createdAt: string;
|
|
668
|
-
}>;
|
|
669
|
-
meta: {
|
|
670
|
-
pulledAt: string;
|
|
671
|
-
};
|
|
672
|
-
}
|
|
673
|
-
export interface PulledTheme {
|
|
674
|
-
theme: Theme | null;
|
|
675
|
-
themeId: string | null;
|
|
676
|
-
selectionId: string | null;
|
|
677
|
-
meta: {
|
|
678
|
-
pulledAt: string;
|
|
679
|
-
updatedAt: string | null;
|
|
680
|
-
};
|
|
681
|
-
}
|
|
682
|
-
export interface PulledVenues {
|
|
683
|
-
venues: Array<{
|
|
684
|
-
slug: string;
|
|
685
|
-
title: string;
|
|
686
|
-
description: string | null;
|
|
687
|
-
timezone: string | null;
|
|
688
|
-
capacity: number | null;
|
|
689
|
-
address: VenueAddress;
|
|
690
|
-
location: VenueLocation | null;
|
|
691
|
-
mapEmbed: string | null;
|
|
692
|
-
updatedAt: string;
|
|
693
|
-
createdAt: string;
|
|
694
|
-
}>;
|
|
695
|
-
meta: {
|
|
696
|
-
pulledAt: string;
|
|
697
|
-
};
|
|
698
|
-
}
|
|
699
|
-
export interface PulledEventCategories {
|
|
700
|
-
eventCategories: Array<{
|
|
701
|
-
identifier: string;
|
|
702
|
-
name: string;
|
|
703
|
-
description: string | null;
|
|
704
|
-
color: string | null;
|
|
705
|
-
sortOrder: number;
|
|
706
|
-
updatedAt: string;
|
|
707
|
-
createdAt: string;
|
|
708
|
-
}>;
|
|
709
|
-
meta: {
|
|
710
|
-
pulledAt: string;
|
|
711
|
-
};
|
|
712
|
-
}
|
|
713
|
-
export interface PulledEvents {
|
|
714
|
-
events: SdkPullEventSeries[];
|
|
715
|
-
meta: {
|
|
716
|
-
pulledAt: string;
|
|
717
|
-
};
|
|
718
|
-
}
|
|
719
|
-
/**
|
|
720
|
-
* Site info returned by the siteInfo() method.
|
|
721
|
-
* Contains configuration data from the CMS server.
|
|
722
|
-
*/
|
|
723
|
-
export interface PulledSiteInfo {
|
|
724
|
-
/** Supabase URL for direct storage access */
|
|
725
|
-
supabaseUrl: string;
|
|
726
|
-
meta: {
|
|
727
|
-
fetchedAt: string;
|
|
728
|
-
};
|
|
729
|
-
}
|
|
730
|
-
/**
|
|
731
|
-
* Content type info returned by the pull.contentTypes() method.
|
|
732
|
-
*/
|
|
733
|
-
export interface PulledContentType {
|
|
734
|
-
key: string;
|
|
735
|
-
name: string;
|
|
736
|
-
hasPages: boolean;
|
|
737
|
-
routePattern: string | null;
|
|
738
|
-
isSingleton: boolean;
|
|
739
|
-
}
|
|
740
|
-
/**
|
|
741
|
-
* Response from pulling content types.
|
|
742
|
-
*/
|
|
743
|
-
export interface PulledContentTypes {
|
|
744
|
-
contentTypes: PulledContentType[];
|
|
745
|
-
meta: {
|
|
746
|
-
pulledAt: string;
|
|
747
|
-
};
|
|
748
|
-
}
|
|
749
|
-
export interface PulledContent {
|
|
750
|
-
entries: Record<string, PulledEntries['entries']>;
|
|
751
|
-
pages: PulledPages['pages'];
|
|
752
|
-
navigation: PulledNavigationMenu[];
|
|
753
|
-
settings: ManagementSettings;
|
|
754
|
-
settingsWarnings?: string[];
|
|
755
|
-
forms: PulledForms['forms'];
|
|
756
|
-
venues?: PulledVenues['venues'];
|
|
757
|
-
eventCategories?: PulledEventCategories['eventCategories'];
|
|
758
|
-
events?: PulledEvents['events'];
|
|
759
|
-
meta: {
|
|
760
|
-
pulledAt: string;
|
|
761
|
-
settingsUpdatedAt?: string | null;
|
|
762
|
-
/** Whether the response was truncated due to size limits and what was returned. */
|
|
763
|
-
truncation: SdkPullTruncationMeta;
|
|
764
|
-
entries?: Record<string, {
|
|
765
|
-
createdAt: string;
|
|
766
|
-
updatedAt: string;
|
|
767
|
-
publishedAt: string | null;
|
|
768
|
-
}>;
|
|
769
|
-
};
|
|
770
|
-
}
|
|
771
|
-
export interface PaginationOptions {
|
|
772
|
-
page?: number;
|
|
773
|
-
limit?: number;
|
|
774
|
-
}
|
|
775
|
-
export interface PaginatedResult<T> {
|
|
776
|
-
items: T[];
|
|
777
|
-
pagination: {
|
|
778
|
-
page: number;
|
|
779
|
-
limit: number;
|
|
780
|
-
total: number;
|
|
781
|
-
hasMore: boolean;
|
|
782
|
-
};
|
|
783
|
-
}
|
|
784
|
-
export interface ApiSuccessResponse<T> {
|
|
785
|
-
success: true;
|
|
786
|
-
data: T;
|
|
787
|
-
}
|
|
788
|
-
export interface ApiErrorResponse {
|
|
789
|
-
success: false;
|
|
790
|
-
error: {
|
|
791
|
-
code: string;
|
|
792
|
-
message: string;
|
|
793
|
-
details?: unknown;
|
|
794
|
-
fieldErrors?: Array<{
|
|
795
|
-
field: string;
|
|
796
|
-
code: string;
|
|
797
|
-
message: string;
|
|
798
|
-
}>;
|
|
799
|
-
/**
|
|
800
|
-
* Precise failure tag from the originating server `DomainServiceError`
|
|
801
|
-
* (e.g. `STALE_BASE`, `INVALID_STYLE_SELECTION`). Optional; the coarse `code`
|
|
802
|
-
* collapses several tags into one HTTP status.
|
|
803
|
-
*/
|
|
804
|
-
tag?: string;
|
|
805
|
-
};
|
|
806
|
-
}
|
|
807
|
-
export type ApiResponse<T> = ApiSuccessResponse<T> | ApiErrorResponse;
|
|
808
|
-
export interface EntryOperations {
|
|
809
|
-
list(contentType: string, options?: PaginationOptions): Promise<PaginatedResult<ManagementEntry>>;
|
|
810
|
-
get(contentType: string, identifier: string): Promise<ManagementEntry | null>;
|
|
811
|
-
/**
|
|
812
|
-
* Correlated overloads: a publish-intent upsert resolves to the entry plus
|
|
813
|
-
* the publication outcome (which may report a failed publish); a draft upsert
|
|
814
|
-
* resolves to the entry alone. Statically-unknown intent gets the honest
|
|
815
|
-
* union.
|
|
816
|
-
*/
|
|
817
|
-
upsert(input: EntryUpsertInput & {
|
|
818
|
-
publication: 'publish';
|
|
819
|
-
}): Promise<EntryPublishUpsertResult>;
|
|
820
|
-
upsert(input: EntryUpsertInput & {
|
|
821
|
-
publication?: 'draft';
|
|
822
|
-
}): Promise<UpsertedManagementEntry>;
|
|
823
|
-
upsert(input: EntryUpsertInput): Promise<UpsertedManagementEntry | EntryPublishUpsertResult>;
|
|
824
|
-
publish(contentType: string, identifier: string): Promise<void>;
|
|
825
|
-
unpublish(contentType: string, identifier: string): Promise<void>;
|
|
826
|
-
delete(contentType: string, identifier: string): Promise<void>;
|
|
827
|
-
}
|
|
828
|
-
export interface PageOperations {
|
|
829
|
-
list(options?: PaginationOptions): Promise<PaginatedResult<ManagementPage>>;
|
|
830
|
-
get(identifier: string): Promise<ManagementPage | null>;
|
|
831
|
-
/** Correlated overloads — see {@link EntryOperations.upsert}. */
|
|
832
|
-
upsert(input: PageUpsertInput & {
|
|
833
|
-
publication: 'publish';
|
|
834
|
-
}): Promise<PagePublishUpsertResult>;
|
|
835
|
-
upsert(input: PageUpsertInput & {
|
|
836
|
-
publication?: 'draft';
|
|
837
|
-
}): Promise<ManagementPage>;
|
|
838
|
-
upsert(input: PageUpsertInput): Promise<ManagementPage | PagePublishUpsertResult>;
|
|
839
|
-
publish(identifier: string): Promise<void>;
|
|
840
|
-
unpublish(identifier: string): Promise<void>;
|
|
841
|
-
delete(identifier: string): Promise<void>;
|
|
842
|
-
}
|
|
843
|
-
export type ManagementPageBlock = SdkGetPageBlockResponse['block'];
|
|
844
|
-
/**
|
|
845
|
-
* Input for `blocks.patch` — derived from the API contract.
|
|
846
|
-
* `baseContentHash` must be the `contentHash` from a prior `blocks.get`;
|
|
847
|
-
* a stale hash rejects with a 409 whose `fieldErrors[0].message` carries the
|
|
848
|
-
* current hash (field `baseContentHash`, code `STALE_CONTENT`).
|
|
849
|
-
*/
|
|
850
|
-
export type BlockPatchInput = SdkPatchPageBlockBody;
|
|
851
|
-
export interface BlockOperations {
|
|
852
|
-
list(pageIdentifier: string): Promise<ManagementBlock[]>;
|
|
853
|
-
get(pageIdentifier: string, blockIdentifier: string): Promise<ManagementPageBlock | null>;
|
|
854
|
-
upsert(pageIdentifier: string, input: BlockUpsertInput): Promise<ManagementBlock>;
|
|
855
|
-
patch(pageIdentifier: string, blockIdentifier: string, input: BlockPatchInput): Promise<ManagementPageBlock>;
|
|
856
|
-
reorder(pageIdentifier: string, blockIdentifiers: string[]): Promise<void>;
|
|
857
|
-
delete(pageIdentifier: string, blockIdentifier: string): Promise<void>;
|
|
858
|
-
}
|
|
859
|
-
export interface NavigationOperations {
|
|
860
|
-
list(): Promise<ManagementNavigationMenu[]>;
|
|
861
|
-
get(name: string): Promise<ManagementNavigationMenu | null>;
|
|
862
|
-
upsert(input: NavigationMenuUpsertInput): Promise<ManagementNavigationMenu>;
|
|
863
|
-
delete(menuId: string): Promise<void>;
|
|
864
|
-
}
|
|
865
|
-
export interface SettingsOperations {
|
|
866
|
-
get(): Promise<ManagementSettings>;
|
|
867
|
-
update(input: SettingsUpdateInput): Promise<ManagementSettings>;
|
|
868
|
-
}
|
|
869
|
-
export interface WebhookOperations {
|
|
870
|
-
setupRevalidation(input: SetupRevalidationWebhookInput): Promise<SetupRevalidationWebhookResult>;
|
|
871
|
-
}
|
|
872
|
-
export interface FormOperations {
|
|
873
|
-
list(): Promise<ManagementForm[]>;
|
|
874
|
-
get(slug: string): Promise<ManagementForm | null>;
|
|
875
|
-
upsert(input: FormUpsertInput): Promise<ManagementForm>;
|
|
876
|
-
delete(slug: string): Promise<void>;
|
|
877
|
-
}
|
|
878
|
-
export interface ThemeOperations {
|
|
879
|
-
upsert(input: ThemeUpsertInput): Promise<ThemeUpsertResult>;
|
|
880
|
-
applySelection(input: ThemeStyleSelectionApplyInput): Promise<ThemeStyleSelectionApplyResult>;
|
|
881
|
-
}
|
|
882
|
-
export interface FooterOperations {
|
|
883
|
-
/** Get footer content */
|
|
884
|
-
get(): Promise<ManagementFooterContent | null>;
|
|
885
|
-
/** Upsert footer content */
|
|
886
|
-
upsert(input: FooterContentUpsertInput): Promise<ManagementFooterContent | null>;
|
|
887
|
-
}
|
|
888
|
-
export interface VenueOperations {
|
|
889
|
-
list(): Promise<ManagementVenue[]>;
|
|
890
|
-
get(slug: string): Promise<ManagementVenue | null>;
|
|
891
|
-
upsert(input: VenueUpsertInput): Promise<ManagementVenue>;
|
|
892
|
-
delete(slug: string): Promise<void>;
|
|
893
|
-
}
|
|
894
|
-
export interface EventCategoryOperations {
|
|
895
|
-
list(): Promise<ManagementEventCategory[]>;
|
|
896
|
-
get(identifier: string): Promise<ManagementEventCategory | null>;
|
|
897
|
-
upsert(input: EventCategoryUpsertInput): Promise<ManagementEventCategory>;
|
|
898
|
-
delete(identifier: string): Promise<void>;
|
|
899
|
-
}
|
|
900
|
-
export interface EventOperations {
|
|
901
|
-
list(): Promise<ManagementEventSeries[]>;
|
|
902
|
-
get(identifier: string): Promise<ManagementEventSeries | null>;
|
|
903
|
-
upsert(input: EventSeriesUpsertInput): Promise<ManagementEventSeries>;
|
|
904
|
-
delete(identifier: string): Promise<void>;
|
|
905
|
-
occurrences: EventOccurrenceOperations;
|
|
906
|
-
}
|
|
907
|
-
export interface EventOccurrenceOperations {
|
|
908
|
-
list(identifier: string, options?: Readonly<{
|
|
909
|
-
all?: boolean;
|
|
910
|
-
status?: ManagementEventOccurrence['status'];
|
|
911
|
-
cursor?: string;
|
|
912
|
-
limit?: number;
|
|
913
|
-
}>): Promise<Readonly<{
|
|
914
|
-
occurrences: ManagementEventOccurrence[];
|
|
915
|
-
nextCursor: string | null;
|
|
916
|
-
}>>;
|
|
917
|
-
add(identifier: string, input: AddEventOccurrenceInput): Promise<ManagementEventOccurrence>;
|
|
918
|
-
update(identifier: string, occurrenceId: string, input: Readonly<{
|
|
919
|
-
schedule?: EventOccurrenceScheduleInput;
|
|
920
|
-
capacity?: EventOccurrenceCapacityIntent;
|
|
921
|
-
}>): Promise<ManagementEventOccurrence>;
|
|
922
|
-
cancel(identifier: string, occurrenceId: string): Promise<ManagementEventOccurrence>;
|
|
923
|
-
delete(identifier: string, occurrenceId: string): Promise<void>;
|
|
924
|
-
}
|
|
925
|
-
export interface PullOperations {
|
|
926
|
-
entries(contentType?: string, options?: PaginationOptions): Promise<PulledEntries>;
|
|
927
|
-
pages(): Promise<PulledPages>;
|
|
928
|
-
/**
|
|
929
|
-
* Cross-type overview of pages and entries with pending (unpublished) changes.
|
|
930
|
-
* Server-side filtered and fully enumerated.
|
|
931
|
-
*/
|
|
932
|
-
drafts(): Promise<PulledDrafts>;
|
|
933
|
-
navigation(): Promise<PulledNavigation>;
|
|
934
|
-
settings(): Promise<PulledSettings>;
|
|
935
|
-
forms(): Promise<PulledForms>;
|
|
936
|
-
theme(): Promise<PulledTheme>;
|
|
937
|
-
footer(): Promise<PulledFooter>;
|
|
938
|
-
venues(): Promise<PulledVenues>;
|
|
939
|
-
eventCategories(): Promise<PulledEventCategories>;
|
|
940
|
-
events(): Promise<PulledEvents>;
|
|
941
|
-
all(): Promise<PulledContent>;
|
|
942
|
-
/**
|
|
943
|
-
* Get site configuration info from the CMS server.
|
|
944
|
-
* Used to get values like Supabase URL for media sync without
|
|
945
|
-
* requiring additional env vars on SDK sites.
|
|
946
|
-
*/
|
|
947
|
-
siteInfo(): Promise<PulledSiteInfo>;
|
|
948
|
-
/**
|
|
949
|
-
* Get all content types for the site.
|
|
950
|
-
* Returns key, name, hasPages, routePattern, and isSingleton for each type.
|
|
951
|
-
*/
|
|
952
|
-
contentTypes(): Promise<PulledContentTypes>;
|
|
953
|
-
}
|
|
954
|
-
export type PulledCatalogTheme = SdkCatalogThemeResponse;
|
|
955
|
-
export type PulledCatalogBlocks = SdkCatalogBlocksResponse;
|
|
956
|
-
export type PulledCatalogContentTypes = SdkCatalogContentTypesResponse;
|
|
957
|
-
export type Capabilities = SdkCapabilitiesResponse;
|
|
958
|
-
/** Demo-seed provenance listing (plan 8.2). */
|
|
959
|
-
export type DemoContent = SdkDemoContentResponse;
|
|
960
|
-
export interface CatalogOperations {
|
|
961
|
-
/** Theme discovery catalog: styles, personalities, palettes, looks + current selection. */
|
|
962
|
-
theme(): Promise<PulledCatalogTheme>;
|
|
963
|
-
/** Block discovery catalog: manifest fields, content-source, theme-aware variant availability. */
|
|
964
|
-
blocks(): Promise<PulledCatalogBlocks>;
|
|
965
|
-
/** Content-type discovery catalog: normalized field DSL per content type. */
|
|
966
|
-
contentTypes(): Promise<PulledCatalogContentTypes>;
|
|
967
|
-
}
|
|
968
|
-
export interface BackfillPageResult {
|
|
969
|
-
pagesUpdated: number;
|
|
970
|
-
identifiersAssigned: Record<string, string>;
|
|
971
|
-
}
|
|
972
|
-
export interface BackfillBlockResult {
|
|
973
|
-
blocksUpdated: number;
|
|
974
|
-
identifiersAssigned: Record<string, string>;
|
|
975
|
-
}
|
|
976
|
-
export interface BackfillEntryResult {
|
|
977
|
-
entriesUpdated: number;
|
|
978
|
-
identifiersAssigned: Record<string, string>;
|
|
979
|
-
}
|
|
980
|
-
export interface BackfillResult {
|
|
981
|
-
pages: BackfillPageResult;
|
|
982
|
-
blocks: {
|
|
983
|
-
total: number;
|
|
984
|
-
byPage: Record<string, BackfillBlockResult>;
|
|
985
|
-
};
|
|
986
|
-
entries: BackfillEntryResult;
|
|
987
|
-
}
|
|
988
|
-
export interface IdentifiersOperations {
|
|
989
|
-
/**
|
|
990
|
-
* Backfill identifiers for pages, blocks, and entries that don't have one.
|
|
991
|
-
* This is useful for migrating content created before the SDK was available.
|
|
992
|
-
* The operation is idempotent - running it multiple times won't overwrite existing identifiers.
|
|
993
|
-
*/
|
|
994
|
-
backfill(): Promise<BackfillResult>;
|
|
995
|
-
}
|
|
996
|
-
export interface MediaUploadResult {
|
|
997
|
-
storagePath: string;
|
|
998
|
-
status: 'created' | 'exists';
|
|
999
|
-
assetId?: string;
|
|
1000
|
-
identifier?: string | null;
|
|
1001
|
-
}
|
|
1002
|
-
export interface MediaOperations {
|
|
1003
|
-
/**
|
|
1004
|
-
* Upload a media file to the target environment.
|
|
1005
|
-
* If the file already exists, returns success without re-uploading.
|
|
1006
|
-
*/
|
|
1007
|
-
upload(file: {
|
|
1008
|
-
data: Buffer;
|
|
1009
|
-
filename: string;
|
|
1010
|
-
contentType: string;
|
|
1011
|
-
storagePath?: string;
|
|
1012
|
-
title?: string;
|
|
1013
|
-
identifier?: string;
|
|
1014
|
-
}): Promise<MediaUploadResult>;
|
|
1015
|
-
/**
|
|
1016
|
-
* Check if a media file exists at the given storage path.
|
|
1017
|
-
*/
|
|
1018
|
-
exists(storagePath: string): Promise<boolean>;
|
|
1019
|
-
/**
|
|
1020
|
-
* Resolve media assets by identifiers or asset IDs.
|
|
1021
|
-
*/
|
|
1022
|
-
resolve(input: {
|
|
1023
|
-
identifiers?: string[];
|
|
1024
|
-
assetIds?: string[];
|
|
1025
|
-
}): Promise<MediaResolveResponse>;
|
|
1026
|
-
/**
|
|
1027
|
-
* Find media assets by checksum for dedupe.
|
|
1028
|
-
*/
|
|
1029
|
-
findByChecksum(checksums: string[]): Promise<ManagementMediaAsset[]>;
|
|
1030
|
-
/**
|
|
1031
|
-
* Assign or update a media identifier.
|
|
1032
|
-
*/
|
|
1033
|
-
assignIdentifier(input: {
|
|
1034
|
-
assetId: string;
|
|
1035
|
-
identifier: string | null;
|
|
1036
|
-
force?: boolean;
|
|
1037
|
-
}): Promise<ManagementMediaAsset>;
|
|
1038
|
-
}
|
|
1039
|
-
export interface ManagementClient {
|
|
1040
|
-
entries: EntryOperations;
|
|
1041
|
-
pages: PageOperations;
|
|
1042
|
-
blocks: BlockOperations;
|
|
1043
|
-
navigation: NavigationOperations;
|
|
1044
|
-
settings: SettingsOperations;
|
|
1045
|
-
webhooks: WebhookOperations;
|
|
1046
|
-
forms: FormOperations;
|
|
1047
|
-
theme: ThemeOperations;
|
|
1048
|
-
footer: FooterOperations;
|
|
1049
|
-
venues: VenueOperations;
|
|
1050
|
-
eventCategories: EventCategoryOperations;
|
|
1051
|
-
events: EventOperations;
|
|
1052
|
-
pull: PullOperations;
|
|
1053
|
-
/** Discovery catalogs (theme / blocks / content-types). */
|
|
1054
|
-
catalog: CatalogOperations;
|
|
1055
|
-
identifiers: IdentifiersOperations;
|
|
1056
|
-
media: MediaOperations;
|
|
1057
|
-
/**
|
|
1058
|
-
* Thin capabilities index: API version, catalog links, and per-catalog content
|
|
1059
|
-
* hashes so agents can cache catalogs and detect drift.
|
|
1060
|
-
*/
|
|
1061
|
-
capabilities(): Promise<Capabilities>;
|
|
1062
|
-
/**
|
|
1063
|
-
* Demo-seed provenance ledger: created and existing resource observations
|
|
1064
|
-
* from demo recipe runs (plan 8.2). Historical heuristic-era observations are
|
|
1065
|
-
* not cleanup-authoritative, and destructive cleanup remains disabled pending
|
|
1066
|
-
* an explicit trust cutoff or purge.
|
|
1067
|
-
*/
|
|
1068
|
-
demoContent(): Promise<DemoContent>;
|
|
1069
|
-
}
|