tods-competition-factory 1.8.1 → 1.8.3

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[];

package/dist/forge/generate.mjs

@@ -3170,20 +3170,20 @@ const ROUND_ROBIN_WITH_PLAYOFF = "ROUND_ROBIN_WITH_PLAYOFF";
 const DECIDER = "DECIDER";
 const BACKDRAW = "BACKDRAW";
 const COMPASS_ATTRIBUTES = {
-  0: { name: "EAST", abbreviation: "E" },
-  "0-1": { name: "WEST", abbreviation: "W" },
-  "0-2": { name: "NORTH", abbreviation: "N" },
-  "0-3": { name: "NORTHEAST", abbreviation: "NE" },
-  "0-1-1": { name: "SOUTH", abbreviation: "S" },
-  "0-1-2": { name: "SOUTHWEST", abbreviation: "SW" },
-  "0-2-1": { name: "NORTHWEST", abbreviation: "NW" },
-  "0-1-1-1": { name: "SOUTHEAST", abbreviation: "SE" }
+  0: { name: "East", abbreviation: "E" },
+  "0-1": { name: "West", abbreviation: "W" },
+  "0-2": { name: "North", abbreviation: "N" },
+  "0-3": { name: "Northeast", abbreviation: "NE" },
+  "0-1-1": { name: "South", abbreviation: "S" },
+  "0-1-2": { name: "Southwest", abbreviation: "SW" },
+  "0-2-1": { name: "Northwest", abbreviation: "NW" },
+  "0-1-1-1": { name: "Southeast", abbreviation: "SE" }
 };
 const OLYMPIC_ATTRIBUTES = {
-  0: { name: "EAST", abbreviation: "E" },
-  "0-1": { name: "WEST", abbreviation: "W" },
-  "0-2": { name: "NORTH", abbreviation: "N" },
-  "0-1-1": { name: "SOUTH", abbreviation: "S" }
+  0: { name: "East", abbreviation: "E" },
+  "0-1": { name: "West", abbreviation: "W" },
+  "0-2": { name: "North", abbreviation: "N" },
+  "0-1-1": { name: "South", abbreviation: "S" }
 };
 const WIN_RATIO = "WIN_RATIO";
 const ROUND_OUTCOME = "ROUND_OUTCOME";
