@opensumi/sumi 2.12.1-next-079c1930 → 2.13.3

package/sumi-browser.d.ts

@@ -28,10 +28,120 @@ declare module 'sumi-browser' {
 
   import type vscode from 'vscode';
   import React from 'react';
+  import { URI as Uri } from 'vscode-uri';
 
   import { ROTATE_TYPE, ANIM_TYPE } from '@opensumi/ide-components';
 
-  export { URI } from '@opensumi/ide-core-browser';
+  interface IRelativePattern {
+    base: string;
+    pattern: string;
+  }
+  class Path {
+    static separator: '/';
+    static isDrive(segment: string): boolean;
+    static splitPath(path: string): string[];
+    static isRelative(path: string): boolean;
+    static pathDepth(path: string): number;
+    static normalizeDrive(path: string): string;
+    readonly isAbsolute: boolean;
+    readonly isRoot: boolean;
+    readonly root: Path | undefined;
+    readonly base: string;
+    readonly name: string;
+    readonly ext: string;
+    private _dir;
+    private readonly raw;
+    constructor(raw: string);
+    protected computeRoot(): Path | undefined;
+    get dir(): Path;
+    protected computeDir(): Path;
+    join(...paths: string[]): Path;
+    toString(): string;
+    relative(path: Path): Path | undefined;
+    isEqualOrParent(path: Path): boolean;
+    isEqual(path: Path): boolean;
+    relativity(path: Path): number;
+  }
+  export class URI {
+    static from(components: {
+      scheme: string;
+      authority?: string;
+      path?: string;
+      query?: string;
+      fragment?: string;
+    }): URI;
+    static file(path: string): URI;
+    static parse(path: string): URI;
+    static isUri(thing: any): thing is URI;
+    static isUriString(str: string): boolean;
+    static revive(data: any): Uri;
+    readonly codeUri: Uri;
+    private _path;
+    constructor(uri?: string | Uri);
+    get displayName(): string;
+    /**
+     * Return all uri from the current to the top most.
+     */
+    get allLocations(): URI[];
+    get parent(): URI;
+    relative(uri: URI): Path | undefined;
+    resolve(path: string | Path): URI;
+    /**
+     * return a new URI replacing the current with the given scheme
+     */
+    withScheme(scheme: string): URI;
+    /**
+     * @deprecated
+     * return this URI without a scheme
+     */
+    withoutScheme(): URI;
+    /**
+     * return a new URI replacing the current with the given authority
+     */
+    withAuthority(authority: string): URI;
+    /**
+     * return this URI without a authority
+     */
+    withoutAuthority(): URI;
+    /**
+     * return a new URI replacing the current with the given path
+     */
+    withPath(path: string | Path): URI;
+    /**
+     * return this URI without a path
+     */
+    withoutPath(): URI;
+    /**
+     * return a new URI replacing the current with the given query
+     */
+    withQuery(query: string): URI;
+    /**
+     * return this URI without a query
+     */
+    withoutQuery(): URI;
+    /**
+     * return a new URI replacing the current with the given fragment
+     */
+    withFragment(fragment: string): URI;
+    /**
+     * return this URI without a fragment
+     */
+    withoutFragment(): URI;
+    get scheme(): string;
+    get authority(): string;
+    get path(): Path;
+    get query(): string;
+    get fragment(): string;
+    toString(skipEncoding?: boolean): string;
+    isEqualOrParent(uri: URI): boolean;
+    isEqual(uri: URI): boolean;
+    matchGlobPattern(pattern: string | IRelativePattern): boolean;
+    static getDistinctParents(uris: URI[]): URI[];
+    getParsedQuery(): {
+      [key: string]: string;
+    };
+    static stringifyQuery(query: { [key: string]: any }): string;
+  }
 
   export interface ScrollAreaProps {
     className?: string;
@@ -45,9 +155,7 @@ declare module 'sumi-browser' {
     top: number;
     left: number;
   }
-  export class Scroll extends React.Component<ScrollAreaProps, any> {
-
-  }
+  export class Scroll extends React.Component<ScrollAreaProps, any> {}
 
   export interface ResizeHandleProps {
     onFinished?: () => void;
@@ -64,7 +172,7 @@ declare module 'sumi-browser' {
   export const ResizeHandleHorizontal: React.ComponentType<ResizeHandleProps>;
   export const ResizeHandleVertical: React.ComponentType<ResizeHandleProps>;
 
-  export const PlainWebview: React.ComponentType<{ id: string, appendToChild?: boolean, renderRoot?: HTMLElement }>;
+  export const PlainWebview: React.ComponentType<{ id: string; appendToChild?: boolean; renderRoot?: HTMLElement }>;
 
   // scope 目前不是必要的，可以直接从 extension 拿到 id
   // 为了兼容已经在使用的插件，暂时先保留声明
@@ -79,7 +187,7 @@ declare module 'sumi-browser' {
    */
   export function formatLocalize(key: string, ...args: string[]): string;
 
-  export function getIcon(iconKey: string, options?: { rotate?: ROTATE_TYPE, anim?: ANIM_TYPE }): string;
+  export function getIcon(iconKey: string, options?: { rotate?: ROTATE_TYPE; anim?: ANIM_TYPE }): string;
 
   /**
    * 获得当前主题的颜色值
@@ -236,28 +344,27 @@ declare module 'sumi-browser' {
      */
     tabTitle?: string;
     /**
-    * 相对于插件路径的icon地址
-    * 如果需要更复杂的图标Resolve，需要在kaitian node进程中注册ResourceProvider
-    */
+     * 相对于插件路径的icon地址
+     * 如果需要更复杂的图标Resolve，需要在kaitian node进程中注册ResourceProvider
+     */
     tabIconPath?: string;
   }
   export namespace commands {
-
     /**
-    * Executes the command denoted by the given command identifier.
-    *
-    * * *Note 1:* When executing an editor command not all types are allowed to
-    * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
-    * `number`, `undefined`, and `null`, as well as [`Position`](#Position), [`Range`](#Range), [`Uri`](#Uri) and [`Location`](#Location).
-    * * *Note 2:* There are no restrictions when executing commands that have been contributed
-    * by extensions.
-    * * *Note 3:* Can not execute some builtin commands.
-    *
-    * @param command Identifier of the command to execute.
-    * @param rest Parameters passed to the command function.
-    * @return A promise that resolves to the returned value of the given command. `undefined` when
-    * the command handler function doesn't return anything.
-    */
+     * Executes the command denoted by the given command identifier.
+     *
+     * * *Note 1:* When executing an editor command not all types are allowed to
+     * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
+     * `number`, `undefined`, and `null`, as well as [`Position`](#Position), [`Range`](#Range), [`Uri`](#Uri) and [`Location`](#Location).
+     * * *Note 2:* There are no restrictions when executing commands that have been contributed
+     * by extensions.
+     * * *Note 3:* Can not execute some builtin commands.
+     *
+     * @param command Identifier of the command to execute.
+     * @param rest Parameters passed to the command function.
+     * @return A promise that resolves to the returned value of the given command. `undefined` when
+     * the command handler function doesn't return anything.
+     */
     export function executeCommand<T>(command: string, ...rest: any[]): Promise<T | undefined>;
   }
 
@@ -269,5 +376,4 @@ declare module 'sumi-browser' {
     export function time(name: string): IReporterTimer;
     export function point(name: string, msg?: string, extra?: any): void;
   }
-
 }