@riverbankcms/sdk 0.138.0 → 0.139.0

package/dist/preview-next/middleware.mjs

@@ -981,14 +981,117 @@ const NEWSLETTER_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 		responseKind: "json",
 		errors: ["auth:forbidden", "server:internal_error"]
 	},
-	getMailchimpSignupSyncHealth: {
-		path: "/sites/{siteId}/integrations/mailchimp/signup-sync-health",
+	getMailingListSetup: {
+		path: "/sites/{siteId}/mailing-list/setup",
+		method: "GET",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		errors: ["auth:forbidden", "server:internal_error"]
+	},
+	getMailingListAuthoringContext: {
+		path: "/sites/{siteId}/mailing-list/authoring-context",
+		method: "GET",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		errors: ["auth:forbidden", "server:internal_error"]
+	},
+	previewMailingListSetupChange: {
+		path: "/sites/{siteId}/mailing-list/setup/preview",
+		method: "POST",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_ALLOWED,
+		errors: [
+			"auth:forbidden",
+			"validation:invalid_input",
+			"server:internal_error"
+		]
+	},
+	applyMailingListSetupChange: {
+		path: "/sites/{siteId}/mailing-list/setup",
+		method: "PUT",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_BLOCKED_DISABLED,
+		errors: [
+			"auth:forbidden",
+			"validation:invalid_input",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
+	getMailingListProviderCatalog: {
+		path: "/sites/{siteId}/mailing-list/providers/{provider}/catalog",
+		method: "GET",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		errors: [
+			"auth:forbidden",
+			"validation:invalid_input",
+			"server:internal_error"
+		]
+	},
+	refreshMailingListProviderCatalog: {
+		path: "/sites/{siteId}/mailing-list/providers/{provider}/catalog/refresh",
+		method: "POST",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_BLOCKED_DISABLED,
+		errors: [
+			"auth:forbidden",
+			"validation:invalid_input",
+			"server:internal_error"
+		]
+	},
+	getMailingListProviderHealth: {
+		path: "/sites/{siteId}/mailing-list/health",
+		method: "GET",
+		tags: [TAG_TEMPLATES.site, TAG_TEMPLATES.siteNewsletter],
+		auth: "user",
+		responseKind: "json",
+		errors: ["auth:forbidden", "server:internal_error"]
+	},
+	getBrevoConnection: {
+		path: "/sites/{siteId}/integrations/brevo/connection",
 		method: "GET",
 		tags: [TAG_TEMPLATES.site],
 		auth: "user",
 		responseKind: "json",
 		errors: ["auth:forbidden", "server:internal_error"]
 	},
+	connectBrevo: {
+		path: "/sites/{siteId}/integrations/brevo/connection",
+		method: "PUT",
+		tags: [TAG_TEMPLATES.site],
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_BLOCKED_DISABLED,
+		errors: [
+			"auth:forbidden",
+			"validation:invalid_input",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
+	disconnectBrevo: {
+		path: "/sites/{siteId}/integrations/brevo/disconnect",
+		method: "POST",
+		tags: [TAG_TEMPLATES.site],
+		auth: "user",
+		responseKind: "json",
+		demoMutation: DEMO_MUTATION_BLOCKED_DISABLED,
+		errors: [
+			"auth:forbidden",
+			"resource:conflict",
+			"server:internal_error"
+		]
+	},
 	getMailchimpConnection: {
 		path: "/sites/{siteId}/integrations/mailchimp/connection",
 		method: "GET",
@@ -1211,6 +1314,56 @@ const NEWSLETTER_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 		responseKind: "json"
 	}
 });
+const PUBLIC_CONTENT_FRESHNESS_SECONDS = 3600;
+function availability(transport) {
+	return {
+		kind: "live",
+		reason: "booking_correctness",
+		freshness: "availability",
+		transport
+	};
+}
+function content(tags, transport = "direct") {
+	return {
+		kind: "tagged",
+		tags,
+		freshness: "content",
+		transport
+	};
+}
+/** The single classification authority for cacheable public reads. */
+const PUBLIC_READ_CACHE_POLICIES = {
+	listPublishedEntries: content(["published_content"]),
+	getPublishedEntryPreview: content(["published_content"]),
+	listPublicEvents: availability("direct"),
+	listPublicEventCalendarWindow: availability("direct"),
+	listPublicRecurringSchedule: availability("batch_only"),
+	getPublicEventDetails: availability("batch_only"),
+	resolveEventSubroute: availability("direct"),
+	listPublicRouteCandidates: content(["published_content"], "batch_only"),
+	listPublicTeamMembers: content(["public_team_members"]),
+	listPublicProducts: availability("direct"),
+	listPublicPasses: availability("direct"),
+	listPublicMemberships: availability("direct"),
+	getPublicFormById: content(["site_forms"]),
+	getPublicBookingServices: availability("direct"),
+	getPublicBookingService: availability("direct"),
+	getPublicBookingResourcesReference: availability("direct"),
+	getPublicBookingAvailableDates: availability("direct"),
+	getPublicBookingAvailableSlots: availability("direct"),
+	getPublicWeeklySlotAvailability: availability("direct"),
+	listPublicForms: content(["site_forms"]),
+	checkRedirect: content([]),
+	getPublicRoutableContent: content(["published_content"]),
+	getPublicSitemapRoutes: content(["published_content"])
+};
+new Set(Object.keys(PUBLIC_READ_CACHE_POLICIES));
+function getPublicReadCachePolicy(endpoint) {
+	return PUBLIC_READ_CACHE_POLICIES[endpoint];
+}
+function publicReadFreshnessSeconds(endpoint) {
+	return getPublicReadCachePolicy(endpoint).freshness === "availability" ? 60 : PUBLIC_CONTENT_FRESHNESS_SECONDS;
+}
 //#endregion
 //#region ../api/src/publicEventEndpointDefinitions.ts
 const PUBLIC_EVENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
@@ -1244,7 +1397,7 @@ const PUBLIC_EVENT_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 	resolveEventSubroute: {
 		path: "/public/sites/{siteId}/events/subroutes/resolve",
 		method: "GET",
-		revalidate: 60,
+		revalidate: publicReadFreshnessSeconds("resolveEventSubroute"),
 		tags: [TAG_TEMPLATES.publicEvents, "event-subroute"],
 		auth: "public",
 		responseKind: "json",
@@ -1297,7 +1450,7 @@ const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS = defineEndpointDefinitio
 	getPublicBookingServices: {
 		path: "/public/bookings/services",
 		method: "GET",
-		revalidate: 60,
+		revalidate: publicReadFreshnessSeconds("getPublicBookingServices"),
 		tags: [TAG_TEMPLATES.publicBookingServices],
 		auth: "public",
 		responseKind: "json"
@@ -1305,7 +1458,7 @@ const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS = defineEndpointDefinitio
 	getPublicBookingService: {
 		path: "/public/bookings/services/{serviceId}",
 		method: "GET",
-		revalidate: 60,
+		revalidate: publicReadFreshnessSeconds("getPublicBookingService"),
 		tags: [TAG_TEMPLATES.publicBookingServices],
 		auth: "public",
 		responseKind: "json"
@@ -1313,7 +1466,7 @@ const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS = defineEndpointDefinitio
 	getPublicBookingResourcesReference: {
 		path: "/public/bookings/resources/reference",
 		method: "GET",
-		revalidate: 60,
+		revalidate: publicReadFreshnessSeconds("getPublicBookingResourcesReference"),
 		tags: [TAG_TEMPLATES.publicBookingServices],
 		auth: "public",
 		responseKind: "json"
@@ -1321,7 +1474,7 @@ const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS = defineEndpointDefinitio
 	getPublicBookingAvailableDates: {
 		path: "/public/bookings/availability/dates",
 		method: "GET",
-		revalidate: 60,
+		revalidate: publicReadFreshnessSeconds("getPublicBookingAvailableDates"),
 		tags: [TAG_TEMPLATES.publicBookingAvailability, TAG_TEMPLATES.publicBookingServices],
 		auth: "public",
 		responseKind: "json"
@@ -1329,7 +1482,7 @@ const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS = defineEndpointDefinitio
 	getPublicBookingAvailableSlots: {
 		path: "/public/bookings/availability/slots",
 		method: "GET",
-		revalidate: 60,
+		revalidate: publicReadFreshnessSeconds("getPublicBookingAvailableSlots"),
 		tags: [TAG_TEMPLATES.publicBookingAvailability, TAG_TEMPLATES.publicBookingServices],
 		auth: "public",
 		responseKind: "json"
@@ -1337,7 +1490,7 @@ const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS = defineEndpointDefinitio
 	getPublicWeeklySlotAvailability: {
 		path: "/public/bookings/weekly-slot-availability",
 		method: "GET",
-		revalidate: 60,
+		revalidate: publicReadFreshnessSeconds("getPublicWeeklySlotAvailability"),
 		tags: [TAG_TEMPLATES.publicBookingAvailability, TAG_TEMPLATES.publicBookingServices],
 		auth: "public",
 		responseKind: "json",
@@ -1787,10 +1940,86 @@ const SDK_MEDIA_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
 		responseKind: "json"
 	}
 });
+//#endregion
+//#region ../api/src/publicReadEndpointDefinitions.ts
+/**
+* Direct public reads governed by the canonical public-read freshness policy.
+* Keeping these definitions together makes the endpoint identity used to
+* derive freshness reviewable beside its route and tags.
+*/
+const PUBLIC_READ_ENDPOINT_DEFINITIONS = defineEndpointDefinitions({
+	getPublishedEntryPreview: {
+		path: "/public/content/{siteId}/{type}/{slug}/preview",
+		method: "GET",
+		revalidate: publicReadFreshnessSeconds("getPublishedEntryPreview"),
+		tags: ["content-{siteId}-{type}-{slug}"],
+		auth: "public",
+		responseKind: "json"
+	},
+	listPublishedEntries: {
+		path: "/public/content/{siteId}/{type}/entries",
+		method: "GET",
+		revalidate: publicReadFreshnessSeconds("listPublishedEntries"),
+		tags: ["content-{siteId}-{type}"],
+		auth: "public",
+		responseKind: "json"
+	},
+	getPublicFormById: {
+		path: "/public/forms/{formId}",
+		method: "GET",
+		revalidate: publicReadFreshnessSeconds("getPublicFormById"),
+		tags: [TAG_TEMPLATES.formById],
+		auth: "public",
+		responseKind: "json"
+	},
+	listPublicEvents: {
+		path: "/public/sites/{siteId}/events",
+		method: "GET",
+		revalidate: publicReadFreshnessSeconds("listPublicEvents"),
+		tags: [TAG_TEMPLATES.publicEvents],
+		auth: "public",
+		responseKind: "json"
+	},
+	listPublicTeamMembers: {
+		path: "/public/sites/{siteId}/team-members",
+		method: "GET",
+		revalidate: publicReadFreshnessSeconds("listPublicTeamMembers"),
+		tags: [TAG_TEMPLATES.publicTeamMembers],
+		errors: [],
+		auth: "public",
+		responseKind: "json"
+	},
+	listPublicPasses: {
+		path: "/public/sites/{siteId}/bookings/products/passes",
+		method: "GET",
+		revalidate: publicReadFreshnessSeconds("listPublicPasses"),
+		tags: [TAG_TEMPLATES.publicPasses],
+		auth: "public",
+		responseKind: "json"
+	},
+	listPublicMemberships: {
+		path: "/public/sites/{siteId}/bookings/products/memberships",
+		method: "GET",
+		revalidate: publicReadFreshnessSeconds("listPublicMemberships"),
+		tags: [TAG_TEMPLATES.publicMemberships],
+		auth: "public",
+		responseKind: "json"
+	},
+	listPublicProducts: {
+		path: "/public/sites/{siteId}/products",
+		method: "GET",
+		revalidate: publicReadFreshnessSeconds("listPublicProducts"),
+		tags: [TAG_TEMPLATES.publicProducts],
+		errors: [],
+		auth: "public",
+		responseKind: "json"
+	}
+});
 const API_ENDPOINTS = {
 	...ACCOUNT_ENDPOINT_DEFINITIONS,
 	...PUBLIC_EVENT_ENDPOINT_DEFINITIONS,
 	...GIFTING_ENDPOINT_DEFINITIONS,
+	...PUBLIC_READ_ENDPOINT_DEFINITIONS,
 	aiContentUpdateChat: {
 		path: "/ai/content-update-chat",
 		method: "POST",
@@ -3793,13 +4022,6 @@ const API_ENDPOINTS = {
 		auth: "user",
 		responseKind: "json"
 	},
-	createNavigationMenu: {
-		path: "/sites/{siteId}/navigation/menus",
-		method: "POST",
-		tags: [TAG_TEMPLATES.siteCollection, TAG_TEMPLATES.siteNavigation],
-		auth: "user",
-		responseKind: "json"
-	},
 	getNavigationMenuItems: {
 		path: "/sites/{siteId}/navigation/menus/{menuId}",
 		method: "GET",
@@ -3811,28 +4033,6 @@ const API_ENDPOINTS = {
 		auth: "user",
 		responseKind: "json"
 	},
-	updateNavigationMenu: {
-		path: "/sites/{siteId}/navigation/menus/{menuId}",
-		method: "PATCH",
-		tags: [
-			TAG_TEMPLATES.siteCollection,
-			TAG_TEMPLATES.siteNavigation,
-			TAG_TEMPLATES.navigationMenuById
-		],
-		auth: "user",
-		responseKind: "json"
-	},
-	deleteNavigationMenu: {
-		path: "/sites/{siteId}/navigation/menus/{menuId}",
-		method: "DELETE",
-		tags: [
-			TAG_TEMPLATES.siteCollection,
-			TAG_TEMPLATES.siteNavigation,
-			TAG_TEMPLATES.navigationMenuById
-		],
-		auth: "user",
-		responseKind: "json"
-	},
 	createNavigationItem: {
 		path: "/sites/{siteId}/navigation/menus/{menuId}/items",
 		method: "POST",
@@ -3903,22 +4103,6 @@ const API_ENDPOINTS = {
 		auth: "public",
 		responseKind: "json"
 	},
-	getPublishedEntryPreview: {
-		path: "/public/content/{siteId}/{type}/{slug}/preview",
-		method: "GET",
-		revalidate: 60,
-		tags: ["content-{siteId}-{type}-{slug}"],
-		auth: "public",
-		responseKind: "json"
-	},
-	listPublishedEntries: {
-		path: "/public/content/{siteId}/{type}/entries",
-		method: "GET",
-		revalidate: 60,
-		tags: ["content-{siteId}-{type}"],
-		auth: "public",
-		responseKind: "json"
-	},
 	getPublishedPostPreview: {
 		path: "/public/posts/{siteId}/{slug}/preview",
 		method: "GET",
@@ -4642,14 +4826,6 @@ const API_ENDPOINTS = {
 		auth: "public",
 		responseKind: "json"
 	},
-	getPublicFormById: {
-		path: "/public/forms/{formId}",
-		method: "GET",
-		revalidate: 60,
-		tags: [TAG_TEMPLATES.formById],
-		auth: "public",
-		responseKind: "json"
-	},
 	listPublicForms: {
 		path: "/public/sites/{siteId}/forms",
 		method: "GET",
@@ -4932,14 +5108,6 @@ const API_ENDPOINTS = {
 		auth: "service",
 		responseKind: "json"
 	},
-	listPublicEvents: {
-		path: "/public/sites/{siteId}/events",
-		method: "GET",
-		revalidate: 60,
-		tags: [TAG_TEMPLATES.publicEvents],
-		auth: "public",
-		responseKind: "json"
-	},
 	getPublicEventFilters: {
 		path: "/public/sites/{siteId}/events/filters",
 		method: "GET",
@@ -4948,15 +5116,6 @@ const API_ENDPOINTS = {
 		auth: "public",
 		responseKind: "json"
 	},
-	listPublicTeamMembers: {
-		path: "/public/sites/{siteId}/team-members",
-		method: "GET",
-		revalidate: 60,
-		tags: [TAG_TEMPLATES.publicTeamMembers],
-		errors: [],
-		auth: "public",
-		responseKind: "json"
-	},
 	resolveWaitlistClaim: {
 		path: "/public/sites/{siteId}/waitlists/claim/resolve",
 		method: "POST",
@@ -4970,31 +5129,6 @@ const API_ENDPOINTS = {
 			"server:internal_error"
 		]
 	},
-	listPublicPasses: {
-		path: "/public/sites/{siteId}/bookings/products/passes",
-		method: "GET",
-		revalidate: 300,
-		tags: [TAG_TEMPLATES.publicPasses],
-		auth: "public",
-		responseKind: "json"
-	},
-	listPublicMemberships: {
-		path: "/public/sites/{siteId}/bookings/products/memberships",
-		method: "GET",
-		revalidate: 300,
-		tags: [TAG_TEMPLATES.publicMemberships],
-		auth: "public",
-		responseKind: "json"
-	},
-	listPublicProducts: {
-		path: "/public/sites/{siteId}/products",
-		method: "GET",
-		revalidate: 300,
-		tags: [TAG_TEMPLATES.publicProducts],
-		errors: [],
-		auth: "public",
-		responseKind: "json"
-	},
 	createShopCheckout: {
 		path: "/public/sites/{siteId}/bookings/checkout",
 		method: "POST",
@@ -6823,13 +6957,6 @@ const API_ENDPOINTS = {
 		auth: "service",
 		responseKind: "json"
 	},
-	sdkDeleteNavigationMenu: {
-		path: "/sdk/{siteId}/navigation/{menuId}",
-		method: "DELETE",
-		auth: "service",
-		responseKind: "json",
-		errors: ["resource:not_found", "server:internal_error"]
-	},
 	sdkUpsertTheme: {
 		path: "/sdk/{siteId}/theme",
 		method: "POST",