fix: Merge pull request #26 from tscircuit/schematic-path

Schematic Path Support

src/lib/builder/schematic-symbol-builder/schematic-path-builder.ts

@@ -0,0 +1,34 @@
+import { Dimension, SchematicPath } from "lib/types"
+import { ProjectBuilder } from "../project-builder"
+import { createSimpleDataBuilderClass } from "../simple-data-builder"
+
+export type SchematicPathBuilderFields = Partial<
+  Omit<SchematicPath, "position"> & {
+    position: { x: Dimension; y: Dimension }
+  }
+>
+
+export interface SchematicPathBuilder {
+  builder_type: "schematic_path_builder"
+  props: SchematicPathBuilderFields
+  setProps(props: Partial<SchematicPathBuilderFields>): SchematicPathBuilder
+  build(): Omit<SchematicPathBuilderFields, "x" | "y"> & {
+    x: Dimension
+    y: Dimension
+  }
+}
+
+export const SchematicPathBuilder = createSimpleDataBuilderClass(
+  "schematic_path_builder",
+  {
+    type: "schematic_path",
+    points: [],
+  } as SchematicPathBuilder["props"],
+  ["position"]
+)
+
+export const createSchematicPathBuilder = (
+  project_builder: ProjectBuilder
+): SchematicPathBuilder => {
+  return new SchematicPathBuilder(project_builder) as any
+}

src/lib/builder/schematic-symbol-builder/schematic-symbol-builder.ts

@@ -13,11 +13,13 @@ import {
   SchematicTextBuilder,
   createSchematicTextBuilder,
 } from "./schematic-text-builder"
+import { createSchematicPathBuilder } from "./schematic-path-builder"
 
 const schematic_symbol_addables = {
   schematic_box: createSchematicBoxBuilder,
   schematic_line: createSchematicLineBuilder,
   schematic_text: createSchematicTextBuilder,
+  schematic_path: createSchematicPathBuilder,
 }
 
 type SchematicSymbolAddables = typeof schematic_symbol_addables

src/lib/soup/index.ts

@@ -1,2 +1,4 @@
 export * from "./units"
 export * from "./common"
+export * from "./source"
+export * from "./schematic"

src/lib/soup/schematic/index.ts

@@ -0,0 +1,2 @@
+export * from "./schematic_box"
+export * from "./schematic_path"

src/lib/soup/schematic/schematic_path.ts

@@ -0,0 +1,12 @@
+import { z } from "zod"
+import { point } from "../common/point"
+
+export const schematic_path = z.object({
+  type: z.literal("schematic_path"),
+  schematic_component_id: z.string(),
+  fill_color: z.string().optional(),
+  is_filled: z.boolean().optional(),
+  points: z.array(point),
+})
+
+export type SchematicPath = z.infer<typeof schematic_path>

src/lib/soup/source/index.ts

@@ -0,0 +1,2 @@
+export * from "./source_simple_capacitor"
+export * from "./source_simple_resistor"

src/lib/soup/source/source_simple_capacitor.ts

@@ -2,7 +2,7 @@ import { z } from "zod"
 import { source_component_base } from "lib/soup/source/base/source_component_base"
 import { capacitance } from "lib/soup/units"
 
-export const source_simple_resistor = source_component_base.extend({
+export const source_simple_capacitor = source_component_base.extend({
   ftype: z.literal("simple_capacitor"),
   capacitance,
 })

src/lib/types/core.ts

@@ -127,6 +127,8 @@ export interface SchematicText {
   anchor: "center" | "left" | "right" | "top" | "bottom"
 }
 
+export type SchematicPath = Soup.SchematicPath
+
 export interface SchematicPort {
   type: "schematic_port"
   schematic_port_id: string

tests/primitives/schematic-path.test.ts

@@ -0,0 +1,23 @@
+import test from "ava"
+import { createProjectBuilder } from "lib/builder"
+import { logLayout } from "../utils/log-layout"
+
+test("render a simple schematic path", async (t) => {
+  const soup = await createProjectBuilder()
+    .add("component", (cb) =>
+      cb.modifySchematic((sb) =>
+        sb.add("schematic_path", (sp) =>
+          sp.setProps({
+            points: [
+              { x: 0, y: 0 },
+              { x: 100, y: 100 },
+            ],
+          })
+        )
+      )
+    )
+    .build()
+
+  await logLayout("custom schematic symbol with path", soup)
+  t.pass()
+})