@library-pals/isbn 0.2.0 → 1.0.0

package/src/providers/google.js

@@ -5,32 +5,93 @@ import {
   GOOGLE_BOOKS_API_BOOK,
 } from "../provider-resolvers.js";
 
+/**
+ * @typedef {import('../index.js').Book} Book
+ * @typedef {import('axios').AxiosRequestConfig} AxiosRequestConfig
+ */
+
 /**
  * Resolves book information from Google Books API using the provided ISBN.
  * @param {string} isbn - The ISBN of the book.
- * @param {object} options - Additional options for the API request.
- * @returns {Promise<object>} The book information retrieved from the API.
+ * @param {AxiosRequestConfig} options - Additional options for the API request.
+ * @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 resolveGoogle(isbn, options) {
   const requestOptions = {
     ...defaultOptions,
     ...options,
-    url: `${GOOGLE_BOOKS_API_BASE}${GOOGLE_BOOKS_API_BOOK}?q=isbn:${isbn}`,
   };
+  const url = `${GOOGLE_BOOKS_API_BASE}${GOOGLE_BOOKS_API_BOOK}?q=isbn:${isbn}`;
 
-  const { status, data } = await axios.request(requestOptions);
-  if (status !== 200) {
-    throw new Error(`wrong response code: ${status}`);
-  }
-  const books = data;
-  if (!books.totalItems) {
-    throw new Error(`no books found with isbn: ${isbn}`);
+  try {
+    const response = await axios.get(url, requestOptions);
+    if (response.status !== 200) {
+      throw new Error(`Wrong response code: ${response.status}`);
+    }
+    const books = response.data;
+    if (!books.totalItems) {
+      throw new Error(`No books found with isbn: ${isbn}`);
+    }
+    // In very rare circumstances books.items[0] is undefined (see #2)
+    if (!books.items || books.items.length === 0) {
+      throw new Error(`No volume info found for book with isbn: ${isbn}`);
+    }
+    const book = books.items[0];
+    return standardize(book.volumeInfo, book.id, isbn);
+  } catch (error) {
+    throw new Error(error.message);
   }
-  // In very rare circumstances books.items[0] is undefined (see #2)
-  if (!books.items || books.items.length === 0) {
-    throw new Error(`no volume info found for book with isbn: ${isbn}`);
-  }
-  const book = books.items[0].volumeInfo;
-  return book;
+}
+
+/**
+ * @typedef {object} GoogleBook
+ * @property {string} title - The title of the book.
+ * @property {string} subtitle - The subtitle of the book.
+ * @property {string[]} authors - The authors of the book.
+ * @property {string} publisher - The publisher of the book.
+ * @property {string} publishedDate - The published date of the book.
+ * @property {string} description - The description of the book.
+ * @property {object[]} industryIdentifiers - The industry identifiers of the book.
+ * @property {object} readingModes - The reading modes of the book.
+ * @property {number} pageCount - The number of pages in the book.
+ * @property {string} printType - The print type of the book.
+ * @property {string[]} categories - The categories of the book.
+ * @property {number} averageRating - The average rating of the book.
+ * @property {number} ratingsCount - The ratings count of the book.
+ * @property {string} maturityRating - The maturity rating of the book.
+ * @property {boolean} allowAnonLogging - The allow anon logging of the book.
+ * @property {string} contentVersion - The content version of the book.
+ * @property {object} panelizationSummary - The panelization summary of the book.
+ * @property {object} imageLinks - The image links of the book.
+ * @property {string} language - The language of the book.
+ * @property {string} previewLink - The preview link of the book.
+ * @property {string} infoLink - The info link of the book.
+ * @property {string} canonicalVolumeLink - The canonical volume link of the book.
+ * @property {object} saleInfo - The sale info of the book.
+ * @property {object} accessInfo - The access info of the book.
+ * @property {object} searchInfo - The search info of the book.
+ */
+
+/**
+ * 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's id.
+ * @param {string} isbn - The book's ISBN.
+ * @returns {Book} - The standardized book object.
+ */
+export function standardize(book, id, isbn) {
+  const standardBook = {
+    title: book.title,
+    authors: book.authors,
+    description: book.description,
+    pageCount: book.pageCount,
+    printType: book.printType,
+    categories: book.categories,
+    thumbnail: `https://books.google.com/books?id=${id}&printsec=frontcover&img=1&zoom=6&edge=curl&source=gbs_api`,
+    link: book.canonicalVolumeLink,
+    isbn,
+  };
+
+  return standardBook;
 }

