zotero-bridge 1.0.1

package/dist/database.d.ts

@@ -0,0 +1,280 @@
+/**
+ * ZoteroBridge - Zotero SQLite Database Connection Module
+ *
+ * This module provides direct access to Zotero's SQLite database (zotero.sqlite)
+ * for reading and writing reference data.
+ *
+ * Uses sql.js for pure JavaScript SQLite support (no native compilation required)
+ *
+ * @author Combjellyshen
+ */
+import { Database as SqlJsDatabase } from 'sql.js';
+export interface ZoteroItem {
+    itemID: number;
+    key: string;
+    itemTypeID: number;
+    dateAdded: string;
+    dateModified: string;
+    libraryID: number;
+}
+export interface ZoteroCollection {
+    collectionID: number;
+    collectionName: string;
+    parentCollectionID: number | null;
+    key: string;
+    libraryID: number;
+}
+export interface ZoteroTag {
+    tagID: number;
+    name: string;
+    type: number;
+}
+export interface ZoteroAttachment {
+    itemID: number;
+    path: string | null;
+    contentType: string | null;
+}
+export declare class ZoteroDatabase {
+    private db;
+    private dbPath;
+    private readonly;
+    private SQL;
+    constructor(dbPath?: string, readonly?: boolean);
+    /**
+     * Find the default Zotero database path based on OS
+     */
+    private findDefaultZoteroDB;
+    /**
+     * Connect to the Zotero database
+     */
+    connect(): Promise<void>;
+    /**
+     * Save changes to the database file
+     */
+    save(): void;
+    /**
+     * Disconnect from the database
+     */
+    disconnect(): void;
+    /**
+     * Get the database instance
+     */
+    getDB(): Promise<SqlJsDatabase>;
+    /**
+     * Get database path
+     */
+    getPath(): string;
+    /**
+     * Execute a query and return all results
+     */
+    private queryAll;
+    /**
+     * Execute a query and return the first result
+     */
+    private queryOne;
+    /**
+     * Execute a statement (INSERT, UPDATE, DELETE)
+     */
+    private execute;
+    /**
+     * Get all collections
+     */
+    getCollections(libraryID?: number): ZoteroCollection[];
+    /**
+     * Get collection by ID
+     */
+    getCollectionById(collectionID: number): ZoteroCollection | null;
+    /**
+     * Get collection by name
+     */
+    getCollectionByName(name: string, libraryID?: number): ZoteroCollection | null;
+    /**
+     * Get subcollections of a collection
+     */
+    getSubcollections(parentCollectionID: number): ZoteroCollection[];
+    /**
+     * Create a new collection
+     */
+    createCollection(name: string, parentCollectionID?: number | null, libraryID?: number): number;
+    /**
+     * Rename a collection
+     */
+    renameCollection(collectionID: number, newName: string): boolean;
+    /**
+     * Move a collection to a new parent
+     */
+    moveCollection(collectionID: number, newParentID: number | null): boolean;
+    /**
+     * Delete a collection
+     */
+    deleteCollection(collectionID: number): boolean;
+    /**
+     * Get all tags with usage count
+     */
+    getTags(): any[];
+    /**
+     * Get tag by name
+     */
+    getTagByName(name: string): any | null;
+    /**
+     * Create a new tag
+     */
+    createTag(name: string, _type?: number): number;
+    /**
+     * Add tag to item
+     */
+    addTagToItem(itemID: number, tagName: string, type?: number): boolean;
+    /**
+     * Remove tag from item
+     */
+    removeTagFromItem(itemID: number, tagName: string): boolean;
+    /**
+     * Get all tags for an item
+     * Note: type is in itemTags table, not tags table
+     */
+    getItemTags(itemID: number): any[];
+    /**
+     * Get items in a collection
+     */
+    getCollectionItems(collectionID: number): ZoteroItem[];
+    /**
+     * Add item to collection
+     */
+    addItemToCollection(itemID: number, collectionID: number): boolean;
+    /**
+     * Remove item from collection
+     */
+    removeItemFromCollection(itemID: number, collectionID: number): boolean;
+    /**
+     * Get item by key
+     */
+    getItemByKey(key: string): ZoteroItem | null;
+    /**
+     * Search items by title
+     */
+    searchItems(query: string, limit?: number, libraryID?: number): any[];
+    /**
+     * Get item details with all fields
+     */
+    getItemDetails(itemID: number): Record<string, any>;
+    /**
+     * Get item abstract
+     */
+    getItemAbstract(itemID: number): string | null;
+    /**
+     * Set item abstract
+     */
+    setItemAbstract(itemID: number, abstract: string): boolean;
+    /**
+     * Get item notes
+     */
+    getItemNotes(itemID: number): any[];
+    /**
+     * Add note to item
+     */
+    addItemNote(parentItemID: number, noteContent: string, title?: string): number;
+    /**
+     * Get attachment path
+     */
+    getAttachmentPath(itemID: number): string | null;
+    /**
+     * Get PDF attachments for an item
+     */
+    getPDFAttachments(parentItemID: number): ZoteroAttachment[];
+    /**
+     * Get storage directory path
+     */
+    getStoragePath(): string;
+    /**
+     * Find item by DOI
+     */
+    findItemByDOI(doi: string): any | null;
+    /**
+     * Find item by ISBN
+     */
+    findItemByISBN(isbn: string): any | null;
+    /**
+     * Find item by any identifier (DOI, ISBN, PMID, arXiv, etc.)
+     */
+    findItemByIdentifier(identifier: string, type?: string): any | null;
+    /**
+     * Get all annotations for an item's attachments
+     */
+    getItemAnnotations(parentItemID: number): any[];
+    /**
+     * Get annotations from a specific attachment
+     */
+    getAttachmentAnnotations(attachmentID: number): any[];
+    /**
+     * Get annotations filtered by type
+     */
+    getAnnotationsByType(parentItemID: number, types: string[]): any[];
+    /**
+     * Get annotations filtered by color
+     */
+    getAnnotationsByColor(parentItemID: number, colors: string[]): any[];
+    /**
+     * Search annotations by text content
+     */
+    searchAnnotations(query: string, parentItemID?: number): any[];
+    /**
+     * Search in Zotero's fulltext index
+     * fulltextWords: wordID, word
+     * fulltextItemWords: wordID, itemID
+     */
+    searchFulltext(query: string, libraryID?: number): any[];
+    /**
+     * Get fulltext content for an attachment
+     * Note: fulltextContent table may not exist in all Zotero versions
+     */
+    getFulltextContent(attachmentID: number): string | null;
+    /**
+     * Get fulltext index status for an item
+     */
+    getFulltextStatus(attachmentID: number): any;
+    /**
+     * Advanced fulltext search with context
+     */
+    searchFulltextWithContext(query: string, contextLength?: number, libraryID?: number): any[];
+    /**
+     * Get related items (manually linked)
+     */
+    getRelatedItems(itemID: number): any[];
+    /**
+     * Find similar items by shared tags
+     */
+    findSimilarByTags(itemID: number, minSharedTags?: number): any[];
+    /**
+     * Find similar items by shared creators
+     */
+    findSimilarByCreators(itemID: number): any[];
+    /**
+     * Find similar items by shared collection
+     */
+    findSimilarByCollection(itemID: number): any[];
+    /**
+     * Generate a unique Zotero key
+     *
+     * Zotero uses a specific character set that excludes ambiguous characters:
+     * - No '0' (zero) - confused with 'O'
+     * - No '1' (one) - confused with 'I' or 'L'
+     * - No 'I' - confused with '1' or 'L'
+     * - No 'L' - confused with '1' or 'I'
+     * - No 'O' - confused with '0'
+     *
+     * Valid characters: 23456789ABCDEFGHJKMNPQRSTUVWXYZ
+     */
+    private generateKey;
+    /**
+     * Execute a raw SQL query
+     */
+    query(sql: string, params?: any[]): any[];
+    /**
+     * Execute a raw SQL statement
+     */
+    run(sql: string, params?: any[]): {
+        changes: number;
+        lastInsertRowid: number;
+    };
+}
+//# sourceMappingURL=database.d.ts.map

