@vscode/markdown-editor 0.0.2-73 → 0.0.2-74

package/dist/index.d.ts

@@ -217,6 +217,11 @@ export declare class BlockViewNode<T extends AnyViewData = AnyViewData> extends
 export declare interface BlockViewOptions {
     readonly renderCustomCodeBlock?: (language: string, content: string) => HTMLElement | undefined;
     readonly onToggleCheckbox?: (item: ListItemAstNode, newChecked: boolean) => void;
+    /**
+     * Supplies live, declarative metadata for recognized links. The editor owns
+     * the markup and styling; providers own lookup, caching, and updates.
+     */
+    readonly linkPresentationProvider?: ILinkPresentationProvider;
     /**
      * Opens a link's URL. Called when the user activates a link: a plain click
      * while the link's block is inactive (rendered), or a Ctrl/Cmd+click while it
@@ -1952,6 +1957,19 @@ export declare interface IHistoryStrategy {
     record?(operation: () => void, edit?: StringEdit): void;
 }
 
+export declare interface ILinkPresentation extends IDisposable {
+    /** Current presentation, updated without rebuilding the editor. */
+    readonly presentation: IObservable<LinkPresentation | undefined>;
+}
+
+export declare interface ILinkPresentationProvider {
+    /**
+     * Returns `undefined` for unsupported links. The caller disposes the returned
+     * reference when the rendered link disappears.
+     */
+    createLinkPresentation(url: string): ILinkPresentation | undefined;
+}
+
 export declare class ImageAstNode extends AstNode {
     readonly alt: string;
     readonly url: string;
@@ -2187,11 +2205,41 @@ export declare class LinkAstNode extends AstNode {
     protected _localEquals(o: this): boolean;
 }
 
+/**
+ * Declarative rendering data for one link. `kind` selects the package-owned
+ * visual treatment; providers never supply DOM or CSS.
+ */
+export declare interface LinkPresentation {
+    readonly kind: LinkPresentationKind;
+    readonly title?: string;
+    readonly detail?: string;
+    readonly reference?: string;
+    /** Primary resource state, such as pull-request lifecycle or session state. */
+    readonly status?: LinkPresentationStatus;
+    /** Secondary state, such as pull-request CI status. */
+    readonly secondaryStatus?: LinkPresentationStatus;
+    readonly tooltip?: string;
+    readonly ariaLabel?: string;
+}
+
+export declare type LinkPresentationKind = 'resource' | 'issue' | 'pullRequest' | 'commit' | 'file' | 'folder' | 'session' | 'repository' | 'branch';
+
+export declare interface LinkPresentationStatus {
+    readonly kind: LinkPresentationStatusKind;
+    readonly label: string;
+}
+
+export declare type LinkPresentationStatusKind = 'neutral' | 'pending' | 'success' | 'warning' | 'error' | 'open' | 'closed' | 'merged' | 'draft' | 'notPlanned';
+
 declare class LinkViewData {
     readonly ast: LinkAstNode;
+    /** Active: render the Markdown source; inactive: allow a rich presentation. */
+    readonly showMarkup: boolean;
     readonly content: readonly AnyViewData[];
     readonly kind = "link";
-    constructor(ast: LinkAstNode, content: readonly AnyViewData[]);
+    constructor(ast: LinkAstNode, 
+    /** Active: render the Markdown source; inactive: allow a rich presentation. */
+    showMarkup: boolean, content: readonly AnyViewData[]);
 }
 
 export declare class ListAstNode extends BlockAstNodeBase {
@@ -2700,6 +2748,30 @@ declare interface ReplacedItem {
     readonly deletedLocal: readonly AnnotatedRange[];
 }
 
+export declare class RichLink {
+    static create(options: RichLinkOptions): RichLink;
+    static mount(element: HTMLElement, authoredLabel: HTMLSpanElement): RichLink;
+    static clear(element: HTMLElement): void;
+    readonly element: HTMLElement;
+    readonly authoredLabel: HTMLSpanElement;
+    private readonly _icon;
+    private readonly _title;
+    private readonly _detail;
+    private readonly _reference;
+    private readonly _status;
+    private readonly _secondaryStatus;
+    private constructor();
+    update(presentation: LinkPresentation | undefined): void;
+    private _renderUnavailable;
+    private _setDefaultOrder;
+}
+
+export declare interface RichLinkOptions {
+    readonly href: string;
+    readonly authoredLabel: string;
+    readonly presentation?: LinkPresentation;
+}
+
 export declare const selectAll: SelectionCommand;
 
 export declare function selectBlock(ctx: CursorCommandContext, blockRange: OffsetRange): Selection_2;