@tscircuit/props 0.0.651 → 0.0.653
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 +10 -0
- package/dist/index.d.ts +247 -3
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/lib/components/autoroutingphase.ts +12 -0
- package/lib/components/group.ts +6 -6
- package/lib/platformConfig.ts +3 -0
- package/package.json +1 -1
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import { expectTypesMatch } from "lib/typecheck"
|
|
2
2
|
import { z } from "zod"
|
|
3
3
|
import { type FanoutProps, fanoutProps } from "../common/fanoutProps"
|
|
4
|
+
import {
|
|
5
|
+
type FanoutTracePath,
|
|
6
|
+
fanoutTracePath,
|
|
7
|
+
} from "../common/fanoutTracePath"
|
|
4
8
|
import {
|
|
5
9
|
type AutorouterProp,
|
|
6
10
|
type RoutingTolerances,
|
|
@@ -21,6 +25,13 @@ export interface AutoroutingPhaseProps extends RoutingTolerances, FanoutProps {
|
|
|
21
25
|
name?: string
|
|
22
26
|
autorouter?: AutorouterProp
|
|
23
27
|
phaseIndex?: number
|
|
28
|
+
/**
|
|
29
|
+
* Saved PCB wire/via routes using the same format as fanout pcbTracePaths.
|
|
30
|
+
* Numeric distances are mm; unit strings are normalized to mm. Omitted by
|
|
31
|
+
* default; an empty array is accepted. No aliases or prop conflicts are
|
|
32
|
+
* introduced, and existing phases require no migration.
|
|
33
|
+
*/
|
|
34
|
+
pcbTracePaths?: FanoutTracePath[]
|
|
24
35
|
region?: {
|
|
25
36
|
shape?: "rect"
|
|
26
37
|
minX: number
|
|
@@ -41,6 +52,7 @@ export const autoroutingPhaseProps = z
|
|
|
41
52
|
name: z.string().optional(),
|
|
42
53
|
autorouter: autorouterProp.optional(),
|
|
43
54
|
phaseIndex: z.number().optional(),
|
|
55
|
+
pcbTracePaths: z.array(fanoutTracePath).optional(),
|
|
44
56
|
...routingTolerances.shape,
|
|
45
57
|
region: z
|
|
46
58
|
.object({
|
package/lib/components/group.ts
CHANGED
|
@@ -338,15 +338,15 @@ export interface AutorouterConfig {
|
|
|
338
338
|
availableJumperTypes?: Array<"1206x4" | "0603">
|
|
339
339
|
allowViaInPad?: boolean
|
|
340
340
|
groupMode?:
|
|
341
|
-
| "sequential_trace"
|
|
341
|
+
| /** @deprecated Disabled by default in core. Use the default autorouter with <autoroutingphase /> or <fanout /> as needed. Legacy support requires platformConfig.allowLegacyAutorouters: true. */ "sequential_trace"
|
|
342
342
|
| "subcircuit"
|
|
343
|
-
| /** @deprecated Use
|
|
343
|
+
| /** @deprecated Disabled by default in core. Use the default autorouter with <autoroutingphase /> or <fanout /> as needed. Legacy support requires platformConfig.allowLegacyAutorouters: true. */ "sequential-trace"
|
|
344
344
|
local?: boolean
|
|
345
345
|
algorithmFn?: (simpleRouteJson: any) => Promise<any>
|
|
346
346
|
/** Override the solver used to place implicit breakout points. */
|
|
347
347
|
implicitBreakoutPointSolverFn?: ImplicitBreakoutPointSolverFn
|
|
348
348
|
preset?:
|
|
349
|
-
| "sequential_trace"
|
|
349
|
+
| /** @deprecated Disabled by default in core. Use the default autorouter with <autoroutingphase /> or <fanout /> as needed. Legacy support requires platformConfig.allowLegacyAutorouters: true. */ "sequential_trace"
|
|
350
350
|
| "subcircuit"
|
|
351
351
|
| "default"
|
|
352
352
|
| "auto"
|
|
@@ -361,13 +361,13 @@ export interface AutorouterConfig {
|
|
|
361
361
|
| "single_layer_fanout"
|
|
362
362
|
| "fanout"
|
|
363
363
|
| /** @deprecated Use "auto_jumper" */ "auto-jumper"
|
|
364
|
-
| /** @deprecated Use
|
|
364
|
+
| /** @deprecated Disabled by default in core. Use the default autorouter with <autoroutingphase /> or <fanout /> as needed. Legacy support requires platformConfig.allowLegacyAutorouters: true. */ "sequential-trace"
|
|
365
365
|
| /** @deprecated Use "auto_local" */ "auto-local"
|
|
366
366
|
| /** @deprecated Use "auto_cloud" */ "auto-cloud"
|
|
367
367
|
}
|
|
368
368
|
|
|
369
369
|
export type AutorouterPreset =
|
|
370
|
-
| "sequential_trace"
|
|
370
|
+
| /** @deprecated Disabled by default in core. Use the default autorouter with <autoroutingphase /> or <fanout /> as needed. Legacy support requires platformConfig.allowLegacyAutorouters: true. */ "sequential_trace"
|
|
371
371
|
| "subcircuit"
|
|
372
372
|
| "default"
|
|
373
373
|
| "auto"
|
|
@@ -382,7 +382,7 @@ export type AutorouterPreset =
|
|
|
382
382
|
| "single_layer_fanout"
|
|
383
383
|
| "fanout"
|
|
384
384
|
| "auto-jumper"
|
|
385
|
-
| "sequential-trace"
|
|
385
|
+
| /** @deprecated Disabled by default in core. Use the default autorouter with <autoroutingphase /> or <fanout /> as needed. Legacy support requires platformConfig.allowLegacyAutorouters: true. */ "sequential-trace"
|
|
386
386
|
| "auto-local"
|
|
387
387
|
| "auto-cloud"
|
|
388
388
|
|
package/lib/platformConfig.ts
CHANGED
|
@@ -79,7 +79,10 @@ export interface PlatformConfig {
|
|
|
79
79
|
/**
|
|
80
80
|
* Allows the deprecated sequential_trace and auto_cloud autorouter presets.
|
|
81
81
|
* Defaults to false because these presets are otherwise disabled.
|
|
82
|
+
* This also applies to the sequential-trace and auto-cloud aliases.
|
|
82
83
|
* Platforms should only enable this temporarily while migrating projects.
|
|
84
|
+
* For sequential_trace / sequential-trace, use the default autorouter with
|
|
85
|
+
* <autoroutingphase /> or <fanout /> elements as needed instead.
|
|
83
86
|
*/
|
|
84
87
|
allowLegacyAutorouters?: boolean
|
|
85
88
|
|