@ncukondo/reference-manager 0.1.0 → 0.3.0

package/dist/cli/server-client.d.ts

@@ -1,4 +1,29 @@
 import type { CslItem } from "../core/csl-json/types.js";
+import type { AddReferencesResult } from "../features/operations/add.js";
+import type { CiteResult } from "../features/operations/cite.js";
+import type { ListOptions, ListResult } from "../features/operations/list.js";
+import type { RemoveResult } from "../features/operations/remove.js";
+import type { SearchOperationOptions, SearchResult } from "../features/operations/search.js";
+import type { UpdateOperationResult } from "../features/operations/update.js";
+/**
+ * Options for addFromInputs method.
+ */
+export interface AddFromInputsOptions {
+    force?: boolean;
+    format?: string;
+}
+/**
+ * Options for cite method.
+ */
+export interface CiteOptions {
+    identifiers: string[];
+    byUuid?: boolean;
+    inText?: boolean;
+    style?: string;
+    cslFile?: string;
+    locale?: string;
+    format?: "text" | "html";
+}
 /**
  * Client for communicating with the reference-manager HTTP server.
  */
@@ -11,11 +36,15 @@ export declare class ServerClient {
      */
     getAll(): Promise<CslItem[]>;
     /**
-     * Find reference by UUID.
-     * @param uuid - Reference UUID
+     * Find reference by identifier.
+     * @param identifier - Citation ID or UUID
+     * @param options - Options object
+     * @param options.byUuid - If true, treat identifier as UUID; otherwise as citation ID
      * @returns CSL item or null if not found
      */
-    findByUuid(uuid: string): Promise<CslItem | null>;
+    find(identifier: string, options?: {
+        byUuid?: boolean;
+    }): Promise<CslItem | null>;
     /**
      * Add new reference to the library.
      * @param item - CSL item to add
@@ -24,15 +53,49 @@ export declare class ServerClient {
     add(item: CslItem): Promise<CslItem>;
     /**
      * Update existing reference.
-     * @param uuid - Reference UUID
-     * @param item - Updated CSL item
-     * @returns Updated CSL item
+     * @param identifier - Citation ID or UUID
+     * @param updates - Partial CSL item with fields to update
+     * @param options - Options object
+     * @param options.byUuid - If true, treat identifier as UUID; otherwise as citation ID
+     * @returns Update operation result
+     */
+    update(identifier: string, updates: Partial<CslItem>, options?: {
+        byUuid?: boolean;
+    }): Promise<UpdateOperationResult>;
+    /**
+     * Remove reference by identifier.
+     * @param identifier - Citation ID or UUID
+     * @param options - Options object
+     * @param options.byUuid - If true, treat identifier as UUID; otherwise as citation ID
+     * @returns Remove operation result
+     */
+    remove(identifier: string, options?: {
+        byUuid?: boolean;
+    }): Promise<RemoveResult>;
+    /**
+     * Add references from various input formats.
+     * @param inputs - Array of inputs (file paths, PMIDs, DOIs)
+     * @param options - Options for add operation
+     * @returns Result containing added, failed, and skipped items
+     */
+    addFromInputs(inputs: string[], options?: AddFromInputsOptions): Promise<AddReferencesResult>;
+    /**
+     * Generate citations for references.
+     * @param options - Cite options including identifiers and formatting
+     * @returns Cite result with per-identifier results
+     */
+    cite(options: CiteOptions): Promise<CiteResult>;
+    /**
+     * List all references with optional formatting.
+     * @param options - List options including format
+     * @returns List result with formatted items
      */
-    update(uuid: string, item: CslItem): Promise<CslItem>;
+    list(options?: ListOptions): Promise<ListResult>;
     /**
-     * Remove reference by UUID.
-     * @param uuid - Reference UUID
+     * Search references with query.
+     * @param options - Search options including query and format
+     * @returns Search result with formatted items
      */
-    remove(uuid: string): Promise<void>;
+    search(options: SearchOperationOptions): Promise<SearchResult>;
 }
 //# sourceMappingURL=server-client.d.ts.map

package/dist/cli/server-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server-client.d.ts","sourceRoot":"","sources":["../../src/cli/server-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEzD;;GAEG;AACH,qBAAa,YAAY;IACX,OAAO,CAAC,OAAO;gBAAP,OAAO,EAAE,MAAM;IAEnC;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAWlC;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAevD;;;;OAIG;IACG,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAe1C;;;;;OAKG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAe3D;;;OAGG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAU1C"}
+{"version":3,"file":"server-client.d.ts","sourceRoot":"","sources":["../../src/cli/server-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,KAAK,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAC7F,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,YAAY;IACX,OAAO,CAAC,OAAO;gBAAP,OAAO,EAAE,MAAM;IAEnC;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAWlC;;;;;;OAMG;IACG,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAkBvF;;;;OAIG;IACG,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAe1C;;;;;;;OAOG;IACG,MAAM,CACV,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,EACzB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7B,OAAO,CAAC,qBAAqB,CAAC;IAkBjC;;;;;;OAMG;IACG,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAgBvF;;;;;OAKG;IACG,aAAa,CACjB,MAAM,EAAE,MAAM,EAAE,EAChB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,mBAAmB,CAAC;IAe/B;;;;OAIG;IACG,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAerD;;;;OAIG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAetD;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC;CAcrE"}