@remotion/paths 4.0.142 → 4.0.144

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

@@ -4,5 +4,13 @@ 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,6 +19,14 @@ 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.
+ */
 const getInstructionIndexAtLength = (path, length) => {
     const constructed = (0, construct_1.construct)(path);
     if (length > constructed.totalLength) {

package/dist/index.d.ts

@@ -17,3 +17,6 @@ export { scalePath } from './scale-path';
 export { serializeInstructions } from './serialize-instructions';
 export { translatePath } from './translate-path';
 export { WarpPathFn, warpPath } from './warp-path';
+export declare const PathInternals: {
+    getBoundingBoxFromInstructions: (instructions: import("./helpers/types").ReducedInstruction[]) => import("./helpers/types").BoundingBox;
+};

package/dist/index.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.warpPath = exports.translatePath = exports.serializeInstructions = exports.scalePath = exports.reversePath = exports.resetPath = exports.reduceInstructions = exports.parsePath = exports.normalizePath = exports.interpolatePath = exports.getTangentAtLength = exports.getSubpaths = exports.getPointAtLength = exports.getLength = exports.getInstructionIndexAtLength = exports.getBoundingBox = exports.extendViewBox = exports.evolvePath = void 0;
+exports.PathInternals = exports.warpPath = exports.translatePath = exports.serializeInstructions = exports.scalePath = exports.reversePath = exports.resetPath = exports.reduceInstructions = exports.parsePath = exports.normalizePath = exports.interpolatePath = exports.getTangentAtLength = exports.getSubpaths = exports.getPointAtLength = exports.getLength = exports.getInstructionIndexAtLength = exports.getBoundingBox = exports.extendViewBox = exports.evolvePath = void 0;
+const get_bounding_box_1 = require("./get-bounding-box");
 var evolve_path_1 = require("./evolve-path");
 Object.defineProperty(exports, "evolvePath", { enumerable: true, get: function () { return evolve_path_1.evolvePath; } });
 var extend_viewbox_1 = require("./extend-viewbox");
 Object.defineProperty(exports, "extendViewBox", { enumerable: true, get: function () { return extend_viewbox_1.extendViewBox; } });
-var get_bounding_box_1 = require("./get-bounding-box");
-Object.defineProperty(exports, "getBoundingBox", { enumerable: true, get: function () { return get_bounding_box_1.getBoundingBox; } });
+var get_bounding_box_2 = require("./get-bounding-box");
+Object.defineProperty(exports, "getBoundingBox", { enumerable: true, get: function () { return get_bounding_box_2.getBoundingBox; } });
 var get_instruction_index_at_length_1 = require("./get-instruction-index-at-length");
 Object.defineProperty(exports, "getInstructionIndexAtLength", { enumerable: true, get: function () { return get_instruction_index_at_length_1.getInstructionIndexAtLength; } });
 var get_length_1 = require("./get-length");
@@ -37,3 +38,6 @@ var translate_path_1 = require("./translate-path");
 Object.defineProperty(exports, "translatePath", { enumerable: true, get: function () { return translate_path_1.translatePath; } });
 var warp_path_1 = require("./warp-path");
 Object.defineProperty(exports, "warpPath", { enumerable: true, get: function () { return warp_path_1.warpPath; } });
+exports.PathInternals = {
+    getBoundingBoxFromInstructions: get_bounding_box_1.getBoundingBoxFromInstructions,
+};

package/dist/normalize-path.d.ts

@@ -2,7 +2,8 @@ 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.
- * @param {string} path A valid SVG path
  * @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

@@ -153,8 +153,9 @@ const normalizeInstructions = (instructions) => {
 exports.normalizeInstructions = normalizeInstructions;
 /**
  * @description Removes all relative coordinates from an SVG path and converts them into absolute coordinates.
- * @param {string} path A valid SVG path
  * @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.
  */
 const normalizePath = (path) => {
     const instructions = (0, parse_path_1.parsePath)(path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotion/paths",
-  "version": "4.0.142",
+  "version": "4.0.144",
   "description": "Utility functions for SVG paths",
   "main": "dist/index.js",
   "sideEffects": false,
@@ -17,8 +17,7 @@
     "@types/node": "18.14.6",
     "eslint": "8.56.0",
     "prettier": "3.2.5",
-    "prettier-plugin-organize-imports": "3.2.4",
-    "vitest": "0.31.1"
+    "prettier-plugin-organize-imports": "3.2.4"
   },
   "keywords": [
     "svg",
@@ -33,6 +32,6 @@
     "lint": "eslint src --ext ts,tsx",
     "watch": "tsc -w",
     "build": "tsc -d",
-    "test": "vitest --run"
+    "test": "bun test src"
   }
 }