@tscircuit/curvy-trace-solver 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,92 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Publish to npm
+on:
+  push:
+    branches:
+      - main
+      - '!version-bumps/**'
+  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
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - uses: actions/setup-node@v4
+        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@v6
+        with:
+          commit-message: "chore: bump version"
+          title: "chore: bump version to v${{ steps.package-version.outputs.version }}"
+          body: "Automated package update"
+          branch: version-bumps/v${{ steps.package-version.outputs.version }}
+          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
+      - name: Notify release-tracker of version update
+        # Continue-on-error just in case the tracker is down
+        continue-on-error: true
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          PACKAGE_JSON=$(cat package.json)
+          curl -X POST https://release-tracker.tscircuit.com/release_events/create \
+            -H "Content-Type: application/json" \
+            -d "{
+              \"event\": {
+                \"event_type\": \"versions_updated\",
+                \"repo\": \"tscircuit/circuit-json-to-kicad\",
+                \"version\": \"$VERSION\",
+                \"package_json\": $PACKAGE_JSON
+              }
+            }"

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

@@ -0,0 +1,40 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Bun Test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - '!version-bumps/**'
+
+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
+
+      - name: Upload snapshot artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-snapshots
+          path: tests/**/__snapshots__/*.diff.png
+          if-no-files-found: ignore

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/README.md

@@ -1,3 +1,102 @@
 # @tscircuit/curvy-trace-solver
 
 Convert trace waypoints into curvy traces maximizing trace-to-trace and trace-to-obstacle distance
+
+<img width="1352" height="1420" alt="image" src="https://github.com/user-attachments/assets/197d546a-6d2b-4bdc-8708-27a76430ff63" />
+
+## Installation
+
+```bash
+bun add @tscircuit/curvy-trace-solver
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { CurvyTraceSolver } from "@tscircuit/curvy-trace-solver"
+import type { CurvyTraceProblem } from "@tscircuit/curvy-trace-solver"
+
+const problem: CurvyTraceProblem = {
+  bounds: { minX: 0, minY: 0, maxX: 100, maxY: 100 },
+  waypointPairs: [
+    {
+      start: { x: 0, y: 10 },
+      end: { x: 100, y: 80 },
+    },
+    {
+      start: { x: 0, y: 20 },
+      end: { x: 100, y: 90 },
+    },
+  ],
+  obstacles: [],
+  preferredSpacing: 25,
+}
+
+const solver = new CurvyTraceSolver(problem)
+solver.solve()
+
+// Access the solved traces
+console.log(solver.outputTraces)
+// Each trace contains: { waypointPair, points: Point[], networkId? }
+```
+
+### Problem Definition
+
+A `CurvyTraceProblem` consists of:
+
+| Property           | Type             | Description                                                                 |
+| ------------------ | ---------------- | --------------------------------------------------------------------------- |
+| `bounds`           | `Bounds`         | The rectangular area containing the traces (`minX`, `minY`, `maxX`, `maxY`) |
+| `waypointPairs`    | `WaypointPair[]` | Array of start/end point pairs to connect with traces                       |
+| `obstacles`        | `Obstacle[]`     | Rectangular obstacles that traces should avoid                              |
+| `preferredSpacing` | `number`         | Minimum desired spacing between traces                                      |
+
+### Waypoint Pairs
+
+```typescript
+interface WaypointPair {
+  start: { x: number; y: number }
+  end: { x: number; y: number }
+  networkId?: string // Traces with the same networkId are allowed to intersect
+}
+```
+
+### Obstacles
+
+```typescript
+interface Obstacle {
+  minX: number
+  minY: number
+  maxX: number
+  maxY: number
+  center: { x: number; y: number }
+  networkId?: string // Traces with matching networkId can pass through this obstacle
+}
+```
+
+### Output
+
+After calling `solver.solve()`, access `solver.outputTraces` which contains:
+
+```typescript
+interface OutputTrace {
+  waypointPair: WaypointPair
+  points: Point[] // Array of points forming the curved trace
+  networkId?: string
+}
+```
+
+### Visualization
+
+The solver provides a `visualize()` method that returns a `GraphicsObject` compatible with `graphics-debug`:
+
+```typescript
+import { getSvgFromGraphicsObject } from "graphics-debug"
+
+const solver = new CurvyTraceSolver(problem)
+solver.solve()
+
+const svg = getSvgFromGraphicsObject(solver.visualize())
+```

package/dist/index.js

@@ -201,169 +201,9 @@ var require_deep_rename_keys = __commonJS({
   }
 });
 
-// node_modules/xml-reader/node_modules/eventemitter3/index.js
+// node_modules/eventemitter3/index.js
 var require_eventemitter3 = __commonJS({
-  "node_modules/xml-reader/node_modules/eventemitter3/index.js"(exports, module) {
-    "use strict";
-    var has = Object.prototype.hasOwnProperty;
-    var prefix = "~";
-    function Events() {
-    }
-    if (Object.create) {
-      Events.prototype = /* @__PURE__ */ Object.create(null);
-      if (!new Events().__proto__) prefix = false;
-    }
-    function EE(fn, context, once) {
-      this.fn = fn;
-      this.context = context;
-      this.once = once || false;
-    }
-    function EventEmitter() {
-      this._events = new Events();
-      this._eventsCount = 0;
-    }
-    EventEmitter.prototype.eventNames = function eventNames() {
-      var names = [], events, name;
-      if (this._eventsCount === 0) return names;
-      for (name in events = this._events) {
-        if (has.call(events, name)) names.push(prefix ? name.slice(1) : name);
-      }
-      if (Object.getOwnPropertySymbols) {
-        return names.concat(Object.getOwnPropertySymbols(events));
-      }
-      return names;
-    };
-    EventEmitter.prototype.listeners = function listeners(event, exists) {
-      var evt = prefix ? prefix + event : event, available = this._events[evt];
-      if (exists) return !!available;
-      if (!available) return [];
-      if (available.fn) return [available.fn];
-      for (var i = 0, l = available.length, ee = new Array(l); i < l; i++) {
-        ee[i] = available[i].fn;
-      }
-      return ee;
-    };
-    EventEmitter.prototype.emit = function emit(event, a1, a2, a3, a4, a5) {
-      var evt = prefix ? prefix + event : event;
-      if (!this._events[evt]) return false;
-      var listeners = this._events[evt], len = arguments.length, args, i;
-      if (listeners.fn) {
-        if (listeners.once) this.removeListener(event, listeners.fn, void 0, true);
-        switch (len) {
-          case 1:
-            return listeners.fn.call(listeners.context), true;
-          case 2:
-            return listeners.fn.call(listeners.context, a1), true;
-          case 3:
-            return listeners.fn.call(listeners.context, a1, a2), true;
-          case 4:
-            return listeners.fn.call(listeners.context, a1, a2, a3), true;
-          case 5:
-            return listeners.fn.call(listeners.context, a1, a2, a3, a4), true;
-          case 6:
-            return listeners.fn.call(listeners.context, a1, a2, a3, a4, a5), true;
-        }
-        for (i = 1, args = new Array(len - 1); i < len; i++) {
-          args[i - 1] = arguments[i];
-        }
-        listeners.fn.apply(listeners.context, args);
-      } else {
-        var length = listeners.length, j;
-        for (i = 0; i < length; i++) {
-          if (listeners[i].once) this.removeListener(event, listeners[i].fn, void 0, true);
-          switch (len) {
-            case 1:
-              listeners[i].fn.call(listeners[i].context);
-              break;
-            case 2:
-              listeners[i].fn.call(listeners[i].context, a1);
-              break;
-            case 3:
-              listeners[i].fn.call(listeners[i].context, a1, a2);
-              break;
-            case 4:
-              listeners[i].fn.call(listeners[i].context, a1, a2, a3);
-              break;
-            default:
-              if (!args) for (j = 1, args = new Array(len - 1); j < len; j++) {
-                args[j - 1] = arguments[j];
-              }
-              listeners[i].fn.apply(listeners[i].context, args);
-          }
-        }
-      }
-      return true;
-    };
-    EventEmitter.prototype.on = function on(event, fn, context) {
-      var listener = new EE(fn, context || this), evt = prefix ? prefix + event : event;
-      if (!this._events[evt]) this._events[evt] = listener, this._eventsCount++;
-      else if (!this._events[evt].fn) this._events[evt].push(listener);
-      else this._events[evt] = [this._events[evt], listener];
-      return this;
-    };
-    EventEmitter.prototype.once = function once(event, fn, context) {
-      var listener = new EE(fn, context || this, true), evt = prefix ? prefix + event : event;
-      if (!this._events[evt]) this._events[evt] = listener, this._eventsCount++;
-      else if (!this._events[evt].fn) this._events[evt].push(listener);
-      else this._events[evt] = [this._events[evt], listener];
-      return this;
-    };
-    EventEmitter.prototype.removeListener = function removeListener(event, fn, context, once) {
-      var evt = prefix ? prefix + event : event;
-      if (!this._events[evt]) return this;
-      if (!fn) {
-        if (--this._eventsCount === 0) this._events = new Events();
-        else delete this._events[evt];
-        return this;
-      }
-      var listeners = this._events[evt];
-      if (listeners.fn) {
-        if (listeners.fn === fn && (!once || listeners.once) && (!context || listeners.context === context)) {
-          if (--this._eventsCount === 0) this._events = new Events();
-          else delete this._events[evt];
-        }
-      } else {
-        for (var i = 0, events = [], length = listeners.length; i < length; i++) {
-          if (listeners[i].fn !== fn || once && !listeners[i].once || context && listeners[i].context !== context) {
-            events.push(listeners[i]);
-          }
-        }
-        if (events.length) this._events[evt] = events.length === 1 ? events[0] : events;
-        else if (--this._eventsCount === 0) this._events = new Events();
-        else delete this._events[evt];
-      }
-      return this;
-    };
-    EventEmitter.prototype.removeAllListeners = function removeAllListeners(event) {
-      var evt;
-      if (event) {
-        evt = prefix ? prefix + event : event;
-        if (this._events[evt]) {
-          if (--this._eventsCount === 0) this._events = new Events();
-          else delete this._events[evt];
-        }
-      } else {
-        this._events = new Events();
-        this._eventsCount = 0;
-      }
-      return this;
-    };
-    EventEmitter.prototype.off = EventEmitter.prototype.removeListener;
-    EventEmitter.prototype.addListener = EventEmitter.prototype.on;
-    EventEmitter.prototype.setMaxListeners = function setMaxListeners() {
-      return this;
-    };
-    EventEmitter.prefixed = prefix;
-    EventEmitter.EventEmitter = EventEmitter;
-    if ("undefined" !== typeof module) {
-      module.exports = EventEmitter;
-    }
-  }
-});
-
-// node_modules/xml-lexer/node_modules/eventemitter3/index.js
-var require_eventemitter32 = __commonJS({
-  "node_modules/xml-lexer/node_modules/eventemitter3/index.js"(exports, module) {
+  "node_modules/eventemitter3/index.js"(exports, module) {
     "use strict";
     var has = Object.prototype.hasOwnProperty;
     var prefix = "~";
@@ -533,7 +373,7 @@ var require_lexer = __commonJS({
       }
       return obj;
     }
-    var EventEmitter = require_eventemitter32();
+    var EventEmitter = require_eventemitter3();
     var noop = function noop2() {
     };
     var State = {

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@tscircuit/curvy-trace-solver",
   "main": "dist/index.js",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "scripts": {
     "start": "cosmos",
+    "format": "biome format --write .",
+    "format:check": "biome format .",
     "build": "tsup ./lib/index.ts --format esm --dts",
     "build:site": "cosmos-export"
   },

package/.claude/settings.local.json

@@ -1,16 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npx tsc:*)",
-      "mcp__ide__getDiagnostics",
-      "Bash(xargs:*)",
-      "Bash(npx tsx:*)",
-      "Bash(npm run benchmark:*)",
-      "Bash(for i in 1 2 3)",
-      "Bash(do echo \"Run $i:\")",
-      "Bash(done)",
-      "Bash(UPDATE_SNAPSHOTS=1 bun test:*)",
-      "Bash(BUN_UPDATE_SNAPSHOTS=true bun test:*)"
-    ]
-  }
-}