scryfall-api 4.0.0-beta.2 → 4.0.1

package/README.md

@@ -39,21 +39,26 @@ bun add scryfall-api
 
 In the documentation below, requiring the package is assumed.
 
-```js
+```ts
 import scryfall from 'scryfall-api';
-```
 
+scryfall.Cards.byName('Black Lotus').then(console.log);
+```
 
 **With CommonJS**
 
 ```js
 const scryfall = require('scryfall-api');
+
+scryfall.Cards.byName('Black Lotus').then(console.log);
 ```
 
 **If you only need Cards**
 
-```js
+```ts
 import { Cards } from 'scryfall-api';
+
+Cards.byName('Black Lotus').then(console.log);
 ```
 
 Link to [full documentation.](./DOCUMENTATION.md)

package/dist/scryfall-api.cjs

@@ -20,15 +20,15 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/scryfall-api.ts
 var scryfall_api_exports = {};
 __export(scryfall_api_exports, {
-  CardIdentifierBuilder: () => card_identifier_default,
-  Cards: () => card_default,
-  Catalogs: () => catalog_default,
+  CardIdentifierBuilder: () => CardIdentifierApi,
+  Cards: () => card_api_default,
+  Catalogs: () => catalog_api_default,
   InvalidScryfallArgumentError: () => InvalidScryfallArgumentError,
   MagicPageResult: () => MagicPageResult,
-  Rulings: () => ruling_default,
+  Rulings: () => ruling_api_default,
   ScryfallError: () => ScryfallError,
-  Sets: () => set_default,
-  SymbologyApi: () => symbology_default,
+  Sets: () => set_api_default,
+  SymbologyApi: () => symbology_api_default,
   UnknownScryfallError: () => UnknownScryfallError
 });
 module.exports = __toCommonJS(scryfall_api_exports);
@@ -72,68 +72,12 @@ async function debounce() {
   }
 }
 function createDebounceFetcher(fetcher2 = fetch) {
-  return async function debounceFetcher(...args) {
+  return async function debounceFetcher(...arguments_) {
     await debounce();
-    return fetcher2(...args);
+    return fetcher2(...arguments_);
   };
 }
 
-// src/fetcher/page.result.ts
-var MagicPageResult = class {
-  constructor(apiPath, query) {
-    this.apiPath = apiPath;
-    this.query = query;
-    this.#hasMore = true;
-    this.#count = 0;
-  }
-  #count;
-  #hasMore;
-  get count() {
-    return this.#count;
-  }
-  get hasMore() {
-    return this.#hasMore;
-  }
-  async all() {
-    const r = [];
-    while (this.#hasMore) {
-      const result = await this.next();
-      r.push(...result);
-    }
-    return r;
-  }
-  async get(limit) {
-    const r = [];
-    while (this.#hasMore) {
-      const result = await this.next();
-      r.push(...result);
-      if (r.length === limit) {
-        return r;
-      }
-      if (r.length > limit) {
-        return r.slice(0, limit);
-      }
-    }
-    return r;
-  }
-  async next() {
-    const results = await fetcher(this.apiPath, this.query);
-    this.#hasMore = results?.has_more ?? false;
-    this.#count = Number.parseInt(`${results?.total_cards ?? 0}`, 10);
-    if (this.#hasMore) {
-      this.setNextPage();
-    }
-    return results?.data ?? [];
-  }
-  async page(page) {
-    this.query.page = page;
-    return this.next();
-  }
-  setNextPage() {
-    this.query.page += 1;
-  }
-};
-
 // src/fetcher/retry.fetcher.ts
 var defaultCanRetry = async (response) => {
   const object = await response.json();
@@ -144,11 +88,11 @@ var defaultCanRetry = async (response) => {
   const code = "code" in object && typeof object.code === "string" ? object.code : void 0;
   return code !== "not_found" && code !== "bad_request";
 };
-function createRetryFetcher({ maxAttempts = 3, canRetry = defaultCanRetry } = {}, fetcher2 = fetch) {
+function createRetryFetcher({ canRetry = defaultCanRetry, maxAttempts = 3 } = {}, fetcher2 = fetch) {
   let retries = 0;
-  return async function retryFetcher(...args) {
+  return async function retryFetcher(...arguments_) {
     retries++;
-    const response = await fetcher2(...args);
+    const response = await fetcher2(...arguments_);
     if (response.ok) {
       return response;
     }
@@ -162,44 +106,42 @@ function createRetryFetcher({ maxAttempts = 3, canRetry = defaultCanRetry } = {}
       if (code && details && status) {
         throw new ScryfallError(code, details, status, type, warnings);
       }
-      throw new UnknownScryfallError(`Request failed with status ${response.status}`);
+      throw new UnknownScryfallError(`Request failed with status ${response.status.toFixed(0)}`);
     }
     if (canRetry(response)) {
-      return retryFetcher(...args);
+      return retryFetcher(...arguments_);
     }
     if (code && details && status) {
       throw new ScryfallError(code, details, status, type, warnings);
     }
-    throw new UnknownScryfallError(`Request failed with status ${response.status}`);
+    throw new UnknownScryfallError(`Request failed with status ${response.status.toFixed(0)}`);
   };
 }
 
-// src/fetcher/index.ts
+// src/fetcher/fetcher.ts
 var simpleFetcher = createDebounceFetcher(createRetryFetcher());
 var endpoint = "https://api.scryfall.com";
 var DATE_REGEXP = /^\d{4}-\d{2}-\d{2}?$/;
 var dateParser = (_key, value) => {
-  if (typeof value === "string") {
-    if (DATE_REGEXP.test(value)) {
-      return new Date(value);
-    }
+  if (typeof value === "string" && DATE_REGEXP.test(value)) {
+    return new Date(value);
   }
   return value;
 };
-async function fetcher(apiPath, params, body) {
+async function fetcher(apiPath, parameters, body) {
   let path = "";
   if (typeof apiPath === "number" || typeof apiPath === "string") {
     path = apiPath;
   } else if (apiPath) {
     path = apiPath.join("/");
   }
-  const url = new URL(`${endpoint}/${path}`);
-  if (params) {
-    Object.entries(params).forEach(([key, value]) => {
+  const url = new URL(`${endpoint}/${String(path)}`);
+  if (parameters) {
+    for (const [key, value] of Object.entries(parameters)) {
       if (value !== void 0) {
-        url.searchParams.append(key, `${value}`);
+        url.searchParams.append(key, value.toString());
       }
-    });
+    }
   }
   try {
     const init = {
@@ -214,19 +156,75 @@ async function fetcher(apiPath, params, body) {
     const response = await simpleFetcher(url, init);
     const content = await response.text();
     return JSON.parse(content, dateParser);
-  } catch (e) {
-    if (e instanceof ScryfallError) {
-      if (e.warnings) {
-        console.warn(e.warnings);
+  } catch (error) {
+    if (error instanceof ScryfallError) {
+      if (error.warnings) {
+        console.warn(error.warnings);
       }
-      if (e.code === "not_found" || e.code === "bad_request") {
+      if (error.code === "not_found" || error.code === "bad_request") {
         return void 0;
       }
     }
-    throw e;
+    throw error;
   }
 }
 
+// src/fetcher/page.result.ts
+var MagicPageResult = class {
+  constructor(apiPath, query) {
+    this.apiPath = apiPath;
+    this.query = query;
+    this.#hasMore = true;
+    this.#count = 0;
+  }
+  #count;
+  #hasMore;
+  get count() {
+    return this.#count;
+  }
+  get hasMore() {
+    return this.#hasMore;
+  }
+  async all() {
+    const r = [];
+    while (this.#hasMore) {
+      const result = await this.next();
+      r.push(...result);
+    }
+    return r;
+  }
+  async get(limit) {
+    const r = [];
+    while (this.#hasMore) {
+      const result = await this.next();
+      r.push(...result);
+      if (r.length === limit) {
+        return r;
+      }
+      if (r.length > limit) {
+        return r.slice(0, limit);
+      }
+    }
+    return r;
+  }
+  async next() {
+    const results = await fetcher(this.apiPath, this.query);
+    this.#hasMore = results?.has_more ?? false;
+    this.#count = Number.parseInt(results?.total_cards?.toFixed(0) ?? "0", 10);
+    if (this.#hasMore) {
+      this.setNextPage();
+    }
+    return results?.data ?? [];
+  }
+  async page(page) {
+    this.query.page = page;
+    return this.next();
+  }
+  setNextPage() {
+    this.query.page += 1;
+  }
+};
+
 // src/api/card/card.api.ts
 var CardApi = class {
   /*
@@ -292,8 +290,8 @@ var CardApi = class {
   }
   async collection(...identifiers) {
     const cards2 = [];
-    for (let i = 0; i < identifiers.length; i += 75) {
-      const collectionSection = { identifiers: identifiers.slice(i, i + 75) };
+    for (let index = 0; index < identifiers.length; index += 75) {
+      const collectionSection = { identifiers: identifiers.slice(index, index + 75) };
       const result = await fetcher(
         "cards/collection",
         void 0,
@@ -316,9 +314,6 @@ var CardApi = class {
 var cards = new CardApi();
 var card_api_default = cards;
 
-// src/api/card/index.ts
-var card_default = card_api_default;
-
 // src/api/card-identifier/card-identifier.api.ts
 var CardIdentifierApi = class {
   static byId(id) {
@@ -343,85 +338,94 @@ var CardIdentifierApi = class {
     return { oracle_id: id };
   }
   static bySet(set2, collectorNumber) {
-    return { collector_number: `${collectorNumber}`, set: set2 };
+    return { collector_number: String(collectorNumber), set: set2 };
   }
 };
 
-// src/api/card-identifier/index.ts
-var card_identifier_default = CardIdentifierApi;
-
 // src/api/catalog/catalog.api.ts
 var CatalogApi = class {
   async artifactTypes() {
-    return (await fetcher("catalog/artifact-types"))?.data ?? [];
+    const response = await fetcher("catalog/artifact-types");
+    return response?.data ?? [];
   }
   async artistNames() {
-    return (await fetcher("catalog/artist-names"))?.data ?? [];
+    const response = await fetcher("catalog/artist-names");
+    return response?.data ?? [];
   }
   async cardNames() {
-    return (await fetcher("catalog/card-names"))?.data ?? [];
+    const response = await fetcher("catalog/card-names");
+    return response?.data ?? [];
   }
   async creatureTypes() {
-    return (await fetcher("catalog/creature-types"))?.data ?? [];
+    const response = await fetcher("catalog/creature-types");
+    return response?.data ?? [];
   }
   async enchantmentTypes() {
-    return (await fetcher("catalog/enchantment-types"))?.data ?? [];
+    const response = await fetcher("catalog/enchantment-types");
+    return response?.data ?? [];
   }
   async landTypes() {
-    return (await fetcher("catalog/land-types"))?.data ?? [];
+    const response = await fetcher("catalog/land-types");
+    return response?.data ?? [];
   }
   async loyalties() {
-    return (await fetcher("catalog/loyalties"))?.data ?? [];
+    const response = await fetcher("catalog/loyalties");
+    return response?.data ?? [];
   }
   async planeswalkerTypes() {
-    return (await fetcher("catalog/planeswalker-types"))?.data ?? [];
+    const response = await fetcher("catalog/planeswalker-types");
+    return response?.data ?? [];
   }
   async powers() {
-    return (await fetcher("catalog/powers"))?.data ?? [];
+    const response = await fetcher("catalog/powers");
+    return response?.data ?? [];
   }
   async spellTypes() {
-    return (await fetcher("catalog/spell-types"))?.data ?? [];
+    const response = await fetcher("catalog/spell-types");
+    return response?.data ?? [];
   }
   async toughnesses() {
-    return (await fetcher("catalog/toughnesses"))?.data ?? [];
+    const response = await fetcher("catalog/toughnesses");
+    return response?.data ?? [];
   }
   async watermarks() {
-    return (await fetcher("catalog/watermarks"))?.data ?? [];
+    const response = await fetcher("catalog/watermarks");
+    return response?.data ?? [];
   }
   async wordBank() {
-    return (await fetcher("catalog/word-bank"))?.data ?? [];
+    const response = await fetcher("catalog/word-bank");
+    return response?.data ?? [];
   }
 };
 var catalog = new CatalogApi();
 var catalog_api_default = catalog;
 
-// src/api/catalog/index.ts
-var catalog_default = catalog_api_default;
-
 // src/api/ruling/ruling.api.ts
 var RulingApi = class {
   async byArenaId(id) {
-    return (await fetcher(["cards/arena", id, "rulings"]))?.data ?? [];
+    const response = await fetcher(["cards/arena", id, "rulings"]);
+    return response?.data ?? [];
   }
   async byId(id) {
-    return (await fetcher(["cards", id, "rulings"]))?.data ?? [];
+    const response = await fetcher(["cards", id, "rulings"]);
+    return response?.data ?? [];
   }
   async byMtgoId(id) {
-    return (await fetcher(["cards/mtgo", id, "rulings"]))?.data ?? [];
+    const response = await fetcher(["cards/mtgo", id, "rulings"]);
+    return response?.data ?? [];
   }
   async byMultiverseId(id) {
-    return (await fetcher(["cards/multiverse", id, "rulings"]))?.data ?? [];
+    const response = await fetcher(["cards/multiverse", id, "rulings"]);
+    return response?.data ?? [];
   }
   async bySet(setCode, collectorNumber) {
-    return (await fetcher(["cards", setCode, `${collectorNumber}`, "rulings"]))?.data ?? [];
+    const response = await fetcher(["cards", setCode, String(collectorNumber), "rulings"]);
+    return response?.data ?? [];
   }
 };
 var rulings = new RulingApi();
 var ruling_api_default = rulings;
 
-// src/api/ruling/index.ts
-var ruling_default = ruling_api_default;
-
 // src/api/set/set.api.ts
 var SetApi = class {
   async all() {
@@ -441,9 +445,6 @@ var SetApi = class {
 var set = new SetApi();
 var set_api_default = set;
 
-// src/api/set/index.ts
-var set_default = set_api_default;
-
 // src/api/symbology/symbology.api.ts
 var SymbologyApi = class {
   async all() {
@@ -458,10 +459,10 @@ var SymbologyApi = class {
       cost: shorthand
     });
     return cost ?? {
-      cost: "",
-      colors: [],
       cmc: 0,
       colorless: false,
+      colors: [],
+      cost: "",
       monocolored: false,
       multicolored: false,
       object: "mana_cost"
@@ -470,9 +471,6 @@ var SymbologyApi = class {
 };
 var symbology = new SymbologyApi();
 var symbology_api_default = symbology;
-
-// src/api/symbology/index.ts
-var symbology_default = symbology_api_default;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CardIdentifierBuilder,