turbo-stream 2.3.0 → 2.4.0

package/dist/flatten.js

@@ -26,7 +26,7 @@ function flatten(input) {
 }
 exports.flatten = flatten;
 function stringify(input, index) {
-    const { deferred, plugins } = this;
+    const { deferred, plugins, postPlugins } = this;
     const str = this.stringified;
     const stack = [[input, index]];
     while (stack.length > 0) {
@@ -34,6 +34,7 @@ function stringify(input, index) {
         const partsForObj = (obj) => Object.keys(obj)
             .map((k) => `"_${flatten.call(this, k)}":${flatten.call(this, obj[k])}`)
             .join(",");
+        let error = null;
         switch (typeof input) {
             case "boolean":
             case "number":
@@ -45,9 +46,12 @@ function stringify(input, index) {
                 break;
             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)}]`;
+                if (!keyFor) {
+                    error = new Error("Cannot encode symbol unless created with Symbol.for()");
+                }
+                else {
+                    str[index] = `["${utils_js_1.TYPE_SYMBOL}",${JSON.stringify(keyFor)}]`;
+                }
                 break;
             }
             case "object": {
@@ -133,7 +137,7 @@ function stringify(input, index) {
                         str[index] = `{${partsForObj(input)}}`;
                     }
                     else {
-                        throw new Error("Cannot encode object with prototype");
+                        error = new Error("Cannot encode object with prototype");
                     }
                 }
                 break;
@@ -159,10 +163,33 @@ function stringify(input, index) {
                     }
                 }
                 if (!pluginHandled) {
-                    throw new Error("Cannot encode function or unexpected type");
+                    error = new Error("Cannot encode function or unexpected type");
                 }
             }
         }
+        if (error) {
+            let pluginHandled = false;
+            if (postPlugins) {
+                for (const plugin of postPlugins) {
+                    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 error;
+            }
+        }
     }
 }
 const objectProtoNames = Object.getOwnPropertyNames(Object.prototype)

package/dist/turbo-stream.d.ts

@@ -8,5 +8,6 @@ export declare function decode(readable: ReadableStream<Uint8Array>, options?: {
 }>;
 export declare function encode(input: unknown, options?: {
     plugins?: EncodePlugin[];
+    postPlugins?: EncodePlugin[];
     signal?: AbortSignal;
 }): ReadableStream<Uint8Array>;

package/dist/turbo-stream.js

@@ -107,13 +107,14 @@ async function decodeDeferred(reader) {
     }
 }
 function encode(input, options) {
-    const { plugins, signal } = options ?? {};
+    const { plugins, postPlugins, signal } = options ?? {};
     const encoder = {
         deferred: {},
         index: 0,
         indices: new Map(),
         stringified: [],
         plugins,
+        postPlugins,
         signal,
     };
     const textEncoder = new TextEncoder();

package/dist/turbo-stream.mjs

@@ -72,12 +72,13 @@ function flatten(input) {
   return index;
 }
 function stringify(input, index) {
-  const { deferred, plugins } = this;
+  const { deferred, plugins, postPlugins } = this;
   const str = this.stringified;
   const stack = [[input, index]];
   while (stack.length > 0) {
     const [input2, index2] = stack.pop();
     const partsForObj = (obj) => Object.keys(obj).map((k) => `"_${flatten.call(this, k)}":${flatten.call(this, obj[k])}`).join(",");
+    let error = null;
     switch (typeof input2) {
       case "boolean":
       case "number":
@@ -89,11 +90,13 @@ function stringify(input, index) {
         break;
       case "symbol": {
         const keyFor = Symbol.keyFor(input2);
-        if (!keyFor)
-          throw new Error(
+        if (!keyFor) {
+          error = new Error(
             "Cannot encode symbol unless created with Symbol.for()"
           );
-        str[index2] = `["${TYPE_SYMBOL}",${JSON.stringify(keyFor)}]`;
+        } else {
+          str[index2] = `["${TYPE_SYMBOL}",${JSON.stringify(keyFor)}]`;
+        }
         break;
       }
       case "object": {
@@ -161,7 +164,7 @@ function stringify(input, index) {
           } else if (isPlainObject(input2)) {
             str[index2] = `{${partsForObj(input2)}}`;
           } else {
-            throw new Error("Cannot encode object with prototype");
+            error = new Error("Cannot encode object with prototype");
           }
         }
         break;
@@ -185,9 +188,30 @@ function stringify(input, index) {
           }
         }
         if (!pluginHandled) {
-          throw new Error("Cannot encode function or unexpected type");
+          error = new Error("Cannot encode function or unexpected type");
+        }
+      }
+    }
+    if (error) {
+      let pluginHandled = false;
+      if (postPlugins) {
+        for (const plugin of postPlugins) {
+          const pluginResult = plugin(input2);
+          if (Array.isArray(pluginResult)) {
+            pluginHandled = true;
+            const [pluginIdentifier, ...rest] = pluginResult;
+            str[index2] = `[${JSON.stringify(pluginIdentifier)}`;
+            if (rest.length > 0) {
+              str[index2] += `,${rest.map((v) => flatten.call(this, v)).join(",")}`;
+            }
+            str[index2] += "]";
+            break;
+          }
         }
       }
+      if (!pluginHandled) {
+        throw error;
+      }
     }
   }
 }
@@ -520,13 +544,14 @@ async function decodeDeferred(reader) {
   }
 }
 function encode(input, options) {
-  const { plugins, signal } = options ?? {};
+  const { plugins, postPlugins, signal } = options ?? {};
   const encoder = {
     deferred: {},
     index: 0,
     indices: /* @__PURE__ */ new Map(),
     stringified: [],
     plugins,
+    postPlugins,
     signal
   };
   const textEncoder = new TextEncoder();

package/dist/utils.d.ts

@@ -32,6 +32,7 @@ export interface ThisEncode {
     stringified: string[];
     deferred: Record<number, Promise<unknown>>;
     plugins?: EncodePlugin[];
+    postPlugins?: EncodePlugin[];
     signal?: AbortSignal;
 }
 export declare class Deferred<T = unknown> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "turbo-stream",
-  "version": "2.3.0",
+  "version": "2.4.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",
@@ -18,7 +18,7 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "pnpm build:esm && pnpm build:cjs",
+    "build": "pnpm build:esm && pnpm build:cjs && cp ./dist/turbo-stream.mjs ./viewer/scripts/turbo-stream.js",
     "build:cjs": "tsc --outDir dist --project tsconfig.lib.json",
     "build:esm": "esbuild --bundle --platform=node --target=node16 --format=esm --outfile=dist/turbo-stream.mjs src/turbo-stream.ts",
     "test": "node --no-warnings --loader tsm --enable-source-maps --test-reporter tap --test src/*.spec.ts",