npm - @riverbankcms/sdk - Versions diffs - 0.147.0 → 0.148.0 - Mend

@riverbankcms/sdk 0.147.0 → 0.148.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (381) hide show

package/dist/preview-next/middleware.mjs CHANGED Viewed

@@ -1613,6 +1613,7 @@ const SDK_EVENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 		responseKind: "json",
 		errors: [
 			"resource:not_found",
+			"validation:invalid_input",
 			"resource:conflict",
 			"server:internal_error"
 		]
@@ -2117,28 +2118,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
@@ -2563,6 +2542,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",
@@ -2572,6 +2560,161 @@ const BILLING_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 	}
 });
 //#endregion
+//#region ../api/src/editLeaseEndpoints.ts
+const path = "/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,
+		method: "GET",
+		editLease: "lifecycle",
+		errors: lifecycleErrors,
+		auth: "user",
+		responseKind: "json"
+	},
+	acquireEditLease: {
+		path,
+		method: "POST",
+		editLease: "lifecycle",
+		errors: lifecycleErrors,
+		auth: "user",
+		responseKind: "json"
+	},
+	takeOverEditLease: {
+		path,
+		method: "PUT",
+		editLease: "lifecycle",
+		errors: lifecycleErrors,
+		auth: "user",
+		responseKind: "json"
+	},
+	heartbeatEditLease: {
+		path,
+		method: "PATCH",
+		editLease: "lifecycle",
+		errors: [...lifecycleErrors, "auth:lease_lost"],
+		auth: "user",
+		responseKind: "json"
+	},
+	releaseEditLease: {
+		path,
+		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
@@ -2664,6 +2807,8 @@ const API_ENDPOINTS = {
 	...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",
@@ -2685,6 +2830,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	aiDesignerPageOpsApply: {
+		editLease: "managed",
 		path: "/sites/{siteId}/ai/designer/page/apply",
 		method: "POST",
 		tags: [TAG_TEMPLATES.siteCollection],
@@ -3519,6 +3665,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	restoreContentEntryVersion: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/versions/{versionId}/restore",
 		method: "POST",
 		errors: [
@@ -3536,6 +3683,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	updateContentEntryContent: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/content",
 		method: "PUT",
 		tags: [
@@ -3552,67 +3700,6 @@ const API_ENDPOINTS = {
 		],
 		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",
@@ -3649,6 +3736,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	updateRouteMetadata: {
+		editLease: "managed",
 		path: "/sites/{siteId}/routes/{routeId}/metadata",
 		method: "PATCH",
 		tags: [
@@ -3666,6 +3754,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	publishContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/publish",
 		method: "POST",
 		tags: [
@@ -3677,6 +3766,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	scheduleContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/schedule",
 		method: "POST",
 		tags: [
@@ -3694,6 +3784,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	cancelScheduledContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/schedule",
 		method: "DELETE",
 		tags: [
@@ -3711,6 +3802,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	discardContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/discard",
 		method: "POST",
 		tags: [
@@ -3729,6 +3821,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	unpublishContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/unpublish",
 		method: "POST",
 		tags: [
@@ -3770,6 +3863,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	deleteContentEntry: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}",
 		method: "DELETE",
 		tags: [
@@ -4979,6 +5073,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	saveBlockContent: {
+		editLease: "owner-derived",
 		path: "/blocks/{blockId}/content",
 		method: "POST",
 		tags: [
@@ -5016,6 +5111,7 @@ const API_ENDPOINTS = {
 		errors: ["resource:not_found", "resource:conflict"]
 	},
 	createEntrySlotBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/slots/{slotKey}/blocks",
 		method: "POST",
 		tags: [
@@ -5033,6 +5129,7 @@ const API_ENDPOINTS = {
 		]
 	},
 	reorderEntrySlotBlocks: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/slots/{slotKey}/blocks/reorder",
 		method: "POST",
 		tags: [
@@ -5050,6 +5147,7 @@ const API_ENDPOINTS = {
 		]
 	},
 	deleteEntrySlotBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/content/{type}/{entryId}/slots/{slotKey}/blocks/{blockId}",
 		method: "DELETE",
 		tags: [
@@ -5080,6 +5178,7 @@ const API_ENDPOINTS = {
 		]
 	},
 	createPageSurfaceSlotBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots/{slotKey}/blocks",
 		method: "POST",
 		tags: [
@@ -5098,6 +5197,7 @@ const API_ENDPOINTS = {
 		]
 	},
 	reorderPageSurfaceSlotBlocks: {
+		editLease: "managed",
 		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots/{slotKey}/blocks/reorder",
 		method: "POST",
 		tags: [
@@ -5116,6 +5216,7 @@ const API_ENDPOINTS = {
 		]
 	},
 	deletePageSurfaceSlotBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/page-surfaces/{pageSurfaceId}/slots/{slotKey}/blocks/{blockId}",
 		method: "DELETE",
 		tags: [
@@ -5133,6 +5234,7 @@ const API_ENDPOINTS = {
 		]
 	},
 	createBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/blocks",
 		method: "POST",
 		tags: [
@@ -5144,6 +5246,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	reorderBlocks: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/blocks/reorder",
 		method: "POST",
 		tags: [
@@ -5155,6 +5258,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	deleteBlock: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/blocks/{blockId}",
 		method: "DELETE",
 		tags: [
@@ -5200,6 +5304,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	publishPageDraft: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/publish",
 		method: "POST",
 		tags: [TAG_TEMPLATES.siteRoutableContent, TAG_TEMPLATES.pageById],
@@ -5207,6 +5312,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	discardPageDraft: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/discard",
 		method: "POST",
 		tags: [TAG_TEMPLATES.siteRoutableContent, TAG_TEMPLATES.pageById],
@@ -5222,6 +5328,7 @@ const API_ENDPOINTS = {
 		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],
@@ -5251,6 +5358,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	restorePageVersion: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/versions/{versionId}/restore",
 		method: "POST",
 		errors: [
@@ -5264,6 +5372,7 @@ const API_ENDPOINTS = {
 		responseKind: "json"
 	},
 	applyPageDesignEditorAction: {
+		editLease: "managed",
 		path: "/sites/{siteId}/pages/{pageId}/design/actions",
 		method: "POST",
 		tags: [TAG_TEMPLATES.siteRoutableContent, TAG_TEMPLATES.pageById],