archapi 0.3.0__py3-none-any.whl

archapi/types.py

@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import Any, Dict, List, Optional
+
+
+@dataclass
+class DetectionResult:
+    framework: str
+    confidence: float
+    reasons: List[str] = field(default_factory=list)
+
+
+@dataclass
+class ScanResult:
+    framework: str
+    project_path: Path
+    routes: List[Path] = field(default_factory=list)
+    controllers: List[Path] = field(default_factory=list)
+    services: List[Path] = field(default_factory=list)
+    models: List[Path] = field(default_factory=list)
+    schemas: List[Path] = field(default_factory=list)
+    middleware: List[Path] = field(default_factory=list)
+    tests: List[Path] = field(default_factory=list)
+    config_files: List[Path] = field(default_factory=list)
+    unknown: List[Path] = field(default_factory=list)
+
+
+@dataclass
+class APIGenome:
+    framework: str
+    route_style: str = "unknown"
+    controller_style: str = "unknown"
+    service_style: str = "unknown"
+    model_style: str = "unknown"
+    schema_style: str = "unknown"
+    auth_style: str = "unknown"
+    error_style: str = "unknown"
+    test_style: str = "unknown"
+    confidence: float = 0.0
+    metadata: Dict[str, Any] = field(default_factory=dict)
+
+
+@dataclass
+class APIPlan:
+    request: str
+    method: str
+    path: str
+    entities: List[str]
+    layers: List[str]
+    generation_allowed: bool
+    reason: Optional[str] = None
+    metadata: Dict[str, Any] = field(default_factory=dict)
+
+
+@dataclass
+class GeneratedFile:
+    path: Path
+    content: str
+    action: str = "create"
+
+
+@dataclass
+class ValidationReport:
+    success: bool
+    errors: List[str] = field(default_factory=list)
+    warnings: List[str] = field(default_factory=list)
+
+
+@dataclass
+class GenerationResult:
+    project_path: Path
+    plan: APIPlan
+    files: List[GeneratedFile]
+    validation_report: ValidationReport
+    warnings: List[str] = field(default_factory=list)
+
+    @property
+    def diff(self) -> str:
+        chunks: List[str] = []
+        for file in self.files:
+            chunks.append(f"--- {file.path}")
+            chunks.append(f"+++ {file.path}")
+            chunks.append(file.content)
+            chunks.append("")
+        return "\n".join(chunks)
+
+    def apply(self) -> None:
+        if not self.validation_report.success:
+            raise RuntimeError(
+                "Cannot apply generated files because validation failed: "
+                + "; ".join(self.validation_report.errors)
+            )
+
+        for generated in self.files:
+            target = self.project_path / generated.path
+            target.parent.mkdir(parents=True, exist_ok=True)
+
+            if target.exists() and generated.action == "create":
+                raise FileExistsError(f"Refusing to overwrite existing file: {target}")
+
+            target.write_text(generated.content, encoding="utf-8")

