react-terminal-viewer-cicd 2.1.1 → 3.0.0-beta.2

package/dist/worker/src/TerminalViewer/index.d.ts

@@ -0,0 +1,185 @@
+import { ITerminalOptions } from '@xterm/xterm';
+import React from 'react';
+import type { IHighlightOptions } from '../Addon/HighlightAddon';
+import type { ISearchOptions } from '../Addon/SearchAddon';
+import type { ICacheOptions } from '../Hooks/useCache';
+import type { IRemoteOptions } from '../Hooks/useRemote';
+import { ExtraOptions, LogAfterProps, TerminalRef } from '../types';
+import './index.less';
+export interface TerminalViewerProps {
+    /**
+     * @description.zh-CN 指定 TerminalViewer 挂载的节点，并在容器内展现，false 为挂载在当前位置
+     * @default 当前位置
+     */
+    ref?: TerminalRef;
+    /**
+     * @description.zh-CN 是否自动拉伸填充容器宽高
+     * @default true
+     */
+    fit?: boolean;
+    /**
+     *@description.zh-CN 是否开启自动滚动到底部
+     *@default true
+     */
+    autoScroll?: boolean;
+    /**
+     * @description.zh-CN 自动滚动到某一行，开启后自动滚动到底部失效
+     */
+    scrollToRow?: number;
+    /**
+     * @description.zh-CN 是否支持刷新
+     * @default true
+     */
+    refreshable?: boolean;
+    /**
+     * @description.zh-CN 搜索框 placeholder
+     */
+    searchPlaceholder?: string;
+    /**
+     * @description.zh-CN 默认全屏显示
+     * @default false
+     */
+    defaultFullScreen?: boolean;
+    /**
+     * @description.zh-CN 自定义日志头部, null 为不显示默认头部
+     */
+    header?: React.ReactNode;
+    /**
+     * @description.zh-CN 搜索框前的内容
+     */
+    inputAddonBefore?: React.ReactNode;
+    /**
+     * @description.zh-CN 搜索框后的内容
+     */
+    inputAddonAfter?: React.ReactNode;
+    /**
+     * @description.zh-CN toolbar 自定义工具栏
+     */
+    toolbar?: React.ReactNode;
+    /**
+     * @description.zh-CN 是否显示全屏图标
+     * @default true
+     */
+    showFullScreen?: boolean;
+    /**
+     * @description.zh-CN 自定义空文本显示
+     */
+    empty?: React.ReactNode;
+    /**
+     * @description.zh-CN 外层样式类名
+     */
+    className?: string;
+    /**
+     * @description.zh-CN 可用于设置外层容器样式
+     */
+    style?: object;
+    /**
+     * @description.zh-CN 用于渲染日志的默认数据，如 "echo 1\r\necho2"
+     * @default ''
+     */
+    defaultData?: string;
+    /**
+     * @description.zh-CN 默认打开的标签
+     * @default 0
+     */
+    defaultTabIndex?: number;
+    /**
+     * @description.zh-CN 激活的标签, 如果同时设置了 defaultTabIndex 则以此属性为准
+     * @default 0
+     */
+    activeTabIndex?: number;
+    /**
+     * @description.zh-CN 设置日志后置标签，仅在开启虚拟 DOM 生效
+     */
+    logAfter?: React.FunctionComponent<LogAfterProps> | React.ComponentClass<LogAfterProps>;
+    /**
+     * @description.zh-CN 多标签配置选项
+     */
+    tabs?: {
+        key: string | number;
+        title?: React.ReactNode;
+        defaultData?: string;
+        remoteOptions?: IRemoteOptions;
+        cacheOptions?: ICacheOptions;
+    }[];
+    /**
+     *@description.zh-CN 自定义图标
+     */
+    icons?: {
+        search?: React.ReactNode;
+        up?: React.ReactNode;
+        down?: React.ReactNode;
+        clear?: React.ReactNode;
+        top?: React.ReactNode;
+        bottom?: React.ReactNode;
+        fullScreen?: React.ReactNode;
+        fullScreenExit?: React.ReactNode;
+        refresh?: React.ReactNode;
+        loading?: React.ReactNode;
+    };
+    /**
+     * @description.zh-CN 是否支持渲染超链接
+     * @default true
+     */
+    webLinksSupport?: boolean;
+    /**
+     * @description.zh-CN 是否使用 canvas 渲染, 开启 canvas 会有更好的性能但可能会遇到更多的问题
+     * @default false
+     */
+    canvasSupport?: boolean;
+    /**
+     * @description.zh-CN 是否使用自研虚拟 DOM 内核，开启后 terminalOptions, canvasSupport, webLinksSupport 不可用
+     * @default false
+     */
+    virtualDomSupport?: boolean;
+    /**
+     * @description.zh-CN  日志 web worker 路径, 需配合 CopyPlugin 使用且仅在开启 virtualDomSupport 为 true 时有效
+  
+     * @default "/worker"
+     */
+    workerPath?: string;
+    /**
+     * @description.zh-CN 远程加载配置
+     *
+     */
+    remoteOptions?: IRemoteOptions;
+    /**
+     * @description.zh-CN 缓存全局配置，仅在配置远程加载后有效，如 `expires: 60 * 1000` 表示自动清理已过期一分钟的缓存
+     */
+    cacheOptions?: ICacheOptions;
+    /**
+     * @description.zh-CN xterm 搜索选项
+     */
+    searchOptions?: ISearchOptions;
+    /**
+     * @description.zh-CN 高亮选项
+     */
+    highlightOptions?: IHighlightOptions[];
+    /**
+     * @description.zh-CN xtem.js 配置, https://github.com/xtermjs/xterm.js
+     */
+    terminalOptions?: ITerminalOptions;
+    /**
+     * @description.zh-CN 额外的功能选项 { showLineNumber 仅 虚拟 DOM 模式支持}
+     */
+    extraOptions?: ExtraOptions;
+    /**
+     * @description.zh-CN 指定 TerminalViewer 挂载的节点，并在容器内展现，开启全屏后无效， false 为挂载在当前位置
+     * @default 当前节点
+     */
+    getContainer?: string | HTMLElement | (() => HTMLElement | null);
+    /**
+     * @description.zh-CN 点击 tab 标题后回调函数
+     */
+    onTitleChange?: (index: number) => void;
+    /**
+     * @description.zh-CN 加载状态变更回调函数
+     */
+    onLoading?: (bool: boolean) => void;
+    /**
+     * @description.zh-CN 刷新后的回调函数
+     */
+    onRefresh?: () => void;
+}
+declare const TerminalViewer: React.ForwardRefExoticComponent<Omit<TerminalViewerProps, "ref"> & React.RefAttributes<TerminalRef | undefined>>;
+export default TerminalViewer;

