@tscircuit/props 0.0.695 → 0.0.697

package/lib/assembly/index.ts

@@ -1,6 +1,8 @@
 import { assemblyCadAssemblyProps } from "./cadassembly"
 import { assemblyCableProps } from "./cable"
 import { assemblyDeviceProps } from "./device"
+import { assemblyPartProps } from "./part"
+import { assemblyReferenceSurfaceProps } from "./referencesurface"
 import { assemblyPrintedPartProps } from "./printedpart"
 import { assemblyMotorProps } from "./motor"
 import { assemblyScreenProps } from "./screen"
@@ -10,6 +12,8 @@ export * from "./board-mounting"
 export * from "./cable"
 export * from "./device"
 export * from "./motor"
+export * from "./part"
+export * from "./referencesurface"
 export * from "./printedpart"
 export * from "./screen"
 export * from "./subassembly"
@@ -19,6 +23,8 @@ export const assemblyProps = {
   cable: assemblyCableProps,
   device: assemblyDeviceProps,
   motor: assemblyMotorProps,
+  part: assemblyPartProps,
+  referencesurface: assemblyReferenceSurfaceProps,
   printedpart: assemblyPrintedPartProps,
   screen: assemblyScreenProps,
   subassembly: assemblySubassemblyProps,

package/lib/assembly/part.ts

@@ -0,0 +1,47 @@
+import { type CadModelProp, cadModelProp } from "lib/common/cadModel"
+import { url } from "lib/common/url"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+import type { ReactNode } from "react"
+
+/** A generic component of an assembly, with optional CAD geometry. */
+export interface AssemblyPartProps {
+  /** Stable identity used by assembly selectors. */
+  name: string
+  /** Human-facing alternate to the stable name. */
+  displayName?: string
+  /** Modelprinter/footprinter string, trimmed; mutually exclusive with modelUrl and cadModel. */
+  model?: string
+  /** Imported CAD model URL; mutually exclusive with model and cadModel. */
+  modelUrl?: string
+  /** Existing component CAD model formats; mutually exclusive with model and modelUrl. */
+  cadModel?: CadModelProp
+  /** Reference surfaces defining named mounting frames for this part. */
+  children?: ReactNode
+}
+
+export const assemblyPartProps = z
+  .object({
+    name: z.string().trim().min(1),
+    displayName: z.string().optional(),
+    model: z.string().trim().min(1).optional(),
+    modelUrl: url
+      .refine((value) => value.trim().length > 0, "modelUrl cannot be empty")
+      .optional(),
+    cadModel: cadModelProp.optional(),
+    children: z.custom<ReactNode>().optional(),
+  })
+  .refine(
+    (part) =>
+      [part.model, part.modelUrl, part.cadModel].filter(
+        (value) => value !== undefined,
+      ).length <= 1,
+    {
+      message: "Provide only one of model, modelUrl, or cadModel",
+      path: ["model"],
+    },
+  )
+
+export type AssemblyPartPropsInput = z.input<typeof assemblyPartProps>
+
+expectTypesMatch<AssemblyPartProps, AssemblyPartPropsInput>(true)

package/lib/assembly/printedpart.ts

@@ -2,7 +2,7 @@ import { type CadModelProp, cadModelProp } from "lib/common/cadModel"
 import { url } from "lib/common/url"
 import { distance, type Distance } from "lib/common/distance"
 import { expectTypesMatch } from "lib/typecheck"
-import { isValidElement, type ReactElement } from "react"
+import { isValidElement, type ReactElement, type ReactNode } from "react"
 import { z } from "zod"
 
 /** Provide exactly one of jscad, model, modelUrl, or cadModel. */
@@ -10,6 +10,12 @@ export interface AssemblyPrintedPartProps {
   /** Stable identity used by assembly mounting selectors. */
   name: string
   displayName?: string
+  /** Color for the rendered printed part. Omit to retain authored materials. */
+  color?: string
+  /** Printable material classification; omitted when unspecified. */
+  material?: "pla" | "petg" | "nylon"
+  /** Reference surfaces defining named mounting frames, alongside CAD children. */
+  children?: ReactNode
   /** Pure jscad-fiber JSX in right-handed local XYZ, dimensions in millimeters.
    * Named reference rectangles define attachment faces; they add no material.
    * Hooks, async components, and raw kernel geometry are not supported.
@@ -36,6 +42,9 @@ export const assemblyPrintedPartProps = z
   .object({
     name: z.string().trim().min(1),
     displayName: z.string().optional(),
+    color: z.string().trim().min(1).optional(),
+    material: z.enum(["pla", "petg", "nylon"]).optional(),
+    children: z.custom<ReactNode>().optional(),
     jscad: z
       .custom<ReactElement>(isValidElement, "Expected jscad-fiber JSX")
       .optional(),

package/lib/assembly/referencesurface.ts

@@ -0,0 +1,80 @@
+import { type Distance, distance } from "lib/common/distance"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+/** A named, non-solid mounting frame in the owning part's local, right-handed
+ * XYZ (mm). Offsets locate its origin; its normal and tangent are directions.
+ */
+export interface AssemblyReferenceSurfaceProps {
+  /** Unique within the part; defaults to "anchor". Use PART.name to mount to it. */
+  name?: string
+  /** Reference shape; defaults to rect. Does not create solid geometry. */
+  shape?: "rect"
+  /** Defaults to xy. Positive normals: xy +Z, xz +Y, yz +X. */
+  plane?: "xy" | "xz" | "yz"
+  /** Outward normal, perpendicular to plane. Defaults: xy z+, xz y+, yz x+.
+   * Reversing the normal retains the local X tangent. Replaces positive/negative.
+   */
+  normalDirection?: "x+" | "x-" | "y+" | "y-" | "z+" | "z-"
+  /** Surface center offsets from the part origin, in mm or unit strings; each defaults to zero. */
+  centerXOffset?: Distance
+  centerYOffset?: Distance
+  centerZOffset?: Distance
+  /** Optional rectangular extents along the tangent and its perpendicular.
+   * Supply width and height together. Mounting uses the center, not the edges.
+   */
+  width?: Distance
+  height?: Distance
+}
+
+const offset = distance.pipe(z.number().finite())
+const extent = distance.pipe(z.number().positive().finite())
+
+export const assemblyReferenceSurfaceProps = z
+  .object({
+    name: z.string().trim().min(1).default("anchor"),
+    shape: z.literal("rect").default("rect"),
+    plane: z.enum(["xy", "xz", "yz"]).default("xy"),
+    normalDirection: z.enum(["x+", "x-", "y+", "y-", "z+", "z-"]).optional(),
+    centerXOffset: offset.default(0),
+    centerYOffset: offset.default(0),
+    centerZOffset: offset.default(0),
+    width: extent.optional(),
+    height: extent.optional(),
+  })
+  .refine(
+    (surface) =>
+      (surface.width === undefined) === (surface.height === undefined),
+    {
+      message: "Provide width and height together",
+      path: ["width"],
+    },
+  )
+  .superRefine((surface, ctx) => {
+    const normalAxis =
+      surface.plane === "xy" ? "z" : surface.plane === "xz" ? "y" : "x"
+    if (surface.normalDirection && surface.normalDirection[0] !== normalAxis)
+      ctx.addIssue({
+        code: z.ZodIssueCode.custom,
+        path: ["normalDirection"],
+        message: `normalDirection must be ${normalAxis}+ or ${normalAxis}- for plane ${surface.plane}`,
+      })
+  })
+  .transform((surface) => ({
+    ...surface,
+    normalDirection:
+      surface.normalDirection ??
+      (surface.plane === "xy"
+        ? ("z+" as const)
+        : surface.plane === "xz"
+          ? ("y+" as const)
+          : ("x+" as const)),
+  }))
+
+export type AssemblyReferenceSurfacePropsInput = z.input<
+  typeof assemblyReferenceSurfaceProps
+>
+expectTypesMatch<
+  AssemblyReferenceSurfaceProps,
+  AssemblyReferenceSurfacePropsInput
+>(true)

package/package.json

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