@ideal-postcodes/address-finder - npm Package Compare versions

Comparing version 1.8.0 to 1.8.1

CHANGELOG.md

@@ -0,1 +1,8 @@
+## [1.8.1](https://github.com/ideal-postcodes/address-finder/compare/1.8.0...1.8.1) (2021-03-11)
+
+
+### Bug Fixes
+
+* **License:** Update ([5a86433](https://github.com/ideal-postcodes/address-finder/commit/5a86433eb6e7533e957acc6bc9859eb2af65ce7b))
+
 # [1.8.0](https://github.com/ideal-postcodes/address-finder/compare/1.7.0...1.8.0) (2021-03-11)
@@ -2,0 +9,0 @@

dist/controller.d.ts

@@ -68,3 +68,5 @@ import { View } from "./view";
     /**
-     * Creates a new instance of `Autocomplete.View` and attaches it to the DOM.
+     * Attaches Controller to the DOM.
+     *
+     * If `checkKey` is enabled, a key check will be performed prioer to binding. Use the `onLoaded` and `onFailedCheck` callbacks to define follow up behaviour if the key check succeeds or fails
      */
@@ -88,2 +90,3 @@ init(): Promise<void>;
      * Writes a selected to the input fields specified in the controller config
+     *
      * @public
@@ -90,0 +93,0 @@ */

dist/controller.js

@@ -75,3 +75,3 @@ "use strict";
     onKeyDown: NOOP,
-    onUnhide: NOOP
+    onUnhide: NOOP,
 };
@@ -116,3 +116,3 @@ /**
             }),
-            onSelect: this._onSelect()
+            onSelect: this._onSelect(),
         });
@@ -132,3 +132,5 @@ this.init();
     /**
-     * Creates a new instance of `Autocomplete.View` and attaches it to the DOM.
+     * Attaches Controller to the DOM.
+     *
+     * If `checkKey` is enabled, a key check will be performed prioer to binding. Use the `onLoaded` and `onFailedCheck` callbacks to define follow up behaviour if the key check succeeds or fails
      */
@@ -214,2 +216,3 @@ init() {
      * Writes a selected to the input fields specified in the controller config
+     *
      * @public
@@ -216,0 +219,0 @@ */

dist/index.d.ts

@@ -36,2 +36,5 @@ import { Address, AddressSuggestion } from "@ideal-postcodes/api-typings";
 }
+/**
+ * Configuration options for an Address Finder instance
+ */
 export interface ControllerOptions extends Partial<Omit<Config, "api_key">>, Partial<Omit<ViewOptions, "scope" | "document">> {
@@ -255,2 +258,7 @@ /**
 }
+/**
+ * Configure and launch an instance of the Address Finder
+ *
+ * This method will create and return a new AddressFinder instance. It will also add a global reference to the controller at `AddressFinder.controllers`
+ */
 export declare const setup: (config: ControllerOptions) => Controller;
@@ -257,0 +265,0 @@ /**

dist/index.js

@@ -6,2 +6,7 @@ "use strict";
 Object.defineProperty(exports, "Controller", { enumerable: true, get: function () { return controller_1.Controller; } });
+/**
+ * Configure and launch an instance of the Address Finder
+ *
+ * This method will create and return a new AddressFinder instance. It will also add a global reference to the controller at `AddressFinder.controllers`
+ */
 const setup = (config) => {
@@ -8,0 +13,0 @@ const c = new controller_1.Controller(config);

dist/view.d.ts

@@ -270,3 +270,3 @@ import { AddressSuggestion } from "@ideal-postcodes/api-typings";
 /**
- * View
+ * # View
  *
@@ -273,0 +273,0 @@ * Represents the user interface which binds to the DOM.

dist/view.js

@@ -9,3 +9,3 @@ "use strict";
 /**
- * View
+ * # View
  *
@@ -12,0 +12,0 @@ * Represents the user interface which binds to the DOM.

esm/controller.d.ts

@@ -68,3 +68,5 @@ import { View } from "./view";
     /**
-     * Creates a new instance of `Autocomplete.View` and attaches it to the DOM.
+     * Attaches Controller to the DOM.
+     *
+     * If `checkKey` is enabled, a key check will be performed prioer to binding. Use the `onLoaded` and `onFailedCheck` callbacks to define follow up behaviour if the key check succeeds or fails
      */
@@ -88,2 +90,3 @@ init(): Promise<void>;
      * Writes a selected to the input fields specified in the controller config
+     *
      * @public
@@ -90,0 +93,0 @@ */

esm/controller.js

@@ -69,3 +69,3 @@ /* eslint-disable no-invalid-this */
     onKeyDown: NOOP,
-    onUnhide: NOOP
+    onUnhide: NOOP,
 };
@@ -110,3 +110,3 @@ /**
             }),
-            onSelect: this._onSelect()
+            onSelect: this._onSelect(),
         });
@@ -126,3 +126,5 @@ this.init();
     /**
-     * Creates a new instance of `Autocomplete.View` and attaches it to the DOM.
+     * Attaches Controller to the DOM.
+     *
+     * If `checkKey` is enabled, a key check will be performed prioer to binding. Use the `onLoaded` and `onFailedCheck` callbacks to define follow up behaviour if the key check succeeds or fails
      */
@@ -208,2 +210,3 @@ init() {
      * Writes a selected to the input fields specified in the controller config
+     *
      * @public
@@ -210,0 +213,0 @@ */

esm/index.d.ts

@@ -36,2 +36,5 @@ import { Address, AddressSuggestion } from "@ideal-postcodes/api-typings";
 }
+/**
+ * Configuration options for an Address Finder instance
+ */
 export interface ControllerOptions extends Partial<Omit<Config, "api_key">>, Partial<Omit<ViewOptions, "scope" | "document">> {
@@ -255,2 +258,7 @@ /**
 }
+/**
+ * Configure and launch an instance of the Address Finder
+ *
+ * This method will create and return a new AddressFinder instance. It will also add a global reference to the controller at `AddressFinder.controllers`
+ */
 export declare const setup: (config: ControllerOptions) => Controller;
@@ -257,0 +265,0 @@ /**

esm/index.js

 import { Controller, defaults } from "./controller";
+/**
+ * Configure and launch an instance of the Address Finder
+ *
+ * This method will create and return a new AddressFinder instance. It will also add a global reference to the controller at `AddressFinder.controllers`
+ */
 export const setup = (config) => {
@@ -3,0 +8,0 @@ const c = new Controller(config);

esm/view.d.ts

@@ -270,3 +270,3 @@ import { AddressSuggestion } from "@ideal-postcodes/api-typings";
 /**
- * View
+ * # View
  *
@@ -273,0 +273,0 @@ * Represents the user interface which binds to the DOM.

esm/view.js

@@ -6,3 +6,3 @@ import { isString, toKey, setStyle, restoreStyle, idGen, show, hide, remove, toHtmlElem, } from "@ideal-postcodes/jsutil";
 /**
- * View
+ * # View
  *
@@ -9,0 +9,0 @@ * Represents the user interface which binds to the DOM.

package.json

 {
   "name": "@ideal-postcodes/address-finder",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "description": "Address Finder JS library backed by the Ideal Postcodes UK address search API",
@@ -36,3 +36,3 @@ "main": "dist/index.js",
   },
-  "homepage": "https://github.com/ideal-postcodes/address-finder",
+  "homepage": "https://address-finder.ideal-postcodes.dev",
   "repository": {
@@ -44,3 +44,2 @@ "type": "git",
     "test": "karma start",
-    "test:browsers": "npm run test:browsers:latest && npm run test:browsers:legacy",
     "test:browsers:latest": "karma start .config/latest.conf.ts",
@@ -55,3 +54,3 @@ "test:browsers:legacy": "karma start .config/legacy.conf.ts",
     "css": "minify css/address-finder.css > css/address-finder.min.css && minify css/optional.css > css/optional.min.css",
-    "docs": "typedoc --mode file --out docs/ --name 'Ideal Postcodes Address Finder' --theme minimal --excludePrivate --hideGenerator lib/",
+    "docs": "typedoc",
     "prepublishOnly": "npm run build"
@@ -102,3 +101,3 @@ },
   ],
-  "license": "AGPL-3.0",
+  "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
@@ -113,3 +112,3 @@ "@ideal-postcodes/core-axios": "~2.2.4",
     "@babel/core": "~7.12.3",
-    "@babel/preset-env": "~7.12.1",
+    "@babel/preset-env": "~7.13.9",
     "@cablanchard/eslint-config": "~2.1.0",
@@ -120,2 +119,3 @@ "@cablanchard/semantic-release": "~1.3.4",
     "@ideal-postcodes/api-typings": "~2.0.1",
+    "@ideal-postcodes/doc-assets": "~1.0.0",
     "@ideal-postcodes/supported-browsers": "~2.5.0",
@@ -156,8 +156,8 @@ "@rollup/plugin-commonjs": "~17.1.0",
     "rollup": "~2.40.0",
-    "semantic-release": "~17.3.1",
+    "semantic-release": "~17.4.1",
     "sinon": "~9.2.2",
     "ts-node": "~9.1.1",
-    "typedoc": "~0.19.2",
-    "typescript": "~4.1.3"
+    "typedoc": "~0.20.30",
+    "typescript": "~4.2.3"
   }
 }

README.md

@@ -7,7 +7,3 @@ <h1 align="center">
 
-![Cross Browser Testing](https://github.com/ideal-postcodes/address-finder/workflows/Cross%20Browser%20Testing/badge.svg?branch=saucelabs)
-[![Release](https://github.com/ideal-postcodes/address-finder/workflows/Release/badge.svg)](https://github.com/ideal-postcodes/address-finder/actions)
 [![codecov](https://codecov.io/gh/ideal-postcodes/address-finder/branch/main/graph/badge.svg?token=WWZ31TM1M7)](https://codecov.io/gh/ideal-postcodes/address-finder)
-![Dependency Status](https://david-dm.org/ideal-postcodes/address-finder.svg)
-
 [![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Faddress-finder.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Faddress-finder)
@@ -26,5 +22,5 @@ ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@ideal-postcodes/address-finder.svg?color=%234c1&style=popout)
 
-- [How it Works](https://github.com/ideal-postcodes/address-finder#how-it-works)
-- [Documentation](https://github.com/ideal-postcodes/address-finder#documentation)
-- [Quickstart](https://github.com/ideal-postcodes/address-finder#quickstart)
+- [How it Works](#how-it-works)
+- [Documentation](#documentation)
+- [Quickstart](#quickstart)
 - [Library Documentation](https://address-finder.ideal-postcodes.dev/)
@@ -38,9 +34,9 @@ - [npm Module](https://www.npmjs.com/package/@ideal-postcodes/address-finder)
 
-[![Webpack Status](https://github.com/ideal-postcodes/address-finder/workflows/Webpack%20Demo/badge.svg)](examples/webpack/)
+[![Webpack Status](https://github.com/ideal-postcodes/address-finder-examples/workflows/Webpack%20Demo/badge.svg)](examples/webpack/)
 
-[![Parcel Status](https://github.com/ideal-postcodes/address-finder/workflows/Parcel%20Demo/badge.svg)](examples/parcel/)
+[![Parcel Status](https://github.com/ideal-postcodes/address-finder-examples/workflows/Parcel%20Demo/badge.svg)](examples/parcel/)
 
-[![Rollup Status](https://github.com/ideal-postcodes/address-finder/workflows/Rollup%20Demo/badge.svg)](examples/rollup/)
+[![Rollup Status](https://github.com/ideal-postcodes/address-finder-examples/workflows/Rollup%20Demo/badge.svg)](examples/rollup/)
 
-[![React Demo](https://github.com/ideal-postcodes/address-finder/workflows/React%20Demo/badge.svg)](examples/react/)
+[![React Demo](https://github.com/ideal-postcodes/address-finder-examples/workflows/React%20Demo/badge.svg)](examples/react/)
 
@@ -348,2 +344,2 @@ ## Related Projects
 
-GNU Affero General Public License v3.0
+Copyright IDDQD Limited

New alerts

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license

Found 1 instance in 1 package

Fixed alerts

Copyleft License

License

(Experimental) Copyleft license information was found

Found 1 instance in 1 package

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found

Found 1 instance in 1 package

Improved metrics

Number of low license alerts

2

decreased by-50%

License quality

80

increased by14.29%

Lines of code

4078

increased by0.94%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

153587

decreased by-17.76%

Dev dependency count

49

increased by2.08%

Number of lines in readme file

342

decreased by-1.16%

No dependency changes