package/dist/worker/src/TerminalViewer/index.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/dist/worker/src/TerminalViewerBody/index.d.ts

@@ -0,0 +1,87 @@
+import { CanvasAddon } from '@xterm/addon-canvas';
+import { FitAddon } from '@xterm/addon-fit';
+import { WebLinksAddon } from '@xterm/addon-web-links';
+import { ITerminalOptions, Terminal } from '@xterm/xterm';
+import '@xterm/xterm/css/xterm.css';
+import React from 'react';
+import type { IHighlightOptions } from '../Addon/HighlightAddon';
+import { HighlightAddon } from '../Addon/HighlightAddon';
+import { SearchAddon } from '../Addon/SearchAddon';
+import type { AddonType } from '../Addon/useAddon';
+import type { ICacheOptions } from '../Hooks/useCache';
+import type { IRemoteOptions } from '../Hooks/useRemote';
+import { TerminalRef } from '../types';
+import './index.less';
+export interface TerminalExposedRef {
+    terminal?: Terminal | undefined;
+    addons?: {
+        search?: SearchAddon | undefined;
+        fit?: FitAddon | undefined;
+        webLinks?: WebLinksAddon | undefined;
+        highlight?: HighlightAddon | undefined;
+        canvas?: CanvasAddon | undefined;
+    };
+    refresh?: (() => void) | undefined;
+}
+export interface TerminalViewerBodyProps {
+    /**
+     * @description.zh-CN 是否自动拉伸填充容器宽高
+     * @default true
+     */
+    fit?: boolean;
+    /**
+     *@description.zh-CN 是否开启自动滚动到底部
+     *@default true
+     */
+    autoScroll?: boolean;
+    /**
+     * @description.zh-CN 外层样式类名
+     */
+    className?: string;
+    /**
+     * @description.zh-CN 自定义空文本显示
+     */
+    empty?: React.ReactNode;
+    /**
+     * @description.zh-CN 是否支持渲染超链接
+     * @default true
+     */
+    webLinksSupport?: boolean;
+    /**
+     * @description.zh-CN 是否使用 canvas 渲染
+     * @default false
+     */
+    canvasSupport?: boolean;
+    /**
+     * @description.zh-CN 远程搜索选配置
+     *
+     */
+    remoteOptions?: IRemoteOptions;
+    /**
+     * @description.zh-CN 缓存配置，仅在配置远程加载后有效，如 `expires: 60 * 1000` 表示自动清理已过期一分钟的缓存
+     */
+    cacheOptions?: ICacheOptions;
+    /**
+     * @description.zh-CN 高亮选项
+     */
+    highlightOptions?: IHighlightOptions[];
+    /**
+     * @description.zh-CN xtem.js 配置, https://github.com/xtermjs/xterm.js
+     */
+    terminalOptions?: ITerminalOptions;
+    /**
+     * @description.zh-CN 用于渲染日志的默认数据，如 "echo 1\r\necho2"
+     * @default '''
+     */
+    defaultData?: string;
+    /**
+     * @description.zh-CN 插件加载成功后的回调
+     */
+    onAddonReady?: (instance: Terminal, addon: AddonType) => void;
+    /**
+     * @description.zh-CN 加载状态变更后的回调
+     */
+    onLoading?: (loading: boolean) => void;
+}
+declare const TerminalViewerBody: React.ForwardRefExoticComponent<TerminalViewerBodyProps & React.RefAttributes<TerminalRef | undefined>>;
+export default TerminalViewerBody;

