seroval 0.6.0 → 0.8.0

package/src/tree/types.ts

@@ -1,34 +1,45 @@
-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,
+  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 interface SerovalBaseNode {
@@ -37,37 +48,49 @@ export interface SerovalBaseNode {
   // Reference ID
   i: number | undefined;
   // Serialized value
-  s: any;
-  // Size/Byte offset
+  s: unknown;
+  // size/length
   l: number | undefined;
   // Constructor name / RegExp source
   c: string | undefined;
-  // message /flags
+  // 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
+  b: number | 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;
@@ -78,64 +101,39 @@ 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;
+  // id
   i: number;
 }
 
 export interface SerovalBigIntNode extends SerovalBaseNode {
   t: SerovalNodeType.BigInt;
+  // value in string
   s: string;
 }
 
 export interface SerovalDateNode extends SerovalBaseNode {
   t: SerovalNodeType.Date;
+  // id (Dates are stateful)
   i: number;
+  // value in ISO string
   s: string;
 }
 
 export interface SerovalRegExpNode extends SerovalBaseNode {
   t: SerovalNodeType.RegExp;
+  // id (RegExp are stateful)
   i: number;
   // source
   c: string;
@@ -143,20 +141,39 @@ export interface SerovalRegExpNode extends SerovalBaseNode {
   m: string;
 }
 
+export interface SerovalArrayBufferNode extends SerovalBaseNode {
+  t: SerovalNodeType.ArrayBuffer;
+  // id
+  i: number;
+  // sequence in bytes
+  s: number[];
+}
+
 export interface SerovalTypedArrayNode extends SerovalBaseNode {
   t: SerovalNodeType.TypedArray;
+  // id
   i: number;
-  s: string[];
+  // length
   l: number;
+  // TypedArray Constructor
   c: string;
+  // ArrayBuffer reference
+  f: SerovalNode;
+  // Byte Offset
+  b: number;
 }
 
 export interface SerovalBigIntTypedArrayNode extends SerovalBaseNode {
   t: SerovalNodeType.BigIntTypedArray;
   i: number;
-  s: string[];
+  // length
   l: number;
+  // TypedArray Constructor
   c: string;
+  // ArrayBuffer reference
+  f: SerovalNode;
+  // Byte Offset
+  b: number;
 }
 
 export type SerovalSemiPrimitiveNode =
@@ -168,90 +185,149 @@ export type SerovalSemiPrimitiveNode =
 
 export interface SerovalSetNode extends SerovalBaseNode {
   t: SerovalNodeType.Set;
+  // id
+  i: number;
+  // Size of Set
   l: number;
+  // Items in Set (as array)
   a: SerovalNode[];
-  i: number;
 }
 
 export interface SerovalMapNode extends SerovalBaseNode {
   t: SerovalNodeType.Map;
-  d: SerovalMapRecordNode;
   i: number;
+  // key/value pairs
+  d: SerovalMapRecordNode;
 }
 
 export interface SerovalArrayNode extends SerovalBaseNode {
   t: SerovalNodeType.Array;
+  // size of array
   l: number;
-  a: SerovalNode[];
+  // items
+  a: (SerovalNode | undefined)[];
   i: number;
 }
 
 export interface SerovalObjectNode extends SerovalBaseNode {
   t: SerovalNodeType.Object;
+  // key/value pairs
   d: SerovalObjectRecordNode;
   i: number;
 }
 
 export interface SerovalNullConstructorNode extends SerovalBaseNode {
   t: SerovalNodeType.NullConstructor;
+  // key/value pairs
   d: SerovalObjectRecordNode;
   i: number;
 }
 
 export interface SerovalPromiseNode extends SerovalBaseNode {
   t: SerovalNodeType.Promise;
+  // resolved value
   f: SerovalNode;
   i: number;
 }
 
 export interface SerovalErrorNode extends SerovalBaseNode {
   t: SerovalNodeType.Error;
+  // constructor name
   c: string;
+  // message
   m: string;
+  // other properties
   d: SerovalObjectRecordNode | undefined;
   i: number;
 }
 
 export interface SerovalAggregateErrorNode extends SerovalBaseNode {
   t: SerovalNodeType.AggregateError;
-  m: string;
-  d: SerovalObjectRecordNode | undefined;
-  l: number;
-  a: SerovalNode[];
   i: number;
-}
-
-export interface SerovalIterableNode extends SerovalBaseNode {
-  t: SerovalNodeType.Iterable;
+  // message
+  m: string;
+  // other properties
   d: SerovalObjectRecordNode | undefined;
-  l: number;
-  a: SerovalNode[];
-  i: number;
 }
 
 export interface SerovalWKSymbolNode extends SerovalBaseNode {
   t: SerovalNodeType.WKSymbol;
+  i: number;
   s: Symbols;
 }
 
 export interface SerovalURLNode extends SerovalBaseNode {
   t: SerovalNodeType.URL;
   i: number;
+  // raw URL
   s: string;
 }
 
 export interface SerovalURLSearchParamsNode extends SerovalBaseNode {
   t: SerovalNodeType.URLSearchParams;
   i: number;
+  // raw URL search params
   s: string;
 }
 
 export interface SerovalReferenceNode extends SerovalBaseNode {
   t: SerovalNodeType.Reference;
   i: number;
+  // id of the reference in the map
   s: string;
 }
 
+export interface SerovalDataViewNode extends SerovalBaseNode {
+  t: SerovalNodeType.DataView;
+  i: number;
+  // byte length
+  l: number;
+  // reference to array buffer
+  f: SerovalNode;
+  // byte offset
+  b: number;
+}
+
+export interface SerovalBlobNode extends SerovalBaseNode {
+  t: SerovalNodeType.Blob;
+  i: number;
+  // file type
+  c: string;
+  // reference to array buffer
+  f: SerovalNode;
+}
+
+export interface SerovalFileNode extends SerovalBaseNode {
+  t: SerovalNodeType.File;
+  i: number;
+  // file type
+  c: string;
+  // file name
+  m: string;
+  // reference to array buffer
+  f: SerovalNode;
+  // last modified
+  b: number;
+}
+
+export interface SerovalHeadersNode extends SerovalBaseNode {
+  t: SerovalNodeType.Headers;
+  i: number;
+  d: SerovalPlainRecordNode;
+}
+
+export interface SerovalFormDataNode extends SerovalBaseNode {
+  t: SerovalNodeType.FormData;
+  i: number;
+  d: SerovalPlainRecordNode;
+}
+
+export interface SerovalBoxedNode extends SerovalBaseNode {
+  t: SerovalNodeType.Boxed;
+  i: number;
+  f: SerovalNode;
+}
+
 export type SerovalNode =
   | SerovalPrimitiveNode
   | SerovalIndexedValueNode
@@ -264,8 +340,14 @@ export type SerovalNode =
   | SerovalPromiseNode
   | SerovalErrorNode
   | SerovalAggregateErrorNode
-  | SerovalIterableNode
   | SerovalWKSymbolNode
   | SerovalURLNode
   | SerovalURLSearchParamsNode
-  | SerovalReferenceNode;
+  | SerovalReferenceNode
+  | SerovalArrayBufferNode
+  | SerovalDataViewNode
+  | SerovalBlobNode
+  | SerovalFileNode
+  | SerovalHeadersNode
+  | SerovalFormDataNode
+  | SerovalBoxedNode;

package/src/tree/web-api.ts

@@ -1,24 +1,36 @@
 import assert from '../assert';
 import { Feature } from '../compat';
-import { ParserContext } from '../context';
-import { SerovalNodeType, SerovalURLNode, SerovalURLSearchParamsNode } from './types';
+import type { ParserContext } from '../context';
+import { serializeString } from '../string';
+import UnsupportedTypeError from './UnsupportedTypeError';
+import { serializeArrayBuffer } from './primitives';
+import type {
+  SerovalBlobNode,
+  SerovalFileNode,
+  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,
-    s: current.href,
+    s: serializeString(current.href),
     l: undefined,
     c: undefined,
     m: undefined,
     d: undefined,
     f: undefined,
     a: undefined,
+    b: undefined,
   };
 }
 
@@ -27,16 +39,57 @@ 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,
-    s: current.toString(),
+    s: serializeString(current.toString()),
     l: undefined,
     c: undefined,
     m: undefined,
     d: undefined,
     f: undefined,
     a: undefined,
+    b: undefined,
+  };
+}
+
+export async function createBlobNode(
+  ctx: ParserContext,
+  id: number,
+  current: Blob,
+): Promise<SerovalBlobNode> {
+  assert(ctx.features & Feature.WebAPI, new UnsupportedTypeError(current));
+  return {
+    t: SerovalNodeType.Blob,
+    i: id,
+    s: undefined,
+    l: undefined,
+    c: serializeString(current.type),
+    m: undefined,
+    d: undefined,
+    f: serializeArrayBuffer(ctx, await current.arrayBuffer()),
+    a: undefined,
+    b: undefined,
+  };
+}
+
+export async function createFileNode(
+  ctx: ParserContext,
+  id: number,
+  current: File,
+): Promise<SerovalFileNode> {
+  assert(ctx.features & Feature.WebAPI, new UnsupportedTypeError(current));
+  return {
+    t: SerovalNodeType.File,
+    i: id,
+    s: undefined,
+    l: undefined,
+    c: serializeString(current.type),
+    m: serializeString(current.name),
+    d: undefined,
+    f: serializeArrayBuffer(ctx, await current.arrayBuffer()),
+    a: undefined,
+    b: current.lastModified,
   };
 }

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/dist/types/quote.d.ts

