@vectara/vectara-ui 0.0.2

package/lib/utils/citations/applyCitationOrder.d.ts

@@ -0,0 +1 @@
+export declare const applyCitationOrder: (searchResults: any[], unorderedSummary: string) => any[];

package/lib/utils/citations/applyCitationOrder.js

@@ -0,0 +1,19 @@
+export const applyCitationOrder = (searchResults, unorderedSummary) => {
+    const orderedSearchResults = [];
+    const citations = unorderedSummary.match(/\[\d+\]/g) || [];
+    const addedCitations = new Set();
+    for (let i = 0; i < citations.length; i++) {
+        const citation = citations[i];
+        // Ignore citations that have already been added.
+        if (addedCitations.has(citation))
+            continue;
+        // Extract index from [INDEX] format.
+        const citationIndex = Number(citation.slice(1, citation.length - 1)) - 1;
+        // Ignore citations that are out of range of the search results.
+        if (citationIndex < 0 || citationIndex >= searchResults.length)
+            continue;
+        orderedSearchResults.push(searchResults[citationIndex]);
+        addedCitations.add(citation);
+    }
+    return orderedSearchResults;
+};

package/lib/utils/citations/applyCitationOrder.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/citations/applyCitationOrder.test.js

@@ -0,0 +1,65 @@
+import { applyCitationOrder } from "./applyCitationOrder";
+const searchResult1 = {
+    id: "id1",
+    snippet: {
+        pre: "pre",
+        text: "text",
+        post: "post"
+    },
+    source: "source1",
+    url: "url1",
+    title: "title1",
+    metadata: {
+        key: "value"
+    }
+};
+const searchResult2 = {
+    id: "id2",
+    snippet: {
+        pre: "pre",
+        text: "text",
+        post: "post"
+    },
+    source: "source2",
+    url: "url2",
+    title: "title2",
+    metadata: {
+        key: "value"
+    }
+};
+const searchResult3 = {
+    id: "id3",
+    snippet: {
+        pre: "pre",
+        text: "text",
+        post: "post"
+    },
+    source: "source3",
+    url: "url3",
+    title: "title3",
+    metadata: {
+        key: "value"
+    }
+};
+const searchResult4 = {
+    id: "id4",
+    snippet: {
+        pre: "pre",
+        text: "text",
+        post: "post"
+    },
+    source: "source4",
+    url: "url4",
+    title: "title4",
+    metadata: {
+        key: "value"
+    }
+};
+describe("applyCitationOrder", () => {
+    test("reorders search results to match the order of the citations in the summary", () => {
+        expect(applyCitationOrder([searchResult1, searchResult2, searchResult3, searchResult4], "summary [4] some words [1][3] and stuff at the end")).toEqual([searchResult4, searchResult1, searchResult3]);
+    });
+    test("ignores citations that are out of range of search results", () => {
+        expect(applyCitationOrder([searchResult1, searchResult2, searchResult3, searchResult4], "summary [5] some words [1][3] and stuff at the end")).toEqual([searchResult1, searchResult3]);
+    });
+});

package/lib/utils/citations/extractCitations.d.ts

@@ -0,0 +1,4 @@
+export declare const extractCitations: (summary: string) => {
+    text: string;
+    references?: string[] | undefined;
+}[];

package/lib/utils/citations/extractCitations.js

@@ -0,0 +1,26 @@
+export const extractCitations = (summary) => {
+    // Match citations.
+    const regex = /\[(\d+(,*\s*\d*)*)\]/g;
+    const citations = [];
+    let match;
+    let lastIndex = 0;
+    // Parse all cited content.
+    while ((match = regex.exec(summary)) !== null) {
+        const index = match.index;
+        const reference = match[1];
+        const text = summary.slice(lastIndex, index);
+        // Handle citations that are in the form of [1, 2, 3] or [1,2,3]
+        // so normalize to the latter.
+        citations.push({
+            text,
+            references: reference.replace(/\s/g, "").split(",")
+        });
+        lastIndex = index + match[0].length;
+    }
+    // Add the remaining content after the last citation.
+    const text = summary.slice(lastIndex);
+    if (text.length > 0) {
+        citations.push({ text });
+    }
+    return citations;
+};

