@deepcitation/deepcitation-js 1.0.6 → 1.0.8

package/lib/client/DeepCitation.d.ts

@@ -1,5 +1,5 @@
-import type { Citation } from "../types/index";
-import type { CitationInput, ConvertFileInput, ConvertFileResponse, DeepCitationConfig, FileInput, PrepareConvertedFileOptions, PrepareFilesResult, UploadFileOptions, UploadFileResponse, VerifyCitationsFromLlmOutput, VerifyCitationsOptions, VerifyCitationsResponse } from "./types";
+import type { Citation } from "../types/index.js";
+import type { CitationInput, ConvertFileInput, ConvertFileResponse, DeepCitationConfig, FileInput, PrepareConvertedFileOptions, PrepareFilesResult, UploadFileOptions, UploadFileResponse, VerifyCitationsFromLlmOutput, VerifyCitationsOptions, VerifyCitationsResponse } from "./types.js";
 /**
  * DeepCitation client for file upload and citation verification.
  *
@@ -28,13 +28,6 @@ import type { CitationInput, ConvertFileInput, ConvertFileResponse, DeepCitation
 export declare class DeepCitation {
     private readonly apiKey;
     private readonly apiUrl;
-    /**
-     * Stores mapping of user-provided fileId to internal attachmentId
-     * This allows users to reference files by their own IDs
-     */
-    private fileIdMap;
-    /** Store file mapping and return public response */
-    private storeAndReturnResponse;
     /**
      * Create a new DeepCitation client instance.
      *
@@ -190,17 +183,4 @@ export declare class DeepCitation {
     verifyCitationsFromLlmOutput(input: VerifyCitationsFromLlmOutput, citations?: {
         [key: string]: Citation;
     }): Promise<VerifyCitationsResponse>;
-    /**
-     * Register a file that was uploaded separately (e.g., via direct API call).
-     * This allows you to use verifyCitations with files not uploaded via uploadFile().
-     *
-     * @param fileId - Your file ID
-     * @param attachmentId - The internal attachment ID
-     */
-    registerFile(fileId: string, attachmentId: string): void;
-    /**
-     * Clear the internal file ID mapping.
-     * Useful for cleanup or when working with many files.
-     */
-    clearFileMap(): void;
 }

package/lib/client/DeepCitation.js

