hivemind-ovos-agent-plugin 0.1.0__tar.gz

hivemind_ovos_agent_plugin-0.1.0/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Casimiro Ferreira
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hivemind_ovos_agent_plugin-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: hivemind-ovos-agent-plugin
+Version: 0.1.0
+Summary: OVOS agent protocol plugin for HiveMind-core
+Author-email: jarbasAi <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/JarbasHiveMind/hivemind-ovos-agent-plugin
+Project-URL: Issues, https://github.com/JarbasHiveMind/hivemind-ovos-agent-plugin/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: ovos-bus-client<2.0.0,>=1.3.1
+Requires-Dist: ovos-config<3.0.0,>=0.0.12
+Requires-Dist: ovos-utils<1.0.0,>=0.8.2
+Requires-Dist: hivemind-bus-client<1.0.0,>=0.7.0a2
+Requires-Dist: hivemind-plugin-manager<1.0.0,>=0.3.0
+Requires-Dist: pyee<13.0.0,>=8.1.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# HiveMind OVOS Agent Plugin
+
+OVOS agent protocol plugin for [HiveMind-core](https://github.com/JarbasHiveMind/HiveMind-core).
+
+Bridges HiveMind client messages to an [OpenVoiceOS](https://github.com/OpenVoiceOS) message bus.
+HiveMind clients connect to a `hivemind-core` listener, and this plugin forwards their
+Mycroft `Message` payloads to a local OVOS bus (and routes OVOS responses back to the
+originating client).
+
+## Installation
+
+```bash
+pip install hivemind-ovos-agent-plugin
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/JarbasHiveMind/hivemind-ovos-agent-plugin
+cd hivemind-ovos-agent-plugin
+pip install -e .
+```
+
+## Usage
+
+The plugin registers itself as a HiveMind agent protocol via the
+`hivemind.agent.protocol` entry point group, with name `hivemind-ovos-agent-plugin`.
+
+In your `hivemind-core` configuration:
+
+```json
+{
+  "agent_protocol": {
+    "hivemind-ovos-agent-plugin": {
+      "host": "127.0.0.1",
+      "port": 8181
+    }
+  }
+}
+```
+
+`hivemind-core` will discover the plugin via its entry point and instantiate the
+`OVOSAgentProtocol` class with the supplied config. The plugin connects to the OVOS
+message bus at the given host/port (defaulting to `127.0.0.1:8181`).
+
+### Direct programmatic use
+
+```python
+from hivemind_ovos_agent_plugin import OVOSAgentProtocol
+
+agent = OVOSAgentProtocol(config={"host": "127.0.0.1", "port": 8181})
+# pass `agent` to your HiveMindListenerProtocol
+```
+
+## How it works
+
+The plugin owns two callbacks on the OVOS bus:
+
+- **`hive.send.downstream`** — emitted by OVOS components that want to push a
+  `HiveMessage` to a connected HiveMind client. The plugin wraps the payload in a
+  `HiveMessage` and dispatches it to the right peer, or fans it out for
+  `PROPAGATE`/`BROADCAST` types.
+- **`message`** (catch-all) — every internal OVOS bus message is inspected. If its
+  `context["destination"]` lists a connected HiveMind peer, the plugin forwards it back
+  to that peer wrapped as a `HiveMessageType.BUS` message. This is where **client
+  isolation** is enforced: a client never sees responses meant for another client.
+
+Upstream traffic (client → OVOS bus) is handled by `hivemind-core` itself; this plugin
+only handles the downstream half.
+
+
+## Documentation
+
+Full developer documentation lives in [`docs/`](docs/):
+
+- [`docs/architecture.md`](docs/architecture.md) — how the plugin fits between HiveMind
+  and OVOS.
+- [`docs/configuration.md`](docs/configuration.md) — every config knob.
+- [`docs/message_flow.md`](docs/message_flow.md) — end-to-end message lifecycle.
+- [`docs/development.md`](docs/development.md) — running tests, releasing.
+
+## License
+
+Apache 2.0. See [LICENSE.md](LICENSE.md).

hivemind_ovos_agent_plugin-0.1.0/README.md

@@ -0,0 +1,84 @@
+# HiveMind OVOS Agent Plugin
+
+OVOS agent protocol plugin for [HiveMind-core](https://github.com/JarbasHiveMind/HiveMind-core).
+
+Bridges HiveMind client messages to an [OpenVoiceOS](https://github.com/OpenVoiceOS) message bus.
+HiveMind clients connect to a `hivemind-core` listener, and this plugin forwards their
+Mycroft `Message` payloads to a local OVOS bus (and routes OVOS responses back to the
+originating client).
+
+## Installation
+
+```bash
+pip install hivemind-ovos-agent-plugin
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/JarbasHiveMind/hivemind-ovos-agent-plugin
+cd hivemind-ovos-agent-plugin
+pip install -e .
+```
+
+## Usage
+
+The plugin registers itself as a HiveMind agent protocol via the
+`hivemind.agent.protocol` entry point group, with name `hivemind-ovos-agent-plugin`.
+
+In your `hivemind-core` configuration:
+
+```json
+{
+  "agent_protocol": {
+    "hivemind-ovos-agent-plugin": {
+      "host": "127.0.0.1",
+      "port": 8181
+    }
+  }
+}
+```
+
+`hivemind-core` will discover the plugin via its entry point and instantiate the
+`OVOSAgentProtocol` class with the supplied config. The plugin connects to the OVOS
+message bus at the given host/port (defaulting to `127.0.0.1:8181`).
+
+### Direct programmatic use
+
+```python
+from hivemind_ovos_agent_plugin import OVOSAgentProtocol
+
+agent = OVOSAgentProtocol(config={"host": "127.0.0.1", "port": 8181})
+# pass `agent` to your HiveMindListenerProtocol
+```
+
+## How it works
+
+The plugin owns two callbacks on the OVOS bus:
+
+- **`hive.send.downstream`** — emitted by OVOS components that want to push a
+  `HiveMessage` to a connected HiveMind client. The plugin wraps the payload in a
+  `HiveMessage` and dispatches it to the right peer, or fans it out for
+  `PROPAGATE`/`BROADCAST` types.
+- **`message`** (catch-all) — every internal OVOS bus message is inspected. If its
+  `context["destination"]` lists a connected HiveMind peer, the plugin forwards it back
+  to that peer wrapped as a `HiveMessageType.BUS` message. This is where **client
+  isolation** is enforced: a client never sees responses meant for another client.
+
+Upstream traffic (client → OVOS bus) is handled by `hivemind-core` itself; this plugin
+only handles the downstream half.
+
+
+## Documentation
+
+Full developer documentation lives in [`docs/`](docs/):
+
+- [`docs/architecture.md`](docs/architecture.md) — how the plugin fits between HiveMind
+  and OVOS.
+- [`docs/configuration.md`](docs/configuration.md) — every config knob.
+- [`docs/message_flow.md`](docs/message_flow.md) — end-to-end message lifecycle.
+- [`docs/development.md`](docs/development.md) — running tests, releasing.
+
+## License
+
+Apache 2.0. See [LICENSE.md](LICENSE.md).

hivemind_ovos_agent_plugin-0.1.0/hivemind_ovos_agent_plugin/__init__.py

@@ -0,0 +1,101 @@
+import dataclasses
+from typing import Dict, Any
+
+from ovos_bus_client import MessageBusClient
+from ovos_bus_client.message import Message
+from ovos_config import Configuration
+from ovos_utils.fakebus import FakeBus
+from ovos_utils.log import LOG
+from pyee import EventEmitter
+
+from hivemind_bus_client.message import HiveMessage, HiveMessageType
+from hivemind_plugin_manager.protocols import AgentProtocol
+
+from hivemind_ovos_agent_plugin.version import __version__
+
+
+@dataclasses.dataclass()
+class OVOSAgentProtocol(AgentProtocol):
+    """HiveMind agent protocol that bridges client messages to an OVOS bus."""
+    bus: MessageBusClient = dataclasses.field(default_factory=FakeBus)
+    config: Dict[str, Any] = dataclasses.field(default_factory=lambda: Configuration().get("websocket", {}))
+
+    def __post_init__(self):
+        if not self.bus or isinstance(self.bus, FakeBus):
+            ovos_bus_address = self.config.get("host") or "127.0.0.1"
+            ovos_bus_port = self.config.get("port") or 8181
+            self.bus = MessageBusClient(
+                host=ovos_bus_address,
+                port=ovos_bus_port,
+                emitter=EventEmitter(),
+            )
+            self.bus.run_in_thread()
+            self.bus.connected_event.wait()
+        self.register_bus_handlers()
+
+    def register_bus_handlers(self):
+        LOG.debug("registering internal OVOS bus handlers")
+        self.bus.on("hive.send.downstream", self.handle_send)
+        self.bus.on("message", self.handle_internal_mycroft)  # catch all
+
+    # mycroft handlers - from master -> slave
+    def handle_send(self, message: Message):
+        """ovos wants to send a HiveMessage.
+
+        A device can be both a master and a slave; downstream messages are handled here.
+        HiveMindSlaveInternalProtocol handles requests meant to go upstream.
+        """
+        payload = message.data.get("payload")
+        peer = message.data.get("peer")
+        msg_type = message.data["msg_type"]
+
+        hmessage = HiveMessage(msg_type, payload=payload, target_peers=[peer])
+
+        if msg_type in [HiveMessageType.PROPAGATE, HiveMessageType.BROADCAST]:
+            for peer in self.clients:
+                self.clients[peer].send(hmessage)
+        elif msg_type == HiveMessageType.ESCALATE:
+            # only slaves can escalate, ignore silently
+            pass
+        elif peer:
+            if peer in self.clients:
+                client = self.clients[peer]
+                client.send(hmessage)
+            else:
+                LOG.error("That client is not connected")
+                self.bus.emit(
+                    message.forward(
+                        "hive.client.send.error",
+                        {"error": "That client is not connected", "peer": peer},
+                    )
+                )
+
+    def handle_internal_mycroft(self, message: str):
+        """Forward internal messages to clients if they are the target.
+
+        Client isolation happens here: clients only get responses to their own messages.
+        """
+        message = Message.deserialize(message)
+        target_peers = message.context.get("destination") or []
+        if not isinstance(target_peers, list):
+            target_peers = [target_peers]
+
+        if target_peers:
+            for peer, client in self.clients.items():
+                if peer in target_peers:
+                    LOG.debug(f"{message.msg_type} - destination: {peer}")
+                    message.context["source"] = "hive"
+                    msg = HiveMessage(
+                        HiveMessageType.BUS,
+                        source_peer=peer,
+                        target_peers=target_peers,
+                        payload=message,
+                    )
+                    client.send(msg)
+
+
+# back-compat alias for the old class name shipped from ovos-bus-client
+OVOSProtocol = OVOSAgentProtocol
+
+
+__all__ = ["OVOSAgentProtocol", "OVOSProtocol", "__version__"]

hivemind_ovos_agent_plugin-0.1.0/hivemind_ovos_agent_plugin/version.py

@@ -0,0 +1,8 @@
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 1
+VERSION_BUILD = 0
+VERSION_ALPHA = 0
+# END_VERSION_BLOCK
+
+__version__ = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_BUILD}" + (f"a{VERSION_ALPHA}" if VERSION_ALPHA else "")

hivemind_ovos_agent_plugin-0.1.0/hivemind_ovos_agent_plugin.egg-info/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: hivemind-ovos-agent-plugin
+Version: 0.1.0
+Summary: OVOS agent protocol plugin for HiveMind-core
+Author-email: jarbasAi <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/JarbasHiveMind/hivemind-ovos-agent-plugin
+Project-URL: Issues, https://github.com/JarbasHiveMind/hivemind-ovos-agent-plugin/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: ovos-bus-client<2.0.0,>=1.3.1
+Requires-Dist: ovos-config<3.0.0,>=0.0.12
+Requires-Dist: ovos-utils<1.0.0,>=0.8.2
+Requires-Dist: hivemind-bus-client<1.0.0,>=0.7.0a2
+Requires-Dist: hivemind-plugin-manager<1.0.0,>=0.3.0
+Requires-Dist: pyee<13.0.0,>=8.1.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# HiveMind OVOS Agent Plugin
+
+OVOS agent protocol plugin for [HiveMind-core](https://github.com/JarbasHiveMind/HiveMind-core).
+
+Bridges HiveMind client messages to an [OpenVoiceOS](https://github.com/OpenVoiceOS) message bus.
+HiveMind clients connect to a `hivemind-core` listener, and this plugin forwards their
+Mycroft `Message` payloads to a local OVOS bus (and routes OVOS responses back to the
+originating client).
+
+## Installation
+
+```bash
+pip install hivemind-ovos-agent-plugin
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/JarbasHiveMind/hivemind-ovos-agent-plugin
+cd hivemind-ovos-agent-plugin
+pip install -e .
+```
+
+## Usage
+
+The plugin registers itself as a HiveMind agent protocol via the
+`hivemind.agent.protocol` entry point group, with name `hivemind-ovos-agent-plugin`.
+
+In your `hivemind-core` configuration:
+
+```json
+{
+  "agent_protocol": {
+    "hivemind-ovos-agent-plugin": {
+      "host": "127.0.0.1",
+      "port": 8181
+    }
+  }
+}
+```
+
+`hivemind-core` will discover the plugin via its entry point and instantiate the
+`OVOSAgentProtocol` class with the supplied config. The plugin connects to the OVOS
+message bus at the given host/port (defaulting to `127.0.0.1:8181`).
+
+### Direct programmatic use
+
+```python
+from hivemind_ovos_agent_plugin import OVOSAgentProtocol
+
+agent = OVOSAgentProtocol(config={"host": "127.0.0.1", "port": 8181})
+# pass `agent` to your HiveMindListenerProtocol
+```
+
+## How it works
+
+The plugin owns two callbacks on the OVOS bus:
+
+- **`hive.send.downstream`** — emitted by OVOS components that want to push a
+  `HiveMessage` to a connected HiveMind client. The plugin wraps the payload in a
+  `HiveMessage` and dispatches it to the right peer, or fans it out for
+  `PROPAGATE`/`BROADCAST` types.
+- **`message`** (catch-all) — every internal OVOS bus message is inspected. If its
+  `context["destination"]` lists a connected HiveMind peer, the plugin forwards it back
+  to that peer wrapped as a `HiveMessageType.BUS` message. This is where **client
+  isolation** is enforced: a client never sees responses meant for another client.
+
+Upstream traffic (client → OVOS bus) is handled by `hivemind-core` itself; this plugin
+only handles the downstream half.
+
+
+## Documentation
+
+Full developer documentation lives in [`docs/`](docs/):
+
+- [`docs/architecture.md`](docs/architecture.md) — how the plugin fits between HiveMind
+  and OVOS.
+- [`docs/configuration.md`](docs/configuration.md) — every config knob.
+- [`docs/message_flow.md`](docs/message_flow.md) — end-to-end message lifecycle.
+- [`docs/development.md`](docs/development.md) — running tests, releasing.
+
+## License
+
+Apache 2.0. See [LICENSE.md](LICENSE.md).

hivemind_ovos_agent_plugin-0.1.0/hivemind_ovos_agent_plugin.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE.md
+README.md
+pyproject.toml
+hivemind_ovos_agent_plugin/__init__.py
+hivemind_ovos_agent_plugin/version.py
+hivemind_ovos_agent_plugin.egg-info/PKG-INFO
+hivemind_ovos_agent_plugin.egg-info/SOURCES.txt
+hivemind_ovos_agent_plugin.egg-info/dependency_links.txt
+hivemind_ovos_agent_plugin.egg-info/entry_points.txt
+hivemind_ovos_agent_plugin.egg-info/requires.txt
+hivemind_ovos_agent_plugin.egg-info/top_level.txt
+tests/test_bus_registration.py
+tests/test_handle_send.py
+tests/test_import.py
+tests/test_isolation.py

hivemind_ovos_agent_plugin-0.1.0/hivemind_ovos_agent_plugin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hivemind_ovos_agent_plugin-0.1.0/hivemind_ovos_agent_plugin.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[hivemind.agent.protocol]
+hivemind-ovos-agent-plugin = hivemind_ovos_agent_plugin:OVOSAgentProtocol

hivemind_ovos_agent_plugin-0.1.0/hivemind_ovos_agent_plugin.egg-info/requires.txt

@@ -0,0 +1,10 @@
+ovos-bus-client<2.0.0,>=1.3.1
+ovos-config<3.0.0,>=0.0.12
+ovos-utils<1.0.0,>=0.8.2
+hivemind-bus-client<1.0.0,>=0.7.0a2
+hivemind-plugin-manager<1.0.0,>=0.3.0
+pyee<13.0.0,>=8.1.0
+
+[test]
+pytest
+pytest-cov

hivemind_ovos_agent_plugin-0.1.0/hivemind_ovos_agent_plugin.egg-info/top_level.txt

@@ -0,0 +1 @@
+hivemind_ovos_agent_plugin

hivemind_ovos_agent_plugin-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hivemind-ovos-agent-plugin"
+dynamic = ["version"]
+description = "OVOS agent protocol plugin for HiveMind-core"
+license = { text = "Apache-2.0" }
+readme = "README.md"
+authors = [
+    { name = "jarbasAi", email = "jarbasai@mailfence.com" }
+]
+requires-python = ">=3.10"
+dependencies = [
+    "ovos-bus-client>=1.3.1,<2.0.0",
+    "ovos-config>=0.0.12,<3.0.0",
+    "ovos-utils>=0.8.2,<1.0.0",
+    "hivemind-bus-client>=0.7.0a2,<1.0.0",
+    "hivemind-plugin-manager>=0.3.0,<1.0.0",
+    "pyee>=8.1.0,<13.0.0",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+]
+
+[project.urls]
+Homepage = "https://github.com/JarbasHiveMind/hivemind-ovos-agent-plugin"
+Issues = "https://github.com/JarbasHiveMind/hivemind-ovos-agent-plugin/issues"
+
+[project.entry-points."hivemind.agent.protocol"]
+"hivemind-ovos-agent-plugin" = "hivemind_ovos_agent_plugin:OVOSAgentProtocol"
+
+[tool.setuptools.dynamic]
+version = { attr = "hivemind_ovos_agent_plugin.version.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["hivemind_ovos_agent_plugin*"]

hivemind_ovos_agent_plugin-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hivemind_ovos_agent_plugin-0.1.0/tests/test_bus_registration.py

@@ -0,0 +1,20 @@
+"""Verify the plugin registers the expected handlers on the OVOS bus."""
+
+from hivemind_ovos_agent_plugin import OVOSAgentProtocol
+
+
+class TestBusRegistration:
+    def test_registers_hive_send_downstream(self, agent, fake_bus):
+        # FakeBus stores listeners on its internal emitter
+        listeners = fake_bus.ee.listeners("hive.send.downstream")
+        assert any(l.__func__ is OVOSAgentProtocol.handle_send for l in listeners) or \
+               any(getattr(l, "__name__", "") == "handle_send" for l in listeners)
+
+    def test_registers_catch_all_message_listener(self, agent, fake_bus):
+        listeners = fake_bus.ee.listeners("message")
+        assert any(getattr(l, "__name__", "") == "handle_internal_mycroft" for l in listeners) or \
+               any(l.__func__ is OVOSAgentProtocol.handle_internal_mycroft for l in listeners)
+
+    def test_bus_field_is_kept(self, agent, fake_bus):
+        """The bus the plugin operates on is the one we wired in."""
+        assert agent.bus is fake_bus

hivemind_ovos_agent_plugin-0.1.0/tests/test_handle_send.py

@@ -0,0 +1,80 @@
+"""Tests for OVOSAgentProtocol.handle_send (downstream dispatch from OVOS bus)."""
+
+from ovos_bus_client.message import Message
+from hivemind_bus_client.message import HiveMessage, HiveMessageType
+
+
+def _send_msg(msg_type, peer=None, payload=None):
+    """Helper to build the ovos Message that triggers handle_send."""
+    return Message("hive.send.downstream", {
+        "msg_type": msg_type,
+        "peer": peer,
+        "payload": payload,
+    })
+
+
+class TestHandleSendDirect:
+    def test_dispatch_to_connected_peer(self, agent, make_client):
+        peer = "ws://1.2.3.4:5678"
+        client = make_client(peer)
+        agent.hm_protocol.clients = {peer: client}
+
+        agent.handle_send(_send_msg(HiveMessageType.BUS, peer=peer, payload={"x": 1}))
+
+        client.send.assert_called_once()
+        sent = client.send.call_args[0][0]
+        assert isinstance(sent, HiveMessage)
+        assert sent.msg_type == HiveMessageType.BUS
+
+    def test_unknown_peer_emits_error_on_bus(self, agent, make_client, fake_bus):
+        seen = []
+        fake_bus.on("hive.client.send.error", lambda m: seen.append(m))
+
+        agent.hm_protocol.clients = {}  # nobody connected
+        agent.handle_send(_send_msg(HiveMessageType.BUS, peer="ws://missing:1234", payload={}))
+
+        assert len(seen) == 1
+        assert seen[0].data["peer"] == "ws://missing:1234"
+        assert "not connected" in seen[0].data["error"].lower()
+
+    def test_no_peer_no_dispatch(self, agent, make_client):
+        c1 = make_client("ws://a")
+        c2 = make_client("ws://b")
+        agent.hm_protocol.clients = {"ws://a": c1, "ws://b": c2}
+
+        # msg_type that isn't propagate/broadcast/escalate, with peer=None
+        agent.handle_send(_send_msg(HiveMessageType.BUS, peer=None, payload={}))
+
+        c1.send.assert_not_called()
+        c2.send.assert_not_called()
+
+
+class TestHandleSendFanout:
+    def test_propagate_fans_out_to_all(self, agent, make_client):
+        peers = [f"ws://{i}" for i in range(3)]
+        clients = {p: make_client(p) for p in peers}
+        agent.hm_protocol.clients = clients
+
+        agent.handle_send(_send_msg(HiveMessageType.PROPAGATE, peer=peers[0], payload={}))
+
+        for c in clients.values():
+            c.send.assert_called_once()
+
+    def test_broadcast_fans_out_to_all(self, agent, make_client):
+        peers = [f"ws://{i}" for i in range(3)]
+        clients = {p: make_client(p) for p in peers}
+        agent.hm_protocol.clients = clients
+
+        agent.handle_send(_send_msg(HiveMessageType.BROADCAST, peer=peers[0], payload={}))
+
+        for c in clients.values():
+            c.send.assert_called_once()
+
+    def test_escalate_is_silently_ignored(self, agent, make_client):
+        c = make_client("ws://a")
+        agent.hm_protocol.clients = {"ws://a": c}
+
+        agent.handle_send(_send_msg(HiveMessageType.ESCALATE, peer="ws://a", payload={}))
+
+        # ESCALATE goes upstream, not downstream — no client should be sent to
+        c.send.assert_not_called()

hivemind_ovos_agent_plugin-0.1.0/tests/test_import.py

@@ -0,0 +1,36 @@
+"""Sanity tests: public surface and version."""
+
+import hivemind_ovos_agent_plugin as pkg
+
+
+def test_public_class_exported():
+    assert hasattr(pkg, "OVOSAgentProtocol")
+
+
+def test_backcompat_alias_exists():
+    """The old name shipped by ovos-bus-client[hivemind] must still resolve."""
+    assert pkg.OVOSProtocol is pkg.OVOSAgentProtocol
+
+
+def test_version_string():
+    assert isinstance(pkg.__version__, str)
+    assert pkg.__version__.split(".")[0].isdigit()
+
+
+def test_is_agent_protocol_subclass():
+    from hivemind_plugin_manager.protocols import AgentProtocol
+    assert issubclass(pkg.OVOSAgentProtocol, AgentProtocol)
+
+
+def test_entry_point_registered():
+    """The plugin must be discoverable via the hivemind.agent.protocol entry point."""
+    try:
+        from importlib.metadata import entry_points
+    except ImportError:  # pragma: no cover
+        from importlib_metadata import entry_points  # type: ignore
+
+    eps = entry_points()
+    # python 3.10+ select API
+    group = eps.select(group="hivemind.agent.protocol") if hasattr(eps, "select") else eps.get("hivemind.agent.protocol", [])
+    names = {ep.name for ep in group}
+    assert "hivemind-ovos-agent-plugin" in names

hivemind_ovos_agent_plugin-0.1.0/tests/test_isolation.py

@@ -0,0 +1,73 @@
+"""Client isolation invariant: a client must only receive messages targeted at it."""
+
+from ovos_bus_client.message import Message
+from hivemind_bus_client.message import HiveMessageType
+
+
+def _ovos_internal(msg_type, destination=None, data=None):
+    """Build the serialized JSON that handle_internal_mycroft expects."""
+    msg = Message(msg_type, data or {}, {"destination": destination} if destination is not None else {})
+    return msg.serialize()
+
+
+class TestClientIsolation:
+    def test_message_addressed_to_one_client_only_reaches_that_client(self, agent, make_client):
+        alice = make_client("ws://alice")
+        bob = make_client("ws://bob")
+        agent.hm_protocol.clients = {"ws://alice": alice, "ws://bob": bob}
+
+        agent.handle_internal_mycroft(_ovos_internal("speak", destination="ws://alice", data={"utterance": "hi"}))
+
+        alice.send.assert_called_once()
+        bob.send.assert_not_called()
+
+    def test_destination_can_be_a_list(self, agent, make_client):
+        alice = make_client("ws://alice")
+        bob = make_client("ws://bob")
+        carol = make_client("ws://carol")
+        agent.hm_protocol.clients = {"ws://alice": alice, "ws://bob": bob, "ws://carol": carol}
+
+        agent.handle_internal_mycroft(_ovos_internal("speak", destination=["ws://alice", "ws://bob"]))
+
+        alice.send.assert_called_once()
+        bob.send.assert_called_once()
+        carol.send.assert_not_called()
+
+    def test_message_with_no_destination_is_dropped(self, agent, make_client):
+        alice = make_client("ws://alice")
+        bob = make_client("ws://bob")
+        agent.hm_protocol.clients = {"ws://alice": alice, "ws://bob": bob}
+
+        agent.handle_internal_mycroft(_ovos_internal("speak", destination=None, data={"utterance": "hi"}))
+
+        alice.send.assert_not_called()
+        bob.send.assert_not_called()
+
+    def test_message_addressed_to_unknown_peer_is_dropped(self, agent, make_client):
+        alice = make_client("ws://alice")
+        agent.hm_protocol.clients = {"ws://alice": alice}
+
+        agent.handle_internal_mycroft(_ovos_internal("speak", destination="ws://stranger"))
+
+        alice.send.assert_not_called()
+
+    def test_forwarded_message_is_wrapped_as_bus_hivemessage(self, agent, make_client):
+        alice = make_client("ws://alice")
+        agent.hm_protocol.clients = {"ws://alice": alice}
+
+        agent.handle_internal_mycroft(_ovos_internal("speak", destination="ws://alice"))
+
+        sent = alice.send.call_args[0][0]
+        assert sent.msg_type == HiveMessageType.BUS
+        # payload is the Mycroft Message
+        assert sent.payload.msg_type == "speak"
+
+    def test_forwarded_message_marks_source_as_hive(self, agent, make_client):
+        """Downstream relays must rewrite source so the client sees it came from the hive."""
+        alice = make_client("ws://alice")
+        agent.hm_protocol.clients = {"ws://alice": alice}
+
+        agent.handle_internal_mycroft(_ovos_internal("speak", destination="ws://alice"))
+
+        sent = alice.send.call_args[0][0]
+        assert sent.payload.context.get("source") == "hive"