@rulecad/cad 0.3.0 → 0.3.2

package/AGENTS.md

@@ -50,8 +50,8 @@ variable says which rule it comes from. Follow these steps; they're what makes a
 - A part is named in fits as `<item>.<part>`; an object that returns one unnamed shape has one part, `body`.
 - A gap fit can't tell whether holes line up. Where a board screws into a part, add a holes fit
   (`{ "holes": "pcb.board", "into": "case.body", "depth": "m2.insert_length" }`).
-- A part built around another (a case around its board) reads it: `"uses": ["node/carrier"]`, then
-  `carrier.board_w` and `v.carrier.board_holes`. Never copy another object's numbers by hand.
+- A part built around another (a case around its board) reads it: `"uses": ["macropad/pcb"]`, then
+  `pcb.board_w` and `v.pcb.board_holes`. Never copy another object's numbers by hand.
 
 ## Circuit boards
 - `"engine": "pcb"` in the .json; `main(v)` returns a board built with `v.pcb` (see @rulecad/pcb's README).

package/README.md

@@ -96,12 +96,12 @@ which version it holds (`keyboard/keycap@0.1.0`, or `+changes` if it isn't a rel
 
 - `value`: a number, or arithmetic over numbers and names (`+ - * /`, brackets, `min`, `max`, `round`). Rule sets are
   `<namespace>.<rule>`; the object's own variables are bare names. Parsed, never evaluated as code.
-- **Other objects' numbers:** `"uses": ["node/carrier"]` reads another object as a rule set named after it:
-  `carrier.board_w` in an expression, `v.carrier.board_w` in code. It gets the object's variables and, from a board, its
-  outline (`board_x`, `board_y`, `board_w`, `board_d`) and, in code, where each of its parts is (`v.carrier.board_parts`),
-  a shaped board's outline (`board_outline`) and its mounting holes (`v.carrier.board_holes`, each
-  `{ x, y, d }`). So a case follows its board: change the board and the case rebuilds around it. `"node/carrier@^0.2.0"`
-  also checks the version; `"node/carrier@0.2.0"` reads that release. `cad rules` shows each borrowed number with the
+- **Other objects' numbers:** `"uses": ["macropad/pcb"]` reads another object as a rule set named after it:
+  `pcb.board_w` in an expression, `v.pcb.board_w` in code. It gets the object's variables and, from a board, its
+  outline (`board_x`, `board_y`, `board_w`, `board_d`) and, in code, where each of its parts is (`v.pcb.board_parts`),
+  a shaped board's outline (`board_outline`) and its mounting holes (`v.pcb.board_holes`, each
+  `{ x, y, d }`). So a case follows its board: change the board and the case rebuilds around it. `"macropad/pcb@^0.2.0"`
+  also checks the version; `"macropad/pcb@0.2.0"` reads that release. `cad rules` shows each borrowed number with the
   object and version it came from; two objects can't read each other.
 - `show`: on the rules card `cad show` hands its target (six at most). `interface`: other parts depend on it (versioning will compare these).
 - `tweak: { min, max }`: may be changed with `--set`. Variables without one are fixed by their rule.