@@ -1,2 +0,0 @@
-export default function quote(str: string): string;
-export declare function invQuote(str: string): string;

package/src/quote.ts

@@ -1,56 +0,0 @@
-// Written by https://github.com/DylanPiercey and is distributed under the MIT license.
-// Creates a JavaScript double quoted string and escapes all characters
-// not listed as DoubleStringCharacters on
-// Also includes "<" to escape "</script>" and "\" to avoid invalid escapes in the output.
-// http://www.ecma-international.org/ecma-262/5.1/#sec-7.8.4
-export default function quote(str: string) {
-  let result = '';
-  let lastPos = 0;
-  for (let i = 0, len = str.length; i < len; i++) {
-    let replacement;
-    switch (str[i]) {
-      case '"':
-        replacement = '\\"';
-        break;
-      case '\\':
-        replacement = '\\\\';
-        break;
-      case '<':
-        replacement = '\\x3C';
-        break;
-      case '\n':
-        replacement = '\\n';
-        break;
-      case '\r':
-        replacement = '\\r';
-        break;
-      case '\u2028':
-        replacement = '\\u2028';
-        break;
-      case '\u2029':
-        replacement = '\\u2029';
-        break;
-      default:
-        continue;
-    }
-    result += str.slice(lastPos, i) + replacement;
-    lastPos = i + 1;
-  }
-  if (lastPos === 0) {
-    result = str;
-  } else {
-    result += str.slice(lastPos);
-  }
-  return result;
-}
-
-export function invQuote(str: string): string {
-  return str
-    .replace(/\\"/g, '"')
-    .replace(/\\\\/g, '\\')
-    .replace(/\\x3C/g, '<')
-    .replace(/\\n/g, '\n')
-    .replace(/\\r/g, '\r')
-    .replace(/\\u2028/g, '\u2028')
-    .replace(/\\u2029/g, '\u2029');
-}