labtech-script-decode

v0.7.3

Published

3 years ago

Utilites to decode LabTech scripts and encodings.

Downloads

0High
0Medium
0Low

k-grube

kspooner13

LabTech ConnectWise Automate

labtech-script-decode

A set of utilities to load, parse, encode and interpolate exported LabTech scripts from XML into JSON and from JSON to XML. This module will run in the browser or on the server.

Installation

npm install --save labtech-script-decode

Usage

Server

const labtech_script = require('labtech-script-decode');

labtech_script.decodeXML(scriptXML).then(scriptJSON => {})

labtech_script.decode(base64string).then()

Browser

Include using Webpack, Browserify, etc, or directly using a script tag:

<script src="/dist/labtech-script-decode.min.js"></script>
<script>
  labtech_script.decodeXML(scriptXML)
    .then(scriptJSON => {
      // scriptJSON
    })
</script>

Documentation

Script functions and their associated documentation for each script function.

Examples

See the test folder for an example decoded script here.

This library is documented with JSDoc for exported object schema.

API

decodeXML(value)

Decode and interpolate an XML string

Arguments

| Param | Type | Description | | --- | --- | --- | | value | String | Exported LabTech script |

Returns

Promise ⇒ Object<LabTechScript>

decode(value)

Decode and parse a base 64 encoded string such as ScriptData or LicenseData. This function does not interpolate constants such as function names into decoded values.

Arguments

| Param | Type | Description | | --- | --- | --- | | value | String or Array | Base 64 encoded |

Returns

Promise ⇒ Object<Parsed XML>

encodeXML(object)

Encode and de-interpolate object into an XML string. The input's schema is validated to confirm that the output will produce a valid LabTech script.

Arguments

| Param | Type | Description | | --- | --- | --- | | object | Object<LabTech_Expansion> | Packed LabTech script |

Returns

Promise ⇒ String<XML>

encode(object)

Encode a JSON object into a base64 encoded string such as for ScriptData or LicenseData.

Arguments

| Param | Type | Description | | --- | --- | --- | | object | object | |

Returns

Promise ⇒ String

interpolate(scriptData)

Arguments

| Param | Type | Description | | --- | --- | --- | | scriptData | Object<ScriptData> | Uninterpolated script data |

Returns

Promise ⇒ Object<ScriptData>

toText(scriptJSON)

Arguments

| Param | Type | Description | | --- | --- | --- | | scriptJSON | LabTechScript | LabTech Script JSON returned by decodeXML |

Constants

A helper object containing a map of ids to

Properties

| Property | Values | | --- | --- | | Actions | Function location in script | | Continues | Function enabled or disabled | | FunctionFlags | Base 10 bitstring determining target for this function | | FunctionTypes | If or regular function| | Functions | Function definitions | | OsLimits | Function OS limits |