Custom field in ParticipantResult

[laukaichung]

I'd like to store an extra field for a football match decided by a penalty shoot-out. Is it possible to allow creating a custom field, like extra, to store any data in ParticipantResult when updating a match:

bracketsManager.update.match({
   id: 1,
    opponent1: {
      id: 25,
      score: 0,
      result: "win",
      extra: {penaltyScore: 5},
    },
    opponent2: {
      id: 26,
      score: 0,
      result: "loss",
      extra: { penaltyScore: 4 }
    },
  });

[Drarig29]

Hi, thanks for the idea!

I just implemented and released it in v1.5.2. I didn't enforce you to use extra: you can just drop penaltyScore in the ParticipantResult if you want.

#143 was in the same vein FYI.

[laukaichung]

Thanks again. It works great!
I think the ParticipantResult typescript definition needs to update as well to avoid type complaints in bracketsManager.update.match. Something like this should work:

export interface ParticipantResult extends Record<string, unknown>{
    /** If `null`, the participant is to be determined. */
    id: number | null;
    /** Indicates where the participant comes from. */
    position?: number;
    /** If this participant forfeits, the other automatically wins. */
    forfeit?: boolean;
    /** The current score of the participant. */
    score?: number;
    /** Tells what is the result of a duel for this participant. */
    result?: Result;
}

[Drarig29]

Hmm, can you show what kind of "type complaints" you have?

[laukaichung]

The IDE shows this error:

TS2322: Type '{ id: number; score: number; result: "draw" | "win" | "loss"; penaltyScore: number | undefined; }' is not assignable to type 'ParticipantResult'.
Object literal may only specify known properties, and 'penaltyScore' does not exist in type 'ParticipantResult'

but I have fixed it by type assertion, so it's all good:

interface ExtendedParticipantResult extends ParticipantResult {
 penaltyScore: number;
}

bracketsManager.update.match({
  id: 1,
   opponent1: {
     id: 25,
     score: 0,
     result: "win",
     penaltyScore: 5,
   } as ExtendedParticipantResult ,
 });

[Drarig29]

That's what I wanted. Sorry I didn't tell you how to use the change.

What I wanted was:

• Backwards compatibility
• Only update.match() and update.matchGame() should be able to take used-defined data. The rest of the lib only does partial updates, so the user-defined data should stay here.
• I didn't want match<T extends MatchResults> because the hints and the explicit link to MatchResults would be broken in the general use case.
• You should have a compilation error if you didn't intend to have user-defined properties.

So I used match<T extends MatchResults = Match> to make the generic type optional for the general use case.

If you do want to introduce user-defined properties, the idiomatic way is to pass a custom interface as a generic:

interface CustomMatch extends Match {
  opponent1: Match['opponent1'] & {penaltyScore: number}
  opponent2: Match['opponent2'] & {penaltyScore: number}
}

bracketsManager.update.match<CustomMatch>({
  id: 1,
   opponent1: {
     id: 25,
     score: 0,
     result: "win",
     penaltyScore: 5,
   },
 });

[Drarig29]

I believe you could also use declaration merging to have an edited version of the Match interface in your whole codebase.