altium-to-circuit-json 0.0.89 → 0.0.91

package/dist/index.d.ts

@@ -8,6 +8,7 @@ declare class PcbCopperLayerMap {
     private readonly mappings;
     constructor(document: AltiumPcbDocument);
     getLayer(layer: string | undefined): LayerRef | undefined;
+    getDisplayName(layer: string | undefined): string | undefined;
 }
 
 interface ConvertAltiumPcbDocOptions {

package/dist/index.js

@@ -55,6 +55,36 @@ var INNER_LAYERS = all_layers.filter(
   (layer) => layer.startsWith("inner")
 );
 
+// lib/pcb/layers/getAltiumPcbLayerDisplayName.ts
+import { getAltiumPcbLayerAliasKey } from "altiumts";
+var STANDARD_LAYER_LABELS = {
+  BOTTOM: "Bottom Layer",
+  BOTTOMOVERLAY: "Bottom Overlay",
+  BOTTOMPASTE: "Bottom Paste",
+  BOTTOMSOLDER: "Bottom Solder",
+  DRILLDRAWING: "Drill Drawing",
+  DRILLGUIDE: "Drill Guide",
+  KEEPOUT: "Keep-Out Layer",
+  MULTILAYER: "Multi-Layer",
+  TOP: "Top Layer",
+  TOPOVERLAY: "Top Overlay",
+  TOPPASTE: "Top Paste",
+  TOPSOLDER: "Top Solder"
+};
+function getAltiumPcbLayerDisplayName(layer) {
+  if (!layer) return void 0;
+  const layerKey = getAltiumPcbLayerAliasKey(layer);
+  const standardLabel = STANDARD_LAYER_LABELS[layerKey];
+  if (standardLabel) return standardLabel;
+  const signalLayerOrdinal = /^MID(\d+)$/u.exec(layerKey)?.[1];
+  if (signalLayerOrdinal) return `Signal Layer ${signalLayerOrdinal}`;
+  const planeLayerOrdinal = /^INTERNALPLANE(\d+)$/u.exec(layerKey)?.[1];
+  if (planeLayerOrdinal) return `Internal Plane ${planeLayerOrdinal}`;
+  const mechanicalLayerOrdinal = /^MECHANICAL(\d+)$/u.exec(layerKey)?.[1];
+  if (mechanicalLayerOrdinal) return `Mechanical ${mechanicalLayerOrdinal}`;
+  return layer.trim() || void 0;
+}
+
 // lib/pcb/layers/getRecordLayer.ts
 function getRecordLayer(record) {
   return record.getDecoded("LAYER");
@@ -218,8 +248,8 @@ var PcbCopperLayerMap = class {
     if (entries.length === 0) {
       this.layers = ["top", "bottom"];
       this.mappings.push(
-        { keys: ["TOP"], layer: "top" },
-        { keys: ["BOTTOM"], layer: "bottom" }
+        { displayName: "Top Layer", keys: ["TOP"], layer: "top" },
+        { displayName: "Bottom Layer", keys: ["BOTTOM"], layer: "bottom" }
       );
       return;
     }
@@ -244,7 +274,9 @@ var PcbCopperLayerMap = class {
           );
         }
       }
-      this.mappings.push({ keys, layer });
+      const displayName = entry.name?.trim() || getAltiumPcbLayerDisplayName(entry.layerId);
+      if (!displayName) throw new Error("Copper board stack layer has no name");
+      this.mappings.push({ displayName, keys, layer });
     }
   }
   getLayer(layer) {
@@ -259,6 +291,11 @@ var PcbCopperLayerMap = class {
     }
     return void 0;
   }
+  getDisplayName(layer) {
+    const identity = getCopperLayerIdentity(layer);
+    const key = identity ?? normalizeLayer(layer);
+    return this.mappings.find((mapping) => mapping.keys.includes(key))?.displayName;
+  }
 };
 
 // lib/pcb/pads/isElectricalPcbPad.ts
@@ -3313,7 +3350,7 @@ function convertOwnedComponentRecords({
           0.05
         )
       } : element;
