seroval-plugins

• fix: streaming serialization cleanup (#77)
• fix: preserve own proto properties through serialize (#81)
• fix: preserve circular own proto properties through deferred assignment (#82)
• fix: use element length for bigint typed array views (#83)
• fix: unescape regexp source in the serialized output (#84)

Credits to @spokodev and @greymoth-jp

• Move AbortSignal to seroval-plugins/web
  • This was an implementation mistake in 1.2.0, AbortSignal is a web standard.
• expose onParse, pushPendingState, popPendingState and parseWithError in Plugin API.
• Rework serialized Promise format
  • Instead of assigning resolver methods to a Promise, seroval will now keep track of an object that contains those methods and instead will reference that object when resolving in a streaming format.
  • status and value is now replaced with s (0, 1, 2 as pending, success, failure) and v respectively.
• Fix support for invalid Dates.
  • Turns out, new Date(NaN) is a thing.

• Add AbortSignal to serializable values

This feature adds a very basic OpaqueReference class. The purpose of this class is to wrap user-specified values into "opaque references": references that are hidden from the serializer. An OpaqueReference contains two values: the original value it is trying to hide, and an optional replacement value, which is what the serializer "sees".

A replacement value can only be a value that seroval can serialize. By default, a replacement value is undefined.

Example:

import { serialize, deserialize, OpaqueReference } from 'seroval';

const example = {
  transparent: "This is a transparent value.",
  opaque: new OpaqueReference('This is an opaque value.'),
};

// You can still access the original value:
console.log(example.opaque.value);

// but now it's different
const deserialized = deserialize(serialize(example));
console.log(deserialized.opaque); // undefined

What's Changed

• Introduce createStream https://github.com/lxsmnsyc/seroval/pull/36/commits/a4039554433b785197572252afe24810067e75aa
  • This function provides a universal streaming primitive that users can use. ReadableStream isn't a JS standard and so there was no counterpart to Promise when it comes to streaming data, so I had to introduce a minimal streaming primitive that is both portable and serializable.
• Create seroval-plugins https://github.com/lxsmnsyc/seroval/pull/36/commits/22dcc59d2e165340809b81adaba8799a0049d7cc
  • This package is dedicated for authoring plugins.
  • Given that createStream has been introduced, seroval is no longer dependent from the ReadableStream API, which makes seroval no longer tied to the Web API too.
• Move the following Web API support to seroval-plugins/web
  • Blob
  • CustomEvent
  • DOMException
  • Event
  • File
  • FormData
  • Headers
  • ReadableStream
  • Request
  • Response
  • URLSearchParams
  • URL
• Deprecate some feature flags. The following features can no longer be disabled:
  • Set
  • Map
  • Promise
  • BigInt
  • TypedArray
  • Symbol
  • WebAPI
• Plugin parsing is now on a higher priority, which would allow users to customize serialization for things like plain objects.
• Promise and AsyncIterable is now supported in sync mode, but will only generate a non-resolving instance.
• Add extends option to Plugins API. This allows the plugins to require other plugins in case the feature is required (e.g. Request relies on both Headers and ReadableStream)

Fixes

• Fix RegExp serialization
• Fix string deserialization
• Fix plugin tag deserialization check
• Fix treeshaking for top-level variables

Full Changelog: https://github.com/lxsmnsyc/seroval/compare/v0.15.1...v1.0.0