@tscircuit/props 0.0.682 → 0.0.683

package/lib/assembly/board-mounting.ts

@@ -0,0 +1,56 @@
+import type { AutocompleteString } from "lib/common/autocomplete"
+import { z } from "zod"
+
+export type BoardMountRotationAnchor = AutocompleteString<
+  "topedge" | "bottomedge" | "leftedge" | "rightedge"
+>
+
+export type BoardMountOrientation =
+  | "top_layer_toward_mount_face"
+  | "bottom_layer_toward_mount_face"
+
+const identityPathPattern =
+  "[A-Za-z_][A-Za-z0-9_-]*(?:\\.[A-Za-z_][A-Za-z0-9_-]*)*"
+const referencePattern =
+  "[A-Za-z_][A-Za-z0-9_-]*(?:\\.[A-Za-z_][A-Za-z0-9_-]*)+"
+const reference = new RegExp(`^${referencePattern}$`)
+const anchor = new RegExp(`^${identityPathPattern}$`)
+const expression = new RegExp(
+  `^calc\\(\\s*(${referencePattern})\\s*(?:([+-])\\s*((?:\\d+(?:\\.\\d*)?|\\.\\d+))\\s*(degcw|degccw))?\\s*\\)$`,
+)
+
+export const boardMountRotation = z
+  .string()
+  .trim()
+  .superRefine((value, ctx) => {
+    if (reference.test(value)) return
+    const match = expression.exec(value)
+    if (!match) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          "Expected a qualified mounting reference or calc(reference +/- Ndegcw|Ndegccw)",
+      })
+      return
+    }
+    if (match[3] !== undefined && !Number.isFinite(Number(match[3]))) {
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "Mount rotation angle must be finite",
+      })
+    }
+  })
+
+export const boardMountRotationAnchor = z
+  .custom<BoardMountRotationAnchor>((value) => typeof value === "string", {
+    message: "Expected a board edge or component identity path",
+  })
+  .transform((value) => value.trim())
+  .refine((value) => anchor.test(value), {
+    message: "Expected a board edge or component identity path",
+  })
+
+export const boardMountOrientation = z.enum([
+  "top_layer_toward_mount_face",
+  "bottom_layer_toward_mount_face",
+])

package/lib/assembly/index.ts

@@ -4,6 +4,7 @@ import { assemblyMotorProps } from "./motor"
 import { assemblyScreenProps } from "./screen"
 import { assemblySubassemblyProps } from "./subassembly"
 
+export * from "./board-mounting"
 export * from "./device"
 export * from "./motor"
 export * from "./screen"

package/lib/assembly/motor.ts

@@ -23,6 +23,8 @@ export interface AssemblyMotorProps {
    * shaft. Defaults to "z+", the native shaft axis of the NEMA models.
    */
   shaftFacingDirection?: CadModelAxisDirection
+  /** e.g. "jst-ph-6". */
+  wireConnection?: "none" | "stubs" | "jst-ph-6"
 }
 
 export const assemblyMotorProps = z
@@ -34,8 +36,17 @@ export const assemblyMotorProps = z
     standard: z.enum(["nema8", "nema17", "nema23"]).optional(),
     model: z.string().trim().min(1).optional(),
     shaftFacingDirection: cadModelAxisDirection.default("z+"),
+    wireConnection: z.enum(["none", "stubs", "jst-ph-6"]).optional(),
   })
   .superRefine((motor, context) => {
+    if (motor.model !== undefined && motor.wireConnection !== undefined) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message:
+          "Set wireConnection in the custom model string, or use standard",
+        path: ["wireConnection"],
+      })
+    }
     if (motor.standard === undefined && motor.model === undefined) {
       context.addIssue({
         code: z.ZodIssueCode.custom,

package/lib/components/board.ts

@@ -5,6 +5,13 @@ import { type Point, point } from "lib/common/point"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 import { subcircuitGroupProps, type SubcircuitGroupProps } from "./group"
+import {
+  boardMountOrientation,
+  boardMountRotation,
+  boardMountRotationAnchor,
+  type BoardMountOrientation,
+  type BoardMountRotationAnchor,
+} from "../assembly/board-mounting"
 
 const boardColorPresets = [
   "not_specified",
@@ -78,17 +85,16 @@ 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.
-   */
+  /** e.g. "NEMA17.backface". */
   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.
-   */
+  /** Clearance from the mounting face, e.g. "6mm". */
   mountGap?: Distance
+  /** e.g. "J_USB" or "rightedge". */
+  mountRotationAnchor?: BoardMountRotationAnchor
+  /** e.g. "calc(NEMA17.wireside-90degcw)". */
+  mountRotation?: string
+  /** e.g. "top_layer_toward_mount_face". */
+  mountOrientation?: BoardMountOrientation
   /** Fabricator preset, preserved as supplied. Omitted leaves the preset unset. */
   fabricatorPreset?:
     | "jlcpcb_economy"
@@ -169,15 +175,20 @@ export const boardProps = subcircuitGroupProps
       .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.',
-      ),
+      .describe('e.g. "NEMA17.backface".'),
     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.",
-      ),
+      .describe('Clearance from the mounting face, e.g. "6mm".'),
+    mountRotationAnchor: boardMountRotationAnchor
+      .optional()
+      .describe('e.g. "J_USB" or "rightedge".'),
+    mountRotation: boardMountRotation
+      .optional()
+      .describe('e.g. "calc(NEMA17.wireside-90degcw)".'),
+    mountOrientation: boardMountOrientation
+      .optional()
+      .describe('e.g. "top_layer_toward_mount_face".'),
     fabricatorPreset: z
       .enum([
         "jlcpcb_economy",

package/package.json

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