tods-competition-factory 1.8.2 → 1.8.4

package/dist/forge/generate.d.ts

@@ -1278,16 +1278,16 @@ interface UnifiedVenueID {
 
 /**
  *
- * @param {object} playoffAttributes - mapping of exitProfile to structure names, e.g. 0-1-1 for SOUTH
+ * @param {object} playoffAttributes - mapping of exitProfile to structure names, e.g. 0-1-1 for South
  * @param {string} playoffStructureNameBase - Root word for default playoff naming, e.g. 'Playoff' for 'Playoff 3-4'
- * @param {string} exitProfile - rounds at which a participant exited each structure, e.g. 0-1-1-1 for losing EAST, WEST, SOUTH
+ * @param {string} exitProfile - rounds at which a participant exited each structure, e.g. 0-1-1-1 for losing East, West, South
  * @param {boolean} exitProfileLimit - limit playoff rounds generated by the attributes present in playoffAttributes
  * @param {number} finishingPositionOffset - amount by which to offset finishingPositions, e.g. 2 for playing off 3-4
  * @param {number} finishingPositionLimit - highest value of possible finishing Positions to play off
  * @param {object} finishingPositionNaming - map of { [finishingPositionRange]: customName }
  * @param {number} roundOffsetLimit - how many rounds to play off (# of additional matchUps per participant)
  * @param {number} roundOffset - used internally to track generated structures; saved in structure attributes;
- * @param {number} stageSequence - what sequence within stage structures, e.g. WEST is stageSequence 2 in COMPASS
+ * @param {number} stageSequence - what sequence within stage structures, e.g. West is stageSequence 2 in COMPASS
  * @param {string} stage - [QUALIFYING, MAIN, CONSOLATION, PLAY-OFF]
  *
  */
@@ -1368,6 +1368,12 @@ type RoundProfile = {
         roundName?: string;
     };
 };
+type PlayoffAttributes = {
+    [key: string | number]: {
+        name: string;
+        abbreviation: string;
+    };
+};
 
 type GenerateAndPopulateArgs = {
     addNameBaseToAttributeName?: boolean;
@@ -1484,6 +1490,7 @@ type GenerateDrawDefinitionArgs = {
     automated?: boolean | {
         seedsOnly: boolean;
     };
+    playoffAttributes?: PlayoffAttributes;
     policyDefinitions?: PolicyDefinitions;
     voluntaryConsolation?: {
         structureAbbreviation?: string;
@@ -1505,6 +1512,7 @@ type GenerateDrawDefinitionArgs = {
     processCodes?: string[];
     matchUpFormat?: string;
     matchUpType?: TypeEnum;
+    structureName?: string;
     tieFormatName?: string;
     tieFormat?: TieFormat;
     drawEntries?: Entry[];