Dependabot/npm and yarn/jest puppeteer 10.1.4

.eslintrc.json

@@ -1,24 +1,21 @@
 {
     "env": {
-        "commonjs": true,
-        "es6": true,
-        "node": true,
-        "mocha": true
-    },
-    "extends": [
-        "standard"
-    ],
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
+      "commonjs": true,
+      "es2021": true,
+      "node": true,
+      "jest": true
     },
+    "extends": ["eslint:recommended", "google"],
     "parserOptions": {
-        "ecmaVersion": 2018
+      "ecmaVersion": 12
     },
     "rules": {
-        "quote-props": [
-            "error",
-            "consistent-as-needed"
-        ]
+      "max-len": [
+        "error", 120
+      ],
+      "object-curly-spacing": [
+        "error", "always"
+      ],
+      "space-infix-ops": "error"
     }
-}
+  }

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: monthly

.github/workflows/ci.yml

@@ -7,17 +7,14 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  ci:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [10.x, 12.x]
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
       with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm i
+        node-version: '20'
+        cache: 'npm'
+    - run: npm ci
     - run: npm run lint
     - run: npm test

.github/workflows/coverage.yml

@@ -0,0 +1,23 @@
+name: Test Coveralls
+
+on: ["push", "pull_request"]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        cache: 'npm'
+
+    - name: Coverage
+      run: |
+        npm ci
+        npm run coverage
+
+    - name: Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/npmpublish.yml

