datocms-plugin-sdk 2.0.2 → 2.0.3

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.
Files changed (31) hide show
  1. package/dist/cjs/manifest.js +254 -253
  2. package/dist/cjs/manifest.js.map +1 -1
  3. package/dist/esm/ctx/base.d.ts +1 -1
  4. package/dist/esm/hooks/renderItemFormSidebar.d.ts +1 -1
  5. package/dist/esm/hooks/renderItemFormSidebarPanel.d.ts +1 -1
  6. package/dist/esm/hooks/renderManualFieldExtensionConfigScreen.d.ts +2 -2
  7. package/dist/esm/hooks/renderModal.d.ts +1 -1
  8. package/dist/esm/hooks/renderUploadSidebar.d.ts +1 -1
  9. package/dist/esm/hooks/renderUploadSidebarPanel.d.ts +1 -1
  10. package/dist/esm/manifest.js +254 -253
  11. package/dist/esm/manifest.js.map +1 -1
  12. package/dist/esm/manifestTypes.d.ts +39 -91
  13. package/dist/types/ctx/base.d.ts +1 -1
  14. package/dist/types/hooks/renderItemFormSidebar.d.ts +1 -1
  15. package/dist/types/hooks/renderItemFormSidebarPanel.d.ts +1 -1
  16. package/dist/types/hooks/renderManualFieldExtensionConfigScreen.d.ts +2 -2
  17. package/dist/types/hooks/renderModal.d.ts +1 -1
  18. package/dist/types/hooks/renderUploadSidebar.d.ts +1 -1
  19. package/dist/types/hooks/renderUploadSidebarPanel.d.ts +1 -1
  20. package/dist/types/manifestTypes.d.ts +39 -91
  21. package/manifest.json +254 -253
  22. package/package.json +2 -2
  23. package/src/ctx/base.ts +1 -1
  24. package/src/hooks/renderItemFormSidebar.ts +1 -1
  25. package/src/hooks/renderItemFormSidebarPanel.ts +1 -1
  26. package/src/hooks/renderManualFieldExtensionConfigScreen.ts +2 -2
  27. package/src/hooks/renderModal.ts +1 -1
  28. package/src/hooks/renderUploadSidebar.ts +1 -1
  29. package/src/hooks/renderUploadSidebarPanel.ts +1 -1
  30. package/src/manifest.ts +408 -374
  31. package/src/manifestTypes.ts +39 -91