package/lib/utils/citations/extractCitations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/citations/extractCitations.test.js

@@ -0,0 +1,40 @@
+import { extractCitations } from "./extractCitations";
+describe("extractCitations", () => {
+    test("extracts single citations", () => {
+        const summary = "[1] Beginning of summary. [2][3] Multiple at beginning of sentence, and before comma [4], single at middle [5] of sentence. At end of sentence [6].";
+        expect(extractCitations(summary)).toEqual([
+            { text: "", references: ["1"] },
+            { text: " Beginning of summary. ", references: ["2"] },
+            { text: "", references: ["3"] },
+            {
+                text: " Multiple at beginning of sentence, and before comma ",
+                references: ["4"]
+            },
+            { text: ", single at middle ", references: ["5"] },
+            {
+                text: " of sentence. At end of sentence ",
+                references: ["6"]
+            },
+            { text: "." }
+        ]);
+    });
+    test("extracts citation at the end of the summary", () => {
+        const summary = "End of summary. [1]";
+        expect(extractCitations(summary)).toEqual([{ text: "End of summary. ", references: ["1"] }]);
+    });
+    test("extracts multiple comma-delimited citations", () => {
+        const summary = "Two citations [1, 2] and seven citations [1, 2, 3, 4, 5, 6, 7] and without spaces [1,2,3].";
+        expect(extractCitations(summary)).toEqual([
+            { text: "Two citations ", references: ["1", "2"] },
+            {
+                text: " and seven citations ",
+                references: ["1", "2", "3", "4", "5", "6", "7"]
+            },
+            {
+                text: " and without spaces ",
+                references: ["1", "2", "3"]
+            },
+            { text: "." }
+        ]);
+    });
+});

package/lib/utils/citations/index.d.ts

@@ -0,0 +1,5 @@
+export { applyCitationOrder } from "./applyCitationOrder";
+export { extractCitations } from "./extractCitations";
+export { reorderCitations } from "./reorderCitations";
+export { sanitizeCitations } from "./sanitizeCitations";
+export { removeCitations } from "./removeCitations";

package/lib/utils/citations/index.js

@@ -0,0 +1,5 @@
+export { applyCitationOrder } from "./applyCitationOrder";
+export { extractCitations } from "./extractCitations";
+export { reorderCitations } from "./reorderCitations";
+export { sanitizeCitations } from "./sanitizeCitations";
+export { removeCitations } from "./removeCitations";

package/lib/utils/citations/removeCitations.d.ts

@@ -0,0 +1 @@
+export declare const removeCitations: (text: string) => string;

package/lib/utils/citations/removeCitations.js

@@ -0,0 +1,2 @@
+const regex = /(^\[(\d+(,*\s*\d*)*)\] ?)|( ?\[(\d+(,*\s*\d*)*)\])/g;
+export const removeCitations = (text) => text.replace(regex, "");

package/lib/utils/citations/removeCitations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/citations/removeCitations.test.js

@@ -0,0 +1,11 @@
+import { removeCitations } from "./removeCitations";
+describe("removeCitations", () => {
+    test("removes single citations", () => {
+        const summary = "[1] Beginning of summary. [2][3] Multiple at beginning[2] of sentence, and before comma [4], single at middle [5] of sentence. At end of sentence [6].";
+        expect(removeCitations(summary)).toEqual("Beginning of summary. Multiple at beginning of sentence, and before comma, single at middle of sentence. At end of sentence.");
+    });
+    test("removes multiple comma-delimited citations", () => {
+        const summary = "Two citations [1, 2] and seven citations[1, 2, 3, 4, 5, 6, 7] and without spaces [1,2,3].";
+        expect(removeCitations(summary)).toEqual("Two citations and seven citations and without spaces.");
+    });
+});

package/lib/utils/citations/reorderCitations.d.ts

@@ -0,0 +1 @@
+export declare const reorderCitations: (unorderedSummary: string) => string;

package/lib/utils/citations/reorderCitations.js

