@tmlmt/cooklang-parser 3.0.0-alpha.4 → 3.0.0-alpha.7

package/dist/index.cjs

@@ -312,17 +312,19 @@ var nonWordChar = "\\s@#~\\[\\]{(,;:!?";
 var nonWordCharStrict = "\\s@#~\\[\\]{(,;:!?|";
 var ingredientWithAlternativeRegex = d().literal("@").startNamedGroup("ingredientModifiers").anyOf("@\\-&?").zeroOrMore().endGroup().optional().startNamedGroup("ingredientRecipeAnchor").literal("./").endGroup().optional().startGroup().startGroup().startNamedGroup("mIngredientName").notAnyOf(nonWordChar).oneOrMore().startGroup().whitespace().oneOrMore().notAnyOf(nonWordChar).oneOrMore().endGroup().oneOrMore().endGroup().positiveLookahead("\\s*(?:\\{[^\\}]*\\}|\\([^)]*\\))").endGroup().or().startNamedGroup("sIngredientName").notAnyOf(nonWordChar).zeroOrMore().notAnyOf("\\." + nonWordChar).endGroup().endGroup().startGroup().literal("{").startNamedGroup("ingredientQuantityModifier").literal("=").exactly(1).endGroup().optional().startNamedGroup("ingredientQuantity").startGroup().notAnyOf("}|%").oneOrMore().endGroup().optional().startGroup().literal("%").notAnyOf("|}").oneOrMore().lazy().endGroup().optional().startGroup().literal("|").notAnyOf("}").oneOrMore().lazy().endGroup().zeroOrMore().endGroup().literal("}").endGroup().optional().startGroup().literal("(").startNamedGroup("ingredientPreparation").notAnyOf(")").oneOrMore().lazy().endGroup().literal(")").endGroup().optional().startGroup().literal("[").startNamedGroup("ingredientNote").notAnyOf("\\]").oneOrMore().lazy().endGroup().literal("]").endGroup().optional().startNamedGroup("ingredientAlternative").startGroup().literal("|").startGroup().anyOf("@\\-&?").zeroOrMore().endGroup().optional().startGroup().literal("./").endGroup().optional().startGroup().startGroup().startGroup().notAnyOf(nonWordChar).oneOrMore().startGroup().whitespace().oneOrMore().notAnyOf(nonWordChar).oneOrMore().endGroup().oneOrMore().endGroup().positiveLookahead("\\s*(?:\\{[^\\}]*\\}|\\([^)]*\\))").endGroup().or().startGroup().notAnyOf(nonWordChar).oneOrMore().endGroup().endGroup().startGroup().literal("{").startGroup().literal("=").exactly(1).endGroup().optional().startGroup().notAnyOf("}%").oneOrMore().endGroup().optional().startGroup().literal("%").startGroup().notAnyOf("}").oneOrMore().lazy().endGroup().endGroup().optional().literal("}").endGroup().optional().startGroup().literal("(").startGroup().notAnyOf(")").oneOrMore().lazy().endGroup().literal(")").endGroup().optional().startGroup().literal("[").startGroup().notAnyOf("\\]").oneOrMore().lazy().endGroup().literal("]").endGroup().optional().endGroup().zeroOrMore().endGroup().toRegExp();
 var inlineIngredientAlternativesRegex = new RegExp("\\|" + ingredientWithAlternativeRegex.source.slice(1));
