@tscircuit/cli 0.1.795 → 0.1.796

package/dist/main.js

@@ -74141,7 +74141,7 @@ var package_default = {
     "@tscircuit/fake-snippets": "^0.0.182",
     "@tscircuit/file-server": "^0.0.32",
     "@tscircuit/math-utils": "0.0.29",
-    "@tscircuit/props": "^0.0.441",
+    "@tscircuit/props": "^0.0.448",
     "@tscircuit/runframe": "^0.0.1510",
     "@tscircuit/schematic-match-adapt": "^0.0.22",
     "@types/bun": "^1.2.2",
@@ -74156,7 +74156,7 @@ var package_default = {
     chokidar: "4.0.1",
     "circuit-json": "0.0.325",
     "circuit-json-to-gltf": "^0.0.58",
-    "circuit-json-to-kicad": "^0.0.33",
+    "circuit-json-to-kicad": "^0.0.38",
     "circuit-json-to-readable-netlist": "^0.0.13",
     "circuit-json-to-spice": "^0.0.10",
     "circuit-json-to-tscircuit": "^0.0.9",
@@ -74176,7 +74176,7 @@ var package_default = {
     jszip: "^3.10.1",
     "jwt-decode": "^4.0.0",
     "kicad-component-converter": "^0.1.22",
-    kicadts: "^0.0.23",
+    kicadts: "^0.0.24",
     kleur: "^4.1.5",
     ky: "^1.7.4",
     "looks-same": "^9.0.1",
@@ -81716,10 +81716,22 @@ import {
   parseKicadSexpr as parseKicadSexpr2,
   KicadPcb as KicadPcb2,
   FootprintModel as FootprintModel2,
-  At as At2
+  At as At2,
+  EmbeddedFonts as EmbeddedFonts4,
+  FootprintAttr,
+  Property,
+  TextEffects as TextEffects6,
+  TextEffectsFont as TextEffectsFont6
 } from "kicadts";
 import { KicadSymbolLib } from "kicadts";
 import { parseKicadMod } from "kicadts";
+import {
+  parseKicadSexpr as parseKicadSexpr3,
+  Footprint as Footprint3,
+  Property as Property2,
+  TextEffects as TextEffects7,
+  TextEffectsFont as TextEffectsFont7
+} from "kicadts";
 import { KicadSymbolLib as KicadSymbolLib2 } from "kicadts";
 var ConverterStage = class {
   MAX_ITERATIONS = 1000;
@@ -83350,6 +83362,9 @@ var AddFootprintsStage = class extends ConverterStage {
         componentRotation: component.rotation || 0
       });
       if (fpText) {
+        if (sourceComponent?.name && textElement.text === sourceComponent.name) {
+          fpText.type = "reference";
+        }
         fpTexts.push(fpText);
       }
     }
@@ -83935,11 +83950,69 @@ var ExtractFootprintsStage = class extends ConverterStage {
     footprint.position = At2.from([0, 0, 0]);
     footprint.locked = false;
     footprint.placed = false;
+    if (!footprint.descr) {
+      footprint.descr = "";
+    }
+    if (!footprint.tags) {
+      footprint.tags = "";
+    }
+    if (!footprint.embeddedFonts) {
+      footprint.embeddedFonts = new EmbeddedFonts4(false);
+    }
+    if (!footprint.attr) {
+      const attr = new FootprintAttr;
+      const padTypes = (footprint.fpPads ?? []).map((pad) => pad.padType);
+      if (padTypes.some((padType) => padType.includes("thru_hole"))) {
+        attr.type = "through_hole";
+      } else if (padTypes.some((padType) => padType.includes("smd"))) {
+        attr.type = "smd";
+      }
+      footprint.attr = attr;
+    }
     footprint.uuid = undefined;
     footprint.path = undefined;
     footprint.sheetfile = undefined;
     footprint.sheetname = undefined;
-    footprint.properties = [];
+    const defaultFont = new TextEffectsFont6;
+    defaultFont.size = { width: 1.27, height: 1.27 };
+    defaultFont.thickness = 0.15;
+    const defaultEffects = new TextEffects6({ font: defaultFont });
+    footprint.properties = [
+      new Property({
+        key: "Reference",
+        value: "Ref**",
+        position: [0, 0, 0],
+        layer: "F.SilkS",
+        uuid: generateDeterministicUuid(`${footprintName}-property-Reference`),
+        effects: defaultEffects
+      }),
+      new Property({
+        key: "Value",
+        value: "Val**",
+        position: [0, 0, 0],
+        layer: "F.Fab",
+        uuid: generateDeterministicUuid(`${footprintName}-property-Value`),
+        effects: defaultEffects
+      }),
+      new Property({
+        key: "Datasheet",
+        value: "",
+        position: [0, 0, 0],
+        layer: "F.Fab",
+        hidden: true,
+        uuid: generateDeterministicUuid(`${footprintName}-property-Datasheet`),
+        effects: defaultEffects
+      }),
+      new Property({
+        key: "Description",
+        value: "",
+        position: [0, 0, 0],
+        layer: "F.Fab",
+        hidden: true,
+        uuid: generateDeterministicUuid(`${footprintName}-property-Description`),
+        effects: defaultEffects
+      })
+    ];
     const texts = footprint.fpTexts ?? [];
     for (const text of texts) {
       text.uuid = undefined;
@@ -83951,9 +84024,12 @@ var ExtractFootprintsStage = class extends ConverterStage {
     }
     footprint.fpTexts = texts;
     const pads = footprint.fpPads ?? [];
-    for (const pad of pads) {
-      pad.uuid = undefined;
-      pad.net = undefined;
+    for (let i = 0;i < pads.length; i++) {
+      const pad = pads[i];
+      if (pad) {
+        pad.uuid = generateDeterministicUuid(`${footprintName}-pad-${pad.number ?? i}`);
+        pad.net = undefined;
+      }
     }
     footprint.fpPads = pads;
     const models = footprint.models ?? [];
@@ -83962,7 +84038,7 @@ var ExtractFootprintsStage = class extends ConverterStage {
     for (const model of models) {
       if (model.path) {
         const modelFilename = getBasename(model.path);
-        const newPath = `\${KIPRJMOD}/${fpLibraryName}.3dshapes/${modelFilename}`;
+        const newPath = `../../3dmodels/${fpLibraryName}.3dshapes/${modelFilename}`;
         const newModel = new FootprintModel2(newPath);
         if (model.offset)
           newModel.offset = model.offset;
@@ -84132,9 +84208,10 @@ function renameKicadFootprint(params2) {
   footprint.libraryLink = newKicadFootprintName;
   for (const model of footprint.models) {
     const currentPath = model.path;
-    if (currentPath.includes("${KIPRJMOD}/")) {
-      const filename = currentPath.split("/").pop() ?? "";
-      model.path = `\${KIPRJMOD}/3dmodels/${kicadLibraryName}.3dshapes/${filename}`;
+    const usesProjectPath = currentPath.includes("${KIPRJMOD}/") || /3dmodels[\\/]/.test(currentPath);
+    if (usesProjectPath) {
+      const filename = currentPath.split(/[\\/]/).pop() ?? "";
+      model.path = `../../3dmodels/${kicadLibraryName}.3dshapes/${filename}`;
     }
   }
   return {
@@ -84143,6 +84220,106 @@ function renameKicadFootprint(params2) {
     model3dSourcePaths: kicadFootprint.model3dSourcePaths
   };
 }
+function applyKicadFootprintMetadata(kicadModString, metadata, footprintName) {
+  try {
+    const parsed = parseKicadSexpr3(kicadModString);
+    const footprint = parsed.find((node) => node instanceof Footprint3);
+    if (!footprint) {
+      return kicadModString;
+    }
+    if (metadata.version !== undefined) {
+      footprint.version = Number(metadata.version);
+    }
+    if (metadata.generator !== undefined) {
+      footprint.generator = metadata.generator;
+    }
+    if (metadata.generatorVersion !== undefined) {
+      footprint.generatorVersion = String(metadata.generatorVersion);
+    }
+    if (metadata.embeddedFonts !== undefined) {}
+    if (metadata.properties) {
+      const defaultFont = new TextEffectsFont7;
+      defaultFont.size = { width: 1.27, height: 1.27 };
+      defaultFont.thickness = 0.15;
+      const defaultEffects = new TextEffects7({ font: defaultFont });
+      const newProperties = [];
+      const refMeta = metadata.properties.Reference;
+      newProperties.push(new Property2({
+        key: "Reference",
+        value: refMeta?.value ?? "REF**",
+        position: refMeta?.at ? [
+          Number(refMeta.at.x),
+          Number(refMeta.at.y),
+          Number(refMeta.at.rotation ?? 0)
+        ] : [0, 0, 0],
+        layer: refMeta?.layer ?? "F.SilkS",
+        uuid: refMeta?.uuid ?? generateDeterministicUuid(`${footprintName}-property-Reference`),
+        effects: defaultEffects,
+        hidden: refMeta?.hide
+      }));
+      const valMeta = metadata.properties.Value;
+      newProperties.push(new Property2({
+        key: "Value",
+        value: valMeta?.value ?? footprintName,
+        position: valMeta?.at ? [
+          Number(valMeta.at.x),
+          Number(valMeta.at.y),
+          Number(valMeta.at.rotation ?? 0)
+        ] : [0, 0, 0],
+        layer: valMeta?.layer ?? "F.Fab",
+        uuid: valMeta?.uuid ?? generateDeterministicUuid(`${footprintName}-property-Value`),
+        effects: defaultEffects,
+        hidden: valMeta?.hide
+      }));
+      const dsMeta = metadata.properties.Datasheet;
+      newProperties.push(new Property2({
+        key: "Datasheet",
+        value: dsMeta?.value ?? "",
+        position: dsMeta?.at ? [
+          Number(dsMeta.at.x),
+          Number(dsMeta.at.y),
+          Number(dsMeta.at.rotation ?? 0)
+        ] : [0, 0, 0],
+        layer: dsMeta?.layer ?? "F.Fab",
+        uuid: dsMeta?.uuid ?? generateDeterministicUuid(`${footprintName}-property-Datasheet`),
+        effects: defaultEffects,
+        hidden: dsMeta?.hide ?? true
+      }));
+      const descMeta = metadata.properties.Description;
+      newProperties.push(new Property2({
+        key: "Description",
+        value: descMeta?.value ?? "",
+        position: descMeta?.at ? [
+          Number(descMeta.at.x),
+          Number(descMeta.at.y),
+          Number(descMeta.at.rotation ?? 0)
+        ] : [0, 0, 0],
+        layer: descMeta?.layer ?? "F.Fab",
+        uuid: descMeta?.uuid ?? generateDeterministicUuid(`${footprintName}-property-Description`),
+        effects: defaultEffects,
+        hidden: descMeta?.hide ?? true
+      }));
+      footprint.properties = newProperties;
+    }
+    if (metadata.attributes && footprint.attr) {
+      if (metadata.attributes.through_hole) {
+        footprint.attr.type = "through_hole";
+      } else if (metadata.attributes.smd) {
+        footprint.attr.type = "smd";
+      }
+      if (metadata.attributes.exclude_from_pos_files !== undefined) {
+        footprint.attr.excludeFromPosFiles = metadata.attributes.exclude_from_pos_files;
+      }
+      if (metadata.attributes.exclude_from_bom !== undefined) {
+        footprint.attr.excludeFromBom = metadata.attributes.exclude_from_bom;
+      }
+    }
+    return footprint.getString();
+  } catch (error) {
+    console.warn(`Failed to apply kicadFootprintMetadata:`, error);
+    return kicadModString;
+  }
+}
 function classifyKicadFootprints(ctx) {
   for (const extractedKicadComponent of ctx.extractedKicadComponents) {
     classifyFootprintsForComponent({
@@ -84157,17 +84334,24 @@ function classifyFootprintsForComponent({
 }) {
   const { tscircuitComponentName, kicadFootprints } = extractedKicadComponent;
   let hasAddedUserFootprint = false;
+  const metadata = ctx.footprintMetadataMap.get(tscircuitComponentName);
   for (const kicadFootprint of kicadFootprints) {
     if (kicadFootprint.isBuiltin) {
       addBuiltinFootprint({ ctx, kicadFootprint });
     } else {
       if (!hasAddedUserFootprint) {
         hasAddedUserFootprint = true;
-        const renamedFootprint = renameKicadFootprint({
+        let renamedFootprint = renameKicadFootprint({
           kicadFootprint,
           newKicadFootprintName: tscircuitComponentName,
           kicadLibraryName: ctx.kicadLibraryName
         });
+        if (metadata) {
+          renamedFootprint = {
+            ...renamedFootprint,
+            kicadModString: applyKicadFootprintMetadata(renamedFootprint.kicadModString, metadata, tscircuitComponentName)
+          };
+        }
         addUserFootprint({ ctx, kicadFootprint: renamedFootprint });
       } else {
         addUserFootprint({ ctx, kicadFootprint });
@@ -84393,7 +84577,8 @@ var KicadLibraryConverter = class {
     this.options = options;
     this.ctx = createKicadLibraryConverterContext({
       kicadLibraryName: options.kicadLibraryName ?? "tscircuit_library",
-      includeBuiltins: options.includeBuiltins ?? true
+      includeBuiltins: options.includeBuiltins ?? true,
+      getComponentKicadMetadata: options.getComponentKicadMetadata
     });
   }
   async run() {
@@ -84411,14 +84596,20 @@ var KicadLibraryConverter = class {
     const builtTscircuitComponents = [];
     const { entrypoint } = this.options;
     const exports2 = await this.options.getExportsFromTsxFile(entrypoint);
-    const componentExports = exports2.filter((name) => /^[A-Z]/.test(name));
-    for (const exportName of componentExports) {
+    const namedExports = exports2.filter((name) => name !== "default" && /^[A-Z]/.test(name));
+    for (const exportName of namedExports) {
       let componentPath = entrypoint;
       if (this.options.resolveExportPath) {
         const resolved = await this.options.resolveExportPath(entrypoint, exportName);
         if (resolved)
           componentPath = resolved;
       }
+      if (this.ctx.getComponentKicadMetadata) {
+        const metadata = await this.ctx.getComponentKicadMetadata(componentPath, exportName);
+        if (metadata) {
+          this.ctx.footprintMetadataMap.set(exportName, metadata);
+        }
+      }
       const circuitJson = await this.options.buildFileToCircuitJson(componentPath, exportName);
       if (circuitJson && (!Array.isArray(circuitJson) || circuitJson.length > 0)) {
         builtTscircuitComponents.push({
@@ -84427,6 +84618,28 @@ var KicadLibraryConverter = class {
         });
       }
     }
+    if (exports2.includes("default")) {
+      let componentPath = entrypoint;
+      if (this.options.resolveExportPath) {
+        const resolved = await this.options.resolveExportPath(entrypoint, "default");
+        if (resolved)
+          componentPath = resolved;
+      }
+      const componentName = deriveComponentNameFromPath(componentPath);
+      if (this.ctx.getComponentKicadMetadata) {
+        const metadata = await this.ctx.getComponentKicadMetadata(componentPath, "default");
+        if (metadata) {
+          this.ctx.footprintMetadataMap.set(componentName, metadata);
+        }
+      }
+      const circuitJson = await this.options.buildFileToCircuitJson(componentPath, "default");
+      if (circuitJson && (!Array.isArray(circuitJson) || circuitJson.length > 0)) {
+        builtTscircuitComponents.push({
+          tscircuitComponentName: componentName,
+          circuitJson
+        });
+      }
+    }
     return builtTscircuitComponents;
   }
   extractKicadComponents() {
@@ -84464,6 +84677,8 @@ function createKicadLibraryConverterContext(params2) {
   return {
     kicadLibraryName: params2.kicadLibraryName,
     includeBuiltins: params2.includeBuiltins,
+    getComponentKicadMetadata: params2.getComponentKicadMetadata,
+    footprintMetadataMap: /* @__PURE__ */ new Map,
     builtTscircuitComponents: [],
     extractedKicadComponents: [],
     userKicadFootprints: [],
@@ -84474,6 +84689,10 @@ function createKicadLibraryConverterContext(params2) {
     kicadProjectFsMap: {}
   };
 }
+function deriveComponentNameFromPath(filePath) {
+  const filename = filePath.split(/[/\\]/).pop() || filePath;
+  return filename.replace(/\.(tsx?|jsx?)$/, "");
+}
 
 // lib/shared/convert-to-kicad-library.tsx
 import fs27 from "node:fs";
@@ -84509,6 +84728,75 @@ async function importFromUserLand(moduleName) {
   return import(moduleName);
 }
 
+// lib/shared/extract-kicad-footprint-metadata.ts
+function extractKicadFootprintMetadata(Component, options = {}) {
+  const { maxIterations = 100, debug: debug11 = false } = options;
+  let reactElm;
+  try {
+    reactElm = Component({});
+  } catch (e) {
+    if (debug11) {
+      console.log(`[extractKicadFootprintMetadata] Failed to call root component:`, e);
+    }
+    return {};
+  }
+  if (!reactElm) {
+    return {};
+  }
+  const queue = [reactElm];
+  let iterations = 0;
+  while (queue.length > 0) {
+    iterations++;
+    if (iterations > maxIterations) {
+      if (debug11) {
+        console.log(`[extractKicadFootprintMetadata] Max iterations (${maxIterations}) reached`);
+      }
+      break;
+    }
+    const elm = queue.shift();
+    if (!elm)
+      continue;
+    if (typeof elm.type === "function") {
+      try {
+        let childElm = null;
+        try {
+          childElm = elm.type(elm.props || {});
+        } catch {
+          childElm = elm.type();
+        }
+        if (childElm) {
+          queue.push(childElm);
+        }
+      } catch (e) {
+        if (debug11) {
+          console.log(`[extractKicadFootprintMetadata] Failed to call functional component:`, e);
+        }
+      }
+    }
+    if (elm?.props?.kicadFootprintMetadata) {
+      return elm.props.kicadFootprintMetadata;
+    }
+    if (elm?.props) {
+      const children = elm.props.children;
+      if (Array.isArray(children)) {
+        for (const child of children) {
+          if (child && typeof child === "object") {
+            queue.push(child);
+          }
+        }
+      } else if (children && typeof children === "object") {
+        queue.push(children);
+      }
+      for (const [key, value] of Object.entries(elm.props)) {
+        if (key !== "children" && value && typeof value === "object" && "type" in value && "props" in value) {
+          queue.push(value);
+        }
+      }
+    }
+  }
+  return {};
+}
+
 // lib/shared/convert-to-kicad-library.tsx
 import { jsxDEV } from "react/jsx-dev-runtime";
 async function convertToKicadLibrary({
@@ -84545,6 +84833,18 @@ async function convertToKicadLibrary({
       const module2 = await import(pathToFileURL(filePath2).href);
       return Object.keys(module2);
     },
+    getComponentKicadMetadata: async (filePath2, componentName) => {
+      try {
+        const module2 = await import(pathToFileURL(filePath2).href);
+        const Component = module2[componentName];
+        if (!Component || typeof Component !== "function") {
+          return null;
+        }
+        return extractKicadFootprintMetadata(Component);
+      } catch (error) {
+        return null;
+      }
+    },
     includeBuiltins: true
   });
   await converter.run();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/cli",
-  "version": "0.1.795",
+  "version": "0.1.796",
   "main": "dist/main.js",
   "devDependencies": {
     "@babel/standalone": "^7.26.9",
@@ -9,7 +9,7 @@
     "@tscircuit/fake-snippets": "^0.0.182",
     "@tscircuit/file-server": "^0.0.32",
     "@tscircuit/math-utils": "0.0.29",
-    "@tscircuit/props": "^0.0.441",
+    "@tscircuit/props": "^0.0.448",
     "@tscircuit/runframe": "^0.0.1510",
     "@tscircuit/schematic-match-adapt": "^0.0.22",
     "@types/bun": "^1.2.2",
@@ -24,7 +24,7 @@
     "chokidar": "4.0.1",
     "circuit-json": "0.0.325",
     "circuit-json-to-gltf": "^0.0.58",
-    "circuit-json-to-kicad": "^0.0.33",
+    "circuit-json-to-kicad": "^0.0.38",
     "circuit-json-to-readable-netlist": "^0.0.13",
     "circuit-json-to-spice": "^0.0.10",
     "circuit-json-to-tscircuit": "^0.0.9",
@@ -44,7 +44,7 @@
     "jszip": "^3.10.1",
     "jwt-decode": "^4.0.0",
     "kicad-component-converter": "^0.1.22",
-    "kicadts": "^0.0.23",
+    "kicadts": "^0.0.24",
     "kleur": "^4.1.5",
     "ky": "^1.7.4",
     "looks-same": "^9.0.1",