node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org ยป

tenon-api-client

Tenon API Client Module

This is an interface to TENON - a web accessiblity testing API.

Tenon docs: http://tenon.io/documentation/

This API client module is open and free. However, access to the Tenon API must be granted by Tenon. You will need to obtain an API key to use it.

This module is fully async and should be usable in a server that has to support multiple simultaneous connections.

To Use

var tenon = require('tenon-api-client');
tenon({
  url: 'local/path/to/html or http:// URL', // required
  key: 'your Tenon API key'                 // required
  // any additional options, see below
}, function(err, response) {
  if (err) {
    console.log('Oops: ' + err);
  } else {
    console.log(JSON.stringify(response, null, '  ')); // or something useful
  }
});

Details

This API client module receives a configuration object as its first parameter. This object can contain properties corresponding to all the request parameters documented in the Tenon API documentation (except for src, see below). In addition, it can also contain the following properties:

  • url -- either a web URL (http or https) or a path to a local html file. This property is required.
  • urlPrefix -- This gets prepended to url. Convenient for converting file paths to http urls. Default is no urlPrefix.
  • config -- Path to a JSON file with parameters to merge in. This file would be a convenient place to put the API key.
  • userid and password -- if both are present and the url starts with "http", then these are incorporated into the url passed to the Tenon API for basic auth: (userid:password@domain.com/...)
  • filter -- an array of tIDs to filter out of the results. Actually it leaves resultSet unmolested, but creates a new array, resultSetFiltered, with these particular errors filtered out. Default is the empty array: [].
  • inline -- if present should be a function or false. If false then it suppresses inlining of local Javascript and CSS. If a function, it will be used for inlining in place of the companion inliner.js module. The function must accept a config object with one property -- fname, containing a string path to the HTML file. It must return a promise and fulfill that promise with a string that we will send to the Tenon API as the src parameter. Any other value (including null and undefined) will cause normal inlining with the companion inliner module. This property applies only if url is a path to a local html file.

The only Tenon API parameter that cannot be passed is src. The module requires the url property and will populate src if url points to a local file.

IMPORTANT: If the given url is a local file (it doesn't start with "http") and the inline property in the configuration is not false or a function, this module will inline all local Javascript and CSS. For example:

<link rel="stylesheet" href="css/combo.css" media="screen">

will be converted to:

<style media="screen">
  [[content of css/combo.css]]
</style>

The inlined files must be relative to the HTML file. For example, if a javascript src attribute in an html file at C:\project\index.html is "js/script.js" then the file should be at C:\project\js\script.js.

If the target file is not found (or cannot be opened for some reason) its reference is left unaltered and it is not inlined.

Javascript and CSS references that start with "http" are not touched.

Userid/password are ignored for local files.

The basic assumption is that files loaded with HTTP (or HTTPS) are accessible to the Tenon server, but local files are not.

Returned Results

The callback receives two parameters: err, and results.

If err is null, then results is an object. It consists of the results returned by the Tenon API with one additional property: resultSetFiltered. This property is an array created by filtering resultSet against the filter configuration (see above.)

Calling code can test results.resultSetFiltered.length to see if there are any unfiltered accessibility errors.

Default Tenon API Parameters

These are default values for various Tenon API parameters.

fragment: '0',
ref: '0',
store: '0',
viewPortHeight: '768',
viewPortWidth: '1024',

Used In

This module is used in Tenon Grunt Plugin and Tenon Gulp Plugin.

Changelog

  • 0.1.7 - Minor internal change to help grunt-tenon-client.
  • 0.1.5 & 0.1.6 - new tenon URL (https vs http)
  • 0.1.4 - Documented urlPrefix - no code changes.
  • 0.1.3 - Removed functionality for modifying url parameters in CSS local files. It was not useful.
  • 0.1.2 - Made inlining function optional and user replacable.