-var quantityAlternativeRegex = d().startNamedGroup("ingredientQuantityValue").notAnyOf("}|%").oneOrMore().endGroup().optional().startGroup().literal("%").startNamedGroup("ingredientUnit").notAnyOf("|}").oneOrMore().endGroup().endGroup().optional().startGroup().literal("|").startNamedGroup("ingredientAltQuantity").startGroup().notAnyOf("}").oneOrMore().endGroup().zeroOrMore().endGroup().endGroup().optional().toRegExp();
+var quantityAlternativeRegex = d().startNamedGroup("quantity").notAnyOf("}|%").oneOrMore().endGroup().optional().startGroup().literal("%").startNamedGroup("unit").notAnyOf("|}").oneOrMore().endGroup().endGroup().optional().startGroup().literal("|").startNamedGroup("alternative").startGroup().notAnyOf("}").oneOrMore().endGroup().zeroOrMore().endGroup().endGroup().optional().toRegExp();
 var ingredientWithGroupKeyRegex = d().literal("@|").startNamedGroup("gIngredientGroupKey").notAnyOf(nonWordCharStrict).oneOrMore().endGroup().literal("|").startNamedGroup("gIngredientModifiers").anyOf("@\\-&?").zeroOrMore().endGroup().optional().startNamedGroup("gIngredientRecipeAnchor").literal("./").endGroup().optional().startGroup().startGroup().startNamedGroup("gmIngredientName").notAnyOf(nonWordChar).oneOrMore().startGroup().whitespace().oneOrMore().notAnyOf(nonWordChar).oneOrMore().endGroup().oneOrMore().endGroup().positiveLookahead("\\s*(?:\\{[^\\}]*\\}|\\([^)]*\\))").endGroup().or().startNamedGroup("gsIngredientName").notAnyOf(nonWordChar).zeroOrMore().notAnyOf("\\." + nonWordChar).endGroup().endGroup().startGroup().literal("{").startNamedGroup("gIngredientQuantityModifier").literal("=").exactly(1).endGroup().optional().startNamedGroup("gIngredientQuantity").startGroup().notAnyOf("}|%").oneOrMore().endGroup().optional().startGroup().literal("%").notAnyOf("|}").oneOrMore().lazy().endGroup().optional().startGroup().literal("|").notAnyOf("}").oneOrMore().lazy().endGroup().zeroOrMore().endGroup().literal("}").endGroup().optional().startGroup().literal("(").startNamedGroup("gIngredientPreparation").notAnyOf(")").oneOrMore().lazy().endGroup().literal(")").endGroup().optional().toRegExp();
 var ingredientAliasRegex = d().startAnchor().startNamedGroup("ingredientListName").notAnyOf("|").oneOrMore().endGroup().literal("|").startNamedGroup("ingredientDisplayName").notAnyOf("|").oneOrMore().endGroup().endAnchor().toRegExp();
 var cookwareRegex = d().literal("#").startNamedGroup("cookwareModifiers").anyOf("\\-&?").zeroOrMore().endGroup().startGroup().startGroup().startNamedGroup("mCookwareName").notAnyOf(nonWordChar).oneOrMore().startGroup().whitespace().oneOrMore().notAnyOf(nonWordChar).oneOrMore().endGroup().oneOrMore().endGroup().positiveLookahead("\\s*(?:\\{[^\\}]*\\})").endGroup().or().startNamedGroup("sCookwareName").notAnyOf(nonWordChar).zeroOrMore().notAnyOf("\\." + nonWordChar).endGroup().endGroup().startGroup().literal("{").startNamedGroup("cookwareQuantity").anyCharacter().zeroOrMore().lazy().endGroup().literal("}").endGroup().optional().toRegExp();
 var timerRegex = d().literal("~").startNamedGroup("timerName").anyCharacter().zeroOrMore().lazy().endGroup().literal("{").startNamedGroup("timerQuantity").anyCharacter().oneOrMore().lazy().endGroup().startGroup().literal("%").startNamedGroup("timerUnit").anyCharacter().oneOrMore().lazy().endGroup().endGroup().optional().literal("}").toRegExp();
+var arbitraryScalableRegex = d().literal("{{").startGroup().startNamedGroup("arbitraryName").notAnyOf("}:%").oneOrMore().endGroup().literal(":").endGroup().optional().startNamedGroup("arbitraryQuantity").startGroup().notAnyOf("}|%").oneOrMore().endGroup().optional().startGroup().literal("%").notAnyOf("|}").oneOrMore().lazy().endGroup().optional().startGroup().literal("|").notAnyOf("}").oneOrMore().lazy().endGroup().zeroOrMore().endGroup().literal("}}").toRegExp();
 var tokensRegex = new RegExp(
   [
     ingredientWithGroupKeyRegex,
     ingredientWithAlternativeRegex,
     cookwareRegex,
-    timerRegex
+    timerRegex,
+    arbitraryScalableRegex
   ].map((r2) => r2.source).join("|"),
   "gu"
 );
@@ -554,8 +556,8 @@ function multiplyQuantityValue(value, factor) {
       value.value,
       (0, import_big.default)(factor)
     );
