@strategicprojects/rpic 0.1.1 → 0.3.0

package/README.md

@@ -1,15 +1,15 @@
 # rpic
 
 JS/TS bindings for [rpic](https://github.com/milkway/rpic-lang) — the pic
-graphics language compiled to **SVG** with an **animation manifest**, via
-WebAssembly. Works in the browser and in Node, ships TypeScript types.
+graphics language compiled to **SVG** with animation and diagnostic manifests,
+via WebAssembly. Works in the browser and in Node, ships TypeScript types.
 
 ```js
 import * as rpic from '@strategicprojects/rpic';
 
 await rpic.ready();                       // browser: wasm fetched automatically
 
-const { svg, animations } = rpic.compile('box "A"; arrow; box "B"');
+const { svg, animations, diagnostics } = rpic.compile('box "A"; arrow; box "B"');
 document.querySelector('#stage').innerHTML = svg;
 
 // animate with GSAP:
@@ -34,7 +34,7 @@ console.log(rpic.renderSvg('box "hi"'));
 | Function | Description |
 |----------|-------------|
 | `ready(wasmInput?)` | Initialize WASM. Browser: no arg. Node: pass `.wasm` bytes/URL. |
-| `compile(src, {circuits?})` | → `{ svg, animations }` (throws on a pic error). |
+| `compile(src, {circuits?})` | → `{ svg, animations, diagnostics }` (throws on a pic error). |
 | `renderSvg(src, {circuits?})` | → SVG string. |
 | `animate(root, animations, gsap)` | Build/play a GSAP timeline (`draw`/`fade`/`pop`). Browser only. |
 

package/index.d.ts

@@ -11,6 +11,8 @@ export interface Anim {
 export interface Bundle {
   svg: string;
   animations: Anim[];
+  /** lines emitted by pic `print` statements */
+  diagnostics: string[];
 }
 
 export interface CompileOptions {
@@ -24,7 +26,7 @@ export interface CompileOptions {
  */
 export function ready(wasmInput?: BufferSource | URL | string): Promise<void>;
 
-/** Compile pic source into `{ svg, animations }`. Throws on a pic error. */
+/** Compile pic source into `{ svg, animations, diagnostics }`. Throws on a pic error. */
 export function compile(src: string, opts?: CompileOptions): Bundle;
 
 /** Compile and return only the SVG string. */

package/index.js

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

package/package.json

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

package/pkg/rpic_wasm.d.ts

@@ -2,7 +2,8 @@
 /* eslint-disable */
 
 /**
- * Compile pic source to a JSON `{svg, animations}` bundle (or `{error}`).
+ * Compile pic source to a JSON `{svg, animations, diagnostics}` bundle (or
+ * `{error}`).
  */
 export function compile(src: string): string;
 

package/pkg/rpic_wasm.js

@@ -1,7 +1,8 @@
 /* @ts-self-types="./rpic_wasm.d.ts" */
 
 /**
- * Compile pic source to a JSON `{svg, animations}` bundle (or `{error}`).
+ * Compile pic source to a JSON `{svg, animations, diagnostics}` bundle (or
+ * `{error}`).
  * @param {string} src
  * @returns {string}
  */