@tscircuit/props 0.0.448 → 0.0.450

package/lib/common/kicadSymbolMetadata.ts

@@ -0,0 +1,115 @@
+import { distance } from "circuit-json"
+import { expectTypesMatch } from "lib/typecheck"
+import { z } from "zod"
+import {
+  kicadAt,
+  kicadFont,
+  type KicadAt,
+  type KicadFont,
+} from "./kicadFootprintMetadata"
+
+export interface KicadSymbolPinNumbers {
+  hide?: boolean
+}
+
+export const kicadSymbolPinNumbers = z.object({
+  hide: z.boolean().optional(),
+})
+
+type InferredKicadSymbolPinNumbers = z.input<typeof kicadSymbolPinNumbers>
+expectTypesMatch<KicadSymbolPinNumbers, InferredKicadSymbolPinNumbers>(true)
+
+export interface KicadSymbolPinNames {
+  offset?: number | string
+  hide?: boolean
+}
+
+export const kicadSymbolPinNames = z.object({
+  offset: distance.optional(),
+  hide: z.boolean().optional(),
+})
+
+type InferredKicadSymbolPinNames = z.input<typeof kicadSymbolPinNames>
+expectTypesMatch<KicadSymbolPinNames, InferredKicadSymbolPinNames>(true)
+
+export interface KicadSymbolEffects {
+  font?: KicadFont
+  justify?: string | string[]
+  hide?: boolean
+}
+
+export const kicadSymbolEffects = z.object({
+  font: kicadFont.optional(),
+  justify: z.union([z.string(), z.array(z.string())]).optional(),
+  hide: z.boolean().optional(),
+})
+
+type InferredKicadSymbolEffects = z.input<typeof kicadSymbolEffects>
+expectTypesMatch<KicadSymbolEffects, InferredKicadSymbolEffects>(true)
+
+export interface KicadSymbolProperty {
+  value: string
+  id?: number | string
+  at?: KicadAt
+  effects?: KicadSymbolEffects
+}
+
+export const kicadSymbolProperty = z.object({
+  value: z.string(),
+  id: z.union([z.number(), z.string()]).optional(),
+  at: kicadAt.optional(),
+  effects: kicadSymbolEffects.optional(),
+})
+
+type InferredKicadSymbolProperty = z.input<typeof kicadSymbolProperty>
+expectTypesMatch<KicadSymbolProperty, InferredKicadSymbolProperty>(true)
+
+export interface KicadSymbolProperties {
+  Reference?: KicadSymbolProperty
+  Value?: KicadSymbolProperty
+  Footprint?: KicadSymbolProperty
+  Datasheet?: KicadSymbolProperty
+  Description?: KicadSymbolProperty
+  ki_keywords?: KicadSymbolProperty
+  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(),
+})
+
+type InferredKicadSymbolProperties = z.input<typeof kicadSymbolProperties>
+expectTypesMatch<KicadSymbolProperties, InferredKicadSymbolProperties>(true)
+
+export interface KicadSymbolMetadata {
+  symbolName?: string
+  extends?: string
+  pinNumbers?: KicadSymbolPinNumbers
+  pinNames?: KicadSymbolPinNames
+  excludeFromSim?: boolean
+  inBom?: boolean
+  onBoard?: boolean
+  properties?: KicadSymbolProperties
+  embeddedFonts?: boolean
+}
+
+export const kicadSymbolMetadata = z.object({
+  symbolName: z.string().optional(),
+  extends: z.string().optional(),
+  pinNumbers: kicadSymbolPinNumbers.optional(),
+  pinNames: kicadSymbolPinNames.optional(),
+  excludeFromSim: z.boolean().optional(),
+  inBom: z.boolean().optional(),
+  onBoard: z.boolean().optional(),
+  properties: kicadSymbolProperties.optional(),
+  embeddedFonts: z.boolean().optional(),
+})
+
+type InferredKicadSymbolMetadata = z.input<typeof kicadSymbolMetadata>
+expectTypesMatch<KicadSymbolMetadata, InferredKicadSymbolMetadata>(true)

package/lib/common/layout.ts

@@ -14,6 +14,10 @@ import {
   type KicadFootprintMetadata,
   kicadFootprintMetadata,
 } from "./kicadFootprintMetadata"
+import {
+  type KicadSymbolMetadata,
+  kicadSymbolMetadata,
+} from "./kicadSymbolMetadata"
 import { pcbStyle, type PcbStyle } from "./pcbStyle"
 import { schStyle, type SchStyle } from "./schStyle"
 import { type SymbolProp, symbolProp } from "./symbolProp"
@@ -253,6 +257,7 @@ export interface CommonComponentProps<PinLabel extends string = string>
   supplierPartNumbers?: SupplierPartNumbers
   cadModel?: CadModelProp
   kicadFootprintMetadata?: KicadFootprintMetadata
+  kicadSymbolMetadata?: KicadSymbolMetadata
   children?: any
   symbolName?: string
   doNotPlace?: boolean
@@ -266,6 +271,7 @@ export interface CommonComponentProps<PinLabel extends string = string>
    * Whether to show this component's CAD model as translucent in the 3D viewer.
    */
   showAsTranslucentModel?: boolean
+  mfn?: string
 }
 
 export const commonComponentProps = commonLayoutProps
@@ -277,6 +283,7 @@ export const commonComponentProps = commonLayoutProps
     datasheetUrl: z.string().optional(),
     cadModel: cadModelProp.optional(),
     kicadFootprintMetadata: kicadFootprintMetadata.optional(),
+    kicadSymbolMetadata: kicadSymbolMetadata.optional(),
     children: z.any().optional(),
     symbolName: z.string().optional(),
     doNotPlace: z.boolean().optional(),
@@ -293,6 +300,7 @@ export const commonComponentProps = commonLayoutProps
         "Whether to show this component's CAD model as translucent in the 3D viewer.",
       ),
     pinAttributes: z.record(z.string(), pinAttributeMap).optional(),
+    mfn: z.string().describe("Manufacturer Part Number").optional(),
   })
 
 type InferredCommonComponentProps = z.input<typeof commonComponentProps>

package/lib/index.ts

@@ -15,6 +15,7 @@ export * from "./common/cadModel"
 export * from "./common/schematicPinLabel"
 export * from "./common/schematicSize"
 export * from "./common/kicadFootprintMetadata"
+export * from "./common/kicadSymbolMetadata"
 
 export * from "./components/board"
 export * from "./components/panel"

package/package.json

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