@deepcitation/deepcitation-js 1.0.5 → 1.0.7

package/README.md

@@ -41,7 +41,7 @@ Get a free API key at [deepcitation.com](https://deepcitation.com/signup) — no
 
 ```bash
 # .env
-DEEPCITATION_API_KEY=dc_live_your_api_key_here
+DEEPCITATION_API_KEY=sk-dc-your_api_key_here
 ```
 
 ---
@@ -123,7 +123,7 @@ function Response({ citations, verifications }) {
 
 ```typescript
 const dc = new DeepCitation({
-  apiKey: string,      // Your API key (dc_live_* or dc_test_*)
+  apiKey: string,      // Your API key (sk-dc-*)
   apiUrl?: string,     // Optional: Custom API URL
 });
 

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, VerifyCitationsFromLlmOutputInput, VerifyCitationsOptions, VerifyCitationsResponse } from "./types";
+import type { CitationInput, ConvertFileInput, ConvertFileResponse, DeepCitationConfig, FileInput, PrepareConvertedFileOptions, PrepareFilesResult, UploadFileOptions, UploadFileResponse, VerifyCitationsFromLlmOutput, VerifyCitationsOptions, VerifyCitationsResponse } from "./types";
 /**
  * DeepCitation client for file upload and citation verification.
  *
@@ -28,11 +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;
     /**
      * Create a new DeepCitation client instance.
      *
@@ -185,20 +180,7 @@ export declare class DeepCitation {
      * }
      * ```
      */
-    verifyCitationsFromLlmOutput(input: VerifyCitationsFromLlmOutputInput, citations?: {
+    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,6 +1,26 @@
 import { getAllCitationsFromLlmOutput } from "../parsing/parseCitation";
 import { generateCitationKey } from "../react/utils";
 const DEFAULT_API_URL = "https://api.deepcitation.com";
+/** Convert File/Blob/Buffer to a Blob suitable for FormData */
+function toBlob(file, filename) {
+    if (typeof Buffer !== "undefined" && Buffer.isBuffer(file)) {
+        const uint8 = Uint8Array.from(file);
+        return { blob: new Blob([uint8]), name: filename || "document" };
+    }
+    if (file instanceof Blob) {
+        return {
+            blob: file,
+            name: filename || (file instanceof File ? file.name : "document"),
+        };
+    }
+    throw new Error("Invalid file type. Expected File, Blob, or Buffer.");
+}
+/** 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}`);
+}
 /**
  * DeepCitation client for file upload and citation verification.
  *
@@ -29,11 +49,6 @@ const DEFAULT_API_URL = "https://api.deepcitation.com";
 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();
     /**
      * Create a new DeepCitation client instance.
      *
@@ -71,51 +86,22 @@ export class DeepCitation {
      * ```
      */
     async uploadFile(file, options) {
+        const { blob, name } = toBlob(file, options?.filename);
         const formData = new FormData();
-        // Handle different input types
-        if (typeof Buffer !== "undefined" && Buffer.isBuffer(file)) {
-            // Node.js Buffer - copy to a new ArrayBuffer for Blob compatibility
-            const filename = options?.filename || "document";
-            // Use Uint8Array.from to create a copy that's definitely backed by ArrayBuffer (not SharedArrayBuffer)
-            const uint8 = Uint8Array.from(file);
-            const blob = new Blob([uint8]);
-            formData.append("file", blob, filename);
-        }
-        else if (file instanceof Blob) {
-            // File or Blob
-            const filename = options?.filename || (file instanceof File ? file.name : "document");
-            formData.append("file", file, filename);
-        }
-        else {
-            throw new Error("Invalid file type. Expected File, Blob, or Buffer.");
-        }
-        // Add optional fields
-        if (options?.fileId) {
+        formData.append("file", blob, name);
+        if (options?.fileId)
             formData.append("fileId", options.fileId);
-        }
-        if (options?.filename) {
+        if (options?.filename)
             formData.append("filename", options.filename);
-        }
         const response = await fetch(`${this.apiUrl}/prepareFile`, {
             method: "POST",
-            headers: {
-                Authorization: `Bearer ${this.apiKey}`,
-            },
+            headers: { Authorization: `Bearer ${this.apiKey}` },
             body: formData,
         });
         if (!response.ok) {
-            const error = await response.json().catch(() => ({}));
-            throw new Error(error?.error?.message || `Upload failed with status ${response.status}`);
+            throw new Error(await extractErrorMessage(response, "Upload"));
         }
-        // Internal response includes attachmentId which we need for verification
-        const apiResponse = (await response.json());
-        // Store the mapping for later verification calls
-        this.fileIdMap.set(apiResponse.fileId, {
-            attachmentId: apiResponse.attachmentId,
-        });
-        // Return public response without internal fields
-        const { attachmentId: _attachmentId, ...publicResponse } = apiResponse;
-        return publicResponse;
+        return (await response.json());
     }
     /**
      * Convert a URL or Office file to PDF for citation verification.
@@ -150,76 +136,40 @@ export class DeepCitation {
      * ```
      */
     async convertToPdf(input) {
-        // Handle string URL shorthand
         const inputObj = typeof input === "string" ? { url: input } : input;
-        const { url, file, filename, fileId, singlePage } = inputObj;
+        const { url, file, filename, fileId } = inputObj;
         if (!url && !file) {
             throw new Error("Either url or file must be provided");
         }
         let response;
         if (url) {
-            // URL conversion - send as JSON
             response = await fetch(`${this.apiUrl}/convertFile`, {
                 method: "POST",
                 headers: {
                     Authorization: `Bearer ${this.apiKey}`,
                     "Content-Type": "application/json",
                 },
-                body: JSON.stringify({
-                    url,
-                    filename,
-                    fileId,
-                    singlePage,
-                }),
+                body: JSON.stringify({ url, filename, fileId }),
             });
         }
-        else if (file) {
-            // Office file conversion - send as multipart
+        else {
+            const { blob, name } = toBlob(file, filename);
             const formData = new FormData();
-            if (typeof Buffer !== "undefined" && Buffer.isBuffer(file)) {
-                const fname = filename || "document";
-                const uint8 = Uint8Array.from(file);
-                const blob = new Blob([uint8]);
-                formData.append("file", blob, fname);
-            }
-            else if (file instanceof Blob) {
-                const fname = filename || (file instanceof File ? file.name : "document");
-                formData.append("file", file, fname);
-            }
-            else {
-                throw new Error("Invalid file type. Expected File, Blob, or Buffer.");
-            }
-            if (fileId) {
+            formData.append("file", blob, name);
+            if (fileId)
                 formData.append("fileId", fileId);
-            }
-            if (filename) {
+            if (filename)
                 formData.append("filename", filename);
-            }
             response = await fetch(`${this.apiUrl}/convertFile`, {
                 method: "POST",
-                headers: {
-                    Authorization: `Bearer ${this.apiKey}`,
-                },
+                headers: { Authorization: `Bearer ${this.apiKey}` },
                 body: formData,
             });
         }
-        else {
-            throw new Error("Either url or file must be provided");
-        }
         if (!response.ok) {
-            const error = await response.json().catch(() => ({}));
-            throw new Error(error?.error?.message ||
-                `Conversion failed with status ${response.status}`);
+            throw new Error(await extractErrorMessage(response, "Conversion"));
         }
-        // Internal response includes attachmentId which we need for the two-step flow
-        const apiResponse = (await response.json());
-        // Store the mapping for later verification and prepareConvertedFile calls
-        this.fileIdMap.set(apiResponse.fileId, {
-            attachmentId: apiResponse.attachmentId,
-        });
-        // Return public response without internal fields
-        const { attachmentId: _attachmentId, ...publicResponse } = apiResponse;
-        return publicResponse;
+        return (await response.json());
     }
     /**
      * Prepare a previously converted file for citation verification.
@@ -242,11 +192,6 @@ export class DeepCitation {
      * ```
      */
     async prepareConvertedFile(options) {
-        // Look up the internal attachmentId from the fileId
-        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: {
@@ -254,23 +199,13 @@ export class DeepCitation {
                 "Content-Type": "application/json",
             },
             body: JSON.stringify({
-                attachmentId: fileInfo.attachmentId,
                 fileId: options.fileId,
             }),
         });
         if (!response.ok) {
-            const error = await response.json().catch(() => ({}));
-            throw new Error(error?.error?.message || `Prepare failed with status ${response.status}`);
+            throw new Error(await extractErrorMessage(response, "Prepare"));
         }
-        // Internal response includes attachmentId
-        const apiResponse = (await response.json());
-        // Update the mapping (attachmentId should remain the same)
-        this.fileIdMap.set(apiResponse.fileId, {
-            attachmentId: apiResponse.attachmentId,
-        });
-        // Return public response without internal fields
-        const { attachmentId: _attachmentId, ...publicResponse } = apiResponse;
-        return publicResponse;
+        return (await response.json());
     }
     /**
      * Upload multiple files for citation verification and get structured content.
@@ -333,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)) {
@@ -362,26 +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) {
-            const error = await response.json().catch(() => ({}));
-            throw new Error(error?.error?.message ||
-                `Verification failed with status ${response.status}`);
+            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.
@@ -411,10 +342,7 @@ 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 and verify each group
+        // Group citations by fileId
         const citationsByFile = new Map();
         for (const [key, citation] of Object.entries(citations)) {
             const fileId = citation.fileId || "";
@@ -423,54 +351,18 @@ export class DeepCitation {
             }
             citationsByFile.get(fileId)[key] = citation;
         }
-        // Verify citations for each file
-        const allHighlights = {};
+        // Verify all files in parallel
+        const verificationPromises = [];
         for (const [fileId, fileCitations] of citationsByFile) {
-            // Check if we have the file registered
-            const fileInfo = this.fileIdMap.get(fileId);
-            if (!fileInfo) {
-                // Skip citations for unregistered files
-                continue;
-            }
-            const response = await fetch(`${this.apiUrl}/verifyCitation`, {
-                method: "POST",
-                headers: {
-                    Authorization: `Bearer ${this.apiKey}`,
-                    "Content-Type": "application/json",
-                },
-                body: JSON.stringify({
-                    data: {
-                        attachmentId: fileInfo.attachmentId,
-                        citations: fileCitations,
-                        outputImageFormat,
-                    },
-                }),
-            });
-            if (!response.ok) {
-                const error = await response.json().catch(() => ({}));
-                throw new Error(error?.error?.message ||
-                    `Verification failed with status ${response.status}`);
+            if (fileId) {
+                verificationPromises.push(this.verifyCitations(fileId, fileCitations, { outputImageFormat }));
             }
-            const result = (await response.json());
+        }
+        const results = await Promise.all(verificationPromises);
+        const allHighlights = {};
+        for (const result of results) {
             Object.assign(allHighlights, result.foundHighlights);
         }
         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, VerifyCitationsFromLlmOutputInput, ConvertFileInput, ConvertFileResponse, PrepareConvertedFileOptions, } from "./types";
+export type { DeepCitationConfig, UploadFileResponse, UploadFileOptions, VerifyCitationsResponse, VerifyCitationsOptions, CitationInput, FileInput, FileDataPart, PrepareFilesResult, VerifyCitationsFromLlmOutput, ConvertFileInput, ConvertFileResponse, PrepareConvertedFileOptions, } from "./types";

package/lib/client/types.d.ts

@@ -3,7 +3,7 @@ import type { Citation, FoundHighlightLocation } from "../types/index";
  * Configuration options for the DeepCitation client
  */
 export interface DeepCitationConfig {
-    /** Your DeepCitation API key (starts with dc_live_ or dc_test_) */
+    /** Your DeepCitation API key (starts with sk-dc-) */
     apiKey: string;
     /** Optional custom API base URL. Defaults to https://api.deepcitation.com */
     apiUrl?: string;
@@ -94,7 +94,7 @@ export interface PrepareFilesResult {
 /**
  * Input for verifyCitationsFromLlmOutput
  */
-export interface VerifyCitationsFromLlmOutputInput {
+export interface VerifyCitationsFromLlmOutput {
     /** The LLM response containing citations */
     llmOutput: string;
     /** Optional file references (required for Zero Data Retention or after storage expires) */
@@ -114,8 +114,6 @@ export interface ConvertFileInput {
     filename?: string;
     /** Optional custom file ID */
     fileId?: string;
-    /** For URLs: render as single long page instead of paginated */
-    singlePage?: boolean;
 }
 /**
  * Response from convertFile
@@ -146,12 +144,3 @@ export interface PrepareConvertedFileOptions {
     /** The file ID from a previous convertFile call */
     fileId: string;
 }
-/**
- * @deprecated Use PrepareConvertedFileOptions instead
- */
-export interface PrepareFileFromAttachmentOptions {
-    /** The attachment ID from a previous convertFile call */
-    attachmentId: string;
-    /** Optional custom file ID */
-    fileId?: string;
-}

package/lib/index.d.ts

@@ -3,7 +3,7 @@
  * @packageDocumentation
  */
 export { DeepCitation } from "./client/index.js";
-export type { DeepCitationConfig, UploadFileResponse, UploadFileOptions, VerifyCitationsResponse, VerifyCitationsOptions, CitationInput, FileInput, FileDataPart, PrepareFilesResult, VerifyCitationsFromLlmOutputInput, } from "./client/index.js";
+export type { DeepCitationConfig, UploadFileResponse, UploadFileOptions, VerifyCitationsResponse, VerifyCitationsOptions, CitationInput, FileInput, FileDataPart, PrepareFilesResult, VerifyCitationsFromLlmOutput, } from "./client/index.js";
 export { parseCitation, getCitationStatus, getAllCitationsFromLlmOutput, groupCitationsByFileId, groupCitationsByFileIdObject, } from "./parsing/parseCitation.js";
 export { normalizeCitations, getCitationPageNumber, } from "./parsing/normalizeCitation.js";
 export { isGeminiGarbage, cleanRepeatingLastSentence, } from "./parsing/parseWorkAround.js";

package/package.json

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