Merge pull request #106 from trustpilot/update-library

Update dependencies and switch to axios

.github/workflows/pushes.yaml

@@ -0,0 +1,50 @@
+name: build-and-release
+
+"on":
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+permissions:
+  contents: write
+  packages: write
+  pull-requests: write
+
+jobs:
+  made-with-tpgha:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Setting up NodeJs
+        id: setup-node-js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+
+      - name: npm ci
+        run: npm ci
+        shell: bash
+
+      - name: npm run lint
+        run: npm run lint
+        shell: bash
+
+      - name: npm run test
+        run: npm run test
+        shell: bash
+
+      - name: npm run build
+        run: npm run build
+        shell: bash
+
+      - name: npm run release
+        run: npx semantic-release
+        shell: bash

.npmignore

@@ -6,6 +6,6 @@ src
 .gitignore
 .nvmrc
 .releaserc
-.travis.yml
+.github
 tsconfig.*
 tslint.json

.nvmrc

@@ -1 +1 @@
-v12.21.0
+v20

.prettierignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+output

.prettierrc.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+  trailingComma: 'all',
+  singleQuote: true,
+  printWidth: 120,
+  tabWidth: 2,
+  endOfLine: 'auto',
+};

.releaserc

@@ -1,8 +1,3 @@
-analyzeCommits:
-  preset: eslint
-generateNotes:
-  preset: eslint
-  path: '@semantic-release/release-notes-generator'
 prepare:
 - "@semantic-release/changelog"
 - "@semantic-release/npm"

README.md

@@ -1,21 +1,17 @@
 # trustpilot
 
-[![Build Status](https://travis-ci.org/trustpilot/node-trustpilot.svg?branch=master)](https://travis-ci.org/trustpilot/node-trustpilot) [![npm](https://img.shields.io/npm/v/trustpilot.svg)](https://www.npmjs.com/package/trustpilot)
-
-This a node API wrapper for accessing the Trustpilot APIs. You can learn all about the Trustpilot API at [https://developers.trustpilot.com/](https://developers.trustpilot.com/).
+This a NodeJS API wrapper for accessing the Trustpilot APIs. You can learn all about the Trustpilot API at [https://developers.trustpilot.com/](https://developers.trustpilot.com/).
 
 ## Installation
 
-This module is built using Typescript and Node.js `v12.21.x`.
-
-If you are not using version 4 of Node, you'll have to transpile the code down to ES5 yourself.
+This module is built using Typescript and NodeJS `v20.x`.
 
 Install using `npm install trustpilot`
 
 ## Usage
 
 As of version 3, the project has been converted to Typescript.
-The trustpilot module is async/await based. It provides [request-promise-native](https://github.com/request/request-promise-native) objects with sane defaults.
+The trustpilot module is async/await based. It provides an [axios instance](https://github.com/axios/axios?tab=readme-ov-file#creating-an-instance) with sane defaults.
 
 ### Basic Usage
 
@@ -33,6 +29,7 @@ async run() {
   // For basic calls authentified by API key, use client.apiRequest
   try {
     const response = await client.apiRequest('/v1/resources/images');
+    console.log(response.data);
   } catch(error) {
     // handle the error
   });
@@ -41,7 +38,7 @@ async run() {
 
 ### Usage with OAuth
 
-For calls authentified by OAuth token, use the `authenticate()` promise, which resolves with a `request-promise-native`
+For calls authentified by OAuth token, use the `authenticate()` promise, which resolves with an `axiosInstance`
 object with everything you need.
 
 ```ts
@@ -56,9 +53,8 @@ async run() {
     }).authenticate();
 
   try {
-    await client(`/v1/private/business-units/${YOUR_BUSINESS_UNIT_ID}/reviews`);
-    // same as
-    await client.get(`/v1/private/business-units/${YOUR_BUSINESS_UNIT_ID}/reviews`);
+    const response = await client.get(`/v1/private/business-units/${YOUR_BUSINESS_UNIT_ID}/reviews`);
+    console.log(response.data);
   } catch(error) {
     // handle the error
   });
@@ -102,3 +98,18 @@ async run() {
   // Use client
 }
 ```
+
+### Migration from v3 to v4
+
+As of version 4, [request-promise-native](https://github.com/request/request-promise-native) has been replaced by [axios](https://github.com/axios/axios)
+
+This means all responses are now following [this response schema](https://github.com/axios/axios?tab=readme-ov-file#response-schema)
+so code that previously used the response body directly, will need to add a `.data`
+
+```ts
+const json = await client.apiRequest('...');
+```
+
+```ts
+const json = (await client.apiRequest('...')).data;
+```