tods-competition-factory 2.0.2 → 2.0.5

package/dist/tods-competition-factory.d.ts

@@ -2113,6 +2113,73 @@ type MatchUpsMap = {
     drawMatchUps: MatchUp[];
 };
 
+type GenerateDrawMaticRoundArgs = {
+    tournamentParticipants?: HydratedParticipant[];
+    adHocRatings?: {
+        [key: string]: number;
+    };
+    ignoreLastRoundNumber?: boolean;
+    restrictEntryStatus?: boolean;
+    drawDefinition: DrawDefinition;
+    generateMatchUps?: boolean;
+    eventType?: EventTypeUnion;
+    salted?: number | boolean;
+    participantIds?: string[];
+    encounterValue?: number;
+    sameTeamValue?: number;
+    maxIterations?: number;
+    matchUpIds?: string[];
+    structure?: Structure;
+    roundNumber?: number;
+    structureId?: string;
+    scaleName?: string;
+    idPrefix?: string;
+    isMock?: boolean;
+    drawId?: string;
+    event: Event$1;
+};
+type DrawMaticRoundResult = {
+    participantIdPairings?: string[][];
+    candidatesCount?: number;
+    roundNumber?: number;
+    matchUps?: MatchUp[];
+    iterations?: number;
+    success?: boolean;
+    maxDelta?: number;
+    maxDiff?: number;
+};
+declare function generateDrawMaticRound({ encounterValue, sameTeamValue, maxIterations, generateMatchUps, tournamentParticipants, ignoreLastRoundNumber, participantIds, drawDefinition, adHocRatings, salted, roundNumber, structureId, matchUpIds, eventType, structure, scaleName, idPrefix, isMock, event, }: GenerateDrawMaticRoundArgs): ResultType & DrawMaticRoundResult;
+
+type DrawMaticArgs = {
+    adHocRatings?: {
+        [key: string]: number;
+    };
+    restrictEntryStatus?: boolean;
+    tournamentRecord: Tournament;
+    drawDefinition: DrawDefinition;
+    enableDoubleRobin?: boolean;
+    generateMatchUps?: boolean;
+    eventType?: EventTypeUnion;
+    salted?: number | boolean;
+    participantIds?: string[];
+    encounterValue?: number;
+    sameTeamValue?: number;
+    maxIterations?: number;
+    matchUpIds?: string[];
+    structure?: Structure;
+    roundsCount?: number;
+    structureId?: string;
+    idPrefix?: string;
+    isMock?: boolean;
+    event: Event$1;
+    scaleAccessor?: string;
+    scaleName?: string;
+};
+declare function drawMatic(params: DrawMaticArgs): ResultType & {
+    matchUps?: MatchUp[];
+    roundResults?: DrawMaticRoundResult[];
+};
+
 type FactoryEngine = {
     [key: string]: any;
 };
@@ -2485,6 +2552,49 @@ type MatchUpFilters = {
     filterMatchUpTypes?: boolean;
     filterMatchUpIds?: boolean;
 };
