@library-pals/isbn 0.2.0 → 1.0.1

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

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

@@ -0,0 +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,CAoBzB;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;mBAnMY,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;;;;;;iBA2DR,MAAM;;;;cACN,MAAM,EAAE;;;;aACR;QAAC,MAAM,EAAE;YAAC,GAAG,EAAE,MAAM,CAAA;SAAC,CAAA;KAAC,EAAE"}

package/src/providers/open-library.js

@@ -5,68 +5,200 @@ import {
   OPENLIBRARY_API_BOOK,
 } from "../provider-resolvers.js";
 
+/**
+ * @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 {object} options - Additional options for the request.
- * @returns {Promise<object>} A promise that resolves to the standardized book object.
+ * @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 async function resolveOpenLibrary(isbn, options) {
   const requestOptions = {
     ...defaultOptions,
     ...options,
-    url: `${OPENLIBRARY_API_BASE}${OPENLIBRARY_API_BOOK}?bibkeys=ISBN:${isbn}&format=json&jscmd=details`,
   };
+  const url = `${OPENLIBRARY_API_BASE}${OPENLIBRARY_API_BOOK}/${isbn}.json`;
 
-  const { status, data } = await axios.request(requestOptions);
-  if (status !== 200) {
-    throw new Error(
-      `Wrong response code: ${status}. Response data: ${JSON.stringify(data)}`
-    );
+  try {
+    const response = await axios.get(url, requestOptions);
+    if (response.status !== 200) {
+      throw new Error(`Wrong response code: ${response.status}`);
+    }
+    const book = response.data;
+    if (!book || Object.keys(book).length === 0) {
+      throw new Error(`No books found with ISBN: ${isbn}`);
+    }
+    return await standardize(book, isbn);
+  } catch (error) {
+    throw new Error(error.message);
   }
-  const books = data;
-  const book = books[`ISBN:${isbn}`];
-  if (!book) {
-    throw new Error(`No books found with ISBN: ${isbn}`);
-  }
-  return standardize(book);
 }
 
-const LANGUAGE_MAP = {
-  "/languages/eng": "en",
-  "/languages/spa": "es",
-  "/languages/fre": "fr",
-};
+/**
+ * @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 {object} book - The book object to be standardized.
- * @returns {object} - The standardized 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.
  */
-function standardize(book) {
+export async function standardize(book, isbn) {
+  const { description, subjects, rawAuthors } = await getWorks(book);
+  const authors = await getAuthors(rawAuthors);
   const standardBook = {
-    title: book.details.title,
-    publishedDate: book.details.publish_date,
-    authors: book.details.authors
-      ? book.details.authors.map(({ name }) => name)
-      : [],
-    description: book.details.subtitle,
-    industryIdentifiers: [],
-    pageCount: book.details.number_of_pages,
+    title: book.title,
+    authors,
+    description,
+    pageCount: book.number_of_pages,
     printType: "BOOK",
-    categories: [],
-    imageLinks: {
-      smallThumbnail: book.thumbnail_url,
-      thumbnail: book.thumbnail_url,
-    },
-    previewLink: book.preview_url,
-    infoLink: book.info_url,
-    publisher: book.details.publishers ? book.details.publishers[0] : "",
-    language: book.details.languages
-      ? LANGUAGE_MAP[book.details.languages[0].key] || "unknown"
-      : "unknown",
+    categories: subjects,
+    thumbnail: `https://covers.openlibrary.org/b/id/${book.covers[0]}-L.jpg`,
+    link: book.key
+      ? `${OPENLIBRARY_API_BASE}${book.key}`
+      : `${OPENLIBRARY_API_BASE}${OPENLIBRARY_API_BOOK}/${isbn}`,
+    isbn,
   };
 
   return standardBook;
 }
+
+/**
+ * Retrieves the author names from OpenLibrary.
+ * @param {{key: string}[]} rawAuthors - List of author keys.
+ * @returns {Promise<string[]>} - List of author names.
+ */
+export async function getAuthors(rawAuthors) {
+  const promises = rawAuthors
+    .filter((author) => author && author.key)
+    .map((author) =>
+      axios
+        .get(`https://openlibrary.org/${author.key}.json`)
+        .then((response) => {
+          if (response.status !== 200) {
+            throw new Error(
+              `Unable to get author ${author.key}: ${response.status}`,
+            );
+          }
+          return response.data && response.data.name;
+        }),
+    );
+
+  try {
+    return await Promise.all(promises);
+  } catch (error) {
+    throw new Error(error.message);
+  }
+}
+
+/**
+ * @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 async function getWorks(book) {
+  const defaultResponse = {
+    description: "",
+    subjects: [],
+    rawAuthors: [],
+  };
+
+  if (!book.works) {
+    return defaultResponse;
+  }
+
+  const [work] = book.works;
+
+  if (!work || !work.key) {
+    return defaultResponse;
+  }
+
+  try {
+    const response = await axios.get(
+      `https://openlibrary.org/${work.key}.json`,
+    );
+
+    if (response.status !== 200) {
+      throw new Error(`Unable to get ${work.key}: ${response.status}`);
+    }
+
+    /** @type {OpenLibraryResponse} */
+    const data = response.data;
+
+    return {
+      description: data.description || "",
+      subjects: data.subjects || [],
+      rawAuthors: data.authors?.map((a) => a.author) || [],
+    };
+  } catch (error) {
+    throw new Error(error.message);
+  }
+}

