lineadraw 0.6.0 → 0.8.0

package/README.md

@@ -128,8 +128,7 @@ lineadraw manifest   Validate all modules and write .lineadraw/marketplace.json
 lineadraw check      Validate without writing; fail if the committed manifest is stale
 lineadraw init       Add the marketplace structure to the current npm project
 
-lineadraw status     Is the Linea desktop app serving agents? port, open editors
-lineadraw editors    The open drawings: id, name, path, kind, dirty
+lineadraw status     App version, port, the open drawings: id, name, path, kind, dirty
 lineadraw open <file.linea>            Open a file in a new window
 lineadraw close [--editor <x>] [--discard]
 lineadraw call <operation> ['<json>'] [--editor <x>]   Run one linea_* tool
@@ -142,7 +141,8 @@ token; `--port`, `--token` and `LINEA_BRIDGE_TOKEN` override) — see
 docs/desktop-bridge.md in the linea repo.
 
 The manifest is deterministic (repo-relative paths, no git metadata), so
-`check` is a byte-for-byte diff — the included CI workflow runs it on every
+`check` compares the parsed JSON (formatting, a trailing newline or CRLF
+line endings never make it stale) — the included CI workflow runs it on every
 push and PR. `manifest`/`check` also **dry-run every block** through
 `lineadraw/sdk` and render thumbnails.
 
