@x12i/made-easy 0.0.0-stage → 0.1.0

package/recipes/shared-1.0.0.json

@@ -0,0 +1,456 @@
+{
+  "schemaVersion": "1.0",
+  "id": "shared",
+  "version": "1.0.0",
+  "title": "Made Easy shared recipe",
+  "description": "Six required human section roles in order, one operator reference, four subject profiles and two presets. A quickstart compresses one job; a handbook expands the same job’s mechanism, decisions and exceptions.",
+  "roles": [
+    {
+      "role": "decision",
+      "title": "The decision",
+      "purpose": "State one concrete job, the question it answers, the decision owner, and what the decision depends on.",
+      "requirements": [
+        {
+          "type": "decision",
+          "min": 1,
+          "fields": [
+            "job",
+            "question",
+            "owner",
+            "dependsOn"
+          ],
+          "label": "decision block"
+        }
+      ]
+    },
+    {
+      "role": "working-model",
+      "title": "How the job works",
+      "purpose": "Map inputs, operator stages, outputs, side effects and failure points. Explain mechanisms that change a decision or how the reader interprets a failure.",
+      "requirements": [
+        {
+          "type": "job-map",
+          "min": 1,
+          "fields": [
+            "inputs",
+            "stages",
+            "outputs",
+            "sideEffects",
+            "failurePoints"
+          ],
+          "label": "job map"
+        }
+      ]
+    },
+    {
+      "role": "ownership",
+      "title": "Who does what",
+      "purpose": "Assign human decisions, human actions and delegated work. Each pause rule has a trigger, a decision owner, work that may continue, and a resume condition.",
+      "requirements": [
+        {
+          "type": "human-action",
+          "min": 1,
+          "where": {
+            "kind": "decision"
+          },
+          "fields": [
+            "actor",
+            "action"
+          ],
+          "label": "human decision"
+        },
+        {
+          "type": "human-action",
+          "min": 1,
+          "where": {
+            "kind": "delegated"
+          },
+          "fields": [
+            "actor",
+            "action"
+          ],
+          "label": "delegated work"
+        },
+        {
+          "type": "pause",
+          "min": 1,
+          "fields": [
+            "rule"
+          ],
+          "label": "pause rule"
+        }
+      ]
+    },
+    {
+      "role": "operator-brief",
+      "title": "The operator brief",
+      "purpose": "Show the reusable brief with goal, inputs, authority, pauses, acceptance checks and what to return. Link the exact operator-reference revision. Leave procedure selection inside the authorized scope to the operator.",
+      "requirements": [
+        {
+          "type": "brief",
+          "min": 1,
+          "label": "brief block"
+        }
+      ]
+    },
+    {
+      "role": "evidence-review",
+      "title": "Reviewing the evidence",
+      "purpose": "Show a usable result and a plausible failure from the same job. Link both to the same acceptance checks and show what makes a result partial or invalid.",
+      "requirements": [
+        {
+          "type": "evidence-comparison",
+          "min": 1,
+          "fields": [
+            "usable",
+            "flawed",
+            "decisiveChecks",
+            "recovery",
+            "partialWhen",
+            "invalidWhen"
+          ],
+          "label": "evidence comparison"
+        },
+        {
+          "type": "review-checklist",
+          "min": 1,
+          "label": "review checklist"
+        }
+      ]
+    },
+    {
+      "role": "next-decision",
+      "title": "The next decision",
+      "purpose": "Provide choices to accept, request a targeted rerun, authorize a next action, or escalate where applicable. State who decides and what evidence supports each choice.",
+      "requirements": [
+        {
+          "type": "decision",
+          "min": 1,
+          "fields": [
+            "question",
+            "owner",
+            "options",
+            "options[].kind",
+            "options[].decidedBy",
+            "options[].evidence"
+          ],
+          "label": "next-decision block"
+        }
+      ]
+    }
+  ],
+  "operatorRoles": [
+    {
+      "role": "scope",
+      "title": "Scope and profile",
+      "purpose": "Profile facts the operator must honour."
+    },
+    {
+      "role": "procedure",
+      "title": "Procedure",
+      "purpose": "Exact commands and procedures, with supported versions."
+    },
+    {
+      "role": "interface",
+      "title": "Interface",
+      "purpose": "API shapes and example output."
+    },
+    {
+      "role": "example",
+      "title": "Runnable example",
+      "purpose": "A complete runnable example and its expected result."
+    },
+    {
+      "role": "recovery",
+      "title": "Recovery",
+      "purpose": "Recovery instructions for each failure point."
+    }
+  ],
+  "data": {
+    "brief": [
+      "outcome",
+      "inputs",
+      "authority.reads",
+      "authority.changes",
+      "limits",
+      "pauseRules",
+      "acceptanceChecks",
+      "reportBack",
+      "operatorReference.entries"
+    ],
+    "input": [
+      "label",
+      "placeholder",
+      "example"
+    ],
+    "pauseRule": [
+      "trigger",
+      "owner",
+      "mayContinue",
+      "resumeWhen"
+    ],
+    "reportBackField": [
+      "label"
+    ],
+    "check": [
+      "observable",
+      "evidenceSource",
+      "passCondition",
+      "onMissing",
+      "onContradictory"
+    ],
+    "resultPresent": [
+      "summary",
+      "checks",
+      "completedActions",
+      "observations",
+      "gaps",
+      "nextSteps"
+    ]
+  },
+  "profiles": {
+    "market": {
+      "title": "Market",
+      "description": "A market or audience finding: who was measured, where, when, how, and whether comparisons hold.",
+      "referenceFields": [
+        {
+          "key": "audience",
+          "label": "Audience"
+        },
+        {
+          "key": "market",
+          "label": "Market"
+        },
+        {
+          "key": "timeframe",
+          "label": "Timeframe"
+        },
+        {
+          "key": "method",
+          "label": "Method"
+        },
+        {
+          "key": "sampleFrame",
+          "label": "Sample frame"
+        },
+        {
+          "key": "comparability",
+          "label": "Comparability rules"
+        }
+      ],
+      "requiredOperatorRoles": [
+        "scope",
+        "procedure",
+        "recovery"
+      ],
+      "requiresRunnableExample": false,
+      "requiresExactVersion": false
+    },
+    "product": {
+      "title": "Product",
+      "description": "A product configured or operated by a job: which model or release, on what platform, with what result.",
+      "referenceFields": [
+        {
+          "key": "modelOrRelease",
+          "label": "Model or release"
+        },
+        {
+          "key": "platform",
+          "label": "Platform"
+        },
+        {
+          "key": "configuration",
+          "label": "Configuration"
+        },
+        {
+          "key": "resultingStateEvidence",
+          "label": "Evidence of the resulting state"
+        }
+      ],
+      "requiredOperatorRoles": [
+        "scope",
+        "procedure",
+        "recovery"
+      ],
+      "requiresRunnableExample": false,
+      "requiresExactVersion": false
+    },
+    "service": {
+      "title": "Service",
+      "description": "A service obtained or changed by a job: region, plan, eligibility, terms, and provider confirmation.",
+      "referenceFields": [
+        {
+          "key": "region",
+          "label": "Region"
+        },
+        {
+          "key": "plan",
+          "label": "Plan"
+        },
+        {
+          "key": "eligibility",
+          "label": "Eligibility"
+        },
+        {
+          "key": "effectiveTerms",
+          "label": "Effective terms",
+          "optional": true,
+          "help": "Where relevant."
+        },
+        {
+          "key": "confirmationEvidence",
+          "label": "Provider confirmation or delivery evidence"
+        }
+      ],
+      "requiredOperatorRoles": [
+        "scope",
+        "procedure",
+        "recovery"
+      ],
+      "requiresRunnableExample": false,
+      "requiresExactVersion": false
+    },
+    "sdk": {
+      "title": "SDK",
+      "description": "A software distribution used by a job: exact version, runtime, interface, test environment and a runnable example.",
+      "referenceFields": [
+        {
+          "key": "distribution",
+          "label": "Distribution"
+        },
+        {
+          "key": "version",
+          "label": "Exact version"
+        },
+        {
+          "key": "runtime",
+          "label": "Runtime"
+        },
+        {
+          "key": "interface",
+          "label": "Interface"
+        },
+        {
+          "key": "testEnvironment",
+          "label": "Test environment"
+        }
+      ],
+      "npmFields": [
+        {
+          "key": "package",
+          "label": "Package name"
+        },
+        {
+          "key": "requested",
+          "label": "Requested range"
+        },
+        {
+          "key": "integrity",
+          "label": "Registry integrity"
+        },
+        {
+          "key": "registry",
+          "label": "Registry"
+        }
+      ],
+      "requiredOperatorRoles": [
+        "scope",
+        "procedure",
+        "interface",
+        "example",
+        "recovery"
+      ],
+      "requiresRunnableExample": true,
+      "requiresExactVersion": true
+    }
+  },
+  "presets": {
+    "quickstart": {
+      "title": "Quickstart",
+      "description": "Compresses one job into the six required sections.",
+      "minWords": 25,
+      "roleExtras": {}
+    },
+    "handbook": {
+      "title": "Handbook",
+      "description": "Expands the same job’s mechanism, decisions and exceptions.",
+      "minWords": 110,
+      "roleExtras": {
+        "decision": [
+          {
+            "type": "decision",
+            "min": 1,
+            "fields": [
+              "options",
+              "options[].consequence"
+            ],
+            "label": "decision consequences"
+          }
+        ],
+        "working-model": [
+          {
+            "type": "job-map",
+            "min": 1,
+            "fields": [
+              "mechanisms"
+            ],
+            "label": "mechanisms"
+          }
+        ],
+        "ownership": [
+          {
+            "type": "callout",
+            "min": 1,
+            "where": {
+              "variant": "exception"
+            },
+            "fields": [
+              "text"
+            ],
+            "label": "exception"
+          }
+        ],
+        "next-decision": [
+          {
+            "type": "decision",
+            "min": 1,
+            "fields": [
+              "options[].consequence"
+            ],
+            "label": "next-decision consequences"
+          }
+        ]
+      }
+    }
+  },
+  "validation": {
+    "draft": {
+      "placeholders": "warning",
+      "missingBlocks": "warning",
+      "missingFields": "warning",
+      "shortContent": "warning",
+      "stalePins": "warning",
+      "unverifiedExamples": "warning",
+      "unresolvedClaims": "warning",
+      "privateReferences": "info",
+      "profileFields": "warning",
+      "sdkExactness": "warning",
+      "unstableAnchors": "info",
+      "incompleteData": "warning"
+    },
+    "release": {
+      "placeholders": "error",
+      "missingBlocks": "error",
+      "missingFields": "error",
+      "shortContent": "error",
+      "stalePins": "error",
+      "unverifiedExamples": "error",
+      "unresolvedClaims": "error",
+      "privateReferences": "error",
+      "profileFields": "error",
+      "sdkExactness": "error",
+      "unstableAnchors": "warning",
+      "incompleteData": "error"
+    }
+  }
+}