package/.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

package/.github/workflows/npm-publish.yml

@@ -1,30 +0,0 @@
-name: Publish npm package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.github/workflows/test.yml

@@ -1,16 +0,0 @@
-name: Test
-
-on: push
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-      - run: npm ci
-      - run: npm test
-        env:
-          CI: true

package/src/cli.js

@@ -1,41 +0,0 @@
-#!/usr/bin/env node
-import meow from "meow";
-import isbn from "./index.js";
-
-const cli = meow(
-  `
-  Usage
-    $ isbn <input>
-
-  Options
-    --isbn, -i  The ISBN for the book
-
-  Examples
-    $ isbn 9780374104092
-
-  This script will resolve the provided ISBN to a book. The ISBN must be a valid ISBN-10 or ISBN-13.
-`,
-  {
-    importMeta: import.meta,
-    flags: {
-      isbn: {
-        type: "string",
-        shortFlag: "i",
-        isRequired: true,
-      },
-    },
-  }
-);
-
-if (!/^(\d{10}|\d{13})$/.test(cli.flags.isbn)) {
-  console.error("Invalid ISBN. Please provide a valid ISBN-10 or ISBN-13.");
-  process.exit(1);
-}
-
-try {
-  const book = await isbn.resolve(cli.flags.isbn);
-  console.log(book);
-} catch (error) {
-  console.error("An error occurred while trying to resolve the ISBN:", error);
-  process.exit(1);
-}

package/src/providers/worldcat.js

@@ -1,63 +0,0 @@
-import axios from "axios";
-import {
-  defaultOptions,
-  WORLDCAT_API_BASE,
-  WORLDCAT_API_BOOK,
-} from "../provider-resolvers.js";
-
-/**
- * Resolves a book using the Worldcat API based on the provided ISBN.
- * @param {string} isbn - The ISBN of the book to resolve.
- * @param {object} options - Additional options for the request.
- * @returns {Promise<object>} 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 async function resolveWorldcat(isbn, options) {
-  const requestOptions = {
-    ...defaultOptions,
-    ...options,
-    url: `${WORLDCAT_API_BASE}${WORLDCAT_API_BOOK}/${isbn}?method=getMetadata&fl=*&format=json`,
-  };
-
-  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.stat !== "ok") {
-    throw new Error(`No books found with ISBN: ${isbn}`);
-  }
-  const [book] = books.list;
-  return standardize(book);
-}
-
-const LANGUAGE_MAP = {
-  eng: "en",
-  spa: "es",
-  fre: "fr",
-};
-
-/**
- * Standardizes a book object by extracting relevant information from the provided book object.
- * @param {object} book - The book object to be standardized.
- * @returns {object} - The standardized book object.
- */
-function standardize(book) {
-  const standardBook = {
-    title: book.title,
-    publishedDate: book.year,
-    authors: book.author ? [book.author] : [],
-    description: null,
-    industryIdentifiers: [],
-    pageCount: null,
-    printType: "BOOK",
-    categories: [],
-    imageLinks: {},
-    publisher: book.publisher,
-    language: LANGUAGE_MAP[book.lang] || "unknown",
-  };
-
-  return standardBook;
-}