@tscircuit/core 0.0.33 → 0.0.34

package/dist/index.d.ts

@@ -3438,80 +3438,76 @@ declare class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
     doInitialPcbPrimitiveRender(): void;
 }
 
+declare const edgeSpecifiers: readonly ["leftedge", "rightedge", "topedge", "bottomedge", "center"];
+type EdgeSpecifier = (typeof edgeSpecifiers)[number];
 declare class Constraint extends PrimitiveComponent<typeof constraintProps> {
     get config(): {
         zodProps: z.ZodUnion<[z.ZodObject<{
             pcb: z.ZodOptional<z.ZodLiteral<true>>;
-            type: z.ZodOptional<z.ZodLiteral<"xdist">>;
-            xdist: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+            xDist: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
             left: z.ZodString;
             right: z.ZodString;
             edgeToEdge: z.ZodOptional<z.ZodLiteral<true>>;
             centerToCenter: z.ZodOptional<z.ZodLiteral<true>>;
-            fromLeftEdge: z.ZodOptional<z.ZodLiteral<true>>;
-            fromLeftCenter: z.ZodOptional<z.ZodLiteral<true>>;
-            toRightEdge: z.ZodOptional<z.ZodLiteral<true>>;
-            toRightCenter: z.ZodOptional<z.ZodLiteral<true>>;
         }, "strip", z.ZodTypeAny, {
             left: string;
             right: string;
-            xdist: number;
-            type?: "xdist" | undefined;
+            xDist: number;
             pcb?: true | undefined;
             edgeToEdge?: true | undefined;
             centerToCenter?: true | undefined;
-            fromLeftEdge?: true | undefined;
-            fromLeftCenter?: true | undefined;
-            toRightEdge?: true | undefined;
-            toRightCenter?: true | undefined;
         }, {
             left: string;
             right: string;
-            xdist: string | number;
-            type?: "xdist" | undefined;
+            xDist: string | number;
             pcb?: true | undefined;
             edgeToEdge?: true | undefined;
             centerToCenter?: true | undefined;
-            fromLeftEdge?: true | undefined;
-            fromLeftCenter?: true | undefined;
-            toRightEdge?: true | undefined;
-            toRightCenter?: true | undefined;
         }>, z.ZodObject<{
             pcb: z.ZodOptional<z.ZodLiteral<true>>;
-            type: z.ZodOptional<z.ZodLiteral<"ydist">>;
-            ydist: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+            yDist: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
             top: z.ZodString;
             bottom: z.ZodString;
             edgeToEdge: z.ZodOptional<z.ZodLiteral<true>>;
             centerToCenter: z.ZodOptional<z.ZodLiteral<true>>;
-            fromTopEdge: z.ZodOptional<z.ZodLiteral<true>>;
-            fromTopCenter: z.ZodOptional<z.ZodLiteral<true>>;
-            toBottomEdge: z.ZodOptional<z.ZodLiteral<true>>;
-            toBottomCenter: z.ZodOptional<z.ZodLiteral<true>>;
         }, "strip", z.ZodTypeAny, {
             top: string;
             bottom: string;
-            ydist: number;
-            type?: "ydist" | undefined;
+            yDist: number;
             pcb?: true | undefined;
             edgeToEdge?: true | undefined;
             centerToCenter?: true | undefined;
-            fromTopEdge?: true | undefined;
-            fromTopCenter?: true | undefined;
-            toBottomEdge?: true | undefined;
-            toBottomCenter?: true | undefined;
         }, {
             top: string;
             bottom: string;
-            ydist: string | number;
-            type?: "ydist" | undefined;
+            yDist: string | number;
             pcb?: true | undefined;
             edgeToEdge?: true | undefined;
             centerToCenter?: true | undefined;
-            fromTopEdge?: true | undefined;
-            fromTopCenter?: true | undefined;
-            toBottomEdge?: true | undefined;
-            toBottomCenter?: true | undefined;
+        }>, z.ZodObject<{
+            pcb: z.ZodOptional<z.ZodLiteral<true>>;
+            sameY: z.ZodOptional<z.ZodLiteral<true>>;
+            for: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            for: string[];
+            pcb?: true | undefined;
+            sameY?: true | undefined;
+        }, {
+            for: string[];
+            pcb?: true | undefined;
+            sameY?: true | undefined;
+        }>, z.ZodObject<{
+            pcb: z.ZodOptional<z.ZodLiteral<true>>;
+            sameX: z.ZodOptional<z.ZodLiteral<true>>;
+            for: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            for: string[];
+            pcb?: true | undefined;
+            sameX?: true | undefined;
+        }, {
+            for: string[];
+            pcb?: true | undefined;
+            sameX?: true | undefined;
         }>]>;
     };
     constructor(props: z.input<typeof constraintProps>);
@@ -3519,6 +3515,8 @@ declare class Constraint extends PrimitiveComponent<typeof constraintProps> {
         componentsWithSelectors: Array<{
             component: PrimitiveComponent<any>;
             selector: string;
+            componentSelector: string;
+            edge: EdgeSpecifier | undefined;
         }>;
     };
 }

package/dist/index.js

@@ -522,11 +522,18 @@ var Footprint = class extends PrimitiveComponent {
     if (constraints.length === 0) return;
     const involvedComponents = constraints.flatMap(
       (constraint) => constraint._getAllReferencedComponents().componentsWithSelectors
-    ).map(({ component, selector }) => ({
+    ).map(({ component, selector, componentSelector, edge }) => ({
       component,
       selector,
+      componentSelector,
+      edge,
       bounds: component._getCircuitJsonBounds()
     }));
+    if (involvedComponents.some((c) => c.edge)) {
+      throw new Error(
+        "edge constraints not implemented yet for footprint layout, contributions welcome!"
+      );
+    }
     function getComponentDetails(selector) {
       return involvedComponents.find(({ selector: s }) => s === selector);
     }
@@ -547,8 +554,8 @@ var Footprint = class extends PrimitiveComponent {
     }
     for (const constraint of constraints) {
       const props = constraint._parsedProps;
-      if ("xdist" in props) {
-        const { xdist, left, right, edgeToEdge, centerToCenter } = props;
+      if ("xDist" in props) {
+        const { xDist, left, right, edgeToEdge, centerToCenter } = props;
         const leftVar = getKVar(`${left}_x`);
         const rightVar = getKVar(`${right}_x`);
         const leftBounds = getComponentDetails(left)?.bounds;
@@ -559,7 +566,7 @@ var Footprint = class extends PrimitiveComponent {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.xdist,
+              props.xDist,
               kiwi.Strength.required
             )
           );
@@ -574,13 +581,13 @@ var Footprint = class extends PrimitiveComponent {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.xdist,
+              props.xDist,
               kiwi.Strength.required
             )
           );
         }
-      } else if ("ydist" in props) {
-        const { ydist, top, bottom, edgeToEdge, centerToCenter } = props;
+      } else if ("yDist" in props) {
+        const { yDist, top, bottom, edgeToEdge, centerToCenter } = props;
         const topVar = getKVar(`${top}_y`);
         const bottomVar = getKVar(`${bottom}_y`);
         const topBounds = getComponentDetails(top)?.bounds;
@@ -591,7 +598,7 @@ var Footprint = class extends PrimitiveComponent {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.ydist,
+              props.yDist,
               kiwi.Strength.required
             )
           );
@@ -606,11 +613,37 @@ var Footprint = class extends PrimitiveComponent {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.ydist,
+              props.yDist,
               kiwi.Strength.required
             )
           );
         }
+      } else if ("sameY" in props) {
+        const { for: selectors } = props;
+        if (selectors.length < 2) continue;
+        const vars = selectors.map((selector) => getKVar(`${selector}_y`));
+        const expr = new kiwi.Expression(...vars.slice(1));
+        solver.addConstraint(
+          new kiwi.Constraint(
+            expr,
+            kiwi.Operator.Eq,
+            vars[0],
+            kiwi.Strength.required
+          )
+        );
+      } else if ("sameX" in props) {
+        const { for: selectors } = props;
+        if (selectors.length < 2) continue;
+        const vars = selectors.map((selector) => getKVar(`${selector}_x`));
+        const expr = new kiwi.Expression(...vars.slice(1));
+        solver.addConstraint(
+          new kiwi.Constraint(
+            expr,
+            kiwi.Operator.Eq,
+            vars[0],
+            kiwi.Strength.required
+          )
+        );
       }
     }
     solver.updateVariables();
