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
@@ -3,7 +3,7 @@ export var manifest = {
3
3
  validateManualFieldExtensionParameters: {
4
4
  name: 'validateManualFieldExtensionParameters',
5
5
  comment: {
6
- comment: 'This function will be called each time the configuration object changes. It\nmust return an object containing possible validation errors',
6
+ markdownText: 'This function will be called each time the configuration object changes. It\nmust return an object containing possible validation errors.',
7
7
  tag: 'manualFieldExtensions',
8
8
  },
9
9
  nonCtxArguments: [
@@ -25,7 +25,7 @@ export var manifest = {
25
25
  uploadsDropdownActions: {
26
26
  name: 'uploadsDropdownActions',
27
27
  comment: {
28
- comment: '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.',
28
+ markdownText: '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.',
29
29
  tag: 'dropdownActions',
30
30
  },
31
31
  nonCtxArguments: [],
@@ -43,7 +43,7 @@ export var manifest = {
43
43
  uploadSidebars: {
44
44
  name: 'uploadSidebars',
45
45
  comment: {
46
- comment: 'Use this function to declare new sidebar to be shown when the user opens\nup an asset in the Media Area',
46
+ markdownText: 'Use this function to declare new sidebar to be shown when the user opens\nup an asset in the Media Area.',
47
47
  tag: 'sidebarPanels',
48
48
  },
49
49
  nonCtxArguments: [],
@@ -61,7 +61,7 @@ export var manifest = {
61
61
  uploadSidebarPanels: {
62
62
  name: 'uploadSidebarPanels',
63
63
  comment: {
64
- comment: 'Use this function to declare new sidebar panels to be shown when the user\nopens up an asset in the Media Area',
64
+ markdownText: 'Use this function to declare new sidebar panels to be shown when the user\nopens up an asset in the Media Area.',
65
65
  tag: 'sidebarPanels',
66
66
  },
67
67
  nonCtxArguments: [],
@@ -79,7 +79,7 @@ export var manifest = {
79
79
  settingsAreaSidebarItemGroups: {
80
80
  name: 'settingsAreaSidebarItemGroups',
81
81
  comment: {
82
- comment: 'Use this function to declare new navigation sections in the Settings Area\nsidebar',
82
+ markdownText: 'Use this function to declare new navigation sections in the Settings Area\nsidebar.',
83
83
  tag: 'pages',
84
84
  },
85
85
  nonCtxArguments: [],
@@ -97,7 +97,7 @@ export var manifest = {
97
97
  renderUploadSidebarPanel: {
98
98
  name: 'renderUploadSidebarPanel',
99
99
  comment: {
100
- comment: 'This function will be called when the plugin needs to render a sidebar panel\n(see the `uploadSidebarPanels` function)',
100
+ markdownText: 'This function will be called when the plugin needs to render a sidebar panel\n(see the `uploadSidebarPanels` hook).',
101
101
  tag: 'sidebarPanels',
102
102
  },
103
103
  nonCtxArguments: [
@@ -113,7 +113,7 @@ export var manifest = {
113
113
  items: {
114
114
  sidebarPaneId: {
115
115
  comment: {
116
- comment: 'The ID of the sidebar panel that needs to be rendered',
116
+ markdownText: 'The ID of the sidebar panel that needs to be rendered.',
117
117
  },
118
118
  location: {
119
119
  filePath: 'src/hooks/renderUploadSidebarPanel.ts',
@@ -123,7 +123,7 @@ export var manifest = {
123
123
  },
124
124
  parameters: {
125
125
  comment: {
126
- comment: 'The arbitrary `parameters` of the panel declared in the\n`uploadSidebarPanels` function',
126
+ markdownText: 'The arbitrary `parameters` of the panel declared in the\n`uploadSidebarPanels` function.',
127
127
  },
128
128
  location: {
129
129
  filePath: 'src/hooks/renderUploadSidebarPanel.ts',
@@ -133,7 +133,7 @@ export var manifest = {
133
133
  },
134
134
  upload: {
135
135
  comment: {
136
- comment: 'The active asset',
136
+ markdownText: 'The active asset.',
137
137
  },
138
138
  location: {
139
139
  filePath: 'src/hooks/renderUploadSidebarPanel.ts',
@@ -155,7 +155,7 @@ export var manifest = {
155
155
  renderUploadSidebar: {
156
156
  name: 'renderUploadSidebar',
157
157
  comment: {
158
- comment: 'This function will be called when the plugin needs to render a sidebar (see\nthe `uploadSidebars` function)',
158
+ markdownText: 'This function will be called when the plugin needs to render a sidebar (see\nthe `uploadSidebars` hook).',
159
159
  tag: 'sidebarPanels',
160
160
  },
161
161
  nonCtxArguments: [
@@ -171,7 +171,7 @@ export var manifest = {
171
171
  items: {
172
172
  sidebarId: {
173
173
  comment: {
174
- comment: 'The ID of the sidebar that needs to be rendered',
174
+ markdownText: 'The ID of the sidebar that needs to be rendered.',
175
175
  },
176
176
  location: {
177
177
  filePath: 'src/hooks/renderUploadSidebar.ts',
@@ -181,7 +181,7 @@ export var manifest = {
181
181
  },
182
182
  parameters: {
183
183
  comment: {
184
- comment: 'The arbitrary `parameters` of the declared in the `uploadSidebars`\nfunction',
184
+ markdownText: 'The arbitrary `parameters` of the declared in the `uploadSidebars`\nfunction.',
185
185
  },
186
186
  location: {
187
187
  filePath: 'src/hooks/renderUploadSidebar.ts',
@@ -191,7 +191,7 @@ export var manifest = {
191
191
  },
192
192
  upload: {
193
193
  comment: {
194
- comment: 'The active asset',
194
+ markdownText: 'The active asset.',
195
195
  },
196
196
  location: {
197
197
  filePath: 'src/hooks/renderUploadSidebar.ts',
@@ -213,7 +213,7 @@ export var manifest = {
213
213
  renderPage: {
214
214
  name: 'renderPage',
215
215
  comment: {
216
- comment: 'This function will be called when the plugin needs to render a specific\npage (see the `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and\n`contentAreaSidebarItems` functions)',
216
+ markdownText: 'This function will be called when the plugin needs to render a specific\npage (see the `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and\n`contentAreaSidebarItems` functions).',
217
217
  tag: 'pages',
218
218
  },
219
219
  nonCtxArguments: [
@@ -229,7 +229,7 @@ export var manifest = {
229
229
  items: {
230
230
  pageId: {
231
231
  comment: {
232
- comment: 'The ID of the page that needs to be rendered',
232
+ markdownText: 'The ID of the page that needs to be rendered.',
233
233
  },
234
234
  location: {
235
235
  filePath: 'src/hooks/renderPage.ts',
@@ -251,7 +251,7 @@ export var manifest = {
251
251
  renderModal: {
252
252
  name: 'renderModal',
253
253
  comment: {
254
- comment: 'This function will be called when the plugin requested to open a modal (see\nthe `openModal` function)',
254
+ markdownText: 'This function will be called when the plugin requested to open a modal (see\nthe `openModal` hook).',
255
255
  tag: 'modals',
256
256
  },
257
257
  nonCtxArguments: [
@@ -267,7 +267,7 @@ export var manifest = {
267
267
  items: {
268
268
  modalId: {
269
269
  comment: {
270
- comment: 'The ID of the modal that needs to be rendered',
270
+ markdownText: 'The ID of the modal that needs to be rendered.',
271
271
  },
272
272
  location: {
273
273
  filePath: 'src/hooks/renderModal.ts',
@@ -277,7 +277,7 @@ export var manifest = {
277
277
  },
278
278
  parameters: {
279
279
  comment: {
280
- comment: 'The arbitrary `parameters` of the modal declared in the `openModal`\nfunction',
280
+ markdownText: 'The arbitrary `parameters` of the modal declared in the `openModal`\nfunction.',
281
281
  },
282
282
  location: {
283
283
  filePath: 'src/hooks/renderModal.ts',
@@ -293,7 +293,7 @@ export var manifest = {
293
293
  items: {
294
294
  resolve: {
295
295
  comment: {
296
- comment: 'A function to be called by the plugin to close the modal. The `openModal`\ncall will be resolved with the passed return value',
296
+ markdownText: 'A function to be called by the plugin to close the modal. The `openModal`\ncall will be resolved with the passed return value.',
297
297
  example: "const returnValue = prompt(\n 'Please specify the value to return to the caller:',\n 'success',\n);\n\nawait ctx.resolve(returnValue);",
298
298
  },
299
299
  location: {
@@ -327,7 +327,7 @@ export var manifest = {
327
327
  items: {
328
328
  fieldExtensionId: {
329
329
  comment: {
330
- comment: 'The ID of the field extension for which we need to render the parameters\nform',
330
+ markdownText: 'The ID of the field extension for which we need to render the parameters\nform.',
331
331
  },
332
332
  location: {
333
333
  filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
@@ -337,7 +337,7 @@ export var manifest = {
337
337
  },
338
338
  parameters: {
339
339
  comment: {
340
- comment: 'The current value of the parameters (you can change the value with the\n`setParameters` function)',
340
+ markdownText: 'The current value of the parameters (you can change the value with the\n`setParameters` hook).',
341
341
  },
342
342
  location: {
343
343
  filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
@@ -347,7 +347,7 @@ export var manifest = {
347
347
  },
348
348
  errors: {
349
349
  comment: {
350
- comment: 'The current validation errors for the parameters (you can set them\nimplementing the `validateManualFieldExtensionParameters` function)',
350
+ markdownText: 'The current validation errors for the parameters (you can set them\nimplementing the `validateManualFieldExtensionParameters` hook).',
351
351
  },
352
352
  location: {
353
353
  filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
@@ -357,7 +357,7 @@ export var manifest = {
357
357
  },
358
358
  pendingField: {
359
359
  comment: {
360
- comment: 'The field entity that is being edited in the form',
360
+ markdownText: 'The field entity that is being edited in the form.',
361
361
  },
362
362
  location: {
363
363
  filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
@@ -367,7 +367,7 @@ export var manifest = {
367
367
  },
368
368
  itemType: {
369
369
  comment: {
370
- comment: 'The model for the field being edited',
370
+ markdownText: 'The model for the field being edited.',
371
371
  },
372
372
  location: {
373
373
  filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
@@ -383,7 +383,7 @@ export var manifest = {
383
383
  items: {
384
384
  setParameters: {
385
385
  comment: {
386
- comment: 'Sets a new value for the parameters',
386
+ markdownText: 'Sets a new value for the parameters.',
387
387
  example: "await ctx.setParameters({ color: '#ff0000' });",
388
388
  },
389
389
  location: {
@@ -405,7 +405,7 @@ export var manifest = {
405
405
  renderItemFormSidebarPanel: {
406
406
  name: 'renderItemFormSidebarPanel',
407
407
  comment: {
408
- comment: 'This function will be called when the plugin needs to render a sidebar panel\n(see the `itemFormSidebarPanels` function)',
408
+ markdownText: 'This function will be called when the plugin needs to render a sidebar panel\n(see the `itemFormSidebarPanels` hook).',
409
409
  tag: 'sidebarPanels',
410
410
  },
411
411
  nonCtxArguments: [
@@ -420,12 +420,12 @@ export var manifest = {
420
420
  {
421
421
  name: 'ItemFormAdditionalProperties',
422
422
  comment: {
423
- comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
423
+ markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
424
424
  },
425
425
  items: {
426
426
  locale: {
427
427
  comment: {
428
- comment: 'The currently active locale for the record',
428
+ markdownText: 'The currently active locale for the record.',
429
429
  },
430
430
  location: {
431
431
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -435,7 +435,7 @@ export var manifest = {
435
435
  },
436
436
  item: {
437
437
  comment: {
438
- comment: 'If an already persisted record is being edited, returns the full record\nentity',
438
+ markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
439
439
  },
440
440
  location: {
441
441
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -445,7 +445,7 @@ export var manifest = {
445
445
  },
446
446
  itemType: {
447
447
  comment: {
448
- comment: 'The model for the record being edited',
448
+ markdownText: 'The model for the record being edited.',
449
449
  },
450
450
  location: {
451
451
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -455,7 +455,7 @@ export var manifest = {
455
455
  },
456
456
  formValues: {
457
457
  comment: {
458
- comment: 'The complete internal form state',
458
+ markdownText: 'The complete internal form state.',
459
459
  },
460
460
  location: {
461
461
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -465,7 +465,7 @@ export var manifest = {
465
465
  },
466
466
  itemStatus: {
467
467
  comment: {
468
- comment: 'The current status of the record being edited',
468
+ markdownText: 'The current status of the record being edited.',
469
469
  },
470
470
  location: {
471
471
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -475,7 +475,7 @@ export var manifest = {
475
475
  },
476
476
  isSubmitting: {
477
477
  comment: {
478
- comment: 'Whether the form is currently submitting itself or not',
478
+ markdownText: 'Whether the form is currently submitting itself or not.',
479
479
  },
480
480
  location: {
481
481
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -485,7 +485,7 @@ export var manifest = {
485
485
  },
486
486
  isFormDirty: {
487
487
  comment: {
488
- comment: 'Whether the form has some non-persisted changes or not',
488
+ markdownText: 'Whether the form has some non-persisted changes or not.',
489
489
  },
490
490
  location: {
491
491
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -495,7 +495,7 @@ export var manifest = {
495
495
  },
496
496
  blocksAnalysis: {
497
497
  comment: {
498
- comment: 'Provides information on how many blocks are currently present in the form',
498
+ markdownText: 'Provides information on how many blocks are currently present in the form.',
499
499
  },
500
500
  location: {
501
501
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -509,7 +509,7 @@ export var manifest = {
509
509
  items: {
510
510
  sidebarPaneId: {
511
511
  comment: {
512
- comment: 'The ID of the sidebar panel that needs to be rendered',
512
+ markdownText: 'The ID of the sidebar panel that needs to be rendered.',
513
513
  },
514
514
  location: {
515
515
  filePath: 'src/hooks/renderItemFormSidebarPanel.ts',
@@ -519,7 +519,7 @@ export var manifest = {
519
519
  },
520
520
  parameters: {
521
521
  comment: {
522
- comment: 'The arbitrary `parameters` of the panel declared in the\n`itemFormSidebarPanels` function',
522
+ markdownText: 'The arbitrary `parameters` of the panel declared in the\n`itemFormSidebarPanels` function.',
523
523
  },
524
524
  location: {
525
525
  filePath: 'src/hooks/renderItemFormSidebarPanel.ts',
@@ -534,12 +534,12 @@ export var manifest = {
534
534
  {
535
535
  name: 'ItemFormAdditionalMethods',
536
536
  comment: {
537
- comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
537
+ markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
538
538
  },
539
539
  items: {
540
540
  toggleField: {
541
541
  comment: {
542
- comment: '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.',
542
+ markdownText: '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.',
543
543
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
544
544
  },
545
545
  location: {
@@ -550,7 +550,7 @@ export var manifest = {
550
550
  },
551
551
  disableField: {
552
552
  comment: {
553
- comment: 'Disables/re-enables a specific field in the form',
553
+ markdownText: 'Disables/re-enables a specific field in the form.',
554
554
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
555
555
  },
556
556
  location: {
@@ -561,7 +561,7 @@ export var manifest = {
561
561
  },
562
562
  scrollToField: {
563
563
  comment: {
564
- comment: '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.',
564
+ markdownText: '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.',
565
565
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
566
566
  },
567
567
  location: {
@@ -572,7 +572,7 @@ export var manifest = {
572
572
  },
573
573
  setFieldValue: {
574
574
  comment: {
575
- comment: 'Changes a specific path of the `formValues` object',
575
+ markdownText: 'Changes a specific path of the `formValues` object.',
576
576
  example: "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');",
577
577
  },
578
578
  location: {
@@ -583,7 +583,7 @@ export var manifest = {
583
583
  },
584
584
  formValuesToItem: {
585
585
  comment: {
586
- comment: '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`.',
586
+ markdownText: '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`.',
587
587
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
588
588
  },
589
589
  location: {
@@ -594,7 +594,7 @@ export var manifest = {
594
594
  },
595
595
  itemToFormValues: {
596
596
  comment: {
597
- comment: 'Takes an Item entity, and converts it into the internal form state',
597
+ markdownText: 'Takes an Item entity, and converts it into the internal form state.',
598
598
  example: 'await ctx.itemToFormValues(ctx.item);',
599
599
  },
600
600
  location: {
@@ -605,7 +605,7 @@ export var manifest = {
605
605
  },
606
606
  saveCurrentItem: {
607
607
  comment: {
608
- comment: 'Triggers a submit form for current record',
608
+ markdownText: 'Triggers a submit form for current record.',
609
609
  example: 'await ctx.saveCurrentItem();',
610
610
  },
611
611
  location: {
@@ -627,7 +627,7 @@ export var manifest = {
627
627
  renderItemFormSidebar: {
628
628
  name: 'renderItemFormSidebar',
629
629
  comment: {
630
- comment: 'This function will be called when the plugin needs to render a sidebar (see\nthe `itemFormSidebars` function)',
630
+ markdownText: 'This function will be called when the plugin needs to render a sidebar (see\nthe `itemFormSidebars` hook).',
631
631
  tag: 'sidebarPanels',
632
632
  },
633
633
  nonCtxArguments: [
@@ -642,12 +642,12 @@ export var manifest = {
642
642
  {
643
643
  name: 'ItemFormAdditionalProperties',
644
644
  comment: {
645
- comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
645
+ markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
646
646
  },
647
647
  items: {
648
648
  locale: {
649
649
  comment: {
650
- comment: 'The currently active locale for the record',
650
+ markdownText: 'The currently active locale for the record.',
651
651
  },
652
652
  location: {
653
653
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -657,7 +657,7 @@ export var manifest = {
657
657
  },
658
658
  item: {
659
659
  comment: {
660
- comment: 'If an already persisted record is being edited, returns the full record\nentity',
660
+ markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
661
661
  },
662
662
  location: {
663
663
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -667,7 +667,7 @@ export var manifest = {
667
667
  },
668
668
  itemType: {
669
669
  comment: {
670
- comment: 'The model for the record being edited',
670
+ markdownText: 'The model for the record being edited.',
671
671
  },
672
672
  location: {
673
673
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -677,7 +677,7 @@ export var manifest = {
677
677
  },
678
678
  formValues: {
679
679
  comment: {
680
- comment: 'The complete internal form state',
680
+ markdownText: 'The complete internal form state.',
681
681
  },
682
682
  location: {
683
683
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -687,7 +687,7 @@ export var manifest = {
687
687
  },
688
688
  itemStatus: {
689
689
  comment: {
690
- comment: 'The current status of the record being edited',
690
+ markdownText: 'The current status of the record being edited.',
691
691
  },
692
692
  location: {
693
693
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -697,7 +697,7 @@ export var manifest = {
697
697
  },
698
698
  isSubmitting: {
699
699
  comment: {
700
- comment: 'Whether the form is currently submitting itself or not',
700
+ markdownText: 'Whether the form is currently submitting itself or not.',
701
701
  },
702
702
  location: {
703
703
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -707,7 +707,7 @@ export var manifest = {
707
707
  },
708
708
  isFormDirty: {
709
709
  comment: {
710
- comment: 'Whether the form has some non-persisted changes or not',
710
+ markdownText: 'Whether the form has some non-persisted changes or not.',
711
711
  },
712
712
  location: {
713
713
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -717,7 +717,7 @@ export var manifest = {
717
717
  },
718
718
  blocksAnalysis: {
719
719
  comment: {
720
- comment: 'Provides information on how many blocks are currently present in the form',
720
+ markdownText: 'Provides information on how many blocks are currently present in the form.',
721
721
  },
722
722
  location: {
723
723
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -731,7 +731,7 @@ export var manifest = {
731
731
  items: {
732
732
  sidebarId: {
733
733
  comment: {
734
- comment: 'The ID of the sidebar that needs to be rendered',
734
+ markdownText: 'The ID of the sidebar that needs to be rendered.',
735
735
  },
736
736
  location: {
737
737
  filePath: 'src/hooks/renderItemFormSidebar.ts',
@@ -741,7 +741,7 @@ export var manifest = {
741
741
  },
742
742
  parameters: {
743
743
  comment: {
744
- comment: 'The arbitrary `parameters` of the declared in the `itemFormSidebars`\nfunction',
744
+ markdownText: 'The arbitrary `parameters` of the declared in the `itemFormSidebars`\nfunction.',
745
745
  },
746
746
  location: {
747
747
  filePath: 'src/hooks/renderItemFormSidebar.ts',
@@ -756,12 +756,12 @@ export var manifest = {
756
756
  {
757
757
  name: 'ItemFormAdditionalMethods',
758
758
  comment: {
759
- comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
759
+ markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
760
760
  },
761
761
  items: {
762
762
  toggleField: {
763
763
  comment: {
764
- comment: '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.',
764
+ markdownText: '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.',
765
765
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
766
766
  },
767
767
  location: {
@@ -772,7 +772,7 @@ export var manifest = {
772
772
  },
773
773
  disableField: {
774
774
  comment: {
775
- comment: 'Disables/re-enables a specific field in the form',
775
+ markdownText: 'Disables/re-enables a specific field in the form.',
776
776
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
777
777
  },
778
778
  location: {
@@ -783,7 +783,7 @@ export var manifest = {
783
783
  },
784
784
  scrollToField: {
785
785
  comment: {
786
- comment: '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.',
786
+ markdownText: '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.',
787
787
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
788
788
  },
789
789
  location: {
@@ -794,7 +794,7 @@ export var manifest = {
794
794
  },
795
795
  setFieldValue: {
796
796
  comment: {
797
- comment: 'Changes a specific path of the `formValues` object',
797
+ markdownText: 'Changes a specific path of the `formValues` object.',
798
798
  example: "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');",
799
799
  },
800
800
  location: {
@@ -805,7 +805,7 @@ export var manifest = {
805
805
  },
806
806
  formValuesToItem: {
807
807
  comment: {
808
- comment: '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`.',
808
+ markdownText: '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`.',
809
809
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
810
810
  },
811
811
  location: {
@@ -816,7 +816,7 @@ export var manifest = {
816
816
  },
817
817
  itemToFormValues: {
818
818
  comment: {
819
- comment: 'Takes an Item entity, and converts it into the internal form state',
819
+ markdownText: 'Takes an Item entity, and converts it into the internal form state.',
820
820
  example: 'await ctx.itemToFormValues(ctx.item);',
821
821
  },
822
822
  location: {
@@ -827,7 +827,7 @@ export var manifest = {
827
827
  },
828
828
  saveCurrentItem: {
829
829
  comment: {
830
- comment: 'Triggers a submit form for current record',
830
+ markdownText: 'Triggers a submit form for current record.',
831
831
  example: 'await ctx.saveCurrentItem();',
832
832
  },
833
833
  location: {
@@ -849,7 +849,7 @@ export var manifest = {
849
849
  renderItemFormOutlet: {
850
850
  name: 'renderItemFormOutlet',
851
851
  comment: {
852
- comment: 'This function will be called when the plugin needs to render an outlet\ndefined by the `itemFormOutlets()` hook.',
852
+ markdownText: 'This function will be called when the plugin needs to render an outlet\ndefined by the `itemFormOutlets()` hook.',
853
853
  tag: 'outlets',
854
854
  },
855
855
  nonCtxArguments: [
@@ -864,12 +864,12 @@ export var manifest = {
864
864
  {
865
865
  name: 'ItemFormAdditionalProperties',
866
866
  comment: {
867
- comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
867
+ markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
868
868
  },
869
869
  items: {
870
870
  locale: {
871
871
  comment: {
872
- comment: 'The currently active locale for the record',
872
+ markdownText: 'The currently active locale for the record.',
873
873
  },
874
874
  location: {
875
875
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -879,7 +879,7 @@ export var manifest = {
879
879
  },
880
880
  item: {
881
881
  comment: {
882
- comment: 'If an already persisted record is being edited, returns the full record\nentity',
882
+ markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
883
883
  },
884
884
  location: {
885
885
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -889,7 +889,7 @@ export var manifest = {
889
889
  },
890
890
  itemType: {
891
891
  comment: {
892
- comment: 'The model for the record being edited',
892
+ markdownText: 'The model for the record being edited.',
893
893
  },
894
894
  location: {
895
895
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -899,7 +899,7 @@ export var manifest = {
899
899
  },
900
900
  formValues: {
901
901
  comment: {
902
- comment: 'The complete internal form state',
902
+ markdownText: 'The complete internal form state.',
903
903
  },
904
904
  location: {
905
905
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -909,7 +909,7 @@ export var manifest = {
909
909
  },
910
910
  itemStatus: {
911
911
  comment: {
912
- comment: 'The current status of the record being edited',
912
+ markdownText: 'The current status of the record being edited.',
913
913
  },
914
914
  location: {
915
915
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -919,7 +919,7 @@ export var manifest = {
919
919
  },
920
920
  isSubmitting: {
921
921
  comment: {
922
- comment: 'Whether the form is currently submitting itself or not',
922
+ markdownText: 'Whether the form is currently submitting itself or not.',
923
923
  },
924
924
  location: {
925
925
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -929,7 +929,7 @@ export var manifest = {
929
929
  },
930
930
  isFormDirty: {
931
931
  comment: {
932
- comment: 'Whether the form has some non-persisted changes or not',
932
+ markdownText: 'Whether the form has some non-persisted changes or not.',
933
933
  },
934
934
  location: {
935
935
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -939,7 +939,7 @@ export var manifest = {
939
939
  },
940
940
  blocksAnalysis: {
941
941
  comment: {
942
- comment: 'Provides information on how many blocks are currently present in the form',
942
+ markdownText: 'Provides information on how many blocks are currently present in the form.',
943
943
  },
944
944
  location: {
945
945
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -953,7 +953,7 @@ export var manifest = {
953
953
  items: {
954
954
  itemFormOutletId: {
955
955
  comment: {
956
- comment: 'The ID of the outlet that needs to be rendered',
956
+ markdownText: 'The ID of the outlet that needs to be rendered.',
957
957
  },
958
958
  location: {
959
959
  filePath: 'src/hooks/renderItemFormOutlet.ts',
@@ -968,12 +968,12 @@ export var manifest = {
968
968
  {
969
969
  name: 'ItemFormAdditionalMethods',
970
970
  comment: {
971
- comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
971
+ markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
972
972
  },
973
973
  items: {
974
974
  toggleField: {
975
975
  comment: {
976
- comment: '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.',
976
+ markdownText: '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.',
977
977
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
978
978
  },
979
979
  location: {
@@ -984,7 +984,7 @@ export var manifest = {
984
984
  },
985
985
  disableField: {
986
986
  comment: {
987
- comment: 'Disables/re-enables a specific field in the form',
987
+ markdownText: 'Disables/re-enables a specific field in the form.',
988
988
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
989
989
  },
990
990
  location: {
@@ -995,7 +995,7 @@ export var manifest = {
995
995
  },
996
996
  scrollToField: {
997
997
  comment: {
998
- comment: '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.',
998
+ markdownText: '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.',
999
999
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
1000
1000
  },
1001
1001
  location: {
@@ -1006,7 +1006,7 @@ export var manifest = {
1006
1006
  },
1007
1007
  setFieldValue: {
1008
1008
  comment: {
1009
- comment: 'Changes a specific path of the `formValues` object',
1009
+ markdownText: 'Changes a specific path of the `formValues` object.',
1010
1010
  example: "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');",
1011
1011
  },
1012
1012
  location: {
@@ -1017,7 +1017,7 @@ export var manifest = {
1017
1017
  },
1018
1018
  formValuesToItem: {
1019
1019
  comment: {
1020
- comment: '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`.',
1020
+ markdownText: '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`.',
1021
1021
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
1022
1022
  },
1023
1023
  location: {
@@ -1028,7 +1028,7 @@ export var manifest = {
1028
1028
  },
1029
1029
  itemToFormValues: {
1030
1030
  comment: {
1031
- comment: 'Takes an Item entity, and converts it into the internal form state',
1031
+ markdownText: 'Takes an Item entity, and converts it into the internal form state.',
1032
1032
  example: 'await ctx.itemToFormValues(ctx.item);',
1033
1033
  },
1034
1034
  location: {
@@ -1039,7 +1039,7 @@ export var manifest = {
1039
1039
  },
1040
1040
  saveCurrentItem: {
1041
1041
  comment: {
1042
- comment: 'Triggers a submit form for current record',
1042
+ markdownText: 'Triggers a submit form for current record.',
1043
1043
  example: 'await ctx.saveCurrentItem();',
1044
1044
  },
1045
1045
  location: {
@@ -1061,7 +1061,7 @@ export var manifest = {
1061
1061
  renderItemCollectionOutlet: {
1062
1062
  name: 'renderItemCollectionOutlet',
1063
1063
  comment: {
1064
- comment: 'This function will be called when the plugin needs to render an outlet\ndefined by the `itemFormOutlets()` hook.',
1064
+ markdownText: 'This function will be called when the plugin needs to render an outlet\ndefined by the `itemCollectionOutlets()` hook.',
1065
1065
  tag: 'outlets',
1066
1066
  },
1067
1067
  nonCtxArguments: [
@@ -1077,14 +1077,24 @@ export var manifest = {
1077
1077
  items: {
1078
1078
  itemCollectionOutletId: {
1079
1079
  comment: {
1080
- comment: 'The ID of the outlet that needs to be rendered',
1080
+ markdownText: 'The ID of the outlet that needs to be rendered.',
1081
1081
  },
1082
1082
  location: {
1083
1083
  filePath: 'src/hooks/renderItemCollectionOutlet.ts',
1084
- lineNumber: 21,
1084
+ lineNumber: 24,
1085
1085
  },
1086
1086
  type: 'string',
1087
1087
  },
1088
+ itemType: {
1089
+ comment: {
1090
+ markdownText: 'The model for which the outlet is being rendered.',
1091
+ },
1092
+ location: {
1093
+ filePath: 'src/hooks/renderItemCollectionOutlet.ts',
1094
+ lineNumber: 26,
1095
+ },
1096
+ type: 'ItemType',
1097
+ },
1088
1098
  },
1089
1099
  },
1090
1100
  ],
@@ -1093,13 +1103,13 @@ export var manifest = {
1093
1103
  returnType: 'void',
1094
1104
  location: {
1095
1105
  filePath: 'src/hooks/renderItemCollectionOutlet.ts',
1096
- lineNumber: 11,
1106
+ lineNumber: 14,
1097
1107
  },
1098
1108
  },
1099
1109
  renderFieldExtension: {
1100
1110
  name: 'renderFieldExtension',
1101
1111
  comment: {
1102
- comment: 'This function will be called when the plugin needs to render a field\nextension (see the `manualFieldExtensions` and `overrideFieldExtensions`\nfunctions)',
1112
+ markdownText: 'This function will be called when the plugin needs to render a field\nextension (see the `manualFieldExtensions` and `overrideFieldExtensions`\nfunctions).',
1103
1113
  tag: 'forcedFieldExtensions',
1104
1114
  },
1105
1115
  nonCtxArguments: [
@@ -1114,12 +1124,12 @@ export var manifest = {
1114
1124
  {
1115
1125
  name: 'ItemFormAdditionalProperties',
1116
1126
  comment: {
1117
- comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1127
+ markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
1118
1128
  },
1119
1129
  items: {
1120
1130
  locale: {
1121
1131
  comment: {
1122
- comment: 'The currently active locale for the record',
1132
+ markdownText: 'The currently active locale for the record.',
1123
1133
  },
1124
1134
  location: {
1125
1135
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1129,7 +1139,7 @@ export var manifest = {
1129
1139
  },
1130
1140
  item: {
1131
1141
  comment: {
1132
- comment: 'If an already persisted record is being edited, returns the full record\nentity',
1142
+ markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
1133
1143
  },
1134
1144
  location: {
1135
1145
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1139,7 +1149,7 @@ export var manifest = {
1139
1149
  },
1140
1150
  itemType: {
1141
1151
  comment: {
1142
- comment: 'The model for the record being edited',
1152
+ markdownText: 'The model for the record being edited.',
1143
1153
  },
1144
1154
  location: {
1145
1155
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1149,7 +1159,7 @@ export var manifest = {
1149
1159
  },
1150
1160
  formValues: {
1151
1161
  comment: {
1152
- comment: 'The complete internal form state',
1162
+ markdownText: 'The complete internal form state.',
1153
1163
  },
1154
1164
  location: {
1155
1165
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1159,7 +1169,7 @@ export var manifest = {
1159
1169
  },
1160
1170
  itemStatus: {
1161
1171
  comment: {
1162
- comment: 'The current status of the record being edited',
1172
+ markdownText: 'The current status of the record being edited.',
1163
1173
  },
1164
1174
  location: {
1165
1175
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1169,7 +1179,7 @@ export var manifest = {
1169
1179
  },
1170
1180
  isSubmitting: {
1171
1181
  comment: {
1172
- comment: 'Whether the form is currently submitting itself or not',
1182
+ markdownText: 'Whether the form is currently submitting itself or not.',
1173
1183
  },
1174
1184
  location: {
1175
1185
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1179,7 +1189,7 @@ export var manifest = {
1179
1189
  },
1180
1190
  isFormDirty: {
1181
1191
  comment: {
1182
- comment: 'Whether the form has some non-persisted changes or not',
1192
+ markdownText: 'Whether the form has some non-persisted changes or not.',
1183
1193
  },
1184
1194
  location: {
1185
1195
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1189,7 +1199,7 @@ export var manifest = {
1189
1199
  },
1190
1200
  blocksAnalysis: {
1191
1201
  comment: {
1192
- comment: 'Provides information on how many blocks are currently present in the form',
1202
+ markdownText: 'Provides information on how many blocks are currently present in the form.',
1193
1203
  },
1194
1204
  location: {
1195
1205
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1202,12 +1212,12 @@ export var manifest = {
1202
1212
  {
1203
1213
  name: 'FieldAdditionalProperties',
1204
1214
  comment: {
1205
- comment: 'These information describe the current state of the field where this plugin\nis applied to.',
1215
+ markdownText: 'These information describe the current state of the field where this plugin\nis applied to.',
1206
1216
  },
1207
1217
  items: {
1208
1218
  disabled: {
1209
1219
  comment: {
1210
- comment: 'Whether the field is currently disabled or not',
1220
+ markdownText: 'Whether the field is currently disabled or not.',
1211
1221
  },
1212
1222
  location: {
1213
1223
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1217,7 +1227,7 @@ export var manifest = {
1217
1227
  },
1218
1228
  fieldPath: {
1219
1229
  comment: {
1220
- comment: 'The path in the `formValues` object where to find the current value for the\nfield',
1230
+ markdownText: 'The path in the `formValues` object where to find the current value for the\nfield.',
1221
1231
  },
1222
1232
  location: {
1223
1233
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1227,7 +1237,7 @@ export var manifest = {
1227
1237
  },
1228
1238
  field: {
1229
1239
  comment: {
1230
- comment: 'The field where the field extension is installed to',
1240
+ markdownText: 'The field where the field extension is installed to.',
1231
1241
  },
1232
1242
  location: {
1233
1243
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1237,7 +1247,7 @@ export var manifest = {
1237
1247
  },
1238
1248
  parentField: {
1239
1249
  comment: {
1240
- comment: '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',
1250
+ markdownText: '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.',
1241
1251
  },
1242
1252
  location: {
1243
1253
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1247,7 +1257,7 @@ export var manifest = {
1247
1257
  },
1248
1258
  block: {
1249
1259
  comment: {
1250
- comment: '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.',
1260
+ markdownText: '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.',
1251
1261
  },
1252
1262
  location: {
1253
1263
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -1261,7 +1271,7 @@ export var manifest = {
1261
1271
  items: {
1262
1272
  fieldExtensionId: {
1263
1273
  comment: {
1264
- comment: 'The ID of the field extension that needs to be rendered',
1274
+ markdownText: 'The ID of the field extension that needs to be rendered.',
1265
1275
  },
1266
1276
  location: {
1267
1277
  filePath: 'src/hooks/renderFieldExtension.ts',
@@ -1271,7 +1281,7 @@ export var manifest = {
1271
1281
  },
1272
1282
  parameters: {
1273
1283
  comment: {
1274
- comment: 'The arbitrary `parameters` of the field extension',
1284
+ markdownText: 'The arbitrary `parameters` of the field extension.',
1275
1285
  },
1276
1286
  location: {
1277
1287
  filePath: 'src/hooks/renderFieldExtension.ts',
@@ -1286,12 +1296,12 @@ export var manifest = {
1286
1296
  {
1287
1297
  name: 'ItemFormAdditionalMethods',
1288
1298
  comment: {
1289
- comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
1299
+ markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
1290
1300
  },
1291
1301
  items: {
1292
1302
  toggleField: {
1293
1303
  comment: {
1294
- comment: '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.',
1304
+ markdownText: '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.',
1295
1305
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
1296
1306
  },
1297
1307
  location: {
@@ -1302,7 +1312,7 @@ export var manifest = {
1302
1312
  },
1303
1313
  disableField: {
1304
1314
  comment: {
1305
- comment: 'Disables/re-enables a specific field in the form',
1315
+ markdownText: 'Disables/re-enables a specific field in the form.',
1306
1316
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
1307
1317
  },
1308
1318
  location: {
@@ -1313,7 +1323,7 @@ export var manifest = {
1313
1323
  },
1314
1324
  scrollToField: {
1315
1325
  comment: {
1316
- comment: '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.',
1326
+ markdownText: '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.',
1317
1327
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
1318
1328
  },
1319
1329
  location: {
@@ -1324,7 +1334,7 @@ export var manifest = {
1324
1334
  },
1325
1335
  setFieldValue: {
1326
1336
  comment: {
1327
- comment: 'Changes a specific path of the `formValues` object',
1337
+ markdownText: 'Changes a specific path of the `formValues` object.',
1328
1338
  example: "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');",
1329
1339
  },
1330
1340
  location: {
@@ -1335,7 +1345,7 @@ export var manifest = {
1335
1345
  },
1336
1346
  formValuesToItem: {
1337
1347
  comment: {
1338
- comment: '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`.',
1348
+ markdownText: '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`.',
1339
1349
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
1340
1350
  },
1341
1351
  location: {
@@ -1346,7 +1356,7 @@ export var manifest = {
1346
1356
  },
1347
1357
  itemToFormValues: {
1348
1358
  comment: {
1349
- comment: 'Takes an Item entity, and converts it into the internal form state',
1359
+ markdownText: 'Takes an Item entity, and converts it into the internal form state.',
1350
1360
  example: 'await ctx.itemToFormValues(ctx.item);',
1351
1361
  },
1352
1362
  location: {
@@ -1357,7 +1367,7 @@ export var manifest = {
1357
1367
  },
1358
1368
  saveCurrentItem: {
1359
1369
  comment: {
1360
- comment: 'Triggers a submit form for current record',
1370
+ markdownText: 'Triggers a submit form for current record.',
1361
1371
  example: 'await ctx.saveCurrentItem();',
1362
1372
  },
1363
1373
  location: {
@@ -1379,7 +1389,7 @@ export var manifest = {
1379
1389
  renderConfigScreen: {
1380
1390
  name: 'renderConfigScreen',
1381
1391
  comment: {
1382
- comment: "This function will be called when the plugin needs to render the plugin's\nconfiguration form",
1392
+ markdownText: "This function will be called when the plugin needs to render the plugin's\nconfiguration form.",
1383
1393
  tag: 'configScreen',
1384
1394
  },
1385
1395
  nonCtxArguments: [],
@@ -1397,7 +1407,7 @@ export var manifest = {
1397
1407
  renderAssetSource: {
1398
1408
  name: 'renderAssetSource',
1399
1409
  comment: {
1400
- comment: "This function will be called when the user selects one of the plugin's\nasset sources to upload a new media file.",
1410
+ markdownText: "This function will be called when the user selects one of the plugin's\nasset sources to upload a new media file.",
1401
1411
  tag: 'assetSources',
1402
1412
  },
1403
1413
  nonCtxArguments: [
@@ -1413,7 +1423,7 @@ export var manifest = {
1413
1423
  items: {
1414
1424
  assetSourceId: {
1415
1425
  comment: {
1416
- comment: 'The ID of the assetSource that needs to be rendered',
1426
+ markdownText: 'The ID of the assetSource that needs to be rendered.',
1417
1427
  },
1418
1428
  location: {
1419
1429
  filePath: 'src/hooks/renderAssetSource.ts',
@@ -1429,7 +1439,7 @@ export var manifest = {
1429
1439
  items: {
1430
1440
  select: {
1431
1441
  comment: {
1432
- comment: '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.',
1442
+ markdownText: '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.',
1433
1443
  example: "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});",
1434
1444
  },
1435
1445
  location: {
@@ -1451,7 +1461,7 @@ export var manifest = {
1451
1461
  overrideFieldExtensions: {
1452
1462
  name: 'overrideFieldExtensions',
1453
1463
  comment: {
1454
- comment: 'Use this function to automatically force one or more field extensions to a\nparticular field',
1464
+ markdownText: 'Use this function to automatically force one or more field extensions to a\nparticular field.',
1455
1465
  tag: 'forcedFieldExtensions',
1456
1466
  },
1457
1467
  nonCtxArguments: [
@@ -1486,7 +1496,7 @@ export var manifest = {
1486
1496
  onBoot: {
1487
1497
  name: 'onBoot',
1488
1498
  comment: {
1489
- comment: 'This function will be called once at boot time and can be used to perform\nie. some initial integrity checks on the configuration.',
1499
+ markdownText: 'This function will be called once at boot time and can be used to perform\nie. some initial integrity checks on the configuration.',
1490
1500
  tag: 'boot',
1491
1501
  },
1492
1502
  nonCtxArguments: [],
@@ -1504,7 +1514,7 @@ export var manifest = {
1504
1514
  onBeforeItemsUnpublish: {
1505
1515
  name: 'onBeforeItemsUnpublish',
1506
1516
  comment: {
1507
- comment: 'This function will be called before unpublishing records. You can stop the\naction by returning `false`',
1517
+ markdownText: 'This function will be called before unpublishing records. You can stop the\naction by returning `false`.',
1508
1518
  tag: 'beforeHooks',
1509
1519
  },
1510
1520
  nonCtxArguments: [
@@ -1527,7 +1537,7 @@ export var manifest = {
1527
1537
  onBeforeItemsPublish: {
1528
1538
  name: 'onBeforeItemsPublish',
1529
1539
  comment: {
1530
- comment: 'This function will be called before publishing records. You can stop the\naction by returning `false`',
1540
+ markdownText: 'This function will be called before publishing records. You can stop the\naction by returning `false`.',
1531
1541
  tag: 'beforeHooks',
1532
1542
  },
1533
1543
  nonCtxArguments: [
@@ -1550,7 +1560,7 @@ export var manifest = {
1550
1560
  onBeforeItemsDestroy: {
1551
1561
  name: 'onBeforeItemsDestroy',
1552
1562
  comment: {
1553
- comment: 'This function will be called before destroying records. You can stop the\naction by returning `false`',
1563
+ markdownText: 'This function will be called before destroying records. You can stop the\naction by returning `false`.',
1554
1564
  tag: 'beforeHooks',
1555
1565
  },
1556
1566
  nonCtxArguments: [
@@ -1573,7 +1583,7 @@ export var manifest = {
1573
1583
  onBeforeItemUpsert: {
1574
1584
  name: 'onBeforeItemUpsert',
1575
1585
  comment: {
1576
- comment: 'This function will be called before saving a new version of a record. You\ncan stop the action by returning `false`',
1586
+ markdownText: 'This function will be called before saving a new version of a record. You\ncan stop the action by returning `false`.',
1577
1587
  tag: 'beforeHooks',
1578
1588
  },
1579
1589
  nonCtxArguments: [
@@ -1596,7 +1606,7 @@ export var manifest = {
1596
1606
  manualFieldExtensions: {
1597
1607
  name: 'manualFieldExtensions',
1598
1608
  comment: {
1599
- comment: 'Use this function to declare new field extensions that users will be able\nto install manually in some field',
1609
+ markdownText: 'Use this function to declare new field extensions that users will be able\nto install manually in some field.',
1600
1610
  tag: 'manualFieldExtensions',
1601
1611
  },
1602
1612
  nonCtxArguments: [],
@@ -1614,7 +1624,7 @@ export var manifest = {
1614
1624
  mainNavigationTabs: {
1615
1625
  name: 'mainNavigationTabs',
1616
1626
  comment: {
1617
- comment: 'Use this function to declare new tabs you want to add in the top-bar of the\nUI',
1627
+ markdownText: 'Use this function to declare new tabs you want to add in the top-bar of the\nUI.',
1618
1628
  tag: 'pages',
1619
1629
  },
1620
1630
  nonCtxArguments: [],
@@ -1632,7 +1642,7 @@ export var manifest = {
1632
1642
  itemsDropdownActions: {
1633
1643
  name: 'itemsDropdownActions',
1634
1644
  comment: {
1635
- comment: '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.',
1645
+ markdownText: '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.',
1636
1646
  tag: 'dropdownActions',
1637
1647
  },
1638
1648
  nonCtxArguments: [
@@ -1667,7 +1677,7 @@ export var manifest = {
1667
1677
  itemFormSidebars: {
1668
1678
  name: 'itemFormSidebars',
1669
1679
  comment: {
1670
- comment: 'Use this function to declare new sidebar to be shown when the user edits\nrecords of a particular model',
1680
+ markdownText: 'Use this function to declare new sidebar to be shown when the user edits\nrecords of a particular model.',
1671
1681
  tag: 'sidebarPanels',
1672
1682
  },
1673
1683
  nonCtxArguments: [
@@ -1690,7 +1700,7 @@ export var manifest = {
1690
1700
  itemFormSidebarPanels: {
1691
1701
  name: 'itemFormSidebarPanels',
1692
1702
  comment: {
1693
- comment: 'Use this function to declare new sidebar panels to be shown when the user\nedits records of a particular model',
1703
+ markdownText: 'Use this function to declare new sidebar panels to be shown when the user\nedits records of a particular model.',
1694
1704
  tag: 'sidebarPanels',
1695
1705
  },
1696
1706
  nonCtxArguments: [
@@ -1713,7 +1723,7 @@ export var manifest = {
1713
1723
  itemFormOutlets: {
1714
1724
  name: 'itemFormOutlets',
1715
1725
  comment: {
1716
- comment: "Use this function to declare custom outlets to be shown at the top of the\nrecord's editing page",
1726
+ markdownText: "Use this function to declare custom outlets to be shown at the top of the\nrecord's editing page.",
1717
1727
  tag: 'outlets',
1718
1728
  },
1719
1729
  nonCtxArguments: [
@@ -1736,7 +1746,7 @@ export var manifest = {
1736
1746
  itemFormDropdownActions: {
1737
1747
  name: 'itemFormDropdownActions',
1738
1748
  comment: {
1739
- comment: '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.',
1749
+ markdownText: '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.',
1740
1750
  tag: 'dropdownActions',
1741
1751
  },
1742
1752
  nonCtxArguments: [
@@ -1751,12 +1761,12 @@ export var manifest = {
1751
1761
  {
1752
1762
  name: 'ItemFormAdditionalProperties',
1753
1763
  comment: {
1754
- comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1764
+ markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
1755
1765
  },
1756
1766
  items: {
1757
1767
  locale: {
1758
1768
  comment: {
1759
- comment: 'The currently active locale for the record',
1769
+ markdownText: 'The currently active locale for the record.',
1760
1770
  },
1761
1771
  location: {
1762
1772
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1766,7 +1776,7 @@ export var manifest = {
1766
1776
  },
1767
1777
  item: {
1768
1778
  comment: {
1769
- comment: 'If an already persisted record is being edited, returns the full record\nentity',
1779
+ markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
1770
1780
  },
1771
1781
  location: {
1772
1782
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1776,7 +1786,7 @@ export var manifest = {
1776
1786
  },
1777
1787
  itemType: {
1778
1788
  comment: {
1779
- comment: 'The model for the record being edited',
1789
+ markdownText: 'The model for the record being edited.',
1780
1790
  },
1781
1791
  location: {
1782
1792
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1786,7 +1796,7 @@ export var manifest = {
1786
1796
  },
1787
1797
  formValues: {
1788
1798
  comment: {
1789
- comment: 'The complete internal form state',
1799
+ markdownText: 'The complete internal form state.',
1790
1800
  },
1791
1801
  location: {
1792
1802
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1796,7 +1806,7 @@ export var manifest = {
1796
1806
  },
1797
1807
  itemStatus: {
1798
1808
  comment: {
1799
- comment: 'The current status of the record being edited',
1809
+ markdownText: 'The current status of the record being edited.',
1800
1810
  },
1801
1811
  location: {
1802
1812
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1806,7 +1816,7 @@ export var manifest = {
1806
1816
  },
1807
1817
  isSubmitting: {
1808
1818
  comment: {
1809
- comment: 'Whether the form is currently submitting itself or not',
1819
+ markdownText: 'Whether the form is currently submitting itself or not.',
1810
1820
  },
1811
1821
  location: {
1812
1822
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1816,7 +1826,7 @@ export var manifest = {
1816
1826
  },
1817
1827
  isFormDirty: {
1818
1828
  comment: {
1819
- comment: 'Whether the form has some non-persisted changes or not',
1829
+ markdownText: 'Whether the form has some non-persisted changes or not.',
1820
1830
  },
1821
1831
  location: {
1822
1832
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1826,7 +1836,7 @@ export var manifest = {
1826
1836
  },
1827
1837
  blocksAnalysis: {
1828
1838
  comment: {
1829
- comment: 'Provides information on how many blocks are currently present in the form',
1839
+ markdownText: 'Provides information on how many blocks are currently present in the form.',
1830
1840
  },
1831
1841
  location: {
1832
1842
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1848,7 +1858,7 @@ export var manifest = {
1848
1858
  itemCollectionOutlets: {
1849
1859
  name: 'itemCollectionOutlets',
1850
1860
  comment: {
1851
- comment: 'Use this function to declare custom outlets to be shown at the top of a\ncollection of records of a particular model',
1861
+ markdownText: 'Use this function to declare custom outlets to be shown at the top of a\ncollection of records of a particular model.',
1852
1862
  tag: 'outlets',
1853
1863
  },
1854
1864
  nonCtxArguments: [
@@ -1871,7 +1881,7 @@ export var manifest = {
1871
1881
  initialLocationQueryForItemSelector: {
1872
1882
  name: 'initialLocationQueryForItemSelector',
1873
1883
  comment: {
1874
- comment: 'Use this function to customize the initial filters when opening a record\nselector via a "Single link" or "Multiple links" field',
1884
+ markdownText: 'Use this function to customize the initial filters when opening a record\nselector via a "Single link" or "Multiple links" field.',
1875
1885
  tag: 'locationQuery',
1876
1886
  },
1877
1887
  nonCtxArguments: [
@@ -1898,7 +1908,7 @@ export var manifest = {
1898
1908
  fieldDropdownActions: {
1899
1909
  name: 'fieldDropdownActions',
1900
1910
  comment: {
1901
- comment: '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.',
1911
+ markdownText: '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.',
1902
1912
  tag: 'dropdownActions',
1903
1913
  },
1904
1914
  nonCtxArguments: [
@@ -1913,12 +1923,12 @@ export var manifest = {
1913
1923
  {
1914
1924
  name: 'ItemFormAdditionalProperties',
1915
1925
  comment: {
1916
- comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
1926
+ markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
1917
1927
  },
1918
1928
  items: {
1919
1929
  locale: {
1920
1930
  comment: {
1921
- comment: 'The currently active locale for the record',
1931
+ markdownText: 'The currently active locale for the record.',
1922
1932
  },
1923
1933
  location: {
1924
1934
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1928,7 +1938,7 @@ export var manifest = {
1928
1938
  },
1929
1939
  item: {
1930
1940
  comment: {
1931
- comment: 'If an already persisted record is being edited, returns the full record\nentity',
1941
+ markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
1932
1942
  },
1933
1943
  location: {
1934
1944
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1938,7 +1948,7 @@ export var manifest = {
1938
1948
  },
1939
1949
  itemType: {
1940
1950
  comment: {
1941
- comment: 'The model for the record being edited',
1951
+ markdownText: 'The model for the record being edited.',
1942
1952
  },
1943
1953
  location: {
1944
1954
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1948,7 +1958,7 @@ export var manifest = {
1948
1958
  },
1949
1959
  formValues: {
1950
1960
  comment: {
1951
- comment: 'The complete internal form state',
1961
+ markdownText: 'The complete internal form state.',
1952
1962
  },
1953
1963
  location: {
1954
1964
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1958,7 +1968,7 @@ export var manifest = {
1958
1968
  },
1959
1969
  itemStatus: {
1960
1970
  comment: {
1961
- comment: 'The current status of the record being edited',
1971
+ markdownText: 'The current status of the record being edited.',
1962
1972
  },
1963
1973
  location: {
1964
1974
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1968,7 +1978,7 @@ export var manifest = {
1968
1978
  },
1969
1979
  isSubmitting: {
1970
1980
  comment: {
1971
- comment: 'Whether the form is currently submitting itself or not',
1981
+ markdownText: 'Whether the form is currently submitting itself or not.',
1972
1982
  },
1973
1983
  location: {
1974
1984
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1978,7 +1988,7 @@ export var manifest = {
1978
1988
  },
1979
1989
  isFormDirty: {
1980
1990
  comment: {
1981
- comment: 'Whether the form has some non-persisted changes or not',
1991
+ markdownText: 'Whether the form has some non-persisted changes or not.',
1982
1992
  },
1983
1993
  location: {
1984
1994
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -1988,7 +1998,7 @@ export var manifest = {
1988
1998
  },
1989
1999
  blocksAnalysis: {
1990
2000
  comment: {
1991
- comment: 'Provides information on how many blocks are currently present in the form',
2001
+ markdownText: 'Provides information on how many blocks are currently present in the form.',
1992
2002
  },
1993
2003
  location: {
1994
2004
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2001,12 +2011,12 @@ export var manifest = {
2001
2011
  {
2002
2012
  name: 'FieldAdditionalProperties',
2003
2013
  comment: {
2004
- comment: 'These information describe the current state of the field where this plugin\nis applied to.',
2014
+ markdownText: 'These information describe the current state of the field where this plugin\nis applied to.',
2005
2015
  },
2006
2016
  items: {
2007
2017
  disabled: {
2008
2018
  comment: {
2009
- comment: 'Whether the field is currently disabled or not',
2019
+ markdownText: 'Whether the field is currently disabled or not.',
2010
2020
  },
2011
2021
  location: {
2012
2022
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2016,7 +2026,7 @@ export var manifest = {
2016
2026
  },
2017
2027
  fieldPath: {
2018
2028
  comment: {
2019
- comment: 'The path in the `formValues` object where to find the current value for the\nfield',
2029
+ markdownText: 'The path in the `formValues` object where to find the current value for the\nfield.',
2020
2030
  },
2021
2031
  location: {
2022
2032
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2026,7 +2036,7 @@ export var manifest = {
2026
2036
  },
2027
2037
  field: {
2028
2038
  comment: {
2029
- comment: 'The field where the field extension is installed to',
2039
+ markdownText: 'The field where the field extension is installed to.',
2030
2040
  },
2031
2041
  location: {
2032
2042
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2036,7 +2046,7 @@ export var manifest = {
2036
2046
  },
2037
2047
  parentField: {
2038
2048
  comment: {
2039
- comment: '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',
2049
+ markdownText: '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.',
2040
2050
  },
2041
2051
  location: {
2042
2052
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2046,7 +2056,7 @@ export var manifest = {
2046
2056
  },
2047
2057
  block: {
2048
2058
  comment: {
2049
- comment: '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.',
2059
+ markdownText: '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.',
2050
2060
  },
2051
2061
  location: {
2052
2062
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2068,7 +2078,7 @@ export var manifest = {
2068
2078
  executeUploadsDropdownAction: {
2069
2079
  name: 'executeUploadsDropdownAction',
2070
2080
  comment: {
2071
- comment: 'Use this function to execute a particular dropdown action defined via\nthe `uploadsDropdownActions()` hook.',
2081
+ markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `uploadsDropdownActions()` hook.',
2072
2082
  tag: 'dropdownActions',
2073
2083
  },
2074
2084
  nonCtxArguments: [
@@ -2107,7 +2117,7 @@ export var manifest = {
2107
2117
  executeItemsDropdownAction: {
2108
2118
  name: 'executeItemsDropdownAction',
2109
2119
  comment: {
2110
- comment: 'Use this function to execute a particular dropdown action defined via\nthe `itemsDropdownActions()` hook.',
2120
+ markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `itemsDropdownActions()` hook.',
2111
2121
  tag: 'dropdownActions',
2112
2122
  },
2113
2123
  nonCtxArguments: [
@@ -2146,7 +2156,7 @@ export var manifest = {
2146
2156
  executeItemFormDropdownAction: {
2147
2157
  name: 'executeItemFormDropdownAction',
2148
2158
  comment: {
2149
- comment: 'Use this function to execute a particular dropdown action defined via\nthe `itemFormDropdownActions()` hook.',
2159
+ markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `itemFormDropdownActions()` hook.',
2150
2160
  tag: 'dropdownActions',
2151
2161
  },
2152
2162
  nonCtxArguments: [
@@ -2161,12 +2171,12 @@ export var manifest = {
2161
2171
  {
2162
2172
  name: 'ItemFormAdditionalProperties',
2163
2173
  comment: {
2164
- comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2174
+ markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
2165
2175
  },
2166
2176
  items: {
2167
2177
  locale: {
2168
2178
  comment: {
2169
- comment: 'The currently active locale for the record',
2179
+ markdownText: 'The currently active locale for the record.',
2170
2180
  },
2171
2181
  location: {
2172
2182
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2176,7 +2186,7 @@ export var manifest = {
2176
2186
  },
2177
2187
  item: {
2178
2188
  comment: {
2179
- comment: 'If an already persisted record is being edited, returns the full record\nentity',
2189
+ markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
2180
2190
  },
2181
2191
  location: {
2182
2192
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2186,7 +2196,7 @@ export var manifest = {
2186
2196
  },
2187
2197
  itemType: {
2188
2198
  comment: {
2189
- comment: 'The model for the record being edited',
2199
+ markdownText: 'The model for the record being edited.',
2190
2200
  },
2191
2201
  location: {
2192
2202
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2196,7 +2206,7 @@ export var manifest = {
2196
2206
  },
2197
2207
  formValues: {
2198
2208
  comment: {
2199
- comment: 'The complete internal form state',
2209
+ markdownText: 'The complete internal form state.',
2200
2210
  },
2201
2211
  location: {
2202
2212
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2206,7 +2216,7 @@ export var manifest = {
2206
2216
  },
2207
2217
  itemStatus: {
2208
2218
  comment: {
2209
- comment: 'The current status of the record being edited',
2219
+ markdownText: 'The current status of the record being edited.',
2210
2220
  },
2211
2221
  location: {
2212
2222
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2216,7 +2226,7 @@ export var manifest = {
2216
2226
  },
2217
2227
  isSubmitting: {
2218
2228
  comment: {
2219
- comment: 'Whether the form is currently submitting itself or not',
2229
+ markdownText: 'Whether the form is currently submitting itself or not.',
2220
2230
  },
2221
2231
  location: {
2222
2232
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2226,7 +2236,7 @@ export var manifest = {
2226
2236
  },
2227
2237
  isFormDirty: {
2228
2238
  comment: {
2229
- comment: 'Whether the form has some non-persisted changes or not',
2239
+ markdownText: 'Whether the form has some non-persisted changes or not.',
2230
2240
  },
2231
2241
  location: {
2232
2242
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2236,7 +2246,7 @@ export var manifest = {
2236
2246
  },
2237
2247
  blocksAnalysis: {
2238
2248
  comment: {
2239
- comment: 'Provides information on how many blocks are currently present in the form',
2249
+ markdownText: 'Provides information on how many blocks are currently present in the form.',
2240
2250
  },
2241
2251
  location: {
2242
2252
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2262,12 +2272,12 @@ export var manifest = {
2262
2272
  {
2263
2273
  name: 'ItemFormAdditionalMethods',
2264
2274
  comment: {
2265
- comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2275
+ markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
2266
2276
  },
2267
2277
  items: {
2268
2278
  toggleField: {
2269
2279
  comment: {
2270
- comment: '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.',
2280
+ markdownText: '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.',
2271
2281
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
2272
2282
  },
2273
2283
  location: {
@@ -2278,7 +2288,7 @@ export var manifest = {
2278
2288
  },
2279
2289
  disableField: {
2280
2290
  comment: {
2281
- comment: 'Disables/re-enables a specific field in the form',
2291
+ markdownText: 'Disables/re-enables a specific field in the form.',
2282
2292
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
2283
2293
  },
2284
2294
  location: {
@@ -2289,7 +2299,7 @@ export var manifest = {
2289
2299
  },
2290
2300
  scrollToField: {
2291
2301
  comment: {
2292
- comment: '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.',
2302
+ markdownText: '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.',
2293
2303
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
2294
2304
  },
2295
2305
  location: {
@@ -2300,7 +2310,7 @@ export var manifest = {
2300
2310
  },
2301
2311
  setFieldValue: {
2302
2312
  comment: {
2303
- comment: 'Changes a specific path of the `formValues` object',
2313
+ markdownText: 'Changes a specific path of the `formValues` object.',
2304
2314
  example: "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');",
2305
2315
  },
2306
2316
  location: {
@@ -2311,7 +2321,7 @@ export var manifest = {
2311
2321
  },
2312
2322
  formValuesToItem: {
2313
2323
  comment: {
2314
- comment: '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`.',
2324
+ markdownText: '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`.',
2315
2325
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
2316
2326
  },
2317
2327
  location: {
@@ -2322,7 +2332,7 @@ export var manifest = {
2322
2332
  },
2323
2333
  itemToFormValues: {
2324
2334
  comment: {
2325
- comment: 'Takes an Item entity, and converts it into the internal form state',
2335
+ markdownText: 'Takes an Item entity, and converts it into the internal form state.',
2326
2336
  example: 'await ctx.itemToFormValues(ctx.item);',
2327
2337
  },
2328
2338
  location: {
@@ -2333,7 +2343,7 @@ export var manifest = {
2333
2343
  },
2334
2344
  saveCurrentItem: {
2335
2345
  comment: {
2336
- comment: 'Triggers a submit form for current record',
2346
+ markdownText: 'Triggers a submit form for current record.',
2337
2347
  example: 'await ctx.saveCurrentItem();',
2338
2348
  },
2339
2349
  location: {
@@ -2355,7 +2365,7 @@ export var manifest = {
2355
2365
  executeFieldDropdownAction: {
2356
2366
  name: 'executeFieldDropdownAction',
2357
2367
  comment: {
2358
- comment: 'Use this function to execute a particular dropdown action defined via\nthe `fieldDropdownActions()` hook.',
2368
+ markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `fieldDropdownActions()` hook.',
2359
2369
  tag: 'dropdownActions',
2360
2370
  },
2361
2371
  nonCtxArguments: [
@@ -2370,12 +2380,12 @@ export var manifest = {
2370
2380
  {
2371
2381
  name: 'ItemFormAdditionalProperties',
2372
2382
  comment: {
2373
- comment: "These information describe the current state of the form that's being shown\nto the end-user to edit a record",
2383
+ markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
2374
2384
  },
2375
2385
  items: {
2376
2386
  locale: {
2377
2387
  comment: {
2378
- comment: 'The currently active locale for the record',
2388
+ markdownText: 'The currently active locale for the record.',
2379
2389
  },
2380
2390
  location: {
2381
2391
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2385,7 +2395,7 @@ export var manifest = {
2385
2395
  },
2386
2396
  item: {
2387
2397
  comment: {
2388
- comment: 'If an already persisted record is being edited, returns the full record\nentity',
2398
+ markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
2389
2399
  },
2390
2400
  location: {
2391
2401
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2395,7 +2405,7 @@ export var manifest = {
2395
2405
  },
2396
2406
  itemType: {
2397
2407
  comment: {
2398
- comment: 'The model for the record being edited',
2408
+ markdownText: 'The model for the record being edited.',
2399
2409
  },
2400
2410
  location: {
2401
2411
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2405,7 +2415,7 @@ export var manifest = {
2405
2415
  },
2406
2416
  formValues: {
2407
2417
  comment: {
2408
- comment: 'The complete internal form state',
2418
+ markdownText: 'The complete internal form state.',
2409
2419
  },
2410
2420
  location: {
2411
2421
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2415,7 +2425,7 @@ export var manifest = {
2415
2425
  },
2416
2426
  itemStatus: {
2417
2427
  comment: {
2418
- comment: 'The current status of the record being edited',
2428
+ markdownText: 'The current status of the record being edited.',
2419
2429
  },
2420
2430
  location: {
2421
2431
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2425,7 +2435,7 @@ export var manifest = {
2425
2435
  },
2426
2436
  isSubmitting: {
2427
2437
  comment: {
2428
- comment: 'Whether the form is currently submitting itself or not',
2438
+ markdownText: 'Whether the form is currently submitting itself or not.',
2429
2439
  },
2430
2440
  location: {
2431
2441
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2435,7 +2445,7 @@ export var manifest = {
2435
2445
  },
2436
2446
  isFormDirty: {
2437
2447
  comment: {
2438
- comment: 'Whether the form has some non-persisted changes or not',
2448
+ markdownText: 'Whether the form has some non-persisted changes or not.',
2439
2449
  },
2440
2450
  location: {
2441
2451
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2445,7 +2455,7 @@ export var manifest = {
2445
2455
  },
2446
2456
  blocksAnalysis: {
2447
2457
  comment: {
2448
- comment: 'Provides information on how many blocks are currently present in the form',
2458
+ markdownText: 'Provides information on how many blocks are currently present in the form.',
2449
2459
  },
2450
2460
  location: {
2451
2461
  filePath: 'src/ctx/commonExtras/itemForm.ts',
@@ -2458,12 +2468,12 @@ export var manifest = {
2458
2468
  {
2459
2469
  name: 'FieldAdditionalProperties',
2460
2470
  comment: {
2461
- comment: 'These information describe the current state of the field where this plugin\nis applied to.',
2471
+ markdownText: 'These information describe the current state of the field where this plugin\nis applied to.',
2462
2472
  },
2463
2473
  items: {
2464
2474
  disabled: {
2465
2475
  comment: {
2466
- comment: 'Whether the field is currently disabled or not',
2476
+ markdownText: 'Whether the field is currently disabled or not.',
2467
2477
  },
2468
2478
  location: {
2469
2479
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2473,7 +2483,7 @@ export var manifest = {
2473
2483
  },
2474
2484
  fieldPath: {
2475
2485
  comment: {
2476
- comment: 'The path in the `formValues` object where to find the current value for the\nfield',
2486
+ markdownText: 'The path in the `formValues` object where to find the current value for the\nfield.',
2477
2487
  },
2478
2488
  location: {
2479
2489
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2483,7 +2493,7 @@ export var manifest = {
2483
2493
  },
2484
2494
  field: {
2485
2495
  comment: {
2486
- comment: 'The field where the field extension is installed to',
2496
+ markdownText: 'The field where the field extension is installed to.',
2487
2497
  },
2488
2498
  location: {
2489
2499
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2493,7 +2503,7 @@ export var manifest = {
2493
2503
  },
2494
2504
  parentField: {
2495
2505
  comment: {
2496
- comment: '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',
2506
+ markdownText: '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.',
2497
2507
  },
2498
2508
  location: {
2499
2509
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2503,7 +2513,7 @@ export var manifest = {
2503
2513
  },
2504
2514
  block: {
2505
2515
  comment: {
2506
- comment: '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.',
2516
+ markdownText: '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.',
2507
2517
  },
2508
2518
  location: {
2509
2519
  filePath: 'src/ctx/commonExtras/field.ts',
@@ -2529,12 +2539,12 @@ export var manifest = {
2529
2539
  {
2530
2540
  name: 'ItemFormAdditionalMethods',
2531
2541
  comment: {
2532
- comment: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record",
2542
+ markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
2533
2543
  },
2534
2544
  items: {
2535
2545
  toggleField: {
2536
2546
  comment: {
2537
- comment: '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.',
2547
+ markdownText: '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.',
2538
2548
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
2539
2549
  },
2540
2550
  location: {
@@ -2545,7 +2555,7 @@ export var manifest = {
2545
2555
  },
2546
2556
  disableField: {
2547
2557
  comment: {
2548
- comment: 'Disables/re-enables a specific field in the form',
2558
+ markdownText: 'Disables/re-enables a specific field in the form.',
2549
2559
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
2550
2560
  },
2551
2561
  location: {
@@ -2556,7 +2566,7 @@ export var manifest = {
2556
2566
  },
2557
2567
  scrollToField: {
2558
2568
  comment: {
2559
- comment: '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.',
2569
+ markdownText: '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.',
2560
2570
  example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
2561
2571
  },
2562
2572
  location: {
@@ -2567,7 +2577,7 @@ export var manifest = {
2567
2577
  },
2568
2578
  setFieldValue: {
2569
2579
  comment: {
2570
- comment: 'Changes a specific path of the `formValues` object',
2580
+ markdownText: 'Changes a specific path of the `formValues` object.',
2571
2581
  example: "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');",
2572
2582
  },
2573
2583
  location: {
@@ -2578,7 +2588,7 @@ export var manifest = {
2578
2588
  },
2579
2589
  formValuesToItem: {
2580
2590
  comment: {
2581
- comment: '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`.',
2591
+ markdownText: '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`.',
2582
2592
  example: 'await ctx.formValuesToItem(ctx.formValues, false);',
2583
2593
  },
2584
2594
  location: {
@@ -2589,7 +2599,7 @@ export var manifest = {
2589
2599
  },
2590
2600
  itemToFormValues: {
2591
2601
  comment: {
2592
- comment: 'Takes an Item entity, and converts it into the internal form state',
2602
+ markdownText: 'Takes an Item entity, and converts it into the internal form state.',
2593
2603
  example: 'await ctx.itemToFormValues(ctx.item);',
2594
2604
  },
2595
2605
  location: {
@@ -2600,7 +2610,7 @@ export var manifest = {
2600
2610
  },
2601
2611
  saveCurrentItem: {
2602
2612
  comment: {
2603
- comment: 'Triggers a submit form for current record',
2613
+ markdownText: 'Triggers a submit form for current record.',
2604
2614
  example: 'await ctx.saveCurrentItem();',
2605
2615
  },
2606
2616
  location: {
@@ -2622,7 +2632,7 @@ export var manifest = {
2622
2632
  customMarksForStructuredTextField: {
2623
2633
  name: 'customMarksForStructuredTextField',
2624
2634
  comment: {
2625
- comment: 'Use this function to define a number of custom marks for a specific\nStructured Text field',
2635
+ markdownText: 'Use this function to define a number of custom marks for a specific\nStructured Text field.',
2626
2636
  tag: 'structuredText',
2627
2637
  },
2628
2638
  nonCtxArguments: [
@@ -2657,7 +2667,7 @@ export var manifest = {
2657
2667
  customBlockStylesForStructuredTextField: {
2658
2668
  name: 'customBlockStylesForStructuredTextField',
2659
2669
  comment: {
2660
- comment: 'Use this function to define a number of custom block styles for a specific\nStructured Text field',
2670
+ markdownText: 'Use this function to define a number of custom block styles for a specific\nStructured Text field.',
2661
2671
  tag: 'structuredText',
2662
2672
  },
2663
2673
  nonCtxArguments: [
@@ -2692,7 +2702,7 @@ export var manifest = {
2692
2702
  contentAreaSidebarItems: {
2693
2703
  name: 'contentAreaSidebarItems',
2694
2704
  comment: {
2695
- comment: 'Use this function to declare new items in the content area sidebar',
2705
+ markdownText: 'Use this function to declare new items in the content area sidebar.',
2696
2706
  tag: 'sidebarItems',
2697
2707
  },
2698
2708
  nonCtxArguments: [],
@@ -2710,7 +2720,7 @@ export var manifest = {
2710
2720
  buildItemPresentationInfo: {
2711
2721
  name: 'buildItemPresentationInfo',
2712
2722
  comment: {
2713
- comment: 'Use this function to customize the presentation of a record in records\ncollections and "Single link" or "Multiple links" field',
2723
+ markdownText: 'Use this function to customize the presentation of a record in records\ncollections and "Single link" or "Multiple links" field.',
2714
2724
  tag: 'presentation',
2715
2725
  },
2716
2726
  nonCtxArguments: [
@@ -2733,7 +2743,7 @@ export var manifest = {
2733
2743
  assetSources: {
2734
2744
  name: 'assetSources',
2735
2745
  comment: {
2736
- comment: 'Use this function to declare additional sources to be shown when users want\nto upload new assets',
2746
+ markdownText: 'Use this function to declare additional sources to be shown when users want\nto upload new assets.',
2737
2747
  tag: 'assetSources',
2738
2748
  },
2739
2749
  nonCtxArguments: [],
@@ -2754,12 +2764,12 @@ export var manifest = {
2754
2764
  {
2755
2765
  name: 'PluginProperties',
2756
2766
  comment: {
2757
- comment: "Information about the current plugin. Useful to access the plugin's global\nconfiguration object.",
2767
+ markdownText: "Information about the current plugin. Useful to access the plugin's global\nconfiguration object.",
2758
2768
  },
2759
2769
  items: {
2760
2770
  plugin: {
2761
2771
  comment: {
2762
- comment: 'The current plugin',
2772
+ markdownText: 'The current plugin.',
2763
2773
  },
2764
2774
  location: {
2765
2775
  filePath: 'src/ctx/base.ts',
@@ -2772,12 +2782,12 @@ export var manifest = {
2772
2782
  {
2773
2783
  name: 'AuthenticationProperties',
2774
2784
  comment: {
2775
- comment: 'Information about the current user using the CMS',
2785
+ markdownText: 'Information about the current user using the CMS.',
2776
2786
  },
2777
2787
  items: {
2778
2788
  currentUser: {
2779
2789
  comment: {
2780
- comment: 'The current DatoCMS user. It can either be the owner or one of the\ncollaborators (regular or SSO).',
2790
+ markdownText: 'The current DatoCMS user. It can either be the owner or one of the\ncollaborators (regular or SSO).',
2781
2791
  },
2782
2792
  location: {
2783
2793
  filePath: 'src/ctx/base.ts',
@@ -2787,7 +2797,7 @@ export var manifest = {
2787
2797
  },
2788
2798
  currentRole: {
2789
2799
  comment: {
2790
- comment: 'The role for the current DatoCMS user',
2800
+ markdownText: 'The role for the current DatoCMS user.',
2791
2801
  },
2792
2802
  location: {
2793
2803
  filePath: 'src/ctx/base.ts',
@@ -2797,7 +2807,7 @@ export var manifest = {
2797
2807
  },
2798
2808
  currentUserAccessToken: {
2799
2809
  comment: {
2800
- comment: 'The access token to perform API calls on behalf of the current user. Only\navailable if `currentUserAccessToken` additional permission is granted',
2810
+ markdownText: 'The access token to perform API calls on behalf of the current user. Only\navailable if `currentUserAccessToken` additional permission is granted.',
2801
2811
  },
2802
2812
  location: {
2803
2813
  filePath: 'src/ctx/base.ts',
@@ -2812,7 +2822,7 @@ export var manifest = {
2812
2822
  items: {
2813
2823
  site: {
2814
2824
  comment: {
2815
- comment: 'The current DatoCMS project',
2825
+ markdownText: 'The current DatoCMS project.',
2816
2826
  },
2817
2827
  location: {
2818
2828
  filePath: 'src/ctx/base.ts',
@@ -2822,7 +2832,7 @@ export var manifest = {
2822
2832
  },
2823
2833
  environment: {
2824
2834
  comment: {
2825
- comment: 'The ID of the current environment',
2835
+ markdownText: 'The ID of the current environment.',
2826
2836
  },
2827
2837
  location: {
2828
2838
  filePath: 'src/ctx/base.ts',
@@ -2832,7 +2842,7 @@ export var manifest = {
2832
2842
  },
2833
2843
  owner: {
2834
2844
  comment: {
2835
- comment: 'The account that is the project owner',
2845
+ markdownText: 'The account/organization that is the project owner.',
2836
2846
  },
2837
2847
  location: {
2838
2848
  filePath: 'src/ctx/base.ts',
@@ -2842,7 +2852,8 @@ export var manifest = {
2842
2852
  },
2843
2853
  account: {
2844
2854
  comment: {
2845
- comment: 'The account that is the project owner',
2855
+ markdownText: 'The account that is the project owner.',
2856
+ deprecatedMarkdownText: 'Please use `.owner` instead, as the project owner can also be\nan organization',
2846
2857
  },
2847
2858
  location: {
2848
2859
  filePath: 'src/ctx/base.ts',
@@ -2852,7 +2863,7 @@ export var manifest = {
2852
2863
  },
2853
2864
  ui: {
2854
2865
  comment: {
2855
- comment: 'UI preferences of the current user (right now, only the preferred locale is\navailable)',
2866
+ markdownText: 'UI preferences of the current user (right now, only the preferred locale is\navailable).',
2856
2867
  },
2857
2868
  location: {
2858
2869
  filePath: 'src/ctx/base.ts',
@@ -2862,7 +2873,7 @@ export var manifest = {
2862
2873
  },
2863
2874
  theme: {
2864
2875
  comment: {
2865
- comment: 'An object containing the theme colors for the current DatoCMS project',
2876
+ markdownText: 'An object containing the theme colors for the current DatoCMS project.',
2866
2877
  },
2867
2878
  location: {
2868
2879
  filePath: 'src/ctx/base.ts',
@@ -2875,12 +2886,12 @@ export var manifest = {
2875
2886
  {
2876
2887
  name: 'EntityReposProperties',
2877
2888
  comment: {
2878
- comment: '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.',
2889
+ markdownText: '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.',
2879
2890
  },
2880
2891
  items: {
2881
2892
  itemTypes: {
2882
2893
  comment: {
2883
- comment: 'All the models of the current DatoCMS project, indexed by ID',
2894
+ markdownText: 'All the models of the current DatoCMS project, indexed by ID.',
2884
2895
  },
2885
2896
  location: {
2886
2897
  filePath: 'src/ctx/base.ts',
@@ -2890,7 +2901,7 @@ export var manifest = {
2890
2901
  },
2891
2902
  fields: {
2892
2903
  comment: {
2893
- comment: '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.',
2904
+ markdownText: '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.',
2894
2905
  },
2895
2906
  location: {
2896
2907
  filePath: 'src/ctx/base.ts',
@@ -2900,7 +2911,7 @@ export var manifest = {
2900
2911
  },
2901
2912
  fieldsets: {
2902
2913
  comment: {
2903
- comment: '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.',
2914
+ markdownText: '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.',
2904
2915
  },
2905
2916
  location: {
2906
2917
  filePath: 'src/ctx/base.ts',
@@ -2910,7 +2921,7 @@ export var manifest = {
2910
2921
  },
2911
2922
  users: {
2912
2923
  comment: {
2913
- comment: '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.',
2924
+ markdownText: '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.',
2914
2925
  },
2915
2926
  location: {
2916
2927
  filePath: 'src/ctx/base.ts',
@@ -2920,7 +2931,7 @@ export var manifest = {
2920
2931
  },
2921
2932
  ssoUsers: {
2922
2933
  comment: {
2923
- comment: '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.',
2934
+ markdownText: '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.',
2924
2935
  },
2925
2936
  location: {
2926
2937
  filePath: 'src/ctx/base.ts',
@@ -2935,12 +2946,12 @@ export var manifest = {
2935
2946
  {
2936
2947
  name: 'LoadDataMethods',
2937
2948
  comment: {
2938
- comment: 'These methods can be used to asyncronously load additional information your\nplugin needs to work',
2949
+ markdownText: 'These methods can be used to asyncronously load additional information your\nplugin needs to work.',
2939
2950
  },
2940
2951
  items: {
2941
2952
  loadItemTypeFields: {
2942
2953
  comment: {
2943
- comment: 'Loads all the fields for a specific model (or block). Fields will be\nreturned and will also be available in the the `fields` property.',
2954
+ markdownText: 'Loads all the fields for a specific model (or block). Fields will be\nreturned and will also be available in the the `fields` property.',
2944
2955
  example: "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);",
2945
2956
  },
2946
2957
  location: {
@@ -2951,7 +2962,7 @@ export var manifest = {
2951
2962
  },
2952
2963
  loadItemTypeFieldsets: {
2953
2964
  comment: {
2954
- comment: 'Loads all the fieldsets for a specific model (or block). Fieldsets will be\nreturned and will also be available in the the `fieldsets` property.',
2965
+ markdownText: 'Loads all the fieldsets for a specific model (or block). Fieldsets will be\nreturned and will also be available in the the `fieldsets` property.',
2955
2966
  example: "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);",
2956
2967
  },
2957
2968
  location: {
@@ -2962,7 +2973,7 @@ export var manifest = {
2962
2973
  },
2963
2974
  loadFieldsUsingPlugin: {
2964
2975
  comment: {
2965
- comment: 'Loads all the fields in the project that are currently using the plugin for\none of its manual field extensions.',
2976
+ markdownText: 'Loads all the fields in the project that are currently using the plugin for\none of its manual field extensions.',
2966
2977
  example: "const fields = await ctx.loadFieldsUsingPlugin();\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);",
2967
2978
  },
2968
2979
  location: {
@@ -2973,7 +2984,7 @@ export var manifest = {
2973
2984
  },
2974
2985
  loadUsers: {
2975
2986
  comment: {
2976
- comment: 'Loads all regular users. Users will be returned and will also be available\nin the the `users` property.',
2987
+ markdownText: 'Loads all regular users. Users will be returned and will also be available\nin the the `users` property.',
2977
2988
  example: "const users = await ctx.loadUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
2978
2989
  },
2979
2990
  location: {
@@ -2984,7 +2995,7 @@ export var manifest = {
2984
2995
  },
2985
2996
  loadSsoUsers: {
2986
2997
  comment: {
2987
- comment: 'Loads all SSO users. Users will be returned and will also be available in\nthe the `ssoUsers` property.',
2998
+ markdownText: 'Loads all SSO users. Users will be returned and will also be available in\nthe the `ssoUsers` property.',
2988
2999
  example: "const users = await ctx.loadSsoUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
2989
3000
  },
2990
3001
  location: {
@@ -2998,12 +3009,12 @@ export var manifest = {
2998
3009
  {
2999
3010
  name: 'UpdatePluginParametersMethods',
3000
3011
  comment: {
3001
- comment: 'These methods can be used to update both plugin parameters and manual field\nextensions configuration.',
3012
+ markdownText: 'These methods can be used to update both plugin parameters and manual field\nextensions configuration.',
3002
3013
  },
3003
3014
  items: {
3004
3015
  updatePluginParameters: {
3005
3016
  comment: {
3006
- comment: '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.',
3017
+ markdownText: '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.',
3007
3018
  example: "await ctx.updatePluginParameters({ debugMode: true });\nawait ctx.notice('Plugin parameters successfully updated!');",
3008
3019
  },
3009
3020
  location: {
@@ -3014,7 +3025,7 @@ export var manifest = {
3014
3025
  },
3015
3026
  updateFieldAppearance: {
3016
3027
  comment: {
3017
- comment: '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.',
3028
+ markdownText: '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.',
3018
3029
  example: "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}",
3019
3030
  },
3020
3031
  location: {
@@ -3028,12 +3039,12 @@ export var manifest = {
3028
3039
  {
3029
3040
  name: 'ToastMethods',
3030
3041
  comment: {
3031
- comment: 'These methods can be used to show UI-consistent toast notifications to the\nend-user',
3042
+ markdownText: 'These methods can be used to show UI-consistent toast notifications to the\nend-user.',
3032
3043
  },
3033
3044
  items: {
3034
3045
  alert: {
3035
3046
  comment: {
3036
- comment: 'Triggers an "error" toast displaying the selected message',
3047
+ markdownText: 'Triggers an "error" toast displaying the selected message.',
3037
3048
  example: "const message = prompt(\n 'Please insert a message:',\n 'This is an alert message!',\n);\n\nawait ctx.alert(message);",
3038
3049
  },
3039
3050
  location: {
@@ -3044,7 +3055,7 @@ export var manifest = {
3044
3055
  },
3045
3056
  notice: {
3046
3057
  comment: {
3047
- comment: 'Triggers a "success" toast displaying the selected message',
3058
+ markdownText: 'Triggers a "success" toast displaying the selected message.',
3048
3059
  example: "const message = prompt(\n 'Please insert a message:',\n 'This is a notice message!',\n);\n\nawait ctx.notice(message);",
3049
3060
  },
3050
3061
  location: {
@@ -3055,7 +3066,7 @@ export var manifest = {
3055
3066
  },
3056
3067
  customToast: {
3057
3068
  comment: {
3058
- comment: 'Triggers a custom toast displaying the selected message (and optionally a\nCTA)',
3069
+ markdownText: 'Triggers a custom toast displaying the selected message (and optionally a\nCTA).',
3059
3070
  example: "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}",
3060
3071
  },
3061
3072
  location: {
@@ -3069,12 +3080,12 @@ export var manifest = {
3069
3080
  {
3070
3081
  name: 'ItemDialogMethods',
3071
3082
  comment: {
3072
- comment: 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith records',
3083
+ markdownText: 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith records.',
3073
3084
  },
3074
3085
  items: {
3075
3086
  createNewItem: {
3076
3087
  comment: {
3077
- comment: '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.',
3088
+ markdownText: '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.',
3078
3089
  example: "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}",
3079
3090
  },
3080
3091
  location: {
@@ -3085,7 +3096,7 @@ export var manifest = {
3085
3096
  },
3086
3097
  selectItem: {
3087
3098
  comment: {
3088
- comment: '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.',
3099
+ markdownText: '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.',
3089
3100
  example: "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}",
3090
3101
  },
3091
3102
  location: {
@@ -3096,7 +3107,7 @@ export var manifest = {
3096
3107
  },
3097
3108
  editItem: {
3098
3109
  comment: {
3099
- comment: '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.',
3110
+ markdownText: '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.',
3100
3111
  example: "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}",
3101
3112
  },
3102
3113
  location: {
@@ -3110,12 +3121,12 @@ export var manifest = {
3110
3121
  {
3111
3122
  name: 'UploadDialogMethods',
3112
3123
  comment: {
3113
- comment: 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets',
3124
+ markdownText: 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets.',
3114
3125
  },
3115
3126
  items: {
3116
3127
  selectUpload: {
3117
3128
  comment: {
3118
- comment: '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.',
3129
+ markdownText: '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.',
3119
3130
  example: "const item = await ctx.selectUpload({ multiple: false });\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}",
3120
3131
  },
3121
3132
  location: {
@@ -3126,7 +3137,7 @@ export var manifest = {
3126
3137
  },
3127
3138
  editUpload: {
3128
3139
  comment: {
3129
- comment: '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',
3140
+ markdownText: '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.',
3130
3141
  example: "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}",
3131
3142
  },
3132
3143
  location: {
@@ -3137,7 +3148,7 @@ export var manifest = {
3137
3148
  },
3138
3149
  editUploadMetadata: {
3139
3150
  comment: {
3140
- comment: '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.',
3151
+ markdownText: '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.',
3141
3152
  example: "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}",
3142
3153
  },
3143
3154
  location: {
@@ -3151,12 +3162,12 @@ export var manifest = {
3151
3162
  {
3152
3163
  name: 'CustomDialogMethods',
3153
3164
  comment: {
3154
- comment: 'These methods can be used to open custom dialogs/confirmation panels',
3165
+ markdownText: 'These methods can be used to open custom dialogs/confirmation panels.',
3155
3166
  },
3156
3167
  items: {
3157
3168
  openModal: {
3158
3169
  comment: {
3159
- comment: 'Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function',
3170
+ markdownText: 'Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function.',
3160
3171
  example: "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}",
3161
3172
  },
3162
3173
  location: {
@@ -3167,7 +3178,7 @@ export var manifest = {
3167
3178
  },
3168
3179
  openConfirm: {
3169
3180
  comment: {
3170
- comment: 'Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user',
3181
+ markdownText: 'Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user.',
3171
3182
  example: "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}",
3172
3183
  },
3173
3184
  location: {
@@ -3181,12 +3192,12 @@ export var manifest = {
3181
3192
  {
3182
3193
  name: 'NavigateMethods',
3183
3194
  comment: {
3184
- comment: 'These methods can be used to take the user to different pages',
3195
+ markdownText: 'These methods can be used to take the user to different pages.',
3185
3196
  },
3186
3197
  items: {
3187
3198
  navigateTo: {
3188
3199
  comment: {
3189
- comment: 'Moves the user to another URL internal to the backend',
3200
+ markdownText: 'Moves the user to another URL internal to the backend.',
3190
3201
  example: "await ctx.navigateTo('/');",
3191
3202
  },
3192
3203
  location: {
@@ -3202,12 +3213,12 @@ export var manifest = {
3202
3213
  selfResizingPluginFrameCtxSizingUtilities: {
3203
3214
  name: 'SizingUtilities',
3204
3215
  comment: {
3205
- comment: 'A number of methods that you can use to control the size of the plugin frame',
3216
+ markdownText: 'A number of methods that you can use to control the size of the plugin frame.',
3206
3217
  },
3207
3218
  items: {
3208
3219
  startAutoResizer: {
3209
3220
  comment: {
3210
- comment: "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.",
3221
+ markdownText: "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.",
3211
3222
  },
3212
3223
  location: {
3213
3224
  filePath: 'src/ctx/commonExtras/sizing.ts',
@@ -3217,7 +3228,7 @@ export var manifest = {
3217
3228
  },
3218
3229
  stopAutoResizer: {
3219
3230
  comment: {
3220
- comment: 'Stops resizing the iframe automatically',
3231
+ markdownText: 'Stops resizing the iframe automatically.',
3221
3232
  },
3222
3233
  location: {
3223
3234
  filePath: 'src/ctx/commonExtras/sizing.ts',
@@ -3227,7 +3238,7 @@ export var manifest = {
3227
3238
  },
3228
3239
  updateHeight: {
3229
3240
  comment: {
3230
- comment: "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",
3241
+ markdownText: "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.",
3231
3242
  },
3232
3243
  location: {
3233
3244
  filePath: 'src/ctx/commonExtras/sizing.ts',