@tscircuit/core 0.0.16 → 0.0.18

package/dist/index.js

@@ -12,13 +12,16 @@ __export(components_exports, {
   Chip: () => Chip,
   Footprint: () => Footprint,
   Group: () => Group,
+  Jumper: () => Jumper,
   Led: () => Led,
   Net: () => Net,
   NormalComponent: () => NormalComponent,
+  PlatedHole: () => PlatedHole,
   Port: () => Port,
   PrimitiveComponent: () => PrimitiveComponent,
   Renderable: () => Renderable,
   Resistor: () => Resistor,
+  SilkscreenPath: () => SilkscreenPath,
   SmtPad: () => SmtPad,
   Trace: () => Trace,
   TraceHint: () => TraceHint
@@ -167,6 +170,7 @@ var PrimitiveComponent = class extends Renderable {
   _parsedProps;
   componentName = "";
   lowercaseComponentName = "";
+  externallyAddedAliases;
   source_group_id = null;
   source_component_id = null;
   schematic_component_id = null;
@@ -177,6 +181,7 @@ var PrimitiveComponent = class extends Renderable {
     this.children = [];
     this.childrenPendingRemoval = [];
     this.props = props ?? {};
+    this.externallyAddedAliases = [];
     this._parsedProps = this.config.zodProps.parse(
       props ?? {}
     );
@@ -466,7 +471,8 @@ var Port = class extends PrimitiveComponent {
       /* @__PURE__ */ new Set([
         ...props.aliases ?? [],
         props.name,
-        ...typeof props.pinNumber === "number" ? [`pin${props.pinNumber}`, props.pinNumber.toString()] : []
+        ...typeof props.pinNumber === "number" ? [`pin${props.pinNumber}`, props.pinNumber.toString()] : [],
+        ...this.externallyAddedAliases
       ])
     );
   }
@@ -796,6 +802,83 @@ var SmtPad = class extends PrimitiveComponent {
   }
 };
 
+// lib/components/primitive-components/SilkscreenPath.ts
+import { silkscreenPathProps } from "@tscircuit/props";
+var SilkscreenPath = class extends PrimitiveComponent {
+  pcb_silkscreen_path_id = null;
+  get config() {
+    return {
+      zodProps: silkscreenPathProps
+    };
+  }
+  doInitialPcbPrimitiveRender() {
+    const { db } = this.project;
+    const { _parsedProps: props } = this;
+    const layer = props.layer ?? "top";
+    if (layer !== "top" && layer !== "bottom") {
+      throw new Error(
+        `Invalid layer "${layer}" for SilkscreenPath. Must be "top" or "bottom".`
+      );
+    }
+    const pcb_silkscreen_path = db.pcb_silkscreen_path.insert({
+      pcb_component_id: this.parent?.pcb_component_id,
+      layer,
+      route: props.route,
+      stroke_width: props.strokeWidth ?? 0.1
+    });
+    this.pcb_silkscreen_path_id = pcb_silkscreen_path.pcb_silkscreen_path_id;
+  }
+};
+
+// lib/components/primitive-components/PlatedHole.ts
+import { platedHoleProps } from "@tscircuit/props";
+var PlatedHole = class extends PrimitiveComponent {
+  pcb_plated_hole_id = null;
+  matchedPort = null;
+  isPcbPrimitive = true;
+  get config() {
+    return {
+      zodProps: platedHoleProps
+    };
+  }
+  doInitialPortMatching() {
+    const parentPorts = (this.parent?.children ?? []).filter(
+      (c) => c.componentName === "Port"
+    );
+    if (!this.props.portHints) {
+      return;
+    }
+    for (const port of parentPorts) {
+      if (port.isMatchingAnyOf(this.props.portHints)) {
+        this.matchedPort = port;
+        port.registerMatch(this);
+        return;
+      }
+    }
+  }
+  doInitialPcbPrimitiveRender() {
+    const { db } = this.project;
+    const { _parsedProps: props } = this;
+    if (!props.portHints) return;
+    const position = this.getGlobalPcbPosition();
+    if (props.shape === "circle") {
+      const plated_hole_input = {
+        pcb_component_id: this.parent?.pcb_component_id,
+        pcb_port_id: this.matchedPort?.pcb_port_id,
+        layers: ["top", "bottom"],
+        outer_diameter: props.outerDiameter,
+        hole_diameter: props.holeDiameter,
+        shape: "circle",
+        port_hints: this.getNameAndAliases(),
+        x: position.x,
+        y: position.y,
+        type: "pcb_plated_hole"
+      };
+      const pcb_plated_hole = db.pcb_plated_hole.insert(plated_hole_input);
+    }
+  }
+};
+
 // lib/utils/createComponentsFromSoup.ts
 var createComponentsFromSoup = (soup) => {
   const components = [];
@@ -823,6 +906,27 @@ var createComponentsFromSoup = (soup) => {
           portHints: elm.port_hints
         })
       );
+    } else if (elm.type === "pcb_silkscreen_path") {
+      components.push(
+        new SilkscreenPath({
+          layer: elm.layer,
+          route: elm.route,
+          strokeWidth: elm.stroke_width
+        })
+      );
+    } else if (elm.type === "pcb_plated_hole" && elm.shape === "circle") {
+      if (elm.shape === "circle") {
+        components.push(
+          new PlatedHole({
+            pcbX: elm.x,
+            pcbY: elm.y,
+            shape: "circle",
+            holeDiameter: elm.hole_diameter,
+            outerDiameter: elm.outer_diameter,
+            portHints: elm.port_hints
+          })
+        );
+      }
     }
   }
   return components;