package/src/providers/isbndb.d.ts

@@ -0,0 +1,184 @@
+/**
+ * @typedef {import('../index.js').Book} Book
+ * @typedef {import('axios').AxiosRequestConfig} AxiosRequestConfig
+ */
+/**
+ * Resolves the ISBN using the ISBNdb API.
+ * @param {string} isbn - The ISBN to resolve.
+ * @param {AxiosRequestConfig} options - Additional options for the request.
+ * @returns {Promise<Book>} - A promise that resolves to the standardized book data.
+ * @throws {Error} - If the response code is not 200 or if no books are found with the given ISBN.
+ */
+export function resolveIsbnDb(isbn: string, options: AxiosRequestConfig): Promise<Book>;
+export type Book = import('../index.js').Book;
+export type AxiosRequestConfig = import('axios').AxiosRequestConfig;
+export type Dimension = {
+    /**
+     * - The unit of the dimension.
+     */
+    unit: string;
+    /**
+     * - The value of the dimension.
+     */
+    value: number;
+};
+export type Offset = {
+    /**
+     * - The x offset.
+     */
+    x: string;
+    /**
+     * - The y offset.
+     */
+    y: string;
+};
+export type Price = {
+    /**
+     * - The condition of the book.
+     */
+    condition: string;
+    /**
+     * - The merchant selling the book.
+     */
+    merchant: string;
+    /**
+     * - The logo of the merchant.
+     */
+    merchant_logo: string;
+    /**
+     * - The offset of the merchant logo.
+     */
+    merchant_logo_offset: Offset;
+    /**
+     * - The shipping cost.
+     */
+    shipping: string;
+    /**
+     * - The price of the book.
+     */
+    price: string;
+    /**
+     * - The total cost.
+     */
+    total: string;
+    /**
+     * - The link to buy the book.
+     */
+    link: string;
+};
+export type OtherIsbn = {
+    /**
+     * - The ISBN of the book.
+     */
+    isbn: string;
+    /**
+     * - The binding of the book.
+     */
+    binding: string;
+};
+export type IsbnDbBook = {
+    /**
+     * - The title of the book.
+     */
+    title: string;
+    /**
+     * - The long title of the book.
+     */
+    title_long: string;
+    /**
+     * - The ISBN of the book.
+     */
+    isbn: string;
+    /**
+     * - The ISBN13 of the book.
+     */
+    isbn13: string;
+    /**
+     * - The Dewey Decimal classification of the book.
+     */
+    dewey_decimal: string;
+    /**
+     * - The binding of the book.
+     */
+    binding: string;
+    /**
+     * - The publisher of the book.
+     */
+    publisher: string;
+    /**
+     * - The language of the book.
+     */
+    language: string;
+    /**
+     * - The published date of the book.
+     */
+    date_published: string;
+    /**
+     * - The edition of the book.
+     */
+    edition: string;
+    /**
+     * - The number of pages in the book.
+     */
+    pages: number;
+    /**
+     * - The dimensions of the book.
+     */
+    dimensions: string;
+    /**
+     * - The structured dimensions of the book.
+     */
+    dimensions_structured: {
+        length: Dimension;
+        width: Dimension;
+        height: Dimension;
+        weight: Dimension;
+    };
+    /**
+     * - The overview of the book.
+     */
+    overview: string;
+    /**
+     * - The image link of the book.
+     */
+    image: string;
+    /**
+     * - The manufacturer's suggested retail price of the book.
+     */
+    msrp: number;
+    /**
+     * - The excerpt of the book.
+     */
+    excerpt: string;
+    /**
+     * - The synopsis of the book.
+     */
+    synopsis: string;
+    /**
+     * - The authors of the book.
+     */
+    authors: string[];
+    /**
+     * - The subjects or categories of the book.
+     */
+    subjects: string[];
+    /**
+     * - The reviews of the book.
+     */
+    reviews: string[];
+    /**
+     * - The prices of the book.
+     */
+    prices: Price[];
+    /**
+     * - The related books.
+     */
+    related: {
+        type: string;
+    };
+    /**
+     * - The other ISBNs of the book.
+     */
+    other_isbns: OtherIsbn[];
+};
+//# sourceMappingURL=isbndb.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isbndb.d.ts","sourceRoot":"","sources":["isbndb.js"],"names":[],"mappings":"AAOA;;;GAGG;AAEH;;;;;;GAMG;AACH,oCALW,MAAM,WACN,kBAAkB,GAChB,QAAQ,IAAI,CAAC,CA6BzB;mBArCY,OAAO,aAAa,EAAE,IAAI;iCAC1B,OAAO,OAAO,EAAE,kBAAkB;;;;;UAwCjC,MAAM;;;;WACN,MAAM;;;;;;OAKN,MAAM;;;;OACN,MAAM;;;;;;eAKN,MAAM;;;;cACN,MAAM;;;;mBACN,MAAM;;;;0BACN,MAAM;;;;cACN,MAAM;;;;WACN,MAAM;;;;WACN,MAAM;;;;UACN,MAAM;;;;;;UAKN,MAAM;;;;aACN,MAAM;;;;;;WAKN,MAAM;;;;gBACN,MAAM;;;;UACN,MAAM;;;;YACN,MAAM;;;;mBACN,MAAM;;;;aACN,MAAM;;;;eACN,MAAM;;;;cACN,MAAM;;;;oBACN,MAAM;;;;aACN,MAAM;;;;WACN,MAAM;;;;gBACN,MAAM;;;;;QAE2B,MAAM,EAAvC,SAAS;QACwB,KAAK,EAAtC,SAAS;QACwB,MAAM,EAAvC,SAAS;QACwB,MAAM,EAAvC,SAAS;;;;;cACT,MAAM;;;;WACN,MAAM;;;;UACN,MAAM;;;;aACN,MAAM;;;;cACN,MAAM;;;;aACN,MAAM,EAAE;;;;cACR,MAAM,EAAE;;;;aACR,MAAM,EAAE;;;;YACR,KAAK,EAAE;;;;;QAES,IAAI,EAApB,MAAM;;;;;iBACN,SAAS,EAAE"}

