@tmlmt/cooklang-parser 1.0.8 → 1.2.1

package/dist/index.d.ts

@@ -1,7 +1,24 @@
+/**
+ * Represents a recipe section
+ * Wrapped as a Class and not as a simple type to expose some useful helper
+ * classes (e.g. `isBlank()`)
+ * @category Types
+ */
 declare class Section {
+    /** The name of the section. Can be an empty string for the default (first) section. */
     name: string;
+    /** An array of steps and notes that make up the content of the section. */
     content: (Step | Note)[];
+    /**
+     * Creates an instance of Section.
+     * @param name - The name of the section. Defaults to an empty string.
+     */
     constructor(name?: string);
+    /**
+     * Checks if the section is blank (has no name and no content).
+     * Used during recipe parsing
+     * @returns `true` if the section is blank, otherwise `false`.
+     */
     isBlank(): boolean;
 }
 
@@ -61,6 +78,11 @@ declare class Recipe {
      * @returns A new Recipe instance with the scaled ingredients.
      */
     scaleBy(factor: number): Recipe;
+    /**
+     * Gets the number of servings for the recipe.
+     * @private
+     * @returns The number of servings, or undefined if not set.
+     */
     private getServings;
     /**
      * Clones the recipe.
@@ -146,6 +168,51 @@ interface MetadataExtract {
     /** The number of servings the recipe makes. Used for scaling */
     servings?: number;
 }
+/**
+ * Represents a quantity described by text, e.g. "a pinch"
+ * @category Types
+ */
+interface TextValue {
+    type: "text";
+    value: string;
+}
+/**
+ * Represents a quantity described by a decimal number, e.g. "1.5"
+ * @category Types
+ */
+interface DecimalValue {
+    type: "decimal";
+    value: number;
+}
+/**
+ * Represents a quantity described by a fraction, e.g. "1/2"
+ * @category Types
+ */
+interface FractionValue {
+    type: "fraction";
+    /** The numerator of the fraction */
+    num: number;
+    /** The denominator of the fraction */
+    den: number;
+}
+/**
+ * Represents a single, fixed quantity.
+ * This can be a text, decimal, or fraction.
+ * @category Types
+ */
+interface FixedValue {
+    type: "fixed";
+    value: TextValue | DecimalValue | FractionValue;
+}
+/**
+ * Represents a range of quantities, e.g. "1-2"
+ * @category Types
+ */
+interface Range {
+    type: "range";
+    min: DecimalValue | FractionValue;
+    max: DecimalValue | FractionValue;
+}
 /**
  * Represents an ingredient in a recipe.
  * @category Types
@@ -154,7 +221,7 @@ interface Ingredient {
     /** The name of the ingredient. */
     name: string;
     /** The quantity of the ingredient. */
-    quantity?: number | string;
+    quantity?: FixedValue | Range;
     /** The unit of the ingredient. */
     unit?: string;
     /** The preparation of the ingredient. */
@@ -174,7 +241,7 @@ interface Timer {
     /** The name of the timer. */
     name?: string;
     /** The duration of the timer. */
-    duration: number;
+    duration: FixedValue | Range;
     /** The unit of the timer. */
     unit: string;
 }
@@ -197,12 +264,12 @@ interface IngredientItem {
     type: "ingredient";
     /** The value of the item. */
     value: number;
-    /** If this is a referenced ingredient, quantity specific to this instance */
-    partialQuantity?: number | string;
-    /** If this is a referenced ingredient, unit specific to this instance  */
-    partialUnit?: string;
-    /** If this is a referenced ingredient, preparation specific to this instance  */
-    partialPreparation?: string;
+    /** The alias/name of the ingredient as it should be displayed in the preparation */
+    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.
@@ -213,6 +280,8 @@ interface CookwareItem {
     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;
 }
 /**
  * Represents a timer item in a recipe step.
@@ -234,6 +303,7 @@ type Item = TextItem | IngredientItem | CookwareItem | TimerItem;
  * @category Types
  */
 interface Step {
+    type: "step";
     /** The items in the step. */
     items: Item[];
 }
@@ -242,6 +312,7 @@ interface Step {
  * @category Types
  */
 interface Note {
+    type: "note";
     /** The content of the note. */
     note: string;
 }
@@ -252,6 +323,8 @@ interface Note {
 interface Cookware {
     /** The name of the cookware. */
     name: string;
+    /** The quantity of cookware */
+    quantity?: FixedValue | Range;
     /** Whether the cookware is optional. */
     optional?: boolean;
     /** Whether the cookware is hidden. */
@@ -372,4 +445,4 @@ declare class ShoppingList {
     categorize(): void;
 }
 
-export { type AddedRecipe, type AisleCategory, AisleConfig, type AisleIngredient, type CategorizedIngredients, type Cookware, type CookwareItem, type Ingredient, type IngredientItem, type Item, type Metadata, type MetadataExtract, type Note, Recipe, ShoppingList, type Step, type TextItem, type Timer, type TimerItem };
+export { type AddedRecipe, type AisleCategory, AisleConfig, type AisleIngredient, type CategorizedIngredients, type Cookware, type CookwareItem, type DecimalValue, type FixedValue, type FractionValue, type Ingredient, type IngredientItem, type Item, type Metadata, type MetadataExtract, type Note, type Range, Recipe, Section, ShoppingList, type Step, type TextItem, type TextValue, type Timer, type TimerItem };