@@ -1,5 +1,5 @@
-import { getAllCitationsFromLlmOutput } from "../parsing/parseCitation";
-import { generateCitationKey } from "../react/utils";
+import { getAllCitationsFromLlmOutput } from "../parsing/parseCitation.js";
+import { generateCitationKey } from "../react/utils.js";
 const DEFAULT_API_URL = "https://api.deepcitation.com";
 /** Convert File/Blob/Buffer to a Blob suitable for FormData */
 function toBlob(file, filename) {
@@ -18,7 +18,8 @@ function toBlob(file, filename) {
 /** Extract error message from API response */
 async function extractErrorMessage(response, fallbackAction) {
     const error = await response.json().catch(() => ({}));
-    return error?.error?.message || `${fallbackAction} failed with status ${response.status}`;
+    return (error?.error?.message ||
+        `${fallbackAction} failed with status ${response.status}`);
 }
 /**
  * DeepCitation client for file upload and citation verification.
@@ -48,17 +49,6 @@ async function extractErrorMessage(response, fallbackAction) {
 export class DeepCitation {
     apiKey;
     apiUrl;
-    /**
-     * Stores mapping of user-provided fileId to internal attachmentId
-     * This allows users to reference files by their own IDs
-     */
-    fileIdMap = new Map();
-    /** Store file mapping and return public response */
-    storeAndReturnResponse(apiResponse) {
-        this.fileIdMap.set(apiResponse.fileId, { attachmentId: apiResponse.attachmentId });
-        const { attachmentId: _, ...publicResponse } = apiResponse;
-        return publicResponse;
-    }
     /**
      * Create a new DeepCitation client instance.
      *
@@ -111,7 +101,7 @@ export class DeepCitation {
         if (!response.ok) {
             throw new Error(await extractErrorMessage(response, "Upload"));
         }
-        return this.storeAndReturnResponse(await response.json());
+        return (await response.json());
     }
     /**
      * Convert a URL or Office file to PDF for citation verification.
@@ -179,10 +169,7 @@ export class DeepCitation {
         if (!response.ok) {
             throw new Error(await extractErrorMessage(response, "Conversion"));
         }
-        const apiResponse = (await response.json());
-        this.fileIdMap.set(apiResponse.fileId, { attachmentId: apiResponse.attachmentId });
-        const { attachmentId: _, ...publicResponse } = apiResponse;
-        return publicResponse;
+        return (await response.json());
     }
     /**
      * Prepare a previously converted file for citation verification.
@@ -205,10 +192,6 @@ export class DeepCitation {
      * ```
      */
     async prepareConvertedFile(options) {
-        const fileInfo = this.fileIdMap.get(options.fileId);
-        if (!fileInfo) {
-            throw new Error(`File ID "${options.fileId}" not found. Make sure to call convertToPdf() first.`);
-        }
         const response = await fetch(`${this.apiUrl}/prepareFile`, {
             method: "POST",
             headers: {
@@ -216,14 +199,13 @@ export class DeepCitation {
                 "Content-Type": "application/json",
             },
             body: JSON.stringify({
-                attachmentId: fileInfo.attachmentId,
                 fileId: options.fileId,
             }),
         });
         if (!response.ok) {
             throw new Error(await extractErrorMessage(response, "Prepare"));
         }
-        return this.storeAndReturnResponse(await response.json());
+        return (await response.json());
     }
     /**
      * Upload multiple files for citation verification and get structured content.
@@ -286,11 +268,6 @@ export class DeepCitation {
      * ```
      */
     async verifyCitations(fileId, citations, options) {
-        // Look up the internal IDs from our map
-        const fileInfo = this.fileIdMap.get(fileId);
-        if (!fileInfo) {
-            throw new Error(`File ID "${fileId}" not found. Make sure to upload the file first with uploadFile().`);
-        }
         // Normalize citations to a map with citation keys
         const citationMap = {};
         if (Array.isArray(citations)) {
@@ -315,24 +292,27 @@ export class DeepCitation {
         else {
             throw new Error("Invalid citations format");
         }
-        const response = await fetch(`${this.apiUrl}/verifyCitation`, {
+        const requestUrl = `${this.apiUrl}/verifyCitations`;
+        const requestBody = {
+            data: {
+                fileId,
+                citations: citationMap,
+                outputImageFormat: options?.outputImageFormat || "avif",
+            },
+        };
+        const response = await fetch(requestUrl, {
             method: "POST",
             headers: {
                 Authorization: `Bearer ${this.apiKey}`,
                 "Content-Type": "application/json",
             },
-            body: JSON.stringify({
-                data: {
-                    attachmentId: fileInfo.attachmentId,
-                    citations: citationMap,
-                    outputImageFormat: options?.outputImageFormat || "avif",
-                },
-            }),
+            body: JSON.stringify(requestBody),
         });
         if (!response.ok) {
             throw new Error(await extractErrorMessage(response, "Verification"));
         }
-        return (await response.json());
+        const result = (await response.json());
+        return result;
     }
     /**
      * Verify citations from LLM output with automatic parsing.
@@ -362,9 +342,6 @@ export class DeepCitation {
         if (Object.keys(citations).length === 0) {
             return { foundHighlights: {} };
         }
-        // Note: fileDataParts is now only used to identify which files to verify
-        // The mapping from fileId to attachmentId must be registered via uploadFile() or prepareFiles()
-        // in the same session. For Zero Data Retention scenarios, use verifyCitations() directly.
         // Group citations by fileId
         const citationsByFile = new Map();
         for (const [key, citation] of Object.entries(citations)) {
@@ -374,10 +351,10 @@ export class DeepCitation {
             }
             citationsByFile.get(fileId)[key] = citation;
         }
-        // Filter to only registered files and verify in parallel
+        // Verify all files in parallel
         const verificationPromises = [];
         for (const [fileId, fileCitations] of citationsByFile) {
-            if (this.fileIdMap.has(fileId)) {
+            if (fileId) {
                 verificationPromises.push(this.verifyCitations(fileId, fileCitations, { outputImageFormat }));
             }
         }
@@ -388,21 +365,4 @@ export class DeepCitation {
         }
         return { foundHighlights: allHighlights };
     }
-    /**
-     * Register a file that was uploaded separately (e.g., via direct API call).
-     * This allows you to use verifyCitations with files not uploaded via uploadFile().
-     *
-     * @param fileId - Your file ID
-     * @param attachmentId - The internal attachment ID
-     */
-    registerFile(fileId, attachmentId) {
-        this.fileIdMap.set(fileId, { attachmentId });
-    }
-    /**
-     * Clear the internal file ID mapping.
-     * Useful for cleanup or when working with many files.
-     */
-    clearFileMap() {
-        this.fileIdMap.clear();
-    }
 }

package/lib/client/index.d.ts

@@ -1,2 +1,2 @@
-export { DeepCitation } from "./DeepCitation";
-export type { DeepCitationConfig, UploadFileResponse, UploadFileOptions, VerifyCitationsResponse, VerifyCitationsOptions, CitationInput, FileInput, FileDataPart, PrepareFilesResult, VerifyCitationsFromLlmOutput, ConvertFileInput, ConvertFileResponse, PrepareConvertedFileOptions, } from "./types";
+export { DeepCitation } from "./DeepCitation.js";
+export type { DeepCitationConfig, UploadFileResponse, UploadFileOptions, VerifyCitationsResponse, VerifyCitationsOptions, CitationInput, FileInput, FileDataPart, PrepareFilesResult, VerifyCitationsFromLlmOutput, ConvertFileInput, ConvertFileResponse, PrepareConvertedFileOptions, } from "./types.js";

package/lib/client/index.js

@@ -1 +1 @@
-export { DeepCitation } from "./DeepCitation";
+export { DeepCitation } from "./DeepCitation.js";

package/lib/client/types.d.ts

@@ -1,4 +1,4 @@
-import type { Citation, FoundHighlightLocation } from "../types/index";
+import type { Citation, FoundHighlightLocation } from "../types/index.js";
 /**
  * Configuration options for the DeepCitation client
  */

package/lib/prompts/citationPrompts.d.ts

@@ -1,4 +1,4 @@
-export declare const CITATION_MARKDOWN_SYNTAX_PROMPT = "\nCitation syntax to use within Markdown:\n\u2022 To support any ideas or information that requires a citation from the provided content, use the following citation syntax:\n<cite file_id='file_id' start_page_key='page_number_PAGE_index_INDEX' full_phrase='the verbatim text of the terse phrase inside <file_text />; remember to escape quotes and newlines inside the full_phrase to remain as valid JSON' key_span='the verbatim value or words within full_phrase that best support the citation' line_ids='2-6' reasoning='the terse logic used to conclude the citation' />\n\n\u2022 Very important: for page numbers, only use the page number and page index info from the page_number_PAGE_index_INDEX format (e.g. <page_number_1_index_0>) and never from the contents inside the page.\n\u2022 start_page_key, full_phrase, and line_ids are required for each citation.\n\u2022 Infer line_ids, as we only provide the first, last, and every 5th line. When copying a previous <cite />, use the full info from the previous citation without changing the start_page_key, line_ids, or any other <cite /> attributes.\n\u2022 Use refer to line_ids inclusively, and use a range (or single) for each citation, split multiple sequential line_ids into multiple citations.\n\u2022 These citations will be replaced and displayed in-line as a numeric element (e.g. [1]), the markdown preceding <cite /> should read naturally with only one <cite /> per sentence with rare exceptions for two <cite /> in a sentence. <cite /> often present best at the end of the sentence, and are not grouped at the end of the document.\n\u2022 The full_phrase should be the exact verbatim text of the phrase or paragraph from the source document to support the insight or idea.\n\u2022 We do NOT put the full_phrase inside <cite ...></cite>; we only use full_phrase inside the full_phrase attribute.\n";
+export declare const CITATION_MARKDOWN_SYNTAX_PROMPT = "\nCitation syntax to use within Markdown:\n\u2022 To support any ideas or information that requires a citation from the provided content, use the following citation syntax:\n<cite file_id='file_id' start_page_key='page_number_PAGE_index_INDEX' full_phrase='the verbatim text of the terse phrase inside <file_text />; remember to escape quotes and newlines inside the full_phrase to remain as valid JSON' key_span='the verbatim value or 1-3 words within full_phrase that best support the citation' line_ids='2-6' reasoning='the terse logic used to conclude the citation' />\n\n\u2022 Very important: for page numbers, only use the page number and page index info from the page_number_PAGE_index_INDEX format (e.g. <page_number_1_index_0>) and never from the contents inside the page.\n\u2022 start_page_key, full_phrase, and line_ids are required for each citation.\n\u2022 Infer line_ids, as we only provide the first, last, and every 5th line. When copying a previous <cite />, use the full info from the previous citation without changing the start_page_key, line_ids, or any other <cite /> attributes.\n\u2022 Use refer to line_ids inclusively, and use a range (or single) for each citation, split multiple sequential line_ids into multiple citations.\n\u2022 These citations will be replaced and displayed in-line as a numeric element (e.g. [1]), the markdown preceding <cite /> should read naturally with only one <cite /> per sentence with rare exceptions for two <cite /> in a sentence. <cite /> often present best at the end of the sentence, and are not grouped at the end of the document.\n\u2022 The full_phrase should be the exact verbatim text of the phrase or paragraph from the source document to support the insight or idea.\n\u2022 We do NOT put the full_phrase inside <cite ...></cite>; we only use full_phrase inside the full_phrase attribute.\n";
 export declare const AV_CITATION_MARKDOWN_SYNTAX_PROMPT = "\n\u2022 To support any ideas or information that requires a citation from the provided content, use the following citation syntax:\n<cite file_id='file_id' full_phrase='the verbatim text of the phrase; remember to escape quotes and newlines inside the full_phrase to remain as valid JSON' timestamps='HH:MM:SS.SSS-HH:MM:SS.SSS' reasoning='the logic connecting the form section requirements to the supporting source citation' />\n\u2022 These citations are displayed in-line or in the relevant list item, and are not grouped at the end of the document.\n";
 export interface WrapSystemPromptOptions {
     /** The original system prompt to wrap with citation instructions */

package/lib/prompts/citationPrompts.js

@@ -1,7 +1,7 @@
 export const CITATION_MARKDOWN_SYNTAX_PROMPT = `
 Citation syntax to use within Markdown:
 • To support any ideas or information that requires a citation from the provided content, use the following citation syntax:
-<cite file_id='file_id' start_page_key='page_number_PAGE_index_INDEX' full_phrase='the verbatim text of the terse phrase inside <file_text />; remember to escape quotes and newlines inside the full_phrase to remain as valid JSON' key_span='the verbatim value or words within full_phrase that best support the citation' line_ids='2-6' reasoning='the terse logic used to conclude the citation' />
+<cite file_id='file_id' start_page_key='page_number_PAGE_index_INDEX' full_phrase='the verbatim text of the terse phrase inside <file_text />; remember to escape quotes and newlines inside the full_phrase to remain as valid JSON' key_span='the verbatim value or 1-3 words within full_phrase that best support the citation' line_ids='2-6' reasoning='the terse logic used to conclude the citation' />
 
 • Very important: for page numbers, only use the page number and page index info from the page_number_PAGE_index_INDEX format (e.g. <page_number_1_index_0>) and never from the contents inside the page.
 • start_page_key, full_phrase, and line_ids are required for each citation.
@@ -125,7 +125,7 @@ export const CITATION_JSON_OUTPUT_FORMAT = {
         },
         keySpan: {
             type: "string",
-            description: "the verbatim value or words within fullPhrase that best support the citation",
+            description: "the verbatim value or 1-3 words within fullPhrase that best support the citation",
         },
         lineIds: {
             type: "array",

package/lib/prompts/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./promptCompression";
-export * from "./citationPrompts";
-export * from "./types";
+export * from "./promptCompression.js";
+export * from "./citationPrompts.js";
+export * from "./types.js";

package/lib/prompts/index.js

@@ -1,3 +1,3 @@
-export * from "./promptCompression";
-export * from "./citationPrompts";
-export * from "./types";
+export * from "./promptCompression.js";
+export * from "./citationPrompts.js";
+export * from "./types.js";

package/lib/prompts/promptCompression.d.ts

@@ -1,4 +1,4 @@
-import { CompressedResult } from "./types";
+import { CompressedResult } from "./types.js";
 /**
  * Compress all occurrences of `ids` inside `obj`, returning a new object
  * plus the `prefixMap` needed to decompress.

package/lib/types/citation.d.ts

@@ -1,5 +1,5 @@
-import { type ScreenBox } from "./boxes";
-import { type FoundHighlightLocation } from "./foundHighlight";
+import { type ScreenBox } from "./boxes.js";
+import { type FoundHighlightLocation } from "./foundHighlight.js";
 export type OutputImageFormat = "jpeg" | "png" | "avif" | undefined | null;
 export declare const DEFAULT_OUTPUT_IMAGE_FORMAT: "avif";
 export interface VerifyCitationResponse {

package/lib/types/foundHighlight.d.ts

@@ -1,6 +1,6 @@
-import { type Citation } from "./citation";
-import { type SearchState } from "./search";
-import { type PdfSpaceItem } from "./boxes";
+import { type Citation } from "./citation.js";
+import { type SearchState } from "./search.js";
+import { type PdfSpaceItem } from "./boxes.js";
 export declare const NOT_FOUND_HIGHLIGHT_INDEX = -1;
 export declare const PENDING_HIGHLIGHT_INDEX = -2;
 export declare const BLANK_HIGHLIGHT_LOCATION: FoundHighlightLocation;

package/package.json

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