@remit/calendar-service 0.0.18 → 0.0.20

package/src/feed.ts

@@ -1,203 +0,0 @@
-import { createHash, randomBytes } from "node:crypto";
-import type {
-	CalendarCollectionItem,
-	CalendarObjectItem,
-} from "@remit/data-ports";
-import ICAL from "ical.js";
-import { CALENDAR_PRODID } from "./build.js";
-import { computeEtag } from "./etag.js";
-import { serializeCalendar } from "./parse.js";
-
-/** Random bytes behind a feed token (issue #1067). */
-export const CALENDAR_FEED_TOKEN_BYTES = 32;
-
-/** Where a feed lives, as the one place the shape of that path is written. */
-export const CALENDAR_FEED_PATH_PREFIX = "/feeds/calendar/";
-export const CALENDAR_FEED_PATH_SUFFIX = ".ics";
-
-/** base64url over `CALENDAR_FEED_TOKEN_BYTES`, so the length is fixed. */
-const TOKEN_LENGTH = Math.ceil((CALENDAR_FEED_TOKEN_BYTES * 4) / 3);
-const TOKEN_SHAPE = new RegExp(`^[A-Za-z0-9_-]{${TOKEN_LENGTH}}$`);
-
-/** A minted feed address: the secret, handed out once, and what is stored. */
-export interface CalendarFeedSecret {
-	token: string;
-	tokenHash: string;
-}
-
-export const hashCalendarFeedToken = (token: string): string =>
-	createHash("sha256").update(token, "utf8").digest("hex");
-
-/**
- * A fresh feed token and the hash that will stand in for it.
- *
- * 32 random bytes rather than a stretched password: nothing about this value is
- * user-chosen, so there is no dictionary to search and a slow hash would only
- * tax every poll of every subscribed client.
- */
-export const mintCalendarFeedToken = (): CalendarFeedSecret => {
-	const token = randomBytes(CALENDAR_FEED_TOKEN_BYTES).toString("base64url");
-	return { token, tokenHash: hashCalendarFeedToken(token) };
-};
-
-/**
- * Whether a path segment can be a feed token at all.
- *
- * Checked before anything is hashed or read, so a request carrying a megabyte
- * of path or a `../` never reaches the store. A refusal here is the same 404 a
- * revoked token gets — the caller learns nothing from the difference.
- */
-export const isCalendarFeedToken = (token: string): boolean =>
-	TOKEN_SHAPE.test(token);
-
-/**
- * The token a request path carries, or `null` when the path is not a feed
- * address. One segment only: a slash inside it would name a different route.
- */
-export const readCalendarFeedToken = (path: string): string | null => {
-	if (!path.startsWith(CALENDAR_FEED_PATH_PREFIX)) return null;
-	if (!path.endsWith(CALENDAR_FEED_PATH_SUFFIX)) return null;
-	const token = path.slice(
-		CALENDAR_FEED_PATH_PREFIX.length,
-		-CALENDAR_FEED_PATH_SUFFIX.length,
-	);
-	if (token.includes("/")) return null;
-	return token;
-};
-
-/**
- * The feed path with its token taken out, for a log line or a metric label.
- *
- * The token is the whole credential, so a path that carries one is not a field
- * that can be recorded. Redacted rather than dropped: which route was served is
- * what an operator reads a log for, and a blank path loses that too.
- */
-export const redactCalendarFeedPath = (path: string): string =>
-	readCalendarFeedToken(path) === null
-		? path
-		: `${CALENDAR_FEED_PATH_PREFIX}<redacted>${CALENDAR_FEED_PATH_SUFFIX}`;
-
-/**
- * A TEXT value as RFC 5545 3.3.11 writes one.
- *
- * ical.js escapes TEXT only for the properties in its design set, and no `X-`
- * property is in it, so a value goes out verbatim: a comma or a semicolon
- * reads back as a value list, and a line break as the start of a whole
- * component the subscriber never had. TEXT has no encoding for a control
- * character, so one is dropped rather than served.
- */
-const escapeIcalText = (value: string): string =>
-	value
-		.replace(/\\/g, "\\\\")
-		.replace(/;/g, "\\;")
-		.replace(/,/g, "\\,")
-		.replace(/\r\n|\r|\n/g, "\\n")
-		// biome-ignore lint/suspicious/noControlCharactersInRegex: RFC 5545 TEXT excludes CONTROL.
-		.replace(/[\u0000-\u0008\u000b\u000c\u000e-\u001f\u007f]/g, "");
-
-/** The bytes a feed serves, and what a conditional request needs to skip them. */
-export interface CalendarFeed {
-	icalData: string;
-	etag: string;
-}
-
-/**
- * One VCALENDAR carrying every event in a collection.
- *
- * The stored components are copied across as they are: a recurring event
- * travels as its master plus its RRULE, never as an expansion, because a
- * subscriber renders occurrences itself and expects to keep doing so past any
- * horizon this server would have chosen. VTIMEZONE definitions come along for
- * the same reason — without them a client reads a TZID it cannot resolve.
- *
- * `X-WR-CALNAME` is a property of the calendar, not of the response: Apple
- * Calendar, Google Calendar and Thunderbird all name a subscription from it.
- */
-export const buildCalendarFeed = (
-	collection: CalendarCollectionItem,
-	objects: readonly CalendarObjectItem[],
-): CalendarFeed => {
-	const feed = new ICAL.Component("vcalendar");
-	feed.updatePropertyWithValue("prodid", CALENDAR_PRODID);
-	feed.updatePropertyWithValue("version", "2.0");
-	feed.updatePropertyWithValue("calscale", "GREGORIAN");
-	feed.updatePropertyWithValue(
-		"x-wr-calname",
-		escapeIcalText(collection.displayName),
-	);
-	if (collection.timezone !== "") {
-		feed.updatePropertyWithValue(
-			"x-wr-timezone",
-			escapeIcalText(collection.timezone),
-		);
-	}
-
-	const zonesSeen = new Set<string>();
-	for (const object of objects) {
-		const stored = new ICAL.Component(ICAL.parse(object.icalData));
-		// A copy of the list, not the list: adding a component reparents it,
-		// which splices it out of the array `getAllSubcomponents` handed back and
-		// would drop whatever followed it.
-		for (const child of [...stored.getAllSubcomponents()]) {
-			if (child.name === "vtimezone") {
-				const tzid = child.getFirstPropertyValue("tzid");
-				const key = typeof tzid === "string" ? tzid : "";
-				if (zonesSeen.has(key)) continue;
-				zonesSeen.add(key);
-			}
-			feed.addSubcomponent(child);
-		}
-	}
-
-	// ical.js leaves the last content line unterminated. Every line in an
-	// iCalendar stream ends with CRLF (RFC 5545 3.1), END:VCALENDAR included.
-	const serialized = serializeCalendar(feed);
-	const icalData = serialized.endsWith("\r\n")
-		? serialized
-		: `${serialized}\r\n`;
-	return { icalData, etag: computeEtag(icalData) };
-};
-
-/**
- * Whether an `If-None-Match` covers the tag the feed would serve.
- *
- * Accepts the weak form and `*`, and reads the header as the list RFC 9110
- * 13.1.2 says it is — a subscriber that has polled through a proxy may get its
- * own tag back with a `W/` on it, and answering 200 to that resends the whole
- * calendar for nothing.
- */
-export const calendarFeedIsUnchanged = (
-	ifNoneMatch: string | undefined,
-	etag: string,
-): boolean => {
-	if (ifNoneMatch === undefined || ifNoneMatch === "") return false;
-	if (ifNoneMatch.trim() === "*") return true;
-	return ifNoneMatch
-		.split(",")
-		.map((candidate) =>
-			candidate.trim().replace(/^W\//, "").replace(/^"|"$/g, ""),
-		)
-		.includes(etag);
-};
-
-/**
- * Whether the calendar has stood still since the date an `If-Modified-Since`
- * carries.
- *
- * Compared at whole seconds, which is the resolution an HTTP-date has: a
- * `Last-Modified` served from a millisecond timestamp is rounded down on the
- * way out, and comparing the unrounded value against what comes back declares
- * every calendar modified within the second it was last written.
- *
- * An unreadable date is not a condition (RFC 9110 13.1.3) — the full calendar
- * is served rather than a 304 nobody asked for.
- */
-export const calendarFeedIsUnmodifiedSince = (
-	ifModifiedSince: string | undefined,
-	lastModifiedAt: number,
-): boolean => {
-	if (ifModifiedSince === undefined || ifModifiedSince === "") return false;
-	const since = Date.parse(ifModifiedSince);
-	if (Number.isNaN(since)) return false;
-	return Math.floor(lastModifiedAt / 1000) * 1000 <= since;
-};

package/src/feeds/google-secret-address.ics

@@ -1,99 +0,0 @@
-BEGIN:VCALENDAR
-PRODID:-//Google Inc//Google Calendar 70.9054//EN
-VERSION:2.0
-CALSCALE:GREGORIAN
-METHOD:PUBLISH
-X-WR-CALNAME:Harbour rota
-X-WR-TIMEZONE:Europe/Amsterdam
-BEGIN:VTIMEZONE
-TZID:Europe/Amsterdam
-X-LIC-LOCATION:Europe/Amsterdam
-BEGIN:DAYLIGHT
-TZOFFSETFROM:+0100
-TZOFFSETTO:+0200
-TZNAME:CEST
-DTSTART:19700329T020000
-RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU
-END:DAYLIGHT
-BEGIN:STANDARD
-TZOFFSETFROM:+0200
-TZOFFSETTO:+0100
-TZNAME:CET
-DTSTART:19701025T030000
-RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU
-END:STANDARD
-END:VTIMEZONE
-BEGIN:VTIMEZONE
-TZID:America/New_York
-BEGIN:DAYLIGHT
-TZOFFSETFROM:-0500
-TZOFFSETTO:-0400
-TZNAME:EDT
-DTSTART:19700308T020000
-RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=2SU
-END:DAYLIGHT
-BEGIN:STANDARD
-TZOFFSETFROM:-0400
-TZOFFSETTO:-0500
-TZNAME:EST
-DTSTART:19701101T020000
-RRULE:FREQ=YEARLY;BYMONTH=11;BYDAY=1SU
-END:STANDARD
-END:VTIMEZONE
-BEGIN:VEVENT
-DTSTART;TZID=Europe/Amsterdam:20261005T090000
-DTEND;TZID=Europe/Amsterdam:20261005T093000
-RRULE:FREQ=WEEKLY;COUNT=6;BYDAY=MO
-EXDATE;TZID=Europe/Amsterdam:20261019T090000
-DTSTAMP:20260925T120000Z
-UID:pilot-standup@google.com
-CREATED:20260901T080000Z
-LAST-MODIFIED:20260920T080000Z
-SEQUENCE:0
-STATUS:CONFIRMED
-SUMMARY:Pilot standup
-TRANSP:OPAQUE
-END:VEVENT
-BEGIN:VEVENT
-DTSTART;TZID=Europe/Amsterdam:20261012T100000
-DTEND;TZID=Europe/Amsterdam:20261012T103000
-DTSTAMP:20260925T120000Z
-UID:pilot-standup@google.com
-RECURRENCE-ID;TZID=Europe/Amsterdam:20261012T090000
-SEQUENCE:1
-STATUS:CONFIRMED
-SUMMARY:Pilot standup (moved)
-TRANSP:OPAQUE
-END:VEVENT
-BEGIN:VEVENT
-DTSTART;TZID=Europe/Amsterdam:20261102T090000
-DTEND;TZID=Europe/Amsterdam:20261102T093000
-DTSTAMP:20260925T120000Z
-UID:pilot-standup@google.com
-RECURRENCE-ID;TZID=Europe/Amsterdam:20261102T090000
-SEQUENCE:1
-STATUS:CANCELLED
-SUMMARY:Pilot standup
-TRANSP:OPAQUE
-END:VEVENT
-BEGIN:VEVENT
-DTSTART;VALUE=DATE:20261007
-DTEND;VALUE=DATE:20261009
-DTSTAMP:20260925T120000Z
-UID:quay-offsite@google.com
-SEQUENCE:0
-STATUS:CONFIRMED
-SUMMARY:Quay offsite
-TRANSP:TRANSPARENT
-END:VEVENT
-BEGIN:VEVENT
-DTSTART:20261008T140000Z
-DTEND:20261008T150000Z
-DTSTAMP:20260925T120000Z
-UID:tide-review@google.com
-SEQUENCE:0
-STATUS:CONFIRMED
-SUMMARY:Tide table review
-TRANSP:OPAQUE
-END:VEVENT
-END:VCALENDAR

package/src/fixtures.ts

@@ -1,52 +0,0 @@
-/**
- * iCalendar fixtures, assembled from lines so the CRLF the RFC requires is
- * explicit rather than a property of this file's own line endings.
- */
-export const ical = (...lines: string[]): string => `${lines.join("\r\n")}\r\n`;
-
-/**
- * The same resource as a client that ignores RFC 5545 3.1 would send it. Real
- * `.ics` files arrive LF-only often enough — anything that has been through a
- * text-mode checkout, an editor, or a naive copy — that reading them is part of
- * the job, not an edge case.
- */
-export const asLf = (icalData: string): string =>
-	icalData.replace(/\r\n/g, "\n");
-
-/**
- * Europe/Amsterdam as a client writes it into a resource. Present so a
- * DST-crossing series resolves against the definition the resource itself
- * carries, which is the only zone data RFC 5545 promises a server.
- */
-export const AMSTERDAM_VTIMEZONE = [
-	"BEGIN:VTIMEZONE",
-	"TZID:Europe/Amsterdam",
-	"BEGIN:DAYLIGHT",
-	"TZOFFSETFROM:+0100",
-	"TZOFFSETTO:+0200",
-	"TZNAME:CEST",
-	"DTSTART:19700329T020000",
-	"RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU",
-	"END:DAYLIGHT",
-	"BEGIN:STANDARD",
-	"TZOFFSETFROM:+0200",
-	"TZOFFSETTO:+0100",
-	"TZNAME:CET",
-	"DTSTART:19701025T030000",
-	"RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU",
-	"END:STANDARD",
-	"END:VTIMEZONE",
-];
-
-export const singleEvent = (...eventLines: string[]): string =>
-	ical(
-		"BEGIN:VCALENDAR",
-		"VERSION:2.0",
-		"PRODID:-//Remit//Calendar Tests//EN",
-		"BEGIN:VEVENT",
-		"UID:fixture@example.com",
-		"DTSTAMP:20260801T090000Z",
-		...eventLines,
-		"END:VEVENT",
-		"END:VCALENDAR",
-	);

package/src/index.ts

@@ -1,128 +0,0 @@
-export {
-	type AcceptCalendarSuggestionInput,
-	type AcceptedCalendarSuggestion,
-	acceptCalendarSuggestion,
-	buildAcceptedCalendar,
-} from "./accept.js";
-export {
-	applyEventFields,
-	buildEventCalendar,
-	CALENDAR_PRODID,
-	type CalendarEventFields,
-	eventTimeFields,
-	OFFSET_BEARING,
-	readEventTime,
-	readRecurrenceRule,
-} from "./build.js";
-export { correctCalendarSuggestion } from "./correct.js";
-export type {
-	CalendarResult,
-	CalendarValidationCode,
-	CalendarValidationError,
-} from "./errors.js";
-export { computeEtag } from "./etag.js";
-export {
-	CALENDAR_EXPANSION_HORIZON_DAYS,
-	CALENDAR_EXPANSION_MAX_OCCURRENCES,
-	CALENDAR_WINDOW_MAX_STEPS,
-	type CalendarExpansion,
-	expandCalendar,
-	expandCalendarWindow,
-} from "./expand.js";
-export {
-	buildCalendarFeed,
-	CALENDAR_FEED_PATH_PREFIX,
-	CALENDAR_FEED_PATH_SUFFIX,
-	CALENDAR_FEED_TOKEN_BYTES,
-	type CalendarFeed,
-	type CalendarFeedSecret,
-	calendarFeedIsUnchanged,
-	calendarFeedIsUnmodifiedSince,
-	hashCalendarFeedToken,
-	isCalendarFeedToken,
-	mintCalendarFeedToken,
-	readCalendarFeedToken,
-	redactCalendarFeedPath,
-} from "./feed.js";
-export {
-	type ParsedCalendar,
-	parseCalendar,
-	serializeCalendar,
-} from "./parse.js";
-export {
-	type CalendarObjectProjection,
-	projectCalendar,
-} from "./project.js";
-export {
-	DEFAULT_CALENDAR_URL_SEGMENT,
-	deleteCalendarObject,
-	deleteCalendarObjectWrite,
-	type PutCalendarObjectInput,
-	prepareCalendarObject,
-	provisionDefaultCalendar,
-	putCalendarObject,
-	readWrittenObject,
-} from "./put.js";
-export {
-	answersOvertakenBy,
-	type ReopenCalendarSuggestionInput,
-	reopenCalendarSuggestion,
-} from "./reopen.js";
-export {
-	applyScopedDelete,
-	applyScopedUpdate,
-	findOccurrence,
-	followingUidOf,
-	followingUidPrefix,
-	type RecurrenceScopeValue,
-	type ScopedWrite,
-	type ScopedWriteInput,
-} from "./scope.js";
-export {
-	CALENDAR_SUBSCRIPTION_MAX_BYTES,
-	CALENDAR_SUBSCRIPTION_TIMEOUT_MS,
-	type CalendarFeedFetch,
-	type CalendarFeedFetcher,
-	type CalendarFeedResource,
-	type CalendarFeedSplit,
-	type CalendarFeedWrite,
-	type CalendarSubscriptionRefresh,
-	type CalendarSubscriptionTarget,
-	fetchCalendarFeed,
-	isSubscriptionDue,
-	readCalendarFeed,
-	readSubscriptionUrl,
-	recordCalendarFeedFailure,
-	refreshCalendarSubscription,
-	splitCalendarFeed,
-	writeCalendarFeed,
-} from "./subscribe.js";
-export {
-	type CalendarSuggestionProjection,
-	inviteMethodOf,
-	mailAddressOf,
-	projectSuggestion,
-	type RecordCalendarSuggestionInput,
-	type RecordedCalendarSuggestion,
-	recordCalendarSuggestion,
-} from "./suggest.js";
-export {
-	civilInZone,
-	isResolvableZone,
-	type ResolvedTime,
-	resolveTime,
-	toOffsetIso,
-	toUtcIso,
-} from "./time.js";
-export {
-	type BusySpan,
-	CALENDAR_WINDOW_LOOKBACK_DAYS,
-	type CalendarInstance,
-	type CalendarWindow,
-	type CalendarWindowRepositories,
-	isBusy,
-	listBusySpans,
-	listCalendarInstances,
-	listObjectInstances,
-	mergeBusySpans,
-} from "./window.js";