-
Notifications
You must be signed in to change notification settings - Fork 22
/
forms.ts
213 lines (195 loc) · 5.51 KB
/
forms.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
/*
* Copyright (C) 2021 PixieBrix, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import { Effect } from "@/types";
import { BlockArg, BlockOptions, Logger, Schema } from "@/core";
import { boolean } from "@/utils";
import { BusinessError } from "@/errors";
import { requireSingleElement } from "@/nativeEditor/utils";
type SetValueData = {
$input: JQuery;
value: unknown;
dispatchEvent?: boolean;
logger: Logger;
};
/**
* Set the value of an input, doing the right thing for check boxes, etc.
*/
function setValue({
$input,
value,
logger,
dispatchEvent = true,
}: SetValueData) {
for (const field of $input) {
if (field.isContentEditable) {
field.textContent = String(value);
if (dispatchEvent) {
field.dispatchEvent(new InputEvent("input", { bubbles: true }));
}
continue;
}
if (
!(
field instanceof HTMLInputElement ||
field instanceof HTMLTextAreaElement
)
) {
logger.warn(
"The selected element is not an input field nor an editable element",
{ field }
);
continue;
}
if (
field instanceof HTMLInputElement &&
["radio", "checkbox"].includes(field.type)
) {
field.checked = boolean(value);
} else {
$(field).val(String(value));
}
if (dispatchEvent) {
field.dispatchEvent(new Event("change", { bubbles: true }));
field.dispatchEvent(new InputEvent("input", { bubbles: true }));
}
}
}
export class SetInputValue extends Effect {
constructor() {
super(
"@pixiebrix/forms/set",
"Set Input Value",
"Set the value of an input field"
);
}
inputSchema: Schema = {
type: "object",
properties: {
inputs: {
type: "array",
items: {
type: "object",
properties: {
selector: {
type: "string",
format: "selector",
},
value: {
oneOf: [
{ type: "string" },
{ type: "boolean" },
{ type: "number" },
],
},
},
},
minItems: 1,
},
},
required: ["inputs"],
};
async effect(
{
inputs,
}: BlockArg<{ inputs: Array<{ selector: string; value: unknown }> }>,
{ logger }: BlockOptions
): Promise<void> {
for (const { selector, value } of inputs) {
const $input = $(document).find(selector);
if ($input.length === 0) {
logger.warn(`Could not find input for selector: ${selector}`);
} else {
setValue({ $input, value, logger, dispatchEvent: true });
}
}
}
}
export class FormFill extends Effect {
constructor() {
super("@pixiebrix/form-fill", "Form Fill", "Fill out fields in a form");
}
inputSchema: Schema = {
type: "object",
properties: {
formSelector: {
type: "string",
format: "selector",
},
fieldNames: {
type: "object",
additionalProperties: {
oneOf: [{ type: "string" }, { type: "boolean" }, { type: "number" }],
},
},
fieldSelectors: {
type: "object",
additionalProperties: {
oneOf: [{ type: "string" }, { type: "boolean" }, { type: "number" }],
},
},
submit: {
description: "true to submit the form, or a JQuery selector to click",
default: false,
oneOf: [{ type: "string" }, { type: "boolean" }],
},
},
required: ["formSelector"],
};
async effect(
{
formSelector,
fieldNames = {},
fieldSelectors = {},
submit = false,
}: BlockArg,
{ logger }: BlockOptions
): Promise<void> {
const $form = $(requireSingleElement(formSelector));
for (const [name, value] of Object.entries(fieldNames)) {
const $input = $form.find(`[name="${name}"]`);
if ($input.length === 0) {
logger.warn(`No input ${name} exists in the form`);
}
setValue({ $input, value, logger, dispatchEvent: true });
}
for (const [selector, value] of Object.entries(fieldSelectors)) {
// eslint-disable-next-line unicorn/no-array-callback-reference -- false positive for jquery
const $input = $form.find(selector);
if ($input.length === 0) {
logger.warn(
`Could not find input with selector ${selector} on the form`
);
}
setValue({ $input, value, logger, dispatchEvent: true });
}
if (typeof submit === "boolean") {
if (submit) {
if (!$form.is("form")) {
throw new BusinessError(
`Can only submit a form element, got tag ${$form.get(0).tagName}`
);
}
$form.trigger("submit");
}
} else if (typeof submit === "string") {
const $submit = $(requireSingleElement(submit));
$submit.trigger("click");
} else {
throw new BusinessError("Unexpected argument for property submit");
}
}
}