@nivora/matrix 0.1.0

package/.next/types/validator.ts

@@ -0,0 +1,115 @@
+// This file is generated automatically by Next.js
+// Do not edit this file manually
+// This file validates that all pages and layouts export the correct types
+
+import type { AppRoutes, LayoutRoutes, ParamMap } from "./routes.js"
+import type { ResolvingMetadata, ResolvingViewport } from "next/types.js"
+
+type AppPageConfig<Route extends AppRoutes = AppRoutes> = {
+  default: React.ComponentType<{ params: Promise<ParamMap[Route]> } & any> | ((props: { params: Promise<ParamMap[Route]> } & any) => React.ReactNode | Promise<React.ReactNode> | never | void | Promise<void>)
+  generateStaticParams?: (props: { params: ParamMap[Route] }) => Promise<any[]> | any[]
+  generateMetadata?: (
+    props: { params: Promise<ParamMap[Route]> } & any,
+    parent: ResolvingMetadata
+  ) => Promise<any> | any
+  generateViewport?: (
+    props: { params: Promise<ParamMap[Route]> } & any,
+    parent: ResolvingViewport
+  ) => Promise<any> | any
+  metadata?: any
+  viewport?: any
+}
+
+type LayoutConfig<Route extends LayoutRoutes = LayoutRoutes> = {
+  default: React.ComponentType<LayoutProps<Route>> | ((props: LayoutProps<Route>) => React.ReactNode | Promise<React.ReactNode> | never | void | Promise<void>)
+  generateStaticParams?: (props: { params: ParamMap[Route] }) => Promise<any[]> | any[]
+  generateMetadata?: (
+    props: { params: Promise<ParamMap[Route]> } & any,
+    parent: ResolvingMetadata
+  ) => Promise<any> | any
+  generateViewport?: (
+    props: { params: Promise<ParamMap[Route]> } & any,
+    parent: ResolvingViewport
+  ) => Promise<any> | any
+  metadata?: any
+  viewport?: any
+}
+
+
+// Validate ../../src/app/builder/page.tsx
+{
+  type __IsExpected<Specific extends AppPageConfig<"/builder">> = Specific
+  const handler = {} as typeof import("../../src/app/builder/page.js")
+  type __Check = __IsExpected<typeof handler>
+  // @ts-ignore
+  type __Unused = __Check
+}
+
+// Validate ../../src/app/guide/page.tsx
+{
+  type __IsExpected<Specific extends AppPageConfig<"/guide">> = Specific
+  const handler = {} as typeof import("../../src/app/guide/page.js")
+  type __Check = __IsExpected<typeof handler>
+  // @ts-ignore
+  type __Unused = __Check
+}
+
+// Validate ../../src/app/matrix/page.tsx
+{
+  type __IsExpected<Specific extends AppPageConfig<"/matrix">> = Specific
+  const handler = {} as typeof import("../../src/app/matrix/page.js")
+  type __Check = __IsExpected<typeof handler>
+  // @ts-ignore
+  type __Unused = __Check
+}
+
+// Validate ../../src/app/page.tsx
+{
+  type __IsExpected<Specific extends AppPageConfig<"/">> = Specific
+  const handler = {} as typeof import("../../src/app/page.js")
+  type __Check = __IsExpected<typeof handler>
+  // @ts-ignore
+  type __Unused = __Check
+}
+
+// Validate ../../src/app/releases/[id]/page.tsx
+{
+  type __IsExpected<Specific extends AppPageConfig<"/releases/[id]">> = Specific
+  const handler = {} as typeof import("../../src/app/releases/[id]/page.js")
+  type __Check = __IsExpected<typeof handler>
+  // @ts-ignore
+  type __Unused = __Check
+}
+
+// Validate ../../src/app/releases/page.tsx
+{
+  type __IsExpected<Specific extends AppPageConfig<"/releases">> = Specific
+  const handler = {} as typeof import("../../src/app/releases/page.js")
+  type __Check = __IsExpected<typeof handler>
+  // @ts-ignore
+  type __Unused = __Check
+}
+
+// Validate ../../src/app/specs/[id]/page.tsx
+{
+  type __IsExpected<Specific extends AppPageConfig<"/specs/[id]">> = Specific
+  const handler = {} as typeof import("../../src/app/specs/[id]/page.js")
+  type __Check = __IsExpected<typeof handler>
+  // @ts-ignore
+  type __Unused = __Check
+}
+
+
+
+
+
+
+
+// Validate ../../src/app/layout.tsx
+{
+  type __IsExpected<Specific extends LayoutConfig<"/">> = Specific
+  const handler = {} as typeof import("../../src/app/layout.js")
+  type __Check = __IsExpected<typeof handler>
+  // @ts-ignore
+  type __Unused = __Check
+}

package/README.md

