@tmlmt/cooklang-parser 3.0.0-alpha.21 → 3.0.0-alpha.23

package/dist/index.d.cts

@@ -334,7 +334,7 @@ interface MetadataObject {
  * Represents any value that can appear in recipe metadata.
  * @category Types
  */
-type MetadataValue = string | number | (string | number)[] | MetadataObject | MetadataSource | MetadataTime | Yield | undefined;
+type MetadataValue = string | number | (string | number | MetadataObject)[] | MetadataObject | MetadataSource | MetadataTime | Yield | undefined;
 /**
  * Represents the metadata of a recipe.
  * @category Types
@@ -509,7 +509,7 @@ interface IngredientExtras {
      * Used if: the ingredient is a recipe
      *
      * @example
-     * ```cooklang
+     * ```yaml
      * Take @./essentials/doughs/pizza dough{1} out of the freezer and let it unfreeze overnight
      * ```
      * Would lead to:
@@ -541,9 +541,12 @@ interface AlternativeIngredientRef {
 interface IngredientQuantityGroup extends QuantityWithPlainUnit {
     /**
      * References to alternative ingredients for this quantity group.
+     * Each inner array represents one alternative choice option (subgroup).
+     * Items within the same inner array are combined with "+" (AND),
+     * while different inner arrays represent "or" alternatives.
      * If undefined, this group has no alternatives.
      */
-    alternatives?: AlternativeIngredientRef[];
+    alternatives?: AlternativeIngredientRef[][];
 }
 /**
  * Represents an AND group of quantities when primary units are incompatible but equivalents can be summed.
@@ -557,9 +560,12 @@ interface IngredientQuantityAndGroup extends FlatAndGroup<QuantityWithPlainUnit>
     equivalents?: QuantityWithPlainUnit[];
     /**
      * References to alternative ingredients for this quantity group.
+     * Each inner array represents one alternative choice option (subgroup).
+     * Items within the same inner array are combined with "+" (AND),
+     * while different inner arrays represent "or" alternatives.
      * If undefined, this group has no alternatives.
      */
-    alternatives?: AlternativeIngredientRef[];
+    alternatives?: AlternativeIngredientRef[][];
 }
 /**
  * Represents an ingredient in a recipe.
@@ -1760,15 +1766,15 @@ declare function renderFractionAsVulgar(num: number, den: number): string;
  * Format a numeric value (decimal or fraction) to a string.
  *
  * @param value - The decimal or fraction value to format
- * @param useVulgar - Whether to use Unicode vulgar fraction characters (default: false)
+ * @param useVulgar - Whether to use Unicode vulgar fraction characters (default: true)
  * @returns The formatted string representation
  * @category Helpers
  *
  * @example
  * ```typescript
  * formatNumericValue({ type: "decimal", decimal: 1.5 }); // "1.5"
- * formatNumericValue({ type: "fraction", num: 1, den: 2 }); // "1/2"
- * formatNumericValue({ type: "fraction", num: 1, den: 2 }, true); // "½"
+ * formatNumericValue({ type: "fraction", num: 1, den: 2 }); // "½"
+ * formatNumericValue({ type: "fraction", num: 1, den: 2 }, false); // "1/2"
  * formatNumericValue({ type: "fraction", num: 5, den: 4 }, true); // "1¼"
  * ```
  */
