@picteus/extension-sdk 0.18.0 → 0.20.0

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 (281) hide show
  1. package/dist/generated/backEndIntents.d.ts +216 -0
  2. package/dist/generated/backEndIntents.js +12 -0
  3. package/dist/generated/frontEndIntents.d.ts +1112 -0
  4. package/dist/generated/frontEndIntents.js +97 -0
  5. package/dist/generated/intentValidator.d.ts +49 -0
  6. package/dist/generated/intentValidator.js +363 -0
  7. package/dist/generated/viewKit.d.ts +1728 -378
  8. package/dist/generated/viewKit.js +1024 -300
  9. package/dist/index.d.ts +3 -2
  10. package/dist/index.js +3 -2
  11. package/dist/picteus-ws-client/apis/AdministrationApi.d.ts +1 -1
  12. package/dist/picteus-ws-client/apis/AdministrationApi.js +1 -1
  13. package/dist/picteus-ws-client/apis/ApiSecretApi.d.ts +1 -1
  14. package/dist/picteus-ws-client/apis/ApiSecretApi.js +1 -1
  15. package/dist/picteus-ws-client/apis/CollectionApi.d.ts +1 -1
  16. package/dist/picteus-ws-client/apis/CollectionApi.js +1 -1
  17. package/dist/picteus-ws-client/apis/ExtensionApi.d.ts +166 -2
  18. package/dist/picteus-ws-client/apis/ExtensionApi.js +199 -2
  19. package/dist/picteus-ws-client/apis/ImageApi.d.ts +25 -1
  20. package/dist/picteus-ws-client/apis/ImageApi.js +25 -1
  21. package/dist/picteus-ws-client/apis/ImageAttachmentApi.d.ts +1 -1
  22. package/dist/picteus-ws-client/apis/ImageAttachmentApi.js +1 -1
  23. package/dist/picteus-ws-client/apis/MiscellaneousApi.d.ts +1 -1
  24. package/dist/picteus-ws-client/apis/MiscellaneousApi.js +1 -1
  25. package/dist/picteus-ws-client/apis/RepositoryApi.d.ts +1 -1
  26. package/dist/picteus-ws-client/apis/RepositoryApi.js +1 -1
  27. package/dist/picteus-ws-client/apis/SettingsApi.d.ts +1 -1
  28. package/dist/picteus-ws-client/apis/SettingsApi.js +1 -1
  29. package/dist/picteus-ws-client/models/AiModel.d.ts +44 -0
  30. package/dist/picteus-ws-client/models/AiModel.js +49 -0
  31. package/dist/picteus-ws-client/models/ApiSecret.d.ts +1 -1
  32. package/dist/picteus-ws-client/models/ApiSecret.js +1 -1
  33. package/dist/picteus-ws-client/models/ApiSecretSummary.d.ts +1 -1
  34. package/dist/picteus-ws-client/models/ApiSecretSummary.js +1 -1
  35. package/dist/picteus-ws-client/models/ApiSecretType.d.ts +1 -1
  36. package/dist/picteus-ws-client/models/ApiSecretType.js +1 -1
  37. package/dist/picteus-ws-client/models/ApplicationConfiguration.d.ts +1 -1
  38. package/dist/picteus-ws-client/models/ApplicationConfiguration.js +1 -1
  39. package/dist/picteus-ws-client/models/ApplicationMetadata.d.ts +1 -1
  40. package/dist/picteus-ws-client/models/ApplicationMetadata.js +1 -1
  41. package/dist/picteus-ws-client/models/ApplicationMetadataItem.d.ts +1 -1
  42. package/dist/picteus-ws-client/models/ApplicationMetadataItem.js +1 -1
  43. package/dist/picteus-ws-client/models/ApplicationMetadataItemValue.d.ts +1 -1
  44. package/dist/picteus-ws-client/models/ApplicationMetadataItemValue.js +1 -1
  45. package/dist/picteus-ws-client/models/ApplicationSettings.d.ts +1 -1
  46. package/dist/picteus-ws-client/models/ApplicationSettings.js +1 -1
  47. package/dist/picteus-ws-client/models/CaptionInstruction.d.ts +50 -0
  48. package/dist/picteus-ws-client/models/CaptionInstruction.js +55 -0
  49. package/dist/picteus-ws-client/models/Collection.d.ts +1 -1
  50. package/dist/picteus-ws-client/models/Collection.js +1 -1
  51. package/dist/picteus-ws-client/models/CommandEntity.d.ts +1 -1
  52. package/dist/picteus-ws-client/models/CommandEntity.js +1 -1
  53. package/dist/picteus-ws-client/models/ComputedImageFormat.d.ts +1 -1
  54. package/dist/picteus-ws-client/models/ComputedImageFormat.js +1 -1
  55. package/dist/picteus-ws-client/models/ConfigurationCapability.d.ts +1 -1
  56. package/dist/picteus-ws-client/models/ConfigurationCapability.js +1 -1
  57. package/dist/picteus-ws-client/models/ConfigurationExtensionCommand.d.ts +1 -1
  58. package/dist/picteus-ws-client/models/ConfigurationExtensionCommand.js +1 -1
  59. package/dist/picteus-ws-client/models/ConstantsRegistry.d.ts +15 -1
  60. package/dist/picteus-ws-client/models/ConstantsRegistry.js +11 -1
  61. package/dist/picteus-ws-client/models/Dates.d.ts +1 -1
  62. package/dist/picteus-ws-client/models/Dates.js +1 -1
  63. package/dist/picteus-ws-client/models/EligibleTagsInstruction.d.ts +56 -0
  64. package/dist/picteus-ws-client/models/EligibleTagsInstruction.js +59 -0
  65. package/dist/picteus-ws-client/models/Extension.d.ts +1 -1
  66. package/dist/picteus-ws-client/models/Extension.js +1 -1
  67. package/dist/picteus-ws-client/models/ExtensionActivity.d.ts +1 -1
  68. package/dist/picteus-ws-client/models/ExtensionActivity.js +1 -1
  69. package/dist/picteus-ws-client/models/ExtensionActivityState.d.ts +1 -1
  70. package/dist/picteus-ws-client/models/ExtensionActivityState.js +1 -1
  71. package/dist/picteus-ws-client/models/ExtensionAiModel.d.ts +56 -0
  72. package/dist/picteus-ws-client/models/ExtensionAiModel.js +57 -0
  73. package/dist/picteus-ws-client/models/ExtensionAndManual.d.ts +1 -1
  74. package/dist/picteus-ws-client/models/ExtensionAndManual.js +1 -1
  75. package/dist/picteus-ws-client/models/ExtensionCaption.d.ts +44 -0
  76. package/dist/picteus-ws-client/models/ExtensionCaption.js +51 -0
  77. package/dist/picteus-ws-client/models/ExtensionCategory.d.ts +1 -1
  78. package/dist/picteus-ws-client/models/ExtensionCategory.js +1 -1
  79. package/dist/picteus-ws-client/models/ExtensionEligibleTags.d.ts +44 -0
  80. package/dist/picteus-ws-client/models/ExtensionEligibleTags.js +51 -0
  81. package/dist/picteus-ws-client/models/ExtensionGenerationOptions.d.ts +1 -1
  82. package/dist/picteus-ws-client/models/ExtensionGenerationOptions.js +1 -1
  83. package/dist/picteus-ws-client/models/ExtensionIdImageEmbeddingName.d.ts +1 -1
  84. package/dist/picteus-ws-client/models/ExtensionIdImageEmbeddingName.js +1 -1
  85. package/dist/picteus-ws-client/models/ExtensionImageEmbeddings.d.ts +1 -1
  86. package/dist/picteus-ws-client/models/ExtensionImageEmbeddings.js +1 -1
  87. package/dist/picteus-ws-client/models/ExtensionImageFeature.d.ts +1 -1
  88. package/dist/picteus-ws-client/models/ExtensionImageFeature.js +1 -1
  89. package/dist/picteus-ws-client/models/ExtensionImageFeatureName.d.ts +1 -1
  90. package/dist/picteus-ws-client/models/ExtensionImageFeatureName.js +1 -1
  91. package/dist/picteus-ws-client/models/ExtensionImageFeaturesAttribute.d.ts +1 -1
  92. package/dist/picteus-ws-client/models/ExtensionImageFeaturesAttribute.js +1 -1
  93. package/dist/picteus-ws-client/models/ExtensionImageTag.d.ts +1 -1
  94. package/dist/picteus-ws-client/models/ExtensionImageTag.js +1 -1
  95. package/dist/picteus-ws-client/models/ExtensionImageTagsAttribute.d.ts +1 -1
  96. package/dist/picteus-ws-client/models/ExtensionImageTagsAttribute.js +1 -1
  97. package/dist/picteus-ws-client/models/ExtensionManual.d.ts +1 -1
  98. package/dist/picteus-ws-client/models/ExtensionManual.js +1 -1
  99. package/dist/picteus-ws-client/models/ExtensionSettings.d.ts +1 -1
  100. package/dist/picteus-ws-client/models/ExtensionSettings.js +1 -1
  101. package/dist/picteus-ws-client/models/ExtensionState.d.ts +1 -1
  102. package/dist/picteus-ws-client/models/ExtensionState.js +1 -1
  103. package/dist/picteus-ws-client/models/ExtensionsConfiguration.d.ts +1 -1
  104. package/dist/picteus-ws-client/models/ExtensionsConfiguration.js +1 -1
  105. package/dist/picteus-ws-client/models/GenerationRecipe.d.ts +2 -2
  106. package/dist/picteus-ws-client/models/GenerationRecipe.js +1 -1
  107. package/dist/picteus-ws-client/models/GenerationRecipePrompt.d.ts +1 -1
  108. package/dist/picteus-ws-client/models/GenerationRecipePrompt.js +1 -1
  109. package/dist/picteus-ws-client/models/GenerationRecipeVersion.d.ts +24 -0
  110. package/dist/picteus-ws-client/models/GenerationRecipeVersion.js +42 -0
  111. package/dist/picteus-ws-client/models/Image.d.ts +1 -1
  112. package/dist/picteus-ws-client/models/Image.js +1 -1
  113. package/dist/picteus-ws-client/models/ImageDimensions.d.ts +1 -1
  114. package/dist/picteus-ws-client/models/ImageDimensions.js +1 -1
  115. package/dist/picteus-ws-client/models/ImageDistance.d.ts +1 -1
  116. package/dist/picteus-ws-client/models/ImageDistance.js +1 -1
  117. package/dist/picteus-ws-client/models/ImageEmbedding.d.ts +1 -1
  118. package/dist/picteus-ws-client/models/ImageEmbedding.js +1 -1
  119. package/dist/picteus-ws-client/models/ImageFeature.d.ts +1 -1
  120. package/dist/picteus-ws-client/models/ImageFeature.js +1 -1
  121. package/dist/picteus-ws-client/models/ImageFeatureFormat.d.ts +1 -1
  122. package/dist/picteus-ws-client/models/ImageFeatureFormat.js +1 -1
  123. package/dist/picteus-ws-client/models/ImageFeatureNullValue.d.ts +1 -1
  124. package/dist/picteus-ws-client/models/ImageFeatureNullValue.js +1 -1
  125. package/dist/picteus-ws-client/models/ImageFeatureType.d.ts +1 -1
  126. package/dist/picteus-ws-client/models/ImageFeatureType.js +1 -1
  127. package/dist/picteus-ws-client/models/ImageFeatureValue.d.ts +1 -1
  128. package/dist/picteus-ws-client/models/ImageFeatureValue.js +1 -1
  129. package/dist/picteus-ws-client/models/ImageFormat.d.ts +1 -1
  130. package/dist/picteus-ws-client/models/ImageFormat.js +1 -1
  131. package/dist/picteus-ws-client/models/ImageMediaUrl.d.ts +1 -1
  132. package/dist/picteus-ws-client/models/ImageMediaUrl.js +1 -1
  133. package/dist/picteus-ws-client/models/ImageMetadata.d.ts +1 -1
  134. package/dist/picteus-ws-client/models/ImageMetadata.js +1 -1
  135. package/dist/picteus-ws-client/models/ImageResizeRender.d.ts +1 -1
  136. package/dist/picteus-ws-client/models/ImageResizeRender.js +1 -1
  137. package/dist/picteus-ws-client/models/ImageSummary.d.ts +1 -1
  138. package/dist/picteus-ws-client/models/ImageSummary.js +1 -1
  139. package/dist/picteus-ws-client/models/InstructionsPrompt.d.ts +1 -1
  140. package/dist/picteus-ws-client/models/InstructionsPrompt.js +1 -1
  141. package/dist/picteus-ws-client/models/Manifest.d.ts +1 -1
  142. package/dist/picteus-ws-client/models/Manifest.js +1 -1
  143. package/dist/picteus-ws-client/models/ManifestCapability.d.ts +1 -1
  144. package/dist/picteus-ws-client/models/ManifestCapability.js +1 -1
  145. package/dist/picteus-ws-client/models/ManifestCapabilityCaptionsDetails.d.ts +32 -0
  146. package/dist/picteus-ws-client/models/ManifestCapabilityCaptionsDetails.js +41 -0
  147. package/dist/picteus-ws-client/models/ManifestCapabilityEligibleTagsDetails.d.ts +32 -0
  148. package/dist/picteus-ws-client/models/ManifestCapabilityEligibleTagsDetails.js +41 -0
  149. package/dist/picteus-ws-client/models/ManifestCapabilityId.d.ts +1 -1
  150. package/dist/picteus-ws-client/models/ManifestCapabilityId.js +1 -1
  151. package/dist/picteus-ws-client/models/ManifestEvent.d.ts +1 -1
  152. package/dist/picteus-ws-client/models/ManifestEvent.js +1 -1
  153. package/dist/picteus-ws-client/models/ManifestExecution.d.ts +1 -1
  154. package/dist/picteus-ws-client/models/ManifestExecution.js +1 -1
  155. package/dist/picteus-ws-client/models/ManifestExtensionCommand.d.ts +1 -1
  156. package/dist/picteus-ws-client/models/ManifestExtensionCommand.js +1 -1
  157. package/dist/picteus-ws-client/models/ManifestExtensionCommandOn.d.ts +1 -1
  158. package/dist/picteus-ws-client/models/ManifestExtensionCommandOn.js +1 -1
  159. package/dist/picteus-ws-client/models/ManifestExtensionCommandSpecification.d.ts +1 -1
  160. package/dist/picteus-ws-client/models/ManifestExtensionCommandSpecification.js +1 -1
  161. package/dist/picteus-ws-client/models/ManifestExtensionCommandUi.d.ts +1 -1
  162. package/dist/picteus-ws-client/models/ManifestExtensionCommandUi.js +1 -1
  163. package/dist/picteus-ws-client/models/ManifestImageFeaturesCapability.d.ts +40 -0
  164. package/dist/picteus-ws-client/models/ManifestImageFeaturesCapability.js +47 -0
  165. package/dist/picteus-ws-client/models/ManifestImageTagsCapability.d.ts +40 -0
  166. package/dist/picteus-ws-client/models/ManifestImageTagsCapability.js +47 -0
  167. package/dist/picteus-ws-client/models/ManifestInstructions.d.ts +4 -4
  168. package/dist/picteus-ws-client/models/ManifestInstructions.js +4 -4
  169. package/dist/picteus-ws-client/models/ManifestInstructionsCapabilitiesInner.d.ts +32 -0
  170. package/dist/picteus-ws-client/models/ManifestInstructionsCapabilitiesInner.js +56 -0
  171. package/dist/picteus-ws-client/models/ManifestInterfaceElement.d.ts +1 -1
  172. package/dist/picteus-ws-client/models/ManifestInterfaceElement.js +1 -1
  173. package/dist/picteus-ws-client/models/ManifestInterfaceElementIntegration.d.ts +1 -1
  174. package/dist/picteus-ws-client/models/ManifestInterfaceElementIntegration.js +1 -1
  175. package/dist/picteus-ws-client/models/ManifestRuntime.d.ts +1 -1
  176. package/dist/picteus-ws-client/models/ManifestRuntime.js +1 -1
  177. package/dist/picteus-ws-client/models/ManifestRuntimeEnvironment.d.ts +1 -1
  178. package/dist/picteus-ws-client/models/ManifestRuntimeEnvironment.js +1 -1
  179. package/dist/picteus-ws-client/models/ManifestThrottlingPolicy.d.ts +1 -1
  180. package/dist/picteus-ws-client/models/ManifestThrottlingPolicy.js +1 -1
  181. package/dist/picteus-ws-client/models/ManifestUserInterface.d.ts +1 -1
  182. package/dist/picteus-ws-client/models/ManifestUserInterface.js +1 -1
  183. package/dist/picteus-ws-client/models/PromptKind.d.ts +1 -1
  184. package/dist/picteus-ws-client/models/PromptKind.js +1 -1
  185. package/dist/picteus-ws-client/models/Repository.d.ts +1 -1
  186. package/dist/picteus-ws-client/models/Repository.js +1 -1
  187. package/dist/picteus-ws-client/models/RepositoryActivity.d.ts +1 -1
  188. package/dist/picteus-ws-client/models/RepositoryActivity.js +1 -1
  189. package/dist/picteus-ws-client/models/RepositoryActivityKind.d.ts +1 -1
  190. package/dist/picteus-ws-client/models/RepositoryActivityKind.js +1 -1
  191. package/dist/picteus-ws-client/models/RepositoryLocationType.d.ts +1 -1
  192. package/dist/picteus-ws-client/models/RepositoryLocationType.js +1 -1
  193. package/dist/picteus-ws-client/models/RepositoryState.d.ts +1 -1
  194. package/dist/picteus-ws-client/models/RepositoryState.js +1 -1
  195. package/dist/picteus-ws-client/models/RunCommandParameters.d.ts +1 -1
  196. package/dist/picteus-ws-client/models/RunCommandParameters.js +1 -1
  197. package/dist/picteus-ws-client/models/SearchCriteria.d.ts +1 -1
  198. package/dist/picteus-ws-client/models/SearchCriteria.js +1 -1
  199. package/dist/picteus-ws-client/models/SearchFeatureComparisonOperator.d.ts +1 -1
  200. package/dist/picteus-ws-client/models/SearchFeatureComparisonOperator.js +1 -1
  201. package/dist/picteus-ws-client/models/SearchFeatureCondition.d.ts +1 -1
  202. package/dist/picteus-ws-client/models/SearchFeatureCondition.js +1 -1
  203. package/dist/picteus-ws-client/models/SearchFeatureConditionValue.d.ts +1 -1
  204. package/dist/picteus-ws-client/models/SearchFeatureConditionValue.js +1 -1
  205. package/dist/picteus-ws-client/models/SearchFeatureLogicalOperator.d.ts +1 -1
  206. package/dist/picteus-ws-client/models/SearchFeatureLogicalOperator.js +1 -1
  207. package/dist/picteus-ws-client/models/SearchFeatures.d.ts +1 -1
  208. package/dist/picteus-ws-client/models/SearchFeatures.js +1 -1
  209. package/dist/picteus-ws-client/models/SearchFeaturesResult.d.ts +1 -1
  210. package/dist/picteus-ws-client/models/SearchFeaturesResult.js +1 -1
  211. package/dist/picteus-ws-client/models/SearchFilter.d.ts +1 -1
  212. package/dist/picteus-ws-client/models/SearchFilter.js +1 -1
  213. package/dist/picteus-ws-client/models/SearchFilterOrigin.d.ts +1 -1
  214. package/dist/picteus-ws-client/models/SearchFilterOrigin.js +1 -1
  215. package/dist/picteus-ws-client/models/SearchImageIdResult.d.ts +1 -1
  216. package/dist/picteus-ws-client/models/SearchImageIdResult.js +1 -1
  217. package/dist/picteus-ws-client/models/SearchImageResult.d.ts +1 -1
  218. package/dist/picteus-ws-client/models/SearchImageResult.js +1 -1
  219. package/dist/picteus-ws-client/models/SearchImageSummaryResult.d.ts +1 -1
  220. package/dist/picteus-ws-client/models/SearchImageSummaryResult.js +1 -1
  221. package/dist/picteus-ws-client/models/SearchImagesOrigin.d.ts +1 -1
  222. package/dist/picteus-ws-client/models/SearchImagesOrigin.js +1 -1
  223. package/dist/picteus-ws-client/models/SearchKeyword.d.ts +1 -1
  224. package/dist/picteus-ws-client/models/SearchKeyword.js +1 -1
  225. package/dist/picteus-ws-client/models/SearchMediaUrlResult.d.ts +1 -1
  226. package/dist/picteus-ws-client/models/SearchMediaUrlResult.js +1 -1
  227. package/dist/picteus-ws-client/models/SearchOriginNature.d.ts +1 -1
  228. package/dist/picteus-ws-client/models/SearchOriginNature.js +1 -1
  229. package/dist/picteus-ws-client/models/SearchParameters.d.ts +1 -1
  230. package/dist/picteus-ws-client/models/SearchParameters.js +1 -1
  231. package/dist/picteus-ws-client/models/SearchProperties.d.ts +1 -1
  232. package/dist/picteus-ws-client/models/SearchProperties.js +1 -1
  233. package/dist/picteus-ws-client/models/SearchPropertyRange.d.ts +1 -1
  234. package/dist/picteus-ws-client/models/SearchPropertyRange.js +1 -1
  235. package/dist/picteus-ws-client/models/SearchRange.d.ts +1 -1
  236. package/dist/picteus-ws-client/models/SearchRange.js +1 -1
  237. package/dist/picteus-ws-client/models/SearchRepositoriesOrigin.d.ts +1 -1
  238. package/dist/picteus-ws-client/models/SearchRepositoriesOrigin.js +1 -1
  239. package/dist/picteus-ws-client/models/SearchSorting.d.ts +1 -1
  240. package/dist/picteus-ws-client/models/SearchSorting.js +1 -1
  241. package/dist/picteus-ws-client/models/SearchSortingProperty.d.ts +1 -1
  242. package/dist/picteus-ws-client/models/SearchSortingProperty.js +1 -1
  243. package/dist/picteus-ws-client/models/SearchTags.d.ts +1 -1
  244. package/dist/picteus-ws-client/models/SearchTags.js +1 -1
  245. package/dist/picteus-ws-client/models/SearchTagsResult.d.ts +1 -1
  246. package/dist/picteus-ws-client/models/SearchTagsResult.js +1 -1
  247. package/dist/picteus-ws-client/models/Software.d.ts +1 -1
  248. package/dist/picteus-ws-client/models/Software.js +1 -1
  249. package/dist/picteus-ws-client/models/TagsPlaceholder.d.ts +24 -0
  250. package/dist/picteus-ws-client/models/TagsPlaceholder.js +42 -0
  251. package/dist/picteus-ws-client/models/TextualPrompt.d.ts +1 -1
  252. package/dist/picteus-ws-client/models/TextualPrompt.js +1 -1
  253. package/dist/picteus-ws-client/models/UserInterfaceAnchor.d.ts +1 -1
  254. package/dist/picteus-ws-client/models/UserInterfaceAnchor.js +1 -1
  255. package/dist/picteus-ws-client/models/UserInterfaceSidebarIntegration.d.ts +1 -1
  256. package/dist/picteus-ws-client/models/UserInterfaceSidebarIntegration.js +1 -1
  257. package/dist/picteus-ws-client/models/UserInterfaceWindowIntegration.d.ts +1 -1
  258. package/dist/picteus-ws-client/models/UserInterfaceWindowIntegration.js +1 -1
  259. package/dist/picteus-ws-client/models/index.d.ts +11 -0
  260. package/dist/picteus-ws-client/models/index.js +11 -0
  261. package/dist/picteus-ws-client/runtime.d.ts +1 -1
  262. package/dist/picteus-ws-client/runtime.js +1 -1
  263. package/dist/picteusExtension.d.ts +27 -5
  264. package/dist/picteusExtension.js +62 -27
  265. package/package.json +4 -6
  266. package/dist/featureViewGrammar.d.ts +0 -2814
  267. package/dist/featureViewGrammar.js +0 -2612
  268. package/dist/generated/featureViewGrammar.d.ts +0 -3913
  269. package/dist/generated/featureViewGrammar.js +0 -4099
  270. package/dist/intents.d.ts +0 -188
  271. package/dist/intents.js +0 -26
  272. package/dist/picteus-ws-client/models/ExtensionActivityKind.d.ts +0 -26
  273. package/dist/picteus-ws-client/models/ExtensionActivityKind.js +0 -44
  274. package/dist/picteus-ws-client/models/ExtensionStatus.d.ts +0 -25
  275. package/dist/picteus-ws-client/models/ExtensionStatus.js +0 -43
  276. package/dist/picteus-ws-client/models/ImageEmbeddings.d.ts +0 -32
  277. package/dist/picteus-ws-client/models/ImageEmbeddings.js +0 -43
  278. package/dist/picteus-ws-client/models/RepositoryStatus.d.ts +0 -27
  279. package/dist/picteus-ws-client/models/RepositoryStatus.js +0 -45
  280. package/dist/picteus-ws-client/models/Settings.d.ts +0 -32
  281. package/dist/picteus-ws-client/models/Settings.js +0 -41
@@ -15,95 +15,163 @@ export declare abstract class ViewKitNode<T = unknown> {
15
15
  }
16
16
  /** Typographic stroke weight styling. */
17
17
  export declare enum TextWeight {
18
+ /** Thin / light text weight */
18
19
  thin = "thin",
20
+ /** Standard text weight */
19
21
  normal = "normal",
22
+ /** Heavy / bold text weight */
20
23
  heavy = "heavy"
21
24
  }
22
25
  /** Visual text color intensity and contrast. */
23
26
  export declare enum TextIntensity {
27
+ /** Low visual contrast / subdued text color */
24
28
  low = "low",
29
+ /** Standard text color */
25
30
  medium = "medium",
31
+ /** High visual contrast / intense text color */
26
32
  high = "high"
27
33
  }
28
34
  /** Geometric shape representation for visual containers and indicators. */
29
35
  export declare enum Shape {
36
+ /** Circular container shape */
30
37
  circle = "circle",
38
+ /** Square container shape */
31
39
  square = "square"
32
40
  }
33
41
  /** Relative sizing scale for visual elements and indicators. */
34
42
  export declare enum Size {
43
+ /** Compact small size */
35
44
  small = "small",
45
+ /** Standard medium size */
36
46
  medium = "medium",
47
+ /** Prominent large size */
37
48
  large = "large"
38
49
  }
50
+ /** Measurement unit for text truncation. */
51
+ export declare enum TruncateMode {
52
+ /** Truncate by total character count */
53
+ characters = "characters",
54
+ /** Truncate by number of rendered lines */
55
+ lines = "lines"
56
+ }
39
57
  /** Visual presentation style for string values. */
40
58
  export declare enum StringRepresentation {
59
+ /** Standard inline text rendering */
41
60
  plain = "plain",
61
+ /** Visual chip / tag pill representation */
42
62
  chip = "chip",
63
+ /** Multiline text with preserved whitespace and line breaks */
43
64
  multiline = "multiline"
44
65
  }
45
66
  /** Visual separator rendered between sequential elements or items. */
