datocms-plugin-sdk 0.3.4 → 0.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/types.json CHANGED
@@ -26,7 +26,7 @@
26
26
  "sources": [
27
27
  {
28
28
  "fileName": "SiteApiSchema.ts",
29
- "line": 1907,
29
+ "line": 1929,
30
30
  "character": 2
31
31
  }
32
32
  ],
@@ -44,7 +44,7 @@
44
44
  "sources": [
45
45
  {
46
46
  "fileName": "SiteApiSchema.ts",
47
- "line": 1906,
47
+ "line": 1928,
48
48
  "character": 2
49
49
  }
50
50
  ],
@@ -62,7 +62,7 @@
62
62
  "sources": [
63
63
  {
64
64
  "fileName": "SiteApiSchema.ts",
65
- "line": 1905,
65
+ "line": 1927,
66
66
  "character": 2
67
67
  }
68
68
  ],
@@ -86,7 +86,7 @@
86
86
  "sources": [
87
87
  {
88
88
  "fileName": "SiteApiSchema.ts",
89
- "line": 1904,
89
+ "line": 1926,
90
90
  "character": 17
91
91
  }
92
92
  ]
@@ -98,7 +98,7 @@
98
98
  "kindString": "Interface",
99
99
  "flags": {},
100
100
  "comment": {
101
- "shortText": "Each Model consists of a set of fields. Using the database metaphore, fields are like\ntable columns, and when creating them you need to specify their type (`string`, `file`,\n`float`, etc.) and any required validation.",
101
+ "shortText": "Each Model consists of a set of fields. Using the database metaphore, fields are like\ntable columns, and when creating them you need to specify their type (`string`,\n`file`, `float`, etc.) and any required validation.",
102
102
  "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"field\".\n"
103
103
  },