archapi/validation/architecture_score.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Dict, List
+
+from archapi.types import APIGenome, GeneratedFile
+
+
+@dataclass
+class ArchitectureScore:
+    score: float
+    max_score: float
+    percentage: float
+    passed: Dict[str, bool] = field(default_factory=dict)
+    notes: List[str] = field(default_factory=list)
+
+
+class ArchitectureConsistencyScorer:
+    """
+    Scores whether generated API files follow the detected project architecture.
+
+    v0.3 supports Express TypeScript and FastAPI layer conventions.
+    """
+
+    def score(self, files: List[GeneratedFile], genome: APIGenome) -> ArchitectureScore:
+        generated_paths = [str(file.path).replace("\\", "/") for file in files]
+        generated_text = "\n".join(file.content for file in files)
+
+        if genome.framework == "fastapi":
+            checks = self._score_fastapi(generated_paths, generated_text, genome)
+        else:
+            checks = self._score_express(generated_paths, generated_text, genome)
+
+        max_score = float(len(checks))
+        raw_score = float(sum(1 for value in checks.values() if value))
+        percentage = round((raw_score / max_score) * 100, 2) if max_score else 0.0
+
+        notes = [
+            f"Failed architecture check: {name}"
+            for name, passed in checks.items()
+            if not passed
+        ]
+
+        return ArchitectureScore(
+            score=raw_score,
+            max_score=max_score,
+            percentage=percentage,
+            passed=checks,
+            notes=notes,
+        )
+
+    def _score_express(self, paths: List[str], text: str, genome: APIGenome) -> Dict[str, bool]:
+        return {
+            "has_route_layer": any("/routes/" in p or p.startswith("src/routes/") for p in paths),
+            "has_controller_layer": any("/controllers/" in p or p.startswith("src/controllers/") for p in paths),
+            "has_service_layer": any("/services/" in p or p.startswith("src/services/") for p in paths),
+            "has_schema_layer": any("/schemas/" in p or p.startswith("src/schemas/") for p in paths),
+            "has_test_layer": any("/tests/" in p or p.startswith("tests/") for p in paths),
+            "matches_express_router": genome.framework != "express-typescript" or "Router" in text,
+            "matches_controller_style": genome.controller_style == "unknown" or "Request" in text or "Response" in text,
+            "matches_service_style": genome.service_style == "unknown" or "Service" in text or "service" in text,
+            "matches_schema_style": genome.schema_style == "unknown" or genome.schema_style not in {"zod", "joi"} or genome.schema_style in text.lower(),
+            "matches_test_style": genome.test_style == "unknown" or "describe(" in text or "it(" in text,
+        }
+
+    def _score_fastapi(self, paths: List[str], text: str, genome: APIGenome) -> Dict[str, bool]:
+        return {
+            "has_router_layer": any("/routers/" in p or p.startswith("app/routers/") for p in paths),
+            "has_service_layer": any("/services/" in p or p.startswith("app/services/") for p in paths),
+            "has_schema_layer": any("/schemas/" in p or p.startswith("app/schemas/") for p in paths),
+            "has_test_layer": any("/tests/" in p or p.startswith("tests/") for p in paths),
+            "matches_apirouter": "APIRouter" in text,
+            "matches_async_endpoint": "async def" in text,
+            "matches_pydantic_schema": "BaseModel" in text,
+            "matches_service_style": "Service" in text or "_service" in text,
+            "matches_test_style": "def test_" in text,
+        }

archapi/validation/basic_validators.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import List
+
+from archapi.types import GeneratedFile, ValidationReport
+
+
+class BasicGeneratedCodeValidator:
+    """
+    Framework-independent validation for generated file objects.
+    """
+
+    def validate(self, files: List[GeneratedFile]) -> ValidationReport:
+        errors: List[str] = []
+        warnings: List[str] = []
+
+        if not files:
+            errors.append("No generated files were provided.")
+
+        seen = set()
+
+        for generated in files:
+            if not generated.content.strip():
+                errors.append(f"Generated file is empty: {generated.path}")
+
+            if str(generated.path) in seen:
+                errors.append(f"Duplicate generated path: {generated.path}")
+
+            seen.add(str(generated.path))
+
+            if Path(generated.path).is_absolute():
+                errors.append(f"Generated path must be relative, got absolute path: {generated.path}")
+
+            if ".." in Path(generated.path).parts:
+                errors.append(f"Generated path must not contain '..': {generated.path}")
+
+        return ValidationReport(success=len(errors) == 0, errors=errors, warnings=warnings)

archapi/validation/command_validator.py

