@tscircuit/props 0.0.677 → 0.0.678

package/lib/assembly/index.ts

@@ -1,15 +1,18 @@
 import { assemblyCadAssemblyProps } from "./cadassembly"
 import { assemblyDeviceProps } from "./device"
+import { assemblyMotorProps } from "./motor"
 import { assemblyScreenProps } from "./screen"
 import { assemblySubassemblyProps } from "./subassembly"
 
 export * from "./device"
+export * from "./motor"
 export * from "./screen"
 export * from "./subassembly"
 export * from "./cadassembly"
 
 export const assemblyProps = {
   device: assemblyDeviceProps,
+  motor: assemblyMotorProps,
   screen: assemblyScreenProps,
   subassembly: assemblySubassemblyProps,
   cadassembly: assemblyCadAssemblyProps,

package/lib/assembly/motor.ts

@@ -0,0 +1,57 @@
+import {
+  type CadModelAxisDirection,
+  cadModelAxisDirection,
+} from "lib/common/cadModel"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export type AssemblyMotorStandard = "nema8" | "nema17" | "nema23"
+
+export interface AssemblyMotorProps {
+  /** Stable assembly identity used by selectors. */
+  name: string
+  /** Human-facing alternate to the stable name. */
+  displayName?: string
+  /** NEMA frame standard; required when model is omitted, exclusive with model. */
+  standard?: AssemblyMotorStandard
+  /** Advanced modelprinter string, trimmed; exclusive with standard. */
+  model?: string
+  /**
+   * Direction from the motor body toward the shaft tip in the right-handed
+   * circuit frame: +X right, +Y top, +Z above the board. This is a direction,
+   * not a position; it does not specify translation or rotation about the
+   * shaft. Defaults to "z+", the native shaft axis of the NEMA models.
+   */
+  shaftFacingDirection?: CadModelAxisDirection
+}
+
+export const assemblyMotorProps = z
+  .object({
+    name: z.string().refine((value) => value.trim().length > 0, {
+      message: "name cannot be empty",
+    }),
+    displayName: z.string().optional(),
+    standard: z.enum(["nema8", "nema17", "nema23"]).optional(),
+    model: z.string().trim().min(1).optional(),
+    shaftFacingDirection: cadModelAxisDirection.default("z+"),
+  })
+  .superRefine((motor, context) => {
+    if (motor.standard === undefined && motor.model === undefined) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "Provide standard or model",
+        path: ["standard"],
+      })
+    }
+    if (motor.standard !== undefined && motor.model !== undefined) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "Provide either standard or model, not both",
+        path: ["model"],
+      })
+    }
+  })
+
+export type AssemblyMotorPropsInput = z.input<typeof assemblyMotorProps>
+
+expectTypesMatch<AssemblyMotorProps, AssemblyMotorPropsInput>(true)

package/lib/components/board.ts

@@ -78,6 +78,17 @@ export const boardOutlinePoint = z
 export interface BoardProps
   extends Omit<SubcircuitGroupProps, "subcircuit" | "connections" | "outline"> {
   title?: string
+  /**
+   * Assembly mounting target, such as "NEMA17.backface". Trimmed; omitted
+   * leaves the board unattached. The target face is resolved by the consumer.
+   */
+  mountedTo?: string
+  /**
+   * Nonnegative finite clearance between the target mounting face and the
+   * nearest PCB surface, in millimeters or a unit string. Parsed to mm.
+   * Omitted leaves the gap unset; only meaningful when mountedTo is supplied.
+   */
+  mountGap?: Distance
   /** Fabricator preset, preserved as supplied. Omitted leaves the preset unset. */
   fabricatorPreset?:
     | "jlcpcb_economy"
@@ -153,6 +164,20 @@ export interface BoardProps
 export const boardProps = subcircuitGroupProps
   .omit({ connections: true })
   .extend({
+    mountedTo: z
+      .string()
+      .trim()
+      .min(1)
+      .optional()
+      .describe(
+        'Assembly mounting target, such as "NEMA17.backface". Trimmed; omitted leaves the board unattached. The target face is resolved by the consumer.',
+      ),
+    mountGap: distance
+      .pipe(z.number().nonnegative().finite())
+      .optional()
+      .describe(
+        "Nonnegative finite clearance between the target mounting face and the nearest PCB surface, in millimeters or a unit string, parsed to mm. Omitted leaves the gap unset; only meaningful when mountedTo is supplied.",
+      ),
     fabricatorPreset: z
       .enum([
         "jlcpcb_economy",

package/package.json

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