@tscircuit/props 0.0.685 → 0.0.687

package/lib/assembly/cable.ts

@@ -0,0 +1,26 @@
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export type AssemblyCableStandard = "usb_c"
+
+export interface AssemblyCableProps {
+  /** Stable assembly identity for the cable. */
+  name: string
+  /** Start connector selector or named assembly reference, e.g. MOTOR.wireside. */
+  from: string
+  /** End connector selector or named assembly reference. */
+  to: string
+  /** Optional USB-C-to-USB-C preset. Omit to infer the cable from its endpoints. */
+  standard?: AssemblyCableStandard
+}
+
+export const assemblyCableProps = z.object({
+  name: z.string().trim().min(1),
+  from: z.string().trim().min(1),
+  to: z.string().trim().min(1),
+  standard: z.literal("usb_c").optional(),
+})
+
+export type AssemblyCablePropsInput = z.input<typeof assemblyCableProps>
+
+expectTypesMatch<AssemblyCableProps, AssemblyCablePropsInput>(true)

package/lib/assembly/index.ts

@@ -1,4 +1,5 @@
 import { assemblyCadAssemblyProps } from "./cadassembly"
+import { assemblyCableProps } from "./cable"
 import { assemblyDeviceProps } from "./device"
 import { assemblyPrintedPartProps } from "./printedpart"
 import { assemblyMotorProps } from "./motor"
@@ -6,6 +7,7 @@ import { assemblyScreenProps } from "./screen"
 import { assemblySubassemblyProps } from "./subassembly"
 
 export * from "./board-mounting"
+export * from "./cable"
 export * from "./device"
 export * from "./motor"
 export * from "./printedpart"
@@ -14,6 +16,7 @@ export * from "./subassembly"
 export * from "./cadassembly"
 
 export const assemblyProps = {
+  cable: assemblyCableProps,
   device: assemblyDeviceProps,
   motor: assemblyMotorProps,
   printedpart: assemblyPrintedPartProps,

package/lib/assembly/motor.ts

@@ -2,6 +2,7 @@ import {
   type CadModelAxisDirection,
   cadModelAxisDirection,
 } from "lib/common/cadModel"
+import { distance, type Distance } from "lib/common/distance"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
@@ -25,6 +26,18 @@ export interface AssemblyMotorProps {
   shaftFacingDirection?: CadModelAxisDirection
   /** e.g. "jst-ph-6". */
   wireConnection?: "none" | "stubs" | "jst-ph-6"
+  /** Assembly mounting target, e.g. "FRAME.xMotor"; paired with mountFace.
+   * Face mating determines orientation, so shaftFacingDirection must be omitted.
+   */
+  mountedTo?: string
+  /** This motor's mating face, e.g. "frontface" or "backface".
+   * Outward normals oppose and in-plane X directions align with the target.
+   */
+  mountFace?: string
+  /** Nonnegative surface clearance in mm or a unit string; defaults to zero.
+   * Requires mountedTo. Positive values separate the mating faces.
+   */
+  mountGap?: Distance
 }
 
 export const assemblyMotorProps = z
@@ -35,10 +48,41 @@ export const assemblyMotorProps = z
     displayName: z.string().optional(),
     standard: z.enum(["nema8", "nema17", "nema23"]).optional(),
     model: z.string().trim().min(1).optional(),
-    shaftFacingDirection: cadModelAxisDirection.default("z+"),
+    shaftFacingDirection: cadModelAxisDirection.optional(),
     wireConnection: z.enum(["none", "stubs", "jst-ph-6"]).optional(),
+    mountedTo: z
+      .string()
+      .trim()
+      .regex(/^.+\.[^.]+$/, "Expected part.face")
+      .optional(),
+    mountFace: z.string().trim().min(1).optional(),
+    mountGap: distance.pipe(z.number().nonnegative().finite()).optional(),
   })
   .superRefine((motor, context) => {
+    if ((motor.mountedTo === undefined) !== (motor.mountFace === undefined)) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "Provide mountedTo and mountFace together",
+        path: ["mountFace"],
+      })
+    }
+    if (motor.mountGap !== undefined && motor.mountedTo === undefined) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "mountGap requires mountedTo",
+        path: ["mountGap"],
+      })
+    }
+    if (
+      motor.mountedTo !== undefined &&
+      motor.shaftFacingDirection !== undefined
+    ) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "Mounted motors derive shaft direction from the mating faces",
+        path: ["shaftFacingDirection"],
+      })
+    }
     if (motor.model !== undefined && motor.wireConnection !== undefined) {
       context.addIssue({
         code: z.ZodIssueCode.custom,
@@ -62,6 +106,14 @@ export const assemblyMotorProps = z
       })
     }
   })
+  .transform((motor) =>
+    motor.mountedTo === undefined
+      ? {
+          ...motor,
+          shaftFacingDirection: motor.shaftFacingDirection ?? ("z+" as const),
+        }
+      : motor,
+  )
 
 export type AssemblyMotorPropsInput = z.input<typeof assemblyMotorProps>
 

package/package.json

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