@deepcitation/deepcitation-js 1.1.27 → 1.1.29

package/lib/types/index.d.ts

@@ -1,11 +1,96 @@
-/**
- * Type definitions for DeepCitation
- *
- * @packageDocumentation
- */
-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, } from "./verification.js";
-export type { SearchStatus, SearchMethod, SearchAttempt } from "./search.js";
-export type { ScreenBox, PdfSpaceItem, IVertex } from "./boxes.js";
+interface PdfSpaceItem extends ScreenBox {
+    text?: string;
+}
+type IVertex = {
+    x: number;
+    y: number;
+};
+interface ScreenBox extends IVertex {
+    width: number;
+    height: number;
+}
+
+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";
+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";
+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;
+}
+
+declare const NOT_FOUND_VERIFICATION_INDEX = -1;
+declare const PENDING_VERIFICATION_INDEX = -2;
+declare const BLANK_VERIFICATION: Verification;
+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;
+}
+
+type OutputImageFormat = "jpeg" | "png" | "avif" | undefined | null;
+declare const DEFAULT_OUTPUT_IMAGE_FORMAT: "avif";
+interface VerifyCitationResponse {
+    verifications: {
+        [key: string]: Verification;
+    };
+}
+interface VerifyCitationRequest {
+    attachmentId: string;
+    citations: {
+        [key: string]: Citation;
+    };
+    outputImageFormat?: OutputImageFormat;
+    apiKey?: string;
+}
+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;
+}
+interface CitationStatus {
+    isVerified: boolean;
+    isMiss: boolean;
+    isPartialMatch: boolean;
+    isPending: boolean;
+}
+
+export { BLANK_VERIFICATION, type Citation, type CitationStatus, DEFAULT_OUTPUT_IMAGE_FORMAT, type IVertex, NOT_FOUND_VERIFICATION_INDEX, type OutputImageFormat, PENDING_VERIFICATION_INDEX, type PdfSpaceItem, type ScreenBox, type SearchAttempt, type SearchMethod, type SearchStatus, type Verification, type VerifyCitationRequest, type VerifyCitationResponse };

package/lib/types/index.js

@@ -1,7 +1 @@
-/**
- * Type definitions for DeepCitation
- *
- * @packageDocumentation
- */
-export { DEFAULT_OUTPUT_IMAGE_FORMAT } from "./citation.js";
-export { NOT_FOUND_VERIFICATION_INDEX, PENDING_VERIFICATION_INDEX, BLANK_VERIFICATION, } from "./verification.js";
+export{d as BLANK_VERIFICATION,a as DEFAULT_OUTPUT_IMAGE_FORMAT,b as NOT_FOUND_VERIFICATION_INDEX,c as PENDING_VERIFICATION_INDEX}from'../chunk-RQPZSRID.js';import'../chunk-O2XFH626.js';

package/lib/utils-CSqRI6NU.d.cts

@@ -0,0 +1,45 @@
+import { Citation, Verification } from './types/index.cjs';
+
+/**
+ * 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
+ */
+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
+ */
+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.
+ */
+declare function generateCitationInstanceId(citationKey: string): string;
+/**
+ * Gets the display text for a citation (keySpan with fallback to number).
+ */
+declare function getCitationDisplayText(citation: Citation, options?: {
+    fallbackDisplay?: string | null;
+}): string;
+/**
+ * Gets the citation number as a string.
+ */
+declare function getCitationNumber(citation: Citation): string;
+/**
+ * Gets the keySpan text from a citation.
+ */
+declare function getCitationKeySpanText(citation: Citation): string;
+/**
+ * Joins class names, filtering out falsy values.
+ * This is a minimal implementation for the base component.
+ */
+declare function classNames(...classes: (string | undefined | null | false)[]): string;
+/**
+ * Default padding values for citation styling.
+ */
+declare const CITATION_X_PADDING = 4;
+declare const CITATION_Y_PADDING = 1;
+
+export { CITATION_X_PADDING as C, generateVerificationKey as a, generateCitationInstanceId as b, CITATION_Y_PADDING as c, getCitationDisplayText as d, getCitationNumber as e, getCitationKeySpanText as f, generateCitationKey as g, classNames as h };

package/lib/{react/utils.d.ts → utils-D_wxy_ni.d.ts}

@@ -1,44 +1,45 @@
-import type { Citation } from "../types/citation.js";
-import type { Verification } from "../types/verification.js";
-export declare function cn(...classes: (string | undefined | null | false)[]): string;
+import { Citation, Verification } from './types/index.js';
+
 /**
  * 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 declare function generateCitationKey(citation: Citation): string;
+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;
+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.
  */
-export declare function generateCitationInstanceId(citationKey: string): string;
+declare function generateCitationInstanceId(citationKey: string): string;
 /**
  * Gets the display text for a citation (keySpan with fallback to number).
  */