-    if (factor === parseInt(factor.toString()) || // e.g. 2 === int
-    (0, import_big.default)(1).div(factor).toNumber() === parseInt((0, import_big.default)(1).div(factor).toString())) {
+    if (newValue.type === "fraction" && ((0, import_big.default)(factor).toNumber() === parseInt((0, import_big.default)(factor).toString()) || // e.g. 2 === int
+    (0, import_big.default)(1).div(factor).toNumber() === parseInt((0, import_big.default)(1).div(factor).toString()))) {
       return {
         type: "fixed",
         value: newValue
@@ -642,8 +644,10 @@ var IncompatibleUnitsError = class extends Error {
   }
 };
 var InvalidQuantityFormat = class extends Error {
-  constructor(value) {
-    super(`Invalid quantity format found in: ${value}`);
+  constructor(value, extra) {
+    super(
+      `Invalid quantity format found in: ${value}${extra ? ` (${extra})` : ""}`
+    );
     this.name = "InvalidQuantityFormat";
   }
 };
@@ -833,7 +837,7 @@ var flattenPlainUnitGroup = (summed) => {
           }
         ];
       } else {
-        return andEntries.map((entry) => ({ groupQuantity: entry }));
+        return andEntries;
       }
     }
     const simpleEntries = entries.filter(
@@ -847,12 +851,10 @@ var flattenPlainUnitGroup = (summed) => {
       if (simpleEntries.length > 1) {
         result.equivalents = simpleEntries.slice(1);
       }
-      return [{ groupQuantity: result }];
+      return [result];
     } else {
       const first = entries[0];
-      return [
-        { groupQuantity: { quantity: first.quantity, unit: first.unit } }
-      ];
+      return [{ quantity: first.quantity, unit: first.unit }];
     }
   } else if (isGroup(summed)) {
     const andEntries = [];
@@ -877,7 +879,7 @@ var flattenPlainUnitGroup = (summed) => {
       }
     }
     if (equivalentsList.length === 0) {
-      return andEntries.map((entry) => ({ groupQuantity: entry }));
+      return andEntries;
     }
     const result = {
       type: "and",
@@ -886,19 +888,17 @@ var flattenPlainUnitGroup = (summed) => {
     };
     return [result];
   } else {
-    return [
-      { groupQuantity: { quantity: summed.quantity, unit: summed.unit } }
-    ];
+    return [{ quantity: summed.quantity, unit: summed.unit }];
   }
 };
 
 // src/utils/parser_helpers.ts
