copperflow 0.3.4 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +117 -14
- package/dist/app/THIRD_PARTY_LICENSES.txt +5 -0
- package/dist/app/assets/NewPartDialog-ZQ4Y3m45.js +1 -0
- package/dist/app/assets/PackagesDialog-C8ZyWl-g.css +1 -0
- package/dist/app/assets/PackagesDialog-vEzilmpR.js +2 -0
- package/dist/app/assets/VerifyPartDialog-BHLqD_WJ.css +1 -0
- package/dist/app/assets/VerifyPartDialog-DYr1UIds.js +2 -0
- package/dist/app/assets/footprint-preview-Nyk2poiN.js +160 -0
- package/dist/app/assets/index-BUjGdMvr.js +20 -0
- package/dist/app/assets/index-CF7-tL4t.css +1 -0
- package/dist/app/assets/texture-worker-CyI_g_XZ.js +1 -0
- package/dist/app/index.html +2 -2
- package/dist/cli-commands.js +141 -16
- package/dist/cli-commands.js.map +1 -1
- package/dist/cli-impedance.d.ts +4 -0
- package/dist/cli-impedance.js +56 -0
- package/dist/cli-impedance.js.map +1 -0
- package/dist/cli-simulate.d.ts +3 -0
- package/dist/cli-simulate.js +54 -0
- package/dist/cli-simulate.js.map +1 -0
- package/dist/core/analyze.js +5 -2
- package/dist/core/analyze.js.map +1 -1
- package/dist/core/bom.d.ts +6 -1
- package/dist/core/bom.js +23 -4
- package/dist/core/bom.js.map +1 -1
- package/dist/core/case-results.d.ts +4 -0
- package/dist/core/case-results.js +9 -0
- package/dist/core/case-results.js.map +1 -0
- package/dist/core/change-files.d.ts +31 -0
- package/dist/core/change-files.js +67 -0
- package/dist/core/change-files.js.map +1 -0
- package/dist/core/change-render.d.ts +18 -0
- package/dist/core/change-render.js +48 -0
- package/dist/core/change-render.js.map +1 -0
- package/dist/core/change-view.d.ts +33 -0
- package/dist/core/change-view.js +73 -0
- package/dist/core/change-view.js.map +1 -0
- package/dist/core/change-words.d.ts +39 -0
- package/dist/core/change-words.js +214 -0
- package/dist/core/change-words.js.map +1 -0
- package/dist/core/checklist-text.d.ts +21 -0
- package/dist/core/checklist-text.js +59 -0
- package/dist/core/checklist-text.js.map +1 -0
- package/dist/core/edit.js +5 -2
- package/dist/core/edit.js.map +1 -1
- package/dist/core/fabrication.d.ts +9 -2
- package/dist/core/fabrication.js +29 -10
- package/dist/core/fabrication.js.map +1 -1
- package/dist/core/library.d.ts +46 -0
- package/dist/core/library.js +54 -16
- package/dist/core/library.js.map +1 -1
- package/dist/core/model-export.d.ts +33 -0
- package/dist/core/model-export.js +33 -0
- package/dist/core/model-export.js.map +1 -0
- package/dist/core/modules.d.ts +1 -0
- package/dist/core/modules.js +17 -0
- package/dist/core/modules.js.map +1 -1
- package/dist/core/order-report.d.ts +10 -0
- package/dist/core/order-report.js +93 -0
- package/dist/core/order-report.js.map +1 -0
- package/dist/core/packages.d.ts +18 -0
- package/dist/core/packages.js +49 -0
- package/dist/core/packages.js.map +1 -0
- package/dist/core/pin-header.d.ts +5 -0
- package/dist/core/pin-header.js +77 -0
- package/dist/core/pin-header.js.map +1 -0
- package/dist/core/pin-map.d.ts +46 -0
- package/dist/core/pin-map.js +101 -0
- package/dist/core/pin-map.js.map +1 -0
- package/dist/core/render.d.ts +26 -5
- package/dist/core/render.js +16 -6
- package/dist/core/render.js.map +1 -1
- package/dist/core/sheet-card.d.ts +4 -0
- package/dist/core/sheet-card.js +46 -1
- package/dist/core/sheet-card.js.map +1 -1
- package/dist/core/sheet-files.js +10 -3
- package/dist/core/sheet-files.js.map +1 -1
- package/dist/core/simulate.d.ts +19 -0
- package/dist/core/simulate.js +72 -0
- package/dist/core/simulate.js.map +1 -0
- package/dist/core/step-export.d.ts +17 -0
- package/dist/core/step-export.js +35 -0
- package/dist/core/step-export.js.map +1 -0
- package/dist/core/supplier-prop.d.ts +6 -0
- package/dist/core/supplier-prop.js +21 -0
- package/dist/core/supplier-prop.js.map +1 -0
- package/dist/core/workspace.d.ts +2 -1
- package/dist/core/workspace.js +2 -1
- package/dist/core/workspace.js.map +1 -1
- package/dist/engine/board.js +3 -1
- package/dist/engine/board.js.map +1 -1
- package/dist/engine/checks/fast-lines.d.ts +60 -0
- package/dist/engine/checks/fast-lines.js +209 -0
- package/dist/engine/checks/fast-lines.js.map +1 -0
- package/dist/engine/checks/index.js +2 -0
- package/dist/engine/checks/index.js.map +1 -1
- package/dist/engine/design-diff.d.ts +120 -0
- package/dist/engine/design-diff.js +249 -0
- package/dist/engine/design-diff.js.map +1 -0
- package/dist/engine/design.d.ts +3 -0
- package/dist/engine/design.js +7 -2
- package/dist/engine/design.js.map +1 -1
- package/dist/engine/fab/export.d.ts +17 -1
- package/dist/engine/fab/export.js +26 -4
- package/dist/engine/fab/export.js.map +1 -1
- package/dist/engine/fab/names.d.ts +2 -2
- package/dist/engine/fab/names.js +4 -2
- package/dist/engine/fab/names.js.map +1 -1
- package/dist/engine/fab/picture/board-picture.d.ts +52 -0
- package/dist/engine/fab/picture/board-picture.js +102 -0
- package/dist/engine/fab/picture/board-picture.js.map +1 -0
- package/dist/engine/fab/picture/board-view.d.ts +20 -0
- package/dist/engine/fab/picture/board-view.js +50 -0
- package/dist/engine/fab/picture/board-view.js.map +1 -0
- package/dist/engine/fab/picture/compose.d.ts +50 -0
- package/dist/engine/fab/picture/compose.js +208 -0
- package/dist/engine/fab/picture/compose.js.map +1 -0
- package/dist/engine/fab/picture/layer-images.d.ts +9 -0
- package/dist/engine/fab/picture/layer-images.js +67 -0
- package/dist/engine/fab/picture/layer-images.js.map +1 -0
- package/dist/engine/fab/picture/looks.d.ts +152 -0
- package/dist/engine/fab/picture/looks.js +53 -0
- package/dist/engine/fab/picture/looks.js.map +1 -0
- package/dist/engine/fab/picture/png.d.ts +31 -0
- package/dist/engine/fab/picture/png.js +47 -0
- package/dist/engine/fab/picture/png.js.map +1 -0
- package/dist/engine/fab/picture/raster.d.ts +46 -0
- package/dist/engine/fab/picture/raster.js +170 -0
- package/dist/engine/fab/picture/raster.js.map +1 -0
- package/dist/engine/fab/zip.d.ts +2 -1
- package/dist/engine/fab/zip.js +1 -1
- package/dist/engine/fab/zip.js.map +1 -1
- package/dist/engine/footprints/array.d.ts +4 -0
- package/dist/engine/footprints/array.js +51 -0
- package/dist/engine/footprints/array.js.map +1 -0
- package/dist/engine/footprints/axial.d.ts +6 -0
- package/dist/engine/footprints/axial.js +115 -0
- package/dist/engine/footprints/axial.js.map +1 -0
- package/dist/engine/footprints/catalogue.d.ts +39 -0
- package/dist/engine/footprints/catalogue.js +284 -0
- package/dist/engine/footprints/catalogue.js.map +1 -0
- package/dist/engine/footprints/chip.js +10 -1
- package/dist/engine/footprints/chip.js.map +1 -1
- package/dist/engine/footprints/connector.d.ts +16 -0
- package/dist/engine/footprints/connector.js +31 -0
- package/dist/engine/footprints/connector.js.map +1 -0
- package/dist/engine/footprints/dcjack.d.ts +3 -0
- package/dist/engine/footprints/dcjack.js +46 -0
- package/dist/engine/footprints/dcjack.js.map +1 -0
- package/dist/engine/footprints/dpak.d.ts +7 -0
- package/dist/engine/footprints/dpak.js +172 -0
- package/dist/engine/footprints/dpak.js.map +1 -0
- package/dist/engine/footprints/dual.d.ts +11 -2
- package/dist/engine/footprints/dual.js +113 -12
- package/dist/engine/footprints/dual.js.map +1 -1
- package/dist/engine/footprints/index.js +46 -3
- package/dist/engine/footprints/index.js.map +1 -1
- package/dist/engine/footprints/inductor.d.ts +3 -0
- package/dist/engine/footprints/inductor.js +32 -0
- package/dist/engine/footprints/inductor.js.map +1 -0
- package/dist/engine/footprints/known.js +114 -14
- package/dist/engine/footprints/known.js.map +1 -1
- package/dist/engine/footprints/ledsmd.d.ts +3 -0
- package/dist/engine/footprints/ledsmd.js +52 -0
- package/dist/engine/footprints/ledsmd.js.map +1 -0
- package/dist/engine/footprints/ledth.d.ts +4 -0
- package/dist/engine/footprints/ledth.js +45 -0
- package/dist/engine/footprints/ledth.js.map +1 -0
- package/dist/engine/footprints/melf.d.ts +8 -0
- package/dist/engine/footprints/melf.js +56 -0
- package/dist/engine/footprints/melf.js.map +1 -0
- package/dist/engine/footprints/plcc.d.ts +4 -0
- package/dist/engine/footprints/plcc.js +117 -0
- package/dist/engine/footprints/plcc.js.map +1 -0
- package/dist/engine/footprints/resonator.d.ts +3 -0
- package/dist/engine/footprints/resonator.js +33 -0
- package/dist/engine/footprints/resonator.js.map +1 -0
- package/dist/engine/footprints/screw.d.ts +3 -0
- package/dist/engine/footprints/screw.js +51 -0
- package/dist/engine/footprints/screw.js.map +1 -0
- package/dist/engine/footprints/smallsot.d.ts +8 -0
- package/dist/engine/footprints/smallsot.js +143 -0
- package/dist/engine/footprints/smallsot.js.map +1 -0
- package/dist/engine/footprints/smdbox.d.ts +33 -0
- package/dist/engine/footprints/smdbox.js +76 -0
- package/dist/engine/footprints/smdbox.js.map +1 -0
- package/dist/engine/footprints/smdcan.d.ts +3 -0
- package/dist/engine/footprints/smdcan.js +61 -0
- package/dist/engine/footprints/smdcan.js.map +1 -0
- package/dist/engine/footprints/smdip.d.ts +4 -0
- package/dist/engine/footprints/smdip.js +58 -0
- package/dist/engine/footprints/smdip.js.map +1 -0
- package/dist/engine/footprints/socket.d.ts +8 -0
- package/dist/engine/footprints/socket.js +21 -0
- package/dist/engine/footprints/socket.js.map +1 -0
- package/dist/engine/footprints/sod.d.ts +6 -0
- package/dist/engine/footprints/sod.js +63 -6
- package/dist/engine/footprints/sod.js.map +1 -1
- package/dist/engine/footprints/sot.d.ts +1 -1
- package/dist/engine/footprints/sot.js +17 -2
- package/dist/engine/footprints/sot.js.map +1 -1
- package/dist/engine/footprints/tact.d.ts +3 -0
- package/dist/engine/footprints/tact.js +65 -0
- package/dist/engine/footprints/tact.js.map +1 -0
- package/dist/engine/footprints/tantalum.d.ts +7 -0
- package/dist/engine/footprints/tantalum.js +91 -0
- package/dist/engine/footprints/tantalum.js.map +1 -0
- package/dist/engine/footprints/to92inline.d.ts +14 -0
- package/dist/engine/footprints/to92inline.js +21 -0
- package/dist/engine/footprints/to92inline.js.map +1 -0
- package/dist/engine/footprints/topower.d.ts +7 -0
- package/dist/engine/footprints/topower.js +119 -0
- package/dist/engine/footprints/topower.js.map +1 -0
- package/dist/engine/footprints/usb.d.ts +32 -0
- package/dist/engine/footprints/usb.js +109 -0
- package/dist/engine/footprints/usb.js.map +1 -0
- package/dist/engine/footprints/xtal.d.ts +4 -0
- package/dist/engine/footprints/xtal.js +61 -0
- package/dist/engine/footprints/xtal.js.map +1 -0
- package/dist/engine/impedance.d.ts +72 -0
- package/dist/engine/impedance.js +133 -0
- package/dist/engine/impedance.js.map +1 -0
- package/dist/engine/line-length.d.ts +15 -0
- package/dist/engine/line-length.js +116 -0
- package/dist/engine/line-length.js.map +1 -0
- package/dist/engine/model.d.ts +2 -0
- package/dist/engine/model.js.map +1 -1
- package/dist/engine/pcb-place/roles.d.ts +3 -1
- package/dist/engine/pcb-place/roles.js +5 -0
- package/dist/engine/pcb-place/roles.js.map +1 -1
- package/dist/engine/rules/impedance-widths.d.ts +20 -0
- package/dist/engine/rules/impedance-widths.js +57 -0
- package/dist/engine/rules/impedance-widths.js.map +1 -0
- package/dist/engine/rules/load.js +11 -2
- package/dist/engine/rules/load.js.map +1 -1
- package/dist/engine/rules/pairs.d.ts +27 -0
- package/dist/engine/rules/pairs.js +86 -0
- package/dist/engine/rules/pairs.js.map +1 -0
- package/dist/engine/rules/profiles.js +16 -0
- package/dist/engine/rules/profiles.js.map +1 -1
- package/dist/engine/rules/rotations.d.ts +12 -3
- package/dist/engine/rules/rotations.js +77 -2
- package/dist/engine/rules/rotations.js.map +1 -1
- package/dist/engine/rules/schema.d.ts +44 -0
- package/dist/engine/rules/schema.js +16 -1
- package/dist/engine/rules/schema.js.map +1 -1
- package/dist/engine/sim/answer.d.ts +13 -0
- package/dist/engine/sim/answer.js +101 -0
- package/dist/engine/sim/answer.js.map +1 -0
- package/dist/engine/sim/cases.d.ts +29 -0
- package/dist/engine/sim/cases.js +63 -0
- package/dist/engine/sim/cases.js.map +1 -0
- package/dist/engine/sim/devices.d.ts +109 -0
- package/dist/engine/sim/devices.js +137 -0
- package/dist/engine/sim/devices.js.map +1 -0
- package/dist/engine/sim/elements.d.ts +49 -0
- package/dist/engine/sim/elements.js +2 -0
- package/dist/engine/sim/elements.js.map +1 -0
- package/dist/engine/sim/from-circuit.d.ts +52 -0
- package/dist/engine/sim/from-circuit.js +354 -0
- package/dist/engine/sim/from-circuit.js.map +1 -0
- package/dist/engine/sim/limits.d.ts +12 -0
- package/dist/engine/sim/limits.js +79 -0
- package/dist/engine/sim/limits.js.map +1 -0
- package/dist/engine/sim/linear.d.ts +2 -0
- package/dist/engine/sim/linear.js +49 -0
- package/dist/engine/sim/linear.js.map +1 -0
- package/dist/engine/sim/model-schema.d.ts +246 -0
- package/dist/engine/sim/model-schema.js +115 -0
- package/dist/engine/sim/model-schema.js.map +1 -0
- package/dist/engine/sim/part-models.d.ts +47 -0
- package/dist/engine/sim/part-models.js +102 -0
- package/dist/engine/sim/part-models.js.map +1 -0
- package/dist/engine/sim/run.d.ts +14 -0
- package/dist/engine/sim/run.js +13 -0
- package/dist/engine/sim/run.js.map +1 -0
- package/dist/engine/sim/solve.d.ts +42 -0
- package/dist/engine/sim/solve.js +294 -0
- package/dist/engine/sim/solve.js.map +1 -0
- package/dist/engine/sim/spice.d.ts +5 -0
- package/dist/engine/sim/spice.js +66 -0
- package/dist/engine/sim/spice.js.map +1 -0
- package/dist/engine/sim/values.d.ts +4 -0
- package/dist/engine/sim/values.js +40 -0
- package/dist/engine/sim/values.js.map +1 -0
- package/dist/engine/solid/heights-smd.d.ts +3 -0
- package/dist/engine/solid/heights-smd.js +81 -0
- package/dist/engine/solid/heights-smd.js.map +1 -0
- package/dist/engine/solid/heights-through.d.ts +7 -0
- package/dist/engine/solid/heights-through.js +93 -0
- package/dist/engine/solid/heights-through.js.map +1 -0
- package/dist/engine/solid/heights-uno.d.ts +2 -0
- package/dist/engine/solid/heights-uno.js +15 -0
- package/dist/engine/solid/heights-uno.js.map +1 -0
- package/dist/engine/solid/heights.d.ts +31 -0
- package/dist/engine/solid/heights.js +112 -0
- package/dist/engine/solid/heights.js.map +1 -0
- package/dist/engine/solid/limits.d.ts +7 -0
- package/dist/engine/solid/limits.js +20 -0
- package/dist/engine/solid/limits.js.map +1 -0
- package/dist/engine/solid/model.d.ts +54 -0
- package/dist/engine/solid/model.js +147 -0
- package/dist/engine/solid/model.js.map +1 -0
- package/dist/engine/solid/step.d.ts +5 -0
- package/dist/engine/solid/step.js +164 -0
- package/dist/engine/solid/step.js.map +1 -0
- package/dist/engine/solid/thickness.d.ts +11 -0
- package/dist/engine/solid/thickness.js +10 -0
- package/dist/engine/solid/thickness.js.map +1 -0
- package/dist/library/kicad/board.d.ts +26 -0
- package/dist/library/kicad/board.js +96 -0
- package/dist/library/kicad/board.js.map +1 -0
- package/dist/library/kicad/copper.d.ts +44 -0
- package/dist/library/kicad/copper.js +106 -0
- package/dist/library/kicad/copper.js.map +1 -0
- package/dist/library/kicad/footprints.d.ts +62 -0
- package/dist/library/kicad/footprints.js +184 -0
- package/dist/library/kicad/footprints.js.map +1 -0
- package/dist/library/kicad/geometry.d.ts +36 -0
- package/dist/library/kicad/geometry.js +84 -0
- package/dist/library/kicad/geometry.js.map +1 -0
- package/dist/library/kicad/import.d.ts +58 -0
- package/dist/library/kicad/import.js +240 -0
- package/dist/library/kicad/import.js.map +1 -0
- package/dist/library/kicad/plan.d.ts +40 -0
- package/dist/library/kicad/plan.js +139 -0
- package/dist/library/kicad/plan.js.map +1 -0
- package/dist/library/kicad/read.d.ts +30 -0
- package/dist/library/kicad/read.js +105 -0
- package/dist/library/kicad/read.js.map +1 -0
- package/dist/library/kicad/sexpr.d.ts +36 -0
- package/dist/library/kicad/sexpr.js +153 -0
- package/dist/library/kicad/sexpr.js.map +1 -0
- package/dist/library/kicad/tally.d.ts +32 -0
- package/dist/library/kicad/tally.js +55 -0
- package/dist/library/kicad/tally.js.map +1 -0
- package/dist/library/kicad/write.d.ts +37 -0
- package/dist/library/kicad/write.js +146 -0
- package/dist/library/kicad/write.js.map +1 -0
- package/dist/library/new-part.d.ts +2 -0
- package/dist/library/new-part.js +1 -0
- package/dist/library/new-part.js.map +1 -1
- package/dist/mcp/board-import-tool.d.ts +1 -1
- package/dist/mcp/board-import-tool.js +14 -4
- package/dist/mcp/board-import-tool.js.map +1 -1
- package/dist/mcp/copper-summary.d.ts +2 -0
- package/dist/mcp/copper-summary.js +4 -2
- package/dist/mcp/copper-summary.js.map +1 -1
- package/dist/mcp/create-part.d.ts +23 -0
- package/dist/mcp/create-part.js +1 -0
- package/dist/mcp/create-part.js.map +1 -1
- package/dist/mcp/fast-summary.d.ts +3 -0
- package/dist/mcp/fast-summary.js +46 -0
- package/dist/mcp/fast-summary.js.map +1 -0
- package/dist/mcp/guide.d.ts +3 -1
- package/dist/mcp/guide.js +15 -4
- package/dist/mcp/guide.js.map +1 -1
- package/dist/mcp/model-tool.d.ts +31 -0
- package/dist/mcp/model-tool.js +27 -0
- package/dist/mcp/model-tool.js.map +1 -0
- package/dist/mcp/render-tool.d.ts +33 -2
- package/dist/mcp/render-tool.js +21 -5
- package/dist/mcp/render-tool.js.map +1 -1
- package/dist/mcp/server.js +20 -8
- package/dist/mcp/server.js.map +1 -1
- package/dist/mcp/sheet-card-tools.d.ts +3 -1
- package/dist/mcp/sheet-card-tools.js +3 -1
- package/dist/mcp/sheet-card-tools.js.map +1 -1
- package/dist/mcp/simulate-tool.d.ts +10 -0
- package/dist/mcp/simulate-tool.js +12 -0
- package/dist/mcp/simulate-tool.js.map +1 -0
- package/dist/render/render.js +11327 -1645
- package/dist/studio/change-route.d.ts +18 -0
- package/dist/studio/change-route.js +24 -0
- package/dist/studio/change-route.js.map +1 -0
- package/dist/studio/http-error.d.ts +5 -0
- package/dist/studio/http-error.js +9 -0
- package/dist/studio/http-error.js.map +1 -0
- package/dist/studio/live.d.ts +2 -0
- package/dist/studio/live.js.map +1 -1
- package/dist/studio/server.js +43 -15
- package/dist/studio/server.js.map +1 -1
- package/dist/studio/verify-routes.d.ts +42 -0
- package/dist/studio/verify-routes.js +110 -0
- package/dist/studio/verify-routes.js.map +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/library/modules/CanNode/CanNode.sheet.tsx +1 -1
- package/library/modules/CanNode/parts/MCP2515-I-SO/MCP2515_I_SO.tsx +1 -0
- package/library/modules/CanNode/parts/MCP2515-I-SO/part.yaml +2 -0
- package/library/modules/CanNode/parts/MCP2515-I-SO/verification.md +2 -1
- package/library/modules/CanNode/parts/TJA1051T-3/TJA1051T_3.tsx +1 -0
- package/library/modules/CanNode/parts/TJA1051T-3/part.yaml +2 -0
- package/library/modules/CanNode/parts/TJA1051T-3/verification.md +2 -1
- package/library/modules/DigitalInput24V/DigitalInput24V.sheet.tsx +7 -7
- package/library/modules/RelayDriver/RelayDriver.sheet.tsx +3 -3
- package/library/modules/RelayDriver/parts/AO3400A/part.yaml +34 -0
- package/library/modules/RelayDriver/parts/AO3400A/verification.md +11 -1
- package/library/modules/RelayDriver/parts/SRD-12VDC-SL-C/SRD_12VDC_SL_C.tsx +1 -0
- package/library/modules/RelayDriver/parts/SRD-12VDC-SL-C/part.yaml +14 -0
- package/library/modules/RelayDriver/parts/SRD-12VDC-SL-C/verification.md +4 -1
- package/package.json +2 -1
- package/skills/copperflow/references/copper.md +8 -0
- package/skills/copperflow/references/design-rules.md +57 -6
- package/skills/copperflow/references/editable-subset.md +18 -8
- package/skills/copperflow/references/modules.md +26 -0
- package/skills/copperflow/references/parts-library.md +2 -1
- package/skills/copperflow/references/writing-circuits.md +9 -0
- package/dist/app/assets/NewPartDialog-C4sKWnGI.js +0 -160
- package/dist/app/assets/index-BgzJedaB.css +0 -1
- package/dist/app/assets/index-C_U9me2P.js +0 -19
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { fabricationErrors } from "../engine/fab/export.js";
|
|
2
|
+
import { naturalCompare } from "../engine/order.js";
|
|
3
|
+
import { checkDesign } from "./check.js";
|
|
4
|
+
/** The most lines the report takes; the lines without a supplier part number are cut to fit, with a count. */
|
|
5
|
+
export const ORDER_REPORT_MAX_LINES = 40;
|
|
6
|
+
const PLACEHOLDER_CODE = "footprint-placeholder";
|
|
7
|
+
const counted = (n, word, plural = `${word}s`) => `${n} ${n === 1 ? word : plural}`;
|
|
8
|
+
const BUILT_IN_HOW = 'Add a number to a built-in part: set_props { part, props: { supplierPartNumbers: "jlcpcb:<number>" } } in the file that writes it (a sheet\'s part by its name in the .sheet.tsx).';
|
|
9
|
+
const LIBRARY_HOW = 'Add a number to a library part: suppliers: { jlcpcb: "<number>" } in parts/<id>/part.yaml, then copperflow parts build (or create_part again with replace); a person then verifies it again.';
|
|
10
|
+
const NO_PRICE = "No price or stock is checked: copperflow stores neither.";
|
|
11
|
+
const HONEST = '"Ready" covers only the lines above: it does not say the board works or that a maker will accept it.';
|
|
12
|
+
const round = (mm) => String(Math.round(mm * 10) / 10);
|
|
13
|
+
function boardLine(design) {
|
|
14
|
+
const board = design.circuit.board;
|
|
15
|
+
const outline = board?.outline ?? [];
|
|
16
|
+
const layers = `${board?.layers ?? 2} layers`;
|
|
17
|
+
const check = checkDesign(design);
|
|
18
|
+
const errors = check.errors.reduce((sum, group) => sum + group.count, 0);
|
|
19
|
+
const warnings = check.warnings.length === 0 ? "no warnings" : `warnings: ${check.warnings.map((group) => `${group.type} ${group.count}`).join(", ")}`;
|
|
20
|
+
const checks = `Checks: ${counted(errors, "error")}, ${counted(design.pcb.ratsnest.length, "unrouted connection")}, ${warnings}.`;
|
|
21
|
+
if (outline.length < 3)
|
|
22
|
+
return `Board: no outline, ${layers}. ${checks}`;
|
|
23
|
+
const xs = outline.map((p) => p.x);
|
|
24
|
+
const ys = outline.map((p) => p.y);
|
|
25
|
+
return `Board: ${round(Math.max(...xs) - Math.min(...xs))} x ${round(Math.max(...ys) - Math.min(...ys))} mm, ${layers}. ${checks}`;
|
|
26
|
+
}
|
|
27
|
+
/** What makes the fabrication export refuse the design or the bare board wrong; empty when there is nothing. */
|
|
28
|
+
function bareBoardReasons(design) {
|
|
29
|
+
const errors = fabricationErrors(design).length;
|
|
30
|
+
const placeholders = design.diagnostics.filter((d) => d.code === PLACEHOLDER_CODE).flatMap((d) => d.items);
|
|
31
|
+
const unrouted = design.pcb.ratsnest.length;
|
|
32
|
+
return [
|
|
33
|
+
...(errors > 0 ? [counted(errors, "error")] : []),
|
|
34
|
+
...(unrouted > 0 ? [counted(unrouted, "unrouted connection")] : []),
|
|
35
|
+
...(placeholders.length > 0 ? [`a placeholder footprint (${[...placeholders].sort(naturalCompare).join(", ")})`] : []),
|
|
36
|
+
...((design.circuit.board?.outline.length ?? 0) < 3 ? ["no board outline"] : []),
|
|
37
|
+
];
|
|
38
|
+
}
|
|
39
|
+
const verdict = (what, reasons) => `Ready for ${what}: ${reasons.length === 0 ? "yes" : `no: ${reasons.join("; ")}`}`;
|
|
40
|
+
/** "R101: resistor 10k 0603"; a line without a value names its MPN. */
|
|
41
|
+
const describeLine = (line) => ` ${line.designators.join(", ")}: ${[line.kind, line.value || line.mpn, line.footprint].filter((s) => s !== "").join(" ")}`;
|
|
42
|
+
function unverifiedParts(bom) {
|
|
43
|
+
const parts = new Map();
|
|
44
|
+
for (const line of bom.filter((l) => l.libraryPart !== undefined && l.verified !== true)) {
|
|
45
|
+
const id = line.libraryPart;
|
|
46
|
+
parts.set(id, [...(parts.get(id) ?? []), ...line.designators]);
|
|
47
|
+
}
|
|
48
|
+
return [...parts.entries()].sort(([a], [b]) => naturalCompare(a, b)).map(([id, designators]) => `${id} (${designators.sort(naturalCompare).join(", ")})`);
|
|
49
|
+
}
|
|
50
|
+
function throughHoleParts(design) {
|
|
51
|
+
return design.pcb.parts
|
|
52
|
+
.filter((part) => part.footprint?.pads.some((pad) => pad.layers === "through"))
|
|
53
|
+
.map((part) => part.component)
|
|
54
|
+
.sort(naturalCompare);
|
|
55
|
+
}
|
|
56
|
+
function assemblyReasons(bom, missing, unverified) {
|
|
57
|
+
return [
|
|
58
|
+
...(missing > 0 ? [`${missing} of ${bom.length} ${bom.length === 1 ? "line has" : "lines have"} no supplier part number`] : []),
|
|
59
|
+
...(unverified > 0 ? [`${counted(unverified, "library part is", "library parts are")} not verified`] : []),
|
|
60
|
+
];
|
|
61
|
+
}
|
|
62
|
+
/** The report's lines, at most ORDER_REPORT_MAX_LINES. */
|
|
63
|
+
export function orderReportLines(design, bom) {
|
|
64
|
+
const missing = bom.filter((line) => line.supplier === "");
|
|
65
|
+
const unverified = unverifiedParts(bom);
|
|
66
|
+
const through = throughHoleParts(design);
|
|
67
|
+
const head = [
|
|
68
|
+
`Order report for ${design.file}`,
|
|
69
|
+
boardLine(design),
|
|
70
|
+
verdict("bare boards", bareBoardReasons(design)),
|
|
71
|
+
`BOM: ${counted(bom.length, "line")}, ${bom.length - missing.length} with a supplier part number.${missing.length > 0 ? " Without one:" : ""}`,
|
|
72
|
+
];
|
|
73
|
+
const tail = [
|
|
74
|
+
...(unverified.length > 0 ? [`Not verified: ${unverified.join(", ")}. A person should check them against their datasheets before ordering.`] : []),
|
|
75
|
+
`Through-hole: ${through.length > 0 ? through.join(", ") : "none"}`,
|
|
76
|
+
verdict("assembly", assemblyReasons(bom, missing.length, unverified.length)),
|
|
77
|
+
...(missing.some((line) => line.libraryPart === undefined) ? [BUILT_IN_HOW] : []),
|
|
78
|
+
...(missing.some((line) => line.libraryPart !== undefined) ? [LIBRARY_HOW] : []),
|
|
79
|
+
NO_PRICE,
|
|
80
|
+
HONEST,
|
|
81
|
+
];
|
|
82
|
+
const room = ORDER_REPORT_MAX_LINES - head.length - tail.length;
|
|
83
|
+
const listed = missing.length <= room ? missing.map(describeLine) : [...missing.slice(0, room - 1).map(describeLine), ` … and ${missing.length - (room - 1)} more`];
|
|
84
|
+
return [...head, ...listed, ...tail];
|
|
85
|
+
}
|
|
86
|
+
/** The report as text; `short` keeps the two verdicts and says where the whole report is. */
|
|
87
|
+
export function formatOrderReport(design, bom, options = {}) {
|
|
88
|
+
const lines = orderReportLines(design, bom);
|
|
89
|
+
if (!options.short)
|
|
90
|
+
return lines.join("\n");
|
|
91
|
+
return [...lines.filter((line) => line.startsWith("Ready for ")), `The whole order report: the bom tool, or copperflow bom ${design.file}.`].join("\n");
|
|
92
|
+
}
|
|
93
|
+
//# sourceMappingURL=order-report.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"order-report.js","sourceRoot":"","sources":["../../src/core/order-report.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAEnD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC,8GAA8G;AAC9G,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAA;AAExC,MAAM,gBAAgB,GAAG,uBAAuB,CAAA;AAChD,MAAM,OAAO,GAAG,CAAC,CAAS,EAAE,IAAY,EAAE,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAA;AACnG,MAAM,YAAY,GAChB,oLAAoL,CAAA;AACtL,MAAM,WAAW,GACf,8LAA8L,CAAA;AAChM,MAAM,QAAQ,GAAG,0DAA0D,CAAA;AAC3E,MAAM,MAAM,GAAG,sGAAsG,CAAA;AAErH,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;AAE9D,SAAS,SAAS,CAAC,MAAc;IAC/B,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAA;IAClC,MAAM,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,EAAE,CAAA;IACpC,MAAM,MAAM,GAAG,GAAG,KAAK,EAAE,MAAM,IAAI,CAAC,SAAS,CAAA;IAC7C,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACjC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IACxE,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;IACtJ,MAAM,MAAM,GAAG,WAAW,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,KAAK,QAAQ,GAAG,CAAA;IACjI,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,sBAAsB,MAAM,KAAK,MAAM,EAAE,CAAA;IACxE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAClC,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAClC,OAAO,UAAU,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,MAAM,KAAK,MAAM,EAAE,CAAA;AACpI,CAAC;AAED,gHAAgH;AAChH,SAAS,gBAAgB,CAAC,MAAc;IACtC,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,MAAM,CAAA;IAC/C,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAC1G,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAA;IAC3C,OAAO;QACL,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjD,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtH,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACjF,CAAA;AACH,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,OAA0B,EAAE,EAAE,CAAC,aAAa,IAAI,KAAK,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAA;AAEhJ,uEAAuE;AACvE,MAAM,YAAY,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;AAEpK,SAAS,eAAe,CAAC,GAAuB;IAC9C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAoB,CAAA;IACzC,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,EAAE,CAAC;QACzF,MAAM,EAAE,GAAG,IAAI,CAAC,WAAqB,CAAA;QACrC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAA;IAChE,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC3J,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAc;IACtC,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK;SACpB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;SAC9E,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC;SAC7B,IAAI,CAAC,cAAc,CAAC,CAAA;AACzB,CAAC;AAED,SAAS,eAAe,CAAC,GAAuB,EAAE,OAAe,EAAE,UAAkB;IACnF,OAAO;QACL,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,OAAO,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,0BAA0B,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/H,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3G,CAAA;AACH,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,gBAAgB,CAAC,MAAc,EAAE,GAAuB;IACtE,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAA;IAC1D,MAAM,UAAU,GAAG,eAAe,CAAC,GAAG,CAAC,CAAA;IACvC,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACxC,MAAM,IAAI,GAAG;QACX,oBAAoB,MAAM,CAAC,IAAI,EAAE;QACjC,SAAS,CAAC,MAAM,CAAC;QACjB,OAAO,CAAC,aAAa,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAChD,QAAQ,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,gCAAgC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,EAAE;KAC/I,CAAA;IACD,MAAM,IAAI,GAAG;QACX,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,wEAAwE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAClJ,iBAAiB,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;QACnE,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QAC5E,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjF,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChF,QAAQ;QACR,MAAM;KACP,CAAA;IACD,MAAM,IAAI,GAAG,sBAAsB,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;IAC/D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,WAAW,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,CAAA;IACpK,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,CAAA;AACtC,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,iBAAiB,CAAC,MAAc,EAAE,GAAuB,EAAE,OAAO,GAAwB,EAAE;IAC1G,MAAM,KAAK,GAAG,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC3C,IAAI,CAAC,OAAO,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC3C,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,EAAE,2DAA2D,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzJ,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { type PackageEntry } from "../engine/footprints/catalogue.js";
|
|
2
|
+
export interface FormatOptions {
|
|
3
|
+
/** Show each package's other strings after its name (useful when a search was made). */
|
|
4
|
+
readonly also?: boolean;
|
|
5
|
+
/** Leave the less common sizes out, and end with a line saying how many were left out. */
|
|
6
|
+
readonly hideExtras?: boolean;
|
|
7
|
+
/** End with the general forms of the families that take numbers. */
|
|
8
|
+
readonly forms?: boolean;
|
|
9
|
+
}
|
|
10
|
+
/** The packages as text: a heading per group (in catalogue order) over one line per package. */
|
|
11
|
+
export declare function formatPackages(entries: readonly PackageEntry[], options?: FormatOptions): string;
|
|
12
|
+
/** The line for a search that found nothing, with the nearest valid strings when the first word looks like one. */
|
|
13
|
+
export declare function noPackageText(words: readonly string[]): string;
|
|
14
|
+
/** The answer to a search: the whole catalogue for no words, the matching packages otherwise, or the no-match line. */
|
|
15
|
+
export declare function packagesText(words: readonly string[]): {
|
|
16
|
+
text: string;
|
|
17
|
+
found: boolean;
|
|
18
|
+
};
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
// The catalogue of standard packages as text, for the command line and for agents: search and compact listing. Pure.
|
|
2
|
+
import { findPackages, PACKAGE_FORMS, PACKAGE_GROUPS, packageFacts } from "../engine/footprints/catalogue.js";
|
|
3
|
+
import { nearestFootprints } from "../engine/footprints/known.js";
|
|
4
|
+
const HEADER = "Packages: string to type as the footprint, name, pads, courtyard mm, mount (smd or th)";
|
|
5
|
+
const FORMS_HEADING = "General forms (any size works; the above are examples):";
|
|
6
|
+
const GAP = " ";
|
|
7
|
+
const mountText = (mount) => (mount === "through-hole" ? "th" : "smd");
|
|
8
|
+
function cells(entry, options) {
|
|
9
|
+
const facts = packageFacts(entry);
|
|
10
|
+
const also = options.also && entry.also !== undefined ? ` (also ${entry.also.join(", ")})` : "";
|
|
11
|
+
return { footprint: entry.footprint, name: `${entry.name}${also}`, rest: `${facts.pads} ${facts.width}x${facts.height} ${mountText(facts.mount)}` };
|
|
12
|
+
}
|
|
13
|
+
/** The lines of one group, columns aligned within the group. */
|
|
14
|
+
function groupLines(entries, options) {
|
|
15
|
+
const all = entries.map((entry) => cells(entry, options));
|
|
16
|
+
const footprintWidth = Math.max(...all.map((cell) => cell.footprint.length));
|
|
17
|
+
const nameWidth = Math.max(...all.map((cell) => cell.name.length));
|
|
18
|
+
return all.map((cell) => ` ${cell.footprint.padEnd(footprintWidth)}${GAP}${cell.name.padEnd(nameWidth)}${GAP}${cell.rest}`);
|
|
19
|
+
}
|
|
20
|
+
function formLines() {
|
|
21
|
+
const width = Math.max(...PACKAGE_FORMS.map((one) => one.form.length));
|
|
22
|
+
return [FORMS_HEADING, ...PACKAGE_FORMS.map((one) => ` ${one.form.padEnd(width)}${GAP}${one.says}`)];
|
|
23
|
+
}
|
|
24
|
+
/** The packages as text: a heading per group (in catalogue order) over one line per package. */
|
|
25
|
+
export function formatPackages(entries, options = {}) {
|
|
26
|
+
const shown = options.hideExtras ? entries.filter((entry) => entry.extra !== true) : entries;
|
|
27
|
+
const hidden = entries.length - shown.length;
|
|
28
|
+
const sections = PACKAGE_GROUPS.flatMap((group) => {
|
|
29
|
+
const inGroup = shown.filter((entry) => entry.group === group);
|
|
30
|
+
return inGroup.length === 0 ? [] : [[group, ...groupLines(inGroup, options)].join("\n")];
|
|
31
|
+
});
|
|
32
|
+
const more = hidden > 0 ? [`${hidden} more sizes are left out here; a search lists them (packages dip, packages qfn).`] : [];
|
|
33
|
+
return [HEADER, ...sections, ...(options.forms ? [formLines().join("\n")] : []), ...more].join("\n");
|
|
34
|
+
}
|
|
35
|
+
/** The line for a search that found nothing, with the nearest valid strings when the first word looks like one. */
|
|
36
|
+
export function noPackageText(words) {
|
|
37
|
+
const nearest = words.length === 1 ? nearestFootprints(words[0]) : [];
|
|
38
|
+
const near = nearest.length > 0 ? ` Nearest strings: ${nearest.join(", ")}.` : "";
|
|
39
|
+
return `No package matches "${words.join(" ")}".${near} Search with no words lists them all.`;
|
|
40
|
+
}
|
|
41
|
+
/** The answer to a search: the whole catalogue for no words, the matching packages otherwise, or the no-match line. */
|
|
42
|
+
export function packagesText(words) {
|
|
43
|
+
const entries = findPackages(words);
|
|
44
|
+
if (entries.length === 0)
|
|
45
|
+
return { text: noPackageText(words), found: false };
|
|
46
|
+
const whole = words.length === 0;
|
|
47
|
+
return { text: formatPackages(entries, { also: !whole, forms: whole, hideExtras: whole }), found: true };
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=packages.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"packages.js","sourceRoot":"","sources":["../../src/core/packages.ts"],"names":[],"mappings":"AAAA,qHAAqH;AACrH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,YAAY,EAAqB,MAAM,mCAAmC,CAAA;AAChI,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AAWjE,MAAM,MAAM,GAAG,wFAAwF,CAAA;AACvG,MAAM,aAAa,GAAG,yDAAyD,CAAA;AAC/E,MAAM,GAAG,GAAG,IAAI,CAAA;AAEhB,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AAQ9E,SAAS,KAAK,CAAC,KAAmB,EAAE,OAAsB;IACxD,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;IACjC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IAC/F,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,GAAG,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAA;AACvJ,CAAC;AAED,gEAAgE;AAChE,SAAS,UAAU,CAAC,OAAgC,EAAE,OAAsB;IAC1E,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;IACzD,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;IAC5E,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IAClE,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;AAC9H,CAAC;AAED,SAAS,SAAS;IAChB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IACtE,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;AACvG,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,cAAc,CAAC,OAAgC,EAAE,OAAO,GAAkB,EAAE;IAC1F,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;IAC5F,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;IAC5C,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAChD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,CAAA;QAC9D,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAC1F,CAAC,CAAC,CAAA;IACF,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,kFAAkF,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC5H,OAAO,CAAC,MAAM,EAAE,GAAG,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACtG,CAAC;AAED,mHAAmH;AACnH,MAAM,UAAU,aAAa,CAAC,KAAwB;IACpD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC/E,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,qBAAqB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IACjF,OAAO,uBAAuB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,uCAAuC,CAAA;AAC/F,CAAC;AAED,uHAAuH;AACvH,MAAM,UAAU,YAAY,CAAC,KAAwB;IACnD,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;IACnC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAA;IAC7E,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAA;IAChC,OAAO,EAAE,IAAI,EAAE,cAAc,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;AAC1G,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { MappedPart } from "./pin-map.js";
|
|
2
|
+
/** Upper case, every other character to "_", and "N" before a leading digit: "can1/txcan" is CAN1_TXCAN, "5V" N5V. */
|
|
3
|
+
export declare function cIdentifier(text: string): string;
|
|
4
|
+
/** The header of the parts, wired as in `file`; `guard` names it (U101 gives U101_PINS_H). */
|
|
5
|
+
export declare function formatPinHeader(file: string, parts: readonly MappedPart[], guard: string): string;
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
const IDENTIFIER = /^[A-Za-z_][A-Za-z0-9_]*$/;
|
|
2
|
+
/** Upper case, every other character to "_", and "N" before a leading digit: "can1/txcan" is CAN1_TXCAN, "5V" N5V. */
|
|
3
|
+
export function cIdentifier(text) {
|
|
4
|
+
const upper = text.toUpperCase().replace(/[^A-Z0-9_]/g, "_");
|
|
5
|
+
return /^[0-9]/.test(upper) ? `N${upper}` : upper;
|
|
6
|
+
}
|
|
7
|
+
const cString = (text) => `"${text.replace(/\\/g, "\\\\").replace(/"/g, '\\"')}"`;
|
|
8
|
+
const comment = (text) => `/* ${text.replace(/\*\//g, "* /")} */`;
|
|
9
|
+
/** Gives every define a unique name: a repeated name gets "_<pad>", and one still repeated "_<part>_<pad>". */
|
|
10
|
+
function nameDefines(defines) {
|
|
11
|
+
const count = (names) => names.reduce((map, name) => map.set(name, (map.get(name) ?? 0) + 1), new Map());
|
|
12
|
+
const bases = count(defines.map((d) => d.base));
|
|
13
|
+
const withPad = defines.map((d) => (bases.get(d.base) === 1 ? d.base : `${d.base}_${d.pad}`));
|
|
14
|
+
const padded = count(withPad);
|
|
15
|
+
const named = defines.map((d, i) => {
|
|
16
|
+
const name = withPad[i];
|
|
17
|
+
return { ...d, name: padded.get(name) === 1 ? name : `${d.base}_${cIdentifier(d.part)}_${d.pad}` };
|
|
18
|
+
});
|
|
19
|
+
const collided = named.filter((d) => d.name !== d.base).map((d) => d.name);
|
|
20
|
+
return { named, collided };
|
|
21
|
+
}
|
|
22
|
+
const forwardDefine = (part, row) => {
|
|
23
|
+
if (row.origin === undefined)
|
|
24
|
+
return comment(`${part} ${row.pin}: pad ${row.pad}, ${row.type}, not connected`);
|
|
25
|
+
if (row.origin === "made up")
|
|
26
|
+
return comment(`${part} ${row.pin}: pad ${row.pad}, ${row.type}, on a net with no name`);
|
|
27
|
+
return { part, pad: row.pad, base: `${cIdentifier(part)}_${cIdentifier(row.pin)}_NET`, value: cString(row.net), note: `pad ${row.pad}, ${row.type}` };
|
|
28
|
+
};
|
|
29
|
+
const reverseDefine = (part, row) => ({
|
|
30
|
+
part,
|
|
31
|
+
pad: row.pad,
|
|
32
|
+
base: `${cIdentifier(part)}_${cIdentifier(row.net)}_PIN`,
|
|
33
|
+
value: cString(row.pin),
|
|
34
|
+
note: `${part} pad ${row.pad}`,
|
|
35
|
+
...(IDENTIFIER.test(row.pin) ? { id: row.pin } : {}),
|
|
36
|
+
});
|
|
37
|
+
/** A block of defines and comment lines, the names and values in columns. */
|
|
38
|
+
function block(lines) {
|
|
39
|
+
const defines = lines.filter((line) => typeof line !== "string");
|
|
40
|
+
const nameWidth = Math.max(0, ...defines.flatMap((d) => [d.name?.length ?? 0, d.id ? (d.name?.length ?? 0) + 3 : 0]));
|
|
41
|
+
const valueWidth = Math.max(0, ...defines.map((d) => d.value.length));
|
|
42
|
+
return lines.flatMap((line) => {
|
|
43
|
+
if (typeof line === "string")
|
|
44
|
+
return [line];
|
|
45
|
+
const name = line.name;
|
|
46
|
+
const main = `#define ${name.padEnd(nameWidth)} ${line.note ? `${line.value.padEnd(valueWidth)} ${comment(line.note)}` : line.value}`;
|
|
47
|
+
return line.id ? [main, `#define ${`${name}_ID`.padEnd(nameWidth)} ${line.id}`] : [main];
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
/** The header of the parts, wired as in `file`; `guard` names it (U101 gives U101_PINS_H). */
|
|
51
|
+
export function formatPinHeader(file, parts, guard) {
|
|
52
|
+
const sections = parts.map((part) => ({
|
|
53
|
+
part,
|
|
54
|
+
forward: part.rows.map((row) => forwardDefine(part.id, row)),
|
|
55
|
+
reverse: part.rows.filter((row) => row.signal === true).map((row) => reverseDefine(part.id, row)),
|
|
56
|
+
}));
|
|
57
|
+
const all = sections.flatMap((s) => [...s.forward, ...s.reverse].filter((line) => typeof line !== "string"));
|
|
58
|
+
const { named, collided } = nameDefines(all);
|
|
59
|
+
const nameOf = new Map(all.map((define, i) => [define, named[i]]));
|
|
60
|
+
const resolve = (lines) => lines.map((line) => (typeof line === "string" ? line : nameOf.get(line)));
|
|
61
|
+
const guardName = `${cIdentifier(guard)}_PINS_H`;
|
|
62
|
+
return [
|
|
63
|
+
comment(`Pins as wired in ${file}, written by copperflow pins. Net and pin names are strings.`),
|
|
64
|
+
`#ifndef ${guardName}`,
|
|
65
|
+
`#define ${guardName}`,
|
|
66
|
+
...(collided.length > 0 ? [comment(`Names that collided have the pad number added: ${collided.join(", ")}`)] : []),
|
|
67
|
+
...sections.flatMap(({ part, forward, reverse }) => [
|
|
68
|
+
"",
|
|
69
|
+
comment(`${part.id}: ${part.title}, pins as wired in ${file}`),
|
|
70
|
+
...block(resolve(forward)),
|
|
71
|
+
...(reverse.length > 0 ? ["", comment(`Signal nets on ${part.id}'s pins`), ...block(resolve(reverse))] : []),
|
|
72
|
+
]),
|
|
73
|
+
"",
|
|
74
|
+
"#endif",
|
|
75
|
+
].join("\n");
|
|
76
|
+
}
|
|
77
|
+
//# sourceMappingURL=pin-header.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pin-header.js","sourceRoot":"","sources":["../../src/core/pin-header.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,GAAG,0BAA0B,CAAA;AAE7C,sHAAsH;AACtH,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;IAC5D,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;AACnD,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAA;AACzF,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAA;AAazE,+GAA+G;AAC/G,SAAS,WAAW,CAAC,OAA0B;IAC7C,MAAM,KAAK,GAAG,CAAC,KAAwB,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,GAAG,EAAkB,CAAC,CAAA;IAC3I,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;IAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;IAC7F,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACjC,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAW,CAAA;QACjC,OAAO,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAA;IACpG,CAAC,CAAC,CAAA;IACF,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAc,CAAC,CAAA;IACpF,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAA;AAC5B,CAAC;AAED,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,GAAW,EAAmB,EAAE;IACnE,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC,GAAG,IAAI,IAAI,GAAG,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,iBAAiB,CAAC,CAAA;IAC9G,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC,GAAG,IAAI,IAAI,GAAG,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,yBAAyB,CAAC,CAAA;IACtH,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,EAAE,EAAE,CAAA;AACvJ,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,GAAW,EAAU,EAAE,CAAC,CAAC;IAC5D,IAAI;IACJ,GAAG,EAAE,GAAG,CAAC,GAAG;IACZ,IAAI,EAAE,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM;IACxD,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IACvB,IAAI,EAAE,GAAG,IAAI,QAAQ,GAAG,CAAC,GAAG,EAAE;IAC9B,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;CACrD,CAAC,CAAA;AAEF,6EAA6E;AAC7E,SAAS,KAAK,CAAC,KAAqC;IAClD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAA;IAChF,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACrH,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IACrE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,CAAC,IAAI,CAAC,CAAA;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAc,CAAA;QAChC,MAAM,IAAI,GAAG,WAAW,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;QACvI,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAC3F,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,8FAA8F;AAC9F,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,KAA4B,EAAE,KAAa;IACvF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpC,IAAI;QACJ,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5D,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;KAClG,CAAC,CAAC,CAAA;IACH,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAA;IAC5H,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IAC5C,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAW,CAAC,CAAC,CAAC,CAAA;IAC5E,MAAM,OAAO,GAAG,CAAC,KAAqC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAY,CAAC,CAAC,CAAA;IAChJ,MAAM,SAAS,GAAG,GAAG,WAAW,CAAC,KAAK,CAAC,SAAS,CAAA;IAChD,OAAO;QACL,OAAO,CAAC,oBAAoB,IAAI,8DAA8D,CAAC;QAC/F,WAAW,SAAS,EAAE;QACtB,WAAW,SAAS,EAAE;QACtB,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,kDAAkD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAClH,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;YAClD,EAAE;YACF,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,KAAK,sBAAsB,IAAI,EAAE,CAAC;YAC9D,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC1B,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,kBAAkB,IAAI,CAAC,EAAE,SAAS,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC7G,CAAC;QACF,EAAE;QACF,QAAQ;KACT,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACd,CAAC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { Design } from "../engine/design.js";
|
|
2
|
+
import type { PinType } from "../engine/model.js";
|
|
3
|
+
import { type DesignSource } from "./design-source.js";
|
|
4
|
+
export declare const NOT_CONNECTED = "not connected";
|
|
5
|
+
/**
|
|
6
|
+
* One pad of a part. `net` is the net's name, or "not connected"; `origin` says whether a person gave the name
|
|
7
|
+
* (a `net.X` in a trace, or a port's net) or the build made it up from a pin (a net written only as pin to pin).
|
|
8
|
+
*/
|
|
9
|
+
export interface PinRow {
|
|
10
|
+
pad: string;
|
|
11
|
+
pin: string;
|
|
12
|
+
type: PinType;
|
|
13
|
+
net: string;
|
|
14
|
+
origin?: "given" | "made up";
|
|
15
|
+
/** True for a named signal net: not power, not ground, not made up. */
|
|
16
|
+
signal?: boolean;
|
|
17
|
+
}
|
|
18
|
+
/** What the map is drawn for: the part's id and a title, e.g. a library part's title or the part's kind. */
|
|
19
|
+
export interface MappedPart {
|
|
20
|
+
id: string;
|
|
21
|
+
title: string;
|
|
22
|
+
rows: PinRow[];
|
|
23
|
+
}
|
|
24
|
+
/** The parts the map shows when none is named: every library chip and every connector, in name order. */
|
|
25
|
+
export declare function pinMapParts(design: Design): string[];
|
|
26
|
+
/** The library chips among the parts: the package writes a C header for each. */
|
|
27
|
+
export declare function isLibraryChip(design: Design, part: string): boolean;
|
|
28
|
+
/** A row per pad of the part, by pad number; throws, listing the parts there are, when there is no such part. */
|
|
29
|
+
export declare function pinRows(design: Design, part: string): PinRow[];
|
|
30
|
+
/** The rows of the parts, each with its title: the library part's title, else the part's kind. */
|
|
31
|
+
export declare function mappedParts(design: Design, parts: readonly string[], titles: ReadonlyMap<string, string>): MappedPart[];
|
|
32
|
+
export declare function formatPinsMarkdown(parts: readonly MappedPart[]): string;
|
|
33
|
+
export declare function formatPinsCsv(parts: readonly MappedPart[]): string;
|
|
34
|
+
export type PinFormat = "md" | "csv" | "c";
|
|
35
|
+
export declare const PIN_FORMATS: readonly PinFormat[];
|
|
36
|
+
/** The titles of the library parts among `parts`, read from the library. */
|
|
37
|
+
export declare function libraryTitles(root: string, design: Design, parts: readonly string[]): Promise<Map<string, string>>;
|
|
38
|
+
/** The map of a design's parts in a format; `guard` names the C header (its file name without .h). */
|
|
39
|
+
export declare function formatPins(design: Design, parts: readonly MappedPart[], format: PinFormat, guard: string): string;
|
|
40
|
+
/** `copperflow pins`: one part, or every library chip and connector, in a format. */
|
|
41
|
+
export declare function pinMapText(root: string, file: string, options?: {
|
|
42
|
+
part?: string;
|
|
43
|
+
format?: PinFormat;
|
|
44
|
+
design?: Design;
|
|
45
|
+
engine?: DesignSource;
|
|
46
|
+
}): Promise<string>;
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { csvCell } from "../engine/fab/csv.js";
|
|
2
|
+
import { naturalCompare } from "../engine/order.js";
|
|
3
|
+
import { isConnector, isPowerNet } from "../engine/pcb-place/roles.js";
|
|
4
|
+
import { buildWith } from "./design-source.js";
|
|
5
|
+
import { readPart } from "./library.js";
|
|
6
|
+
import { formatPinHeader } from "./pin-header.js";
|
|
7
|
+
import { resolveCircuit } from "./workspace.js";
|
|
8
|
+
export const NOT_CONNECTED = "not connected";
|
|
9
|
+
/** The parts the map shows when none is named: every library chip and every connector, in name order. */
|
|
10
|
+
export function pinMapParts(design) {
|
|
11
|
+
return design.circuit.components
|
|
12
|
+
.filter((c) => isLibraryChip(design, c.id) || isConnector(c))
|
|
13
|
+
.map((c) => c.id)
|
|
14
|
+
.sort(naturalCompare);
|
|
15
|
+
}
|
|
16
|
+
/** The library chips among the parts: the package writes a C header for each. */
|
|
17
|
+
export function isLibraryChip(design, part) {
|
|
18
|
+
const component = design.circuit.components.find((c) => c.id === part);
|
|
19
|
+
return component?.library !== undefined && component.kind === "chip";
|
|
20
|
+
}
|
|
21
|
+
function componentNamed(design, part) {
|
|
22
|
+
const component = design.circuit.components.find((c) => c.id === part);
|
|
23
|
+
if (component)
|
|
24
|
+
return component;
|
|
25
|
+
const names = design.circuit.components.map((c) => c.id).sort(naturalCompare);
|
|
26
|
+
throw new Error(`No part named ${part} in ${design.file}. Parts: ${names.join(", ")}`);
|
|
27
|
+
}
|
|
28
|
+
/** A net the build named from a pin has the id "net:" + that pin and no names. */
|
|
29
|
+
const isMadeUp = (net) => net.names.length === 0;
|
|
30
|
+
/** A row per pad of the part, by pad number; throws, listing the parts there are, when there is no such part. */
|
|
31
|
+
export function pinRows(design, part) {
|
|
32
|
+
return signalRows(design, part).map(({ signal: _signal, ...row }) => row);
|
|
33
|
+
}
|
|
34
|
+
/** The rows with `signal` set on the named signal nets, which the header's reverse list reads. */
|
|
35
|
+
function signalRows(design, part) {
|
|
36
|
+
const component = componentNamed(design, part);
|
|
37
|
+
const typeOf = new Map(design.circuit.components.flatMap((c) => c.pins.map((p) => [p.id, p.type])));
|
|
38
|
+
return [...component.pins]
|
|
39
|
+
.sort((a, b) => a.number - b.number)
|
|
40
|
+
.map((pin) => {
|
|
41
|
+
const base = { pad: String(pin.number), pin: pin.names[1] ?? pin.names[0] ?? `pin${pin.number}`, type: pin.type };
|
|
42
|
+
const net = design.circuit.nets.find((n) => n.pins.includes(pin.id));
|
|
43
|
+
if (!net || net.pins.length < 2)
|
|
44
|
+
return { ...base, net: NOT_CONNECTED };
|
|
45
|
+
if (isMadeUp(net))
|
|
46
|
+
return { ...base, net: net.id.replace(/^net:/, ""), origin: "made up" };
|
|
47
|
+
return { ...base, net: net.names[0], origin: "given", ...(isPowerNet(net, (p) => typeOf.get(p)) ? {} : { signal: true }) };
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
/** The rows of the parts, each with its title: the library part's title, else the part's kind. */
|
|
51
|
+
export function mappedParts(design, parts, titles) {
|
|
52
|
+
return parts.map((id) => ({ id, title: titles.get(id) ?? componentNamed(design, id).kind, rows: signalRows(design, id) }));
|
|
53
|
+
}
|
|
54
|
+
const mdCell = (value) => value.replace(/\|/g, "\\|");
|
|
55
|
+
const originText = (row) => row.origin ?? "";
|
|
56
|
+
export function formatPinsMarkdown(parts) {
|
|
57
|
+
return parts
|
|
58
|
+
.map((part) => [
|
|
59
|
+
`## ${part.id}: ${mdCell(part.title)}`,
|
|
60
|
+
"",
|
|
61
|
+
"| Pad | Pin | Type | Net | Net name |",
|
|
62
|
+
"| --- | --- | --- | --- | --- |",
|
|
63
|
+
...part.rows.map((r) => `| ${[r.pad, r.pin, r.type, r.net, originText(r)].map(mdCell).join(" | ")} |`),
|
|
64
|
+
"",
|
|
65
|
+
].join("\n"))
|
|
66
|
+
.join("\n");
|
|
67
|
+
}
|
|
68
|
+
export function formatPinsCsv(parts) {
|
|
69
|
+
const rows = parts.flatMap((part) => part.rows.map((r) => [part.id, r.pad, r.pin, r.type, r.net, originText(r)]));
|
|
70
|
+
return `${[["Part", "Pad", "Pin", "Type", "Net", "Net name"], ...rows].map((row) => row.map(csvCell).join(",")).join("\n")}\n`;
|
|
71
|
+
}
|
|
72
|
+
export const PIN_FORMATS = ["md", "csv", "c"];
|
|
73
|
+
/** The titles of the library parts among `parts`, read from the library. */
|
|
74
|
+
export async function libraryTitles(root, design, parts) {
|
|
75
|
+
const titles = new Map();
|
|
76
|
+
for (const id of parts) {
|
|
77
|
+
const library = design.circuit.components.find((c) => c.id === id)?.library;
|
|
78
|
+
if (library)
|
|
79
|
+
titles.set(id, (await readPart(root, library)).title);
|
|
80
|
+
}
|
|
81
|
+
return titles;
|
|
82
|
+
}
|
|
83
|
+
/** The map of a design's parts in a format; `guard` names the C header (its file name without .h). */
|
|
84
|
+
export function formatPins(design, parts, format, guard) {
|
|
85
|
+
if (format === "csv")
|
|
86
|
+
return formatPinsCsv(parts).replace(/\n$/, "");
|
|
87
|
+
if (format === "c")
|
|
88
|
+
return formatPinHeader(design.file, parts, guard);
|
|
89
|
+
return formatPinsMarkdown(parts).replace(/\n$/, "");
|
|
90
|
+
}
|
|
91
|
+
/** The circuit's name for a header guard: "boards/can-node.circuit.tsx" is "can-node". */
|
|
92
|
+
const circuitName = (file) => (file.split("/").pop() ?? file).replace(/\.circuit\.tsx$/, "");
|
|
93
|
+
/** `copperflow pins`: one part, or every library chip and connector, in a format. */
|
|
94
|
+
export async function pinMapText(root, file, options = {}) {
|
|
95
|
+
const { file: circuit } = await resolveCircuit(root, file);
|
|
96
|
+
const design = options.design ?? (await buildWith(root, circuit, options.engine));
|
|
97
|
+
const parts = options.part !== undefined ? [componentNamed(design, options.part).id] : pinMapParts(design);
|
|
98
|
+
const mapped = mappedParts(design, parts, await libraryTitles(root, design, parts));
|
|
99
|
+
return formatPins(design, mapped, options.format ?? "md", options.part ?? circuitName(design.file));
|
|
100
|
+
}
|
|
101
|
+
//# sourceMappingURL=pin-map.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pin-map.js","sourceRoot":"","sources":["../../src/core/pin-map.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAE,SAAS,EAAqB,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAA;AAuB5C,yGAAyG;AACzG,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU;SAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;SAC5D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAChB,IAAI,CAAC,cAAc,CAAC,CAAA;AACzB,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,aAAa,CAAC,MAAc,EAAE,IAAY;IACxD,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,CAAA;IACtE,OAAO,SAAS,EAAE,OAAO,KAAK,SAAS,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,CAAA;AACtE,CAAC;AAED,SAAS,cAAc,CAAC,MAAc,EAAE,IAAY;IAClD,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,CAAA;IACtE,IAAI,SAAS;QAAE,OAAO,SAAS,CAAA;IAC/B,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAC7E,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,OAAO,MAAM,CAAC,IAAI,YAAY,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AACxF,CAAC;AAED,kFAAkF;AAClF,MAAM,QAAQ,GAAG,CAAC,GAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAA;AAErD,iHAAiH;AACjH,MAAM,UAAU,OAAO,CAAC,MAAc,EAAE,IAAY;IAClD,OAAO,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;AAC3E,CAAC;AAED,kGAAkG;AAClG,SAAS,UAAU,CAAC,MAAc,EAAE,IAAY;IAC9C,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAC9C,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAU,CAAC,CAAC,CAAC,CAAA;IAC5G,OAAO,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC;SACvB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;SACnC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,IAAI,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,GAAG,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAA;QACjH,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;QACpE,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,aAAa,EAAE,CAAA;QACvE,IAAI,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,SAAkB,EAAE,CAAA;QACnG,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAW,EAAE,MAAM,EAAE,OAAgB,EAAE,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAA;IAC/I,CAAC,CAAC,CAAA;AACN,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,WAAW,CAAC,MAAc,EAAE,KAAwB,EAAE,MAAmC;IACvG,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;AAC5H,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AAC7D,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAA;AAEpD,MAAM,UAAU,kBAAkB,CAAC,KAA4B;IAC7D,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACZ;QACE,MAAM,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;QACtC,EAAE;QACF,uCAAuC;QACvC,iCAAiC;QACjC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QACtG,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb;SACA,IAAI,CAAC,IAAI,CAAC,CAAA;AACf,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAA4B;IACxD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACjH,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;AAChI,CAAC;AAGD,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;AAEnE,4EAA4E;AAC5E,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAY,EAAE,MAAc,EAAE,KAAwB;IACxF,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAA;IACxC,KAAK,MAAM,EAAE,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,CAAA;QAC3E,IAAI,OAAO;YAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IACpE,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,sGAAsG;AACtG,MAAM,UAAU,UAAU,CAAC,MAAc,EAAE,KAA4B,EAAE,MAAiB,EAAE,KAAa;IACvG,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACpE,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;IACrE,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;AACrD,CAAC;AAED,0FAA0F;AAC1F,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAA;AAEpG,qFAAqF;AACrF,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,IAAY,EACZ,IAAY,EACZ,OAAO,GAAkF,EAAE;IAE3F,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;IACjF,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1G,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;IACnF,OAAO,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AACrG,CAAC"}
|
package/dist/core/render.d.ts
CHANGED
|
@@ -1,14 +1,31 @@
|
|
|
1
1
|
import type { Design } from "../engine/design.js";
|
|
2
|
+
import type { DesignDiff } from "../engine/design-diff.js";
|
|
3
|
+
import type { Side } from "../engine/fab/picture/board-picture.js";
|
|
4
|
+
import type { LookRequest } from "../engine/fab/picture/looks.js";
|
|
5
|
+
import type { CanvasLoader } from "../engine/fab/picture/png.js";
|
|
2
6
|
import { type DesignSource } from "./design-source.js";
|
|
7
|
+
import type { Modeller } from "./model-export.js";
|
|
3
8
|
/** What to draw; the Studio's renderer defines the same. */
|
|
4
9
|
export interface RenderRequest {
|
|
5
|
-
|
|
10
|
+
/** "board": the bare board as made, from the fabrication layers. */
|
|
11
|
+
view: "pcb" | "schematic" | "board" | "3d";
|
|
12
|
+
/** The board view's side; refused for the others. */
|
|
13
|
+
side?: Side;
|
|
14
|
+
/** The look of the board and 3d views; refused for the others. */
|
|
15
|
+
look?: LookRequest;
|
|
16
|
+
/** View 3d's angle: top, bottom, front or iso (the default). */
|
|
17
|
+
angle?: "top" | "bottom" | "front" | "iso";
|
|
6
18
|
/** The schematic page; the first one when left out. Refused for the PCB. */
|
|
7
19
|
page?: string;
|
|
8
20
|
/** Zoom to these parts (their courtyards plus a margin) instead of the whole board or sheet. */
|
|
9
21
|
parts?: string[];
|
|
10
|
-
/** Width of the image in pixels, 320 to 2000; 1024 by default. The height follows the drawing's shape. */
|
|
22
|
+
/** Width of the image in pixels, 320 to 2000 (4000 for the board); 1024 by default. The height follows the drawing's shape. */
|
|
11
23
|
width?: number;
|
|
24
|
+
/** A change marked over the dimmed board, and the words the line ends with (change-render.ts). The PCB only. */
|
|
25
|
+
change?: {
|
|
26
|
+
diff: DesignDiff;
|
|
27
|
+
caption: string;
|
|
28
|
+
};
|
|
12
29
|
}
|
|
13
30
|
/** The picture and one line saying what it shows. */
|
|
14
31
|
export interface Rendered {
|
|
@@ -18,8 +35,10 @@ export interface Rendered {
|
|
|
18
35
|
what: string;
|
|
19
36
|
/** The schematic page drawn; none for the PCB. */
|
|
20
37
|
page?: string;
|
|
38
|
+
/** What the line names in place of the file: the design's name for the board view. */
|
|
39
|
+
label?: string;
|
|
21
40
|
}
|
|
22
|
-
export interface Renderer {
|
|
41
|
+
export interface Renderer extends Modeller {
|
|
23
42
|
renderDesign(design: Design, request: RenderRequest): Promise<Rendered>;
|
|
24
43
|
}
|
|
25
44
|
export interface RenderOptions {
|
|
@@ -29,6 +48,8 @@ export interface RenderOptions {
|
|
|
29
48
|
engine?: DesignSource;
|
|
30
49
|
/** Loads the renderer; tests pass the source module. Without it the bundled dist/render/render.js is loaded. */
|
|
31
50
|
renderer?: () => Promise<Renderer>;
|
|
51
|
+
/** Loads the canvas package for the board view; tests pass one that fails. */
|
|
52
|
+
canvas?: CanvasLoader;
|
|
32
53
|
}
|
|
33
54
|
export declare const CANVAS_MISSING = "Rendering needs the optional package @napi-rs/canvas, which is not installed here. Install it (npm install -g @napi-rs/canvas) and try again.";
|
|
34
55
|
/** Builds the circuit and draws the requested view of it; the canvas package missing is said in plain words. */
|
|
@@ -39,7 +60,7 @@ export declare function renderCircuit(root: string, file: string, request: Rende
|
|
|
39
60
|
export declare const renderedLine: (rendered: Rendered & {
|
|
40
61
|
file: string;
|
|
41
62
|
}) => string;
|
|
42
|
-
/** `<name>-pcb.png` or `<name>-schematic-<page>.png` beside the circuit, the page made safe for a file name. */
|
|
43
|
-
export declare function defaultPictureName(circuit: string, view: RenderRequest["view"], page: string | undefined): string;
|
|
63
|
+
/** `<name>-pcb.png`, `<name>-board-<side>.png` or `<name>-schematic-<page>.png` beside the circuit, the page made safe for a file name. */
|
|
64
|
+
export declare function defaultPictureName(circuit: string, view: RenderRequest["view"], page: string | undefined, side?: Side, angle?: string): string;
|
|
44
65
|
/** Draws the picture and writes it into the project (refusing a path outside it); answers the CLI's line. */
|
|
45
66
|
export declare function writeRender(root: string, file: string, request: RenderRequest, out: string | undefined, options?: RenderOptions): Promise<string>;
|
package/dist/core/render.js
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
// A picture of a circuit's board or of one schematic page, for the CLI and the MCP server: builds the design and hands
|
|
2
2
|
// it to the Studio's renderer, bundled to dist/render/render.js (studio/src/render/node-render.ts), which draws it with
|
|
3
|
-
// the Studio's own drawing code on a canvas from the optional package @napi-rs/canvas
|
|
3
|
+
// the Studio's own drawing code on a canvas from the optional package @napi-rs/canvas; the board as made (view "board")
|
|
4
|
+
// is drawn from the fabrication layers instead (src/engine/fab/picture). Also writes the picture for the CLI.
|
|
4
5
|
import { mkdir, writeFile } from "node:fs/promises";
|
|
5
6
|
import { basename, dirname, relative, resolve, sep } from "node:path";
|
|
7
|
+
import { renderBoardView } from "../engine/fab/picture/board-view.js";
|
|
6
8
|
import { buildWith } from "./design-source.js";
|
|
7
9
|
import { assertLandsInProject } from "./fabrication.js";
|
|
8
10
|
import { resolveCircuit } from "./workspace.js";
|
|
@@ -20,8 +22,16 @@ function canvasMissing(error) {
|
|
|
20
22
|
/** Builds the circuit and draws the requested view of it; the canvas package missing is said in plain words. */
|
|
21
23
|
export async function renderCircuit(root, file, request, options = {}) {
|
|
22
24
|
const { file: circuit } = await resolveCircuit(root, file);
|
|
25
|
+
if (request.view === "3d" && request.side !== undefined)
|
|
26
|
+
throw new Error("side is for view board only; view 3d takes angle");
|
|
27
|
+
if (request.view !== "3d" && request.angle !== undefined)
|
|
28
|
+
throw new Error("angle is for view 3d only");
|
|
29
|
+
if (request.view !== "board" && request.view !== "3d" && (request.side !== undefined || request.look !== undefined))
|
|
30
|
+
throw new Error("side and look are for view board only");
|
|
23
31
|
const design = options.design ?? (await buildWith(root, circuit, options.engine));
|
|
24
32
|
try {
|
|
33
|
+
if (request.view === "board")
|
|
34
|
+
return { ...(await renderBoardView(design, request, options.canvas)), file: circuit };
|
|
25
35
|
const renderer = await (options.renderer ?? bundledRenderer)();
|
|
26
36
|
return { ...(await renderer.renderDesign(design, request)), file: circuit };
|
|
27
37
|
}
|
|
@@ -32,11 +42,11 @@ export async function renderCircuit(root, file, request, options = {}) {
|
|
|
32
42
|
}
|
|
33
43
|
}
|
|
34
44
|
/** The one-line answer: `io.circuit.tsx: PCB, whole board 32.3 x 23.6 mm; 1024 x 748 px`. */
|
|
35
|
-
export const renderedLine = (rendered) => `${rendered.file}: ${rendered.what}; ${rendered.width} x ${rendered.height} px`;
|
|
36
|
-
/** `<name>-pcb.png` or `<name>-schematic-<page>.png` beside the circuit, the page made safe for a file name. */
|
|
37
|
-
export function defaultPictureName(circuit, view, page) {
|
|
45
|
+
export const renderedLine = (rendered) => `${rendered.label ?? rendered.file}: ${rendered.what}; ${rendered.width} x ${rendered.height} px`;
|
|
46
|
+
/** `<name>-pcb.png`, `<name>-board-<side>.png` or `<name>-schematic-<page>.png` beside the circuit, the page made safe for a file name. */
|
|
47
|
+
export function defaultPictureName(circuit, view, page, side = "top", angle = "iso") {
|
|
38
48
|
const name = basename(circuit).replace(/\.(circuit|sheet)\.tsx$/, "");
|
|
39
|
-
const suffix = view === "pcb" ? "pcb" : `schematic-${(page ?? "Main").replace(/[^A-Za-z0-9_-]+/g, "-")}`;
|
|
49
|
+
const suffix = view === "pcb" ? "pcb" : view === "board" ? `board-${side}` : view === "3d" ? `3d-${angle}` : `schematic-${(page ?? "Main").replace(/[^A-Za-z0-9_-]+/g, "-")}`;
|
|
40
50
|
const folder = dirname(circuit);
|
|
41
51
|
return `${folder === "." ? "" : `${folder}/`}${name}-${suffix}.png`;
|
|
42
52
|
}
|
|
@@ -47,7 +57,7 @@ export async function writeRender(root, file, request, out, options = {}) {
|
|
|
47
57
|
if (out !== undefined)
|
|
48
58
|
await assertLandsInProject(root, resolve(root, out));
|
|
49
59
|
const rendered = await renderCircuit(root, file, request, options);
|
|
50
|
-
const target = resolve(root, out ?? defaultPictureName(rendered.file, request.view, rendered.page));
|
|
60
|
+
const target = resolve(root, out ?? defaultPictureName(rendered.file, request.view, rendered.page, request.side, request.angle));
|
|
51
61
|
await assertLandsInProject(root, target);
|
|
52
62
|
await mkdir(dirname(target), { recursive: true });
|
|
53
63
|
await writeFile(target, rendered.png);
|
package/dist/core/render.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/core/render.ts"],"names":[],"mappings":"AAAA,uHAAuH;AACvH,wHAAwH;AACxH,
|
|
1
|
+
{"version":3,"file":"render.js","sourceRoot":"","sources":["../../src/core/render.ts"],"names":[],"mappings":"AAAA,uHAAuH;AACvH,wHAAwH;AACxH,wHAAwH;AACxH,8GAA8G;AAC9G,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAGrE,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAA;AAIrE,OAAO,EAAE,SAAS,EAAqB,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAiD/C,MAAM,CAAC,MAAM,cAAc,GACzB,+IAA+I,CAAA;AAEjJ,sHAAsH;AACtH,MAAM,eAAe,GAAG,GAAsB,EAAE,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,qBAAqB,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAsB,CAAA;AAElI,wGAAwG;AACxG,SAAS,aAAa,CAAC,KAAc;IACnC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAA8C,CAAA;IACxE,MAAM,IAAI,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;IACvD,IAAI,IAAI,KAAK,sBAAsB,IAAI,IAAI,KAAK,kBAAkB;QAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAA;IAC3G,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAA;AACzE,CAAC;AAED,gHAAgH;AAChH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAY,EAAE,IAAY,EAAE,OAAsB,EAAE,OAAO,GAAkB,EAAE;IACjH,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC1D,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;IAC5H,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;IACtG,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;IAC7K,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;IACjF,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO;YAAE,OAAO,EAAE,GAAG,CAAC,MAAM,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;QACnH,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC,EAAE,CAAA;QAC9D,OAAO,EAAE,GAAG,CAAC,MAAM,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;IAC7E,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,aAAa,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAA;QACzD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC;AAED,6FAA6F;AAC7F,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAqC,EAAU,EAAE,CAAC,GAAG,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,MAAM,QAAQ,CAAC,MAAM,KAAK,CAAA;AAEhL,2IAA2I;AAC3I,MAAM,UAAU,kBAAkB,CAAC,OAAe,EAAE,IAA2B,EAAE,IAAwB,EAAE,IAAI,GAAS,KAAK,EAAE,KAAK,GAAG,KAAK;IAC1I,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAA;IACrE,MAAM,MAAM,GAAG,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC,EAAE,CAAA;IAC7K,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/B,OAAO,GAAG,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,GAAG,IAAI,IAAI,MAAM,MAAM,CAAA;AACrE,CAAC;AAED,6GAA6G;AAC7G,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAY,EAAE,IAAY,EAAE,OAAsB,EAAE,GAAuB,EAAE,OAAO,GAAkB,EAAE;IACxI,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAA;IACxH,IAAI,GAAG,KAAK,SAAS;QAAE,MAAM,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;IAC3E,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IAClE,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,IAAI,kBAAkB,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;IAChI,MAAM,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACxC,MAAM,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IACjD,MAAM,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAClE,OAAO,SAAS,KAAK,KAAK,QAAQ,CAAC,KAAK,MAAM,QAAQ,CAAC,MAAM,SAAS,QAAQ,CAAC,IAAI,EAAE,CAAA;AACvF,CAAC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { CARD_LIMITS, PORT_TYPES } from "../engine/sheet-ports.js";
|
|
2
2
|
import type { PinType } from "../engine/model.js";
|
|
3
|
+
import { type SimCase } from "../engine/sim/cases.js";
|
|
3
4
|
import { type Scan } from "./analyze.js";
|
|
4
5
|
export { CARD_LIMITS, PORT_TYPES };
|
|
5
6
|
export interface CardPort {
|
|
@@ -11,11 +12,14 @@ export interface SheetCardText {
|
|
|
11
12
|
does?: string;
|
|
12
13
|
sources?: string[];
|
|
13
14
|
ports: CardPort[];
|
|
15
|
+
/** The cases simulate runs, when the card has them and they read as cases. */
|
|
16
|
+
cases?: SimCase[];
|
|
14
17
|
}
|
|
15
18
|
/** What describe_sheet changes: a value sets, null removes, absent keeps. */
|
|
16
19
|
export interface CardChange {
|
|
17
20
|
does?: string | null;
|
|
18
21
|
sources?: string[] | null;
|
|
22
|
+
cases?: SimCase[] | null;
|
|
19
23
|
ports?: Record<string, {
|
|
20
24
|
type?: string | null;
|
|
21
25
|
carries?: string | null;
|