@modular-circuit/transpiler 0.1.8 → 0.1.10

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { VECTOR2, At, Color, ConnectionGraph, NL_NetList, BOX2 } from '@modular-circuit/electronics-model';
-import { SCHEMATIC, PIN_DISPLAY_OPT, LIB_SYMBOL, Drawing, PIN_DEFINITION, SCH_LABEL, SCH_SYMBOL, SCH_LINE, PIN_INSTANCE, SCH_SHEET, SCH_SHEET_PIN, Effects, Justify, SCH_FIELD, Fill, Stroke, Project, IR_Graph, ModuleResolver, ModuleCircuit } from '@modular-circuit/ir';
+import { SCHEMATIC, PIN_DISPLAY_OPT, LIB_SYMBOL, Drawing, PIN_DEFINITION, SCH_LABEL, SCH_SYMBOL, SCH_LINE, PIN_INSTANCE, SCH_SHEET, SCH_SHEET_PIN, Effects, Justify, SCH_FIELD, Fill, Stroke, Project, IR_Graph, DesignBlockContent, ModuleResolver, ModuleCircuit } from '@modular-circuit/ir';
 import { CG_SCHEMATIC, CONNECTION_GRAPH_BUILDER_CTX } from '@modular-circuit/perc';
 
 declare function get_sch_default_drawing_sheet(): string;
@@ -128,8 +128,12 @@ declare class NetListConverter {
     private convert_net_label;
 }
 
+declare function convert_graph_to_sheets(ctx: ConvertGraphToKiCadInput): Promise<Record<string, string>>;
+
 declare function convert_graph_to_kicad_project(ctx: ConvertGraphToKiCadInput): Promise<Blob>;
 
+declare function convert_graph_to_design_block(ctx: ConvertGraphToKiCadInput): Promise<DesignBlockContent>;
+
 declare const KiCadSymbolLibFileExtension = "kicad_sym";
 declare const SchematicSymbolFileExtension = "sym";
 declare const LegacySymbolLibFileExtension = "lib";
@@ -463,20 +467,11 @@ declare class StringFormatter {
     append_quote(str: string): void;
 }
 
-interface NamedContent {
-    filename: string;
-    content: string;
-}
-interface DesignBlock {
-    main_sch: string;
-    sheets: NamedContent[];
-    pcb?: NamedContent;
-}
 declare function collect_sub_sheets_by_id(module_ids: string[], module_resolver: ModuleResolver): Promise<{
     sheets: Record<string, string>;
     module_main_sheet: Record<string, string>;
     modules: Record<string, ModuleCircuit>;
-    design_blocks: DesignBlock[];
+    design_blocks: DesignBlockContent[];
 }>;
 
 declare const gen_lib_gnd: (value: string) => LIB_SYMBOL;
