kindle_to_np3.user.js

// ==UserScript==
// @name        Kindle Noteplan3 X-Callbacks
// @namespace   Violentmonkey Scripts
// @match *://read.amazon.com/*
// @grant       GM.setValue
// @grant       GM.getValue
// @version     2.4
// @author      John Collins
// @description Adds links for creating notes with highlights automatically
// @downloadURL https://raw.githubusercontent.com/jlc467/np3_user_scripts/main/kindle_to_np3.user.js
// @updateURL https://raw.githubusercontent.com/jlc467/np3_user_scripts/main/kindle_to_np3.user.js
// ==/UserScript==

// Changelog
//  2.4 July 18, 2022
//    Fix: Use kp-annotation-location for annotation location, which works with page numbers
//    Fix: Kindle URL when using Copy wasn't working, now using decodeURIComponent

(function () {
  var currentTitle;
  var allAnnotationMD = "";
  var exportData = {};
  var locations = [];
  var exportElements = [];
  function startScript() {
    setInterval(detectChange, 1000);
  }

  // used to detect if user has navigated to new book
  async function detectChange() {
    try {
      let newTitle = getTitle();
      if (!newTitle) {
        //console.log("empty new title");
        return;
      }
      if (!getAnnotationsElementArray().length) {
        //console.log("empty annotations");
        return;
      }
      if (newTitle !== currentTitle) {
        currentTitle = newTitle;
        //console.log("title changed!");
        try {
          exportData = await GM.getValue(getBookASIN(), {});
        } catch (err) {}
        cleanup();
        addActions();
      }
    } catch (err) {
      console.log("detectChange ~ err", err);
    }
  }

  // adds x-callback anchor tags to title of book and individual annotations
  function addActions() {
    var authors = getAuthors();

    getAnnotationsElementArray().forEach(renderAnnotation);

    addTitleLinks(allAnnotationMD, authors);
  }

  function renderAnnotation(a) {
    try {
      var annotationMD = "";

      const annotationElement = getAnnotationElement(a);

      if (!annotationElement) {
        // haven't seen this yet but guess it can happen
        return;
      }
      var authors = getAuthors();
      var highlightText = getHighlightText(a);
      var noteText = getNoteText(a);
      var location = getLocation(a);
      var link = getMDLinkToNote(a);
      var exportedStatusElement;
      if (location) {
        exportedStatusElement = getExportedStatus(location);
        exportElements.push(exportedStatusElement);
      }

      if (noteText) {
        annotationMD += "\n- " + noteText;
        if (link) {
          annotationMD += link;
        }
      }
      if (highlightText) {
        annotationMD += "\n> " + highlightText.replace("\n", "\n> ");
        if (link) {
          annotationMD += link;
        }
      }

      allAnnotationMD += annotationMD + "\n";
      if (location) {
        locations.push(location);
      }
      appendPipeSeperator(annotationElement);

      annotationElement.appendChild(
        getAddSingleHighlightLink(
          annotationMD,
          `${currentTitle}${location ? ` location ${location}` : ""}`,
          authors,
          location,
          exportedStatusElement
        )
      );

      appendPipeSeperator(annotationElement);

      annotationElement.appendChild(
        getAddToExistingLink(
          annotationMD,
          currentTitle,
          location,
          exportedStatusElement
        )
      );

      appendPipeSeperator(annotationElement);

      annotationElement.appendChild(getClipboardLink(annotationMD));
      if (exportedStatusElement) {
        appendPipeSeperator(annotationElement);
        annotationElement.appendChild(exportedStatusElement);
      }
    } catch (err) {
      console.log("getAnnotationsElementArray forEach ~ err", err);
    }
  }

  // adds links near title of book, uses all annotations for book
  function addTitleLinks(allAnnotationMD, authors) {
    const authorsElement = getAuthorsElement();
    var topLevelLinkContainerElement = document.createElement("div");
    topLevelLinkContainerElement.appendChild(
      getAddSingleHighlightLink(allAnnotationMD, currentTitle, authors)
    );
    appendPipeSeperator(topLevelLinkContainerElement);
    topLevelLinkContainerElement.appendChild(getClipboardLink(allAnnotationMD));

    appendPipeSeperator(topLevelLinkContainerElement);
    topLevelLinkContainerElement.appendChild(getExportedStatus());
    authorsElement.parentNode.insertBefore(
      topLevelLinkContainerElement,
      authorsElement.nextSibling
    );
  }

  // creates new note
  function getAddSingleHighlightLink(text, title, authors, loc, exportStatus) {
    var a = document.createElement("a");
    var linkText = document.createTextNode("new");
    var textWithAuthor = `Author(s): ${authors}\n${text}`;
    var textWithFrontMatter = getFrontMatterMeta() + text;
    a.appendChild(linkText);
    a.className = "a-size-small a-color-secondary np3";
    a.title =
      "Create note with this highlight in NP3. Title of note will be the title of book.";
    a.href = `noteplan://x-callback-url/addNote?noteTitle=${encodeURIComponent(
      title
    )}&openNote=yes&text=${encodeURIComponent(textWithFrontMatter)}`;
    if (loc) {
      a.addEventListener("click", () => {
        setExport(loc, exportStatus);
      });
    } else {
      a.addEventListener("click", () => {
        var d = new Date().toISOString();
        var dRender = new Date(d).toLocaleString();
        locations.forEach((loc) => {
          exportData[loc] = d;
        });
        exportElements.forEach((ele) => {
          ele.innerHTML = dRender;
        });
        GM.setValue(`${getBookASIN()}`, exportData);
        document.getElementById("top-export-count").innerHTML =
          getTopExportCount();
      });
    }
    return a;
  }

  // appends to existing note
  function getAddToExistingLink(text, title, loc, exportStatus) {
    var a = document.createElement("a");
    var linkText = document.createTextNode("append");
    a.appendChild(linkText);
    a.className = "a-size-small a-color-secondary np3";
    a.title =
      "Add to existing note in NP3, assuming note title is the title of book.";
    a.href = `noteplan://x-callback-url/addText?noteTitle=${encodeURIComponent(
      title
    )}&text=${text}&mode=append`;
    if (loc) {
      a.addEventListener("click", () => {
        setExport(loc, exportStatus);
      });
    }
    return a;
  }

  // copies to clipboard
  function getClipboardLink(text) {
    var a = document.createElement("a");
    var linkText = document.createTextNode("copy");
    a.appendChild(linkText);
    a.className = "a-size-small a-color-secondary np3";
    a.title = "Copy to clipboard for NP3";
    a.href = "javascript:void(0);";
    a.addEventListener("click", () => {
      copyToClipboard(decodeURIComponent(text));
    });
    return a;
  }

  function setExport(loc, exportStatus) {
    exportData[loc] = new Date().toISOString();
    exportStatus.innerHTML = new Date(exportData[loc]).toLocaleString();
    GM.setValue(`${getBookASIN()}`, exportData);
    document.getElementById("top-export-count").innerHTML = getTopExportCount();
  }

  function getMDLinkToNote(note) {
    try {
      let url = getDirectUrlToNote(note);
      let loc = getLocation(note);

      if (url && loc) {
        return " [loc " + loc + "](" + encodeURIComponent(url) + ")";
      }
      return "";
    } catch (err) {}
  }

  function getDirectUrlToNote(note) {
    try {
      let location = getLocation(note);
      let asin = getBookASIN();
      return "kindle://book?action=open&asin=" + asin + "&location=" + location;
    } catch (err) {}
  }

  function getAuthors() {
    const authors = getAuthorsElement()
      .textContent.split("、")
      .map((a) => `[[${a}]]`)
      .join(" ");

    return authors;
  }

  function getTitle() {
    const title = getTitleElement().textContent;
    return title;
  }

  // start element / text getters, liable to change

  function getLocation(note) {
    try {
      var node = note.querySelector("#kp-annotation-location");
      if (node) {
        var loc = node.value;
        return loc
      }

      return "";
    } catch (err) {}
    return "";
  }

  function getBookASIN() {
    let asinInput = document.getElementById("kp-notebook-annotations-asin");
    if (asinInput) {
      return asinInput.value;
    }
    return false;
  }

  function getTitleElement() {
    return document.querySelector("#annotation-section h3");
  }

  function getAuthorsElement() {
    const titleElement = getTitleElement();
    const authorsElement = titleElement.nextElementSibling;
    return authorsElement;
  }

  function getAnnotationsElementArray() {
    return [
      ...document
        .getElementById("kp-notebook-annotations")
        .getElementsByClassName("kp-notebook-row-separator"),
    ];
  }

  function getHighlightText(note) {
    var node = note.querySelector("#highlight");

    if (node) {
      return node.textContent;
    }
    return "";
  }

  function getNoteText(note) {
    var node = note.querySelector("#note");
    if (node) {
      return node.textContent;
    }
    return "";
  }

  function getAnnotationElement(a) {
    return (
      a.querySelector("#annotationHighlightHeader") ||
      a.querySelector("#annotationNoteHeader")
    );
  }

  // end element / text getters

  function cleanup() {
    // remove elements with np3 class.. seems like they get destroyed by themselves, not necessary.
    allAnnotationMD = "";
    locations = [];
    exportElements = [];
  }

  function appendPipeSeperator(ele) {
    ele.appendChild(document.createTextNode(" | "));
  }

  async function copyToClipboard(textToCopy) {
    try {
      // 1) Copy text
      await navigator.clipboard.writeText(textToCopy);

      // 2) Catch errors
    } catch (err) {
      //console.error("Failed to copy: ", err);
    }
  }

  function getFrontMatterMeta() {
    return `---
title: ${currentTitle}
type: book-note
Author: ${getAuthorsElement().textContent}
source: my Kindle highlights
book: https://www.amazon.com/dp/${getBookASIN() || "unknown"}
---
    `;
  }

  function getTopExportCount() {
    let exportCount = Object.keys(exportData).length;

    let neverExportedCount = 0;
    locations.forEach((loc) => {
      if (!exportData[loc]) {
        neverExportedCount++;
      }
    });

    var text = !exportCount
      ? "never exported"
      : `${neverExportedCount} unexported`;
    return text;
  }

  function getExportedStatus(loc) {
    var a = document.createElement("span");
    var text = "";
    if (!loc) {
      a.id = "top-export-count";
      text = getTopExportCount();
    } else {
      text = exportData[loc]
        ? `exported ${new Date(exportData[loc]).toLocaleString()}`
        : "never exported";
    }
    var exportText = document.createTextNode(text);
    a.appendChild(exportText);
    a.className = "a-size-small a-color-secondary np3";
    return a;
  }

  setTimeout(() => {
    startScript();
  }, 500);
})();


// Credit to these scripts that helped build this:
// https://github.com/yanncharlou/GreaseMonkeyKindleNotesExtractor
// https://github.com/serizawa-jp/roamkit/blob/b3edbbd8aa5fda53abb25e9a32f87dec676ffdf9/bookmarklets/kindle2roam/kindle2roam.js