datocms-plugin-sdk 2.0.2 → 2.0.4

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 (36) hide show
  1. package/dist/cjs/hooks/renderItemCollectionOutlet.js.map +1 -1
  2. package/dist/cjs/manifest.js +266 -255
  3. package/dist/cjs/manifest.js.map +1 -1
  4. package/dist/esm/ctx/base.d.ts +1 -1
  5. package/dist/esm/hooks/renderItemCollectionOutlet.d.ts +6 -1
  6. package/dist/esm/hooks/renderItemCollectionOutlet.js.map +1 -1
  7. package/dist/esm/hooks/renderItemFormSidebar.d.ts +1 -1
  8. package/dist/esm/hooks/renderItemFormSidebarPanel.d.ts +1 -1
  9. package/dist/esm/hooks/renderManualFieldExtensionConfigScreen.d.ts +2 -2
  10. package/dist/esm/hooks/renderModal.d.ts +1 -1
  11. package/dist/esm/hooks/renderUploadSidebar.d.ts +1 -1
  12. package/dist/esm/hooks/renderUploadSidebarPanel.d.ts +1 -1
  13. package/dist/esm/manifest.js +266 -255
  14. package/dist/esm/manifest.js.map +1 -1
  15. package/dist/esm/manifestTypes.d.ts +39 -91
  16. package/dist/types/ctx/base.d.ts +1 -1
  17. package/dist/types/hooks/renderItemCollectionOutlet.d.ts +6 -1
  18. package/dist/types/hooks/renderItemFormSidebar.d.ts +1 -1
  19. package/dist/types/hooks/renderItemFormSidebarPanel.d.ts +1 -1
  20. package/dist/types/hooks/renderManualFieldExtensionConfigScreen.d.ts +2 -2
  21. package/dist/types/hooks/renderModal.d.ts +1 -1
  22. package/dist/types/hooks/renderUploadSidebar.d.ts +1 -1
  23. package/dist/types/hooks/renderUploadSidebarPanel.d.ts +1 -1
  24. package/dist/types/manifestTypes.d.ts +39 -91
  25. package/manifest.json +266 -255
  26. package/package.json +2 -2
  27. package/src/ctx/base.ts +1 -1
  28. package/src/hooks/renderItemCollectionOutlet.ts +6 -1
  29. package/src/hooks/renderItemFormSidebar.ts +1 -1
  30. package/src/hooks/renderItemFormSidebarPanel.ts +1 -1
  31. package/src/hooks/renderManualFieldExtensionConfigScreen.ts +2 -2
  32. package/src/hooks/renderModal.ts +1 -1
  33. package/src/hooks/renderUploadSidebar.ts +1 -1
  34. package/src/hooks/renderUploadSidebarPanel.ts +1 -1
  35. package/src/manifest.ts +422 -377
  36. 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,8 +1149,8 @@ export const manifest: Manifest = {
1135
1149
  renderItemCollectionOutlet: {
1136
1150
  name: 'renderItemCollectionOutlet',
1137
1151
  comment: {
1138
- comment:
1139
- 'This function will be called when the plugin needs to render an outlet\ndefined by the `itemFormOutlets()` hook.',
1152
+ markdownText:
1153
+ 'This function will be called when the plugin needs to render an outlet\ndefined by the `itemCollectionOutlets()` hook.',
1140
1154
  tag: 'outlets',
1141
1155
  },
1142
1156
  nonCtxArguments: [
@@ -1152,14 +1166,26 @@ 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',
1159
- lineNumber: 21,
1174
+ lineNumber: 24,
1160
1175
  },
1161
1176
  type: 'string',
1162
1177
  },
1178
+ itemType: {
1179
+ comment: {
1180
+ markdownText:
1181
+ 'The model for which the outlet is being rendered.',
1182
+ },
1183
+ location: {
1184
+ filePath: 'src/hooks/renderItemCollectionOutlet.ts',
1185
+ lineNumber: 26,
1186
+ },
1187
+ type: 'ItemType',
1188
+ },
1163
1189
  },
1164
1190
  },
1165
1191
  ],
@@ -1168,14 +1194,14 @@ export const manifest: Manifest = {
1168
1194
  returnType: 'void',
1169
1195
  location: {
1170
1196
  filePath: 'src/hooks/renderItemCollectionOutlet.ts',
1171
- lineNumber: 11,
1197
+ lineNumber: 14,
1172
1198
  },
1173
1199
  },
