tods-competition-factory 1.8.28 → 1.8.29

package/dist/tods-competition-factory.development.cjs.js

@@ -2929,7 +2929,7 @@ var matchUpFormatCode = {
 };
 
 function factoryVersion() {
-    return '1.8.28';
+    return '1.8.29';
 }
 
 function getObjectTieFormat(obj) {
@@ -4187,8 +4187,8 @@ var validMatchUpStatuses = [
 ];
 var directingMatchUpStatuses = [
     BYE,
-    DOUBLE_WALKOVER,
-    DOUBLE_DEFAULT,
+    DOUBLE_WALKOVER, // directing because of a produced WALKOVER
+    DOUBLE_DEFAULT, // directing because of a produced WALKOVER
     COMPLETED$1,
     DEFAULTED,
     RETIRED$1,
@@ -5506,31 +5506,31 @@ var TIE_FORMAT_MODIFICATIONS = 'tieFormatModification';
 var extensionConstants = {
     APPLIED_POLICIES: APPLIED_POLICIES,
     AUDIT_POSITION_ACTIONS: AUDIT_POSITION_ACTIONS,
-    CONTEXT: CONTEXT,
+    CONTEXT: CONTEXT, // used to capture, e.g. context in which a venue was added
     DELEGATED_OUTCOME: DELEGATED_OUTCOME,
     DISABLED: DISABLED,
     DISABLE_LINKS: DISABLE_LINKS,
     DISABLE_AUTO_CALC: DISABLE_AUTO_CALC,
     DRAW_DELETIONS: DRAW_DELETIONS,
     DRAW_PROFILE: DRAW_PROFILE,
-    ENTRY_PROFILE: ENTRY_PROFILE,
+    ENTRY_PROFILE: ENTRY_PROFILE, // used for drawGeneration; not relevant for anonymized tournaments
     EVENT_PROFILE: EVENT_PROFILE,
     FLIGHT_PROFILE: FLIGHT_PROFILE,
-    GROUPING_ATTRIBUTE: GROUPING_ATTRIBUTE,
+    GROUPING_ATTRIBUTE: GROUPING_ATTRIBUTE, // for generating teams; not relevant for anonymized tournaments
     LINEUPS: LINEUPS,
     LINKED_TOURNAMENTS: LINKED_TOURNAMENTS,
     MATCHUP_HISTORY: MATCHUP_HISTORY,
     PARTICIPANT_REPRESENTATIVES: PARTICIPANT_REPRESENTATIVES,
     PERSON_REQUESTS: PERSON_REQUESTS,
-    RANKING_POINTS: RANKING_POINTS,
+    RANKING_POINTS: RANKING_POINTS, // for attaching points awarded to tournamentRecord
     ROUND_TARGET: ROUND_TARGET,
     SCHEDULE_LIMITS: SCHEDULE_LIMITS,
     SCHEDULE_TIMING: SCHEDULE_TIMING,
     SCHEDULING_PROFILE: SCHEDULING_PROFILE,
-    STATUS_DETAIL: STATUS_DETAIL,
+    STATUS_DETAIL: STATUS_DETAIL, // attached to event.entries
     SUB_ORDER: SUB_ORDER,
     TALLY: TALLY,
-    TIE_FORMAT_MODIFICATIONS: TIE_FORMAT_MODIFICATIONS,
+    TIE_FORMAT_MODIFICATIONS: TIE_FORMAT_MODIFICATIONS, // for auditing, not important when anonymized
     FACTORY: FACTORY$1,
 };
 var internalExtensions = [
@@ -6638,8 +6638,8 @@ var topicConstants = {
     DELETED_DRAW_IDS: DELETED_DRAW_IDS,
     DELETED_MATCHUP_IDS: DELETED_MATCHUP_IDS,
     MODIFY_DRAW_DEFINITION: MODIFY_DRAW_DEFINITION,
-    MODIFY_DRAW_ENTRIES: MODIFY_DRAW_ENTRIES,
-    MODIFY_EVENT_ENTRIES: MODIFY_EVENT_ENTRIES,
+    MODIFY_DRAW_ENTRIES: MODIFY_DRAW_ENTRIES, // TODO
+    MODIFY_EVENT_ENTRIES: MODIFY_EVENT_ENTRIES, // TODO
     MODIFY_MATCHUP: MODIFY_MATCHUP,
     MODIFY_PARTICIPANTS: MODIFY_PARTICIPANTS,
     MODIFY_POSITION_ASSIGNMENTS: MODIFY_POSITION_ASSIGNMENTS,
@@ -8526,7 +8526,7 @@ function getStructureSeedAssignments(_a) {
             return {
                 participantId: entry.participantId,
                 seedValue: seedNumber,
-                seedProxy: true,
+                seedProxy: true, // flag so that proxy seeding information doesn't get used externally
                 seedNumber: seedNumber,
             };
         })
@@ -11197,7 +11197,7 @@ function targetByRoundOutcome(_a) {
 function targetByWinRatio(_a) {
     var matchUp = _a.matchUp;
     return {
-        targetLinks: { loserTargetLink: undefined, winnerTargetLink: undefined },
+        targetLinks: { loserTargetLink: undefined, winnerTargetLink: undefined }, // returned for testing
         targetMatchUps: { loserMatchUp: undefined, winnerMatchUp: undefined },
         matchUp: matchUp,
     };
@@ -11749,7 +11749,7 @@ function modifyMatchUpScore(_a) {
             // participantsProfile: { withGroupings: true },
             matchUpFilters: { matchUpIds: [matchUpId] },
             nextMatchUps: true,
-            tournamentRecord: tournamentRecord,
+            tournamentRecord: tournamentRecord, // required to hydrate participants
             inContext: true,
             drawDefinition: drawDefinition,
             matchUpsMap: matchUpsMap,
@@ -16693,14 +16693,14 @@ var POLICY_POSITION_ACTIONS_DEFAULT = (_a$e = {},
         // enabledStructures: [] => all structures are enabled
         enabledStructures: [
             {
-                stages: [QUALIFYING, MAIN],
-                stageSequences: [1],
-                enabledActions: [],
+                stages: [QUALIFYING, MAIN], // stages to which this policy applies
+                stageSequences: [1], // stageSequences to which this policy applies
+                enabledActions: [], // enabledActions: [] => all actions are enabled
                 disabledActions: [], // disabledActions: [] => no actions are disabled
             },
             {
-                stages: [],
-                stageSequences: [],
+                stages: [], // stages: [] => applies to all stages
+                stageSequences: [], // stageSequences: [] => applies to all stageSequences
                 enabledActions: [
                     ADD_NICKNAME,
                     ADD_PENALTY,
@@ -16738,8 +16738,8 @@ var POLICY_POSITION_ACTIONS_NO_MOVEMENT = (_a$c = {},
         // enabledStructures: [] => all structures are enabled
         enabledStructures: [
             {
-                stages: [],
-                stageSequences: [],
+                stages: [], // stages: [] => applies to all stages
+                stageSequences: [], // stageSequences: [] => applies to all stageSequences
                 enabledActions: [SEED_VALUE, ADD_NICKNAME, ADD_PENALTY],
                 disabledActions: [], // disabledActions: [] => no actions are disabled
             },
@@ -16863,7 +16863,7 @@ var POLICY_SCHEDULING_DEFAULT = (_a$9 = {},
             _c),
         matchUpAverageTimes: [
             {
-                matchUpFormatCodes: [FORMAT_STANDARD],
+                matchUpFormatCodes: [FORMAT_STANDARD], // Best of 3 tiebreak sets
                 averageTimes: [
                     {
                         categoryNames: [],
@@ -16876,31 +16876,31 @@ var POLICY_SCHEDULING_DEFAULT = (_a$9 = {},
                 ],
             },
             {
-                matchUpFormatCodes: ['SET3-S:6/TB7-F:TB10'],
+                matchUpFormatCodes: ['SET3-S:6/TB7-F:TB10'], // Two tiebreak sets, 10-point match tiebreak at one set all
                 averageTimes: [{ categoryNames: [], minutes: { default: 85 } }],
             },
             {
-                matchUpFormatCodes: ['SET3-S:6/TB7-F:TB7'],
+                matchUpFormatCodes: ['SET3-S:6/TB7-F:TB7'], // Two tiebreak sets, 7-point match tiebreak at one set all
                 averageTimes: [{ categoryNames: [], minutes: { default: 70 } }],
             },
             {
-                matchUpFormatCodes: ['SET3-S:4NOAD-F:TB7'],
+                matchUpFormatCodes: ['SET3-S:4NOAD-F:TB7'], // Two short sets to 4 with deciding game at 3-3, 7-point match tiebreak at one set all
                 averageTimes: [{ categoryNames: [], minutes: { default: 55 } }],
             },
             {
-                matchUpFormatCodes: ['SET3-S:4/TB7'],
+                matchUpFormatCodes: ['SET3-S:4/TB7'], // Best of 3 sets to 4
                 averageTimes: [{ categoryNames: [], minutes: { default: 60 } }],
             },
             {
-                matchUpFormatCodes: ['SET3-S:4/TB7-F:TB7'],
+                matchUpFormatCodes: ['SET3-S:4/TB7-F:TB7'], // Two short sets to 4, 7-point match tiebreak at one set all
                 averageTimes: [{ categoryNames: [], minutes: { default: 50 } }],
             },
             {
-                matchUpFormatCodes: ['SET3-S:4/TB7-F:TB10'],
+                matchUpFormatCodes: ['SET3-S:4/TB7-F:TB10'], // Two short sets to 4, 10-point match tiebreak at one set all
                 averageTimes: [{ categoryNames: [], minutes: { default: 55 } }],
             },
             {
-                matchUpFormatCodes: ['SET3-S:4/TB5@3'],
+                matchUpFormatCodes: ['SET3-S:4/TB5@3'], // Two out of three short sets to 4 with 5-point tiebreak at 3 games all
                 averageTimes: [{ categoryNames: [], minutes: { default: 45 } }],
             },
             {
@@ -16911,15 +16911,15 @@ var POLICY_SCHEDULING_DEFAULT = (_a$9 = {},
                 averageTimes: [{ categoryNames: [], minutes: { default: 40 } }],
             },
             {
-                matchUpFormatCodes: ['SET1-S:5/TB9@4'],
+                matchUpFormatCodes: ['SET1-S:5/TB9@4'], // One no advantage set to 5, tiebreak to 9 at 4-4
                 averageTimes: [{ categoryNames: [], minutes: { default: 30 } }],
             },
             {
-                matchUpFormatCodes: ['SET1-S:6/TB7'],
+                matchUpFormatCodes: ['SET1-S:6/TB7'], // One standard tiebreak set to 6, 7-point tiebreak at 6 games all
                 averageTimes: [{ categoryNames: [], minutes: { default: 30 } }],
             },
             {
-                matchUpFormatCodes: ['SET1-S:6NOAD'],
+                matchUpFormatCodes: ['SET1-S:6NOAD'], // One set to 6 with deciding game at 5 games all
                 averageTimes: [{ categoryNames: [], minutes: { default: 30 } }],
             },
             {
@@ -16932,11 +16932,11 @@ var POLICY_SCHEDULING_DEFAULT = (_a$9 = {},
                 averageTimes: [{ categoryNames: [], minutes: { default: 20 } }],
             },
             {
-                matchUpFormatCodes: ['SET1-S:4NOAD'],
+                matchUpFormatCodes: ['SET1-S:4NOAD'], // One short set to 4, deciding game is played at 3 games all
                 averageTimes: [{ categoryNames: [], minutes: { default: 20 } }],
             },
             {
-                matchUpFormatCodes: ['SET1-S:TB10'],
+                matchUpFormatCodes: ['SET1-S:TB10'], // One 10-point tiebreak game
                 averageTimes: [{ categoryNames: [], minutes: { default: 10 } }],
             },
         ],
@@ -16997,7 +16997,7 @@ var POLICY_SCHEDULING_DEFAULT = (_a$9 = {},
                 ],
             },
             {
-                matchUpFormatCodes: ['SET1-S:4/TB5@3'],
+                matchUpFormatCodes: ['SET1-S:4/TB5@3'], // One short set to 4, 5-point tiebreak at 3 games all
                 recoveryTimes: [
                     {
                         categoryTypes: [ADULT, JUNIOR],
@@ -17010,7 +17010,7 @@ var POLICY_SCHEDULING_DEFAULT = (_a$9 = {},
                 ],
             },
             {
-                matchUpFormatCodes: ['SET1-S:TB10'],
+                matchUpFormatCodes: ['SET1-S:TB10'], // One 10-point tiebreak game
                 recoveryTimes: [
                     {
                         categoryNames: [],
@@ -18122,7 +18122,7 @@ function addFinishingRounds(_a) {
     if (!validMatchUps(matchUps))
         return [];
     var _d = getRoundMatchUps$1({
-        interpolate: true,
+        interpolate: true, // for structures which do not contain a final round of one matchUps (structure winner)
         matchUps: matchUps,
     }), roundProfile = _d.roundProfile, _e = _d.roundNumbers, roundNumbers = _e === void 0 ? [] : _e;
     roundsCount = roundsCount || Math.max.apply(Math, __spreadArray(__spreadArray([], __read(roundNumbers), false), [0], false));
@@ -19080,7 +19080,7 @@ var baseAttributeKeys = [
     'tieMatchUps',
     'roundPosition',
     'score',
-    'sides',
+    'sides', // can be removed only if drawPositions is present and is not a TEAM matchUp
     'winnerMatchUpId',
     'loserMatchUpId',
     'matchUpDuration',
@@ -21586,8 +21586,8 @@ function tidyScore(params) {
     var doProcess = function (methods) {
         methods.forEach(function (method) {
             result = transforms[method]({
-                profile: profile,
-                identifier: identifier,
+                profile: profile, // config object compatible with provider profiles
+                identifier: identifier, // optional identifier (used in test harness)
                 matchUpStatus: matchUpStatus,
                 attributes: attributes,
                 applied: applied,
@@ -25716,7 +25716,7 @@ function roundRobinMatchUps(_a) {
             matchUpStatus: roundNumber
                 ? MatchUpStatusEnum.ToBePlayed
                 : MatchUpStatusEnum.Bye,
-            matchUpType: matchUpType,
+            matchUpType: matchUpType, // does not (perhaps) need to be included; but because structures[].structure unsure about derivation inContext
             // finishingPositionRange in RR is not very useful, but provided for consistency
             finishingPositionRange: { winner: range, loser: range },
             drawPositions: drawPositions,
@@ -28047,7 +28047,7 @@ function setMatchUpStatus$2(params) {
     var matchUpTieId = inContextMatchUp === null || inContextMatchUp === void 0 ? void 0 : inContextMatchUp.matchUpTieId;
     // Get winner/loser position targets ----------------------------------------
     var targetData = positionTargets({
-        matchUpId: matchUpTieId || matchUpId,
+        matchUpId: matchUpTieId || matchUpId, // get targets for TEAM matchUp if tieMatchUp
         inContextDrawMatchUps: inContextDrawMatchUps,
         drawDefinition: drawDefinition,
     });
@@ -28755,7 +28755,7 @@ function addDrawDefinition$1(params) {
     else {
         var flights = (flightProfile === null || flightProfile === void 0 ? void 0 : flightProfile.flights) || [];
         flights.push({
-            manuallyAdded: true,
+            manuallyAdded: true, // this drawDefinition was not part of automated split
             flightNumber: drawOrder,
             drawEntries: drawEntries,
             drawName: drawName,
@@ -29101,7 +29101,7 @@ function getEventPublishStatuses(_a) {
     if ((_b = timeItem === null || timeItem === void 0 ? void 0 : timeItem.itemValue) === null || _b === void 0 ? void 0 : _b.PUBLIC) {
         var _c = timeItem.itemValue.PUBLIC || {}, _d = _c.drawIds, publishedDrawIds = _d === void 0 ? [] : _d, seeding = _c.seeding;
         var publishedSeeding = {
-            published: undefined,
+            published: undefined, // seeding can be present for all entries in an event when no flights have been defined
             seedingScaleNames: [],
             drawIds: [], // seeding can be specific to drawIds
         };
@@ -33210,7 +33210,7 @@ var competitionGovernor = {
     unlinkTournament: unlinkTournament,
     unlinkTournaments: unlinkTournaments,
     getLinkedTournamentIds: getLinkedTournamentIds,
-    addDrawDefinition: addDrawDefinition,
+    addDrawDefinition: addDrawDefinition, // test
     getCompetitionParticipants: getCompetitionParticipants,
     getParticipants: getParticipants,
     addParticipant: addParticipant,
@@ -33218,10 +33218,10 @@ var competitionGovernor = {
     setMatchUpStatus: setMatchUpStatus,
     bulkMatchUpStatusUpdate: bulkMatchUpStatusUpdate,
     bulkScheduleMatchUps: bulkScheduleMatchUps,
-    addPenalty: addPenalty,
-    removePenalty: removePenalty,
-    modifyPenalty: modifyPenalty,
-    getCompetitionPenalties: getCompetitionPenalties,
+    addPenalty: addPenalty, // test
+    removePenalty: removePenalty, // test
+    modifyPenalty: modifyPenalty, // test
+    getCompetitionPenalties: getCompetitionPenalties, // test
     findParticipant: publicFindParticipant,
 };
 
@@ -34522,8 +34522,8 @@ function competitionScheduleMatchUps(params) {
         courtsData: courtsData,
         completedMatchUps: alwaysReturnCompleted
             ? allCompletedMatchUps
-            : completedMatchUps,
-        dateMatchUps: dateMatchUps,
+            : completedMatchUps, // completed matchUps for the filter date
+        dateMatchUps: dateMatchUps, // all incomplete matchUps for the filter date
         venues: venues,
     };
     if (withCourtGridRows) {
@@ -34677,7 +34677,7 @@ function calculateScheduleTimes(_a) {
     // need to reduce courts available for a given time period by the number of matchUps scheduled at a given venue
     var matchUpFilters = { scheduledDate: scheduleDate, venueIds: venueIds };
     var matchUpsWithSchedule = competitionScheduleMatchUps({
-        sortDateMatchUps: false,
+        sortDateMatchUps: false, // unnecessary for extracting bookings; reduce processing overhead;
         tournamentRecords: tournamentRecords,
         matchUpFilters: matchUpFilters,
     });
@@ -34797,8 +34797,8 @@ function checkParticipantProfileInitialization(_a) {
             typeChangeTimeAfterRecovery: undefined,
             timeAfterRecovery: undefined,
             priorMatchUpType: undefined,
-            potentialRecovery: {},
-            potentialCounted: {},
+            potentialRecovery: {}, // { [drawId]: [timeString] } - timeAfterRecovery for potential matchUps by drawId
+            potentialCounted: {}, // whether a potential matchUp has been counted for daily limits for a specific drawId
             potentialBookings: {},
             bookings: [],
             counters: {},
@@ -35406,7 +35406,7 @@ function getVenueSchedulingDetails(_a) {
         }), matchUpsToSchedule = _g.matchUpsToSchedule, matchUpMap = _g.matchUpMap;
         var venueCourts = courts.filter(function (court) { return court.venueId === venueId; });
         venueScheduledRoundDetails[venueId] = {
-            previousRemainingScheduleTimes: [],
+            previousRemainingScheduleTimes: [], // keep track of sheduleTimes not used on previous iteration
             courtsCount: venueCourts.length,
             greatestAverageMinutes: greatestAverageMinutes,
             scheduledRoundsDetails: scheduledRoundsDetails,
@@ -37671,10 +37671,10 @@ function getRoundId(obj) {
     var relevantStructureId = isRoundRobin ? containerStructureId : structureId;
     // retain order
     var id = [
-        tournamentId,
-        eventId,
-        drawId,
-        relevantStructureId,
+        tournamentId, // 1
+        eventId, // 2
+        drawId, // 3
+        relevantStructureId, // 4
         roundNumber, // 5
     ].join('|');
     return definedAttributes({
@@ -38827,7 +38827,7 @@ var scheduleGovernor$1 = {
     getMatchUpFormatTimingUpdate: getMatchUpFormatTimingUpdate$1,
     getEventMatchUpFormatTiming: getEventMatchUpFormatTiming,
     removeEventMatchUpFormatTiming: removeEventMatchUpFormatTiming,
-    getMatchUpDailyLimitsUpdate: getMatchUpDailyLimitsUpdate$1,
+    getMatchUpDailyLimitsUpdate: getMatchUpDailyLimitsUpdate$1, // document
     getMatchUpDailyLimits: getMatchUpDailyLimits,
     setMatchUpDailyLimits: setMatchUpDailyLimits,
     getProfileRounds: getProfileRounds,
@@ -38835,7 +38835,7 @@ var scheduleGovernor$1 = {
     assignMatchUpVenue: assignMatchUpVenue,
     assignMatchUpCourt: assignMatchUpCourt,
     allocateTeamMatchUpCourts: allocateTeamMatchUpCourts,
-    addMatchUpScheduleItems: addMatchUpScheduleItems,
+    addMatchUpScheduleItems: addMatchUpScheduleItems, // test
     addMatchUpScheduledDate: addMatchUpScheduledDate,
     addMatchUpScheduledTime: addMatchUpScheduledTime,
     addMatchUpCourtOrder: addMatchUpCourtOrder,
@@ -38843,7 +38843,7 @@ var scheduleGovernor$1 = {
     addMatchUpStopTime: addMatchUpStopTime,
     addMatchUpResumeTime: addMatchUpResumeTime,
     addMatchUpEndTime: addMatchUpEndTime,
-    addMatchUpOfficial: addMatchUpOfficial,
+    addMatchUpOfficial: addMatchUpOfficial, // test
     getSchedulingProfile: getSchedulingProfile$1,
     setSchedulingProfile: setSchedulingProfile$1,
     addSchedulingProfileRound: addSchedulingProfileRound,
@@ -39235,14 +39235,14 @@ var POLICY_MATCHUP_ACTIONS_DEFAULT = (_a$2 = {},
         // enabledStructures: [] => all structures are enabled
         enabledStructures: [
             {
-                stages: [],
-                stageSequences: [],
+                stages: [], // stages: [] => applies to all stages
+                stageSequences: [], // stageSequences: [] => applies to all stageSequences
                 enabledActions: [],
                 disabledActions: [], // disabledActions: [] => no actions are disabled
             },
         ],
         participants: {
-            enforceCategory: true,
+            enforceCategory: true, // validate collectionDefinition.category against event.category
             enforceGender: true, // disallow placing FEMALEs in MALE events and vice versa
         },
         processCodes: {
@@ -39628,7 +39628,7 @@ function matchUpActions$2(_a) {
         };
         validActions.push({
             info: 'set outcome and winningSide',
-            method: SCHEDULE_METHOD,
+            method: SCHEDULE_METHOD, // setMatchUpStatus
             type: SCORE,
             payload: payload,
         });
@@ -41921,7 +41921,7 @@ function generateQualifyingLink(_a) {
             finishingPositions: finishingPositions,
         },
         target: {
-            feedProfile: DRAW,
+            feedProfile: DRAW, // positions are not automatically placed
             roundNumber: targetEntryRound,
             structureId: targetStructureId,
         },
@@ -42139,7 +42139,7 @@ function generateQualifyingStructures(_a) {
                         matchUpFormat: matchUpFormat,
                         stageSequence: stageSequence,
                         matchUpType: matchUpType,
-                        roundLimit: roundLimit,
+                        roundLimit: roundLimit, // redundant
                         matchUps: matchUps,
                     });
                     if (roundTarget) {
@@ -42450,7 +42450,7 @@ function getAvailablePlayoffProfiles$1(_a) {
     else {
         return {
             availablePlayoffProfiles: Object.values(available),
-            availablePlayoffRounds: Object.values(available),
+            availablePlayoffRounds: Object.values(available), // to be deprecated
             positionsPlayedOff: positionsPlayedOff,
         };
     }
@@ -47248,7 +47248,7 @@ function generateQualifyingStructure$1(params) {
             matchUpFormat: matchUpFormat,
             stageSequence: stageSequence,
             matchUpType: matchUpType,
-            roundLimit: roundLimit,
+            roundLimit: roundLimit, // redundant
             matchUps: matchUps,
         });
         if (roundTarget) {
@@ -48144,7 +48144,7 @@ var structureGovernor = {
     generateQualifyingStructure: generateQualifyingStructure$1,
     attachQualifyingStructure: attachQualifyingStructure$1,
     addQualifyingStructure: addQualifyingStructure$1,
-    getAvailablePlayoffRounds: getAvailablePlayoffProfiles$1,
+    getAvailablePlayoffRounds: getAvailablePlayoffProfiles$1, // to be deprecated,
     getAvailablePlayoffProfiles: getAvailablePlayoffProfiles$1,
     getSourceRounds: getSourceRounds,
     getDrawStructures: getDrawStructures,
@@ -48157,7 +48157,7 @@ var structureGovernor = {
     addVoluntaryConsolationStage: addVoluntaryConsolationStage$1,
     addVoluntaryConsolationStructure: addVoluntaryConsolationStructure$1,
     generateVoluntaryConsolation: generateVoluntaryConsolation$1,
-    buildDrawHierarchy: buildDrawHierarchy,
+    buildDrawHierarchy: buildDrawHierarchy, // obsolete
     generateDrawTypeAndModifyDrawDefinition: generateDrawTypeAndModifyDrawDefinition$1,
     generateDrawStructuresAndLinks: generateDrawStructuresAndLinks$1,
 };
@@ -49551,7 +49551,7 @@ function addEventEntries(params) {
             removedEntries.push.apply(removedEntries, __spreadArray([], __read(ungroupedParticipantIdsToRemove), false));
             removeEventEntries({
                 participantIds: ungroupedParticipantIdsToRemove,
-                autoEntryPositions: false,
+                autoEntryPositions: false, // because the method will be called below if necessary
                 event: event,
             });
         }
@@ -52169,16 +52169,16 @@ function getValidQualifiersAction(_a) {
     // disallow placing qualifiers until source structure is completed
     var requireCompletedStructures = policy === null || policy === void 0 ? void 0 : policy.requireCompletedStructures;
     var _h = getSourceStructureIdsAndRelevantLinks({
-        targetRoundNumber: targetRoundNumber,
-        linkType: WINNER,
+        targetRoundNumber: targetRoundNumber, // look for soure structrues targeting roundNumber
+        linkType: WINNER, // WINNER of qualifying structures will traverse link
         drawDefinition: drawDefinition,
         structureId: structureId,
     }) || {}, eliminationSoureStructureIds = _h.sourceStructureIds, eliminationSourceLinks = _h.relevantLinks;
     if (eliminationSoureStructureIds === null || eliminationSoureStructureIds === void 0 ? void 0 : eliminationSoureStructureIds.length)
         sourceStructureIds.push.apply(sourceStructureIds, __spreadArray([], __read(eliminationSoureStructureIds), false));
     var _j = getSourceStructureIdsAndRelevantLinks({
-        targetRoundNumber: targetRoundNumber,
-        linkType: POSITION,
+        targetRoundNumber: targetRoundNumber, // look for soure structrues targeting roundNumber
+        linkType: POSITION, // link will define how many finishingPositions traverse the link
         drawDefinition: drawDefinition,
         structureId: structureId,
     }) || {}, roundRobinSourceStructureIds = _j.sourceStructureIds, roundRobinSourceLinks = _j.relevantLinks;
@@ -52307,7 +52307,7 @@ function getValidQualifiersAction(_a) {
     if (qualifyingParticipantIds.length) {
         validAssignmentActions.push(definedAttributes({
             payload: {
-                qualifyingParticipantId: undefined,
+                qualifyingParticipantId: undefined, // to be provided by client
                 drawPosition: drawPosition,
                 structureId: structureId,
                 drawId: drawId,
@@ -54969,7 +54969,7 @@ function addParticipantContext(params) {
                 if ((event === null || event === void 0 ? void 0 : event.eventType) === TEAM$2) {
                     // add back lineUps extension for team resolution when { matchUpType: TEAM } is missing side.lineUps
                     var extension = findExtension$2({
-                        element: rawEvent.drawDefinitions[i],
+                        element: rawEvent.drawDefinitions[i], // rawEvent because deepCopy has converted extensions
                         name: LINEUPS,
                     }).extension;
                     if (extension)
@@ -54989,7 +54989,7 @@ function addParticipantContext(params) {
             if ((_c = timeItem === null || timeItem === void 0 ? void 0 : timeItem.itemValue) === null || _c === void 0 ? void 0 : _c.PUBLIC) {
                 var _h = timeItem.itemValue.PUBLIC || {}, _j = _h.drawIds, publishedDrawIds = _j === void 0 ? [] : _j, seeding = _h.seeding;
                 var publishedSeeding = {
-                    published: undefined,
+                    published: undefined, // seeding can be present for all entries in an event when no flights have been defined
                     seedingScaleNames: [],
                     drawIds: [], // seeding can be specific to drawIds
                 };
@@ -58752,9 +58752,9 @@ function analyzeDraws(_a) {
     if (!tournamentRecord)
         return { error: MISSING_TOURNAMENT_RECORD };
     var drawsAnalysis = {
-        positionsNoOutcomes: [],
-        canBePruned: [],
-        matchPlay: [],
+        positionsNoOutcomes: [], // all positions assigned and no outcomes
+        canBePruned: [], // partially assigned positions with outcomes => drawSizes can be reduced
+        matchPlay: [], // only first round has active matchUps; some unassigned positions
         inactive: [],
         drawAnalysis: {},
     };
@@ -59293,9 +59293,9 @@ var scheduleGovernor = {
     removeEventMatchUpFormatTiming: removeEventMatchUpFormatTiming$1,
     getMatchUpFormatTimingUpdate: getMatchUpFormatTimingUpdate,
     getMatchUpDependencies: getMatchUpDependencies,
-    getMatchUpDailyLimits: getMatchUpDailyLimits$1,
-    setMatchUpDailyLimits: setMatchUpDailyLimits$1,
-    getMatchUpDailyLimitsUpdate: getMatchUpDailyLimitsUpdate,
+    getMatchUpDailyLimits: getMatchUpDailyLimits$1, // document
+    setMatchUpDailyLimits: setMatchUpDailyLimits$1, // document
+    getMatchUpDailyLimitsUpdate: getMatchUpDailyLimitsUpdate, // document
     validateSchedulingProfile: validateSchedulingProfile,
     setSchedulingProfile: setSchedulingProfile,
     getSchedulingProfile: getSchedulingProfile,
@@ -59402,7 +59402,7 @@ function getEntryStatusReports(_a) {
     var tournamentId = tournamentRecord.tournamentId;
     var participantMap = getParticipants$1({
         withScaleValues: true,
-        withEvents: true,
+        withEvents: true, // so that event rankings will be present
         withSeeding: true,
         tournamentRecord: tournamentRecord,
         withDraws: true,
@@ -59757,18 +59757,19 @@ function getParticipantStats(_a) {
             if (teamParticipantId) {
                 var processForTeam = !opponentParticipantId ||
                     sides.every(function (side) {
-                        side.participant &&
+                        return (side.participant &&
                             (getCompetitorIds({
-                                side: side,
                                 individualParticipantIds: teamMap.get(teamParticipantId),
+                                side: side,
                             }) ||
                                 getCompetitorIds({
-                                    side: side,
                                     individualParticipantIds: teamMap.get(opponentParticipantId),
-                                }));
+                                    side: side,
+                                })));
                     });
-                if (processForTeam)
+                if (processForTeam) {
                     processSides(teamParticipantId, teamMap.get(teamParticipantId));
+                }
             }
             else {
                 try {
@@ -62493,7 +62494,7 @@ function setEntryPositions(_a) {
             var positioning = entryPositions_1_1.value;
             var participantId = positioning.participantId, entryPosition = positioning.entryPosition;
             var result = setEntryPosition({
-                skipRefresh: true,
+                skipRefresh: true, // avoid redundant processing
                 tournamentRecord: tournamentRecord,
                 drawDefinition: drawDefinition,
                 participantId: participantId,
@@ -65033,7 +65034,7 @@ var eventGovernor = {
     addDrawEntries: addDrawEntries,
     removeSeeding: removeSeeding,
     autoSeeding: autoSeeding,
-    getAvailablePlayoffRounds: getAvailablePlayoffProfiles,
+    getAvailablePlayoffRounds: getAvailablePlayoffProfiles, // to be deprecated
     getAvailablePlayoffProfiles: getAvailablePlayoffProfiles,
     getAssignedParticipantIds: getAssignedParticipantIds,
     deleteDrawDefinitions: deleteDrawDefinitions,
@@ -66045,7 +66046,7 @@ function getEventProperties(_a) {
         hasRatedParticipants = !!(hasRatedParticipants || rating);
         return {
             participantId: participantId,
-            participantName: participantName || name,
+            participantName: participantName || name, // support legacy
             seed: seed,
             ranking: ranking,
             rating: rating,
@@ -67034,10 +67035,10 @@ function kSet(maxCountables, counted) {
     return isNaN(kset) ? eloConfig.kDefault() : kset;
 }
 var eloConfig = {
-    nSpread: 400,
+    nSpread: 400, // determines the 'spread' of the scale
     diffThreshold: 0.125,
-    kCalc: k538,
-    kMultiplier: kSet,
+    kCalc: k538, // use calculation defined by FiveThirtyEight.com
+    kMultiplier: kSet, // change to kDefault for value of 1
     kDefault: kDefault,
 };
 function calculateNewRatings(params) {
@@ -68665,7 +68666,7 @@ function anonymizeTournamentRecord(_a) {
         var _b;
         return (_a = {},
             _a[gender] = ((_b = generatePersons({
-                category: { ageCategoryCode: 'O18' },
+                category: { ageCategoryCode: 'O18' }, // ageCategoryCode is unimportant since birthYear will be replaced
                 count: gendersCount[gender],
                 addressProps: { citiesCount: 10 },
                 personExtensions: [],