104
104
  "children": [
@@ -111,7 +111,7 @@
111
111
  "sources": [
112
112
  {
113
113
  "fileName": "SiteApiSchema.ts",
114
- "line": 2513,
114
+ "line": 2539,
115
115
  "character": 2
116
116
  }
117
117
  ],
@@ -129,7 +129,7 @@
129
129
  "sources": [
130
130
  {
131
131
  "fileName": "SiteApiSchema.ts",
132
- "line": 2512,
132
+ "line": 2538,
133
133
  "character": 2
134
134
  }
135
135
  ],
@@ -147,7 +147,7 @@
147
147
  "sources": [
148
148
  {
149
149
  "fileName": "SiteApiSchema.ts",
150
- "line": 2514,
150
+ "line": 2540,
151
151
  "character": 2
152
152
  }
153
153
  ],
@@ -165,7 +165,7 @@
165
165
  "sources": [
166
166
  {
167
167
  "fileName": "SiteApiSchema.ts",
168
- "line": 2511,
168
+ "line": 2537,
169
169
  "character": 2
170
170
  }
171
171
  ],
@@ -190,7 +190,7 @@
190
190
  "sources": [
191
191
  {
192
192
  "fileName": "SiteApiSchema.ts",
193
- "line": 2510,
193
+ "line": 2536,
194
194
  "character": 17
195
195
  }
196
196
  ]
@@ -215,7 +215,7 @@
215
215
  "sources": [
216
216
  {
217
217
  "fileName": "SiteApiSchema.ts",
218
- "line": 3523,
218
+ "line": 3563,
219
219
  "character": 2
220
220
  }
221
221
  ],
@@ -233,7 +233,7 @@
233
233
  "sources": [
234
234
  {
235
235
  "fileName": "SiteApiSchema.ts",
236
- "line": 3522,
236
+ "line": 3562,
237
237
  "character": 2
238
238
  }
239
239
  ],
@@ -251,7 +251,7 @@
251
251
  "sources": [
252
252
  {
253
253
  "fileName": "SiteApiSchema.ts",
254
- "line": 3525,
254
+ "line": 3565,
255
255
  "character": 2
256
256
  }
257
257
  ],
@@ -269,7 +269,7 @@
269
269
  "sources": [
270
270
  {
271
271
  "fileName": "SiteApiSchema.ts",
272
- "line": 3524,
272
+ "line": 3564,
273
273
  "character": 2
274
274
  }
275
275
  ],
@@ -287,7 +287,7 @@
287
287
  "sources": [
288
288
  {
289
289
  "fileName": "SiteApiSchema.ts",
290
- "line": 3521,
290
+ "line": 3561,
291
291
  "character": 2
292
292
  }
293
293
  ],
@@ -313,7 +313,7 @@
313
313
  "sources": [
314
314
  {
315
315
  "fileName": "SiteApiSchema.ts",
316
- "line": 3520,
316
+ "line": 3560,
317
317
  "character": 17
318
318
  }
319
319
  ]
@@ -326,7 +326,7 @@
326
326
  "flags": {},
327
327
  "comment": {
328
328
  "shortText": "The way you define the kind of content you can edit inside your administrative area\npasses through the concept of Models, which are much like database tables. For\nbackward-compatibility reasons, the API refers to models as \"item types\".",
329
- "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"item_type\".\n"
329
+ "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`\n\"item_type\".\n"
330
330
  },
331
331
  "children": [
332
332
  {
@@ -338,7 +338,7 @@
338
338
  "sources": [
339
339
  {
340
340
  "fileName": "SiteApiSchema.ts",
341
- "line": 2236,
341
+ "line": 2261,
342
342
  "character": 2
343
343
  }
344
344
  ],
@@ -356,7 +356,7 @@
356
356
  "sources": [
357
357
  {
358
358
  "fileName": "SiteApiSchema.ts",
359
- "line": 2235,
359
+ "line": 2260,
360
360
  "character": 2
361
361
  }
362
362
  ],
@@ -374,7 +374,7 @@
374
374
  "sources": [
375
375
  {
376
376
  "fileName": "SiteApiSchema.ts",
377
- "line": 2237,
377
+ "line": 2262,
378
378
  "character": 2
379
379
  }
380
380
  ],
@@ -392,7 +392,7 @@
392
392
  "sources": [
393
393
  {
394
394
  "fileName": "SiteApiSchema.ts",
395
- "line": 2234,
395
+ "line": 2259,
396
396
  "character": 2
397
397
  }
398
398
  ],
@@ -417,7 +417,7 @@
417
417
  "sources": [
418
418
  {
419
419
  "fileName": "SiteApiSchema.ts",
420
- "line": 2233,
420
+ "line": 2258,
421
421
  "character": 17
422
422
  }
423
423
  ]
@@ -442,7 +442,7 @@
442
442
  "sources": [
443
443
  {
444
444
  "fileName": "SiteApiSchema.ts",
445
- "line": 3130,
445
+ "line": 3165,
446
446
  "character": 2
447
447
  }
448
448
  ],
@@ -460,7 +460,7 @@
460
460
  "sources": [
461
461
  {
462
462
  "fileName": "SiteApiSchema.ts",
463
- "line": 3129,
463
+ "line": 3164,
464
464
  "character": 2
465
465
  }
466
466
  ],
@@ -478,7 +478,7 @@
478
478
  "sources": [
479
479
  {
480
480
  "fileName": "SiteApiSchema.ts",
481
- "line": 3131,
481
+ "line": 3166,
482
482
  "character": 2
483
483
  }
484
484
  ],
@@ -496,7 +496,7 @@
496
496
  "sources": [
497
497
  {
498
498
  "fileName": "SiteApiSchema.ts",
499
- "line": 3128,
499
+ "line": 3163,
500
500
  "character": 2
501
501
  }
502
502
  ],
@@ -521,7 +521,7 @@
521
521
  "sources": [
522
522
  {
523
523
  "fileName": "SiteApiSchema.ts",
524
- "line": 3127,
524
+ "line": 3162,
525
525
  "character": 17
526
526
  }
527
527
  ]
@@ -546,7 +546,7 @@
546
546
  "sources": [
547
547
  {
548
548
  "fileName": "SiteApiSchema.ts",
549
- "line": 924,
549
+ "line": 930,
550
550
  "character": 2
551
551
  }
552
552
  ],
@@ -564,7 +564,7 @@
564
564
  "sources": [
565
565
  {
566
566
  "fileName": "SiteApiSchema.ts",
567
- "line": 923,
567
+ "line": 929,
568
568
  "character": 2
569
569
  }
570
570
  ],
@@ -582,7 +582,7 @@
582
582
  "sources": [
583
583
  {
584
584
  "fileName": "SiteApiSchema.ts",
585
- "line": 926,
585
+ "line": 932,
586
586
  "character": 2
587
587
  }
588
588
  ],
@@ -600,7 +600,7 @@
600
600
  "sources": [
601
601
  {
602
602
  "fileName": "SiteApiSchema.ts",
603
- "line": 925,
603
+ "line": 931,
604
604
  "character": 2
605
605
  }
606
606
  ],
@@ -618,7 +618,7 @@
618
618
  "sources": [
619
619
  {
620
620
  "fileName": "SiteApiSchema.ts",
621
- "line": 922,
621
+ "line": 928,
622
622
  "character": 2
623
623
  }
624
624
  ],
@@ -644,7 +644,7 @@
644
644
  "sources": [
645
645
  {
646
646
  "fileName": "SiteApiSchema.ts",
647
- "line": 921,
647
+ "line": 927,
648
648
  "character": 17
649
649
  }
650
650
  ]
@@ -669,7 +669,7 @@
669
669
  "sources": [
670
670
  {
671
671
  "fileName": "SiteApiSchema.ts",
672
- "line": 5969,
672
+ "line": 6053,
673
673
  "character": 2
674
674
  }
675
675
  ],
@@ -687,7 +687,7 @@
687
687
  "sources": [
688
688
  {
689
689
  "fileName": "SiteApiSchema.ts",
690
- "line": 5968,
690
+ "line": 6052,
691
691
  "character": 2
692
692
  }
693
693
  ],
@@ -705,7 +705,7 @@
705
705
  "sources": [
706
706
  {
707
707
  "fileName": "SiteApiSchema.ts",
708
- "line": 5970,
708
+ "line": 6054,
709
709
  "character": 2
710
710
  }
711
711
  ],
@@ -723,7 +723,7 @@
723
723
  "sources": [
724
724
  {
725
725
  "fileName": "SiteApiSchema.ts",
726
- "line": 5967,
726
+ "line": 6051,
727
727
  "character": 2
728
728
  }
729
729
  ],
@@ -748,7 +748,7 @@
748
748
  "sources": [
749
749
  {
750
750
  "fileName": "SiteApiSchema.ts",
751
- "line": 5966,
751
+ "line": 6050,
752
752
  "character": 17
753
753
  }
754
754
  ]
@@ -773,7 +773,7 @@
773
773
  "sources": [
774
774
  {
775
775
  "fileName": "SiteApiSchema.ts",
776
- "line": 1699,
776
+ "line": 1717,
777
777
  "character": 2
778
778
  }
779
779
  ],
@@ -791,7 +791,7 @@
791
791
  "sources": [
792
792
  {
793
793
  "fileName": "SiteApiSchema.ts",
794
- "line": 1698,
794
+ "line": 1716,
795
795
  "character": 2
796
796
  }
797
797
  ],
@@ -809,7 +809,7 @@
809
809
  "sources": [
810
810
  {
811
811
  "fileName": "SiteApiSchema.ts",
812
- "line": 1701,
812
+ "line": 1719,
813
813
  "character": 2
814
814
  }
815
815
  ],
@@ -827,7 +827,7 @@
827
827
  "sources": [
828
828
  {
829
829
  "fileName": "SiteApiSchema.ts",
830
- "line": 1700,
830
+ "line": 1718,
831
831
  "character": 2
832
832
  }
833
833
  ],
@@ -845,7 +845,7 @@
845
845
  "sources": [
846
846
  {
847
847
  "fileName": "SiteApiSchema.ts",
848
- "line": 1697,
848
+ "line": 1715,
849
849
  "character": 2
850
850
  }
851
851
  ],
@@ -871,7 +871,7 @@
871
871
  "sources": [
872
872
  {
873
873
  "fileName": "SiteApiSchema.ts",
874
- "line": 1696,
874
+ "line": 1714,
875
875
  "character": 17
876
876
  }
877
877
  ]
@@ -896,7 +896,7 @@
896
896
  "sources": [
897
897
  {
898
898
  "fileName": "SiteApiSchema.ts",
899
- "line": 3998,
899
+ "line": 4044,
900
900
  "character": 2
901
901
  }
902
902
  ],
@@ -914,7 +914,7 @@
914
914
  "sources": [
915
915
  {
916
916
  "fileName": "SiteApiSchema.ts",
917
- "line": 3997,
917
+ "line": 4043,
918
918
  "character": 2
919
919
  }
920
920
  ],
@@ -932,7 +932,7 @@
932
932
  "sources": [
933
933
  {
934
934
  "fileName": "SiteApiSchema.ts",
935
- "line": 3999,
935
+ "line": 4045,
936
936
  "character": 2
937
937
  }
938
938
  ],
@@ -950,7 +950,7 @@
950
950
  "sources": [
951
951
  {
952
952
  "fileName": "SiteApiSchema.ts",
953
- "line": 3996,
953
+ "line": 4042,
954
954
  "character": 2
955
955
  }
956
956
  ],
@@ -975,7 +975,7 @@
975
975
  "sources": [
976
976
  {
977
977
  "fileName": "SiteApiSchema.ts",
978
- "line": 3995,
978
+ "line": 4041,
979
979
  "character": 17
980
980
  }
981
981
  ]
@@ -987,7 +987,7 @@
987
987
  "kindString": "Interface",
988
988
  "flags": {},
989
989
  "comment": {
990
- "shortText": "A DatoCMS administrative area can be accessed by multiple people. Every collaborator is\nlinked to a specific Role, which describes what actions it will be able to perform once\nlogged in.",
990
+ "shortText": "A DatoCMS administrative area can be accessed by multiple people. Every collaborator\nis linked to a specific Role, which describes what actions it will be able to perform\nonce logged in.",
991
991
  "text": "This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` \"user\".\n"
992
992
  },
993
993
  "children": [
@@ -1000,7 +1000,7 @@
1000
1000
  "sources": [
1001
1001
  {
1002
1002
  "fileName": "SiteApiSchema.ts",
1003
- "line": 1608,
1003
+ "line": 1626,
1004
1004
  "character": 2
1005
1005
  }
1006
1006
  ],
@@ -1018,7 +1018,7 @@
1018
1018
  "sources": [
1019
1019
  {
1020
1020
  "fileName": "SiteApiSchema.ts",
1021
- "line": 1607,
1021
+ "line": 1625,
1022
1022
  "character": 2
1023
1023
  }
1024
1024
  ],
@@ -1038,7 +1038,7 @@
1038
1038
  "sources": [
1039
1039
  {
1040
1040
  "fileName": "SiteApiSchema.ts",
1041
- "line": 1610,
1041
+ "line": 1628,
1042
1042
  "character": 2
1043
1043
  }
1044
1044
  ],
@@ -1056,7 +1056,7 @@
1056
1056
  "sources": [
1057
1057
  {
1058
1058
  "fileName": "SiteApiSchema.ts",
1059
- "line": 1609,
1059
+ "line": 1627,
1060
1060
  "character": 2
1061
1061
  }
1062
1062
  ],
@@ -1074,7 +1074,7 @@
1074
1074
  "sources": [
1075
1075
  {
1076
1076
  "fileName": "SiteApiSchema.ts",
1077
- "line": 1606,
1077
+ "line": 1624,
1078
1078
  "character": 2
1079
1079
  }
1080
1080
  ],
@@ -1100,7 +1100,7 @@
1100
1100
  "sources": [
1101
1101
  {
1102
1102
  "fileName": "SiteApiSchema.ts",
1103
- "line": 1605,
1103
+ "line": 1623,
1104
1104
  "character": 17
1105
1105
  }
1106
1106
  ]
@@ -1117,7 +1117,7 @@
1117
1117
  "sources": [
1118
1118
  {
1119
1119
  "fileName": "types.ts",
1120
- "line": 242,
1120
+ "line": 265,
1121
1121
  "character": 12
1122
1122
  }
1123
1123
  ],
@@ -1137,12 +1137,12 @@
1137
1137
  "kindString": "Property",
1138
1138
  "flags": {},
1139
1139
  "comment": {
1140
- "shortText": "ID of field extension. Will be the first argument for the `renderFieldExtension` function"
1140
+ "shortText": "ID of field extension. Will be the first argument for the\n`renderFieldExtension` function"
1141
1141
  },
1142
1142
  "sources": [
1143
1143
  {
1144
1144
  "fileName": "types.ts",
1145
- "line": 244,
1145
+ "line": 270,
1146
1146
  "character": 2
1147
1147
  }
1148
1148
  ],
@@ -1165,7 +1165,7 @@
1165
1165
  "sources": [
1166
1166
  {
1167
1167
  "fileName": "types.ts",
1168
- "line": 258,
1168
+ "line": 285,
1169
1169
  "character": 2
1170
1170
  }
1171
1171
  ],
@@ -1183,12 +1183,12 @@
1183
1183
  "isOptional": true
1184
1184
  },
1185
1185
  "comment": {
1186
- "shortText": "An arbitrary configuration object that will be passed as the `parameters` property of\nthe second argument of the `renderFieldExtension` function"
1186
+ "shortText": "An arbitrary configuration object that will be passed as the `parameters`\nproperty of the second argument of the `renderFieldExtension` function"
1187
1187
  },
1188
1188
  "sources": [
1189
1189
  {
1190
1190
  "fileName": "types.ts",
1191
- "line": 249,
1191
+ "line": 275,
1192
1192
  "character": 2
1193
1193
  }
1194
1194
  ],
@@ -1216,12 +1216,12 @@
1216
1216
  "isOptional": true
1217
1217
  },
1218
1218
  "comment": {
1219
- "shortText": "If multiple addons are present for a field, they will be sorted by ascending `rank`.\nIf you want to specify an explicit value for `rank`, make sure to offer a way for\nfinal users to customize it inside the plugin's settings form, otherwise the\nhardcoded value you choose might clash with the one of another plugin! *"
1219
+ "shortText": "If multiple addons are present for a field, they will be sorted by\nascending `rank`. If you want to specify an explicit value for `rank`, make\nsure to offer a way for final users to customize it inside the plugin's\nsettings form, otherwise the hardcoded value you choose might clash with\nthe one of another plugin! *"
1220
1220
  },
1221
1221
  "sources": [
1222
1222
  {
1223
1223
  "fileName": "types.ts",
1224
- "line": 256,
1224
+ "line": 283,
1225
1225
  "character": 2
1226
1226
  }
1227
1227
  ],
@@ -1246,7 +1246,7 @@
1246
1246
  "sources": [
1247
1247
  {
1248
1248
  "fileName": "types.ts",
1249
- "line": 242,
1249
+ "line": 265,
1250
1250
  "character": 28
1251
1251
  }
1252
1252
  ]
@@ -1265,7 +1265,7 @@
1265
1265
  "sources": [
1266
1266
  {
1267
1267
  "fileName": "types.ts",
1268
- "line": 367,
1268
+ "line": 400,
1269
1269
  "character": 12
1270
1270
  }
1271
1271
  ],
@@ -1278,36 +1278,6 @@
1278
1278
  "kindString": "Type literal",
1279
1279
  "flags": {},
1280
1280
  "children": [
1281
- {
1282
- "id": 259,
1283
- "name": "currentAccessToken",
1284
- "kind": 1024,
1285
- "kindString": "Property",
1286
- "flags": {},
1287
- "comment": {
1288
- "shortText": "The access token to perform API calls on behalf of the current user. Only available\nif `currentAccessToken` permission is granted"
1289
- },
1290
- "sources": [
1291
- {
1292
- "fileName": "types.ts",
1293
- "line": 385,
1294
- "character": 2
1295
- }
1296
- ],
1297
- "type": {
1298
- "type": "union",
1299
- "types": [
1300
- {
1301
- "type": "intrinsic",
1302
- "name": "string"
1303
- },
1304
- {
1305
- "type": "intrinsic",
1306
- "name": "undefined"
1307
- }
1308
- ]
1309
- }
1310
- },
1311
1281
  {
1312
1282
  "id": 258,
1313
1283
  "name": "currentRole",
@@ -1320,7 +1290,7 @@
1320
1290
  "sources": [
1321
1291
  {
1322
1292
  "fileName": "types.ts",
1323
- "line": 380,
1293
+ "line": 413,
1324
1294
  "character": 2
1325
1295
  }
1326
1296
  ],
@@ -1337,12 +1307,12 @@
1337
1307
  "kindString": "Property",
1338
1308
  "flags": {},
1339
1309
  "comment": {
1340
- "shortText": "The current DatoCMS user. It can either be the owner or one of the collaborators\n(regular or SSO)."
1310
+ "shortText": "The current DatoCMS user. It can either be the owner or one of the\ncollaborators (regular or SSO)."
1341
1311
  },
1342
1312
  "sources": [
1343
1313
  {
1344
1314
  "fileName": "types.ts",
1345
- "line": 378,
1315
+ "line": 411,
1346
1316
  "character": 2
1347
1317
  }
1348
1318
  ],
@@ -1367,6 +1337,36 @@
1367
1337
  ]
1368
1338
  }
1369
1339
  },
1340
+ {
1341
+ "id": 259,
1342
+ "name": "currentUserAccessToken",
1343
+ "kind": 1024,
1344
+ "kindString": "Property",
1345
+ "flags": {},
1346
+ "comment": {
1347
+ "shortText": "The access token to perform API calls on behalf of the current user. Only\navailable if `currentUserAccessToken` additional permission is granted"
1348
+ },
1349
+ "sources": [
1350
+ {
1351
+ "fileName": "types.ts",
1352
+ "line": 418,
1353
+ "character": 2
1354
+ }
1355
+ ],
1356
+ "type": {
1357
+ "type": "union",
1358
+ "types": [
1359
+ {
1360
+ "type": "intrinsic",
1361
+ "name": "string"
1362
+ },
1363
+ {
1364
+ "type": "intrinsic",
1365
+ "name": "undefined"
1366
+ }
1367
+ ]
1368
+ }
1369
+ },
1370
1370
  {
1371
1371
  "id": 255,
1372
1372
  "name": "environment",
@@ -1379,7 +1379,7 @@
1379
1379
  "sources": [
1380
1380
  {
1381
1381
  "fileName": "types.ts",
1382
- "line": 371,
1382
+ "line": 404,
1383
1383
  "character": 2
1384
1384
  }
1385
1385
  ],
@@ -1400,7 +1400,7 @@
1400
1400
  "sources": [
1401
1401
  {
1402
1402
  "fileName": "types.ts",
1403
- "line": 373,
1403
+ "line": 406,
1404
1404
  "character": 2
1405
1405
  }
1406
1406
  ],
@@ -1438,7 +1438,7 @@
1438
1438
  "sources": [
1439
1439
  {
1440
1440
  "fileName": "types.ts",
1441
- "line": 387,
1441
+ "line": 420,
1442
1442
  "character": 2
1443
1443
  }
1444
1444
  ],
@@ -1460,7 +1460,7 @@
1460
1460
  "sources": [
1461
1461
  {
1462
1462
  "fileName": "types.ts",
1463
- "line": 369,
1463
+ "line": 402,
1464
1464
  "character": 2
1465
1465
  }
1466
1466
  ],
@@ -1477,12 +1477,12 @@
1477
1477
  "kindString": "Property",
1478
1478
  "flags": {},
1479
1479
  "comment": {
1480
- "shortText": "UI preferences of the current user (right now, only the preferred locale is available)"
1480
+ "shortText": "UI preferences of the current user (right now, only the preferred locale is\navailable)"
1481
1481
  },
1482
1482
  "sources": [
1483
1483
  {
1484
1484
  "fileName": "types.ts",
1485
- "line": 389,
1485
+ "line": 425,
1486
1486
  "character": 2
1487
1487
  }
1488
1488
  ],
@@ -1507,7 +1507,7 @@
1507
1507
  "sources": [
1508
1508
  {
1509
1509
  "fileName": "types.ts",
1510
- "line": 391,
1510
+ "line": 427,
1511
1511
  "character": 4
1512
1512
  }
1513
1513
  ],
@@ -1529,7 +1529,7 @@
1529
1529
  "sources": [
1530
1530
  {
1531
1531
  "fileName": "types.ts",
1532
- "line": 389,
1532
+ "line": 425,
1533
1533
  "character": 6
1534
1534
  }
1535
1535
  ]
@@ -1542,9 +1542,9 @@
1542
1542
  "title": "Properties",
1543
1543
  "kind": 1024,
1544
1544
  "children": [
1545
- 259,
1546
1545
  258,
1547
1546
  257,
1547
+ 259,
1548
1548
  255,
1549
1549
  256,
1550
1550
  260,
@@ -1556,7 +1556,7 @@
1556
1556
  "sources": [
1557
1557
  {
1558
1558
  "fileName": "types.ts",
1559
- "line": 367,
1559
+ "line": 400,
1560
1560
  "character": 31
1561
1561
  }
1562
1562
  ]
@@ -1575,7 +1575,7 @@
1575
1575
  "sources": [
1576
1576
  {
1577
1577
  "fileName": "types.ts",
1578
- "line": 345,
1578
+ "line": 375,
1579
1579
  "character": 12
1580
1580
  }
1581
1581
  ],
@@ -1602,7 +1602,7 @@
1602
1602
  "sources": [
1603
1603
  {
1604
1604
  "fileName": "types.ts",
1605
- "line": 351,
1605
+ "line": 384,
1606
1606
  "character": 2
1607
1607
  }
1608
1608
  ],
@@ -1632,7 +1632,7 @@
1632
1632
  "sources": [
1633
1633
  {
1634
1634
  "fileName": "types.ts",
1635
- "line": 347,
1635
+ "line": 377,
1636
1636
  "character": 2
1637
1637
  }
1638
1638
  ],
@@ -1648,12 +1648,12 @@
1648
1648
  "kindString": "Property",
1649
1649
  "flags": {},
1650
1650
  "comment": {
1651
- "shortText": "The value to be returned by the `openConfirm` promise if the button is clicked by the user"
1651
+ "shortText": "The value to be returned by the `openConfirm` promise if the button is\nclicked by the user"
1652
1652
  },
1653
1653
  "sources": [
1654
1654
  {
1655
1655
  "fileName": "types.ts",
1656
- "line": 349,
1656
+ "line": 382,
1657
1657
  "character": 2
1658
1658
  }
1659
1659
  ],
@@ -1677,7 +1677,7 @@
1677
1677
  "sources": [
1678
1678
  {
1679
1679
  "fileName": "types.ts",
1680
- "line": 345,
1680
+ "line": 375,
1681
1681
  "character": 28
1682
1682
  }
1683
1683
  ]
@@ -1696,7 +1696,7 @@
1696
1696
  "sources": [
1697
1697
  {
1698
1698
  "fileName": "types.ts",
1699
- "line": 355,
1699
+ "line": 388,
1700
1700
  "character": 12
1701
1701
  }
1702
1702
  ],
@@ -1721,7 +1721,7 @@
1721
1721
  "sources": [
1722
1722
  {
1723
1723
  "fileName": "types.ts",
1724
- "line": 363,
1724
+ "line": 396,
1725
1725
  "character": 2
1726
1726
  }
1727
1727
  ],
@@ -1743,7 +1743,7 @@
1743
1743
  "sources": [
1744
1744
  {
1745
1745
  "fileName": "types.ts",
1746
- "line": 361,
1746
+ "line": 394,
1747
1747
  "character": 2
1748
1748
  }
1749
1749
  ],
@@ -1768,7 +1768,7 @@
1768
1768
  "sources": [
1769
1769
  {
1770
1770
  "fileName": "types.ts",
1771
- "line": 359,
1771
+ "line": 392,
1772
1772
  "character": 2
1773
1773
  }
1774
1774
  ],
@@ -1789,7 +1789,7 @@
1789
1789
  "sources": [
1790
1790
  {
1791
1791
  "fileName": "types.ts",
1792
- "line": 357,
1792
+ "line": 390,
1793
1793
  "character": 2
1794
1794
  }
1795
1795
  ],
@@ -1814,7 +1814,7 @@
1814
1814
  "sources": [
1815
1815
  {
1816
1816
  "fileName": "types.ts",
1817
- "line": 355,
1817
+ "line": 388,
1818
1818
  "character": 29
1819
1819
  }
1820
1820
  ]
@@ -1828,12 +1828,12 @@
1828
1828
  "kindString": "Type alias",
1829
1829
  "flags": {},
1830
1830
  "comment": {
1831
- "shortText": "The sidebar in the Content Area presents a number of user-defined menu-items. This\nobject represents a new item to be added in the sidebar."
1831
+ "shortText": "The sidebar in the Content Area presents a number of user-defined menu-items.\nThis object represents a new item to be added in the sidebar."
1832
1832
  },
1833
1833
  "sources": [
1834
1834
  {
1835
1835
  "fileName": "types.ts",
1836
- "line": 120,
1836
+ "line": 127,
1837
1837
  "character": 12
1838
1838
  }
1839
1839
  ],
@@ -1858,7 +1858,7 @@
1858
1858
  "sources": [
1859
1859
  {
1860
1860
  "fileName": "types.ts",
1861
- "line": 124,
1861
+ "line": 131,
1862
1862
  "character": 2
1863
1863
  }
1864
1864
  ],
@@ -1879,7 +1879,7 @@
1879
1879
  "sources": [
1880
1880
  {
1881
1881
  "fileName": "types.ts",
1882
- "line": 122,
1882
+ "line": 129,
1883
1883
  "character": 2
1884
1884
  }
1885
1885
  ],
@@ -1897,12 +1897,12 @@
1897
1897
  "isOptional": true
1898
1898
  },
1899
1899
  "comment": {
1900
- "shortText": "Expresses where you want the item to be placed inside the sidebar. If not specified,\nthe item will be placed after the standard items provided by DatoCMS itself."
1900
+ "shortText": "Expresses where you want the item to be placed inside the sidebar. If not\nspecified, the item will be placed after the standard items provided by\nDatoCMS itself."
1901
1901
  },
1902
1902
  "sources": [
1903
1903
  {
1904
1904
  "fileName": "types.ts",
1905
- "line": 133,
1905
+ "line": 141,
1906
1906
  "character": 2
1907
1907
  }
1908
1908
  ],
@@ -1950,7 +1950,7 @@
1950
1950
  "sources": [
1951
1951
  {
1952
1952
  "fileName": "types.ts",
1953
- "line": 126,
1953
+ "line": 133,
1954
1954
  "character": 2
1955
1955
  }
1956
1956
  ],
@@ -1972,7 +1972,7 @@
1972
1972
  "sources": [
1973
1973
  {
1974
1974
  "fileName": "types.ts",
1975
- "line": 127,
1975
+ "line": 134,
1976
1976
  "character": 4
1977
1977
  }
1978
1978
  ],
@@ -1994,7 +1994,7 @@
1994
1994
  "sources": [
1995
1995
  {
1996
1996
  "fileName": "types.ts",
1997
- "line": 126,
1997
+ "line": 133,
1998
1998
  "character": 12
1999
1999
  }
2000
2000
  ]
@@ -2010,12 +2010,12 @@
2010
2010
  "isOptional": true
2011
2011
  },
2012
2012
  "comment": {
2013
- "shortText": "If different plugins specify the same `placement` for their panels, they will be\ndisplayed by ascending `rank`. If you want to specify an explicit value for `rank`,\nmake sure to offer a way for final users to customize it inside the plugin's settings\nform, otherwise the hardcoded value you choose might clash with the one of another plugin! *"
2013
+ "shortText": "If different plugins specify the same `placement` for their panels, they\nwill be displayed by ascending `rank`. If you want to specify an explicit\nvalue for `rank`, make sure to offer a way for final users to customize it\ninside the plugin's settings form, otherwise the hardcoded value you choose\nmight clash with the one of another plugin! *"
2014
2014
  },
2015
2015
  "sources": [
2016
2016
  {
2017
2017
  "fileName": "types.ts",
2018
- "line": 140,
2018
+ "line": 149,
2019
2019
  "character": 2
2020
2020
  }
2021
2021
  ],
@@ -2041,7 +2041,7 @@
2041
2041
  "sources": [
2042
2042
  {
2043
2043
  "fileName": "types.ts",
2044
- "line": 120,
2044
+ "line": 127,
2045
2045
  "character": 37
2046
2046
  }
2047
2047
  ]
@@ -2060,7 +2060,7 @@
2060
2060
  "sources": [
2061
2061
  {
2062
2062
  "fileName": "types.ts",
2063
- "line": 757,
2063
+ "line": 864,
2064
2064
  "character": 12
2065
2065
  }
2066
2066
  ],
@@ -2082,7 +2082,7 @@
2082
2082
  "sources": [
2083
2083
  {
2084
2084
  "fileName": "types.ts",
2085
- "line": 810,
2085
+ "line": 923,
2086
2086
  "character": 2
2087
2087
  }
2088
2088
  ],
@@ -2094,11 +2094,11 @@
2094
2094
  "kindString": "Call signature",
2095
2095
  "flags": {},
2096
2096
  "comment": {
2097
- "shortText": "Opens a UI-consistent confirmation dialog. Returns a promise resolved with the value\nof the choice made by the user",
2097
+ "shortText": "Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user",
2098
2098
  "tags": [
2099
2099
  {
2100
2100
  "tag": "example",
2101
- "text": "\n const result = await ctx.openConfirm({\n title: 'Custom title',\n content:\n 'Lorem Ipsum is simply dummy text of the printing and typesetting industry',\n choices: [\n {\n label: 'Positive',\n value: 'positive',\n intent: 'positive',\n },\n {\n label: 'Negative',\n value: 'negative',\n intent: 'negative',\n },\n ],\n cancel: {\n label: 'Cancel',\n value: false,\n },\n });\n\n if (result) {\n ctx.notice(`Success! ${result}`);\n } else {\n ctx.alert('Cancelled!');\n }\n"
2101
+ "text": "\n\n```js\nconst result = await ctx.openConfirm({\n title: 'Custom title',\n content:\n 'Lorem Ipsum is simply dummy text of the printing and typesetting industry',\n choices: [\n {\n label: 'Positive',\n value: 'positive',\n intent: 'positive',\n },\n {\n label: 'Negative',\n value: 'negative',\n intent: 'negative',\n },\n ],\n cancel: {\n label: 'Cancel',\n value: false,\n },\n});\n\nif (result) {\n ctx.notice(`Success! ${result}`);\n} else {\n ctx.alert('Cancelled!');\n}\n```\n"
2102
2102
  }
2103
2103
  ]
2104
2104
  },
@@ -2138,7 +2138,7 @@
2138
2138
  "sources": [
2139
2139
  {
2140
2140
  "fileName": "types.ts",
2141
- "line": 776,
2141
+ "line": 886,
2142
2142
  "character": 2
2143
2143
  }
2144
2144
  ],
@@ -2150,11 +2150,11 @@
2150
2150
  "kindString": "Call signature",
2151
2151
  "flags": {},
2152
2152
  "comment": {
2153
- "shortText": "Opens a custom modal. Returns a promise resolved with what the modal itself returns\ncalling the `resolve()` function",
2153
+ "shortText": "Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function",
2154
2154
  "tags": [
2155
2155
  {
2156
2156
  "tag": "example",
2157
- "text": "\n const result = await ctx.openModal({\n id: 'regular',\n title: 'Custom title!',\n width: 'l',\n parameters: { foo: 'bar' },\n });\n\n if (result) {\n ctx.notice(`Success! ${JSON.stringify(result)}`);\n } else {\n ctx.alert('Closed!');\n }\n"
2157
+ "text": "\n\n```js\nconst result = await ctx.openModal({\n id: 'regular',\n title: 'Custom title!',\n width: 'l',\n parameters: { foo: 'bar' },\n});\n\nif (result) {\n ctx.notice(`Success! ${JSON.stringify(result)}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
2158
2158
  }
2159
2159
  ]
2160
2160
  },
@@ -2199,7 +2199,7 @@
2199
2199
  "sources": [
2200
2200
  {
2201
2201
  "fileName": "types.ts",
2202
- "line": 757,
2202
+ "line": 864,
2203
2203
  "character": 34
2204
2204
  }
2205
2205
  ]
@@ -2218,7 +2218,7 @@
2218
2218
  "sources": [
2219
2219
  {
2220
2220
  "fileName": "types.ts",
2221
- "line": 218,
2221
+ "line": 237,
2222
2222
  "character": 12
2223
2223
  }
2224
2224
  ],
@@ -2245,7 +2245,7 @@
2245
2245
  "sources": [
2246
2246
  {
2247
2247
  "fileName": "types.ts",
2248
- "line": 222,
2248
+ "line": 244,
2249
2249
  "character": 2
2250
2250
  }
2251
2251
  ],
@@ -2276,7 +2276,7 @@
2276
2276
  "sources": [
2277
2277
  {
2278
2278
  "fileName": "types.ts",
2279
- "line": 224,
2279
+ "line": 246,
2280
2280
  "character": 29
2281
2281
  }
2282
2282
  ],
@@ -2297,7 +2297,7 @@
2297
2297
  "sources": [
2298
2298
  {
2299
2299
  "fileName": "types.ts",
2300
- "line": 224,
2300
+ "line": 246,
2301
2301
  "character": 8
2302
2302
  }
2303
2303
  ],
@@ -2320,7 +2320,7 @@
2320
2320
  "sources": [
2321
2321
  {
2322
2322
  "fileName": "types.ts",
2323
- "line": 224,
2323
+ "line": 246,
2324
2324
  "character": 6
2325
2325
  }
2326
2326
  ]
@@ -2336,12 +2336,12 @@
2336
2336
  "kindString": "Property",
2337
2337
  "flags": {},
2338
2338
  "comment": {
2339
- "shortText": "ID of field extension. Will be the first argument for the `renderFieldExtension` function"
2339
+ "shortText": "ID of field extension. Will be the first argument for the\n`renderFieldExtension` function"
2340
2340
  },
2341
2341
  "sources": [
2342
2342
  {
2343
2343
  "fileName": "types.ts",
2344
- "line": 220,
2344
+ "line": 242,
2345
2345
  "character": 2
2346
2346
  }
2347
2347
  ],
@@ -2364,7 +2364,7 @@
2364
2364
  "sources": [
2365
2365
  {
2366
2366
  "fileName": "types.ts",
2367
- "line": 238,
2367
+ "line": 261,
2368
2368
  "character": 2
2369
2369
  }
2370
2370
  ],
@@ -2382,12 +2382,12 @@
2382
2382
  "isOptional": true
2383
2383
  },
