@deepcitation/deepcitation-js 1.1.3 → 1.1.5

package/lib/index.d.ts

@@ -10,7 +10,7 @@ export { isGeminiGarbage, cleanRepeatingLastSentence, } from "./parsing/parseWor
 export type { Citation, CitationStatus, VerifyCitationRequest, VerifyCitationResponse, OutputImageFormat, } from "./types/citation.js";
 export { DEFAULT_OUTPUT_IMAGE_FORMAT } from "./types/citation.js";
 export type { Verification } from "./types/verification.js";
-export { NOT_FOUND_VERIFICATION_INDEX, PENDING_VERIFICATION_INDEX, BLANK_VERIFICATION, deterministicIdFromVerification, } from "./types/verification.js";
+export { NOT_FOUND_VERIFICATION_INDEX, PENDING_VERIFICATION_INDEX, BLANK_VERIFICATION, } from "./types/verification.js";
 export type { SearchState, SearchStatus, SearchMethod, SearchAttempt, } from "./types/search.js";
 export type { ScreenBox, PdfSpaceItem, IVertex } from "./types/boxes.js";
 export { sha1Hash } from "./utils/sha.js";

package/lib/index.js

@@ -9,7 +9,7 @@ export { parseCitation, getCitationStatus, getAllCitationsFromLlmOutput, groupCi
 export { normalizeCitations, getCitationPageNumber, } from "./parsing/normalizeCitation.js";
 export { isGeminiGarbage, cleanRepeatingLastSentence, } from "./parsing/parseWorkAround.js";
 export { DEFAULT_OUTPUT_IMAGE_FORMAT } from "./types/citation.js";
-export { NOT_FOUND_VERIFICATION_INDEX, PENDING_VERIFICATION_INDEX, BLANK_VERIFICATION, deterministicIdFromVerification, } from "./types/verification.js";
+export { NOT_FOUND_VERIFICATION_INDEX, PENDING_VERIFICATION_INDEX, BLANK_VERIFICATION, } from "./types/verification.js";
 // Utilities
 export { sha1Hash } from "./utils/sha.js";
 export { generateCitationKey } from "./react/utils.js";

package/lib/react/CitationComponent.js

@@ -182,7 +182,7 @@ const DefaultPopoverContent = ({ verification, status, onImageClick, }) => {
  * This means partial matches have blue text (because they were found) but
  * an orange indicator (because they didn't match exactly).
  */
-export const CitationComponent = forwardRef(({ citation, children, className, displayCitationValue = false, fallbackDisplay, verification, variant = "brackets", eventHandlers, isMobile = false, renderIndicator, renderContent, popoverPosition = "top", renderPopoverContent, }, ref) => {
+export const CitationComponent = forwardRef(({ citation, children, className, displayKeySpan = false, fallbackDisplay, verification, variant = "brackets", eventHandlers, isMobile = false, renderIndicator, renderContent, popoverPosition = "top", renderPopoverContent, }, ref) => {
     const containerRef = useRef(null);
     const wrapperRef = useRef(null);
     const [expandedImageSrc, setExpandedImageSrc] = useState(null);
@@ -274,13 +274,13 @@ export const CitationComponent = forwardRef(({ citation, children, className, di
         }
         // For text/minimal/brackets, show the value or fullPhrase
         return getCitationDisplayText(citation, {
-            displayCitationValue: variant === "text" ||
+            displayKeySpan: variant === "text" ||
                 variant === "minimal" ||
                 variant === "brackets" ||
-                displayCitationValue,
+                displayKeySpan,
             fallbackDisplay,
         });
-    }, [citation, variant, displayCitationValue, fallbackDisplay]);
+    }, [citation, variant, displayKeySpan, fallbackDisplay]);
     // Found status class for text styling (blue for found, gray for miss)
     const foundStatusClass = useMemo(() => getFoundStatusClass(status), [status]);
     // Event handlers
@@ -300,7 +300,7 @@ export const CitationComponent = forwardRef(({ citation, children, className, di
     // Early return for miss with fallback display
     if (fallbackDisplay !== null &&
         fallbackDisplay !== undefined &&
-        displayCitationValue &&
+        displayKeySpan &&
         isMiss) {
         return (_jsx("span", { className: classNames("dc-citation-fallback", className), children: fallbackDisplay }));
     }
@@ -332,9 +332,7 @@ export const CitationComponent = forwardRef(({ citation, children, className, di
                 status,
                 citationKey,
                 displayText,
-                isMergedDisplay: variant === "text" ||
-                    variant === "brackets" ||
-                    displayCitationValue,
+                isMergedDisplay: variant === "text" || variant === "brackets" || displayKeySpan,
             });
         }
         // Indicator-only variant - just the checkmark/warning

package/lib/react/CitationVariants.js

@@ -1,7 +1,7 @@
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
 import { memo, useMemo, useCallback, forwardRef, } from "react";
 import { getCitationStatus } from "../parsing/parseCitation.js";
-import { generateCitationKey, generateCitationInstanceId, getCitationDisplayText, getCitationValueText, classNames, } from "./utils.js";
+import { generateCitationKey, generateCitationInstanceId, getCitationDisplayText, getCitationKeySpanText, classNames, } from "./utils.js";
 const TWO_DOTS_THINKING_CONTENT = "..";
 /**
  * Hook to get common citation data.
@@ -31,16 +31,16 @@ const DefaultPartialIndicator = () => (_jsx("span", { className: "citation-parti
  * <ChipCitation citation={citation} verification={found} size="md" />
  * ```
  */
-export const ChipCitation = forwardRef(({ citation, children, className, displayCitationValue = false, fallbackDisplay, verification, eventHandlers, isMobile = false, preventTooltips = false, pendingContent = TWO_DOTS_THINKING_CONTENT, renderVerifiedIndicator = () => _jsx(DefaultVerifiedIndicator, {}), renderPartialIndicator = () => _jsx(DefaultPartialIndicator, {}), size = "md", showIcon = false, icon, }, ref) => {
+export const ChipCitation = forwardRef(({ citation, children, className, displayKeySpan = false, fallbackDisplay, verification, eventHandlers, isMobile = false, preventTooltips = false, pendingContent = TWO_DOTS_THINKING_CONTENT, renderVerifiedIndicator = () => _jsx(DefaultVerifiedIndicator, {}), renderPartialIndicator = () => _jsx(DefaultPartialIndicator, {}), size = "md", showIcon = false, icon, }, ref) => {
     const { citationKey, citationInstanceId, status } = useCitationData(citation, verification);
     const { isVerified, isMiss, isPartialMatch, isPending } = status;
     const displayText = useMemo(() => getCitationDisplayText(citation, {
-        displayCitationValue,
+        displayKeySpan,
         fallbackDisplay,
-    }), [citation, displayCitationValue, fallbackDisplay]);
-    const valueText = useMemo(() => getCitationValueText(citation, {
-        displayCitationValue,
-    }), [citation, displayCitationValue]);
+    }), [citation, displayKeySpan, fallbackDisplay]);
+    const keySpanText = useMemo(() => getCitationKeySpanText(citation, {
+        displayKeySpan,
+    }), [citation, displayKeySpan]);
     const handleClick = useCallback((e) => {
         e.preventDefault();
         e.stopPropagation();
@@ -68,7 +68,7 @@ export const ChipCitation = forwardRef(({ citation, children, className, display
                     ? "citation-chip--pending"
                     : "";
     return (_jsxs(_Fragment, { children: [children, _jsxs("span", { ref: ref, "data-citation-id": citationKey, "data-citation-instance": citationInstanceId, "data-variant": "chip", className: classNames("citation-chip", sizeClasses[size], statusClass, className), onMouseEnter: preventTooltips ? undefined : handleMouseEnter, onMouseLeave: preventTooltips ? undefined : handleMouseLeave, onMouseDown: handleClick, onClick: (e) => e.stopPropagation(), "aria-label": displayText ? `Citation: ${displayText}` : undefined, children: [showIcon &&
-                        (icon || _jsx("span", { className: "citation-chip__icon", children: "\uD83D\uDCC4" })), valueText && !displayCitationValue && (_jsx("span", { className: "citation-chip__value", children: valueText })), _jsx("span", { className: "citation-chip__text", children: displayText }), isPartialMatch && renderPartialIndicator(status), isVerified && !isPartialMatch && renderVerifiedIndicator(status), isPending && (_jsx("span", { className: "citation-chip__pending", children: pendingContent }))] })] }));
+                        (icon || _jsx("span", { className: "citation-chip__icon", children: "\uD83D\uDCC4" })), keySpanText && !displayKeySpan && (_jsx("span", { className: "citation-chip__keySpan", children: keySpanText })), _jsx("span", { className: "citation-chip__text", children: displayText }), isPartialMatch && renderPartialIndicator(status), isVerified && !isPartialMatch && renderVerifiedIndicator(status), isPending && (_jsx("span", { className: "citation-chip__pending", children: pendingContent }))] })] }));
 });
 ChipCitation.displayName = "ChipCitation";
 /**
@@ -81,13 +81,13 @@ ChipCitation.displayName = "ChipCitation";
  * // Renders: Text content¹
  * ```
  */
-export const SuperscriptCitation = forwardRef(({ citation, children, className, displayCitationValue = false, fallbackDisplay, verification, eventHandlers, isMobile = false, preventTooltips = false, pendingContent = TWO_DOTS_THINKING_CONTENT, renderVerifiedIndicator = () => _jsx(DefaultVerifiedIndicator, {}), renderPartialIndicator = () => _jsx(DefaultPartialIndicator, {}), showBrackets = false, }, ref) => {
+export const SuperscriptCitation = forwardRef(({ citation, children, className, displayKeySpan = false, fallbackDisplay, verification, eventHandlers, isMobile = false, preventTooltips = false, pendingContent = TWO_DOTS_THINKING_CONTENT, renderVerifiedIndicator = () => _jsx(DefaultVerifiedIndicator, {}), renderPartialIndicator = () => _jsx(DefaultPartialIndicator, {}), showBrackets = false, }, ref) => {
     const { citationKey, citationInstanceId, status } = useCitationData(citation, verification);
     const { isVerified, isMiss, isPartialMatch, isPending } = status;
     const displayText = useMemo(() => getCitationDisplayText(citation, {
-        displayCitationValue,
+        displayKeySpan,
         fallbackDisplay,
-    }), [citation, displayCitationValue, fallbackDisplay]);
+    }), [citation, displayKeySpan, fallbackDisplay]);
     const handleClick = useCallback((e) => {
         e.preventDefault();
         e.stopPropagation();
@@ -173,14 +173,14 @@ FootnoteCitation.displayName = "FootnoteCitation";
  * // Renders: "quoted text" with subtle underline
  * ```
  */
-export const InlineCitation = forwardRef(({ citation, children, className, displayCitationValue = true, // Default to merged for inline
+export const InlineCitation = forwardRef(({ citation, children, className, displayKeySpan = true, // Default to merged for inline
 fallbackDisplay, verification, eventHandlers, preventTooltips = false, pendingContent = TWO_DOTS_THINKING_CONTENT, renderVerifiedIndicator = () => _jsx(DefaultVerifiedIndicator, {}), renderPartialIndicator = () => _jsx(DefaultPartialIndicator, {}), underlineStyle = "dotted", }, ref) => {
     const { citationKey, citationInstanceId, status } = useCitationData(citation, verification);
     const { isVerified, isMiss, isPartialMatch, isPending } = status;
     const displayText = useMemo(() => getCitationDisplayText(citation, {
-        displayCitationValue,
+        displayKeySpan,
         fallbackDisplay,
-    }), [citation, displayCitationValue, fallbackDisplay]);
+    }), [citation, displayKeySpan, fallbackDisplay]);
     const handleClick = useCallback((e) => {
         e.preventDefault();
         e.stopPropagation();
@@ -216,13 +216,13 @@ InlineCitation.displayName = "InlineCitation";
  * // Renders: 1
  * ```
  */
-export const MinimalCitation = forwardRef(({ citation, children, className, displayCitationValue = false, fallbackDisplay, verification, eventHandlers, preventTooltips = false, pendingContent = TWO_DOTS_THINKING_CONTENT, renderVerifiedIndicator = () => _jsx(DefaultVerifiedIndicator, {}), renderPartialIndicator = () => _jsx(DefaultPartialIndicator, {}), showStatusIndicator = true, }, ref) => {
+export const MinimalCitation = forwardRef(({ citation, children, className, displayKeySpan = false, fallbackDisplay, verification, eventHandlers, preventTooltips = false, pendingContent = TWO_DOTS_THINKING_CONTENT, renderVerifiedIndicator = () => _jsx(DefaultVerifiedIndicator, {}), renderPartialIndicator = () => _jsx(DefaultPartialIndicator, {}), showStatusIndicator = true, }, ref) => {
     const { citationKey, citationInstanceId, status } = useCitationData(citation, verification);
     const { isVerified, isMiss, isPartialMatch, isPending } = status;
     const displayText = useMemo(() => getCitationDisplayText(citation, {
-        displayCitationValue,
+        displayKeySpan,
         fallbackDisplay,
-    }), [citation, displayCitationValue, fallbackDisplay]);
+    }), [citation, displayKeySpan, fallbackDisplay]);
     const handleClick = useCallback((e) => {
         e.preventDefault();
         e.stopPropagation();

package/lib/react/index.d.ts

@@ -11,6 +11,6 @@
  * @packageDocumentation
  */
 export type { CitationContentProps, CitationRenderProps, CitationTooltipProps, CitationStyles, CitationStateClasses, CitationCursorClasses, CitationEventHandlers, CitationVariant as CitationVariantType, UrlFetchStatus, UrlCitationMeta, UrlCitationProps, } from "./types.js";
-export { extractDomain, isBlockedStatus, isErrorStatus, isVerifiedStatus } from "./UrlCitationComponent.js";
-export { generateCitationKey, generateCitationInstanceId, getCitationDisplayText, getCitationValueText, classNames, CITATION_X_PADDING, CITATION_Y_PADDING, } from "./utils.js";
+export { extractDomain, isBlockedStatus, isErrorStatus, isVerifiedStatus, } from "./UrlCitationComponent.js";
+export { generateCitationKey, generateCitationInstanceId, getCitationDisplayText, getCitationKeySpanText, classNames, CITATION_X_PADDING, CITATION_Y_PADDING, } from "./utils.js";
 export { CitationComponent, MemoizedCitationComponent, type CitationVariant, type CitationComponentProps, } from "./CitationComponent.js";

package/lib/react/index.js

@@ -11,8 +11,8 @@
  * @packageDocumentation
  */
 // URL Utilities - For handling URL citation metadata
-export { extractDomain, isBlockedStatus, isErrorStatus, isVerifiedStatus } from "./UrlCitationComponent.js";
+export { extractDomain, isBlockedStatus, isErrorStatus, isVerifiedStatus, } from "./UrlCitationComponent.js";
 // Utilities - For generating citation keys and display text
-export { generateCitationKey, generateCitationInstanceId, getCitationDisplayText, getCitationValueText, classNames, CITATION_X_PADDING, CITATION_Y_PADDING, } from "./utils.js";
+export { generateCitationKey, generateCitationInstanceId, getCitationDisplayText, getCitationKeySpanText, classNames, CITATION_X_PADDING, CITATION_Y_PADDING, } from "./utils.js";
 // Components
 export { CitationComponent, MemoizedCitationComponent, } from "./CitationComponent.js";

package/lib/react/primitives.d.ts

@@ -14,7 +14,7 @@ interface CitationContextValue {
     verification: Verification | null;
     searchState: SearchState | null;
     config: {
-        displayCitationValue: boolean;
+        displayKeySpan: boolean;
         fallbackDisplay: string | null;
         pendingContent: ReactNode;
     };
@@ -28,7 +28,7 @@ export interface CitationRootProps {
     verification?: Verification | null;
     searchState?: SearchState | null;
     children: ReactNode;
-    displayCitationValue?: boolean;
+    displayKeySpan?: boolean;
     fallbackDisplay?: string | null;
     pendingContent?: ReactNode;
 }

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, displayCitationValue = false, fallbackDisplay = null, pendingContent = "..", className, ...props }, ref) => {
+export const CitationRoot = forwardRef(({ citation, verification = null, searchState = null, children, displayKeySpan = false, fallbackDisplay = null, pendingContent = "..", className, ...props }, ref) => {
     const citationKey = useMemo(() => generateCitationKey(citation), [citation]);
     const citationInstanceId = useMemo(() => generateCitationInstanceId(citationKey), [citationKey]);
     const status = getCitationStatus(verification);
@@ -32,7 +32,7 @@ export const CitationRoot = forwardRef(({ citation, verification = null, searchS
         verification,
         searchState,
         config: {
-            displayCitationValue,
+            displayKeySpan,
             fallbackDisplay,
             pendingContent,
         },
@@ -43,7 +43,7 @@ export const CitationRoot = forwardRef(({ citation, verification = null, searchS
         status,
         verification,
         searchState,
-        displayCitationValue,
+        displayKeySpan,
         fallbackDisplay,
         pendingContent,
     ]);
@@ -100,7 +100,7 @@ export const CitationNumber = forwardRef(({ className, number, ...props }, ref)
     const displayNumber = useMemo(() => {
         if (number !== undefined)
             return String(number);
-        if (config.displayCitationValue) {
+        if (config.displayKeySpan) {
             return (citation.value ||
                 citation.citationNumber?.toString() ||
                 config.fallbackDisplay ||
@@ -120,7 +120,7 @@ export const CitationValue = forwardRef(({ className, value, separator = " ", ..
     const displayValue = useMemo(() => {
         if (value !== undefined)
             return value;
-        if (config.displayCitationValue)
+        if (config.displayKeySpan)
             return "";
         return citation.value || "";
     }, [value, citation, config]);

package/lib/react/types.d.ts

@@ -90,7 +90,7 @@ export interface BaseCitationProps {
     /** Class name for controlling inner content width */
     innerWidthClassName?: string;
     /** When true, displays value/citationNumber merged in the bracket */
-    displayCitationValue?: boolean;
+    displayKeySpan?: boolean;
     /** Fallback display text when citation value is empty */
     fallbackDisplay?: string | null;
     /** Display variant for the citation */

package/lib/react/utils.d.ts

@@ -13,14 +13,14 @@ export declare function generateCitationInstanceId(citationKey: string): string;
  * Gets the display text for a citation based on configuration.
  */
 export declare function getCitationDisplayText(citation: Citation, options?: {
-    displayCitationValue?: boolean;
+    displayKeySpan?: boolean;
     fallbackDisplay?: string | null;
 }): string;
 /**
- * Gets the value text to display before the citation bracket.
+ * Gets the keySpan text to display before the citation bracket.
  */
-export declare function getCitationValueText(citation: Citation, options?: {
-    displayCitationValue?: boolean;
+export declare function getCitationKeySpanText(citation: Citation, options?: {
+    displayKeySpan?: boolean;
 }): string;
 /**
  * Joins class names, filtering out falsy values.

package/lib/react/utils.js

@@ -9,7 +9,6 @@ export function generateCitationKey(citation) {
         citation.pageNumber?.toString() || "",
         citation.fullPhrase || "",
         citation.keySpan?.toString() || "",
-        citation.value || "",
         citation.lineIds?.join(",") || "",
         citation.timestamps?.startTime || "",
         citation.timestamps?.endTime || "",
@@ -28,9 +27,9 @@ export function generateCitationInstanceId(citationKey) {
  * Gets the display text for a citation based on configuration.
  */
 export function getCitationDisplayText(citation, options = {}) {
-    const { displayCitationValue = false, fallbackDisplay } = options;
-    if (displayCitationValue) {
-        return (citation.value ||
+    const { displayKeySpan = false, fallbackDisplay } = options;
+    if (displayKeySpan) {
+        return (citation.keySpan?.toString() ||
             citation.citationNumber?.toString() ||
             fallbackDisplay ||
             "");
@@ -38,14 +37,14 @@ export function getCitationDisplayText(citation, options = {}) {
     return citation.citationNumber?.toString() || "";
 }
 /**
- * Gets the value text to display before the citation bracket.
+ * Gets the keySpan text to display before the citation bracket.
  */
-export function getCitationValueText(citation, options = {}) {
-    const { displayCitationValue = false } = options;
-    if (displayCitationValue) {
+export function getCitationKeySpanText(citation, options = {}) {
+    const { displayKeySpan = false } = options;
+    if (displayKeySpan) {
         return "";
     }
-    return citation.value || "";
+    return citation.keySpan?.toString() || "";
 }
 /**
  * Joins class names, filtering out falsy values.

package/lib/types/index.d.ts

@@ -6,6 +6,6 @@
 export type { Citation, CitationStatus, VerifyCitationRequest, VerifyCitationResponse, OutputImageFormat, } from "./citation.js";
 export { DEFAULT_OUTPUT_IMAGE_FORMAT } from "./citation.js";
 export type { Verification } from "./verification.js";
-export { NOT_FOUND_VERIFICATION_INDEX, PENDING_VERIFICATION_INDEX, BLANK_VERIFICATION, deterministicIdFromVerification, } 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 { ScreenBox, PdfSpaceItem, IVertex } from "./boxes.js";

package/lib/types/index.js

@@ -4,4 +4,4 @@
  * @packageDocumentation
  */
 export { DEFAULT_OUTPUT_IMAGE_FORMAT } from "./citation.js";
-export { NOT_FOUND_VERIFICATION_INDEX, PENDING_VERIFICATION_INDEX, BLANK_VERIFICATION, deterministicIdFromVerification, } from "./verification.js";
+export { NOT_FOUND_VERIFICATION_INDEX, PENDING_VERIFICATION_INDEX, BLANK_VERIFICATION, } from "./verification.js";

package/lib/types/verification.d.ts

@@ -4,12 +4,9 @@ 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 {
-    regex?: RegExp | null;
-    lowerCaseSearchTerm: string | null;
+    fileId?: string | null;
     label?: string | null;
-    attachmentId?: string | null;
     pageNumber?: number | null;
     timestamp?: number | null;
     citation?: Citation;

package/lib/types/verification.js

@@ -1,11 +1,8 @@
-import { sha1Hash } from "../utils/sha.js";
 export const NOT_FOUND_VERIFICATION_INDEX = -1;
 export const PENDING_VERIFICATION_INDEX = -2;
 export const BLANK_VERIFICATION = {
+    fileId: null,
     pageNumber: NOT_FOUND_VERIFICATION_INDEX,
-    regex: null,
-    lowerCaseSearchTerm: null,
-    attachmentId: null,
     matchSnippet: null,
     source: null,
     citation: {
@@ -18,6 +15,3 @@ export const BLANK_VERIFICATION = {
         pageNumber: NOT_FOUND_VERIFICATION_INDEX,
     },
 };
-export function deterministicIdFromVerification(verification) {
-    return sha1Hash(`${verification.lowerCaseSearchTerm}-${verification.attachmentId}-${verification.pageNumber}-${verification.hitIndexWithinPage}-${verification.matchSnippet}-${verification?.hitIndexWithinPage}`);
-}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deepcitation/deepcitation-js",
-    "version": "1.1.3",
+    "version": "1.1.5",
     "description": "DeepCitation JavaScript SDK for deterministic AI citation verification",
     "type": "module",
     "private": false,