@remit/data-ports 0.0.74 → 0.0.76

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/data-ports",
-  "version": "0.0.74",
+  "version": "0.0.76",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/conformance/account.ts

@@ -78,5 +78,27 @@ export function accountRepositoryConformance(
 				AccountService.Calendar,
 			]);
 		});
+
+		test("the mail sources of a config leave out an account with mail off", async () => {
+			const accountConfigId = harness.makeId();
+			const mailOnly = await repo.create(accountInput(accountConfigId));
+			const both = await repo.create({
+				...accountInput(accountConfigId),
+				syncedServices: [AccountService.Mail, AccountService.Calendar],
+			});
+			await repo.create({
+				...accountInput(accountConfigId),
+				syncedServices: [AccountService.Calendar],
+			});
+			await repo.create(accountInput(harness.makeId()));
+
+			const sources =
+				await repo.listMailSourcesByAccountConfig(accountConfigId);
+
+			assert.deepEqual(
+				sources.map((account) => account.accountId).sort(),
+				[mailOnly.accountId, both.accountId].sort(),
+			);
+		});
 	});
 }

package/src/conformance/calendar-collection.ts

@@ -231,6 +231,98 @@ export function calendarCollectionRepositoryConformance(
 			);
 		});
 
+		test("a collection starts with no subscription and empty fetch bookkeeping", async () => {
+			const calendar = await repo.create({
+				accountConfigId: harness.makeId(),
+				urlSegment: "plain",
+				displayName: "Plain",
+			});
+
+			assert.equal(calendar.subscriptionUrl, "");
+			assert.equal(calendar.subscriptionEnabled, false);
+			assert.equal(calendar.subscriptionCheckedAt, 0);
+			assert.equal(calendar.subscriptionFetchedAt, 0);
+			assert.equal(calendar.subscriptionError, "");
+		});
+
+		test("listEnabledSubscriptions returns enabled subscriptions across account configs and nothing else", async () => {
+			const first = harness.makeId();
+			const second = harness.makeId();
+			const subscribed = await repo.create({
+				accountConfigId: first,
+				urlSegment: "feed",
+				displayName: "Feed",
+				source: CalendarSource.Subscribed,
+				subscriptionUrl: "https://calendar.example/feed.ics",
+				subscriptionEnabled: true,
+			});
+			const elsewhere = await repo.create({
+				accountConfigId: second,
+				urlSegment: "feed",
+				displayName: "Feed",
+				source: CalendarSource.Subscribed,
+				subscriptionUrl: "https://calendar.example/other.ics",
+				subscriptionEnabled: true,
+			});
+			const paused = await repo.create({
+				accountConfigId: first,
+				urlSegment: "paused",
+				displayName: "Paused",
+				source: CalendarSource.Subscribed,
+				subscriptionUrl: "https://calendar.example/paused.ics",
+				subscriptionEnabled: true,
+			});
+			await repo.update(first, paused.calendarId, {
+				subscriptionEnabled: false,
+			});
+			await repo.create({
+				accountConfigId: first,
+				urlSegment: "own",
+				displayName: "Own",
+			});
+
+			const ids = (await repo.listEnabledSubscriptions())
+				.filter(
+					(calendar) =>
+						calendar.accountConfigId === first ||
+						calendar.accountConfigId === second,
+				)
+				.map((calendar) => calendar.calendarId)
+				.sort();
+
+			assert.deepEqual(
+				ids,
+				[subscribed.calendarId, elsewhere.calendarId].sort(),
+			);
+		});
+
+		test("update records a fetch outcome on the collection", async () => {
+			const accountConfigId = harness.makeId();
+			const calendar = await repo.create({
+				accountConfigId,
+				urlSegment: "fetched",
+				displayName: "Fetched",
+				source: CalendarSource.Subscribed,
+				subscriptionUrl: "https://calendar.example/feed.ics",
+				subscriptionEnabled: true,
+			});
+
+			const updated = await repo.update(accountConfigId, calendar.calendarId, {
+				subscriptionCheckedAt: 2_000,
+				subscriptionFetchedAt: 1_000,
+				subscriptionError: "the feed answered 404",
+			});
+
+			assert.equal(updated.subscriptionCheckedAt, 2_000);
+			assert.equal(updated.subscriptionFetchedAt, 1_000);
+			assert.equal(updated.subscriptionError, "the feed answered 404");
+			assert.equal(
+				updated.subscriptionUrl,
+				"https://calendar.example/feed.ics",
+			);
+			assert.equal(updated.subscriptionEnabled, true);
+		});
+
 		test("delete removes the row", async () => {
 			const accountConfigId = harness.makeId();
 			const calendar = await repo.create({

package/src/errors.ts

@@ -212,3 +212,15 @@ export class InternalServerError extends UnhandledError {
  */
 export const isNotFoundError = (error: unknown): boolean =>
 	(error as { name?: string })?.name === "NotFoundError";
+
+export class MailSyncOffError extends BadRequestError {
+	name = "MailSyncOffError";
+
+	constructor(message: string, accountId: string) {
+		super(message);
+		this.publicApiError = {
+			code: "mail_sync_off",
+			details: { accountId },
+		};
+	}
+}

package/src/interfaces/account.ts

@@ -24,6 +24,9 @@ export interface IAccountRepository {
 		options?: { limit?: number; continuationToken?: string },
 	): Promise<ResultList<AccountItem>>;
 	listAllByAccountConfig(accountConfigId: string): Promise<AccountItem[]>;
+	listMailSourcesByAccountConfig(
+		accountConfigId: string,
+	): Promise<AccountItem[]>;
 	describe(accountId: string): Promise<AccountDescription>;
 	listAll(): Promise<AccountItem[]>;
 	incrementMailboxSynced(accountId: string): Promise<AccountItem>;

package/src/interfaces/calendar-collection.ts

@@ -37,6 +37,12 @@ export interface ICalendarCollectionRepository {
 	listByAccountConfig(
 		accountConfigId: string,
 	): Promise<CalendarCollectionItem[]>;
+	/**
+	 * Every `Subscribed` collection whose refresh is on, across all account
+	 * configs. The scheduled refresh walks this; a disabled subscription is
+	 * absent, which is what stops its refresh.
+	 */
+	listEnabledSubscriptions(): Promise<CalendarCollectionItem[]>;
 	findByUrlSegment(
 		accountConfigId: string,
 		urlSegment: string,

package/src/types.ts

@@ -701,7 +701,8 @@ export type CalendarEventIndexItem = z.infer<typeof CalendarEventIndexSchema>;
 
 // `calendarId` is derived from accountConfigId + urlSegment, and syncSequence
 // starts at zero and only ever moves through the collection's own bump — so
-// neither is ever supplied here.
+// neither is ever supplied here. The fetch bookkeeping starts empty and only
+// moves through an update after a fetch.
 export type CreateCalendarCollectionInput = Omit<
 	CalendarCollectionItem,
 	| "calendarId"
@@ -712,15 +713,31 @@ export type CreateCalendarCollectionInput = Omit<
 	| "componentSet"
 	| "source"
 	| "timezone"
+	| "subscriptionUrl"
+	| "subscriptionEnabled"
+	| "subscriptionCheckedAt"
+	| "subscriptionFetchedAt"
+	| "subscriptionError"
 > & {
 	color?: CalendarCollectionItem["color"];
 	componentSet?: CalendarCollectionItem["componentSet"];
 	source?: CalendarCollectionItem["source"];
 	timezone?: CalendarCollectionItem["timezone"];
+	subscriptionUrl?: CalendarCollectionItem["subscriptionUrl"];
+	subscriptionEnabled?: CalendarCollectionItem["subscriptionEnabled"];
 };
 
 export type UpdateCalendarCollectionInput = Partial<
-	Pick<CalendarCollectionItem, "displayName" | "color" | "timezone">
+	Pick<
+		CalendarCollectionItem,
+		| "displayName"
+		| "color"
+		| "timezone"
+		| "subscriptionEnabled"
+		| "subscriptionCheckedAt"
+		| "subscriptionFetchedAt"
+		| "subscriptionError"
+	>
 >;
 
 export type CalendarFeedTokenItem = z.infer<typeof CalendarFeedTokenSchema>;