@scaleleap/amazon-marketplaces - npm Package Compare versions

Comparing version 1.3.0 to 1.4.0

CHANGELOG.md

@@ -6,2 +6,9 @@ # Changelog
 
+# [1.4.0](https://github.com/ScaleLeap/amazon-marketplaces/compare/v1.3.0...v1.4.0) (2020-02-18)
+
+
+### Features
+
+* adds utility functions to finding marketplaces ([cad2615](https://github.com/ScaleLeap/amazon-marketplaces/commit/cad261596a85ce16197ffecd7e545238b8a75089))
+
 # [1.3.0](https://github.com/ScaleLeap/amazon-marketplaces/compare/v1.2.0...v1.3.0) (2020-01-30)
@@ -8,0 +15,0 @@

package.json

 {
   "name": "@scaleleap/amazon-marketplaces",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "publishConfig": {
     "access": "public"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "description": "A collection of Amazon Marketplace data objects.",
   "homepage": "https://github.com/ScaleLeap/amazon-marketplaces#readme",
   "scripts": {
-    "test": "jest && npm run lint",
+    "test": "jest",
+    "prebuild": "npm run clean",
     "build": "tsc",
+    "clean": "rimraf lib",
     "build:docs": "typedoc",
@@ -34,12 +36,13 @@ "lint": "eslint --ext .ts --ignore-path .gitignore ."
     "@jedmao/semantic-release-npm-github-config": "1.0.9",
-    "@types/jest": "24.9.1",
-    "@types/node": "13.5.0",
-    "@typescript-eslint/eslint-plugin": "2.17.0",
-    "@typescript-eslint/parser": "2.17.0",
+    "@types/jest": "25.1.2",
+    "@types/node": "13.7.1",
+    "@typescript-eslint/eslint-plugin": "2.19.2",
+    "@typescript-eslint/parser": "2.19.2",
     "eslint": "6.8.0",
-    "eslint-config-prettier": "6.9.0",
+    "eslint-config-prettier": "6.10.0",
     "eslint-plugin-prettier": "3.1.2",
     "jest": "25.1.0",
     "prettier": "1.19.1",
-    "ts-jest": "25.0.0",
+    "rimraf": "3.0.2",
+    "ts-jest": "25.2.0",
     "tsconfigs": "4.0.2",
@@ -49,3 +52,5 @@ "typedoc": "0.16.9",
   },
-  "dependencies": {},
+  "dependencies": {
+    "@lavadrop/ensure": "1.0.0"
+  },
   "release": {
@@ -52,0 +57,0 @@ "extends": "@jedmao/semantic-release-npm-github-config",

README.md

@@ -34,2 +34,4 @@ ![Amazon Marketplace Logo](https://raw.githubusercontent.com/ScaleLeap/amazon-marketplaces/master/amazon-marketplace.png)
 
+#### Enum of Amazon Marketplace Data
+
 ```ts
@@ -45,2 +47,23 @@ import { amazonMarketplaces } from '@scaleleap/amazon-marketplaces'
 
+#### List of Amazon Marketplace Data
+
+```ts
+import { amazonMarketplacesList } from '@scaleleap/amazon-marketplaces'
+
+const marketplaceIds = amazonMarketplacesList.map(marketplace => marketplace.id)
+```
+
+#### Utility Functions
+
+```ts
+import { findAmazonMarketplace, findAmazonMarketplaceOrFail } from '@scaleleap/amazon-marketplaces'
+
+// Return value *can* be undefined
+const CA = findAmazonMarketplace('countryCode', 'CA')
+
+// Function will throw an error if marketplace is not found
+// Thus return value is never undefined.
+const US = findAmazonMarketplaceOrFail('countryCode', 'US')
+```
+
 ### Full Data Object Example
@@ -101,1 +124,7 @@
 This project is licensed under the MIT License.
+
+### Badges
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ScaleLeap/amazon-marketplaces/CI)](https://github.com/ScaleLeap/amazon-marketplaces/actions)
+[![NPM](https://img.shields.io/npm/v/@scaleleap/amazon-marketplaces)](https://npm.im/@scaleleap/amazon-marketplaces)
+[![License](https://img.shields.io/npm/l/@scaleleap/amazon-marketplaces)](./LICENSE)

src/index.ts

@@ -0,2 +1,3 @@
+export * from './amazon-marketplace'
 export * from './marketplaces'
-export * from './amazon-marketplace'
+export * from './utils'

tests/index.test.ts

@@ -1,2 +0,8 @@
-import { AmazonMarketplace, amazonMarketplaces, amazonMarketplacesList } from '../src'
+import {
+  AmazonMarketplace,
+  amazonMarketplaces,
+  amazonMarketplacesList,
+  findAmazonMarketplace,
+  findAmazonMarketplaceOrFail,
+} from '../src'
 
@@ -7,2 +13,4 @@ describe('index', () => {
     expect(AmazonMarketplace).toBeTruthy()
+    expect(findAmazonMarketplace).toBeTruthy()
+    expect(findAmazonMarketplaceOrFail).toBeTruthy()
   })
@@ -9,0 +17,0 @@

tsconfig.json

 {
   "extends": "tsconfigs/nodejs-module",
   "compilerOptions": {
-    "outDir": "dist"
+    "outDir": "lib"
   },
@@ -6,0 +6,0 @@ "include": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

66218

increased by10.45%

Number of package files

99

increased by5.32%

Lines of code

1243

increased by11.48%

Number of lines in readme file

128

increased by29.29%

Worsened metrics

Dependency count

1

increased byInfinity%

Dev dependency count

15

increased by7.14%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@lavadrop/ensure@1.0.0

• + Added@lavadrop/ensure@1.0.0(transitive)