circuit-to-svg 0.0.210 → 0.0.212

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +7 -7
  2. package/dist/index.d.ts +7 -2
  3. package/dist/index.js +385 -227
  4. package/dist/index.js.map +1 -1
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -65,7 +65,7 @@ const schematicSvg = convertCircuitJsonToSchematicSvg(circuitJson, {
65
65
  })
66
66
  ```
67
67
 
68
- See the [schematic grid snapshot](tests/sch/__snapshots__/grid-and-points.snap.svg).
68
+ ![Schematic grid snapshot](./tests/sch/__snapshots__/grid-and-points.snap.svg)
69
69
 
70
70
  #### Options
71
71
 
@@ -91,7 +91,7 @@ const pcbSvg = convertCircuitJsonToPcbSvg(circuitJson, {
91
91
  })
92
92
  ```
93
93
 
94
- See the [PCB default snapshot](tests/pcb/__snapshots__/default.snap.svg).
94
+ ![PCB default snapshot](./tests/pcb/__snapshots__/default.snap.svg)
95
95
 
96
96
  #### Options
97
97
 
@@ -119,7 +119,7 @@ const assemblySvg = convertCircuitJsonToAssemblySvg(circuitJson, {
119
119
  })
120
120
  ```
121
121
 
122
- See the [assembly board snapshot](tests/assembly/__snapshots__/first-assembly-test.snap.svg).
122
+ ![Assembly board snapshot](./tests/assembly/__snapshots__/first-assembly-test.snap.svg)
123
123
 
124
124
  #### Options
125
125
 
@@ -139,7 +139,7 @@ import { convertCircuitJsonToPinoutSvg } from 'circuit-to-svg'
139
139
  const pinoutSvg = convertCircuitJsonToPinoutSvg(circuitJson)
140
140
  ```
141
141
 
142
- See the [pinout snapshot](tests/pinout/__snapshots__/pinout-basic.snap.svg).
142
+ ![Pinout snapshot](./tests/pinout/__snapshots__/pinout-basic.snap.svg)
143
143
 
144
144
  #### Options
145
145
 
@@ -173,7 +173,7 @@ const schematicSimulationSvg = convertCircuitJsonToSchematicSimulationSvg({
173
173
  })
174
174
  ```
175
175
 
176
- See the [schematic simulation snapshot](tests/sim/__snapshots__/schematic-simulation-combined.snap.svg).
176
+ ![Schematic simulation snapshot](./tests/sim/__snapshots__/schematic-simulation-combined.snap.svg)
177
177
 
178
178
  #### Options
179
179
 
@@ -206,7 +206,7 @@ const simulationGraphSvg = convertCircuitJsonToSimulationGraphSvg({
206
206
  })
207
207
  ```
208
208
 
209
- See the [simulation graph snapshot](tests/sim/__snapshots__/simulation-graph.snap.svg).
209
+ ![Simulation graph snapshot](./tests/sim/__snapshots__/simulation-graph.snap.svg)
210
210
 
211
211
  #### Options
212
212
 
@@ -228,7 +228,7 @@ const solderPasteMaskSvg = convertCircuitJsonToSolderPasteMask(circuitJson, {
228
228
  })
229
229
  ```
230
230
 
231
- See the [solder paste snapshot](tests/pcb/__snapshots__/solder-paste.test.tsx.top.snap.svg).
231
+ ![Solder paste snapshot](./tests/pcb/__snapshots__/solder-paste.test.tsx.top.snap.svg)
232
232
 
233
233
  #### Options
234
234
 
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { AnyCircuitElement, SchematicComponent } from 'circuit-json';
1
+ import { AnyCircuitElement, PcbPort, SchematicComponent } from 'circuit-json';
2
2
  import { Matrix } from 'transformation-matrix';
3
3
  import { INode } from 'svgson';
4
4
 
@@ -87,6 +87,11 @@ interface Options$2 {
87
87
  height?: number;
88
88
  includeVersion?: boolean;
89
89
  }
90
+ interface PinoutLabel {
91
+ pcb_port: PcbPort;
92
+ aliases: string[];
93
+ edge: "left" | "right" | "top" | "bottom";
94
+ }
90
95
  interface PinoutSvgContext {
91
96
  transform: Matrix;
92
97
  soup: AnyCircuitElement[];
@@ -347,4 +352,4 @@ declare const createSvgObjectsForSchComponentPortHovers: ({ component, transform
347
352
  circuitJson: AnyCircuitElement[];
348
353
  }) => INode[];
349
354
 
350
- export { type AssemblySvgContext, CIRCUIT_TO_SVG_VERSION, type ColorMap, type ColorOverrides, type PcbColorMap, type PcbColorOverrides, type PcbContext, type PinoutSvgContext, circuitJsonToPcbSvg, circuitJsonToSchematicSvg, convertCircuitJsonToAssemblySvg, convertCircuitJsonToPcbSvg, convertCircuitJsonToPinoutSvg, convertCircuitJsonToSchematicSimulationSvg, convertCircuitJsonToSchematicSvg, convertCircuitJsonToSimulationGraphSvg, convertCircuitJsonToSolderPasteMask, createSvgObjectsForSchComponentPortHovers, getSoftwareUsedString };
355
+ export { type AssemblySvgContext, CIRCUIT_TO_SVG_VERSION, type ColorMap, type ColorOverrides, type PcbColorMap, type PcbColorOverrides, type PcbContext, type PinoutLabel, type PinoutSvgContext, circuitJsonToPcbSvg, circuitJsonToSchematicSvg, convertCircuitJsonToAssemblySvg, convertCircuitJsonToPcbSvg, convertCircuitJsonToPinoutSvg, convertCircuitJsonToSchematicSimulationSvg, convertCircuitJsonToSchematicSvg, convertCircuitJsonToSimulationGraphSvg, convertCircuitJsonToSolderPasteMask, createSvgObjectsForSchComponentPortHovers, getSoftwareUsedString };