@weasel-js/svg 1.11.0 → 1.11.1

package/README.md

@@ -183,6 +183,14 @@ writes a `kit:image` leaf back as an `SvgImageNode`.
 in (a non-`none` value warns) and written back as `none`, so a source file
 that relied on letterboxing imports stretched.
 
+## Writing XML by hand
+
+`escapeAttr(s)` and `escapeText(s)` are the escaping this package writes XML
+with, for a caller writing its own. Both drop the characters XML 1.0 cannot
+hold, even as references, and turn a vertical tab or form feed into a line
+break. `escapeAttr` also writes tabs and line breaks as references, since a
+parser reads a literal one in an attribute as a space.
+
 ## License
 
 MIT

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Affine } from '@weasel-js/geom';
+export { pathToD as serializePathD } from '@weasel-js/geom';
 import { Path, Paint, ScreenLength, StrokeAlign, MarkerRef, VertexWidth, StrokeNib, StyledRun, TextStyle, TextVerticalAlign, Fill, Stroke, PoseLinear, MarkerEntry, TextPoseLayout, RenderNeeds, TilePatternSpec, ImageNodeData, IngestCtx } from '@weasel-js/core';
 
 /**
@@ -441,18 +442,19 @@ declare function nativeSvgSpace(space: string | null | undefined): boolean;
 declare function serializeSvg(nodes: SvgNode[], opts?: SerializeOptions): string;
 
 /**
- * Serialize a weasel `Path` to an SVG `d=` attribute string. `RectPath`
- * lowers to `M h v h Z`; `PolygonPath` walks the (commands, coords)
- * arrays, emitting one SVG command per kit command, with corner shapes
- * expanded into the geometry they draw.
+ * Escaping for the XML this package writes by hand.
  *
- * Output uses absolute commands only and a small amount of whitespace
- * compression (no leading zeros stripped beyond what `Number.toString`
- * already does). Numbers are rounded to ~6 decimals via `trimNumber`.
+ * XML 1.0 cannot hold most C0 controls, U+FFFE, U+FFFF, or half a surrogate
+ * pair, even as character references, and a parser rejects the whole
+ * document over one. A vertical tab or form feed is a line break where text
+ * comes from (a word processor's clipboard), so those become `\n`; the rest
+ * are dropped.
  */
-
-/** Serialize a weasel `Path` to an SVG `d=` attribute string. */
-declare function serializePathD(given: Path): string;
+/** A parser turns a literal tab or line break in an attribute value into a
+ *  space, so those are written as character references. */
+declare function escapeAttr(s: string): string;
+/** A literal carriage return in content is read back as a newline. */
+declare function escapeText(s: string): string;
 
 /**
  * What `serializeSvg(nodes)` reads that loads on demand: the paint kind of
@@ -701,4 +703,4 @@ declare function svgNodesToKitDrafts<TData = Record<string, unknown>>(input: Par
  */
 declare function unpackSvgFiles(files: File[], ctx: IngestCtx): Promise<void>;
 
-export { DEFAULT_MEDIA_ENVIRONMENT, IDENTITY_MATRIX, type Matrix, type NamespaceMeta, type NamespacedElement, type ParseOptions, type ParseResult, type SerializeOptions, type SupportsOptions, type SvgDraftBounds, type SvgDraftPose, type SvgGroupNode, type SvgImageNode, type SvgKitLeafData, type SvgKitPose, type SvgKitTree, type SvgKitTreeNode, type SvgLeafNode, type SvgMediaEnvironment, type SvgNode, type SvgNodesFromKitOptions, type SvgNodesToKitDraftsOptions, type SvgPaint, type SvgPathNode, type SvgSceneDraft, type SvgStroke, type SvgTextNode, evaluateMediaQuery, evaluateSupports, fillDataFromSvg, nativeSvgKind, nativeSvgSpace, parseSvg, serializePathD, serializeSvg, strokeDataFromSvg, svgImageFromKit, svgLeafFromKit, svgNeeds, svgNodesFromKit, svgNodesToKitDrafts, svgPaintFromKit, svgStrokeFromKit, tilePreviewCssUrl, tilePreviewSvg, unpackSvgFiles, warmSvg };
+export { DEFAULT_MEDIA_ENVIRONMENT, IDENTITY_MATRIX, type Matrix, type NamespaceMeta, type NamespacedElement, type ParseOptions, type ParseResult, type SerializeOptions, type SupportsOptions, type SvgDraftBounds, type SvgDraftPose, type SvgGroupNode, type SvgImageNode, type SvgKitLeafData, type SvgKitPose, type SvgKitTree, type SvgKitTreeNode, type SvgLeafNode, type SvgMediaEnvironment, type SvgNode, type SvgNodesFromKitOptions, type SvgNodesToKitDraftsOptions, type SvgPaint, type SvgPathNode, type SvgSceneDraft, type SvgStroke, type SvgTextNode, escapeAttr, escapeText, evaluateMediaQuery, evaluateSupports, fillDataFromSvg, nativeSvgKind, nativeSvgSpace, parseSvg, serializeSvg, strokeDataFromSvg, svgImageFromKit, svgLeafFromKit, svgNeeds, svgNodesFromKit, svgNodesToKitDrafts, svgPaintFromKit, svgStrokeFromKit, tilePreviewCssUrl, tilePreviewSvg, unpackSvgFiles, warmSvg };

