@remit/calendar-service 0.0.18 → 0.0.20

package/src/project.ts

@@ -1,122 +0,0 @@
-import type { CalendarObjectItem } from "@remit/data-ports";
-import { CalendarEventStatus, CalendarTransparency } from "@remit/domain-enums";
-import ICAL from "ical.js";
-import { type CalendarResult, calendarFailure } from "./errors.js";
-import type { ParsedCalendar } from "./parse.js";
-import { resolveTime, tzidOf } from "./time.js";
-
-/**
- * The columns `CalendarObject` carries beside its bytes. Every one of them is
- * read out of the VEVENT here and nowhere else, so the row can only ever
- * describe the `icalData` it was written with.
- */
-export type CalendarObjectProjection = Pick<
-	CalendarObjectItem,
-	| "icalUid"
-	| "summary"
-	| "dtStart"
-	| "dtEnd"
-	| "allDay"
-	| "zoneCertainty"
-	| "status"
-	| "transparency"
-	| "hasRecurrence"
-	| "sequence"
->;
-
-const STATUS_BY_ICAL: Record<string, CalendarObjectItem["status"]> = {
-	CONFIRMED: CalendarEventStatus.Confirmed,
-	TENTATIVE: CalendarEventStatus.Tentative,
-	CANCELLED: CalendarEventStatus.Cancelled,
-};
-
-const TRANSPARENCY_BY_ICAL: Record<string, CalendarObjectItem["transparency"]> =
-	{
-		OPAQUE: CalendarTransparency.Opaque,
-		TRANSPARENT: CalendarTransparency.Transparent,
-	};
-
-export const readString = (component: ICAL.Component, name: string): string => {
-	const value = component.getFirstPropertyValue(name);
-	return typeof value === "string" ? value : "";
-};
-
-/**
- * The fields that describe one VEVENT rather than the series it belongs to.
- *
- * Read per occurrence as well as per resource: an override VEVENT carries its
- * own summary, status and transparency, and a range read that took them from
- * the master would draw the old title over an edited instance and count a
- * cancelled one as busy time.
- */
-export type CalendarEventDisplay = Pick<
-	CalendarObjectItem,
-	"summary" | "status" | "transparency"
->;
-
-export const projectEventDisplay = (
-	component: ICAL.Component,
-): CalendarEventDisplay => ({
-	summary: readString(component, "summary"),
-	status:
-		STATUS_BY_ICAL[readString(component, "status").toUpperCase()] ??
-		CalendarEventStatus.Confirmed,
-	transparency:
-		TRANSPARENCY_BY_ICAL[readString(component, "transp").toUpperCase()] ??
-		CalendarTransparency.Opaque,
-});
-
-/**
- * Whether the resource expands to more than its master instance — an RRULE, an
- * RDATE, or an override VEVENT. The overrides count: a client that edits one
- * instance of a series and then deletes the rule leaves a resource with nothing
- * but a master and its exceptions, and every one of those is still an
- * occurrence somebody has to see.
- */
-export const hasRecurrence = (calendar: ParsedCalendar): boolean =>
-	calendar.master.hasProperty("rrule") ||
-	calendar.master.hasProperty("rdate") ||
-	calendar.overrides.length > 0;
-
-export const projectCalendar = (
-	calendar: ParsedCalendar,
-	collectionTimezone: string,
-): CalendarResult<CalendarObjectProjection> => {
-	const event = new ICAL.Event(calendar.master);
-	const start = resolveTime(
-		event.startDate,
-		tzidOf(calendar.master.getFirstProperty("dtstart")),
-		collectionTimezone,
-	);
-	const end = resolveTime(
-		event.endDate,
-		tzidOf(
-			calendar.master.getFirstProperty("dtend") ??
-				calendar.master.getFirstProperty("dtstart"),
-		),
-		collectionTimezone,
-	);
-
-	if (end.instantMs < start.instantMs) {
-		return calendarFailure(
-			"BackwardsEnd",
-			`the event ends at ${end.isoUtc}, before it starts at ${start.isoUtc}`,
-		);
-	}
-
-	const sequence = calendar.master.getFirstPropertyValue("sequence");
-
-	return {
-		ok: true,
-		value: {
-			icalUid: calendar.uid,
-			dtStart: start.isoOffset,
-			dtEnd: end.isoOffset,
-			allDay: start.isDate,
-			zoneCertainty: start.certainty,
-			...projectEventDisplay(calendar.master),
-			hasRecurrence: hasRecurrence(calendar),
-			sequence: typeof sequence === "number" ? sequence : 0,
-		},
-	};
-};

