Files
yaak/src-web/components/responseViewers/TextViewer.tsx
2025-11-23 08:38:13 -08:00

148 lines
4.3 KiB
TypeScript

import type { HttpResponse } from '@yaakapp-internal/models';
import classNames from 'classnames';
import type { ReactNode } from 'react';
import { useCallback, useMemo } from 'react';
import { createGlobalState } from 'react-use';
import { useDebouncedValue } from '../../hooks/useDebouncedValue';
import { useFormatText } from '../../hooks/useFormatText';
import { useResponseBodyText } from '../../hooks/useResponseBodyText';
import type { EditorProps } from '../core/Editor/Editor';
import { hyperlink } from '../core/Editor/hyperlink/extension';
import { Editor } from '../core/Editor/LazyEditor';
import { IconButton } from '../core/IconButton';
import { Input } from '../core/Input';
const extraExtensions = [hyperlink];
interface Props {
pretty: boolean;
className?: string;
text: string;
language: EditorProps['language'];
response: HttpResponse;
requestId: string;
}
const useFilterText = createGlobalState<Record<string, string | null>>({});
export function TextViewer({ language, text, response, requestId, pretty, className }: Props) {
const [filterTextMap, setFilterTextMap] = useFilterText();
const filterText = filterTextMap[requestId] ?? null;
const debouncedFilterText = useDebouncedValue(filterText);
const setFilterText = useCallback(
(v: string | null) => {
setFilterTextMap((m) => ({ ...m, [requestId]: v }));
},
[setFilterTextMap, requestId],
);
const isSearching = filterText != null;
const filteredResponse = useResponseBodyText({ response, filter: debouncedFilterText ?? null });
const toggleSearch = useCallback(() => {
if (isSearching) {
setFilterText(null);
} else {
setFilterText('');
}
}, [isSearching, setFilterText]);
const canFilter = language === 'json' || language === 'xml' || language === 'html';
const actions = useMemo<ReactNode[]>(() => {
const nodes: ReactNode[] = [];
if (!canFilter) return nodes;
if (isSearching) {
nodes.push(
<div key="input" className="w-full !opacity-100">
<Input
key={requestId}
validate={!filteredResponse.error}
hideLabel
autoFocus
containerClassName="bg-surface"
size="sm"
placeholder={language === 'json' ? 'JSONPath expression' : 'XPath expression'}
label="Filter expression"
name="filter"
defaultValue={filterText}
onKeyDown={(e) => e.key === 'Escape' && toggleSearch()}
onChange={setFilterText}
stateKey={`filter.${response.id}`}
/>
</div>,
);
}
nodes.push(
<IconButton
key="icon"
size="sm"
isLoading={filteredResponse.isPending}
icon={isSearching ? 'x' : 'filter'}
title={isSearching ? 'Close filter' : 'Filter response'}
onClick={toggleSearch}
className={classNames('border !border-border-subtle', isSearching && '!opacity-100')}
/>,
);
return nodes;
}, [
canFilter,
filterText,
filteredResponse.error,
filteredResponse.isPending,
isSearching,
language,
requestId,
response,
setFilterText,
toggleSearch,
]);
const formattedBody = useFormatText({ text, language, pretty });
if (formattedBody == null) {
return null;
}
let body: string;
if (isSearching && filterText?.length > 0) {
if (filteredResponse.error) {
body = '';
} else {
body = filteredResponse.data != null ? filteredResponse.data : '';
}
} else {
body = formattedBody;
}
// Decode unicode sequences in the text to readable characters
if (language === 'json' && pretty) {
body = decodeUnicodeLiterals(body);
body = body.replace(/\\\//g, '/'); // Hide unnecessary escaping of '/' by some older frameworks
}
return (
<Editor
readOnly
className={className}
defaultValue={body}
language={language}
actions={actions}
extraExtensions={extraExtensions}
// State key for storing fold state
stateKey={`response.body.${response.id}`}
/>
);
}
/** Convert \uXXXX to actual Unicode characters */
function decodeUnicodeLiterals(text: string): string {
return text.replace(/\\u([0-9a-fA-F]{4})/g, (_, hex) => {
const charCode = Number.parseInt(hex, 16);
return String.fromCharCode(charCode);
});
}