@riverbankcms/sdk 0.147.0 → 0.148.0

package/dist/server/index.mjs

@@ -1601,6 +1601,7 @@ const SDK_EVENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 		responseKind: "json",
 		errors: [
 			"resource:not_found",
+			"validation:invalid_input",
 			"resource:conflict",
 			"server:internal_error"
 		]
@@ -2108,28 +2109,6 @@ const EVENT_MANAGEMENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 			"resource:conflict",
 			"server:internal_error"
 		]
-	},
-	/**
-	* The Content tab's one write: the short introduction, image and
-	* description of an event's page, published without its layout.
-	*/
-	saveEventPageWords: {
-		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/words",
-		method: "PUT",
-		tags: [
-			TAG_TEMPLATES.siteCollection,
-			TAG_TEMPLATES.siteRoutableContent,
-			TAG_TEMPLATES.pageSurfaceById
-		],
-		auth: "user",
-		responseKind: "json",
-		errors: [
-			"auth:forbidden",
-			"validation:invalid_input",
-			"resource:not_found",
-			"resource:conflict",
-			"server:internal_error"
-		]
 	}
 });
 //#endregion
@@ -2554,6 +2533,15 @@ const BILLING_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 		auth: "user",
 		responseKind: "json"
 	},
+	/** Continue on Free from the onboarding card page; only the attempt's owner. */
+	continueOnboardingOnFree: {
+		path: "/onboarding/attempts/{attemptToken}/plan/free",
+		method: "POST",
+		tags: ["billing"],
+		auth: "user",
+		errors: [],
+		responseKind: "json"
+	},
 	createBillingPortalSession: {
 		path: "/billing/portal/session",
 		method: "POST",
@@ -2563,6 +2551,161 @@ const BILLING_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 	}
 });
 //#endregion
