quickjs-emscripten - npm Package Versions

#161 Fix a bug where context.evalCode(..., { type: 'module' }) would return success when some kinds of error occurred when using quickjs variants.
- Also adds context.getPromiseState(handle) to resolve promises synchronously.

0.29.0

Diff

jitl

published 0.29.0 • 2 months ago

Changelog

Source

v0.29.0

#154 ESModule exports
- context.evalCode(code, filename, { type: "module" }) or when code is detected to be a module: now returns a handle to the module's exports, or a promise handle that resolves to the module's exports.
- Added context.getPromiseState(handle) which returns the state of a promise handle, and can be unwrapped with context.unwrapResult(promiseState).
#159 add LICENSE file and SPDX license identifiers to all packages.

0.28.0

Diff

jitl

published 0.28.0 • 3 months ago

Changelog

Source

v0.28.0

#155 Update library versions and add versions to documentation.
- quickjs version 2024-01-13+229b07b9 vendored to quickjs-emscripten on 2024-02-11.
  - Evaluating a ES Module with context.evalCode(...) now returns a Promise object instead of undefined.
- quickjs-ng version git+229b07b9 vendored to quickjs-emscripten on 2024-02-11.

0.27.0

Diff

jitl

published 0.27.0 • 3 months ago

Changelog

Source

v0.27.0

#147 Support providing and retrieving WebAssembly.Memory
- Fixes #146 by adding wasmMemory: WebAssembly.Memory option for newVariant, and mod.getWasmMemory() method for QuickJS[Async]WASMModule.
- Fixes #138 by
  - removing internal use of using statement.
  - Use ESBuild Symbol.for('Symbol.dispose') if Symbol.dispose isn't defined globally.

0.26.1-rc.0

Diff

jitl

published 0.26.1-rc.0 • 4 months ago

0.26.0

Diff

jitl

published 0.26.0 • 4 months ago

Changelog

Source

v0.26.0

#136, #116 (thanks to @GrantMatejka) Expose ability to configure Context's intrinsic objects.
#135 (thanks to @saghul) Add quickjs-ng variants. quickjs-ng is a fork of quickjs under active development. It implements more EcmaScript standards and removes some of quickjs's custom language features like BigFloat.
#134 Support using statement for Disposable. If you using value = vm.unwrapResult(vm.evalCode("1+1")), the value will be automatically disposed when the scope exits.
#133 WebAssembly loading options & Cloudflare Worker support. Added an example of using quickjs-emscripten in a Cloudflare Worker.

0.25.1

Diff

jitl

published 0.25.1 • 4 months ago

Changelog

Source

v0.25.1

#130 Fix some README and docs quibbles.

0.25.0

Diff

jitl

published 0.25.0 • 4 months ago

Changelog

Source

v0.25.0

#129 Improve packaging strategy, native ES Modules, and browser-first builds.

New package layout

quickjs-emscripten is re-organized into several NPM packages in a monorepo structure:

quickjs-emscripten (install size 7.5mb) - mostly backwards compatible all-in-one package. This package installs the WASM files for DEBUG_SYNC, DEBUG_ASYNC, RELEASE_SYNC and RELEASE_ASYNC variants as NPM dependencies. Its total install size is reduced from ~
quickjs-emscripten-core (install size 573kb) - just the Typescript code, should be compatible with almost any runtime. You can use this with a single a-la-carte build variant, such as @jitl/quickjs-wasmfile-release-sync to reduce the total install size needed to run QuickJS to ~1.1mb.
Several a-la-carte build variants, named @jitl/quickjs-{wasmfile,singlefile-{esm,cjs,browser}}-{debug,release}-{sync,asyncify}. See the [quickjs-emscripten-core docs][core-docs] for more details.

ESModules & Browser support

quickjs-emscripten uses [package.json export conditions][conditions] to provide native ES Modules for NodeJS and the browser when appropriate. Most bundlers, like Webpack@5 and Vite, will understand conditions and work out of the box. This should enable advanced tree-shaking, although I'm not sure how much benefit is possible with the library.

You can also use quickjs-emscripten directly from an HTML file in two ways:

<!doctype html>
<!-- Import from a ES Module CDN -->
<script type="module">
  import { getQuickJS } from "https://esm.run/quickjs-emscripten@0.25.0"
  const QuickJS = await getQuickJS()
  console.log(QuickJS.evalCode("1+1"))
</script>

In edge cases, you might want to use the IIFE build which provides QuickJS as the global QJS.

<!doctype html>
<!-- Add a script tag to load the library as the QJS global -->
<script
  src="https://cdn.jsdelivr.net/npm/quickjs-emscripten@0.25.0-rc.11/dist/index.global.js"
  type="text/javascript"
></script>
<!-- Then use the QJS global in a script tag -->
<script type="text/javascript">
  QJS.getQuickJS().then((QuickJS) => {
    console.log(QuickJS.evalCode("1+1"))
  })
</script>

Breaking Changes

We now differentiate between runtime environments at build time using Node.JS package.json [export conditions in subpath exports][conditions], instead of including support for all environments in a single build. While this resolves open issues with relatively modern bundlers like webpack@5 and vite, it may cause regressions if you use an older bundler that doesn't understand the "browser" condition.
The release variants - RELEASE_SYNC (the default), and RELEASE_ASYNC - no longer embed the WebAssembly code inside a JS file. Instead, they attempt to load the WebAssembly code from a separate file. Very old bundlers may not understand this syntax, or your web server may not serve the .wasm files correctly. Please test in a staging environment to verify your production build works as expected.
quickjs-emscripten now uses [subpath exports in package.json][conditions]. Imports of specific files must be removed. The only valid import paths for quickjs-emscripten are:
- import * from 'quickjs-emscripten' (the library)
- import packageJson from 'quickjs-emscripten/package.json'
- import { DEBUG_SYNC, DEBUG_ASYNC, RELEASE_SYNC, RELEASE_ASYNC } from 'quickjs-emscripten/variants' (these are exported from the main import, but are also available as their own files)
You should update your imports to use one of these paths. Notably, the WASM files can no longer be directly imported from the quickjs-emscripten package.
If you have errors about missing type files, you may need to upgrade to typescript@5 and set moduleResolution to node16 in your tsconfig.json. This shouldn't be necessary for most users.