circuit-json 0.0.178 → 0.0.180
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.
- package/README.md +46 -0
- package/dist/index.d.mts +768 -56
- package/dist/index.mjs +426 -368
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -71,6 +71,7 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
71
71
|
- [PcbAutoroutingError](#pcbautoroutingerror)
|
|
72
72
|
- [PcbBoard](#pcbboard)
|
|
73
73
|
- [PcbComponent](#pcbcomponent)
|
|
74
|
+
- [PcbCutout](#pcbcutout)
|
|
74
75
|
- [PcbFabricationNotePath](#pcbfabricationnotepath)
|
|
75
76
|
- [PcbFabricationNoteText](#pcbfabricationnotetext)
|
|
76
77
|
- [PcbGroup](#pcbgroup)
|
|
@@ -97,6 +98,7 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
97
98
|
- [SchematicBox](#schematicbox)
|
|
98
99
|
- [SchematicComponent](#schematiccomponent)
|
|
99
100
|
- [SchematicError](#schematicerror)
|
|
101
|
+
- [SchematicGroup](#schematicgroup)
|
|
100
102
|
- [SchematicLine](#schematicline)
|
|
101
103
|
- [SchematicManualEditConflictWarning](#schematicmanualeditconflictwarning)
|
|
102
104
|
- [SchematicPath](#schematicpath)
|
|
@@ -557,6 +559,27 @@ interface PcbComponent {
|
|
|
557
559
|
}
|
|
558
560
|
```
|
|
559
561
|
|
|
562
|
+
### PcbCutout
|
|
563
|
+
|
|
564
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_cutout.ts)
|
|
565
|
+
|
|
566
|
+
Defines a rectangular cutout on the PCB.
|
|
567
|
+
|
|
568
|
+
```typescript
|
|
569
|
+
/** Defines a rectangular cutout on the PCB. */
|
|
570
|
+
interface PcbCutoutRect {
|
|
571
|
+
type: "pcb_cutout"
|
|
572
|
+
pcb_cutout_id: string
|
|
573
|
+
pcb_group_id?: string
|
|
574
|
+
subcircuit_id?: string
|
|
575
|
+
shape: "rect"
|
|
576
|
+
center: Point
|
|
577
|
+
width: Length
|
|
578
|
+
height: Length
|
|
579
|
+
rotation?: Rotation
|
|
580
|
+
}
|
|
581
|
+
```
|
|
582
|
+
|
|
560
583
|
### PcbFabricationNotePath
|
|
561
584
|
|
|
562
585
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_fabrication_note_path.ts)
|
|
@@ -1124,6 +1147,29 @@ interface SchematicError {
|
|
|
1124
1147
|
}
|
|
1125
1148
|
```
|
|
1126
1149
|
|
|
1150
|
+
### SchematicGroup
|
|
1151
|
+
|
|
1152
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_group.ts)
|
|
1153
|
+
|
|
1154
|
+
Defines a group of components on the schematic
|
|
1155
|
+
|
|
1156
|
+
```typescript
|
|
1157
|
+
/** Defines a group of components on the schematic */
|
|
1158
|
+
interface SchematicGroup {
|
|
1159
|
+
type: "schematic_group"
|
|
1160
|
+
schematic_group_id: string
|
|
1161
|
+
source_group_id: string
|
|
1162
|
+
is_subcircuit?: boolean
|
|
1163
|
+
subcircuit_id?: string
|
|
1164
|
+
width: Length
|
|
1165
|
+
height: Length
|
|
1166
|
+
center: Point
|
|
1167
|
+
schematic_component_ids: string[]
|
|
1168
|
+
name?: string
|
|
1169
|
+
description?: string
|
|
1170
|
+
}
|
|
1171
|
+
```
|
|
1172
|
+
|
|
1127
1173
|
### SchematicLine
|
|
1128
1174
|
|
|
1129
1175
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_line.ts)
|