@placekit/autocomplete-js - npm Package Compare versions

Comparing version 1.0.0-alpha.10 to 1.0.0

dist/placekit-autocomplete.d.ts

@@ -1,2 +0,2 @@
-/*! @placekit/autocomplete-js v1.0.0-alpha.10 | © placekit.io | MIT license | https://github.com/placekit/autocomplete-js#readme */
+/*! @placekit/autocomplete-js v1.0.0 | © placekit.io | MIT license | https://github.com/placekit/autocomplete-js#readme */
 import type { PKOptions, PKResult } from '@placekit/client-js';
@@ -3,0 +3,0 @@

package.json

 {
   "name": "@placekit/autocomplete-js",
-  "version": "1.0.0-alpha.10",
+  "version": "1.0.0",
   "author": "PlaceKit <[e-mail]>",
@@ -45,4 +45,4 @@ "description": "PlaceKit Autocomplete JavaScript library",
     "@rollup/plugin-replace": "^5.0.2",
-    "autoprefixer": "^10.4.13",
-    "eslint": "^8.33.0",
+    "autoprefixer": "^10.4.14",
+    "eslint": "^8.36.0",
     "eslint-config-google": "^0.14.0",
@@ -52,4 +52,4 @@ "npm-watch": "^0.11.0",
     "postcss-banner": "^4.0.1",
-    "rimraf": "^4.1.2",
-    "rollup": "^3.15.0",
+    "rimraf": "^4.4.0",
+    "rollup": "^3.20.0",
     "rollup-plugin-cleanup": "^3.2.1",
@@ -60,5 +60,5 @@ "rollup-plugin-copy": "^3.4.0",
   "dependencies": {
-    "@placekit/client-js": "^1.0.0-alpha.3",
+    "@placekit/client-js": "^1.0.0",
     "@popperjs/core": "^2.11.6"
   }
 }

README.md

@@ -30,3 +30,3 @@ <h1 align="center">
 
-For React implementations, check our [PlaceKit Autocomplete React](https://github.com/placekit/autocomplete-react) library.
+For React implementations, check our [PlaceKit Autocomplete React](https://github.com/placekit/autocomplete-react) library. And for Vue implementations, check our [Vue.js example](./examples/autocomplete-js-vue/).
 
@@ -48,3 +48,3 @@ ## ✨ Features
 ```html
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@1.0.0-alpha.10/dist/placekit-autocomplete.min.css" />
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@1.0.0/dist/placekit-autocomplete.min.css" />
 <script src="https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js"></script>
@@ -70,3 +70,3 @@ ```
 <script type="module">
-  import placekit from 'https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@1.0.0-alpha.10/dist/placekit-autocomplete.esm.js';
+  import placekit from 'https://cdn.jsdelivr.net/npm/@placekit/autocomplete-js@1.0.0/dist/placekit-autocomplete.esm.js';
   const pka = placekitAutocomplete(/* ... */);
@@ -168,8 +168,10 @@ // ...
 | `maxResults` | JS client | `integer` | `5` | Number of results per page. |
-| `language` | JS client | `string?` | `undefined` | Language of the results, two-letter ISO language code. |
+| `language` | `string?` | `undefined` | Preferred language for the results<sup>[(1)](#ft1)</sup>, [two-letter ISO](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Supported languages are `en` and `fr`. Defaults to the country's language. |
 | `types` | JS client | `string[]?` | `undefined` | Type of results to show. Array of accepted values: `street`, `city`, `country`, `airport`, `bus`, `train`, `townhall`, `tourism`. Prepend `-` to omit a type like `['-bus']`. Unset to return all. |
-| [`countries`](#%EF%B8%8F-countries-option-is-required) | `string[]?` | `undefined` | Countries to search in, or fallback to if `countryByIP` is `true`. Array of [two-letter ISO](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes in the [supported list of countries](#supported-countries). |
+| [`countries`](#%EF%B8%8F-countries-option-is-required) | `string[]?` | `undefined` | Countries to search in, or fallback to if `countryByIP` is `true`. Array of [two-letter ISO](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes<sup>[(1)](#ft1)</sup>. |
 | [`countryByIP`](#countryByIP-option) | `boolean?` | `undefined` | Use IP to find user's country (turned off). |
 | `coordinates` | JS client | `string?` | `undefined` | Coordinates to search around. Automatically set when calling [`pka.requestGeolocation()`](#pkarequestGeolocation). |
 
+<a id="ft1"><b>[1]</b></a>: See [Scope and Limitations](https://placekit.io/terms/scope) for more details.
+
 #### ⚠️ `countries` option is required
@@ -182,8 +184,4 @@
 
-If `countries` is missing or invalid, you'll get a `422` error.
+If `countries` is missing or invalid, you'll get a `422` error, excepted when`types` option is set to `['country']` only.
 
-#### Supported countries
-
-Supported countries are `be`, `ca`, `ch`, `de`, `es`, `fr`, `gb`, `it`, `nl`, `pt`, `us`.
-
 #### `countryByIP` option
@@ -190,0 +188,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

258009

increased by0.06%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Number of lines in readme file

412

decreased by-0.48%

Dependency changes

• Updated@placekit/client-js@^1.0.0