package/dist/database.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.d.ts","sourceRoot":"","sources":["../src/database.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAkB,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,QAAQ,CAAC;AAK9D,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,qBAAa,cAAc;IACzB,OAAO,CAAC,EAAE,CAA8B;IACxC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,GAAG,CAAa;gBAEZ,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAe;IAKtD;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAqC3B;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAqB9B;;OAEG;IACH,IAAI,IAAI,IAAI;IAUZ;;OAEG;IACH,UAAU,IAAI,IAAI;IAUlB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,aAAa,CAAC;IAOrC;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACH,OAAO,CAAC,QAAQ;IAkBhB;;OAEG;IACH,OAAO,CAAC,QAAQ;IAKhB;;OAEG;IACH,OAAO,CAAC,OAAO;IAoBf;;OAEG;IACH,cAAc,CAAC,SAAS,GAAE,MAAU,GAAG,gBAAgB,EAAE;IASzD;;OAEG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,gBAAgB,GAAG,IAAI;IAQhE;;OAEG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,GAAE,MAAU,GAAG,gBAAgB,GAAG,IAAI;IAQjF;;OAEG;IACH,iBAAiB,CAAC,kBAAkB,EAAE,MAAM,GAAG,gBAAgB,EAAE;IASjE;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,kBAAkB,GAAE,MAAM,GAAG,IAAW,EAAE,SAAS,GAAE,MAAU,GAAG,MAAM;IAevG;;OAEG;IACH,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;IAchE;;OAEG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;IAczE;;OAEG;IACH,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IAkB/C;;OAEG;IACH,OAAO,IAAI,GAAG,EAAE;IAUhB;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI;IAItC;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAU,GAAG,MAAM;IAgBlD;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,MAAU,GAAG,OAAO;IAsBxE;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;IAe3D;;;OAGG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE;IAclC;;OAEG;IACH,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,EAAE;IAStD;;OAEG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO;IAmBlE;;OAEG;IACH,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO;IAUvE;;OAEG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAQ5C;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,EAAE,SAAS,GAAE,MAAU,GAAG,GAAG,EAAE;IAgB5E;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IA2DnD;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAW9C;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAqC1D;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE;IAQnC;;OAEG;IACH,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,MAAM;IAsClF;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAsBhD;;OAEG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,gBAAgB,EAAE;IAQ3D;;OAEG;IACH,cAAc,IAAI,MAAM;IASxB;;OAEG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI;IAoBtC;;OAEG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI;IAoBxC;;OAEG;IACH,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI;IA8CnE;;OAEG;IACH,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG,EAAE;IAuB/C;;OAEG;IACH,wBAAwB,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG,EAAE;IAsBrD;;OAEG;IACH,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,EAAE;IAuBlE;;OAEG;IACH,qBAAqB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,EAAE;IAuBpE;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,GAAG,EAAE;IAgC9D;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,GAAE,MAAU,GAAG,GAAG,EAAE;IA2B3D;;;OAGG;IACH,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAkCvD;;OAEG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG;IAc5C;;OAEG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,GAAE,MAAY,EAAE,SAAS,GAAE,MAAU,GAAG,GAAG,EAAE;IAyCnG;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE;IA2BtC;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,GAAE,MAAU,GAAG,GAAG,EAAE;IAqBnE;;OAEG;IACH,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE;IAkB5C;;OAEG;IACH,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,EAAE;IAqB9C;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,WAAW;IASnB;;OAEG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,GAAG,EAAO,GAAG,GAAG,EAAE;IAI7C;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,GAAG,EAAO,GAAG;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAA;KAAE;CAGnF"}