datocms-plugin-sdk 0.3.1 → 0.3.2

package/types.json

@@ -2060,7 +2060,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 766,
+					"line": 795,
 					"character": 12
 				}
 			],
@@ -2082,7 +2082,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 817,
+									"line": 848,
 									"character": 2
 								}
 							],
@@ -2098,7 +2098,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const result = await sdk.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  if (result) {\n    sdk.notice(`Success! ${result}`);\n  } else {\n    sdk.alert('Cancelled!');\n  }\n"
+												"text": "\n  const result = await ctx.openConfirm({\n    title: 'Custom title',\n    content:\n      'Lorem Ipsum is simply dummy text of the printing and typesetting industry',\n    choices: [\n      {\n        label: 'Positive',\n        value: 'positive',\n        intent: 'positive',\n      },\n      {\n        label: 'Negative',\n        value: 'negative',\n        intent: 'negative',\n      },\n    ],\n    cancel: {\n      label: 'Cancel',\n      value: false,\n    },\n  });\n\n  if (result) {\n    ctx.notice(`Success! ${result}`);\n  } else {\n    ctx.alert('Cancelled!');\n  }\n"
 											}
 										]
 									},
@@ -2138,7 +2138,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 784,
+									"line": 814,
 									"character": 2
 								}
 							],
@@ -2154,7 +2154,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const result = await sdk.openModal({\n    id: 'regular',\n    title: 'Custom title!',\n    width: 'l',\n    parameters: { foo: 'bar' },\n  });\n  if (result) {\n    sdk.notice(`Success! ${JSON.stringify(result)}`);\n  } else {\n    sdk.alert('Closed!');\n  }\n"
+												"text": "\n  const result = await ctx.openModal({\n    id: 'regular',\n    title: 'Custom title!',\n    width: 'l',\n    parameters: { foo: 'bar' },\n  });\n\n  if (result) {\n    ctx.notice(`Success! ${JSON.stringify(result)}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
 											}
 										]
 									},
@@ -2199,7 +2199,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 766,
+							"line": 795,
 							"character": 34
 						}
 					]
@@ -4414,7 +4414,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 832,
+					"line": 863,
 					"character": 12
 				}
 			],
@@ -4436,7 +4436,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 834,
+									"line": 865,
 									"character": 2
 								}
 							],
@@ -4483,7 +4483,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 832,
+							"line": 863,
 							"character": 28
 						}
 					]
@@ -4715,7 +4715,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 603,
+					"line": 610,
 					"character": 12
 				}
 			],
@@ -4737,7 +4737,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 632,
+									"line": 645,
 									"character": 2
 								}
 							],
@@ -4752,7 +4752,7 @@
 									"sources": [
 										{
 											"fileName": "types.ts",
-											"line": 632,
+											"line": 645,
 											"character": 14
 										}
 									],
@@ -4768,7 +4768,7 @@
 												"tags": [
 													{
 														"tag": "example",
-														"text": "\n  const items = await ctx.selectItem('810907', { multiple: true });\n  if (items) {\n    ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
+														"text": "\n  const itemTypeId = prompt('Please insert a model ID:');\n\n  const items = await ctx.selectItem(itemTypeId, { multiple: true });\n\n  if (items) {\n    ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
 													}
 												]
 											},
@@ -4808,7 +4808,7 @@
 																	"sources": [
 																		{
 																			"fileName": "types.ts",
-																			"line": 633,
+																			"line": 646,
 																			"character": 36
 																		}
 																	],
@@ -4866,7 +4866,7 @@
 												"tags": [
 													{
 														"tag": "example",
-														"text": "\n  const items = await ctx.selectItem('810907', { multiple: true });\n  if (items) {\n    ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
+														"text": "\n  const itemTypeId = prompt('Please insert a model ID:');\n\n  const items = await ctx.selectItem(itemTypeId, { multiple: true });\n\n  if (items) {\n    ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
 													}
 												]
 											},
@@ -4908,7 +4908,7 @@
 																	"sources": [
 																		{
 																			"fileName": "types.ts",
-																			"line": 634,
+																			"line": 647,
 																			"character": 37
 																		}
 																	],
