openfoodfacts / openfoodfacts-nodejs Goto Github PK

Migrating to TypeScript, I had to delete tests as they were not working anymore. We should reintroduce them.

Story

Part of

• (Insert Story issue number here)

Create method getProductsByLanguages(languages).
Where languages is an array.

It must work for the following endpoints:

• https://en.wiki.openfoodfacts.org/API#List_of_products_with_given_language_on_packaging
• https://en.wiki.openfoodfacts.org/API#List_of_products_in_Italian_and_Chinese
• https://en.wiki.openfoodfacts.org/API#List_of_multilingual_products

What

• Require a custom user agent to use the SDK
• Using the SDK and the API in general will remain as of today: free and accessible for everyone.
  IN the same way, we don't want to implement an API key mechanism and all that kind of stuff.
• However, due to misuse of the API through various SDKs, we will now force all language clients to have a valid User Agent so that we can reach out in case of problems.
• For now, We will only require an app name for the user agent.

Having this module on NPM would be great 📦🙂

The function for getting products with barcode is failing

Hello, i just checked your lovely project and i discovered you have some sections missing out like FAQ, about us, contact us and privacy policy. If you dont mind i will like to write that for you.
My email: [email protected]

URL is modified on country call and then can't be reset properly, find a solution to change that.

Idea of solution: OFF should probably be immutable.

Create method getProductsByLanguageCount(count).
Where count is a number.

It must work for the following endpoints:

• https://en.wiki.openfoodfacts.org/API#List_of_products_by_language_count

What

The npm package corresponding to this repo is not up to date to the latest development.
See here for more info.

Steps to reproduce the behavior:

1. Run pnpm add openfoodfacts-nodejs in your terminal (or npm i ...
2. Go to the node_modules folder
3. Search for the openfoodfacts-nodejs package folder
4. Open the README and see the version.
5. The error can occur when consuming the package in TypeScript for example. => it works when using require but no IntelliSense.

Expected behavior

To have the latest code of this repo in the package.

Screenshots

Platform (Desktop, Mobile, Hunger Games)

• OS: Desktop
• Platform: NodeJS, Desktop

Part of

Create method getProductsByBarcodeBeginning(barcodeBeginning)
Where barcodeBeginning is a String. (It must automatically add xxxx[...])

example:

await OFF.getProductsByBarcodeBeginning('3596710')
// should fetch https://world.openfoodfacts.org/code/3596710xxxxxx.json

It must work for the following endpoint:

• https://en.wiki.openfoodfacts.org/API#List_of_barcodes_beginning_with_3596710

Problem: Tests are randomly failing because of POST/PUT/DELETE requests and the running time is really long.

Solution: Check the resolved URL instead of making HTTP requests.

Features

• New APIs: https://github.com/openfoodfacts/api-documentation/issues?q=is%3Aissue+is%3Aopen+label%3A%22new+api+to+document%22
• Existing APIs: https://github.com/openfoodfacts/api-documentation/

Roadmap

• List of new APIs to implement: https://github.com/openfoodfacts/api-documentation/issues

Create method getLanguages().

It must work for the following endpoint:

• https://en.wiki.openfoodfacts.org/API#List_of_languages_present_on_packaging

Create method getBrand(brandName).

It must work for the following endpoint:

• https://en.wiki.openfoodfacts.org/API#Individual_Brand

Create method getLabels()

It must work for the following endpoint:

• https://en.wiki.openfoodfacts.org/API#List_of_labels

The test suite is named 'country' which seems random. I assume something like 'OFF Test' or 'API Test' would be more appropriate.

Create method getProductsByLabel(label).

It must work for the following endpoint:

• https://en.wiki.openfoodfacts.org/API#Individual_label

Tracking issue for:

• https://github.com/openfoodfacts/openfoodfacts-nodejs/security/code-scanning/3