circuit-to-canvas 0.0.1 → 0.0.3

package/.github/workflows/bun-formatcheck.yml

@@ -0,0 +1,26 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Format Check
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  format-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run format check
+        run: bun run format:check

package/.github/workflows/bun-pver-release.yml

@@ -0,0 +1,77 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Publish to npm
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+env:
+  UPSTREAM_REPOS: "" # comma-separated list, e.g. "eval,tscircuit,docs"
+  UPSTREAM_PACKAGES_TO_UPDATE: "" # comma-separated list, e.g. "@tscircuit/core,@tscircuit/protos"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    if: ${{ !(github.event_name == 'push' && startsWith(github.event.head_commit.message, 'v')) }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.TSCIRCUIT_BOT_GITHUB_TOKEN }}
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm install -g pver
+      - run: bun install --frozen-lockfile
+      - run: bun run build
+      - run: pver release --no-push-main
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.TSCIRCUIT_BOT_GITHUB_TOKEN }}
+
+      - name: Get package version
+        id: package-version
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+
+      - name: Create Pull Request
+        id: create-pr
+        uses: peter-evans/create-pull-request@v5
+        with:
+          commit-message: "chore: bump version to ${{ steps.package-version.outputs.version }}"
+          title: "chore: bump version to ${{ steps.package-version.outputs.version }}"
+          body: "Automated package update"
+          branch: bump-version-${{ github.run_number }}
+          base: main
+          token: ${{ secrets.TSCIRCUIT_BOT_GITHUB_TOKEN }}
+          committer: tscircuitbot <githubbot@tscircuit.com>
+          author: tscircuitbot <githubbot@tscircuit.com>
+
+      - name: Enable auto-merge
+        if: steps.create-pr.outputs.pull-request-number != ''
+        run: |
+          gh pr merge ${{ steps.create-pr.outputs.pull-request-number }} --auto --squash --delete-branch
+        env:
+          GH_TOKEN: ${{ secrets.TSCIRCUIT_BOT_GITHUB_TOKEN }}
+
+      # - name: Trigger upstream repo updates
+      #   if: env.UPSTREAM_REPOS && env.UPSTREAM_PACKAGES_TO_UPDATE
+      #   run: |
+      #     IFS=',' read -ra REPOS <<< "${{ env.UPSTREAM_REPOS }}"
+      #     for repo in "${REPOS[@]}"; do
+      #       if [[ -n "$repo" ]]; then
+      #         echo "Triggering update for repo: $repo"
+      #         curl -X POST \
+      #           -H "Accept: application/vnd.github.v3+json" \
+      #           -H "Authorization: token ${{ secrets.TSCIRCUIT_BOT_GITHUB_TOKEN }}" \
+      #           -H "Content-Type: application/json" \
+      #           "https://api.github.com/repos/tscircuit/$repo/actions/workflows/update-package.yml/dispatches" \
+      #           -d "{\"ref\":\"main\",\"inputs\":{\"package_names\":\"${{ env.UPSTREAM_PACKAGES_TO_UPDATE }}\"}}"
+      #       fi
+      #     done

package/.github/workflows/bun-test.yml

@@ -0,0 +1,31 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Bun Test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    # Skip test for PRs that not chore: bump version
+    if: "${{ github.event_name != 'pull_request' || github.event.pull_request.title != 'chore: bump version' }}"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run tests
+        run: bun test

package/.github/workflows/bun-typecheck.yml

