@deepcitation/deepcitation-js 1.1.22 → 1.1.24

package/lib/react/CitationVariants.d.ts

@@ -1,7 +1,6 @@
 import React, { type ReactNode } from "react";
 import type { CitationStatus } from "../types/citation.js";
 import type { Verification } from "../types/verification.js";
-import type { SearchState } from "../types/search.js";
 import type { BaseCitationProps, CitationVariant as CitationVariantType, CitationEventHandlers } from "./types.js";
 /**
  * Shared props for all citation variant components.
@@ -9,8 +8,6 @@ import type { BaseCitationProps, CitationVariant as CitationVariantType, Citatio
 export interface CitationVariantProps extends BaseCitationProps {
     /** Found citation highlight location data */
     verification?: Verification | null;
-    /** Current search state for the citation */
-    searchState?: SearchState | null;
     /** Event handlers */
     eventHandlers?: CitationEventHandlers;
     /** Whether on mobile device */

package/lib/react/Popover.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Popover component built on Radix UI primitives.
+ * This is a shadcn-style component - copy/paste friendly.
+ *
+ * @see https://ui.shadcn.com/docs/components/popover
+ * @see https://www.radix-ui.com/primitives/docs/components/popover
+ */
+import * as React from "react";
+import * as PopoverPrimitive from "@radix-ui/react-popover";
+declare const Popover: React.FC<PopoverPrimitive.PopoverProps>;
+declare const PopoverTrigger: React.ForwardRefExoticComponent<PopoverPrimitive.PopoverTriggerProps & React.RefAttributes<HTMLButtonElement>>;
+declare const PopoverAnchor: React.ForwardRefExoticComponent<PopoverPrimitive.PopoverAnchorProps & React.RefAttributes<HTMLDivElement>>;
+declare const PopoverPortal: React.FC<PopoverPrimitive.PopoverPortalProps>;
+declare const PopoverContent: React.ForwardRefExoticComponent<Omit<PopoverPrimitive.PopoverContentProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
+export { Popover, PopoverTrigger, PopoverContent, PopoverAnchor, PopoverPortal };

package/lib/react/Popover.js

@@ -0,0 +1,20 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * Popover component built on Radix UI primitives.
+ * This is a shadcn-style component - copy/paste friendly.
+ *
+ * @see https://ui.shadcn.com/docs/components/popover
+ * @see https://www.radix-ui.com/primitives/docs/components/popover
+ */
+import * as React from "react";
+import * as PopoverPrimitive from "@radix-ui/react-popover";
+function cn(...classes) {
+    return classes.filter(Boolean).join(" ");
+}
+const Popover = PopoverPrimitive.Root;
+const PopoverTrigger = PopoverPrimitive.Trigger;
+const PopoverAnchor = PopoverPrimitive.Anchor;
+const PopoverPortal = PopoverPrimitive.Portal;
+const PopoverContent = React.forwardRef(({ className, align = "center", sideOffset = 4, ...props }, ref) => (_jsx(PopoverPrimitive.Portal, { children: _jsx(PopoverPrimitive.Content, { ref: ref, align: align, sideOffset: sideOffset, className: cn("z-50 rounded-md border bg-white p-1 shadow-md outline-none", "border-gray-200 dark:border-gray-700 dark:bg-gray-900", "data-[state=open]:animate-in data-[state=closed]:animate-out", "data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0", "data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95", "data-[side=bottom]:slide-in-from-top-2", "data-[side=left]:slide-in-from-right-2", "data-[side=right]:slide-in-from-left-2", "data-[side=top]:slide-in-from-bottom-2", className), ...props }) })));
+PopoverContent.displayName = PopoverPrimitive.Content.displayName;
+export { Popover, PopoverTrigger, PopoverContent, PopoverAnchor, PopoverPortal };

package/lib/react/primitives.d.ts

@@ -5,14 +5,12 @@
 import React, { type ReactNode, type HTMLAttributes, type MouseEvent, type TouchEvent } from "react";
 import type { Citation as CitationType, CitationStatus } from "../types/citation.js";
 import type { Verification } from "../types/verification.js";
