@typecad/cuttlefish 1.0.0-alpha.6 → 1.0.0-alpha.8

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

@@ -10,7 +10,6 @@ export declare const BoardSpecSchema: z.ZodObject<{
     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>;
@@ -262,11 +261,11 @@ export declare const BoardSpecSchema: z.ZodObject<{
         channels: z.ZodNumber;
         pins: z.ZodArray<z.ZodString, "many">;
     }, "strip", z.ZodTypeAny, {
-        channels: number;
         pins: string[];
-    }, {
         channels: number;
+    }, {
         pins: string[];
+        channels: number;
     }>>>;
     timers: z.ZodArray<z.ZodObject<{
         instance: z.ZodNumber;
@@ -276,12 +275,12 @@ export declare const BoardSpecSchema: z.ZodObject<{
     }, "strict", z.ZodTypeAny, {
         type: "general" | "high_speed" | "rtc" | "sys";
         instance: number;
-        bits: 16 | 8 | 32 | 64;
+        bits: 8 | 16 | 32 | 64;
         features?: ("pwm" | "capture" | "compare" | "interrupt" | "dma")[] | undefined;
     }, {
         type: "general" | "high_speed" | "rtc" | "sys";
         instance: number;
-        bits: 16 | 8 | 32 | 64;
+        bits: 8 | 16 | 32 | 64;
         features?: ("pwm" | "capture" | "compare" | "interrupt" | "dma")[] | undefined;
     }>, "many">;
     wifi: z.ZodObject<{
@@ -366,6 +365,32 @@ export declare const BoardSpecSchema: z.ZodObject<{
     }>;
 }, "strict", z.ZodTypeAny, {
     architecture: string;
+    mcuId: string;
+    mcuName: string;
+    boardId: string;
+    boardName: string;
+    vendor: string;
+    clockSpeed: number;
+    fqbn: 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;
+    }[];
     i2c: Record<string, {
         sda?: string | undefined;
         scl?: string | undefined;
@@ -414,39 +439,7 @@ export declare const BoardSpecSchema: z.ZodObject<{
         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: {
@@ -468,7 +461,7 @@ export declare const BoardSpecSchema: z.ZodObject<{
     timers: {
         type: "general" | "high_speed" | "rtc" | "sys";
         instance: number;
-        bits: 16 | 8 | 32 | 64;
+        bits: 8 | 16 | 32 | 64;
         features?: ("pwm" | "capture" | "compare" | "interrupt" | "dma")[] | undefined;
     }[];
     features: {
@@ -480,6 +473,11 @@ export declare const BoardSpecSchema: z.ZodObject<{
         hardwareRng: boolean;
         fpu: boolean;
     };
+    wifi: {
+        type: "wifi" | "wifi6";
+        supportsStation: boolean;
+        supportsAp: boolean;
+    };
     bluetooth: {
         type: "classic" | "ble" | "dual";
         version: string;
@@ -491,13 +489,39 @@ export declare const BoardSpecSchema: z.ZodObject<{
         externalRam?: number | undefined;
         rtcMemory?: number | undefined;
     };
+    description?: string | undefined;
     touch?: {
-        channels: number;
         pins: string[];
+        channels: number;
     } | null | undefined;
-    description?: string | undefined;
 }, {
     architecture: string;
+    mcuId: string;
+    mcuName: string;
+    boardId: string;
+    boardName: string;
+    vendor: string;
+    clockSpeed: number;
+    fqbn: 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;
+    }[];
     i2c: Record<string, {
         sda?: string | undefined;
         scl?: string | undefined;
@@ -546,39 +570,7 @@ export declare const BoardSpecSchema: z.ZodObject<{
         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: {
@@ -600,7 +592,7 @@ export declare const BoardSpecSchema: z.ZodObject<{
     timers: {
         type: "general" | "high_speed" | "rtc" | "sys";
         instance: number;
-        bits: 16 | 8 | 32 | 64;
+        bits: 8 | 16 | 32 | 64;
         features?: ("pwm" | "capture" | "compare" | "interrupt" | "dma")[] | undefined;
     }[];
     features: {
@@ -612,6 +604,11 @@ export declare const BoardSpecSchema: z.ZodObject<{
         hardwareRng: boolean;
         fpu: boolean;
     };
+    wifi: {
+        type: "wifi" | "wifi6";
+        supportsStation: boolean;
+        supportsAp: boolean;
+    };
     bluetooth: {
         type: "classic" | "ble" | "dual";
         version: string;
@@ -623,11 +620,11 @@ export declare const BoardSpecSchema: z.ZodObject<{
         externalRam?: number | undefined;
         rtcMemory?: number | undefined;
     };
+    description?: string | undefined;
     touch?: {
-        channels: number;
         pins: string[];
+        channels: number;
     } | null | undefined;
-    description?: string | undefined;
 }>;
 export type BoardSpec = z.infer<typeof BoardSpecSchema>;
 export declare function parseBoardSpec(jsoncText: string): BoardSpec;

package/dist/create/board-spec.js

@@ -111,7 +111,6 @@ export const BoardSpecSchema = z.object({
     // Build
     clockSpeed: z.number().int(),
     fqbn: z.string().min(1),
-    platformioTarget: z.string().min(1),
     arduinoDefine: z.string().min(1),
     // Memory (module-level; silicon memory is derived)
     moduleFlash: z.number().int().nullable(),

package/dist/create/init-scaffold.d.ts

@@ -6,10 +6,17 @@ export interface KnownTarget {
     isNative: boolean;
     architecture?: ArchitectureIdentifier;
     boardPackage?: string;
-    frameworkPackage: string;
-    framework: string;
+    /** Framework package + id. Optional on embedded targets: the scaffold wizard
+     *  fills these in by discovering installed @typecad/framework-* packages, so
+     *  KNOWN_TARGETS board entries do not hardcode a framework. Native targets
+     *  set them directly. */
+    frameworkPackage?: string;
+    framework?: string;
     buildTarget?: string;
     mcu?: string;
+    /** Framework-specific config (becomes frameworkData in cuttlefish.config.ts).
+     *  Carries framework-specific target/options data for the selected framework. */
+    frameworkData?: Record<string, unknown>;
 }
 export declare function registerKnownTarget(target: KnownTarget): void;
 export declare const KNOWN_TARGETS: ReadonlyArray<KnownTarget>;

package/dist/create/init-scaffold.js

@@ -17,8 +17,6 @@ const _knownTargets = [
         isNative: false,
         architecture: 'avr',
         boardPackage: '@typecad/board-arduino-uno',
-        frameworkPackage: '@typecad/framework-arduino',
-        framework: 'arduino',
         buildTarget: 'arduino:avr:uno',
         mcu: 'atmega328p',
     },
@@ -28,8 +26,6 @@ const _knownTargets = [
         isNative: false,
         architecture: 'esp32',
         boardPackage: '@typecad/board-esp32-devkit',
-        frameworkPackage: '@typecad/framework-arduino',
-        framework: 'arduino',
         buildTarget: 'esp32:esp32:esp32',
         mcu: 'esp32',
     },
@@ -39,8 +35,6 @@ const _knownTargets = [
         isNative: false,
         architecture: 'esp32s3',
         boardPackage: '@typecad/board-esp32s3',
-        frameworkPackage: '@typecad/framework-arduino',
-        framework: 'arduino',
         buildTarget: 'esp32:esp32:esp32s3',
         mcu: 'esp32s3',
     },
@@ -50,8 +44,6 @@ const _knownTargets = [
         isNative: false,
         architecture: 'esp32c3',
         boardPackage: '@typecad/board-esp32c3',
-        frameworkPackage: '@typecad/framework-arduino',
-        framework: 'arduino',
         buildTarget: 'esp32:esp32:esp32c3',
         mcu: 'esp32c3',
     },
@@ -61,8 +53,6 @@ const _knownTargets = [
         isNative: false,
         architecture: 'esp32c6',
         boardPackage: '@typecad/board-esp32c6',
-        frameworkPackage: '@typecad/framework-arduino',
-        framework: 'arduino',
         buildTarget: 'esp32:esp32:esp32c6',
         mcu: 'esp32c6',
     },
@@ -72,8 +62,6 @@ const _knownTargets = [
         isNative: false,
         architecture: 'rp2040',
         boardPackage: '@typecad/board-rp2040',
-        frameworkPackage: '@typecad/framework-arduino',
-        framework: 'arduino',
         buildTarget: 'rp2040:rp2040:rpipico',
         mcu: 'rp2040',
     },
@@ -83,8 +71,6 @@ const _knownTargets = [
         isNative: false,
         architecture: 'rp2350',
         boardPackage: '@typecad/board-rp2350',
-        frameworkPackage: '@typecad/framework-arduino',
-        framework: 'arduino',
         buildTarget: 'rp2040:rp2040:rpipico2',
         mcu: 'rp2350',
     },

package/dist/create/init-templates.d.ts

@@ -13,6 +13,8 @@ export interface InitProjectOptions {
     baudRate?: number;
     includeSketch: boolean;
     toolchainType?: string;
+    /** Extra frameworkData fields (e.g. `{ target: 'esp32s3' }` for framework-esp32). */
+    frameworkData?: Record<string, unknown>;
 }
 export declare function generateProjectPackageJson(options: InitProjectOptions): string;
 export declare function generateProjectTsconfig(options: InitProjectOptions): string;

package/dist/create/init-templates.js

@@ -150,8 +150,12 @@ export default config;
 `;
     }
     const buildTarget = options.buildTarget;
-    const resolvedToolchain = options.toolchainType ?? 'arduino-cli';
-    const buildTargetLine = buildTarget ? `\n  // Framework data\n  frameworkData: {\n    buildTarget: '${buildTarget}',\n  },` : '';
+    const resolvedToolchain = options.toolchainType
+        ?? 'arduino-cli';
+    let frameworkDataBlock = '';
+    if (buildTarget) {
+        frameworkDataBlock = `\n  // Framework data\n  frameworkData: {\n    buildTarget: '${buildTarget}',\n  },`;
+    }
     const mcuLine = options.mcu
         ? `\n  // MCU package — provides silicon-level pin definitions\n  mcu: '${options.mcu.startsWith('@') ? options.mcu : `@typecad/mcu-${options.mcu}`}',\n`
         : '';
@@ -181,7 +185,7 @@ const config: CuttlefishConfig = {
   target: '${options.architecture}',${mcuLine}${boardLine}
 
   // Framework package — controls code generation strategy
-  framework: '${options.frameworkPackage}',${buildTargetLine}
+  framework: '${options.frameworkPackage}',${frameworkDataBlock}
 
   // Output / build options
   output: {
@@ -211,6 +215,22 @@ declare global {
   type Owned<T = unknown> = T;
   type Shared<T = unknown> = T;
   type Mutable<T = unknown> = T;
+  // SafeVariable: SEU-resistant storage. The transpiler lowers SafeVariable<number>
+  // to a C++ template with inverted-redundancy storage. Declared as an interface
+  // (not a type alias) so the TS type checker recognizes method calls.
+  // Arithmetic T only (integral or floating-point); string is rejected by a
+  // static_assert in the emitted C++ template.
+  interface SafeVariable<T = number> { set(value: T): void; get(): T; valid(): boolean; hasFault(): boolean; }
+  // SafeInt: chainable bounds-checked signed-integer arithmetic. The transpiler
+  // lowers SafeInt<number> to SafeInt<int32_t> (a C++ template with sticky-fault
+  // overflow detection). Signed integer T only — unsigned/bool/float/string are
+  // rejected by a static_assert in the emitted C++ template.
+  interface SafeInt<T = number> {
+    add(delta: T): SafeInt<T>; sub(delta: T): SafeInt<T>;
+    mul(factor: T): SafeInt<T>; divide(d: T): SafeInt<T>; mod(d: T): SafeInt<T>;
+    negate(): SafeInt<T>; absValue(): SafeInt<T>;
+    get(): T; hasFault(): boolean; valid(): boolean; reset(newValue: T): void;
+  }
 
   type uint8_t = number;
   type int8_t = number;
@@ -236,6 +256,20 @@ declare global {
     error(...args: unknown[]): void;
   }
   const console: Console;
+
+  // Convenience helper for volatile variables in TypeCAD programs.
+  // The transpiler detects calls to volatile() and emits the C++ volatile qualifier.
+  declare function volatile<T>(value: T): T;
+
+  // JS-style timers (declared here so a project does not need "dom" in tsconfig
+  // lib to type setInterval/setTimeout). The transpiler rewrites these to
+  // __tc_setInterval/__tc_setTimeout and emits the timer_methods polyfill when
+  // used. Note: Timing.setInterval/setTimeout (from @typecad/hal) is the
+  // preferred single entry point and is typed via the @typecad/board import.
+  declare function setInterval(handler: () => void, timeout?: number): number;
+  declare function setTimeout(handler: () => void, timeout?: number): number;
+  declare function clearInterval(id: number): void;
+  declare function clearTimeout(id: number): void;
 }
 
 export {};
@@ -254,6 +288,22 @@ declare global {
   type Owned<T = unknown> = T;
   type Shared<T = unknown> = T;
   type Mutable<T = unknown> = T;
+  // SafeVariable: SEU-resistant storage. The transpiler lowers SafeVariable<number>
+  // to a C++ template with inverted-redundancy storage. Declared as an interface
+  // (not a type alias) so the TS type checker recognizes method calls.
+  // Arithmetic T only (integral or floating-point); string is rejected by a
+  // static_assert in the emitted C++ template.
+  interface SafeVariable<T = number> { set(value: T): void; get(): T; valid(): boolean; hasFault(): boolean; }
+  // SafeInt: chainable bounds-checked signed-integer arithmetic. The transpiler
+  // lowers SafeInt<number> to SafeInt<int32_t> (a C++ template with sticky-fault
+  // overflow detection). Signed integer T only — unsigned/bool/float/string are
+  // rejected by a static_assert in the emitted C++ template.
+  interface SafeInt<T = number> {
+    add(delta: T): SafeInt<T>; sub(delta: T): SafeInt<T>;
+    mul(factor: T): SafeInt<T>; divide(d: T): SafeInt<T>; mod(d: T): SafeInt<T>;
+    negate(): SafeInt<T>; absValue(): SafeInt<T>;
+    get(): T; hasFault(): boolean; valid(): boolean; reset(newValue: T): void;
+  }
 
   type uint8_t = number;
   type int8_t = number;
@@ -279,6 +329,20 @@ declare global {
     error(...args: unknown[]): void;
   }
   const console: Console;
+
+  // Convenience helper for volatile variables in TypeCAD programs.
+  // The transpiler detects calls to volatile() and emits the C++ volatile qualifier.
+  declare function volatile<T>(value: T): T;
+
+  // JS-style timers (declared here so a project does not need "dom" in tsconfig
+  // lib to type setInterval/setTimeout). The transpiler rewrites these to
+  // __tc_setInterval/__tc_setTimeout and emits the timer_methods polyfill when
+  // used. Note: Timing.setInterval/setTimeout (from @typecad/hal) is the
+  // preferred single entry point and is typed via the @typecad/board import.
+  declare function setInterval(handler: () => void, timeout?: number): number;
+  declare function setTimeout(handler: () => void, timeout?: number): number;
+  declare function clearInterval(id: number): void;
+  declare function clearTimeout(id: number): void;
 }
 
 declare module '@typecad/board' {
@@ -508,11 +572,13 @@ export default [
     files: ["src/**/*.ts"],
     languageOptions: {
       parser: tsparser,
-      parserOptions: {
-        // Type-aware parsing so @typescript-eslint/no-explicit-any resolves
-        // imported bindings to their real types instead of defaulting to any.
-        project: "./tsconfig.json",
-      },
+      // NOTE: do NOT set parserOptions.project here. None of the rules below
+      // (no-restricted-syntax, the cuttlefish/* AST rules, no-explicit-any,
+      // no-eval, ...) consume type information, so enabling type-aware linting
+      // only forces ESLint to build a full TS type-program per file — ~3.4s of
+      // pure overhead on small projects with zero change to what is detected.
+      // If a future rule needs types, scope project to that rule only via
+      // parserOptions on a dedicated config block, not globally.
     },
     plugins: {
       "@typescript-eslint": tseslint,

package/dist/create/init-wizard.js

@@ -84,15 +84,29 @@ export async function runInitWizard(partialOptions) {
             targetId = await promptSelect(rl, "Target", targetOptions);
         }
         const target = KNOWN_TARGETS.find((t) => t.id === targetId);
-        // 3. Framework (only for embedded targets)
+        // 3. Framework (only for embedded targets). Discover installed
+        // @typecad/framework-* packages rather than hardcoding a single option, so
+        // the wizard reflects whichever frameworks the user has installed.
         let framework = target.framework;
         let frameworkPackage = target.frameworkPackage;
         if (!target.isNative) {
-            const frameworkOptions = [
-                { label: "Arduino (digitalWrite, Wire, SPI)", value: 'arduino', pkg: '@typecad/framework-arduino' },
+            // Candidate framework families and their user-facing labels. The wizard
+            // shows whichever are installed (resolvable) in the user's project.
+            const frameworkCandidates = [
+                { value: 'arduino', label: 'Arduino (digitalWrite, Wire, SPI)' },
+                { value: 'zephyr', label: 'Zephyr RTOS' },
+                { value: 'esp-idf', label: 'ESP-IDF' },
             ];
-            if (target.architecture === 'avr') {
-                frameworkOptions.push({ label: "Bare-metal AVR (PORTB, etc.)", value: 'avr', pkg: '@typecad/framework-avr' });
+            const frameworkOptions = [];
+            for (const candidate of frameworkCandidates) {
+                const pkg = `@typecad/framework-${candidate.value}`;
+                try {
+                    require.resolve(`${pkg}/package.json`, { paths: [process.cwd()] });
+                    frameworkOptions.push({ label: candidate.label, value: candidate.value, pkg });
+                }
+                catch {
+                    // framework not installed; skip
+                }
             }
             if (partialOptions?.framework) {
                 const match = frameworkOptions.find(f => f.value === partialOptions.framework);
@@ -100,6 +114,13 @@ export async function runInitWizard(partialOptions) {
                 frameworkPackage = match?.pkg ?? `@typecad/framework-${partialOptions.framework}`;
                 console.log(`${chalk.cyan("?")} Framework: ${chalk.white(framework)}`);
             }
+            else if (frameworkOptions.length === 0) {
+                // No framework installed and none requested via --framework: abort
+                // rather than produce a broken scaffold with an empty framework field
+                // (which would generate invalid package.json + cuttlefish.config.ts).
+                throw new Error("No @typecad/framework-* packages found in this project. " +
+                    "Install one before scaffolding, e.g.: npm i @typecad/framework-arduino");
+            }
             else if (frameworkOptions.length === 1) {
                 framework = frameworkOptions[0].value;
                 frameworkPackage = frameworkOptions[0].pkg;
@@ -148,12 +169,15 @@ export async function runInitWizard(partialOptions) {
             isNative: target.isNative,
             architecture: target.architecture,
             boardPackage: target.boardPackage,
-            frameworkPackage,
-            framework,
+            frameworkPackage: frameworkPackage ?? '',
+            framework: framework ?? '',
             buildTarget: target.buildTarget,
             mcu: target.mcu,
             baudRate,
             includeSketch,
+            ...(target.frameworkData
+                ? { frameworkData: target.frameworkData }
+                : {}),
         };
     }
     catch (err) {