@strategicprojects/rpic 0.6.2 → 0.7.0

package/README.md

@@ -9,7 +9,7 @@ import * as rpic from '@strategicprojects/rpic';
 
 await rpic.ready();                       // browser: wasm fetched automatically
 
-const { svg, animations, diagnostics, warnings } = rpic.compile('box "A"; arrow; box "B"');
+const { svg, animations, diagnostics, warnings, objects } = rpic.compile('box "A"; arrow; box "B"');
 document.querySelector('#stage').innerHTML = svg;
 
 // animate with GSAP:
@@ -52,7 +52,7 @@ first build. In Node, pass the math artifact's bytes:
 | Function | Description |
 |----------|-------------|
 | `ready(wasmInput?, {math?})` | Initialize WASM. Browser: no arg. Node: pass `.wasm` bytes/URL. `math: true` loads the math-enabled build; conflicting later calls reject. |
-| `compile(src, {circuits?, texlabels?})` | → `{ svg, animations, diagnostics, warnings }` (throws on a pic error with `errorInfo`). |
+| `compile(src, {circuits?, texlabels?})` | → `{ svg, animations, diagnostics, warnings, objects }` (throws on a pic error with `errorInfo`). |
 | `renderSvg(src, {circuits?, texlabels?})` | → SVG string. |
 | `animate(root, animations, gsap)` | Build/play a GSAP timeline (`draw`/`fade`/`pop`). Browser only. |
 

package/index.d.ts

@@ -26,6 +26,22 @@ export interface Diagnostic {
   hint: string | null;
 }
 
+export interface ObjectGeometry {
+  /** matches the shape's `<g id="sN">` group in the SVG */
+  id: string;
+  /** "box" | "circle" | "ellipse" | "path" | "spline" | "arc" | "brace" | "text" */
+  kind: string;
+  /** bounds in SVG user units (the viewBox space); `null` for invisible shapes */
+  bbox: { x: number; y: number; w: number; h: number } | null;
+  /** 1-based source position of the statement that drew it, when known */
+  line?: number;
+  col?: number;
+  /** exclusive end column of the statement's leading token */
+  end_col?: number;
+  /** absent = your own input; a `copy` include name or `"circuits"` otherwise */
+  file?: string;
+}
+
 export interface Bundle {
   svg: string;
   animations: Anim[];
@@ -33,6 +49,8 @@ export interface Bundle {
   diagnostics: string[];
   /** non-fatal compiler warnings for accepted but suspicious input */
   warnings: Diagnostic[];
+  /** per-object geometry, index-aligned with the `<g id="sN">` groups */
+  objects: ObjectGeometry[];
 }
 
 export interface CompileError extends Error {
@@ -75,7 +93,7 @@ export function ready(
   opts?: ReadyOptions
 ): Promise<void>;
 
-/** Compile pic source into `{ svg, animations, diagnostics, warnings }`. Throws on a pic error. */
+/** Compile pic source into `{ svg, animations, diagnostics, warnings, objects }`. Throws on a pic error. */
 export function compile(src: string, opts?: CompileOptions): Bundle;
 
 /** Compile and return only the SVG string. */

package/index.js

@@ -63,7 +63,7 @@ function ensure() {
 }
 
 /**
- * Compile pic source into `{ svg, animations, diagnostics, warnings }` (throws on a pic error).
+ * Compile pic source into `{ svg, animations, diagnostics, warnings, objects }` (throws on a pic error).
  * @param {string} src
  * @param {{circuits?: boolean, texlabels?: boolean}} [opts]
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strategicprojects/rpic",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "The pic graphics language compiled to SVG with animation manifests, via WebAssembly. Browser + Node.",
   "type": "module",
   "main": "./index.js",