@sebastianwessel/quickjs
Version:
A typescript package to execute JavaScript and TypeScript code in a WebAssembly QuickJS sandbox
79 lines (78 loc) • 2.84 kB
TypeScript
/**
* QuickJS sandbox for JavaScript/Typescript applications
*
* This TypeScript package allows you to safely execute JavaScript code within a WebAssembly sandbox using the QuickJS engine.
* Perfect for isolating and running untrusted code securely, it leverages the lightweight and fast QuickJS engine compiled to WebAssembly, providing a robust environment for code execution.
*
* @author Sebastian Wessel
* @copyright Sebastian Wessel
* @license MIT
* @link https://sebastianwessel.github.io/quickjs/
* @link https://github.com/sebastianwessel/quickjs
*
* @example
* ```typescript
* import { type SandboxOptions, loadQuickJs } from '@sebastianwessel/quickjs'
*
* // General setup like loading and init of the QuickJS wasm
* // It is a ressource intensive job and should be done only once if possible
* const { runSandboxed } = await loadQuickJs()
*
* const options: SandboxOptions = {
* allowFetch: true, // inject fetch and allow the code to fetch data
* allowFs: true, // mount a virtual file system and provide node:fs module
* env: {
* MY_ENV_VAR: 'env var value',
* },
* }
*
* const code = `
* import { join } from 'path'
*
* const fn = async ()=>{
* console.log(join('src','dist')) // logs "src/dist" on host system
*
* console.log(env.MY_ENV_VAR) // logs "env var value" on host system
*
* const url = new URL('https://example.com')
*
* const f = await fetch(url)
*
* return f.text()
* }
*
* export default await fn()
* `
*
* const result = await runSandboxed(async ({ evalCode }) => evalCode(code), options)
*
* console.log(result) // { ok: true, data: '<!doctype html>\n<html>\n[....]</html>\n' }
* ```
*
*
* @module
*/
export * from './loadQuickJs.js';
export * from './loadAsyncQuickJs.js';
export * from './adapter/fetch.js';
export * from './createVirtualFileSystem.js';
export * from './getTypescriptSupport.js';
export * from './types/CodeFunctionInput.js';
export * from './types/ErrorResponse.js';
export * from './types/LoadQuickJsOptions.js';
export * from './types/OkResponse.js';
export * from './types/OkResponseCheck.js';
export * from './types/Prettify.js';
export * from './types/RuntimeOptions.js';
export * from './types/SandboxEvalCode.js';
export * from './types/SandboxFunction.js';
export * from './types/SandboxOptions.js';
export * from './types/SandboxValidateCode.js';
export * from './types/Serializer.js';
export * from './sandbox/handleToNative/serializer/index.js';
export * from './sandbox/handleToNative/handleToNative.js';
export * from './sandbox/expose/expose.js';
export * from './sandbox/syncVersion/getModuleLoader.js';
export * from './sandbox/syncVersion/modulePathNormalizer.js';
export * from './sandbox/asyncVersion/getAsyncModuleLoader.js';
export * from './sandbox/asyncVersion/modulePathNormalizerAsync.js';