SVP-IR

Semantic Voxel Protocol - Intermediate Representation

SVP 中间表示层 (IR) - 提供所有层级的 TypeScript 类型定义和 Zod 运行时验证。

特性

• 📝 完整类型定义 - L5 到 L1 所有层级的 TypeScript 类型
• ✅ Zod 验证 - 运行时 Schema 验证
• 🔄 序列化工具 - YAML/JSON 转换工具
• 🗺️ 源映射支持 - 编译溯源信息

安装

npm install @semanticvoxelprotocol/ir

使用

类型定义

import { 
  L5Blueprint, 
  L4LogicChain, 
  L3Domain,
  L2Block,
  L1Code 
} from '@semanticvoxelprotocol/ir';

// 定义 L5 蓝图
const blueprint: L5Blueprint = {
  svpVersion: "0.1.0",
  level: 5,
  project: {
    name: "ecommerce-service",
    description: "电商订单服务",
    version: "1.0.0"
  },
  intent: {
    problem: "构建可扩展的电商后端",
    solution: "使用 SVP 分层架构",
    successCriteria: ["支持 1000 QPS", "99.9% 可用性"]
  },
  domains: [
    { name: "Order", responsibility: "订单管理", dependencies: [] }
  ]
};

运行时验证

import { validateL5, validateL3 } from '@semanticvoxelprotocol/ir';

// 验证 L5 蓝图
const result = validateL5(blueprint);
if (!result.valid) {
  console.error('验证失败:', result.errors);
}

// 验证 L3 领域模型
const domainResult = validateL3(domainYaml);

层级常量

import { SVPLevel } from '@semanticvoxelprotocol/ir';

console.log(SVPLevel.L5_INTENT);     // 5
console.log(SVPLevel.L4_ARCHITECTURE); // 4
console.log(SVPLevel.L3_LOGIC);       // 3
console.log(SVPLevel.L2_SKETCH);      // 2
console.log(SVPLevel.L1_CODE);        // 1

API 参考

验证函数

函数	输入	输出	说明
validateL5	unknown	ValidationResult<L5Blueprint>	验证 L5 蓝图
validateL4	unknown	ValidationResult<L4LogicChain>	验证 L4 架构
validateL3	unknown	ValidationResult<L3Domain>	验证 L3 逻辑
validateL2	unknown	ValidationResult<L2Block[]>	验证 L2 骨架

类型导出

• L5Blueprint - L5 意图层蓝图
• L4LogicChain - L4 架构层逻辑链
• L3Domain - L3 领域模型
• L2Block - L2 代码骨架块
• L1Code - L1 代码实现
• ValidationResult<T> - 验证结果类型

开发

# 安装依赖
npm install

# 构建
npm run build

# 运行测试
npm run test

License

MIT