seroval 0.5.1 → 0.7.0

package/src/tree/types.ts

@@ -11,7 +11,7 @@ export const enum SerovalNodeType {
   NegativeInfinity,
   NaN,
   BigInt,
-  Reference,
+  IndexedValue,
   Date,
   RegExp,
   Set,
@@ -26,6 +26,15 @@ export const enum SerovalNodeType {
   TypedArray,
   BigIntTypedArray,
   WKSymbol,
+  URL,
+  URLSearchParams,
+  Reference,
+  ArrayBuffer,
+  DataView,
+  Blob,
+  File,
+  Headers,
+  FormData,
 }
 
 export interface SerovalBaseNode {
@@ -35,11 +44,11 @@ export interface SerovalBaseNode {
   i: number | undefined;
   // Serialized value
   s: any;
-  // Size/Byte offset
+  // size/length
   l: number | undefined;
   // Constructor name / RegExp source
   c: string | undefined;
-  // message /flags
+  // message/flags
   m: string | undefined;
   // dictionary
   d: SerovalDictionaryNode | undefined;
@@ -47,6 +56,8 @@ export interface SerovalBaseNode {
   a: SerovalNode[] | undefined;
   // fulfilled node
   f: SerovalNode | undefined;
+  // byte offset
+  b: number | undefined;
 }
 
 export interface SerovalObjectRecordNode {
@@ -115,24 +126,29 @@ export type SerovalPrimitiveNode =
   | SerovalInfinityNode
   | SerovalNaNNode;
 
-export interface SerovalReferenceNode extends SerovalBaseNode {
-  t: SerovalNodeType.Reference;
+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;
@@ -140,20 +156,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 =
@@ -165,63 +200,78 @@ 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;
+  // items
   a: SerovalNode[];
   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;
+  i: number;
+  // message
   m: string;
+  // other properties
   d: SerovalObjectRecordNode | undefined;
-  l: number;
-  a: SerovalNode[];
-  i: number;
 }
 
 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;
 }
@@ -231,9 +281,75 @@ export interface SerovalWKSymbolNode extends SerovalBaseNode {
   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: SerovalObjectRecordNode;
+}
+
+export interface SerovalFormDataNode extends SerovalBaseNode {
+  t: SerovalNodeType.FormData;
+  i: number;
+  d: SerovalObjectRecordNode;
+}
+
 export type SerovalNode =
   | SerovalPrimitiveNode
-  | SerovalReferenceNode
+  | SerovalIndexedValueNode
   | SerovalSemiPrimitiveNode
   | SerovalSetNode
   | SerovalMapNode
@@ -244,4 +360,13 @@ export type SerovalNode =
   | SerovalErrorNode
   | SerovalAggregateErrorNode
   | SerovalIterableNode
-  | SerovalWKSymbolNode;
+  | SerovalWKSymbolNode
+  | SerovalURLNode
+  | SerovalURLSearchParamsNode
+  | SerovalReferenceNode
+  | SerovalArrayBufferNode
+  | SerovalDataViewNode
+  | SerovalBlobNode
+  | SerovalFileNode
+  | SerovalHeadersNode
+  | SerovalFormDataNode;

package/src/tree/web-api.ts

@@ -0,0 +1,92 @@
+import assert from '../assert';
+import { Feature } from '../compat';
+import { ParserContext } from '../context';
+import { serializeString } from '../string';
+import { serializeArrayBuffer } from './primitives';
+import {
+  SerovalBlobNode,
+  SerovalFileNode,
+  SerovalNodeType,
+  SerovalURLNode,
+  SerovalURLSearchParamsNode,
+} from './types';
+
+export function createURLNode(
+  ctx: ParserContext,
+  id: number,
+  current: URL,
+): SerovalURLNode {
+  assert(ctx.features & Feature.WebAPI, 'Unsupported type "URL"');
+  return {
+    t: SerovalNodeType.URL,
+    i: id,
+    s: serializeString(current.href),
+    l: undefined,
+    c: undefined,
+    m: undefined,
+    d: undefined,
+    f: undefined,
+    a: undefined,
+    b: undefined,
+  };
+}
+
+export function createURLSearchParamsNode(
+  ctx: ParserContext,
+  id: number,
+  current: URLSearchParams,
+): SerovalURLSearchParamsNode {
+  assert(ctx.features & Feature.WebAPI, 'Unsupported type "URLSearchParams"');
+  return {
+    t: SerovalNodeType.URLSearchParams,
+    i: id,
+    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, 'Unsupported type "Blob"');
+  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, 'Unsupported type "File"');
+  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

@@ -34,12 +34,17 @@ export type BigIntTypedArrayValue =
   | BigInt64Array
   | BigUint64Array;
 
+export type WebAPIValue =
+  | URL
+  | URLSearchParams;
+
 export type SemiPrimitiveValue =
   | RegExp
   | Date
   | TypedArrayValue
   | BigIntTypedArrayValue
-  | bigint;
+  | bigint
+  | WebAPIValue;
 
 export type CommonServerValue =
   | 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;