package/dist/worker/src/TerminalViewerBody/index.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/dist/worker/src/TerminalViewerHeader/index.d.ts

@@ -0,0 +1,88 @@
+import React from 'react';
+import './index.less';
+export interface TerminalViewerHeaderProps {
+    /**
+     * @description.zh-CN 搜索框 placeholder
+     * @default 请输入
+     */
+    placeholder?: string;
+    /**
+     * @description.zh-CN  搜索框默认内容
+     *
+     */
+    defaultValue?: string;
+    /**
+     * @description.zh-CN 是否支持清除搜索框
+     * @default true
+     */
+    clearable?: string;
+    /**
+     * @description.zh-CN 是否支持刷新
+     */
+    refreshable?: boolean;
+    /**
+     * @description.zh-CN 是否处于加载状态
+     */
+    loading?: boolean;
+    /**
+     * @description.zh-CN 搜索结果
+     */
+    searchResult?: {
+        resultIndex: number;
+        resultCount: number;
+    };
+    /**
+     * @description.zh-CN 激活的标题
+     * @default 0;
+     */
+    activeTitleIndex?: number;
+    /**
+     * @description.zh-CN Tab 标题
+     */
+    titles?: React.ReactNode[] | number[];
+    /**
+     * @description.zh-CN 搜索框前的内容
+     */
+    inputAddonBefore?: React.ReactNode;
+    /**
+     * @description.zh-CN 搜索框后的内容
+     */
+    inputAddonAfter?: React.ReactNode;
+    /**
+     *@description.zh-CN 自定义图标
+     */
+    icons?: {
+        search?: React.ReactNode;
+        up?: React.ReactNode;
+        down?: React.ReactNode;
+        clear?: React.ReactNode;
+        refresh?: React.ReactNode;
+        loading?: React.ReactNode;
+    };
+    /**
+     * @description.zh-CN 点击下一个按钮回调
+     */
+    onSearchPrev?: (value: string) => void;
+    /**
+     * @description.zh-CN 点击上一个按钮回调
+     */
+    onSearchNext?: (value: string) => void;
+    /**
+     * @description.zh-CN 搜索框文本变更回调函数
+     */
+    onSearchChange?: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * @description.zh-CN 清空文本框后回调函数
+     */
+    onSearchClear?: (e: React.SyntheticEvent<HTMLElement>) => void;
+    /**
+     * @description.zh-CN 点击 Tab 标题后回调函数
+     */
+    onTitleChange?: (index: number) => void;
+    /**
+     *@description.zh-CN 点击刷新按钮后的回调
+     */
+    onRefresh?: (e: React.SyntheticEvent<HTMLSpanElement>) => void;
+}
+declare const TerminalViewerHeader: React.FC<TerminalViewerHeaderProps>;
+export default TerminalViewerHeader;