@@ -1899,7 +1905,7 @@ declare function isGroupedItem(item: IngredientItem): boolean;
  * for (const item of step.items) {
  *   if (item.type === 'ingredient') {
  *     item.alternatives.forEach((alt, idx) => {
- *       const isSelected = isAlternativeSelected(item, idx, recipe, choices);
+ *       const isSelected = isAlternativeSelected(recipe, choices, item, idx);
  *       // Render differently based on isSelected
  *     });
  *   }
@@ -2033,15 +2039,18 @@ declare function isSimpleGroup(entry: IngredientQuantityGroup | IngredientQuanti
  * for (const entry of ingredient.quantities) {
  *   if (hasAlternatives(entry)) {
  *     // entry.alternatives is available and non-empty
- *     for (const alt of entry.alternatives) {
- *       console.log(`Alternative ingredient index: ${alt.index}`);
+ *     for (const subgroup of entry.alternatives) {
+ *       // Each subgroup is one "or" choice; items within are combined with "+"
+ *       for (const alt of subgroup) {
+ *         console.log(`Alternative ingredient index: ${alt.index}`);
+ *       }
  *     }
  *   }
  * }
  * ```
  */
 declare function hasAlternatives(entry: IngredientQuantityGroup | IngredientQuantityAndGroup): entry is (IngredientQuantityGroup | IngredientQuantityAndGroup) & {
-    alternatives: AlternativeIngredientRef[];
+    alternatives: AlternativeIngredientRef[][];
 };
 
 /**

package/dist/index.d.ts

@@ -334,7 +334,7 @@ interface MetadataObject {
  * Represents any value that can appear in recipe metadata.
  * @category Types
  */
-type MetadataValue = string | number | (string | number)[] | MetadataObject | MetadataSource | MetadataTime | Yield | undefined;
+type MetadataValue = string | number | (string | number | MetadataObject)[] | MetadataObject | MetadataSource | MetadataTime | Yield | undefined;
 /**
  * Represents the metadata of a recipe.
  * @category Types
@@ -509,7 +509,7 @@ interface IngredientExtras {
      * Used if: the ingredient is a recipe
      *
      * @example
-     * ```cooklang
+     * ```yaml
      * Take @./essentials/doughs/pizza dough{1} out of the freezer and let it unfreeze overnight
      * ```
      * Would lead to:
@@ -541,9 +541,12 @@ interface AlternativeIngredientRef {
 interface IngredientQuantityGroup extends QuantityWithPlainUnit {
     /**
      * References to alternative ingredients for this quantity group.
+     * Each inner array represents one alternative choice option (subgroup).
+     * Items within the same inner array are combined with "+" (AND),
+     * while different inner arrays represent "or" alternatives.
      * If undefined, this group has no alternatives.
      */
-    alternatives?: AlternativeIngredientRef[];
+    alternatives?: AlternativeIngredientRef[][];
 }
 /**
  * Represents an AND group of quantities when primary units are incompatible but equivalents can be summed.
@@ -557,9 +560,12 @@ interface IngredientQuantityAndGroup extends FlatAndGroup<QuantityWithPlainUnit>
     equivalents?: QuantityWithPlainUnit[];
     /**
      * References to alternative ingredients for this quantity group.
+     * Each inner array represents one alternative choice option (subgroup).
+     * Items within the same inner array are combined with "+" (AND),
+     * while different inner arrays represent "or" alternatives.
      * If undefined, this group has no alternatives.
      */
-    alternatives?: AlternativeIngredientRef[];
+    alternatives?: AlternativeIngredientRef[][];
 }
 /**
  * Represents an ingredient in a recipe.
@@ -1760,15 +1766,15 @@ declare function renderFractionAsVulgar(num: number, den: number): string;
  * Format a numeric value (decimal or fraction) to a string.
  *
  * @param value - The decimal or fraction value to format
- * @param useVulgar - Whether to use Unicode vulgar fraction characters (default: false)
+ * @param useVulgar - Whether to use Unicode vulgar fraction characters (default: true)
  * @returns The formatted string representation
  * @category Helpers
  *
  * @example
  * ```typescript
  * formatNumericValue({ type: "decimal", decimal: 1.5 }); // "1.5"
- * formatNumericValue({ type: "fraction", num: 1, den: 2 }); // "1/2"
- * formatNumericValue({ type: "fraction", num: 1, den: 2 }, true); // "½"
+ * formatNumericValue({ type: "fraction", num: 1, den: 2 }); // "½"
+ * formatNumericValue({ type: "fraction", num: 1, den: 2 }, false); // "1/2"
  * formatNumericValue({ type: "fraction", num: 5, den: 4 }, true); // "1¼"
  * ```
  */
@@ -1899,7 +1905,7 @@ declare function isGroupedItem(item: IngredientItem): boolean;
  * for (const item of step.items) {
  *   if (item.type === 'ingredient') {
  *     item.alternatives.forEach((alt, idx) => {
- *       const isSelected = isAlternativeSelected(item, idx, recipe, choices);
+ *       const isSelected = isAlternativeSelected(recipe, choices, item, idx);
  *       // Render differently based on isSelected
  *     });
  *   }
@@ -2033,15 +2039,18 @@ declare function isSimpleGroup(entry: IngredientQuantityGroup | IngredientQuanti
  * for (const entry of ingredient.quantities) {
  *   if (hasAlternatives(entry)) {
  *     // entry.alternatives is available and non-empty
- *     for (const alt of entry.alternatives) {
- *       console.log(`Alternative ingredient index: ${alt.index}`);
+ *     for (const subgroup of entry.alternatives) {
+ *       // Each subgroup is one "or" choice; items within are combined with "+"
+ *       for (const alt of subgroup) {
+ *         console.log(`Alternative ingredient index: ${alt.index}`);
+ *       }
  *     }
  *   }
  * }
  * ```
  */
 declare function hasAlternatives(entry: IngredientQuantityGroup | IngredientQuantityAndGroup): entry is (IngredientQuantityGroup | IngredientQuantityAndGroup) & {
-    alternatives: AlternativeIngredientRef[];
+    alternatives: AlternativeIngredientRef[][];
 };
 
 /**

package/dist/index.js

@@ -1774,6 +1774,10 @@ function parseNestedMetaVar(content, varName) {
   const match = content.match(nestedMetaVarRegex(varName));
   if (!match) return void 0;
   const nestedContent = match[1];
+  const lines = nestedContent.split(/\r?\n/).filter((line) => line.trim() !== "");
+  if (lines.length > 0 && lines[0].trim().startsWith("- ")) {
+    return parseListItems(lines);
+  }
   return parseNestedBlock(nestedContent);
 }
 function parseNestedBlock(content) {
@@ -1800,7 +1804,7 @@ function parseNestedBlock(content) {
     if (currentIndent !== baseIndent) {
       throw new BadIndentationError();
     }
-    const keyValueMatch = line.match(/^[ ]*([^:\n]+?):\s*(.*)$/);
+    const keyValueMatch = line.match(/^ *([^:\n]+?):\s*(.*)$/);
     if (!keyValueMatch) {
       i2++;
       continue;
@@ -1812,7 +1816,7 @@ function parseNestedBlock(content) {
       let j = i2 + 1;
       while (j < lines.length) {
         const childLine = lines[j];
-        const childIndent = childLine.match(/^([ ]*)/)?.[1]?.length;
+        const childIndent = childLine.match(/^( *)/)?.[1]?.length;
         if (childIndent && childIndent > baseIndent) {
           childLines.push(childLine);
           j++;
@@ -1823,14 +1827,7 @@ function parseNestedBlock(content) {
       if (childLines.length > 0) {
         const firstChildTrimmed = childLines[0].trim();
         if (firstChildTrimmed.startsWith("- ")) {
-          const reconstructedContent = `${key}:
-${childLines.join("\n")}`;
-          const listResult = parseListMetaVar(reconstructedContent, key);
-          if (listResult) {
-            result[key] = listResult.map(
-              (item) => parseMetadataValue(item)
-            );
-          }
+          result[key] = parseListItems(childLines);
         } else {
           const childContent = childLines.join("\n");
           const nested = parseNestedBlock(childContent);
@@ -1838,16 +1835,67 @@ ${childLines.join("\n")}`;
             result[key] = nested;
           }
         }
+      } else {
+        result[key] = "";
       }
       i2 = j;
     } else {
-      result[key] = parseMetadataValue(rawValue);
+      result[key] = parseSingleLineMetadataValue(rawValue);
       i2++;
     }
   }
   return result;
 }
