turbo-stream 2.0.0 → 2.1.0

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.d.ts

@@ -1,2 +1,2 @@
 import { type ThisEncode } from "./utils.js";
-export declare function flatten(this: ThisEncode, input: unknown): number;
+export declare function flatten(this: ThisEncode, input: unknown): number | [number];

package/dist/flatten.js

@@ -6,14 +6,16 @@ function flatten(input) {
     const { indices } = this;
     const existing = indices.get(input);
     if (existing)
-        return existing;
+        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()}]`;
@@ -86,14 +90,27 @@ function stringify(input, index) {
                     str[index] = `["${utils_js_1.TYPE_REGEXP}",${JSON.stringify(input.source)},${JSON.stringify(input.flags)}]`;
                 }
                 else if (input instanceof Set) {
-                    str[index] = `["${utils_js_1.TYPE_SET}",${[...input]
-                        .map((val) => flatten.call(this, val))
-                        .join(",")}]`;
+                    if (input.size > 0) {
+                        str[index] = `["${utils_js_1.TYPE_SET}",${[...input]
+                            .map((val) => flatten.call(this, val))
+                            .join(",")}]`;
+                    }
+                    else {
+                        str[index] = `["${utils_js_1.TYPE_SET}"]`;
+                    }
                 }
                 else if (input instanceof Map) {
-                    str[index] = `["${utils_js_1.TYPE_MAP}",${[...input]
-                        .flatMap(([k, v]) => [flatten.call(this, k), flatten.call(this, v)])
-                        .join(",")}]`;
+                    if (input.size > 0) {
+                        str[index] = `["${utils_js_1.TYPE_MAP}",${[...input]
+                            .flatMap(([k, v]) => [
+                            flatten.call(this, k),
+                            flatten.call(this, v),
+                        ])
+                            .join(",")}]`;
+                    }
+                    else {
+                        str[index] = `["${utils_js_1.TYPE_MAP}"]`;
+                    }
                 }
                 else if (input instanceof Promise) {
                     str[index] = `["${utils_js_1.TYPE_PROMISE}",${index}]`;
@@ -117,6 +134,7 @@ function stringify(input, index) {
                 }
             }
             break;
+        }
         default:
             throw new Error("Cannot encode function or unexpected type");
     }

package/dist/turbo-stream.js

@@ -121,6 +121,9 @@ function encode(input, options) {
     const readable = new ReadableStream({
         async start(controller) {
             const id = flatten_js_1.flatten.call(encoder, input);
+            if (Array.isArray(id)) {
+                throw new Error("This should never happen");
+            }
             if (id < 0) {
                 controller.enqueue(textEncoder.encode(`${id}\n`));
             }
@@ -136,7 +139,10 @@ function encode(input, options) {
                     seenPromises.add((encoder.deferred[Number(deferredId)] = raceSignal(deferred, encoder.signal)
                         .then((resolved) => {
                         const id = flatten_js_1.flatten.call(encoder, resolved);
-                        if (id < 0) {
+                        if (Array.isArray(id)) {
+                            controller.enqueue(textEncoder.encode(`${utils_js_1.TYPE_PROMISE}${deferredId}:[["${utils_js_1.TYPE_PREVIOUS_RESOLVED}",${id[0]}]]\n`));
+                        }
+                        else if (id < 0) {
                             controller.enqueue(textEncoder.encode(`${utils_js_1.TYPE_PROMISE}${deferredId}:${id}\n`));
                         }
                         else {
@@ -153,7 +159,10 @@ function encode(input, options) {
                             reason = new Error("An unknown error occurred");
                         }
                         const id = flatten_js_1.flatten.call(encoder, reason);
-                        if (id < 0) {
+                        if (Array.isArray(id)) {
+                            controller.enqueue(textEncoder.encode(`${utils_js_1.TYPE_ERROR}${deferredId}:[["${utils_js_1.TYPE_PREVIOUS_RESOLVED}",${id[0]}]]\n`));
+                        }
+                        else if (id < 0) {
                             controller.enqueue(textEncoder.encode(`${utils_js_1.TYPE_ERROR}${deferredId}:${id}\n`));
                         }
                         else {

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";
@@ -15,6 +16,7 @@ var TYPE_REGEXP = "R";
 var TYPE_SET = "S";
 var TYPE_SYMBOL = "Y";
 var TYPE_URL = "U";
+var TYPE_PREVIOUS_RESOLVED = "Z";
 var Deferred = class {
   promise;
   resolve;
@@ -27,12 +29,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);
@@ -51,14 +53,16 @@ function flatten(input) {
   const { indices } = this;
   const existing = indices.get(input);
   if (existing)
-    return existing;
+    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 +84,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 +92,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 +108,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 +120,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) {
@@ -125,9 +130,20 @@ function stringify(input, index) {
             input.source
           )},${JSON.stringify(input.flags)}]`;
         } else if (input instanceof Set) {
-          str[index] = `["${TYPE_SET}",${[...input].map((val) => flatten.call(this, val)).join(",")}]`;
+          if (input.size > 0) {
+            str[index] = `["${TYPE_SET}",${[...input].map((val) => flatten.call(this, val)).join(",")}]`;
+          } else {
+            str[index] = `["${TYPE_SET}"]`;
+          }
         } else if (input instanceof Map) {
-          str[index] = `["${TYPE_MAP}",${[...input].flatMap(([k, v]) => [flatten.call(this, k), flatten.call(this, v)]).join(",")}]`;
+          if (input.size > 0) {
+            str[index] = `["${TYPE_MAP}",${[...input].flatMap(([k, v]) => [
+              flatten.call(this, k),
+              flatten.call(this, v)
+            ]).join(",")}]`;
+          } else {
+            str[index] = `["${TYPE_MAP}"]`;
+          }
         } else if (input instanceof Promise) {
           str[index] = `["${TYPE_PROMISE}",${index}]`;
           deferred[index] = input;
@@ -146,6 +162,7 @@ function stringify(input, index) {
         }
       }
       break;
