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

package/dist/index.d.cts

@@ -657,6 +657,11 @@ interface Timer {
     /** The unit of the timer. */
     unit: string;
 }
+/**
+ * Represents a formatting attribute for a {@link TextItem}.
+ * @category Types
+ */
+type TextAttribute = "bold" | "italic" | "bold+italic" | "link" | "code";
 /**
  * Represents a text item in a recipe step.
  * @category Types
@@ -666,6 +671,10 @@ interface TextItem {
     type: "text";
     /** The content of the text item. */
     value: string;
+    /** The formatting attribute of the text item, if any. */
+    attribute?: TextAttribute;
+    /** The URL target, only present when attribute is "link". */
+    href?: string;
 }
 /**
  * Represents an arbitrary scalable quantity in a recipe.
@@ -1653,5 +1662,11 @@ declare class NoProductCatalogForCartError extends Error {
 declare class NoShoppingListForCartError extends Error {
     constructor();
 }
+declare class NoTabAsIndentError extends Error {
+    constructor();
+}
+declare class BadIndentationError 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 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 };
+export { type AddedIngredient, type AddedRecipe, type AddedRecipeOptions, type AlternativeIngredientRef, type AndGroup, type ArbitraryScalable, type ArbitraryScalableItem, BadIndentationError, 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, NoTabAsIndentError, 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 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, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSimpleGroup, renderFractionAsVulgar };

package/dist/index.d.ts

@@ -657,6 +657,11 @@ interface Timer {
     /** The unit of the timer. */
     unit: string;
 }
+/**
+ * Represents a formatting attribute for a {@link TextItem}.
+ * @category Types
+ */
+type TextAttribute = "bold" | "italic" | "bold+italic" | "link" | "code";
 /**
  * Represents a text item in a recipe step.
  * @category Types
@@ -666,6 +671,10 @@ interface TextItem {
     type: "text";
     /** The content of the text item. */
     value: string;
