@tscircuit/cli 0.0.189 → 0.0.191

package/docs/EDIT_EVENT_PIPELINE.md

@@ -0,0 +1,34 @@
+# Edit Event Pipeline
+
+Whenever someone makes a manual edit to tscircuit, a `manual-edits.ts` file is created
+or edited describing what was changed. This file can be loaded into a `<board />` component
+with `layout={layout().manualEdits(manualEdits)}`.
+
+There pipeline for edit events is kind of complicated because the event must appear
+to happen instantaneously, but must also be stored, and the circuit should be
+re-rendered to determine the new routing.
+
+If you're debugging the edit event pipeline, turn on the debug logs:
+
+```bash
+DEBUG=tscircuit:cli:edit-event-watcher
+```
+
+## How the Edit Events are Processed
+
+This these are all the steps that happen to add an edit to `manual-edits.ts`,
+then apply it to the circuit.
+
+1. The user makes a change inside the `pcb-viewer` or `schematic-viewer`
+2. An edit event is emitted via e.g. `<PCBViewer onEditEventsChanged={...} />`
+3. The edit event is added to the list of `instantEditEvents` in `MainContentView.tsx`
+   1. Instant edit events are applied on the browser side, but don't re-route the circuit
+   2. You can tell you're in the phase where the edit event is still be processed and hasn't
+      been rendered because the traces still point to the old location
+4. The edit event is sent to the api server in a post request to `/api/dev_package_examples/update`
+5. The api server adds the edit event to the database
+6. The CLI "watcher" (see `start-edit-event-watcher.ts`) polls for new edit events
+7. The CLI watcher edits the `manual-edits.ts` file and triggers the circuit to re-render
+8. The circuit re-renders and the circuit json (soup) is updated on the server via `/api/dev_package_examples/update`
+9. The browser polls for the updated soup via `/api/dev_package_examples/get_soup` and the browser
+   updates with the fully routed circuit json

package/example-project/examples/macrokeypad.tsx

@@ -29,7 +29,11 @@ export const MacroKeypad = () => {
   }
 
   return (
-    <board width="120mm" height="80mm">
+    <board
+      width="120mm"
+      height="80mm"
+      layout={layout().manualEdits(manualEdits)}
+    >
       {keyPositions.map(({ keyNum, x, y }) => (
         <Key name={`K${keyNum}`} keyNum={keyNum} pcbX={x} pcbY={y} />
       ))}

package/example-project/src/manual-edits.ts

@@ -52,6 +52,102 @@ export default {
       relative_to: "group_center",
     },
   ],
-  manual_trace_hints: [],
+  manual_trace_hints: [
+    {
+      pcb_port_selector: ".SW4 > .pin2",
+      offsets: [
+        {
+          x: -8.492199000694345,
+          y: -1.998912735924403,
+          via: false,
+        },
+      ],
+    },
+    {
+      pcb_port_selector: ".D4 > .pin2",
+      offsets: [
+        {
+          x: -13.122988422132295,
+          y: -8.524891307031254,
+          via: false,
+        },
+      ],
+    },
+    {
+      pcb_port_selector: ".D1 > .pin2",
+      offsets: [
+        {
+          x: -8.302539134254346,
+          y: -25.869889610856028,
+          via: true,
+        },
+        {
+          x: 32.60178017340978,
+          y: -2.310485746577827,
+          via: true,
+        },
+      ],
+    },
+    {
+      pcb_port_selector: ".SW7 > .pin1",
+      offsets: [
+        {
+          x: -23.955683342322523,
+          y: 10.88389101192926,
+          via: false,
+        },
+        {
+          x: -16.747386499009068,
+          y: 10.88389101192926,
+          via: false,
+        },
+      ],
+    },
+    {
+      pcb_port_selector: ".SW4 > .pin1",
+      offsets: [
+        {
+          x: -23.904010775309708,
+          y: -3.8845684719809483,
+          via: false,
+        },
+      ],
+    },
+    {
+      pcb_port_selector: ".SW1 > .pin2",
+      offsets: [
+        {
+          x: -9.94176262647342,
+          y: -22.9635299104251,
+          via: false,
+        },
+      ],
+    },
+    {
+      pcb_port_selector: ".D2 > .pin2",
+      offsets: [
+        {
+          x: 13.891002671418706,
+          y: -22.21580740004698,
+          via: false,
+        },
+      ],
+    },
+    {
+      pcb_port_selector: ".D3 > .pin2",
+      offsets: [
+        {
+          x: 30.876601037632064,
+          y: -25.674952976702208,
+          via: true,
+        },
+        {
+          x: 44.2153867766214,
+          y: 0.20923347590906705,
+          via: true,
+        },
+      ],
+    },
+  ],
   edit_events: [],
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/cli",
-  "version": "0.0.189",
+  "version": "0.0.191",
   "private": false,
   "type": "module",
   "description": "Command line tool for developing, publishing and installing tscircuit circuits",
@@ -37,7 +37,7 @@
     "@edge-runtime/primitives": "^4.1.0",
     "@hono/node-server": "^1.8.2",
     "@tscircuit/builder": "*",
-    "@tscircuit/core": "0.0.41",
+    "@tscircuit/core": "0.0.44",
     "@tscircuit/props": "^0.0.62",
     "archiver": "^7.0.1",
     "axios": "^1.6.7",
@@ -97,7 +97,7 @@
     "@tscircuit/3d-viewer": "^0.0.17",
     "@tscircuit/layout": "^0.0.28",
     "@tscircuit/manual-edit-events": "^0.0.4",
-    "@tscircuit/pcb-viewer": "^1.4.4",
+    "@tscircuit/pcb-viewer": "^1.9.1",
     "@tscircuit/schematic-viewer": "^1.2.14",
     "@tscircuit/soup-util": "^0.0.23",
     "@tscircuit/table-viewer": "0.0.8",