@proj-airi/plugin-protocol 0.9.0-alpha.18

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-PRESENT Neko Ayaka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+# @proj-airi/plugin-protocol
+
+Shared protocol contracts for plugin-module communication in Project AIRI.
+
+## What it does
+
+- Defines websocket event names and payload types for module/plugin orchestration.
+- Exposes Eventa event definitions bound to protocol event names.
+- Provides shared transport/event utility types used by server and plugin runtimes.
+
+## How to use
+
+```ts
+import type { WebSocketEvent, WebSocketEventOf, WebSocketEvents } from '@proj-airi/plugin-protocol/types'
+
+import { moduleAnnounce, moduleAuthenticate } from '@proj-airi/plugin-protocol/types'
+```
+
+## When to use
+
+- You need canonical protocol contracts for plugin <-> host communication.
+- You need event name stability and matching payload definitions across runtimes.
+
+## When not to use
+
+- You only need higher-level runtime client APIs from SDK packages.
+- You are implementing app-only UI state that is not part of plugin/server transport contracts.
+
+## License
+
+[MIT](../../LICENSE)