@@ -4965,7 +4965,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 617,
+									"line": 627,
 									"character": 2
 								}
 							],
@@ -4981,7 +4981,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const item = await sdk.createNewItem('810907');\n  if (item) {\n    sdk.notice(`Success! ${item.id}`);\n  } else {\n    sdk.alert('Closed!');\n  }\n"
+												"text": "\n  const itemTypeId = prompt('Please insert a model ID:');\n\n  const item = await ctx.createNewItem(itemTypeId);\n\n  if (item) {\n    ctx.notice(`Success! ${item.id}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
 											}
 										]
 									},
@@ -5030,7 +5030,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 650,
+									"line": 665,
 									"character": 2
 								}
 							],
@@ -5046,7 +5046,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const item = await sdk.editItem('50479504');\n\n  if (item) {\n    sdk.notice(`Success! ${item.id}`);\n  } else {\n    sdk.alert('Closed!');\n  }\n"
+												"text": "\n  const itemId = prompt('Please insert a record ID:');\n\n  const item = await ctx.editItem(itemId);\n\n  if (item) {\n    ctx.notice(`Success! ${item.id}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
 											}
 										]
 									},
@@ -5107,7 +5107,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 603,
+							"line": 610,
 							"character": 32
 						}
 					]
@@ -5126,7 +5126,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 871,
+					"line": 902,
 					"character": 12
 				}
 			],
@@ -5148,7 +5148,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 885,
+									"line": 925,
 									"character": 2
 								}
 							],
@@ -5164,7 +5164,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  sdk.disableField(sdk.fieldPath, true);\n"
+												"text": "\n  const fieldPath = prompt(\n    'Please insert the path of a field in the form',\n    ctx.fieldPath,\n  );\n  ctx.disableField(fieldPath, true);\n"
 											}
 										]
 									},
@@ -5208,7 +5208,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 907,
+									"line": 955,
 									"character": 2
 								}
 							],
@@ -5224,7 +5224,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  await sdk.saveCurrentItem();\n"
+												"text": "\n  await ctx.saveCurrentItem();\n"
 											}
 										]
 									},
@@ -5250,7 +5250,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 893,
+									"line": 937,
 									"character": 2
 								}
 							],
@@ -5266,7 +5266,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  sdk.scrollToField(sdk.fieldPath);\n"
+												"text": "\n  const fieldPath = prompt(\n    'Please insert the path of a field in the form',\n    ctx.fieldPath,\n  );\n  ctx.scrollToField(fieldPath);\n"
 											}
 										]
 									},
@@ -5312,7 +5312,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 900,
+									"line": 948,
 									"character": 2
 								}
 							],
@@ -5328,7 +5328,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  sdk.setFieldValue(sdk.fieldPath, 'new value');\n"
+												"text": "\n  const fieldPath = prompt(\n    'Please insert the path of a field in the form',\n    ctx.fieldPath,\n  );\n  ctx.setFieldValue(fieldPath, 'new value');\n"
 											}
 										]
 									},
@@ -5372,7 +5372,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 878,
+									"line": 914,
 									"character": 2
 								}
 							],
@@ -5388,7 +5388,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  sdk.toggleField(sdk.fieldPath, true);\n"
+												"text": "\n  const fieldPath = prompt(\n    'Please insert the path of a field in the form',\n    ctx.fieldPath,\n  );\n\n  ctx.toggleField(fieldPath, true);\n"
 											}
 										]
 									},
@@ -5440,7 +5440,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 871,
+							"line": 902,
 							"character": 40
 						}
 					]
@@ -5459,7 +5459,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 847,
+					"line": 878,
 					"character": 12
 				}
 			],
@@ -5484,7 +5484,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 855,
+									"line": 886,
 									"character": 2
 								}
 							],
@@ -5515,7 +5515,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 861,
+									"line": 892,
 									"character": 2
 								}
 							],
@@ -5536,7 +5536,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 859,
+									"line": 890,
 									"character": 2
 								}
 							],
