com.wallstop-studios.dxmessaging 2.0.0 → 2.1.0

package/Runtime/Unity/InitialGlobalMessageBusProvider.cs

@@ -0,0 +1,38 @@
+namespace DxMessaging.Unity
+{
+    using DxMessaging.Core;
+    using DxMessaging.Core.MessageBus;
+    using UnityEngine;
+
+    /// <summary>
+    /// Serialized provider that always returns the original global message bus created during static initialisation.
+    /// </summary>
+    /// <remarks>
+    /// Unlike <see cref="CurrentGlobalMessageBusProvider"/>, this asset ignores runtime overrides of
+    /// <see cref="MessageHandler.MessageBus"/>, making it ideal for debugging or diagnostics scenarios where you need a
+    /// stable reference to the startup bus.
+    /// </remarks>
+    /// <example>
+    /// <code>
+    /// // Temporarily override the global bus while still keeping a reference to the startup instance.
+    /// var initialProvider = Resources.Load<InitialGlobalMessageBusProvider>("InitialGlobalMessageBusProvider");
+    /// IMessageBus startupBus = initialProvider.Resolve();
+    /// using (MessageHandler.OverrideGlobalMessageBus(customBus))
+    /// {
+    ///     // ... scenario under test
+    /// }
+    /// // startupBus still references the original global bus
+    /// </code>
+    /// </summary>
+    [CreateAssetMenu(
+        fileName = "InitialGlobalMessageBusProvider",
+        menuName = "Wallstop Studios/DxMessaging/Message Bus Providers/Initial Global Message Bus"
+    )]
+    public sealed class InitialGlobalMessageBusProvider : ScriptableMessageBusProvider
+    {
+        public override IMessageBus Resolve()
+        {
+            return MessageHandler.InitialGlobalMessageBus;
+        }
+    }
+}

package/Runtime/Unity/InitialGlobalMessageBusProvider.cs.meta

@@ -0,0 +1,12 @@
+fileFormatVersion: 2
+guid: 1f3f2efbb7f4441ebde8b418d178885a
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
+

package/Runtime/Unity/Integrations/Reflex/AssemblyInfo.cs

@@ -0,0 +1,11 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo(
+    assemblyName: "WallstopStudios.DxMessaging.Tests.Runtime",
+    AllInternalsVisible = true
+)]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Editor")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime.Reflex")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime.VContainer")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime.Zenject")]

package/Runtime/Unity/Integrations/Reflex/AssemblyInfo.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 978915f0cb9d43d99e46455ff38dc528
+timeCreated: 1761517485

package/Runtime/Unity/Integrations/Reflex/ReflexRegistrationInstaller.cs

@@ -0,0 +1,73 @@
+namespace DxMessaging.Unity.Integrations.Reflex
+{
+#if REFLEX_PRESENT
+    using Core.MessageBus;
+    using global::Reflex.Attributes;
+    using global::Reflex.Core;
+
+    /// <summary>
+    /// Optional installer that binds <see cref="IMessageRegistrationBuilder"/> for Reflex containers.
+    /// </summary>
+    public sealed class DxMessagingRegistrationInstaller : IInstaller
+    {
+        public void InstallBindings(ContainerBuilder containerBuilder)
+        {
+            containerBuilder.AddSingleton(
+                typeof(ContainerMessageRegistrationBuilder),
+                typeof(ContainerMessageRegistrationBuilder),
+                typeof(IMessageRegistrationBuilder)
+            );
+        }
+
+        internal sealed class ContainerMessageRegistrationBuilder : IMessageRegistrationBuilder
+        {
+            [Inject]
+            private Container _container;
+
+            public MessageRegistrationLease Build(MessageRegistrationBuildOptions options)
+            {
+                MessageRegistrationBuilder innerBuilder = ResolveInnerBuilder();
+                return innerBuilder.Build(options);
+            }
+
+            private MessageRegistrationBuilder ResolveInnerBuilder()
+            {
+                IMessageBusProvider provider = TryResolveProvider();
+                if (provider != null)
+                {
+                    return new MessageRegistrationBuilder(provider);
+                }
+
+                return new MessageRegistrationBuilder(new ContainerMessageBusProvider(_container));
+            }
+
+            private IMessageBusProvider TryResolveProvider()
+            {
+                try
+                {
+                    return _container.Resolve<IMessageBusProvider>();
+                }
+                catch
+                {
+                    return null;
+                }
+            }
+        }
+
+        public sealed class ContainerMessageBusProvider : IMessageBusProvider
+        {
+            private readonly Container _container;
+
+            public ContainerMessageBusProvider(Container container)
+            {
+                _container = container;
+            }
+
+            public IMessageBus Resolve()
+            {
+                return _container.Resolve<IMessageBus>();
+            }
+        }
+    }
+#endif
+}

