@tscircuit/fabricator-drc 0.0.1

package/README.md

@@ -0,0 +1,60 @@
+# @tscircuit/fabricator-drc
+
+Fabricator-specific DRC checks for tscircuit. Install the provider through the
+optional `platform.fabricatorEngine` interface:
+
+```tsx
+import { RootCircuit } from "@tscircuit/core"
+import { fabricatorEngine } from "@tscircuit/fabricator-drc"
+
+const circuit = new RootCircuit({ platform: { fabricatorEngine } })
+circuit.add(
+  <board width="10mm" height="10mm" fabricatorPreset="jlcpcb_economy">
+    <via name="V1" pcbX={0} pcbY={0} holeDiameter="0.25mm"
+      outerDiameter="0.6mm" fromLayer="top" toLayer="bottom" />
+  </board>,
+)
+await circuit.renderUntilSettled()
+```
+
+Requires the fabricator engine integration in core and props. The package is
+not yet published to npm.
+
+## Initial check
+
+For `jlcpcb_economy`, `jlcpcb_standard`, `jlcpcb_economy_20260912`, and
+`jlcpcb_standard_20260912`, via **hole diameters strictly below 0.3 mm** produce
+one `pcb_fabricator_extra_charge_warning` per board with all affected via IDs.
+Exactly 0.3 mm is allowed without this warning. Outer copper diameter does not
+control this check. This records a surcharge warning, not a fabrication error,
+and does not change via geometry or calculate a fee.
+
+The spelling is `jlcpcb_economy`, matching the board prop. Unversioned presets
+resolve to the 20260912 rules. Dated presets remain fixed; add a new dated
+preset before changing rules. Unknown presets currently return no diagnostics.
+
+## Provider contract
+
+`runDrcChecks({ circuitJson, fabricatorPreset, pcbBoardId })`
+returns Circuit JSON diagnostic records. Core supplies the selected board's
+subtree after routing; callers using the function directly must supply that
+same scope. Circuit JSON positions and distances use millimeters in board world
+coordinates (+X right, +Y up, +Z above). The function does not mutate its input.
+
+Core inserts the returned records into the circuit. Omitted engines or presets,
+`drcChecksDisabled`, and `pcbDisabled` prevent execution. Disabling autorouting
+does not disable the check for manually placed vias.
+
+## Development
+
+```sh
+bun install
+bun test
+bun run typecheck
+bun run build
+bun run format:check
+```
+
+Preset rule data and diagnostic generation live in `lib/index.ts`. Add checks
+with boundary tests and preserve dated preset behavior. CI validates tests,
+types, build output, and formatting; npm publishing is not configured yet.

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { AnyCircuitElement, PcbBoard, PcbFabricatorExtraChargeWarning } from 'circuit-json';
+
+interface FabricatorDrcParams {
+    /** Board subtree in Circuit JSON world coordinates: +X right, +Y up, +Z above; positions and distances in mm. */
+    circuitJson: AnyCircuitElement[];
+    fabricatorPreset: string;
+    pcbBoardId: PcbBoard["pcb_board_id"];
+}
+/** Dated presets keep fixed rules; unversioned names select the current rules. */
+declare const fabricatorPresets: {
+    readonly jlcpcb_economy_20260912: {
+        readonly minimumViaHoleDiameterWithoutExtraCharge: 0.3;
+    };
+    readonly jlcpcb_standard_20260912: {
+        readonly minimumViaHoleDiameterWithoutExtraCharge: 0.3;
+    };
+};
+/** Generate surcharge diagnostics without modifying geometry or input records. */
+declare function runDrcChecks({ circuitJson, fabricatorPreset, pcbBoardId, }: FabricatorDrcParams): PcbFabricatorExtraChargeWarning[];
+/** Install as platform.fabricatorEngine in @tscircuit/core. */
+declare const fabricatorEngine: {
+    runDrcChecks: typeof runDrcChecks;
+};
+
+export { type FabricatorDrcParams, fabricatorEngine, fabricatorPresets, runDrcChecks };

package/dist/index.js

@@ -0,0 +1,42 @@
+// lib/index.ts
+import {
+  pcb_fabricator_extra_charge_warning
+} from "circuit-json";
+var fabricatorPresets = {
+  jlcpcb_economy_20260912: { minimumViaHoleDiameterWithoutExtraCharge: 0.3 },
+  jlcpcb_standard_20260912: { minimumViaHoleDiameterWithoutExtraCharge: 0.3 }
+};
+var presetAliases = {
+  jlcpcb_economy: "jlcpcb_economy_20260912",
+  jlcpcb_standard: "jlcpcb_standard_20260912"
+};
+function resolvePreset(name) {
+  const resolved = Object.hasOwn(presetAliases, name) ? presetAliases[name] : name;
+  return Object.hasOwn(fabricatorPresets, resolved) ? fabricatorPresets[resolved] : void 0;
+}
+function runDrcChecks({
+  circuitJson,
+  fabricatorPreset,
+  pcbBoardId
+}) {
+  const preset = resolvePreset(fabricatorPreset);
+  if (!preset) return [];
+  const threshold = preset.minimumViaHoleDiameterWithoutExtraCharge;
+  const smallVias = circuitJson.filter((element) => element.type === "pcb_via").filter((via) => via.hole_diameter < threshold);
+  if (smallVias.length === 0) return [];
+  return [
+    pcb_fabricator_extra_charge_warning.parse({
+      type: "pcb_fabricator_extra_charge_warning",
+      fabricator_preset: fabricatorPreset,
+      pcb_board_id: pcbBoardId,
+      pcb_via_ids: smallVias.map((via) => via.pcb_via_id),
+      message: `${fabricatorPreset}: ${smallVias.length} via(s) have a hole diameter below ${threshold} mm and incur an extra fabrication charge. Use a hole diameter of at least ${threshold} mm to avoid this charge.`
+    })
+  ];
+}
+var fabricatorEngine = { runDrcChecks };
+export {
+  fabricatorEngine,
+  fabricatorPresets,
+  runDrcChecks
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@tscircuit/fabricator-drc",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "Fabricator-specific Circuit JSON design rule checks",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tscircuit/fabricator-drc"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "scripts": {
+    "test": "bun test",
+    "typecheck": "tsc --noEmit",
+    "build": "tsup lib/index.ts --format esm --dts",
+    "format:check": "biome format .",
+    "prepare": "bun run build",
+    "prepack": "bun run build"
+  },
+  "dependencies": {
+    "circuit-json": "^0.0.489",
+    "zod": "^3.25.76"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@types/bun": "^1.2.16",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}