@opensecret/react 1.3.5 → 1.3.7

package/dist/index.d.ts

@@ -47,6 +47,7 @@ declare namespace api {
         requestAccountDeletion,
         confirmAccountDeletion,
         fetchModels,
+        uploadDocument,
         LoginResponse,
         UserResponse,
         KVListItem,
@@ -64,7 +65,9 @@ declare namespace api {
         ThirdPartyTokenResponse,
         EncryptDataRequest,
         EncryptDataResponse,
-        DecryptDataRequest
+        DecryptDataRequest,
+        DocumentUploadRequest,
+        DocumentResponse
     }
 }
 
@@ -311,6 +314,17 @@ declare type DeveloperResponse = PlatformUser & {
 
 export declare type DeveloperRole = "owner" | "admin" | "developer" | "viewer";
 
+export declare type DocumentResponse = {
+    text: string;
+    filename: string;
+    size: number;
+};
+
+declare type DocumentUploadRequest = {
+    filename: string;
+    content_base64: string;
+};
+
 declare type EmailSettings = {
     provider: string;
     send_from: string;
@@ -1101,6 +1115,33 @@ export declare type OpenSecretContextType = {
      * - Requires an active authentication session
      */
     fetchModels: () => Promise<Model[]>;
+    /**
+     * Uploads a document for text extraction and processing
+     * @param file - The file to upload (File or Blob object)
+     * @returns A promise resolving to the extracted document text and metadata
+     * @throws {Error} If:
+     * - The file exceeds 10MB size limit
+     * - The user is not authenticated (or is a guest user)
+     * - Usage limits are exceeded (403)
+     * - Processing fails (500)
+     *
+     * @description
+     * This function uploads a document to the Tinfoil processing service which:
+     * 1. Extracts text from various document formats (PDF, DOCX, TXT, etc.)
+     * 2. Returns the extracted text ready for use in chat prompts
+     * 3. Maintains end-to-end encryption using session keys
+     *
+     * Common supported formats include PDF, DOCX, XLSX, PPTX, TXT, RTF, and more.
+     * Guest users will receive a 401 Unauthorized error.
+     *
+     * Example usage:
+     * ```typescript
+     * const file = new File(["content"], "document.pdf", { type: "application/pdf" });
+     * const result = await context.uploadDocument(file);
+     * console.log(result.text); // Extracted text from the document
+     * ```
+     */
+    uploadDocument: (file: File | Blob) => Promise<DocumentResponse>;
 };
 
 /**
@@ -1857,6 +1898,35 @@ declare function updateProject(orgId: string, projectId: string, updates: {
     status?: string;
 }): Promise<Project>;
 
+/**
+ * Uploads a document for text extraction and processing
+ * @param file - The file to upload (File or Blob object)
+ * @returns A promise resolving to the extracted document text and metadata
+ * @throws {Error} If:
+ * - The file exceeds 10MB size limit
+ * - The user is not authenticated
+ * - The user is a guest (401)
+ * - Usage limits are exceeded (403)
+ * - Processing fails (500)
+ *
+ * @description
+ * This function uploads a document to the Tinfoil processing service which:
+ * 1. Extracts text from various document formats (PDF, DOCX, TXT, etc.)
+ * 2. Returns the extracted text ready for use in chat prompts
+ * 3. Maintains end-to-end encryption using session keys
+ *
+ * The file is converted to base64 before upload due to encryption requirements.
+ * Common supported formats include PDF, DOCX, XLSX, PPTX, TXT, RTF, and more.
+ *
+ * Example usage:
+ * ```typescript
+ * const file = new File(["content"], "document.pdf", { type: "application/pdf" });
+ * const result = await uploadDocument(file);
+ * console.log(result.text); // Extracted text from the document
+ * ```
+ */
+declare function uploadDocument(file: File | Blob): Promise<DocumentResponse>;
+
 export declare function useOpenSecret(): OpenSecretContextType;
 
 export declare function useOpenSecretDeveloper(): OpenSecretDeveloperContextType;