@riverbankcms/sdk 0.147.0 → 0.149.0

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

@@ -29,6 +29,8 @@ export type ApiKeyId = Brand<string, 'ApiKeyId'>;
 export type SiteRouteId = Brand<string, 'SiteRouteId'>;
 export type PageId = Brand<string, 'PageId'>;
 export type PageSurfaceId = Brand<string, 'PageSurfaceId'>;
+export type EditLeaseToken = Brand<string, 'EditLeaseToken'>;
+export type EditorClientId = Brand<string, 'EditorClientId'>;
 export type OccurrenceId = Brand<string, 'OccurrenceId'>;
 export type EventOfferingId = Brand<string, 'EventOfferingId'>;
 export type EventSeriesId = Brand<string, 'EventSeriesId'>;
@@ -78,6 +80,7 @@ export type MembershipId = Brand<string, 'MembershipId'>;
 export type RetiredCourseId = Brand<string, 'RetiredCourseId'>;
 export type CustomerId = Brand<string, 'CustomerId'>;
 export type OrderId = Brand<string, 'OrderId'>;
+export type OrderRetirementOperationId = Brand<string, 'OrderRetirementOperationId'>;
 export type OrderItemId = Brand<string, 'OrderItemId'>;
 export type OrderRefundId = Brand<string, 'OrderRefundId'>;
 export type OrderPaymentReceiptId = Brand<string, 'OrderPaymentReceiptId'>;
@@ -116,6 +119,10 @@ export type ContentBlockId = Brand<string, 'ContentBlockId'>;
 export type ContentVersionId = Brand<string, 'ContentVersionId'>;
 export type EntryContentHash = Brand<string, 'EntryContentHash'>;
 export type StripeInvoiceId = Brand<string, 'StripeInvoiceId'>;
+/** A platform (not Connect) Stripe customer id, `cus_…`. */
+export type StripeCustomerId = Brand<string, 'StripeCustomerId'>;
+/** A Stripe subscription id, `sub_…`. */
+export type StripeSubscriptionId = Brand<string, 'StripeSubscriptionId'>;
 export type NewsletterSubscriberId = Brand<string, 'NewsletterSubscriberId'>;
 export type NavigationMenuId = Brand<string, 'NavigationMenuId'>;
 export type NavigationItemId = Brand<string, 'NavigationItemId'>;
@@ -178,6 +185,8 @@ export declare const unsafeAsApiKeyId: (id: string) => ApiKeyId;
 export declare const unsafeAsSiteRouteId: (id: string) => SiteRouteId;
 export declare const unsafeAsPageId: (id: string) => PageId;
 export declare const unsafeAsPageSurfaceId: (id: string) => PageSurfaceId;
+export declare const unsafeAsEditLeaseToken: (id: string) => EditLeaseToken;
+export declare const unsafeAsEditorClientId: (id: string) => EditorClientId;
 export declare const unsafeAsOccurrenceId: (id: string) => OccurrenceId;
 export declare const unsafeAsEventOfferingId: (id: string) => EventOfferingId;
 export declare const unsafeAsEventSeriesId: (id: string) => EventSeriesId;
@@ -220,6 +229,7 @@ export declare const unsafeAsFormSubmissionId: (id: string) => FormSubmissionId;
 export declare const unsafeAsPassId: (id: string) => PassId;
 export declare const unsafeAsMembershipId: (id: string) => MembershipId;
 export declare const unsafeAsCustomerId: (id: string) => CustomerId;
+export declare const unsafeAsOrderRetirementOperationId: (id: string) => OrderRetirementOperationId;
 export declare const unsafeAsOrderId: (id: string) => OrderId;
 export declare const unsafeAsOrderItemId: (id: string) => OrderItemId;
 export declare const unsafeAsOrderRefundId: (id: string) => OrderRefundId;
@@ -250,6 +260,8 @@ export declare const unsafeAsContentBlockId: (id: string) => ContentBlockId;
 export declare const unsafeAsContentVersionId: (id: string) => ContentVersionId;
 export declare const unsafeAsEntryContentHash: (value: string) => EntryContentHash;
 export declare const unsafeAsStripeInvoiceId: (id: string) => StripeInvoiceId;
+export declare const unsafeAsStripeCustomerId: (id: string) => StripeCustomerId;
+export declare const unsafeAsStripeSubscriptionId: (id: string) => StripeSubscriptionId;
 export declare const unsafeAsNewsletterSubscriberId: (id: string) => NewsletterSubscriberId;
 export declare const unsafeAsNavigationMenuId: (id: string) => NavigationMenuId;
 export declare const unsafeAsNavigationItemId: (id: string) => NavigationItemId;
