@remotion/paths 4.0.244 → 4.0.245

package/dist/evolve-path.d.ts

@@ -1,9 +1,3 @@
-/**
- * @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
- * @see [Documentation](https://remotion.dev/docs/paths/evolve-path)
- */
 export declare const evolvePath: (progress: number, path: string) => {
     strokeDasharray: string;
     strokeDashoffset: number;

package/dist/evolve-path.js

@@ -2,11 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.evolvePath = void 0;
 const get_length_1 = require("./get-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
- * @see [Documentation](https://remotion.dev/docs/paths/evolve-path)
+/*
+ * @description Animates an SVG path from being invisible to its full length.
+ * @see [Documentation](https://www.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 @@
-/**
- * @description Extends a viewbox in all directions by a scale factor.
- * @param {string} currentViewBox A valid SVG viewBox
- * @see [Documentation](https://remotion.dev/docs/paths/extend-viewbox)
- */
 export declare const extendViewBox: (currentViewBox: string, scale: number) => string;

package/dist/extend-viewbox.js

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

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

@@ -1,8 +1,3 @@
 import type { BoundingBox, ReducedInstruction } from './helpers/types';
 export declare const getBoundingBoxFromInstructions: (instructions: ReducedInstruction[]) => BoundingBox;
-/**
- * @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;

package/dist/get-bounding-box.js

@@ -153,9 +153,8 @@ const getBoundingBoxFromInstructions = (instructions) => {
     };
 };
 exports.getBoundingBoxFromInstructions = getBoundingBoxFromInstructions;
-/**
+/*
  * @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) => {

package/dist/get-instruction-index-at-length.d.ts

@@ -4,13 +4,5 @@ type InstructionAtLength = {
     lengthIntoInstruction: number;
 };
 export declare const getInstructionIndexAtLengthFromConstructed: (constructed: Constructed, fractionLength: number) => InstructionAtLength;
-/**
- * @description Gets the index of the instruction and the part length into the instruction at a specified length along an SVG path.
- * @see [Documentation](https://remotion.dev/docs/paths/get-instruction-index-at-length)
- * @param path The SVG path data as a string.
- * @param length The length along the path at which to find the instruction index and the part length into the instruction.
- * @returns {InstructionAtLength} Object containing the index of the instruction and the part length into the instruction at the given length.
- * @throws {Error} If the given length is less than 0 or greater than the total length of the path, or if the path is invalid.
- */
 export declare const getInstructionIndexAtLength: (path: string, length: number) => InstructionAtLength;
 export {};

package/dist/get-instruction-index-at-length.js

@@ -19,13 +19,9 @@ const getInstructionIndexAtLengthFromConstructed = (constructed, fractionLength)
     };
 };
 exports.getInstructionIndexAtLengthFromConstructed = getInstructionIndexAtLengthFromConstructed;
-/**
+/*
  * @description Gets the index of the instruction and the part length into the instruction at a specified length along an SVG path.
- * @see [Documentation](https://remotion.dev/docs/paths/get-instruction-index-at-length)
- * @param path The SVG path data as a string.
- * @param length The length along the path at which to find the instruction index and the part length into the instruction.
- * @returns {InstructionAtLength} Object containing the index of the instruction and the part length into the instruction at the given length.
- * @throws {Error} If the given length is less than 0 or greater than the total length of the path, or if the path is invalid.
+ * @see [Documentation](https://www.remotion.dev/docs/paths/get-instruction-index-at-length)
  */
 const getInstructionIndexAtLength = (path, length) => {
     const constructed = (0, construct_1.construct)(path);

package/dist/get-length.d.ts

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

package/dist/get-length.js

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

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

@@ -1,7 +1 @@
-/**
- * @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
- * @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

@@ -3,11 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPointAtLength = void 0;
 const get_instruction_index_at_length_1 = require("./get-instruction-index-at-length");
 const construct_1 = require("./helpers/construct");
-/**
+/*
  * @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
- * @see [Documentation](https://remotion.dev/docs/paths/get-point-at-length)
+ * @see [Documentation](https://www.remotion.dev/docs/paths/get-point-at-length)
  */
 const getPointAtLength = (path, length) => {
     const constructed = (0, construct_1.construct)(path);

package/dist/get-subpaths.d.ts

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

package/dist/get-subpaths.js

@@ -4,10 +4,9 @@ exports.getSubpaths = void 0;
 const construct_1 = require("./helpers/construct");
 const parse_path_1 = require("./parse-path");
 const serialize_instructions_1 = require("./serialize-instructions");
-/**
- * @description Splits a valid SVG path into it's parts.
- * @param {string} path A valid SVG path
- * @see [Documentation](https://remotion.dev/docs/paths/get-subpaths)
+/*
+ * @description Takes an SVG path and returns an array of subpaths, splitting the path by `M` and `m` statements.
+ * @see [Documentation](https://www.remotion.dev/docs/paths/get-subpaths)
  */
 const getSubpaths = (path) => {
     const parsed = (0, parse_path_1.parsePath)(path);

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

@@ -1,7 +1 @@
-/**
- * @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
- * @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

@@ -3,11 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTangentAtLength = void 0;
 const get_instruction_index_at_length_1 = require("./get-instruction-index-at-length");
 const construct_1 = require("./helpers/construct");
-/**
- * @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
- * @see [Documentation](https://remotion.dev/docs/paths/get-tangent-at-length)
+/*
+ * @description Gets tangent values x and y of a point which is on an SVG path.
+ * @see [Documentation](https://www.remotion.dev/docs/paths/get-tangent-at-length)
  */
 const getTangentAtLength = (path, length) => {
     const constructed = (0, construct_1.construct)(path);

package/dist/interpolate-path/interpolate-path.d.ts

@@ -1,8 +1 @@
-/**
- * @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
- * @see [Documentation](https://remotion.dev/docs/paths/interpolate-path)
- */
 export declare const interpolatePath: (value: number, firstPath: string, secondPath: string) => string;

package/dist/interpolate-path/interpolate-path.js

@@ -37,12 +37,9 @@ const parse_path_1 = require("../parse-path");
 const reduce_instructions_1 = require("../reduce-instructions");
 const serialize_instructions_1 = require("../serialize-instructions");
 const interpolate_instructions_1 = require("./interpolate-instructions");
-/**
- * @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
- * @see [Documentation](https://remotion.dev/docs/paths/interpolate-path)
+/*
+ * @description Interpolates between two SVG paths based on the provided value, transitioning from the first path to the second.
+ * @see [Documentation](https://www.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,9 +1,3 @@
 import type { AbsoluteInstruction, Instruction } from './helpers/types';
 export declare const normalizeInstructions: (instructions: Instruction[]) => AbsoluteInstruction[];
-/**
- * @description Removes all relative coordinates from an SVG path and converts them into absolute coordinates.
- * @see [Documentation](https://remotion.dev/docs/paths/normalize-path)
- * @param {string} path A valid SVG path
- * @returns {string} A string representation of the SVG path with absolute coordinates.
- */
 export declare const normalizePath: (path: string) => string;

package/dist/normalize-path.js

@@ -151,11 +151,9 @@ const normalizeInstructions = (instructions) => {
     return normalized;
 };
 exports.normalizeInstructions = normalizeInstructions;
-/**
- * @description Removes all relative coordinates from an SVG path and converts them into absolute coordinates.
- * @see [Documentation](https://remotion.dev/docs/paths/normalize-path)
- * @param {string} path A valid SVG path
- * @returns {string} A string representation of the SVG path with absolute coordinates.
+/*
+ * @description Removes all relative coordinates from a path and converts them into absolute coordinates.
+ * @see [Documentation](https://www.remotion.dev/docs/paths/normalize-path)
  */
 const normalizePath = (path) => {
     const instructions = (0, parse_path_1.parsePath)(path);

package/dist/parse-path.d.ts

@@ -1,8 +1,2 @@
 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

@@ -56,10 +56,8 @@ const parseValues = (args, instructionType) => {
     }
     return numbers.map(Number);
 };
-/**
+/*
  * @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) => {

package/dist/reduce-instructions.d.ts

@@ -1,7 +1,2 @@
 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,9 +3,8 @@ 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
+/*
+ * @description Takes an array of Instruction's and reduces the amount of instruction types so that the path only consists of M, L, C, and Z instructions.
  * @see [Documentation](https://www.remotion.dev/docs/paths/reduce-instructions)
  */
 const reduceInstructions = (instruction) => {

package/dist/reset-path.d.ts

@@ -1,6 +1 @@
-/**
- * @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,9 +3,8 @@ 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) => {

package/dist/reverse-path.d.ts

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

package/dist/reverse-path.js

@@ -82,10 +82,9 @@ function reverseNormalizedPath(instructions) {
     revstring = revstring.replace(/M M/g, 'Z M');
     return revstring;
 }
-/**
+/*
  * @description Reverses a path so the end and start are switched.
- * @param {string} path A valid SVG path
- * @see [Documentation](https://remotion.dev/docs/paths/reverse-path)
+ * @see [Documentation](https://www.remotion.dev/docs/paths/reverse-path)
  */
 const reversePath = (path) => {
     const parsed = (0, parse_path_1.parsePath)(path);

package/dist/scale-path.d.ts

@@ -1,10 +1 @@
-/**
- * @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,13 +6,8 @@ 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) => {

package/dist/translate-path.d.ts

@@ -1,11 +1,3 @@
 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,12 +102,8 @@ 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) => {

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

@@ -1,9 +1,4 @@
 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,9 +11,8 @@ 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
+/*
+ * @description Allows you to remap the coordinates of an SVG using a function in order to create a warp effect.
  * @see [Documentation](https://www.remotion.dev/docs/paths/warp-path)
  */
 const warpPath = (path, transformer, options) => {

package/package.json

@@ -3,7 +3,7 @@
     "url": "https://github.com/remotion-dev/remotion/tree/main/packages/paths"
   },
   "name": "@remotion/paths",
-  "version": "4.0.244",
+  "version": "4.0.245",
   "description": "Utilities for working with SVG paths",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,7 +21,7 @@
   ],
   "devDependencies": {
     "eslint": "9.14.0",
-    "@remotion/eslint-config-internal": "4.0.244"
+    "@remotion/eslint-config-internal": "4.0.245"
   },
   "exports": {
     "./package.json": "./package.json",