@tscircuit/props 0.0.340 → 0.0.342

package/lib/components/board.ts

@@ -1,3 +1,4 @@
+import type { AutocompleteString } from "lib/common/autocomplete"
 import { distance, type Distance } from "lib/common/distance"
 import { ninePointAnchor } from "lib/common/ninePointAnchor"
 import { type Point, point } from "lib/common/point"
@@ -5,6 +6,23 @@ import { expectTypesMatch } from "lib/typecheck"
 import { z } from "zod"
 import { subcircuitGroupProps, type SubcircuitGroupProps } from "./group"
 
+const boardColorPresets = [
+  "not_specified",
+  "green",
+  "red",
+  "blue",
+  "purple",
+  "black",
+  "white",
+  "yellow",
+] as const
+
+export type BoardColorPreset = (typeof boardColorPresets)[number]
+
+export type BoardColor = AutocompleteString<BoardColorPreset>
+
+const boardColor = z.custom<BoardColor>((value) => typeof value === "string")
+
 export interface BoardProps extends Omit<SubcircuitGroupProps, "subcircuit"> {
   material?: "fr4" | "fr1"
   /** Number of layers for the PCB */
@@ -12,6 +30,18 @@ export interface BoardProps extends Omit<SubcircuitGroupProps, "subcircuit"> {
   borderRadius?: Distance
   boardAnchorPosition?: Point
   boardAnchorAlignment?: z.infer<typeof ninePointAnchor>
+  /** Color applied to both top and bottom solder masks */
+  solderMaskColor?: BoardColor
+  /** Color of the top solder mask */
+  topSolderMaskColor?: BoardColor
+  /** Color of the bottom solder mask */
+  bottomSolderMaskColor?: BoardColor
+  /** Color applied to both top and bottom silkscreens */
+  silkscreenColor?: BoardColor
+  /** Color of the top silkscreen */
+  topSilkscreenColor?: BoardColor
+  /** Color of the bottom silkscreen */
+  bottomSilkscreenColor?: BoardColor
 }
 
 export const boardProps = subcircuitGroupProps.extend({
@@ -20,6 +50,12 @@ export const boardProps = subcircuitGroupProps.extend({
   borderRadius: distance.optional(),
   boardAnchorPosition: point.optional(),
   boardAnchorAlignment: ninePointAnchor.optional(),
+  solderMaskColor: boardColor.optional(),
+  topSolderMaskColor: boardColor.optional(),
+  bottomSolderMaskColor: boardColor.optional(),
+  silkscreenColor: boardColor.optional(),
+  topSilkscreenColor: boardColor.optional(),
+  bottomSilkscreenColor: boardColor.optional(),
 })
 
 type InferredBoardProps = z.input<typeof boardProps>

package/lib/platformConfig.ts

@@ -17,6 +17,17 @@ export interface FootprintFileParserEntry {
   loadFromUrl: (url: string) => Promise<FootprintLibraryResult>
 }
 
+export type CircuitJson = any[]
+
+export interface SpiceEngineSimulationResult {
+  engineVersionString?: string
+  simulationResultCircuitJson: CircuitJson
+}
+
+export interface SpiceEngine {
+  simulate: (spiceString: string) => Promise<SpiceEngineSimulationResult>
+}
+
 export interface PlatformConfig {
   partsEngine?: PartsEngine
 
@@ -39,6 +50,8 @@ export interface PlatformConfig {
   schematicDisabled?: boolean
   partsEngineDisabled?: boolean
 
+  spiceEngine?: SpiceEngine
+
   footprintLibraryMap?: Record<
     string,
     | ((path: string) => Promise<FootprintLibraryResult>)
@@ -72,6 +85,21 @@ const footprintFileParserEntry = z.object({
     ),
 })
 
+const spiceEngineSimulationResult = z.object({
+  engineVersionString: z.string().optional(),
+  simulationResultCircuitJson: unvalidatedCircuitJson,
+})
+
+const spiceEngineZod = z.object({
+  simulate: z
+    .function()
+    .args(z.string())
+    .returns(z.promise(spiceEngineSimulationResult))
+    .describe(
+      "A function that takes a SPICE string and returns a simulation result",
+    ),
+})
+
 export const platformConfig = z.object({
   partsEngine: partsEngine.optional(),
   autorouter: autorouterProp.optional(),
@@ -86,6 +114,7 @@ export const platformConfig = z.object({
   pcbDisabled: z.boolean().optional(),
   schematicDisabled: z.boolean().optional(),
   partsEngineDisabled: z.boolean().optional(),
+  spiceEngine: spiceEngineZod.optional(),
   footprintLibraryMap: z
     .record(
       z.string(),

package/package.json

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