cursor-history 0.6.0 → 0.9.1

package/dist/lib/index.d.ts

@@ -5,10 +5,10 @@
  * projects, NOT a network/REST API. Functions are imported directly:
  * `import { listSessions, getSession, searchSessions } from 'cursor-history'`
  */
-export type { Session, Message, ToolCall, SearchResult, LibraryConfig, PaginatedResult, } from './types.js';
-export { DatabaseLockedError, DatabaseNotFoundError, InvalidConfigError, isDatabaseLockedError, isDatabaseNotFoundError, isInvalidConfigError, } from './errors.js';
+export type { Session, Message, ToolCall, SearchResult, LibraryConfig, PaginatedResult, MigrationMode, MigrateSessionConfig, MigrateWorkspaceConfig, SessionMigrationResult, WorkspaceMigrationResult, BackupManifest, BackupFileEntry, BackupStats, BackupConfig, BackupProgress, BackupResult, RestoreConfig, RestoreProgress, RestoreResult, BackupValidation, BackupInfo, SqliteDriverName, } from './types.js';
+export { DatabaseLockedError, DatabaseNotFoundError, InvalidConfigError, SessionNotFoundError, WorkspaceNotFoundError, SameWorkspaceError, NoSessionsFoundError, DestinationHasSessionsError, BackupError, NoDataError, FileExistsError, InsufficientSpaceError, RestoreError, BackupNotFoundError, InvalidBackupError, TargetExistsError, IntegrityError, isDatabaseLockedError, isDatabaseNotFoundError, isInvalidConfigError, isSessionNotFoundError, isWorkspaceNotFoundError, isSameWorkspaceError, isNoSessionsFoundError, isDestinationHasSessionsError, isBackupError, isNoDataError, isFileExistsError, isInsufficientSpaceError, isRestoreError, isBackupNotFoundError, isInvalidBackupError, isTargetExistsError, isIntegrityError, } from './errors.js';
 export { getDefaultDataPath } from './utils.js';
-import type { LibraryConfig, PaginatedResult, Session, SearchResult } from './types.js';
+import type { LibraryConfig, PaginatedResult, Session, SearchResult, MigrateSessionConfig, MigrateWorkspaceConfig, SessionMigrationResult, WorkspaceMigrationResult, SqliteDriverName } from './types.js';
 /**
  * List all chat sessions, optionally filtered and paginated.
  *
@@ -20,19 +20,19 @@ import type { LibraryConfig, PaginatedResult, Session, SearchResult } from './ty
  *
  * @example
  * // List all sessions
- * const result = listSessions();
+ * const result = await listSessions();
  * console.log(result.data); // Session[]
  *
  * @example
  * // List sessions with pagination
- * const page1 = listSessions({ limit: 10, offset: 0 });
- * const page2 = listSessions({ limit: 10, offset: 10 });
+ * const page1 = await listSessions({ limit: 10, offset: 0 });
+ * const page2 = await listSessions({ limit: 10, offset: 10 });
  *
  * @example
  * // List sessions for specific workspace
- * const result = listSessions({ workspace: '/path/to/project' });
+ * const result = await listSessions({ workspace: '/path/to/project' });
  */
-export declare function listSessions(config?: LibraryConfig): PaginatedResult<Session>;
+export declare function listSessions(config?: LibraryConfig): Promise<PaginatedResult<Session>>;
 /**
  * Get a specific session by index.
  *
@@ -44,14 +44,14 @@ export declare function listSessions(config?: LibraryConfig): PaginatedResult<Se
  * @throws {InvalidConfigError} If index is out of bounds
  *
  * @example
- * const session = getSession(0);
+ * const session = await getSession(0);
  * console.log(session.messages); // Message[]
  *
  * @example
  * // Get session from custom data path
- * const session = getSession(5, { dataPath: '/custom/cursor/data' });
+ * const session = await getSession(5, { dataPath: '/custom/cursor/data' });
  */
-export declare function getSession(index: number, config?: LibraryConfig): Session;
+export declare function getSession(index: number, config?: LibraryConfig): Promise<Session>;
 /**
  * Search across all sessions for matching content.
  *
@@ -63,11 +63,11 @@ export declare function getSession(index: number, config?: LibraryConfig): Sessi
  *
  * @example
  * // Basic search
- * const results = searchSessions('authentication');
+ * const results = await searchSessions('authentication');
  *
  * @example
  * // Search with context lines
- * const results = searchSessions('error', { context: 2 });
+ * const results = await searchSessions('error', { context: 2 });
  * results.forEach(r => {
  *   console.log(r.contextBefore); // 2 lines before match
  *   console.log(r.match);          // matched line
@@ -76,9 +76,9 @@ export declare function getSession(index: number, config?: LibraryConfig): Sessi
  *
  * @example
  * // Search within specific workspace
- * const results = searchSessions('bug', { workspace: '/path/to/project' });
+ * const results = await searchSessions('bug', { workspace: '/path/to/project' });
  */
