@tmlmt/cooklang-parser 3.0.0-alpha.11 → 3.0.0-alpha.12

package/dist/index.d.cts

@@ -508,31 +508,27 @@ interface Ingredient {
     /** The collection of potential additional metadata for the ingredient */
     extras?: IngredientExtras;
 }
-/**
- * Represents a contributor to an ingredient's total quantity, corresponding
- * to a single mention in the recipe text. It can contain multiple
- * equivalent quantities (e.g., in different units).
- * @category Types
- */
-interface IngredientItemQuantity extends QuantityWithExtendedUnit {
-    /**
-     * A list of equivalent quantities/units for this ingredient mention besides the primary quantity.
-     * For `@salt{1%tsp|5%g}`, the main quantity is 1 tsp and the equivalents will contain 5 g.
-     */
-    equivalents?: QuantityWithExtendedUnit[];
+type MaybeScalableQuantity = QuantityWithExtendedUnit & {
     /** Indicates whether this quantity should be scaled when the recipe serving size changes. */
     scalable: boolean;
-}
+    /** A list of equivalent quantities/units for this ingredient mention besides the primary quantity.
+     * For `@salt{1%tsp|5%g}`, the main quantity is 1 tsp and the equivalents will contain 5 g. */
+    equivalents?: QuantityWithExtendedUnit[];
+};
+type WithOptionalQuantity<T> = (T & MaybeScalableQuantity) | (T & {
+    quantity?: undefined;
+    scalable?: never;
+    unit?: never;
+    equivalents?: never;
+});
 /**
  * Represents a single ingredient choice within a single or a group of `IngredientItem`s. It points
  * to a specific ingredient and its corresponding quantity information.
  * @category Types
  */
-interface IngredientAlternative {
+type IngredientAlternativeBase = {
     /** The index of the ingredient within the {@link Recipe.ingredients} array. */
     index: number;
-    /** The quantity of this specific mention of the ingredient */
-    itemQuantity?: IngredientItemQuantity;
     /** The alias/name of the ingredient as it should be displayed for this occurrence. */
     displayName: string;
     /** An optional note for this specific choice (e.g., "for a vegan version"). */
@@ -541,7 +537,8 @@ interface IngredientAlternative {
      * with group keys: the id of the corresponding ingredient item (e.g. "ingredient-item-2").
      * Can be useful for creating alternative selection UI elements with anchor links */
     itemId?: string;
-}
+};
+type IngredientAlternative = WithOptionalQuantity<IngredientAlternativeBase>;
 /**
  * Represents an ingredient item in a recipe step.
  * @category Types
@@ -1500,7 +1497,7 @@ declare function formatExtendedQuantity(item: QuantityWithExtendedUnit): string;
  * formatItemQuantity(itemQuantity, " / "); // "100 g / 3.5 oz"
  * ```
  */
-declare function formatItemQuantity(itemQuantity: IngredientItemQuantity, separator?: string): string;
+declare function formatItemQuantity(itemQuantity: MaybeScalableQuantity, separator?: string): string;
 /**
  * Check if an ingredient item is a grouped alternative (vs inline alternative).
  *
@@ -1642,4 +1639,4 @@ declare class NoShoppingListForCartError extends Error {
     constructor();
 }
 
-export { type AddedIngredient, type AddedRecipe, type AddedRecipeOptions, type AlternativeIngredientRef, type AndGroup, type ArbitraryScalable, type ArbitraryScalableItem, type CartContent, type CartMatch, type CartMisMatch, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareFlag, type CookwareItem, type DecimalValue, type FixedNumericValue, type FixedValue, type FlatAndGroup, type FlatGroup, type FlatOrGroup, type FractionValue, type GetIngredientQuantitiesOptions, type Group, type Ingredient, type IngredientAlternative, type IngredientExtras, type IngredientFlag, type IngredientItem, type IngredientItemQuantity, type IngredientQuantityAndGroup, type IngredientQuantityGroup, type MaybeNestedAndGroup, type MaybeNestedGroup, type MaybeNestedOrGroup, type Metadata, NoProductCatalogForCartError, type NoProductMatchErrorCode, NoShoppingListForCartError, type Note, type NoteItem, type OrGroup, ProductCatalog, type ProductMatch, type ProductMisMatch, type ProductOption, type ProductOptionBase, type ProductOptionCore, type ProductSelection, type ProductSize, type QuantityBase, type QuantityWithExtendedUnit, type QuantityWithPlainUnit, type QuantityWithUnitDef, type QuantityWithUnitLike, type Range, Recipe, type RecipeAlternatives, type RecipeChoices, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingCart, type ShoppingCartOptions, type ShoppingCartSummary, ShoppingList, type SpecificUnitSystem, type Step, type StepItem, type TextItem, type TextValue, type Timer, type TimerItem, type ToBaseBySystem, type Unit, type UnitDefinition, type UnitDefinitionLike, type UnitSystem, type UnitType, convertQuantityToSystem, formatExtendedQuantity, formatItemQuantity, formatNumericValue, formatQuantity, formatQuantityWithUnit, formatSingleValue, formatUnit, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSimpleGroup, renderFractionAsVulgar };
+export { type AddedIngredient, type AddedRecipe, type AddedRecipeOptions, type AlternativeIngredientRef, type AndGroup, type ArbitraryScalable, type ArbitraryScalableItem, type CartContent, type CartMatch, type CartMisMatch, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareFlag, type CookwareItem, type DecimalValue, type FixedNumericValue, type FixedValue, type FlatAndGroup, type FlatGroup, type FlatOrGroup, type FractionValue, type GetIngredientQuantitiesOptions, type Group, type Ingredient, type IngredientAlternative, type IngredientExtras, type IngredientFlag, type IngredientItem, type IngredientQuantityAndGroup, type IngredientQuantityGroup, type MaybeNestedAndGroup, type MaybeNestedGroup, type MaybeNestedOrGroup, type MaybeScalableQuantity, type Metadata, NoProductCatalogForCartError, type NoProductMatchErrorCode, NoShoppingListForCartError, type Note, type NoteItem, type OrGroup, ProductCatalog, type ProductMatch, type ProductMisMatch, type ProductOption, type ProductOptionBase, type ProductOptionCore, type ProductSelection, type ProductSize, type QuantityBase, type QuantityWithExtendedUnit, type QuantityWithPlainUnit, type QuantityWithUnitDef, type QuantityWithUnitLike, type Range, Recipe, type RecipeAlternatives, type RecipeChoices, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingCart, type ShoppingCartOptions, type ShoppingCartSummary, ShoppingList, type SpecificUnitSystem, type Step, type StepItem, type TextItem, type TextValue, type Timer, type TimerItem, type ToBaseBySystem, type Unit, type UnitDefinition, type UnitDefinitionLike, type UnitSystem, type UnitType, convertQuantityToSystem, formatExtendedQuantity, formatItemQuantity, formatNumericValue, formatQuantity, formatQuantityWithUnit, formatSingleValue, formatUnit, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSimpleGroup, renderFractionAsVulgar };

package/dist/index.d.ts

@@ -508,31 +508,27 @@ interface Ingredient {
     /** The collection of potential additional metadata for the ingredient */
     extras?: IngredientExtras;
 }
