nintendo-switch-eshop - npm Package Compare versions

Comparing version 3.0.3 to 4.0.0

CHANGELOG.md

@@ -5,2 +5,28 @@ # Changelog
 
+## [4.0.0](https://github.com/lmmfranco/nintendo-switch-eshop/compare/v3.0.3...v4.0.0) (2020-10-31)
+
+
+### ⚠ BREAKING CHANGES
+
+* use getQueriedGamesAmerica to get games based on a given query. For example when
+your users can perform a search (just like on the nintendo.com website) you can use this to severly
+limit the results to go through.
+* The repo files have been moved around a lot. This probably won't impact
+you too much, but if you were importing from a specific path (not the root of
+require('nintendo-switch-eshop')) then you'll have to change your imports.
+* **api:** getGamesAmerica no longer takes any parameters and
+should always return all games.
+
+Co-authored-by: Jeroen Claassens <[e-mail]>
+
+### Features
+
+* add getQueriedGamesAmerica ([bfc1830](https://github.com/lmmfranco/nintendo-switch-eshop/commit/bfc18301af2325286810ae8342d708a6771c3132))
+* restructure repo ([59ead46](https://github.com/lmmfranco/nintendo-switch-eshop/commit/59ead46ba2c2cbdfe7f3ffcddc53a144dbf7391f))
+
+
+### Bug Fixes
+
+* **api:** updated getgamesamerica algolia request to retrieve all games ([#281](https://github.com/lmmfranco/nintendo-switch-eshop/issues/281)) ([2ace2cc](https://github.com/lmmfranco/nintendo-switch-eshop/commit/2ace2ccfd6f90894b327861f344aa3217d85a5f7))
+
 ### [3.0.3](https://github.com/lmmfranco/nintendo-switch-eshop/compare/v3.0.2...v3.0.3) (2020-09-10)
@@ -7,0 +33,0 @@

dist/index.d.ts

@@ -1,5 +0,16 @@
-export * from './constants';
-export * from './interfaces';
-export * from './nintendo-switch-eshop';
-export { getGamesAmerica as default } from './nintendo-switch-eshop';
+export { getGamesAmerica as default, getGamesAmerica } from './lib/getGames/getGamesAmerica';
+export { getGamesEurope } from './lib/getGames/getGamesEurope';
+export { getGamesJapan } from './lib/getGames/getGamesJapan';
+export { getQueriedGamesAmerica } from './lib/getGames/getQueriedGamesAmerica';
+export { getActiveShops } from './lib/getShops/getActiveShops';
+export { getShopsAmerica } from './lib/getShops/getShopsAmerica';
+export { getShopsAsia } from './lib/getShops/getShopsAsia';
+export { getShopsEurope } from './lib/getShops/getShopsEurope';
+export { getPrices } from './lib/other/getPrices';
+export { getShopsByCountryCodes } from './lib/other/getShopByCountryCode';
+export { parseGameCode } from './lib/other/parseGameCode';
+export { parseNSUID } from './lib/other/parseNSUID';
+export { EU_GET_GAMES_URL, JP_GET_GAMES_URL, PRICE_GET_URL, QUERIED_US_ALGOLIA_KEY, Region, US_ALGOLIA_HEADERS, US_ALGOLIA_ID, US_ALGOLIA_KEY, US_GET_GAMES_URL } from './lib/utils/constants';
+export type { EShop, EURequestOptions, GameEU, GameJP, GameUS, PriceResponse, QueriedGameUS } from './lib/utils/interfaces';
+export { EshopError } from './lib/utils/utils';
 //# sourceMappingURL=index.d.ts.map

dist/index.js

 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = void 0;
-__exportStar(require("./constants"), exports);
-__exportStar(require("./interfaces"), exports);
-__exportStar(require("./nintendo-switch-eshop"), exports);
-var nintendo_switch_eshop_1 = require("./nintendo-switch-eshop");
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return nintendo_switch_eshop_1.getGamesAmerica; } });
+exports.EshopError = exports.US_GET_GAMES_URL = exports.US_ALGOLIA_KEY = exports.US_ALGOLIA_ID = exports.US_ALGOLIA_HEADERS = exports.Region = exports.QUERIED_US_ALGOLIA_KEY = exports.PRICE_GET_URL = exports.JP_GET_GAMES_URL = exports.EU_GET_GAMES_URL = exports.parseNSUID = exports.parseGameCode = exports.getShopsByCountryCodes = exports.getPrices = exports.getShopsEurope = exports.getShopsAsia = exports.getShopsAmerica = exports.getActiveShops = exports.getQueriedGamesAmerica = exports.getGamesJapan = exports.getGamesEurope = exports.getGamesAmerica = exports.default = void 0;
+var getGamesAmerica_1 = require("./lib/getGames/getGamesAmerica");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return getGamesAmerica_1.getGamesAmerica; } });
+Object.defineProperty(exports, "getGamesAmerica", { enumerable: true, get: function () { return getGamesAmerica_1.getGamesAmerica; } });
+var getGamesEurope_1 = require("./lib/getGames/getGamesEurope");
+Object.defineProperty(exports, "getGamesEurope", { enumerable: true, get: function () { return getGamesEurope_1.getGamesEurope; } });
+var getGamesJapan_1 = require("./lib/getGames/getGamesJapan");
+Object.defineProperty(exports, "getGamesJapan", { enumerable: true, get: function () { return getGamesJapan_1.getGamesJapan; } });
+var getQueriedGamesAmerica_1 = require("./lib/getGames/getQueriedGamesAmerica");
+Object.defineProperty(exports, "getQueriedGamesAmerica", { enumerable: true, get: function () { return getQueriedGamesAmerica_1.getQueriedGamesAmerica; } });
+var getActiveShops_1 = require("./lib/getShops/getActiveShops");
+Object.defineProperty(exports, "getActiveShops", { enumerable: true, get: function () { return getActiveShops_1.getActiveShops; } });
+var getShopsAmerica_1 = require("./lib/getShops/getShopsAmerica");
+Object.defineProperty(exports, "getShopsAmerica", { enumerable: true, get: function () { return getShopsAmerica_1.getShopsAmerica; } });
+var getShopsAsia_1 = require("./lib/getShops/getShopsAsia");
+Object.defineProperty(exports, "getShopsAsia", { enumerable: true, get: function () { return getShopsAsia_1.getShopsAsia; } });
+var getShopsEurope_1 = require("./lib/getShops/getShopsEurope");
+Object.defineProperty(exports, "getShopsEurope", { enumerable: true, get: function () { return getShopsEurope_1.getShopsEurope; } });
+var getPrices_1 = require("./lib/other/getPrices");
+Object.defineProperty(exports, "getPrices", { enumerable: true, get: function () { return getPrices_1.getPrices; } });
+var getShopByCountryCode_1 = require("./lib/other/getShopByCountryCode");
+Object.defineProperty(exports, "getShopsByCountryCodes", { enumerable: true, get: function () { return getShopByCountryCode_1.getShopsByCountryCodes; } });
+var parseGameCode_1 = require("./lib/other/parseGameCode");
+Object.defineProperty(exports, "parseGameCode", { enumerable: true, get: function () { return parseGameCode_1.parseGameCode; } });
+var parseNSUID_1 = require("./lib/other/parseNSUID");
+Object.defineProperty(exports, "parseNSUID", { enumerable: true, get: function () { return parseNSUID_1.parseNSUID; } });
+var constants_1 = require("./lib/utils/constants");
+Object.defineProperty(exports, "EU_GET_GAMES_URL", { enumerable: true, get: function () { return constants_1.EU_GET_GAMES_URL; } });
+Object.defineProperty(exports, "JP_GET_GAMES_URL", { enumerable: true, get: function () { return constants_1.JP_GET_GAMES_URL; } });
+Object.defineProperty(exports, "PRICE_GET_URL", { enumerable: true, get: function () { return constants_1.PRICE_GET_URL; } });
+Object.defineProperty(exports, "QUERIED_US_ALGOLIA_KEY", { enumerable: true, get: function () { return constants_1.QUERIED_US_ALGOLIA_KEY; } });
+Object.defineProperty(exports, "Region", { enumerable: true, get: function () { return constants_1.Region; } });
+Object.defineProperty(exports, "US_ALGOLIA_HEADERS", { enumerable: true, get: function () { return constants_1.US_ALGOLIA_HEADERS; } });
+Object.defineProperty(exports, "US_ALGOLIA_ID", { enumerable: true, get: function () { return constants_1.US_ALGOLIA_ID; } });
+Object.defineProperty(exports, "US_ALGOLIA_KEY", { enumerable: true, get: function () { return constants_1.US_ALGOLIA_KEY; } });
+Object.defineProperty(exports, "US_GET_GAMES_URL", { enumerable: true, get: function () { return constants_1.US_GET_GAMES_URL; } });
+var utils_1 = require("./lib/utils/utils");
+Object.defineProperty(exports, "EshopError", { enumerable: true, get: function () { return utils_1.EshopError; } });
 //# sourceMappingURL=index.js.map

