scryfall-api 1.0.7 → 2.1.0

package/CHANGELOG.md

@@ -2,16 +2,14 @@
 
 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.
 
-### [1.0.7](https://bitbucket.org/MarioMH/scryfall-api/compare/v1.0.6...v1.0.7) (2021-06-16)
+## 2.1.0 (2021-10-16)
 
-### [1.0.6](https://bitbucket.org/MarioMH/scryfall-api/compare/v1.0.5...v1.0.6) (2021-04-07)
 
-### [1.0.5](http://bitbucket.org/MarioMH/scryfall-api/compare/v1.0.4...v1.0.5) (2021-04-07)
+### Features
 
-### [1.0.4](http://bitbucket.org/MarioMH/scryfall-api/compare/v1.0.3...v1.0.4) (2021-04-07)
+* removed BulkData ([110d6e2](https://bitbucket.org/MarioMH/scryfall-api/commit/110d6e27d6bdd98889e760d33c122713371b491d))
 
-### [1.0.3](http://bitbucket.org/MarioMH/scryfall-api/compare/v1.0.2...v1.0.3) (2021-04-07)
 
-### [1.0.2](http://bitbucket.org/MarioMH/scryfall-api/compare/v1.0.1...v1.0.2) (2021-04-07)
+### Bug Fixes
 
-### 1.0.1 (2021-04-07)
+* removed invalid condition ([c74c0c7](https://bitbucket.org/MarioMH/scryfall-api/commit/c74c0c793bf43058c7a705b043b3cfd661a35206))

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)
 
 A Node.js SDK for [Scryfall](https://scryfall.com/docs/api) written in Typescript.
 
-As of [April 7th, 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 [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).
 
 ## Installation
 
@@ -13,31 +13,34 @@ As of [April 7th, 2021](./CHANGELOG.md), all features described in the [Scryfall
 npm install scryfall-api
 ```
 
-
 ## Documentation
-Link to [documentation.](./DOCUMENTATION.md)
 
+Link to [documentation.](./DOCUMENTATION.md)
 
 ## Contributing
 
 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
 cd scryfall-api
 npm install
 ```
-You can now make changes to the repository. 
+
+You can now make changes to the repository.
 
 To compile, then test:
+
 ```bat
 npm run build
 ```
+
 To compile and then test on every file change:
+
 ```bat
 npm run build:watch
 ```
 
-
 ## MIT License
 
 [Copyright 2017-2021 Mackenzie McClane](./LICENSE)

package/lib/api/CardIdfentifier.d.ts

@@ -0,0 +1,9 @@
+export declare class CardIdentifier {
+    static byId(id: string): CardIdentifier;
+    static byIllustrationId(id: string): CardIdentifier;
+    static byMtgoId(id: number): CardIdentifier;
+    static byMultiverseId(id: number): CardIdentifier;
+    static byName(name: string, set?: string): CardIdentifier;
+    static byOracleId(id: string): CardIdentifier;
+    static bySet(set: string, collectorNumber: string | number): CardIdentifier;
+}

package/lib/api/Cards.d.ts

@@ -1,327 +1,19 @@
-import { Color } from '..';
-import MagicEmitter from '../util/MagicEmitter';
-import MagicQuerier from '../util/MagicQuerier';
-import { Set } from './Sets';
-declare enum UniqueStrategy {
-    cards = 0,
-    art = 1,
-    prints = 2
-}
-declare enum Sort {
-    name = 0,
-    set = 1,
-    released = 2,
-    rarity = 3,
-    color = 4,
-    usd = 5,
-    tix = 6,
-    eur = 7,
-    cmc = 8,
-    power = 9,
-    toughness = 10,
-    edhrec = 11,
-    artist = 12
-}
-declare enum SortDirection {
-    auto = 0,
-    asc = 1,
-    desc = 2
-}
-export interface SearchOptions {
-    unique?: keyof typeof UniqueStrategy;
-    order?: keyof typeof Sort;
-    dir?: keyof typeof SortDirection;
-    include_extras?: boolean;
-    include_multilingual?: boolean;
-    include_variations?: boolean;
-    /**
-     * The page to start on. Defaults to `1`, for first page. A page is 175 cards.
-     */
-    page?: number;
-}
-declare enum Rarity {
-    common = 0,
-    uncommon = 1,
-    rare = 2,
-    mythic = 3
-}
-declare enum FrameEffect {
-    legendary = 0,
-    miracle = 1,
-    nyxtouched = 2,
-    draft = 3,
-    devoid = 4,
-    tombstone = 5,
-    colorshifted = 6,
-    inverted = 7,
-    sunmoondfc = 8,
-    compasslanddfc = 9,
-    originpwdfc = 10,
-    mooneldrazidfc = 11,
-    moonreversemoondfc = 12,
-    showcase = 13,
-    extendedart = 14
-}
-declare enum Game {
-    paper = 0,
-    arena = 1,
-    mtgo = 2
-}
-declare enum Legality {
-    legal = 0,
-    not_legal = 1,
-    restricted = 2,
-    banned = 3
-}
-declare enum Border {
-    black = 0,
-    borderless = 1,
-    gold = 2,
-    silver = 3,
-    white = 4
-}
-declare enum Layout {
-    normal = 0,
-    split = 1,
-    flip = 2,
-    transform = 3,
-    meld = 4,
-    leveler = 5,
-    saga = 6,
-    adventure = 7,
-    planar = 8,
-    scheme = 9,
-    vanguard = 10,
-    token = 11,
-    double_faced_token = 12,
-    emblem = 13,
-    augment = 14,
-    host = 15,
-    art_series = 16,
-    double_sided = 17
-}
-declare enum Format {
-    standard = 0,
-    future = 1,
-    historic = 2,
-    pioneer = 3,
-    modern = 4,
-    legacy = 5,
-    pauper = 6,
-    vintage = 7,
-    penny = 8,
-    commander = 9,
-    brawl = 10,
-    duel = 11,
-    oldschool = 12
-}
-export declare type Legalities = {
-    [key in keyof typeof Format]: keyof typeof Legality;
-};
-export interface ImageUris {
-    small: string;
-    normal: string;
-    large: string;
-    png: string;
-    art_crop: string;
-    border_crop: string;
-}
-export interface Prices {
-    usd?: string | null;
-    usd_foil?: string | null;
-    eur?: string | null;
-    tix?: string | null;
-}
-export interface PurchaseUris {
-    tcgplayer?: string | null;
-    cardmarket?: string | null;
-    cardhoarder?: string | null;
-    [key: string]: string | null | undefined;
-}
-export interface RelatedUris {
-    gatherer?: string | null;
-    tcgplayer_decks?: string | null;
-    edhrec?: string | null;
-    mtgtop8?: string | null;
-    [key: string]: string | null | undefined;
-}
-declare enum RelatedCardComponent {
-    token = 0,
-    meld_part = 1,
-    meld_result = 2,
-    combo_piece = 3
-}
-export interface RelatedCard {
-    object: 'related_card';
-    id: string;
-    component: keyof typeof RelatedCardComponent;
-    name: string;
-    type_line: string;
-    uri: string;
-}
-export interface CardFace {
-    object: 'card_face';
-    artist?: string | null;
-    color_indicator?: Color[] | null;
-    colors: Color[];
-    flavor_text?: string | null;
-    illustration_id?: string | null;
-    image_uris?: ImageUris | null;
-    loyalty?: string | null;
-    mana_cost: string;
-    name: string;
-    oracle_text?: string | null;
-    power?: string | null;
-    printed_name?: string | null;
-    printed_text?: string | null;
-    printed_type_line?: string | null;
-    toughness?: string | null;
-    type_line: string;
-    watermark?: string | null;
-}
-export interface Preview {
-    previewed_at?: string | null;
-    source_uri?: string | null;
-    source?: string | null;
-}
-declare enum PromoType {
-    tourney = 0,
-    prerelease = 1,
-    datestamped = 2,
-    planeswalkerdeck = 3,
-    buyabox = 4,
-    judgegift = 5,
-    event = 6,
-    convention = 7,
-    starterdeck = 8,
-    instore = 9,
-    setpromo = 10,
-    fnm = 11,
-    openhouse = 12,
-    league = 13,
-    draftweekend = 14,
-    gameday = 15,
-    release = 16,
-    intropack = 17,
-    giftbox = 18,
-    duels = 19,
-    wizardsplaynetwork = 20,
-    premiereshop = 21,
-    playerrewards = 22,
-    gateway = 23,
-    arenaleague = 24
-}
-export interface Card {
-    object: 'card';
-    arena_id?: number | null;
-    id: string;
-    lang: string;
-    mtgo_id?: number | null;
-    mtgo_foil_id?: number | null;
-    multiverse_ids?: number[] | null;
-    tcgplayer_id?: number | null;
-    oracle_id: string;
-    prints_search_uri: string;
-    rulings_uri: string;
-    scryfall_uri: string;
-    uri: string;
-    all_parts?: RelatedCard[] | null;
-    card_faces?: CardFace[] | null;
-    cmc: number;
-    colors?: Color[] | null;
-    color_identity: Color[];
-    color_indicator?: Color[] | null;
-    edhrec_rank?: number | null;
-    foil: boolean;
-    hand_modifier?: string | null;
-    layout: keyof typeof Layout;
-    legalities: Legalities;
-    life_modifier?: string | null;
-    loyalty?: string | null;
-    mana_cost?: string | null;
-    name: string;
-    nonfoil: boolean;
-    oracle_text?: string | null;
-    oversized: boolean;
-    power?: string | null;
-    reserved: boolean;
-    toughness?: string | null;
-    type_line: string;
-    artist?: string | null;
-    artist_ids?: string[] | null;
-    booster: boolean;
-    border_color: keyof typeof Border;
-    card_back_id: string;
-    collector_number: string;
-    digital: boolean;
-    flavor_text?: string | null;
-    frame_effects?: (keyof typeof FrameEffect)[] | null;
-    frame: '1993' | '1997' | '2003' | '2015' | 'Future';
-    full_art: boolean;
-    games: (keyof typeof Game)[];
-    highres_image: boolean;
-    illustration_id?: string | null;
-    image_uris?: ImageUris | null;
-    prices: Prices;
-    printed_name?: string | null;
-    printed_text?: string | null;
-    printed_type_line?: string | null;
-    promo: boolean;
-    promo_types?: (keyof typeof PromoType)[] | null;
-    purchase_uris: PurchaseUris;
-    rarity: keyof typeof Rarity;
-    related_uris: RelatedUris;
-    released_at: string;
-    reprint: boolean;
-    scryfall_set_uri: string;
-    set_name: string;
-    set_search_uri: string;
-    set_type: Set['set_type'];
-    set_uri: string;
-    set: string;
-    story_spotlight: boolean;
-    textless: boolean;
-    variation: boolean;
-    variation_of?: string | null;
-    watermark?: string | null;
-    preview?: Preview | null;
-}
-export interface CardIdentifier {
-    id?: string;
-    mtgo_id?: number;
-    multiverse_id?: number;
-    oracle_id?: string;
-    illustration_id?: string;
-    name?: string;
-    set?: string;
-    collector_number?: string;
-}
-export declare class CardIdentifier {
-    static byId(id: string): CardIdentifier;
-    static byMtgoId(id: number): CardIdentifier;
-    static byMultiverseId(id: number): CardIdentifier;
-    static byOracleId(id: string): CardIdentifier;
-    static byIllustrationId(id: string): CardIdentifier;
-    static byName(name: string, set?: string): CardIdentifier;
-    static bySet(set: string, collectorNumber: string | number): CardIdentifier;
-}
-declare class Cards extends MagicQuerier {
-    byName(name: string, fuzzy?: boolean): Promise<Card>;
-    byName(name: string, set?: string, fuzzy?: boolean): Promise<Card>;
-    byId(id: string): Promise<Card>;
-    bySet(setCode: string, collectorNumber: number, lang?: string): Promise<Card>;
-    byMultiverseId(id: number): Promise<Card>;
-    byMtgoId(id: number): Promise<Card>;
-    byArenaId(id: number): Promise<Card>;
-    byTcgPlayerId(id: number): Promise<Card>;
-    random(): Promise<Card>;
-    /**
-     * Returns a MagicEmitter of every card in the Scryfall database that matches the given query.
-     */
-    search(query: string, options?: SearchOptions | number): MagicEmitter<Card, never>;
+import MagicPageResult from '../query/MagicPageResult';
+import MagicQuery from '../query/MagicQuery';
+import { Card, CardIdentifier, SearchOptions } from '../types';
+declare class Cards extends MagicQuery {
     autoCompleteName(name: string): Promise<string[]>;
-    collection(...identifiers: CardIdentifier[]): MagicEmitter<Card, CardIdentifier>;
-    private processCollection;
+    byArenaId(id: number): Promise<Card | undefined>;
+    byId(id: string): Promise<Card | undefined>;
+    byMtgoId(id: number): Promise<Card | undefined>;
+    byMultiverseId(id: number): Promise<Card | undefined>;
+    byName(name: string, fuzzy?: boolean): Promise<Card | undefined>;
+    byName(name: string, set?: string, fuzzy?: boolean): Promise<Card | undefined>;
+    bySet(setCode: string, collectorNumber: number, lang?: string): Promise<Card | undefined>;
+    byTcgPlayerId(id: number): Promise<Card | undefined>;
+    collection(...identifiers: CardIdentifier[]): Promise<Card[]>;
+    random(): Promise<Card | undefined>;
+    search(query: string, options?: SearchOptions | number): MagicPageResult<Card, Cards>;
 }
 declare const _default: Cards;
 export default _default;

package/lib/api/Cards.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/api/Catalog.d.ts

@@ -1,18 +1,18 @@
-import MagicQuerier from '../util/MagicQuerier';
-declare class Catalog extends MagicQuerier {
-    cardNames(): Promise<string[]>;
+import MagicQuery from '../query/MagicQuery';
+declare class Catalog extends MagicQuery {
+    artifactTypes(): Promise<string[]>;
     artistNames(): Promise<string[]>;
-    wordBank(): Promise<string[]>;
+    cardNames(): Promise<string[]>;
     creatureTypes(): Promise<string[]>;
-    planeswalkerTypes(): Promise<string[]>;
-    landTypes(): Promise<string[]>;
-    artifactTypes(): Promise<string[]>;
     enchantmentTypes(): Promise<string[]>;
-    spellTypes(): Promise<string[]>;
+    landTypes(): Promise<string[]>;
+    loyalties(): Promise<string[]>;
+    planeswalkerTypes(): Promise<string[]>;
     powers(): Promise<string[]>;
+    spellTypes(): Promise<string[]>;
     toughnesses(): Promise<string[]>;
-    loyalties(): Promise<string[]>;
     watermarks(): Promise<string[]>;
+    wordBank(): Promise<string[]>;
 }
 declare const _default: Catalog;
 export default _default;

package/lib/api/Catalog.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/api/Misc.d.ts

@@ -1,14 +1,6 @@
-import MagicQuerier from '../util/MagicQuerier';
-export interface HomepageLink {
-    id: number;
-    created_at: string;
-    updated_at: string;
-    priority: number;
-    text: string;
-    uri: string;
-    badge?: string | null;
-}
-declare class Misc extends MagicQuerier {
+import MagicQuery from '../query/MagicQuery';
+import { HomepageLink } from '../types';
+declare class Misc extends MagicQuery {
     homepageLinks(): Promise<HomepageLink[]>;
 }
 declare const _default: Misc;

package/lib/api/Misc.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/api/Rulings.d.ts

@@ -1,15 +1,11 @@
-import MagicQuerier from '../util/MagicQuerier';
-export interface Ruling {
-    source: string;
-    published_at: string;
-    comment: string;
-}
-declare class Rulings extends MagicQuerier {
+import MagicQuery from '../query/MagicQuery';
+import { Ruling } from '../types';
+declare class Rulings extends MagicQuery {
+    byArenaId(id: number): Promise<Ruling[]>;
     byId(id: string): Promise<Ruling[]>;
-    bySet(setCode: string, collectorNumber: string | number): Promise<Ruling[]>;
-    byMultiverseId(id: number): Promise<Ruling[]>;
     byMtgoId(id: number): Promise<Ruling[]>;
-    byArenaId(id: number): Promise<Ruling[]>;
+    byMultiverseId(id: number): Promise<Ruling[]>;
+    bySet(setCode: string, collectorNumber: string | number): Promise<Ruling[]>;
 }
 declare const _default: Rulings;
 export default _default;

package/lib/api/Rulings.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/api/Sets.d.ts

@@ -1,50 +1,10 @@
-import MagicQuerier from '../util/MagicQuerier';
-declare enum SetType {
-    core = 0,
-    expansion = 1,
-    masters = 2,
-    masterpiece = 3,
-    from_the_vault = 4,
-    spellbook = 5,
-    premium_deck = 6,
-    duel_deck = 7,
-    draft_innovation = 8,
-    treasure_chest = 9,
-    commander = 10,
-    planechase = 11,
-    archenemy = 12,
-    vanguard = 13,
-    funny = 14,
-    starter = 15,
-    box = 16,
-    promo = 17,
-    token = 18,
-    memorabilia = 19
-}
-export interface Set {
-    id: string;
-    code: string;
-    mtgo_code?: string | null;
-    tcgplayer_id?: number | null;
-    name: string;
-    set_type: keyof typeof SetType;
-    released_at?: string | null;
-    block_code?: string | null;
-    block?: string | null;
-    parent_set_code?: string | null;
-    card_count: number;
-    digital: boolean;
-    foil_only: boolean;
-    scryfall_uri: string;
-    uri: string;
-    icon_svg_uri: string;
-    search_uri: string;
-}
-declare class Sets extends MagicQuerier {
+import MagicQuery from '../query/MagicQuery';
+import { Set } from '../types';
+declare class Sets extends MagicQuery {
     all(): Promise<Set[]>;
-    byCode(code: string): Promise<Set>;
-    byId(id: string): Promise<Set>;
-    byTcgPlayerId(id: number): Promise<Set>;
+    byCode(code: string): Promise<Set | undefined>;
+    byId(id: string): Promise<Set | undefined>;
+    byTcgPlayerId(id: number): Promise<Set | undefined>;
 }
 declare const _default: Sets;
 export default _default;

package/lib/api/Sets.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/api/Symbology.d.ts

@@ -1,28 +1,8 @@
-import { Color } from '../util/Color';
-import MagicQuerier from '../util/MagicQuerier';
-export interface CardSymbol {
-    symbol: string;
-    loose_variant?: string | null;
-    english: string;
-    transposable: boolean;
-    represents_mana: boolean;
-    converted_mana_cost?: number | null;
-    colors: Color[];
-    appears_in_mana_costs: boolean;
-    funny: boolean;
-    gatherer_alternates?: string[] | null;
-}
-export interface ManaCost {
-    cost: string;
-    cmc: number;
-    colors: Color[];
-    colorless: boolean;
-    monocolored: boolean;
-    multicolored: boolean;
-}
-declare class Symbology extends MagicQuerier {
+import MagicQuery from '../query/MagicQuery';
+import { CardSymbol, ManaCost } from '../types';
+declare class Symbology extends MagicQuery {
     all(): Promise<CardSymbol[]>;
-    parseMana(shorthand: string): Promise<ManaCost>;
+    parseMana(shorthand: string): Promise<ManaCost | undefined>;
 }
 declare const _default: Symbology;
 export default _default;

package/lib/api/Symbology.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/error/MagicQueryError.d.ts

@@ -0,0 +1,5 @@
+import { SearchError } from '../types/SearchError';
+export declare class MagicQueryError extends Error {
+    readonly data?: SearchError | undefined;
+    constructor(data?: SearchError | undefined);
+}

package/lib/index.d.ts

@@ -1,26 +1 @@
-import { SearchError } from './util/MagicQuerier';
-export { default as BulkData } from './api/BulkData';
-export * from './api/Cards';
 export { default as Cards } from './api/Cards';
-export * from './api/Catalog';
-export { default as Catalog } from './api/Catalog';
-export * from './api/Misc';
-export { default as Misc } from './api/Misc';
-export * from './api/Rulings';
-export { default as Rulings } from './api/Rulings';
-export * from './api/Sets';
-export { default as Sets } from './api/Sets';
-export * from './api/Symbology';
-export { default as Symbology } from './api/Symbology';
-export * from './util/Color';
-/**
- * Returns the last error thrown while querying.
- */
-export declare function error(): SearchError | undefined;
-/**
- * Sets the API calls to retry if they fail, for any reason.
- * @param attempts The number of attempts that can be made (includes the initial call).
- * @param timeout The time that the query should wait before attempting the request again.
- * @param canRetry The function.
- */
-export declare function setRetry(attempts: number, timeout?: number, canRetry?: (error: SearchError) => boolean): void;

package/lib/query/MagicPageResult.d.ts

@@ -0,0 +1,17 @@
+import { PageQuery } from '../types';
+import MagicQuery from './MagicQuery';
+export default class MagicPageResult<T, Q extends MagicQuery, P = unknown> {
+    private readonly q;
+    private readonly apiPath;
+    private readonly query;
+    private readonly post?;
+    private hasMore;
+    constructor(q: Q, apiPath: string, query: PageQuery, post?: P | undefined);
+    private _count?;
+    get count(): number | undefined;
+    all(): Promise<T[]>;
+    get(limit: number): Promise<T[]>;
+    next(): Promise<T[]>;
+    page(page: number): Promise<T[]>;
+    private setNextPage;
+}

package/lib/query/MagicQuery.d.ts

@@ -0,0 +1,13 @@
+import { AxiosRequestConfig } from 'axios';
+import { Query, RetryStrategy, TOrArrayOfT } from '../types';
+export default class MagicQuery {
+    static retry: RetryStrategy;
+    private static readonly endpoint;
+    private static lastQuery;
+    private static readonly rateLimit;
+    private static canRetry;
+    private static debounce;
+    private static sleep;
+    private static tryQuery;
+    query<T = unknown, Y = unknown>(apiPath: TOrArrayOfT<string | number | undefined>, query?: Query, post?: Y, requestOptions?: AxiosRequestConfig): Promise<T | undefined>;
+}