@typecad/cuttlefish 0.1.0-alpha.1

package/dist/create/board-spec.d.ts

@@ -0,0 +1,640 @@
+import { z } from 'zod';
+export declare function stripJsonc(text: string): string;
+export declare const BoardSpecSchema: z.ZodObject<{
+    architecture: z.ZodString;
+    mcuId: z.ZodString;
+    mcuName: z.ZodString;
+    boardId: z.ZodString;
+    boardName: z.ZodString;
+    vendor: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    clockSpeed: z.ZodNumber;
+    fqbn: z.ZodString;
+    platformioTarget: z.ZodString;
+    arduinoDefine: z.ZodString;
+    moduleFlash: z.ZodNullable<z.ZodNumber>;
+    externalRam: z.ZodNullable<z.ZodNumber>;
+    gpioRange: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+    excludedGpio: z.ZodArray<z.ZodNumber, "many">;
+    pins: z.ZodArray<z.ZodObject<{
+        gpio: z.ZodNumber;
+        capabilities: z.ZodEnum<["FULL_GPIO", "FULL_GPIO_ANALOG", "FULL_GPIO_TOUCH", "FULL_GPIO_ANALOG_TOUCH", "FULL_GPIO_DAC", "INPUT_ONLY"]>;
+        functions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            type: z.ZodEnum<["i2c", "spi", "uart", "adc", "dac", "pwm", "touch", "usb"]>;
+            instance: z.ZodNumber;
+            role: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            type: "i2c" | "spi" | "uart" | "adc" | "dac" | "pwm" | "touch" | "usb";
+            instance: number;
+            role: string;
+        }, {
+            type: "i2c" | "spi" | "uart" | "adc" | "dac" | "pwm" | "touch" | "usb";
+            instance: number;
+            role: string;
+        }>, "many">>;
+        alt: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        warnings: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        unsafe: z.ZodOptional<z.ZodBoolean>;
+        notes: z.ZodOptional<z.ZodString>;
+        onboardLed: z.ZodOptional<z.ZodBoolean>;
+    }, "strict", z.ZodTypeAny, {
+        gpio: number;
+        capabilities: "FULL_GPIO" | "FULL_GPIO_ANALOG" | "FULL_GPIO_TOUCH" | "FULL_GPIO_ANALOG_TOUCH" | "FULL_GPIO_DAC" | "INPUT_ONLY";
+        functions?: {
+            type: "i2c" | "spi" | "uart" | "adc" | "dac" | "pwm" | "touch" | "usb";
+            instance: number;
+            role: string;
+        }[] | undefined;
+        alt?: string[] | undefined;
+        warnings?: string[] | undefined;
+        unsafe?: boolean | undefined;
+        notes?: string | undefined;
+        onboardLed?: boolean | undefined;
+    }, {
+        gpio: number;
+        capabilities: "FULL_GPIO" | "FULL_GPIO_ANALOG" | "FULL_GPIO_TOUCH" | "FULL_GPIO_ANALOG_TOUCH" | "FULL_GPIO_DAC" | "INPUT_ONLY";
+        functions?: {
+            type: "i2c" | "spi" | "uart" | "adc" | "dac" | "pwm" | "touch" | "usb";
+            instance: number;
+            role: string;
+        }[] | undefined;
+        alt?: string[] | undefined;
+        warnings?: string[] | undefined;
+        unsafe?: boolean | undefined;
+        notes?: string | undefined;
+        onboardLed?: boolean | undefined;
+    }>, "many">;
+    unsafe: z.ZodArray<z.ZodString, "many">;
+    analog: z.ZodArray<z.ZodString, "many">;
+    i2c: z.ZodRecord<z.ZodString, z.ZodObject<{
+        sda: z.ZodOptional<z.ZodString>;
+        scl: z.ZodOptional<z.ZodString>;
+        mosi: z.ZodOptional<z.ZodString>;
+        miso: z.ZodOptional<z.ZodString>;
+        sck: z.ZodOptional<z.ZodString>;
+        cs: z.ZodOptional<z.ZodString>;
+        tx: z.ZodOptional<z.ZodString>;
+        rx: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }>>;
+    spi: z.ZodRecord<z.ZodString, z.ZodObject<{
+        sda: z.ZodOptional<z.ZodString>;
+        scl: z.ZodOptional<z.ZodString>;
+        mosi: z.ZodOptional<z.ZodString>;
+        miso: z.ZodOptional<z.ZodString>;
+        sck: z.ZodOptional<z.ZodString>;
+        cs: z.ZodOptional<z.ZodString>;
+        tx: z.ZodOptional<z.ZodString>;
+        rx: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }>>;
+    uart: z.ZodRecord<z.ZodString, z.ZodObject<{
+        sda: z.ZodOptional<z.ZodString>;
+        scl: z.ZodOptional<z.ZodString>;
+        mosi: z.ZodOptional<z.ZodString>;
+        miso: z.ZodOptional<z.ZodString>;
+        sck: z.ZodOptional<z.ZodString>;
+        cs: z.ZodOptional<z.ZodString>;
+        tx: z.ZodOptional<z.ZodString>;
+        rx: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }>>;
+    peripheralInstances: z.ZodObject<{
+        i2c: z.ZodArray<z.ZodObject<{
+            instance: z.ZodNumber;
+            defaultPins: z.ZodRecord<z.ZodString, z.ZodString>;
+            alternatePins: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>>;
+        }, "strict", z.ZodTypeAny, {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }, {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }>, "many">;
+        spi: z.ZodArray<z.ZodObject<{
+            instance: z.ZodNumber;
+            defaultPins: z.ZodRecord<z.ZodString, z.ZodString>;
+            alternatePins: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>>;
+        }, "strict", z.ZodTypeAny, {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }, {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }>, "many">;
+        uart: z.ZodArray<z.ZodObject<{
+            instance: z.ZodNumber;
+            defaultPins: z.ZodRecord<z.ZodString, z.ZodString>;
+            alternatePins: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>>;
+        }, "strict", z.ZodTypeAny, {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }, {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        i2c: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+        spi: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+        uart: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+    }, {
+        i2c: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+        spi: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+        uart: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+    }>;
+    adc: z.ZodArray<z.ZodObject<{
+        instance: z.ZodNumber;
+        channels: z.ZodNumber;
+        resolution: z.ZodNumber;
+        referenceVoltage: z.ZodNumber;
+        maxValue: z.ZodNumber;
+        referenceVoltages: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    }, "strict", z.ZodTypeAny, {
+        instance: number;
+        channels: number;
+        resolution: number;
+        referenceVoltage: number;
+        maxValue: number;
+        referenceVoltages?: Record<string, number> | undefined;
+    }, {
+        instance: number;
+        channels: number;
+        resolution: number;
+        referenceVoltage: number;
+        maxValue: number;
+        referenceVoltages?: Record<string, number> | undefined;
+    }>, "many">;
+    pwm: z.ZodObject<{
+        channels: z.ZodNumber;
+        resolution: z.ZodNumber;
+        maxFrequency: z.ZodNumber;
+    }, "strict", z.ZodTypeAny, {
+        channels: number;
+        resolution: number;
+        maxFrequency: number;
+    }, {
+        channels: number;
+        resolution: number;
+        maxFrequency: number;
+    }>;
+    touch: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        channels: z.ZodNumber;
+        pins: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        channels: number;
+        pins: string[];
+    }, {
+        channels: number;
+        pins: string[];
+    }>>>;
+    timers: z.ZodArray<z.ZodObject<{
+        instance: z.ZodNumber;
+        type: z.ZodEnum<["general", "high_speed", "rtc", "sys"]>;
+        bits: z.ZodUnion<[z.ZodLiteral<8>, z.ZodLiteral<16>, z.ZodLiteral<32>, z.ZodLiteral<64>]>;
+        features: z.ZodOptional<z.ZodArray<z.ZodEnum<["pwm", "capture", "compare", "interrupt", "dma"]>, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        type: "general" | "high_speed" | "rtc" | "sys";
+        instance: number;
+        bits: 16 | 8 | 32 | 64;
+        features?: ("pwm" | "capture" | "compare" | "interrupt" | "dma")[] | undefined;
+    }, {
+        type: "general" | "high_speed" | "rtc" | "sys";
+        instance: number;
+        bits: 16 | 8 | 32 | 64;
+        features?: ("pwm" | "capture" | "compare" | "interrupt" | "dma")[] | undefined;
+    }>, "many">;
+    wifi: z.ZodObject<{
+        type: z.ZodEnum<["wifi", "wifi6"]>;
+        supportsStation: z.ZodBoolean;
+        supportsAp: z.ZodBoolean;
+    }, "strict", z.ZodTypeAny, {
+        type: "wifi" | "wifi6";
+        supportsStation: boolean;
+        supportsAp: boolean;
+    }, {
+        type: "wifi" | "wifi6";
+        supportsStation: boolean;
+        supportsAp: boolean;
+    }>;
+    bluetooth: z.ZodObject<{
+        type: z.ZodEnum<["classic", "ble", "dual"]>;
+        version: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        type: "classic" | "ble" | "dual";
+        version: string;
+    }, {
+        type: "classic" | "ble" | "dual";
+        version: string;
+    }>;
+    usb: z.ZodObject<{
+        type: z.ZodEnum<["device", "host", "otg"]>;
+        vid: z.ZodString;
+        pid: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        type: "device" | "host" | "otg";
+        vid: string;
+        pid: string;
+    }, {
+        type: "device" | "host" | "otg";
+        vid: string;
+        pid: string;
+    }>;
+    features: z.ZodObject<{
+        multicore: z.ZodBoolean;
+        coreCount: z.ZodNumber;
+        deepSleep: z.ZodBoolean;
+        watchdog: z.ZodBoolean;
+        externalInterrupts: z.ZodBoolean;
+        hardwareRng: z.ZodBoolean;
+        fpu: z.ZodBoolean;
+    }, "strict", z.ZodTypeAny, {
+        multicore: boolean;
+        coreCount: number;
+        deepSleep: boolean;
+        watchdog: boolean;
+        externalInterrupts: boolean;
+        hardwareRng: boolean;
+        fpu: boolean;
+    }, {
+        multicore: boolean;
+        coreCount: number;
+        deepSleep: boolean;
+        watchdog: boolean;
+        externalInterrupts: boolean;
+        hardwareRng: boolean;
+        fpu: boolean;
+    }>;
+    memory: z.ZodObject<{
+        flash: z.ZodNumber;
+        sram: z.ZodNumber;
+        eeprom: z.ZodNumber;
+        externalRam: z.ZodOptional<z.ZodNumber>;
+        rtcMemory: z.ZodOptional<z.ZodNumber>;
+    }, "strict", z.ZodTypeAny, {
+        flash: number;
+        sram: number;
+        eeprom: number;
+        externalRam?: number | undefined;
+        rtcMemory?: number | undefined;
+    }, {
+        flash: number;
+        sram: number;
+        eeprom: number;
+        externalRam?: number | undefined;
+        rtcMemory?: number | undefined;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    architecture: string;
+    i2c: Record<string, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }>;
+    spi: Record<string, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }>;
+    uart: Record<string, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }>;
+    adc: {
+        instance: number;
+        channels: number;
+        resolution: number;
+        referenceVoltage: number;
+        maxValue: number;
+        referenceVoltages?: Record<string, number> | undefined;
+    }[];
+    pwm: {
+        channels: number;
+        resolution: number;
+        maxFrequency: number;
+    };
+    usb: {
+        type: "device" | "host" | "otg";
+        vid: string;
+        pid: string;
+    };
+    wifi: {
+        type: "wifi" | "wifi6";
+        supportsStation: boolean;
+        supportsAp: boolean;
+    };
+    unsafe: string[];
+    mcuId: string;
+    mcuName: string;
+    boardId: string;
+    boardName: string;
+    vendor: string;
+    clockSpeed: number;
+    fqbn: string;
+    platformioTarget: string;
+    arduinoDefine: string;
+    moduleFlash: number | null;
+    externalRam: number | null;
+    gpioRange: [number, number];
+    excludedGpio: number[];
+    pins: {
+        gpio: number;
+        capabilities: "FULL_GPIO" | "FULL_GPIO_ANALOG" | "FULL_GPIO_TOUCH" | "FULL_GPIO_ANALOG_TOUCH" | "FULL_GPIO_DAC" | "INPUT_ONLY";
+        functions?: {
+            type: "i2c" | "spi" | "uart" | "adc" | "dac" | "pwm" | "touch" | "usb";
+            instance: number;
+            role: string;
+        }[] | undefined;
+        alt?: string[] | undefined;
+        warnings?: string[] | undefined;
+        unsafe?: boolean | undefined;
+        notes?: string | undefined;
+        onboardLed?: boolean | undefined;
+    }[];
+    analog: string[];
+    peripheralInstances: {
+        i2c: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+        spi: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+        uart: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+    };
+    timers: {
+        type: "general" | "high_speed" | "rtc" | "sys";
+        instance: number;
+        bits: 16 | 8 | 32 | 64;
+        features?: ("pwm" | "capture" | "compare" | "interrupt" | "dma")[] | undefined;
+    }[];
+    features: {
+        multicore: boolean;
+        coreCount: number;
+        deepSleep: boolean;
+        watchdog: boolean;
+        externalInterrupts: boolean;
+        hardwareRng: boolean;
+        fpu: boolean;
+    };
+    bluetooth: {
+        type: "classic" | "ble" | "dual";
+        version: string;
+    };
+    memory: {
+        flash: number;
+        sram: number;
+        eeprom: number;
+        externalRam?: number | undefined;
+        rtcMemory?: number | undefined;
+    };
+    touch?: {
+        channels: number;
+        pins: string[];
+    } | null | undefined;
+    description?: string | undefined;
+}, {
+    architecture: string;
+    i2c: Record<string, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }>;
+    spi: Record<string, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }>;
+    uart: Record<string, {
+        sda?: string | undefined;
+        scl?: string | undefined;
+        mosi?: string | undefined;
+        miso?: string | undefined;
+        sck?: string | undefined;
+        cs?: string | undefined;
+        tx?: string | undefined;
+        rx?: string | undefined;
+    }>;
+    adc: {
+        instance: number;
+        channels: number;
+        resolution: number;
+        referenceVoltage: number;
+        maxValue: number;
+        referenceVoltages?: Record<string, number> | undefined;
+    }[];
+    pwm: {
+        channels: number;
+        resolution: number;
+        maxFrequency: number;
+    };
+    usb: {
+        type: "device" | "host" | "otg";
+        vid: string;
+        pid: string;
+    };
+    wifi: {
+        type: "wifi" | "wifi6";
+        supportsStation: boolean;
+        supportsAp: boolean;
+    };
+    unsafe: string[];
+    mcuId: string;
+    mcuName: string;
+    boardId: string;
+    boardName: string;
+    vendor: string;
+    clockSpeed: number;
+    fqbn: string;
+    platformioTarget: string;
+    arduinoDefine: string;
+    moduleFlash: number | null;
+    externalRam: number | null;
+    gpioRange: [number, number];
+    excludedGpio: number[];
+    pins: {
+        gpio: number;
+        capabilities: "FULL_GPIO" | "FULL_GPIO_ANALOG" | "FULL_GPIO_TOUCH" | "FULL_GPIO_ANALOG_TOUCH" | "FULL_GPIO_DAC" | "INPUT_ONLY";
+        functions?: {
+            type: "i2c" | "spi" | "uart" | "adc" | "dac" | "pwm" | "touch" | "usb";
+            instance: number;
+            role: string;
+        }[] | undefined;
+        alt?: string[] | undefined;
+        warnings?: string[] | undefined;
+        unsafe?: boolean | undefined;
+        notes?: string | undefined;
+        onboardLed?: boolean | undefined;
+    }[];
+    analog: string[];
+    peripheralInstances: {
+        i2c: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+        spi: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+        uart: {
+            instance: number;
+            defaultPins: Record<string, string>;
+            alternatePins?: Record<string, string[]> | undefined;
+        }[];
+    };
+    timers: {
+        type: "general" | "high_speed" | "rtc" | "sys";
+        instance: number;
+        bits: 16 | 8 | 32 | 64;
+        features?: ("pwm" | "capture" | "compare" | "interrupt" | "dma")[] | undefined;
+    }[];
+    features: {
+        multicore: boolean;
+        coreCount: number;
+        deepSleep: boolean;
+        watchdog: boolean;
+        externalInterrupts: boolean;
+        hardwareRng: boolean;
+        fpu: boolean;
+    };
+    bluetooth: {
+        type: "classic" | "ble" | "dual";
+        version: string;
+    };
+    memory: {
+        flash: number;
+        sram: number;
+        eeprom: number;
+        externalRam?: number | undefined;
+        rtcMemory?: number | undefined;
+    };
+    touch?: {
+        channels: number;
+        pins: string[];
+    } | null | undefined;
+    description?: string | undefined;
+}>;
+export type BoardSpec = z.infer<typeof BoardSpecSchema>;
+export declare function parseBoardSpec(jsoncText: string): BoardSpec;
+export declare function safeParseBoardSpec(jsoncText: string): {
+    success: true;
+    spec: BoardSpec;
+} | {
+    success: false;
+    errors: string[];
+};