circuit-json 0.0.273 → 0.0.275
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 +95 -0
- package/dist/index.d.mts +656 -11
- package/dist/index.mjs +932 -853
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -46,6 +46,7 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
46
46
|
- [Typescript Usage](#typescript-usage)
|
|
47
47
|
|
|
48
48
|
- [Source Components](#source-components)
|
|
49
|
+
- [SourceBoard](#sourceboard)
|
|
49
50
|
- [SourceComponentBase](#sourcecomponentbase)
|
|
50
51
|
- [SourceFailedToCreateComponentError](#sourcefailedtocreatecomponenterror)
|
|
51
52
|
- [SourceGroup](#sourcegroup)
|
|
@@ -88,8 +89,11 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
88
89
|
- [PcbComponent](#pcbcomponent)
|
|
89
90
|
- [PcbComponentOutsideBoardError](#pcbcomponentoutsideboarderror)
|
|
90
91
|
- [PcbCopperPour](#pcbcopperpour)
|
|
92
|
+
- [PcbCourtyardOutline](#pcbcourtyardoutline)
|
|
93
|
+
- [PcbCourtyardRect](#pcbcourtyardrect)
|
|
91
94
|
- [PcbCutout](#pcbcutout)
|
|
92
95
|
- [PcbFabricationNotePath](#pcbfabricationnotepath)
|
|
96
|
+
- [PcbFabricationNoteRect](#pcbfabricationnoterect)
|
|
93
97
|
- [PcbFabricationNoteText](#pcbfabricationnotetext)
|
|
94
98
|
- [PcbFootprintOverlapError](#pcbfootprintoverlaperror)
|
|
95
99
|
- [PcbGroundPlane](#pcbgroundplane)
|
|
@@ -223,6 +227,22 @@ There are 3 main element prefixes:
|
|
|
223
227
|
|
|
224
228
|
## Source Components
|
|
225
229
|
|
|
230
|
+
### SourceBoard
|
|
231
|
+
|
|
232
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_board.ts)
|
|
233
|
+
|
|
234
|
+
Defines a board in the source domain
|
|
235
|
+
|
|
236
|
+
```typescript
|
|
237
|
+
/** Defines a board in the source domain */
|
|
238
|
+
interface SourceBoard {
|
|
239
|
+
type: "source_board"
|
|
240
|
+
source_board_id: string
|
|
241
|
+
source_group_id: string
|
|
242
|
+
title?: string
|
|
243
|
+
}
|
|
244
|
+
```
|
|
245
|
+
|
|
226
246
|
### SourceComponentBase
|
|
227
247
|
|
|
228
248
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/base/source_component_base.ts)
|
|
@@ -919,6 +939,55 @@ interface PcbCopperPourRect {
|
|
|
919
939
|
}
|
|
920
940
|
```
|
|
921
941
|
|
|
942
|
+
### PcbCourtyardOutline
|
|
943
|
+
|
|
944
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_courtyard_outline.ts)
|
|
945
|
+
|
|
946
|
+
Defines a courtyard outline on the PCB
|
|
947
|
+
|
|
948
|
+
```typescript
|
|
949
|
+
/** Defines a courtyard outline on the PCB */
|
|
950
|
+
interface PcbCourtyardOutline {
|
|
951
|
+
type: "pcb_courtyard_outline"
|
|
952
|
+
pcb_courtyard_outline_id: string
|
|
953
|
+
pcb_component_id: string
|
|
954
|
+
pcb_group_id?: string
|
|
955
|
+
subcircuit_id?: string
|
|
956
|
+
layer: VisibleLayer
|
|
957
|
+
outline: Point[]
|
|
958
|
+
stroke_width: Length
|
|
959
|
+
is_closed?: boolean
|
|
960
|
+
is_stroke_dashed?: boolean
|
|
961
|
+
color?: string
|
|
962
|
+
}
|
|
963
|
+
```
|
|
964
|
+
|
|
965
|
+
### PcbCourtyardRect
|
|
966
|
+
|
|
967
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_courtyard_rect.ts)
|
|
968
|
+
|
|
969
|
+
Defines a courtyard rectangle on the PCB
|
|
970
|
+
|
|
971
|
+
```typescript
|
|
972
|
+
/** Defines a courtyard rectangle on the PCB */
|
|
973
|
+
interface PcbCourtyardRect {
|
|
974
|
+
type: "pcb_courtyard_rect"
|
|
975
|
+
pcb_courtyard_rect_id: string
|
|
976
|
+
pcb_component_id: string
|
|
977
|
+
pcb_group_id?: string
|
|
978
|
+
subcircuit_id?: string
|
|
979
|
+
center: Point
|
|
980
|
+
width: Length
|
|
981
|
+
height: Length
|
|
982
|
+
layer: VisibleLayer
|
|
983
|
+
stroke_width: Length
|
|
984
|
+
is_filled?: boolean
|
|
985
|
+
has_stroke?: boolean
|
|
986
|
+
is_stroke_dashed?: boolean
|
|
987
|
+
color?: string
|
|
988
|
+
}
|
|
989
|
+
```
|
|
990
|
+
|
|
922
991
|
### PcbCutout
|
|
923
992
|
|
|
924
993
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_cutout.ts)
|
|
@@ -960,6 +1029,32 @@ interface PcbFabricationNotePath {
|
|
|
960
1029
|
}
|
|
961
1030
|
```
|
|
962
1031
|
|
|
1032
|
+
### PcbFabricationNoteRect
|
|
1033
|
+
|
|
1034
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_fabrication_note_rect.ts)
|
|
1035
|
+
|
|
1036
|
+
Defines a fabrication note rectangle on the PCB
|
|
1037
|
+
|
|
1038
|
+
```typescript
|
|
1039
|
+
/** Defines a fabrication note rectangle on the PCB */
|
|
1040
|
+
interface PcbFabricationNoteRect {
|
|
1041
|
+
type: "pcb_fabrication_note_rect"
|
|
1042
|
+
pcb_fabrication_note_rect_id: string
|
|
1043
|
+
pcb_component_id: string
|
|
1044
|
+
pcb_group_id?: string
|
|
1045
|
+
subcircuit_id?: string
|
|
1046
|
+
center: Point
|
|
1047
|
+
width: Length
|
|
1048
|
+
height: Length
|
|
1049
|
+
layer: VisibleLayer
|
|
1050
|
+
stroke_width: Length
|
|
1051
|
+
is_filled?: boolean
|
|
1052
|
+
has_stroke?: boolean
|
|
1053
|
+
is_stroke_dashed?: boolean
|
|
1054
|
+
color?: string
|
|
1055
|
+
}
|
|
1056
|
+
```
|
|
1057
|
+
|
|
963
1058
|
### PcbFabricationNoteText
|
|
964
1059
|
|
|
965
1060
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_fabrication_note_text.ts)
|