@@ -866,6 +970,20 @@ var NormalComponent = class extends PrimitiveComponent {
     }
     const portsFromFootprint = this.getPortsFromFootprint();
     this.addAll(portsFromFootprint);
+    const pinLabels = this._parsedProps.pinLabels;
+    if (pinLabels) {
+      for (let [pinNumber, label] of Object.entries(pinLabels)) {
+        pinNumber = pinNumber.replace("pin", "");
+        const port = this.selectOne(`port[pinNumber='${pinNumber}']`);
+        if (!port) {
+          throw new Error(
+            `Could not find port for pin number ${pinNumber} in chip ${this.getString()}`
+          );
+        }
+        port.externallyAddedAliases.push(label);
+        port.props.name = label;
+      }
+    }
   }
   _addChildrenFromStringFootprint() {
     const { footprint } = this.props;
@@ -1902,27 +2020,81 @@ var Chip = class extends NormalComponent {
       zodProps: chipProps
     };
   }
-  initPorts() {
-    super.initPorts();
+  doInitialSourceRender() {
+    const { db } = this.project;
     const { _parsedProps: props } = this;
-    if (props.pinLabels) {
-      for (const [pinNumber, label] of Object.entries(props.pinLabels)) {
-        const port = this.selectOne(`port[pinNumber='${pinNumber}']`);
-        if (!port) {
-          throw new Error(
-            `Could not find port for pin number ${pinNumber} in chip ${this.getString()}`
-          );
-        }
-        port.props.aliases.push(port.props.name);
-        port.props.name = label;
-      }
-    }
+    const source_component = db.source_component.insert({
+      ftype: "simple_chip",
+      name: props.name,
+      manufacturer_part_number: props.manufacturerPartNumber,
+      supplier_part_numbers: props.supplierPartNumbers
+    });
+    this.source_component_id = source_component.source_component_id;
+  }
+  doInitialSchematicComponentRender() {
+    const { db } = this.project;
+    const { _parsedProps: props } = this;
+    const ports = this.children.filter((child) => child instanceof Port);
+    const pinSpacing = props.schPinSpacing ?? 0.2;
+    const dimensions = getAllDimensionsForSchematicBox({
+      schWidth: props.schWidth,
+      schHeight: props.schHeight,
+      schPinSpacing: pinSpacing,
+      schPinStyle: props.schPinStyle,
+      pinCount: ports.length,
+      // @ts-ignore there's a subtley in the definition difference with
+      // leftSide/rightSide/topSide/bottomSide in how the direction is defined
+      // that doesn't really matter
+      schPortArrangement: props.schPortArrangement
+    });
+    this.schematicDimensions = dimensions;
+    const schematic_component2 = db.schematic_component.insert({
+      center: { x: props.schX ?? 0, y: props.schY ?? 0 },
+      rotation: props.schRotation ?? 0,
+      size: dimensions.getSize(),
+      port_arrangement: underscorifyPortArrangement(
+        props.schPortArrangement
+      ),
+      pin_spacing: pinSpacing,
+      // @ts-ignore soup needs to support distance for pin_styles
+      pin_styles: underscorifyPinStyles(props.schPinStyle),
+      port_labels: props.pinLabels,
+      source_component_id: this.source_component_id
+    });
+    this.schematic_component_id = schematic_component2.schematic_component_id;
+  }
+  doInitialPcbComponentRender() {
+    const { db } = this.project;
+    const { _parsedProps: props } = this;
+    const pcb_component = db.pcb_component.insert({
+      center: { x: props.pcbX ?? 0, y: props.pcbY ?? 0 },
+      width: 2,
+      // Default width, adjust as needed
+      height: 3,
+      // Default height, adjust as needed
+      layer: props.layer ?? "top",
+      rotation: props.pcbRotation ?? 0,
+      source_component_id: this.source_component_id
+    });
+    this.pcb_component_id = pcb_component.pcb_component_id;
+  }
+};
+
+// lib/components/normal-components/Jumper.ts
+import { jumperProps } from "@tscircuit/props";
+var Jumper = class extends NormalComponent {
+  schematicDimensions = null;
+  get config() {
+    return {
+      zodProps: jumperProps
+    };
   }
   doInitialSourceRender() {
     const { db } = this.project;
     const { _parsedProps: props } = this;
     const source_component = db.source_component.insert({
       ftype: "simple_chip",
+      // TODO unknown or jumper
       name: props.name,
       manufacturer_part_number: props.manufacturerPartNumber,
       supplier_part_numbers: props.supplierPartNumbers
@@ -1943,7 +2115,10 @@ var Chip = class extends NormalComponent {
       // @ts-ignore there's a subtley in the definition difference with
       // leftSide/rightSide/topSide/bottomSide in how the direction is defined
       // that doesn't really matter
-      schPortArrangement: props.schPortArrangement
+      schPortArrangement: {
+        // TODO use schematic direction or schPortArrangement
+        rightSize: ports.length
+      }
     });
     this.schematicDimensions = dimensions;
     const schematic_component2 = db.schematic_component.insert({
@@ -1986,6 +2161,7 @@ var Project = class {
   rootComponent = null;
   children;
   db;
+  _hasRenderedAtleastOnce = false;
   constructor() {
     this.children = [];
     this.db = su([]);
@@ -2029,13 +2205,29 @@ var Project = class {
     if (!rootComponent) throw new Error("Project has no root component");
     rootComponent.setProject(this);
     rootComponent.runRenderCycle();
+    this._hasRenderedAtleastOnce = true;
   }
   getSoup() {
+    if (!this._hasRenderedAtleastOnce) this.render();
     return this.db.toArray();
   }
   getCircuitJson() {
     return this.getSoup();
   }
+  async getSvg(options) {
+    const circuitToSvg = await import("circuit-to-svg").catch((e) => {
+      throw new Error(
+        `To use project.getSvg, you must install the "circuit-to-svg" package.
+
+"${e.message}"`
+      );
+    });
+    return circuitToSvg.circuitJsonToPcbSvg(this.getSoup());
+  }
+  async preview(previewNameOrOpts) {
+    const previewOpts = typeof previewNameOrOpts === "object" ? previewNameOrOpts : { previewName: previewNameOrOpts };
+    throw new Error("project.preview is not yet implemented");
+  }
   computeGlobalSchematicTransform() {
     return identity5();
   }
@@ -2061,14 +2253,17 @@ export {
   Chip,
   Footprint,
   Group,
+  Jumper,
   Led,
   Net,
   NormalComponent,
+  PlatedHole,
   Port,
   PrimitiveComponent,
   Project,
   Renderable,
   Resistor,
+  SilkscreenPath,
   SmtPad,
   Trace,
   TraceHint

package/lib/Project.ts

@@ -11,6 +11,8 @@ export class Project {
   children: PrimitiveComponent[]
   db: SoupUtilObjects
 
+  _hasRenderedAtleastOnce = false
+
   constructor() {
     this.children = []
     this.db = su([])
@@ -64,9 +66,11 @@ export class Project {
     rootComponent.setProject(this)
 
     rootComponent.runRenderCycle()
+    this._hasRenderedAtleastOnce = true
   }
 
   getSoup(): AnySoupElement[] {
+    if (!this._hasRenderedAtleastOnce) this.render()
     return this.db.toArray()
   }
 
@@ -74,6 +78,31 @@ export class Project {
     return this.getSoup()
   }
 
+  async getSvg(options: { view: "pcb"; layer?: string }): Promise<string> {
+    const circuitToSvg = await import("circuit-to-svg").catch((e) => {
+      throw new Error(
+        `To use project.getSvg, you must install the "circuit-to-svg" package.\n\n"${e.message}"`,
+      )
+    })
+
+    return circuitToSvg.circuitJsonToPcbSvg(this.getSoup())
+  }
+
+  async preview(
+    previewNameOrOpts:
+      | string
+      | {
+          previewName: string
+          tscircuitApiKey?: string
+        },
+  ) {
+    const previewOpts =
+      typeof previewNameOrOpts === "object"
+        ? previewNameOrOpts
+        : { previewName: previewNameOrOpts }
+    throw new Error("project.preview is not yet implemented")
+  }
+
   computeGlobalSchematicTransform(): Matrix {
     return identity()
   }

package/lib/components/base-components/NormalComponent.ts

@@ -87,6 +87,22 @@ export class NormalComponent<
     const portsFromFootprint = this.getPortsFromFootprint()
 
     this.addAll(portsFromFootprint)
+
+    const pinLabels: Record<string, string> | undefined =
+      this._parsedProps.pinLabels
+    if (pinLabels) {
+      for (let [pinNumber, label] of Object.entries(pinLabels)) {
+        pinNumber = pinNumber.replace("pin", "")
+        const port = this.selectOne(`port[pinNumber='${pinNumber}']`)
+        if (!port) {
+          throw new Error(
+            `Could not find port for pin number ${pinNumber} in chip ${this.getString()}`,
+          )
+        }
+        port.externallyAddedAliases.push(label)
+        port.props.name = label
+      }
+    }
   }
 
   _addChildrenFromStringFootprint() {

package/lib/components/base-components/PrimitiveComponent.ts

@@ -46,6 +46,8 @@ export abstract class PrimitiveComponent<
   componentName = ""
   lowercaseComponentName = ""
 
+  externallyAddedAliases: string[]
+
   source_group_id: string | null = null
   source_component_id: string | null = null
   schematic_component_id: string | null = null
@@ -57,6 +59,7 @@ export abstract class PrimitiveComponent<
     this.children = []
     this.childrenPendingRemoval = []
     this.props = props ?? {}
+    this.externallyAddedAliases = []
     this._parsedProps = this.config.zodProps.parse(
       props ?? {},
     ) as z.infer<ZodProps>

package/lib/components/index.ts

@@ -13,3 +13,6 @@ export { Trace } from "./primitive-components/Trace"
 export { TraceHint } from "./primitive-components/TraceHint"
 export { Group } from "./primitive-components/Group"
 export { Chip } from "./normal-components/Chip"
+export { Jumper } from "./normal-components/Jumper"
+export { SilkscreenPath } from "./primitive-components/SilkscreenPath"
+export { PlatedHole } from "./primitive-components/PlatedHole"

package/lib/components/normal-components/Chip.ts

@@ -21,25 +21,6 @@ export class Chip<PinLabels extends string = never> extends NormalComponent<
     }
   }
 
-  initPorts() {
-    super.initPorts()
-
-    const { _parsedProps: props } = this
-
-    if (props.pinLabels) {
-      for (const [pinNumber, label] of Object.entries(props.pinLabels)) {
-        const port = this.selectOne(`port[pinNumber='${pinNumber}']`)
-        if (!port) {
-          throw new Error(
-            `Could not find port for pin number ${pinNumber} in chip ${this.getString()}`,
-          )
-        }
-        port.props.aliases.push(port.props.name)
-        port.props.name = label
-      }
-    }
-  }
-
   doInitialSourceRender(): void {
     const { db } = this.project!
     const { _parsedProps: props } = this

package/lib/components/normal-components/Jumper.ts

@@ -0,0 +1,101 @@
+import { NormalComponent } from "lib/components/base-components/NormalComponent"
+import { jumperProps } from "@tscircuit/props"
+import { Port } from "../primitive-components/Port"
+import type { BaseSymbolName } from "lib/utils/constants"
+import {
+  getAllDimensionsForSchematicBox,
+  type SchematicBoxDimensions,
+} from "lib/utils/schematic/getAllDimensionsForSchematicBox"
+import { underscorifyPortArrangement } from "lib/soup/underscorifyPortArrangement"
+import { underscorifyPinStyles } from "lib/soup/underscorifyPinStyles"
+
+export class Jumper<PinLabels extends string = never> extends NormalComponent<
+  typeof jumperProps,
+  PinLabels
+> {
+  schematicDimensions: SchematicBoxDimensions | null = null
+
+  get config() {
+    return {
+      zodProps: jumperProps,
+    }
+  }
+
+  doInitialSourceRender(): void {
+    const { db } = this.project!
+    const { _parsedProps: props } = this
+
+    const source_component = db.source_component.insert({
+      ftype: "simple_chip", // TODO unknown or jumper
+      name: props.name,
+      manufacturer_part_number: props.manufacturerPartNumber,
+      supplier_part_numbers: props.supplierPartNumbers,
+    })
+
+    this.source_component_id = source_component.source_component_id!
+  }
+
+  doInitialSchematicComponentRender() {
+    const { db } = this.project!
+    const { _parsedProps: props } = this
+
+    const ports = this.children.filter((child) => child instanceof Port)
+
+    const pinSpacing = props.schPinSpacing ?? 0.2
+
+    const dimensions = getAllDimensionsForSchematicBox({
+      schWidth: props.schWidth,
+      schHeight: props.schHeight,
+      schPinSpacing: pinSpacing,
+      schPinStyle: props.schPinStyle,
+
+      pinCount: ports.length,
+
+      // @ts-ignore there's a subtley in the definition difference with
+      // leftSide/rightSide/topSide/bottomSide in how the direction is defined
+      // that doesn't really matter
+      schPortArrangement: {
+        // TODO use schematic direction or schPortArrangement
+        rightSize: ports.length,
+      },
+    })
+    this.schematicDimensions = dimensions
+
+    const schematic_component = db.schematic_component.insert({
+      center: { x: props.schX ?? 0, y: props.schY ?? 0 },
+      rotation: props.schRotation ?? 0,
+      size: dimensions.getSize(),
+
+      port_arrangement: underscorifyPortArrangement(
+        props.schPortArrangement as any,
+      ),
+
+      pin_spacing: pinSpacing,
+
+      // @ts-ignore soup needs to support distance for pin_styles
+      pin_styles: underscorifyPinStyles(props.schPinStyle),
+
+      port_labels: props.pinLabels,
+
+      source_component_id: this.source_component_id!,
+    })
+
+    this.schematic_component_id = schematic_component.schematic_component_id
+  }
+
+  doInitialPcbComponentRender() {
+    const { db } = this.project!
+    const { _parsedProps: props } = this
+
+    const pcb_component = db.pcb_component.insert({
+      center: { x: props.pcbX ?? 0, y: props.pcbY ?? 0 },
+      width: 2, // Default width, adjust as needed
+      height: 3, // Default height, adjust as needed
+      layer: props.layer ?? "top",
+      rotation: props.pcbRotation ?? 0,
+      source_component_id: this.source_component_id!,
+    })
+
+    this.pcb_component_id = pcb_component.pcb_component_id
+  }
+}

package/lib/components/primitive-components/PlatedHole.ts

@@ -0,0 +1,60 @@
+import { PrimitiveComponent } from "../base-components/PrimitiveComponent"
+import { platedHoleProps } from "@tscircuit/props"
+import type { Port } from "./Port"
+import type { PCBPlatedHoleInput } from "@tscircuit/soup"
+
+export class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
+  pcb_plated_hole_id: string | null = null
+  matchedPort: Port | null = null
+  isPcbPrimitive = true
+
+  get config() {
+    return {
+      zodProps: platedHoleProps,
+    }
+  }
+
+  doInitialPortMatching(): void {
+    const parentPorts = (this.parent?.children ?? []).filter(
+      (c) => c.componentName === "Port",
+    ) as Port[]
+
+    if (!this.props.portHints) {
+      return
+    }
+
+    for (const port of parentPorts) {
+      if (port.isMatchingAnyOf(this.props.portHints)) {
+        this.matchedPort = port
+        port.registerMatch(this)
+        return
+      }
+    }
+  }
+
+  doInitialPcbPrimitiveRender(): void {
+    const { db } = this.project!
+    const { _parsedProps: props } = this
+    if (!props.portHints) return
+    const position = this.getGlobalPcbPosition()
+    if (props.shape === "circle") {
+      const plated_hole_input: PCBPlatedHoleInput = {
+        pcb_component_id: this.parent?.pcb_component_id!,
+        pcb_port_id: this.matchedPort?.pcb_port_id!,
+        layers: ["top", "bottom"],
+        outer_diameter: props.outerDiameter,
+        hole_diameter: props.holeDiameter,
+        shape: "circle",
+        port_hints: this.getNameAndAliases(),
+        x: position.x,
+        y: position.y,
+        type: "pcb_plated_hole",
+      }
+
+      // @ts-ignore - some issue with soup-util types it seems
+      const pcb_plated_hole = db.pcb_plated_hole.insert(plated_hole_input)
+
+      // this.pcb_plated_hole_id = pcb_plated_hole.pcb_plated_hole_id
+    }
+  }
+}

package/lib/components/primitive-components/Port.ts

@@ -82,6 +82,7 @@ export class Port extends PrimitiveComponent<typeof portProps> {
         ...(typeof props.pinNumber === "number"
           ? [`pin${props.pinNumber}`, props.pinNumber.toString()]
           : []),
+        ...this.externallyAddedAliases,
       ]),
     ) as string[]
   }

package/lib/components/primitive-components/SilkscreenPath.ts

@@ -0,0 +1,35 @@
+import { silkscreenPathProps } from "@tscircuit/props"
+import { PrimitiveComponent } from "../base-components/PrimitiveComponent"
+
+export class SilkscreenPath extends PrimitiveComponent<
+  typeof silkscreenPathProps
+> {
+  pcb_silkscreen_path_id: string | null = null
+
+  get config() {
+    return {
+      zodProps: silkscreenPathProps,
+    }
+  }
+
+  doInitialPcbPrimitiveRender(): void {
+    const { db } = this.project!
+    const { _parsedProps: props } = this
+
+    const layer = props.layer ?? "top"
+    if (layer !== "top" && layer !== "bottom") {
+      throw new Error(
+        `Invalid layer "${layer}" for SilkscreenPath. Must be "top" or "bottom".`,
+      )
+    }
+
+    const pcb_silkscreen_path = db.pcb_silkscreen_path.insert({
+      pcb_component_id: this.parent?.pcb_component_id!,
+      layer,
+      route: props.route,
+      stroke_width: props.strokeWidth ?? 0.1,
+    })
+
+    this.pcb_silkscreen_path_id = pcb_silkscreen_path.pcb_silkscreen_path_id
+  }
+}

package/lib/fiber/intrinsic-jsx.ts

@@ -9,6 +9,7 @@ declare global {
       diode: Props.DiodeProps
       led: Props.LedProps
       board: Props.BoardProps
+      jumper: Props.JumperProps
       bug: Props.ChipProps
       // TODO use ChipProps once it gets merged in @tscircuit/props
       chip: Props.ChipProps