46
67
  export declare enum Separator {
68
+ /** Vertical dividing bar */
47
69
  bar = "bar",
70
+ /** Comma separator */
48
71
  comma = "comma",
72
+ /** Bullet dot separator */
49
73
  dot = "dot",
74
+ /** Forward slash separator */
50
75
  slash = "slash",
76
+ /** Dash separator */
51
77
  dash = "dash",
78
+ /** Space separator */
52
79
  space = "space"
53
80
  }
54
81
  /** Supported syntax highlighting languages for formatted code blocks. */
55
82
  export declare enum CodeLanguage {
83
+ /** XML markup syntax */
56
84
  xml = "xml",
85
+ /** JSON format syntax */
57
86
  json = "json",
87
+ /** YAML format syntax */
58
88
  yaml = "yaml"
59
89
  }
60
90
  /** Visual presentation style for boolean values. */
61
91
  export declare enum BooleanRepresentation {
92
+ /** Standard inline text rendering (e.g. "true" / "false" or custom labels) */
62
93
  plain = "plain",
94
+ /** Visual badge pill representation */
63
95
  badge = "badge"
64
96
  }
65
97
  /** Visual color tone variants for badge pill representations. */
66
98
  export declare enum BadgeVariant {
99
+ /** Neutral gray tone */
67
100
  neutral = "neutral",
101
+ /** Success green tone */
68
102
  success = "success",
103
+ /** Warning yellow/orange tone */
69
104
  warning = "warning",
105
+ /** Danger red tone */
70
106
  danger = "danger"
71
107
  }
72
108
  /** Presentation format styles for timestamp elements. */
73
109
  export declare enum TimestampFormat {
110
+ /** Complete date and time display */
74
111
  datetime = "datetime",
112
+ /** Date-only display */
75
113
  date = "date",
114
+ /** Time-only display */
76
115
  time = "time",
116
+ /** Relative time expression (e.g. "5 minutes ago") */
77
117
  relative = "relative"
78
118
  }
79
119
  /** Visual style variants for interactive button actions. */
80
120
  export declare enum ButtonVariant {
121
+ /** Primary emphasis button style for default/recommended actions */
81
122
  primary = "primary",
123
+ /** Secondary standard button style */
82
124
  secondary = "secondary",
125
+ /** Subtle low-contrast button style */
83
126
  subtle = "subtle",
127
+ /** Destructive / dangerous action button style */
84
128
  danger = "danger"
85
129
  }
86
- /** Text horizontal alignment options for table columns. */
130
+ /**
131
+ * Text horizontal alignment options for table columns.
132
+ *
133
+ * @remarks
134
+ * Horizontal alignment applied within cells of a TableColumn. The alignment is a presentation choice and does not affect the stored cell values.
135
+ */
87
136
  export declare enum TableColumnAlign {
137
+ /** Left-aligned text */
88
138
  left = "left",
139
+ /** Center-aligned text */
89
140
  center = "center",
141
+ /** Right-aligned text */
90
142
  right = "right"
91
143
  }
92
- /** Width mode for table columns. */
144
+ /**
145
+ * Width mode for table columns.
146
+ *
147
+ * @remarks
148
+ * Controls how an optional TableColumn width is interpreted by the table renderer.
149
+ */
93
150
  export declare enum TableColumnWidthMode {
151
+ /** Fixed width constraint */
94
152
  fixed = "fixed",
153
+ /** Maximum width upper bound constraint */
95
154
  maximum = "maximum"
96
155
  }
97
- /** Visual styling variants for hairline dividers. */
156
+ /**
157
+ * Visual styling variants for hairline dividers.
158
+ *
159
+ * @remarks
160
+ * Selects the visual stroke treatment used by DividerElement.
161
+ */
98
162
  export declare enum DividerStyle {
163
+ /** Subtle thin hairline border */
99
164
  hairline = "hairline",
165
+ /** Solid standard divider line */
100
166
  solid = "solid",
167
+ /** Dashed separator line */
101
168
  dashed = "dashed"
102
169
  }
103
170
  /**
104
- * Polymorphic root base model for all visual UI elements in Picteus feature views.
105
- * Uses the @discriminator("type") decorator so all child models inheriting from UiElement
106
- * are automatically recognized by schema emitters and SDK code generators.
171
+ * Polymorphic root model for visual UI elements.
172
+ *
173
+ * @remarks
174
+ * Every concrete visual element carries a type discriminator whose literal value selects its model and renderer. The @discriminator("type") metadata lets schema emitters and SDK generators represent derived models as a polymorphic hierarchy. Consumers should dispatch on the discriminator and preserve unknown elements when round-tripping data where possible.
107
175
  */