@@ -5557,7 +5557,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 851,
+									"line": 882,
 									"character": 2
 								}
 							],
@@ -5588,7 +5588,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 857,
+									"line": 888,
 									"character": 2
 								}
 							],
@@ -5626,7 +5626,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 853,
+									"line": 884,
 									"character": 2
 								}
 							],
@@ -5648,7 +5648,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 849,
+									"line": 880,
 									"character": 2
 								}
 							],
@@ -5676,7 +5676,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 847,
+							"line": 878,
 							"character": 43
 						}
 					]
@@ -5692,7 +5692,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 910,
+					"line": 958,
 					"character": 12
 				}
 			],
@@ -5726,7 +5726,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 864,
+					"line": 895,
 					"character": 12
 				}
 			],
@@ -6030,7 +6030,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 555,
+					"line": 556,
 					"character": 12
 				}
 			],
@@ -6052,7 +6052,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 581,
+									"line": 586,
 									"character": 2
 								}
 							],
@@ -6068,7 +6068,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const fields = await sdk.loadFieldsUsingPlugin();\n  sdk.notice(\n    `Success! ${fields\n      .map((field) => field.attributes.api_key)\n      .join(', ')}`,\n  );\n"
+												"text": "\n  const fields = await ctx.loadFieldsUsingPlugin();\n\n  ctx.notice(\n    `Success! ${fields\n      .map((field) => field.attributes.api_key)\n      .join(', ')}`,\n  );\n"
 											}
 										]
 									},
@@ -6098,7 +6098,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 568,
+									"line": 572,
 									"character": 2
 								}
 							],
@@ -6114,7 +6114,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const fields = await sdk.loadItemTypeFields('810907');\n  sdk.notice(\n    `Success! ${fields\n      .map((field) => field.attributes.api_key)\n      .join(', ')}`,\n  );\n"
+												"text": "\n  const fieldId = prompt('Please insert a field ID:');\n\n  const fields = await ctx.loadItemTypeFields(fieldId);\n\n  ctx.notice(\n    `Success! ${fields\n      .map((field) => field.attributes.api_key)\n      .join(', ')}`,\n  );\n"
 											}
 										]
 									},
@@ -6157,7 +6157,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 599,
+									"line": 606,
 									"character": 2
 								}
 							],
@@ -6173,7 +6173,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const users = await sdk.loadSsoUsers();\n  sdk.notice(`Success! ${users.map((user) => i.id).join(', ')}`);\n"
+												"text": "\n  const users = await ctx.loadSsoUsers();\n\n  ctx.notice(`Success! ${users.map((user) => i.id).join(', ')}`);\n"
 											}
 										]
 									},
@@ -6203,7 +6203,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 590,
+									"line": 596,
 									"character": 2
 								}
 							],
@@ -6219,7 +6219,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const users = await sdk.loadUsers();\n  sdk.notice(`Success! ${users.map((user) => i.id).join(', ')}`);\n"
+												"text": "\n  const users = await ctx.loadUsers();\n\n  ctx.notice(`Success! ${users.map((user) => i.id).join(', ')}`);\n"
 											}
 										]
 									},
@@ -6256,7 +6256,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 555,
+							"line": 556,
 							"character": 30
 						}
 					]
@@ -7051,7 +7051,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 821,
+					"line": 852,
 					"character": 12
 				}
 			],
@@ -7073,7 +7073,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 828,
+									"line": 859,
 									"character": 2
 								}
 							],
@@ -7089,7 +7089,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  sdk.navigateTo('/');\n"
+												"text": "\n  ctx.navigateTo('/');\n"
 											}
 										]
 									},
@@ -7126,7 +7126,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 821,
+							"line": 852,
 							"character": 30
 						}
 					]
@@ -7142,7 +7142,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1095,
+					"line": 1151,
 					"character": 12
 				}
 			],
@@ -7164,7 +7164,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1096,
+									"line": 1152,
 									"character": 2
 								}
 							],
@@ -7202,7 +7202,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 1095,
+							"line": 1151,
 							"character": 38
 						}
 					]
