scryfall-api 3.2.0 → 3.2.2

package/dist/types/src/types/index.d.ts

@@ -0,0 +1,42 @@
+export * from "./Border";
+export * from "./BulkDataDefinition";
+export * from "./BulkDataType";
+export * from "./BulkDataTypes";
+export * from "./Card";
+export * from "./CardFace";
+export * from "./CardIdentifier";
+export * from "./CardSymbol";
+export * from "./Color";
+export * from "./Format";
+export * from "./FrameEffect";
+export * from "./Game";
+export * from "./HomepageLink";
+export * from "./ImageUris";
+export * from "./Layout";
+export * from "./Legalties";
+export * from "./Legalty";
+export * from "./ManaCost";
+export * from "./PageQuery";
+export * from "./PageQueryValue";
+export * from "./Preview";
+export * from "./Prices";
+export * from "./PromoType";
+export * from "./PurchaseUris";
+export * from "./Query";
+export * from "./Rarity";
+export * from "./RelatedCard";
+export * from "./RelatedCardComponent";
+export * from "./RelatedUris";
+export * from "./ResultCatalog";
+export * from "./ResultData";
+export * from "./ResultList";
+export * from "./RetryStrategy";
+export * from "./Ruling";
+export * from "./SearchError";
+export * from "./SearchOptions";
+export * from "./Set";
+export * from "./SetType";
+export * from "./Sort";
+export * from "./SortDirection";
+export * from "./TOrArrayOfT";
+export * from "./UniqueStrategy";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "scryfall-api",
-	"version": "3.2.0",
+	"version": "3.2.2",
 	"description": "A Javascript library for https://scryfall.com/docs/api written in Typescript.",
 	"keywords": [
 		"magic the gathering",
@@ -23,68 +23,55 @@
 		"url": "https://github.com/MarioMH8/scryfall-api"
 	},
 	"license": "MIT",
-	"main": "dist/scryfall-api.cjs.js",
-	"umd:main": "dist/scryfall-api.umd.min.js",
-	"module": "dist/scryfall-api.esm.js",
 	"files": [
 		"dist"
 	],
+	"module": "./dist/scryfall-api.mjs",
+	"types": "./dist/types/src/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/src/index.d.ts",
+			"require": "./dist/scryfall-api.js",
+			"import": "./dist/scryfall-api.mjs",
+			"default": "./dist/scryfall-api.mjs"
+		}
+	},
 	"scripts": {
-		"build": "yarn typecheck && preconstruct build",
-		"build:watch": "preconstruct watch",
-		"lint": "eslint --ext .ts,.tsx --ignore-path .gitignore .",
-		"lint:fix": "eslint --ext .ts,.tsx --ignore-path .gitignore --fix .",
-		"prepare": "husky install",
-		"prettier": "prettier --ignore-unknown --check .",
-		"prettier:fix": "prettier --ignore-unknown --write .",
-		"publish": "yarn build && yarn changeset publish",
-		"test": "vitest",
-		"test:coverage": "vitest run --coverage",
+		"build": "vite build",
+		"lint": "eslint .",
+		"lint:fix": "eslint --fix .",
+		"publish": "yarn changeset publish",
+		"test": "vitest run --no-isolate",
+		"test:coverage": "vitest run --no-isolate --coverage",
 		"typecheck": "tsc --noEmit",
-		"version": "yarn changeset version && yarn install --mode update-lockfile",
-		"webstorm-integration": "vitest --watch --reporter=dot --reporter=json --outputFile=.vitest-result.json"
+		"version": "yarn changeset version && yarn install --mode update-lockfile"
 	},
 	"engines": {
 		"node": ">=18"
 	},
