{"_id":"@alex-taxiera/pokemon-tcg-sdk-typescript","_rev":"2-b876516a531e144df5105c50ca834f1a","name":"@alex-taxiera/pokemon-tcg-sdk-typescript","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.1":{"name":"@alex-taxiera/pokemon-tcg-sdk-typescript","version":"0.0.1","description":"Typescript SDK for the PokemonTCG API (https://pokemontcg.io)","main":"dist/index.js","types":"dist/index.d.ts","keywords":["PokemonTCG","Typescript","API","SDK"],"scripts":{"prettier":"prettier --config .prettierrc.json 'src/**/*.ts' --write","lint":"eslint . --ext .ts","lint:fix":"eslint . --ext .ts --fix","test":"npm run lint && jest","build":"npm run lint:fix && tsc"},"repository":{"type":"git","url":"git+https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript.git"},"contributors":[{"name":"Bradyn Glines","url":"https://github.com/glinesbdev"},{"name":"CptSpaceToaster","url":"https://github.com/CptSpaceToaster"},{"name":"Monbrey","url":"https://github.com/Monbrey"},{"name":"Jonathan Meyer","url":"https://github.com/jonathan-meyer"},{"name":"Elisabeth Diang","url":"https://github.com/acupoftee"}],"license":"MIT","dependencies":{"node-fetch":"^2.6.0"},"devDependencies":{"@types/jest":"26.0.20","@types/node":"^17.0.36","@types/node-fetch":"^2.6.1","@typescript-eslint/eslint-plugin":"4.17.0","@typescript-eslint/parser":"4.17.0","eslint":"7.22.0","eslint-config-prettier":"8.1.0","eslint-plugin-prettier":"3.3.1","jest":"26.6.3","prettier":"2.2.1","ts-jest":"26.5.3","ts-node":"4.1.0","typescript":"4.1.5"},"gitHead":"846ec216532b1cdddb4a29a5f343ea15738ed22d","bugs":{"url":"https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript/issues"},"homepage":"https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript#readme","_id":"@alex-taxiera/pokemon-tcg-sdk-typescript@0.0.1","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-Wje4q1BKb4/7eNTlr2N+CwgIbSsNE1bQWufhEBr7RHbhoGVlIFFme+zRTIw6JiCY3z4Lnk6S/7DpllrGkGlxPQ==","shasum":"1a2c23ca3c2018f42044cd35cc4bcc6f79dfbb09","tarball":"https://registry.npmjs.org/@alex-taxiera/pokemon-tcg-sdk-typescript/-/pokemon-tcg-sdk-typescript-0.0.1.tgz","fileCount":71,"unpackedSize":54325,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCiN1r6zS5LrrbmZNmz27FPxdLRXShaUaXJKMbVi4H06QIhAJId0M7hn1d28Nh6/u6SzaFaNGIcsUbxiLk4E2y9Pw3v"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiltmdACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpVgA//SXerv4Qwf3gPO+9Z5SK/17mE2nmysHLBH9TO/Gbrg41IRszK\r\nhX7i2EOhOC/IesJ/H86WhNhi5VZYnEaoPt9MjohjwbhF++2p607tsvrWOH88\r\nR8e1kvDM0sNZWNjKo6zFixmrt7iZVuWpclo+kBZKcqI/l8tMJRIQMpDwiFuM\r\nt7KRKqb+8lP/AEmzK3osSFKB4zCs/6VbqvqBM7y+lj9ICqq/mVHBGfZEXMzG\r\nyy79O4QCRYMiP9/1Smdt5tDriW7bwmar7G8rBQW749BUfFHJP4vFLuseC4MU\r\nrdlzeR3E8dT29I9SPxd15DNN1Es/a2uX0PjP6pScuO1ZFoAKisw45emEdLiu\r\n6fobXaCyWnYkaNjy6byJhRvIdZX+8kmfw2O9UXTdxEVLR95dFtVIduK8Izgv\r\nZElKlqz/4UUHopgdTJH8kKVSz94a4KxMrV9khUDCGF1Urqcal5KdRC50WqzK\r\nu5X3vV3/ab30mdhE/rLCFbGt2YU+eroYKxLPWFgRYYtj4f+4KUpthX6idPyE\r\ng8I3dh/xc0ydHxY/OF/Kdfl+5s5QM10EfVx0YCVJQyqR+uvL0j5c8bqt1Dss\r\nEin//LhVoSrcv/QKWw/KxXAXJpGRY9vRuAlAYFJ4Axcu3XKssPqcgBAfjqNf\r\nvbswm59Y4IsqiGuOdUXUedh+wMWpI1NyaL0=\r\n=pGcC\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alextaxiera","email":"alex.taxiera@gmail.com"},"directories":{},"maintainers":[{"name":"alextaxiera","email":"alex.taxiera@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/pokemon-tcg-sdk-typescript_0.0.1_1654053277476_0.5737722209444267"},"_hasShrinkwrap":false},"0.0.2":{"name":"@alex-taxiera/pokemon-tcg-sdk-typescript","version":"0.0.2","description":"Typescript SDK for the PokemonTCG API (https://pokemontcg.io)","main":"dist/index.js","types":"dist/index.d.ts","keywords":["PokemonTCG","Typescript","API","SDK"],"scripts":{"prettier":"prettier --config .prettierrc.json 'src/**/*.ts' --write","lint":"eslint . --ext .ts","lint:fix":"eslint . --ext .ts --fix","test":"npm run lint && jest","build":"npm run lint:fix && tsc"},"repository":{"type":"git","url":"git+https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript.git"},"contributors":[{"name":"Bradyn Glines","url":"https://github.com/glinesbdev"},{"name":"CptSpaceToaster","url":"https://github.com/CptSpaceToaster"},{"name":"Monbrey","url":"https://github.com/Monbrey"},{"name":"Jonathan Meyer","url":"https://github.com/jonathan-meyer"},{"name":"Elisabeth Diang","url":"https://github.com/acupoftee"}],"license":"MIT","dependencies":{"node-fetch":"^2.6.0"},"devDependencies":{"@types/jest":"26.0.20","@types/node":"^17.0.36","@types/node-fetch":"^2.6.1","@typescript-eslint/eslint-plugin":"4.17.0","@typescript-eslint/parser":"4.17.0","eslint":"7.22.0","eslint-config-prettier":"8.1.0","eslint-plugin-prettier":"3.3.1","jest":"26.6.3","prettier":"2.2.1","ts-jest":"26.5.3","ts-node":"4.1.0","typescript":"4.1.5"},"gitHead":"0cc4f4c29f56401a596782e9243cc649bfe9fd12","bugs":{"url":"https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript/issues"},"homepage":"https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript#readme","_id":"@alex-taxiera/pokemon-tcg-sdk-typescript@0.0.2","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-6s3gvw56GiHNqWSoQn4SLHdbGla/qlojWsqY1S856b4Ml3eJZtUwvo/CdA2kzbl4g5yDNpCJX3huS3Eopgk10g==","shasum":"f9cfaf8b966e400580a5524a85964661dddd8242","tarball":"https://registry.npmjs.org/@alex-taxiera/pokemon-tcg-sdk-typescript/-/pokemon-tcg-sdk-typescript-0.0.2.tgz","fileCount":71,"unpackedSize":54397,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA90+PGfU1iJaIygJrr37w0ZkP84e2cL5DMGYMWNY6E2AiBTtLi9vxxmP3OHwqiOSYykLADFcf0UdfzfW/2mF4zAlQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJipWP6ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrbqA//Vhe9xtTnT+pirBkWg91gh5RCaR2a9z3QCcrqt141IVw5x+no\r\n7UJaJq4eDDaxSWGXZ7MqNPTqnfJihInlwNtQInb69haty8TdfhZgvbk6isgP\r\nnwGJ8LRdperTezbuC1vM52xHxFt1wKHGryKom8uRHLfaebuMrrpoquxKN2VE\r\nT2AsABuNyBFG1/bnNrEMHtcr+/10B2dNkOXYaFENHjJxS98ma2y1gERh60wV\r\n76tNTVBmrkoFv9+brPcEPNInUZjXxnQ2WVm58nBjVw4Q+4vuF5TfaQMKtETt\r\nelQY5usgjq/YJJlPshnxwRPDL7r9haM3wOUL3ex9XI5h8gqZ5YZBAaPpoDVd\r\nGsea1SjtwXXcK2QRd4zZvCMND7e5ozmrpA3jhryq6ogXeG2neFNGU0gtlzii\r\nOS8HDBIaBajX4TinnxRUXzzDIS+7KxwFMlj8uP0h/B0rVZLBQRmO3SR+qBwJ\r\nmUOMWj2UkyGpylD8g7uA0mPvw6E0HDDzp1qqqdgualL0sfawHzL3H+5yqIZ4\r\nWtAM8nn3Fn5TQShMshC/mpJijd9bQgFBwZl7U4MBQNI2CQjiGLAw1lBZ9gcb\r\nToPegcA8+wsZM/+r8MV5gRk8ttENVt3sCbYvtKENJfYCdixzqtN57D33ygox\r\n1BpLG3BofxPCYuDu5kKchah/RQbPBxBBLxw=\r\n=Vw1E\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alextaxiera","email":"alex.taxiera@gmail.com"},"directories":{},"maintainers":[{"name":"alextaxiera","email":"alex.taxiera@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/pokemon-tcg-sdk-typescript_0.0.2_1655006202432_0.25978999468772757"},"_hasShrinkwrap":false},"0.0.3":{"name":"@alex-taxiera/pokemon-tcg-sdk-typescript","version":"0.0.3","description":"Typescript SDK for the PokemonTCG API (https://pokemontcg.io)","main":"dist/index.js","types":"dist/index.d.ts","keywords":["PokemonTCG","Typescript","API","SDK"],"scripts":{"prettier":"prettier --config .prettierrc.json 'src/**/*.ts' --write","lint":"eslint . --ext .ts","lint:fix":"eslint . --ext .ts --fix","test":"npm run lint && jest","build":"npm run lint:fix && tsc"},"repository":{"type":"git","url":"git+https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript.git"},"contributors":[{"name":"Bradyn Glines","url":"https://github.com/glinesbdev"},{"name":"CptSpaceToaster","url":"https://github.com/CptSpaceToaster"},{"name":"Monbrey","url":"https://github.com/Monbrey"},{"name":"Jonathan Meyer","url":"https://github.com/jonathan-meyer"},{"name":"Elisabeth Diang","url":"https://github.com/acupoftee"}],"license":"MIT","dependencies":{"node-fetch":"^2.6.0"},"devDependencies":{"@types/jest":"26.0.20","@types/node":"^17.0.36","@types/node-fetch":"^2.6.1","@typescript-eslint/eslint-plugin":"4.17.0","@typescript-eslint/parser":"4.17.0","eslint":"7.22.0","eslint-config-prettier":"8.1.0","eslint-plugin-prettier":"3.3.1","jest":"26.6.3","prettier":"2.2.1","ts-jest":"26.5.3","ts-node":"4.1.0","typescript":"4.1.5"},"gitHead":"0cc4f4c29f56401a596782e9243cc649bfe9fd12","bugs":{"url":"https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript/issues"},"homepage":"https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript#readme","_id":"@alex-taxiera/pokemon-tcg-sdk-typescript@0.0.3","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-UMB5mnVEeStx4W5XmFC+K9ObFvHhjaNSfD9cZ51K8euuTIklXmsO0uCEYxued75Q8SxdIau5VB3fE138zLc58w==","shasum":"b3033e56f0fb00161efd2a44f8eb25e5dc0baf9a","tarball":"https://registry.npmjs.org/@alex-taxiera/pokemon-tcg-sdk-typescript/-/pokemon-tcg-sdk-typescript-0.0.3.tgz","fileCount":71,"unpackedSize":54398,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIASBHU1DrfyDnus0zssxjs56Si+wjgJvNXn8tpdXf5N8AiEAlK2aGF46EOQLAN/rhPckjdDP9fFDtmd8nfE2ugQLdM4="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJipWROACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrMKg/+OfKAh6MTUIkLRVEYvXhDTw53M1mklyes6t4j96DC/GXo5vy4\r\nPa50KW8+tcQyYmP/RvBfr3/nl2NuQl4MUkP8nqWTfky6lqVhRtQ2WOltlcnZ\r\n1FRHXc3Cs4q0eHTJSp1NdX6KoGmRmFPJtDfAYn3MC9TlZ7Y6A0LERyVVL9Ts\r\ny90/YCj3oFQPYM7Qxb10i2LHfsIb63iERSZ5pdynEnImwE6h8CcjiTVvWvC2\r\ntcGvNVDZaEDOwDzcHOYglw1KGvtAE4HnJI+e4/HSfQBXdAZhob+q01PtPmcb\r\nIgvkXn/ghq0YUtriWfZRJBBl5OXeRbvH2prJ3JRVX9D0C4n2k5orHH3U3Yc8\r\nd9C0qH/2PtGJfITlRvOTGW4qXXZMTA6zAFQ2Pv+sGXqzub6q4nLNceNYWXh/\r\n/vqtfu9Jg13BcyAML7k/PmSp3YVwEK2V3oqDAbBg/ZPgnWqSgr6JHpDbftBz\r\nZI+nqpk2xTg8bVEn/QW/zUndGt5YLhgXTls7yIdrqbusy0E6fjIJZV9YcqVP\r\n5rZyJv7b6njRzBgZSknNGIbkYIUWqg5pRu4c/ZswDjsjkTDVAE5WuAiZ7pYU\r\nngZOxDXtxsRHNqNi4lTGWxCSLCJYaw4/DtfMEUGm8jTJPkJK3cqSs4D+iMqg\r\nSmkrYFkCF2tP8ov8LbUWusW9bDsvUkgvX2o=\r\n=EXjF\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alextaxiera","email":"alex.taxiera@gmail.com"},"directories":{},"maintainers":[{"name":"alextaxiera","email":"alex.taxiera@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/pokemon-tcg-sdk-typescript_0.0.3_1655006286345_0.38292855556742267"},"_hasShrinkwrap":false}},"time":{"created":"2022-06-01T03:14:37.427Z","0.0.1":"2022-06-01T03:14:37.683Z","modified":"2022-06-12T03:58:06.665Z","0.0.2":"2022-06-12T03:56:42.634Z","0.0.3":"2022-06-12T03:58:06.509Z"},"maintainers":[{"name":"alextaxiera","email":"alex.taxiera@gmail.com"}],"description":"Typescript SDK for the PokemonTCG API (https://pokemontcg.io)","homepage":"https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript#readme","keywords":["PokemonTCG","Typescript","API","SDK"],"repository":{"type":"git","url":"git+https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript.git"},"contributors":[{"name":"Bradyn Glines","url":"https://github.com/glinesbdev"},{"name":"CptSpaceToaster","url":"https://github.com/CptSpaceToaster"},{"name":"Monbrey","url":"https://github.com/Monbrey"},{"name":"Jonathan Meyer","url":"https://github.com/jonathan-meyer"},{"name":"Elisabeth Diang","url":"https://github.com/acupoftee"}],"bugs":{"url":"https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript/issues"},"license":"MIT","readme":"# Pokémon TCG TypeScript SDK\n\n*Now supporting Version 2 of the Pokémon TCG API! Please refer to the [V1 to V2 Migration](https://docs.pokemontcg.io/#documentationmigration) section of the \nofficial API docs for more information.*\n\n***See the [migration guide](MIGRATING.md) for steps to update your app to use the latest supported version of the SDK***\n\n[![pokemontcg-developers on discord](https://img.shields.io/badge/discord-pokemontcg--developers-738bd7.svg)](https://discord.gg/dpsTCvg)\n![pokemon-tcg-sdk-typescript build status](https://github.com/acupoftee/pokemon-tcg-sdk-typescript/actions/workflows/sdk_test.yaml/badge.svg\n)\n\nThis is the TypeScript SDK for the [Pokémon Trading Card Game API](https://docs.pokemontcg.io).\n\n## Installation\n\n**npm**\n\n    npm install pokemon-tcg-sdk-typescript\n\n**yarn**\n\n    yarn add pokemon-tcg-sdk-typescript\n\n# Configuration\nThe SDK works out of the box! Simply import the SDK, and you're ready to go:\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nPokemonTCG.findCardByID('xy7-54').then((card: PokemonTCG.Card) => {\n    console.log(card.name) // Gardevoir\n})\n```\n\nIt is recommended to use an API key for version 2 of the API. By default, requests are limited to 20,000/day. Requests are rate limited to 1000 requests a day, and a maximum of 30 per minute. \n\nTo use the SDK with an API key, create an account at https://dev.pokemontcg.io to grab an API key.\nThen set your API key to the environment variable `POKEMONTCG_API_KEY` in a `.env` file. \n**Make sure to use this exact environment variable, otherwise the SDK will not be able to read the API key.** \n\n# Usage\nAll function calls return generic promises like `Promise<T>` or `Promise<T[]>`\n\n## Card Methods\n* [findCardByID()](#findcardbyid)\n* [findCardsByQueries()](#findcardbyqueries)\n* [getAllCards()](#getallcards)\n* [getTypes()](#gettypes)\n* [getSupertypes()](#getsupertypes)\n* [getSubtypes()](#getsubtypes)\n* [getRarities()](#getrarities)\n\n## Set Methods\n* [findSetByID()](#findsetbyid)\n* [findSetsByQueries()](#findsetbyqueries)\n* [getAllSets()](#getallsets)\n\n### findCardByID()\nReturns a single Pokémon card given an ID. \n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nPokemonTCG.findCardByID('xy7-54').then((card: PokemonTCG.Card) => {\n    console.log(card.name) // Gardevoir\n});\n```\n\n### findCardByQueries()\nReturns an array of cards filtered through a search query.\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nconst params: PokemonTCG.Query[] = { q: 'id:xy7-54' };\n\nPokemonTCG.findCardsByQueries(params).then((cards: PokemonTCG.Card[]) => {\n   console.log(card[0].name) // Gardevoir\n});\n```\n### getAllCards()\nReturns all Pokémon cards available through recursive pagination.\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nPokemonTCG.getAllCards();\n```\n\n### getTypes()\nReturns all Energy Types\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nPokemonTCG.getTypes();\n```\n\n### getSupertypes()\nReturns all Super Types\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nPokemonTCG.getSupertypes();\n```\n\n### getSubtypes()\nReturns all Sub Types\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nPokemonTCG.getSubtypes();\n```\n\n### getRarities()\nReturns all card Rarities\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nPokemonTCG.getRarities();\n```\n### findSetByID()\nReturns a single Pokémon card given an ID.\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nPokemonTCG.findSetByID('base1').then((set: PokemonTCG.Set) => {\n    console.log(set.name) // Base\n});\n```\n\n### findSetByQueries()\nReturns an array of cards filtered through a search query.\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nconst params: PokemonTCG.Query[] = { q: 'name:Base' };\n\nPokemonTCG.findSetsByQueries(params).then((sets: PokemonTCG.Set[]) => {\n   console.log(sets[0].name) // Base\n});\n```\n### getAllSets()\nReturns all Pokémon sets available through recursive pagination.\n```typescript\nimport { PokemonTCG } from 'pokemon-tcg-sdk-typescript';\n\nPokemonTCG.getAllSets();\n```\n\n## Contributing\nContributions are welcome! If you want to contribute, feel free to fork the repository, open and issue, then submit a pull request. \nESLint and Prettier are used to enforce a consistent coding style. \n\n### Setup\nRaring to code your heart out? Awesome! Here's how to get started:\n1. Open and issue with a bug or feature. Ensure the change is not already being worked on. \n2. Fork and clone the repository from the `master` branch.\n3. Create a feature branch.\n4. Run `npm ci` to install exact versions specified in the `package-lock.json`.\n5. Code your heart out!\n6. Run `npm run test` to run ESLint and Jest tests. \n7. (OPTIONAL) Test your changes in a project of yours:\n   1. Create a link with `npm` or `yarn` (depending on what tool you installed this SDK with)\n   2. In your project that uses the SDK, install the linked package with `yarn/npm link pokemon-tcg-sdk-typescript`\n   3. Verify the SDK behaves as expected, and your changes took effect\n8. Submit a [pull request](https://github.com/PokemonTCG/pokemon-tcg-sdk-typescript/compare)! 🎉\n\n","readmeFilename":"README.md"}