@@ -5037,6 +5037,7 @@ function groupRounds({ groupSize, drawPositionOffset }) {
 
 function generateRoundRobin({
   structureName = constantToString(MAIN),
+  groupNameBase = "Group",
   stageSequence = 1,
   structureOptions,
   appliedPolicies,
@@ -5070,7 +5071,7 @@ function generateRoundRobin({
       ...matchUps.map(({ roundNumber }) => roundNumber)
     );
     return structureTemplate({
-      structureName: `Group ${structureOrder}`,
+      structureName: `${groupNameBase} ${structureOrder}`,
       structureId: uuids?.pop(),
       structureType: ITEM,
       finishingPosition,
@@ -13964,6 +13965,7 @@ function treeMatchUps({
 function firstRoundLoserConsolation(params) {
   const {
     finishingPositionOffset = 0,
+    playoffAttributes,
     stageSequence = 1,
     staggeredEntry,
     structureName,
@@ -13985,7 +13987,7 @@ function firstRoundLoserConsolation(params) {
   };
   const { matchUps } = staggeredEntry ? feedInMatchUps(mainParams) : treeMatchUps(mainParams);
   const mainStructure = structureTemplate({
-    structureName: structureName || constantToString(MAIN),
+    structureName: structureName || playoffAttributes?.["0"]?.name || constantToString(MAIN),
     structureId: structureId || uuids?.pop(),
     stageSequence,
     matchUpType,
@@ -14004,7 +14006,7 @@ function firstRoundLoserConsolation(params) {
       isMock
     });
     const consolation = constantToString(CONSOLATION);
-    const consolationStructureName = params.consolationStructureName || (structureName ? `${structureName} ${consolation}` : consolation);
+    const consolationStructureName = playoffAttributes?.["0-1"]?.name ?? params.consolationStructureName ?? (structureName ? `${structureName} ${consolation}` : consolation);
     const consolationStructure = structureTemplate({
       structureName: consolationStructureName,
       matchUps: consolationMatchUps,
@@ -14082,10 +14084,10 @@ function feedInLinks({
 
 function generateCurtisConsolation(params) {
   const {
-    structureName = constantToString(MAIN),
     playoffStructureNameBase,
     finishingPositionOffset,
     stageSequence = 1,
+    playoffAttributes,
     structureNameMap,
     staggeredEntry,
     stage = MAIN,
@@ -14105,6 +14107,7 @@ function generateCurtisConsolation(params) {
     uuids
   };
   const { matchUps, roundsCount: mainDrawRoundsCount } = staggeredEntry ? feedInMatchUps(mainParams) : treeMatchUps(mainParams);
+  const structureName = params.structureName ?? playoffAttributes?.["0"]?.name ?? constantToString(MAIN);
   const mainStructure = structureTemplate({
     structureId: structureId || uuids?.pop(),
     structureName,
@@ -14123,6 +14126,7 @@ function generateCurtisConsolation(params) {
         idPrefix: idPrefix && `${idPrefix}-c${index}`,
         structureId: uuids?.pop(),
         playoffStructureNameBase,
+        playoffAttributes,
         structureNameMap,
         stageSequence: stageSequence2,
         roundOffset,
@@ -14151,7 +14155,7 @@ function generateCurtisConsolation(params) {
         matchUpType,
         isMock
       });
-      const defaultName = constantToString(PLAY_OFF);
+      const defaultName = playoffAttributes?.["3-4"]?.name ?? constantToString(PLAY_OFF);
       const mappedStructureName = structureNameMap?.[defaultName] || defaultName;
       const structureName2 = playoffStructureNameBase ? `${playoffStructureNameBase} ${mappedStructureName}` : mappedStructureName;
       const playoffStructure = structureTemplate({
@@ -14183,6 +14187,7 @@ function generateCurtisConsolation(params) {
 function consolationFeedStructure({
   playoffStructureNameBase,
   stageSequence = 1,
+  playoffAttributes,
   structureNameMap,
   roundOffset = 0,
   matchUpType,
@@ -14204,7 +14209,8 @@ function consolationFeedStructure({
     isMock,
     uuids
   });
-  const defaultName = `${constantToString(CONSOLATION)} ${index + 1}`;
+  const indexedStructureName = index === 0 && playoffAttributes?.["0-1"]?.name || index === 1 && playoffAttributes?.["0-3"]?.name;
+  const defaultName = indexedStructureName || `${constantToString(CONSOLATION)} ${index + 1}`;
   const mappedStructureName = structureNameMap?.[defaultName] || defaultName;
   const structureName = playoffStructureNameBase ? `${playoffStructureNameBase} ${mappedStructureName}` : mappedStructureName;
   const consolationStructure = structureTemplate({
@@ -14254,7 +14260,7 @@ function generatePlayoffStructures(params) {
   const finishingPositionRange = `${finishingPositionsFrom}-${finishingPositionsTo}`;
   const attributeProfile = playoffAttributes?.[exitProfile];
   const base = playoffStructureNameBase && `${playoffStructureNameBase} ` || "";
-  const customNaming = finishingPositionNaming?.[finishingPositionRange];
+  const customNaming = playoffAttributes?.[finishingPositionRange] ?? finishingPositionNaming?.[finishingPositionRange];
   const structureName = customNaming?.name || attributeProfile?.name && (addNameBaseToAttributeName ? `${base}${attributeProfile?.name}` : attributeProfile.name) || `${base}${finishingPositionRange}`;
   const structureAbbreviation = customNaming?.abbreviation || attributeProfile?.abbreviation;
   const mainParams = {
@@ -14359,6 +14365,7 @@ function feedInChampionship(params) {
   const {
     finishingPositionOffset,
     stageSequence = 1,
+    playoffAttributes,
     policyDefinitions,
     feedsFromFinal,
     staggeredEntry,
@@ -14386,7 +14393,7 @@ function feedInChampionship(params) {
   };
   const { matchUps } = staggeredEntry ? feedInMatchUps(mainParams) : treeMatchUps(mainParams);
   const mainStructure = structureTemplate({
-    structureName: structureName || constantToString(MAIN),
+    structureName: structureName || playoffAttributes?.["0"]?.name || constantToString(MAIN),
     structureId: structureId || uuids?.pop(),
     stageSequence,
     matchUpType,
@@ -14411,7 +14418,7 @@ function feedInChampionship(params) {
   });
   if (drawSize > 2) {
     const consolationStructure = structureTemplate({
-      structureName: constantToString(CONSOLATION),
+      structureName: playoffAttributes?.["0-1"]?.name ?? constantToString(CONSOLATION),
       matchUps: consolationMatchUps,
       structureId: uuids?.pop(),
       stage: CONSOLATION,
@@ -14436,10 +14443,9 @@ function feedInChampionship(params) {
 }
 
 function processPlayoffGroups({
-  compassAttributes = COMPASS_ATTRIBUTES,
-  olympicAttributes = OLYMPIC_ATTRIBUTES,
   requireSequential = true,
   playoffMatchUpFormat,
+  playoffAttributes,
   sourceStructureId,
   policyDefinitions,
   stageSequence,
@@ -14488,6 +14494,8 @@ function processPlayoffGroups({
     if (positionsPlayedOff) {
       finishingPositionOffset = Math.min(...positionsPlayedOff) - 1;
     }
+    const finishingPositionRange = positionsPlayedOff && `${Math.min(...positionsPlayedOff)}-${Math.max(...positionsPlayedOff)}`;
+    const structureName = playoffGroup.structureName || finishingPositionRange && playoffGroup.playoffAttributes?.[finishingPositionRange]?.name || playoffGroup.playoffAttributes?.["0"]?.name;
     const playoffGroupParams = {
       addNameBaseToAttributeName: playoffGroup.addNameBaseToAttributeName,
       playoffStructureNameBase: playoffGroup.playoffStructureNameBase,
@@ -14496,8 +14504,8 @@ function processPlayoffGroups({
       structureId: playoffGroup.structureId ?? uuids?.pop(),
       playoffAttributes: playoffGroup.playoffAttributes,
       structureNameMap: playoffGroup.structureNameMap,
-      structureName: playoffGroup.structureName,
-      sequenceLimit: playoffGroup.sequenceLimit
+      sequenceLimit: playoffGroup.sequenceLimit,
+      structureName
     };
     const params = {
       ...playoffGroupParams,
@@ -14539,9 +14547,9 @@ function processPlayoffGroups({
       });
       const playoffStructure = structureTemplate({
         structureId: playoffGroup.structureId ?? uuids?.pop(),
-        structureName: playoffGroup.structureName,
         matchUpFormat: playoffMatchUpFormat,
         stage: PLAY_OFF,
+        structureName,
         stageSequence,
         matchUps
       });
@@ -14558,8 +14566,8 @@ function processPlayoffGroups({
         finishingPositions
       });
     } else if ([COMPASS, OLYMPIC, PLAY_OFF].includes(playoffDrawType)) {
-      const { structureName } = playoffGroup;
       const params2 = {
+        playoffAttributes: playoffGroup.playoffAttributes ?? playoffAttributes,
         structureId: playoffGroup.structureId ?? uuids?.pop(),
         playoffStructureNameBase: structureName,
         idPrefix: idPrefix && `${idPrefix}-po`,
@@ -14574,12 +14582,12 @@ function processPlayoffGroups({
       };
       if (playoffDrawType === COMPASS) {
         Object.assign(params2, {
-          playoffAttributes: compassAttributes,
+          playoffAttributes: playoffGroup?.playoffAttributes ?? playoffAttributes ?? COMPASS_ATTRIBUTES,
           roundOffsetLimit: 3
         });
       } else if (playoffDrawType === OLYMPIC) {
         Object.assign(params2, {
-          playoffAttributes: olympicAttributes,
+          playoffAttributes: playoffGroup?.playoffAttributes ?? playoffAttributes ?? OLYMPIC_ATTRIBUTES,
           roundOffsetLimit: 2
         });
       }
@@ -14615,11 +14623,11 @@ function processPlayoffGroups({
       const uuidsFMLC = [uuids?.pop(), uuids?.pop()];
       const params2 = {
         structureId: playoffGroup.structureId ?? uuids?.pop(),
-        structureName: playoffGroup.structureName,
         idPrefix: idPrefix && `${idPrefix}-po`,
         finishingPositionOffset,
         uuids: uuidsFMLC,
         stage: PLAY_OFF,
+        structureName,
         matchUpType,
         feedPolicy,
         drawSize,
@@ -19369,10 +19377,8 @@ function luckyRoundProfiles(drawSize) {
 
 function getGenerators(params) {
   const {
-    compassAttributes = COMPASS_ATTRIBUTES,
-    olympicAttributes = OLYMPIC_ATTRIBUTES,
+    playoffAttributes,
     stageSequence = 1,
-    structureName,
     structureId,
     stage = MAIN,
     matchUpType,
@@ -19382,13 +19388,13 @@ function getGenerators(params) {
   const { appliedPolicies } = getAppliedPolicies(params);
   const feedPolicy = params.policyDefinitions?.[POLICY_TYPE_FEED_IN] || appliedPolicies?.[POLICY_TYPE_FEED_IN];
   params.skipRounds = params.skipRounds || drawSize <= 4 && (feedPolicy?.feedMainFinal ? 0 : 1) || 0;
-  const main = constantToString(MAIN);
+  const structureName = params.structureName ?? playoffAttributes?.["0"]?.name ?? constantToString(MAIN);
   const singleElimination = () => {
     const { matchUps } = treeMatchUps(params);
     const structure = structureTemplate({
       structureId: structureId || uuids?.pop(),
-      structureName: structureName || main,
       stageSequence,
+      structureName,
       matchUpType,
       matchUps,
       stage
@@ -19399,9 +19405,9 @@ function getGenerators(params) {
     [AD_HOC]: () => {
       const structure = structureTemplate({
         structureId: structureId || uuids?.pop(),
-        structureName: structureName || main,
         finishingPosition: WIN_RATIO,
         stageSequence,
+        structureName,
         matchUps: [],
         matchUpType,
         stage
@@ -19412,8 +19418,8 @@ function getGenerators(params) {
       const { matchUps } = luckyDraw(params);
       const structure = structureTemplate({
         structureId: structureId || uuids?.pop(),
-        structureName: structureName || main,
         stageSequence,
+        structureName,
         matchUpType,
         matchUps,
         stage
@@ -19425,12 +19431,12 @@ function getGenerators(params) {
     [COMPASS]: () => generatePlayoffStructures({
       ...params,
       roundOffsetLimit: 3,
-      playoffAttributes: compassAttributes
+      playoffAttributes: playoffAttributes ?? COMPASS_ATTRIBUTES
     }),
     [OLYMPIC]: () => generatePlayoffStructures({
       ...params,
       roundOffsetLimit: 2,
-      playoffAttributes: olympicAttributes
+      playoffAttributes: playoffAttributes ?? OLYMPIC_ATTRIBUTES
     }),
     [PLAY_OFF]: () => {
       return generatePlayoffStructures(params);
@@ -19439,8 +19445,8 @@ function getGenerators(params) {
       const { matchUps } = feedInMatchUps({ drawSize, uuids, matchUpType });
       const structure = structureTemplate({
         structureId: structureId || uuids?.pop(),
-        structureName: structureName || main,
         stageSequence,
+        structureName,
         matchUpType,
         stage: MAIN,
         matchUps
@@ -20217,7 +20223,9 @@ function generateQualifyingStructures({
       }
       const roundTargetName = qualifyingProfiles.length > 1 ? `${roundTarget}-` : "";
       const stageSequenceName = structureProfiles.length > 1 || roundTargetName ? stageSequence : "";
-      const qualifyingStructureName = structureName || (roundTargetName || stageSequenceName ? `${QUALIFYING} ${roundTargetName}${stageSequenceName}` : QUALIFYING);
+      const qualifyingStructureName = structureName || (roundTargetName || stageSequenceName ? `${constantToString(
+        QUALIFYING
+      )} ${roundTargetName}${stageSequenceName}` : constantToString(QUALIFYING));
       if (drawType === ROUND_ROBIN) {
         const {
           structures: structures2,
@@ -20686,7 +20694,7 @@ function generateDrawTypeAndModifyDrawDefinition(params) {
 }
 
 function addVoluntaryConsolationStructure$1({
-  structureName = VOLUNTARY_CONSOLATION,
+  structureName = constantToString(VOLUNTARY_CONSOLATION),
   structureAbbreviation,
   drawDefinition,
   matchUpType,