package/src/manifest.ts CHANGED
@@ -5,8 +5,8 @@ export const manifest: Manifest = {
5
5
  validateManualFieldExtensionParameters: {
6
6
  name: 'validateManualFieldExtensionParameters',
7
7
  comment: {
8
- comment:
9
- 'This function will be called each time the configuration object changes. It\nmust return an object containing possible validation errors',
8
+ markdownText:
9
+ 'This function will be called each time the configuration object changes. It\nmust return an object containing possible validation errors.',
10
10
  tag: 'manualFieldExtensions',
11
11
  },
12
12
  nonCtxArguments: [
@@ -28,7 +28,7 @@ export const manifest: Manifest = {
28
28
  uploadsDropdownActions: {
29
29
  name: 'uploadsDropdownActions',
30
30
  comment: {
31
- comment:
31
+ markdownText:
32
32
  'This function lets you set up custom actions (or groups of actions) that\nshow up when the user:\n\n* selects multiple assets in the Media Area for batch operations, or\n* opens up a specific asset from the Media Area.\n\nThe `executeUploadsDropdownAction()` hook will be triggered once the user\nclicks on one of the defined actions.',
33
33
  tag: 'dropdownActions',
34
34
  },
@@ -47,8 +47,8 @@ export const manifest: Manifest = {
47
47
  uploadSidebars: {
48
48
  name: 'uploadSidebars',
49
49
  comment: {
50
- comment:
51
- 'Use this function to declare new sidebar to be shown when the user opens\nup an asset in the Media Area',
50
+ markdownText:
51
+ 'Use this function to declare new sidebar to be shown when the user opens\nup an asset in the Media Area.',
52
52
  tag: 'sidebarPanels',
53
53
  },
54
54
  nonCtxArguments: [],
@@ -66,8 +66,8 @@ export const manifest: Manifest = {
66
66
  uploadSidebarPanels: {
67
67
  name: 'uploadSidebarPanels',
68
68
  comment: {
69
- comment:
70
- 'Use this function to declare new sidebar panels to be shown when the user\nopens up an asset in the Media Area',
69
+ markdownText:
70
+ 'Use this function to declare new sidebar panels to be shown when the user\nopens up an asset in the Media Area.',
71
71
  tag: 'sidebarPanels',
72
72
  },
73
73
  nonCtxArguments: [],
@@ -85,8 +85,8 @@ export const manifest: Manifest = {
85
85
  settingsAreaSidebarItemGroups: {
86
86
  name: 'settingsAreaSidebarItemGroups',
87
87
  comment: {
88
- comment:
89
- 'Use this function to declare new navigation sections in the Settings Area\nsidebar',
88
+ markdownText:
89
+ 'Use this function to declare new navigation sections in the Settings Area\nsidebar.',
90
90
  tag: 'pages',
91
91
  },
92
92
  nonCtxArguments: [],
@@ -104,8 +104,8 @@ export const manifest: Manifest = {
104
104
  renderUploadSidebarPanel: {
105
105
  name: 'renderUploadSidebarPanel',
106
106
  comment: {
107
- comment:
108
- 'This function will be called when the plugin needs to render a sidebar panel\n(see the `uploadSidebarPanels` function)',
107
+ markdownText:
108
+ 'This function will be called when the plugin needs to render a sidebar panel\n(see the `uploadSidebarPanels` hook).',
109
109
  tag: 'sidebarPanels',
110
110
  },
111
111
  nonCtxArguments: [
@@ -121,8 +121,8 @@ export const manifest: Manifest = {
121
121
  items: {
122
122
  sidebarPaneId: {
123
123
  comment: {
124
- comment:
125
- 'The ID of the sidebar panel that needs to be rendered',
124
+ markdownText:
125
+ 'The ID of the sidebar panel that needs to be rendered.',
126
126
  },
127
127
  location: {
128
128
  filePath: 'src/hooks/renderUploadSidebarPanel.ts',
@@ -132,8 +132,8 @@ export const manifest: Manifest = {
132
132
  },
133
133
  parameters: {
134
134
  comment: {
135
- comment:
136
- 'The arbitrary `parameters` of the panel declared in the\n`uploadSidebarPanels` function',
135
+ markdownText:
136
+ 'The arbitrary `parameters` of the panel declared in the\n`uploadSidebarPanels` function.',
137
137
  },
138
138
  location: {
139
139
  filePath: 'src/hooks/renderUploadSidebarPanel.ts',
@@ -143,7 +143,7 @@ export const manifest: Manifest = {
143
143
  },
144
144
  upload: {
145
145
  comment: {
146
- comment: 'The active asset',
146
+ markdownText: 'The active asset.',
147
147
  },
148
148
  location: {
149
149
  filePath: 'src/hooks/renderUploadSidebarPanel.ts',
@@ -165,8 +165,8 @@ export const manifest: Manifest = {
165
165
  renderUploadSidebar: {
166
166
  name: 'renderUploadSidebar',
167
167
  comment: {
168
- comment:
169
- 'This function will be called when the plugin needs to render a sidebar (see\nthe `uploadSidebars` function)',
168
+ markdownText:
169
+ 'This function will be called when the plugin needs to render a sidebar (see\nthe `uploadSidebars` hook).',
170
170
  tag: 'sidebarPanels',
171
171
  },
172
172
  nonCtxArguments: [
@@ -182,7 +182,8 @@ export const manifest: Manifest = {
182
182
  items: {
183
183
  sidebarId: {
184
184
  comment: {
185
- comment: 'The ID of the sidebar that needs to be rendered',
185
+ markdownText:
186
+ 'The ID of the sidebar that needs to be rendered.',
186
187
  },
187
188
  location: {
188
189
  filePath: 'src/hooks/renderUploadSidebar.ts',
@@ -192,8 +193,8 @@ export const manifest: Manifest = {
192
193
  },
193
194
  parameters: {
194
195
  comment: {
195
- comment:
196
- 'The arbitrary `parameters` of the declared in the `uploadSidebars`\nfunction',
196
+ markdownText:
197
+ 'The arbitrary `parameters` of the declared in the `uploadSidebars`\nfunction.',
197
198
  },
198
199
  location: {
199
200
  filePath: 'src/hooks/renderUploadSidebar.ts',
@@ -203,7 +204,7 @@ export const manifest: Manifest = {
203
204
  },
204
205
  upload: {
205
206
  comment: {
206
- comment: 'The active asset',
207
+ markdownText: 'The active asset.',
207
208
  },
208
209
  location: {
209
210
  filePath: 'src/hooks/renderUploadSidebar.ts',
@@ -225,8 +226,8 @@ export const manifest: Manifest = {
225
226
  renderPage: {
226
227
  name: 'renderPage',
227
228
  comment: {
228
- comment:
229
- 'This function will be called when the plugin needs to render a specific\npage (see the `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and\n`contentAreaSidebarItems` functions)',
229
+ markdownText:
230
+ 'This function will be called when the plugin needs to render a specific\npage (see the `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and\n`contentAreaSidebarItems` functions).',
230
231
  tag: 'pages',
231
232
  },
232
233
  nonCtxArguments: [
@@ -242,7 +243,7 @@ export const manifest: Manifest = {
242
243
  items: {
243
244
  pageId: {
244
245
  comment: {
245
- comment: 'The ID of the page that needs to be rendered',
246
+ markdownText: 'The ID of the page that needs to be rendered.',
246
247
  },
247
248
  location: {
248
249
  filePath: 'src/hooks/renderPage.ts',
@@ -264,8 +265,8 @@ export const manifest: Manifest = {
264
265
  renderModal: {
265
266
  name: 'renderModal',
266
267
  comment: {
267
- comment:
268
- 'This function will be called when the plugin requested to open a modal (see\nthe `openModal` function)',
268
+ markdownText:
269
+ 'This function will be called when the plugin requested to open a modal (see\nthe `openModal` hook).',
269
270
  tag: 'modals',
270
271
  },
271
272
  nonCtxArguments: [
@@ -281,7 +282,8 @@ export const manifest: Manifest = {
281
282
  items: {
282
283
  modalId: {
283
284
  comment: {
284
- comment: 'The ID of the modal that needs to be rendered',
285
+ markdownText:
286
+ 'The ID of the modal that needs to be rendered.',
285
287
  },
286
288
  location: {
287
289
  filePath: 'src/hooks/renderModal.ts',
@@ -291,8 +293,8 @@ export const manifest: Manifest = {
291
293
  },
292
294
  parameters: {
293
295
  comment: {
294
- comment:
295
- 'The arbitrary `parameters` of the modal declared in the `openModal`\nfunction',
296
+ markdownText:
297
+ 'The arbitrary `parameters` of the modal declared in the `openModal`\nfunction.',
296
298
  },
297
299
  location: {
298
300
  filePath: 'src/hooks/renderModal.ts',
@@ -308,8 +310,8 @@ export const manifest: Manifest = {
308
310
  items: {
309
311
  resolve: {
310
312
  comment: {
311
- comment:
312
- 'A function to be called by the plugin to close the modal. The `openModal`\ncall will be resolved with the passed return value',
313
+ markdownText:
314
+ 'A function to be called by the plugin to close the modal. The `openModal`\ncall will be resolved with the passed return value.',
313
315
  example:
314
316
  "const returnValue = prompt(\n 'Please specify the value to return to the caller:',\n 'success',\n);\n\nawait ctx.resolve(returnValue);",
315
317
  },
@@ -344,8 +346,8 @@ export const manifest: Manifest = {
344
346
  items: {
345
347
  fieldExtensionId: {
346
348
  comment: {
347
- comment:
348
- 'The ID of the field extension for which we need to render the parameters\nform',
349
+ markdownText:
350
+ 'The ID of the field extension for which we need to render the parameters\nform.',
349
351
  },
350
352
  location: {
351
353
  filePath:
@@ -356,8 +358,8 @@ export const manifest: Manifest = {
356
358
  },
357
359
  parameters: {
358
360
  comment: {
359
- comment:
360
- 'The current value of the parameters (you can change the value with the\n`setParameters` function)',
361
+ markdownText:
362
+ 'The current value of the parameters (you can change the value with the\n`setParameters` hook).',
361
363
  },
362
364
  location: {
363
365
  filePath:
@@ -368,8 +370,8 @@ export const manifest: Manifest = {
368
370
  },
369
371
  errors: {
370
372
  comment: {
371
- comment:
372
- 'The current validation errors for the parameters (you can set them\nimplementing the `validateManualFieldExtensionParameters` function)',
373
+ markdownText:
374
+ 'The current validation errors for the parameters (you can set them\nimplementing the `validateManualFieldExtensionParameters` hook).',
373
375
  },
374
376
  location: {
375
377
  filePath:
@@ -380,7 +382,8 @@ export const manifest: Manifest = {
380
382
  },
381
383
  pendingField: {
382
384
  comment: {
383
- comment: 'The field entity that is being edited in the form',
385
+ markdownText:
386
+ 'The field entity that is being edited in the form.',
384
387
  },
385
388
  location: {
386
389
  filePath:
@@ -391,7 +394,7 @@ export const manifest: Manifest = {
391
394
  },
392
395
  itemType: {
393
396
  comment: {
394
- comment: 'The model for the field being edited',
397
+ markdownText: 'The model for the field being edited.',
395
398
  },
396
399
  location: {
397
400
  filePath:
@@ -408,7 +411,7 @@ export const manifest: Manifest = {
408
411
  items: {
409
412
  setParameters: {
410
413
  comment: {
411
- comment: 'Sets a new value for the parameters',
414
+ markdownText: 'Sets a new value for the parameters.',
412
415
  example: "await ctx.setParameters({ color: '#ff0000' });",
413
416
  },
414
417
  location: {
@@ -431,8 +434,8 @@ export const manifest: Manifest = {
431
434
  renderItemFormSidebarPanel: {
432
435
  name: 'renderItemFormSidebarPanel',
433
436
  comment: {
434
- comment:
435
- 'This function will be called when the plugin needs to render a sidebar panel\n(see the `itemFormSidebarPanels` function)',
437
+ markdownText:
438
+ 'This function will be called when the plugin needs to render a sidebar panel\n(see the `itemFormSidebarPanels` hook).',
436
439
  tag: 'sidebarPanels',
437
440
  },
438
441
  nonCtxArguments: [
@@ -447,13 +450,13 @@ export const manifest: Manifest = {
447
450
  {
448
451
  name: 'ItemFormAdditionalProperties',
449
452
  comment: {
450
- comment:
451
- "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
453
+ markdownText:
454
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
452
455
  },
453
456
  items: {
454
457
  locale: {
455
458
  comment: {
456
- comment: 'The currently active locale for the record',
459
+ markdownText: 'The currently active locale for the record.',
457
460
  },
458
461
  location: {
459
462
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -463,8 +466,8 @@ export const manifest: Manifest = {
463
466
  },
464
467
  item: {
465
468
  comment: {
466
- comment:
467
- 'If an already persisted record is being edited, returns the full record\nentity',
469
+ markdownText:
470
+ 'If an already persisted record is being edited, returns the full record\nentity.',
468
471
  },
469
472
  location: {
470
473
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -474,7 +477,7 @@ export const manifest: Manifest = {
474
477
  },
475
478
  itemType: {
476
479
  comment: {
477
- comment: 'The model for the record being edited',
480
+ markdownText: 'The model for the record being edited.',
478
481
  },
479
482
  location: {
480
483
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -484,7 +487,7 @@ export const manifest: Manifest = {
484
487
  },
485
488
  formValues: {
486
489
  comment: {
487
- comment: 'The complete internal form state',
490
+ markdownText: 'The complete internal form state.',
488
491
  },
489
492
  location: {
490
493
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -494,7 +497,8 @@ export const manifest: Manifest = {
494
497
  },
495
498
  itemStatus: {
496
499
  comment: {
497
- comment: 'The current status of the record being edited',
500
+ markdownText:
501
+ 'The current status of the record being edited.',
498
502
  },
499
503
  location: {
500
504
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -504,8 +508,8 @@ export const manifest: Manifest = {
504
508
  },
505
509
  isSubmitting: {
506
510
  comment: {
507
- comment:
508
- 'Whether the form is currently submitting itself or not',
511
+ markdownText:
512
+ 'Whether the form is currently submitting itself or not.',
509
513
  },
510
514
  location: {
511
515
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -515,8 +519,8 @@ export const manifest: Manifest = {
515
519
  },
516
520
  isFormDirty: {
517
521
  comment: {
518
- comment:
519
- 'Whether the form has some non-persisted changes or not',
522
+ markdownText:
523
+ 'Whether the form has some non-persisted changes or not.',
520
524
  },
521
525
  location: {
522
526
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -526,8 +530,8 @@ export const manifest: Manifest = {
526
530
  },
527
531
  blocksAnalysis: {
528
532
  comment: {
529
- comment:
530
- 'Provides information on how many blocks are currently present in the form',
533
+ markdownText:
534
+ 'Provides information on how many blocks are currently present in the form.',
531
535
  },
532
536
  location: {
533
537
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -541,8 +545,8 @@ export const manifest: Manifest = {
541
545
  items: {
542
546
  sidebarPaneId: {
543
547
  comment: {
544
- comment:
545
- 'The ID of the sidebar panel that needs to be rendered',
548
+ markdownText:
549
+ 'The ID of the sidebar panel that needs to be rendered.',
546
550
  },
547
551
  location: {
548
552
  filePath: 'src/hooks/renderItemFormSidebarPanel.ts',
@@ -552,8 +556,8 @@ export const manifest: Manifest = {
552
556
  },
553
557
  parameters: {
554
558
  comment: {
555
- comment:
556
- 'The arbitrary `parameters` of the panel declared in the\n`itemFormSidebarPanels` function',
559
+ markdownText:
560
+ 'The arbitrary `parameters` of the panel declared in the\n`itemFormSidebarPanels` function.',
557
561
  },
558
562
  location: {
559
563
  filePath: 'src/hooks/renderItemFormSidebarPanel.ts',
@@ -568,13 +572,13 @@ export const manifest: Manifest = {
568
572
  {
569
573
  name: 'ItemFormAdditionalMethods',
570
574
  comment: {
571
- comment:
572
- "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
575
+ markdownText:
576
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
573
577
  },
574
578
  items: {
575
579
  toggleField: {
576
580
  comment: {
577
- comment:
581
+ markdownText:
578
582
  'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
579
583
  example:
580
584
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
@@ -587,7 +591,8 @@ export const manifest: Manifest = {
587
591
  },
588
592
  disableField: {
589
593
  comment: {
590
- comment: 'Disables/re-enables a specific field in the form',
594
+ markdownText:
595
+ 'Disables/re-enables a specific field in the form.',
591
596
  example:
592
597
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
593
598
  },
@@ -599,7 +604,7 @@ export const manifest: Manifest = {
599
604
  },
600
605
  scrollToField: {
601
606
  comment: {
602
- comment:
607
+ markdownText:
603
608
  '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\nfield.',
604
609
  example:
605
610
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
@@ -612,7 +617,8 @@ export const manifest: Manifest = {
612
617
  },
613
618
  setFieldValue: {
614
619
  comment: {
615
- comment: 'Changes a specific path of the `formValues` object',
620
+ markdownText:
621
+ 'Changes a specific path of the `formValues` object.',
616
622
  example:
617
623
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
618
624
  },
@@ -624,7 +630,7 @@ export const manifest: Manifest = {
624
630
  },
625
631
  formValuesToItem: {
626
632
  comment: {
627
- comment:
633
+ markdownText:
628
634
  'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
629
635
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
630
636
  },
@@ -636,8 +642,8 @@ export const manifest: Manifest = {
636
642
  },
637
643
  itemToFormValues: {
638
644
  comment: {
639
- comment:
640
- 'Takes an Item entity, and converts it into the internal form state',
645
+ markdownText:
646
+ 'Takes an Item entity, and converts it into the internal form state.',
641
647
  example: 'await ctx.itemToFormValues(ctx.item);',
642
648
  },
643
649
  location: {
@@ -648,7 +654,7 @@ export const manifest: Manifest = {
648
654
  },
649
655
  saveCurrentItem: {
650
656
  comment: {
651
- comment: 'Triggers a submit form for current record',
657
+ markdownText: 'Triggers a submit form for current record.',
652
658
  example: 'await ctx.saveCurrentItem();',
653
659
  },
654
660
  location: {
@@ -670,8 +676,8 @@ export const manifest: Manifest = {
670
676
  renderItemFormSidebar: {
671
677
  name: 'renderItemFormSidebar',
672
678
  comment: {
673
- comment:
674
- 'This function will be called when the plugin needs to render a sidebar (see\nthe `itemFormSidebars` function)',
679
+ markdownText:
680
+ 'This function will be called when the plugin needs to render a sidebar (see\nthe `itemFormSidebars` hook).',
675
681
  tag: 'sidebarPanels',
676
682
  },
677
683
  nonCtxArguments: [
@@ -686,13 +692,13 @@ export const manifest: Manifest = {
686
692
  {
687
693
  name: 'ItemFormAdditionalProperties',
688
694
  comment: {
689
- comment:
690
- "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
695
+ markdownText:
696
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
691
697
  },
692
698
  items: {
693
699
  locale: {
694
700
  comment: {
695
- comment: 'The currently active locale for the record',
701
+ markdownText: 'The currently active locale for the record.',
696
702
  },
697
703
  location: {
698
704
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -702,8 +708,8 @@ export const manifest: Manifest = {
702
708
  },
703
709
  item: {
704
710
  comment: {
705
- comment:
706
- 'If an already persisted record is being edited, returns the full record\nentity',
711
+ markdownText:
712
+ 'If an already persisted record is being edited, returns the full record\nentity.',
707
713
  },
708
714
  location: {
709
715
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -713,7 +719,7 @@ export const manifest: Manifest = {
713
719
  },
714
720
  itemType: {
715
721
  comment: {
716
- comment: 'The model for the record being edited',
722
+ markdownText: 'The model for the record being edited.',
717
723
  },
718
724
  location: {
719
725
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -723,7 +729,7 @@ export const manifest: Manifest = {
723
729
  },
724
730
  formValues: {
725
731
  comment: {
726
- comment: 'The complete internal form state',
732
+ markdownText: 'The complete internal form state.',
727
733
  },
728
734
  location: {
729
735
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -733,7 +739,8 @@ export const manifest: Manifest = {
733
739
  },
734
740
  itemStatus: {
735
741
  comment: {
736
- comment: 'The current status of the record being edited',
742
+ markdownText:
743
+ 'The current status of the record being edited.',
737
744
  },
738
745
  location: {
739
746
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -743,8 +750,8 @@ export const manifest: Manifest = {
743
750
  },
744
751
  isSubmitting: {
745
752
  comment: {
746
- comment:
747
- 'Whether the form is currently submitting itself or not',
753
+ markdownText:
754
+ 'Whether the form is currently submitting itself or not.',
748
755
  },
749
756
  location: {
750
757
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -754,8 +761,8 @@ export const manifest: Manifest = {
754
761
  },
755
762
  isFormDirty: {
756
763
  comment: {
757
- comment:
758
- 'Whether the form has some non-persisted changes or not',
764
+ markdownText:
765
+ 'Whether the form has some non-persisted changes or not.',
759
766
  },
760
767
  location: {
761
768
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -765,8 +772,8 @@ export const manifest: Manifest = {
765
772
  },
766
773
  blocksAnalysis: {
767
774
  comment: {
768
- comment:
769
- 'Provides information on how many blocks are currently present in the form',
775
+ markdownText:
776
+ 'Provides information on how many blocks are currently present in the form.',
770
777
  },
771
778
  location: {
772
779
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -780,7 +787,8 @@ export const manifest: Manifest = {
780
787
  items: {
781
788
  sidebarId: {
782
789
  comment: {
783
- comment: 'The ID of the sidebar that needs to be rendered',
790
+ markdownText:
791
+ 'The ID of the sidebar that needs to be rendered.',
784
792
  },
785
793
  location: {
786
794
  filePath: 'src/hooks/renderItemFormSidebar.ts',
@@ -790,8 +798,8 @@ export const manifest: Manifest = {
790
798
  },
791
799
  parameters: {
792
800
  comment: {
793
- comment:
794
- 'The arbitrary `parameters` of the declared in the `itemFormSidebars`\nfunction',
801
+ markdownText:
802
+ 'The arbitrary `parameters` of the declared in the `itemFormSidebars`\nfunction.',
795
803
  },
796
804
  location: {
797
805
  filePath: 'src/hooks/renderItemFormSidebar.ts',
@@ -806,13 +814,13 @@ export const manifest: Manifest = {
806
814
  {
807
815
  name: 'ItemFormAdditionalMethods',
808
816
  comment: {
809
- comment:
810
- "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
817
+ markdownText:
818
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
811
819
  },
812
820
  items: {
813
821
  toggleField: {
814
822
  comment: {
815
- comment:
823
+ markdownText:
816
824
  'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
817
825
  example:
818
826
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
@@ -825,7 +833,8 @@ export const manifest: Manifest = {
825
833
  },
826
834
  disableField: {
827
835
  comment: {
828
- comment: 'Disables/re-enables a specific field in the form',
836
+ markdownText:
837
+ 'Disables/re-enables a specific field in the form.',
829
838
  example:
830
839
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
831
840
  },
@@ -837,7 +846,7 @@ export const manifest: Manifest = {
837
846
  },
838
847
  scrollToField: {
839
848
  comment: {
840
- comment:
849
+ markdownText:
841
850
  '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\nfield.',
842
851
  example:
843
852
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
@@ -850,7 +859,8 @@ export const manifest: Manifest = {
850
859
  },
851
860
  setFieldValue: {
852
861
  comment: {
853
- comment: 'Changes a specific path of the `formValues` object',
862
+ markdownText:
863
+ 'Changes a specific path of the `formValues` object.',
854
864
  example:
855
865
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
856
866
  },
@@ -862,7 +872,7 @@ export const manifest: Manifest = {
862
872
  },
863
873
  formValuesToItem: {
864
874
  comment: {
865
- comment:
875
+ markdownText:
866
876
  'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
867
877
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
868
878
  },
@@ -874,8 +884,8 @@ export const manifest: Manifest = {
874
884
  },
875
885
  itemToFormValues: {
876
886
  comment: {
877
- comment:
878
- 'Takes an Item entity, and converts it into the internal form state',
887
+ markdownText:
888
+ 'Takes an Item entity, and converts it into the internal form state.',
879
889
  example: 'await ctx.itemToFormValues(ctx.item);',
880
890
  },
881
891
  location: {
@@ -886,7 +896,7 @@ export const manifest: Manifest = {
886
896
  },
887
897
  saveCurrentItem: {
888
898
  comment: {
889
- comment: 'Triggers a submit form for current record',
899
+ markdownText: 'Triggers a submit form for current record.',
890
900
  example: 'await ctx.saveCurrentItem();',
891
901
  },
892
902
  location: {
@@ -908,7 +918,7 @@ export const manifest: Manifest = {
908
918
  renderItemFormOutlet: {
909
919
  name: 'renderItemFormOutlet',
910
920
  comment: {
911
- comment:
921
+ markdownText:
912
922
  'This function will be called when the plugin needs to render an outlet\ndefined by the `itemFormOutlets()` hook.',
913
923
  tag: 'outlets',
914
924
  },
@@ -924,13 +934,13 @@ export const manifest: Manifest = {
924
934
  {
925
935
  name: 'ItemFormAdditionalProperties',
926
936
  comment: {
927
- comment:
928
- "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
937
+ markdownText:
938
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
929
939
  },
930
940
  items: {
931
941
  locale: {
932
942
  comment: {
933
- comment: 'The currently active locale for the record',
943
+ markdownText: 'The currently active locale for the record.',
934
944
  },
935
945
  location: {
936
946
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -940,8 +950,8 @@ export const manifest: Manifest = {
940
950
  },
941
951
  item: {
942
952
  comment: {
943
- comment:
944
- 'If an already persisted record is being edited, returns the full record\nentity',
953
+ markdownText:
954
+ 'If an already persisted record is being edited, returns the full record\nentity.',
945
955
  },
946
956
  location: {
947
957
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -951,7 +961,7 @@ export const manifest: Manifest = {
951
961
  },
952
962
  itemType: {
953
963
  comment: {
954
- comment: 'The model for the record being edited',
964
+ markdownText: 'The model for the record being edited.',
955
965
  },
956
966
  location: {
957
967
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -961,7 +971,7 @@ export const manifest: Manifest = {
961
971
  },
962
972
  formValues: {
963
973
  comment: {
964
- comment: 'The complete internal form state',
974
+ markdownText: 'The complete internal form state.',
965
975
  },
966
976
  location: {
967
977
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -971,7 +981,8 @@ export const manifest: Manifest = {
971
981
  },
972
982
  itemStatus: {
973
983
  comment: {
974
- comment: 'The current status of the record being edited',
984
+ markdownText:
985
+ 'The current status of the record being edited.',
975
986
  },
976
987
  location: {
977
988
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -981,8 +992,8 @@ export const manifest: Manifest = {
981
992
  },
982
993
  isSubmitting: {
983
994
  comment: {
984
- comment:
985
- 'Whether the form is currently submitting itself or not',
995
+ markdownText:
996
+ 'Whether the form is currently submitting itself or not.',
986
997
  },
987
998
  location: {
988
999
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -992,8 +1003,8 @@ export const manifest: Manifest = {
992
1003
  },
993
1004
  isFormDirty: {
994
1005
  comment: {
995
- comment:
996
- 'Whether the form has some non-persisted changes or not',
1006
+ markdownText:
1007
+ 'Whether the form has some non-persisted changes or not.',
997
1008
  },
998
1009
  location: {
999
1010
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1003,8 +1014,8 @@ export const manifest: Manifest = {
1003
1014
  },
1004
1015
  blocksAnalysis: {
1005
1016
  comment: {
1006
- comment:
1007
- 'Provides information on how many blocks are currently present in the form',
1017
+ markdownText:
1018
+ 'Provides information on how many blocks are currently present in the form.',
1008
1019
  },
1009
1020
  location: {
1010
1021
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1018,7 +1029,8 @@ export const manifest: Manifest = {
1018
1029
  items: {
1019
1030
  itemFormOutletId: {
1020
1031
  comment: {
1021
- comment: 'The ID of the outlet that needs to be rendered',
1032
+ markdownText:
1033
+ 'The ID of the outlet that needs to be rendered.',
1022
1034
  },
1023
1035
  location: {
1024
1036
  filePath: 'src/hooks/renderItemFormOutlet.ts',
@@ -1033,13 +1045,13 @@ export const manifest: Manifest = {
1033
1045
  {
1034
1046
  name: 'ItemFormAdditionalMethods',
1035
1047
  comment: {
1036
- comment:
1037
- "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
1048
+ markdownText:
1049
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
1038
1050
  },
1039
1051
  items: {
1040
1052
  toggleField: {
1041
1053
  comment: {
1042
- comment:
1054
+ markdownText:
1043
1055
  'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
1044
1056
  example:
1045
1057
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
@@ -1052,7 +1064,8 @@ export const manifest: Manifest = {
1052
1064
  },
1053
1065
  disableField: {
1054
1066
  comment: {
1055
- comment: 'Disables/re-enables a specific field in the form',
1067
+ markdownText:
1068
+ 'Disables/re-enables a specific field in the form.',
1056
1069
  example:
1057
1070
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
1058
1071
  },
@@ -1064,7 +1077,7 @@ export const manifest: Manifest = {
1064
1077
  },
1065
1078
  scrollToField: {
1066
1079
  comment: {
1067
- comment:
1080
+ markdownText:
1068
1081
  '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\nfield.',
1069
1082
  example:
1070
1083
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
@@ -1077,7 +1090,8 @@ export const manifest: Manifest = {
1077
1090
  },
1078
1091
  setFieldValue: {
1079
1092
  comment: {
1080
- comment: 'Changes a specific path of the `formValues` object',
1093
+ markdownText:
1094
+ 'Changes a specific path of the `formValues` object.',
1081
1095
  example:
1082
1096
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
1083
1097
  },
@@ -1089,7 +1103,7 @@ export const manifest: Manifest = {
1089
1103
  },
1090
1104
  formValuesToItem: {
1091
1105
  comment: {
1092
- comment:
1106
+ markdownText:
1093
1107
  'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
1094
1108
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
1095
1109
  },
@@ -1101,8 +1115,8 @@ export const manifest: Manifest = {
1101
1115
  },
1102
1116
  itemToFormValues: {
1103
1117
  comment: {
1104
- comment:
1105
- 'Takes an Item entity, and converts it into the internal form state',
1118
+ markdownText:
1119
+ 'Takes an Item entity, and converts it into the internal form state.',
1106
1120
  example: 'await ctx.itemToFormValues(ctx.item);',
1107
1121
  },
1108
1122
  location: {
@@ -1113,7 +1127,7 @@ export const manifest: Manifest = {
1113
1127
  },
1114
1128
  saveCurrentItem: {
1115
1129
  comment: {
1116
- comment: 'Triggers a submit form for current record',
1130
+ markdownText: 'Triggers a submit form for current record.',
1117
1131
  example: 'await ctx.saveCurrentItem();',
1118
1132
  },
1119
1133
  location: {
@@ -1135,7 +1149,7 @@ export const manifest: Manifest = {
1135
1149
  renderItemCollectionOutlet: {
1136
1150
  name: 'renderItemCollectionOutlet',
1137
1151
  comment: {
1138
- comment:
1152
+ markdownText:
1139
1153
  'This function will be called when the plugin needs to render an outlet\ndefined by the `itemFormOutlets()` hook.',
1140
1154
  tag: 'outlets',
1141
1155
  },
@@ -1152,7 +1166,8 @@ export const manifest: Manifest = {
1152
1166
  items: {
1153
1167
  itemCollectionOutletId: {
1154
1168
  comment: {
1155
- comment: 'The ID of the outlet that needs to be rendered',
1169
+ markdownText:
1170
+ 'The ID of the outlet that needs to be rendered.',
1156
1171
  },
1157
1172
  location: {
1158
1173
  filePath: 'src/hooks/renderItemCollectionOutlet.ts',
@@ -1174,8 +1189,8 @@ export const manifest: Manifest = {
1174
1189
  renderFieldExtension: {
1175
1190
  name: 'renderFieldExtension',
1176
1191
  comment: {
1177
- comment:
1178
- 'This function will be called when the plugin needs to render a field\nextension (see the `manualFieldExtensions` and `overrideFieldExtensions`\nfunctions)',
1192
+ markdownText:
1193
+ 'This function will be called when the plugin needs to render a field\nextension (see the `manualFieldExtensions` and `overrideFieldExtensions`\nfunctions).',
1179
1194
  tag: 'forcedFieldExtensions',
1180
1195
  },
1181
1196
  nonCtxArguments: [
@@ -1190,13 +1205,13 @@ export const manifest: Manifest = {
1190
1205
  {
1191
1206
  name: 'ItemFormAdditionalProperties',
1192
1207
  comment: {
1193
- comment:
1194
- "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1208
+ markdownText:
1209
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
1195
1210
  },
1196
1211
  items: {
1197
1212
  locale: {
1198
1213
  comment: {
1199
- comment: 'The currently active locale for the record',
1214
+ markdownText: 'The currently active locale for the record.',
1200
1215
  },
1201
1216
  location: {
1202
1217
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1206,8 +1221,8 @@ export const manifest: Manifest = {
1206
1221
  },
1207
1222
  item: {
1208
1223
  comment: {
1209
- comment:
1210
- 'If an already persisted record is being edited, returns the full record\nentity',
1224
+ markdownText:
1225
+ 'If an already persisted record is being edited, returns the full record\nentity.',
1211
1226
  },
1212
1227
  location: {
1213
1228
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1217,7 +1232,7 @@ export const manifest: Manifest = {
1217
1232
  },
1218
1233
  itemType: {
1219
1234
  comment: {
1220
- comment: 'The model for the record being edited',
1235
+ markdownText: 'The model for the record being edited.',
1221
1236
  },
1222
1237
  location: {
1223
1238
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1227,7 +1242,7 @@ export const manifest: Manifest = {
1227
1242
  },
1228
1243
  formValues: {
1229
1244
  comment: {
1230
- comment: 'The complete internal form state',
1245
+ markdownText: 'The complete internal form state.',
1231
1246
  },
1232
1247
  location: {
1233
1248
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1237,7 +1252,8 @@ export const manifest: Manifest = {
1237
1252
  },
1238
1253
  itemStatus: {
1239
1254
  comment: {
1240
- comment: 'The current status of the record being edited',
1255
+ markdownText:
1256
+ 'The current status of the record being edited.',
1241
1257
  },
1242
1258
  location: {
1243
1259
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1247,8 +1263,8 @@ export const manifest: Manifest = {
1247
1263
  },
1248
1264
  isSubmitting: {
1249
1265
  comment: {
1250
- comment:
1251
- 'Whether the form is currently submitting itself or not',
1266
+ markdownText:
1267
+ 'Whether the form is currently submitting itself or not.',
1252
1268
  },
1253
1269
  location: {
1254
1270
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1258,8 +1274,8 @@ export const manifest: Manifest = {
1258
1274
  },
1259
1275
  isFormDirty: {
1260
1276
  comment: {
1261
- comment:
1262
- 'Whether the form has some non-persisted changes or not',
1277
+ markdownText:
1278
+ 'Whether the form has some non-persisted changes or not.',
1263
1279
  },
1264
1280
  location: {
1265
1281
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1269,8 +1285,8 @@ export const manifest: Manifest = {
1269
1285
  },
1270
1286
  blocksAnalysis: {
1271
1287
  comment: {
1272
- comment:
1273
- 'Provides information on how many blocks are currently present in the form',
1288
+ markdownText:
1289
+ 'Provides information on how many blocks are currently present in the form.',
1274
1290
  },
1275
1291
  location: {
1276
1292
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1283,13 +1299,14 @@ export const manifest: Manifest = {
1283
1299
  {
1284
1300
  name: 'FieldAdditionalProperties',
1285
1301
  comment: {
1286
- comment:
1302
+ markdownText:
1287
1303
  'These information describe the current state of the field where this plugin\nis applied to.',
1288
1304
  },
1289
1305
  items: {
1290
1306
  disabled: {
1291
1307
  comment: {
1292
- comment: 'Whether the field is currently disabled or not',
1308
+ markdownText:
1309
+ 'Whether the field is currently disabled or not.',
1293
1310
  },
1294
1311
  location: {
1295
1312
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1299,8 +1316,8 @@ export const manifest: Manifest = {
1299
1316
  },
1300
1317
  fieldPath: {
1301
1318
  comment: {
1302
- comment:
1303
- 'The path in the `formValues` object where to find the current value for the\nfield',
1319
+ markdownText:
1320
+ 'The path in the `formValues` object where to find the current value for the\nfield.',
1304
1321
  },
1305
1322
  location: {
1306
1323
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1310,8 +1327,8 @@ export const manifest: Manifest = {
1310
1327
  },
1311
1328
  field: {
1312
1329
  comment: {
1313
- comment:
1314
- 'The field where the field extension is installed to',
1330
+ markdownText:
1331
+ 'The field where the field extension is installed to.',
1315
1332
  },
1316
1333
  location: {
1317
1334
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1321,8 +1338,8 @@ export const manifest: Manifest = {
1321
1338
  },
1322
1339
  parentField: {
1323
1340
  comment: {
1324
- comment:
1325
- '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',
1341
+ markdownText:
1342
+ '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.',
1326
1343
  },
1327
1344
  location: {
1328
1345
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1332,7 +1349,7 @@ export const manifest: Manifest = {
1332
1349
  },
1333
1350
  block: {
1334
1351
  comment: {
1335
- comment:
1352
+ markdownText:
1336
1353
  'If the field extension is installed in a field of a block, returns the ID\nof the block — or `undefined` if the block is still not persisted — and the\nblock model.',
1337
1354
  },
1338
1355
  location: {
@@ -1347,8 +1364,8 @@ export const manifest: Manifest = {
1347
1364
  items: {
1348
1365
  fieldExtensionId: {
1349
1366
  comment: {
1350
- comment:
1351
- 'The ID of the field extension that needs to be rendered',
1367
+ markdownText:
1368
+ 'The ID of the field extension that needs to be rendered.',
1352
1369
  },
1353
1370
  location: {
1354
1371
  filePath: 'src/hooks/renderFieldExtension.ts',
@@ -1358,7 +1375,8 @@ export const manifest: Manifest = {
1358
1375
  },
1359
1376
  parameters: {
1360
1377
  comment: {
1361
- comment: 'The arbitrary `parameters` of the field extension',
1378
+ markdownText:
1379
+ 'The arbitrary `parameters` of the field extension.',
1362
1380
  },
1363
1381
  location: {
1364
1382
  filePath: 'src/hooks/renderFieldExtension.ts',
@@ -1373,13 +1391,13 @@ export const manifest: Manifest = {
1373
1391
  {
1374
1392
  name: 'ItemFormAdditionalMethods',
1375
1393
  comment: {
1376
- comment:
1377
- "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
1394
+ markdownText:
1395
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
1378
1396
  },
1379
1397
  items: {
1380
1398
  toggleField: {
1381
1399
  comment: {
1382
- comment:
1400
+ markdownText:
1383
1401
  'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
1384
1402
  example:
1385
1403
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
@@ -1392,7 +1410,8 @@ export const manifest: Manifest = {
1392
1410
  },
1393
1411
  disableField: {
1394
1412
  comment: {
1395
- comment: 'Disables/re-enables a specific field in the form',
1413
+ markdownText:
1414
+ 'Disables/re-enables a specific field in the form.',
1396
1415
  example:
1397
1416
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
1398
1417
  },
@@ -1404,7 +1423,7 @@ export const manifest: Manifest = {
1404
1423
  },
1405
1424
  scrollToField: {
1406
1425
  comment: {
1407
- comment:
1426
+ markdownText:
1408
1427
  '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\nfield.',
1409
1428
  example:
1410
1429
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
@@ -1417,7 +1436,8 @@ export const manifest: Manifest = {
1417
1436
  },
1418
1437
  setFieldValue: {
1419
1438
  comment: {
1420
- comment: 'Changes a specific path of the `formValues` object',
1439
+ markdownText:
1440
+ 'Changes a specific path of the `formValues` object.',
1421
1441
  example:
1422
1442
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
1423
1443
  },
@@ -1429,7 +1449,7 @@ export const manifest: Manifest = {
1429
1449
  },
1430
1450
  formValuesToItem: {
1431
1451
  comment: {
1432
- comment:
1452
+ markdownText:
1433
1453
  'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
1434
1454
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
1435
1455
  },
@@ -1441,8 +1461,8 @@ export const manifest: Manifest = {
1441
1461
  },
1442
1462
  itemToFormValues: {
1443
1463
  comment: {
1444
- comment:
1445
- 'Takes an Item entity, and converts it into the internal form state',
1464
+ markdownText:
1465
+ 'Takes an Item entity, and converts it into the internal form state.',
1446
1466
  example: 'await ctx.itemToFormValues(ctx.item);',
1447
1467
  },
1448
1468
  location: {
@@ -1453,7 +1473,7 @@ export const manifest: Manifest = {
1453
1473
  },
1454
1474
  saveCurrentItem: {
1455
1475
  comment: {
1456
- comment: 'Triggers a submit form for current record',
1476
+ markdownText: 'Triggers a submit form for current record.',
1457
1477
  example: 'await ctx.saveCurrentItem();',
1458
1478
  },
1459
1479
  location: {
@@ -1475,8 +1495,8 @@ export const manifest: Manifest = {
1475
1495
  renderConfigScreen: {
1476
1496
  name: 'renderConfigScreen',
1477
1497
  comment: {
1478
- comment:
1479
- "This function will be called when the plugin needs to render the plugin's\nconfiguration form",
1498
+ markdownText:
1499
+ "This function will be called when the plugin needs to render the plugin's\nconfiguration form.",
1480
1500
  tag: 'configScreen',
1481
1501
  },
1482
1502
  nonCtxArguments: [],
@@ -1494,7 +1514,7 @@ export const manifest: Manifest = {
1494
1514
  renderAssetSource: {
1495
1515
  name: 'renderAssetSource',
1496
1516
  comment: {
1497
- comment:
1517
+ markdownText:
1498
1518
  "This function will be called when the user selects one of the plugin's\nasset sources to upload a new media file.",
1499
1519
  tag: 'assetSources',
1500
1520
  },
@@ -1511,8 +1531,8 @@ export const manifest: Manifest = {
1511
1531
  items: {
1512
1532
  assetSourceId: {
1513
1533
  comment: {
1514
- comment:
1515
- 'The ID of the assetSource that needs to be rendered',
1534
+ markdownText:
1535
+ 'The ID of the assetSource that needs to be rendered.',
1516
1536
  },
1517
1537
  location: {
1518
1538
  filePath: 'src/hooks/renderAssetSource.ts',
@@ -1528,7 +1548,7 @@ export const manifest: Manifest = {
1528
1548
  items: {
1529
1549
  select: {
1530
1550
  comment: {
1531
- comment:
1551
+ markdownText:
1532
1552
  'Function to be called when the user selects the asset: it will trigger the\ncreation of a new `Upload` that will be added in the Media Area.',
1533
1553
  example:
1534
1554
  "await ctx.select({\n resource: {\n url: 'https://images.unsplash.com/photo-1416339306562-f3d12fefd36f',\n filename: 'man-drinking-coffee.jpg',\n },\n copyright: 'Royalty free (Unsplash)',\n author: 'Jeff Sheldon',\n notes: 'A man drinking a coffee',\n tags: ['man', 'coffee'],\n});",
@@ -1552,8 +1572,8 @@ export const manifest: Manifest = {
1552
1572
  overrideFieldExtensions: {
1553
1573
  name: 'overrideFieldExtensions',
1554
1574
  comment: {
1555
- comment:
1556
- 'Use this function to automatically force one or more field extensions to a\nparticular field',
1575
+ markdownText:
1576
+ 'Use this function to automatically force one or more field extensions to a\nparticular field.',
1557
1577
  tag: 'forcedFieldExtensions',
1558
1578
  },
1559
1579
  nonCtxArguments: [
@@ -1588,7 +1608,7 @@ export const manifest: Manifest = {
1588
1608
  onBoot: {
1589
1609
  name: 'onBoot',
1590
1610
  comment: {
1591
- comment:
1611
+ markdownText:
1592
1612
  'This function will be called once at boot time and can be used to perform\nie. some initial integrity checks on the configuration.',
1593
1613
  tag: 'boot',
1594
1614
  },
@@ -1607,8 +1627,8 @@ export const manifest: Manifest = {
1607
1627
  onBeforeItemsUnpublish: {
1608
1628
  name: 'onBeforeItemsUnpublish',
1609
1629
  comment: {
1610
- comment:
1611
- 'This function will be called before unpublishing records. You can stop the\naction by returning `false`',
1630
+ markdownText:
1631
+ 'This function will be called before unpublishing records. You can stop the\naction by returning `false`.',
1612
1632
  tag: 'beforeHooks',
1613
1633
  },
1614
1634
  nonCtxArguments: [
@@ -1631,8 +1651,8 @@ export const manifest: Manifest = {
1631
1651
  onBeforeItemsPublish: {
1632
1652
  name: 'onBeforeItemsPublish',
1633
1653
  comment: {
1634
- comment:
1635
- 'This function will be called before publishing records. You can stop the\naction by returning `false`',
1654
+ markdownText:
1655
+ 'This function will be called before publishing records. You can stop the\naction by returning `false`.',
1636
1656
  tag: 'beforeHooks',
1637
1657
  },
1638
1658
  nonCtxArguments: [
@@ -1655,8 +1675,8 @@ export const manifest: Manifest = {
1655
1675
  onBeforeItemsDestroy: {
1656
1676
  name: 'onBeforeItemsDestroy',
1657
1677
  comment: {
1658
- comment:
1659
- 'This function will be called before destroying records. You can stop the\naction by returning `false`',
1678
+ markdownText:
1679
+ 'This function will be called before destroying records. You can stop the\naction by returning `false`.',
1660
1680
  tag: 'beforeHooks',
1661
1681
  },
1662
1682
  nonCtxArguments: [
@@ -1679,8 +1699,8 @@ export const manifest: Manifest = {
1679
1699
  onBeforeItemUpsert: {
1680
1700
  name: 'onBeforeItemUpsert',
1681
1701
  comment: {
1682
- comment:
1683
- 'This function will be called before saving a new version of a record. You\ncan stop the action by returning `false`',
1702
+ markdownText:
1703
+ 'This function will be called before saving a new version of a record. You\ncan stop the action by returning `false`.',
1684
1704
  tag: 'beforeHooks',
1685
1705
  },
1686
1706
  nonCtxArguments: [
@@ -1703,8 +1723,8 @@ export const manifest: Manifest = {
1703
1723
  manualFieldExtensions: {
1704
1724
  name: 'manualFieldExtensions',
1705
1725
  comment: {
1706
- comment:
1707
- 'Use this function to declare new field extensions that users will be able\nto install manually in some field',
1726
+ markdownText:
1727
+ 'Use this function to declare new field extensions that users will be able\nto install manually in some field.',
1708
1728
  tag: 'manualFieldExtensions',
1709
1729
  },
1710
1730
  nonCtxArguments: [],
@@ -1722,8 +1742,8 @@ export const manifest: Manifest = {
1722
1742
  mainNavigationTabs: {
1723
1743
  name: 'mainNavigationTabs',
1724
1744
  comment: {
1725
- comment:
1726
- 'Use this function to declare new tabs you want to add in the top-bar of the\nUI',
1745
+ markdownText:
1746
+ 'Use this function to declare new tabs you want to add in the top-bar of the\nUI.',
1727
1747
  tag: 'pages',
1728
1748
  },
1729
1749
  nonCtxArguments: [],
@@ -1741,7 +1761,7 @@ export const manifest: Manifest = {
1741
1761
  itemsDropdownActions: {
1742
1762
  name: 'itemsDropdownActions',
1743
1763
  comment: {
1744
- comment:
1764
+ markdownText:
1745
1765
  'This function lets you set up custom actions (or groups of actions) that\nshow up when the user:\n\n* selects multiple records in the collection view for batch operations, or\n* starts editing a specific record.\n\nThe `executeItemsDropdownAction()` hook will be triggered once the user\nclicks on one of the defined actions.',
1746
1766
  tag: 'dropdownActions',
1747
1767
  },
@@ -1777,8 +1797,8 @@ export const manifest: Manifest = {
1777
1797
  itemFormSidebars: {
1778
1798
  name: 'itemFormSidebars',
1779
1799
  comment: {
1780
- comment:
1781
- 'Use this function to declare new sidebar to be shown when the user edits\nrecords of a particular model',
1800
+ markdownText:
1801
+ 'Use this function to declare new sidebar to be shown when the user edits\nrecords of a particular model.',
1782
1802
  tag: 'sidebarPanels',
1783
1803
  },
1784
1804
  nonCtxArguments: [
@@ -1801,8 +1821,8 @@ export const manifest: Manifest = {
1801
1821
  itemFormSidebarPanels: {
1802
1822
  name: 'itemFormSidebarPanels',
1803
1823
  comment: {
1804
- comment:
1805
- 'Use this function to declare new sidebar panels to be shown when the user\nedits records of a particular model',
1824
+ markdownText:
1825
+ 'Use this function to declare new sidebar panels to be shown when the user\nedits records of a particular model.',
1806
1826
  tag: 'sidebarPanels',
1807
1827
  },
1808
1828
  nonCtxArguments: [
@@ -1825,8 +1845,8 @@ export const manifest: Manifest = {
1825
1845
  itemFormOutlets: {
1826
1846
  name: 'itemFormOutlets',
1827
1847
  comment: {
1828
- comment:
1829
- "Use this function to declare custom outlets to be shown at the top of the\nrecord's editing page",
1848
+ markdownText:
1849
+ "Use this function to declare custom outlets to be shown at the top of the\nrecord's editing page.",
1830
1850
  tag: 'outlets',
1831
1851
  },
1832
1852
  nonCtxArguments: [
@@ -1849,7 +1869,7 @@ export const manifest: Manifest = {
1849
1869
  itemFormDropdownActions: {
1850
1870
  name: 'itemFormDropdownActions',
1851
1871
  comment: {
1852
- comment:
1872
+ markdownText:
1853
1873
  'Use this function to define custom actions (or groups of actions) to be\ndisplayed at when editing a particular record.\n\nThe `executeItemFormDropdownAction()` hook will be triggered once the user\nclicks on one of the defined actions.',
1854
1874
  tag: 'dropdownActions',
1855
1875
  },
@@ -1865,13 +1885,13 @@ export const manifest: Manifest = {
1865
1885
  {
1866
1886
  name: 'ItemFormAdditionalProperties',
1867
1887
  comment: {
1868
- comment:
1869
- "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1888
+ markdownText:
1889
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
1870
1890
  },
1871
1891
  items: {
1872
1892
  locale: {
1873
1893
  comment: {
1874
- comment: 'The currently active locale for the record',
1894
+ markdownText: 'The currently active locale for the record.',
1875
1895
  },
1876
1896
  location: {
1877
1897
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1881,8 +1901,8 @@ export const manifest: Manifest = {
1881
1901
  },
1882
1902
  item: {
1883
1903
  comment: {
1884
- comment:
1885
- 'If an already persisted record is being edited, returns the full record\nentity',
1904
+ markdownText:
1905
+ 'If an already persisted record is being edited, returns the full record\nentity.',
1886
1906
  },
1887
1907
  location: {
1888
1908
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1892,7 +1912,7 @@ export const manifest: Manifest = {
1892
1912
  },
1893
1913
  itemType: {
1894
1914
  comment: {
1895
- comment: 'The model for the record being edited',
1915
+ markdownText: 'The model for the record being edited.',
1896
1916
  },
1897
1917
  location: {
1898
1918
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1902,7 +1922,7 @@ export const manifest: Manifest = {
1902
1922
  },
1903
1923
  formValues: {
1904
1924
  comment: {
1905
- comment: 'The complete internal form state',
1925
+ markdownText: 'The complete internal form state.',
1906
1926
  },
1907
1927
  location: {
1908
1928
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1912,7 +1932,8 @@ export const manifest: Manifest = {
1912
1932
  },
1913
1933
  itemStatus: {
1914
1934
  comment: {
1915
- comment: 'The current status of the record being edited',
1935
+ markdownText:
1936
+ 'The current status of the record being edited.',
1916
1937
  },
1917
1938
  location: {
1918
1939
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1922,8 +1943,8 @@ export const manifest: Manifest = {
1922
1943
  },
1923
1944
  isSubmitting: {
1924
1945
  comment: {
1925
- comment:
1926
- 'Whether the form is currently submitting itself or not',
1946
+ markdownText:
1947
+ 'Whether the form is currently submitting itself or not.',
1927
1948
  },
1928
1949
  location: {
1929
1950
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1933,8 +1954,8 @@ export const manifest: Manifest = {
1933
1954
  },
1934
1955
  isFormDirty: {
1935
1956
  comment: {
1936
- comment:
1937
- 'Whether the form has some non-persisted changes or not',
1957
+ markdownText:
1958
+ 'Whether the form has some non-persisted changes or not.',
1938
1959
  },
1939
1960
  location: {
1940
1961
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1944,8 +1965,8 @@ export const manifest: Manifest = {
1944
1965
  },
1945
1966
  blocksAnalysis: {
1946
1967
  comment: {
1947
- comment:
1948
- 'Provides information on how many blocks are currently present in the form',
1968
+ markdownText:
1969
+ 'Provides information on how many blocks are currently present in the form.',
1949
1970
  },
1950
1971
  location: {
1951
1972
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1967,8 +1988,8 @@ export const manifest: Manifest = {
1967
1988
  itemCollectionOutlets: {
1968
1989
  name: 'itemCollectionOutlets',
1969
1990
  comment: {
1970
- comment:
1971
- 'Use this function to declare custom outlets to be shown at the top of a\ncollection of records of a particular model',
1991
+ markdownText:
1992
+ 'Use this function to declare custom outlets to be shown at the top of a\ncollection of records of a particular model.',
1972
1993
  tag: 'outlets',
1973
1994
  },
1974
1995
  nonCtxArguments: [
@@ -1991,8 +2012,8 @@ export const manifest: Manifest = {
1991
2012
  initialLocationQueryForItemSelector: {
1992
2013
  name: 'initialLocationQueryForItemSelector',
1993
2014
  comment: {
1994
- comment:
1995
- 'Use this function to customize the initial filters when opening a record\nselector via a "Single link" or "Multiple links" field',
2015
+ markdownText:
2016
+ 'Use this function to customize the initial filters when opening a record\nselector via a "Single link" or "Multiple links" field.',
1996
2017
  tag: 'locationQuery',
1997
2018
  },
1998
2019
  nonCtxArguments: [
@@ -2020,7 +2041,7 @@ export const manifest: Manifest = {
2020
2041
  fieldDropdownActions: {
2021
2042
  name: 'fieldDropdownActions',
2022
2043
  comment: {
2023
- comment:
2044
+ markdownText:
2024
2045
  'Use this function to define custom actions (or groups of actions) to be\ndisplayed at the individual field level in the record editing form.\n\nThe `executeFieldDropdownAction()` hook will be triggered once the user\nclicks on one of the defined actions.',
2025
2046
  tag: 'dropdownActions',
2026
2047
  },
@@ -2036,13 +2057,13 @@ export const manifest: Manifest = {
2036
2057
  {
2037
2058
  name: 'ItemFormAdditionalProperties',
2038
2059
  comment: {
2039
- comment:
2040
- "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2060
+ markdownText:
2061
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
2041
2062
  },
2042
2063
  items: {
2043
2064
  locale: {
2044
2065
  comment: {
2045
- comment: 'The currently active locale for the record',
2066
+ markdownText: 'The currently active locale for the record.',
2046
2067
  },
2047
2068
  location: {
2048
2069
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2052,8 +2073,8 @@ export const manifest: Manifest = {
2052
2073
  },
2053
2074
  item: {
2054
2075
  comment: {
2055
- comment:
2056
- 'If an already persisted record is being edited, returns the full record\nentity',
2076
+ markdownText:
2077
+ 'If an already persisted record is being edited, returns the full record\nentity.',
2057
2078
  },
2058
2079
  location: {
2059
2080
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2063,7 +2084,7 @@ export const manifest: Manifest = {
2063
2084
  },
2064
2085
  itemType: {
2065
2086
  comment: {
2066
- comment: 'The model for the record being edited',
2087
+ markdownText: 'The model for the record being edited.',
2067
2088
  },
2068
2089
  location: {
2069
2090
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2073,7 +2094,7 @@ export const manifest: Manifest = {
2073
2094
  },
2074
2095
  formValues: {
2075
2096
  comment: {
2076
- comment: 'The complete internal form state',
2097
+ markdownText: 'The complete internal form state.',
2077
2098
  },
2078
2099
  location: {
2079
2100
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2083,7 +2104,8 @@ export const manifest: Manifest = {
2083
2104
  },
2084
2105
  itemStatus: {
2085
2106
  comment: {
2086
- comment: 'The current status of the record being edited',
2107
+ markdownText:
2108
+ 'The current status of the record being edited.',
2087
2109
  },
2088
2110
  location: {
2089
2111
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2093,8 +2115,8 @@ export const manifest: Manifest = {
2093
2115
  },
2094
2116
  isSubmitting: {
2095
2117
  comment: {
2096
- comment:
2097
- 'Whether the form is currently submitting itself or not',
2118
+ markdownText:
2119
+ 'Whether the form is currently submitting itself or not.',
2098
2120
  },
2099
2121
  location: {
2100
2122
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2104,8 +2126,8 @@ export const manifest: Manifest = {
2104
2126
  },
2105
2127
  isFormDirty: {
2106
2128
  comment: {
2107
- comment:
2108
- 'Whether the form has some non-persisted changes or not',
2129
+ markdownText:
2130
+ 'Whether the form has some non-persisted changes or not.',
2109
2131
  },
2110
2132
  location: {
2111
2133
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2115,8 +2137,8 @@ export const manifest: Manifest = {
2115
2137
  },
2116
2138
  blocksAnalysis: {
2117
2139
  comment: {
2118
- comment:
2119
- 'Provides information on how many blocks are currently present in the form',
2140
+ markdownText:
2141
+ 'Provides information on how many blocks are currently present in the form.',
2120
2142
  },
2121
2143
  location: {
2122
2144
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2129,13 +2151,14 @@ export const manifest: Manifest = {
2129
2151
  {
2130
2152
  name: 'FieldAdditionalProperties',
2131
2153
  comment: {
2132
- comment:
2154
+ markdownText:
2133
2155
  'These information describe the current state of the field where this plugin\nis applied to.',
2134
2156
  },
2135
2157
  items: {
2136
2158
  disabled: {
2137
2159
  comment: {
2138
- comment: 'Whether the field is currently disabled or not',
2160
+ markdownText:
2161
+ 'Whether the field is currently disabled or not.',
2139
2162
  },
2140
2163
  location: {
2141
2164
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2145,8 +2168,8 @@ export const manifest: Manifest = {
2145
2168
  },
2146
2169
  fieldPath: {
2147
2170
  comment: {
2148
- comment:
2149
- 'The path in the `formValues` object where to find the current value for the\nfield',
2171
+ markdownText:
2172
+ 'The path in the `formValues` object where to find the current value for the\nfield.',
2150
2173
  },
2151
2174
  location: {
2152
2175
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2156,8 +2179,8 @@ export const manifest: Manifest = {
2156
2179
  },
2157
2180
  field: {
2158
2181
  comment: {
2159
- comment:
2160
- 'The field where the field extension is installed to',
2182
+ markdownText:
2183
+ 'The field where the field extension is installed to.',
2161
2184
  },
2162
2185
  location: {
2163
2186
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2167,8 +2190,8 @@ export const manifest: Manifest = {
2167
2190
  },
2168
2191
  parentField: {
2169
2192
  comment: {
2170
- comment:
2171
- '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',
2193
+ markdownText:
2194
+ '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.',
2172
2195
  },
2173
2196
  location: {
2174
2197
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2178,7 +2201,7 @@ export const manifest: Manifest = {
2178
2201
  },
2179
2202
  block: {
2180
2203
  comment: {
2181
- comment:
2204
+ markdownText:
2182
2205
  'If the field extension is installed in a field of a block, returns the ID\nof the block — or `undefined` if the block is still not persisted — and the\nblock model.',
2183
2206
  },
2184
2207
  location: {
@@ -2201,7 +2224,7 @@ export const manifest: Manifest = {
2201
2224
  executeUploadsDropdownAction: {
2202
2225
  name: 'executeUploadsDropdownAction',
2203
2226
  comment: {
2204
- comment:
2227
+ markdownText:
2205
2228
  'Use this function to execute a particular dropdown action defined via\nthe `uploadsDropdownActions()` hook.',
2206
2229
  tag: 'dropdownActions',
2207
2230
  },
@@ -2241,7 +2264,7 @@ export const manifest: Manifest = {
2241
2264
  executeItemsDropdownAction: {
2242
2265
  name: 'executeItemsDropdownAction',
2243
2266
  comment: {
2244
- comment:
2267
+ markdownText:
2245
2268
  'Use this function to execute a particular dropdown action defined via\nthe `itemsDropdownActions()` hook.',
2246
2269
  tag: 'dropdownActions',
2247
2270
  },
@@ -2281,7 +2304,7 @@ export const manifest: Manifest = {
2281
2304
  executeItemFormDropdownAction: {
2282
2305
  name: 'executeItemFormDropdownAction',
2283
2306
  comment: {
2284
- comment:
2307
+ markdownText:
2285
2308
  'Use this function to execute a particular dropdown action defined via\nthe `itemFormDropdownActions()` hook.',
2286
2309
  tag: 'dropdownActions',
2287
2310
  },
@@ -2297,13 +2320,13 @@ export const manifest: Manifest = {
2297
2320
  {
2298
2321
  name: 'ItemFormAdditionalProperties',
2299
2322
  comment: {
2300
- comment:
2301
- "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2323
+ markdownText:
2324
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
2302
2325
  },
2303
2326
  items: {
2304
2327
  locale: {
2305
2328
  comment: {
2306
- comment: 'The currently active locale for the record',
2329
+ markdownText: 'The currently active locale for the record.',
2307
2330
  },
2308
2331
  location: {
2309
2332
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2313,8 +2336,8 @@ export const manifest: Manifest = {
2313
2336
  },
2314
2337
  item: {
2315
2338
  comment: {
2316
- comment:
2317
- 'If an already persisted record is being edited, returns the full record\nentity',
2339
+ markdownText:
2340
+ 'If an already persisted record is being edited, returns the full record\nentity.',
2318
2341
  },
2319
2342
  location: {
2320
2343
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2324,7 +2347,7 @@ export const manifest: Manifest = {
2324
2347
  },
2325
2348
  itemType: {
2326
2349
  comment: {
2327
- comment: 'The model for the record being edited',
2350
+ markdownText: 'The model for the record being edited.',
2328
2351
  },
2329
2352
  location: {
2330
2353
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2334,7 +2357,7 @@ export const manifest: Manifest = {
2334
2357
  },
2335
2358
  formValues: {
2336
2359
  comment: {
2337
- comment: 'The complete internal form state',
2360
+ markdownText: 'The complete internal form state.',
2338
2361
  },
2339
2362
  location: {
2340
2363
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2344,7 +2367,8 @@ export const manifest: Manifest = {
2344
2367
  },
2345
2368
  itemStatus: {
2346
2369
  comment: {
2347
- comment: 'The current status of the record being edited',
2370
+ markdownText:
2371
+ 'The current status of the record being edited.',
2348
2372
  },
2349
2373
  location: {
2350
2374
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2354,8 +2378,8 @@ export const manifest: Manifest = {
2354
2378
  },
2355
2379
  isSubmitting: {
2356
2380
  comment: {
2357
- comment:
2358
- 'Whether the form is currently submitting itself or not',
2381
+ markdownText:
2382
+ 'Whether the form is currently submitting itself or not.',
2359
2383
  },
2360
2384
  location: {
2361
2385
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2365,8 +2389,8 @@ export const manifest: Manifest = {
2365
2389
  },
2366
2390
  isFormDirty: {
2367
2391
  comment: {
2368
- comment:
2369
- 'Whether the form has some non-persisted changes or not',
2392
+ markdownText:
2393
+ 'Whether the form has some non-persisted changes or not.',
2370
2394
  },
2371
2395
  location: {
2372
2396
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2376,8 +2400,8 @@ export const manifest: Manifest = {
2376
2400
  },
2377
2401
  blocksAnalysis: {
2378
2402
  comment: {
2379
- comment:
2380
- 'Provides information on how many blocks are currently present in the form',
2403
+ markdownText:
2404
+ 'Provides information on how many blocks are currently present in the form.',
2381
2405
  },
2382
2406
  location: {
2383
2407
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2403,13 +2427,13 @@ export const manifest: Manifest = {
2403
2427
  {
2404
2428
  name: 'ItemFormAdditionalMethods',
2405
2429
  comment: {
2406
- comment:
2407
- "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2430
+ markdownText:
2431
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
2408
2432
  },
2409
2433
  items: {
2410
2434
  toggleField: {
2411
2435
  comment: {
2412
- comment:
2436
+ markdownText:
2413
2437
  'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
2414
2438
  example:
2415
2439
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
@@ -2422,7 +2446,8 @@ export const manifest: Manifest = {
2422
2446
  },
2423
2447
  disableField: {
2424
2448
  comment: {
2425
- comment: 'Disables/re-enables a specific field in the form',
2449
+ markdownText:
2450
+ 'Disables/re-enables a specific field in the form.',
2426
2451
  example:
2427
2452
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
2428
2453
  },
@@ -2434,7 +2459,7 @@ export const manifest: Manifest = {
2434
2459
  },
2435
2460
  scrollToField: {
2436
2461
  comment: {
2437
- comment:
2462
+ markdownText:
2438
2463
  '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\nfield.',
2439
2464
  example:
2440
2465
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
@@ -2447,7 +2472,8 @@ export const manifest: Manifest = {
2447
2472
  },
2448
2473
  setFieldValue: {
2449
2474
  comment: {
2450
- comment: 'Changes a specific path of the `formValues` object',
2475
+ markdownText:
2476
+ 'Changes a specific path of the `formValues` object.',
2451
2477
  example:
2452
2478
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
2453
2479
  },
@@ -2459,7 +2485,7 @@ export const manifest: Manifest = {
2459
2485
  },
2460
2486
  formValuesToItem: {
2461
2487
  comment: {
2462
- comment:
2488
+ markdownText:
2463
2489
  'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
2464
2490
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
2465
2491
  },
@@ -2471,8 +2497,8 @@ export const manifest: Manifest = {
2471
2497
  },
2472
2498
  itemToFormValues: {
2473
2499
  comment: {
2474
- comment:
2475
- 'Takes an Item entity, and converts it into the internal form state',
2500
+ markdownText:
2501
+ 'Takes an Item entity, and converts it into the internal form state.',
2476
2502
  example: 'await ctx.itemToFormValues(ctx.item);',
2477
2503
  },
2478
2504
  location: {
@@ -2483,7 +2509,7 @@ export const manifest: Manifest = {
2483
2509
  },
2484
2510
  saveCurrentItem: {
2485
2511
  comment: {
2486
- comment: 'Triggers a submit form for current record',
2512
+ markdownText: 'Triggers a submit form for current record.',
2487
2513
  example: 'await ctx.saveCurrentItem();',
2488
2514
  },
2489
2515
  location: {
@@ -2505,7 +2531,7 @@ export const manifest: Manifest = {
2505
2531
  executeFieldDropdownAction: {
2506
2532
  name: 'executeFieldDropdownAction',
2507
2533
  comment: {
2508
- comment:
2534
+ markdownText:
2509
2535
  'Use this function to execute a particular dropdown action defined via\nthe `fieldDropdownActions()` hook.',
2510
2536
  tag: 'dropdownActions',
2511
2537
  },
@@ -2521,13 +2547,13 @@ export const manifest: Manifest = {
2521
2547
  {
2522
2548
  name: 'ItemFormAdditionalProperties',
2523
2549
  comment: {
2524
- comment:
2525
- "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2550
+ markdownText:
2551
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
2526
2552
  },
2527
2553
  items: {
2528
2554
  locale: {
2529
2555
  comment: {
2530
- comment: 'The currently active locale for the record',
2556
+ markdownText: 'The currently active locale for the record.',
2531
2557
  },
2532
2558
  location: {
2533
2559
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2537,8 +2563,8 @@ export const manifest: Manifest = {
2537
2563
  },
2538
2564
  item: {
2539
2565
  comment: {
2540
- comment:
2541
- 'If an already persisted record is being edited, returns the full record\nentity',
2566
+ markdownText:
2567
+ 'If an already persisted record is being edited, returns the full record\nentity.',
2542
2568
  },
2543
2569
  location: {
2544
2570
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2548,7 +2574,7 @@ export const manifest: Manifest = {
2548
2574
  },
2549
2575
  itemType: {
2550
2576
  comment: {
2551
- comment: 'The model for the record being edited',
2577
+ markdownText: 'The model for the record being edited.',
2552
2578
  },
2553
2579
  location: {
2554
2580
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2558,7 +2584,7 @@ export const manifest: Manifest = {
2558
2584
  },
2559
2585
  formValues: {
2560
2586
  comment: {
2561
- comment: 'The complete internal form state',
2587
+ markdownText: 'The complete internal form state.',
2562
2588
  },
2563
2589
  location: {
2564
2590
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2568,7 +2594,8 @@ export const manifest: Manifest = {
2568
2594
  },
2569
2595
  itemStatus: {
2570
2596
  comment: {
2571
- comment: 'The current status of the record being edited',
2597
+ markdownText:
2598
+ 'The current status of the record being edited.',
2572
2599
  },
2573
2600
  location: {
2574
2601
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2578,8 +2605,8 @@ export const manifest: Manifest = {
2578
2605
  },
2579
2606
  isSubmitting: {
2580
2607
  comment: {
2581
- comment:
2582
- 'Whether the form is currently submitting itself or not',
2608
+ markdownText:
2609
+ 'Whether the form is currently submitting itself or not.',
2583
2610
  },
2584
2611
  location: {
2585
2612
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2589,8 +2616,8 @@ export const manifest: Manifest = {
2589
2616
  },
2590
2617
  isFormDirty: {
2591
2618
  comment: {
2592
- comment:
2593
- 'Whether the form has some non-persisted changes or not',
2619
+ markdownText:
2620
+ 'Whether the form has some non-persisted changes or not.',
2594
2621
  },
2595
2622
  location: {
2596
2623
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2600,8 +2627,8 @@ export const manifest: Manifest = {
2600
2627
  },
2601
2628
  blocksAnalysis: {
2602
2629
  comment: {
2603
- comment:
2604
- 'Provides information on how many blocks are currently present in the form',
2630
+ markdownText:
2631
+ 'Provides information on how many blocks are currently present in the form.',
2605
2632
  },
2606
2633
  location: {
2607
2634
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2614,13 +2641,14 @@ export const manifest: Manifest = {
2614
2641
  {
2615
2642
  name: 'FieldAdditionalProperties',
2616
2643
  comment: {
2617
- comment:
2644
+ markdownText:
2618
2645
  'These information describe the current state of the field where this plugin\nis applied to.',
2619
2646
  },
2620
2647
  items: {
2621
2648
  disabled: {
2622
2649
  comment: {
2623
- comment: 'Whether the field is currently disabled or not',
2650
+ markdownText:
2651
+ 'Whether the field is currently disabled or not.',
2624
2652
  },
2625
2653
  location: {
2626
2654
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2630,8 +2658,8 @@ export const manifest: Manifest = {
2630
2658
  },
2631
2659
  fieldPath: {
2632
2660
  comment: {
2633
- comment:
2634
- 'The path in the `formValues` object where to find the current value for the\nfield',
2661
+ markdownText:
2662
+ 'The path in the `formValues` object where to find the current value for the\nfield.',
2635
2663
  },
2636
2664
  location: {
2637
2665
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2641,8 +2669,8 @@ export const manifest: Manifest = {
2641
2669
  },
2642
2670
  field: {
2643
2671
  comment: {
2644
- comment:
2645
- 'The field where the field extension is installed to',
2672
+ markdownText:
2673
+ 'The field where the field extension is installed to.',
2646
2674
  },
2647
2675
  location: {
2648
2676
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2652,8 +2680,8 @@ export const manifest: Manifest = {
2652
2680
  },
2653
2681
  parentField: {
2654
2682
  comment: {
2655
- comment:
2656
- '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',
2683
+ markdownText:
2684
+ '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.',
2657
2685
  },
2658
2686
  location: {
2659
2687
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2663,7 +2691,7 @@ export const manifest: Manifest = {
2663
2691
  },
2664
2692
  block: {
2665
2693
  comment: {
2666
- comment:
2694
+ markdownText:
2667
2695
  'If the field extension is installed in a field of a block, returns the ID\nof the block — or `undefined` if the block is still not persisted — and the\nblock model.',
2668
2696
  },
2669
2697
  location: {
@@ -2690,13 +2718,13 @@ export const manifest: Manifest = {
2690
2718
  {
2691
2719
  name: 'ItemFormAdditionalMethods',
2692
2720
  comment: {
2693
- comment:
2694
- "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2721
+ markdownText:
2722
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
2695
2723
  },
2696
2724
  items: {
2697
2725
  toggleField: {
2698
2726
  comment: {
2699
- comment:
2727
+ markdownText:
2700
2728
  'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
2701
2729
  example:
2702
2730
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
@@ -2709,7 +2737,8 @@ export const manifest: Manifest = {
2709
2737
  },
2710
2738
  disableField: {
2711
2739
  comment: {
2712
- comment: 'Disables/re-enables a specific field in the form',
2740
+ markdownText:
2741
+ 'Disables/re-enables a specific field in the form.',
2713
2742
  example:
2714
2743
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
2715
2744
  },
@@ -2721,7 +2750,7 @@ export const manifest: Manifest = {
2721
2750
  },
2722
2751
  scrollToField: {
2723
2752
  comment: {
2724
- comment:
2753
+ markdownText:
2725
2754
  '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\nfield.',
2726
2755
  example:
2727
2756
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
@@ -2734,7 +2763,8 @@ export const manifest: Manifest = {
2734
2763
  },
2735
2764
  setFieldValue: {
2736
2765
  comment: {
2737
- comment: 'Changes a specific path of the `formValues` object',
2766
+ markdownText:
2767
+ 'Changes a specific path of the `formValues` object.',
2738
2768
  example:
2739
2769
  "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
2740
2770
  },
@@ -2746,7 +2776,7 @@ export const manifest: Manifest = {
2746
2776
  },
2747
2777
  formValuesToItem: {
2748
2778
  comment: {
2749
- comment:
2779
+ markdownText:
2750
2780
  'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
2751
2781
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
2752
2782
  },
@@ -2758,8 +2788,8 @@ export const manifest: Manifest = {
2758
2788
  },
2759
2789
  itemToFormValues: {
2760
2790
  comment: {
2761
- comment:
2762
- 'Takes an Item entity, and converts it into the internal form state',
2791
+ markdownText:
2792
+ 'Takes an Item entity, and converts it into the internal form state.',
2763
2793
  example: 'await ctx.itemToFormValues(ctx.item);',
2764
2794
  },
2765
2795
  location: {
@@ -2770,7 +2800,7 @@ export const manifest: Manifest = {
2770
2800
  },
2771
2801
  saveCurrentItem: {
2772
2802
  comment: {
2773
- comment: 'Triggers a submit form for current record',
2803
+ markdownText: 'Triggers a submit form for current record.',
2774
2804
  example: 'await ctx.saveCurrentItem();',
2775
2805
  },
2776
2806
  location: {
@@ -2792,8 +2822,8 @@ export const manifest: Manifest = {
2792
2822
  customMarksForStructuredTextField: {
2793
2823
  name: 'customMarksForStructuredTextField',
2794
2824
  comment: {
2795
- comment:
2796
- 'Use this function to define a number of custom marks for a specific\nStructured Text field',
2825
+ markdownText:
2826
+ 'Use this function to define a number of custom marks for a specific\nStructured Text field.',
2797
2827
  tag: 'structuredText',
2798
2828
  },
2799
2829
  nonCtxArguments: [
@@ -2828,8 +2858,8 @@ export const manifest: Manifest = {
2828
2858
  customBlockStylesForStructuredTextField: {
2829
2859
  name: 'customBlockStylesForStructuredTextField',
2830
2860
  comment: {
2831
- comment:
2832
- 'Use this function to define a number of custom block styles for a specific\nStructured Text field',
2861
+ markdownText:
2862
+ 'Use this function to define a number of custom block styles for a specific\nStructured Text field.',
2833
2863
  tag: 'structuredText',
2834
2864
  },
2835
2865
  nonCtxArguments: [
@@ -2865,8 +2895,8 @@ export const manifest: Manifest = {
2865
2895
  contentAreaSidebarItems: {
2866
2896
  name: 'contentAreaSidebarItems',
2867
2897
  comment: {
2868
- comment:
2869
- 'Use this function to declare new items in the content area sidebar',
2898
+ markdownText:
2899
+ 'Use this function to declare new items in the content area sidebar.',
2870
2900
  tag: 'sidebarItems',
2871
2901
  },
2872
2902
  nonCtxArguments: [],
@@ -2884,8 +2914,8 @@ export const manifest: Manifest = {
2884
2914
  buildItemPresentationInfo: {
2885
2915
  name: 'buildItemPresentationInfo',
2886
2916
  comment: {
2887
- comment:
2888
- 'Use this function to customize the presentation of a record in records\ncollections and "Single link" or "Multiple links" field',
2917
+ markdownText:
2918
+ 'Use this function to customize the presentation of a record in records\ncollections and "Single link" or "Multiple links" field.',
2889
2919
  tag: 'presentation',
2890
2920
  },
2891
2921
  nonCtxArguments: [
@@ -2908,8 +2938,8 @@ export const manifest: Manifest = {
2908
2938
  assetSources: {
2909
2939
  name: 'assetSources',
2910
2940
  comment: {
2911
- comment:
2912
- 'Use this function to declare additional sources to be shown when users want\nto upload new assets',
2941
+ markdownText:
2942
+ 'Use this function to declare additional sources to be shown when users want\nto upload new assets.',
2913
2943
  tag: 'assetSources',
2914
2944
  },
2915
2945
  nonCtxArguments: [],
@@ -2930,13 +2960,13 @@ export const manifest: Manifest = {
2930
2960
  {
2931
2961
  name: 'PluginProperties',
2932
2962
  comment: {
2933
- comment:
2963
+ markdownText:
2934
2964
  "Information about the current plugin. Useful to access the plugin's global\nconfiguration object.",
2935
2965
  },
2936
2966
  items: {
2937
2967
  plugin: {
2938
2968
  comment: {
2939
- comment: 'The current plugin',
2969
+ markdownText: 'The current plugin.',
2940
2970
  },
2941
2971
  location: {
2942
2972
  filePath: 'src/ctx/base.ts',
@@ -2949,12 +2979,12 @@ export const manifest: Manifest = {
2949
2979
  {
2950
2980
  name: 'AuthenticationProperties',
2951
2981
  comment: {
2952
- comment: 'Information about the current user using the CMS',
2982
+ markdownText: 'Information about the current user using the CMS.',
2953
2983
  },
2954
2984
  items: {
2955
2985
  currentUser: {
2956
2986
  comment: {
2957
- comment:
2987
+ markdownText:
2958
2988
  'The current DatoCMS user. It can either be the owner or one of the\ncollaborators (regular or SSO).',
2959
2989
  },
2960
2990
  location: {
@@ -2965,7 +2995,7 @@ export const manifest: Manifest = {
2965
2995
  },
2966
2996
  currentRole: {
2967
2997
  comment: {
2968
- comment: 'The role for the current DatoCMS user',
2998
+ markdownText: 'The role for the current DatoCMS user.',
2969
2999
  },
2970
3000
  location: {
2971
3001
  filePath: 'src/ctx/base.ts',
@@ -2975,8 +3005,8 @@ export const manifest: Manifest = {
2975
3005
  },
2976
3006
  currentUserAccessToken: {
2977
3007
  comment: {
2978
- comment:
2979
- 'The access token to perform API calls on behalf of the current user. Only\navailable if `currentUserAccessToken` additional permission is granted',
3008
+ markdownText:
3009
+ 'The access token to perform API calls on behalf of the current user. Only\navailable if `currentUserAccessToken` additional permission is granted.',
2980
3010
  },
2981
3011
  location: {
2982
3012
  filePath: 'src/ctx/base.ts',
@@ -2991,7 +3021,7 @@ export const manifest: Manifest = {
2991
3021
  items: {
2992
3022
  site: {
2993
3023
  comment: {
2994
- comment: 'The current DatoCMS project',
3024
+ markdownText: 'The current DatoCMS project.',
2995
3025
  },
2996
3026
  location: {
2997
3027
  filePath: 'src/ctx/base.ts',
@@ -3001,7 +3031,7 @@ export const manifest: Manifest = {
3001
3031
  },
3002
3032
  environment: {
3003
3033
  comment: {
3004
- comment: 'The ID of the current environment',
3034
+ markdownText: 'The ID of the current environment.',
3005
3035
  },
3006
3036
  location: {
3007
3037
  filePath: 'src/ctx/base.ts',
@@ -3011,7 +3041,8 @@ export const manifest: Manifest = {
3011
3041
  },
3012
3042
  owner: {
3013
3043
  comment: {
3014
- comment: 'The account that is the project owner',
3044
+ markdownText:
3045
+ 'The account/organization that is the project owner.',
3015
3046
  },
3016
3047
  location: {
3017
3048
  filePath: 'src/ctx/base.ts',
@@ -3021,7 +3052,9 @@ export const manifest: Manifest = {
3021
3052
  },
3022
3053
  account: {
3023
3054
  comment: {
3024
- comment: 'The account that is the project owner',
3055
+ markdownText: 'The account that is the project owner.',
3056
+ deprecatedMarkdownText:
3057
+ 'Please use `.owner` instead, as the project owner can also be\nan organization',
3025
3058
  },
3026
3059
  location: {
3027
3060
  filePath: 'src/ctx/base.ts',
@@ -3031,8 +3064,8 @@ export const manifest: Manifest = {
3031
3064
  },
3032
3065
  ui: {
3033
3066
  comment: {
3034
- comment:
3035
- 'UI preferences of the current user (right now, only the preferred locale is\navailable)',
3067
+ markdownText:
3068
+ 'UI preferences of the current user (right now, only the preferred locale is\navailable).',
3036
3069
  },
3037
3070
  location: {
3038
3071
  filePath: 'src/ctx/base.ts',
@@ -3042,8 +3075,8 @@ export const manifest: Manifest = {
3042
3075
  },
3043
3076
  theme: {
3044
3077
  comment: {
3045
- comment:
3046
- 'An object containing the theme colors for the current DatoCMS project',
3078
+ markdownText:
3079
+ 'An object containing the theme colors for the current DatoCMS project.',
3047
3080
  },
3048
3081
  location: {
3049
3082
  filePath: 'src/ctx/base.ts',
@@ -3056,14 +3089,14 @@ export const manifest: Manifest = {
3056
3089
  {
3057
3090
  name: 'EntityReposProperties',
3058
3091
  comment: {
3059
- comment:
3092
+ markdownText:
3060
3093
  'These properties provide access to "entity repos", that is, the collection of\nresources of a particular type that have been loaded by the CMS up to this\nmoment. The entity repos are objects, indexed by the ID of the entity itself.',
3061
3094
  },
3062
3095
  items: {
3063
3096
  itemTypes: {
3064
3097
  comment: {
3065
- comment:
3066
- 'All the models of the current DatoCMS project, indexed by ID',
3098
+ markdownText:
3099
+ 'All the models of the current DatoCMS project, indexed by ID.',
3067
3100
  },
3068
3101
  location: {
3069
3102
  filePath: 'src/ctx/base.ts',
@@ -3073,7 +3106,7 @@ export const manifest: Manifest = {
3073
3106
  },
3074
3107
  fields: {
3075
3108
  comment: {
3076
- comment:
3109
+ markdownText:
3077
3110
  'All the fields currently loaded for the current DatoCMS project, indexed by\nID. If some fields you need are not present, use the `loadItemTypeFields`\nfunction to load them.',
3078
3111
  },
3079
3112
  location: {
@@ -3084,7 +3117,7 @@ export const manifest: Manifest = {
3084
3117
  },
3085
3118
  fieldsets: {
3086
3119
  comment: {
3087
- comment:
3120
+ markdownText:
3088
3121
  'All the fieldsets currently loaded for the current DatoCMS project, indexed\nby ID. If some fields you need are not present, use the\n`loadItemTypeFieldsets` function to load them.',
3089
3122
  },
3090
3123
  location: {
@@ -3095,7 +3128,7 @@ export const manifest: Manifest = {
3095
3128
  },
3096
3129
  users: {
3097
3130
  comment: {
3098
- comment:
3131
+ markdownText:
3099
3132
  '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.',
3100
3133
  },
3101
3134
  location: {
@@ -3106,7 +3139,7 @@ export const manifest: Manifest = {
3106
3139
  },
3107
3140
  ssoUsers: {
3108
3141
  comment: {
3109
- comment:
3142
+ markdownText:
3110
3143
  '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.',
3111
3144
  },
3112
3145
  location: {
@@ -3122,13 +3155,13 @@ export const manifest: Manifest = {
3122
3155
  {
3123
3156
  name: 'LoadDataMethods',
3124
3157
  comment: {
3125
- comment:
3126
- 'These methods can be used to asyncronously load additional information your\nplugin needs to work',
3158
+ markdownText:
3159
+ 'These methods can be used to asyncronously load additional information your\nplugin needs to work.',
3127
3160
  },
3128
3161
  items: {
3129
3162
  loadItemTypeFields: {
3130
3163
  comment: {
3131
- comment:
3164
+ markdownText:
3132
3165
  'Loads all the fields for a specific model (or block). Fields will be\nreturned and will also be available in the the `fields` property.',
3133
3166
  example:
3134
3167
  "const 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);",
@@ -3141,7 +3174,7 @@ export const manifest: Manifest = {
3141
3174
  },
3142
3175
  loadItemTypeFieldsets: {
3143
3176
  comment: {
3144
- comment:
3177
+ markdownText:
3145
3178
  'Loads all the fieldsets for a specific model (or block). Fieldsets will be\nreturned and will also be available in the the `fieldsets` property.',
3146
3179
  example:
3147
3180
  "const itemTypeId = prompt('Please insert a model ID:');\n\nconst fieldsets = await ctx.loadItemTypeFieldsets(itemTypeId);\n\nctx.notice(\n `Success! ${fieldsets\n .map((fieldset) => fieldset.attributes.title)\n .join(', ')}`,\n);",
@@ -3154,7 +3187,7 @@ export const manifest: Manifest = {
3154
3187
  },
3155
3188
  loadFieldsUsingPlugin: {
3156
3189
  comment: {
3157
- comment:
3190
+ markdownText:
3158
3191
  'Loads all the fields in the project that are currently using the plugin for\none of its manual field extensions.',
3159
3192
  example:
3160
3193
  "const fields = await ctx.loadFieldsUsingPlugin();\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);",
@@ -3167,7 +3200,7 @@ export const manifest: Manifest = {
3167
3200
  },
3168
3201
  loadUsers: {
3169
3202
  comment: {
3170
- comment:
3203
+ markdownText:
3171
3204
  'Loads all regular users. Users will be returned and will also be available\nin the the `users` property.',
3172
3205
  example:
3173
3206
  "const users = await ctx.loadUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
@@ -3180,7 +3213,7 @@ export const manifest: Manifest = {
3180
3213
  },
3181
3214
  loadSsoUsers: {
3182
3215
  comment: {
3183
- comment:
3216
+ markdownText:
3184
3217
  'Loads all SSO users. Users will be returned and will also be available in\nthe the `ssoUsers` property.',
3185
3218
  example:
3186
3219
  "const users = await ctx.loadSsoUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
@@ -3196,13 +3229,13 @@ export const manifest: Manifest = {
3196
3229
  {
3197
3230
  name: 'UpdatePluginParametersMethods',
3198
3231
  comment: {
3199
- comment:
3232
+ markdownText:
3200
3233
  'These methods can be used to update both plugin parameters and manual field\nextensions configuration.',
3201
3234
  },
3202
3235
  items: {
3203
3236
  updatePluginParameters: {
3204
3237
  comment: {
3205
- comment:
3238
+ markdownText:
3206
3239
  'Updates the plugin parameters.\n\nAlways check `ctx.currentRole.meta.final_permissions.can_edit_schema`\nbefore calling this, as the user might not have the permission to perform\nthe operation.',
3207
3240
  example:
3208
3241
  "await ctx.updatePluginParameters({ debugMode: true });\nawait ctx.notice('Plugin parameters successfully updated!');",
@@ -3215,7 +3248,7 @@ export const manifest: Manifest = {
3215
3248
  },
3216
3249
  updateFieldAppearance: {
3217
3250
  comment: {
3218
- comment:
3251
+ markdownText:
3219
3252
  '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.\n\nAlways check `ctx.currentRole.meta.final_permissions.can_edit_schema`\nbefore calling this, as the user might not have the permission to perform\nthe operation.',
3220
3253
  example:
3221
3254
  "const 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}",
@@ -3231,14 +3264,14 @@ export const manifest: Manifest = {
3231
3264
  {
3232
3265
  name: 'ToastMethods',
3233
3266
  comment: {
3234
- comment:
3235
- 'These methods can be used to show UI-consistent toast notifications to the\nend-user',
3267
+ markdownText:
3268
+ 'These methods can be used to show UI-consistent toast notifications to the\nend-user.',
3236
3269
  },
3237
3270
  items: {
3238
3271
  alert: {
3239
3272
  comment: {
3240
- comment:
3241
- 'Triggers an "error" toast displaying the selected message',
3273
+ markdownText:
3274
+ 'Triggers an "error" toast displaying the selected message.',
3242
3275
  example:
3243
3276
  "const message = prompt(\n 'Please insert a message:',\n 'This is an alert message!',\n);\n\nawait ctx.alert(message);",
3244
3277
  },
@@ -3250,8 +3283,8 @@ export const manifest: Manifest = {
3250
3283
  },
3251
3284
  notice: {
3252
3285
  comment: {
3253
- comment:
3254
- 'Triggers a "success" toast displaying the selected message',
3286
+ markdownText:
3287
+ 'Triggers a "success" toast displaying the selected message.',
3255
3288
  example:
3256
3289
  "const message = prompt(\n 'Please insert a message:',\n 'This is a notice message!',\n);\n\nawait ctx.notice(message);",
3257
3290
  },
@@ -3263,8 +3296,8 @@ export const manifest: Manifest = {
3263
3296
  },
3264
3297
  customToast: {
3265
3298
  comment: {
3266
- comment:
3267
- 'Triggers a custom toast displaying the selected message (and optionally a\nCTA)',
3299
+ markdownText:
3300
+ 'Triggers a custom toast displaying the selected message (and optionally a\nCTA).',
3268
3301
  example:
3269
3302
  "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\nif (result === 'cta') {\n ctx.notice(`Clicked CTA!`);\n}",
3270
3303
  },
@@ -3279,13 +3312,13 @@ export const manifest: Manifest = {
3279
3312
  {
3280
3313
  name: 'ItemDialogMethods',
3281
3314
  comment: {
3282
- comment:
3283
- 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith records',
3315
+ markdownText:
3316
+ 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith records.',
3284
3317
  },
3285
3318
  items: {
3286
3319
  createNewItem: {
3287
3320
  comment: {
3288
- comment:
3321
+ markdownText:
3289
3322
  '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.',
3290
3323
  example:
3291
3324
  "const 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}",
@@ -3298,7 +3331,7 @@ export const manifest: Manifest = {
3298
3331
  },
3299
3332
  selectItem: {
3300
3333
  comment: {
3301
- comment:
3334
+ markdownText:
3302
3335
  '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.',
3303
3336
  example:
3304
3337
  "const 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}",
@@ -3311,7 +3344,7 @@ export const manifest: Manifest = {
3311
3344
  },
3312
3345
  editItem: {
3313
3346
  comment: {
3314
- comment:
3347
+ markdownText:
3315
3348
  '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.',
3316
3349
  example:
3317
3350
  "const 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}",
@@ -3327,13 +3360,13 @@ export const manifest: Manifest = {
3327
3360
  {
3328
3361
  name: 'UploadDialogMethods',
3329
3362
  comment: {
3330
- comment:
3331
- 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets',
3363
+ markdownText:
3364
+ 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets.',
3332
3365
  },
3333
3366
  items: {
3334
3367
  selectUpload: {
3335
3368
  comment: {
3336
- comment:
3369
+ markdownText:
3337
3370
  '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.',
3338
3371
  example:
3339
3372
  "const item = await ctx.selectUpload({ multiple: false });\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}",
@@ -3346,8 +3379,8 @@ export const manifest: Manifest = {
3346
3379
  },
3347
3380
  editUpload: {
3348
3381
  comment: {
3349
- comment:
3350
- 'Opens a dialog for editing a Media Area asset. It returns a promise\nresolved with:\n\n- 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',
3382
+ markdownText:
3383
+ 'Opens a dialog for editing a Media Area asset. It returns a promise\nresolved with:\n\n- 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.',
3351
3384
  example:
3352
3385
  "const 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}",
3353
3386
  },
@@ -3359,7 +3392,7 @@ export const manifest: Manifest = {
3359
3392
  },
3360
3393
  editUploadMetadata: {
3361
3394
  comment: {
3362
- comment:
3395
+ markdownText:
3363
3396
  '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.',
3364
3397
  example:
3365
3398
  "const 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}",
@@ -3375,14 +3408,14 @@ export const manifest: Manifest = {
3375
3408
  {
3376
3409
  name: 'CustomDialogMethods',
3377
3410
  comment: {
3378
- comment:
3379
- 'These methods can be used to open custom dialogs/confirmation panels',
3411
+ markdownText:
3412
+ 'These methods can be used to open custom dialogs/confirmation panels.',
3380
3413
  },
3381
3414
  items: {
3382
3415
  openModal: {
3383
3416
  comment: {
3384
- comment:
3385
- 'Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function',
3417
+ markdownText:
3418
+ 'Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function.',
3386
3419
  example:
3387
3420
  "const 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}",
3388
3421
  },
@@ -3394,8 +3427,8 @@ export const manifest: Manifest = {
3394
3427
  },
3395
3428
  openConfirm: {
3396
3429
  comment: {
3397
- comment:
3398
- 'Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user',
3430
+ markdownText:
3431
+ 'Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user.',
3399
3432
  example:
3400
3433
  "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\nif (result) {\n ctx.notice(`Success! ${result}`);\n} else {\n ctx.alert('Cancelled!');\n}",
3401
3434
  },
@@ -3410,13 +3443,14 @@ export const manifest: Manifest = {
3410
3443
  {
3411
3444
  name: 'NavigateMethods',
3412
3445
  comment: {
3413
- comment:
3414
- 'These methods can be used to take the user to different pages',
3446
+ markdownText:
3447
+ 'These methods can be used to take the user to different pages.',
3415
3448
  },
3416
3449
  items: {
3417
3450
  navigateTo: {
3418
3451
  comment: {
3419
- comment: 'Moves the user to another URL internal to the backend',
3452
+ markdownText:
3453
+ 'Moves the user to another URL internal to the backend.',
3420
3454
  example: "await ctx.navigateTo('/');",
3421
3455
  },
3422
3456
  location: {
@@ -3432,13 +3466,13 @@ export const manifest: Manifest = {
3432
3466
  selfResizingPluginFrameCtxSizingUtilities: {
3433
3467
  name: 'SizingUtilities',
3434
3468
  comment: {
3435
- comment:
3436
- 'A number of methods that you can use to control the size of the plugin frame',
3469
+ markdownText:
3470
+ 'A number of methods that you can use to control the size of the plugin frame.',
3437
3471
  },
3438
3472
  items: {
3439
3473
  startAutoResizer: {
3440
3474
  comment: {
3441
- comment:
3475
+ markdownText:
3442
3476
  "Listens for DOM changes and automatically calls `setHeight` when it detects\na change. If you're using `datocms-react-ui` package, the `<Canvas />`\ncomponent already takes care of calling this method for you.",
3443
3477
  },
3444
3478
  location: {
@@ -3449,7 +3483,7 @@ export const manifest: Manifest = {
3449
3483
  },
3450
3484
  stopAutoResizer: {
3451
3485
  comment: {
3452
- comment: 'Stops resizing the iframe automatically',
3486
+ markdownText: 'Stops resizing the iframe automatically.',
3453
3487
  },
3454
3488
  location: {
3455
3489
  filePath: 'src/ctx/commonExtras/sizing.ts',
@@ -3459,8 +3493,8 @@ export const manifest: Manifest = {
3459
3493
  },
3460
3494
  updateHeight: {
3461
3495
  comment: {
3462
- comment:
3463
- "Triggers a change in the size of the iframe. If you don't explicitely pass\na `newHeight` it will be automatically calculated using the iframe content\nat the moment",
3496
+ markdownText:
3497
+ "Triggers a change in the size of the iframe. If you don't explicitely pass\na `newHeight` it will be automatically calculated using the iframe content\nat the moment.",
3464
3498
  },
3465
3499
  location: {
3466
3500
  filePath: 'src/ctx/commonExtras/sizing.ts',