@tscircuit/props 0.0.717 → 0.0.719

package/lib/assembly/bom.ts

@@ -0,0 +1,26 @@
+import { supplierProps, type SupplierProps } from "lib/common/layout"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+
+/** Purchasing metadata shared by physical assembly elements, not CAD primitives. */
+export interface AssemblyBomProps extends SupplierProps {
+  /** Alternative HTTP(S) purchase links, independent of supplier part numbers.
+   * Omitted and empty arrays are accepted. No SKU-to-URL mapping is inferred.
+   */
+  purchaseUrls?: string[]
+}
+
+export const assemblyBomProps = supplierProps.extend({
+  purchaseUrls: z
+    .array(
+      z
+        .string()
+        .url()
+        .refine((value) => /^https?:\/\//i.test(value), {
+          message: "Purchase links must use HTTP or HTTPS",
+        }),
+    )
+    .optional(),
+})
+
+expectTypesMatch<AssemblyBomProps, z.input<typeof assemblyBomProps>>(true)

package/lib/assembly/cable.ts

@@ -1,9 +1,10 @@
+import { assemblyBomProps, type AssemblyBomProps } from "./bom"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
 export type AssemblyCableStandard = "usb_c"
 
-export interface AssemblyCableProps {
+export interface AssemblyCableProps extends AssemblyBomProps {
   /** Stable assembly identity for the cable. */
   name: string
   /** Start connector selector or named assembly reference, e.g. MOTOR.wireside. */
@@ -23,6 +24,7 @@ export interface AssemblyCableProps {
 
 export const assemblyCableProps = z
   .object({
+    ...assemblyBomProps.shape,
     name: z.string().trim().min(1),
     from: z.string().trim().min(1),
     to: z.string().trim().min(1),

package/lib/assembly/device.ts

@@ -1,8 +1,9 @@
+import { assemblyBomProps, type AssemblyBomProps } from "./bom"
 import { url } from "lib/common/url"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
-export interface AssemblyDeviceProps {
+export interface AssemblyDeviceProps extends AssemblyBomProps {
   /** Product-level assembly identity. */
   name?: string
   /** Imported CAD model URL. Mutually exclusive with cadModel where supported. */
@@ -13,6 +14,7 @@ export interface AssemblyDeviceProps {
 
 export const assemblyDeviceProps = z
   .object({
+    ...assemblyBomProps.shape,
     name: z.string().optional(),
     model: z.string().trim().min(1).optional(),
     modelUrl: url

package/lib/assembly/index.ts

@@ -12,6 +12,7 @@ import { assemblyScreenProps } from "./screen"
 import { assemblySubassemblyProps } from "./subassembly"
 import { assemblyExplosionProps } from "./explosion"
 
+export * from "./bom"
 export * from "./drawing"
 export * from "./board-mounting"
 export * from "./bolt"

package/lib/assembly/motor.ts

@@ -1,3 +1,4 @@
+import { assemblyBomProps, type AssemblyBomProps } from "./bom"
 import {
   type CadModelAxisDirection,
   cadModelAxisDirection,
@@ -12,7 +13,9 @@ import {
 
 export type AssemblyMotorStandard = "nema8" | "nema17" | "nema23"
 
-export interface AssemblyMotorProps extends AssemblyFaceMountProps {
+export interface AssemblyMotorProps
+  extends AssemblyFaceMountProps,
+    AssemblyBomProps {
   /** Stable assembly identity used by selectors. */
   name: string
   /** Human-facing alternate to the stable name. */
@@ -37,6 +40,7 @@ export interface AssemblyMotorProps extends AssemblyFaceMountProps {
 
 export const assemblyMotorProps = z
   .object({
+    ...assemblyBomProps.shape,
     ...assemblyFaceMountShape,
     name: z.string().refine((value) => value.trim().length > 0, {
       message: "name cannot be empty",

package/lib/assembly/part.ts

@@ -1,3 +1,4 @@
+import { assemblyBomProps, type AssemblyBomProps } from "./bom"
 import { type CadModelProp, cadModelProp } from "lib/common/cadModel"
 import { url } from "lib/common/url"
 import { expectTypesMatch } from "lib/typecheck"
@@ -10,7 +11,9 @@ import {
 } from "./face-mounting"
 
 /** A generic component of an assembly, with optional CAD geometry. */
-export interface AssemblyPartProps extends AssemblyFaceMountProps {
+export interface AssemblyPartProps
+  extends AssemblyFaceMountProps,
+    AssemblyBomProps {
   /** Stable identity used by assembly selectors. */
   name: string
   /** Human-facing alternate to the stable name. */
@@ -29,6 +32,7 @@ export interface AssemblyPartProps extends AssemblyFaceMountProps {
 // Keep model validation separate from ordinary face-mount pairing.
 export const assemblyPartBaseProps = z
   .object({
+    ...assemblyBomProps.shape,
     name: z.string().trim().min(1),
     displayName: z.string().optional(),
     model: z.string().trim().min(1).optional(),

package/lib/assembly/printedpart.ts

@@ -1,3 +1,4 @@
+import { assemblyBomProps, type AssemblyBomProps } from "./bom"
 import { type CadModelProp, cadModelProp } from "lib/common/cadModel"
 import { url } from "lib/common/url"
 import { expectTypesMatch } from "lib/typecheck"
@@ -10,7 +11,9 @@ import {
 } from "./face-mounting"
 
 /** Provide exactly one of jscad, model, modelUrl, or cadModel. */
-export interface AssemblyPrintedPartProps extends AssemblyFaceMountProps {
+export interface AssemblyPrintedPartProps
+  extends AssemblyFaceMountProps,
+    AssemblyBomProps {
   /** Stable identity used by assembly mounting selectors. */
   name: string
   displayName?: string
@@ -33,6 +36,7 @@ export interface AssemblyPrintedPartProps extends AssemblyFaceMountProps {
 
 export const assemblyPrintedPartProps = z
   .object({
+    ...assemblyBomProps.shape,
     ...assemblyFaceMountShape,
     name: z.string().trim().min(1),
     displayName: z.string().optional(),

package/lib/assembly/screen.ts

@@ -1,9 +1,10 @@
+import { assemblyBomProps, type AssemblyBomProps } from "./bom"
 import { url } from "lib/common/url"
 import { type Distance, distance } from "lib/common/distance"
 import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 
-export interface AssemblyScreenProps {
+export interface AssemblyScreenProps extends AssemblyBomProps {
   /** Stable product-level identity for the screen assembly. */
   name: string
   /** Imported CAD model URL. Mutually exclusive with cadModel where supported. */
@@ -41,6 +42,7 @@ const positiveDistance = (fieldName: "width" | "height") =>
 
 export const assemblyScreenProps = z
   .object({
+    ...assemblyBomProps.shape,
     name: nonemptyString("name"),
     model: z.string().trim().min(1).optional(),
     modelUrl: url

package/lib/assembly/subassembly.ts

@@ -1,3 +1,4 @@
+import { assemblyBomProps, type AssemblyBomProps } from "./bom"
 import { url } from "lib/common/url"
 import { type CadModelProp, cadModelProp } from "lib/common/cadModel"
 import { expectTypesMatch } from "lib/typecheck"
@@ -9,7 +10,9 @@ import {
   type AssemblyFaceMountProps,
 } from "./face-mounting"
 
-export interface AssemblySubassemblyProps extends AssemblyFaceMountProps {
+export interface AssemblySubassemblyProps
+  extends AssemblyFaceMountProps,
+    AssemblyBomProps {
   /** Stable identity used by selectors from other assembly elements. */
   name: string
   /** Imported CAD model URL. Mutually exclusive with cadModel where supported. */
@@ -26,6 +29,7 @@ export interface AssemblySubassemblyProps extends AssemblyFaceMountProps {
 
 export const assemblySubassemblyProps = z
   .object({
+    ...assemblyBomProps.shape,
     ...assemblyFaceMountShape,
     name: z.string().refine((value) => value.trim().length > 0, {
       message: "name cannot be empty",

package/lib/common/kicadFootprintMetadata.ts

@@ -62,19 +62,39 @@ export const kicadProperty = z.object({
 type InferredKicadProperty = z.input<typeof kicadProperty>
 expectTypesMatch<KicadProperty, InferredKicadProperty>(true)
 
+/** Built-in and custom property names share the same validated property shape. */
 export interface KicadFootprintProperties {
+  [propertyName: string]: KicadProperty | undefined
   Reference?: KicadProperty
   Value?: KicadProperty
   Datasheet?: KicadProperty
   Description?: KicadProperty
 }
 
-export const kicadFootprintProperties = z.object({
-  Reference: kicadProperty.optional(),
-  Value: kicadProperty.optional(),
-  Datasheet: kicadProperty.optional(),
-  Description: kicadProperty.optional(),
-})
+const kicadFootprintPropertiesSchema = z
+  .object({
+    Reference: kicadProperty.optional(),
+    Value: kicadProperty.optional(),
+    Datasheet: kicadProperty.optional(),
+    Description: kicadProperty.optional(),
+  })
+  .catchall(kicadProperty.optional())
+
+// Name the schema type so consumers retain the named properties without
+// expanding the catchall throughout generated package declarations.
+interface KicadFootprintPropertiesSchema
+  extends z.ZodObject<
+    typeof kicadFootprintPropertiesSchema.shape,
+    "strip",
+    z.ZodOptional<typeof kicadProperty>,
+    z.output<typeof kicadFootprintPropertiesSchema>,
+    KicadFootprintProperties
+  > {}
+
+export { type KicadFootprintPropertiesSchema }
+
+export const kicadFootprintProperties: KicadFootprintPropertiesSchema =
+  kicadFootprintPropertiesSchema
 
 type InferredKicadFootprintProperties = z.input<typeof kicadFootprintProperties>
 expectTypesMatch<KicadFootprintProperties, InferredKicadFootprintProperties>(

package/lib/common/kicadSymbolMetadata.ts

@@ -64,7 +64,9 @@ export const kicadSymbolProperty = z.object({
 type InferredKicadSymbolProperty = z.input<typeof kicadSymbolProperty>
 expectTypesMatch<KicadSymbolProperty, InferredKicadSymbolProperty>(true)
 
+/** Built-in and custom property names share the same validated property shape. */
 export interface KicadSymbolProperties {
+  [propertyName: string]: KicadSymbolProperty | undefined
   Reference?: KicadSymbolProperty
   Value?: KicadSymbolProperty
   Footprint?: KicadSymbolProperty
@@ -74,15 +76,33 @@ export interface KicadSymbolProperties {
   ki_fp_filters?: KicadSymbolProperty
 }
 
-export const kicadSymbolProperties = z.object({
-  Reference: kicadSymbolProperty.optional(),
-  Value: kicadSymbolProperty.optional(),
-  Footprint: kicadSymbolProperty.optional(),
-  Datasheet: kicadSymbolProperty.optional(),
-  Description: kicadSymbolProperty.optional(),
-  ki_keywords: kicadSymbolProperty.optional(),
-  ki_fp_filters: kicadSymbolProperty.optional(),
-})
+const kicadSymbolPropertiesSchema = z
+  .object({
+    Reference: kicadSymbolProperty.optional(),
+    Value: kicadSymbolProperty.optional(),
+    Footprint: kicadSymbolProperty.optional(),
+    Datasheet: kicadSymbolProperty.optional(),
+    Description: kicadSymbolProperty.optional(),
+    ki_keywords: kicadSymbolProperty.optional(),
+    ki_fp_filters: kicadSymbolProperty.optional(),
+  })
+  .catchall(kicadSymbolProperty.optional())
+
+// Name the schema type so consumers retain the named properties without
+// expanding the catchall throughout generated package declarations.
+interface KicadSymbolPropertiesSchema
+  extends z.ZodObject<
+    typeof kicadSymbolPropertiesSchema.shape,
+    "strip",
+    z.ZodOptional<typeof kicadSymbolProperty>,
+    z.output<typeof kicadSymbolPropertiesSchema>,
+    KicadSymbolProperties
+  > {}
+
+export { type KicadSymbolPropertiesSchema }
+
+export const kicadSymbolProperties: KicadSymbolPropertiesSchema =
+  kicadSymbolPropertiesSchema
 
 type InferredKicadSymbolProperties = z.input<typeof kicadSymbolProperties>
 expectTypesMatch<KicadSymbolProperties, InferredKicadSymbolProperties>(true)

package/package.json

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