seroval 1.3.1 → 1.4.0

package/src/core/context/parser/sync.ts

@@ -1,408 +0,0 @@
-import {
-  createAggregateErrorNode,
-  createArrayBufferNode,
-  createArrayNode,
-  createAsyncIteratorFactoryInstanceNode,
-  createBigIntNode,
-  createBigIntTypedArrayNode,
-  createBoxedNode,
-  createDataViewNode,
-  createDateNode,
-  createErrorNode,
-  createIteratorFactoryInstanceNode,
-  createNumberNode,
-  createPluginNode,
-  createRegExpNode,
-  createSetNode,
-  createStreamConstructorNode,
-  createStringNode,
-  createTypedArrayNode,
-} from '../../base-primitives';
-import { Feature } from '../../compat';
-import { NIL } from '../../constants';
-import { SerovalParserError, SerovalUnsupportedTypeError } from '../../errors';
-import {
-  FALSE_NODE,
-  NULL_NODE,
-  TRUE_NODE,
-  UNDEFINED_NODE,
-} from '../../literals';
-import { OpaqueReference } from '../../opaque-reference';
-import { SpecialReference } from '../../special-reference';
-import type { Stream } from '../../stream';
-import { createStream, isStream } from '../../stream';
-import { serializeString } from '../../string';
-import type {
-  SerovalAggregateErrorNode,
-  SerovalArrayNode,
-  SerovalBigIntTypedArrayNode,
-  SerovalBoxedNode,
-  SerovalDataViewNode,
-  SerovalErrorNode,
-  SerovalMapNode,
-  SerovalNode,
-  SerovalNullConstructorNode,
-  SerovalObjectNode,
-  SerovalObjectRecordKey,
-  SerovalObjectRecordNode,
-  SerovalPluginNode,
-  SerovalPromiseConstructorNode,
-  SerovalSetNode,
-  SerovalTypedArrayNode,
-} from '../../types';
-import { getErrorOptions } from '../../utils/error';
-import { iteratorToSequence } from '../../utils/iterator-to-sequence';
-import type {
-  BigIntTypedArrayValue,
-  TypedArrayValue,
-} from '../../utils/typed-array';
-import type { BaseParserContextOptions } from '../parser';
-import { BaseParserContext, ParserNodeType } from '../parser';
-
-type ObjectLikeNode = SerovalObjectNode | SerovalNullConstructorNode;
-
-export type BaseSyncParserContextOptions = BaseParserContextOptions;
-
-export default abstract class BaseSyncParserContext extends BaseParserContext {
-  protected parseItems(current: unknown[]): SerovalNode[] {
-    const nodes = [];
-    for (let i = 0, len = current.length; i < len; i++) {
-      if (i in current) {
-        nodes[i] = this.parseTop(current[i]);
-      }
-    }
-    return nodes;
-  }
-
-  protected parseArray(id: number, current: unknown[]): SerovalArrayNode {
-    return createArrayNode(id, current, this.parseItems(current));
-  }
-
-  protected parseProperties(
-    properties: Record<string | symbol, unknown>,
-  ): SerovalObjectRecordNode {
-    const entries = Object.entries(properties);
-    const keyNodes: SerovalObjectRecordKey[] = [];
-    const valueNodes: SerovalNode[] = [];
-    for (let i = 0, len = entries.length; i < len; i++) {
-      keyNodes.push(serializeString(entries[i][0]));
-      valueNodes.push(this.parseTop(entries[i][1]));
-    }
-    // Check special properties, symbols in this case
-    let symbol = Symbol.iterator;
-    if (symbol in properties) {
-      keyNodes.push(this.parseWellKnownSymbol(symbol));
-      valueNodes.push(
-        createIteratorFactoryInstanceNode(
-          this.parseIteratorFactory(),
-          this.parseTop(
-            iteratorToSequence(properties as unknown as Iterable<unknown>),
-          ),
-        ),
-      );
-    }
-    symbol = Symbol.asyncIterator;
-    if (symbol in properties) {
-      keyNodes.push(this.parseWellKnownSymbol(symbol));
-      valueNodes.push(
-        createAsyncIteratorFactoryInstanceNode(
-          this.parseAsyncIteratorFactory(),
-          this.parseTop(createStream()),
-        ),
-      );
-    }
-    symbol = Symbol.toStringTag;
-    if (symbol in properties) {
-      keyNodes.push(this.parseWellKnownSymbol(symbol));
-      valueNodes.push(createStringNode(properties[symbol] as string));
-    }
-    symbol = Symbol.isConcatSpreadable;
-    if (symbol in properties) {
-      keyNodes.push(this.parseWellKnownSymbol(symbol));
-      valueNodes.push(properties[symbol] ? TRUE_NODE : FALSE_NODE);
-    }
-    return {
-      k: keyNodes,
-      v: valueNodes,
-      s: keyNodes.length,
-    };
-  }
-
-  protected parsePlainObject(
-    id: number,
-    current: Record<string, unknown>,
-    empty: boolean,
-  ): ObjectLikeNode {
-    return this.createObjectNode(
-      id,
-      current,
-      empty,
-      this.parseProperties(current),
-    );
-  }
-
-  protected parseBoxed(id: number, current: object): SerovalBoxedNode {
-    return createBoxedNode(id, this.parseTop(current.valueOf()));
-  }
-
-  protected parseTypedArray(
-    id: number,
-    current: TypedArrayValue,
-  ): SerovalTypedArrayNode {
-    return createTypedArrayNode(id, current, this.parseTop(current.buffer));
-  }
-
-  protected parseBigIntTypedArray(
-    id: number,
-    current: BigIntTypedArrayValue,
-  ): SerovalBigIntTypedArrayNode {
-    return createBigIntTypedArrayNode(
-      id,
-      current,
-      this.parseTop(current.buffer),
-    );
-  }
-
-  protected parseDataView(id: number, current: DataView): SerovalDataViewNode {
-    return createDataViewNode(id, current, this.parseTop(current.buffer));
-  }
-
-  protected parseError(id: number, current: Error): SerovalErrorNode {
-    const options = getErrorOptions(current, this.features);
-    return createErrorNode(
-      id,
-      current,
-      options ? this.parseProperties(options) : NIL,
-    );
-  }
-
-  protected parseAggregateError(
-    id: number,
-    current: AggregateError,
-  ): SerovalAggregateErrorNode {
-    const options = getErrorOptions(current, this.features);
-    return createAggregateErrorNode(
-      id,
-      current,
-      options ? this.parseProperties(options) : NIL,
-    );
-  }
-
-  protected parseMap(
-    id: number,
-    current: Map<unknown, unknown>,
-  ): SerovalMapNode {
-    const keyNodes: SerovalNode[] = [];
-    const valueNodes: SerovalNode[] = [];
-    for (const [key, value] of current.entries()) {
-      keyNodes.push(this.parseTop(key));
-      valueNodes.push(this.parseTop(value));
-    }
-    return this.createMapNode(id, keyNodes, valueNodes, current.size);
-  }
-
-  protected parseSet(id: number, current: Set<unknown>): SerovalSetNode {
-    const items: SerovalNode[] = [];
-    for (const item of current.keys()) {
-      items.push(this.parseTop(item));
-    }
-    return createSetNode(id, current.size, items);
-  }
-
-  protected parsePlugin(
-    id: number,
-    current: unknown,
-  ): SerovalPluginNode | undefined {
-    const currentPlugins = this.plugins;
-    if (currentPlugins) {
-      for (let i = 0, len = currentPlugins.length; i < len; i++) {
-        const plugin = currentPlugins[i];
-        if (plugin.parse.sync && plugin.test(current)) {
-          return createPluginNode(
-            id,
-            plugin.tag,
-            plugin.parse.sync(current, this, {
-              id,
-            }),
-          );
-        }
-      }
-    }
-    return undefined;
-  }
-
-  protected parseStream(id: number, _current: Stream<unknown>): SerovalNode {
-    return createStreamConstructorNode(
-      id,
-      this.parseSpecialReference(SpecialReference.StreamConstructor),
-      [],
-    );
-  }
-
-  protected parsePromise(
-    id: number,
-    _current: Promise<unknown>,
-  ): SerovalPromiseConstructorNode {
-    return this.createPromiseConstructorNode(id, this.createIndex({}));
-  }
-
-  // biome-ignore lint/complexity/noExcessiveCognitiveComplexity: ehh
-  protected parseObject(id: number, current: object): SerovalNode {
-    if (Array.isArray(current)) {
-      return this.parseArray(id, current);
-    }
-    if (isStream(current)) {
-      return this.parseStream(id, current);
-    }
-    const currentClass = current.constructor;
-    if (currentClass === OpaqueReference) {
-      return this.parseTop(
-        (current as OpaqueReference<unknown, unknown>).replacement,
-      );
-    }
-    const parsed = this.parsePlugin(id, current);
-    if (parsed) {
-      return parsed;
-    }
-    switch (currentClass) {
-      case Object:
-        return this.parsePlainObject(
-          id,
-          current as Record<string, unknown>,
-          false,
-        );
-      case undefined:
-        return this.parsePlainObject(
-          id,
-          current as Record<string, unknown>,
-          true,
-        );
-      case Date:
-        return createDateNode(id, current as unknown as Date);
-      case RegExp:
-        return createRegExpNode(id, current as unknown as RegExp);
-      case Error:
-      case EvalError:
-      case RangeError:
-      case ReferenceError:
-      case SyntaxError:
-      case TypeError:
-      case URIError:
-        return this.parseError(id, current as unknown as Error);
-      case Number:
-      case Boolean:
-      case String:
-      case BigInt:
-        return this.parseBoxed(id, current);
-      case ArrayBuffer:
-        return createArrayBufferNode(id, current as unknown as ArrayBuffer);
-      case Int8Array:
-      case Int16Array:
-      case Int32Array:
-      case Uint8Array:
-      case Uint16Array:
-      case Uint32Array:
-      case Uint8ClampedArray:
-      case Float32Array:
-      case Float64Array:
-        return this.parseTypedArray(id, current as unknown as TypedArrayValue);
-      case DataView:
-        return this.parseDataView(id, current as unknown as DataView);
-      case Map:
-        return this.parseMap(id, current as unknown as Map<unknown, unknown>);
-      case Set:
-        return this.parseSet(id, current as unknown as Set<unknown>);
-      default:
-        break;
-    }
-    // Promises
-    if (currentClass === Promise || current instanceof Promise) {
-      return this.parsePromise(id, current as unknown as Promise<unknown>);
-    }
-    const currentFeatures = this.features;
-    // BigInt Typed Arrays
-    if (currentFeatures & Feature.BigIntTypedArray) {
-      switch (currentClass) {
-        case BigInt64Array:
-        case BigUint64Array:
-          return this.parseBigIntTypedArray(
-            id,
-            current as unknown as BigIntTypedArrayValue,
-          );
-        default:
-          break;
-      }
-    }
-    if (
-      currentFeatures & Feature.AggregateError &&
-      typeof AggregateError !== 'undefined' &&
-      (currentClass === AggregateError || current instanceof AggregateError)
-    ) {
-      return this.parseAggregateError(id, current as unknown as AggregateError);
-    }
-    // Slow path. We only need to handle Errors and Iterators
-    // since they have very broad implementations.
-    if (current instanceof Error) {
-      return this.parseError(id, current);
-    }
-    // Generator functions don't have a global constructor
-    // despite existing
-    if (Symbol.iterator in current || Symbol.asyncIterator in current) {
-      return this.parsePlainObject(id, current, !!currentClass);
-    }
-    throw new SerovalUnsupportedTypeError(current);
-  }
-
-  protected parseFunction(current: unknown): SerovalNode {
-    const ref = this.getReference(current);
-    if (ref.type !== ParserNodeType.Fresh) {
-      return ref.value;
-    }
-    const plugin = this.parsePlugin(ref.value, current);
-    if (plugin) {
-      return plugin;
-    }
-    throw new SerovalUnsupportedTypeError(current);
-  }
-
-  parseTop<T>(current: T): SerovalNode {
-    switch (typeof current) {
-      case 'boolean':
-        return current ? TRUE_NODE : FALSE_NODE;
-      case 'undefined':
-        return UNDEFINED_NODE;
-      case 'string':
-        return createStringNode(current as string);
-      case 'number':
-        return createNumberNode(current as number);
-      case 'bigint':
-        return createBigIntNode(current as bigint);
-      case 'object': {
-        if (current) {
-          const ref = this.getReference(current);
-          return ref.type === ParserNodeType.Fresh
-            ? this.parseObject(ref.value, current as object)
-            : ref.value;
-        }
-        return NULL_NODE;
-      }
-      case 'symbol':
-        return this.parseWellKnownSymbol(current);
-      case 'function': {
-        return this.parseFunction(current);
-      }
-      default:
-        throw new SerovalUnsupportedTypeError(current);
-    }
-  }
-
-  parse<T>(current: T): SerovalNode {
-    try {
-      return this.parseTop(current);
-    } catch (error) {
-      throw error instanceof SerovalParserError
-        ? error
-        : new SerovalParserError(error);
-    }
-  }
-}

