figify/types.d.ts at main · zeyarpaing/figify · GitHub

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
type Parameter = {
  name: string;
  key: string;
  description?: string;
  allowFreeform?: boolean;
  optional?: boolean;
};

type NetworkAccess = {
  allowedDomains: string[];
  reasoning?: string;
  devAllowedDomains?: string[];
};

type ManifestMenuItem = {
  name: string;
  command: string;
  parameters?: Parameter[];
  parameterOnly?: boolean;
};

type ManifestRelaunchButton = {
  command: string;
  name: string;
  multipleSelection?: boolean;
};

type PluginPermissionType =
  | 'currentuser'
  | 'activeusers'
  | 'fileusers'
  | 'payments'
  | 'teamlibrary';

type CodeLanguage = {
  label: string;
  value: string;
};

type CodegenPreference =
  | {
      itemType: 'unit';
      defaultScaleFactor: number;
      scaledUnit: string;
      default?: boolean;
      includedLanguages?: string[];
    }
  | {
      itemType: 'select';
      propertyName: string;
      label: string;
      options: {
        label: string;
        value: string;
        isDefault?: boolean;
      }[];
      includedLanguages?: string[];
    }
  | {
      itemType: 'action';
      propertyName: string;
      label: string;
      includedLanguages?: string[];
    };

export interface PluginManifest {
  name: string;
  id: string;
  api: string;
  main: string;
  ui?: string | { [key: string]: string };
  capabilities?: ('textreview' | 'codegen' | 'inspect' | 'vscode')[];
  enableProposedApi?: boolean;
  enablePrivatePluginApi?: boolean;
  build?: string;
  permissions?: PluginPermissionType[];
  editorType: Array<'figma' | 'figjam' | 'dev'>;
  menu?: ManifestMenuItem[];
  relaunchButtons?: ManifestRelaunchButton[];
  networkAccess?: NetworkAccess;
  parameters?: Parameter[];
  parameterOnly?: boolean;
  codegenLanguages?: CodeLanguage[];
  codegenPreferences?: CodegenPreference[];
}