soustack 0.4.0 → 0.4.1

package/dist/scrape/index.d.mts

@@ -1,5 +1,5 @@
 /**
- * Soustack Recipe Schema v0.3.0
+ * Soustack Recipe Schema v0.0.2
  * A portable, scalable, interoperable recipe format.
  */
 interface SoustackRecipe {
@@ -7,20 +7,10 @@ interface SoustackRecipe {
     '@type'?: 'Recipe';
     /** Optional $schema pointer for profile-aware validation */
     $schema?: string;
-    /** Optional declared validation profile */
-    profile?: string;
-    /** Recipe level: "lite" or "base" */
-    level?: "lite" | "base";
+    /** Optional declared validation profile (vNext only) */
+    profile?: "base" | "equipped" | "illustrated" | "lite" | "prepped" | "scalable" | "timed";
     /** Stack declarations as a map: Record<stackName, versionNumber> */
     stacks?: Record<string, number>;
-    /** Attribution stack payload */
-    attribution?: AttributionModule;
-    /** Taxonomy stack payload */
-    taxonomy?: TaxonomyModule;
-    /** Media stack payload */
-    media?: MediaModule;
-    /** Times stack payload */
-    times?: TimesModule;
     /** Unique identifier (slug or UUID) */
     id?: string;
     /** Optional display title */
@@ -37,6 +27,10 @@ interface SoustackRecipe {
     /** Additional tags for filtering */
     tags?: string[];
     /** URL(s) to recipe image(s) */
+    images?: string[];
+    /** URL(s) to recipe video(s) */
+    videos?: string[];
+    /** Legacy image field preserved for compatibility */
     image?: string | string[];
     /** ISO 8601 date string */
     dateAdded?: string;
@@ -68,19 +62,18 @@ interface Yield {
     description?: string;
 }
 /**
- * Time can be structured (machine-readable) or simple (strings).
- * Structured time takes precedence if both exist.
+ * Time uses DurationMinutes format (vNext).
+ * Required total field with minutes.
  */
-type Time = StructuredTime | SimpleTime;
-interface StructuredTime {
-    prep?: number;
-    active?: number;
-    passive?: number;
-    total?: number;
-}
-interface SimpleTime {
-    prepTime?: string;
-    cookTime?: string;
+interface Time {
+    total: DurationMinutes;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
+}
+interface DurationMinutes {
+    minutes: number;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 interface Equipment {
     id?: string;
@@ -90,87 +83,119 @@ interface Equipment {
     capacity?: Quantity;
     scalingLimit?: number;
     alternatives?: string[];
+    count?: number;
+    countScaling?: EquipmentCountScaling;
+    upgrades?: EquipmentUpgradeRule[];
 }
 interface Quantity {
     amount: number;
     /** Unit string (e.g. "g", "cup") or null for count-based items (e.g. "2 eggs") */
     unit: string | null;
 }
+type EquipmentCountScaling = 'fixed' | 'linear' | EquipmentThresholdScaling;
+interface EquipmentThresholdScaling {
+    mode: 'threshold';
+    steps: EquipmentThresholdStep[];
+}
+interface EquipmentThresholdStep {
+    maxFactor: number;
+    count: number;
+}
+interface EquipmentUpgradeRule {
+    minFactor: number;
+    use: string;
+}
 type IngredientItem = string | Ingredient | IngredientSubsection;
 interface IngredientSubsection {
-    subsection: string;
-    items: (string | Ingredient)[];
+    section: string;
+    ingredients: IngredientItem[];
 }
 interface Ingredient {
     id?: string;
-    /** Full human-readable text (e.g. "2 cups flour") */
-    item: string;
+    /** Ingredient name (required in vNext) */
+    name: string;
     quantity?: Quantity;
-    name?: string;
-    aisle?: string;
-    /** Required prep state (e.g. "diced") */
-    prep?: string;
-    prepAction?: string;
-    prepTime?: number;
+    /** Required prep state (e.g. "diced") or array of prep items */
+    prep?: string | string[];
     /** ID of equipment where this ingredient goes */
     destination?: string;
     scaling?: Scaling;
-    critical?: boolean;
     optional?: boolean;
     notes?: string;
+    temperature?: Temperature;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 /**
- * Intelligent Scaling Logic
+ * Intelligent Scaling Logic (vNext format)
  * Defines how an ingredient behaves when the recipe yield changes.
  */
-type Scaling = ScalingLinear | ScalingDiscrete | ScalingProportional | ScalingFixed | ScalingBakersPercentage;
+type Scaling = ScalingLinear | ScalingDiscrete | ScalingProportional | ScalingFixed | ScalingToTaste | ScalingBakersPercentage;
 interface ScalingBase {
     min?: number;
     max?: number;
 }
 interface ScalingLinear extends ScalingBase {
-    type: "linear";
+    mode: "linear";
 }
 interface ScalingDiscrete extends ScalingBase {
-    type: "discrete";
-    roundTo?: number;
+    mode: "discrete";
+    step?: number;
+    rounding?: "nearest" | "ceil" | "floor";
 }
 interface ScalingProportional extends ScalingBase {
-    type: "proportional";
+    mode: "proportional";
     factor?: number;
 }
 interface ScalingFixed extends ScalingBase {
-    type: "fixed";
+    mode: "fixed";
+}
+interface ScalingToTaste {
+    mode: "toTaste";
 }
-interface ScalingBakersPercentage extends ScalingBase {
-    type: 'bakers_percentage';
+interface ScalingBakersPercentage {
+    mode: "bakersPercent";
+    /** The percentage relative to the reference (e.g. 2 for 2%) */
+    percent: number;
     /** The ID of the flour/base ingredient this is relative to */
-    referenceId: string;
-    /** The percentage relative to the reference (e.g. 0.02 for 2%) */
-    factor?: number;
+    of: string;
 }
 type InstructionItem = string | Instruction | InstructionSubsection;
 interface InstructionSubsection {
-    subsection: string;
-    items: (string | Instruction)[];
+    section: string;
+    steps: InstructionItem[];
 }
 interface SoustackInstruction {
     id?: string;
     text: string;
-    destination?: string;
     /** IDs of steps that must complete before this one starts */
     dependsOn?: string[];
     /** IDs of ingredients used in this step */
     inputs?: string[];
+    /** IDs of techniques used in this step */
+    techniqueIds?: string[];
+    /** IDs of equipment used in this step */
+    usesEquipment?: string[];
     timing?: StepTiming;
-    /** Optional image URL for this instruction */
-    image?: string;
+    temperature?: Temperature;
+    images?: string[];
+    videos?: string[];
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 type Instruction = SoustackInstruction;
 interface StepTiming {
-    duration: number | string;
-    type: "active" | "passive";
-    scaling?: "linear" | "fixed" | "sqrt";
+    activity: "active" | "passive";
+    duration?: DurationMinutes | DurationRange;
+    completionCue?: string;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
+}
+interface DurationRange {
+    minMinutes: number;
+    maxMinutes: number;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 interface Storage {
     roomTemp?: StorageMethod;
@@ -209,24 +234,11 @@ interface NutritionFacts {
     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 Temperature {
+    value: number;
+    unit: "celsius" | "fahrenheit";
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 
 interface HowToStep {

package/dist/scrape/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Soustack Recipe Schema v0.3.0
+ * Soustack Recipe Schema v0.0.2
  * A portable, scalable, interoperable recipe format.
  */
 interface SoustackRecipe {
@@ -7,20 +7,10 @@ interface SoustackRecipe {
     '@type'?: 'Recipe';
     /** Optional $schema pointer for profile-aware validation */
     $schema?: string;
-    /** Optional declared validation profile */
-    profile?: string;
-    /** Recipe level: "lite" or "base" */
-    level?: "lite" | "base";
+    /** Optional declared validation profile (vNext only) */
+    profile?: "base" | "equipped" | "illustrated" | "lite" | "prepped" | "scalable" | "timed";
     /** Stack declarations as a map: Record<stackName, versionNumber> */
     stacks?: Record<string, number>;
-    /** Attribution stack payload */
-    attribution?: AttributionModule;
-    /** Taxonomy stack payload */
-    taxonomy?: TaxonomyModule;
-    /** Media stack payload */
-    media?: MediaModule;
-    /** Times stack payload */
-    times?: TimesModule;
     /** Unique identifier (slug or UUID) */
     id?: string;
     /** Optional display title */
@@ -37,6 +27,10 @@ interface SoustackRecipe {
     /** Additional tags for filtering */
     tags?: string[];
     /** URL(s) to recipe image(s) */
+    images?: string[];
+    /** URL(s) to recipe video(s) */
+    videos?: string[];
+    /** Legacy image field preserved for compatibility */
     image?: string | string[];
     /** ISO 8601 date string */
     dateAdded?: string;
@@ -68,19 +62,18 @@ interface Yield {
     description?: string;
 }
 /**
- * Time can be structured (machine-readable) or simple (strings).
- * Structured time takes precedence if both exist.
+ * Time uses DurationMinutes format (vNext).
+ * Required total field with minutes.
  */
-type Time = StructuredTime | SimpleTime;
-interface StructuredTime {
-    prep?: number;
-    active?: number;
-    passive?: number;
-    total?: number;
-}
-interface SimpleTime {
-    prepTime?: string;
-    cookTime?: string;
+interface Time {
+    total: DurationMinutes;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
+}
+interface DurationMinutes {
+    minutes: number;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 interface Equipment {
     id?: string;
@@ -90,87 +83,119 @@ interface Equipment {
     capacity?: Quantity;
     scalingLimit?: number;
     alternatives?: string[];
+    count?: number;
+    countScaling?: EquipmentCountScaling;
+    upgrades?: EquipmentUpgradeRule[];
 }
 interface Quantity {
     amount: number;
     /** Unit string (e.g. "g", "cup") or null for count-based items (e.g. "2 eggs") */
     unit: string | null;
 }
+type EquipmentCountScaling = 'fixed' | 'linear' | EquipmentThresholdScaling;
+interface EquipmentThresholdScaling {
+    mode: 'threshold';
+    steps: EquipmentThresholdStep[];
+}
+interface EquipmentThresholdStep {
+    maxFactor: number;
+    count: number;
+}
+interface EquipmentUpgradeRule {
+    minFactor: number;
+    use: string;
+}
 type IngredientItem = string | Ingredient | IngredientSubsection;
 interface IngredientSubsection {
-    subsection: string;
-    items: (string | Ingredient)[];
+    section: string;
+    ingredients: IngredientItem[];
 }
 interface Ingredient {
     id?: string;
-    /** Full human-readable text (e.g. "2 cups flour") */
-    item: string;
+    /** Ingredient name (required in vNext) */
+    name: string;
     quantity?: Quantity;
-    name?: string;
-    aisle?: string;
-    /** Required prep state (e.g. "diced") */
-    prep?: string;
-    prepAction?: string;
-    prepTime?: number;
+    /** Required prep state (e.g. "diced") or array of prep items */
+    prep?: string | string[];
     /** ID of equipment where this ingredient goes */
     destination?: string;
     scaling?: Scaling;
-    critical?: boolean;
     optional?: boolean;
     notes?: string;
+    temperature?: Temperature;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 /**
- * Intelligent Scaling Logic
+ * Intelligent Scaling Logic (vNext format)
  * Defines how an ingredient behaves when the recipe yield changes.
  */
-type Scaling = ScalingLinear | ScalingDiscrete | ScalingProportional | ScalingFixed | ScalingBakersPercentage;
+type Scaling = ScalingLinear | ScalingDiscrete | ScalingProportional | ScalingFixed | ScalingToTaste | ScalingBakersPercentage;
 interface ScalingBase {
     min?: number;
     max?: number;
 }
 interface ScalingLinear extends ScalingBase {
-    type: "linear";
+    mode: "linear";
 }
 interface ScalingDiscrete extends ScalingBase {
-    type: "discrete";
-    roundTo?: number;
+    mode: "discrete";
+    step?: number;
+    rounding?: "nearest" | "ceil" | "floor";
 }
 interface ScalingProportional extends ScalingBase {
-    type: "proportional";
+    mode: "proportional";
     factor?: number;
 }
 interface ScalingFixed extends ScalingBase {
-    type: "fixed";
+    mode: "fixed";
+}
+interface ScalingToTaste {
+    mode: "toTaste";
 }
-interface ScalingBakersPercentage extends ScalingBase {
-    type: 'bakers_percentage';
+interface ScalingBakersPercentage {
+    mode: "bakersPercent";
+    /** The percentage relative to the reference (e.g. 2 for 2%) */
+    percent: number;
     /** The ID of the flour/base ingredient this is relative to */
-    referenceId: string;
-    /** The percentage relative to the reference (e.g. 0.02 for 2%) */
-    factor?: number;
+    of: string;
 }
 type InstructionItem = string | Instruction | InstructionSubsection;
 interface InstructionSubsection {
-    subsection: string;
-    items: (string | Instruction)[];
+    section: string;
+    steps: InstructionItem[];
 }
 interface SoustackInstruction {
     id?: string;
     text: string;
-    destination?: string;
     /** IDs of steps that must complete before this one starts */
     dependsOn?: string[];
     /** IDs of ingredients used in this step */
     inputs?: string[];
+    /** IDs of techniques used in this step */
+    techniqueIds?: string[];
+    /** IDs of equipment used in this step */
+    usesEquipment?: string[];
     timing?: StepTiming;
-    /** Optional image URL for this instruction */
-    image?: string;
+    temperature?: Temperature;
+    images?: string[];
+    videos?: string[];
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 type Instruction = SoustackInstruction;
 interface StepTiming {
-    duration: number | string;
-    type: "active" | "passive";
-    scaling?: "linear" | "fixed" | "sqrt";
+    activity: "active" | "passive";
+    duration?: DurationMinutes | DurationRange;
+    completionCue?: string;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
+}
+interface DurationRange {
+    minMinutes: number;
+    maxMinutes: number;
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 interface Storage {
     roomTemp?: StorageMethod;
@@ -209,24 +234,11 @@ interface NutritionFacts {
     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 Temperature {
+    value: number;
+    unit: "celsius" | "fahrenheit";
+    metadata?: Record<string, unknown>;
+    [k: `x-${string}`]: unknown;
 }
 
 interface HowToStep {