@soustack/spec 0.0.2

package/fixtures/valid/referenced-scaling.valid.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "quantified": 1,
+    "scaling": 1,
+    "structured": 1,
+    "referenced": 1
+  },
+  "name": "Referenced with Scaling",
+  "yield": {
+    "amount": 1,
+    "unit": "loaf"
+  },
+  "time": {
+    "total": {
+      "minutes": 60
+    }
+  },
+  "ingredients": [
+    {
+      "id": "flour",
+      "name": "Bread flour",
+      "quantity": {
+        "amount": 500,
+        "unit": "g"
+      }
+    },
+    {
+      "id": "water",
+      "name": "Water",
+      "quantity": {
+        "amount": 325,
+        "unit": "g"
+      },
+      "scaling": {
+        "mode": "bakersPercent",
+        "percent": 65,
+        "of": "flour"
+      }
+    }
+  ],
+  "instructions": [
+    {
+      "id": "mix",
+      "text": "Mix flour and water",
+      "inputs": [
+        "flour",
+        "water"
+      ]
+    },
+    {
+      "id": "bake",
+      "text": "Bake the bread",
+      "inputs": [
+        "flour",
+        "water"
+      ]
+    }
+  ],
+  "scaling": {
+    "discrete": {
+      "min": 1,
+      "max": 4,
+      "step": 1
+    }
+  }
+}

package/fixtures/valid/storage-leftovers-simple.valid.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "storage": 1
+  },
+  "name": "Soup with Simple Leftovers",
+  "ingredients": [
+    "soup"
+  ],
+  "instructions": [
+    "Cook the soup"
+  ],
+  "storage": {
+    "refrigerated": {
+      "duration": {
+        "iso8601": "P4D"
+      }
+    },
+    "leftovers": {
+      "notes": "Store in an airtight container.",
+      "reheat": [
+        "Microwave 2\u20133 minutes, stirring halfway.",
+        "Or warm in a skillet over medium heat with a splash of water."
+      ]
+    }
+  }
+}

package/fixtures/valid/storage-leftovers-structured.valid.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "storage": 1
+  },
+  "name": "Casserole with Structured Reheating",
+  "ingredients": [
+    "casserole ingredients"
+  ],
+  "instructions": [
+    "Prepare the casserole"
+  ],
+  "storage": {
+    "frozen": {
+      "duration": {
+        "iso8601": "P2M"
+      }
+    },
+    "leftovers": {
+      "portioning": {
+        "notes": "Cool completely, then portion into containers."
+      },
+      "reheat": [
+        {
+          "method": "microwave",
+          "duration": {
+            "minMinutes": 2,
+            "maxMinutes": 3
+          },
+          "notes": "Stir halfway."
+        },
+        {
+          "method": "oven",
+          "temp": {
+            "value": 350,
+            "unit": "F"
+          },
+          "notes": "Cover and heat until hot throughout."
+        }
+      ]
+    }
+  }
+}

package/fixtures/valid/structured-nested-step-sections.valid.json

