chore: Prepare v4.2.0-rc.2

Author: lesleysin

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.2.0-rc.2
+
+- New capability-base UIDriver API + docs
+
 ## 4.2.0-rc.1
 
 - New capability-base UIDriver API

lib/src/capabilities/native_module_capability.dart

@@ -2,17 +2,59 @@ import "package:duit_kernel/duit_kernel.dart";
 import "package:duit_kernel/src/capabilities/driver_ref.dart";
 import "package:meta/meta.dart";
 
+/// A mixin that provides capabilities for managing and interacting with
+/// native code in the Duit UI system. Classes that mix in this delegate should
+/// provide concrete implementations for handling native module interactions,
+/// such as invoking native methods and initializing the native module.
 mixin NativeModuleCapabilityDelegate implements DriverRefHolder {
   @override
   @mustBeOverridden
-  void linkDriver(UIDriver driver) => throw const MissingCapabilityMethodImplementation(
+  void linkDriver(UIDriver driver) =>
+      throw const MissingCapabilityMethodImplementation(
         "linkDriver",
         "NativeModuleCapabilityDelegate",
       );
 
+  /// Initializes the native module.
+  ///
+  /// This method must be overridden by implementers.
+  ///
+  /// Throws [MissingCapabilityMethodImplementation] if not overridden.
   @mustBeOverridden
-  Future<void> initNativeModule() => throw const MissingCapabilityMethodImplementation(
+  Future<void> initNativeModule() =>
+      throw const MissingCapabilityMethodImplementation(
         "initNativeModule",
         "NativeModuleCapabilityDelegate",
       );
+
+  /// Invokes a native method.
+  ///
+  /// The [method] parameter represents the name of the native method to invoke.
+  /// The [arguments] parameter contains any additional data required for the method.
+  ///
+  /// This method must be overridden by implementers.
+  ///
+  /// Throws [MissingCapabilityMethodImplementation] if not overridden.
+  @mustBeOverridden
+  Future<T?> invokeNativeMethod<T>(
+    String method, [
+    arguments,
+  ]) =>
+      throw const MissingCapabilityMethodImplementation(
+        "invokeNativeMethod",
+        "NativeModuleCapabilityDelegate",
+      );
+
+  /// Called to clean up any external resources, subscriptions, or handlers
+  /// typically when a delegate is being disposed of or detached. Implementations
+  /// should ensure all open streams or event sources are closed.
+  ///
+  /// This method must be overridden by implementers.
+  ///
+  /// Throws [MissingCapabilityMethodImplementation] by default.
+  @mustBeOverridden
+  void releaseResources() => throw const MissingCapabilityMethodImplementation(
+        "releaseResources",
+        "NativeModuleCapabilityDelegate",
+      );
 }

lib/src/capabilities/scripting_capability.dart

@@ -2,17 +2,23 @@ import "package:duit_kernel/duit_kernel.dart";
 import "package:duit_kernel/src/capabilities/driver_ref.dart";
 import "package:meta/meta.dart";
 
+/// A mixin that provides capabilities for managing and run scripts in the Duit UI system.
+/// Classes that mix in this delegate
+/// should provide concrete implementations for
+/// handling script execution, evaluation, and initialization.
 mixin ScriptingCapabilityDelegate implements DriverRefHolder {
   @override
   @mustBeOverridden
-  void linkDriver(UIDriver driver) => throw const MissingCapabilityMethodImplementation(
+  void linkDriver(UIDriver driver) =>
+      throw const MissingCapabilityMethodImplementation(
         "linkDriver",
         "ScriptingCapabilityDelegate",
       );
 
   /// Eval script source code
   @mustBeOverridden
-  Future<void> evalScript(String source) => throw const MissingCapabilityMethodImplementation(
+  Future<void> evalScript(String source) =>
+      throw const MissingCapabilityMethodImplementation(
         "evalScript",
         "ScriptingCapabilityDelegate",
       );
@@ -36,8 +42,22 @@ mixin ScriptingCapabilityDelegate implements DriverRefHolder {
 
   /// Initializes the scripting capability.
   @mustBeOverridden
-  Future<void> initScriptingCapability() => throw const MissingCapabilityMethodImplementation(
+  Future<void> initScriptingCapability() =>
+      throw const MissingCapabilityMethodImplementation(
         "initScriptingCapability",
         "ScriptingCapabilityDelegate",
       );
+
+  /// Called to clean up any external resources, subscriptions, or handlers
+  /// typically when a delegate is being disposed of or detached. Implementations
+  /// should ensure all open streams or event sources are closed.
+  ///
+  /// This method must be overridden by implementers.
+  ///
+  /// Throws [MissingCapabilityMethodImplementation] by default.
+  @mustBeOverridden
+  void releaseResources() => throw const MissingCapabilityMethodImplementation(
+        "releaseResources",
+        "ScriptingCapabilityDelegate",
+      );
 }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: duit_kernel
 description: "Core library for flutter_duit package.  Contains reusable models for developing third-party packages."
-version: 4.2.0-rc.1
+version: 4.2.0-rc.2
 repository: https://github.com/lesleysin/duit_kernel
 funding:
   - https://boosty.to/duit_foundation