expose XmlElement interface in v1 + rename canvas api in v2

Author: g-harel

README.legacy.md

@@ -76,7 +76,7 @@ editableSvg.attributes.width = 1000;
 const svg = editableSvg.render();
 ```
 
-Utilities to create nodes in the editable output can be imported from `blobs/editable`.
+New elements can be added anywhere in the hierarchy.
 
 ```typescript
 const xmlChild = blobs.xml("path");

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <a href="https://github.com/g-harel/blobs/README.legacy.md"><b>Legacy documentation</b></a>
+    <a href="https://github.com/g-harel/blobs/blob/master/README.legacy.md"><b>Legacy documentation</b></a>
 </p>
 
 <br>
@@ -61,7 +61,7 @@ container.innerHTML = svgString;
 ## Canvas
 
 ```js
-const path = blobs2.canvas(
+const path = blobs2.canvasPath(
     {
         seed: Date.now(),
         extraPoints: 16,
@@ -100,7 +100,7 @@ export interface SvgOptions {
     stroke?: string; // Default: "none".
     strokeWidth?: number; // Default: 0.
 }
-export const canvas: (blobOptions: BlobOptions, canvasOptions?: CanvasOptions) => Path2D;
+export const canvasPath: (blobOptions: BlobOptions, canvasOptions?: CanvasOptions) => Path2D;
 export const svg: (blobOptions: BlobOptions, svgOptions?: SvgOptions) => string;
 export const svgPath: (blobOptions: BlobOptions) => string;
 ```

internal/animate/testing/script.ts

@@ -180,7 +180,7 @@ const testGen = () => {
         for (let j = 0; j < cellSideCount; j++) {
             ctx.strokeRect(i * cellSize, j * cellSize, cellSize, cellSize);
             ctx.fill(
-                blobs2.canvas(
+                blobs2.canvasPath(
                     {
                         extraPoints: j,
                         randomness: i,

public/blobs.ts

@@ -63,7 +63,7 @@ const raw = (blobOptions: BlobOptions): Point[] => {
     });
 };
 
-export const canvas = (blobOptions: BlobOptions, canvasOptions: CanvasOptions = {}): Path2D => {
+export const canvasPath = (blobOptions: BlobOptions, canvasOptions: CanvasOptions = {}): Path2D => {
     return renderPath2D(
         mapPoints(raw(blobOptions), ({curr}) => {
             curr.x += canvasOptions.offsetX || 0;

public/legacy.ts

@@ -1,5 +1,5 @@
 import {rand} from "../internal/rand";
-import {renderEditable, XmlElement} from "../internal/render/svg";
+import {renderEditable, XmlElement as InternalXmlElement} from "../internal/render/svg";
 import {genBlob} from "../internal/gen";
 import {mapPoints} from "../internal/util";
 
@@ -100,7 +100,14 @@ blobs.editable = (options: BlobOptions): XmlElement => {
     });
 };
 
+export interface XmlElement {
+    tag: string;
+    attributes: Record<string, string | number>;
+    children: XmlElement[];
+    render(): string;
+}
+
 // Shortcut to create an XmlElement without "new";
-blobs.xml = (tag: string) => new XmlElement(tag);
+blobs.xml = (tag: string): XmlElement => new InternalXmlElement(tag);
 
 export default blobs;