@@ -0,0 +1,185 @@
+# GAMP 5 V-Model Traceability System
+
+A streamlined requirements traceability and test management system designed for regulated environments, using **Gherkin as the source of truth** for Functional Specifications.
+
+📚 **Documentation**:
+- [**User Guide**](./USER_GUIDE.md): How to use the dashboard and CLI.
+- [**Developer Guide**](./DEVELOPER_GUIDE.md): Architecture, setup, and development workflow.
+- [**Philosophy & Approach**](./GAMP_AND_V_MODEL.md): GAMP 5 principles, V-Model, and "Spec-as-Code" reasoning.
+
+
+## Data Model
+
+This system uses a **relational model** with 3 artifact types and no duplicate data:
+
+| Artifact | Format | Location | Purpose |
+|----------|--------|----------|---------|
+| **URS** | Database | SQLite Table `urs` | High-level business requirements |
+| **FS** | Gherkin | `specs/fs/*.requirement` | Functional specs + embedded test scenarios |
+| **RISK** | Database | SQLite Table `risks` | Risk assessments linked to FS |
+
+### Key Insight: Gherkin IS the Functional Specification
+
+Instead of maintaining separate FS documents and test files, we use Gherkin Feature files AS the functional specification:
+
+```gherkin
+@URS-001 @RISK-001
+Feature: FS-001 User Login Authentication
+  The system shall provide a login interface that authenticates users 
+  against stored credentials and establishes a secure session.
+  
+  Requirements:
+  - FR-001.1: Display login form with email and password fields
+  - FR-001.2: Validate credentials against stored hash
+  - FR-001.3: Rate limit after 5 failed attempts
+
+  Scenario: Successful login with valid credentials
+    Given I am on the login page
+    When I enter valid credentials
+    Then I should be redirected to my dashboard
+```
+
+**Benefits:**
+- **No duplication**: The Feature description IS the spec, scenarios ARE the tests
+- **Single source of truth**: Edit one file, both spec and tests are updated
+- **Clear traceability**: `@URS-xxx` and `@RISK-xxx` tags create automatic links
+- **Executable specs**: The `.requirement` files can be run by Cucumber
+
+## Directory Structure
+
+```
+docs/
+├── specs/
+│   └── fs/                     # Functional Specs (Gherkin)
+│       ├── FS-001-login.requirement
+│       ├── FS-002-session.requirement
+│       ├── FS-003-registration.requirement
+│       ├── FS-004-booking.requirement
+│       ├── FS-005-waitlist.requirement
+│       ├── FS-006-schedule.requirement
+│       └── FS-007-instructor.requirement
+└── src/                        # Next.js Dashboard
+```
+
+## Linking Artifacts
+
+### URS to FS
+Use `@URS-xxx` tag in the Gherkin Feature:
+```gherkin
+@URS-001
+Feature: FS-001 User Login
+```
+
+### FS to Risk
+Use `@RISK-xxx` tag in the Gherkin Feature:
+```gherkin
+@URS-001 @RISK-001
+Feature: FS-001 User Login
+```
+
+### Verification Levels (V-Model)
+- **URS** → Verified by **PQ** (Performance Qualification)
+- **FS** → Verified by **OQ** (Operational Qualification)  
+- **Scenarios** → Verified by **IQ** (Installation Qualification)
+
+## Running the Dashboard
+
+```bash
+cd docs
+bun install
+bun run dev
+```
+
+Access at: http://localhost:3000
+
+## Dashboard Pages
+
+| Page | Description |
+|------|-------------|
+| `/` | Dashboard with stats, coverage, and traceability summary |
+| `/specs` | Browse URS (YAML), FS (Gherkin), and Risk (YAML) |
+| `/matrix` | Full traceability matrix: URS → FS → Scenarios → Risks |
+| `/builder` | Visual editor for creating new FS .requirement files |
+| `/search` | Search across all artifacts |
+
+## Creating New Artifacts
+
+### New URS (via Dashboard or manually)
+Create `specs/urs/URS-xxx.yaml`:
+```yaml
+id: URS-004
+type: urs
+title: New Business Requirement
+status: draft
+priority: high
+owner: Product Team
+category: Core
+business_need: |
+  Description of the business need...
+intended_use: |
+  How the system will be used...
+acceptance_criteria:
+  - Criterion 1
+  - Criterion 2
+regulatory_refs:
+  - GAMP 5
+```
+
+### New FS (via Builder or manually)
+Create `specs/fs/FS-xxx-name.requirement`:
+```gherkin
+@URS-xxx @RISK-xxx
+Feature: FS-xxx Feature Title
+  The system shall...
+  
+  Requirements:
+  - FR-xxx.1: First requirement
+  - FR-xxx.2: Second requirement
+
+  Scenario: Test case 1
+    Given ...
+    When ...
+    Then ...
+```
+
+### New Risk (manually)
+Create `specs/risk/RISK-xxx.yaml`:
+```yaml
+id: RISK-004
+type: risk
+title: Risk Title
+status: draft
+category: Security
+gamp_category: 4
+fs_ids:
+  - FS-001
+impact: high
+probability: medium
+risk_level: high
+risks:
+  - id: R-004.1
+    description: Risk description
+    impact: high
+    probability: medium
+mitigations:
+  - risk_id: R-004.1
+    control: Control measure
+    test: How to test
+residual_risk: acceptable
+```
+
+## Running Tests
+
+The `.requirement` files are standard Gherkin and can be executed with Cucumber:
+
+```bash
+# Configure cucumber to find .requirement files
+npx cucumber-js specs/fs/**/*.requirement
+```
+
+## GAMP 5 Compliance
+
+- **Category 4**: Configured products (authentication, session management)
+- **Category 5**: Custom applications (booking transactions)
+- **21 CFR Part 11**: Electronic records and signatures ready
+- **ALCOA+**: Data integrity principles for booking records