@@ -0,0 +1,9 @@
+export const reorderCitations = (unorderedSummary) => {
+    const allCitations = unorderedSummary.match(/\[\d+\]/g) || [];
+    const uniqueCitations = [...new Set(allCitations)];
+    const citationToReplacement = {};
+    uniqueCitations.forEach((citation, index) => {
+        citationToReplacement[citation] = `[${index + 1}]`;
+    });
+    return unorderedSummary.replace(/\[\d+\]/g, (match) => citationToReplacement[match]);
+};

package/lib/utils/citations/reorderCitations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/citations/reorderCitations.test.js

@@ -0,0 +1,6 @@
+import { reorderCitations } from "./reorderCitations";
+describe("reorderCitations", () => {
+    test("reorders citations in a summary", () => {
+        expect(reorderCitations("summary [4] some words [1][3] and stuff at the end")).toEqual("summary [1] some words [2][3] and stuff at the end");
+    });
+});

package/lib/utils/citations/sanitizeCitations.d.ts

@@ -0,0 +1 @@
+export declare const sanitizeCitations: (summary?: string) => string | undefined;

package/lib/utils/citations/sanitizeCitations.js

@@ -0,0 +1,30 @@
+export const sanitizeCitations = (summary) => {
+    if (!summary)
+        return summary;
+    // Match citations.
+    const regex = /\[(\d+(,*\s*\d*)*)\]/g;
+    const parts = [];
+    let match;
+    let lastIndex = 0;
+    // Parse all cited content.
+    while ((match = regex.exec(summary)) !== null) {
+        const index = match.index;
+        const reference = match[1];
+        const text = summary.slice(lastIndex, index);
+        // Handle citations that are in the form of [1, 2, 3] or [1,2,3]
+        // so normalize to the latter.
+        parts.push(text);
+        parts.push(reference
+            .replace(/\s/g, "")
+            .split(",")
+            .map((citation) => `[${citation}]`)
+            .join(""));
+        lastIndex = index + match[0].length;
+    }
+    // Add the remaining content after the last citation.
+    const text = summary.slice(lastIndex);
+    if (text.length > 0) {
+        parts.push(text);
+    }
+    return parts.join("");
+};

package/lib/utils/citations/sanitizeCitations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/citations/sanitizeCitations.test.js

@@ -0,0 +1,11 @@
+import { sanitizeCitations } from "./sanitizeCitations";
+describe("sanitizeCitations", () => {
+    test("ignores single citations", () => {
+        const summary = "[1] Beginning of summary. [2][3] Multiple at beginning of sentence, and before comma [4], single at middle [5] of sentence. At end of sentence [6].";
+        expect(sanitizeCitations(summary)).toEqual(summary);
+    });
+    test("sanitize multiple comma-delimited citations", () => {
+        const summary = "Two citations [1, 2] and seven citations [1, 2, 3, 4, 5, 6, 7] and without spaces [1,2,3].";
+        expect(sanitizeCitations(summary)).toEqual("Two citations [1][2] and seven citations [1][2][3][4][5][6][7] and without spaces [1][2][3].");
+    });
+});

package/lib/utils/createId.d.ts

@@ -0,0 +1 @@
+export declare const createId: () => string;

package/lib/utils/createId.js

@@ -0,0 +1,10 @@
+let id = 0;
+export const createId = () => {
+    if (id === Number.MAX_SAFE_INTEGER) {
+        id = 0;
+    }
+    else {
+        id++;
+    }
+    return id.toString();
+};

package/lib/utils/getTrackingProps.d.ts

@@ -0,0 +1,7 @@
+export declare const getTrackingProps: (track?: boolean) => {
+    rel: string;
+    referrerPolicy: string;
+} | {
+    rel: string;
+    referrerPolicy?: undefined;
+};

package/lib/utils/getTrackingProps.js

