@remit/web-client 0.0.230 → 0.0.231

package/src/lib/calendar-route.test.ts

@@ -0,0 +1,210 @@
+/**
+ * The calendar's address, rule by rule — which tier holds which fact, what a
+ * segment the calendar cannot read resolves to, and what a query string it did
+ * not write is allowed to say.
+ */
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+import { CALENDAR_DENSITY_KEY } from "./calendar-density.js";
+import {
+	calendarSearchSchema,
+	calendarViewMountsGrid,
+	calendarViews,
+	canonicalCalendarParams,
+	DEFAULT_CALENDAR_VIEW,
+	isoDate,
+	parseCalendarDate,
+	parseCalendarView,
+	readCalendarIds,
+	stepCalendarDate,
+} from "./calendar-route.js";
+
+const TODAY = "2026-06-10";
+
+describe("parseCalendarView", () => {
+	it("reads every zoom the ladder has", () => {
+		for (const view of calendarViews) {
+			assert.equal(parseCalendarView(view), view);
+		}
+	});
+
+	it("reads a segment that names no zoom as none", () => {
+		assert.equal(parseCalendarView("fortnight"), undefined);
+		assert.equal(parseCalendarView("Week"), undefined);
+		assert.equal(parseCalendarView(""), undefined);
+	});
+});
+
+describe("parseCalendarDate", () => {
+	it("reads a day the calendar has", () => {
+		assert.equal(parseCalendarDate("2026-06-10"), "2026-06-10");
+		assert.equal(parseCalendarDate("2024-02-29"), "2024-02-29");
+	});
+
+	it("refuses a day the calendar does not have", () => {
+		assert.equal(parseCalendarDate("2026-02-30"), undefined);
+		assert.equal(parseCalendarDate("2026-13-01"), undefined);
+		assert.equal(parseCalendarDate("2025-02-29"), undefined);
+	});
+
+	it("refuses anything that is not the one spelling", () => {
+		assert.equal(parseCalendarDate("2026-6-10"), undefined);
+		assert.equal(parseCalendarDate("10-06-2026"), undefined);
+		assert.equal(parseCalendarDate("2026-06-10T09:30"), undefined);
+		assert.equal(parseCalendarDate("today"), undefined);
+		assert.equal(parseCalendarDate(""), undefined);
+	});
+});
+
+describe("canonicalCalendarParams", () => {
+	it("leaves an address it can read alone", () => {
+		assert.deepEqual(
+			canonicalCalendarParams({ view: "day", date: "2026-06-10" }, TODAY),
+			{ view: "day", date: "2026-06-10" },
+		);
+	});
+
+	it("keeps the half it could read", () => {
+		assert.deepEqual(
+			canonicalCalendarParams({ view: "fortnight", date: "2026-06-10" }, TODAY),
+			{ view: DEFAULT_CALENDAR_VIEW, date: "2026-06-10" },
+		);
+		assert.deepEqual(
+			canonicalCalendarParams({ view: "day", date: "yesterday" }, TODAY),
+			{ view: "day", date: TODAY },
+		);
+	});
+
+	it("sends an address it can read nothing of to this week", () => {
+		assert.deepEqual(canonicalCalendarParams({ view: "", date: "" }, TODAY), {
+			view: DEFAULT_CALENDAR_VIEW,
+			date: TODAY,
+		});
+	});
+});
+
+describe("calendarViewMountsGrid", () => {
+	it("draws the week and the day", () => {
+		assert.equal(calendarViewMountsGrid("week"), true);
+		assert.equal(calendarViewMountsGrid("day"), true);
+	});
+
+	it("has the other three still to come", () => {
+		assert.equal(calendarViewMountsGrid("year"), false);
+		assert.equal(calendarViewMountsGrid("month"), false);
+		assert.equal(calendarViewMountsGrid("agenda"), false);
+	});
+});
+
+describe("stepCalendarDate", () => {
+	it("steps a screenful in the view's own unit", () => {
+		assert.equal(stepCalendarDate("2026-06-10", "day", 1), "2026-06-11");
+		assert.equal(stepCalendarDate("2026-06-10", "week", 1), "2026-06-17");
+		assert.equal(stepCalendarDate("2026-06-10", "agenda", 1), "2026-06-17");
+		assert.equal(stepCalendarDate("2026-06-10", "month", 1), "2026-07-10");
+		assert.equal(stepCalendarDate("2026-06-10", "year", 1), "2027-06-10");
+	});
+
+	it("steps back the same distance it steps forward", () => {
+		for (const view of calendarViews) {
+			const forward = stepCalendarDate("2026-06-10", view, 1);
+			assert.equal(stepCalendarDate(forward, view, -1), "2026-06-10");
+		}
+	});
+
+	it("crosses a month, a year and a leap day", () => {
+		assert.equal(stepCalendarDate("2026-12-31", "day", 1), "2027-01-01");
+		assert.equal(stepCalendarDate("2026-01-01", "day", -1), "2025-12-31");
+		assert.equal(stepCalendarDate("2024-02-28", "day", 1), "2024-02-29");
+		assert.equal(stepCalendarDate("2026-12-15", "month", 1), "2027-01-15");
+		assert.equal(stepCalendarDate("2026-01-15", "month", -1), "2025-12-15");
+	});
+
+	it("holds a month step to a day that month has", () => {
+		assert.equal(stepCalendarDate("2026-03-31", "month", -1), "2026-02-28");
+		assert.equal(stepCalendarDate("2026-01-31", "month", 1), "2026-02-28");
+		assert.equal(stepCalendarDate("2024-01-31", "month", 1), "2024-02-29");
+		assert.equal(stepCalendarDate("2024-02-29", "year", 1), "2025-02-28");
+	});
+});
+
+describe("isoDate", () => {
+	it("names the day an instant falls on by the device's own clock", () => {
+		assert.equal(isoDate(new Date(2026, 5, 10, 9, 30)), "2026-06-10");
+		assert.equal(isoDate(new Date(2026, 0, 1, 0, 0)), "2026-01-01");
+		assert.equal(isoDate(new Date(2026, 11, 31, 23, 59)), "2026-12-31");
+	});
+});
+
+describe("readCalendarIds", () => {
+	it("reads repeated params, a single one, and none", () => {
+		assert.deepEqual(readCalendarIds(["cal_a", "cal_b"]), ["cal_a", "cal_b"]);
+		assert.deepEqual(readCalendarIds("cal_a"), ["cal_a"]);
+		assert.deepEqual(readCalendarIds(undefined), []);
+	});
+
+	it("spells one set of ticked calendars one way", () => {
+		assert.deepEqual(readCalendarIds(["cal_b", "cal_a", "cal_b"]), [
+			"cal_a",
+			"cal_b",
+		]);
+	});
+
+	it("keeps a numeric-looking id the router handed through as a number", () => {
+		assert.deepEqual(readCalendarIds([12, "cal_a"]), ["12", "cal_a"]);
+	});
+
+	it("drops what is not an id rather than refusing the address", () => {
+		assert.deepEqual(readCalendarIds(["", "cal_a", null, { id: "x" }]), [
+			"cal_a",
+		]);
+	});
+});
+
+describe("calendarSearchSchema", () => {
+	it("carries the ticked calendars", () => {
+		assert.deepEqual(calendarSearchSchema.parse({ calendarId: "cal_a" }), {
+			calendarId: ["cal_a"],
+		});
+		assert.deepEqual(
+			calendarSearchSchema.parse({ calendarId: ["cal_b", "cal_a"] }),
+			{ calendarId: ["cal_a", "cal_b"] },
+		);
+	});
+
+	it("leaves the param out where nothing is ticked off", () => {
+		// Absent rather than empty: the router writes no param for `undefined`, so
+		// a calendar showing everything is one the query says nothing about.
+		assert.equal(calendarSearchSchema.parse({}).calendarId, undefined);
+		assert.equal(
+			calendarSearchSchema.parse({ calendarId: [] }).calendarId,
+			undefined,
+		);
+		assert.equal(
+			calendarSearchSchema.parse({ calendarId: ["", null] }).calendarId,
+			undefined,
+		);
+	});
+
+	it("strips a param that is not the calendar's to carry", () => {
+		const parsed = calendarSearchSchema.parse({
+			calendarId: ["cal_a"],
+			q: "invoice",
+			// Density is a device preference, so an address naming one is ignored
+			// rather than obeyed: a link must not resize another reader's day.
+			density: "compact",
+			date: "2026-06-10",
+		});
+		assert.deepEqual(parsed, { calendarId: ["cal_a"] });
+	});
+});
+
+describe("density is not URL state", () => {
+	it("is stored against the device, under a key of its own", () => {
+		assert.equal(CALENDAR_DENSITY_KEY, "remit:calendar-density");
+	});
+
+	it("has no reading in the query", () => {
+		assert.deepEqual(calendarSearchSchema.parse({ density: "compact" }), {});
+	});
+});