2384
2384
  "comment": {
2385
- "shortText": "An arbitrary configuration object that will be passed as the `parameters` property of\nthe second argument of the `renderFieldExtension` function"
2385
+ "shortText": "An arbitrary configuration object that will be passed as the `parameters`\nproperty of the second argument of the `renderFieldExtension` function"
2386
2386
  },
2387
2387
  "sources": [
2388
2388
  {
2389
2389
  "fileName": "types.ts",
2390
- "line": 229,
2390
+ "line": 251,
2391
2391
  "character": 2
2392
2392
  }
2393
2393
  ],
@@ -2415,12 +2415,12 @@
2415
2415
  "isOptional": true
2416
2416
  },
2417
2417
  "comment": {
2418
- "shortText": "If multiple plugins override a field, the one with the highest `rank` will win. If\nyou want to specify an explicit value for `rank`, make sure to offer a way for final\nusers to customize it inside the plugin's settings form, otherwise the hardcoded\nvalue you choose might clash with the one of another plugin! *"
2418
+ "shortText": "If multiple plugins override a field, the one with the highest `rank` will\nwin. If you want to specify an explicit value for `rank`, make sure to\noffer a way for final users to customize it inside the plugin's settings\nform, otherwise the hardcoded value you choose might clash with the one of\nanother plugin! *"
2419
2419
  },
2420
2420
  "sources": [
2421
2421
  {
2422
2422
  "fileName": "types.ts",
2423
- "line": 236,
2423
+ "line": 259,
2424
2424
  "character": 2
2425
2425
  }
2426
2426
  ],
@@ -2446,7 +2446,7 @@
2446
2446
  "sources": [
2447
2447
  {
2448
2448
  "fileName": "types.ts",
2449
- "line": 218,
2449
+ "line": 237,
2450
2450
  "character": 29
2451
2451
  }
2452
2452
  ]
@@ -2462,7 +2462,7 @@
2462
2462
  "sources": [
2463
2463
  {
2464
2464
  "fileName": "types.ts",
2465
- "line": 438,
2465
+ "line": 475,
2466
2466
  "character": 12
2467
2467
  }
2468
2468
  ],
@@ -2487,7 +2487,7 @@
2487
2487
  "sources": [
2488
2488
  {
2489
2489
  "fileName": "types.ts",
2490
- "line": 440,
2490
+ "line": 477,
2491
2491
  "character": 6
2492
2492
  }
2493
2493
  ],
@@ -2509,7 +2509,7 @@
2509
2509
  "sources": [
2510
2510
  {
2511
2511
  "fileName": "types.ts",
2512
- "line": 439,
2512
+ "line": 476,
2513
2513
  "character": 4
2514
2514
  }
2515
2515
  ]
@@ -2535,7 +2535,7 @@
2535
2535
  "sources": [
2536
2536
  {
2537
2537
  "fileName": "types.ts",
2538
- "line": 444,
2538
+ "line": 481,
2539
2539
  "character": 6
2540
2540
  }
2541
2541
  ],
@@ -2555,7 +2555,7 @@
2555
2555
  "sources": [
2556
2556
  {
2557
2557
  "fileName": "types.ts",
2558
- "line": 445,
2558
+ "line": 482,
2559
2559
  "character": 6
2560
2560
  }
2561
2561
  ],
@@ -2583,7 +2583,7 @@
2583
2583
  "sources": [
2584
2584
  {
2585
2585
  "fileName": "types.ts",
2586
- "line": 443,
2586
+ "line": 480,
2587
2587
  "character": 6
2588
2588
  }
2589
2589
  ],
@@ -2607,7 +2607,7 @@
2607
2607
  "sources": [
2608
2608
  {
2609
2609
  "fileName": "types.ts",
2610
- "line": 442,
2610
+ "line": 479,
2611
2611
  "character": 4
2612
2612
  }
2613
2613
  ]
@@ -2631,7 +2631,7 @@
2631
2631
  "sources": [
2632
2632
  {
2633
2633
  "fileName": "types.ts",
2634
- "line": 449,
2634
+ "line": 486,
2635
2635
  "character": 6
2636
2636
  }
2637
2637
  ],
@@ -2649,7 +2649,7 @@
2649
2649
  "sources": [
2650
2650
  {
2651
2651
  "fileName": "types.ts",
2652
- "line": 448,
2652
+ "line": 485,
2653
2653
  "character": 6
2654
2654
  }
2655
2655
  ],
@@ -2667,7 +2667,7 @@
2667
2667
  "sources": [
2668
2668
  {
2669
2669
  "fileName": "types.ts",
2670
- "line": 450,
2670
+ "line": 487,
2671
2671
  "character": 6
2672
2672
  }
2673
2673
  ],
@@ -2701,7 +2701,7 @@
2701
2701
  "sources": [
2702
2702
  {
2703
2703
  "fileName": "types.ts",
2704
- "line": 447,
2704
+ "line": 484,
2705
2705
  "character": 4
2706
2706
  }
2707
2707
  ]
@@ -2725,7 +2725,7 @@
2725
2725
  "sources": [
2726
2726
  {
2727
2727
  "fileName": "types.ts",
2728
- "line": 454,
2728
+ "line": 491,
2729
2729
  "character": 6
2730
2730
  }
2731
2731
  ],
@@ -2743,7 +2743,7 @@
2743
2743
  "sources": [
2744
2744
  {
2745
2745
  "fileName": "types.ts",
2746
- "line": 453,
2746
+ "line": 490,
2747
2747
  "character": 6
2748
2748
  }
2749
2749
  ],
@@ -2766,7 +2766,7 @@
2766
2766
  "sources": [
2767
2767
  {
2768
2768
  "fileName": "types.ts",
2769
- "line": 452,
2769
+ "line": 489,
2770
2770
  "character": 4
2771
2771
  }
2772
2772
  ]
@@ -2790,7 +2790,7 @@
2790
2790
  "sources": [
2791
2791
  {
2792
2792
  "fileName": "types.ts",
2793
- "line": 458,
2793
+ "line": 495,
2794
2794
  "character": 6
2795
2795
  }
2796
2796
  ],
@@ -2810,7 +2810,7 @@
2810
2810
  "sources": [
2811
2811
  {
2812
2812
  "fileName": "types.ts",
2813
- "line": 459,
2813
+ "line": 496,
2814
2814
  "character": 6
2815
2815
  }
2816
2816
  ],
@@ -2830,7 +2830,7 @@
2830
2830
  "sources": [
2831
2831
  {
2832
2832
  "fileName": "types.ts",
2833
- "line": 460,
2833
+ "line": 497,
2834
2834
  "character": 6
2835
2835
  }
2836
2836
  ],
@@ -2858,7 +2858,7 @@
2858
2858
  "sources": [
2859
2859
  {
2860
2860
  "fileName": "types.ts",
2861
- "line": 457,
2861
+ "line": 494,
2862
2862
  "character": 6
2863
2863
  }
2864
2864
  ],
@@ -2883,7 +2883,7 @@
2883
2883
  "sources": [
2884
2884
  {
2885
2885
  "fileName": "types.ts",
2886
- "line": 456,
2886
+ "line": 493,
2887
2887
  "character": 4
2888
2888
  }
2889
2889
  ]
@@ -2907,7 +2907,7 @@
2907
2907
  "sources": [
2908
2908
  {
2909
2909
  "fileName": "types.ts",
2910
- "line": 465,
2910
+ "line": 502,
2911
2911
  "character": 6
2912
2912
  }
2913
2913
  ],
@@ -2925,7 +2925,7 @@
2925
2925
  "sources": [
2926
2926
  {
2927
2927
  "fileName": "types.ts",
2928
- "line": 464,
2928
+ "line": 501,
2929
2929
  "character": 6
2930
2930
  }
2931
2931
  ],
@@ -2943,7 +2943,7 @@
2943
2943
  "sources": [
2944
2944
  {
2945
2945
  "fileName": "types.ts",
2946
- "line": 463,
2946
+ "line": 500,
2947
2947
  "character": 6
2948
2948
  }
2949
2949
  ],
@@ -2961,7 +2961,7 @@
2961
2961
  "sources": [
2962
2962
  {
2963
2963
  "fileName": "types.ts",
2964
- "line": 466,
2964
+ "line": 503,
2965
2965
  "character": 6
2966
2966
  }
2967
2967
  ],
@@ -2996,7 +2996,7 @@
2996
2996
  "sources": [
2997
2997
  {
2998
2998
  "fileName": "types.ts",
2999
- "line": 462,
2999
+ "line": 499,
3000
3000
  "character": 4
3001
3001
  }
3002
3002
  ]
@@ -3017,7 +3017,7 @@
3017
3017
  "sources": [
3018
3018
  {
3019
3019
  "fileName": "types.ts",
3020
- "line": 262,
3020
+ "line": 289,
3021
3021
  "character": 12
3022
3022
  }
3023
3023
  ],
@@ -3044,7 +3044,7 @@
3044
3044
  "sources": [
3045
3045
  {
3046
3046
  "fileName": "types.ts",
3047
- "line": 266,
3047
+ "line": 293,
3048
3048
  "character": 2
3049
3049
  }
3050
3050
  ],
@@ -3071,7 +3071,7 @@
3071
3071
  "sources": [
3072
3072
  {
3073
3073
  "fileName": "types.ts",
3074
- "line": 264,
3074
+ "line": 291,
3075
3075
  "character": 2
3076
3076
  }
3077
3077
  ],
@@ -3095,7 +3095,7 @@
3095
3095
  "sources": [
3096
3096
  {
3097
3097
  "fileName": "types.ts",
3098
- "line": 262,
3098
+ "line": 289,
3099
3099
  "character": 37
3100
3100
  }
3101
3101
  ]
@@ -3111,7 +3111,7 @@
3111
3111
  "sources": [
3112
3112
  {
3113
3113
  "fileName": "types.ts",
3114
- "line": 148,
3114
+ "line": 157,
3115
3115
  "character": 12
3116
3116
  }
3117
3117
  ],
@@ -3212,7 +3212,7 @@
3212
3212
  "sources": [
3213
3213
  {
3214
3214
  "fileName": "types.ts",
3215
- "line": 287,
3215
+ "line": 314,
3216
3216
  "character": 12
3217
3217
  }
3218
3218
  ],
@@ -3237,7 +3237,7 @@
3237
3237
  "sources": [
3238
3238
  {
3239
3239
  "fileName": "types.ts",
3240
- "line": 292,
3240
+ "line": 319,
3241
3241
  "character": 2
3242
3242
  }
3243
3243
  ],
@@ -3267,7 +3267,7 @@
3267
3267
  "sources": [
3268
3268
  {
3269
3269
  "fileName": "types.ts",
3270
- "line": 300,
3270
+ "line": 327,
3271
3271
  "character": 2
3272
3272
  }
3273
3273
  ],
@@ -3298,7 +3298,7 @@
3298
3298
  "sources": [
3299
3299
  {
3300
3300
  "fileName": "types.ts",
3301
- "line": 297,
3301
+ "line": 324,
3302
3302
  "character": 2
3303
3303
  }
3304
3304
  ],
@@ -3329,7 +3329,7 @@
3329
3329
  "sources": [
3330
3330
  {
3331
3331
  "fileName": "types.ts",
3332
- "line": 294,
3332
+ "line": 321,
3333
3333
  "character": 2
3334
3334
  }
3335
3335
  ],
@@ -3359,7 +3359,7 @@
3359
3359
  "sources": [
3360
3360
  {
3361
3361
  "fileName": "types.ts",
3362
- "line": 290,
3362
+ "line": 317,
3363
3363
  "character": 2
3364
3364
  }
3365
3365
  ],
@@ -3385,7 +3385,7 @@
3385
3385
  "sources": [
3386
3386
  {
3387
3387
  "fileName": "types.ts",
3388
- "line": 287,
3388
+ "line": 314,
3389
3389
  "character": 29
3390
3390
  }
3391
3391
  ]
@@ -3404,7 +3404,7 @@
3404
3404
  "sources": [
3405
3405
  {
3406
3406
  "fileName": "types.ts",
3407
- "line": 279,
3407
+ "line": 306,
3408
3408
  "character": 12
3409
3409
  }
3410
3410
  ],
@@ -3429,7 +3429,7 @@
3429
3429
  "sources": [
3430
3430
  {
3431
3431
  "fileName": "types.ts",
3432
- "line": 281,
3432
+ "line": 308,
3433
3433
  "character": 2
3434
3434
  }
3435
3435
  ],
@@ -3450,7 +3450,7 @@
3450
3450
  "sources": [
3451
3451
  {
3452
3452
  "fileName": "types.ts",
3453
- "line": 283,
3453
+ "line": 310,
3454
3454
  "character": 2
3455
3455
  }
3456
3456
  ],
@@ -3473,7 +3473,7 @@
3473
3473
  "sources": [
3474
3474
  {
3475
3475
  "fileName": "types.ts",
3476
- "line": 279,
3476
+ "line": 306,
3477
3477
  "character": 25
3478
3478
  }
3479
3479
  ]
@@ -4414,7 +4414,7 @@
4414
4414
  "sources": [
4415
4415
  {
4416
4416
  "fileName": "types.ts",
4417
- "line": 825,
4417
+ "line": 941,
4418
4418
  "character": 12
4419
4419
  }
4420
4420
  ],
@@ -4436,7 +4436,7 @@
4436
4436
  "sources": [
4437
4437
  {
4438
4438
  "fileName": "types.ts",
4439
- "line": 827,
4439
+ "line": 943,
4440
4440
  "character": 2
4441
4441
  }
4442
4442
  ],
@@ -4489,7 +4489,7 @@
4489
4489
  "sources": [
4490
4490
  {
4491
4491
  "fileName": "types.ts",
4492
- "line": 825,
4492
+ "line": 941,
4493
4493
  "character": 28
4494
4494
  }
4495
4495
  ]
@@ -4505,7 +4505,7 @@
4505
4505
  "sources": [
4506
4506
  {
4507
4507
  "fileName": "types.ts",
4508
- "line": 395,
4508
+ "line": 431,
4509
4509
  "character": 12
4510
4510
  }
4511
4511
  ],
@@ -4527,7 +4527,7 @@
4527
4527
  "sources": [
4528
4528
  {
4529
4529
  "fileName": "types.ts",
4530
- "line": 396,
4530
+ "line": 432,
4531
4531
  "character": 2
4532
4532
  }
4533
4533
  ],
@@ -4549,7 +4549,7 @@
4549
4549
  "sources": [
4550
4550
  {
4551
4551
  "fileName": "types.ts",
4552
- "line": 395,
4552
+ "line": 431,
4553
4553
  "character": 39
4554
4554
  }
4555
4555
  ]
@@ -4565,7 +4565,7 @@
4565
4565
  "sources": [
4566
4566
  {
4567
4567
  "fileName": "types.ts",
4568
- "line": 401,
4568
+ "line": 437,
4569
4569
  "character": 12
4570
4570
  }
4571
4571
  ],
@@ -4587,7 +4587,7 @@
4587
4587
  "sources": [
4588
4588
  {
4589
4589
  "fileName": "types.ts",
4590
- "line": 402,
4590
+ "line": 438,
4591
4591
  "character": 2
4592
4592
  }
4593
4593
  ],
@@ -4625,7 +4625,7 @@
4625
4625
  "sources": [
4626
4626
  {
4627
4627
  "fileName": "types.ts",
4628
- "line": 401,
4628
+ "line": 437,
4629
4629
  "character": 26
4630
4630
  }
4631
4631
  ]
@@ -4641,7 +4641,7 @@
4641
4641
  "sources": [
4642
4642
  {
4643
4643
  "fileName": "types.ts",
4644
- "line": 399,
4644
+ "line": 435,
4645
4645
  "character": 12
4646
4646
  }
4647
4647
  ],
@@ -4670,7 +4670,7 @@
4670
4670
  "sources": [
4671
4671
  {
4672
4672
  "fileName": "types.ts",
4673
- "line": 405,
4673
+ "line": 441,
4674
4674
  "character": 12
4675
4675
  }
4676
4676
  ],
@@ -4721,7 +4721,7 @@
4721
4721
  "sources": [
4722
4722
  {
4723
4723
  "fileName": "types.ts",
4724
- "line": 588,
4724
+ "line": 652,
4725
4725
  "character": 12
4726
4726
  }
4727
4727
  ],
@@ -4743,7 +4743,7 @@
4743
4743
  "sources": [
4744
4744
  {
4745
4745
  "fileName": "types.ts",
4746
- "line": 621,
4746
+ "line": 693,
4747
4747
  "character": 2
4748
4748
  }
4749
4749
  ],
@@ -4758,7 +4758,7 @@
4758
4758
  "sources": [
4759
4759
  {
4760
4760
  "fileName": "types.ts",
4761
- "line": 621,
4761
+ "line": 693,
4762
4762
  "character": 14
4763
4763
  }
4764
4764
  ],
