@devframes/plugin-messages 0.0.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-PRESENT Anthony Fu <https://github.com/antfu>
+
+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,49 @@
+# @devframes/plugin-messages
+
+> [!WARNING] Experimental
+> This plugin is experimental and may change without a major version bump until
+> it stabilizes.
+
+A devframe plugin that surfaces the hub message feed (`ctx.messages`) as a
+portable panel: browse diagnostics and notifications from every mounted tool,
+filter by level / source / category / label, inspect stack traces, element and
+file positions, and jump to the offending file in your editor.
+
+Ported from the built-in Messages view of
+[`vitejs/devtools`](https://github.com/vitejs/devtools); rebuilt on devframe's
+framework-neutral client (`connectDevframe`) with a Vue + Vite SPA, reading the
+feed through `@devframes/hub`'s `listSince` delta API.
+
+## Mount into a hub
+
+```ts
+import { mountDevframe } from '@devframes/hub/node'
+import messagesDevframe from '@devframes/plugin-messages'
+
+await mountDevframe(hubContext, messagesDevframe)
+```
+
+The hub's `ctx.messages` host feeds the panel live — every
+`ctx.messages.add(...)` from any mounted tool shows up, updates stream over
+the `devframe:messages:updated` broadcast, and dismissals write back through
+the plugin's namespaced RPCs. On a plain (non-hub) context the plugin warns
+(`DP_MESSAGES_0001`) and serves an empty feed.
+
+## Embed the panel directly
+
+```ts
+import { mountMessages } from '@devframes/plugin-messages/client'
+
+const handle = await mountMessages(document.querySelector('#panel')!, {
+  rpc, // optional — reuse the host page's client
+})
+```
+
+## Standalone
+
+```bash
+npx @devframes/plugin-messages
+```
+
+`pnpm dev` in this package self-hosts the SPA against a demo-seeded messages
+host, so the feed is lively without a full hub.

package/bin.mjs

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import process from 'node:process'
+import { createMessagesCli } from './dist/cli.mjs'
+
+async function main() {
+  const cli = createMessagesCli()
+  await cli.parse()
+}
+
+main().catch((error) => {
+  console.error(error)
+  process.exit(1)
+})

package/dist/cli.d.mts

@@ -0,0 +1,12 @@
+import { CliHandle } from "devframe/adapters/cli";
+
+//#region src/cli.d.ts
+/**
+ * Build the standalone CLI for the messages panel — backs the package `bin`
+ * (`devframe-messages`) and `npx @devframes/plugin-messages`. Wraps the
+ * default {@link createMessagesDevframe} definition with devframe's
+ * `dev` / `build` / `spa` / `mcp` command shell.
+ */
+declare function createMessagesCli(): CliHandle;
+//#endregion
+export { createMessagesCli };

package/dist/cli.mjs

@@ -0,0 +1,14 @@
+import { n as messagesDevframe } from "./src-CY7M8Mzi.mjs";
+import { createCli } from "devframe/adapters/cli";
+//#region src/cli.ts
+/**
+* Build the standalone CLI for the messages panel — backs the package `bin`
+* (`devframe-messages`) and `npx @devframes/plugin-messages`. Wraps the
+* default {@link createMessagesDevframe} definition with devframe's
+* `dev` / `build` / `spa` / `mcp` command shell.
+*/
+function createMessagesCli() {
+	return createCli(messagesDevframe);
+}
+//#endregion
+export { createMessagesCli };