package/src/lib/calendar-route.ts

@@ -0,0 +1,183 @@
+/**
+ * The calendar's address, read and written in one place.
+ *
+ * `/calendar/{view}/{date}` and, under it, the event a reader has open. The
+ * five zoom levels are mutually exclusive and each is a different surface, so
+ * the view is a path segment (R5); the date is one too, because the strip is
+ * infinite and the address has to name where it opened — a `?date=` param
+ * would be a query compensating for a missing segment (R4). What the reader
+ * has ticked off modifies the view without changing what is mounted, so the
+ * calendar filter is query (R2), validated here rather than at the read site
+ * (R7).
+ *
+ * Nothing here reads a clock. Every function takes the instant it needs, so
+ * "today" is a decision the caller makes once and this module can be tested
+ * without one.
+ */
+import type { CalendarViewId } from "@remit/ui";
+import { z } from "zod";
+
+/** The zoom ladder, widest first. The union `@remit/ui` already publishes. */
+export const calendarViews = [
+	"year",
+	"month",
+	"week",
+	"day",
+	"agenda",
+] as const satisfies readonly CalendarViewId[];
+
+const calendarViewSchema = z.enum(calendarViews);
+
+/** Where `/calendar` sends a reader who named no zoom of their own. */
+export const DEFAULT_CALENDAR_VIEW: CalendarViewId = "week";
+
+/**
+ * The views the grid draws today. The other three are named surfaces that
+ * arrive in later stages, and they say so on screen rather than matching a
+ * route that renders nothing.
+ */
+const GRID_VIEWS = new Set<CalendarViewId>(["week", "day"]);
+
+export const calendarViewMountsGrid = (view: CalendarViewId): boolean =>
+	GRID_VIEWS.has(view);
+
+/** The view a segment names, or `undefined` where it names none. */
+export function parseCalendarView(segment: string): CalendarViewId | undefined {
+	const parsed = calendarViewSchema.safeParse(segment);
+	return parsed.success ? parsed.data : undefined;
+}
+
+const ISO_DATE = /^\d{4}-\d{2}-\d{2}$/;
+
+/**
+ * The day a segment names, or `undefined`. A date the calendar does not have —
+ * the 31st of February, the 13th month — is not a day, so it is rejected
+ * rather than rolled forward into one the reader did not ask for.
+ */
+export function parseCalendarDate(segment: string): string | undefined {
+	if (!ISO_DATE.test(segment)) return undefined;
+	const [year, month, day] = segment.split("-").map(Number);
+	const instant = Date.UTC(year, month - 1, day);
+	const round = new Date(instant);
+	if (round.getUTCFullYear() !== year) return undefined;
+	if (round.getUTCMonth() !== month - 1) return undefined;
+	if (round.getUTCDate() !== day) return undefined;
+	return segment;
+}
+
+const pad = (value: number): string => String(value).padStart(2, "0");
+
+/** The day an instant falls on, by the clock the reader's device is running. */
+export function isoDate(instant: Date): string {
+	return `${instant.getFullYear()}-${pad(instant.getMonth() + 1)}-${pad(
+		instant.getDate(),
+	)}`;
+}
+
+export interface CalendarParams {
+	view: CalendarViewId;
+	date: string;
+}
+
+/**
+ * The address a pair of segments resolves to.
+ *
+ * A hand-edited or stale URL is a normal thing to receive, so an unreadable
+ * segment is replaced rather than thrown: the half that was readable is kept,
+ * and the reader lands on a calendar instead of an error. The caller compares
+ * this with what it was given and redirects when they differ, so the address
+ * bar ends up naming exactly what is on screen.
+ */
+export function canonicalCalendarParams(
+	segments: { view: string; date: string },
+	today: string,
+): CalendarParams {
+	return {
+		view: parseCalendarView(segments.view) ?? DEFAULT_CALENDAR_VIEW,
+		date: parseCalendarDate(segments.date) ?? today,
+	};
+}
+
+/**
+ * The day the previous or next screenful starts on. A step is measured in the
+ * view's own unit, which is what makes back-and-forward land where the reader
+ * came from at every zoom. Agenda steps a week, the range it loads.
+ */
+export function stepCalendarDate(
+	date: string,
+	view: CalendarViewId,
+	direction: -1 | 1,
+): string {
+	const [year, month, day] = date.split("-").map(Number);
+	if (view === "year") return clampedDate(year + direction, month, day);
+	if (view === "month") return clampedDate(year, month + direction, day);
+	const days = view === "day" ? 1 : 7;
+	const stepped = new Date(Date.UTC(year, month - 1, day + days * direction));
+	return isoDateUtc(stepped);
+}
+
+const isoDateUtc = (instant: Date): string =>
+	`${instant.getUTCFullYear()}-${pad(instant.getUTCMonth() + 1)}-${pad(
+		instant.getUTCDate(),
+	)}`;
+
+/**
+ * A month or a year away from a date, held to a day that month has. Stepping
+ * off the 31st of March must land in February rather than skipping it.
+ */
+function clampedDate(year: number, month: number, day: number): string {
+	const normalisedYear = year + Math.floor((month - 1) / 12);
+	const normalisedMonth = ((((month - 1) % 12) + 12) % 12) + 1;
+	const lastDay = new Date(
+		Date.UTC(normalisedYear, normalisedMonth, 0),
+	).getUTCDate();
+	return `${normalisedYear}-${pad(normalisedMonth)}-${pad(
+		Math.min(day, lastDay),
+	)}`;
+}
+
+/**
+ * A calendar's id, as the URL carries it. A hand-written schema is a second
+ * owner of a shape the domain will publish, so stage A.3 replaces this with
+ * the generated one and every read site keeps working.
+ */
+const calendarIdSchema = z.string().min(1);
+
+/**
+ * The calendars a query string has ticked.
+ *
+ * Repeated `calendarId=` params are the shape, and the shape the address is
+ * written back in (`lib/search-params.ts`). They arrive here in three readings
+ * all the same: a list from repeated params, a scalar from a single one, and a
+ * number where the id looked like one. One set of ticked calendars has one
+ * spelling, which is what deduplicating and sorting is for.
+ */
+export function readCalendarIds(value: unknown): string[] {
+	const raw = value === undefined || value === null ? [] : [value].flat();
+	const named = new Set<string>();
+	for (const entry of raw) {
+		if (typeof entry !== "string" && typeof entry !== "number") continue;
+		const id = calendarIdSchema.safeParse(String(entry));
+		if (id.success) named.add(id.data);
+	}
+	return [...named].sort();
+}
+
+/**
+ * What the calendar reads out of the query, and all of it.
+ *
+ * Ticking nothing off leaves the param out rather than writing an empty list:
+ * the address states what a reader has narrowed to, so a calendar showing
+ * everything is a calendar the query has nothing to say about.
+ *
+ * Density is absent on purpose: it is how much of a day this device fits on
+ * screen, which is a preference the device holds (`lib/calendar-density.ts`)
+ * rather than a fact about the view, so it belongs to no tier of the address.
+ */
+export const calendarSearchSchema = z.object({
+	calendarId: z
+		.preprocess(readCalendarIds, z.array(calendarIdSchema))
+		.transform((ids) => (ids.length === 0 ? undefined : ids)),
+});
+
+export type CalendarSearch = z.infer<typeof calendarSearchSchema>;

