-
Notifications
You must be signed in to change notification settings - Fork 24
/
fromFigma.mjs
244 lines (230 loc) · 7.11 KB
/
fromFigma.mjs
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
// run with node --env-file=.env app.mjs
const TOKEN = process.env.FIGMA_ACCESS_TOKEN;
const URL_BASE = "https://api.figma.com/v1/files";
export const KEY_PREFIX_COLLECTION = "@";
/**
* @link https://www.figma.com/developers/api#get-files-endpoint
* @param {string} fileKey
* @returns {Object<any>} styles data
*/
export async function getFileStyles(fileKey) {
try {
const fileResponse = await fetch(`${URL_BASE}/${fileKey}`, {
method: "GET",
headers: { "X-FIGMA-TOKEN": TOKEN },
});
const data = await fileResponse.json();
return fileRESTResponseToStylesJSON(data);
} catch (e) {
throw e;
}
}
/**
* @link https://www.figma.com/developers/api#get-local-variables-endpoint
* @param {string} fileKey
* @param {string} nameSpace - the namespace for $extensions data
* @returns {Object<any>} styles data
*/
export async function getFileVariables(fileKey, nameSpace) {
try {
const fileResponse = await fetch(`${URL_BASE}/${fileKey}/variables/local`, {
method: "GET",
headers: { "X-FIGMA-TOKEN": TOKEN },
});
const data = await fileResponse.json();
return variablesRESTResponseToVariablesJSON(data, nameSpace);
} catch (e) {
throw e;
}
}
function fileRESTResponseToStylesJSON(response) {
const styles = response.styles;
for (let styleId in styles) {
if (styles[styleId].remote) {
delete styles[styleId];
}
}
traverseChildrenForStyles(styles, response.document, {
foundCount: 0,
needToFind: Object.keys(styles).length,
});
return Object.values(styles).filter(({ remote }) => !remote);
function traverseChildrenForStyles(styles, node, finder) {
if (finder.foundCount >= finder.needToFind) return;
if (node.styles) {
for (let styleType in node.styles) {
const styleId = node.styles[styleType];
if (styles[styleId] && !styles[styleId].type) {
finder.foundCount++;
if (styleType === "text") {
const { fontSize, fontFamily, fontWeight, fontStyle } =
node.boundVariables;
styles[styleId] = {
type: "TEXT",
name: styles[styleId].name,
fontSize: fontSize ? fontSize[0] : node.fontSize,
fontFamily: fontFamily ? fontFamily[0] : node.fontFamily,
fontWeight: fontWeight ? fontWeight[0] : node.fontWeight,
fontStyle: fontStyle
? fontStyle[0]
: node.style.italic
? "italic"
: "normal",
};
} else if (styleType === "effect") {
styles[styleId].type = "EFFECT";
styles[styleId].effects = node.effects;
} else if (styleType === "FILL") {
styles[styleId].type = "FILL";
styles[styleId].fills = node.fills;
}
}
}
}
if (node.children) {
node.children.forEach((child) =>
traverseChildrenForStyles(styles, child, finder),
);
}
}
}
function variablesRESTResponseToVariablesJSON(response, nameSpace) {
const collections = Object.values(response.meta.variableCollections).filter(
(c) => !c.remote,
);
const object = {};
const { idToKey } = uniqueKeyIdMaps(collections, "id", KEY_PREFIX_COLLECTION);
collections.forEach(
(collection) =>
(object[idToKey[collection.id]] = restAPICollectionResponseToJSON(
nameSpace,
idToKey,
response.meta.variables,
collection,
)),
);
return object;
/* Creating maps of any nodes where the names have an incrementing suffix if duplicates */
function uniqueKeyIdMaps(nodesWithNames, idKey, prefix = "") {
const idToKey = {};
const keyToId = {};
nodesWithNames.forEach((node) => {
const key = sanitizeName(node.name);
let int = 2;
let uniqueKey = `${prefix}${key}`;
while (keyToId[uniqueKey]) {
uniqueKey = `${prefix}${key}_${int}`;
int++;
}
keyToId[uniqueKey] = node[idKey];
idToKey[node[idKey]] = uniqueKey;
});
return { idToKey, keyToId };
}
function sanitizeName(name) {
return name
.replace(/[^a-zA-Z0-9 ]/g, "")
.replace(/^ +/, "")
.replace(/ +$/, "")
.replace(/ +/g, "_")
.toLowerCase();
}
/* REST API Node conversion to JSON */
function restAPICollectionResponseToJSON(
nameSpace,
collectionIdToKeyMap,
variables,
{ name, modes, variableIds, id: figmaId },
) {
const collection = {};
const { idToKey, keyToId } = uniqueKeyIdMaps(modes, "modeId");
const modeKeys = Object.values(idToKey);
collection.$extensions = {
[nameSpace]: { figmaId, modes: modeKeys },
};
variableIds.forEach((variableId) => {
const { name, resolvedType, valuesByMode, description } =
variables[variableId];
const value = valuesByMode[keyToId[modeKeys[0]]];
const fontWeight =
resolvedType === "FLOAT" &&
Boolean(name.match(/\/?weight/i)) &&
"fontWeight";
const fontFamily =
resolvedType === "STRING" &&
Boolean(name.match(/\/?family/i)) &&
"fontFamily";
if (
(value !== undefined &&
["COLOR", "FLOAT", "STRING"].includes(resolvedType)) ||
fontFamily
) {
let obj = collection;
name.split("/").forEach((groupName) => {
const safeName = groupName
.split(/[^\da-zA-Z]+/)
.join("-")
.toLowerCase();
obj[safeName] = obj[safeName] || {};
obj = obj[safeName];
});
obj.$type =
resolvedType === "COLOR"
? "color"
: resolvedType === "FLOAT"
? fontWeight || "number"
: fontFamily || "unknown";
obj.$value = restAPIValueToJSON(
value,
resolvedType,
collectionIdToKeyMap,
variables,
);
obj.$description = description || "";
obj.$extensions = {
[nameSpace]: {
figmaId: variableId,
modes: modeKeys.reduce((into, modeKey) => {
into[modeKey] = restAPIValueToJSON(
valuesByMode[keyToId[modeKey]],
resolvedType,
collectionIdToKeyMap,
variables,
);
return into;
}, {}),
},
};
}
});
return collection;
}
function restAPIValueToJSON(
value,
resolvedType,
collectionIdToKeyMap,
variables,
) {
if (value.type === "VARIABLE_ALIAS") {
const variable = variables[value.id];
if (!variable) {
console.log(value);
return "UNKNOWN";
}
const prefix = collectionIdToKeyMap[variable.variableCollectionId];
return `{${prefix}.${variable.name.replace(/\//g, ".")}}`;
}
return resolvedType === "COLOR" ? rgbToHex(value) : value;
function rgbToHex({ r, g, b, a }) {
const toHex = (value) => {
const hex = Math.round(value * 255).toString(16);
return hex.length === 1 ? "0" + hex : hex;
};
const hex = [toHex(r), toHex(g), toHex(b)];
if (a !== 1) {
hex.push(toHex(a));
}
return `#${hex.join("")}`;
}
}
}