@riverbankcms/sdk 0.145.0 → 0.146.0

package/dist/preview-next/middleware.mjs

@@ -1,4 +1,5 @@
 import { NextResponse } from "next/server.js";
+import { z } from "zod";
 //#region ../preview-next/src/constants.ts
 const PREVIEW_COOKIE_NAME = "preview_token";
 const PREVIEW_REFRESH_COOKIE_NAME = "preview_refresh_token";
@@ -979,6 +980,13 @@ const EVENT_SERIES_REGISTRATION_ENDPOINT_DEFINITIONS = defineEndpointDefinitions
 		errors: [],
 		responseKind: "blob"
 	},
+	exportEventOfferingRegistrationsCsv: {
+		path: "/sites/{siteId}/bookings/event-offerings/{eventOfferingId}/registrations/export.csv",
+		method: "GET",
+		auth: "user",
+		errors: [],
+		responseKind: "blob"
+	},
 	updateEventSeriesRegistration: {
 		path: "/sites/{siteId}/bookings/event-series/{seriesId}/registrations/{registrationId}",
 		method: "PATCH",
@@ -989,6 +997,19 @@ const EVENT_SERIES_REGISTRATION_ENDPOINT_DEFINITIONS = defineEndpointDefinitions
 			"resource:not_found",
 			"server:internal_error"
 		]
+	},
+	saveEventSeriesRegistrationAnswers: {
+		path: "/sites/{siteId}/bookings/event-series/{seriesId}/registrations/{registrationId}/answers",
+		method: "PUT",
+		auth: "user",
+		responseKind: "json",
+		errors: [
+			"validation:invalid_input",
+			"auth:forbidden",
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		]
 	}
 });
 //#endregion
@@ -1409,6 +1430,30 @@ const NEWSLETTER_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 		responseKind: "json",
 		demoMutation: DEMO_MUTATION_BLOCKED_HIDDEN
 	},
+	scheduleNewsletterCampaign: {
+		path: "/sites/{siteId}/newsletter/campaigns/{campaignId}/schedule",
+		method: "POST",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_BLOCKED_HIDDEN
+	},
+	unscheduleNewsletterCampaign: {
+		path: "/sites/{siteId}/newsletter/campaigns/{campaignId}/unschedule",
+		method: "POST",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_BLOCKED_HIDDEN
+	},
+	stopNewsletterCampaign: {
+		path: "/sites/{siteId}/newsletter/campaigns/{campaignId}/stop",
+		method: "POST",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_BLOCKED_HIDDEN
+	},
 	testSendNewsletterCampaign: {
 		path: "/sites/{siteId}/newsletter/campaigns/{campaignId}/test-send",
 		method: "POST",
@@ -1418,6 +1463,154 @@ const NEWSLETTER_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 		demoMutation: DEMO_MUTATION_BLOCKED_HIDDEN
 	}
 });
+//#endregion
+//#region ../api/src/sdkEventEndpointDefinitions.ts
+/**
+* The SDK's Event graph: the Events themselves and the occurrences of one run.
+* Extracted from `endpoints.ts` so this family can be read, and added to, on
+* its own. New entries here must declare `errors`; the
+* require-api-endpoint-errors lint enforces that here as in endpoints.ts.
+*/
+const SDK_EVENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
+	sdkListEvents: {
+		path: "/sdk/{siteId}/events",
+		method: "GET",
+		auth: "service",
+		responseKind: "json"
+	},
+	sdkUpsertEvent: {
+		path: "/sdk/{siteId}/events",
+		method: "POST",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"validation:invalid_input",
+			"resource:not_found",
+			"resource:conflict",
+			"billing:plan_limit_exceeded",
+			"server:internal_error"
+		]
+	},
+	sdkGetEvent: {
+		path: "/sdk/{siteId}/events/{identifier}",
+		method: "GET",
+		auth: "service",
+		responseKind: "json"
+	},
+	sdkDeleteEvent: {
+		path: "/sdk/{siteId}/events/{identifier}",
+		method: "DELETE",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
+	sdkTakeEventOffline: {
+		path: "/sdk/{siteId}/events/{identifier}/lifecycle",
+		method: "POST",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"resource:not_found",
+			"validation:invalid_input",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
+	sdkListEventOccurrences: {
+		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences",
+		method: "GET",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"resource:not_found",
+			"validation:invalid_input",
+			"server:internal_error"
+		]
+	},
+	sdkAddEventOccurrence: {
+		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences",
+		method: "POST",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"resource:not_found",
+			"validation:invalid_input",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
+	sdkUpdateEventOccurrence: {
+		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences/{occurrenceId}",
+		method: "PATCH",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"resource:not_found",
+			"validation:invalid_input",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
+	sdkCancelEventOccurrence: {
+		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences/{occurrenceId}/cancel",
+		method: "POST",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
+	sdkDeleteEventOccurrence: {
+		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences/{occurrenceId}",
+		method: "DELETE",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	}
+});
+//#endregion
+//#region ../api/src/sdkPageDesignEndpointDefinitions.ts
+/**
+* SDK management endpoints for a page's draft design (issue 1497), spread into
+* `ENDPOINT_DEFINITIONS` like the other endpoint-definition modules. New
+* entries here must declare `errors`, which the require-api-endpoint-errors
+* lint enforces.
+*/
+const SDK_PAGE_DESIGN_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
+	sdkGetPageDesign: {
+		path: "/sdk/{siteId}/pages/{identifier}/design",
+		method: "GET",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"resource:not_found",
+			"validation:invalid_input",
+			"server:internal_error"
+		]
+	},
+	sdkSavePageDesign: {
+		path: "/sdk/{siteId}/pages/{identifier}/design",
+		method: "POST",
+		auth: "service",
+		responseKind: "json",
+		errors: [
+			"resource:not_found",
+			"validation:invalid_input",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	}
+});
 const PUBLIC_CONTENT_FRESHNESS_SECONDS = 3600;
 function availability(transport) {
 	return {
@@ -1713,6 +1906,45 @@ const SITE_API_KEY_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 	}
 });
 //#endregion
