@deepcitation/deepcitation-js 1.1.27 → 1.1.29

package/lib/react/useSmartDiff.js

@@ -1,64 +0,0 @@
-import { diffLines, diffWordsWithSpace } from "../utils/diff.js";
-import { useMemo } from "react";
-export const useSmartDiff = (expected = "", actual = "") => {
-    return useMemo(() => {
-        // 1. Sanitize standard noise (CRLF, trailing spaces)
-        const cleanExpected = (expected || "").trim().replace(/\r\n/g, "\n");
-        const cleanActual = (actual || "").trim().replace(/\r\n/g, "\n");
-        // 2. First Pass: Diff by LINES.
-        // This isolates the "extra line" issue. The extra line becomes one "added" chunk,
-        // and it prevents the tokenizer from getting confused on the rest of the text.
-        const lineDiffs = diffLines(cleanExpected, cleanActual);
-        // 3. Second Pass: Process the line results to find "Modifications"
-        const processedDiffs = [];
-        let hasDiff = false;
-        let totalChange = 0;
-        for (let i = 0; i < lineDiffs.length; i++) {
-            const part = lineDiffs[i];
-            const nextPart = lineDiffs[i + 1];
-            // CHECK FOR MODIFICATION:
-            // If we see a "Removed" block immediately followed by an "Added" block,
-            // it means this specific line changed. We should DIFF WORDS inside this line.
-            if (part.removed && nextPart && nextPart.added) {
-                // Run word diff ONLY on this pair of lines
-                const wordDiffs = diffWordsWithSpace(part.value, nextPart.value);
-                processedDiffs.push({
-                    type: "modified",
-                    parts: wordDiffs,
-                });
-                hasDiff = true;
-                // Calculate raw change amount for variance score
-                totalChange += Math.abs(part.value.length - nextPart.value.length);
-                i++; // Skip the next part since we merged it into this block
-            }
-            // CHECK FOR PURE ADDITION/DELETION (The "Extra Line" Scenario)
-            else if (part.added || part.removed) {
-                processedDiffs.push({
-                    type: part.added ? "added" : "removed",
-                    parts: [{ value: part.value, added: part.added, removed: part.removed }],
-                });
-                hasDiff = true;
-                totalChange += part.value.length;
-            }
-            // UNCHANGED BLOCKS
-            else {
-                processedDiffs.push({
-                    type: "unchanged",
-                    parts: [{ value: part.value }],
-                });
-            }
-        }
-        // 4. Calculate a similarity score to decide UI defaults
-        // 1.0 = Perfect match, 0.0 = Totally different
-        const maxLength = Math.max(cleanExpected.length, cleanActual.length);
-        const similarity = maxLength === 0 ? 1 : 1 - totalChange / maxLength;
-        return {
-            diffResult: processedDiffs,
-            hasDiff,
-            similarity,
-            // If similarity is too low (< 60%), the Diff view is likely "Fruit Salad" (messy).
-            // We can use this boolean to default the UI to the "Source" tab.
-            isHighVariance: similarity < 0.6,
-        };
-    }, [expected, actual]);
-};

package/lib/react/utils.js

