@tscircuit/props 0.0.605 → 0.0.607

package/lib/components/diode.ts

@@ -33,7 +33,7 @@ const connectionTarget = z
 
 const connectionsProp = z.record(diodeConnectionKeys, connectionTarget)
 
-const diodePinLabelsProp = z.record(
+export const diodePinLabelsProp = z.record(
   z.enum(diodePins),
   schematicPinLabel
     .or(z.array(schematicPinLabel).readonly())

package/lib/components/footprint.ts

@@ -1,19 +1,38 @@
-import { type LayerRef, layer_ref } from "circuit-json"
+import {
+  type InsertionDirectionInput,
+  type LayerRef,
+  layer_ref,
+} from "circuit-json"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 import { type FootprintProp, footprintProp } from "../common/footprintProp"
 
-export type FootprintInsertionDirection =
-  | "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`.
+ */
+export type FootprintInsertionDirection = InsertionDirectionInput
 
 export const footprintInsertionDirection = z.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",
 ])
@@ -45,8 +64,21 @@ export 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
 }
@@ -60,7 +92,7 @@ export const footprintProps = z.object({
   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.",
     ),
 })
 

package/lib/components/led.ts

@@ -2,6 +2,7 @@ import { commonComponentProps, lrPolarPins } from "lib/common/layout"
 import { schematicOrientation } from "lib/common/schematicOrientation"
 import { z } from "zod"
 import { createConnectionsProp } from "lib/common/connectionsProp"
+import { diodePinLabelsProp } from "lib/components/diode"
 
 export type LedPinLabels = (typeof lrPolarPins)[number]
 
@@ -10,6 +11,7 @@ export const ledProps = commonComponentProps.extend({
   wavelength: z.string().optional(),
   schDisplayValue: z.string().optional(),
   schOrientation: schematicOrientation.optional(),
+  pinLabels: diodePinLabelsProp.optional(),
   connections: createConnectionsProp(lrPolarPins).optional(),
   laser: z.boolean().optional(),
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/props",
-  "version": "0.0.605",
+  "version": "0.0.607",
   "description": "Props for tscircuit builtin component types",
   "main": "dist/index.js",
   "type": "module",
@@ -32,7 +32,7 @@
     "@types/node": "^20.12.11",
     "@types/react": "^18.3.2",
     "ava": "^6.1.3",
-    "circuit-json": "^0.0.455",
+    "circuit-json": "^0.0.461",
     "expect-type": "^1.3.0",
     "glob": "^11.0.0",
     "madge": "^8.0.0",