obsidian-mcp-server/dist/services/obsidianRestAPI/methods/periodicNoteMethods.js

Obsidian Knowledge-Management MCP (Model Context Protocol) server that enables AI agents and development tools to interact with an Obsidian vault. It provides a comprehensive suite of tools for reading, writing, searching, and managing notes, tags, and fr

/**
 * @module PeriodicNoteMethods
 * @description
 * Methods for interacting with periodic notes (daily, weekly, etc.) via the Obsidian REST API.
 */
/**
 * Gets the content of a periodic note (daily, weekly, etc.).
 * @param _request - The internal request function from the service instance.
 * @param period - The period type ('daily', 'weekly', 'monthly', 'quarterly', 'yearly').
 * @param format - 'markdown' or 'json'.
 * @param context - Request context.
 * @returns The note content or NoteJson.
 */
export async function getPeriodicNote(_request, period, format = "markdown", context) {
    const acceptHeader = format === "json" ? "application/vnd.olrapi.note+json" : "text/markdown";
    return _request({
        method: "GET",
        url: `/periodic/${period}/`,
        headers: { Accept: acceptHeader },
    }, context, "getPeriodicNote");
}
/**
 * Updates (overwrites) the content of a periodic note. Creates if needed.
 * @param _request - The internal request function from the service instance.
 * @param period - The period type.
 * @param content - The new content.
 * @param context - Request context.
 * @returns {Promise<void>} Resolves on success (204 No Content).
 */
export async function updatePeriodicNote(_request, period, content, context) {
    await _request({
        method: "PUT",
        url: `/periodic/${period}/`,
        headers: { "Content-Type": "text/markdown" },
        data: content,
    }, context, "updatePeriodicNote");
}
/**
 * Appends content to a periodic note. Creates if needed.
 * @param _request - The internal request function from the service instance.
 * @param period - The period type.
 * @param content - The content to append.
 * @param context - Request context.
 * @returns {Promise<void>} Resolves on success (204 No Content).
 */
export async function appendPeriodicNote(_request, period, content, context) {
    await _request({
        method: "POST",
        url: `/periodic/${period}/`,
        headers: { "Content-Type": "text/markdown" },
        data: content,
    }, context, "appendPeriodicNote");
}
/**
 * Deletes a periodic note.
 * @param _request - The internal request function from the service instance.
 * @param period - The period type.
 * @param context - Request context.
 * @returns {Promise<void>} Resolves on success (204 No Content).
 */
export async function deletePeriodicNote(_request, period, context) {
    await _request({
        method: "DELETE",
        url: `/periodic/${period}/`,
    }, context, "deletePeriodicNote");
}