package/dist/index.js

@@ -1,5 +1,6 @@
-import { identity, multiply, invert, splitByClosure, fillsOpenSubpaths, rotateAboutPoint, hasOpenSubpath, splitSubpaths } from '@weasel-js/geom';
-import { resolveCorners, PATH_M, PATH_L, PATH_C, PATH_Q, PATH_Z, isTileKind, boundsOfPath, transformPath, isSolidPaint, warmFonts, warmPaintKinds, isPaintKindKnown, solid, fillToBoundsFrame, getMarker, registerMarker, dwarn, unionAABB, createInsertOp, fillInPoseFrame, pathThroughPoseFrame, DEFAULT_SHAPE_FILL, pathInPoseFrame, poseLinearOf, poseFrameOf, DEFAULT_TEXT_STYLE, resolveScreenLength, pathFromD, isPatternPaint, resolveTextStyle, strokeToPath, toRuns, resolveRunFace, parseColor, rgbaToHex, layoutRuns, resolveRuns, resolveAlign, PathBuilder, scaleVertexWidth, getPaintKind, resolveMarkerSize, paragraphDirection, scriptMetricsFor, vertexHalfWidths, isTilePaint, tileSpecOf } from '@weasel-js/core';
+import { identity, multiply, pathToD, invert, splitByClosure, fillsOpenSubpaths, rotateAboutPoint, hasOpenSubpath, splitSubpaths } from '@weasel-js/geom';
+export { pathToD as serializePathD } from '@weasel-js/geom';
+import { isTileKind, boundsOfPath, transformPath, isSolidPaint, warmFonts, warmPaintKinds, isPaintKindKnown, solid, fillToBoundsFrame, getMarker, registerMarker, dwarn, unionAABB, createInsertOp, fillInPoseFrame, pathThroughPoseFrame, DEFAULT_SHAPE_FILL, pathInPoseFrame, poseLinearOf, poseFrameOf, DEFAULT_TEXT_STYLE, resolveScreenLength, pathFromD, isPatternPaint, resolveTextStyle, strokeToPath, toRuns, resolveRunFace, parseColor, rgbaToHex, layoutRuns, resolveRuns, resolveAlign, PathBuilder, PATH_M, PATH_L, PATH_Z, scaleVertexWidth, getPaintKind, resolveMarkerSize, paragraphDirection, scriptMetricsFor, vertexHalfWidths, isTilePaint, tileSpecOf } from '@weasel-js/core';
 import { tileGeometry } from '@weasel-js/core/patterns-builtin';
 
 // src/types.ts
@@ -1383,40 +1384,6 @@ function readPattern(el, onWarn) {
   if (!isIdentity([m[0], m[1], m[2], m[3], 0, 0])) paint.transform = [m[0], m[1], m[2], m[3]];
   return paint;
 }
