figma-metadata-extractor 1.0.4 → 1.0.6

package/dist/index.cjs

@@ -124,6 +124,7 @@ function generateImageCSSVariables({
 }
 const Logger = {
   isHTTP: false,
+  enableLogging: false,
   log: (...args) => {
     if (Logger.isHTTP) {
       console.log("[INFO]", ...args);
@@ -136,6 +137,7 @@ const Logger = {
   }
 };
 function writeLogs(name, value) {
+  if (!Logger.enableLogging) return;
   if (process.env.NODE_ENV !== "development") return;
   try {
     const logsDir = "logs";
@@ -1375,8 +1377,10 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
     localPath,
     imageFormat = "png",
     pngScale = 2,
-    useRelativePaths = true
+    useRelativePaths = true,
+    enableLogging = false
   } = options;
+  Logger.enableLogging = enableLogging;
   if (!apiKey && !oauthToken) {
     throw new Error("Either apiKey or oauthToken is required");
   }
@@ -1433,7 +1437,7 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
           imageNodes,
           { pngScale: imageFormat === "png" ? pngScale : void 0 }
         );
-        result.nodes = enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths);
+        result.nodes = enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths, localPath);
         Logger.log(`Successfully downloaded and enriched ${downloadResults.length} images`);
       }
     }
@@ -1451,7 +1455,8 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
   }
 }
 async function downloadFigmaImages(figmaUrl, nodes, options) {
-  const { apiKey, oauthToken, useOAuth = false, pngScale = 2, localPath } = options;
+  const { apiKey, oauthToken, useOAuth = false, pngScale = 2, localPath, enableLogging = false } = options;
+  Logger.enableLogging = enableLogging;
   if (!apiKey && !oauthToken) {
     throw new Error("Either apiKey or oauthToken is required");
   }
@@ -1487,8 +1492,10 @@ async function downloadFigmaFrameImage(figmaUrl, options) {
     pngScale = 2,
     localPath,
     fileName,
-    format = "png"
+    format = "png",
+    enableLogging = false
   } = options;
+  Logger.enableLogging = enableLogging;
   if (!apiKey && !oauthToken) {
     throw new Error("Either apiKey or oauthToken is required");
   }
@@ -1557,7 +1564,7 @@ function hasImageFill(node, globalVars) {
   }
   return fillData.some((fill) => fill?.type === "IMAGE");
 }