package/schemas/artifact.v1.json

@@ -0,0 +1,36 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/artifact.v1.json",
+  "title": "Artifact descriptor",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "path": {
+      "type": "string"
+    },
+    "mediaType": {
+      "type": "string"
+    },
+    "size": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "sha256": {
+      "type": "string"
+    },
+    "url": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "path",
+    "mediaType",
+    "size",
+    "sha256"
+  ],
+  "additionalProperties": false
+}

package/schemas/assets.v1.json

@@ -0,0 +1,61 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/assets.v1.json",
+  "title": "assets.yaml",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+$"
+    },
+    "assets": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+          },
+          "path": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 240
+          },
+          "mediaType": {
+            "type": "string",
+            "minLength": 1
+          },
+          "digest": {
+            "type": "string",
+            "pattern": "^sha256:[0-9a-f]{64}$"
+          },
+          "alt": {
+            "type": "string"
+          },
+          "decorative": {
+            "type": "boolean"
+          },
+          "visibility": {
+            "type": "string",
+            "enum": [
+              "private",
+              "public"
+            ]
+          }
+        },
+        "required": [
+          "id",
+          "path",
+          "mediaType",
+          "digest"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "schemaVersion"
+  ],
+  "additionalProperties": false
+}

package/schemas/block.v1.json

@@ -0,0 +1,27 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/block.v1.json",
+  "title": "Structured block envelope",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+    },
+    "type": {
+      "type": "string"
+    },
+    "props": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    }
+  },
+  "required": [
+    "id",
+    "type"
+  ],
+  "additionalProperties": false
+}

package/schemas/blocks/brief.v1.json

@@ -0,0 +1,20 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/blocks/brief.v1.json",
+  "title": "Operator brief props",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "view": {
+      "type": "string",
+      "enum": [
+        "both",
+        "worked",
+        "template"
+      ]
+    },
+    "title": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/blocks/callout.v1.json

@@ -0,0 +1,25 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/blocks/callout.v1.json",
+  "title": "Callout props",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "variant": {
+      "type": "string",
+      "enum": [
+        "info",
+        "success",
+        "warning",
+        "risk",
+        "exception"
+      ]
+    },
+    "title": {
+      "type": "string"
+    },
+    "text": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/blocks/code.v1.json

@@ -0,0 +1,21 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/blocks/code.v1.json",
+  "title": "Code props",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "language": {
+      "type": "string"
+    },
+    "caption": {
+      "type": "string"
+    },
+    "code": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "code"
+  ],
+  "additionalProperties": false
+}