Skip to content

Latest commit

 

History

History
64 lines (54 loc) · 2.3 KB

README.md

File metadata and controls

64 lines (54 loc) · 2.3 KB
Raw

Build Status Quality Gate Status

QRadar App JavaScript Library (qjslib)

QJSLib is a JavaScript utility library that provides functionality for QRadar apps to simplify interactions with QRadar.

How to use

Browser vs module

The build process for this project generates two separate files in lib/.

qappfw.js is not minified. It is designed to be bundled with your application code.

qappfw.min.js is minified with polyfills for browser compatibility. It is designed to be used directly in the browser.

As a module

  1. Install qjslib.
npm i qjslib
  1. Import it into your application.
import { QRadar } from "qjslib";
  1. You can now use the helper functions.
QRadar.fetch("/api/gui_app_framework/applications")
    .then((response) => response.json())
    .then((json) => console.log(json));

As a browser script

  1. Get the latest release of QJSLib.
  2. Download the latest tarball qjslib-(version).tgz.
  3. Extract package/lib/qappfw.min.js.
  4. Place this file in your QRadar app, e.g. in /app/static/qappfw.min.js
  5. Add a reference to the file from your HTML file.
  6. The utility class QRadar is added to the global scope - and can be accessed through window.qappfw.QRadar.
  7. You can now use qjslib like this:
const QRadar = window.qappfw.QRadar

// Using traditional xmlhttprequest callback
QRadar.rest({
    path: "/api/gui_app_framework/applications",
    onComplete: function() {console.log(this.response);},
    httpMethod: "GET"
});

// Using modern promise based fetch
// Not using arrow functions for older browser compatability
QRadar.fetch("/api/gui_app_framework/applications")
    .then(function(response) {return response.json();})
    .then(function(json) {console.log(json);});

console.log(QRadar.getWindowOrigin());

Developing this project

See setup in CONTRIBUTING