-function flushPendingNote(section, note) {
-  if (note.length > 0) {
-    section.content.push({ type: "note", note });
-    return "";
+function flushPendingNote(section, noteItems) {
+  if (noteItems.length > 0) {
+    section.content.push({ type: "note", items: [...noteItems] });
+    return [];
   }
-  return note;
+  return noteItems;
 }
 function flushPendingItems(section, items) {
   if (items.length > 0) {
@@ -1671,6 +1671,10 @@ var _Recipe = class _Recipe {
      * The parsed recipe timers.
      */
     __publicField(this, "timers", []);
+    /**
+     * The parsed arbitrary quantities.
+     */
+    __publicField(this, "arbitraries", []);
     /**
      * The parsed recipe servings. Used for scaling. Parsed from one of
      * {@link Metadata.servings}, {@link Metadata.yield} or {@link Metadata.serves}
@@ -1698,12 +1702,64 @@ var _Recipe = class _Recipe {
     _Recipe.itemCounts.set(this, current + 1);
     return current;
   }
+  /**
+   * Parses a matched arbitrary scalable quantity and adds it to the given array.
+   * @private
+   * @param regexMatchGroups - The regex match groups from arbitrary scalable regex.
+   * @param intoArray - The array to push the parsed arbitrary scalable item into.
+   */
+  _parseArbitraryScalable(regexMatchGroups, intoArray) {
+    if (!regexMatchGroups || !regexMatchGroups.arbitraryQuantity) return;
+    const quantityMatch = regexMatchGroups.arbitraryQuantity?.trim().match(quantityAlternativeRegex);
+    if (quantityMatch?.groups) {
+      const value = quantityMatch.groups.quantity ? parseQuantityInput(quantityMatch.groups.quantity) : void 0;
+      const unit = quantityMatch.groups.unit;
+      const name = regexMatchGroups.arbitraryName || void 0;
+      if (!value || value.type === "fixed" && value.value.type === "text") {
+        throw new InvalidQuantityFormat(
+          regexMatchGroups.arbitraryQuantity?.trim(),
+          "Arbitrary quantities must have a numerical value"
+        );
+      }
+      const arbitrary = {
+        quantity: value
+      };
+      if (name) arbitrary.name = name;
+      if (unit) arbitrary.unit = unit;
+      intoArray.push({
+        type: "arbitrary",
+        index: this.arbitraries.push(arbitrary) - 1
+      });
+    }
+  }
+  /**
+   * Parses text for arbitrary scalables and returns NoteItem array.
+   * @param text - The text to parse for arbitrary scalables.
+   * @returns Array of NoteItem (text and arbitrary scalable items).
+   */
+  _parseNoteText(text) {
+    const noteItems = [];
+    let cursor = 0;
+    const globalRegex = new RegExp(arbitraryScalableRegex.source, "g");
+    for (const match of text.matchAll(globalRegex)) {
+      const idx = match.index;
+      if (idx > cursor) {
+        noteItems.push({ type: "text", value: text.slice(cursor, idx) });
+      }
+      this._parseArbitraryScalable(match.groups, noteItems);
+      cursor = idx + match[0].length;
+    }
+    if (cursor < text.length) {
+      noteItems.push({ type: "text", value: text.slice(cursor) });
+    }
+    return noteItems;
+  }
   _parseQuantityRecursive(quantityRaw) {
     let quantityMatch = quantityRaw.match(quantityAlternativeRegex);
     const quantities = [];
     while (quantityMatch?.groups) {
-      const value = quantityMatch.groups.ingredientQuantityValue ? parseQuantityInput(quantityMatch.groups.ingredientQuantityValue) : void 0;
-      const unit = quantityMatch.groups.ingredientUnit;
+      const value = quantityMatch.groups.quantity ? parseQuantityInput(quantityMatch.groups.quantity) : void 0;
+      const unit = quantityMatch.groups.unit;
       if (value) {
         const newQuantity = { quantity: value };
         if (unit) {
@@ -1720,9 +1776,7 @@ var _Recipe = class _Recipe {
       } else {
         throw new InvalidQuantityFormat(quantityRaw);
       }
-      quantityMatch = quantityMatch.groups.ingredientAltQuantity ? quantityMatch.groups.ingredientAltQuantity.match(
-        quantityAlternativeRegex
-      ) : null;
+      quantityMatch = quantityMatch.groups.alternative ? quantityMatch.groups.alternative.match(quantityAlternativeRegex) : null;
     }
     return quantities;
   }
@@ -2025,7 +2079,7 @@ var _Recipe = class _Recipe {
                     (eq) => toPlainUnit(eq)
                   );
                 }
-                newRef.alternativeQuantities = [altQty];
+                newRef.quantities = [altQty];
               }
               alternativeRefs.push(newRef);
             }
@@ -2050,7 +2104,7 @@ var _Recipe = class _Recipe {
                 }
                 alternativeRefs.push({
                   index: otherAlt.index,
-                  alternativeQuantities: [altQty]
+                  quantities: [altQty]
                 });
               }
             }
@@ -2077,8 +2131,8 @@ var _Recipe = class _Recipe {
               if (!group.alternativeQuantities.has(ref.index)) {
                 group.alternativeQuantities.set(ref.index, []);
               }
-              if (ref.alternativeQuantities && ref.alternativeQuantities.length > 0) {
-                for (const altQty of ref.alternativeQuantities) {
+              if (ref.quantities && ref.quantities.length > 0) {
+                for (const altQty of ref.quantities) {
                   if (altQty.equivalents && altQty.equivalents.length > 0) {
                     const entries = [
                       toExtendedUnit({
@@ -2121,9 +2175,9 @@ var _Recipe = class _Recipe {
                 ...altQuantities
               );
               const flattenedAlt = flattenPlainUnitGroup(summedAltQuantity);
-              ref.alternativeQuantities = flattenedAlt.flatMap((item) => {
-                if ("groupQuantity" in item) {
-                  return [item.groupQuantity];
+              ref.quantities = flattenedAlt.flatMap((item) => {
+                if ("quantity" in item) {
+                  return [item];
                 } else {
                   return item.entries;
                 }
@@ -2254,19 +2308,27 @@ var _Recipe = class _Recipe {
     let blankLineBefore = true;
     let section = new Section();
     const items = [];
-    let note = "";
+    let noteText = "";
     let inNote = false;
     for (const line of cleanContent) {
       if (line.trim().length === 0) {
         flushPendingItems(section, items);
-        note = flushPendingNote(section, note);
+        flushPendingNote(
+          section,
+          noteText ? this._parseNoteText(noteText) : []
+        );
+        noteText = "";
         blankLineBefore = true;
         inNote = false;
         continue;
       }
       if (line.startsWith("=")) {
         flushPendingItems(section, items);
-        note = flushPendingNote(section, note);
+        flushPendingNote(
+          section,
+          noteText ? this._parseNoteText(noteText) : []
+        );
+        noteText = "";
         if (this.sections.length === 0 && section.isBlank()) {
           section.name = line.replace(/^=+|=+$/g, "").trim();
         } else {
@@ -2281,22 +2343,26 @@ var _Recipe = class _Recipe {
       }
       if (blankLineBefore && line.startsWith(">")) {
         flushPendingItems(section, items);
-        note = flushPendingNote(section, note);
-        note += line.substring(1).trim();
+        flushPendingNote(
+          section,
+          noteText ? this._parseNoteText(noteText) : []
+        );
+        noteText = line.substring(1).trim();
         inNote = true;
         blankLineBefore = false;
         continue;
       }
       if (inNote) {
         if (line.startsWith(">")) {
-          note += " " + line.substring(1).trim();
+          noteText += " " + line.substring(1).trim();
         } else {
-          note += " " + line.trim();
+          noteText += " " + line.trim();
         }
         blankLineBefore = false;
         continue;
       }
-      note = flushPendingNote(section, note);
+      flushPendingNote(section, noteText ? this._parseNoteText(noteText) : []);
+      noteText = "";
       let cursor = 0;
       for (const match of line.matchAll(tokensRegex)) {
         const idx = match.index;
@@ -2343,6 +2409,8 @@ var _Recipe = class _Recipe {
             newItem.quantity = quantity;
           }
           items.push(newItem);
+        } else if (groups.arbitraryQuantity) {
+          this._parseArbitraryScalable(groups, items);
         } else {
           const durationStr = groups.timerQuantity.trim();
           const unit = (groups.timerUnit || "").trim();
@@ -2366,7 +2434,7 @@ var _Recipe = class _Recipe {
       blankLineBefore = false;
     }
     flushPendingItems(section, items);
-    note = flushPendingNote(section, note);
+    flushPendingNote(section, noteText ? this._parseNoteText(noteText) : []);
     if (!section.isBlank()) {
       this.sections.push(section);
     }
@@ -2381,9 +2449,9 @@ var _Recipe = class _Recipe {
    * @throws `Error` if the recipe does not contains an initial {@link Recipe.servings | servings} value
    */
   scaleTo(newServings) {
-    const originalServings = this.getServings();
+    let originalServings = this.getServings();
     if (originalServings === void 0 || originalServings === 0) {
-      throw new Error("Error scaling recipe: no initial servings value set");
+      originalServings = 1;
     }
     const factor = (0, import_big4.default)(newServings).div(originalServings);
     return this.scaleBy(factor);
@@ -2396,9 +2464,9 @@ var _Recipe = class _Recipe {
    */
   scaleBy(factor) {
     const newRecipe = this.clone();
-    const originalServings = newRecipe.getServings();
+    let originalServings = newRecipe.getServings();
     if (originalServings === void 0 || originalServings === 0) {
-      throw new Error("Error scaling recipe: no initial servings value set");
+      originalServings = 1;
     }
     function scaleAlternativesBy(alternatives, factor2) {
       for (const alternative of alternatives) {
@@ -2447,6 +2515,12 @@ var _Recipe = class _Recipe {
     for (const alternatives of newRecipe.choices.ingredientItems.values()) {
       scaleAlternativesBy(alternatives, factor);
     }
+    for (const arbitrary of newRecipe.arbitraries) {
+      arbitrary.quantity = multiplyQuantityValue(
+        arbitrary.quantity,
+        factor
+      );
+    }
     newRecipe._populate_ingredient_quantities();
     newRecipe.servings = (0, import_big4.default)(originalServings).times(factor).toNumber();
     if (newRecipe.metadata.servings && this.metadata.servings) {
@@ -2509,6 +2583,7 @@ var _Recipe = class _Recipe {
     });
     newRecipe.cookware = deepClone(this.cookware);
     newRecipe.timers = deepClone(this.timers);
+    newRecipe.arbitraries = deepClone(this.arbitraries);
     newRecipe.servings = this.servings;
     return newRecipe;
   }