@stravica-ai/rcf-schemas 0.2.0

package/schemas/prd.schema.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.stravica.io/rcf/v0.2.0/prd.schema.json",
+  "title": "RCF PRD",
+  "description": "Product Requirements Document. One per project. The PRD is a pure shell document; requirement bodies live in individual req.schema.json files and each REQ carries the mandatory prdId back-reference. The walker computes the PRD's requirement list by inverting REQ.prdId at load time.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "prdId",
+    "productName",
+    "version",
+    "status",
+    "problemStatement",
+    "objectives",
+    "createdAt",
+    "updatedAt"
+  ],
+  "properties": {
+    "prdId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/prdId" },
+    "productName": { "type": "string", "minLength": 1 },
+    "version": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/version" },
+    "status": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/authoringStatus" },
+    "executiveSummary": { "type": "string" },
+    "problemStatement": { "type": "string", "minLength": 1 },
+    "targetUsers": {
+      "type": "array",
+      "items": { "type": "string", "minLength": 1 }
+    },
+    "inScope": {
+      "type": "array",
+      "items": { "type": "string", "minLength": 1 }
+    },
+    "outOfScope": {
+      "type": "array",
+      "items": { "type": "string", "minLength": 1 }
+    },
+    "objectives": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "type": "string", "minLength": 1 }
+    },
+    "constraints": {
+      "type": "array",
+      "items": { "type": "string", "minLength": 1 }
+    },
+    "createdAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" },
+    "updatedAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" }
+  }
+}

package/schemas/req.schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.stravica.io/rcf/v0.2.0/req.schema.json",
+  "title": "RCF Requirement",
+  "description": "Individual requirement within a PRD. One file per requirement. Recommended path: rcf/requirements/REQ-001.json. Carries the mandatory prdId parent reference; the PRD does not list its requirements.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "reqId",
+    "prdId",
+    "title",
+    "description",
+    "category",
+    "domain",
+    "priority",
+    "version",
+    "status",
+    "createdAt",
+    "updatedAt"
+  ],
+  "properties": {
+    "reqId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/reqId" },
+    "prdId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/prdId" },
+    "title": { "type": "string", "minLength": 1 },
+    "description": { "type": "string", "minLength": 1 },
+    "category": { "enum": ["functional", "nonFunctional", "technical", "security"] },
+    "domain": { "type": "string", "minLength": 1 },
+    "priority": { "enum": ["must", "should", "could", "wont"] },
+    "rationale": { "type": "string" },
+    "tags": {
+      "type": "array",
+      "items": { "type": "string" }
+    },
+    "version": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/version" },
+    "status": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/authoringStatus" },
+    "createdAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" },
+    "updatedAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" }
+  }
+}

package/schemas/tac.schema.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.stravica.io/rcf/v0.2.0/tac.schema.json",
+  "title": "RCF Technical Architecture Component",
+  "description": "One per architectural component. Verbose per-component descriptions are fine; the schema does not constrain length.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "tacId",
+    "prdId",
+    "tadId",
+    "version",
+    "status",
+    "name",
+    "purpose",
+    "responsibilities",
+    "createdAt",
+    "updatedAt"
+  ],
+  "properties": {
+    "tacId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/tacId" },
+    "prdId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/prdId" },
+    "tadId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/tadId" },
+    "version": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/version" },
+    "status": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/authoringStatus" },
+
+    "name": { "type": "string", "minLength": 1 },
+    "purpose": { "type": "string", "minLength": 1 },
+    "responsibilities": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "type": "string", "minLength": 1 }
+    },
+
+    "internalStructure": { "type": "string" },
+    "interfaces": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/interfaceDef" }
+    },
+    "dependencies": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/dependencyRef" }
+    },
+    "tradeoffs": { "type": "string" },
+    "notes": { "type": "string" },
+
+    "createdAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" },
+    "updatedAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" }
+  },
+  "$defs": {
+    "interfaceDef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "kind"],
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "kind": { "type": "string", "minLength": 1 },
+        "description": { "type": "string" }
+      }
+    },
+    "dependencyRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "kind"],
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "kind": { "enum": ["tac", "external"] },
+        "tacId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/tacId" },
+        "description": { "type": "string" }
+      }
+    }
+  }
+}

