altium-to-circuit-json 0.0.83 → 0.0.85

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { LayerRef, SourceSimpleChip, SourcePort, AnyCircuitElement, SourceNet, SourceTrace } from 'circuit-json';
-import { AltiumPcbDocument, AltiumRecord, AltiumPadRecord, AltiumSchDoc, AltiumPrjPcb } from 'altiumts';
+import { AltiumPcbDocument, AltiumPrjPcb, AltiumRecord, AltiumPadRecord, AltiumSchDoc } from 'altiumts';
 
 declare class PcbCopperLayerMap {
     readonly layers: LayerRef[];
@@ -19,6 +19,7 @@ interface ConvertAltiumPcbDocOptions {
     includeSilkscreen?: boolean;
     includeTraces?: boolean;
     includeVias?: boolean;
+    project?: AltiumPrjPcb;
 }
 interface PcbNetContext {
     elements: Array<SourceNet | SourceTrace>;

package/dist/index.js

@@ -465,15 +465,6 @@ function createPcbConversionContext({
   };
 }
 
-// lib/schematic/document/constants.ts
-var SCHEMATIC_SHEET_ID = "schematic_sheet_altium";
-var SCHEMATIC_UNIT_TO_MILLIMETERS = 10.16 / 1.1;
-var SCHEMATIC_SHEET_INSET = 5 / SCHEMATIC_UNIT_TO_MILLIMETERS;
-var SCHEMATIC_SHEET_WIDTH = 297 / SCHEMATIC_UNIT_TO_MILLIMETERS;
-var SCHEMATIC_SHEET_HEIGHT = 210 / SCHEMATIC_UNIT_TO_MILLIMETERS;
-var SCHEMATIC_SHEET_INNER_WIDTH = SCHEMATIC_SHEET_WIDTH - SCHEMATIC_SHEET_INSET * 2;
-var SCHEMATIC_SHEET_INNER_HEIGHT = SCHEMATIC_SHEET_HEIGHT - SCHEMATIC_SHEET_INSET * 2;
-
 // lib/schematic/geometry/getAveragePoint.ts
 function getAveragePoint(points) {
   if (points.length === 0) return { x: 0, y: 0 };
@@ -616,6 +607,15 @@ function unscaleLength(lengthMillimeters, altiumUnitsToMillimetersScale) {
   }).x;
 }
 
+// lib/schematic/document/constants.ts
+var SCHEMATIC_SHEET_ID = "schematic_sheet_altium";
+var SCHEMATIC_UNIT_TO_MILLIMETERS = 10.16 / 1.1;
+var SCHEMATIC_SHEET_INSET = 5 / SCHEMATIC_UNIT_TO_MILLIMETERS;
+var SCHEMATIC_SHEET_WIDTH = 297 / SCHEMATIC_UNIT_TO_MILLIMETERS;
+var SCHEMATIC_SHEET_HEIGHT = 210 / SCHEMATIC_UNIT_TO_MILLIMETERS;
+var SCHEMATIC_SHEET_INNER_WIDTH = SCHEMATIC_SHEET_WIDTH - SCHEMATIC_SHEET_INSET * 2;
+var SCHEMATIC_SHEET_INNER_HEIGHT = SCHEMATIC_SHEET_HEIGHT - SCHEMATIC_SHEET_INSET * 2;
+
 // lib/schematic/document/getPositiveNumber.ts
 function getPositiveNumber(candidate, fallback) {
   const parsed = Number(candidate);
@@ -623,11 +623,43 @@ function getPositiveNumber(candidate, fallback) {
 }
 
 // lib/schematic/document/getAltiumSheetDimensions.ts
+var STANDARD_SHEET_SIZES = [
+  { width: 1150, height: 760 },
+  { width: 1550, height: 1110 },
+  { width: 2230, height: 1570 },
+  { width: 3150, height: 2230 },
+  { width: 4460, height: 3150 },
+  { width: 950, height: 750 },
+  { width: 1500, height: 950 },
+  { width: 2e3, height: 1500 },
+  { width: 3200, height: 2e3 },
+  { width: 4200, height: 3200 },
+  { width: 1100, height: 850 },
+  { width: 1400, height: 850 },
+  { width: 1700, height: 1100 },
+  { width: 990, height: 790 },
+  { width: 1540, height: 990 },
+  { width: 2060, height: 1560 },
+  { width: 3260, height: 2060 },
+  { width: 4280, height: 3280 }
+];
 function getAltiumSheetDimensions(sheetRecord) {
-  return {
+  const customDimensions = {
     width: getPositiveNumber(sheetRecord?.getCaseInsensitive("CUSTOMX"), 1e3),
     height: getPositiveNumber(sheetRecord?.getCaseInsensitive("CUSTOMY"), 800)
   };
+  const sheetStyle = sheetRecord?.getCaseInsensitive("SHEETSTYLE");
+  if (sheetRecord?.getCaseInsensitive("USECUSTOMSHEET") === "T" || sheetStyle === void 0) {
+    return customDimensions;
+  }
+  const standardDimensions = STANDARD_SHEET_SIZES[Number(sheetStyle)];
+  if (!standardDimensions) {
+    throw new RangeError(
+      `Unsupported Altium schematic sheet style: ${sheetStyle}`
+    );
+  }
+  const isPortrait = Number(sheetRecord?.getCaseInsensitive("WORKSPACEORIENTATION") ?? 0) !== 0;
+  return isPortrait ? { width: standardDimensions.height, height: standardDimensions.width } : standardDimensions;
 }
 
 // lib/schematic/document/createSheetBorder.ts
@@ -650,12 +682,26 @@ function createSheetBorder(sheetRecord, scale5) {
 
 // lib/schematic/document/addSchematicSheet.ts
 function addSchematicSheet(context) {
+  const scaledSheetWidth = scaleLength(
+    context.sheetDimensions.width,
+    context.scale
+  );
+  const scaledSheetHeight = scaleLength(
+    context.sheetDimensions.height,
+    context.scale
+  );
+  const usesCustomSheet = context.sheetRecord?.getCaseInsensitive("USECUSTOMSHEET") === "T";
+  const sheetDimensions = usesCustomSheet ? {
+    sheet_width: scaledSheetWidth * SCHEMATIC_UNIT_TO_MILLIMETERS,
+    sheet_height: scaledSheetHeight * SCHEMATIC_UNIT_TO_MILLIMETERS
+  } : {};
   context.elements.push({
     type: "schematic_sheet",
     schematic_sheet_id: SCHEMATIC_SHEET_ID,
     name: context.options.sheetName ?? "Altium schematic",
     outline_color: "#334155",
-    sheet_index: 0
+    sheet_index: 0,
+    ...sheetDimensions
   });
   if (context.options.includeSheetBorder === true) {
     context.elements.push(createSheetBorder(context.sheetRecord, context.scale));
@@ -5982,16 +6028,98 @@ function convertPcbMechanicalText({
   };
 }
 
+// lib/pcb/text/getProjectTextReplacements.ts
+function getProjectTextReplacements(project) {
+  const replacements = [];
+  for (const section of project.sections) {
+    if (/^PARAMETER\d+$/iu.test(section.name)) {
+      const name = section.entries.find(
+        (entry) => entry.key.toUpperCase() === "NAME"
+      )?.value;
+      const text = section.entries.find(
+        (entry) => entry.key.toUpperCase() === "VALUE"
+      )?.value;
+      if (name && text !== void 0 && text !== "*") {
+        replacements.push({ name, text });
+      }
+      continue;
+    }
+    if (!/^PARAMETERS?$/iu.test(section.name)) continue;
+    for (const entry of section.entries) {
+      const separatorIndex = entry.value.indexOf("=");
+      if (separatorIndex <= 0) continue;
+      const name = entry.value.slice(0, separatorIndex).trim();
+      const text = entry.value.slice(separatorIndex + 1);
+      if (name && text !== "*") replacements.push({ name, text });
+    }
+  }
+  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,
+  text
+}) {
+  if (!project || !text.includes(".")) return text;
+  let resolvedText = text;
+  const replacements = getProjectTextReplacements(project).sort(
+    (first, second) => second.name.length - first.name.length
+  );
+  for (const replacement of replacements) {
+    resolvedText = replaceMatchingSpecialString({
+      isQuoted: false,
+      replacement,
+      text: resolvedText
+    });
+  }
+  for (const replacement of replacements) {
+    resolvedText = replaceMatchingSpecialString({
+      isQuoted: true,
+      replacement,
+      text: resolvedText
+    });
+  }
+  return resolvedText;
+}
+
 // lib/pcb/silkscreen/convertPcbSilkscreenText.ts
 function convertPcbSilkscreenText({
-  document,
+  context,
   record,
   recordIndex
 }) {
   if (!record.position || !record.text) return void 0;
+  const { document, options } = context;
   const component = document.getComponentForRecord(record);
   const specialString = record.text.trim().toLowerCase();
-  const text = specialString === ".designator" ? component?.designator : specialString === ".comment" ? component?.comment : record.text;
+  const componentText = specialString === ".designator" ? component?.designator : specialString === ".comment" ? component?.comment : record.text;
+  const text = resolvePcbProjectSpecialStrings({
+    project: options.project,
+    text: componentText ?? ""
+  });
   if (!text) return void 0;
   return {
     type: "pcb_silkscreen_text",
@@ -6481,7 +6609,7 @@ function convertPcbRecords(context) {
       if (isOverlayLayer(record.layer)) {
         if (options.includeSilkscreen === false) continue;
         if (isHiddenPcbComponentText({ document, record })) continue;
-        const text = convertPcbSilkscreenText({ document, record, recordIndex });
+        const text = convertPcbSilkscreenText({ context, record, recordIndex });
         if (text) elements.push(text);
       } else {
         const text = convertPcbCopperText({ layerMap, record, recordIndex });