@@ -4770,11 +4770,11 @@
4770
4770
  "kindString": "Call signature",
4771
4771
  "flags": {},
4772
4772
  "comment": {
4773
- "shortText": "Opens a dialog for selecting one (or multiple) record(s) from a list of existing\nrecords of type `itemTypeId`. It returns a promise resolved with the selected\nrecord(s), or `null` if the user closes the dialog without choosing any record.",
4773
+ "shortText": "Opens a dialog for selecting one (or multiple) record(s) from a list of\nexisting records of type `itemTypeId`. It returns a promise resolved with\nthe selected record(s), or `null` if the user closes the dialog without\nchoosing any record.",
4774
4774
  "tags": [
4775
4775
  {
4776
4776
  "tag": "example",
4777
- "text": "\n const itemTypeId = prompt('Please insert a model ID:');\n\n const items = await ctx.selectItem(itemTypeId, { multiple: true });\n\n if (items) {\n ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n } else {\n ctx.alert('Closed!');\n }\n"
4777
+ "text": "\n\n```js\nconst itemTypeId = prompt('Please insert a model ID:');\n\nconst items = await ctx.selectItem(itemTypeId, { multiple: true });\n\nif (items) {\n ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
4778
4778
  }
4779
4779
  ]
4780
4780
  },
@@ -4814,7 +4814,7 @@
4814
4814
  "sources": [
4815
4815
  {
4816
4816
  "fileName": "types.ts",
4817
- "line": 622,
4817
+ "line": 694,
4818
4818
  "character": 36
4819
4819
  }
4820
4820
  ],
@@ -4868,11 +4868,11 @@
4868
4868
  "kindString": "Call signature",
4869
4869
  "flags": {},
4870
4870
  "comment": {
4871
- "shortText": "Opens a dialog for selecting one (or multiple) record(s) from a list of existing\nrecords of type `itemTypeId`. It returns a promise resolved with the selected\nrecord(s), or `null` if the user closes the dialog without choosing any record.",
4871
+ "shortText": "Opens a dialog for selecting one (or multiple) record(s) from a list of\nexisting records of type `itemTypeId`. It returns a promise resolved with\nthe selected record(s), or `null` if the user closes the dialog without\nchoosing any record.",
4872
4872
  "tags": [
4873
4873
  {
4874
4874
  "tag": "example",
4875
- "text": "\n const itemTypeId = prompt('Please insert a model ID:');\n\n const items = await ctx.selectItem(itemTypeId, { multiple: true });\n\n if (items) {\n ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n } else {\n ctx.alert('Closed!');\n }\n"
4875
+ "text": "\n\n```js\nconst itemTypeId = prompt('Please insert a model ID:');\n\nconst items = await ctx.selectItem(itemTypeId, { multiple: true });\n\nif (items) {\n ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
4876
4876
  }
4877
4877
  ]
4878
4878
  },
@@ -4914,7 +4914,7 @@
4914
4914
  "sources": [
4915
4915
  {
4916
4916
  "fileName": "types.ts",
4917
- "line": 623,
4917
+ "line": 695,
4918
4918
  "character": 37
4919
4919
  }
4920
4920
  ],
@@ -4971,7 +4971,7 @@
4971
4971
  "sources": [
4972
4972
  {
4973
4973
  "fileName": "types.ts",
4974
- "line": 604,
4974
+ "line": 672,
4975
4975
  "character": 2
4976
4976
  }
4977
4977
  ],
@@ -4983,11 +4983,11 @@
4983
4983
  "kindString": "Call signature",
4984
4984
  "flags": {},
4985
4985
  "comment": {
4986
- "shortText": "Opens a dialog for creating a new record. It returns a promise resolved with the\nnewly created record or `null` if the user closes the dialog without creating anything.",
4986
+ "shortText": "Opens a dialog for creating a new record. It returns a promise resolved\nwith the newly created record or `null` if the user closes the dialog\nwithout creating anything.",
4987
4987
  "tags": [
4988
4988
  {
4989
4989
  "tag": "example",
4990
- "text": "\n const itemTypeId = prompt('Please insert a model ID:');\n\n const item = await ctx.createNewItem(itemTypeId);\n\n if (item) {\n ctx.notice(`Success! ${item.id}`);\n } else {\n ctx.alert('Closed!');\n }\n"
4990
+ "text": "\n\n```js\nconst itemTypeId = prompt('Please insert a model ID:');\n\nconst item = await ctx.createNewItem(itemTypeId);\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
4991
4991
  }
4992
4992
  ]
4993
4993
  },
@@ -5036,7 +5036,7 @@
5036
5036
  "sources": [
5037
5037
  {
5038
5038
  "fileName": "types.ts",
5039
- "line": 640,
5039
+ "line": 716,
5040
5040
  "character": 2
5041
5041
  }
5042
5042
  ],
@@ -5048,11 +5048,11 @@
5048
5048
  "kindString": "Call signature",
5049
5049
  "flags": {},
5050
5050
  "comment": {
5051
- "shortText": "Opens a dialog for editing an existing record. It returns a promise resolved with the\nedited record, or `null` if the user closes the dialog without persisting any change.",
5051
+ "shortText": "Opens a dialog for editing an existing record. It returns a promise\nresolved with the edited record, or `null` if the user closes the dialog\nwithout persisting any change.",
5052
5052
  "tags": [
5053
5053
  {
5054
5054
  "tag": "example",
5055
- "text": "\n const itemId = prompt('Please insert a record ID:');\n\n const item = await ctx.editItem(itemId);\n\n if (item) {\n ctx.notice(`Success! ${item.id}`);\n } else {\n ctx.alert('Closed!');\n }\n"
5055
+ "text": "\n\n```js\nconst itemId = prompt('Please insert a record ID:');\n\nconst item = await ctx.editItem(itemId);\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
5056
5056
  }
5057
5057
  ]
5058
5058
  },
@@ -5113,7 +5113,7 @@
5113
5113
  "sources": [
5114
5114
  {
5115
5115
  "fileName": "types.ts",
5116
- "line": 588,
5116
+ "line": 652,
5117
5117
  "character": 32
5118
5118
  }
5119
5119
  ]
@@ -5127,12 +5127,12 @@
5127
5127
  "kindString": "Type alias",
5128
5128
  "flags": {},
5129
5129
  "comment": {
5130
- "shortText": "These methods can be used to interact with the form that's being shown to the end-user\nto edit a record"
5130
+ "shortText": "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record"
5131
5131
  },
5132
5132
  "sources": [
5133
5133
  {
5134
5134
  "fileName": "types.ts",
5135
- "line": 863,
5135
+ "line": 980,
5136
5136
  "character": 12
5137
5137
  }
5138
5138
  ],
@@ -5154,7 +5154,7 @@
5154
5154
  "sources": [
5155
5155
  {
5156
5156
  "fileName": "types.ts",
5157
- "line": 887,
5157
+ "line": 1010,
5158
5158
  "character": 2
5159
5159
  }
5160
5160
  ],
@@ -5170,7 +5170,7 @@
5170
5170
  "tags": [
5171
5171
  {
5172
5172
  "tag": "example",
5173
- "text": "\n const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n );\n\n await ctx.disableField(fieldPath, true);\n"
5173
+ "text": "\n\n```js\nconst fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);\n```\n"
5174
5174
  }
5175
5175
  ]
5176
5176
  },
@@ -5220,7 +5220,7 @@
5220
5220
  "sources": [
5221
5221
  {
5222
5222
  "fileName": "types.ts",
5223
- "line": 919,
5223
+ "line": 1051,
5224
5224
  "character": 2
5225
5225
  }
5226
5226
  ],
@@ -5236,7 +5236,7 @@
5236
5236
  "tags": [
5237
5237
  {
5238
5238
  "tag": "example",
5239
- "text": "\n await ctx.saveCurrentItem();\n"
5239
+ "text": "\n\n```js\nawait ctx.saveCurrentItem();\n```\n"
5240
5240
  }
5241
5241
  ]
5242
5242
  },
@@ -5262,7 +5262,7 @@
5262
5262
  "sources": [
5263
5263
  {
5264
5264
  "fileName": "types.ts",
5265
- "line": 900,
5265
+ "line": 1026,
5266
5266
  "character": 2
5267
5267
  }
5268
5268
  ],
@@ -5274,11 +5274,11 @@
5274
5274
  "kindString": "Call signature",
5275
5275
  "flags": {},
5276
5276
  "comment": {
5277
- "shortText": "Smoothly navigates to a specific field in the form. If the field is localized it will\nswitch language tab and then navigate to the chosen field.",
5277
+ "shortText": "Smoothly navigates to a specific field in the form. If the field is\nlocalized it will switch language tab and then navigate to the chosen field.",
5278
5278
  "tags": [
5279
5279
  {
5280
5280
  "tag": "example",
5281
- "text": "\n const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n );\n\n await ctx.scrollToField(fieldPath);\n"
5281
+ "text": "\n\n```js\nconst fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);\n```\n"
5282
5282
  }
5283
5283
  ]
5284
5284
  },
@@ -5330,7 +5330,7 @@
5330
5330
  "sources": [
5331
5331
  {
5332
5332
  "fileName": "types.ts",
5333
- "line": 912,
5333
+ "line": 1041,
5334
5334
  "character": 2
5335
5335
  }
5336
5336
  ],
@@ -5346,7 +5346,7 @@
5346
5346
  "tags": [
5347
5347
  {
5348
5348
  "tag": "example",
5349
- "text": "\n const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n );\n\n await ctx.setFieldValue(fieldPath, 'new value');\n"
5349
+ "text": "\n\n```js\nconst fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');\n```\n"
5350
5350
  }
5351
5351
  ]
5352
5352
  },
@@ -5396,7 +5396,7 @@
5396
5396
  "sources": [
5397
5397
  {
5398
5398
  "fileName": "types.ts",
5399
- "line": 875,
5399
+ "line": 995,
5400
5400
  "character": 2
5401
5401
  }
5402
5402
  ],
@@ -5412,7 +5412,7 @@
5412
5412
  "tags": [
5413
5413
  {
5414
5414
  "tag": "example",
5415
- "text": "\n const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n );\n\n await ctx.toggleField(fieldPath, true);\n"
5415
+ "text": "\n\n```js\nconst fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);\n```\n"
5416
5416
  }
5417
5417
  ]
5418
5418
  },
@@ -5470,7 +5470,7 @@
5470
5470
  "sources": [
5471
5471
  {
5472
5472
  "fileName": "types.ts",
5473
- "line": 863,
5473
+ "line": 980,
5474
5474
  "character": 40
5475
5475
  }
5476
5476
  ]
@@ -5484,12 +5484,12 @@
5484
5484
  "kindString": "Type alias",
5485
5485
  "flags": {},
5486
5486
  "comment": {
5487
- "shortText": "These information describe the current state of the form that's being shown to the\nend-user to edit a record"
5487
+ "shortText": "These information describe the current state of the form that's being shown\nto the end-user to edit a record"
5488
5488
  },
5489
5489
  "sources": [
5490
5490
  {
5491
5491
  "fileName": "types.ts",
5492
- "line": 840,
5492
+ "line": 956,
5493
5493
  "character": 12
5494
5494
  }
5495
5495
  ],
@@ -5514,7 +5514,7 @@
5514
5514
  "sources": [
5515
5515
  {
5516
5516
  "fileName": "types.ts",
5517
- "line": 848,
5517
+ "line": 964,
5518
5518
  "character": 2
5519
5519
  }
5520
5520
  ],
@@ -5545,7 +5545,7 @@
5545
5545
  "sources": [
5546
5546
  {
5547
5547
  "fileName": "types.ts",
5548
- "line": 854,
5548
+ "line": 970,
5549
5549
  "character": 2
5550
5550
  }
5551
5551
  ],
@@ -5566,7 +5566,7 @@
5566
5566
  "sources": [
5567
5567
  {
5568
5568
  "fileName": "types.ts",
5569
- "line": 852,
5569
+ "line": 968,
5570
5570
  "character": 2
5571
5571
  }
5572
5572
  ],
@@ -5587,7 +5587,7 @@
5587
5587
  "sources": [
5588
5588
  {
5589
5589
  "fileName": "types.ts",
5590
- "line": 844,
5590
+ "line": 960,
5591
5591
  "character": 2
5592
5592
  }
5593
5593
  ],
@@ -5618,7 +5618,7 @@
5618
5618
  "sources": [
5619
5619
  {
5620
5620
  "fileName": "types.ts",
5621
- "line": 850,
5621
+ "line": 966,
5622
5622
  "character": 2
5623
5623
  }
5624
5624
  ],
@@ -5656,7 +5656,7 @@
5656
5656
  "sources": [
5657
5657
  {
5658
5658
  "fileName": "types.ts",
5659
- "line": 846,
5659
+ "line": 962,
5660
5660
  "character": 2
5661
5661
  }
5662
5662
  ],
@@ -5678,7 +5678,7 @@
5678
5678
  "sources": [
5679
5679
  {
5680
5680
  "fileName": "types.ts",
5681
- "line": 842,
5681
+ "line": 958,
5682
5682
  "character": 2
5683
5683
  }
5684
5684
  ],
@@ -5706,7 +5706,7 @@
5706
5706
  "sources": [
5707
5707
  {
5708
5708
  "fileName": "types.ts",
5709
- "line": 840,
5709
+ "line": 956,
5710
5710
  "character": 43
5711
5711
  }
5712
5712
  ]
@@ -5722,7 +5722,7 @@
5722
5722
  "sources": [
5723
5723
  {
5724
5724
  "fileName": "types.ts",
5725
- "line": 922,
5725
+ "line": 1054,
5726
5726
  "character": 12
5727
5727
  }
5728
5728
  ],
@@ -5756,7 +5756,7 @@
5756
5756
  "sources": [
5757
5757
  {
5758
5758
  "fileName": "types.ts",
5759
- "line": 857,
5759
+ "line": 973,
5760
5760
  "character": 12
5761
5761
  }
5762
5762
  ],
@@ -5788,7 +5788,7 @@
5788
5788
  "sources": [
5789
5789
  {
5790
5790
  "fileName": "types.ts",
5791
- "line": 189,
5791
+ "line": 203,
5792
5792
  "character": 12
5793
5793
  }
5794
5794
  ],
@@ -5808,12 +5808,12 @@
5808
5808
  "kindString": "Property",
5809
5809
  "flags": {},
5810
5810
  "comment": {
5811
- "shortText": "ID of the panel. Will be the first argument for the `renderItemFormSidebarPanel` function"
5811
+ "shortText": "ID of the panel. Will be the first argument for the\n`renderItemFormSidebarPanel` function"
5812
5812
  },
5813
5813
  "sources": [
5814
5814
  {
5815
5815
  "fileName": "types.ts",
5816
- "line": 191,
5816
+ "line": 208,
5817
5817
  "character": 2
5818
5818
  }
5819
5819
  ],
@@ -5836,7 +5836,7 @@
5836
5836
  "sources": [
5837
5837
  {
5838
5838
  "fileName": "types.ts",
5839
- "line": 214,
5839
+ "line": 233,
5840
5840
  "character": 2
5841
5841
  }
5842
5842
  ],
@@ -5857,7 +5857,7 @@
5857
5857
  "sources": [
5858
5858
  {
5859
5859
  "fileName": "types.ts",
5860
- "line": 193,
5860
+ "line": 210,
5861
5861
  "character": 2
5862
5862
  }
5863
5863
  ],
@@ -5875,12 +5875,12 @@
5875
5875
  "isOptional": true
5876
5876
  },
5877
5877
  "comment": {
5878
- "shortText": "An arbitrary configuration object that will be passed as the `parameters` property of\nthe second argument of the `renderItemFormSidebarPanel` function"
5878
+ "shortText": "An arbitrary configuration object that will be passed as the `parameters`\nproperty of the second argument of the `renderItemFormSidebarPanel` function"
5879
5879
  },
5880
5880
  "sources": [
5881
5881
  {
5882
5882
  "fileName": "types.ts",
5883
- "line": 198,
5883
+ "line": 215,
5884
5884
  "character": 2
5885
5885
  }
5886
5886
  ],
@@ -5908,12 +5908,12 @@
5908
5908
  "isOptional": true
5909
5909
  },
5910
5910
  "comment": {
5911
- "shortText": "Expresses where you want the item to be placed inside the sidebar. If not specified,\nthe item will be placed after the standard panels provided by DatoCMS itself."
5911
+ "shortText": "Expresses where you want the item to be placed inside the sidebar. If not\nspecified, the item will be placed after the standard panels provided by\nDatoCMS itself."
5912
5912
  },
5913
5913
  "sources": [
5914
5914
  {
5915
5915
  "fileName": "types.ts",
5916
- "line": 205,
5916
+ "line": 223,
5917
5917
  "character": 2
5918
5918
  }
5919
5919
  ],
@@ -5932,12 +5932,12 @@
5932
5932
  "isOptional": true
5933
5933
  },
5934
5934
  "comment": {
5935
- "shortText": "If multiple sidebar panels specify the same `placement`, they will be sorted by\nascending `rank`. If you want to specify an explicit value for `rank`, make sure to\noffer a way for final users to customize it inside the plugin's settings form,\notherwise the hardcoded value you choose might clash with the one of another plugin! *"
5935
+ "shortText": "If multiple sidebar panels specify the same `placement`, they will be\nsorted by ascending `rank`. If you want to specify an explicit value for\n`rank`, make sure to offer a way for final users to customize it inside the\nplugin's settings form, otherwise the hardcoded value you choose might\nclash with the one of another plugin! *"
5936
5936
  },
5937
5937
  "sources": [
5938
5938
  {
5939
5939
  "fileName": "types.ts",
5940
- "line": 212,
5940
+ "line": 231,
5941
5941
  "character": 2
5942
5942
  }
5943
5943
  ],
@@ -5960,7 +5960,7 @@
5960
5960
  "sources": [
5961
5961
  {
5962
5962
  "fileName": "types.ts",
5963
- "line": 200,
5963
+ "line": 217,
5964
5964
  "character": 2
5965
5965
  }
5966
5966
  ],
@@ -5988,7 +5988,7 @@
5988
5988
  "sources": [
5989
5989
  {
5990
5990
  "fileName": "types.ts",
5991
- "line": 189,
5991
+ "line": 203,
5992
5992
  "character": 35
5993
5993
  }
5994
5994
  ]
@@ -6004,7 +6004,7 @@
6004
6004
  "sources": [
6005
6005
  {
6006
6006
  "fileName": "types.ts",
6007
- "line": 183,
6007
+ "line": 197,
6008
6008
  "character": 12
6009
6009
  }
6010
6010
  ],
