import-validation

Import Validation

The repo uses a domain/layer/plane package layering architecture with unidirectional dependencies enforced by Dependency Cruiser, driven by data from architecture.config.json.

Domain/Layer/Plane Structure

Packages are organized by:

• Domains: framework (target-agnostic) and target families (sql, document, etc.).
• Layers: dependencies flow inward (toward core) within a domain — core → authoring → targets → lanes → runtime → adapters.
• Planes: migration (authoring, tooling, targets), runtime (lanes, runtime, adapters), and shared (cross-plane code and prebuilt artifacts safe for both).

Configuration (architecture.config.json)

dependency-cruiser.config.mjs reads data-driven config:

1. Package configs map a glob to domain/layer/plane:

   { "glob": "packages/framework/core-plan/**", "domain": "framework", "layer": "core", "plane": "shared" }
   

2. Layer order defines dependency direction per domain:

   { "layerOrder": { "sql": ["core", "authoring", "targets", "lanes", "runtime", "adapters"] } }
   

3. Rules define allowed/denied patterns:

   { "rules": { "sameLayer": "allow", "downward": "allow", "upward": "deny",
     "crossDomain": "denyExceptFramework", "migrationToRuntime": "deny",
     "runtimeToMigration": "allowArtifactsOnly" } }
   

4. Plane rules declare per-plane allow/forbid plus exceptions:

   { "planeRules": {
     "shared":    { "allow": ["shared"],            "forbid": ["migration", "runtime"], "exceptions": [] },
     "migration": { "allow": ["shared", "migration"], "forbid": ["runtime"],            "exceptions": [] },
     "runtime":   { "allow": ["shared", "runtime"],   "forbid": ["migration"],           "exceptions": [] } } }
   

Rules

• Same-layer imports allowed — e.g. orm-lane may import sql-relational-core (both lanes):

  import { schema } from '@internal/sql-relational-core/schema';
  

• Cross-layer: import only from inner layers (closer to core). Outer layers cannot be imported by inner ones:

  // ✅ lanes importing core
  import { planInvalid } from '@internal/plan';
  // ❌ core importing lanes
  import { sql } from '@internal/sql-lane';