@@ -487,4 +482,4 @@ declare const gen_sch_gnd: (value: string, pwr_number: number, port_id: string,
 
 declare const gen_sch_vcc: (value: string, pwr_number: number, port_id: string, position: VECTOR2) => SCH_SYMBOL;
 
-export { AllegroNetlistFileExtension, AltiumFootprintLibPathExtension, ArchiveFileExtension, BLOCK_PIN_GAP, BLOCK_PIN_TB_MARGIN, type BlockLabelPadding, type BlockSize, type BoxGeometry, CadstarFootprintLibPathExtension, CadstarNetlistFileExtension, CadstarPartsLibraryFileExtension, CadstarPcbFileExtension, CadstarSchematicFileExtension, type ConnectionGraphMap, type ConvertGraphToKiCadContext, type ConvertGraphToKiCadInput, CsvFileExtension, DEFAULT_PAPER_SIZE, DatabaseLibraryFileExtension, type DesignBlock, DesignRulesFileExtension, DrawingSheetFileExtension, DrillFileExtension, EagleFootprintLibPathExtension, EaglePcbFileExtension, EquFileExtension, FONT_SIZE, FootprintAssignmentFileExtension, FootprintPlaceFileExtension, GENERATOR_NAME, GENERATOR_VERSION, GRID_SIZE, GedaPcbFootprintLibFileExtension, GerberFileExtension, GerberFileExtensionsRegex, GerberJobFileExtension, GltfBinaryFileExtension, GraphConverter, HTTPLibraryFileExtension, HotkeyFileExtension, HtmlFileExtension, Ipc2581FileExtension, IpcD356FileExtension, JpegFileExtension, JsonFileExtension, KICAD_SCH_FRAME, KiCadFootprintFileExtension, KiCadFootprintLibPathExtension, KiCadPcbFileExtension, KiCadProjectArchive, KiCadSchematicFileExtension, KiCadSymbolLibFileExtension, type LabelPadding, Layout, LegacyFootprintLibPathExtension, LegacyPcbFileExtension, LegacyProjectFileExtension, LegacySchematicFileExtension, LegacySymbolDocumentFileExtension, LegacySymbolLibFileExtension, MacrosFileExtension, MarkdownFileExtension, type NamedContent, NetListConverter, NetlistFileExtension, type NetlistProject, type NetlistToKicadContext, OrCadPcb2NetlistFileExtension, PAPER, PAPER_SIZE, PdfFileExtension, PngFileExtension, ProjectFileExtension, ProjectLocalSettingsFileExtension, ReportFileExtension, SCHEMATIC_PRINTER, SCH_VERSION, SVGFileExtension, SchematicSymbolFileExtension, type Size, SpecctraDsnFileExtension, SpecctraSessionFileExtension, SpiceFileExtension, StepFileAbrvExtension, StepFileExtension, StringFormatter, TextFileExtension, VrmlFileExtension, WIRE_PADDING, WorkbookFileExtension, XmlFileExtension, collect_sub_sheets, collect_sub_sheets_by_id, convert_graph_to_kicad_project, filterNullOrUndefined, gen_lib_gnd, gen_lib_vcc, gen_sch_gnd, gen_sch_vcc, get_power_pos, get_sch_default_drawing_sheet, tab };
+export { AllegroNetlistFileExtension, AltiumFootprintLibPathExtension, ArchiveFileExtension, BLOCK_PIN_GAP, BLOCK_PIN_TB_MARGIN, type BlockLabelPadding, type BlockSize, type BoxGeometry, CadstarFootprintLibPathExtension, CadstarNetlistFileExtension, CadstarPartsLibraryFileExtension, CadstarPcbFileExtension, CadstarSchematicFileExtension, type ConnectionGraphMap, type ConvertGraphToKiCadContext, type ConvertGraphToKiCadInput, CsvFileExtension, DEFAULT_PAPER_SIZE, DatabaseLibraryFileExtension, DesignRulesFileExtension, DrawingSheetFileExtension, DrillFileExtension, EagleFootprintLibPathExtension, EaglePcbFileExtension, EquFileExtension, FONT_SIZE, FootprintAssignmentFileExtension, FootprintPlaceFileExtension, GENERATOR_NAME, GENERATOR_VERSION, GRID_SIZE, GedaPcbFootprintLibFileExtension, GerberFileExtension, GerberFileExtensionsRegex, GerberJobFileExtension, GltfBinaryFileExtension, GraphConverter, HTTPLibraryFileExtension, HotkeyFileExtension, HtmlFileExtension, Ipc2581FileExtension, IpcD356FileExtension, JpegFileExtension, JsonFileExtension, KICAD_SCH_FRAME, KiCadFootprintFileExtension, KiCadFootprintLibPathExtension, KiCadPcbFileExtension, KiCadProjectArchive, KiCadSchematicFileExtension, KiCadSymbolLibFileExtension, type LabelPadding, Layout, LegacyFootprintLibPathExtension, LegacyPcbFileExtension, LegacyProjectFileExtension, LegacySchematicFileExtension, LegacySymbolDocumentFileExtension, LegacySymbolLibFileExtension, MacrosFileExtension, MarkdownFileExtension, NetListConverter, NetlistFileExtension, type NetlistProject, type NetlistToKicadContext, OrCadPcb2NetlistFileExtension, PAPER, PAPER_SIZE, PdfFileExtension, PngFileExtension, ProjectFileExtension, ProjectLocalSettingsFileExtension, ReportFileExtension, SCHEMATIC_PRINTER, SCH_VERSION, SVGFileExtension, SchematicSymbolFileExtension, type Size, SpecctraDsnFileExtension, SpecctraSessionFileExtension, SpiceFileExtension, StepFileAbrvExtension, StepFileExtension, StringFormatter, TextFileExtension, VrmlFileExtension, WIRE_PADDING, WorkbookFileExtension, XmlFileExtension, collect_sub_sheets, collect_sub_sheets_by_id, convert_graph_to_design_block, convert_graph_to_kicad_project, convert_graph_to_sheets, filterNullOrUndefined, gen_lib_gnd, gen_lib_vcc, gen_sch_gnd, gen_sch_vcc, get_power_pos, get_sch_default_drawing_sheet, tab };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { VECTOR2, At, Color, ConnectionGraph, NL_NetList, BOX2 } from '@modular-circuit/electronics-model';
-import { SCHEMATIC, PIN_DISPLAY_OPT, LIB_SYMBOL, Drawing, PIN_DEFINITION, SCH_LABEL, SCH_SYMBOL, SCH_LINE, PIN_INSTANCE, SCH_SHEET, SCH_SHEET_PIN, Effects, Justify, SCH_FIELD, Fill, Stroke, Project, IR_Graph, ModuleResolver, ModuleCircuit } from '@modular-circuit/ir';
+import { SCHEMATIC, PIN_DISPLAY_OPT, LIB_SYMBOL, Drawing, PIN_DEFINITION, SCH_LABEL, SCH_SYMBOL, SCH_LINE, PIN_INSTANCE, SCH_SHEET, SCH_SHEET_PIN, Effects, Justify, SCH_FIELD, Fill, Stroke, Project, IR_Graph, DesignBlockContent, ModuleResolver, ModuleCircuit } from '@modular-circuit/ir';
 import { CG_SCHEMATIC, CONNECTION_GRAPH_BUILDER_CTX } from '@modular-circuit/perc';
 
 declare function get_sch_default_drawing_sheet(): string;
@@ -128,8 +128,12 @@ declare class NetListConverter {
     private convert_net_label;
 }
 
+declare function convert_graph_to_sheets(ctx: ConvertGraphToKiCadInput): Promise<Record<string, string>>;
+
 declare function convert_graph_to_kicad_project(ctx: ConvertGraphToKiCadInput): Promise<Blob>;
 
+declare function convert_graph_to_design_block(ctx: ConvertGraphToKiCadInput): Promise<DesignBlockContent>;
+
 declare const KiCadSymbolLibFileExtension = "kicad_sym";
 declare const SchematicSymbolFileExtension = "sym";
 declare const LegacySymbolLibFileExtension = "lib";
@@ -463,20 +467,11 @@ declare class StringFormatter {
     append_quote(str: string): void;
 }
 
-interface NamedContent {
-    filename: string;
-    content: string;
-}
-interface DesignBlock {
-    main_sch: string;
-    sheets: NamedContent[];
-    pcb?: NamedContent;
-}
 declare function collect_sub_sheets_by_id(module_ids: string[], module_resolver: ModuleResolver): Promise<{
     sheets: Record<string, string>;
     module_main_sheet: Record<string, string>;
     modules: Record<string, ModuleCircuit>;
-    design_blocks: DesignBlock[];
+    design_blocks: DesignBlockContent[];
 }>;
 
 declare const gen_lib_gnd: (value: string) => LIB_SYMBOL;
@@ -487,4 +482,4 @@ declare const gen_sch_gnd: (value: string, pwr_number: number, port_id: string,
 
 declare const gen_sch_vcc: (value: string, pwr_number: number, port_id: string, position: VECTOR2) => SCH_SYMBOL;
 
-export { AllegroNetlistFileExtension, AltiumFootprintLibPathExtension, ArchiveFileExtension, BLOCK_PIN_GAP, BLOCK_PIN_TB_MARGIN, type BlockLabelPadding, type BlockSize, type BoxGeometry, CadstarFootprintLibPathExtension, CadstarNetlistFileExtension, CadstarPartsLibraryFileExtension, CadstarPcbFileExtension, CadstarSchematicFileExtension, type ConnectionGraphMap, type ConvertGraphToKiCadContext, type ConvertGraphToKiCadInput, CsvFileExtension, DEFAULT_PAPER_SIZE, DatabaseLibraryFileExtension, type DesignBlock, DesignRulesFileExtension, DrawingSheetFileExtension, DrillFileExtension, EagleFootprintLibPathExtension, EaglePcbFileExtension, EquFileExtension, FONT_SIZE, FootprintAssignmentFileExtension, FootprintPlaceFileExtension, GENERATOR_NAME, GENERATOR_VERSION, GRID_SIZE, GedaPcbFootprintLibFileExtension, GerberFileExtension, GerberFileExtensionsRegex, GerberJobFileExtension, GltfBinaryFileExtension, GraphConverter, HTTPLibraryFileExtension, HotkeyFileExtension, HtmlFileExtension, Ipc2581FileExtension, IpcD356FileExtension, JpegFileExtension, JsonFileExtension, KICAD_SCH_FRAME, KiCadFootprintFileExtension, KiCadFootprintLibPathExtension, KiCadPcbFileExtension, KiCadProjectArchive, KiCadSchematicFileExtension, KiCadSymbolLibFileExtension, type LabelPadding, Layout, LegacyFootprintLibPathExtension, LegacyPcbFileExtension, LegacyProjectFileExtension, LegacySchematicFileExtension, LegacySymbolDocumentFileExtension, LegacySymbolLibFileExtension, MacrosFileExtension, MarkdownFileExtension, type NamedContent, NetListConverter, NetlistFileExtension, type NetlistProject, type NetlistToKicadContext, OrCadPcb2NetlistFileExtension, PAPER, PAPER_SIZE, PdfFileExtension, PngFileExtension, ProjectFileExtension, ProjectLocalSettingsFileExtension, ReportFileExtension, SCHEMATIC_PRINTER, SCH_VERSION, SVGFileExtension, SchematicSymbolFileExtension, type Size, SpecctraDsnFileExtension, SpecctraSessionFileExtension, SpiceFileExtension, StepFileAbrvExtension, StepFileExtension, StringFormatter, TextFileExtension, VrmlFileExtension, WIRE_PADDING, WorkbookFileExtension, XmlFileExtension, collect_sub_sheets, collect_sub_sheets_by_id, convert_graph_to_kicad_project, filterNullOrUndefined, gen_lib_gnd, gen_lib_vcc, gen_sch_gnd, gen_sch_vcc, get_power_pos, get_sch_default_drawing_sheet, tab };
+export { AllegroNetlistFileExtension, AltiumFootprintLibPathExtension, ArchiveFileExtension, BLOCK_PIN_GAP, BLOCK_PIN_TB_MARGIN, type BlockLabelPadding, type BlockSize, type BoxGeometry, CadstarFootprintLibPathExtension, CadstarNetlistFileExtension, CadstarPartsLibraryFileExtension, CadstarPcbFileExtension, CadstarSchematicFileExtension, type ConnectionGraphMap, type ConvertGraphToKiCadContext, type ConvertGraphToKiCadInput, CsvFileExtension, DEFAULT_PAPER_SIZE, DatabaseLibraryFileExtension, DesignRulesFileExtension, DrawingSheetFileExtension, DrillFileExtension, EagleFootprintLibPathExtension, EaglePcbFileExtension, EquFileExtension, FONT_SIZE, FootprintAssignmentFileExtension, FootprintPlaceFileExtension, GENERATOR_NAME, GENERATOR_VERSION, GRID_SIZE, GedaPcbFootprintLibFileExtension, GerberFileExtension, GerberFileExtensionsRegex, GerberJobFileExtension, GltfBinaryFileExtension, GraphConverter, HTTPLibraryFileExtension, HotkeyFileExtension, HtmlFileExtension, Ipc2581FileExtension, IpcD356FileExtension, JpegFileExtension, JsonFileExtension, KICAD_SCH_FRAME, KiCadFootprintFileExtension, KiCadFootprintLibPathExtension, KiCadPcbFileExtension, KiCadProjectArchive, KiCadSchematicFileExtension, KiCadSymbolLibFileExtension, type LabelPadding, Layout, LegacyFootprintLibPathExtension, LegacyPcbFileExtension, LegacyProjectFileExtension, LegacySchematicFileExtension, LegacySymbolDocumentFileExtension, LegacySymbolLibFileExtension, MacrosFileExtension, MarkdownFileExtension, NetListConverter, NetlistFileExtension, type NetlistProject, type NetlistToKicadContext, OrCadPcb2NetlistFileExtension, PAPER, PAPER_SIZE, PdfFileExtension, PngFileExtension, ProjectFileExtension, ProjectLocalSettingsFileExtension, ReportFileExtension, SCHEMATIC_PRINTER, SCH_VERSION, SVGFileExtension, SchematicSymbolFileExtension, type Size, SpecctraDsnFileExtension, SpecctraSessionFileExtension, SpiceFileExtension, StepFileAbrvExtension, StepFileExtension, StringFormatter, TextFileExtension, VrmlFileExtension, WIRE_PADDING, WorkbookFileExtension, XmlFileExtension, collect_sub_sheets, collect_sub_sheets_by_id, convert_graph_to_design_block, convert_graph_to_kicad_project, convert_graph_to_sheets, filterNullOrUndefined, gen_lib_gnd, gen_lib_vcc, gen_sch_gnd, gen_sch_vcc, get_power_pos, get_sch_default_drawing_sheet, tab };

package/dist/index.js

@@ -155,7 +155,9 @@ __export(index_exports, {
   XmlFileExtension: () => XmlFileExtension,
   collect_sub_sheets: () => collect_sub_sheets,
   collect_sub_sheets_by_id: () => collect_sub_sheets_by_id,
+  convert_graph_to_design_block: () => convert_graph_to_design_block,
   convert_graph_to_kicad_project: () => convert_graph_to_kicad_project,
+  convert_graph_to_sheets: () => convert_graph_to_sheets,
   filterNullOrUndefined: () => filterNullOrUndefined,
   gen_lib_gnd: () => gen_lib_gnd,
   gen_lib_vcc: () => gen_lib_vcc,
@@ -313,8 +315,10 @@ async function collect_sub_sheets_by_id(module_ids, module_resolver) {
       module_main_sheet[k] = module_circuit.main;
       modules[k] = module_circuit;
       const design_block = {
-        main_sch: module_circuit.main,
-        sheets: []
+        root: module_circuit.main,
+        schematics: [],
+        pcb: null,
+        components: []
       };
       console.log(`Fetching ZIP archive for module ${id} from ${zip_archive_url.toString()}`);
       const zip_archive = await fetch(zip_archive_url).then((res) => res.arrayBuffer());
@@ -327,10 +331,10 @@ async function collect_sub_sheets_by_id(module_ids, module_resolver) {
             continue;
           }
           sheets[filename] = content;
-          design_block.sheets.push({ filename, content });
+          design_block.schematics.push({ filename, content });
         } else if (name.endsWith(import_utils2.KICAD_PCB_FILE_EXT)) {
           const filename = (0, import_utils2.remove_filename_path_prefix)(name);
-          design_block.pcb = { filename, content };
+          design_block.pcb = { pcb: { filename, content } };
         }
       }
       design_blocks.push(design_block);
@@ -2986,6 +2990,26 @@ async function convert_graph_to_kicad_project(ctx) {
   });
   return kicad_project.toZip();
 }
+
+// src/builder/graph_to_kicad/convert_graph_to_design_block.ts
+async function convert_graph_to_design_block(ctx) {
+  const sheets = await convert_graph_to_sheets(ctx);
+  const kicad_project = new KiCadProjectArchive(ctx.project.name, {
+    ...sheets
+  });
+  const design_block = {
+    root: kicad_project.main_sch_name,
+    pcb: null,
+    components: [],
+    schematics: Object.entries(sheets).map(([filename, content]) => {
+      return {
+        filename,
+        content
+      };
+    })
+  };
+  return design_block;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AllegroNetlistFileExtension,
@@ -3069,7 +3093,9 @@ async function convert_graph_to_kicad_project(ctx) {
   XmlFileExtension,
   collect_sub_sheets,
   collect_sub_sheets_by_id,
+  convert_graph_to_design_block,
   convert_graph_to_kicad_project,
+  convert_graph_to_sheets,
   filterNullOrUndefined,
   gen_lib_gnd,
   gen_lib_vcc,

package/dist/index.mjs

@@ -200,8 +200,10 @@ async function collect_sub_sheets_by_id(module_ids, module_resolver) {
       module_main_sheet[k] = module_circuit.main;
       modules[k] = module_circuit;
       const design_block = {
-        main_sch: module_circuit.main,
-        sheets: []
+        root: module_circuit.main,
+        schematics: [],
+        pcb: null,
+        components: []
       };
       console.log(`Fetching ZIP archive for module ${id} from ${zip_archive_url.toString()}`);
       const zip_archive = await fetch(zip_archive_url).then((res) => res.arrayBuffer());
@@ -214,10 +216,10 @@ async function collect_sub_sheets_by_id(module_ids, module_resolver) {
             continue;
           }
           sheets[filename] = content;
-          design_block.sheets.push({ filename, content });
+          design_block.schematics.push({ filename, content });
         } else if (name.endsWith(KICAD_PCB_FILE_EXT)) {
           const filename = remove_filename_path_prefix2(name);
-          design_block.pcb = { filename, content };
+          design_block.pcb = { pcb: { filename, content } };
         }
       }
       design_blocks.push(design_block);
@@ -2887,6 +2889,26 @@ async function convert_graph_to_kicad_project(ctx) {
   });
   return kicad_project.toZip();
 }