@@ -286,6 +298,8 @@ export declare const parseApiKeyId: (value: unknown) => Result<ApiKeyId, Branded
 export declare const parseSiteRouteId: (value: unknown) => Result<SiteRouteId, BrandedIdParseError>;
 export declare const parsePageId: (value: unknown) => Result<PageId, BrandedIdParseError>;
 export declare const parsePageSurfaceId: (value: unknown) => Result<PageSurfaceId, BrandedIdParseError>;
+export declare const parseEditLeaseToken: (value: unknown) => Result<EditLeaseToken, BrandedIdParseError>;
+export declare const parseEditorClientId: (value: unknown) => Result<EditorClientId, BrandedIdParseError>;
 export declare const parseOccurrenceId: (value: unknown) => Result<OccurrenceId, BrandedIdParseError>;
 export declare const parseEventOfferingId: (value: unknown) => Result<EventOfferingId, BrandedIdParseError>;
 export declare const parseEventAttendeeTicketLineId: (value: unknown) => Result<EventAttendeeTicketLineId, BrandedIdParseError>;
@@ -326,6 +340,7 @@ export declare const parseEventSeriesRegistrationId: (value: unknown) => Result<
 export declare const parseParticipantId: (value: unknown) => Result<ParticipantId, BrandedIdParseError>;
 export declare const parseParticipantParticipationId: (value: unknown) => Result<ParticipantParticipationId, BrandedIdParseError>;
 export declare const parseOrderItemId: (value: unknown) => Result<OrderItemId, BrandedIdParseError>;
+export declare const parseOrderRetirementOperationId: (value: unknown) => Result<OrderRetirementOperationId, BrandedIdParseError>;
 export declare const parseOrderId: (value: unknown) => Result<OrderId, BrandedIdParseError>;
 export declare const parseOrderRefundId: (value: unknown) => Result<OrderRefundId, BrandedIdParseError>;
 export declare const parseOrderPaymentReceiptId: (value: unknown) => Result<OrderPaymentReceiptId, BrandedIdParseError>;

package/dist/_dts/core/src/currency-format.d.ts

@@ -17,9 +17,10 @@ export declare function unsafeCurrencyCode(value: string): CurrencyCode;
 /**
  * Trailing-decimal policy for a formatted amount:
  * - 'exact' : the currency's natural precision (usually 2) — "£25.00"
- * - 'auto'  : drop trailing zeros within the currency's natural precision — "£25", "£25.50"
+ * - 'auto'  : drop trailing zeros within the currency's natural precision — "£25", "£25.5"
+ * - 'whole' : round to whole major units — "£25"
  */
-export type CurrencyDecimals = 'exact' | 'auto';
+export type CurrencyDecimals = 'exact' | 'auto' | 'whole';
 export type FormatCurrencyOptions = Readonly<{
     /** Defaults to 'exact'. */
     decimals?: CurrencyDecimals;
@@ -36,4 +37,9 @@ export type FormatCurrencyOptions = Readonly<{
  * own `Intl.NumberFormat`.
  */
 export declare function formatCurrencyAmount(amountCents: number, currency: string, options?: FormatCurrencyOptions): string;
+/**
+ * `formatCurrencyAmount` for an amount already in MAJOR units (29.99 = £29.99),
+ * such as a registrar price. Prefer minor units everywhere else.
+ */
+export declare function formatCurrencyMajorUnits(amount: number, currency: string, options?: FormatCurrencyOptions): string;
 export {};

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,60 @@
+import type { ContentEntryId, EditLeaseToken, EditorClientId, PageId, PageSurfaceId } from './branded';
+/**
+ * How long a lease lasts without a heartbeat. The server grants for this long, and a
+ * reload handover is only worth presenting within it (issue 1570).
+ */
+export declare const EDIT_LEASE_TTL_SECONDS = 60;
+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';
@@ -16,6 +18,9 @@ export * from './money-input';
 export * from './booking-flexible-balance';
 export * from './booking-refunds';
 export * from './booking-instalments';
+export * from './booking-instalment-deposit';
+export * from './booking-live-payment-terms';
+export * from './booking-payment-options';
 export * from './booking-date-time';
 export * from './booking-consent';
 export * from './appointment-service-categories';
@@ -30,6 +35,8 @@ 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';

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;