@@ -0,0 +1,26 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Type Check
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  type-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun i
+
+      - name: Run type check
+        run: bunx tsc --noEmit

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 tscircuit Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,6 +2,8 @@
 
 Draw [Circuit JSON](https://github.com/tscircuit/circuit-json) into a Canvas- works with any canvas object (Node/Vanilla)
 
+[![NPM Version](https://img.shields.io/npm/v/circuit-to-canvas)](https://npmjs.com/package/circuit-to-canvas)
+
 ```tsx
 const drawer = new CircuitToCanvasDrawer(canvasOrCanvasRenderingContext2d)
 
@@ -28,3 +30,67 @@ There are two "types" of layers:
 - Layer groups "top" (includes "top_copper", "top_soldermask")
 
 inner layers go by the name inner1, inner2 etc.
+
+## Feature Parity with circuit-to-svg
+
+This checklist tracks PCB drawing features from [circuit-to-svg](https://github.com/tscircuit/circuit-to-svg) that are implemented in circuit-to-canvas.
+
+### PCB Elements
+
+- [x] `pcb_board` - Board outline with center/width/height or custom outline
+- [x] `pcb_trace` - PCB traces with route points
+- [x] `pcb_via` - Via holes
+- [x] `pcb_plated_hole` - Plated through-holes (circular, pill, oval shapes)
+- [x] `pcb_hole` - Non-plated holes (circular, square, oval shapes)
+- [x] `pcb_smtpad` - SMT pads (rect, circle, rotated_rect, pill shapes)
+- [x] `pcb_copper_pour` - Copper pour areas (rect, polygon shapes)
+- [x] `pcb_cutout` - Board cutouts (rect, circle, polygon shapes)
+
+### Silkscreen Elements
+
+- [x] `pcb_silkscreen_text` - Text on silkscreen layer
+- [x] `pcb_silkscreen_rect` - Rectangles on silkscreen
+- [x] `pcb_silkscreen_circle` - Circles on silkscreen
+- [x] `pcb_silkscreen_line` - Lines on silkscreen
+- [x] `pcb_silkscreen_path` - Paths/routes on silkscreen
+
+### Copper Text
+
+- [ ] `pcb_copper_text` - Text rendered on copper layers (supports knockout mode, mirroring)
+
+### Error Visualization
+
+- [ ] `pcb_trace_error` - Trace routing error indicators
+- [ ] `pcb_footprint_overlap_error` - Footprint overlap error indicators
+
+### Debug/Development Features
+
+- [ ] `pcb_component` - Component bounding box visualization
+- [ ] `pcb_group` - PCB group visualization with dashed outlines
+- [ ] `pcb_courtyard_rect` - Component courtyard rectangles
+
+### Fabrication Notes
+
+- [ ] `pcb_fabrication_note_text` - Fabrication note text
+- [ ] `pcb_fabrication_note_rect` - Fabrication note rectangles
+- [ ] `pcb_fabrication_note_path` - Fabrication note paths
+- [ ] `pcb_fabrication_note_dimension` - Fabrication dimension annotations
+
+### Annotation/Notes
+
+- [ ] `pcb_note_text` - General note text
+- [ ] `pcb_note_rect` - Note rectangles
+- [ ] `pcb_note_path` - Note paths
+- [ ] `pcb_note_line` - Note lines
+- [ ] `pcb_note_dimension` - Dimension annotations
+
+### Panel Support
+
+- [ ] `pcb_panel` - PCB panel outlines for panelization
+
+### Visualization Features
+
+- [ ] Rats nest visualization - Unrouted connection indicators
+- [ ] PCB grid overlay - Configurable grid with major/minor lines
+- [ ] Soldermask rendering - Soldermask layer visualization
+- [ ] Anchor offset indicators - Debug indicators for relative positioning

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AnyCircuitElement, PcbPlatedHole } from 'circuit-json';
+import { AnyCircuitElement, PcbPlatedHole, PCBVia, PCBHole, PcbSmtPad, PCBTrace, PcbBoard, PcbSilkscreenText, PcbSilkscreenRect, PcbSilkscreenCircle, PcbSilkscreenLine, PcbSilkscreenPath, PcbCutout, PcbCopperPour } from 'circuit-json';
 import { Matrix } from 'transformation-matrix';
 
 /**
@@ -12,6 +12,7 @@ interface CanvasContext {
     arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void;
     ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number, startAngle: number, endAngle: number): void;
     fill(): void;
+    stroke(): void;
     rect(x: number, y: number, w: number, h: number): void;
     lineTo(x: number, y: number): void;
     moveTo(x: number, y: number): void;
@@ -19,11 +20,20 @@ interface CanvasContext {
     restore(): void;
     translate(x: number, y: number): void;
     rotate(angle: number): void;
+    scale(x: number, y: number): void;
     fillStyle: string | CanvasGradient | CanvasPattern;
+    strokeStyle: string | CanvasGradient | CanvasPattern;
+    lineWidth: number;
+    lineCap: "butt" | "round" | "square";
+    lineJoin: "bevel" | "round" | "miter";
     canvas: {
         width: number;
         height: number;
     };
+    fillText(text: string, x: number, y: number): void;
+    font: string;
+    textAlign: "start" | "end" | "left" | "right" | "center";
+    textBaseline: "top" | "hanging" | "middle" | "alphabetic" | "ideographic" | "bottom";
 }
 type CopperLayerName = "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6";
 type CopperColorMap = Record<CopperLayerName, string> & {
@@ -140,6 +150,48 @@ interface DrawPillParams {
 }
 declare function drawPill(params: DrawPillParams): void;
 
+interface DrawPolygonParams {
+    ctx: CanvasContext;
+    points: Array<{
+        x: number;
+        y: number;
+    }>;
+    fill: string;
+    transform: Matrix;
+}
+declare function drawPolygon(params: DrawPolygonParams): void;
+
+interface DrawLineParams {
+    ctx: CanvasContext;
+    start: {
+        x: number;
+        y: number;
+    };
+    end: {
+        x: number;
+        y: number;
+    };
+    strokeWidth: number;
+    stroke: string;
+    transform: Matrix;
+    lineCap?: "butt" | "round" | "square";
+}
+declare function drawLine(params: DrawLineParams): void;
+
+interface DrawPathParams {
+    ctx: CanvasContext;
+    points: Array<{
+        x: number;
+        y: number;
+    }>;
+    fill?: string;
+    stroke?: string;
+    strokeWidth?: number;
+    transform: Matrix;
+    closePath?: boolean;
+}
+declare function drawPath(params: DrawPathParams): void;
+
 interface DrawPcbPlatedHoleParams {
     ctx: CanvasContext;
     hole: PcbPlatedHole;
@@ -148,4 +200,96 @@ interface DrawPcbPlatedHoleParams {
 }
 declare function drawPcbPlatedHole(params: DrawPcbPlatedHoleParams): void;
 
-export { type CameraBounds, type CanvasContext, CircuitToCanvasDrawer, type CopperColorMap, type CopperLayerName, DEFAULT_PCB_COLOR_MAP, type DrawCircleParams, type DrawContext, type DrawElementsOptions, type DrawOvalParams, type DrawPcbPlatedHoleParams, type DrawPillParams, type DrawRectParams, type DrawerConfig, type PcbColorMap, drawCircle, drawOval, drawPcbPlatedHole, drawPill, drawRect };
+interface DrawPcbViaParams {
+    ctx: CanvasContext;
+    via: PCBVia;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+declare function drawPcbVia(params: DrawPcbViaParams): void;
+
+interface DrawPcbHoleParams {
+    ctx: CanvasContext;
+    hole: PCBHole;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+declare function drawPcbHole(params: DrawPcbHoleParams): void;
+
+interface DrawPcbSmtPadParams {
+    ctx: CanvasContext;
+    pad: PcbSmtPad;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+declare function drawPcbSmtPad(params: DrawPcbSmtPadParams): void;
+
+interface DrawPcbTraceParams {
+    ctx: CanvasContext;
+    trace: PCBTrace;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+declare function drawPcbTrace(params: DrawPcbTraceParams): void;
+
+interface DrawPcbBoardParams {
+    ctx: CanvasContext;
+    board: PcbBoard;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+declare function drawPcbBoard(params: DrawPcbBoardParams): void;
+
+interface DrawPcbSilkscreenTextParams {
+    ctx: CanvasContext;
+    text: PcbSilkscreenText;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+interface DrawPcbSilkscreenRectParams {
+    ctx: CanvasContext;
+    rect: PcbSilkscreenRect;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+interface DrawPcbSilkscreenCircleParams {
+    ctx: CanvasContext;
+    circle: PcbSilkscreenCircle;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+interface DrawPcbSilkscreenLineParams {
+    ctx: CanvasContext;
+    line: PcbSilkscreenLine;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+interface DrawPcbSilkscreenPathParams {
+    ctx: CanvasContext;
+    path: PcbSilkscreenPath;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+declare function drawPcbSilkscreenText(params: DrawPcbSilkscreenTextParams): void;
+declare function drawPcbSilkscreenRect(params: DrawPcbSilkscreenRectParams): void;
+declare function drawPcbSilkscreenCircle(params: DrawPcbSilkscreenCircleParams): void;
+declare function drawPcbSilkscreenLine(params: DrawPcbSilkscreenLineParams): void;
+declare function drawPcbSilkscreenPath(params: DrawPcbSilkscreenPathParams): void;
+
+interface DrawPcbCutoutParams {
+    ctx: CanvasContext;
+    cutout: PcbCutout;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+declare function drawPcbCutout(params: DrawPcbCutoutParams): void;
+
+interface DrawPcbCopperPourParams {
+    ctx: CanvasContext;
+    pour: PcbCopperPour;
+    transform: Matrix;
+    colorMap: PcbColorMap;
+}
+declare function drawPcbCopperPour(params: DrawPcbCopperPourParams): void;
+
+export { type CameraBounds, type CanvasContext, CircuitToCanvasDrawer, type CopperColorMap, type CopperLayerName, DEFAULT_PCB_COLOR_MAP, type DrawCircleParams, type DrawContext, type DrawElementsOptions, type DrawLineParams, type DrawOvalParams, type DrawPathParams, type DrawPcbBoardParams, type DrawPcbCopperPourParams, type DrawPcbCutoutParams, type DrawPcbHoleParams, type DrawPcbPlatedHoleParams, type DrawPcbSilkscreenCircleParams, type DrawPcbSilkscreenLineParams, type DrawPcbSilkscreenPathParams, type DrawPcbSilkscreenRectParams, type DrawPcbSilkscreenTextParams, type DrawPcbSmtPadParams, type DrawPcbTraceParams, type DrawPcbViaParams, type DrawPillParams, type DrawPolygonParams, type DrawRectParams, type DrawerConfig, type PcbColorMap, drawCircle, drawLine, drawOval, drawPath, drawPcbBoard, drawPcbCopperPour, drawPcbCutout, drawPcbHole, drawPcbPlatedHole, drawPcbSilkscreenCircle, drawPcbSilkscreenLine, drawPcbSilkscreenPath, drawPcbSilkscreenRect, drawPcbSilkscreenText, drawPcbSmtPad, drawPcbTrace, drawPcbVia, drawPill, drawPolygon, drawRect };