changelog, naming adjustments

Author: justjake

CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## v0.30.0
+
+- [#200](https://github.com/justjake/quickjs-emscripten/pull/200) Inspect and iterate handles, equality, changes to result types, changes to debug logging.
+- [#195](https://github.com/justjake/quickjs-emscripten/pull/195) Export `setDebugMode`
+
+### Collection & Iteration
+
+- For objects and arrays: add `context.getOwnPropertyNames(handle, options)` to iterate the key or array index handles.
+- For arrays: add `context.getLength(handle)` which reads `handle.length` and returns it as a number or undefined to make writing `for (i=0;i<length;i++)` loops easier.
+- For iterable collections like Map, Set, Array: add `context.getIterator(handle)` calls `handle[Symbol.iterator]()` and then exposes the result as an `IterableIterator` to host javascript.
+
+### Usability improvements
+
+- The `SuccessOrFail<T, QuickJSHandle>` return type is largely replaced with a new return type `DisposableSuccess<T> | DisposableFail<QuickJSHandle>`. The new type implements `result.unwrap()` as a replacement for `context.unwrapResult(result)`. It also implements `dispose()` directly, so you no longer need to distinguish between success and failure to clean up.
+- add `context.callMethod(handle, 'methodName')`, this makes it easier to call methods like `context.callMethod(handle, 'keys')` or `context.callMethod('values')` which can be used with the new iterator.
+
+### Equality
+
+- Added `context.eq(a, b)`, `context.sameValue(a, b)`, `context.sameValueZero(a, b)`
+
+### Debug logging changes
+
+Debug logging is now disabled by default, even when using a DEBUG variant. It can be enabled on a runtime-by-runtime basis with `runtime.setDebugMode(boolean)` or `context.runtime.setDebugMode(boolean)`, or globally using `setDebugMode(boolean)`. As with before, you should use a DEBUG variant to see logs from the WebAssembly C code.
+
+## v0.29.2
+
+- [#179](https://github.com/justjake/quickjs-emscripten/pull/161) Add a work-around for a bug in Webkit ARM to quickjs build variants. quickjs-ng is still affected by this bug.
+
 ## v0.29.1
 
 - [#161](https://github.com/justjake/quickjs-emscripten/pull/161) Fix a bug where `context.evalCode(..., { type: 'module' })` would return success when some kinds of error occurred when using `quickjs` variants.

packages/quickjs-emscripten-core/src/context-asyncify.ts

@@ -6,7 +6,7 @@ import type {
   JSRuntimePointer,
   JSValuePointer,
 } from "@jitl/quickjs-ffi-types"
-import type { ContextResult } from "./context"
+import type { QuickJSContextResult } from "./context"
 import { QuickJSContext } from "./context"
 import type { Lifetime } from "./lifetime"
 import type { QuickJSModuleCallbacks } from "./module"
@@ -46,7 +46,7 @@ export class QuickJSAsyncContext extends QuickJSContext {
     filename: string = "eval.js",
     /** See {@link EvalFlags} for number semantics */
     options?: number | ContextEvalOptions,
-  ): Promise<ContextResult<QuickJSHandle>> {
+  ): Promise<QuickJSContextResult<QuickJSHandle>> {
     const detectModule = (options === undefined ? 1 : 0) as EvalDetectModule
     const flags = evalOptionsToFlags(options) as EvalFlags
     let resultPtr = 0 as JSValuePointer

packages/quickjs-emscripten-core/src/context.ts

@@ -60,7 +60,7 @@ import type {
 } from "./vm-interface"
 import { QuickJSIterator } from "./QuickJSIterator"
 
-export type ContextResult<S> = DisposableResult<S, QuickJSHandle>
+export type QuickJSContextResult<S> = DisposableResult<S, QuickJSHandle>
 
 /**
  * Property key for getting or setting a property on a handle with
@@ -752,7 +752,7 @@ export class QuickJSContext
    *
    * @param promiseLikeHandle - A handle to a Promise-like value with a `.then(onSuccess, onError)` method.
    */
-  resolvePromise(promiseLikeHandle: QuickJSHandle): Promise<ContextResult<QuickJSHandle>> {
+  resolvePromise(promiseLikeHandle: QuickJSHandle): Promise<QuickJSContextResult<QuickJSHandle>> {
     this.runtime.assertOwned(promiseLikeHandle)
     const vmResolveResult = Scope.withScope((scope) => {
       const vmPromise = scope.manage(this.getProp(this.global, "Promise"))
@@ -763,7 +763,7 @@ export class QuickJSContext
       return Promise.resolve(vmResolveResult)
     }
 
-    return new Promise<ContextResult<QuickJSHandle>>((resolve) => {
+    return new Promise<QuickJSContextResult<QuickJSHandle>>((resolve) => {
       Scope.withScope((scope) => {
         const resolveHandle = scope.manage(
           this.newFunction("resolve", (value) => {
@@ -911,7 +911,7 @@ export class QuickJSContext
       strings: true,
       numbersAsStrings: true,
     },
-  ): ContextResult<DisposableArray<QuickJSHandle>> {
+  ): QuickJSContextResult<DisposableArray<QuickJSHandle>> {
     this.runtime.assertOwned(handle)
     handle.value // assert alive
     const flags = getOwnPropertyNamesOptionsToFlags(options)
@@ -958,7 +958,7 @@ export class QuickJSContext
    * }
    * ```
    */
-  getIterator(iterableHandle: QuickJSHandle): ContextResult<QuickJSIterator> {
+  getIterator(iterableHandle: QuickJSHandle): QuickJSContextResult<QuickJSIterator> {
     const SymbolIterator = (this._SymbolIterator ??= this.memory.manage(
       this.getWellKnownSymbol("iterator"),
     ))
@@ -1061,17 +1061,17 @@ export class QuickJSContext
     func: QuickJSHandle,
     thisVal: QuickJSHandle,
     args?: QuickJSHandle[],
-  ): ContextResult<QuickJSHandle>
+  ): QuickJSContextResult<QuickJSHandle>
   callFunction(
     func: QuickJSHandle,
     thisVal: QuickJSHandle,
     ...args: QuickJSHandle[]
-  ): ContextResult<QuickJSHandle>
+  ): QuickJSContextResult<QuickJSHandle>
   callFunction(
     func: QuickJSHandle,
     thisVal: QuickJSHandle,
     ...restArgs: Array<QuickJSHandle | QuickJSHandle[] | undefined>
-  ): ContextResult<QuickJSHandle> {
+  ): QuickJSContextResult<QuickJSHandle> {
     this.runtime.assertOwned(func)
     let args
     const firstArg = restArgs[0]
@@ -1115,7 +1115,7 @@ export class QuickJSContext
     thisHandle: QuickJSHandle,
     key: QuickJSPropertyKey,
     args: QuickJSHandle[] = [],
-  ): ContextResult<QuickJSHandle> {
+  ): QuickJSContextResult<QuickJSHandle> {
     return this.getProp(thisHandle, key).consume((func) =>
       this.callFunction(func, thisHandle, args),
     )
@@ -1164,7 +1164,7 @@ export class QuickJSContext
      * See {@link EvalFlags} for number semantics.
      */
     options?: number | ContextEvalOptions,
-  ): ContextResult<QuickJSHandle> {
+  ): QuickJSContextResult<QuickJSHandle> {
     const detectModule = (options === undefined ? 1 : 0) as EvalDetectModule
     const flags = evalOptionsToFlags(options) as EvalFlags
     const resultPtr = this.memory