@tscircuit/props 0.0.555 → 0.0.557

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/dist/index.js CHANGED
@@ -439,6 +439,9 @@ var commonComponentProps = commonLayoutProps.merge(supplierProps).extend({
439
439
  schSectionName: z16.string().optional().describe(
440
440
  'This component will be drawn as part of this section e.g. "Power"'
441
441
  ),
442
+ schSheetName: z16.string().optional().describe(
443
+ 'This component will be drawn as part of this sheet e.g. "Main"'
444
+ ),
442
445
  datasheetUrl: url.optional(),
443
446
  cadModel: cadModelProp.optional(),
444
447
  kicadFootprintMetadata: kicadFootprintMetadata.optional(),
@@ -16443,7 +16446,8 @@ var subcircuitGroupProps = baseGroupProps.extend({
16443
16446
  outline: z37.array(point).optional(),
16444
16447
  outlineOffsetX: distance11.optional(),
16445
16448
  outlineOffsetY: distance11.optional(),
16446
- circuitJson: z37.array(z37.any()).optional()
16449
+ circuitJson: z37.array(z37.any()).optional(),
16450
+ exposedNets: z37.array(z37.string()).optional()
16447
16451
  });
16448
16452
  var subcircuitGroupPropsWithBool = subcircuitGroupProps.extend({
16449
16453
  subcircuit: z37.literal(true)
@@ -18202,42 +18206,51 @@ expectTypesMatch(
18202
18206
  true
18203
18207
  );
18204
18208
 
18209
+ // lib/components/schematic-sheet.ts
18210
+ import { z as z117 } from "zod";
18211
+ var schematicSheetProps = z117.object({
18212
+ name: z117.string(),
18213
+ displayName: z117.string(),
18214
+ children: z117.any().optional()
18215
+ });
18216
+ expectTypesMatch(true);
18217
+
18205
18218
  // lib/components/copper-text.ts
18206
18219
  import { layer_ref as layer_ref10, length as length8 } from "circuit-json";
18207
- import { z as z117 } from "zod";
18220
+ import { z as z118 } from "zod";
18208
18221
  var copperTextProps = pcbLayoutProps.extend({
18209
- text: z117.string(),
18222
+ text: z118.string(),
18210
18223
  anchorAlignment: ninePointAnchor.default("center"),
18211
- font: z117.enum(["tscircuit2024"]).optional(),
18224
+ font: z118.enum(["tscircuit2024"]).optional(),
18212
18225
  fontSize: length8.optional(),
18213
- layers: z117.array(layer_ref10).optional(),
18214
- knockout: z117.boolean().optional(),
18215
- mirrored: z117.boolean().optional()
18226
+ layers: z118.array(layer_ref10).optional(),
18227
+ knockout: z118.boolean().optional(),
18228
+ mirrored: z118.boolean().optional()
18216
18229
  });
18217
18230
 
18218
18231
  // lib/components/silkscreen-text.ts
18219
18232
  import { layer_ref as layer_ref11, length as length9 } from "circuit-json";
18220
- import { z as z118 } from "zod";
18233
+ import { z as z119 } from "zod";
18221
18234
  var silkscreenTextProps = pcbLayoutProps.extend({
18222
- text: z118.string(),
18235
+ text: z119.string(),
18223
18236
  anchorAlignment: ninePointAnchor.default("center"),
18224
- font: z118.enum(["tscircuit2024"]).optional(),
18237
+ font: z119.enum(["tscircuit2024"]).optional(),
18225
18238
  fontSize: length9.optional(),
18226
18239
  /**
18227
18240
  * If true, text will knock out underlying silkscreen
18228
18241
  */
18229
- isKnockout: z118.boolean().optional(),
18242
+ isKnockout: z119.boolean().optional(),
18230
18243
  knockoutPadding: length9.optional(),
18231
18244
  knockoutPaddingLeft: length9.optional(),
18232
18245
  knockoutPaddingRight: length9.optional(),
18233
18246
  knockoutPaddingTop: length9.optional(),
18234
18247
  knockoutPaddingBottom: length9.optional(),
18235
- layers: z118.array(layer_ref11).optional()
18248
+ layers: z119.array(layer_ref11).optional()
18236
18249
  });
18237
18250
 
18238
18251
  // lib/components/silkscreen-path.ts
18239
18252
  import { length as length10, route_hint_point as route_hint_point5 } from "circuit-json";
18240
- import { z as z119 } from "zod";
18253
+ import { z as z120 } from "zod";
18241
18254
  var silkscreenPathProps = pcbLayoutProps.omit({
18242
18255
  pcbLeftEdgeX: true,
18243
18256
  pcbRightEdgeX: true,
@@ -18249,7 +18262,7 @@ var silkscreenPathProps = pcbLayoutProps.omit({
18249
18262
  pcbOffsetY: true,
18250
18263
  pcbRotation: true
18251
18264
  }).extend({
18252
- route: z119.array(route_hint_point5),
18265
+ route: z120.array(route_hint_point5),
18253
18266
  strokeWidth: length10.optional()
18254
18267
  });
18255
18268
 
@@ -18271,10 +18284,10 @@ var silkscreenLineProps = pcbLayoutProps.omit({
18271
18284
 
18272
18285
  // lib/components/silkscreen-rect.ts
18273
18286
  import { distance as distance41 } from "circuit-json";
18274
- import { z as z120 } from "zod";
18287
+ import { z as z121 } from "zod";
18275
18288
  var silkscreenRectProps = pcbLayoutProps.omit({ pcbRotation: true }).extend({
18276
- filled: z120.boolean().default(true).optional(),
18277
- stroke: z120.enum(["dashed", "solid", "none"]).optional(),
18289
+ filled: z121.boolean().default(true).optional(),
18290
+ stroke: z121.enum(["dashed", "solid", "none"]).optional(),
18278
18291
  strokeWidth: distance41.optional(),
18279
18292
  width: distance41,
18280
18293
  height: distance41,
@@ -18283,10 +18296,10 @@ var silkscreenRectProps = pcbLayoutProps.omit({ pcbRotation: true }).extend({
18283
18296
 
18284
18297
  // lib/components/silkscreen-circle.ts
18285
18298
  import { distance as distance42 } from "circuit-json";
18286
- import { z as z121 } from "zod";
18299
+ import { z as z122 } from "zod";
18287
18300
  var silkscreenCircleProps = pcbLayoutProps.omit({ pcbRotation: true }).extend({
18288
- isFilled: z121.boolean().optional(),
18289
- isOutline: z121.boolean().optional(),
18301
+ isFilled: z122.boolean().optional(),
18302
+ isOutline: z122.boolean().optional(),
18290
18303
  strokeWidth: distance42.optional(),
18291
18304
  radius: distance42
18292
18305
  });
@@ -18304,63 +18317,63 @@ expectTypesMatch(true);
18304
18317
 
18305
18318
  // lib/components/trace-hint.ts
18306
18319
  import { distance as distance43, layer_ref as layer_ref12, route_hint_point as route_hint_point6 } from "circuit-json";
18307
- import { z as z123 } from "zod";
18308
- var routeHintPointProps = z123.object({
18320
+ import { z as z124 } from "zod";
18321
+ var routeHintPointProps = z124.object({
18309
18322
  x: distance43,
18310
18323
  y: distance43,
18311
- via: z123.boolean().optional(),
18324
+ via: z124.boolean().optional(),
18312
18325
  toLayer: layer_ref12.optional()
18313
18326
  });
18314
- var traceHintProps = z123.object({
18315
- for: z123.string().optional().describe(
18327
+ var traceHintProps = z124.object({
18328
+ for: z124.string().optional().describe(
18316
18329
  "Selector for the port you're targeting, not required if you're inside a trace"
18317
18330
  ),
18318
- order: z123.number().optional(),
18331
+ order: z124.number().optional(),
18319
18332
  offset: route_hint_point6.or(routeHintPointProps).optional(),
18320
- offsets: z123.array(route_hint_point6).or(z123.array(routeHintPointProps)).optional(),
18321
- traceWidth: z123.number().optional()
18333
+ offsets: z124.array(route_hint_point6).or(z124.array(routeHintPointProps)).optional(),
18334
+ traceWidth: z124.number().optional()
18322
18335
  });
18323
18336
 
18324
18337
  // lib/components/port.ts
18325
- import { z as z124 } from "zod";
18338
+ import { z as z125 } from "zod";
18326
18339
  var portProps = commonLayoutProps.extend({
18327
- name: z124.string().optional(),
18328
- pinNumber: z124.number().optional(),
18329
- schStemLength: z124.number().optional(),
18330
- aliases: z124.array(z124.string()).optional(),
18331
- layer: z124.string().optional(),
18332
- layers: z124.array(z124.string()).optional(),
18333
- schX: z124.number().optional(),
18334
- schY: z124.number().optional(),
18340
+ name: z125.string().optional(),
18341
+ pinNumber: z125.number().optional(),
18342
+ schStemLength: z125.number().optional(),
18343
+ aliases: z125.array(z125.string()).optional(),
18344
+ layer: z125.string().optional(),
18345
+ layers: z125.array(z125.string()).optional(),
18346
+ schX: z125.number().optional(),
18347
+ schY: z125.number().optional(),
18335
18348
  direction: direction.optional(),
18336
- connectsTo: z124.string().or(z124.array(z124.string())).optional(),
18349
+ connectsTo: z125.string().or(z125.array(z125.string())).optional(),
18337
18350
  kicadPinMetadata: kicadPinMetadata.optional(),
18338
- hasInversionCircle: z124.boolean().optional()
18351
+ hasInversionCircle: z125.boolean().optional()
18339
18352
  });
18340
18353
 
18341
18354
  // lib/components/pcb-note-text.ts
18342
18355
  import { length as length11 } from "circuit-json";
18343
- import { z as z125 } from "zod";
18356
+ import { z as z126 } from "zod";
18344
18357
  var pcbNoteTextProps = pcbLayoutProps.extend({
18345
- text: z125.string(),
18346
- anchorAlignment: z125.enum(["center", "top_left", "top_right", "bottom_left", "bottom_right"]).default("center"),
18347
- font: z125.enum(["tscircuit2024"]).optional(),
18358
+ text: z126.string(),
18359
+ anchorAlignment: z126.enum(["center", "top_left", "top_right", "bottom_left", "bottom_right"]).default("center"),
18360
+ font: z126.enum(["tscircuit2024"]).optional(),
18348
18361
  fontSize: length11.optional(),
18349
- color: z125.string().optional()
18362
+ color: z126.string().optional()
18350
18363
  });
18351
18364
  expectTypesMatch(true);
18352
18365
 
18353
18366
  // lib/components/pcb-note-rect.ts
18354
18367
  import { distance as distance44 } from "circuit-json";
18355
- import { z as z126 } from "zod";
18368
+ import { z as z127 } from "zod";
18356
18369
  var pcbNoteRectProps = pcbLayoutProps.omit({ pcbRotation: true }).extend({
18357
18370
  width: distance44,
18358
18371
  height: distance44,
18359
18372
  strokeWidth: distance44.optional(),
18360
- isFilled: z126.boolean().optional(),
18361
- hasStroke: z126.boolean().optional(),
18362
- isStrokeDashed: z126.boolean().optional(),
18363
- color: z126.string().optional(),
18373
+ isFilled: z127.boolean().optional(),
18374
+ hasStroke: z127.boolean().optional(),
18375
+ isStrokeDashed: z127.boolean().optional(),
18376
+ color: z127.string().optional(),
18364
18377
  cornerRadius: distance44.optional()
18365
18378
  });
18366
18379
  expectTypesMatch(true);
@@ -18370,7 +18383,7 @@ import {
18370
18383
  length as length12,
18371
18384
  route_hint_point as route_hint_point7
18372
18385
  } from "circuit-json";
18373
- import { z as z127 } from "zod";
18386
+ import { z as z128 } from "zod";
18374
18387
  var pcbNotePathProps = pcbLayoutProps.omit({
18375
18388
  pcbLeftEdgeX: true,
18376
18389
  pcbRightEdgeX: true,
@@ -18382,15 +18395,15 @@ var pcbNotePathProps = pcbLayoutProps.omit({
18382
18395
  pcbOffsetY: true,
18383
18396
  pcbRotation: true
18384
18397
  }).extend({
18385
- route: z127.array(route_hint_point7),
18398
+ route: z128.array(route_hint_point7),
18386
18399
  strokeWidth: length12.optional(),
18387
- color: z127.string().optional()
18400
+ color: z128.string().optional()
18388
18401
  });
18389
18402
  expectTypesMatch(true);
18390
18403
 
18391
18404
  // lib/components/pcb-note-line.ts
18392
18405
  import { distance as distance45 } from "circuit-json";
18393
- import { z as z128 } from "zod";
18406
+ import { z as z129 } from "zod";
18394
18407
  var pcbNoteLineProps = pcbLayoutProps.omit({
18395
18408
  pcbLeftEdgeX: true,
18396
18409
  pcbRightEdgeX: true,
@@ -18407,15 +18420,15 @@ var pcbNoteLineProps = pcbLayoutProps.omit({
18407
18420
  x2: distance45,
18408
18421
  y2: distance45,
18409
18422
  strokeWidth: distance45.optional(),
18410
- color: z128.string().optional(),
18411
- isDashed: z128.boolean().optional()
18423
+ color: z129.string().optional(),
18424
+ isDashed: z129.boolean().optional()
18412
18425
  });
18413
18426
  expectTypesMatch(true);
18414
18427
 
18415
18428
  // lib/components/pcb-note-dimension.ts
18416
18429
  import { distance as distance46, length as length13 } from "circuit-json";
18417
- import { z as z129 } from "zod";
18418
- var dimensionTarget2 = z129.union([z129.string(), point]);
18430
+ import { z as z130 } from "zod";
18431
+ var dimensionTarget2 = z130.union([z130.string(), point]);
18419
18432
  var pcbNoteDimensionProps = pcbLayoutProps.omit({
18420
18433
  pcbLeftEdgeX: true,
18421
18434
  pcbRightEdgeX: true,
@@ -18429,101 +18442,101 @@ var pcbNoteDimensionProps = pcbLayoutProps.omit({
18429
18442
  }).extend({
18430
18443
  from: dimensionTarget2,
18431
18444
  to: dimensionTarget2,
18432
- text: z129.string().optional(),
18445
+ text: z130.string().optional(),
18433
18446
  offset: distance46.optional(),
18434
- font: z129.enum(["tscircuit2024"]).optional(),
18447
+ font: z130.enum(["tscircuit2024"]).optional(),
18435
18448
  fontSize: length13.optional(),
18436
- color: z129.string().optional(),
18449
+ color: z130.string().optional(),
18437
18450
  arrowSize: distance46.optional(),
18438
- units: z129.enum(["in", "mm"]).optional(),
18439
- outerEdgeToEdge: z129.literal(true).optional(),
18440
- centerToCenter: z129.literal(true).optional(),
18441
- innerEdgeToEdge: z129.literal(true).optional()
18451
+ units: z130.enum(["in", "mm"]).optional(),
18452
+ outerEdgeToEdge: z130.literal(true).optional(),
18453
+ centerToCenter: z130.literal(true).optional(),
18454
+ innerEdgeToEdge: z130.literal(true).optional()
18442
18455
  });
18443
18456
  expectTypesMatch(
18444
18457
  true
18445
18458
  );
18446
18459
 
18447
18460
  // lib/platformConfig.ts
18448
- import { z as z130 } from "zod";
18449
- var unvalidatedCircuitJson = z130.array(z130.any()).describe("Circuit JSON");
18450
- var footprintLibraryResult = z130.object({
18451
- footprintCircuitJson: z130.array(z130.any()),
18461
+ import { z as z131 } from "zod";
18462
+ var unvalidatedCircuitJson = z131.array(z131.any()).describe("Circuit JSON");
18463
+ var footprintLibraryResult = z131.object({
18464
+ footprintCircuitJson: z131.array(z131.any()),
18452
18465
  cadModel: cadModelProp.optional()
18453
18466
  });
18454
- var pathToCircuitJsonFn = z130.function().args(z130.string()).returns(z130.promise(footprintLibraryResult)).or(
18455
- z130.function().args(
18456
- z130.string(),
18457
- z130.object({ resolvedPcbStyle: pcbStyle.optional() }).optional()
18458
- ).returns(z130.promise(footprintLibraryResult))
18467
+ var pathToCircuitJsonFn = z131.function().args(z131.string()).returns(z131.promise(footprintLibraryResult)).or(
18468
+ z131.function().args(
18469
+ z131.string(),
18470
+ z131.object({ resolvedPcbStyle: pcbStyle.optional() }).optional()
18471
+ ).returns(z131.promise(footprintLibraryResult))
18459
18472
  ).describe("A function that takes a path and returns Circuit JSON");
18460
- var footprintFileParserEntry = z130.object({
18461
- loadFromUrl: z130.function().args(z130.string()).returns(z130.promise(footprintLibraryResult)).describe(
18473
+ var footprintFileParserEntry = z131.object({
18474
+ loadFromUrl: z131.function().args(z131.string()).returns(z131.promise(footprintLibraryResult)).describe(
18462
18475
  "A function that takes a footprint file URL and returns Circuit JSON"
18463
18476
  )
18464
18477
  });
18465
- var spiceEngineSimulationResult = z130.object({
18466
- engineVersionString: z130.string().optional(),
18478
+ var spiceEngineSimulationResult = z131.object({
18479
+ engineVersionString: z131.string().optional(),
18467
18480
  simulationResultCircuitJson: unvalidatedCircuitJson
18468
18481
  });
18469
- var spiceEngineZod = z130.object({
18470
- simulate: z130.function().args(z130.string()).returns(z130.promise(spiceEngineSimulationResult)).describe(
18482
+ var spiceEngineZod = z131.object({
18483
+ simulate: z131.function().args(z131.string()).returns(z131.promise(spiceEngineSimulationResult)).describe(
18471
18484
  "A function that takes a SPICE string and returns a simulation result"
18472
18485
  )
18473
18486
  });
18474
- var defaultSpiceEngine = z130.custom(
18487
+ var defaultSpiceEngine = z131.custom(
18475
18488
  (value) => typeof value === "string"
18476
18489
  );
18477
- var autorouterInstance = z130.object({
18478
- run: z130.function().args().returns(z130.promise(z130.unknown())).describe("Run the autorouter"),
18479
- getOutputSimpleRouteJson: z130.function().args().returns(z130.promise(z130.any())).describe("Get the resulting SimpleRouteJson")
18490
+ var autorouterInstance = z131.object({
18491
+ run: z131.function().args().returns(z131.promise(z131.unknown())).describe("Run the autorouter"),
18492
+ getOutputSimpleRouteJson: z131.function().args().returns(z131.promise(z131.any())).describe("Get the resulting SimpleRouteJson")
18480
18493
  });
18481
- var autorouterDefinition = z130.object({
18482
- createAutorouter: z130.function().args(z130.any(), z130.any().optional()).returns(z130.union([autorouterInstance, z130.promise(autorouterInstance)])).describe("Create an autorouter instance")
18494
+ var autorouterDefinition = z131.object({
18495
+ createAutorouter: z131.function().args(z131.any(), z131.any().optional()).returns(z131.union([autorouterInstance, z131.promise(autorouterInstance)])).describe("Create an autorouter instance")
18483
18496
  });
18484
- var platformFetch = z130.custom((value) => typeof value === "function").describe("A fetch-like function to use for platform requests");
18485
- var platformConfig = z130.object({
18497
+ var platformFetch = z131.custom((value) => typeof value === "function").describe("A fetch-like function to use for platform requests");
18498
+ var platformConfig = z131.object({
18486
18499
  partsEngine: partsEngine.optional(),
18487
18500
  autorouter: autorouterProp.optional(),
18488
- autorouterMap: z130.record(z130.string(), autorouterDefinition).optional(),
18501
+ autorouterMap: z131.record(z131.string(), autorouterDefinition).optional(),
18489
18502
  registryApiUrl: url.optional(),
18490
18503
  cloudAutorouterUrl: url.optional(),
18491
- projectName: z130.string().optional(),
18504
+ projectName: z131.string().optional(),
18492
18505
  projectBaseUrl: url.optional(),
18493
- version: z130.string().optional(),
18506
+ version: z131.string().optional(),
18494
18507
  url: url.optional(),
18495
- printBoardInformationToSilkscreen: z130.boolean().optional(),
18496
- includeBoardFiles: z130.array(z130.string()).describe(
18508
+ printBoardInformationToSilkscreen: z131.boolean().optional(),
18509
+ includeBoardFiles: z131.array(z131.string()).describe(
18497
18510
  'The board files to automatically build with "tsci build", defaults to ["**/*.circuit.tsx"]. Can be an array of files or globs'
18498
18511
  ).optional(),
18499
- snapshotsDir: z130.string().describe(
18512
+ snapshotsDir: z131.string().describe(
18500
18513
  'The directory where snapshots are stored for "tsci snapshot", defaults to "tests/__snapshots__"'
18501
18514
  ).optional(),
18502
18515
  defaultSpiceEngine: defaultSpiceEngine.optional(),
18503
- unitPreference: z130.enum(["mm", "in", "mil"]).optional(),
18504
- localCacheEngine: z130.any().optional(),
18505
- pcbDisabled: z130.boolean().optional(),
18506
- routingDisabled: z130.boolean().optional(),
18507
- schematicDisabled: z130.boolean().optional(),
18508
- partsEngineDisabled: z130.boolean().optional(),
18509
- drcChecksDisabled: z130.boolean().optional(),
18510
- netlistDrcChecksDisabled: z130.boolean().optional(),
18511
- routingDrcChecksDisabled: z130.boolean().optional(),
18512
- placementDrcChecksDisabled: z130.boolean().optional(),
18513
- pinSpecificationDrcChecksDisabled: z130.boolean().optional(),
18514
- spiceEngineMap: z130.record(z130.string(), spiceEngineZod).optional(),
18515
- footprintLibraryMap: z130.record(
18516
- z130.string(),
18517
- z130.union([
18516
+ unitPreference: z131.enum(["mm", "in", "mil"]).optional(),
18517
+ localCacheEngine: z131.any().optional(),
18518
+ pcbDisabled: z131.boolean().optional(),
18519
+ routingDisabled: z131.boolean().optional(),
18520
+ schematicDisabled: z131.boolean().optional(),
18521
+ partsEngineDisabled: z131.boolean().optional(),
18522
+ drcChecksDisabled: z131.boolean().optional(),
18523
+ netlistDrcChecksDisabled: z131.boolean().optional(),
18524
+ routingDrcChecksDisabled: z131.boolean().optional(),
18525
+ placementDrcChecksDisabled: z131.boolean().optional(),
18526
+ pinSpecificationDrcChecksDisabled: z131.boolean().optional(),
18527
+ spiceEngineMap: z131.record(z131.string(), spiceEngineZod).optional(),
18528
+ footprintLibraryMap: z131.record(
18529
+ z131.string(),
18530
+ z131.union([
18518
18531
  pathToCircuitJsonFn,
18519
- z130.record(
18520
- z130.string(),
18521
- z130.union([unvalidatedCircuitJson, pathToCircuitJsonFn])
18532
+ z131.record(
18533
+ z131.string(),
18534
+ z131.union([unvalidatedCircuitJson, pathToCircuitJsonFn])
18522
18535
  )
18523
18536
  ])
18524
18537
  ).optional(),
18525
- footprintFileParserMap: z130.record(z130.string(), footprintFileParserEntry).optional(),
18526
- resolveProjectStaticFileImportUrl: z130.function().args(z130.string()).returns(z130.promise(z130.string())).describe(
18538
+ footprintFileParserMap: z131.record(z131.string(), footprintFileParserEntry).optional(),
18539
+ resolveProjectStaticFileImportUrl: z131.function().args(z131.string()).returns(z131.promise(z131.string())).describe(
18527
18540
  "A function that returns a string URL for static files for the project"
18528
18541
  ).optional(),
18529
18542
  platformFetch: platformFetch.optional()
@@ -18735,6 +18748,7 @@ export {
18735
18748
  schematicRectProps,
18736
18749
  schematicRowProps,
18737
18750
  schematicSectionProps,
18751
+ schematicSheetProps,
18738
18752
  schematicSymbolSize,
18739
18753
  schematicTableProps,
18740
18754
  schematicTextProps,