package/dist/worker/src/TerminalViewerToolBar/index.d.ts

@@ -0,0 +1,46 @@
+import React from 'react';
+import './index.less';
+interface TerminalViewerToolBarProps {
+    /**
+     * @description.zh-CN 外层容器样式类名
+     */
+    className?: string;
+    /**
+     * @description.zh-CN 外层容器样式
+     *
+     */
+    style?: object;
+    /**
+     *@description.zh-CN 自定义图标
+     */
+    icons?: {
+        top?: React.ReactNode;
+        bottom?: React.ReactNode;
+        fullScreen?: React.ReactNode;
+        fullScreenExit?: React.ReactNode;
+    };
+    /**
+     * @description.zh-CN 是否为全屏模式
+     * @default false
+     */
+    fullScreen?: boolean;
+    /**
+     * @description.zh-CN 是否显示全屏图标
+     * @default true
+     */
+    showFullScreen?: boolean;
+    /** *
+     * @description.zh.CN 点击滚动到顶部按钮的回调
+     */
+    onScrollTop?: (e: React.SyntheticEvent<HTMLDivElement>) => void;
+    /**
+     * @description.zh.CN 点击滚动到底部按钮的回调
+     */
+    onScrollBottom?: (e: React.SyntheticEvent<HTMLDivElement>) => void;
+    /**
+     * @description.zh.CN 点击全屏/取消全屏按钮的回调
+     */
+    onFullScreen?: (e: React.SyntheticEvent<HTMLDivElement>) => void;
+}
+declare const TerminalViewerToolBar: React.FC<TerminalViewerToolBarProps>;
+export default TerminalViewerToolBar;

package/dist/worker/src/TerminalViewerVirtualDom/ReactVirtualized.d.ts

