sv-webrisk-client

Client for communicating with the sv-webrisk GraphQL system.

It is built in TypeScript and has one peer dependency of @simpleview/sv-graphql-client

OS Support

The expectation is that this application will be installed in Linux using sv-kubernetes.

Prerequisites

• sv-graphql-client

Install

Using npm:

npm install @simpleview/sv-webrisk-client

Using yarn:

yarn install @simpleview/sv-webrisk-client

Update

To update to the latest version, just rerun the install command.

Authentication Requirements

sv-webrisk queries do not require any authentication.

Implementation & Usage

To see the input parameters and output fields of an endpoint, please view the Schema in the GraphQL Explorer at https://graphql.simpleviewinc.com/ for the corresponding GraphQL query.

WebriskPrefix

WebriskPrefix can be loaded into the sv-graphql-client GraphServer to use as a client library for accessing webrisk in GraphQL.

import { WebriskPrefix } from "@simpleview/sv-webrisk-client";
import { GraphServer } from "@simpleview/sv-graphql-client";

export default new GraphServer({ graphUrl: GRAPHQL_URL, prefixes: [WebriskPrefix] });

CommonJS:

const { WebriskPrefix } = require("@simpleview/sv-webrisk-client");
const { GraphServer } = require("@simpleview/sv-graphql-client");

module.exports = new GraphServer({ graphUrl: GRAPHQL_URL, prefixes: [WebriskPrefix] });

Where you are making server requests:

JavaScript:

const { webrisk } = require("./webriskGraphServer");

TypeScript:

import { webrisk } from "./webriskGraphServer";

WebriskPrefix.lookup

This method wraps the webrisk.lookup GraphQL query.

const result = await webrisk.lookup({
	fields: "success safe failures",
	input: {
		urls: [
			"http://www.simpleviewinc.com",
			"http://www.google.com",
			"http://www.google.co.uk"
		]
	}
});

For a request with invalid input such as an invalid url, an error will be thrown such Variable "$input" got invalid value "http:/%www.google.com" at "input.urls"; Expected type "URL". Invalid URL

Related Documentation

• sv-graphql-client
• sv-webrisk (client lives in containers/client)