-import type { SearchState } from "../types/search.js";
 interface CitationContextValue {
     citation: CitationType;
     citationKey: string;
     citationInstanceId: string;
     status: CitationStatus;
     verification: Verification | null;
-    searchState: SearchState | null;
     config: {
         hideKeySpan: boolean;
         fallbackDisplay: string | null;
@@ -26,7 +24,6 @@ export declare function useCitationContextSafe(): CitationContextValue | null;
 export interface CitationRootProps {
     citation: CitationType;
     verification?: Verification | null;
-    searchState?: SearchState | null;
     children: ReactNode;
     hideKeySpan?: boolean;
     fallbackDisplay?: string | null;

package/lib/react/primitives.js

@@ -20,7 +20,7 @@ export function useCitationContextSafe() {
     return useContext(CitationContext);
 }
 /** Root component that provides citation context to all child primitives. */
-export const CitationRoot = forwardRef(({ citation, verification = null, searchState = null, children, hideKeySpan = false, fallbackDisplay = null, pendingContent = "..", className, ...props }, ref) => {
+export const CitationRoot = forwardRef(({ citation, verification = null, children, hideKeySpan = false, fallbackDisplay = null, pendingContent = "..", className, ...props }, ref) => {
     const citationKey = useMemo(() => generateCitationKey(citation), [citation]);
     const citationInstanceId = useMemo(() => generateCitationInstanceId(citationKey), [citationKey]);
     const status = getCitationStatus(verification);
@@ -30,7 +30,6 @@ export const CitationRoot = forwardRef(({ citation, verification = null, searchS
         citationInstanceId,
         status,
         verification,
-        searchState,
         config: {
             hideKeySpan,
             fallbackDisplay,
@@ -42,7 +41,6 @@ export const CitationRoot = forwardRef(({ citation, verification = null, searchS
         citationInstanceId,
         status,
         verification,
-        searchState,
         hideKeySpan,
         fallbackDisplay,
         pendingContent,

package/lib/react/types.d.ts

@@ -1,6 +1,6 @@
 import type { Citation, CitationStatus } from "../types/citation.js";
 import type { Verification } from "../types/verification.js";
-import type { SearchState } from "../types/search.js";
+import type { SearchStatus } from "../types/search.js";
 /**
  * Available citation display variants.
  *
@@ -135,8 +135,8 @@ export interface CitationContentProps extends BaseCitationProps {
     citationInstanceId: string;
     /** Found citation highlight data */
     verification: Verification | null | undefined;
-    /** Current search state */
-    searchState: SearchState | undefined | null;
+    /** Search status */
+    searchStatus: SearchStatus | undefined | null;
     /** Actual page number where citation was found */
     actualPageNumber?: number | null;
     /** Page number from citation data */
@@ -279,6 +279,5 @@ export interface CitationTooltipProps {
     children: React.ReactNode;
     citation: Citation;
     verification?: Verification | null;
-    searchState?: SearchState | null;
     shouldShowTooltip: boolean;
 }

package/lib/react/useSmartDiff.js

@@ -1,4 +1,4 @@
-import * as Diff from "diff";
+import { diffLines, diffWordsWithSpace } from "../utils/diff.js";
 import { useMemo } from "react";
 export const useSmartDiff = (expected = "", actual = "") => {
     return useMemo(() => {
@@ -8,7 +8,7 @@ export const useSmartDiff = (expected = "", actual = "") => {
         // 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 = Diff.diffLines(cleanExpected, cleanActual);
+        const lineDiffs = diffLines(cleanExpected, cleanActual);
         // 3. Second Pass: Process the line results to find "Modifications"
         const processedDiffs = [];
         let hasDiff = false;
@@ -21,7 +21,7 @@ export const useSmartDiff = (expected = "", actual = "") => {
             // 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 = Diff.diffWordsWithSpace(part.value, nextPart.value);
+                const wordDiffs = diffWordsWithSpace(part.value, nextPart.value);
                 processedDiffs.push({
                     type: "modified",
                     parts: wordDiffs,

package/lib/react/utils.d.ts

@@ -1,9 +1,17 @@
 import type { Citation } from "../types/citation.js";
+import type { Verification } from "../types/verification.js";
 /**
  * Generates a unique, deterministic key for a citation based on its content.
- * Uses a hash of the citation's identifying properties.
+ *  @param citation - The citation to generate a key for
+ * @returns A unique, deterministic key for the citation
  */
 export declare function generateCitationKey(citation: Citation): string;
+/**
+ * Generates a unique, deterministic key for a verification based on its content.
+ * @param verification - The verification to generate a key for
+ * @returns
+ */
+export declare function generateVerificationKey(verification: Verification): string;
 /**
  * Generates a unique instance ID for a citation component render.
  * Combines the citation key with a random suffix for uniqueness.

package/lib/react/utils.js

@@ -2,7 +2,8 @@ import { sha1Hash } from "../utils/sha.js";
 import { getCitationPageNumber } from "../parsing/normalizeCitation.js";
 /**
  * Generates a unique, deterministic key for a citation based on its content.
- * Uses a hash of the citation's identifying properties.
+ *  @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);
@@ -17,6 +18,26 @@ export function generateCitationKey(citation) {
     ];
     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.

package/lib/types/index.d.ts

@@ -7,5 +7,5 @@ export type { Citation, CitationStatus, VerifyCitationRequest, VerifyCitationRes
 export { DEFAULT_OUTPUT_IMAGE_FORMAT } from "./citation.js";
 export type { Verification } from "./verification.js";
 export { NOT_FOUND_VERIFICATION_INDEX, PENDING_VERIFICATION_INDEX, BLANK_VERIFICATION, } from "./verification.js";
-export type { SearchState, SearchStatus } from "./search.js";
+export type { SearchStatus, SearchMethod, SearchAttempt } from "./search.js";
 export type { ScreenBox, PdfSpaceItem, IVertex } from "./boxes.js";

package/lib/types/search.d.ts

@@ -17,19 +17,3 @@ export interface SearchAttempt {
     endTime?: number;
     durationMs?: number;
 }
-export interface SearchState {
-    status: SearchStatus;
-    expectedPage?: number | null;
-    actualPage?: number | null;
-    expectedLineIds?: number[] | null;
-    actualLineIds?: number[] | null;
-    actualTimestamps?: {
-        startTime?: string;
-        endTime?: string;
-    };
-    expectedTimestamps?: {
-        startTime?: string;
-        endTime?: string;
-    };
-    searchAttempts?: SearchAttempt[];
-}

package/lib/types/verification.d.ts

@@ -1,24 +1,26 @@
 import { type Citation } from "./citation.js";
-import { type SearchState } from "./search.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 declare function deterministicIdFromVerification(verification: Verification): string;
 export interface Verification {
     attachmentId?: string | null;
     label?: string | null;
     citation?: Citation;
-    searchState?: SearchState | null;
+    status?: SearchStatus | null;
+    searchAttempts?: SearchAttempt[];
     highlightColor?: string | null;
-    pageNumber?: number | null;
-    lineIds?: number[] | null;
-    timestamps?: {
+    verifiedPageNumber?: number | null;
+    verifiedLineIds?: number[] | null;
+    verifiedTimestamps?: {
         startTime?: string;
         endTime?: string;
     } | null;
+    verifiedFullPhrase?: string | null;
+    verifiedKeySpan?: string | null;
+    verifiedMatchSnippet?: string | null;
     hitIndexWithinPage?: number | null;
-    matchSnippet?: string | null;
     pdfSpaceItem?: PdfSpaceItem;
     verificationImageBase64?: string | null;
     verifiedAt?: Date;

package/lib/types/verification.js

@@ -1,17 +1,11 @@
-import { sha1Hash } from "../utils/sha.js";
 export const NOT_FOUND_VERIFICATION_INDEX = -1;
 export const PENDING_VERIFICATION_INDEX = -2;
 export const BLANK_VERIFICATION = {
     attachmentId: null,
-    pageNumber: NOT_FOUND_VERIFICATION_INDEX,
-    matchSnippet: null,
+    verifiedPageNumber: NOT_FOUND_VERIFICATION_INDEX,
+    verifiedMatchSnippet: null,
     citation: {
         pageNumber: NOT_FOUND_VERIFICATION_INDEX,
     },
-    searchState: {
-        status: "not_found",
-    },
+    status: "not_found",
 };
-export function deterministicIdFromVerification(verification) {
-    return sha1Hash(`${verification.label}-${verification.attachmentId}-${verification.pageNumber}-${verification.hitIndexWithinPage}-${verification.matchSnippet}-${verification?.hitIndexWithinPage}`);
-}

package/lib/utils/diff.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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[];