@tmlmt/cooklang-parser 2.0.2 → 2.1.0

package/dist/index.d.cts

@@ -452,15 +452,30 @@ interface CategorizedIngredients {
     [category: string]: Ingredient[];
 }
 /**
- * Represents a recipe that has been added to a shopping list.
+ * Represents a recipe together with a scaling factor
  * @category Types
  */
-interface AddedRecipe {
+interface RecipeWithFactor {
     /** The recipe that was added. */
     recipe: Recipe;
-    /** The factor the recipe was scaled by. */
+    /** The factor the recipe is scaled by. */
     factor: number;
 }
+/**
+ * Represents a recipe together with a servings value for scaling
+ * @category Types
+ */
+interface RecipeWithServings {
+    /** The recipe that was added. */
+    recipe: Recipe;
+    /** The servings the recipe is scaled to */
+    servings: number;
+}
+/**
+ * Represents a recipe that has been added to a shopping list.
+ * @category Types
+ */
+type AddedRecipe = RecipeWithFactor | RecipeWithServings;
 /**
  * Represents an ingredient in a category.
  * @category Types
@@ -580,11 +595,23 @@ declare class ShoppingList {
      */
     constructor(category_config_str?: string | CategoryConfig);
     private calculate_ingredients;
+    /**
+     * Adds a recipe to the shopping list, then automatically
+     * recalculates the quantities and recategorize the ingredients.
+     * @param recipe - The recipe to add.
+     * @param scaling - The scaling option for the recipe. Can be either a factor or a number of servings
+     */
+    add_recipe(recipe: Recipe, scaling?: {
+        factor: number;
+    } | {
+        servings: number;
+    }): void;
     /**
      * Adds a recipe to the shopping list, then automatically
      * recalculates the quantities and recategorize the ingredients.
      * @param recipe - The recipe to add.
      * @param factor - The factor to scale the recipe by.
+     * @deprecated since v2.0.3. Use the other call signature with `scaling` instead. Will be removed in v3
      */
     add_recipe(recipe: Recipe, factor?: number): void;
     /**
@@ -606,4 +633,4 @@ declare class ShoppingList {
     categorize(): void;
 }
 
-export { type AddedRecipe, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareFlag, type CookwareItem, type DecimalValue, type FixedValue, type FractionValue, type Ingredient, type IngredientExtras, type IngredientFlag, type IngredientItem, type Item, type Metadata, type Note, type QuantityPart, type Range, Recipe, Section, ShoppingList, type Step, type TextItem, type TextValue, type Timer, type TimerItem };
+export { type AddedRecipe, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareFlag, type CookwareItem, type DecimalValue, type FixedValue, type FractionValue, type Ingredient, type IngredientExtras, type IngredientFlag, type IngredientItem, type Item, type Metadata, type Note, type QuantityPart, type Range, Recipe, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingList, type Step, type TextItem, type TextValue, type Timer, type TimerItem };

package/dist/index.d.ts

@@ -452,15 +452,30 @@ interface CategorizedIngredients {
     [category: string]: Ingredient[];
 }
 /**
- * Represents a recipe that has been added to a shopping list.
+ * Represents a recipe together with a scaling factor
  * @category Types
  */
-interface AddedRecipe {
+interface RecipeWithFactor {
     /** The recipe that was added. */
     recipe: Recipe;
-    /** The factor the recipe was scaled by. */
+    /** The factor the recipe is scaled by. */
     factor: number;
 }
+/**
+ * Represents a recipe together with a servings value for scaling
+ * @category Types
+ */
+interface RecipeWithServings {
+    /** The recipe that was added. */
+    recipe: Recipe;
+    /** The servings the recipe is scaled to */
+    servings: number;
+}
+/**
+ * Represents a recipe that has been added to a shopping list.
+ * @category Types
+ */
+type AddedRecipe = RecipeWithFactor | RecipeWithServings;
 /**
  * Represents an ingredient in a category.
  * @category Types
@@ -580,11 +595,23 @@ declare class ShoppingList {
      */
     constructor(category_config_str?: string | CategoryConfig);
     private calculate_ingredients;
+    /**
+     * Adds a recipe to the shopping list, then automatically
+     * recalculates the quantities and recategorize the ingredients.
+     * @param recipe - The recipe to add.
+     * @param scaling - The scaling option for the recipe. Can be either a factor or a number of servings
+     */
+    add_recipe(recipe: Recipe, scaling?: {
+        factor: number;
+    } | {
+        servings: number;
+    }): void;
     /**
      * Adds a recipe to the shopping list, then automatically
      * recalculates the quantities and recategorize the ingredients.
      * @param recipe - The recipe to add.
      * @param factor - The factor to scale the recipe by.
+     * @deprecated since v2.0.3. Use the other call signature with `scaling` instead. Will be removed in v3
      */
     add_recipe(recipe: Recipe, factor?: number): void;
     /**
@@ -606,4 +633,4 @@ declare class ShoppingList {
     categorize(): void;
 }
 
-export { type AddedRecipe, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareFlag, type CookwareItem, type DecimalValue, type FixedValue, type FractionValue, type Ingredient, type IngredientExtras, type IngredientFlag, type IngredientItem, type Item, type Metadata, type Note, type QuantityPart, type Range, Recipe, Section, ShoppingList, type Step, type TextItem, type TextValue, type Timer, type TimerItem };
+export { type AddedRecipe, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareFlag, type CookwareItem, type DecimalValue, type FixedValue, type FractionValue, type Ingredient, type IngredientExtras, type IngredientFlag, type IngredientItem, type Item, type Metadata, type Note, type QuantityPart, type Range, Recipe, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingList, type Step, type TextItem, type TextValue, type Timer, type TimerItem };

package/dist/index.js

@@ -1216,8 +1216,14 @@ var ShoppingList = class {
   }
   calculate_ingredients() {
     this.ingredients = [];
-    for (const { recipe, factor } of this.recipes) {
-      const scaledRecipe = factor === 1 ? recipe : recipe.scaleBy(factor);
+    for (const addedRecipe of this.recipes) {
+      let scaledRecipe;
+      if ("factor" in addedRecipe) {
+        const { recipe, factor } = addedRecipe;
+        scaledRecipe = factor === 1 ? recipe : recipe.scaleBy(factor);
+      } else {
+        scaledRecipe = addedRecipe.recipe.scaleTo(addedRecipe.servings);
+      }
       for (const ingredient of scaledRecipe.ingredients) {
         if (ingredient.flags && ingredient.flags.includes("hidden")) {
           continue;
@@ -1266,14 +1272,16 @@ var ShoppingList = class {
       }
     }
   }
-  /**
-   * Adds a recipe to the shopping list, then automatically
-   * recalculates the quantities and recategorize the ingredients.
-   * @param recipe - The recipe to add.
-   * @param factor - The factor to scale the recipe by.
-   */
-  add_recipe(recipe, factor = 1) {
-    this.recipes.push({ recipe, factor });
+  add_recipe(recipe, scaling) {
+    if (typeof scaling === "number" || scaling === void 0) {
+      this.recipes.push({ recipe, factor: scaling ?? 1 });
+    } else {
+      if ("factor" in scaling) {
+        this.recipes.push({ recipe, factor: scaling.factor });
+      } else {
+        this.recipes.push({ recipe, servings: scaling.servings });
+      }
+    }
     this.calculate_ingredients();
     this.categorize();
   }