@cloudtower/eagle 4100.0.2 → 4100.0.3

package/dist/src/core/LogView/LogView.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import type { LogViewProps } from "./LogView.types";
+export declare const LogView: React.FC<LogViewProps>;

package/dist/src/core/LogView/LogView.style.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+export declare const LogViewContainer: import("@linaria/react").StyledComponent<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & Record<never, unknown>>;
+export declare const LogViewInnerContaier: import("@linaria/react").StyledComponent<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & Record<never, unknown>>;
+export declare const LogTerminal: import("@linaria/react").StyledComponent<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & Record<never, unknown>>;
+export declare const CustomContentOverlay: import("@linaria/react").StyledComponent<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & Record<never, unknown>>;
+export declare const SearchInputStyle: import("@linaria/core").LinariaClassName;

package/dist/src/core/LogView/LogView.types.d.ts

@@ -0,0 +1,103 @@
+/// <reference types="react" />
+import type { EventSourceInit } from "eventsource";
+import type { Terminal } from "@xterm/xterm";
+import type { SearchInputProps } from "../SearchInput";
+export interface EventSourceOptions {
+    closeEventName?: string;
+    openEventName?: string;
+    errorEventName?: string;
+    messageEventName?: string;
+    url?: string;
+    initOptions?: EventSourceInit;
+    /**
+     * Callback when the eventsource is opened
+     */
+    onOpen?: ((e: Event, eventSource: EventSource, params: {
+        terminal: Terminal;
+    }) => void) | undefined;
+    /**
+     * Callback when the eventsource is closed
+     */
+    onClose?: ((e: Event) => void) | undefined;
+    /**
+     * Callback when the eventsource has an error
+     */
+    onError?: ((e: Event) => void) | undefined;
+    /**
+     * Callback which formats the eventsource data stream.
+     */
+    onMessage?: ((message: any) => void) | undefined;
+    formatMessage?: ((message: any) => string) | undefined;
+    /**
+     * Set to true, to reconnect the EventSource automatically.
+     */
+    reconnect?: boolean;
+    /**
+     * Set the time to wait between reconnects in seconds.
+     * Default is 1s
+     */
+    reconnectWait?: number;
+    onSetupEventSource?: (params: {
+        setupFn: () => void;
+    }) => void;
+}
+export interface LogViewProps {
+    /**
+     * 类名
+     */
+    className?: string;
+    /**
+     * 是否显示顶部搜索栏。
+     * @default true
+     */
+    showSearch?: boolean;
+    /**
+     * 静态日志内容，换行后会按终端逐行渲染。
+     */
+    content?: string;
+    /**
+     * 是否启用 EventSource
+     * @default false
+     */
+    eventSource?: boolean;
+    /**
+     * EventSource 的配置
+     */
+    eventSourceOptions?: EventSourceOptions;
+    /**
+     * 终端滚动缓冲区大小，用于限制保留的历史日志行数。
+     * @default 9999999
+     */
+    scrollback?: number;
+    /**
+     * 终端可视区域的行数
+     * @default 23
+     */
+    rows?: number;
+    /**
+     * 搜索高亮结果的最大数量，注意：在日志数据量较大时需要设置为较小的值（比如 1000），否则可能会导致性能问题，请根据实际情况进行调整
+     * @default 999999
+     */
+    searchHighlightLimit?: number;
+    /**
+     * 是否启用键盘快捷键
+     * @default true
+     */
+    enableKeyboardShortcuts?: boolean;
+    /**
+     * 自定义无数据时的内容渲染
+     * @param terminal xterm终端实例，可用于写入自定义内容
+     */
+    emptyRenderer?: (terminal: Terminal) => React.ReactNode;
+    /**
+     * 自定义错误时的内容渲染
+     * @param terminal xterm终端实例
+     * @param error 错误对象
+     * @param reconnect 重新连接函数
+     */
+    errorRenderer?: (terminal: Terminal, error: Error | Event, reconnect: () => void) => React.ReactNode;
+    /**
+     * 搜索框的配置
+     */
+    searchInputProps?: Partial<SearchInputProps>;
+}