@@ -7218,7 +7218,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1089,
+					"line": 1145,
 					"character": 12
 				}
 			],
@@ -7240,7 +7240,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1090,
+									"line": 1146,
 									"character": 2
 								}
 							],
@@ -7262,7 +7262,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 1089,
+							"line": 1145,
 							"character": 41
 						}
 					]
@@ -7297,7 +7297,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1099,
+					"line": 1155,
 					"character": 12
 				}
 			],
@@ -7326,7 +7326,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1093,
+					"line": 1149,
 					"character": 12
 				}
 			],
@@ -7355,7 +7355,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1101,
+					"line": 1157,
 					"character": 12
 				}
 			],
@@ -7633,7 +7633,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1078,
+					"line": 1134,
 					"character": 12
 				}
 			],
@@ -7655,7 +7655,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1079,
+									"line": 1135,
 									"character": 2
 								}
 							],
@@ -7693,7 +7693,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 1078,
+							"line": 1134,
 							"character": 50
 						}
 					]
@@ -7709,7 +7709,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1070,
+					"line": 1126,
 					"character": 12
 				}
 			],
@@ -7731,7 +7731,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1071,
+									"line": 1127,
 									"character": 2
 								}
 							],
@@ -7753,7 +7753,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 1070,
+							"line": 1126,
 							"character": 53
 						}
 					]
@@ -7798,7 +7798,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1082,
+					"line": 1138,
 					"character": 12
 				}
 			],
@@ -7832,7 +7832,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1074,
+					"line": 1130,
 					"character": 12
 				}
 			],
@@ -7861,7 +7861,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1086,
+					"line": 1142,
 					"character": 12
 				}
 			],
@@ -7890,7 +7890,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 967,
+					"line": 1015,
 					"character": 12
 				}
 			],
@@ -7912,7 +7912,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 968,
+									"line": 1016,
 									"character": 2
 								}
 							],
@@ -7950,7 +7950,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 967,
+							"line": 1015,
 							"character": 52
 						}
 					]
@@ -7969,7 +7969,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 943,
+					"line": 991,
 					"character": 12
 				}
 			],
@@ -7994,7 +7994,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 952,
+									"line": 1000,
 									"character": 2
 								}
 							],
@@ -8015,7 +8015,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 956,
+									"line": 1004,
 									"character": 2
 								}
 							],
@@ -8037,7 +8037,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 946,
+									"line": 994,
 									"character": 2
 								}
 							],
@@ -8058,7 +8058,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 954,
+									"line": 1002,
 									"character": 2
 								}
 							],
@@ -8076,7 +8076,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 944,
+									"line": 992,
 									"character": 2
 								}
 							],
@@ -8097,7 +8097,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 948,
+									"line": 996,
 									"character": 2
 								}
 							],
@@ -8128,7 +8128,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 961,
+									"line": 1009,
 									"character": 2
 								}
 							],
@@ -8159,7 +8159,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 950,
+									"line": 998,
 									"character": 2
 								}
 							],
@@ -8188,7 +8188,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 943,
+							"line": 991,
 							"character": 55
 						}
 					]
@@ -8233,7 +8233,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 971,
+					"line": 1019,
 					"character": 12
 				}
 			],
@@ -8262,7 +8262,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 964,
+					"line": 1012,
 					"character": 12
 				}
 			],
@@ -8291,7 +8291,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 974,
+					"line": 1022,
 					"character": 12
 				}
 			],
@@ -8352,7 +8352,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1052,
+					"line": 1108,
 					"character": 12
 				}
 			],
@@ -8374,7 +8374,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1053,
+									"line": 1109,
 									"character": 2
 								}
 							],
@@ -8408,7 +8408,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1060,
+									"line": 1116,
 									"character": 2
 								}
 							],
@@ -8478,7 +8478,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 1052,
+							"line": 1108,
 							"character": 70
 						}
 					]
@@ -8497,7 +8497,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1029,
+					"line": 1085,
 					"character": 12
 				}
 			],
@@ -8522,7 +8522,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1042,
+									"line": 1098,
 									"character": 2
 								}
 							],
