figma-metadata-extractor 1.0.10 → 1.0.11

package/dist/index.cjs

@@ -1630,6 +1630,59 @@ async function downloadFigmaFrameImage(figmaUrl, options) {
     throw new Error(`Failed to download frame image: ${error instanceof Error ? error.message : String(error)}`);
   }
 }
+function getImageNodeInfo(metadata) {
+  if (!metadata.images || metadata.images.length === 0) {
+    return [];
+  }
+  const imageAssets = findImageAssets(metadata.nodes, metadata.globalVars);
+  return imageAssets.map((asset) => ({
+    nodeId: asset.id,
+    name: asset.name
+  }));
+}
+function enrichMetadataWithImages(metadata, imagePaths, options = {}) {
+  const { useRelativePaths = true, localPath } = options;
+  if (!metadata.images || metadata.images.length === 0) {
+    return metadata;
+  }
+  const imageAssets = findImageAssets(metadata.nodes, metadata.globalVars);
+  let downloadResults;
+  if (Array.isArray(imagePaths)) {
+    if (imagePaths.length !== metadata.images.length) {
+      throw new Error(`Number of image paths (${imagePaths.length}) must match number of images (${metadata.images.length})`);
+    }
+    downloadResults = imagePaths.map((filePath, index) => ({
+      filePath,
+      finalDimensions: metadata.images[index].finalDimensions,
+      wasCropped: metadata.images[index].wasCropped,
+      cssVariables: metadata.images[index].cssVariables
+    }));
+  } else {
+    downloadResults = imageAssets.map((asset) => {
+      const filePath = imagePaths[asset.id];
+      if (!filePath) {
+        throw new Error(`No image path provided for node ID: ${asset.id}`);
+      }
+      const imageMetadata = metadata.images.find((img) => img.nodeId === asset.id);
+      return {
+        filePath,
+        finalDimensions: imageMetadata?.finalDimensions || { width: 0, height: 0 },
+        wasCropped: imageMetadata?.wasCropped || false,
+        cssVariables: imageMetadata?.cssVariables
+      };
+    });
+  }
+  const enrichedNodes = enrichNodesWithImages(
+    metadata.nodes,
+    imageAssets,
+    downloadResults,
+    useRelativePaths
+  );
+  return {
+    ...metadata,
+    nodes: enrichedNodes
+  };
+}
 function sanitizeFileName(name) {
   return name.replace(/[^a-z0-9]/gi, "-").replace(/-+/g, "-").replace(/^-|-$/g, "").toLowerCase();
 }
@@ -1706,8 +1759,10 @@ exports.componentExtractor = componentExtractor;
 exports.contentOnly = contentOnly;
 exports.downloadFigmaFrameImage = downloadFigmaFrameImage;
 exports.downloadFigmaImages = downloadFigmaImages;
+exports.enrichMetadataWithImages = enrichMetadataWithImages;
 exports.extractFromDesign = extractFromDesign;
 exports.getFigmaMetadata = getFigmaMetadata;
+exports.getImageNodeInfo = getImageNodeInfo;
 exports.layoutAndText = layoutAndText;
 exports.layoutExtractor = layoutExtractor;
 exports.layoutOnly = layoutOnly;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { getFigmaMetadata, downloadFigmaImages, downloadFigmaFrameImage, type FigmaMetadataOptions, type FigmaImageOptions, type FigmaFrameImageOptions, type FigmaImageNode, type FigmaMetadataResult, type FigmaImageResult, } from "./lib.js";
+export { getFigmaMetadata, downloadFigmaImages, downloadFigmaFrameImage, enrichMetadataWithImages, getImageNodeInfo, type FigmaMetadataOptions, type FigmaImageOptions, type FigmaFrameImageOptions, type FigmaImageNode, type FigmaMetadataResult, type FigmaImageResult, } from "./lib.js";
 export type { SimplifiedDesign } from "./extractors/types.js";
 export type { ExtractorFn, TraversalContext, TraversalOptions, GlobalVars, StyleTypes, } from "./extractors/index.js";
 export { extractFromDesign, simplifyRawFigmaObject, layoutExtractor, textExtractor, visualsExtractor, componentExtractor, allExtractors, layoutAndText, contentOnly, visualsOnly, layoutOnly, collapseSvgContainers, } from "./extractors/index.js";

package/dist/index.js

@@ -1628,6 +1628,59 @@ async function downloadFigmaFrameImage(figmaUrl, options) {
     throw new Error(`Failed to download frame image: ${error instanceof Error ? error.message : String(error)}`);
   }
 }
+function getImageNodeInfo(metadata) {
+  if (!metadata.images || metadata.images.length === 0) {
+    return [];
+  }
+  const imageAssets = findImageAssets(metadata.nodes, metadata.globalVars);
+  return imageAssets.map((asset) => ({
+    nodeId: asset.id,
+    name: asset.name
+  }));
+}
+function enrichMetadataWithImages(metadata, imagePaths, options = {}) {
+  const { useRelativePaths = true, localPath } = options;
+  if (!metadata.images || metadata.images.length === 0) {
+    return metadata;
+  }
+  const imageAssets = findImageAssets(metadata.nodes, metadata.globalVars);
+  let downloadResults;
+  if (Array.isArray(imagePaths)) {
+    if (imagePaths.length !== metadata.images.length) {
+      throw new Error(`Number of image paths (${imagePaths.length}) must match number of images (${metadata.images.length})`);
+    }
+    downloadResults = imagePaths.map((filePath, index) => ({
+      filePath,
+      finalDimensions: metadata.images[index].finalDimensions,
+      wasCropped: metadata.images[index].wasCropped,
+      cssVariables: metadata.images[index].cssVariables
+    }));
+  } else {
+    downloadResults = imageAssets.map((asset) => {
+      const filePath = imagePaths[asset.id];
+      if (!filePath) {
+        throw new Error(`No image path provided for node ID: ${asset.id}`);
+      }
+      const imageMetadata = metadata.images.find((img) => img.nodeId === asset.id);
+      return {
+        filePath,
+        finalDimensions: imageMetadata?.finalDimensions || { width: 0, height: 0 },
+        wasCropped: imageMetadata?.wasCropped || false,
+        cssVariables: imageMetadata?.cssVariables
+      };
+    });
+  }
+  const enrichedNodes = enrichNodesWithImages(
+    metadata.nodes,
+    imageAssets,
+    downloadResults,
+    useRelativePaths
+  );
+  return {
+    ...metadata,
+    nodes: enrichedNodes
+  };
+}
 function sanitizeFileName(name) {
   return name.replace(/[^a-z0-9]/gi, "-").replace(/-+/g, "-").replace(/^-|-$/g, "").toLowerCase();
 }
@@ -1705,8 +1758,10 @@ export {
   contentOnly,
   downloadFigmaFrameImage,
   downloadFigmaImages,
+  enrichMetadataWithImages,
   extractFromDesign,
   getFigmaMetadata,
+  getImageNodeInfo,
   layoutAndText,
   layoutExtractor,
   layoutOnly,

package/package.json

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