@ideal-postcodes/core-browser - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0

CHANGELOG.md

@@ -0,1 +1,13 @@
+# [1.1.0](https://github.com/ideal-postcodes/core-browser/compare/1.0.2...1.1.0) (2019-12-06)
+
+
+### Bug Fixes
+
+* **CBT:** Patch CBT lib ([7b58455](https://github.com/ideal-postcodes/core-browser/commit/7b5845533e796f47e6238799d0d9ef77c59048ef))
+
+
+### Features
+
+* **Core-Interface:** Update core-interface to 1.4.0 ([075f5c9](https://github.com/ideal-postcodes/core-browser/commit/075f5c9b150ae828d8d58ca4f25b326b6714efeb))
+
 ## [1.0.2](https://github.com/ideal-postcodes/core-browser/compare/1.0.1...1.0.2) (2019-10-22)
@@ -2,0 +14,0 @@

package.json

 {
   "name": "@ideal-postcodes/core-browser",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Browser javascript client for api.ideal-postcodes.co.uk",
@@ -58,7 +58,7 @@ "author": {
   "dependencies": {
-    "@ideal-postcodes/core-interface": "~1.3.0"
+    "@ideal-postcodes/core-interface": "~1.4.0"
   },
   "devDependencies": {
     "@cablanchard/eslint-config": "~1.1.1",
-    "@cablanchard/semantic-release": "~1.2.1",
+    "@cablanchard/semantic-release": "~1.3.0",
     "@cablanchard/tsconfig": "~1.0.0",
@@ -68,7 +68,7 @@ "@ideal-postcodes/api-typings": "~1.1.0",
     "@types/chai": "~4.2.3",
-    "@types/dotenv": "~6.1.1",
+    "@types/dotenv": "~8.2.0",
     "@types/karma": "~3.0.3",
     "@types/mocha": "~5.2.7",
-    "@types/node": "~12.11.1",
-    "@types/puppeteer": "~1.20.2",
+    "@types/node": "~12.12.0",
+    "@types/puppeteer": "~2.0.0",
     "babel-polyfill": "~6.26.0",
@@ -78,3 +78,3 @@ "chai": "~4.2.0",
     "dotenv": "~8.2.0",
-    "eslint": "~6.5.1",
+    "eslint": "~6.7.1",
     "karma": "~4.4.0",
@@ -89,11 +89,11 @@ "karma-cbt-launcher": "~0.4.6",
     "mocha": "~6.2.1",
-    "nock": "~11.4.0",
-    "prettier": "~1.18.2",
-    "puppeteer": "~1.20.0",
+    "nock": "~11.7.0",
+    "prettier": "~1.19.1",
+    "puppeteer": "~2.0.0",
     "semantic-release": "~15.13.24",
     "sinon": "~7.5.0",
-    "ts-node": "~8.4.1",
-    "typescript": "~3.6.4",
+    "ts-node": "~8.5.0",
+    "typescript": "~3.7.2",
     "typedoc": "~0.15.0"
   }
 }

README.md

@@ -5,19 +5,23 @@ <h1 align="center">
 
-> JavaScript browser client for api.ideal-postcodes.co.uk
+> JavaScript (browser) client for api.ideal-postcodes.co.uk
 
 [![CircleCI](https://circleci.com/gh/ideal-postcodes/core-browser/tree/master.svg?style=svg)](https://circleci.com/gh/ideal-postcodes/core-browser/tree/master)
 [![codecov](https://codecov.io/gh/ideal-postcodes/core-browser/branch/master/graph/badge.svg?token=bjeFUcTPi5)](https://codecov.io/gh/ideal-postcodes/core-browser)
-![Dependency Status](https://david-dm.org/ideal-postcodes/core-browser.svg)
+[![Dependency Status](https://david-dm.org/ideal-postcodes/core-browser.svg)](https://david-dm.org/ideal-postcodes/core-browser)
 [![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-browser.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-browser)
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/@ideal-postcodes/core-browser)
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@ideal-postcodes/core-browser)](https://bundlephobia.com/result?p=@ideal-postcodes/core-browser)
 
 `@ideal-postcodes/core-browser` is the JavaScript browser client for api.ideal-postcodes.co.uk
 
-Our JavaScript client implements a common interface defined at [`@ideal-postcodes/core-interface`](https://github.com/ideal-postcodes/core-interface). In depth client documentation can be found at [core-interface.ideal-postcodes.dev](https://core-interface.ideal-postcodes.dev).
+Our JavaScript client implements a common interface defined at [@ideal-postcodes/core-interface](https://github.com/ideal-postcodes/core-interface).
 
+High level client documentation can be found at [core-interface](https://github.com/ideal-postcodes/core-interface/blob/master/README.md).
+
+In depth client documentation can be found at [core-interface.ideal-postcodes.dev](https://core-interface.ideal-postcodes.dev).
+
 Tested against [a suite of modern and legacy, mobile and desktop browsers](https://github.com/ideal-postcodes/supported-browsers).
 
-This library is transpiled to modern ES6 and modules. It should be consumed by a bundler or transpiler (e.g. webpack, parcel, rollup) for minification, module resolution and specific browser support.
+`@ideal-postcodes/core-browser`should be consumed by a bundler or transpiler (e.g. webpack, parcel, rollup) for minification, module resolution and specific browser support.
 
-To support legacy browsers, you will also need to include `fetch` polyfill and ES3 transpilation.
+[core-browser-bundled](https://github.com/ideal-postcodes/core-browser-bundled) provides pre-bundled versions of `core-browser`, which can be immediately dropped into a page.
 
@@ -28,4 +32,4 @@ ## Links
 - [Quickstart](#quickstart)
-- [Client Documentation](https://core-interface.ideal-postcodes.dev/#documentation)
-- [Core JS API Client Documentation](https://core-interface.ideal-postcodes.dev/)
+- [Client Documentation](https://github.com/ideal-postcodes/core-interface/blob/master/README.md)
+- [In Depth Client Documentation](https://core-interface.ideal-postcodes.dev/#documentation)
 - [npm Module](https://www.npmjs.com/package/@ideal-postcodes/core-browser)
@@ -32,0 +36,0 @@ - [GitHub Repository](https://github.com/ideal-postcodes/core-browser)

No alert changes

Improved metrics

Total package byte prevSize

23703

increased by3.33%

Number of lines in readme file

159

increased by2.58%

Dependency changes

• + Added@ideal-postcodes/core-interface@1.4.0(transitive)

• - Removed@ideal-postcodes/core-interface@1.3.0(transitive)

• Updated@ideal-postcodes/core-interface@~1.4.0