package/schemas/tad.schema.json

@@ -0,0 +1,162 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.stravica.io/rcf/v0.2.0/tad.schema.json",
+  "title": "RCF Technical Architecture Document",
+  "description": "Master Technical Architecture Document. One per project. TACs and ADRs each carry the mandatory tadId parent reference; the TAD does not list them. The walker computes both children lists by inverting TAC.tadId and ADR.tadId at load time. The schema defines the FULL set of possible sections; what's required for a given project is a tooling decision.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "tadId",
+    "prdId",
+    "version",
+    "status",
+    "systemOverview",
+    "createdAt",
+    "updatedAt"
+  ],
+  "properties": {
+    "tadId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/tadId" },
+    "prdId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/prdId" },
+    "version": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/version" },
+    "status": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/authoringStatus" },
+
+    "systemOverview": { "$ref": "#/$defs/systemOverview" },
+
+    "architecturePrinciples": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/principle" }
+    },
+    "dataArchitecture": { "$ref": "#/$defs/dataArchitecture" },
+    "integrationArchitecture": { "$ref": "#/$defs/integrationArchitecture" },
+    "securityArchitecture": { "$ref": "#/$defs/securityArchitecture" },
+    "deploymentArchitecture": { "$ref": "#/$defs/deploymentArchitecture" },
+    "operationalConcerns": { "$ref": "#/$defs/operationalConcerns" },
+
+    "createdAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" },
+    "updatedAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" }
+  },
+  "$defs": {
+    "systemOverview": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["executiveSummary", "systemPurpose", "architecturalApproach", "keyCapabilities"],
+      "properties": {
+        "executiveSummary": { "type": "string", "minLength": 1 },
+        "systemPurpose": { "type": "string", "minLength": 1 },
+        "architecturalApproach": { "type": "string", "minLength": 1 },
+        "keyCapabilities": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "type": "string", "minLength": 1 }
+        }
+      }
+    },
+    "principle": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "description", "rationale"],
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "description": { "type": "string", "minLength": 1 },
+        "rationale": { "type": "string", "minLength": 1 }
+      }
+    },
+    "dataArchitecture": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["dataStores", "coreEntities"],
+      "properties": {
+        "dataStores": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name", "kind"],
+            "properties": {
+              "name": { "type": "string", "minLength": 1 },
+              "kind": { "type": "string", "minLength": 1 },
+              "purpose": { "type": "string" }
+            }
+          }
+        },
+        "coreEntities": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name"],
+            "properties": {
+              "name": { "type": "string", "minLength": 1 },
+              "description": { "type": "string" }
+            }
+          }
+        },
+        "dataFlow": { "type": "string" },
+        "retention": { "type": "string" }
+      }
+    },
+    "integrationArchitecture": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["apiDesign"],
+      "properties": {
+        "apiDesign": { "type": "string", "minLength": 1 },
+        "externalSystems": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name"],
+            "properties": {
+              "name": { "type": "string", "minLength": 1 },
+              "purpose": { "type": "string" },
+              "protocol": { "type": "string" }
+            }
+          }
+        },
+        "eventModel": { "type": "string" }
+      }
+    },
+    "securityArchitecture": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["authenticationPattern", "authorizationModel"],
+      "properties": {
+        "authenticationPattern": { "type": "string", "minLength": 1 },
+        "authorizationModel": { "type": "string", "minLength": 1 },
+        "secretsManagement": { "type": "string" },
+        "threatModel": { "type": "string" },
+        "complianceRequirements": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      }
+    },
+    "deploymentArchitecture": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["targetEnvironment"],
+      "properties": {
+        "targetEnvironment": { "type": "string", "minLength": 1 },
+        "topology": { "type": "string" },
+        "scaling": { "type": "string" },
+        "cicd": { "type": "string" }
+      }
+    },
+    "operationalConcerns": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["healthChecks", "logging"],
+      "properties": {
+        "healthChecks": { "type": "string", "minLength": 1 },
+        "logging": { "type": "string", "minLength": 1 },
+        "metrics": { "type": "string" },
+        "alerting": { "type": "string" },
+        "backup": { "type": "string" },
+        "disasterRecovery": { "type": "string" }
+      }
+    }
+  }
+}