@@ -0,0 +1,146 @@
+from __future__ import annotations
+
+import json
+import subprocess
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import Dict, List, Optional
+
+
+@dataclass
+class CommandResult:
+    name: str
+    command: List[str]
+    skipped: bool
+    success: bool
+    returncode: Optional[int] = None
+    stdout: str = ""
+    stderr: str = ""
+    reason: Optional[str] = None
+
+
+@dataclass
+class CommandValidationReport:
+    success: bool
+    results: List[CommandResult] = field(default_factory=list)
+
+    @property
+    def errors(self) -> List[str]:
+        messages: List[str] = []
+        for result in self.results:
+            if not result.skipped and not result.success:
+                messages.append(
+                    f"{result.name} failed with exit code {result.returncode}"
+                )
+        return messages
+
+
+class CommandValidator:
+    """
+    Runs project validation commands only when they are available.
+
+    v0.2 supports Node/TypeScript package.json scripts:
+    - build
+    - test
+    - lint
+    """
+
+    def __init__(self, project_path: Path):
+        self.project_path = Path(project_path)
+
+    def validate_node_project(self) -> CommandValidationReport:
+        package_json = self.project_path / "package.json"
+
+        if not package_json.exists():
+            return CommandValidationReport(
+                success=True,
+                results=[
+                    CommandResult(
+                        name="node_project",
+                        command=[],
+                        skipped=True,
+                        success=True,
+                        reason="package.json not found",
+                    )
+                ],
+            )
+
+        try:
+            data = json.loads(package_json.read_text(encoding="utf-8"))
+        except Exception as exc:
+            return CommandValidationReport(
+                success=False,
+                results=[
+                    CommandResult(
+                        name="package_json_parse",
+                        command=[],
+                        skipped=False,
+                        success=False,
+                        reason=f"Failed to parse package.json: {exc}",
+                    )
+                ],
+            )
+
+        scripts: Dict[str, str] = data.get("scripts", {})
+
+        checks = [
+            ("build", ["npm", "run", "build"]),
+            ("test", ["npm", "test"]),
+            ("lint", ["npm", "run", "lint"]),
+        ]
+
+        results: List[CommandResult] = []
+
+        for script_name, command in checks:
+            if script_name not in scripts:
+                results.append(
+                    CommandResult(
+                        name=script_name,
+                        command=command,
+                        skipped=True,
+                        success=True,
+                        reason=f"script '{script_name}' not found in package.json",
+                    )
+                )
+                continue
+
+            results.append(self._run(script_name, command))
+
+        success = all(result.success for result in results)
+        return CommandValidationReport(success=success, results=results)
+
+    def _run(self, name: str, command: List[str]) -> CommandResult:
+        try:
+            completed = subprocess.run(
+                command,
+                cwd=self.project_path,
+                capture_output=True,
+                text=True,
+                timeout=60,
+            )
+
+            return CommandResult(
+                name=name,
+                command=command,
+                skipped=False,
+                success=completed.returncode == 0,
+                returncode=completed.returncode,
+                stdout=completed.stdout[-4000:],
+                stderr=completed.stderr[-4000:],
+            )
+        except FileNotFoundError:
+            return CommandResult(
+                name=name,
+                command=command,
+                skipped=True,
+                success=True,
+                reason=f"Command not available: {command[0]}",
+            )
+        except subprocess.TimeoutExpired:
+            return CommandResult(
+                name=name,
+                command=command,
+                skipped=False,
+                success=False,
+                reason="Command timed out after 60 seconds",
+            )