@@ -0,0 +1,84 @@
+{
+  "$schema": "https://spec.soustack.org/soustack.schema.json",
+  "stacks": {
+    "structured": 1,
+    "timed": 1
+  },
+  "name": "Nested Step Sections",
+  "yield": {
+    "amount": 1,
+    "unit": "dish"
+  },
+  "time": {
+    "total": {
+      "minutes": 90
+    }
+  },
+  "ingredients": [
+    {
+      "id": "flour",
+      "name": "Flour"
+    },
+    {
+      "id": "water",
+      "name": "Water"
+    }
+  ],
+  "instructions": [
+    {
+      "section": "Main",
+      "steps": [
+        {
+          "section": "Prep",
+          "steps": [
+            {
+              "id": "prep1",
+              "text": "Prepare ingredients",
+              "timing": {
+                "activity": "active",
+                "duration": {
+                  "minutes": 10
+                }
+              }
+            },
+            {
+              "id": "prep2",
+              "text": "Measure everything",
+              "timing": {
+                "activity": "active",
+                "duration": {
+                  "minutes": 5
+                }
+              }
+            }
+          ]
+        },
+        {
+          "section": "Cooking",
+          "steps": [
+            {
+              "id": "cook1",
+              "text": "Mix everything together",
+              "timing": {
+                "activity": "active",
+                "duration": {
+                  "minutes": 15
+                }
+              }
+            },
+            {
+              "id": "cook2",
+              "text": "Cook until done",
+              "timing": {
+                "activity": "active",
+                "duration": {
+                  "minutes": 30
+                }
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@soustack/spec",
+  "publishConfig": { "access": "public" },
+  "version": "0.0.2",
+  "type": "module",
+  "license": "CC0-1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RichardHerold/soustack-spec.git"
+  },
+  "files": [
+    "soustack.schema.json",
+    "defs/",
+    "stacks/",
+    "schemas/",
+    "fixtures/",
+    "src/",
+    "dist/",
+    "SOUSTACK_SPEC_VERSION",
+    "SPEC.md",
+    "README.md"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepack": "npm run build",
+    "guard": "node scripts/guard-no-legacy.mjs",
+    "guard:canonical-host": "node scripts/guard-canonical-host.mjs",
+    "check-refs": "node scripts/check-schema-refs.mjs",
+    "validate": "node scripts/validate-fixtures.mjs",
+    "verify:version": "node scripts/verify-version.mjs",
+    "verify:registry": "node scripts/validate-registry.mjs",
+    "verify:stack-docs": "node scripts/verify-stack-docs.mjs",
+    "build:schemas": "node scripts/generate-stack-gating.mjs",
+    "docs:sync": "node scripts/generate-docs-from-registry.mjs",
+    "verify:generated": "node scripts/verify-generated-clean.mjs",
+    "verify": "npm run verify:version && npm run verify:registry && npm run verify:stack-docs && npm run check-refs && npm run guard && npm run guard:canonical-host && npm run validate && npm run verify:generated",
+    "test": "npm run verify"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1"
+  }
+}

package/schemas/stacks-registry.schema.json

@@ -0,0 +1,108 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "../schemas/stacks-registry.schema.json",
+  "title": "Soustack Stacks Registry Schema",
+  "type": "object",
+  "properties": {
+    "$schema": { "type": "string" },
+    "registryVersion": { "type": "integer", "minimum": 1 },
+    "spec": {
+      "type": "object",
+      "properties": {
+        "name": { "type": "string" },
+        "currentSpecVersion": { "type": "string" },
+        "canonicalStacksFormat": { "type": "string", "enum": ["map"] }
+      },
+      "required": ["name", "currentSpecVersion", "canonicalStacksFormat"],
+      "additionalProperties": false
+    },
+    "profiles": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string",
+        "pattern": "^[a-z][a-z0-9-]*$"
+      },
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "title": { "type": "string" },
+          "description": { "type": "string" },
+          "requiresProfiles": {
+            "type": "array",
+            "items": { "type": "string" }
+          },
+          "requiresStacks": {
+            "type": "array",
+            "items": { "type": "string" }
+          }
+        },
+        "required": ["title", "description"],
+        "anyOf": [
+          { "required": ["requiresProfiles"] },
+          { "required": ["requiresStacks"] }
+        ],
+        "additionalProperties": false
+      }
+    },
+    "stacks": {
+      "type": "object",
+      "propertyNames": {
+        "anyOf": [
+          {
+            "type": "string",
+            "pattern": "^[a-z][a-z0-9-]*$"
+          },
+          {
+            "type": "string",
+            "pattern": "^x-[a-z0-9-]+(?:\\.[a-z0-9-]+)*$"
+          }
+        ]
+      },
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "title": { "type": "string" },
+          "latestMajor": { "type": "integer", "minimum": 1 },
+          "requires": {
+            "type": "array",
+            "items": { "type": "string" }
+          },
+          "schema": {
+            "type": "object",
+            "properties": {
+              "major": {
+                "type": "object",
+                "propertyNames": {
+                  "type": "string",
+                  "pattern": "^[0-9]+$"
+                },
+                "additionalProperties": { "type": "string" }
+              }
+            },
+            "required": ["major"],
+            "additionalProperties": false
+          },
+          "docs": {
+            "type": "object",
+            "properties": {
+              "major": {
+                "type": "object",
+                "propertyNames": {
+                  "type": "string",
+                  "pattern": "^[0-9]+$"
+                },
+                "additionalProperties": { "type": "string" }
+              }
+            },
+            "required": ["major"],
+            "additionalProperties": false
+          }
+        },
+        "required": ["title", "latestMajor", "requires", "schema"],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": ["registryVersion", "spec", "profiles", "stacks"],
+  "additionalProperties": false
+}