+    /** The formatting attribute of the text item, if any. */
+    attribute?: TextAttribute;
+    /** The URL target, only present when attribute is "link". */
+    href?: string;
 }
 /**
  * Represents an arbitrary scalable quantity in a recipe.
@@ -1653,5 +1662,11 @@ declare class NoProductCatalogForCartError extends Error {
 declare class NoShoppingListForCartError extends Error {
     constructor();
 }
+declare class NoTabAsIndentError extends Error {
+    constructor();
+}
+declare class BadIndentationError 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 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 };
+export { type AddedIngredient, type AddedRecipe, type AddedRecipeOptions, type AlternativeIngredientRef, type AndGroup, type ArbitraryScalable, type ArbitraryScalableItem, BadIndentationError, 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, NoTabAsIndentError, 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 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, hasAlternatives, isAlternativeSelected, isAndGroup, isGroupedItem, isSimpleGroup, renderFractionAsVulgar };

package/dist/index.js

@@ -299,6 +299,37 @@ var shoppingListRegex = d().literal("[").startNamedGroup("name").anyCharacter().
 var rangeRegex = d().startAnchor().digit().oneOrMore().startGroup().anyOf(".,/").exactly(1).digit().oneOrMore().endGroup().optional().literal("-").digit().oneOrMore().startGroup().anyOf(".,/").exactly(1).digit().oneOrMore().endGroup().optional().endAnchor().toRegExp();
 var numberLikeRegex = d().startAnchor().digit().oneOrMore().startGroup().anyOf(".,/").exactly(1).digit().oneOrMore().endGroup().optional().endAnchor().toRegExp();
 var floatRegex = d().startAnchor().digit().oneOrMore().startGroup().anyOf(".").exactly(1).digit().oneOrMore().endGroup().optional().endAnchor().toRegExp();
+var mdEscaped = d().literal("\\").startCaptureGroup().anyOf("*_`").endGroup();
+var mdInlineCode = d().literal("`").startCaptureGroup().notAnyOf("`").oneOrMore().lazy().endGroup().literal("`");
+var mdLink = d().literal("[").startCaptureGroup().notAnyOf("\\]").oneOrMore().lazy().endGroup().literal("](").startCaptureGroup().notAnyOf(")").oneOrMore().lazy().endGroup().literal(")");
+var mdTripleAsterisk = d().literal("***").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("***");
+var mdTripleUnderscore = d().literal("___").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("___");
+var mdBoldAstItalicUnd = d().literal("**_").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("_**");
+var mdBoldUndItalicAst = d().literal("__*").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("*__");
+var mdItalicAstBoldUnd = d().literal("*__").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("__*");
+var mdItalicUndBoldAst = d().literal("_**").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("**_");
+var mdBoldAsterisk = d().literal("**").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("**");
+var mdBoldUnderscore = d().wordBoundary().literal("__").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("__").wordBoundary();
+var mdItalicAsterisk = d().literal("*").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("*");
+var mdItalicUnderscore = d().wordBoundary().literal("_").startCaptureGroup().anyCharacter().oneOrMore().lazy().endGroup().literal("_").wordBoundary();
+var markdownRegex = new RegExp(
+  [
+    mdEscaped,
+    mdInlineCode,
+    mdLink,
+    mdTripleAsterisk,
+    mdTripleUnderscore,
+    mdBoldAstItalicUnd,
+    mdBoldUndItalicAst,
+    mdItalicAstBoldUnd,
+    mdItalicUndBoldAst,
+    mdBoldAsterisk,
+    mdBoldUnderscore,
+    mdItalicAsterisk,
+    mdItalicUnderscore
+  ].map((r2) => r2.toRegExp().source).join("|"),
+  "g"
+);
 
 // src/units/definitions.ts
 var units = [
@@ -1425,12 +1456,106 @@ function parseQuantityInput(input_str) {
   }
   return { type: "fixed", value: parseFixedValue(clean_str) };
 }
+function parseMarkdownSegments(text) {
+  const items = [];
+  let cursor = 0;
+  for (const match of text.matchAll(markdownRegex)) {
+    const idx = match.index;
+    if (idx > cursor) {
+      items.push({ type: "text", value: text.slice(cursor, idx) });
+    }
+    const [
+      ,
+      escaped,
+      // group 1: escaped character
+      code,
+      // group 2: inline code
+      linkText,
+      // group 3: link text
+      linkUrl,
+      // group 4: link url
+      tripleAst,
+      // group 5: ***bold+italic***
+      tripleUnd,
+      // group 6: ___bold+italic___
+      astUnd,
+      // group 7: **_bold+italic_**
+      undAst,
+      // group 8: __*bold+italic*__
+      astUndUnd,
+      // group 9: *__bold+italic__*
+      undAstAst,
+      // group 10: _**bold+italic**_
+      boldAst,
+      // group 11: **bold**
+      boldUnd,
+      // group 12: __bold__
+      italicAst,
+      // group 13: *italic*
+      italicUnd
+      // group 14: _italic_
+    ] = match;
+    let value;
+    let attribute;
+    let href;
+    if (escaped !== void 0) {
+      items.push({ type: "text", value: escaped });
+      cursor = idx + match[0].length;
+      continue;
+    } else if (code !== void 0) {
+      value = code;
+      attribute = "code";
+    } else if (linkText !== void 0) {
+      value = linkText;
+      attribute = "link";
+      href = linkUrl;
+    } else if (tripleAst !== void 0 || tripleUnd !== void 0 || astUnd !== void 0 || undAst !== void 0 || astUndUnd !== void 0 || undAstAst !== void 0) {
+      value = tripleAst ?? tripleUnd ?? astUnd ?? undAst ?? astUndUnd ?? undAstAst;
+      attribute = "bold+italic";
+    } else if (boldAst !== void 0 || boldUnd !== void 0) {
+      value = boldAst ?? boldUnd;
+      attribute = "bold";
+    } else {
+      value = italicAst ?? italicUnd;
+      attribute = "italic";
+    }
+    const item = { type: "text", value };
+    if (attribute) item.attribute = attribute;
+    if (href) item.href = href;
+    items.push(item);
+    cursor = idx + match[0].length;
+  }
+  if (cursor < text.length) {
+    items.push({ type: "text", value: text.slice(cursor) });
+  }
+  return items;
+}
 function parseSimpleMetaVar(content, varName) {
   const varMatch = content.match(
     new RegExp(`^${varName}:\\s*(.*(?:\\r?\\n\\s+.*)*)+`, "m")
   );
   return varMatch ? varMatch[1]?.trim().replace(/\s*\r?\n\s+/g, " ") : void 0;
 }
+function parseBlockScalarMetaVar(content, varName) {
+  const match = content.match(
+    new RegExp(
+      `^${varName}:\\s*([|>])\\s*\\r?\\n((?:(?:[ ]+.*|\\s*)(?:\\r?\\n|$))+)`,
+      "m"
+    )
+  );
+  if (!match) return void 0;
+  const style = match[1];
+  const rawBlock = match[2];
+  const lines = rawBlock.split(/\r?\n/);
+  const firstNonEmpty = lines.find((l) => l.trim() !== "");
+  if (!firstNonEmpty) return void 0;
+  const baseIndent = firstNonEmpty.match(/^([ ]*)/)[1].length;
+  const stripped = lines.map((line) => line.trim() === "" ? "" : line.slice(baseIndent)).join("\n").replace(/\n+$/, "");
+  if (style === "|") {
+    return stripped;
+  }
+  return stripped.replace(/\n\n/g, "\0").replace(/\n/g, " ").replace(/\0/g, "\n");
+}
 function parseScalingMetaVar(content, varName) {
   const varMatch = content.match(scalingMetaValueRegex(varName));
   if (!varMatch) return void 0;
@@ -1613,6 +1738,13 @@ function extractMetadata(content) {
     "cuisine",
     "difficulty"
   ]) {
+    if (metaVar === "description" || metaVar === "introduction") {
+      const blockValue = parseBlockScalarMetaVar(metadataContent, metaVar);
+      if (blockValue) {
+        metadata[metaVar] = blockValue;
+        continue;
+      }
+    }
     const stringMetaValue = parseSimpleMetaVar(metadataContent, metaVar);
     if (stringMetaValue) metadata[metaVar] = stringMetaValue;
   }
@@ -2316,13 +2448,13 @@ var _Recipe = class _Recipe {
     for (const match of text.matchAll(globalRegex)) {
       const idx = match.index;
       if (idx > cursor) {
-        noteItems.push({ type: "text", value: text.slice(cursor, idx) });
+        noteItems.push(...parseMarkdownSegments(text.slice(cursor, idx)));
       }
       this._parseArbitraryScalable(match.groups, noteItems);
       cursor = idx + match[0].length;
     }
     if (cursor < text.length) {
-      noteItems.push({ type: "text", value: text.slice(cursor) });
+      noteItems.push(...parseMarkdownSegments(text.slice(cursor)));
     }
     return noteItems;
   }
@@ -2876,7 +3008,7 @@ var _Recipe = class _Recipe {
       for (const match of line.matchAll(tokensRegex)) {
         const idx = match.index;
         if (idx > cursor) {
-          items.push({ type: "text", value: line.slice(cursor, idx) });
+          items.push(...parseMarkdownSegments(line.slice(cursor, idx)));
         }
         const groups = match.groups;
         if (groups.mIngredientName || groups.sIngredientName) {
@@ -2938,7 +3070,7 @@ var _Recipe = class _Recipe {
         cursor = idx + match[0].length;
       }
       if (cursor < line.length) {
-        items.push({ type: "text", value: line.slice(cursor) });
+        items.push(...parseMarkdownSegments(line.slice(cursor)));
       }
       blankLineBefore = false;
     }
@@ -3867,9 +3999,11 @@ function isAlternativeSelected(recipe, choices, item, alternativeIndex) {
   return alternativeIndex === selectedIndex;
 }
 export {
+  BadIndentationError,
   CategoryConfig,
   NoProductCatalogForCartError,
   NoShoppingListForCartError,
+  NoTabAsIndentError,
   ProductCatalog,
   Recipe,
   Section,