soustack 0.2.3 → 0.3.0

package/dist/index.d.mts

@@ -1,10 +1,24 @@
 /**
- * Soustack Recipe Schema v0.2.1
+ * Soustack Recipe Schema v0.3.0
  * A portable, scalable, interoperable recipe format.
  */
 interface SoustackRecipe {
+    /** Document marker for Soustack recipes */
+    '@type'?: 'Recipe';
     /** Optional $schema pointer for profile-aware validation */
     $schema?: string;
+    /** Optional declared validation profile */
+    profile?: string;
+    /** Enabled module identifiers (e.g., "nutrition@1") */
+    modules?: string[];
+    /** Attribution module payload */
+    attribution?: AttributionModule;
+    /** Taxonomy module payload */
+    taxonomy?: TaxonomyModule;
+    /** Media module payload */
+    media?: MediaModule;
+    /** Times module payload */
+    times?: TimesModule;
     /** Unique identifier (slug or UUID) */
     id?: string;
     /** Optional display title */
@@ -77,25 +91,25 @@ interface Equipment {
     name: string;
     required?: boolean;
     label?: string;
-    capacity?: Quantity;
+    capacity?: Quantity$1;
     scalingLimit?: number;
     alternatives?: string[];
 }
-interface Quantity {
+interface Quantity$1 {
     amount: number;
     /** Unit string (e.g. "g", "cup") or null for count-based items (e.g. "2 eggs") */
     unit: string | null;
 }
-type IngredientItem = string | Ingredient | IngredientSubsection;
+type IngredientItem = string | Ingredient$1 | IngredientSubsection;
 interface IngredientSubsection {
     subsection: string;
-    items: (string | Ingredient)[];
+    items: (string | Ingredient$1)[];
 }
-interface Ingredient {
+interface Ingredient$1 {
     id?: string;
     /** Full human-readable text (e.g. "2 cups flour") */
     item: string;
-    quantity?: Quantity;
+    quantity?: Quantity$1;
     name?: string;
     aisle?: string;
     /** Required prep state (e.g. "diced") */
@@ -208,15 +222,27 @@ interface Alternative {
     dietary?: string[];
 }
 interface NutritionFacts {
-    calories?: string;
-    fatContent?: string;
-    carbohydrateContent?: string;
-    proteinContent?: string;
-    fiberContent?: string;
-    sugarContent?: string;
-    sodiumContent?: string;
-    servingSize?: string;
-    [key: string]: string | number | null | string[] | undefined;
+    calories?: number;
+    protein_g?: number;
+}
+interface AttributionModule {
+    url?: string;
+    author?: string;
+    datePublished?: string;
+}
+interface TaxonomyModule {
+    keywords?: string[];
+    category?: string;
+    cuisine?: string;
+}
+interface MediaModule {
+    images?: string[];
+    videos?: string[];
+}
+interface TimesModule {
+    prepMinutes?: number;
+    cookMinutes?: number;
+    totalMinutes?: number;
 }
 
 interface ScaleRecipeOptions {
@@ -228,7 +254,7 @@ interface ScaleRecipeOptions {
 }
 declare function scaleRecipe(recipe: Recipe, options?: ScaleRecipeOptions): Recipe;
 
-type ProfileName = "base" | "cookable" | "scalable" | "quantified" | "illustrated" | "schedulable";
+type ProfileName = "minimal" | "core";
 interface NormalizedError {
     path: string;
     message: string;
@@ -276,6 +302,7 @@ interface SchemaOrgRecipe$1 {
     datePublished?: string;
     dateModified?: string;
     nutrition?: NutritionInformation;
+    video?: SchemaOrgImage;
     '@graph'?: unknown;
 }
 type SchemaOrgIngredientList = string | string[];
@@ -321,6 +348,14 @@ interface NutritionInformation {
     [key: string]: string | number | null | undefined;
 }
 
+/**
+ * Convert a Soustack recipe to Schema.org JSON-LD format.
+ *
+ * BREAKING CHANGE in v0.3.0: This function now targets the "minimal" profile
+ * and only includes modules that are schemaOrgMappable (as defined in the
+ * modules registry). Non-mappable modules (e.g., nutrition@1, schedule@1)
+ * are excluded from the conversion.
+ */
 declare function toSchemaOrg(recipe: Recipe): SchemaOrgRecipe$1;
 
 interface HowToStep {
@@ -348,6 +383,69 @@ interface SchemaOrgRecipe {
 
 declare function extractSchemaOrgRecipeFromHTML(html: string): SchemaOrgRecipe | null;
 
-declare const SOUSTACK_SPEC_VERSION = "0.2.1";
+declare const SOUSTACK_SPEC_VERSION = "0.3.0";
+
+type ConvertTarget = 'metric';
+type ConvertMode = 'volume' | 'mass';
+type RoundMode = 'none' | 'sane';
+interface LineItem {
+    ingredient: string;
+    quantity: number;
+    unit: string | null;
+}
+interface ConvertedLineItem extends LineItem {
+    notes?: string;
+}
+declare class UnknownUnitError extends Error {
+    readonly unit: string;
+    constructor(unit: string);
+}
+declare class UnsupportedConversionError extends Error {
+    readonly unit: string;
+    readonly mode: ConvertMode;
+    constructor(unit: string, mode: ConvertMode);
+}
+declare class MissingEquivalencyError extends Error {
+    readonly ingredient: string;
+    readonly unit: string;
+    constructor(ingredient: string, unit: string);
+}
+declare function convertLineItemToMetric(item: LineItem, mode: ConvertMode, opts?: {
+    round?: RoundMode;
+}): ConvertedLineItem;
+
+interface Quantity {
+    amount: number;
+    unit?: string | null;
+}
+interface Ingredient {
+    id?: string;
+    item: string;
+    quantity?: Quantity;
+    name?: string;
+    prep?: string;
+    prepAction?: string;
+    prepActions?: string[];
+    form?: string;
+    prepTime?: number;
+    optional?: boolean;
+    notes?: string;
+}
+interface MiseEnPlaceTask {
+    category: 'prep' | 'state' | 'measure' | 'other';
+    action?: string;
+    form?: string;
+    items: Array<{
+        ingredient: string;
+        quantity?: Quantity;
+        optional?: boolean;
+        notes?: string;
+    }>;
+}
+interface MiseEnPlacePlan {
+    tasks: MiseEnPlaceTask[];
+    ungrouped: Ingredient[];
+}
+declare function miseEnPlace(ingredients: Ingredient[]): MiseEnPlacePlan;
 
-export { type Alternative, type Equipment, type FrozenStorageMethod, type Ingredient, type IngredientItem, type IngredientSubsection, type Instruction, type InstructionItem, type InstructionSubsection, type MakeAheadComponent, type NutritionFacts, type ParsedIngredient, type ParsedYield, type Quantity, type Recipe, SOUSTACK_SPEC_VERSION, type Scaling, type ScalingBakersPercentage, type ScalingBase, type ScalingDiscrete, type ScalingFixed, type ScalingLinear, type ScalingProportional, type SimpleTime, type Source, type SoustackInstruction, type SoustackRecipe, type StepTiming, type Storage, type StorageMethod, type StructuredTime, type Substitution, type Time, type Yield, detectProfiles, extractSchemaOrgRecipeFromHTML, fromSchemaOrg, scaleRecipe, toSchemaOrg, validateRecipe };
+export { type Alternative, type AttributionModule, type ConvertMode, type ConvertTarget, type ConvertedLineItem, type Equipment, type FrozenStorageMethod, type Ingredient$1 as Ingredient, type IngredientItem, type IngredientSubsection, type Instruction, type InstructionItem, type InstructionSubsection, type LineItem, type MakeAheadComponent, type MediaModule, type Ingredient as MiseEnPlaceIngredient, type MiseEnPlacePlan, type Quantity as MiseEnPlaceQuantity, type MiseEnPlaceTask, MissingEquivalencyError, type NutritionFacts, type ParsedIngredient, type ParsedYield, type Quantity$1 as Quantity, type Recipe, type RoundMode, SOUSTACK_SPEC_VERSION, type Scaling, type ScalingBakersPercentage, type ScalingBase, type ScalingDiscrete, type ScalingFixed, type ScalingLinear, type ScalingProportional, type SimpleTime, type Source, type SoustackInstruction, type SoustackRecipe, type StepTiming, type Storage, type StorageMethod, type StructuredTime, type Substitution, type TaxonomyModule, type Time, type TimesModule, UnknownUnitError, UnsupportedConversionError, type Yield, convertLineItemToMetric, detectProfiles, extractSchemaOrgRecipeFromHTML, fromSchemaOrg, miseEnPlace, scaleRecipe, toSchemaOrg, validateRecipe };

package/dist/index.d.ts

@@ -1,10 +1,24 @@
 /**
- * Soustack Recipe Schema v0.2.1
+ * Soustack Recipe Schema v0.3.0
  * A portable, scalable, interoperable recipe format.
  */
 interface SoustackRecipe {
+    /** Document marker for Soustack recipes */
+    '@type'?: 'Recipe';
     /** Optional $schema pointer for profile-aware validation */
     $schema?: string;
+    /** Optional declared validation profile */
+    profile?: string;
+    /** Enabled module identifiers (e.g., "nutrition@1") */
+    modules?: string[];
+    /** Attribution module payload */
+    attribution?: AttributionModule;
+    /** Taxonomy module payload */
+    taxonomy?: TaxonomyModule;
+    /** Media module payload */
+    media?: MediaModule;
+    /** Times module payload */
+    times?: TimesModule;
     /** Unique identifier (slug or UUID) */
     id?: string;
     /** Optional display title */
@@ -77,25 +91,25 @@ interface Equipment {
     name: string;
     required?: boolean;
     label?: string;
-    capacity?: Quantity;
+    capacity?: Quantity$1;
     scalingLimit?: number;
     alternatives?: string[];
 }
-interface Quantity {
+interface Quantity$1 {
     amount: number;
     /** Unit string (e.g. "g", "cup") or null for count-based items (e.g. "2 eggs") */
     unit: string | null;
 }
-type IngredientItem = string | Ingredient | IngredientSubsection;
+type IngredientItem = string | Ingredient$1 | IngredientSubsection;
 interface IngredientSubsection {
     subsection: string;
-    items: (string | Ingredient)[];
+    items: (string | Ingredient$1)[];
 }
-interface Ingredient {
+interface Ingredient$1 {
     id?: string;
     /** Full human-readable text (e.g. "2 cups flour") */
     item: string;
-    quantity?: Quantity;
+    quantity?: Quantity$1;
     name?: string;
     aisle?: string;
     /** Required prep state (e.g. "diced") */
@@ -208,15 +222,27 @@ interface Alternative {
     dietary?: string[];
 }
 interface NutritionFacts {
-    calories?: string;
-    fatContent?: string;
-    carbohydrateContent?: string;
-    proteinContent?: string;
-    fiberContent?: string;
-    sugarContent?: string;
-    sodiumContent?: string;
-    servingSize?: string;
-    [key: string]: string | number | null | string[] | undefined;
+    calories?: number;
+    protein_g?: number;
+}
+interface AttributionModule {
+    url?: string;
+    author?: string;
+    datePublished?: string;
+}
+interface TaxonomyModule {
+    keywords?: string[];
+    category?: string;
+    cuisine?: string;
+}
+interface MediaModule {
+    images?: string[];
+    videos?: string[];
+}
+interface TimesModule {
+    prepMinutes?: number;
+    cookMinutes?: number;
+    totalMinutes?: number;
 }
 
 interface ScaleRecipeOptions {
@@ -228,7 +254,7 @@ interface ScaleRecipeOptions {
 }
 declare function scaleRecipe(recipe: Recipe, options?: ScaleRecipeOptions): Recipe;
 
-type ProfileName = "base" | "cookable" | "scalable" | "quantified" | "illustrated" | "schedulable";
+type ProfileName = "minimal" | "core";
 interface NormalizedError {
     path: string;
     message: string;
@@ -276,6 +302,7 @@ interface SchemaOrgRecipe$1 {
     datePublished?: string;
     dateModified?: string;
     nutrition?: NutritionInformation;
+    video?: SchemaOrgImage;
     '@graph'?: unknown;
 }
 type SchemaOrgIngredientList = string | string[];
@@ -321,6 +348,14 @@ interface NutritionInformation {
     [key: string]: string | number | null | undefined;
 }
 
+/**
+ * Convert a Soustack recipe to Schema.org JSON-LD format.
+ *
+ * BREAKING CHANGE in v0.3.0: This function now targets the "minimal" profile
+ * and only includes modules that are schemaOrgMappable (as defined in the
+ * modules registry). Non-mappable modules (e.g., nutrition@1, schedule@1)
+ * are excluded from the conversion.
+ */
 declare function toSchemaOrg(recipe: Recipe): SchemaOrgRecipe$1;
 
 interface HowToStep {
@@ -348,6 +383,69 @@ interface SchemaOrgRecipe {
 
 declare function extractSchemaOrgRecipeFromHTML(html: string): SchemaOrgRecipe | null;
 
-declare const SOUSTACK_SPEC_VERSION = "0.2.1";
+declare const SOUSTACK_SPEC_VERSION = "0.3.0";
+
+type ConvertTarget = 'metric';
+type ConvertMode = 'volume' | 'mass';
+type RoundMode = 'none' | 'sane';
+interface LineItem {
+    ingredient: string;
+    quantity: number;
+    unit: string | null;
+}
+interface ConvertedLineItem extends LineItem {
+    notes?: string;
+}
+declare class UnknownUnitError extends Error {
+    readonly unit: string;
+    constructor(unit: string);
+}
+declare class UnsupportedConversionError extends Error {
+    readonly unit: string;
+    readonly mode: ConvertMode;
+    constructor(unit: string, mode: ConvertMode);
+}
+declare class MissingEquivalencyError extends Error {
+    readonly ingredient: string;
+    readonly unit: string;
+    constructor(ingredient: string, unit: string);
+}
+declare function convertLineItemToMetric(item: LineItem, mode: ConvertMode, opts?: {
+    round?: RoundMode;
+}): ConvertedLineItem;
+
+interface Quantity {
+    amount: number;
+    unit?: string | null;
+}
+interface Ingredient {
+    id?: string;
+    item: string;
+    quantity?: Quantity;
+    name?: string;
+    prep?: string;
+    prepAction?: string;
+    prepActions?: string[];
+    form?: string;
+    prepTime?: number;
+    optional?: boolean;
+    notes?: string;
+}
+interface MiseEnPlaceTask {
+    category: 'prep' | 'state' | 'measure' | 'other';
+    action?: string;
+    form?: string;
+    items: Array<{
+        ingredient: string;
+        quantity?: Quantity;
+        optional?: boolean;
+        notes?: string;
+    }>;
+}
+interface MiseEnPlacePlan {
+    tasks: MiseEnPlaceTask[];
+    ungrouped: Ingredient[];
+}
+declare function miseEnPlace(ingredients: Ingredient[]): MiseEnPlacePlan;
 
-export { type Alternative, type Equipment, type FrozenStorageMethod, type Ingredient, type IngredientItem, type IngredientSubsection, type Instruction, type InstructionItem, type InstructionSubsection, type MakeAheadComponent, type NutritionFacts, type ParsedIngredient, type ParsedYield, type Quantity, type Recipe, SOUSTACK_SPEC_VERSION, type Scaling, type ScalingBakersPercentage, type ScalingBase, type ScalingDiscrete, type ScalingFixed, type ScalingLinear, type ScalingProportional, type SimpleTime, type Source, type SoustackInstruction, type SoustackRecipe, type StepTiming, type Storage, type StorageMethod, type StructuredTime, type Substitution, type Time, type Yield, detectProfiles, extractSchemaOrgRecipeFromHTML, fromSchemaOrg, scaleRecipe, toSchemaOrg, validateRecipe };
+export { type Alternative, type AttributionModule, type ConvertMode, type ConvertTarget, type ConvertedLineItem, type Equipment, type FrozenStorageMethod, type Ingredient$1 as Ingredient, type IngredientItem, type IngredientSubsection, type Instruction, type InstructionItem, type InstructionSubsection, type LineItem, type MakeAheadComponent, type MediaModule, type Ingredient as MiseEnPlaceIngredient, type MiseEnPlacePlan, type Quantity as MiseEnPlaceQuantity, type MiseEnPlaceTask, MissingEquivalencyError, type NutritionFacts, type ParsedIngredient, type ParsedYield, type Quantity$1 as Quantity, type Recipe, type RoundMode, SOUSTACK_SPEC_VERSION, type Scaling, type ScalingBakersPercentage, type ScalingBase, type ScalingDiscrete, type ScalingFixed, type ScalingLinear, type ScalingProportional, type SimpleTime, type Source, type SoustackInstruction, type SoustackRecipe, type StepTiming, type Storage, type StorageMethod, type StructuredTime, type Substitution, type TaxonomyModule, type Time, type TimesModule, UnknownUnitError, UnsupportedConversionError, type Yield, convertLineItemToMetric, detectProfiles, extractSchemaOrgRecipeFromHTML, fromSchemaOrg, miseEnPlace, scaleRecipe, toSchemaOrg, validateRecipe };