add participation condition typing and stories

Author: coder13

src/components/CutoffTimeLimitPanel/CutoffTimeLimitPanel.stories.tsx

@@ -2,6 +2,8 @@ import type { Meta, StoryObj } from '@storybook/react';
 import {
   getStorybookRoundFixture,
   makeStorybookCompetitionFixtureWithRound,
+  storybookParticipationConditionLinkedRoundsFixture,
+  storybookParticipationConditionPercentFixture,
 } from '@/storybook/competitionFixtures';
 import { makeCompetitionContainerDecorator } from '@/storybook/competitionStorybook';
 import { CutoffTimeLimitPanel } from './CutoffTimeLimitPanel';
@@ -53,6 +55,24 @@ export const RankingAdvancement: Story = {
   },
 };
 
+export const ParticipationConditionPercent: Story = {
+  parameters: {
+    competitionFixture: storybookParticipationConditionPercentFixture,
+  },
+  args: {
+    round: storybookParticipationConditionPercentFixture.events[0].rounds[0],
+  },
+};
+
+export const ParticipationConditionLinkedRounds: Story = {
+  parameters: {
+    competitionFixture: storybookParticipationConditionLinkedRoundsFixture,
+  },
+  args: {
+    round: storybookParticipationConditionLinkedRoundsFixture.events[0].rounds[1],
+  },
+};
+
 export const CutoffAndTimeLimit: Story = {
   args: {
     round: getStorybookRoundFixture('222-r1'),

src/containers/CompetitionRound/CompetitionRound.stories.tsx

@@ -2,6 +2,8 @@ import type { Meta, StoryObj } from '@storybook/react';
 import {
   makeStorybookCompetitionFixtureWithRound,
   makeStorybookEventCompetitionFixture,
+  storybookParticipationConditionLinkedRoundsFixture,
+  storybookParticipationConditionPercentFixture,
 } from '@/storybook/competitionFixtures';
 import { makeCompetitionContainerDecorator } from '@/storybook/competitionStorybook';
 import { CompetitionRoundContainer } from './CompetitionRound';
@@ -24,13 +26,33 @@ export const RoundOne: Story = {
   },
 };
 
+export const ParticipationConditionPercent: Story = {
+  parameters: {
+    competitionFixture: storybookParticipationConditionPercentFixture,
+  },
+  args: {
+    competitionId: 'SeattleSummerOpen2026',
+    roundId: '333-r1',
+  },
+};
+
 export const RoundTwo: Story = {
   args: {
     competitionId: 'SeattleSummerOpen2026',
     roundId: '333-r2',
   },
 };
 
+export const ParticipationConditionLinkedRounds: Story = {
+  parameters: {
+    competitionFixture: storybookParticipationConditionLinkedRoundsFixture,
+  },
+  args: {
+    competitionId: 'SeattleSummerOpen2026',
+    roundId: '333-r2',
+  },
+};
+
 export const FinalRound: Story = {
   parameters: {
     competitionFixture: makeStorybookCompetitionFixtureWithRound('333-r3', (round) => ({

src/lib/wcif.test.ts

@@ -1,8 +1,5 @@
-import {
-  CompatibleRound,
-  getAdvancementConditionForRound,
-  getRoundParticipationRuleset,
-} from './wcif';
+import { Round } from '@wca/helpers';
+import { getAdvancementConditionForRound, getRoundParticipationRuleset } from './wcif';
 
 describe('wcif participation helpers', () => {
   it('backfills stable advancement conditions into a participation ruleset', () => {
@@ -21,7 +18,7 @@ describe('wcif participation helpers', () => {
         },
         results: [],
       },
-    ] as unknown as CompatibleRound[];
+    ] as unknown as Round[];
 
     expect(getRoundParticipationRuleset(rounds, rounds[1])).toEqual({
       participationSource: {
@@ -57,7 +54,7 @@ describe('wcif participation helpers', () => {
         },
         results: [],
       },
-    ] as unknown as CompatibleRound[];
+    ] as unknown as Round[];
 
     expect(getAdvancementConditionForRound(rounds, rounds[0])).toEqual({
       sourceType: 'round',
@@ -97,7 +94,7 @@ describe('wcif participation helpers', () => {
         },
         results: [],
       },
-    ] as unknown as CompatibleRound[];
+    ] as unknown as Round[];
 
     expect(getAdvancementConditionForRound(rounds, rounds[1])).toEqual({
       sourceType: 'linkedRounds',

src/lib/wcif.ts

@@ -1,46 +1,15 @@
-import { Round, parseActivityCode } from '@wca/helpers';
+import {
+  ParticipationResultCondition,
+  ParticipationRuleset,
+  ParticipationSource,
+  ReservedPlaces,
+  Round,
+  parseActivityCode,
+} from '@wca/helpers';
 
-type LegacyAdvancementCondition = {
-  type: 'ranking' | 'percent' | 'attemptResult';
-  level: number;
-};
-
-export type ResultCondition =
-  | {
-      type: 'ranking' | 'percent';
-      value: number;
-    }
-  | {
-      type: 'resultAchieved';
-      scope: 'single' | 'average';
-      value: number | null;
-    };
+type LegacyAdvancementCondition = NonNullable<Round['advancementCondition']>;
 
-export type ParticipationSource =
-  | {
-      type: 'registrations';
-    }
-  | {
-      type: 'round';
-      roundId: string;
-      resultCondition: ResultCondition;
-    }
-  | {
-      type: 'linkedRounds';
-      roundIds: string[];
-      resultCondition: ResultCondition;
-    };
-
-export type ReservedPlaces = {
-  nationalities: string[];
-  count?: number;
-  reservations?: number;
-};
-
-export type ParticipationRuleset = {
-  participationSource: ParticipationSource;
-  reservedPlaces?: ReservedPlaces | null;
-};
+export type ResultCondition = ParticipationResultCondition;
 
 export interface RoundAdvancementCondition {
   sourceType: ParticipationSource['type'];
@@ -49,19 +18,16 @@ export interface RoundAdvancementCondition {
   reservedPlaces?: ReservedPlaces | null;
 }
 
-export type CompatibleRound = Round & {
-  advancementCondition?: LegacyAdvancementCondition | null;
-  participationRuleset?: ParticipationRuleset | null;
-};
+export type CompatibleRound = Round;
 
 const averagedFormats = new Set(['a', 'm', '5', 'h']);
 
-const getRoundResultType = (round: Pick<CompatibleRound, 'format'>): 'single' | 'average' =>
+const getRoundResultType = (round: Pick<Round, 'format'>): 'single' | 'average' =>
   averagedFormats.has(round.format) ? 'average' : 'single';
 
 const getLegacyResultCondition = (
   advancementCondition: LegacyAdvancementCondition,
-  sourceRound?: CompatibleRound,
+  sourceRound?: Round,
 ): ResultCondition => {
   switch (advancementCondition.type) {
     case 'ranking':
@@ -83,10 +49,7 @@ const getLegacyResultCondition = (
   }
 };
 
-const getPreviousRound = (
-  eventRounds: CompatibleRound[],
-  round: CompatibleRound,
-): CompatibleRound | undefined => {
+const getPreviousRound = (eventRounds: Round[], round: Round): Round | undefined => {
   const { eventId, roundNumber } = parseActivityCode(round.id);
 
   if (!roundNumber || roundNumber <= 1) {
@@ -97,8 +60,8 @@ const getPreviousRound = (
 };
 
 export const getRoundParticipationRuleset = (
-  eventRounds: CompatibleRound[],
-  round: CompatibleRound,
+  eventRounds: Round[],
+  round: Round,
 ): ParticipationRuleset | null => {
   if (round.participationRuleset) {
     return round.participationRuleset;
@@ -123,14 +86,14 @@ export const getRoundParticipationRuleset = (
 };
 
 const getRoundParticipationSource = (
-  eventRounds: CompatibleRound[],
-  round: CompatibleRound,
+  eventRounds: Round[],
+  round: Round,
 ): ParticipationSource | null =>
   getRoundParticipationRuleset(eventRounds, round)?.participationSource ?? null;
 
 export const getAdvancementConditionForRound = (
-  eventRounds: CompatibleRound[],
-  round: CompatibleRound,
+  eventRounds: Round[],
+  round: Round,
 ): RoundAdvancementCondition | null => {
   if (round.advancementCondition) {
     return {

src/storybook/competitionFixtures.ts

@@ -730,3 +730,60 @@ export const makeStorybookCompetitionFixtureWithRound = (
 
   return competition;
 };
+
+export const makeStorybookCompetitionFixtureWithRoundUpdates = (
+  updates: Record<string, (round: Round) => Round>,
+): Competition => {
+  const competition = cloneCompetition(storybookCompetitionFixture);
+
+  competition.events = competition.events.map((event) => ({
+    ...event,
+    rounds: event.rounds.map((round) => updates[round.id]?.(round) ?? round),
+  }));
+
+  return competition;
+};
+
+export const storybookParticipationConditionPercentFixture =
+  makeStorybookCompetitionFixtureWithRoundUpdates({
+    '333-r1': (round) => ({
+      ...round,
+      advancementCondition: null,
+    }),
+    '333-r2': (round) => ({
+      ...round,
+      advancementCondition: null,
+      participationRuleset: {
+        participationSource: {
+          type: 'round',
+          roundId: '333-r1',
+          resultCondition: {
+            type: 'percent',
+            value: 75,
+          },
+        },
+      },
+    }),
+  });
+
+export const storybookParticipationConditionLinkedRoundsFixture =
+  makeStorybookCompetitionFixtureWithRoundUpdates({
+    '333-r2': (round) => ({
+      ...round,
+      advancementCondition: null,
+    }),
+    '333-r3': (round) => ({
+      ...round,
+      advancementCondition: null,
+      participationRuleset: {
+        participationSource: {
+          type: 'linkedRounds',
+          roundIds: ['333-r1', '333-r2'],
+          resultCondition: {
+            type: 'ranking',
+            value: 12,
+          },
+        },
+      },
+    }),
+  });

src/types/wca-helpers.d.ts

@@ -0,0 +1,44 @@
+import '@wca/helpers';
+
+declare module '@wca/helpers' {
+  export type ParticipationResultCondition =
+    | {
+        type: 'ranking' | 'percent';
+        value: number;
+      }
+    | {
+        type: 'resultAchieved';
+        scope: 'single' | 'average';
+        value: number | null;
+      };
+
+  export type ParticipationSource =
+    | {
+        type: 'registrations';
+      }
+    | {
+        type: 'round';
+        roundId: string;
+        resultCondition: ParticipationResultCondition;
+      }
+    | {
+        type: 'linkedRounds';
+        roundIds: string[];
+        resultCondition: ParticipationResultCondition;
+      };
+
+  export interface ReservedPlaces {
+    nationalities: string[];
+    count?: number;
+    reservations?: number;
+  }
+
+  export interface ParticipationRuleset {
+    participationSource: ParticipationSource;
+    reservedPlaces?: ReservedPlaces | null;
+  }
+
+  export interface Round {
+    participationRuleset?: ParticipationRuleset | null;
+  }
+}