@riverbankcms/sdk 0.107.0 → 0.108.0

package/dist/_dts/api/src/cache-tags.d.ts

@@ -32,6 +32,7 @@ export declare const TAG_TEMPLATES: {
     readonly siteRouteOutcomes: "riverbank:site:{siteId}:route-outcomes";
     readonly routeById: "riverbank:route:{routeId}";
     readonly pageById: "riverbank:page:{pageId}";
+    readonly pageSurfaceById: "riverbank:page-surface:{pageSurfaceId}";
     readonly workflowRunById: "riverbank:workflow-run:{runId}";
     readonly siteForms: "riverbank:site:{siteId}:forms";
     readonly formById: "riverbank:form:{formId}";
@@ -74,6 +75,8 @@ export declare const tags: {
     readonly siteRouteOutcomes: (siteId: string) => string;
     readonly route: (routeId: string) => string;
     readonly page: (pageId: string) => string;
+    readonly pageSurface: (pageSurfaceId: string) => string;
+    readonly surfaceSlot: (surfaceSlotId: string) => string;
     readonly workflowRun: (runId: string) => string;
     readonly siteForms: (siteId: string) => string;
     readonly form: (formId: string) => string;

package/dist/_dts/api/src/contentRuntime.d.ts

@@ -115,6 +115,16 @@ export type ContentEntryDetail<TContent> = {
     draftContent: TContent;
     publishedContent: TContent | null;
 };
+export type PageSurfaceEditorDocument<TContent = Record<string, unknown>> = {
+    owner: {
+        kind: 'pageSurface';
+        pageSurfaceId: string;
+    };
+    route: ContentRouteRecord;
+    draftContent: TContent;
+    publishedContent: TContent | null;
+    optimisticHash: string;
+};
 export type ContentEntryDetailResponse<TContent = Record<string, unknown>> = {
     entry: ContentEntryDetail<TContent>;
     optimisticHash?: string | null;
@@ -420,6 +430,7 @@ export type BlockListItem = {
     content?: Record<string, unknown> | null;
     draftContent?: Record<string, unknown> | null;
     publishedContent?: Record<string, unknown> | null;
+    optimisticHash?: string | null;
 };
 export type EntryPageContentSlotAllowedBlocks = Readonly<{
     kind: 'default';
@@ -437,6 +448,9 @@ export type EntryPageContentSlot = Readonly<{
     allowedBlocks: EntryPageContentSlotAllowedBlocks;
     blocks: readonly BlockListItem[];
 }>;
+export type PageSurfaceContentSlot = EntryPageContentSlot & Readonly<{
+    compositionHash: string;
+}>;
 export type EntryPageContentSlotWarning = Readonly<{
     kind: 'orphaned-slot-hidden';
     slotKey: string;
@@ -446,6 +460,10 @@ export type EntryPageContentSlotsResponse = Readonly<{
     slots: readonly EntryPageContentSlot[];
     warnings: readonly EntryPageContentSlotWarning[];
 }>;
+export type PageSurfaceContentSlotsResponse = Readonly<{
+    slots: readonly PageSurfaceContentSlot[];
+    warnings: readonly EntryPageContentSlotWarning[];
+}>;
 export type PublishedBlockBaseline = {
     id: string;
     kind: string;
@@ -676,7 +694,7 @@ export type SdkRuntimePageSurfaceContentSource = Readonly<{
 export type SdkRuntimePageSurface = {
     id: string;
     routeId: string;
-    readinessState: 'shippable';
+    readinessState: 'internal_pilot' | 'shippable';
     subject: SdkRuntimePageSurfaceSubject;
     title: string;
     slug: string | null;

package/dist/_dts/api/src/endpoints.d.ts

@@ -1711,6 +1711,30 @@ export declare const API_ENDPOINTS: {
         readonly auth: "user";
         readonly responseKind: "json";
     };
+    readonly updatePageSurfaceDraftContent: {
+        readonly path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/content";
+        readonly method: "PUT";
+        readonly errors: readonly ["validation:invalid_input", "resource:not_found", "resource:conflict", "server:internal_error"];
+        readonly tags: ["riverbank:site", "riverbank:page-surface:{pageSurfaceId}"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+    };
+    readonly discardPageSurfaceDraftContent: {
+        readonly path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/content/draft";
+        readonly method: "DELETE";
+        readonly errors: readonly ["validation:invalid_input", "resource:not_found", "resource:conflict", "server:internal_error"];
+        readonly tags: ["riverbank:site", "riverbank:page-surface:{pageSurfaceId}"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+    };
+    readonly updatePageSurfaceRouteMetadata: {
+        readonly path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/metadata";
+        readonly method: "PATCH";
+        readonly errors: readonly ["validation:invalid_input", "resource:not_found", "resource:conflict", "server:internal_error"];
+        readonly tags: ["riverbank:site", "riverbank:site:{siteId}:routable-content", "riverbank:page-surface:{pageSurfaceId}"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+    };
     readonly runSdkWorkflow: {
         readonly path: "/sites/{siteId}/content/{type}/{entryId}/workflows/{workflowId}/run";
         readonly method: "POST";
@@ -2011,6 +2035,42 @@ export declare const API_ENDPOINTS: {
         readonly errors: readonly [];
         readonly responseKind: "json";
     };
+    readonly getFooterComposition: {
+        readonly path: "/sites/{siteId}/settings/footer-composition";
+        readonly method: "GET";
+        readonly revalidate: 120;
+        readonly tags: ["riverbank:site:{siteId}", "riverbank:site:{siteId}:settings"];
+        readonly auth: "user";
+        readonly errors: readonly ["resource:not_found", "server:internal_error"];
+        readonly responseKind: "json";
+    };
+    readonly updateFooterComposition: {
+        readonly path: "/sites/{siteId}/settings/footer-composition";
+        readonly method: "POST";
+        readonly tags: ["riverbank:site:{siteId}", "riverbank:site:{siteId}:settings"];
+        readonly auth: "user";
+        readonly demoMutation: import("./apiEndpointTypes").ApiDemoMutationPolicy;
+        readonly errors: readonly ["validation:invalid_input", "resource:not_found", "server:internal_error"];
+        readonly responseKind: "json";
+    };
+    readonly getPublicProfile: {
+        readonly path: "/sites/{siteId}/settings/public-profile";
+        readonly method: "GET";
+        readonly revalidate: 120;
+        readonly tags: ["riverbank:site:{siteId}", "riverbank:site:{siteId}:settings"];
+        readonly auth: "user";
+        readonly errors: readonly ["resource:not_found", "server:internal_error"];
+        readonly responseKind: "json";
+    };
+    readonly updatePublicProfile: {
+        readonly path: "/sites/{siteId}/settings/public-profile";
+        readonly method: "POST";
+        readonly tags: ["riverbank:site:{siteId}", "riverbank:site:{siteId}:settings"];
+        readonly auth: "user";
+        readonly demoMutation: import("./apiEndpointTypes").ApiDemoMutationPolicy;
+        readonly errors: readonly ["validation:invalid_input", "resource:not_found", "server:internal_error"];
+        readonly responseKind: "json";
+    };
     readonly updateSiteLayoutSettings: {
         readonly path: "/sites/{siteId}/settings/layout";
         readonly method: "POST";
@@ -2907,6 +2967,38 @@ export declare const API_ENDPOINTS: {
         readonly responseKind: "json";
         readonly errors: readonly ["resource:not_found"];
     };
+    readonly listPageSurfaceContentSlots: {
+        readonly path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots";
+        readonly method: "GET";
+        readonly tags: ["riverbank:site", "riverbank:page-surface:{pageSurfaceId}", "surface-slots", "blocks"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+        readonly errors: readonly ["resource:not_found", "resource:conflict", "server:internal_error"];
+    };
+    readonly createPageSurfaceSlotBlock: {
+        readonly path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots/{slotKey}/blocks";
+        readonly method: "POST";
+        readonly tags: ["riverbank:site", "riverbank:page-surface:{pageSurfaceId}", "surface-slot-{slotKey}", "blocks"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+        readonly errors: readonly ["validation:invalid_input", "resource:not_found", "resource:conflict", "server:internal_error"];
+    };
+    readonly reorderPageSurfaceSlotBlocks: {
+        readonly path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots/{slotKey}/blocks/reorder";
+        readonly method: "POST";
+        readonly tags: ["riverbank:site", "riverbank:page-surface:{pageSurfaceId}", "surface-slot-{slotKey}", "blocks"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+        readonly errors: readonly ["validation:invalid_input", "resource:not_found", "resource:conflict", "server:internal_error"];
+    };
+    readonly deletePageSurfaceSlotBlock: {
+        readonly path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots/{slotKey}/blocks/{blockId}";
+        readonly method: "DELETE";
+        readonly tags: ["riverbank:site", "riverbank:page-surface:{pageSurfaceId}", "surface-slot-{slotKey}", "blocks"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+        readonly errors: readonly ["resource:not_found", "resource:conflict", "server:internal_error"];
+    };
     readonly createBlock: {
         readonly path: "/sites/{siteId}/pages/{pageId}/blocks";
         readonly method: "POST";
@@ -5043,6 +5135,13 @@ export declare const API_ENDPOINTS: {
         readonly auth: "service";
         readonly responseKind: "json";
     };
+    readonly sdkPatchPageBlock: {
+        readonly path: "/sdk/{siteId}/pages/{identifier}/blocks/{blockIdentifier}";
+        readonly method: "PATCH";
+        readonly errors: readonly ["validation:invalid_input", "resource:not_found", "resource:conflict", "billing:plan_limit_exceeded", "server:internal_error"];
+        readonly auth: "service";
+        readonly responseKind: "json";
+    };
     readonly sdkReorderPageBlocks: {
         readonly path: "/sdk/{siteId}/pages/{identifier}/blocks/reorder";
         readonly method: "POST";

package/dist/_dts/api/src/footer-settings.d.ts

@@ -0,0 +1 @@
+export * from './footerSettings';

package/dist/_dts/api/src/footerSettings.d.ts

@@ -0,0 +1,8 @@
+import type { SiteId } from "../../core/src/index";
+import type { FooterCompositionSnapshot, FooterCompositionUpdateRequest, FooterCompositionUpdateResponse, PublicProfileSnapshot, PublicProfileUpdateRequest, PublicProfileUpdateResponse } from "./siteManagementEndpoints";
+import type { ApiClient } from "./request";
+export type { FooterCompositionSnapshot, FooterCompositionUpdateRequest, FooterCompositionUpdateResponse, PublicProfileSnapshot, PublicProfileUpdateRequest, PublicProfileUpdateResponse, } from "./siteManagementEndpoints";
+export declare function getFooterComposition(apiClient: ApiClient, siteId: SiteId): Promise<FooterCompositionSnapshot>;
+export declare function updateFooterComposition(apiClient: ApiClient, siteId: SiteId, body: FooterCompositionUpdateRequest): Promise<FooterCompositionUpdateResponse>;
+export declare function getPublicProfile(apiClient: ApiClient, siteId: SiteId): Promise<PublicProfileSnapshot>;
+export declare function updatePublicProfile(apiClient: ApiClient, siteId: SiteId, body: PublicProfileUpdateRequest): Promise<PublicProfileUpdateResponse>;

package/dist/_dts/api/src/index.d.ts

@@ -1,4 +1,7 @@
 export { API_ENDPOINTS, buildEndpointURL } from './endpoints';
+export { PREVIEW_CONTENT_CONTRACT_HEADER, PREVIEW_CONTENT_CONTRACT_PARAM, parsePreviewContentContract, type PreviewContentContract, } from './previewContentContract';
+export { getFooterComposition, getPublicProfile, updateFooterComposition, updatePublicProfile, } from './footerSettings';
+export type { FooterCompositionSnapshot, FooterCompositionUpdateRequest, FooterCompositionUpdateResponse, PublicProfileSnapshot, PublicProfileUpdateRequest, PublicProfileUpdateResponse, } from './siteManagementEndpoints';
 export { classifyDemoDashboardMutationDescriptor, classifyDemoDashboardMutationEndpoint, summarizeDemoDashboardMutationSurfaces, } from './demoDashboardMutationSurfaces';
 export type { DemoDashboardMutationEndpointDescriptor, DemoDashboardMutationSurface, DemoDashboardMutationSurfaceSummary, } from './demoDashboardMutationSurfaces';
 export { managedDomainAddOnPricingSnapshotSchema } from './accessAdmin';
@@ -53,7 +56,7 @@ export type { PublicProductCategorySelector, PublicProductCategorySelectorQuery,
 export { publishContentEntry, discardContentDraft, deleteContentEntry, createContentEntry, updateContentEntryContent, mutateContentEntryUnified, listPublishedEntries, } from './contentEntries';
 export { getContentEntryVersion, getPageVersion, listContentEntryVersions, listPageVersions, restoreContentEntryVersion, restorePageVersion, } from './contentVersionHistoryClient';
 export type { DraftVersionPrecondition, GetVersionHistoryResponse, ListVersionHistoryResponse, RestoreVersionHistoryRequest, RestoreVersionHistoryResponse, VersionHistoryDetail, VersionHistoryItem, VersionHistoryListQuery, VersionHistoryOwnerKind, VersionHistoryWarning, } from './contentVersionHistory';
-export { mutateBlockContent, createBlock, createEntrySlotBlock, reorderBlocks, reorderEntrySlotBlocks, deleteBlock, deleteEntrySlotBlock, listBlocks, listEntryPageContentSlots, listEntrySlotBlocks, } from './blocks';
+export { mutateBlockContent, createBlock, createEntrySlotBlock, createPageSurfaceSlotBlock, reorderBlocks, reorderEntrySlotBlocks, reorderPageSurfaceSlotBlocks, deleteBlock, deleteEntrySlotBlock, deletePageSurfaceSlotBlock, listBlocks, listEntryPageContentSlots, listPageSurfaceContentSlots, listEntrySlotBlocks, } from './blocks';
 export { blocksKeys } from './blocksKeys';
 export { contentKeys } from './contentKeys';
 export { createPage, deletePage, publishPageDraft, discardPageDraft, getPageDesignEditorState, savePageDesignState, applyPageDesignEditorAction, } from './pages';
@@ -121,4 +124,4 @@ export type { AIChatMessage, AiBriefTurn, AiDesignerThemePatchOp, AiPatchApplyRe
 export type { CancelFlexibleBalanceBookingDueToNonPaymentRequest, FlexibleBalanceAdminActionPlan, FlexibleBalanceAdminActionResponse, FlexibleBalanceAdminActionSource, FlexibleBalanceAdminActionView, ReopenFlexibleBalanceBookingAfterNonPaymentCancellationRequest, } from './types';
 export type { CancelShopOrderItemRequest, CancelShopOrderItemResponse, CancelShopOrderRequest, CancelShopOrderResponse, StaffCancellationContextCategory, StaffCancellationContextInput, StaffCancellationContextUiCategory, } from './siteOperations';
 export type { ContentTypeKey } from './contentEntries';
-export type { BlockListItem, EntryPageContentSlot, EntryPageContentSlotAllowedBlocks, EntryPageContentSlotWarning, EntryPageContentSlotsResponse, SdkEntrySlotContent, SdkRuntimePageSurfaceSubject, SiteBookingOfferingPresetSummary, WorkflowContentEntryTargetSnapshot, WorkflowPageDraftContent, WorkflowPagePublishedContent, WorkflowPageStatus, WorkflowPageTargetSnapshot, WorkflowRunStatusResponse, WorkflowTargetEntrySnapshot, } from './contentRuntime';
+export type { BlockListItem, EntryPageContentSlot, EntryPageContentSlotAllowedBlocks, EntryPageContentSlotWarning, EntryPageContentSlotsResponse, PageSurfaceContentSlot, PageSurfaceContentSlotsResponse, PageSurfaceEditorDocument, SdkEntrySlotContent, SdkRuntimeContentByPathResponse, SdkRuntimePageSurface, SdkRuntimePageSurfaceResponse, SdkRuntimePageSurfaceSubject, SdkSurfaceSlotContent, SiteBookingOfferingPresetSummary, WorkflowContentEntryTargetSnapshot, WorkflowPageDraftContent, WorkflowPagePublishedContent, WorkflowPageStatus, WorkflowPageTargetSnapshot, WorkflowRunStatusResponse, WorkflowTargetEntrySnapshot, } from './contentRuntime';

package/dist/_dts/api/src/navigation/contracts.d.ts

@@ -39,8 +39,8 @@ export declare const internalLinkPayloadSchema: z.ZodObject<{
     routeId: z.ZodString;
     entityId: z.ZodString;
     entityType: z.ZodEnum<{
-        page: "page";
         content: "content";
+        page: "page";
     }>;
     href: z.ZodString;
     title: z.ZodString;
@@ -71,8 +71,8 @@ export declare const linkPayloadSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     routeId: z.ZodString;
     entityId: z.ZodString;
     entityType: z.ZodEnum<{
-        page: "page";
         content: "content";
+        page: "page";
     }>;
     href: z.ZodString;
     title: z.ZodString;
@@ -184,8 +184,8 @@ export declare const dashboardNavigationLinkSchema: z.ZodDiscriminatedUnion<[z.Z
     routeId: z.ZodString;
     entityId: z.ZodString;
     entityType: z.ZodEnum<{
-        page: "page";
         content: "content";
+        page: "page";
     }>;
     href: z.ZodString;
     title: z.ZodString;

package/dist/_dts/api/src/previewContentContract.d.ts

@@ -0,0 +1,4 @@
+export declare const PREVIEW_CONTENT_CONTRACT_PARAM: "__riverbank_content_contract";
+export declare const PREVIEW_CONTENT_CONTRACT_HEADER: "x-riverbank-preview-content-contract";
+export type PreviewContentContract = 'compat' | 'native';
+export declare function parsePreviewContentContract(value: unknown): PreviewContentContract | null;

package/dist/_dts/api/src/sdkContracts.d.ts

@@ -1,5 +1,6 @@
 import type { FieldDefinition, FieldDefinitionInput, SdkCustomBlock, SdkCustomBlockInput, SiteFooterContent, Theme } from '../../blocks/src/index';
 import type { LinkPayload } from './navigation/types';
+import type { JsonValue } from './shared-contracts';
 import type { SdkEventPricing, SdkEventPricingInput } from './sdk-event-pricing';
 import type { SdkEventPaymentTerms, SdkEventPaymentTermsInput } from './sdk-event-payment-terms';
 /**
@@ -368,6 +369,65 @@ export interface SdkGetPageBlock {
 export interface SdkGetPageBlockResponse {
     block: SdkGetPageBlock;
 }
+/**
+ * A single PATCH operation against a block's draft content.
+ *
+ * Discriminated on `op`. Only `set` exists today; additional operations
+ * (e.g. `unset`) extend this union without breaking existing callers.
+ *
+ * `path` must resolve to a manifest-defined field of the block (dot/bracket
+ * syntax, e.g. `title`, `items[0].label`, `cta.label`). Paths that do not
+ * resolve to a manifest field — including prototype-chain segments such as
+ * `__proto__` — are rejected with a 400 naming the offending operation index.
+ *
+ * Numeric repeater indices must address an EXISTING item (strictly below the
+ * current array length). To append or resize, `set` the whole repeater field.
+ */
+export type SdkPatchPageBlockOperation = Readonly<{
+    op: 'set';
+    path: string;
+    value: JsonValue;
+}>;
+/**
+ * Body for `PATCH pages/{identifier}/blocks/{blockIdentifier}`.
+ *
+ * Operations apply atomically to an in-memory copy of the block's draft
+ * data; the result is validated once against the block manifest, then
+ * persisted in a single guarded draft write (published rows are untouched —
+ * publish remains page-boundary). Any invalid operation aborts the whole
+ * request.
+ *
+ * `baseContentHash` is required and must equal the `contentHash` returned by
+ * the block GET. On mismatch (including a concurrent write landing between
+ * read and write) the endpoint returns 409 carrying
+ * `SdkPatchPageBlockStaleContentFieldError` in `fieldErrors`.
+ */
+export interface SdkPatchPageBlockBody {
+    operations: readonly SdkPatchPageBlockOperation[];
+    baseContentHash: string;
+}
+export declare const SDK_PATCH_STALE_CONTENT_FIELD = "baseContentHash";
+export declare const SDK_PATCH_STALE_CONTENT_CODE = "STALE_CONTENT";
+/**
+ * Typed stale-conflict detail for block PATCH 409 responses, transported in
+ * the standard envelope's `fieldErrors`. `message` is EXACTLY the current
+ * draft content hash (no prose) — echo it back as `baseContentHash` to
+ * retry. The SDK client surfaces this as a discriminated
+ * `BlockPatchStaleContentError` so callers never string-sniff.
+ */
+export interface SdkPatchPageBlockStaleContentFieldError {
+    field: typeof SDK_PATCH_STALE_CONTENT_FIELD;
+    code: typeof SDK_PATCH_STALE_CONTENT_CODE;
+    /** Exactly the current draft content hash. */
+    message: string;
+}
+/**
+ * Success response mirrors the block GET shape; `block.contentHash` is the
+ * NEW draft content hash (use it as `baseContentHash` for the next patch).
+ */
+export interface SdkPatchPageBlockResponse {
+    block: SdkGetPageBlock;
+}
 export interface SdkPullNavigationItem {
     id: string;
     menuId: string;
@@ -387,6 +447,7 @@ export interface SdkPullNavigationMenu {
     name: string;
     isPrimary: boolean;
     isFooter: boolean;
+    footerRole: 'main' | 'legal-policy' | null;
     items: SdkPullNavigationItem[];
     createdAt: string;
     updatedAt: string;
@@ -882,6 +943,7 @@ export interface SdkUpsertNavigationMenuResponse {
         name: string;
         isPrimary: boolean;
         isFooter: boolean;
+        footerRole: 'main' | 'legal-policy' | null;
         items: SdkPullNavigationItem[];
         createdAt: string;
         updatedAt: string;

package/dist/_dts/api/src/siteBanner.d.ts

@@ -89,8 +89,8 @@ export declare const siteBannerSettingsSchema: z.ZodDiscriminatedUnion<[z.ZodObj
             routeId: z.ZodString;
             entityId: z.ZodString;
             entityType: z.ZodEnum<{
-                page: "page";
                 content: "content";
+                page: "page";
             }>;
             href: z.ZodString;
             title: z.ZodString;
@@ -155,8 +155,8 @@ export declare const siteBannerSettingsInputSchema: z.ZodDiscriminatedUnion<[z.Z
             routeId: z.ZodString;
             entityId: z.ZodString;
             entityType: z.ZodEnum<{
-                page: "page";
                 content: "content";
+                page: "page";
             }>;
             href: z.ZodString;
             title: z.ZodString;