@@ -6055,12 +6055,12 @@
6055
6055
  "kindString": "Type alias",
6056
6056
  "flags": {},
6057
6057
  "comment": {
6058
- "shortText": "These methods can be used to asyncronously load additional information your plugin needs to work"
6058
+ "shortText": "These methods can be used to asyncronously load additional information your\nplugin needs to work"
6059
6059
  },
6060
6060
  "sources": [
6061
6061
  {
6062
6062
  "fileName": "types.ts",
6063
- "line": 538,
6063
+ "line": 586,
6064
6064
  "character": 12
6065
6065
  }
6066
6066
  ],
@@ -6082,7 +6082,7 @@
6082
6082
  "sources": [
6083
6083
  {
6084
6084
  "fileName": "types.ts",
6085
- "line": 564,
6085
+ "line": 622,
6086
6086
  "character": 2
6087
6087
  }
6088
6088
  ],
@@ -6094,11 +6094,11 @@
6094
6094
  "kindString": "Call signature",
6095
6095
  "flags": {},
6096
6096
  "comment": {
6097
- "shortText": "Loads all the fields in the project that are currently using the plugin for one of\nits manual field extensions.",
6097
+ "shortText": "Loads all the fields in the project that are currently using the plugin for\none of its manual field extensions.",
6098
6098
  "tags": [
6099
6099
  {
6100
6100
  "tag": "example",
6101
- "text": "\n const fields = await ctx.loadFieldsUsingPlugin();\n\n ctx.notice(\n `Success! ${fields.map((field) => field.attributes.api_key).join(', ')}`,\n );\n"
6101
+ "text": "\n\n```js\nconst fields = await ctx.loadFieldsUsingPlugin();\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);\n```\n"
6102
6102
  }
6103
6103
  ]
6104
6104
  },
@@ -6128,7 +6128,7 @@
6128
6128
  "sources": [
6129
6129
  {
6130
6130
  "fileName": "types.ts",
6131
- "line": 552,
6131
+ "line": 605,
6132
6132
  "character": 2
6133
6133
  }
6134
6134
  ],
@@ -6140,11 +6140,11 @@
6140
6140
  "kindString": "Call signature",
6141
6141
  "flags": {},
6142
6142
  "comment": {
6143
- "shortText": "Loads all the fields for a specific model (or block). Fields will be returned and\nwill also be available in the the `fields` property.",
6143
+ "shortText": "Loads all the fields for a specific model (or block). Fields will be\nreturned and will also be available in the the `fields` property.",
6144
6144
  "tags": [
6145
6145
  {
6146
6146
  "tag": "example",
6147
- "text": "\n const itemTypeId = prompt('Please insert a model ID:');\n\n const fields = await ctx.loadItemTypeFields(itemTypeId);\n\n ctx.notice(\n `Success! ${fields.map((field) => field.attributes.api_key).join(', ')}`,\n );\n"
6147
+ "text": "\n\n```js\nconst itemTypeId = prompt('Please insert a model ID:');\n\nconst fields = await ctx.loadItemTypeFields(itemTypeId);\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);\n```\n"
6148
6148
  }
6149
6149
  ]
6150
6150
  },
@@ -6187,7 +6187,7 @@
6187
6187
  "sources": [
6188
6188
  {
6189
6189
  "fileName": "types.ts",
6190
- "line": 584,
6190
+ "line": 648,
6191
6191
  "character": 2
6192
6192
  }
6193
6193
  ],
@@ -6199,11 +6199,11 @@
6199
6199
  "kindString": "Call signature",
6200
6200
  "flags": {},
6201
6201
  "comment": {
6202
- "shortText": "Loads all SSO users. Users will be returned and will also be available in the the\n`ssoUsers` property.",
6202
+ "shortText": "Loads all SSO users. Users will be returned and will also be available in\nthe the `ssoUsers` property.",
6203
6203
  "tags": [
6204
6204
  {
6205
6205
  "tag": "example",
6206
- "text": "\n const users = await ctx.loadSsoUsers();\n\n ctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);\n"
6206
+ "text": "\n\n```js\nconst users = await ctx.loadSsoUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);\n```\n"
6207
6207
  }
6208
6208
  ]
6209
6209
  },
@@ -6233,7 +6233,7 @@
6233
6233
  "sources": [
6234
6234
  {
6235
6235
  "fileName": "types.ts",
6236
- "line": 574,
6236
+ "line": 635,
6237
6237
  "character": 2
6238
6238
  }
6239
6239
  ],
@@ -6245,11 +6245,11 @@
6245
6245
  "kindString": "Call signature",
6246
6246
  "flags": {},
6247
6247
  "comment": {
6248
- "shortText": "Loads all regular users. Users will be returned and will also be available in the the\n`users` property.",
6248
+ "shortText": "Loads all regular users. Users will be returned and will also be available\nin the the `users` property.",
6249
6249
  "tags": [
6250
6250
  {
6251
6251
  "tag": "example",
6252
- "text": "\n const users = await ctx.loadUsers();\n\n ctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);\n"
6252
+ "text": "\n\n```js\nconst users = await ctx.loadUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);\n```\n"
6253
6253
  }
6254
6254
  ]
6255
6255
  },
@@ -6286,7 +6286,7 @@
6286
6286
  "sources": [
6287
6287
  {
6288
6288
  "fileName": "types.ts",
6289
- "line": 538,
6289
+ "line": 586,
6290
6290
  "character": 30
6291
6291
  }
6292
6292
  ]
@@ -6369,7 +6369,7 @@
6369
6369
  "isOptional": true
6370
6370
  },
6371
6371
  "comment": {
6372
- "shortText": "Expresses where you want to place the tab in the top-bar. If not specified, the tab\nwill be placed after the standard tabs provided by DatoCMS itself."
6372
+ "shortText": "Expresses where you want to place the tab in the top-bar. If not specified,\nthe tab will be placed after the standard tabs provided by DatoCMS itself."
6373
6373
  },
6374
6374
  "sources": [
6375
6375
  {
@@ -6490,12 +6490,12 @@
6490
6490
  "isOptional": true
6491
6491
  },
6492
6492
  "comment": {
6493
- "shortText": "If different plugins specify the same `placement` for their tabs, they will be\ndisplayed by ascending `rank`. If you want to specify an explicit value for `rank`,\nmake sure to offer a way for final users to customize it inside the plugin's settings\nform, otherwise the hardcoded value you choose might clash with the one of another plugin! *"
6493
+ "shortText": "If different plugins specify the same `placement` for their tabs, they will\nbe displayed by ascending `rank`. If you want to specify an explicit value\nfor `rank`, make sure to offer a way for final users to customize it inside\nthe plugin's settings form, otherwise the hardcoded value you choose might\nclash with the one of another plugin! *"
6494
6494
  },
6495
6495
  "sources": [
6496
6496
  {
6497
6497
  "fileName": "types.ts",
6498
- "line": 48,
6498
+ "line": 52,
6499
6499
  "character": 2
6500
6500
  }
6501
6501
  ],
@@ -6535,12 +6535,12 @@
6535
6535
  "kindString": "Type alias",
6536
6536
  "flags": {},
6537
6537
  "comment": {
6538
- "shortText": "Field extensions extend the basic functionality of DatoCMS when it comes to presenting\nrecord's fields to the final user. Depending on the extension type (`editor` or\n`addon`) they will be shown in different places of the interface."
6538
+ "shortText": "Field extensions extend the basic functionality of DatoCMS when it comes to\npresenting record's fields to the final user. Depending on the extension type\n(`editor` or `addon`) they will be shown in different places of the interface."
6539
6539
  },
6540
6540
  "sources": [
6541
6541
  {
6542
6542
  "fileName": "types.ts",
6543
- "line": 155,
6543
+ "line": 164,
6544
6544
  "character": 12
6545
6545
  }
6546
6546
  ],
@@ -6562,12 +6562,12 @@
6562
6562
  "isOptional": true
6563
6563
  },
6564
6564
  "comment": {
6565
- "shortText": "For `editor` extensions: moves the field to the sidebar of the record editing page,\nmimicking a sidebar panel"
6565
+ "shortText": "For `editor` extensions: moves the field to the sidebar of the record\nediting page, mimicking a sidebar panel"
6566
6566
  },
6567
6567
  "sources": [
6568
6568
  {
6569
6569
  "fileName": "types.ts",
6570
- "line": 170,
6570
+ "line": 183,
6571
6571
  "character": 2
6572
6572
  }
6573
6573
  ],
@@ -6596,7 +6596,7 @@
6596
6596
  "sources": [
6597
6597
  {
6598
6598
  "fileName": "types.ts",
6599
- "line": 170,
6599
+ "line": 183,
6600
6600
  "character": 31
6601
6601
  }
6602
6602
  ],
@@ -6618,7 +6618,7 @@
6618
6618
  "sources": [
6619
6619
  {
6620
6620
  "fileName": "types.ts",
6621
- "line": 170,
6621
+ "line": 183,
6622
6622
  "character": 29
6623
6623
  }
6624
6624
  ]
@@ -6636,12 +6636,12 @@
6636
6636
  "isOptional": true
6637
6637
  },
6638
6638
  "comment": {
6639
- "shortText": "Whether this field extension needs some configuration options before being installed\nin a field or not. Will trigger the `renderManualFieldExtensionConfigScreen` and\n`validateManualFieldExtensionParameters` methods"
6639
+ "shortText": "Whether this field extension needs some configuration options before being\ninstalled in a field or not. Will trigger the\n`renderManualFieldExtensionConfigScreen` and\n`validateManualFieldExtensionParameters` methods"
6640
6640
  },
6641
6641
  "sources": [
6642
6642
  {
6643
6643
  "fileName": "types.ts",
6644
- "line": 178,
6644
+ "line": 192,
6645
6645
  "character": 2
6646
6646
  }
6647
6647
  ],
@@ -6670,7 +6670,7 @@
6670
6670
  "sources": [
6671
6671
  {
6672
6672
  "fileName": "types.ts",
6673
- "line": 178,
6673
+ "line": 192,
6674
6674
  "character": 29
6675
6675
  }
6676
6676
  ],
@@ -6692,7 +6692,7 @@
6692
6692
  "sources": [
6693
6693
  {
6694
6694
  "fileName": "types.ts",
6695
- "line": 178,
6695
+ "line": 192,
6696
6696
  "character": 27
6697
6697
  }
6698
6698
  ]
@@ -6713,7 +6713,7 @@
6713
6713
  "sources": [
6714
6714
  {
6715
6715
  "fileName": "types.ts",
6716
- "line": 172,
6716
+ "line": 185,
6717
6717
  "character": 2
6718
6718
  }
6719
6719
  ],
@@ -6742,12 +6742,12 @@
6742
6742
  "kindString": "Property",
6743
6743
  "flags": {},
6744
6744
  "comment": {
6745
- "shortText": "ID of field extension. Will be the first argument for the `renderFieldExtension` function"
6745
+ "shortText": "ID of field extension. Will be the first argument for the\n`renderFieldExtension` function"
6746
6746
  },
6747
6747
  "sources": [
6748
6748
  {
6749
6749
  "fileName": "types.ts",
6750
- "line": 157,
6750
+ "line": 169,
6751
6751
  "character": 2
6752
6752
  }
6753
6753
  ],
@@ -6770,7 +6770,7 @@
6770
6770
  "sources": [
6771
6771
  {
6772
6772
  "fileName": "types.ts",
6773
- "line": 180,
6773
+ "line": 194,
6774
6774
  "character": 2
6775
6775
  }
6776
6776
  ],
@@ -6791,7 +6791,7 @@
6791
6791
  "sources": [
6792
6792
  {
6793
6793
  "fileName": "types.ts",
6794
- "line": 159,
6794
+ "line": 171,
6795
6795
  "character": 2
6796
6796
  }
6797
6797
  ],
@@ -6807,12 +6807,12 @@
6807
6807
  "kindString": "Property",
6808
6808
  "flags": {},
6809
6809
  "comment": {
6810
- "shortText": "Type of field extension. An `editor` extension replaces the default field editor that\nDatoCMS provides, while an `addon` extension is placed underneath the field editor to\nprovide additional info/behaviour. You can setup multiple field addons for every field."
6810
+ "shortText": "Type of field extension. An `editor` extension replaces the default field\neditor that DatoCMS provides, while an `addon` extension is placed\nunderneath the field editor to provide additional info/behaviour. You can\nsetup multiple field addons for every field."
6811
6811
  },
6812
6812
  "sources": [
6813
6813
  {
6814
6814
  "fileName": "types.ts",
6815
- "line": 165,
6815
+ "line": 178,
6816
6816
  "character": 2
6817
6817
  }
6818
6818
  ],
@@ -6841,7 +6841,7 @@
6841
6841
  "sources": [
6842
6842
  {
6843
6843
  "fileName": "types.ts",
6844
- "line": 155,
6844
+ "line": 164,
6845
6845
  "character": 35
6846
6846
  }
6847
6847
  ]
@@ -6860,7 +6860,7 @@
6860
6860
  "sources": [
6861
6861
  {
6862
6862
  "fileName": "types.ts",
6863
- "line": 304,
6863
+ "line": 331,
6864
6864
  "character": 12
6865
6865
  }
6866
6866
  ],
@@ -6887,7 +6887,7 @@
6887
6887
  "sources": [
6888
6888
  {
6889
6889
  "fileName": "types.ts",
6890
- "line": 310,
6890
+ "line": 337,
6891
6891
  "character": 2
6892
6892
  }
6893
6893
  ],
@@ -6908,7 +6908,7 @@
6908
6908
  "sources": [
6909
6909
  {
6910
6910
  "fileName": "types.ts",
6911
- "line": 306,
6911
+ "line": 333,
6912
6912
  "character": 2
6913
6913
  }
6914
6914
  ],
@@ -6931,7 +6931,7 @@
6931
6931
  "sources": [
6932
6932
  {
6933
6933
  "fileName": "types.ts",
6934
- "line": 319,
6934
+ "line": 346,
6935
6935
  "character": 2
6936
6936
  }
6937
6937
  ],
@@ -6949,12 +6949,12 @@
6949
6949
  "isOptional": true
6950
6950
  },
6951
6951
  "comment": {
6952
- "shortText": "An arbitrary configuration object that will be passed as the `parameters` property of\nthe second argument of the `renderModal` function"
6952
+ "shortText": "An arbitrary configuration object that will be passed as the `parameters`\nproperty of the second argument of the `renderModal` function"
6953
6953
  },
6954
6954
  "sources": [
6955
6955
  {
6956
6956
  "fileName": "types.ts",
6957
- "line": 317,
6957
+ "line": 344,
6958
6958
  "character": 2
6959
6959
  }
6960
6960
  ],
@@ -6987,7 +6987,7 @@
6987
6987
  "sources": [
6988
6988
  {
6989
6989
  "fileName": "types.ts",
6990
- "line": 308,
6990
+ "line": 335,
6991
6991
  "character": 2
6992
6992
  }
6993
6993
  ],
@@ -7010,7 +7010,7 @@
7010
7010
  "sources": [
7011
7011
  {
7012
7012
  "fileName": "types.ts",
7013
- "line": 312,
7013
+ "line": 339,
7014
7014
  "character": 2
7015
7015
  }
7016
7016
  ],
@@ -7062,7 +7062,7 @@
7062
7062
  "sources": [
7063
7063
  {
7064
7064
  "fileName": "types.ts",
7065
- "line": 304,
7065
+ "line": 331,
7066
7066
  "character": 20
7067
7067
  }
7068
7068
  ]
@@ -7081,7 +7081,7 @@
7081
7081
  "sources": [
7082
7082
  {
7083
7083
  "fileName": "types.ts",
7084
- "line": 814,
7084
+ "line": 927,
7085
7085
  "character": 12
7086
7086
  }
7087
7087
  ],
@@ -7103,7 +7103,7 @@
7103
7103
  "sources": [
7104
7104
  {
7105
7105
  "fileName": "types.ts",
7106
- "line": 821,
7106
+ "line": 937,
7107
7107
  "character": 2
7108
7108
  }
7109
7109
  ],
@@ -7119,7 +7119,7 @@
7119
7119
  "tags": [
7120
7120
  {
7121
7121
  "tag": "example",
7122
- "text": "\n await ctx.navigateTo('/');\n"
7122
+ "text": "\n\n```js\nawait ctx.navigateTo('/');\n```\n"
7123
7123
  }
7124
7124
  ]
7125
7125
  },
@@ -7162,7 +7162,7 @@
7162
7162
  "sources": [
7163
7163
  {
7164
7164
  "fileName": "types.ts",
7165
- "line": 814,
7165
+ "line": 927,
7166
7166
  "character": 30
7167
7167
  }
7168
7168
  ]
@@ -7178,7 +7178,7 @@
7178
7178
  "sources": [
7179
7179
  {
7180
7180
  "fileName": "types.ts",
7181
- "line": 1100,
7181
+ "line": 1253,
7182
7182
  "character": 12
7183
7183
  }
7184
7184
  ],
@@ -7200,7 +7200,7 @@
7200
7200
  "sources": [
7201
7201
  {
7202
7202
  "fileName": "types.ts",
7203
- "line": 1101,
7203
+ "line": 1254,
7204
7204
  "character": 2
7205
7205
  }
7206
7206
  ],
@@ -7238,7 +7238,7 @@
7238
7238
  "sources": [
7239
7239
  {
7240
7240
  "fileName": "types.ts",
7241
- "line": 1100,
7241
+ "line": 1253,
7242
7242
  "character": 38
7243
7243
  }
7244
7244
  ]
@@ -7254,7 +7254,7 @@
7254
7254
  "sources": [
7255
7255
  {
7256
7256
  "fileName": "types.ts",
7257
- "line": 1094,
7257
+ "line": 1247,
7258
7258
  "character": 12
7259
7259
  }
7260
7260
  ],
@@ -7276,7 +7276,7 @@
7276
7276
  "sources": [
7277
7277
  {
7278
7278
  "fileName": "types.ts",
7279
- "line": 1095,
7279
+ "line": 1248,
7280
7280
  "character": 2
7281
7281
  }
7282
7282
  ],
@@ -7298,7 +7298,7 @@
7298
7298
  "sources": [
7299
7299
  {
7300
7300
  "fileName": "types.ts",
7301
- "line": 1094,
7301
+ "line": 1247,
7302
7302
  "character": 41
7303
7303
  }
7304
7304
  ]
@@ -7333,7 +7333,7 @@
7333
7333
  "sources": [
7334
7334
  {
7335
7335
  "fileName": "types.ts",
7336
- "line": 1104,
7336
+ "line": 1257,
7337
7337
  "character": 12
7338
7338
  }
7339
7339
  ],
