-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfigmaextractor.go
More file actions
458 lines (402 loc) · 13.2 KB
/
figmaextractor.go
File metadata and controls
458 lines (402 loc) · 13.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
package figmaextractor
import (
"fmt"
"os"
"path/filepath"
"strconv"
"strings"
"github.com/hellenic-development/figma-extractor/pkg/extractor"
"github.com/hellenic-development/figma-extractor/pkg/figma"
"github.com/hellenic-development/figma-extractor/pkg/formatter"
"github.com/hellenic-development/figma-extractor/pkg/imager"
)
// Options configures the extraction.
type Options struct {
AccessToken string
FileURL string // Figma file URL
NodeIDs []string // empty = entire file
InheritFileContext bool
ExportImages bool
ImageFormat string // "png", "svg", "jpg", "pdf"
ImageScales []float64
ImageDir string
ComponentTree bool
Logger Logger // nil = no logging
}
// Logger receives progress messages. A nil Logger means silent operation.
type Logger interface {
Infof(format string, args ...any)
Warnf(format string, args ...any)
Errorf(format string, args ...any)
}
// Result contains the extraction output.
type Result struct {
Specs *extractor.DesignSpecs
FileName string // Figma file name
Markdown string // formatted markdown output
}
func (o *Options) logInfo(f string, a ...any) {
if o.Logger != nil {
o.Logger.Infof(f, a...)
}
}
func (o *Options) logWarn(f string, a ...any) {
if o.Logger != nil {
o.Logger.Warnf(f, a...)
}
}
func (o *Options) logError(f string, a ...any) {
if o.Logger != nil {
o.Logger.Errorf(f, a...)
}
}
// Run executes the Figma extraction pipeline and returns the result.
func Run(opts Options) (*Result, error) {
// Apply defaults.
if opts.ImageFormat == "" {
opts.ImageFormat = "png"
}
if opts.ImageDir == "" {
opts.ImageDir = "figma-assets"
}
if len(opts.ImageScales) == 0 {
opts.ImageScales = []float64{1}
}
// Extract file key from URL.
opts.logInfo("Extracting file key from URL...")
fileKey, err := figma.ExtractFileKey(opts.FileURL)
if err != nil {
return nil, fmt.Errorf("extract file key: %w", err)
}
opts.logInfo("File key: %s", fileKey)
// Extract node IDs from URL or merge with explicit ones.
var targetNodeIDs []string
if len(opts.NodeIDs) > 0 {
opts.logInfo("Using %d explicit node ID(s)", len(opts.NodeIDs))
targetNodeIDs = opts.NodeIDs
} else {
opts.logInfo("Checking URL for node IDs...")
urlNodeIDs, err := figma.ExtractNodeIDs(opts.FileURL)
if err != nil {
return nil, fmt.Errorf("extract node IDs from URL: %w", err)
}
if len(urlNodeIDs) > 0 {
targetNodeIDs = urlNodeIDs
opts.logInfo("Found %d node(s) in URL", len(targetNodeIDs))
} else {
opts.logInfo("No node IDs found, will extract entire file")
}
}
// Create Figma client.
opts.logInfo("Authenticating with Figma API...")
client := figma.NewClient(opts.AccessToken)
var specs *extractor.DesignSpecs
var fileName string
var fileResp *figma.FileResponse
var nodesResp *figma.NodesResponse
// Choose extraction strategy based on whether node IDs are provided.
if len(targetNodeIDs) > 0 {
opts.logInfo("Extracting %d specific node(s)...", len(targetNodeIDs))
opts.logInfo("Fetching nodes from Figma...")
nodesResp, err = client.GetFileNodes(fileKey, targetNodeIDs)
if err != nil {
return nil, fmt.Errorf("fetch nodes: %w", err)
}
opts.logInfo("Retrieved %d node(s)", len(nodesResp.Nodes))
opts.logInfo("Fetching file metadata...")
fileResp, err = client.GetFile(fileKey)
if err != nil {
return nil, fmt.Errorf("fetch file metadata: %w", err)
}
opts.logInfo("File: %s", fileResp.Name)
fileName = fileResp.Name
opts.logInfo("Extracting design specifications from nodes...")
specs = extractor.ExtractNodes(fileResp, nodesResp, targetNodeIDs, opts.InheritFileContext)
} else {
opts.logInfo("Extracting entire file...")
opts.logInfo("Fetching file data from Figma...")
fileResp, err = client.GetFile(fileKey)
if err != nil {
return nil, fmt.Errorf("fetch file: %w", err)
}
opts.logInfo("File: %s", fileResp.Name)
fileName = fileResp.Name
opts.logInfo("Extracting design specifications...")
specs = extractor.Extract(fileResp)
}
// Image export (opt-in).
if opts.ExportImages {
if err := exportImages(&opts, client, fileKey, specs, fileResp, nodesResp, targetNodeIDs); err != nil {
return nil, err
}
}
// Component tree is opt-in.
if opts.ComponentTree {
extractor.AttachAssetsToNodeTree(specs.NodeTree, specs.ExportedAssets)
} else {
specs.NodeTree = nil
}
// Format as markdown.
opts.logInfo("Generating markdown documentation...")
markdown := formatter.ToMarkdown(specs, fileName, opts.ImageDir)
return &Result{
Specs: specs,
FileName: fileName,
Markdown: markdown,
}, nil
}
// exportImages handles the full image export pipeline: screenshot, ExportSettings nodes,
// IMAGE fills, render fallback, and deduplication.
func exportImages(opts *Options, client *figma.Client, fileKey string, specs *extractor.DesignSpecs, fileResp *figma.FileResponse, nodesResp *figma.NodesResponse, targetNodeIDs []string) error {
// Validate format.
validFormats := map[string]bool{"png": true, "svg": true, "jpg": true, "pdf": true}
if !validFormats[opts.ImageFormat] {
return fmt.Errorf("invalid image format %q (must be png, svg, jpg, or pdf)", opts.ImageFormat)
}
// Validate scales.
for _, s := range opts.ImageScales {
if s <= 0 {
return fmt.Errorf("scale value must be positive, got %g", s)
}
}
config := imager.ExportConfig{
Format: opts.ImageFormat,
Scales: opts.ImageScales,
OutputDir: opts.ImageDir,
}
// Screenshot: render the target node(s) (or full document) as a complete design screenshot.
screenshotName := "complete_design_screenshot." + config.Format
screenshotNodes := make(map[string]string) // nodeID -> nodeName
if len(targetNodeIDs) > 0 {
for _, id := range targetNodeIDs {
if nd, ok := nodesResp.Nodes[id]; ok {
screenshotNodes[id] = nd.Document.Name
for _, child := range nd.Document.Children {
screenshotNodes[child.ID] = child.Name
}
}
}
} else {
screenshotNodes[fileResp.Document.ID] = fileResp.Document.Name
for _, child := range fileResp.Document.Children {
screenshotNodes[child.ID] = child.Name
}
}
opts.logInfo("Capturing design screenshot to %s...", screenshotName)
screenshotResult, err := imager.ExportImages(client, fileKey, screenshotNodes, imager.ExportConfig{
Format: config.Format,
Scales: []float64{1},
OutputDir: config.OutputDir,
})
if err != nil {
opts.logWarn("Screenshot failed: %v", err)
} else {
for _, asset := range screenshotResult.Assets {
oldPath := filepath.Join(config.OutputDir, asset.FileName)
newPath := filepath.Join(config.OutputDir, screenshotName)
if err := os.Rename(oldPath, newPath); err != nil {
opts.logWarn("Could not rename screenshot: %v", err)
specs.ExportedAssets = append(specs.ExportedAssets, extractor.ExportedAssetInfo{
NodeID: asset.NodeID,
NodeName: asset.NodeName,
FileName: asset.FileName,
Format: asset.Format,
Scale: asset.Scale,
IsScreenshot: true,
})
} else {
specs.ExportedAssets = append(specs.ExportedAssets, extractor.ExportedAssetInfo{
NodeID: asset.NodeID,
NodeName: asset.NodeName,
FileName: screenshotName,
Format: asset.Format,
Scale: asset.Scale,
IsScreenshot: true,
})
}
}
}
// Phase 1: Collect and export nodes with ExportSettings via render API.
exportNodes := make(map[string]string)
if len(targetNodeIDs) > 0 {
opts.logInfo("Discovering exportable child nodes...")
for _, id := range targetNodeIDs {
if nd, ok := nodesResp.Nodes[id]; ok {
childExport := imager.CollectExportableNodes(&nd.Document)
for cID, cName := range childExport {
if _, isRoot := screenshotNodes[cID]; isRoot {
continue
}
exportNodes[cID] = cName
}
}
}
if len(exportNodes) == 0 {
opts.logInfo("No additional exportable child nodes")
} else {
opts.logInfo("Found %d exportable child node(s)", len(exportNodes))
}
} else {
opts.logInfo("Discovering exportable nodes...")
exportNodes = imager.CollectExportableNodes(&fileResp.Document)
delete(exportNodes, fileResp.Document.ID)
if len(exportNodes) == 0 {
opts.logInfo("No additional exportable nodes")
} else {
opts.logInfo("Found %d exportable node(s)", len(exportNodes))
}
}
if len(exportNodes) > 0 {
opts.logInfo("Exporting rendered images to %s...", opts.ImageDir)
result, err := imager.ExportImages(client, fileKey, exportNodes, config)
if err != nil {
return fmt.Errorf("export images: %w", err)
}
opts.logInfo("Exported %d image(s)", len(result.Assets))
for _, dlErr := range result.Errors {
opts.logWarn("%v", dlErr)
}
for _, asset := range result.Assets {
specs.ExportedAssets = append(specs.ExportedAssets, extractor.ExportedAssetInfo{
NodeID: asset.NodeID,
NodeName: asset.NodeName,
FileName: asset.FileName,
Format: asset.Format,
Scale: asset.Scale,
})
}
}
// Phase 2: Collect and export embedded IMAGE fill nodes via file images API.
var roots []*figma.Node
if len(targetNodeIDs) > 0 {
for _, id := range targetNodeIDs {
if nd, ok := nodesResp.Nodes[id]; ok {
doc := nd.Document // copy
roots = append(roots, &doc)
}
}
} else {
roots = append(roots, &fileResp.Document)
}
var allImageFills []imager.ImageFillNode
for _, root := range roots {
for _, fill := range imager.CollectImageFillNodes(root) {
if _, isScreenshot := screenshotNodes[fill.NodeID]; isScreenshot {
continue
}
allImageFills = append(allImageFills, fill)
}
}
if len(allImageFills) > 0 {
opts.logInfo("Found %d embedded image(s), fetching download URLs...", len(allImageFills))
var unresolvedNodes []imager.ImageFillNode
fileImagesResp, err := client.GetFileImages(fileKey)
if err != nil {
opts.logWarn("File images API failed: %v", err)
unresolvedNodes = allImageFills
} else {
opts.logInfo("Downloading embedded images to %s...", opts.ImageDir)
fillResult, err := imager.ExportImageFills(fileImagesResp, allImageFills, config)
if err != nil {
return fmt.Errorf("export image fills: %w", err)
}
if len(fillResult.Assets) > 0 {
opts.logInfo("Exported %d embedded image(s)", len(fillResult.Assets))
}
for _, dlErr := range fillResult.Errors {
opts.logWarn("%v", dlErr)
}
for _, asset := range fillResult.Assets {
specs.ExportedAssets = append(specs.ExportedAssets, extractor.ExportedAssetInfo{
NodeID: asset.NodeID,
NodeName: asset.NodeName,
FileName: asset.FileName,
Format: asset.Format,
Scale: asset.Scale,
})
}
unresolvedNodes = fillResult.UnresolvedNodes
}
// Fallback: render unresolved IMAGE fill nodes via the render API.
if len(unresolvedNodes) > 0 {
opts.logInfo("Rendering %d image(s) via render API (no file image URLs)...", len(unresolvedNodes))
renderNodes := imager.ImageFillNodesToMap(unresolvedNodes)
for id := range screenshotNodes {
delete(renderNodes, id)
}
renderResult, err := imager.ExportImages(client, fileKey, renderNodes, config)
if err != nil {
opts.logError("Rendering images failed: %v", err)
// Non-fatal: continue.
} else {
opts.logInfo("Rendered %d image(s)", len(renderResult.Assets))
for _, dlErr := range renderResult.Errors {
opts.logWarn("%v", dlErr)
}
for _, asset := range renderResult.Assets {
specs.ExportedAssets = append(specs.ExportedAssets, extractor.ExportedAssetInfo{
NodeID: asset.NodeID,
NodeName: asset.NodeName,
FileName: asset.FileName,
Format: asset.Format,
Scale: asset.Scale,
})
}
}
}
}
// Remove non-screenshot assets that duplicate a screenshot node.
if len(screenshotNodes) > 0 {
excludeIDs := make(map[string]bool, len(screenshotNodes))
excludeNames := make(map[string]bool, len(screenshotNodes))
for id, name := range screenshotNodes {
excludeIDs[id] = true
excludeNames[name] = true
}
filtered := specs.ExportedAssets[:0]
for _, a := range specs.ExportedAssets {
if !a.IsScreenshot && (excludeIDs[a.NodeID] || excludeNames[a.NodeName]) {
os.Remove(filepath.Join(opts.ImageDir, a.FileName))
continue
}
filtered = append(filtered, a)
}
specs.ExportedAssets = filtered
}
return nil
}
// ParseScales parses a comma-separated string of scale factors into a float64 slice.
func ParseScales(scalesStr string) ([]float64, error) {
parts := strings.Split(scalesStr, ",")
scales := make([]float64, 0, len(parts))
for _, part := range parts {
trimmed := strings.TrimSpace(part)
if trimmed == "" {
continue
}
s, err := strconv.ParseFloat(trimmed, 64)
if err != nil {
return nil, fmt.Errorf("invalid scale value %q: %w", trimmed, err)
}
if s <= 0 {
return nil, fmt.Errorf("scale value must be positive, got %g", s)
}
scales = append(scales, s)
}
if len(scales) == 0 {
return []float64{1}, nil
}
return scales, nil
}
// ParseNodeIDs parses a comma-separated string of node IDs and returns a slice.
func ParseNodeIDs(nodeIDsStr string) []string {
parts := strings.Split(nodeIDsStr, ",")
result := make([]string, 0, len(parts))
for _, part := range parts {
trimmed := strings.TrimSpace(part)
if trimmed != "" {
result = append(result, trimmed)
}
}
return result
}