-function enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths = true) {
+function enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths = true, localPath) {
   const imageMap = /* @__PURE__ */ new Map();
   imageAssets.forEach((asset, index) => {
     const result = downloadResults[index];
@@ -1566,9 +1573,17 @@ function enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativeP
       if (useRelativePaths === false) {
         pathForMarkup = result.filePath;
       } else if (typeof useRelativePaths === "string") {
-        pathForMarkup = result.filePath.replace(useRelativePaths, ".");
+        const basePath = useRelativePaths.endsWith("/") ? useRelativePaths : useRelativePaths + "/";
+        const normalizedFilePath = result.filePath.replace(/\\/g, "/");
+        const normalizedBasePath = basePath.replace(/\\/g, "/");
+        if (normalizedFilePath.startsWith(normalizedBasePath)) {
+          pathForMarkup = "./" + normalizedFilePath.substring(normalizedBasePath.length);
+        } else {
+          pathForMarkup = "./" + result.filePath.split(/[/\\]/).pop();
+        }
       } else {
-        pathForMarkup = result.filePath.replace(process.cwd(), ".");
+        const fileName = result.filePath.split(/[/\\]/).pop();
+        pathForMarkup = "./" + fileName;
       }
       imageMap.set(asset.id, {
         filePath: result.filePath,

package/dist/index.js

@@ -122,6 +122,7 @@ function generateImageCSSVariables({
 }
 const Logger = {
   isHTTP: false,
+  enableLogging: false,
   log: (...args) => {
     if (Logger.isHTTP) {
       console.log("[INFO]", ...args);
@@ -134,6 +135,7 @@ const Logger = {
   }
 };
 function writeLogs(name, value) {
+  if (!Logger.enableLogging) return;
   if (process.env.NODE_ENV !== "development") return;
   try {
     const logsDir = "logs";
@@ -1373,8 +1375,10 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
     localPath,
     imageFormat = "png",
     pngScale = 2,
-    useRelativePaths = true
+    useRelativePaths = true,
+    enableLogging = false
   } = options;
+  Logger.enableLogging = enableLogging;
   if (!apiKey && !oauthToken) {
     throw new Error("Either apiKey or oauthToken is required");
   }
@@ -1431,7 +1435,7 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
           imageNodes,
           { pngScale: imageFormat === "png" ? pngScale : void 0 }
         );
-        result.nodes = enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths);
+        result.nodes = enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths, localPath);
         Logger.log(`Successfully downloaded and enriched ${downloadResults.length} images`);
       }
     }
@@ -1449,7 +1453,8 @@ async function getFigmaMetadata(figmaUrl, options = {}) {
   }
 }
 async function downloadFigmaImages(figmaUrl, nodes, options) {
-  const { apiKey, oauthToken, useOAuth = false, pngScale = 2, localPath } = options;
+  const { apiKey, oauthToken, useOAuth = false, pngScale = 2, localPath, enableLogging = false } = options;
+  Logger.enableLogging = enableLogging;
   if (!apiKey && !oauthToken) {
     throw new Error("Either apiKey or oauthToken is required");
   }
@@ -1485,8 +1490,10 @@ async function downloadFigmaFrameImage(figmaUrl, options) {
     pngScale = 2,
     localPath,
     fileName,
-    format = "png"
+    format = "png",
+    enableLogging = false
   } = options;
+  Logger.enableLogging = enableLogging;
   if (!apiKey && !oauthToken) {
     throw new Error("Either apiKey or oauthToken is required");
   }
@@ -1555,7 +1562,7 @@ function hasImageFill(node, globalVars) {
   }
   return fillData.some((fill) => fill?.type === "IMAGE");
 }
-function enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths = true) {
+function enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativePaths = true, localPath) {
   const imageMap = /* @__PURE__ */ new Map();
   imageAssets.forEach((asset, index) => {
     const result = downloadResults[index];
@@ -1564,9 +1571,17 @@ function enrichNodesWithImages(nodes, imageAssets, downloadResults, useRelativeP
       if (useRelativePaths === false) {
         pathForMarkup = result.filePath;
       } else if (typeof useRelativePaths === "string") {
-        pathForMarkup = result.filePath.replace(useRelativePaths, ".");
+        const basePath = useRelativePaths.endsWith("/") ? useRelativePaths : useRelativePaths + "/";
+        const normalizedFilePath = result.filePath.replace(/\\/g, "/");
+        const normalizedBasePath = basePath.replace(/\\/g, "/");
+        if (normalizedFilePath.startsWith(normalizedBasePath)) {
+          pathForMarkup = "./" + normalizedFilePath.substring(normalizedBasePath.length);
+        } else {
+          pathForMarkup = "./" + result.filePath.split(/[/\\]/).pop();
+        }
       } else {
-        pathForMarkup = result.filePath.replace(process.cwd(), ".");
+        const fileName = result.filePath.split(/[/\\]/).pop();
+        pathForMarkup = "./" + fileName;
       }
       imageMap.set(asset.id, {
         filePath: result.filePath,

package/dist/lib.d.ts

@@ -18,12 +18,15 @@ export interface FigmaMetadataOptions {
     /** 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.
+     * Control how image paths are generated in downloadedImage properties.
+     * - true (default): Just the filename (e.g., "./icon.png")
+     * - false: Absolute file path (e.g., "/absolute/path/to/images/icon.png")
+     * - string: Strip this base path from file path (e.g., "/var/www" → "./images/icon.png")
      * Default: true
      */
     useRelativePaths?: boolean | string;
+    /** Enable JSON debug log files (defaults to false) */
+    enableLogging?: boolean;
 }
 export interface FigmaImageOptions {
     /** Export scale for PNG images (defaults to 2) */
@@ -76,6 +79,8 @@ export interface FigmaFrameImageOptions {
     fileName: string;
     /** Image format to download (defaults to 'png') */
     format?: 'png' | 'svg';
+    /** Enable JSON debug log files (defaults to false) */
+    enableLogging?: boolean;
 }
 /**
  * Extract metadata from a Figma file or specific nodes

package/dist/utils/logger.d.ts

@@ -1,5 +1,6 @@
 export declare const Logger: {
     isHTTP: boolean;
+    enableLogging: boolean;
     log: (...args: any[]) => void;
     error: (...args: any[]) => void;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "figma-metadata-extractor",
-    "version": "1.0.4",
+    "version": "1.0.6",
     "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",