@riverbankcms/sdk 0.138.0 → 0.140.0

package/dist/_dts/api/src/publicExperience/sharedTypes.d.ts

@@ -4,6 +4,9 @@
  * Re-exported from `../publicExperienceEndpoints`, which stays the public import site.
  */
 import type { AutoAppliedDiscountPreview } from '../bookingRecords';
+import type { MailingListSignupSourceRef, MailingListVisitorSelection } from '../../../core/src/index';
+import type { PublicEventLoaderParams } from '../../../blocks/src/system/blocks/events/shared/types';
+export type { MailingListSignupSourceRef } from '../../../core/src/index';
 export declare const PUBLIC_EVENT_TICKET_SELECTION_CONTRACT_VERSION: "public-event-ticket-selection.v2";
 export type EventTicketSelectionRequest = {
     pricingOptionId?: string | null;
@@ -19,66 +22,23 @@ export type EventTicketLineSummaryResponse = {
     currency: string;
 };
 export type { PublicEventPriceDisplay, PublicEventPricing, } from '../../../core/src/index';
-/** Query parameters accepted by the public event list loaders. */
-export type PublicEventLoaderParams = {
-    limit?: string;
-    from?: string;
-    to?: string;
-    afterStartsAt?: string;
-    afterId?: string;
-    categoryIds?: string;
-    venueId?: string;
-    staffMemberId?: string;
-    eventSurface?: string;
-    eventPresets?: string;
-    scheduleScope?: string;
-    seriesId?: string;
-    seriesIds?: string;
-    runSeriesId?: string;
-    seriesSlug?: string;
-    includeOccurrenceId?: string;
-    /**
-     * What the read is asking for: `'occurrences'` (default) for a page of dates,
-     * or `'runs'` for one row per whole-series run regardless of date.
-     */
-    readIntent?: string;
-    detailLevel?: string;
-    readProfile?: string;
-};
-export type NewsletterSignupPublicDestinationRef = {
-    tag: 'block_ref';
-    blockId: string;
-} | {
-    tag: 'signed_destination_ref';
-    token: string;
-};
-export type NewsletterSubscribeTarget = {
-    tag: 'legacy_riverbank_list';
-    listId: string;
-    destinationRef?: NewsletterSignupPublicDestinationRef;
-} | {
-    tag: 'published_block_ref';
-    destinationRef: NewsletterSignupPublicDestinationRef;
-};
-type NewsletterSubscribeFields = {
+/** Query parameters accepted by the public Event list loaders. */
+export type { PublicEventLoaderParams } from '../../../blocks/src/system/blocks/events/shared/types';
+export type NewsletterSubscribeBody = {
     email: string;
     firstName?: string | null;
     lastName?: string | null;
     name?: string | null;
     company?: string | null;
     phone?: string | null;
-    tags?: string[];
+    sourceRef: MailingListSignupSourceRef;
+    setupRevision: number;
+    visitorSelection?: MailingListVisitorSelection;
     meta?: {
         honeypot?: string;
         altchaSolution?: string | null;
     };
 };
-export type NewsletterSubscribeBody = NewsletterSubscribeFields & ({
-    target: NewsletterSubscribeTarget;
-} | {
-    listId: string;
-    destinationRef?: NewsletterSignupPublicDestinationRef;
-});
 export type PublicEventScheduleScope = 'any' | 'recurring' | 'oneOff';
 export type PublicEventRecurrence = Readonly<{
     kind: 'weekly';

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

@@ -0,0 +1,65 @@
+/**
+ * The anonymous onboarding attempt, addressed by its opaque resume token.
+ *
+ * Every route here is reached before there is an account, so none of them can
+ * be scoped to a site or a user: the token is the whole credential. They are
+ * kept together so that stays obvious.
+ */
+export declare const PUBLIC_ONBOARDING_ATTEMPT_ENDPOINT_DEFINITIONS: {
+    createPublicOnboardingAttempt: {
+        path: "/public/onboarding/attempts";
+        method: "POST";
+        auth: "public";
+        errors: never[];
+        responseKind: "json";
+    };
+    createPublicOnboardingLogoUploadUrl: {
+        path: "/public/onboarding/attempts/{attemptToken}/logo-upload-url";
+        method: "POST";
+        auth: "public";
+        errors: never[];
+        responseKind: "json";
+    };
+    uploadPublicOnboardingLogo: {
+        path: "/public/onboarding/attempts/{attemptToken}/logo";
+        method: "POST";
+        auth: "public";
+        errors: never[];
+        responseKind: "json";
+    };
+    getPublicOnboardingAttempt: {
+        path: "/public/onboarding/attempts/{attemptToken}";
+        method: "GET";
+        auth: "public";
+        errors: never[];
+        responseKind: "json";
+    };
+    getPublicOnboardingAttemptProgress: {
+        path: "/public/onboarding/attempts/{attemptToken}/status";
+        method: "GET";
+        auth: "public";
+        errors: never[];
+        responseKind: "json";
+    };
+    updatePublicOnboardingAttempt: {
+        path: "/public/onboarding/attempts/{attemptToken}";
+        method: "PATCH";
+        auth: "public";
+        errors: never[];
+        responseKind: "json";
+    };
+    runPublicOnboardingAttempt: {
+        path: "/public/onboarding/attempts/{attemptToken}/run";
+        method: "POST";
+        auth: "public";
+        errors: never[];
+        responseKind: "json";
+    };
+    resendPublicOnboardingAttemptConfirmation: {
+        path: "/public/onboarding/attempts/{attemptToken}/resend-confirmation";
+        method: "POST";
+        auth: "public";
+        errors: never[];
+        responseKind: "json";
+    };
+};

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

@@ -0,0 +1,73 @@
+/**
+ * Direct public reads governed by the canonical public-read freshness policy.
+ * Keeping these definitions together makes the endpoint identity used to
+ * derive freshness reviewable beside its route and tags.
+ */
+export declare const PUBLIC_READ_ENDPOINT_DEFINITIONS: {
+    getPublishedEntryPreview: {
+        path: "/public/content/{siteId}/{type}/{slug}/preview";
+        method: "GET";
+        revalidate: number;
+        tags: "content-{siteId}-{type}-{slug}"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublishedEntries: {
+        path: "/public/content/{siteId}/{type}/entries";
+        method: "GET";
+        revalidate: number;
+        tags: "content-{siteId}-{type}"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    getPublicFormById: {
+        path: "/public/forms/{formId}";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:form:{formId}"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicEvents: {
+        path: "/public/sites/{siteId}/events";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-events"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicTeamMembers: {
+        path: "/public/sites/{siteId}/team-members";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-team-members"[];
+        errors: never[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicPasses: {
+        path: "/public/sites/{siteId}/bookings/products/passes";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-passes"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicMemberships: {
+        path: "/public/sites/{siteId}/bookings/products/memberships";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-memberships"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicProducts: {
+        path: "/public/sites/{siteId}/products";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-products"[];
+        errors: never[];
+        auth: "public";
+        responseKind: "json";
+    };
+};

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

@@ -0,0 +1,20 @@
+/**
+ * Endpoints whose success status does not mean the write happened.
+ *
+ * A revision-guarded write answers a lost race with 200 and a response that
+ * says so, because the client needs the authoritative document back in order
+ * to recover. That is a sound contract, but it means HTTP status is no longer
+ * the whole story: save plumbing that reads 2xx as "saved" will tell someone
+ * their changes are stored when they were rejected.
+ *
+ * Listing an endpoint here makes that impossible to overlook. Save helpers
+ * require callers of these endpoints to say how to read the outcome, and
+ * forbid the question everywhere else, so the answer cannot drift away from
+ * the contract.
+ *
+ * Add an endpoint here in the same change that gives its response a
+ * non-writing variant.
+ */
+export type SaveOutcomeBearingEndpoint = 'updatePublicProfile' | 'updateFooterComposition';
+/** Whether a completed request actually wrote what the caller sent. */
+export type SaveOutcome = 'saved' | 'not-saved';

package/dist/_dts/api/src/schemas/site-api-keys.d.ts

@@ -53,8 +53,8 @@ export declare const sitePreviewKeyParamsSchema: z.ZodObject<{
 export declare const createSiteApiKeyBodySchema: z.ZodObject<{
     name: z.ZodString;
     environment: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        test: "test";
         live: "live";
+        test: "test";
     }>>>;
 }, z.core.$strip>;
 /** What a client sends: `environment` may be omitted. */

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

@@ -1,6 +1,6 @@
 import type { BlockContentSource, BlockContentSourceKind, FieldDefinition, FieldDefinitionInput, SdkCustomBlock, SdkCustomBlockInput, Theme } from '../../blocks/src/index';
 import type { ContentTypeSchema } from '../../content-model/src/index';
-import type { FooterCompositionV1, RichTextDoc } from '../../core/src/index';
+import type { EventPreset, FooterCompositionV1, RichTextDoc } from '../../core/src/index';
 export type { SdkBlockAppearanceChoice, SdkBlockAppearanceOutcome, } from './sdkBlockUpsertContracts';
 import type { LinkPayload } from './navigation/types';
 import type { JsonValue } from './shared-contracts';
@@ -9,7 +9,6 @@ import type { ManagementMediaAsset } from './sdkMediaContracts';
 export type { ManagementMediaAsset, SdkMediaDeleteApplyResponse, SdkMediaDeletePreviewResponse, SdkMediaDownloadResponse, SdkMediaListResponse, } from './sdkMediaContracts';
 import type { SdkPullEventOccurrence } from './sdk-event-schedule';
 import type { SiteCommandApplicationResult } from '@riverbankcms/site-commands';
-import type { EventPreset } from '../../core/src/index';
 import type { SdkThemeWire } from './sdkThemeWire';
 import type { SdkCatalogButtonStyleControl } from './sdkThemeCatalogContracts';
 export type { SdkCatalogButtonRole, SdkCatalogButtonStyleControl, } from './sdkThemeCatalogContracts';
@@ -201,11 +200,7 @@ export interface RiverbankSiteConfigInput extends Omit<RiverbankSiteConfig, 'cus
     customBlocks?: SdkCustomBlockInput[];
     blockFieldExtensions?: SdkBlockFieldExtensionsInputMap;
 }
-export type PushSdkConfigRequest = {
-    config: RiverbankSiteConfigInput;
-    forceContentTypes?: boolean;
-    mode?: 'apply' | 'preview';
-};
+export type { PushSdkConfigRequest } from './sdkPushContracts';
 export type SyncCollectionResult = {
     created: number;
     updated: number;
@@ -243,21 +238,7 @@ export type SdkConfigSyncResult = {
     footerBlocks: SyncFooterBlocksResult;
     ignoredDocumentSections: IgnoredDocumentSyncSection[];
 };
-export type PushSdkConfigResponse = {
-    success: true;
-    mode: 'apply' | 'preview';
-    message: string;
-    /**
-     * Legacy all-content-shaped sync payload retained for published CLIs that
-     * still read document sync buckets such as `sync.pages.errors`.
-     */
-    sync: SdkContentSyncResult | null;
-    /**
-     * Schema/config-only push-config result. New clients should prefer this over
-     * `sync` so document sections stay unrepresentable in the active contract.
-     */
-    configSync: SdkConfigSyncResult | null;
-};
+export type { PushSdkConfigResponse } from './sdkPushContracts';
 export interface SdkBackfillPageResult {
     pagesUpdated: number;
     identifiersAssigned: Record<string, string>;
@@ -469,11 +450,7 @@ export interface SdkPullNavigationItem {
 export interface SdkPullNavigationMenu {
     id: string;
     siteId: string;
-    identifier: string | null;
-    name: string;
-    isPrimary: boolean;
-    isFooter: boolean;
-    footerRole: 'main' | 'legal-policy' | null;
+    location: 'main' | 'footer' | 'legal';
     items: SdkPullNavigationItem[];
     createdAt: string;
     updatedAt: string;
@@ -1146,11 +1123,7 @@ export interface SdkEventOccurrenceResponse {
 }
 export type SdkUpsertNavigationMenuResponse = SdkCommandApplicationResult<{
     id: string;
-    identifier: string | null;
-    name: string;
-    isPrimary: boolean;
-    isFooter: boolean;
-    footerRole: 'main' | 'legal-policy' | null;
+    location: 'main' | 'footer' | 'legal';
     items: SdkPullNavigationItem[];
     createdAt: string;
     updatedAt: string;

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

@@ -0,0 +1,18 @@
+import type { MailingListProviderScope } from '../../core/src/index';
+import type { RiverbankSiteConfigInput, SdkConfigSyncResult, SdkContentSyncResult } from './sdkContracts';
+export type PushSdkConfigRequest = {
+    config: RiverbankSiteConfigInput;
+    forceContentTypes?: boolean;
+    mode?: 'apply' | 'preview';
+    expectedMailingListProviderScope?: MailingListProviderScope;
+};
+export type PushSdkConfigResponse = {
+    success: true;
+    mode: 'apply' | 'preview';
+    message: string;
+    /** Legacy document-sync result read by already-published CLI versions. */
+    sync: SdkContentSyncResult | null;
+    /** Canonical schema/config-only result for current clients. */
+    configSync: SdkConfigSyncResult | null;
+    mailingListProviderScope: MailingListProviderScope | null;
+};