package/Runtime/Unity/Integrations/Reflex/ReflexRegistrationInstaller.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 679059e269c44cda9044da10c5640935
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/Integrations/Reflex/WallstopStudios.DxMessaging.Reflex.asmdef

@@ -0,0 +1,20 @@
+{
+  "name": "WallstopStudios.DxMessaging.Reflex",
+  "rootNamespace": "DxMessaging.Unity.Integrations.Reflex",
+  "references": ["WallstopStudios.DxMessaging", "Reflex", "Reflex.Unity"],
+  "includePlatforms": [],
+  "excludePlatforms": [],
+  "allowUnsafeCode": false,
+  "overrideReferences": false,
+  "precompiledReferences": [],
+  "autoReferenced": true,
+  "defineConstraints": ["REFLEX_PRESENT"],
+  "versionDefines": [
+    {
+      "name": "com.gustavopsantos.reflex",
+      "expression": "0.0.1",
+      "define": "REFLEX_PRESENT"
+    }
+  ],
+  "noEngineReferences": false
+}

package/Runtime/Unity/Integrations/Reflex/WallstopStudios.DxMessaging.Reflex.asmdef.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 40c54d5b9b8a421f8bdb5674af90b8db
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/Integrations/Reflex.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 1f0fca97d2b2462491078c52ecc0f92a
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/Integrations/VContainer/AssemblyInfo.cs

@@ -0,0 +1,11 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo(
+    assemblyName: "WallstopStudios.DxMessaging.Tests.Runtime",
+    AllInternalsVisible = true
+)]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Editor")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime.Reflex")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime.VContainer")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime.Zenject")]

package/Runtime/Unity/Integrations/VContainer/AssemblyInfo.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: c26d8cf1c99e45c0a847404d9a455ed1
+timeCreated: 1761517479

package/Runtime/Unity/Integrations/VContainer/VContainerRegistrationExtensions.cs

@@ -0,0 +1,46 @@
+namespace DxMessaging.Unity.Integrations.VContainer
+{
+#if VCONTAINER_PRESENT
+    using global::VContainer;
+    using Core.MessageBus;
+
+    /// <summary>
+    /// Provides convenience extension methods for wiring <see cref="IMessageRegistrationBuilder"/> inside VContainer scopes.
+    /// </summary>
+    public static class VContainerRegistrationExtensions
+    {
+        /// <summary>
+        /// Registers <see cref="IMessageRegistrationBuilder"/> as a transient service backed by the scoped message bus.
+        /// </summary>
+        public static void RegisterMessageRegistrationBuilder(this IContainerBuilder builder)
+        {
+            builder.Register<IMessageRegistrationBuilder>(CreateBuilder, Lifetime.Transient);
+        }
+
+        private static IMessageRegistrationBuilder CreateBuilder(IObjectResolver resolver)
+        {
+            if (resolver.TryResolve(out IMessageBusProvider provider))
+            {
+                return new MessageRegistrationBuilder(provider);
+            }
+
+            return new MessageRegistrationBuilder(new ResolverMessageBusProvider(resolver));
+        }
+
+        public sealed class ResolverMessageBusProvider : IMessageBusProvider
+        {
+            private readonly IObjectResolver _resolver;
+
+            public ResolverMessageBusProvider(IObjectResolver resolver)
+            {
+                _resolver = resolver;
+            }
+
+            public IMessageBus Resolve()
+            {
+                return _resolver.Resolve<IMessageBus>();
+            }
+        }
+    }
+#endif
+}

package/Runtime/Unity/Integrations/VContainer/VContainerRegistrationExtensions.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 494e388075f84aeda9266a0e57f8a05d
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/Integrations/VContainer/WallstopStudios.DxMessaging.VContainer.asmdef

@@ -0,0 +1,30 @@
+{
+  "name": "WallstopStudios.DxMessaging.VContainer",
+  "rootNamespace": "DxMessaging.Unity.Integrations.VContainer",
+  "references": ["WallstopStudios.DxMessaging", "VContainer", "VContainer.Unity"],
+  "includePlatforms": [],
+  "excludePlatforms": [],
+  "allowUnsafeCode": false,
+  "overrideReferences": false,
+  "precompiledReferences": [],
+  "autoReferenced": true,
+  "defineConstraints": ["VCONTAINER_PRESENT"],
+  "versionDefines": [
+    {
+      "name": "jp.cysharp.vcontainer",
+      "expression": "0.0.1",
+      "define": "VCONTAINER_PRESENT"
+    },
+    {
+      "name": "jp.hadashikick.vcontainer",
+      "expression": "0.0.1",
+      "define": "VCONTAINER_PRESENT"
+    },
+    {
+      "name": "VContainer",
+      "expression": "0.0.1",
+      "define": "VCONTAINER_PRESENT"
+    }
+  ],
+  "noEngineReferences": false
+}

