@aniketbiswas/obsidian-mcp-server 1.0.0

package/build/types/obsidian.d.ts

@@ -0,0 +1,329 @@
+/**
+ * ============================================================================
+ * OBSIDIAN MCP - Type Definitions
+ * ============================================================================
+ *
+ * Comprehensive TypeScript type definitions for the Obsidian Local REST API
+ * and internal MCP server data structures.
+ *
+ * These types ensure type safety throughout the codebase and provide
+ * excellent IDE support with autocompletion and error checking.
+ * ============================================================================
+ */
+/**
+ * Configuration for connecting to Obsidian's Local REST API.
+ * These values can be set via environment variables.
+ */
+export interface ObsidianConfig {
+    /** API key from Obsidian Local REST API plugin settings */
+    apiKey: string;
+    /** Host where Obsidian is running (default: 127.0.0.1) */
+    host: string;
+    /** Port for the REST API (default: 27124) */
+    port: number;
+    /** Whether to use HTTPS (default: true) */
+    secure: boolean;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout: number;
+    /** Whether to verify SSL certificates (default: false for self-signed) */
+    verifySsl: boolean;
+}
+/**
+ * Default configuration values
+ */
+export declare const DEFAULT_CONFIG: Omit<ObsidianConfig, "apiKey">;
+/**
+ * Basic server status information returned by GET /
+ */
+export interface ServerStatus {
+    status: string;
+    versions: {
+        obsidian: string;
+        self: string;
+    };
+    service: string;
+    authenticated: boolean;
+}
+/**
+ * Represents a file or directory in the vault
+ */
+export interface VaultItem {
+    /** File or directory name */
+    name: string;
+    /** Full path from vault root */
+    path: string;
+    /** Type of item */
+    type: "file" | "directory";
+    /** File extension (for files only) */
+    extension?: string;
+    /** File size in bytes (for files only) */
+    size?: number;
+    /** Creation timestamp */
+    ctime?: number;
+    /** Modification timestamp */
+    mtime?: number;
+}
+/**
+ * Directory listing response
+ */
+export interface DirectoryListing {
+    files: string[];
+}
+/**
+ * Note content with optional metadata
+ */
+export interface NoteContent {
+    /** Raw markdown content */
+    content: string;
+    /** File path */
+    path: string;
+    /** Parsed frontmatter (if any) */
+    frontmatter?: Record<string, unknown>;
+    /** Content without frontmatter */
+    body?: string;
+}
+/**
+ * Search result from the vault
+ */
+export interface SearchResult {
+    /** Path to the matching file */
+    filename: string;
+    /** Relevance score */
+    score?: number;
+    /** Matching content snippets */
+    matches?: SearchMatch[];
+}
+/**
+ * Individual search match within a file
+ */
+export interface SearchMatch {
+    /** Match context/snippet */
+    match: string;
+    /** Position information */
+    position?: {
+        start: number;
+        end: number;
+    };
+}
+/**
+ * Response from POST /search
+ */
+export interface SearchResponse {
+    results: SearchResult[];
+}
+/**
+ * Available command in Obsidian
+ */
+export interface ObsidianCommand {
+    /** Unique command ID */
+    id: string;
+    /** Human-readable name */
+    name: string;
+}
+/**
+ * Commands list response
+ */
+export interface CommandsResponse {
+    commands: ObsidianCommand[];
+}
+/**
+ * Supported periodic note periods
+ */
+export type PeriodicNotePeriod = "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
+/**
+ * Periodic note date specification
+ */
+export interface PeriodicNoteDate {
+    year: number;
+    month: number;
+    day: number;
+}
+/**
+ * Supported patch operations for note content
+ */
+export type PatchOperation = "append" | "prepend" | "replace" | "insert-after" | "insert-before" | "insert-under-heading";
+/**
+ * Options for patching note content
+ */
+export interface PatchOptions {
+    /** The operation to perform */
+    operation: PatchOperation;
+    /** Content to insert/append/prepend */
+    content: string;
+    /** Target heading (for heading-based operations) */
+    heading?: string;
+    /** Target text to find (for insert-before/after operations) */
+    targetText?: string;
+    /** Line number for line-based operations */
+    lineNumber?: number;
+    /** Whether to create the file if it doesn't exist */
+    createIfNotExists?: boolean;
+}
+/**
+ * Standard frontmatter properties
+ */
+export interface StandardFrontmatter {
+    /** Note title */
+    title?: string;
+    /** Array of tags */
+    tags?: string[];
+    /** Aliases for the note */
+    aliases?: string[];
+    /** Creation date */
+    created?: string;
+    /** Last modified date */
+    modified?: string;
+    /** CSS classes to apply */
+    cssclass?: string;
+    /** Whether to publish the note */
+    publish?: boolean;
+    /** Custom properties */
+    [key: string]: unknown;
+}
+/**
+ * Represents a link between notes
+ */
+export interface NoteLink {
+    /** Source file path */
+    source: string;
+    /** Target file path or link text */
+    target: string;
+    /** Display text of the link */
+    displayText?: string;
+    /** Whether this is an embed (![[link]]) */
+    isEmbed?: boolean;
+    /** Link type */
+    type: "internal" | "external" | "tag";
+}
+/**
+ * Backlink information
+ */
+export interface Backlink {
+    /** Path of the file containing the backlink */
+    sourcePath: string;
+    /** Context around the link */
+    context?: string;
+    /** Line number where the link appears */
+    lineNumber?: number;
+}
+/**
+ * Template for creating new notes
+ */
+export interface NoteTemplate {
+    /** Template name */
+    name: string;
+    /** Template content */
+    content: string;
+    /** Default frontmatter */
+    frontmatter?: StandardFrontmatter;
+    /** Folder to create the note in */
+    folder?: string;
+}
+/**
+ * Error response from the API
+ */
+export interface ApiError {
+    /** Error code */
+    code: string;
+    /** Error message */
+    message: string;
+    /** HTTP status code */
+    status: number;
+    /** Additional error details */
+    details?: Record<string, unknown>;
+}
+/**
+ * Custom error class for Obsidian API errors
+ */
+export declare class ObsidianApiError extends Error {
+    readonly code: string;
+    readonly status: number;
+    readonly details?: Record<string, unknown>;
+    constructor(error: ApiError);
+}
+/**
+ * Standard success response structure
+ */
+export interface ToolSuccessResponse {
+    success: true;
+    message: string;
+    data?: unknown;
+}
+/**
+ * Standard error response structure
+ */
+export interface ToolErrorResponse {
+    success: false;
+    error: string;
+    code?: string;
+}
+/**
+ * Combined tool response type
+ */
+export type ToolResponse = ToolSuccessResponse | ToolErrorResponse;
+/**
+ * Options for listing vault contents
+ */
+export interface ListVaultOptions {
+    /** Directory path to list (default: root) */
+    path?: string;
+    /** Whether to include subdirectories recursively */
+    recursive?: boolean;
+    /** File extensions to filter by */
+    extensions?: string[];
+    /** Maximum depth for recursive listing */
+    maxDepth?: number;
+}
+/**
+ * Options for creating a new note
+ */
+export interface CreateNoteOptions {
+    /** File path for the note */
+    path: string;
+    /** Note content */
+    content: string;
+    /** Whether to overwrite if exists */
+    overwrite?: boolean;
+    /** Frontmatter to include */
+    frontmatter?: StandardFrontmatter;
+    /** Whether to create parent directories */
+    createFolders?: boolean;
+}
+/**
+ * Options for reading a note
+ */
+export interface ReadNoteOptions {
+    /** File path */
+    path: string;
+    /** Whether to parse frontmatter */
+    parseFrontmatter?: boolean;
+    /** Whether to include file stats */
+    includeStats?: boolean;
+}
+/**
+ * Options for updating a note
+ */
+export interface UpdateNoteOptions {
+    /** File path */
+    path: string;
+    /** New content (replaces entire file) */
+    content?: string;
+    /** Patch options for partial updates */
+    patch?: PatchOptions;
+}
+/**
+ * Options for searching the vault
+ */
+export interface SearchOptions {
+    /** Search query */
+    query: string;
+    /** Folder to search in */
+    folder?: string;
+    /** File extensions to include */
+    extensions?: string[];
+    /** Maximum number of results */
+    limit?: number;
+    /** Whether to include content snippets */
+    includeSnippets?: boolean;
+}
+//# sourceMappingURL=obsidian.d.ts.map