@@ -1,88 +0,0 @@
-import { sha1Hash } from "../utils/sha.js";
-import { getCitationPageNumber } from "../parsing/normalizeCitation.js";
-// =============================================================================
-// UTILITY FUNCTIONS
-// =============================================================================
-export function cn(...classes) {
-    return classes.filter(Boolean).join(" ");
-}
-/**
- * Generates a unique, deterministic key for a citation based on its content.
- *  @param citation - The citation to generate a key for
- * @returns A unique, deterministic key for the citation
- */
-export function generateCitationKey(citation) {
-    const pageNumber = citation.pageNumber || getCitationPageNumber(citation.startPageKey);
-    const keyParts = [
-        citation.attachmentId || "",
-        pageNumber?.toString() || "",
-        citation.fullPhrase || "",
-        citation.keySpan?.toString() || "",
-        citation.lineIds?.join(",") || "",
-        citation.timestamps?.startTime || "",
-        citation.timestamps?.endTime || "",
-    ];
-    return sha1Hash(keyParts.join("|")).slice(0, 16);
-}
-/**
- * Generates a unique, deterministic key for a verification based on its content.
- * @param verification - The verification to generate a key for
- * @returns
- */
-export function generateVerificationKey(verification) {
-    const keyParts = [
-        verification.attachmentId || "",
-        verification.label || "",
-        verification.verifiedFullPhrase || "",
-        verification.verifiedKeySpan || "",
-        verification.verifiedLineIds?.join(",") || "",
-        verification.verifiedPageNumber?.toString() || "",
-        verification.verifiedTimestamps?.startTime || "",
-        verification.verifiedTimestamps?.endTime || "",
-        verification.verifiedMatchSnippet || "",
-        verification.hitIndexWithinPage?.toString() || "",
-    ];
-    return sha1Hash(keyParts.join("|")).slice(0, 16);
-}
-/**
- * Generates a unique instance ID for a citation component render.
- * Combines the citation key with a random suffix for uniqueness.
- */
-export function generateCitationInstanceId(citationKey) {
-    const randomSuffix = Math.random().toString(36).slice(2, 11);
-    return `${citationKey}-${randomSuffix}`;
-}
-/**
- * Gets the display text for a citation (keySpan with fallback to number).
- */
-export function getCitationDisplayText(citation, options = {}) {
-    const { fallbackDisplay } = options;
-    return (citation.keySpan?.toString() ||
-        citation.citationNumber?.toString() ||
-        fallbackDisplay ||
-        "1");
-}
-/**
- * Gets the citation number as a string.
- */
-export function getCitationNumber(citation) {
-    return citation.citationNumber?.toString() || "1";
-}
-/**
- * Gets the keySpan text from a citation.
- */
-export function getCitationKeySpanText(citation) {
-    return citation.keySpan?.toString() || "";
-}
-/**
- * Joins class names, filtering out falsy values.
- * This is a minimal implementation for the base component.
- */
-export function classNames(...classes) {
-    return classes.filter(Boolean).join(" ");
-}
-/**
- * Default padding values for citation styling.
- */
-export const CITATION_X_PADDING = 4;
-export const CITATION_Y_PADDING = 1;

package/lib/types/boxes.d.ts

@@ -1,11 +0,0 @@
-export interface PdfSpaceItem extends ScreenBox {
-    text?: string;
-}
-export type IVertex = {
-    x: number;
-    y: number;
-};
-export interface ScreenBox extends IVertex {
-    width: number;
-    height: number;
-}

package/lib/types/boxes.js

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

package/lib/types/citation.d.ts

@@ -1,39 +0,0 @@
-import { type ScreenBox } from "./boxes.js";
-import { type Verification } from "./verification.js";
-export type OutputImageFormat = "jpeg" | "png" | "avif" | undefined | null;
-export declare const DEFAULT_OUTPUT_IMAGE_FORMAT: "avif";
-export interface VerifyCitationResponse {
-    verifications: {
-        [key: string]: Verification;
-    };
-}
-export interface VerifyCitationRequest {
-    attachmentId: string;
-    citations: {
-        [key: string]: Citation;
-    };
-    outputImageFormat?: OutputImageFormat;
-    apiKey?: string;
-}
-export interface Citation {
-    attachmentId?: string;
-    fullPhrase?: string | null;
-    keySpan?: string | null;
-    startPageKey?: string | null;
-    lineIds?: number[] | null;
-    reasoning?: string | null;
-    selection?: ScreenBox | null;
-    citationNumber?: number;
-    pageNumber?: number | null;
-    timestamps?: {
-        endTime?: string;
-        startTime?: string;
-    };
-    beforeCite?: string;
-}
-export interface CitationStatus {
-    isVerified: boolean;
-    isMiss: boolean;
-    isPartialMatch: boolean;
-    isPending: boolean;
-}

package/lib/types/citation.js

@@ -1 +0,0 @@
-export const DEFAULT_OUTPUT_IMAGE_FORMAT = "avif";

package/lib/types/search.d.ts