package/Runtime/Unity/Integrations/VContainer/WallstopStudios.DxMessaging.VContainer.asmdef.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 2583d1d4ebd847faba751e3be6bf5b20
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/Integrations/VContainer.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 4d890fb7cb4f49e18fd9fbac12d5040c
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/Integrations/Zenject/AssemblyInfo.cs

@@ -0,0 +1,11 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo(
+    assemblyName: "WallstopStudios.DxMessaging.Tests.Runtime",
+    AllInternalsVisible = true
+)]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Editor")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime.Reflex")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime.VContainer")]
+[assembly: InternalsVisibleTo("WallstopStudios.DxMessaging.Tests.Runtime.Zenject")]

package/Runtime/Unity/Integrations/Zenject/AssemblyInfo.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: ec21f9c7970043fe88177114708ef79e
+timeCreated: 1761517466

package/Runtime/Unity/Integrations/Zenject/WallstopStudios.DxMessaging.Zenject.asmdef

@@ -0,0 +1,30 @@
+{
+  "name": "WallstopStudios.DxMessaging.Zenject",
+  "rootNamespace": "DxMessaging.Unity.Integrations.Zenject",
+  "references": ["WallstopStudios.DxMessaging", "Zenject"],
+  "includePlatforms": [],
+  "excludePlatforms": [],
+  "allowUnsafeCode": false,
+  "overrideReferences": false,
+  "precompiledReferences": [],
+  "autoReferenced": true,
+  "defineConstraints": ["ZENJECT_PRESENT"],
+  "versionDefines": [
+    {
+      "name": "com.extenject.zenject",
+      "expression": "0.0.1",
+      "define": "ZENJECT_PRESENT"
+    },
+    {
+      "name": "com.modesttree.zenject",
+      "expression": "0.0.1",
+      "define": "ZENJECT_PRESENT"
+    },
+    {
+      "name": "com.svermeulen.extenject",
+      "expression": "0.0.1",
+      "define": "ZENJECT_PRESENT"
+    }
+  ],
+  "noEngineReferences": false
+}

package/Runtime/Unity/Integrations/Zenject/WallstopStudios.DxMessaging.Zenject.asmdef.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 5c2f6b45062a4c07a599dd8bcbac2bb4
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/Integrations/Zenject/ZenjectRegistrationInstaller.cs

@@ -0,0 +1,55 @@
+namespace DxMessaging.Unity.Integrations.Zenject
+{
+#if ZENJECT_PRESENT
+    using global::Zenject;
+    using Core.MessageBus;
+
+    /// <summary>
+    /// Optional installer that exposes <see cref="IMessageRegistrationBuilder"/> using the scoped Zenject container.
+    /// </summary>
+    public sealed class DxMessagingRegistrationInstaller : MonoInstaller
+    {
+        internal void RunInstallBindings(DiContainer container)
+        {
+            Container = container;
+            InstallBindings();
+        }
+
+        public override void InstallBindings()
+        {
+            Container.Bind<IMessageRegistrationBuilder>().FromMethod(CreateBuilder).AsTransient();
+        }
+
+        private static IMessageRegistrationBuilder CreateBuilder(InjectContext context)
+        {
+            IMessageBusProvider provider = context.Container.TryResolve<IMessageBusProvider>();
+            if (provider != null)
+            {
+                return new MessageRegistrationBuilder(provider);
+            }
+
+            IMessageBus messageBus = context.Container.Resolve<IMessageBus>();
+            return new MessageRegistrationBuilder(
+                new ContainerMessageBusProvider(context.Container, messageBus)
+            );
+        }
+
+        public sealed class ContainerMessageBusProvider : IMessageBusProvider
+        {
+            private readonly DiContainer _container;
+            private readonly IMessageBus _cachedBus;
+
+            public ContainerMessageBusProvider(DiContainer container, IMessageBus cachedBus)
+            {
+                _container = container;
+                _cachedBus = cachedBus;
+            }
+
+            public IMessageBus Resolve()
+            {
+                return _cachedBus ?? _container.Resolve<IMessageBus>();
+            }
+        }
+    }
+#endif
+}

package/Runtime/Unity/Integrations/Zenject/ZenjectRegistrationInstaller.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 1f5d2f7d6c9b4bb9bb5d9ce1f2e4763c
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/Integrations/Zenject.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 6f2c8f2b1b0b4f618d4f2711d8f6ac2b
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/Integrations.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: d4cc934a94a46b849bd0ce328eba12be
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/MessageAwareComponent.cs