package/src/lib/search-params.test.ts

@@ -0,0 +1,77 @@
+/**
+ * The spelling the address bar is written in.
+ *
+ * The router reads a repeated param as a list already; this is the other half,
+ * and the assertions are the round trip — anything written here has to come
+ * back the value it went in as.
+ */
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+import { parseSearchWith } from "@tanstack/react-router";
+import { stringifySearch } from "./search-params.js";
+
+/** The router's own reader, which this module has to stay symmetrical with. */
+const parseSearch = parseSearchWith(JSON.parse);
+
+/** Spread, because the router's reader answers with a null-prototype object. */
+const roundTrip = (search: Record<string, unknown>): unknown => ({
+	...parseSearch(stringifySearch(search)),
+});
+
+describe("stringifySearch", () => {
+	it("writes a list as the repeated params it is", () => {
+		assert.equal(
+			stringifySearch({ calendarId: ["cal_a", "cal_b"] }),
+			"?calendarId=cal_a&calendarId=cal_b",
+		);
+	});
+
+	it("writes a list of one as one param", () => {
+		assert.equal(
+			stringifySearch({ calendarId: ["cal_a"] }),
+			"?calendarId=cal_a",
+		);
+	});
+
+	it("writes nothing for an empty list, an absent value, or no params", () => {
+		assert.equal(stringifySearch({ calendarId: [] }), "");
+		assert.equal(stringifySearch({ q: undefined }), "");
+		assert.equal(stringifySearch({}), "");
+	});
+
+	it("leaves an ordinary value the way the router already wrote it", () => {
+		assert.equal(stringifySearch({ q: "invoice" }), "?q=invoice");
+		assert.equal(stringifySearch({ wizard: "review" }), "?wizard=review");
+	});
+
+	it("percent-encodes what a query string cannot carry raw", () => {
+		assert.equal(stringifySearch({ q: "from:ada &c" }), "?q=from%3Aada+%26c");
+	});
+});
+
+describe("what is written comes back", () => {
+	it("gives a list back as a list", () => {
+		assert.deepEqual(roundTrip({ calendarId: ["cal_a", "cal_b"] }), {
+			calendarId: ["cal_a", "cal_b"],
+		});
+	});
+
+	it("gives text that reads as JSON back as text", () => {
+		// Unquoted, the reader would hand back a boolean and a number.
+		assert.deepEqual(roundTrip({ q: "true" }), { q: "true" });
+		assert.deepEqual(roundTrip({ q: "2026" }), { q: "2026" });
+		assert.deepEqual(roundTrip({ q: "[draft]" }), { q: "[draft]" });
+	});
+
+	it("gives ordinary text back unchanged", () => {
+		assert.deepEqual(roundTrip({ q: "from:ada invoice" }), {
+			q: "from:ada invoice",
+		});
+	});
+
+	it("gives a structure back as a structure", () => {
+		assert.deepEqual(roundTrip({ filter: { unread: true } }), {
+			filter: { unread: true },
+		});
+	});
+});

