@tmlmt/cooklang-parser 3.0.0-alpha.19 → 3.0.0-alpha.20

package/dist/index.d.cts

@@ -299,16 +299,17 @@ interface MetadataSource {
     author?: string;
 }
 /**
- * Represents scaling variable information for a recipe.
+ * Represents a yield metadata value for a recipe.
+ * Supports plain quantities (e.g. `yield: 300%g`), complex format with
+ * surrounding text (e.g. `yield: about {{300%g}} of bread`), or simple
+ * numbers (e.g. `yield: 2`).
  * @category Types
  */
-interface MetadataScalingVar extends QuantityWithPlainUnit {
-    /** The text before the scaling variable. */
+interface Yield extends QuantityWithPlainUnit {
+    /** The text before the scaling variable (complex `{{}}` format). */
     textBefore?: string;
-    /** The text after the scaling variable. */
+    /** The text after the scaling variable (complex `{{}}` format). */
     textAfter?: string;
-    /** The text precising a numerical scaling variable. */
-    text?: string;
 }
 /**
  * Represents time information for a recipe.
@@ -333,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 | MetadataScalingVar | undefined;
+type MetadataValue = string | number | (string | number)[] | MetadataObject | MetadataSource | MetadataTime | Yield | undefined;
 /**
  * Represents the metadata of a recipe.
  * @category Types
@@ -351,55 +352,54 @@ interface Metadata {
     /** The author of the recipe (separate from source author). */
     author?: string;
     /** The number of servings the recipe makes.
-     * Can be given either as:
-     * - a number
-     * - a string which starts with a number (which will be used for scaling) followed by a comma and then whatever you want
-     * - or an arbitrary scalable number, optionally preceded and/or followed by text.
+     * Stored as a number when the value is numeric, or as a string when non-numeric
+     * (e.g. `servings: two`). Non-numeric values default the internal scaling baseline to 1.
      *
-     * Interchangeable with `yield` or `serves`. If multiple ones are defined,
-     * the prevailance order for the number which will used for scaling
-     * is `servings` \> `yield` \> `serves`.
+     * Interchangeable with `yield` or `serves` for the purpose of setting
+     * {@link Recipe.servings}. If multiple ones are defined, the prevalence
+     * order is `servings` \> `serves` \> `yield`.
      *
      * @example
      * ```yaml
      * servings: 4
      * ```
+     */
+    servings?: number | string;
+    /** The yield of the recipe.
+     * Can be given as:
+     * - a plain quantity with optional unit: `yield: 300%g` or `yield: 2`
+     * - a complex format with `{{}}` and optional surrounding text:
+     *   `yield: about {{300%g}} of bread`
+     *
+     * Interchangeable with `servings` or `serves` for the purpose of setting
+     * {@link Recipe.servings}. If multiple ones are defined, the prevalence
+     * order is `servings` \> `serves` \> `yield`.
      *
      * @example
      * ```yaml
-     * servings: 2, a few
+     * yield: 300%g
      * ```
      *
-     * * @example
+     * @example
      * ```yaml
-     * servings: {{1.5%kg}} of bread
+     * yield: about {{300%g}} of bread
      * ```
      */
-    servings?: MetadataScalingVar;
-    /** The yield of the recipe.
-     * Can be given either as:
-     * - a number
-     * - a string which starts with a number (which will be used for scaling) followed by a comma and then whatever you want
-     * - or an arbitrary scalable number, optionally preceded and/or followed by text.
-     *
-     * Interchangeable with `servings` or `serves`. If multiple ones are defined,
-     * the prevailance order for the number which will used for scaling
-     * is `servings` \> `yield` \> `serves`. See {@link Metadata.servings | servings}
-     * for examples.
-     */
-    yield?: MetadataScalingVar;
+    yield?: Yield;
     /** The number of people the recipe serves.
-     * Can be given either as:
-     * - a number
-     * - a string which starts with a number (which will be used for scaling) followed by a comma and then whatever you want
-     * - or an arbitrary scalable number, optionally preceded and/or followed by text.
+     * Stored as a number when the value is numeric, or as a string when non-numeric
+     * (e.g. `serves: two`). Non-numeric values default the internal scaling baseline to 1.
+     *
+     * Interchangeable with `servings` or `yield` for the purpose of setting
+     * {@link Recipe.servings}. If multiple ones are defined, the prevalence
+     * order is `servings` \> `serves` \> `yield`.
      *
-     * Interchangeable with `servings` or `yield`. If multiple ones are defined,
-     * the prevailance order for the number which will used for scaling
-     * is `servings` \> `yield` \> `serves`. See {@link Metadata.servings | servings}
-     * for examples.
+     * @example
+     * ```yaml
+     * serves: 4
+     * ```
      */
-    serves?: MetadataScalingVar;
+    serves?: number | string;
     /** The course of the recipe. */
     course?: string;
     /** The category of the recipe. */
@@ -1439,7 +1439,7 @@ declare class Pantry {
  * 14141 = { name = "Big pack", size = "6%kg", price = 10 }
  * `
  * const catalog = new ProductCatalog(catalog);
- * const eggs = catalog.find("oeuf");
+ * const eggs = catalog.products.find(p => p.ingredientName === "eggs");
  * ```
  */
 declare class ProductCatalog {
@@ -1543,19 +1543,6 @@ declare class ShoppingList {
      * and updates the resultingPantry to reflect consumed stock.
      */
     private applyPantrySubtraction;
-    /**
-     * Builds a ratio map from equivalence lists.
-     * For each equivalence list, stores ratio = equiv_value / primary_value
-     * for every pair of units, so equivalents can be recomputed after
-     * pantry subtraction modifies primary quantities.
-     */
-    private static buildEquivalenceRatioMap;
-    /**
-     * Recomputes equivalent quantities from current primary values and stored ratios.
-     * For each equivalent unit in equivUnits, new_value = Σ (primary_value × ratio[equivUnit][primaryUnit]).
-     * Returns undefined if all equivalents compute to zero.
-     */
-    private static recomputeEquivalents;
     /**
      * Adds a recipe to the shopping list, then automatically
      * recalculates the quantities and recategorize the ingredients.
@@ -2085,4 +2072,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 IngredientAlternativeBase, type IngredientExtras, type IngredientFlag, type IngredientItem, type IngredientQuantityAndGroup, type IngredientQuantityGroup, type MaybeNestedAndGroup, type MaybeNestedGroup, type MaybeNestedOrGroup, type MaybeScalableQuantity, type Metadata, type MetadataObject, type MetadataScalingVar, type MetadataSource, type MetadataTime, type MetadataValue, NoProductCatalogForCartError, type NoProductMatchErrorCode, NoShoppingListForCartError, type Note, type NoteItem, type OrGroup, Pantry, type PantryItem, type PantryItemToml, type PantryOptions, 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, type RawQuantityGroup, Recipe, type RecipeAlternatives, type RecipeChoices, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingCart, type ShoppingCartOptions, type ShoppingCartSummary, ShoppingList, type SpecificUnitSystem, type Step, type StepItem, type TextAttribute, type TextItem, type TextValue, type Timer, type TimerItem, type ToBaseBySystem, type Unit, type UnitDefinition, type UnitDefinitionLike, type UnitFractionConfig, type UnitSystem, type UnitType, type WithOptionalQuantity, convertQuantityToSystem, formatExtendedQuantity, formatItemQuantity, formatNumericValue, formatQuantity, formatQuantityWithUnit, formatSingleValue, formatUnit, getEffectiveChoices, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSectionActive, isSimpleGroup, isStepActive, 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 IngredientAlternativeBase, 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, Pantry, type PantryItem, type PantryItemToml, type PantryOptions, 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, type RawQuantityGroup, Recipe, type RecipeAlternatives, type RecipeChoices, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingCart, type ShoppingCartOptions, type ShoppingCartSummary, ShoppingList, type SpecificUnitSystem, type Step, type StepItem, type TextAttribute, type TextItem, type TextValue, type Timer, type TimerItem, type ToBaseBySystem, type Unit, type UnitDefinition, type UnitDefinitionLike, type UnitFractionConfig, type UnitSystem, type UnitType, type WithOptionalQuantity, type Yield, convertQuantityToSystem, formatExtendedQuantity, formatItemQuantity, formatNumericValue, formatQuantity, formatQuantityWithUnit, formatSingleValue, formatUnit, getEffectiveChoices, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSectionActive, isSimpleGroup, isStepActive, renderFractionAsVulgar };

package/dist/index.d.ts

@@ -299,16 +299,17 @@ interface MetadataSource {
     author?: string;
 }
 /**
- * Represents scaling variable information for a recipe.
+ * Represents a yield metadata value for a recipe.
+ * Supports plain quantities (e.g. `yield: 300%g`), complex format with
+ * surrounding text (e.g. `yield: about {{300%g}} of bread`), or simple
+ * numbers (e.g. `yield: 2`).
  * @category Types
  */
-interface MetadataScalingVar extends QuantityWithPlainUnit {
-    /** The text before the scaling variable. */
+interface Yield extends QuantityWithPlainUnit {
+    /** The text before the scaling variable (complex `{{}}` format). */
     textBefore?: string;
-    /** The text after the scaling variable. */
+    /** The text after the scaling variable (complex `{{}}` format). */
     textAfter?: string;
-    /** The text precising a numerical scaling variable. */
-    text?: string;
 }
 /**
  * Represents time information for a recipe.
@@ -333,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 | MetadataScalingVar | undefined;
+type MetadataValue = string | number | (string | number)[] | MetadataObject | MetadataSource | MetadataTime | Yield | undefined;
 /**
  * Represents the metadata of a recipe.
  * @category Types
@@ -351,55 +352,54 @@ interface Metadata {
     /** The author of the recipe (separate from source author). */
     author?: string;
     /** The number of servings the recipe makes.
-     * Can be given either as:
-     * - a number
-     * - a string which starts with a number (which will be used for scaling) followed by a comma and then whatever you want
-     * - or an arbitrary scalable number, optionally preceded and/or followed by text.
+     * Stored as a number when the value is numeric, or as a string when non-numeric
+     * (e.g. `servings: two`). Non-numeric values default the internal scaling baseline to 1.
      *
-     * Interchangeable with `yield` or `serves`. If multiple ones are defined,
-     * the prevailance order for the number which will used for scaling
-     * is `servings` \> `yield` \> `serves`.
+     * Interchangeable with `yield` or `serves` for the purpose of setting
+     * {@link Recipe.servings}. If multiple ones are defined, the prevalence
+     * order is `servings` \> `serves` \> `yield`.
      *
      * @example
      * ```yaml
      * servings: 4
      * ```
+     */
+    servings?: number | string;
+    /** The yield of the recipe.
+     * Can be given as:
+     * - a plain quantity with optional unit: `yield: 300%g` or `yield: 2`
+     * - a complex format with `{{}}` and optional surrounding text:
+     *   `yield: about {{300%g}} of bread`
+     *
+     * Interchangeable with `servings` or `serves` for the purpose of setting
+     * {@link Recipe.servings}. If multiple ones are defined, the prevalence
+     * order is `servings` \> `serves` \> `yield`.
      *
      * @example
      * ```yaml
-     * servings: 2, a few
+     * yield: 300%g
      * ```
      *
-     * * @example
+     * @example
      * ```yaml
-     * servings: {{1.5%kg}} of bread
+     * yield: about {{300%g}} of bread
      * ```
      */
-    servings?: MetadataScalingVar;
-    /** The yield of the recipe.
-     * Can be given either as:
-     * - a number
-     * - a string which starts with a number (which will be used for scaling) followed by a comma and then whatever you want
-     * - or an arbitrary scalable number, optionally preceded and/or followed by text.
-     *
-     * Interchangeable with `servings` or `serves`. If multiple ones are defined,
-     * the prevailance order for the number which will used for scaling
-     * is `servings` \> `yield` \> `serves`. See {@link Metadata.servings | servings}
-     * for examples.
-     */
-    yield?: MetadataScalingVar;
+    yield?: Yield;
     /** The number of people the recipe serves.
-     * Can be given either as:
-     * - a number
-     * - a string which starts with a number (which will be used for scaling) followed by a comma and then whatever you want
-     * - or an arbitrary scalable number, optionally preceded and/or followed by text.
+     * Stored as a number when the value is numeric, or as a string when non-numeric
+     * (e.g. `serves: two`). Non-numeric values default the internal scaling baseline to 1.
+     *
+     * Interchangeable with `servings` or `yield` for the purpose of setting
+     * {@link Recipe.servings}. If multiple ones are defined, the prevalence
+     * order is `servings` \> `serves` \> `yield`.
      *
-     * Interchangeable with `servings` or `yield`. If multiple ones are defined,
-     * the prevailance order for the number which will used for scaling
-     * is `servings` \> `yield` \> `serves`. See {@link Metadata.servings | servings}
-     * for examples.
+     * @example
+     * ```yaml
+     * serves: 4
+     * ```
      */
-    serves?: MetadataScalingVar;
+    serves?: number | string;
     /** The course of the recipe. */
     course?: string;
     /** The category of the recipe. */
@@ -1439,7 +1439,7 @@ declare class Pantry {
  * 14141 = { name = "Big pack", size = "6%kg", price = 10 }
  * `
  * const catalog = new ProductCatalog(catalog);
- * const eggs = catalog.find("oeuf");
+ * const eggs = catalog.products.find(p => p.ingredientName === "eggs");
  * ```
  */
 declare class ProductCatalog {
@@ -1543,19 +1543,6 @@ declare class ShoppingList {
      * and updates the resultingPantry to reflect consumed stock.
      */
     private applyPantrySubtraction;
-    /**
-     * Builds a ratio map from equivalence lists.
-     * For each equivalence list, stores ratio = equiv_value / primary_value
-     * for every pair of units, so equivalents can be recomputed after
-     * pantry subtraction modifies primary quantities.
-     */
-    private static buildEquivalenceRatioMap;
-    /**
-     * Recomputes equivalent quantities from current primary values and stored ratios.
-     * For each equivalent unit in equivUnits, new_value = Σ (primary_value × ratio[equivUnit][primaryUnit]).
-     * Returns undefined if all equivalents compute to zero.
-     */
-    private static recomputeEquivalents;
     /**
      * Adds a recipe to the shopping list, then automatically
      * recalculates the quantities and recategorize the ingredients.
@@ -2085,4 +2072,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 IngredientAlternativeBase, type IngredientExtras, type IngredientFlag, type IngredientItem, type IngredientQuantityAndGroup, type IngredientQuantityGroup, type MaybeNestedAndGroup, type MaybeNestedGroup, type MaybeNestedOrGroup, type MaybeScalableQuantity, type Metadata, type MetadataObject, type MetadataScalingVar, type MetadataSource, type MetadataTime, type MetadataValue, NoProductCatalogForCartError, type NoProductMatchErrorCode, NoShoppingListForCartError, type Note, type NoteItem, type OrGroup, Pantry, type PantryItem, type PantryItemToml, type PantryOptions, 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, type RawQuantityGroup, Recipe, type RecipeAlternatives, type RecipeChoices, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingCart, type ShoppingCartOptions, type ShoppingCartSummary, ShoppingList, type SpecificUnitSystem, type Step, type StepItem, type TextAttribute, type TextItem, type TextValue, type Timer, type TimerItem, type ToBaseBySystem, type Unit, type UnitDefinition, type UnitDefinitionLike, type UnitFractionConfig, type UnitSystem, type UnitType, type WithOptionalQuantity, convertQuantityToSystem, formatExtendedQuantity, formatItemQuantity, formatNumericValue, formatQuantity, formatQuantityWithUnit, formatSingleValue, formatUnit, getEffectiveChoices, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSectionActive, isSimpleGroup, isStepActive, 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 IngredientAlternativeBase, 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, Pantry, type PantryItem, type PantryItemToml, type PantryOptions, 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, type RawQuantityGroup, Recipe, type RecipeAlternatives, type RecipeChoices, type RecipeWithFactor, type RecipeWithServings, Section, ShoppingCart, type ShoppingCartOptions, type ShoppingCartSummary, ShoppingList, type SpecificUnitSystem, type Step, type StepItem, type TextAttribute, type TextItem, type TextValue, type Timer, type TimerItem, type ToBaseBySystem, type Unit, type UnitDefinition, type UnitDefinitionLike, type UnitFractionConfig, type UnitSystem, type UnitType, type WithOptionalQuantity, type Yield, convertQuantityToSystem, formatExtendedQuantity, formatItemQuantity, formatNumericValue, formatQuantity, formatQuantityWithUnit, formatSingleValue, formatUnit, getEffectiveChoices, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSectionActive, isSimpleGroup, isStepActive, renderFractionAsVulgar };