@dicelette/core 1.28.2 → 1.28.3

package/dist/index.d.mts

@@ -312,9 +312,10 @@ declare function includeDiceType(dice: string, diceType?: string, userStats?: bo
  * @param {Engine|null} engine The random engine to use, default to nodeCrypto
  * @param {boolean} pity Whether to enable pity system (reroll on failure) or not
  * @param {boolean} sort Whether to sort the dice results or not
+ * @param {string} comment Optional comment to attach to the result. If provided, skips extracting the comment from the dice string (assumes dice is already clean).
  * @returns {Resultat|undefined} The result of the roll
  */
-declare function roll(dice: string, engine?: Engine | null, pity?: boolean, sort?: SortOrder): Resultat | undefined;
+declare function roll(dice: string, engine?: Engine | null, pity?: boolean, sort?: SortOrder, comment?: string): Resultat | undefined;
 declare function replaceInFormula(element: string, diceResult: Resultat, compareResult: {
     dice: string;
     compare: Compare | undefined;
@@ -367,6 +368,18 @@ declare function findBestRecord(record: Record<string, string>, searchTerm: stri
 declare function replaceUnknown(dice: string, replacer: string): string;
 declare function verifyStatMatcherPattern(dice: string, replaceUnknow?: string): string;
 
+/**
+ * Splits a dice string into the dice expression and its trailing comment.
+ * Comments are preceded by whitespace and start with #, //, [, or /*.
+ * The returned comment does NOT include the marker prefix.
+ * @example
+ * splitDiceComment("1d6 # attack") // => { dice: "1d6", comment: "attack" }
+ * splitDiceComment("2d8+3") // => { dice: "2d8+3", comment: undefined }
+ */
+declare function splitDiceComment(dice: string): {
+    dice: string;
+    comment: string | undefined;
+};
 /**
  * Escape regex string
  * @param string {string}
@@ -477,4 +490,4 @@ declare function testStatCombinaison(template: StatisticalTemplate, engine?: Eng
  */
 declare function generateRandomStat(total?: number | undefined, max?: number, min?: number, engine?: Engine | null): number;
 
-export { COMMENT_REGEX, type Compare, type ComparedValue, type Critical, type CustomCritical, type CustomCriticalMap, DETECT_CRITICAL, DiceTypeError, EmptyObjectError, FormulaError, type FormulaHintResult, MIN_THRESHOLD_MATCH, MaxGreater, type Modifier, NORMALIZE_SINGLE_DICE, NoStatisticsError, OPTIONAL_COMMENT, REMOVER_PATTERN, type Resultat, SIGN_REGEX, SIGN_REGEX_SPACE, SYMBOL_DICE, type Sign, SortOrder, type Statistic, type StatisticalSchema, type StatisticalTemplate, TooManyDice, TooManyStats, calculateSimilarity, createCriticalCustom, diceRandomParse, diceTypeRandomParse, escapeRegex, evalCombinaison, evalOneCombinaison, evalStatsDice, findBestRecord, findBestStatMatch, generateRandomStat, generateStatsDice, getCachedRegex, getEngine, getEngineId, includeDiceType, isNumber, levenshteinDistance, randomInt, replaceExpByRandom, replaceFormulaInDice, replaceInFormula, replaceUnknown, resolveFormulaHint, roll, standardizeDice, templateSchema, testDiceRegistered, testStatCombinaison, verifyStatMatcherPattern, verifyTemplateValue };
+export { COMMENT_REGEX, type Compare, type ComparedValue, type Critical, type CustomCritical, type CustomCriticalMap, DETECT_CRITICAL, DiceTypeError, EmptyObjectError, FormulaError, type FormulaHintResult, MIN_THRESHOLD_MATCH, MaxGreater, type Modifier, NORMALIZE_SINGLE_DICE, NoStatisticsError, OPTIONAL_COMMENT, REMOVER_PATTERN, type Resultat, SIGN_REGEX, SIGN_REGEX_SPACE, SYMBOL_DICE, type Sign, SortOrder, type Statistic, type StatisticalSchema, type StatisticalTemplate, TooManyDice, TooManyStats, calculateSimilarity, createCriticalCustom, diceRandomParse, diceTypeRandomParse, escapeRegex, evalCombinaison, evalOneCombinaison, evalStatsDice, findBestRecord, findBestStatMatch, generateRandomStat, generateStatsDice, getCachedRegex, getEngine, getEngineId, includeDiceType, isNumber, levenshteinDistance, randomInt, replaceExpByRandom, replaceFormulaInDice, replaceInFormula, replaceUnknown, resolveFormulaHint, roll, splitDiceComment, standardizeDice, templateSchema, testDiceRegistered, testStatCombinaison, verifyStatMatcherPattern, verifyTemplateValue };

package/dist/index.d.ts

@@ -312,9 +312,10 @@ declare function includeDiceType(dice: string, diceType?: string, userStats?: bo
  * @param {Engine|null} engine The random engine to use, default to nodeCrypto
  * @param {boolean} pity Whether to enable pity system (reroll on failure) or not
  * @param {boolean} sort Whether to sort the dice results or not
+ * @param {string} comment Optional comment to attach to the result. If provided, skips extracting the comment from the dice string (assumes dice is already clean).
  * @returns {Resultat|undefined} The result of the roll
  */
-declare function roll(dice: string, engine?: Engine | null, pity?: boolean, sort?: SortOrder): Resultat | undefined;
+declare function roll(dice: string, engine?: Engine | null, pity?: boolean, sort?: SortOrder, comment?: string): Resultat | undefined;
 declare function replaceInFormula(element: string, diceResult: Resultat, compareResult: {
     dice: string;
     compare: Compare | undefined;
@@ -367,6 +368,18 @@ declare function findBestRecord(record: Record<string, string>, searchTerm: stri
 declare function replaceUnknown(dice: string, replacer: string): string;
 declare function verifyStatMatcherPattern(dice: string, replaceUnknow?: string): string;
 
+/**
+ * Splits a dice string into the dice expression and its trailing comment.
+ * Comments are preceded by whitespace and start with #, //, [, or /*.
+ * The returned comment does NOT include the marker prefix.
+ * @example
+ * splitDiceComment("1d6 # attack") // => { dice: "1d6", comment: "attack" }
+ * splitDiceComment("2d8+3") // => { dice: "2d8+3", comment: undefined }
+ */
+declare function splitDiceComment(dice: string): {
+    dice: string;
+    comment: string | undefined;
+};
 /**
  * Escape regex string
  * @param string {string}
@@ -477,4 +490,4 @@ declare function testStatCombinaison(template: StatisticalTemplate, engine?: Eng
  */
 declare function generateRandomStat(total?: number | undefined, max?: number, min?: number, engine?: Engine | null): number;
 
-export { COMMENT_REGEX, type Compare, type ComparedValue, type Critical, type CustomCritical, type CustomCriticalMap, DETECT_CRITICAL, DiceTypeError, EmptyObjectError, FormulaError, type FormulaHintResult, MIN_THRESHOLD_MATCH, MaxGreater, type Modifier, NORMALIZE_SINGLE_DICE, NoStatisticsError, OPTIONAL_COMMENT, REMOVER_PATTERN, type Resultat, SIGN_REGEX, SIGN_REGEX_SPACE, SYMBOL_DICE, type Sign, SortOrder, type Statistic, type StatisticalSchema, type StatisticalTemplate, TooManyDice, TooManyStats, calculateSimilarity, createCriticalCustom, diceRandomParse, diceTypeRandomParse, escapeRegex, evalCombinaison, evalOneCombinaison, evalStatsDice, findBestRecord, findBestStatMatch, generateRandomStat, generateStatsDice, getCachedRegex, getEngine, getEngineId, includeDiceType, isNumber, levenshteinDistance, randomInt, replaceExpByRandom, replaceFormulaInDice, replaceInFormula, replaceUnknown, resolveFormulaHint, roll, standardizeDice, templateSchema, testDiceRegistered, testStatCombinaison, verifyStatMatcherPattern, verifyTemplateValue };
+export { COMMENT_REGEX, type Compare, type ComparedValue, type Critical, type CustomCritical, type CustomCriticalMap, DETECT_CRITICAL, DiceTypeError, EmptyObjectError, FormulaError, type FormulaHintResult, MIN_THRESHOLD_MATCH, MaxGreater, type Modifier, NORMALIZE_SINGLE_DICE, NoStatisticsError, OPTIONAL_COMMENT, REMOVER_PATTERN, type Resultat, SIGN_REGEX, SIGN_REGEX_SPACE, SYMBOL_DICE, type Sign, SortOrder, type Statistic, type StatisticalSchema, type StatisticalTemplate, TooManyDice, TooManyStats, calculateSimilarity, createCriticalCustom, diceRandomParse, diceTypeRandomParse, escapeRegex, evalCombinaison, evalOneCombinaison, evalStatsDice, findBestRecord, findBestStatMatch, generateRandomStat, generateStatsDice, getCachedRegex, getEngine, getEngineId, includeDiceType, isNumber, levenshteinDistance, randomInt, replaceExpByRandom, replaceFormulaInDice, replaceInFormula, replaceUnknown, resolveFormulaHint, roll, splitDiceComment, standardizeDice, templateSchema, testDiceRegistered, testStatCombinaison, verifyStatMatcherPattern, verifyTemplateValue };

package/dist/index.js

@@ -62,6 +62,7 @@ __export(index_exports, {
   replaceUnknown: () => replaceUnknown,
   resolveFormulaHint: () => resolveFormulaHint,
   roll: () => roll,
+  splitDiceComment: () => splitDiceComment,
   standardizeDice: () => standardizeDice,
   templateSchema: () => templateSchema,
   testDiceRegistered: () => testDiceRegistered,
@@ -285,10 +286,6 @@ var import_mathjs10 = require("mathjs");
 var import_rpg_dice_roller7 = require("@dice-roller/rpg-dice-roller");
 var import_mathjs8 = require("mathjs");
 
-// src/dice/compare.ts
-var import_rpg_dice_roller4 = require("@dice-roller/rpg-dice-roller");
-var import_mathjs2 = require("mathjs");
-
 // src/utils.ts
 var import_uniformize2 = require("uniformize");
 var import_rpg_dice_roller3 = require("@dice-roller/rpg-dice-roller");
@@ -507,6 +504,12 @@ function generateRandomStat(total = 100, max, min, engine = import_rpg_dice_roll
 }
 
 // src/utils.ts
+function splitDiceComment(dice) {
+  const match = /\s+(#|\/{2}|\[|\/\*)(?<comment>.*)/i.exec(dice);
+  if (!match?.groups) return { dice: dice.trimEnd(), comment: void 0 };
+  const comment = match.groups.comment.trim() || void 0;
+  return { dice: dice.slice(0, match.index).trimEnd(), comment };
+}
 function escapeRegex(string) {
   return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
@@ -543,6 +546,8 @@ function createCriticalCustom(dice, customCritical, template, engine = import_rp
 }
 
 // src/dice/compare.ts
+var import_rpg_dice_roller4 = require("@dice-roller/rpg-dice-roller");
+var import_mathjs2 = require("mathjs");
 function isTrivialComparison(maxValue, minValue, compare) {
   const canSucceed = canComparisonSucceed(maxValue, compare, minValue);
   const canFail = canComparisonFail(maxValue, compare, minValue);
@@ -1133,7 +1138,7 @@ function setSortOrder(toRoll, sort) {
 }
 function prepareDice(diceInput) {
   let dice = standardizeDice(replaceFormulaInDice(diceInput)).replace(/^\+/, "").replaceAll("=>", ">=").replaceAll("=<", "<=").trimStart();
-  dice = dice.replaceAll(DETECT_CRITICAL, "").trimEnd();
+  dice = dice.replaceAll(REMOVER_PATTERN.CRITICAL_BLOCK, "").trimEnd();
   const explodingSuccess = normalizeExplodingSuccess(dice);
   if (explodingSuccess) dice = explodingSuccess.dice;
   let diceDisplay;
@@ -1185,9 +1190,8 @@ function handleBulkRolls(dice, isCurlyBulk, bulkContent, compare, explodingSucce
   const bulkProcessContent = isCurlyBulk ? bulkContent : dice;
   const diceArray = bulkProcessContent.split("#");
   const numberOfDice = Number.parseInt(diceArray[0], 10);
-  let diceToRoll = diceArray[1].replace(COMMENT_REGEX, "");
-  const commentsMatch = diceArray[1].match(COMMENT_REGEX);
-  const comments = commentsMatch ? commentsMatch[2] : void 0;
+  const { dice: diceToRollBase, comment: comments } = splitDiceComment(diceArray[1]);
+  let diceToRoll = diceToRollBase;
   let curlyCompare;
   if (isCurlyBulk) {
     const curlyCompareRegex = diceToRoll.match(SIGN_REGEX_SPACE);
@@ -1372,7 +1376,7 @@ function handlePitySystem(dice, compare, diceRoll, roller, engine) {
 }
 
 // src/roll.ts
-function roll(dice, engine = import_rpg_dice_roller8.NumberGenerator.engines.nodeCrypto, pity, sort) {
+function roll(dice, engine = import_rpg_dice_roller8.NumberGenerator.engines.nodeCrypto, pity, sort, comment) {
   if (sort === "none" /* None */) sort = void 0;
   const prepared = prepareDice(dice);
   if (!prepared.dice.includes("d")) return void 0;
@@ -1415,8 +1419,10 @@ function roll(dice, engine = import_rpg_dice_roller8.NumberGenerator.engines.nod
   }
   const roller = new import_rpg_dice_roller8.DiceRoller();
   import_rpg_dice_roller8.NumberGenerator.generator.engine = engine;
-  let diceWithoutComment = processedDice.replace(COMMENT_REGEX, "").trimEnd();
-  diceWithoutComment = setSortOrder(diceWithoutComment, sort);
+  const splitResult = splitDiceComment(processedDice);
+  const diceBase = comment !== void 0 ? processedDice.trimEnd() : splitResult.dice;
+  const resolvedComment = comment ?? splitResult.comment;
+  const diceWithoutComment = setSortOrder(diceBase, sort);
   let diceRoll;
   try {
     diceRoll = roller.roll(diceWithoutComment);
@@ -1432,8 +1438,6 @@ function roll(dice, engine = import_rpg_dice_roller8.NumberGenerator.engines.nod
     );
     compare.trivial = trivial ? true : void 0;
   }
-  const commentMatch = processedDice.match(COMMENT_REGEX);
-  const comment = commentMatch ? commentMatch[2] : void 0;
   let rerollCount = 0;
   let pityResult;
   if (pity && compare) {
@@ -1450,7 +1454,7 @@ function roll(dice, engine = import_rpg_dice_roller8.NumberGenerator.engines.nod
       return {
         ...pityResult,
         dice: prepared.isSimpleCurly ? finalDiceDisplay : processedDice,
-        comment,
+        comment: resolvedComment,
         compare,
         modifier: modificator,
         pityLogs: rerollCount,
@@ -1472,7 +1476,7 @@ function roll(dice, engine = import_rpg_dice_roller8.NumberGenerator.engines.nod
     return {
       dice: prepared.isSimpleCurly ? finalDiceDisplay : prepared.diceDisplay,
       result: resultOutput,
-      comment,
+      comment: resolvedComment,
       compare: compare ? compare : void 0,
       modifier: modificator,
       total: successes,
@@ -1483,7 +1487,7 @@ function roll(dice, engine = import_rpg_dice_roller8.NumberGenerator.engines.nod
   return {
     dice: prepared.isSimpleCurly ? finalDiceDisplay : processedDice,
     result: resultOutput,
-    comment,
+    comment: resolvedComment,
     compare: compare ? compare : void 0,
     modifier: modificator,
     total: roller.total,
@@ -1700,6 +1704,7 @@ function replaceInFormula(element, diceResult, compareResult, res, engine = impo
   replaceUnknown,
   resolveFormulaHint,
   roll,
+  splitDiceComment,
   standardizeDice,
   templateSchema,
   testDiceRegistered,