@tmlmt/cooklang-parser 1.4.4 → 2.0.1

package/dist/index.d.cts

@@ -125,6 +125,11 @@ declare class Recipe {
     clone(): Recipe;
 }
 
+interface Quantity {
+    value: FixedValue | Range;
+    unit?: string;
+}
+
 /**
  * Represents the metadata of a recipe.
  * @category Types
@@ -145,22 +150,47 @@ interface Metadata {
     /** The author of the recipe. */
     author?: string;
     /** The number of servings the recipe makes.
-     * Complex info can be given, as long as the first part before a comma has a numerical value, which will be used for scaling
+     * Should be either a number or a string which starts with a number
+     * (which will be used for scaling) followed by a comma and then
+     * whatever you want.
+     *
+     * 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`. If multiple ones are defined, the latest one will be used for scaling */
-    servings?: string;
+     * @example
+     * ```yaml
+     * servings: 4
+     * ```
+     *
+     * @example
+     * ```yaml
+     * servings: 2, a few
+     * ```
+     */
+    servings?: number | string;
     /** The yield of the recipe.
-     * Complex info can be given, as long as the first part before a comma has a numerical value, which will be used for scaling
+     * Should be either a number or a string which starts with a number
+     * (which will be used for scaling) followed by a comma and then
+     * whatever you want.
      *
-     * Interchangeable with `servings` or `serves`. If multiple ones are defined, the latest one will be used for scaling
+     * 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?: string;
+    yield?: number | string;
     /** The number of people the recipe serves.
-     * Complex info can be given, as long as the first part before a comma has a numerical value, which will be used for scaling
+     * Should be either a number or a string which starts with a number
+     * (which will be used for scaling) followed by a comma and then
+     * whatever you want.
      *
-     * Interchangeable with `servings` or `yield`. If multiple ones are defined, the latest one will be used for scaling
+     * 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.
      */
-    serves?: string;
+    serves?: number | string;
     /** The course of the recipe. */
     course?: string;
     /** The category of the recipe. */
@@ -256,6 +286,41 @@ interface Range {
     min: DecimalValue | FractionValue;
     max: DecimalValue | FractionValue;
 }
+/**
+ * Represents a contributor to an ingredient's total quantity
+ * @category Types
+ */
+interface QuantityPart extends Quantity {
+    /** - If _true_, the quantity will scale
+     * - If _false_, the quantity is fixed
+     */
+    scalable: boolean;
+}
+/**
+ * Represents a possible state modifier or other flag for an ingredient in a recipe
+ * @category Types
+ */
+type IngredientFlag = "optional" | "hidden" | "recipe";
+/**
+ * Represents the collection of possible additional metadata for an ingredient in a recipe
+ * @category Types
+ */
+interface IngredientExtras {
+    /**
+     * The path of the ingredient-recipe, relative to the present recipe
+     * Used if: the ingredient is a recipe
+     *
+     * @example
+     * ```cooklang
+     * Take @./essentials/doughs/pizza dough{1} out of the freezer and let it unfreeze overnight
+     * ```
+     * Would lead to:
+     * ```yaml
+     * path: 'essentials/doughts/pizza dough.cook'
+     * ```
+     */
+    path: string;
+}
 /**
  * Represents an ingredient in a recipe.
  * @category Types
@@ -267,14 +332,14 @@ interface Ingredient {
     quantity?: FixedValue | Range;
     /** The unit of the ingredient. */
     unit?: string;
+    /** The array of contributors to the ingredient's total quantity. */
+    quantityParts?: QuantityPart[];
     /** The preparation of the ingredient. */
     preparation?: string;
-    /** Whether the ingredient is optional. */
-    optional?: boolean;
-    /** Whether the ingredient is hidden. */
-    hidden?: boolean;
-    /** Whether the ingredient is a recipe. */
-    isRecipe?: boolean;
+    /** A list of potential state modifiers or other flags for the ingredient */
+    flags?: IngredientFlag[];
+    /** The collection of potential additional metadata for the ingredient */
+    extras?: IngredientExtras;
 }
 /**
  * Represents a timer in a recipe.
@@ -295,7 +360,7 @@ interface Timer {
 interface TextItem {
     /** The type of the item. */
     type: "text";
-    /** The value of the item. */
+    /** The content of the text item. */
     value: string;
 }
 /**
@@ -305,14 +370,14 @@ interface TextItem {
 interface IngredientItem {
     /** The type of the item. */
     type: "ingredient";
-    /** The value of the item. */
-    value: number;
-    /** The alias/name of the ingredient as it should be displayed in the preparation */
+    /** The index of the ingredient, within the {@link Recipe.ingredients | list of ingredients} */
+    index: number;
+    /** Index of the quantity part corresponding to this item / this occurence
+     * of the ingredient, which may be referenced elsewhere. */
+    quantityPartIndex?: number;
+    /** The alias/name of the ingredient as it should be displayed in the preparation
+     * for this occurence */
     displayName: string;