@@ -8553,7 +8553,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1032,
+									"line": 1088,
 									"character": 2
 								}
 							],
@@ -8571,7 +8571,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1030,
+									"line": 1086,
 									"character": 2
 								}
 							],
@@ -8592,7 +8592,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1037,
+									"line": 1093,
 									"character": 2
 								}
 							],
@@ -8627,7 +8627,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 1029,
+							"line": 1085,
 							"character": 73
 						}
 					]
@@ -8672,7 +8672,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1063,
+					"line": 1119,
 					"character": 12
 				}
 			],
@@ -8706,7 +8706,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1045,
+					"line": 1101,
 					"character": 12
 				}
 			],
@@ -8735,7 +8735,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1067,
+					"line": 1123,
 					"character": 12
 				}
 			],
@@ -8764,7 +8764,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 837,
+					"line": 868,
 					"character": 12
 				}
 			],
@@ -8811,7 +8811,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 990,
+					"line": 1038,
 					"character": 12
 				}
 			],
@@ -8833,7 +8833,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 991,
+									"line": 1039,
 									"character": 2
 								}
 							],
@@ -8867,7 +8867,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 996,
+									"line": 1052,
 									"character": 2
 								}
 							],
@@ -8879,7 +8879,13 @@
 									"kindString": "Call signature",
 									"flags": {},
 									"comment": {
-										"shortText": "A function to be called by the plugin to close the modal. The `openModal`\ncall will be resolved with the passed return value"
+										"shortText": "A function to be called by the plugin to close the modal. The `openModal`\ncall will be resolved with the passed return value",
+										"tags": [
+											{
+												"tag": "example",
+												"text": "\n  const returnValue = prompt(\n    'Please specify the value to return to the caller:',\n    'success',\n  );\n\n  ctx.resolve(returnValue);\n"
+											}
+										]
 									},
 									"parameters": [
 										{
@@ -8915,7 +8921,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 990,
+							"line": 1038,
 							"character": 43
 						}
 					]
@@ -8934,7 +8940,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 978,
+					"line": 1026,
 					"character": 12
 				}
 			],
@@ -8959,7 +8965,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 981,
+									"line": 1029,
 									"character": 2
 								}
 							],
@@ -8977,7 +8983,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 979,
+									"line": 1027,
 									"character": 2
 								}
 							],
@@ -8998,7 +9004,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 983,
+									"line": 1031,
 									"character": 2
 								}
 							],
@@ -9032,7 +9038,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 978,
+							"line": 1026,
 							"character": 46
 						}
 					]
@@ -9077,7 +9083,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 999,
+					"line": 1055,
 					"character": 12
 				}
 			],
@@ -9111,7 +9117,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 986,
+					"line": 1034,
 					"character": 12
 				}
 			],
@@ -9140,7 +9146,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1003,
+					"line": 1059,
 					"character": 12
 				}
 			],
@@ -9169,7 +9175,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1016,
+					"line": 1072,
 					"character": 12
 				}
 			],
@@ -9191,7 +9197,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1017,
+									"line": 1073,
 									"character": 2
 								}
 							],
@@ -9229,7 +9235,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 1016,
+							"line": 1072,
 							"character": 42
 						}
 					]
@@ -9248,7 +9254,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1007,
+					"line": 1063,
 					"character": 12
 				}
 			],
@@ -9270,7 +9276,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1008,
+									"line": 1064,
 									"character": 2
 								}
 							],
@@ -9291,7 +9297,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 1010,
+									"line": 1066,
 									"character": 2
 								}
 							],
@@ -9314,7 +9320,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 1007,
+							"line": 1063,
 							"character": 45
 						}
 					]
@@ -9349,7 +9355,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1020,
+					"line": 1076,
 					"character": 12
 				}
 			],
@@ -9378,7 +9384,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1013,
+					"line": 1069,
 					"character": 12
 				}
 			],
@@ -9407,7 +9413,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 1022,
+					"line": 1078,
 					"character": 12
 				}
 			],
@@ -9465,7 +9471,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 936,
+					"line": 984,
 					"character": 12
 				}
 			],
