@opensumi/sumi 2.12.1-next-079c1930

package/sumi-browser.d.ts

@@ -0,0 +1,273 @@
+interface IComponentMethod {
+  [methodName: string]: any; // Function
+}
+
+interface IComponentProps<N, W = any> {
+  kaitianExtendSet: {
+    set<T = IComponentMethod>(methods: T): void;
+  };
+  kaitianExtendService: {
+    node: N;
+    worker: W;
+  };
+  viewState?: {
+    width: number;
+    height: number;
+  };
+}
+
+/**
+ * @deprecated `katian-browser` is deprecated. Please use `sumi-browser` instead.
+ */
+declare module 'kaitian-browser' {
+  export * from 'sumi-browser';
+}
+
+declare module 'sumi-browser' {
+  export * from '@opensumi/ide-components';
+
+  import type vscode from 'vscode';
+  import React from 'react';
+
+  import { ROTATE_TYPE, ANIM_TYPE } from '@opensumi/ide-components';
+
+  export { URI } from '@opensumi/ide-core-browser';
+
+  export interface ScrollAreaProps {
+    className?: string;
+    onScroll?: (position: ScrollPosition) => any;
+    atTopClassName?: string;
+    style?: any;
+    containerStyle?: any;
+  }
+
+  export interface ScrollPosition {
+    top: number;
+    left: number;
+  }
+  export class Scroll extends React.Component<ScrollAreaProps, any> {
+
+  }
+
+  export interface ResizeHandleProps {
+    onFinished?: () => void;
+    onResize?: () => void;
+    max?: number;
+    min?: number;
+    preserve?: number;
+    className?: string;
+    delegate?: (delegate: IResizeHandleDelegate) => void;
+  }
+  export interface IResizeHandleDelegate {
+    setSize(prev: number, next: number): void;
+  }
+  export const ResizeHandleHorizontal: React.ComponentType<ResizeHandleProps>;
+  export const ResizeHandleVertical: React.ComponentType<ResizeHandleProps>;
+
+  export const PlainWebview: React.ComponentType<{ id: string, appendToChild?: boolean, renderRoot?: HTMLElement }>;
+
+  // scope 目前不是必要的，可以直接从 extension 拿到 id
+  // 为了兼容已经在使用的插件，暂时先保留声明
+  export function localize(key: string, defaultMessage?: string, scope?: string): string;
+
+  /**
+   * 格式化国际化文案
+   * @example
+   * ```js
+   * kaitian.formatLocalize('task.label', '任务', '运行');
+   * ```
+   */
+  export function formatLocalize(key: string, ...args: string[]): string;
+
+  export function getIcon(iconKey: string, options?: { rotate?: ROTATE_TYPE, anim?: ANIM_TYPE }): string;
+
+  /**
+   * 获得当前主题的颜色值
+   * 格式 '-分割的颜色名':'颜色值(rgb, rgba或hex)'
+   * @example
+   * ```json
+   * {
+   *  'editor-background':'#000000',
+   * }
+   * ```
+   */
+  export function getThemeColors(): { [key: string]: string };
+
+  export enum ToolBarPosition {
+    /**
+     * 左边
+     */
+    LEFT = 1,
+    /**
+     * 中间
+     */
+    CENTER = 2,
+    /**
+     * 右边
+     */
+    RIGHT = 3,
+  }
+
+  export type ISumiBrowserConfig = IKaitianBrowserConfig;
+  /**
+   * @deprecated `IKaitianBrowserConfig` was renamed to `ISumiBrowserConfig`, use that instead.
+   */
+  export interface IKaitianBrowserConfig {
+    left?: {
+      component: ITabBarComponentContribution[];
+    };
+    right?: {
+      component: ITabBarComponentContribution[];
+    };
+    bottom?: {
+      component: ITabBarComponentContribution[];
+    };
+    editor?: {
+      component: IEditorComponentContribution[];
+    };
+    toolBar?: {
+      position?: ToolBarPosition;
+      component: IToolBarComponentContribution[];
+    };
+  }
+
+  export interface IToolBarComponentContribution {
+    /**
+     * id
+     */
+    id: string;
+    /**
+     * ToolBar 组件主体
+     */
+    panel: React.ComponentType;
+    /**
+     * 位置
+     */
+    position: ToolBarPosition;
+  }
+  export interface ITabBarComponentContribution {
+    /**
+     * id
+     */
+    id: string;
+    /**
+     * Tabbar组件主体
+     */
+    panel: React.ComponentType;
+    /**
+     * 内置icon名称
+     */
+    icon?: string;
+    /**
+     * 相对于插件路径的icon地址
+     */
+    iconPath?: string;
+    /**
+     * 用于激活的快捷键
+     */
+    keyBinding?: string;
+    /**
+     * 名称
+     */
+    title: string;
+    /**
+     * 排序权重
+     */
+    priority?: number;
+    /**
+     * 禁止面板的resize功能
+     */
+    noResize?: boolean;
+    /**
+     * 是否全部展开
+     */
+    expanded?: boolean;
+  }
+
+  export enum EditorComponentRenderMode {
+    ONE_PER_RESOURCE = 1, // 每个resource渲染一个新的
+    ONE_PER_GROUP = 2, // 每个Group最多存在一个新的
+    ONE_PER_WORKBENCH = 3, // 整个IDE只有一个, 视图会被重用
+  }
+
+  export interface IEditorComponentContribution {
+    /**
+     * id
+     */
+    id: string;
+    /**
+     * 适配的scheme, 如果不填，默认为file协议
+     */
+    scheme?: string;
+    /**
+     * editor组件主体
+     */
+    panel: React.ComponentType;
+    /**
+     * 渲染方式
+     */
+    renderMode?: EditorComponentRenderMode;
+    /**
+     * 仅作用于file协议
+     * 要处理的文件的后缀
+     */
+    fileExt?: string[];
+    /**
+     * 仅作用于file协议
+     * 判断一个path是否要被处理
+     * @deprecated
+     */
+    // shouldPreview?: (path: Path) => boolean;
+    /**
+     * 判断一个uri是否要被处理(传入参数为vscode uri)
+     * 如果不存在handles方法，则默认显示（file协议还要过shouldPreview和fileExt)
+     */
+    handles?: (uri: vscode.Uri) => boolean;
+    /**
+     * 如果这个资源有多个打开方式，这个会作为打开方式名称
+     */
+    title?: string;
+    /**
+     * 排序权重， 默认为10
+     */
+    priority?: number;
+    /**
+     * Tab名称，如果需要更复杂的名称Resolve，需要在kaitian node进程中注册ResourceProvider
+     */
+    tabTitle?: string;
+    /**
+    * 相对于插件路径的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.
+    */
+    export function executeCommand<T>(command: string, ...rest: any[]): Promise<T | undefined>;
+  }
+
+  export interface IReporterTimer {
+    timeEnd(msg?: string, extra?: any): number;
+  }
+
+  export namespace reporter {
+    export function time(name: string): IReporterTimer;
+    export function point(name: string, msg?: string, extra?: any): void;
+  }
+
+}