@@ -0,0 +1,18 @@
+export const getTrackingProps = (track) => {
+    if (track) {
+        return {
+            // Protect against tabnabbing.
+            rel: "noopener",
+            // Provide information for tracking, e.g. to docs. Technically this should be
+            // 'referrerpolicy' but React wants it in camel case. This clashes with
+            // react-router Link's HTMLAttributeReferrerPolicy type definition so we
+            // have to use @ts-expect-error at callsites that consume this helper.
+            referrerPolicy: "no-referrer-when-downgrade"
+        };
+    }
+    // Protect against tabnabbing and strip information from the referrer header.
+    return {
+        rel: "noopener"
+        // Default referrer policy is set by a meta tag in index.html.
+    };
+};

package/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export { truncateStart, truncateEnd } from "./truncateString";

package/lib/utils/index.js

@@ -0,0 +1 @@
+export { truncateStart, truncateEnd } from "./truncateString";

package/lib/utils/truncateString.d.ts

@@ -0,0 +1,2 @@
+export declare const truncateStart: (source: string, maxLength: number) => string;
+export declare const truncateEnd: (source: string, maxLength: number) => string;

package/lib/utils/truncateString.js

@@ -0,0 +1,20 @@
+export const truncateStart = (source, maxLength) => {
+    if (source.length < maxLength || maxLength <= 0)
+        return source;
+    const truncatedSource = source.substring(source.length - maxLength, source.length).trim();
+    if (truncatedSource.length)
+        return `…${truncatedSource}`;
+    return truncatedSource;
+};
+export const truncateEnd = (source, maxLength) => {
+    if (source.length < maxLength || maxLength <= 0)
+        return source;
+    const truncatedSource = source.substring(0, maxLength).trim();
+    if (truncatedSource.length) {
+        if ([".", "?", "!"].includes(truncatedSource[truncatedSource.length - 1])) {
+            return `${truncatedSource} …`;
+        }
+        return `${truncatedSource}…`;
+    }
+    return truncatedSource;
+};

package/lib/utils/truncateString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/utils/truncateString.test.js

@@ -0,0 +1,59 @@
+import { truncateStart, truncateEnd } from "./truncateString";
+describe("truncateStart", () => {
+    it("returns a truncated source up to the maxLength", () => {
+        const source = "12345678";
+        expect(truncateStart(source, 5)).toBe("…45678");
+    });
+    it("preserves the original source if maxLength exceeds its length", () => {
+        const source = "12345678";
+        expect(truncateStart(source, 10)).toBe(source);
+    });
+    it("trims whitespace", () => {
+        const source = "1234 5678";
+        expect(truncateStart(source, 5)).toBe("…5678");
+    });
+    it("ignores zero maxLength", () => {
+        const source = "12345678";
+        expect(truncateStart(source, 0)).toBe(source);
+    });
+    it("ignores negative maxLength", () => {
+        const source = "12345678";
+        expect(truncateStart(source, -1)).toBe(source);
+    });
+});
+describe("truncateEnd", () => {
+    it("trims the maxLength number of characters from the start of the source", () => {
+        const source = "12345678";
+        expect(truncateEnd(source, 5)).toBe("12345…");
+    });
+    it("returns a truncated source up to the maxLength", () => {
+        const source = "12345678";
+        expect(truncateEnd(source, 10)).toBe(source);
+    });
+    it("trims whitespace", () => {
+        const source = "1234 5678";
+        expect(truncateEnd(source, 5)).toBe("1234…");
+    });
+    it("ignores zero maxLength", () => {
+        const source = "12345678";
+        expect(truncateEnd(source, 0)).toBe(source);
+    });
+    it("ignores negative maxLength", () => {
+        const source = "12345678";
+        expect(truncateEnd(source, -1)).toBe(source);
+    });
+    describe("inserts a space between the ellipsis and the truncated source when it ends", () => {
+        it("with a period", () => {
+            const source = "the. word";
+            expect(truncateEnd(source, 4)).toBe("the. …");
+        });
+        it("with a question mark", () => {
+            const source = "the? word";
+            expect(truncateEnd(source, 4)).toBe("the? …");
+        });
+        it("with an exclamation point", () => {
+            const source = "the! word";
+            expect(truncateEnd(source, 4)).toBe("the! …");
+        });
+    });
+});