-    /** Quantity specific to this step item for this ingredient which may also be referenced elsewhere */
-    itemQuantity?: FixedValue | Range;
-    /** Unit specific to this step item for this ingredient which may also be referenced elsewhere */
-    itemUnit?: string;
 }
 /**
  * Represents a cookware item in a recipe step.
@@ -321,10 +386,11 @@ interface IngredientItem {
 interface CookwareItem {
     /** The type of the item. */
     type: "cookware";
-    /** The value of the item. */
-    value: number;
-    /** Quantity specific to this step item for this cookware which may also be referenced elsewhere */
-    itemQuantity?: FixedValue | Range;
+    /** The index of the cookware, within the {@link Recipe.cookware | list of cookware} */
+    index: number;
+    /** Index of the quantity part corresponding to this item / this occurence
+     * of the cookware, which may be referenced elsewhere. */
+    quantityPartIndex?: number;
 }
 /**
  * Represents a timer item in a recipe step.
@@ -333,8 +399,8 @@ interface CookwareItem {
 interface TimerItem {
     /** The type of the item. */
     type: "timer";
-    /** The value of the item. */
-    value: number;
+    /** The index of the timer, within the {@link Recipe.timers | list of timers} */
+    index: number;
 }
 /**
  * Represents an item in a recipe step.
@@ -359,6 +425,11 @@ interface Note {
     /** The content of the note. */
     note: string;
 }
+/**
+ * Represents a possible state modifier or other flag for cookware used in a recipe
+ * @category Types
+ */
+type CookwareFlag = "optional" | "hidden";
 /**
  * Represents a piece of cookware in a recipe.
  * @category Types
@@ -368,10 +439,10 @@ interface Cookware {
     name: string;
     /** The quantity of cookware */
     quantity?: FixedValue | Range;
-    /** Whether the cookware is optional. */
-    optional?: boolean;
-    /** Whether the cookware is hidden. */
-    hidden?: boolean;
+    /** The array of contributors to the cookware's total quantity. */
+    quantityParts?: (FixedValue | Range)[];
+    /** A list of potential state modifiers or other flags for the cookware */
+    flags: CookwareFlag[];
 }
 /**
  * Represents categorized ingredients.
@@ -535,4 +606,4 @@ declare class ShoppingList {
     categorize(): void;
 }
 
-export { type AddedRecipe, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareItem, type DecimalValue, type FixedValue, type FractionValue, type Ingredient, type IngredientItem, type Item, type Metadata, type Note, 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, Section, ShoppingList, type Step, type TextItem, type TextValue, type Timer, type TimerItem };

package/dist/index.d.ts

@@ -125,6 +125,11 @@ declare class Recipe {
     clone(): Recipe;
 }
 
+interface Quantity {
+    value: FixedValue | Range;
+    unit?: string;
+}
+
 /**
  * Represents the metadata of a recipe.
  * @category Types
@@ -145,22 +150,47 @@ interface Metadata {
     /** The author of the recipe. */
     author?: string;
     /** The number of servings the recipe makes.
-     * Complex info can be given, as long as the first part before a comma has a numerical value, which will be used for scaling
+     * Should be either a number or a string which starts with a number
+     * (which will be used for scaling) followed by a comma and then
+     * whatever you want.
+     *
+     * 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`. If multiple ones are defined, the latest one will be used for scaling */
-    servings?: string;
+     * @example
+     * ```yaml
+     * servings: 4
+     * ```
+     *
+     * @example
+     * ```yaml
+     * servings: 2, a few
+     * ```
+     */
+    servings?: number | string;
     /** The yield of the recipe.
-     * Complex info can be given, as long as the first part before a comma has a numerical value, which will be used for scaling
+     * Should be either a number or a string which starts with a number
+     * (which will be used for scaling) followed by a comma and then
+     * whatever you want.
      *
-     * Interchangeable with `servings` or `serves`. If multiple ones are defined, the latest one will be used for scaling
+     * 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?: string;
+    yield?: number | string;
     /** The number of people the recipe serves.
-     * Complex info can be given, as long as the first part before a comma has a numerical value, which will be used for scaling
+     * Should be either a number or a string which starts with a number
+     * (which will be used for scaling) followed by a comma and then
+     * whatever you want.
      *
-     * Interchangeable with `servings` or `yield`. If multiple ones are defined, the latest one will be used for scaling
+     * 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.
      */
-    serves?: string;
+    serves?: number | string;
     /** The course of the recipe. */
     course?: string;
     /** The category of the recipe. */
@@ -256,6 +286,41 @@ interface Range {
     min: DecimalValue | FractionValue;
     max: DecimalValue | FractionValue;
 }
