@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,10 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Sync Module
|
|
3
|
-
*
|
|
4
|
-
* Provides content synchronization between local files and CMS.
|
|
5
|
-
*/
|
|
6
|
-
export { calculateDiff, calculatePullDiff, hasPendingChanges, formatDiffSummary, formatDiffDetail, buildJsonDiff, type ContentDiff, type EntryDiff, type PageDiff, type BlockDiff, type NavigationDiff, type DiffType, type DiffOptions, type JsonDiff, type JsonDiffMode, type JsonDiffChange, type JsonDiffChangeType, type JsonDiffOperation, type PullJsonDiff, type PullJsonDiffChange, type FieldChange, findChangedFieldsWithValues, formatValue, formatHumanDiff, } from './diff';
|
|
7
|
-
export { buildFieldDiffs, buildFieldChanges, formatFieldPath, formatFieldChange, formatFieldDiffValue, type FieldDiff, type FieldDiffKind, type FieldDiffIdentity, type FieldDiffIdentityInput, type FieldPathSegment, type BuildFieldDiffOptions, } from './field-diff';
|
|
8
|
-
export { executeResidualSettingsSyncPlan, createEmptySyncResult, formatSyncResult, type SyncOptions, type SyncResult, type ResidualSettingsDiff, type ResidualSettingsLocalContent, } from './executor';
|
|
9
|
-
export { addCounters, mergeManySyncResults, mergeSyncResults, } from './syncResultAggregation';
|
|
10
|
-
export { extractMediaPaths, buildStorageUrl, downloadMedia, syncMedia, type MediaSyncResult, type MediaSyncSummary, type MediaSyncOptions, type MediaUploadClient, } from './media';
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Content Mapper Utilities
|
|
3
|
-
*
|
|
4
|
-
* Converts pulled remote content to local format for comparison.
|
|
5
|
-
* Strips metadata fields that don't exist in local files.
|
|
6
|
-
*/
|
|
7
|
-
import type { ManagementNavigationItem, ManagementNavigationMenu, ManagementFooterContent, PulledNavigationItem, PulledNavigationMenu, PulledPages, PulledEntries } from '../../client/management/types';
|
|
8
|
-
import type { LocalEntry, LocalPage, LocalNavigation, LocalNavigationItem, LocalFooterContent } from '../content/reader';
|
|
9
|
-
type NavigationItemForMapping = ManagementNavigationItem | PulledNavigationItem;
|
|
10
|
-
type NavigationMenuForMapping = ManagementNavigationMenu | PulledNavigationMenu;
|
|
11
|
-
/**
|
|
12
|
-
* Strip ID and position from remote navigation items for comparison.
|
|
13
|
-
* Local navigation files don't include these server-generated fields.
|
|
14
|
-
*
|
|
15
|
-
* Converts CMS internal links to SDK identifier-based format:
|
|
16
|
-
* - Internal page links → { kind: 'page', identifier }
|
|
17
|
-
* - Internal entry links → { kind: 'entry', contentType, identifier }
|
|
18
|
-
* - External links → { kind: 'external', href }
|
|
19
|
-
* - Fallback (no identifier) → { kind: 'url', href }
|
|
20
|
-
*/
|
|
21
|
-
export declare function stripNavigationItemIds(items: NavigationItemForMapping[]): LocalNavigationItem[];
|
|
22
|
-
/**
|
|
23
|
-
* Convert pulled navigation menus to local format for comparison.
|
|
24
|
-
* Strips internal IDs and timestamps, keeps only sync-relevant fields.
|
|
25
|
-
*/
|
|
26
|
-
export declare function convertPulledNavigationToLocal(remoteMenus: NavigationMenuForMapping[]): LocalNavigation;
|
|
27
|
-
/**
|
|
28
|
-
* Convert pulled pages to local format for comparison.
|
|
29
|
-
* Strips server-side metadata like timestamps.
|
|
30
|
-
*/
|
|
31
|
-
export declare function convertPulledPagesToLocal(remotePages: PulledPages['pages']): LocalPage[];
|
|
32
|
-
/**
|
|
33
|
-
* Convert pulled entries to local format for comparison.
|
|
34
|
-
* Strips server-side metadata like timestamps.
|
|
35
|
-
*/
|
|
36
|
-
export declare function convertPulledEntriesToLocal(remoteEntries: Record<string, PulledEntries['entries']>): Map<string, LocalEntry[]>;
|
|
37
|
-
/**
|
|
38
|
-
* Convert pulled footer content to local format for comparison/writing.
|
|
39
|
-
*/
|
|
40
|
-
export declare function convertPulledFooterToLocal(remoteFooter: ManagementFooterContent): LocalFooterContent;
|
|
41
|
-
export {};
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { ManagementClient } from '../../client/management';
|
|
2
|
-
import type { OutputContext } from '../output';
|
|
3
|
-
export declare function syncMediaByIdentifier(params: {
|
|
4
|
-
identifiers: Set<string>;
|
|
5
|
-
source: {
|
|
6
|
-
client: ManagementClient;
|
|
7
|
-
supabaseUrl: string;
|
|
8
|
-
siteId: string;
|
|
9
|
-
};
|
|
10
|
-
target: {
|
|
11
|
-
client: ManagementClient;
|
|
12
|
-
};
|
|
13
|
-
output: OutputContext;
|
|
14
|
-
overwrite?: boolean;
|
|
15
|
-
}): Promise<void>;
|
|
@@ -1,158 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Media Sync Helper
|
|
3
|
-
*
|
|
4
|
-
* Handles syncing media assets between environments during pull/push operations.
|
|
5
|
-
*
|
|
6
|
-
* With relative paths, storagePath values in content are like "originals/2024/12/abc.jpg"
|
|
7
|
-
* (without site prefix). The actual files are stored at "sites/{siteId}/originals/...".
|
|
8
|
-
*
|
|
9
|
-
* When syncing:
|
|
10
|
-
* 1. Extract all relative storagePath values from content
|
|
11
|
-
* 2. Download files from source: sites/{sourceSiteId}/{relativePath}
|
|
12
|
-
* 3. Upload files to target: sites/{targetSiteId}/{relativePath}
|
|
13
|
-
*
|
|
14
|
-
* No path rewriting in content data is needed since paths are relative!
|
|
15
|
-
*/
|
|
16
|
-
import { type StoragePathParseError } from '../../../../media-core/src/index';
|
|
17
|
-
/**
|
|
18
|
-
* Extract all unique storagePath values from content data.
|
|
19
|
-
* Recursively walks through objects and arrays to find all media references.
|
|
20
|
-
*/
|
|
21
|
-
export declare function extractMediaPaths(data: unknown): Set<string>;
|
|
22
|
-
/**
|
|
23
|
-
* Extract all unique media identifiers from content data.
|
|
24
|
-
* Recursively walks through objects and arrays to find media references.
|
|
25
|
-
*/
|
|
26
|
-
export declare function extractMediaIdentifiers(data: unknown): Set<string>;
|
|
27
|
-
/**
|
|
28
|
-
* Build a public URL for a storage path.
|
|
29
|
-
* @param supabaseUrl - The Supabase project URL
|
|
30
|
-
* @param storagePath - Relative or site-scoped path within the bucket
|
|
31
|
-
* @param siteId - The site ID context for relative paths
|
|
32
|
-
* @param bucket - Storage bucket name (default: "media")
|
|
33
|
-
*/
|
|
34
|
-
export type MediaStorageUrlBuildError = Readonly<{
|
|
35
|
-
tag: 'invalid_storage_path';
|
|
36
|
-
siteId: string;
|
|
37
|
-
storagePath: string;
|
|
38
|
-
cause: StoragePathParseError;
|
|
39
|
-
}>;
|
|
40
|
-
export type MediaStorageUrlBuildResult = Readonly<{
|
|
41
|
-
ok: true;
|
|
42
|
-
value: string;
|
|
43
|
-
}> | Readonly<{
|
|
44
|
-
ok: false;
|
|
45
|
-
error: MediaStorageUrlBuildError;
|
|
46
|
-
}>;
|
|
47
|
-
export declare function buildStorageUrl(supabaseUrl: string, storagePath: string, siteId: string, bucket?: string): MediaStorageUrlBuildResult;
|
|
48
|
-
/**
|
|
49
|
-
* Check if a file path is an image that can be transformed by Supabase.
|
|
50
|
-
* @param path - The file path or storage path
|
|
51
|
-
*/
|
|
52
|
-
export declare function isTransformableImage(path: string): boolean;
|
|
53
|
-
/**
|
|
54
|
-
* Build a URL using Supabase's image transform endpoint.
|
|
55
|
-
* Returns a resized version to avoid exceeding upload size limits.
|
|
56
|
-
*
|
|
57
|
-
* @param supabaseUrl - The Supabase project URL
|
|
58
|
-
* @param storagePath - Relative or site-scoped path within the bucket
|
|
59
|
-
* @param siteId - The site ID context for relative paths
|
|
60
|
-
* @param options - Transform options (width, quality)
|
|
61
|
-
*/
|
|
62
|
-
export declare function buildImageTransformUrl(supabaseUrl: string, storagePath: string, siteId: string, options?: {
|
|
63
|
-
width?: number;
|
|
64
|
-
quality?: number;
|
|
65
|
-
}): MediaStorageUrlBuildResult;
|
|
66
|
-
/**
|
|
67
|
-
* Download a file from a public Supabase storage URL.
|
|
68
|
-
* Returns the file data as a Buffer, or null if download fails after retries.
|
|
69
|
-
*
|
|
70
|
-
* Uses exponential backoff retry for transient network failures.
|
|
71
|
-
*/
|
|
72
|
-
export declare function downloadMedia(url: string, options?: {
|
|
73
|
-
maxRetries?: number;
|
|
74
|
-
}): Promise<{
|
|
75
|
-
data: Buffer;
|
|
76
|
-
contentType: string;
|
|
77
|
-
} | null>;
|
|
78
|
-
/**
|
|
79
|
-
* Result of syncing a single media file
|
|
80
|
-
*/
|
|
81
|
-
export interface MediaSyncResult {
|
|
82
|
-
/** Relative storage path */
|
|
83
|
-
relativePath: string;
|
|
84
|
-
/** Whether the sync was successful */
|
|
85
|
-
success: boolean;
|
|
86
|
-
/** Error message if sync failed */
|
|
87
|
-
error?: string;
|
|
88
|
-
/** Whether the file was skipped (already exists) */
|
|
89
|
-
skipped?: boolean;
|
|
90
|
-
}
|
|
91
|
-
/**
|
|
92
|
-
* Result of syncing all media
|
|
93
|
-
*/
|
|
94
|
-
export interface MediaSyncSummary {
|
|
95
|
-
/** Total number of unique media files found */
|
|
96
|
-
total: number;
|
|
97
|
-
/** Number successfully synced */
|
|
98
|
-
synced: number;
|
|
99
|
-
/** Number skipped (already exist) */
|
|
100
|
-
skipped: number;
|
|
101
|
-
/** Number that failed */
|
|
102
|
-
failed: number;
|
|
103
|
-
/** Individual results */
|
|
104
|
-
results: MediaSyncResult[];
|
|
105
|
-
}
|
|
106
|
-
/**
|
|
107
|
-
* Options for media sync
|
|
108
|
-
*/
|
|
109
|
-
export interface MediaSyncOptions {
|
|
110
|
-
/** Supabase URL of the source environment */
|
|
111
|
-
sourceSupabaseUrl: string;
|
|
112
|
-
/** Site ID of the source environment */
|
|
113
|
-
sourceSiteId: string;
|
|
114
|
-
/** Site ID of the target environment */
|
|
115
|
-
targetSiteId: string;
|
|
116
|
-
/** Storage bucket name */
|
|
117
|
-
bucket?: string;
|
|
118
|
-
/** Callback for progress updates */
|
|
119
|
-
onProgress?: (completed: number, total: number, current: string) => void;
|
|
120
|
-
}
|
|
121
|
-
/**
|
|
122
|
-
* Interface for media upload client (to be implemented by management client)
|
|
123
|
-
*/
|
|
124
|
-
export interface MediaUploadClient {
|
|
125
|
-
/**
|
|
126
|
-
* Upload a media file to the target environment.
|
|
127
|
-
* Returns the storage path if successful, or error if failed.
|
|
128
|
-
*/
|
|
129
|
-
uploadMedia(file: {
|
|
130
|
-
data: Buffer;
|
|
131
|
-
filename: string;
|
|
132
|
-
contentType: string;
|
|
133
|
-
storagePath: string;
|
|
134
|
-
}): Promise<{
|
|
135
|
-
storagePath: string;
|
|
136
|
-
} | {
|
|
137
|
-
error: string;
|
|
138
|
-
}>;
|
|
139
|
-
/**
|
|
140
|
-
* Check if a media file already exists at the given relative path.
|
|
141
|
-
*/
|
|
142
|
-
mediaExists(storagePath: string): Promise<boolean>;
|
|
143
|
-
}
|
|
144
|
-
/**
|
|
145
|
-
* Sync media files from source to target environment.
|
|
146
|
-
*
|
|
147
|
-
* With relative paths, content data doesn't need to be modified.
|
|
148
|
-
* We just copy files from source site folder to target site folder.
|
|
149
|
-
*
|
|
150
|
-
* @param content - The content data containing media references
|
|
151
|
-
* @param client - Client for uploading to target environment
|
|
152
|
-
* @param options - Sync options
|
|
153
|
-
* @returns Summary of sync results (content unchanged since paths are relative)
|
|
154
|
-
*/
|
|
155
|
-
export declare function syncMedia<T>(content: T, client: MediaUploadClient, options: MediaSyncOptions): Promise<{
|
|
156
|
-
summary: MediaSyncSummary;
|
|
157
|
-
content: T;
|
|
158
|
-
}>;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import { type SyncResult } from './executor';
|
|
2
|
-
export declare function mergeManySyncResults(results: readonly SyncResult[]): SyncResult;
|
|
3
|
-
export declare function mergeSyncResults(first: SyncResult, second: SyncResult): SyncResult;
|
|
4
|
-
export declare function addCounters<TCounters extends Record<string, number>>(first: TCounters, second: TCounters, keys: readonly (keyof TCounters)[]): TCounters;
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Block Content Validation
|
|
3
|
-
*
|
|
4
|
-
* Validates block data against block schemas to catch common errors:
|
|
5
|
-
* - Unknown fields that will be silently dropped
|
|
6
|
-
* - Missing required fields
|
|
7
|
-
* - Invalid field values (wrong types, malformed structures)
|
|
8
|
-
*/
|
|
9
|
-
import type { FieldDefinition } from '../../config/types';
|
|
10
|
-
type BlockManifest = Readonly<{
|
|
11
|
-
fields: readonly FieldDefinition[];
|
|
12
|
-
}> & Record<string, unknown>;
|
|
13
|
-
export interface ValidationWarning {
|
|
14
|
-
type: 'unknown_field' | 'missing_required' | 'invalid_content';
|
|
15
|
-
field: string;
|
|
16
|
-
message: string;
|
|
17
|
-
}
|
|
18
|
-
export interface BlockValidationResult {
|
|
19
|
-
valid: boolean;
|
|
20
|
-
warnings: ValidationWarning[];
|
|
21
|
-
errors: ValidationWarning[];
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* Extract all valid field IDs from a block manifest, including nested fields.
|
|
25
|
-
*
|
|
26
|
-
* Handles field types that contain nested fields:
|
|
27
|
-
* - group: has schema.fields
|
|
28
|
-
* - modal: has schema.fields
|
|
29
|
-
* - repeater: has schema.fields (monomorphic) or itemTypes (polymorphic)
|
|
30
|
-
* - tabGroup: has tabs[].fields
|
|
31
|
-
*/
|
|
32
|
-
export declare function extractFieldIds(fields: readonly FieldDefinition[]): Set<string>;
|
|
33
|
-
/**
|
|
34
|
-
* Extract required field IDs from a block manifest.
|
|
35
|
-
*
|
|
36
|
-
* Note: Only checks top-level required fields. Nested required fields
|
|
37
|
-
* within groups/repeaters are not validated at this level since their
|
|
38
|
-
* presence depends on parent field structure.
|
|
39
|
-
*/
|
|
40
|
-
export declare function extractRequiredFieldIds(fields: readonly FieldDefinition[]): Set<string>;
|
|
41
|
-
/**
|
|
42
|
-
* Validate block content values against the shared manifest push policy.
|
|
43
|
-
*
|
|
44
|
-
* This catches type mismatches, malformed structures, and invalid values
|
|
45
|
-
* that would be rejected by SDK block writes.
|
|
46
|
-
*
|
|
47
|
-
* @param data - The block data to validate
|
|
48
|
-
* @param manifest - The block manifest with field definitions
|
|
49
|
-
* @param customFields - Optional custom fields from config (blockFieldExtensions)
|
|
50
|
-
* @returns Array of validation warnings for invalid content
|
|
51
|
-
*/
|
|
52
|
-
export declare function validateBlockContent(data: Record<string, unknown>, manifest: BlockManifest, customFields?: readonly FieldDefinition[]): ValidationWarning[];
|
|
53
|
-
/**
|
|
54
|
-
* Validate block data against its manifest schema.
|
|
55
|
-
*
|
|
56
|
-
* Returns warnings for unknown fields (fields in data not in schema)
|
|
57
|
-
* and errors for missing required fields.
|
|
58
|
-
*
|
|
59
|
-
* @param data - The block data to validate
|
|
60
|
-
* @param manifest - The block manifest with field definitions
|
|
61
|
-
* @param customFields - Optional custom fields from config (blockFieldExtensions)
|
|
62
|
-
*/
|
|
63
|
-
export declare function validateBlockData(data: Record<string, unknown>, manifest: BlockManifest, customFields?: readonly FieldDefinition[]): BlockValidationResult;
|
|
64
|
-
/**
|
|
65
|
-
* Format validation result for display.
|
|
66
|
-
*/
|
|
67
|
-
export declare function formatValidationResult(pageIdentifier: string, blockIdentifier: string, blockKind: string, result: BlockValidationResult): string[];
|
|
68
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare function sha256(buffer: Buffer): string;
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Block Operations for Management Client
|
|
3
|
-
*/
|
|
4
|
-
import { ManagementApiError, type HttpClient } from './http';
|
|
5
|
-
import type { BlockOperations } from './types';
|
|
6
|
-
/**
|
|
7
|
-
* Discriminated stale-conflict error for `blocks.patch`: the block's draft
|
|
8
|
-
* changed since the caller's read. `currentHash` is the server's current
|
|
9
|
-
* draft content hash — retry the patch with it as `baseContentHash`.
|
|
10
|
-
* Extracted from the typed `SdkPatchPageBlockStaleContentFieldError` wire
|
|
11
|
-
* contract, so callers never parse prose.
|
|
12
|
-
*/
|
|
13
|
-
export declare class BlockPatchStaleContentError extends ManagementApiError {
|
|
14
|
-
readonly kind = "stale-content";
|
|
15
|
-
readonly currentHash: string;
|
|
16
|
-
constructor(source: ManagementApiError, currentHash: string);
|
|
17
|
-
}
|
|
18
|
-
export declare function isBlockPatchStaleContentError(error: unknown): error is BlockPatchStaleContentError;
|
|
19
|
-
export declare function createBlockOperations(http: HttpClient): BlockOperations;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Catalog (discovery surface) operations for the Management Client.
|
|
3
|
-
*
|
|
4
|
-
* Read-only catalogs an agent enumerates to act without reading repo source.
|
|
5
|
-
*/
|
|
6
|
-
import type { HttpClient } from './http';
|
|
7
|
-
import type { Capabilities, CatalogOperations, DemoContent } from './types';
|
|
8
|
-
export declare function createCatalogOperations(http: HttpClient): CatalogOperations;
|
|
9
|
-
export declare function createCapabilitiesOperation(http: HttpClient): () => Promise<Capabilities>;
|
|
10
|
-
export declare function createDemoContentOperation(http: HttpClient): () => Promise<DemoContent>;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Event Operations for Management Client
|
|
3
|
-
*/
|
|
4
|
-
import { type HttpClient } from './http';
|
|
5
|
-
import type { EventOperations, EventOccurrenceOperations } from './types';
|
|
6
|
-
export declare function createEventOccurrenceOperations(http: HttpClient): EventOccurrenceOperations;
|
|
7
|
-
export declare function createEventOperations(http: HttpClient): EventOperations;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Footer Operations for Management Client
|
|
3
|
-
*
|
|
4
|
-
* Provides operations for managing footer content (bottomText only).
|
|
5
|
-
* Footer content is stored in site_settings and synced via content/footer.json.
|
|
6
|
-
*/
|
|
7
|
-
import type { HttpClient } from './http';
|
|
8
|
-
import type { FooterOperations } from './types';
|
|
9
|
-
export declare function createFooterOperations(http: HttpClient): FooterOperations;
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* HTTP Client for Management Operations
|
|
3
|
-
*
|
|
4
|
-
* Provides typed HTTP client for SDK management endpoints.
|
|
5
|
-
*/
|
|
6
|
-
import type { ManagementClientConfig, ApiResponse } from './types';
|
|
7
|
-
export interface ManagementApiErrorRequest {
|
|
8
|
-
method: 'GET' | 'POST' | 'PATCH' | 'DELETE';
|
|
9
|
-
/** Request path relative to the management API base URL (e.g. "/entries/post") */
|
|
10
|
-
path: string;
|
|
11
|
-
/** Full URL requested */
|
|
12
|
-
url: string;
|
|
13
|
-
/** Base URL for management API requests (e.g. "https://dashboard/.../api/sdk/<siteId>") */
|
|
14
|
-
baseUrl: string;
|
|
15
|
-
/** Dashboard origin (e.g. "https://dashboard.riverbankcms.com") */
|
|
16
|
-
dashboardUrl: string;
|
|
17
|
-
/** Site ID used for the request */
|
|
18
|
-
siteId: string;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Error thrown when management API request fails
|
|
22
|
-
*/
|
|
23
|
-
export declare class ManagementApiError extends Error {
|
|
24
|
-
readonly code: string;
|
|
25
|
-
readonly details?: unknown;
|
|
26
|
-
readonly statusCode?: number;
|
|
27
|
-
readonly request?: ManagementApiErrorRequest;
|
|
28
|
-
/**
|
|
29
|
-
* Precise failure tag from the server's `DomainServiceError` (e.g. `STALE_BASE`,
|
|
30
|
-
* `INVALID_STYLE_SELECTION`). Branch on this when the coarse `code`/`statusCode`
|
|
31
|
-
* collapses several failures into one.
|
|
32
|
-
*/
|
|
33
|
-
readonly tag?: string;
|
|
34
|
-
constructor(message: string, code: string, details?: unknown, statusCode?: number, request?: ManagementApiErrorRequest, tag?: string);
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* Type guard to check if an error is a 404 Not Found response.
|
|
38
|
-
* Use this to handle "resource not found" scenarios gracefully.
|
|
39
|
-
*
|
|
40
|
-
* @example
|
|
41
|
-
* ```ts
|
|
42
|
-
* try {
|
|
43
|
-
* return await http.get<Entry>(`/entries/${type}/${id}`);
|
|
44
|
-
* } catch (error) {
|
|
45
|
-
* if (is404Error(error)) {
|
|
46
|
-
* return null;
|
|
47
|
-
* }
|
|
48
|
-
* throw error;
|
|
49
|
-
* }
|
|
50
|
-
* ```
|
|
51
|
-
*/
|
|
52
|
-
export declare function is404Error(error: unknown): error is ManagementApiError;
|
|
53
|
-
/**
|
|
54
|
-
* HTTP client interface for management operations
|
|
55
|
-
*/
|
|
56
|
-
export interface HttpClient {
|
|
57
|
-
get<T>(path: string, params?: Record<string, string>): Promise<T>;
|
|
58
|
-
post<T>(path: string, body?: unknown): Promise<T>;
|
|
59
|
-
patch<T>(path: string, body?: unknown): Promise<T>;
|
|
60
|
-
delete(path: string, body?: unknown): Promise<void>;
|
|
61
|
-
}
|
|
62
|
-
export declare function buildRequestInfo(options: {
|
|
63
|
-
method: ManagementApiErrorRequest['method'];
|
|
64
|
-
path: string;
|
|
65
|
-
url: string;
|
|
66
|
-
baseUrl: string;
|
|
67
|
-
dashboardUrl: string;
|
|
68
|
-
siteId: string;
|
|
69
|
-
}): ManagementApiErrorRequest;
|
|
70
|
-
export declare function readApiResponse<T>(response: Response, requestInfo: ManagementApiErrorRequest, options?: {
|
|
71
|
-
allowNonJsonOk?: false;
|
|
72
|
-
}): Promise<ApiResponse<T>>;
|
|
73
|
-
export declare function readApiResponse<T>(response: Response, requestInfo: ManagementApiErrorRequest, options: {
|
|
74
|
-
allowNonJsonOk: true;
|
|
75
|
-
}): Promise<ApiResponse<T> | undefined>;
|
|
76
|
-
/**
|
|
77
|
-
* Create HTTP client for management API
|
|
78
|
-
*/
|
|
79
|
-
export declare function createHttpClient(config: ManagementClientConfig): HttpClient;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Identifiers Operations
|
|
3
|
-
*
|
|
4
|
-
* Operations for managing SDK identifiers on pages, blocks, and entries.
|
|
5
|
-
*/
|
|
6
|
-
import type { HttpClient } from './http';
|
|
7
|
-
import type { IdentifiersOperations } from './types';
|
|
8
|
-
/**
|
|
9
|
-
* Create identifiers operations
|
|
10
|
-
*/
|
|
11
|
-
export declare function createIdentifiersOperations(http: HttpClient): IdentifiersOperations;
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Management Client Factory
|
|
3
|
-
*
|
|
4
|
-
* Creates a typed SDK client for management operations (pull/push content).
|
|
5
|
-
*
|
|
6
|
-
* @example
|
|
7
|
-
* ```typescript
|
|
8
|
-
* import { createManagementClient } from '@riverbankcms/sdk/client/management';
|
|
9
|
-
*
|
|
10
|
-
* const client = createManagementClient({
|
|
11
|
-
* dashboardUrl: 'http://localhost:4000',
|
|
12
|
-
* managementApiKey: 'bld_mgmt_sk_...',
|
|
13
|
-
* siteId: 'your-site-id',
|
|
14
|
-
* });
|
|
15
|
-
*
|
|
16
|
-
* // Pull content
|
|
17
|
-
* const entries = await client.pull.entries('blog-post');
|
|
18
|
-
*
|
|
19
|
-
* // Upsert entry
|
|
20
|
-
* await client.entries.upsert({
|
|
21
|
-
* identifier: 'my-post',
|
|
22
|
-
* contentType: 'blog-post',
|
|
23
|
-
* data: { title: 'Hello World' },
|
|
24
|
-
* });
|
|
25
|
-
*
|
|
26
|
-
* // Publish entry
|
|
27
|
-
* await client.entries.publish('blog-post', 'my-post');
|
|
28
|
-
* ```
|
|
29
|
-
*/
|
|
30
|
-
import type { ManagementClient, ManagementClientConfig } from './types';
|
|
31
|
-
/**
|
|
32
|
-
* Create a management client for SDK operations
|
|
33
|
-
*
|
|
34
|
-
* @param config - Client configuration
|
|
35
|
-
* @returns ManagementClient instance
|
|
36
|
-
*/
|
|
37
|
-
export declare function createManagementClient(config: ManagementClientConfig): ManagementClient;
|
|
38
|
-
export type { ManagementClient, ManagementClientConfig, ManagementEntry, ManagementPage, ManagementBlock, ManagementNavigationMenu, ManagementNavigationItem, ManagementSettings, ManagementForm, ManagementFormField, ManagementFormSchema, ManagementFormSettings, ManagementVenue, VenueAddress, VenueLocation, VenueUpsertInput, ManagementEventCategory, EventCategoryUpsertInput, ManagementEventSeries, ManagementEventOccurrence, EventOccurrenceScheduleInput, AddEventOccurrenceInput, EventOccurrenceCapacityIntent, EventSchedule, EventScheduleUpsertInput, EventStartDurationSchedule, EventStartEndSchedule, EventPricing, EventPaymentTerms, EventPaymentTermsInput, EventContent, EventSeriesUpsertInput, EntryUpsertInput, EntryPublishUpsertResult, UpsertedManagementEntry, PageUpsertInput, PagePublishUpsertResult, BlockUpsertInput, NavigationMenuUpsertInput, NavigationItemInput, FormUpsertInput, SiteStyleSelectionApplyCommand, SiteStyleSelectionApplyCommandInput, ThemeUpsertInitializeInput, ThemeUpsertInput, ThemeUpsertResult, ThemeUpsertUpdateInput, ThemeStyleSelectionApplyInput, ThemeStyleSelectionApplyResult, FooterContent, ManagementFooterContent, FooterContentUpsertInput, FooterOperations, PulledFooter, PulledEntries, PulledPages, PulledDrafts, PulledNavigation, PulledSettings, PulledForms, PulledTheme, PulledVenues, PulledEventCategories, PulledEvents, PulledSiteInfo, PulledContentType, PulledContentTypes, PulledContent, PaginationOptions, PaginatedResult, EntryOperations, PageOperations, BlockOperations, NavigationOperations, SettingsOperations, SettingsUpdateInput, WebhookOperations, SetupRevalidationWebhookInput, SetupRevalidationWebhookResult, ManagementWebhookEndpoint, RevalidationWebhookPlannedEndpoint, FormOperations, ThemeOperations, VenueOperations, EventCategoryOperations, EventOperations, EventOccurrenceOperations, PullOperations, CatalogOperations, PulledCatalogTheme, PulledCatalogBlocks, PulledCatalogContentTypes, Capabilities, DemoContent, IdentifiersOperations, BackfillResult, BackfillPageResult, BackfillBlockResult, BackfillEntryResult, MediaOperations, MediaUploadResult, } from './types';
|
|
39
|
-
export { ManagementApiError, type ManagementApiErrorRequest } from './http';
|
|
40
|
-
export { BlockPatchStaleContentError, isBlockPatchStaleContentError, } from './blocks';
|
|
41
|
-
export { applySiteStyleSelectionBodyFromCommand, buildApplySiteStyleSelectionCommand, } from './theme';
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Media Operations for SDK Management Client
|
|
3
|
-
*
|
|
4
|
-
* Provides methods for syncing media files between environments.
|
|
5
|
-
*/
|
|
6
|
-
import type { ManagementClientConfig, ManagementMediaAsset, MediaResolveResponse } from './types';
|
|
7
|
-
/**
|
|
8
|
-
* Result of a media upload
|
|
9
|
-
*/
|
|
10
|
-
export interface MediaUploadResult {
|
|
11
|
-
storagePath: string;
|
|
12
|
-
status: 'created' | 'exists';
|
|
13
|
-
assetId?: string;
|
|
14
|
-
identifier?: string | null;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* Result of a media exists check
|
|
18
|
-
*/
|
|
19
|
-
export interface MediaExistsResult {
|
|
20
|
-
exists: boolean;
|
|
21
|
-
}
|
|
22
|
-
/**
|
|
23
|
-
* Media operations interface
|
|
24
|
-
*/
|
|
25
|
-
export interface MediaOperations {
|
|
26
|
-
/**
|
|
27
|
-
* Upload a media file to the target environment.
|
|
28
|
-
* If the file already exists, returns success without re-uploading.
|
|
29
|
-
*
|
|
30
|
-
* @param file - File data and metadata
|
|
31
|
-
* @returns Upload result with storage path
|
|
32
|
-
*/
|
|
33
|
-
upload(file: {
|
|
34
|
-
data: Buffer;
|
|
35
|
-
filename: string;
|
|
36
|
-
contentType: string;
|
|
37
|
-
storagePath?: string;
|
|
38
|
-
title?: string;
|
|
39
|
-
identifier?: string;
|
|
40
|
-
}): Promise<MediaUploadResult>;
|
|
41
|
-
/**
|
|
42
|
-
* Check if a media file exists at the given storage path.
|
|
43
|
-
*
|
|
44
|
-
* @param storagePath - The storage path to check
|
|
45
|
-
* @returns Whether the file exists
|
|
46
|
-
*/
|
|
47
|
-
exists(storagePath: string): Promise<boolean>;
|
|
48
|
-
/**
|
|
49
|
-
* Resolve media assets by identifiers or asset IDs.
|
|
50
|
-
*/
|
|
51
|
-
resolve(input: {
|
|
52
|
-
identifiers?: string[];
|
|
53
|
-
assetIds?: string[];
|
|
54
|
-
}): Promise<MediaResolveResponse>;
|
|
55
|
-
/**
|
|
56
|
-
* Find media assets by checksum for dedupe.
|
|
57
|
-
*/
|
|
58
|
-
findByChecksum(checksums: string[]): Promise<ManagementMediaAsset[]>;
|
|
59
|
-
/**
|
|
60
|
-
* Assign or update a media identifier.
|
|
61
|
-
*/
|
|
62
|
-
assignIdentifier(input: {
|
|
63
|
-
assetId: string;
|
|
64
|
-
identifier: string | null;
|
|
65
|
-
force?: boolean;
|
|
66
|
-
}): Promise<ManagementMediaAsset>;
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* Create media operations for the management client.
|
|
70
|
-
* Uses direct-to-storage signed upload URLs for file uploads.
|
|
71
|
-
*/
|
|
72
|
-
export declare function createMediaOperations(config: ManagementClientConfig): MediaOperations;
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
import type { ManagementSettings, SettingsUpdateInput } from './types';
|
|
2
|
-
export declare const SETTINGS_BASE_FIELDS: readonly ["homepageId", "seoDefaults"];
|
|
3
|
-
export declare const SETTINGS_BRANDING_FIELDS: readonly ["logoIdentifier", "faviconIdentifier"];
|
|
4
|
-
export declare const SETTINGS_FIELDS: readonly ["homepageId", "seoDefaults", "logoIdentifier", "faviconIdentifier"];
|
|
5
|
-
export type SettingsBaseField = (typeof SETTINGS_BASE_FIELDS)[number];
|
|
6
|
-
export type SettingsBrandingField = (typeof SETTINGS_BRANDING_FIELDS)[number];
|
|
7
|
-
export type SettingsField = (typeof SETTINGS_FIELDS)[number];
|
|
8
|
-
export type SettingsBrandingIdentifierCarrier = Partial<Record<SettingsBrandingField, string | null | undefined>>;
|
|
9
|
-
export type SettingsBrandingPullResolution = Readonly<{
|
|
10
|
-
field: SettingsBrandingField;
|
|
11
|
-
kind: 'resolved';
|
|
12
|
-
identifier: string;
|
|
13
|
-
}> | Readonly<{
|
|
14
|
-
field: SettingsBrandingField;
|
|
15
|
-
kind: 'missing';
|
|
16
|
-
}> | Readonly<{
|
|
17
|
-
field: SettingsBrandingField;
|
|
18
|
-
kind: 'unresolved';
|
|
19
|
-
assetId: string;
|
|
20
|
-
}>;
|
|
21
|
-
export declare function hasOwnSettingsField(settings: object, field: SettingsField): boolean;
|
|
22
|
-
export declare function buildSettingsUpdateInput(settings: Partial<ManagementSettings>): SettingsUpdateInput;
|
|
23
|
-
export declare function applySettingsBrandingPullResolutions(baseSettings: Pick<ManagementSettings, 'homepageId' | 'seoDefaults'>, resolutions: SettingsBrandingPullResolution[]): {
|
|
24
|
-
settings: ManagementSettings;
|
|
25
|
-
warnings: string[];
|
|
26
|
-
};
|
|
27
|
-
export declare function getSettingsBrandingLabel(field: SettingsBrandingField): string;
|
|
28
|
-
export declare function collectSettingsBrandingIdentifiers(settings: SettingsBrandingIdentifierCarrier | null | undefined): Array<{
|
|
29
|
-
field: SettingsBrandingField;
|
|
30
|
-
identifier: string;
|
|
31
|
-
}>;
|
|
32
|
-
export declare function isImageMimeType(mimeType: string | null | undefined): boolean;
|