@formigio/fazemos-cli 0.10.24 → 0.10.26

package/dist/runbook/schema.js

@@ -0,0 +1,136 @@
+/**
+ * Vendored copy of the FROZEN Runbook frontmatter / I/O-contract schema (F39).
+ *
+ * SOURCE OF TRUTH: the canonical artifact lives in the workspace at
+ *   projects/fazemos/runbooks/runbook.schema.json
+ * (F39 tech spec §5.6, OQ-6). This vendored copy is a **cache** used only as
+ * the absent-canonical fallback: `loadRunbookSchema()` (checks.ts) loads the
+ * canonical file when run inside a workspace clone — the normal case, since the
+ * tool is validating files in that clone — and falls back to this copy only
+ * when the canonical file cannot be found.
+ *
+ * LOCKSTEP (F39 §9.2, AC#10): the vendored copy must be byte-identical to, or a
+ * strict superset of, the canonical schema. A unit test diffs the two and FAILS
+ * at ERROR severity on any drift (it may never define an enum value the
+ * canonical schema lacks, nor omit one it has). Because the canonical file is
+ * the source of truth and this is a cache, silent divergence would let the CLI
+ * accept/reject Runbooks differently from the contract F40 reads — so it is a
+ * hard CI failure, not a soft warning.
+ *
+ * Enum evolution is append-only within a major version (§5.2): new values may be
+ * ADDED via a minor bump (e.g. "1.0" -> "1.1"); any value REMOVAL is a breaking
+ * change requiring a major bump (e.g. "1.x" -> "2.0"). Bumped together with the
+ * CLI version; mirrors the established KNOWN_MANIFEST_VERSIONS pattern.
+ */
+export const RUNBOOK_SCHEMA_VERSIONS = ['1.0'];
+// FROZEN closed enums (F39 §5.2). Exported so checks.ts + tests reference one set.
+export const RUNBOOK_TYPE_ENUM = ['text', 'number', 'boolean', 'url', 'filepath', 'json'];
+export const RUNBOOK_FORMAT_ENUM = ['text', 'filepath', 'url', 'commit_sha', 'integer', 'markdown', 'json'];
+export const RUNBOOK_SOURCE_HINT_ENUM = ['upstream', 'pipeline_param', 'dispatch_param', 'workspace_path'];
+/**
+ * The vendored JSON-Schema (draft-07). Kept structurally identical to the
+ * canonical runbook.schema.json. The schema-drift unit test (§9.2, AC#10)
+ * compares the canonical file against this object and fails on any divergence.
+ */
+export const runbookSchema = {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    $id: 'https://fazemos/schemas/runbook.json',
+    title: 'Runbook frontmatter / I/O-contract schema',
+    description: 'Frozen schema for the Runbook primitive\'s step-doc frontmatter (F39). The single source of truth that F39\'s CLI validator (`fazemos runbook validate`) AND F40\'s dispatch param-validation both read. Frozen at runbook_schema_version 1.0. Enum evolution is append-only within a major version (a minor bump, e.g. 1.0 -> 1.1); any enum value removal requires a major bump (e.g. 1.x -> 2.0). See specs/tech/platform/F39-runbook-substrate-authority-flip-tech-spec.md sections 5.1-5.3 + 5.6.',
+    type: 'object',
+    required: ['runbook_schema_version', 'runbook', 'title', 'description', 'role', 'contract'],
+    additionalProperties: false,
+    properties: {
+        runbook_schema_version: {
+            type: 'string',
+            description: 'The contract version. Required (F39 section 5.3): the Runbook contract is load-bearing for F40, so a missing version is a hard error. Frozen set for F39 is ["1.0"].',
+        },
+        runbook: {
+            type: 'string',
+            pattern: '^[a-z0-9]+(-[a-z0-9]+)*$',
+            description: 'Stable kebab-case id; the callable "function name" that F40\'s runbook_ref resolves. Library-unique. Replaces the legacy step:/playbook: keys. Independent of the resolver-mandated physical filename (which must equal the step name).',
+        },
+        title: { type: 'string', minLength: 1, description: 'Human label.' },
+        description: {
+            type: 'string',
+            minLength: 1,
+            description: 'Single-line, non-empty description. The F18 validateDescription contract enforces non-empty + no newline at render; the CLI re-applies it as runbook.description_invalid before a render.',
+        },
+        role: {
+            type: 'string',
+            minLength: 1,
+            description: 'Capability HINT (role-slug, post-F25). Overridable at dispatch. NEVER a hard filler pin (F39 section 6.4). A Runbook is what to do, never who.',
+        },
+        contract: {
+            type: 'object',
+            required: ['inputs', 'outputs'],
+            additionalProperties: false,
+            properties: {
+                inputs: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        required: ['name', 'type', 'required', 'source_hint'],
+                        additionalProperties: false,
+                        properties: {
+                            name: {
+                                type: 'string',
+                                minLength: 1,
+                                description: 'The name the PROCEDURE BODY uses. The binding maps the actual wire (section 5.5); the renamed wire name never leaks into the Runbook.',
+                            },
+                            type: {
+                                type: 'string',
+                                enum: ['text', 'number', 'boolean', 'url', 'filepath', 'json'],
+                                description: 'FROZEN closed enum (F39 section 5.2). Closed at 6.',
+                            },
+                            required: { type: 'boolean' },
+                            source_hint: {
+                                type: 'string',
+                                enum: ['upstream', 'pipeline_param', 'dispatch_param', 'workspace_path'],
+                                description: 'FROZEN closed enum (F39 section 5.2). The shape of how this input is typically satisfied, NEVER the wire. Closed at 4.',
+                            },
+                            description: { type: 'string' },
+                        },
+                    },
+                },
+                outputs: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        required: ['name', 'type', 'required', 'success_criteria'],
+                        additionalProperties: false,
+                        properties: {
+                            name: { type: 'string', minLength: 1 },
+                            type: {
+                                type: 'string',
+                                enum: ['text', 'number', 'boolean', 'url', 'filepath', 'json'],
+                                description: 'FROZEN closed enum (F39 section 5.2). Closed at 6.',
+                            },
+                            required: { type: 'boolean' },
+                            format: {
+                                type: 'string',
+                                enum: ['text', 'filepath', 'url', 'commit_sha', 'integer', 'markdown', 'json'],
+                                description: 'FROZEN closed enum (F39 section 5.2). Optional; refines type. Absent => unconstrained beyond type. Closed at 7.',
+                            },
+                            success_criteria: {
+                                type: 'string',
+                                minLength: 1,
+                                description: 'What turns the contract into a real function signature (Ollie section 1: the single highest-value piece). What a pipeline evaluator, chat dispatcher, and inbox auto-wake all agree on for "did this Runbook return what it promised."',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        defaults: {
+            type: 'object',
+            additionalProperties: false,
+            description: 'SUGGESTED defaults only; the binding override wins when present (section 5.5). Honors BUG36 (eval budget keys off step shape).',
+            properties: {
+                reviewer: { type: ['string', 'null'], description: 'role-slug or null.' },
+                eval_max_turns: { type: ['integer', 'null'], description: 'null => engine default.' },
+            },
+        },
+    },
+};
+//# sourceMappingURL=schema.js.map

package/dist/runbook/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/runbook/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,KAAK,CAAU,CAAC;AAExD,mFAAmF;AACnF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAU,CAAC;AACnG,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,CAAU,CAAC;AACrH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,UAAU,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,gBAAgB,CAAU,CAAC;AAEpH;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,yCAAyC;IAClD,GAAG,EAAE,sCAAsC;IAC3C,KAAK,EAAE,2CAA2C;IAClD,WAAW,EACT,weAAwe;IAC1e,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,wBAAwB,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,CAAC;IAC3F,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,sBAAsB,EAAE;YACtB,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,sKAAsK;SACzK;QACD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,0BAA0B;YACnC,WAAW,EACT,yOAAyO;SAC5O;QACD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE;QACpE,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,CAAC;YACZ,WAAW,EACT,2LAA2L;SAC9L;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,CAAC;YACZ,WAAW,EACT,gJAAgJ;SACnJ;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,MAAM,EAAE;oBACN,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,CAAC;wBACrD,oBAAoB,EAAE,KAAK;wBAC3B,UAAU,EAAE;4BACV,IAAI,EAAE;gCACJ,IAAI,EAAE,QAAQ;gCACd,SAAS,EAAE,CAAC;gCACZ,WAAW,EACT,uIAAuI;6BAC1I;4BACD,IAAI,EAAE;gCACJ,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC;gCAC9D,WAAW,EAAE,oDAAoD;6BAClE;4BACD,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;4BAC7B,WAAW,EAAE;gCACX,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE,CAAC,UAAU,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,gBAAgB,CAAC;gCACxE,WAAW,EACT,wHAAwH;6BAC3H;4BACD,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;yBAChC;qBACF;iBACF;gBACD,OAAO,EAAE;oBACP,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,CAAC;wBAC1D,oBAAoB,EAAE,KAAK;wBAC3B,UAAU,EAAE;4BACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;4BACtC,IAAI,EAAE;gCACJ,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC;gCAC9D,WAAW,EAAE,oDAAoD;6BAClE;4BACD,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;4BAC7B,MAAM,EAAE;gCACN,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,CAAC;gCAC9E,WAAW,EACT,iHAAiH;6BACpH;4BACD,gBAAgB,EAAE;gCAChB,IAAI,EAAE,QAAQ;gCACd,SAAS,EAAE,CAAC;gCACZ,WAAW,EACT,wOAAwO;6BAC3O;yBACF;qBACF;iBACF;aACF;SACF;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,WAAW,EACT,gIAAgI;YAClI,UAAU,EAAE;gBACV,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE;gBACzE,cAAc,EAAE,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,yBAAyB,EAAE;aACtF;SACF;KACF;CACO,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formigio/fazemos-cli",
-  "version": "0.10.24",
+  "version": "0.10.26",
   "description": "CLI for the Fazemos Team Accomplishment Platform",
   "type": "module",
   "license": "MIT",