+/**
+ * Represents a contributor to an ingredient's total quantity
+ * @category Types
+ */
+interface QuantityPart extends Quantity {
+    /** - If _true_, the quantity will scale
+     * - If _false_, the quantity is fixed
+     */
+    scalable: boolean;
+}
+/**
+ * Represents a possible state modifier or other flag for an ingredient in a recipe
+ * @category Types
+ */
+type IngredientFlag = "optional" | "hidden" | "recipe";
+/**
+ * Represents the collection of possible additional metadata for an ingredient in a recipe
+ * @category Types
+ */
+interface IngredientExtras {
+    /**
+     * The path of the ingredient-recipe, relative to the present recipe
+     * Used if: the ingredient is a recipe
+     *
+     * @example
+     * ```cooklang
+     * Take @./essentials/doughs/pizza dough{1} out of the freezer and let it unfreeze overnight
+     * ```
+     * Would lead to:
+     * ```yaml
+     * path: 'essentials/doughts/pizza dough.cook'
+     * ```
+     */
+    path: string;
+}
 /**
  * Represents an ingredient in a recipe.
  * @category Types
@@ -267,14 +332,14 @@ interface Ingredient {
     quantity?: FixedValue | Range;
     /** The unit of the ingredient. */
     unit?: string;
+    /** The array of contributors to the ingredient's total quantity. */
+    quantityParts?: QuantityPart[];
     /** The preparation of the ingredient. */
     preparation?: string;
-    /** Whether the ingredient is optional. */
-    optional?: boolean;
-    /** Whether the ingredient is hidden. */
-    hidden?: boolean;
-    /** Whether the ingredient is a recipe. */
-    isRecipe?: boolean;
+    /** A list of potential state modifiers or other flags for the ingredient */
+    flags?: IngredientFlag[];
+    /** The collection of potential additional metadata for the ingredient */
+    extras?: IngredientExtras;
 }
 /**
  * Represents a timer in a recipe.
@@ -295,7 +360,7 @@ interface Timer {
 interface TextItem {
     /** The type of the item. */
     type: "text";
-    /** The value of the item. */
+    /** The content of the text item. */
     value: string;
 }
 /**
@@ -305,14 +370,14 @@ interface TextItem {
 interface IngredientItem {
     /** The type of the item. */
     type: "ingredient";
-    /** The value of the item. */
-    value: number;
-    /** The alias/name of the ingredient as it should be displayed in the preparation */
+    /** The index of the ingredient, within the {@link Recipe.ingredients | list of ingredients} */
+    index: number;
+    /** Index of the quantity part corresponding to this item / this occurence
+     * of the ingredient, which may be referenced elsewhere. */
+    quantityPartIndex?: number;
+    /** The alias/name of the ingredient as it should be displayed in the preparation
+     * for this occurence */
     displayName: string;
-    /** Quantity specific to this step item for this ingredient which may also be referenced elsewhere */
-    itemQuantity?: FixedValue | Range;
-    /** Unit specific to this step item for this ingredient which may also be referenced elsewhere */
-    itemUnit?: string;
 }
 /**
  * Represents a cookware item in a recipe step.
@@ -321,10 +386,11 @@ interface IngredientItem {
 interface CookwareItem {
     /** The type of the item. */
     type: "cookware";
-    /** The value of the item. */
-    value: number;
-    /** Quantity specific to this step item for this cookware which may also be referenced elsewhere */
-    itemQuantity?: FixedValue | Range;
+    /** The index of the cookware, within the {@link Recipe.cookware | list of cookware} */
+    index: number;
+    /** Index of the quantity part corresponding to this item / this occurence
+     * of the cookware, which may be referenced elsewhere. */
+    quantityPartIndex?: number;
 }
 /**
  * Represents a timer item in a recipe step.
@@ -333,8 +399,8 @@ interface CookwareItem {
 interface TimerItem {
     /** The type of the item. */
     type: "timer";
-    /** The value of the item. */
-    value: number;
+    /** The index of the timer, within the {@link Recipe.timers | list of timers} */
+    index: number;
 }
 /**
  * Represents an item in a recipe step.
@@ -359,6 +425,11 @@ interface Note {
     /** The content of the note. */
     note: string;
 }
+/**
+ * Represents a possible state modifier or other flag for cookware used in a recipe
+ * @category Types
+ */
+type CookwareFlag = "optional" | "hidden";
 /**
  * Represents a piece of cookware in a recipe.
  * @category Types
@@ -368,10 +439,10 @@ interface Cookware {
     name: string;
     /** The quantity of cookware */
     quantity?: FixedValue | Range;
-    /** Whether the cookware is optional. */
-    optional?: boolean;
-    /** Whether the cookware is hidden. */
-    hidden?: boolean;
+    /** The array of contributors to the cookware's total quantity. */
+    quantityParts?: (FixedValue | Range)[];
+    /** A list of potential state modifiers or other flags for the cookware */
+    flags: CookwareFlag[];
 }
 /**
  * Represents categorized ingredients.
@@ -535,4 +606,4 @@ declare class ShoppingList {
     categorize(): void;
 }
 
-export { type AddedRecipe, type CategorizedIngredients, type Category, CategoryConfig, type CategoryIngredient, type Cookware, type CookwareItem, type DecimalValue, type FixedValue, type FractionValue, type Ingredient, type IngredientItem, type Item, type Metadata, type Note, 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, Section, ShoppingList, type Step, type TextItem, type TextValue, type Timer, type TimerItem };