-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathindex.tsx
More file actions
398 lines (381 loc) · 13.4 KB
/
Copy pathindex.tsx
File metadata and controls
398 lines (381 loc) · 13.4 KB
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
import React, { useContext, useEffect, useRef, useState } from 'react'
import Form from '@rjsf/core'
import clsx from 'clsx'
import { RJSFSchema, UiSchema, RegistryWidgetsType, RegistryFieldsType } from '@rjsf/utils'
import validator from '@rjsf/validator-ajv8'
import $RefParser from '@apidevtools/json-schema-ref-parser'
import {
MethodExample,
MethodParam,
SchemaComponents,
} from '@site/src/components/ParserOpenRPC/interfaces'
import styles from './styles.module.scss'
import global from '../global.module.scss'
import { BaseInputTemplate } from '@site/src/components/ParserOpenRPC/InteractiveBox/templates/BaseInputTemplate'
import { ArrayFieldTemplate } from '@site/src/components/ParserOpenRPC/InteractiveBox/templates/ArrayFieldTemplate'
import { ObjectFieldTemplate } from '@site/src/components/ParserOpenRPC/InteractiveBox/templates/ObjectFieldTemplate'
import { ConditionalField } from '@site/src/components/ParserOpenRPC/InteractiveBox/fields/ConditionalField'
import { DropdownWidget } from '@site/src/components/ParserOpenRPC/InteractiveBox/widgets/DropdownWidget'
import { SelectWidget } from '@site/src/components/ParserOpenRPC/InteractiveBox/widgets/SelectWidget'
import { Tooltip } from '@site/src/components/Tooltip'
import { useColorMode } from '@docusaurus/theme-common'
import { ParserOpenRPCContext } from '@site/src/components/ParserOpenRPC'
import { MetamaskProviderContext } from '@site/src/theme/Root'
import * as isPlainObject from 'lodash.isplainobject'
import * as camelCase from 'lodash.camelcase'
import { RemoveButton } from '@site/src/components/ParserOpenRPC/InteractiveBox/buttonTemplates/RemoveButton'
import { AddButton } from '@site/src/components/ParserOpenRPC/InteractiveBox/buttonTemplates/AddButton'
import ClearIcon from '@site/static/img/icons/clear-icon.svg'
import ResetIcon from '@site/static/img/icons/reset-icon.svg'
import SubmitIcon from '@site/static/img/icons/submit-icon.svg'
import { WrapIfAdditionalTemplate } from '@site/src/components/ParserOpenRPC/InteractiveBox/templates/WrapIfAdditionalTemplate'
interface InteractiveBoxProps {
params: MethodParam[]
components: SchemaComponents
examples: MethodExample[]
onParamChange: (data) => void
drawerLabel?: string | null
closeComplexTypeView?: () => void
isOpen?: boolean
onModalClose?: () => void
}
type ObjectType = { [key: string]: any }
type KeyOrderType = { name: string }
function sortObjectKeysByArray(obj: ObjectType, orderArray: KeyOrderType[]): ObjectType {
const result: ObjectType = {}
for (const { name } of orderArray) {
if (name in obj) {
result[name] = obj[name]
}
}
return result
}
function removeEmptyStrings(obj) {
for (const key in obj) {
if (obj[key] === '') {
delete obj[key]
}
}
return obj
}
function removeEmptyArrays(obj: any, params: any[]) {
const newObj = JSON.parse(JSON.stringify(obj))
for (const key in newObj) {
const currentParam = params.find(item => item.name === key)
if (newObj.hasOwnProperty(key)) {
if (!Array.isArray(newObj[key]) && typeof newObj[key] === 'object') {
newObj[key] = removeEmptyStrings(newObj[key])
}
if (currentParam && currentParam.required) {
return newObj
}
if (Array.isArray(newObj[key]) && newObj[key].length === 0) {
delete newObj[key]
} else if (newObj[key] !== null && typeof newObj[key] === 'object') {
newObj[key] = removeEmptyArrays(newObj[key], params)
}
}
}
return newObj
}
export default function InteractiveBox({
params,
components,
examples,
onParamChange,
drawerLabel,
closeComplexTypeView,
isOpen = false,
onModalClose,
}: InteractiveBoxProps) {
const [parsedSchema, setParsedSchema] = useState<RJSFSchema>(null)
const [defaultFormData, setDefaultFormData] = useState<any>({})
const [currentFormData, setCurrentFormData] = useState<any>({})
const [isFormReseted, setIsFormReseted] = useState(false)
const [currentSchemaId, setCurrentSchemaId] = useState('')
const [objectPropertyBeforeEdit, setObjectPropertyBeforeEdit] = useState(null)
const [objectValueBeforeEdit, setObjectValueBeforeEdit] = useState(null)
const formRef = useRef(null)
const { colorMode } = useColorMode()
const { isComplexTypeView } = useContext(ParserOpenRPCContext)
const { metaMaskAccount } = useContext(MetamaskProviderContext)
const addWalletId = propName => ({ [propName]: metaMaskAccount })
const getObjectWithAddress = value => {
const addressField = 'address'
const fromField = 'from'
if (Object.keys(value).includes(addressField)) {
return {
...value,
...addWalletId(addressField),
}
}
if (Object.keys(value).includes(fromField)) {
return {
...value,
...addWalletId(fromField),
}
}
return value
}
const checkName = (name: string) => {
if (name === 'requestPermissionObject') return 'requestPermissionsObject'
return name.trim().split(/\s+/).length > 1 ? camelCase(name) : name
}
useEffect(() => {
if (examples && examples.length > 0 && examples[0].params) {
const defaultValues = Object.fromEntries(
examples[0].params.map(({ name, value }) => {
if (metaMaskAccount) {
if (name === 'Address' || name === 'From') {
return [checkName(name), metaMaskAccount]
}
if (isPlainObject(value)) {
return [checkName(name), getObjectWithAddress(value)]
}
}
if (isPlainObject(value)) {
return [
checkName(name),
Object.fromEntries(
Object.entries(value).map(([key, val]) => [
key,
isPlainObject(val) && val?.description ? val.value : val,
])
),
]
}
return [checkName(name), value]
})
)
setDefaultFormData({ ...defaultValues })
setCurrentFormData({ ...defaultValues })
onParamChange({ ...defaultValues })
}
}, [examples, metaMaskAccount])
// ---------------- CHECKPOINT 1 ----------------
// Build the schema that will be supplied to RJSF.
// If a parameter schema contains `patternProperties` but does not explicitly
// allow additional properties, we inject `additionalProperties: true` so that
// RJSF`s `canExpand` helper recognises it as dynamic and enables the "Add" UI.
const schema: RJSFSchema = {
components: {
schemas: components,
},
type: 'object',
// @ts-ignore – the OpenRPC param list isn't strictly typed for RJSF here.
properties: Object.fromEntries(
params.map(({ name, schema }) => {
let patchedSchema: any = { ...schema }
if (patchedSchema.patternProperties && patchedSchema.additionalProperties === undefined) {
// Attempt to infer a sensible schema for additional properties. If the
// sole patternProperty specifies an object, default to object {}; otherwise fallback to string.
let inferredAdditional: any = { type: 'string', default: 'New Value' }
const singlePattern: any = Object.values(patchedSchema.patternProperties)[0]
if (singlePattern && singlePattern.type === 'object') {
inferredAdditional = { type: 'object', default: {} }
}
patchedSchema = { ...patchedSchema, additionalProperties: inferredAdditional }
}
return [name, patchedSchema]
})
),
}
const uiSchema: UiSchema = {
'ui:globalOptions': {
label: false,
},
'ui:widget': 'checkbox',
}
const templates = {
BaseInputTemplate,
ArrayFieldTemplate,
WrapIfAdditionalTemplate,
ObjectFieldTemplate,
FieldErrorTemplate: () => null,
ErrorListTemplate: () => null,
ButtonTemplates: { AddButton, RemoveButton },
}
const widgets: RegistryWidgetsType = {
CheckboxWidget: DropdownWidget,
SelectWidget: SelectWidget,
}
const fields: RegistryFieldsType = {
// @ts-ignore
AnyOfField: ConditionalField,
// @ts-ignore
OneOfField: ConditionalField,
}
const handleResetForm = e => {
e.preventDefault()
setCurrentFormData({ ...defaultFormData })
onParamChange({ ...defaultFormData })
setIsFormReseted(true)
}
const handleClearForm = e => {
e.preventDefault()
if (formRef) {
formRef?.current?.reset()
}
}
const handleSubmitAndClose = (e: React.MouseEvent<HTMLButtonElement>) => {
e.preventDefault()
onParamChange(currentFormData)
if (isComplexTypeView) {
closeComplexTypeView()
} else {
onModalClose?.()
}
}
const isLightTheme = colorMode === 'light'
useEffect(() => {
const dereferenceSchema = async () => {
try {
if (schema) {
const deref = (await $RefParser.dereference(schema)) as RJSFSchema
setParsedSchema(deref)
}
} catch (error) {
console.error('Error of parsing schema:', error)
}
}
dereferenceSchema()
}, [])
const onChangeHandler = data => {
setCurrentFormData(data.formData)
}
const handleBlur = () => {
const cleaned = removeEmptyArrays(currentFormData, params)
setCurrentFormData(cleaned)
onParamChange(cleaned)
}
const cloneAndSetNullIfExists = (obj, key) => {
if (typeof obj !== 'object' || obj === null) return obj
const newObj = Array.isArray(obj) ? [] : {}
for (const prop in obj) {
if (obj.hasOwnProperty(prop)) {
if (prop === key) {
newObj[prop] = []
} else if (typeof obj[prop] === 'object' && obj[prop] !== null) {
newObj[prop] = cloneAndSetNullIfExists(obj[prop], key)
} else {
newObj[prop] = obj[prop]
}
}
}
return newObj
}
const cloneObjectAndSetNullIfExists = (obj, key) => {
if (typeof obj !== 'object' || obj === null) {
return obj
}
let newObj = {}
if (Object.keys(obj).length >= 1) {
newObj = objectValueBeforeEdit
} else {
for (const prop in obj) {
if (obj.hasOwnProperty(prop)) {
if (Object.keys(obj).length === 0) {
newObj[prop] = {}
} else if (typeof obj[prop] === 'object' && obj[prop] !== null) {
newObj[objectPropertyBeforeEdit] = cloneObjectAndSetNullIfExists(obj[prop], key)
} else {
newObj[prop] = obj[prop]
}
}
}
}
return newObj
}
const handleCancelClick = () => {
if (drawerLabel) {
const currentKey = Object.keys(currentFormData)[0]
if (objectPropertyBeforeEdit && currentKey) {
const upData = cloneObjectAndSetNullIfExists(
currentFormData[currentKey],
objectPropertyBeforeEdit
)
setCurrentFormData({ [currentKey]: upData })
setObjectPropertyBeforeEdit(null)
setObjectValueBeforeEdit(null)
} else {
const upData = cloneAndSetNullIfExists(currentFormData, drawerLabel)
setCurrentFormData(upData)
}
}
closeComplexTypeView()
}
return parsedSchema ? (
<>
<div className={styles.tableHeadingRow}>
<div className={clsx(styles.tableHeadingColumn, 'font-weight-medium')}>Parameter</div>
<div className={clsx(styles.tableHeadingColumn, 'font-weight-medium')}>Value</div>
</div>
<Form
schema={parsedSchema}
formData={currentFormData}
formContext={{
currentSchemaId,
isFormReseted,
setCurrentSchemaId,
objectPropertyBeforeEdit,
setObjectPropertyBeforeEdit,
setObjectValueBeforeEdit,
currentFormData,
setCurrentFormData,
onParamChange,
}}
validator={validator}
liveValidate={isOpen}
noHtml5Validate
onChange={onChangeHandler}
onBlur={handleBlur}
templates={templates}
uiSchema={uiSchema}
widgets={widgets}
ref={formRef}
fields={fields}>
<div
className={clsx(
styles.tableFooterRow,
isLightTheme ? styles.tableFooterRowLight : styles.tableFooterRowDark
)}>
<div className={clsx(styles.footerButtons, styles.footerButtonsLeft)}>
<Tooltip message="Reset fields">
<button className={styles.footerButtonLeft} onClick={handleResetForm}>
<ResetIcon className={styles.footerButtonIcon} />
</button>
</Tooltip>
<Tooltip message="Clear fields">
<button className={styles.footerButtonLeft} onClick={handleClearForm}>
<ClearIcon className={styles.footerButtonIcon} />
</button>
</Tooltip>
<Tooltip message="Submit and close">
<button className={styles.footerButtonLeft} onClick={handleSubmitAndClose}>
<SubmitIcon className={styles.footerButtonIcon} />
</button>
</Tooltip>
</div>
{isComplexTypeView ? (
<div className={clsx(styles.footerButtons)}>
<button
className={clsx(
global.secondaryBtn,
styles.footerButtonRight,
styles.footerButtonRightOutline
)}
onClick={handleCancelClick}>
Cancel
</button>
<button
className={clsx(global.primaryBtn, styles.footerButtonRight)}
onClick={handleSubmitAndClose}>
Save
</button>
</div>
) : null}
</div>
</Form>
</>
) : null
}