node-turbo 1.2.6 → 1.3.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024-2025 Walter Krivanek
+Copyright (c) 2024-2026 Walter Krivanek
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -55,11 +55,11 @@ node-turbo has been tested with 100% code coverage with the following engines/li
 
 | Name | Version(s) |
 | :--- | :--- |
-| [Hotwire Turbo](https://turbo.hotwired.dev/) | 7.3.0 - 8.0.18 |
+| [Hotwire Turbo](https://turbo.hotwired.dev/) | 7.3.0 - 8.0.23 |
 | [Node.js](https://nodejs.org/) | 16.6 - 22.20.0 |
-| [Koa](https://koajs.com/) | 2.14.2 - 3.0.1 |
-| [Express](https://expressjs.com/) | 4.18.2 - 5.1.0 |
-| [ws](https://github.com/websockets/ws) | 8.15.1 -  8.18.3 |
+| [Koa](https://koajs.com/) | 2.14.2 - 3.1.2 |
+| [Express](https://expressjs.com/) | 4.18.2 - 5.2.1 |
+| [ws](https://github.com/websockets/ws) | 8.15.1 -  8.19.0 |
 
 ## API docs
 See [`/docs/API.md`](./docs/API.md) for a documentation of all node-turbo classes and functions.
@@ -216,15 +216,15 @@ Result:
 
 ##### Using the Node.js streams API
 If you want to use the [Node.js streams API](https://nodejs.org/docs/latest/api/stream.html) with Turbo Streams, you can 
-create a Readable stream instance which reads Turbo Stream messages.
+create a `PassThrough` stream instance which reads Turbo Stream messages.
 
 ```javascript
 import { TurboStream } from 'node-turbo';
 
 const ts = new TurboStream();
-const readable = ts.createReadableStream();
+const nStream = ts.createNodeStream();
 
-readable.pipe(process.stdout);
+nStream.pipe(process.stdout);
 
 // These elements get piped immediately:
 ts
@@ -459,9 +459,9 @@ const wss = new WebSocketServer({ port: 8080 });
 
 wss.on('connection', function connection(ws) {
   const ts = new TurboStream();
-  const readable = ts.createReadableStream();
+  const nStream = ts.createNodeStream();
   const wsStream = createWebSocketStream(ws, { encoding: 'utf8' });
-  readable.pipe(wsStream);
+  nStream.pipe(wsStream);
 
   ts
     .append('target-id', '<p>My content</p>')
@@ -508,8 +508,8 @@ const httpServer = http.createServer((req, res) => {
 
     // You can also use the streams API.
     setTimeout(() => {    
-      const stream = ssets.createReadableStream();
-      stream.pipe(res); 
+      const nStream = ssets.createNodeStream();
+      nStream.pipe(res); 
       ssets.prependAll('.stream', '<p>Prepend!</p>');
     }, 2000);
 
@@ -529,7 +529,7 @@ const httpServer = http.createServer((req, res) => {
       padding: 10px;
     }
     </style>
-    <script type="module" src="https://unpkg.com/@hotwired/turbo@8.0.12/dist/turbo.es2017-esm.js"></script>
+    <script type="module" src="https://unpkg.com/@hotwired/turbo@8.0.23/dist/turbo.es2017-esm.js"></script>
     <script>
       var eventSource = new EventSource('/sse');
       eventSource.onmessage = function(event) {
@@ -616,7 +616,7 @@ app.use(async (ctx, next) => {
       padding: 10px;
     }
     </style>
-    <script type="module" src="https://unpkg.com/@hotwired/turbo@8.0.12/dist/turbo.es2017-esm.js"></script>
+    <script type="module" src="https://unpkg.com/@hotwired/turbo@8.0.23/dist/turbo.es2017-esm.js"></script>
     <script>
       var eventSource = new EventSource('/sse');
       eventSource.onmessage = function(event) {
@@ -693,7 +693,7 @@ app.get('/', async (req, res) => {
       padding: 10px;
     }
     </style>
-    <script type="module" src="https://unpkg.com/@hotwired/turbo@8.0.12/dist/turbo.es2017-esm.js"></script>
+    <script type="module" src="https://unpkg.com/@hotwired/turbo@8.0.23/dist/turbo.es2017-esm.js"></script>
     <script>
       var eventSource = new EventSource('/sse');
       eventSource.onmessage = function(event) {
@@ -720,4 +720,4 @@ app.listen(config.port);
 ```
 ## License
  
-node-turbo is © 2024-2025 Walter Krivanek and released under the [MIT license](https://mit-license.org).
+node-turbo is © 2024-2026 Walter Krivanek and released under the [MIT license](https://mit-license.org).

package/docs/API.md

@@ -1,6 +1,6 @@
 # node-turbo API documentation
 
-Version 1.2.6
+Version 1.3.0
 
 ## Table of Contents
 
@@ -26,7 +26,7 @@ Version 1.2.6
       - [turbostream.flush()](#turbostreamflush)
       - [turbostream.custom(action, target, content)](#turbostreamcustomaction-target-content)
       - [turbostream.customAll(action, targets, content)](#turbostreamcustomallaction-targets-content)
-      - [turbostream.createReadableStream(opts, opts.continuous, streamOptions)](#turbostreamcreatereadablestreamopts-optscontinuous-streamoptions)
+      - [turbostream.createNodeStream(opts, streamOptions)](#turbostreamcreatenodestreamopts-streamoptions)
       - [turbostream.append(targetOrAttributes, content)](#turbostreamappendtargetorattributes-content)
       - [turbostream.appendAll(targetsOrAttributes, content)](#turbostreamappendalltargetsorattributes-content)
       - [turbostream.prepend(targetOrAttributes, content)](#turbostreamprependtargetorattributes-content)
@@ -54,7 +54,7 @@ Version 1.2.6
       - [turboelement.renderAttributesAsHtml()](#turboelementrenderattributesashtml)
       - [turboelement.validate()](#turboelementvalidate)
       - [turboelement.render()](#turboelementrender)
-   - [Class: TurboReadable](#class-turboreadable)
+   - [Class: TurboReadable (deprecated)](#class-turboreadable)
       - [new TurboReadable(turboStream[, opts])](#new-turboreadableturbostream-opts)
       - [turboreadable._turboStream](#turboreadable_turbostream)
       - [turboreadable._boundPush](#turboreadable_boundpush)
@@ -92,7 +92,7 @@ Version 1.2.6
       - [sseturbostream.eventName](#sseturbostreameventname)
       - [sseturbostream.render()](#sseturbostreamrender)
       - [sseturbostream.renderSseEvent(raw)](#sseturbostreamrendersseeventraw)
-      - [sseturbostream.createReadableStream()](#sseturbostreamcreatereadablestream)
+      - [sseturbostream.createNodeStream()](#sseturbostreamcreatenodestream)
       - [sseturbostream.event(eventName)](#sseturbostreameventeventname)
 - [node-turbo/errors](#node-turboerrors)
    - [Class: ValidationError](#class-validationerror)
@@ -271,16 +271,16 @@ Adds a Turbo Stream Element with a custom action, targeting multiple DOM element
 
 Returns: {TurboStream} The instance for chaining.
 
-#### turbostream.createReadableStream(opts, opts.continuous, streamOptions)
+#### turbostream.createNodeStream(opts, streamOptions)
 
 - `opts` {Object<String, String>} The options for stream creation.
-- `opts.continuous` {Boolean} If true, a TurboReadable instance is returned. 
- If false, a readable stream created from the buffered items is returned.
+- `opts.continuous` {Boolean} If true, a {node:stream~PassThrough} instance is returned. 
+ If false, a {node:stream~Readable} created from the buffered items is returned.
 - `streamOptions` {Object<String, String>} The options for the readable stream itself.
 
-Creates a readable stream.
+Creates either a {node:stream~Readable} or {node:stream~PassThrough} stream instance.
 
-Returns: {stream.Readable | TurboReadable} Either a readable stream or a TurboReadable instance.
+Returns: {node:stream~Readable | {node:stream~PassThrough}} Either a readable stream or a TurboReadable instance.
 
 #### turbostream.append(targetOrAttributes, content)
 
@@ -510,6 +510,9 @@ Render function to implement.
 
 ### Class: TurboReadable
 
+> [!WARNING]
+> Deprecated since v1.3.0!
+
 ```javascript
 import { TurboReadable } from 'node-turbo';
 ```
@@ -688,7 +691,7 @@ Adds the element to the buffer, if config.buffer === true.
 Fires the event 'element' with the added element.
 > - clear()  
 Clears the buffer.
-> - createReadableStream(opts, opts.continuous, streamOptions)  
+> - createNodeStream(opts, streamOptions)  
 Creates a readable stream.
 > - custom(action, target, content)  
 Adds a Turbo Stream Element with a custom action.
@@ -752,7 +755,7 @@ Adds the element to the buffer, if config.buffer === true.
 Fires the event 'element' with the added element.
 > - clear()  
 Clears the buffer.
-> - createReadableStream(opts, opts.continuous, streamOptions)  
+> - createNodeStream(opts, streamOptions)  
 Creates a readable stream.
 > - custom(action, target, content)  
 Adds a Turbo Stream Element with a custom action.
@@ -851,7 +854,7 @@ Adds the element to the buffer, if config.buffer === true.
 Fires the event 'element' with the added element.
 > - clear()  
 Clears the buffer.
-> - createReadableStream(opts, opts.continuous, streamOptions)  
+> - createNodeStream(opts, streamOptions)  
 Creates a readable stream.
 > - custom(action, target, content)  
 Adds a Turbo Stream Element with a custom action.
@@ -942,15 +945,15 @@ Returns: {String | null} The rendered SSE or null if there were no elements in t
 
 - `raw` {String} The raw HTML string.
 
-Takes a HTML fragment string and converts it to an SSE event message.
+Takes an HTML fragment string and converts it to an SSE event message.
 
 Returns: {String | null} The converted SSE event message or null if no string has been passed.
 
-#### sseturbostream.createReadableStream()
+#### sseturbostream.createNodeStream()
 
-Creates a {TurboReadable} instance, which pipes to a {node:stream~Transform} to add SSE specific syntax.
+Creates a {node:stream~PassThrough} instance, which passes Turbo Stream elements through as SSE messages.
 
-Returns: {node:stream.Transform} The Transform stream instance.
+Returns: {node:stream~PassThrough} The PassThrough stream instance.
 
 #### sseturbostream.event(eventName)
 
@@ -1050,4 +1053,4 @@ Gets thrown when invalid attributes are discovered.
 
 ***
 
-node-turbo is © 2024-2025 by Walter Krivanek and released under the [MIT license](https://mit-license.org).
+node-turbo is © 2024-2026 by Walter Krivanek and released under the [MIT license](https://mit-license.org).