@remit/backend 0.0.94 → 0.0.96

package/src/response.ts

@@ -7,23 +7,50 @@ import {
 	resolveAllowedOrigin,
 } from "./request-context.js";
 
-export const formatResponse = (
-	body: Record<string, unknown>,
-	statusCode = 200,
-): APIGatewayProxyResult => {
-	if (body.statusCode && typeof body.statusCode === "number") {
-		statusCode = body.statusCode;
-	}
-
-	if ("body" in body && body.body && typeof body.body === "object") {
-		body = body.body as Record<string, unknown>;
-	}
+const RAW_API_RESPONSE: unique symbol = Symbol("remit.rawApiResponse");
+
+/**
+ * A response whose bytes are not JSON — an iCalendar feed, and whatever later
+ * joins it.
+ *
+ * Every other handler returns a plain object and lets this module decide the
+ * status, the content type and the serialization. That is the right default and
+ * stays the default; a handler that has to own its own media type says so with
+ * `rawApiResponse` rather than by returning a shape this one has to guess at.
+ * The CORS and correlation headers are still added here, so a raw response is
+ * not a way around them.
+ */
+export interface RawApiResponse {
+	statusCode: number;
+	headers: Record<string, string>;
+	body: string;
+}
+
+type MarkedRawApiResponse = RawApiResponse & {
+	readonly [RAW_API_RESPONSE]: true;
+};
 
-	logger.debug({ statusCode }, "response");
+export const rawApiResponse = (
+	response: RawApiResponse,
+): MarkedRawApiResponse =>
+	Object.assign(response, { [RAW_API_RESPONSE]: true as const });
 
+const isRawApiResponse = (
+	body: Record<string, unknown>,
+): body is MarkedRawApiResponse & Record<string, unknown> =>
+	RAW_API_RESPONSE in body;
+
+/**
+ * The headers every response carries whatever its body is: the CORS grant the
+ * browser needs, and the id the request's log lines are already tagged with.
+ * Returning that id is what makes a bug report's "correlation id" resolve to a
+ * server-side line; the browser can only read a non-safelisted header when it
+ * is exposed.
+ */
+const envelopeHeaders = (): Record<string, string> => {
 	const allowOrigin = resolveAllowedOrigin(getRequestOrigin());
 
-	const corsHeaders: Record<string, string> = {
+	const headers: Record<string, string> = {
 		"Access-Control-Allow-Origin": allowOrigin,
 		"Access-Control-Allow-Headers": "Authorization,Content-Type",
 		"Access-Control-Allow-Methods": "GET,POST,PUT,PATCH,DELETE,OPTIONS",
@@ -31,26 +58,46 @@ export const formatResponse = (
 	};
 
 	if (allowOrigin !== "*") {
-		corsHeaders["Access-Control-Allow-Credentials"] = "true";
+		headers["Access-Control-Allow-Credentials"] = "true";
 	}
 
-	// The id the request's log lines are already tagged with. Returning it is
-	// what makes a bug report's "correlation id" resolve to a server-side line;
-	// the browser can only read a non-safelisted header when it is exposed.
 	const correlationId = getRequestCorrelationId();
-	const correlationHeaders: Record<string, string> = correlationId
-		? {
-				"x-correlation-id": correlationId,
-				"Access-Control-Expose-Headers": "x-correlation-id",
-			}
-		: {};
+	if (correlationId) {
+		headers["x-correlation-id"] = correlationId;
+		headers["Access-Control-Expose-Headers"] = "x-correlation-id";
+	}
+
+	return headers;
+};
+
+export const formatResponse = (
+	body: Record<string, unknown>,
+	statusCode = 200,
+): APIGatewayProxyResult => {
+	if (body.statusCode && typeof body.statusCode === "number") {
+		statusCode = body.statusCode;
+	}
+
+	if (isRawApiResponse(body)) {
+		logger.debug({ statusCode: body.statusCode }, "response");
+		return {
+			statusCode: body.statusCode,
+			headers: { ...envelopeHeaders(), ...body.headers },
+			body: body.body,
+		};
+	}
+
+	if ("body" in body && body.body && typeof body.body === "object") {
+		body = body.body as Record<string, unknown>;
+	}
+
+	logger.debug({ statusCode }, "response");
 
 	return {
 		statusCode: statusCode,
 		headers: {
 			"Content-Type": "application/json",
-			...corsHeaders,
-			...correlationHeaders,
+			...envelopeHeaders(),
 		},
 		body: JSON.stringify(body),
 	};

package/src/service/compose-sqlite.ts

@@ -6,6 +6,7 @@ import {
 	AddressRepo,
 	CalendarCollectionRepo,
 	CalendarEventIndexRepo,
+	CalendarFeedTokenRepo,
 	CalendarObjectRepo,
 	CalendarSuggestionRepo,
 	ConfigImportRepo,
@@ -86,6 +87,7 @@ export const buildSqliteClient = async (): Promise<RemitClient> => {
 		calendarCollection: new CalendarCollectionRepo(genericDb),
 		calendarObject: new CalendarObjectRepo(genericDb),
 		calendarEventIndex: new CalendarEventIndexRepo(genericDb),
+		calendarFeedToken: new CalendarFeedTokenRepo(genericDb),
 		calendarSuggestion: new CalendarSuggestionRepo(genericDb),
 		calendarUnitOfWork: new DrizzleCalendarUnitOfWork(genericDb),
 		unitOfWork: new DrizzleUnitOfWork(messageDataDb),

package/src/service/create-remit-client.ts

@@ -6,6 +6,7 @@ import type {
 	IAddressRepository,
 	ICalendarCollectionRepository,
 	ICalendarEventIndexRepository,
+	ICalendarFeedTokenRepository,
 	ICalendarObjectRepository,
 	ICalendarSuggestionRepository,
 	ICalendarUnitOfWork,
@@ -130,6 +131,7 @@ export interface RemitClient {
 	calendarCollection: ICalendarCollectionRepository;
 	calendarObject: ICalendarObjectRepository;
 	calendarEventIndex: ICalendarEventIndexRepository;
+	calendarFeedToken: ICalendarFeedTokenRepository;
 	calendarSuggestion: ICalendarSuggestionRepository;
 	calendarUnitOfWork: ICalendarUnitOfWork;
 
@@ -225,6 +227,7 @@ export interface RemitClientRepositories {
 	calendarCollection: ICalendarCollectionRepository;
 	calendarObject: ICalendarObjectRepository;
 	calendarEventIndex: ICalendarEventIndexRepository;
+	calendarFeedToken: ICalendarFeedTokenRepository;
 	calendarSuggestion: ICalendarSuggestionRepository;
 	calendarUnitOfWork: ICalendarUnitOfWork;
 	unitOfWork?: IUnitOfWork;
@@ -466,6 +469,7 @@ export const createRemitClient = (deps: RemitClientDeps): RemitClient => {
 		calendarCollection: repositories.calendarCollection,
 		calendarObject: repositories.calendarObject,
 		calendarEventIndex: repositories.calendarEventIndex,
+		calendarFeedToken: repositories.calendarFeedToken,
 		calendarSuggestion: repositories.calendarSuggestion,
 		calendarUnitOfWork: repositories.calendarUnitOfWork,
 		unitOfWork: repositories.unitOfWork,

package/src/types.ts

@@ -63,6 +63,10 @@ export type OperationIds =
 	| "CalendarDetailOperations_getCalendar"
 	| "CalendarDetailOperations_updateCalendar"
 	| "CalendarDetailOperations_deleteCalendar"
+	| "CalendarDetailOperations_getCalendarFeed"
+	| "CalendarDetailOperations_putCalendarFeed"
+	| "CalendarDetailOperations_revokeCalendarFeed"
+	| "CalendarFeedOperations_getCalendarFeedIcal"
 	| "CalendarEventOperations_listCalendarEvents"
 	| "CalendarEventOperations_createCalendarEvent"
 	| "CalendarEventDetailOperations_getCalendarEvent"
@@ -180,6 +184,26 @@ export type CalendarDetailOperationIds = MatchPrefix<
 	OperationIds
 >;
 
+/**
+ * The feed sub-resource of `/calendars/{calendarId}`, handled beside the
+ * collection itself rather than inside it: minting a credential and serving one
+ * calendar's settings are different jobs on the same path.
+ */
+export type CalendarFeedDetailOperationIds =
+	| "CalendarDetailOperations_getCalendarFeed"
+	| "CalendarDetailOperations_putCalendarFeed"
+	| "CalendarDetailOperations_revokeCalendarFeed";
+
+export type CalendarCollectionDetailOperationIds = Exclude<
+	CalendarDetailOperationIds,
+	CalendarFeedDetailOperationIds
+>;
+
+export type CalendarFeedOperationIds = MatchPrefix<
+	"CalendarFeedOperations_",
+	OperationIds
+>;
+
 export type CalendarEventOperationIds = MatchPrefix<
 	"CalendarEventOperations_",
 	OperationIds