@tscircuit/props 0.0.605 → 0.0.606

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import * as zod from 'zod';
 import { z } from 'zod';
 import * as react from 'react';
 import { ReactElement, ReactNode } from 'react';
-import { LayerRef, AnyCircuitElement, LayerRefInput, SourceNet, PcbPort, SourcePort, PcbComponent, SourceComponentBase, CircuitJsonError, Point as Point$1, RouteHintPoint, PcbTrace, AnySourceComponent, VisibleLayer, RouteHintPointInput } from 'circuit-json';
+import { LayerRef, AnyCircuitElement, LayerRefInput, SourceNet, PcbPort, SourcePort, PcbComponent, SourceComponentBase, CircuitJsonError, Point as Point$1, RouteHintPoint, PcbTrace, AnySourceComponent, InsertionDirectionInput, VisibleLayer, RouteHintPointInput } from 'circuit-json';
 
 declare const direction: z.ZodEnum<["up", "down", "left", "right"]>;
 type Direction = "up" | "down" | "left" | "right";
@@ -104990,8 +104990,18 @@ declare const differentialPairProps: z.ZodObject<{
     maxLengthSkew?: number | undefined;
 }>;
 
-type FootprintInsertionDirection = "from_above" | "from_left" | "from_right" | "from_front" | "from_back";
-declare const footprintInsertionDirection: z.ZodEnum<["from_above", "from_left", "from_right", "from_front", "from_back"]>;
+/**
+ * Direction a cable or mating part is attached from, named for the side of the
+ * footprint it approaches from.
+ *
+ * Aliased to Circuit JSON's input union so the two cannot drift apart. Both the
+ * named spellings and their Cartesian equivalents are accepted here, as are the
+ * deprecated `from_front` (now `from_top`) and `from_back` (now `from_bottom`).
+ * Core normalizes them to the six named values before writing
+ * `pcb_component.insertion_direction`.
+ */
+type FootprintInsertionDirection = InsertionDirectionInput;
+declare const footprintInsertionDirection: z.ZodEnum<["from_left", "from_right", "from_top", "from_bottom", "from_above", "from_below", "from_x_neg", "from_x_pos", "from_y_pos", "from_y_neg", "from_z_pos", "from_z_neg", "from_front", "from_back"]>;
 interface FootprintProps {
     children?: any;
     name?: string;
@@ -105015,8 +105025,21 @@ interface FootprintProps {
      */
     src?: FootprintProp;
     /**
-     * Direction a cable or mating part is inserted into this footprint in its
-     * unrotated orientation.
+     * Direction a cable or mating part is attached from, in the footprint's own
+     * frame -- the same frame its pads are drawn in. Directions are named for the
+     * footprint as drawn in the 2D PCB view: `from_top` is +Y, `from_bottom` -Y,
+     * `from_left` -X, `from_right` +X, `from_above` +Z and `from_below` -Z.
+     * Cartesian spellings such as `from_y_pos` are also accepted.
+     *
+     * This names a side, not a motion. A receptacle on the +Y edge is `from_top`
+     * because that is the side the plug comes from, even though the plug itself
+     * moves in -Y as it seats.
+     *
+     * This is a property of the part, so it is authored without regard to where
+     * the part is placed. Rotating or flipping the component rotates this with it,
+     * and `pcb_component.insertion_direction` reports the result in board
+     * coordinates. The two frames coincide for an unrotated top-layer part, which
+     * makes the distinction easy to miss.
      */
     insertionDirection?: FootprintInsertionDirection;
 }
@@ -105034,14 +105057,14 @@ declare const footprintProps: z.ZodObject<{
     }>>>;
     circuitJson: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
     src: z.ZodOptional<z.ZodType<FootprintProp, z.ZodTypeDef, FootprintProp>>;
-    insertionDirection: z.ZodOptional<z.ZodEnum<["from_above", "from_left", "from_right", "from_front", "from_back"]>>;
+    insertionDirection: z.ZodOptional<z.ZodEnum<["from_left", "from_right", "from_top", "from_bottom", "from_above", "from_below", "from_x_neg", "from_x_pos", "from_y_pos", "from_y_neg", "from_z_pos", "from_z_neg", "from_front", "from_back"]>>;
 }, "strip", z.ZodTypeAny, {
     name?: string | undefined;
     children?: any;
     circuitJson?: any[] | undefined;
     originalLayer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8" | undefined;
     src?: FootprintProp | undefined;
-    insertionDirection?: "from_above" | "from_left" | "from_right" | "from_front" | "from_back" | undefined;
+    insertionDirection?: "from_left" | "from_right" | "from_top" | "from_bottom" | "from_above" | "from_below" | "from_x_neg" | "from_x_pos" | "from_y_pos" | "from_y_neg" | "from_z_pos" | "from_z_neg" | "from_front" | "from_back" | undefined;
 }, {
     name?: string | undefined;
     children?: any;
@@ -105050,7 +105073,7 @@ declare const footprintProps: z.ZodObject<{
         name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8";
     } | undefined;
     src?: FootprintProp | undefined;
-    insertionDirection?: "from_above" | "from_left" | "from_right" | "from_front" | "from_back" | undefined;
+    insertionDirection?: "from_left" | "from_right" | "from_top" | "from_bottom" | "from_above" | "from_below" | "from_x_neg" | "from_x_pos" | "from_y_pos" | "from_y_neg" | "from_z_pos" | "from_z_neg" | "from_front" | "from_back" | undefined;
 }>;
 type FootprintPropsInput = z.input<typeof footprintProps>;
 

package/dist/index.js

@@ -17405,12 +17405,24 @@ var differentialPairProps = z72.object({
 expectTypesMatch(true);
 
 // lib/components/footprint.ts
-import { layer_ref as layer_ref6 } from "circuit-json";
+import {
+  layer_ref as layer_ref6
+} from "circuit-json";
 import { z as z73 } from "zod";
 var footprintInsertionDirection = z73.enum([
-  "from_above",
   "from_left",
   "from_right",
+  "from_top",
+  "from_bottom",
+  "from_above",
+  "from_below",
+  "from_x_neg",
+  "from_x_pos",
+  "from_y_pos",
+  "from_y_neg",
+  "from_z_pos",
+  "from_z_neg",
+  // Deprecated, accepted so existing sources keep type-checking.
   "from_front",
   "from_back"
 ]);
@@ -17422,7 +17434,7 @@ var footprintProps = z73.object({
   circuitJson: z73.array(z73.any()).optional(),
   src: footprintProp.describe("Can be a footprint or kicad string").optional(),
   insertionDirection: footprintInsertionDirection.optional().describe(
-    "Direction a cable or mating part is inserted into this footprint in its unrotated orientation."
+    "Direction a cable or mating part is attached from, named for the side of the footprint it approaches from, in its unrotated orientation."
   )
 });
 expectTypesMatch(true);