@@ -1,19 +0,0 @@
-export type SearchStatus = "loading" | "pending" | "not_found" | "partial_text_found" | "found" | "found_key_span_only" | "found_phrase_missed_value" | "found_on_other_page" | "found_on_other_line" | "first_word_found" | "timestamp_wip";
-export type SearchMethod = "exact_line_match" | "line_with_buffer" | "current_page" | "keyspan_fallback" | "adjacent_pages" | "expanded_window" | "regex_search" | "bm25_search" | "fuzzy_regex" | "first_word_fallback";
-export interface SearchAttempt {
-    method: SearchMethod;
-    success: boolean;
-    searchPhrases: string[];
-    pageSearched?: number;
-    matchedPhrases?: string[];
-    matchedVariation?: string;
-    phraseVariations?: string[];
-    matchQuality?: string;
-    isPartialMatch?: boolean;
-    matchScore?: number;
-    matchSnippet?: string;
-    notes?: string;
-    startTime?: number;
-    endTime?: number;
-    durationMs?: number;
-}

package/lib/types/search.js

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

package/lib/types/verification.d.ts

@@ -1,27 +0,0 @@
-import { type Citation } from "./citation.js";
-import { type SearchStatus, type SearchAttempt } from "./search.js";
-import { type PdfSpaceItem } from "./boxes.js";
-export declare const NOT_FOUND_VERIFICATION_INDEX = -1;
-export declare const PENDING_VERIFICATION_INDEX = -2;
-export declare const BLANK_VERIFICATION: Verification;
-export interface Verification {
-    attachmentId?: string | null;
-    label?: string | null;
-    citation?: Citation;
-    status?: SearchStatus | null;
-    searchAttempts?: SearchAttempt[];
-    highlightColor?: string | null;
-    verifiedPageNumber?: number | null;
-    verifiedLineIds?: number[] | null;
-    verifiedTimestamps?: {
-        startTime?: string;
-        endTime?: string;
-    } | null;
-    verifiedFullPhrase?: string | null;
-    verifiedKeySpan?: string | null;
-    verifiedMatchSnippet?: string | null;
-    hitIndexWithinPage?: number | null;
-    pdfSpaceItem?: PdfSpaceItem;
-    verificationImageBase64?: string | null;
-    verifiedAt?: Date;
-}

package/lib/types/verification.js

@@ -1,11 +0,0 @@
-export const NOT_FOUND_VERIFICATION_INDEX = -1;
-export const PENDING_VERIFICATION_INDEX = -2;
-export const BLANK_VERIFICATION = {
-    attachmentId: null,
-    verifiedPageNumber: NOT_FOUND_VERIFICATION_INDEX,
-    verifiedMatchSnippet: null,
-    citation: {
-        pageNumber: NOT_FOUND_VERIFICATION_INDEX,
-    },
-    status: "not_found",
-};

package/lib/utils/diff.d.ts

@@ -1,60 +0,0 @@
-/**
- * Custom diff implementation to replace the 'diff' npm package.
- * This avoids dependency issues in Firebase Functions environments.
- *
- * Implements a Myers diff algorithm with optimizations inspired by jsdiff.
- * @see https://github.com/kpdecker/jsdiff
- *
- * ---
- *
- * BSD 3-Clause License
- *
- * Copyright (c) 2009-2015, Kevin Decker <kpdecker@gmail.com>
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice, this
- *    list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- *    this list of conditions and the following disclaimer in the documentation
- *    and/or other materials provided with the distribution.
- *
- * 3. Neither the name of the copyright holder nor the names of its
- *    contributors may be used to endorse or promote products derived from
- *    this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-export interface Change {
-    value: string;
-    added?: boolean;
-    removed?: boolean;
-    count?: number;
-}
-/**
- * Compare two strings line by line.
- * Similar to Diff.diffLines from the 'diff' package.
- */
-export declare function diffLines(oldStr: string, newStr: string): Change[];
-/**
- * Compare two strings word by word, preserving whitespace.
- * Similar to Diff.diffWordsWithSpace from the 'diff' package.
- *
- * Features matching jsdiff:
- * - Extended Unicode word character support
- * - Proper tokenization (words, whitespace runs, single punctuation)
- * - Whitespace deduplication in consecutive changes
- */
-export declare function diffWordsWithSpace(oldStr: string, newStr: string): Change[];