@riverbankcms/sdk 0.146.0 → 0.148.0

package/dist/_dts/core/src/demo-lifecycle-status.d.ts

@@ -1,10 +1,10 @@
 export declare const demoBlueprintStatusValues: readonly ["draft", "published", "archived"];
 export type DemoBlueprintStatus = (typeof demoBlueprintStatusValues)[number];
-export declare const demoInstanceStatusValues: readonly ["warming", "available", "claimed", "expired", "recycling", "failed"];
+export declare const demoInstanceStatusValues: readonly ["warming", "available", "claimed", "expired", "showcase", "failed"];
 export type DemoInstanceStatus = (typeof demoInstanceStatusValues)[number];
 export declare const demoClaimStatusValues: readonly ["active", "expired", "released"];
 export type DemoClaimStatus = (typeof demoClaimStatusValues)[number];
-export declare const demoBlueprintArtifactKindValues: readonly ["site_backup", "manual_snapshot"];
+export declare const demoBlueprintArtifactKindValues: readonly ["recipe"];
 export type DemoBlueprintArtifactKind = (typeof demoBlueprintArtifactKindValues)[number];
 export declare function narrowDemoInstanceStatus(value: string): DemoInstanceStatus;
 export declare function narrowDemoClaimStatus(value: string): DemoClaimStatus;

package/dist/_dts/core/src/demo-warm-pool-target.d.ts

@@ -0,0 +1,8 @@
+import { type Result } from './result';
+export declare const DEFAULT_DEMO_WARM_POOL_TARGET = 0;
+export declare const MAX_DEMO_WARM_POOL_TARGET = 20;
+export type DemoWarmPoolTargetError = Readonly<{
+    kind: 'invalid_demo_warm_pool_target';
+    message: 'DEMO_WARM_POOL_TARGET must be a whole number from 0 to 20.';
+}>;
+export declare function parseDemoWarmPoolTarget(value: string | null | undefined): Result<number, DemoWarmPoolTargetError>;

package/dist/_dts/core/src/edit-lease.d.ts

@@ -0,0 +1,55 @@
+import type { ContentEntryId, EditLeaseToken, EditorClientId, PageId, PageSurfaceId } from './branded';
+export type EditLeaseScope = Readonly<{
+    nodeType: 'page';
+    nodeId: PageId;
+}> | Readonly<{
+    nodeType: 'content_entry';
+    nodeId: ContentEntryId;
+}> | Readonly<{
+    nodeType: 'page_surface';
+    nodeId: PageSurfaceId;
+}>;
+export type EditLeaseHolder = Readonly<{
+    kind: 'your-other-tab';
+}> | Readonly<{
+    kind: 'another-user';
+    name: string | null;
+}>;
+export type EditLeaseView = Readonly<{
+    kind: 'free';
+}> | Readonly<{
+    kind: 'mine';
+    expiresAt: string;
+}> | Readonly<{
+    kind: 'held-elsewhere';
+    holder: EditLeaseHolder;
+    expiresAt: string;
+}>;
+export type EditLeaseAcquireResult = Readonly<{
+    kind: 'granted';
+    token: EditLeaseToken;
+    expiresAt: string;
+}> | Extract<EditLeaseView, {
+    kind: 'held-elsewhere';
+}>;
+export type EditAuthority = Readonly<{
+    kind: 'edit-lease';
+    token: EditLeaseToken;
+    clientId: EditorClientId;
+}> | Readonly<{
+    kind: 'exempt';
+    reason: 'team-member-profile' | 'sdk';
+}>;
+export type OwnerEditAuthority = EditAuthority | Readonly<{
+    kind: 'no-lease-headers';
+}>;
+export type EditLeaseTarget = Readonly<{
+    kind: 'leased';
+    scope: EditLeaseScope;
+}> | Readonly<{
+    kind: 'unleased';
+}>;
+export declare function parseEditLeaseScope(input: Readonly<{
+    nodeType: EditLeaseScope['nodeType'];
+    nodeId: string;
+}>): EditLeaseScope | null;

package/dist/_dts/core/src/editor-state.d.ts

@@ -1,5 +1,6 @@
+import type { EditorBlockVersions } from './block-content-identity';
 import type { Brand } from './branded';
-import type { BlockContentIdentity } from './block-content-identity';
+import type { ValueSync } from './editor-value-sync';
 export type EditorSiteId = Brand<string, 'EditorSiteId'>;
 export type EditorPageId = Brand<string, 'EditorPageId'>;
 export type EditorEntryId = Brand<string, 'EditorEntryId'>;