package/src/core/cross/async.ts

@@ -1,9 +0,0 @@
-import BaseAsyncParserContext from '../context/parser/async';
-import type { SerovalMode } from '../plugin';
-import type { CrossParserContextOptions } from './parser';
-
-export type CrossAsyncParserContextOptions = CrossParserContextOptions;
-
-export default class CrossAsyncParserContext extends BaseAsyncParserContext {
-  readonly mode: SerovalMode = 'cross';
-}

package/src/core/cross/deserializer.ts

@@ -1,16 +0,0 @@
-import type { BaseDeserializerOptions } from '../context/deserializer';
-import BaseDeserializerContext from '../context/deserializer';
-import type { SerovalMode } from '../plugin';
-
-export type CrossDeserializerContextOptions = BaseDeserializerOptions;
-
-export default class CrossDeserializerContext extends BaseDeserializerContext {
-  readonly mode: SerovalMode = 'cross';
-
-  assignIndexedValue<T>(index: number, value: T): T {
-    if (!this.refs.has(index)) {
-      this.refs.set(index, value);
-    }
-    return value;
-  }
-}

package/src/core/cross/parser.ts

@@ -1,7 +0,0 @@
-import type { BaseParserContextOptions } from '../context/parser';
-
-export type CrossParserContextOptions = BaseParserContextOptions;
-
-export interface CrossContextOptions {
-  scopeId?: string;
-}