-	"resolutions": {
-		"minimist": "1.2.6",
-		"terser": "^5.14.2"
-	},
 	"peerDependencies": {
-		"axios": "^0"
+		"axios": "^0 || ^1"
 	},
 	"devDependencies": {
-		"@babel/core": "7.18.10",
-		"@babel/preset-typescript": "7.18.6",
-		"@changesets/cli": "2.24.2",
-		"@commitlint/cli": "17.0.3",
-		"@commitlint/config-conventional": "17.0.3",
-		"@preconstruct/cli": "2.2.1",
-		"@types/node": "18.6.4",
-		"@typescript-eslint/eslint-plugin": "5.32.0",
-		"@typescript-eslint/parser": "5.32.0",
-		"axios": "0.27.2",
-		"c8": "7.12.0",
-		"eslint": "8.21.0",
-		"eslint-config-prettier": "8.5.0",
-		"eslint-plugin-prettier": "4.2.1",
-		"husky": "8.0.1",
-		"lint-staged": "13.0.3",
-		"prettier": "2.7.1",
-		"typescript": "4.7.4",
-		"vite": "3.0.4",
-		"vitest": "0.21.0"
+		"@changesets/cli": "2.26.0",
+		"@hexatool/eslint-config-typescript": "1.0.1",
+		"@hexatool/tsconfig": "18.0.0",
+		"@types/node": "18.11.18",
+		"@vitest/coverage-c8": "^0.28.0",
+		"axios": "1.2.6",
+		"eslint": "8.33.0",
+		"rollup-plugin-typescript2": "0.34.1",
+		"typescript": "4.9.4",
+		"vite": "4.0.4",
+		"vitest": "0.28.1"
 	},
 	"lint-staged": {
 		"*.{ts,tsx}": "eslint --fix",
-		"*": "prettier --ignore-unknown --write ."
+		"*": "prettier --ignore-unknown --write"
 	},
-	"preconstruct": {
-		"umdName": "scryfall",
-		"globals": {
-			"axios": "axios"
-		}
+	"volta": {
+		"node": "18.13.0",
+		"yarn": "3.3.1"
 	},
-	"packageManager": "yarn@3.2.2"
+	"packageManager": "yarn@3.3.1"
 }

package/dist/declarations/dist/src/api/CardIdentifierBuilder.d.ts