package/build/types/obsidian.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"obsidian.d.ts","sourceRoot":"","sources":["../../src/types/obsidian.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAMH;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,MAAM,EAAE,OAAO,CAAC;IAChB,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAMzD,CAAC;AAMF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE;QACR,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,QAAQ,CAAC,EAAE;QACT,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B;AAMD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAMD;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,SAAS,GACT,SAAS,GACT,cAAc,GACd,eAAe,GACf,sBAAsB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,SAAS,EAAE,cAAc,CAAC;IAC1B,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,oBAAoB;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wBAAwB;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAMD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB;IAChB,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,KAAK,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,0BAA0B;IAC1B,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAMD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAEtC,KAAK,EAAE,QAAQ;CAO5B;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,IAAI,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAMnE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,2CAA2C;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,oCAAoC;IACpC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B"}

package/build/types/obsidian.js

@@ -0,0 +1,38 @@
+/**
+ * ============================================================================
+ * OBSIDIAN MCP - Type Definitions
+ * ============================================================================
+ *
+ * Comprehensive TypeScript type definitions for the Obsidian Local REST API
+ * and internal MCP server data structures.
+ *
+ * These types ensure type safety throughout the codebase and provide
+ * excellent IDE support with autocompletion and error checking.
+ * ============================================================================
+ */
+/**
+ * Default configuration values
+ */
+export const DEFAULT_CONFIG = {
+    host: "127.0.0.1",
+    port: 27124,
+    secure: true,
+    timeout: 30000,
+    verifySsl: false,
+};
+/**
+ * Custom error class for Obsidian API errors
+ */
+export class ObsidianApiError extends Error {
+    code;
+    status;
+    details;
+    constructor(error) {
+        super(error.message);
+        this.name = "ObsidianApiError";
+        this.code = error.code;
+        this.status = error.status;
+        this.details = error.details;
+    }
+}
+//# sourceMappingURL=obsidian.js.map