-function parseMetadataValue(rawValue) {
+function parseListItems(childLines) {
+  const listIndent = childLines[0].match(/^( *)/)?.[1]?.length;
+  const groups = [];
+  let currentGroup = [];
+  for (const line of childLines) {
+    const indent = line.match(/^( *)/)?.[1]?.length;
+    if (indent === listIndent && line.trim().startsWith("- ")) {
+      if (currentGroup.length > 0) {
+        groups.push(currentGroup);
+      }
+      currentGroup = [line];
+    } else {
+      currentGroup.push(line);
+    }
+  }
+  groups.push(currentGroup);
+  const isObjectItem = (group) => {
+    if (group.length > 1) return true;
+    const value = group[0].replace(/^\s*-\s*/, "").trim();
+    return /^[^:\n]+:\s/.test(value);
+  };
+  const hasObjectItems = groups.some(isObjectItem);
+  if (!hasObjectItems) {
+    return groups.map((group) => {
+      const value = group[0].replace(/^\s*-\s*/, "").trim();
+      return parseSingleLineMetadataValue(value);
+    });
+  }
+  const items = [];
+  for (const group of groups) {
+    const firstLine = group[0];
+    const afterDash = firstLine.replace(/^\s*-\s*/, "");
+    const dashPrefixMatch = firstLine.match(/^( *-\s*)/);
+    const contentIndent = dashPrefixMatch?.[1]?.length;
+    const objectLines = [" ".repeat(contentIndent) + afterDash];
+    for (let k = 1; k < group.length; k++) {
+      objectLines.push(group[k]);
+    }
+    const parsed = parseNestedBlock(objectLines.join("\n"));
+    if (parsed) {
+      items.push(parsed);
+    } else {
+      items.push(
+        parseSingleLineMetadataValue(afterDash.trim())
+      );
+    }
+  }
+  return items;
+}
+function parseSingleLineMetadataValue(rawValue) {
   if (rawValue.startsWith("[") && rawValue.endsWith("]")) {
     return rawValue.slice(1, -1).split(",").map((item) => item.trim());
   }
@@ -1862,7 +1910,7 @@ function parseAnyMetaVar(content, varName) {
   const list = parseListMetaVar(content, varName);
   if (list) return list;
   const simple = parseSimpleMetaVar(content, varName);
-  if (simple) return parseMetadataValue(simple);
+  if (simple) return parseSingleLineMetadataValue(simple);
   return void 0;
 }
 function getNumericValueFromYield(v) {
@@ -1946,7 +1994,7 @@ function extractMetadata(content) {
   const sourceName = parseSimpleMetaVar(metadataContent, "source.name");
   const sourceUrl = parseSimpleMetaVar(metadataContent, "source.url");
   const sourceAuthor = parseSimpleMetaVar(metadataContent, "source.author");
-  if (sourceNested) {
+  if (sourceNested && !Array.isArray(sourceNested)) {
     const source = {};
     if (typeof sourceNested.name === "string") source.name = sourceNested.name;
     if (typeof sourceNested.url === "string") source.url = sourceNested.url;
@@ -1966,7 +2014,7 @@ function extractMetadata(content) {
   const prepTime = parseSimpleMetaVar(metadataContent, "prep time") ?? parseSimpleMetaVar(metadataContent, "time.prep");
   const cookTime = parseSimpleMetaVar(metadataContent, "cook time") ?? parseSimpleMetaVar(metadataContent, "time.cook");
   const totalTime = parseSimpleMetaVar(metadataContent, "time required") ?? parseSimpleMetaVar(metadataContent, "time") ?? parseSimpleMetaVar(metadataContent, "duration");
-  if (timeNested) {
+  if (timeNested && !Array.isArray(timeNested)) {
     const time = {};
     if (typeof timeNested.prep === "string") time.prep = timeNested.prep;
     if (typeof timeNested.cook === "string") time.cook = timeNested.cook;
@@ -2033,7 +2081,7 @@ function unionOfSets(s1, s2) {
 }
 function getAlternativeSignature(alternatives) {
   if (!alternatives || alternatives.length === 0) return null;
-  return alternatives.map((a2) => a2.index).sort((a2, b) => a2 - b).join(",");
+  return alternatives.flat().map((a2) => a2.index).sort((a2, b) => a2 - b).join(",");
 }
 
 // src/classes/pantry.ts
@@ -3346,7 +3394,7 @@ var _Recipe = class _Recipe {
             const currentSubgroupIdx = groupSubgroups.findIndex(
               (sg) => sg.some((alt) => alt.itemId === item.id)
             );
-            alternativeRefs = groupSubgroups.filter((_, idx) => idx !== currentSubgroupIdx).flatMap(
+            alternativeRefs = groupSubgroups.filter((_, idx) => idx !== currentSubgroupIdx).map(
               (subgroup) => subgroup.map((otherAlt) => {
                 const ref = {
                   index: otherAlt.index
@@ -3385,7 +3433,7 @@ var _Recipe = class _Recipe {
                 };
                 ref.quantities = [altQty];
               }
-              return ref;
+              return [ref];
             });
           }
           const altIndices = getAlternativeSignature(alternativeRefs) ?? "";
@@ -3406,28 +3454,36 @@ var _Recipe = class _Recipe {
           if (!groupsForIng.has(signature)) {
             groupsForIng.set(signature, {
               quantities: [],
-              alternativeQuantities: /* @__PURE__ */ new Map()
+              alternativeQuantities: /* @__PURE__ */ new Map(),
+              alternativeSubgroups: []
             });
           }
           const group = groupsForIng.get(signature);
           group.quantities.push(quantityEntry);
-          for (const ref of alternativeRefs ?? []) {
-            if (!group.alternativeQuantities.has(ref.index)) {
-              group.alternativeQuantities.set(ref.index, []);
-            }
-            for (const altQty of ref.quantities ?? []) {
-              const extended = toExtendedUnit({
-                quantity: altQty.quantity,
-                unit: altQty.unit
-              });
-              if (altQty.equivalents?.length) {
-                const eqEntries = [
-                  extended,
-                  ...altQty.equivalents.map((eq) => toExtendedUnit(eq))
-                ];
-                group.alternativeQuantities.get(ref.index).push({ or: eqEntries });
-              } else {
-                group.alternativeQuantities.get(ref.index).push(extended);
+          if (alternativeRefs && alternativeRefs.length > 0 && group.alternativeSubgroups.length === 0) {
+            group.alternativeSubgroups = alternativeRefs.map(
+              (subgroup) => subgroup.map((ref) => ref.index)
+            );
+          }
+          for (const subgroup of alternativeRefs ?? []) {
+            for (const ref of subgroup) {
+              if (!group.alternativeQuantities.has(ref.index)) {
+                group.alternativeQuantities.set(ref.index, []);
+              }
+              for (const altQty of ref.quantities ?? []) {
+                const extended = toExtendedUnit({
+                  quantity: altQty.quantity,
+                  unit: altQty.unit
+                });
+                if (altQty.equivalents?.length) {
+                  const eqEntries = [
+                    extended,
+                    ...altQty.equivalents.map((eq) => toExtendedUnit(eq))
+                  ];
+                  group.alternativeQuantities.get(ref.index).push({ or: eqEntries });
+                } else {
+                  group.alternativeQuantities.get(ref.index).push(extended);
+                }
               }
             }
           }
@@ -3550,17 +3606,25 @@ var _Recipe = class _Recipe {
               this.unitSystem
             );
             const flattened = flattenPlainUnitGroup(summed);
-            const alternatives = group.alternativeQuantities.size > 0 ? [...group.alternativeQuantities].map(([altIdx, altQtys]) => ({
-              index: altIdx,
-              ...altQtys.length > 0 && {
-                quantities: flattenPlainUnitGroup(
-                  addEquivalentsAndSimplify(altQtys, this.unitSystem)
-                ).flatMap(
-                  /* v8 ignore next -- item.and branch requires complex nested AND-with-equivalents structure */
-                  (item) => "quantity" in item ? [item] : item.and
-                )
-              }
-            })) : void 0;
+            let alternatives;
+            if (group.alternativeSubgroups.length > 0) {
+              alternatives = group.alternativeSubgroups.map(
+                (subgroupIndices) => subgroupIndices.map((altIdx) => {
+                  const altQtys = group.alternativeQuantities.get(altIdx);
+                  return {
+                    index: altIdx,
+                    ...altQtys.length > 0 && {
+                      quantities: flattenPlainUnitGroup(
+                        addEquivalentsAndSimplify(altQtys, this.unitSystem)
+                      ).flatMap(
+                        /* v8 ignore next -- item.and branch requires complex nested AND-with-equivalents structure */
+                        (item) => "quantity" in item ? [item] : item.and
+                      )
+                    }
+                  };
+                })
+              );
+            }
             for (const gq of flattened) {
               if ("and" in gq) {
                 quantityGroups.push({
@@ -5084,6 +5148,7 @@ export {
 // v8 ignore if -- @preserve
 /* v8 ignore else -- expliciting error type -- @preserve */
 /* v8 ignore next 4 -- @preserve: defensive guard; regex always matches */
+/* v8 ignore else -- @preserve: empty non nested block will in practice be detected earlier */
 // v8 ignore if -- @preserve: defensive type guard
 /* v8 ignore if -- @preserve */
 // v8 ignore next -- @preserve