easyeda-mcp-pro 0.3.2 → 0.5.2

package/dist/circuit/circuit-ir.d.ts

@@ -0,0 +1,460 @@
+/**
+ * CircuitIR — versioned, validated, machine-readable circuit model.
+ *
+ * CircuitIR is the **source of truth** for downstream EasyEDA operations.
+ * It is produced by compiling a DesignIntent, but can also be authored or
+ * edited directly for advanced use cases.
+ *
+ * Every significant node (Block, Device, Net, Rail) carries a `designIntentRef`
+ * array for traceability back to the originating DesignIntent requirements.
+ *
+ * @schema circuit-ir/v1
+ */
+import { z } from 'zod';
+import { ValidationStatus, NetType, ConstraintSeverity, ConstraintType, BoardLayerType, KeepoutRestriction, PlacementSide, PlacementZoneType, MountingHoleType } from './types.js';
+export declare const CIRCUIT_IR_SCHEMA_VERSION = "circuit-ir/v1";
+export declare const BlockSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        requirementId: z.ZodString;
+        note: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    children: z.ZodDefault<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export type Block = z.infer<typeof BlockSchema>;
+export declare const DeviceSchema: z.ZodObject<{
+    id: z.ZodString;
+    ref: z.ZodString;
+    mpn: z.ZodOptional<z.ZodString>;
+    manufacturer: z.ZodOptional<z.ZodString>;
+    package: z.ZodOptional<z.ZodString>;
+    datasheet: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    lcsc: z.ZodOptional<z.ZodString>;
+    blockRef: z.ZodOptional<z.ZodString>;
+    designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        requirementId: z.ZodString;
+        note: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    metadata: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type Device = z.infer<typeof DeviceSchema>;
+export declare const NetNodeSchema: z.ZodObject<{
+    deviceRef: z.ZodString;
+    pin: z.ZodString;
+}, z.core.$strip>;
+export declare const NetSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodDefault<z.ZodEnum<typeof NetType>>;
+    nodes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        deviceRef: z.ZodString;
+        pin: z.ZodString;
+    }, z.core.$strip>>>;
+    blockRef: z.ZodOptional<z.ZodString>;
+    designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        requirementId: z.ZodString;
+        note: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    metadata: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type Net = z.infer<typeof NetSchema>;
+export type NetNode = z.infer<typeof NetNodeSchema>;
+export declare const PowerRailSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    voltage: z.ZodNumber;
+    tolerance: z.ZodDefault<z.ZodNumber>;
+    maxCurrentAmps: z.ZodOptional<z.ZodNumber>;
+    sourceBlockRef: z.ZodOptional<z.ZodString>;
+    sinkBlockRefs: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        requirementId: z.ZodString;
+        note: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    metadata: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type PowerRail = z.infer<typeof PowerRailSchema>;
+export declare const InterfacePinSchema: z.ZodObject<{
+    pin: z.ZodString;
+    signal: z.ZodString;
+    type: z.ZodOptional<z.ZodEnum<{
+        output: "output";
+        input: "input";
+        power: "power";
+        ground: "ground";
+        bidirectional: "bidirectional";
+    }>>;
+}, z.core.$strip>;
+export declare const InterfaceSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodString;
+    pinout: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        pin: z.ZodString;
+        signal: z.ZodString;
+        type: z.ZodOptional<z.ZodEnum<{
+            output: "output";
+            input: "input";
+            power: "power";
+            ground: "ground";
+            bidirectional: "bidirectional";
+        }>>;
+    }, z.core.$strip>>>;
+    blockRef: z.ZodOptional<z.ZodString>;
+    designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        requirementId: z.ZodString;
+        note: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type Interface = z.infer<typeof InterfaceSchema>;
+export type InterfacePin = z.infer<typeof InterfacePinSchema>;
+export declare const ConstraintSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodEnum<typeof ConstraintType>;
+    severity: z.ZodDefault<z.ZodEnum<typeof ConstraintSeverity>>;
+    description: z.ZodString;
+    scope: z.ZodOptional<z.ZodString>;
+    designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        requirementId: z.ZodString;
+        note: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type Constraint = z.infer<typeof ConstraintSchema>;
+export declare const BomIntentSchema: z.ZodObject<{
+    excludeRefs: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    preferredVendors: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    costTargetUsd: z.ZodOptional<z.ZodNumber>;
+    notes: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type BomIntent = z.infer<typeof BomIntentSchema>;
+export declare const PcbIntentSchema: z.ZodObject<{
+    layerCount: z.ZodOptional<z.ZodNumber>;
+    stackup: z.ZodOptional<z.ZodString>;
+    widthMm: z.ZodOptional<z.ZodNumber>;
+    heightMm: z.ZodOptional<z.ZodNumber>;
+    material: z.ZodOptional<z.ZodString>;
+    notes: z.ZodOptional<z.ZodString>;
+    boardOutline: z.ZodOptional<z.ZodObject<{
+        shape: z.ZodArray<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>>;
+        cutouts: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>>>>;
+    }, z.core.$strip>>;
+    layerStack: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodEnum<typeof BoardLayerType>;
+        thicknessMm: z.ZodNumber;
+        material: z.ZodString;
+        copperWeightOz: z.ZodOptional<z.ZodNumber>;
+        dielectricConstant: z.ZodOptional<z.ZodNumber>;
+        order: z.ZodNumber;
+    }, z.core.$strip>>>;
+    netClasses: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        traceWidthMm: z.ZodNumber;
+        clearanceMm: z.ZodNumber;
+        viaDiameterMm: z.ZodOptional<z.ZodNumber>;
+        viaHoleMm: z.ZodOptional<z.ZodNumber>;
+        priority: z.ZodOptional<z.ZodNumber>;
+        netNames: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>>;
+    clearanceRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        netClassA: z.ZodString;
+        netClassB: z.ZodString;
+        clearanceMm: z.ZodNumber;
+        layer: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    keepoutAreas: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        outline: z.ZodArray<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>>;
+        layer: z.ZodString;
+        restriction: z.ZodEnum<typeof KeepoutRestriction>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    placementZones: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        outline: z.ZodArray<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>>;
+        layer: z.ZodEnum<typeof PlacementSide>;
+        zoneType: z.ZodEnum<typeof PlacementZoneType>;
+        name: z.ZodString;
+        allowedRefs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    mountingHoles: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        diameterMm: z.ZodNumber;
+        type: z.ZodDefault<z.ZodEnum<typeof MountingHoleType>>;
+        plated: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    fiducials: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        type: z.ZodEnum<{
+            local: "local";
+            global: "global";
+        }>;
+        top: z.ZodBoolean;
+        bottom: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    testPads: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        netName: z.ZodString;
+        diameterMm: z.ZodNumber;
+        layer: z.ZodEnum<typeof PlacementSide>;
+        label: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type PcbIntent = z.infer<typeof PcbIntentSchema>;
+export declare const ManufacturingIntentSchema: z.ZodObject<{
+    quantity: z.ZodOptional<z.ZodNumber>;
+    process: z.ZodOptional<z.ZodEnum<{
+        "lead-free": "lead-free";
+        "lead-based": "lead-based";
+        mixed: "mixed";
+    }>>;
+    timelineWeeks: z.ZodOptional<z.ZodNumber>;
+    notes: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ManufacturingIntent = z.infer<typeof ManufacturingIntentSchema>;
+export declare const CircuitIRSchema: z.ZodObject<{
+    $schema: z.ZodDefault<z.ZodLiteral<"circuit-ir/v1">>;
+    metadata: z.ZodObject<{
+        version: z.ZodDefault<z.ZodLiteral<"1.0.0">>;
+        createdAt: z.ZodOptional<z.ZodString>;
+        designIntentRef: z.ZodOptional<z.ZodString>;
+        validationStatus: z.ZodDefault<z.ZodEnum<typeof ValidationStatus>>;
+    }, z.core.$strip>;
+    blocks: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            requirementId: z.ZodString;
+            note: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        children: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>>;
+    devices: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        ref: z.ZodString;
+        mpn: z.ZodOptional<z.ZodString>;
+        manufacturer: z.ZodOptional<z.ZodString>;
+        package: z.ZodOptional<z.ZodString>;
+        datasheet: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+        lcsc: z.ZodOptional<z.ZodString>;
+        blockRef: z.ZodOptional<z.ZodString>;
+        designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            requirementId: z.ZodString;
+            note: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        metadata: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+    nets: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodDefault<z.ZodEnum<typeof NetType>>;
+        nodes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            deviceRef: z.ZodString;
+            pin: z.ZodString;
+        }, z.core.$strip>>>;
+        blockRef: z.ZodOptional<z.ZodString>;
+        designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            requirementId: z.ZodString;
+            note: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        metadata: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+    rails: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        voltage: z.ZodNumber;
+        tolerance: z.ZodDefault<z.ZodNumber>;
+        maxCurrentAmps: z.ZodOptional<z.ZodNumber>;
+        sourceBlockRef: z.ZodOptional<z.ZodString>;
+        sinkBlockRefs: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            requirementId: z.ZodString;
+            note: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        metadata: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+    interfaces: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+        pinout: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            pin: z.ZodString;
+            signal: z.ZodString;
+            type: z.ZodOptional<z.ZodEnum<{
+                output: "output";
+                input: "input";
+                power: "power";
+                ground: "ground";
+                bidirectional: "bidirectional";
+            }>>;
+        }, z.core.$strip>>>;
+        blockRef: z.ZodOptional<z.ZodString>;
+        designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            requirementId: z.ZodString;
+            note: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+    constraints: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodEnum<typeof ConstraintType>;
+        severity: z.ZodDefault<z.ZodEnum<typeof ConstraintSeverity>>;
+        description: z.ZodString;
+        scope: z.ZodOptional<z.ZodString>;
+        designIntentRef: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            requirementId: z.ZodString;
+            note: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>>;
+    bom: z.ZodDefault<z.ZodObject<{
+        excludeRefs: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        preferredVendors: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        costTargetUsd: z.ZodOptional<z.ZodNumber>;
+        notes: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    pcb: z.ZodDefault<z.ZodObject<{
+        layerCount: z.ZodOptional<z.ZodNumber>;
+        stackup: z.ZodOptional<z.ZodString>;
+        widthMm: z.ZodOptional<z.ZodNumber>;
+        heightMm: z.ZodOptional<z.ZodNumber>;
+        material: z.ZodOptional<z.ZodString>;
+        notes: z.ZodOptional<z.ZodString>;
+        boardOutline: z.ZodOptional<z.ZodObject<{
+            shape: z.ZodArray<z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+            }, z.core.$strip>>;
+            cutouts: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+            }, z.core.$strip>>>>;
+        }, z.core.$strip>>;
+        layerStack: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            type: z.ZodEnum<typeof BoardLayerType>;
+            thicknessMm: z.ZodNumber;
+            material: z.ZodString;
+            copperWeightOz: z.ZodOptional<z.ZodNumber>;
+            dielectricConstant: z.ZodOptional<z.ZodNumber>;
+            order: z.ZodNumber;
+        }, z.core.$strip>>>;
+        netClasses: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            traceWidthMm: z.ZodNumber;
+            clearanceMm: z.ZodNumber;
+            viaDiameterMm: z.ZodOptional<z.ZodNumber>;
+            viaHoleMm: z.ZodOptional<z.ZodNumber>;
+            priority: z.ZodOptional<z.ZodNumber>;
+            netNames: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strip>>>;
+        clearanceRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            netClassA: z.ZodString;
+            netClassB: z.ZodString;
+            clearanceMm: z.ZodNumber;
+            layer: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        keepoutAreas: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            outline: z.ZodArray<z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+            }, z.core.$strip>>;
+            layer: z.ZodString;
+            restriction: z.ZodEnum<typeof KeepoutRestriction>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        placementZones: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            outline: z.ZodArray<z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+            }, z.core.$strip>>;
+            layer: z.ZodEnum<typeof PlacementSide>;
+            zoneType: z.ZodEnum<typeof PlacementZoneType>;
+            name: z.ZodString;
+            allowedRefs: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        mountingHoles: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            diameterMm: z.ZodNumber;
+            type: z.ZodDefault<z.ZodEnum<typeof MountingHoleType>>;
+            plated: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+        fiducials: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            type: z.ZodEnum<{
+                local: "local";
+                global: "global";
+            }>;
+            top: z.ZodBoolean;
+            bottom: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+        testPads: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            netName: z.ZodString;
+            diameterMm: z.ZodNumber;
+            layer: z.ZodEnum<typeof PlacementSide>;
+            label: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    manufacturing: z.ZodDefault<z.ZodObject<{
+        quantity: z.ZodOptional<z.ZodNumber>;
+        process: z.ZodOptional<z.ZodEnum<{
+            "lead-free": "lead-free";
+            "lead-based": "lead-based";
+            mixed: "mixed";
+        }>>;
+        timelineWeeks: z.ZodOptional<z.ZodNumber>;
+        notes: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strict>;
+export type CircuitIR = z.infer<typeof CircuitIRSchema>;
+/**
+ * Parse and validate an unknown input as a CircuitIR.
+ *
+ * Returns the validated CircuitIR on success.
+ * Throws `CircuitError` with structured errors on failure.
+ */
+export declare function validateCircuitIR(input: unknown): CircuitIR;
+/**
+ * Type guard: check whether an unknown value is a valid CircuitIR.
+ */
+export declare function isCircuitIR(value: unknown): value is CircuitIR;