@@ -124,7 +124,7 @@ which version it holds (`keyboard/keycap@0.1.0`, or `+changes` if it isn't a rel
   only touches a's faces near b; JSCAD's own splits every face along b's planes, which can leave slivers far away).
 - A rule set can also carry `"footprints"` (pad data from @rulecad/pcb's `fromKicad`, with its source), which a
   board's code reads as `v.parts.footprints.usb_c`.
-- An object or rule set named with a hyphen (`pod-th`) is read with an underscore in expressions (`pod_th.width`),
+- An object or rule set named with a hyphen (`mx-switch`) is read with an underscore in expressions (`mx_switch.housing_top`),
   since a hyphen there is a minus.
 - Rules carry `kind`: spec (manufacturer), default (slicer), community (rule of thumb) or measured (your own test
   print, which beats the rest), plus `source` and `checked`.

package/bin/cad.mjs

@@ -12,7 +12,7 @@ import { git, tags, bump, bigger, newer, compare, snapshot, materialise, files,
 import { check } from '@rulecad/printcheck';
 import { preview } from '../lib/preview.mjs';
 import { isAssembly, buildAssembly, checkAssembly, shapes } from '../lib/assembly.mjs';
-import { fromParts, fromShapes, encode } from '@rulecad/model-link';
+import { fromParts, fromShapes, encode, check as checkLink, expand } from '@rulecad/model-link';
 import { threemf, slotOf } from '../lib/threemf.mjs';
 
 // The project's filaments: { base: { slot: 1, … }, legend: { slot: 2, … } } in project.json
@@ -31,6 +31,12 @@ function filamentNotes(parts, fil) {
 const openInSlicer = (f) => (process.platform === 'darwin' ? execFileSync('open', ['-a', 'Bambu Studio', f])
   : execFileSync(process.platform === 'win32' ? 'explorer' : 'xdg-open', [f]));
 const VIEW = process.env.CAD_VIEW_URL || config.viewUrl;
+// A link to the model page; one the page would turn away is an error here, not when someone opens it
+async function linkTo(model) {
+  const errors = checkLink(model.shapes ? expand(model) : model);
+  if (errors.length) throw new Error(`no link: ${errors[0]}`);
+  return `${VIEW}#m=${await encode(model)}`;
+}
 
 const HELP = `cad: JSCAD designs you can trace, check, share and print (rulecad)
 
@@ -278,7 +284,7 @@ async function assembly(cmd, ref) {
         return placed.place.map(([i, ...m], n) => { const p = placed.shapes[i].part; return { shape: i, role: p.role, label: p.object || p.label, slot: slotOf(fil, p.filament), triangles: tri(placed.shapes[i].triangles), matrix: m, name: s.parts[n].name }; });
       })() : []),
     };
-    const url = `${VIEW}#m=${await encode(model)}`;
+    const url = await linkTo(model);
     return { view: url, stl: `${url}&get=stl`, '3mf': `${url}&get=3mf`, src: model.src, size: url.length, title, version: '' };
   };
   if (cmd === 'link') return await printLinks(await link());
@@ -309,7 +315,7 @@ async function links(d, b, set) {
     ...(b.circuit ? { views: await (await pcbEngine()).views(b.circuit) } : {}), // boards: the 2D board and schematic
     ...fromParts(b.parts.map((p) => ({ name: p.name, role: p.role, label: p.label, slot: slotOf(fil, p.filament), triangles: p.triangles.flatMap((t) => t.slice(1, -1).map((_, i) => [t[0], t[i + 1], t[i + 2]])) }))),
   };
-  const url = `${VIEW}#m=${await encode(model)}`;
+  const url = await linkTo(model);
   return { view: url, stl: `${url}&get=stl`, '3mf': `${url}&get=3mf`, src, size: url.length, title: model.title, version };
 }
 

package/lib/design.mjs

@@ -46,10 +46,10 @@ export function locate(ref) {
 }
 
 // ---------- objects that read each other ----------
-// "uses": ["node/carrier"] reads another object's numbers as a rule set named after it (carrier.board_w in an
-// expression, v.carrier.board_w in code): its variables, and what a board tells the parts around it (board_x, board_y,
-// board_w, board_d, and for code board_holes, board_parts (where each part is) and board_outline, for a shaped board). The object is built (cached) first. "node/carrier@^0.2.0" also checks
-// its version; "node/carrier@0.2.0" reads that release instead of the working copy.
+// "uses": ["macropad/pcb"] reads another object's numbers as a rule set named after it (pcb.board_w in an
+// expression, v.pcb.board_w in code): its variables, and what a board tells the parts around it (board_x, board_y,
+// board_w, board_d, and for code board_holes, board_parts (where each part is) and board_outline, for a shaped board). The object is built (cached) first. "macropad/pcb@^0.2.0" also checks
+// its version; "macropad/pcb@0.2.0" reads that release instead of the working copy.
 export const isObjectRef = (u) => String(u).includes('/');
 const building = new Set();
 export async function objectSets(d, object) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rulecad/cad",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "The cad command: JSCAD designs from traceable rules, checked for printing and fit, versioned by what fits, shared as links and exported as Bambu 3MF.",
   "type": "module",
   "bin": {
@@ -47,7 +47,7 @@
     "@rulecad/keyboard-layout": "^0.1.2",
     "@rulecad/printcheck": "^0.1.0",
     "@rulecad/fit": "^0.2.0",
-    "@rulecad/model-link": "^0.1.2",
+    "@rulecad/model-link": "^0.1.4",
     "@rulecad/versions": "^0.1.0",
     "@rulecad/shapes": "^0.2.0",
     "@rulecad/rules": "^0.2.0",