Release 0.2.0-beta (#5)

MelbourneDeveloper · web-flow · commit 91edecd75f29 · 2025-12-02T22:24:47.000+11:00
TLDR;

Bump releases and doco

What Does This Do?

Adds documentation website link and demo GIF to README
Updates all packages to use pub.dev hosted dart_node_core instead of local path dependencies
Adds doc comments to dart_node_ws WebSocket classes
Adds LICENSE file to dart_node_ws package
Brief Details?

How Do The Tests Prove The Change Works?

No functional changes - documentation and dependency source updates only. Existing tests remain valid.
diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 Write your entire stack in Dart: React web apps, React Native mobile apps with Expo, and Node.js Express backends.
 
+📚 **[Documentation & Website](https://melbournedeveloper.github.io/dart_node/)**
+
+![React and React Native](images/dart_node.gif)
+
 ## Package Architecture
 
 ```mermaid
@@ -18,13 +22,13 @@ graph TD
 
 ## Packages
 
-| Package | Description | Version |
-|---------|-------------|---------|
-| [dart_node_core](packages/dart_node_core) | Core JS interop utilities | 0.1.0-beta |
-| [dart_node_express](packages/dart_node_express) | Express.js bindings | 0.1.0-beta |
-| [dart_node_ws](packages/dart_node_ws) | WebSocket bindings | 0.1.0-beta |
-| [dart_node_react](packages/dart_node_react) | React bindings | 0.1.0-beta |
-| [dart_node_react_native](packages/dart_node_react_native) | React Native bindings | 0.1.0-beta |
+| Package | Description | 
+|---------|-------------|
+| [dart_node_core](packages/dart_node_core) | Core JS interop utilities 
+| [dart_node_express](packages/dart_node_express) | Express.js bindings 
+| [dart_node_ws](packages/dart_node_ws) | WebSocket bindings 
+| [dart_node_react](packages/dart_node_react) | React bindings 
+| [dart_node_react_native](packages/dart_node_react_native) | React Native bindings |
 
 ## Example Quick Start
 
diff --git a/images/dart_node.gif b/images/dart_node.gif
diff --git a/packages/dart_node_core/CHANGELOG.md b/packages/dart_node_core/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## 0.2.0-beta
 
 - Add WebSocket support via dart_node_ws package
+- Updated docs
 
 ## 0.1.0-beta
 
diff --git a/packages/dart_node_express/CHANGELOG.md b/packages/dart_node_express/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## 0.2.0-beta
 
 - Add WebSocket support integration with dart_node_ws
+- Updated docs
 
 ## 0.1.0-beta
 
diff --git a/packages/dart_node_express/pubspec.lock b/packages/dart_node_express/pubspec.lock
@@ -12,9 +12,10 @@ packages:
   dart_node_core:
     dependency: "direct main"
     description:
-      path: "../dart_node_core"
-      relative: true
-    source: path
+      name: dart_node_core
+      sha256: "4926d74031883ed7948018ba47604270015571e4e9035db1f4bdf59e18dbd58b"
+      url: "https://pub.dev"
+    source: hosted
     version: "0.2.0-beta"
   nadz:
     dependency: transitive
diff --git a/packages/dart_node_express/pubspec.yaml b/packages/dart_node_express/pubspec.yaml
@@ -8,5 +8,4 @@ environment:
 
 dependencies:
   austerity: ^1.3.0
-  dart_node_core:
-    path: ../dart_node_core
+  dart_node_core: ^0.2.0-beta
diff --git a/packages/dart_node_react/CHANGELOG.md b/packages/dart_node_react/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ## 0.2.0-beta
 
-- Version bump for package family consistency
+- Updated docs
 
 ## 0.1.0-beta
 
diff --git a/packages/dart_node_react/pubspec.lock b/packages/dart_node_react/pubspec.lock
@@ -12,9 +12,10 @@ packages:
   dart_node_core:
     dependency: "direct main"
     description:
-      path: "../dart_node_core"
-      relative: true
-    source: path
+      name: dart_node_core
+      sha256: "4926d74031883ed7948018ba47604270015571e4e9035db1f4bdf59e18dbd58b"
+      url: "https://pub.dev"
+    source: hosted
     version: "0.2.0-beta"
   lints:
     dependency: "direct dev"
diff --git a/packages/dart_node_react/pubspec.yaml b/packages/dart_node_react/pubspec.yaml
@@ -8,8 +8,7 @@ environment:
 
 dependencies:
   austerity: ^1.3.0
-  dart_node_core:
-    path: ../dart_node_core
+  dart_node_core: ^0.2.0-beta
 
 dev_dependencies:
   lints: ^5.0.0
diff --git a/packages/dart_node_react_native/CHANGELOG.md b/packages/dart_node_react_native/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ## 0.2.0-beta
 
-- Version bump for package family consistency
+- Updated docs
 
 ## 0.1.0-beta
 
diff --git a/packages/dart_node_react_native/pubspec.lock b/packages/dart_node_react_native/pubspec.lock
@@ -12,16 +12,18 @@ packages:
   dart_node_core:
     dependency: "direct main"
     description:
-      path: "../dart_node_core"
-      relative: true
-    source: path
+      name: dart_node_core
+      sha256: "4926d74031883ed7948018ba47604270015571e4e9035db1f4bdf59e18dbd58b"
+      url: "https://pub.dev"
+    source: hosted
     version: "0.2.0-beta"
   dart_node_react:
     dependency: "direct main"
     description:
-      path: "../dart_node_react"
-      relative: true
-    source: path
+      name: dart_node_react
+      sha256: e1da283d3c3cb7c753f8d6a04ee5af80cccc8bfdf47a2ef1516cc3dfbe5603cc
+      url: "https://pub.dev"
+    source: hosted
     version: "0.2.0-beta"
   lints:
     dependency: "direct dev"
diff --git a/packages/dart_node_react_native/pubspec.yaml b/packages/dart_node_react_native/pubspec.yaml
@@ -8,10 +8,8 @@ environment:
 
 dependencies:
   austerity: ^1.3.0
-  dart_node_core:
-    path: ../dart_node_core
-  dart_node_react:
-    path: ../dart_node_react
+  dart_node_core: ^0.2.0-beta
+  dart_node_react: ^0.2.0-beta
 
 dev_dependencies:
   lints: ^5.0.0
diff --git a/packages/dart_node_ws/LICENSE b/packages/dart_node_ws/LICENSE
@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Christian Findlay
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/packages/dart_node_ws/lib/src/websocket_server.dart b/packages/dart_node_ws/lib/src/websocket_server.dart
@@ -20,8 +20,11 @@ class WebSocketServer {
   WebSocketServer._(this._server, this.port);
 
   final JSWebSocketServer _server;
+
+  /// The port the server is listening on
   final int port;
 
+  /// Registers a handler for new client connections
   void onConnection(
     void Function(WebSocketClient client, String? url) handler,
   ) =>
@@ -43,6 +46,7 @@ class WebSocketServer {
     };
   }
 
+  /// Closes the WebSocket server
   void close([void Function()? callback]) => _server.close(
         callback != null ? (() => callback()).toJS : null,
       );
diff --git a/packages/dart_node_ws/lib/src/websocket_types.dart b/packages/dart_node_ws/lib/src/websocket_types.dart
@@ -66,9 +66,11 @@ class WebSocketClient {
 
   bool get isOpen => _ws.readyState == WebSocketReadyState.open.value;
 
+  /// Registers a handler for incoming messages
   void onMessage(MessageHandler handler) =>
       _ws.on('message', ((JSAny data) => handler(data)).toJS);
 
+  /// Registers a handler for connection close events
   void onClose(CloseHandler handler) => _ws.on(
         'close',
         ((int code, JSAny? reason) => handler((
@@ -83,6 +85,7 @@ class WebSocketClient {
         _ => reason.toString(),
       };
 
+  /// Registers a handler for error events
   void onError(ErrorHandler handler) =>
       _ws.on('error', ((JSAny error) => handler(error)).toJS);
 }
diff --git a/packages/dart_node_ws/pubspec.lock b/packages/dart_node_ws/pubspec.lock
@@ -12,9 +12,10 @@ packages:
   dart_node_core:
     dependency: "direct main"
     description:
-      path: "../dart_node_core"
-      relative: true
-    source: path
+      name: dart_node_core
+      sha256: "4926d74031883ed7948018ba47604270015571e4e9035db1f4bdf59e18dbd58b"
+      url: "https://pub.dev"
+    source: hosted
     version: "0.2.0-beta"
   nadz:
     dependency: transitive
diff --git a/packages/dart_node_ws/pubspec.yaml b/packages/dart_node_ws/pubspec.yaml
@@ -8,5 +8,4 @@ environment:
 
 dependencies:
   austerity: ^1.3.0
-  dart_node_core:
-    path: ../dart_node_core
+  dart_node_core: ^0.2.0-beta
