circuit-json-to-kicad 0.0.35 → 0.0.37

package/dist/index.d.ts

@@ -212,6 +212,38 @@ declare class CircuitJsonToKicadLibraryConverter {
     getModel3dSourcePaths(): string[];
 }
 
+/**
+ * KiCad footprint metadata that can be extracted from component props.
+ * This mirrors the KicadFootprintMetadata type from @tscircuit/props.
+ */
+interface KicadFootprintMetadata {
+    footprintName?: string;
+    layer?: string;
+    properties?: {
+        Reference?: KicadPropertyMetadata;
+        Value?: KicadPropertyMetadata;
+        Datasheet?: KicadPropertyMetadata;
+        Description?: KicadPropertyMetadata;
+    };
+    attributes?: {
+        through_hole?: boolean;
+        smd?: boolean;
+        exclude_from_pos_files?: boolean;
+        exclude_from_bom?: boolean;
+    };
+    embeddedFonts?: boolean;
+}
+interface KicadPropertyMetadata {
+    value: string;
+    at?: {
+        x: number | string;
+        y: number | string;
+        rotation?: number | string;
+    };
+    layer?: string;
+    uuid?: string;
+    hide?: boolean;
+}
 interface KicadLibraryConverterOptions {
     /**
      * Name for the generated KiCad library (e.g., "my-library").
@@ -248,6 +280,12 @@ interface KicadLibraryConverterOptions {
      * Default: true
      */
     includeBuiltins?: boolean;
+    /**
+     * Callback to get KiCad footprint metadata from a component via prop introspection.
+     * This allows extracting kicadFootprintMetadata props without rendering the component.
+     * Return null if no metadata is available.
+     */
+    getComponentKicadMetadata?: (filePath: string, componentName: string) => Promise<KicadFootprintMetadata | null>;
 }
 interface KicadLibraryConverterOutput {
     /**
@@ -280,4 +318,4 @@ declare class KicadLibraryConverter {
     getOutput(): KicadLibraryConverterOutput;
 }
 
-export { CircuitJsonToKicadLibraryConverter, CircuitJsonToKicadPcbConverter, CircuitJsonToKicadProConverter, CircuitJsonToKicadSchConverter, type FootprintEntry, KicadLibraryConverter, type KicadLibraryConverterOptions, type KicadLibraryConverterOutput, type KicadLibraryOutput, type SymbolEntry };
+export { CircuitJsonToKicadLibraryConverter, CircuitJsonToKicadPcbConverter, CircuitJsonToKicadProConverter, CircuitJsonToKicadSchConverter, type FootprintEntry, type KicadFootprintMetadata, KicadLibraryConverter, type KicadLibraryConverterOptions, type KicadLibraryConverterOutput, type KicadLibraryOutput, type KicadPropertyMetadata, type SymbolEntry };

package/dist/index.js

@@ -1911,6 +1911,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);
       }
     }
@@ -2585,7 +2588,12 @@ 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";
 function getBasename(filePath) {
   const parts = filePath.split(/[/\\]/);
@@ -2664,11 +2672,71 @@ 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 = void 0;
     footprint.path = void 0;
     footprint.sheetfile = void 0;
     footprint.sheetname = void 0;
-    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 = void 0;
@@ -2680,9 +2748,14 @@ var ExtractFootprintsStage = class extends ConverterStage {
     }
     footprint.fpTexts = texts;
     const pads = footprint.fpPads ?? [];
-    for (const pad of pads) {
-      pad.uuid = void 0;
-      pad.net = void 0;
+    for (let i = 0; i < pads.length; i++) {
+      const pad = pads[i];
+      if (pad) {
+        pad.uuid = generateDeterministicUuid(
+          `${footprintName}-pad-${pad.number ?? i}`
+        );
+        pad.net = void 0;
+      }
     }
     footprint.fpPads = pads;
     const models = footprint.models ?? [];
@@ -2883,6 +2956,117 @@ function renameKicadFootprint(params) {
   };
 }
 
+// lib/kicad-library/kicad-library-converter-utils/applyKicadFootprintMetadata.ts
+import {
+  parseKicadSexpr as parseKicadSexpr3,
+  Footprint as Footprint3,
+  Property as Property2,
+  TextEffects as TextEffects7,
+  TextEffectsFont as TextEffectsFont7
+} from "kicadts";
+function applyKicadFootprintMetadata(kicadModString, metadata, footprintName) {
+  try {
+    const parsed = parseKicadSexpr3(kicadModString);
+    const footprint = parsed.find(
+      (node) => node instanceof Footprint3
+    );
+    if (!footprint) {
+      return kicadModString;
+    }
+    if (metadata.embeddedFonts !== void 0) {
+    }
+    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 !== void 0) {
+        footprint.attr.excludeFromPosFiles = metadata.attributes.exclude_from_pos_files;
+      }
+      if (metadata.attributes.exclude_from_bom !== void 0) {
+        footprint.attr.excludeFromBom = metadata.attributes.exclude_from_bom;
+      }
+    }
+    return footprint.getString();
+  } catch (error) {
+    console.warn(`Failed to apply kicadFootprintMetadata:`, error);
+    return kicadModString;
+  }
+}
+
 // lib/kicad-library/stages/ClassifyKicadFootprintsStage.ts
 function classifyKicadFootprints(ctx) {
   for (const extractedKicadComponent of ctx.extractedKicadComponents) {
@@ -2898,17 +3082,28 @@ 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 });
@@ -3156,7 +3351,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() {
@@ -3189,6 +3385,15 @@ var KicadLibraryConverter = class {
         );
         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
@@ -3210,6 +3415,15 @@ var KicadLibraryConverter = class {
         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"
@@ -3263,6 +3477,8 @@ function createKicadLibraryConverterContext(params) {
   return {
     kicadLibraryName: params.kicadLibraryName,
     includeBuiltins: params.includeBuiltins,
+    getComponentKicadMetadata: params.getComponentKicadMetadata,
+    footprintMetadataMap: /* @__PURE__ */ new Map(),
     builtTscircuitComponents: [],
     extractedKicadComponents: [],
     userKicadFootprints: [],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "circuit-json-to-kicad",
   "main": "dist/index.js",
-  "version": "0.0.35",
+  "version": "0.0.37",
   "type": "module",
   "files": [
     "dist"