altium-to-circuit-json 0.0.45 → 0.0.47

package/README.md

@@ -39,6 +39,24 @@ The public conversion functions are:
 - `convertAltiumPcbDocToCircuitJson(document, options)` for PCB documents.
 - `convertAltiumSchDocToCircuitJson(document, options)` for schematic documents.
 
+For callers that need progress visibility, debugging, or custom orchestration,
+the same conversion is exposed as a staged converter:
+
+```ts
+import { AltiumToCircuitJsonConverter } from "altium-to-circuit-json"
+
+const converter = new AltiumToCircuitJsonConverter(bytes)
+while (!converter.finished) {
+  console.log(converter.currentStage?.constructor.name)
+  converter.step()
+}
+const circuitJson = converter.getOutput()
+```
+
+Each stage has the standard converter contract: `step()`,
+`runUntilFinished()`, `finished`, and `getOutput()`. The parser boundary stays
+in `altiumts`; conversion stages consume typed Altium documents and records.
+
 ## Current coverage
 
 PCB conversion currently emits:

package/dist/index.d.ts

@@ -1,18 +1,96 @@
-import { AltiumPcbDocument, AltiumSchDoc } from 'altiumts';
-import { AnyCircuitElement } from 'circuit-json';
+import { AnyCircuitElement, SourceNet, SourceTrace } from 'circuit-json';
+import { AltiumPcbDocument, AltiumRecord, AltiumSchDoc } from 'altiumts';
 
 interface ConvertAltiumPcbDocOptions {
     includeBoardOutline?: boolean;
     includeComponents?: boolean;
     includeCopperAreas?: boolean;
     includeCourtyards?: boolean;
-    includeKeepouts?: boolean;
     includeDimensions?: boolean;
+    includeKeepouts?: boolean;
     includePads?: boolean;
     includeSilkscreen?: boolean;
     includeTraces?: boolean;
     includeVias?: boolean;
 }
+interface PcbNetContext {
+    elements: Array<SourceNet | SourceTrace>;
+    getSourceNetId: (record: AltiumRecord) => string | undefined;
+    getSourceTraceId: (record: AltiumRecord) => string | undefined;
+}
+interface PcbConversionContext {
+    document: AltiumPcbDocument;
+    elements: AnyCircuitElement[];
+    netContext: PcbNetContext;
+    options: ConvertAltiumPcbDocOptions;
+}
+
+interface SchematicConversionContext extends SchematicContext {
+    elements: AnyCircuitElement[];
+    handledRecords: Set<AltiumRecord>;
+    options: ConvertAltiumSchDocOptions;
+    sheetDimensions: SheetDimensions;
+}
+interface SheetDimensions {
+    height: number;
+    width: number;
+}
+interface SchematicContext {
+    document: AltiumSchDoc;
+    records: AltiumRecord[];
+    scale: number;
+    sheetRecord?: AltiumRecord;
+}
+
+type AltiumSource = ArrayBuffer | Uint8Array | string;
+type AltiumSourceType = "auto" | "pcb" | "schematic";
+type SupportedAltiumDocument = AltiumPcbDocument | AltiumSchDoc;
+interface ConvertAltiumToCircuitJsonOptions {
+    pcb?: ConvertAltiumPcbDocOptions;
+    schematic?: ConvertAltiumSchDocOptions;
+    sourceType?: AltiumSourceType;
+}
+interface AltiumToCircuitJsonConverterContext {
+    document: SupportedAltiumDocument;
+    elements: AnyCircuitElement[];
+    options: ConvertAltiumToCircuitJsonOptions;
+    pcb?: PcbConversionContext;
+    schematic?: SchematicConversionContext;
+}
+
+declare abstract class ConverterStage<Input, Output> {
+    readonly input: Input;
+    readonly context: AltiumToCircuitJsonConverterContext;
+    readonly maxIterations = 1000;
+    iteration: number;
+    finished: boolean;
+    constructor(input: Input, context: AltiumToCircuitJsonConverterContext);
+    step(): void;
+    abstract _step(): void;
+    runUntilFinished(): void;
+    abstract getOutput(): Output;
+}
+
+declare class AltiumToCircuitJsonConverter {
+    readonly context: AltiumToCircuitJsonConverterContext;
+    readonly pipeline: ConverterStage<SupportedAltiumDocument, unknown>[];
+    currentStageIndex: number;
+    finished: boolean;
+    constructor(source: AltiumSource | SupportedAltiumDocument, options?: ConvertAltiumToCircuitJsonOptions);
+    get currentStage(): ConverterStage<SupportedAltiumDocument, unknown> | undefined;
+    step(): void;
+    runUntilFinished(): void;
+    getOutput(): AnyCircuitElement[];
+}
+
+declare function isSupportedAltiumDocument(source: unknown): source is SupportedAltiumDocument;
+
+declare function parseAltiumSource(source: AltiumSource, sourceType: "auto" | "pcb" | "schematic"): SupportedAltiumDocument;
+
+declare function toUint8Array(source: AltiumSource): Uint8Array;
+
+declare function convertAltiumDocumentToCircuitJson(document: unknown, options?: ConvertAltiumToCircuitJsonOptions): AnyCircuitElement[];
+
 declare function convertAltiumPcbDocToCircuitJson(document: AltiumPcbDocument, options?: ConvertAltiumPcbDocOptions): AnyCircuitElement[];
 
 interface ConvertAltiumSchDocOptions {
@@ -23,16 +101,9 @@ interface ConvertAltiumSchDocOptions {
     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[];
+declare function convertAltiumToCircuitJson(source: AltiumSource, options?: ConvertAltiumToCircuitJsonOptions): AnyCircuitElement[];
 
-export { type AltiumSourceType, type ConvertAltiumPcbDocOptions, type ConvertAltiumSchDocOptions, type ConvertAltiumToCircuitJsonOptions, type SupportedAltiumDocument, convertAltiumDocumentToCircuitJson, convertAltiumPcbDocToCircuitJson, convertAltiumSchDocToCircuitJson, convertAltiumToCircuitJson };
+export { type AltiumSource, type AltiumSourceType, AltiumToCircuitJsonConverter, type AltiumToCircuitJsonConverterContext, type ConvertAltiumPcbDocOptions, type ConvertAltiumSchDocOptions, type ConvertAltiumToCircuitJsonOptions, ConverterStage, type SupportedAltiumDocument, convertAltiumDocumentToCircuitJson, convertAltiumPcbDocToCircuitJson, convertAltiumSchDocToCircuitJson, convertAltiumToCircuitJson, isSupportedAltiumDocument, parseAltiumSource, toUint8Array };