summaryrefslogtreecommitdiff
path: root/packages/frontend/src/scripts/form.ts
blob: 242a504c3b5f64c88a44a768e37da8db709801eb (plain)
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
/*
 * SPDX-FileCopyrightText: syuilo and misskey-project
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import * as Misskey from 'misskey-js';

type EnumItem = string | {
	label: string;
	value: string;
};

type Hidden = boolean | ((v: any) => boolean);

export type FormItem = {
	label?: string;
	type: 'string';
	default: string | null;
	description?: string;
	required?: boolean;
	hidden?: Hidden;
	multiline?: boolean;
	treatAsMfm?: boolean;
} | {
	label?: string;
	type: 'number';
	default: number | null;
	description?: string;
	required?: boolean;
	hidden?: Hidden;
	step?: number;
} | {
	label?: string;
	type: 'boolean';
	default: boolean | null;
	description?: string;
	hidden?: Hidden;
} | {
	label?: string;
	type: 'enum';
	default: string | null;
	required?: boolean;
	hidden?: Hidden;
	enum: EnumItem[];
} | {
	label?: string;
	type: 'radio';
	default: unknown | null;
	required?: boolean;
	hidden?: Hidden;
	options: {
		label: string;
		value: unknown;
	}[];
} | {
	label?: string;
	type: 'range';
	default: number | null;
	description?: string;
	required?: boolean;
	step?: number;
	min: number;
	max: number;
	textConverter?: (value: number) => string;
	hidden?: Hidden;
} | {
	label?: string;
	type: 'object';
	default: Record<string, unknown> | null;
	hidden: Hidden;
} | {
	label?: string;
	type: 'array';
	default: unknown[] | null;
	hidden: Hidden;
} | {
	type: 'button';
	content?: string;
	hidden?: Hidden;
	action: (ev: MouseEvent, v: any) => void;
} | {
	type: 'drive-file';
	defaultFileId?: string | null;
	hidden?: Hidden;
	validate?: (v: Misskey.entities.DriveFile) => Promise<boolean>;
};

export type Form = Record<string, FormItem>;

type GetItemType<Item extends FormItem> =
	Item['type'] extends 'string' ? string :
	Item['type'] extends 'number' ? number :
	Item['type'] extends 'boolean' ? boolean :
	Item['type'] extends 'radio' ? unknown :
	Item['type'] extends 'range' ? number :
	Item['type'] extends 'enum' ? string :
	Item['type'] extends 'array' ? unknown[] :
	Item['type'] extends 'object' ? Record<string, unknown> :
	Item['type'] extends 'drive-file' ? Misskey.entities.DriveFile | undefined :
	never;

export type GetFormResultType<F extends Form> = {
	[P in keyof F]: GetItemType<F[P]>;
};