package/src/core/cross/serializer.ts

@@ -1,72 +0,0 @@
-import { SerovalNodeType } from '../constants';
-import type { BaseSerializerContextOptions } from '../context/serializer';
-import BaseSerializerContext from '../context/serializer';
-import { GLOBAL_CONTEXT_REFERENCES } from '../keys';
-import type { SerovalMode } from '../plugin';
-import { serializeString } from '../string';
-import type { SerovalNode } from '../types';
-import type { CrossContextOptions } from './parser';
-
-export interface CrossSerializerContextOptions
-  extends BaseSerializerContextOptions,
-    CrossContextOptions {}
-
-export default class CrossSerializerContext extends BaseSerializerContext {
-  readonly mode: SerovalMode = 'cross';
-
-  scopeId?: string;
-
-  constructor(options: CrossSerializerContextOptions) {
-    super(options);
-    this.scopeId = options.scopeId;
-  }
-
-  getRefParam(id: number): string {
-    return GLOBAL_CONTEXT_REFERENCES + '[' + id + ']';
-  }
-
-  protected assignIndexedValue(index: number, value: string): string {
-    // In cross-reference, we have to assume that
-    // every reference are going to be referenced
-    // in the future, and so we need to store
-    // all of it into the reference array.
-    return this.getRefParam(index) + '=' + value;
-  }
-
-  serializeTop(tree: SerovalNode): string {
-    // Get the serialized result
-    const result = this.serialize(tree);
-    // If the node is a non-reference, return
-    // the result immediately
-    const id = tree.i;
-    if (id == null) {
-      return result;
-    }
-    // Get the patches
-    const patches = this.resolvePatches();
-    // Get the variable that represents the root
-    const ref = this.getRefParam(id);
-    // Parameters needed for scoping
-    const params = this.scopeId == null ? '' : GLOBAL_CONTEXT_REFERENCES;
-    // If there are patches, append it after the result
-    const body = patches ? '(' + result + ',' + patches + ref + ')' : result;
-    // If there are no params, there's no need to generate a function
-    if (params === '') {
-      if (tree.t === SerovalNodeType.Object && !patches) {
-        return '(' + body + ')';
-      }
-      return body;
-    }
-    // Get the arguments for the IIFE
-    const args =
-      this.scopeId == null
-        ? '()'
-        : '(' +
-          GLOBAL_CONTEXT_REFERENCES +
-          '["' +
-          serializeString(this.scopeId) +
-          '"])';
-    // Create the IIFE
-    return '(' + this.createFunction([params], body) + ')' + args;
-  }
-}