+    }
     default:
       throw new Error("Cannot encode function or unexpected type");
   }
@@ -174,6 +191,8 @@ function hydrate(index) {
   switch (index) {
     case UNDEFINED:
       return;
+    case NULL:
+      return null;
     case NAN:
       return NaN;
     case POSITIVE_INFINITY:
@@ -237,6 +256,8 @@ function hydrate(index) {
           let error = errorType && globalObj && globalObj[errorType] ? new globalObj[errorType](message) : new Error(message);
           hydrated[index] = error;
           return error;
+        case TYPE_PREVIOUS_RESOLVED:
+          return hydrate.call(this, b);
         default:
           if (Array.isArray(plugins)) {
             const args = value.slice(1).map((i) => hydrate.call(this, i));
@@ -379,6 +400,9 @@ function encode(input, options) {
   const readable = new ReadableStream({
     async start(controller) {
       const id = flatten.call(encoder, input);
+      if (Array.isArray(id)) {
+        throw new Error("This should never happen");
+      }
       if (id < 0) {
         controller.enqueue(textEncoder.encode(`${id}
 `));
@@ -401,7 +425,14 @@ function encode(input, options) {
             ).then(
               (resolved) => {
                 const id2 = flatten.call(encoder, resolved);
-                if (id2 < 0) {
+                if (Array.isArray(id2)) {
+                  controller.enqueue(
+                    textEncoder.encode(
+                      `${TYPE_PROMISE}${deferredId}:[["${TYPE_PREVIOUS_RESOLVED}",${id2[0]}]]
+`
+                    )
+                  );
+                } else if (id2 < 0) {
                   controller.enqueue(
                     textEncoder.encode(`${TYPE_PROMISE}${deferredId}:${id2}
 `)
@@ -422,7 +453,14 @@ function encode(input, options) {
                   reason = new Error("An unknown error occurred");
                 }
                 const id2 = flatten.call(encoder, reason);
-                if (id2 < 0) {
+                if (Array.isArray(id2)) {
+                  controller.enqueue(
+                    textEncoder.encode(
+                      `${TYPE_ERROR}${deferredId}:[["${TYPE_PREVIOUS_RESOLVED}",${id2[0]}]]
+`
+                    )
+                  );
+                } else if (id2 < 0) {
                   controller.enqueue(
                     textEncoder.encode(`${TYPE_ERROR}${deferredId}:${id2}
 `)

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:
@@ -87,6 +89,8 @@ function hydrate(index) {
                         : new Error(message);
                     hydrated[index] = error;
                     return error;
+                case utils_js_1.TYPE_PREVIOUS_RESOLVED:
+                    return hydrate.call(this, b);
                 default:
                     // Run plugins at the end so we have a chance to resolve primitives
                     // without running into a loop

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";
@@ -14,6 +15,7 @@ export declare const TYPE_REGEXP = "R";
 export declare const TYPE_SET = "S";
 export declare const TYPE_SYMBOL = "Y";
 export declare const TYPE_URL = "U";
+export declare const TYPE_PREVIOUS_RESOLVED = "Z";
 export type DecodePlugin = (type: string, ...data: unknown[]) => {
     value: unknown;
 } | false | null | undefined;

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_PREVIOUS_RESOLVED = 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";
@@ -17,6 +18,7 @@ exports.TYPE_REGEXP = "R";
 exports.TYPE_SET = "S";
 exports.TYPE_SYMBOL = "Y";
 exports.TYPE_URL = "U";
+exports.TYPE_PREVIOUS_RESOLVED = "Z";
 class Deferred {
     promise;
     resolve;
@@ -30,12 +32,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": "2.0.0",
+  "version": "2.1.0",
   "description": "A streaming data transport format that aims to support built-in features such as Promises, Dates, RegExps, Maps, Sets and more.",
   "files": [
     "dist",