+//#region ../api/src/siteManagementEndpointDefinitions.ts
+const SITE_MANAGEMENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
+	createSite: {
+		path: "/sites/manage",
+		method: "POST",
+		tags: ["site"],
+		auth: "user",
+		responseKind: "json"
+	},
+	updateSite: {
+		path: "/sites/manage",
+		method: "PUT",
+		tags: ["site"],
+		auth: "user",
+		responseKind: "json"
+	},
+	changeSiteAddress: {
+		path: "/sites/{siteId}/address",
+		method: "PUT",
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_BLOCKED_DISABLED
+	},
+	getSiteAddressAvailability: {
+		path: "/sites/{siteId}/address/availability",
+		method: "GET",
+		auth: "user",
+		responseKind: "json"
+	},
+	deleteSite: {
+		path: "/sites/{siteId}",
+		method: "DELETE",
+		tags: ["site", "site-{siteId}"],
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_BLOCKED_HIDDEN
+	}
+});
+//#endregion
 //#region ../api/src/eventManagementEndpointDefinitions.ts
 const EVENT_MANAGEMENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 	listEvents: {
@@ -1760,6 +1992,28 @@ const EVENT_MANAGEMENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 			"server:internal_error"
 		]
 	},
+	/**
+	* The web address of an event's own page. A course page belongs to the
+	* event itself, so its address is written here rather than through a run.
+	*/
+	updateEventAddress: {
+		path: "/sites/{siteId}/bookings/events/{eventId}/address",
+		method: "PATCH",
+		tags: [
+			"site-{siteId}",
+			"event-series-{siteId}",
+			TAG_TEMPLATES.siteRoutableContent,
+			TAG_TEMPLATES.siteRedirects
+		],
+		auth: "user",
+		responseKind: "json",
+		errors: [
+			"validation:invalid_input",
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
 	createWholeSeriesRun: {
 		path: "/sites/{siteId}/bookings/events/{eventId}/runs",
 		method: "POST",
@@ -1786,6 +2040,20 @@ const EVENT_MANAGEMENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 			"server:internal_error"
 		]
 	},
+	updateCourseBookingSettings: {
+		path: "/sites/{siteId}/bookings/events/{eventId}/booking-settings",
+		method: "PATCH",
+		tags: ["site-{siteId}", "event-series-{siteId}"],
+		auth: "user",
+		responseKind: "json",
+		errors: [
+			"validation:invalid_input",
+			"auth:forbidden",
+			"resource:not_found",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
 	cancelWholeSeriesRun: {
 		path: "/sites/{siteId}/bookings/events/{eventId}/runs/{runId}/cancellation",
 		method: "POST",
@@ -1798,6 +2066,28 @@ 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
@@ -2230,7 +2520,43 @@ const BILLING_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 		responseKind: "json"
 	}
 });
+//#endregion
+//#region ../api/src/clientErrorReporting.ts
+const CLIENT_ERROR_REPORT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({ reportClientError: {
+	path: "/client/error-report",
+	method: "POST",
+	auth: "user",
+	errors: [],
+	responseKind: "json"
+} });
+const CLIENT_ERROR_REPORT_LIMITS = {
+	pathname: 1024,
+	name: 120,
+	message: 2e3,
+	stack: 8e3,
+	digest: 128,
+	componentStack: 8e3,
+	sourceLocation: 1024
+};
+const clientErrorEventSchema = z.enum([
+	"dashboard:route-error",
+	"dashboard:app-error",
+	"client:error-boundary",
+	"client:window-error",
+	"client:unhandled-rejection"
+]);
+z.object({
+	event: clientErrorEventSchema,
+	pathname: z.string().startsWith("/").max(CLIENT_ERROR_REPORT_LIMITS.pathname),
+	name: z.string().max(CLIENT_ERROR_REPORT_LIMITS.name),
+	message: z.string().max(CLIENT_ERROR_REPORT_LIMITS.message),
+	stack: z.string().max(CLIENT_ERROR_REPORT_LIMITS.stack).nullable(),
+	digest: z.string().max(CLIENT_ERROR_REPORT_LIMITS.digest).nullable(),
+	componentStack: z.string().max(CLIENT_ERROR_REPORT_LIMITS.componentStack).nullable(),
+	sourceLocation: z.string().max(CLIENT_ERROR_REPORT_LIMITS.sourceLocation).nullable()
+}).strict();
 const API_ENDPOINTS = {
+	...CLIENT_ERROR_REPORT_ENDPOINT_DEFINITIONS,
 	...PUBLIC_NEWSLETTER_ENDPOINT_DEFINITIONS,
 	...ACCOUNT_ENDPOINT_DEFINITIONS,
 	...PUBLIC_ONBOARDING_ATTEMPT_ENDPOINT_DEFINITIONS,
@@ -2238,6 +2564,7 @@ const API_ENDPOINTS = {
 	...GIFTING_ENDPOINT_DEFINITIONS,
 	...PUBLIC_READ_ENDPOINT_DEFINITIONS,
 	...BILLING_ENDPOINT_DEFINITIONS,
+	...SITE_MANAGEMENT_ENDPOINT_DEFINITIONS,
 	aiContentUpdateChat: {
 		path: "/ai/content-update-chat",
 		method: "POST",
@@ -2764,13 +3091,6 @@ const API_ENDPOINTS = {
 		auth: "user",
 		responseKind: "json"
 	},
-	createSite: {
-		path: "/sites/manage",
-		method: "POST",
-		tags: ["site"],
-		auth: "user",
-		responseKind: "json"
-	},
 	createSiteManual: {
 		path: "/sites/manual",
 		method: "POST",
@@ -2778,21 +3098,6 @@ const API_ENDPOINTS = {
 		auth: "user",
 		responseKind: "json"
 	},
-	updateSite: {
-		path: "/sites/manage",
-		method: "PUT",
-		tags: ["site"],
-		auth: "user",
-		responseKind: "json"
-	},
-	deleteSite: {
-		path: "/sites/{siteId}",
-		method: "DELETE",
-		tags: ["site", "site-{siteId}"],
-		auth: "user",
-		responseKind: "json",
-		demoMutation: DEMO_MUTATION_BLOCKED_HIDDEN
-	},
 	listSiteMembers: {
 		path: "/sites/{siteId}/members",
 		method: "GET",
@@ -7025,6 +7330,7 @@ const API_ENDPOINTS = {
 		auth: "service",
 		responseKind: "json"
 	},
+	...SDK_PAGE_DESIGN_ENDPOINT_DEFINITIONS,
 	sdkUpsertPageBlock: {
 		path: "/sdk/{siteId}/pages/{identifier}/blocks",
 		method: "POST",
@@ -7147,87 +7453,7 @@ const API_ENDPOINTS = {
 		auth: "service",
 		responseKind: "json"
 	},
-	sdkListEvents: {
-		path: "/sdk/{siteId}/events",
-		method: "GET",
-		auth: "service",
-		responseKind: "json"
-	},
-	sdkUpsertEvent: {
-		path: "/sdk/{siteId}/events",
-		method: "POST",
-		auth: "service",
-		responseKind: "json"
-	},
-	sdkGetEvent: {
-		path: "/sdk/{siteId}/events/{identifier}",
-		method: "GET",
-		auth: "service",
-		responseKind: "json"
-	},
-	sdkDeleteEvent: {
-		path: "/sdk/{siteId}/events/{identifier}",
-		method: "DELETE",
-		auth: "service",
-		responseKind: "json"
-	},
-	sdkListEventOccurrences: {
-		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences",
-		method: "GET",
-		auth: "service",
-		responseKind: "json",
-		errors: [
-			"resource:not_found",
-			"validation:invalid_input",
-			"server:internal_error"
-		]
-	},
-	sdkAddEventOccurrence: {
-		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences",
-		method: "POST",
-		auth: "service",
-		responseKind: "json",
-		errors: [
-			"resource:not_found",
-			"validation:invalid_input",
-			"resource:conflict",
-			"server:internal_error"
-		]
-	},
-	sdkUpdateEventOccurrence: {
-		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences/{occurrenceId}",
-		method: "PATCH",
-		auth: "service",
-		responseKind: "json",
-		errors: [
-			"resource:not_found",
-			"validation:invalid_input",
-			"resource:conflict",
-			"server:internal_error"
-		]
-	},
-	sdkCancelEventOccurrence: {
-		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences/{occurrenceId}/cancel",
-		method: "POST",
-		auth: "service",
-		responseKind: "json",
-		errors: [
-			"resource:not_found",
-			"resource:conflict",
-			"server:internal_error"
-		]
-	},
-	sdkDeleteEventOccurrence: {
-		path: "/sdk/{siteId}/events/{identifier}/runs/{runIdentifier}/occurrences/{occurrenceId}",
-		method: "DELETE",
-		auth: "service",
-		responseKind: "json",
-		errors: [
-			"resource:not_found",
-			"resource:conflict",
-			"server:internal_error"
-		]
-	},
+	...SDK_EVENT_ENDPOINT_DEFINITIONS,
 	sdkUpsertEntry: {
 		path: "/sdk/{siteId}/entries",
 		method: "POST",