@placekit/client-js - npm Package Compare versions

Comparing version 1.0.0-alpha.3 to 1.0.0

dist/placekit.cjs.js

@@ -1,2 +0,2 @@
-/*! @placekit/client-js v1.0.0-alpha.3 | © placekit.io | MIT license | https://github.com/placekit/client-js#readme */
+/*! @placekit/client-js v1.0.0 | © placekit.io | MIT license | https://github.com/placekit/client-js#readme */
 'use strict';
@@ -3,0 +3,0 @@

dist/placekit.d.ts

@@ -1,2 +0,2 @@
-/*! @placekit/client-js v1.0.0-alpha.3 | © placekit.io | MIT license | https://github.com/placekit/client-js#readme */
+/*! @placekit/client-js v1.0.0 | © placekit.io | MIT license | https://github.com/placekit/client-js#readme */
 export default PlaceKit;
@@ -34,4 +34,2 @@ export as namespace PlaceKit;
 
-type PKCountry = "be" | "ca" | "ch" | "de" | "es" | "fr" | "gb" | "it" | "nl" | "pt" | "us";
-
 export type PKOptions = Partial<{
@@ -42,3 +40,3 @@ timeout?: number;
   types?: PKType[];
-  countries?: PKCountry[];
+  countries?: string[];
   countryByIP?: boolean;
@@ -45,0 +43,0 @@ forwardIP?: string;

dist/placekit.umd.js

@@ -1,2 +0,2 @@
-/*! @placekit/client-js v1.0.0-alpha.3 | © placekit.io | MIT license | https://github.com/placekit/client-js#readme */
+/*! @placekit/client-js v1.0.0 | © placekit.io | MIT license | https://github.com/placekit/client-js#readme */
 (function (global, factory) {
@@ -3,0 +3,0 @@ typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :

package.json

 {
   "name": "@placekit/client-js",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0",
   "author": "PlaceKit <[e-mail]>",
@@ -40,10 +40,10 @@ "description": "PlaceKit JavaScript client",
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^23.0.4",
-    "eslint": "^8.29.0",
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "eslint": "^8.36.0",
     "eslint-config-google": "^0.14.0",
-    "jest": "^29.3.1",
-    "jest-environment-jsdom": "^29.3.1",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
     "jest-fetch-mock": "^3.0.3",
-    "rimraf": "^3.0.2",
-    "rollup": "^3.7.4",
+    "rimraf": "^4.4.0",
+    "rollup": "^3.20.0",
     "rollup-plugin-cleanup": "^3.2.1",
@@ -50,0 +50,0 @@ "rollup-plugin-copy": "^3.4.0"

README.md

@@ -73,3 +73,3 @@ <h1 align="center">
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@placekit/client-js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@placekit/client-js@1.0.0/dist/placekit.umd.js"></script>
 ```
@@ -97,3 +97,3 @@
 <script type="module">
-  import placekit from 'https://cdn.jsdelivr.net/npm/@placekit/client-js@1.0.0-alpha.2/dist/placekit.esm.js';
+  import placekit from 'https://cdn.jsdelivr.net/npm/@placekit/client-js@1.0.0/dist/placekit.esm.mjs';
   const pk = placekit(/* ... */);
@@ -202,5 +202,5 @@ // ...
 | `maxResults` | `integer?` | `5` | Number of results per page. |
-| `language` | `string?` | `undefined` | Language of the results, [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 if available. |
+| `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` | `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). |
@@ -210,2 +210,4 @@ | `forwardIP` | `string?` | `undefined` | Set `x-forwarded-for` header to forward the provided IP for back-end usages (otherwise it'll use the server IP). |
 
+<a id="ft1"><b>[1]</b></a>: See [Scope and Limitations](https://placekit.io/terms/scope) for more details.
+
 #### ⚠️ `countries` option is required
@@ -218,8 +220,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
@@ -226,0 +224,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

Number of low quality alerts

0

decreased by-100%

Number of medium supply chain risk alerts

3

decreased by-25%

Worsened metrics

Total package byte prevSize

25847

decreased by-12.44%

Number of package files

7

decreased by-12.5%

Lines of code

422

decreased by-20.08%

Number of lines in readme file

270

decreased by-0.74%

No dependency changes