altium-to-circuit-json 0.0.2

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 tscircuit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,88 @@
+# altium-to-circuit-json
+
+Convert Altium schematic and PCB documents into [Circuit JSON](https://github.com/tscircuit/circuit-json).
+
+The converter is built on [altiumts](https://github.com/tscircuit/altiumts). Its visual tests render the original document with `altiumts` on the left and the converted Circuit JSON with `circuit-to-svg` on the right, then combine the panels with `stack-svgs` and verify them with `bun-match-svg`.
+
+## Install
+
+```sh
+bun add altium-to-circuit-json
+```
+
+## Usage
+
+Automatic format detection accepts text, `Uint8Array`, or `ArrayBuffer` input:
+
+```ts
+import { readFile } from "node:fs/promises"
+import { convertAltiumToCircuitJson } from "altium-to-circuit-json"
+
+const bytes = await readFile("motor-controller.PcbDoc")
+const circuitJson = convertAltiumToCircuitJson(bytes)
+```
+
+Parsed `altiumts` documents can be converted directly:
+
+```ts
+import { parseAltiumSchDoc } from "altiumts"
+import { convertAltiumSchDocToCircuitJson } from "altium-to-circuit-json"
+
+const document = parseAltiumSchDoc(schematicBytes)
+const circuitJson = convertAltiumSchDocToCircuitJson(document)
+```
+
+The public conversion functions are:
+
+- `convertAltiumToCircuitJson(source, options)` for automatic parsing and conversion.
+- `convertAltiumDocumentToCircuitJson(document, options)` for an already parsed document.
+- `convertAltiumPcbDocToCircuitJson(document, options)` for PCB documents.
+- `convertAltiumSchDocToCircuitJson(document, options)` for schematic documents.
+
+## Current coverage
+
+PCB conversion currently emits:
+
+- polygon board outlines and board cutouts;
+- PCB component placement bounds;
+- top, bottom, and inner-layer copper tracks;
+- vias;
+- circular, rectangular, rounded, octagonal, rotated, pill, slotted, plated, and non-plated pads/holes;
+- top and bottom silkscreen lines, arcs, fills, and text; and
+- Altium mil coordinates converted to millimeters.
+
+Schematic conversion currently emits:
+
+- sheet identity and border geometry;
+- wires as schematic traces;
+- polylines, polygons, rectangles, circles, ellipses, and arcs;
+- pins, junctions, no-ERC markers, ports, and power ports;
+- labels, net labels, designators, parameters, and text frames; and
+- active multipart/display-mode filtering plus Altium text orientation and anchoring.
+
+The package is intentionally an incremental converter. Connectivity source elements, complete component semantics, copper pours/regions, mechanical/dimension primitives, models, and project-level hierarchy remain follow-up areas.
+
+## Visual tests
+
+Download the checksum-pinned open-source reference files and run the tests:
+
+```sh
+bun run test
+```
+
+Update the SVG snapshots after an intentional visual change:
+
+```sh
+bun run test:update-svg
+```
+
+Every imported reference used by the test suite has a side-by-side SVG snapshot. The committed fixtures are generated from pinned upstream URLs and are not stored in this repository.
+
+## Development
+
+```sh
+bun install
+bun run typecheck
+bun run format:check
+bun run build
+```

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { AltiumPcbDocument, AltiumSchDoc } from 'altiumts';
+import { AnyCircuitElement } from 'circuit-json';
+
+interface ConvertAltiumPcbDocOptions {
+    includeBoardOutline?: boolean;
+    includeComponents?: boolean;
+    includePads?: boolean;
+    includeSilkscreen?: boolean;
+    includeTraces?: boolean;
+    includeVias?: boolean;
+}
+declare function convertAltiumPcbDocToCircuitJson(document: AltiumPcbDocument, options?: ConvertAltiumPcbDocOptions): AnyCircuitElement[];
+
+interface ConvertAltiumSchDocOptions {
+    includeHidden?: boolean;
+    includeSheetBorder?: boolean;
+    includeText?: boolean;
+    schematicUnitScale?: number;
+    sheetName?: string;
+}
+declare function convertAltiumSchDocToCircuitJson(document: AltiumSchDoc, options?: ConvertAltiumSchDocOptions): AnyCircuitElement[];
+
+type AltiumSourceType = "auto" | "pcb" | "schematic";
+interface ConvertAltiumToCircuitJsonOptions {
+    pcb?: ConvertAltiumPcbDocOptions;
+    schematic?: ConvertAltiumSchDocOptions;
+    sourceType?: AltiumSourceType;
+}
+type SupportedAltiumDocument = AltiumPcbDocument | AltiumSchDoc;
+declare function convertAltiumToCircuitJson(source: ArrayBuffer | Uint8Array | string, options?: ConvertAltiumToCircuitJsonOptions): AnyCircuitElement[];
+declare function convertAltiumDocumentToCircuitJson(document: unknown, options?: ConvertAltiumToCircuitJsonOptions): AnyCircuitElement[];
+
+export { type AltiumSourceType, type ConvertAltiumPcbDocOptions, type ConvertAltiumSchDocOptions, type ConvertAltiumToCircuitJsonOptions, type SupportedAltiumDocument, convertAltiumDocumentToCircuitJson, convertAltiumPcbDocToCircuitJson, convertAltiumSchDocToCircuitJson, convertAltiumToCircuitJson };