@tscircuit/props 0.0.695 → 0.0.696

package/lib/assembly/index.ts

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

package/lib/assembly/part.ts

@@ -0,0 +1,43 @@
+import { type CadModelProp, cadModelProp } from "lib/common/cadModel"
+import { url } from "lib/common/url"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+/** 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
+}
+
+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(),
+  })
+  .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/package.json

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