@@ -9494,7 +9500,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 929,
+					"line": 977,
 					"character": 12
 				}
 			],
@@ -9516,7 +9522,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 930,
+									"line": 978,
 									"character": 2
 								}
 							],
@@ -9554,7 +9560,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 929,
+							"line": 977,
 							"character": 50
 						}
 					]
@@ -9573,7 +9579,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 915,
+					"line": 963,
 					"character": 12
 				}
 			],
@@ -9595,7 +9601,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 916,
+									"line": 964,
 									"character": 2
 								}
 							],
@@ -9616,7 +9622,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 923,
+									"line": 971,
 									"character": 2
 								}
 							],
@@ -9647,7 +9653,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 918,
+									"line": 966,
 									"character": 2
 								}
 							],
@@ -9671,7 +9677,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 915,
+							"line": 963,
 							"character": 53
 						}
 					]
@@ -9687,7 +9693,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 933,
+					"line": 981,
 					"character": 12
 				}
 			],
@@ -9716,7 +9722,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 926,
+					"line": 974,
 					"character": 12
 				}
 			],
@@ -10642,7 +10648,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 654,
+					"line": 669,
 					"character": 12
 				}
 			],
@@ -10664,7 +10670,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 661,
+									"line": 681,
 									"character": 2
 								}
 							],
@@ -10680,7 +10686,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  sdk.alert('Alert!');\n"
+												"text": "\n  const message = prompt(\n    'Please insert a message:',\n    'This is an alert message!',\n  );\n\n  ctx.alert(message);\n"
 											}
 										]
 									},
@@ -10713,7 +10719,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 688,
+									"line": 713,
 									"character": 2
 								}
 							],
@@ -10729,7 +10735,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const result = await sdk.customToast({\n    type: 'warning',\n    message: 'Just a sample warning notification!',\n    dismissOnPageChange: true,\n    dismissAfterTimeout: 22000,\n    cta: {\n      label: 'Execute call-to-action',\n      value: 'cta',\n    },\n  });\n\n  if (result === 'cta') {\n    sdk.notice(`Clicked CTA!`);\n  }\n"
+												"text": "\n  const result = await ctx.customToast({\n    type: 'warning',\n    message: 'Just a sample warning notification!',\n    dismissOnPageChange: true,\n    dismissAfterTimeout: 5000,\n    cta: {\n      label: 'Execute call-to-action',\n      value: 'cta',\n    },\n  });\n\n  if (result === 'cta') {\n    ctx.notice(`Clicked CTA!`);\n  }\n"
 											}
 										]
 									},
@@ -10799,7 +10805,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 668,
+									"line": 693,
 									"character": 2
 								}
 							],
@@ -10815,7 +10821,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  sdk.notice('Notice!');\n"
+												"text": "\n  const message = prompt(\n    'Please insert a message:',\n    'This is a notice message!',\n  );\n\n  ctx.notice(message);\n"
 											}
 										]
 									},
@@ -10854,7 +10860,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 654,
+							"line": 669,
 							"character": 27
 						}
 					]
@@ -10895,7 +10901,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 545,
+									"line": 546,
 									"character": 2
 								}
 							],
@@ -10912,7 +10918,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const fieldId = 234;\n  ctx.updateFieldAppearance(234, [\n    {\n      operation: 'updateEditor',\n      newFieldExtensionParameters: { foo: 'bar' },\n    },\n    {\n      operation: 'updateAddon',\n      index: 2,\n      newFieldExtensionParameters: { bar: 'qux' },\n    },\n  ]);\n"
+												"text": "\n  const fieldId = prompt('Please insert a field ID:');\n\n  ctx.updateFieldAppearance(fieldId, [\n    {\n      operation: 'updateEditor',\n      newFieldExtensionParameters: { foo: 'bar' },\n    },\n    {\n      operation: 'updateAddon',\n      index: 2,\n      newFieldExtensionParameters: { bar: 'qux' },\n    },\n  ]);\n"
 											}
 										]
 									},