@@ -7362,7 +7362,7 @@
7362
7362
  "sources": [
7363
7363
  {
7364
7364
  "fileName": "types.ts",
7365
- "line": 1098,
7365
+ "line": 1251,
7366
7366
  "character": 12
7367
7367
  }
7368
7368
  ],
@@ -7391,7 +7391,7 @@
7391
7391
  "sources": [
7392
7392
  {
7393
7393
  "fileName": "types.ts",
7394
- "line": 1106,
7394
+ "line": 1259,
7395
7395
  "character": 12
7396
7396
  }
7397
7397
  ],
@@ -7423,7 +7423,7 @@
7423
7423
  "sources": [
7424
7424
  {
7425
7425
  "fileName": "types.ts",
7426
- "line": 408,
7426
+ "line": 444,
7427
7427
  "character": 12
7428
7428
  }
7429
7429
  ],
@@ -7448,7 +7448,7 @@
7448
7448
  "sources": [
7449
7449
  {
7450
7450
  "fileName": "types.ts",
7451
- "line": 431,
7451
+ "line": 468,
7452
7452
  "character": 2
7453
7453
  }
7454
7454
  ],
@@ -7470,7 +7470,7 @@
7470
7470
  "sources": [
7471
7471
  {
7472
7472
  "fileName": "types.ts",
7473
- "line": 433,
7473
+ "line": 470,
7474
7474
  "character": 2
7475
7475
  }
7476
7476
  ],
@@ -7503,12 +7503,12 @@
7503
7503
  "kindString": "Property",
7504
7504
  "flags": {},
7505
7505
  "comment": {
7506
- "shortText": "All the fields currently loaded for the current DatoCMS project, indexed by ID. It\nwill always contain the current model fields and all the fields of the blocks it\nmight contain via Modular Content/Structured Text fields. If some fields you need are\nnot present, use the `loadItemTypeFields` function to load them."
7506
+ "shortText": "All the fields currently loaded for the current DatoCMS project, indexed by\nID. It will always contain the current model fields and all the fields of\nthe blocks it might contain via Modular Content/Structured Text fields. If\nsome fields you need are not present, use the `loadItemTypeFields` function\nto load them."
7507
7507
  },
7508
7508
  "sources": [
7509
7509
  {
7510
7510
  "fileName": "types.ts",
7511
- "line": 415,
7511
+ "line": 452,
7512
7512
  "character": 2
7513
7513
  }
7514
7514
  ],
@@ -7541,12 +7541,12 @@
7541
7541
  "kindString": "Property",
7542
7542
  "flags": {},
7543
7543
  "comment": {
7544
- "shortText": "All the SSO users currently loaded for the current DatoCMS project, indexed by ID. It\nwill always contain the current user. If some users you need are not present, use the\n`loadSsoUsers` function to load them."
7544
+ "shortText": "All the SSO users currently loaded for the current DatoCMS project, indexed\nby ID. It will always contain the current user. If some users you need are\nnot present, use the `loadSsoUsers` function to load them."
7545
7545
  },
7546
7546
  "sources": [
7547
7547
  {
7548
7548
  "fileName": "types.ts",
7549
- "line": 429,
7549
+ "line": 466,
7550
7550
  "character": 2
7551
7551
  }
7552
7552
  ],
@@ -7584,7 +7584,7 @@
7584
7584
  "sources": [
7585
7585
  {
7586
7586
  "fileName": "types.ts",
7587
- "line": 417,
7587
+ "line": 454,
7588
7588
  "character": 2
7589
7589
  }
7590
7590
  ],
@@ -7601,12 +7601,12 @@
7601
7601
  "kindString": "Property",
7602
7602
  "flags": {},
7603
7603
  "comment": {
7604
- "shortText": "All the regular users currently loaded for the current DatoCMS project, indexed by\nID. It will always contain the current user. If some users you need are not present,\nuse the `loadUsers` function to load them."
7604
+ "shortText": "All the regular users currently loaded for the current DatoCMS project,\nindexed by ID. It will always contain the current user. If some users you\nneed are not present, use the `loadUsers` function to load them."
7605
7605
  },
7606
7606
  "sources": [
7607
7607
  {
7608
7608
  "fileName": "types.ts",
7609
- "line": 423,
7609
+ "line": 460,
7610
7610
  "character": 2
7611
7611
  }
7612
7612
  ],
@@ -7650,7 +7650,7 @@
7650
7650
  "sources": [
7651
7651
  {
7652
7652
  "fileName": "types.ts",
7653
- "line": 408,
7653
+ "line": 444,
7654
7654
  "character": 41
7655
7655
  }
7656
7656
  ]
@@ -7669,7 +7669,7 @@
7669
7669
  "sources": [
7670
7670
  {
7671
7671
  "fileName": "types.ts",
7672
- "line": 1083,
7672
+ "line": 1236,
7673
7673
  "character": 12
7674
7674
  }
7675
7675
  ],
@@ -7691,7 +7691,7 @@
7691
7691
  "sources": [
7692
7692
  {
7693
7693
  "fileName": "types.ts",
7694
- "line": 1084,
7694
+ "line": 1237,
7695
7695
  "character": 2
7696
7696
  }
7697
7697
  ],
@@ -7729,7 +7729,7 @@
7729
7729
  "sources": [
7730
7730
  {
7731
7731
  "fileName": "types.ts",
7732
- "line": 1083,
7732
+ "line": 1236,
7733
7733
  "character": 50
7734
7734
  }
7735
7735
  ]
@@ -7745,7 +7745,7 @@
7745
7745
  "sources": [
7746
7746
  {
7747
7747
  "fileName": "types.ts",
7748
- "line": 1075,
7748
+ "line": 1228,
7749
7749
  "character": 12
7750
7750
  }
7751
7751
  ],
@@ -7767,7 +7767,7 @@
7767
7767
  "sources": [
7768
7768
  {
7769
7769
  "fileName": "types.ts",
7770
- "line": 1076,
7770
+ "line": 1229,
7771
7771
  "character": 2
7772
7772
  }
7773
7773
  ],
@@ -7789,7 +7789,7 @@
7789
7789
  "sources": [
7790
7790
  {
7791
7791
  "fileName": "types.ts",
7792
- "line": 1075,
7792
+ "line": 1228,
7793
7793
  "character": 53
7794
7794
  }
7795
7795
  ]
@@ -7834,7 +7834,7 @@
7834
7834
  "sources": [
7835
7835
  {
7836
7836
  "fileName": "types.ts",
7837
- "line": 1087,
7837
+ "line": 1240,
7838
7838
  "character": 12
7839
7839
  }
7840
7840
  ],
@@ -7868,7 +7868,7 @@
7868
7868
  "sources": [
7869
7869
  {
7870
7870
  "fileName": "types.ts",
7871
- "line": 1079,
7871
+ "line": 1232,
7872
7872
  "character": 12
7873
7873
  }
7874
7874
  ],
@@ -7897,7 +7897,7 @@
7897
7897
  "sources": [
7898
7898
  {
7899
7899
  "fileName": "types.ts",
7900
- "line": 1091,
7900
+ "line": 1244,
7901
7901
  "character": 12
7902
7902
  }
7903
7903
  ],
@@ -7926,7 +7926,7 @@
7926
7926
  "sources": [
7927
7927
  {
7928
7928
  "fileName": "types.ts",
7929
- "line": 971,
7929
+ "line": 1111,
7930
7930
  "character": 12
7931
7931
  }
7932
7932
  ],
@@ -7948,7 +7948,7 @@
7948
7948
  "sources": [
7949
7949
  {
7950
7950
  "fileName": "types.ts",
7951
- "line": 972,
7951
+ "line": 1112,
7952
7952
  "character": 2
7953
7953
  }
7954
7954
  ],
@@ -7986,7 +7986,7 @@
7986
7986
  "sources": [
7987
7987
  {
7988
7988
  "fileName": "types.ts",
7989
- "line": 971,
7989
+ "line": 1111,
7990
7990
  "character": 52
7991
7991
  }
7992
7992
  ]
@@ -8000,12 +8000,12 @@
8000
8000
  "kindString": "Type alias",
8001
8001
  "flags": {},
8002
8002
  "comment": {
8003
- "shortText": "Information regarding the state of a specific field where you need to render the field extension"
8003
+ "shortText": "Information regarding the state of a specific field where you need to render\nthe field extension"
8004
8004
  },
8005
8005
  "sources": [
8006
8006
  {
8007
8007
  "fileName": "types.ts",
8008
- "line": 947,
8008
+ "line": 1087,
8009
8009
  "character": 12
8010
8010
  }
8011
8011
  ],
@@ -8030,7 +8030,7 @@
8030
8030
  "sources": [
8031
8031
  {
8032
8032
  "fileName": "types.ts",
8033
- "line": 956,
8033
+ "line": 1096,
8034
8034
  "character": 2
8035
8035
  }
8036
8036
  ],
@@ -8051,7 +8051,7 @@
8051
8051
  "sources": [
8052
8052
  {
8053
8053
  "fileName": "types.ts",
8054
- "line": 960,
8054
+ "line": 1100,
8055
8055
  "character": 2
8056
8056
  }
8057
8057
  ],
@@ -8073,7 +8073,7 @@
8073
8073
  "sources": [
8074
8074
  {
8075
8075
  "fileName": "types.ts",
8076
- "line": 950,
8076
+ "line": 1090,
8077
8077
  "character": 2
8078
8078
  }
8079
8079
  ],
@@ -8094,7 +8094,7 @@
8094
8094
  "sources": [
8095
8095
  {
8096
8096
  "fileName": "types.ts",
8097
- "line": 958,
8097
+ "line": 1098,
8098
8098
  "character": 2
8099
8099
  }
8100
8100
  ],
@@ -8112,7 +8112,7 @@
8112
8112
  "sources": [
8113
8113
  {
8114
8114
  "fileName": "types.ts",
8115
- "line": 948,
8115
+ "line": 1088,
8116
8116
  "character": 2
8117
8117
  }
8118
8118
  ],
@@ -8133,7 +8133,7 @@
8133
8133
  "sources": [
8134
8134
  {
8135
8135
  "fileName": "types.ts",
8136
- "line": 952,
8136
+ "line": 1092,
8137
8137
  "character": 2
8138
8138
  }
8139
8139
  ],
@@ -8159,12 +8159,12 @@
8159
8159
  "kindString": "Property",
8160
8160
  "flags": {},
8161
8161
  "comment": {
8162
- "shortText": "If the field extension is installed in a field of a block, returns the top level\nModular Content/Structured Text field containing the block itself"
8162
+ "shortText": "If the field extension is installed in a field of a block, returns the top\nlevel Modular Content/Structured Text field containing the block itself"
8163
8163
  },
8164
8164
  "sources": [
8165
8165
  {
8166
8166
  "fileName": "types.ts",
8167
- "line": 965,
8167
+ "line": 1105,
8168
8168
  "character": 2
8169
8169
  }
8170
8170
  ],
@@ -8195,7 +8195,7 @@
8195
8195
  "sources": [
8196
8196
  {
8197
8197
  "fileName": "types.ts",
8198
- "line": 954,
8198
+ "line": 1094,
8199
8199
  "character": 2
8200
8200
  }
8201
8201
  ],
@@ -8224,7 +8224,7 @@
8224
8224
  "sources": [
8225
8225
  {
8226
8226
  "fileName": "types.ts",
8227
- "line": 947,
8227
+ "line": 1087,
8228
8228
  "character": 55
8229
8229
  }
8230
8230
  ]
@@ -8269,7 +8269,7 @@
8269
8269
  "sources": [
8270
8270
  {
8271
8271
  "fileName": "types.ts",
8272
- "line": 975,
8272
+ "line": 1115,
8273
8273
  "character": 12
8274
8274
  }
8275
8275
  ],
@@ -8298,7 +8298,7 @@
8298
8298
  "sources": [
8299
8299
  {
8300
8300
  "fileName": "types.ts",
8301
- "line": 968,
8301
+ "line": 1108,
8302
8302
  "character": 12
8303
8303
  }
8304
8304
  ],
@@ -8327,7 +8327,7 @@
8327
8327
  "sources": [
8328
8328
  {
8329
8329
  "fileName": "types.ts",
8330
- "line": 978,
8330
+ "line": 1118,
8331
8331
  "character": 12
8332
8332
  }
8333
8333
  ],
@@ -8383,12 +8383,12 @@
8383
8383
  "kindString": "Type alias",
8384
8384
  "flags": {},
8385
8385
  "comment": {
8386
- "shortText": "These methods can be used to update the configuration object of a specific field extension"
8386
+ "shortText": "These methods can be used to update the configuration object of a specific\nfield extension"
8387
8387
  },
8388
8388
  "sources": [
8389
8389
  {
8390
8390
  "fileName": "types.ts",
8391
- "line": 1057,
8391
+ "line": 1207,
8392
8392
  "character": 12
8393
8393
  }
8394
8394
  ],
@@ -8410,7 +8410,7 @@
8410
8410
  "sources": [
8411
8411
  {
8412
8412
  "fileName": "types.ts",
8413
- "line": 1058,
8413
+ "line": 1208,
8414
8414
  "character": 2
8415
8415
  }
8416
8416
  ],
@@ -8444,7 +8444,7 @@
8444
8444
  "sources": [
8445
8445
  {
8446
8446
  "fileName": "types.ts",
8447
- "line": 1065,
8447
+ "line": 1218,
8448
8448
  "character": 2
8449
8449
  }
8450
8450
  ],
@@ -8460,7 +8460,7 @@
8460
8460
  "tags": [
8461
8461
  {
8462
8462
  "tag": "example",
8463
- "text": "\n await ctx.setParameters({ color: '#ff0000' });\n"
8463
+ "text": "\n\n```js\nawait ctx.setParameters({ color: '#ff0000' });\n```\n"
8464
8464
  }
8465
8465
  ]
8466
8466
  },
@@ -8514,7 +8514,7 @@
8514
8514
  "sources": [
8515
8515
  {
8516
8516
  "fileName": "types.ts",
8517
- "line": 1057,
8517
+ "line": 1207,
8518
8518
  "character": 70
8519
8519
  }
8520
8520
  ]
@@ -8528,12 +8528,12 @@
8528
8528
  "kindString": "Type alias",
8529
8529
  "flags": {},
8530
8530
  "comment": {
8531
- "shortText": "Information regarding the specific form that you need to render to let the end-user\nedit the configuration object of a field extension"
8531
+ "shortText": "Information regarding the specific form that you need to render to let the\nend-user edit the configuration object of a field extension"
8532
8532
  },
8533
8533
  "sources": [
8534
8534
  {
8535
8535
  "fileName": "types.ts",
8536
- "line": 1037,
8536
+ "line": 1184,
8537
8537
  "character": 12
8538
8538
  }
8539
8539
  ],
@@ -8553,12 +8553,12 @@
8553
8553
  "kindString": "Property",
8554
8554
  "flags": {},
8555
8555
  "comment": {
8556
- "shortText": "The current validation errors for the parameters (you can set them implementing the\n`validateManualFieldExtensionParameters` function)"
8556
+ "shortText": "The current validation errors for the parameters (you can set them\nimplementing the `validateManualFieldExtensionParameters` function)"
8557
8557
  },
8558
8558
  "sources": [
8559
8559
  {
8560
8560
  "fileName": "types.ts",
8561
- "line": 1050,
8561
+ "line": 1197,
8562
8562
  "character": 2
8563
8563
  }
8564
8564
  ],
@@ -8589,7 +8589,7 @@
8589
8589
  "sources": [
8590
8590
  {
8591
8591
  "fileName": "types.ts",
8592
- "line": 1040,
8592
+ "line": 1187,
8593
8593
  "character": 2
8594
8594
  }
8595
8595
  ],
@@ -8607,7 +8607,7 @@
8607
8607
  "sources": [
8608
8608
  {
8609
8609
  "fileName": "types.ts",
8610
- "line": 1038,
8610
+ "line": 1185,
8611
8611
  "character": 2
8612
8612
  }
8613
8613
  ],
@@ -8628,7 +8628,7 @@
8628
8628
  "sources": [
8629
8629
  {
8630
8630
  "fileName": "types.ts",
8631
- "line": 1045,
8631
+ "line": 1192,
8632
8632
  "character": 2
8633
8633
  }
8634
8634
  ],
@@ -8663,7 +8663,7 @@
8663
8663
  "sources": [
8664
8664
  {
8665
8665
  "fileName": "types.ts",
8666
- "line": 1037,
8666
+ "line": 1184,
8667
8667
  "character": 73
8668
8668
  }
8669
8669
  ]
@@ -8708,7 +8708,7 @@
8708
8708
  "sources": [
8709
8709
  {
8710
8710
  "fileName": "types.ts",
8711
- "line": 1068,
8711
+ "line": 1221,
8712
8712
  "character": 12
8713
8713
  }
8714
8714
  ],
@@ -8742,7 +8742,7 @@
8742
8742
  "sources": [
8743
8743
  {
8744
8744
  "fileName": "types.ts",
8745
- "line": 1053,
8745
+ "line": 1200,
8746
8746
  "character": 12
8747
8747
  }
8748
8748
  ],
@@ -8771,7 +8771,7 @@
8771
8771
  "sources": [
8772
8772
  {
8773
8773
  "fileName": "types.ts",
8774
- "line": 1072,
8774
+ "line": 1225,
8775
8775
  "character": 12
8776
8776
  }
8777
8777
  ],
@@ -8800,7 +8800,7 @@
8800
8800
  "sources": [
8801
8801
  {
8802
8802
  "fileName": "types.ts",
8803
- "line": 830,
8803
+ "line": 946,
8804
8804
  "character": 12
8805
8805
  }
8806
8806
  ],
@@ -8847,7 +8847,7 @@
8847
8847
  "sources": [
8848
8848
  {
8849
8849
  "fileName": "types.ts",
8850
- "line": 993,
8850
+ "line": 1134,
8851
8851
  "character": 12
8852
8852
  }
8853
8853
  ],
@@ -8869,7 +8869,7 @@
8869
8869
  "sources": [
8870
8870
  {
8871
8871
  "fileName": "types.ts",
8872
- "line": 994,
8872
+ "line": 1135,
8873
8873
  "character": 2
8874
8874
  }
8875
8875
  ],
@@ -8903,7 +8903,7 @@
8903
8903
  "sources": [
8904
8904
  {
8905
8905
  "fileName": "types.ts",
8906
- "line": 1007,
8906
+ "line": 1151,
8907
8907
  "character": 2
8908
8908
  }
8909
8909
  ],