-/**
- * Represents a contributor to an ingredient's total quantity, corresponding
- * to a single mention in the recipe text. It can contain multiple
- * equivalent quantities (e.g., in different units).
- * @category Types
- */
-interface IngredientItemQuantity extends QuantityWithExtendedUnit {
-    /**
-     * A list of equivalent quantities/units for this ingredient mention besides the primary quantity.
-     * For `@salt{1%tsp|5%g}`, the main quantity is 1 tsp and the equivalents will contain 5 g.
-     */
-    equivalents?: QuantityWithExtendedUnit[];
+type MaybeScalableQuantity = QuantityWithExtendedUnit & {
     /** Indicates whether this quantity should be scaled when the recipe serving size changes. */
     scalable: boolean;
-}
+    /** A list of equivalent quantities/units for this ingredient mention besides the primary quantity.
+     * For `@salt{1%tsp|5%g}`, the main quantity is 1 tsp and the equivalents will contain 5 g. */
+    equivalents?: QuantityWithExtendedUnit[];
+};
+type WithOptionalQuantity<T> = (T & MaybeScalableQuantity) | (T & {
+    quantity?: undefined;
+    scalable?: never;
+    unit?: never;
+    equivalents?: never;
+});
 /**
  * Represents a single ingredient choice within a single or a group of `IngredientItem`s. It points
  * to a specific ingredient and its corresponding quantity information.
  * @category Types
  */
