@tmlmt/cooklang-parser 1.2.5 → 1.4.0

package/dist/index.js

@@ -2,16 +2,15 @@ var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
-// src/classes/aisle_config.ts
-var AisleConfig = class {
+// src/classes/category_config.ts
+var CategoryConfig = class {
   /**
-   * Creates a new AisleConfig instance.
-   * @param config - The aisle configuration to parse.
+   * Creates a new CategoryConfig instance.
+   * @param config - The category configuration to parse.
    */
   constructor(config) {
     /**
-     * The categories of aisles.
-     * @see {@link AisleCategory}
+     * The parsed categories of ingredients.
      */
     __publicField(this, "categories", []);
     if (config) {
@@ -19,8 +18,9 @@ var AisleConfig = class {
     }
   }
   /**
-   * Parses an aisle configuration from a string.
-   * @param config - The aisle configuration to parse.
+   * Parses a category configuration from a string into property
+   *   {@link CategoryConfig.categories | categories}
+   * @param config - The category configuration to parse.
    */
   parse(config) {
     let currentCategory = null;
@@ -70,7 +70,10 @@ var Section = class {
    * @param name - The name of the section. Defaults to an empty string.
    */
   constructor(name = "") {
-    /** The name of the section. Can be an empty string for the default (first) section. */
+    /**
+     * The name of the section. Can be an empty string for the default (first) section.
+     * @defaultValue `""`
+     */
     __publicField(this, "name");
     /** An array of steps and notes that make up the content of the section. */
     __publicField(this, "content", []);
@@ -316,14 +319,14 @@ var units = [
     name: "g",
     type: "mass",
     system: "metric",
-    aliases: ["gram", "grams"],
+    aliases: ["gram", "grams", "grammes"],
     toBase: 1
   },
   {
     name: "kg",
     type: "mass",
     system: "metric",
-    aliases: ["kilogram", "kilograms"],
+    aliases: ["kilogram", "kilograms", "kilogrammes", "kilos", "kilo"],
     toBase: 1e3
   },
   // Mass (Imperial)
@@ -346,7 +349,7 @@ var units = [
     name: "ml",
     type: "volume",
     system: "metric",
-    aliases: ["milliliter", "milliliters", "millilitre", "millilitres"],
+    aliases: ["milliliter", "milliliters", "millilitre", "millilitres", "cc"],
     toBase: 1
   },
   {
@@ -411,7 +414,7 @@ var units = [
     name: "piece",
     type: "count",
     system: "metric",
-    aliases: ["pieces"],
+    aliases: ["pieces", "pc"],
     toBase: 1
   }
 ];
@@ -766,32 +769,31 @@ var Recipe = class _Recipe {
    */
   constructor(content) {
     /**
-     * The recipe's metadata.
-     * @see {@link Metadata}
+     * The parsed recipe metadata.
      */
     __publicField(this, "metadata", {});
     /**
-     * The recipe's ingredients.
-     * @see {@link Ingredient}
+     * The parsed recipe ingredients.
      */
     __publicField(this, "ingredients", []);
     /**
-     * The recipe's sections.
-     * @see {@link Section}
+     * The parsed recipe sections.
      */
     __publicField(this, "sections", []);
     /**
-     * The recipe's cookware.
-     * @see {@link Cookware}
+     * The parsed recipe cookware.
      */
     __publicField(this, "cookware", []);
     /**
-     * The recipe's timers.
-     * @see {@link Timer}
+     * The parsed recipe timers.
      */
     __publicField(this, "timers", []);
     /**
-     * The recipe's servings. Used for scaling
+     * The parsed recipe servings. Used for scaling. Parsed from one of
+     * {@link Metadata.servings}, {@link Metadata.yield} or {@link Metadata.serves}
+     * metadata fields.
+     *
+     * @see {@link Recipe.scaleBy | scaleBy()} and {@link Recipe.scaleTo | scaleTo()} methods
      */
     __publicField(this, "servings");
     if (content) {
@@ -953,9 +955,12 @@ var Recipe = class _Recipe {
     }
   }
   /**
-   * Scales the recipe to a new number of servings.
+   * Scales the recipe to a new number of servings. In practice, it calls
+   * {@link Recipe.scaleBy | scaleBy} with a factor corresponding to the ratio between `newServings`
+   *   and the recipe's {@link Recipe.servings | servings} value.
    * @param newServings - The new number of servings.
    * @returns A new Recipe instance with the scaled ingredients.
+   * @throws `Error` if the recipe does not contains an initial {@link Recipe.servings | servings} value
    */
   scaleTo(newServings) {
     const originalServings = this.getServings();
@@ -1040,32 +1045,28 @@ var Recipe = class _Recipe {
 // src/classes/shopping_list.ts
 var ShoppingList = class {
   /**
-   * Creates a new ShoppingList instance.
-   * @param aisle_config_str - The aisle configuration to parse.
+   * Creates a new ShoppingList instance
+   * @param category_config_str - The category configuration to parse.
    */
-  constructor(aisle_config_str) {
+  constructor(category_config_str) {
     /**
      * The ingredients in the shopping list.
-     * @see {@link Ingredient}
      */
     __publicField(this, "ingredients", []);
     /**
      * The recipes in the shopping list.
-     * @see {@link AddedRecipe}
      */
     __publicField(this, "recipes", []);
     /**
-     * The aisle configuration for the shopping list.
-     * @see {@link AisleConfig}
+     * The category configuration for the shopping list.
      */
-    __publicField(this, "aisle_config");
+    __publicField(this, "category_config");
     /**
      * The categorized ingredients in the shopping list.
-     * @see {@link CategorizedIngredients}
      */
     __publicField(this, "categories");
-    if (aisle_config_str) {
-      this.set_aisle_config(aisle_config_str);
+    if (category_config_str) {
+      this.set_category_config(category_config_str);
     }
   }
   calculate_ingredients() {
@@ -1121,7 +1122,8 @@ var ShoppingList = class {
     }
   }
   /**
-   * Adds a recipe to the shopping list.
+   * 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.
    */
@@ -1131,7 +1133,8 @@ var ShoppingList = class {
     this.categorize();
   }
   /**
-   * Removes a recipe from the shopping list.
+   * Removes a recipe from the shopping list, then automatically
+   * recalculates the quantities and recategorize the ingredients.s
    * @param index - The index of the recipe to remove.
    */
   remove_recipe(index) {
@@ -1143,31 +1146,35 @@ var ShoppingList = class {
     this.categorize();
   }
   /**
-   * Sets the aisle configuration for the shopping list.
-   * @param config - The aisle configuration to parse.
+   * Sets the category configuration for the shopping list
+   * and automatically categorize current ingredients from the list.
+   * @param config - The category configuration to parse.
    */
-  set_aisle_config(config) {
-    this.aisle_config = new AisleConfig(config);
+  set_category_config(config) {
+    if (typeof config === "string")
+      this.category_config = new CategoryConfig(config);
+    else if (config instanceof CategoryConfig) this.category_config = config;
+    else throw new Error("Invalid category configuration");
     this.categorize();
   }
   /**
    * Categorizes the ingredients in the shopping list
-   * Will use the aisle config if any, otherwise all ingredients will be placed in the "other" category
+   * Will use the category config if any, otherwise all ingredients will be placed in the "other" category
    */
   categorize() {
-    if (!this.aisle_config) {
+    if (!this.category_config) {
       this.categories = { other: this.ingredients };
       return;
     }
     const categories = { other: [] };
-    for (const category of this.aisle_config.categories) {
+    for (const category of this.category_config.categories) {
       categories[category.name] = [];
     }
     for (const ingredient of this.ingredients) {
       let found = false;
-      for (const category of this.aisle_config.categories) {
-        for (const aisleIngredient of category.ingredients) {
-          if (aisleIngredient.aliases.includes(ingredient.name)) {
+      for (const category of this.category_config.categories) {
+        for (const categoryIngredient of category.ingredients) {
+          if (categoryIngredient.aliases.includes(ingredient.name)) {
             categories[category.name].push(ingredient);
             found = true;
             break;
@@ -1185,7 +1192,7 @@ var ShoppingList = class {
   }
 };
 export {
-  AisleConfig,
+  CategoryConfig,
   Recipe,
   Section,
   ShoppingList