scryfall-api 2.2.0 → 3.0.1

package/CHANGELOG.md

@@ -1,40 +1,13 @@
-# Changelog
+# scryfall-api
 
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+## 3.0.1
 
-## [2.2.0](https://bitbucket.org/MarioMH/scryfall-api/compare/v2.1.4...v2.2.0) (2021-10-18)
+### Patch Changes
 
+-   30beaf5: Fixed readme in npm.js
 
-### Features
+## 3.0.0
 
-* exposed hasMore property in MagicPageResult ([c21ea6e](https://bitbucket.org/MarioMH/scryfall-api/commit/c21ea6e3c814de9742169c888f7e41f3713c3cb9))
+### Major Changes
 
-### [2.1.4](https://bitbucket.org/MarioMH/scryfall-api/compare/v2.1.3...v2.1.4) (2021-10-18)
-
-
-### Bug Fixes
-
-* fixed index exports ([d0e8835](https://bitbucket.org/MarioMH/scryfall-api/commit/d0e8835b61467b8119b33fc3407f64ea3aa333d1))
-
-### [2.1.3](https://bitbucket.org/MarioMH/scryfall-api/compare/v2.1.2...v2.1.3) (2021-10-18)
-
-
-### Bug Fixes
-
-* fixed index exports ([5087d91](https://bitbucket.org/MarioMH/scryfall-api/commit/5087d91cd8129b572332aff73a6e24fe0bd5470b))
-
-### [2.1.2](https://bitbucket.org/MarioMH/scryfall-api/compare/v2.1.1...v2.1.2) (2021-10-16)
-
-### [2.1.1](https://bitbucket.org/MarioMH/scryfall-api/compare/v2.1.0...v2.1.1) (2021-10-16)
-
-## 2.1.0 (2021-10-16)
-
-
-### Features
-
-* removed BulkData ([110d6e2](https://bitbucket.org/MarioMH/scryfall-api/commit/110d6e27d6bdd98889e760d33c122713371b491d))
-
-
-### Bug Fixes
-
-* removed invalid condition ([c74c0c7](https://bitbucket.org/MarioMH/scryfall-api/commit/c74c0c793bf43058c7a705b043b3cfd661a35206))
+-   91baaf8: Migrated repository to GitHub.

package/DOCUMENTATION.md

@@ -0,0 +1,505 @@
+## Table of Contents
+
+-   [Usage](#usage)
+-   [Cards](#cards)
+    -   [`Cards.autoCompleteName(name: string): Promise<string[]>;` ](#cardsautocompletenamename-string-promisestring-)
+    -   [`Cards.byArenaId(id: number): Promise<Card | undefined>;` ](#cardsbyarenaidid-number-promiscard-undefined-)
+    -   [`Cards.byId(id: string): Promise<Card | undefined>;`](#cardsbyidid-string-promiscard-undefined-)
+    -   [`Cards.byMtgoId(id: number): Promise<Card | undefined>;` ](#cardsbymtgoidid-number-promiscard-undefined-)
+    -   [`Cards.byMultiverseId(id: number): Promise<Card | undefined>;` ](#cardsbymultiverseidid-number-promiscard-undefined-)
+    -   [`Cards.byName(name: string, fuzzy = false): Promise<Card | undefined>;`](#cardsbynamename-string-set-string-fuzzy-false-promiscard-undefined-)
+    -   [`Cards.byName(name: string, set?: string, fuzzy = false): Promise<Card | undefined>;`](#cardsbynamename-string-set-string-fuzzy-false-promiscard-undefined-)
+    -   [`Cards.bySet(code: string, collectorId: number, lang?: string): Promise<Card | undefined>;`](#cardsbysetsetcode-string-collectornumber-number-lang-string-promiscard-undefined-)
+    -   [`Cards.byTcgPlayerId(id: number): Promise<Card | undefined>;` ](#cardsbytcgplayeridid-number-promiscard-undefined-)
+    -   [`Cards.collection(...collection: CardIdentifier[]): Promise<Card[]>;`](#cardscollectioncollection-cardidentifier-promiscard-)
+    -   [`Cards.random(id: number): Promise<Card | undefined>;` ](#cardsrandomid-number-promiscard-undefined-)
+    -   [`Cards.search(query: string, options?: SearchOptions | number): MagicPageResult<Card, Cards>;` ](#cardssearchquery-string-options-searchoptions-number-magicpageresultcard-cards-)
+-   [Sets](#sets)
+    -   [`Sets.all(): Promise<Set[]>;` ](#setsall-promisset-)
+    -   [`Sets.byCode(code: string): Promise<Set>;` ](#setsbycodecode-string-promisset-)
+    -   [`Sets.byId(id: string): Promise<Set>;` ](#setsbyidid-string-promisset-)
+    -   [`Sets.byTcgPlayerId(id: number): Promise<Set>;` ](#setsbytcgplayeridid-number-promisset-)
+-   [Rulings](#rulings)
+    -   [`Rulings.byArenaId(id: number): Promise<Ruling[]>;` ](#rulingsbyarenaidid-number-promisruling-)
+    -   [`Rulings.byId(id: string): Promise<Ruling[]>;` ](#rulingsbyidid-string-promisruling-)
+    -   [`Rulings.byMtgoId(id: number): Promise<Ruling[]>;` ](#rulingsbymtgoidid-number-promisruling-)
+    -   [`Rulings.byMultiverseId(id: number): Promise<Ruling[]>;` ](#rulingsbymultiverseidid-number-promisruling-)
+    -   [`Rulings.bySet(code: string, collectorId: string | number): Promise<Ruling[]>;` ](#rulingsbysetcode-string-collectorid-string-number-promisruling-)
+-   [Symbology](#symbology)
+    -   [`Symbology.all(): Promise<CardSymbol[]>;`](#symbologyall-promiscardsymbol-)
+    -   [`Symbology.parseMana(mana: string): Promise<ManaCost>;` ](#symbologyparsemanamana-string-promismanacost-)
+-   [Catalogs](#catalogs)
+    -   [`Catalog.artifactTypes(): Promise<string[]>;` ](#catalogartifacttypes-promisstring-)
+    -   [`Catalog.artistNames(): Promise<string[]>;` ](#catalogartistnames-promisstring-)
+    -   [`Catalog.cardNames(): Promise<string[]>;` ](#catalogcardnames-promisstring-)
+    -   [`Catalog.creatureTypes(): Promise<string[]>;` ](#catalogcreaturetypes-promisstring-)
+    -   [`Catalog.enchantmentTypes(): Promise<string[]>;` ](#catalogenchantmenttypes-promisstring-)
+    -   [`Catalog.landTypes(): Promise<string[]>;`](#cataloglandtypes-promisstring-)
+    -   [`Catalog.loyalties(): Promise<string[]>;` ](#catalogloyalties-promisstring-)
+    -   [`Catalog.planeswalkerTypes(): Promise<string[]>;` ](#catalogplaneswalkertypes-promisstring-)
+    -   [`Catalog.powers(): Promise<string[]>;` ](#catalogpowers-promisstring-)
+    -   [`Catalog.spellTypes(): Promise<string[]>;` ](#catalogspelltypes-promisstring-)
+    -   [`Catalog.toughnesses(): Promise<string[]>;`](#catalooughnesses-promisstring-)
+    -   [`Catalog.watermarks(): Promise<string[]>;` ](#catalogwatermarks-promisstring-)
+    -   [`Catalog.wordBank(): Promise<string[]>;`](#catalogwordbank-promisstring-)
+-   [Misc](#misc)
+    -   [`Misc.homepageLinks(): Promise<string[]>;`](#mischomepagelinks-promisstring)
+
+## Usage [↑](#table-of-contents)
+
+In the documentation below, requiring the package is assumed.
+
+```js
+const Scry = require('scryfall-api');
+```
+
+Or with TypeScrypt:
+
+```ts
+import * as Scry from 'scryfall-api';
+```
+
+If you only need Cards
+
+```ts
+import { Cards } from 'scryfall-api';
+```
+
+## Cards [↑](#table-of-contents)
+
+### `Cards.autoCompleteName(name: string): Promise<string[]>;` [↑](#table-of-contents)
+
+From the [Scryfall documentation](https://scryfall.com/docs/api/cards/autocomplete):
+
+Returns [an array] containing up to 25 full card names that could be autocompletions of the given string parameter q.
+
+This method is designed for creating assistive UI elements that allow users to free-type card names.
+The names are sorted with the nearest match first.
+
+Spaces, punctuation, and capitalization are ignored.
+
+If q is less than 2 characters long, or if no names match, the Catalog will contain 0 items(instead of returning any errors).
+
+```ts
+import { Cards } from 'scryfall-api';
+
+Cards.autoCompleteName('bloodsc').then(results => {
+	for (const result of results) {
+		console.log(result);
+		// Bloodscent
+		// Blood Scrivener
+		// Bloodscale Prowler
+		// Burning-Tree Bloodscale
+		// Ghor-Clan Bloodscale
+	}
+});
+```
+
+### `Cards.byArenaId(id: number): Promise<Card | undefined>;` [↑](#table-of-contents)
+
+Gets a card based on its MTG Arena id.
+
+```ts
+import { Cards } from 'scryfall-api';
+
+Cards.byArenaId(67330).then(result => console.log(result.name)); // Yargle, Glutton of Urborg
+```
+
+### `Cards.byId(id: string): Promise<Card | undefined>;` [↑](#table-of-contents)
+
+Gets a single card from its ID.
+
+```ts
+import { Cards } from 'scryfall-api';
+
+Cards.byId('9ea8179a-d3c9-4cdc-a5b5-68cc73279050').then(result => console.log(result.name)); // Blood Scrivener
+```
+
+### `Cards.byMtgoId(id: number): Promise<Card | undefined>;` [↑](#table-of-contents)
+
+Gets a card based on its MTGO(sometimes called "Cat") id.
+
+```ts
+import { Cards } from 'scryfall-api';
+
+Cards.byMtgoId(48338).then(result => console.log(result.name)); // Blood Scrivener
+```
+
+### `Cards.byMultiverseId(id: number): Promise<Card | undefined>;` [↑](#table-of-contents)
+
+Gets a card based on its multiverse id.
+
+```ts
+Cards.byMultiverseId(369030).then(result => console.log(result.name)); // Blood Scrivener
+```
+
+### `Cards.byName(name: string, set?: string, fuzzy = false): Promise<Card | undefined>;` [↑](#table-of-contents)
+
+Gets a card based on its name. Supports fuzzy searching, by 1-2 replacements/translations.
+
+```ts
+import { Cards } from 'scryfall-api';
+
+Cards.byName('Blood Scrivener').then(result => console.log(result.name)); // Blood Scrivener
+Cards.byName('Bliid Scrivener', true).then(result => console.log(result.name)); // Blood Scrivener
+Cards.byName('Loxodon Warhammer', 'MRD').then(result => console.log(result.name, result.set)); // Loxodon Warhammer, mrd
+Cards.byName('Warhammer', 'MRD', true).then(result => console.log(result.name, result.set)); // Loxodon Warhammer, mrd
+```
+
+### `Cards.bySet(setCode: string, collectorNumber: number, lang?: string): Promise<Card | undefined>;` [↑](#table-of-contents)
+
+Gets a card based on its set and collector id. You can use the optional `lang` argument to get cards in another language. See the [Scryfall Documentation for a list of all languages](https://scryfall.com/docs/api/languages).
+
+```ts
+import { Cards } from 'scryfall-api';
+
+Cards.bySet('dgm', 22).then(result => console.log(result.name + ', ' + result.printed_name)); // Blood Scrivener, undefined
+Cards.bySet('dgm', 22, 'ja').then(result => console.log(result.name + ', ' + result.printed_name)); // Blood Scrivener, 血の公証人
+```
+
+### `Cards.byTcgPlayerId(id: number): Promise<Card | undefined>;` [↑](#table-of-contents)
+
+Gets a card based on its TCG Player id.
+
+```ts
+import { Cards } from 'scryfall-api';
+
+Cards.byTcgPlayerId(1030).then(result => console.log(result.name)); // Ankh of Mishra
+```
+
+### `Cards.collection(...collection: CardIdentifier[]): Promise<Card[]>;` [↑](#table-of-contents)
+
+Takes a list of "card identifiers", which describe a card, and returns their actual card objects.
+
+This method is useful for decks and even entire collections. Scryfall has a limit of 75 cards, but this API will split your request into multiple API calls, allowing requests of _as many cards as you want_.
+
+In order to assist with manual requests, this method comes with a new set of factories by the name `CardIdentifier`. These are:
+
+-   `CardIdentifier.byId(id: string): CardIdentifier;`
+-   `CardIdentifier.byMultiverseId(id: number): CardIdentifier;`
+-   `CardIdentifier.byMtgoId(id: number): CardIdentifier;`
+-   `CardIdentifier.byOracleId(id: string): CardIdentifier;`
+-   `CardIdentifier.byIllustrationId(id: string): CardIdentifier;`
+-   `CardIdentifier.byName(string: string, set?: string): CardIdentifier;`
+-   `CardIdentifier.byName(string: string, set?: string): CardIdentifier;`
+-   `CardIdentifier.bySet(set: string, collectorNumber: string | number): CardIdentifier;`
+
+```ts
+import { Cards, CardIdentifier } from 'scryfall-api';
+
+const collection = [
+	CardIdentifier.byId('94c70f23-0ca9-425e-a53a-6c09921c0075'),
+	CardIdentifier.byMultiverseId(462293),
+	CardIdentifier.byMtgoId(71692),
+	CardIdentifier.byOracleId('394c6de5-7957-4a0b-a6b9-ee0c707cd022'),
+	CardIdentifier.byIllustrationId('99f43949-049e-41e2-bf4c-e22e11790012'),
+	CardIdentifier.byName('Blood Scrivener'),
+	CardIdentifier.byName('Lightning Bolt', 'prm'),
+	CardIdentifier.bySet('mrd', '150'),
+];
+
+const cards = await Cards.collection(...collection);
+// every card identifier has been mapped to its real card object
+
+for (const card of cards) {
+	console.log(card.name);
+}
+// Crush Dissent
+// Contentious Plan
+// Bond of Insight
+// Forgotten Cave
+// GO TO JAIL
+// Blood Scrivener
+// Lightning Bolt
+// Chalice of the Void
+```
+
+### `Cards.random(id: number): Promise<Card | undefined>;` [↑](#table-of-contents)
+
+Gets a random card.
+
+```ts
+import { Cards } from 'scryfall-api';
+
+Cards.random().then(result => console.log(result.name));
+```
+
+### `Cards.search(query: string, options?: SearchOptions | number): MagicPageResult<Card, Cards>;` [↑](#table-of-contents)
+
+Queries for a card using the [Scryfall Search API](https://scryfall.com/docs/reference).
+
+```ts
+import { Cards } from 'scryfall-api';
+
+Cards.search('type:planeswalker')
+	.all()
+	.then(result => console.log(result.name));
+```
+
+For information on how to provide extra options, see the [`/get/cards/search`](https://scryfall.com/docs/api/cards/search) page on Scryfall. You can also reference the [`SearchOptions`](src/types/SearchOptions.ts) interface
+
+This query returns a [`MagicPageResult`](#magicemittert-).
+
+The page parameter is the page of results that the query will begin at. A page is 175 cards, and cannot be changed. To get only the one page you requested, you can do the following:
+
+```ts
+import { Cards } from 'scryfall-api';
+
+// Start in page 13
+const result = Cards.search('type:planeswalker', 13);
+
+// Get page 13
+const cardsFromPage13 = await result.next(); // cardsFromPage13.lenth === 175
+
+// Get page 14
+const cardsFromPage14 = await result.next(); // cardsFromPage14.lenth === 175
+
+// Or you can get any page directly by
+const cardsFromPage15 = await result.page(15); // cardsFromPage15.lenth === 175
+```
+
+You can bypass the 175 card limit by using:
+
+```ts
+import { Cards } from 'scryfall-api';
+
+// Get 300 cards starting on page 1
+const result1 = await Cards.search('type:planeswalker').get(200); // result.lenth === 200
+
+// Get 300 cards starting on page 13
+const result2 = await Cards.search('type:planeswalker', 13).get(300); // result.lenth === 300
+```
+
+## Sets [↑](#table-of-contents)
+
+### `Sets.all(): Promise<Set[]>;` [↑](#table-of-contents)
+
+Gets all sets.
+
+```ts
+import { Sets } from 'scryfall-api';
+
+Sets.all().then(result => console.log(result.lenh));
+```
+
+### `Sets.byCode(code: string): Promise<Set>;` [↑](#table-of-contents)
+
+Gets a set by its code.
+
+```ts
+import { Sets } from 'scryfall-api';
+
+Sets.byCode('hou').then(set => console.log(set.name)); // Hour of Devastation
+```
+
+### `Sets.byId(id: string): Promise<Set>;` [↑](#table-of-contents)
+
+Gets a set by its Scryfall ID.
+
+```ts
+import { Sets } from 'scryfall-api';
+
+Sets.byId('65ff168b-bb94-47a5-a8f9-4ec6c213e768').then(set => console.log(set.name)); // Hour of Devastation
+```
+
+### `Sets.byTcgPlayerId(id: number): Promise<Set>;` [↑](#table-of-contents)
+
+Gets a set by its TCG Player ID, also known as the `groupId` on [TCGPlayer's API](https://docs.tcgplayer.com/docs).
+
+```ts
+import { Sets } from 'scryfall-api';
+
+Sets.byTcgPlayerId(1934).then(set => console.log(set.name)); // Hour of Devastation
+```
+
+## Rulings [↑](#table-of-contents)
+
+### `Rulings.byArenaId(id: number): Promise<Ruling[]>;` [↑](#table-of-contents)
+
+Gets the rulings for a card based on its Arena id.
+
+```ts
+import { Rulings } from 'scryfall-api';
+
+Rulings.byArenaId(67204).then(result => console.log(result.lenh)); // 3
+```
+
+### `Rulings.byId(id: string): Promise<Ruling[]>;` [↑](#table-of-contents)
+
+Gets the rulings for a single card from its ID.
+
+```ts
+import { Rulings } from 'scryfall-api';
+
+Rulings.byId('9ea8179a-d3c9-4cdc-a5b5-68cc73279050').then(result => console.log(result.lenh)); // 2
+```
+
+### `Rulings.byMtgoId(id: number): Promise<Ruling[]>;` [↑](#table-of-contents)
+
+Gets the rulings for a card based on its MTGO(sometimes called "Cat") id.
+
+```ts
+import { Rulings } from 'scryfall-api';
+
+Rulings.byMtgoId(48338).then(result => console.log(result.lenh)); // 2
+```
+
+### `Rulings.byMultiverseId(id: number): Promise<Ruling[]>;` [↑](#table-of-contents)
+
+Gets the rulings for a card based on its multiverse id.
+
+```ts
+import { Rulings } from 'scryfall-api';
+
+Rulings.byMultiverseId(369030).then(result => console.log(result.lenh)); // 2
+```
+
+### `Rulings.bySet(code: string, collectorId: string | number): Promise<Ruling[]>;` [↑](#table-of-contents)
+
+Gets the rulings for a card based on its set and collector id.
+
+```ts
+import { Rulings } from 'scryfall-api';
+
+Rulings.bySet('dgm', '22').then(result => console.log(result.lenh)); // 2
+```
+
+## Symbology [↑](#table-of-contents)
+
+### `Symbology.all(): Promise<CardSymbol[]>;` [↑](#table-of-contents)
+
+Gets all [card symbols](https://scryfall.com/docs/api/card-symbols).
+
+```ts
+import { Symbology } from 'scryfall-api';
+
+Symbology.all().then(result => console.log(result.lenh)); // 63
+```
+
+### `Symbology.parseMana(mana: string): Promise<ManaCost>;` [↑](#table-of-contents)
+
+From the [Scryfall documentation](https://scryfall.com/docs/api/card-symbols/parse-mana):
+
+Parses the given mana cost parameter and returns Scryfall’s interpretation.
+
+The server understands most community shorthand for mana costs(such as `2WW` for `{2}{W}{W}`). Symbols can also be out of order, lowercase, or have multiple colorless costs(such as `2{g}2` for `{4}{G}`).
+
+```ts
+import { Symbology } from 'scryfall-api';
+
+Symbology.parseMana('7wg').then(result => console.log(result.cost)); // {7}{W}{G}
+```
+
+## Catalogs [↑](#table-of-contents)
+
+### `Catalog.cardNames(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.cardNames().then(result => console.log(result.lenh)); // 18059
+```
+
+### `Catalog.artistNames(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.artistNames().then(result => console.log(result.lenh)); // 676
+```
+
+### `Catalog.wordBank(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.wordBank().then(result => console.log(result.lenh)); // 12892
+```
+
+### `Catalog.creatureTypes(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.creatureTypes().then(result => console.log(result.lenh)); // 242
+```
+
+### `Catalog.planeswalkerTypes(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.planeswalkerTypes().then(result => console.log(result.lenh)); // 42
+```
+
+### `Catalog.landTypes(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.landTypes().then(result => console.log(result.lenh)); // 13
+```
+
+### `Catalog.artifactTypes(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.artifactTypes().then(result => console.log(result.lenh)); // 6
+```
+
+### `Catalog.enchantmentTypes(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.enchantmentTypes().then(result => console.log(result.lenh)); // 5
+```
+
+### `Catalog.spellTypes(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.spellTypes().then(result => console.log(result.lenh)); // 2
+```
+
+### `Catalog.powers(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.powers().then(result => console.log(result.lenh)); // 33
+```
+
+### `Catalog.toughnesses(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.toughnesses().then(result => console.log(result.lenh)); // 35
+```
+
+### `Catalog.loyalties(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.loyalties().then(result => console.log(result.lenh)); // 9
+```
+
+### `Catalog.watermarks(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+import { Catalog } from 'scryfall-api';
+
+Catalog.watermarks().then(result => console.log(result.lenh)); // 50
+```
+
+## Misc [↑](#table-of-contents)
+
+### `Misc.homepageLinks(): Promise<string[]>;` [↑](#table-of-contents)
+
+```ts
+Misc.homepageLinks().then(result => console.log(result.lenh)); // 4
+```

package/LICENSE

@@ -1,7 +1,21 @@
-Copyright 2017-2021 Mackenzie McClane
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2021-2022 Mario Menéndez
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,11 +1,11 @@
 # scryfall-api
 
-[![npm](https://img.shields.io/npm/v/scryfall-api.svg?style=flat-square)](https://www.npmjs.com/package/scryfall-api)
-[![GitHub issues](https://img.shields.io/bitbucket/issues/MarioMH/scryfall-api.svg?style=flat-square)](https://bitbucket.org/MarioMH/scryfall-api.git)
+[![npm](https://img.shields.io/npm/v/scryfall-api?style=flat-square)](https://www.npmjs.com/package/scryfall-api)
+[![GitHub issues](https://img.shields.io/github/issues/mariomh8/scryfall-api?style=flat-square)](https://github.com/MarioMH8/scryfall-api)
 
-A Node.js SDK for [Scryfall](https://scryfall.com/docs/api) written in Typescript.
+A Javascript library for [Scryfall](https://scryfall.com/docs/api) written in Typescript.
 
-As of [October 16th, 2021](./CHANGELOG.md), all features described in the [Scryfall documentation](https://scryfall.com/docs/api) are supported. If you see something that isn't supported, make an issue! See [support readme](./SUPPORT.md).
+As of [January 29th, 2022](./CHANGELOG.md), almost all features described in the [Scryfall documentation](https://scryfall.com/docs/api) are supported. If you see something that isn't supported, make an issue! See [support readme](./SUPPORT.md).
 
 ## Installation
 
@@ -22,9 +22,9 @@ Link to [documentation.](./DOCUMENTATION.md)
 Thanks for wanting to help out! Here's the setup you'll have to do:
 
 ```bat
-git clone https://bitbucket.org/MarioMH/scryfall-api.git
+git clone git@github.com:MarioMH8/scryfall-api.git
 cd scryfall-api
-npm install
+yarn install
 ```
 
 You can now make changes to the repository.
@@ -32,15 +32,9 @@ You can now make changes to the repository.
 To compile:
 
 ```bat
-npm run build
-```
-
-To compile on every file change:
-
-```bat
-npm run build:watch
+yarn build
 ```
 
 ## MIT License
 
-[Copyright 2017-2021 Mackenzie McClane](./LICENSE)
+[Copyright 2021-2022 Mario Menéndez](./LICENSE)

package/SUPPORT.md

@@ -0,0 +1,38 @@
+## Supported:
+
+| Query                                                                                                                             | Result             |
+| --------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
+| [`/cards/named?{fuzzy/exact}=<card name>`](DOCUMENTATION.md#cardsbyname-name-string-fuzzy--false-promisecard-)                    | Card               |
+| [`/cards/:id`](DOCUMENTATION.md#cardsbyid-id-string-promisecard-)                                                                 | Card               |
+| [`/cards/:set/:collector_number(/:lang)`](DOCUMENTATION.md#cardsbyset-setcode-string-collectorid-number-lang-string-promisecard-) | Card               |
+| [`/cards/multiverse/:multiverse_id`](DOCUMENTATION.mdardsbymultiverseid-id-number-promisecard-)                                   | Card               |
+| [`/cards/mtgo/:mtgo_id`](DOCUMENTATION.mdardsbymtgoid-id-number-promisecard-)                                                     | Card               |
+| [`/cards/arena/:id`](DOCUMENTATION.mdardsbyarenaid-id-number-promisecard-)                                                        | Card               |
+| [`/cards/tcgplayer/:id`](DOCUMENTATION.mdardsbytcgplayerid-id-number-promisecard-)                                                | Card               |
+| [`/cards/random`](DOCUMENTATION.mdardsrandom-id-number-promisecard-)                                                              | Card               |
+| [`/cards/search?q=:query`](DOCUMENTATION.mdardssearch-query-string-magicemittercard-)                                             | List\<Card\>       |
+| [`/cards/autocomplete?q=:query`](DOCUMENTATION.mdardsautocompletename-name-string-promisestring-)                                 | Catalog            |
+| [`/cards/collection`](DOCUMENTATION.mdardscollection-collection-cardidentifier-magicemittercard-)                                 | List\<Card\>       |
+| [`/sets`](DOCUMENTATION.mdetsall--promiseset-)                                                                                    | List\<Set\>        |
+| [`/sets/:code`](DOCUMENTATION.mdetsbycode-code-string-promiseset-)                                                                | Set                |
+| [`/sets/:id`](DOCUMENTATION.mdetsbyid-id-string-promiseset-)                                                                      | Set                |
+| [`/sets/tcgplayer/:id`](DOCUMENTATION.mdetsbytcgplayerid-id-number-promiseset-)                                                   | Set                |
+| [`/cards/multiverse/:id/rulings`](DOCUMENTATION.mdulingsbymultiverseid-id-number-promiseruling-)                                  | List\<Ruling\>     |
+| [`/cards/mtgo/:id/rulings`](DOCUMENTATION.mdulingsbymtgoid-id-number-promiseruling-)                                              | List\<Ruling\>     |
+| [`/cards/arena/:id/rulings`](DOCUMENTATION.mdulingsbyarenaid-id-number-promiseruling-)                                            | List\<Ruling\>     |
+| [`/cards/:code/:number/rulings`](DOCUMENTATION.mdulingsbyset-code-string-collectorid-string-promiseruling-)                       | List\<Ruling\>     |
+| [`/cards/:id/rulings`](DOCUMENTATION.mdulingsbyid-id-string-promiseruling-)                                                       | List\<Ruling\>     |
+| [`/symbology`](DOCUMENTATION.mdymbologyall--promisecardsymbol-)                                                                   | List\<CardSymbol\> |
+| [`/symbology/parse-mana?cost=:cost`](DOCUMENTATION.mdymbologyparsemana-mana-string-promisemanacost-)                              | ManaCost           |
+| [`/catalog/card-names`](DOCUMENTATION.mdatalogcardnames--promisestring-)                                                          | Catalog            |
+| [`/catalog/word-bank`](DOCUMENTATION.mdatalogwordbank--promisestring-)                                                            | Catalog            |
+| [`/catalog/creature-types`](DOCUMENTATION.mdatalogcreaturetypes--promisestring-)                                                  | Catalog            |
+| [`/catalog/planeswalker-types`](DOCUMENTATION.mdatalogplaneswalkertypes--promisestring-)                                          | Catalog            |
+| [`/catalog/land-types`](DOCUMENTATION.mdataloglandtypes--promisestring-)                                                          | Catalog            |
+| [`/catalog/artifact-types`](DOCUMENTATION.mdatalogartifacttypes--promisestring-)                                                  | Catalog            |
+| [`/catalog/enchantment-types`](DOCUMENTATION.mdatalogenchantmenttypes--promisestring-)                                            | Catalog            |
+| [`/catalog/spell-types`](DOCUMENTATION.mdatalogspelltypes--promisestring-)                                                        | Catalog            |
+| [`/catalog/powers`](DOCUMENTATION.mdatalogpowers--promisestring-)                                                                 | Catalog            |
+| [`/catalog/toughnesses`](DOCUMENTATION.mdatalogtoughnesses--promisestring-)                                                       | Catalog            |
+| [`/catalog/loyalties`](DOCUMENTATION.mdatalogloyalties--promisestring-)                                                           | Catalog            |
+| [`/catalog/watermarks`](DOCUMENTATION.mdatalogwatermarks--promisestring-)                                                         | Catalog            |

package/dist/scryfall-api.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./declarations/src/index";