@tscircuit/props 0.0.644 → 0.0.645

package/lib/assembly/index.ts

@@ -1,7 +1,10 @@
 import { assemblyDeviceProps } from "./device"
+import { assemblyScreenProps } from "./screen"
 
 export * from "./device"
+export * from "./screen"
 
 export const assemblyProps = {
   device: assemblyDeviceProps,
+  screen: assemblyScreenProps,
 } as const

package/lib/assembly/screen.ts

@@ -0,0 +1,69 @@
+import { type Distance, distance } from "lib/common/distance"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+export interface AssemblyScreenProps {
+  /** Stable product-level identity for the screen assembly. */
+  name: string
+  /** Selector for the connector that the screen attaches to. */
+  connectsTo: string
+  /**
+   * Outer width of the screen body, including its bezel but excluding the flex
+   * cable. When supplied, it must be provided together with `height`.
+   */
+  width?: Distance
+  /**
+   * Outer height of the screen body, including its bezel but excluding the flex
+   * cable. When supplied, it must be provided together with `width`.
+   */
+  height?: Distance
+  /**
+   * Advanced modelprinter string used to render the screen assembly. Required
+   * when `width` and `height` are omitted.
+   */
+  cadModel?: string
+}
+
+const nonemptyString = (fieldName: "name" | "connectsTo" | "cadModel") =>
+  z.string().refine((value) => value.trim().length > 0, {
+    message: `${fieldName} cannot be empty`,
+  })
+
+const positiveDistance = (fieldName: "width" | "height") =>
+  distance.refine((value) => Number.isFinite(value) && value > 0, {
+    message: `${fieldName} must be a positive finite distance`,
+  })
+
+export const assemblyScreenProps = z
+  .object({
+    name: nonemptyString("name"),
+    connectsTo: nonemptyString("connectsTo"),
+    width: positiveDistance("width").optional(),
+    height: positiveDistance("height").optional(),
+    cadModel: nonemptyString("cadModel").optional(),
+  })
+  .superRefine((screen, context) => {
+    const hasWidth = screen.width !== undefined
+    const hasHeight = screen.height !== undefined
+
+    if (hasWidth !== hasHeight) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "width and height must be provided together",
+        path: hasWidth ? ["height"] : ["width"],
+      })
+      return
+    }
+
+    if (!hasWidth && screen.cadModel === undefined) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "provide either width and height or cadModel",
+        path: [],
+      })
+    }
+  })
+
+export type AssemblyScreenPropsInput = z.input<typeof assemblyScreenProps>
+
+expectTypesMatch<AssemblyScreenProps, AssemblyScreenPropsInput>(true)

package/package.json

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