circuit-json-to-kicad 0.0.39 → 0.0.41

package/dist/index.d.ts

@@ -255,6 +255,21 @@ interface KicadLibraryConverterOptions {
      * Return null if no metadata is available.
      */
     getComponentKicadMetadata?: (filePath: string, componentName: string) => Promise<KicadFootprintMetadata | null>;
+    /**
+     * Whether to generate files for KiCad PCM (Plugin and Content Manager).
+     * When true:
+     * - Footprint references in symbols will be prefixed with "PCM_"
+     * - 3D model paths will use ${KICAD_3RD_PARTY} variable instead of relative paths
+     * Default: false
+     */
+    isPcm?: boolean;
+    /**
+     * The KiCad PCM package identifier (e.g., "com_tscircuit_author_package-name").
+     * Required when useKicadPcmPaths is true.
+     * Used to construct 3D model paths like:
+     * ${KICAD9_3RD_PARTY}/3dmodels/<kicadPcmPackageId>/<library>.3dshapes/<model>.step
+     */
+    kicadPcmPackageId?: string;
 }
 interface KicadLibraryConverterOutput {
     /**

package/dist/index.js

@@ -101,6 +101,50 @@ function extractReferencePrefix(name) {
   const match = name.match(/^([A-Za-z]+)/);
   return match?.[1]?.toUpperCase() ?? "U";
 }
+var referencePrefixByFtype = {
+  simple_resistor: "R",
+  simple_capacitor: "C",
+  simple_inductor: "L",
+  simple_diode: "D",
+  simple_led: "D",
+  simple_chip: "U",
+  simple_transistor: "Q",
+  simple_mosfet: "Q",
+  simple_fuse: "F",
+  simple_switch: "SW",
+  simple_push_button: "SW",
+  simple_potentiometer: "RV",
+  simple_crystal: "Y",
+  simple_resonator: "Y",
+  simple_pin_header: "J",
+  simple_pinout: "J",
+  simple_test_point: "TP",
+  simple_battery: "BT"
+};
+var referenceDesignatorPattern = /^[A-Za-z]+\\d+$/;
+function isReferenceDesignator(value) {
+  if (!value) return false;
+  return referenceDesignatorPattern.test(value.trim());
+}
+function getReferencePrefixForComponent(sourceComponent) {
+  const name = sourceComponent?.name;
+  if (isReferenceDesignator(name)) {
+    return extractReferencePrefix(name);
+  }
+  const ftype = sourceComponent?.ftype;
+  if (ftype && referencePrefixByFtype[ftype]) {
+    return referencePrefixByFtype[ftype];
+  }
+  return extractReferencePrefix(name);
+}
+function getReferenceDesignator(sourceComponent) {
+  const name = sourceComponent?.name;
+  if (isReferenceDesignator(name)) {
+    return name.trim();
+  }
+  const prefix = getReferencePrefixForComponent(sourceComponent);
+  return `${prefix}?`;
+}
 
 // lib/schematic/getLibraryId.ts
 import { symbols } from "schematic-symbols";
@@ -127,7 +171,7 @@ function getLibraryId(sourceComp, schematicComp, cadComponent) {
     sourceComp,
     cadComponent
   );
-  const refPrefix = extractReferencePrefix(sourceComp.name);
+  const refPrefix = getReferencePrefixForComponent(sourceComp);
   return `Device:${refPrefix}_${ergonomicName}`;
 }
 
@@ -197,7 +241,8 @@ var AddLibrarySymbolsStage = class extends ConverterStage {
       description: this.getDescription(sourceComp),
       keywords: this.getKeywords(sourceComp),
       fpFilters: this.getFpFilters(sourceComp),
-      footprintRef: footprintName ? `tscircuit:${footprintName}` : ""
+      footprintRef: footprintName ? `tscircuit:${footprintName}` : "",
+      referencePrefix: getReferencePrefixForComponent(sourceComp)
     });
   }
   /**
@@ -220,7 +265,8 @@ var AddLibrarySymbolsStage = class extends ConverterStage {
       schematicComponent: void 0,
       description: isPower ? "Power net label" : isGround ? "Ground net label" : "Net symbol",
       keywords: isPower ? "power net" : isGround ? "ground net" : "net",
-      fpFilters: ""
+      fpFilters: "",
+      referencePrefix: libId.split(":")[1]?.[0] || "U"
     });
   }
   /**
@@ -280,7 +326,8 @@ var AddLibrarySymbolsStage = class extends ConverterStage {
     description,
     keywords,
     fpFilters,
-    footprintRef = ""
+    footprintRef = "",
+    referencePrefix
   }) {
     const symbol = new SchematicSymbol({
       libraryId: libId,
@@ -300,7 +347,8 @@ var AddLibrarySymbolsStage = class extends ConverterStage {
       description,
       keywords,
       fpFilters,
-      footprintRef
+      footprintRef,
+      referencePrefix
     });
     const drawingSymbol = this.createDrawingSubsymbol({
       libId,
@@ -327,9 +375,10 @@ var AddLibrarySymbolsStage = class extends ConverterStage {
     description,
     keywords,
     fpFilters,
-    footprintRef = ""
+    footprintRef = "",
+    referencePrefix
   }) {
-    const refPrefix = libId.split(":")[1]?.[0] || "U";
+    const refPrefix = referencePrefix || libId.split(":")[1]?.[0] || "U";
     const properties = [
       {
         key: "Reference",
@@ -794,43 +843,44 @@ var AddSchematicSymbolsStage = class extends ConverterStage {
    */
   getComponentMetadata(sourceComp) {
     const name = sourceComp.name || "?";
+    const reference = getReferenceDesignator(sourceComp);
     if (sourceComp.ftype === "simple_resistor") {
       return {
-        reference: name,
+        reference,
         value: sourceComp.display_resistance || "R",
         description: "Resistor"
       };
     }
     if (sourceComp.ftype === "simple_capacitor") {
       return {
-        reference: name,
+        reference,
         value: sourceComp.display_capacitance || "C",
         description: "Capacitor"
       };
     }
     if (sourceComp.ftype === "simple_inductor") {
       return {
-        reference: name,
+        reference,
         value: sourceComp.display_inductance || "L",
         description: "Inductor"
       };
     }
     if (sourceComp.ftype === "simple_diode") {
       return {
-        reference: name,
+        reference,
         value: "D",
         description: "Diode"
       };
     }
     if (sourceComp.ftype === "simple_chip") {
       return {
-        reference: name,
+        reference,
         value: name,
         description: "Integrated Circuit"
       };
     }
     return {
-      reference: name,
+      reference,
       value: name,
       description: "Component"
     };
@@ -2937,8 +2987,15 @@ var CircuitJsonToKicadLibraryConverter = class {
 
 // lib/kicad-library/kicad-library-converter-utils/renameKicadFootprint.ts
 import { parseKicadMod } from "kicadts";
+var KICAD_3RD_PARTY_PLACEHOLDER = "${KICAD_3RD_PARTY}";
 function renameKicadFootprint(params) {
-  const { kicadFootprint, newKicadFootprintName, kicadLibraryName } = params;
+  const {
+    kicadFootprint,
+    newKicadFootprintName,
+    kicadLibraryName,
+    isPcm,
+    kicadPcmPackageId
+  } = params;
   const footprint = parseKicadMod(kicadFootprint.kicadModString);
   footprint.libraryLink = newKicadFootprintName;
   for (const model of footprint.models) {
@@ -2946,7 +3003,11 @@ function renameKicadFootprint(params) {
     const usesProjectPath = currentPath.includes("${KIPRJMOD}/") || /3dmodels[\\/]/.test(currentPath);
     if (usesProjectPath) {
       const filename = currentPath.split(/[\\/]/).pop() ?? "";
-      model.path = `../../3dmodels/${kicadLibraryName}.3dshapes/${filename}`;
+      if (isPcm && kicadPcmPackageId) {
+        model.path = `${KICAD_3RD_PARTY_PLACEHOLDER}/3dmodels/${kicadPcmPackageId}/${kicadLibraryName}.3dshapes/${filename}`;
+      } else {
+        model.path = `../../3dmodels/${kicadLibraryName}.3dshapes/${filename}`;
+      }
     }
   }
   return {
@@ -3077,6 +3138,8 @@ function applyKicadFootprintMetadata(kicadModString, metadata, footprintName) {
 }
 
 // lib/kicad-library/stages/ClassifyKicadFootprintsStage.ts
+import { parseKicadMod as parseKicadMod2 } from "kicadts";
+var KICAD_3RD_PARTY_PLACEHOLDER2 = "${KICAD_3RD_PARTY}";
 function classifyKicadFootprints(ctx) {
   for (const extractedKicadComponent of ctx.extractedKicadComponents) {
     classifyFootprintsForComponent({
@@ -3101,7 +3164,9 @@ function classifyFootprintsForComponent({
         let renamedFootprint = renameKicadFootprint({
           kicadFootprint,
           newKicadFootprintName: tscircuitComponentName,
-          kicadLibraryName: ctx.kicadLibraryName
+          kicadLibraryName: ctx.kicadLibraryName,
+          isPcm: ctx.isPcm,
+          kicadPcmPackageId: ctx.kicadPcmPackageId
         });
         if (metadata) {
           renamedFootprint = {
@@ -3139,9 +3204,37 @@ function addBuiltinFootprint({
     (fp) => fp.footprintName === kicadFootprint.footprintName
   );
   if (!alreadyExists) {
-    ctx.builtinKicadFootprints.push(kicadFootprint);
+    if (ctx.isPcm && ctx.kicadPcmPackageId) {
+      const updatedFootprint = updateBuiltinFootprintModelPaths({
+        kicadFootprint,
+        kicadPcmPackageId: ctx.kicadPcmPackageId
+      });
+      ctx.builtinKicadFootprints.push(updatedFootprint);
+    } else {
+      ctx.builtinKicadFootprints.push(kicadFootprint);
+    }
   }
 }
+function updateBuiltinFootprintModelPaths({
+  kicadFootprint,
+  kicadPcmPackageId
+}) {
+  const footprint = parseKicadMod2(kicadFootprint.kicadModString);
+  for (const model of footprint.models) {
+    const currentPath = model.path;
+    const usesProjectPath = currentPath.includes("${KIPRJMOD}/") || /3dmodels[\\/]/.test(currentPath);
+    if (usesProjectPath) {
+      const filename = currentPath.split(/[\\/]/).pop() ?? "";
+      model.path = `${KICAD_3RD_PARTY_PLACEHOLDER2}/3dmodels/${kicadPcmPackageId}/tscircuit_builtin.3dshapes/${filename}`;
+    }
+  }
+  return {
+    footprintName: kicadFootprint.footprintName,
+    kicadModString: footprint.getString(),
+    model3dSourcePaths: kicadFootprint.model3dSourcePaths,
+    isBuiltin: kicadFootprint.isBuiltin
+  };
+}
 function componentHasCustomFootprint(extractedKicadComponent) {
   return extractedKicadComponent.kicadFootprints.some((fp) => !fp.isBuiltin);
 }
@@ -3165,24 +3258,26 @@ function renameKicadSymbol(params) {
 
 // lib/kicad-library/kicad-library-converter-utils/updateKicadSymbolFootprint.ts
 function updateKicadSymbolFootprint(params) {
-  const { kicadSymbol, kicadLibraryName, kicadFootprintName } = params;
+  const { kicadSymbol, kicadLibraryName, kicadFootprintName, isPcm } = params;
   const properties = kicadSymbol.symbol.properties ?? [];
+  const effectiveKicadLibraryName = isPcm ? `PCM_${kicadLibraryName}` : kicadLibraryName;
   for (const prop of properties) {
     if (prop.key === "Footprint") {
-      prop.value = `${kicadLibraryName}:${kicadFootprintName}`;
+      prop.value = `${effectiveKicadLibraryName}:${kicadFootprintName}`;
     }
   }
 }
 
 // lib/kicad-library/kicad-library-converter-utils/updateBuiltinKicadSymbolFootprint.ts
-function updateBuiltinKicadSymbolFootprint(kicadSymbol) {
+function updateBuiltinKicadSymbolFootprint(kicadSymbol, options) {
   const symbol = kicadSymbol.symbol;
   const properties = symbol.properties ?? [];
+  const libraryName = options?.isPcm ? "PCM_tscircuit_builtin" : "tscircuit_builtin";
   for (const prop of properties) {
     if (prop.key === "Footprint" && prop.value) {
       const parts = prop.value.split(":");
       const footprintName = parts.length > 1 ? parts[1] : parts[0];
-      prop.value = `tscircuit_builtin:${footprintName}`;
+      prop.value = `${libraryName}:${footprintName}`;
     }
   }
   return { symbolName: kicadSymbol.symbolName, symbol };
@@ -3218,7 +3313,8 @@ function classifySymbolsForComponent({
           updateKicadSymbolFootprint({
             kicadSymbol: renamedSymbol,
             kicadLibraryName: ctx.kicadLibraryName,
-            kicadFootprintName: tscircuitComponentName
+            kicadFootprintName: tscircuitComponentName,
+            isPcm: ctx.isPcm
           });
         }
         addUserSymbol({ ctx, kicadSymbol: renamedSymbol });
@@ -3234,11 +3330,14 @@ function classifySymbolsForComponent({
       updateKicadSymbolFootprint({
         kicadSymbol: renamedSymbol,
         kicadLibraryName: ctx.kicadLibraryName,
-        kicadFootprintName: tscircuitComponentName
+        kicadFootprintName: tscircuitComponentName,
+        isPcm: ctx.isPcm
       });
       addUserSymbol({ ctx, kicadSymbol: renamedSymbol });
     } else {
-      const updatedSymbol = updateBuiltinKicadSymbolFootprint(kicadSymbol);
+      const updatedSymbol = updateBuiltinKicadSymbolFootprint(kicadSymbol, {
+        isPcm: ctx.isPcm
+      });
       addBuiltinSymbol({ ctx, kicadSymbol: updatedSymbol });
     }
   }
@@ -3361,7 +3460,9 @@ var KicadLibraryConverter = class {
     this.ctx = createKicadLibraryConverterContext({
       kicadLibraryName: options.kicadLibraryName ?? "tscircuit_library",
       includeBuiltins: options.includeBuiltins ?? true,
-      getComponentKicadMetadata: options.getComponentKicadMetadata
+      getComponentKicadMetadata: options.getComponentKicadMetadata,
+      isPcm: options.isPcm ?? false,
+      kicadPcmPackageId: options.kicadPcmPackageId
     });
   }
   async run() {
@@ -3487,6 +3588,8 @@ function createKicadLibraryConverterContext(params) {
     kicadLibraryName: params.kicadLibraryName,
     includeBuiltins: params.includeBuiltins,
     getComponentKicadMetadata: params.getComponentKicadMetadata,
+    isPcm: params.isPcm,
+    kicadPcmPackageId: params.kicadPcmPackageId,
     footprintMetadataMap: /* @__PURE__ */ new Map(),
     builtTscircuitComponents: [],
     extractedKicadComponents: [],

package/package.json

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