package/src/put.test.ts

@@ -1,318 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { computeEtag } from "./etag.js";
-import { asLf, singleEvent } from "./fixtures.js";
-import { MemoryCalendarStore, MissingRow } from "./memory-store.js";
-import { parseCalendar, serializeCalendar } from "./parse.js";
-import {
-	DEFAULT_CALENDAR_URL_SEGMENT,
-	deleteCalendarObject,
-	provisionDefaultCalendar,
-	putCalendarObject,
-} from "./put.js";
-
-const ACCOUNT_CONFIG_ID = "account-config-1";
-
-const provisioned = async (): Promise<{
-	store: MemoryCalendarStore;
-	calendarId: string;
-}> => {
-	const store = new MemoryCalendarStore();
-	const collection = await provisionDefaultCalendar(store, ACCOUNT_CONFIG_ID);
-	return { store, calendarId: collection.calendarId };
-};
-
-const RESOURCE = singleEvent(
-	"DTSTART:20260826T090000Z",
-	"DTEND:20260826T100000Z",
-	"SUMMARY:Quarterly review",
-);
-
-describe("provisionDefaultCalendar", () => {
-	it("gives an account config a default collection at the default segment", async () => {
-		const store = new MemoryCalendarStore();
-
-		const collection = await provisionDefaultCalendar(store, ACCOUNT_CONFIG_ID);
-
-		assert.equal(collection.urlSegment, DEFAULT_CALENDAR_URL_SEGMENT);
-		assert.equal(collection.source, "Default");
-		assert.equal(collection.displayName, "Calendar");
-	});
-
-	it("returns the same collection on a second first use", async () => {
-		const store = new MemoryCalendarStore();
-
-		const first = await provisionDefaultCalendar(store, ACCOUNT_CONFIG_ID);
-		const second = await provisionDefaultCalendar(store, ACCOUNT_CONFIG_ID);
-
-		assert.equal(second.calendarId, first.calendarId);
-		assert.equal(store.collections.size, 1);
-	});
-});
-
-describe("putCalendarObject", () => {
-	it("stores the bytes it was given, untouched", async () => {
-		const { store, calendarId } = await provisioned();
-
-		const result = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "review.ics",
-			icalData: RESOURCE,
-		});
-
-		assert.ok(result.ok);
-		assert.equal(result.value.icalData, RESOURCE);
-		assert.equal(result.value.summary, "Quarterly review");
-		assert.equal(result.value.icalUid, "fixture@example.com");
-	});
-
-	it("stores the input bytes rather than a reserialization of them", async () => {
-		// The etag is a digest of what the writer sent. ical.js refolds and
-		// reorders on serialize, so a write path that stored its own
-		// reserialization would hand back a tag for bytes nobody wrote, and every
-		// client's cached copy would miss on the next read.
-		const { store, calendarId } = await provisioned();
-		const source = singleEvent(
-			"DTSTART:20260826T090000Z",
-			"DTEND:20260826T100000Z",
-			"SUMMARY:A summary long enough that RFC 5545 line folding rewrites it when ical.js serializes the event again",
-			"X-MICROSOFT-CDO-BUSYSTATUS:BUSY",
-		);
-		const parsed = await parseCalendar(source);
-		assert.ok(parsed.ok);
-		const reserialized = serializeCalendar(parsed.value.component);
-		assert.notEqual(
-			reserialized,
-			source,
-			"the fixture survives reserialization unchanged, so it proves nothing",
-		);
-
-		const result = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "folded.ics",
-			icalData: source,
-		});
-
-		assert.ok(result.ok);
-		assert.equal(result.value.icalData, source);
-		assert.equal(result.value.etag, computeEtag(source));
-		assert.notEqual(result.value.etag, computeEtag(reserialized));
-	});
-
-	it("stores an LF-only resource as it arrived, without normalizing it", async () => {
-		// The store keeps what the writer sent. Rewriting line endings on the way
-		// in would give the resource an etag for bytes nobody wrote, and the
-		// writer's own If-Match would miss on its very next request.
-		const { store, calendarId } = await provisioned();
-		const source = asLf(RESOURCE);
-
-		const result = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "lf.ics",
-			icalData: source,
-		});
-
-		assert.ok(result.ok);
-		assert.equal(result.value.icalData, source);
-		assert.ok(!result.value.icalData.includes("\r"));
-		assert.equal(result.value.etag, computeEtag(source));
-		assert.equal(result.value.summary, "Quarterly review");
-		assert.equal(result.value.dtStart, "2026-08-26T09:00:00+00:00");
-	});
-
-	it("writes the occurrence rows the resource expands to", async () => {
-		const { store, calendarId } = await provisioned();
-
-		const result = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "series.ics",
-			icalData: singleEvent(
-				"DTSTART:20260826T090000Z",
-				"DTEND:20260826T100000Z",
-				"RRULE:FREQ=WEEKLY;COUNT=3",
-			),
-		});
-
-		assert.ok(result.ok);
-		assert.equal(
-			store.occurrences.get(result.value.calendarObjectId)?.length,
-			3,
-		);
-	});
-
-	it("replaces the occurrences of a resource it rewrites", async () => {
-		const { store, calendarId } = await provisioned();
-		const input = {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "series.ics",
-		};
-
-		await putCalendarObject(store, {
-			...input,
-			icalData: singleEvent(
-				"DTSTART:20260826T090000Z",
-				"DTEND:20260826T100000Z",
-				"RRULE:FREQ=WEEKLY;COUNT=5",
-			),
-		});
-		const result = await putCalendarObject(store, {
-			...input,
-			icalData: singleEvent(
-				"DTSTART:20260826T090000Z",
-				"DTEND:20260826T100000Z",
-				"RRULE:FREQ=WEEKLY;COUNT=2",
-			),
-		});
-
-		assert.ok(result.ok);
-		assert.equal(store.objects.size, 1);
-		assert.equal(
-			store.occurrences.get(result.value.calendarObjectId)?.length,
-			2,
-		);
-	});
-
-	it("stamps the collection's new sequence on the resource it wrote", async () => {
-		const { store, calendarId } = await provisioned();
-
-		const first = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "one.ics",
-			icalData: RESOURCE,
-		});
-		const second = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "two.ics",
-			icalData: singleEvent(
-				"DTSTART:20260827T090000Z",
-				"DTEND:20260827T100000Z",
-			),
-		});
-
-		assert.ok(first.ok);
-		assert.ok(second.ok);
-		assert.equal(first.value.syncSequence, 1);
-		assert.equal(second.value.syncSequence, 2);
-		assert.equal(store.collections.get(calendarId)?.syncSequence, 2);
-	});
-
-	it("computes the etag over the stored bytes", async () => {
-		const { store, calendarId } = await provisioned();
-
-		const result = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "review.ics",
-			icalData: RESOURCE,
-		});
-
-		assert.ok(result.ok);
-		assert.match(result.value.etag, /^[0-9a-f]{64}$/);
-	});
-
-	it("refuses a resource the collection does not store, and writes nothing", async () => {
-		const { store, calendarId } = await provisioned();
-
-		const result = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "todo.ics",
-			icalData: [
-				"BEGIN:VCALENDAR",
-				"VERSION:2.0",
-				"BEGIN:VTODO",
-				"UID:todo@example.com",
-				"END:VTODO",
-				"END:VCALENDAR",
-				"",
-			].join("\r\n"),
-		});
-
-		assert.ok(!result.ok);
-		assert.equal(result.error.code, "UnsupportedComponent");
-		assert.equal(store.objects.size, 0);
-		assert.equal(store.collections.get(calendarId)?.syncSequence, 0);
-	});
-
-	it("refuses an event that ends before it starts", async () => {
-		const { store, calendarId } = await provisioned();
-
-		const result = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "backwards.ics",
-			icalData: singleEvent(
-				"DTSTART:20260826T100000Z",
-				"DTEND:20260826T090000Z",
-			),
-		});
-
-		assert.ok(!result.ok);
-		assert.equal(result.error.code, "BackwardsEnd");
-		assert.equal(store.objects.size, 0);
-	});
-
-	it("fails loudly when the collection does not exist", async () => {
-		const store = new MemoryCalendarStore();
-
-		await assert.rejects(
-			putCalendarObject(store, {
-				accountConfigId: ACCOUNT_CONFIG_ID,
-				calendarId: "no-such-calendar",
-				resourceName: "review.ics",
-				icalData: RESOURCE,
-			}),
-			MissingRow,
-		);
-	});
-
-	it("projects the event in the collection's timezone", async () => {
-		const store = new MemoryCalendarStore();
-		const collection = await store.repos.calendarCollection.create({
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			urlSegment: "berlin",
-			displayName: "Berlin",
-			timezone: "Europe/Berlin",
-		});
-
-		const result = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId: collection.calendarId,
-			resourceName: "floating.ics",
-			icalData: singleEvent("DTSTART:20260826T090000", "DTEND:20260826T100000"),
-		});
-
-		assert.ok(result.ok);
-		assert.equal(result.value.dtStart, "2026-08-26T09:00:00+02:00");
-	});
-});
-
-describe("deleteCalendarObject", () => {
-	it("takes the occurrences with the resource and bumps the collection", async () => {
-		const { store, calendarId } = await provisioned();
-		const written = await putCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			resourceName: "review.ics",
-			icalData: RESOURCE,
-		});
-		assert.ok(written.ok);
-
-		await deleteCalendarObject(store, {
-			accountConfigId: ACCOUNT_CONFIG_ID,
-			calendarId,
-			calendarObjectId: written.value.calendarObjectId,
-		});
-
-		assert.equal(store.objects.size, 0);
-		assert.equal(store.occurrences.size, 0);
-		assert.equal(store.collections.get(calendarId)?.syncSequence, 2);
-	});
-});

