Skip to content

Latest commit

 

History

History
266 lines (198 loc) · 17.6 KB

CHANGELOG.md

File metadata and controls

266 lines (198 loc) · 17.6 KB

0.12.0 (08 February 2022)

This release introduces a major refactor of the JavaScript runtime by @j-f1 and several performance enhancements.

Merged pull requests:

  • Add Hashable conformance to JSObject (#162) via @yonihemi
  • Add test for detached ArrayBuffer (#154) via @yonihemi
  • Fix detached ArrayBuffer errors (#153) via @yonihemi
  • Split runtime into multiple files (#150) via @j-f1
  • Add a way for Swift code to access raw contents of a Typed Array (#151) via @yonihemi
  • Prevent installGlobalExecutor() from running more than once (#152) via @yonihemi
  • Return from runtime functions instead of taking a pointer where possible (#147) via @j-f1
  • Use TypedArray.set to copy a bunch of bytes (#146) via @kateinoigakukun

0.11.1 (22 November 2021)

This is a bugfix release that removes a requirement for macOS Monterey in Package.swift for this package. README.md was updated to explicitly specify that if you're building an app or a library that depends on JavaScriptKit for macOS (i.e. cross-platform code that supports both WebAssembly and macOS), you need either

  • macOS Monterey that has the new Swift concurrency runtime available, or
  • any version of macOS that supports Swift concurrency back-deployment with Xcode 13.2 or later, or
  • add .unsafeFlags(["-Xfrontend", "-disable-availability-checking"]) in Package.swift manifest.

Merged pull requests:

0.11.0 (22 November 2021)

This release adds support for async/await and SwiftWasm 5.5. Use the new value async property on a JSPromise instance to await for its result. You'll have to add a dependency on the new JavaScriptEventLoop target in your Package.swift, import JavaScriptEventLoop, and call JavaScriptEventLoop.installGlobalExecutor() in your code before you start using await and Task APIs.

Additionally, manual memory management API of JSClosure has been removed to improve usability. This significantly bumps minimum browser version requirements for users of apps depending on JavaScriptKit. Previous manual memory management mode is still available though with a special compiler flags, see README.md for more details.

This new release of JavaScriptKit may work with SwiftWasm 5.4 and 5.3, but is no longer tested with those versions due to compatibility issues introduced on macOS by latest versions of Xcode.

Many thanks to @j-f1, @kateinoigakukun, and @PatrickPijnappel for their contributions to this release!

Closed issues:

  • Enchancement: Add a link to the docs (#136)
  • Use FinalizationRegistry to auto-deinit JSClosure (#131)
  • make test crashes due to JSClosure memory issues (#129)
  • Avoid manual memory management with JSClosure (#106)

Merged pull requests:

0.10.1 (29 April 2021)

This is a minor patch release that includes updates to our dependencies and minor documentation tweaks.

Closed issues:

  • Do you accept contributions for wrappers over JavaScript objects? (#124)
  • Can't read from a file using JSPromise (#121)
  • TypeError when trying to implement a JSBridgedClass for WebSocket.send (#120)

Merged pull requests:

0.10.0 (21 January 2021)

This release contains multiple breaking changes in preparation for enabling async/await, when this feature is available in a stable SwiftWasm release. Namely:

  • JSClosure.init(_ body: @escaping ([JSValue]) -> ()) overload is deprecated to simplify type checking. Its presence requires explicit type signatures at the place of use. It will be removed in a future version of JavaScriptKit.
  • JSClosure is no longer a subclass of JSFunction. These classes are not related enough to keep them in the same class hierarchy. As a result, you can no longer call JSClosure objects directly from Swift.
  • Introduced JSOneshotClosure for closures that are going to be called only once. You don't need to manage references to these closures manually, as opposed to JSClosure. However, they can only be called a single time from the JS side. Subsequent invocation attempts will raise a fatal error on the Swift side.
  • Removed generic parameters on JSPromise, now both success and failure values are always assumed to be of JSValue type. This also significantly simplifies type checking and allows callers to fully control type casting if needed.

Closed issues:

  • DOMKit? (#21)

Merged pull requests:

0.9.0 (27 November 2020)

This release introduces support for catching JSError instances in Swift from throwing JavaScript functions. This is possible thanks to the new JSThrowingFunction and JSThrowingObject classes. The former can only be called with try, while the latter will expose all of its member functions as throwing. Use the new throws property on JSFunction to convert it to JSThrowingFunction, and the new throwing property on JSObject to convert it to JSThrowingObject.

Closed issues:

  • Support JS errors (#37)

Merged pull requests:

0.8.0 (21 October 2020)

This release introduces a few enhancements and deprecations. Namely, JSValueConstructible and JSValueConvertible were renamed to ConstructibleFromJSValue and ConvertibleToJSValue respectively. The old names are deprecated, and you should move away from using the old names in your code. Additionally, JavaScriptKit now requires the most recent 5.3 and development toolchains, but thanks to this it no longer uses unsafe flags, which prevented building other libraries depending on JavaScriptKit on other platforms.

The main user-visible enhancement is that now force casts are no longer required in client code. That is, we now allow this

let document = JSObject.global.document
let foundDivs = document.getElementsByTagName("div")

in addition to the previously available explicit style with force unwrapping:

let document = JSObject.global.document.object!
let foundDivs = document.getElementsByTagName!("div").object!

Note that the code in the first example is still dynamically typed. The Swift compiler won't warn you if you misspell names of properties or cast them to a wrong type. This feature is purely additive, and is added for convenience. You can still use force unwraps in your code interfacing with JavaScriptKit. If you're interested in a statically-typed DOM API, we recommend having a look at the DOMKit library, which is currently in development.

Lastly, JSError now conforms to the JSBridgedClass protocol, which makes it easier to integrate with idiomatic Swift code.

Closed issues:

  • Errors building example: undefined symbols (#95)
  • Documentation website is broken (#93)
  • Rename JSValueConstructible and JSValueConvertible (#87)
  • Build fails with the unsafe flags error (#6)

Merged pull requests:

0.7.2 (28 September 2020)

This is a bugfix release that resolves an issue with the JavaScript runtime being unavailable when installed via NPM.

0.7.1 (27 September 2020)

This is a bugfix release that resolves an issue with the JavaScript runtime being unavailable when installed via NPM.

Closed issues:

  • 0.7.0 unavailable on NPM (#79)
  • Automatic performance testing (#67)

Merged pull requests:

0.7.0 (25 September 2020)

This release adds multiple new types bridged from JavaScript, namely JSError, JSDate, JSTimer (which corresponds to setTimeout/setInterval calls and manages closure lifetime for you), JSString and JSPromise. We now also have documentation published automatically for the main branch.

Closed issues:

  • TypedArray improvement? (#52)

Merged pull requests:

0.6.0 (11 September 2020)

This release adds JSTypedArray generic type, renames JSObjectRef to JSObject, and makes JSClosure memory management more explicit.

Closed issues:

  • Support for JS Arrays “holes”, including the test suite (#39)
  • BigInt Support (#29)
  • Separate namespaces for methods and properties? (#27)

Merged pull requests: