@remit/data-ports 0.0.77 → 0.0.78

package/package.json

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

package/src/conformance/calendar-suggestion.ts

@@ -234,12 +234,38 @@ export function calendarSuggestionRepositoryConformance(
 				suggestion(accountConfigId, harness.makeId(), harness.makeId(), "uid"),
 			);
 
+			const newerMessageId = harness.makeId();
 			const retired = await repo.supersedeIfPending(
 				accountConfigId,
 				written.suggestionId,
+				newerMessageId,
 			);
 
 			assert.equal(retired?.state, CalendarSuggestionState.Superseded);
+			const reread = await repo.get(accountConfigId, written.suggestionId);
+			assert.equal(reread.supersededByMessageId, newerMessageId);
+		});
+
+		test("a re-read of the retired message keeps the revision that retired it", async () => {
+			const accountConfigId = harness.makeId();
+			const input = suggestion(
+				accountConfigId,
+				harness.makeId(),
+				harness.makeId(),
+				"uid",
+			);
+			const written = await repo.put(input);
+			const newerMessageId = harness.makeId();
+			await repo.supersedeIfPending(
+				accountConfigId,
+				written.suggestionId,
+				newerMessageId,
+			);
+
+			const rewritten = await repo.put(input);
+
+			assert.equal(rewritten.state, CalendarSuggestionState.Superseded);
+			assert.equal(rewritten.supersededByMessageId, newerMessageId);
 		});
 
 		test("supersedeIfPending leaves an answered card alone and says so", async () => {
@@ -258,11 +284,13 @@ export function calendarSuggestionRepositoryConformance(
 			const retired = await repo.supersedeIfPending(
 				accountConfigId,
 				written.suggestionId,
+				harness.makeId(),
 			);
 
 			assert.equal(retired, null);
 			const reread = await repo.get(accountConfigId, written.suggestionId);
 			assert.equal(reread.state, CalendarSuggestionState.Accepted);
+			assert.equal(reread.supersededByMessageId, "");
 			assert.equal(reread.acceptedCalendarObjectId, "cal-object-7");
 		});
 
@@ -273,11 +301,58 @@ export function calendarSuggestionRepositoryConformance(
 			);
 
 			assert.equal(
-				await repo.supersedeIfPending(harness.makeId(), written.suggestionId),
+				await repo.supersedeIfPending(
+					harness.makeId(),
+					written.suggestionId,
+					harness.makeId(),
+				),
 				null,
 			);
 		});
 
+		test("repointSuperseded moves a retired card to a later revision", async () => {
+			const accountConfigId = harness.makeId();
+			const written = await repo.put(
+				suggestion(accountConfigId, harness.makeId(), harness.makeId(), "uid"),
+			);
+			await repo.supersedeIfPending(
+				accountConfigId,
+				written.suggestionId,
+				harness.makeId(),
+			);
+			const newest = harness.makeId();
+
+			const repointed = await repo.repointSuperseded(
+				accountConfigId,
+				written.suggestionId,
+				newest,
+			);
+
+			assert.equal(repointed?.supersededByMessageId, newest);
+			const reread = await repo.get(accountConfigId, written.suggestionId);
+			assert.equal(reread.state, CalendarSuggestionState.Superseded);
+			assert.equal(reread.supersededByMessageId, newest);
+		});
+
+		test("repointSuperseded leaves a card that is not superseded alone", async () => {
+			const accountConfigId = harness.makeId();
+			const written = await repo.put(
+				suggestion(accountConfigId, harness.makeId(), harness.makeId(), "uid"),
+			);
+
+			assert.equal(
+				await repo.repointSuperseded(
+					accountConfigId,
+					written.suggestionId,
+					harness.makeId(),
+				),
+				null,
+			);
+			const reread = await repo.get(accountConfigId, written.suggestionId);
+			assert.equal(reread.state, CalendarSuggestionState.Pending);
+			assert.equal(reread.supersededByMessageId, "");
+		});
+
 		test("settle rejects a suggestion that is not there", async () => {
 			const accountConfigId = harness.makeId();
 			await assert.rejects(

package/src/interfaces/calendar-suggestion.ts

@@ -56,8 +56,9 @@ export interface ICalendarSuggestionRepository {
 		input: SettleCalendarSuggestionInput,
 	): Promise<CalendarSuggestionItem>;
 	/**
-	 * Retires a card as `Superseded`, but only while it is still `Pending`.
-	 * Returns the retired row, or `null` when the card had already been
+	 * Retires a card as `Superseded`, but only while it is still `Pending`, and
+	 * records the message whose revision retired it so the card can open that
+	 * one. Returns the retired row, or `null` when the card had already been
 	 * answered and nothing was written.
 	 *
 	 * A compare-and-set rather than a plain `settle` because the producer reads
@@ -69,5 +70,16 @@ export interface ICalendarSuggestionRepository {
 	supersedeIfPending(
 		accountConfigId: string,
 		suggestionId: string,
+		supersededByMessageId: string,
+	): Promise<CalendarSuggestionItem | null>;
+	/**
+	 * Points a card already `Superseded` at a later revision, so every retired
+	 * revision of an event opens the newest one. Returns the updated row, or
+	 * `null` when the card is not superseded and nothing was written.
+	 */
+	repointSuperseded(
+		accountConfigId: string,
+		suggestionId: string,
+		supersededByMessageId: string,
 	): Promise<CalendarSuggestionItem | null>;
 }

package/src/types.ts

@@ -788,13 +788,15 @@ export type CalendarSuggestionItem = z.infer<typeof CalendarSuggestionSchema>;
  * `state` and `acceptedCalendarObjectId` are excluded: a producer only ever
  * writes a `Pending` suggestion, and the two fields that record what a person
  * decided move exclusively through `settle`, so a re-sync can never walk an
- * answered card back to Pending.
+ * answered card back to Pending. `supersededByMessageId` moves only through
+ * `supersedeIfPending`, with the state it explains.
  */
 export type PutCalendarSuggestionInput = Omit<
 	CalendarSuggestionItem,
 	| "suggestionId"
 	| "state"
 	| "acceptedCalendarObjectId"
+	| "supersededByMessageId"
 	| "createdAt"
 	| "updatedAt"
 >;