turbo-stream 2.0.1 → 2.2.0

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,7 +6,7 @@ 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)
@@ -90,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}]`;
@@ -122,8 +135,30 @@ function stringify(input, index) {
             }
             break;
         }
-        default:
-            throw new Error("Cannot encode function or unexpected type");
+        default: {
+            const isArray = Array.isArray(input);
+            let pluginHandled = false;
+            if (!isArray && plugins) {
+                for (const plugin of plugins) {
+                    const pluginResult = plugin(input);
+                    if (Array.isArray(pluginResult)) {
+                        pluginHandled = true;
+                        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] += "]";
+                        break;
+                    }
+                }
+            }
+            if (!pluginHandled) {
+                throw new Error("Cannot encode function or unexpected type");
+            }
+        }
     }
 }
 const objectProtoNames = Object.getOwnPropertyNames(Object.prototype)

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

@@ -16,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;
@@ -52,7 +53,7 @@ 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)
@@ -129,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;
@@ -151,8 +163,28 @@ function stringify(input, index) {
       }
       break;
     }
-    default:
-      throw new Error("Cannot encode function or unexpected type");
+    default: {
+      const isArray = Array.isArray(input);
+      let pluginHandled = false;
+      if (!isArray && plugins) {
+        for (const plugin of plugins) {
+          const pluginResult = plugin(input);
+          if (Array.isArray(pluginResult)) {
+            pluginHandled = true;
+            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] += "]";
+            break;
+          }
+        }
+      }
+      if (!pluginHandled) {
+        throw new Error("Cannot encode function or unexpected type");
+      }
+    }
   }
 }
 var objectProtoNames = Object.getOwnPropertyNames(Object.prototype).sort().join("\0");
@@ -244,6 +276,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));
@@ -386,6 +420,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}
 `));
@@ -408,7 +445,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}
 `)
@@ -429,7 +473,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

@@ -89,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

@@ -15,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,6 +1,6 @@
 "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.NULL = 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 = -3;
@@ -18,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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "turbo-stream",
-  "version": "2.0.1",
+  "version": "2.2.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",