package/src/providers/isbndb.js

@@ -5,56 +5,124 @@ import {
   ISBNDB_API_BOOK,
 } from "../provider-resolvers.js";
 
+/**
+ * @typedef {import('../index.js').Book} Book
+ * @typedef {import('axios').AxiosRequestConfig} AxiosRequestConfig
+ */
+
 /**
  * Resolves the ISBN using the ISBNdb API.
  * @param {string} isbn - The ISBN to resolve.
- * @param {object} options - Additional options for the request.
- * @returns {Promise<object>} - A promise that resolves to the standardized book data.
+ * @param {AxiosRequestConfig} options - Additional options for the request.
+ * @returns {Promise<Book>} - A promise that resolves to the standardized book data.
  * @throws {Error} - If the response code is not 200 or if no books are found with the given ISBN.
  */
 export async function resolveIsbnDb(isbn, options) {
+  if (!process.env.ISBNDB_API_KEY) {
+    throw new Error(`ISBNdb requires an API key`);
+  }
+
   const requestOptions = {
     ...defaultOptions,
     ...options,
-    url: `${ISBNDB_API_BASE}${ISBNDB_API_BOOK}/${isbn}`,
-    headers: { Authorization: process.env.ISBNDB_API_KEY || "" },
+    headers: { Authorization: process.env.ISBNDB_API_KEY },
   };
 
-  const { status, data } = await axios.request(requestOptions);
-  if (status !== 200) {
-    throw new Error(
-      `Wrong response code: ${status}. Response data: ${JSON.stringify(data)}`
-    );
-  }
-  const books = data;
-  if (!books.book) {
-    throw new Error(`No books found with ISBN: ${isbn}`);
+  const url = `${ISBNDB_API_BASE}${ISBNDB_API_BOOK}/${isbn}`;
+
+  try {
+    const response = await axios.get(url, requestOptions);
+    if (response.status !== 200) {
+      throw new Error(`Wrong response code: ${response.status}`);
+    }
+    const books = response.data;
+    if (!books.book) {
+      throw new Error(`No books found with ISBN: ${isbn}`);
+    }
+    return standardize(books.book, isbn);
+  } catch (error) {
+    throw new Error(error.message);
   }
-  return standardize(books.book);
 }
 
+/**
+ * @typedef {object} Dimension
+ * @property {string} unit - The unit of the dimension.
+ * @property {number} value - The value of the dimension.
+ */
+
+/**
+ * @typedef {object} Offset
+ * @property {string} x - The x offset.
+ * @property {string} y - The y offset.
+ */
+
+/**
+ * @typedef {object} Price
+ * @property {string} condition - The condition of the book.
+ * @property {string} merchant - The merchant selling the book.
+ * @property {string} merchant_logo - The logo of the merchant.
+ * @property {Offset} merchant_logo_offset - The offset of the merchant logo.
+ * @property {string} shipping - The shipping cost.
+ * @property {string} price - The price of the book.
+ * @property {string} total - The total cost.
+ * @property {string} link - The link to buy the book.
+ */
+
+/**
+ * @typedef {object} OtherIsbn
+ * @property {string} isbn - The ISBN of the book.
+ * @property {string} binding - The binding of the book.
+ */
+
+/**
+ * @typedef {object} IsbnDbBook
+ * @property {string} title - The title of the book.
+ * @property {string} title_long - The long title of the book.
+ * @property {string} isbn - The ISBN of the book.
+ * @property {string} isbn13 - The ISBN13 of the book.
+ * @property {string} dewey_decimal - The Dewey Decimal classification of the book.
+ * @property {string} binding - The binding of the book.
+ * @property {string} publisher - The publisher of the book.
+ * @property {string} language - The language of the book.
+ * @property {string} date_published - The published date of the book.
+ * @property {string} edition - The edition of the book.
+ * @property {number} pages - The number of pages in the book.
+ * @property {string} dimensions - The dimensions of the book.
+ * @property {object} dimensions_structured - The structured dimensions of the book.
+ * @property {Dimension} dimensions_structured.length - The length of the book.
+ * @property {Dimension} dimensions_structured.width - The width of the book.
+ * @property {Dimension} dimensions_structured.height - The height of the book.
+ * @property {Dimension} dimensions_structured.weight - The weight of the book.
+ * @property {string} overview - The overview of the book.
+ * @property {string} image - The image link of the book.
+ * @property {number} msrp - The manufacturer's suggested retail price of the book.
+ * @property {string} excerpt - The excerpt of the book.
+ * @property {string} synopsis - The synopsis of the book.
+ * @property {string[]} authors - The authors of the book.
+ * @property {string[]} subjects - The subjects or categories of the book.
+ * @property {string[]} reviews - The reviews of the book.
+ * @property {Price[]} prices - The prices of the book.
+ * @property {object} related - The related books.
+ * @property {string} related.type - The type of the related books.
+ * @property {OtherIsbn[]} other_isbns - The other ISBNs of the book.
+ */
+
 /**
  * Standardizes a book object by transforming its properties into a consistent format.
- * @param {object} book - The book object to be standardized.
- * @returns {object} - The standardized book object.
+ * @param {IsbnDbBook} book - The book object to be standardized.
+ * @param {string} isbn - The book's ISBN.
+ * @returns {Book} - The standardized book object.
  */
-function standardize(book) {
+function standardize(book, isbn) {
   return {
     title: book.title_long,
-    publishedDate: book.date_published,
     authors: book.authors,
     description: book.overview,
-    industryIdentifiers: [book.isbn, book.isbn13, book.dewey_decimal].filter(
-      Boolean
-    ),
     pageCount: book.pages,
     printType: "BOOK",
     categories: book.subjects,
-    imageLinks: {
-      smallThumbnail: book.image,
-      thumbnail: book.image,
-    },
-    publisher: book.publisher,
-    language: book.language,
+    thumbnail: book.image,
+    isbn,
   };
 }

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

@@ -0,0 +1,256 @@
+/**
+ * @typedef {import('../index.js').Book} Book
+ * @typedef {import('axios').AxiosRequestConfig} AxiosRequestConfig
+ */
+/**
+ * Resolves a book from the Open Library API using the provided ISBN.
+ * @param {string} isbn - The ISBN of the book.
+ * @param {AxiosRequestConfig} options - Additional options for the request.
+ * @returns {Promise<Book>} A promise that resolves to the standardized book object.
+ * @throws {Error} If the response code is not 200 or if no books are found with the provided ISBN.
+ */
+export function resolveOpenLibrary(isbn: string, options: AxiosRequestConfig): Promise<Book>;
+/**
+ * @typedef {object} Author
+ * @property {string} key - The key of the author.
+ */
+/**
+ * @typedef {object} Language
+ * @property {string} key - The key of the language.
+ */
+/**
+ * @typedef {object} Type
+ * @property {string} key - The key of the type.
+ */
+/**
+ * @typedef {object} FirstSentence
+ * @property {string} type - The type of the first sentence.
+ * @property {string} value - The value of the first sentence.
+ */
+/**
+ * @typedef {object} Work
+ * @property {string} key - The key of the work.
+ */
+/**
+ * @typedef {object} DateTime
+ * @property {string} type - The type of the datetime.
+ * @property {string} value - The value of the datetime.
+ */
+/**
+ * @typedef {object} OpenLibraryBook
+ * @property {object} identifiers - The identifiers of the book.
+ * @property {string} title - The title of the book.
+ * @property {Author[]} authors - The authors of the book.
+ * @property {string} publish_date - The publish date of the book.
+ * @property {string[]} publishers - The publishers of the book.
+ * @property {number[]} covers - The covers of the book.
+ * @property {string[]} contributions - The contributions to the book.
+ * @property {Language[]} languages - The languages of the book.
+ * @property {string[]} source_records - The source records of the book.
+ * @property {string[]} local_id - The local IDs of the book.
+ * @property {Type} type - The type of the book.
+ * @property {FirstSentence} first_sentence - The first sentence of the book.
+ * @property {string} key - The key of the book.
+ * @property {number} number_of_pages - The number of pages in the book.
+ * @property {Work[]} works - The works related to the book.
+ * @property {object} classifications - The classifications of the book.
+ * @property {string} ocaid - The Open Content Alliance ID of the book.
+ * @property {string[]} isbn_10 - The ISBN-10 of the book.
+ * @property {string[]} isbn_13 - The ISBN-13 of the book.
+ * @property {number} latest_revision - The latest revision of the book.
+ * @property {number} revision - The revision of the book.
+ * @property {DateTime} created - The creation datetime of the book.
+ * @property {DateTime} last_modified - The last modified datetime of the book.
+ */
+/**
+ * Standardizes a book object by extracting relevant information from the provided book object.
+ * @param {OpenLibraryBook} book - The book object to be standardized.
+ * @param {string} isbn - The book's isbn.
+ * @returns {Promise<Book>} - The standardized book object.
+ */
+export function standardize(book: OpenLibraryBook, isbn: string): Promise<Book>;
+/**
+ * Retrieves the author names from OpenLibrary.
+ * @param {{key: string}[]} rawAuthors - List of author keys.
+ * @returns {Promise<string[]>} - List of author names.
+ */
+export function getAuthors(rawAuthors: {
+    key: string;
+}[]): Promise<string[]>;
+/**
+ * @typedef {object} OpenLibraryResponse
+ * @property {string} description - The description of the book.
+ * @property {string[]} subjects - The subjects of the book.
+ * @property {{author: {key: string}}[]} authors - The authors of the book.
+ */
+/**
+ * Retrieves the description of the book from OpenLibrary.
+ * @param {OpenLibraryBook} book - The book object from OpenLibrary.
+ * @returns {Promise<{description: string, subjects: string[], rawAuthors: {key: string}[]}>} - Description of the book.
+ */
+export function getWorks(book: OpenLibraryBook): Promise<{
+    description: string;
+    subjects: string[];
+    rawAuthors: {
+        key: string;
+    }[];
+}>;
+export type Book = import('../index.js').Book;
+export type AxiosRequestConfig = import('axios').AxiosRequestConfig;
+export type Author = {
+    /**
+     * - The key of the author.
+     */
+    key: string;
+};
+export type Language = {
+    /**
+     * - The key of the language.
+     */
+    key: string;
+};
+export type Type = {
+    /**
+     * - The key of the type.
+     */
+    key: string;
+};
+export type FirstSentence = {
+    /**
+     * - The type of the first sentence.
+     */
+    type: string;
+    /**
+     * - The value of the first sentence.
+     */
+    value: string;
+};
+export type Work = {
+    /**
+     * - The key of the work.
+     */
+    key: string;
+};
+export type DateTime = {
+    /**
+     * - The type of the datetime.
+     */
+    type: string;
+    /**
+     * - The value of the datetime.
+     */
+    value: string;
+};
+export type OpenLibraryBook = {
+    /**
+     * - The identifiers of the book.
+     */
+    identifiers: object;
+    /**
+     * - The title of the book.
+     */
+    title: string;
+    /**
+     * - The authors of the book.
+     */
+    authors: Author[];
+    /**
+     * - The publish date of the book.
+     */
+    publish_date: string;
+    /**
+     * - The publishers of the book.
+     */
+    publishers: string[];
+    /**
+     * - The covers of the book.
+     */
+    covers: number[];
+    /**
+     * - The contributions to the book.
+     */
+    contributions: string[];
+    /**
+     * - The languages of the book.
+     */
+    languages: Language[];
+    /**
+     * - The source records of the book.
+     */
+    source_records: string[];
+    /**
+     * - The local IDs of the book.
+     */
+    local_id: string[];
+    /**
+     * - The type of the book.
+     */
+    type: Type;
+    /**
+     * - The first sentence of the book.
+     */
+    first_sentence: FirstSentence;
+    /**
+     * - The key of the book.
+     */
+    key: string;
+    /**
+     * - The number of pages in the book.
+     */
+    number_of_pages: number;
+    /**
+     * - The works related to the book.
+     */
+    works: Work[];
+    /**
+     * - The classifications of the book.
+     */
+    classifications: object;
+    /**
+     * - The Open Content Alliance ID of the book.
+     */
+    ocaid: string;
+    /**
+     * - The ISBN-10 of the book.
+     */
+    isbn_10: string[];
+    /**
+     * - The ISBN-13 of the book.
+     */
+    isbn_13: string[];
+    /**
+     * - The latest revision of the book.
+     */
+    latest_revision: number;
+    /**
+     * - The revision of the book.
+     */
+    revision: number;
+    /**
+     * - The creation datetime of the book.
+     */
+    created: DateTime;
+    /**
+     * - The last modified datetime of the book.
+     */
+    last_modified: DateTime;
+};
+export type OpenLibraryResponse = {
+    /**
+     * - The description of the book.
+     */
+    description: string;
+    /**
+     * - The subjects of the book.
+     */
+    subjects: string[];
+    /**
+     * - The authors of the book.
+     */
+    authors: {
+        author: {
+            key: string;
+        };
+    }[];
+};
+//# sourceMappingURL=open-library.d.ts.map