@tscircuit/props 0.0.679 → 0.0.680

package/lib/common/layout.ts

@@ -258,7 +258,11 @@ export interface CommonComponentProps<PinLabel extends string = string>
    * Whether to show this component's CAD model as translucent in the 3D viewer.
    */
   showAsTranslucentModel?: boolean
+  /** Alias for manufacturerPartNumber. No default; use resolveManufacturerPartNumber to resolve aliases. */
+  mpn?: string
+  /** Alias for manufacturerPartNumber. Retained for existing circuits. */
   mfn?: string
+  /** Manufacturer's part number. Aliases must agree when specified together. */
   manufacturerPartNumber?: string
   /**
    * This component will be drawn as part of this section e.g. "Power"
@@ -314,6 +318,7 @@ export const commonComponentProps = commonLayoutProps
         "Whether to show this component's CAD model as translucent in the 3D viewer.",
       ),
     pinAttributes: z.record(z.string(), pinAttributeMap).optional(),
+    mpn: z.string().describe("Manufacturer Part Number").optional(),
     mfn: z.string().describe("Manufacturer Part Number").optional(),
     manufacturerPartNumber: z.string().optional(),
   })

package/lib/common/resolveManufacturerPartNumber.ts

@@ -0,0 +1,23 @@
+import type { CommonComponentProps } from "./layout"
+
+/**
+ * Schemas retain the author's optional aliases so their Zod objects remain
+ * composable. Consumers resolve them to a canonical manufacturer part number
+ * with this helper. There is no default: empty/whitespace-only values are absent.
+ * Equal aliases are accepted; conflicting nonempty aliases throw. Existing
+ * manufacturerPartNumber and mfn inputs remain supported without migration.
+ */
+export const resolveManufacturerPartNumber = (
+  props: Pick<CommonComponentProps, "manufacturerPartNumber" | "mpn" | "mfn">,
+): string | undefined => {
+  const partNumbers = [props.manufacturerPartNumber, props.mpn, props.mfn]
+    .map((partNumber) => partNumber?.trim())
+    .filter((partNumber): partNumber is string => Boolean(partNumber))
+
+  if (new Set(partNumbers).size > 1) {
+    throw new Error(
+      "Conflicting manufacturerPartNumber, mpn, and mfn: specify the same manufacturer part number for all aliases",
+    )
+  }
+  return partNumbers[0]
+}

package/lib/components/crystal.ts

@@ -31,7 +31,6 @@ export interface CrystalProps<PinLabel extends string = string>
   /** Maximum allowed PCB trace length between the crystal and its connected component */
   maxTraceLength?: number | string
   manufacturerPartNumber?: string
-  mpn?: string
   pinVariant?: PinVariant
   schOrientation?: SchematicOrientation
   connections?: Connections<CrystalPinLabels>
@@ -42,7 +41,6 @@ export const crystalProps = commonComponentProps.extend({
   loadCapacitance: capacitance,
   maxTraceLength: distance.optional(),
   manufacturerPartNumber: z.string().optional(),
-  mpn: z.string().optional(),
   pinVariant: z.enum(["two_pin", "four_pin"]).optional(),
   schOrientation: schematicOrientation.optional(),
   connections: createConnectionsProp(crystalPins).optional(),

package/lib/components/mountedboard.ts

@@ -7,6 +7,8 @@ import { subcircuitGroupProps, type SubcircuitGroupProps } from "./group"
 
 type MountedBoardChipProps = Pick<
   ChipPropsSU,
+  | "mpn"
+  | "mfn"
   | "manufacturerPartNumber"
   | "pinLabels"
   | "showPinAliases"
@@ -26,6 +28,8 @@ export interface MountedBoardProps
 }
 
 export const mountedboardProps = subcircuitGroupProps.extend({
+  mpn: chipProps.shape.mpn,
+  mfn: chipProps.shape.mfn,
   manufacturerPartNumber: chipProps.shape.manufacturerPartNumber,
   pinLabels: chipProps.shape.pinLabels,
   showPinAliases: chipProps.shape.showPinAliases,

package/lib/index.ts

@@ -4,6 +4,7 @@ export * from "./assembly"
 export * from "./enclosure"
 export * from "./common/portHints"
 export * from "./common/layout"
+export * from "./common/resolveManufacturerPartNumber"
 export * from "./common/pinAttributeMap"
 export * from "./common/point3"
 export * from "./common/pcbPath"

package/package.json

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