108
176
  export interface UiElementBase {
109
177
  /** The polymorphic discriminator type tag. */
@@ -113,11 +181,21 @@ export interface UiElementBase {
113
181
  export declare abstract class BaseUiElement<T = UiElement> extends ViewKitNode<T> implements UiElementBase {
114
182
  abstract readonly type: string;
115
183
  }
116
- /** Polymorphic base model for interactive actions. */
184
+ /**
185
+ * Polymorphic base model for interactive actions.
186
+ *
187
+ * @remarks
188
+ * Shared action contract for user-invokable card controls. Concrete action models provide their own discriminator and action-specific destination or command fields.
189
+ */
117
190
  export interface UiActionBase {
118
191
  /** The polymorphic discriminator type tag. */
119
192
  readonly type: string;
120
- /** Display label for the action */
193
+ /**
194
+ * Display label for the action
195
+ *
196
+ * @remarks
197
+ * User-facing label shown on the control. Keep it short and action-oriented.
198
+ */
121
199
  readonly label: string;
122
200
  }
123
201
  /** Abstract base class for all `UiAction` models. */
@@ -125,48 +203,101 @@ export declare abstract class BaseUiAction<T = UiAction> extends ViewKitNode<T>
125
203
  abstract readonly type: string;
126
204
  abstract readonly label: string;
127
205
  }
128
- /** Truncation configuration for long textual content with optional expand affordance. */
206
+ /**
207
+ * Truncation configuration for long textual content with optional expand affordance.
208
+ *
209
+ * @remarks
210
+ * Controls how a renderer abbreviates long text. When mode is characters, limit represents maximum character count; when mode is lines, limit represents visual line count.
211
+ */
129
212
  export interface TruncateOptions {
130
- /** Maximum number of characters to display before truncating */
131
- readonly characterLimit: number;
213
+ /**
214
+ * Maximum threshold limit before truncating
215
+ *
216
+ * @remarks
217
+ * Threshold after which the renderer can shorten the displayed text. When mode is characters, this represents character count; when mode is lines, this represents visual line count.
218
+ */
219
+ readonly limit: number;
220
+ /**
221
+ * Truncation measurement mode (characters or lines)
222
+ *
223
+ * @remarks
224
+ * Whether limit represents character count or line count. Defaults to lines.
225
+ *
226
+ * @defaultValue TruncateMode.lines
227
+ */
228
+ readonly mode?: TruncateMode;
132
229
  /**
133
230
  * Whether to render a "Show more" / "Show less" toggle affordance
134
231
  *
232
+ * @remarks
233
+ * When true, permits an expand/collapse control for text beyond the truncation threshold. Defaults to true.
234
+ *
135
235
  * @defaultValue true
136
236
  */
137
237
  readonly showMore?: boolean;
138
238
  }
139
- /** Base modifier traits for elements that support copy affordance. */
239
+ /**
240
+ * Base modifier traits for elements that support copy affordance.
241
+ *
242
+ * @remarks
243
+ * Common optional presentation traits shared by primitive values and content renderers. Modifiers affect how content is displayed or copied; they do not transform the source value.
244
+ */
140
245
  export interface BaseModifiers {
141
- /** Adds an interactive copy button/action next to the rendered value */
246
+ /**
247
+ * Adds an interactive copy button/action next to the rendered value
248
+ *
249
+ * @remarks
250
+ * When true, exposes a copy affordance for the associated value where supported by the renderer.
251
+ */
142
252
  readonly copyable?: boolean;
143
253
  }
144
- /** Common modifier traits that can be attached to primitive elements. */
254
+ /**
255
+ * Common modifier traits that can be attached to primitive elements.
256
+ *
257
+ * @remarks
258
+ * Extends BaseModifiers with text styling controls. Defaults provide normal weight, medium intensity, and proportional text unless a feature explicitly overrides them.
259
+ */
145
260
  export interface PrimitiveModifiers extends BaseModifiers {
146
- /** Configures character truncation threshold with show-more affordance */
261
+ /**
262
+ * Configures truncation threshold with show-more affordance
263
+ *
264
+ * @remarks
265
+ * Optional text abbreviation behavior. The source text remains unchanged, and the renderer may offer expansion according to showMore.
266
+ */
147
267
  readonly truncate?: TruncateOptions;
148
268
  /**
149
269
  * Typographic text weight
150
270
  *
271
+ * @remarks
272
+ * Relative font weight for textual rendering; defaults to normal.
273
+ *
151
274
  * @defaultValue TextWeight.normal
152
275
  */
153
276
  readonly weight?: TextWeight;
154
277
  /**
155
278
  * Visual text color intensity
156
279
  *
280
+ * @remarks
281
+ * Relative contrast treatment for the text; defaults to medium.
282
+ *
157
283
  * @defaultValue TextIntensity.medium
158
284
  */
159
285
  readonly intensity?: TextIntensity;
160
286
  /**
161
287
  * Whether to use monospace font rendering (for hashes, IDs, codes)
162
288
  *
289
+ * @remarks
290
+ * When true, requests a fixed-width font suitable for identifiers and code-like values. Defaults to false.
291
+ *
163
292
  * @defaultValue false
164
293
  */
165
294
  readonly monospace?: boolean;
166
295
  }
167
296
  /**
168
- * Universal textual string primitive element.
169
- * Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
297
+ * Text value primitive with selectable inline, chip, or multiline presentation.
298
+ *
299
+ * @remarks
300
+ * Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
170
301
  */
171
302
  export interface StringElement extends UiElementBase {
172
303
  /**
@@ -175,11 +306,19 @@ export interface StringElement extends UiElementBase {
175
306
  * @defaultValue "string"
176
307
  */
177
308
  readonly type: "string";
178
- /** Text value */
309
+ /**
310
+ * Text value
311
+ *
312
+ * @remarks
313
+ * Text to render. Supply plain text; this field is not a Markdown or HTML document.
314
+ */
179
315
  readonly value: string;
180
316
  /**
181
317
  * Display representation mode
182
318
  *
319
+ * @remarks
320
+ * Selects inline, chip, or multiline rendering. The default is plain, so callers can omit this for ordinary text.
321
+ *
183
322
  * @defaultValue StringRepresentation.plain
184
323
  */
185
324
  readonly representation?: StringRepresentation;
@@ -187,8 +326,10 @@ export interface StringElement extends UiElementBase {
187
326
  readonly modifiers?: PrimitiveModifiers;
188
327
  }
189
328
  /**
190
- * Collection of textual string values rendered as a sequence of inline items or chips.
191
- * Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
329
+ * Collection of textual values rendered as an inline sequence or chips.
330
+ *
331
+ * @remarks
332
+ * Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
192
333
  */
193
334
  export interface StringsElement extends UiElementBase {
194
335
  /**
@@ -197,20 +338,38 @@ export interface StringsElement extends UiElementBase {
197
338
  * @defaultValue "strings"
198
339
  */
199
340
  readonly type: "strings";
200
- /** Array of string values */
341
+ /**
342
+ * Array of string values
343
+ *
344
+ * @remarks
345
+ * Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
346
+ */
201
347
  readonly values: string[];
202
348
  /**
203
349
  * Display representation mode (plain text or visual chips)
204
350
  *
351
+ * @remarks
352
+ * Selects whether values appear as ordinary inline text or as separate visual chips. The default uses the plain representation.
353
+ *
205
354
  * @defaultValue StringRepresentation.plain
206
355
  */
207
356
  readonly representation?: StringRepresentation;
208
- /** Optional visual separator rendered between sequential values */
357
+ /**
358
+ * Optional visual separator rendered between sequential values
359
+ *
360
+ * @remarks
361
+ * Separator inserted between adjacent values in plain representation. It does not become part of any value.
362
+ */
209
363
  readonly separator?: Separator;
210
364
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
211
365
  readonly modifiers?: PrimitiveModifiers;
212
366
  }
213
- /** Monospace code block or formatted code snippet representation. */
367
+ /**
368
+ * Monospace code block or formatted code snippet representation.
369
+ *
370
+ * @remarks
371
+ * Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
372
+ */
214
373
  export interface StringCodeElement extends UiElementBase {
215
374
  /**
216
375
  * Discriminator type
@@ -218,14 +377,29 @@ export interface StringCodeElement extends UiElementBase {
218
377
  * @defaultValue "string-code"
219
378
  */
220
379
  readonly type: "string-code";
221
- /** Text value */
380
+ /**
381
+ * Text value
382
+ *
383
+ * @remarks
384
+ * Code or text snippet to display. Include any desired line breaks in this string.
385
+ */
222
386
  readonly value: string;
223
- /** Optional syntax highlighting language identifier */
387
+ /**
388
+ * Optional syntax highlighting language identifier
389
+ *
390
+ * @remarks
391
+ * Optional syntax hint for the renderer. Supported values describe highlighting modes and do not validate the snippet's syntax.
392
+ */
224
393
  readonly language?: CodeLanguage;
225
394
  /** Optional visual modifiers (copyable) */
226
395
  readonly modifiers?: BaseModifiers;
227
396
  }
228
- /** XML markup code block element. */
397
+ /**
398
+ * XML markup code block element.
399
+ *
400
+ * @remarks
401
+ * Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
402
+ */
229
403
  export interface XmlElement extends UiElementBase {
230
404
  /**
231
405
  * Discriminator type
@@ -233,12 +407,22 @@ export interface XmlElement extends UiElementBase {
233
407
  * @defaultValue "xml"
234
408
  */
235
409
  readonly type: "xml";
236
- /** XML content value */
410
+ /**
411
+ * XML content value
412
+ *
413
+ * @remarks
414
+ * XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
415
+ */
237
416
  readonly value: string;
238
417
  /** Optional visual modifiers (copyable) */
239
418
  readonly modifiers?: BaseModifiers;
240
419
  }
241
- /** JSON data or structure representation element. */
420
+ /**
421
+ * JSON data or structure representation element.
422
+ *
423
+ * @remarks
424
+ * Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
425
+ */
242
426
  export interface JsonElement extends UiElementBase {
243
427
  /**
244
428
  * Discriminator type
@@ -246,12 +430,22 @@ export interface JsonElement extends UiElementBase {
246
430
  * @defaultValue "json"
247
431
  */
248
432
  readonly type: "json";
249
- /** JSON content value */
433
+ /**
434
+ * JSON content value
435
+ *
436
+ * @remarks
437
+ * Serialized JSON text to render. No parsing or schema validation is implied by this element.
438
+ */
250
439
  readonly value: string;
251
440
  /** Optional visual modifiers (copyable) */
252
441
  readonly modifiers?: BaseModifiers;
253
442
  }
254
- /** Hyperlink representation for external or internal URL navigation. */
443
+ /**
444
+ * Hyperlink representation for external or internal URL navigation.
445
+ *
446
+ * @remarks
447
+ * Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
448
+ */
255
449
  export interface StringUrlElement extends UiElementBase {
256
450
  /**
257
451
  * Discriminator type
@@ -259,14 +453,24 @@ export interface StringUrlElement extends UiElementBase {
259
453
  * @defaultValue "string-url"
260
454
  */
261
455
  readonly type: "string-url";
262
- /** Target URL or navigation destination */
456
+ /**
457
+ * Target URL or navigation destination
458
+ *
459
+ * @remarks
460
+ * Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
461
+ */
263
462
  readonly value: string;
264
463
  /** Optional custom anchor text label */
265
464
  readonly label?: string;
266
465
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
267
466
  readonly modifiers?: PrimitiveModifiers;
268
467
  }
269
- /** Monospace semantic identifier representation. */
468
+ /**
469
+ * Monospace semantic identifier representation.
470
+ *
471
+ * @remarks
472
+ * Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
473
+ */
270
474
  export interface IdentifierElement extends UiElementBase {
271
475
  /**
272
476
  * Discriminator type
@@ -274,12 +478,22 @@ export interface IdentifierElement extends UiElementBase {
274
478
  * @defaultValue "identifier"
275
479
  */
276
480
  readonly type: "identifier";
277
- /** Identifier string value */
481
+ /**
482
+ * Identifier string value
483
+ *
484
+ * @remarks
485
+ * Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
486
+ */
278
487
  readonly value: string;
279
488
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
280
489
  readonly modifiers?: PrimitiveModifiers;
281
490
  }
282
- /** Aspect ratio representation (e.g. "16:9", "4:3", "1:1"). */
491
+ /**
492
+ * Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
493
+ *
494
+ * @remarks
495
+ * Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
496
+ */
283
497
  export interface RatioElement extends UiElementBase {
284
498
  /**
285
499
  * Discriminator type
@@ -287,12 +501,22 @@ export interface RatioElement extends UiElementBase {
287
501
  * @defaultValue "ratio"
288
502
  */
289
503
  readonly type: "ratio";
290
- /** Aspect ratio numerical expression */
504
+ /**
505
+ * Aspect ratio numerical expression
506
+ *
507
+ * @remarks
508
+ * Numeric ratio value used by the renderer to produce an aspect-ratio display.
509
+ */
291
510
  readonly value: number;
292
511
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
293
512
  readonly modifiers?: PrimitiveModifiers;
294
513
  }
295
- /** Image dimensions representation displaying formatted width and height in pixels. */
514
+ /**
515
+ * Image dimensions representation displaying formatted width and height in pixels.
516
+ *
517
+ * @remarks
518
+ * Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
519
+ */
296
520
  export interface DimensionsElement extends UiElementBase {
297
521
  /**
298
522
  * Discriminator type
@@ -300,14 +524,29 @@ export interface DimensionsElement extends UiElementBase {
300
524
  * @defaultValue "dimensions"
301
525
  */
302
526
  readonly type: "dimensions";
303
- /** Width in pixels */
527
+ /**
528
+ * Width in pixels
529
+ *
530
+ * @remarks
531
+ * Horizontal pixel count. Values below one are rejected by the schema constraint.
532
+ */
304
533
  readonly width: number;
305
- /** Height in pixels */
534
+ /**
535
+ * Height in pixels
536
+ *
537
+ * @remarks
538
+ * Vertical pixel count. Values below one are rejected by the schema constraint.
539
+ */
306
540
  readonly height: number;
307
541
  /** Optional visual modifiers (copyable) */
308
542
  readonly modifiers?: BaseModifiers;
309
543
  }
310
- /** Single color representation with hex value, shape/size styling, text display toggle, and copy affordance. */
544
+ /**
545
+ * Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
546
+ *
547
+ * @remarks
548
+ * Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
549
+ */
311
550
  export interface ColourElement extends UiElementBase {
312
551
  /**
313
552
  * Discriminator type
@@ -315,32 +554,56 @@ export interface ColourElement extends UiElementBase {
315
554
  * @defaultValue "color"
316
555
  */
317
556
  readonly type: "color";
318
- /** Hexadecimal color code */
557
+ /**
558
+ * Hexadecimal color code
559
+ *
560
+ * @remarks
561
+ * Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
562
+ */
319
563
  readonly value: string;
320
- /** Optional descriptive color name label */
564
+ /**
565
+ * Optional descriptive color name label
566
+ *
567
+ * @remarks
568
+ * Human-readable color name available to the renderer when text is shown.
569
+ */
321
570
  readonly label?: string;
322
571
  /**
323
572
  * Whether to display the textual color code or label next to the swatch
324
573
  *
574
+ * @remarks
575
+ * When true, allows the renderer to show the color's text label alongside the swatch. The default is true.
576
+ *
325
577
  * @defaultValue true
326
578
  */
327
579
  readonly showText?: boolean;
328
580
  /**
329
581
  * Visual shape of the color indicator
330
582
  *
583
+ * @remarks
584
+ * Geometry used for the swatch; defaults to a circle.
585
+ *
331
586
  * @defaultValue Shape.circle
332
587
  */
333
588
  readonly shape?: Shape;
334
589
  /**
335
590
  * Visual size of the color indicator
336
591
  *
592
+ * @remarks
593
+ * Relative size class for the swatch; defaults to medium.
594
+ *
337
595
  * @defaultValue Size.medium
338
596
  */
339
597
  readonly size?: Size;
340
598
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
341
599
  readonly modifiers?: PrimitiveModifiers;
342
600
  }
343
- /** Plain unbounded numeric value primitive element. */
601
+ /**
602
+ * Plain unbounded numeric value primitive element.
603
+ *
604
+ * @remarks
605
+ * Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
606
+ */
344
607
  export interface NumberUnboundedElement extends UiElementBase {
345
608
  /**
346
609
  * Discriminator type
@@ -348,14 +611,29 @@ export interface NumberUnboundedElement extends UiElementBase {
348
611
  * @defaultValue "number-unbounded"
349
612
  */
350
613
  readonly type: "number-unbounded";
351
- /** Numeric value */
614
+ /**
615
+ * Numeric value
616
+ *
617
+ * @remarks
618
+ * Number to display. Its meaning and any valid range are defined by the producing feature.
619
+ */
352
620
  readonly value: number;
353
- /** Optional unit suffix (e.g. "px", "ms", "MB") */
621
+ /**
622
+ * Optional unit suffix (e.g. "px", "ms", "MB")
623
+ *
624
+ * @remarks
625
+ * Short unit label appended or otherwise associated with the displayed value. Include only the unit text, not a second copy of the number.
626
+ */
354
627
  readonly unit?: string;
355
628
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
356
629
  readonly modifiers?: PrimitiveModifiers;
357
630
  }
358
- /** Bounded numeric rating represented as visual stars. */
631
+ /**
632
+ * Bounded numeric rating represented as visual stars.
633
+ *
634
+ * @remarks
635
+ * Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
636
+ */
359
637
  export interface NumberBoundedStarsElement extends UiElementBase {
360
638
  /**
361
639
  * Discriminator type
@@ -363,14 +641,29 @@ export interface NumberBoundedStarsElement extends UiElementBase {
363
641
  * @defaultValue "number-stars"
364
642
  */
365
643
  readonly type: "number-stars";
366
- /** Numeric rating score */
644
+ /**
645
+ * Numeric rating score
646
+ *
647
+ * @remarks
648
+ * Score represented by the filled portion of the star display.
649
+ */
367
650
  readonly value: number;
368
- /** Maximum rating scale (defaults to 5) */
651
+ /**
652
+ * Maximum rating scale (defaults to 5)
653
+ *
654
+ * @remarks
655
+ * Upper end of the rating scale. When omitted, the scale is five; value should use the same scale.
656
+ */
369
657
  readonly maximum?: number;
370
658
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
371
659
  readonly modifiers?: PrimitiveModifiers;
372
660
  }
373
- /** Bounded numeric meter representation (read-only progress / score bar). */
661
+ /**
662
+ * Bounded numeric meter representation (read-only progress / score bar).
663
+ *
664
+ * @remarks
665
+ * Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
666
+ */
374
667
  export interface NumberBoundedMeterElement extends UiElementBase {
375
668
  /**
376
669
  * Discriminator type
@@ -378,22 +671,49 @@ export interface NumberBoundedMeterElement extends UiElementBase {
378
671
  * @defaultValue "number-meter"
379
672
  */
380
673
  readonly type: "number-meter";
381
- /** Numeric value */
674
+ /**
675
+ * Numeric value
676
+ *
677
+ * @remarks
678
+ * Current measurement or score represented by the meter.
679
+ */
382
680
  readonly value: number;
383
- /** Minimum scale bound (defaults to 0) */
681
+ /**
682
+ * Minimum scale bound (defaults to 0)
683
+ *
684
+ * @remarks
685
+ * Lower end of the meter range. Defaults to zero when omitted.
686
+ */
384
687
  readonly minimum?: number;
385
- /** Maximum scale bound (e.g. 100) */
688
+ /**
689
+ * Maximum scale bound (e.g. 100)
690
+ *
691
+ * @remarks
692
+ * Upper end of the meter range. Choose a bound consistent with value and minimum.
693
+ */
386
694
  readonly maximum?: number;
387
- /** Optional custom text label override (e.g. "68 / 100") */
695
+ /**
696
+ * Optional custom text label override (e.g. "68 / 100")
697
+ *
698
+ * @remarks
699
+ * Optional readout text to use instead of a renderer-generated value and range label.
700
+ */
388
701
  readonly label?: string;
389
- /** Optional unit suffix (e.g. "%") */
702
+ /**
703
+ * Optional unit suffix (e.g. "%")
704
+ *
705
+ * @remarks
706
+ * Unit associated with the value, such as a percent sign. This affects display only and does not convert the numeric value.
707
+ */
390
708
  readonly unit?: string;
391
709
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
392
710
  readonly modifiers?: PrimitiveModifiers;
393
711
  }
394
712
  /**
395
- * Universal boolean primitive element.
396
- * Supports standard plain text or badge pill presentation with customizable labels and variants.
713
+ * Boolean value primitive with text or badge presentation.
714
+ *
715
+ * @remarks
716
+ * Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
397
717
  */
398
718
  export interface BooleanElement extends UiElementBase {
399
719
  /**
@@ -402,36 +722,58 @@ export interface BooleanElement extends UiElementBase {
402
722
  * @defaultValue "boolean"
403
723
  */
404
724
  readonly type: "boolean";
405
- /** Boolean state value */
725
+ /**
726
+ * Boolean state value
727
+ *
728
+ * @remarks
729
+ * State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
730
+ */
406
731
  readonly value: boolean;
407
732
  /**
408
733
  * Display representation mode
409
734
  *
735
+ * @remarks
736
+ * Selects ordinary text or a badge pill. Badge color applies only to badge presentation.
737
+ *
410
738
  * @defaultValue BooleanRepresentation.plain
411
739
  */
412
740
  readonly representation?: BooleanRepresentation;
413
741
  /**
414
742
  * Custom display label when true (defaults to "true")
415
743
  *
744
+ * @remarks
745
+ * Text used for the true state in plain representation. Defaults to the literal text true.
746
+ *
416
747
  * @defaultValue "true"
417
748
  */
418
749
  readonly trueLabel?: string;
419
750
  /**
420
751
  * Custom display label when false (defaults to "false")
421
752
  *
753
+ * @remarks
754
+ * Text used for the false state in plain representation. Defaults to the literal text false.
755
+ *
422
756
  * @defaultValue "false"
423
757
  */
424
758
  readonly falseLabel?: string;
425
759
  /**
426
760
  * Badge color tone when rendered as badge
427
761
  *
762
+ * @remarks
763
+ * Semantic color treatment for badge presentation; it has no effect in plain representation.
764
+ *
428
765
  * @defaultValue BadgeVariant.neutral
429
766
  */
430
767
  readonly variant?: BadgeVariant;
431
768
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
432
769
  readonly modifiers?: PrimitiveModifiers;
433
770
  }
434
- /** Formatted date and time representation. */
771
+ /**
772
+ * Formatted date and time representation.
773
+ *
774
+ * @remarks
775
+ * Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
776
+ */
435
777
  export interface TimestampElement extends UiElementBase {
436
778
  /**
437
779
  * Discriminator type
@@ -439,18 +781,31 @@ export interface TimestampElement extends UiElementBase {
439
781
  * @defaultValue "timestamp"
440
782
  */
441
783
  readonly type: "timestamp";
442
- /** The timestamp in milliseconds */
784
+ /**
785
+ * The timestamp in milliseconds
786
+ *
787
+ * @remarks
788
+ * Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
789
+ */
443
790
  readonly value: number;
444
791
  /**
445
792
  * Presentation date/time format
446
793
  *
794
+ * @remarks
795
+ * Controls whether the timestamp is shown as date and time, date only, time only, or relative text. The default is datetime.
796
+ *
447
797
  * @defaultValue TimestampFormat.datetime
448
798
  */
449
799
  readonly format?: TimestampFormat;
450
800
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
451
801
  readonly modifiers?: PrimitiveModifiers;
452
802
  }
453
- /** Thumbnail image reference with placeholder fallback handling. */
803
+ /**
804
+ * Thumbnail image reference with placeholder fallback handling.
805
+ *
806
+ * @remarks
807
+ * References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
808
+ */
454
809
  export interface ImageReferenceElement extends UiElementBase {
455
810
  /**
456
811
  * Discriminator type
@@ -458,20 +813,43 @@ export interface ImageReferenceElement extends UiElementBase {
458
813
  * @defaultValue "image-ref"
459
814
  */
460
815
  readonly type: "image-ref";
461
- /** Image source URI (HTTPS URL, base64 data URI, or asset path) */
816
+ /**
817
+ * Image source URI (HTTPS URL, base64 data URI, or asset path)
818
+ *
819
+ * @remarks
820
+ * Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
821
+ */
462
822
  readonly src: string;
463
- /** Accessible alternative description */
823
+ /**
824
+ * Accessible alternative description
825
+ *
826
+ * @remarks
827
+ * Alternative text describing the image for assistive technology. Provide meaningful text when the image conveys information; omit it only when it is decorative.
828
+ */
464
829
  readonly alt?: string;
465
830
  /**
466
831
  * Aspect ratio of the thumbnail container
467
832
  *
833
+ * @remarks
834
+ * Preferred ratio of the rendered thumbnail container, expressed as a ratio string such as 1:1. It controls presentation rather than modifying the source image.
835
+ *
468
836
  * @defaultValue "1:1"
469
837
  */
470
838
  readonly aspectRatio?: string;
471
- /** Fallback placeholder image URI */
839
+ /**
840
+ * Fallback placeholder image URI
841
+ *
842
+ * @remarks
843
+ * Optional source to display when the primary image cannot be loaded. It follows the same URI conventions as src.
844
+ */
472
845
  readonly placeholder?: string;
473
846
  }
474
- /** Interactive button action triggering an extension command. */
847
+ /**
848
+ * Interactive button action triggering an extension command.
849
+ *
850
+ * @remarks
851
+ * When activated, the client dispatches commandId to the specified extension and may include target and parameters as command input. disabled and variant affect presentation and availability, not the command's authorization.
852
+ */
475
853
  export interface ButtonActionElement extends UiActionBase {
476
854
  /**
477
855
  * Discriminator type
@@ -479,28 +857,59 @@ export interface ButtonActionElement extends UiActionBase {
479
857
  * @defaultValue "button"
480
858
  */
481
859
  readonly type: "button";
482
- /** Extension identifier owning the target command */
860
+ /**
861
+ * Extension identifier owning the target command
862
+ *
863
+ * @remarks
864
+ * Extension that registers commandId. Omit only when the client can resolve the command in the current extension context.
865
+ */
483
866
  readonly extensionId?: string;
484
- /** Command identifier to invoke */
867
+ /**
868
+ * Command identifier to invoke
869
+ *
870
+ * @remarks
871
+ * Identifier of the registered extension command to dispatch when the button is activated.
872
+ */
485
873
  readonly commandId: string;
486
- /** Target entity or context identifier */
874
+ /**
875
+ * Target entity or context identifier
876
+ *
877
+ * @remarks
878
+ * Optional entity or context identifier forwarded to the command handler. Its format is determined by the target extension.
879
+ */
487
880
  readonly target?: string;
488
- /** Optional arbitrary parameters payload forwarded to the command handler */
881
+ /**
882
+ * Optional arbitrary parameters payload forwarded to the command handler
883
+ *
884
+ * @remarks
885
+ * JSON-compatible arguments passed to the extension command. Define and validate their shape in the command implementation.
886
+ */
489
887
  readonly parameters?: Record<string, unknown>;
490
888
  /**
491
889
  * Whether the button is disabled / unavailable
492
890
  *
891
+ * @remarks
892
+ * When true, the client renders the action as unavailable and should not dispatch it from user activation.
893
+ *
493
894
  * @defaultValue false
494
895
  */
495
896
  readonly disabled?: boolean;
496
897
  /**
497
898
  * Button visual style variant
498
899
  *
900
+ * @remarks
901
+ * Selects the button's emphasis style. Use danger for destructive operations and primary for the main recommended action; the variant does not change behavior.
902
+ *
499
903
  * @defaultValue ButtonVariant.secondary
500
904
  */
501
905
  readonly variant?: ButtonVariant;
502
906
  }
503
- /** External link action distinct from inline URL text values. */
907
+ /**
908
+ * External link action distinct from inline URL text values.
909
+ *
910
+ * @remarks
911
+ * Renders a user-invokable action that opens a destination externally. Use StringUrlElement for a link embedded in content rather than an action control.
912
+ */
504
913
  export interface ExternalLinkActionElement extends UiActionBase {
505
914
  /**
506
915
  * Discriminator type
@@ -508,10 +917,20 @@ export interface ExternalLinkActionElement extends UiActionBase {
508
917
  * @defaultValue "external-link"
509
918
  */
510
919
  readonly type: "external-link";
511
- /** Target URL destination */
920
+ /**
921
+ * Target URL destination
922
+ *
923
+ * @remarks
924
+ * External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
925
+ */
512
926
  readonly url: string;
513
927
  }
514
- /** Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling. */
928
+ /**
929
+ * Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling.
930
+ *
931
+ * @remarks
932
+ * Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
933
+ */
515
934
  export interface MarkdownBlockElement extends UiElementBase {
516
935
  /**
517
936
  * Discriminator type
@@ -519,12 +938,22 @@ export interface MarkdownBlockElement extends UiElementBase {
519
938
  * @defaultValue "markdown"
520
939
  */
521
940
  readonly type: "markdown";
522
- /** Raw Markdown markup content */
941
+ /**
942
+ * Raw Markdown markup content
943
+ *
944
+ * @remarks
945
+ * Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
946
+ */
523
947
  readonly content: string;
524
948
  /** Optional visual modifiers (copyable) */
525
949
  readonly modifiers?: BaseModifiers;
526
950
  }
527
- /** Sandboxed HTML rendering escape hatch. */
951
+ /**
952
+ * Sandboxed HTML rendering escape hatch.
953
+ *
954
+ * @remarks
955
+ * Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
956
+ */
528
957
  export interface HtmlBlockElement extends UiElementBase {
529
958
  /**
530
959
  * Discriminator type
@@ -532,21 +961,51 @@ export interface HtmlBlockElement extends UiElementBase {
532
961
  * @defaultValue "html"
533
962
  */
534
963
  readonly type: "html";
535
- /** Raw HTML markup content */
964
+ /**
965
+ * Raw HTML markup content
966
+ *
967
+ * @remarks
968
+ * HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
969
+ */
536
970
  readonly content: string;
537
971
  /** Optional visual modifiers (copyable) */
538
972
  readonly modifiers?: BaseModifiers;
539
973
  }
540
- /** Single slot within a multi-slot horizontal row layout. */
974
+ /**
975
+ * Single slot within a multi-slot horizontal row layout.
976
+ *
977
+ * @remarks
978
+ * A slot combines an optional label, a relative width, and one visual child. Slot widths are percentages of the row and should be chosen so the full row's widths form a usable layout.
979
+ */
541
980
  export interface Slot {
542
- /** Optional slot label (e.g. "Slot A") */
981
+ /**
982
+ * Optional slot label (e.g. "Slot A")
983
+ *
984
+ * @remarks
985
+ * Short text identifying this region of the row. It is independent of the rendered content.
986
+ */
543
987
  readonly label?: string;
544
- /** Width percentage (1-100) */
988
+ /**
989
+ * Width percentage (1-100)
990
+ *
991
+ * @remarks
992
+ * Relative share of the row width. The schema constrains explicit values to the inclusive range 1 through 100.
993
+ */
545
994
  readonly width?: number;
546
- /** Rendered content inside the slot */
995
+ /**
996
+ * Rendered content inside the slot
997
+ *
998
+ * @remarks
999
+ * One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
1000
+ */
547
1001
  readonly content: UiElement;
548
1002
  }
549
- /** Multi-slot horizontal row layout comprising slots with individual widths. */
1003
+ /**
1004
+ * Horizontal row layout with individually sized slots.
1005
+ *
1006
+ * @remarks
1007
+ * Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
1008
+ */
550
1009
  export interface MultiSlotElement extends UiElementBase {
551
1010
  /**
552
1011
  * Discriminator type
@@ -554,12 +1013,19 @@ export interface MultiSlotElement extends UiElementBase {
554
1013
  * @defaultValue "multi-slot"
555
1014
  */
556
1015
  readonly type: "multi-slot";
557
- /** List of slots comprising the row */
1016
+ /**
1017
+ * List of slots comprising the row
1018
+ *
1019
+ * @remarks
1020
+ * Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
1021
+ */
558
1022
  readonly slots: Slot[];
559
1023
  }
560
1024
  /**
561
- * Flowing inline layout container with automatic line wrapping.
562
- * Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
1025
+ * Inline layout container that wraps child elements.
1026
+ *
1027
+ * @remarks
1028
+ * Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
563
1029
  */
564
1030
  export interface FlowingElement extends UiElementBase {
565
1031
  /**
@@ -568,14 +1034,26 @@ export interface FlowingElement extends UiElementBase {
568
1034
  * @defaultValue "flowing"
569
1035
  */
570
1036
  readonly type: "flowing";
571
- /** Optional visual separator rendered between sequential child elements */
1037
+ /**
1038
+ * Optional visual separator rendered between sequential child elements
1039
+ *
1040
+ * @remarks
1041
+ * Separator placed between adjacent elements. Omit it when spacing or the child renderers already provide sufficient separation.
1042
+ */
572
1043
  readonly separator?: Separator;
573
- /** List of child elements rendered sequentially with line wrapping */
1044
+ /**
1045
+ * List of child elements rendered sequentially with line wrapping
1046
+ *
1047
+ * @remarks
1048
+ * Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
1049
+ */
574
1050
  readonly elements: UiElement[];
575
1051
  }
576
1052
  /**
577
- * Standard label and value row.
578
- * Displays a muted label on the left and value representation on the right with a vertical dividing line.
1053
+ * Label and value row with an optional divider.
1054
+ *
1055
+ * @remarks
1056
+ * Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
579
1057
  */
580
1058
  export interface LabelValueElement extends UiElementBase {
581
1059
  /**
@@ -584,44 +1062,90 @@ export interface LabelValueElement extends UiElementBase {
584
1062
  * @defaultValue "label-value"
585
1063
  */
586
1064
  readonly type: "label-value";
587
- /** Key or descriptive label displayed muted on the left */
1065
+ /**
1066
+ * Key or descriptive label displayed muted on the left
1067
+ *
1068
+ * @remarks
1069
+ * Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
1070
+ */
588
1071
  readonly label: string;
589
- /** Rendered value element on the right */
1072
+ /**
1073
+ * Rendered value element on the right
1074
+ *
1075
+ * @remarks
1076
+ * Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
1077
+ */
590
1078
  readonly value: UiElement;
591
1079
  /**
592
1080
  * Whether to render a bottom border/hairline divider
593
1081
  *
1082
+ * @remarks
1083
+ * Enables a horizontal separator beneath this row when true. Defaults to false.
1084
+ *
594
1085
  * @defaultValue false
595
1086
  */
596
1087
  readonly withDivider?: boolean;
597
1088
  }
598
- /** Column definition for structured tables. */
1089
+ /**
1090
+ * Column definition for structured tables.
1091
+ *
1092
+ * @remarks
1093
+ * Describes one table column and its visual sizing. When columns are supplied, their order corresponds to the position of each cell in a row.
1094
+ */
599
1095
  export interface TableColumn {
600
- /** Display header text */
1096
+ /**
1097
+ * Display header text
1098
+ *
1099
+ * @remarks
1100
+ * Optional header shown above values in this column. Omit when the table has no header row.
1101
+ */
601
1102
  readonly header?: string;
602
1103
  /**
603
1104
  * Text horizontal alignment
604
1105
  *
1106
+ * @remarks
1107
+ * Horizontal alignment applied to cell content in the column. Defaults to left.
1108
+ *
605
1109
  * @defaultValue TableColumnAlign.left
606
1110
  */
607
1111
  readonly align?: TableColumnAlign;
608
- /** Width percentage (1-100) */
1112
+ /**
1113
+ * Width percentage (1-100)
1114
+ *
1115
+ * @remarks
1116
+ * Column width percentage used with widthMode. Explicit values are constrained to 1 through 100.
1117
+ */
609
1118
  readonly width?: number;
610
1119
  /**
611
1120
  * Sizing mode for the provided width
612
1121
  *
613
- * @defaultValue TableColumnWidthMode.fixed
1122
+ * @remarks
1123
+ * Determines whether width is a fixed percentage allocation or an upper bound. Defaults to fixed.
1124
+ *
1125
+ * @defaultValue TableColumnWidthMode.fixed
1126
+ */
1127
+ readonly widthMode?: TableColumnWidthMode;
1128
+ }
1129
+ /**
1130
+ * Single table row containing an array of cell values.
1131
+ *
1132
+ * @remarks
1133
+ * A row's cell array is positional: cell at each index corresponds to the column at that index. Keep row lengths aligned with the table's explicit column definitions when present.
1134
+ */
1135
+ export interface TableRow {
1136
+ /**
1137
+ * Array of cell values corresponding to table columns
1138
+ *
1139
+ * @remarks
1140
+ * Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
614
1141
  */
615
- readonly widthMode?: TableColumnWidthMode;
616
- }
617
- /** Single table row containing an array of cell values. */
618
- export interface TableRow {
619
- /** Array of cell values corresponding to table columns */
620
1142
  readonly cells: UiElement[];
621
1143
  }
622
1144
  /**
623
- * Structured tabular data representation.
624
- * Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
1145
+ * Structured tabular data with optional columns and separators.
1146
+ *
1147
+ * @remarks
1148
+ * Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
625
1149
  */
626
1150
  export interface TableElement extends UiElementBase {
627
1151
  /**
@@ -633,36 +1157,80 @@ export interface TableElement extends UiElementBase {
633
1157
  /**
634
1158
  * Whether to render alternating row background colors
635
1159
  *
1160
+ * @remarks
1161
+ * Enables alternating backgrounds across successive rows to improve scanability. Defaults to false.
1162
+ *
636
1163
  * @defaultValue false
637
1164
  */
638
1165
  readonly isStriped?: boolean;
639
1166
  /**
640
1167
  * Whether to render vertical column separators
641
1168
  *
1169
+ * @remarks
1170
+ * Adds vertical dividers between columns when true. Defaults to false.
1171
+ *
642
1172
  * @defaultValue false
643
1173
  */
644
1174
  readonly withColumnSeparators?: boolean;
645
1175
  /**
646
1176
  * Whether to render horizontal row separators
647
1177
  *
1178
+ * @remarks
1179
+ * Adds horizontal dividers between rows when true. Defaults to false.
1180
+ *
648
1181
  * @defaultValue false
649
1182
  */
650
1183
  readonly withRowSeparators?: boolean;
651
- /** Optional explicit column definitions */
1184
+ /**
1185
+ * Optional explicit column definitions
1186
+ *
1187
+ * @remarks
1188
+ * Optional ordered column metadata defining headers, alignment, and width. When omitted, the renderer may infer a basic layout from row cells.
1189
+ */
652
1190
  readonly columns?: TableColumn[];
653
- /** Tabular data rows */
1191
+ /**
1192
+ * Tabular data rows
1193
+ *
1194
+ * @remarks
1195
+ * Ordered table rows. Each row's cells correspond positionally to the declared columns.
1196
+ */
654
1197
  readonly rows: TableRow[];
655
1198
  }
656
- /** Single entry within a repeating group. */
1199
+ /**
1200
+ * Single entry within a repeating group.
1201
+ *
1202
+ * @remarks
1203
+ * A repeating entry carries a stable display label and either one primary value or a list of nested elements, depending on the shape needed by the feature.
1204
+ */
657
1205
  export interface RepeatingGroupEntry {
658
- /** Entry label */
1206
+ /**
1207
+ * Entry label
1208
+ *
1209
+ * @remarks
1210
+ * Short label identifying this entry within the repeated group.
1211
+ */
659
1212
  readonly label: string;
660
- /** Primary entry value or nested elements */
1213
+ /**
1214
+ * Primary entry value or nested elements
1215
+ *
1216
+ * @remarks
1217
+ * Optional primary visual value for a compact entry. Use elements for a multi-part structured entry.
1218
+ */
661
1219
  readonly value?: UiElement;
662
- /** Nested elements for structured entries */
1220
+ /**
1221
+ * Nested elements for structured entries
1222
+ *
1223
+ * @remarks
1224
+ * Optional ordered content for entries that require more than one value element.
1225
+ */
663
1226
  readonly elements?: UiElement[];
664
1227
  }
665
- /** Repeating group container where entries share uniform structure and retain per-entry labels. */
1228
+ /**
1229
+ * Repeating group container where entries share uniform structure and retain per-entry labels.
1230
+ *
1231
+ * @remarks
1232
+ * Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
1233
+ */
666
1234
  export interface RepeatingGroupElement extends UiElementBase {
667
1235
  /**
668
1236
  * Discriminator type
@@ -670,12 +1238,27 @@ export interface RepeatingGroupElement extends UiElementBase {
670
1238
  * @defaultValue "repeating-group"
671
1239
  */
672
1240
  readonly type: "repeating-group";
673
- /** Optional section header for the group */
1241
+ /**
1242
+ * Optional section header for the group
1243
+ *
1244
+ * @remarks
1245
+ * Heading displayed for the repeated section, separate from the labels of individual entries.
1246
+ */
674
1247
  readonly title?: string;
675
- /** List of repeated entry records */
1248
+ /**
1249
+ * List of repeated entry records
1250
+ *
1251
+ * @remarks
1252
+ * Entries in display order. Each entry supplies its own label and content.
1253
+ */
676
1254
  readonly entries: RepeatingGroupEntry[];
677
1255
  }
678
- /** Collapsible disclosure container (accordion) with summary badge. */
1256
+ /**
1257
+ * Collapsible disclosure container (accordion) with summary badge.
1258
+ *
1259
+ * @remarks
1260
+ * Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
1261
+ */
679
1262
  export interface CollapsibleGroupElement extends UiElementBase {
680
1263
  /**
681
1264
  * Discriminator type
@@ -683,20 +1266,43 @@ export interface CollapsibleGroupElement extends UiElementBase {
683
1266
  * @defaultValue "collapsible-group"
684
1267
  */
685
1268
  readonly type: "collapsible-group";
686
- /** Group title (e.g. "Show specimen details") */
1269
+ /**
1270
+ * Group title (e.g. "Show specimen details")
1271
+ *
1272
+ * @remarks
1273
+ * Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
1274
+ */
687
1275
  readonly title: string;
688
- /** Secondary summary indicator (e.g. "2 neutral values") */
1276
+ /**
1277
+ * Secondary summary indicator (e.g. "2 neutral values")
1278
+ *
1279
+ * @remarks
1280
+ * Compact contextual text shown alongside the title while the group is collapsed or expanded. It does not replace the nested content.
1281
+ */
689
1282
  readonly summary?: string;
690
1283
  /**
691
1284
  * Whether the disclosure is open/expanded by default
692
1285
  *
1286
+ * @remarks
1287
+ * Initial expanded state requested by the data. Defaults to false; subsequent interaction is managed by the client.
1288
+ *
693
1289
  * @defaultValue false
694
1290
  */
695
1291
  readonly defaultExpanded?: boolean;
696
- /** Nested content elements revealed when expanded */
1292
+ /**
1293
+ * Nested content elements revealed when expanded
1294
+ *
1295
+ * @remarks
1296
+ * Ordered child elements made visible by expanding the group.
1297
+ */
697
1298
  readonly elements: UiElement[];
698
1299
  }
699
- /** Visual hairline separator separating sections or element groups. */
1300
+ /**
1301
+ * Visual hairline separator separating sections or element groups.
1302
+ *
1303
+ * @remarks
1304
+ * A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
1305
+ */
700
1306
  export interface DividerElement extends UiElementBase {
701
1307
  /**
702
1308
  * Discriminator type
@@ -707,66 +1313,130 @@ export interface DividerElement extends UiElementBase {
707
1313
  /**
708
1314
  * Line styling
709
1315
  *
1316
+ * @remarks
1317
+ * Visual stroke treatment for the separator. Defaults to a subtle hairline.
1318
+ *
710
1319
  * @defaultValue DividerStyle.hairline
711
1320
  */
712
1321
  readonly style?: DividerStyle;
713
1322
  }
714
- /** Base envelope container model holding the schema version attribute. */
1323
+ /**
1324
+ * Base envelope containing the schema version.
1325
+ *
1326
+ * @remarks
1327
+ * All root ViewKit documents extend this envelope so consumers can identify the schema contract version before processing the root content.
1328
+ */
715
1329
  export interface Envelop {
716
1330
  /**
717
1331
  * Schema specification version
718
1332
  *
1333
+ * @remarks
1334
+ * Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
1335
+ *
719
1336
  * @defaultValue "1.0"
720
1337
  */
721
1338
  readonly schemaVersion: "1.0";
722
1339
  }
723
- /** Container model representing an ordered list of visual elements. */
1340
+ /**
1341
+ * Root container holding an ordered list of visual elements.
1342
+ *
1343
+ * @remarks
1344
+ * Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
1345
+ */
724
1346
  export interface UiContainer extends Envelop {
725
- /** Ordered list of visual elements, structures, and content */
1347
+ /**
1348
+ * Ordered list of visual elements, structures, and content
1349
+ *
1350
+ * @remarks
1351
+ * Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
1352
+ */
726
1353
  readonly elements: UiElement[];
727
1354
  }
728
1355
  /**
729
- * Root Card container model.
730
- * Represents a complete feature card rendered inside the 360px panel.
1356
+ * Root container for a complete feature card.
1357
+ *
1358
+ * @remarks
1359
+ * A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
731
1360
  */
732
1361
  export interface UiCard extends UiContainer {
733
- /** Human-readable feature title displayed in the card header */
1362
+ /**
1363
+ * Human-readable feature title displayed in the card header
1364
+ *
1365
+ * @remarks
1366
+ * Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
1367
+ */
734
1368
  readonly title: string;
735
- /** Optional neutral subtitle / description for the feature */
1369
+ /**
1370
+ * Optional neutral subtitle / description for the feature
1371
+ *
1372
+ * @remarks
1373
+ * Brief secondary context shown with the title. Use the content elements for detailed information rather than placing an entire report in this field.
1374
+ */
736
1375
  readonly description?: string;
737
- /** Optional card action buttons rendered at the base of the feature card */
1376
+ /**
1377
+ * Optional card action buttons rendered at the base of the feature card
1378
+ *
1379
+ * @remarks
1380
+ * Optional user-invokable actions shown after the card content. Their order is preserved and each action's own fields define its command or link behavior.
1381
+ */
738
1382
  readonly actions?: UiAction[];
739
1383
  }
740
1384
  /**
741
- * Polymorphic root base model for all visual UI elements in Picteus feature views.
742
- * Uses the @discriminator("type") decorator so all child models inheriting from UiElement
743
- * are automatically recognized by schema emitters and SDK code generators.
1385
+ * Polymorphic root model for visual UI elements.
1386
+ *
1387
+ * @remarks
1388
+ * Every concrete visual element carries a type discriminator whose literal value selects its model and renderer. The @discriminator("type") metadata lets schema emitters and SDK generators represent derived models as a polymorphic hierarchy. Consumers should dispatch on the discriminator and preserve unknown elements when round-tripping data where possible.
744
1389
  */
745
1390
  export type UiElement = StringElement | StringsElement | StringCodeElement | XmlElement | JsonElement | StringUrlElement | IdentifierElement | RatioElement | DimensionsElement | ColourElement | NumberUnboundedElement | NumberBoundedStarsElement | NumberBoundedMeterElement | BooleanElement | TimestampElement | ImageReferenceElement | MarkdownBlockElement | HtmlBlockElement | MultiSlotElement | FlowingElement | LabelValueElement | TableElement | RepeatingGroupElement | CollapsibleGroupElement | DividerElement;
746
- /** Polymorphic base model for interactive actions. */
1391
+ /**
1392
+ * Polymorphic base model for interactive actions.
1393
+ *
1394
+ * @remarks
1395
+ * Shared action contract for user-invokable card controls. Concrete action models provide their own discriminator and action-specific destination or command fields.
1396
+ */
747
1397
  export type UiAction = ButtonActionElement | ExternalLinkActionElement;
748
1398
  /**
749
1399
  * Class implementation of the `TruncateOptions` interface.
750
1400
  *
751
1401
  * @remarks
752
- * Truncation configuration for long textual content with optional expand affordance.
1402
+ * Controls how a renderer abbreviates long text. When mode is characters, limit represents maximum character count; when mode is lines, limit represents visual line count.
753
1403
  */
754
1404
  export declare class TruncateOptionsClass extends ViewKitNode<TruncateOptions> implements TruncateOptions {
755
- /** Maximum number of characters to display before truncating */
756
- readonly characterLimit: number;
1405
+ /**
1406
+ * Maximum threshold limit before truncating
1407
+ *
1408
+ * @remarks
1409
+ * Threshold after which the renderer can shorten the displayed text. When mode is characters, this represents character count; when mode is lines, this represents visual line count.
1410
+ */
1411
+ readonly limit: number;
1412
+ /**
1413
+ * Truncation measurement mode (characters or lines)
1414
+ *
1415
+ * @remarks
1416
+ * Whether limit represents character count or line count. Defaults to lines.
1417
+ *
1418
+ * @defaultValue TruncateMode.lines
1419
+ */
1420
+ readonly mode?: TruncateMode;
757
1421
  /**
758
1422
  * Whether to render a "Show more" / "Show less" toggle affordance
759
1423
  *
1424
+ * @remarks
1425
+ * When true, permits an expand/collapse control for text beyond the truncation threshold. Defaults to true.
1426
+ *
760
1427
  * @defaultValue true
761
1428
  */
762
1429
  readonly showMore?: boolean;
763
1430
  /**
764
1431
  * Constructs a new `TruncateOptionsClass` instance.
765
1432
  *
766
- * @param characterLimit - Maximum number of characters to display before truncating
767
- * @param options - Optional component settings. (showMore (defaults to `true`)).
1433
+ * @param limit - Maximum threshold limit before truncating
1434
+
1435
+ Threshold after which the renderer can shorten the displayed text. When mode is characters, this represents character count; when mode is lines, this represents visual line count.
1436
+ * @param options - Optional component settings. (mode (defaults to `lines`), showMore (defaults to `true`)).
768
1437
  */
769
- constructor(characterLimit: number, options?: {
1438
+ constructor(limit: number, options?: {
1439
+ mode?: TruncateMode;
770
1440
  showMore?: boolean;
771
1441
  });
772
1442
  }
@@ -774,10 +1444,15 @@ export declare class TruncateOptionsClass extends ViewKitNode<TruncateOptions> i
774
1444
  * Class implementation of the `BaseModifiers` interface.
775
1445
  *
776
1446
  * @remarks
777
- * Base modifier traits for elements that support copy affordance.
1447
+ * Common optional presentation traits shared by primitive values and content renderers. Modifiers affect how content is displayed or copied; they do not transform the source value.
778
1448
  */
779
1449
  export declare class BaseModifiersClass extends ViewKitNode<BaseModifiers> implements BaseModifiers {
780
- /** Adds an interactive copy button/action next to the rendered value */
1450
+ /**
1451
+ * Adds an interactive copy button/action next to the rendered value
1452
+ *
1453
+ * @remarks
1454
+ * When true, exposes a copy affordance for the associated value where supported by the renderer.
1455
+ */
781
1456
  readonly copyable?: boolean;
782
1457
  /**
783
1458
  * Constructs a new `BaseModifiersClass` instance.
@@ -792,30 +1467,49 @@ export declare class BaseModifiersClass extends ViewKitNode<BaseModifiers> imple
792
1467
  * Class implementation of the `PrimitiveModifiers` interface.
793
1468
  *
794
1469
  * @remarks
795
- * Common modifier traits that can be attached to primitive elements.
1470
+ * Extends BaseModifiers with text styling controls. Defaults provide normal weight, medium intensity, and proportional text unless a feature explicitly overrides them.
796
1471
  */
797
1472
  export declare class PrimitiveModifiersClass extends ViewKitNode<PrimitiveModifiers> implements PrimitiveModifiers {
798
- /** Configures character truncation threshold with show-more affordance */
1473
+ /**
1474
+ * Configures truncation threshold with show-more affordance
1475
+ *
1476
+ * @remarks
1477
+ * Optional text abbreviation behavior. The source text remains unchanged, and the renderer may offer expansion according to showMore.
1478
+ */
799
1479
  readonly truncate?: TruncateOptions;
800
1480
  /**
801
1481
  * Typographic text weight
802
1482
  *
1483
+ * @remarks
1484
+ * Relative font weight for textual rendering; defaults to normal.
1485
+ *
803
1486
  * @defaultValue TextWeight.normal
804
1487
  */
805
1488
  readonly weight?: TextWeight;
806
1489
  /**
807
1490
  * Visual text color intensity
808
1491
  *
1492
+ * @remarks
1493
+ * Relative contrast treatment for the text; defaults to medium.
1494
+ *
809
1495
  * @defaultValue TextIntensity.medium
810
1496
  */
811
1497
  readonly intensity?: TextIntensity;
812
1498
  /**
813
1499
  * Whether to use monospace font rendering (for hashes, IDs, codes)
814
1500
  *
1501
+ * @remarks
1502
+ * When true, requests a fixed-width font suitable for identifiers and code-like values. Defaults to false.
1503
+ *
815
1504
  * @defaultValue false
816
1505
  */
817
1506
  readonly monospace?: boolean;
818
- /** Adds an interactive copy button/action next to the rendered value */
1507
+ /**
1508
+ * Adds an interactive copy button/action next to the rendered value
1509
+ *
1510
+ * @remarks
1511
+ * When true, exposes a copy affordance for the associated value where supported by the renderer.
1512
+ */
819
1513
  readonly copyable?: boolean;
820
1514
  /**
821
1515
  * Constructs a new `PrimitiveModifiersClass` instance.
@@ -834,8 +1528,7 @@ export declare class PrimitiveModifiersClass extends ViewKitNode<PrimitiveModifi
834
1528
  * Class implementation of the `StringElement` interface.
835
1529
  *
836
1530
  * @remarks
837
- * Universal textual string primitive element.
838
- * Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
1531
+ * Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
839
1532
  */
840
1533
  export declare class StringElementClass extends BaseUiElement<StringElement> implements StringElement {
841
1534
  /**
@@ -844,11 +1537,19 @@ export declare class StringElementClass extends BaseUiElement<StringElement> imp
844
1537
  * @defaultValue "string"
845
1538
  */
846
1539
  readonly type = "string";
847
- /** Text value */
1540
+ /**
1541
+ * Text value
1542
+ *
1543
+ * @remarks
1544
+ * Text to render. Supply plain text; this field is not a Markdown or HTML document.
1545
+ */
848
1546
  readonly value: string;
849
1547
  /**
850
1548
  * Display representation mode
851
1549
  *
1550
+ * @remarks
1551
+ * Selects inline, chip, or multiline rendering. The default is plain, so callers can omit this for ordinary text.
1552
+ *
852
1553
  * @defaultValue StringRepresentation.plain
853
1554
  */
854
1555
  readonly representation?: StringRepresentation;
@@ -858,6 +1559,8 @@ export declare class StringElementClass extends BaseUiElement<StringElement> imp
858
1559
  * Constructs a new `StringElementClass` instance.
859
1560
  *
860
1561
  * @param value - Text value
1562
+
1563
+ Text to render. Supply plain text; this field is not a Markdown or HTML document.
861
1564
  * @param options - Optional component settings. (representation (defaults to `plain`), modifiers).
862
1565
  */
863
1566
  constructor(value: string, options?: {
@@ -869,8 +1572,7 @@ export declare class StringElementClass extends BaseUiElement<StringElement> imp
869
1572
  * Class implementation of the `StringsElement` interface.
870
1573
  *
871
1574
  * @remarks
872
- * Collection of textual string values rendered as a sequence of inline items or chips.
873
- * Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
1575
+ * Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
874
1576
  */
875
1577
  export declare class StringsElementClass extends BaseUiElement<StringsElement> implements StringsElement {
876
1578
  /**
@@ -879,15 +1581,28 @@ export declare class StringsElementClass extends BaseUiElement<StringsElement> i
879
1581
  * @defaultValue "strings"
880
1582
  */
881
1583
  readonly type = "strings";
882
- /** Array of string values */
1584
+ /**
1585
+ * Array of string values
1586
+ *
1587
+ * @remarks
1588
+ * Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
1589
+ */
883
1590
  readonly values: string[];
884
1591
  /**
885
1592
  * Display representation mode (plain text or visual chips)
886
1593
  *
1594
+ * @remarks
1595
+ * Selects whether values appear as ordinary inline text or as separate visual chips. The default uses the plain representation.
1596
+ *
887
1597
  * @defaultValue StringRepresentation.plain
888
1598
  */
889
1599
  readonly representation?: StringRepresentation;
890
- /** Optional visual separator rendered between sequential values */
1600
+ /**
1601
+ * Optional visual separator rendered between sequential values
1602
+ *
1603
+ * @remarks
1604
+ * Separator inserted between adjacent values in plain representation. It does not become part of any value.
1605
+ */
891
1606
  readonly separator?: Separator;
892
1607
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
893
1608
  readonly modifiers?: PrimitiveModifiers;
@@ -895,6 +1610,8 @@ export declare class StringsElementClass extends BaseUiElement<StringsElement> i
895
1610
  * Constructs a new `StringsElementClass` instance.
896
1611
  *
897
1612
  * @param values - Array of string values
1613
+
1614
+ Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
898
1615
  * @param options - Optional component settings. (representation (defaults to `plain`), separator, modifiers).
899
1616
  */
900
1617
  constructor(values: string[], options?: {
@@ -907,7 +1624,7 @@ export declare class StringsElementClass extends BaseUiElement<StringsElement> i
907
1624
  * Class implementation of the `StringCodeElement` interface.
908
1625
  *
909
1626
  * @remarks
910
- * Monospace code block or formatted code snippet representation.
1627
+ * Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
911
1628
  */
912
1629
  export declare class StringCodeElementClass extends BaseUiElement<StringCodeElement> implements StringCodeElement {
913
1630
  /**
@@ -916,9 +1633,19 @@ export declare class StringCodeElementClass extends BaseUiElement<StringCodeElem
916
1633
  * @defaultValue "string-code"
917
1634
  */
918
1635
  readonly type = "string-code";
919
- /** Text value */
1636
+ /**
1637
+ * Text value
1638
+ *
1639
+ * @remarks
1640
+ * Code or text snippet to display. Include any desired line breaks in this string.
1641
+ */
920
1642
  readonly value: string;
921
- /** Optional syntax highlighting language identifier */
1643
+ /**
1644
+ * Optional syntax highlighting language identifier
1645
+ *
1646
+ * @remarks
1647
+ * Optional syntax hint for the renderer. Supported values describe highlighting modes and do not validate the snippet's syntax.
1648
+ */
922
1649
  readonly language?: CodeLanguage;
923
1650
  /** Optional visual modifiers (copyable) */
924
1651
  readonly modifiers?: BaseModifiers;
@@ -926,6 +1653,8 @@ export declare class StringCodeElementClass extends BaseUiElement<StringCodeElem
926
1653
  * Constructs a new `StringCodeElementClass` instance.
927
1654
  *
928
1655
  * @param value - Text value
1656
+
1657
+ Code or text snippet to display. Include any desired line breaks in this string.
929
1658
  * @param options - Optional component settings. (language, modifiers).
930
1659
  */
931
1660
  constructor(value: string, options?: {
@@ -937,7 +1666,7 @@ export declare class StringCodeElementClass extends BaseUiElement<StringCodeElem
937
1666
  * Class implementation of the `XmlElement` interface.
938
1667
  *
939
1668
  * @remarks
940
- * XML markup code block element.
1669
+ * Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
941
1670
  */
942
1671
  export declare class XmlElementClass extends BaseUiElement<XmlElement> implements XmlElement {
943
1672
  /**
@@ -946,7 +1675,12 @@ export declare class XmlElementClass extends BaseUiElement<XmlElement> implement
946
1675
  * @defaultValue "xml"
947
1676
  */
948
1677
  readonly type = "xml";
949
- /** XML content value */
1678
+ /**
1679
+ * XML content value
1680
+ *
1681
+ * @remarks
1682
+ * XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
1683
+ */
950
1684
  readonly value: string;
951
1685
  /** Optional visual modifiers (copyable) */
952
1686
  readonly modifiers?: BaseModifiers;
@@ -954,6 +1688,8 @@ export declare class XmlElementClass extends BaseUiElement<XmlElement> implement
954
1688
  * Constructs a new `XmlElementClass` instance.
955
1689
  *
956
1690
  * @param value - XML content value
1691
+
1692
+ XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
957
1693
  * @param options - Optional component settings. (modifiers).
958
1694
  */
959
1695
  constructor(value: string, options?: {
@@ -964,7 +1700,7 @@ export declare class XmlElementClass extends BaseUiElement<XmlElement> implement
964
1700
  * Class implementation of the `JsonElement` interface.
965
1701
  *
966
1702
  * @remarks
967
- * JSON data or structure representation element.
1703
+ * Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
968
1704
  */
969
1705
  export declare class JsonElementClass extends BaseUiElement<JsonElement> implements JsonElement {
970
1706
  /**
@@ -973,7 +1709,12 @@ export declare class JsonElementClass extends BaseUiElement<JsonElement> impleme
973
1709
  * @defaultValue "json"
974
1710
  */
975
1711
  readonly type = "json";
976
- /** JSON content value */
1712
+ /**
1713
+ * JSON content value
1714
+ *
1715
+ * @remarks
1716
+ * Serialized JSON text to render. No parsing or schema validation is implied by this element.
1717
+ */
977
1718
  readonly value: string;
978
1719
  /** Optional visual modifiers (copyable) */
979
1720
  readonly modifiers?: BaseModifiers;
@@ -981,6 +1722,8 @@ export declare class JsonElementClass extends BaseUiElement<JsonElement> impleme
981
1722
  * Constructs a new `JsonElementClass` instance.
982
1723
  *
983
1724
  * @param value - JSON content value
1725
+
1726
+ Serialized JSON text to render. No parsing or schema validation is implied by this element.
984
1727
  * @param options - Optional component settings. (modifiers).
985
1728
  */
986
1729
  constructor(value: string, options?: {
@@ -991,7 +1734,7 @@ export declare class JsonElementClass extends BaseUiElement<JsonElement> impleme
991
1734
  * Class implementation of the `StringUrlElement` interface.
992
1735
  *
993
1736
  * @remarks
994
- * Hyperlink representation for external or internal URL navigation.
1737
+ * Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
995
1738
  */
996
1739
  export declare class StringUrlElementClass extends BaseUiElement<StringUrlElement> implements StringUrlElement {
997
1740
  /**
@@ -1000,7 +1743,12 @@ export declare class StringUrlElementClass extends BaseUiElement<StringUrlElemen
1000
1743
  * @defaultValue "string-url"
1001
1744
  */
1002
1745
  readonly type = "string-url";
1003
- /** Target URL or navigation destination */
1746
+ /**
1747
+ * Target URL or navigation destination
1748
+ *
1749
+ * @remarks
1750
+ * Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
1751
+ */
1004
1752
  readonly value: string;
1005
1753
  /** Optional custom anchor text label */
1006
1754
  readonly label?: string;
@@ -1010,6 +1758,8 @@ export declare class StringUrlElementClass extends BaseUiElement<StringUrlElemen
1010
1758
  * Constructs a new `StringUrlElementClass` instance.
1011
1759
  *
1012
1760
  * @param value - Target URL or navigation destination
1761
+
1762
+ Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
1013
1763
  * @param options - Optional component settings. (label, modifiers).
1014
1764
  */
1015
1765
  constructor(value: string, options?: {
@@ -1021,7 +1771,7 @@ export declare class StringUrlElementClass extends BaseUiElement<StringUrlElemen
1021
1771
  * Class implementation of the `IdentifierElement` interface.
1022
1772
  *
1023
1773
  * @remarks
1024
- * Monospace semantic identifier representation.
1774
+ * Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
1025
1775
  */
1026
1776
  export declare class IdentifierElementClass extends BaseUiElement<IdentifierElement> implements IdentifierElement {
1027
1777
  /**
@@ -1030,7 +1780,12 @@ export declare class IdentifierElementClass extends BaseUiElement<IdentifierElem
1030
1780
  * @defaultValue "identifier"
1031
1781
  */
1032
1782
  readonly type = "identifier";
1033
- /** Identifier string value */
1783
+ /**
1784
+ * Identifier string value
1785
+ *
1786
+ * @remarks
1787
+ * Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
1788
+ */
1034
1789
  readonly value: string;
1035
1790
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
1036
1791
  readonly modifiers?: PrimitiveModifiers;
@@ -1038,6 +1793,8 @@ export declare class IdentifierElementClass extends BaseUiElement<IdentifierElem
1038
1793
  * Constructs a new `IdentifierElementClass` instance.
1039
1794
  *
1040
1795
  * @param value - Identifier string value
1796
+
1797
+ Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
1041
1798
  * @param options - Optional component settings. (modifiers).
1042
1799
  */
1043
1800
  constructor(value: string, options?: {
@@ -1048,7 +1805,7 @@ export declare class IdentifierElementClass extends BaseUiElement<IdentifierElem
1048
1805
  * Class implementation of the `RatioElement` interface.
1049
1806
  *
1050
1807
  * @remarks
1051
- * Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
1808
+ * Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
1052
1809
  */
1053
1810
  export declare class RatioElementClass extends BaseUiElement<RatioElement> implements RatioElement {
1054
1811
  /**
@@ -1057,7 +1814,12 @@ export declare class RatioElementClass extends BaseUiElement<RatioElement> imple
1057
1814
  * @defaultValue "ratio"
1058
1815
  */
1059
1816
  readonly type = "ratio";
1060
- /** Aspect ratio numerical expression */
1817
+ /**
1818
+ * Aspect ratio numerical expression
1819
+ *
1820
+ * @remarks
1821
+ * Numeric ratio value used by the renderer to produce an aspect-ratio display.
1822
+ */
1061
1823
  readonly value: number;
1062
1824
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
1063
1825
  readonly modifiers?: PrimitiveModifiers;
@@ -1065,6 +1827,8 @@ export declare class RatioElementClass extends BaseUiElement<RatioElement> imple
1065
1827
  * Constructs a new `RatioElementClass` instance.
1066
1828
  *
1067
1829
  * @param value - Aspect ratio numerical expression
1830
+
1831
+ Numeric ratio value used by the renderer to produce an aspect-ratio display.
1068
1832
  * @param options - Optional component settings. (modifiers).
1069
1833
  */
1070
1834
  constructor(value: number, options?: {
@@ -1075,7 +1839,7 @@ export declare class RatioElementClass extends BaseUiElement<RatioElement> imple
1075
1839
  * Class implementation of the `DimensionsElement` interface.
1076
1840
  *
1077
1841
  * @remarks
1078
- * Image dimensions representation displaying formatted width and height in pixels.
1842
+ * Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
1079
1843
  */
1080
1844
  export declare class DimensionsElementClass extends BaseUiElement<DimensionsElement> implements DimensionsElement {
1081
1845
  /**
@@ -1084,9 +1848,19 @@ export declare class DimensionsElementClass extends BaseUiElement<DimensionsElem
1084
1848
  * @defaultValue "dimensions"
1085
1849
  */
1086
1850
  readonly type = "dimensions";
1087
- /** Width in pixels */
1851
+ /**
1852
+ * Width in pixels
1853
+ *
1854
+ * @remarks
1855
+ * Horizontal pixel count. Values below one are rejected by the schema constraint.
1856
+ */
1088
1857
  readonly width: number;
1089
- /** Height in pixels */
1858
+ /**
1859
+ * Height in pixels
1860
+ *
1861
+ * @remarks
1862
+ * Vertical pixel count. Values below one are rejected by the schema constraint.
1863
+ */
1090
1864
  readonly height: number;
1091
1865
  /** Optional visual modifiers (copyable) */
1092
1866
  readonly modifiers?: BaseModifiers;
@@ -1094,7 +1868,11 @@ export declare class DimensionsElementClass extends BaseUiElement<DimensionsElem
1094
1868
  * Constructs a new `DimensionsElementClass` instance.
1095
1869
  *
1096
1870
  * @param width - Width in pixels
1871
+
1872
+ Horizontal pixel count. Values below one are rejected by the schema constraint.
1097
1873
  * @param height - Height in pixels
1874
+
1875
+ Vertical pixel count. Values below one are rejected by the schema constraint.
1098
1876
  * @param options - Optional component settings. (modifiers).
1099
1877
  */
1100
1878
  constructor(width: number, height: number, options?: {
@@ -1105,7 +1883,7 @@ export declare class DimensionsElementClass extends BaseUiElement<DimensionsElem
1105
1883
  * Class implementation of the `ColourElement` interface.
1106
1884
  *
1107
1885
  * @remarks
1108
- * Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
1886
+ * Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
1109
1887
  */
1110
1888
  export declare class ColourElementClass extends BaseUiElement<ColourElement> implements ColourElement {
1111
1889
  /**
@@ -1114,25 +1892,44 @@ export declare class ColourElementClass extends BaseUiElement<ColourElement> imp
1114
1892
  * @defaultValue "color"
1115
1893
  */
1116
1894
  readonly type = "color";
1117
- /** Hexadecimal color code */
1895
+ /**
1896
+ * Hexadecimal color code
1897
+ *
1898
+ * @remarks
1899
+ * Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
1900
+ */
1118
1901
  readonly value: string;
1119
- /** Optional descriptive color name label */
1902
+ /**
1903
+ * Optional descriptive color name label
1904
+ *
1905
+ * @remarks
1906
+ * Human-readable color name available to the renderer when text is shown.
1907
+ */
1120
1908
  readonly label?: string;
1121
1909
  /**
1122
1910
  * Whether to display the textual color code or label next to the swatch
1123
1911
  *
1912
+ * @remarks
1913
+ * When true, allows the renderer to show the color's text label alongside the swatch. The default is true.
1914
+ *
1124
1915
  * @defaultValue true
1125
1916
  */
1126
1917
  readonly showText?: boolean;
1127
1918
  /**
1128
1919
  * Visual shape of the color indicator
1129
1920
  *
1921
+ * @remarks
1922
+ * Geometry used for the swatch; defaults to a circle.
1923
+ *
1130
1924
  * @defaultValue Shape.circle
1131
1925
  */
1132
1926
  readonly shape?: Shape;
1133
1927
  /**
1134
1928
  * Visual size of the color indicator
1135
1929
  *
1930
+ * @remarks
1931
+ * Relative size class for the swatch; defaults to medium.
1932
+ *
1136
1933
  * @defaultValue Size.medium
1137
1934
  */
1138
1935
  readonly size?: Size;
@@ -1142,6 +1939,8 @@ export declare class ColourElementClass extends BaseUiElement<ColourElement> imp
1142
1939
  * Constructs a new `ColourElementClass` instance.
1143
1940
  *
1144
1941
  * @param value - Hexadecimal color code
1942
+
1943
+ Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
1145
1944
  * @param options - Optional component settings. (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
1146
1945
  */
1147
1946
  constructor(value: string, options?: {
@@ -1156,7 +1955,7 @@ export declare class ColourElementClass extends BaseUiElement<ColourElement> imp
1156
1955
  * Class implementation of the `NumberUnboundedElement` interface.
1157
1956
  *
1158
1957
  * @remarks
1159
- * Plain unbounded numeric value primitive element.
1958
+ * Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
1160
1959
  */
1161
1960
  export declare class NumberUnboundedElementClass extends BaseUiElement<NumberUnboundedElement> implements NumberUnboundedElement {
1162
1961
  /**
@@ -1165,9 +1964,19 @@ export declare class NumberUnboundedElementClass extends BaseUiElement<NumberUnb
1165
1964
  * @defaultValue "number-unbounded"
1166
1965
  */
1167
1966
  readonly type = "number-unbounded";
1168
- /** Numeric value */
1967
+ /**
1968
+ * Numeric value
1969
+ *
1970
+ * @remarks
1971
+ * Number to display. Its meaning and any valid range are defined by the producing feature.
1972
+ */
1169
1973
  readonly value: number;
1170
- /** Optional unit suffix (e.g. "px", "ms", "MB") */
1974
+ /**
1975
+ * Optional unit suffix (e.g. "px", "ms", "MB")
1976
+ *
1977
+ * @remarks
1978
+ * Short unit label appended or otherwise associated with the displayed value. Include only the unit text, not a second copy of the number.
1979
+ */
1171
1980
  readonly unit?: string;
1172
1981
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
1173
1982
  readonly modifiers?: PrimitiveModifiers;
@@ -1175,6 +1984,8 @@ export declare class NumberUnboundedElementClass extends BaseUiElement<NumberUnb
1175
1984
  * Constructs a new `NumberUnboundedElementClass` instance.
1176
1985
  *
1177
1986
  * @param value - Numeric value
1987
+
1988
+ Number to display. Its meaning and any valid range are defined by the producing feature.
1178
1989
  * @param options - Optional component settings. (unit, modifiers).
1179
1990
  */
1180
1991
  constructor(value: number, options?: {
@@ -1186,7 +1997,7 @@ export declare class NumberUnboundedElementClass extends BaseUiElement<NumberUnb
1186
1997
  * Class implementation of the `NumberBoundedStarsElement` interface.
1187
1998
  *
1188
1999
  * @remarks
1189
- * Bounded numeric rating represented as visual stars.
2000
+ * Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
1190
2001
  */
1191
2002
  export declare class NumberBoundedStarsElementClass extends BaseUiElement<NumberBoundedStarsElement> implements NumberBoundedStarsElement {
1192
2003
  /**
@@ -1195,9 +2006,19 @@ export declare class NumberBoundedStarsElementClass extends BaseUiElement<Number
1195
2006
  * @defaultValue "number-stars"
1196
2007
  */
1197
2008
  readonly type = "number-stars";
1198
- /** Numeric rating score */
2009
+ /**
2010
+ * Numeric rating score
2011
+ *
2012
+ * @remarks
2013
+ * Score represented by the filled portion of the star display.
2014
+ */
1199
2015
  readonly value: number;
1200
- /** Maximum rating scale (defaults to 5) */
2016
+ /**
2017
+ * Maximum rating scale (defaults to 5)
2018
+ *
2019
+ * @remarks
2020
+ * Upper end of the rating scale. When omitted, the scale is five; value should use the same scale.
2021
+ */
1201
2022
  readonly maximum?: number;
1202
2023
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
1203
2024
  readonly modifiers?: PrimitiveModifiers;
@@ -1205,6 +2026,8 @@ export declare class NumberBoundedStarsElementClass extends BaseUiElement<Number
1205
2026
  * Constructs a new `NumberBoundedStarsElementClass` instance.
1206
2027
  *
1207
2028
  * @param value - Numeric rating score
2029
+
2030
+ Score represented by the filled portion of the star display.
1208
2031
  * @param options - Optional component settings. (maximum, modifiers).
1209
2032
  */
1210
2033
  constructor(value: number, options?: {
@@ -1216,24 +2039,49 @@ export declare class NumberBoundedStarsElementClass extends BaseUiElement<Number
1216
2039
  * Class implementation of the `NumberBoundedMeterElement` interface.
1217
2040
  *
1218
2041
  * @remarks
1219
- * Bounded numeric meter representation (read-only progress / score bar).
2042
+ * Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
1220
2043
  */
1221
2044
  export declare class NumberBoundedMeterElementClass extends BaseUiElement<NumberBoundedMeterElement> implements NumberBoundedMeterElement {
1222
2045
  /**
1223
- * Discriminator identifier for `NumberBoundedMeterElement`.
2046
+ * Discriminator identifier for `NumberBoundedMeterElement`.
2047
+ *
2048
+ * @defaultValue "number-meter"
2049
+ */
2050
+ readonly type = "number-meter";
2051
+ /**
2052
+ * Numeric value
2053
+ *
2054
+ * @remarks
2055
+ * Current measurement or score represented by the meter.
2056
+ */
2057
+ readonly value: number;
2058
+ /**
2059
+ * Minimum scale bound (defaults to 0)
2060
+ *
2061
+ * @remarks
2062
+ * Lower end of the meter range. Defaults to zero when omitted.
2063
+ */
2064
+ readonly minimum?: number;
2065
+ /**
2066
+ * Maximum scale bound (e.g. 100)
2067
+ *
2068
+ * @remarks
2069
+ * Upper end of the meter range. Choose a bound consistent with value and minimum.
2070
+ */
2071
+ readonly maximum?: number;
2072
+ /**
2073
+ * Optional custom text label override (e.g. "68 / 100")
1224
2074
  *
1225
- * @defaultValue "number-meter"
2075
+ * @remarks
2076
+ * Optional readout text to use instead of a renderer-generated value and range label.
1226
2077
  */
1227
- readonly type = "number-meter";
1228
- /** Numeric value */
1229
- readonly value: number;
1230
- /** Minimum scale bound (defaults to 0) */
1231
- readonly minimum?: number;
1232
- /** Maximum scale bound (e.g. 100) */
1233
- readonly maximum?: number;
1234
- /** Optional custom text label override (e.g. "68 / 100") */
1235
2078
  readonly label?: string;
1236
- /** Optional unit suffix (e.g. "%") */
2079
+ /**
2080
+ * Optional unit suffix (e.g. "%")
2081
+ *
2082
+ * @remarks
2083
+ * Unit associated with the value, such as a percent sign. This affects display only and does not convert the numeric value.
2084
+ */
1237
2085
  readonly unit?: string;
1238
2086
  /** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
1239
2087
  readonly modifiers?: PrimitiveModifiers;
@@ -1241,6 +2089,8 @@ export declare class NumberBoundedMeterElementClass extends BaseUiElement<Number
1241
2089
  * Constructs a new `NumberBoundedMeterElementClass` instance.
1242
2090
  *
1243
2091
  * @param value - Numeric value
2092
+
2093
+ Current measurement or score represented by the meter.
1244
2094
  * @param options - Optional component settings. (minimum, maximum, label, unit, modifiers).
1245
2095
  */
1246
2096
  constructor(value: number, options?: {
@@ -1255,8 +2105,7 @@ export declare class NumberBoundedMeterElementClass extends BaseUiElement<Number
1255
2105
  * Class implementation of the `BooleanElement` interface.
1256
2106
  *
1257
2107
  * @remarks
1258
- * Universal boolean primitive element.
1259
- * Supports standard plain text or badge pill presentation with customizable labels and variants.
2108
+ * Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
1260
2109
  */
1261
2110
  export declare class BooleanElementClass extends BaseUiElement<BooleanElement> implements BooleanElement {
1262
2111
  /**
@@ -1265,29 +2114,46 @@ export declare class BooleanElementClass extends BaseUiElement<BooleanElement> i
1265
2114
  * @defaultValue "boolean"
1266
2115
  */
1267
2116
  readonly type = "boolean";
1268
- /** Boolean state value */
2117
+ /**
2118
+ * Boolean state value
2119
+ *
2120
+ * @remarks
2121
+ * State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
2122
+ */
1269
2123
  readonly value: boolean;
1270
2124
  /**
1271
2125
  * Display representation mode
1272
2126
  *
2127
+ * @remarks
2128
+ * Selects ordinary text or a badge pill. Badge color applies only to badge presentation.
2129
+ *
1273
2130
  * @defaultValue BooleanRepresentation.plain
1274
2131
  */
1275
2132
  readonly representation?: BooleanRepresentation;
1276
2133
  /**
1277
2134
  * Custom display label when true (defaults to "true")
1278
2135
  *
2136
+ * @remarks
2137
+ * Text used for the true state in plain representation. Defaults to the literal text true.
2138
+ *
1279
2139
  * @defaultValue "true"
1280
2140
  */
1281
2141
  readonly trueLabel?: string;
1282
2142
  /**
1283
2143
  * Custom display label when false (defaults to "false")
1284
2144
  *
2145
+ * @remarks
2146
+ * Text used for the false state in plain representation. Defaults to the literal text false.
2147
+ *
1285
2148
  * @defaultValue "false"
1286
2149
  */
1287
2150
  readonly falseLabel?: string;
1288
2151
  /**
1289
2152
  * Badge color tone when rendered as badge
1290
2153
  *
2154
+ * @remarks
2155
+ * Semantic color treatment for badge presentation; it has no effect in plain representation.
2156
+ *
1291
2157
  * @defaultValue BadgeVariant.neutral
1292
2158
  */
1293
2159
  readonly variant?: BadgeVariant;
@@ -1297,6 +2163,8 @@ export declare class BooleanElementClass extends BaseUiElement<BooleanElement> i
1297
2163
  * Constructs a new `BooleanElementClass` instance.
1298
2164
  *
1299
2165
  * @param value - Boolean state value
2166
+
2167
+ State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
1300
2168
  * @param options - Optional component settings. (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
1301
2169
  */
1302
2170
  constructor(value: boolean, options?: {
@@ -1311,7 +2179,7 @@ export declare class BooleanElementClass extends BaseUiElement<BooleanElement> i
1311
2179
  * Class implementation of the `TimestampElement` interface.
1312
2180
  *
1313
2181
  * @remarks
1314
- * Formatted date and time representation.
2182
+ * Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
1315
2183
  */
1316
2184
  export declare class TimestampElementClass extends BaseUiElement<TimestampElement> implements TimestampElement {
1317
2185
  /**
@@ -1320,11 +2188,19 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
1320
2188
  * @defaultValue "timestamp"
1321
2189
  */
1322
2190
  readonly type = "timestamp";
1323
- /** The timestamp in milliseconds */
2191
+ /**
2192
+ * The timestamp in milliseconds
2193
+ *
2194
+ * @remarks
2195
+ * Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
2196
+ */
1324
2197
  readonly value: number;
1325
2198
  /**
1326
2199
  * Presentation date/time format
1327
2200
  *
2201
+ * @remarks
2202
+ * Controls whether the timestamp is shown as date and time, date only, time only, or relative text. The default is datetime.
2203
+ *
1328
2204
  * @defaultValue TimestampFormat.datetime
1329
2205
  */
1330
2206
  readonly format?: TimestampFormat;
@@ -1334,6 +2210,8 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
1334
2210
  * Constructs a new `TimestampElementClass` instance.
1335
2211
  *
1336
2212
  * @param value - The timestamp in milliseconds
2213
+
2214
+ Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
1337
2215
  * @param options - Optional component settings. (format (defaults to `datetime`), modifiers).
1338
2216
  */
1339
2217
  constructor(value: number, options?: {
@@ -1345,7 +2223,7 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
1345
2223
  * Class implementation of the `ImageReferenceElement` interface.
1346
2224
  *
1347
2225
  * @remarks
1348
- * Thumbnail image reference with placeholder fallback handling.
2226
+ * References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
1349
2227
  */
1350
2228
  export declare class ImageReferenceElementClass extends BaseUiElement<ImageReferenceElement> implements ImageReferenceElement {
1351
2229
  /**
@@ -1354,22 +2232,42 @@ export declare class ImageReferenceElementClass extends BaseUiElement<ImageRefer
1354
2232
  * @defaultValue "image-ref"
1355
2233
  */
1356
2234
  readonly type = "image-ref";
1357
- /** Image source URI (HTTPS URL, base64 data URI, or asset path) */
2235
+ /**
2236
+ * Image source URI (HTTPS URL, base64 data URI, or asset path)
2237
+ *
2238
+ * @remarks
2239
+ * Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
2240
+ */
1358
2241
  readonly src: string;
1359
- /** Accessible alternative description */
2242
+ /**
2243
+ * Accessible alternative description
2244
+ *
2245
+ * @remarks
2246
+ * Alternative text describing the image for assistive technology. Provide meaningful text when the image conveys information; omit it only when it is decorative.
2247
+ */
1360
2248
  readonly alt?: string;
1361
2249
  /**
1362
2250
  * Aspect ratio of the thumbnail container
1363
2251
  *
2252
+ * @remarks
2253
+ * Preferred ratio of the rendered thumbnail container, expressed as a ratio string such as 1:1. It controls presentation rather than modifying the source image.
2254
+ *
1364
2255
  * @defaultValue "1:1"
1365
2256
  */
1366
2257
  readonly aspectRatio?: string;
1367
- /** Fallback placeholder image URI */
2258
+ /**
2259
+ * Fallback placeholder image URI
2260
+ *
2261
+ * @remarks
2262
+ * Optional source to display when the primary image cannot be loaded. It follows the same URI conventions as src.
2263
+ */
1368
2264
  readonly placeholder?: string;
1369
2265
  /**
1370
2266
  * Constructs a new `ImageReferenceElementClass` instance.
1371
2267
  *
1372
2268
  * @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
2269
+
2270
+ Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
1373
2271
  * @param options - Optional component settings. (alt, aspectRatio (defaults to `1:1`), placeholder).
1374
2272
  */
1375
2273
  constructor(src: string, options?: {
@@ -1382,7 +2280,7 @@ export declare class ImageReferenceElementClass extends BaseUiElement<ImageRefer
1382
2280
  * Class implementation of the `ButtonActionElement` interface.
1383
2281
  *
1384
2282
  * @remarks
1385
- * Interactive button action triggering an extension command.
2283
+ * When activated, the client dispatches commandId to the specified extension and may include target and parameters as command input. disabled and variant affect presentation and availability, not the command's authorization.
1386
2284
  */
1387
2285
  export declare class ButtonActionElementClass extends BaseUiAction<ButtonActionElement> implements ButtonActionElement {
1388
2286
  /**
@@ -1391,25 +2289,56 @@ export declare class ButtonActionElementClass extends BaseUiAction<ButtonActionE
1391
2289
  * @defaultValue "button"
1392
2290
  */
1393
2291
  readonly type = "button";
1394
- /** Command identifier to invoke */
2292
+ /**
2293
+ * Command identifier to invoke
2294
+ *
2295
+ * @remarks
2296
+ * Identifier of the registered extension command to dispatch when the button is activated.
2297
+ */
1395
2298
  readonly commandId: string;
1396
- /** Display label for the action */
2299
+ /**
2300
+ * Display label for the action
2301
+ *
2302
+ * @remarks
2303
+ * User-facing label shown on the control. Keep it short and action-oriented.
2304
+ */
1397
2305
  readonly label: string;
1398
- /** Extension identifier owning the target command */
2306
+ /**
2307
+ * Extension identifier owning the target command
2308
+ *
2309
+ * @remarks
2310
+ * Extension that registers commandId. Omit only when the client can resolve the command in the current extension context.
2311
+ */
1399
2312
  readonly extensionId?: string;
1400
- /** Target entity or context identifier */
2313
+ /**
2314
+ * Target entity or context identifier
2315
+ *
2316
+ * @remarks
2317
+ * Optional entity or context identifier forwarded to the command handler. Its format is determined by the target extension.
2318
+ */
1401
2319
  readonly target?: string;
1402
- /** Optional arbitrary parameters payload forwarded to the command handler */
2320
+ /**
2321
+ * Optional arbitrary parameters payload forwarded to the command handler
2322
+ *
2323
+ * @remarks
2324
+ * JSON-compatible arguments passed to the extension command. Define and validate their shape in the command implementation.
2325
+ */
1403
2326
  readonly parameters?: Record<string, unknown>;
1404
2327
  /**
1405
2328
  * Whether the button is disabled / unavailable
1406
2329
  *
2330
+ * @remarks
2331
+ * When true, the client renders the action as unavailable and should not dispatch it from user activation.
2332
+ *
1407
2333
  * @defaultValue false
1408
2334
  */
1409
2335
  readonly disabled?: boolean;
1410
2336
  /**
1411
2337
  * Button visual style variant
1412
2338
  *
2339
+ * @remarks
2340
+ * Selects the button's emphasis style. Use danger for destructive operations and primary for the main recommended action; the variant does not change behavior.
2341
+ *
1413
2342
  * @defaultValue ButtonVariant.secondary
1414
2343
  */
1415
2344
  readonly variant?: ButtonVariant;
@@ -1417,7 +2346,11 @@ export declare class ButtonActionElementClass extends BaseUiAction<ButtonActionE
1417
2346
  * Constructs a new `ButtonActionElementClass` instance.
1418
2347
  *
1419
2348
  * @param commandId - Command identifier to invoke
2349
+
2350
+ Identifier of the registered extension command to dispatch when the button is activated.
1420
2351
  * @param label - Display label for the action
2352
+
2353
+ User-facing label shown on the control. Keep it short and action-oriented.
1421
2354
  * @param options - Optional component settings. (extensionId, target, parameters, disabled (defaults to `false`), variant (defaults to `secondary`)).
1422
2355
  */
1423
2356
  constructor(commandId: string, label: string, options?: {
@@ -1432,7 +2365,7 @@ export declare class ButtonActionElementClass extends BaseUiAction<ButtonActionE
1432
2365
  * Class implementation of the `ExternalLinkActionElement` interface.
1433
2366
  *
1434
2367
  * @remarks
1435
- * External link action distinct from inline URL text values.
2368
+ * Renders a user-invokable action that opens a destination externally. Use StringUrlElement for a link embedded in content rather than an action control.
1436
2369
  */
1437
2370
  export declare class ExternalLinkActionElementClass extends BaseUiAction<ExternalLinkActionElement> implements ExternalLinkActionElement {
1438
2371
  /**
@@ -1441,15 +2374,29 @@ export declare class ExternalLinkActionElementClass extends BaseUiAction<Externa
1441
2374
  * @defaultValue "external-link"
1442
2375
  */
1443
2376
  readonly type = "external-link";
1444
- /** Target URL destination */
2377
+ /**
2378
+ * Target URL destination
2379
+ *
2380
+ * @remarks
2381
+ * External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
2382
+ */
1445
2383
  readonly url: string;
1446
- /** Display label for the action */
2384
+ /**
2385
+ * Display label for the action
2386
+ *
2387
+ * @remarks
2388
+ * User-facing label shown on the control. Keep it short and action-oriented.
2389
+ */
1447
2390
  readonly label: string;
1448
2391
  /**
1449
2392
  * Constructs a new `ExternalLinkActionElementClass` instance.
1450
2393
  *
1451
2394
  * @param url - Target URL destination
2395
+
2396
+ External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
1452
2397
  * @param label - Display label for the action
2398
+
2399
+ User-facing label shown on the control. Keep it short and action-oriented.
1453
2400
  */
1454
2401
  constructor(url: string, label: string);
1455
2402
  }
@@ -1457,7 +2404,7 @@ export declare class ExternalLinkActionElementClass extends BaseUiAction<Externa
1457
2404
  * Class implementation of the `MarkdownBlockElement` interface.
1458
2405
  *
1459
2406
  * @remarks
1460
- * Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling.
2407
+ * Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
1461
2408
  */
1462
2409
  export declare class MarkdownBlockElementClass extends BaseUiElement<MarkdownBlockElement> implements MarkdownBlockElement {
1463
2410
  /**
@@ -1466,7 +2413,12 @@ export declare class MarkdownBlockElementClass extends BaseUiElement<MarkdownBlo
1466
2413
  * @defaultValue "markdown"
1467
2414
  */
1468
2415
  readonly type = "markdown";
1469
- /** Raw Markdown markup content */
2416
+ /**
2417
+ * Raw Markdown markup content
2418
+ *
2419
+ * @remarks
2420
+ * Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
2421
+ */
1470
2422
  readonly content: string;
1471
2423
  /** Optional visual modifiers (copyable) */
1472
2424
  readonly modifiers?: BaseModifiers;
@@ -1474,6 +2426,8 @@ export declare class MarkdownBlockElementClass extends BaseUiElement<MarkdownBlo
1474
2426
  * Constructs a new `MarkdownBlockElementClass` instance.
1475
2427
  *
1476
2428
  * @param content - Raw Markdown markup content
2429
+
2430
+ Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
1477
2431
  * @param options - Optional component settings. (modifiers).
1478
2432
  */
1479
2433
  constructor(content: string, options?: {
@@ -1484,7 +2438,7 @@ export declare class MarkdownBlockElementClass extends BaseUiElement<MarkdownBlo
1484
2438
  * Class implementation of the `HtmlBlockElement` interface.
1485
2439
  *
1486
2440
  * @remarks
1487
- * Sandboxed HTML rendering escape hatch.
2441
+ * Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
1488
2442
  */
1489
2443
  export declare class HtmlBlockElementClass extends BaseUiElement<HtmlBlockElement> implements HtmlBlockElement {
1490
2444
  /**
@@ -1493,7 +2447,12 @@ export declare class HtmlBlockElementClass extends BaseUiElement<HtmlBlockElemen
1493
2447
  * @defaultValue "html"
1494
2448
  */
1495
2449
  readonly type = "html";
1496
- /** Raw HTML markup content */
2450
+ /**
2451
+ * Raw HTML markup content
2452
+ *
2453
+ * @remarks
2454
+ * HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
2455
+ */
1497
2456
  readonly content: string;
1498
2457
  /** Optional visual modifiers (copyable) */
1499
2458
  readonly modifiers?: BaseModifiers;
@@ -1501,6 +2460,8 @@ export declare class HtmlBlockElementClass extends BaseUiElement<HtmlBlockElemen
1501
2460
  * Constructs a new `HtmlBlockElementClass` instance.
1502
2461
  *
1503
2462
  * @param content - Raw HTML markup content
2463
+
2464
+ HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
1504
2465
  * @param options - Optional component settings. (modifiers).
1505
2466
  */
1506
2467
  constructor(content: string, options?: {
@@ -1511,19 +2472,36 @@ export declare class HtmlBlockElementClass extends BaseUiElement<HtmlBlockElemen
1511
2472
  * Class implementation of the `Slot` interface.
1512
2473
  *
1513
2474
  * @remarks
1514
- * Single slot within a multi-slot horizontal row layout.
2475
+ * A slot combines an optional label, a relative width, and one visual child. Slot widths are percentages of the row and should be chosen so the full row's widths form a usable layout.
1515
2476
  */
1516
2477
  export declare class SlotClass extends ViewKitNode<Slot> implements Slot {
1517
- /** Rendered content inside the slot */
2478
+ /**
2479
+ * Rendered content inside the slot
2480
+ *
2481
+ * @remarks
2482
+ * One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
2483
+ */
1518
2484
  readonly content: UiElement;
1519
- /** Optional slot label (e.g. "Slot A") */
2485
+ /**
2486
+ * Optional slot label (e.g. "Slot A")
2487
+ *
2488
+ * @remarks
2489
+ * Short text identifying this region of the row. It is independent of the rendered content.
2490
+ */
1520
2491
  readonly label?: string;
1521
- /** Width percentage (1-100) */
2492
+ /**
2493
+ * Width percentage (1-100)
2494
+ *
2495
+ * @remarks
2496
+ * Relative share of the row width. The schema constrains explicit values to the inclusive range 1 through 100.
2497
+ */
1522
2498
  readonly width?: number;
1523
2499
  /**
1524
2500
  * Constructs a new `SlotClass` instance.
1525
2501
  *
1526
2502
  * @param content - Rendered content inside the slot
2503
+
2504
+ One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
1527
2505
  * @param options - Optional component settings. (label, width).
1528
2506
  */
1529
2507
  constructor(content: UiElement, options?: {
@@ -1535,7 +2513,7 @@ export declare class SlotClass extends ViewKitNode<Slot> implements Slot {
1535
2513
  * Class implementation of the `MultiSlotElement` interface.
1536
2514
  *
1537
2515
  * @remarks
1538
- * Multi-slot horizontal row layout comprising slots with individual widths.
2516
+ * Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
1539
2517
  */
1540
2518
  export declare class MultiSlotElementClass extends BaseUiElement<MultiSlotElement> implements MultiSlotElement {
1541
2519
  /**
@@ -1544,12 +2522,19 @@ export declare class MultiSlotElementClass extends BaseUiElement<MultiSlotElemen
1544
2522
  * @defaultValue "multi-slot"
1545
2523
  */
1546
2524
  readonly type = "multi-slot";
1547
- /** List of slots comprising the row */
2525
+ /**
2526
+ * List of slots comprising the row
2527
+ *
2528
+ * @remarks
2529
+ * Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
2530
+ */
1548
2531
  readonly slots: Slot[];
1549
2532
  /**
1550
2533
  * Constructs a new `MultiSlotElementClass` instance.
1551
2534
  *
1552
2535
  * @param slots - List of slots comprising the row
2536
+
2537
+ Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
1553
2538
  */
1554
2539
  constructor(slots: Slot[]);
1555
2540
  }
@@ -1557,8 +2542,7 @@ export declare class MultiSlotElementClass extends BaseUiElement<MultiSlotElemen
1557
2542
  * Class implementation of the `FlowingElement` interface.
1558
2543
  *
1559
2544
  * @remarks
1560
- * Flowing inline layout container with automatic line wrapping.
1561
- * Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
2545
+ * Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
1562
2546
  */
1563
2547
  export declare class FlowingElementClass extends BaseUiElement<FlowingElement> implements FlowingElement {
1564
2548
  /**
@@ -1567,14 +2551,26 @@ export declare class FlowingElementClass extends BaseUiElement<FlowingElement> i
1567
2551
  * @defaultValue "flowing"
1568
2552
  */
1569
2553
  readonly type = "flowing";
1570
- /** List of child elements rendered sequentially with line wrapping */
2554
+ /**
2555
+ * List of child elements rendered sequentially with line wrapping
2556
+ *
2557
+ * @remarks
2558
+ * Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
2559
+ */
1571
2560
  readonly elements: UiElement[];
1572
- /** Optional visual separator rendered between sequential child elements */
2561
+ /**
2562
+ * Optional visual separator rendered between sequential child elements
2563
+ *
2564
+ * @remarks
2565
+ * Separator placed between adjacent elements. Omit it when spacing or the child renderers already provide sufficient separation.
2566
+ */
1573
2567
  readonly separator?: Separator;
1574
2568
  /**
1575
2569
  * Constructs a new `FlowingElementClass` instance.
1576
2570
  *
1577
2571
  * @param elements - List of child elements rendered sequentially with line wrapping
2572
+
2573
+ Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
1578
2574
  * @param options - Optional component settings. (separator).
1579
2575
  */
1580
2576
  constructor(elements: UiElement[], options?: {
@@ -1585,8 +2581,7 @@ export declare class FlowingElementClass extends BaseUiElement<FlowingElement> i
1585
2581
  * Class implementation of the `LabelValueElement` interface.
1586
2582
  *
1587
2583
  * @remarks
1588
- * Standard label and value row.
1589
- * Displays a muted label on the left and value representation on the right with a vertical dividing line.
2584
+ * Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
1590
2585
  */
1591
2586
  export declare class LabelValueElementClass extends BaseUiElement<LabelValueElement> implements LabelValueElement {
1592
2587
  /**
@@ -1595,13 +2590,26 @@ export declare class LabelValueElementClass extends BaseUiElement<LabelValueElem
1595
2590
  * @defaultValue "label-value"
1596
2591
  */
1597
2592
  readonly type = "label-value";
1598
- /** Key or descriptive label displayed muted on the left */
2593
+ /**
2594
+ * Key or descriptive label displayed muted on the left
2595
+ *
2596
+ * @remarks
2597
+ * Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
2598
+ */
1599
2599
  readonly label: string;
1600
- /** Rendered value element on the right */
2600
+ /**
2601
+ * Rendered value element on the right
2602
+ *
2603
+ * @remarks
2604
+ * Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
2605
+ */
1601
2606
  readonly value: UiElement;
1602
2607
  /**
1603
2608
  * Whether to render a bottom border/hairline divider
1604
2609
  *
2610
+ * @remarks
2611
+ * Enables a horizontal separator beneath this row when true. Defaults to false.
2612
+ *
1605
2613
  * @defaultValue false
1606
2614
  */
1607
2615
  readonly withDivider?: boolean;
@@ -1609,7 +2617,11 @@ export declare class LabelValueElementClass extends BaseUiElement<LabelValueElem
1609
2617
  * Constructs a new `LabelValueElementClass` instance.
1610
2618
  *
1611
2619
  * @param label - Key or descriptive label displayed muted on the left
2620
+
2621
+ Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
1612
2622
  * @param value - Rendered value element on the right
2623
+
2624
+ Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
1613
2625
  * @param options - Optional component settings. (withDivider (defaults to `false`)).
1614
2626
  */
1615
2627
  constructor(label: string, value: UiElement, options?: {
@@ -1620,22 +2632,38 @@ export declare class LabelValueElementClass extends BaseUiElement<LabelValueElem
1620
2632
  * Class implementation of the `TableColumn` interface.
1621
2633
  *
1622
2634
  * @remarks
1623
- * Column definition for structured tables.
2635
+ * Describes one table column and its visual sizing. When columns are supplied, their order corresponds to the position of each cell in a row.
1624
2636
  */
1625
2637
  export declare class TableColumnClass extends ViewKitNode<TableColumn> implements TableColumn {
1626
- /** Display header text */
2638
+ /**
2639
+ * Display header text
2640
+ *
2641
+ * @remarks
2642
+ * Optional header shown above values in this column. Omit when the table has no header row.
2643
+ */
1627
2644
  readonly header?: string;
1628
2645
  /**
1629
2646
  * Text horizontal alignment
1630
2647
  *
2648
+ * @remarks
2649
+ * Horizontal alignment applied to cell content in the column. Defaults to left.
2650
+ *
1631
2651
  * @defaultValue TableColumnAlign.left
1632
2652
  */
1633
2653
  readonly align?: TableColumnAlign;
1634
- /** Width percentage (1-100) */
2654
+ /**
2655
+ * Width percentage (1-100)
2656
+ *
2657
+ * @remarks
2658
+ * Column width percentage used with widthMode. Explicit values are constrained to 1 through 100.
2659
+ */
1635
2660
  readonly width?: number;
1636
2661
  /**
1637
2662
  * Sizing mode for the provided width
1638
2663
  *
2664
+ * @remarks
2665
+ * Determines whether width is a fixed percentage allocation or an upper bound. Defaults to fixed.
2666
+ *
1639
2667
  * @defaultValue TableColumnWidthMode.fixed
1640
2668
  */
1641
2669
  readonly widthMode?: TableColumnWidthMode;
@@ -1655,15 +2683,22 @@ export declare class TableColumnClass extends ViewKitNode<TableColumn> implement
1655
2683
  * Class implementation of the `TableRow` interface.
1656
2684
  *
1657
2685
  * @remarks
1658
- * Single table row containing an array of cell values.
2686
+ * A row's cell array is positional: cell at each index corresponds to the column at that index. Keep row lengths aligned with the table's explicit column definitions when present.
1659
2687
  */
1660
2688
  export declare class TableRowClass extends ViewKitNode<TableRow> implements TableRow {
1661
- /** Array of cell values corresponding to table columns */
2689
+ /**
2690
+ * Array of cell values corresponding to table columns
2691
+ *
2692
+ * @remarks
2693
+ * Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
2694
+ */
1662
2695
  readonly cells: UiElement[];
1663
2696
  /**
1664
2697
  * Constructs a new `TableRowClass` instance.
1665
2698
  *
1666
2699
  * @param cells - Array of cell values corresponding to table columns
2700
+
2701
+ Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
1667
2702
  */
1668
2703
  constructor(cells: UiElement[]);
1669
2704
  }
@@ -1671,8 +2706,7 @@ export declare class TableRowClass extends ViewKitNode<TableRow> implements Tabl
1671
2706
  * Class implementation of the `TableElement` interface.
1672
2707
  *
1673
2708
  * @remarks
1674
- * Structured tabular data representation.
1675
- * Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
2709
+ * Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
1676
2710
  */
1677
2711
  export declare class TableElementClass extends BaseUiElement<TableElement> implements TableElement {
1678
2712
  /**
@@ -1681,32 +2715,53 @@ export declare class TableElementClass extends BaseUiElement<TableElement> imple
1681
2715
  * @defaultValue "table"
1682
2716
  */
1683
2717
  readonly type = "table";
1684
- /** Tabular data rows */
2718
+ /**
2719
+ * Tabular data rows
2720
+ *
2721
+ * @remarks
2722
+ * Ordered table rows. Each row's cells correspond positionally to the declared columns.
2723
+ */
1685
2724
  readonly rows: TableRow[];
1686
2725
  /**
1687
2726
  * Whether to render alternating row background colors
1688
2727
  *
2728
+ * @remarks
2729
+ * Enables alternating backgrounds across successive rows to improve scanability. Defaults to false.
2730
+ *
1689
2731
  * @defaultValue false
1690
2732
  */
1691
2733
  readonly isStriped?: boolean;
1692
2734
  /**
1693
2735
  * Whether to render vertical column separators
1694
2736
  *
2737
+ * @remarks
2738
+ * Adds vertical dividers between columns when true. Defaults to false.
2739
+ *
1695
2740
  * @defaultValue false
1696
2741
  */
1697
2742
  readonly withColumnSeparators?: boolean;
1698
2743
  /**
1699
2744
  * Whether to render horizontal row separators
1700
2745
  *
2746
+ * @remarks
2747
+ * Adds horizontal dividers between rows when true. Defaults to false.
2748
+ *
1701
2749
  * @defaultValue false
1702
2750
  */
1703
2751
  readonly withRowSeparators?: boolean;
1704
- /** Optional explicit column definitions */
2752
+ /**
2753
+ * Optional explicit column definitions
2754
+ *
2755
+ * @remarks
2756
+ * Optional ordered column metadata defining headers, alignment, and width. When omitted, the renderer may infer a basic layout from row cells.
2757
+ */
1705
2758
  readonly columns?: TableColumn[];
1706
2759
  /**
1707
2760
  * Constructs a new `TableElementClass` instance.
1708
2761
  *
1709
2762
  * @param rows - Tabular data rows
2763
+
2764
+ Ordered table rows. Each row's cells correspond positionally to the declared columns.
1710
2765
  * @param options - Optional component settings. (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
1711
2766
  */
1712
2767
  constructor(rows: TableRow[], options?: {
@@ -1720,19 +2775,36 @@ export declare class TableElementClass extends BaseUiElement<TableElement> imple
1720
2775
  * Class implementation of the `RepeatingGroupEntry` interface.
1721
2776
  *
1722
2777
  * @remarks
1723
- * Single entry within a repeating group.
2778
+ * A repeating entry carries a stable display label and either one primary value or a list of nested elements, depending on the shape needed by the feature.
1724
2779
  */
1725
2780
  export declare class RepeatingGroupEntryClass extends ViewKitNode<RepeatingGroupEntry> implements RepeatingGroupEntry {
1726
- /** Entry label */
2781
+ /**
2782
+ * Entry label
2783
+ *
2784
+ * @remarks
2785
+ * Short label identifying this entry within the repeated group.
2786
+ */
1727
2787
  readonly label: string;
1728
- /** Primary entry value or nested elements */
2788
+ /**
2789
+ * Primary entry value or nested elements
2790
+ *
2791
+ * @remarks
2792
+ * Optional primary visual value for a compact entry. Use elements for a multi-part structured entry.
2793
+ */
1729
2794
  readonly value?: UiElement;
1730
- /** Nested elements for structured entries */
2795
+ /**
2796
+ * Nested elements for structured entries
2797
+ *
2798
+ * @remarks
2799
+ * Optional ordered content for entries that require more than one value element.
2800
+ */
1731
2801
  readonly elements?: UiElement[];
1732
2802
  /**
1733
2803
  * Constructs a new `RepeatingGroupEntryClass` instance.
1734
2804
  *
1735
2805
  * @param label - Entry label
2806
+
2807
+ Short label identifying this entry within the repeated group.
1736
2808
  * @param options - Optional component settings. (value, elements).
1737
2809
  */
1738
2810
  constructor(label: string, options?: {
@@ -1744,7 +2816,7 @@ export declare class RepeatingGroupEntryClass extends ViewKitNode<RepeatingGroup
1744
2816
  * Class implementation of the `RepeatingGroupElement` interface.
1745
2817
  *
1746
2818
  * @remarks
1747
- * Repeating group container where entries share uniform structure and retain per-entry labels.
2819
+ * Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
1748
2820
  */
1749
2821
  export declare class RepeatingGroupElementClass extends BaseUiElement<RepeatingGroupElement> implements RepeatingGroupElement {
1750
2822
  /**
@@ -1753,14 +2825,26 @@ export declare class RepeatingGroupElementClass extends BaseUiElement<RepeatingG
1753
2825
  * @defaultValue "repeating-group"
1754
2826
  */
1755
2827
  readonly type = "repeating-group";
1756
- /** List of repeated entry records */
2828
+ /**
2829
+ * List of repeated entry records
2830
+ *
2831
+ * @remarks
2832
+ * Entries in display order. Each entry supplies its own label and content.
2833
+ */
1757
2834
  readonly entries: RepeatingGroupEntry[];
1758
- /** Optional section header for the group */
2835
+ /**
2836
+ * Optional section header for the group
2837
+ *
2838
+ * @remarks
2839
+ * Heading displayed for the repeated section, separate from the labels of individual entries.
2840
+ */
1759
2841
  readonly title?: string;
1760
2842
  /**
1761
2843
  * Constructs a new `RepeatingGroupElementClass` instance.
1762
2844
  *
1763
2845
  * @param entries - List of repeated entry records
2846
+
2847
+ Entries in display order. Each entry supplies its own label and content.
1764
2848
  * @param options - Optional component settings. (title).
1765
2849
  */
1766
2850
  constructor(entries: RepeatingGroupEntry[], options?: {
@@ -1771,7 +2855,7 @@ export declare class RepeatingGroupElementClass extends BaseUiElement<RepeatingG
1771
2855
  * Class implementation of the `CollapsibleGroupElement` interface.
1772
2856
  *
1773
2857
  * @remarks
1774
- * Collapsible disclosure container (accordion) with summary badge.
2858
+ * Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
1775
2859
  */
1776
2860
  export declare class CollapsibleGroupElementClass extends BaseUiElement<CollapsibleGroupElement> implements CollapsibleGroupElement {
1777
2861
  /**
@@ -1780,15 +2864,33 @@ export declare class CollapsibleGroupElementClass extends BaseUiElement<Collapsi
1780
2864
  * @defaultValue "collapsible-group"
1781
2865
  */
1782
2866
  readonly type = "collapsible-group";
1783
- /** Group title (e.g. "Show specimen details") */
2867
+ /**
2868
+ * Group title (e.g. "Show specimen details")
2869
+ *
2870
+ * @remarks
2871
+ * Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
2872
+ */
1784
2873
  readonly title: string;
1785
- /** Nested content elements revealed when expanded */
2874
+ /**
2875
+ * Nested content elements revealed when expanded
2876
+ *
2877
+ * @remarks
2878
+ * Ordered child elements made visible by expanding the group.
2879
+ */
1786
2880
  readonly elements: UiElement[];
1787
- /** Secondary summary indicator (e.g. "2 neutral values") */
2881
+ /**
2882
+ * Secondary summary indicator (e.g. "2 neutral values")
2883
+ *
2884
+ * @remarks
2885
+ * Compact contextual text shown alongside the title while the group is collapsed or expanded. It does not replace the nested content.
2886
+ */
1788
2887
  readonly summary?: string;
1789
2888
  /**
1790
2889
  * Whether the disclosure is open/expanded by default
1791
2890
  *
2891
+ * @remarks
2892
+ * Initial expanded state requested by the data. Defaults to false; subsequent interaction is managed by the client.
2893
+ *
1792
2894
  * @defaultValue false
1793
2895
  */
1794
2896
  readonly defaultExpanded?: boolean;
@@ -1796,7 +2898,11 @@ export declare class CollapsibleGroupElementClass extends BaseUiElement<Collapsi
1796
2898
  * Constructs a new `CollapsibleGroupElementClass` instance.
1797
2899
  *
1798
2900
  * @param title - Group title (e.g. "Show specimen details")
2901
+
2902
+ Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
1799
2903
  * @param elements - Nested content elements revealed when expanded
2904
+
2905
+ Ordered child elements made visible by expanding the group.
1800
2906
  * @param options - Optional component settings. (summary, defaultExpanded (defaults to `false`)).
1801
2907
  */
1802
2908
  constructor(title: string, elements: UiElement[], options?: {
@@ -1808,7 +2914,7 @@ export declare class CollapsibleGroupElementClass extends BaseUiElement<Collapsi
1808
2914
  * Class implementation of the `DividerElement` interface.
1809
2915
  *
1810
2916
  * @remarks
1811
- * Visual hairline separator separating sections or element groups.
2917
+ * A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
1812
2918
  */
1813
2919
  export declare class DividerElementClass extends BaseUiElement<DividerElement> implements DividerElement {
1814
2920
  /**
@@ -1820,6 +2926,9 @@ export declare class DividerElementClass extends BaseUiElement<DividerElement> i
1820
2926
  /**
1821
2927
  * Line styling
1822
2928
  *
2929
+ * @remarks
2930
+ * Visual stroke treatment for the separator. Defaults to a subtle hairline.
2931
+ *
1823
2932
  * @defaultValue DividerStyle.hairline
1824
2933
  */
1825
2934
  readonly style?: DividerStyle;
@@ -1836,12 +2945,15 @@ export declare class DividerElementClass extends BaseUiElement<DividerElement> i
1836
2945
  * Class implementation of the `Envelop` interface.
1837
2946
  *
1838
2947
  * @remarks
1839
- * Base envelope container model holding the schema version attribute.
2948
+ * All root ViewKit documents extend this envelope so consumers can identify the schema contract version before processing the root content.
1840
2949
  */
1841
2950
  export declare class EnvelopClass extends ViewKitNode<Envelop> implements Envelop {
1842
2951
  /**
1843
2952
  * Schema specification version
1844
2953
  *
2954
+ * @remarks
2955
+ * Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
2956
+ *
1845
2957
  * @defaultValue "1.0"
1846
2958
  */
1847
2959
  readonly schemaVersion: "1.0";
@@ -1858,14 +2970,22 @@ export declare class EnvelopClass extends ViewKitNode<Envelop> implements Envelo
1858
2970
  * Class implementation of the `UiContainer` interface.
1859
2971
  *
1860
2972
  * @remarks
1861
- * Container model representing an ordered list of visual elements.
2973
+ * Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
1862
2974
  */
1863
2975
  export declare class UiContainerClass extends ViewKitNode<UiContainer> implements UiContainer {
1864
- /** Ordered list of visual elements, structures, and content */
2976
+ /**
2977
+ * Ordered list of visual elements, structures, and content
2978
+ *
2979
+ * @remarks
2980
+ * Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
2981
+ */
1865
2982
  readonly elements: UiElement[];
1866
2983
  /**
1867
2984
  * Schema specification version
1868
2985
  *
2986
+ * @remarks
2987
+ * Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
2988
+ *
1869
2989
  * @defaultValue "1.0"
1870
2990
  */
1871
2991
  readonly schemaVersion: "1.0";
@@ -1873,6 +2993,8 @@ export declare class UiContainerClass extends ViewKitNode<UiContainer> implement
1873
2993
  * Constructs a new `UiContainerClass` instance.
1874
2994
  *
1875
2995
  * @param elements - Ordered list of visual elements, structures, and content
2996
+
2997
+ Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
1876
2998
  * @param options - Optional component settings. (schemaVersion (defaults to `1.0`)).
1877
2999
  */
1878
3000
  constructor(elements: UiElement[], options?: {
@@ -1883,21 +3005,43 @@ export declare class UiContainerClass extends ViewKitNode<UiContainer> implement
1883
3005
  * Class implementation of the `UiCard` interface.
1884
3006
  *
1885
3007
  * @remarks
1886
- * Root Card container model.
1887
- * Represents a complete feature card rendered inside the 360px panel.
3008
+ * A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
1888
3009
  */
1889
3010
  export declare class UiCardClass extends ViewKitNode<UiCard> implements UiCard {
1890
- /** Human-readable feature title displayed in the card header */
3011
+ /**
3012
+ * Human-readable feature title displayed in the card header
3013
+ *
3014
+ * @remarks
3015
+ * Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
3016
+ */
1891
3017
  readonly title: string;
1892
- /** Ordered list of visual elements, structures, and content */
3018
+ /**
3019
+ * Ordered list of visual elements, structures, and content
3020
+ *
3021
+ * @remarks
3022
+ * Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
3023
+ */
1893
3024
  readonly elements: UiElement[];
1894
- /** Optional neutral subtitle / description for the feature */
3025
+ /**
3026
+ * Optional neutral subtitle / description for the feature
3027
+ *
3028
+ * @remarks
3029
+ * Brief secondary context shown with the title. Use the content elements for detailed information rather than placing an entire report in this field.
3030
+ */
1895
3031
  readonly description?: string;
1896
- /** Optional card action buttons rendered at the base of the feature card */
3032
+ /**
3033
+ * Optional card action buttons rendered at the base of the feature card
3034
+ *
3035
+ * @remarks
3036
+ * Optional user-invokable actions shown after the card content. Their order is preserved and each action's own fields define its command or link behavior.
3037
+ */
1897
3038
  readonly actions?: UiAction[];
1898
3039
  /**
1899
3040
  * Schema specification version
1900
3041
  *
3042
+ * @remarks
3043
+ * Version of the ViewKit envelope contract. It is a literal value and should be preserved when serializing or forwarding a document.
3044
+ *
1901
3045
  * @defaultValue "1.0"
1902
3046
  */
1903
3047
  readonly schemaVersion: "1.0";
@@ -1905,7 +3049,11 @@ export declare class UiCardClass extends ViewKitNode<UiCard> implements UiCard {
1905
3049
  * Constructs a new `UiCardClass` instance.
1906
3050
  *
1907
3051
  * @param title - Human-readable feature title displayed in the card header
3052
+
3053
+ Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
1908
3054
  * @param elements - Ordered list of visual elements, structures, and content
3055
+
3056
+ Top-level visual content in render order. Use a structural element to group related children and primitive elements for individual values.
1909
3057
  * @param options - Optional component settings. (description, actions, schemaVersion (defaults to `1.0`)).
1910
3058
  */
1911
3059
  constructor(title: string, elements: UiElement[], options?: {
@@ -1918,7 +3066,7 @@ export declare class UiCardClass extends ViewKitNode<UiCard> implements UiCard {
1918
3066
  * Fluent builder for constructing strongly-typed `UiContainer` instances.
1919
3067
  *
1920
3068
  * @remarks
1921
- * Container model representing an ordered list of visual elements.
3069
+ * Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
1922
3070
  */
1923
3071
  export declare class UiContainerBuilder {
1924
3072
  private readonly _elements;
@@ -1942,10 +3090,11 @@ export declare class UiContainerBuilder {
1942
3090
  * Appends a `StringElement` component.
1943
3091
  *
1944
3092
  * @remarks
1945
- * Universal textual string primitive element.
1946
- * Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
3093
+ * Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
1947
3094
  *
1948
3095
  * @param value - Text value
3096
+
3097
+ Text to render. Supply plain text; this field is not a Markdown or HTML document.
1949
3098
  * @param options - Optional component settings (representation (defaults to `plain`), modifiers).
1950
3099
  * @returns This builder instance for method chaining.
1951
3100
  */
@@ -1957,10 +3106,11 @@ export declare class UiContainerBuilder {
1957
3106
  * Appends a `StringsElement` component.
1958
3107
  *
1959
3108
  * @remarks
1960
- * Collection of textual string values rendered as a sequence of inline items or chips.
1961
- * Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
3109
+ * Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
1962
3110
  *
1963
3111
  * @param values - Array of string values
3112
+
3113
+ Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
1964
3114
  * @param options - Optional component settings (representation (defaults to `plain`), separator, modifiers).
1965
3115
  * @returns This builder instance for method chaining.
1966
3116
  */
@@ -1973,9 +3123,11 @@ export declare class UiContainerBuilder {
1973
3123
  * Appends a `StringCodeElement` component.
1974
3124
  *
1975
3125
  * @remarks
1976
- * Monospace code block or formatted code snippet representation.
3126
+ * Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
1977
3127
  *
1978
3128
  * @param value - Text value
3129
+
3130
+ Code or text snippet to display. Include any desired line breaks in this string.
1979
3131
  * @param options - Optional component settings (language, modifiers).
1980
3132
  * @returns This builder instance for method chaining.
1981
3133
  */
@@ -1987,9 +3139,11 @@ export declare class UiContainerBuilder {
1987
3139
  * Appends a `XmlElement` component.
1988
3140
  *
1989
3141
  * @remarks
1990
- * XML markup code block element.
3142
+ * Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
1991
3143
  *
1992
3144
  * @param value - XML content value
3145
+
3146
+ XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
1993
3147
  * @param options - Optional component settings (modifiers).
1994
3148
  * @returns This builder instance for method chaining.
1995
3149
  */
@@ -2000,9 +3154,11 @@ export declare class UiContainerBuilder {
2000
3154
  * Appends a `JsonElement` component.
2001
3155
  *
2002
3156
  * @remarks
2003
- * JSON data or structure representation element.
3157
+ * Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
2004
3158
  *
2005
3159
  * @param value - JSON content value
3160
+
3161
+ Serialized JSON text to render. No parsing or schema validation is implied by this element.
2006
3162
  * @param options - Optional component settings (modifiers).
2007
3163
  * @returns This builder instance for method chaining.
2008
3164
  */
@@ -2013,9 +3169,11 @@ export declare class UiContainerBuilder {
2013
3169
  * Appends a `StringUrlElement` component.
2014
3170
  *
2015
3171
  * @remarks
2016
- * Hyperlink representation for external or internal URL navigation.
3172
+ * Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
2017
3173
  *
2018
3174
  * @param value - Target URL or navigation destination
3175
+
3176
+ Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
2019
3177
  * @param options - Optional component settings (label, modifiers).
2020
3178
  * @returns This builder instance for method chaining.
2021
3179
  */
@@ -2027,9 +3185,11 @@ export declare class UiContainerBuilder {
2027
3185
  * Appends a `IdentifierElement` component.
2028
3186
  *
2029
3187
  * @remarks
2030
- * Monospace semantic identifier representation.
3188
+ * Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
2031
3189
  *
2032
3190
  * @param value - Identifier string value
3191
+
3192
+ Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
2033
3193
  * @param options - Optional component settings (modifiers).
2034
3194
  * @returns This builder instance for method chaining.
2035
3195
  */
@@ -2040,9 +3200,11 @@ export declare class UiContainerBuilder {
2040
3200
  * Appends a `RatioElement` component.
2041
3201
  *
2042
3202
  * @remarks
2043
- * Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
3203
+ * Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
2044
3204
  *
2045
3205
  * @param value - Aspect ratio numerical expression
3206
+
3207
+ Numeric ratio value used by the renderer to produce an aspect-ratio display.
2046
3208
  * @param options - Optional component settings (modifiers).
2047
3209
  * @returns This builder instance for method chaining.
2048
3210
  */
@@ -2053,10 +3215,14 @@ export declare class UiContainerBuilder {
2053
3215
  * Appends a `DimensionsElement` component.
2054
3216
  *
2055
3217
  * @remarks
2056
- * Image dimensions representation displaying formatted width and height in pixels.
3218
+ * Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
2057
3219
  *
2058
3220
  * @param width - Width in pixels
3221
+
3222
+ Horizontal pixel count. Values below one are rejected by the schema constraint.
2059
3223
  * @param height - Height in pixels
3224
+
3225
+ Vertical pixel count. Values below one are rejected by the schema constraint.
2060
3226
  * @param options - Optional component settings (modifiers).
2061
3227
  * @returns This builder instance for method chaining.
2062
3228
  */
@@ -2067,9 +3233,11 @@ export declare class UiContainerBuilder {
2067
3233
  * Appends a `ColourElement` component.
2068
3234
  *
2069
3235
  * @remarks
2070
- * Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
3236
+ * Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
2071
3237
  *
2072
3238
  * @param value - Hexadecimal color code
3239
+
3240
+ Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
2073
3241
  * @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
2074
3242
  * @returns This builder instance for method chaining.
2075
3243
  */
@@ -2084,9 +3252,11 @@ export declare class UiContainerBuilder {
2084
3252
  * Appends a `ColourElement` component.
2085
3253
  *
2086
3254
  * @remarks
2087
- * Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
3255
+ * Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
2088
3256
  *
2089
3257
  * @param value - Hexadecimal color code
3258
+
3259
+ Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
2090
3260
  * @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
2091
3261
  * @returns This builder instance for method chaining.
2092
3262
  */
@@ -2101,9 +3271,11 @@ export declare class UiContainerBuilder {
2101
3271
  * Appends a `NumberUnboundedElement` component.
2102
3272
  *
2103
3273
  * @remarks
2104
- * Plain unbounded numeric value primitive element.
3274
+ * Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
2105
3275
  *
2106
3276
  * @param value - Numeric value
3277
+
3278
+ Number to display. Its meaning and any valid range are defined by the producing feature.
2107
3279
  * @param options - Optional component settings (unit, modifiers).
2108
3280
  * @returns This builder instance for method chaining.
2109
3281
  */
@@ -2115,9 +3287,11 @@ export declare class UiContainerBuilder {
2115
3287
  * Appends a `NumberBoundedStarsElement` component.
2116
3288
  *
2117
3289
  * @remarks
2118
- * Bounded numeric rating represented as visual stars.
3290
+ * Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
2119
3291
  *
2120
3292
  * @param value - Numeric rating score
3293
+
3294
+ Score represented by the filled portion of the star display.
2121
3295
  * @param options - Optional component settings (maximum, modifiers).
2122
3296
  * @returns This builder instance for method chaining.
2123
3297
  */
@@ -2129,9 +3303,11 @@ export declare class UiContainerBuilder {
2129
3303
  * Appends a `NumberBoundedStarsElement` component.
2130
3304
  *
2131
3305
  * @remarks
2132
- * Bounded numeric rating represented as visual stars.
3306
+ * Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
2133
3307
  *
2134
3308
  * @param value - Numeric rating score
3309
+
3310
+ Score represented by the filled portion of the star display.
2135
3311
  * @param options - Optional component settings (maximum, modifiers).
2136
3312
  * @returns This builder instance for method chaining.
2137
3313
  */
@@ -2143,9 +3319,11 @@ export declare class UiContainerBuilder {
2143
3319
  * Appends a `NumberBoundedMeterElement` component.
2144
3320
  *
2145
3321
  * @remarks
2146
- * Bounded numeric meter representation (read-only progress / score bar).
3322
+ * Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
2147
3323
  *
2148
3324
  * @param value - Numeric value
3325
+
3326
+ Current measurement or score represented by the meter.
2149
3327
  * @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
2150
3328
  * @returns This builder instance for method chaining.
2151
3329
  */
@@ -2160,9 +3338,11 @@ export declare class UiContainerBuilder {
2160
3338
  * Appends a `NumberBoundedMeterElement` component.
2161
3339
  *
2162
3340
  * @remarks
2163
- * Bounded numeric meter representation (read-only progress / score bar).
3341
+ * Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
2164
3342
  *
2165
3343
  * @param value - Numeric value
3344
+
3345
+ Current measurement or score represented by the meter.
2166
3346
  * @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
2167
3347
  * @returns This builder instance for method chaining.
2168
3348
  */
@@ -2177,10 +3357,11 @@ export declare class UiContainerBuilder {
2177
3357
  * Appends a `BooleanElement` component.
2178
3358
  *
2179
3359
  * @remarks
2180
- * Universal boolean primitive element.
2181
- * Supports standard plain text or badge pill presentation with customizable labels and variants.
3360
+ * Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
2182
3361
  *
2183
3362
  * @param value - Boolean state value
3363
+
3364
+ State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
2184
3365
  * @param options - Optional component settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
2185
3366
  * @returns This builder instance for method chaining.
2186
3367
  */
@@ -2195,9 +3376,11 @@ export declare class UiContainerBuilder {
2195
3376
  * Appends a `TimestampElement` component.
2196
3377
  *
2197
3378
  * @remarks
2198
- * Formatted date and time representation.
3379
+ * Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
2199
3380
  *
2200
3381
  * @param value - The timestamp in milliseconds
3382
+
3383
+ Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
2201
3384
  * @param options - Optional component settings (format (defaults to `datetime`), modifiers).
2202
3385
  * @returns This builder instance for method chaining.
2203
3386
  */
@@ -2209,9 +3392,11 @@ export declare class UiContainerBuilder {
2209
3392
  * Appends a `ImageReferenceElement` component.
2210
3393
  *
2211
3394
  * @remarks
2212
- * Thumbnail image reference with placeholder fallback handling.
3395
+ * References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
2213
3396
  *
2214
3397
  * @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
3398
+
3399
+ Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
2215
3400
  * @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
2216
3401
  * @returns This builder instance for method chaining.
2217
3402
  */
@@ -2224,9 +3409,11 @@ export declare class UiContainerBuilder {
2224
3409
  * Appends a `ImageReferenceElement` component.
2225
3410
  *
2226
3411
  * @remarks
2227
- * Thumbnail image reference with placeholder fallback handling.
3412
+ * References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
2228
3413
  *
2229
3414
  * @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
3415
+
3416
+ Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
2230
3417
  * @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
2231
3418
  * @returns This builder instance for method chaining.
2232
3419
  */
@@ -2239,9 +3426,11 @@ export declare class UiContainerBuilder {
2239
3426
  * Appends a `MarkdownBlockElement` component.
2240
3427
  *
2241
3428
  * @remarks
2242
- * Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling.
3429
+ * Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
2243
3430
  *
2244
3431
  * @param content - Raw Markdown markup content
3432
+
3433
+ Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
2245
3434
  * @param options - Optional component settings (modifiers).
2246
3435
  * @returns This builder instance for method chaining.
2247
3436
  */
@@ -2252,9 +3441,11 @@ export declare class UiContainerBuilder {
2252
3441
  * Appends a `MarkdownBlockElement` component.
2253
3442
  *
2254
3443
  * @remarks
2255
- * Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling.
3444
+ * Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
2256
3445
  *
2257
3446
  * @param content - Raw Markdown markup content
3447
+
3448
+ Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
2258
3449
  * @param options - Optional component settings (modifiers).
2259
3450
  * @returns This builder instance for method chaining.
2260
3451
  */
@@ -2265,9 +3456,11 @@ export declare class UiContainerBuilder {
2265
3456
  * Appends a `HtmlBlockElement` component.
2266
3457
  *
2267
3458
  * @remarks
2268
- * Sandboxed HTML rendering escape hatch.
3459
+ * Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
2269
3460
  *
2270
3461
  * @param content - Raw HTML markup content
3462
+
3463
+ HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
2271
3464
  * @param options - Optional component settings (modifiers).
2272
3465
  * @returns This builder instance for method chaining.
2273
3466
  */
@@ -2278,9 +3471,11 @@ export declare class UiContainerBuilder {
2278
3471
  * Appends a `HtmlBlockElement` component.
2279
3472
  *
2280
3473
  * @remarks
2281
- * Sandboxed HTML rendering escape hatch.
3474
+ * Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
2282
3475
  *
2283
3476
  * @param content - Raw HTML markup content
3477
+
3478
+ HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
2284
3479
  * @param options - Optional component settings (modifiers).
2285
3480
  * @returns This builder instance for method chaining.
2286
3481
  */
@@ -2291,9 +3486,11 @@ export declare class UiContainerBuilder {
2291
3486
  * Appends a `MultiSlotElement` component.
2292
3487
  *
2293
3488
  * @remarks
2294
- * Multi-slot horizontal row layout comprising slots with individual widths.
3489
+ * Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
2295
3490
  *
2296
3491
  * @param slots - List of slots comprising the row
3492
+
3493
+ Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
2297
3494
  * @returns This builder instance for method chaining.
2298
3495
  */
2299
3496
  addMultiSlot(slots: Slot[]): this;
@@ -2301,10 +3498,11 @@ export declare class UiContainerBuilder {
2301
3498
  * Appends a `FlowingElement` component.
2302
3499
  *
2303
3500
  * @remarks
2304
- * Flowing inline layout container with automatic line wrapping.
2305
- * Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
3501
+ * Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
2306
3502
  *
2307
3503
  * @param elements - List of child elements rendered sequentially with line wrapping
3504
+
3505
+ Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
2308
3506
  * @param options - Optional component settings (separator).
2309
3507
  * @returns This builder instance for method chaining.
2310
3508
  */
@@ -2315,11 +3513,14 @@ export declare class UiContainerBuilder {
2315
3513
  * Appends a `LabelValueElement` component.
2316
3514
  *
2317
3515
  * @remarks
2318
- * Standard label and value row.
2319
- * Displays a muted label on the left and value representation on the right with a vertical dividing line.
3516
+ * Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
2320
3517
  *
2321
3518
  * @param label - Key or descriptive label displayed muted on the left
3519
+
3520
+ Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
2322
3521
  * @param value - Rendered value element on the right
3522
+
3523
+ Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
2323
3524
  * @param options - Optional component settings (withDivider (defaults to `false`)).
2324
3525
  * @returns This builder instance for method chaining.
2325
3526
  */
@@ -2330,10 +3531,11 @@ export declare class UiContainerBuilder {
2330
3531
  * Appends a `TableElement` component.
2331
3532
  *
2332
3533
  * @remarks
2333
- * Structured tabular data representation.
2334
- * Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
3534
+ * Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
2335
3535
  *
2336
3536
  * @param rows - Tabular data rows
3537
+
3538
+ Ordered table rows. Each row's cells correspond positionally to the declared columns.
2337
3539
  * @param options - Optional component settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
2338
3540
  * @returns This builder instance for method chaining.
2339
3541
  */
@@ -2347,9 +3549,11 @@ export declare class UiContainerBuilder {
2347
3549
  * Appends a `RepeatingGroupElement` component.
2348
3550
  *
2349
3551
  * @remarks
2350
- * Repeating group container where entries share uniform structure and retain per-entry labels.
3552
+ * Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
2351
3553
  *
2352
3554
  * @param entries - List of repeated entry records
3555
+
3556
+ Entries in display order. Each entry supplies its own label and content.
2353
3557
  * @param options - Optional component settings (title).
2354
3558
  * @returns This builder instance for method chaining.
2355
3559
  */
@@ -2360,10 +3564,14 @@ export declare class UiContainerBuilder {
2360
3564
  * Appends a `CollapsibleGroupElement` component.
2361
3565
  *
2362
3566
  * @remarks
2363
- * Collapsible disclosure container (accordion) with summary badge.
3567
+ * Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
2364
3568
  *
2365
3569
  * @param title - Group title (e.g. "Show specimen details")
3570
+
3571
+ Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
2366
3572
  * @param elements - Nested content elements revealed when expanded
3573
+
3574
+ Ordered child elements made visible by expanding the group.
2367
3575
  * @param options - Optional component settings (summary, defaultExpanded (defaults to `false`)).
2368
3576
  * @returns This builder instance for method chaining.
2369
3577
  */
@@ -2375,7 +3583,7 @@ export declare class UiContainerBuilder {
2375
3583
  * Appends a `DividerElement` component.
2376
3584
  *
2377
3585
  * @remarks
2378
- * Visual hairline separator separating sections or element groups.
3586
+ * A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
2379
3587
  *
2380
3588
  * @param options - Optional component settings (style (defaults to `hairline`)).
2381
3589
  * @returns This builder instance for method chaining.
@@ -2435,7 +3643,7 @@ export declare const UiContainer: {
2435
3643
  * Functional helper to create a `UiContainerClass` instance directly.
2436
3644
  *
2437
3645
  * @remarks
2438
- * Container model representing an ordered list of visual elements.
3646
+ * Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
2439
3647
  *
2440
3648
  * @param options - Optional configuration properties.
2441
3649
  * @returns A strongly-typed `UiContainerClass` instance.
@@ -2447,7 +3655,7 @@ export declare function createUiContainer(options?: {
2447
3655
  * Parses a JSON string or raw object into a validated `UiContainerClass` instance.
2448
3656
  *
2449
3657
  * @remarks
2450
- * Container model representing an ordered list of visual elements.
3658
+ * Provides the shared root content collection inherited by cards and other root models. The order of elements is significant and is preserved by the renderer.
2451
3659
  *
2452
3660
  * @param json - JSON string or parsed JavaScript object to validate and hydrate.
2453
3661
  * @param withDeepValidation - Whether to recursively validate all nested child entities.
@@ -2458,8 +3666,7 @@ export declare function parseUiContainer(json: string | unknown, withDeepValidat
2458
3666
  * Fluent builder for constructing strongly-typed `UiCard` instances.
2459
3667
  *
2460
3668
  * @remarks
2461
- * Root Card container model.
2462
- * Represents a complete feature card rendered inside the 360px panel.
3669
+ * A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
2463
3670
  */
2464
3671
  export declare class UiCardBuilder {
2465
3672
  private readonly _title;
@@ -2470,12 +3677,16 @@ export declare class UiCardBuilder {
2470
3677
  * Initializes a new `UiCardBuilder`.
2471
3678
  *
2472
3679
  * @param title - Human-readable feature title displayed in the card header
3680
+
3681
+ Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
2473
3682
  */
2474
3683
  constructor(title: string);
2475
3684
  /**
2476
3685
  * Sets the `description` property on this builder.
2477
3686
  *
2478
3687
  * @param description - Optional neutral subtitle / description for the feature
3688
+
3689
+ Brief secondary context shown with the title. Use the content elements for detailed information rather than placing an entire report in this field.
2479
3690
  * @returns This builder instance for method chaining.
2480
3691
  */
2481
3692
  description(description: string): this;
@@ -2511,10 +3722,11 @@ export declare class UiCardBuilder {
2511
3722
  * Appends a `StringElement` component.
2512
3723
  *
2513
3724
  * @remarks
2514
- * Universal textual string primitive element.
2515
- * Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
3725
+ * Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
2516
3726
  *
2517
3727
  * @param value - Text value
3728
+
3729
+ Text to render. Supply plain text; this field is not a Markdown or HTML document.
2518
3730
  * @param options - Optional component settings (representation (defaults to `plain`), modifiers).
2519
3731
  * @returns This builder instance for method chaining.
2520
3732
  */
@@ -2526,10 +3738,11 @@ export declare class UiCardBuilder {
2526
3738
  * Appends a `StringsElement` component.
2527
3739
  *
2528
3740
  * @remarks
2529
- * Collection of textual string values rendered as a sequence of inline items or chips.
2530
- * Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
3741
+ * Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
2531
3742
  *
2532
3743
  * @param values - Array of string values
3744
+
3745
+ Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
2533
3746
  * @param options - Optional component settings (representation (defaults to `plain`), separator, modifiers).
2534
3747
  * @returns This builder instance for method chaining.
2535
3748
  */
@@ -2542,9 +3755,11 @@ export declare class UiCardBuilder {
2542
3755
  * Appends a `StringCodeElement` component.
2543
3756
  *
2544
3757
  * @remarks
2545
- * Monospace code block or formatted code snippet representation.
3758
+ * Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
2546
3759
  *
2547
3760
  * @param value - Text value
3761
+
3762
+ Code or text snippet to display. Include any desired line breaks in this string.
2548
3763
  * @param options - Optional component settings (language, modifiers).
2549
3764
  * @returns This builder instance for method chaining.
2550
3765
  */
@@ -2556,9 +3771,11 @@ export declare class UiCardBuilder {
2556
3771
  * Appends a `XmlElement` component.
2557
3772
  *
2558
3773
  * @remarks
2559
- * XML markup code block element.
3774
+ * Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
2560
3775
  *
2561
3776
  * @param value - XML content value
3777
+
3778
+ XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
2562
3779
  * @param options - Optional component settings (modifiers).
2563
3780
  * @returns This builder instance for method chaining.
2564
3781
  */
@@ -2569,9 +3786,11 @@ export declare class UiCardBuilder {
2569
3786
  * Appends a `JsonElement` component.
2570
3787
  *
2571
3788
  * @remarks
2572
- * JSON data or structure representation element.
3789
+ * Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
2573
3790
  *
2574
3791
  * @param value - JSON content value
3792
+
3793
+ Serialized JSON text to render. No parsing or schema validation is implied by this element.
2575
3794
  * @param options - Optional component settings (modifiers).
2576
3795
  * @returns This builder instance for method chaining.
2577
3796
  */
@@ -2582,9 +3801,11 @@ export declare class UiCardBuilder {
2582
3801
  * Appends a `StringUrlElement` component.
2583
3802
  *
2584
3803
  * @remarks
2585
- * Hyperlink representation for external or internal URL navigation.
3804
+ * Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
2586
3805
  *
2587
3806
  * @param value - Target URL or navigation destination
3807
+
3808
+ Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
2588
3809
  * @param options - Optional component settings (label, modifiers).
2589
3810
  * @returns This builder instance for method chaining.
2590
3811
  */
@@ -2596,9 +3817,11 @@ export declare class UiCardBuilder {
2596
3817
  * Appends a `IdentifierElement` component.
2597
3818
  *
2598
3819
  * @remarks
2599
- * Monospace semantic identifier representation.
3820
+ * Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
2600
3821
  *
2601
3822
  * @param value - Identifier string value
3823
+
3824
+ Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
2602
3825
  * @param options - Optional component settings (modifiers).
2603
3826
  * @returns This builder instance for method chaining.
2604
3827
  */
@@ -2609,9 +3832,11 @@ export declare class UiCardBuilder {
2609
3832
  * Appends a `RatioElement` component.
2610
3833
  *
2611
3834
  * @remarks
2612
- * Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
3835
+ * Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
2613
3836
  *
2614
3837
  * @param value - Aspect ratio numerical expression
3838
+
3839
+ Numeric ratio value used by the renderer to produce an aspect-ratio display.
2615
3840
  * @param options - Optional component settings (modifiers).
2616
3841
  * @returns This builder instance for method chaining.
2617
3842
  */
@@ -2622,10 +3847,14 @@ export declare class UiCardBuilder {
2622
3847
  * Appends a `DimensionsElement` component.
2623
3848
  *
2624
3849
  * @remarks
2625
- * Image dimensions representation displaying formatted width and height in pixels.
3850
+ * Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
2626
3851
  *
2627
3852
  * @param width - Width in pixels
3853
+
3854
+ Horizontal pixel count. Values below one are rejected by the schema constraint.
2628
3855
  * @param height - Height in pixels
3856
+
3857
+ Vertical pixel count. Values below one are rejected by the schema constraint.
2629
3858
  * @param options - Optional component settings (modifiers).
2630
3859
  * @returns This builder instance for method chaining.
2631
3860
  */
@@ -2636,9 +3865,11 @@ export declare class UiCardBuilder {
2636
3865
  * Appends a `ColourElement` component.
2637
3866
  *
2638
3867
  * @remarks
2639
- * Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
3868
+ * Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
2640
3869
  *
2641
3870
  * @param value - Hexadecimal color code
3871
+
3872
+ Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
2642
3873
  * @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
2643
3874
  * @returns This builder instance for method chaining.
2644
3875
  */
@@ -2653,9 +3884,11 @@ export declare class UiCardBuilder {
2653
3884
  * Appends a `ColourElement` component.
2654
3885
  *
2655
3886
  * @remarks
2656
- * Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
3887
+ * Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
2657
3888
  *
2658
3889
  * @param value - Hexadecimal color code
3890
+
3891
+ Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
2659
3892
  * @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
2660
3893
  * @returns This builder instance for method chaining.
2661
3894
  */
@@ -2670,9 +3903,11 @@ export declare class UiCardBuilder {
2670
3903
  * Appends a `NumberUnboundedElement` component.
2671
3904
  *
2672
3905
  * @remarks
2673
- * Plain unbounded numeric value primitive element.
3906
+ * Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
2674
3907
  *
2675
3908
  * @param value - Numeric value
3909
+
3910
+ Number to display. Its meaning and any valid range are defined by the producing feature.
2676
3911
  * @param options - Optional component settings (unit, modifiers).
2677
3912
  * @returns This builder instance for method chaining.
2678
3913
  */
@@ -2684,9 +3919,11 @@ export declare class UiCardBuilder {
2684
3919
  * Appends a `NumberBoundedStarsElement` component.
2685
3920
  *
2686
3921
  * @remarks
2687
- * Bounded numeric rating represented as visual stars.
3922
+ * Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
2688
3923
  *
2689
3924
  * @param value - Numeric rating score
3925
+
3926
+ Score represented by the filled portion of the star display.
2690
3927
  * @param options - Optional component settings (maximum, modifiers).
2691
3928
  * @returns This builder instance for method chaining.
2692
3929
  */
@@ -2698,9 +3935,11 @@ export declare class UiCardBuilder {
2698
3935
  * Appends a `NumberBoundedStarsElement` component.
2699
3936
  *
2700
3937
  * @remarks
2701
- * Bounded numeric rating represented as visual stars.
3938
+ * Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
2702
3939
  *
2703
3940
  * @param value - Numeric rating score
3941
+
3942
+ Score represented by the filled portion of the star display.
2704
3943
  * @param options - Optional component settings (maximum, modifiers).
2705
3944
  * @returns This builder instance for method chaining.
2706
3945
  */
@@ -2712,9 +3951,11 @@ export declare class UiCardBuilder {
2712
3951
  * Appends a `NumberBoundedMeterElement` component.
2713
3952
  *
2714
3953
  * @remarks
2715
- * Bounded numeric meter representation (read-only progress / score bar).
3954
+ * Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
2716
3955
  *
2717
3956
  * @param value - Numeric value
3957
+
3958
+ Current measurement or score represented by the meter.
2718
3959
  * @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
2719
3960
  * @returns This builder instance for method chaining.
2720
3961
  */
@@ -2729,9 +3970,11 @@ export declare class UiCardBuilder {
2729
3970
  * Appends a `NumberBoundedMeterElement` component.
2730
3971
  *
2731
3972
  * @remarks
2732
- * Bounded numeric meter representation (read-only progress / score bar).
3973
+ * Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
2733
3974
  *
2734
3975
  * @param value - Numeric value
3976
+
3977
+ Current measurement or score represented by the meter.
2735
3978
  * @param options - Optional component settings (minimum, maximum, label, unit, modifiers).
2736
3979
  * @returns This builder instance for method chaining.
2737
3980
  */
@@ -2746,10 +3989,11 @@ export declare class UiCardBuilder {
2746
3989
  * Appends a `BooleanElement` component.
2747
3990
  *
2748
3991
  * @remarks
2749
- * Universal boolean primitive element.
2750
- * Supports standard plain text or badge pill presentation with customizable labels and variants.
3992
+ * Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
2751
3993
  *
2752
3994
  * @param value - Boolean state value
3995
+
3996
+ State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
2753
3997
  * @param options - Optional component settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
2754
3998
  * @returns This builder instance for method chaining.
2755
3999
  */
@@ -2764,9 +4008,11 @@ export declare class UiCardBuilder {
2764
4008
  * Appends a `TimestampElement` component.
2765
4009
  *
2766
4010
  * @remarks
2767
- * Formatted date and time representation.
4011
+ * Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
2768
4012
  *
2769
4013
  * @param value - The timestamp in milliseconds
4014
+
4015
+ Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
2770
4016
  * @param options - Optional component settings (format (defaults to `datetime`), modifiers).
2771
4017
  * @returns This builder instance for method chaining.
2772
4018
  */
@@ -2778,9 +4024,11 @@ export declare class UiCardBuilder {
2778
4024
  * Appends a `ImageReferenceElement` component.
2779
4025
  *
2780
4026
  * @remarks
2781
- * Thumbnail image reference with placeholder fallback handling.
4027
+ * References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
2782
4028
  *
2783
4029
  * @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
4030
+
4031
+ Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
2784
4032
  * @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
2785
4033
  * @returns This builder instance for method chaining.
2786
4034
  */
@@ -2793,9 +4041,11 @@ export declare class UiCardBuilder {
2793
4041
  * Appends a `ImageReferenceElement` component.
2794
4042
  *
2795
4043
  * @remarks
2796
- * Thumbnail image reference with placeholder fallback handling.
4044
+ * References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
2797
4045
  *
2798
4046
  * @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
4047
+
4048
+ Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
2799
4049
  * @param options - Optional component settings (alt, aspectRatio (defaults to `1:1`), placeholder).
2800
4050
  * @returns This builder instance for method chaining.
2801
4051
  */
@@ -2808,9 +4058,11 @@ export declare class UiCardBuilder {
2808
4058
  * Appends a `MarkdownBlockElement` component.
2809
4059
  *
2810
4060
  * @remarks
2811
- * Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling.
4061
+ * Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
2812
4062
  *
2813
4063
  * @param content - Raw Markdown markup content
4064
+
4065
+ Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
2814
4066
  * @param options - Optional component settings (modifiers).
2815
4067
  * @returns This builder instance for method chaining.
2816
4068
  */
@@ -2821,9 +4073,11 @@ export declare class UiCardBuilder {
2821
4073
  * Appends a `MarkdownBlockElement` component.
2822
4074
  *
2823
4075
  * @remarks
2824
- * Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling.
4076
+ * Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
2825
4077
  *
2826
4078
  * @param content - Raw Markdown markup content
4079
+
4080
+ Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
2827
4081
  * @param options - Optional component settings (modifiers).
2828
4082
  * @returns This builder instance for method chaining.
2829
4083
  */
@@ -2834,9 +4088,11 @@ export declare class UiCardBuilder {
2834
4088
  * Appends a `HtmlBlockElement` component.
2835
4089
  *
2836
4090
  * @remarks
2837
- * Sandboxed HTML rendering escape hatch.
4091
+ * Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
2838
4092
  *
2839
4093
  * @param content - Raw HTML markup content
4094
+
4095
+ HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
2840
4096
  * @param options - Optional component settings (modifiers).
2841
4097
  * @returns This builder instance for method chaining.
2842
4098
  */
@@ -2847,9 +4103,11 @@ export declare class UiCardBuilder {
2847
4103
  * Appends a `HtmlBlockElement` component.
2848
4104
  *
2849
4105
  * @remarks
2850
- * Sandboxed HTML rendering escape hatch.
4106
+ * Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
2851
4107
  *
2852
4108
  * @param content - Raw HTML markup content
4109
+
4110
+ HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
2853
4111
  * @param options - Optional component settings (modifiers).
2854
4112
  * @returns This builder instance for method chaining.
2855
4113
  */
@@ -2860,9 +4118,11 @@ export declare class UiCardBuilder {
2860
4118
  * Appends a `MultiSlotElement` component.
2861
4119
  *
2862
4120
  * @remarks
2863
- * Multi-slot horizontal row layout comprising slots with individual widths.
4121
+ * Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
2864
4122
  *
2865
4123
  * @param slots - List of slots comprising the row
4124
+
4125
+ Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
2866
4126
  * @returns This builder instance for method chaining.
2867
4127
  */
2868
4128
  addMultiSlot(slots: Slot[]): this;
@@ -2870,10 +4130,11 @@ export declare class UiCardBuilder {
2870
4130
  * Appends a `FlowingElement` component.
2871
4131
  *
2872
4132
  * @remarks
2873
- * Flowing inline layout container with automatic line wrapping.
2874
- * Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
4133
+ * Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
2875
4134
  *
2876
4135
  * @param elements - List of child elements rendered sequentially with line wrapping
4136
+
4137
+ Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
2877
4138
  * @param options - Optional component settings (separator).
2878
4139
  * @returns This builder instance for method chaining.
2879
4140
  */
@@ -2884,11 +4145,14 @@ export declare class UiCardBuilder {
2884
4145
  * Appends a `LabelValueElement` component.
2885
4146
  *
2886
4147
  * @remarks
2887
- * Standard label and value row.
2888
- * Displays a muted label on the left and value representation on the right with a vertical dividing line.
4148
+ * Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
2889
4149
  *
2890
4150
  * @param label - Key or descriptive label displayed muted on the left
4151
+
4152
+ Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
2891
4153
  * @param value - Rendered value element on the right
4154
+
4155
+ Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
2892
4156
  * @param options - Optional component settings (withDivider (defaults to `false`)).
2893
4157
  * @returns This builder instance for method chaining.
2894
4158
  */
@@ -2899,10 +4163,11 @@ export declare class UiCardBuilder {
2899
4163
  * Appends a `TableElement` component.
2900
4164
  *
2901
4165
  * @remarks
2902
- * Structured tabular data representation.
2903
- * Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
4166
+ * Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
2904
4167
  *
2905
4168
  * @param rows - Tabular data rows
4169
+
4170
+ Ordered table rows. Each row's cells correspond positionally to the declared columns.
2906
4171
  * @param options - Optional component settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
2907
4172
  * @returns This builder instance for method chaining.
2908
4173
  */
@@ -2916,9 +4181,11 @@ export declare class UiCardBuilder {
2916
4181
  * Appends a `RepeatingGroupElement` component.
2917
4182
  *
2918
4183
  * @remarks
2919
- * Repeating group container where entries share uniform structure and retain per-entry labels.
4184
+ * Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
2920
4185
  *
2921
4186
  * @param entries - List of repeated entry records
4187
+
4188
+ Entries in display order. Each entry supplies its own label and content.
2922
4189
  * @param options - Optional component settings (title).
2923
4190
  * @returns This builder instance for method chaining.
2924
4191
  */
@@ -2929,10 +4196,14 @@ export declare class UiCardBuilder {
2929
4196
  * Appends a `CollapsibleGroupElement` component.
2930
4197
  *
2931
4198
  * @remarks
2932
- * Collapsible disclosure container (accordion) with summary badge.
4199
+ * Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
2933
4200
  *
2934
4201
  * @param title - Group title (e.g. "Show specimen details")
4202
+
4203
+ Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
2935
4204
  * @param elements - Nested content elements revealed when expanded
4205
+
4206
+ Ordered child elements made visible by expanding the group.
2936
4207
  * @param options - Optional component settings (summary, defaultExpanded (defaults to `false`)).
2937
4208
  * @returns This builder instance for method chaining.
2938
4209
  */
@@ -2944,7 +4215,7 @@ export declare class UiCardBuilder {
2944
4215
  * Appends a `DividerElement` component.
2945
4216
  *
2946
4217
  * @remarks
2947
- * Visual hairline separator separating sections or element groups.
4218
+ * A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
2948
4219
  *
2949
4220
  * @param options - Optional component settings (style (defaults to `hairline`)).
2950
4221
  * @returns This builder instance for method chaining.
@@ -2977,6 +4248,8 @@ export declare const UiCard: {
2977
4248
  * Creates a new fluent builder for constructing a `UiCard`.
2978
4249
  *
2979
4250
  * @param title - Human-readable feature title displayed in the card header
4251
+
4252
+ Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
2980
4253
  * @returns A new `UiCardBuilder` instance.
2981
4254
  */
2982
4255
  builder(title: string): UiCardBuilder;
@@ -3008,10 +4281,11 @@ export declare const UiCard: {
3008
4281
  * Functional helper to create a `UiCardClass` instance directly.
3009
4282
  *
3010
4283
  * @remarks
3011
- * Root Card container model.
3012
- * Represents a complete feature card rendered inside the 360px panel.
4284
+ * A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
3013
4285
  *
3014
4286
  * @param title - Human-readable feature title displayed in the card header
4287
+
4288
+ Primary heading for the card. Keep it concise enough for the card header; longer explanatory text belongs in description or elements.
3015
4289
  * @param options - Optional configuration properties.
3016
4290
  * @returns A strongly-typed `UiCardClass` instance.
3017
4291
  */
@@ -3024,8 +4298,7 @@ export declare function createUiCard(title: string, options?: {
3024
4298
  * Parses a JSON string or raw object into a validated `UiCardClass` instance.
3025
4299
  *
3026
4300
  * @remarks
3027
- * Root Card container model.
3028
- * Represents a complete feature card rendered inside the 360px panel.
4301
+ * A complete card has a required title and ordered content inherited from UiContainer. It is designed for the feature-card surface; description and actions supplement the content, with action controls rendered separately from the element list.
3029
4302
  *
3030
4303
  * @param json - JSON string or parsed JavaScript object to validate and hydrate.
3031
4304
  * @param withDeepValidation - Whether to recursively validate all nested child entities.
@@ -3036,20 +4309,23 @@ export declare function parseUiCard(json: string | unknown, withDeepValidation?:
3036
4309
  * Creates a `TruncateOptions` component instance.
3037
4310
  *
3038
4311
  * @remarks
3039
- * Truncation configuration for long textual content with optional expand affordance.
4312
+ * Controls how a renderer abbreviates long text. When mode is characters, limit represents maximum character count; when mode is lines, limit represents visual line count.
3040
4313
  *
3041
- * @param characterLimit - Maximum number of characters to display before truncating
3042
- * @param options - Optional settings (showMore (defaults to `true`)).
4314
+ * @param limit - Maximum threshold limit before truncating
4315
+
4316
+ Threshold after which the renderer can shorten the displayed text. When mode is characters, this represents character count; when mode is lines, this represents visual line count.
4317
+ * @param options - Optional settings (mode (defaults to `lines`), showMore (defaults to `true`)).
3043
4318
  * @returns A strongly-typed `TruncateOptions` object.
3044
4319
  */
3045
- export declare function truncateOptions(characterLimit: number, options?: {
4320
+ export declare function truncateOptions(limit: number, options?: {
4321
+ mode?: TruncateMode;
3046
4322
  showMore?: boolean;
3047
4323
  }): TruncateOptions;
3048
4324
  /**
3049
4325
  * Creates a `BaseModifiers` component instance.
3050
4326
  *
3051
4327
  * @remarks
3052
- * Base modifier traits for elements that support copy affordance.
4328
+ * Common optional presentation traits shared by primitive values and content renderers. Modifiers affect how content is displayed or copied; they do not transform the source value.
3053
4329
  *
3054
4330
  * @param options - Optional settings (copyable).
3055
4331
  * @returns A strongly-typed `BaseModifiers` object.
@@ -3061,7 +4337,7 @@ export declare function baseModifiers(options?: {
3061
4337
  * Creates a `PrimitiveModifiers` component instance.
3062
4338
  *
3063
4339
  * @remarks
3064
- * Common modifier traits that can be attached to primitive elements.
4340
+ * Extends BaseModifiers with text styling controls. Defaults provide normal weight, medium intensity, and proportional text unless a feature explicitly overrides them.
3065
4341
  *
3066
4342
  * @param options - Optional settings (truncate, weight (defaults to `normal`), intensity (defaults to `medium`), monospace (defaults to `false`), copyable).
3067
4343
  * @returns A strongly-typed `PrimitiveModifiers` object.
@@ -3077,10 +4353,11 @@ export declare function primitiveModifiers(options?: {
3077
4353
  * Creates a `StringElement` component instance.
3078
4354
  *
3079
4355
  * @remarks
3080
- * Universal textual string primitive element.
3081
- * Supports plain text, compact chip pill, or multiline pre-wrapped presentation.
4356
+ * Use this primitive for one textual value when a structured label/value row is unnecessary. Choose multiline for content whose line breaks should remain visible; modifiers apply presentation traits without changing the underlying value.
3082
4357
  *
3083
4358
  * @param value - Text value
4359
+
4360
+ Text to render. Supply plain text; this field is not a Markdown or HTML document.
3084
4361
  * @param options - Optional settings (representation (defaults to `plain`), modifiers).
3085
4362
  * @returns A strongly-typed `StringElement` object.
3086
4363
  */
@@ -3092,10 +4369,11 @@ export declare function string(value: string, options?: {
3092
4369
  * Creates a `StringsElement` component instance.
3093
4370
  *
3094
4371
  * @remarks
3095
- * Collection of textual string values rendered as a sequence of inline items or chips.
3096
- * Supports visual separators (comma, dot, slash, bar, dash, space) and copyable affordance.
4372
+ * Use this primitive when several related strings should be rendered as one compact sequence. The client preserves the array order and inserts the selected separator between values.
3097
4373
  *
3098
4374
  * @param values - Array of string values
4375
+
4376
+ Values to render in order. Each array entry remains a distinct item for chip presentation and is not parsed as a delimited string.
3099
4377
  * @param options - Optional settings (representation (defaults to `plain`), separator, modifiers).
3100
4378
  * @returns A strongly-typed `StringsElement` object.
3101
4379
  */
@@ -3108,9 +4386,11 @@ export declare function strings(values: string[], options?: {
3108
4386
  * Creates a `StringCodeElement` component instance.
3109
4387
  *
3110
4388
  * @remarks
3111
- * Monospace code block or formatted code snippet representation.
4389
+ * Use for source-like or preformatted textual content that should be rendered in a code-oriented style. The language is a presentation hint; the content is not parsed or validated as code by this contract.
3112
4390
  *
3113
4391
  * @param value - Text value
4392
+
4393
+ Code or text snippet to display. Include any desired line breaks in this string.
3114
4394
  * @param options - Optional settings (language, modifiers).
3115
4395
  * @returns A strongly-typed `StringCodeElement` object.
3116
4396
  */
@@ -3122,9 +4402,11 @@ export declare function stringCode(value: string, options?: {
3122
4402
  * Creates a `XmlElement` component instance.
3123
4403
  *
3124
4404
  * @remarks
3125
- * XML markup code block element.
4405
+ * Specialized code-oriented element for XML content. It uses the custom XML renderer rather than requiring consumers to construct a generic code block.
3126
4406
  *
3127
4407
  * @param value - XML content value
4408
+
4409
+ XML markup to render. The contract carries the source text; it does not guarantee that the document is well-formed.
3128
4410
  * @param options - Optional settings (modifiers).
3129
4411
  * @returns A strongly-typed `XmlElement` object.
3130
4412
  */
@@ -3135,9 +4417,11 @@ export declare function xml(value: string, options?: {
3135
4417
  * Creates a `JsonElement` component instance.
3136
4418
  *
3137
4419
  * @remarks
3138
- * JSON data or structure representation element.
4420
+ * Specialized representation for JSON text. Supply serialized JSON when consumers should display a JSON document; this field is a string and is not structurally validated here.
3139
4421
  *
3140
4422
  * @param value - JSON content value
4423
+
4424
+ Serialized JSON text to render. No parsing or schema validation is implied by this element.
3141
4425
  * @param options - Optional settings (modifiers).
3142
4426
  * @returns A strongly-typed `JsonElement` object.
3143
4427
  */
@@ -3148,9 +4432,11 @@ export declare function json(value: string, options?: {
3148
4432
  * Creates a `StringUrlElement` component instance.
3149
4433
  *
3150
4434
  * @remarks
3151
- * Hyperlink representation for external or internal URL navigation.
4435
+ * Use this element when displayed text should also behave as a link. Unlike StringElement, the value is a navigation destination and may be paired with a separate human-readable label.
3152
4436
  *
3153
4437
  * @param value - Target URL or navigation destination
4438
+
4439
+ Destination associated with the link. Supply a URL or client-recognized navigation target supported by the renderer.
3154
4440
  * @param options - Optional settings (label, modifiers).
3155
4441
  * @returns A strongly-typed `StringUrlElement` object.
3156
4442
  */
@@ -3162,9 +4448,11 @@ export declare function stringUrl(value: string, options?: {
3162
4448
  * Creates a `IdentifierElement` component instance.
3163
4449
  *
3164
4450
  * @remarks
3165
- * Monospace semantic identifier representation.
4451
+ * Use for identifiers, hashes, and other machine-oriented strings that benefit from monospace styling. The value remains text and is not resolved as a Picteus entity.
3166
4452
  *
3167
4453
  * @param value - Identifier string value
4454
+
4455
+ Identifier text to display, such as an opaque ID or hash. Avoid embedding presentation markup in the value.
3168
4456
  * @param options - Optional settings (modifiers).
3169
4457
  * @returns A strongly-typed `IdentifierElement` object.
3170
4458
  */
@@ -3175,9 +4463,11 @@ export declare function identifier(value: string, options?: {
3175
4463
  * Creates a `RatioElement` component instance.
3176
4464
  *
3177
4465
  * @remarks
3178
- * Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
4466
+ * Displays a numeric aspect ratio as a ratio expression. Provide a positive value meaningful to the surrounding content; this type does not encode the source image dimensions.
3179
4467
  *
3180
4468
  * @param value - Aspect ratio numerical expression
4469
+
4470
+ Numeric ratio value used by the renderer to produce an aspect-ratio display.
3181
4471
  * @param options - Optional settings (modifiers).
3182
4472
  * @returns A strongly-typed `RatioElement` object.
3183
4473
  */
@@ -3188,10 +4478,14 @@ export declare function ratio(value: number, options?: {
3188
4478
  * Creates a `DimensionsElement` component instance.
3189
4479
  *
3190
4480
  * @remarks
3191
- * Image dimensions representation displaying formatted width and height in pixels.
4481
+ * Displays a width/height pair as image dimensions. Both values are positive pixel counts; together they describe dimensions, not an aspect ratio or a resize request.
3192
4482
  *
3193
4483
  * @param width - Width in pixels
4484
+
4485
+ Horizontal pixel count. Values below one are rejected by the schema constraint.
3194
4486
  * @param height - Height in pixels
4487
+
4488
+ Vertical pixel count. Values below one are rejected by the schema constraint.
3195
4489
  * @param options - Optional settings (modifiers).
3196
4490
  * @returns A strongly-typed `DimensionsElement` object.
3197
4491
  */
@@ -3202,9 +4496,11 @@ export declare function dimensions(width: number, height: number, options?: {
3202
4496
  * Creates a `ColourElement` component instance.
3203
4497
  *
3204
4498
  * @remarks
3205
- * Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
4499
+ * Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
3206
4500
  *
3207
4501
  * @param value - Hexadecimal color code
4502
+
4503
+ Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
3208
4504
  * @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
3209
4505
  * @returns A strongly-typed `ColourElement` object.
3210
4506
  */
@@ -3219,9 +4515,11 @@ export declare function colour(value: string, options?: {
3219
4515
  * Creates a `ColourElement` component instance.
3220
4516
  *
3221
4517
  * @remarks
3222
- * Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
4518
+ * Displays one color swatch with configurable geometry and optional adjacent text. Supply the color as a hexadecimal string; the schema leaves exact accepted hex formats to the renderer.
3223
4519
  *
3224
4520
  * @param value - Hexadecimal color code
4521
+
4522
+ Color value used to draw the swatch. Use a hexadecimal representation supported by the client renderer.
3225
4523
  * @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
3226
4524
  * @returns A strongly-typed `ColourElement` object.
3227
4525
  */
@@ -3236,9 +4534,11 @@ export declare function color(value: string, options?: {
3236
4534
  * Creates a `NumberUnboundedElement` component instance.
3237
4535
  *
3238
4536
  * @remarks
3239
- * Plain unbounded numeric value primitive element.
4537
+ * Displays a numeric value without a progress scale or rating interpretation. Use unit to communicate the measurement context; no range is imposed by this model.
3240
4538
  *
3241
4539
  * @param value - Numeric value
4540
+
4541
+ Number to display. Its meaning and any valid range are defined by the producing feature.
3242
4542
  * @param options - Optional settings (unit, modifiers).
3243
4543
  * @returns A strongly-typed `NumberUnboundedElement` object.
3244
4544
  */
@@ -3250,9 +4550,11 @@ export declare function numberUnbounded(value: number, options?: {
3250
4550
  * Creates a `NumberBoundedStarsElement` component instance.
3251
4551
  *
3252
4552
  * @remarks
3253
- * Bounded numeric rating represented as visual stars.
4553
+ * Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
3254
4554
  *
3255
4555
  * @param value - Numeric rating score
4556
+
4557
+ Score represented by the filled portion of the star display.
3256
4558
  * @param options - Optional settings (maximum, modifiers).
3257
4559
  * @returns A strongly-typed `NumberBoundedStarsElement` object.
3258
4560
  */
@@ -3264,9 +4566,11 @@ export declare function numberBoundedStars(value: number, options?: {
3264
4566
  * Creates a `NumberBoundedStarsElement` component instance.
3265
4567
  *
3266
4568
  * @remarks
3267
- * Bounded numeric rating represented as visual stars.
4569
+ * Displays a score on a star scale. Keep value within the scale from zero through maximum; this model declares the scale metadata but does not impose a numeric validation bound.
3268
4570
  *
3269
4571
  * @param value - Numeric rating score
4572
+
4573
+ Score represented by the filled portion of the star display.
3270
4574
  * @param options - Optional settings (maximum, modifiers).
3271
4575
  * @returns A strongly-typed `NumberBoundedStarsElement` object.
3272
4576
  */
@@ -3278,9 +4582,11 @@ export declare function numberStars(value: number, options?: {
3278
4582
  * Creates a `NumberBoundedMeterElement` component instance.
3279
4583
  *
3280
4584
  * @remarks
3281
- * Bounded numeric meter representation (read-only progress / score bar).
4585
+ * Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
3282
4586
  *
3283
4587
  * @param value - Numeric value
4588
+
4589
+ Current measurement or score represented by the meter.
3284
4590
  * @param options - Optional settings (minimum, maximum, label, unit, modifiers).
3285
4591
  * @returns A strongly-typed `NumberBoundedMeterElement` object.
3286
4592
  */
@@ -3295,9 +4601,11 @@ export declare function numberBoundedMeter(value: number, options?: {
3295
4601
  * Creates a `NumberBoundedMeterElement` component instance.
3296
4602
  *
3297
4603
  * @remarks
3298
- * Bounded numeric meter representation (read-only progress / score bar).
4604
+ * Displays a scalar value against a minimum-to-maximum range. Supply comparable bounds and a value in that range; optional label and unit customize the textual readout without changing the meter scale.
3299
4605
  *
3300
4606
  * @param value - Numeric value
4607
+
4608
+ Current measurement or score represented by the meter.
3301
4609
  * @param options - Optional settings (minimum, maximum, label, unit, modifiers).
3302
4610
  * @returns A strongly-typed `NumberBoundedMeterElement` object.
3303
4611
  */
@@ -3312,10 +4620,11 @@ export declare function numberMeter(value: number, options?: {
3312
4620
  * Creates a `BooleanElement` component instance.
3313
4621
  *
3314
4622
  * @remarks
3315
- * Universal boolean primitive element.
3316
- * Supports standard plain text or badge pill presentation with customizable labels and variants.
4623
+ * Displays a boolean state using text or a badge. The representation determines whether true/false labels or a colored badge are used; configured labels and variant are presentation choices only.
3317
4624
  *
3318
4625
  * @param value - Boolean state value
4626
+
4627
+ State to display. This remains a boolean value in the data model even when the renderer substitutes custom labels.
3319
4628
  * @param options - Optional settings (representation (defaults to `plain`), trueLabel (defaults to `true`), falseLabel (defaults to `false`), variant (defaults to `neutral`), modifiers).
3320
4629
  * @returns A strongly-typed `BooleanElement` object.
3321
4630
  */
@@ -3330,9 +4639,11 @@ export declare function boolean(value: boolean, options?: {
3330
4639
  * Creates a `TimestampElement` component instance.
3331
4640
  *
3332
4641
  * @remarks
3333
- * Formatted date and time representation.
4642
+ * Displays an epoch timestamp using a selected date/time format. The input is a count of milliseconds, not seconds; relative formatting is interpreted by the consumer.
3334
4643
  *
3335
4644
  * @param value - The timestamp in milliseconds
4645
+
4646
+ Unix epoch timestamp measured in milliseconds. Convert seconds-based timestamps before assigning this value.
3336
4647
  * @param options - Optional settings (format (defaults to `datetime`), modifiers).
3337
4648
  * @returns A strongly-typed `TimestampElement` object.
3338
4649
  */
@@ -3344,9 +4655,11 @@ export declare function timestamp(value: number, options?: {
3344
4655
  * Creates a `ImageReferenceElement` component instance.
3345
4656
  *
3346
4657
  * @remarks
3347
- * Thumbnail image reference with placeholder fallback handling.
4658
+ * References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
3348
4659
  *
3349
4660
  * @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
4661
+
4662
+ Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
3350
4663
  * @param options - Optional settings (alt, aspectRatio (defaults to `1:1`), placeholder).
3351
4664
  * @returns A strongly-typed `ImageReferenceElement` object.
3352
4665
  */
@@ -3359,9 +4672,11 @@ export declare function imageReference(src: string, options?: {
3359
4672
  * Creates a `ImageReferenceElement` component instance.
3360
4673
  *
3361
4674
  * @remarks
3362
- * Thumbnail image reference with placeholder fallback handling.
4675
+ * References an image source for thumbnail rendering and provides accessible text and a fallback source. The client determines loading, sizing, and placeholder behavior.
3363
4676
  *
3364
4677
  * @param src - Image source URI (HTTPS URL, base64 data URI, or asset path)
4678
+
4679
+ Source URI understood by the client renderer. Supported forms include HTTPS locations, base64 data URIs, and client asset paths; this field is not raw image bytes.
3365
4680
  * @param options - Optional settings (alt, aspectRatio (defaults to `1:1`), placeholder).
3366
4681
  * @returns A strongly-typed `ImageReferenceElement` object.
3367
4682
  */
@@ -3374,10 +4689,14 @@ export declare function imageRef(src: string, options?: {
3374
4689
  * Creates a `ButtonActionElement` component instance.
3375
4690
  *
3376
4691
  * @remarks
3377
- * Interactive button action triggering an extension command.
4692
+ * When activated, the client dispatches commandId to the specified extension and may include target and parameters as command input. disabled and variant affect presentation and availability, not the command's authorization.
3378
4693
  *
3379
4694
  * @param commandId - Command identifier to invoke
4695
+
4696
+ Identifier of the registered extension command to dispatch when the button is activated.
3380
4697
  * @param label - Display label for the action
4698
+
4699
+ User-facing label shown on the control. Keep it short and action-oriented.
3381
4700
  * @param options - Optional settings (extensionId, target, parameters, disabled (defaults to `false`), variant (defaults to `secondary`)).
3382
4701
  * @returns A strongly-typed `ButtonActionElement` object.
3383
4702
  */
@@ -3392,10 +4711,14 @@ export declare function buttonAction(commandId: string, label: string, options?:
3392
4711
  * Creates a `ExternalLinkActionElement` component instance.
3393
4712
  *
3394
4713
  * @remarks
3395
- * External link action distinct from inline URL text values.
4714
+ * Renders a user-invokable action that opens a destination externally. Use StringUrlElement for a link embedded in content rather than an action control.
3396
4715
  *
3397
4716
  * @param url - Target URL destination
4717
+
4718
+ External destination opened when the user activates the link action. The client controls how external navigation is handed to the platform.
3398
4719
  * @param label - Display label for the action
4720
+
4721
+ User-facing label shown on the control. Keep it short and action-oriented.
3399
4722
  * @returns A strongly-typed `ExternalLinkActionElement` object.
3400
4723
  */
3401
4724
  export declare function externalLinkAction(url: string, label: string): ExternalLinkActionElement;
@@ -3403,9 +4726,11 @@ export declare function externalLinkAction(url: string, label: string): External
3403
4726
  * Creates a `MarkdownBlockElement` component instance.
3404
4727
  *
3405
4728
  * @remarks
3406
- * Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling.
4729
+ * Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
3407
4730
  *
3408
4731
  * @param content - Raw Markdown markup content
4732
+
4733
+ Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
3409
4734
  * @param options - Optional settings (modifiers).
3410
4735
  * @returns A strongly-typed `MarkdownBlockElement` object.
3411
4736
  */
@@ -3416,9 +4741,11 @@ export declare function markdownBlock(content: string, options?: {
3416
4741
  * Creates a `MarkdownBlockElement` component instance.
3417
4742
  *
3418
4743
  * @remarks
3419
- * Full Markdown fallback block rendered with core typographic hierarchy, spacing, and styling.
4744
+ * Use this custom-renderer escape hatch when the structured ViewKit elements cannot express the required rich text. Markdown rendering is a presentation fallback; prefer typed elements when consumers need to inspect individual values.
3420
4745
  *
3421
4746
  * @param content - Raw Markdown markup content
4747
+
4748
+ Markdown source consumed by the client renderer. The schema treats it as an opaque string and does not validate the markup or its links.
3422
4749
  * @param options - Optional settings (modifiers).
3423
4750
  * @returns A strongly-typed `MarkdownBlockElement` object.
3424
4751
  */
@@ -3429,9 +4756,11 @@ export declare function markdown(content: string, options?: {
3429
4756
  * Creates a `HtmlBlockElement` component instance.
3430
4757
  *
3431
4758
  * @remarks
3432
- * Sandboxed HTML rendering escape hatch.
4759
+ * Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
3433
4760
  *
3434
4761
  * @param content - Raw HTML markup content
4762
+
4763
+ HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
3435
4764
  * @param options - Optional settings (modifiers).
3436
4765
  * @returns A strongly-typed `HtmlBlockElement` object.
3437
4766
  */
@@ -3442,9 +4771,11 @@ export declare function htmlBlock(content: string, options?: {
3442
4771
  * Creates a `HtmlBlockElement` component instance.
3443
4772
  *
3444
4773
  * @remarks
3445
- * Sandboxed HTML rendering escape hatch.
4774
+ * Use only when structured elements or Markdown cannot represent the required content. Rendering occurs in a sandboxed host context, but callers should still avoid embedding untrusted content and should not assume access to application privileges.
3446
4775
  *
3447
4776
  * @param content - Raw HTML markup content
4777
+
4778
+ HTML source passed to the custom renderer. This is an opaque string, not a typed or sanitized DOM structure.
3448
4779
  * @param options - Optional settings (modifiers).
3449
4780
  * @returns A strongly-typed `HtmlBlockElement` object.
3450
4781
  */
@@ -3455,9 +4786,11 @@ export declare function html(content: string, options?: {
3455
4786
  * Creates a `Slot` component instance.
3456
4787
  *
3457
4788
  * @remarks
3458
- * Single slot within a multi-slot horizontal row layout.
4789
+ * A slot combines an optional label, a relative width, and one visual child. Slot widths are percentages of the row and should be chosen so the full row's widths form a usable layout.
3459
4790
  *
3460
4791
  * @param content - Rendered content inside the slot
4792
+
4793
+ One visual element displayed in this slot. Use a nested layout element when the slot itself needs multiple children.
3461
4794
  * @param options - Optional settings (label, width).
3462
4795
  * @returns A strongly-typed `Slot` object.
3463
4796
  */
@@ -3469,9 +4802,11 @@ export declare function slot(content: UiElement, options?: {
3469
4802
  * Creates a `MultiSlotElement` component instance.
3470
4803
  *
3471
4804
  * @remarks
3472
- * Multi-slot horizontal row layout comprising slots with individual widths.
4805
+ * Use this layout when a row needs explicit regions with independently controlled widths. Each slot contains one child element; unlike FlowingElement, the layout does not automatically wrap a sequence of children.
3473
4806
  *
3474
4807
  * @param slots - List of slots comprising the row
4808
+
4809
+ Ordered slots in the row. Each slot's width is a percentage; arrange slot definitions in the intended visual order.
3475
4810
  * @returns A strongly-typed `MultiSlotElement` object.
3476
4811
  */
3477
4812
  export declare function multiSlot(slots: Slot[]): MultiSlotElement;
@@ -3479,10 +4814,11 @@ export declare function multiSlot(slots: Slot[]): MultiSlotElement;
3479
4814
  * Creates a `FlowingElement` component instance.
3480
4815
  *
3481
4816
  * @remarks
3482
- * Flowing inline layout container with automatic line wrapping.
3483
- * Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
4817
+ * Use for compact related values that should flow horizontally and wrap naturally at the available width. Child order is preserved; an optional separator is placed between neighboring children.
3484
4818
  *
3485
4819
  * @param elements - List of child elements rendered sequentially with line wrapping
4820
+
4821
+ Ordered children rendered in the flow. The client wraps them as needed rather than requiring callers to calculate line breaks.
3486
4822
  * @param options - Optional settings (separator).
3487
4823
  * @returns A strongly-typed `FlowingElement` object.
3488
4824
  */
@@ -3493,11 +4829,14 @@ export declare function flowing(elements: UiElement[], options?: {
3493
4829
  * Creates a `LabelValueElement` component instance.
3494
4830
  *
3495
4831
  * @remarks
3496
- * Standard label and value row.
3497
- * Displays a muted label on the left and value representation on the right with a vertical dividing line.
4832
+ * Represents one named value with a muted left-hand label and a right-hand visual element. Use it for a single field; use TableElement for repeated rows or column-aligned data.
3498
4833
  *
3499
4834
  * @param label - Key or descriptive label displayed muted on the left
4835
+
4836
+ Human-readable name for the value. This text is rendered as the row label rather than as a separate UiElement.
3500
4837
  * @param value - Rendered value element on the right
4838
+
4839
+ Value content rendered in the right-hand region. It may be a primitive or a nested structural element.
3501
4840
  * @param options - Optional settings (withDivider (defaults to `false`)).
3502
4841
  * @returns A strongly-typed `LabelValueElement` object.
3503
4842
  */
@@ -3508,7 +4847,7 @@ export declare function labelValue(label: string, value: UiElement, options?: {
3508
4847
  * Creates a `TableColumn` component instance.
3509
4848
  *
3510
4849
  * @remarks
3511
- * Column definition for structured tables.
4850
+ * Describes one table column and its visual sizing. When columns are supplied, their order corresponds to the position of each cell in a row.
3512
4851
  *
3513
4852
  * @param options - Optional settings (header, align (defaults to `left`), width, widthMode (defaults to `fixed`)).
3514
4853
  * @returns A strongly-typed `TableColumn` object.
@@ -3523,9 +4862,11 @@ export declare function tableColumn(options?: {
3523
4862
  * Creates a `TableRow` component instance.
3524
4863
  *
3525
4864
  * @remarks
3526
- * Single table row containing an array of cell values.
4865
+ * A row's cell array is positional: cell at each index corresponds to the column at that index. Keep row lengths aligned with the table's explicit column definitions when present.
3527
4866
  *
3528
4867
  * @param cells - Array of cell values corresponding to table columns
4868
+
4869
+ Ordered contents for this row. Each cell is a UiElement so values can use the same primitive and layout renderers as other ViewKit content.
3529
4870
  * @returns A strongly-typed `TableRow` object.
3530
4871
  */
3531
4872
  export declare function tableRow(cells: UiElement[]): TableRow;
@@ -3533,10 +4874,11 @@ export declare function tableRow(cells: UiElement[]): TableRow;
3533
4874
  * Creates a `TableElement` component instance.
3534
4875
  *
3535
4876
  * @remarks
3536
- * Structured tabular data representation.
3537
- * Supports header/borderless modes, 2-column key-value tables, and 3-column data tables.
4877
+ * Use for data that benefits from aligned rows and columns, including key/value and multi-column tables. Supply rows in display order; explicit columns are optional, and divider/striping flags independently control visual separators and alternating backgrounds.
3538
4878
  *
3539
4879
  * @param rows - Tabular data rows
4880
+
4881
+ Ordered table rows. Each row's cells correspond positionally to the declared columns.
3540
4882
  * @param options - Optional settings (isStriped (defaults to `false`), withColumnSeparators (defaults to `false`), withRowSeparators (defaults to `false`), columns).
3541
4883
  * @returns A strongly-typed `TableElement` object.
3542
4884
  */
@@ -3550,9 +4892,11 @@ export declare function table(rows: TableRow[], options?: {
3550
4892
  * Creates a `RepeatingGroupEntry` component instance.
3551
4893
  *
3552
4894
  * @remarks
3553
- * Single entry within a repeating group.
4895
+ * A repeating entry carries a stable display label and either one primary value or a list of nested elements, depending on the shape needed by the feature.
3554
4896
  *
3555
4897
  * @param label - Entry label
4898
+
4899
+ Short label identifying this entry within the repeated group.
3556
4900
  * @param options - Optional settings (value, elements).
3557
4901
  * @returns A strongly-typed `RepeatingGroupEntry` object.
3558
4902
  */
@@ -3564,9 +4908,11 @@ export declare function repeatingGroupEntry(label: string, options?: {
3564
4908
  * Creates a `RepeatingGroupElement` component instance.
3565
4909
  *
3566
4910
  * @remarks
3567
- * Repeating group container where entries share uniform structure and retain per-entry labels.
4911
+ * Groups a sequence of labeled entries under one optional section title. Use it when records have the same general presentation but need their own labels.
3568
4912
  *
3569
4913
  * @param entries - List of repeated entry records
4914
+
4915
+ Entries in display order. Each entry supplies its own label and content.
3570
4916
  * @param options - Optional settings (title).
3571
4917
  * @returns A strongly-typed `RepeatingGroupElement` object.
3572
4918
  */
@@ -3577,10 +4923,14 @@ export declare function repeatingGroup(entries: RepeatingGroupEntry[], options?:
3577
4923
  * Creates a `CollapsibleGroupElement` component instance.
3578
4924
  *
3579
4925
  * @remarks
3580
- * Collapsible disclosure container (accordion) with summary badge.
4926
+ * Groups nested content behind a disclosure control. The title names the group, summary can provide a compact status indicator, and defaultExpanded controls only the initial state.
3581
4927
  *
3582
4928
  * @param title - Group title (e.g. "Show specimen details")
4929
+
4930
+ Text shown on the disclosure control. Use a concise action or section name that remains meaningful while the content is collapsed.
3583
4931
  * @param elements - Nested content elements revealed when expanded
4932
+
4933
+ Ordered child elements made visible by expanding the group.
3584
4934
  * @param options - Optional settings (summary, defaultExpanded (defaults to `false`)).
3585
4935
  * @returns A strongly-typed `CollapsibleGroupElement` object.
3586
4936
  */
@@ -3592,7 +4942,7 @@ export declare function collapsibleGroup(title: string, elements: UiElement[], o
3592
4942
  * Creates a `DividerElement` component instance.
3593
4943
  *
3594
4944
  * @remarks
3595
- * Visual hairline separator separating sections or element groups.
4945
+ * A standalone visual separator for dividing adjacent sections or element groups. Use the divider flags on tables or rows when the separator is part of that structure.
3596
4946
  *
3597
4947
  * @param options - Optional settings (style (defaults to `hairline`)).
3598
4948
  * @returns A strongly-typed `DividerElement` object.
@@ -3604,7 +4954,7 @@ export declare function divider(options?: {
3604
4954
  * Creates a `Envelop` component instance.
3605
4955
  *
3606
4956
  * @remarks
3607
- * Base envelope container model holding the schema version attribute.
4957
+ * All root ViewKit documents extend this envelope so consumers can identify the schema contract version before processing the root content.
3608
4958
  *
3609
4959
  * @param options - Optional settings (schemaVersion (defaults to `1.0`)).
3610
4960
  * @returns A strongly-typed `Envelop` object.