@@ -11056,7 +11062,7 @@
 			"sources": [
 				{
 					"fileName": "types.ts",
-					"line": 697,
+					"line": 722,
 					"character": 12
 				}
 			],
@@ -11078,7 +11084,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 712,
+									"line": 737,
 									"character": 2
 								}
 							],
@@ -11093,7 +11099,7 @@
 									"sources": [
 										{
 											"fileName": "types.ts",
-											"line": 712,
+											"line": 737,
 											"character": 16
 										}
 									],
@@ -11109,7 +11115,7 @@
 												"tags": [
 													{
 														"tag": "example",
-														"text": "\n  const item = await sdk.selectUpload({ multiple: false });\n\n  if (item) {\n    sdk.notice(`Success! ${item.id}`);\n  } else {\n    sdk.alert('Closed!');\n  }\n"
+														"text": "\n  const item = await ctx.selectUpload({ multiple: false });\n\n  if (item) {\n    ctx.notice(`Success! ${item.id}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
 													}
 												]
 											},
@@ -11138,7 +11144,7 @@
 																	"sources": [
 																		{
 																			"fileName": "types.ts",
-																			"line": 713,
+																			"line": 738,
 																			"character": 16
 																		}
 																	],
@@ -11196,7 +11202,7 @@
 												"tags": [
 													{
 														"tag": "example",
-														"text": "\n  const item = await sdk.selectUpload({ multiple: false });\n\n  if (item) {\n    sdk.notice(`Success! ${item.id}`);\n  } else {\n    sdk.alert('Closed!');\n  }\n"
+														"text": "\n  const item = await ctx.selectUpload({ multiple: false });\n\n  if (item) {\n    ctx.notice(`Success! ${item.id}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
 													}
 												]
 											},
@@ -11227,7 +11233,7 @@
 																	"sources": [
 																		{
 																			"fileName": "types.ts",
-																			"line": 714,
+																			"line": 739,
 																			"character": 17
 																		}
 																	],
@@ -11284,7 +11290,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 734,
+									"line": 761,
 									"character": 2
 								}
 							],
@@ -11301,7 +11307,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const item = await sdk.editUpload('21717537');\n\n  if (item) {\n    sdk.notice(`Success! ${item.id}`);\n  } else {\n    sdk.alert('Closed!');\n  }\n"
+												"text": "\n  const uploadId = prompt('Please insert an asset ID:');\n\n  const item = await ctx.editUpload(uploadId);\n\n  if (item) {\n    ctx.notice(`Success! ${item.id}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
 											}
 										]
 									},
@@ -11356,7 +11362,7 @@
 																			"sources": [
 																				{
 																					"fileName": "types.ts",
-																					"line": 736,
+																					"line": 763,
 																					"character": 27
 																				}
 																			],
@@ -11396,7 +11402,7 @@
 							"sources": [
 								{
 									"fileName": "types.ts",
-									"line": 757,
+									"line": 786,
 									"character": 2
 								}
 							],
@@ -11412,7 +11418,7 @@
 										"tags": [
 											{
 												"tag": "example",
-												"text": "\n  const result = await sdk.editUploadMetadata({\n    upload_id: '21717537',\n    alt: null,\n    title: null,\n    custom_data: {},\n    focal_point: null,\n  });\n\n  if (result) {\n    sdk.notice(`Success! ${JSON.stringify(result)}`);\n  } else {\n    sdk.alert('Closed!');\n  }\n"
+												"text": "\n  const uploadId = prompt('Please insert an asset ID:');\n\n  const result = await ctx.editUploadMetadata({\n    upload_id: uploadId,\n    alt: null,\n    title: null,\n    custom_data: {},\n    focal_point: null,\n  });\n\n  if (result) {\n    ctx.notice(`Success! ${JSON.stringify(result)}`);\n  } else {\n    ctx.alert('Closed!');\n  }\n"
 											}
 										]
 									},
@@ -11487,7 +11493,7 @@
 					"sources": [
 						{
 							"fileName": "types.ts",
-							"line": 697,
+							"line": 722,
 							"character": 34
 						}
 					]