turbo-stream 1.2.1 → 2.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2018-19 [these people](https://github.com/rich-harris/devalue/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/flatten.js

@@ -9,11 +9,13 @@ function flatten(input) {
         return existing;
     if (input === undefined)
         return utils_js_1.UNDEFINED;
+    if (input === null)
+        return utils_js_1.NULL;
     if (Number.isNaN(input))
         return utils_js_1.NAN;
-    if (input === Infinity)
+    if (input === Number.POSITIVE_INFINITY)
         return utils_js_1.POSITIVE_INFINITY;
-    if (input === -Infinity)
+    if (input === Number.NEGATIVE_INFINITY)
         return utils_js_1.NEGATIVE_INFINITY;
     if (input === 0 && 1 / input < 0)
         return utils_js_1.NEGATIVE_ZERO;
@@ -38,15 +40,16 @@ function stringify(input, index) {
         case "bigint":
             str[index] = `["${utils_js_1.TYPE_BIGINT}","${input}"]`;
             break;
-        case "symbol":
+        case "symbol": {
             const keyFor = Symbol.keyFor(input);
             if (!keyFor)
                 throw new Error("Cannot encode symbol unless created with Symbol.for()");
             str[index] = `["${utils_js_1.TYPE_SYMBOL}",${JSON.stringify(keyFor)}]`;
             break;
-        case "object":
+        }
+        case "object": {
             if (!input) {
-                str[index] = "null";
+                str[index] = `${utils_js_1.NULL}`;
                 break;
             }
             const isArray = Array.isArray(input);
@@ -59,8 +62,9 @@ function stringify(input, index) {
                         const [pluginIdentifier, ...rest] = pluginResult;
                         str[index] = `[${JSON.stringify(pluginIdentifier)}`;
                         if (rest.length > 0) {
-                            str[index] +=
-                                "," + rest.map((v) => flatten.call(this, v)).join(",");
+                            str[index] += `,${rest
+                                .map((v) => flatten.call(this, v))
+                                .join(",")}`;
                         }
                         str[index] += "]";
                         break;
@@ -74,7 +78,7 @@ function stringify(input, index) {
                         result +=
                             (i ? "," : "") +
                                 (i in input ? flatten.call(this, input[i]) : utils_js_1.HOLE);
-                    str[index] = result + "]";
+                    str[index] = `${result}]`;
                 }
                 else if (input instanceof Date) {
                     str[index] = `["${utils_js_1.TYPE_DATE}",${input.getTime()}]`;
@@ -117,6 +121,7 @@ function stringify(input, index) {
                 }
             }
             break;
+        }
         default:
             throw new Error("Cannot encode function or unexpected type");
     }

package/dist/turbo-stream.d.ts

@@ -1,7 +1,12 @@
 import { type DecodePlugin, type EncodePlugin } from "./utils.js";
 export type { DecodePlugin, EncodePlugin };
-export declare function decode(readable: ReadableStream<Uint8Array>, plugins?: DecodePlugin[]): Promise<{
+export declare function decode(readable: ReadableStream<Uint8Array>, options?: {
+    plugins?: DecodePlugin[];
+}): Promise<{
     done: Promise<undefined>;
     value: unknown;
 }>;
-export declare function encode(input: unknown, plugins?: EncodePlugin[]): ReadableStream<Uint8Array>;
+export declare function encode(input: unknown, options?: {
+    plugins?: EncodePlugin[];
+    signal?: AbortSignal;
+}): ReadableStream<Uint8Array>;

package/dist/turbo-stream.js

@@ -4,7 +4,8 @@ exports.encode = exports.decode = void 0;
 const flatten_js_1 = require("./flatten.js");
 const unflatten_js_1 = require("./unflatten.js");
 const utils_js_1 = require("./utils.js");
-async function decode(readable, plugins) {
+async function decode(readable, options) {
+    const { plugins } = options ?? {};
     const done = new utils_js_1.Deferred();
     const reader = readable
         .pipeThrough((0, utils_js_1.createLineSplittingTransform)())
@@ -105,13 +106,15 @@ async function decodeDeferred(reader) {
         read = await reader.read();
     }
 }
-function encode(input, plugins) {
+function encode(input, options) {
+    const { plugins, signal } = options ?? {};
     const encoder = {
         deferred: {},
         index: 0,
         indices: new Map(),
         stringified: [],
         plugins,
+        signal,
     };
     const textEncoder = new TextEncoder();
     let lastSentIndex = 0;
@@ -130,7 +133,7 @@ function encode(input, plugins) {
                 for (const [deferredId, deferred] of Object.entries(encoder.deferred)) {
                     if (seenPromises.has(deferred))
                         continue;
-                    seenPromises.add((encoder.deferred[Number(deferredId)] = deferred
+                    seenPromises.add((encoder.deferred[Number(deferredId)] = raceSignal(deferred, encoder.signal)
                         .then((resolved) => {
                         const id = flatten_js_1.flatten.call(encoder, resolved);
                         if (id < 0) {
@@ -174,3 +177,17 @@ function encode(input, plugins) {
     return readable;
 }
 exports.encode = encode;
+function raceSignal(promise, signal) {
+    if (!signal)
+        return promise;
+    if (signal.aborted)
+        return Promise.reject(signal.reason || new Error("Signal was aborted."));
+    const abort = new Promise((resolve, reject) => {
+        signal.addEventListener("abort", (event) => {
+            reject(signal.reason || new Error("Signal was aborted."));
+        });
+        promise.then(resolve).catch(reject);
+    });
+    abort.catch(() => { });
+    return Promise.race([abort, promise]);
+}

package/dist/turbo-stream.mjs

@@ -1,10 +1,11 @@
 // src/utils.ts
 var HOLE = -1;
 var NAN = -2;
-var NEGATIVE_INFINITY = -4;
-var NEGATIVE_ZERO = -5;
-var POSITIVE_INFINITY = -3;
-var UNDEFINED = -1;
+var NEGATIVE_INFINITY = -3;
+var NEGATIVE_ZERO = -4;
+var NULL = -5;
+var POSITIVE_INFINITY = -6;
+var UNDEFINED = -7;
 var TYPE_BIGINT = "B";
 var TYPE_DATE = "D";
 var TYPE_ERROR = "E";
@@ -27,12 +28,12 @@ var Deferred = class {
   }
 };
 function createLineSplittingTransform() {
-  let decoder = new TextDecoder();
+  const decoder = new TextDecoder();
   let leftover = "";
   return new TransformStream({
     transform(chunk, controller) {
-      let str = decoder.decode(chunk, { stream: true });
-      let parts = (leftover + str).split("\n");
+      const str = decoder.decode(chunk, { stream: true });
+      const parts = (leftover + str).split("\n");
       leftover = parts.pop() || "";
       for (const part of parts) {
         controller.enqueue(part);
@@ -54,11 +55,13 @@ function flatten(input) {
     return existing;
   if (input === void 0)
     return UNDEFINED;
+  if (input === null)
+    return NULL;
   if (Number.isNaN(input))
     return NAN;
-  if (input === Infinity)
+  if (input === Number.POSITIVE_INFINITY)
     return POSITIVE_INFINITY;
-  if (input === -Infinity)
+  if (input === Number.NEGATIVE_INFINITY)
     return NEGATIVE_INFINITY;
   if (input === 0 && 1 / input < 0)
     return NEGATIVE_ZERO;
@@ -80,7 +83,7 @@ function stringify(input, index) {
     case "bigint":
       str[index] = `["${TYPE_BIGINT}","${input}"]`;
       break;
-    case "symbol":
+    case "symbol": {
       const keyFor = Symbol.keyFor(input);
       if (!keyFor)
         throw new Error(
@@ -88,9 +91,10 @@ function stringify(input, index) {
         );
       str[index] = `["${TYPE_SYMBOL}",${JSON.stringify(keyFor)}]`;
       break;
-    case "object":
+    }
+    case "object": {
       if (!input) {
-        str[index] = "null";
+        str[index] = `${NULL}`;
         break;
       }
       const isArray = Array.isArray(input);
@@ -103,7 +107,7 @@ function stringify(input, index) {
             const [pluginIdentifier, ...rest] = pluginResult;
             str[index] = `[${JSON.stringify(pluginIdentifier)}`;
             if (rest.length > 0) {
-              str[index] += "," + rest.map((v) => flatten.call(this, v)).join(",");
+              str[index] += `,${rest.map((v) => flatten.call(this, v)).join(",")}`;
             }
             str[index] += "]";
             break;
@@ -115,7 +119,7 @@ function stringify(input, index) {
         if (isArray) {
           for (let i = 0; i < input.length; i++)
             result += (i ? "," : "") + (i in input ? flatten.call(this, input[i]) : HOLE);
-          str[index] = result + "]";
+          str[index] = `${result}]`;
         } else if (input instanceof Date) {
           str[index] = `["${TYPE_DATE}",${input.getTime()}]`;
         } else if (input instanceof URL) {
@@ -146,6 +150,7 @@ function stringify(input, index) {
         }
       }
       break;
+    }
     default:
       throw new Error("Cannot encode function or unexpected type");
   }
@@ -174,6 +179,8 @@ function hydrate(index) {
   switch (index) {
     case UNDEFINED:
       return;
+    case NULL:
+      return null;
     case NAN:
       return NaN;
     case POSITIVE_INFINITY:
@@ -272,7 +279,8 @@ function hydrate(index) {
 }
 
 // src/turbo-stream.ts
-async function decode(readable, plugins) {
+async function decode(readable, options) {
+  const { plugins } = options ?? {};
   const done = new Deferred();
   const reader = readable.pipeThrough(createLineSplittingTransform()).getReader();
   const decoder = {
@@ -363,13 +371,15 @@ async function decodeDeferred(reader) {
     read = await reader.read();
   }
 }
-function encode(input, plugins) {
+function encode(input, options) {
+  const { plugins, signal } = options ?? {};
   const encoder = {
     deferred: {},
     index: 0,
     indices: /* @__PURE__ */ new Map(),
     stringified: [],
-    plugins
+    plugins,
+    signal
   };
   const textEncoder = new TextEncoder();
   let lastSentIndex = 0;
@@ -392,7 +402,10 @@ function encode(input, plugins) {
           if (seenPromises.has(deferred))
             continue;
           seenPromises.add(
-            encoder.deferred[Number(deferredId)] = deferred.then(
+            encoder.deferred[Number(deferredId)] = raceSignal(
+              deferred,
+              encoder.signal
+            ).then(
               (resolved) => {
                 const id2 = flatten.call(encoder, resolved);
                 if (id2 < 0) {
@@ -445,6 +458,21 @@ function encode(input, plugins) {
   });
   return readable;
 }
+function raceSignal(promise, signal) {
+  if (!signal)
+    return promise;
+  if (signal.aborted)
+    return Promise.reject(signal.reason || new Error("Signal was aborted."));
+  const abort = new Promise((resolve, reject) => {
+    signal.addEventListener("abort", (event) => {
+      reject(signal.reason || new Error("Signal was aborted."));
+    });
+    promise.then(resolve).catch(reject);
+  });
+  abort.catch(() => {
+  });
+  return Promise.race([abort, promise]);
+}
 export {
   decode,
   encode

package/dist/unflatten.js

@@ -24,6 +24,8 @@ function hydrate(index) {
     switch (index) {
         case utils_js_1.UNDEFINED:
             return;
+        case utils_js_1.NULL:
+            return null;
         case utils_js_1.NAN:
             return NaN;
         case utils_js_1.POSITIVE_INFINITY:

package/dist/utils.d.ts

@@ -1,9 +1,10 @@
 export declare const HOLE = -1;
 export declare const NAN = -2;
-export declare const NEGATIVE_INFINITY = -4;
-export declare const NEGATIVE_ZERO = -5;
-export declare const POSITIVE_INFINITY = -3;
-export declare const UNDEFINED = -1;
+export declare const NEGATIVE_INFINITY = -3;
+export declare const NEGATIVE_ZERO = -4;
+export declare const NULL = -5;
+export declare const POSITIVE_INFINITY = -6;
+export declare const UNDEFINED = -7;
 export declare const TYPE_BIGINT = "B";
 export declare const TYPE_DATE = "D";
 export declare const TYPE_ERROR = "E";
@@ -30,6 +31,7 @@ export interface ThisEncode {
     stringified: string[];
     deferred: Record<number, Promise<unknown>>;
     plugins?: EncodePlugin[];
+    signal?: AbortSignal;
 }
 export declare class Deferred<T = unknown> {
     promise: Promise<T>;

package/dist/utils.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLineSplittingTransform = exports.Deferred = exports.TYPE_URL = exports.TYPE_SYMBOL = exports.TYPE_SET = exports.TYPE_REGEXP = exports.TYPE_PROMISE = exports.TYPE_NULL_OBJECT = exports.TYPE_MAP = exports.TYPE_ERROR = exports.TYPE_DATE = exports.TYPE_BIGINT = exports.UNDEFINED = exports.POSITIVE_INFINITY = exports.NEGATIVE_ZERO = exports.NEGATIVE_INFINITY = exports.NAN = exports.HOLE = void 0;
+exports.createLineSplittingTransform = exports.Deferred = exports.TYPE_URL = exports.TYPE_SYMBOL = exports.TYPE_SET = exports.TYPE_REGEXP = exports.TYPE_PROMISE = exports.TYPE_NULL_OBJECT = exports.TYPE_MAP = exports.TYPE_ERROR = exports.TYPE_DATE = exports.TYPE_BIGINT = exports.UNDEFINED = exports.POSITIVE_INFINITY = exports.NULL = exports.NEGATIVE_ZERO = exports.NEGATIVE_INFINITY = exports.NAN = exports.HOLE = void 0;
 exports.HOLE = -1;
 exports.NAN = -2;
-exports.NEGATIVE_INFINITY = -4;
-exports.NEGATIVE_ZERO = -5;
-exports.POSITIVE_INFINITY = -3;
-exports.UNDEFINED = -1;
+exports.NEGATIVE_INFINITY = -3;
+exports.NEGATIVE_ZERO = -4;
+exports.NULL = -5;
+exports.POSITIVE_INFINITY = -6;
+exports.UNDEFINED = -7;
 exports.TYPE_BIGINT = "B";
 exports.TYPE_DATE = "D";
 exports.TYPE_ERROR = "E";
@@ -30,12 +31,12 @@ class Deferred {
 }
 exports.Deferred = Deferred;
 function createLineSplittingTransform() {
-    let decoder = new TextDecoder();
+    const decoder = new TextDecoder();
     let leftover = "";
     return new TransformStream({
         transform(chunk, controller) {
-            let str = decoder.decode(chunk, { stream: true });
-            let parts = (leftover + str).split("\n");
+            const str = decoder.decode(chunk, { stream: true });
+            const parts = (leftover + str).split("\n");
             // The last part might be a partial line, so keep it for the next chunk.
             leftover = parts.pop() || "";
             for (const part of parts) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "turbo-stream",
-  "version": "1.2.1",
+  "version": "2.0.1",
   "description": "A streaming data transport format that aims to support built-in features such as Promises, Dates, RegExps, Maps, Sets and more.",
   "files": [
     "dist",