-export declare function searchSessions(query: string, config?: LibraryConfig): SearchResult[];
+export declare function searchSessions(query: string, config?: LibraryConfig): Promise<SearchResult[]>;
 /**
  * Export a session to JSON format.
  *
@@ -90,10 +90,10 @@ export declare function searchSessions(query: string, config?: LibraryConfig): S
  * @throws {InvalidConfigError} If index is out of bounds
  *
  * @example
- * const json = exportSessionToJson(0);
+ * const json = await exportSessionToJson(0);
  * fs.writeFileSync('session.json', json);
  */
-export declare function exportSessionToJson(index: number, config?: LibraryConfig): string;
+export declare function exportSessionToJson(index: number, config?: LibraryConfig): Promise<string>;
 /**
  * Export a session to Markdown format.
  *
@@ -105,10 +105,10 @@ export declare function exportSessionToJson(index: number, config?: LibraryConfi
  * @throws {InvalidConfigError} If index is out of bounds
  *
  * @example
- * const markdown = exportSessionToMarkdown(0);
+ * const markdown = await exportSessionToMarkdown(0);
  * fs.writeFileSync('session.md', markdown);
  */
-export declare function exportSessionToMarkdown(index: number, config?: LibraryConfig): string;
+export declare function exportSessionToMarkdown(index: number, config?: LibraryConfig): Promise<string>;
 /**
  * Export all sessions to JSON format.
  *
@@ -118,14 +118,14 @@ export declare function exportSessionToMarkdown(index: number, config?: LibraryC
  * @throws {DatabaseNotFoundError} If database path does not exist
  *
  * @example
- * const json = exportAllSessionsToJson();
+ * const json = await exportAllSessionsToJson();
  * fs.writeFileSync('all-sessions.json', json);
  *
  * @example
  * // Export sessions from specific workspace
- * const json = exportAllSessionsToJson({ workspace: '/path/to/project' });
+ * const json = await exportAllSessionsToJson({ workspace: '/path/to/project' });
  */
-export declare function exportAllSessionsToJson(config?: LibraryConfig): string;
+export declare function exportAllSessionsToJson(config?: LibraryConfig): Promise<string>;
 /**
  * Export all sessions to Markdown format.
  *
@@ -135,8 +135,117 @@ export declare function exportAllSessionsToJson(config?: LibraryConfig): string;
  * @throws {DatabaseNotFoundError} If database path does not exist
  *
  * @example
- * const markdown = exportAllSessionsToMarkdown();
+ * const markdown = await exportAllSessionsToMarkdown();
  * fs.writeFileSync('all-sessions.md', markdown);
  */
