@mintlify/common 1.0.1138 → 1.0.1140

package/dist/search/highlight.test.js

@@ -0,0 +1,176 @@
+import { describe, expect, test } from 'vitest';
+import { getHighlightedSnippet, getHighlightedText, stripDuplicatedTitleLine, } from './highlight.js';
+const PRE = '<mark><b>';
+const POST = '</b></mark>';
+const ELLIPSIS = '…';
+describe('getHighlightedText', () => {
+    test('returns escaped text unchanged when query is empty', () => {
+        expect(getHighlightedText('Quickstart', '')).toBe('Quickstart');
+        expect(getHighlightedText('', 'foo')).toBe('');
+    });
+    test('returns escaped text unchanged when no match is found', () => {
+        expect(getHighlightedText('Quickstart', 'foobar')).toBe('Quickstart');
+    });
+    test('wraps a case-insensitive match in mark/b tags and preserves original casing', () => {
+        expect(getHighlightedText('Quickstart', 'quickstart')).toBe(`${PRE}Quickstart${POST}`);
+    });
+    test('highlights every occurrence of the query', () => {
+        expect(getHighlightedText('search and search again', 'search')).toBe(`${PRE}search${POST} and ${PRE}search${POST} again`);
+    });
+    test('escapes HTML in the surrounding text', () => {
+        expect(getHighlightedText('<script>quickstart</script>', 'quickstart')).toBe(`&lt;script&gt;${PRE}quickstart${POST}&lt;/script&gt;`);
+    });
+    test('highlights matches across a full chunk without truncating', () => {
+        const content = Array.from({ length: 200 }, (_, i) => (i === 100 ? 'target' : `w${i}`)).join(' ');
+        const result = getHighlightedText(content, 'target');
+        expect(result).toContain(`${PRE}target${POST}`);
+        expect(result).toContain('w0');
+        expect(result).toContain('w199');
+    });
+    test('highlights multi-word query terms', () => {
+        const content = 'Learn how to configure webhooks for your application and receive events';
+        const result = getHighlightedText(content, 'configure webhooks');
+        expect(result).toContain(`${PRE}configure webhooks${POST}`);
+    });
+    test('preserves original case in highlighted text', () => {
+        const content = 'The TypeScript SDK provides type safety';
+        const result = getHighlightedText(content, 'typescript sdk');
+        expect(result).toContain(`${PRE}TypeScript SDK${POST}`);
+    });
+    test('escapes HTML in non-highlighted content to prevent XSS', () => {
+        const content = 'Use <script>alert("xss")</script> to test the API endpoint';
+        const result = getHighlightedText(content, 'API');
+        expect(result).not.toContain('<script>');
+        expect(result).toContain('&lt;script&gt;');
+        expect(result).toContain(`${PRE}API${POST}`);
+    });
+    test('respects word boundaries when only padded variations match', () => {
+        const result = getHighlightedText('shellofoo and a stray foo here', 'foo bar');
+        expect(result).toContain(`stray ${PRE}foo${POST} here`);
+        expect(result).not.toContain(`shello${PRE}foo${POST}`);
+    });
+    test('highlights standalone words when a compound match also appears', () => {
+        const result = getHighlightedText('foo bar here, also foo standalone, and bar elsewhere', 'foo bar');
+        expect(result).toContain(`${PRE}foo bar${POST}`);
+        expect(result).toContain(`also ${PRE}foo${POST} standalone`);
+        expect(result).toContain(`and ${PRE}bar${POST} elsewhere`);
+    });
+    test('highlights an individual query word inside a short text segment', () => {
+        expect(getHighlightedText('Webhooks', 'configure webhooks')).toBe(`${PRE}Webhooks${POST}`);
+    });
+    test('highlights a word prefix when the query is a partial word', () => {
+        expect(getHighlightedText('Test the integration', 'tes')).toBe(`${PRE}Tes${POST}t the integration`);
+        expect(getHighlightedText('Testing your proxy setup', 'tes')).toBe(`${PRE}Tes${POST}ting your proxy setup`);
+    });
+    test('highlights the full word when the query matches it exactly', () => {
+        expect(getHighlightedText('Test the integration', 'test')).toBe(`${PRE}Test${POST} the integration`);
+    });
+    test('does not highlight a partial match in the middle of a word', () => {
+        expect(getHighlightedText('latest greatest', 'test')).toBe('latest greatest');
+    });
+    test('strips server-emitted <mark><b> highlight tags before re-highlighting', () => {
+        expect(getHighlightedText('<mark><b>Install</b></mark> the Mintlify CLI', 'install')).toBe(`${PRE}Install${POST} the Mintlify CLI`);
+    });
+    test('strips server highlight tags even when query has no match', () => {
+        expect(getHighlightedText('<mark><b>Install</b></mark> the CLI', 'foobar')).toBe('Install the CLI');
+    });
+    test('strips server highlight tags when query is empty', () => {
+        expect(getHighlightedText('<mark><b>Install</b></mark> the CLI', '')).toBe('Install the CLI');
+    });
+    test('completes within timeout for very long queries', () => {
+        const content = 'A '.repeat(1000) + 'needle ' + 'B '.repeat(1000);
+        const longQuery = Array.from({ length: 30 }, (_, i) => `word${i}`).join(' ');
+        const start = Date.now();
+        getHighlightedText(content, longQuery);
+        const elapsed = Date.now() - start;
+        expect(elapsed).toBeLessThan(500);
+    });
+});
+describe('getHighlightedSnippet', () => {
+    test('returns escaped text unchanged when query is empty', () => {
+        expect(getHighlightedSnippet('Quickstart', '')).toBe('Quickstart');
+        expect(getHighlightedSnippet('', 'foo')).toBe('');
+    });
+    test('returns escaped text unchanged when no match is found', () => {
+        expect(getHighlightedSnippet('Quickstart guide', 'foobar')).toBe('Quickstart guide');
+    });
+    test('does not window when the match is near the start', () => {
+        expect(getHighlightedSnippet('Quickstart guide for the API', 'quickstart')).toBe(`${PRE}Quickstart${POST} guide for the API`);
+    });
+    test('windows around a match buried deep in the content', () => {
+        const boilerplate = 'REST Endpoint POST /v1/resources Summary Creates a resource Description This endpoint ';
+        const content = `${boilerplate}accepts a customerEmail field in the request body`;
+        const result = getHighlightedSnippet(content, 'customerEmail');
+        expect(result.startsWith(`${ELLIPSIS} `)).toBe(true);
+        expect(result).toContain(`${PRE}customerEmail${POST}`);
+        // Leading boilerplate is windowed out of the snippet.
+        expect(result).not.toContain('REST Endpoint POST');
+    });
+    test('keeps preceding context before the match within the leading window', () => {
+        const content = 'word '.repeat(40) + 'before target needle after';
+        const result = getHighlightedSnippet(content, 'needle');
+        expect(result).toContain(`${PRE}needle${POST}`);
+        expect(result).toContain('target');
+    });
+    test('adds a trailing ellipsis when content is windowed at both ends', () => {
+        const lead = 'lorem ipsum dolor sit amet '.repeat(5);
+        const tail = ' consectetur adipiscing elit sed do eiusmod tempor incididunt'.repeat(10);
+        const content = `${lead}MATCHWORD${tail}`;
+        const result = getHighlightedSnippet(content, 'matchword');
+        expect(result.startsWith(`${ELLIPSIS} `)).toBe(true);
+        expect(result.endsWith(` ${ELLIPSIS}`)).toBe(true);
+        expect(result).toContain(`${PRE}MATCHWORD${POST}`);
+    });
+    test('does not add a trailing ellipsis when the match is at the very end', () => {
+        const content = 'word '.repeat(40) + 'finalToken';
+        const result = getHighlightedSnippet(content, 'finalToken');
+        expect(result.startsWith(`${ELLIPSIS} `)).toBe(true);
+        expect(result.endsWith(`${PRE}finalToken${POST}`)).toBe(true);
+    });
+    test('escapes HTML in the windowed snippet', () => {
+        const content = 'intro text '.repeat(10) + '<script>danger</script> targetField value';
+        const result = getHighlightedSnippet(content, 'targetField');
+        expect(result).not.toContain('<script>');
+        expect(result).toContain('&lt;script&gt;');
+        expect(result).toContain(`${PRE}targetField${POST}`);
+    });
+    test('caps output length even when the match is near the start', () => {
+        const content = 'match ' + 'word '.repeat(400);
+        const result = getHighlightedSnippet(content, 'match', { maxLength: 40 });
+        expect(result.startsWith(`${PRE}match${POST}`)).toBe(true);
+        expect(result.endsWith(` ${ELLIPSIS}`)).toBe(true);
+        // No leading ellipsis since the window starts at the beginning.
+        expect(result.startsWith(`${ELLIPSIS}`)).toBe(false);
+        // Bounded output rather than the full ~2k-char chunk.
+        expect(result.length).toBeLessThan(120);
+    });
+    test('respects a custom leading context', () => {
+        const content = 'aaaa bbbb cccc dddd eeee ffff gggg needle tail';
+        const result = getHighlightedSnippet(content, 'needle', { leadingContext: 5 });
+        expect(result.startsWith(`${ELLIPSIS} `)).toBe(true);
+        expect(result).toContain(`${PRE}needle${POST}`);
+        expect(result).not.toContain('aaaa');
+    });
+    test('caps the leading window when there is no query or no match', () => {
+        const content = 'word '.repeat(100).trim();
+        const noQuery = getHighlightedSnippet(content, '', { maxLength: 40 });
+        const noMatch = getHighlightedSnippet(content, 'zzz', { maxLength: 40 });
+        for (const result of [noQuery, noMatch]) {
+            expect(result.endsWith(` ${ELLIPSIS}`)).toBe(true);
+            expect(result.length).toBeLessThan(60);
+            expect(result).not.toContain(PRE);
+        }
+        expect(getHighlightedSnippet('short text', 'zzz', { maxLength: 40 })).toBe('short text');
+    });
+});
+describe('stripDuplicatedTitleLine', () => {
+    test('drops a first line that repeats the header', () => {
+        expect(stripDuplicatedTitleLine('Install\nRun npm install', 'Install')).toBe('Run npm install');
+        expect(stripDuplicatedTitleLine('<mark>Install</mark>\nRun it', 'Install')).toBe('Run it');
+    });
+    test('leaves content alone otherwise', () => {
+        expect(stripDuplicatedTitleLine('Overview\nRun it', 'Install')).toBe('Overview\nRun it');
+        expect(stripDuplicatedTitleLine('Install', 'Install')).toBe('Install');
+        expect(stripDuplicatedTitleLine('Install\nRun it', '')).toBe('Install\nRun it');
+    });
+});

package/dist/search/index.d.ts

@@ -0,0 +1 @@
+export * from './highlight.js';

package/dist/search/index.js

@@ -0,0 +1 @@
+export * from './highlight.js';