turbo-stream 1.2.0 → 2.0.0

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

@@ -190,14 +190,6 @@ function hydrate(index) {
     return hydrated[index] = value;
   if (Array.isArray(value)) {
     if (typeof value[0] === "string") {
-      if (Array.isArray(plugins)) {
-        const args = value.slice(1).map((i) => hydrate.call(this, i));
-        for (const plugin of plugins) {
-          const result = plugin(value[0], ...args);
-          if (result)
-            return hydrated[index] = result.value;
-        }
-      }
       const [type, b, c] = value;
       switch (type) {
         case TYPE_DATE:
@@ -246,6 +238,14 @@ function hydrate(index) {
           hydrated[index] = error;
           return error;
         default:
+          if (Array.isArray(plugins)) {
+            const args = value.slice(1).map((i) => hydrate.call(this, i));
+            for (const plugin of plugins) {
+              const result = plugin(value[0], ...args);
+              if (result)
+                return hydrated[index] = result.value;
+            }
+          }
           throw new SyntaxError();
       }
     } else {
@@ -272,7 +272,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 +364,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 +395,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 +451,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

@@ -40,14 +40,6 @@ function hydrate(index) {
         return (hydrated[index] = value);
     if (Array.isArray(value)) {
         if (typeof value[0] === "string") {
-            if (Array.isArray(plugins)) {
-                const args = value.slice(1).map((i) => hydrate.call(this, i));
-                for (const plugin of plugins) {
-                    const result = plugin(value[0], ...args);
-                    if (result)
-                        return (hydrated[index] = result.value);
-                }
-            }
             const [type, b, c] = value;
             switch (type) {
                 case utils_js_1.TYPE_DATE:
@@ -96,6 +88,16 @@ function hydrate(index) {
                     hydrated[index] = error;
                     return error;
                 default:
+                    // Run plugins at the end so we have a chance to resolve primitives
+                    // without running into a loop
+                    if (Array.isArray(plugins)) {
+                        const args = value.slice(1).map((i) => hydrate.call(this, i));
+                        for (const plugin of plugins) {
+                            const result = plugin(value[0], ...args);
+                            if (result)
+                                return (hydrated[index] = result.value);
+                        }
+                    }
                     throw new SyntaxError();
             }
         }

package/dist/utils.d.ts

@@ -30,6 +30,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/package.json

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