cee-wrapper v1.0.4

TypeScript Wrapper for CEE - Binary Interface

This project is a TypeScript application which acts as a wrapper for the Binary Interface of the CEE. It facilitates interaction between client applications and the binary interface.

The application communicates with explanation-engine.js, a web worker, sending and receiving messages.

Features

• TypeScript: The entire codebase is written in TypeScript providing static typing.
• Web Worker Integration: Interaction with explanation-engine.js.
• Protocol Buffers Transformation (TEMPORARY): It uses a script to transform .proto files into .ts files to ensure the responses from the worker are typed. This is temporary because ultimately the files should be stored in the definitions repo and consumed as a node module.

Dependencies

A postinstall script moves the files explanation-engine.js and explanation-engine.wasm from node modules to the /public directory, so that they can be used by the web worker.

Scripts

The application comes with the following scripts:

• npm run compile-protos: This script compiles all .proto files in the /protos dir to .ts files. This is a temporary measure because we do not yet have the protos available in the definitions repository.
• npm run build: This script compiles the TypeScript into JavaScript.

Use the /demo project in this repo (/typescript/demo) to test out features.