chatop-knight-js v0.1.0

ChatOps Knight JS

This module provides a set of functions to help JavaScript Developers working with Kyndryl ChatOps knight to authenticate and access API endpoints using JavaScript promises.

Requirements (MacOS/Windows)

• NodeJs
  • Minimum: v10.x
  • Recommended: v12.x or v14.x
• npm
  • Tested on: v7.24.x
• Kyndryl ChatOps Knight
  • Recommended: v20.19

Note: Depending on your Windows setup windows-build-tools may need to be installed first. Also, for MacOS users, you should have xcode-select or entire Xcode App installed.

Install

npm install chatops-knight-js --save

Uninstall

npm uninstall chatops-knight-js

Release notes and versions

Change log

Class Constructor

{
  // Indicates if the HTTP request to the knight server should use
  // HTTPS (secure) or HTTP (non-secure) protocol
  https: true,
  // If https is true, then provide client certificate, client key and
  // the root CA cert
  // Client cert and key are optional now
  cert: './client.crt',
  key: './client.key',
  cacert: './ca.crt',
  // Indicate the server name for the ChatOps Knight API, all paths are relative to this one
  baseUrl: 'https://chatops-prod-int.extnet.ibm.com',
  // Indicate the internal path with API version
  rootPath: 'api/v1',
  // HTTP request timeout in milliseconds
  timeout: 2000,
  // If should use a proxy or not by the HTTP request
  // Example:
  // proxy: { host: proxy.ip, port: proxy.port }
  proxy: false,
}

Module usage

Production

const knight = require('chatops-knight-js');

const knight = new Knight( {
    https: true,
    cert: './client.crt',
    key: './client.key',
    cacert: './ca.crt',
    baseUrl: 'https://chatops-prod-int.extnet.ibm.com/',
    rootPath: 'api/v1',
    timeout: 2000,
    proxy: false
});

Development

const knight = require('chatops-knight-js');

const knight = new Knight( {
    https: true,
    cacert: './ca.crt',
    baseUrl: 'https://chatops-dev-int.extnet.ibm.com/',
    rootPath: 'api/v1',
    timeout: 5000,
    proxy: false
});

Check health status of the knight server:

const status = await knight.healthCheck();

Error handling

This package extends the error stack to differentiate if the exception occurred on the ChatOps Knight API layer or not. Also, adds a help message from the knight API docs.

try {
  knight.function(...);
}
// An exception happened and it was thrown
catch(err) {
  if(err.isKnightError) {
    // This an error from ChatOps Knight API
    // Check Knight hint on this error
    console.log(err.knightHelpMessage);
    // For some endpoints there are details on the error message
    if (err.knightHelpMessage.details) {
      console.error(err.knightHelpMessage.details);
    }
  }
  else {
    // Here is still the full Axios error, e.g. err.isAxiosError, err.response, err.request
    // This allows handling of network/tls related issues
    // Or just re-kthrow if you don't care
    throw err;
  }
}

Coverage and Limitations

The following ChatOps Knight API endpoints are currently covered.

Creating your test environment (with HTTPS)

Follow the detailed instructions from this doc.

References

• ChatOps Knight Production Internal API documentation
• ChatOps Knight Development Internal API documentation

Contributing

If you want to contribute to the module and make it better, your help is very welcome. You can do so submitting a Pull Request. It will be reviewed and merged to main branch if accepted.

Reporting an issue

If you have found what you believe to be an issue with chatops-knight-js please do not hesitate to file an issue on the GitHub repository here.

Suggesting a new feature

If you want to see new features or enhancements to the current ones, we would love to hear them. Please submit an issue on the GitHub repository here.

Authors

Written by Rod Anami rod.anami@kyndryl.com, September 2021.

Contributors

• None

License

This package is licensed under the Eclipse Public License 2.0.

Kyndryl ChatOps Knight (ChatOps Fabric) software is licensed under a commercial license to its customers.