schematic-symbols 0.0.1

package/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @seveibar @tscircuit/core

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

@@ -0,0 +1,25 @@
+# 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@v3
+      - name: Setup bun
+        uses: oven-sh/setup-bun@v1
+        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 }}

package/README.md

@@ -0,0 +1,88 @@
+# schematic-symbols
+
+> [!WARNING]
+> This is a work-in-progress that contains all the schematic symbols for tscircuit.
+
+Schematic symbols for tscircuit
+
+## Usage
+
+```ts
+import { getSvg, resize, symbols } from "@tscircuit/schematic-symbols"
+
+console.log(symbols.resistor.primitives)
+// [{ type: "path", d: "M0 0L1 0...", color: "primary" }, {type: "text", text: "{REF}", ... }]
+console.log(symbols.resistor.size)
+// { width: 1, height: 0.6 }
+
+getSvg(resistor)
+// <svg><path d="M0 0L1 0... ...</svg>
+
+// You can easily resize symbols
+console.log(resize(symbols.resistor, { width: 100 }).size)
+// { width: 100, height: 60 }
+```
+
+## Adding New Symbols
+
+Go into the `./symbols` directory to add new shapes. After adding a shape file, it will
+automatically appear in the dev environment (`npm run dev`). Here's an example of a shape
+file:
+
+```ts
+// boxresistor.ts
+import { path, text, defineSymbol } from "drawing"
+
+export const boxresistor = defineSymbol({
+  primitives: [
+    path({ points: [[0, 0] /* ... */, , [1, 0]], color: "primary" }),
+    text("{REF}", { x: 0.5, y: 0.3, anchor: "middle_top" }),
+  ],
+  ports: [
+    { x: 0, y: 0, labels: ["1", "-"] },
+    { x: 1, y: 0, labels: ["2", "+"] },
+  ],
+  center: { x: 0.5, y: 0 },
+  size: { width: 1, height: 0.6 },
+})
+```
+
+### Primitives
+
+Various primitive JSON elements are defined to represent components, each primitive has
+a function you can use to quickly define it inside new symbol definitions.
+
+| Primitive | Description                                                 |
+| --------- | ----------------------------------------------------------- |
+| `path`    | A set of lines `{ points: Array<[number, number]>, color }` |
+| `text`    | Text `{ text, x, y, anchor }`                               |
+| `circle`  | Circle `{ x, y, radius }`                                   |
+| `box`     | Box `{ x, y, width, height, anchor }`                       |
+
+### Colors
+
+You can use the following color aliases to color your symbol:
+
+- `primary`
+- `secondary`
+- `background`
+
+### Guidelines
+
+The symbols should all look correct next to eachother, since they're all used together
+in the same schematic.
+
+- The width of most standard passives is `1`
+- The height of most standard passives is `0.6`
+
+### Development
+
+Software needed to edit this project:
+- VS Code
+- Inkscape
+
+## References
+
+- [MIT Schematic Symbols](https://github.com/sjgallagher2/SchematicSymbolsSVG)
+- [affinity-circuit-symbols-asset](https://github.com/keikawa/affinity-circuit-symbols-asset/tree/main)
+- [Inkscape Symbols](https://github.com/upb-lea/Inkscape_electric_Symbols?tab=readme-ov-file)

package/assets/symbols-svg-json/boxresistor.json

@@ -0,0 +1,90 @@
+{
+  "paths": {
+    "path1": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.5291666499999996,
+          "y": 0
+        },
+        {
+          "x": -0.2645833500000001,
+          "y": 0
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path2": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.2645832500000007,
+          "y": 0
+        },
+        {
+          "x": 0.5291666500000001,
+          "y": 0
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path3": {
+      "type": "path",
+      "points": [
+        {
+          "x": -1.4999999997655777e-7,
+          "y": -0.13229169999999968
+        },
+        {
+          "x": 0.26458314999999955,
+          "y": -0.13229169999999968
+        },
+        {
+          "x": 0.26458314999999955,
+          "y": 0.13229169999999968
+        },
+        {
+          "x": -0.2645835500000011,
+          "y": 0.13229169999999968
+        },
+        {
+          "x": -0.2645835500000011,
+          "y": -0.13229169999999968
+        },
+        {
+          "x": -1.5000000175291461e-7,
+          "y": -0.13229169999999968
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    }
+  },
+  "texts": {
+    "top1": {
+      "type": "text",
+      "text": "{REF}",
+      "x": -0.018740649999999803,
+      "y": -0.20383659999999892
+    },
+    "bottom1": {
+      "type": "text",
+      "text": "{VAL}",
+      "x": -0.01777865000000034,
+      "y": 0.2961594000000023
+    }
+  },
+  "refblocks": {},
+  "bounds": {
+    "minX": -0.5291666499999996,
+    "maxX": 0.5291666500000001,
+    "minY": -0.13229169999999968,
+    "maxY": 0.13229169999999968,
+    "width": 1.0583332999999997,
+    "height": 0.26458339999999936,
+    "centerX": 2.220446049250313e-16,
+    "centerY": 0
+  }
+}

package/assets/symbols-svg-json/capacitor.json

@@ -0,0 +1,76 @@
+{
+  "paths": {
+    "path27": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.5291666500000001,
+          "y": 0
+        },
+        {
+          "x": 0.07937504999999989,
+          "y": 0
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path28": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.07937494999999961,
+          "y": 0
+        },
+        {
+          "x": -0.5291666500000001,
+          "y": 0
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path29": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.07937504999999989,
+          "y": -0.26458330000000174
+        },
+        {
+          "x": 0.07937504999999989,
+          "y": 0.2645832999999982
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path30": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.07937495000000006,
+          "y": -0.26458330000000174
+        },
+        {
+          "x": -0.07937494999999961,
+          "y": 0.2645832999999982
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    }
+  },
+  "texts": {},
+  "refblocks": {},
+  "bounds": {
+    "minX": -0.5291666500000001,
+    "maxX": 0.5291666500000001,
+    "minY": -0.26458330000000174,
+    "maxY": 0.2645832999999982,
+    "width": 1.0583333000000001,
+    "height": 0.5291665999999999,
+    "centerX": 0,
+    "centerY": -1.7763568394002505e-15
+  }
+}

package/assets/symbols-svg-json/capacitor_polarized.json

@@ -0,0 +1,83 @@
+{
+  "paths": {
+    "path31": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.5291666499999996,
+          "y": 0
+        },
+        {
+          "x": 0.07937484999999933,
+          "y": 0
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path32": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.07937515000000017,
+          "y": 0
+        },
+        {
+          "x": -0.5291666500000001,
+          "y": 0
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path33": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.07937504999999989,
+          "y": -0.2645832999999982
+        },
+        {
+          "x": 0.07937504999999989,
+          "y": 0.26458329999999997
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path34": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.07937495000000006,
+          "y": -0.2645832999999982
+        },
+        {
+          "x": -0.07937495000000006,
+          "y": 0.26458329999999997
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    }
+  },
+  "texts": {
+    "top1": {
+      "type": "text",
+      "text": "+",
+      "x": 0.13859564999999963,
+      "y": -0.3182225999999986
+    }
+  },
+  "refblocks": {},
+  "bounds": {
+    "minX": -0.5291666500000001,
+    "maxX": 0.5291666499999996,
+    "minY": -0.2645832999999982,
+    "maxY": 0.26458329999999997,
+    "width": 1.0583332999999997,
+    "height": 0.5291665999999982,
+    "centerX": -2.220446049250313e-16,
+    "centerY": 8.881784197001252e-16
+  }
+}

package/assets/symbols-svg-json/diode.json

@@ -0,0 +1,91 @@
+{
+  "paths": {
+    "path40": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.13229164999999998,
+          "y": 0
+        },
+        {
+          "x": -0.13229164999999954,
+          "y": 0.13229169999999968
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path41": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.13229164999999954,
+          "y": -0.13229170000000323
+        },
+        {
+          "x": 0.13229164999999998,
+          "y": 0
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path42": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.13229164999999954,
+          "y": 0.13229169999999613
+        },
+        {
+          "x": -0.13229164999999954,
+          "y": -0.13229170000000323
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path43": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.13229164999999998,
+          "y": -0.13229170000000323
+        },
+        {
+          "x": 0.13229164999999998,
+          "y": 0.13229169999999613
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path44": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.5291666500000001,
+          "y": 0
+        },
+        {
+          "x": -0.5291666499999996,
+          "y": 0
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    }
+  },
+  "texts": {},
+  "refblocks": {},
+  "bounds": {
+    "minX": -0.5291666499999996,
+    "maxX": 0.5291666500000001,
+    "minY": -0.13229170000000323,
+    "maxY": 0.13229169999999968,
+    "width": 1.0583332999999997,
+    "height": 0.2645834000000029,
+    "centerX": 2.220446049250313e-16,
+    "centerY": -1.7763568394002505e-15
+  }
+}

package/assets/symbols-svg-json/diode_bipolar_zener.json

@@ -0,0 +1,166 @@
+{
+  "paths": {
+    "path67": {
+      "type": "path",
+      "points": [
+        {
+          "x": 5.000000058430487e-8,
+          "y": 3.552713678800501e-15
+        },
+        {
+          "x": -0.2645832499999994,
+          "y": 0.13229200000000318
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path68": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.2645832499999994,
+          "y": -0.13229199999999608
+        },
+        {
+          "x": 5.000000058430487e-8,
+          "y": 0
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path69": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.2645832499999994,
+          "y": 0.13229200000000318
+        },
+        {
+          "x": -0.2645832499999994,
+          "y": -0.13229199999999608
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path70": {
+      "type": "path",
+      "points": [
+        {
+          "x": 5.000000058430487e-8,
+          "y": -0.13229199999999608
+        },
+        {
+          "x": 5.000000058430487e-8,
+          "y": 0.13229200000000318
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path71": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.5291666499999996,
+          "y": -9.999999974752427e-7
+        },
+        {
+          "x": -0.5291666500000001,
+          "y": -9.999999974752427e-7
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path72": {
+      "type": "path",
+      "points": [
+        {
+          "x": 4.499999994855841e-7,
+          "y": 0.13229200000000318
+        },
+        {
+          "x": -0.07937455000000071,
+          "y": 0.13229200000000318
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path73": {
+      "type": "path",
+      "points": [
+        {
+          "x": 4.499999994855841e-7,
+          "y": -0.1322909999999986
+        },
+        {
+          "x": 0.07937544999999968,
+          "y": -0.1322909999999986
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path74": {
+      "type": "path",
+      "points": [
+        {
+          "x": 3.49999999649242e-7,
+          "y": 3.552713678800501e-15
+        },
+        {
+          "x": 0.2645833500000001,
+          "y": -0.13229199999999608
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path75": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.2645833500000001,
+          "y": 0.13229200000000318
+        },
+        {
+          "x": 3.49999999649242e-7,
+          "y": 3.552713678800501e-15
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path76": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.2645833500000001,
+          "y": -0.13229199999999608
+        },
+        {
+          "x": 0.2645833500000001,
+          "y": 0.13229200000000318
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    }
+  },
+  "texts": {},
+  "refblocks": {},
+  "bounds": {
+    "minX": -0.5291666500000001,
+    "maxX": 0.5291666499999996,
+    "minY": -0.13229199999999608,
+    "maxY": 0.13229200000000318,
+    "width": 1.0583332999999997,
+    "height": 0.26458399999999926,
+    "centerX": -2.220446049250313e-16,
+    "centerY": 3.552713678800501e-15
+  }
+}

package/assets/symbols-svg-json/diode_schottky.json

@@ -0,0 +1,76 @@
+{
+  "paths": {
+    "path63": {
+      "type": "path",
+      "points": [
+        {
+          "x": -5.000000014021566e-8,
+          "y": -0.13229199999999963
+        },
+        {
+          "x": 0.05291665000000023,
+          "y": -0.13229199999999963
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path64": {
+      "type": "path",
+      "points": [
+        {
+          "x": 0.05291665000000023,
+          "y": -0.07937499999999886
+        },
+        {
+          "x": 0.05291665000000023,
+          "y": -0.13229199999999963
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path65": {
+      "type": "path",
+      "points": [
+        {
+          "x": -5.000000014021566e-8,
+          "y": 0.13229199999999963
+        },
+        {
+          "x": -0.05291665000000023,
+          "y": 0.13229199999999963
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    },
+    "path66": {
+      "type": "path",
+      "points": [
+        {
+          "x": -0.05291665000000023,
+          "y": 0.07937499999999886
+        },
+        {
+          "x": -0.05291665000000023,
+          "y": 0.13229199999999963
+        }
+      ],
+      "color": "primary",
+      "fill": false
+    }
+  },
+  "texts": {},
+  "refblocks": {},
+  "bounds": {
+    "minX": -0.05291665000000023,
+    "maxX": 0.05291665000000023,
+    "minY": -0.13229199999999963,
+    "maxY": 0.13229199999999963,
+    "width": 0.10583330000000046,
+    "height": 0.26458399999999926,
+    "centerX": 0,
+    "centerY": 0
+  }
+}