@@ -8,6 +9,31 @@ export declare const unsafeAsEditorSiteId: (value: string) => EditorSiteId;
 export declare const unsafeAsEditorPageId: (value: string) => EditorPageId;
 export declare const unsafeAsEditorEntryId: (value: string) => EditorEntryId;
 export declare const unsafeAsEditorBlockId: (value: string) => EditorBlockId;
+/** Identity of the ordered block collection currently mounted in the editor. */
+export type EditorBlockCollectionOwner = Readonly<{
+    kind: 'page';
+    pageId: string;
+}> | Readonly<{
+    kind: 'entry-slot';
+    type: string;
+    entryId: string;
+    slotKey: string;
+}> | Readonly<{
+    kind: 'surface-slot';
+    pageSurfaceId: string;
+    slotKey: string;
+}> | Readonly<{
+    kind: 'site-footer';
+    siteId: string;
+}>;
+/** Server membership facts for a loaded collection, independent of selected local edits. */
+export type EditorBlockCollectionReadBaseline = Readonly<{
+    owner: EditorBlockCollectionOwner;
+    currentBlockIds: readonly string[];
+    publishedBlockIds: readonly string[];
+}>;
+export declare function editorBlockCollectionOwnerKey(owner: EditorBlockCollectionOwner): string;
+export declare function editorBlockCollectionOwnersEqual(left: EditorBlockCollectionOwner | null, right: EditorBlockCollectionOwner | null): boolean;
 export type EditorValueRecord = Readonly<Record<string, unknown>>;
 export type EditorMetadataValues = Brand<EditorValueRecord, 'EditorMetadataValues'>;
 export type EditorContentValues = Brand<EditorValueRecord, 'EditorContentValues'>;
@@ -15,6 +41,7 @@ export type EditorBlockValues = Brand<EditorValueRecord, 'EditorBlockValues'>;
 export declare const unsafeAsEditorMetadataValues: (value: EditorValueRecord) => EditorMetadataValues;
 export declare const unsafeAsEditorContentValues: (value: EditorValueRecord) => EditorContentValues;
 export declare const unsafeAsEditorBlockValues: (value: EditorValueRecord) => EditorBlockValues;
