altium-to-circuit-json 0.0.76 → 0.0.78

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { LayerRef, SourceSimpleChip, SourcePort, AnyCircuitElement, SourceNet, SourceTrace } from 'circuit-json';
-import { AltiumPcbDocument, AltiumRecord, AltiumPadRecord, AltiumSchDoc } from 'altiumts';
+import { AltiumPcbDocument, AltiumRecord, AltiumPadRecord, AltiumSchDoc, AltiumPrjPcb } from 'altiumts';
 
 declare class PcbCopperLayerMap {
     readonly layers: LayerRef[];
@@ -110,9 +110,14 @@ declare function convertAltiumPcbDocToCircuitJson(document: AltiumPcbDocument, o
 
 interface ConvertAltiumSchDocOptions {
     centerOnSchematicSheet?: boolean;
+    currentDate?: string;
+    currentTime?: string;
+    documentName?: string;
     includeHidden?: boolean;
     includeSheetBorder?: boolean;
     includeText?: boolean;
+    project?: AltiumPrjPcb;
+    projectName?: string;
     schematicUnitScale?: number;
     sheetName?: string;
 }

package/dist/index.js

@@ -837,6 +837,28 @@ function getFontFamily(record, context) {
   return context.sheetRecord?.getDecoded(`FONTNAME${fontId}`) ?? "Arial";
 }
 
+// lib/schematic/text/resolveSchematicText.ts
+import {
+  resolveSchematicParameterReferenceWithContext
+} from "altiumts";
+function resolveSchematicText({
+  document,
+  options,
+  record,
+  reference
+}) {
+  return resolveSchematicParameterReferenceWithContext({
+    currentDate: options.currentDate,
+    currentTime: options.currentTime,
+    document,
+    documentName: options.documentName,
+    project: options.project,
+    projectName: options.projectName,
+    record,
+    reference
+  }) ?? reference;
+}
+
 // lib/schematic/text/wrapSchematicText.ts
 function wrapSchematicText({
   text,
@@ -879,12 +901,18 @@ function renderTextRecord({
 }) {
   const kind = record.recordKind;
   const scale5 = context.scale;
-  if (kind === "4" || kind === "25" || kind === "34" || kind === "41") {
+  if (kind === "4" || kind === "25" || kind === "32" || kind === "33" || kind === "34" || kind === "41") {
     if (options.includeText === false) return [];
     if (record.getBoolean("ISHIDDEN") && !options.includeHidden) return [];
-    const text = record.getDecoded("TEXT") ?? record.getDecoded("NAME") ?? record.getDecoded("DESIGNATOR");
+    const reference = record.getDecoded("TEXT") ?? record.getDecoded("NAME") ?? record.getDecoded("DESIGNATOR");
     const location = getLocation(record);
-    if (!text || !location) return [];
+    if (!reference || !location) return [];
+    const text = resolveSchematicText({
+      document: context.document,
+      options,
+      record,
+      reference
+    });
     return [createText({ record, index, text, location, color, context })];
   }
   if (kind === "28") {
@@ -1633,6 +1661,124 @@ function renderSchematicImageRecord({
   ];
 }
 
+// lib/schematic/rendering/renderSheetEntry.ts
+function renderSheetEntry({
+  context,
+  index,
+  options,
+  record
+}) {
+  const sheetSymbol = context.document.getParent(record);
+  const sheetLocation = sheetSymbol ? getLocation(sheetSymbol) : void 0;
+  if (!sheetSymbol || sheetSymbol.recordKind !== "15" || !sheetLocation) {
+    return [];
+  }
+  const sheetWidth = Math.max(
+    getCoordinateOrFallback({ record: sheetSymbol, key: "XSIZE", fallback: 1 }),
+    1
+  );
+  const sheetHeight = Math.max(
+    getCoordinateOrFallback({ record: sheetSymbol, key: "YSIZE", fallback: 1 }),
+    1
+  );
+  const distance = Math.max(record.getNumber("DISTANCEFROMTOP") ?? 0, 0) * 10;
+  const rawSide = Math.round(record.getNumber("SIDE") ?? 0);
+  const side = rawSide === 1 || rawSide === 2 || rawSide === 3 ? rawSide : 0;
+  const point = side === 1 ? { x: sheetLocation.x + sheetWidth, y: sheetLocation.y - distance } : side === 2 ? { x: sheetLocation.x + distance, y: sheetLocation.y } : side === 3 ? {
+    x: sheetLocation.x + distance,
+    y: sheetLocation.y - sheetHeight
+  } : { x: sheetLocation.x, y: sheetLocation.y - distance };
+  const points = side === 1 ? [
+    { x: point.x, y: point.y + 4 },
+    { x: point.x - 7, y: point.y },
+    { x: point.x, y: point.y - 4 }
+  ] : side === 2 ? [
+    { x: point.x - 4, y: point.y },
+    { x: point.x, y: point.y - 7 },
+    { x: point.x + 4, y: point.y }
+  ] : side === 3 ? [
+    { x: point.x - 4, y: point.y },
+    { x: point.x, y: point.y + 7 },
+    { x: point.x + 4, y: point.y }
+  ] : [
+    { x: point.x, y: point.y + 4 },
+    { x: point.x + 7, y: point.y },
+    { x: point.x, y: point.y - 4 }
+  ];
+  const elements = [
+    {
+      type: "schematic_path",
+      schematic_path_id: `schematic_sheet_entry_altium_${index}`,
+      schematic_sheet_id: SCHEMATIC_SHEET_ID,
+      points: points.map((entryPoint) => scalePoint(entryPoint, context.scale)),
+      stroke_width: Math.max(scaleLength(1, context.scale), 0.05),
+      stroke_color: "#840000",
+      fill_color: "#ffffc2",
+      is_filled: true,
+      is_dashed: false
+    }
+  ];
+  const name = record.getDecoded("NAME");
+  if (!name || options.includeText === false) return elements;
+  const fontId = Math.max(Math.round(record.getNumber("TEXTFONTID") ?? 1), 1);
+  const fontSize = Math.max(
+    Number(context.sheetRecord?.getCaseInsensitive(`SIZE${fontId}`) ?? 9),
+    1
+  );
+  const textLocation = side === 0 ? { x: point.x + 9, y: point.y } : side === 1 ? { x: point.x - 9, y: point.y } : side === 2 ? { x: point.x, y: point.y - 9 } : { x: point.x, y: point.y + 9 };
+  const anchor = side === 0 ? "center_left" : side === 1 ? "center_right" : side === 2 ? "top_center" : "bottom_center";
+  elements.push(
+    createDirectText({
+      id: `schematic_sheet_entry_text_altium_${index}`,
+      text: name,
+      location: textLocation,
+      fontSize,
+      color: "#840000",
+      scale: context.scale,
+      ccwRotationDegrees: 0,
+      anchor
+    })
+  );
+  return elements;
+}
+
+// lib/schematic/rendering/renderSheetSymbol.ts
+function renderSheetSymbol({
+  context,
+  index,
+  record
+}) {
+  const location = getLocation(record);
+  if (!location) return [];
+  const width = Math.max(
+    getCoordinateOrFallback({ record, key: "XSIZE", fallback: 1 }),
+    1
+  );
+  const height = Math.max(
+    getCoordinateOrFallback({ record, key: "YSIZE", fallback: 1 }),
+    1
+  );
+  return [
+    {
+      type: "schematic_rect",
+      schematic_rect_id: `schematic_sheet_symbol_altium_${index}`,
+      schematic_sheet_id: SCHEMATIC_SHEET_ID,
+      center: scalePoint(
+        { x: location.x + width / 2, y: location.y - height / 2 },
+        context.scale
+      ),
+      width: scaleLength(width, context.scale),
+      height: scaleLength(height, context.scale),
+      rotation: 0,
+      stroke_width: Math.max(scaleLength(1, context.scale), 0.05),
+      color: "#840000",
+      is_filled: true,
+      fill_color: "#ffffc2",
+      is_dashed: false
+    }
+  ];
+}
+
 // lib/schematic/rendering/convertSchematicRecord.ts
 function convertSchematicRecord({
   record,
@@ -1649,6 +1795,10 @@ function convertSchematicRecord({
   if (record instanceof AltiumSchImageRecord) {
     return renderSchematicImageRecord({ context, index, record });
   }
+  if (kind === "15") return renderSheetSymbol({ context, index, record });
+  if (kind === "16") {
+    return renderSheetEntry({ context, index, options, record });
+  }
   const primitive = renderPrimitiveRecord({
     record,
     index,
@@ -3100,7 +3250,7 @@ function convertOwnedComponentRecords({
       {
         index,
         options: {
-          includeHidden: context.options.includeHidden,
+          ...context.options,
           includeText: record instanceof AltiumSchPinRecord ? false : context.options.includeText
         },
         record
@@ -3621,7 +3771,13 @@ function getComponentIdentity({
   ownedRecords
 }, context) {
   const designator = findOwnedDesignator(ownedRecords) ?? componentRecord.designator ?? `U${componentIndex}`;
-  const displayText = findOwnedParameterText(ownedRecords, "Value")?.trim() || findOwnedParameterText(ownedRecords, "Comment")?.trim() || componentRecord.comment?.trim() || componentRecord.designItemId?.trim() || componentRecord.libraryReference?.trim() || "";
+  const displayTextReference = findOwnedParameterText(ownedRecords, "Value")?.trim() || findOwnedParameterText(ownedRecords, "Comment")?.trim() || componentRecord.comment?.trim() || componentRecord.designItemId?.trim() || componentRecord.libraryReference?.trim() || "";
+  const displayText = resolveSchematicText({
+    document: context.document,
+    options: context.options,
+    record: componentRecord,
+    reference: displayTextReference
+  }).trim();
   const libraryReference = componentRecord.libraryReference ?? componentRecord.designItemId ?? designator;
   const manufacturerPartNumber = findOwnedParameterText(
     ownedRecords,
@@ -4071,8 +4227,7 @@ function convertSemanticSchematic(document, options) {
 // lib/schematic/document/convertSchematicSemantics.ts
 function convertSchematicSemantics(context) {
   const conversion = convertSemanticSchematic(context.document, {
-    includeHidden: context.options.includeHidden,
-    includeText: context.options.includeText,
+    ...context.options,
     scale: context.scale,
     schematicSheetId: SCHEMATIC_SHEET_ID
   });