package/build/types/obsidian.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"obsidian.js","sourceRoot":"","sources":["../../src/types/obsidian.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAyBH;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAmC;IAC5D,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,KAAK;IACX,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,KAAK;IACd,SAAS,EAAE,KAAK;CACjB,CAAC;AA8PF;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzB,IAAI,CAAS;IACb,MAAM,CAAS;IACf,OAAO,CAA2B;IAElD,YAAY,KAAe;QACzB,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IAC/B,CAAC;CACF"}

package/build/utils/client.d.ts

@@ -0,0 +1,201 @@
+/**
+ * ============================================================================
+ * OBSIDIAN MCP - Obsidian REST API Client
+ * ============================================================================
+ *
+ * A robust HTTP client for interacting with Obsidian's Local REST API.
+ * Features:
+ * - Automatic authentication
+ * - Error handling with detailed error messages
+ * - Support for all REST API endpoints
+ * - Request timeout handling
+ * - SSL/TLS configuration for self-signed certificates
+ * ============================================================================
+ */
+import { ObsidianConfig, ServerStatus, VaultItem, NoteContent, SearchResult, ObsidianCommand, PatchOptions, PeriodicNotePeriod, PeriodicNoteDate, StandardFrontmatter } from "../types/obsidian.js";
+/**
+ * Obsidian REST API Client
+ *
+ * Provides a type-safe interface for all Obsidian Local REST API operations.
+ */
+export declare class ObsidianClient {
+    private readonly config;
+    private readonly baseUrl;
+    private readonly agent;
+    constructor(config: ObsidianConfig);
+    /**
+     * Get server status and version information.
+     */
+    getServerStatus(): Promise<ServerStatus>;
+    /**
+     * Check if the server is reachable and authenticated.
+     */
+    healthCheck(): Promise<boolean>;
+    /**
+     * Get the list of available commands in Obsidian.
+     */
+    getCommands(): Promise<ObsidianCommand[]>;
+    /**
+     * Execute a command in Obsidian.
+     * @param commandId - The ID of the command to execute
+     */
+    executeCommand(commandId: string): Promise<void>;
+    /**
+     * List files in the vault root or a specific directory.
+     * @param path - Optional directory path (relative to vault root)
+     */
+    listDirectory(path?: string): Promise<string[]>;
+    /**
+     * List all files in the vault recursively.
+     * @param basePath - Starting path for the listing
+     * @param maxDepth - Maximum recursion depth (default: 10)
+     */
+    listAllFiles(basePath?: string, maxDepth?: number): Promise<VaultItem[]>;
+    /**
+     * Recursive helper for listing files.
+     */
+    private listFilesRecursive;
+    /**
+     * Get the content of a file from the vault.
+     * @param path - File path relative to vault root
+     */
+    getFile(path: string): Promise<string>;
+    /**
+     * Get a note with parsed frontmatter.
+     * @param path - File path relative to vault root
+     */
+    getNote(path: string): Promise<NoteContent>;
+    /**
+     * Create or replace a file in the vault.
+     * @param path - File path relative to vault root
+     * @param content - File content
+     */
+    putFile(path: string, content: string): Promise<void>;
+    /**
+     * Create a note with frontmatter.
+     * @param path - File path relative to vault root
+     * @param content - Note content (without frontmatter)
+     * @param frontmatter - Frontmatter properties
+     */
+    createNote(path: string, content: string, frontmatter?: StandardFrontmatter): Promise<void>;
+    /**
+     * Append content to a file.
+     * @param path - File path relative to vault root
+     * @param content - Content to append
+     */
+    appendToFile(path: string, content: string): Promise<void>;
+    /**
+     * Patch a file with specific operations.
+     * @param path - File path relative to vault root
+     * @param content - Content for the patch operation
+     * @param options - Patch operation options
+     */
+    patchFile(path: string, content: string, options?: Partial<PatchOptions>): Promise<void>;
+    /**
+     * Delete a file from the vault.
+     * @param path - File path relative to vault root
+     */
+    deleteFile(path: string): Promise<void>;
+    /**
+     * Get the content of the currently active file in Obsidian.
+     */
+    getActiveFile(): Promise<NoteContent | null>;
+    /**
+     * Update the content of the currently active file.
+     * @param content - New content for the file
+     */
+    updateActiveFile(content: string): Promise<void>;
+    /**
+     * Append content to the currently active file.
+     * @param content - Content to append
+     */
+    appendToActiveFile(content: string): Promise<void>;
+    /**
+     * Patch the currently active file.
+     * @param content - Content for the patch operation
+     * @param options - Patch options
+     */
+    patchActiveFile(content: string, options?: Partial<PatchOptions>): Promise<void>;
+    /**
+     * Delete the currently active file.
+     */
+    deleteActiveFile(): Promise<void>;
+    /**
+     * Open a file in the Obsidian UI.
+     * @param path - File path relative to vault root
+     * @param newLeaf - Whether to open in a new pane
+     */
+    openFile(path: string, newLeaf?: boolean): Promise<void>;
+    /**
+     * Search the vault using Obsidian's query syntax.
+     * @param query - Search query (supports Obsidian search syntax)
+     */
+    search(query: string): Promise<SearchResult[]>;
+    /**
+     * Simple text search across the vault.
+     * @param query - Plain text to search for
+     */
+    simpleSearch(query: string): Promise<SearchResult[]>;
+    /**
+     * Get the current periodic note for a given period.
+     * @param period - The period type (daily, weekly, monthly, quarterly, yearly)
+     */
+    getCurrentPeriodicNote(period: PeriodicNotePeriod): Promise<NoteContent | null>;
+    /**
+     * Get a periodic note for a specific date.
+     * @param period - The period type
+     * @param date - The specific date
+     */
+    getPeriodicNote(period: PeriodicNotePeriod, date: PeriodicNoteDate): Promise<NoteContent | null>;
+    /**
+     * Append content to the current periodic note.
+     * @param period - The period type
+     * @param content - Content to append
+     */
+    appendToPeriodicNote(period: PeriodicNotePeriod, content: string): Promise<void>;
+    /**
+     * Append content to a periodic note for a specific date.
+     * @param period - The period type
+     * @param date - The specific date
+     * @param content - Content to append
+     */
+    appendToPeriodicNoteByDate(period: PeriodicNotePeriod, date: PeriodicNoteDate, content: string): Promise<void>;
+    /**
+     * Update the content of the current periodic note.
+     * @param period - The period type
+     * @param content - New content
+     */
+    updatePeriodicNote(period: PeriodicNotePeriod, content: string): Promise<void>;
+    /**
+     * Patch the current periodic note.
+     * @param period - The period type
+     * @param content - Patch content
+     * @param options - Patch options
+     */
+    patchPeriodicNote(period: PeriodicNotePeriod, content: string, options?: Partial<PatchOptions>): Promise<void>;
+    /**
+     * Delete the current periodic note.
+     * @param period - The period type
+     */
+    deletePeriodicNote(period: PeriodicNotePeriod): Promise<void>;
+    /**
+     * Make an HTTP request to the Obsidian API.
+     */
+    private request;
+}
+/**
+ * Get or create the singleton Obsidian client instance.
+ * @param config - Configuration (only used on first call)
+ */
+export declare function getClient(config: ObsidianConfig): ObsidianClient;
+/**
+ * Create a new Obsidian client instance.
+ * @param config - Configuration for the client
+ */
+export declare function createClient(config: ObsidianConfig): ObsidianClient;
+/**
+ * Reset the singleton client instance.
+ * Useful for testing or reconnecting with different config.
+ */
+export declare function resetClient(): void;
+//# sourceMappingURL=client.d.ts.map

