@specverse/engines 5.0.2 → 5.1.0

package/assets/examples/10-api/documentation.md

@@ -1,95 +0,0 @@
-# SpecVerseFundamentals
-
-Example 01-01: Basic model definition with attributes
-
-**Version:** 1.0.0  
-**Generated:** 2026-03-23T18:22:33.403Z
-
-## Table of Contents
-
-- [Overview](#overview)
-- [Models](#models)
-  - [Product](#product)
-
-## Overview
-
-### Component Statistics
-
-| Component Type | Count |
-|----------------|-------|
-| Models | 1 |
-| Controllers | 0 |
-| Services | 0 |
-| Views | 0 |
-| Events | 0 |
-
-### Imports
-
-
-### Exports
-
-**SpecVerseFundamentals:**
-- **models:** Product
-
-## Models
-
-### Product
-
-Simple product with basic attributes
-
-#### Attributes
-
-| Name | Type | Required | Unique | Description |
-|------|------|----------|--------|-------------|
-| id | UUID | ✓ |  |  |
-| name | String | ✓ |  |  |
-| summary | String |  |  |  |
-| price | Money | ✓ |  |  |
-| inStock | Boolean |  |  | Default: true |
-| category | String | ✓ |  |  |
-| contactEmail | Email |  |  |  |
-
-#### Behaviors
-
-##### attachProfile
-
-Attach a profile to this model instance
-
-**Parameters:**
-- `profileName`: String (required)
-
-**Returns:** Boolean
-
-**Preconditions:**
-- Profile exists and is compatible with this model
-
-**Postconditions:**
-- Profile is attached
-- Profile attributes are available
-
-##### detachProfile
-
-Detach a profile from this model instance
-
-**Parameters:**
-- `profileName`: String (required)
-
-**Returns:** Boolean
-
-**Preconditions:**
-- Profile is currently attached
-
-**Postconditions:**
-- Profile is detached
-- Profile attributes are no longer available
-
-##### hasProfile
-
-Check if a profile is attached to this model instance
-
-**Parameters:**
-- `profileName`: String (required)
-
-**Returns:** Boolean
-
----

package/assets/examples/10-api/inferred-spec.yaml

@@ -1,7 +0,0 @@
-name: GeneratedComponent
-version: 3.1.0
-controllers: {}
-services: {}
-events: {}
-views: {}
-models: {}

package/assets/examples/10-api/metadata.yaml

@@ -1,89 +0,0 @@
-# API Integration Examples Metadata
-category: "api"
-title: "SpecVerse API Integration"
-description: "Comprehensive examples for programmatic integration of SpecVerse in TypeScript and JavaScript applications"
-targetAudience: "developers"
-estimatedTime: "2-3 hours"
-
-learningObjectives:
-  - "Master the SpecVerse programmatic API for parsing and validation"
-  - "Integrate AI inference engine into applications"
-  - "Generate UML diagrams and documentation programmatically"
-  - "Handle errors and edge cases in API integration"
-  - "Test and validate API integrations"
-
-examples:
-  - id: "09-01-usage-example"
-    title: "Comprehensive API Usage"
-    description: "Complete workflow examples showing all SpecVerse API capabilities"
-    concepts: ["api", "parsing", "inference", "generation", "integration"]
-    prerequisites: ["basic-javascript", "nodejs"]
-    difficulty: "intermediate"
-    estimatedTime: "45 minutes"
-    formats: ["js", "ts"]
-    learningObjectives:
-      - "Parse and validate SpecVerse specifications programmatically"
-      - "Use AI inference engine to enhance specifications"
-      - "Generate UML diagrams and documentation"
-      - "Handle parsing and validation errors"
-    specverseFeatures: ["Parser API", "Inference Engine", "Generators", "Error Handling"]
-    realWorldUseCase: "Build tools, web applications, automated processing pipelines"
-
-  - id: "09-02-workflow-test"
-    title: "End-to-End API Testing"
-    description: "Focused workflow test for CI/CD and production validation"
-    concepts: ["testing", "ci-cd", "validation", "automation"]
-    prerequisites: ["api-basics"]
-    difficulty: "intermediate" 
-    estimatedTime: "30 minutes"
-    formats: ["js"]
-    learningObjectives:
-      - "Create automated API tests for CI/CD pipelines"
-      - "Validate API functionality with embedded specifications"
-      - "Handle success/failure scenarios appropriately"
-    specverseFeatures: ["API Testing", "Validation", "CI/CD Integration"]
-    realWorldUseCase: "Automated testing, build pipelines, API health checks"
-
-  - id: "09-03-package-integration"
-    title: "Package Integration Testing"
-    description: "Validate complete npm package installation and API functionality"
-    concepts: ["npm", "package-testing", "integration", "real-world-usage"]
-    prerequisites: ["api-basics", "npm-knowledge"]
-    difficulty: "advanced"
-    estimatedTime: "45 minutes"
-    formats: ["js"]
-    learningObjectives:
-      - "Test complete package installation workflow"
-      - "Validate API functionality in real npm environment"
-      - "Ensure package integrity and completeness"
-    specverseFeatures: ["Package Distribution", "API Validation", "Integration Testing"]
-    realWorldUseCase: "Release validation, package testing, integration verification"
-
-usagePatterns:
-  webApplications:
-    description: "Integration into React, Vue, Angular applications"
-    examples: ["React component generation", "Vue template processing", "Angular service integration"]
-  
-  buildTools:
-    description: "webpack, vite, rollup plugin integration"
-    examples: ["Build-time specification processing", "Asset generation", "Plugin development"]
-  
-  apiServices:
-    description: "Express, Fastify, Koa API endpoint integration"
-    examples: ["Specification validation endpoints", "API generation services", "Documentation APIs"]
-  
-  cliTools:
-    description: "Custom CLI tool development"
-    examples: ["Custom specification processors", "Domain-specific tools", "Workflow automation"]
-
-performanceConsiderations:
-  parsing: "Sub-5ms for typical specifications"
-  inference: "Optimized rule processing engine"
-  memory: "Efficient caching and resource management"
-  concurrency: "Thread-safe for concurrent processing"
-
-nextSteps:
-  - "Integrate SpecVerse into your project using these patterns"
-  - "Customize examples for your specific use case"
-  - "Use workflow-test.js patterns for production validation" 
-  - "Explore advanced inference engine configuration options"

package/assets/examples/10-api/openapi.json

@@ -1,61 +0,0 @@
-{
-  "openapi": "3.0.3",
-  "info": {
-    "title": "SpecVerseFundamentals",
-    "description": "Example 01-01: Basic model definition with attributes",
-    "version": "1.0.0"
-  },
-  "servers": [
-    {
-      "url": "https://api.example.com"
-    }
-  ],
-  "paths": {},
-  "components": {
-    "schemas": {
-      "Product": {
-        "type": "object",
-        "description": "Simple product with basic attributes",
-        "properties": {
-          "id": {
-            "type": "string",
-            "description": ""
-          },
-          "name": {
-            "type": "string",
-            "description": ""
-          },
-          "summary": {
-            "type": "string",
-            "description": ""
-          },
-          "price": {
-            "type": "string",
-            "description": ""
-          },
-          "inStock": {
-            "type": "boolean",
-            "description": "Default: true",
-            "default": "true"
-          },
-          "category": {
-            "type": "string",
-            "description": ""
-          },
-          "contactEmail": {
-            "type": "string",
-            "description": ""
-          }
-        },
-        "required": [
-          "id",
-          "name",
-          "price",
-          "category"
-        ]
-      }
-    },
-    "responses": {},
-    "parameters": {}
-  }
-}

package/assets/examples/10-api/package-integration-test.js

@@ -1,177 +0,0 @@
-#!/usr/bin/env node
-/**
- * SpecVerse npm Package Integration Test
- * 
- * Tests the actual npm package installation and API usage
- * This validates that the built package works when installed externally
- */
-
-import { execSync } from 'child_process';
-import { mkdtempSync, rmSync, writeFileSync, readFileSync } from 'fs';
-import { tmpdir } from 'os';
-import { join } from 'path';
-
-async function testPackageIntegration() {
-  console.log('🧪 Testing npm package integration...');
-  
-  let testDir;
-  let packagePath;
-  
-  try {
-    // 1. Create package from current source
-    console.log('1️⃣ Creating package...');
-    const packOutput = execSync('npm pack --silent', { encoding: 'utf8' }).trim();
-    // Extract just the .tgz filename from the output (last line that ends with .tgz)
-    const tgzFilename = packOutput.split('\n').filter(line => line.endsWith('.tgz')).pop() || packOutput;
-    packagePath = join(process.cwd(), tgzFilename);
-    console.log(`✅ Package created: ${tgzFilename}`);
-    
-    // 2. Create temporary test directory
-    console.log('2️⃣ Setting up test environment...');
-    testDir = mkdtempSync(join(tmpdir(), 'specverse-test-'));
-    console.log(`✅ Test directory: ${testDir}`);
-    
-    // 3. Install package in test directory
-    console.log('3️⃣ Installing package...');
-    execSync(`cd "${testDir}" && npm init -y --silent`, { stdio: 'ignore' });
-    // Set type to module for ES module support
-    const packageJsonPath = join(testDir, 'package.json');
-    const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
-    packageJson.type = 'module';
-    writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
-    execSync(`cd "${testDir}" && npm install "${packagePath}" --silent`, { stdio: 'ignore' });
-    console.log('✅ Package installed successfully');
-    
-    // 4. Create test script (ES module)
-    console.log('4️⃣ Creating test script...');
-    const testScript = `
-import { SpecVerseParser, LogicalInferenceEngine } from '@specverse/lang';
-import { readFileSync } from 'fs';
-import { join, dirname } from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-async function runTest() {
-  console.log('🔍 Testing installed package...');
-
-  // Simple test specification
-  const testSpec = \`components:
-  TestComponent:
-    version: "3.2.0"
-    description: "Test component for package integration"
-
-    models:
-      Product:
-        description: "Test product model"
-        attributes:
-          id: UUID required unique
-          name: String required
-          price: Number required
-        lifecycles:
-          status:
-            flow: draft -> active -> archived
-
-deployments: {}
-\`;
-
-  try {
-    // Test 1: Parse specification
-    const schemaPath = join(__dirname, 'node_modules/@specverse/lang/schema/SPECVERSE-SCHEMA.json');
-    const schema = JSON.parse(readFileSync(schemaPath, 'utf8'));
-    const parser = new SpecVerseParser(schema);
-
-    const parseResult = parser.parseContent(testSpec, 'test.specly');
-    if (parseResult.errors.length > 0) {
-      throw new Error('Parsing failed: ' + parseResult.errors.map(e => e.message).join(', '));
-    }
-    console.log('✅ Parsing successful');
-
-    // Test 2: Run inference
-    const config = {
-      logical: {
-        generateControllers: true,
-        generateServices: true,
-        generateEvents: true,
-        generateViews: true
-      },
-      rules: {
-        logicalRulesPath: join(__dirname, 'node_modules/@specverse/lang/dist/inference-engine/rules/logical')
-      }
-    };
-
-    const engine = new LogicalInferenceEngine(config);
-    await engine.loadRules();
-
-    // Get the first (and only) component since parser uses array-style indexing
-    const componentName = Object.keys(parseResult.ast.components)[0];
-    const component = parseResult.ast.components[componentName];
-    const models = component.models;
-    const inference = await engine.inferLogicalSpecification(models, 'TestComponent');
-
-    console.log(\`✅ Inference successful:\`);
-    console.log(\`   Controllers: \${Object.keys(inference.controllers || {}).length}\`);
-    console.log(\`   Services: \${Object.keys(inference.services || {}).length}\`);
-    console.log(\`   Events: \${Object.keys(inference.events || {}).length}\`);
-    console.log(\`   Views: \${Object.keys(inference.views || {}).length}\`);
-
-    console.log('🎉 PACKAGE INTEGRATION TEST SUCCESS!');
-    process.exit(0);
-
-  } catch (error) {
-    console.error('❌ Test failed:', error.message);
-    process.exit(1);
-  }
-}
-
-runTest();
-`;
-    
-    writeFileSync(join(testDir, 'test.js'), testScript);
-    console.log('✅ Test script created');
-    
-    // 5. Run the test
-    console.log('5️⃣ Running package integration test...');
-    execSync(`cd "${testDir}" && node test.js`, { 
-      stdio: 'inherit',
-      timeout: 30000 
-    });
-    
-    console.log('🎉 npm Package Integration Test PASSED!');
-    
-  } catch (error) {
-    console.error('❌ Package integration test failed:', error.message);
-    throw error;
-    
-  } finally {
-    // Cleanup
-    if (testDir) {
-      try {
-        rmSync(testDir, { recursive: true, force: true });
-        console.log('🧹 Cleaned up test directory');
-      } catch (cleanupError) {
-        console.warn('⚠️ Could not clean up test directory:', cleanupError.message);
-      }
-    }
-    
-    if (packagePath) {
-      try {
-        rmSync(packagePath, { force: true });
-        console.log('🧹 Cleaned up package file');
-      } catch (cleanupError) {
-        console.warn('⚠️ Could not clean up package file:', cleanupError.message);
-      }
-    }
-  }
-}
-
-// Run if called directly
-if (import.meta.url === `file://${process.argv[1]}`) {
-  testPackageIntegration().catch((error) => {
-    console.error('Package integration test failed:', error.message);
-    process.exit(1);
-  });
-}
-
-export { testPackageIntegration };