package/dist/src/core/LogView/LogView.utils.d.ts

@@ -0,0 +1,23 @@
+import { Terminal } from "@xterm/xterm";
+import { EventSourceOptions } from "./LogView.types";
+export declare const ENCODED_NEWLINE = 10;
+export declare const ENCODED_CARRIAGE_RETURN = 13;
+export declare const SEARCH_BAR_HEIGHT = 45;
+/**
+ * Create an event source connection to stream logs
+ * @param url The URL to connect to
+ * @param options The options for the connection
+ * @param terminal Terminal instance to append logs to directly
+ * @returns Function to close/abort the connection
+ */
+export declare const eventsource: (url: string | URL, options: EventSourceOptions, terminal: Terminal) => () => void;
+type KeyboardAction = Pick<KeyboardEvent, "ctrlKey" | "shiftKey" | "key" | "metaKey">;
+export declare const customShortcutsForMac: KeyboardAction[];
+export declare const customShortcutsForWin: KeyboardAction[];
+export declare const isCustomKeyboardAction: (event: KeyboardEvent, actions: KeyboardAction[]) => boolean;
+export declare const isMacOS: () => boolean;
+export declare const scrollPages: (direction: "up" | "down", terminal: Terminal | null | undefined) => void;
+export declare const scrollLines: (direction: "up" | "down", terminal: Terminal | null | undefined) => void;
+export declare const selectAll: (terminal: Terminal | null | undefined) => void;
+export declare const copySelectLines: (terminal: Terminal | null | undefined) => void;
+export {};

package/dist/src/core/LogView/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./LogView";
+export * from "./LogView.types";

package/dist/src/core/Typo/index.d.ts