@@ -0,0 +1,19 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'npm'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -1,5 +1,7 @@
-# Investing.com unofficial APIs
-![Node.js CI](https://github.com/DavideViolante/investing-com-api/workflows/Node.js%20CI/badge.svg) [![Maintainability](https://api.codeclimate.com/v1/badges/ce48adbd97ff85557918/maintainability)](https://codeclimate.com/github/DavideViolante/investing-com-api/maintainability) [![Donate](https://img.shields.io/badge/paypal-donate-179BD7.svg)](https://www.paypal.me/dviolante)
+# Investing.com Unofficial APIs
+[![](https://github.com/davideviolante/investing-com-api/workflows/Node.js%20CI/badge.svg)](https://github.com/DavideViolante/investing-com-api/actions?query=workflow%3A"Node.js+CI") [![Coverage Status](https://coveralls.io/repos/github/DavideViolante/investing-com-api/badge.svg?branch=master)](https://coveralls.io/github/DavideViolante/investing-com-api?branch=master) [![Maintainability](https://api.codeclimate.com/v1/badges/ce48adbd97ff85557918/maintainability)](https://codeclimate.com/github/DavideViolante/investing-com-api/maintainability) ![npm](https://img.shields.io/npm/dm/investing-com-api)  [![Donate](https://img.shields.io/badge/paypal-donate-179BD7.svg)](https://www.paypal.me/dviolante)
+
+[![NPM](https://nodei.co/npm/investing-com-api.png)](https://nodei.co/npm/investing-com-api/)
 
 Unofficial APIs for Investing.com website.
 
@@ -8,22 +10,61 @@ Unofficial APIs for Investing.com website.
 
 ### Example
 ```js
-const { investing } = require('investing-com-api')
+const { investing } = require('investing-com-api');
 
-async function main () {
-  const response = await investing('currencies/eur-usd')
-  // response = [ { date: Timestamp, value: Number }, {...}, ... ]
+async function main() {
+  try {
+    const response1 = await investing('currencies/eur-usd'); // Providing a valid mapping.js key
+    const response2 = await investing('currencies/eur-usd', 'P1M', 'P1D'); // With optional params
+    const response3 = await investing('1'); // Providing the pairId directly, even if not present in mapping.js
+  } catch (err) {
+    console.error(err);
+  }
 }
 ```
 
-### Available inputs
-- [mapping.js](https://github.com/DavideViolante/investing-com-api/blob/master/mapping.js)
+### Response
+```js
+[
+  {
+    date: 1659398400000,
+    value: 1.0157,
+    price_open: 1.0264,
+    price_high: 1.0294,
+    price_low: 1.0155,
+    price_close: 1.0157,
+    volume: 10
+  },
+  {
+    date: 1659484800000,
+    value: 1.0136,
+    price_open: 1.0158,
+    price_high: 1.0209,
+    price_low: 1.0126,
+    price_close: 1.0136,
+    volume: 15
+  },
+  ...
+]
+```
+
+
+### Inputs
+Only input is required, other params are optional.
+- **input** _String_: input string, see [mapping.js](https://github.com/DavideViolante/investing-com-api/blob/master/mapping.js) keys, or provide a valid investing.com pairId. (Required)
+- **period** _String_: Period of time, window size. Default P1M (1 month). Valid values: P1D, P1W, P1M, P3M, P6M, P1Y, P5Y, MAX.
+- **interval** _Number_: Interval between results. Default P1D (1 day). Valid values: PT1M, PT5M, PT15M, PT30M, PT1H, PT5H, P1D, P1W, P1M.
+- **pointscount** _Number_: number of total results. Valid values seems to be 60, 70 or 120.
+- **pptrLaunchOptions** _Any_: Puppeteer launch options, see [official website](https://pptr.dev/api/puppeteer.launchoptions).
 
 ### Run tests
-- `npm test`
+`npm test`
 
 ### Run lint
-- `npm run lint`
+`npm run lint`
+
+### Contribute
+PRs are welcome to add more elements to the [mapping.js](https://github.com/DavideViolante/investing-com-api/blob/master/mapping.js) file.
 
 ### Author
 - [Davide Violante](https://github.com/DavideViolante/)

functions.js

@@ -1,10 +1,37 @@
-function mapResponse (array) {
-  return array.map(item => ({
-    date: item[0],
-    value: item[1]
-  }))
+/**
+ * Map the Investing array response
+ * @param {Array} array Array of data returned from Investing website
+ * @return {Array} An array of objects with date and value properties
+ */
+const mapResponse = (array = []) => array.map((item) => ({
+  date: item[0],
+  price_open: item[1],
+  price_high: item[2],
+  price_low: item[3],
+  price_close: item[4],
+  value: item[4],
+  volume: item[5],
+}));
+
+/**
+ * Get JSON response from Investing APIs
+ * @param {*} page puppeteer page
+ * @return {Object} JSON response from Investing, with data property containing an array of arrays
+ */
+async function getJsonContent(page) {
+  // If there is this element, the page cannot be loaded due to CloudFlare protection
+  // Element: <body class="no-js">
+  // eslint-disable-next-line no-undef
+  const bodyClass = await page.evaluate(() => document.querySelector('body').getAttribute('class'));
+  if (bodyClass === 'no-js') {
+    throw new Error(`Error: couldn't bypass CloudFlare protection`);
+  }
+  // eslint-disable-next-line no-undef
+  const content = await page.evaluate(() => document.querySelector('body').textContent);
+  return JSON.parse(content);
 }
 
 module.exports = {
-  mapResponse
-}
+  mapResponse,
+  getJsonContent,
+};

index.d.ts

@@ -0,0 +1,16 @@
+declare module "investing-com-api" {
+  export function investing(
+    input: string,
+    period?: 'P1D' | 'P1W' | 'P1M' | 'P3M' | 'P6M' | 'P1Y' | 'P5Y' | 'MAX',
+    interval?: 'PT1M' | 'PT5M' | 'PT15M' | 'PT30M' | 'PT1H' | 'PT5H' | 'P1D' | 'P1W' | 'P1M',
+    pointscount?: 60 | 70 | 120,
+    pptrLaunchOptions?: any,
+  ): Promise<{
+    date: number,
+    value: number,
+    price_open: number,
+    price_high: number,
+    price_low: number,
+    price_close: number,
+  }[]>;
+}

index.js

@@ -1,48 +1,86 @@
-const axios = require('axios')
-const { mapping } = require('./mapping')
-const { mapResponse } = require('./functions')
+const puppeteer = require('puppeteer');
+const { mapping } = require('./mapping');
+const { getJsonContent, mapResponse } = require('./functions');
 
-function callInvesting (pairId) {
-  return axios({
-    method: 'GET',
-    url: 'https://www.investing.com/common/modules/js_instrument_chart/api/data.php',
-    params: {
-      pair_id: pairId,
-      pair_interval: '86400', // 1 day
-      chart_type: 'area', // 'area', 'candlestick'
-      candle_count: '90', // days
-      volume_series: 'yes',
-      events: 'yes',
-      period: '1-year'
-    },
-    headers: {
-      'Referer': 'https://www.investing.com/',
-      'X-Requested-With': 'XMLHttpRequest'
-    }
-  })
+const validPeriod = ['P1D', 'P1W', 'P1M', 'P3M', 'P6M', 'P1Y', 'P5Y', 'MAX'];
+const validInterval = ['PT1M', 'PT5M', 'PT15M', 'PT30M', 'PT1H', 'PT5H', 'P1D', 'P1W', 'P1M'];
+const validPointscount = [60, 70, 120];
+
+/**
+ * Check if params are valid
+ * @param {String} input input
+ * @param {String} period period
+ * @param {String} interval interval
+ * @param {Number} pointscount pointscount
+ */
+function checkParams(input, period, interval, pointscount) {
+  if (!input) {
+    throw Error('Parameter input is required');
+  }
+  if (!validPeriod.includes(period)) {
+    throw Error('Invalid period parameter. Valid values are: P1D, P1W, P1M, P3M, P6M, P1Y, P5Y, MAX');
+  }
+  if (!validInterval.includes(interval)) {
+    throw Error('Invalid interval parameter. Valid values are: PT1M, PT5M, PT15M, PT30M, PT1H, PT5H, P1D, P1W, P1M');
+  }
+  if (!validPointscount.includes(pointscount)) {
+    throw Error('Invalid pointscount parameter. Valid values are: 60, 70, 120');
+  }
 }
 
-async function investing (input) {
+/**
+ * Call Investing website
+ * @param {string} pairId Input string, see mapping.js keys, or provide a valid investing.com pairId
+ * @param {string} period Period of time, window size.
+ *                        Valid values: P1D, P1W, P1M, P3M, P6M, P1Y, P5Y, MAX
+ * @param {string} interval Interval between results.
+ *                          Valid values: PT1M, PT5M, PT15M, PT30M, PT1H, PT5H, P1D, P1W, P1M
+ * @param {number} pointscount Number of results returned. Valid values: 60, 70, 120
+ * @param {*} pptrLaunchOptions Puppeteer launch options, see https://pptr.dev/api/puppeteer.launchoptions
+ * @return {Promise<Array>} An array of arrays with date (timestamp) and values (number) properties
+ */
+async function callInvesting(pairId, period, interval, pointscount, pptrLaunchOptions) {
+  const browser = await puppeteer.launch(pptrLaunchOptions);
+  const page = await browser.newPage();
+  // eslint-disable-next-line max-len
+  await page.setUserAgent('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36');
+  // eslint-disable-next-line max-len
+  await page.goto(`https://api.investing.com/api/financialdata/${pairId}/historical/chart?period=${period}&interval=${interval}&pointscount=${pointscount}`);
+  const jsonContent = await getJsonContent(page);
+  await browser.close();
+  return jsonContent.data;
+}
+
+/**
+ * Investing
+ * @param {string} input Input string, see mapping.js keys, or provide a valid investing.com pairId
+ * @param {string} [period] Period of time, window size. Default P1M (1 month)
+ *                        Valid values: P1D, P1W, P1M, P3M, P6M, P1Y, P5Y, MAX
+ * @param {string} [interval] Interval between results. Default P1D (1 day)
+ *                          Valid values: PT1M, PT5M, PT15M, PT30M, PT1H, PT5H, P1D, P1W, P1M
+ * @param {number} [pointscount] Number of results returned, but depends on period and interval too.
+ *                             Valid values: 60, 70, 120
+ * @param {*} [pptrLaunchOptions] Puppeteer launch options, see https://pptr.dev/api/puppeteer.launchoptions
+ * @return {Promise<Array>} An array of objects with date (timestamp), value (number) and other (number) properties
+ */
+async function investing(input, period = 'P1M', interval = 'P1D', pointscount = 120, pptrLaunchOptions) {
   try {
-    if (!input) {
-      throw Error('Parameter input is required')
-    }
-    const endpoint = mapping[input]
-    if (!endpoint) {
-      throw Error(`No mapping found for ${input}, check mapping.js`)
+    checkParams(input, period, interval, pointscount);
+    const pairId = mapping[input]?.pairId || input;
+    const resInvesting = await callInvesting(pairId, period, interval, pointscount, pptrLaunchOptions);
+    const results = mapResponse(resInvesting);
+    if (!results.length) {
+      throw Error('Wrong input or pairId');
     }
-    const response = await callInvesting(endpoint.pairId)
-    if (!response.data.candles) {
-      throw Error('No response.data.candles found')
-    }
-    const results = mapResponse(response.data.candles)
-    // console.log(results)
-    return results
+    return results;
   } catch (err) {
-    console.log(err.message)
+    console.error(err.message);
+    if (err.response?.data?.['@errors']?.[0]) {
+      console.error(err.response.data['@errors'][0]);
+    }
   }
 }
 
-// investing('equities/netflix,-inc.')
+// investing('1').then(console.log);
 
-exports.investing = investing
+exports.investing = investing;