@@ -1,10 +0,0 @@
-import { CardIdentifier } from '../types';
-export declare class CardIdentifierBuilder {
-    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/dist/declarations/dist/src/api/Cards.d.ts

@@ -1,19 +0,0 @@
-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[]>;
-    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/dist/declarations/dist/src/api/Catalog.d.ts

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

package/dist/declarations/dist/src/api/Rulings.d.ts

@@ -1,11 +0,0 @@
-import MagicQuery from '../query/MagicQuery';
-import { Ruling } from '../types';
-declare class Rulings extends MagicQuery {
-    byArenaId(id: number): Promise<Ruling[]>;
-    byId(id: string): Promise<Ruling[]>;
-    byMtgoId(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/dist/declarations/dist/src/api/Sets.d.ts

@@ -1,10 +0,0 @@
-import MagicQuery from '../query/MagicQuery';
-import { Set } from '../types';
-declare class Sets extends MagicQuery {
-    all(): 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/dist/declarations/dist/src/api/Symbology.d.ts

@@ -1,8 +0,0 @@
-import MagicQuery from '../query/MagicQuery';
-import { CardSymbol, ManaCost } from '../types';
-declare class Symbology extends MagicQuery {
-    all(): Promise<CardSymbol[]>;
-    parseMana(shorthand: string): Promise<ManaCost | undefined>;
-}
-declare const _default: Symbology;
-export default _default;

package/dist/declarations/dist/src/error/MagicQueryError.d.ts

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

package/dist/declarations/dist/src/index.d.ts

@@ -1,10 +0,0 @@
-export { default as Cards } from './api/Cards';
-export { default as Catalog } from './api/Catalog';
-export { default as Rulings } from './api/Rulings';
-export { default as Sets } from './api/Sets';
-export { default as Symbology } from './api/Symbology';
-export * from './api/CardIdentifierBuilder';
-export * from './error/MagicQueryError';
-export * from './query/MagicQuery';
-export * from './query/MagicPageResult';
-export * from './types';

package/dist/declarations/dist/src/query/MagicPageResult.d.ts

@@ -1,18 +0,0 @@
-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;
-    private _count;
-    constructor(q: Q, apiPath: string, query: PageQuery, post?: P | undefined);
-    get count(): number;
-    get hasMore(): boolean;
-    all(): Promise<T[]>;
-    get(limit: number): Promise<T[]>;
-    next(): Promise<T[]>;
-    page(page: number): Promise<T[]>;
-    private setNextPage;
-}

package/dist/declarations/dist/src/query/MagicQuery.d.ts

@@ -1,13 +0,0 @@
-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>;
-}

package/dist/declarations/dist/src/types/Border.d.ts

@@ -1,7 +0,0 @@
-export declare enum Border {
-    black = 0,
-    borderless = 1,
-    gold = 2,
-    silver = 3,
-    white = 4
-}

package/dist/declarations/dist/src/types/BulkDataDefinition.d.ts

@@ -1,14 +0,0 @@
-import { BulkDataType } from './BulkDataType';
-export interface BulkDataDefinition {
-    compressed_size: number;
-    content_encoding: string;
-    content_type: string;
-    description: string;
-    download_uri: string;
-    id: string;
-    name: string;
-    object: 'bulk_data';
-    type: BulkDataType;
-    updated_at: string;
-    uri: string;
-}

package/dist/declarations/dist/src/types/BulkDataType.d.ts

@@ -1,2 +0,0 @@
-import { BulkDataTypes } from './BulkDataTypes';
-export declare type BulkDataType = keyof typeof BulkDataTypes;

package/dist/declarations/dist/src/types/BulkDataTypes.d.ts

@@ -1,7 +0,0 @@
-export declare enum BulkDataTypes {
-    oracle_cards = 0,
-    unique_artwork = 1,
-    default_cards = 2,
-    all_cards = 3,
-    rulings = 4
-}

package/dist/declarations/dist/src/types/Card.d.ts

@@ -1,91 +0,0 @@
-import { Border } from './Border';
-import { CardFace } from './CardFace';
-import { Color } from './Color';
-import { FrameEffect } from './FrameEffect';
-import { Game } from './Game';
-import { ImageUris } from './ImageUris';
-import { Layout } from './Layout';
-import { Legalities } from './Legalties';
-import { Preview } from './Preview';
-import { Prices } from './Prices';
-import { PromoType } from './PromoType';
-import { PurchaseUris } from './PurchaseUris';
-import { Rarity } from './Rarity';
-import { RelatedCard } from './RelatedCard';
-import { RelatedUris } from './RelatedUris';
-import { Set as ScryfallSet } from './Set';
-export interface Card {
-    object: 'card';
-    arena_id?: number;
-    id: string;
-    lang: string;
-    mtgo_id?: number;
-    mtgo_foil_id?: number;
-    multiverse_ids?: number[];
-    tcgplayer_id?: number;
-    oracle_id: string;
-    prints_search_uri: string;
-    rulings_uri: string;
-    scryfall_uri: string;
-    uri: string;
-    all_parts?: RelatedCard[];
-    card_faces?: CardFace[];
-    cmc: number;
-    colors?: Color[];
-    color_identity: Color[];
-    color_indicator?: Color[];
-    edhrec_rank?: number;
-    foil: boolean;
-    hand_modifier?: string;
-    layout: keyof typeof Layout;
-    legalities: Legalities;
-    life_modifier?: string;
-    loyalty?: string;
-    mana_cost?: string;
-    name: string;
-    nonfoil: boolean;
-    oracle_text?: string;
-    oversized: boolean;
-    power?: string;
-    reserved: boolean;
-    toughness?: string;
-    type_line: string;
-    artist?: string;
-    artist_ids?: string[];
-    booster: boolean;
-    border_color: keyof typeof Border;
-    card_back_id: string;
-    collector_number: string;
-    digital: boolean;
-    flavor_text?: string;
-    frame_effects?: (keyof typeof FrameEffect)[];
-    frame: '1993' | '1997' | '2003' | '2015' | 'Future';
-    full_art: boolean;
-    games: (keyof typeof Game)[];
-    highres_image: boolean;
-    illustration_id?: string;
-    image_uris?: ImageUris;
-    prices: Prices;
-    printed_name?: string;
-    printed_text?: string;
-    printed_type_line?: string;
-    promo: boolean;
-    promo_types?: (keyof typeof PromoType)[];
-    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: ScryfallSet['set_type'];
-    set_uri: string;
-    set: string;
-    story_spotlight: boolean;
-    textless: boolean;
-    variation: boolean;
-    variation_of?: string;
-    watermark?: string;
-    preview?: Preview;
-}

package/dist/declarations/dist/src/types/CardFace.d.ts

@@ -1,22 +0,0 @@
-import { Color } from './Color';
-import { ImageUris } from './ImageUris';
-export interface CardFace {
-    object: 'card_face';
-    artist?: string;
-    color_indicator?: Color[];
-    colors: Color[];
-    flavor_text?: string;
-    illustration_id?: string;
-    image_uris?: ImageUris;
-    loyalty?: string;
-    mana_cost: string;
-    name: string;
-    oracle_text?: string;
-    power?: string;
-    printed_name?: string;
-    printed_text?: string;
-    printed_type_line?: string;
-    toughness?: string;
-    type_line: string;
-    watermark?: string;
-}

package/dist/declarations/dist/src/types/CardIdentifier.d.ts

@@ -1,10 +0,0 @@
-export interface CardIdentifier {
-    id?: string;
-    mtgo_id?: number;
-    multiverse_id?: number;
-    oracle_id?: string;
-    illustration_id?: string;
-    name?: string;
-    set?: string;
-    collector_number?: string;
-}

package/dist/declarations/dist/src/types/CardSymbol.d.ts

@@ -1,13 +0,0 @@
-import { Color } from './Color';
-export interface CardSymbol {
-    symbol: string;
-    loose_variant?: string;
-    english: string;
-    transposable: boolean;
-    represents_mana: boolean;
-    converted_mana_cost?: number;
-    colors: Color[];
-    appears_in_mana_costs: boolean;
-    funny: boolean;
-    gatherer_alternates?: string[];
-}

package/dist/declarations/dist/src/types/Color.d.ts

@@ -1,9 +0,0 @@
-declare enum Colors {
-    W = 0,
-    B = 1,
-    R = 2,
-    U = 3,
-    G = 4
-}
-export declare type Color = keyof typeof Colors;
-export {};

package/dist/declarations/dist/src/types/Format.d.ts

@@ -1,15 +0,0 @@
-export 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
-}

package/dist/declarations/dist/src/types/FrameEffect.d.ts

@@ -1,17 +0,0 @@
-export 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
-}