-      return preparedElement.type === "schematic_text" ? preparedElement : {
+      return {
         ...preparedElement,
         schematic_component_id: schematicComponentId
       };
@@ -3591,7 +3628,7 @@ function convertPrimitiveGatePin(port, context) {
   delete port.schematicPort.display_pin_label;
   delete port.schematicPort.display_pin_label_text_parts;
   return elements.map(
-    (element) => element.type === "schematic_line" || element.type === "schematic_circle" || element.type === "schematic_path" ? {
+    (element) => element.type === "schematic_line" || element.type === "schematic_circle" || element.type === "schematic_path" || element.type === "schematic_text" ? {
       ...element,
       schematic_component_id: port.schematicPort.schematic_component_id
     } : element
@@ -3807,7 +3844,7 @@ function createNumericPinDesignatorText({
     font_size: Math.max(scaleLength(1.5, scale5), 0.15),
     position,
     rotation: side === "top" || side === "bottom" ? -90 : 0,
-    // Primitive component bodies render their text as sheet-level elements.
+    schematic_component_id: schematicPort.schematic_component_id,
     schematic_sheet_id: schematicPort.schematic_sheet_id,
     schematic_text_id: `schematic_pin_designator_altium_${recordIndex}`,
     text: designator
@@ -6012,67 +6049,26 @@ function mapTextAnchor(justification) {
   return "bottom_left";
 }
 
-// lib/pcb/text/convertPcbCopperText.ts
-function convertPcbCopperText({
-  layerMap,
-  record,
-  recordIndex
-}) {
-  if (!record.position || !record.text) return void 0;
-  const layer = layerMap.getLayer(record.layer);
-  if (!layer) return void 0;
-  return {
-    type: "pcb_copper_text",
-    pcb_copper_text_id: `pcb_copper_text_altium_${recordIndex}`,
-    pcb_component_id: getPcbComponentIdForRecord(record),
-    text: record.text,
-    font: "tscircuit2024",
-    font_size: milsToMillimeters(record.heightMils ?? 30),
-    anchor_position: toMillimeterPoint(record.position),
-    anchor_alignment: mapTextAnchor(record.justification),
-    ccw_rotation: record.rotation,
-    layer,
-    is_mirrored: record.mirrored
-  };
-}
-
-// lib/pcb/text/mapFabricationTextAnchor.ts
-function mapFabricationTextAnchor(justification) {
-  const anchor = mapTextAnchor(justification);
-  return anchor === "top_left" || anchor === "top_right" || anchor === "bottom_left" || anchor === "bottom_right" ? anchor : "center";
+// lib/pcb/text/escapeRegularExpression.ts
+function escapeRegularExpression(text) {
+  return text.replace(/[.*+?^${}()|[\]\\]/gu, "\\$&");
 }
 
-// lib/pcb/text/convertPcbMechanicalText.ts
-function convertPcbMechanicalText({
-  document,
-  record,
-  recordIndex
+// lib/pcb/text/replaceMatchingSpecialString.ts
+function replaceMatchingSpecialString({
+  isQuoted,
+  replacement,
+  text
 }) {
-  const componentIndex = record.componentIndex;
-  const component = document.getComponentForRecord(record);
-  if (!record.position || componentIndex === void 0 || !component || !record.text) {
-    return void 0;
+  const escapedName = escapeRegularExpression(replacement.name);
+  const quotedExpression = new RegExp(`'\\.${escapedName}'`, "giu");
+  if (isQuoted) {
+    return text.replace(quotedExpression, () => replacement.text);
   }
-  const normalizedText = record.text.trim().toUpperCase();
-  const isDesignator = normalizedText === ".DESIGNATOR";
-  const isComment = normalizedText === ".COMMENT";
-  if (isDesignator && component.getBoolean("NAMEON") === false) return void 0;
-  if (isComment && component.getBoolean("COMMENTON") === false) return void 0;
-  const text = isDesignator ? component.designator : isComment ? component.comment : record.text;
-  if (!text) return void 0;
-  return {
-    type: "pcb_fabrication_note_text",
-    pcb_fabrication_note_text_id: `pcb_fabrication_note_text_altium_${recordIndex}`,
-    pcb_component_id: getPcbComponentId(componentIndex),
-    text,
-    font: "tscircuit2024",
-    font_size: milsToMillimeters(record.heightMils ?? 30),
-    anchor_position: toMillimeterPoint(record.position),
-    anchor_alignment: mapFabricationTextAnchor(record.justification),
-    ccw_rotation: record.rotation,
-    layer: component.side === "bottom" ? "bottom" : "top",
-    color: FABRICATION_NOTE_COLOR
-  };
+  const exactReference = `.${replacement.name}`.toLowerCase();
+  return text.split("'").map(
+    (segment, index) => index % 2 === 0 && segment.toLowerCase() === exactReference ? replacement.text : segment
+  ).join("'");
 }
 
 // lib/pcb/text/getProjectTextReplacements.ts
@@ -6103,28 +6099,6 @@ function getProjectTextReplacements(project) {
   return replacements;
 }
 
-// lib/pcb/text/escapeRegularExpression.ts
-function escapeRegularExpression(text) {
-  return text.replace(/[.*+?^${}()|[\]\\]/gu, "\\$&");
-}
-
-// lib/pcb/text/replaceMatchingSpecialString.ts
-function replaceMatchingSpecialString({
-  isQuoted,
-  replacement,
-  text
-}) {
-  const escapedName = escapeRegularExpression(replacement.name);
-  const quotedExpression = new RegExp(`'\\.${escapedName}'`, "giu");
-  if (isQuoted) {
-    return text.replace(quotedExpression, () => replacement.text);
-  }
-  const exactReference = `.${replacement.name}`.toLowerCase();
-  return text.split("'").map(
-    (segment, index) => index % 2 === 0 && segment.toLowerCase() === exactReference ? replacement.text : segment
-  ).join("'");
-}
-
 // lib/pcb/text/resolvePcbProjectSpecialStrings.ts
 function resolvePcbProjectSpecialStrings({
   project,
@@ -6152,6 +6126,103 @@ function resolvePcbProjectSpecialStrings({
   return resolvedText;
 }
 
+// lib/pcb/text/resolvePcbTextSpecialStrings.ts
+function resolvePcbTextSpecialStrings({
+  layer,
+  layerMap,
+  project,
+  text
+}) {
+  if (!text.toLowerCase().includes(".layer_name")) {
+    return resolvePcbProjectSpecialStrings({ project, text });
+  }
+  const layerDisplayName = layerMap.getDisplayName(layer) ?? getAltiumPcbLayerDisplayName(layer);
+  if (!layerDisplayName)
+    return resolvePcbProjectSpecialStrings({ project, text });
+  const replacement = { name: "Layer_Name", text: layerDisplayName };
+  const layerResolvedText = replaceMatchingSpecialString({
+    isQuoted: true,
+    replacement,
+    text: replaceMatchingSpecialString({
+      isQuoted: false,
+      replacement,
+      text
+    })
+  });
+  return resolvePcbProjectSpecialStrings({ project, text: layerResolvedText });
+}
+
+// lib/pcb/text/convertPcbCopperText.ts
+function convertPcbCopperText({
+  context,
+  record,
+  recordIndex
+}) {
+  if (!record.position || !record.text) return void 0;
+  const { layerMap, options } = context;
+  const layer = layerMap.getLayer(record.layer);
+  if (!layer) return void 0;
+  const text = resolvePcbTextSpecialStrings({
+    layer: record.layer,
+    layerMap,
+    project: options.project,
+    text: record.text
+  });
+  if (!text) return void 0;
+  return {
+    type: "pcb_copper_text",
+    pcb_copper_text_id: `pcb_copper_text_altium_${recordIndex}`,
+    pcb_component_id: getPcbComponentIdForRecord(record),
+    text,
+    font: "tscircuit2024",
+    font_size: milsToMillimeters(record.heightMils ?? 30),
+    anchor_position: toMillimeterPoint(record.position),
+    anchor_alignment: mapTextAnchor(record.justification),
+    ccw_rotation: record.rotation,
+    layer,
+    is_mirrored: record.mirrored
+  };
+}
+
+// lib/pcb/text/mapFabricationTextAnchor.ts
+function mapFabricationTextAnchor(justification) {
+  const anchor = mapTextAnchor(justification);
+  return anchor === "top_left" || anchor === "top_right" || anchor === "bottom_left" || anchor === "bottom_right" ? anchor : "center";
+}
+
+// lib/pcb/text/convertPcbMechanicalText.ts
+function convertPcbMechanicalText({
+  document,
+  record,
+  recordIndex
+}) {
+  const componentIndex = record.componentIndex;
+  const component = document.getComponentForRecord(record);
+  if (!record.position || componentIndex === void 0 || !component || !record.text) {
+    return void 0;
+  }
+  const normalizedText = record.text.trim().toUpperCase();
+  const isDesignator = normalizedText === ".DESIGNATOR";
+  const isComment = normalizedText === ".COMMENT";
+  if (isDesignator && component.getBoolean("NAMEON") === false) return void 0;
+  if (isComment && component.getBoolean("COMMENTON") === false) return void 0;
+  const text = isDesignator ? component.designator : isComment ? component.comment : record.text;
+  if (!text) return void 0;
+  return {
+    type: "pcb_fabrication_note_text",
+    pcb_fabrication_note_text_id: `pcb_fabrication_note_text_altium_${recordIndex}`,
+    pcb_component_id: getPcbComponentId(componentIndex),
+    text,
+    font: "tscircuit2024",
+    font_size: milsToMillimeters(record.heightMils ?? 30),
+    anchor_position: toMillimeterPoint(record.position),
+    anchor_alignment: mapFabricationTextAnchor(record.justification),
+    ccw_rotation: record.rotation,
+    layer: component.side === "bottom" ? "bottom" : "top",
+    color: FABRICATION_NOTE_COLOR
+  };
+}
+
 // lib/pcb/silkscreen/convertPcbSilkscreenText.ts
 function convertPcbSilkscreenText({
   context,
@@ -6159,11 +6230,13 @@ function convertPcbSilkscreenText({
   recordIndex
 }) {
   if (!record.position || !record.text) return void 0;
-  const { document, options } = context;
+  const { document, layerMap, options } = context;
   const component = document.getComponentForRecord(record);
   const specialString = record.text.trim().toLowerCase();
   const componentText = specialString === ".designator" ? component?.designator : specialString === ".comment" ? component?.comment : record.text;
-  const text = resolvePcbProjectSpecialStrings({
+  const text = resolvePcbTextSpecialStrings({
+    layer: record.layer,
+    layerMap,
     project: options.project,
     text: componentText ?? ""
   });
@@ -6664,7 +6737,7 @@ function convertPcbRecords(context) {
         const text = convertPcbSilkscreenText({ context, record, recordIndex });
         if (text) elements.push(text);
       } else {
-        const text = convertPcbCopperText({ layerMap, record, recordIndex });
+        const text = convertPcbCopperText({ context, record, recordIndex });
         if (text) elements.push(text);
       }
       continue;