@riverbankcms/sdk 0.147.0 → 0.148.0

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

@@ -176,13 +176,13 @@ export type DeleteContentTypeResponse = {
 export type DuplicateContentTypeResponse = {
     contentType: ContentTypeRecord;
 };
-export declare function listContentTypes(apiClient: ApiClient, { siteId, options, }: {
+export declare function listContentTypes(apiClient: ApiClient<'listContentTypes'>, { siteId, options, }: {
     siteId: string;
     options?: RequestInit;
 }): Promise<{
     contentTypes: SerializedContentTypeSummary[];
 }>;
-export declare function enableContentType(apiClient: ApiClient, { siteId, key, options, }: {
+export declare function enableContentType(apiClient: ApiClient<'enableContentType'>, { siteId, key, options, }: {
     siteId: string;
     key: 'post' | 'event' | 'testimonial' | (string & {});
     options?: RequestInit;
@@ -190,7 +190,7 @@ export declare function enableContentType(apiClient: ApiClient, { siteId, key, o
     ok: boolean;
     contentType: SerializedContentTypeSummary;
 }>;
-export declare function setupContentType(apiClient: ApiClient, { siteId, key, addListingPage, addNavItem, seedExample, listBlockKind, options, }: {
+export declare function setupContentType(apiClient: ApiClient<'setupContentType'>, { siteId, key, addListingPage, addNavItem, seedExample, listBlockKind, options, }: {
     siteId: string;
     key: 'post' | 'event' | 'testimonial' | (string & {});
     addListingPage?: boolean;
@@ -205,35 +205,35 @@ export declare function setupContentType(apiClient: ApiClient, { siteId, key, ad
     navItemId?: string;
     entryId?: string;
 }>;
-export declare function getContentTemplate(apiClient: ApiClient, { siteId, type, options, }: {
+export declare function getContentTemplate(apiClient: ApiClient<'getContentTemplate'>, { siteId, type, options, }: {
     siteId: string;
     type: string;
     options?: RequestInit;
 }): Promise<ContentTemplateDetailsResponse>;
-export declare function updateContentTemplateBlock(apiClient: ApiClient, { siteId, type, blockId, content, options, }: {
+export declare function updateContentTemplateBlock(apiClient: ApiClient<'updateContentTemplateBlock'>, { siteId, type, blockId, content, options, }: {
     siteId: string;
     type: string;
     blockId: string;
     content: Record<string, unknown>;
     options?: RequestInit;
 }): Promise<ContentTemplateDetailsResponse>;
-export declare function applyContentTemplateAddon(apiClient: ApiClient, { siteId, type, addonKey, options, }: {
+export declare function applyContentTemplateAddon(apiClient: ApiClient<'applyContentTemplateAddon'>, { siteId, type, addonKey, options, }: {
     siteId: string;
     type: string;
     addonKey: string;
     options?: RequestInit;
 }): Promise<ContentTemplateDetailsResponse>;
-export declare function updateContentTemplateBlockBindings(apiClient: ApiClient, { siteId, type, blockId, bindings, options, }: {
+export declare function updateContentTemplateBlockBindings(apiClient: ApiClient<'updateContentTemplateBlockBindings'>, { siteId, type, blockId, bindings, options, }: {
     siteId: string;
     type: string;
     blockId: string;
     bindings: Record<string, unknown>;
     options?: RequestInit;
 }): Promise<ContentTemplateDetailsResponse>;
-export declare function getTransforms(apiClient: ApiClient, { options, }?: {
+export declare function getTransforms(apiClient: ApiClient<'getTransforms'>, { options, }?: {
     options?: RequestInit;
 }): Promise<GetTransformsResponse>;
-export declare function createTemplateBlock(apiClient: ApiClient, { siteId, type, blockKind, scope, position, options, }: {
+export declare function createTemplateBlock(apiClient: ApiClient<'createTemplateBlock'>, { siteId, type, blockKind, scope, position, options, }: {
     siteId: string;
     type: string;
     blockKind: string;
@@ -241,13 +241,13 @@ export declare function createTemplateBlock(apiClient: ApiClient, { siteId, type
     position?: number;
     options?: RequestInit;
 }): Promise<ContentTemplateDetailsResponse>;
-export declare function deleteTemplateBlock(apiClient: ApiClient, { siteId, type, blockId, options, }: {
+export declare function deleteTemplateBlock(apiClient: ApiClient<'deleteTemplateBlock'>, { siteId, type, blockId, options, }: {
     siteId: string;
     type: string;
     blockId: string;
     options?: RequestInit;
 }): Promise<ContentTemplateDetailsResponse>;
-export declare function reorderTemplateBlocks(apiClient: ApiClient, { siteId, type, blockIds, options, }: {
+export declare function reorderTemplateBlocks(apiClient: ApiClient<'reorderTemplateBlocks'>, { siteId, type, blockIds, options, }: {
     siteId: string;
     type: string;
     blockIds: string[];

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

@@ -1,6 +1,6 @@
 import type { GetVersionHistoryResponse, ListVersionHistoryResponse, RestoreVersionHistoryRequest, RestoreVersionHistoryResponse } from "./contentVersionHistory";
 import type { ApiClient } from "./request";
-export declare function listContentEntryVersions(apiClient: ApiClient, input: {
+export declare function listContentEntryVersions(apiClient: ApiClient<"listContentEntryVersions">, input: {
     siteId: string;
     type: string;
     entryId: string;
@@ -8,14 +8,14 @@ export declare function listContentEntryVersions(apiClient: ApiClient, input: {
     cursor?: string;
     options?: RequestInit;
 }): Promise<ListVersionHistoryResponse>;
-export declare function getContentEntryVersion(apiClient: ApiClient, input: {
+export declare function getContentEntryVersion(apiClient: ApiClient<"getContentEntryVersion">, input: {
     siteId: string;
     type: string;
     entryId: string;
     versionId: string;
     options?: RequestInit;
 }): Promise<GetVersionHistoryResponse>;
-export declare function restoreContentEntryVersion(apiClient: ApiClient, input: {
+export declare function restoreContentEntryVersion(apiClient: ApiClient<"restoreContentEntryVersion">, input: {
     siteId: string;
     type: string;
     entryId: string;
@@ -23,20 +23,20 @@ export declare function restoreContentEntryVersion(apiClient: ApiClient, input:
     body: RestoreVersionHistoryRequest;
     options?: RequestInit;
 }): Promise<RestoreVersionHistoryResponse>;
-export declare function listPageVersions(apiClient: ApiClient, input: {
+export declare function listPageVersions(apiClient: ApiClient<"listPageVersions">, input: {
     siteId: string;
     pageId: string;
     limit?: number;
     cursor?: string;
     options?: RequestInit;
 }): Promise<ListVersionHistoryResponse>;
-export declare function getPageVersion(apiClient: ApiClient, input: {
+export declare function getPageVersion(apiClient: ApiClient<"getPageVersion">, input: {
     siteId: string;
     pageId: string;
     versionId: string;
     options?: RequestInit;
 }): Promise<GetVersionHistoryResponse>;
-export declare function restorePageVersion(apiClient: ApiClient, input: {
+export declare function restorePageVersion(apiClient: ApiClient<"restorePageVersion">, input: {
     siteId: string;
     pageId: string;
     versionId: string;

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

@@ -0,0 +1,67 @@
+import type { RevisionedBlockListItem, PageSurfaceEditorDocument, ContentRouteRecord } from './contentRuntime';
+/** A settled block's complete values and next-write identity. */
+export type DocumentBlockBaseline = RevisionedBlockListItem & Readonly<{
+    orderIndex: number;
+    content: Record<string, unknown> | null;
+    draftContent: null;
+    publishedContent: Record<string, unknown> | null;
+    draftContentId: null;
+    publishedContentId: string | null;
+}>;
+/** Complete ordered block membership covered by a document lifecycle write. */
+export type DocumentBlockState = Readonly<{
+    kind: 'page';
+    pageId: string;
+    blocks: readonly DocumentBlockBaseline[];
+}> | Readonly<{
+    kind: 'entry-slots';
+    slots: readonly Readonly<{
+        entrySlotId: string;
+        slotKey: string;
+        blocks: readonly DocumentBlockBaseline[];
+    }>[];
+}> | Readonly<{
+    kind: 'surface-slots';
+    pageSurfaceId: string;
+    slots: readonly Readonly<{
+        surfaceSlotId: string;
+        slotKey: string;
+        compositionHash: string;
+        blocks: readonly DocumentBlockBaseline[];
+    }>[];
+}>;
+export type DiscardPageSurfaceResponse = Readonly<{
+    kind: 'unchanged';
+}> | Readonly<{
+    kind: 'discarded';
+    document: PageSurfaceEditorDocument;
+    blockState: Extract<DocumentBlockState, {
+        kind: 'surface-slots';
+    }>;
+}>;
+/**
+ * A publish moves the route's draft revision. `draftUpdatedAt` and `route` are what
+ * the publish itself wrote, from the same transaction, so an open editor adopts
+ * values and revision together. `noChange` still acknowledges the revisions observed
+ * under the publication lock without replacing document values.
+ */
+export type PublishPageSurfaceResponse = Readonly<{
+    revisions: Readonly<{
+        content: string;
+        metadata: string;
+    }>;
+}> & ({
+    publication: 'published';
+    draftUpdatedAt: string;
+    route: ContentRouteRecord;
+    document: PageSurfaceEditorDocument;
+    blockState: Extract<DocumentBlockState, {
+        kind: 'surface-slots';
+    }>;
+} | {
+    publication: 'noChange';
+    document: PageSurfaceEditorDocument;
+    blockState: Extract<DocumentBlockState, {
+        kind: 'surface-slots';
+    }>;
+});

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

@@ -4,33 +4,33 @@ import type { ApiClient } from './request';
 type RemoveDomainResponse = NonNullable<APIEndpoints['removeDomain']['response']>;
 type GetDomainDnsResponse = NonNullable<APIEndpoints['getDomainDns']['response']>;
 type VerifyDomainDnsResponse = NonNullable<APIEndpoints['verifyDomainDns']['response']>;
-export declare function listAccountDomains(apiClient: ApiClient, options?: RequestInit): Promise<SiteDomainRecord[]>;
-export declare function searchDomainsRequest(apiClient: ApiClient, query: string, options?: RequestInit): Promise<DomainSearchResultResponse>;
-export declare function registerDomainRequest(apiClient: ApiClient, input: RegisterDomainRequestPayload, options?: RequestInit): Promise<RegisterDomainResponse>;
-export declare function assignDomainToSiteRequest(apiClient: ApiClient, { domainId, siteId, options, }: {
+export declare function listAccountDomains(apiClient: ApiClient<'listAccountDomains'>, options?: RequestInit): Promise<SiteDomainRecord[]>;
+export declare function searchDomainsRequest(apiClient: ApiClient<'searchDomains'>, query: string, options?: RequestInit): Promise<DomainSearchResultResponse>;
+export declare function registerDomainRequest(apiClient: ApiClient<'registerDomain'>, input: RegisterDomainRequestPayload, options?: RequestInit): Promise<RegisterDomainResponse>;
+export declare function assignDomainToSiteRequest(apiClient: ApiClient<'assignDomain'>, { domainId, siteId, options, }: {
     domainId: string;
     siteId: string;
     options?: RequestInit;
 }): Promise<SiteDomainRecord>;
-export declare function removeDomainRequest(apiClient: ApiClient, { domainId, options }: {
+export declare function removeDomainRequest(apiClient: ApiClient<'removeDomain'>, { domainId, options }: {
     domainId: string;
     options?: RequestInit;
 }): Promise<RemoveDomainResponse>;
-export declare function syncCustomDomainToEdgeConfig(apiClient: ApiClient, siteId: string, options?: RequestInit): Promise<{
+export declare function syncCustomDomainToEdgeConfig(apiClient: ApiClient<'syncCustomDomainToEdgeConfig'>, siteId: string, options?: RequestInit): Promise<{
     success: boolean;
     domain: string;
     siteId: string;
     message: string;
 }>;
-export declare function retryDomainConfigRequest(apiClient: ApiClient, { domainId, options }: {
+export declare function retryDomainConfigRequest(apiClient: ApiClient<'retryDomainConfig'>, { domainId, options }: {
     domainId: string;
     options?: RequestInit;
 }): Promise<DomainConfigResult>;
-export declare function getDomainDnsRequest(apiClient: ApiClient, { domainId, options }: {
+export declare function getDomainDnsRequest(apiClient: ApiClient<'getDomainDns'>, { domainId, options }: {
     domainId: string;
     options?: RequestInit;
 }): Promise<GetDomainDnsResponse>;
-export declare function verifyDomainDnsRequest(apiClient: ApiClient, { domainId, options }: {
+export declare function verifyDomainDnsRequest(apiClient: ApiClient<'verifyDomainDns'>, { domainId, options }: {
     domainId: string;
     options?: RequestInit;
 }): Promise<VerifyDomainDnsResponse>;
@@ -41,13 +41,13 @@ type DomainIdRequest = {
     domainId: string;
     options?: RequestInit;
 };
-export declare function retryNameserversRequest(apiClient: ApiClient, { domainId, options }: DomainIdRequest): Promise<RetryNameserversResponse>;
-export declare function updateRegisteredDomainContactRequest(apiClient: ApiClient, { domainId, contact, options }: DomainIdRequest & {
+export declare function retryNameserversRequest(apiClient: ApiClient<'retryDomainNameservers'>, { domainId, options }: DomainIdRequest): Promise<RetryNameserversResponse>;
+export declare function updateRegisteredDomainContactRequest(apiClient: ApiClient<'updateRegisteredDomainContact'>, { domainId, contact, options }: DomainIdRequest & {
     contact: SiteDomainContactPayload;
 }): Promise<RegistrarLifecycleResponse>;
-export declare function setRegisteredDomainPrivacyRequest(apiClient: ApiClient, { domainId, enabled, options }: DomainIdRequest & RegistrarBooleanMutationRequest): Promise<RegistrarLifecycleResponse>;
-export declare function setRegisteredDomainAutoRenewRequest(apiClient: ApiClient, { domainId, enabled, options }: DomainIdRequest & RegistrarBooleanMutationRequest): Promise<RegistrarLifecycleResponse>;
-export declare function getRegisteredDomainRenewalPostureRequest(apiClient: ApiClient, { domainId, options }: DomainIdRequest): Promise<RegistrarRenewalPostureResponse>;
-export declare function retryVercelRequest(apiClient: ApiClient, { domainId, options }: DomainIdRequest): Promise<RetryVercelResponse>;
-export declare function retryResendRequest(apiClient: ApiClient, { domainId, options }: DomainIdRequest): Promise<RetryResendResponse>;
+export declare function setRegisteredDomainPrivacyRequest(apiClient: ApiClient<'setRegisteredDomainPrivacy'>, { domainId, enabled, options }: DomainIdRequest & RegistrarBooleanMutationRequest): Promise<RegistrarLifecycleResponse>;
+export declare function setRegisteredDomainAutoRenewRequest(apiClient: ApiClient<'setRegisteredDomainAutoRenew'>, { domainId, enabled, options }: DomainIdRequest & RegistrarBooleanMutationRequest): Promise<RegistrarLifecycleResponse>;
+export declare function getRegisteredDomainRenewalPostureRequest(apiClient: ApiClient<'getRegisteredDomainRenewalPosture'>, { domainId, options }: DomainIdRequest): Promise<RegistrarRenewalPostureResponse>;
+export declare function retryVercelRequest(apiClient: ApiClient<'retryDomainVercel'>, { domainId, options }: DomainIdRequest): Promise<RetryVercelResponse>;
+export declare function retryResendRequest(apiClient: ApiClient<'retryDomainResend'>, { domainId, options }: DomainIdRequest): Promise<RetryResendResponse>;
 export {};

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

@@ -0,0 +1,72 @@
+import type { EditLeaseAcquireResult, EditLeaseView } from '../../core/src/index';
+import type { APIEndpoint } from './apiEndpointTypes';
+type EditLeaseParams = Readonly<{
+    siteId: string;
+    nodeType: 'page' | 'content_entry' | 'page_surface';
+    nodeId: string;
+}>;
+export type EditLeaseAPIEndpoints = Readonly<{
+    acquireEditLease: APIEndpoint<never, EditLeaseParams, {
+        lease: EditLeaseAcquireResult;
+    }>;
+    takeOverEditLease: APIEndpoint<never, EditLeaseParams, {
+        lease: EditLeaseAcquireResult;
+    }>;
+    readEditLease: APIEndpoint<never, EditLeaseParams, {
+        lease: EditLeaseView;
+    }>;
+    heartbeatEditLease: APIEndpoint<never, EditLeaseParams, {
+        lease: {
+            kind: 'lost';
+        } | {
+            kind: 'mine';
+            expiresAt: string;
+        };
+    }>;
+    releaseEditLease: APIEndpoint<never, EditLeaseParams, {
+        released: boolean;
+    }>;
+}>;
+export declare const EDIT_LEASE_ENDPOINT_DEFINITIONS: {
+    readonly readEditLease: {
+        readonly path: "/sites/{siteId}/edit-leases/{nodeType}/{nodeId}";
+        readonly method: "GET";
+        readonly editLease: "lifecycle";
+        readonly errors: readonly ["auth:lease_required", "auth:forbidden", "resource:not_found", "validation:invalid_input", "server:internal_error"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+    };
+    readonly acquireEditLease: {
+        readonly path: "/sites/{siteId}/edit-leases/{nodeType}/{nodeId}";
+        readonly method: "POST";
+        readonly editLease: "lifecycle";
+        readonly errors: readonly ["auth:lease_required", "auth:forbidden", "resource:not_found", "validation:invalid_input", "server:internal_error"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+    };
+    readonly takeOverEditLease: {
+        readonly path: "/sites/{siteId}/edit-leases/{nodeType}/{nodeId}";
+        readonly method: "PUT";
+        readonly editLease: "lifecycle";
+        readonly errors: readonly ["auth:lease_required", "auth:forbidden", "resource:not_found", "validation:invalid_input", "server:internal_error"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+    };
+    readonly heartbeatEditLease: {
+        readonly path: "/sites/{siteId}/edit-leases/{nodeType}/{nodeId}";
+        readonly method: "PATCH";
+        readonly editLease: "lifecycle";
+        readonly errors: readonly ["auth:lease_required", "auth:forbidden", "resource:not_found", "validation:invalid_input", "server:internal_error", "auth:lease_lost"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+    };
+    readonly releaseEditLease: {
+        readonly path: "/sites/{siteId}/edit-leases/{nodeType}/{nodeId}";
+        readonly method: "DELETE";
+        readonly editLease: "lifecycle";
+        readonly errors: readonly ["auth:lease_required", "auth:forbidden", "resource:not_found", "validation:invalid_input", "server:internal_error"];
+        readonly auth: "user";
+        readonly responseKind: "json";
+    };
+};
+export {};

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

@@ -8,16 +8,16 @@ import type { GetEmailSettingsResponse, UpdateEmailSettingsRequest, UpdateEmailS
 /**
  * Fetch email template settings for a site.
  */
-export declare function getEmailSettingsRequest(apiClient: ApiClient, siteId: string, options?: RequestInit): Promise<GetEmailSettingsResponse>;
+export declare function getEmailSettingsRequest(apiClient: ApiClient<'getEmailSettings'>, siteId: string, options?: RequestInit): Promise<GetEmailSettingsResponse>;
 /**
  * Update email template settings for a site.
  */
-export declare function updateEmailSettingsRequest(apiClient: ApiClient, siteId: string, payload: UpdateEmailSettingsRequest, options?: RequestInit): Promise<UpdateEmailSettingsResponse>;
+export declare function updateEmailSettingsRequest(apiClient: ApiClient<'updateEmailSettings'>, siteId: string, payload: UpdateEmailSettingsRequest, options?: RequestInit): Promise<UpdateEmailSettingsResponse>;
 /**
  * Send a test email using the current form values.
  */
-export declare function sendTestEmailRequest(apiClient: ApiClient, siteId: string, payload: SendTestEmailRequest, options?: RequestInit): Promise<SendTestEmailResponse>;
+export declare function sendTestEmailRequest(apiClient: ApiClient<'sendTestEmail'>, siteId: string, payload: SendTestEmailRequest, options?: RequestInit): Promise<SendTestEmailResponse>;
 /**
  * Build a rendered preview for the current template form values.
  */
-export declare function previewEmailTemplateRequest(apiClient: ApiClient, siteId: string, payload: PreviewEmailTemplateRequest, options?: RequestInit): Promise<PreviewEmailTemplateResponse>;
+export declare function previewEmailTemplateRequest(apiClient: ApiClient<'previewEmailTemplate'>, siteId: string, payload: PreviewEmailTemplateRequest, options?: RequestInit): Promise<PreviewEmailTemplateResponse>;