package/src/put.ts

@@ -1,133 +0,0 @@
-import type {
-	CalendarCollectionItem,
-	CalendarObjectItem,
-	DeleteCalendarObjectWrite,
-	ICalendarStore,
-	PutCalendarObjectWrite,
-} from "@remit/data-ports";
-import { deriveCalendarObjectId } from "@remit/data-ports/id";
-import { CalendarSource } from "@remit/domain-enums";
-import type { CalendarResult } from "./errors.js";
-import { computeEtag } from "./etag.js";
-import { expandCalendar } from "./expand.js";
-import { parseCalendar } from "./parse.js";
-import { projectCalendar } from "./project.js";
-
-/** URL segment of the collection every account config is provisioned with. */
-export const DEFAULT_CALENDAR_URL_SEGMENT = "default";
-
-export interface PutCalendarObjectInput {
-	accountConfigId: string;
-	calendarId: string;
-	/** Last path segment of the resource's URL, e.g. `"a1b2c3.ics"`. */
-	resourceName: string;
-	/** The VCALENDAR text as it arrived, stored byte-for-byte. */
-	icalData: string;
-}
-
-/**
- * Turns one calendar resource into the write that stores it, read in the
- * collection's timezone. Every caller that stores an event goes through here —
- * a REST handler, a DAV PUT, an accepted suggestion, a feed refresh — because
- * the object row, its occurrence rows and the collection's sequence bump are
- * one fact, and a caller that writes any of them alone leaves the store
- * describing a calendar that does not exist.
- *
- * The bytes are stored exactly as given: parsing is for validating and
- * projecting them, never for rewriting them. Refusing the resource is a
- * returned value — the input is client-supplied, so malformed iCalendar is an
- * outcome the caller renders, not a fault.
- */
-export const prepareCalendarObject = async (
-	collection: Pick<CalendarCollectionItem, "timezone">,
-	input: PutCalendarObjectInput,
-): Promise<CalendarResult<PutCalendarObjectWrite>> => {
-	const parsed = await parseCalendar(input.icalData);
-	if (!parsed.ok) return parsed;
-
-	const projection = projectCalendar(parsed.value, collection.timezone);
-	if (!projection.ok) return projection;
-
-	const expansion = expandCalendar(parsed.value, collection.timezone);
-	return {
-		ok: true,
-		value: {
-			kind: "PutObject",
-			accountConfigId: input.accountConfigId,
-			object: {
-				...projection.value,
-				calendarId: input.calendarId,
-				resourceName: input.resourceName,
-				icalData: input.icalData,
-				etag: computeEtag(input.icalData),
-				expandedThrough: expansion.expandedThrough,
-			},
-			occurrences: expansion.occurrences,
-		},
-	};
-};
-
-/** The resource a committed put wrote, under the id its name derives to. */
-export const readWrittenObject = (
-	store: ICalendarStore,
-	write: PutCalendarObjectWrite,
-): Promise<CalendarObjectItem> =>
-	store.repos.calendarObject.get(
-		write.object.calendarId,
-		deriveCalendarObjectId(write.object.calendarId, write.object.resourceName),
-	);
-
-/** Writes one calendar resource into its collection. */
-export const putCalendarObject = async (
-	store: ICalendarStore,
-	input: PutCalendarObjectInput,
-): Promise<CalendarResult<CalendarObjectItem>> => {
-	const collection = await store.repos.calendarCollection.get(
-		input.accountConfigId,
-		input.calendarId,
-	);
-	const write = await prepareCalendarObject(collection, input);
-	if (!write.ok) return write;
-	await store.commit([write.value]);
-	return { ok: true, value: await readWrittenObject(store, write.value) };
-};
-
-/**
- * Removes a resource and the occurrences it produced — an object dropped
- * without its occurrence rows leaves a calendar showing events no resource
- * backs, which nothing later can attribute or clean up.
- */
-export const deleteCalendarObjectWrite = (input: {
-	accountConfigId: string;
-	calendarId: string;
-	calendarObjectId: string;
-}): DeleteCalendarObjectWrite => ({ kind: "DeleteObject", ...input });
-
-export const deleteCalendarObject = async (
-	store: ICalendarStore,
-	input: {
-		accountConfigId: string;
-		calendarId: string;
-		calendarObjectId: string;
-	},
-): Promise<void> => {
-	await store.commit([deleteCalendarObjectWrite(input)]);
-};
-
-/**
- * The collection an account config stores events in until someone makes
- * another. Safe to call on every request that needs a calendar: `calendarId` is
- * derived from the account config and the URL segment, so a second call returns
- * the collection the first one made rather than a rival copy of it.
- */
-export const provisionDefaultCalendar = (
-	store: ICalendarStore,
-	accountConfigId: string,
-	displayName = "Calendar",
-): Promise<CalendarCollectionItem> =>
-	store.repos.calendarCollection.create({
-		accountConfigId,
-		urlSegment: DEFAULT_CALENDAR_URL_SEGMENT,
-		displayName,
-		source: CalendarSource.Default,
-	});