@dicelette/core 1.23.1 → 1.24.1

package/dist/index.d.mts

@@ -2,29 +2,19 @@ import { Engine, Random } from 'random-js';
 import { z } from 'zod';
 
 /**
- * Allow to replace the compare part of a dice and use the critical customized one
- * @example
- * dice = "1d20=20";
- * custom critical {sign: ">", value: "$/2"}
- * Random stats = 6
- * result = "1d20>3"
- */
-declare function createCriticalCustom(dice: string, customCritical: CustomCritical, template: StatisticalTemplate, engine?: Engine | null): string;
-/**
- * Parse the string provided and turn it as a readable dice for dice parser
- * @param dice {string}
- * @param engine
- * @param pity
+ * Utility function that allow to get the id of an engine
+ * @param engine {unknown} Engine to identify
+ * @returns {string} Id of the engine or "unknown"
+ * @private
  */
-declare function roll(dice: string, engine?: Engine | null, pity?: boolean): Resultat | undefined;
+declare function getEngineId(engine: unknown): string;
 /**
- * Evaluate a formula and replace "^" by "**" if any
- * @param {Sign} sign
- * @param {number} value
- * @param {number} total
- * @returns
+ * Utility function to get the engine from its name
+ * @param engine {"nativeMath" | "browserCrypto" | "nodeCrypto"} The engine name
+ * @returns {Engine} The engine
+ * @public
  */
