scryfall-api 1.0.7 → 2.1.0

package/lib/types/PageQueryValue.d.ts

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

package/lib/types/Preview.d.ts

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

package/lib/types/Prices.d.ts

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

package/lib/types/PromoType.d.ts

@@ -0,0 +1,27 @@
+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/lib/types/PurchaseUris.d.ts

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

package/lib/types/Query.d.ts

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

package/lib/types/Rarity.d.ts

@@ -0,0 +1,6 @@
+export declare enum Rarity {
+    common = 0,
+    uncommon = 1,
+    rare = 2,
+    mythic = 3
+}

package/lib/types/RelatedCard.d.ts

@@ -0,0 +1,9 @@
+import { RelatedCardComponent } from './RelatedCardComponent';
+export interface RelatedCard {
+    component: keyof typeof RelatedCardComponent;
+    id: string;
+    name: string;
+    object: 'related_card';
+    type_line: string;
+    uri: string;
+}

package/lib/types/RelatedCardComponent.d.ts

@@ -0,0 +1,6 @@
+export declare enum RelatedCardComponent {
+    token = 0,
+    meld_part = 1,
+    meld_result = 2,
+    combo_piece = 3
+}

package/lib/types/RelatedUris.d.ts

@@ -0,0 +1,7 @@
+export interface RelatedUris {
+    gatherer?: string;
+    tcgplayer_decks?: string;
+    edhrec?: string;
+    mtgtop8?: string;
+    [key: string]: string | undefined;
+}

package/lib/types/ResultCatalog.d.ts

@@ -0,0 +1,2 @@
+import { ResultData } from './ResultData';
+export declare type ResultCatalog = ResultData<string>;

package/lib/types/ResultData.d.ts

@@ -0,0 +1,4 @@
+export interface ResultData<T, NOT_FOUND = never> {
+    data: T[];
+    not_found?: NOT_FOUND[];
+}

package/lib/types/ResultList.d.ts

@@ -0,0 +1,7 @@
+import { ResultData } from './ResultData';
+export interface ResultList<T, NOT_FOUND = never> extends ResultData<T, NOT_FOUND> {
+    has_more: boolean;
+    next_page: string;
+    total_cards: string;
+    warnings: string[];
+}

package/lib/types/RetryStrategy.d.ts

@@ -0,0 +1,11 @@
+import { SearchError } from './SearchError';
+export interface RetryStrategy {
+    attempts: number;
+    timeout?: number;
+    /**
+     * Whether even `not_found` and `bad_request` errors should be retried.
+     * @deprecated Don't use this, this is for unit tests
+     */
+    forced?: boolean;
+    canRetry?(error?: SearchError): boolean;
+}

package/lib/types/Ruling.d.ts

@@ -0,0 +1,5 @@
+export interface Ruling {
+    source: string;
+    published_at: string;
+    comment: string;
+}

package/lib/types/SearchError.d.ts

@@ -0,0 +1,7 @@
+export interface SearchError {
+    object: 'error';
+    code: string;
+    status: number;
+    details: string;
+    warnings?: string[];
+}

package/lib/types/SearchOptions.d.ts

@@ -0,0 +1,15 @@
+import { Sort } from './Sort';
+import { SortDirection } from './SortDirection';
+import { UniqueStrategy } from './UniqueStrategy';
+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;
+}

package/lib/types/Set.d.ts

@@ -0,0 +1,20 @@
+import { SetType } from './SetType';
+export interface Set {
+    id: string;
+    code: string;
+    mtgo_code?: string;
+    tcgplayer_id?: number;
+    name: string;
+    set_type: keyof typeof SetType;
+    released_at?: string;
+    block_code?: string;
+    block?: string;
+    parent_set_code?: string;
+    card_count: number;
+    digital: boolean;
+    foil_only: boolean;
+    scryfall_uri: string;
+    uri: string;
+    icon_svg_uri: string;
+    search_uri: string;
+}

package/lib/types/SetType.d.ts

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

package/lib/types/Sort.d.ts

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

package/lib/types/SortDirection.d.ts

@@ -0,0 +1,5 @@
+export declare enum SortDirection {
+    auto = 0,
+    asc = 1,
+    desc = 2
+}

package/lib/types/TOrArrayOfT.d.ts

