soustack 0.3.0 → 0.4.1

package/src/defs/entities.schema.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://soustack.spec/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/src/defs/ingredientQuantified.schema.json

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

package/src/defs/quantity.schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://soustack.spec/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/src/defs/scalingRule.schema.json

@@ -0,0 +1,127 @@
+{
+"$id": "https://soustack.spec/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/src/defs/temperature.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://soustack.spec/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/src/profiles/base.schema.json

@@ -1,9 +1,9 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "http://soustack.org/schema/v0.3.0/profiles/base",
+  "$id": "http://soustack.org/schema/v0.0.2/profiles/base",
   "title": "Soustack Base Profile Schema",
   "description": "Wrapper schema that exposes the unmodified Soustack base schema.",
   "allOf": [
-    { "$ref": "http://soustack.org/schema/v0.3.0" }
+    { "$ref": "http://soustack.org/schema/v0.0.2" }
   ]
 }

package/src/profiles/equipped.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://soustack.org/schema/v0.0.2/profiles/equipped",
+  "title": "Soustack Equipped Profile Schema",
+  "description": "Profile for recipes that declare required tools/equipment.",
+  "allOf": [
+    { "$ref": "http://soustack.org/schema/v0.0.2/profiles/base" }
+  ]
+}
+

package/src/profiles/illustrated.schema.json

@@ -1,10 +1,10 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "http://soustack.org/schema/v0.3.0/profiles/illustrated",
+  "$id": "http://soustack.org/schema/v0.0.2/profiles/illustrated",
   "title": "Soustack Illustrated Profile Schema",
   "description": "Extends the base schema to guarantee at least one illustrative image.",
   "allOf": [
-    { "$ref": "http://soustack.org/schema/v0.3.0" },
+    { "$ref": "http://soustack.org/schema/v0.0.2" },
     {
       "anyOf": [
         { "required": ["image"] },
@@ -27,13 +27,13 @@
   "definitions": {
     "imageInstruction": {
       "allOf": [
-        { "$ref": "http://soustack.org/schema/v0.3.0#/definitions/instruction" },
+        { "$ref": "http://soustack.org/schema/v0.0.2#/definitions/instruction" },
         { "required": ["image"] }
       ]
     },
     "instructionSubsectionWithImage": {
       "allOf": [
-        { "$ref": "http://soustack.org/schema/v0.3.0#/definitions/instructionSubsection" },
+        { "$ref": "http://soustack.org/schema/v0.0.2#/definitions/instructionSubsection" },
         {
           "properties": {
             "items": {

package/src/profiles/lite.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://soustack.org/schema/v0.0.2/profiles/lite",
+  "title": "Soustack Lite Profile Schema",
+  "description": "Wrapper schema that exposes the unmodified Soustack base schema.",
+  "allOf": [
+    { "$ref": "http://soustack.org/schema/v0.0.2" }
+  ]
+}
+

package/src/profiles/prepped.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://soustack.org/schema/v0.0.2/profiles/prepped",
+  "title": "Soustack Prepped Profile Schema",
+  "description": "Profile for recipes that include prep guidance and/or mise en place tasks.",
+  "allOf": [
+    { "$ref": "http://soustack.org/schema/v0.0.2/profiles/base" }
+  ]
+}
+

package/src/profiles/scalable.schema.json

@@ -1,16 +1,16 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "http://soustack.org/schema/v0.3.0/profiles/scalable",
+  "$id": "http://soustack.org/schema/v0.0.2/profiles/scalable",
   "title": "Soustack Scalable Profile Schema",
   "description": "Extends the base schema to guarantee quantified ingredients plus a structured yield for deterministic scaling.",
   "allOf": [
-    { "$ref": "http://soustack.org/schema/v0.3.0" },
+    { "$ref": "http://soustack.org/schema/v0.0.2" },
     {
       "required": ["yield", "ingredients"],
       "properties": {
         "yield": {
           "allOf": [
-            { "$ref": "http://soustack.org/schema/v0.3.0#/definitions/yield" },
+            { "$ref": "http://soustack.org/schema/v0.0.2#/definitions/yield" },
             { "properties": { "amount": { "type": "number", "exclusiveMinimum": 0 } } }
           ]
         },
@@ -30,13 +30,13 @@
   "definitions": {
     "scalableIngredient": {
       "allOf": [
-        { "$ref": "http://soustack.org/schema/v0.3.0#/definitions/ingredient" },
+        { "$ref": "http://soustack.org/schema/v0.0.2#/definitions/ingredient" },
         { "required": ["item", "quantity"] },
         {
           "properties": {
             "quantity": {
               "allOf": [
-                { "$ref": "http://soustack.org/schema/v0.3.0#/definitions/quantity" },
+                { "$ref": "http://soustack.org/schema/v0.0.2#/definitions/quantity" },
                 { "properties": { "amount": { "type": "number", "exclusiveMinimum": 0 } } }
               ]
             }
@@ -59,7 +59,7 @@
     },
     "scalableIngredientSubsection": {
       "allOf": [
-        { "$ref": "http://soustack.org/schema/v0.3.0#/definitions/ingredientSubsection" },
+        { "$ref": "http://soustack.org/schema/v0.0.2#/definitions/ingredientSubsection" },
         {
           "properties": {
             "items": {

package/src/profiles/timed.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://soustack.org/schema/v0.0.2/profiles/timed",
+  "title": "Soustack Timed Profile Schema",
+  "description": "Extends the base schema to guarantee structured instructions with timing metadata.",
+  "allOf": [
+    { "$ref": "http://soustack.org/schema/v0.0.2" }
+  ]
+}
+