+//#region ../api/src/editLeaseEndpoints.ts
+const path$1 = "/sites/{siteId}/edit-leases/{nodeType}/{nodeId}";
+const lifecycleErrors = [
+	"auth:lease_required",
+	"auth:forbidden",
+	"resource:not_found",
+	"validation:invalid_input",
+	"server:internal_error"
+];
+const EDIT_LEASE_ENDPOINT_DEFINITIONS = {
+	readEditLease: {
+		path: path$1,
+		method: "GET",
+		editLease: "lifecycle",
+		errors: lifecycleErrors,
+		auth: "user",
+		responseKind: "json"
+	},
+	acquireEditLease: {
+		path: path$1,
+		method: "POST",
+		editLease: "lifecycle",
+		errors: lifecycleErrors,
+		auth: "user",
+		responseKind: "json"
+	},
+	takeOverEditLease: {
+		path: path$1,
+		method: "PUT",
+		editLease: "lifecycle",
+		errors: lifecycleErrors,
+		auth: "user",
+		responseKind: "json"
+	},
+	heartbeatEditLease: {
+		path: path$1,
+		method: "PATCH",
+		editLease: "lifecycle",
+		errors: [...lifecycleErrors, "auth:lease_lost"],
+		auth: "user",
+		responseKind: "json"
+	},
+	releaseEditLease: {
+		path: path$1,
+		method: "DELETE",
+		editLease: "lifecycle",
+		errors: lifecycleErrors,
+		auth: "user",
+		responseKind: "json"
+	}
+};
+//#endregion
+//#region ../api/src/pageSurfaceEditorEndpoints.ts
+const surfaceTags = [TAG_TEMPLATES.siteCollection, TAG_TEMPLATES.pageSurfaceById];
+const PAGE_SURFACE_EDITOR_ENDPOINT_DEFINITIONS = {
+	getPageSurfaceEditorDocument: {
+		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/content",
+		method: "GET",
+		errors: [
+			"auth:forbidden",
+			"validation:invalid_input",
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		],
+		tags: surfaceTags,
+		auth: "user",
+		responseKind: "json"
+	},
+	updatePageSurfaceDraftContent: {
+		editLease: "managed",
+		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/content",
+		method: "PUT",
+		errors: [
+			"validation:invalid_input",
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		],
+		tags: surfaceTags,
+		auth: "user",
+		responseKind: "json"
+	},
+	discardPageSurfaceDraftContent: {
+		editLease: "managed",
+		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/content/draft",
+		method: "DELETE",
+		errors: [
+			"validation:invalid_input",
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		],
+		tags: surfaceTags,
+		auth: "user",
+		responseKind: "json"
+	},
+	updatePageSurfaceRouteMetadata: {
+		editLease: "managed",
+		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/metadata",
+		method: "PATCH",
+		errors: [
+			"validation:invalid_input",
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		],
+		tags: [
+			TAG_TEMPLATES.siteCollection,
+			TAG_TEMPLATES.siteRoutableContent,
+			TAG_TEMPLATES.pageSurfaceById
+		],
+		auth: "user",
+		responseKind: "json"
+	},
+	publishPageSurface: {
+		editLease: "managed",
+		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/publication",
+		method: "POST",
+		errors: [
+			"auth:forbidden",
+			"validation:invalid_input",
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		],
+		tags: [
+			TAG_TEMPLATES.siteCollection,
+			TAG_TEMPLATES.siteRoutableContent,
+			TAG_TEMPLATES.pageSurfaceById
+		],
+		auth: "user",
+		responseKind: "json"
+	},
+	saveEventContentTab: {
+		editLease: "managed",
+		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/event-content",
+		method: "PUT",
+		errors: [
+			"auth:forbidden",
+			"validation:invalid_input",
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		],
+		tags: [
+			TAG_TEMPLATES.siteCollection,
+			TAG_TEMPLATES.siteRoutableContent,
+			TAG_TEMPLATES.pageSurfaceById
+		],
+		auth: "user",
+		responseKind: "json"
+	}
+};
+//#endregion
 //#region ../api/src/bookingPeopleEndpointDefinitions.ts
 /**
 * People endpoints (#1356): the People list, its CSV export, and deleting a
@@ -2655,6 +2798,8 @@ const API_ENDPOINTS$1 = {
 	...GIFTING_ENDPOINT_DEFINITIONS,
 	...PUBLIC_READ_ENDPOINT_DEFINITIONS,
 	...BILLING_ENDPOINT_DEFINITIONS,
+	...EDIT_LEASE_ENDPOINT_DEFINITIONS,
+	...PAGE_SURFACE_EDITOR_ENDPOINT_DEFINITIONS,
 	...SITE_MANAGEMENT_ENDPOINT_DEFINITIONS,
 	aiContentUpdateChat: {
 		path: "/ai/content-update-chat",
@@ -2676,6 +2821,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	aiDesignerPageOpsApply: {
+		editLease: "managed",
 		path: "/sites/{siteId}/ai/designer/page/apply",
 		method: "POST",
 		tags: [TAG_TEMPLATES.siteCollection],
@@ -3510,6 +3656,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	restoreContentEntryVersion: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/versions/{versionId}/restore",
 		method: "POST",
 		errors: [
@@ -3527,6 +3674,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	updateContentEntryContent: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/content",
 		method: "PUT",
 		tags: [
@@ -3543,67 +3691,6 @@ const API_ENDPOINTS$1 = {
 		],
 		responseKind: "json"
 	},
-	updatePageSurfaceDraftContent: {
-		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/content",
-		method: "PUT",
-		errors: [
-			"validation:invalid_input",
-			"resource:not_found",
-			"resource:conflict",
-			"server:internal_error"
-		],
-		tags: [TAG_TEMPLATES.siteCollection, TAG_TEMPLATES.pageSurfaceById],
-		auth: "user",
-		responseKind: "json"
-	},
-	discardPageSurfaceDraftContent: {
-		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/content/draft",
-		method: "DELETE",
-		errors: [
-			"validation:invalid_input",
-			"resource:not_found",
-			"resource:conflict",
-			"server:internal_error"
-		],
-		tags: [TAG_TEMPLATES.siteCollection, TAG_TEMPLATES.pageSurfaceById],
-		auth: "user",
-		responseKind: "json"
-	},
-	updatePageSurfaceRouteMetadata: {
-		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/metadata",
-		method: "PATCH",
-		errors: [
-			"validation:invalid_input",
-			"resource:not_found",
-			"resource:conflict",
-			"server:internal_error"
-		],
-		tags: [
-			TAG_TEMPLATES.siteCollection,
-			TAG_TEMPLATES.siteRoutableContent,
-			TAG_TEMPLATES.pageSurfaceById
-		],
-		auth: "user",
-		responseKind: "json"
-	},
-	publishPageSurface: {
-		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/publication",
-		method: "POST",
-		errors: [
-			"auth:forbidden",
-			"validation:invalid_input",
-			"resource:not_found",
-			"resource:conflict",
-			"server:internal_error"
-		],
-		tags: [
-			TAG_TEMPLATES.siteCollection,
-			TAG_TEMPLATES.siteRoutableContent,
-			TAG_TEMPLATES.pageSurfaceById
-		],
-		auth: "user",
-		responseKind: "json"
-	},
 	runSdkWorkflow: {
 		path: "/sites/{siteId}/content/{type}/{entryId}/workflows/{workflowId}/run",
 		method: "POST",
@@ -3640,6 +3727,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	updateRouteMetadata: {
+		editLease: "managed",
 		path: "/sites/{siteId}/routes/{routeId}/metadata",
 		method: "PATCH",
 		tags: [
@@ -3657,6 +3745,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	publishContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/publish",
 		method: "POST",
 		tags: [
@@ -3668,6 +3757,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	scheduleContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/schedule",
 		method: "POST",
 		tags: [
@@ -3685,6 +3775,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	cancelScheduledContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/schedule",
 		method: "DELETE",
 		tags: [
@@ -3702,6 +3793,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	discardContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/discard",
 		method: "POST",
 		tags: [
@@ -3720,6 +3812,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	unpublishContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/unpublish",
 		method: "POST",
 		tags: [
@@ -3761,6 +3854,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	deleteContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}",
 		method: "DELETE",
 		tags: [
@@ -4970,6 +5064,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	saveBlockContent: {
+		editLease: "owner-derived",
 		path: "/blocks/{blockId}/content",
 		method: "POST",
 		tags: [
@@ -5007,6 +5102,7 @@ const API_ENDPOINTS$1 = {
 		errors: ["resource:not_found", "resource:conflict"]
 	},
 	createEntrySlotBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/slots/{slotKey}/blocks",
 		method: "POST",
 		tags: [
@@ -5024,6 +5120,7 @@ const API_ENDPOINTS$1 = {
 		]
 	},
 	reorderEntrySlotBlocks: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/slots/{slotKey}/blocks/reorder",
 		method: "POST",
 		tags: [
@@ -5041,6 +5138,7 @@ const API_ENDPOINTS$1 = {
 		]
 	},
 	deleteEntrySlotBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/slots/{slotKey}/blocks/{blockId}",
 		method: "DELETE",
 		tags: [
@@ -5071,6 +5169,7 @@ const API_ENDPOINTS$1 = {
 		]
 	},
 	createPageSurfaceSlotBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots/{slotKey}/blocks",
 		method: "POST",
 		tags: [
@@ -5089,6 +5188,7 @@ const API_ENDPOINTS$1 = {
 		]
 	},
 	reorderPageSurfaceSlotBlocks: {
+		editLease: "managed",
 		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots/{slotKey}/blocks/reorder",
 		method: "POST",
 		tags: [
@@ -5107,6 +5207,7 @@ const API_ENDPOINTS$1 = {
 		]
 	},
 	deletePageSurfaceSlotBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots/{slotKey}/blocks/{blockId}",
 		method: "DELETE",
 		tags: [
@@ -5124,6 +5225,7 @@ const API_ENDPOINTS$1 = {
 		]
 	},
 	createBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/blocks",
 		method: "POST",
 		tags: [
@@ -5135,6 +5237,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	reorderBlocks: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/blocks/reorder",
 		method: "POST",
 		tags: [
@@ -5146,6 +5249,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	deleteBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/blocks/{blockId}",
 		method: "DELETE",
 		tags: [
@@ -5191,6 +5295,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	publishPageDraft: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/publish",
 		method: "POST",
 		tags: [TAG_TEMPLATES.siteRoutableContent, TAG_TEMPLATES.pageById],
@@ -5198,6 +5303,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	discardPageDraft: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/discard",
 		method: "POST",
 		tags: [TAG_TEMPLATES.siteRoutableContent, TAG_TEMPLATES.pageById],
@@ -5213,6 +5319,7 @@ const API_ENDPOINTS$1 = {
 		errors: ["resource:not_found", "server:internal_error"]
 	},
 	savePageDesignState: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/design-state",
 		method: "POST",
 		tags: [TAG_TEMPLATES.siteRoutableContent, TAG_TEMPLATES.pageById],
@@ -5242,6 +5349,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	restorePageVersion: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/versions/{versionId}/restore",
 		method: "POST",
 		errors: [
@@ -5255,6 +5363,7 @@ const API_ENDPOINTS$1 = {
 		responseKind: "json"
 	},
 	applyPageDesignEditorAction: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/design/actions",
 		method: "POST",
 		tags: [TAG_TEMPLATES.siteRoutableContent, TAG_TEMPLATES.pageById],
@@ -8111,6 +8220,8 @@ const API_ERROR_CODE_SET = /* @__PURE__ */ new Set([
 	"auth:sudo_required",
 	"auth:insufficient_permissions",
 	"auth:impersonation_restricted",
+	"auth:lease_required",
+	"auth:lease_lost",
 	"validation:invalid_input",
 	"validation:missing_field",
 	"validation:invalid_format",
@@ -8662,7 +8773,7 @@ var SimpleCache = class {
 * 1. This constant
 * 2. The "version" field in package.json
 */
-const SDK_VERSION = "0.147.0";
+const SDK_VERSION = "0.148.0";
 //#endregion
 //#region src/client/error.ts
 let _Symbol$for;