@library-pals/isbn 1.2.0 → 1.3.0

package/README.md

@@ -7,6 +7,7 @@ following providers:
 - [Open Library Books API](https://openlibrary.org/dev/docs/api/books)
 - [ISBNdb API](https://isbndb.com/apidocs/v2) using API key in the environment
   variable `ISBNDB_API_KEY`
+- [Libro.fm](https://libro.fm/explore)
 
 ## Acknowledgements
 
@@ -65,7 +66,7 @@ information.
   "authors": ["Jeff VanderMeer"],
   "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",
+  "format": "book",
   "categories": [
     "Fiction",
     "Fiction / General",
@@ -97,7 +98,7 @@ information.
   "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",
+  "format": "book",
   "categories": [
     "Nebula Award Winner",
     "award:nebula_award=novel",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@library-pals/isbn",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Find books by ISBN",
   "exports": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -26,7 +26,8 @@
     "google",
     "openlibrary",
     "api",
-    "isbndb"
+    "isbndb",
+    "librofm"
   ],
   "author": "Katy DeCorah <@katydecorah>",
   "license": "AGPL-3.0-or-later",

package/src/index.d.ts

@@ -4,8 +4,8 @@
  * @property {string} title - The title of the book.
  * @property {string[]} authors - The authors of the book.
  * @property {string} description - The overview of the book.
- * @property {number} pageCount - The number of pages in the book.
- * @property {string} printType - The print type of the book.
+ * @property {number} [pageCount] - The number of pages in the book.
+ * @property {string} format - The format of the book.
  * @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.
@@ -27,6 +27,7 @@ export default class Isbn {
         GOOGLE: string;
         OPENLIBRARY: string;
         ISBNDB: string;
+        LIBROFM: string;
     };
     /**
      * Sets the providers for the ISBN lookup.
@@ -65,11 +66,11 @@ export type Book = {
     /**
      * - The number of pages in the book.
      */
-    pageCount: number;
+    pageCount?: number;
     /**
-     * - The print type of the book.
+     * - The format of the book.
      */
-    printType: string;
+    format: string;
     /**
      * - The subjects or categories of the book.
      */

package/src/index.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"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;;;;gBACN,MAAM;;;;YACN,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

@@ -10,8 +10,8 @@ import {
  * @property {string} title - The title of the book.
  * @property {string[]} authors - The authors of the book.
  * @property {string} description - The overview of the book.
- * @property {number} pageCount - The number of pages in the book.
- * @property {string} printType - The print type of the book.
+ * @property {number} [pageCount] - The number of pages in the book.
+ * @property {string} format - The format of the book.
  * @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.

package/src/provider-resolvers.d.ts

@@ -14,10 +14,13 @@ export const OPENLIBRARY_API_BASE: "https://openlibrary.org";
 export const OPENLIBRARY_API_BOOK: "/isbn";
 export const ISBNDB_API_BASE: "https://api2.isbndb.com";
 export const ISBNDB_API_BOOK: "/book";
+export const LIBROFM_API_BASE: "https://libro.fm";
+export const LIBROFM_API_BOOK: "/audiobooks";
 export namespace PROVIDER_NAMES {
     let GOOGLE: string;
     let OPENLIBRARY: string;
     let ISBNDB: string;
+    let LIBROFM: string;
 }
 /**
  * Default providers for resolving ISBN information.

package/src/provider-resolvers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider-resolvers.d.ts","sourceRoot":"","sources":["provider-resolvers.js"],"names":[],"mappings":"AAIA;;;GAGG;AAEH;;;;GAIG;AACH,6BAHU,kBAAkB,CAK1B;AAEF,iEAAkE;AAClE,wDAAyD;AAEzD,6DAA8D;AAC9D,2CAA4C;AAE5C,wDAAyD;AACzD,sCAAuC;;;;;;AAOvC;;;GAGG;AACH,0CAIE;AACF;;EAIE;wBAxCW,MAAM,EAAE;iCACR,OAAO,OAAO,EAAE,kBAAkB;8BANjB,uBAAuB"}
+{"version":3,"file":"provider-resolvers.d.ts","sourceRoot":"","sources":["provider-resolvers.js"],"names":[],"mappings":"AAKA;;;GAGG;AAEH;;;;GAIG;AACH,6BAHU,kBAAkB,CAK1B;AAEF,iEAAkE;AAClE,wDAAyD;AAEzD,6DAA8D;AAC9D,2CAA4C;AAE5C,wDAAyD;AACzD,sCAAuC;AAEvC,kDAAmD;AACnD,6CAA8C;;;;;;;AAS9C;;;GAGG;AACH,0CAKE;AAEF;;EAKE;wBAhDW,MAAM,EAAE;iCACR,OAAO,OAAO,EAAE,kBAAkB;8BAPjB,uBAAuB"}

package/src/provider-resolvers.js

@@ -1,6 +1,7 @@
 import { resolveGoogle } from "./providers/google.js";
 import { resolveOpenLibrary } from "./providers/open-library.js";
 import { resolveIsbnDb } from "./providers/isbndb.js";
+import { resolveLibroFm } from "./providers/librofm.js";
 
 /**
  * @typedef {string[]} Providers
@@ -24,10 +25,15 @@ export const OPENLIBRARY_API_BOOK = "/isbn";
 
 export const ISBNDB_API_BASE = "https://api2.isbndb.com";
 export const ISBNDB_API_BOOK = "/book";
+
+export const LIBROFM_API_BASE = "https://libro.fm";
+export const LIBROFM_API_BOOK = "/audiobooks";
+
 export const PROVIDER_NAMES = {
   GOOGLE: "google",
   OPENLIBRARY: "openlibrary",
   ISBNDB: "isbndb",
+  LIBROFM: "librofm",
 };
 
 /**
@@ -38,9 +44,12 @@ export const DEFAULT_PROVIDERS = [
   PROVIDER_NAMES.GOOGLE,
   PROVIDER_NAMES.OPENLIBRARY,
   PROVIDER_NAMES.ISBNDB,
+  PROVIDER_NAMES.LIBROFM,
 ];
+
 export const PROVIDER_RESOLVERS = {
   [PROVIDER_NAMES.GOOGLE]: resolveGoogle,
   [PROVIDER_NAMES.OPENLIBRARY]: resolveOpenLibrary,
   [PROVIDER_NAMES.ISBNDB]: resolveIsbnDb,
+  [PROVIDER_NAMES.LIBROFM]: resolveLibroFm,
 };

package/src/providers/google.js

@@ -99,7 +99,7 @@ export async function standardize(book, id, isbn) {
     authors: book.authors,
     description: book.description,
     pageCount: book.pageCount,
-    printType: book.printType,
+    format: book.printType?.toLowerCase(),
     categories: formatCategories(categories),
     thumbnail: getLargestThumbnail(imageLinks),
     link: book.canonicalVolumeLink,

package/src/providers/isbndb.js

@@ -120,7 +120,7 @@ function standardize(book, isbn) {
     authors: book.authors,
     description: book.overview,
     pageCount: book.pages,
-    printType: "BOOK",
+    format: "book",
     categories: book.subjects,
     thumbnail: book.image,
     publisher: book.publisher,

package/src/providers/librofm.d.ts

@@ -0,0 +1,123 @@
+/**
+ * @typedef {import('../index.js').Book} Book
+ * @typedef {import('axios').AxiosRequestConfig} AxiosRequestConfig
+ */
+/**
+ * Resolves book information from Libro.fm using the provided ISBN.
+ * @param {string} isbn - The ISBN of the book.
+ * @returns {Promise<Book>} The book information retrieved from the API.
+ * @throws {Error} If the API response code is not 200, or if no books are found with the provided ISBN, or if no volume information is found for the book.
+ */
+export function resolveLibroFm(isbn: string): Promise<Book>;
+/**
+ * Standardizes a book object by extracting relevant information from the provided book object.
+ * @param {string} data - The data to be standardized.
+ * @param {string} isbn - The book's ISBN.
+ * @param {string} url - The URL of the book.
+ * @returns {Promise<Book>} The standardized book object.
+ */
+export function standardize(data: string, isbn: string, url: string): Promise<Book>;
+/**
+ * @typedef {object} Person
+ * @property {string} name - The name of the person.
+ */
+/**
+ * @typedef {object} Audiobook
+ * @property {string} url - The URL of the audiobook.
+ * @property {string} bookFormat - The format of the audiobook.
+ * @property {string} name - The name of the audiobook.
+ * @property {string} description - The description of the audiobook.
+ * @property {string} isbn - The ISBN of the audiobook.
+ * @property {string} image - The image of the audiobook.
+ * @property {string} abridged - Whether the audiobook is abridged.
+ * @property {Person[]} author - The author of the audiobook.
+ * @property {Person[]} readBy - The person who read the audiobook.
+ * @property {string} publisher - The publisher of the audiobook.
+ * @property {string} datePublished - The date the audiobook was published.
+ * @property {string} inLanguage - The language of the audiobook.
+ * @property {string} duration - The duration of the audiobook.
+ * @property {string[]} regionsAllowed - The regions allowed for the audiobook.
+ * @property {object} offers - The offers for the audiobook.
+ * @property {object} workExample - The work example for the audiobook.
+ */
+/**
+ * Formats the description by removing HTML tags and contents inside them.
+ * @param {string} description - The description to be formatted.
+ * @returns {string} The formatted description.
+ */
+export function formatDescription(description: string): string;
+export type Book = import('../index.js').Book;
+export type AxiosRequestConfig = import('axios').AxiosRequestConfig;
+export type Person = {
+    /**
+     * - The name of the person.
+     */
+    name: string;
+};
+export type Audiobook = {
+    /**
+     * - The URL of the audiobook.
+     */
+    url: string;
+    /**
+     * - The format of the audiobook.
+     */
+    bookFormat: string;
+    /**
+     * - The name of the audiobook.
+     */
+    name: string;
+    /**
+     * - The description of the audiobook.
+     */
+    description: string;
+    /**
+     * - The ISBN of the audiobook.
+     */
+    isbn: string;
+    /**
+     * - The image of the audiobook.
+     */
+    image: string;
+    /**
+     * - Whether the audiobook is abridged.
+     */
+    abridged: string;
+    /**
+     * - The author of the audiobook.
+     */
+    author: Person[];
+    /**
+     * - The person who read the audiobook.
+     */
+    readBy: Person[];
+    /**
+     * - The publisher of the audiobook.
+     */
+    publisher: string;
+    /**
+     * - The date the audiobook was published.
+     */
+    datePublished: string;
+    /**
+     * - The language of the audiobook.
+     */
+    inLanguage: string;
+    /**
+     * - The duration of the audiobook.
+     */
+    duration: string;
+    /**
+     * - The regions allowed for the audiobook.
+     */
+    regionsAllowed: string[];
+    /**
+     * - The offers for the audiobook.
+     */
+    offers: object;
+    /**
+     * - The work example for the audiobook.
+     */
+    workExample: object;
+};
+//# sourceMappingURL=librofm.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"librofm.d.ts","sourceRoot":"","sources":["librofm.js"],"names":[],"mappings":"AAGA;;;GAGG;AAEH;;;;;GAKG;AACH,qCAJW,MAAM,GACJ,QAAQ,IAAI,CAAC,CAezB;AAED;;;;;;GAMG;AACH,kCALW,MAAM,QACN,MAAM,OACN,MAAM,GACJ,QAAQ,IAAI,CAAC,CAgCzB;AAED;;;GAGG;AACH;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;GAIG;AACH,+CAHW,MAAM,GACJ,MAAM,CAiBlB;mBA3GY,OAAO,aAAa,EAAE,IAAI;iCAC1B,OAAO,OAAO,EAAE,kBAAkB;;;;;UAgEjC,MAAM;;;;;;SAIN,MAAM;;;;gBACN,MAAM;;;;UACN,MAAM;;;;iBACN,MAAM;;;;UACN,MAAM;;;;WACN,MAAM;;;;cACN,MAAM;;;;YACN,MAAM,EAAE;;;;YACR,MAAM,EAAE;;;;eACR,MAAM;;;;mBACN,MAAM;;;;gBACN,MAAM;;;;cACN,MAAM;;;;oBACN,MAAM,EAAE;;;;YACR,MAAM;;;;iBACN,MAAM"}

package/src/providers/librofm.js

@@ -0,0 +1,134 @@
+import { LIBROFM_API_BASE, LIBROFM_API_BOOK } from "../provider-resolvers.js";
+import axios from "axios";
+
+/**
+ * @typedef {import('../index.js').Book} Book
+ * @typedef {import('axios').AxiosRequestConfig} AxiosRequestConfig
+ */
+
+/**
+ * Resolves book information from Libro.fm using the provided ISBN.
+ * @param {string} isbn - The ISBN of the book.
+ * @returns {Promise<Book>} The book information retrieved from the API.
+ * @throws {Error} If the API response code is not 200, or if no books are found with the provided ISBN, or if no volume information is found for the book.
+ */
+export async function resolveLibroFm(isbn) {
+  const url = `${LIBROFM_API_BASE}${LIBROFM_API_BOOK}/${isbn}`;
+
+  const response = await axios.get(url);
+  try {
+    if (response.status !== 200) {
+      throw new Error(`Unable to get ${url}: ${response.status}`);
+    }
+    return standardize(response.data, isbn, url);
+  } catch (error) {
+    throw new Error(error.message);
+  }
+}
+
+/**
+ * Standardizes a book object by extracting relevant information from the provided book object.
+ * @param {string} data - The data to be standardized.
+ * @param {string} isbn - The book's ISBN.
+ * @param {string} url - The URL of the book.
+ * @returns {Promise<Book>} The standardized book object.
+ */
+export async function standardize(data, isbn, url) {
+  // Use a regular expression to extract the JSON
+  const regex = /<script type="application\/ld\+json">(.*?)<\/script>/s;
+  const match = data.match(regex);
+  if (!match) {
+    throw new Error(`No information found for ${url}`);
+  }
+
+  /**
+   * @type {Audiobook}
+   */
+  const book = JSON.parse(match[1]);
+  const standardBook = {
+    title: book.name,
+    authors: book.author.map((author) => author.name),
+    description: formatDescription(book.description),
+    format: book.bookFormat.includes("Audiobook")
+      ? "audiobook"
+      : book.bookFormat,
+    categories: extractGenres(data),
+    thumbnail: book.image,
+    link: book.url,
+    publisher: book.publisher,
+    publishedDate: book.datePublished,
+    language: book.inLanguage,
+    isbn,
+    bookProvider: "Libro.fm",
+  };
+
+  return standardBook;
+}
+
+/**
+ * @typedef {object} Person
+ * @property {string} name - The name of the person.
+ */
+/**
+ * @typedef {object} Audiobook
+ * @property {string} url - The URL of the audiobook.
+ * @property {string} bookFormat - The format of the audiobook.
+ * @property {string} name - The name of the audiobook.
+ * @property {string} description - The description of the audiobook.
+ * @property {string} isbn - The ISBN of the audiobook.
+ * @property {string} image - The image of the audiobook.
+ * @property {string} abridged - Whether the audiobook is abridged.
+ * @property {Person[]} author - The author of the audiobook.
+ * @property {Person[]} readBy - The person who read the audiobook.
+ * @property {string} publisher - The publisher of the audiobook.
+ * @property {string} datePublished - The date the audiobook was published.
+ * @property {string} inLanguage - The language of the audiobook.
+ * @property {string} duration - The duration of the audiobook.
+ * @property {string[]} regionsAllowed - The regions allowed for the audiobook.
+ * @property {object} offers - The offers for the audiobook.
+ * @property {object} workExample - The work example for the audiobook.
+ */
+
+/**
+ * Formats the description by removing HTML tags and contents inside them.
+ * @param {string} description - The description to be formatted.
+ * @returns {string} The formatted description.
+ */
+export function formatDescription(description) {
+  if (!description) return "";
+  // Replace <br> with a space
+  description = description.replaceAll("<br>", " ");
+  // Replace <b>—</b> with a dash
+  description = description.replaceAll("<b>—</b>", "—");
+  // Remove bold tags and contents
+  description = description.replaceAll(/<b>.*?<\/b>/g, "");
+  // Remove all other html elements
+  description = description.replaceAll(/<.*?>/g, "");
+  // Trim
+  description = description.trim();
+  // Remove extra spaces
+  description = description.replaceAll(/\s{2,}/g, " ");
+  return description;
+}
+
+/**
+ * Extracts the genres from the given text.
+ * @param {string} text - The text to extract genres from.
+ * @returns {string[]} The extracted genres.
+ */
+function extractGenres(text) {
+  const regex = /<div class="audiobook-genres">\s*([\S\s]*?)\s*<\/div>/;
+  const match = text.match(regex);
+  if (!match) {
+    return [];
+  }
+
+  const linkRegex = /<a href="\/genres\/[^"]*">(.*?)<\/a>/g;
+  const genres = [];
+  let linkMatch;
+  while ((linkMatch = linkRegex.exec(match[1])) !== null) {
+    genres.push(linkMatch[1]);
+  }
+
+  return genres;
+}

package/src/providers/open-library.js

@@ -112,7 +112,7 @@ export async function standardize(book, isbn) {
     authors,
     description,
     pageCount: book.number_of_pages,
-    printType: "BOOK",
+    format: "book",
     categories: subjects,
     thumbnail: `https://covers.openlibrary.org/b/id/${book.covers[0]}-L.jpg`,
     link: book.key