package/build/utils/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/utils/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAIH,OAAO,EACL,cAAc,EACd,YAAY,EACZ,SAAS,EACT,WAAW,EACX,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,kBAAkB,EAClB,gBAAgB,EAEhB,mBAAmB,EACpB,MAAM,sBAAsB,CAAC;AA8B9B;;;;GAIG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA2B;gBAErC,MAAM,EAAE,cAAc;IAkBlC;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC;IAQ9C;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IASrC;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAQ/C;;;OAGG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWtD;;;OAGG;IACG,aAAa,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IASrD;;;;OAIG;IACG,YAAY,CAAC,QAAQ,GAAE,MAAW,EAAE,QAAQ,GAAE,MAAW,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMtF;;OAEG;YACW,kBAAkB;IAwChC;;;OAGG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ5C;;;OAGG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAYjD;;;;OAIG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS3D;;;;;OAKG;IACG,UAAU,CACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,mBAAmB,GAChC,OAAO,CAAC,IAAI,CAAC;IAWhB;;;;OAIG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAShE;;;;;OAKG;IACG,SAAS,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,OAAO,CAAC,YAAY,CAAM,GAClC,OAAO,CAAC,IAAI,CAAC;IA4BhB;;;OAGG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAW7C;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAwBlD;;;OAGG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAStD;;;OAGG;IACG,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASxD;;;;OAIG;IACG,eAAe,CACnB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,OAAO,CAAC,YAAY,CAAM,GAClC,OAAO,CAAC,IAAI,CAAC;IAsBhB;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAWvC;;;;OAIG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAYrE;;;OAGG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAUpD;;;OAGG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAc1D;;;OAGG;IACG,sBAAsB,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAwBrF;;;;OAIG;IACG,eAAe,CACnB,MAAM,EAAE,kBAAkB,EAC1B,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAwB9B;;;;OAIG;IACG,oBAAoB,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAStF;;;;;OAKG;IACG,0BAA0B,CAC9B,MAAM,EAAE,kBAAkB,EAC1B,IAAI,EAAE,gBAAgB,EACtB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC;IAShB;;;;OAIG;IACG,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASpF;;;;;OAKG;IACG,iBAAiB,CACrB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,OAAO,CAAC,YAAY,CAAM,GAClC,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;OAGG;IACG,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWnE;;OAEG;YACW,OAAO;CA0HtB;AAgBD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAKhE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAEnE;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAElC"}