@tscircuit/props 0.0.420 → 0.0.422

package/lib/common/distance.ts

@@ -1,5 +1,11 @@
+import { distance as baseDistance, length } from "circuit-json"
 import { z } from "zod"
 
 export type Distance = number | string
 
-export { distance, length } from "circuit-json"
+const calcString = z.string().regex(/^calc\(.*\)$/)
+
+export const distance = baseDistance
+export const pcbCoordinate = calcString.or(baseDistance)
+
+export { length }

package/lib/common/layout.ts

@@ -6,6 +6,7 @@ import {
   supplier_name,
 } from "circuit-json"
 import { expectTypesMatch } from "lib/typecheck"
+import { pcbCoordinate } from "./distance"
 import { z } from "zod"
 import { type CadModelProp, cadModelProp } from "./cadModel"
 import { type FootprintProp, footprintProp } from "./footprintProp"
@@ -25,6 +26,14 @@ export type PositionMode = PcbPositionMode
 export interface PcbLayoutProps {
   pcbX?: string | number
   pcbY?: string | number
+  /**
+   * Position the left, right, top, or bottom edge of the component. Setting any of these
+   * properties changes the anchor used for pcb positioning to the specified edge.
+   */
+  pcbLeftEdgeX?: string | number
+  pcbRightEdgeX?: string | number
+  pcbTopEdgeY?: string | number
+  pcbBottomEdgeY?: string | number
   pcbOffsetX?: string | number
   pcbOffsetY?: string | number
   pcbRotation?: string | number
@@ -51,6 +60,14 @@ export interface PcbLayoutProps {
 export interface CommonLayoutProps {
   pcbX?: string | number
   pcbY?: string | number
+  /**
+   * Position the left, right, top, or bottom edge of the component. Setting any of these
+   * properties changes the anchor used for pcb positioning to the specified edge.
+   */
+  pcbLeftEdgeX?: string | number
+  pcbRightEdgeX?: string | number
+  pcbTopEdgeY?: string | number
+  pcbBottomEdgeY?: string | number
   pcbOffsetX?: string | number
   pcbOffsetY?: string | number
   pcbRotation?: string | number
@@ -98,8 +115,12 @@ export interface CommonLayoutProps {
 }
 
 export const pcbLayoutProps = z.object({
-  pcbX: distance.optional(),
-  pcbY: distance.optional(),
+  pcbX: pcbCoordinate.optional(),
+  pcbY: pcbCoordinate.optional(),
+  pcbLeftEdgeX: pcbCoordinate.optional(),
+  pcbRightEdgeX: pcbCoordinate.optional(),
+  pcbTopEdgeY: pcbCoordinate.optional(),
+  pcbBottomEdgeY: pcbCoordinate.optional(),
   pcbOffsetX: distance.optional(),
   pcbOffsetY: distance.optional(),
   pcbRotation: rotation.optional(),
@@ -127,8 +148,12 @@ type InferredPcbLayoutProps = z.input<typeof pcbLayoutProps>
 expectTypesMatch<PcbLayoutProps, InferredPcbLayoutProps>(true)
 
 export const commonLayoutProps = z.object({
-  pcbX: distance.optional(),
-  pcbY: distance.optional(),
+  pcbX: pcbCoordinate.optional(),
+  pcbY: pcbCoordinate.optional(),
+  pcbLeftEdgeX: pcbCoordinate.optional(),
+  pcbRightEdgeX: pcbCoordinate.optional(),
+  pcbTopEdgeY: pcbCoordinate.optional(),
+  pcbBottomEdgeY: pcbCoordinate.optional(),
   pcbOffsetX: distance.optional(),
   pcbOffsetY: distance.optional(),
   pcbRotation: rotation.optional(),

package/lib/components/cadmodel.ts

@@ -1,4 +1,4 @@
-import { distance, type Distance } from "lib/common/distance"
+import { distance, pcbCoordinate, type Distance } from "lib/common/distance"
 import { expectTypesMatch } from "lib/typecheck"
 import { cadModelBase, type CadModelBase } from "../common/cadModel"
 import { z } from "zod"
@@ -8,14 +8,22 @@ export interface CadModelProps extends CadModelBase {
   stepUrl?: string
   pcbX?: Distance
   pcbY?: Distance
+  pcbLeftEdgeX?: Distance
+  pcbRightEdgeX?: Distance
+  pcbTopEdgeY?: Distance
+  pcbBottomEdgeY?: Distance
   pcbOffsetX?: Distance
   pcbOffsetY?: Distance
   pcbZ?: Distance
 }
 
 const pcbPosition = z.object({
-  pcbX: distance.optional(),
-  pcbY: distance.optional(),
+  pcbX: pcbCoordinate.optional(),
+  pcbY: pcbCoordinate.optional(),
+  pcbLeftEdgeX: pcbCoordinate.optional(),
+  pcbRightEdgeX: pcbCoordinate.optional(),
+  pcbTopEdgeY: pcbCoordinate.optional(),
+  pcbBottomEdgeY: pcbCoordinate.optional(),
   pcbOffsetX: distance.optional(),
   pcbOffsetY: distance.optional(),
   pcbZ: distance.optional(),

package/lib/components/courtyard-outline.ts

@@ -5,6 +5,10 @@ import { z } from "zod"
 
 export const courtyardOutlineProps = pcbLayoutProps
   .omit({
+    pcbLeftEdgeX: true,
+    pcbRightEdgeX: true,
+    pcbTopEdgeY: true,
+    pcbBottomEdgeY: true,
     pcbX: true,
     pcbY: true,
     pcbOffsetX: true,

package/lib/components/fabrication-note-dimension.ts

@@ -9,7 +9,15 @@ const dimensionTarget = z.union([z.string(), point])
 export interface FabricationNoteDimensionProps
   extends Omit<
     PcbLayoutProps,
-    "pcbX" | "pcbY" | "pcbOffsetX" | "pcbOffsetY" | "pcbRotation"
+    | "pcbLeftEdgeX"
+    | "pcbRightEdgeX"
+    | "pcbTopEdgeY"
+    | "pcbBottomEdgeY"
+    | "pcbX"
+    | "pcbY"
+    | "pcbOffsetX"
+    | "pcbOffsetY"
+    | "pcbRotation"
   > {
   from: string | Point
   to: string | Point
@@ -27,6 +35,10 @@ export interface FabricationNoteDimensionProps
 
 export const fabricationNoteDimensionProps = pcbLayoutProps
   .omit({
+    pcbLeftEdgeX: true,
+    pcbRightEdgeX: true,
+    pcbTopEdgeY: true,
+    pcbBottomEdgeY: true,
     pcbX: true,
     pcbY: true,
     pcbOffsetX: true,

package/lib/components/fabrication-note-path.ts

@@ -4,6 +4,10 @@ import { z } from "zod"
 
 export const fabricationNotePathProps = pcbLayoutProps
   .omit({
+    pcbLeftEdgeX: true,
+    pcbRightEdgeX: true,
+    pcbTopEdgeY: true,
+    pcbBottomEdgeY: true,
     pcbX: true,
     pcbY: true,
     pcbOffsetX: true,

package/lib/components/pcb-note-dimension.ts

@@ -9,7 +9,15 @@ const dimensionTarget = z.union([z.string(), point])
 export interface PcbNoteDimensionProps
   extends Omit<
     PcbLayoutProps,
-    "pcbX" | "pcbY" | "pcbOffsetX" | "pcbOffsetY" | "pcbRotation"
+    | "pcbLeftEdgeX"
+    | "pcbRightEdgeX"
+    | "pcbTopEdgeY"
+    | "pcbBottomEdgeY"
+    | "pcbX"
+    | "pcbY"
+    | "pcbOffsetX"
+    | "pcbOffsetY"
+    | "pcbRotation"
   > {
   from: string | Point
   to: string | Point
@@ -27,6 +35,10 @@ export interface PcbNoteDimensionProps
 
 export const pcbNoteDimensionProps = pcbLayoutProps
   .omit({
+    pcbLeftEdgeX: true,
+    pcbRightEdgeX: true,
+    pcbTopEdgeY: true,
+    pcbBottomEdgeY: true,
     pcbX: true,
     pcbY: true,
     pcbOffsetX: true,

package/lib/components/pcb-note-line.ts

@@ -6,7 +6,15 @@ import { z } from "zod"
 export interface PcbNoteLineProps
   extends Omit<
     PcbLayoutProps,
-    "pcbX" | "pcbY" | "pcbOffsetX" | "pcbOffsetY" | "pcbRotation"
+    | "pcbLeftEdgeX"
+    | "pcbRightEdgeX"
+    | "pcbTopEdgeY"
+    | "pcbBottomEdgeY"
+    | "pcbX"
+    | "pcbY"
+    | "pcbOffsetX"
+    | "pcbOffsetY"
+    | "pcbRotation"
   > {
   x1: string | number
   y1: string | number
@@ -19,6 +27,10 @@ export interface PcbNoteLineProps
 
 export const pcbNoteLineProps = pcbLayoutProps
   .omit({
+    pcbLeftEdgeX: true,
+    pcbRightEdgeX: true,
+    pcbTopEdgeY: true,
+    pcbBottomEdgeY: true,
     pcbX: true,
     pcbY: true,
     pcbOffsetX: true,

package/lib/components/pcb-note-path.ts

@@ -10,7 +10,15 @@ import { z } from "zod"
 export interface PcbNotePathProps
   extends Omit<
     PcbLayoutProps,
-    "pcbX" | "pcbY" | "pcbOffsetX" | "pcbOffsetY" | "pcbRotation"
+    | "pcbLeftEdgeX"
+    | "pcbRightEdgeX"
+    | "pcbTopEdgeY"
+    | "pcbBottomEdgeY"
+    | "pcbX"
+    | "pcbY"
+    | "pcbOffsetX"
+    | "pcbOffsetY"
+    | "pcbRotation"
   > {
   route: RouteHintPointInput[]
   strokeWidth?: string | number
@@ -19,6 +27,10 @@ export interface PcbNotePathProps
 
 export const pcbNotePathProps = pcbLayoutProps
   .omit({
+    pcbLeftEdgeX: true,
+    pcbRightEdgeX: true,
+    pcbTopEdgeY: true,
+    pcbBottomEdgeY: true,
     pcbX: true,
     pcbY: true,
     pcbOffsetX: true,

package/lib/components/silkscreen-path.ts

@@ -4,6 +4,10 @@ import { z } from "zod"
 
 export const silkscreenPathProps = pcbLayoutProps
   .omit({
+    pcbLeftEdgeX: true,
+    pcbRightEdgeX: true,
+    pcbTopEdgeY: true,
+    pcbBottomEdgeY: true,
     pcbX: true,
     pcbY: true,
     pcbOffsetX: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/props",
-  "version": "0.0.420",
+  "version": "0.0.422",
   "description": "Props for tscircuit builtin component types",
   "main": "dist/index.js",
   "type": "module",