@picteus/extension-sdk 0.16.0 → 0.17.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.
- package/dist/generated/viewKit.d.ts +221 -252
- package/dist/generated/viewKit.js +189 -266
- package/dist/picteus-ws-client/apis/AdministrationApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/AdministrationApi.js +1 -1
- package/dist/picteus-ws-client/apis/ApiSecretApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/ApiSecretApi.js +1 -1
- package/dist/picteus-ws-client/apis/CollectionApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/CollectionApi.js +1 -1
- package/dist/picteus-ws-client/apis/ExtensionApi.d.ts +5 -3
- package/dist/picteus-ws-client/apis/ExtensionApi.js +2 -2
- package/dist/picteus-ws-client/apis/ImageApi.d.ts +36 -5
- package/dist/picteus-ws-client/apis/ImageApi.js +44 -3
- package/dist/picteus-ws-client/apis/ImageAttachmentApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/ImageAttachmentApi.js +1 -1
- package/dist/picteus-ws-client/apis/MiscellaneousApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/MiscellaneousApi.js +1 -1
- package/dist/picteus-ws-client/apis/RepositoryApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/RepositoryApi.js +1 -1
- package/dist/picteus-ws-client/apis/SettingsApi.d.ts +1 -1
- package/dist/picteus-ws-client/apis/SettingsApi.js +1 -1
- package/dist/picteus-ws-client/models/ApiSecret.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApiSecret.js +1 -1
- package/dist/picteus-ws-client/models/ApiSecretSummary.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApiSecretSummary.js +1 -1
- package/dist/picteus-ws-client/models/ApiSecretType.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApiSecretType.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationConfiguration.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApplicationConfiguration.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadata.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadata.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadataItem.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadataItem.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationMetadataItemValue.d.ts +4 -2
- package/dist/picteus-ws-client/models/ApplicationMetadataItemValue.js +1 -1
- package/dist/picteus-ws-client/models/ApplicationSettings.d.ts +1 -1
- package/dist/picteus-ws-client/models/ApplicationSettings.js +1 -1
- package/dist/picteus-ws-client/models/Collection.d.ts +1 -1
- package/dist/picteus-ws-client/models/Collection.js +1 -1
- package/dist/picteus-ws-client/models/CommandEntity.d.ts +1 -1
- package/dist/picteus-ws-client/models/CommandEntity.js +1 -1
- package/dist/picteus-ws-client/models/ComputedImageFormat.d.ts +1 -1
- package/dist/picteus-ws-client/models/ComputedImageFormat.js +1 -1
- package/dist/picteus-ws-client/models/ConfigurationCapability.d.ts +1 -1
- package/dist/picteus-ws-client/models/ConfigurationCapability.js +1 -1
- package/dist/picteus-ws-client/models/ConfigurationExtensionCommand.d.ts +1 -1
- package/dist/picteus-ws-client/models/ConfigurationExtensionCommand.js +1 -1
- package/dist/picteus-ws-client/models/ConstantsRegistry.d.ts +1 -1
- package/dist/picteus-ws-client/models/ConstantsRegistry.js +1 -1
- package/dist/picteus-ws-client/models/Dates.d.ts +1 -1
- package/dist/picteus-ws-client/models/Dates.js +1 -1
- package/dist/picteus-ws-client/models/Extension.d.ts +1 -1
- package/dist/picteus-ws-client/models/Extension.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionActivity.d.ts +23 -5
- package/dist/picteus-ws-client/models/ExtensionActivity.js +17 -5
- package/dist/picteus-ws-client/models/ExtensionActivityState.d.ts +25 -0
- package/dist/picteus-ws-client/models/ExtensionActivityState.js +43 -0
- package/dist/picteus-ws-client/models/ExtensionAndManual.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionAndManual.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionCategory.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionCategory.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionGenerationOptions.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionGenerationOptions.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionIdImageEmbeddingName.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionIdImageEmbeddingName.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageEmbeddings.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageEmbeddings.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeature.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeature.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeatureName.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeatureName.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeaturesAttribute.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageFeaturesAttribute.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageTag.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageTag.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageTagsAttribute.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionImageTagsAttribute.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionManual.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionManual.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionSettings.d.ts +5 -3
- package/dist/picteus-ws-client/models/ExtensionSettings.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionState.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionState.js +1 -1
- package/dist/picteus-ws-client/models/ExtensionsConfiguration.d.ts +1 -1
- package/dist/picteus-ws-client/models/ExtensionsConfiguration.js +1 -1
- package/dist/picteus-ws-client/models/GenerationRecipe.d.ts +13 -1
- package/dist/picteus-ws-client/models/GenerationRecipe.js +5 -1
- package/dist/picteus-ws-client/models/GenerationRecipePrompt.d.ts +1 -1
- package/dist/picteus-ws-client/models/GenerationRecipePrompt.js +1 -1
- package/dist/picteus-ws-client/models/Image.d.ts +1 -1
- package/dist/picteus-ws-client/models/Image.js +1 -1
- package/dist/picteus-ws-client/models/ImageDimensions.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageDimensions.js +1 -1
- package/dist/picteus-ws-client/models/ImageDistance.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageDistance.js +1 -1
- package/dist/picteus-ws-client/models/ImageEmbedding.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageEmbedding.js +1 -1
- package/dist/picteus-ws-client/models/ImageFeature.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFeature.js +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureFormat.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureFormat.js +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureNullValue.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureNullValue.js +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureType.d.ts +2 -1
- package/dist/picteus-ws-client/models/ImageFeatureType.js +2 -1
- package/dist/picteus-ws-client/models/ImageFeatureValue.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFeatureValue.js +1 -1
- package/dist/picteus-ws-client/models/ImageFormat.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageFormat.js +1 -1
- package/dist/picteus-ws-client/models/ImageMediaUrl.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageMediaUrl.js +1 -1
- package/dist/picteus-ws-client/models/ImageMetadata.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageMetadata.js +1 -1
- package/dist/picteus-ws-client/models/ImageResizeRender.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageResizeRender.js +1 -1
- package/dist/picteus-ws-client/models/ImageSummary.d.ts +1 -1
- package/dist/picteus-ws-client/models/ImageSummary.js +1 -1
- package/dist/picteus-ws-client/models/InstructionsPrompt.d.ts +5 -3
- package/dist/picteus-ws-client/models/InstructionsPrompt.js +1 -1
- package/dist/picteus-ws-client/models/Manifest.d.ts +5 -3
- package/dist/picteus-ws-client/models/Manifest.js +1 -1
- package/dist/picteus-ws-client/models/ManifestCapability.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestCapability.js +1 -1
- package/dist/picteus-ws-client/models/ManifestCapabilityId.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestCapabilityId.js +1 -1
- package/dist/picteus-ws-client/models/ManifestEvent.d.ts +1 -3
- package/dist/picteus-ws-client/models/ManifestEvent.js +1 -3
- package/dist/picteus-ws-client/models/ManifestExecution.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestExecution.js +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommand.d.ts +5 -3
- package/dist/picteus-ws-client/models/ManifestExtensionCommand.js +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandOn.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandOn.js +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandSpecification.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandSpecification.js +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandUi.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestExtensionCommandUi.js +1 -1
- package/dist/picteus-ws-client/models/ManifestInstructions.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestInstructions.js +1 -1
- package/dist/picteus-ws-client/models/ManifestInterfaceElement.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestInterfaceElement.js +1 -1
- package/dist/picteus-ws-client/models/ManifestInterfaceElementIntegration.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestInterfaceElementIntegration.js +1 -1
- package/dist/picteus-ws-client/models/ManifestRuntime.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestRuntime.js +1 -1
- package/dist/picteus-ws-client/models/ManifestRuntimeEnvironment.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestRuntimeEnvironment.js +1 -1
- package/dist/picteus-ws-client/models/ManifestThrottlingPolicy.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestThrottlingPolicy.js +1 -1
- package/dist/picteus-ws-client/models/ManifestUserInterface.d.ts +1 -1
- package/dist/picteus-ws-client/models/ManifestUserInterface.js +1 -1
- package/dist/picteus-ws-client/models/PromptKind.d.ts +1 -1
- package/dist/picteus-ws-client/models/PromptKind.js +1 -1
- package/dist/picteus-ws-client/models/Repository.d.ts +1 -1
- package/dist/picteus-ws-client/models/Repository.js +1 -1
- package/dist/picteus-ws-client/models/RepositoryActivity.d.ts +1 -1
- package/dist/picteus-ws-client/models/RepositoryActivity.js +1 -1
- package/dist/picteus-ws-client/models/RepositoryActivityKind.d.ts +1 -1
- package/dist/picteus-ws-client/models/RepositoryActivityKind.js +1 -1
- package/dist/picteus-ws-client/models/RepositoryLocationType.d.ts +1 -1
- package/dist/picteus-ws-client/models/RepositoryLocationType.js +1 -1
- package/dist/picteus-ws-client/models/RepositoryState.d.ts +1 -1
- package/dist/picteus-ws-client/models/RepositoryState.js +1 -1
- package/dist/picteus-ws-client/models/RunCommandParameters.d.ts +5 -3
- package/dist/picteus-ws-client/models/RunCommandParameters.js +1 -1
- package/dist/picteus-ws-client/models/SearchCriteria.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchCriteria.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureComparisonOperator.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureComparisonOperator.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureCondition.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureCondition.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureConditionValue.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureConditionValue.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureLogicalOperator.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatureLogicalOperator.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeatures.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeatures.js +1 -1
- package/dist/picteus-ws-client/models/SearchFeaturesResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFeaturesResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchFilter.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFilter.js +1 -1
- package/dist/picteus-ws-client/models/SearchFilterOrigin.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchFilterOrigin.js +1 -1
- package/dist/picteus-ws-client/models/SearchImageIdResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchImageIdResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchImageResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchImageResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchImageSummaryResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchImageSummaryResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchImagesOrigin.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchImagesOrigin.js +1 -1
- package/dist/picteus-ws-client/models/SearchKeyword.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchKeyword.js +1 -1
- package/dist/picteus-ws-client/models/SearchMediaUrlResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchMediaUrlResult.js +1 -1
- package/dist/picteus-ws-client/models/SearchOriginNature.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchOriginNature.js +1 -1
- package/dist/picteus-ws-client/models/SearchParameters.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchParameters.js +1 -1
- package/dist/picteus-ws-client/models/SearchProperties.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchProperties.js +1 -1
- package/dist/picteus-ws-client/models/SearchPropertyRange.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchPropertyRange.js +1 -1
- package/dist/picteus-ws-client/models/SearchRange.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchRange.js +1 -1
- package/dist/picteus-ws-client/models/SearchRepositoriesOrigin.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchRepositoriesOrigin.js +1 -1
- package/dist/picteus-ws-client/models/SearchSorting.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchSorting.js +1 -1
- package/dist/picteus-ws-client/models/SearchSortingProperty.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchSortingProperty.js +1 -1
- package/dist/picteus-ws-client/models/SearchTags.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchTags.js +1 -1
- package/dist/picteus-ws-client/models/SearchTagsResult.d.ts +1 -1
- package/dist/picteus-ws-client/models/SearchTagsResult.js +1 -1
- package/dist/picteus-ws-client/models/Software.d.ts +1 -1
- package/dist/picteus-ws-client/models/Software.js +1 -1
- package/dist/picteus-ws-client/models/TextualPrompt.d.ts +1 -1
- package/dist/picteus-ws-client/models/TextualPrompt.js +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceAnchor.d.ts +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceAnchor.js +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceSidebarIntegration.d.ts +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceSidebarIntegration.js +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceWindowIntegration.d.ts +1 -1
- package/dist/picteus-ws-client/models/UserInterfaceWindowIntegration.js +1 -1
- package/dist/picteus-ws-client/models/index.d.ts +1 -1
- package/dist/picteus-ws-client/models/index.js +1 -1
- package/dist/picteus-ws-client/runtime.d.ts +1 -1
- package/dist/picteus-ws-client/runtime.js +1 -1
- package/dist/picteusExtension.d.ts +1 -1
- package/dist/picteusExtension.js +1 -1
- package/package.json +1 -1
|
@@ -25,6 +25,17 @@ export declare enum TextIntensity {
|
|
|
25
25
|
medium = "medium",
|
|
26
26
|
high = "high"
|
|
27
27
|
}
|
|
28
|
+
/** Geometric shape representation for visual containers and indicators. */
|
|
29
|
+
export declare enum Shape {
|
|
30
|
+
circle = "circle",
|
|
31
|
+
square = "square"
|
|
32
|
+
}
|
|
33
|
+
/** Relative sizing scale for visual elements and indicators. */
|
|
34
|
+
export declare enum Size {
|
|
35
|
+
small = "small",
|
|
36
|
+
medium = "medium",
|
|
37
|
+
large = "large"
|
|
38
|
+
}
|
|
28
39
|
/** Representation style for short string values. */
|
|
29
40
|
export declare enum StringShortRepresentation {
|
|
30
41
|
plain = "plain",
|
|
@@ -45,7 +56,7 @@ export declare enum BadgeVariant {
|
|
|
45
56
|
}
|
|
46
57
|
/** Presentation format styles for timestamp elements. */
|
|
47
58
|
export declare enum TimestampFormat {
|
|
48
|
-
|
|
59
|
+
datetime = "datetime",
|
|
49
60
|
date = "date",
|
|
50
61
|
time = "time",
|
|
51
62
|
relative = "relative"
|
|
@@ -245,21 +256,41 @@ export interface RatioElement extends UiElementBase {
|
|
|
245
256
|
* @defaultValue "ratio"
|
|
246
257
|
*/
|
|
247
258
|
readonly type: "ratio";
|
|
248
|
-
/** Aspect ratio
|
|
249
|
-
readonly value:
|
|
259
|
+
/** Aspect ratio numerical expression */
|
|
260
|
+
readonly value: number;
|
|
250
261
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
251
262
|
readonly modifiers?: PrimitiveModifiers;
|
|
252
263
|
}
|
|
253
|
-
/** Single color
|
|
264
|
+
/** Single color representation with hex value, shape/size styling, text display toggle, and copy affordance. */
|
|
254
265
|
export interface ColourElement extends UiElementBase {
|
|
255
266
|
/**
|
|
256
267
|
* Discriminator type
|
|
257
268
|
*
|
|
258
|
-
* @defaultValue "color
|
|
269
|
+
* @defaultValue "color"
|
|
259
270
|
*/
|
|
260
|
-
readonly type: "color
|
|
271
|
+
readonly type: "color";
|
|
261
272
|
/** Hexadecimal color code */
|
|
262
273
|
readonly value: string;
|
|
274
|
+
/** Optional descriptive color name label */
|
|
275
|
+
readonly label?: string;
|
|
276
|
+
/**
|
|
277
|
+
* Whether to display the textual color code or label next to the swatch
|
|
278
|
+
*
|
|
279
|
+
* @defaultValue true
|
|
280
|
+
*/
|
|
281
|
+
readonly showText?: boolean;
|
|
282
|
+
/**
|
|
283
|
+
* Visual shape of the color indicator
|
|
284
|
+
*
|
|
285
|
+
* @defaultValue Shape.circle
|
|
286
|
+
*/
|
|
287
|
+
readonly shape?: Shape;
|
|
288
|
+
/**
|
|
289
|
+
* Visual size of the color indicator
|
|
290
|
+
*
|
|
291
|
+
* @defaultValue Size.medium
|
|
292
|
+
*/
|
|
293
|
+
readonly size?: Size;
|
|
263
294
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
264
295
|
readonly modifiers?: PrimitiveModifiers;
|
|
265
296
|
}
|
|
@@ -366,12 +397,12 @@ export interface TimestampElement extends UiElementBase {
|
|
|
366
397
|
* @defaultValue "timestamp"
|
|
367
398
|
*/
|
|
368
399
|
readonly type: "timestamp";
|
|
369
|
-
/**
|
|
370
|
-
readonly value:
|
|
400
|
+
/** The timestamp in milliseconds */
|
|
401
|
+
readonly value: number;
|
|
371
402
|
/**
|
|
372
403
|
* Presentation date/time format
|
|
373
404
|
*
|
|
374
|
-
* @defaultValue TimestampFormat.
|
|
405
|
+
* @defaultValue TimestampFormat.datetime
|
|
375
406
|
*/
|
|
376
407
|
readonly format?: TimestampFormat;
|
|
377
408
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
@@ -398,17 +429,6 @@ export interface ImageReferenceElement extends UiElementBase {
|
|
|
398
429
|
/** Fallback placeholder image URI */
|
|
399
430
|
readonly placeholder?: string;
|
|
400
431
|
}
|
|
401
|
-
/** Dominant color set palette rendered in descending dominance order. */
|
|
402
|
-
export interface DominantColourSetElement extends UiElementBase {
|
|
403
|
-
/**
|
|
404
|
-
* Discriminator type
|
|
405
|
-
*
|
|
406
|
-
* @defaultValue "color-set"
|
|
407
|
-
*/
|
|
408
|
-
readonly type: "color-set";
|
|
409
|
-
/** List of hexadecimal color strings in descending priority */
|
|
410
|
-
readonly colors: string[];
|
|
411
|
-
}
|
|
412
432
|
/** Interactive button action triggering an extension command. */
|
|
413
433
|
export interface ButtonActionElement extends UiActionBase {
|
|
414
434
|
/**
|
|
@@ -488,7 +508,7 @@ export interface Slot {
|
|
|
488
508
|
* Multi-slot horizontal row with declared column width proportions.
|
|
489
509
|
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
490
510
|
*/
|
|
491
|
-
export interface
|
|
511
|
+
export interface MultiSlotElement extends UiElementBase {
|
|
492
512
|
/**
|
|
493
513
|
* Discriminator type
|
|
494
514
|
*
|
|
@@ -500,11 +520,25 @@ export interface MultiSlotRowElement extends UiElementBase {
|
|
|
500
520
|
/** List of slots comprising the row */
|
|
501
521
|
readonly slots: Slot[];
|
|
502
522
|
}
|
|
523
|
+
/**
|
|
524
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
525
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
526
|
+
*/
|
|
527
|
+
export interface FlowingElement extends UiElementBase {
|
|
528
|
+
/**
|
|
529
|
+
* Discriminator type
|
|
530
|
+
*
|
|
531
|
+
* @defaultValue "flowing"
|
|
532
|
+
*/
|
|
533
|
+
readonly type: "flowing";
|
|
534
|
+
/** List of child elements rendered sequentially with line wrapping */
|
|
535
|
+
readonly elements: UiElement[];
|
|
536
|
+
}
|
|
503
537
|
/**
|
|
504
538
|
* Standard label and value row.
|
|
505
539
|
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
506
540
|
*/
|
|
507
|
-
export interface
|
|
541
|
+
export interface LabelValueElement extends UiElementBase {
|
|
508
542
|
/**
|
|
509
543
|
* Discriminator type
|
|
510
544
|
*
|
|
@@ -669,7 +703,7 @@ export interface UiCard extends UiContainer {
|
|
|
669
703
|
* Uses the @discriminator("type") decorator so all child models inheriting from UiElement
|
|
670
704
|
* are automatically recognized by schema emitters and SDK code generators.
|
|
671
705
|
*/
|
|
672
|
-
export type UiElement = StringShortElement | StringLongElement | StringCodeElement | XmlElement | JsonElement | StringUrlElement | IdentifierElement | RatioElement | ColourElement | NumberUnboundedElement | NumberBoundedStarsElement | NumberBoundedMeterElement | BooleanPlainElement | BooleanBadgeElement | TimestampElement | ImageReferenceElement |
|
|
706
|
+
export type UiElement = StringShortElement | StringLongElement | StringCodeElement | XmlElement | JsonElement | StringUrlElement | IdentifierElement | RatioElement | ColourElement | NumberUnboundedElement | NumberBoundedStarsElement | NumberBoundedMeterElement | BooleanPlainElement | BooleanBadgeElement | TimestampElement | ImageReferenceElement | MarkdownBlockElement | HtmlBlockElement | MultiSlotElement | FlowingElement | LabelValueElement | TableElement | RepeatingGroupElement | CollapsibleGroupElement | DividerElement;
|
|
673
707
|
/** Polymorphic base model for interactive actions. */
|
|
674
708
|
export type UiAction = ButtonActionElement | ExternalLinkActionElement;
|
|
675
709
|
/**
|
|
@@ -973,17 +1007,17 @@ export declare class RatioElementClass extends BaseUiElement<RatioElement> imple
|
|
|
973
1007
|
* @defaultValue "ratio"
|
|
974
1008
|
*/
|
|
975
1009
|
readonly type = "ratio";
|
|
976
|
-
/** Aspect ratio
|
|
977
|
-
readonly value:
|
|
1010
|
+
/** Aspect ratio numerical expression */
|
|
1011
|
+
readonly value: number;
|
|
978
1012
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
979
1013
|
readonly modifiers?: PrimitiveModifiers;
|
|
980
1014
|
/**
|
|
981
1015
|
* Constructs a new `RatioElementClass` instance.
|
|
982
1016
|
*
|
|
983
|
-
* @param value - Aspect ratio
|
|
1017
|
+
* @param value - Aspect ratio numerical expression
|
|
984
1018
|
* @param options - Optional component settings. (modifiers).
|
|
985
1019
|
*/
|
|
986
|
-
constructor(value:
|
|
1020
|
+
constructor(value: number, options?: {
|
|
987
1021
|
modifiers?: PrimitiveModifiers;
|
|
988
1022
|
});
|
|
989
1023
|
}
|
|
@@ -991,26 +1025,50 @@ export declare class RatioElementClass extends BaseUiElement<RatioElement> imple
|
|
|
991
1025
|
* Class implementation of the `ColourElement` interface.
|
|
992
1026
|
*
|
|
993
1027
|
* @remarks
|
|
994
|
-
* Single color
|
|
1028
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
995
1029
|
*/
|
|
996
1030
|
export declare class ColourElementClass extends BaseUiElement<ColourElement> implements ColourElement {
|
|
997
1031
|
/**
|
|
998
1032
|
* Discriminator identifier for `ColourElement`.
|
|
999
1033
|
*
|
|
1000
|
-
* @defaultValue "color
|
|
1034
|
+
* @defaultValue "color"
|
|
1001
1035
|
*/
|
|
1002
|
-
readonly type = "color
|
|
1036
|
+
readonly type = "color";
|
|
1003
1037
|
/** Hexadecimal color code */
|
|
1004
1038
|
readonly value: string;
|
|
1039
|
+
/** Optional descriptive color name label */
|
|
1040
|
+
readonly label?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Whether to display the textual color code or label next to the swatch
|
|
1043
|
+
*
|
|
1044
|
+
* @defaultValue true
|
|
1045
|
+
*/
|
|
1046
|
+
readonly showText?: boolean;
|
|
1047
|
+
/**
|
|
1048
|
+
* Visual shape of the color indicator
|
|
1049
|
+
*
|
|
1050
|
+
* @defaultValue Shape.circle
|
|
1051
|
+
*/
|
|
1052
|
+
readonly shape?: Shape;
|
|
1053
|
+
/**
|
|
1054
|
+
* Visual size of the color indicator
|
|
1055
|
+
*
|
|
1056
|
+
* @defaultValue Size.medium
|
|
1057
|
+
*/
|
|
1058
|
+
readonly size?: Size;
|
|
1005
1059
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
1006
1060
|
readonly modifiers?: PrimitiveModifiers;
|
|
1007
1061
|
/**
|
|
1008
1062
|
* Constructs a new `ColourElementClass` instance.
|
|
1009
1063
|
*
|
|
1010
1064
|
* @param value - Hexadecimal color code
|
|
1011
|
-
* @param options - Optional component settings. (modifiers).
|
|
1065
|
+
* @param options - Optional component settings. (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
1012
1066
|
*/
|
|
1013
1067
|
constructor(value: string, options?: {
|
|
1068
|
+
label?: string;
|
|
1069
|
+
showText?: boolean;
|
|
1070
|
+
shape?: Shape;
|
|
1071
|
+
size?: Size;
|
|
1014
1072
|
modifiers?: PrimitiveModifiers;
|
|
1015
1073
|
});
|
|
1016
1074
|
}
|
|
@@ -1201,12 +1259,12 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
|
|
|
1201
1259
|
* @defaultValue "timestamp"
|
|
1202
1260
|
*/
|
|
1203
1261
|
readonly type = "timestamp";
|
|
1204
|
-
/**
|
|
1205
|
-
readonly value:
|
|
1262
|
+
/** The timestamp in milliseconds */
|
|
1263
|
+
readonly value: number;
|
|
1206
1264
|
/**
|
|
1207
1265
|
* Presentation date/time format
|
|
1208
1266
|
*
|
|
1209
|
-
* @defaultValue TimestampFormat.
|
|
1267
|
+
* @defaultValue TimestampFormat.datetime
|
|
1210
1268
|
*/
|
|
1211
1269
|
readonly format?: TimestampFormat;
|
|
1212
1270
|
/** Optional visual modifiers (copyable, truncate, emphasis, monospace) */
|
|
@@ -1214,10 +1272,10 @@ export declare class TimestampElementClass extends BaseUiElement<TimestampElemen
|
|
|
1214
1272
|
/**
|
|
1215
1273
|
* Constructs a new `TimestampElementClass` instance.
|
|
1216
1274
|
*
|
|
1217
|
-
* @param value -
|
|
1218
|
-
* @param options - Optional component settings. (format (defaults to `
|
|
1275
|
+
* @param value - The timestamp in milliseconds
|
|
1276
|
+
* @param options - Optional component settings. (format (defaults to `datetime`), modifiers).
|
|
1219
1277
|
*/
|
|
1220
|
-
constructor(value:
|
|
1278
|
+
constructor(value: number, options?: {
|
|
1221
1279
|
format?: TimestampFormat;
|
|
1222
1280
|
modifiers?: PrimitiveModifiers;
|
|
1223
1281
|
});
|
|
@@ -1259,28 +1317,6 @@ export declare class ImageReferenceElementClass extends BaseUiElement<ImageRefer
|
|
|
1259
1317
|
placeholder?: string;
|
|
1260
1318
|
});
|
|
1261
1319
|
}
|
|
1262
|
-
/**
|
|
1263
|
-
* Class implementation of the `DominantColourSetElement` interface.
|
|
1264
|
-
*
|
|
1265
|
-
* @remarks
|
|
1266
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
1267
|
-
*/
|
|
1268
|
-
export declare class DominantColourSetElementClass extends BaseUiElement<DominantColourSetElement> implements DominantColourSetElement {
|
|
1269
|
-
/**
|
|
1270
|
-
* Discriminator identifier for `DominantColourSetElement`.
|
|
1271
|
-
*
|
|
1272
|
-
* @defaultValue "color-set"
|
|
1273
|
-
*/
|
|
1274
|
-
readonly type = "color-set";
|
|
1275
|
-
/** List of hexadecimal color strings in descending priority */
|
|
1276
|
-
readonly colors: string[];
|
|
1277
|
-
/**
|
|
1278
|
-
* Constructs a new `DominantColourSetElementClass` instance.
|
|
1279
|
-
*
|
|
1280
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
1281
|
-
*/
|
|
1282
|
-
constructor(colors: string[]);
|
|
1283
|
-
}
|
|
1284
1320
|
/**
|
|
1285
1321
|
* Class implementation of the `ButtonActionElement` interface.
|
|
1286
1322
|
*
|
|
@@ -1435,15 +1471,15 @@ export declare class SlotClass extends ViewKitNode<Slot> implements Slot {
|
|
|
1435
1471
|
});
|
|
1436
1472
|
}
|
|
1437
1473
|
/**
|
|
1438
|
-
* Class implementation of the `
|
|
1474
|
+
* Class implementation of the `MultiSlotElement` interface.
|
|
1439
1475
|
*
|
|
1440
1476
|
* @remarks
|
|
1441
1477
|
* Multi-slot horizontal row with declared column width proportions.
|
|
1442
1478
|
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
1443
1479
|
*/
|
|
1444
|
-
export declare class
|
|
1480
|
+
export declare class MultiSlotElementClass extends BaseUiElement<MultiSlotElement> implements MultiSlotElement {
|
|
1445
1481
|
/**
|
|
1446
|
-
* Discriminator identifier for `
|
|
1482
|
+
* Discriminator identifier for `MultiSlotElement`.
|
|
1447
1483
|
*
|
|
1448
1484
|
* @defaultValue "multi-slot"
|
|
1449
1485
|
*/
|
|
@@ -1453,7 +1489,7 @@ export declare class MultiSlotRowElementClass extends BaseUiElement<MultiSlotRow
|
|
|
1453
1489
|
/** Proportions descriptor (e.g. "1/3 + 2/3", "equal", "1/4 + 3/4") */
|
|
1454
1490
|
readonly proportions?: string;
|
|
1455
1491
|
/**
|
|
1456
|
-
* Constructs a new `
|
|
1492
|
+
* Constructs a new `MultiSlotElementClass` instance.
|
|
1457
1493
|
*
|
|
1458
1494
|
* @param slots - List of slots comprising the row
|
|
1459
1495
|
* @param options - Optional component settings. (proportions).
|
|
@@ -1463,15 +1499,38 @@ export declare class MultiSlotRowElementClass extends BaseUiElement<MultiSlotRow
|
|
|
1463
1499
|
});
|
|
1464
1500
|
}
|
|
1465
1501
|
/**
|
|
1466
|
-
* Class implementation of the `
|
|
1502
|
+
* Class implementation of the `FlowingElement` interface.
|
|
1503
|
+
*
|
|
1504
|
+
* @remarks
|
|
1505
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
1506
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
1507
|
+
*/
|
|
1508
|
+
export declare class FlowingElementClass extends BaseUiElement<FlowingElement> implements FlowingElement {
|
|
1509
|
+
/**
|
|
1510
|
+
* Discriminator identifier for `FlowingElement`.
|
|
1511
|
+
*
|
|
1512
|
+
* @defaultValue "flowing"
|
|
1513
|
+
*/
|
|
1514
|
+
readonly type = "flowing";
|
|
1515
|
+
/** List of child elements rendered sequentially with line wrapping */
|
|
1516
|
+
readonly elements: UiElement[];
|
|
1517
|
+
/**
|
|
1518
|
+
* Constructs a new `FlowingElementClass` instance.
|
|
1519
|
+
*
|
|
1520
|
+
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
1521
|
+
*/
|
|
1522
|
+
constructor(elements: UiElement[]);
|
|
1523
|
+
}
|
|
1524
|
+
/**
|
|
1525
|
+
* Class implementation of the `LabelValueElement` interface.
|
|
1467
1526
|
*
|
|
1468
1527
|
* @remarks
|
|
1469
1528
|
* Standard label and value row.
|
|
1470
1529
|
* Displays a muted label on the left and value representation on the right with a vertical dividing line.
|
|
1471
1530
|
*/
|
|
1472
|
-
export declare class
|
|
1531
|
+
export declare class LabelValueElementClass extends BaseUiElement<LabelValueElement> implements LabelValueElement {
|
|
1473
1532
|
/**
|
|
1474
|
-
* Discriminator identifier for `
|
|
1533
|
+
* Discriminator identifier for `LabelValueElement`.
|
|
1475
1534
|
*
|
|
1476
1535
|
* @defaultValue "label-value"
|
|
1477
1536
|
*/
|
|
@@ -1487,7 +1546,7 @@ export declare class LabelValueRowElementClass extends BaseUiElement<LabelValueR
|
|
|
1487
1546
|
*/
|
|
1488
1547
|
readonly withDivider?: boolean;
|
|
1489
1548
|
/**
|
|
1490
|
-
* Constructs a new `
|
|
1549
|
+
* Constructs a new `LabelValueElementClass` instance.
|
|
1491
1550
|
*
|
|
1492
1551
|
* @param label - Key or descriptive label displayed muted on the left
|
|
1493
1552
|
* @param value - Rendered value element on the right
|
|
@@ -1920,37 +1979,45 @@ export declare class UiContainerBuilder {
|
|
|
1920
1979
|
* @remarks
|
|
1921
1980
|
* Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
|
|
1922
1981
|
*
|
|
1923
|
-
* @param value - Aspect ratio
|
|
1982
|
+
* @param value - Aspect ratio numerical expression
|
|
1924
1983
|
* @param options - Optional component settings (modifiers).
|
|
1925
1984
|
* @returns This builder instance for method chaining.
|
|
1926
1985
|
*/
|
|
1927
|
-
addRatio(value:
|
|
1986
|
+
addRatio(value: number, options?: {
|
|
1928
1987
|
modifiers?: PrimitiveModifiers;
|
|
1929
1988
|
}): this;
|
|
1930
1989
|
/**
|
|
1931
1990
|
* Appends a `ColourElement` component.
|
|
1932
1991
|
*
|
|
1933
1992
|
* @remarks
|
|
1934
|
-
* Single color
|
|
1993
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
1935
1994
|
*
|
|
1936
1995
|
* @param value - Hexadecimal color code
|
|
1937
|
-
* @param options - Optional component settings (modifiers).
|
|
1996
|
+
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
1938
1997
|
* @returns This builder instance for method chaining.
|
|
1939
1998
|
*/
|
|
1940
1999
|
addColour(value: string, options?: {
|
|
2000
|
+
label?: string;
|
|
2001
|
+
showText?: boolean;
|
|
2002
|
+
shape?: Shape;
|
|
2003
|
+
size?: Size;
|
|
1941
2004
|
modifiers?: PrimitiveModifiers;
|
|
1942
2005
|
}): this;
|
|
1943
2006
|
/**
|
|
1944
2007
|
* Appends a `ColourElement` component.
|
|
1945
2008
|
*
|
|
1946
2009
|
* @remarks
|
|
1947
|
-
* Single color
|
|
2010
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
1948
2011
|
*
|
|
1949
2012
|
* @param value - Hexadecimal color code
|
|
1950
|
-
* @param options - Optional component settings (modifiers).
|
|
2013
|
+
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
1951
2014
|
* @returns This builder instance for method chaining.
|
|
1952
2015
|
*/
|
|
1953
|
-
|
|
2016
|
+
addColor(value: string, options?: {
|
|
2017
|
+
label?: string;
|
|
2018
|
+
showText?: boolean;
|
|
2019
|
+
shape?: Shape;
|
|
2020
|
+
size?: Size;
|
|
1954
2021
|
modifiers?: PrimitiveModifiers;
|
|
1955
2022
|
}): this;
|
|
1956
2023
|
/**
|
|
@@ -2064,11 +2131,11 @@ export declare class UiContainerBuilder {
|
|
|
2064
2131
|
* @remarks
|
|
2065
2132
|
* Formatted date and time representation.
|
|
2066
2133
|
*
|
|
2067
|
-
* @param value -
|
|
2068
|
-
* @param options - Optional component settings (format (defaults to `
|
|
2134
|
+
* @param value - The timestamp in milliseconds
|
|
2135
|
+
* @param options - Optional component settings (format (defaults to `datetime`), modifiers).
|
|
2069
2136
|
* @returns This builder instance for method chaining.
|
|
2070
2137
|
*/
|
|
2071
|
-
addTimestamp(value:
|
|
2138
|
+
addTimestamp(value: number, options?: {
|
|
2072
2139
|
format?: TimestampFormat;
|
|
2073
2140
|
modifiers?: PrimitiveModifiers;
|
|
2074
2141
|
}): this;
|
|
@@ -2102,26 +2169,6 @@ export declare class UiContainerBuilder {
|
|
|
2102
2169
|
aspectRatio?: string;
|
|
2103
2170
|
placeholder?: string;
|
|
2104
2171
|
}): this;
|
|
2105
|
-
/**
|
|
2106
|
-
* Appends a `DominantColourSetElement` component.
|
|
2107
|
-
*
|
|
2108
|
-
* @remarks
|
|
2109
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
2110
|
-
*
|
|
2111
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
2112
|
-
* @returns This builder instance for method chaining.
|
|
2113
|
-
*/
|
|
2114
|
-
addDominantColourSet(colors: string[]): this;
|
|
2115
|
-
/**
|
|
2116
|
-
* Appends a `DominantColourSetElement` component.
|
|
2117
|
-
*
|
|
2118
|
-
* @remarks
|
|
2119
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
2120
|
-
*
|
|
2121
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
2122
|
-
* @returns This builder instance for method chaining.
|
|
2123
|
-
*/
|
|
2124
|
-
addDominantColors(colors: string[]): this;
|
|
2125
2172
|
/**
|
|
2126
2173
|
* Appends a `MarkdownBlockElement` component.
|
|
2127
2174
|
*
|
|
@@ -2175,21 +2222,7 @@ export declare class UiContainerBuilder {
|
|
|
2175
2222
|
modifiers?: BaseModifiers;
|
|
2176
2223
|
}): this;
|
|
2177
2224
|
/**
|
|
2178
|
-
* Appends a `
|
|
2179
|
-
*
|
|
2180
|
-
* @remarks
|
|
2181
|
-
* Multi-slot horizontal row with declared column width proportions.
|
|
2182
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
2183
|
-
*
|
|
2184
|
-
* @param slots - List of slots comprising the row
|
|
2185
|
-
* @param options - Optional component settings (proportions).
|
|
2186
|
-
* @returns This builder instance for method chaining.
|
|
2187
|
-
*/
|
|
2188
|
-
addMultiSlotRow(slots: Slot[], options?: {
|
|
2189
|
-
proportions?: string;
|
|
2190
|
-
}): this;
|
|
2191
|
-
/**
|
|
2192
|
-
* Appends a `MultiSlotRowElement` component.
|
|
2225
|
+
* Appends a `MultiSlotElement` component.
|
|
2193
2226
|
*
|
|
2194
2227
|
* @remarks
|
|
2195
2228
|
* Multi-slot horizontal row with declared column width proportions.
|
|
@@ -2203,22 +2236,18 @@ export declare class UiContainerBuilder {
|
|
|
2203
2236
|
proportions?: string;
|
|
2204
2237
|
}): this;
|
|
2205
2238
|
/**
|
|
2206
|
-
* Appends a `
|
|
2239
|
+
* Appends a `FlowingElement` component.
|
|
2207
2240
|
*
|
|
2208
2241
|
* @remarks
|
|
2209
|
-
*
|
|
2210
|
-
*
|
|
2242
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
2243
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
2211
2244
|
*
|
|
2212
|
-
* @param
|
|
2213
|
-
* @param value - Rendered value element on the right
|
|
2214
|
-
* @param options - Optional component settings (withDivider (defaults to `false`)).
|
|
2245
|
+
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
2215
2246
|
* @returns This builder instance for method chaining.
|
|
2216
2247
|
*/
|
|
2217
|
-
|
|
2218
|
-
withDivider?: boolean;
|
|
2219
|
-
}): this;
|
|
2248
|
+
addFlowing(elements: UiElement[]): this;
|
|
2220
2249
|
/**
|
|
2221
|
-
* Appends a `
|
|
2250
|
+
* Appends a `LabelValueElement` component.
|
|
2222
2251
|
*
|
|
2223
2252
|
* @remarks
|
|
2224
2253
|
* Standard label and value row.
|
|
@@ -2515,37 +2544,45 @@ export declare class UiCardBuilder {
|
|
|
2515
2544
|
* @remarks
|
|
2516
2545
|
* Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
|
|
2517
2546
|
*
|
|
2518
|
-
* @param value - Aspect ratio
|
|
2547
|
+
* @param value - Aspect ratio numerical expression
|
|
2519
2548
|
* @param options - Optional component settings (modifiers).
|
|
2520
2549
|
* @returns This builder instance for method chaining.
|
|
2521
2550
|
*/
|
|
2522
|
-
addRatio(value:
|
|
2551
|
+
addRatio(value: number, options?: {
|
|
2523
2552
|
modifiers?: PrimitiveModifiers;
|
|
2524
2553
|
}): this;
|
|
2525
2554
|
/**
|
|
2526
2555
|
* Appends a `ColourElement` component.
|
|
2527
2556
|
*
|
|
2528
2557
|
* @remarks
|
|
2529
|
-
* Single color
|
|
2558
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
2530
2559
|
*
|
|
2531
2560
|
* @param value - Hexadecimal color code
|
|
2532
|
-
* @param options - Optional component settings (modifiers).
|
|
2561
|
+
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2533
2562
|
* @returns This builder instance for method chaining.
|
|
2534
2563
|
*/
|
|
2535
2564
|
addColour(value: string, options?: {
|
|
2565
|
+
label?: string;
|
|
2566
|
+
showText?: boolean;
|
|
2567
|
+
shape?: Shape;
|
|
2568
|
+
size?: Size;
|
|
2536
2569
|
modifiers?: PrimitiveModifiers;
|
|
2537
2570
|
}): this;
|
|
2538
2571
|
/**
|
|
2539
2572
|
* Appends a `ColourElement` component.
|
|
2540
2573
|
*
|
|
2541
2574
|
* @remarks
|
|
2542
|
-
* Single color
|
|
2575
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
2543
2576
|
*
|
|
2544
2577
|
* @param value - Hexadecimal color code
|
|
2545
|
-
* @param options - Optional component settings (modifiers).
|
|
2578
|
+
* @param options - Optional component settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
2546
2579
|
* @returns This builder instance for method chaining.
|
|
2547
2580
|
*/
|
|
2548
|
-
|
|
2581
|
+
addColor(value: string, options?: {
|
|
2582
|
+
label?: string;
|
|
2583
|
+
showText?: boolean;
|
|
2584
|
+
shape?: Shape;
|
|
2585
|
+
size?: Size;
|
|
2549
2586
|
modifiers?: PrimitiveModifiers;
|
|
2550
2587
|
}): this;
|
|
2551
2588
|
/**
|
|
@@ -2659,11 +2696,11 @@ export declare class UiCardBuilder {
|
|
|
2659
2696
|
* @remarks
|
|
2660
2697
|
* Formatted date and time representation.
|
|
2661
2698
|
*
|
|
2662
|
-
* @param value -
|
|
2663
|
-
* @param options - Optional component settings (format (defaults to `
|
|
2699
|
+
* @param value - The timestamp in milliseconds
|
|
2700
|
+
* @param options - Optional component settings (format (defaults to `datetime`), modifiers).
|
|
2664
2701
|
* @returns This builder instance for method chaining.
|
|
2665
2702
|
*/
|
|
2666
|
-
addTimestamp(value:
|
|
2703
|
+
addTimestamp(value: number, options?: {
|
|
2667
2704
|
format?: TimestampFormat;
|
|
2668
2705
|
modifiers?: PrimitiveModifiers;
|
|
2669
2706
|
}): this;
|
|
@@ -2697,26 +2734,6 @@ export declare class UiCardBuilder {
|
|
|
2697
2734
|
aspectRatio?: string;
|
|
2698
2735
|
placeholder?: string;
|
|
2699
2736
|
}): this;
|
|
2700
|
-
/**
|
|
2701
|
-
* Appends a `DominantColourSetElement` component.
|
|
2702
|
-
*
|
|
2703
|
-
* @remarks
|
|
2704
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
2705
|
-
*
|
|
2706
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
2707
|
-
* @returns This builder instance for method chaining.
|
|
2708
|
-
*/
|
|
2709
|
-
addDominantColourSet(colors: string[]): this;
|
|
2710
|
-
/**
|
|
2711
|
-
* Appends a `DominantColourSetElement` component.
|
|
2712
|
-
*
|
|
2713
|
-
* @remarks
|
|
2714
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
2715
|
-
*
|
|
2716
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
2717
|
-
* @returns This builder instance for method chaining.
|
|
2718
|
-
*/
|
|
2719
|
-
addDominantColors(colors: string[]): this;
|
|
2720
2737
|
/**
|
|
2721
2738
|
* Appends a `MarkdownBlockElement` component.
|
|
2722
2739
|
*
|
|
@@ -2770,21 +2787,7 @@ export declare class UiCardBuilder {
|
|
|
2770
2787
|
modifiers?: BaseModifiers;
|
|
2771
2788
|
}): this;
|
|
2772
2789
|
/**
|
|
2773
|
-
* Appends a `
|
|
2774
|
-
*
|
|
2775
|
-
* @remarks
|
|
2776
|
-
* Multi-slot horizontal row with declared column width proportions.
|
|
2777
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
2778
|
-
*
|
|
2779
|
-
* @param slots - List of slots comprising the row
|
|
2780
|
-
* @param options - Optional component settings (proportions).
|
|
2781
|
-
* @returns This builder instance for method chaining.
|
|
2782
|
-
*/
|
|
2783
|
-
addMultiSlotRow(slots: Slot[], options?: {
|
|
2784
|
-
proportions?: string;
|
|
2785
|
-
}): this;
|
|
2786
|
-
/**
|
|
2787
|
-
* Appends a `MultiSlotRowElement` component.
|
|
2790
|
+
* Appends a `MultiSlotElement` component.
|
|
2788
2791
|
*
|
|
2789
2792
|
* @remarks
|
|
2790
2793
|
* Multi-slot horizontal row with declared column width proportions.
|
|
@@ -2798,22 +2801,18 @@ export declare class UiCardBuilder {
|
|
|
2798
2801
|
proportions?: string;
|
|
2799
2802
|
}): this;
|
|
2800
2803
|
/**
|
|
2801
|
-
* Appends a `
|
|
2804
|
+
* Appends a `FlowingElement` component.
|
|
2802
2805
|
*
|
|
2803
2806
|
* @remarks
|
|
2804
|
-
*
|
|
2805
|
-
*
|
|
2807
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
2808
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
2806
2809
|
*
|
|
2807
|
-
* @param
|
|
2808
|
-
* @param value - Rendered value element on the right
|
|
2809
|
-
* @param options - Optional component settings (withDivider (defaults to `false`)).
|
|
2810
|
+
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
2810
2811
|
* @returns This builder instance for method chaining.
|
|
2811
2812
|
*/
|
|
2812
|
-
|
|
2813
|
-
withDivider?: boolean;
|
|
2814
|
-
}): this;
|
|
2813
|
+
addFlowing(elements: UiElement[]): this;
|
|
2815
2814
|
/**
|
|
2816
|
-
* Appends a `
|
|
2815
|
+
* Appends a `LabelValueElement` component.
|
|
2817
2816
|
*
|
|
2818
2817
|
* @remarks
|
|
2819
2818
|
* Standard label and value row.
|
|
@@ -3107,37 +3106,45 @@ export declare function identifier(value: string, options?: {
|
|
|
3107
3106
|
* @remarks
|
|
3108
3107
|
* Aspect ratio representation (e.g. "16:9", "4:3", "1:1").
|
|
3109
3108
|
*
|
|
3110
|
-
* @param value - Aspect ratio
|
|
3109
|
+
* @param value - Aspect ratio numerical expression
|
|
3111
3110
|
* @param options - Optional settings (modifiers).
|
|
3112
3111
|
* @returns A strongly-typed `RatioElement` object.
|
|
3113
3112
|
*/
|
|
3114
|
-
export declare function ratio(value:
|
|
3113
|
+
export declare function ratio(value: number, options?: {
|
|
3115
3114
|
modifiers?: PrimitiveModifiers;
|
|
3116
3115
|
}): RatioElement;
|
|
3117
3116
|
/**
|
|
3118
3117
|
* Creates a `ColourElement` component instance.
|
|
3119
3118
|
*
|
|
3120
3119
|
* @remarks
|
|
3121
|
-
* Single color
|
|
3120
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
3122
3121
|
*
|
|
3123
3122
|
* @param value - Hexadecimal color code
|
|
3124
|
-
* @param options - Optional settings (modifiers).
|
|
3123
|
+
* @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
3125
3124
|
* @returns A strongly-typed `ColourElement` object.
|
|
3126
3125
|
*/
|
|
3127
3126
|
export declare function colour(value: string, options?: {
|
|
3127
|
+
label?: string;
|
|
3128
|
+
showText?: boolean;
|
|
3129
|
+
shape?: Shape;
|
|
3130
|
+
size?: Size;
|
|
3128
3131
|
modifiers?: PrimitiveModifiers;
|
|
3129
3132
|
}): ColourElement;
|
|
3130
3133
|
/**
|
|
3131
3134
|
* Creates a `ColourElement` component instance.
|
|
3132
3135
|
*
|
|
3133
3136
|
* @remarks
|
|
3134
|
-
* Single color
|
|
3137
|
+
* Single color representation with hex value, shape/size styling, text display toggle, and copy affordance.
|
|
3135
3138
|
*
|
|
3136
3139
|
* @param value - Hexadecimal color code
|
|
3137
|
-
* @param options - Optional settings (modifiers).
|
|
3140
|
+
* @param options - Optional settings (label, showText (defaults to `true`), shape (defaults to `circle`), size (defaults to `medium`), modifiers).
|
|
3138
3141
|
* @returns A strongly-typed `ColourElement` object.
|
|
3139
3142
|
*/
|
|
3140
|
-
export declare function
|
|
3143
|
+
export declare function color(value: string, options?: {
|
|
3144
|
+
label?: string;
|
|
3145
|
+
showText?: boolean;
|
|
3146
|
+
shape?: Shape;
|
|
3147
|
+
size?: Size;
|
|
3141
3148
|
modifiers?: PrimitiveModifiers;
|
|
3142
3149
|
}): ColourElement;
|
|
3143
3150
|
/**
|
|
@@ -3251,11 +3258,11 @@ export declare function booleanBadge(value: boolean, options?: {
|
|
|
3251
3258
|
* @remarks
|
|
3252
3259
|
* Formatted date and time representation.
|
|
3253
3260
|
*
|
|
3254
|
-
* @param value -
|
|
3255
|
-
* @param options - Optional settings (format (defaults to `
|
|
3261
|
+
* @param value - The timestamp in milliseconds
|
|
3262
|
+
* @param options - Optional settings (format (defaults to `datetime`), modifiers).
|
|
3256
3263
|
* @returns A strongly-typed `TimestampElement` object.
|
|
3257
3264
|
*/
|
|
3258
|
-
export declare function timestamp(value:
|
|
3265
|
+
export declare function timestamp(value: number, options?: {
|
|
3259
3266
|
format?: TimestampFormat;
|
|
3260
3267
|
modifiers?: PrimitiveModifiers;
|
|
3261
3268
|
}): TimestampElement;
|
|
@@ -3289,26 +3296,6 @@ export declare function imageRef(src: string, options?: {
|
|
|
3289
3296
|
aspectRatio?: string;
|
|
3290
3297
|
placeholder?: string;
|
|
3291
3298
|
}): ImageReferenceElement;
|
|
3292
|
-
/**
|
|
3293
|
-
* Creates a `DominantColourSetElement` component instance.
|
|
3294
|
-
*
|
|
3295
|
-
* @remarks
|
|
3296
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
3297
|
-
*
|
|
3298
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
3299
|
-
* @returns A strongly-typed `DominantColourSetElement` object.
|
|
3300
|
-
*/
|
|
3301
|
-
export declare function dominantColourSet(colors: string[]): DominantColourSetElement;
|
|
3302
|
-
/**
|
|
3303
|
-
* Creates a `DominantColourSetElement` component instance.
|
|
3304
|
-
*
|
|
3305
|
-
* @remarks
|
|
3306
|
-
* Dominant color set palette rendered in descending dominance order.
|
|
3307
|
-
*
|
|
3308
|
-
* @param colors - List of hexadecimal color strings in descending priority
|
|
3309
|
-
* @returns A strongly-typed `DominantColourSetElement` object.
|
|
3310
|
-
*/
|
|
3311
|
-
export declare function dominantColors(colors: string[]): DominantColourSetElement;
|
|
3312
3299
|
/**
|
|
3313
3300
|
* Creates a `ButtonActionElement` component instance.
|
|
3314
3301
|
*
|
|
@@ -3405,21 +3392,7 @@ export declare function slot(content: UiElement, options?: {
|
|
|
3405
3392
|
width?: string;
|
|
3406
3393
|
}): Slot;
|
|
3407
3394
|
/**
|
|
3408
|
-
* Creates a `
|
|
3409
|
-
*
|
|
3410
|
-
* @remarks
|
|
3411
|
-
* Multi-slot horizontal row with declared column width proportions.
|
|
3412
|
-
* Examples: "1/3 + 2/3", "equal thirds", "1/4 + 3/4".
|
|
3413
|
-
*
|
|
3414
|
-
* @param slots - List of slots comprising the row
|
|
3415
|
-
* @param options - Optional settings (proportions).
|
|
3416
|
-
* @returns A strongly-typed `MultiSlotRowElement` object.
|
|
3417
|
-
*/
|
|
3418
|
-
export declare function multiSlotRow(slots: Slot[], options?: {
|
|
3419
|
-
proportions?: string;
|
|
3420
|
-
}): MultiSlotRowElement;
|
|
3421
|
-
/**
|
|
3422
|
-
* Creates a `MultiSlotRowElement` component instance.
|
|
3395
|
+
* Creates a `MultiSlotElement` component instance.
|
|
3423
3396
|
*
|
|
3424
3397
|
* @remarks
|
|
3425
3398
|
* Multi-slot horizontal row with declared column width proportions.
|
|
@@ -3427,28 +3400,24 @@ export declare function multiSlotRow(slots: Slot[], options?: {
|
|
|
3427
3400
|
*
|
|
3428
3401
|
* @param slots - List of slots comprising the row
|
|
3429
3402
|
* @param options - Optional settings (proportions).
|
|
3430
|
-
* @returns A strongly-typed `
|
|
3403
|
+
* @returns A strongly-typed `MultiSlotElement` object.
|
|
3431
3404
|
*/
|
|
3432
3405
|
export declare function multiSlot(slots: Slot[], options?: {
|
|
3433
3406
|
proportions?: string;
|
|
3434
|
-
}):
|
|
3407
|
+
}): MultiSlotElement;
|
|
3435
3408
|
/**
|
|
3436
|
-
* Creates a `
|
|
3409
|
+
* Creates a `FlowingElement` component instance.
|
|
3437
3410
|
*
|
|
3438
3411
|
* @remarks
|
|
3439
|
-
*
|
|
3440
|
-
*
|
|
3412
|
+
* Flowing inline layout container with automatic line wrapping.
|
|
3413
|
+
* Renders child elements horizontally in sequence, automatically wrapping to the next line when space runs out.
|
|
3441
3414
|
*
|
|
3442
|
-
* @param
|
|
3443
|
-
* @
|
|
3444
|
-
* @param options - Optional settings (withDivider (defaults to `false`)).
|
|
3445
|
-
* @returns A strongly-typed `LabelValueRowElement` object.
|
|
3415
|
+
* @param elements - List of child elements rendered sequentially with line wrapping
|
|
3416
|
+
* @returns A strongly-typed `FlowingElement` object.
|
|
3446
3417
|
*/
|
|
3447
|
-
export declare function
|
|
3448
|
-
withDivider?: boolean;
|
|
3449
|
-
}): LabelValueRowElement;
|
|
3418
|
+
export declare function flowing(elements: UiElement[]): FlowingElement;
|
|
3450
3419
|
/**
|
|
3451
|
-
* Creates a `
|
|
3420
|
+
* Creates a `LabelValueElement` component instance.
|
|
3452
3421
|
*
|
|
3453
3422
|
* @remarks
|
|
3454
3423
|
* Standard label and value row.
|
|
@@ -3457,11 +3426,11 @@ export declare function labelValueRow(label: string, value: UiElement, options?:
|
|
|
3457
3426
|
* @param label - Key or descriptive label displayed muted on the left
|
|
3458
3427
|
* @param value - Rendered value element on the right
|
|
3459
3428
|
* @param options - Optional settings (withDivider (defaults to `false`)).
|
|
3460
|
-
* @returns A strongly-typed `
|
|
3429
|
+
* @returns A strongly-typed `LabelValueElement` object.
|
|
3461
3430
|
*/
|
|
3462
3431
|
export declare function labelValue(label: string, value: UiElement, options?: {
|
|
3463
3432
|
withDivider?: boolean;
|
|
3464
|
-
}):
|
|
3433
|
+
}): LabelValueElement;
|
|
3465
3434
|
/**
|
|
3466
3435
|
* Creates a `TableColumn` component instance.
|
|
3467
3436
|
*
|
|
@@ -3711,7 +3680,7 @@ export declare function isRatioElement(value: unknown, withDeepValidation?: bool
|
|
|
3711
3680
|
*
|
|
3712
3681
|
* @param value - The value to inspect.
|
|
3713
3682
|
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3714
|
-
* @returns `true` if the value is a `ColourElement` (type = "color
|
|
3683
|
+
* @returns `true` if the value is a `ColourElement` (type = "color"), otherwise `false`.
|
|
3715
3684
|
*/
|
|
3716
3685
|
export declare function isColourElement(value: unknown, withDeepValidation?: boolean): value is ColourElement;
|
|
3717
3686
|
/**
|
|
@@ -3770,14 +3739,6 @@ export declare function isTimestampElement(value: unknown, withDeepValidation?:
|
|
|
3770
3739
|
* @returns `true` if the value is a `ImageReferenceElement` (type = "image-ref"), otherwise `false`.
|
|
3771
3740
|
*/
|
|
3772
3741
|
export declare function isImageReferenceElement(value: unknown, withDeepValidation?: boolean): value is ImageReferenceElement;
|
|
3773
|
-
/**
|
|
3774
|
-
* Type guard predicate narrowing a value to `DominantColourSetElement`.
|
|
3775
|
-
*
|
|
3776
|
-
* @param value - The value to inspect.
|
|
3777
|
-
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3778
|
-
* @returns `true` if the value is a `DominantColourSetElement` (type = "color-set"), otherwise `false`.
|
|
3779
|
-
*/
|
|
3780
|
-
export declare function isDominantColourSetElement(value: unknown, withDeepValidation?: boolean): value is DominantColourSetElement;
|
|
3781
3742
|
/**
|
|
3782
3743
|
* Type guard predicate narrowing a value to `MarkdownBlockElement`.
|
|
3783
3744
|
*
|
|
@@ -3795,21 +3756,29 @@ export declare function isMarkdownBlockElement(value: unknown, withDeepValidatio
|
|
|
3795
3756
|
*/
|
|
3796
3757
|
export declare function isHtmlBlockElement(value: unknown, withDeepValidation?: boolean): value is HtmlBlockElement;
|
|
3797
3758
|
/**
|
|
3798
|
-
* Type guard predicate narrowing a value to `
|
|
3759
|
+
* Type guard predicate narrowing a value to `MultiSlotElement`.
|
|
3760
|
+
*
|
|
3761
|
+
* @param value - The value to inspect.
|
|
3762
|
+
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3763
|
+
* @returns `true` if the value is a `MultiSlotElement` (type = "multi-slot"), otherwise `false`.
|
|
3764
|
+
*/
|
|
3765
|
+
export declare function isMultiSlotElement(value: unknown, withDeepValidation?: boolean): value is MultiSlotElement;
|
|
3766
|
+
/**
|
|
3767
|
+
* Type guard predicate narrowing a value to `FlowingElement`.
|
|
3799
3768
|
*
|
|
3800
3769
|
* @param value - The value to inspect.
|
|
3801
3770
|
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3802
|
-
* @returns `true` if the value is a `
|
|
3771
|
+
* @returns `true` if the value is a `FlowingElement` (type = "flowing"), otherwise `false`.
|
|
3803
3772
|
*/
|
|
3804
|
-
export declare function
|
|
3773
|
+
export declare function isFlowingElement(value: unknown, withDeepValidation?: boolean): value is FlowingElement;
|
|
3805
3774
|
/**
|
|
3806
|
-
* Type guard predicate narrowing a value to `
|
|
3775
|
+
* Type guard predicate narrowing a value to `LabelValueElement`.
|
|
3807
3776
|
*
|
|
3808
3777
|
* @param value - The value to inspect.
|
|
3809
3778
|
* @param withDeepValidation - Whether to recursively validate all properties.
|
|
3810
|
-
* @returns `true` if the value is a `
|
|
3779
|
+
* @returns `true` if the value is a `LabelValueElement` (type = "label-value"), otherwise `false`.
|
|
3811
3780
|
*/
|
|
3812
|
-
export declare function
|
|
3781
|
+
export declare function isLabelValueElement(value: unknown, withDeepValidation?: boolean): value is LabelValueElement;
|
|
3813
3782
|
/**
|
|
3814
3783
|
* Type guard predicate narrowing a value to `TableElement`.
|
|
3815
3784
|
*
|