figma-metadata-extractor 1.0.3 → 1.0.4

package/dist/index.cjs

@@ -1374,7 +1374,8 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
     downloadImages = false,
     localPath,
     imageFormat = "png",
-    pngScale = 2
+    pngScale = 2,
+    useRelativePaths = true
   } = options;
   if (!apiKey && !oauthToken) {
     throw new Error("Either apiKey or oauthToken is required");
@@ -1432,7 +1433,7 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
           imageNodes,
           { pngScale: imageFormat === "png" ? pngScale : void 0 }
         );
-        result.nodes = enrichNodesWithImages(nodes, imageAssets, downloadResults);
+        result.nodes = enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths);
         Logger.log(`Successfully downloaded and enriched ${downloadResults.length} images`);
       }
     }
@@ -1556,18 +1557,26 @@ function hasImageFill(node, globalVars) {
   }
   return fillData.some((fill) => fill?.type === "IMAGE");
 }
-function enrichNodesWithImages(nodes, imageAssets, downloadResults) {
+function enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths = true) {
   const imageMap = /* @__PURE__ */ new Map();
   imageAssets.forEach((asset, index) => {
     const result = downloadResults[index];
     if (result) {
+      let pathForMarkup;
+      if (useRelativePaths === false) {
+        pathForMarkup = result.filePath;
+      } else if (typeof useRelativePaths === "string") {
+        pathForMarkup = result.filePath.replace(useRelativePaths, ".");
+      } else {
+        pathForMarkup = result.filePath.replace(process.cwd(), ".");
+      }
       imageMap.set(asset.id, {
         filePath: result.filePath,
-        relativePath: result.filePath.replace(process.cwd(), "."),
+        relativePath: pathForMarkup,
         dimensions: result.finalDimensions,
         wasCropped: result.wasCropped,
-        markdown: `![${asset.name}](${result.filePath.replace(process.cwd(), ".")})`,
-        html: `<img src="${result.filePath.replace(process.cwd(), ".")}" alt="${asset.name}" width="${result.finalDimensions.width}" height="${result.finalDimensions.height}">`
+        markdown: `![${asset.name}](${pathForMarkup})`,
+        html: `<img src="${pathForMarkup}" alt="${asset.name}" width="${result.finalDimensions.width}" height="${result.finalDimensions.height}">`
       });
     }
   });

package/dist/index.js

@@ -1372,7 +1372,8 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
     downloadImages = false,
     localPath,
     imageFormat = "png",
-    pngScale = 2
+    pngScale = 2,
+    useRelativePaths = true
   } = options;
   if (!apiKey && !oauthToken) {
     throw new Error("Either apiKey or oauthToken is required");
@@ -1430,7 +1431,7 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
           imageNodes,
           { pngScale: imageFormat === "png" ? pngScale : void 0 }
         );
-        result.nodes = enrichNodesWithImages(nodes, imageAssets, downloadResults);
+        result.nodes = enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths);
         Logger.log(`Successfully downloaded and enriched ${downloadResults.length} images`);
       }
     }
@@ -1554,18 +1555,26 @@ function hasImageFill(node, globalVars) {
   }
   return fillData.some((fill) => fill?.type === "IMAGE");
 }
-function enrichNodesWithImages(nodes, imageAssets, downloadResults) {
+function enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths = true) {
   const imageMap = /* @__PURE__ */ new Map();
   imageAssets.forEach((asset, index) => {
     const result = downloadResults[index];
     if (result) {
+      let pathForMarkup;
+      if (useRelativePaths === false) {
+        pathForMarkup = result.filePath;
+      } else if (typeof useRelativePaths === "string") {
+        pathForMarkup = result.filePath.replace(useRelativePaths, ".");
+      } else {
+        pathForMarkup = result.filePath.replace(process.cwd(), ".");
+      }
       imageMap.set(asset.id, {
         filePath: result.filePath,
-        relativePath: result.filePath.replace(process.cwd(), "."),
+        relativePath: pathForMarkup,
         dimensions: result.finalDimensions,
         wasCropped: result.wasCropped,
-        markdown: `![${asset.name}](${result.filePath.replace(process.cwd(), ".")})`,
-        html: `<img src="${result.filePath.replace(process.cwd(), ".")}" alt="${asset.name}" width="${result.finalDimensions.width}" height="${result.finalDimensions.height}">`
+        markdown: `![${asset.name}](${pathForMarkup})`,
+        html: `<img src="${pathForMarkup}" alt="${asset.name}" width="${result.finalDimensions.width}" height="${result.finalDimensions.height}">`
       });
     }
   });

package/dist/lib.d.ts

@@ -17,6 +17,13 @@ export interface FigmaMetadataOptions {
     imageFormat?: 'png' | 'svg';
     /** Export scale for PNG images (defaults to 2) */
     pngScale?: number;
+    /**
+     * Use relative paths in downloadedImage properties instead of absolute paths.
+     * If true, paths will be relative to process.cwd().
+     * If a string, paths will be relative to that base path.
+     * Default: true
+     */
+    useRelativePaths?: boolean | string;
 }
 export interface FigmaImageOptions {
     /** Export scale for PNG images (defaults to 2) */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "figma-metadata-extractor",
-    "version": "1.0.3",
+    "version": "1.0.4",
     "description": "Extract metadata and download images from Figma files. A standalone library for accessing Figma design data and downloading frame images programmatically.",
     "type": "module",
     "main": "dist/index.cjs",