@soustack/spec 0.0.2

package/defs/duration.schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://spec.soustack.org/defs/duration.schema.json",
+  "title": "Durations",
+  "type": "object",
+  "properties": {
+    "DurationMinutes": {
+      "type": "object",
+      "properties": {
+        "minutes": { "type": "number", "exclusiveMinimum": 0 },
+        "metadata": { "type": "object", "additionalProperties": true }
+      },
+      "required": ["minutes"],
+      "additionalProperties": false,
+      "patternProperties": {
+        "^x-": { "$ref": "./common.schema.json#/properties/extensionLaneValue" }
+      }
+    },
+    "StorageDuration": {
+      "type": "object",
+      "properties": {
+        "iso8601": { "type": "string", "pattern": "^P" },
+        "metadata": { "type": "object", "additionalProperties": true }
+      },
+      "required": ["iso8601"],
+      "additionalProperties": false,
+      "patternProperties": {
+        "^x-": { "$ref": "./common.schema.json#/properties/extensionLaneValue" }
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/defs/entities.schema.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://spec.soustack.org/defs/entities.schema.json",
+  "title": "Soustack entity bases",
+  "type": "object",
+  "$defs": {
+    "IngredientBase": {
+      "type": "object",
+      "properties": {
+        "id": { "type": "string" },
+        "name": { "type": "string" },
+        "quantity": { "$ref": "./quantity.schema.json" },
+        "temperature": { "$ref": "./temperature.schema.json" },
+        "notes": { "type": "string" },
+        "prep": {
+          "oneOf": [
+            { "type": "string", "minLength": 1 },
+            {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "anyOf": [
+                  { "type": "string", "minLength": 1 },
+                  { "$ref": "../stacks/prep.schema.json#/$defs/prepItem" }
+                ]
+              }
+            }
+          ]
+        },
+        "metadata": { "type": "object", "additionalProperties": true },
+        "scaling": { "$ref": "./scalingRule.schema.json" }
+      },
+      "required": ["name"],
+      "additionalProperties": false,
+      "patternProperties": {
+        "^x-": { "$ref": "./common.schema.json#/properties/extensionLaneValue" }
+      }
+    },
+    "StepBase": {
+      "type": "object",
+      "properties": {
+        "id": { "type": "string" },
+        "text": { "type": "string" },
+        "dependsOn": {
+          "type": "array",
+          "items": { "type": "string" },
+          "uniqueItems": true
+        },
+        "inputs": {
+          "type": "array",
+          "items": { "type": "string" },
+          "uniqueItems": true
+        },
+        "techniqueIds": {
+          "type": "array",
+          "items": { "type": "string" },
+          "uniqueItems": true
+        },
+        "usesEquipment": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[A-Za-z0-9._-]+$"
+          },
+          "uniqueItems": true
+        },
+        "temperature": { "$ref": "./temperature.schema.json" },
+        "timing": {
+          "type": "object",
+          "properties": {
+            "activity": { "type": "string", "enum": ["active", "passive"] },
+            "duration": {
+              "type": "object",
+              "oneOf": [
+                { "$ref": "./duration.schema.json#/properties/DurationMinutes" },
+                {
+                  "type": "object",
+                  "properties": {
+                    "minMinutes": { "type": "number", "exclusiveMinimum": 0 },
+                    "maxMinutes": { "type": "number", "exclusiveMinimum": 0 }
+                  },
+                  "required": ["minMinutes", "maxMinutes"],
+                  "additionalProperties": false
+                }
+              ]
+            },
+            "completionCue": { "type": "string" },
+            "metadata": { "type": "object", "additionalProperties": true }
+          },
+          "anyOf": [
+            { "required": ["duration"] },
+            { "required": ["completionCue"] }
+          ],
+          "additionalProperties": false,
+          "patternProperties": {
+            "^x-": { "$ref": "./common.schema.json#/properties/extensionLaneValue" }
+          }
+        },
+        "images": { "type": "array", "items": { "$ref": "./common.schema.json#/properties/uri" } },
+        "videos": { "type": "array", "items": { "$ref": "./common.schema.json#/properties/uri" } },
+        "metadata": { "type": "object", "additionalProperties": true }
+      },
+      "required": ["text"],
+      "additionalProperties": false,
+      "patternProperties": {
+        "^x-": { "$ref": "./common.schema.json#/properties/extensionLaneValue" }
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/defs/ingredientQuantified.schema.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://spec.soustack.org/defs/ingredientQuantified.schema.json",
+  "title": "Quantified Ingredient",
+  "allOf": [
+    { "$ref": "./entities.schema.json#/$defs/IngredientBase" },
+    { "required": ["id", "quantity"] }
+  ]
+}

package/defs/quantity.schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://spec.soustack.org/defs/quantity.schema.json",
+  "title": "Quantity",
+  "type": "object",
+  "properties": {
+    "amount": { "type": "number" },
+    "unit": { "type": "string", "minLength": 1 },
+    "metadata": { "type": "object", "additionalProperties": true }
+  },
+  "required": ["amount", "unit"],
+  "additionalProperties": false,
+  "patternProperties": {
+    "^x-": { "$ref": "./common.schema.json#/properties/extensionLaneValue" }
+  }
+}

package/defs/scalingRule.schema.json

@@ -0,0 +1,127 @@
+{
+"$id": "https://spec.soustack.org/defs/scalingRule.schema.json",
+"$schema": "https://json-schema.org/draft/2020-12/schema",
+"title": "Soustack ScalingRule",
+"type": "object",
+"additionalProperties": false,
+"required": ["mode"],
+"properties": {
+"mode": {
+"type": "string",
+"enum": ["linear", "fixed", "discrete", "toTaste", "bakersPercent"]
+},
+
+"step": {
+  "type": "number",
+  "exclusiveMinimum": 0
+},
+"rounding": {
+  "type": "string",
+  "enum": ["nearest", "ceil", "floor"]
+},
+"min": {
+  "type": "number"
+},
+"max": {
+  "type": "number"
+},
+
+"percent": {
+  "type": "number",
+  "exclusiveMinimum": 0
+},
+"of": {
+  "type": "string",
+  "minLength": 1
+}
+
+},
+
+"allOf": [
+{
+"if": {
+"properties": { "mode": { "const": "linear" } },
+"required": ["mode"]
+},
+"then": {
+"not": {
+"anyOf": [
+{ "required": ["step"] },
+{ "required": ["rounding"] },
+{ "required": ["min"] },
+{ "required": ["max"] },
+{ "required": ["percent"] },
+{ "required": ["of"] }
+]
+}
+}
+},
+{
+"if": {
+"properties": { "mode": { "const": "fixed" } },
+"required": ["mode"]
+},
+"then": {
+"not": {
+"anyOf": [
+{ "required": ["step"] },
+{ "required": ["rounding"] },
+{ "required": ["min"] },
+{ "required": ["max"] },
+{ "required": ["percent"] },
+{ "required": ["of"] }
+]
+}
+}
+},
+{
+"if": {
+"properties": { "mode": { "const": "toTaste" } },
+"required": ["mode"]
+},
+"then": {
+"not": {
+"anyOf": [
+{ "required": ["step"] },
+{ "required": ["rounding"] },
+{ "required": ["min"] },
+{ "required": ["max"] },
+{ "required": ["percent"] },
+{ "required": ["of"] }
+]
+}
+}
+},
+{
+"if": {
+"properties": { "mode": { "const": "discrete" } },
+"required": ["mode"]
+},
+"then": {
+"not": {
+"anyOf": [
+{ "required": ["percent"] },
+{ "required": ["of"] }
+]
+}
+}
+},
+{
+"if": {
+"properties": { "mode": { "const": "bakersPercent" } },
+"required": ["mode"]
+},
+"then": {
+"required": ["percent", "of"],
+"not": {
+"anyOf": [
+{ "required": ["step"] },
+{ "required": ["rounding"] },
+{ "required": ["min"] },
+{ "required": ["max"] }
+]
+}
+}
+}
+]
+}

package/defs/temperature.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://spec.soustack.org/defs/temperature.schema.json",
+  "title": "Temperature",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "target": {
+          "type": "string",
+          "enum": ["oven", "stovetop", "pan", "oil", "water", "grill", "broiler", "internal", "ambient", "surface"]
+        },
+        "level": {
+          "type": "string",
+          "enum": ["veryLow", "low", "medium", "mediumHigh", "high", "veryHigh"]
+        },
+        "metadata": { "type": "object", "additionalProperties": true }
+      },
+      "required": ["target", "level"],
+      "additionalProperties": false,
+      "patternProperties": {
+        "^x-": { "$ref": "./common.schema.json#/properties/extensionLaneValue" }
+      }
+    },
+    {
+      "type": "object",
+      "properties": {
+        "target": {
+          "type": "string",
+          "enum": ["oven", "stovetop", "pan", "oil", "water", "grill", "broiler", "internal", "ambient", "surface"]
+        },
+        "unit": { "type": "string", "enum": ["celsius", "fahrenheit"] },
+        "value": { "type": "number" },
+        "approximate": { "type": "boolean" },
+        "metadata": { "type": "object", "additionalProperties": true }
+      },
+      "required": ["target", "unit", "value"],
+      "additionalProperties": false,
+      "patternProperties": {
+        "^x-": { "$ref": "./common.schema.json#/properties/extensionLaneValue" }
+      }
+    },
+    {
+      "type": "object",
+      "properties": {
+        "target": {
+          "type": "string",
+          "enum": ["oven", "stovetop", "pan", "oil", "water", "grill", "broiler", "internal", "ambient", "surface"]
+        },
+        "unit": { "type": "string", "enum": ["celsius", "fahrenheit"] },
+        "minValue": { "type": "number" },
+        "maxValue": { "type": "number" },
+        "metadata": { "type": "object", "additionalProperties": true }
+      },
+      "required": ["target", "unit", "minValue", "maxValue"],
+      "additionalProperties": false,
+      "patternProperties": {
+        "^x-": { "$ref": "./common.schema.json#/properties/extensionLaneValue" }
+      }
+    }
+  ]
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export declare const SOUSTACK_SPEC_VERSION = "0.0.2";
+export declare const ROOT_SCHEMA_PATH = "soustack.schema.json";
+export declare const STACKS_REGISTRY_PATH = "stacks/registry.json";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,UAAU,CAAC;AAC7C,eAAO,MAAM,gBAAgB,yBAAyB,CAAC;AACvD,eAAO,MAAM,oBAAoB,yBAAyB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export const SOUSTACK_SPEC_VERSION = "0.0.2";
+export const ROOT_SCHEMA_PATH = "soustack.schema.json";
+export const STACKS_REGISTRY_PATH = "stacks/registry.json";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAC7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,sBAAsB,CAAC;AACvD,MAAM,CAAC,MAAM,oBAAoB,GAAG,sBAAsB,CAAC"}

package/fixtures/content/illustrated-step.valid.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "structured": 1,
+    "illustrated": 1
+  },
+  "name": "Picture Smoothie",
+  "ingredients": [
+    "fruit",
+    "yogurt"
+  ],
+  "instructions": [
+    {
+      "id": "s1",
+      "text": "blend",
+      "images": [
+        "http://example.com/blend.jpg"
+      ]
+    }
+  ],
+  "images": [
+    "http://example.com/cover2.jpg"
+  ]
+}

package/fixtures/invalid/equipment-unknown-reference.invalid.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "equipment": 1,
+    "structured": 1
+  },
+  "name": "Recipe with Invalid Equipment Reference",
+  "yield": {
+    "amount": 1,
+    "unit": "serving"
+  },
+  "time": {
+    "total": {
+      "minutes": 30
+    }
+  },
+  "equipment": [
+    {
+      "id": "skillet",
+      "name": "8-inch skillet"
+    }
+  ],
+  "ingredients": [
+    {
+      "id": "meat",
+      "name": "Meat"
+    }
+  ],
+  "instructions": [
+    {
+      "id": "sear",
+      "text": "Sear the meat",
+      "usesEquipment": [
+        "nonexistent"
+      ]
+    }
+  ]
+}

package/fixtures/invalid/mise-en-place-unknown-equipment.invalid.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "prep": 1,
+    "equipment": 1
+  },
+  "name": "Recipe with Unknown Equipment Reference",
+  "yield": {
+    "amount": 1,
+    "unit": "serving"
+  },
+  "time": {
+    "total": {
+      "minutes": 30
+    }
+  },
+  "equipment": [
+    {
+      "id": "knife",
+      "name": "Chef's knife"
+    }
+  ],
+  "ingredients": [
+    "onion"
+  ],
+  "instructions": [
+    "Cook"
+  ],
+  "miseEnPlace": [
+    {
+      "text": "Use the missing equipment",
+      "usesEquipment": [
+        "missing-equipment"
+      ]
+    }
+  ]
+}