@@ -8915,11 +8915,11 @@
8915
8915
  "kindString": "Call signature",
8916
8916
  "flags": {},
8917
8917
  "comment": {
8918
- "shortText": "A function to be called by the plugin to close the modal. The `openModal` call will\nbe resolved with the passed return value",
8918
+ "shortText": "A function to be called by the plugin to close the modal. The `openModal`\ncall will be resolved with the passed return value",
8919
8919
  "tags": [
8920
8920
  {
8921
8921
  "tag": "example",
8922
- "text": "\n const returnValue = prompt(\n 'Please specify the value to return to the caller:',\n 'success',\n );\n\n await ctx.resolve(returnValue);\n"
8922
+ "text": "\n\n```js\nconst returnValue = prompt(\n 'Please specify the value to return to the caller:',\n 'success',\n);\n\nawait ctx.resolve(returnValue);\n```\n"
8923
8923
  }
8924
8924
  ]
8925
8925
  },
@@ -8963,7 +8963,7 @@
8963
8963
  "sources": [
8964
8964
  {
8965
8965
  "fileName": "types.ts",
8966
- "line": 993,
8966
+ "line": 1134,
8967
8967
  "character": 43
8968
8968
  }
8969
8969
  ]
@@ -8982,7 +8982,7 @@
8982
8982
  "sources": [
8983
8983
  {
8984
8984
  "fileName": "types.ts",
8985
- "line": 982,
8985
+ "line": 1122,
8986
8986
  "character": 12
8987
8987
  }
8988
8988
  ],
@@ -9007,7 +9007,7 @@
9007
9007
  "sources": [
9008
9008
  {
9009
9009
  "fileName": "types.ts",
9010
- "line": 985,
9010
+ "line": 1125,
9011
9011
  "character": 2
9012
9012
  }
9013
9013
  ],
@@ -9025,7 +9025,7 @@
9025
9025
  "sources": [
9026
9026
  {
9027
9027
  "fileName": "types.ts",
9028
- "line": 983,
9028
+ "line": 1123,
9029
9029
  "character": 2
9030
9030
  }
9031
9031
  ],
@@ -9046,7 +9046,7 @@
9046
9046
  "sources": [
9047
9047
  {
9048
9048
  "fileName": "types.ts",
9049
- "line": 987,
9049
+ "line": 1127,
9050
9050
  "character": 2
9051
9051
  }
9052
9052
  ],
@@ -9080,7 +9080,7 @@
9080
9080
  "sources": [
9081
9081
  {
9082
9082
  "fileName": "types.ts",
9083
- "line": 982,
9083
+ "line": 1122,
9084
9084
  "character": 46
9085
9085
  }
9086
9086
  ]
@@ -9125,7 +9125,7 @@
9125
9125
  "sources": [
9126
9126
  {
9127
9127
  "fileName": "types.ts",
9128
- "line": 1010,
9128
+ "line": 1154,
9129
9129
  "character": 12
9130
9130
  }
9131
9131
  ],
@@ -9159,7 +9159,7 @@
9159
9159
  "sources": [
9160
9160
  {
9161
9161
  "fileName": "types.ts",
9162
- "line": 990,
9162
+ "line": 1130,
9163
9163
  "character": 12
9164
9164
  }
9165
9165
  ],
@@ -9188,7 +9188,7 @@
9188
9188
  "sources": [
9189
9189
  {
9190
9190
  "fileName": "types.ts",
9191
- "line": 1014,
9191
+ "line": 1158,
9192
9192
  "character": 12
9193
9193
  }
9194
9194
  ],
@@ -9217,7 +9217,7 @@
9217
9217
  "sources": [
9218
9218
  {
9219
9219
  "fileName": "types.ts",
9220
- "line": 1025,
9220
+ "line": 1171,
9221
9221
  "character": 12
9222
9222
  }
9223
9223
  ],
@@ -9239,7 +9239,7 @@
9239
9239
  "sources": [
9240
9240
  {
9241
9241
  "fileName": "types.ts",
9242
- "line": 1026,
9242
+ "line": 1172,
9243
9243
  "character": 2
9244
9244
  }
9245
9245
  ],
@@ -9277,7 +9277,7 @@
9277
9277
  "sources": [
9278
9278
  {
9279
9279
  "fileName": "types.ts",
9280
- "line": 1025,
9280
+ "line": 1171,
9281
9281
  "character": 42
9282
9282
  }
9283
9283
  ]
@@ -9296,7 +9296,7 @@
9296
9296
  "sources": [
9297
9297
  {
9298
9298
  "fileName": "types.ts",
9299
- "line": 1017,
9299
+ "line": 1162,
9300
9300
  "character": 12
9301
9301
  }
9302
9302
  ],
@@ -9318,7 +9318,7 @@
9318
9318
  "sources": [
9319
9319
  {
9320
9320
  "fileName": "types.ts",
9321
- "line": 1018,
9321
+ "line": 1163,
9322
9322
  "character": 2
9323
9323
  }
9324
9324
  ],
@@ -9339,7 +9339,7 @@
9339
9339
  "sources": [
9340
9340
  {
9341
9341
  "fileName": "types.ts",
9342
- "line": 1020,
9342
+ "line": 1165,
9343
9343
  "character": 2
9344
9344
  }
9345
9345
  ],
@@ -9362,7 +9362,7 @@
9362
9362
  "sources": [
9363
9363
  {
9364
9364
  "fileName": "types.ts",
9365
- "line": 1017,
9365
+ "line": 1162,
9366
9366
  "character": 45
9367
9367
  }
9368
9368
  ]
@@ -9397,7 +9397,7 @@
9397
9397
  "sources": [
9398
9398
  {
9399
9399
  "fileName": "types.ts",
9400
- "line": 1029,
9400
+ "line": 1175,
9401
9401
  "character": 12
9402
9402
  }
9403
9403
  ],
@@ -9426,7 +9426,7 @@
9426
9426
  "sources": [
9427
9427
  {
9428
9428
  "fileName": "types.ts",
9429
- "line": 1023,
9429
+ "line": 1168,
9430
9430
  "character": 12
9431
9431
  }
9432
9432
  ],
@@ -9455,7 +9455,7 @@
9455
9455
  "sources": [
9456
9456
  {
9457
9457
  "fileName": "types.ts",
9458
- "line": 1031,
9458
+ "line": 1177,
9459
9459
  "character": 12
9460
9460
  }
9461
9461
  ],
@@ -9484,7 +9484,7 @@
9484
9484
  "sources": [
9485
9485
  {
9486
9486
  "fileName": "types.ts",
9487
- "line": 436,
9487
+ "line": 473,
9488
9488
  "character": 12
9489
9489
  }
9490
9490
  ],
@@ -9513,7 +9513,7 @@
9513
9513
  "sources": [
9514
9514
  {
9515
9515
  "fileName": "types.ts",
9516
- "line": 943,
9516
+ "line": 1080,
9517
9517
  "character": 12
9518
9518
  }
9519
9519
  ],
@@ -9542,7 +9542,7 @@
9542
9542
  "sources": [
9543
9543
  {
9544
9544
  "fileName": "types.ts",
9545
- "line": 936,
9545
+ "line": 1073,
9546
9546
  "character": 12
9547
9547
  }
9548
9548
  ],
@@ -9564,7 +9564,7 @@
9564
9564
  "sources": [
9565
9565
  {
9566
9566
  "fileName": "types.ts",
9567
- "line": 937,
9567
+ "line": 1074,
9568
9568
  "character": 2
9569
9569
  }
9570
9570
  ],
@@ -9602,7 +9602,7 @@
9602
9602
  "sources": [
9603
9603
  {
9604
9604
  "fileName": "types.ts",
9605
- "line": 936,
9605
+ "line": 1073,
9606
9606
  "character": 50
9607
9607
  }
9608
9608
  ]
@@ -9621,7 +9621,7 @@
9621
9621
  "sources": [
9622
9622
  {
9623
9623
  "fileName": "types.ts",
9624
- "line": 925,
9624
+ "line": 1059,
9625
9625
  "character": 12
9626
9626
  }
9627
9627
  ],
@@ -9643,7 +9643,7 @@
9643
9643
  "sources": [
9644
9644
  {
9645
9645
  "fileName": "types.ts",
9646
- "line": 926,
9646
+ "line": 1060,
9647
9647
  "character": 2
9648
9648
  }
9649
9649
  ],
@@ -9659,12 +9659,12 @@
9659
9659
  "kindString": "Property",
9660
9660
  "flags": {},
9661
9661
  "comment": {
9662
- "shortText": "The arbitrary `parameters` of the panel declared in the `itemFormSidebarPanels` function"
9662
+ "shortText": "The arbitrary `parameters` of the panel declared in the\n`itemFormSidebarPanels` function"
9663
9663
  },
9664
9664
  "sources": [
9665
9665
  {
9666
9666
  "fileName": "types.ts",
9667
- "line": 930,
9667
+ "line": 1067,
9668
9668
  "character": 2
9669
9669
  }
9670
9670
  ],
@@ -9695,7 +9695,7 @@
9695
9695
  "sources": [
9696
9696
  {
9697
9697
  "fileName": "types.ts",
9698
- "line": 928,
9698
+ "line": 1062,
9699
9699
  "character": 2
9700
9700
  }
9701
9701
  ],
@@ -9719,7 +9719,7 @@
9719
9719
  "sources": [
9720
9720
  {
9721
9721
  "fileName": "types.ts",
9722
- "line": 925,
9722
+ "line": 1059,
9723
9723
  "character": 53
9724
9724
  }
9725
9725
  ]
@@ -9735,7 +9735,7 @@
9735
9735
  "sources": [
9736
9736
  {
9737
9737
  "fileName": "types.ts",
9738
- "line": 940,
9738
+ "line": 1077,
9739
9739
  "character": 12
9740
9740
  }
9741
9741
  ],
@@ -9764,7 +9764,7 @@
9764
9764
  "sources": [
9765
9765
  {
9766
9766
  "fileName": "types.ts",
9767
- "line": 933,
9767
+ "line": 1070,
9768
9768
  "character": 12
9769
9769
  }
9770
9770
  ],
@@ -9796,7 +9796,7 @@
9796
9796
  "sources": [
9797
9797
  {
9798
9798
  "fileName": "types.ts",
9799
- "line": 57,
9799
+ "line": 61,
9800
9800
  "character": 12
9801
9801
  }
9802
9802
  ],
@@ -9821,7 +9821,7 @@
9821
9821
  "sources": [
9822
9822
  {
9823
9823
  "fileName": "types.ts",
9824
- "line": 61,
9824
+ "line": 65,
9825
9825
  "character": 2
9826
9826
  }
9827
9827
  ],
@@ -9842,7 +9842,7 @@
9842
9842
  "sources": [
9843
9843
  {
9844
9844
  "fileName": "types.ts",
9845
- "line": 59,
9845
+ "line": 63,
9846
9846
  "character": 2
9847
9847
  }
9848
9848
  ],
@@ -9863,7 +9863,7 @@
9863
9863
  "sources": [
9864
9864
  {
9865
9865
  "fileName": "types.ts",
9866
- "line": 63,
9866
+ "line": 67,
9867
9867
  "character": 2
9868
9868
  }
9869
9869
  ],
@@ -9885,7 +9885,7 @@
9885
9885
  "sources": [
9886
9886
  {
9887
9887
  "fileName": "types.ts",
9888
- "line": 64,
9888
+ "line": 68,
9889
9889
  "character": 4
9890
9890
  }
9891
9891
  ],
@@ -9907,7 +9907,7 @@
9907
9907
  "sources": [
9908
9908
  {
9909
9909
  "fileName": "types.ts",
9910
- "line": 63,
9910
+ "line": 67,
9911
9911
  "character": 12
9912
9912
  }
9913
9913
  ]
@@ -9929,7 +9929,7 @@
9929
9929
  "sources": [
9930
9930
  {
9931
9931
  "fileName": "types.ts",
9932
- "line": 57,
9932
+ "line": 61,
9933
9933
  "character": 38
9934
9934
  }
9935
9935
  ]
@@ -9943,12 +9943,12 @@
9943
9943
  "kindString": "Type alias",
9944
9944
  "flags": {},
9945
9945
  "comment": {
9946
- "shortText": "The sidebar in the Settings Area presents a number of pages grouped by topic. This\nobject represents a new group to be added in the sideebar to the standard ones DatoCMS provides."
9946
+ "shortText": "The sidebar in the Settings Area presents a number of pages grouped by topic.\nThis object represents a new group to be added in the sideebar to the\nstandard ones DatoCMS provides."
9947
9947
  },
9948
9948
  "sources": [
9949
9949
  {
9950
9950
  "fileName": "types.ts",
9951
- "line": 72,
9951
+ "line": 77,
9952
9952
  "character": 12
9953
9953
  }
9954
9954
  ],
@@ -9973,7 +9973,7 @@
9973
9973
  "sources": [
9974
9974
  {
9975
9975
  "fileName": "types.ts",
9976
- "line": 76,
9976
+ "line": 81,
9977
9977
  "character": 2
9978
9978
  }
9979
9979
  ],
@@ -9998,7 +9998,7 @@
9998
9998
  "sources": [
9999
9999
  {
10000
10000
  "fileName": "types.ts",
10001
- "line": 74,
10001
+ "line": 79,
10002
10002
  "character": 2
10003
10003
  }
10004
10004
  ],
@@ -10016,12 +10016,12 @@
10016
10016
  "isOptional": true
10017
10017
  },
10018
10018
  "comment": {
10019
- "shortText": "Expresses where you want the group to be placed inside the sidebar. If not specified,\nthe item will be placed after the standard items provided by DatoCMS itself."
10019
+ "shortText": "Expresses where you want the group to be placed inside the sidebar. If not\nspecified, the item will be placed after the standard items provided by\nDatoCMS itself."
10020
10020
  },
10021
10021
  "sources": [
10022
10022
  {
10023
10023
  "fileName": "types.ts",
10024
- "line": 81,
10024
+ "line": 87,
10025
10025
  "character": 2
10026
10026
  }
10027
10027
  ],
@@ -10090,12 +10090,12 @@
10090
10090
  "isOptional": true
10091
10091
  },
10092
10092
  "comment": {
10093
- "shortText": "If different plugins specify the same `placement` for their sections, they will be\ndisplayed by ascending `rank`. If you want to specify an explicit value for `rank`,\nmake sure to offer a way for final users to customize it inside the plugin's settings\nform, otherwise the hardcoded value you choose might clash with the one of another plugin! *"
10093
+ "shortText": "If different plugins specify the same `placement` for their sections, they\nwill be displayed by ascending `rank`. If you want to specify an explicit\nvalue for `rank`, make sure to offer a way for final users to customize it\ninside the plugin's settings form, otherwise the hardcoded value you choose\nmight clash with the one of another plugin! *"
10094
10094
  },
10095
10095
  "sources": [
10096
10096
  {
10097
10097
  "fileName": "types.ts",
10098
- "line": 100,
10098
+ "line": 107,
10099
10099
  "character": 2
10100
10100
  }
10101
10101
  ],
@@ -10120,7 +10120,7 @@
10120
10120
  "sources": [
10121
10121
  {
10122
10122
  "fileName": "types.ts",
10123
- "line": 72,
10123
+ "line": 77,
10124
10124
  "character": 43
10125
10125
  }
10126
10126
  ]
@@ -10288,7 +10288,7 @@
10288
10288
  "sources": [
10289
10289
  {
10290
10290
  "fileName": "types.ts",
10291
- "line": 270,
10291
+ "line": 297,
10292
10292
  "character": 12
10293
10293
  }
10294
10294
  ],
@@ -10310,7 +10310,7 @@
10310
10310
  "sources": [
10311
10311
  {
10312
10312
  "fileName": "types.ts",
10313
- "line": 272,
10313
+ "line": 299,
10314
10314
  "character": 2
10315
10315
  }
10316
10316
  ],
@@ -10328,7 +10328,7 @@
10328
10328
  "sources": [
10329
10329
  {
10330
10330
  "fileName": "types.ts",
10331
- "line": 275,
10331
+ "line": 302,
10332
10332
  "character": 2
10333
10333
  }
10334
10334
  ],
@@ -10346,7 +10346,7 @@
10346
10346
  "sources": [
10347
10347
  {
10348
10348
  "fileName": "types.ts",
10349
- "line": 274,
10349
+ "line": 301,
10350
10350
  "character": 2
10351
10351
  }
10352
10352
  ],
@@ -10364,7 +10364,7 @@
10364
10364
  "sources": [
10365
10365
  {
10366
10366
  "fileName": "types.ts",
10367
- "line": 271,
10367
+ "line": 298,
10368
10368
  "character": 2
10369
10369
  }
10370
10370
  ],
@@ -10382,7 +10382,7 @@
10382
10382
  "sources": [
10383
10383
  {
10384
10384
  "fileName": "types.ts",
10385
- "line": 273,
10385
+ "line": 300,
10386
10386
  "character": 2
10387
10387
  }
10388
10388
  ],
@@ -10408,7 +10408,7 @@
10408
10408
  "sources": [
10409
10409
  {
10410
10410
  "fileName": "types.ts",
10411
- "line": 270,
10411
+ "line": 297,
10412
10412
  "character": 20
10413
10413
  }
10414
10414
  ]
@@ -10427,7 +10427,7 @@
10427
10427
  "sources": [
10428
10428
  {
10429
10429
  "fileName": "types.ts",
10430
- "line": 323,
10430
+ "line": 350,
10431
10431
  "character": 12
10432
10432
  }
10433
10433
  ],
@@ -10467,7 +10467,7 @@
10467
10467
  "sources": [
10468
10468
  {
10469
10469
  "fileName": "types.ts",
10470
- "line": 329,
10470
+ "line": 356,
10471
10471
  "character": 2
10472
10472
  }
10473
10473
  ],
@@ -10492,7 +10492,7 @@
10492
10492
  "sources": [
10493
10493
  {
10494
10494
  "fileName": "types.ts",
10495
- "line": 331,
10495
+ "line": 358,
10496
10496
  "character": 4
10497
10497
  }
10498
10498
  ],
@@ -10508,12 +10508,12 @@
10508
10508
  "kindString": "Property",
10509
10509
  "flags": {},
10510
10510
  "comment": {
10511
- "shortText": "The value to be returned by the `customToast` promise if the button is clicked by the user"
10511
+ "shortText": "The value to be returned by the `customToast` promise if the button is\nclicked by the user"
10512
10512
  },
