reactive-vscode 0.0.1-beta.6 → 0.2.0-beta.1

package/dist/index.d.ts

@@ -14,10 +14,14 @@ import { Disposable as Disposable_2 } from 'vscode';
 import { DocumentSelector } from 'vscode';
 import { EffectScope } from '@vue/reactivity';
 import { Event as Event_2 } from 'vscode';
+import { EventEmitter } from 'vscode';
 import { Extension } from 'vscode';
 import { ExtensionContext } from 'vscode';
+import { ExtensionTerminalOptions } from 'vscode';
 import { FoldingRangeProvider } from 'vscode';
+import { GlobPattern } from 'vscode';
 import { LogLevel } from 'vscode';
+import { MaybeRef } from '@vue/reactivity';
 import { MaybeRefOrGetter } from '@vue/reactivity';
 import { NotebookEditor } from 'vscode';
 import { NotebookRange } from 'vscode';
@@ -33,6 +37,7 @@ import { Task } from 'vscode';
 import { TaskExecution } from 'vscode';
 import { TaskFilter } from 'vscode';
 import { Terminal } from 'vscode';
+import { TerminalOptions } from 'vscode';
 import { TerminalState } from 'vscode';
 import { TextDocument } from 'vscode';
 import { TextEditor } from 'vscode';
@@ -40,6 +45,7 @@ import { TextEditorDecorationType } from 'vscode';
 import { TextEditorEdit } from 'vscode';
 import { TextEditorSelectionChangeKind } from 'vscode';
 import { TreeDataProvider } from 'vscode';
+import { TreeItem } from 'vscode';
 import { TreeView } from 'vscode';
 import { TreeViewOptions } from 'vscode';
 import { Uri } from 'vscode';
