@tscircuit/schematic-trace-solver 0.0.1

package/.claude/settings.local.json

@@ -0,0 +1,6 @@
+{
+  "permissions": {
+    "allow": ["Bash(bun:*)"],
+    "deny": []
+  }
+}

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,28 @@
+# Created using @tscircuit/plop (npm install -g @tscircuit/plop)
+name: Publish to npm
+on:
+  push:
+    branches:
+      - main
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    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
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.TSCIRCUIT_BOT_GITHUB_TOKEN }}

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

@@ -0,0 +1,28 @@
+# 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
+
+    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) 2024 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

@@ -0,0 +1,75 @@
+# Schematic Trace Solver
+
+Solve for the correct positions and routing for schematic traces and net labels. For use inside [@tscircuit/core](https://github.com/tscircuit/core)
+
+[Online Playground](https://schematic-trace-solver.vercel.app) ・ [tscircuit](https://github.com/tscircuit/tscircuit) ・ [@tscircuit/core](https://github.com/tscircuit/core)
+
+## Overview
+
+The Schematic Trace Solver is a pipeline that figures out how to route schematic traces
+and place net labels for a given schematic layout.
+
+Chips are defined by their center point, width, and height and pins.
+
+You then pass in direct connections and net connections. Direct connections are
+explicit pin-to-pin connections. When there's a direct connection between two
+pins, there is guaranteed to be a routed trace between them.
+
+Net connections will not be routed, net labels are placed instead.
+
+The solver first constructs minimum spanning tree to determine what pin-pairs
+to draw via the `MspConnectionPairSolver`. If there are two pins A and B that both connect to C, this phase will
+determine how to route traces to minimize overlap or crossings. e.g. we may
+decide to route a trace from A to B, then B to C OR we may decide to route a
+trace from A to C, then C to B. The pairs of traces are the mspConnectionPairs,
+these are used in future phases.
+
+After the minimum spanning tree is constructed, we draw the schematic traces
+for each mspConnectionPair via the `SchematicTraceLinesSolver`. The `TraceOverlapShiftSolver`
+then shifts the schematic traces to make sure there are no parallel overlapping traces by
+shifting parallel traces orthogonally by a small amount.
+
+Finally, the `NetLabelPlacementSolver` places net labels for each net connection. Often
+this requires drawing small traces to adapt to the `availableFacingDirections` of the net connection.
+If there is crowding at the pin, we look for an available spot along the trace connected to the pin.
+
+## Usage
+
+```tsx
+import { SchematicTracePipelineSolver } from "@tscircuit/schematic-trace-solver"
+
+type ChipId = string
+type PinId = string
+
+const solver = new SchematicTracePipelineSolver({
+  chips: {
+    chipId: "U1",
+    center: { x: 0, y: 0 },
+    width: 1.6,
+    height: 0.6,
+    pins: [
+      {
+        pinId: "U1.1",
+        x: -0.8,
+        y: 0.2,
+      },
+      // ...
+    ],
+  },
+  directConnections: [
+    {
+      pinIds: ["U1.1", "C1.1"],
+      netId: "VCC",
+    },
+    // ...
+  ],
+  netConnections: [
+    {
+      availableFacingDirections: ["y-"],
+      netId: "GND",
+      pinIds: ["U1.3", "C1.2", "C2.2"],
+    },
+    // ...
+  ],
+})
+```

package/biome.json

@@ -0,0 +1,93 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.0.0/schema.json",
+  "assist": { "actions": { "source": { "organizeImports": "on" } } },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space"
+  },
+  "files": {
+    "includes": ["**", "!**/cosmos-export", "!**/dist", "!**/package.json"]
+  },
+  "javascript": {
+    "formatter": {
+      "jsxQuoteStyle": "double",
+      "quoteProperties": "asNeeded",
+      "trailingCommas": "all",
+      "semicolons": "asNeeded",
+      "arrowParentheses": "always",
+      "bracketSpacing": true,
+      "bracketSameLine": false
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "suspicious": {
+        "noExplicitAny": "off"
+      },
+      "complexity": {
+        "noForEach": "error",
+        "useLiteralKeys": "off"
+      },
+      "a11y": {
+        "noAccessKey": "off",
+        "noAriaHiddenOnFocusable": "off",
+        "noAriaUnsupportedElements": "off",
+        "noAutofocus": "off",
+        "noDistractingElements": "off",
+        "noHeaderScope": "off",
+        "noInteractiveElementToNoninteractiveRole": "off",
+        "noLabelWithoutControl": "off",
+        "noNoninteractiveElementToInteractiveRole": "off",
+        "noNoninteractiveTabindex": "off",
+        "noPositiveTabindex": "off",
+        "noRedundantAlt": "off",
+        "noRedundantRoles": "off",
+        "noStaticElementInteractions": "off",
+        "noSvgWithoutTitle": "off",
+        "useAltText": "off",
+        "useAnchorContent": "off",
+        "useAriaActivedescendantWithTabindex": "off",
+        "useAriaPropsForRole": "off",
+        "useAriaPropsSupportedByRole": "off",
+        "useButtonType": "off",
+        "useFocusableInteractive": "off",
+        "useHeadingContent": "off",
+        "useHtmlLang": "off",
+        "useIframeTitle": "off",
+        "useKeyWithClickEvents": "off",
+        "useKeyWithMouseEvents": "off",
+        "useMediaCaption": "off",
+        "useSemanticElements": "off",
+        "useValidAnchor": "off",
+        "useValidAriaProps": "off",
+        "useValidAriaRole": "off",
+        "useValidAriaValues": "off",
+        "useValidAutocomplete": "off",
+        "useValidLang": "off"
+      },
+      "style": {
+        "useSingleVarDeclarator": "error",
+        "noParameterAssign": "off",
+        "noUselessElse": "off",
+        "noNonNullAssertion": "off",
+        "useNumberNamespace": "off",
+        "noUnusedTemplateLiteral": "off",
+        "useFilenamingConvention": {
+          "level": "error",
+          "options": {
+            "strictCase": true,
+            "requireAscii": true,
+            "filenameCases": ["kebab-case", "export"]
+          }
+        },
+        "useAsConstAssertion": "error",
+        "useDefaultParameterLast": "error",
+        "useEnumInitializers": "error",
+        "useSelfClosingElements": "error",
+        "noInferrableTypes": "error"
+      }
+    }
+  }
+}

package/bunfig.toml

@@ -0,0 +1,5 @@
+# [test]
+# preload = ["./tests/fixtures/preload.ts"]
+
+[install.lockfile]
+save = false

package/cosmos.config.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "http://json.schemastore.org/cosmos-config",
+  "plugins": ["react-cosmos-plugin-vite"],
+  "fixtureFileSuffix": "page",
+  "decoratorFile": "cosmos.decorator.tsx"
+}

package/cosmos.decorator.tsx

@@ -0,0 +1,21 @@
+import React, { useEffect } from "react"
+
+export const TailwindDecorator = ({
+  children,
+}: {
+  children: React.ReactNode
+}) => {
+  useEffect(() => {
+    const script = document.createElement("script")
+    script.src = "https://cdn.tailwindcss.com"
+    document.head.appendChild(script)
+
+    return () => {
+      document.head.removeChild(script)
+    }
+  }, [])
+
+  return <>{children}</>
+}
+
+export default TailwindDecorator