@@ -1,6 +1,7 @@
 namespace DxMessaging.Unity
 {
     using Core;
+    using Core.MessageBus;
     using Core.Messages;
     using UnityEngine;
 
@@ -65,6 +66,9 @@ namespace DxMessaging.Unity
         protected virtual bool RegisterForStringMessages => true;
 
         protected MessagingComponent _messagingComponent;
+        protected IMessageBus _configuredMessageBus;
+        protected IMessageBusProvider _configuredMessageBusProvider;
+        protected MessageBusProviderHandle _configuredMessageBusProviderHandle;
 
         /// <summary>
         /// Creates the <see cref="MessagingComponent"/>, token, and calls <see cref="RegisterMessageHandlers"/>.
@@ -72,6 +76,30 @@ namespace DxMessaging.Unity
         protected virtual void Awake()
         {
             _messagingComponent = GetComponent<MessagingComponent>();
+            if (
+                _configuredMessageBusProvider == null
+                && _configuredMessageBusProviderHandle.TryGetProvider(
+                    out IMessageBusProvider handleProvider
+                )
+            )
+            {
+                _configuredMessageBusProvider = handleProvider;
+            }
+
+            if (_configuredMessageBusProvider != null)
+            {
+                _messagingComponent.Configure(
+                    _configuredMessageBusProvider,
+                    MessageBusRebindMode.PreserveRegistrations
+                );
+            }
+            else if (_configuredMessageBus != null)
+            {
+                _messagingComponent.Configure(
+                    _configuredMessageBus,
+                    MessageBusRebindMode.PreserveRegistrations
+                );
+            }
             _messageRegistrationToken = _messagingComponent.Create(this);
             RegisterMessageHandlers();
         }
@@ -143,6 +171,80 @@ namespace DxMessaging.Unity
             // Intentionally left blank
         }
 
+        /// <summary>
+        /// Supplies a custom <see cref="IMessageBus"/> for this component's underlying <see cref="MessageHandler"/>.
+        /// </summary>
+        /// <param name="messageBus">
+        /// Container-managed bus to use. Pass <see langword="null"/> to revert to the global bus
+        /// returned by <see cref="MessageHandler.MessageBus"/>.
+        /// </param>
+        /// <param name="rebindMode">Controls whether existing handlers should migrate to the provided bus immediately.</param>
+        /// <remarks>
+        /// Call this during dependency injection (before <see cref="Awake"/>) to ensure the token is created against
+        /// the provided bus, or invoke it later to retarget existing registrations.
+        /// </remarks>
+        public virtual void ConfigureMessageBus(
+            IMessageBus messageBus,
+            MessageBusRebindMode rebindMode
+        )
+        {
+            _configuredMessageBus = messageBus;
+            _configuredMessageBusProvider = null;
+            _configuredMessageBusProviderHandle = MessageBusProviderHandle.Empty;
+            _messagingComponent?.Configure(_configuredMessageBus, rebindMode);
+        }
+
+        /// <summary>
+        /// Supplies an <see cref="IMessageBusProvider"/> for this component's underlying <see cref="MessageHandler"/>.
+        /// </summary>
+        /// <param name="messageBusProvider">Provider used to resolve buses for this component.</param>
+        /// <param name="rebindMode">Controls whether existing handlers should migrate to the provided bus immediately.</param>
+        public virtual void ConfigureMessageBus(
+            IMessageBusProvider messageBusProvider,
+            MessageBusRebindMode rebindMode
+        )
+        {
+            _configuredMessageBusProvider = messageBusProvider;
+            if (messageBusProvider != null)
+            {
+                _configuredMessageBus = null;
+                _configuredMessageBusProviderHandle = MessageBusProviderHandle.FromProvider(
+                    messageBusProvider
+                );
+            }
+            else
+            {
+                _configuredMessageBusProviderHandle = MessageBusProviderHandle.Empty;
+            }
+
+            _messagingComponent?.Configure(_configuredMessageBusProvider, rebindMode);
+        }
+
+        /// <summary>
+        /// Supplies a serialized handle that resolves an <see cref="IMessageBusProvider"/>.
+        /// </summary>
+        /// <param name="providerHandle">Handle referencing the provider.</param>
+        /// <param name="rebindMode">Controls whether existing handlers should migrate to the provided bus immediately.</param>
+        public virtual void ConfigureMessageBus(
+            MessageBusProviderHandle providerHandle,
+            MessageBusRebindMode rebindMode
+        )
+        {
+            _configuredMessageBusProviderHandle = providerHandle;
+            if (providerHandle.TryGetProvider(out IMessageBusProvider provider))
+            {
+                _configuredMessageBusProvider = provider;
+                _configuredMessageBus = null;
+            }
+            else
+            {
+                _configuredMessageBusProvider = null;
+                _configuredMessageBusProviderHandle = MessageBusProviderHandle.Empty;
+            }
+
+            _messagingComponent?.Configure(providerHandle, rebindMode);
+        }
+
         /// <summary>
         /// Demo handler: targeted string message to this GameObject.
         /// Override to implement behavior.