@@ -174,6 +180,7 @@ export declare type TextEditorCommandCallback = (textEditor: TextEditor, edit: T
 
 export declare interface TreeViewNode {
     readonly children?: this[];
+    readonly treeItem: TreeItem | Thenable<TreeItem>;
 }
 
 /**
@@ -250,6 +257,26 @@ export declare function useCommands(commands: Partial<Commands>): void;
  */
 export declare function useCommentController(id: string, label: string): CommentController;
 
+/**
+ * Create terminal, and allows you to control the terminal lifecycle.
+ *
+ * @category terminal
+ */
+export declare function useControlledTerminal(name?: string, shellPath?: string, shellArgs?: readonly string[] | string): UseControlledTerminalReturn;
+
+export declare function useControlledTerminal(options: TerminalOptions): UseControlledTerminalReturn;
+
+export declare function useControlledTerminal(options: ExtensionTerminalOptions): UseControlledTerminalReturn;
+
+declare interface UseControlledTerminalReturn {
+    terminal: Ref<Terminal | null>;
+    getIsActive: () => boolean;
+    show: () => void;
+    sendText: (text: string) => void;
+    close: () => void;
+    state: ComputedRef<TerminalState | undefined>;
+}
+
 /**
  * @reactive `env.shell`
  */
@@ -285,11 +312,15 @@ export declare function useEvent<T>(event: Event_2<T>, listeners?: ((e: T) => an
  * @category utilities
  * @reactive `EventEmitter`
  */
-export declare function useEventEmitter<T>(listeners?: ((e: T) => any)[]): {
+export declare function useEventEmitter<T>(eventEmitter?: EventEmitter<T>, listeners?: ((e: T) => any)[]): UseEventEmitterReturn<T>;
+
+export declare function useEventEmitter<T>(listeners?: ((e: T) => any)[]): UseEventEmitterReturn<T>;
+
+declare interface UseEventEmitterReturn<T> {
     event: Event_2<T>;
     fire: (data: T) => void;
-    addListener: Event_2<T>;
-};
+    addListener: (listener: (e: T) => any) => void;
+}
 
 /**
  * @reactive `tasks.fetchTasks`
@@ -323,6 +354,18 @@ toJSON(): any;
  */
 export declare function useFoldingRangeProvider(selector: DocumentSelector, provideFoldingRanges: MaybeRefOrGetter<FoldingRangeProvider['provideFoldingRanges']>): void;
 
+/**
+ * @reactive `workspace.createFileSystemWatcher`
+ */
+export declare function useFsWatcher(globPattern: GlobPattern, ignoreCreateEvents?: boolean | undefined, ignoreChangeEvents?: boolean | undefined, ignoreDeleteEvents?: boolean | undefined): {
+    onDidCreate: Event_2<Uri>;
+    onDidChange: Event_2<Uri>;
+    onDidDelete: Event_2<Uri>;
+    ignoreCreateEvents: boolean;
+    ignoreChangeEvents: boolean;
+    ignoreDeleteEvents: boolean;
+};
+
 /**
  * Determines if the current color theme is dark. See `vscode::ColorTheme.kind`.
  *
@@ -422,11 +465,26 @@ export declare interface UseStatusBarItemOptions {
  */
 export declare const useTaskExecutions: () => ComputedRef<readonly TaskExecution[]>;
 
+/**
+ * @category terminal
+ * @reactive `window.createTerminal()`
+ */
+export declare function useTerminal(name?: string, shellPath?: string, shellArgs?: readonly string[] | string): UseTerminalReturn;
+
+export declare function useTerminal(options: TerminalOptions): UseTerminalReturn;
+
+export declare function useTerminal(options: ExtensionTerminalOptions): UseTerminalReturn;
+
+declare interface UseTerminalReturn extends Omit<Terminal, 'state' | 'dispose'> {
+    terminal: Terminal;
+    state: ComputedRef<TerminalState>;
+}
+
 /**
  * @reactive `Terminal.state`
  * @category terminal
  */
-export declare const useTerminalState: (terminal: Terminal) => ComputedRef<TerminalState>;
+export declare function useTerminalState(terminal: MaybeNullableRefOrGetter<Terminal>): ComputedRef<TerminalState | undefined>;
 
 /**
  * Register a text editor command. See `vscode::commands.registerTextEditorCommand`.
@@ -471,9 +529,16 @@ export declare function useTextEditorVisibleRanges(textEditor: MaybeNullableRefO
  *
  * @category view
  */
-export declare const useTreeView: <T extends TreeViewNode>(viewId: string, treeData: MaybeRefOrGetter<T[]>, options: UseTreeViewOptions<T>) => TreeView<T>;
+export declare const useTreeView: <T extends TreeViewNode>(viewId: string, treeData: MaybeRefOrGetter<T[]>, options?: UseTreeViewOptions<T> | undefined) => TreeView<T>;
 
-export declare type UseTreeViewOptions<T> = (Omit<TreeViewOptions<T>, 'treeDataProvider'> & Pick<TreeDataProvider<T>, 'getTreeItem' | 'resolveTreeItem'>) | TreeDataProvider<T>['getTreeItem'];
+export declare type UseTreeViewOptions<T> = Omit<TreeViewOptions<T>, 'treeDataProvider'> & Pick<TreeDataProvider<T>, 'resolveTreeItem'> & {
+    title?: MaybeRefOrGetter<string | undefined>;
+    badge?: MaybeRefOrGetter<ViewBadge | undefined>;
+    /**
+     * Additional watch source to trigger a change event. Useful when `treeItem` is a promise.
+     */
+    watchSource?: WatchSource<any>;
+};
 
 /**
  * @reactive `Uri`
@@ -502,7 +567,7 @@ toJSON(): any;
  *
  * @category view
  */
-export declare function useViewBadge(view: MaybeRefOrGetter<Nullable<ViewWithBadge>>, title: MaybeRefOrGetter<ViewBadge | undefined>): void;
+export declare function useViewBadge(view: MaybeRefOrGetter<Nullable<ViewWithBadge>>, badge: MaybeRefOrGetter<ViewBadge | undefined>): void;
 
 /**
  * Reactively set the title of a view (`vscode::TreeView` or `vscode::WebviewView`).
@@ -534,23 +599,18 @@ export declare function useVscodeContext<T>(name: string, value: ComputedRef<T>
 
 export declare function useVscodeContext<T>(name: string, value: WritableComputedRef<T>, shouldUpdate?: MaybeRefOrGetter<boolean>): WritableComputedRef<T>;
 
-export declare function useVscodeContext<T>(name: string, value: Ref<T>, shouldUpdate?: MaybeRefOrGetter<boolean>): Ref<T>;
+export declare function useVscodeContext<T>(name: string, value: MaybeRef<T>, shouldUpdate?: MaybeRefOrGetter<boolean>): Ref<T>;
 
 /**
  * Register a webview view. See `vscode::window.registerWebviewViewProvider`.
  *
  * @category view
  */
-export declare const useWebviewView: (viewId: string, html: MaybeRefOrGetter<string>, webviewOptions?: MaybeRefOrGetter<WebviewOptions> | undefined, registerOptions?: ({
-    readonly webviewOptions?: {
-        readonly retainContextWhenHidden?: boolean | undefined;
-    } | undefined;
-} & {
-    onDidReceiveMessage?: ((message: any) => void) | undefined;
-}) | undefined) => {
+export declare const useWebviewView: (viewId: string, html: MaybeRefOrGetter<string>, options?: WebviewRegisterOptions | undefined) => {
     view: ShallowRef<WebviewView | undefined>;
     context: ShallowRef<unknown>;
     postMessage: (message: any) => Thenable<boolean> | undefined;
+    forceRefresh: () => void;
 };
 
 /**
@@ -660,6 +720,14 @@ options?: DebuggerOptions,
     )
 }
 
+declare interface WebviewRegisterOptions {
+    retainContextWhenHidden?: boolean;
+    onDidReceiveMessage?: (message: any) => void;
+    webviewOptions?: MaybeRefOrGetter<WebviewOptions>;
+    title?: MaybeRefOrGetter<string | undefined>;
+    badge?: MaybeRefOrGetter<ViewBadge | undefined>;
+}
+
 
 export * from "@vue/reactivity";