-function serializePathD(given) {
-  const path = resolveCorners(given);
-  if (path.kind === "rect") {
-    const { x, y, width: width2, height: height2 } = path;
-    return `M${trimNumber(x)} ${trimNumber(y)}h${trimNumber(width2)}v${trimNumber(height2)}h${trimNumber(-width2)}Z`;
-  }
-  const cmds = path.commands;
-  const xs = path.coords;
-  const out = [];
-  let ci = 0;
-  for (let i = 0; i < cmds.length; i++) {
-    const c = cmds[i];
-    if (c === PATH_M) {
-      out.push(`M${trimNumber(xs[ci])} ${trimNumber(xs[ci + 1])}`);
-      ci += 2;
-    } else if (c === PATH_L) {
-      out.push(`L${trimNumber(xs[ci])} ${trimNumber(xs[ci + 1])}`);
-      ci += 2;
-    } else if (c === PATH_C) {
-      out.push(
-        `C${trimNumber(xs[ci])} ${trimNumber(xs[ci + 1])} ${trimNumber(xs[ci + 2])} ${trimNumber(xs[ci + 3])} ${trimNumber(xs[ci + 4])} ${trimNumber(xs[ci + 5])}`
-      );
-      ci += 6;
-    } else if (c === PATH_Q) {
-      out.push(
-        `Q${trimNumber(xs[ci])} ${trimNumber(xs[ci + 1])} ${trimNumber(xs[ci + 2])} ${trimNumber(xs[ci + 3])}`
-      );
-      ci += 4;
-    } else if (c === PATH_Z) {
-      out.push("Z");
-    }
-  }
-  return out.join("");
-}
 
 // src/gradients.ts
 var WEASEL_NS = "urn:weasel-js:svg";
@@ -1722,7 +1689,7 @@ var PaintServerRegistry = class {
     }
     for (const path of this.clips) {
       parts.push(
-        `<clipPath id="${this.clipIds.get(path)}"><path d="${serializePathD(path)}"/></clipPath>`
+        `<clipPath id="${this.clipIds.get(path)}"><path d="${pathToD(path)}"/></clipPath>`
       );
     }
     parts.push("</defs>");
@@ -1736,7 +1703,7 @@ function defaultMarkerXml(id, entry, onWarn, key, size) {
   const name = key ?? id;
   const unit = size === void 0 ? 1 : resolveMarkerSize({ key: name, size }, 1);
   const path = entry.path({ size: unit, stroke: { paint: { kind: "solid", color: "#000" } } });
-  const d = serializePathD(path);
+  const d = pathToD(path);
   const fill = markerPaintAttrs("fill", entry.fill, id, onWarn);
   const outline = entry.outline ? ` ${markerPaintAttrs("stroke", entry.outline.paint, id, onWarn)} stroke-width="${trimNumber(entry.outline.width * unit)}" stroke-linecap="round" stroke-linejoin="round"` : "";
   const orient = typeof entry.orient === "number" ? trimNumber(entry.orient * 180 / Math.PI) : "auto-start-reverse";
@@ -2159,7 +2126,7 @@ function strokeOutlineXml(path, stroke, fillAttrs, transform) {
     ...stroke.markerEnd ? { markerEnd: stroke.markerEnd } : {}
   };
   const outline = strokeToPath(path, kit);
-  const attrs = [`d="${serializePathD(outline)}"`, ...fillAttrs, 'stroke="none"'];
+  const attrs = [`d="${pathToD(outline)}"`, ...fillAttrs, 'stroke="none"'];
   if (transform) attrs.push(transform);
   attrs.push(`${WEASEL_NS_PREFIX}:${ROLE}="${OUTLINE}"`);
   return `<path ${attrs.join(" ")}/>`;
@@ -2403,13 +2370,17 @@ var LineTracker = class {
     return Math.abs(lineHeight - DEFAULT_LINE_HEIGHT) < 1e-6 ? void 0 : lineHeight;
   }
 };
+var holdsOnlyText = (el) => !Array.from(el.childNodes).some(
+  (child) => child.nodeType === 1
+  /* ELEMENT_NODE */
+);
 function warnUnreadPositions(el, onWarn) {
   const tag = el.tagName.toLowerCase();
   for (const name of ["x", "y"]) {
     const raw = el.getAttribute(name)?.trim() ?? "";
     if (/[\s,]/.test(raw)) onWarn(`<${tag} ${name}="${raw}"> positions each glyph; only the first value is read`);
   }
-  for (const name of tag === "tspan" ? ["rotate"] : ["dx", "rotate"]) {
+  for (const name of tag === "tspan" || holdsOnlyText(el) ? ["rotate"] : ["dx", "rotate"]) {
     const raw = el.getAttribute(name)?.trim() ?? "";
     if (raw.split(/[\s,]+/).some((v) => parseFloat(v) !== 0 && v !== "")) {
       onWarn(`<${tag} ${name}="${raw}"> is not read; the glyphs keep their own advance and angle`);
@@ -2540,8 +2511,9 @@ function placeTspanRun(tspan, run, lines, inherited2, onWarn) {
     return 0;
   }
   const raw = tspan.getAttribute("dx");
+  const tag = tspan.tagName.toLowerCase();
   if (COLLAPSIBLE.test(run.text)) {
-    onWarn(`<tspan dx="${raw}"> is not read: its text has white space SVG collapses, which moves the glyphs the list names`);
+    onWarn(`<${tag} dx="${raw}"> is not read: its text has white space SVG collapses, which moves the glyphs the list names`);
     line.push(run);
     return 0;
   }
@@ -2554,7 +2526,7 @@ function placeTspanRun(tspan, run, lines, inherited2, onWarn) {
   } else if (dx[0] !== 0 && lines.length === 1) {
     lead = dx[0];
   } else if (dx[0] !== 0) {
-    onWarn(`<tspan dx="${raw}"> opens a line; the line starts at the box edge, and the rest of the list is read`);
+    onWarn(`<${tag} dx="${raw}"> opens a line; the line starts at the box edge, and the rest of the list is read`);
   }
   line.push(...spread(run, dx.slice(1), inherited2));
   return lead;
@@ -2716,7 +2688,10 @@ function readRuns(el, tracker, inheritedShift, letterSpacing, gradients, leafSty
   const push = (run) => {
     runLines[runLines.length - 1].push(run);
   };
-  for (let i = 0; i < el.childNodes.length; i++) {
+  if (holdsOnlyText(el) && el.hasAttribute("dx")) {
+    const t = el.textContent ?? "";
+    if (t) lead = placeTspanRun(el, { text: t, ...inheritedShift }, runLines, letterSpacing, onWarn);
+  } else for (let i = 0; i < el.childNodes.length; i++) {
     const child = el.childNodes[i];
     if (child.nodeType === 3) {
       const t = child.textContent ?? "";
@@ -3809,7 +3784,7 @@ function groupXml(node, registry, namespaces, warn, layoutOf) {
   return `${head}${body}${metaElementsXml(node.meta, namespaces)}</g>`;
 }
 function pathXml(node, registry, namespaces, warn) {
-  const attrs = [`d="${serializePathD(node.path)}"`];
+  const attrs = [`d="${pathToD(node.path)}"`];
   const fillAttrs = paintAttrs(node.fill, "fill", registry);
   for (const a of fillAttrs) attrs.push(a);
   if (node.path.kind === "polygon" && node.path.fillRule === "evenodd") {
@@ -4257,6 +4232,6 @@ function svgNodesFromKit(tree, options = {}) {
   return out;
 }
 
-export { DEFAULT_MEDIA_ENVIRONMENT, IDENTITY_MATRIX, evaluateMediaQuery, evaluateSupports, fillDataFromSvg, nativeSvgKind, nativeSvgSpace, parseSvg, serializePathD, serializeSvg, strokeDataFromSvg, svgImageFromKit, svgLeafFromKit, svgNeeds, svgNodesFromKit, svgNodesToKitDrafts, svgPaintFromKit, svgStrokeFromKit, tilePreviewCssUrl, tilePreviewSvg, unpackSvgFiles, warmSvg };
+export { DEFAULT_MEDIA_ENVIRONMENT, IDENTITY_MATRIX, escapeAttr, escapeText, evaluateMediaQuery, evaluateSupports, fillDataFromSvg, nativeSvgKind, nativeSvgSpace, parseSvg, serializeSvg, strokeDataFromSvg, svgImageFromKit, svgLeafFromKit, svgNeeds, svgNodesFromKit, svgNodesToKitDrafts, svgPaintFromKit, svgStrokeFromKit, tilePreviewCssUrl, tilePreviewSvg, unpackSvgFiles, warmSvg };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map