package/src/core/cross/stream.ts

@@ -1,9 +0,0 @@
-import type { BaseStreamParserContextOptions } from '../context/parser/stream';
-import BaseStreamParserContext from '../context/parser/stream';
-import type { SerovalMode } from '../plugin';
-
-export type CrossStreamParserContextOptions = BaseStreamParserContextOptions;
-
-export default class CrossStreamParserContext extends BaseStreamParserContext {
-  readonly mode: SerovalMode = 'cross';
-}

package/src/core/cross/sync.ts

@@ -1,9 +0,0 @@
-import BaseSyncParserContext from '../context/parser/sync';
-import type { SerovalMode } from '../plugin';
-import type { CrossParserContextOptions } from './parser';
-
-export type CrossSyncParserContextOptions = CrossParserContextOptions;
-
-export default class CrossSyncParserContext extends BaseSyncParserContext {
-  readonly mode: SerovalMode = 'cross';
-}

package/src/core/tree/async.ts

@@ -1,9 +0,0 @@
-import type { BaseParserContextOptions } from '../context/parser';
-import BaseAsyncParserContext from '../context/parser/async';
-import type { SerovalMode } from '../plugin';
-
-export type AsyncParserContextOptions = Omit<BaseParserContextOptions, 'refs'>;
-
-export default class AsyncParserContext extends BaseAsyncParserContext {
-  readonly mode: SerovalMode = 'vanilla';
-}

