prevent browser issue without an input containing the api key

.circleci/config.yml

@@ -1,12 +1,13 @@
 version: 2.1
 
 orbs:
-  node: circleci/[email protected]
+  node: circleci/[email protected]
+  codecov: codecov/[email protected]
 
 jobs:
   build:
     docker:
-      - image: cimg/node:20.2.0
+      - image: cimg/node:21.7.2
 
     steps:
       - checkout
@@ -25,5 +26,8 @@ jobs:
           name: Run tests
           command: |
             ./cc-test-reporter before-build
-            npm run coverage
+            npm run test
             ./cc-test-reporter after-build --coverage-input-type lcov --exit-code $?
+
+      # Upload coverage reports to Codecov
+      - codecov/upload

.eslintrc.js

@@ -1,4 +1,11 @@
 module.exports = {
+  env: {
+    node: true,
+    browser: true,
+  },
+  parserOptions: {
+    ecmaVersion: 'latest',
+  },
   extends: [
     'airbnb-base',
     'plugin:prettier/recommended',

.github/workflows/meterian.yml

@@ -0,0 +1,23 @@
+# .github/workflows/meterian.yml
+
+name: Meterian Scanner workflow
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  meterian_scan:
+    name: Meterian client scan
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Meterian Scanner
+        uses: MeterianHQ/[email protected]
+        env:
+          METERIAN_API_TOKEN: ${{ secrets.METERIAN_API_TOKEN }}

.hound.yml

@@ -1,3 +1,4 @@
 eslint:
-  version: 8.33.0
+  version: 8.44.0
+  esversion: 6
   ignore_file: .eslintignore

CHANGELOG.md

@@ -6,6 +6,20 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [1.0.4] - 2024-02-03
+
+### Changed
+
+- upgrade dependencies
+
+## [1.0.3] - 2023-11-10
+
+### Changed
+
+- adds input parameter `address_only` into the typescript definition
+
+## [1.0.2] - 2023-07-16
+
 ### Changed
 
 - upgrade dependencies
@@ -94,7 +108,11 @@ Open Cage website URL has changed
 
 First release
 
-[unreleased]: https://github.com/tsamaya/opencage-api-client/compare/v1.0.0...HEAD
+[unreleased]: https://github.com/tsamaya/opencage-api-client/compare/v1.0.4...HEAD
+[1.0.4]: https://github.com/tsamaya/opencage-api-client/compare/v0.10.3...v1.0.4
+[1.0.3]: https://github.com/tsamaya/opencage-api-client/compare/v0.10.2...v1.0.3
+[1.0.2]: https://github.com/tsamaya/opencage-api-client/compare/v0.10.2...v1.0.2
+[1.0.1]: https://github.com/tsamaya/opencage-api-client/compare/v0.10.0...v1.0.1
 [1.0.0]: https://github.com/tsamaya/opencage-api-client/compare/v0.10.0...v1.0.0
 [0.10.0]: https://github.com/tsamaya/opencage-api-client/compare/v0.9.0...v0.10.0
 [0.9.0]: https://github.com/tsamaya/opencage-api-client/compare/v0.8.1...v0.9.0

README.md

@@ -3,7 +3,7 @@
 [![Version](https://img.shields.io/npm/v/opencage-api-client.svg)](https://www.npmjs.com/package/opencage-api-client)
 ![Downloads](https://img.shields.io/npm/dw/opencage-api-client)
 [![GitHub license](https://img.shields.io/github/license/tsamaya/opencage-api-client)](https://github.com/tsamaya/opencage-api-client/blob/master/LICENSE.md)
-![Maintained](https://img.shields.io/maintenance/yes/2023.svg)
+![Maintained](https://img.shields.io/maintenance/yes/2024.svg)
 
 This repository is an [OpenCage Geocoding API](https://opencagedata.com/api) client for JavaScript and node.
 
@@ -16,11 +16,11 @@ This repository is an [OpenCage Geocoding API](https://opencagedata.com/api) cli
 
 ### Security
 
-| Source                               | Scores                                                                                                                                                                                                                                                                                                                  |
-| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [Meterian](https://www.meterian.io/) | [![stability status](https://www.meterian.io/badge/gh/tsamaya/opencage-api-client/stability)](https://www.meterian.io/report/gh/tsamaya/opencage-api-client) [![security status](https://www.meterian.io/badge/gh/tsamaya/opencage-api-client/security)](https://www.meterian.io/report/gh/tsamaya/opencage-api-client) |
-| [FOSSA](https://fossa.com/)          | [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftsamaya%2Fopencage-api-client.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftsamaya%2Fopencage-api-client?ref=badge_shield)                                                                                                |
-| [Snyk](https://snyk.io/)             | ![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/tsamaya/opencage-api-client?label=GH%20Vulnerabilities) ![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/opencage-api-client?label=npm%20Vulnerabilities)                             |
+| Source                               | Scores                                                                                                                                                                                                                                                                                                                                                  |
+| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Meterian](https://www.meterian.io/) | [![security status](https://www.meterian.com/badge/gh/tsamaya/opencage-api-client/security?branch=master)](https://www.meterian.com/report/gh/tsamaya/opencage-api-client) [![stability status](https://www.meterian.com/badge/gh/tsamaya/opencage-api-client/stability?branch=master)](https://www.meterian.com/report/gh/tsamaya/opencage-api-client) |
+| [FOSSA](https://fossa.com/)          | [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftsamaya%2Fopencage-api-client.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftsamaya%2Fopencage-api-client?ref=badge_shield)                                                                                                                                |
+| [Snyk](https://snyk.io/)             | ![Known Vulnerabilities](https://snyk.io/test/github/tsamaya/opencage-api-client/badge.svg)                                                                                                                                                                                                                                                             |
 
 ## Tutorial
 
@@ -152,8 +152,7 @@ Check the examples using the Test API key from OpenCage [error handling examples
 1.  Fork or clone this repository
 1.  `$ cd` into the `repository` folder
 1.  `$ npm install` to install all the required dependencies from [npm](https://www.npmjs.com/)
-1.  lint and test using `$ npm test`
-1.  coverage `$ npm run coverage`
+1.  lint and test coverage using `$ npm test`
 1.  Build : `$ npm run build`
 
 ## 🛣 Revision History

docs/index.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset='utf-8'>
-  <title>opencage-api-client 1.0.1 | Documentation</title>
+  <title>opencage-api-client 1.0.3 | Documentation</title>
   <meta name='description' content='An OpenCageData Geocoder API client library for node and browsers (UMD)'>
   <meta name='viewport' content='width=device-width,initial-scale=1'>
   <link href='assets/bass.css' rel='stylesheet'>
@@ -15,7 +15,7 @@
       <div id='split-left' class='overflow-auto fs0 height-viewport-100'>
         <div class='py1 px2'>
           <h3 class='mb0 no-anchor'>opencage-api-client</h3>
-          <div class='mb1'><code>1.0.1</code></div>
+          <div class='mb1'><code>1.0.3</code></div>
           <input
             placeholder='Filter'
             id='filter-input'

examples/browser.html

@@ -75,7 +75,7 @@ <h2 class="title">Result</h2>
     }
 
     $('.button.is-text').click(function () {
-      console.log('submit button clicked');
+      console.log('cancel button clicked');
       clear();
       raz();
     });
@@ -84,6 +84,7 @@ <h2 class="title">Result</h2>
       console.log('submit button clicked');
       clear();
       if (!check()) {
+        console.log('invalid input');
         return;
       }
 

index.d.ts

@@ -97,6 +97,14 @@ declare module 'opencage-api-client' {
      * When set to 1 the behaviour of the geocoder is changed to attempt to match the nearest road (as opposed to address). If possible we also fill additional information in the roadinfo annotation. Please see details API Documentation.
      */
     roadinfo?: number;
+    /**
+     * When set to 1 we include only the address (exluding POI names) in the formatted string we return.
+     *
+     * Example usage: address_only=1
+     *
+     * As an example, by default a reverse geocoding request for the coordinates 50.976004, 11.336753 returns a formatted value of Goethes Gartenhaus, Corona-Schröter-Weg 1, 99425 Weimar, Germany, but if address_only=1 is specified the value would be simply Corona-Schröter-Weg 1, 99425 Weimar, Germany. This can be particularly useful when there are many stores/restaurants/whatever at a single location (for example a multi-story building).
+     */
+    address_only?: number;
   }
 
   export function geocode(input: GeocodeRequest): Promise<any>;