@@ -0,0 +1,71 @@
+import React from 'react';
+import type { ListRowProps } from 'react-virtualized';
+import { IHighlightOptions } from '../Addon/HighlightAddon';
+import type { SearcherRef } from '../Addon/WorkerLog/types';
+import type { ICacheOptions } from '../Hooks/useCache';
+import type { IRemoteOptions } from '../Hooks/useRemote';
+import { ExtraOptions, LogAfterProps, TerminalRef, VirtualDomTerminal } from '../types';
+import './virtualized.less';
+export interface TerminalViewerVirtualDomProps {
+    /**
+     * @description.zh-CN 是否自动拉伸填充容器宽高
+     * @default true
+     */
+    fit?: boolean;
+    /**
+     * @description.zh-CN 外层样式类名
+     */
+    className?: string;
+    /**
+     * @description.zh-CN 自定义空文本显示
+     */
+    empty?: React.ReactNode;
+    /**
+     *@description.zh-CN 是否开启自动滚动到底部
+     *@default true
+     */
+    autoScroll?: boolean;
+    /**
+     * @description.zh-CN 自动滚动到某一行，开启后自动滚动到底部失效
+     */
+    scrollToRow?: number;
+    /**
+     * @description.zh-CN 设置日志后置标签，仅在开启虚拟 DOM 生效
+     */
+    logAfter?: React.FunctionComponent<LogAfterProps> | React.ComponentClass<LogAfterProps>;
+    /**
+     * @description.zh-CN 用于渲染日志的默认数据，如 "echo 1\r\necho2"
+     * @default '''
+     */
+    defaultData?: string;
+    /**
+     * @description.zh-CN 远程搜索配置
+     *
+     */
+    remoteOptions?: IRemoteOptions;
+    /**
+     * @description.zh-CN 缓存配置，仅在配置远程加载后有效，如 `expires: 60 * 1000` 表示自动清理已过期一分钟的缓存
+     */
+    cacheOptions?: ICacheOptions;
+    /**
+     * @description.zh-CN 高亮选项
+     */
+    highlightOptions?: IHighlightOptions[];
+    /**
+     * @description.zh-CN 额外的功能选项 { showLineNumber 仅 虚拟 DOM 模式支持}
+     */
+    extraOptions?: ExtraOptions;
+    /**
+     * @description.zh-CN 插件加载成功后的回调
+     */
+    onAddonReady?: (instance?: VirtualDomTerminal, addon?: SearcherRef) => void;
+    /**
+     * @description.zh-CN 加载状态变更后的回调
+     */
+    onLoading?: (loading: boolean) => void;
+}
+export type RowRenderProps = ListRowProps & {
+    style: object;
+};
+declare const ReactVirtualized: React.ForwardRefExoticComponent<TerminalViewerVirtualDomProps & React.RefAttributes<TerminalRef | undefined>>;
+export default ReactVirtualized;

package/dist/worker/src/TerminalViewerVirtualDom/ReactVirtuoso.d.ts

@@ -0,0 +1,67 @@
+import React from 'react';
+import { IHighlightOptions } from '../Addon/HighlightAddon';
+import type { SearcherRef } from '../Addon/WorkerLog/types';
+import type { ICacheOptions } from '../Hooks/useCache';
+import type { IRemoteOptions } from '../Hooks/useRemote';
+import { ExtraOptions, LogAfterProps, TerminalRef, VirtualDomTerminal } from '../types';
+import './virtuoso.less';
+export interface TerminalViewerVirtualDomProps {
+    /**
+     * @description.zh-CN 是否自动拉伸填充容器宽高
+     * @default true
+     */
+    fit?: boolean;
+    /**
+     * @description.zh-CN 外层样式类名
+     */
+    className?: string;
+    /**
+     * @description.zh-CN 自定义空文本显示
+     */
+    empty?: React.ReactNode;
+    /**
+     *@description.zh-CN 是否开启自动滚动到底部
+     *@default true
+     */
+    autoScroll?: boolean;
+    /**
+     * @description.zh-CN 自动滚动到某一行，开启后自动滚动到底部失效
+     */
+    scrollToRow?: number;
+    /**
+     * @description.zh-CN 设置日志后置标签，仅在开启虚拟 DOM 生效
+     */
+    logAfter?: React.FunctionComponent<LogAfterProps> | React.ComponentClass<LogAfterProps>;
+    /**
+     * @description.zh-CN 用于渲染日志的默认数据，如 "echo 1\r\necho2"
+     * @default '''
+     */
+    defaultData?: string;
+    /**
+     * @description.zh-CN 远程搜索配置
+     *
+     */
+    remoteOptions?: IRemoteOptions;
+    /**
+     * @description.zh-CN 缓存配置，仅在配置远程加载后有效，如 `expires: 60 * 1000` 表示自动清理已过期一分钟的缓存
+     */
+    cacheOptions?: ICacheOptions;
+    /**
+     * @description.zh-CN 高亮选项
+     */
+    highlightOptions?: IHighlightOptions[];
+    /**
+     * @description.zh-CN 额外的功能选项 { showLineNumber 仅 虚拟 DOM 模式支持}
+     */
+    extraOptions?: ExtraOptions;
+    /**
+     * @description.zh-CN 插件加载成功后的回调
+     */
+    onAddonReady?: (instance?: VirtualDomTerminal, addon?: SearcherRef) => void;
+    /**
+     * @description.zh-CN 加载状态变更后的回调
+     */
+    onLoading?: (loading: boolean) => void;
+}
+declare const ReactVirtuoso: React.ForwardRefExoticComponent<TerminalViewerVirtualDomProps & React.RefAttributes<TerminalRef | undefined>>;
+export default ReactVirtuoso;