@@ -2,6 +2,7 @@ export declare const Typo: {
     readonly Display: {
         readonly d1_bold_title: import("@linaria/core").LinariaClassName;
         readonly d1s_bold_title: import("@linaria/core").LinariaClassName;
+        readonly d1s_regular_title: import("@linaria/core").LinariaClassName;
         readonly d1_regular_title: import("@linaria/core").LinariaClassName;
         readonly d2_bold_title: import("@linaria/core").LinariaClassName;
         readonly d2_regular_title: import("@linaria/core").LinariaClassName;
@@ -14,8 +15,8 @@ export declare const Typo: {
         readonly h2_bold_title: import("@linaria/core").LinariaClassName;
         readonly h2_regular_title: import("@linaria/core").LinariaClassName;
         readonly h3_bold_title: import("@linaria/core").LinariaClassName;
-        readonly h3_bold_upper: import("@linaria/core").LinariaClassName;
         readonly h3_regular_title: import("@linaria/core").LinariaClassName;
+        readonly h3_bold_upper: import("@linaria/core").LinariaClassName;
         readonly h3_regular_upper: import("@linaria/core").LinariaClassName;
     };
     readonly Label: {
@@ -26,6 +27,7 @@ export declare const Typo: {
         readonly l1_regular_title: import("@linaria/core").LinariaClassName;
         readonly l1_regular_upper: import("@linaria/core").LinariaClassName;
         readonly l2_bold: import("@linaria/core").LinariaClassName;
+        readonly l2_bold_strikethrough: import("@linaria/core").LinariaClassName;
         readonly l2_bold_title: import("@linaria/core").LinariaClassName;
         readonly l2_bold_upper: import("@linaria/core").LinariaClassName;
         readonly l2_regular: import("@linaria/core").LinariaClassName;
@@ -68,3 +70,51 @@ export declare const Typo: {
         readonly u1: import("@linaria/core").LinariaClassName;
     };
 };
+export declare const FIGMA_TO_TYPO: {
+    readonly "Display/display1-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Display/display1s-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Display/display1s-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Display/display1-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Display/display2-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Display/display2-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Display/display3-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Display/display3-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Heading/h1-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Heading/h1-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Heading/h2-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Heading/h2-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Heading/h3-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Heading/h3-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Heading/h3-bold-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Heading/h3-regular-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label1-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label1-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label1-regular-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label1-bold-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label2-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label2-medium-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label2-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label2-bold-strikethrough-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label2-regular-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label2-bold-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label3-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label3-semibold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label3-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label3-regular-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label3-bold-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label4-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label4-medium-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label4-bold-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label4-regular-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Label/label4-bold-uppercase-sc": import("@linaria/core").LinariaClassName;
+    readonly "Footnote/footnote1-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Footnote/footnote2-regular-sc": import("@linaria/core").LinariaClassName;
+    readonly "Tabular Num/tnum1-regular-monospace-sc": import("@linaria/core").LinariaClassName;
+    readonly "Tabular Num/tnum1-regular-slashed0-sc": import("@linaria/core").LinariaClassName;
+    readonly "Tabular Num/tnum2-regular-monospace-sc": import("@linaria/core").LinariaClassName;
+    readonly "Tabular Num/tnum2-medium-monospace-sc": import("@linaria/core").LinariaClassName;
+    readonly "Tabular Num/tnum2-regular-slashed0-sc": import("@linaria/core").LinariaClassName;
+    readonly "Tabular Num/tnum2-medium-slashed0-sc": import("@linaria/core").LinariaClassName;
+    readonly "Tabular Num/tnum16-bold-slashed0-sc": import("@linaria/core").LinariaClassName;
+};
+export type FigmaTypographyName = keyof typeof FIGMA_TO_TYPO;

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

@@ -54,6 +54,7 @@ export * from "./LineChart";
 export * from "./Link";
 export * from "./Loading";
 export * from "./LocalUpload";
+export * from "./LogView";
 export * from "./MediumDialog";
 export * from "./message";
 export * from "./message-group";

package/dist/stories/docs/core/LogView.stories.d.ts

@@ -0,0 +1,156 @@
+import type { LogViewProps } from "../../../src/core/LogView";
+import { StoryObj } from "@storybook/react";
+import React from "react";
+declare const meta: {
+    component: React.ComponentType<LogViewProps>;
+    title: "Core/LogView | 日志查看器";
+    parameters: {
+        docs: {
+            description: {
+                component: string;
+            };
+        };
+        controls: {
+            sort: string;
+        };
+    };
+    args: {
+        showSearch: true;
+        rows: number;
+        enableKeyboardShortcuts: true;
+    };
+    argTypes: {
+        content: {
+            control: boolean;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        showSearch: {
+            control: string;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        rows: {
+            control: string;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        scrollback: {
+            control: string;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        enableKeyboardShortcuts: {
+            control: string;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        searchHighlightLimit: {
+            control: string;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        emptyRenderer: {
+            control: boolean;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+            };
+        };
+        errorRenderer: {
+            control: boolean;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+            };
+        };
+        eventSource: {
+            control: boolean;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+                defaultValue: {
+                    summary: string;
+                };
+            };
+        };
+        eventSourceOptions: {
+            control: boolean;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+            };
+        };
+        searchInputProps: {
+            control: boolean;
+            description: string;
+            table: {
+                type: {
+                    summary: string;
+                };
+            };
+        };
+    };
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Basic: Story;
+export declare const HideSearch: Story;
+export declare const CustomRows: Story;
+export declare const LimitedScrollback: Story;
+export declare const DisableKeyboardShortcuts: Story;
+export declare const CustomEmptyRenderer: Story;
+export declare const CustomErrorRenderer: Story;
+export declare const LargeVolume100K: Story;
+export declare const RealtimeLogs: Story;
+export declare const RealtimeLargeVolume100K: Story;