-declare function calculator(sign: Sign, value: number, total: number): number;
+declare function getEngine(engine: "nativeMath" | "browserCrypto" | "nodeCrypto"): Engine;
 
 declare class DiceTypeError extends Error {
     readonly dice: string;
@@ -87,6 +77,7 @@ interface Resultat {
      */
     total?: number;
     pityLogs?: number;
+    trivial?: boolean;
 }
 interface Compare {
     /**
@@ -240,6 +231,11 @@ interface CustomCritical {
      */
     affectSkill?: boolean;
 }
+declare enum SortOrder {
+    Ascending = "sa",
+    Descending = "sd",
+    None = "none"
+}
 
 declare const COMMENT_REGEX: RegExp;
 declare const SIGN_REGEX: RegExp;
@@ -297,6 +293,20 @@ declare const templateSchema: z.ZodObject<{
     damage: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
 }, z.core.$strip>;
 
+/**
+ * Parse the string provided and turn it as a readable dice for dice parser
+ * @param {string} dice The dice string to parse and roll
+ * @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
+ * @returns {Resultat|undefined} The result of the roll
+ */
+declare function roll(dice: string, engine?: Engine | null, pity?: boolean, sort?: SortOrder): Resultat | undefined;
+declare function replaceInFormula(element: string, diceResult: Resultat, compareResult: {
+    dice: string;
+    compare: Compare | undefined;
+}, res: boolean, engine?: Engine | null, pity?: boolean): string;
+
 /**
  * Escape regex string
  * @param string {string}
@@ -345,19 +355,14 @@ declare function replaceExpByRandom(dice: string, engine?: Engine | null): strin
  */
 declare function randomInt(min: number, max: number, engine?: Engine | null, rng?: Random): number;
 /**
- * Utility function that allow to get the id of an engine
- * @param engine {unknown} Engine to identify
- * @returns {string} Id of the engine or "unknown"
- * @private
- */
-declare function getEngineId(engine: unknown): string;
-/**
- * Utility function to get the engine from its name
- * @param engine {"nativeMath" | "browserCrypto" | "nodeCrypto"} The engine name
- * @returns {Engine} The engine
- * @public
+ * Allow to replace the compare part of a dice and use the critical customized one
+ * @example
+ * dice = "1d20=20";
+ * custom critical {sign: ">", value: "$/2"}
+ * Random stats = 6
+ * result = "1d20>3"
  */
-declare function getEngine(engine: "nativeMath" | "browserCrypto" | "nodeCrypto"): Engine;
+declare function createCriticalCustom(dice: string, customCritical: CustomCritical, template: StatisticalTemplate, engine?: Engine | null): string;
 
 /**
  * Verify if the provided dice work with random value
@@ -425,4 +430,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, MaxGreater, type Modifier, NoStatisticsError, OPTIONAL_COMMENT, type Resultat, SIGN_REGEX, SIGN_REGEX_SPACE, SYMBOL_DICE, type Sign, type Statistic, type StatisticalSchema, type StatisticalTemplate, TooManyDice, TooManyStats, calculator, createCriticalCustom, diceRandomParse, diceTypeRandomParse, escapeRegex, evalCombinaison, evalOneCombinaison, evalStatsDice, generateRandomStat, generateStatsDice, getEngine, getEngineId, isNumber, randomInt, replaceExpByRandom, replaceFormulaInDice, roll, standardizeDice, templateSchema, testDiceRegistered, testStatCombinaison, verifyTemplateValue };
+export { COMMENT_REGEX, type Compare, type ComparedValue, type Critical, type CustomCritical, type CustomCriticalMap, DETECT_CRITICAL, DiceTypeError, EmptyObjectError, FormulaError, MaxGreater, type Modifier, NoStatisticsError, OPTIONAL_COMMENT, type Resultat, SIGN_REGEX, SIGN_REGEX_SPACE, SYMBOL_DICE, type Sign, SortOrder, type Statistic, type StatisticalSchema, type StatisticalTemplate, TooManyDice, TooManyStats, createCriticalCustom, diceRandomParse, diceTypeRandomParse, escapeRegex, evalCombinaison, evalOneCombinaison, evalStatsDice, generateRandomStat, generateStatsDice, getEngine, getEngineId, isNumber, randomInt, replaceExpByRandom, replaceFormulaInDice, replaceInFormula, roll, standardizeDice, templateSchema, testDiceRegistered, testStatCombinaison, verifyTemplateValue };

package/dist/index.d.ts

@@ -2,29 +2,19 @@ import { Engine, Random } from 'random-js';
 import { z } from 'zod';
 
 /**
- * Allow to replace the compare part of a dice and use the critical customized one
- * @example
- * dice = "1d20=20";
- * custom critical {sign: ">", value: "$/2"}
- * Random stats = 6
- * result = "1d20>3"
- */
-declare function createCriticalCustom(dice: string, customCritical: CustomCritical, template: StatisticalTemplate, engine?: Engine | null): string;
-/**
- * Parse the string provided and turn it as a readable dice for dice parser
- * @param dice {string}
- * @param engine
- * @param pity
+ * Utility function that allow to get the id of an engine
+ * @param engine {unknown} Engine to identify
+ * @returns {string} Id of the engine or "unknown"
+ * @private
  */
-declare function roll(dice: string, engine?: Engine | null, pity?: boolean): Resultat | undefined;
+declare function getEngineId(engine: unknown): string;
 /**
- * Evaluate a formula and replace "^" by "**" if any
- * @param {Sign} sign
- * @param {number} value
- * @param {number} total
- * @returns
+ * Utility function to get the engine from its name
+ * @param engine {"nativeMath" | "browserCrypto" | "nodeCrypto"} The engine name
+ * @returns {Engine} The engine
+ * @public
  */
-declare function calculator(sign: Sign, value: number, total: number): number;
+declare function getEngine(engine: "nativeMath" | "browserCrypto" | "nodeCrypto"): Engine;
 
 declare class DiceTypeError extends Error {
     readonly dice: string;
@@ -87,6 +77,7 @@ interface Resultat {
      */
     total?: number;
     pityLogs?: number;
+    trivial?: boolean;
 }
 interface Compare {
     /**
@@ -240,6 +231,11 @@ interface CustomCritical {
      */
     affectSkill?: boolean;
 }
+declare enum SortOrder {
+    Ascending = "sa",
+    Descending = "sd",
+    None = "none"
+}
 
 declare const COMMENT_REGEX: RegExp;
 declare const SIGN_REGEX: RegExp;
@@ -297,6 +293,20 @@ declare const templateSchema: z.ZodObject<{
     damage: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
 }, z.core.$strip>;
 
+/**
+ * Parse the string provided and turn it as a readable dice for dice parser
+ * @param {string} dice The dice string to parse and roll
+ * @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
+ * @returns {Resultat|undefined} The result of the roll
+ */
+declare function roll(dice: string, engine?: Engine | null, pity?: boolean, sort?: SortOrder): Resultat | undefined;
+declare function replaceInFormula(element: string, diceResult: Resultat, compareResult: {
+    dice: string;
+    compare: Compare | undefined;
+}, res: boolean, engine?: Engine | null, pity?: boolean): string;
+
 /**
  * Escape regex string
  * @param string {string}
@@ -345,19 +355,14 @@ declare function replaceExpByRandom(dice: string, engine?: Engine | null): strin
  */
 declare function randomInt(min: number, max: number, engine?: Engine | null, rng?: Random): number;
 /**
- * Utility function that allow to get the id of an engine
- * @param engine {unknown} Engine to identify
- * @returns {string} Id of the engine or "unknown"
- * @private
- */
-declare function getEngineId(engine: unknown): string;
-/**
- * Utility function to get the engine from its name
- * @param engine {"nativeMath" | "browserCrypto" | "nodeCrypto"} The engine name
- * @returns {Engine} The engine
- * @public
+ * Allow to replace the compare part of a dice and use the critical customized one
+ * @example
+ * dice = "1d20=20";
+ * custom critical {sign: ">", value: "$/2"}
+ * Random stats = 6
+ * result = "1d20>3"
  */
-declare function getEngine(engine: "nativeMath" | "browserCrypto" | "nodeCrypto"): Engine;
+declare function createCriticalCustom(dice: string, customCritical: CustomCritical, template: StatisticalTemplate, engine?: Engine | null): string;
 
 /**
  * Verify if the provided dice work with random value
@@ -425,4 +430,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, MaxGreater, type Modifier, NoStatisticsError, OPTIONAL_COMMENT, type Resultat, SIGN_REGEX, SIGN_REGEX_SPACE, SYMBOL_DICE, type Sign, type Statistic, type StatisticalSchema, type StatisticalTemplate, TooManyDice, TooManyStats, calculator, createCriticalCustom, diceRandomParse, diceTypeRandomParse, escapeRegex, evalCombinaison, evalOneCombinaison, evalStatsDice, generateRandomStat, generateStatsDice, getEngine, getEngineId, isNumber, randomInt, replaceExpByRandom, replaceFormulaInDice, roll, standardizeDice, templateSchema, testDiceRegistered, testStatCombinaison, verifyTemplateValue };
+export { COMMENT_REGEX, type Compare, type ComparedValue, type Critical, type CustomCritical, type CustomCriticalMap, DETECT_CRITICAL, DiceTypeError, EmptyObjectError, FormulaError, MaxGreater, type Modifier, NoStatisticsError, OPTIONAL_COMMENT, type Resultat, SIGN_REGEX, SIGN_REGEX_SPACE, SYMBOL_DICE, type Sign, SortOrder, type Statistic, type StatisticalSchema, type StatisticalTemplate, TooManyDice, TooManyStats, createCriticalCustom, diceRandomParse, diceTypeRandomParse, escapeRegex, evalCombinaison, evalOneCombinaison, evalStatsDice, generateRandomStat, generateStatsDice, getEngine, getEngineId, isNumber, randomInt, replaceExpByRandom, replaceFormulaInDice, replaceInFormula, roll, standardizeDice, templateSchema, testDiceRegistered, testStatCombinaison, verifyTemplateValue };