package/schemas/test-suite.schema.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.stravica.io/rcf/v0.2.0/test-suite.schema.json",
+  "title": "RCF Test Suite",
+  "description": "One file per Test Suite. Verifies one or more Acceptance Criteria (on the User Story identified by usId) via inline Test Cases. Test Suites hold the AC references; ACs stay clean of downstream references. Test-run status per TC is authored (Phase 3.7) and later derived from real test runs (Phase 6+).",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "id",
+    "usId",
+    "title",
+    "purpose",
+    "testLevel",
+    "acIds",
+    "testCases",
+    "status",
+    "createdAt",
+    "updatedAt"
+  ],
+  "properties": {
+    "id": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/tsId" },
+    "usId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/usId" },
+    "title": { "type": "string", "minLength": 1 },
+    "purpose": { "type": "string", "minLength": 1 },
+    "testLevel": { "enum": ["unit", "integration", "e2e", "contract", "manual"] },
+    "acIds": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/acId" }
+    },
+    "testCases": {
+      "type": "array",
+      "minItems": 0,
+      "items": { "$ref": "#/$defs/testCase" }
+    },
+    "status": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/authoringStatus" },
+    "createdAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" },
+    "updatedAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" }
+  },
+  "$defs": {
+    "testCase": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "acId", "description", "status"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^TC-\\d{3}-[a-z0-9-]+$",
+          "description": "Test Case identifier. TS suffix (three digits) joined to a lowercase alphanumeric slug (hyphens allowed)."
+        },
+        "acId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/acId" },
+        "description": { "type": "string", "minLength": 1 },
+        "testPointer": {
+          "type": "string",
+          "description": "Optional pointer to the executable test, format: filePath::testName."
+        },
+        "status": { "enum": ["pending", "passing", "failing", "skipped"] }
+      }
+    }
+  }
+}

package/schemas/user-story.schema.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.stravica.io/rcf/v0.2.0/user-story.schema.json",
+  "title": "RCF User Story",
+  "description": "User Story document. One file per US. Contains its Acceptance Criteria inline as acceptanceCriteria[].",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "usId",
+    "prdId",
+    "reqId",
+    "version",
+    "status",
+    "title",
+    "asA",
+    "iWant",
+    "soThat",
+    "acceptanceCriteria",
+    "createdAt",
+    "updatedAt"
+  ],
+  "properties": {
+    "usId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/usId" },
+    "prdId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/prdId" },
+    "reqId": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/reqId" },
+    "version": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/version" },
+    "status": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/authoringStatus" },
+    "title": { "type": "string", "minLength": 1 },
+    "description": { "type": "string" },
+    "asA": { "type": "string", "minLength": 1 },
+    "iWant": { "type": "string", "minLength": 1 },
+    "soThat": { "type": "string", "minLength": 1 },
+    "acceptanceCriteria": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#/$defs/acceptanceCriterion" }
+    },
+    "createdAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" },
+    "updatedAt": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/timestamp" }
+  },
+  "$defs": {
+    "acceptanceCriterion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "description", "testable"],
+      "properties": {
+        "id": { "$ref": "https://schemas.stravica.io/rcf/v0.2.0/common.schema.json#/$defs/acId" },
+        "description": { "type": "string", "minLength": 1 },
+        "given": { "type": "string" },
+        "when": { "type": "string" },
+        "then": { "type": "string" },
+        "testable": { "type": "boolean" }
+      }
+    }
+  }
+}