circuit-json 0.0.170 → 0.0.172

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 (2) hide show
  1. package/README.md +114 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -20,6 +20,8 @@ could then read the DSN file back to Circuit JSON.
20
20
  This module has the zod definitions and conversion functions for using circuit json,
21
21
  and is the primary way that Circuit JSON is defined and maintained.
22
22
 
23
+ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
24
+
23
25
  ## Things You Can Do With Circuit JSON
24
26
 
25
27
  - Generate [Gerber files](https://github.com/tscircuit/circuit-json-to-gerber)
@@ -177,6 +179,8 @@ There are 3 main element prefixes:
177
179
 
178
180
  ### SourceComponentBase
179
181
 
182
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/base/source_component_base.ts)
183
+
180
184
  ```typescript
181
185
  interface SourceComponentBase {
182
186
  type: "source_component"
@@ -193,6 +197,8 @@ interface SourceComponentBase {
193
197
 
194
198
  ### SourceFailedToCreateComponentError
195
199
 
200
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_failed_to_create_component_error.ts)
201
+
196
202
  ```typescript
197
203
  /** Error emitted when a component fails to be constructed.
198
204
  * Contains details about the failure and prevents the component from being rendered. */
@@ -211,6 +217,8 @@ interface SourceFailedToCreateComponentError {
211
217
 
212
218
  ### SourceLed
213
219
 
220
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_led.ts)
221
+
214
222
  Defines an LED component that extends the simple diode
215
223
 
216
224
  ```typescript
@@ -222,6 +230,8 @@ interface SourceLed extends SourceComponentBase {
222
230
 
223
231
  ### SourceMissingPropertyError
224
232
 
233
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_missing_property_error.ts)
234
+
225
235
  The source code is missing a property
226
236
 
227
237
  ```typescript
@@ -238,6 +248,8 @@ interface SourceMissingPropertyError {
238
248
 
239
249
  ### SourcePort
240
250
 
251
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_port.ts)
252
+
241
253
  Defines a source port that can be connected to other components
242
254
 
243
255
  ```typescript
@@ -255,6 +267,8 @@ interface SourcePort {
255
267
 
256
268
  ### SourceProjectMetadata
257
269
 
270
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_project_metadata.ts)
271
+
258
272
  ```typescript