-interface IngredientAlternative {
+type IngredientAlternativeBase = {
     /** The index of the ingredient within the {@link Recipe.ingredients} array. */
     index: number;
-    /** The quantity of this specific mention of the ingredient */
-    itemQuantity?: IngredientItemQuantity;
     /** The alias/name of the ingredient as it should be displayed for this occurrence. */
     displayName: string;
     /** An optional note for this specific choice (e.g., "for a vegan version"). */
@@ -541,7 +537,8 @@ interface IngredientAlternative {
      * with group keys: the id of the corresponding ingredient item (e.g. "ingredient-item-2").
      * Can be useful for creating alternative selection UI elements with anchor links */
     itemId?: string;
-}
+};
+type IngredientAlternative = WithOptionalQuantity<IngredientAlternativeBase>;
 /**
  * Represents an ingredient item in a recipe step.
  * @category Types
@@ -1500,7 +1497,7 @@ declare function formatExtendedQuantity(item: QuantityWithExtendedUnit): string;
  * formatItemQuantity(itemQuantity, " / "); // "100 g / 3.5 oz"
  * ```
  */
-declare function formatItemQuantity(itemQuantity: IngredientItemQuantity, separator?: string): string;
+declare function formatItemQuantity(itemQuantity: MaybeScalableQuantity, separator?: string): string;
 /**
  * Check if an ingredient item is a grouped alternative (vs inline alternative).
  *
@@ -1642,4 +1639,4 @@ declare class NoShoppingListForCartError extends Error {
     constructor();
 }
 
-export { type AddedIngredient, type AddedRecipe, type AddedRecipeOptions, type AlternativeIngredientRef, type AndGroup, type ArbitraryScalable, type ArbitraryScalableItem, type CartContent, type CartMatch, type CartMisMatch, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareFlag, type CookwareItem, type DecimalValue, type FixedNumericValue, type FixedValue, type FlatAndGroup, type FlatGroup, type FlatOrGroup, type FractionValue, type GetIngredientQuantitiesOptions, type Group, type Ingredient, type IngredientAlternative, type IngredientExtras, type IngredientFlag, type IngredientItem, type IngredientItemQuantity, type IngredientQuantityAndGroup, type IngredientQuantityGroup, type MaybeNestedAndGroup, type MaybeNestedGroup, type MaybeNestedOrGroup, type Metadata, NoProductCatalogForCartError, type NoProductMatchErrorCode, NoShoppingListForCartError, type Note, type NoteItem, type OrGroup, ProductCatalog, type ProductMatch, type ProductMisMatch, type ProductOption, type ProductOptionBase, type ProductOptionCore, type ProductSelection, type ProductSize, type QuantityBase, type QuantityWithExtendedUnit, type QuantityWithPlainUnit, type QuantityWithUnitDef, type QuantityWithUnitLike, type Range, Recipe, type RecipeAlternatives, type RecipeChoices, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingCart, type ShoppingCartOptions, type ShoppingCartSummary, ShoppingList, type SpecificUnitSystem, type Step, type StepItem, type TextItem, type TextValue, type Timer, type TimerItem, type ToBaseBySystem, type Unit, type UnitDefinition, type UnitDefinitionLike, type UnitSystem, type UnitType, convertQuantityToSystem, formatExtendedQuantity, formatItemQuantity, formatNumericValue, formatQuantity, formatQuantityWithUnit, formatSingleValue, formatUnit, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSimpleGroup, renderFractionAsVulgar };
+export { type AddedIngredient, type AddedRecipe, type AddedRecipeOptions, type AlternativeIngredientRef, type AndGroup, type ArbitraryScalable, type ArbitraryScalableItem, type CartContent, type CartMatch, type CartMisMatch, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareFlag, type CookwareItem, type DecimalValue, type FixedNumericValue, type FixedValue, type FlatAndGroup, type FlatGroup, type FlatOrGroup, type FractionValue, type GetIngredientQuantitiesOptions, type Group, type Ingredient, type IngredientAlternative, type IngredientExtras, type IngredientFlag, type IngredientItem, type IngredientQuantityAndGroup, type IngredientQuantityGroup, type MaybeNestedAndGroup, type MaybeNestedGroup, type MaybeNestedOrGroup, type MaybeScalableQuantity, type Metadata, NoProductCatalogForCartError, type NoProductMatchErrorCode, NoShoppingListForCartError, type Note, type NoteItem, type OrGroup, ProductCatalog, type ProductMatch, type ProductMisMatch, type ProductOption, type ProductOptionBase, type ProductOptionCore, type ProductSelection, type ProductSize, type QuantityBase, type QuantityWithExtendedUnit, type QuantityWithPlainUnit, type QuantityWithUnitDef, type QuantityWithUnitLike, type Range, Recipe, type RecipeAlternatives, type RecipeChoices, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingCart, type ShoppingCartOptions, type ShoppingCartSummary, ShoppingList, type SpecificUnitSystem, type Step, type StepItem, type TextItem, type TextValue, type Timer, type TimerItem, type ToBaseBySystem, type Unit, type UnitDefinition, type UnitDefinitionLike, type UnitSystem, type UnitType, convertQuantityToSystem, formatExtendedQuantity, formatItemQuantity, formatNumericValue, formatQuantity, formatQuantityWithUnit, formatSingleValue, formatUnit, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSimpleGroup, renderFractionAsVulgar };

package/dist/index.js

@@ -2235,7 +2235,7 @@ var _Recipe = class _Recipe {
         alternative.note = note;
       }
       if (itemQuantity) {
-        alternative.itemQuantity = itemQuantity;
+        Object.assign(alternative, itemQuantity);
       }
       alternatives.push(alternative);
       testString = groups.ingredientAlternative || "";
@@ -2343,7 +2343,7 @@ var _Recipe = class _Recipe {
       displayName
     };
     if (itemQuantity) {
-      alternative.itemQuantity = itemQuantity;
+      Object.assign(alternative, itemQuantity);
     }
     const existingAlternatives = this.choices.ingredientGroups.get(groupKey);
     function upsertAlternativeToIngredient(ingredients, ingredientIdx, newAlternativeIdx) {
@@ -2479,28 +2479,28 @@ var _Recipe = class _Recipe {
           for (const alt of allAlts) {
             referencedIndices.add(alt.index);
           }
-          if (!alternative.itemQuantity) continue;
+          if (!alternative.quantity) continue;
           const baseQty = {
-            quantity: alternative.itemQuantity.quantity,
-            ...alternative.itemQuantity.unit && {
-              unit: alternative.itemQuantity.unit
+            quantity: alternative.quantity,
+            ...alternative.unit && {
+              unit: alternative.unit
             }
           };
-          const quantityEntry = alternative.itemQuantity.equivalents?.length ? { or: [baseQty, ...alternative.itemQuantity.equivalents] } : baseQty;
+          const quantityEntry = alternative.equivalents?.length ? { or: [baseQty, ...alternative.equivalents] } : baseQty;
           let alternativeRefs;
           if (!hasExplicitChoice && allAlts.length > 1) {
             alternativeRefs = allAlts.filter(
               (alt) => isGrouped ? alt.itemId !== item.id : alt.index !== alternative.index
             ).map((otherAlt) => {
               const ref = { index: otherAlt.index };
-              if (otherAlt.itemQuantity) {
+              if (otherAlt.quantity) {
                 const altQty = {
-                  quantity: otherAlt.itemQuantity.quantity,
-                  ...otherAlt.itemQuantity.unit && {
-                    unit: otherAlt.itemQuantity.unit.name
+                  quantity: otherAlt.quantity,
+                  ...otherAlt.unit && {
+                    unit: otherAlt.unit.name
                   },
-                  ...otherAlt.itemQuantity.equivalents && {
-                    equivalents: otherAlt.itemQuantity.equivalents.map(
+                  ...otherAlt.equivalents && {
+                    equivalents: otherAlt.equivalents.map(
                       (eq) => toPlainUnit(eq)
                     )
                   }
@@ -2513,14 +2513,10 @@ var _Recipe = class _Recipe {
           const altIndices = getAlternativeSignature(alternativeRefs) ?? "";
           let signature;
           if (isGrouped) {
-            const resolvedUnit = resolveUnit(
-              alternative.itemQuantity.unit?.name
-            );
+            const resolvedUnit = resolveUnit(alternative.unit?.name);
             signature = `group:${item.group}|${altIndices}|${resolvedUnit.type}`;
           } else if (altIndices) {
-            const resolvedUnit = resolveUnit(
-              alternative.itemQuantity.unit?.name
-            );
+            const resolvedUnit = resolveUnit(alternative.unit?.name);
             signature = `${altIndices}|${resolvedUnit.type}}`;
           } else {
             signature = null;
@@ -2788,16 +2784,16 @@ var _Recipe = class _Recipe {
     const unitSystem = this.unitSystem;
     function scaleAlternativesBy(alternatives, factor2) {
       for (const alternative of alternatives) {
-        if (alternative.itemQuantity) {
-          const scaleFactor = alternative.itemQuantity.scalable ? Big4(factor2) : 1;
-          if (alternative.itemQuantity.quantity.type !== "fixed" || alternative.itemQuantity.quantity.value.type !== "text") {
-            alternative.itemQuantity.quantity = multiplyQuantityValue(
-              alternative.itemQuantity.quantity,
+        if (alternative.quantity) {
+          const scaleFactor = alternative.scalable ? Big4(factor2) : 1;
+          if (alternative.quantity.type !== "fixed" || alternative.quantity.value.type !== "text") {
+            alternative.quantity = multiplyQuantityValue(
+              alternative.quantity,
               scaleFactor
             );
           }
-          if (alternative.itemQuantity.equivalents) {
-            alternative.itemQuantity.equivalents = alternative.itemQuantity.equivalents.map(
+          if (alternative.equivalents) {
+            alternative.equivalents = alternative.equivalents.map(
               (altQuantity) => {
                 if (altQuantity.quantity.type === "fixed" && altQuantity.quantity.value.type === "text") {
                   return altQuantity;
@@ -2815,15 +2811,15 @@ var _Recipe = class _Recipe {
           }
           const optimizedPrimary = applyBestUnit(
             {
-              quantity: alternative.itemQuantity.quantity,
-              unit: alternative.itemQuantity.unit
+              quantity: alternative.quantity,
+              unit: alternative.unit
             },
             unitSystem
           );
-          alternative.itemQuantity.quantity = optimizedPrimary.quantity;
-          alternative.itemQuantity.unit = optimizedPrimary.unit;
-          if (alternative.itemQuantity.equivalents) {
-            alternative.itemQuantity.equivalents = alternative.itemQuantity.equivalents.map(
+          alternative.quantity = optimizedPrimary.quantity;
+          alternative.unit = optimizedPrimary.unit;
+          if (alternative.equivalents) {
+            alternative.equivalents = alternative.equivalents.map(
               (eq) => applyBestUnit(eq, unitSystem)
             );
           }
@@ -2927,18 +2923,27 @@ var _Recipe = class _Recipe {
       }
       return newPrimary;
     }
-    function convertItemQuantity(itemQuantity) {
-      const primaryUnit = resolveUnit(itemQuantity.unit?.name);
-      const equivalents = itemQuantity.equivalents ?? [];
+    function convertAlternativeQuantity(alternative) {
+      const primaryUnit = resolveUnit(alternative.unit?.name);
+      const equivalents = alternative.equivalents ?? [];
       const oldPrimary = {
-        quantity: itemQuantity.quantity,
-        unit: itemQuantity.unit
+        quantity: alternative.quantity,
+        unit: alternative.unit
       };
       if (primaryUnit.type !== "other" && isUnitCompatibleWithSystem(primaryUnit, system)) {
         if (method === "remove") {
-          return { ...itemQuantity, equivalents: void 0 };
+          return {
+            quantity: alternative.quantity,
+            unit: alternative.unit,
+            scalable: alternative.scalable
+          };
         }
-        return itemQuantity;
+        return {
+          quantity: alternative.quantity,
+          unit: alternative.unit,
+          scalable: alternative.scalable,
+          equivalents
+        };
       }
       const targetEquivIndex = equivalents.findIndex((eq) => {
         const eqUnit = resolveUnit(eq.unit?.name);
@@ -2953,7 +2958,7 @@ var _Recipe = class _Recipe {
           targetEquiv,
           oldPrimary,
           remainingEquivalents,
-          itemQuantity.scalable,
+          alternative.scalable,
           targetEquiv.unit?.integerProtected,
           "swapped"
         );
@@ -2964,8 +2969,8 @@ var _Recipe = class _Recipe {
           converted,
           oldPrimary,
           equivalents,
-          itemQuantity.scalable,
-          itemQuantity.unit?.integerProtected,
+          alternative.scalable,
+          alternative.unit?.integerProtected,
           "swapped"
         );
       }
@@ -2978,24 +2983,37 @@ var _Recipe = class _Recipe {
             convertedEquiv,
             oldPrimary,
             remainingEquivalents,
-            itemQuantity.scalable,
+            alternative.scalable,
             equiv.unit?.integerProtected,
             "converted"
           );
         }
       }
       if (method === "remove") {
-        return { ...itemQuantity, equivalents: void 0 };
+        return {
+          quantity: alternative.quantity,
+          unit: alternative.unit,
+          scalable: alternative.scalable
+        };
       } else {
-        return itemQuantity;
+        return {
+          quantity: alternative.quantity,
+          unit: alternative.unit,
+          scalable: alternative.scalable,
+          equivalents
+        };
       }
     }
     function convertAlternatives(alternatives) {
       for (const alternative of alternatives) {
-        if (alternative.itemQuantity) {
-          alternative.itemQuantity = convertItemQuantity(
-            alternative.itemQuantity
+        if (alternative.quantity) {
+          const converted = convertAlternativeQuantity(
+            alternative
           );
+          alternative.quantity = converted.quantity;
+          alternative.unit = converted.unit;
+          alternative.scalable = converted.scalable;
+          alternative.equivalents = converted.equivalents;
         }
       }
     }