@@ -0,0 +1 @@
+export declare type TOrArrayOfT<T> = T | T[];

package/lib/types/UniqueStrategy.d.ts

@@ -0,0 +1,5 @@
+export declare enum UniqueStrategy {
+    cards = 0,
+    art = 1,
+    prints = 2
+}

package/lib/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": "1.0.7",
+  "version": "2.1.0",
   "description": "A Node.js SDK for https://scryfall.com/docs/api written in Typescript.",
   "license": "MIT",
   "repository": {
@@ -36,50 +36,58 @@
     "clean": "rimraf lib tsconfig.tsbuildinfo",
     "clean:deps": "rimraf node_modules",
     "commit": "git-cz",
-    "lint": "eslint . --ext .ts",
-    "lint:fix": "npm run lint -- --fix",
-    "release": "standard-version"
+    "lint": "eslint --cache --ext ts .",
+    "lint:fix": "eslint --fix --cache --ext ts .",
+    "release": "standard-version",
+    "prettier": "prettier --check .",
+    "prettier:fix": "prettier --write .",
+    "prepare": "husky install",
+    "test": "jest"
   },
   "dependencies": {
-    "axios": "^0.21.1",
-    "eventemitter3": "^4.0.7"
+    "axios": "^0.23.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^11.0.0",
-    "@commitlint/config-conventional": "^11.0.0",
-    "@rollup/plugin-commonjs": "^17.0.0",
+    "@commitlint/cli": "^13.2.1",
+    "@commitlint/config-conventional": "^13.2.0",
+    "@rollup/plugin-commonjs": "^21.0.0",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^11.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.5",
     "@types/axios": "^0.14.0",
-    "@typescript-eslint/eslint-plugin": "^4.13.0",
-    "@typescript-eslint/parser": "^4.13.0",
-    "commitizen": "^4.2.2",
+    "@types/jest": "^27.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "commitizen": "^4.2.4",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^7.17.0",
-    "eslint-config-prettier": "^7.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "husky": "^4.3.7",
-    "lint-staged": "^10.5.3",
-    "prettier": "^2.2.1",
+    "eslint": "^8.0.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^7.0.0",
+    "jest": "^27.2.5",
+    "lint-staged": "^11.2.3",
+    "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
-    "rollup": "^2.37.0",
+    "rollup": "^2.58.0",
     "rollup-plugin-sourcemaps": "^0.6.3",
     "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-typescript2": "^0.29.0",
-    "standard-version": "^9.2.0",
-    "typescript": "^4.1.3"
+    "rollup-plugin-typescript2": "^0.30.0",
+    "standard-version": "^9.3.1",
+    "ts-jest": "^27.0.5",
+    "typescript": "^4.4.4"
   },
   "config": {
+    "unsafe-perm": true,
     "commitizen": {
       "path": "cz-conventional-changelog"
     }
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-    }
-  },
   "lint-staged": {
-    "*.{ts, tsx}": "eslint --cache --fix"
+    "*.{ts, tsx}": [
+      "eslint --fix --cache --ext ts .",
+      "prettier --write"
+    ]
+  },
+  "standard": {
+    "releaseCommitMessageFormat": "chore(release): {{currentTag}} [skip ci]"
   }
 }

package/lib/api/BulkData.d.ts