+type GenerateDrawDefinitionArgs = {
+    automated?: boolean | {
+        seedsOnly: boolean;
+    };
+    playoffAttributes?: PlayoffAttributes;
+    policyDefinitions?: PolicyDefinitions;
+    voluntaryConsolation?: {
+        structureAbbreviation?: string;
+        structureName?: string;
+        structureId?: string;
+    };
+    enforceMinimumDrawSize?: boolean;
+    ignoreAllowedDrawTypes?: boolean;
+    qualifyingPlaceholder?: boolean;
+    considerEventEntries?: boolean;
+    seedingProfile?: SeedingProfile;
+    hydrateCollections?: boolean;
+    tournamentRecord: Tournament;
+    drawTypeCoercion?: boolean;
+    ignoreStageSpace?: boolean;
+    qualifyingProfiles?: any[];
+    drawMatic?: DrawMaticArgs;
+    qualifyingOnly?: boolean;
+    drawType?: DrawTypeUnion;
+    enforceGender?: boolean;
+    processCodes?: string[];
+    matchUpFormat?: string;
+    matchUpType?: EventTypeUnion;
+    structureName?: string;
+    tieFormatName?: string;
+    tieFormat?: TieFormat;
+    drawEntries?: Entry[];
+    roundsCount?: number;
+    seedsCount?: number;
+    placeByes?: boolean;
+    drawName?: string;
+    drawSize?: number;
+    idPrefix?: string;
+    isMock?: boolean;
+    uuids?: string[];
+    drawId?: string;
+    event: Event$1;
+};
 
 /**
  * Links all tournaments which are currently loaded into competitionEngine state
@@ -2939,13 +3049,15 @@ declare function updateTeamLineUp({ drawDefinition, participantId, tieFormat, li
     error?: ErrorType;
 };
 
-declare function addAdHocMatchUps({ tournamentRecord, drawDefinition, structureId, matchUps, event }: {
+type AddAdHocMatchUpsParams = {
+    suppressNotifications?: boolean;
     tournamentRecord: any;
+    structureId?: string;
     drawDefinition: any;
-    structureId: any;
-    matchUps: any;
+    matchUps: any[];
     event: any;
-}): ResultType;
+};
+declare function addAdHocMatchUps(params: AddAdHocMatchUpsParams): ResultType;
 
 type ModifyDrawNameArgs = {
     tournamentRecord: Tournament;
@@ -2974,36 +3086,20 @@ type SetSubOrderArgs = {
 };
 declare function setSubOrder({ tournamentRecord, drawDefinition, drawPosition, structureId, subOrder, event, }: SetSubOrderArgs): ResultType;
 
-/**
- *
- * @param {object} tournamentRecord - passed automatically if tournamentEngine.setState() has been called
- * @param {string} eventId - resolved by tournamentEngine to the event object
- *
- * @param {object} policyDefinitions - seeding policyDefinitions determines the # of seeds for given participantsCount/drawSize
- * @param {object} scaleAttributes -
- * @param {string} scaleName - OPTIONAL - defaults to scaleAttributes.scaleName
- * @param {number} drawSize - OPTIONAL - defaults to calculation based on # of entries
- * @param {string} drawId - OPTIONAL - will use flight.drawEntries or drawDefinition.entries rather than event.entries
- * @param {string} stage - OPTIONAL - filters entries by specified stage
- *
- * @param {boolean} sortDescending - OPTIONAL - defaults to false
- * @param {function} scaleSortMethod - OPTIONAL - user defined sorting method
- *
- * @returns {object} - { success: true } or { error }
- */
-declare function autoSeeding({ tournamentRecord, drawDefinition, policyDefinitions, scaleAttributes, scaleName, drawSize, drawId, event, stage, sortDescending, scaleSortMethod, }: {
+type AutoSeedingParams = {
+    sortDescending: boolean;
+    stage: StageTypeUnion;
     tournamentRecord: any;
-    drawDefinition: any;
     policyDefinitions: any;
     scaleAttributes: any;
-    scaleName: any;
-    drawSize: any;
-    drawId: any;
-    event: any;
-    stage: any;
-    sortDescending: any;
     scaleSortMethod: any;
-}): {
+    drawDefinition: any;
+    scaleName: string;
+    drawSize: number;
+    drawId: string;
+    event: any;
+};
+declare function autoSeeding({ tournamentRecord, drawDefinition, policyDefinitions, scaleAttributes, scaleName, drawSize, drawId, event, stage, sortDescending, scaleSortMethod, }: AutoSeedingParams): {
     stageEntries?: Entry[] | undefined;
     seedsCount?: number | undefined;
     entries?: Entry[] | undefined;
@@ -3643,116 +3739,6 @@ type GenerateDrawStructuresAndLinksArgs = {
 };
 declare function generateDrawStructuresAndLinks(params: GenerateDrawStructuresAndLinksArgs): any;
 
-type GenerateDrawMaticRoundArgs = {
-    tournamentParticipants?: HydratedParticipant[];
-    adHocRatings?: {
-        [key: string]: number;
-    };
-    ignoreLastRoundNumber?: boolean;
-    restrictEntryStatus?: boolean;
-    drawDefinition: DrawDefinition;
-    generateMatchUps?: boolean;
-    eventType?: EventTypeUnion;
-    salted?: number | boolean;
-    participantIds?: string[];
-    encounterValue?: number;
-    sameTeamValue?: number;
-    maxIterations?: number;
-    matchUpIds?: string[];
-    structure?: Structure;
-    roundNumber?: number;
-    structureId?: string;
-    scaleName?: string;
-    idPrefix?: string;
-    isMock?: boolean;
-    drawId?: string;
-    event: Event$1;
-};
-type DrawMaticRoundResult = {
-    participantIdPairings?: string[][];
-    candidatesCount?: number;
-    roundNumber?: number;
-    matchUps?: MatchUp[];
-    iterations?: number;
-    success?: boolean;
-    maxDelta?: number;
-    maxDiff?: number;
-};
-declare function generateDrawMaticRound({ encounterValue, sameTeamValue, maxIterations, generateMatchUps, tournamentParticipants, ignoreLastRoundNumber, participantIds, drawDefinition, adHocRatings, salted, roundNumber, structureId, matchUpIds, eventType, structure, scaleName, idPrefix, isMock, event, }: GenerateDrawMaticRoundArgs): ResultType & DrawMaticRoundResult;
-
-type DrawMaticArgs = {
-    adHocRatings?: {
-        [key: string]: number;
-    };
-    restrictEntryStatus?: boolean;
-    tournamentRecord: Tournament;
-    drawDefinition: DrawDefinition;
-    enableDoubleRobin?: boolean;
-    generateMatchUps?: boolean;
-    eventType?: EventTypeUnion;
-    salted?: number | boolean;
-    participantIds?: string[];
-    encounterValue?: number;
-    sameTeamValue?: number;
-    maxIterations?: number;
-    matchUpIds?: string[];
-    structure?: Structure;
-    roundsCount?: number;
-    structureId?: string;
-    idPrefix?: string;
-    isMock?: boolean;
-    event: Event$1;
-    scaleAccessor?: string;
-    scaleName?: string;
-};
-declare function drawMatic(params: DrawMaticArgs): ResultType & {
-    matchUps?: MatchUp[];
-    roundResults?: DrawMaticRoundResult[];
-};
-
-type GenerateDrawDefinitionArgs = {
-    automated?: boolean | {
-        seedsOnly: boolean;
-    };
-    playoffAttributes?: PlayoffAttributes;
-    policyDefinitions?: PolicyDefinitions;
-    voluntaryConsolation?: {
-        structureAbbreviation?: string;
-        structureName?: string;
-        structureId?: string;
-    };
-    enforceMinimumDrawSize?: boolean;
-    ignoreAllowedDrawTypes?: boolean;
-    qualifyingPlaceholder?: boolean;
-    considerEventEntries?: boolean;
-    seedingProfile?: SeedingProfile;
-    hydrateCollections?: boolean;
-    tournamentRecord: Tournament;
-    drawTypeCoercion?: boolean;
-    ignoreStageSpace?: boolean;
-    qualifyingProfiles?: any[];
-    drawMatic?: DrawMaticArgs;
-    qualifyingOnly?: boolean;
-    drawType?: DrawTypeUnion;
-    enforceGender?: boolean;
-    processCodes?: string[];
-    matchUpFormat?: string;
-    matchUpType?: EventTypeUnion;
-    structureName?: string;
-    tieFormatName?: string;
-    tieFormat?: TieFormat;
-    drawEntries?: Entry[];
-    roundsCount?: number;
-    seedsCount?: number;
-    placeByes?: boolean;
-    drawName?: string;
-    drawSize?: number;
-    idPrefix?: string;
-    isMock?: boolean;
-    uuids?: string[];
-    drawId?: string;
-    event: Event$1;
-};
 declare function generateDrawDefinition(params: GenerateDrawDefinitionArgs): ResultType & {
     existingDrawDefinition?: boolean;
     qualifyingConflicts?: any[];