1174
1200
  renderFieldExtension: {
1175
1201
  name: 'renderFieldExtension',
1176
1202
  comment: {
1177
- comment:
1178
- 'This function will be called when the plugin needs to render a field\nextension (see the `manualFieldExtensions` and `overrideFieldExtensions`\nfunctions)',
1203
+ markdownText:
1204
+ 'This function will be called when the plugin needs to render a field\nextension (see the `manualFieldExtensions` and `overrideFieldExtensions`\nfunctions).',
1179
1205
  tag: 'forcedFieldExtensions',
1180
1206
  },
1181
1207
  nonCtxArguments: [
@@ -1190,13 +1216,13 @@ export const manifest: Manifest = {
1190
1216
  {
1191
1217
  name: 'ItemFormAdditionalProperties',
1192
1218
  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",
1219
+ markdownText:
1220
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
1195
1221
  },
1196
1222
  items: {
1197
1223
  locale: {
1198
1224
  comment: {
1199
- comment: 'The currently active locale for the record',
1225
+ markdownText: 'The currently active locale for the record.',
1200
1226
  },
1201
1227
  location: {
1202
1228
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1206,8 +1232,8 @@ export const manifest: Manifest = {
1206
1232
  },
1207
1233
  item: {
1208
1234
  comment: {
1209
- comment:
1210
- 'If an already persisted record is being edited, returns the full record\nentity',
1235
+ markdownText:
1236
+ 'If an already persisted record is being edited, returns the full record\nentity.',
1211
1237
  },
1212
1238
  location: {
1213
1239
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1217,7 +1243,7 @@ export const manifest: Manifest = {
1217
1243
  },
1218
1244
  itemType: {
1219
1245
  comment: {
1220
- comment: 'The model for the record being edited',
1246
+ markdownText: 'The model for the record being edited.',
1221
1247
  },
1222
1248
  location: {
1223
1249
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1227,7 +1253,7 @@ export const manifest: Manifest = {
1227
1253
  },
1228
1254
  formValues: {
1229
1255
  comment: {
1230
- comment: 'The complete internal form state',
1256
+ markdownText: 'The complete internal form state.',
1231
1257
  },
1232
1258
  location: {
1233
1259
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1237,7 +1263,8 @@ export const manifest: Manifest = {
1237
1263
  },
1238
1264
  itemStatus: {
1239
1265
  comment: {
1240
- comment: 'The current status of the record being edited',
1266
+ markdownText:
1267
+ 'The current status of the record being edited.',
1241
1268
  },
1242
1269
  location: {
1243
1270
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1247,8 +1274,8 @@ export const manifest: Manifest = {
1247
1274
  },
1248
1275
  isSubmitting: {
1249
1276
  comment: {
1250
- comment:
1251
- 'Whether the form is currently submitting itself or not',
1277
+ markdownText:
1278
+ 'Whether the form is currently submitting itself or not.',
1252
1279
  },
1253
1280
  location: {
1254
1281
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1258,8 +1285,8 @@ export const manifest: Manifest = {
1258
1285
  },
1259
1286
  isFormDirty: {
1260
1287
  comment: {
1261
- comment:
1262
- 'Whether the form has some non-persisted changes or not',
1288
+ markdownText:
1289
+ 'Whether the form has some non-persisted changes or not.',
1263
1290
  },
1264
1291
  location: {
1265
1292
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1269,8 +1296,8 @@ export const manifest: Manifest = {
1269
1296
  },
1270
1297
  blocksAnalysis: {
1271
1298
  comment: {
1272
- comment:
1273
- 'Provides information on how many blocks are currently present in the form',
1299
+ markdownText:
1300
+ 'Provides information on how many blocks are currently present in the form.',
1274
1301
  },
1275
1302
  location: {
1276
1303
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1283,13 +1310,14 @@ export const manifest: Manifest = {
1283
1310
  {
1284
1311
  name: 'FieldAdditionalProperties',
1285
1312
  comment: {
1286
- comment:
1313
+ markdownText:
1287
1314
  'These information describe the current state of the field where this plugin\nis applied to.',
1288
1315
  },
1289
1316
  items: {
1290
1317
  disabled: {
1291
1318
  comment: {
1292
- comment: 'Whether the field is currently disabled or not',
1319
+ markdownText:
1320
+ 'Whether the field is currently disabled or not.',
1293
1321
  },
1294
1322
  location: {
1295
1323
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1299,8 +1327,8 @@ export const manifest: Manifest = {
1299
1327
  },
1300
1328
  fieldPath: {
1301
1329
  comment: {
1302
- comment:
1303
- 'The path in the `formValues` object where to find the current value for the\nfield',
1330
+ markdownText:
1331
+ 'The path in the `formValues` object where to find the current value for the\nfield.',
1304
1332
  },
1305
1333
  location: {
1306
1334
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1310,8 +1338,8 @@ export const manifest: Manifest = {
1310
1338
  },
1311
1339
  field: {
1312
1340
  comment: {
1313
- comment:
1314
- 'The field where the field extension is installed to',
1341
+ markdownText:
1342
+ 'The field where the field extension is installed to.',
1315
1343
  },
1316
1344
  location: {
1317
1345
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1321,8 +1349,8 @@ export const manifest: Manifest = {
1321
1349
  },
1322
1350
  parentField: {
1323
1351
  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',
1352
+ markdownText:
1353
+ '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
1354
  },
1327
1355
  location: {
1328
1356
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1332,7 +1360,7 @@ export const manifest: Manifest = {
1332
1360
  },
1333
1361
  block: {
1334
1362
  comment: {
1335
- comment:
1363
+ markdownText:
1336
1364
  '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
1365
  },
1338
1366
  location: {
@@ -1347,8 +1375,8 @@ export const manifest: Manifest = {
1347
1375
  items: {
1348
1376
  fieldExtensionId: {
1349
1377
  comment: {
1350
- comment:
1351
- 'The ID of the field extension that needs to be rendered',
1378
+ markdownText:
1379
+ 'The ID of the field extension that needs to be rendered.',
1352
1380
  },
1353
1381
  location: {
1354
1382
  filePath: 'src/hooks/renderFieldExtension.ts',
@@ -1358,7 +1386,8 @@ export const manifest: Manifest = {
1358
1386
  },
1359
1387
  parameters: {
1360
1388
  comment: {
1361
- comment: 'The arbitrary `parameters` of the field extension',
1389
+ markdownText:
1390
+ 'The arbitrary `parameters` of the field extension.',
1362
1391
  },
1363
1392
  location: {
1364
1393
  filePath: 'src/hooks/renderFieldExtension.ts',
@@ -1373,13 +1402,13 @@ export const manifest: Manifest = {
1373
1402
  {
1374
1403
  name: 'ItemFormAdditionalMethods',
1375
1404
  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",
1405
+ markdownText:
1406
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
1378
1407
  },
1379
1408
  items: {
1380
1409
  toggleField: {
1381
1410
  comment: {
1382
- comment:
1411
+ markdownText:
1383
1412
  '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
1413
  example:
1385
1414
  "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 +1421,8 @@ export const manifest: Manifest = {
1392
1421
  },
1393
1422
  disableField: {
1394
1423
  comment: {
1395
- comment: 'Disables/re-enables a specific field in the form',
1424
+ markdownText:
1425
+ 'Disables/re-enables a specific field in the form.',
1396
1426
  example:
1397
1427
  "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
1428
  },
@@ -1404,7 +1434,7 @@ export const manifest: Manifest = {
1404
1434
  },
1405
1435
  scrollToField: {
1406
1436
  comment: {
1407
- comment:
1437
+ markdownText:
1408
1438
  '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
1439
  example:
1410
1440
  "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 +1447,8 @@ export const manifest: Manifest = {
1417
1447
  },
1418
1448
  setFieldValue: {
1419
1449
  comment: {
1420
- comment: 'Changes a specific path of the `formValues` object',
1450
+ markdownText:
1451
+ 'Changes a specific path of the `formValues` object.',
1421
1452
  example:
1422
1453
  "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
1454
  },
@@ -1429,7 +1460,7 @@ export const manifest: Manifest = {
1429
1460
  },
1430
1461
  formValuesToItem: {
1431
1462
  comment: {
1432
- comment:
1463
+ markdownText:
1433
1464
  '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
1465
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
1435
1466
  },
@@ -1441,8 +1472,8 @@ export const manifest: Manifest = {
1441
1472
  },
1442
1473
  itemToFormValues: {
1443
1474
  comment: {
1444
- comment:
1445
- 'Takes an Item entity, and converts it into the internal form state',
1475
+ markdownText:
1476
+ 'Takes an Item entity, and converts it into the internal form state.',
1446
1477
  example: 'await ctx.itemToFormValues(ctx.item);',
1447
1478
  },
1448
1479
  location: {
@@ -1453,7 +1484,7 @@ export const manifest: Manifest = {
1453
1484
  },
1454
1485
  saveCurrentItem: {
1455
1486
  comment: {
1456
- comment: 'Triggers a submit form for current record',
1487
+ markdownText: 'Triggers a submit form for current record.',
1457
1488
  example: 'await ctx.saveCurrentItem();',
1458
1489
  },
1459
1490
  location: {
@@ -1475,8 +1506,8 @@ export const manifest: Manifest = {
1475
1506
  renderConfigScreen: {
1476
1507
  name: 'renderConfigScreen',
1477
1508
  comment: {
1478
- comment:
1479
- "This function will be called when the plugin needs to render the plugin's\nconfiguration form",
1509
+ markdownText:
1510
+ "This function will be called when the plugin needs to render the plugin's\nconfiguration form.",
1480
1511
  tag: 'configScreen',
1481
1512
  },
1482
1513
  nonCtxArguments: [],
@@ -1494,7 +1525,7 @@ export const manifest: Manifest = {
1494
1525
  renderAssetSource: {
1495
1526
  name: 'renderAssetSource',
1496
1527
  comment: {
1497
- comment:
1528
+ markdownText:
1498
1529
  "This function will be called when the user selects one of the plugin's\nasset sources to upload a new media file.",
1499
1530
  tag: 'assetSources',
1500
1531
  },
@@ -1511,8 +1542,8 @@ export const manifest: Manifest = {
1511
1542
  items: {
1512
1543
  assetSourceId: {
1513
1544
  comment: {
1514
- comment:
1515
- 'The ID of the assetSource that needs to be rendered',
1545
+ markdownText:
1546
+ 'The ID of the assetSource that needs to be rendered.',
1516
1547
  },
1517
1548
  location: {
1518
1549
  filePath: 'src/hooks/renderAssetSource.ts',
@@ -1528,7 +1559,7 @@ export const manifest: Manifest = {
1528
1559
  items: {
1529
1560
  select: {
1530
1561
  comment: {
1531
- comment:
1562
+ markdownText:
1532
1563
  '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
1564
  example:
1534
1565
  "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 +1583,8 @@ export const manifest: Manifest = {
1552
1583
  overrideFieldExtensions: {
1553
1584
  name: 'overrideFieldExtensions',
1554
1585
  comment: {
1555
- comment:
1556
- 'Use this function to automatically force one or more field extensions to a\nparticular field',
1586
+ markdownText:
1587
+ 'Use this function to automatically force one or more field extensions to a\nparticular field.',
1557
1588
  tag: 'forcedFieldExtensions',
1558
1589
  },
1559
1590
  nonCtxArguments: [
@@ -1588,7 +1619,7 @@ export const manifest: Manifest = {
1588
1619
  onBoot: {
1589
1620
  name: 'onBoot',
1590
1621
  comment: {
1591
- comment:
1622
+ markdownText:
1592
1623
  'This function will be called once at boot time and can be used to perform\nie. some initial integrity checks on the configuration.',
1593
1624
  tag: 'boot',
1594
1625
  },
@@ -1607,8 +1638,8 @@ export const manifest: Manifest = {
1607
1638
  onBeforeItemsUnpublish: {
1608
1639
  name: 'onBeforeItemsUnpublish',
1609
1640
  comment: {
1610
- comment:
1611
- 'This function will be called before unpublishing records. You can stop the\naction by returning `false`',
1641
+ markdownText:
1642
+ 'This function will be called before unpublishing records. You can stop the\naction by returning `false`.',
1612
1643
  tag: 'beforeHooks',
1613
1644
  },
1614
1645
  nonCtxArguments: [
@@ -1631,8 +1662,8 @@ export const manifest: Manifest = {
1631
1662
  onBeforeItemsPublish: {
1632
1663
  name: 'onBeforeItemsPublish',
1633
1664
  comment: {
1634
- comment:
1635
- 'This function will be called before publishing records. You can stop the\naction by returning `false`',
1665
+ markdownText:
1666
+ 'This function will be called before publishing records. You can stop the\naction by returning `false`.',
1636
1667
  tag: 'beforeHooks',
1637
1668
  },
1638
1669
  nonCtxArguments: [
@@ -1655,8 +1686,8 @@ export const manifest: Manifest = {
1655
1686
  onBeforeItemsDestroy: {
1656
1687
  name: 'onBeforeItemsDestroy',
1657
1688
  comment: {
1658
- comment:
1659
- 'This function will be called before destroying records. You can stop the\naction by returning `false`',
1689
+ markdownText:
1690
+ 'This function will be called before destroying records. You can stop the\naction by returning `false`.',
1660
1691
  tag: 'beforeHooks',
1661
1692
  },
1662
1693
  nonCtxArguments: [
@@ -1679,8 +1710,8 @@ export const manifest: Manifest = {
1679
1710
  onBeforeItemUpsert: {
1680
1711
  name: 'onBeforeItemUpsert',
1681
1712
  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`',
1713
+ markdownText:
1714
+ 'This function will be called before saving a new version of a record. You\ncan stop the action by returning `false`.',
1684
1715
  tag: 'beforeHooks',
1685
1716
  },
1686
1717
  nonCtxArguments: [
@@ -1703,8 +1734,8 @@ export const manifest: Manifest = {
1703
1734
  manualFieldExtensions: {
1704
1735
  name: 'manualFieldExtensions',
1705
1736
  comment: {
1706
- comment:
1707
- 'Use this function to declare new field extensions that users will be able\nto install manually in some field',
1737
+ markdownText:
1738
+ 'Use this function to declare new field extensions that users will be able\nto install manually in some field.',
1708
1739
  tag: 'manualFieldExtensions',
1709
1740
  },
1710
1741
  nonCtxArguments: [],
@@ -1722,8 +1753,8 @@ export const manifest: Manifest = {
1722
1753
  mainNavigationTabs: {
1723
1754
  name: 'mainNavigationTabs',
1724
1755
  comment: {
1725
- comment:
1726
- 'Use this function to declare new tabs you want to add in the top-bar of the\nUI',
1756
+ markdownText:
1757
+ 'Use this function to declare new tabs you want to add in the top-bar of the\nUI.',
1727
1758
  tag: 'pages',
1728
1759
  },
1729
1760
  nonCtxArguments: [],
@@ -1741,7 +1772,7 @@ export const manifest: Manifest = {
1741
1772
  itemsDropdownActions: {
1742
1773
  name: 'itemsDropdownActions',
1743
1774
  comment: {
1744
- comment:
1775
+ markdownText:
1745
1776
  '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
1777
  tag: 'dropdownActions',
1747
1778
  },
@@ -1777,8 +1808,8 @@ export const manifest: Manifest = {
1777
1808
  itemFormSidebars: {
1778
1809
  name: 'itemFormSidebars',
1779
1810
  comment: {
1780
- comment:
1781
- 'Use this function to declare new sidebar to be shown when the user edits\nrecords of a particular model',
1811
+ markdownText:
1812
+ 'Use this function to declare new sidebar to be shown when the user edits\nrecords of a particular model.',
1782
1813
  tag: 'sidebarPanels',
1783
1814
  },
1784
1815
  nonCtxArguments: [
@@ -1801,8 +1832,8 @@ export const manifest: Manifest = {
1801
1832
  itemFormSidebarPanels: {
1802
1833
  name: 'itemFormSidebarPanels',
1803
1834
  comment: {
1804
- comment:
1805
- 'Use this function to declare new sidebar panels to be shown when the user\nedits records of a particular model',
1835
+ markdownText:
1836
+ 'Use this function to declare new sidebar panels to be shown when the user\nedits records of a particular model.',
1806
1837
  tag: 'sidebarPanels',
1807
1838
  },
1808
1839
  nonCtxArguments: [
@@ -1825,8 +1856,8 @@ export const manifest: Manifest = {
1825
1856
  itemFormOutlets: {
1826
1857
  name: 'itemFormOutlets',
1827
1858
  comment: {
1828
- comment:
1829
- "Use this function to declare custom outlets to be shown at the top of the\nrecord's editing page",
1859
+ markdownText:
1860
+ "Use this function to declare custom outlets to be shown at the top of the\nrecord's editing page.",
1830
1861
  tag: 'outlets',
1831
1862
  },
1832
1863
  nonCtxArguments: [
@@ -1849,7 +1880,7 @@ export const manifest: Manifest = {
1849
1880
  itemFormDropdownActions: {
1850
1881
  name: 'itemFormDropdownActions',
1851
1882
  comment: {
1852
- comment:
1883
+ markdownText:
1853
1884
  '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
1885
  tag: 'dropdownActions',
1855
1886
  },
@@ -1865,13 +1896,13 @@ export const manifest: Manifest = {
1865
1896
  {
1866
1897
  name: 'ItemFormAdditionalProperties',
1867
1898
  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",
1899
+ markdownText:
1900
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
1870
1901
  },
1871
1902
  items: {
1872
1903
  locale: {
1873
1904
  comment: {
1874
- comment: 'The currently active locale for the record',
1905
+ markdownText: 'The currently active locale for the record.',
1875
1906
  },
1876
1907
  location: {
1877
1908
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1881,8 +1912,8 @@ export const manifest: Manifest = {
1881
1912
  },
1882
1913
  item: {
1883
1914
  comment: {
1884
- comment:
1885
- 'If an already persisted record is being edited, returns the full record\nentity',
1915
+ markdownText:
1916
+ 'If an already persisted record is being edited, returns the full record\nentity.',
1886
1917
  },
1887
1918
  location: {
1888
1919
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1892,7 +1923,7 @@ export const manifest: Manifest = {
1892
1923
  },
1893
1924
  itemType: {
1894
1925
  comment: {
1895
- comment: 'The model for the record being edited',
1926
+ markdownText: 'The model for the record being edited.',
1896
1927
  },
1897
1928
  location: {
1898
1929
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1902,7 +1933,7 @@ export const manifest: Manifest = {
1902
1933
  },
1903
1934
  formValues: {
1904
1935
  comment: {
1905
- comment: 'The complete internal form state',
1936
+ markdownText: 'The complete internal form state.',
1906
1937
  },
1907
1938
  location: {
1908
1939
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1912,7 +1943,8 @@ export const manifest: Manifest = {
1912
1943
  },
1913
1944
  itemStatus: {
1914
1945
  comment: {
1915
- comment: 'The current status of the record being edited',
1946
+ markdownText:
1947
+ 'The current status of the record being edited.',
1916
1948
  },
1917
1949
  location: {
1918
1950
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1922,8 +1954,8 @@ export const manifest: Manifest = {
1922
1954
  },
1923
1955
  isSubmitting: {
1924
1956
  comment: {
1925
- comment:
1926
- 'Whether the form is currently submitting itself or not',
1957
+ markdownText:
1958
+ 'Whether the form is currently submitting itself or not.',
1927
1959
  },
1928
1960
  location: {
1929
1961
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1933,8 +1965,8 @@ export const manifest: Manifest = {
1933
1965
  },
1934
1966
  isFormDirty: {
1935
1967
  comment: {
1936
- comment:
1937
- 'Whether the form has some non-persisted changes or not',
1968
+ markdownText:
1969
+ 'Whether the form has some non-persisted changes or not.',
1938
1970
  },
1939
1971
  location: {
1940
1972
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1944,8 +1976,8 @@ export const manifest: Manifest = {
1944
1976
  },
1945
1977
  blocksAnalysis: {
1946
1978
  comment: {
1947
- comment:
1948
- 'Provides information on how many blocks are currently present in the form',
1979
+ markdownText:
1980
+ 'Provides information on how many blocks are currently present in the form.',
1949
1981
  },
1950
1982
  location: {
1951
1983
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1967,8 +1999,8 @@ export const manifest: Manifest = {
1967
1999
  itemCollectionOutlets: {
1968
2000
  name: 'itemCollectionOutlets',
1969
2001
  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',
2002
+ markdownText:
2003
+ 'Use this function to declare custom outlets to be shown at the top of a\ncollection of records of a particular model.',
1972
2004
  tag: 'outlets',
1973
2005
  },
1974
2006
  nonCtxArguments: [
@@ -1991,8 +2023,8 @@ export const manifest: Manifest = {
1991
2023
  initialLocationQueryForItemSelector: {
1992
2024
  name: 'initialLocationQueryForItemSelector',
1993
2025
  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',
2026
+ markdownText:
2027
+ 'Use this function to customize the initial filters when opening a record\nselector via a "Single link" or "Multiple links" field.',
1996
2028
  tag: 'locationQuery',
1997
2029
  },
1998
2030
  nonCtxArguments: [
@@ -2020,7 +2052,7 @@ export const manifest: Manifest = {
2020
2052
  fieldDropdownActions: {
2021
2053
  name: 'fieldDropdownActions',
2022
2054
  comment: {
2023
- comment:
2055
+ markdownText:
2024
2056
  '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
2057
  tag: 'dropdownActions',
2026
2058
  },
@@ -2036,13 +2068,13 @@ export const manifest: Manifest = {
2036
2068
  {
2037
2069
  name: 'ItemFormAdditionalProperties',
2038
2070
  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",
2071
+ markdownText:
2072
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
2041
2073
  },
2042
2074
  items: {
2043
2075
  locale: {
2044
2076
  comment: {
2045
- comment: 'The currently active locale for the record',
2077
+ markdownText: 'The currently active locale for the record.',
2046
2078
  },
2047
2079
  location: {
2048
2080
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2052,8 +2084,8 @@ export const manifest: Manifest = {
2052
2084
  },
2053
2085
  item: {
2054
2086
  comment: {
2055
- comment:
2056
- 'If an already persisted record is being edited, returns the full record\nentity',
2087
+ markdownText:
2088
+ 'If an already persisted record is being edited, returns the full record\nentity.',
2057
2089
  },
2058
2090
  location: {
2059
2091
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2063,7 +2095,7 @@ export const manifest: Manifest = {
2063
2095
  },
2064
2096
  itemType: {
2065
2097
  comment: {
2066
- comment: 'The model for the record being edited',
2098
+ markdownText: 'The model for the record being edited.',
2067
2099
  },
2068
2100
  location: {
2069
2101
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2073,7 +2105,7 @@ export const manifest: Manifest = {
2073
2105
  },
2074
2106
  formValues: {
2075
2107
  comment: {
2076
- comment: 'The complete internal form state',
2108
+ markdownText: 'The complete internal form state.',
2077
2109
  },
2078
2110
  location: {
2079
2111
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2083,7 +2115,8 @@ export const manifest: Manifest = {
2083
2115
  },
2084
2116
  itemStatus: {
2085
2117
  comment: {
2086
- comment: 'The current status of the record being edited',
2118
+ markdownText:
2119
+ 'The current status of the record being edited.',
2087
2120
  },
2088
2121
  location: {
2089
2122
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2093,8 +2126,8 @@ export const manifest: Manifest = {
2093
2126
  },
2094
2127
  isSubmitting: {
2095
2128
  comment: {
2096
- comment:
2097
- 'Whether the form is currently submitting itself or not',
2129
+ markdownText:
2130
+ 'Whether the form is currently submitting itself or not.',
2098
2131
  },
2099
2132
  location: {
2100
2133
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2104,8 +2137,8 @@ export const manifest: Manifest = {
2104
2137
  },
2105
2138
  isFormDirty: {
2106
2139
  comment: {
2107
- comment:
2108
- 'Whether the form has some non-persisted changes or not',
2140
+ markdownText:
2141
+ 'Whether the form has some non-persisted changes or not.',
2109
2142
  },
2110
2143
  location: {
2111
2144
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2115,8 +2148,8 @@ export const manifest: Manifest = {
2115
2148
  },
2116
2149
  blocksAnalysis: {
2117
2150
  comment: {
2118
- comment:
2119
- 'Provides information on how many blocks are currently present in the form',
2151
+ markdownText:
2152
+ 'Provides information on how many blocks are currently present in the form.',
2120
2153
  },
2121
2154
  location: {
2122
2155
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2129,13 +2162,14 @@ export const manifest: Manifest = {
2129
2162
  {
2130
2163
  name: 'FieldAdditionalProperties',
2131
2164
  comment: {
2132
- comment:
2165
+ markdownText:
2133
2166
  'These information describe the current state of the field where this plugin\nis applied to.',
2134
2167
  },
2135
2168
  items: {
2136
2169
  disabled: {
2137
2170
  comment: {
2138
- comment: 'Whether the field is currently disabled or not',
2171
+ markdownText:
2172
+ 'Whether the field is currently disabled or not.',
2139
2173
  },
2140
2174
  location: {
2141
2175
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2145,8 +2179,8 @@ export const manifest: Manifest = {
2145
2179
  },
2146
2180
  fieldPath: {
2147
2181
  comment: {
2148
- comment:
2149
- 'The path in the `formValues` object where to find the current value for the\nfield',
2182
+ markdownText:
2183
+ 'The path in the `formValues` object where to find the current value for the\nfield.',
2150
2184
  },
2151
2185
  location: {
2152
2186
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2156,8 +2190,8 @@ export const manifest: Manifest = {
2156
2190
  },
2157
2191
  field: {
2158
2192
  comment: {
2159
- comment:
2160
- 'The field where the field extension is installed to',
2193
+ markdownText:
2194
+ 'The field where the field extension is installed to.',
2161
2195
  },
2162
2196
  location: {
2163
2197
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2167,8 +2201,8 @@ export const manifest: Manifest = {
2167
2201
  },
2168
2202
  parentField: {
2169
2203
  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',
2204
+ markdownText:
2205
+ '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
2206
  },
2173
2207
  location: {
2174
2208
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2178,7 +2212,7 @@ export const manifest: Manifest = {
2178
2212
  },
2179
2213
  block: {
2180
2214
  comment: {
2181
- comment:
2215
+ markdownText:
2182
2216
  '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
2217
  },
2184
2218
  location: {
@@ -2201,7 +2235,7 @@ export const manifest: Manifest = {
2201
2235
  executeUploadsDropdownAction: {
2202
2236
  name: 'executeUploadsDropdownAction',
2203
2237
  comment: {
2204
- comment:
2238
+ markdownText:
2205
2239
  'Use this function to execute a particular dropdown action defined via\nthe `uploadsDropdownActions()` hook.',
2206
2240
  tag: 'dropdownActions',
2207
2241
  },
@@ -2241,7 +2275,7 @@ export const manifest: Manifest = {
2241
2275
  executeItemsDropdownAction: {
2242
2276
  name: 'executeItemsDropdownAction',
2243
2277
  comment: {
2244
- comment:
2278
+ markdownText:
2245
2279
  'Use this function to execute a particular dropdown action defined via\nthe `itemsDropdownActions()` hook.',
2246
2280
  tag: 'dropdownActions',
2247
2281
  },
@@ -2281,7 +2315,7 @@ export const manifest: Manifest = {
2281
2315
  executeItemFormDropdownAction: {
2282
2316
  name: 'executeItemFormDropdownAction',
2283
2317
  comment: {
2284
- comment:
2318
+ markdownText:
2285
2319
  'Use this function to execute a particular dropdown action defined via\nthe `itemFormDropdownActions()` hook.',
2286
2320
  tag: 'dropdownActions',
2287
2321
  },
@@ -2297,13 +2331,13 @@ export const manifest: Manifest = {
2297
2331
  {
2298
2332
  name: 'ItemFormAdditionalProperties',
2299
2333
  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",
2334
+ markdownText:
2335
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
2302
2336
  },
2303
2337
  items: {
2304
2338
  locale: {
2305
2339
  comment: {
2306
- comment: 'The currently active locale for the record',
2340
+ markdownText: 'The currently active locale for the record.',
2307
2341
  },
2308
2342
  location: {
2309
2343
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2313,8 +2347,8 @@ export const manifest: Manifest = {
2313
2347
  },
2314
2348
  item: {
2315
2349
  comment: {
2316
- comment:
2317
- 'If an already persisted record is being edited, returns the full record\nentity',
2350
+ markdownText:
2351
+ 'If an already persisted record is being edited, returns the full record\nentity.',
2318
2352
  },
2319
2353
  location: {
2320
2354
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2324,7 +2358,7 @@ export const manifest: Manifest = {
2324
2358
  },
2325
2359
  itemType: {
2326
2360
  comment: {
2327
- comment: 'The model for the record being edited',
2361
+ markdownText: 'The model for the record being edited.',
2328
2362
  },
2329
2363
  location: {
2330
2364
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2334,7 +2368,7 @@ export const manifest: Manifest = {
2334
2368
  },
2335
2369
  formValues: {
2336
2370
  comment: {
2337
- comment: 'The complete internal form state',
2371
+ markdownText: 'The complete internal form state.',
2338
2372
  },
2339
2373
  location: {
2340
2374
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2344,7 +2378,8 @@ export const manifest: Manifest = {
2344
2378
  },
2345
2379
  itemStatus: {
2346
2380
  comment: {
2347
- comment: 'The current status of the record being edited',
2381
+ markdownText:
2382
+ 'The current status of the record being edited.',
2348
2383
  },
2349
2384
  location: {
2350
2385
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2354,8 +2389,8 @@ export const manifest: Manifest = {
2354
2389
  },
2355
2390
  isSubmitting: {
2356
2391
  comment: {
2357
- comment:
2358
- 'Whether the form is currently submitting itself or not',
2392
+ markdownText:
2393
+ 'Whether the form is currently submitting itself or not.',
2359
2394
  },
2360
2395
  location: {
2361
2396
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2365,8 +2400,8 @@ export const manifest: Manifest = {
2365
2400
  },
2366
2401
  isFormDirty: {
2367
2402
  comment: {
2368
- comment:
2369
- 'Whether the form has some non-persisted changes or not',
2403
+ markdownText:
2404
+ 'Whether the form has some non-persisted changes or not.',
2370
2405
  },
2371
2406
  location: {
2372
2407
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2376,8 +2411,8 @@ export const manifest: Manifest = {
2376
2411
  },
2377
2412
  blocksAnalysis: {
2378
2413
  comment: {
2379
- comment:
2380
- 'Provides information on how many blocks are currently present in the form',
2414
+ markdownText:
2415
+ 'Provides information on how many blocks are currently present in the form.',
2381
2416
  },
2382
2417
  location: {
2383
2418
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2403,13 +2438,13 @@ export const manifest: Manifest = {
2403
2438
  {
2404
2439
  name: 'ItemFormAdditionalMethods',
2405
2440
  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",
2441
+ markdownText:
2442
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
2408
2443
  },
2409
2444
  items: {
2410
2445
  toggleField: {
2411
2446
  comment: {
2412
- comment:
2447
+ markdownText:
2413
2448
  '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
2449
  example:
2415
2450
  "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 +2457,8 @@ export const manifest: Manifest = {
2422
2457
  },
2423
2458
  disableField: {
2424
2459
  comment: {
2425
- comment: 'Disables/re-enables a specific field in the form',
2460
+ markdownText:
2461
+ 'Disables/re-enables a specific field in the form.',
2426
2462
  example:
2427
2463
  "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
2464
  },
@@ -2434,7 +2470,7 @@ export const manifest: Manifest = {
2434
2470
  },
2435
2471
  scrollToField: {
2436
2472
  comment: {
2437
- comment:
2473
+ markdownText:
2438
2474
  '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
2475
  example:
2440
2476
  "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 +2483,8 @@ export const manifest: Manifest = {
2447
2483
  },
2448
2484
  setFieldValue: {
2449
2485
  comment: {
2450
- comment: 'Changes a specific path of the `formValues` object',
2486
+ markdownText:
2487
+ 'Changes a specific path of the `formValues` object.',
2451
2488
  example:
2452
2489
  "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
2490
  },
@@ -2459,7 +2496,7 @@ export const manifest: Manifest = {
2459
2496
  },
2460
2497
  formValuesToItem: {
2461
2498
  comment: {
2462
- comment:
2499
+ markdownText:
2463
2500
  '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
2501
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
2465
2502
  },
@@ -2471,8 +2508,8 @@ export const manifest: Manifest = {
2471
2508
  },
2472
2509
  itemToFormValues: {
2473
2510
  comment: {
2474
- comment:
2475
- 'Takes an Item entity, and converts it into the internal form state',
2511
+ markdownText:
2512
+ 'Takes an Item entity, and converts it into the internal form state.',
2476
2513
  example: 'await ctx.itemToFormValues(ctx.item);',
2477
2514
  },
2478
2515
  location: {
@@ -2483,7 +2520,7 @@ export const manifest: Manifest = {
2483
2520
  },
2484
2521
  saveCurrentItem: {
2485
2522
  comment: {
2486
- comment: 'Triggers a submit form for current record',
2523
+ markdownText: 'Triggers a submit form for current record.',
2487
2524
  example: 'await ctx.saveCurrentItem();',
2488
2525
  },
2489
2526
  location: {
@@ -2505,7 +2542,7 @@ export const manifest: Manifest = {
2505
2542
  executeFieldDropdownAction: {
2506
2543
  name: 'executeFieldDropdownAction',
2507
2544
  comment: {
2508
- comment:
2545
+ markdownText:
2509
2546
  'Use this function to execute a particular dropdown action defined via\nthe `fieldDropdownActions()` hook.',
2510
2547
  tag: 'dropdownActions',
2511
2548
  },
@@ -2521,13 +2558,13 @@ export const manifest: Manifest = {
2521
2558
  {
2522
2559
  name: 'ItemFormAdditionalProperties',
2523
2560
  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",
2561
+ markdownText:
2562
+ "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
2526
2563
  },
2527
2564
  items: {
2528
2565
  locale: {
2529
2566
  comment: {
2530
- comment: 'The currently active locale for the record',
2567
+ markdownText: 'The currently active locale for the record.',
2531
2568
  },
2532
2569
  location: {
2533
2570
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2537,8 +2574,8 @@ export const manifest: Manifest = {
2537
2574
  },
2538
2575
  item: {
2539
2576
  comment: {
2540
- comment:
2541
- 'If an already persisted record is being edited, returns the full record\nentity',
2577
+ markdownText:
2578
+ 'If an already persisted record is being edited, returns the full record\nentity.',
2542
2579
  },
2543
2580
  location: {
2544
2581
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2548,7 +2585,7 @@ export const manifest: Manifest = {
2548
2585
  },
2549
2586
  itemType: {
2550
2587
  comment: {
2551
- comment: 'The model for the record being edited',
2588
+ markdownText: 'The model for the record being edited.',
2552
2589
  },
2553
2590
  location: {
2554
2591
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2558,7 +2595,7 @@ export const manifest: Manifest = {
2558
2595
  },
2559
2596
  formValues: {
2560
2597
  comment: {
2561
- comment: 'The complete internal form state',
2598
+ markdownText: 'The complete internal form state.',
2562
2599
  },
2563
2600
  location: {
2564
2601
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2568,7 +2605,8 @@ export const manifest: Manifest = {
2568
2605
  },
2569
2606
  itemStatus: {
2570
2607
  comment: {
2571
- comment: 'The current status of the record being edited',
2608
+ markdownText:
2609
+ 'The current status of the record being edited.',
2572
2610
  },
2573
2611
  location: {
2574
2612
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2578,8 +2616,8 @@ export const manifest: Manifest = {
2578
2616
  },
2579
2617
  isSubmitting: {
2580
2618
  comment: {
2581
- comment:
2582
- 'Whether the form is currently submitting itself or not',
2619
+ markdownText:
2620
+ 'Whether the form is currently submitting itself or not.',
2583
2621
  },
2584
2622
  location: {
2585
2623
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2589,8 +2627,8 @@ export const manifest: Manifest = {
2589
2627
  },
2590
2628
  isFormDirty: {
2591
2629
  comment: {
2592
- comment:
2593
- 'Whether the form has some non-persisted changes or not',
2630
+ markdownText:
2631
+ 'Whether the form has some non-persisted changes or not.',
2594
2632
  },
2595
2633
  location: {
2596
2634
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2600,8 +2638,8 @@ export const manifest: Manifest = {
2600
2638
  },
2601
2639
  blocksAnalysis: {
2602
2640
  comment: {
2603
- comment:
2604
- 'Provides information on how many blocks are currently present in the form',
2641
+ markdownText:
2642
+ 'Provides information on how many blocks are currently present in the form.',
2605
2643
  },
2606
2644
  location: {
2607
2645
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2614,13 +2652,14 @@ export const manifest: Manifest = {
2614
2652
  {
2615
2653
  name: 'FieldAdditionalProperties',
2616
2654
  comment: {
2617
- comment:
2655
+ markdownText:
2618
2656
  'These information describe the current state of the field where this plugin\nis applied to.',
2619
2657
  },
2620
2658
  items: {
2621
2659
  disabled: {
2622
2660
  comment: {
2623
- comment: 'Whether the field is currently disabled or not',
2661
+ markdownText:
2662
+ 'Whether the field is currently disabled or not.',
2624
2663
  },
2625
2664
  location: {
2626
2665
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2630,8 +2669,8 @@ export const manifest: Manifest = {
2630
2669
  },
2631
2670
  fieldPath: {
2632
2671
  comment: {
2633
- comment:
2634
- 'The path in the `formValues` object where to find the current value for the\nfield',
2672
+ markdownText:
2673
+ 'The path in the `formValues` object where to find the current value for the\nfield.',
2635
2674
  },
2636
2675
  location: {
2637
2676
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2641,8 +2680,8 @@ export const manifest: Manifest = {
2641
2680
  },
2642
2681
  field: {
2643
2682
  comment: {
2644
- comment:
2645
- 'The field where the field extension is installed to',
2683
+ markdownText:
2684
+ 'The field where the field extension is installed to.',
2646
2685
  },
2647
2686
  location: {
2648
2687
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2652,8 +2691,8 @@ export const manifest: Manifest = {
2652
2691
  },
2653
2692
  parentField: {
2654
2693
  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',
2694
+ markdownText:
2695
+ '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
2696
  },
2658
2697
  location: {
2659
2698
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2663,7 +2702,7 @@ export const manifest: Manifest = {
2663
2702
  },
2664
2703
  block: {
2665
2704
  comment: {
2666
- comment:
2705
+ markdownText:
2667
2706
  '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
2707
  },
2669
2708
  location: {
@@ -2690,13 +2729,13 @@ export const manifest: Manifest = {
2690
2729
  {
2691
2730
  name: 'ItemFormAdditionalMethods',
2692
2731
  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",
2732
+ markdownText:
2733
+ "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
2695
2734
  },
2696
2735
  items: {
2697
2736
  toggleField: {
2698
2737
  comment: {
2699
- comment:
2738
+ markdownText:
2700
2739
  '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
2740
  example:
2702
2741
  "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 +2748,8 @@ export const manifest: Manifest = {
2709
2748
  },
2710
2749
  disableField: {
2711
2750
  comment: {
2712
- comment: 'Disables/re-enables a specific field in the form',
2751
+ markdownText:
2752
+ 'Disables/re-enables a specific field in the form.',
2713
2753
  example:
2714
2754
  "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
2755
  },
@@ -2721,7 +2761,7 @@ export const manifest: Manifest = {
2721
2761
  },
2722
2762
  scrollToField: {
2723
2763
  comment: {
2724
- comment:
2764
+ markdownText:
2725
2765
  '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
2766
  example:
2727
2767
  "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 +2774,8 @@ export const manifest: Manifest = {
2734
2774
  },
2735
2775
  setFieldValue: {
2736
2776
  comment: {
2737
- comment: 'Changes a specific path of the `formValues` object',
2777
+ markdownText:
2778
+ 'Changes a specific path of the `formValues` object.',
2738
2779
  example:
2739
2780
  "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
2781
  },
@@ -2746,7 +2787,7 @@ export const manifest: Manifest = {
2746
2787
  },
2747
2788
  formValuesToItem: {
2748
2789
  comment: {
2749
- comment:
2790
+ markdownText:
2750
2791
  '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
2792
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
2752
2793
  },
@@ -2758,8 +2799,8 @@ export const manifest: Manifest = {
2758
2799
  },
2759
2800
  itemToFormValues: {
2760
2801
  comment: {
2761
- comment:
2762
- 'Takes an Item entity, and converts it into the internal form state',
2802
+ markdownText:
2803
+ 'Takes an Item entity, and converts it into the internal form state.',
2763
2804
  example: 'await ctx.itemToFormValues(ctx.item);',
2764
2805
  },
2765
2806
  location: {
@@ -2770,7 +2811,7 @@ export const manifest: Manifest = {
2770
2811
  },
2771
2812
  saveCurrentItem: {
2772
2813
  comment: {
2773
- comment: 'Triggers a submit form for current record',
2814
+ markdownText: 'Triggers a submit form for current record.',
2774
2815
  example: 'await ctx.saveCurrentItem();',
2775
2816
  },
2776
2817
  location: {
@@ -2792,8 +2833,8 @@ export const manifest: Manifest = {
2792
2833
  customMarksForStructuredTextField: {
2793
2834
  name: 'customMarksForStructuredTextField',
2794
2835
  comment: {
2795
- comment:
2796
- 'Use this function to define a number of custom marks for a specific\nStructured Text field',
2836
+ markdownText:
2837
+ 'Use this function to define a number of custom marks for a specific\nStructured Text field.',
2797
2838
  tag: 'structuredText',
2798
2839
  },
2799
2840
  nonCtxArguments: [
@@ -2828,8 +2869,8 @@ export const manifest: Manifest = {
2828
2869
  customBlockStylesForStructuredTextField: {
2829
2870
  name: 'customBlockStylesForStructuredTextField',
2830
2871
  comment: {
2831
- comment:
2832
- 'Use this function to define a number of custom block styles for a specific\nStructured Text field',
2872
+ markdownText:
2873
+ 'Use this function to define a number of custom block styles for a specific\nStructured Text field.',
2833
2874
  tag: 'structuredText',
2834
2875
  },
2835
2876
  nonCtxArguments: [
@@ -2865,8 +2906,8 @@ export const manifest: Manifest = {
2865
2906
  contentAreaSidebarItems: {
2866
2907
  name: 'contentAreaSidebarItems',
2867
2908
  comment: {
2868
- comment:
2869
- 'Use this function to declare new items in the content area sidebar',
2909
+ markdownText:
2910
+ 'Use this function to declare new items in the content area sidebar.',
2870
2911
  tag: 'sidebarItems',
2871
2912
  },
2872
2913
  nonCtxArguments: [],
@@ -2884,8 +2925,8 @@ export const manifest: Manifest = {
2884
2925
  buildItemPresentationInfo: {
2885
2926
  name: 'buildItemPresentationInfo',
2886
2927
  comment: {
2887
- comment:
2888
- 'Use this function to customize the presentation of a record in records\ncollections and "Single link" or "Multiple links" field',
2928
+ markdownText:
2929
+ 'Use this function to customize the presentation of a record in records\ncollections and "Single link" or "Multiple links" field.',
2889
2930
  tag: 'presentation',
2890
2931
  },
2891
2932
  nonCtxArguments: [
@@ -2908,8 +2949,8 @@ export const manifest: Manifest = {
2908
2949
  assetSources: {
2909
2950
  name: 'assetSources',
2910
2951
  comment: {
2911
- comment:
2912
- 'Use this function to declare additional sources to be shown when users want\nto upload new assets',
2952
+ markdownText:
2953
+ 'Use this function to declare additional sources to be shown when users want\nto upload new assets.',
2913
2954
  tag: 'assetSources',
2914
2955
  },
2915
2956
  nonCtxArguments: [],
@@ -2930,13 +2971,13 @@ export const manifest: Manifest = {
2930
2971
  {
2931
2972
  name: 'PluginProperties',
2932
2973
  comment: {
2933
- comment:
2974
+ markdownText:
2934
2975
  "Information about the current plugin. Useful to access the plugin's global\nconfiguration object.",
2935
2976
  },
2936
2977
  items: {
2937
2978
  plugin: {
2938
2979
  comment: {
2939
- comment: 'The current plugin',
2980
+ markdownText: 'The current plugin.',
2940
2981
  },
2941
2982
  location: {
2942
2983
  filePath: 'src/ctx/base.ts',
@@ -2949,12 +2990,12 @@ export const manifest: Manifest = {
2949
2990
  {
2950
2991
  name: 'AuthenticationProperties',
2951
2992
  comment: {
2952
- comment: 'Information about the current user using the CMS',
2993
+ markdownText: 'Information about the current user using the CMS.',
2953
2994
  },
2954
2995
  items: {
2955
2996
  currentUser: {
2956
2997
  comment: {
2957
- comment:
2998
+ markdownText:
2958
2999
  'The current DatoCMS user. It can either be the owner or one of the\ncollaborators (regular or SSO).',
2959
3000
  },
2960
3001
  location: {
@@ -2965,7 +3006,7 @@ export const manifest: Manifest = {
2965
3006
  },
2966
3007
  currentRole: {
2967
3008
  comment: {
2968
- comment: 'The role for the current DatoCMS user',
3009
+ markdownText: 'The role for the current DatoCMS user.',
2969
3010
  },
2970
3011
  location: {
2971
3012
  filePath: 'src/ctx/base.ts',
@@ -2975,8 +3016,8 @@ export const manifest: Manifest = {
2975
3016
  },
2976
3017
  currentUserAccessToken: {
2977
3018
  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',
3019
+ markdownText:
3020
+ 'The access token to perform API calls on behalf of the current user. Only\navailable if `currentUserAccessToken` additional permission is granted.',
2980
3021
  },
2981
3022
  location: {
2982
3023
  filePath: 'src/ctx/base.ts',
@@ -2991,7 +3032,7 @@ export const manifest: Manifest = {
2991
3032
  items: {
2992
3033
  site: {
2993
3034
  comment: {
2994
- comment: 'The current DatoCMS project',
3035
+ markdownText: 'The current DatoCMS project.',
2995
3036
  },
2996
3037
  location: {
2997
3038
  filePath: 'src/ctx/base.ts',
@@ -3001,7 +3042,7 @@ export const manifest: Manifest = {
3001
3042
  },
3002
3043
  environment: {
3003
3044
  comment: {
3004
- comment: 'The ID of the current environment',
3045
+ markdownText: 'The ID of the current environment.',
3005
3046
  },
3006
3047
  location: {
3007
3048
  filePath: 'src/ctx/base.ts',
@@ -3011,7 +3052,8 @@ export const manifest: Manifest = {
3011
3052
  },
3012
3053
  owner: {
3013
3054
  comment: {
3014
- comment: 'The account that is the project owner',
3055
+ markdownText:
3056
+ 'The account/organization that is the project owner.',
3015
3057
  },
3016
3058
  location: {
3017
3059
  filePath: 'src/ctx/base.ts',
@@ -3021,7 +3063,9 @@ export const manifest: Manifest = {
3021
3063
  },
3022
3064
  account: {
3023
3065
  comment: {
3024
- comment: 'The account that is the project owner',
3066
+ markdownText: 'The account that is the project owner.',
3067
+ deprecatedMarkdownText:
3068
+ 'Please use `.owner` instead, as the project owner can also be\nan organization',
3025
3069
  },
3026
3070
  location: {
3027
3071
  filePath: 'src/ctx/base.ts',
@@ -3031,8 +3075,8 @@ export const manifest: Manifest = {
3031
3075
  },
3032
3076
  ui: {
3033
3077
  comment: {
3034
- comment:
3035
- 'UI preferences of the current user (right now, only the preferred locale is\navailable)',
3078
+ markdownText:
3079
+ 'UI preferences of the current user (right now, only the preferred locale is\navailable).',
3036
3080
  },
3037
3081
  location: {
3038
3082
  filePath: 'src/ctx/base.ts',
@@ -3042,8 +3086,8 @@ export const manifest: Manifest = {
3042
3086
  },
3043
3087
  theme: {
3044
3088
  comment: {
3045
- comment:
3046
- 'An object containing the theme colors for the current DatoCMS project',
3089
+ markdownText:
3090
+ 'An object containing the theme colors for the current DatoCMS project.',
3047
3091
  },
3048
3092
  location: {
3049
3093
  filePath: 'src/ctx/base.ts',
@@ -3056,14 +3100,14 @@ export const manifest: Manifest = {
3056
3100
  {
3057
3101
  name: 'EntityReposProperties',
3058
3102
  comment: {
3059
- comment:
3103
+ markdownText:
3060
3104
  '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
3105
  },
3062
3106
  items: {
3063
3107
  itemTypes: {
3064
3108
  comment: {
3065
- comment:
3066
- 'All the models of the current DatoCMS project, indexed by ID',
3109
+ markdownText:
3110
+ 'All the models of the current DatoCMS project, indexed by ID.',
3067
3111
  },
3068
3112
  location: {
3069
3113
  filePath: 'src/ctx/base.ts',
@@ -3073,7 +3117,7 @@ export const manifest: Manifest = {
3073
3117
  },
3074
3118
  fields: {
3075
3119
  comment: {
3076
- comment:
3120
+ markdownText:
3077
3121
  '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
3122
  },
3079
3123
  location: {
@@ -3084,7 +3128,7 @@ export const manifest: Manifest = {
3084
3128
  },
3085
3129
  fieldsets: {
3086
3130
  comment: {
3087
- comment:
3131
+ markdownText:
3088
3132
  '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
3133
  },
3090
3134
  location: {
@@ -3095,7 +3139,7 @@ export const manifest: Manifest = {
3095
3139
  },
3096
3140
  users: {
3097
3141
  comment: {
3098
- comment:
3142
+ markdownText:
3099
3143
  '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
3144
  },
3101
3145
  location: {
@@ -3106,7 +3150,7 @@ export const manifest: Manifest = {
3106
3150
  },
3107
3151
  ssoUsers: {
3108
3152
  comment: {
3109
- comment:
3153
+ markdownText:
3110
3154
  '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
3155
  },
3112
3156
  location: {
@@ -3122,13 +3166,13 @@ export const manifest: Manifest = {
3122
3166
  {
3123
3167
  name: 'LoadDataMethods',
3124
3168
  comment: {
3125
- comment:
3126
- 'These methods can be used to asyncronously load additional information your\nplugin needs to work',
3169
+ markdownText:
3170
+ 'These methods can be used to asyncronously load additional information your\nplugin needs to work.',
3127
3171
  },
3128
3172
  items: {
3129
3173
  loadItemTypeFields: {
3130
3174
  comment: {
3131
- comment:
3175
+ markdownText:
3132
3176
  '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
3177
  example:
3134
3178
  "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 +3185,7 @@ export const manifest: Manifest = {
3141
3185
  },
3142
3186
  loadItemTypeFieldsets: {
3143
3187
  comment: {
3144
- comment:
3188
+ markdownText:
3145
3189
  '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
3190
  example:
3147
3191
  "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 +3198,7 @@ export const manifest: Manifest = {
3154
3198
  },
3155
3199
  loadFieldsUsingPlugin: {
3156
3200
  comment: {
3157
- comment:
3201
+ markdownText:
3158
3202
  'Loads all the fields in the project that are currently using the plugin for\none of its manual field extensions.',
3159
3203
  example:
3160
3204
  "const fields = await ctx.loadFieldsUsingPlugin();\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);",
@@ -3167,7 +3211,7 @@ export const manifest: Manifest = {
3167
3211
  },
3168
3212
  loadUsers: {
3169
3213
  comment: {
3170
- comment:
3214
+ markdownText:
3171
3215
  'Loads all regular users. Users will be returned and will also be available\nin the the `users` property.',
3172
3216
  example:
3173
3217
  "const users = await ctx.loadUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
@@ -3180,7 +3224,7 @@ export const manifest: Manifest = {
3180
3224
  },
3181
3225
  loadSsoUsers: {
3182
3226
  comment: {
3183
- comment:
3227
+ markdownText:
3184
3228
  'Loads all SSO users. Users will be returned and will also be available in\nthe the `ssoUsers` property.',
3185
3229
  example:
3186
3230
  "const users = await ctx.loadSsoUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
@@ -3196,13 +3240,13 @@ export const manifest: Manifest = {
3196
3240
  {
3197
3241
  name: 'UpdatePluginParametersMethods',
3198
3242
  comment: {
3199
- comment:
3243
+ markdownText:
3200
3244
  'These methods can be used to update both plugin parameters and manual field\nextensions configuration.',
3201
3245
  },
3202
3246
  items: {
3203
3247
  updatePluginParameters: {
3204
3248
  comment: {
3205
- comment:
3249
+ markdownText:
3206
3250
  '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
3251
  example:
3208
3252
  "await ctx.updatePluginParameters({ debugMode: true });\nawait ctx.notice('Plugin parameters successfully updated!');",
@@ -3215,7 +3259,7 @@ export const manifest: Manifest = {
3215
3259
  },
3216
3260
  updateFieldAppearance: {
3217
3261
  comment: {
3218
- comment:
3262
+ markdownText:
3219
3263
  '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
3264
  example:
3221
3265
  "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 +3275,14 @@ export const manifest: Manifest = {
3231
3275
  {
3232
3276
  name: 'ToastMethods',
3233
3277
  comment: {
3234
- comment:
3235
- 'These methods can be used to show UI-consistent toast notifications to the\nend-user',
3278
+ markdownText:
3279
+ 'These methods can be used to show UI-consistent toast notifications to the\nend-user.',
3236
3280
  },
3237
3281
  items: {
3238
3282
  alert: {
3239
3283
  comment: {
3240
- comment:
3241
- 'Triggers an "error" toast displaying the selected message',
3284
+ markdownText:
3285
+ 'Triggers an "error" toast displaying the selected message.',
3242
3286
  example:
3243
3287
  "const message = prompt(\n 'Please insert a message:',\n 'This is an alert message!',\n);\n\nawait ctx.alert(message);",
3244
3288
  },
@@ -3250,8 +3294,8 @@ export const manifest: Manifest = {
3250
3294
  },
3251
3295
  notice: {
3252
3296
  comment: {
3253
- comment:
3254
- 'Triggers a "success" toast displaying the selected message',
3297
+ markdownText:
3298
+ 'Triggers a "success" toast displaying the selected message.',
3255
3299
  example:
3256
3300
  "const message = prompt(\n 'Please insert a message:',\n 'This is a notice message!',\n);\n\nawait ctx.notice(message);",
3257
3301
  },
@@ -3263,8 +3307,8 @@ export const manifest: Manifest = {
3263
3307
  },
3264
3308
  customToast: {
3265
3309
  comment: {
3266
- comment:
3267
- 'Triggers a custom toast displaying the selected message (and optionally a\nCTA)',
3310
+ markdownText:
3311
+ 'Triggers a custom toast displaying the selected message (and optionally a\nCTA).',
3268
3312
  example:
3269
3313
  "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
3314
  },
@@ -3279,13 +3323,13 @@ export const manifest: Manifest = {
3279
3323
  {
3280
3324
  name: 'ItemDialogMethods',
3281
3325
  comment: {
3282
- comment:
3283
- 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith records',
3326
+ markdownText:
3327
+ 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith records.',
3284
3328
  },
3285
3329
  items: {
3286
3330
  createNewItem: {
3287
3331
  comment: {
3288
- comment:
3332
+ markdownText:
3289
3333
  '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
3334
  example:
3291
3335
  "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 +3342,7 @@ export const manifest: Manifest = {
3298
3342
  },
3299
3343
  selectItem: {
3300
3344
  comment: {
3301
- comment:
3345
+ markdownText:
3302
3346
  '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
3347
  example:
3304
3348
  "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 +3355,7 @@ export const manifest: Manifest = {
3311
3355
  },
3312
3356
  editItem: {
3313
3357
  comment: {
3314
- comment:
3358
+ markdownText:
3315
3359
  '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
3360
  example:
3317
3361
  "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 +3371,13 @@ export const manifest: Manifest = {
3327
3371
  {
3328
3372
  name: 'UploadDialogMethods',
3329
3373
  comment: {
3330
- comment:
3331
- 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets',
3374
+ markdownText:
3375
+ 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets.',
3332
3376
  },
3333
3377
  items: {
3334
3378
  selectUpload: {
3335
3379
  comment: {
3336
- comment:
3380
+ markdownText:
3337
3381
  '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
3382
  example:
3339
3383
  "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 +3390,8 @@ export const manifest: Manifest = {
3346
3390
  },
3347
3391
  editUpload: {
3348
3392
  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',
3393
+ markdownText:
3394
+ '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
3395
  example:
3352
3396
  "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
3397
  },
@@ -3359,7 +3403,7 @@ export const manifest: Manifest = {
3359
3403
  },
3360
3404
  editUploadMetadata: {
3361
3405
  comment: {
3362
- comment:
3406
+ markdownText:
3363
3407
  '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
3408
  example:
3365
3409
  "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 +3419,14 @@ export const manifest: Manifest = {
3375
3419
  {
3376
3420
  name: 'CustomDialogMethods',
3377
3421
  comment: {
3378
- comment:
3379
- 'These methods can be used to open custom dialogs/confirmation panels',
3422
+ markdownText:
3423
+ 'These methods can be used to open custom dialogs/confirmation panels.',
3380
3424
  },
3381
3425
  items: {
3382
3426
  openModal: {
3383
3427
  comment: {
3384
- comment:
3385
- 'Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function',
3428
+ markdownText:
3429
+ 'Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function.',
3386
3430
  example:
3387
3431
  "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
3432
  },
@@ -3394,8 +3438,8 @@ export const manifest: Manifest = {
3394
3438
  },
3395
3439
  openConfirm: {
3396
3440
  comment: {
3397
- comment:
3398
- 'Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user',
3441
+ markdownText:
3442
+ 'Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user.',
3399
3443
  example:
3400
3444
  "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
3445
  },
@@ -3410,13 +3454,14 @@ export const manifest: Manifest = {
3410
3454
  {
3411
3455
  name: 'NavigateMethods',
3412
3456
  comment: {
3413
- comment:
3414
- 'These methods can be used to take the user to different pages',
3457
+ markdownText:
3458
+ 'These methods can be used to take the user to different pages.',
3415
3459
  },
3416
3460
  items: {
3417
3461
  navigateTo: {
3418
3462
  comment: {
3419
- comment: 'Moves the user to another URL internal to the backend',
3463
+ markdownText:
3464
+ 'Moves the user to another URL internal to the backend.',
3420
3465
  example: "await ctx.navigateTo('/');",
3421
3466
  },
3422
3467
  location: {
@@ -3432,13 +3477,13 @@ export const manifest: Manifest = {
3432
3477
  selfResizingPluginFrameCtxSizingUtilities: {
3433
3478
  name: 'SizingUtilities',
3434
3479
  comment: {
3435
- comment:
3436
- 'A number of methods that you can use to control the size of the plugin frame',
3480
+ markdownText:
3481
+ 'A number of methods that you can use to control the size of the plugin frame.',
3437
3482
  },
3438
3483
  items: {
3439
3484
  startAutoResizer: {
3440
3485
  comment: {
3441
- comment:
3486
+ markdownText:
3442
3487
  "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
3488
  },
3444
3489
  location: {
@@ -3449,7 +3494,7 @@ export const manifest: Manifest = {
3449
3494
  },
3450
3495
  stopAutoResizer: {
3451
3496
  comment: {
3452
- comment: 'Stops resizing the iframe automatically',
3497
+ markdownText: 'Stops resizing the iframe automatically.',
3453
3498
  },
3454
3499
  location: {
3455
3500
  filePath: 'src/ctx/commonExtras/sizing.ts',
@@ -3459,8 +3504,8 @@ export const manifest: Manifest = {
3459
3504
  },
3460
3505
  updateHeight: {
3461
3506
  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",
3507
+ markdownText:
3508
+ "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
3509
  },
3465
3510
  location: {
3466
3511
  filePath: 'src/ctx/commonExtras/sizing.ts',