-export declare function exportAllSessionsToMarkdown(config?: LibraryConfig): string;
+export declare function exportAllSessionsToMarkdown(config?: LibraryConfig): Promise<string>;
+/**
+ * Migrate one or more sessions to a different workspace.
+ *
+ * This is the primary migration function for session-level operations.
+ * Supports moving (removing from source) or copying (keeping source intact).
+ *
+ * @param config - Migration configuration
+ * @returns Array of results for each session migrated
+ * @throws {SessionNotFoundError} If a session cannot be found
+ * @throws {WorkspaceNotFoundError} If destination workspace doesn't exist
+ * @throws {SameWorkspaceError} If source and destination are the same
+ * @throws {DatabaseLockedError} If database is locked by Cursor
+ *
+ * @example
+ * // Move a single session by index
+ * const results = await migrateSession({
+ *   sessions: 3,
+ *   destination: '/path/to/new/project'
+ * });
+ *
+ * @example
+ * // Copy multiple sessions
+ * const results = await migrateSession({
+ *   sessions: [1, 3, 5],
+ *   destination: '/path/to/project',
+ *   mode: 'copy'
+ * });
+ *
+ * @example
+ * // Dry run to preview what would happen
+ * const results = await migrateSession({
+ *   sessions: '1,3,5',
+ *   destination: '/path/to/project',
+ *   dryRun: true
+ * });
+ */
+export declare function migrateSession(config: MigrateSessionConfig): Promise<SessionMigrationResult[]>;
+/**
+ * Migrate all sessions from one workspace to another.
+ *
+ * This is a convenience function for workspace-level migration.
+ * Uses migrateSession internally for each session in the source workspace.
+ *
+ * @param config - Workspace migration configuration
+ * @returns Aggregate result with per-session details
+ * @throws {WorkspaceNotFoundError} If source or destination workspace doesn't exist
+ * @throws {SameWorkspaceError} If source and destination are the same
+ * @throws {NoSessionsFoundError} If source workspace has no sessions
+ * @throws {DestinationHasSessionsError} If destination has sessions and force not set
+ * @throws {DatabaseLockedError} If database is locked by Cursor
+ *
+ * @example
+ * // Move all sessions from old to new project
+ * const result = await migrateWorkspace({
+ *   source: '/old/project',
+ *   destination: '/new/project'
+ * });
+ * console.log(`Migrated ${result.successCount} sessions`);
+ *
+ * @example
+ * // Create backup copy of all sessions
+ * const result = await migrateWorkspace({
+ *   source: '/project',
+ *   destination: '/backup/project',
+ *   mode: 'copy'
+ * });
+ *
+ * @example
+ * // Force merge with existing destination sessions
+ * const result = await migrateWorkspace({
+ *   source: '/old/project',
+ *   destination: '/existing/project',
+ *   force: true
+ * });
+ */
+export declare function migrateWorkspace(config: MigrateWorkspaceConfig): Promise<WorkspaceMigrationResult>;
+export { createBackup, restoreBackup, validateBackup, listBackups, getDefaultBackupDir, } from './backup.js';
+/**
+ * Set the SQLite driver to use for database operations.
+ *
+ * This allows explicit control over which SQLite driver is used.
+ * By default, the library auto-detects: tries node:sqlite first (Node.js 22.5+),
+ * then falls back to better-sqlite3.
+ *
+ * @param name - Driver name: 'better-sqlite3' or 'node:sqlite'
+ * @throws {Error} If the specified driver is not available
+ *
+ * @example
+ * // Force use of better-sqlite3
+ * setDriver('better-sqlite3');
+ *
+ * @example
+ * // Force use of Node.js built-in sqlite
+ * setDriver('node:sqlite');
+ */
+export declare function setDriver(name: SqliteDriverName): void;
+/**
+ * Get the name of the currently active SQLite driver.
+ *
+ * Returns undefined if no driver has been selected yet (auto-selection
+ * happens on first database operation).
+ *
+ * @returns Current driver name or undefined
+ *
+ * @example
+ * const driver = getActiveDriver();
+ * console.log(`Using ${driver ?? 'auto-detect'}`);
+ */
+export declare function getActiveDriver(): SqliteDriverName | undefined;
 //# sourceMappingURL=index.d.ts.map

package/dist/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,YAAY,EACV,OAAO,EACP,OAAO,EACP,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,eAAe,GAChB,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,GACrB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAGhD,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AA8BxF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,YAAY,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC,CAyD7E;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CA6BzE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,YAAY,EAAE,CAmFpF;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,MAAM,CAiBjF;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,MAAM,CAiBrF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,MAAM,CA4BtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,MAAM,CAgC1E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,YAAY,EACV,OAAO,EACP,OAAO,EACP,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,eAAe,EACf,aAAa,EACb,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EAExB,cAAc,EACd,eAAe,EACf,WAAW,EACX,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,aAAa,EACb,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,UAAU,EAEV,gBAAgB,GACjB,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,2BAA2B,EAE3B,WAAW,EACX,WAAW,EACX,eAAe,EACf,sBAAsB,EACtB,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,EAEd,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACtB,6BAA6B,EAE7B,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,wBAAwB,EACxB,cAAc,EACd,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAGhD,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAiC1M;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,YAAY,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CA2D5F;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CA6BxF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAuFnG;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAiBhG;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAiBpG;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,uBAAuB,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CA8BrF;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,2BAA2B,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAiCzF;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAgBpG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAcxG;AAOD,OAAO,EACL,YAAY,EACZ,aAAa,EACb,cAAc,EACd,WAAW,EACX,mBAAmB,GACpB,MAAM,aAAa,CAAC;AAMrB;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAEtD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,IAAI,gBAAgB,GAAG,SAAS,CAE9D"}