@tscircuit/props 0.0.688 → 0.0.689

package/README.md

@@ -632,6 +632,7 @@ export interface CadAssemblyProps {
 
 ```ts
 export interface CadModelProps extends CadModelBase {
+  /** Canonical model URL after parsing; authored model strings resolve to this field. */
   modelUrl: string;
   stepUrl?: string;
   pcbX?: Distance;

package/dist/index.d.ts

@@ -217975,7 +217975,9 @@ declare const cadassemblyProps: z.ZodObject<{
 }>;
 type CadAssemblyPropsInput = z.input<typeof cadassemblyProps>;
 
+/** Parsed CAD model props. Author model strings with CadModelPropsInput. */
 interface CadModelProps extends CadModelBase {
+    /** Canonical model URL after parsing; authored model strings resolve to this field. */
     modelUrl: string;
     stepUrl?: string;
     pcbX?: Distance;
@@ -217988,7 +217990,435 @@ interface CadModelProps extends CadModelBase {
     pcbOffsetY?: Distance;
     pcbZ?: Distance;
 }
-declare const cadmodelProps: z.ZodUnion<[z.ZodNull, z.ZodType<string, z.ZodTypeDef, string>, z.ZodObject<{
+/**
+ * Object inputs require exactly one of model or modelUrl. Modelprinter strings
+ * are trimmed and resolved to modelUrl; HTTP(S) model URLs are preserved.
+ * Parsed objects retain the existing CadModelProps shape, without a model field.
+ * Existing modelUrl objects, bare URL strings, and null remain supported.
+ */
+declare const cadmodelProps: z.ZodUnion<[z.ZodNull, z.ZodType<string, z.ZodTypeDef, string>, z.ZodPipeline<z.ZodEffects<z.ZodEffects<z.ZodObject<{
+    rotationOffset: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodObject<{
+        x: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+        y: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+        z: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+    }, "strip", z.ZodTypeAny, {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    }, {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    }>]>>;
+    positionOffset: z.ZodOptional<z.ZodObject<{
+        x: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+        y: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+        z: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+    }, "strip", z.ZodTypeAny, {
+        x: number;
+        y: number;
+        z: number;
+    }, {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    }>>;
+    modelOriginPosition: z.ZodOptional<z.ZodObject<{
+        x: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+        y: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+        z: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+    }, "strip", z.ZodTypeAny, {
+        x: number;
+        y: number;
+        z: number;
+    }, {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    }>>;
+    modelBounds: z.ZodOptional<z.ZodObject<{
+        min: z.ZodObject<{
+            x: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+            y: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+            z: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+        }, "strip", z.ZodTypeAny, {
+            x: number;
+            y: number;
+            z: number;
+        }, {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        }>;
+        max: z.ZodObject<{
+            x: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+            y: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+            z: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+        }, "strip", z.ZodTypeAny, {
+            x: number;
+            y: number;
+            z: number;
+        }, {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    }, {
+        min: {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        };
+        max: {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        };
+    }>>;
+    size: z.ZodOptional<z.ZodObject<{
+        x: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+        y: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+        z: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
+    }, "strip", z.ZodTypeAny, {
+        x: number;
+        y: number;
+        z: number;
+    }, {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    }>>;
+    modelUnitToMmScale: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
+    modelBoardNormalDirection: z.ZodOptional<z.ZodEnum<["x+", "x-", "y+", "y-", "z+", "z-"]>>;
+    pcbRotationOffset: z.ZodOptional<z.ZodNumber>;
+    zOffsetFromSurface: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
+    showAsTranslucentModel: z.ZodOptional<z.ZodBoolean>;
+    stepUrl: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+} & {
+    /** Modelprinter specification or HTTP(S) URL; mutually exclusive with modelUrl. */
+    model: z.ZodOptional<z.ZodString>;
+    modelUrl: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+} & {
+    pcbX: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>]>>;
+    pcbY: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>]>>;
+    pcbLeftEdgeX: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>]>>;
+    pcbRightEdgeX: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>]>>;
+    pcbTopEdgeY: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>]>>;
+    pcbBottomEdgeY: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>]>>;
+    pcbOffsetX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
+    pcbOffsetY: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
+    pcbZ: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
+}, "strip", z.ZodTypeAny, {
+    rotationOffset?: number | {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    positionOffset?: {
+        x: number;
+        y: number;
+        z: number;
+    } | undefined;
+    modelOriginPosition?: {
+        x: number;
+        y: number;
+        z: number;
+    } | undefined;
+    modelBounds?: {
+        min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    } | undefined;
+    size?: {
+        x: number;
+        y: number;
+        z: number;
+    } | undefined;
+    modelUnitToMmScale?: number | undefined;
+    modelBoardNormalDirection?: "x+" | "x-" | "y+" | "y-" | "z+" | "z-" | undefined;
+    pcbRotationOffset?: number | undefined;
+    zOffsetFromSurface?: number | undefined;
+    showAsTranslucentModel?: boolean | undefined;
+    stepUrl?: string | undefined;
+    model?: string | undefined;
+    modelUrl?: string | undefined;
+    pcbX?: string | number | undefined;
+    pcbY?: string | number | undefined;
+    pcbLeftEdgeX?: string | number | undefined;
+    pcbRightEdgeX?: string | number | undefined;
+    pcbTopEdgeY?: string | number | undefined;
+    pcbBottomEdgeY?: string | number | undefined;
+    pcbOffsetX?: number | undefined;
+    pcbOffsetY?: number | undefined;
+    pcbZ?: number | undefined;
+}, {
+    rotationOffset?: number | {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    positionOffset?: {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    modelOriginPosition?: {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    modelBounds?: {
+        min: {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        };
+        max: {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        };
+    } | undefined;
+    size?: {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    modelUnitToMmScale?: string | number | undefined;
+    modelBoardNormalDirection?: "x+" | "x-" | "y+" | "y-" | "z+" | "z-" | undefined;
+    pcbRotationOffset?: number | undefined;
+    zOffsetFromSurface?: string | number | undefined;
+    showAsTranslucentModel?: boolean | undefined;
+    stepUrl?: string | undefined;
+    model?: string | undefined;
+    modelUrl?: string | undefined;
+    pcbX?: string | number | undefined;
+    pcbY?: string | number | undefined;
+    pcbLeftEdgeX?: string | number | undefined;
+    pcbRightEdgeX?: string | number | undefined;
+    pcbTopEdgeY?: string | number | undefined;
+    pcbBottomEdgeY?: string | number | undefined;
+    pcbOffsetX?: string | number | undefined;
+    pcbOffsetY?: string | number | undefined;
+    pcbZ?: string | number | undefined;
+}>, {
+    rotationOffset?: number | {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    positionOffset?: {
+        x: number;
+        y: number;
+        z: number;
+    } | undefined;
+    modelOriginPosition?: {
+        x: number;
+        y: number;
+        z: number;
+    } | undefined;
+    modelBounds?: {
+        min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    } | undefined;
+    size?: {
+        x: number;
+        y: number;
+        z: number;
+    } | undefined;
+    modelUnitToMmScale?: number | undefined;
+    modelBoardNormalDirection?: "x+" | "x-" | "y+" | "y-" | "z+" | "z-" | undefined;
+    pcbRotationOffset?: number | undefined;
+    zOffsetFromSurface?: number | undefined;
+    showAsTranslucentModel?: boolean | undefined;
+    stepUrl?: string | undefined;
+    model?: string | undefined;
+    modelUrl?: string | undefined;
+    pcbX?: string | number | undefined;
+    pcbY?: string | number | undefined;
+    pcbLeftEdgeX?: string | number | undefined;
+    pcbRightEdgeX?: string | number | undefined;
+    pcbTopEdgeY?: string | number | undefined;
+    pcbBottomEdgeY?: string | number | undefined;
+    pcbOffsetX?: number | undefined;
+    pcbOffsetY?: number | undefined;
+    pcbZ?: number | undefined;
+}, {
+    rotationOffset?: number | {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    positionOffset?: {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    modelOriginPosition?: {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    modelBounds?: {
+        min: {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        };
+        max: {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        };
+    } | undefined;
+    size?: {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    modelUnitToMmScale?: string | number | undefined;
+    modelBoardNormalDirection?: "x+" | "x-" | "y+" | "y-" | "z+" | "z-" | undefined;
+    pcbRotationOffset?: number | undefined;
+    zOffsetFromSurface?: string | number | undefined;
+    showAsTranslucentModel?: boolean | undefined;
+    stepUrl?: string | undefined;
+    model?: string | undefined;
+    modelUrl?: string | undefined;
+    pcbX?: string | number | undefined;
+    pcbY?: string | number | undefined;
+    pcbLeftEdgeX?: string | number | undefined;
+    pcbRightEdgeX?: string | number | undefined;
+    pcbTopEdgeY?: string | number | undefined;
+    pcbBottomEdgeY?: string | number | undefined;
+    pcbOffsetX?: string | number | undefined;
+    pcbOffsetY?: string | number | undefined;
+    pcbZ?: string | number | undefined;
+}>, {
+    modelUrl: string;
+    rotationOffset?: number | {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    positionOffset?: {
+        x: number;
+        y: number;
+        z: number;
+    } | undefined;
+    modelOriginPosition?: {
+        x: number;
+        y: number;
+        z: number;
+    } | undefined;
+    modelBounds?: {
+        min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    } | undefined;
+    size?: {
+        x: number;
+        y: number;
+        z: number;
+    } | undefined;
+    modelUnitToMmScale?: number | undefined;
+    modelBoardNormalDirection?: "x+" | "x-" | "y+" | "y-" | "z+" | "z-" | undefined;
+    pcbRotationOffset?: number | undefined;
+    zOffsetFromSurface?: number | undefined;
+    showAsTranslucentModel?: boolean | undefined;
+    stepUrl?: string | undefined;
+    pcbX?: string | number | undefined;
+    pcbY?: string | number | undefined;
+    pcbLeftEdgeX?: string | number | undefined;
+    pcbRightEdgeX?: string | number | undefined;
+    pcbTopEdgeY?: string | number | undefined;
+    pcbBottomEdgeY?: string | number | undefined;
+    pcbOffsetX?: number | undefined;
+    pcbOffsetY?: number | undefined;
+    pcbZ?: number | undefined;
+}, {
+    rotationOffset?: number | {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    positionOffset?: {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    modelOriginPosition?: {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    modelBounds?: {
+        min: {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        };
+        max: {
+            x: string | number;
+            y: string | number;
+            z: string | number;
+        };
+    } | undefined;
+    size?: {
+        x: string | number;
+        y: string | number;
+        z: string | number;
+    } | undefined;
+    modelUnitToMmScale?: string | number | undefined;
+    modelBoardNormalDirection?: "x+" | "x-" | "y+" | "y-" | "z+" | "z-" | undefined;
+    pcbRotationOffset?: number | undefined;
+    zOffsetFromSurface?: string | number | undefined;
+    showAsTranslucentModel?: boolean | undefined;
+    stepUrl?: string | undefined;
+    model?: string | undefined;
+    modelUrl?: string | undefined;
+    pcbX?: string | number | undefined;
+    pcbY?: string | number | undefined;
+    pcbLeftEdgeX?: string | number | undefined;
+    pcbRightEdgeX?: string | number | undefined;
+    pcbTopEdgeY?: string | number | undefined;
+    pcbBottomEdgeY?: string | number | undefined;
+    pcbOffsetX?: string | number | undefined;
+    pcbOffsetY?: string | number | undefined;
+    pcbZ?: string | number | undefined;
+}>, z.ZodObject<{
     rotationOffset: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodObject<{
         x: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
         y: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
@@ -218207,7 +218637,7 @@ declare const cadmodelProps: z.ZodUnion<[z.ZodNull, z.ZodType<string, z.ZodTypeD
     pcbOffsetX?: string | number | undefined;
     pcbOffsetY?: string | number | undefined;
     pcbZ?: string | number | undefined;
-}>]>;
+}>>]>;
 type CadModelPropsInput = z.input<typeof cadmodelProps>;
 
 declare const powerSourceProps: z.ZodObject<{

package/dist/index.js

@@ -19293,7 +19293,22 @@ var cadModelBaseWithUrl = cadModelBase.extend({
 });
 var cadModelObject = cadModelBaseWithUrl.merge(pcbPosition);
 expectTypesMatch(true);
-var cadmodelProps = z128.union([z128.null(), url, cadModelObject]);
+var cadModelInputObject = cadModelBase.extend({
+  /** Modelprinter specification or HTTP(S) URL; mutually exclusive with modelUrl. */
+  model: z128.string().trim().min(1).optional(),
+  modelUrl: url.optional()
+}).merge(pcbPosition).refine(
+  (props) => props.model === void 0 !== (props.modelUrl === void 0),
+  {
+    message: "Provide exactly one of model or modelUrl",
+    path: ["model"]
+  }
+).transform(({ model, ...props }) => ({
+  ...props,
+  modelUrl: model === void 0 ? props.modelUrl : /^https?:\/\//i.test(model) ? model : `https://modelcdn.tscircuit.com/jscad_models/${encodeURIComponent(model)}.glb`
+})).pipe(cadModelObject);
+expectTypesMatch(true);
+var cadmodelProps = z128.union([z128.null(), url, cadModelInputObject]);
 
 // lib/components/power-source.ts
 import { voltage as voltage5 } from "circuit-json";