@remotion/paths 3.3.54 → 3.3.56

package/dist/evolve-path.d.ts

@@ -1,8 +1,8 @@
 /**
- * Animates an SVG from being invisible to it's full length.
+ * @description Animates an SVG from being invisible to it's full length.
  * @param {string} path A valid SVG path
  * @param {number} progress The first valid SVG path
- * @link https://remotion.dev/docs/paths/evolve-path
+ * @see [Documentation](https://remotion.dev/docs/paths/evolve-path)
  */
 export declare const evolvePath: (progress: number, path: string) => {
     strokeDasharray: string;

package/dist/evolve-path.js

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.evolvePath = void 0;
 const get_length_1 = require("./get-length");
 /**
- * Animates an SVG from being invisible to it's full length.
+ * @description Animates an SVG from being invisible to it's full length.
  * @param {string} path A valid SVG path
  * @param {number} progress The first valid SVG path
- * @link https://remotion.dev/docs/paths/evolve-path
+ * @see [Documentation](https://remotion.dev/docs/paths/evolve-path)
  */
 const evolvePath = (progress, path) => {
     const length = (0, get_length_1.getLength)(path);

package/dist/extend-viewbox.d.ts

@@ -1,6 +1,6 @@
 /**
- * Extends a viewbox in all directions by a scale factor.
+ * @description Extends a viewbox in all directions by a scale factor.
  * @param {string} currentViewBox A valid SVG viewBox
- * @link https://remotion.dev/docs/paths/extend-viewbox
+ * @see [Documentation](https://remotion.dev/docs/paths/extend-viewbox)
  */
 export declare const extendViewBox: (currentViewBox: string, scale: number) => string;

package/dist/extend-viewbox.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extendViewBox = void 0;
 /**
- * Extends a viewbox in all directions by a scale factor.
+ * @description Extends a viewbox in all directions by a scale factor.
  * @param {string} currentViewBox A valid SVG viewBox
- * @link https://remotion.dev/docs/paths/extend-viewbox
+ * @see [Documentation](https://remotion.dev/docs/paths/extend-viewbox)
  */
 const extendViewBox = (currentViewBox, scale) => {
     const relativeScale = scale - 1;

package/dist/get-bounding-box.d.ts

@@ -1,3 +1,8 @@
 import type { BoundingBox, ReducedInstruction } from './helpers/types';
+/**
+ * @description Returns the bounding box of the given path, suitable for calculating the viewBox value that you need to pass to an SVG.
+ * @param {string} d
+ * @see [Documentation](https://www.remotion.dev/docs/paths/get-bounding-box)
+ */
 export declare const getBoundingBox: (d: string) => BoundingBox;
 export declare const getBoundingBoxFromInstructions: (instructions: ReducedInstruction[]) => BoundingBox;

package/dist/get-bounding-box.js

@@ -67,6 +67,11 @@ function minmaxC(A) {
     }
     return [min, max];
 }
+/**
+ * @description Returns the bounding box of the given path, suitable for calculating the viewBox value that you need to pass to an SVG.
+ * @param {string} d
+ * @see [Documentation](https://www.remotion.dev/docs/paths/get-bounding-box)
+ */
 const getBoundingBox = (d) => {
     const parsed = (0, parse_path_1.parsePath)(d);
     const unarced = (0, remove_a_s_t_curves_1.removeATSHVInstructions)((0, normalize_path_1.normalizeInstructions)(parsed));

package/dist/get-length.d.ts

@@ -1,6 +1,6 @@
 /**
- * Gets the length of an SVG path.
+ * @description Gets the length of an SVG path.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/get-length
+ * @see [Documentation](https://remotion.dev/docs/paths/get-length)
  */
 export declare const getLength: (path: string) => number;

package/dist/get-length.js

@@ -4,9 +4,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLength = void 0;
 const construct_1 = require("./helpers/construct");
 /**
- * Gets the length of an SVG path.
+ * @description Gets the length of an SVG path.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/get-length
+ * @see [Documentation](https://remotion.dev/docs/paths/get-length)
  */
 const getLength = (path) => {
     const constructucted = (0, construct_1.construct)(path);

package/dist/get-parts.d.ts

@@ -1,8 +1,8 @@
 import type { Part } from './helpers/types';
 /**
- * Splits a valid SVG path into it's parts.
+ * @description Splits a valid SVG path into it's parts.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/get-parts
+ * @see [Documentation](https://remotion.dev/docs/paths/get-parts)
  * @deprecated In favor of getSubpaths()
  */
 export declare const getParts: (path: string) => Part[];

package/dist/get-parts.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getParts = void 0;
 const construct_1 = require("./helpers/construct");
 /**
- * Splits a valid SVG path into it's parts.
+ * @description Splits a valid SVG path into it's parts.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/get-parts
+ * @see [Documentation](https://remotion.dev/docs/paths/get-parts)
  * @deprecated In favor of getSubpaths()
  */
 const getParts = (path) => {

package/dist/get-point-at-length.d.ts

@@ -1,7 +1,7 @@
 /**
- * Gets the coordinates of a point which is on an SVG path.
+ * @description Gets the coordinates of a point which is on an SVG path.
  * @param {string} path A valid SVG path
  * @param {number} length The length at which the point should be sampled
- * @link https://remotion.dev/docs/paths/get-point-at-length
- */
+ * @see [Documentation](https://remotion.dev/docs/paths/get-point-at-length)
+*/
 export declare const getPointAtLength: (path: string, length: number) => import("./helpers/types").Point;

package/dist/get-point-at-length.js

@@ -4,11 +4,11 @@ exports.getPointAtLength = void 0;
 const construct_1 = require("./helpers/construct");
 const get_part_at_length_1 = require("./helpers/get-part-at-length");
 /**
- * Gets the coordinates of a point which is on an SVG path.
+ * @description Gets the coordinates of a point which is on an SVG path.
  * @param {string} path A valid SVG path
  * @param {number} length The length at which the point should be sampled
- * @link https://remotion.dev/docs/paths/get-point-at-length
- */
+ * @see [Documentation](https://remotion.dev/docs/paths/get-point-at-length)
+*/
 const getPointAtLength = (path, length) => {
     const constructed = (0, construct_1.construct)(path);
     const fractionPart = (0, get_part_at_length_1.getPartAtLength)(path, length);

package/dist/get-subpaths.d.ts

@@ -1,6 +1,6 @@
 /**
- * Splits a valid SVG path into it's parts.
+ * @description Splits a valid SVG path into it's parts.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/get-subpaths
+ * @see [Documentation](https://remotion.dev/docs/paths/get-subpaths)
  */
 export declare const getSubpaths: (path: string) => string[];

package/dist/get-subpaths.js

@@ -4,9 +4,9 @@ exports.getSubpaths = void 0;
 const construct_1 = require("./helpers/construct");
 const serialize_instructions_1 = require("./serialize-instructions");
 /**
- * Splits a valid SVG path into it's parts.
+ * @description Splits a valid SVG path into it's parts.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/get-subpaths
+ * @see [Documentation](https://remotion.dev/docs/paths/get-subpaths)
  */
 const getSubpaths = (path) => {
     const { segments } = (0, construct_1.construct)(path);

package/dist/get-tangent-at-length.d.ts

@@ -1,7 +1,7 @@
 /**
- * Gets tangent values x and y of a point which is on an SVG path
+ * @description Gets tangent values x and y of a point which is on an SVG path
  * @param {string} path A valid SVG path
  * @param {number} length The length at which the tangent should be sampled
- * @link https://remotion.dev/docs/paths/get-tangent-at-length
+ * @see [Documentation](https://remotion.dev/docs/paths/get-tangent-at-length)
  */
 export declare const getTangentAtLength: (path: string, length: number) => import("./helpers/types").Point;

package/dist/get-tangent-at-length.js

@@ -4,10 +4,10 @@ exports.getTangentAtLength = void 0;
 const construct_1 = require("./helpers/construct");
 const get_part_at_length_1 = require("./helpers/get-part-at-length");
 /**
- * Gets tangent values x and y of a point which is on an SVG path
+ * @description Gets tangent values x and y of a point which is on an SVG path
  * @param {string} path A valid SVG path
  * @param {number} length The length at which the tangent should be sampled
- * @link https://remotion.dev/docs/paths/get-tangent-at-length
+ * @see [Documentation](https://remotion.dev/docs/paths/get-tangent-at-length)
  */
 const getTangentAtLength = (path, length) => {
     const constructed = (0, construct_1.construct)(path);

package/dist/interpolate-path.d.ts

@@ -1,8 +1,8 @@
 /**
- * Interpolates between two SVG paths.
+ * @description Interpolates between two SVG paths.
  * @param {number} value A number - 0 means first path, 1 means second path, any other values will be interpolated
  * @param {string} firstPath The first valid SVG path
  * @param {string} secondPath The second valid SVG path
- * @link https://remotion.dev/docs/paths/interpolate-path
+ * @see [Documentation](https://remotion.dev/docs/paths/interpolate-path)
  */
 export declare const interpolatePath: (value: number, firstPath: string, secondPath: string) => string;

package/dist/interpolate-path.js

@@ -332,11 +332,11 @@ function interpolatePathCommands(aCommandsInput, bCommandsInput) {
     };
 }
 /**
- * Interpolates between two SVG paths.
+ * @description Interpolates between two SVG paths.
  * @param {number} value A number - 0 means first path, 1 means second path, any other values will be interpolated
  * @param {string} firstPath The first valid SVG path
  * @param {string} secondPath The second valid SVG path
- * @link https://remotion.dev/docs/paths/interpolate-path
+ * @see [Documentation](https://remotion.dev/docs/paths/interpolate-path)
  */
 const interpolatePath = (value, firstPath, secondPath) => {
     // at 1 return the final value without the extensions used during interpolation

package/dist/normalize-path.d.ts

@@ -1,8 +1,8 @@
 import type { AbsoluteInstruction, Instruction } from './helpers/types';
 /**
- * Removes all relative coordinates from an SVG path and converts them into absolute coordinates.
+ * @description Removes all relative coordinates from an SVG path and converts them into absolute coordinates.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/normalize-path
+ * @see [Documentation](https://remotion.dev/docs/paths/normalize-path)
  */
 export declare const normalizePath: (path: string) => string;
 export declare const normalizeInstructions: (instructions: Instruction[]) => AbsoluteInstruction[];

package/dist/normalize-path.js

@@ -4,9 +4,9 @@ exports.normalizeInstructions = exports.normalizePath = void 0;
 const parse_path_1 = require("./parse-path");
 const serialize_instructions_1 = require("./serialize-instructions");
 /**
- * Removes all relative coordinates from an SVG path and converts them into absolute coordinates.
+ * @description Removes all relative coordinates from an SVG path and converts them into absolute coordinates.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/normalize-path
+ * @see [Documentation](https://remotion.dev/docs/paths/normalize-path)
  */
 const normalizePath = (path) => {
     const instructions = (0, parse_path_1.parsePath)(path);

package/dist/parse-path.d.ts

@@ -1,2 +1,8 @@
 import type { Instruction } from './helpers/types';
+/**
+ * @description Parses an SVG string path into an array of Instruction's.
+ * @param {string} path
+ * @returns an array of objects containing the Instructions
+ * @see [Documentation](https://www.remotion.dev/docs/paths/parse-path)
+ */
 export declare const parsePath: (path: string) => Instruction[];

package/dist/parse-path.js

@@ -42,6 +42,12 @@ const makeInstructions = (arr, instruction, cb) => {
 };
 const segmentRegExp = /([astvzqmhlc])([^astvzqmhlc]*)/gi;
 const numberRegExp = /-?[0-9]*\.?[0-9]+(?:e[-+]?\d+)?/gi;
+/**
+ * @description Parses an SVG string path into an array of Instruction's.
+ * @param {string} path
+ * @returns an array of objects containing the Instructions
+ * @see [Documentation](https://www.remotion.dev/docs/paths/parse-path)
+ */
 const parsePath = (path) => {
     if (!path) {
         throw new Error('No path provided');

package/dist/reduce-instructions.d.ts

@@ -1,2 +1,7 @@
 import type { Instruction, ReducedInstruction } from './helpers/types';
+/**
+ * @description Takes an array of Instruction's and reduces the amount of instruction types them so the path only consists of M, L, C, Q and Z instructions.
+ * @param {Array} instruction
+ * @see [Documentation](https://www.remotion.dev/docs/paths/reduce-instructions)
+ */
 export declare const reduceInstructions: (instruction: Instruction[]) => ReducedInstruction[];

package/dist/reduce-instructions.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.reduceInstructions = void 0;
 const remove_a_s_t_curves_1 = require("./helpers/remove-a-s-t-curves");
 const normalize_path_1 = require("./normalize-path");
+/**
+ * @description Takes an array of Instruction's and reduces the amount of instruction types them so the path only consists of M, L, C, Q and Z instructions.
+ * @param {Array} instruction
+ * @see [Documentation](https://www.remotion.dev/docs/paths/reduce-instructions)
+ */
 const reduceInstructions = (instruction) => {
     const simplified = (0, normalize_path_1.normalizeInstructions)(instruction);
     return (0, remove_a_s_t_curves_1.removeATSHVInstructions)(simplified);

package/dist/reset-path.d.ts

@@ -1 +1,6 @@
+/**
+ * @description Translates an SVG path so that the top-left corner of the bounding box is at 0, 0.
+ * @param {string} d a valid SVG path
+ * @see [Documentation](https://www.remotion.dev/docs/paths/reset-path)
+ */
 export declare const resetPath: (d: string) => string;

package/dist/reset-path.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.resetPath = void 0;
 const get_bounding_box_1 = require("./get-bounding-box");
 const translate_path_1 = require("./translate-path");
+/**
+ * @description Translates an SVG path so that the top-left corner of the bounding box is at 0, 0.
+ * @param {string} d a valid SVG path
+ * @see [Documentation](https://www.remotion.dev/docs/paths/reset-path)
+ */
 const resetPath = (d) => {
     const box = (0, get_bounding_box_1.getBoundingBox)(d);
     return (0, translate_path_1.translatePath)(d, -box.x1, -box.y1);

package/dist/reverse-path.d.ts

@@ -5,8 +5,8 @@
  * not recognise the public domain, where this code is MIT licensed.
  */
 /**
- * Reverses a path so the end and start are switched.
+ * @description Reverses a path so the end and start are switched.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/reverse-path
+ * @see [Documentation](https://remotion.dev/docs/paths/reverse-path)
  */
 export declare const reversePath: (path: string) => string;

package/dist/reverse-path.js

@@ -129,9 +129,9 @@ function reverseNormalizedPath(normalized) {
     return revstring;
 }
 /**
- * Reverses a path so the end and start are switched.
+ * @description Reverses a path so the end and start are switched.
  * @param {string} path A valid SVG path
- * @link https://remotion.dev/docs/paths/reverse-path
+ * @see [Documentation](https://remotion.dev/docs/paths/reverse-path)
  */
 const reversePath = (path) => {
     const normalizedPath = (0, normalize_path_1.normalizePath)(path);

package/dist/scale-path.d.ts

@@ -1 +1,10 @@
+/**
+ * @description Allows you to grow or shrink the size of a path.
+ * @param {string} path A valid SVG path
+ * @param {string} d
+ * @param {Number} scaleX
+ * @param {Number} scaleY
+ * @returns a new path with respect to the scale values provided
+ * @see [Documentation](https://www.remotion.dev/docs/paths/scale-path)
+ */
 export declare const scalePath: (d: string, scaleX: number, scaleY: number) => string;

package/dist/scale-path.js

@@ -6,6 +6,15 @@ const parse_path_1 = require("./parse-path");
 const reduce_instructions_1 = require("./reduce-instructions");
 const serialize_instructions_1 = require("./serialize-instructions");
 const translate_path_1 = require("./translate-path");
+/**
+ * @description Allows you to grow or shrink the size of a path.
+ * @param {string} path A valid SVG path
+ * @param {string} d
+ * @param {Number} scaleX
+ * @param {Number} scaleY
+ * @returns a new path with respect to the scale values provided
+ * @see [Documentation](https://www.remotion.dev/docs/paths/scale-path)
+ */
 const scalePath = (d, scaleX, scaleY) => {
     const reduced = (0, reduce_instructions_1.reduceInstructions)((0, parse_path_1.parsePath)(d));
     const bounded = (0, get_bounding_box_1.getBoundingBoxFromInstructions)(reduced);

package/dist/serialize-instructions.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serializeInstructions = void 0;
+/**
+ * @description Takes an array of Instruction's and serializes it into an SVG path string.
+ * @param {Array} instruction
+ * @returns a serialized SVG path string
+ * @see [Documentation](https://www.remotion.dev/docs/paths/serialize-instructions)
+ */
 const serializeInstruction = (instruction) => {
     if (instruction.type === 'A') {
         return `A ${instruction.rx} ${instruction.ry} ${instruction.xAxisRotation} ${Number(instruction.largeArcFlag)} ${Number(instruction.sweepFlag)} ${instruction.x} ${instruction.y}`;

package/dist/translate-path.d.ts

@@ -1,3 +1,11 @@
 import type { Instruction } from './helpers/types';
 export declare const translateSegments: (segments: Instruction[], x: number, y: number) => Instruction[];
+/**
+ * @description Translates the path by the given x and y coordinates.
+ * @param {string} path the originalSVG path
+ * @param {Number} x the amount of horizontal translation
+ * @param {Number} y the amount of vertical translation
+ * @returns a new string containing a path, if it is valid
+ * @see [Documentation](https://www.remotion.dev/docs/paths/translate-path)
+ */
 export declare const translatePath: (path: string, x: number, y: number) => string;

package/dist/translate-path.js

@@ -102,6 +102,14 @@ const translateSegments = (segments, x, y) => {
     });
 };
 exports.translateSegments = translateSegments;
+/**
+ * @description Translates the path by the given x and y coordinates.
+ * @param {string} path the originalSVG path
+ * @param {Number} x the amount of horizontal translation
+ * @param {Number} y the amount of vertical translation
+ * @returns a new string containing a path, if it is valid
+ * @see [Documentation](https://www.remotion.dev/docs/paths/translate-path)
+ */
 const translatePath = (path, x, y) => {
     return (0, serialize_instructions_1.serializeInstructions)((0, exports.translateSegments)((0, parse_path_1.parsePath)(path), x, y));
 };

package/dist/warp-path/index.d.ts

@@ -1,4 +1,9 @@
 import type { WarpPathFn } from './warp-helpers';
+/**
+ * @description This function works by splitting SVG instructions into many smaller SVG instructions and then remapping the coordinates of each instruction.
+ * @param {string} path an SVG path string
+ * @see [Documentation](https://www.remotion.dev/docs/paths/warp-path)
+ */
 export declare const warpPath: (path: string, transformer: WarpPathFn, options?: {
     interpolationThreshold?: number;
 }) => string;

package/dist/warp-path/index.js

@@ -11,6 +11,11 @@ const getDefaultInterpolationThreshold = (instructions) => {
     const longer = Math.max(boundingBox.y2 - boundingBox.y1, boundingBox.x2 - boundingBox.x1);
     return longer * 0.01;
 };
+/**
+ * @description This function works by splitting SVG instructions into many smaller SVG instructions and then remapping the coordinates of each instruction.
+ * @param {string} path an SVG path string
+ * @see [Documentation](https://www.remotion.dev/docs/paths/warp-path)
+ */
 const warpPath = (path, transformer, options) => {
     var _a;
     const reduced = (0, reduce_instructions_1.reduceInstructions)((0, parse_path_1.parsePath)(path));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/paths",
-	"version": "3.3.54",
+	"version": "3.3.56",
 	"description": "Utility functions for SVG paths",
 	"main": "dist/index.js",
 	"sideEffects": false,
@@ -35,5 +35,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "3a004e0b0e2a805fb276c35dd5922e3389c9f53c"
+	"gitHead": "40e96323b08717213c20fffcce8a985f0310f6e5"
 }

package/dist/helpers/parse.d.ts

@@ -1,2 +0,0 @@
-export declare type Instruction = [string, ...number[]];
-export declare const parsePath: (path: string) => Instruction[];

package/dist/helpers/parse.js

@@ -1,51 +0,0 @@
-"use strict";
-// Copied from: https://github.com/rveciana/svg-path-properties
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parsePath = void 0;
-const length = {
-    a: 7,
-    c: 6,
-    h: 1,
-    l: 2,
-    m: 2,
-    q: 4,
-    s: 4,
-    t: 2,
-    v: 1,
-    z: 0,
-};
-const segmentRegExp = /([astvzqmhlc])([^astvzqmhlc]*)/gi;
-const numberRegExp = /-?[0-9]*\.?[0-9]+(?:e[-+]?\d+)?/gi;
-const parsePath = (path) => {
-    const segments = (path && path.length > 0 ? path : 'M0,0').match(segmentRegExp);
-    if (!segments) {
-        throw new Error(`No path elements found in string ${path}`);
-    }
-    return segments.reduce((segmentsArray, segmentString) => {
-        let command = segmentString.charAt(0);
-        let type = command.toLowerCase();
-        const args = parseValues(segmentString.substr(1));
-        // overloaded moveTo
-        if (type === 'm' && args.length > 2) {
-            segmentsArray.push([command, ...args.splice(0, 2)]);
-            type = 'l';
-            command = command === 'm' ? 'l' : 'L';
-        }
-        while (args.length >= 0) {
-            if (args.length === length[type]) {
-                segmentsArray.push([command, ...args.splice(0, length[type])]);
-                break;
-            }
-            if (args.length < length[type]) {
-                throw new Error(`Malformed path data: "${command}" must have ${length[type]} elements and has ${args.length}: ${segmentString}`);
-            }
-            segmentsArray.push([command, ...args.splice(0, length[type])]);
-        }
-        return segmentsArray;
-    }, []);
-};
-exports.parsePath = parsePath;
-const parseValues = (args) => {
-    const numbers = args.match(numberRegExp);
-    return numbers ? numbers.map(Number) : [];
-};