@riverbankcms/sdk 0.96.0 → 0.98.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -1
- package/dist/{PreviewEditorSidebar-46VT4QVU.mjs → PreviewEditorSidebar-CG3SSJND.mjs} +3 -3
- package/dist/{PreviewEditorUI-JD75GE5F.mjs → PreviewEditorUI-RHNGKAAU.mjs} +3 -3
- package/dist/SdkPreviewModeRuntime-OV5PNJBB.mjs +8 -0
- package/dist/_dts/api/src/bookingManagementEndpoints.d.ts +35 -1
- package/dist/_dts/api/src/bookingOperations.d.ts +246 -0
- package/dist/_dts/api/src/contentRuntime.d.ts +109 -40
- package/dist/_dts/api/src/endpoints.d.ts +80 -0
- package/dist/_dts/api/src/index.d.ts +3 -2
- package/dist/_dts/api/src/public/endpoints.d.ts +1 -1
- package/dist/_dts/api/src/publicExperienceEndpoints.d.ts +10 -0
- package/dist/_dts/api/src/sdkContracts.d.ts +2 -0
- package/dist/_dts/api/src/siteManagementEndpoints.d.ts +2 -1
- package/dist/_dts/api/src/siteRuntimeEndpoints.d.ts +7 -1
- package/dist/_dts/blocks/src/PageRenderer.d.ts +2 -1
- package/dist/_dts/blocks/src/bindings/types.d.ts +0 -4
- package/dist/_dts/blocks/src/client/site-chrome.d.ts +7 -0
- package/dist/_dts/blocks/src/contracts/index.d.ts +1 -0
- package/dist/_dts/blocks/src/contracts/proof-block-islands.d.ts +12 -12
- package/dist/_dts/blocks/src/primitives/content/primitives.d.ts +4 -0
- package/dist/_dts/blocks/src/system/blocks/events/shared/index.d.ts +1 -0
- package/dist/_dts/blocks/src/system/blocks/events/shared/layout.d.ts +2 -0
- package/dist/_dts/blocks/src/system/blocks/index.d.ts +1 -0
- package/dist/_dts/blocks/src/system/blocks/weekly-slot-availability.d.ts +34 -0
- package/dist/_dts/blocks/src/system/componentFactory.d.ts +1 -0
- package/dist/_dts/blocks/src/system/constants/blockKinds.d.ts +1 -1
- package/dist/_dts/blocks/src/system/customize/facets.d.ts +2 -2
- package/dist/_dts/blocks/src/system/data/loaderEndpoints.d.ts +1 -1
- package/dist/_dts/blocks/src/system/data/prefetchBlockData.d.ts +4 -1
- package/dist/_dts/blocks/src/system/node/builder.d.ts +2 -0
- package/dist/_dts/blocks/src/system/node/schema.d.ts +13 -0
- package/dist/_dts/blocks/src/system/node/validation-constants.d.ts +1 -1
- package/dist/_dts/blocks/src/system/registry.d.ts +1 -0
- package/dist/_dts/blocks/src/system/runtime/api/client.d.ts +2 -1
- package/dist/_dts/blocks/src/system/runtime/api/endpoints.d.ts +8 -0
- package/dist/_dts/blocks/src/system/runtime/api/types.d.ts +24 -0
- package/dist/_dts/blocks/src/system/runtime/components/registry.client.d.ts +6 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/useAppointmentCheckoutVerification.d.ts +7 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/useAvailableSlots.d.ts +2 -2
- package/dist/_dts/blocks/src/system/runtime/hooks/useHeadlessEventRegistrationFlow.d.ts +4 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/usePaymentVerification.d.ts +5 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/hooks.d.ts +14 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/useEventRegistrationSubmit.d.ts +8 -2
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/useEventRegistrationWizard.d.ts +133 -2
- package/dist/_dts/blocks/src/system/runtime/nodes/weekly-slot-availability.client.controller.d.ts +3 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/weekly-slot-availability.client.d.ts +9 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/weekly-slot-availability.client.state.d.ts +14 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/weekly-slot-availability.server.d.ts +10 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/weekly-slot-availability.view.d.ts +11 -0
- package/dist/_dts/blocks/src/system/runtime/resolver.d.ts +31 -1
- package/dist/_dts/blocks/src/system/runtime/shared/useWaitlistClaim.d.ts +5 -0
- package/dist/_dts/blocks/src/utils/date-formatting.d.ts +1 -1
- package/dist/_dts/content-editor/src/primitives/PreviewInlineTextEditor.d.ts +1 -1
- package/dist/_dts/content-editor/src/primitives/PreviewRichTextEditor.d.ts +1 -1
- package/dist/_dts/content-model/src/templates/defaults.d.ts +5 -5
- package/dist/_dts/content-model/src/templates/types.d.ts +2 -6
- package/dist/_dts/core/src/branded.d.ts +8 -0
- package/dist/_dts/db/src/generated/supabase/database.types.d.ts +505 -2
- package/dist/_dts/field-primitives/src/bindings/index.d.ts +8 -0
- package/dist/_dts/sdk/src/cli/commands/push/publishGuidance.d.ts +15 -0
- package/dist/_dts/sdk/src/cli/commands/push/scopes/commandBackedDatedOfferingScope.d.ts +2 -1
- package/dist/_dts/sdk/src/cli/commands/push/scopes/types.d.ts +3 -1
- package/dist/_dts/sdk/src/cli/commands/push/stale-resolution.d.ts +9 -3
- package/dist/_dts/sdk/src/cli/commands/push/workflowPlan.d.ts +34 -0
- package/dist/_dts/sdk/src/cli/commands/setup.d.ts +2 -0
- package/dist/_dts/sdk/src/cli/config-loader.d.ts +2 -0
- package/dist/_dts/sdk/src/cli/content/metadataStore.d.ts +29 -0
- package/dist/_dts/sdk/src/cli/content/reader.d.ts +16 -14
- package/dist/_dts/sdk/src/cli/content/writer.d.ts +6 -4
- package/dist/_dts/sdk/src/cli/env-scope.d.ts +2 -0
- package/dist/_dts/sdk/src/cli/helpers.d.ts +6 -7
- package/dist/_dts/sdk/src/cli/merge-remote/entryMergePush.d.ts +2 -0
- package/dist/_dts/sdk/src/cli/merge-remote/pageMergePush.d.ts +2 -0
- package/dist/_dts/sdk/src/cli/push-config.d.ts +13 -2
- package/dist/_dts/sdk/src/cli/setup/setupPlan.d.ts +51 -0
- package/dist/_dts/sdk/src/cli/site-commands/commandRuntime.d.ts +21 -0
- package/dist/_dts/sdk/src/client/runtimeCachePolicy.d.ts +1 -1
- package/dist/_dts/sdk/src/client/types.d.ts +18 -2
- package/dist/_dts/sdk/src/config/types.d.ts +1 -1
- package/dist/_dts/sdk/src/config/validation.d.ts +3 -0
- package/dist/_dts/sdk/src/contracts/bindings.d.ts +3 -7
- package/dist/_dts/sdk/src/contracts/system-block-content.d.ts +13 -0
- package/dist/_dts/sdk/src/next/route-outcome-proxy.d.ts +3 -3
- package/dist/_dts/sdk/src/public-api/contracts.d.ts +174 -78
- package/dist/_dts/sdk/src/public-api/runtime.d.ts +1 -1
- package/dist/_dts/sdk/src/rendering/helpers/bindings.d.ts +4 -4
- package/dist/_dts/sdk/src/rendering/helpers/loadContent.d.ts +52 -1
- package/dist/_dts/sdk/src/rendering/hooks/usePage.d.ts +2 -2
- package/dist/_dts/sdk/src/rendering/islands/types.d.ts +18 -66
- package/dist/_dts/sdk/src/types/block-kinds.d.ts +1 -1
- package/dist/_dts/sdk/src/version.d.ts +1 -1
- package/dist/{chunk-EL55VV6Q.mjs → chunk-6WDBXCPX.mjs} +31 -10
- package/dist/{chunk-XMATDBXO.mjs → chunk-DBRI3PQF.mjs} +731 -180
- package/dist/{chunk-VHIMXQ7Z.mjs → chunk-H24OU7WG.mjs} +2 -2
- package/dist/{chunk-4TLTV7OB.mjs → chunk-PKDPQHB5.mjs} +2 -2
- package/dist/{chunk-VTPPVAOL.mjs → chunk-QPXE2OUZ.mjs} +1 -1
- package/dist/{chunk-7ED5UNHL.mjs → chunk-V2BYFSPW.mjs} +109 -0
- package/dist/cli/index.mjs +2131 -1033
- package/dist/cli/init-docs/content/cli-reference.md +29 -1
- package/dist/cli/init-docs/content/getting-started.md +8 -0
- package/dist/cli/init-docs/content/workflow-agent-safe-sync.md +3 -1
- package/dist/cli/init-docs/content/workflow-preview-mode.md +6 -0
- package/dist/cli/init-docs/content/workflow-remote-setup.md +51 -0
- package/dist/client/{accordion-GUNXIIZR.mjs → accordion-Q2BDNL53.mjs} +1 -1
- package/dist/client/{bookingForm-AOU4VHP5.mjs → bookingForm-ZMP4P7EK.mjs} +16 -6
- package/dist/client/bookings.mjs +98 -18
- package/dist/client/{carousel-4QSX2JPC.mjs → carousel-LW3UXPWO.mjs} +1 -1
- package/dist/client/{cart-JKN6C4ZB.mjs → cart-Z6D3KS6K.mjs} +5 -5
- package/dist/client/{checkout-YY6YMITW.mjs → checkout-YMT2QJQM.mjs} +5 -5
- package/dist/client/{chunk-6H27K6AA.mjs → chunk-26ZBRXFR.mjs} +9 -3
- package/dist/client/{chunk-VJROUYOQ.mjs → chunk-DRRQ7QSL.mjs} +2 -2
- package/dist/client/{chunk-BFCJZODD.mjs → chunk-ET2MDQQT.mjs} +4 -4
- package/dist/client/{chunk-H7A6PUGM.mjs → chunk-HBQEAOG4.mjs} +1 -1
- package/dist/client/{chunk-CPKMJVBD.mjs → chunk-IEOECM7U.mjs} +62 -43
- package/dist/client/{chunk-TNGL2WJF.mjs → chunk-KDP7ZRZV.mjs} +16 -0
- package/dist/client/{chunk-GWCRCJLB.mjs → chunk-R4XK3CKR.mjs} +12 -1
- package/dist/client/{chunk-A3YN7M3G.mjs → chunk-SK2BMD22.mjs} +2 -2
- package/dist/client/{chunk-SY543WZ3.mjs → chunk-XNTHVZ25.mjs} +1 -1
- package/dist/client/client.mjs +3729 -3054
- package/dist/client/{courseRegistration-UU2KMPSQ.mjs → courseRegistration-DGKCMC77.mjs} +4 -4
- package/dist/client/{eventCalendar-WIVNS2TM.mjs → eventCalendar-74Z2NNFM.mjs} +7 -7
- package/dist/client/{eventCombined-P3G5MW4J.mjs → eventCombined-GK2ODOX2.mjs} +7 -7
- package/dist/client/{eventDetails-2VHJ2RDG.mjs → eventDetails-MONAGT3N.mjs} +7 -7
- package/dist/client/{eventListing-TGO6JI3R.mjs → eventListing-SKGAO6PS.mjs} +7 -7
- package/dist/client/{eventRegistration-B46HEJES.mjs → eventRegistration-6KISGXRD.mjs} +7 -7
- package/dist/client/{form-VKRTFUNQ.mjs → form-FXPRTXHI.mjs} +2 -2
- package/dist/client/{headerSection-XUX4ZJLO.mjs → headerSection-7NAN5WNB.mjs} +2 -2
- package/dist/client/hooks.mjs +1661 -1334
- package/dist/client/{locationMap-NQFI5MJO.mjs → locationMap-UERN74U4.mjs} +2 -2
- package/dist/client/{newsletterForm-P2GETCQK.mjs → newsletterForm-SGWXMJ7U.mjs} +2 -2
- package/dist/client/{productDetail-7NQ7O5IF.mjs → productDetail-HN3HWZQZ.mjs} +5 -5
- package/dist/client/{productList-RX6ZJ7BL.mjs → productList-YT22Z5UR.mjs} +5 -5
- package/dist/client/rendering/client.mjs +2208 -1922
- package/dist/client/rendering/islands.mjs +18 -18
- package/dist/client/rendering.mjs +1497 -811
- package/dist/client/{shop-BHN5AKY6.mjs → shop-TKEDNWUS.mjs} +5 -5
- package/dist/preview-next/before-render.mjs +109 -0
- package/dist/preview-next/client/runtime.mjs +5 -5
- package/dist/preview-next/middleware.mjs +109 -0
- package/dist/{sdk-runtime-X2LXQ5IC.mjs → sdk-runtime-LWNYCQF2.mjs} +6 -6
- package/dist/server/components.mjs +2351 -1872
- package/dist/server/config-template-validation.mjs +6 -2
- package/dist/server/config-validation.mjs +1861 -1561
- package/dist/server/config.mjs +1861 -1561
- package/dist/server/data.mjs +1647 -1331
- package/dist/server/index.mjs +208 -9
- package/dist/server/next/middleware.mjs +2 -2
- package/dist/server/next.mjs +2572 -1878
- package/dist/server/page-converter.mjs +1461 -1276
- package/dist/server/prebuild.mjs +1 -1
- package/dist/server/rendering/server.mjs +2372 -1875
- package/dist/server/rendering.mjs +2557 -1941
- package/dist/server/routing.mjs +1716 -1353
- package/dist/server/server.mjs +1911 -1380
- package/package.json +1 -1
- package/dist/SdkPreviewModeRuntime-MJUSYUFB.mjs +0 -8
|
@@ -2,6 +2,7 @@ import type { SiteId } from '../../../../../../core/src/index';
|
|
|
2
2
|
import { type FieldChange, type JsonDiffMode } from '../../../sync';
|
|
3
3
|
import { type CliDatedOfferingCommandBatchSource, type CliDatedOfferingCommandCompileInput, type DatedOfferingReportSubject, type DatedOfferingUpsertItem } from '../../../site-commands';
|
|
4
4
|
import type { WriterOptions } from '../../../content/writer';
|
|
5
|
+
import type { ContentMetadataTarget } from '../../../content/metadataStore';
|
|
5
6
|
import type { PushScopeResult, ScopePushContext } from './types';
|
|
6
7
|
import type { LocalMediaPushReport } from '../../../media/local-sync';
|
|
7
8
|
type CommandBackedDatedOfferingScopeConfig<TLocal, TRemote> = Readonly<{
|
|
@@ -13,7 +14,7 @@ type CommandBackedDatedOfferingScopeConfig<TLocal, TRemote> = Readonly<{
|
|
|
13
14
|
getDisplayLabel: (item: TLocal) => string;
|
|
14
15
|
shouldPushItem?: (item: TLocal) => boolean;
|
|
15
16
|
readLocal: (contentDir: string) => Promise<TLocal[]>;
|
|
16
|
-
readMeta: (contentDir: string) => Promise<Record<string, {
|
|
17
|
+
readMeta: (contentDir: string, metadataTarget?: ContentMetadataTarget) => Promise<Record<string, {
|
|
17
18
|
updatedAt?: string;
|
|
18
19
|
}> | null>;
|
|
19
20
|
fetchRemote: () => Promise<TRemote[]>;
|
|
@@ -5,12 +5,14 @@ import type { SiteId } from '../../../../../../core/src/index';
|
|
|
5
5
|
import type { EnvTarget } from '../../../helpers';
|
|
6
6
|
import type { JsonDiffMode } from '../../../sync';
|
|
7
7
|
import type { LocalMediaPushReport } from '../../../media/local-sync';
|
|
8
|
+
import type { ContentMetadataTarget } from '../../../content/metadataStore';
|
|
8
9
|
export type PushMediaPolicy = 'require' | 'allow-missing';
|
|
9
10
|
export interface ScopePushContext {
|
|
10
11
|
output: OutputContext;
|
|
11
12
|
contentDir: string;
|
|
12
13
|
siteId: SiteId;
|
|
13
14
|
targetEnv: EnvTarget;
|
|
15
|
+
metadataTarget: ContentMetadataTarget;
|
|
14
16
|
client: ManagementClient;
|
|
15
17
|
dryRun: boolean;
|
|
16
18
|
force: boolean;
|
|
@@ -60,7 +62,7 @@ export interface PushScopeConfig<TLocal, TRemote> {
|
|
|
60
62
|
/** Read local items from content directory */
|
|
61
63
|
readLocal: (contentDir: string) => Promise<TLocal[]>;
|
|
62
64
|
/** Read local metadata for stale detection */
|
|
63
|
-
readMeta: (contentDir: string) => Promise<Record<string, {
|
|
65
|
+
readMeta: (contentDir: string, metadataTarget?: ContentMetadataTarget) => Promise<Record<string, {
|
|
64
66
|
updatedAt?: string;
|
|
65
67
|
}> | null>;
|
|
66
68
|
/** Fetch remote items */
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type ContentMetadataTarget } from '../../content/metadataStore';
|
|
1
2
|
import type { OutputContext } from '../../output';
|
|
2
3
|
import type { PulledContent } from '../../../client/management/types';
|
|
3
4
|
import type { StaleItem } from './stale';
|
|
@@ -18,7 +19,7 @@ export declare function resolveStaleOrAbort(opts: {
|
|
|
18
19
|
yes: boolean;
|
|
19
20
|
}): Promise<'resolve' | 'abort'>;
|
|
20
21
|
/**
|
|
21
|
-
* Write only the stale entries/pages/navigation/forms from the already-fetched
|
|
22
|
+
* Write only the stale entries/pages/navigation/forms/settings from the already-fetched
|
|
22
23
|
* remoteContent to disk and update their metadata. Non-stale local content is
|
|
23
24
|
* preserved — we only touch the specific items identified as stale.
|
|
24
25
|
*
|
|
@@ -29,14 +30,19 @@ export declare function resolveStaleOrAbort(opts: {
|
|
|
29
30
|
*/
|
|
30
31
|
export declare function writeStaleItems(contentDir: string, remoteContent: PulledContent, staleItems: StaleItem[], output: OutputContext, options?: {
|
|
31
32
|
skipMeta?: boolean;
|
|
33
|
+
metadataTarget?: ContentMetadataTarget;
|
|
32
34
|
}): Promise<void>;
|
|
33
35
|
/**
|
|
34
36
|
* Update only the theme metadata timestamp without touching the theme content file.
|
|
35
37
|
* Used when the local theme IS the content being pushed — we just need to acknowledge
|
|
36
38
|
* the remote is newer so stale detection passes on the next push.
|
|
37
39
|
*/
|
|
38
|
-
export declare function updateStaleThemeMeta(contentDir: string, themeName: string, remoteUpdatedAt: string
|
|
40
|
+
export declare function updateStaleThemeMeta(contentDir: string, themeName: string, remoteUpdatedAt: string, options?: {
|
|
41
|
+
metadataTarget?: ContentMetadataTarget;
|
|
42
|
+
}): Promise<void>;
|
|
39
43
|
/**
|
|
40
44
|
* Update only the footer metadata timestamp without touching the footer content file.
|
|
41
45
|
*/
|
|
42
|
-
export declare function updateStaleFooterMeta(contentDir: string, remoteUpdatedAt: string
|
|
46
|
+
export declare function updateStaleFooterMeta(contentDir: string, remoteUpdatedAt: string, options?: {
|
|
47
|
+
metadataTarget?: ContentMetadataTarget;
|
|
48
|
+
}): Promise<void>;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { PushScope } from './consts';
|
|
2
|
+
export type PushWorkflowStep = Readonly<{
|
|
3
|
+
tag: 'config';
|
|
4
|
+
mode: 'apply';
|
|
5
|
+
}> | Readonly<{
|
|
6
|
+
tag: 'content';
|
|
7
|
+
}>;
|
|
8
|
+
export type PushWorkflowPreContentStep = Extract<PushWorkflowStep, {
|
|
9
|
+
tag: 'config';
|
|
10
|
+
}>;
|
|
11
|
+
export type PushWorkflowPlan = Readonly<{
|
|
12
|
+
steps: readonly PushWorkflowStep[];
|
|
13
|
+
warnings: readonly PushWorkflowWarning[];
|
|
14
|
+
}>;
|
|
15
|
+
export type PushWorkflowWarning = Readonly<{
|
|
16
|
+
tag: 'with_config_ignored_for_scope';
|
|
17
|
+
pushScope: PushScope;
|
|
18
|
+
}>;
|
|
19
|
+
export type PlanPushWorkflowInput = Readonly<{
|
|
20
|
+
pushScope: PushScope;
|
|
21
|
+
withConfig: boolean;
|
|
22
|
+
dryRun: boolean;
|
|
23
|
+
}>;
|
|
24
|
+
export declare function planPushWorkflow(input: PlanPushWorkflowInput): PushWorkflowPlan;
|
|
25
|
+
export declare function shouldApplyConfigBeforeContent(plan: PushWorkflowPlan): boolean;
|
|
26
|
+
export declare function preContentWorkflowSteps(plan: PushWorkflowPlan): readonly PushWorkflowPreContentStep[];
|
|
27
|
+
export type PushWorkflowPreContentHandlers = Readonly<{
|
|
28
|
+
[TStep in PushWorkflowPreContentStep as TStep['tag']]: (step: TStep) => Promise<boolean>;
|
|
29
|
+
}>;
|
|
30
|
+
export declare function runPushWorkflowPreContentSteps(plan: PushWorkflowPlan, handlers: PushWorkflowPreContentHandlers): Promise<Readonly<{
|
|
31
|
+
success: true;
|
|
32
|
+
}> | Readonly<{
|
|
33
|
+
success: false;
|
|
34
|
+
}>>;
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
* Loads riverbank.config.ts and extracts CLI-relevant configuration
|
|
5
5
|
* (contentDir and sync settings) with appropriate defaults.
|
|
6
6
|
*/
|
|
7
|
+
import type { EnvTarget } from './helpers';
|
|
7
8
|
import type { SyncConfig, BlockFieldExtensionsMap, SdkCustomBlock } from '../config/types';
|
|
8
9
|
/**
|
|
9
10
|
* Loaded CLI configuration with defaults applied.
|
|
@@ -36,6 +37,7 @@ export interface LoadedCliConfig {
|
|
|
36
37
|
* ```
|
|
37
38
|
*/
|
|
38
39
|
export declare function loadCliConfig(configPath?: string): Promise<LoadedCliConfig>;
|
|
40
|
+
export declare function loadCliConfigForEnv(target: EnvTarget, configPath?: string): Promise<LoadedCliConfig>;
|
|
39
41
|
/**
|
|
40
42
|
* Check if a CLI config file exists.
|
|
41
43
|
*
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { SdkEnvironment } from '../env';
|
|
2
|
+
export type ContentMetadataEnv = 'local' | 'remote';
|
|
3
|
+
export type ContentMetadataTarget = Readonly<{
|
|
4
|
+
env: ContentMetadataEnv;
|
|
5
|
+
siteId: string;
|
|
6
|
+
dashboardUrl: string;
|
|
7
|
+
}>;
|
|
8
|
+
export type ContentMetadataReadPath = Readonly<{
|
|
9
|
+
path: string;
|
|
10
|
+
source: 'scoped' | 'legacy';
|
|
11
|
+
}>;
|
|
12
|
+
export declare function metadataTargetFromEnvironment(env: ContentMetadataEnv, environment: Pick<SdkEnvironment, 'siteId' | 'dashboardUrl'>): ContentMetadataTarget;
|
|
13
|
+
export declare function legacyMetadataDir(contentDir: string): string;
|
|
14
|
+
export declare function scopedMetadataDir(contentDir: string, target: ContentMetadataTarget): string;
|
|
15
|
+
export declare function metadataFilePath(contentDir: string, fileName: string, target?: ContentMetadataTarget): string;
|
|
16
|
+
export declare function legacyMetadataFilePath(contentDir: string, fileName: string): string;
|
|
17
|
+
export declare function ensureMetadataDir(contentDir: string, target?: ContentMetadataTarget): Promise<string>;
|
|
18
|
+
export declare function writeMetadataFile(contentDir: string, fileName: string, value: unknown, target?: ContentMetadataTarget): Promise<string>;
|
|
19
|
+
export declare function readMetadataFile<T>(contentDir: string, fileName: string, target?: ContentMetadataTarget): Promise<T | null>;
|
|
20
|
+
export declare function listMetadataFiles(contentDir: string, target?: ContentMetadataTarget): Promise<string[]>;
|
|
21
|
+
export declare function writeMetadataRecordMap<TRecord>(contentDir: string, fileName: string, recordKey: string, next: Readonly<{
|
|
22
|
+
pulledAt: string;
|
|
23
|
+
records: Readonly<Record<string, TRecord>>;
|
|
24
|
+
extra?: Readonly<Record<string, unknown>>;
|
|
25
|
+
}>, options?: Readonly<{
|
|
26
|
+
mode?: 'replace' | 'merge';
|
|
27
|
+
target?: ContentMetadataTarget;
|
|
28
|
+
}>): Promise<string>;
|
|
29
|
+
export declare function resolveMetadataReadPath(contentDir: string, fileName: string, target?: ContentMetadataTarget): Promise<ContentMetadataReadPath | null>;
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
* Reads content from the file system for push operations.
|
|
5
5
|
* Mirrors the structure created by writer.ts.
|
|
6
6
|
*/
|
|
7
|
+
import { type ContentMetadataTarget } from './metadataStore';
|
|
7
8
|
import type { NavigationAuthoringLinkInput, NavigationLocalItemInput } from '../../../../api/src/navigation';
|
|
8
9
|
import type { SdkEventPricingInput } from '../../../../api/src/sdk-event-pricing';
|
|
9
10
|
import type { EventPaymentTermsInput } from '../../client/management/types';
|
|
@@ -233,7 +234,7 @@ export declare function findLegacyEntryFiles(contentDir: string): Promise<string
|
|
|
233
234
|
* @param contentType - Optional specific content type to read
|
|
234
235
|
* @returns Map of content type to entries
|
|
235
236
|
*/
|
|
236
|
-
export declare function readEntries(contentDir: string, contentType?: string): Promise<Map<string, LocalEntry[]>>;
|
|
237
|
+
export declare function readEntries(contentDir: string, contentType?: string, metadataTarget?: ContentMetadataTarget): Promise<Map<string, LocalEntry[]>>;
|
|
237
238
|
/**
|
|
238
239
|
* Read pages from content directory
|
|
239
240
|
*
|
|
@@ -350,7 +351,7 @@ export interface LocalContent {
|
|
|
350
351
|
events: LocalEvent[];
|
|
351
352
|
courses: LocalCourse[];
|
|
352
353
|
}
|
|
353
|
-
export declare function readAllContent(contentDir: string): Promise<LocalContent>;
|
|
354
|
+
export declare function readAllContent(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<LocalContent>;
|
|
354
355
|
/**
|
|
355
356
|
* Check if content directory exists and has content
|
|
356
357
|
*/
|
|
@@ -387,6 +388,7 @@ export interface EntryMetadata {
|
|
|
387
388
|
createdAt?: string;
|
|
388
389
|
updatedAt?: string;
|
|
389
390
|
publishedAt?: string;
|
|
391
|
+
hasUnpublishedChanges?: boolean;
|
|
390
392
|
}>;
|
|
391
393
|
}
|
|
392
394
|
export interface PagesMetadata {
|
|
@@ -414,35 +416,35 @@ export interface SettingsMetadata {
|
|
|
414
416
|
* @param contentType - Content type to read metadata for
|
|
415
417
|
* @returns Metadata or null if not found
|
|
416
418
|
*/
|
|
417
|
-
export declare function readEntriesMeta(contentDir: string, contentType: string): Promise<EntryMetadata | null>;
|
|
419
|
+
export declare function readEntriesMeta(contentDir: string, contentType: string, metadataTarget?: ContentMetadataTarget): Promise<EntryMetadata | null>;
|
|
418
420
|
/**
|
|
419
421
|
* Read all entry metadata files from .meta/ directory
|
|
420
422
|
*
|
|
421
423
|
* @param contentDir - Base content directory
|
|
422
424
|
* @returns Map of content type to metadata
|
|
423
425
|
*/
|
|
424
|
-
export declare function readAllMeta(contentDir: string): Promise<Map<string, EntryMetadata>>;
|
|
426
|
+
export declare function readAllMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<Map<string, EntryMetadata>>;
|
|
425
427
|
/**
|
|
426
428
|
* Read settings metadata from .meta/settings.json
|
|
427
429
|
*
|
|
428
430
|
* @param contentDir - Base content directory
|
|
429
431
|
* @returns Settings metadata or null if not found
|
|
430
432
|
*/
|
|
431
|
-
export declare function readSettingsMeta(contentDir: string): Promise<SettingsMetadata | null>;
|
|
433
|
+
export declare function readSettingsMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<SettingsMetadata | null>;
|
|
432
434
|
/**
|
|
433
435
|
* Read pages metadata from .meta/pages.json
|
|
434
436
|
*
|
|
435
437
|
* @param contentDir - Base content directory
|
|
436
438
|
* @returns Pages metadata or null if not found
|
|
437
439
|
*/
|
|
438
|
-
export declare function readPagesMeta(contentDir: string): Promise<PagesMetadata | null>;
|
|
440
|
+
export declare function readPagesMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<PagesMetadata | null>;
|
|
439
441
|
/**
|
|
440
442
|
* Read navigation metadata from .meta/navigation.json
|
|
441
443
|
*
|
|
442
444
|
* @param contentDir - Base content directory
|
|
443
445
|
* @returns Navigation metadata or null if not found
|
|
444
446
|
*/
|
|
445
|
-
export declare function readNavigationMeta(contentDir: string): Promise<NavigationMetadata | null>;
|
|
447
|
+
export declare function readNavigationMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<NavigationMetadata | null>;
|
|
446
448
|
export interface FormsMetadata {
|
|
447
449
|
pulledAt: string;
|
|
448
450
|
forms: Record<string, {
|
|
@@ -456,7 +458,7 @@ export interface FormsMetadata {
|
|
|
456
458
|
* @param contentDir - Base content directory
|
|
457
459
|
* @returns Forms metadata or null if not found
|
|
458
460
|
*/
|
|
459
|
-
export declare function readFormsMeta(contentDir: string): Promise<FormsMetadata | null>;
|
|
461
|
+
export declare function readFormsMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<FormsMetadata | null>;
|
|
460
462
|
export interface ThemesMetadata {
|
|
461
463
|
pulledAt: string;
|
|
462
464
|
themes: Record<string, {
|
|
@@ -471,7 +473,7 @@ export interface ThemesMetadata {
|
|
|
471
473
|
* @param contentDir - Base content directory
|
|
472
474
|
* @returns Themes metadata or null if not found
|
|
473
475
|
*/
|
|
474
|
-
export declare function readThemesMeta(contentDir: string): Promise<ThemesMetadata | null>;
|
|
476
|
+
export declare function readThemesMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<ThemesMetadata | null>;
|
|
475
477
|
export interface VenuesMetadata {
|
|
476
478
|
pulledAt: string;
|
|
477
479
|
venues: Record<string, {
|
|
@@ -485,7 +487,7 @@ export interface VenuesMetadata {
|
|
|
485
487
|
* @param contentDir - Base content directory
|
|
486
488
|
* @returns Venues metadata or null if not found
|
|
487
489
|
*/
|
|
488
|
-
export declare function readVenuesMeta(contentDir: string): Promise<VenuesMetadata | null>;
|
|
490
|
+
export declare function readVenuesMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<VenuesMetadata | null>;
|
|
489
491
|
export interface EventCategoriesMetadata {
|
|
490
492
|
pulledAt: string;
|
|
491
493
|
eventCategories: Record<string, {
|
|
@@ -499,7 +501,7 @@ export interface EventCategoriesMetadata {
|
|
|
499
501
|
* @param contentDir - Base content directory
|
|
500
502
|
* @returns Event categories metadata or null if not found
|
|
501
503
|
*/
|
|
502
|
-
export declare function readEventCategoriesMeta(contentDir: string): Promise<EventCategoriesMetadata | null>;
|
|
504
|
+
export declare function readEventCategoriesMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<EventCategoriesMetadata | null>;
|
|
503
505
|
export interface EventsMetadata {
|
|
504
506
|
pulledAt: string;
|
|
505
507
|
events: Record<string, {
|
|
@@ -520,14 +522,14 @@ export interface CoursesMetadata {
|
|
|
520
522
|
* @param contentDir - Base content directory
|
|
521
523
|
* @returns Events metadata or null if not found
|
|
522
524
|
*/
|
|
523
|
-
export declare function readEventsMeta(contentDir: string): Promise<EventsMetadata | null>;
|
|
525
|
+
export declare function readEventsMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<EventsMetadata | null>;
|
|
524
526
|
/**
|
|
525
527
|
* Read courses metadata from .meta/courses.json
|
|
526
528
|
*
|
|
527
529
|
* @param contentDir - Base content directory
|
|
528
530
|
* @returns Courses metadata or null if not found
|
|
529
531
|
*/
|
|
530
|
-
export declare function readCoursesMeta(contentDir: string): Promise<CoursesMetadata | null>;
|
|
532
|
+
export declare function readCoursesMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<CoursesMetadata | null>;
|
|
531
533
|
export interface FooterMetadata {
|
|
532
534
|
pulledAt: string;
|
|
533
535
|
updatedAt?: string;
|
|
@@ -538,4 +540,4 @@ export interface FooterMetadata {
|
|
|
538
540
|
* @param contentDir - Base content directory
|
|
539
541
|
* @returns Footer metadata or null if not found
|
|
540
542
|
*/
|
|
541
|
-
export declare function readFooterMeta(contentDir: string): Promise<FooterMetadata | null>;
|
|
543
|
+
export declare function readFooterMeta(contentDir: string, metadataTarget?: ContentMetadataTarget): Promise<FooterMetadata | null>;
|
|
@@ -5,17 +5,19 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import type { PulledEntries, PulledPages, PulledNavigation, PulledSettings, PulledForms, PulledTheme, PulledFooter, PulledVenues, PulledEventCategories, PulledEvents, PulledCourses } from '../../client/management/types';
|
|
7
7
|
import type { Theme } from '../../contracts';
|
|
8
|
-
import { type
|
|
8
|
+
import { type EntryForOutput } from '../helpers';
|
|
9
9
|
import type { EntryBaseSnapshotTarget } from '../merge-remote/entrySnapshots';
|
|
10
10
|
import type { PageBaseSnapshotTarget } from '../merge-remote/pageSnapshots';
|
|
11
|
+
import { type ContentMetadataTarget } from './metadataStore';
|
|
11
12
|
export interface WriterOptions {
|
|
12
13
|
skipMeta?: boolean;
|
|
13
14
|
cleanupMissing?: boolean;
|
|
15
|
+
metadataTarget?: ContentMetadataTarget;
|
|
14
16
|
entryBaseSnapshot?: EntryBaseSnapshotTarget;
|
|
15
17
|
pageBaseSnapshot?: PageBaseSnapshotTarget;
|
|
16
18
|
}
|
|
17
19
|
type WritablePulledEntries = Omit<PulledEntries, 'entries'> & {
|
|
18
|
-
entries:
|
|
20
|
+
entries: EntryForOutput[];
|
|
19
21
|
};
|
|
20
22
|
/**
|
|
21
23
|
* Write entries to content directory
|
|
@@ -92,7 +94,7 @@ export declare function writeThemesMeta(contentDir: string, meta: {
|
|
|
92
94
|
selectionId: string;
|
|
93
95
|
updatedAt: string;
|
|
94
96
|
}>;
|
|
95
|
-
}): Promise<void>;
|
|
97
|
+
}, options?: Pick<WriterOptions, 'metadataTarget'>): Promise<void>;
|
|
96
98
|
/**
|
|
97
99
|
* Write a pulled theme to content directory with metadata
|
|
98
100
|
*
|
|
@@ -207,7 +209,7 @@ export declare function updateMetadataAfterPush(contentDir: string, remoteConten
|
|
|
207
209
|
updatedAt: string;
|
|
208
210
|
createdAt?: string;
|
|
209
211
|
}>;
|
|
210
|
-
}): Promise<void>;
|
|
212
|
+
}, options?: Pick<WriterOptions, 'metadataTarget'>): Promise<void>;
|
|
211
213
|
export declare function writeAllContent(contentDir: string, content: {
|
|
212
214
|
entries: Record<string, PulledEntries['entries']>;
|
|
213
215
|
pages: PulledPages;
|
|
@@ -85,17 +85,16 @@ export interface ParsedPagination {
|
|
|
85
85
|
*/
|
|
86
86
|
export type RowFormatter<T> = (item: T) => string[];
|
|
87
87
|
/**
|
|
88
|
-
* Entry format
|
|
89
|
-
*
|
|
88
|
+
* Entry format written to content/entries/*.json.
|
|
89
|
+
* Operational fields such as manual ordering and unpublished state live in
|
|
90
|
+
* metadata so entry files remain authoring-focused.
|
|
90
91
|
*/
|
|
91
|
-
export interface
|
|
92
|
+
export interface EntryContentFileOutput {
|
|
92
93
|
identifier: string;
|
|
93
94
|
data: Record<string, unknown>;
|
|
94
95
|
status: 'draft' | 'published';
|
|
95
|
-
hasUnpublishedChanges: boolean;
|
|
96
96
|
/** Slug for URL routing - only present for routable content types */
|
|
97
97
|
slug?: string;
|
|
98
|
-
manualOrder?: number;
|
|
99
98
|
blocks?: Record<string, Array<{
|
|
100
99
|
identifier: string | null;
|
|
101
100
|
kind: string;
|
|
@@ -114,9 +113,9 @@ export interface EntryForOutput {
|
|
|
114
113
|
slug?: string;
|
|
115
114
|
title?: string;
|
|
116
115
|
manualOrder?: number;
|
|
117
|
-
blocks?:
|
|
116
|
+
blocks?: EntryContentFileOutput['blocks'];
|
|
118
117
|
}
|
|
119
|
-
export declare function mapEntryForOutput<T extends EntryForOutput>(entry: T):
|
|
118
|
+
export declare function mapEntryForOutput<T extends EntryForOutput>(entry: T): EntryContentFileOutput;
|
|
120
119
|
/**
|
|
121
120
|
* Parse pagination options from command flags.
|
|
122
121
|
*
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { type SiteId } from '../../../../core/src/index';
|
|
2
2
|
import type { ManagementClient } from '../../client/management/types';
|
|
3
|
+
import type { ContentMetadataTarget } from '../content/metadataStore';
|
|
3
4
|
import type { LocalEntry } from '../content/reader';
|
|
4
5
|
import type { EnvTarget } from '../helpers';
|
|
5
6
|
import type { OutputContext } from '../output';
|
|
@@ -12,6 +13,7 @@ export declare function planAndReportRemoteEntryMerge(input: Readonly<{
|
|
|
12
13
|
contentDir: string;
|
|
13
14
|
target: EnvTarget;
|
|
14
15
|
siteId: SiteId;
|
|
16
|
+
metadataTarget: ContentMetadataTarget;
|
|
15
17
|
contentType?: string;
|
|
16
18
|
identifier?: string;
|
|
17
19
|
localEntries: ReadonlyMap<string, readonly LocalEntry[]>;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { SiteId } from '../../../../core/src/index';
|
|
2
2
|
import type { ManagementClient } from '../../client/management/types';
|
|
3
|
+
import type { ContentMetadataTarget } from '../content/metadataStore';
|
|
3
4
|
import type { LocalPage } from '../content/reader';
|
|
4
5
|
import type { EnvTarget } from '../helpers';
|
|
5
6
|
import type { OutputContext } from '../output';
|
|
@@ -12,6 +13,7 @@ export declare function planAndReportRemotePageMerge(input: Readonly<{
|
|
|
12
13
|
contentDir: string;
|
|
13
14
|
target: EnvTarget;
|
|
14
15
|
siteId: SiteId;
|
|
16
|
+
metadataTarget: ContentMetadataTarget;
|
|
15
17
|
identifier?: string;
|
|
16
18
|
localPages: readonly LocalPage[];
|
|
17
19
|
dryRun: boolean;
|
|
@@ -11,18 +11,29 @@ interface PushConfigOptions {
|
|
|
11
11
|
apiKey?: string;
|
|
12
12
|
dashboard: string;
|
|
13
13
|
forceContentTypes?: boolean;
|
|
14
|
+
dryRun?: boolean;
|
|
14
15
|
}
|
|
16
|
+
export type PushConfigActionResult = Readonly<{
|
|
17
|
+
success: true;
|
|
18
|
+
}> | Readonly<{
|
|
19
|
+
success: false;
|
|
20
|
+
}>;
|
|
15
21
|
type PushConfigResponse = NonNullable<APIEndpoints['pushSdkConfig']['response']>;
|
|
16
22
|
type PushConfigSync = NonNullable<PushConfigResponse['configSync']>;
|
|
17
23
|
type LegacyPushConfigSync = NonNullable<PushConfigResponse['sync']>;
|
|
18
24
|
type PushConfigDisplaySync = PushConfigSync | LegacyPushConfigSync;
|
|
19
25
|
type PushConfigSyncArea = 'contentTypes' | 'customBlocks' | 'templateBlocks' | 'settings' | 'ignoredDocuments' | 'pages' | 'entries' | 'navigationMenus';
|
|
20
|
-
type PushConfigSyncMessage = {
|
|
26
|
+
export type PushConfigSyncMessage = {
|
|
21
27
|
area: PushConfigSyncArea;
|
|
22
28
|
message: string;
|
|
23
29
|
};
|
|
24
30
|
export declare function collectPushConfigSyncErrors(sync: PushConfigDisplaySync): PushConfigSyncMessage[];
|
|
25
31
|
export declare function collectPushConfigSyncWarnings(sync: PushConfigDisplaySync): PushConfigSyncMessage[];
|
|
32
|
+
export declare function groupPushConfigSyncWarningsForHuman(warnings: readonly PushConfigSyncMessage[]): PushConfigSyncMessage[];
|
|
33
|
+
export declare function isPushConfigActionSuccess(result: PushConfigActionResult): result is Extract<PushConfigActionResult, {
|
|
34
|
+
success: true;
|
|
35
|
+
}>;
|
|
36
|
+
export declare function markFailedPushConfigCommandResult(result: PushConfigActionResult): void;
|
|
26
37
|
/**
|
|
27
38
|
* Main push-config action.
|
|
28
39
|
* Exported for reuse by `push --with-config`.
|
|
@@ -30,7 +41,7 @@ export declare function collectPushConfigSyncWarnings(sync: PushConfigDisplaySyn
|
|
|
30
41
|
export declare function pushConfigAction(output: OutputContext, options: PushConfigOptions & {
|
|
31
42
|
isRemote: boolean;
|
|
32
43
|
isJsonOutput?: boolean;
|
|
33
|
-
}): Promise<
|
|
44
|
+
}): Promise<PushConfigActionResult>;
|
|
34
45
|
/**
|
|
35
46
|
* push-config command definition
|
|
36
47
|
*/
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import type { EnvTarget } from '../helpers';
|
|
2
|
+
export type SetupOperation = 'create_site' | 'create_management_key' | 'grant_user_access' | 'configure_env' | 'verify_access';
|
|
3
|
+
export type SetupAuthority = 'dashboard_admin' | 'cms_repo_script' | 'sdk_management_key';
|
|
4
|
+
export type SetupPlanStep = Readonly<{
|
|
5
|
+
tag: 'admin_action';
|
|
6
|
+
operation: Exclude<SetupOperation, 'configure_env' | 'verify_access'>;
|
|
7
|
+
title: string;
|
|
8
|
+
detail: string;
|
|
9
|
+
allowedAuthorities: readonly Exclude<SetupAuthority, 'sdk_management_key'>[];
|
|
10
|
+
}> | Readonly<{
|
|
11
|
+
tag: 'local_env';
|
|
12
|
+
operation: 'configure_env';
|
|
13
|
+
title: string;
|
|
14
|
+
detail: string;
|
|
15
|
+
missingVariables: readonly string[];
|
|
16
|
+
exampleLines: readonly string[];
|
|
17
|
+
}> | Readonly<{
|
|
18
|
+
tag: 'cli_check';
|
|
19
|
+
operation: 'verify_access';
|
|
20
|
+
title: string;
|
|
21
|
+
detail: string;
|
|
22
|
+
commands: readonly string[];
|
|
23
|
+
}>;
|
|
24
|
+
export type SetupCapability = Readonly<{
|
|
25
|
+
authority: 'dashboard_admin';
|
|
26
|
+
can: readonly ('create_site' | 'create_management_key' | 'grant_user_access')[];
|
|
27
|
+
}> | Readonly<{
|
|
28
|
+
authority: 'cms_repo_script';
|
|
29
|
+
can: readonly ('create_site' | 'create_management_key' | 'grant_user_access')[];
|
|
30
|
+
requirement: string;
|
|
31
|
+
}> | Readonly<{
|
|
32
|
+
authority: 'sdk_management_key';
|
|
33
|
+
can: readonly ('verify_access')[];
|
|
34
|
+
cannot: readonly ('create_site' | 'create_management_key' | 'grant_user_access')[];
|
|
35
|
+
}>;
|
|
36
|
+
export interface SetupTargetStatus {
|
|
37
|
+
target: EnvTarget;
|
|
38
|
+
siteId: string | null;
|
|
39
|
+
dashboardUrl: string | null;
|
|
40
|
+
managementApiKeySet: boolean;
|
|
41
|
+
}
|
|
42
|
+
export interface SdkSetupPlan {
|
|
43
|
+
target: EnvTarget;
|
|
44
|
+
configured: boolean;
|
|
45
|
+
canMutatePrivilegedResources: false;
|
|
46
|
+
capabilities: readonly SetupCapability[];
|
|
47
|
+
steps: readonly SetupPlanStep[];
|
|
48
|
+
securityNotes: readonly string[];
|
|
49
|
+
}
|
|
50
|
+
export declare function planSdkSetup(status: SetupTargetStatus): SdkSetupPlan;
|
|
51
|
+
export declare function formatSdkSetupPlan(plan: SdkSetupPlan): string;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { type Result, type SiteId } from '../../../../core/src/index';
|
|
2
2
|
import { type DryRunReport, type SiteCommandBatch, type SiteCommandExecutionSuccess, type SiteCommandOf, type SiteCommandPlanFor, type SiteCommandRef, type SiteCommandType, type SiteCommandValidationError } from '../../../../site-commands/src/index';
|
|
3
|
+
import { type ManagementApiErrorRequest } from '../../client/management';
|
|
3
4
|
import type { EnvTarget } from '../helpers';
|
|
4
5
|
export type CliCommandBatchRefInput<TSource extends string = string> = Readonly<{
|
|
5
6
|
source: TSource;
|
|
@@ -11,6 +12,22 @@ export type CliCommandExecutionError<TCommandType extends SiteCommandType> = Rea
|
|
|
11
12
|
commandRef: SiteCommandRef;
|
|
12
13
|
commandType: TCommandType;
|
|
13
14
|
message: string;
|
|
15
|
+
detail?: CliCommandFailureDetail;
|
|
16
|
+
}>;
|
|
17
|
+
export type CliCommandFailureFieldError = Readonly<{
|
|
18
|
+
field: string;
|
|
19
|
+
message: string;
|
|
20
|
+
code?: string;
|
|
21
|
+
}>;
|
|
22
|
+
export type CliCommandFailureDetail = Readonly<{
|
|
23
|
+
tag: 'management_api';
|
|
24
|
+
code: string;
|
|
25
|
+
statusCode?: number;
|
|
26
|
+
request?: ManagementApiErrorRequest;
|
|
27
|
+
fieldErrors: readonly CliCommandFailureFieldError[];
|
|
28
|
+
details?: unknown;
|
|
29
|
+
}> | Readonly<{
|
|
30
|
+
tag: 'unknown';
|
|
14
31
|
}>;
|
|
15
32
|
export type CliCommandExecutionResult<TCommandType extends SiteCommandType> = Readonly<{
|
|
16
33
|
status: 'applied';
|
|
@@ -43,6 +60,7 @@ export type CliCommandReportedPlannedCommand<TCommand extends Readonly<{
|
|
|
43
60
|
export type CliCommandExecutionReportFailure<TSubject> = Readonly<{
|
|
44
61
|
identifier: string;
|
|
45
62
|
message: string;
|
|
63
|
+
detail?: CliCommandFailureDetail;
|
|
46
64
|
subject?: TSubject;
|
|
47
65
|
}>;
|
|
48
66
|
export type CliCommandOutcome<TSubject> = Readonly<{
|
|
@@ -56,6 +74,7 @@ export type CliCommandOutcome<TSubject> = Readonly<{
|
|
|
56
74
|
commandType: SiteCommandType;
|
|
57
75
|
identifier: string;
|
|
58
76
|
message: string;
|
|
77
|
+
detail?: CliCommandFailureDetail;
|
|
59
78
|
subject?: TSubject;
|
|
60
79
|
}> | Readonly<{
|
|
61
80
|
status: 'skipped_by_stop_policy';
|
|
@@ -97,6 +116,7 @@ export declare function createCliCommandBatchRef(input: CliCommandBatchRefInput)
|
|
|
97
116
|
export declare function formatSiteCommandValidationErrors(errors: readonly {
|
|
98
117
|
message: string;
|
|
99
118
|
}[]): string;
|
|
119
|
+
export declare function managementErrorDetail(error: unknown): CliCommandFailureDetail;
|
|
100
120
|
export declare function formatManagementError(error: unknown): string;
|
|
101
121
|
export declare function planCliCommandBatchForTypes<TCommandType extends SiteCommandType>(input: CliCommandBatchRefInput & Readonly<{
|
|
102
122
|
commands: readonly SiteCommandOf<TCommandType>[];
|
|
@@ -126,6 +146,7 @@ export declare function commandExecutionToReport<TCommand extends Readonly<{
|
|
|
126
146
|
export declare function commandCompileFailureToReport<TSubject>(input: Readonly<{
|
|
127
147
|
identifier: string;
|
|
128
148
|
message: string;
|
|
149
|
+
detail?: CliCommandFailureDetail;
|
|
129
150
|
subject?: TSubject;
|
|
130
151
|
warnings?: readonly string[];
|
|
131
152
|
}>): CliCommandExecutionReport<TSubject>;
|
|
@@ -34,7 +34,7 @@ export type ResolveRuntimeCachePolicyInput = Readonly<{
|
|
|
34
34
|
}>;
|
|
35
35
|
export declare function resolveRuntimeCachePolicy(input: ResolveRuntimeCachePolicyInput): RuntimeCachePolicy;
|
|
36
36
|
export type GetSiteRuntimeCacheParams = Readonly<Pick<GetSiteParams, 'id' | 'slug' | 'domain' | 'currentPath' | 'force'>>;
|
|
37
|
-
export type GetContentByPathRuntimeCacheParams = Readonly<Pick<GetPageParams, 'siteId' | 'path' | 'preview'>>;
|
|
37
|
+
export type GetContentByPathRuntimeCacheParams = Readonly<Pick<GetPageParams, 'siteId' | 'path' | 'preview' | 'contentContract'>>;
|
|
38
38
|
type KeyDeriverInputByEndpoint = Readonly<{
|
|
39
39
|
getSite: GetSiteRuntimeCacheParams;
|
|
40
40
|
getContentByPath: GetContentByPathRuntimeCacheParams;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { CheckRedirectResponse, EntriesResponse, EntryResponse, PageResponse, PublicBookingServicesResponse, PublicCoursesResponse, PublicFormResponse, PublicFormsResponse, PublicProductsResponse, PublicTeamMembersResponse, PublicMembershipsResponse, PublicPassesResponse, PublicEventDetailsResponse, PublicEventsResponse, ResolveEntrySubrouteResponse, ResolveEventOccurrenceResponse, RouteOutcomeResponse, RoutableContentResponse, SiteResponse, SitemapRoutesResponse, PublicProductCategorySelector } from '../public-api/contracts';
|
|
1
|
+
import type { CheckRedirectResponse, EntriesResponse, EntryResponse, PageResponse, PublicBookingServicesResponse, PublicWeeklySlotAvailabilityResponse, PublicCoursesResponse, PublicFormResponse, PublicFormsResponse, PublicProductsResponse, PublicTeamMembersResponse, PublicMembershipsResponse, PublicPassesResponse, PublicEventDetailsResponse, PublicEventsResponse, ResolveEntrySubrouteResponse, ResolveEventOccurrenceResponse, RouteDecisionResponse, RouteOutcomeResponse, RoutableContentResponse, SiteResponse, SitemapRoutesResponse, PublicProductCategorySelector } from '../public-api/contracts';
|
|
2
2
|
import type { PublishedRuntimeCacheAdapter, PublishedRuntimeCacheAdapterErrorKind } from './runtimeCachePolicy';
|
|
3
|
-
export type { CheckRedirectResponse, EntriesResponse, EntryResponse, PageResponse, PublicBookingServicesResponse, PublicCoursesResponse, PublicEventsResponse, PublicFormResponse, PublicFormsResponse, PublicProductsResponse, PublicTeamMembersResponse, PublicMembershipsResponse, PublicPassesResponse, PublicEventDetailsResponse, ResolveEntrySubrouteResponse, ResolveEventOccurrenceResponse, RouteOutcomeResponse, RoutableContentResponse, SiteResponse, SitemapRoutesResponse, } from '../public-api/contracts';
|
|
3
|
+
export type { CheckRedirectResponse, EntriesResponse, EntryResponse, PageResponse, PublicBookingServicesResponse, PublicWeeklySlotAvailabilityResponse, PublicCoursesResponse, PublicEventsResponse, PublicFormResponse, PublicFormsResponse, PublicProductsResponse, PublicTeamMembersResponse, PublicMembershipsResponse, PublicPassesResponse, PublicEventDetailsResponse, ResolveEntrySubrouteResponse, ResolveEventOccurrenceResponse, RouteDecisionResponse, RouteOutcomeResponse, RoutableContentResponse, SiteResponse, SitemapRoutesResponse, } from '../public-api/contracts';
|
|
4
4
|
/**
|
|
5
5
|
* Pagination metadata returned when `includeMeta: true`
|
|
6
6
|
*/
|
|
@@ -48,6 +48,7 @@ export type GetPageParams = {
|
|
|
48
48
|
siteId: string;
|
|
49
49
|
path: string;
|
|
50
50
|
preview?: boolean;
|
|
51
|
+
contentContract?: 'compat' | 'native';
|
|
51
52
|
} & SdkMethodOptions;
|
|
52
53
|
/**
|
|
53
54
|
* Base parameters for getEntries - shared across all overloads
|
|
@@ -456,6 +457,16 @@ export interface RiverbankClient {
|
|
|
456
457
|
siteId: string;
|
|
457
458
|
ids?: string;
|
|
458
459
|
} & SdkMethodOptions): Promise<PublicBookingServicesResponse>;
|
|
460
|
+
/**
|
|
461
|
+
* Fetch public weekly appointment slot availability for a service.
|
|
462
|
+
*/
|
|
463
|
+
getPublicWeeklySlotAvailability(params: {
|
|
464
|
+
siteId: string;
|
|
465
|
+
serviceId: string;
|
|
466
|
+
resourceId?: string;
|
|
467
|
+
horizonWeeks?: number;
|
|
468
|
+
timezone?: string;
|
|
469
|
+
} & SdkMethodOptions): Promise<PublicWeeklySlotAvailabilityResponse>;
|
|
459
470
|
/**
|
|
460
471
|
* List public events for a site (optionally time-filtered)
|
|
461
472
|
*/
|
|
@@ -609,6 +620,11 @@ export interface RiverbankClient {
|
|
|
609
620
|
path: string;
|
|
610
621
|
preview?: boolean;
|
|
611
622
|
} & SdkMethodOptions): Promise<RouteOutcomeResponse>;
|
|
623
|
+
resolveRouteDecision(params: {
|
|
624
|
+
siteId: string;
|
|
625
|
+
path: string;
|
|
626
|
+
preview?: boolean;
|
|
627
|
+
} & SdkMethodOptions): Promise<RouteDecisionResponse>;
|
|
612
628
|
/**
|
|
613
629
|
* Get all published routes for a site.
|
|
614
630
|
* Useful for static site generation (SSG) to enumerate all pages.
|
|
@@ -45,7 +45,7 @@ export type BlockCategory = 'marketing' | 'content' | 'blog' | 'media' | 'layout
|
|
|
45
45
|
*
|
|
46
46
|
* Re-exported from `@riverbankcms/blocks` (single source of truth).
|
|
47
47
|
*/
|
|
48
|
-
export declare const SUPPORTED_LOADER_ENDPOINTS: readonly ["listPublishedEntries", "getPublishedEntryPreview", "listPublicEvents", "getPublicEventDetails", "listPublicCourses", "listPublicRouteCandidates", "listPublicTeamMembers", "listPublicProducts", "listPublicPasses", "listPublicMemberships", "getPublicFormById", "getPublicBookingServices"];
|
|
48
|
+
export declare const SUPPORTED_LOADER_ENDPOINTS: readonly ["listPublishedEntries", "getPublishedEntryPreview", "listPublicEvents", "getPublicEventDetails", "listPublicCourses", "listPublicRouteCandidates", "listPublicTeamMembers", "listPublicProducts", "listPublicPasses", "listPublicMemberships", "getPublicFormById", "getPublicBookingServices", "getPublicWeeklySlotAvailability"];
|
|
49
49
|
export type SdkLoaderEndpoint = (typeof SUPPORTED_LOADER_ENDPOINTS)[number];
|
|
50
50
|
export type LoaderParamBinding = {
|
|
51
51
|
$bind: {
|