package.json

 {
-	"name": "nintendo-switch-eshop",
-	"version": "3.0.3",
-	"description": "Unofficial API lib for Nintendo Switch eShop game listing and pricing information.",
-	"author": "lmmfranco",
-	"license": "Apache-2.0",
-	"main": "dist/index.js",
-	"types": "dist/index.d.ts",
-	"scripts": {
-		"test": "jest",
-		"lint": "eslint src __tests__ --ext js,ts --fix",
-		"build": "tsc -b src",
-		"watch": "tsc -b src -w",
-		"clean": "tsc -b src --clean",
-		"docs": "typedoc",
-		"prepublishOnly": "tsc -b src",
-		"sversion": "standard-version",
-		"commit": "git-cz",
-		"cz": "git-cz",
-		"update": "yarn upgrade-interactive --latest"
-	},
-	"dependencies": {
-		"@types/country-data": "^0.0.2",
-		"country-data": "^0.0.31",
-		"fast-xml-parser": "^3.17.4",
-		"node-fetch": "^2.6.1"
-	},
-	"devDependencies": {
-		"@commitlint/cli": "^9.1.2",
-		"@commitlint/config-conventional": "^9.1.2",
-		"@favware/eslint-config": "^5.1.3",
-		"@favware/ts-config": "^3.0.3",
-		"@types/jest": "^26.0.13",
-		"@types/node": "^14.10.0",
-		"@types/node-fetch": "^2.5.7",
-		"common-tags": "^1.8.0",
-		"cz-conventional-changelog": "^3.3.0",
-		"eslint": "^7.8.1",
-		"husky": "^4.3.0",
-		"jest": "^26.4.2",
-		"jest-circus": "^26.4.2",
-		"lint-staged": "^10.3.0",
-		"replace": "^1.2.0",
-		"standard-version": "^9.0.0",
-		"ts-jest": "^26.3.0",
-		"ts-node": "^9.0.0",
-		"typedoc": "^0.19.1",
-		"typedoc-plugin-nojekyll": "^1.0.1",
-		"typescript": "^4.0.2"
-	},
-	"files": [
-		"dist/",
-		"!dist/tsconfig.tsbuildinfo"
-	],
-	"engines": {
-		"node": ">=10",
-		"npm": ">=6"
-	},
-	"keywords": [
-		"eshop",
-		"switch",
-		"nintendo",
-		"crawler",
-		"lib",
-		"typescript"
-	],
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/lmmfranco/nintendo-switch-eshop.git"
-	},
-	"bugs": {
-		"url": "https://github.com/lmmfranco/nintendo-switch-eshop/issues"
-	},
-	"husky": {
-		"hooks": {
-			"commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-			"pre-commit": "yarn lint-staged"
-		}
-	},
-	"lint-staged": {
-		"*.{mjs,js,ts}": "eslint --fix --ext mjs,js,ts"
-	},
-	"config": {
-		"commitizen": {
-			"path": "./node_modules/cz-conventional-changelog"
-		}
-	},
-	"commitlint": {
-		"extends": [
-			"@commitlint/config-conventional"
-		]
-	},
-	"resolutions": {
-		"lodash": "^4.17.20",
-		"dot-prop": "^5.3.0"
-	}
+  "name": "nintendo-switch-eshop",
+  "version": "4.0.0",
+  "description": "Unofficial API lib for Nintendo Switch eShop game listing and pricing information.",
+  "author": "lmmfranco",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint src __tests__ --ext js,ts --fix",
+    "build": "tsc -b src",
+    "watch": "tsc -b src -w",
+    "clean": "tsc -b src --clean",
+    "docs": "typedoc",
+    "prepublishOnly": "tsc -b src",
+    "sversion": "standard-version",
+    "commit": "git-cz",
+    "cz": "git-cz",
+    "update": "yarn upgrade-interactive --latest"
+  },
+  "dependencies": {
+    "@types/country-data": "^0.0.2",
+    "country-data": "^0.0.31",
+    "fast-xml-parser": "^3.17.4",
+    "node-fetch": "^2.6.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^11.0.0",
+    "@commitlint/config-conventional": "^11.0.0",
+    "@favware/eslint-config": "^6.0.2",
+    "@favware/ts-config": "^3.0.4",
+    "@types/jest": "^26.0.15",
+    "@types/node": "^14.14.6",
+    "@types/node-fetch": "^2.5.7",
+    "@typescript-eslint/eslint-plugin": "^4.6.0",
+    "@typescript-eslint/parser": "^4.6.0",
+    "common-tags": "^1.8.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^7.12.1",
+    "eslint-config-prettier": "^6.15.0",
+    "eslint-plugin-prettier": "^3.1.4",
+    "husky": "^4.3.0",
+    "jest": "^26.6.1",
+    "jest-circus": "^26.6.1",
+    "lint-staged": "^10.5.1",
+    "prettier": "^2.1.2",
+    "replace": "^1.2.0",
+    "standard-version": "^9.0.0",
+    "ts-jest": "^26.4.3",
+    "ts-node": "^9.0.0",
+    "typedoc": "^0.19.2",
+    "typedoc-plugin-nojekyll": "^1.0.1",
+    "typescript": "^4.0.5"
+  },
+  "files": [
+    "dist/",
+    "!dist/tsconfig.tsbuildinfo"
+  ],
+  "engines": {
+    "node": ">=10",
+    "npm": ">=6"
+  },
+  "keywords": [
+    "eshop",
+    "switch",
+    "nintendo",
+    "crawler",
+    "lib",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lmmfranco/nintendo-switch-eshop.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lmmfranco/nintendo-switch-eshop/issues"
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-commit": "yarn lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{mjs,js,ts}": "eslint --fix --ext mjs,js,ts"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "resolutions": {
+    "lodash": "^4.17.20",
+    "dot-prop": "^6.0.0"
+  }
 }

