@tscircuit/props 0.0.617 → 0.0.619

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 CHANGED
@@ -911,6 +911,26 @@ export interface FootprintProps {
911
911
  * makes the distinction easy to miss.
912
912
  */
913
913
  insertionDirection?: FootprintInsertionDirection;
914
+ /**
915
+ * Direction the part's enclosure opening faces, named the same way as
916
+ * `insertionDirection` and in the same unrotated part frame.
917
+ *
918
+ * These are two different physical facts and a part may need both. A
919
+ * side-actuated switch is *installed* from above and *actuated* from the side:
920
+ * its aperture must pierce a side wall, while nothing is ever inserted into
921
+ * it. Reusing `insertionDirection` for that would either put the opening on
922
+ * the wrong face or overload a field documented as "the side exposing the
923
+ * receptacle where the cable is attached".
924
+ *
925
+ * Like `insertionDirection`, this is a property of the part, authored without
926
+ * regard to placement: rotating or flipping the component rotates it too, and
927
+ * `pcb_component.cutout_aperture_direction` reports the result in board
928
+ * coordinates.
929
+ *
930
+ * When absent, the aperture falls back to `insertionDirection`, which is
931
+ * correct for every connector -- a cable enters through the opening it needs.
932
+ */
933
+ cutoutApertureDirection?: FootprintInsertionDirection;
914
934
  }
915
935
  ```
916
936