https://github.com/michal-kapala/jitterbit-script

Static typechecker and interpreter for Jitterbit scripts
https://github.com/michal-kapala/jitterbit-script

interpreter ipaas jitterbit jitterbit-harmony jitterbit-studio typechecker

Last synced: 3 months ago
JSON representation

Static typechecker and interpreter for Jitterbit scripts

• Host: GitHub
• URL: https://github.com/michal-kapala/jitterbit-script
• Owner: michal-kapala
• License: mit
• Created: 2022-12-30T15:26:51.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-11-18T00:51:43.000Z (6 months ago)
• Last Synced: 2025-11-18T02:26:50.421Z (6 months ago)
• Topics: interpreter, ipaas, jitterbit, jitterbit-harmony, jitterbit-studio, typechecker
• Language: TypeScript
• Homepage: https://npmjs.com/package/jitterbit-script
• Size: 1.09 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Jitterbit Script

![tests](https://github.com/michal-kapala/jitterbit-script/actions/workflows/tests.yml/badge.svg)

Community-made Node.js package for static code analysis and execution of [Jitterbit scripts](https://success.jitterbit.com/design-studio/design-studio-reference/scripts/jitterbit-script-language/).

Provides language support capabilities for [Jitterbit VS Code extension](https://github.com/michal-kapala/vscode-jitterbit).

 

  

    Language

    TypeScript

  

  

    Platform

    NodeJS

  

## Usage

### Static analysis

Create a typed AST along with detected errors and warnings.

```ts

import {Diagnostic, Parser, Typechecker} from 'jitterbit-script';

const script = ' $hi = "hello world!" ';

const diagnostics: Diagnostic[] = [];

const parser = new Parser();

const ast = parser.parse(script, diagnostics);

const analysis = Typechecker.analyze(ast, diagnostics);

```

The above code should never throw, if it does please raise an issue with a bug report.

### Runtime

Execute a script.

```ts

import {evaluate, Parser, Scope} from 'jitterbit-script';

async function run(script: string) {

  const parser = new Parser();

  try {

    const ast = parser.parse(script);

    return await evaluate(ast, new Scope());

  } catch(err) {

    // error handling

  }

}

const result = run(' $hi = "hello world!" ');

```

## Disclaimer

Please note this is **not** official Jitterbit tooling. It **does** differ in behaviour and support from the original Jitterbit runtimes executing scripts in Jitterbit Harmony.

The static analysis system was redesigned to provide static typing and improve problem reporting for better DX and high quality code development.

Currently the support for runtime APIs is limited. See [README](https://github.com/michal-kapala/jitterbit-script/tree/main/src/api#readme) for details on runtime API support.

The runtime implementation's behaviour is based on the cloud agent and editor versions below.

| Component | Version |

|---|---|

| Cloud agent | 11.23.0.9 |

| Jitterbit Studio |  10.55.0.27 |

This repo is a fork of [tlaceby/guide-to-interpreters-series](https://github.com/tlaceby/guide-to-interpreters-series).