package/dist/declarations/dist/src/types/Game.d.ts

@@ -1,5 +0,0 @@
-export declare enum Game {
-    paper = 0,
-    arena = 1,
-    mtgo = 2
-}

package/dist/declarations/dist/src/types/HomepageLink.d.ts

@@ -1,9 +0,0 @@
-export interface HomepageLink {
-    id: number;
-    created_at: string;
-    updated_at: string;
-    priority: number;
-    text: string;
-    uri: string;
-    badge?: string;
-}

package/dist/declarations/dist/src/types/ImageUris.d.ts

@@ -1,8 +0,0 @@
-export interface ImageUris {
-    small: string;
-    normal: string;
-    large: string;
-    png: string;
-    art_crop: string;
-    border_crop: string;
-}

package/dist/declarations/dist/src/types/Layout.d.ts

@@ -1,22 +0,0 @@
-export declare enum Layout {
-    normal = 0,
-    split = 1,
-    flip = 2,
-    transform = 3,
-    modal_dfc = 4,
-    meld = 5,
-    leveler = 6,
-    'class' = 7,
-    saga = 8,
-    adventure = 9,
-    planar = 10,
-    scheme = 11,
-    vanguard = 12,
-    token = 13,
-    double_faced_token = 14,
-    emblem = 15,
-    augment = 16,
-    host = 17,
-    art_series = 18,
-    reversible_card = 19
-}

package/dist/declarations/dist/src/types/Legalties.d.ts

@@ -1,5 +0,0 @@
-import { Format } from './Format';
-import { Legality } from './Legalty';
-export declare type Legalities = {
-    [key in keyof typeof Format]: keyof typeof Legality;
-};

package/dist/declarations/dist/src/types/Legalty.d.ts

@@ -1,6 +0,0 @@
-export declare enum Legality {
-    legal = 0,
-    not_legal = 1,
-    restricted = 2,
-    banned = 3
-}

package/dist/declarations/dist/src/types/ManaCost.d.ts

@@ -1,9 +0,0 @@
-import { Color } from './Color';
-export interface ManaCost {
-    cost: string;
-    cmc: number;
-    colors: Color[];
-    colorless: boolean;
-    monocolored: boolean;
-    multicolored: boolean;
-}

package/dist/declarations/dist/src/types/PageQuery.d.ts

@@ -1,5 +0,0 @@
-import { QueryValue } from './PageQueryValue';
-export declare type PageQuery = {
-    [key: string]: QueryValue;
-    page: number;
-};

package/dist/declarations/dist/src/types/PageQueryValue.d.ts

@@ -1 +0,0 @@
-export declare type QueryValue = string | number | boolean | undefined;

package/dist/declarations/dist/src/types/Preview.d.ts

@@ -1,5 +0,0 @@
-export interface Preview {
-    previewed_at?: string;
-    source_uri?: string;
-    source?: string;
-}

package/dist/declarations/dist/src/types/Prices.d.ts

@@ -1,6 +0,0 @@
-export interface Prices {
-    usd?: string;
-    usd_foil?: string;
-    eur?: string;
-    tix?: string;
-}

package/dist/declarations/dist/src/types/PromoType.d.ts

@@ -1,27 +0,0 @@
-export 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
-}

package/dist/declarations/dist/src/types/PurchaseUris.d.ts

@@ -1,6 +0,0 @@
-export interface PurchaseUris {
-    tcgplayer?: string;
-    cardmarket?: string;
-    cardhoarder?: string;
-    [key: string]: string | undefined;
-}