archapi-0.3.0.dist-info/METADATA

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: archapi
+Version: 0.3.0
+Summary: Architecture-preserving REST API synthesis library
+Author: ArchAPI Research Team
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/rohith5005/archapi
+Project-URL: Repository, https://github.com/rohith5005/archapi
+Project-URL: Issues, https://github.com/rohith5005/archapi/issues
+Keywords: rest-api,code-generation,architecture,express,fastapi
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ArchAPI
+
+ArchAPI is a Python library for architecture-preserving REST API generation.
+
+It scans an existing backend project, detects the framework, understands the project structure, plans a REST API, generates framework-specific files, validates the output, and writes files only when explicitly requested.
+
+---
+
+## Current Status
+
+Current checkpoint: **Phase 3 complete**
+
+Completed:
+
+- Functional Python package
+- Express TypeScript adapter
+- FastAPI adapter
+- Generic fallback adapter
+- Framework detection
+- Project scanning
+- API architecture model
+- Confidence scoring
+- Low-confidence blocking
+- Strict config mode
+- REST intent planner
+- Code generation
+- Dry-run generation
+- Safe apply
+- Overwrite protection
+- Cache and changed-file detection
+- Secret scanner
+- Context redaction
+- Policy gate
+- Architecture consistency score
+- Command validation
+- Unified regression test suite
+
+---
+
+## Supported Frameworks
+
+Dedicated generation support currently exists for:
+
+- Express TypeScript
+- FastAPI
+
+Other frameworks may be detected, but they currently use the generic fallback adapter.
+
+---
+
+## Installation
+
+From the project root:
+
+```bash
+pip install -e .

archapi-0.3.0.dist-info/RECORD

@@ -0,0 +1,33 @@
+archapi/__init__.py,sha256=7KPVSZPtBi98Z0mwpb7ew2pM30Wlkc3_sHG5cGG4BG8,56
+archapi/core.py,sha256=mp08XxxSXAXp3KjAVL5NKmJ1RWjXInJJrbdAIR9bMbc,10164
+archapi/types.py,sha256=vZPvvRgmu3IFl6hbUeQXhbvHzTeQNlQPQJd-tXckOxs,2884
+archapi/frameworks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/frameworks/base.py,sha256=LpYW2n_p7SmO8NTEgN_K2cxR0fsG003gDHZD4XchYig,1382
+archapi/frameworks/detector.py,sha256=4KcRi-2XwxJwvyNpYao3fci-mVyQoNZhBUMnnagzmvM,4056
+archapi/frameworks/fastapi_adapter.py,sha256=vpYlYQKoKJRwB4M4WQ_JQB9I5E0Ix9CL1aqutCl_i_M,7002
+archapi/frameworks/generic.py,sha256=87cZIXyrLQsQ4oPBF5DvwZlnQEGznwF5L0l0j3-iUJY,7173
+archapi/frameworks/registry.py,sha256=TuWk4nX57hZ3bGcoOB1Pqsj2idjkZ7fVvWKRu9RGTqc,900
+archapi/frameworks/express_ts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/frameworks/express_ts/adapter.py,sha256=WtqJaIwMXjc0xPh2NhlOGVLpKV1z0HhTwcy5oPNFlNI,8333
+archapi/generation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/genome/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/indexing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/indexing/cache.py,sha256=JQ48ID5iDhtaMRZiUY7GjYxZl443uFh2oRSsrMmmIAE,3691
+archapi/mapping/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/planning/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/planning/intent_planner.py,sha256=32BJc1wgilb15GNsI-qCM2oHQZ7Y_LB475rxF1WabG8,5226
+archapi/planning/task_dag.py,sha256=qhs2gzLhyMoXzKHwYJKf93-f_5k55hM-jD9tH479HrE,2582
+archapi/scanner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/security/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/security/context_redactor.py,sha256=aoWLBkbPaXwrJM-hp6oalWi2x_T5iRz3bKpaNZ8iQI8,1168
+archapi/security/policy_gate.py,sha256=RL9-9BeOOKxlU_Fv8YOv5M3smFUb4Z1c6mx0O_JlAr4,1860
+archapi/security/secret_scanner.py,sha256=BOk00PM-C71nsKDRAvj_Ncd6nugRYJ2pix5QYd-X-Ds,2623
+archapi/validation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archapi/validation/architecture_score.py,sha256=Blk_6pWtbuNR7q0GPAqLV-y9XitXZa93np8sn17bUdM,3633
+archapi/validation/basic_validators.py,sha256=m5tTyaQ1P5kOkTWpBo0ejI0D8VjiPrBS-RdruBImD9A,1216
+archapi/validation/command_validator.py,sha256=mLOS6VKjJaxxMhMgZGKVX0FGJi20iynNokFpNlDRx-k,4342
+archapi-0.3.0.dist-info/licenses/LICENSE,sha256=r_ruhz8pLL0BO1NnEQBZ9YxDJP8u7N-i-EM4VAkVJok,1053
+archapi-0.3.0.dist-info/METADATA,sha256=XY1MSBDwxrT0JmQ2ls73eHdXQCSmOUWs4AO4JNgbsAE,2095
+archapi-0.3.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+archapi-0.3.0.dist-info/top_level.txt,sha256=UsoF2Svu8dT7Sq21TOAdv7tn7QeWZ_fYi4cNHGuPNRE,8
+archapi-0.3.0.dist-info/RECORD,,

archapi-0.3.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

archapi-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rohith Chikkala
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files, to deal in the Software
+without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

archapi-0.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+archapi