-
Notifications
You must be signed in to change notification settings - Fork 0
/
code.ts
680 lines (603 loc) · 24.7 KB
/
code.ts
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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
/*
{
"ColorExample": {
"Alias Token/primary": {
"$variableValues": {
"Light": "$Global Token/blue/100",
"Dark": "$Global Token/blue/100"
},
"$description": "",
"$codeSyntax": {
"WEB": "color.aliasToken.primary"
},
"$scopes": [
"ALL_SCOPES"
],
"$hiddenFromPublishing": false
},
"Global Token/blue/100": {
"$variableValues": {
"Light": "#0000FF",
"Dark": "#0000FF"
},
"$description": "",
"$codeSyntax": {
"WEB": "color.globalToken.blue['100']"
},
"$scopes": [
"ALL_SCOPES"
],
"$hiddenFromPublishing": false
}
}
}
*/
function entrypoint() {
console.clear();
figma.showUI(__html__, {
width: 640,
height: 740,
themeColors: true,
});
figma.ui.onmessage = App.onmessage;
}
const App = {
post(params: { type: string, data?: any }) {
figma.ui.postMessage(params);
},
outputExportJSON(data: any) {
App.post({ type: 'LVM-export-json', data });
},
outputImportStatus(data: any) {
App.post({ type: 'LVM-import-status', data });
},
onmessage(msg: any) {
if (msg.type === 'LVM-export') App.doExport();
if (msg.type === 'LVM-import') App.doImport(msg);
},
async doExport() {
// Local Variables の Collections 情報を全て取得する
const collectionsInfo = await CIManip.getCollectionsInfo();
// Collections 情報を JSON に変換する
const jsonObj = JSONManip.getJSONObjByCollectionsInfo(collectionsInfo);
App.outputExportJSON(Util.toJSON(jsonObj));
},
async doImport(msg: any) {
let runtimeError = false;
try {
// JSON をオブジェクトに変換する
const jsonObj = JSON.parse(msg.data);
// 既に登録済みの Local Variables の Collections 情報を取得する
const collectionsInfo = await CIManip.getCollectionsInfo();
// JSON を静的解析して、構文に問題があれば処理を中断する
JSONManip.validateImportJSON(collectionsInfo, jsonObj);
// インポート処理前の Local Variables の Collections 情報を JSON に変換する
const backupJSONObj = JSONManip.getJSONObjByCollectionsInfo(collectionsInfo);
// インポート処理を実行する(実行中に例外が発生したら runtimeError として処理する)
runtimeError = true;
await App.importVariables(collectionsInfo, jsonObj);
runtimeError = false;
// ui.html に情報を送る
App.outputExportJSON(Util.toJSON(backupJSONObj));
App.outputImportStatus(Util.toJSON({
status: 'インポートが成功しました。',
note: 'インポート前の情報をエクスポートしています。必要であればログを控えておいてください。',
}));
App.post({ type: 'LVM-import-succeeded' });
}
catch (err: any) {
// JSON.parse() で失敗した場合は err.lineNumber が与えられる
const status = err.lineNumber != null ? 'Invalid JSON' : 'Invalid data structure';
const note = runtimeError ? 'インポート処理中にエラーが発生しました。データが途中までインポートされた可能性があります。' : undefined;
// ui.html に情報を送る
App.outputImportStatus(Util.toJSON({ status, line: err.lineNumber, message: err.message, note }));
}
},
/**
* JSON 情報を基に Local Variables のインポートを実行する
*/
async importVariables(collectionsInfo: CollectionsInfo, jsonObj: JSONObj, prevNullCount?: number) {
// AliasVariable は、参照先の変数が登録済みでなければ登録できない
// nullCount は、登録できなかった AliasVariables の個数を表す
let nullCount = 0;
for (const [collectionName, variablesValues] of Object.entries(jsonObj as JSONObj)) {
let collectionInfo;
// 初回のインポート処理
if (prevNullCount == null) {
const variableValuesArray = Object.values(variablesValues).map($keys => $keys.$variableValues);
const modeNames = Util.getKeysByObjectArray(variableValuesArray) as ModeNames;
// Collection が存在すればそれを取得、なければ新規 Collection を作成し、mode を設定する
collectionInfo = await CIManip.upsertCollectionInfoByName(collectionsInfo, collectionName, modeNames);
}
// 2回目以降のインポート処理
else {
// Collection を取得する
collectionInfo = collectionsInfo[collectionName];
}
for (const [variableName, jsonObjVariable] of Object.entries(variablesValues)) {
if (VIManip.upsertVariable(collectionInfo, variableName, jsonObjVariable) == null) ++nullCount;
}
}
// nullCount が 1 以上であれば、未登録の AliasVariable があるので再登録を試みる
// 直前の処理と nullCount が同じ場合は、存在しない参照先を指定しているので処理を中断する
// なお、循環参照している場合は、循環を検出した Variable の値の登録が無視される
if (nullCount > 0 && nullCount !== prevNullCount) {
// 直前の処理でインポートに成功した分も含めて Collections 情報を取得し直す
collectionsInfo = await CIManip.getCollectionsInfo();
await App.importVariables(collectionsInfo, jsonObj, nullCount);
}
},
};
/**
* CollectionInfo Manip
*/
const CIManip = {
/**
* 存在する全ての Collection の CollectionInfo を取得する
*/
async getCollectionsInfo() {
const collections = await figma.variables.getLocalVariableCollectionsAsync();
const collectionsInfoArray = await Promise.all(collections.map(collection => CIManip.getCollectionInfo(collection)));
const keyCallback = (value: CollectionInfo) => value.collection.name;
let collectionsInfo = Util.objMap(Util.arrayCombine(collectionsInfoArray), null, keyCallback) as CollectionsInfo;
collectionsInfo = Util.objKeySort(collectionsInfo) as CollectionsInfo;
return collectionsInfo;
},
/**
* Collection から CollectionInfo を作成する
*/
async getCollectionInfo(collection: VariableCollection) {
const variablesInfo = await VIManip.getVariablesInfo(collection);
return { collection, variablesInfo };
},
/**
* 指定した name の CollectionInfo があれば取得し、なければ作成する
*/
async upsertCollectionInfoByName(collectionsInfo: CollectionsInfo, name: string, modeNames: ModeNames) {
let collectionInfo = collectionsInfo[name];
const collection = collectionInfo == null ? figma.variables.createVariableCollection(name) : collectionInfo.collection;
// modeNames で mode を上書きする
CIManip.setModes(collection, modeNames);
if (collectionInfo == null) collectionInfo = await CIManip.getCollectionInfo(collection);
return collectionInfo;
},
/**
* Mode から name を取得する
*/
getModeName(mode: Mode) {
// for Figma bug: https://forum.figma.com/t/the-number-of-modes-does-not-match/79073
if (mode == null) return '';
const name = mode.name;
// デフォルトのモードは name と表示名が異なっているので表示名を使う
if (name === 'Mode 1') return 'Value';
return name;
},
/**
* Collection に modeNames を設定する
*/
setModes(collection: VariableCollection, modeNames: ModeNames) {
if (modeNames.length === 0) return;
const modes = collection.modes;
// modeName を書き換える
modeNames.forEach((modeName, idx) => {
let modeId = modes[idx] && modes[idx].modeId;
if (modeId == null) modeId = collection.addMode(modeName);
else collection.renameMode(modeId, modeName);
});
// 不要な mode を削除する
for (let idx = modeNames.length; idx < modes.length; ++idx) {
collection.removeMode(modes[idx].modeId);
}
},
};
/**
* VariableInfo Manip
*/
const VIManip = {
/**
* 指定した variableName の Variable があれば上書きし、なければ作成する
*/
upsertVariable(collectionInfo: CollectionInfo, variableName: string, jsonObjVariable: JSONObjVariable) {
const { collection, variablesInfo } = collectionInfo;
let variable = (variablesInfo[variableName] && (variablesInfo[variableName] as VariableInfo).variable) as Variable | null;
if (variable == null) {
// 設定しようとしている $variableValues を基に変数の型を導出する
const variableType = AppUtil.detectTypeByJSONObjVariable(collectionInfo.variablesInfo, jsonObjVariable);
if (variableType == null) return null;
variable = figma.variables.createVariable(variableName, collection, variableType);
}
// $variableValues
collection.modes.forEach(mode => {
const modeName = CIManip.getModeName(mode);
const value = jsonObjVariable.$variableValues[modeName];
if (value == null) return;
const internalValue = AppUtil.convertValue(collectionInfo.variablesInfo, value);
if (internalValue == null) return;
variable.setValueForMode(mode.modeId, internalValue);
});
// $description
variable.description = jsonObjVariable.$description;
// $codeSyntax
for (const [platform, codeSyntax] of Object.entries(jsonObjVariable.$codeSyntax)) {
variable.setVariableCodeSyntax(platform as keyof CodeSyntax, codeSyntax);
}
// $scopes
variable.scopes = jsonObjVariable.$scopes;
// $hiddenFromPublishing
variable.hiddenFromPublishing = jsonObjVariable.$hiddenFromPublishing;
return variable;
},
/**
* Collection 内にある Local Variables を全て取得する
*/
async getVariablesInfo(collection: VariableCollection) {
let variablesInfo = {} as VariablesInfo;
const promiseList = [] as Array<Promise<Variable>>;
for (const variableId of collection.variableIds) {
promiseList.push(figma.variables.getVariableByIdAsync(variableId) as Promise<Variable>);
}
const variables = await Promise.all(promiseList);
for (const variable of variables) {
variablesInfo[variable.name] = VIManip.getVariableInfo(collection, variables, variable);
}
variablesInfo = Util.objKeySort(variablesInfo) as VariablesInfo;
return variablesInfo;
},
/**
* Collection と Variable から VariableInfo を作成する
* https://www.figma.com/plugin-docs/api/VariableCollection/
* - name | modes | defaultModeId | variableIds
* https://www.figma.com/plugin-docs/api/Variable/
* - name | resolvedType | valuesByMode | codeSyntax | scopes
* https://www.figma.com/plugin-docs/api/VariableScope/
* - STRING: "ALL_SCOPES" | "TEXT_CONTENT" | "FONT_FAMILY" | "FONT_STYLE"
* - FLOAT: "ALL_SCOPES" | "TEXT_CONTENT" | "CORNER_RADIUS" | "WIDTH_HEIGHT" | "GAP" | "OPACITY" | "STROKE_FLOAT"
* | "EFFECT_FLOAT" | "FONT_WEIGHT" | "FONT_SIZE" | "LINE_HEIGHT" | "LETTER_SPACING" | "PARAGRAPH_SPACING" | "PARAGRAPH_INDENT"
* - COLOR: "ALL_SCOPES" | "ALL_FILLS" | "FRAME_FILL" | "SHAPE_FILL" | "TEXT_FILL" | "STROKE_COLOR" | "EFFECT_COLOR"
*/
getVariableInfo(collection: VariableCollection, variables: Variables, variable: Variable) {
const keyCallback = (value: VariableValue, key: string) => {
const mode = collection.modes.find(mode => mode.modeId === key) as Mode;
return CIManip.getModeName(mode);
};
const valueCallback = (value: VariableValue) => AppUtil.reverseConvertValue(variables, value);
const jsonObjVariable = {
$variableValues: Util.objMap(variable.valuesByMode, valueCallback, keyCallback) as VariableValues,
$description: variable.description,
$codeSyntax: variable.codeSyntax,
$scopes: variable.scopes,
$hiddenFromPublishing: variable.hiddenFromPublishing,
}
// for Figma bug: https://forum.figma.com/t/the-number-of-modes-does-not-match/79073
delete jsonObjVariable.$variableValues[''];
return { variable, jsonObjVariable };
},
};
const JSONManip = {
/**
* Local Variables 情報を JSONObj として取得する
*/
getJSONObjByCollectionsInfo(collectionsInfo: CollectionsInfo) {
const jsonObj: any = {};
for (const collectionInfo of Object.values(collectionsInfo)) {
const collectionJSON = JSONManip.convertVariablesInfoForJSON(collectionInfo.variablesInfo);
jsonObj[collectionInfo.collection.name] = collectionJSON;
}
return jsonObj;
},
/**
* VariablesInfo を JSON 用の構造に変換する
*/
convertVariablesInfoForJSON(variablesInfo: VariablesInfo) {
const jsonObj = {} as VariablesValues;
for (const variableInfo of Object.values(variablesInfo)) {
const variableName = variableInfo.variable.name;
jsonObj[variableName] = variableInfo.jsonObjVariable;
}
return jsonObj;
},
/**
* Import された JSON の形式が妥当かどうかチェックする
*/
validateImportJSON(collectionsInfo: CollectionsInfo, jsonObj: unknown) {
if (!Util.isObject(jsonObj)) {
Util.Exception('JSON がオブジェクトではありません。');
}
if (Object.keys(jsonObj as PlainObject<unknown>).length === 0) {
Util.Exception('JSON が空のオブジェクトです。');
}
for (const [collectionName, variablesValues] of Object.entries(jsonObj as PlainObject<unknown>)) {
if (!Util.isObject(variablesValues)) {
Util.Exception(Util.sprintf("'%s' の値がオブジェクトではありません。", collectionName));
}
for (const [variableName, jsonObjVariable] of Object.entries(variablesValues as PlainObject<unknown>)) {
// jsonObjVariable
if (!Util.isObject(jsonObjVariable)) {
Util.Exception(Util.sprintf("%s['%s'] の値がオブジェクトではありません。", collectionName, variableName));
}
const set = new Set(Object.keys(jsonObjVariable as PlainObject<unknown>));
if (!Util.hasOnlyInSet(set, ['$variableValues', '$description', '$codeSyntax', '$scopes', '$hiddenFromPublishing'])) {
Util.Exception(Util.sprintf("%s['%s'] の値は次のキーのみを全て持つオブジェクトである必要があります。['$variableValues', '$description', '$codeSyntax', '$scopes', '$hiddenFromPublishing']", collectionName, variableName));
}
const validJSONObjVariable = jsonObjVariable as JSONObjVariable;
// jsonObjVariable.$variableValues
if (!Util.isObject(validJSONObjVariable.$variableValues)) {
Util.Exception(Util.sprintf("%s['%s']['$variableValues'] の値がオブジェクトではありません。", collectionName, variableName));
}
for (const [modeName, variableValue] of Object.entries(validJSONObjVariable.$variableValues as PlainObject<unknown>)) {
if (!AppUtil.validateVariableValue(variableValue)) {
Util.Exception(Util.sprintf("%s['%s']['%s'] の値が string | number | boolean ではありません。", collectionName, variableName, modeName));
}
}
// jsonObjVariable.$description
if (!Util.isString(validJSONObjVariable.$description)) {
Util.Exception(Util.sprintf("%s['%s']['$description'] の値が文字列ではありません。", collectionName, variableName));
}
// jsonObjVariable.$codeSyntax
if (!Util.isObject(validJSONObjVariable.$codeSyntax)) {
Util.Exception(Util.sprintf("%s['%s']['$codeSyntax'] の値がオブジェクトではありません。", collectionName, variableName));
}
const codeSyntaxKeys = Object.keys(validJSONObjVariable.$codeSyntax as PlainObject<unknown>);
for (const key of codeSyntaxKeys) {
if (!(key === 'WEB' || key === 'ANDROID' || key === 'iOS')) {
Util.Exception(Util.sprintf("%s['%s']['$codeSyntax'] の値は次のいずれかのキーを持つオブジェクトである必要があります。['WEB', 'ANDROID', 'iOS']", collectionName, variableName));
}
}
// jsonObjVariable.$scopes
if (!Array.isArray(validJSONObjVariable.$scopes)) {
Util.Exception(Util.sprintf("%s['%s']['$scopes'] の値が配列ではありません。", collectionName, variableName));
}
// jsonObjVariable.$hiddenFromPublishing
if (!Util.isBoolean(validJSONObjVariable.$hiddenFromPublishing)) {
Util.Exception(Util.sprintf("%s['%s']['$hiddenFromPublishing'] の値が真偽値ではありません。", collectionName, variableName));
}
}
}
return jsonObj;
},
};
const AppUtil = {
/**
* 入力値が COLOR 型かどうかを判定する
*/
isColorInputValue(value: unknown) {
return Util.isString(value) && /^(?:#|rgba?\()/.test(value);
},
/**
* 入力値が ALIAS 型かどうかを判定する
*/
isAliasInputValue(value: unknown) {
return Util.isString(value) && /^\$/.test(value);
},
/**
* ALIAS 型の入力値から valiableName を取得する
*/
getByAliasInputValue(value: string) {
return value.replace(/^\$/, '');
},
/**
* 変数の値の型として妥当かどうかチェックする
*/
validateVariableValue(value: unknown) {
if (Util.isString(value)) return true;
if (Util.isNumber(value)) return true;
if (Util.isBoolean(value)) return true;
return false;
},
/**
* jsonObjVariable を基に VariableType を取得する
*/
detectTypeByJSONObjVariable(variablesInfo: VariablesInfo, jsonObjVariable: JSONObjVariable) {
return AppUtil.detectType(variablesInfo, Util.getFirstElement(jsonObjVariable.$variableValues) as InputValue | null);
},
/**
* 入力値に応じて Local Variable の型を決める
* https://www.figma.com/plugin-docs/api/VariableResolvedDataType/
* type VariableResolvedDataType = "BOOLEAN" | "COLOR" | "FLOAT" | "STRING"
*/
detectType(variablesInfo: VariablesInfo, value: InputValue | null) {
if (value == null) return null;
if (Util.isBoolean(value)) return 'BOOLEAN';
if (Util.isNumber(value)) return 'FLOAT';
if (AppUtil.isColorInputValue(value)) return 'COLOR';
if (AppUtil.isAliasInputValue(value)) {
const variable = AppUtil.getAliasVariable(variablesInfo, value as string);
return variable == null ? null : variable.resolvedType;
}
return 'STRING';
},
/**
* 入力値を setValueForMode が受け付ける内部値に変換する
*/
convertValue(variablesInfo: VariablesInfo, value: InputValue) {
if (AppUtil.isColorInputValue(value)) return figma.util.rgba(value as string);
if (AppUtil.isAliasInputValue(value)) {
const variable = AppUtil.getAliasVariable(variablesInfo, value as string);
return variable == null ? null : figma.variables.createVariableAlias(variable);
}
return value;
},
/**
* ALIAS 型の入力値から対応する Variable を取得する
*/
getAliasVariable(variablesInfo: VariablesInfo, value: string) {
const variableName = AppUtil.getByAliasInputValue(value);
const variable = variablesInfo[variableName] && variablesInfo[variableName].variable;
return variable;
},
/**
* 内部値を入力値に変換する
* https://www.figma.com/plugin-docs/api/VariableValue/
* - string | number | boolean | RGB | RGBA | VariableAlias
*/
reverseConvertValue(variables: Variables, value: VariableValue) {
if (AppUtil.isColorVariableValue(value)) return AppUtil.rgbaToHex(value as RGBA);
if (AppUtil.isAliasVariableValue(value)) return AppUtil.aliasToName(variables, value as VariableAlias);
return value;
},
/**
* 内部値が COLOR 型かどうかを判定する
*/
isColorVariableValue(value: VariableValue) {
if (!Util.isObject(value)) return false;
const { r, g, b, a } = value as RGBA;
if (r == null || g == null || b == null || a == null) return false;
return true;
},
/**
* 内部値が ALIAS 型かどうかを判定する
*/
isAliasVariableValue(value: VariableValue) {
if (!Util.isObject(value)) return false;
const { type } = value as VariableAlias;
return type === 'VARIABLE_ALIAS';
},
/**
* RGBA 値を CSS value に変換する
*/
rgbaToHex({ r, g, b, a }: RGBA) {
if (a < 1) return `rgb(${[r, g, b].map((value: number) => Math.round(value * 255)).join(' ')} / ${a.toFixed(4)})`;
const toHex = (value: number) => Math.round(value * 255).toString(16).toUpperCase().padStart(2, '0');
return `#${[toHex(r), toHex(g), toHex(b)].join('')}`;
},
/**
* VariableAlias 値を $ValiableName に変換する
*/
aliasToName(variables: Variables, { id }: VariableAlias) {
const variable = variables.find(variable => variable.id === id) as Variable;
return Util.sprintf('$%s', variable.name);
},
};
const Util = {
/**
* 例外を発生させる
*/
Exception(msg: string) {
throw new Error(msg);
},
/**
* %s プレースホルダーのみが使える sprintf を提供する
*/
sprintf(format: string, ...args: any) {
let p = 0;
return format.replace(/%./g, function(m: string) {
if (m === '%%') return '%';
if (m === '%s') return args[p++];
return m;
});
},
/**
* 値を JSON に変換する
*/
toJSON(arg: unknown) {
return JSON.stringify(arg, null, 2);
},
/**
* String かどうかを判定する
*/
isString(arg: unknown) {
return typeof arg === 'string';
},
/**
* Number かどうか判定する
*/
isNumber(arg: unknown) {
return typeof arg === 'number';
},
/**
* Boolean かどうか判定する
*/
isBoolean(arg: unknown) {
return typeof arg === 'boolean';
},
/**
* Object かどうかを判定する
*/
isObject(arg: unknown) {
if (typeof arg !== 'object' || arg === null) return false;
const prototype = Object.getPrototypeOf(arg);
const isPlainObject = prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null;
return isPlainObject && !(Symbol.toStringTag in arg) && !(Symbol.iterator in arg);
},
/**
* Set に含まれる値が唯一指定したものに限るかどうかを判定する
*/
hasOnlyInSet(set: Set<unknown>, values: Array<unknown>) {
for (const value of values) {
if (!set.has(value)) return false;
}
return set.size === values.length;
},
/**
* Object または Array の最初の要素を取得する
*/
getFirstElement(arg: unknown) {
if (Util.isObject(arg) || Array.isArray(arg)) {
const array = Object.values(arg as PlainObject<unknown>);
if (array.length >= 1) return array[0];
}
return null;
},
/**
* Object に対して map する
*/
objMap(obj: PlainObject<unknown>, valueCallback: CallableFunction | null, keyCallback?: CallableFunction) {
if (valueCallback == null) valueCallback = (value: unknown) => value;
if (keyCallback == null) keyCallback = (value: unknown, key: string) => key;
const ret: typeof obj = {};
Object.entries(obj).forEach(([key, value]) => ret[keyCallback(value, key)] = valueCallback(value, key));
return ret;
},
/**
* keyArray と valueArray から Object を生成する
*/
arrayCombine(keyArray: Array<unknown>, valueArray?: Array<unknown>) {
if (valueArray == null) {
valueArray = keyArray;
keyArray = Object.keys(keyArray);
}
const ret: PlainObject<unknown> = {};
for (let i = 0; i < keyArray.length; ++i) ret[keyArray[i] as string | number] = valueArray[i];
return ret;
},
/**
* Object の配列から、Object で使われているキーの一覧を取得する
*/
getKeysByObjectArray(objArray: Array<PlainObject<unknown>>) {
const set = new Set();
for (const obj of objArray) {
for(const key of Object.keys(obj)) {
set.add(key);
}
}
return Array.from(set);
},
/**
* Object のキーを基にソートする
*/
objKeySort(obj: PlainObject<unknown>) {
const ret: typeof obj = {};
const keys = Object.keys(obj);
keys.sort();
for (const key of keys) {
ret[key] = obj[key];
}
return ret;
}
};
type PlainObject<T> = { [key: string]: T };
type Mode = { modeId: string, name: string };
type ModeNames = Array<string>;
type CollectionsInfo = PlainObject<CollectionInfo>;
type CollectionInfo = { collection: VariableCollection, variablesInfo: VariablesInfo };
type VariablesInfo = PlainObject<VariableInfo>;
type VariableInfo = { variable: Variable, jsonObjVariable: JSONObjVariable };
type Variables = Array<Variable>;
type InputValue = string | number | boolean;
type VariableValues = PlainObject<InputValue>;
type JSONObjVariable = { $variableValues: VariableValues, $description: string, $codeSyntax: CodeSyntax, $scopes: VariableScopes, $hiddenFromPublishing: boolean };
type VariablesValues = PlainObject<JSONObjVariable>;
type JSONObj = PlainObject<VariablesValues>;
type CodeSyntax = { [platform in CodeSyntaxPlatform]?: string };
type VariableScopes = Array<VariableScope>;
entrypoint();