@augmentcode/auggie-sdk 0.1.10 → 0.1.12

package/README.md

@@ -334,11 +334,27 @@ import { DirectContext } from "@augmentcode/auggie-sdk";
 // 3. Or pass credentials directly in options
 const context = await DirectContext.create();
 
-// Add files to index
+// Add files to index (waits indefinitely by default)
 await context.addToIndex([
   { path: "src/main.ts", contents: "..." }
 ]);
 
+// Optionally set a timeout
+await context.addToIndex(files, {
+  timeout: 10 * 60 * 1000  // 10 minutes in milliseconds
+});
+
+// Track progress during indexing
+await context.addToIndex(files, {
+  onProgress: (progress) => {
+    console.log(`[${progress.stage}] Uploaded: ${progress.uploaded}/${progress.total}, Indexed: ${progress.indexed}/${progress.total}`);
+    if (progress.stage === 'uploading') {
+      console.log(`  Current file: ${progress.currentFile}`);
+      console.log(`  Bytes uploaded: ${progress.bytesUploaded}`);
+    }
+  }
+});
+
 // Search - returns results in a formatted string ready for LLM use or display
 const results = await context.search("authentication logic");
 console.log(results);
@@ -352,8 +368,47 @@ console.log(answer);
 
 // Export state to avoid re-indexing
 await context.exportToFile("/tmp/state.json");
+
+// For search-only use cases, export lightweight state
+await context.exportToFile("/tmp/search-state.json", { mode: "search-only" });
 ```
 
+#### Search-Only Export (Optimized for Storage)
+
+For applications that only need to search an existing index (without adding or removing files), you can export a lightweight search-only state that excludes the large blobs array:
+
+```typescript
+import { DirectContext } from "@augmentcode/auggie-sdk";
+
+// Create and index files normally
+const context = await DirectContext.create();
+await context.addToIndex(files);
+
+// Export search-only state (much smaller for large codebases)
+const searchState = context.export({ mode: "search-only" });
+// or
+await context.exportToFile("search-state.json", { mode: "search-only" });
+
+// Later, import the search-only state
+const searchContext = await DirectContext.import(searchState);
+// or
+const searchContext = await DirectContext.importFromFile("search-state.json");
+
+// Search operations work normally
+const results = await searchContext.search("authentication logic");
+
+// But indexing operations will throw errors
+// await searchContext.addToIndex(files); // ❌ Error: requires full state
+// await searchContext.removeFromIndex(paths); // ❌ Error: requires full state
+// searchContext.getIndexedPaths(); // ❌ Error: requires full state
+```
+
+**When to use search-only export:**
+- ✅ Search-only applications (e.g., documentation search, code Q&A)
+- ✅ Distributed systems where indexing happens centrally
+- ✅ Reducing index size for large codebases
+- ❌ Applications that need to add/remove files from the index
+
 ### FileSystem Context
 
 **⚠️ Requires Local Auggie Installation**

package/dist/auggie/sdk-acp-client.d.ts

@@ -1,15 +1,16 @@
-import { type SessionNotification } from "@agentclientprotocol/sdk";
-import type { Tool } from "ai";
+import { SessionNotification } from '@agentclientprotocol/sdk';
+import { Tool } from 'ai';
+
 type models = "haiku4.5" | "sonnet4.5" | "sonnet4" | "gpt5";
 /**
  * Predefined tool types that can be excluded from the Auggie agent.
  * These are the built-in tools provided by Auggie.
  */
-export type PredefinedToolType = "remove-files" | "save-file" | "str-replace-editor" | "view" | "launch-process" | "kill-process" | "read-process" | "write-process" | "list-processes" | "web-search" | "add_tasks" | "update_tasks" | "reorganize_tasklist" | "view_tasklist";
+type PredefinedToolType = "remove-files" | "save-file" | "str-replace-editor" | "view" | "launch-process" | "kill-process" | "read-process" | "write-process" | "list-processes" | "web-search" | "add_tasks" | "update_tasks" | "reorganize_tasklist" | "view_tasklist";
 /**
  * Tool identifier type - can be a predefined tool or a custom tool name.
  */
-export type ToolIdentifier = PredefinedToolType | string;
+type ToolIdentifier = PredefinedToolType | string;
 type AuggieOptions = {
     auggiePath?: string;
     workspaceRoot?: string;
@@ -113,5 +114,5 @@ declare class Auggie {
      */
     private killProcess;
 }
-export { Auggie };
-//# sourceMappingURL=sdk-acp-client.d.ts.map
+
+export { Auggie, type PredefinedToolType, type ToolIdentifier };