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

package/dist/index.d.cts

@@ -154,7 +154,7 @@ declare class Recipe {
      * Quantities are grouped by their alternative signature and summed using addEquivalentsAndSimplify.
      * @internal
      */
-    private _populate_ingredient_quantities;
+    private _populateIngredientQuantities;
     /**
      * Gets ingredients with their quantities populated, optionally filtered by section/step
      * and respecting user choices for alternatives.
@@ -237,6 +237,42 @@ declare class Recipe {
     clone(): Recipe;
 }
 
+/**
+ * Represents source attribution information for a recipe.
+ * @category Types
+ */
+interface MetadataSource {
+    /** The name of the source (e.g., "New York Times Cooking"). */
+    name?: string;
+    /** The URL of the source recipe. */
+    url?: string;
+    /** The author at the source. */
+    author?: string;
+}
+/**
+ * Represents time information for a recipe.
+ * @category Types
+ */
+interface MetadataTime {
+    /** The preparation time (not parsed into DateTime format). */
+    prep?: string;
+    /** The cooking time (not parsed into DateTime format). */
+    cook?: string;
+    /** The total time required (not parsed into DateTime format). */
+    total?: string;
+}
+/**
+ * Represents a nested metadata object with arbitrary keys.
+ * @category Types
+ */
+interface MetadataObject {
+    [key: string]: MetadataValue;
+}
+/**
+ * Represents any value that can appear in recipe metadata.
+ * @category Types
+ */
+type MetadataValue = string | number | (string | number)[] | MetadataObject | MetadataSource | MetadataTime | undefined;
 /**
  * Represents the metadata of a recipe.
  * @category Types
@@ -246,15 +282,12 @@ interface Metadata {
     title?: string;
     /** The tags of the recipe. */
     tags?: string[];
-    /** The source of the recipe. */
-    source?: string;
-    /** The source name of the recipe. */
-    "source.name"?: string;
-    /** The source url of the recipe. */
-    "source.url"?: string;
-    /** The source author of the recipe. */
-    "source.author"?: string;
-    /** The author of the recipe. */
+    /**
+     * The source of the recipe. Can be a simple URL string or structured attribution.
+     * When parsed from YAML, `source.name`, `source.url`, `source.author` keys are merged here.
+     */
+    source?: string | MetadataSource;
+    /** The author of the recipe (separate from source author). */
     author?: string;
     /** The number of servings the recipe makes.
      * Should be either a number or a string which starts with a number
@@ -305,30 +338,11 @@ interface Metadata {
     /** The locale of the recipe. */
     locale?: string;
     /**
-     *  The preparation time of the recipe.
-     *  Will not be further parsed into any DateTime format nor normalize
-     */
-    "prep time"?: string;
-    /**
-     *  Alias of `prep time`
+     * Time information for the recipe.
+     * When parsed from YAML, `prep time`, `time.prep`, `cook time`, `time.cook`,
+     * `time required`, `time`, `duration` keys are merged here.
      */
-    "time.prep"?: string;
-    /**
-     *  The cooking time of the recipe.
-     *  Will not be further parsed into any DateTime format nor normalize
-     */
-    "cook time"?: string;
-    /**
-     *  Alias of `cook time`
-     */
-    "time.cook"?: string;
-    /**
-     *  The total time of the recipe.
-     *  Will not be further parsed into any DateTime format nor normalize
-     */
-    "time required"?: string;
-    time?: string;
-    duration?: string;
+    time?: MetadataTime;
     /** The difficulty of the recipe. */
     difficulty?: string;
     /** The cuisine of the recipe. */
@@ -337,14 +351,10 @@ interface Metadata {
     diet?: string;
     /** The description of the recipe. */
     description?: string;
-    /** The images of the recipe. Alias of `pictures` */
+    /** The images of the recipe. */
     images?: string[];
-    /** The images of the recipe. Alias of `images` */
-    pictures?: string[];
-    /** The picture of the recipe. Alias of `picture` */
+    /** The primary image of the recipe. */
     image?: string;
-    /** The picture of the recipe. Alias of `image` */
-    picture?: string;
     /** The introduction of the recipe. */
     introduction?: string;
     /**
@@ -352,7 +362,12 @@ interface Metadata {
      * See [Unit Conversion Guide](/guide-unit-conversion) for more information.
      * This stores the original value as written by the user.
      */
-    "unit system"?: string;
+    unitSystem?: string;
+    /**
+     * Index signature for additional metadata fields not explicitly typed.
+     * Any metadata key in the frontmatter will be captured here.
+     */
+    [key: string]: MetadataValue;
 }
 /**
  * Represents a quantity described by text, e.g. "a pinch"
@@ -508,31 +523,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 +552,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
@@ -1160,7 +1172,7 @@ declare class ProductCatalog {
  * ## Usage
  *
  * - Create a new ShoppingList instance with an optional category configuration (see {@link ShoppingList."constructor" | constructor})
- * - Add recipes, scaling them as needed (see {@link ShoppingList.add_recipe | add_recipe()})
+ * - Add recipes, scaling them as needed (see {@link ShoppingList.addRecipe | addRecipe()})
  * - Categorize the ingredients (see {@link ShoppingList.categorize | categorize()})
  *
  * @example
@@ -1172,10 +1184,10 @@ declare class ProductCatalog {
  * const categoryConfig = fs.readFileSync("./myconfig.txt", "utf-8")
  * const recipe1 = new Recipe(fs.readFileSync("./myrecipe.cook", "utf-8"));
  * const shoppingList = new ShoppingList();
- * shoppingList.set_category_config(categoryConfig);
+ * shoppingList.setCategoryConfig(categoryConfig);
  * // Quantities are automatically calculated and ingredients categorized
  * // when adding a recipe
- * shoppingList.add_recipe(recipe1);
+ * shoppingList.addRecipe(recipe1);
  * ```
  *
  * @category Classes
@@ -1192,17 +1204,17 @@ declare class ShoppingList {
     /**
      * The category configuration for the shopping list.
      */
-    category_config?: CategoryConfig;
+    categoryConfig?: CategoryConfig;
     /**
      * The categorized ingredients in the shopping list.
      */
     categories?: CategorizedIngredients;
     /**
      * Creates a new ShoppingList instance
-     * @param category_config_str - The category configuration to parse.
+     * @param categoryConfigStr - The category configuration to parse.
      */
-    constructor(category_config_str?: string | CategoryConfig);
-    private calculate_ingredients;
+    constructor(categoryConfigStr?: string | CategoryConfig);
+    private calculateIngredients;
     /**
      * Adds a recipe to the shopping list, then automatically
      * recalculates the quantities and recategorize the ingredients.
@@ -1210,7 +1222,7 @@ declare class ShoppingList {
      * @param options - Options for adding the recipe.
      * @throws Error if the recipe has alternatives without corresponding choices.
      */
-    add_recipe(recipe: Recipe, options?: AddedRecipeOptions): void;
+    addRecipe(recipe: Recipe, options?: AddedRecipeOptions): void;
     /**
      * Checks if a recipe has unresolved alternatives (alternatives without provided choices).
      * @param recipe - The recipe to check.
@@ -1220,16 +1232,16 @@ declare class ShoppingList {
     private getUnresolvedAlternativesError;
     /**
      * Removes a recipe from the shopping list, then automatically
-     * recalculates the quantities and recategorize the ingredients.s
+     * recalculates the quantities and recategorize the ingredients.
      * @param index - The index of the recipe to remove.
      */
-    remove_recipe(index: number): void;
+    removeRecipe(index: number): void;
     /**
      * Sets the category configuration for the shopping list
      * and automatically categorize current ingredients from the list.
      * @param config - The category configuration to parse.
      */
-    set_category_config(config: string | CategoryConfig): void;
+    setCategoryConfig(config: string | CategoryConfig): void;
     /**
      * Categorizes the ingredients in the shopping list
      * Will use the category config if any, otherwise all ingredients will be placed in the "other" category
@@ -1272,7 +1284,7 @@ interface ShoppingCartSummary {
  * ```ts
  * const shoppingList = new ShoppingList();
  * const recipe = new Recipe("@flour{600%g}");
- * shoppingList.add_recipe(recipe);
+ * shoppingList.addRecipe(recipe);
  *
  * const catalog = new ProductCatalog();
  * catalog.products = [
@@ -1500,7 +1512,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 +1654,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, type MetadataObject, type MetadataSource, type MetadataTime, type MetadataValue, 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

@@ -154,7 +154,7 @@ declare class Recipe {
      * Quantities are grouped by their alternative signature and summed using addEquivalentsAndSimplify.
      * @internal
      */
-    private _populate_ingredient_quantities;
+    private _populateIngredientQuantities;
     /**
      * Gets ingredients with their quantities populated, optionally filtered by section/step
      * and respecting user choices for alternatives.
@@ -237,6 +237,42 @@ declare class Recipe {
     clone(): Recipe;
 }
 
+/**
+ * Represents source attribution information for a recipe.
+ * @category Types
+ */
+interface MetadataSource {
+    /** The name of the source (e.g., "New York Times Cooking"). */
+    name?: string;
+    /** The URL of the source recipe. */
+    url?: string;
+    /** The author at the source. */
+    author?: string;
+}
+/**
+ * Represents time information for a recipe.
+ * @category Types
+ */
+interface MetadataTime {
+    /** The preparation time (not parsed into DateTime format). */
+    prep?: string;
+    /** The cooking time (not parsed into DateTime format). */
+    cook?: string;
+    /** The total time required (not parsed into DateTime format). */
+    total?: string;
+}
+/**
+ * Represents a nested metadata object with arbitrary keys.
+ * @category Types
+ */
+interface MetadataObject {
+    [key: string]: MetadataValue;
+}
+/**
+ * Represents any value that can appear in recipe metadata.
+ * @category Types
+ */
+type MetadataValue = string | number | (string | number)[] | MetadataObject | MetadataSource | MetadataTime | undefined;
 /**
  * Represents the metadata of a recipe.
  * @category Types
@@ -246,15 +282,12 @@ interface Metadata {
     title?: string;
     /** The tags of the recipe. */
     tags?: string[];
-    /** The source of the recipe. */
-    source?: string;
-    /** The source name of the recipe. */
-    "source.name"?: string;
-    /** The source url of the recipe. */
-    "source.url"?: string;
-    /** The source author of the recipe. */
-    "source.author"?: string;
-    /** The author of the recipe. */
+    /**
+     * The source of the recipe. Can be a simple URL string or structured attribution.
+     * When parsed from YAML, `source.name`, `source.url`, `source.author` keys are merged here.
+     */
+    source?: string | MetadataSource;
+    /** The author of the recipe (separate from source author). */
     author?: string;
     /** The number of servings the recipe makes.
      * Should be either a number or a string which starts with a number
@@ -305,30 +338,11 @@ interface Metadata {
     /** The locale of the recipe. */
     locale?: string;
     /**
-     *  The preparation time of the recipe.
-     *  Will not be further parsed into any DateTime format nor normalize
-     */
-    "prep time"?: string;
-    /**
-     *  Alias of `prep time`
+     * Time information for the recipe.
+     * When parsed from YAML, `prep time`, `time.prep`, `cook time`, `time.cook`,
+     * `time required`, `time`, `duration` keys are merged here.
      */
-    "time.prep"?: string;
-    /**
-     *  The cooking time of the recipe.
-     *  Will not be further parsed into any DateTime format nor normalize
-     */
-    "cook time"?: string;
-    /**
-     *  Alias of `cook time`
-     */
-    "time.cook"?: string;
-    /**
-     *  The total time of the recipe.
-     *  Will not be further parsed into any DateTime format nor normalize
-     */
-    "time required"?: string;
-    time?: string;
-    duration?: string;
+    time?: MetadataTime;
     /** The difficulty of the recipe. */
     difficulty?: string;
     /** The cuisine of the recipe. */
@@ -337,14 +351,10 @@ interface Metadata {
     diet?: string;
     /** The description of the recipe. */
     description?: string;
-    /** The images of the recipe. Alias of `pictures` */
+    /** The images of the recipe. */
     images?: string[];
-    /** The images of the recipe. Alias of `images` */
-    pictures?: string[];
-    /** The picture of the recipe. Alias of `picture` */
+    /** The primary image of the recipe. */
     image?: string;
-    /** The picture of the recipe. Alias of `image` */
-    picture?: string;
     /** The introduction of the recipe. */
     introduction?: string;
     /**
@@ -352,7 +362,12 @@ interface Metadata {
      * See [Unit Conversion Guide](/guide-unit-conversion) for more information.
      * This stores the original value as written by the user.
      */
-    "unit system"?: string;
+    unitSystem?: string;
+    /**
+     * Index signature for additional metadata fields not explicitly typed.
+     * Any metadata key in the frontmatter will be captured here.
+     */
+    [key: string]: MetadataValue;
 }
 /**
  * Represents a quantity described by text, e.g. "a pinch"
@@ -508,31 +523,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 +552,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
@@ -1160,7 +1172,7 @@ declare class ProductCatalog {
  * ## Usage
  *
  * - Create a new ShoppingList instance with an optional category configuration (see {@link ShoppingList."constructor" | constructor})
- * - Add recipes, scaling them as needed (see {@link ShoppingList.add_recipe | add_recipe()})
+ * - Add recipes, scaling them as needed (see {@link ShoppingList.addRecipe | addRecipe()})
  * - Categorize the ingredients (see {@link ShoppingList.categorize | categorize()})
  *
  * @example
@@ -1172,10 +1184,10 @@ declare class ProductCatalog {
  * const categoryConfig = fs.readFileSync("./myconfig.txt", "utf-8")
  * const recipe1 = new Recipe(fs.readFileSync("./myrecipe.cook", "utf-8"));
  * const shoppingList = new ShoppingList();
- * shoppingList.set_category_config(categoryConfig);
+ * shoppingList.setCategoryConfig(categoryConfig);
  * // Quantities are automatically calculated and ingredients categorized
  * // when adding a recipe
- * shoppingList.add_recipe(recipe1);
+ * shoppingList.addRecipe(recipe1);
  * ```
  *
  * @category Classes
@@ -1192,17 +1204,17 @@ declare class ShoppingList {
     /**
      * The category configuration for the shopping list.
      */
-    category_config?: CategoryConfig;
+    categoryConfig?: CategoryConfig;
     /**
      * The categorized ingredients in the shopping list.
      */
     categories?: CategorizedIngredients;
     /**
      * Creates a new ShoppingList instance
-     * @param category_config_str - The category configuration to parse.
+     * @param categoryConfigStr - The category configuration to parse.
      */
-    constructor(category_config_str?: string | CategoryConfig);
-    private calculate_ingredients;
+    constructor(categoryConfigStr?: string | CategoryConfig);
+    private calculateIngredients;
     /**
      * Adds a recipe to the shopping list, then automatically
      * recalculates the quantities and recategorize the ingredients.
@@ -1210,7 +1222,7 @@ declare class ShoppingList {
      * @param options - Options for adding the recipe.
      * @throws Error if the recipe has alternatives without corresponding choices.
      */
-    add_recipe(recipe: Recipe, options?: AddedRecipeOptions): void;
+    addRecipe(recipe: Recipe, options?: AddedRecipeOptions): void;
     /**
      * Checks if a recipe has unresolved alternatives (alternatives without provided choices).
      * @param recipe - The recipe to check.
@@ -1220,16 +1232,16 @@ declare class ShoppingList {
     private getUnresolvedAlternativesError;
     /**
      * Removes a recipe from the shopping list, then automatically
-     * recalculates the quantities and recategorize the ingredients.s
+     * recalculates the quantities and recategorize the ingredients.
      * @param index - The index of the recipe to remove.
      */
-    remove_recipe(index: number): void;
+    removeRecipe(index: number): void;
     /**
      * Sets the category configuration for the shopping list
      * and automatically categorize current ingredients from the list.
      * @param config - The category configuration to parse.
      */
-    set_category_config(config: string | CategoryConfig): void;
+    setCategoryConfig(config: string | CategoryConfig): void;
     /**
      * Categorizes the ingredients in the shopping list
      * Will use the category config if any, otherwise all ingredients will be placed in the "other" category
@@ -1272,7 +1284,7 @@ interface ShoppingCartSummary {
  * ```ts
  * const shoppingList = new ShoppingList();
  * const recipe = new Recipe("@flour{600%g}");
- * shoppingList.add_recipe(recipe);
+ * shoppingList.addRecipe(recipe);
  *
  * const catalog = new ProductCatalog();
  * catalog.products = [
@@ -1500,7 +1512,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 +1654,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, type MetadataObject, type MetadataSource, type MetadataTime, type MetadataValue, 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 };