@tscircuit/props 0.0.556 → 0.0.558

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 (6) hide show
  1. package/README.md +2 -0
  2. package/dist/index.d.ts +56 -0
  3. package/dist/index.js +3 -1
  4. package/dist/index.js.map +1 -1
  5. package/lib/components/group.ts +12 -0
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -185,6 +185,8 @@ export interface SubcircuitGroupProps extends BaseGroupProps {
185
185
  pcbRouteCache?: PcbRouteCache;
186
186
 
187
187
  autorouter?: AutorouterProp;
188
+ exposedNets?: string[];
189
+ exposeNets?: boolean;
188
190
 
189
191
  /**
190
192
  * If true, we'll automatically layout the schematic for this group. Must be
package/dist/index.d.ts CHANGED
@@ -17953,6 +17953,14 @@ interface SubcircuitGroupProps extends BaseGroupProps, RoutingTolerances {
17953
17953
  * Serialized circuit JSON describing a precompiled subcircuit
17954
17954
  */
17955
17955
  circuitJson?: any[];
17956
+ /**
17957
+ * Nets from this subcircuit that should be exposed to parent circuits
17958
+ */
17959
+ exposedNets?: string[];
17960
+ /**
17961
+ * If true, all nets defined within this subcircuit are exposed to parent circuits
17962
+ */
17963
+ exposeNets?: boolean;
17956
17964
  /**
17957
17965
  * If true, we'll automatically layout the schematic for this group. Must be
17958
17966
  * a subcircuit (currently). This is eventually going to be replaced with more
@@ -19645,6 +19653,8 @@ declare const subcircuitGroupProps: z.ZodObject<{
19645
19653
  outlineOffsetX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
19646
19654
  outlineOffsetY: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
19647
19655
  circuitJson: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
19656
+ exposedNets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
19657
+ exposeNets: z.ZodOptional<z.ZodBoolean>;
19648
19658
  minTraceWidth: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
19649
19659
  minViaHoleEdgeToViaHoleEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
19650
19660
  minViaEdgeToPadEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -20089,6 +20099,8 @@ declare const subcircuitGroupProps: z.ZodObject<{
20089
20099
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
20090
20100
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
20091
20101
  circuitJson?: any[] | undefined;
20102
+ exposedNets?: string[] | undefined;
20103
+ exposeNets?: boolean | undefined;
20092
20104
  schAutoLayoutEnabled?: boolean | undefined;
20093
20105
  schTraceAutoLabelEnabled?: boolean | undefined;
20094
20106
  schMaxTraceDistance?: number | undefined;
@@ -20408,6 +20420,8 @@ declare const subcircuitGroupProps: z.ZodObject<{
20408
20420
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
20409
20421
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
20410
20422
  circuitJson?: any[] | undefined;
20423
+ exposedNets?: string[] | undefined;
20424
+ exposeNets?: boolean | undefined;
20411
20425
  schAutoLayoutEnabled?: boolean | undefined;
20412
20426
  schTraceAutoLabelEnabled?: boolean | undefined;
20413
20427
  schMaxTraceDistance?: string | number | undefined;
@@ -21042,6 +21056,8 @@ declare const subcircuitGroupPropsWithBool: z.ZodObject<{
21042
21056
  outlineOffsetX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
21043
21057
  outlineOffsetY: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
21044
21058
  circuitJson: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
21059
+ exposedNets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
21060
+ exposeNets: z.ZodOptional<z.ZodBoolean>;
21045
21061
  minTraceWidth: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
21046
21062
  minViaHoleEdgeToViaHoleEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
21047
21063
  minViaEdgeToPadEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -21489,6 +21505,8 @@ declare const subcircuitGroupPropsWithBool: z.ZodObject<{
21489
21505
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
21490
21506
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
21491
21507
  circuitJson?: any[] | undefined;
21508
+ exposedNets?: string[] | undefined;
21509
+ exposeNets?: boolean | undefined;
21492
21510
  schAutoLayoutEnabled?: boolean | undefined;
21493
21511
  schTraceAutoLabelEnabled?: boolean | undefined;
21494
21512
  schMaxTraceDistance?: number | undefined;
@@ -21809,6 +21827,8 @@ declare const subcircuitGroupPropsWithBool: z.ZodObject<{
21809
21827
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
21810
21828
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
21811
21829
  circuitJson?: any[] | undefined;
21830
+ exposedNets?: string[] | undefined;
21831
+ exposeNets?: boolean | undefined;
21812
21832
  schAutoLayoutEnabled?: boolean | undefined;
21813
21833
  schTraceAutoLabelEnabled?: boolean | undefined;
21814
21834
  schMaxTraceDistance?: string | number | undefined;
@@ -23523,6 +23543,8 @@ declare const groupProps: z.ZodDiscriminatedUnion<"subcircuit", [z.ZodObject<{
23523
23543
  outlineOffsetX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
23524
23544
  outlineOffsetY: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
23525
23545
  circuitJson: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
23546
+ exposedNets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
23547
+ exposeNets: z.ZodOptional<z.ZodBoolean>;
23526
23548
  minTraceWidth: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
23527
23549
  minViaHoleEdgeToViaHoleEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
23528
23550
  minViaEdgeToPadEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -23970,6 +23992,8 @@ declare const groupProps: z.ZodDiscriminatedUnion<"subcircuit", [z.ZodObject<{
23970
23992
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
23971
23993
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
23972
23994
  circuitJson?: any[] | undefined;
23995
+ exposedNets?: string[] | undefined;
23996
+ exposeNets?: boolean | undefined;
23973
23997
  schAutoLayoutEnabled?: boolean | undefined;
23974
23998
  schTraceAutoLabelEnabled?: boolean | undefined;
23975
23999
  schMaxTraceDistance?: number | undefined;
@@ -24290,6 +24314,8 @@ declare const groupProps: z.ZodDiscriminatedUnion<"subcircuit", [z.ZodObject<{
24290
24314
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
24291
24315
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
24292
24316
  circuitJson?: any[] | undefined;
24317
+ exposedNets?: string[] | undefined;
24318
+ exposeNets?: boolean | undefined;
24293
24319
  schAutoLayoutEnabled?: boolean | undefined;
24294
24320
  schTraceAutoLabelEnabled?: boolean | undefined;
24295
24321
  schMaxTraceDistance?: string | number | undefined;
@@ -24955,6 +24981,8 @@ declare const boardProps: z.ZodObject<Omit<{
24955
24981
  outlineOffsetX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
24956
24982
  outlineOffsetY: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
24957
24983
  circuitJson: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
24984
+ exposedNets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
24985
+ exposeNets: z.ZodOptional<z.ZodBoolean>;
24958
24986
  minTraceWidth: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
24959
24987
  minViaHoleEdgeToViaHoleEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
24960
24988
  minViaEdgeToPadEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -25428,6 +25456,8 @@ declare const boardProps: z.ZodObject<Omit<{
25428
25456
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
25429
25457
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
25430
25458
  circuitJson?: any[] | undefined;
25459
+ exposedNets?: string[] | undefined;
25460
+ exposeNets?: boolean | undefined;
25431
25461
  schAutoLayoutEnabled?: boolean | undefined;
25432
25462
  schTraceAutoLabelEnabled?: boolean | undefined;
25433
25463
  schMaxTraceDistance?: number | undefined;
@@ -25763,6 +25793,8 @@ declare const boardProps: z.ZodObject<Omit<{
25763
25793
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
25764
25794
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
25765
25795
  circuitJson?: any[] | undefined;
25796
+ exposedNets?: string[] | undefined;
25797
+ exposeNets?: boolean | undefined;
25766
25798
  schAutoLayoutEnabled?: boolean | undefined;
25767
25799
  schTraceAutoLabelEnabled?: boolean | undefined;
25768
25800
  schMaxTraceDistance?: string | number | undefined;
@@ -28714,6 +28746,8 @@ declare const breakoutProps: z.ZodObject<{
28714
28746
  outlineOffsetX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
28715
28747
  outlineOffsetY: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
28716
28748
  circuitJson: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
28749
+ exposedNets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
28750
+ exposeNets: z.ZodOptional<z.ZodBoolean>;
28717
28751
  minTraceWidth: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
28718
28752
  minViaHoleEdgeToViaHoleEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
28719
28753
  minViaEdgeToPadEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -29164,6 +29198,8 @@ declare const breakoutProps: z.ZodObject<{
29164
29198
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
29165
29199
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
29166
29200
  circuitJson?: any[] | undefined;
29201
+ exposedNets?: string[] | undefined;
29202
+ exposeNets?: boolean | undefined;
29167
29203
  schAutoLayoutEnabled?: boolean | undefined;
29168
29204
  schTraceAutoLabelEnabled?: boolean | undefined;
29169
29205
  schMaxTraceDistance?: number | undefined;
@@ -29483,6 +29519,8 @@ declare const breakoutProps: z.ZodObject<{
29483
29519
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
29484
29520
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
29485
29521
  circuitJson?: any[] | undefined;
29522
+ exposedNets?: string[] | undefined;
29523
+ exposeNets?: boolean | undefined;
29486
29524
  schAutoLayoutEnabled?: boolean | undefined;
29487
29525
  schTraceAutoLabelEnabled?: boolean | undefined;
29488
29526
  schMaxTraceDistance?: string | number | undefined;
@@ -89281,6 +89319,8 @@ declare const stampboardProps: z.ZodObject<Omit<{
89281
89319
  outlineOffsetX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
89282
89320
  outlineOffsetY: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
89283
89321
  circuitJson: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
89322
+ exposedNets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
89323
+ exposeNets: z.ZodOptional<z.ZodBoolean>;
89284
89324
  minTraceWidth: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
89285
89325
  minViaHoleEdgeToViaHoleEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
89286
89326
  minViaEdgeToPadEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -89769,6 +89809,8 @@ declare const stampboardProps: z.ZodObject<Omit<{
89769
89809
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
89770
89810
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
89771
89811
  circuitJson?: any[] | undefined;
89812
+ exposedNets?: string[] | undefined;
89813
+ exposeNets?: boolean | undefined;
89772
89814
  schAutoLayoutEnabled?: boolean | undefined;
89773
89815
  schTraceAutoLabelEnabled?: boolean | undefined;
89774
89816
  schMaxTraceDistance?: number | undefined;
@@ -90114,6 +90156,8 @@ declare const stampboardProps: z.ZodObject<Omit<{
90114
90156
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
90115
90157
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
90116
90158
  circuitJson?: any[] | undefined;
90159
+ exposedNets?: string[] | undefined;
90160
+ exposeNets?: boolean | undefined;
90117
90161
  schAutoLayoutEnabled?: boolean | undefined;
90118
90162
  schTraceAutoLabelEnabled?: boolean | undefined;
90119
90163
  schMaxTraceDistance?: string | number | undefined;
@@ -109471,6 +109515,8 @@ declare const mountedboardProps: z.ZodObject<{
109471
109515
  outlineOffsetX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
109472
109516
  outlineOffsetY: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
109473
109517
  circuitJson: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
109518
+ exposedNets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
109519
+ exposeNets: z.ZodOptional<z.ZodBoolean>;
109474
109520
  minTraceWidth: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
109475
109521
  minViaHoleEdgeToViaHoleEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
109476
109522
  minViaEdgeToPadEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -110060,6 +110106,8 @@ declare const mountedboardProps: z.ZodObject<{
110060
110106
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
110061
110107
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
110062
110108
  circuitJson?: any[] | undefined;
110109
+ exposedNets?: string[] | undefined;
110110
+ exposeNets?: boolean | undefined;
110063
110111
  schAutoLayoutEnabled?: boolean | undefined;
110064
110112
  schTraceAutoLabelEnabled?: boolean | undefined;
110065
110113
  schMaxTraceDistance?: number | undefined;
@@ -110418,6 +110466,8 @@ declare const mountedboardProps: z.ZodObject<{
110418
110466
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
110419
110467
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
110420
110468
  circuitJson?: any[] | undefined;
110469
+ exposedNets?: string[] | undefined;
110470
+ exposeNets?: boolean | undefined;
110421
110471
  schAutoLayoutEnabled?: boolean | undefined;
110422
110472
  schTraceAutoLabelEnabled?: boolean | undefined;
110423
110473
  schMaxTraceDistance?: string | number | undefined;
@@ -121011,6 +121061,8 @@ declare const subcircuitProps: z.ZodObject<{
121011
121061
  outlineOffsetX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
121012
121062
  outlineOffsetY: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
121013
121063
  circuitJson: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
121064
+ exposedNets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
121065
+ exposeNets: z.ZodOptional<z.ZodBoolean>;
121014
121066
  minTraceWidth: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
121015
121067
  minViaHoleEdgeToViaHoleEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
121016
121068
  minViaEdgeToPadEdgeClearance: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
@@ -121455,6 +121507,8 @@ declare const subcircuitProps: z.ZodObject<{
121455
121507
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
121456
121508
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
121457
121509
  circuitJson?: any[] | undefined;
121510
+ exposedNets?: string[] | undefined;
121511
+ exposeNets?: boolean | undefined;
121458
121512
  schAutoLayoutEnabled?: boolean | undefined;
121459
121513
  schTraceAutoLabelEnabled?: boolean | undefined;
121460
121514
  schMaxTraceDistance?: number | undefined;
@@ -121774,6 +121828,8 @@ declare const subcircuitProps: z.ZodObject<{
121774
121828
  autorouterEffortLevel?: "2x" | "1x" | "5x" | "10x" | "100x" | undefined;
121775
121829
  autorouterVersion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "latest" | undefined;
121776
121830
  circuitJson?: any[] | undefined;
121831
+ exposedNets?: string[] | undefined;
121832
+ exposeNets?: boolean | undefined;
121777
121833
  schAutoLayoutEnabled?: boolean | undefined;
121778
121834
  schTraceAutoLabelEnabled?: boolean | undefined;
121779
121835
  schMaxTraceDistance?: string | number | undefined;
package/dist/index.js CHANGED
@@ -16446,7 +16446,9 @@ var subcircuitGroupProps = baseGroupProps.extend({
16446
16446
  outline: z37.array(point).optional(),
16447
16447
  outlineOffsetX: distance11.optional(),
16448
16448
  outlineOffsetY: distance11.optional(),
16449
- circuitJson: z37.array(z37.any()).optional()
16449
+ circuitJson: z37.array(z37.any()).optional(),
16450
+ exposedNets: z37.array(z37.string()).optional(),
16451
+ exposeNets: z37.boolean().optional()
16450
16452
  });
16451
16453
  var subcircuitGroupPropsWithBool = subcircuitGroupProps.extend({
16452
16454
  subcircuit: z37.literal(true)