10513
10513
  "sources": [
10514
10514
  {
10515
10515
  "fileName": "types.ts",
10516
- "line": 333,
10516
+ "line": 363,
10517
10517
  "character": 4
10518
10518
  }
10519
10519
  ],
@@ -10537,7 +10537,7 @@
10537
10537
  "sources": [
10538
10538
  {
10539
10539
  "fileName": "types.ts",
10540
- "line": 329,
10540
+ "line": 356,
10541
10541
  "character": 8
10542
10542
  }
10543
10543
  ]
@@ -10553,12 +10553,12 @@
10553
10553
  "isOptional": true
10554
10554
  },
10555
10555
  "comment": {
10556
- "shortText": "Whether the toast is to be automatically closed after some time (`true` will use the\ndefault DatoCMS time interval)"
10556
+ "shortText": "Whether the toast is to be automatically closed after some time (`true`\nwill use the default DatoCMS time interval)"
10557
10557
  },
10558
10558
  "sources": [
10559
10559
  {
10560
10560
  "fileName": "types.ts",
10561
- "line": 341,
10561
+ "line": 371,
10562
10562
  "character": 2
10563
10563
  }
10564
10564
  ],
@@ -10590,7 +10590,7 @@
10590
10590
  "sources": [
10591
10591
  {
10592
10592
  "fileName": "types.ts",
10593
- "line": 336,
10593
+ "line": 366,
10594
10594
  "character": 2
10595
10595
  }
10596
10596
  ],
@@ -10611,7 +10611,7 @@
10611
10611
  "sources": [
10612
10612
  {
10613
10613
  "fileName": "types.ts",
10614
- "line": 325,
10614
+ "line": 352,
10615
10615
  "character": 2
10616
10616
  }
10617
10617
  ],
@@ -10632,7 +10632,7 @@
10632
10632
  "sources": [
10633
10633
  {
10634
10634
  "fileName": "types.ts",
10635
- "line": 327,
10635
+ "line": 354,
10636
10636
  "character": 2
10637
10637
  }
10638
10638
  ],
@@ -10671,7 +10671,7 @@
10671
10671
  "sources": [
10672
10672
  {
10673
10673
  "fileName": "types.ts",
10674
- "line": 323,
10674
+ "line": 350,
10675
10675
  "character": 40
10676
10676
  }
10677
10677
  ]
@@ -10690,7 +10690,7 @@
10690
10690
  "sources": [
10691
10691
  {
10692
10692
  "fileName": "types.ts",
10693
- "line": 644,
10693
+ "line": 720,
10694
10694
  "character": 12
10695
10695
  }
10696
10696
  ],
@@ -10712,7 +10712,7 @@
10712
10712
  "sources": [
10713
10713
  {
10714
10714
  "fileName": "types.ts",
10715
- "line": 653,
10715
+ "line": 735,
10716
10716
  "character": 2
10717
10717
  }
10718
10718
  ],
@@ -10728,7 +10728,7 @@
10728
10728
  "tags": [
10729
10729
  {
10730
10730
  "tag": "example",
10731
- "text": "\n const message = prompt('Please insert a message:', 'This is an alert message!');\n\n await ctx.alert(message);\n"
10731
+ "text": "\n\n```js\nconst message = prompt(\n 'Please insert a message:',\n 'This is an alert message!',\n);\n\nawait ctx.alert(message);\n```\n"
10732
10732
  }
10733
10733
  ]
10734
10734
  },
@@ -10767,7 +10767,7 @@
10767
10767
  "sources": [
10768
10768
  {
10769
10769
  "fileName": "types.ts",
10770
- "line": 682,
10770
+ "line": 773,
10771
10771
  "character": 2
10772
10772
  }
10773
10773
  ],
@@ -10783,7 +10783,7 @@
10783
10783
  "tags": [
10784
10784
  {
10785
10785
  "tag": "example",
10786
- "text": "\n const result = await ctx.customToast({\n type: 'warning',\n message: 'Just a sample warning notification!',\n dismissOnPageChange: true,\n dismissAfterTimeout: 5000,\n cta: {\n label: 'Execute call-to-action',\n value: 'cta',\n },\n });\n\n if (result === 'cta') {\n ctx.notice(`Clicked CTA!`);\n }\n"
10786
+ "text": "\n\n```js\nconst result = await ctx.customToast({\n type: 'warning',\n message: 'Just a sample warning notification!',\n dismissOnPageChange: true,\n dismissAfterTimeout: 5000,\n cta: {\n label: 'Execute call-to-action',\n value: 'cta',\n },\n});\n\nif (result === 'cta') {\n ctx.notice(`Clicked CTA!`);\n}\n```\n"
10787
10787
  }
10788
10788
  ]
10789
10789
  },
@@ -10853,7 +10853,7 @@
10853
10853
  "sources": [
10854
10854
  {
10855
10855
  "fileName": "types.ts",
10856
- "line": 662,
10856
+ "line": 750,
10857
10857
  "character": 2
10858
10858
  }
10859
10859
  ],
@@ -10869,7 +10869,7 @@
10869
10869
  "tags": [
10870
10870
  {
10871
10871
  "tag": "example",
10872
- "text": "\n const message = prompt('Please insert a message:', 'This is a notice message!');\n\n await ctx.notice(message);\n"
10872
+ "text": "\n\n```js\nconst message = prompt(\n 'Please insert a message:',\n 'This is a notice message!',\n);\n\nawait ctx.notice(message);\n```\n"
10873
10873
  }
10874
10874
  ]
10875
10875
  },
@@ -10914,7 +10914,7 @@
10914
10914
  "sources": [
10915
10915
  {
10916
10916
  "fileName": "types.ts",
10917
- "line": 644,
10917
+ "line": 720,
10918
10918
  "character": 27
10919
10919
  }
10920
10920
  ]
@@ -10928,12 +10928,12 @@
10928
10928
  "kindString": "Type alias",
10929
10929
  "flags": {},
10930
10930
  "comment": {
10931
- "shortText": "These methods can be used to update both plugin parameters and manual field extensions\nconfiguration."
10931
+ "shortText": "These methods can be used to update both plugin parameters and manual field\nextensions configuration."
10932
10932
  },
10933
10933
  "sources": [
10934
10934
  {
10935
10935
  "fileName": "types.ts",
10936
- "line": 473,
10936
+ "line": 510,
10937
10937
  "character": 12
10938
10938
  }
10939
10939
  ],
@@ -10955,7 +10955,7 @@
10955
10955
  "sources": [
10956
10956
  {
10957
10957
  "fileName": "types.ts",
10958
- "line": 531,
10958
+ "line": 576,
10959
10959
  "character": 2
10960
10960
  }
10961
10961
  ],
@@ -10967,12 +10967,12 @@
10967
10967
  "kindString": "Call signature",
10968
10968
  "flags": {},
10969
10969
  "comment": {
10970
- "shortText": "Performs changes in the appearance of a field. You can install/remove a manual field\nextension, or tweak their parameters. If multiple changes are passed, they will be\napplied sequencially.",
10971
- "text": "Always check `ctx.currentRole.meta.final_permissions.can_edit_schema` before calling\nthis, as the user might not have the permission to perform the operation.\n",
10970
+ "shortText": "Performs changes in the appearance of a field. You can install/remove a\nmanual field extension, or tweak their parameters. If multiple changes are\npassed, they will be applied sequencially.",
10971
+ "text": "Always check `ctx.currentRole.meta.final_permissions.can_edit_schema`\nbefore calling this, as the user might not have the permission to perform\nthe operation.\n",
10972
10972
  "tags": [
10973
10973
  {
10974
10974
  "tag": "example",
10975
- "text": "\n const fields = await ctx.loadFieldsUsingPlugin();\n\n if (fields.length === 0) {\n ctx.alert('No field is using this plugin as a manual extension!');\n return;\n }\n\n for (const field of fields) {\n const { appearance } = field.attributes;\n const operations = [];\n\n if (appearance.editor === ctx.plugin.id) {\n operations.push({\n operation: 'updateEditor',\n newParameters: {\n ...appearance.parameters,\n foo: 'bar',\n },\n });\n }\n\n appearance.addons.forEach((addon, i) => {\n if (addon.id !== ctx.plugin.id) {\n return;\n }\n\n operations.push({\n operation: 'updateAddon',\n index: i,\n newParameters: { ...addon.parameters, foo: 'bar' },\n });\n });\n\n await ctx.updateFieldAppearance(field.id, operations);\n await ctx.notice(`Successfully edited field ${field.attributes.api_key}`);\n }\n"
10975
+ "text": "\n\n```js\nconst fields = await ctx.loadFieldsUsingPlugin();\n\nif (fields.length === 0) {\n ctx.alert('No field is using this plugin as a manual extension!');\n return;\n}\n\nfor (const field of fields) {\n const { appearance } = field.attributes;\n const operations = [];\n\n if (appearance.editor === ctx.plugin.id) {\n operations.push({\n operation: 'updateEditor',\n newParameters: {\n ...appearance.parameters,\n foo: 'bar',\n },\n });\n }\n\n appearance.addons.forEach((addon, i) => {\n if (addon.id !== ctx.plugin.id) {\n return;\n }\n\n operations.push({\n operation: 'updateAddon',\n index: i,\n newParameters: { ...addon.parameters, foo: 'bar' },\n });\n });\n\n await ctx.updateFieldAppearance(field.id, operations);\n ctx.notice(`Successfully edited field ${field.attributes.api_key}`);\n}\n```\n"
10976
10976
  }
10977
10977
  ]
10978
10978
  },
@@ -11026,7 +11026,7 @@
11026
11026
  "sources": [
11027
11027
  {
11028
11028
  "fileName": "types.ts",
11029
- "line": 484,
11029
+ "line": 525,
11030
11030
  "character": 2
11031
11031
  }
11032
11032
  ],
@@ -11039,11 +11039,11 @@
11039
11039
  "flags": {},
11040
11040
  "comment": {
11041
11041
  "shortText": "Updates the plugin parameters.",
11042
- "text": "Always check `ctx.currentRole.meta.final_permissions.can_edit_schema` before calling\nthis, as the user might not have the permission to perform the operation.\n",
11042
+ "text": "Always check `ctx.currentRole.meta.final_permissions.can_edit_schema`\nbefore calling this, as the user might not have the permission to perform\nthe operation.\n",
11043
11043
  "tags": [
11044
11044
  {
11045
11045
  "tag": "example",
11046
- "text": "\n await ctx.updatePluginParameters({ debugMode: true });\n await ctx.notice('Plugin parameters successfully updated!');\n"
11046
+ "text": "\n\n```js\nawait ctx.updatePluginParameters({ debugMode: true });\nawait ctx.notice('Plugin parameters successfully updated!');\n```\n"
11047
11047
  }
11048
11048
  ]
11049
11049
  },
@@ -11097,7 +11097,7 @@
11097
11097
  "sources": [
11098
11098
  {
11099
11099
  "fileName": "types.ts",
11100
- "line": 473,
11100
+ "line": 510,
11101
11101
  "character": 38
11102
11102
  }
11103
11103
  ]
@@ -11111,12 +11111,12 @@
11111
11111
  "kindString": "Type alias",
11112
11112
  "flags": {},
11113
11113
  "comment": {
11114
- "shortText": "These methods let you open the standard DatoCMS dialogs needed to interact with Media Area assets"
11114
+ "shortText": "These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets"
11115
11115
  },
11116
11116
  "sources": [
11117
11117
  {
11118
11118
  "fileName": "types.ts",
11119
- "line": 686,
11119
+ "line": 782,
11120
11120
  "character": 12
11121
11121
  }
11122
11122
  ],
@@ -11138,7 +11138,7 @@
11138
11138
  "sources": [
11139
11139
  {
11140
11140
  "fileName": "types.ts",
11141
- "line": 701,
11141
+ "line": 800,
11142
11142
  "character": 2
11143
11143
  }
11144
11144
  ],
@@ -11153,7 +11153,7 @@
11153
11153
  "sources": [
11154
11154
  {
11155
11155
  "fileName": "types.ts",
11156
- "line": 701,
11156
+ "line": 800,
11157
11157
  "character": 16
11158
11158
  }
11159
11159
  ],
@@ -11165,11 +11165,11 @@
11165
11165
  "kindString": "Call signature",
11166
11166
  "flags": {},
11167
11167
  "comment": {
11168
- "shortText": "Opens a dialog for selecting one (or multiple) existing asset(s). It returns a\npromise resolved with the selected asset(s), or `null` if the user closes the dialog\nwithout selecting any upload.",
11168
+ "shortText": "Opens a dialog for selecting one (or multiple) existing asset(s). It\nreturns a promise resolved with the selected asset(s), or `null` if the\nuser closes the dialog without selecting any upload.",
11169
11169
  "tags": [
11170
11170
  {
11171
11171
  "tag": "example",
11172
- "text": "\n const item = await ctx.selectUpload({ multiple: false });\n\n if (item) {\n ctx.notice(`Success! ${item.id}`);\n } else {\n ctx.alert('Closed!');\n }\n"
11172
+ "text": "\n\n```js\nconst item = await ctx.selectUpload({ multiple: false });\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
11173
11173
  }
11174
11174
  ]
11175
11175
  },
@@ -11198,7 +11198,7 @@
11198
11198
  "sources": [
11199
11199
  {
11200
11200
  "fileName": "types.ts",
11201
- "line": 702,
11201
+ "line": 801,
11202
11202
  "character": 16
11203
11203
  }
11204
11204
  ],
@@ -11252,11 +11252,11 @@
11252
11252
  "kindString": "Call signature",
11253
11253
  "flags": {},
11254
11254
  "comment": {
11255
- "shortText": "Opens a dialog for selecting one (or multiple) existing asset(s). It returns a\npromise resolved with the selected asset(s), or `null` if the user closes the dialog\nwithout selecting any upload.",
11255
+ "shortText": "Opens a dialog for selecting one (or multiple) existing asset(s). It\nreturns a promise resolved with the selected asset(s), or `null` if the\nuser closes the dialog without selecting any upload.",
11256
11256
  "tags": [
11257
11257
  {
11258
11258
  "tag": "example",
11259
- "text": "\n const item = await ctx.selectUpload({ multiple: false });\n\n if (item) {\n ctx.notice(`Success! ${item.id}`);\n } else {\n ctx.alert('Closed!');\n }\n"
11259
+ "text": "\n\n```js\nconst item = await ctx.selectUpload({ multiple: false });\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
11260
11260
  }
11261
11261
  ]
11262
11262
  },
@@ -11287,7 +11287,7 @@
11287
11287
  "sources": [
11288
11288
  {
11289
11289
  "fileName": "types.ts",
11290
- "line": 703,
11290
+ "line": 802,
11291
11291
  "character": 17
11292
11292
  }
11293
11293
  ],
@@ -11344,7 +11344,7 @@
11344
11344
  "sources": [
11345
11345
  {
11346
11346
  "fileName": "types.ts",
11347
- "line": 725,
11347
+ "line": 827,
11348
11348
  "character": 2
11349
11349
  }
11350
11350
  ],
@@ -11357,11 +11357,11 @@
11357
11357
  "flags": {},
11358
11358
  "comment": {
11359
11359
  "shortText": "Opens a dialog for editing a Media Area asset. It returns a promise resolved with:",
11360
- "text": "- The updated asset, if the user persists some changes to the asset itself\n- `null`, if the user closes the dialog without persisting any change\n- An asset structure with an additional `deleted` property set to true, if the user\n deletes the asset\n",
11360
+ "text": "- The updated asset, if the user persists some changes to the asset itself\n- `null`, if the user closes the dialog without persisting any change\n- An asset structure with an additional `deleted` property set to true, if\n the user deletes the asset\n",
11361
11361
  "tags": [
11362
11362
  {
11363
11363
  "tag": "example",
11364
- "text": "\n const uploadId = prompt('Please insert an asset ID:');\n\n const item = await ctx.editUpload(uploadId);\n\n if (item) {\n ctx.notice(`Success! ${item.id}`);\n } else {\n ctx.alert('Closed!');\n }\n"
11364
+ "text": "\n\n```js\nconst uploadId = prompt('Please insert an asset ID:');\n\nconst item = await ctx.editUpload(uploadId);\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
11365
11365
  }
11366
11366
  ]
11367
11367
  },
@@ -11416,8 +11416,8 @@
11416
11416
  "sources": [
11417
11417
  {
11418
11418
  "fileName": "types.ts",
11419
- "line": 725,
11420
- "character": 56
11419
+ "line": 829,
11420
+ "character": 27
11421
11421
  }
11422
11422
  ],
11423
11423
  "type": {
@@ -11456,7 +11456,7 @@
11456
11456
  "sources": [
11457
11457
  {
11458
11458
  "fileName": "types.ts",
11459
- "line": 748,
11459
+ "line": 855,
11460
11460
  "character": 2
11461
11461
  }
11462
11462
  ],
@@ -11468,11 +11468,11 @@
11468
11468
  "kindString": "Call signature",
11469
11469
  "flags": {},
11470
11470
  "comment": {
11471
- "shortText": "Opens a dialog for editing a \"single asset\" field structure. It returns a promise\nresolved with the updated structure, or `null` if the user closes the dialog without\npersisting any change.",
11471
+ "shortText": "Opens a dialog for editing a \"single asset\" field structure. It returns a\npromise resolved with the updated structure, or `null` if the user closes\nthe dialog without persisting any change.",
11472
11472
  "tags": [
11473
11473
  {
11474
11474
  "tag": "example",
11475
- "text": "\n const uploadId = prompt('Please insert an asset ID:');\n\n const result = await ctx.editUploadMetadata({\n upload_id: uploadId,\n alt: null,\n title: null,\n custom_data: {},\n focal_point: null,\n });\n\n if (result) {\n ctx.notice(`Success! ${JSON.stringify(result)}`);\n } else {\n ctx.alert('Closed!');\n }\n"
11475
+ "text": "\n\n```js\nconst uploadId = prompt('Please insert an asset ID:');\n\nconst result = await ctx.editUploadMetadata({\n upload_id: uploadId,\n alt: null,\n title: null,\n custom_data: {},\n focal_point: null,\n});\n\nif (result) {\n ctx.notice(`Success! ${JSON.stringify(result)}`);\n} else {\n ctx.alert('Closed!');\n}\n```\n"
11476
11476
  }
11477
11477
  ]
11478
11478
  },
@@ -11547,7 +11547,7 @@
11547
11547
  "sources": [
11548
11548
  {
11549
11549
  "fileName": "types.ts",
11550
- "line": 686,
11550
+ "line": 782,
11551
11551
  "character": 34
11552
11552
  }
11553
11553
  ]