package/dist/worker/src/TerminalViewerVirtualDom/index.d.ts

@@ -0,0 +1,2 @@
+import TerminalViewerVirtualDom from './ReactVirtuoso';
+export default TerminalViewerVirtualDom;

package/dist/worker/src/index.d.ts

@@ -0,0 +1,8 @@
+import { ITerminalOptions, Terminal } from '@xterm/xterm';
+import TerminalViewer from './TerminalViewer';
+import TerminalViewerBody from './TerminalViewerBody';
+import TerminalViewerHeader from './TerminalViewerHeader';
+import TerminalViewerToolBar from './TerminalViewerToolBar';
+import TerminalViewerVirtualDom from './TerminalViewerVirtualDom';
+export { ITerminalOptions, Terminal, TerminalViewerBody, TerminalViewerHeader, TerminalViewerToolBar, TerminalViewerVirtualDom, };
+export default TerminalViewer;

package/dist/worker/src/mock/index.d.ts

@@ -0,0 +1,15 @@
+export declare function loadTest(): string;
+export declare function loadAdvancedTest(): string;
+export declare function loadCustomHighLightTest(random?: boolean): string;
+export declare function fetchCustomHighLightTest(start?: number): Promise<unknown>;
+export declare function remoteFetch(key?: number): Promise<unknown>;
+export declare function cacheFetch(key?: number): Promise<unknown>;
+declare const _default: {
+    loadTest: typeof loadTest;
+    loadAdvancedTest: typeof loadAdvancedTest;
+    loadCustomHighLightTest: typeof loadCustomHighLightTest;
+    fetchCustomHighLightTest: typeof fetchCustomHighLightTest;
+    remoteFetch: typeof remoteFetch;
+    cacheFetch: typeof cacheFetch;
+};
+export default _default;

package/dist/worker/src/types.d.ts

@@ -0,0 +1,30 @@
+import { CanvasAddon } from '@xterm/addon-canvas';
+import { FitAddon } from '@xterm/addon-fit';
+import { WebLinksAddon } from '@xterm/addon-web-links';
+import { Terminal } from '@xterm/xterm';
+import { HighlightAddon } from './Addon/HighlightAddon';
+import { SearchAddon } from './Addon/SearchAddon';
+import type { SearcherRef } from './Addon/WorkerLog/types';
+export interface ExtraOptions {
+    showLineNumber?: boolean;
+}
+export interface VirtualDomTerminal {
+    scrollToTop: () => void;
+    scrollToBottom: () => void;
+}
+export interface TerminalRef {
+    el?: HTMLDivElement | null;
+    refresh: () => void;
+    addons?: {
+        search?: () => SearchAddon | SearcherRef | undefined;
+        fit?: () => FitAddon | undefined;
+        webLinks?: () => WebLinksAddon | undefined;
+        highlight?: () => HighlightAddon | undefined;
+        canvas?: () => CanvasAddon | undefined;
+    } | undefined;
+    terminal?: () => Terminal | VirtualDomTerminal | undefined;
+}
+export interface LogAfterProps {
+    index: number;
+    content: string;
+}

package/dist/worker/types.d.ts

@@ -1,7 +1,7 @@
-import { Terminal } from 'xterm';
-import { FitAddon } from 'xterm-addon-fit';
-import { WebLinksAddon } from 'xterm-addon-web-links';
-import { CanvasAddon } from 'xterm-addon-canvas';
+import { Terminal } from '@xterm/xterm';
+import { FitAddon } from '@xterm/addon-fit';
+import { WebLinksAddon } from '@xterm/addon-web-links';
+import { CanvasAddon } from '@xterm/addon-canvas';
 import { HighlightAddon } from './Addon/HighlightAddon';
 import { SearchAddon } from './Addon/SearchAddon';
 import type { SearcherRef } from './Addon/WorkerLog/types';