-export declare function getCitationDisplayText(citation: Citation, options?: {
+declare function getCitationDisplayText(citation: Citation, options?: {
     fallbackDisplay?: string | null;
 }): string;
 /**
  * Gets the citation number as a string.
  */
-export declare function getCitationNumber(citation: Citation): string;
+declare function getCitationNumber(citation: Citation): string;
 /**
  * Gets the keySpan text from a citation.
  */
-export declare function getCitationKeySpanText(citation: Citation): string;
+declare function getCitationKeySpanText(citation: Citation): string;
 /**
  * Joins class names, filtering out falsy values.
  * This is a minimal implementation for the base component.
  */
-export declare function classNames(...classes: (string | undefined | null | false)[]): string;
+declare function classNames(...classes: (string | undefined | null | false)[]): string;
 /**
  * Default padding values for citation styling.
  */
-export declare const CITATION_X_PADDING = 4;
-export declare const CITATION_Y_PADDING = 1;
+declare const CITATION_X_PADDING = 4;
+declare const CITATION_Y_PADDING = 1;
+
+export { CITATION_X_PADDING as C, generateVerificationKey as a, generateCitationInstanceId as b, CITATION_Y_PADDING as c, getCitationDisplayText as d, getCitationNumber as e, getCitationKeySpanText as f, generateCitationKey as g, classNames as h };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deepcitation/deepcitation-js",
-    "version": "1.1.27",
+    "version": "1.1.29",
     "description": "DeepCitation JavaScript SDK for deterministic AI citation verification",
     "type": "module",
     "private": false,
@@ -14,7 +14,8 @@
         "type": "git",
         "url": "git+https://github.com/deepcitation/deepcitation-js.git"
     },
-    "main": "./lib/index.js",
+    "main": "./lib/index.cjs",
+    "module": "./lib/index.js",
     "types": "./lib/index.d.ts",
     "sideEffects": false,
     "files": [
@@ -22,17 +23,20 @@
         "LICENSE"
     ],
     "scripts": {
-        "build": "rimraf lib && tsc",
-        "build:watch": "rimraf lib && tsc --watch",
+        "build": "tsup",
+        "build:watch": "tsup --watch",
+        "build:tsc": "rimraf lib && tsc",
         "test": "bun test ./src/__tests__/*.test.ts ./src/__tests__/*.test.tsx",
         "test:jest": "jest",
         "test:watch": "jest --watch",
         "test:ct": "playwright test -c playwright-ct.config.ts",
         "test:ct:ui": "playwright test -c playwright-ct.config.ts --ui",
+        "size": "size-limit",
+        "analyze": "size-limit --why",
         "prepublishOnly": "npm run build"
     },
     "engines": {
-        "node": ">=22"
+        "node": ">=18"
     },
     "peerDependencies": {
         "react": ">=17.0.0",
@@ -51,6 +55,7 @@
         }
     },
     "devDependencies": {
+        "@size-limit/preset-small-lib": "^11.0.0",
         "@happy-dom/global-registrator": "^20.0.11",
         "@playwright/experimental-ct-react": "^1.57.0",
         "@playwright/test": "^1.57.0",
@@ -69,34 +74,55 @@
         "react": "19.2.3",
         "react-dom": "19.2.3",
         "rimraf": "^5.0.5",
+        "size-limit": "^11.0.0",
         "ts-jest": "^29.4.6",
+        "tsup": "^8.0.0",
         "typescript": "^5.9.3",
         "vite": "^7.3.0"
     },
+    "size-limit": [
+        {
+            "path": "lib/index.js",
+            "limit": "25 KB"
+        },
+        {
+            "path": "lib/client/index.js",
+            "limit": "10 KB"
+        },
+        {
+            "path": "lib/prompts/index.js",
+            "limit": "15 KB"
+        },
+        {
+            "path": "lib/react/index.js",
+            "limit": "15 KB"
+        }
+    ],
     "exports": {
         ".": {
             "types": "./lib/index.d.ts",
             "import": "./lib/index.js",
-            "require": "./lib/index.js"
+            "require": "./lib/index.cjs"
         },
         "./client": {
             "types": "./lib/client/index.d.ts",
             "import": "./lib/client/index.js",
-            "require": "./lib/client/index.js"
+            "require": "./lib/client/index.cjs"
         },
         "./prompts": {
             "types": "./lib/prompts/index.d.ts",
             "import": "./lib/prompts/index.js",
-            "require": "./lib/prompts/index.js"
+            "require": "./lib/prompts/index.cjs"
         },
         "./react": {
             "types": "./lib/react/index.d.ts",
             "import": "./lib/react/index.js",
-            "require": "./lib/react/index.js"
+            "require": "./lib/react/index.cjs"
         },
         "./types": {
             "types": "./lib/types/index.d.ts",
-            "import": "./lib/types/index.js"
+            "import": "./lib/types/index.js",
+            "require": "./lib/types/index.cjs"
         }
     },
     "keywords": [
@@ -106,6 +132,15 @@
         "llm",
         "hallucination",
         "react",
-        "typescript"
+        "typescript",
+        "openai",
+        "anthropic",
+        "claude",
+        "gpt",
+        "rag",
+        "reference",
+        "source-verification",
+        "fact-checking",
+        "grounding"
     ]
 }