@@ -181,10 +181,10 @@ const walls = doc.addLayer({ name: "walls", color: "#e8e8e8", lineWidth: 0.5 });
 doc.add([
   { type: "polyline", layerId: walls, closed: true,
     points: [[0, 0], [6000, 0], [6000, 3000], [0, 3000]] },
-  { type: "dimension", points: [[0, 0], [6000, 0]], offset: [0, -500],
+  { type: "dimension", points: [[0, 0], [6000, 0]], offset: -500,
     scale: 50 },                                 // annotations × drawing scale
 ]);
-doc.createLayout("Plan 1:50", { sheet: "A3", viewport: { scale: "1:50" } });
+doc.addLayout("Plan 1:50", { sheet: "A3", viewport: { scale: "1:50" } });
 await doc.exportPng("check.png", { width: 1600 });  // verify by LOOKING at it
 await doc.save("plan.linea");
 await doc.exportPdf("plan.pdf");
@@ -212,7 +212,7 @@ await doc.exportPdf("plan.pdf");
   paper size (2.5 body / 3.5 / 5 titles). `scale` is NOT a `styleOverride`
   key; `add`/`update` reject it there.
 - **Reads are detached snapshots**: `doc.document`, `doc.objects`,
-  `getObject`, `query()` return deep clones — mutating them does nothing.
+  `getObject`, `listObjects()` return deep clones — mutating them does nothing.
 - **New documents are layout-less**; `exportPdf` of a layout-less document
   falls back to one auto-fitted A3 page.
 - `transaction(fn)` groups edits into one undo step. `array(ids, count,
@@ -222,29 +222,50 @@ await doc.exportPdf("plan.pdf");
 
 ### API surface
 
-`newDrawing(name?)` / `drawingFromJson(text)` / `openDrawing(path)` → `Drawing`:
+`newDrawing(name?, options?)` / `drawingFromJson(text)` / `openDrawing(path, options?)`
+→ `Drawing`; `options.marketplaces` lists the marketplaces to search and
+install from (`{ kind: "github", spec: "owner/repo[@branch]", token? }` or
+`{ kind: "folder", folder }`, priority order; the public collection is
+appended when missing):
 
 - **Name**: `drawing.name` is the file name (set on `openDrawing`, updated
   by `save(path)`); `newDrawing(name)` names it until it is saved. The
   `.linea` JSON itself carries no name.
 
 - **Read**: `summary()`, `objects`, `layers`, `layouts`, `getObject`,
-  `query({ids, type, layer, color, lineType, content, bbox, inside, near, layout})`,
+  `listObjects({ids, type, layer, color, lineType, content, bbox, inside, near, layout})`,
   `measure(id)` (`bboxOf(ids)`, `length(id)`, `area(id)`), `listLayers()`,
-  `listLayouts()`, `listBlocks()`, `listCommands()`, `revision`
+  `listLayouts()`, `listTextStyles()`, `listDimStyles()`,
+  `listBlockDefinitions()`, `listUserCommands()`, `revision`
 - **Edit**: `add(objects, {layout?})`, `update(ids, patch)` or
   `update([{id, ...patch}])`, `remove(ids)` (→ count), `reorder(ids,
   "front" | "back" | {above} | {below})`, `transaction(fn)` (sync or async;
-  a throw rolls back), `undo()`, `redo()`, `setDimStyle`,
-  `setTextStyle`, `applyOps(ops)`, `ready()`
-- **Modules**: `await installBlocks(sources)` / `removeBlock(id)`,
-  `await installCommands(sources)` / `removeCommand(id)`,
+  a throw rolls back), `undo()`, `redo()`, `applyOps(ops)`, `ready()`
+- **Styles** (by name or id): `listTextStyles()`, `addTextStyle({name, …})`,
+  `updateTextStyle(nameOrId, patch)`, `removeTextStyle(nameOrId)` (refused
+  while objects use it) — the same four for `DimStyle`; `setTextStyle` /
+  `setDimStyle` remain as deprecated aliases of update
+- **Line types / hatch patterns** (the document's own definitions, by
+  name, resolved ahead of the built-in catalogue): `listLineTypes()`,
+  `addLineTypes([{name, dashesMm}])`, `updateLineType(name, patch)`,
+  `removeLineType(name)`; `listHatchPatterns()`,
+  `addHatchPatterns([{name, lines}])`, `updateHatchPattern(name, patch)`,
+  `removeHatchPattern(name)`
+- **Modules**: `await addBlockDefinitions(sources)` / `removeBlockDefinition(id)`,
+  `await addUserCommands(sources)` / `removeUserCommand(id)`,
   `await setBlockDefinitions(sources)`, `await setCommands(sources)`
+- **Marketplaces**: `listMarketplaces()`, `await addMarketplaces(list)`
+  (verifies each catalog), `removeMarketplaces(names)`,
+  `await searchMarketplaces({ query?, kind?, marketplace? })` (entries with
+  install status), `await installMarketplaceEntries(ids, marketplace?)`
+  (declared block dependencies first, one undo step) — then insert a block
+  with `add([{ type: "block", definitionId }])`. Marketplaces are process
+  configuration, never written to the file.
 - **Scripts**: `await runScript(source, inputs?, params?)` runs a
   `defineCommand` module (the same one the editor palette runs) headlessly
   as ONE undo step — its declared `inputs` (points) are supplied up front,
   its declared `params` by name (`{ count: 3 }`; omitted ones take their
-  defaults, unknown names and wrong types throw); `runCommand(id, inputs?,
+  defaults, unknown names and wrong types throw); `runUserCommand(id, inputs?,
   params?)` runs one of the document's own commands. Returns the script's
   return value.
 - **Layers**: `addLayer`, `updateLayer(nameOrId, patch)`,
@@ -253,14 +274,14 @@ await doc.exportPdf("plan.pdf");
 - **Assets**: `addAsset(dataUrl) → assetId` (for `image` objects;
   content-keyed), `removeAsset(id)` (refused while referenced)
 - **Transform**: `move`, `rotate` (radians), `scale`, `mirror`, `copy`, `array`
-- **Layouts**: `createLayout(name, {sheet, scale, viewport, index})`,
+- **Layouts**: `addLayout(name, {sheet, scale, viewport, index})`,
   `updateLayout(nameOrId, {name, sheet, printPalette})`, `removeLayout`,
   `reorderLayouts`, `parseScale("1:50")`. `sheet` is `"A3"` (landscape when
   creating, the current orientation when patching), `{ name: "A3",
   orientation: "portrait" }`, or `{ width, height }` in mm.
 - **Export**: `renderSvg`/`exportSvg`, `renderPng`/`exportPng`, `await toDxf()`/`exportDxf`,
   `toDwg`/`exportDwg` (DWG R2000–2018, default AC1027), `renderPdf`/`exportPdf`,
-  `toJson`/`save`
+  `toLinea`/`save`
 - **Import (merge)**: `importDxf(path)`/`importDxfText(text)` (with
   `unitOverride`), `importDwg(path)`/`importDwgData(bytes)` (DWG R13–R2018),
   `importPdfData(arrayBuffer)`
@@ -274,8 +295,12 @@ Full parameter docs are in the bundled `dist/index.d.ts` JSDoc.
 `hatch` (loops — outer + holes, even-odd; fill solid/pattern/lines) ·
 `text` (position, content; **default alignment center/center**; optional
 leaderLines with the arrowhead at index 0) · `dimension` (linear/angular/
-radial/diameter; `offset` is a vector from points[0] to the dimension line;
-linear with >2 points = chain) · `block` (instances of script definitions) ·
+radial/diameter; linear: `offset` is the signed distance of the dimension
+line from points[0] (left of the measuring direction positive) and
+`rotation` an optional locked measuring direction; angular: `offset` is the
+signed arc radius; `labels[i]` place and word each segment's text —
+`along`/`across` in mm, unset = automatic, `content` with `{value}` for the
+measurement; linear with >2 points = chain) · `block` (instances of script definitions) ·
 `viewport` (layouts only) · `image` (placement of an asset).
 
 ### Block scripts