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

@knotcity/svaas-sdk

v1.14.3

Published

Knot Stations and Vehicles As A Service SDK

Downloads

881

Readme

Knot Station and Vehicles as a Service (SVaaS) Software Development Kit (SDK)

This SDK allows you to use our service allowing you to control stations and vehicles.

More info on the service on our Documentation

README is a Work in progress

Installation

This project is written in TypeScript using Node.js 12 and targeting es2017. It MAY work for older versions of Node.js.

Install using npm:

npm install @knotcity/svaas-sdk

Usage

Import the module in the same way as you do normally.

// JavaScript
const svaas = require('@knotcity/svaas-sdk');
// TypeScript
import svaas = require('@knotcity/svaas-sdk');

Creating a client

Before making request you need to create a new KnotSVaaS object with your keys.

// Fetch your info
const yourKeyId = "...";
// Watch out for line breaks (should be `\n` and not `\\n`)
const yourPrivateKey = "...";
// The knot's public key is available on our [documentation](https://doc.knotcity.io/services/http-signature/#3-verify-signature)
// It's used if you want to verify the request we make to your API/Webhooks
const knotPublicKey = "...";

export const SVaaS = new svaas.KnotSVaaS({
    keyId: yourKeyId,
    privateKey: yourPrivateKey,
    knotPublicKey: knotPublicKey,
    vehiclesEndpoint: '...', // Optionally you can set a custom endpoint for the vehicles API (like if you are on our test environment)
    stationsEndpoint: '...' // Optionally you can set a custom endpoint for the stations API (like if you are on our test environment)
});

Calling an action

To call a specific action, use the client you just created and call the function you need.

try
{
    const resp = await SVaaS.unlockVehicle(vehicleId, unlockId);
    resp.code; // Response code, 0 most of the time, which means success but it can be something else to inform other actions to take
    resp.message; // A descriptive message associated with the code
    resp.data; // Data requested, if any
}
catch(err)
{
    // Something went wrong
}

Verifying a request made to your API/Webhook from us

To be sure that a request to your API comes from us, you can verify its signature with the following function. req is an Express request object

try
{
    const valid = SaaS.checkKnotRequestSignature({ headers: req.headers, httpMethod: req.method, path: req.originalUrl });
}
catch(err)
{
    // Something failed
}