@picteus/extension-sdk 0.17.0 → 0.19.0

package/dist/generated/frontEndIntents.d.ts

@@ -0,0 +1,1112 @@
+import type { Buffer } from "node:buffer";
+/**
+ * Target layout anchor where an embedded extension user interface should be integrated.
+ *
+ * @remarks
+ * The selected anchor is the discriminator for the supported integration surface. Its string value is part of the serialized intent contract and must match one of these declared choices.
+ */
+declare enum UiAnchor {
+    /** Rendered inside a centered or full-screen modal dialog. */
+    Modal = "modal",
+    /** Docked within the collateral sidebar navigation. */
+    Sidebar = "sidebar",
+    /** Rendered inside an independent floating desktop window. */
+    Window = "window",
+    /** Embedded within the image detail inspection view. */
+    ImageDetail = "imageDetail",
+    /** Displayed within a dedicated tab. */
+    Tab = "tab"
+}
+/**
+ * Target layout anchor where an embedded extension user interface should be integrated.
+ *
+ * @remarks
+ * The selected anchor is the discriminator for the supported integration surface. Its string value is part of the serialized intent contract and must match one of these declared choices.
+ */
+export declare const IntentUiAnchor: typeof UiAnchor;
+/**
+ * Target layout anchor where an embedded extension user interface should be integrated.
+ *
+ * @remarks
+ * The selected anchor is the discriminator for the supported integration surface. Its string value is part of the serialized intent contract and must match one of these declared choices.
+ */
+export type IntentUiAnchor = UiAnchor;
+/** Semantic classification and visual styling category of a modal dialog. */
+declare enum DialogType {
+    /** Error notice dialog indicating a failure or critical condition. */
+    Error = "error",
+    /** Informational dialog displaying status, instructions, or notices. */
+    Info = "info",
+    /** Question or confirmation prompt requiring explicit user decision. */
+    Question = "question"
+}
+/** Semantic classification and visual styling category of a modal dialog. */
+export declare const IntentDialogType: typeof DialogType;
+/** Semantic classification and visual styling category of a modal dialog. */
+export type IntentDialogType = DialogType;
+/** Target view or entity type to display in the front-end. */
+declare enum ShowType {
+    /** Registered collateral sidebar panel. */
+    Sidebar = "sidebar",
+    /** Extension settings configuration modal. */
+    ExtensionSettings = "extensionSettings",
+    /** Full-screen image detail inspection view. */
+    Image = "image",
+    /** Repository details and contents view. */
+    Repository = "repository"
+}
+/** Target view or entity type to display in the front-end. */
+export declare const IntentShowType: typeof ShowType;
+/** Target view or entity type to display in the front-end. */
+export type IntentShowType = ShowType;
+/** Visual style and severity variant for toast notifications. */
+declare enum ToastType {
+    /** Informational toast indicating general status or successful completion. */
+    Info = "info",
+    /** Cancellation toast indicating an operation was aborted or cancelled. */
+    Cancel = "cancel",
+    /** Error toast indicating a failure or warning condition. */
+    Error = "error"
+}
+/** Visual style and severity variant for toast notifications. */
+export declare const IntentToastType: typeof ToastType;
+/** Visual style and severity variant for toast notifications. */
+export type IntentToastType = ToastType;
+/**
+ * Unique identity metadata for an intent invocation.
+ *
+ * @remarks
+ * The identity is carried by intent envelopes that inherit from BasisIntent. Producers may use it to correlate an intent with its request or response; it does not identify the user, extension, or target entity.
+ */
+interface Identity {
+    /**
+     * Unique identifier string for the intent invocation.
+     *
+     * @remarks
+     * Opaque correlation value supplied by the producer. Preserve the value unchanged when forwarding or responding to the same invocation.
+     */
+    readonly id: string;
+}
+/**
+ * Unique identity metadata for an intent invocation.
+ *
+ * @remarks
+ * The identity is carried by intent envelopes that inherit from BasisIntent. Producers may use it to correlate an intent with its request or response; it does not identify the user, extension, or target entity.
+ */
+export type IntentIdentity = Identity;
+/**
+ * Contextual entity identifiers associated with an intent execution.
+ *
+ * @remarks
+ * Context communicates which entities are currently selected or otherwise relevant to an operation. It is supplementary to the payload and must not be treated as a substitute for an explicit target required by that payload.
+ */
+interface Context {
+    /** Optional collection of image identifiers. */
+    readonly imageIds?: string[];
+}
+/**
+ * Contextual entity identifiers associated with an intent execution.
+ *
+ * @remarks
+ * Context communicates which entities are currently selected or otherwise relevant to an operation. It is supplementary to the payload and must not be treated as a substitute for an explicit target required by that payload.
+ */
+export type IntentContext = Context;
+/**
+ * Base intent model providing optional identity tracking.
+ *
+ * @remarks
+ * Intent payload models inherit this envelope when they need request correlation. The identity is optional so intents can also be dispatched without a correlation token.
+ */
+export interface BasisIntent {
+    /**
+     * Optional unique identity metadata for the intent invocation.
+     *
+     * @remarks
+     * Correlation metadata for the invocation, should be kept intact during its whole lifecycle.
+     */
+    readonly identity?: IntentIdentity;
+}
+/**
+ * Base intent model extending BasisIntent with execution context references.
+ *
+ * @remarks
+ * It offers additional information about the context of execution the intent.
+ */
+export interface WithContextIntent extends BasisIntent {
+    /** Optional execution context containing target entity identifiers such as image identifiers. */
+    readonly context?: IntentContext;
+}
+/**
+ * Base content structure providing an optional title.
+ *
+ * @remarks
+ * Reusable heading metadata for dialog, notification, and view content. The title is optional in this base so that a consumer can render content that has a description or body without a heading.
+ */
+interface WithTitle {
+    /**
+     * Optional headline or primary title text.
+     *
+     * @remarks
+     * Short heading intended for a title position in the associated UI. Keep this concise; place explanatory prose in description, subtitle, or details fields.
+     */
+    readonly title?: string;
+}
+/**
+ * Base content structure providing an optional title.
+ *
+ * @remarks
+ * Reusable heading metadata for dialog, notification, and view content. The title is optional in this base so that a consumer can render content that has a description or body without a heading.
+ */
+export type IntentWithTitle = WithTitle;
+/**
+ * Base content structure providing a title and subtitle.
+ *
+ * @remarks
+ * Composition of the reusable title and subtitle fields for compact content that needs a heading and one supporting line.
+ */
+interface TitleSubtitle extends WithTitle {
+    /**
+     * Descriptive subtitle or message text.
+     *
+     * @remarks
+     * Short supporting message displayed below a title or as the main text of a compact notification. Use details or body fields for longer content.
+     */
+    readonly subtitle: string;
+}
+/**
+ * Base content structure providing a title and subtitle.
+ *
+ * @remarks
+ * Composition of the reusable title and subtitle fields for compact content that needs a heading and one supporting line.
+ */
+export type IntentTitleSubtitle = TitleSubtitle;
+/**
+ * Base content structure providing a description.
+ *
+ * @remarks
+ * Reusable explanatory text for content that needs a description independent of its heading. The value is plain text and is not interpreted as markup.
+ */
+interface WithDescription {
+    /**
+     * Descriptive subtitle or explanatory message text.
+     *
+     * @remarks
+     * Explanatory text associated with the content. Use this for a short overview; additional or more detailed text can be supplied through a details field.
+     */
+    readonly description: string;
+}
+/**
+ * Base content structure providing a description.
+ *
+ * @remarks
+ * Reusable explanatory text for content that needs a description independent of its heading. The value is plain text and is not interpreted as markup.
+ */
+export type IntentWithDescription = WithDescription;
+/**
+ * Base content structure providing a description and optional details.
+ *
+ * @remarks
+ * Composition for explanatory content with a required overview and optional supplementary body text.
+ */
+interface DescriptionDetails extends WithDescription {
+    /**
+     * Optional supplementary details or extended body text.
+     *
+     * @remarks
+     * Optional longer-form supporting content. Consumers may present it as secondary or expandable text; it remains plain text rather than a markup document.
+     */
+    readonly details?: string;
+}
+/**
+ * Base content structure providing a description and optional details.
+ *
+ * @remarks
+ * Composition for explanatory content with a required overview and optional supplementary body text.
+ */
+export type IntentDescriptionDetails = DescriptionDetails;
+/**
+ * Base content structure providing a title, description, and optional details.
+ *
+ * @remarks
+ * Combines required descriptive content with an additional required title, suitable for cards where a heading and explanatory body are both needed.
+ */
+interface TitleDescriptionDetails extends DescriptionDetails {
+    /** Primary title text displayed in the header. */
+    readonly title: string;
+}
+/**
+ * Base content structure providing a title, description, and optional details.
+ *
+ * @remarks
+ * Combines required descriptive content with an additional required title, suitable for cards where a heading and explanatory body are both needed.
+ */
+export type IntentTitleDescriptionDetails = TitleDescriptionDetails;
+/**
+ * Resource reference pointing to an external or local URL.
+ *
+ * @remarks
+ * Use a URL reference when the resource is available to the consumer through a location rather than inline bytes. The value is interpreted according to the resource consumer and may refer to remote or local content.
+ */
+interface ResourceUrl {
+    /**
+     * Resource destination URL.
+     *
+     * @remarks
+     * Location from which the front-end can retrieve the resource.
+     */
+    readonly url: string;
+}
+/**
+ * Resource reference pointing to an external or local URL.
+ *
+ * @remarks
+ * Use a URL reference when the resource is available to the consumer through a location rather than inline bytes. The value is interpreted according to the resource consumer and may refer to remote or local content.
+ */
+export type IntentResourceUrl = ResourceUrl;
+/**
+ * Resource payload containing raw binary data.
+ *
+ * @remarks
+ * Use this representation to transfer a resource as bytes in the intent payload instead of requiring the consumer to resolve a separate URL.
+ */
+interface ResourceContent {
+    /**
+     * Raw binary byte content of the resource.
+     *
+     * @remarks
+     * Complete binary representation of the resource. The consumer is responsible for interpreting the bytes in the context in which the resource is used.
+     */
+    readonly content: Buffer;
+}
+/**
+ * Resource payload containing raw binary data.
+ *
+ * @remarks
+ * Use this representation to transfer a resource as bytes in the intent payload instead of requiring the consumer to resolve a separate URL.
+ */
+export type IntentResourceContent = ResourceContent;
+/**
+ * Base content structure extending TitleDescriptionDetails with an optional icon resource.
+ *
+ * @remarks
+ * Combines a title and explanatory text with an optional icon for headers and notification cards. The icon can be supplied by URL or as bytes through Resource.
+ */
+interface TitleDescriptionDetailsIcon extends TitleDescriptionDetails {
+    /**
+     * Optional visual icon resource — supplied as a URL or binary bytes.
+     *
+     * @remarks
+     * Decorative or identifying image for the content header. Choose a URL for separately hosted assets or inline bytes when the asset must travel with the payload.
+     */
+    readonly icon?: IntentResourceUrl | IntentResourceContent;
+}
+/**
+ * Base content structure extending TitleDescriptionDetails with an optional icon resource.
+ *
+ * @remarks
+ * Combines a title and explanatory text with an optional icon for headers and notification cards. The icon can be supplied by URL or as bytes through Resource.
+ */
+export type IntentTitleDescriptionDetailsIcon = TitleDescriptionDetailsIcon;
+/**
+ * Base content structure extending title, subtitle, description, and details content with an optional icon.
+ *
+ * @remarks
+ * Combines the common heading and body fields for richer views. The title is required here; subtitle, description, and details are supplied by the composed content structures, while the icon remains optional.
+ */
+interface TitleSubtitleDescriptionDetailsIcon extends TitleSubtitle {
+    /**
+     * Primary title text.
+     *
+     * @remarks
+     * Required concise heading for the content. It is distinct from the supporting subtitle and longer description/details fields.
+     */
+    readonly title: string;
+    /**
+     * Optional supplementary details or extended body text.
+     *
+     * @remarks
+     * Optional longer-form supporting content. Consumers may present it as secondary or expandable text; it remains plain text rather than a markup document.
+     */
+    readonly details?: string;
+    /**
+     * Descriptive subtitle or explanatory message text.
+     *
+     * @remarks
+     * Explanatory text associated with the content. Use this for a short overview; additional or more detailed text can be supplied through a details field.
+     */
+    readonly description: string;
+    /**
+     * Optional visual icon resource — supplied as a URL or binary bytes.
+     *
+     * @remarks
+     * Optional image accompanying the content heading. Its resource can be inline or externally located, as described by Resource.
+     */
+    readonly icon?: IntentResourceUrl | IntentResourceContent;
+}
+/**
+ * Base content structure extending title, subtitle, description, and details content with an optional icon.
+ *
+ * @remarks
+ * Combines the common heading and body fields for richer views. The title is required here; subtitle, description, and details are supplied by the composed content structures, while the icon remains optional.
+ */
+export type IntentTitleSubtitleDescriptionDetailsIcon = TitleSubtitleDescriptionDetailsIcon;
+/**
+ * Dialog content structure extending TitleDescriptionDetailsIcon with an optional icon resource.
+ *
+ * @remarks
+ * Adds the optional resource icon to standard title and description content for dialogs.
+ */
+interface DialogIconContent extends TitleDescriptionDetailsIcon {
+}
+/**
+ * Dialog content structure extending TitleDescriptionDetailsIcon with an optional icon resource.
+ *
+ * @remarks
+ * Adds the optional resource icon to standard title and description content for dialogs.
+ */
+export type IntentDialogIconContent = DialogIconContent;
+/**
+ * Dialog content structure extending DialogIconContent with a modal window size preference.
+ *
+ * @remarks
+ * Controls the preferred width class of a modal dialog. The front-end may choose an appropriate actual width for its viewport when the preference is automatic or a fixed size cannot fit.
+ */
+interface DialogIconSizeContent extends DialogIconContent {
+    /**
+     * Modal dialog window size variant.
+     *
+     * @remarks
+     * Preferred modal size. Use auto when content should determine a suitable width; named sizes express a relative front-end-defined width rather than a pixel measurement.
+     */
+    readonly size?: "auto" | "xs" | "s" | "m" | "l" | "xl";
+}
+/**
+ * Dialog content structure extending DialogIconContent with a modal window size preference.
+ *
+ * @remarks
+ * Controls the preferred width class of a modal dialog. The front-end may choose an appropriate actual width for its viewport when the preference is automatic or a fixed size cannot fit.
+ */
+export type IntentDialogIconSizeContent = DialogIconSizeContent;
+/**
+ * Form configuration containing JSON Schema fields and optional dialog presentation settings.
+ *
+ * @remarks
+ * The parameters value is a JSON Schema object used by the front-end to construct inputs and validate submitted values. Dialog content controls the surrounding modal presentation; it does not change the parameter schema.
+ */
+interface FormContent {
+    /**
+     * JSON Schema specification describing form parameters, input types, default values, and validation rules.
+     *
+     * @remarks
+     * JSON Schema object describing the fields to render, including their types, titles, defaults, and validation constraints. Define an object schema with named properties so collected values can be returned as a keyed object.
+     */
+    readonly parameters: Record<string, unknown>;
+    /**
+     * Optional presentation settings for the modal dialog housing the form.
+     *
+     * @remarks
+     * Optional title, descriptive content, icon, and preferred size for the form dialog. Leave this out when the form can use the front-end's default dialog presentation.
+     */
+    readonly dialogContent?: IntentDialogIconSizeContent;
+}
+/**
+ * Form configuration containing JSON Schema fields and optional dialog presentation settings.
+ *
+ * @remarks
+ * The parameters value is a JSON Schema object used by the front-end to construct inputs and validate submitted values. Dialog content controls the surrounding modal presentation; it does not change the parameter schema.
+ */
+export type IntentFormContent = FormContent;
+/**
+ * An intent that displays a JSON Schema-based form in a modal dialog to collect user input.
+ *
+ * @remarks
+ * The front-end renders the form associated to the schema, collects values, and returns them through the intent interaction flow. Use this for capturing structured input rather than embedding a hand-built form in a custom UI frame.
+ */
+export interface FormIntent extends WithContextIntent {
+    /**
+     * Form configuration containing the JSON Schema parameters definition and dialog presentation settings.
+     *
+     * @remarks
+     * Schema and optional modal presentation configuration for the requested form. The schema defines the form's inputs and validation rules.
+     */
+    readonly form: IntentFormContent;
+}
+/**
+ * UI integration configuration for mounting an extension view inside the collateral sidebar.
+ *
+ * @remarks
+ * Selects the front-end's sidebar host as the integration point. The external flag allows the view to be presented in an independent window instead of occupying the docked sidebar surface.
+ */
+interface UISidebarIntegration {
+    /**
+     * Layout anchor discriminator specifying sidebar placement.
+     *
+     * @remarks
+     * Literal integration discriminator for the sidebar variant. Keep it set to sidebar so consumers can distinguish this payload from other integration modes.
+     */
+    readonly anchor: "sidebar";
+    /**
+     * Whether the sidebar view should open in an external window rather than docked directly in the sidebar.
+     *
+     * @remarks
+     * When true, asks the front-end to open the sidebar-backed view in a separate window. When false, the view is embedded in the sidebar; this flag does not change the integration anchor.
+     */
+    readonly isExternal: boolean;
+}
+/**
+ * UI integration configuration for mounting an extension view inside the collateral sidebar.
+ *
+ * @remarks
+ * Selects the front-end's sidebar host as the integration point. The external flag allows the view to be presented in an independent window instead of occupying the docked sidebar surface.
+ */
+export type IntentUISidebarIntegration = UISidebarIntegration;
+/**
+ * UI integration configuration for rendering an extension view inside an independent window.
+ *
+ * @remarks
+ * Selects a standalone host window without additional window-specific options in this contract.
+ */
+interface UIWindowIntegration {
+    /**
+     * Layout anchor discriminator specifying window placement.
+     *
+     * @remarks
+     * Literal integration discriminator for the independent-window variant.
+     */
+    readonly anchor: "window";
+}
+/**
+ * UI integration configuration for rendering an extension view inside an independent window.
+ *
+ * @remarks
+ * Selects a standalone host window without additional window-specific options in this contract.
+ */
+export type IntentUIWindowIntegration = UIWindowIntegration;
+/**
+ * UI integration configuration for rendering an extension view inside a modal dialog.
+ *
+ * @remarks
+ * Selects a front-end-managed modal as the host surface for the embedded extension view.
+ */
+interface UIModalIntegration {
+    /**
+     * Layout anchor discriminator specifying modal placement.
+     *
+     * @remarks
+     * Literal integration discriminator for the modal variant.
+     */
+    readonly anchor: "modal";
+}
+/**
+ * UI integration configuration for rendering an extension view inside a modal dialog.
+ *
+ * @remarks
+ * Selects a front-end-managed modal as the host surface for the embedded extension view.
+ */
+export type IntentUIModalIntegration = UIModalIntegration;
+/**
+ * UI integration configuration for rendering an extension view inside a tab.
+ *
+ * @remarks
+ * Selects a dedicated front-end tab as the host surface for the embedded extension view.
+ */
+interface UITabIntegration {
+    /**
+     * Layout anchor discriminator specifying tab placement.
+     *
+     * @remarks
+     * Literal integration discriminator for the tab variant.
+     */
+    readonly anchor: "tab";
+}
+/**
+ * UI integration configuration for rendering an extension view inside a tab.
+ *
+ * @remarks
+ * Selects a dedicated front-end tab as the host surface for the embedded extension view.
+ */
+export type IntentUITabIntegration = UITabIntegration;
+/**
+ * Embedded frame content specified by a web URL.
+ *
+ * @remarks
+ * URL-backed frame content is loaded by the front-end. The target must be reachable from that front-end's environment and should use an appropriate secure scheme.
+ */
+interface UrlContent {
+    /**
+     * Target web URL to load inside the embedded frame.
+     *
+     * @remarks
+     * Address of the web document to load. The frame host must be able to reach the location; use a secure URL for remote content.
+     */
+    readonly url: string;
+}
+/**
+ * Embedded frame content specified by a web URL.
+ *
+ * @remarks
+ * URL-backed frame content is loaded by the front-end. The target must be reachable from that front-end's environment and should use an appropriate secure scheme.
+ */
+export type IntentUrlContent = UrlContent;
+/**
+ * Embedded frame content specified by raw inline HTML markup.
+ *
+ * @remarks
+ * Inline document content supplied as a string. It is rendered by the host frame rather than fetched as a separate page; callers should not assume access to the host application's privileges.
+ */
+interface HtmlContent {
+    /**
+     * Raw HTML markup string to render directly inside the embedded frame.
+     *
+     * @remarks
+     * HTML source rendered as the frame document. The TypeSpec contract treats it as an opaque string and does not validate markup or grant access to the host application's privileges.
+     */
+    readonly html: string;
+}
+/**
+ * Embedded frame content specified by raw inline HTML markup.
+ *
+ * @remarks
+ * Inline document content supplied as a string. It is rendered by the host frame rather than fetched as a separate page; callers should not assume access to the host application's privileges.
+ */
+export type IntentHtmlContent = HtmlContent;
+/**
+ * Complete specification for embedding a custom extension user interface within the front-end.
+ *
+ * @remarks
+ * The front-end uses id to identify the view, integration to choose its host surface, and frameContent to load its contents. dialogContent supplies optional header metadata where the selected integration supports it.
+ */
+interface Ui {
+    /**
+     * Unique identifier for the UI instance or transient panel.
+     *
+     * @remarks
+     * Identifier for this view instance. Supply a stable identifier when the front-end should recognize the same registered view across invocations; otherwise use an identifier appropriate to the transient view lifecycle.
+     */
+    readonly id: string;
+    /**
+     * Placement strategy defining where and how the UI is mounted.
+     *
+     * @remarks
+     * Discriminated integration configuration. The anchor selects a supported host surface, while fields on that specific variant refine its presentation.
+     */
+    readonly integration: IntentUISidebarIntegration | IntentUIWindowIntegration | IntentUIModalIntegration | IntentUITabIntegration;
+    /**
+     * Web content to render inside the frame — either a URL or raw HTML.
+     *
+     * @remarks
+     * Content source for the embedded frame. Supply one supported variant; use a URL for hosted application content or inline HTML for a self-contained document.
+     */
+    readonly frameContent: IntentUrlContent | IntentHtmlContent;
+    /**
+     * Optional header title, description, and icon metadata for the view.
+     *
+     * @remarks
+     * Optional display metadata associated with the embedded view. It does not control the integration anchor or the content rendered within the frame.
+     */
+    readonly dialogContent?: IntentDialogIconContent;
+}
+/**
+ * Complete specification for embedding a custom extension user interface within the front-end.
+ *
+ * @remarks
+ * The front-end uses id to identify the view, integration to choose its host surface, and frameContent to load its contents. dialogContent supplies optional header metadata where the selected integration supports it.
+ */
+export type IntentUi = Ui;
+/**
+ * An intent that opens a dedicated UI frame — modal, sidebar, window or tab — rendering a URL or raw inline HTML.
+ *
+ * @remarks
+ * Requests that the front-end mount the content in the selected integration surface, supplying the frame source and optional header metadata.
+ */
+export interface UiIntent extends WithContextIntent {
+    /**
+     * UI view configuration specifying placement anchor, content, and header metadata.
+     *
+     * @remarks
+     * Required view descriptor containing the host integration, content source, and optional display metadata.
+     */
+    readonly ui: IntentUi;
+}
+/**
+ * Parameters for opening an external web URL in the user's default browser.
+ *
+ * @remarks
+ * This payload targets external browser navigation rather than an embedded UI frame. The operating system or front-end handles the actual hand-off to the default browser.
+ */
+interface OpenBrowser {
+    /**
+     * Destination web URL to open externally in the default browser.
+     *
+     * @remarks
+     * External destination passed to the platform's default browser.
+     */
+    readonly url: string;
+}
+/**
+ * Parameters for opening an external web URL in the user's default browser.
+ *
+ * @remarks
+ * This payload targets external browser navigation rather than an embedded UI frame. The operating system or front-end handles the actual hand-off to the default browser.
+ */
+export type IntentOpenBrowser = OpenBrowser;
+/** An intent that prompts the user for confirmation and opens an external URL in the default web browser. */
+export interface OpenBrowserIntent extends BasisIntent {
+    /**
+     * External browser navigation payload containing the target URL.
+     *
+     * @remarks
+     * Required URL payload passed to the operating system or front-end for external browser navigation.
+     */
+    readonly openBrowser: IntentOpenBrowser;
+}
+/**
+ * Embedded frame configuration rendered within a dialog modal.
+ *
+ * @remarks
+ * The frame embeds URL- or HTML-based content in a dialog body. Its height is expressed as a percentage of the available dialog height so that the front-end can adapt the frame to the dialog's rendered dimensions.
+ */
+interface Frame {
+    /**
+     * Embedded web content to render inside the dialog frame.
+     *
+     * @remarks
+     * Source for the embedded content. The selected FrameContent variant determines whether the front-end loads a URL or renders supplied markup.
+     */
+    readonly content: IntentUrlContent | IntentHtmlContent;
+    /**
+     * Frame height expressed as a percentage of available dialog height (0 to 100).
+     *
+     * @remarks
+     * Relative height request, bounded from 0 through 100. A value of 100 requests the full available dialog height; the final rendered dimensions remain controlled by the front-end.
+     */
+    readonly height: number;
+}
+/**
+ * Embedded frame configuration rendered within a dialog modal.
+ *
+ * @remarks
+ * The frame embeds URL- or HTML-based content in a dialog body. Its height is expressed as a percentage of the available dialog height so that the front-end can adapt the frame to the dialog's rendered dimensions.
+ */
+export type IntentFrame = Frame;
+/**
+ * Button label configuration for interactive dialog actions.
+ *
+ * @remarks
+ * Defines user-visible text for the dialog's affirmative choice and optional secondary choice. These labels are presentation strings, not command identifiers.
+ */
+interface DialogButtons {
+    /**
+     * Label text for the primary affirmative / confirmation button.
+     *
+     * @remarks
+     * Text shown for the affirmative action. Keep it specific to the requested decision when possible.
+     */
+    readonly yes: string;
+    /**
+     * Optional label text for the secondary negative / cancellation button.
+     *
+     * @remarks
+     * Text shown for the secondary choice, commonly a cancellation label. Omission leaves that choice to the front-end's default dialog behavior.
+     */
+    readonly no?: string;
+}
+/**
+ * Button label configuration for interactive dialog actions.
+ *
+ * @remarks
+ * Defines user-visible text for the dialog's affirmative choice and optional secondary choice. These labels are presentation strings, not command identifiers.
+ */
+export type IntentDialogButtons = DialogButtons;
+/**
+ * Configuration for interactive modal dialogs displaying notices, confirmation questions, or embedded frames.
+ *
+ * @remarks
+ * Defines the dialog's semantic type and user-facing content, with optional embedded content and button labels. Use question for a decision that requires an explicit response; other types communicate status or errors.
+ */
+interface Dialog extends DialogIconSizeContent {
+    /**
+     * Semantic dialog type — error, info, or question.
+     *
+     * @remarks
+     * Selects the dialog's interaction and visual treatment. Use question when the caller needs a yes/no choice, and error or info for non-question messages.
+     */
+    readonly type: IntentDialogType;
+    /**
+     * Optional embedded HTML or URL frame rendered inside the dialog body.
+     *
+     * @remarks
+     * Optional embedded content displayed within the dialog. Omit it for text-only dialogs; when present, content should be suitable for the dialog's available space.
+     */
+    readonly frame?: IntentFrame;
+    /**
+     * Button label definitions for user response choices.
+     *
+     * @remarks
+     * Labels for the affirmative action and optional secondary cancellation action. The front-end determines the button behavior and returns the user's choice to the intent caller.
+     */
+    readonly buttons: IntentDialogButtons;
+}
+/**
+ * Configuration for interactive modal dialogs displaying notices, confirmation questions, or embedded frames.
+ *
+ * @remarks
+ * Defines the dialog's semantic type and user-facing content, with optional embedded content and button labels. Use question for a decision that requires an explicit response; other types communicate status or errors.
+ */
+export type IntentDialog = Dialog;
+/**
+ * An intent that displays an interactive modal dialog and returns the user's response.
+ *
+ * @remarks
+ * Requests a front-end-managed modal using the supplied dialog configuration. The front-end presents the available controls and resolves the interaction with the user's response.
+ */
+export interface DialogIntent extends WithContextIntent {
+    /**
+     * Modal dialog configuration including type, title, buttons, and optional frame content.
+     *
+     * @remarks
+     * Required modal content and interaction configuration. Its type, buttons, and optional frame determine what the user sees and which response can be returned.
+     */
+    readonly dialog: IntentDialog;
+}
+/**
+ * Individual image descriptor for gallery presentation.
+ *
+ * @remarks
+ * An image entry references an existing image by identifier and may override or augment its displayed textual details.
+ */
+interface Image {
+    /**
+     * Unique identifier of the image in repositories.
+     *
+     * @remarks
+     * Identifier used by the front-end to resolve the image from its repositories. This is a image identifier, not an image URL or binary payload.
+     */
+    readonly imageId: string;
+    /**
+     * Optional title, description, or detail text for the individual image.
+     *
+     * @remarks
+     * Optional display metadata associated with this image entry. The front-end can use it as a per-image caption or descriptive context without changing the referenced image.
+     */
+    readonly details?: IntentTitleDescriptionDetails;
+}
+/**
+ * Individual image descriptor for gallery presentation.
+ *
+ * @remarks
+ * An image entry references an existing image by identifier and may override or augment its displayed textual details.
+ */
+export type IntentImage = Image;
+/**
+ * Content configuration for image gallery presentation containing title, subtitle, description, details, and an optional icon.
+ *
+ * @remarks
+ * Header metadata specialized for the image gallery tab. It reuses the common content fields so gallery presentation follows the same title, text, and icon conventions as other views.
+ */
+interface ImagesContent extends TitleSubtitleDescriptionDetailsIcon {
+}
+/**
+ * Content configuration for image gallery presentation containing title, subtitle, description, details, and an optional icon.
+ *
+ * @remarks
+ * Header metadata specialized for the image gallery tab. It reuses the common content fields so gallery presentation follows the same title, text, and icon conventions as other views.
+ */
+export type IntentImagesContent = ImagesContent;
+/**
+ * Collection of image items displayed inside a dedicated gallery tab.
+ *
+ * @remarks
+ * Pairs the gallery's image entries with the header content shown above them. Each entry points to an existing image; this model does not carry image bytes.
+ */
+interface Images {
+    /**
+     * List of image items to display in the gallery tab.
+     *
+     * @remarks
+     * Ordered gallery entries. The sequence supplied here is the order in which images are presented by the front-end.
+     */
+    readonly images: IntentImage[];
+    /**
+     * Header content configuration for the image gallery tab.
+     *
+     * @remarks
+     * Title, subtitle, description, details, and optional icon for the gallery view header.
+     */
+    readonly content: IntentImagesContent;
+}
+/**
+ * Collection of image items displayed inside a dedicated gallery tab.
+ *
+ * @remarks
+ * Pairs the gallery's image entries with the header content shown above them. Each entry points to an existing image; this model does not carry image bytes.
+ */
+export type IntentImages = Images;
+/**
+ * An intent that opens a tab displaying an image gallery.
+ *
+ * @remarks
+ * Requests a dedicated desk tab for the supplied ordered image collection and header metadata.
+ */
+export interface ImagesIntent extends WithContextIntent {
+    /**
+     * Image collection items and header metadata for the tab view.
+     *
+     * @remarks
+     * Required gallery payload containing both the image references and the content used to describe the tab.
+     */
+    readonly images: IntentImages;
+}
+/**
+ * Navigation payload targeting a specific view, panel, or entity.
+ *
+ * @remarks
+ * Combines a front-end-recognized view category with the identifier needed to resolve the destination. Valid identifier formats depend on the selected view type.
+ */
+interface Show {
+    /**
+     * Target view or entity category discriminator.
+     *
+     * @remarks
+     * Selects which front-end surface or entity resolver handles the navigation request. The id property must identify an entity compatible with this category.
+     */
+    readonly type: IntentShowType;
+    /**
+     * Unique identifier of the target entity — such as an image ID, repository ID, sidebar UUID, or extension ID.
+     *
+     * @remarks
+     * Identifier consumed by the selected destination resolver, for example an image ID for image, repository ID for repository, or extension ID for extensionSettings.
+     */
+    readonly id: string;
+}
+/**
+ * Navigation payload targeting a specific view, panel, or entity.
+ *
+ * @remarks
+ * Combines a front-end-recognized view category with the identifier needed to resolve the destination. Valid identifier formats depend on the selected view type.
+ */
+export type IntentShow = Show;
+/**
+ * An intent that navigates the front-end to a specific view, opening an image detail modal, a registered sidebar panel, an extension settings modal, or a repository view.
+ *
+ * @remarks
+ * It requests navigation in the front-end using a type-and-identifier pair.
+ */
+export interface ShowIntent extends BasisIntent {
+    /**
+     * Target entity and view type specification to display.
+     *
+     * @remarks
+     * Destination descriptor used by the front-end to select the view and resolve its target.
+     */
+    readonly show: IntentShow;
+}
+/**
+ * Configuration payload for brief, non-intrusive toast notifications.
+ *
+ * @remarks
+ * Toast content is intended for transient status feedback rather than a durable notification or an interaction requiring a decision.
+ */
+interface Toast extends TitleSubtitle {
+    /**
+     * Visual style and severity variant of the toast.
+     *
+     * @remarks
+     * Controls the font-end-side visual treatment and communicates the message category; it does not alter the notification text.
+     */
+    readonly type: IntentToastType;
+}
+/**
+ * Configuration payload for brief, non-intrusive toast notifications.
+ *
+ * @remarks
+ * Toast content is intended for transient status feedback rather than a durable notification or an interaction requiring a decision.
+ */
+export type IntentToast = Toast;
+/**
+ * An intent that displays a brief, non-intrusive toast notification in the front-end.
+ *
+ * @remarks
+ * It dispatches a transient status feedback to the front-end.
+ */
+export interface ToastIntent extends WithContextIntent {
+    /**
+     * Toast notification configuration specifying type, title, and subtitle text.
+     *
+     * @remarks
+     * Required toast content and severity configuration.
+     */
+    readonly toast: IntentToast;
+}
+/**
+ * Notification payload for notification center cards or native desktop notifications.
+ *
+ * @remarks
+ * Provides content and delivery preferences for a notification. The consumer can route it to the in-app notification center, the operating system notification manager, or both according to its supported behavior.
+ */
+interface Notification extends TitleSubtitle {
+    /**
+     * Primary notification title heading.
+     *
+     * @remarks
+     * Short heading shown as the notification's primary label.
+     */
+    readonly title: string;
+    /**
+     * Detailed notification message body.
+     *
+     * @remarks
+     * Main explanatory text shown with the notification title and subtitle. Keep the body understandable when the user sees it outside the surrounding application context.
+     */
+    readonly body: string;
+    /**
+     * Whether audio alert chimes and sounds should be suppressed.
+     *
+     * @remarks
+     * Set true when delivery should not produce an audible alert. This preference does not suppress the visual notification.
+     */
+    readonly silent: boolean;
+    /**
+     * Optional raw binary image icon displayed with the notification.
+     *
+     * @remarks
+     * Image bytes supplied for the notification icon. The target notification surface may apply its own size and format constraints.
+     */
+    readonly icon?: Buffer;
+    /**
+     * Whether the notification is dispatched through the operating system native desktop notification manager.
+     *
+     * @remarks
+     * Selects native desktop notification delivery when true. When false, the front-end notification center is the target; actual OS behavior is subject to platform support.
+     */
+    readonly isNative: boolean;
+}
+/**
+ * Notification payload for notification center cards or native desktop notifications.
+ *
+ * @remarks
+ * Provides content and delivery preferences for a notification. The consumer can route it to the in-app notification center, the operating system notification manager, or both according to its supported behavior.
+ */
+export type IntentNotification = Notification;
+/**
+ * An intent that dispatches a notification to the front-end notification center or operating system native desktop notification manager.
+ *
+ * @remarks
+ * It sends a notification content with delivery preferences to the front-end.
+ */
+export interface NotificationIntent extends WithContextIntent {
+    /**
+     * Notification details including title, subtitle, body, icon, and delivery mode.
+     *
+     * @remarks
+     * Required notification content and delivery options.
+     */
+    readonly notification: IntentNotification;
+}
+/**
+ * Specification identifying an extension command for programmatic invocation.
+ *
+ * @remarks
+ * A command is resolved within its owning extension, so both identifiers are required to avoid ambiguity across installed extensions.
+ */
+interface ProcessCommand {
+    /**
+     * Unique identifier of the extension owning the target command.
+     *
+     * @remarks
+     * Identifier of the installed extension that registers the command. It scopes commandId to the correct extension.
+     */
+    readonly extensionId: string;
+    /**
+     * Unique identifier of the command to execute on the extension.
+     *
+     * @remarks
+     * Identifier of the command registered by the owning extension. The extension's command handler determines the accepted input and execution behavior.
+     */
+    readonly commandId: string;
+}
+/**
+ * Specification identifying an extension command for programmatic invocation.
+ *
+ * @remarks
+ * A command is resolved within its owning extension, so both identifiers are required to avoid ambiguity across installed extensions.
+ */
+export type IntentProcessCommand = ProcessCommand;
+/**
+ * An intent that triggers execution of an extension command within the current context.
+ *
+ * @remarks
+ * It asks the front-end to execute an command, submitted its form when it requires inputs.
+ */
+export interface ProcessCommandIntent extends WithContextIntent {
+    /**
+     * Extension and command identification payload.
+     *
+     * @remarks
+     * Identifies the extension and command that the front-end should invoke.
+     */
+    readonly processCommand: IntentProcessCommand;
+}
+/**
+ * Interactive action card configuration bundling an executable intent triggered by a notification button.
+ *
+ * @remarks
+ * Combines user-facing card content and an executable intent. The notification center can present the card and dispatch the nested intent only after the user activates its action.
+ */
+interface Action {
+    /**
+     * Underlying intent executed when the user confirms the action button.
+     *
+     * @remarks
+     * Intent dispatched as the action's effect. Only the supported intent variants are accepted; the action itself does not execute or validate the nested operation.
+     */
+    readonly intent: ShowIntent | UiIntent | OpenBrowserIntent | ProcessCommandIntent;
+    /**
+     * Header title, description, details, icon, and sizing configuration for the action card.
+     *
+     * @remarks
+     * User-facing card content displayed with the action button.
+     */
+    readonly dialogContent: IntentDialogIconSizeContent;
+    /**
+     * Optional label text for the action confirmation button.
+     *
+     * @remarks
+     * Optional concise text for the button that activates the nested intent.
+     */
+    readonly label?: string;
+}
+/**
+ * Interactive action card configuration bundling an executable intent triggered by a notification button.
+ *
+ * @remarks
+ * Combines user-facing card content and an executable intent. The notification center can present the card and dispatch the nested intent only after the user activates its action.
+ */
+export type IntentAction = Action;
+/**
+ * An intent that posts an entry to the front-end notification center, executing an action when the user clicks its action button.
+ *
+ * @remarks
+ * It publishes a user-facing action card containing a nested intent. The nested operation is dispatched in response to the user's activation rather than immediately when this intent is handled.
+ */
+export interface ActionIntent extends WithContextIntent {
+    /**
+     * Action card configuration including header content, action button label, and underlying intent.
+     *
+     * @remarks
+     * Required card configuration, including the intent to dispatch after user activation.
+     */
+    readonly action: IntentAction;
+}
+export declare function isFormIntent(intent: unknown): intent is FormIntent;
+export declare function isUiIntent(intent: unknown): intent is UiIntent;
+export declare function isOpenBrowserIntent(intent: unknown): intent is OpenBrowserIntent;
+export declare function isDialogIntent(intent: unknown): intent is DialogIntent;
+export declare function isImagesIntent(intent: unknown): intent is ImagesIntent;
+export declare function isShowIntent(intent: unknown): intent is ShowIntent;
+export declare function isToastIntent(intent: unknown): intent is ToastIntent;
+export declare function isNotificationIntent(intent: unknown): intent is NotificationIntent;
+export declare function isProcessCommandIntent(intent: unknown): intent is ProcessCommandIntent;
+export declare function isActionIntent(intent: unknown): intent is ActionIntent;
+export type FrontIntent = FormIntent | UiIntent | OpenBrowserIntent | DialogIntent | ImagesIntent | ShowIntent | ToastIntent | NotificationIntent | ProcessCommandIntent | ActionIntent;
+export {};