I was wondering if it would be useful to do a pull request implementing a version of the geocode call accepting an AbortSignal?

We use it to cancel requests that have not completed yet, for example when the user does a new search before the previous result is available. This improves performance and stops useless requests from being sent and then ignored.

With the new version passing the parameters (ie, not controlling a mandatory API key parameter) the behaviour is to read the environment variable. in a browser process.env is not defined and raise an error

The d.ts file does not contain this attribute

Hi! I am very grateful for this package as it has made it very easy to add the opencage API to my project however, I wanted to use the 'proximity' option that opencage suggests to bias my search results but I cannot see how I would do that with this package. Please let me know!

Thank you:)

Hi @tsamaya
Thank you for this javascript library.
Can you explain somewhere how proxyUrl is working? You give some examples of the API using this but I don't understand what the proxy should send. If it's the API key, then what's the use? You can steal the key by running the proxy url, no?

Please add support for languages other than English. Thanks.

The goal would be to add an HTTP header, "User-Agent", and specify the package version.

Ref info here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent

httpbin and jsonplaceholde tend to be buggy then the CI is failing.

run a local server to test the fetch wrapper seems to be the way to go in order to be agnostic from any services

running the integration tests can also be demonstration of the fetch wrapper

when using q to add lat and lng values, the api return empty because encodeURIComponent encode the plus sign +, so it cannot be used with lat and lng.

the response I got is the following:

{
    "documentation": "https://opencagedata.com/api",
    "licenses": [
        {
            "name": "see attribution guide",
            "url": "https://opencagedata.com/credits"
        }
    ],
    "rate": {
        "limit": 2500,
        "remaining": 2494,
        "reset": 1600214400
    },
    "results": [],
    "status": {
        "code": 200,
        "message": "OK"
    },
    "stay_informed": {
        "blog": "https://blog.opencagedata.com",
        "twitter": "https://twitter.com/OpenCage"
    },
    "thanks": "For using an OpenCage API",
    "timestamp": {
        "created_http": "Tue, 15 Sep 2020 23:39:35 GMT",
        "created_unix": 1600213175
    },
    "total_results": 0
}

sending request without encode the plus sign works as expected.

• Other examples as a subtitle

• TypeScript

• Links on example page

I recently created a project and used OpenCage Geocoder with a library called node-geocoder but it was using a few deprecated dependencies and I decided to use opencage-api-client instead.
opencage-api-client is pretty straightforward but it doesn't support TypeScript. In order to keep using it I had to create the type definitions.

https://github.com/calmonr/easycarros/blob/master/typings/opencage-api-client.d.ts#L2-L4

Unfortunately I don't have much time now to create a PR on DefinitelyTyped so we can have something like @types/opencage-api-client but you can do that if you want to support TypeScript by default.

I hope it helps.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency eslint-plugin-jest to v28.5.0
• chore(deps): update dependency eslint to v9

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

• Avoid calling expect conditionally
• Tests should use Jest‘s exception helpers

to remove remove code smells (https://codeclimate.com/github/tsamaya/opencage-api-client/issues)

• Function geocode has 37 lines of code (exceeds 25 allowed).
• Function geocode has a Cognitive Complexity of 11 (exceeds 5 allowed)

implement new unit tests with API keys for testing:

• 6d0e711d72d74daeb2b0bfd2a5cdfdba which will always generate a 200 - OK response.
  Note the response will be as if the q parameter of the request had been 51.952659,7.632473 regardless of what was actually specified.
• 4372eff77b8343cebfc843eb4da4ddc4 which will always generate a 402 - quota exceeded response.
• 2e10e5e828262eb243ec0b54681d699a which will always generate a 403 - suspended response.
• 6c79ee8e1ca44ad58ad1fc493ba9542f which will always generate a 403 - IP address rejected response.
• d6d0f0065f4348a4bdfe4587ba02714b which will always generate a 429 - requesting too quickly response.

Check all informations at https://github.com/OpenCageData/opencagedata-misc-docs/blob/master/library-guidelines.md

unit tests on fetch wrapper make requests to google/httpbin. Can we improve the unit tests to be isolated and avoid using an internet connection?

When using this library in an application created with create-react-app, it is not possible to build a prod version of the application, the dev server is fine.

$ create-react-app --version
1.5.2

and this whatever version used :
browser version: import opencage from 'opencage-api-client/dist/opencage-api.min'; or node version : import opencage from 'opencage-api-client';`

• browser version fails with

$ react-scripts build
Creating an optimized production build...
Failed to compile.

Failed to minify the code from this file:

 	./node_modules/opencage-api-client/dist/opencage-api.min.js:1:1324

Read more here: http://bit.ly/2tRViJ9

error Command failed with exit code 1.

• node version fails with:

$ react-scripts build
Creating an optimized production build...
Failed to compile.

Failed to minify the code from this file:

 	./node_modules/opencage-api-client/src/helpers.js:7

Read more here: http://bit.ly/2tRViJ9

error Command failed with exit code 1.

Add a readme file explaining examples, linking to other repo for instance for typesript

Based on library 0.8:

import { geocode, GeocodeRequest, GeocodeOption } from 'opencage-api-client';

export const doGeocode = async () => {
  const input: GeocodeRequest = {
    q: '51.952659,7.632473',
    key: '6d0e711d72d74daeb2b0bfd2a5cdfdba', // https://opencagedata.com/api#testingkeys
    no_annotations: GeocodeOption.Off,
  };
  const result = await geocode(input);
  console.log(result);
  return result;
};

raises TypeError: Cannot read property 'Off' of undefined

while this code is working

import { geocode, GeocodeRequest } from 'opencage-api-client';

export const doGeocode = async () => {
  const input: GeocodeRequest = {
    q: '51.952659,7.632473',
    key: '6d0e711d72d74daeb2b0bfd2a5cdfdba', // https://opencagedata.com/api#testingkeys
    no_annotations: 1,
  };
  const result = await geocode(input);
  console.log(result);
  return result;
};

As now node since version 18 has a fetch() function built-in and all browsers have this function, I think it is time to get rid of dependencies. That would lighten the package and also narrow down security risks raised by Meterian's report with the old version of node-fetch used by cross-fetch