remove xml helpers from standard import

Author: g-harel

README.md

@@ -83,8 +83,6 @@ const options = {
 If you need to edit the output svg for your use case, blobs also allows for _editable_ output.
 
 ```typescript
-import * as blobs from "blobs";
-
 const editableSvg = blobs.editable(options);
 ```
 
@@ -95,6 +93,17 @@ editableSvg.attributes.width = 1000;
 const svg = editableSvg.render();
 ```
 
+Utilities to create nodes in the editable output can be imported from `blobs/editable`.
+
+```typescript
+import {xml} from "blobs/editable";
+
+const xmlChild = xml("path");
+xmlChild.attributes.stroke = "red";
+// ...
+editableSvg.children.push(xmlChild);
+```
+
 ## License
 
 [MIT](./LICENSE)

internal/xml/index.ts renamed to editable/index.ts

@@ -5,7 +5,7 @@ import {Point} from "./internal/math/geometry";
 import {rad} from "./internal/math/unit";
 import {smooth} from "./internal/svg/smooth";
 import {renderEditable} from "./internal/svg/render";
-import {XmlElement} from "./internal/xml";
+import {XmlElement} from "./editable";
 
 export interface BlobOptions {
     // Bounding box dimensions.
@@ -37,12 +37,16 @@ export interface BlobOptions {
 
 // Generates an svg document string containing a randomized rounded shape.
 const blobs = (opt: BlobOptions): string => {
-    return editable(opt).render();
+    return blobs.editable(opt).render();
 };
 
 // Generates an editable data structure which can be rendered to an svg document
 // containing a randomized rounded shape.
-export const editable = (opt: BlobOptions): XmlElement => {
+blobs.editable = (opt: BlobOptions): XmlElement => {
+    if (!opt) {
+        throw new Error("no options specified");
+    }
+
     // Random number generator.
     const rgen = rand(opt.seed || String(Date.now()));
 
@@ -94,4 +98,3 @@ export const editable = (opt: BlobOptions): XmlElement => {
 };
 
 export default blobs;
-export {IXml, XmlElement} from "./internal/xml";

internal/xml/test.ts renamed to editable/test.ts

@@ -1,6 +1,6 @@
 import {loopAccess} from "./util";
 import {Point, interpolate} from "./point";
-import {xml, XmlElement} from "../xml";
+import {xml, XmlElement} from "../../editable";
 
 export interface RenderOptions {
     // Viewport size.

index.ts

@@ -1,4 +1,4 @@
-import blobs, {BlobOptions, editable} from "..";
+import blobs, {BlobOptions} from "..";
 
 const genMinimalOptions = (): BlobOptions => ({
     size: 1000 * Math.random(),
@@ -27,6 +27,10 @@ describe("blobs", () => {
         expect(a).toEqual(b);
     });
 
+    it("should require options be provided", () => {
+        expect(() => (blobs as any)()).toThrow("options");
+    });
+
     it("should require a size be provided", () => {
         const options = genMinimalOptions();
 
@@ -68,7 +72,7 @@ describe("editable", () => {
     it("should reflect changes when edited", () => {
         const options = genMinimalOptions();
 
-        const out = editable(options);
+        const out = blobs.editable(options);
         const initial = out.render();
         out.attributes.id = "test";
         const modified = out.render();