@tscircuit/props 0.0.669 → 0.0.671

package/lib/assembly/device.ts

@@ -1,14 +1,33 @@
+import { url } from "lib/common/url"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
 export interface AssemblyDeviceProps {
   /** Product-level assembly identity. */
   name?: string
+  /** Imported CAD model URL. Mutually exclusive with cadModel where supported. */
+  modelUrl?: string
+  /** Modelprinter/footprinter string, trimmed; mutually exclusive with other model sources. */
+  model?: string
 }
 
-export const assemblyDeviceProps = z.object({
-  name: z.string().optional(),
-})
+export const assemblyDeviceProps = z
+  .object({
+    name: z.string().optional(),
+    model: z.string().trim().min(1).optional(),
+    modelUrl: url
+      .refine((value) => value.trim().length > 0, {
+        message: "modelUrl cannot be empty",
+      })
+      .optional(),
+  })
+  .refine(
+    (device) => device.model === undefined || device.modelUrl === undefined,
+    {
+      message: "Provide either model or modelUrl, not both",
+      path: ["model"],
+    },
+  )
 
 export type AssemblyDevicePropsInput = z.input<typeof assemblyDeviceProps>
 

package/lib/assembly/screen.ts

@@ -1,3 +1,4 @@
+import { url } from "lib/common/url"
 import { type Distance, distance } from "lib/common/distance"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
@@ -5,6 +6,10 @@ import { z } from "zod"
 export interface AssemblyScreenProps {
   /** Stable product-level identity for the screen assembly. */
   name: string
+  /** Imported CAD model URL. Mutually exclusive with cadModel where supported. */
+  modelUrl?: string
+  /** Modelprinter/footprinter string, trimmed; mutually exclusive with other model sources. */
+  model?: string
   /** Selector for the connector that the screen attaches to. */
   connectsTo: string
   /**
@@ -19,7 +24,7 @@ export interface AssemblyScreenProps {
   height?: Distance
   /**
    * Advanced modelprinter string used to render the screen assembly. Required
-   * when `width` and `height` are omitted.
+   * when `width`, `height`, `model`, and `modelUrl` are omitted.
    */
   cadModel?: string
 }
@@ -37,12 +42,35 @@ const positiveDistance = (fieldName: "width" | "height") =>
 export const assemblyScreenProps = z
   .object({
     name: nonemptyString("name"),
+    model: z.string().trim().min(1).optional(),
+    modelUrl: url
+      .refine((value) => value.trim().length > 0, {
+        message: "modelUrl cannot be empty",
+      })
+      .optional(),
     connectsTo: nonemptyString("connectsTo"),
     width: positiveDistance("width").optional(),
     height: positiveDistance("height").optional(),
     cadModel: nonemptyString("cadModel").optional(),
   })
   .superRefine((screen, context) => {
+    if (
+      screen.model !== undefined &&
+      (screen.modelUrl !== undefined || screen.cadModel !== undefined)
+    ) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "Provide only one of model, modelUrl, or cadModel",
+        path: ["model"],
+      })
+    }
+    if (screen.modelUrl !== undefined && screen.cadModel !== undefined) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "Provide either modelUrl or cadModel, not both",
+        path: ["modelUrl"],
+      })
+    }
     const hasWidth = screen.width !== undefined
     const hasHeight = screen.height !== undefined
 
@@ -55,10 +83,15 @@ export const assemblyScreenProps = z
       return
     }
 
-    if (!hasWidth && screen.cadModel === undefined) {
+    if (
+      !hasWidth &&
+      screen.cadModel === undefined &&
+      screen.modelUrl === undefined &&
+      screen.model === undefined
+    ) {
       context.addIssue({
         code: z.ZodIssueCode.custom,
-        message: "provide either width and height or cadModel",
+        message: "provide width and height, model, cadModel, or modelUrl",
         path: [],
       })
     }

package/lib/assembly/subassembly.ts

@@ -1,3 +1,4 @@
+import { url } from "lib/common/url"
 import { type CadModelProp, cadModelProp } from "lib/common/cadModel"
 import { expectTypesMatch } from "lib/typecheck"
 import type { ReactNode } from "react"
@@ -6,6 +7,10 @@ import { z } from "zod"
 export interface AssemblySubassemblyProps {
   /** Stable identity used by selectors from other assembly elements. */
   name: string
+  /** Imported CAD model URL. Mutually exclusive with cadModel where supported. */
+  modelUrl?: string
+  /** Modelprinter/footprinter string, trimmed; mutually exclusive with other model sources. */
+  model?: string
   /** Human-facing alternate to the stable name. */
   displayName?: string
   /** Optional CAD geometry using the existing component cadModel formats. */
@@ -14,14 +19,38 @@ export interface AssemblySubassemblyProps {
   children?: ReactNode
 }
 
-export const assemblySubassemblyProps = z.object({
-  name: z.string().refine((value) => value.trim().length > 0, {
-    message: "name cannot be empty",
-  }),
-  displayName: z.string().optional(),
-  cadModel: cadModelProp.optional(),
-  children: z.custom<ReactNode>().optional(),
-})
+export const assemblySubassemblyProps = z
+  .object({
+    name: z.string().refine((value) => value.trim().length > 0, {
+      message: "name cannot be empty",
+    }),
+    displayName: z.string().optional(),
+    model: z.string().trim().min(1).optional(),
+    modelUrl: url
+      .refine((value) => value.trim().length > 0, {
+        message: "modelUrl cannot be empty",
+      })
+      .optional(),
+    cadModel: cadModelProp.optional(),
+    children: z.custom<ReactNode>().optional(),
+  })
+  .refine(
+    (assembly) =>
+      assembly.modelUrl === undefined || assembly.cadModel === undefined,
+    {
+      message: "Provide either modelUrl or cadModel, not both",
+      path: ["modelUrl"],
+    },
+  )
+  .refine(
+    (assembly) =>
+      assembly.model === undefined ||
+      (assembly.modelUrl === undefined && assembly.cadModel === undefined),
+    {
+      message: "Provide only one of model, modelUrl, or cadModel",
+      path: ["model"],
+    },
+  )
 
 export type AssemblySubassemblyPropsInput = z.input<
   typeof assemblySubassemblyProps

package/package.json

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