Permalink
Cannot retrieve contributors at this time
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
199 lines (159 sloc)
5.1 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| const notice = (msg) => new Notice(msg, 5000); | |
| const log = (msg) => console.log(msg); | |
| // Do NOT edit this. | |
| // API KEY should be entered in the script settings in QuickAdd plugin options. | |
| const API_URL = "https://www.googleapis.com/books/v1/volumes"; | |
| const API_KEY = "Google Books API Key" | |
| const GOODREADS_URL = "https://www.goodreads.com/search?qid=&q=" | |
| module.exports = { | |
| entry: start, | |
| settings: { | |
| name: "Books script", | |
| author: "Elaws", | |
| options: { | |
| [API_KEY]: { | |
| type: "text", | |
| defaultValue: "", | |
| placeholder: "Google Books API Key", | |
| } | |
| }, | |
| }, | |
| }; | |
| let QuickAdd; | |
| let Settings; | |
| async function start(params, settings) { | |
| QuickAdd = params; | |
| Settings = settings; | |
| var author; | |
| // Possible to enter a book title or ISBN. | |
| var query = await QuickAdd.quickAddApi.inputPrompt( | |
| "Book title or ISBN: " | |
| ); | |
| // If no ISBN is entered, a prompt asks author name. | |
| // Possible to enter only author name, and no book title at previous step. | |
| if(!isISBN(query)){ | |
| author = await QuickAdd.quickAddApi.inputPrompt( | |
| "Author: " | |
| ); | |
| } | |
| if(author) { | |
| if(!query){ | |
| query = `inauthor:${author}`; | |
| } else { | |
| query = query.concat(" inauthor:", author); | |
| } | |
| } | |
| if (!query) { | |
| notice("No query entered."); | |
| throw new Error("No query entered."); | |
| } | |
| log(query); | |
| const searchResults = await getByQuery(query); | |
| const selection = await QuickAdd.quickAddApi.suggester( | |
| searchResults.map(formatTitleForSuggestion), | |
| searchResults | |
| ); | |
| if (!selection) { | |
| notice("No choice selected."); | |
| throw new Error("No choice selected."); | |
| } | |
| const selectedBook = selection.volumeInfo; | |
| const ISBN = getISBN(selectedBook); | |
| const isRead = await QuickAdd.quickAddApi.yesNoPrompt("Read ?"); | |
| let myRating = "/10"; | |
| let myRecommender = " "; | |
| let comment = " "; | |
| // If book already read, add a rating to it. | |
| if(isRead){ | |
| myRating = await QuickAdd.quickAddApi.inputPrompt("Rating", null, "/10"); | |
| } | |
| myRecommender = await QuickAdd.quickAddApi.inputPrompt("Recommender", null, " "); | |
| comment = await QuickAdd.quickAddApi.inputPrompt("Comment", null, " "); | |
| QuickAdd.variables = { | |
| ...selectedBook, | |
| fileName: replaceIllegalFileNameCharactersInString(selectedBook.title), | |
| authors: formatList(selectedBook.authors), | |
| isbn10: `${ISBN.ISBN10 ? ISBN.ISBN10 : " "}`, | |
| isbn13: `${ISBN.ISBN13 ? ISBN.ISBN13 : " "}`, | |
| // An URL to the GoodReads page of the book using its ISBN. | |
| // May fail if ISBN returned by Google Books is not in Goodreads database. | |
| goodreadsURL: `${ISBN.ISBN13 ? GOODREADS_URL + ISBN.ISBN13 : (ISBN.ISBN10 ? GOODREADS_URL + ISBN.ISBN10 : " ")}`, | |
| thumbnail: `${selectedBook.imageLinks ? selectedBook.imageLinks.thumbnail : " "}`.replace("http:", "https:"), | |
| // Publication date | |
| release: `${selectedBook.publishedDate ? (new Date((selectedBook.publishedDate))).getFullYear() : " "}`, | |
| // Squares of different color to tag Obsidian's note, depending if book has already been read or not. | |
| tag: `${isRead ? "\u{0001F7E7}" : "\u{0001F7E5}"}`, | |
| // A rating for the read book, /10. | |
| rating: myRating, | |
| // Is the book already read ? 1 if yes, 0 otherwise. | |
| read: `${isRead ? "1" : "0"}`, | |
| // Who recommended the book to me? | |
| recommender: myRecommender, | |
| // A short personal comment on the book. | |
| comment | |
| }; | |
| } | |
| function getISBN(item){ | |
| var ISBN10 = " "; | |
| var ISBN13 = " "; | |
| var isbn10_data, isbn13_data; | |
| if(item.industryIdentifiers) | |
| { | |
| isbn10_data = (item.industryIdentifiers).find(element => element.type == "ISBN_10"); | |
| isbn13_data = (item.industryIdentifiers).find(element => element.type == "ISBN_13"); | |
| } | |
| if(isbn10_data) ISBN10 = isbn10_data.identifier; | |
| if(isbn13_data) ISBN13 = isbn13_data.identifier; | |
| return {ISBN10, ISBN13}; | |
| } | |
| function isISBN(str){ | |
| return /^(97(8|9))?\d{9}(\d|X)$/.test(str); | |
| } | |
| // Suggestion prompt will include : | |
| // (i) prefix if a book cover is available (i for "image") | |
| // Book's title | |
| // Book's author | |
| // Publication year | |
| function formatTitleForSuggestion(resultItem){ | |
| return `${ | |
| resultItem.volumeInfo.imageLinks ? "(i)" : "" | |
| } ${ | |
| resultItem.volumeInfo.title} - ${ | |
| resultItem.volumeInfo.authors ? resultItem.volumeInfo.authors[0] : "" | |
| } (${ | |
| (new Date(resultItem.volumeInfo.publishedDate)).getFullYear() | |
| })`; | |
| } | |
| async function getByQuery(query) { | |
| const searchResults = await apiGet(query); | |
| if(searchResults.error) | |
| { | |
| notice("Request failed"); | |
| throw new Error("Request failed"); | |
| } | |
| if (searchResults.totalItems == 0) { | |
| notice("No results found."); | |
| throw new Error("No results found."); | |
| } | |
| return searchResults.items; | |
| } | |
| function formatList(list) { | |
| if (list.length === 0 || list[0] == "N/A") return " "; | |
| if (list.length === 1) return `${list[0]}`; | |
| return list.map((item) => `\"${item.trim()}\"`).join(", "); | |
| } | |
| function replaceIllegalFileNameCharactersInString(string) { | |
| return string.replace(/[\\,#%&\{\}\/*<>$\":@.]*/g, ""); | |
| } | |
| async function apiGet(query) { | |
| let finalURL = new URL(API_URL); | |
| finalURL.searchParams.append("q", query); | |
| finalURL.searchParams.append("key", Settings[API_KEY]); | |
| log(finalURL.href); | |
| const res = await request({ | |
| url: finalURL.href, | |
| method: 'GET', | |
| cache: 'no-cache', | |
| }) | |
| return JSON.parse(res); | |
| } |