+/** Presentation of a value's sync state, derived from its `ValueSync` (`syncStateOf`). */
 export type EditorSyncState = {
     kind: 'baseline';
 } | {
@@ -28,15 +55,12 @@ export type EditorStructuralDraftMeta = Readonly<{
     kind: string;
     purpose: string | null;
     orderIndex: number | null;
-    publishedContent: EditorBlockValues | null;
-    optimisticHash: string | null;
 }>;
+/** The baseline revision is the block's optimistic hash. */
 export type EditorStructuralDraftSnapshot = Readonly<{
     id: EditorBlockId;
     version: number;
-    baseline: EditorBlockValues | null;
-    current: EditorBlockValues | null;
-    syncState: EditorDraftSyncState;
+    sync: ValueSync<EditorBlockValues | null>;
     meta: EditorStructuralDraftMeta;
 }>;
 export type EditorBlockDataRowInput = Readonly<{
@@ -47,28 +71,29 @@ export type EditorDraftBlockInitMetaInput = Readonly<{
     kind: string;
     purpose?: string | null;
     orderIndex?: number | null;
-    publishedContent?: EditorBlockBaselineInput;
     optimisticHash?: string | null;
 }>;
 export type EditorDraftBlockBaselineUpdateMetaInput = Readonly<{
     kind?: string;
     purpose?: string | null;
     orderIndex?: number | null;
-    publishedContent?: EditorBlockBaselineInput;
     optimisticHash?: string | null;
 }>;
-export type EditorBlockPublishedBaselineInput = Readonly<{
+/** One block's server versions, as recorded into the editor's block-versions state. */
+export type EditorBlockVersionsEntry = Readonly<{
     id: EditorBlockId;
-    kind?: string;
-    publishedContent?: EditorBlockBaselineInput;
+    versions: EditorBlockVersions;
 }>;
-export type EditorPersistedBlock = BlockContentIdentity & Readonly<{
+/**
+ * A block as undo history records it. Server version identity is deliberately
+ * absent: it lives in the editor's block-versions state, outside history.
+ */
+export type EditorPersistedBlock = Readonly<{
     id: EditorBlockId;
     kind: string;
     content: EditorBlockValues | null;
     orderIndex: number | null;
     draftContent: EditorBlockValues | null;
-    publishedContent: EditorBlockValues | null;
     bindings: EditorBlockValues | null;
     purpose: string | null;
     optimisticHash: string | null;

package/dist/_dts/core/src/editor-value-sync.d.ts

@@ -0,0 +1,79 @@
+import type { Brand } from './branded';
+import type { EditorSyncState } from './editor-state';
+/**
+ * One editor value's sync state: the server baseline it was loaded from, and what the
+ * person intends locally. The request slot nests under local intent, so a pristine value
+ * can never hold a send in flight or a failure (issue 1553, D1).
+ *
+ * The transitions live in `@riverbankcms/content-editor`'s `sync/valueSync.ts`. The
+ * read-only selectors below live here because block-form and editor-blocks read them
+ * and can't depend on content-editor.
+ */
+/** Identifies one save request; a response for any other id is ignored. Allocated by the store. */
+export type SendId = Brand<number, 'SendId'>;
+export declare const unsafeAsSendId: (value: number) => SendId;
+/** The server's compare-and-set token for a baseline. Compared by equality only. */
+export type BaselineRevision = Readonly<{
+    kind: 'known';
+    value: string | null;
+}> | Readonly<{
+    kind: 'unknown';
+}>;
+export type ValueBaseline<V> = Readonly<{
+    values: V;
+    revision: BaselineRevision;
+}>;
+export type IdleRequest = Readonly<{
+    kind: 'idle';
+}>;
+export type InFlightRequest<V> = Readonly<{
+    kind: 'in-flight';
+    id: SendId;
+    sent: V;
+    basis: BaselineRevision;
+}>;
+export type FailedRequest<V> = Readonly<{
+    kind: 'failed';
+    id: SendId;
+    sent: V;
+    error: string;
+    reason: 'rejected' | 'conflict';
+}>;
+/** A request still outstanding whose edits the person discarded. It presents as saved. */
+export type AbandonedRequest = Readonly<{
+    kind: 'abandoned';
+    id: SendId;
+    basis: BaselineRevision;
+}>;
+export type PristineRequest = IdleRequest | AbandonedRequest;
+export type EditedRequest<V> = IdleRequest | InFlightRequest<V> | FailedRequest<V> | AbandonedRequest;
+export type LocalIntent<V> = Readonly<{
+    kind: 'pristine';
+    request: PristineRequest;
+}> | Readonly<{
+    kind: 'edited';
+    values: V;
+    request: EditedRequest<V>;
+}>;
+export type ValueSync<V> = Readonly<{
+    baseline: ValueBaseline<V>;
+    local: LocalIntent<V>;
+}>;
+/** Lease loss isn't an error: the edits stay unsaved and send again once the tab can write. */
+export type SaveFailure = Readonly<{
+    kind: 'rejected' | 'conflict';
+    message: string;
+}> | Readonly<{
+    kind: 'lease-lost';
+}>;
+export declare const UNKNOWN_REVISION: BaselineRevision;
+export declare function knownRevision(value: string | null): BaselineRevision;
+/** A pristine value at the given baseline. */
+export declare function pristineValueSync<V>(values: V, revision: BaselineRevision): ValueSync<V>;
+export type ValueStatus = 'saved' | 'unsaved' | 'saving' | 'failed';
+/** What the person sees: their edits, or the baseline when there are none. */
+export declare function displayedValues<V>(sync: ValueSync<V>): V;
+/** Pristine counts as saved even with an abandoned request: nothing the person wants is unsaved. */
+export declare function valueStatus<V>(sync: ValueSync<V>): ValueStatus;
+/** Projects the model onto the presentation sync state: unsaved and saving are both `pending`. */
+export declare function syncStateOf<V>(sync: ValueSync<V>): EditorSyncState;

package/dist/_dts/core/src/html-entities.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Decodes the HTML entities rendered pages commonly contain (the basic named
+ * set plus decimal and hex numeric references), leaving anything else as is.
+ * For reading text back out of server-rendered HTML, not for sanitising input.
+ */
+export declare function decodeHtmlEntities(text: string): string;

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

@@ -1,9 +1,11 @@
 export * from './branded';
 export * from './date-math';
+export * from './html-entities';
 export * from './duration';
 export * from './demo-capability-policy';
 export * from './demo-claim-access';
 export * from './demo-lifecycle-status';
+export * from './demo-warm-pool-target';
 export * from './demo-runtime';
 export * from './collections';
 export * from './event-booking-offer';
@@ -30,11 +32,12 @@ export { tryAsync } from './try-async';
 export * from './narrow-result';
 export * from './non-empty-array';
 export * from './editor-state';
+export * from './editor-value-sync';
+export * from './edit-lease';
 export * from './block-content-identity';
 export * from './sensitive-collection';
 export * from './assertNever';
 export * from './participants';
-export * from './participant-identity';
 export * from './public-url-validation';
 export * from './public-profile';
 export * from './public-experience';
@@ -76,5 +79,6 @@ export * from './public-read-cache-contract';
 export * from './booking-verticals';
 export * from './event-series-behaviour';
 export * from './navigation-locations';
+export * from './navigation-portal-labels';
 export * from './event-preset-vocabulary';
 export * from './event-catalogue';

package/dist/_dts/core/src/mailing-list-runtime.d.ts

@@ -6,6 +6,7 @@ export type MailingListRuntimeContext = Readonly<{
 }> | Readonly<{
     tag: 'configured';
     revision: MailingListSetupRevision;
+    bookingSignup: BookingSignupOffer;
     form: MailingListGlobalForm;
     provider: MailingListRuntimeProvider;
 }>;
@@ -40,3 +41,17 @@ export type MailingListRuntimeContextParseError = Readonly<{
     tag: 'invalid_mailing_list_runtime_context';
 }>;
 export declare function parseMailingListRuntimeContext(value: unknown): Result<MailingListRuntimeContext, MailingListRuntimeContextParseError>;
+export type BookingSignupOffer = Readonly<{
+    tag: 'offered';
+}> | Readonly<{
+    tag: 'unavailable';
+    reason: 'disabled' | 'fields' | 'destination';
+}>;
+/** Destination facts are resolved once by the provider adapter, before projection. */
+export declare function planBookingSignupOffer(setup: Readonly<{
+    bookingOptInEnabled: boolean;
+    form: MailingListGlobalForm;
+}>, destination: 'available' | 'unavailable'): BookingSignupOffer;
+export declare function resolveBookingSignupOffer(context: MailingListRuntimeContext | undefined, siteName: string | undefined): Readonly<{
+    siteName: string;
+}> | null;

package/dist/_dts/core/src/mailing-list-setup.d.ts

@@ -73,6 +73,7 @@ export type MailingListSiteSetup = Readonly<{
     tag: 'configured';
     siteId: SiteId;
     revision: MailingListSetupRevision;
+    bookingOptInEnabled: boolean;
     form: MailingListGlobalForm;
     provider: ConfiguredMailingListProvider;
 }>;
@@ -111,6 +112,7 @@ export declare function planMailingListFieldCompatibility(input: Readonly<{
     form: MailingListGlobalForm;
     destinations: readonly MailingListDestinationFieldRequirements[];
 }>): MailingListFieldCompatibilityPlan;
+export declare function resolveRequiredGlobalFields(fields: MailingListGlobalFields): readonly MailingListProfileField[];
 export type MailingListSetupSwitchPlan = Readonly<{
     tag: 'activate';
     affectedPlacementCount: 0;

package/dist/_dts/core/src/mailing-list-submission.d.ts

@@ -29,6 +29,10 @@ export type MailingListSignupSource = Readonly<{
     tag: 'sdk_footer_block';
     blockId: MailingListSdkFooterBlockId;
     contentHash: MailingListSdkContentHash;
+}> | Readonly<{
+    tag: 'booking';
+    kind: 'event' | 'appointment';
+    attemptId: string;
 }>;
 /** Public proof of which published placement owns a signup request. */
 export type MailingListSignupSourceRef = Readonly<{
@@ -223,4 +227,6 @@ export type ExternalSignupConsentRecord = (ExternalSignupConsentRecordBase & Rea
     }>;
     confirmation: BrevoConfirmation;
 }>);
+/** Absence of a note means booking proceeds without a signup message. */
+export type BookingMailingListNote = 'confirmation_required' | 'not_confirmed';
 export {};

package/dist/_dts/core/src/navigation-portal-labels.d.ts

@@ -0,0 +1,9 @@
+/**
+ * What a customer sign-in link in a site's menu says when the site hasn't set
+ * its own text. The site renderer falls back to these, and the dashboard's
+ * menu editor shows them, so what an editor sees is what visitors get.
+ */
+export declare const PORTAL_NAV_DEFAULT_LABELS: {
+    readonly loggedOut: "Login";
+    readonly loggedIn: "My Account";
+};

package/dist/_dts/core/src/participants.d.ts

@@ -115,30 +115,6 @@ export type ParticipantRosterProjection = Readonly<{
     slots: readonly ParticipantRosterSlot[];
     issues: readonly ParticipantRosterReconciliationIssue[];
 }>;
-export type ExistingParticipantByEmail = Readonly<{
-    participantId: ParticipantId;
-    email: ParticipantEmail;
-}>;
-export type ParticipantSubjectResolution = {
-    kind: 'create_participant';
-    slotKey: ParticipantSlotKey;
-    email: ParticipantEmail;
-    displayName: string | null;
-    phone: string | null;
-} | {
-    kind: 'reuse_participant_by_site_email';
-    slotKey: ParticipantSlotKey;
-    email: ParticipantEmail;
-    participantId: ParticipantId;
-} | {
-    kind: 'staff_managed_slot';
-    slotKey: ParticipantSlotKey;
-} | {
-    kind: 'blocked_duplicate_participant_in_booking';
-    slotKey: ParticipantSlotKey;
-    email: ParticipantEmail;
-    conflictingSlotKeys: readonly ParticipantSlotKey[];
-};
 type ParticipantContactInput = Readonly<{
     name: string | null;
     email: string | null;
@@ -166,13 +142,6 @@ export type EventSeriesRegistrationParticipantProjectionInput = Readonly<{
         customerId: CustomerId;
     };
 }>;
-export type EventSeriesSessionAttendanceParticipantProjectionInput = Readonly<{
-    attendeeId: AttendeeId;
-    registrationId: EventSeriesRegistrationId;
-    enrollmentSlot: ParticipantParticipationLinkSlot<Extract<ParticipantParticipation, {
-        kind: 'event_series_registration';
-    }>>;
-}>;
 export type SingleSubjectParticipantRosterTarget = Readonly<{
     kind: 'appointment';
     appointmentId: AppointmentId;
@@ -211,16 +180,9 @@ export declare function projectEventSeriesRegistrationParticipantSlot(input: Eve
 }>>;
 export declare function projectSingleSubjectParticipantRoster(input: SingleSubjectParticipantRosterProjectionInput): ParticipantRosterProjection;
 export declare function buildSingleSubjectParticipantPersistenceIntent(input: SingleSubjectParticipantRosterProjectionInput): SingleSubjectParticipantPersistenceIntent;
-export declare function projectEventSeriesSessionAttendanceParticipantSlot(input: EventSeriesSessionAttendanceParticipantProjectionInput): ParticipantParticipationLinkSlot<Extract<ParticipantParticipation, {
-    kind: 'event_series_session_attendance';
-}>>;
 export declare function projectEventRegistrationParticipantRoster(input: EventRegistrationParticipantProjectionInput): ParticipantRosterProjection;
 export declare function reconcileParticipantRoster(input: {
     expectedCount: ParticipantCount;
     slots: readonly ParticipantRosterSlot[];
 }): readonly ParticipantRosterReconciliationIssue[];
-export declare function planParticipantSubjectResolution(input: {
-    projection: ParticipantRosterProjection;
-    existingParticipantsByEmail: readonly ExistingParticipantByEmail[];
-}): readonly ParticipantSubjectResolution[];
 export {};

package/dist/_dts/core/src/uuid.d.ts

@@ -1,6 +1,8 @@
-/**
- * Validates whether a string matches UUID v4 format
- * Format: 8-4-4-4-12 hexadecimal digits
- * Example: 550e8400-e29b-41d4-a716-446655440000
- */
+/** Validate a UUID in the existing 8-4-4-4-12 hexadecimal format. */
 export declare function isValidUuid(str: string): boolean;
+/** UUID v4 generation in both secure and local HTTP browser contexts. */
+export type UuidCryptoSource = Readonly<{
+    randomUUID?: () => string;
+    getRandomValues: (array: Uint8Array<ArrayBuffer>) => Uint8Array<ArrayBuffer>;
+}>;
+export declare function generateUuidV4(cryptoSource?: UuidCryptoSource): string;