README.md

 <div align="center">
-  <p>
-  <a href="https://www.npmjs.com/package/nintendo-switch-eshop"><img src="https://cdn.favware.tech/img/nintendoeshop.png" height="200" alt="logo"/></a>
-  </p>
 
-  <p>
-<h1> nintendo-switch-eshop </h1>
-<h3> A Node.JS lib written to extract Nintendo Switch's eShop game and pricing information </h3>
-  </p>
-</div>
+<a href="https://www.npmjs.com/package/nintendo-switch-eshop"><img src="https://cdn.favware.tech/img/nintendoeshop.png" height="100" alt="logo"/></a>
 
----
+# nintendo-switch-eshop
 
-**Project Status**
+**A Node.JS lib written to extract Nintendo Switch's eShop game and pricing information**
 
 [![GitHub](https://img.shields.io/github/license/lmmfranco/nintendo-switch-eshop?logo=github&style=flat-square)](https://github.com/lmmfranco/nintendo-switch-eshop/blob/master/LICENSE)
-[![npm](https://img.shields.io/npm/v/nintendo-switch-eshop?color=crimson&label=nintendo-switch-eshop%20version&logo=npm&style=flat-square)](https://www.npmjs.com/package/nintendo-switch-eshop)
-[![npm](https://img.shields.io/npm/dw/nintendo-switch-eshop?color=crimson&label=NPM%20Weekly%20Downloads&logo=npm&style=flat-square)](https://www.npmjs.com/package/nintendo-switch-eshop)
-[![npm](https://img.shields.io/npm/dt/nintendo-switch-eshop?color=crimson&label=NPM%20Total%20Downloads&logo=npm&style=flat-square)](https://www.npmjs.com/package/nintendo-switch-eshop)
+[![npm](https://img.shields.io/npm/v/nintendo-switch-eshop?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/nintendo-switch-eshop)
+[![npm](https://img.shields.io/npm/dw/nintendo-switch-eshop?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/nintendo-switch-eshop)
+[![npm](https://img.shields.io/npm/dt/nintendo-switch-eshop?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/nintendo-switch-eshop)
 
-**Bundle Sizes**
+</div>
 
-[![npm bundle size](https://img.shields.io/bundlephobia/min/nintendo-switch-eshop?label=nintendo-switch-eshop%20-%20minified&logo=webpack&style=flat-square)](https://bundlephobia.com/result?p=nintendo-switch-eshop)
-[![npm bundle size](https://img.shields.io/bundlephobia/minzip/nintendo-switch-eshop?label=nintendo-switch-eshop%20-%20minzipped&logo=webpack&style=flat-square)](https://bundlephobia.com/result?p=nintendo-switch-eshop)
-
 ---
@@ -31,2 +21,3 @@
 Add the package through your package manager of choice:
+
 ```sh
@@ -38,5 +29,6 @@ npm install nintendo-switch-eshop
 Require your desired functions:
+
 ```js
-const { getGamesAmerica, getGamesEurope, getGamesJapan } = require('nintendo-switch-eshop');
-// ES6 Style: import { getGamesAmerica, getGamesEurope, getGamesJapan } from 'nintendo-switch-eshop';
+const { getGamesAmerica, getGamesEurope, getGamesJapan, getQueriedGamesAmerica } = require('nintendo-switch-eshop');
+// ES6 Style: import { getGamesAmerica, getGamesEurope, getGamesJapan, getQueriedGamesAmerica } from 'nintendo-switch-eshop';
 // getGamesAmerica is also default exported: import getGamesAmerica from 'nintendo-switch-eshop';
@@ -68,8 +60,12 @@ ```
   </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/bvanzile"><img src="https://avatars3.githubusercontent.com/u/9438505?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bryan Van Zile</b></sub></a><br /><a href="https://github.com/lmmfranco/nintendo-switch-eshop/commits?author=bvanzile" title="Code">💻</a> <a href="https://github.com/lmmfranco/nintendo-switch-eshop/issues?q=author%3Abvanzile" title="Bug reports">🐛</a></td>
+  </tr>
 </table>
 
-<!-- markdownlint-enable -->
+<!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

109007

increased by32.95%

Number of package files

68

increased by240%

Lines of code

1274

increased by45.6%

Worsened metrics

Dev dependency count

26

increased by23.81%

Number of lines in readme file

69

decreased by-4.17%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes