svg-path-commander 0.1.25 → 0.2.0-alpha3

package/src/util/shapeToPath.js

@@ -17,8 +17,8 @@ const shapeParams = {
 /**
  * Returns a new `pathArray` from line attributes.
  *
- * @param {SVGPathCommander.lineAttr} attr shape configuration
- * @returns {SVGPathCommander.pathArray} a new line `pathArray`
+ * @param {SVGPath.lineAttr} attr shape configuration
+ * @returns {SVGPath.pathArray} a new line `pathArray`
  */
 export function getLinePath(attr) {
   const {
@@ -30,11 +30,11 @@ export function getLinePath(attr) {
 /**
  * Returns a new `pathArray` like from polyline/polygon attributes.
  *
- * @param {SVGPathCommander.polyAttr} attr shape configuration
- * @return {SVGPathCommander.pathArray} a new polygon/polyline `pathArray`
+ * @param {SVGPath.polyAttr} attr shape configuration
+ * @return {SVGPath.pathArray} a new polygon/polyline `pathArray`
  */
 export function getPolyPath(attr) {
-  /** @type {SVGPathCommander.pathArray} */
+  /** @type {SVGPath.pathArray} */
   // @ts-ignore -- it's an empty `pathArray`
   const pathArray = [];
   const points = attr.points.trim().split(/[\s|,]/).map(Number);
@@ -51,8 +51,8 @@ export function getPolyPath(attr) {
 /**
  * Returns a new `pathArray` from circle attributes.
  *
- * @param {SVGPathCommander.circleAttr} attr shape configuration
- * @return {SVGPathCommander.pathArray} a circle `pathArray`
+ * @param {SVGPath.circleAttr} attr shape configuration
+ * @return {SVGPath.pathArray} a circle `pathArray`
  */
 export function getCirclePath(attr) {
   const {
@@ -69,8 +69,8 @@ export function getCirclePath(attr) {
 /**
  * Returns a new `pathArray` from ellipse attributes.
  *
- * @param {SVGPathCommander.ellipseAttr} attr shape configuration
- * @return {SVGPathCommander.pathArray} an ellipse `pathArray`
+ * @param {SVGPath.ellipseAttr} attr shape configuration
+ * @return {SVGPath.pathArray} an ellipse `pathArray`
  */
 export function getEllipsePath(attr) {
   const {
@@ -87,8 +87,8 @@ export function getEllipsePath(attr) {
 /**
  * Returns a new `pathArray` like from rect attributes.
  *
- * @param {SVGPathCommander.rectAttr} attr object with properties above
- * @return {SVGPathCommander.pathArray} a new `pathArray` from `<rect>` attributes
+ * @param {SVGPath.rectAttr} attr object with properties above
+ * @return {SVGPath.pathArray} a new `pathArray` from `<rect>` attributes
  */
 export function getRectanglePath(attr) {
   const x = +attr.x || 0;
@@ -134,12 +134,12 @@ export function getRectanglePath(attr) {
  * is `true`, it will replace the target.
  *
  * It can also work with an options object,
- * @see SVGPathCommander.shapeOps
+ * @see SVGPath.shapeOps
  *
  * The newly created `<path>` element keeps all non-specific
  * attributes like `class`, `fill`, etc.
  *
- * @param {SVGPathCommander.shapeTypes | SVGPathCommander.shapeOps} element target shape
+ * @param {SVGPath.shapeTypes | SVGPath.shapeOps} element target shape
  * @param {boolean=} replace option to replace target
  * @return {SVGPathElement | boolean} the newly created `<path>` element
  */

package/src/util/util.js

@@ -6,7 +6,6 @@ import getPathLength from './getPathLength';
 import getTotalLength from './getTotalLength';
 import getDrawDirection from './getDrawDirection';
 import getPointAtLength from './getPointAtLength';
-import getPointAtPathLength from './getPointAtPathLength';
 
 import getPropertiesAtLength from './getPropertiesAtLength';
 import getPropertiesAtPoint from './getPropertiesAtPoint';
@@ -61,7 +60,6 @@ const Util = {
   getTotalLength,
   getPathLength,
   getPointAtLength,
-  getPointAtPathLength,
   getClosestPoint,
   getSegmentOfPoint,
   getPropertiesAtPoint,

package/types/index.d.ts

@@ -1,4 +1,4 @@
-export as namespace SVGPathCommander;
+export as namespace SVGPath;
 export default SVGPathCommander;
 
 // modules
@@ -51,7 +51,6 @@ export { default as splitCubic } from "svg-path-commander/src/process/splitCubic
 export { default as splitPath } from "svg-path-commander/src/process/splitPath";
 export { default as transformEllipse } from "svg-path-commander/src/process/transformEllipse";
 export { default as transformPath } from "svg-path-commander/src/process/transformPath";
-export { default as createPath } from "svg-path-commander/src/util/createPath";
 export { default as getCubicSize } from "svg-path-commander/src/util/getCubicSize";
 export { default as getDrawDirection } from "svg-path-commander/src/util/getDrawDirection";
 export { default as getPathArea } from "svg-path-commander/src/util/getPathArea";
@@ -63,7 +62,6 @@ export { default as segmentArcFactory } from "svg-path-commander/src/util/segmen
 export { default as segmentCubicFactory } from "svg-path-commander/src/util/segmentCubicFactory";
 export { default as segmentQuadFactory } from "svg-path-commander/src/util/segmentQuadFactory";
 export { default as getPointAtLength } from "svg-path-commander/src/util/getPointAtLength";
-export { default as getPointAtPathLength } from "svg-path-commander/src/util/getPointAtPathLength";
 export { default as getPropertiesAtPoint } from "svg-path-commander/src/util/getPropertiesAtPoint";
 export { default as getPropertiesAtLength } from "svg-path-commander/src/util/getPropertiesAtLength";
 export { default as getClosestPoint } from "svg-path-commander/src/util/getClosestPoint";

package/types/more/modules.ts

@@ -51,7 +51,6 @@ export { default as splitPath } from '../../src/process/splitPath';
 export { default as transformEllipse } from '../../src/process/transformEllipse';
 export { default as transformPath } from '../../src/process/transformPath';
 
-export { default as createPath } from '../../src/util/createPath';
 export { default as getCubicSize } from '../../src/util/getCubicSize';
 export { default as getDrawDirection } from '../../src/util/getDrawDirection';
 export { default as getPathArea } from '../../src/util/getPathArea';
@@ -66,8 +65,6 @@ export { default as segmentCubicFactory } from '../../src/util/segmentCubicFacto
 export { default as segmentQuadFactory } from '../../src/util/segmentQuadFactory';
 
 export { default as getPointAtLength } from '../../src/util/getPointAtLength';
-export { default as getPointAtPathLength } from '../../src/util/getPointAtPathLength';
-
 export { default as getPropertiesAtPoint } from '../../src/util/getPropertiesAtPoint';
 export { default as getPropertiesAtLength } from '../../src/util/getPropertiesAtLength';
 export { default as getClosestPoint } from '../../src/util/getClosestPoint';

package/types/more/svg.d.ts

@@ -106,7 +106,7 @@ export type polylineArray =   [MSegment, ...LSegment[]];
 
 export interface options {
   /** @default 4 */
-  round: boolean | number;
+  round: false | number;
   /** @default [0,0,0] */
   origin: number[];
 }
@@ -123,15 +123,16 @@ export interface pathTransformList {
 }
 
 export interface transformObject {
-  // translate?: number | [number, number, number];
-  // rotate?: number | [number, number, number];
-  // scale?: number | [number, number, number];
-  // skew?: number | [number, number];
-  translate?: number | number[];
-  rotate?: number | number[];
-  scale?: number | number[];
-  skew?: number | number[];
-  origin: number[];
+  translate?: number | [number, number, number];
+  rotate?: number | [number, number, number];
+  scale?: number | [number, number, number];
+  skew?: number | [number, number];
+  origin?: [number, number, number?];
+  // translate?: number | number[];
+  // rotate?: number | number[];
+  // scale?: number | number[];
+  // skew?: number | number[];
+  // origin?: number[];
 }
 
 export type shapeTypes = SVGPolylineElement | SVGPolygonElement | SVGLineElement | SVGEllipseElement | SVGCircleElement | SVGRectElement;