@@ -1236,7 +1269,6 @@ var PlatedHole = class extends PrimitiveComponent {
   doInitialPcbPrimitiveRender() {
     const { db } = this.root;
     const { _parsedProps: props } = this;
-    if (!props.portHints) return;
     const position = this._getGlobalPcbPositionBeforeLayout();
     if (props.shape === "circle") {
       const pcb_plated_hole = db.pcb_plated_hole.insert({
@@ -2942,6 +2974,13 @@ var Jumper = class extends NormalComponent {
 // lib/components/primitive-components/Constraint.ts
 import { constraintProps } from "@tscircuit/props";
 import "zod";
+var edgeSpecifiers = [
+  "leftedge",
+  "rightedge",
+  "topedge",
+  "bottomedge",
+  "center"
+];
 var Constraint2 = class extends PrimitiveComponent {
   get config() {
     return {
@@ -2953,23 +2992,38 @@ var Constraint2 = class extends PrimitiveComponent {
     if ("xdist" in props || "ydist" in props) {
       if (!("edgeToEdge" in props) && !("centerToCenter" in props)) {
         throw new Error(
-          "edgeToEdge, centerToCenter (or from*/to* props) must be set for xdist or ydist for <constraint />"
+          `edgeToEdge, centerToCenter must be set for xDist or yDist for ${this}`
         );
       }
     }
+    if ("for" in props && props.for.length < 2) {
+      throw new Error(`"for" must have at least two selectors for ${this}`);
+    }
   }
   _getAllReferencedComponents() {
     const componentsWithSelectors = [];
+    const subcircuit = this.getSubcircuit();
+    function addComponentFromSelector(selector) {
+      const component = subcircuit.selectOne(selector);
+      if (component) {
+        const maybeEdge = selector.split(" ").pop();
+        const edge = edgeSpecifiers.includes(maybeEdge) ? maybeEdge : void 0;
+        componentsWithSelectors.push({
+          selector,
+          component,
+          componentSelector: edge ? selector.replace(` ${edge}`, "") : selector,
+          edge
+        });
+      }
+    }
     for (const key of ["left", "right", "top", "bottom"]) {
       if (key in this._parsedProps) {
-        const selector = this._parsedProps[key];
-        const component = this.getSubcircuit().selectOne(selector);
-        if (component) {
-          componentsWithSelectors.push({
-            selector,
-            component
-          });
-        }
+        addComponentFromSelector(this._parsedProps[key]);
+      }
+    }
+    if ("for" in this._parsedProps) {
+      for (const selector of this._parsedProps.for) {
+        addComponentFromSelector(selector);
       }
     }
     return { componentsWithSelectors };

package/lib/components/primitive-components/Constraint.ts

@@ -2,6 +2,16 @@ import { constraintProps } from "@tscircuit/props"
 import { z } from "zod"
 import { PrimitiveComponent } from "../base-components/PrimitiveComponent"
 
+const edgeSpecifiers = [
+  "leftedge",
+  "rightedge",
+  "topedge",
+  "bottomedge",
+  "center",
+] as const
+
+export type EdgeSpecifier = (typeof edgeSpecifiers)[number]
+
 export class Constraint extends PrimitiveComponent<typeof constraintProps> {
   get config() {
     return {
@@ -13,34 +23,60 @@ export class Constraint extends PrimitiveComponent<typeof constraintProps> {
     super(props)
     if ("xdist" in props || "ydist" in props) {
       if (!("edgeToEdge" in props) && !("centerToCenter" in props)) {
+        // TODO don't throw an error if the selectors specify an edge
         throw new Error(
-          "edgeToEdge, centerToCenter (or from*/to* props) must be set for xdist or ydist for <constraint />",
+          `edgeToEdge, centerToCenter must be set for xDist or yDist for ${this}`,
         )
       }
     }
+    if ("for" in props && props.for.length < 2) {
+      throw new Error(`"for" must have at least two selectors for ${this}`)
+    }
   }
 
   _getAllReferencedComponents(): {
     componentsWithSelectors: Array<{
       component: PrimitiveComponent<any>
       selector: string
+      componentSelector: string
+      edge: EdgeSpecifier | undefined
     }>
   } {
     const componentsWithSelectors: Array<{
       component: PrimitiveComponent<any>
       selector: string
+      componentSelector: string
+      edge: EdgeSpecifier | undefined
     }> = []
 
+    const subcircuit = this.getSubcircuit()
+
+    function addComponentFromSelector(selector: string) {
+      // TODO this selector has to be modified in case it contains a leftedge,
+      // center/topedge/rightedge indicator
+      const component = subcircuit.selectOne(selector)
+      if (component) {
+        const maybeEdge = selector.split(" ").pop() as EdgeSpecifier
+        const edge = edgeSpecifiers.includes(maybeEdge) ? maybeEdge : undefined
+
+        componentsWithSelectors.push({
+          selector,
+          component,
+          componentSelector: edge ? selector.replace(` ${edge}`, "") : selector,
+          edge,
+        })
+      }
+    }
+
     for (const key of ["left", "right", "top", "bottom"]) {
       if (key in this._parsedProps) {
-        const selector = (this._parsedProps as any)[key] as string
-        const component = this.getSubcircuit().selectOne(selector)
-        if (component) {
-          componentsWithSelectors.push({
-            selector,
-            component,
-          })
-        }
+        addComponentFromSelector((this._parsedProps as any)[key] as string)
+      }
+    }
+
+    if ("for" in this._parsedProps) {
+      for (const selector of this._parsedProps.for) {
+        addComponentFromSelector(selector)
       }
     }
 

package/lib/components/primitive-components/Footprint.ts

@@ -23,12 +23,20 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
         (constraint) =>
           constraint._getAllReferencedComponents().componentsWithSelectors,
       )
-      .map(({ component, selector }) => ({
+      .map(({ component, selector, componentSelector, edge }) => ({
         component,
         selector,
+        componentSelector,
+        edge,
         bounds: component._getCircuitJsonBounds(),
       }))
 
+    if (involvedComponents.some((c) => c.edge)) {
+      throw new Error(
+        "edge constraints not implemented yet for footprint layout, contributions welcome!",
+      )
+    }
+
     function getComponentDetails(selector: string) {
       return involvedComponents.find(({ selector: s }) => s === selector)
     }
@@ -56,8 +64,8 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
     for (const constraint of constraints) {
       const props = constraint._parsedProps
 
-      if ("xdist" in props) {
-        const { xdist, left, right, edgeToEdge, centerToCenter } = props
+      if ("xDist" in props) {
+        const { xDist, left, right, edgeToEdge, centerToCenter } = props
         const leftVar = getKVar(`${left}_x`)
         const rightVar = getKVar(`${right}_x`)
         const leftBounds = getComponentDetails(left)?.bounds!
@@ -70,7 +78,7 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.xdist,
+              props.xDist,
               kiwi.Strength.required,
             ),
           )
@@ -87,13 +95,13 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.xdist,
+              props.xDist,
               kiwi.Strength.required,
             ),
           )
         }
-      } else if ("ydist" in props) {
-        const { ydist, top, bottom, edgeToEdge, centerToCenter } = props
+      } else if ("yDist" in props) {
+        const { yDist, top, bottom, edgeToEdge, centerToCenter } = props
         const topVar = getKVar(`${top}_y`)
         const bottomVar = getKVar(`${bottom}_y`)
         const topBounds = getComponentDetails(top)?.bounds!
@@ -108,7 +116,7 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.ydist,
+              props.yDist,
               kiwi.Strength.required,
             ),
           )
@@ -125,11 +133,38 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.ydist,
+              props.yDist,
               kiwi.Strength.required,
             ),
           )
         }
+      } else if ("sameY" in props) {
+        const { for: selectors } = props
+        if (selectors.length < 2) continue
+        const vars = selectors.map((selector) => getKVar(`${selector}_y`))
+        const expr = new kiwi.Expression(...vars.slice(1))
+
+        solver.addConstraint(
+          new kiwi.Constraint(
+            expr,
+            kiwi.Operator.Eq,
+            vars[0],
+            kiwi.Strength.required,
+          ),
+        )
+      } else if ("sameX" in props) {
+        const { for: selectors } = props
+        if (selectors.length < 2) continue
+        const vars = selectors.map((selector) => getKVar(`${selector}_x`))
+        const expr = new kiwi.Expression(...vars.slice(1))
+        solver.addConstraint(
+          new kiwi.Constraint(
+            expr,
+            kiwi.Operator.Eq,
+            vars[0],
+            kiwi.Strength.required,
+          ),
+        )
       }
     }
 

package/lib/components/primitive-components/PlatedHole.ts

@@ -79,7 +79,6 @@ export class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
   doInitialPcbPrimitiveRender(): void {
     const { db } = this.root!
     const { _parsedProps: props } = this
-    if (!props.portHints) return
     const position = this._getGlobalPcbPositionBeforeLayout()
     if (props.shape === "circle") {
       const pcb_plated_hole = db.pcb_plated_hole.insert({

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tscircuit/core",
   "module": "index.ts",
   "type": "module",
-  "version": "0.0.33",
+  "version": "0.0.34",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "files": [
@@ -35,7 +35,7 @@
   "dependencies": {
     "@lume/kiwi": "^0.4.3",
     "@tscircuit/infgrid-ijump-astar": "^0.0.6",
-    "@tscircuit/props": "^0.0.61",
+    "@tscircuit/props": "^0.0.62",
     "@tscircuit/soup": "^0.0.66",
     "@tscircuit/soup-util": "0.0.18",
     "footprinter": "^0.0.44",