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

Comparing version 2.1.0 to 2.2.0

CHANGELOG.md

@@ -0,1 +1,8 @@
+# [2.2.0](https://github.com/ideal-postcodes/address-finder/compare/2.1.0...2.2.0) (2021-06-29)
+
+
+### Features
+
+* **OutputFields:** Target fields using names and labels ([007a260](https://github.com/ideal-postcodes/address-finder/commit/007a2602ade00277b9a1c01971e32cf5c280775e))
+
 # [2.1.0](https://github.com/ideal-postcodes/address-finder/compare/2.0.0...2.1.0) (2021-06-23)
@@ -2,0 +9,0 @@

dist/controller.js

@@ -36,2 +36,4 @@ "use strict";
     outputFields: {},
+    names: {},
+    labels: {},
     removeOrganisation: false,
@@ -234,2 +236,4 @@ injectStyle: true,
             outputFields: this.options.outputFields,
+            names: this.options.names,
+            labels: this.options.labels,
         });
@@ -236,0 +240,0 @@ this.options.onAddressPopulated.call(this, address);

dist/index.d.ts

@@ -8,3 +8,3 @@ /**
 import { Controller, defaults } from "./controller";
-import { SelectorNode, OutputFields } from "@ideal-postcodes/jsutil";
+import { SelectorNode, OutputFields, NamedFields } from "@ideal-postcodes/jsutil";
 import { View, ViewOptions, OnOpen, OnBlur, OnClose, OnFocus, OnInput, OnSelect, OnUnhide } from "./view";
@@ -87,2 +87,12 @@ export interface OnLoaded {
     /**
+     * An object specifying the `name`s of HTML Input Elements to target for address population
+     *
+     * This will fallback to `aria-name` if a name cannot be detected
+     */
+    names?: NamedFields;
+    /**
+     * An object specifying the labels associated with HTML Input Elements to target for address population
+     */
+    labels?: NamedFields;
+    /**
      * Optional. An optional field to remove organisation name from address lines.
@@ -89,0 +99,0 @@ *

esm/controller.js

@@ -29,2 +29,4 @@ /**
     outputFields: {},
+    names: {},
+    labels: {},
     removeOrganisation: false,
@@ -227,2 +229,4 @@ injectStyle: true,
             outputFields: this.options.outputFields,
+            names: this.options.names,
+            labels: this.options.labels,
         });
@@ -229,0 +233,0 @@ this.options.onAddressPopulated.call(this, address);

esm/index.d.ts

@@ -8,3 +8,3 @@ /**
 import { Controller, defaults } from "./controller";
-import { SelectorNode, OutputFields } from "@ideal-postcodes/jsutil";
+import { SelectorNode, OutputFields, NamedFields } from "@ideal-postcodes/jsutil";
 import { View, ViewOptions, OnOpen, OnBlur, OnClose, OnFocus, OnInput, OnSelect, OnUnhide } from "./view";
@@ -87,2 +87,12 @@ export interface OnLoaded {
     /**
+     * An object specifying the `name`s of HTML Input Elements to target for address population
+     *
+     * This will fallback to `aria-name` if a name cannot be detected
+     */
+    names?: NamedFields;
+    /**
+     * An object specifying the labels associated with HTML Input Elements to target for address population
+     */
+    labels?: NamedFields;
+    /**
      * Optional. An optional field to remove organisation name from address lines.
@@ -89,0 +99,0 @@ *

package.json

 {
   "name": "@ideal-postcodes/address-finder",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Address Finder JS library backed by the Ideal Postcodes UK address search API",
@@ -100,4 +100,4 @@ "main": "dist/index.js",
   "dependencies": {
-    "@ideal-postcodes/jsutil": "~4.3.12",
     "@ideal-postcodes/core-axios": "~3.0.0",
+    "@ideal-postcodes/jsutil": "~4.4.0",
     "@xstate/fsm": "~1.6.0",
@@ -104,0 +104,0 @@ "lodash": "~4.17.20"

No alert changes

Improved metrics

Total package byte prevSize

171534

increased by0.74%

Lines of code

4586

increased by0.61%

Dependency changes

• + Added@ideal-postcodes/jsutil@4.4.2(transitive)

• - Removed@ideal-postcodes/jsutil@4.3.12(transitive)

• Updated@ideal-postcodes/jsutil@~4.4.0