seroval 0.7.0 → 0.9.0

package/src/tree/types.ts

@@ -1,40 +1,52 @@
-import { Symbols } from './symbols';
+import type { Symbols } from './symbols';
+
+export const enum SerovalConstant {
+  Null = 0,
+  Undefined = 1,
+  True = 2,
+  False = 3,
+  NegativeZero = 4,
+  Infinity = 5,
+  NegativeInfinity = 6,
+  NaN = 7,
+}
 
 export const enum SerovalNodeType {
-  Number,
-  String,
-  Boolean,
-  Null,
-  Undefined,
-  NegativeZero,
-  Infinity,
-  NegativeInfinity,
-  NaN,
-  BigInt,
-  IndexedValue,
-  Date,
-  RegExp,
-  Set,
-  Map,
-  Array,
-  Object,
-  NullConstructor,
-  Promise,
-  Error,
-  AggregateError,
-  Iterable,
-  TypedArray,
-  BigIntTypedArray,
-  WKSymbol,
-  URL,
-  URLSearchParams,
-  Reference,
-  ArrayBuffer,
-  DataView,
-  Blob,
-  File,
-  Headers,
-  FormData,
+  Number = 0,
+  String = 1,
+  Constant = 2,
+  BigInt = 3,
+  IndexedValue = 4,
+  Date = 5,
+  RegExp = 6,
+  Set = 7,
+  Map = 8,
+  Array = 9,
+  Object = 10,
+  NullConstructor = 11,
+  Promise = 12,
+  Error = 13,
+  AggregateError = 14,
+  TypedArray = 15,
+  BigIntTypedArray = 16,
+  WKSymbol = 17,
+  URL = 18,
+  URLSearchParams = 19,
+  Reference = 20,
+  ArrayBuffer = 21,
+  DataView = 22,
+  Blob = 23,
+  File = 24,
+  Headers = 25,
+  FormData = 26,
+  Boxed = 27,
+}
+
+export const enum SerovalObjectFlags {
+  None = 0,
+  NonExtensible = 1,
+  Sealed = 2,
+  Frozen = 3,
 }
 
 export interface SerovalBaseNode {
@@ -43,7 +55,7 @@ export interface SerovalBaseNode {
   // Reference ID
   i: number | undefined;
   // Serialized value
-  s: any;
+  s: unknown;
   // size/length
   l: number | undefined;
   // Constructor name / RegExp source
@@ -51,31 +63,43 @@ export interface SerovalBaseNode {
   // message/flags
   m: string | undefined;
   // dictionary
-  d: SerovalDictionaryNode | undefined;
+  d: SerovalObjectRecordNode | SerovalMapRecordNode | undefined;
   // array of nodes
-  a: SerovalNode[] | undefined;
+  a: (SerovalNode | undefined)[] | undefined;
   // fulfilled node
   f: SerovalNode | undefined;
-  // byte offset
+  // byte offset/object flags
   b: number | undefined;
+  // object flag
+  o: SerovalObjectFlags | undefined;
 }
 
-export interface SerovalObjectRecordNode {
+export const enum SerovalObjectRecordSpecialKey {
+  SymbolIterator = 0,
+}
+
+export type SerovalObjectRecordKey =
+  | string
+  | SerovalObjectRecordSpecialKey;
+
+export interface SerovalPlainRecordNode {
   k: string[];
   v: SerovalNode[];
   s: number;
 }
 
+export interface SerovalObjectRecordNode {
+  k: SerovalObjectRecordKey[];
+  v: SerovalNode[];
+  s: number;
+}
+
 export interface SerovalMapRecordNode {
   k: SerovalNode[];
   v: SerovalNode[];
   s: number;
 }
 
-export type SerovalDictionaryNode =
-  | SerovalObjectRecordNode
-  | SerovalMapRecordNode;
-
 export interface SerovalNumberNode extends SerovalBaseNode {
   t: SerovalNodeType.Number;
   s: number;
@@ -86,45 +110,15 @@ export interface SerovalStringNode extends SerovalBaseNode {
   s: string;
 }
 
-export interface SerovalBooleanNode extends SerovalBaseNode {
-  t: SerovalNodeType.Boolean;
-  s: boolean;
-}
-
-export interface SerovalNullNode extends SerovalBaseNode {
-  t: SerovalNodeType.Null;
-}
-
-export interface SerovalUndefinedNode extends SerovalBaseNode {
-  t: SerovalNodeType.Undefined;
-}
-
-export interface SerovalNegativeZeroNode extends SerovalBaseNode {
-  t: SerovalNodeType.NegativeZero;
-}
-
-export interface SerovalInfinityNode extends SerovalBaseNode {
-  t: SerovalNodeType.Infinity;
-}
-
-export interface SerovalNegativeInfinityNode extends SerovalBaseNode {
-  t: SerovalNodeType.NegativeInfinity;
-}
-
-export interface SerovalNaNNode extends SerovalBaseNode {
-  t: SerovalNodeType.NaN;
+export interface SerovalConstantNode extends SerovalBaseNode {
+  t: SerovalNodeType.Constant;
+  s: SerovalConstant;
 }
 
 export type SerovalPrimitiveNode =
   | SerovalNumberNode
   | SerovalStringNode
-  | SerovalBooleanNode
-  | SerovalNullNode
-  | SerovalUndefinedNode
-  | SerovalNegativeZeroNode
-  | SerovalNegativeInfinityNode
-  | SerovalInfinityNode
-  | SerovalNaNNode;
+  | SerovalConstantNode;
 
 export interface SerovalIndexedValueNode extends SerovalBaseNode {
   t: SerovalNodeType.IndexedValue;
@@ -220,8 +214,9 @@ export interface SerovalArrayNode extends SerovalBaseNode {
   // size of array
   l: number;
   // items
-  a: SerovalNode[];
+  a: (SerovalNode | undefined)[];
   i: number;
+  o: SerovalObjectFlags;
 }
 
 export interface SerovalObjectNode extends SerovalBaseNode {
@@ -229,6 +224,7 @@ export interface SerovalObjectNode extends SerovalBaseNode {
   // key/value pairs
   d: SerovalObjectRecordNode;
   i: number;
+  o: SerovalObjectFlags;
 }
 
 export interface SerovalNullConstructorNode extends SerovalBaseNode {
@@ -236,6 +232,7 @@ export interface SerovalNullConstructorNode extends SerovalBaseNode {
   // key/value pairs
   d: SerovalObjectRecordNode;
   i: number;
+  o: SerovalObjectFlags;
 }
 
 export interface SerovalPromiseNode extends SerovalBaseNode {
@@ -265,19 +262,9 @@ export interface SerovalAggregateErrorNode extends SerovalBaseNode {
   d: SerovalObjectRecordNode | undefined;
 }
 
-export interface SerovalIterableNode extends SerovalBaseNode {
-  t: SerovalNodeType.Iterable;
-  // other properties
-  d: SerovalObjectRecordNode | undefined;
-  // number of emitted items
-  l: number;
-  // array of items
-  a: SerovalNode[];
-  i: number;
-}
-
 export interface SerovalWKSymbolNode extends SerovalBaseNode {
   t: SerovalNodeType.WKSymbol;
+  i: number;
   s: Symbols;
 }
 
@@ -338,13 +325,19 @@ export interface SerovalFileNode extends SerovalBaseNode {
 export interface SerovalHeadersNode extends SerovalBaseNode {
   t: SerovalNodeType.Headers;
   i: number;
-  d: SerovalObjectRecordNode;
+  d: SerovalPlainRecordNode;
 }
 
 export interface SerovalFormDataNode extends SerovalBaseNode {
   t: SerovalNodeType.FormData;
   i: number;
-  d: SerovalObjectRecordNode;
+  d: SerovalPlainRecordNode;
+}
+
+export interface SerovalBoxedNode extends SerovalBaseNode {
+  t: SerovalNodeType.Boxed;
+  i: number;
+  f: SerovalNode;
 }
 
 export type SerovalNode =
@@ -359,7 +352,6 @@ export type SerovalNode =
   | SerovalPromiseNode
   | SerovalErrorNode
   | SerovalAggregateErrorNode
-  | SerovalIterableNode
   | SerovalWKSymbolNode
   | SerovalURLNode
   | SerovalURLSearchParamsNode
@@ -369,4 +361,5 @@ export type SerovalNode =
   | SerovalBlobNode
   | SerovalFileNode
   | SerovalHeadersNode
-  | SerovalFormDataNode;
+  | SerovalFormDataNode
+  | SerovalBoxedNode;

package/src/tree/web-api.ts

@@ -1,22 +1,25 @@
 import assert from '../assert';
 import { Feature } from '../compat';
-import { ParserContext } from '../context';
+import type { ParserContext } from '../context';
 import { serializeString } from '../string';
+import UnsupportedTypeError from './UnsupportedTypeError';
 import { serializeArrayBuffer } from './primitives';
-import {
+import type {
   SerovalBlobNode,
   SerovalFileNode,
-  SerovalNodeType,
   SerovalURLNode,
   SerovalURLSearchParamsNode,
 } from './types';
+import {
+  SerovalNodeType,
+} from './types';
 
 export function createURLNode(
   ctx: ParserContext,
   id: number,
   current: URL,
 ): SerovalURLNode {
-  assert(ctx.features & Feature.WebAPI, 'Unsupported type "URL"');
+  assert(ctx.features & Feature.WebAPI, new UnsupportedTypeError(current));
   return {
     t: SerovalNodeType.URL,
     i: id,
@@ -28,6 +31,7 @@ export function createURLNode(
     f: undefined,
     a: undefined,
     b: undefined,
+    o: undefined,
   };
 }
 
@@ -36,7 +40,7 @@ export function createURLSearchParamsNode(
   id: number,
   current: URLSearchParams,
 ): SerovalURLSearchParamsNode {
-  assert(ctx.features & Feature.WebAPI, 'Unsupported type "URLSearchParams"');
+  assert(ctx.features & Feature.WebAPI, new UnsupportedTypeError(current));
   return {
     t: SerovalNodeType.URLSearchParams,
     i: id,
@@ -48,6 +52,7 @@ export function createURLSearchParamsNode(
     f: undefined,
     a: undefined,
     b: undefined,
+    o: undefined,
   };
 }
 
@@ -56,7 +61,7 @@ export async function createBlobNode(
   id: number,
   current: Blob,
 ): Promise<SerovalBlobNode> {
-  assert(ctx.features & Feature.WebAPI, 'Unsupported type "Blob"');
+  assert(ctx.features & Feature.WebAPI, new UnsupportedTypeError(current));
   return {
     t: SerovalNodeType.Blob,
     i: id,
@@ -68,6 +73,7 @@ export async function createBlobNode(
     f: serializeArrayBuffer(ctx, await current.arrayBuffer()),
     a: undefined,
     b: undefined,
+    o: undefined,
   };
 }
 
@@ -76,7 +82,7 @@ export async function createFileNode(
   id: number,
   current: File,
 ): Promise<SerovalFileNode> {
-  assert(ctx.features & Feature.WebAPI, 'Unsupported type "File"');
+  assert(ctx.features & Feature.WebAPI, new UnsupportedTypeError(current));
   return {
     t: SerovalNodeType.File,
     i: id,
@@ -88,5 +94,6 @@ export async function createFileNode(
     f: serializeArrayBuffer(ctx, await current.arrayBuffer()),
     a: undefined,
     b: current.lastModified,
+    o: undefined,
   };
 }

package/src/types.ts

@@ -1,4 +1,4 @@
-import { WellKnownSymbols } from './tree/symbols';
+import type { WellKnownSymbols } from './tree/symbols';
 
 // Values that are non-recursive
 export type PrimitiveValue =
@@ -36,11 +36,15 @@ export type BigIntTypedArrayValue =
 
 export type WebAPIValue =
   | URL
-  | URLSearchParams;
+  | URLSearchParams
+  | Blob
+  | File;
 
 export type SemiPrimitiveValue =
   | RegExp
   | Date
+  | ArrayBuffer
+  | DataView
   | TypedArrayValue
   | BigIntTypedArrayValue
   | bigint
@@ -70,7 +74,7 @@ export type AsyncServerValue =
   | { readonly [key: string | number]: AsyncServerValue }
   | Set<AsyncServerValue>
   | Map<AsyncServerValue, AsyncServerValue>
-  | PromiseLike<AsyncServerValue>;
+  | Promise<AsyncServerValue>;
 
 export type NonPrimitiveServerValue<T> =
   T extends PrimitiveValue

package/src/tree/iterator.ts

@@ -1,14 +0,0 @@
-export default function createIterator<T>(
-  values: Array<T>,
-): Iterator<T> {
-  let index = 0;
-  const len = values.length;
-  return {
-    next() {
-      return {
-        value: values[index++],
-        done: index >= len,
-      };
-    },
-  };
-}