259
273
  interface SourceProjectMetadata {
260
274
  type: "source_project_metadata"
@@ -266,6 +280,8 @@ interface SourceProjectMetadata {
266
280
 
267
281
  ### SourceSimpleBattery
268
282
 
283
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_battery.ts)
284
+
269
285
  Defines a simple battery component
270
286
 
271
287
  ```typescript
@@ -278,6 +294,8 @@ interface SourceSimpleBattery extends SourceComponentBase {
278
294
 
279
295
  ### SourceSimpleCapacitor
280
296
 
297
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_capacitor.ts)
298
+
281
299
  Defines a simple capacitor component
282
300
 
283
301
  ```typescript
@@ -293,6 +311,8 @@ interface SourceSimpleCapacitor extends SourceComponentBase {
293
311
 
294
312
  ### SourceSimpleChip
295
313
 
314
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_chip.ts)
315
+
296
316
  Defines a simple integrated circuit component
297
317
 
298
318
  ```typescript
@@ -304,6 +324,8 @@ interface SourceSimpleChip extends SourceComponentBase {
304
324
 
305
325
  ### SourceSimpleCrystal
306
326
 
327
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_crystal.ts)
328
+
307
329
  Defines a simple crystal oscillator component
308
330
 
309
331
  ```typescript
@@ -317,6 +339,8 @@ interface SourceSimpleCrystal extends SourceComponentBase {
317
339
 
318
340
  ### SourceSimpleDiode
319
341
 
342
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_diode.ts)
343
+
320
344
  Defines a simple diode component
321
345
 
322
346
  ```typescript
@@ -328,6 +352,8 @@ interface SourceSimpleDiode extends SourceComponentBase {
328
352
 
329
353
  ### SourceSimpleGround
330
354
 
355
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_ground.ts)
356
+
331
357
  Defines a simple ground component
332
358
 
333
359
  ```typescript
@@ -339,6 +365,8 @@ interface SourceSimpleGround extends SourceComponentBase {
339
365
 
340
366
  ### SourceSimpleInductor
341
367
 
368
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_inductor.ts)
369
+
342
370
  Defines a simple inductor component
343
371
 
344
372
  ```typescript
@@ -351,6 +379,8 @@ interface SourceSimpleInductor extends SourceComponentBase {
351
379
 
352
380
  ### SourceSimpleMosfet
353
381
 
382
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_mosfet.ts)
383
+
354
384
  ```typescript
355
385
  /** Defines a simple mosfet component
356
386
  * This is a three-pin semiconductor device (source, gate, drain)
@@ -365,6 +395,8 @@ interface SourceSimpleMosfet extends SourceComponentBase {
365
395
 
366
396
  ### SourceSimplePowerSource
367
397
 
398
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_power_source.ts)
399
+
368
400
  Defines a simple power source component
369
401
 
370
402
  ```typescript
@@ -377,6 +409,8 @@ interface SourceSimplePowerSource extends SourceComponentBase {
377
409
 
378
410
  ### SourceSimplePushButton
379
411
 
412
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_push_button.ts)
413
+
380
414
  Defines a simple push button component
381
415
 
382
416
  ```typescript
@@ -388,6 +422,8 @@ interface SourceSimplePushButton extends SourceComponentBase {
388
422
 
389
423
  ### SourceSimpleResistor
390
424
 
425
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_resistor.ts)
426
+
391
427
  Defines a simple resistor component
392
428
 
393
429
  ```typescript
@@ -401,6 +437,8 @@ interface SourceSimpleResistor extends SourceComponentBase {
401
437
 
402
438
  ### SourceSimpleResonator
403
439
 
440
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_resonator.ts)
441
+
404
442
  Defines a simple resonator component
405
443
 
406
444
  ```typescript
@@ -415,6 +453,8 @@ interface SourceSimpleResonator extends SourceComponentBase {
415
453
 
416
454
  ### SourceSimpleSwitch
417
455
 
456
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_switch.ts)
457
+
418
458
  Defines a simple switch component
419
459
 
420
460
  ```typescript
@@ -426,6 +466,8 @@ interface SourceSimpleSwitch extends SourceComponentBase {
426
466
 
427
467
  ### SourceSimpleTransistor
428
468
 
469
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_simple_transistor.ts)
470
+
429
471
  ```typescript
430
472
  /** Defines a simple transistor component
431
473
  * This is a three-pin semiconductor device (emitter, base, collector)
@@ -439,6 +481,8 @@ interface SourceSimpleTransistor extends SourceComponentBase {
439
481
 
440
482
  ### SourceTrace
441
483
 
484
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_trace.ts)
485
+
442
486
  ```typescript
443
487
  interface SourceTrace {
444
488
  type: "source_trace"
@@ -457,6 +501,8 @@ interface SourceTrace {
457
501
 
458
502
  ### PcbAutoroutingError
459
503
 
504
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_autorouting_error.ts)
505
+
460
506
  ```typescript
461
507
  interface PcbAutoroutingErrorInterface {
462
508
  type: "pcb_autorouting_error"
@@ -467,6 +513,8 @@ interface PcbAutoroutingErrorInterface {
467
513
 
468
514
  ### PcbBoard
469
515
 
516
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_board.ts)
517
+
470
518
  Defines the board outline of the PCB
471
519
 
472
520
  ```typescript
@@ -488,6 +536,8 @@ interface PcbBoard {
488
536
 
489
537
  ### PcbComponent
490
538
 
539
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_component.ts)
540
+
491
541
  Defines a component on the PCB
492
542
 
493
543
  ```typescript
@@ -507,6 +557,8 @@ interface PcbComponent {
507
557
 
508
558
  ### PcbFabricationNotePath
509
559
 
560
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_fabrication_note_path.ts)
561
+
510
562
  Defines a fabrication path on the PCB for fabricators or assemblers
511
563
 
512
564
  ```typescript
@@ -525,6 +577,8 @@ interface PcbFabricationNotePath {
525
577
 
526
578
  ### PcbFabricationNoteText
527
579
 
580
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_fabrication_note_text.ts)
581
+
528
582
  Defines a fabrication note in text on the PCB, useful for leaving notes for assemblers or fabricators
529
583
 
530
584
  ```typescript
@@ -552,6 +606,8 @@ interface PcbFabricationNoteText {
552
606
 
553
607
  ### PcbGroup
554
608
 
609
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_group.ts)
610
+
555
611
  Defines a group of components on the PCB
556
612
 
557
613
  ```typescript
@@ -573,6 +629,8 @@ interface PcbGroup {
573
629
 
574
630
  ### PcbHole
575
631
 
632
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_hole.ts)
633
+
576
634
  Defines a circular or square hole on the PCB
577
635
 
578
636
  ```typescript
@@ -591,6 +649,8 @@ interface PcbHoleCircleOrSquare {
591
649
 
592
650
  ### PcbManualEditConflictWarning
593
651
 
652
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_manual_edit_conflict_warning.ts)
653
+
594
654
  Warning emitted when a component has both manual placement (via manualEdits) and explicit pcbX/pcbY coordinates
595
655
 
596
656
  ```typescript
@@ -608,6 +668,8 @@ interface PcbManualEditConflictWarning {
608
668
 
609
669
  ### PcbMissingFootprintError
610
670
 
671
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_missing_footprint_error.ts)
672
+
611
673
  Defines a placement error on the PCB
612
674
 
613
675
  ```typescript
@@ -625,6 +687,8 @@ interface PcbMissingFootprintError {
625
687
 
626
688
  ### PcbPlacementError
627
689
 
690
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_placement_error.ts)
691
+
628
692
  Defines a placement error on the PCB
629
693
 
630
694
  ```typescript
@@ -638,6 +702,8 @@ interface PcbPlacementError {
638
702
 
639
703
  ### PcbPlatedHole
640
704
 
705
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_plated_hole.ts)
706
+
641
707
  Defines a circular plated hole on the PCB
642
708
 
643
709
  ```typescript
@@ -700,6 +766,8 @@ interface PcbHoleCircularWithRectPad {
700
766
 
701
767
  ### PcbPort
702
768
 
769
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_port.ts)
770
+
703
771
  Defines a port on the PCB
704
772
 
705
773
  ```typescript
@@ -719,6 +787,8 @@ interface PcbPort {
719
787
 
720
788
  ### PcbPortNotMatchedError
721
789
 
790
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_port_not_matched_error.ts)
791
+
722
792
  Defines a trace error on the PCB where a port is not matched
723
793
 
724
794
  ```typescript
@@ -733,6 +803,8 @@ interface PcbPortNotMatchedError {
733
803
 
734
804
  ### PcbSilkscreenCircle
735
805
 
806
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_silkscreen_circle.ts)
807
+
736
808
  Defines a silkscreen circle on the PCB
737
809
 
738
810
  ```typescript
@@ -752,6 +824,8 @@ interface PcbSilkscreenCircle {
752
824
 
753
825
  ### PcbSilkscreenLine
754
826
 
827
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_silkscreen_line.ts)
828
+
755
829
  Defines a silkscreen line on the PCB
756
830
 
757
831
  ```typescript
@@ -773,6 +847,8 @@ interface PcbSilkscreenLine {
773
847
 
774
848
  ### PcbSilkscreenOval
775
849
 
850
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_silkscreen_oval.ts)
851
+
776
852
  Defines a silkscreen oval on the PCB
777
853
 
778
854
  ```typescript
@@ -792,6 +868,8 @@ interface PcbSilkscreenOval {
792
868
 
793
869
  ### PcbSilkscreenPath
794
870
 
871
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_silkscreen_path.ts)
872
+
795
873
  Defines a silkscreen path on the PCB
796
874
 
797
875
  ```typescript
@@ -810,6 +888,8 @@ interface PcbSilkscreenPath {
810
888
 
811
889
  ### PcbSilkscreenPill
812
890
 
891
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_silkscreen_pill.ts)
892
+
813
893
  Defines a silkscreen pill on the PCB
814
894
 
815
895
  ```typescript
@@ -829,6 +909,8 @@ interface PcbSilkscreenPill {
829
909
 
830
910
  ### PcbSilkscreenRect
831
911
 
912
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_silkscreen_rect.ts)
913
+
832
914
  Defines a silkscreen rect on the PCB
833
915
 
834
916
  ```typescript
@@ -849,6 +931,8 @@ interface PcbSilkscreenRect {
849
931
 
850
932
  ### PcbSilkscreenText
851
933
 
934
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_silkscreen_text.ts)
935
+
852
936
  Defines silkscreen text on the PCB
853
937
 
854
938
  ```typescript
@@ -877,6 +961,8 @@ interface PcbSilkscreenText {
877
961
 
878
962
  ### PcbSolderPaste
879
963
 
964
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_solder_paste.ts)
965
+
880
966
  Defines solderpaste on the PCB
881
967
 
882
968
  ```typescript
@@ -898,6 +984,8 @@ interface PcbSolderPasteCircle {
898
984
 
899
985
  ### PcbText
900
986
 
987
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_text.ts)
988
+
901
989
  Defines text on the PCB
902
990
 
903
991
  ```typescript
@@ -920,6 +1008,8 @@ interface PcbText {
920
1008
 
921
1009
  ### PcbTrace
922
1010
 
1011
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_trace.ts)
1012
+
923
1013
  ```typescript
924
1014
  interface PcbTraceRoutePointWire {
925
1015
  route_type: "wire"
@@ -934,6 +1024,8 @@ interface PcbTraceRoutePointWire {
934
1024
 
935
1025
  ### PcbTraceError
936
1026
 
1027
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_trace_error.ts)
1028
+
937
1029
  Defines a trace error on the PCB
938
1030
 
939
1031
  ```typescript
@@ -953,6 +1045,8 @@ interface PcbTraceError {
953
1045
 
954
1046
  ### PcbTraceHint
955
1047
 
1048
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_trace_hint.ts)
1049
+
956
1050
  A hint that can be used during generation of a PCB trace.
957
1051
 
958
1052
  ```typescript
@@ -970,6 +1064,8 @@ interface PcbTraceHint {
970
1064
 
971
1065
  ### SchematicBox
972
1066
 
1067
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_box.ts)
1068
+
973
1069
  ```typescript
974
1070
  interface SchematicBox {
975
1071
  type: "schematic_box"
@@ -983,6 +1079,8 @@ interface SchematicBox {
983
1079
 
984
1080
  ### SchematicComponent
985
1081
 
1082
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_component.ts)
1083
+
986
1084
  ```typescript
987
1085
  interface SchematicComponent {
988
1086
  type: "schematic_component"
@@ -1013,6 +1111,8 @@ interface SchematicPortArrangementBySides {
1013
1111
 
1014
1112
  ### SchematicError
1015
1113
 
1114
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_error.ts)
1115
+
1016
1116
  ```typescript
1017
1117
  interface SchematicError {
1018
1118
  type: "schematic_error"
@@ -1024,6 +1124,8 @@ interface SchematicError {
1024
1124
 
1025
1125
  ### SchematicLine
1026
1126
 
1127
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_line.ts)
1128
+
1027
1129
  ```typescript
1028
1130
  /** Defines a line on the schematic, this can be used for adding arbitrary lines
1029
1131
  * to a schematic, but don't use it for drawing traces, schematic boxes or where
@@ -1040,6 +1142,8 @@ interface SchematicLine {
1040
1142
 
1041
1143
  ### SchematicManualEditConflictWarning
1042
1144
 
1145
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_manual_edit_conflict_warning.ts)
1146
+
1043
1147
  Warning emitted when a component has both manual placement (via manualEdits) and explicit schX/schY coordinates
1044
1148
 
1045
1149
  ```typescript
@@ -1057,6 +1161,8 @@ interface SchematicManualEditConflictWarning {
1057
1161
 
1058
1162
  ### SchematicPath
1059
1163
 
1164
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_path.ts)
1165
+
1060
1166
  ```typescript
1061
1167
  interface SchematicPath {
1062
1168
  type: "schematic_path"
@@ -1069,6 +1175,8 @@ interface SchematicPath {
1069
1175
 
1070
1176
  ### SchematicPort
1071
1177
 
1178
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_port.ts)
1179
+
1072
1180
  ```typescript
1073
1181
  interface SchematicPort {
1074
1182
  type: "schematic_port"
@@ -1087,6 +1195,8 @@ interface SchematicPort {
1087
1195
 
1088
1196
  ### SchematicText
1089
1197
 
1198
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_text.ts)
1199
+
1090
1200
  ```typescript
1091
1201
  interface SchematicText {
1092
1202
  type: "schematic_text"
@@ -1102,6 +1212,8 @@ interface SchematicText {
1102
1212
 
1103
1213
  ### SchematicTrace
1104
1214
 
1215
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_trace.ts)
1216
+
1105
1217
  ```typescript
1106
1218
  interface SchematicTraceEdge {
1107
1219
  from: {
@@ -1112,6 +1224,8 @@ interface SchematicTraceEdge {
1112
1224
 
1113
1225
  ### SchematicVoltageProbe
1114
1226
 
1227
+ [Source](https://github.com/tscircuit/circuit-json/blob/main/src/schematic/schematic_voltage_probe.ts)
1228
+
1115
1229
  ```typescript
1116
1230
  interface SchematicVoltageProbe {
1117
1231
  type: "schematic_voltage_probe"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "circuit-json",
3
- "version": "0.0.170",
3
+ "version": "0.0.172",
4
4
  "description": "Definitions for the tscircuit intermediary JSON format",
5
5
  "main": "dist/index.mjs",
6
6
  "files": [