package/src/core/tree/deserializer.ts

@@ -1,26 +0,0 @@
-import type { BaseDeserializerOptions } from '../context/deserializer';
-import BaseDeserializerContext from '../context/deserializer';
-import type { SerovalMode } from '../plugin';
-
-export interface VanillaDeserializerContextOptions
-  extends Omit<BaseDeserializerOptions, 'refs'> {
-  markedRefs: number[] | Set<number>;
-}
-
-export default class VanillaDeserializerContext extends BaseDeserializerContext {
-  readonly mode: SerovalMode = 'vanilla';
-
-  marked: Set<number>;
-
-  constructor(options: VanillaDeserializerContextOptions) {
-    super(options);
-    this.marked = new Set(options.markedRefs);
-  }
-
-  assignIndexedValue<T>(index: number, value: T): T {
-    if (this.marked.has(index)) {
-      this.refs.set(index, value);
-    }
-    return value;
-  }
-}

package/src/core/tree/serializer.ts

@@ -1,98 +0,0 @@
-import { SerovalNodeType } from '../constants';
-import type { BaseSerializerContextOptions } from '../context/serializer';
-import BaseSerializerContext from '../context/serializer';
-import { SerovalUnsupportedNodeError } from '../errors';
-import type { SerovalMode } from '../plugin';
-import type {
-  SerovalNode,
-  SerovalPromiseConstructorNode,
-  SerovalPromiseRejectNode,
-  SerovalPromiseResolveNode,
-} from '../types';
-import getIdentifier from '../utils/get-identifier';
-
-export type VanillaSerializerContextOptions = BaseSerializerContextOptions;
-
-export default class VanillaSerializerContext extends BaseSerializerContext {
-  readonly mode: SerovalMode = 'vanilla';
-
-  /**
-   * Map tree refs to actual refs
-   * @private
-   */
-  valid = new Map<number, number>();
-
-  /**
-   * Variables
-   * @private
-   */
-  vars: string[] = [];
-
-  /**
-   * Creates the reference param (identifier) from the given reference ID
-   * Calling this function means the value has been referenced somewhere
-   */
-  getRefParam(index: number): string {
-    /**
-     * Creates a new reference ID from a given reference ID
-     * This new reference ID means that the reference itself
-     * has been referenced at least once, and is used to generate
-     * the variables
-     */
-    let actualIndex = this.valid.get(index);
-    if (actualIndex == null) {
-      actualIndex = this.valid.size;
-      this.valid.set(index, actualIndex);
-    }
-    let identifier = this.vars[actualIndex];
-    if (identifier == null) {
-      identifier = getIdentifier(actualIndex);
-      this.vars[actualIndex] = identifier;
-    }
-    return identifier;
-  }
-
-  protected assignIndexedValue(index: number, value: string): string {
-    if (this.isMarked(index)) {
-      return this.getRefParam(index) + '=' + value;
-    }
-    return value;
-  }
-
-  protected serializePromiseConstructor(
-    node: SerovalPromiseConstructorNode,
-  ): string {
-    throw new SerovalUnsupportedNodeError(node);
-  }
-
-  protected serializePromiseResolve(node: SerovalPromiseResolveNode): string {
-    throw new SerovalUnsupportedNodeError(node);
-  }
-
-  protected serializePromiseReject(node: SerovalPromiseRejectNode): string {
-    throw new SerovalUnsupportedNodeError(node);
-  }
-
-  serializeTop(tree: SerovalNode): string {
-    const result = this.serialize(tree);
-    // Shared references detected
-    if (tree.i != null && this.vars.length) {
-      const patches = this.resolvePatches();
-      let body = result;
-      if (patches) {
-        // Get (or create) a ref from the source
-        const index = this.getRefParam(tree.i);
-        body = result + ',' + patches + index;
-        if (!result.startsWith(index + '=')) {
-          body = index + '=' + body;
-        }
-        body = '(' + body + ')';
-      }
-      return '(' + this.createFunction(this.vars, body) + ')()';
-    }
-    if (tree.t === SerovalNodeType.Object) {
-      return '(' + result + ')';
-    }
-    return result;
-  }
-}

package/src/core/tree/sync.ts

@@ -1,9 +0,0 @@
-import BaseSyncParserContext from '../context/parser/sync';
-import type { BaseParserContextOptions } from '../context/parser';
-import type { SerovalMode } from '../plugin';
-
-export type SyncParserContextOptions = Omit<BaseParserContextOptions, 'refs'>;
-
-export default class SyncParserContext extends BaseSyncParserContext {
-  readonly mode: SerovalMode = 'vanilla';
-}

package/src/core/utils/assert.ts

@@ -1,5 +0,0 @@
-export default function assert(cond: unknown, error: Error): asserts cond {
-  if (!cond) {
-    throw error;
-  }
-}