@@ -1,46 +0,0 @@
-/// <reference types="node" />
-import { Stream } from 'stream';
-import MagicQuerier from '../util/MagicQuerier';
-declare enum BulkDataTypes {
-    oracle_cards = 0,
-    unique_artwork = 1,
-    default_cards = 2,
-    all_cards = 3,
-    rulings = 4
-}
-export declare type BulkDataType = keyof typeof BulkDataTypes;
-export interface BulkDataDefinition {
-    object: 'bulk_data';
-    id: string;
-    type: BulkDataType;
-    updated_at: string;
-    uri: string;
-    name: string;
-    description: string;
-    compressed_size: number;
-    download_uri: string;
-    content_type: string;
-    content_encoding: string;
-}
-declare class BulkData extends MagicQuerier {
-    /**
-     * Returns a stream for the given bulk data if it has been updated since the last download time. If it hasn't, returns `undefined`
-     * @param type The BulkDataType.
-     * @param lastDownload The last time this bulk data was downloaded. If you want to re-download the data regardless of
-     * the last time it was downloaded, set this to `0`.
-     */
-    downloadByType(type: BulkDataType, lastDownload: string | number | Date): Promise<Stream | undefined>;
-    /**
-     * Returns a stream for the given bulk data if it has been updated since the last download time. If it hasn't, returns `undefined`
-     * @param lastDownload The last time this bulk data was downloaded. If you want to re-download the data regardless of
-     * the last time it was downloaded, set this to `0`.
-     */
-    downloadById(id: string, lastDownload: string | number | Date): Promise<Stream | undefined>;
-    definitions(): Promise<BulkDataDefinition[]>;
-    definitionByType(type: BulkDataType): Promise<BulkDataDefinition>;
-    definitionById(id: string): Promise<BulkDataDefinition>;
-    private download;
-    private definition;
-}
-declare const _default: BulkData;
-export default _default;

package/lib/util/MagicEmitter.d.ts

@@ -1,31 +0,0 @@
-import { EventEmitter } from 'eventemitter3';
-export default class MagicEmitter<T, NOT_FOUND = never> extends EventEmitter {
-    private _ended;
-    get ended(): boolean;
-    private _cancelled;
-    get cancelled(): boolean;
-    private _willCancelAfterPage;
-    get willCancelAfterPage(): boolean;
-    constructor();
-    on(event: 'data', listener: (data: T) => any): this;
-    on(event: 'not_found', listener: (data: NOT_FOUND) => any): this;
-    on(event: 'end', listener: (...args: any[]) => any): this;
-    on(event: 'cancel', listener: (...args: any[]) => any): this;
-    on(event: 'error', listener: (err: Error) => any): this;
-    on(event: 'done', listener: (...args: any[]) => any): this;
-    emit(event: 'data', data: T): boolean;
-    emit(event: 'not_found', data: NOT_FOUND): boolean;
-    emit(event: 'end'): boolean;
-    emit(event: 'cancel'): boolean;
-    emit(event: 'error', error: Error): boolean;
-    emit(event: 'done'): boolean;
-    emitAll(event: 'data', ...data: T[]): void;
-    emitAll(event: 'not_found', ...data: NOT_FOUND[]): void;
-    cancel(): this;
-    cancelAfterPage(): this;
-    waitForAll(): Promise<any>;
-    [Symbol.asyncIterator](): AsyncGenerator<T, void, unknown>;
-    all(): AsyncGenerator<T, void, unknown>;
-    notFound(): AsyncGenerator<NOT_FOUND, void, unknown>;
-    private generate;
-}

package/lib/util/MagicQuerier.d.ts

@@ -1,44 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-import MagicEmitter from './MagicEmitter';
-declare type TOrArrayOfT<T> = T | T[];
-export interface Data<T, NOT_FOUND = never> {
-    data: T[];
-    not_found?: NOT_FOUND[];
-}
-export interface List<T, NOT_FOUND = never> extends Data<T, NOT_FOUND> {
-    has_more: boolean;
-    next_page: string | null;
-    total_cards: string | null;
-    warnings: string[];
-}
-export declare type ApiCatalog = Data<string>;
-export interface SearchError {
-    object: 'error';
-    code: string;
-    status: number;
-    details: string;
-    warnings?: string[];
-}
-export interface RetryStrategy {
-    attempts: number;
-    timeout?: number;
-    /**
-     * Whether even `not_found` and `bad_request` errors should be retried.
-     * @deprecated Don't use this, this is for unit tests
-     */
-    forced?: boolean;
-    canRetry?(error: SearchError): boolean;
-}
-export default class MagicQuerier {
-    static lastQuery: number;
-    static lastError: SearchError | undefined;
-    static lastRetries: number;
-    static retry: RetryStrategy;
-    protected query<T>(apiPath: TOrArrayOfT<string | number | undefined>, query?: {
-        [key: string]: any;
-    }, post?: any, requestOptions?: AxiosRequestConfig): Promise<T>;
-    protected queryPage<T>(emitter: MagicEmitter<T>, apiPath: string, query: any, page?: number): Promise<void>;
-    private tryQuery;
-    private canRetry;
-}
-export {};