@library-pals/isbn 1.0.2 → 1.2.0

package/README.md

@@ -55,6 +55,10 @@ Response follows the same schema, but some fields could depend on the service
 that was used to find the book. In general, Google Books API returns more
 information.
 
+#### Response: Google
+
+<!-- google 9780374104092 -->
+
 ```json
 {
   "title": "Annihilation",
@@ -62,12 +66,89 @@ information.
   "description": "Describes the 12th expedition to “Area X,” a region cut off from the continent for decades, by a group of intrepid women scientists who try to ignore the high mortality rates of those on the previous 11 missions. Original. 75,000 first printing.",
   "pageCount": 209,
   "printType": "BOOK",
-  "categories": ["Fiction"],
-  "thumbnail": "http://books.google.com/books/content?id=2cl7AgAAQBAJ&printsec=frontcover&img=1&zoom=1&edge=curl&source=gbs_api",
+  "categories": [
+    "Fiction",
+    "Fiction / General",
+    "Fiction / Fantasy / General",
+    "Fiction / Horror",
+    "Fiction / Literary",
+    "Fiction / Science Fiction / General",
+    "Fiction / Science Fiction / Action & Adventure",
+    "Fiction / Thrillers / Suspense",
+    "Fiction / Dystopian"
+  ],
+  "thumbnail": "http://books.google.com/books/publisher/content?id=2cl7AgAAQBAJ&printsec=frontcover&img=1&zoom=6&edge=curl&source=gbs_api",
   "link": "https://books.google.com/books/about/Annihilation.html?hl=&id=2cl7AgAAQBAJ",
   "publisher": "Macmillan",
   "publishedDate": "2014-02-04",
-  "isbn": "9780374104092"
+  "language": "en",
+  "isbn": "9780374104092",
+  "bookProvider": "Google Books"
+}
+```
+
+#### Response: OpenLibrary
+
+<!-- openlibrary 9780374104092 -->
+
+```json
+{
+  "title": "Annihilation",
+  "authors": ["Jeff VanderMeer"],
+  "description": "Area X has been cut off from the rest of the continent for decades. Nature has reclaimed the last vestiges of human civilization. The twelfth expedition arrives expecting the unexpected, and Area X delivers. They discover a massive topographic anomaly and life-forms that surpass understanding. But it's the surprises that came across the border with them, and the secrets the expedition members are keeping from one another that change everything.",
+  "pageCount": 208,
+  "printType": "BOOK",
+  "categories": [
+    "Nebula Award Winner",
+    "award:nebula_award=novel",
+    "award:nebula_award=2015",
+    "Discoveries in geography",
+    "Fiction",
+    "Scientists",
+    "Science-Fiction",
+    "Suspense fiction",
+    "Paranormal fiction",
+    "Women scientists",
+    "Science fiction",
+    "Fantasy fiction",
+    "Mystery fiction",
+    "Adventure fiction",
+    "Exploration",
+    "Amerikanisches Englisch",
+    "Fiction, science fiction, action & adventure",
+    "Fiction, suspense",
+    "Action & Adventure",
+    "Dystopian",
+    "Fantasy",
+    "Extrasensory perception",
+    "Literary",
+    "Suspense",
+    "Thrillers",
+    "General",
+    "Pollution",
+    "horror",
+    "body horror",
+    "alien invasion",
+    "nyt:trade-fiction-paperback=2018-03-18",
+    "New York Times bestseller",
+    "Explorers",
+    "Secrecy",
+    "Scientific expeditions",
+    "Psychic ability",
+    "Fiction, thrillers, suspense",
+    "Discoveries in geography--fiction",
+    "Scientists--fiction",
+    "Women scientists--fiction",
+    "Ps3572.a4284 a84 2014",
+    "813/.54"
+  ],
+  "thumbnail": "https://covers.openlibrary.org/b/id/10520611-L.jpg",
+  "link": "https://openlibrary.org/books/OL31444108M",
+  "publisher": "Farrar, Straus and Giroux",
+  "publishedDate": "2014",
+  "language": "en",
+  "isbn": "9780374104092",
+  "bookProvider": "Open Library"
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@library-pals/isbn",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "Find books by ISBN",
   "exports": "./src/index.js",
   "types": "./src/index.d.ts",

package/src/index.d.ts

@@ -9,8 +9,10 @@
  * @property {string[]} categories - The subjects or categories of the book.
  * @property {string} publisher - The publisher of the book.
  * @property {string} publishedDate - The date the book was published.
+ * @property {string | undefined} [language] - The language of the book.
  * @property {string | undefined} [thumbnail] - The thumbnail image link of the book.
  * @property {string} [link] - The link of the book.
+ * @property {string} bookProvider - The provider of the book information.
  */
 /**
  * @typedef {import('./provider-resolvers.js').Providers} Providers
@@ -80,6 +82,10 @@ export type Book = {
      * - The date the book was published.
      */
     publishedDate: string;
+    /**
+     * - The language of the book.
+     */
+    language?: string | undefined;
     /**
      * - The thumbnail image link of the book.
      */
@@ -88,6 +94,10 @@ export type Book = {
      * - The link of the book.
      */
     link?: string;
+    /**
+     * - The provider of the book information.
+     */
+    bookProvider: string;
 };
 export type Providers = import('./provider-resolvers.js').Providers;
 export type AxiosRequestConfig = import('axios').AxiosRequestConfig;

package/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AAEH;;;GAGG;AAEH;IACE;;OAEG;IACH,wDAA+B;IAG7B;;;;MAAoC;IAGtC;;;;;;OAMG;IACH,oBALW,MAAM,EAAE,GACN,MAAM,CAwBlB;IAED;;;;;;OAMG;IACH,cALW,MAAM,YACN,kBAAkB,GAChB,QAAQ,IAAI,CAAC,CAkBzB;CACF;;;;;UAhFa,MAAM;;;;WACN,MAAM;;;;aACN,MAAM,EAAE;;;;iBACR,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM,EAAE;;;;eACR,MAAM;;;;mBACN,MAAM;;;;gBACN,MAAM,GAAG,SAAS;;;;WAClB,MAAM;;wBAIP,OAAO,yBAAyB,EAAE,SAAS;iCAC3C,OAAO,OAAO,EAAE,kBAAkB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;GAeG;AAEH;;;GAGG;AAEH;IACE;;OAEG;IACH,wDAA+B;IAG7B;;;;MAAoC;IAGtC;;;;;;OAMG;IACH,oBALW,MAAM,EAAE,GACN,MAAM,CAwBlB;IAED;;;;;;OAMG;IACH,cALW,MAAM,YACN,kBAAkB,GAChB,QAAQ,IAAI,CAAC,CAkBzB;CACF;;;;;UAlFa,MAAM;;;;WACN,MAAM;;;;aACN,MAAM,EAAE;;;;iBACR,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM,EAAE;;;;eACR,MAAM;;;;mBACN,MAAM;;;;eACN,MAAM,GAAG,SAAS;;;;gBAClB,MAAM,GAAG,SAAS;;;;WAClB,MAAM;;;;kBACN,MAAM;;wBAIP,OAAO,yBAAyB,EAAE,SAAS;iCAC3C,OAAO,OAAO,EAAE,kBAAkB"}

package/src/index.js

@@ -15,8 +15,10 @@ import {
  * @property {string[]} categories - The subjects or categories of the book.
  * @property {string} publisher - The publisher of the book.
  * @property {string} publishedDate - The date the book was published.
+ * @property {string | undefined} [language] - The language of the book.
  * @property {string | undefined} [thumbnail] - The thumbnail image link of the book.
  * @property {string} [link] - The link of the book.
+ * @property {string} bookProvider - The provider of the book information.
  */
 
 /**

package/src/providers/google.d.ts

@@ -50,10 +50,21 @@ export function resolveGoogle(isbn: string, options: AxiosRequestConfig): Promis
 /**
  * Standardizes a book object by extracting relevant information from the provided book object.
  * @param {GoogleBook} book - The book object to be standardized.
+ * @param {string} id - The book id.
  * @param {string} isbn - The book's ISBN.
- * @returns {Book} The standardized book object.
+ * @returns {Promise<Book>} The standardized book object.
  */
-export function standardize(book: GoogleBook, isbn: string): Book;
+export function standardize(book: GoogleBook, id: string, isbn: string): Promise<Book>;
+/**
+ * Retrieves the volume information for a book.
+ * @param {string} id - The book id.
+ * @returns {Promise<{imageLinks?: ImageLinks, categories?: string[]}>} - A promise that resolves to an array of author names.
+ * @throws {Error} - If there is an error retrieving the author information.
+ */
+export function getVolume(id: string): Promise<{
+    imageLinks?: ImageLinks;
+    categories?: string[];
+}>;
 export type Book = import('../index.js').Book;
 export type AxiosRequestConfig = import('axios').AxiosRequestConfig;
 export type ImageLinks = {

package/src/providers/google.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"google.d.ts","sourceRoot":"","sources":["google.js"],"names":[],"mappings":"AAOA;;;GAGG;AAEH;;;;;;GAMG;AACH,oCALW,MAAM,WACN,kBAAkB,GAChB,QAAQ,IAAI,CAAC,CA4BzB;AAED;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH;;;;;GAKG;AACH,kCAJW,UAAU,QACV,MAAM,GACJ,IAAI,CAkBhB;mBAnGY,OAAO,aAAa,EAAE,IAAI;iCAC1B,OAAO,OAAO,EAAE,kBAAkB;;;;;iBAuCjC,MAAM;;;;YACN,MAAM;;;;aACN,MAAM;;;;YACN,MAAM;;;;gBACN,MAAM;;;;qBACN,MAAM;;;;;;WAKN,MAAM;;;;cACN,MAAM;;;;aACN,MAAM,EAAE;;;;eACR,MAAM;;;;mBACN,MAAM;;;;iBACN,MAAM;;;;yBACN,MAAM,EAAE;;;;kBACR,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM,EAAE;;;;mBACR,MAAM;;;;kBACN,MAAM;;;;oBACN,MAAM;;;;sBACN,OAAO;;;;oBACP,MAAM;;;;yBACN,MAAM;;;;iBACN,UAAU;;;;cACV,MAAM;;;;iBACN,MAAM;;;;cACN,MAAM;;;;yBACN,MAAM;;;;cACN,MAAM;;;;gBACN,MAAM;;;;gBACN,MAAM"}
+{"version":3,"file":"google.d.ts","sourceRoot":"","sources":["google.js"],"names":[],"mappings":"AAOA;;;GAGG;AAEH;;;;;;GAMG;AACH,oCALW,MAAM,WACN,kBAAkB,GAChB,QAAQ,IAAI,CAAC,CA4BzB;AAED;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH;;;;;;GAMG;AACH,kCALW,UAAU,MACV,MAAM,QACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAuBzB;AAED;;;;;GAKG;AACH,8BAJW,MAAM,GACJ,QAAQ;IAAC,UAAU,CAAC,EAAE,UAAU,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC,CAiBrE;mBA/HY,OAAO,aAAa,EAAE,IAAI;iCAC1B,OAAO,OAAO,EAAE,kBAAkB;;;;;iBAuCjC,MAAM;;;;YACN,MAAM;;;;aACN,MAAM;;;;YACN,MAAM;;;;gBACN,MAAM;;;;qBACN,MAAM;;;;;;WAKN,MAAM;;;;cACN,MAAM;;;;aACN,MAAM,EAAE;;;;eACR,MAAM;;;;mBACN,MAAM;;;;iBACN,MAAM;;;;yBACN,MAAM,EAAE;;;;kBACR,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;;;;gBACN,MAAM,EAAE;;;;mBACR,MAAM;;;;kBACN,MAAM;;;;oBACN,MAAM;;;;sBACN,OAAO;;;;oBACP,MAAM;;;;yBACN,MAAM;;;;iBACN,UAAU;;;;cACV,MAAM;;;;iBACN,MAAM;;;;cACN,MAAM;;;;yBACN,MAAM;;;;cACN,MAAM;;;;gBACN,MAAM;;;;gBACN,MAAM"}

package/src/providers/google.js

@@ -38,7 +38,7 @@ export async function resolveGoogle(isbn, options) {
       throw new Error(`No volume info found for book with isbn: ${isbn}`);
     }
     const book = books.items[0];
-    return standardize(book.volumeInfo, isbn);
+    return await standardize(book.volumeInfo, book.id, isbn);
   } catch (error) {
     throw new Error(error.message);
   }
@@ -86,27 +86,55 @@ export async function resolveGoogle(isbn, options) {
 /**
  * Standardizes a book object by extracting relevant information from the provided book object.
  * @param {GoogleBook} book - The book object to be standardized.
+ * @param {string} id - The book id.
  * @param {string} isbn - The book's ISBN.
- * @returns {Book} The standardized book object.
+ * @returns {Promise<Book>} The standardized book object.
  */
-export function standardize(book, isbn) {
+export async function standardize(book, id, isbn) {
+  const { imageLinks = book.imageLinks, categories = book.categories } =
+    await getVolume(id);
+
   const standardBook = {
     title: book.title,
     authors: book.authors,
     description: book.description,
     pageCount: book.pageCount,
     printType: book.printType,
-    categories: book.categories,
-    thumbnail: getLargestThumbnail(book.imageLinks),
+    categories: formatCategories(categories),
+    thumbnail: getLargestThumbnail(imageLinks),
     link: book.canonicalVolumeLink,
     publisher: book.publisher,
     publishedDate: book.publishedDate,
+    language: book.language,
     isbn,
+    bookProvider: "Google Books",
   };
 
   return standardBook;
 }
 
+/**
+ * Retrieves the volume information for a book.
+ * @param {string} id - The book id.
+ * @returns {Promise<{imageLinks?: ImageLinks, categories?: string[]}>} - A promise that resolves to an array of author names.
+ * @throws {Error} - If there is an error retrieving the author information.
+ */
+export async function getVolume(id) {
+  try {
+    const url = `${GOOGLE_BOOKS_API_BASE}${GOOGLE_BOOKS_API_BOOK}/${id}`;
+    const response = await axios.get(url);
+
+    if (response.status !== 200) {
+      throw new Error(`Unable to get volume ${id}: ${response.status}`);
+    }
+    return {
+      ...response.data.volumeInfo,
+    };
+  } catch (error) {
+    throw new Error(error.message);
+  }
+}
+
 /**
  * Get the largest available thumbnail from a book's image links.
  * @param {ImageLinks} [imageLinks] - The image links object.
@@ -124,10 +152,34 @@ function getLargestThumbnail(imageLinks) {
 
   if (!imageLinks) return;
 
-  for (const size of sizes) {
-    if (size in imageLinks) {
-      // @ts-ignore
-      return imageLinks[size];
-    }
-  }
+  const size = sizes.find((size) => size in imageLinks);
+
+  // @ts-ignore
+  return removeQueryParameter(imageLinks[size], "imgtk");
+}
+
+/**
+ * Removes a query parameter from a URL.
+ * @param {string} url - The URL.
+ * @param {string} parameter - The query parameter to remove.
+ * @returns {string | undefined} The URL with the query parameter removed.
+ */
+function removeQueryParameter(url, parameter) {
+  const urlObject = new URL(url);
+  urlObject.searchParams.delete(parameter);
+  return urlObject.toString();
+}
+
+/**
+ * Formats the categories array.
+ * @param {string[]} categories - The array of categories.
+ * @returns {string[]} The formatted categories array.
+ */
+function formatCategories(categories) {
+  if (!categories || categories.length === 0) return [];
+
+  const [firstCategory] = categories;
+  return firstCategory.includes("/")
+    ? [firstCategory.split("/")[0].trim(), ...categories]
+    : categories;
 }

package/src/providers/isbndb.js

@@ -125,6 +125,8 @@ function standardize(book, isbn) {
     thumbnail: book.image,
     publisher: book.publisher,
     publishedDate: book.date_published,
+    language: book.language,
     isbn,
+    bookProvider: "ISBNdb",
   };
 }

package/src/providers/open-library.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"open-library.d.ts","sourceRoot":"","sources":["open-library.js"],"names":[],"mappings":"AAOA;;;GAGG;AAEH;;;;;;GAMG;AACH,yCALW,MAAM,WACN,kBAAkB,GAChB,QAAQ,IAAI,CAAC,CAuBzB;AAED;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;GAIG;AAEH;;;GAGG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH;;;;;GAKG;AACH,kCAJW,eAAe,QACf,MAAM,GACJ,QAAQ,IAAI,CAAC,CAsBzB;AAED;;;;GAIG;AACH,uCAHW;IAAC,GAAG,EAAE,MAAM,CAAA;CAAC,EAAE,GACb,QAAQ,MAAM,EAAE,CAAC,CAuB7B;AAED;;;;;GAKG;AAEH;;;;GAIG;AACH,+BAHW,eAAe,GACb,QAAQ;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,EAAE;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,EAAE,CAAA;CAAC,CAAC,CAuC3F;mBArMY,OAAO,aAAa,EAAE,IAAI;iCAC1B,OAAO,OAAO,EAAE,kBAAkB;;;;;SAkCjC,MAAM;;;;;;SAKN,MAAM;;;;;;SAKN,MAAM;;;;;;UAKN,MAAM;;;;WACN,MAAM;;;;;;SAKN,MAAM;;;;;;UAKN,MAAM;;;;WACN,MAAM;;;;;;iBAKN,MAAM;;;;WACN,MAAM;;;;aACN,MAAM,EAAE;;;;kBACR,MAAM;;;;gBACN,MAAM,EAAE;;;;YACR,MAAM,EAAE;;;;mBACR,MAAM,EAAE;;;;eACR,QAAQ,EAAE;;;;oBACV,MAAM,EAAE;;;;cACR,MAAM,EAAE;;;;UACR,IAAI;;;;oBACJ,aAAa;;;;SACb,MAAM;;;;qBACN,MAAM;;;;WACN,IAAI,EAAE;;;;qBACN,MAAM;;;;WACN,MAAM;;;;aACN,MAAM,EAAE;;;;aACR,MAAM,EAAE;;;;qBACR,MAAM;;;;cACN,MAAM;;;;aACN,QAAQ;;;;mBACR,QAAQ;;;;;;iBA6DR,MAAM;;;;cACN,MAAM,EAAE;;;;aACR;QAAC,MAAM,EAAE;YAAC,GAAG,EAAE,MAAM,CAAA;SAAC,CAAA;KAAC,EAAE"}
+{"version":3,"file":"open-library.d.ts","sourceRoot":"","sources":["open-library.js"],"names":[],"mappings":"AAOA;;;GAGG;AAEH;;;;;;GAMG;AACH,yCALW,MAAM,WACN,kBAAkB,GAChB,QAAQ,IAAI,CAAC,CAuBzB;AAED;;;GAGG;AAEH;;;GAGG;AAEH;;;GAGG;AAEH;;;;GAIG;AAEH;;;GAGG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH;;;;;GAKG;AACH,kCAJW,eAAe,QACf,MAAM,GACJ,QAAQ,IAAI,CAAC,CAwBzB;AAED;;;;GAIG;AACH,uCAHW;IAAC,GAAG,EAAE,MAAM,CAAA;CAAC,EAAE,GACb,QAAQ,MAAM,EAAE,CAAC,CAuB7B;AAED;;;;;GAKG;AAEH;;;;GAIG;AACH,+BAHW,eAAe,GACb,QAAQ;IAAC,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,EAAE;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,EAAE,CAAA;CAAC,CAAC,CAuC3F;mBAvMY,OAAO,aAAa,EAAE,IAAI;iCAC1B,OAAO,OAAO,EAAE,kBAAkB;;;;;SAkCjC,MAAM;;;;;;SAKN,MAAM;;;;;;SAKN,MAAM;;;;;;UAKN,MAAM;;;;WACN,MAAM;;;;;;SAKN,MAAM;;;;;;UAKN,MAAM;;;;WACN,MAAM;;;;;;iBAKN,MAAM;;;;WACN,MAAM;;;;aACN,MAAM,EAAE;;;;kBACR,MAAM;;;;gBACN,MAAM,EAAE;;;;YACR,MAAM,EAAE;;;;mBACR,MAAM,EAAE;;;;eACR,QAAQ,EAAE;;;;oBACV,MAAM,EAAE;;;;cACR,MAAM,EAAE;;;;UACR,IAAI;;;;oBACJ,aAAa;;;;SACb,MAAM;;;;qBACN,MAAM;;;;WACN,IAAI,EAAE;;;;qBACN,MAAM;;;;WACN,MAAM;;;;aACN,MAAM,EAAE;;;;aACR,MAAM,EAAE;;;;qBACR,MAAM;;;;cACN,MAAM;;;;aACN,QAAQ;;;;mBACR,QAAQ;;;;;;iBA+DR,MAAM;;;;cACN,MAAM,EAAE;;;;aACR;QAAC,MAAM,EAAE;YAAC,GAAG,EAAE,MAAM,CAAA;SAAC,CAAA;KAAC,EAAE"}

package/src/providers/open-library.js

@@ -120,7 +120,9 @@ export async function standardize(book, isbn) {
       : `${OPENLIBRARY_API_BASE}${OPENLIBRARY_API_BOOK}/${isbn}`,
     publisher: book.publishers?.join(", "),
     publishedDate: book.publish_date,
+    language: formatLanguage(book.languages),
     isbn,
+    bookProvider: "Open Library",
   };
 
   return standardBook;
@@ -204,3 +206,38 @@ export async function getWorks(book) {
     throw new Error(error.message);
   }
 }
+
+/**
+ * Formats the language codes from Open Library API to their corresponding ISO 639-1 codes.
+ * @param {Language[]} languages - An array of language codes from Open Library API.
+ * @returns {string | undefined} - A new language map object with ISO 639-1 codes as keys and language codes as values.
+ */
+function formatLanguage(languages) {
+  if (!languages || languages.length === 0) {
+    return;
+  }
+  /**
+   * Mapping of Open Library language codes to their corresponding language names.
+   * https://openlibrary.org/languages.json
+   * @type {{ [key: string]: string } } - A new language map object with ISO 639-1 codes as keys and language codes as values.
+   */
+  const newLanguageMap = {
+    "/languages/eng": "en",
+    "/languages/spa": "es",
+    "/languages/fre": "fr",
+    "/languages/ger": "de",
+    "/languages/rus": "ru",
+    "/languages/ita": "it",
+    "/languages/chi": "zh",
+    "/languages/jpn": "ja",
+    "/languages/por": "pt",
+    "/languages/ara": "ar",
+    "/languages/heb": "he",
+    "/languages/kor": "ko",
+    "/languages/pol": "pl",
+    "/languages/dut": "nl",
+    "/languages/lat": "la",
+  };
+
+  return newLanguageMap[languages[0].key] || undefined;
+}