npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@remscodes/renault-api-client

v1.1.3

Published

Http client using Renault API

Downloads

2

Readme

github ci npm version bundle size license

Installation

npm install @remscodes/renault-api-client

Usage

Example

import { RenaultClient } from '@remscodes/renault-api-client';

// Instantiate new Renault http client
const renault = new RenaultClient();

// Use Gigya and Kamereon sub http client.
const { gigya, kamereon } = renault;

// Login to Gigya service and get auth info (to be automatically stored into session).  
await gigya.login('myLogin', 'myPassword');
await gigya.getAccountInfo();
await gigya.getJwt();

// Get the proper `accountId` and store it into session.
const { accounts } = await kamereon.getPerson();
const accountId = accounts.find(acc => acc.accountType === 'MYRENAULT');

renault.session.accountId = accountId;

// Get the vehicle `vin` and store it into session.
const vehicles = await kamereon.getAccountVehicles();
const { vin } = vehicles.vehicleLinks[0];

renault.session.vin = vin;

// Get vehicle info. 
const response = await kamereon.readBatteryStatus();
const batteryStatus = response.data.attributes;

Session

Authentication info are stored in RenaultSession instance.

const renault = new RenaultClient();
const session = renault.session;
class RenaultSession {
  // Locale that will be used to format date.
  // default: "fr_FR"
  locale: string;

  // Country code that will use as http param for Kamereon.
  // default: "FR"
  country: string;

  // Token to use Gigya getJWT API.
  // Automatically set when Gigya login API is called and succeed.
  gigyaToken: string | undefined;

  // Token to use Kamereon API.
  // Automatically set when Gigya getJWT API is called and succeed.
  token: string | undefined;

  // Selected person id.
  // Automatically set when Gigya getAccountInfo API is called and succeed.
  personId: string | undefined;

  // Selected account id.
  // To be set in order to be automatically passed into each Kamereon API functions that needs it.
  // Otherwise, it needs to be manually passed as function argument using `KamereonClient`.
  accountId: string | undefined;

  // Selected vehicle vin.
  // To be set in order to be automatically passed into each Kamereon API functions that needs it.
  // Otherwise, it needs to be manually passed as function argument using `KamereonClient`.
  vin: string | undefined;
}

Error intercepting

You can intercept response error by passing onError callback into client constructor.

Example :

const renault = new RenaultClient({
  onError: ({ status, url, error }, session) => {
    if (status === 401) {
      session.token = undefined;
      myService.clearToken();
      myService.navigateToLogin();
    }
    else {
      console.error(`Error ${status} from ${url} : ${error}`);
    }
  },
});

Disclaimer

This project is not affiliated with, endorsed by, or connected to Renault. I accept no responsibility for any consequences, intentional or accidental, resulting from interaction with the Renault's API using this project.

Credit

Resources API based on @remscodes/renault-api.

License

MIT © Rémy Abitbol.