package/src/lib/search-params.ts

@@ -0,0 +1,59 @@
+/**
+ * How the address bar spells the query string.
+ *
+ * The router's own serializer writes one param per key, so a list of values
+ * comes out as a JSON blob — `?calendarId=%5B%22cal_a%22%2C%22cal_b%22%5D`. A
+ * list of values is what a query string has always been able to say, and
+ * saying it the ordinary way is what makes a link hand-writable, readable in a
+ * log, and usable by anything that is not this router. The router's own reader
+ * already collects repeated params into an array, so only the writing side was
+ * missing.
+ *
+ * Every other value keeps the spelling the router already gives it, including
+ * the quoting that text reading as JSON needs: the reader JSON-parses whatever
+ * it can, so `?q=true` would come back the boolean unless the string went in
+ * quoted.
+ */
+
+/**
+ * Whether reading this text back would produce something other than the text.
+ *
+ * Decided by shape rather than by parsing it, because a block try/catch is not
+ * available and an over-quoted string still reads back as itself — the reader
+ * unquotes it — where an under-quoted one comes back the wrong type.
+ */
+const readsAsJson = (value: string): boolean =>
+	value === "true" ||
+	value === "false" ||
+	value === "null" ||
+	/^["[{]/.test(value) ||
+	(value !== "" && Number.isFinite(Number(value)));
+
+/** The router's own value spelling. */
+function stringifyValue(value: unknown): string {
+	if (typeof value === "object" && value !== null) return JSON.stringify(value);
+	if (typeof value === "string")
+		return readsAsJson(value) ? JSON.stringify(value) : value;
+	return String(value);
+}
+
+/**
+ * A query string, with a list written as the repeated params it is.
+ *
+ * `undefined` is absent rather than empty: a fact the view has nothing to say
+ * about does not belong in the address at all.
+ */
+export function stringifySearch(search: Record<string, unknown>): string {
+	const params = new URLSearchParams();
+	for (const key of Object.keys(search)) {
+		const value = search[key];
+		if (value === undefined) continue;
+		if (Array.isArray(value)) {
+			for (const entry of value) params.append(key, stringifyValue(entry));
+			continue;
+		}
+		params.set(key, stringifyValue(value));
+	}
+	const written = params.toString();
+	return written === "" ? "" : `?${written}`;
+}