package/fixtures/invalid/mise-en-place-unknown-input.invalid.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "prep": 1,
+    "referenced": 1,
+    "structured": 1
+  },
+  "name": "Recipe with Unknown Input Reference",
+  "yield": {
+    "amount": 1,
+    "unit": "serving"
+  },
+  "time": {
+    "total": {
+      "minutes": 30
+    }
+  },
+  "ingredients": [
+    {
+      "id": "onion",
+      "name": "Onion"
+    }
+  ],
+  "instructions": [
+    {
+      "id": "cook",
+      "text": "Cook",
+      "inputs": [
+        "onion"
+      ]
+    }
+  ],
+  "miseEnPlace": [
+    {
+      "text": "Prepare the missing ingredient",
+      "inputs": [
+        "missing-ingredient"
+      ]
+    }
+  ]
+}

package/fixtures/invalid/storage-leftovers-missing-method.invalid.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "storage": 1
+  },
+  "name": "Recipe with Invalid Reheat Instruction",
+  "ingredients": [
+    "food"
+  ],
+  "instructions": [
+    "Cook the food"
+  ],
+  "storage": {
+    "refrigerated": {
+      "duration": {
+        "iso8601": "P3D"
+      }
+    },
+    "leftovers": {
+      "reheat": [
+        {
+          "duration": {
+            "minMinutes": 2,
+            "maxMinutes": 3
+          },
+          "notes": "Missing required method field"
+        }
+      ]
+    }
+  }
+}

package/fixtures/invalid/storage-leftovers-wrong-type.invalid.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "storage": 1
+  },
+  "name": "Recipe with Wrong Reheat Type",
+  "ingredients": [
+    "food"
+  ],
+  "instructions": [
+    "Cook the food"
+  ],
+  "storage": {
+    "refrigerated": {
+      "duration": {
+        "iso8601": "P3D"
+      }
+    },
+    "leftovers": {
+      "reheat": "Microwave 2\u20133 minutes"
+    }
+  }
+}