+
+// src/builder/graph_to_kicad/convert_graph_to_design_block.ts
+async function convert_graph_to_design_block(ctx) {
+  const sheets = await convert_graph_to_sheets(ctx);
+  const kicad_project = new KiCadProjectArchive(ctx.project.name, {
+    ...sheets
+  });
+  const design_block = {
+    root: kicad_project.main_sch_name,
+    pcb: null,
+    components: [],
+    schematics: Object.entries(sheets).map(([filename, content]) => {
+      return {
+        filename,
+        content
+      };
+    })
+  };
+  return design_block;
+}
 export {
   AllegroNetlistFileExtension,
   AltiumFootprintLibPathExtension,
@@ -2969,7 +2991,9 @@ export {
   XmlFileExtension,
   collect_sub_sheets,
   collect_sub_sheets_by_id,
+  convert_graph_to_design_block,
   convert_graph_to_kicad_project,
+  convert_graph_to_sheets,
   filterNullOrUndefined,
   gen_lib_gnd,
   gen_lib_vcc,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modular-circuit/transpiler",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Intermediate representation of the modular circuit",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -31,8 +31,8 @@
     "jszip": "^3.10.1",
     "@modular-circuit/electronics-model": "0.1.1",
     "@modular-circuit/ir": "0.1.3",
-    "@modular-circuit/perc": "0.1.4",
-    "@modular-circuit/utils": "0.1.2"
+    "@modular-circuit/utils": "0.1.2",
+    "@modular-circuit/perc": "0.1.4"
   },
   "scripts": {
     "clean": "rimraf dist",