@devframes/plugin-messages 0.0.1

package/dist/constants.d.mts

@@ -0,0 +1,14 @@
+//#region src/constants.d.ts
+/** Devframe id — drives the hosted mount path `/__<id>/` and RPC namespacing. */
+declare const PLUGIN_ID = "devframes-plugin-messages";
+/** Preferred standalone CLI port (901x band shared by the core-ish plugins). */
+declare const DEFAULT_PORT = 9014;
+/**
+ * Server→client notification broadcast by the hub context whenever the
+ * message list changes (add/update/remove/clear). Mirrors `@devframes/hub`'s
+ * internal event name; kept as a literal so the client bundle carries no hub
+ * build dependency.
+ */
+declare const MESSAGES_UPDATED_EVENT = "devframe:messages:updated";
+//#endregion
+export { DEFAULT_PORT, MESSAGES_UPDATED_EVENT, PLUGIN_ID };

package/dist/constants.mjs

@@ -0,0 +1,14 @@
+//#region src/constants.ts
+/** Devframe id — drives the hosted mount path `/__<id>/` and RPC namespacing. */
+const PLUGIN_ID = "devframes-plugin-messages";
+/** Preferred standalone CLI port (901x band shared by the core-ish plugins). */
+const DEFAULT_PORT = 9014;
+/**
+* Server→client notification broadcast by the hub context whenever the
+* message list changes (add/update/remove/clear). Mirrors `@devframes/hub`'s
+* internal event name; kept as a literal so the client bundle carries no hub
+* build dependency.
+*/
+const MESSAGES_UPDATED_EVENT = "devframe:messages:updated";
+//#endregion
+export { DEFAULT_PORT, MESSAGES_UPDATED_EVENT, PLUGIN_ID };

package/dist/index.d.mts

@@ -0,0 +1,41 @@
+import { DEFAULT_PORT, MESSAGES_UPDATED_EVENT, PLUGIN_ID } from "./constants.mjs";
+import { DevframeMessageEntry, DevframeMessageEntryFrom, DevframeMessageEntryInput, DevframeMessageLevel, DevframeMessagesListDelta } from "./types.mjs";
+import { DevframeDefinition } from "devframe/types";
+
+//#region src/index.d.ts
+interface MessagesDevframeOptions {
+  /** Override the devframe id (and default CLI command / mount path). */
+  id?: string;
+  /** Override the display name shown in a host dock. */
+  name?: string;
+  /** Override the dock icon. */
+  icon?: string;
+  /**
+   * Override the mount path. Left unset, the SPA mounts at `/` standalone
+   * and `/__<id>/` when hosted (Vite/embedded).
+   */
+  basePath?: string;
+  /** Preferred standalone CLI port. */
+  port?: number;
+  /**
+   * Require the trust handshake on the standalone server. Defaults to
+   * `false` (auto-trust) since the panel is a single-user localhost tool.
+   * Hosted adapters manage their own auth.
+   */
+  auth?: boolean;
+}
+/**
+ * Build a {@link DevframeDefinition} for the hub message feed panel —
+ * a portable view over `ctx.messages`, ported from vitejs/devtools'
+ * built-in Messages view. The same definition runs standalone
+ * (`/cli`, `/spa`, `/build`) and mounts into a host (`/vite`, hub);
+ * a hub host is what feeds it live entries.
+ *
+ * @experimental This plugin is experimental and may change without a major
+ * version bump until it stabilizes.
+ */
+declare function createMessagesDevframe(options?: MessagesDevframeOptions): DevframeDefinition;
+/** The default messages devframe definition. */
+declare const messagesDevframe: DevframeDefinition;
+//#endregion
+export { DEFAULT_PORT, type DevframeMessageEntry, type DevframeMessageEntryFrom, type DevframeMessageEntryInput, type DevframeMessageLevel, type DevframeMessagesListDelta, MESSAGES_UPDATED_EVENT, MessagesDevframeOptions, PLUGIN_ID, createMessagesDevframe, messagesDevframe as default };

package/dist/index.mjs

@@ -0,0 +1,3 @@
+import { n as messagesDevframe, t as createMessagesDevframe } from "./src-CY7M8Mzi.mjs";
+import { DEFAULT_PORT, MESSAGES_UPDATED_EVENT, PLUGIN_ID } from "./constants.mjs";
+export { DEFAULT_PORT, MESSAGES_UPDATED_EVENT, PLUGIN_ID, createMessagesDevframe, messagesDevframe as default };

package/dist/node/index.d.mts

@@ -0,0 +1,16 @@
+import { serverFunctions } from "../rpc/index.mjs";
+import { DevframeNodeContext } from "devframe/types";
+
+//#region src/node/index.d.ts
+/**
+ * Register the message-feed RPC functions on a devframe node context.
+ * Called from the definition's `setup(ctx)` and reusable by host adapters
+ * that wire their own context.
+ *
+ * The plugin reads the feed from the hub-attached `ctx.messages` host. On a
+ * plain (non-hub) context it warns once and keeps the RPC surface registered
+ * as no-ops, so the panel still renders — with an empty feed.
+ */
+declare function setupMessages(ctx: DevframeNodeContext): void;
+//#endregion
+export { serverFunctions, setupMessages };

package/dist/node/index.mjs

@@ -0,0 +1,3 @@
+import { t as setupMessages } from "../node-CatHJRC8.mjs";
+import { t as serverFunctions } from "../rpc-DmXPM8sl.mjs";
+export { serverFunctions, setupMessages };

package/dist/node-CatHJRC8.mjs

@@ -0,0 +1,43 @@
+import { PLUGIN_ID } from "./constants.mjs";
+import { n as getMessagesHost, t as serverFunctions } from "./rpc-DmXPM8sl.mjs";
+import { openHelpers } from "devframe/recipes/open-helpers";
+import { colors } from "devframe/utils/colors";
+import { defineDiagnostics } from "nostics";
+import { ansiFormatter } from "nostics/formatters/ansi";
+//#region src/diagnostics.ts
+const formatAnsi = ansiFormatter(colors);
+function reporter(d, { method = "warn" } = {}) {
+	console[method](formatAnsi(d));
+}
+/**
+* Structured diagnostics for `@devframes/plugin-messages`. Node-side only.
+* Codes use the plugin-private `DP_MESSAGES_` band (see the built-in
+* plugins planning index) so they never collide with devframe core
+* (`DF00xx`) or `@devframes/hub` (`DF80xx`).
+*/
+const diagnostics = defineDiagnostics({
+	docsBase: "https://devfra.me/errors",
+	reporters: [reporter],
+	codes: { DP_MESSAGES_0001: {
+		why: (p) => `"${p.id}" is mounted on a context without a hub messages host (\`ctx.messages\`) — its RPC surface stays registered but no-ops, so the panel will show an empty feed.`,
+		fix: "Mount this devframe through a hub host (`@devframes/hub`'s `createHubContext` + `mountDevframe`) to get a live message feed."
+	} }
+});
+//#endregion
+//#region src/node/index.ts
+/**
+* Register the message-feed RPC functions on a devframe node context.
+* Called from the definition's `setup(ctx)` and reusable by host adapters
+* that wire their own context.
+*
+* The plugin reads the feed from the hub-attached `ctx.messages` host. On a
+* plain (non-hub) context it warns once and keeps the RPC surface registered
+* as no-ops, so the panel still renders — with an empty feed.
+*/
+function setupMessages(ctx) {
+	if (!getMessagesHost(ctx)) diagnostics.DP_MESSAGES_0001({ id: PLUGIN_ID });
+	for (const fn of serverFunctions) ctx.rpc.register(fn);
+	for (const fn of openHelpers) if (!ctx.rpc.definitions.has(fn.name)) ctx.rpc.register(fn);
+}
+//#endregion
+export { setupMessages as t };

package/dist/rpc/index.d.mts

@@ -0,0 +1,87 @@
+import * as _$_devframes_hub_types0 from "@devframes/hub/types";
+import * as _$devframe from "devframe";
+import * as _$devframe_rpc0 from "devframe/rpc";
+import { RpcDefinitionsToFunctions } from "devframe/rpc";
+
+//#region src/rpc/index.d.ts
+/**
+ * The message-feed RPC functions registered by the plugin — thin, typed
+ * wrappers over the hub's `ctx.messages` host. Namespaced
+ * `devframes-plugin-messages:*` per the plugin convention.
+ */
+declare const serverFunctions: readonly [{
+  name: "devframes-plugin-messages:list";
+  type?: "query" | undefined;
+  cacheable?: boolean;
+  args?: undefined;
+  returns?: undefined;
+  jsonSerializable?: boolean;
+  agent?: _$devframe.RpcFunctionAgentOptions;
+  setup?: ((context: _$devframe.DevframeNodeContext) => _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[since?: number | null | undefined], Promise<_$_devframes_hub_types0.DevframeMessagesListDelta>>>) | undefined;
+  handler?: ((since?: number | null | undefined) => Promise<_$_devframes_hub_types0.DevframeMessagesListDelta>) | undefined;
+  dump?: _$devframe_rpc0.RpcDump<[since?: number | null | undefined], Promise<_$_devframes_hub_types0.DevframeMessagesListDelta>, _$devframe.DevframeNodeContext> | undefined;
+  snapshot?: boolean;
+  __cache?: WeakMap<object, _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[since?: number | null | undefined], Promise<_$_devframes_hub_types0.DevframeMessagesListDelta>>>> | undefined;
+  __promise?: _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[since?: number | null | undefined], Promise<_$_devframes_hub_types0.DevframeMessagesListDelta>>> | undefined;
+}, {
+  name: "devframes-plugin-messages:add";
+  type?: "action" | undefined;
+  cacheable?: boolean;
+  args?: undefined;
+  returns?: undefined;
+  jsonSerializable?: boolean;
+  agent?: _$devframe.RpcFunctionAgentOptions;
+  setup?: ((context: _$devframe.DevframeNodeContext) => _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[input: _$_devframes_hub_types0.DevframeMessageEntryInput], Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>>>) | undefined;
+  handler?: ((input: _$_devframes_hub_types0.DevframeMessageEntryInput) => Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>) | undefined;
+  dump?: _$devframe_rpc0.RpcDump<[input: _$_devframes_hub_types0.DevframeMessageEntryInput], Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>, _$devframe.DevframeNodeContext> | undefined;
+  snapshot?: boolean;
+  __cache?: WeakMap<object, _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[input: _$_devframes_hub_types0.DevframeMessageEntryInput], Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>>>> | undefined;
+  __promise?: _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[input: _$_devframes_hub_types0.DevframeMessageEntryInput], Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>>> | undefined;
+}, {
+  name: "devframes-plugin-messages:update";
+  type?: "action" | undefined;
+  cacheable?: boolean;
+  args?: undefined;
+  returns?: undefined;
+  jsonSerializable?: boolean;
+  agent?: _$devframe.RpcFunctionAgentOptions;
+  setup?: ((context: _$devframe.DevframeNodeContext) => _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[id: string, patch: Partial<_$_devframes_hub_types0.DevframeMessageEntryInput>], Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>>>) | undefined;
+  handler?: ((id: string, patch: Partial<_$_devframes_hub_types0.DevframeMessageEntryInput>) => Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>) | undefined;
+  dump?: _$devframe_rpc0.RpcDump<[id: string, patch: Partial<_$_devframes_hub_types0.DevframeMessageEntryInput>], Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>, _$devframe.DevframeNodeContext> | undefined;
+  snapshot?: boolean;
+  __cache?: WeakMap<object, _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[id: string, patch: Partial<_$_devframes_hub_types0.DevframeMessageEntryInput>], Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>>>> | undefined;
+  __promise?: _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[id: string, patch: Partial<_$_devframes_hub_types0.DevframeMessageEntryInput>], Promise<_$_devframes_hub_types0.DevframeMessageEntry | null>>> | undefined;
+}, {
+  name: "devframes-plugin-messages:remove";
+  type?: "action" | undefined;
+  cacheable?: boolean;
+  args?: undefined;
+  returns?: undefined;
+  jsonSerializable?: boolean;
+  agent?: _$devframe.RpcFunctionAgentOptions;
+  setup?: ((context: _$devframe.DevframeNodeContext) => _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[id: string], Promise<void>>>) | undefined;
+  handler?: ((id: string) => Promise<void>) | undefined;
+  dump?: _$devframe_rpc0.RpcDump<[id: string], Promise<void>, _$devframe.DevframeNodeContext> | undefined;
+  snapshot?: boolean;
+  __cache?: WeakMap<object, _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[id: string], Promise<void>>>> | undefined;
+  __promise?: _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[id: string], Promise<void>>> | undefined;
+}, {
+  name: "devframes-plugin-messages:clear";
+  type?: "action" | undefined;
+  cacheable?: boolean;
+  args?: undefined;
+  returns?: undefined;
+  jsonSerializable?: boolean;
+  agent?: _$devframe.RpcFunctionAgentOptions;
+  setup?: ((context: _$devframe.DevframeNodeContext) => _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[], Promise<void>>>) | undefined;
+  handler?: (() => Promise<void>) | undefined;
+  dump?: _$devframe_rpc0.RpcDump<[], Promise<void>, _$devframe.DevframeNodeContext> | undefined;
+  snapshot?: boolean;
+  __cache?: WeakMap<object, _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[], Promise<void>>>> | undefined;
+  __promise?: _$devframe_rpc0.Thenable<_$devframe_rpc0.RpcFunctionSetupResult<[], Promise<void>>> | undefined;
+}];
+declare module 'devframe' {
+  interface DevframeRpcServerFunctions extends RpcDefinitionsToFunctions<typeof serverFunctions> {}
+}
+//#endregion
+export { serverFunctions };

package/dist/rpc/index.mjs

@@ -0,0 +1,2 @@
+import { t as serverFunctions } from "../rpc-DmXPM8sl.mjs";
+export { serverFunctions };

package/dist/rpc-DmXPM8sl.mjs

@@ -0,0 +1,115 @@
+import { createDefineWrapperWithContext } from "devframe/rpc";
+//#region src/rpc/functions/_define.ts
+/**
+* `defineRpcFunction` pre-bound to the framework-neutral
+* {@link DevframeNodeContext}, so each function's `setup(ctx)` receives the
+* typed node context instead of the default `undefined` context.
+*/
+const defineMessagesRpc = createDefineWrapperWithContext();
+/**
+* Read the hub-attached messages host off a node context, if present. The
+* plugin talks to `ctx.messages` structurally so its shipped code carries no
+* runtime dependency on `@devframes/hub` — hosts other than the hub can
+* satisfy the same surface.
+*/
+function getMessagesHost(ctx) {
+	return ctx.messages;
+}
+//#endregion
+//#region src/rpc/functions/add.ts
+/**
+* Add a message entry from a browser client. The origin is force-stamped
+* `from: 'browser'` so client-originated entries can't impersonate the
+* server. Returns the stored entry (with generated id/timestamp), or `null`
+* when no messages host is attached.
+*/
+const messagesAdd = defineMessagesRpc({
+	name: "devframes-plugin-messages:add",
+	type: "action",
+	jsonSerializable: true,
+	setup: (ctx) => ({ handler: async (input) => {
+		const host = getMessagesHost(ctx);
+		if (!host) return null;
+		return (await host.add({
+			...input,
+			from: "browser"
+		})).entry;
+	} })
+});
+//#endregion
+//#region src/rpc/functions/clear.ts
+/** Clear the whole message feed. */
+const messagesClear = defineMessagesRpc({
+	name: "devframes-plugin-messages:clear",
+	type: "action",
+	jsonSerializable: true,
+	setup: (ctx) => ({ handler: async () => {
+		await getMessagesHost(ctx)?.clear();
+	} })
+});
+//#endregion
+//#region src/rpc/functions/list.ts
+/**
+* Read the message list incrementally. Pass the `version` from the previous
+* result as `since` to receive only what changed; omit it for the initial
+* full snapshot. Apply `removedIds` before upserting `entries`.
+*
+* `snapshot: true` bakes the full list into static builds, so the panel
+* renders the last captured feed without a live server.
+*/
+const messagesList = defineMessagesRpc({
+	name: "devframes-plugin-messages:list",
+	type: "query",
+	jsonSerializable: true,
+	snapshot: true,
+	agent: {
+		title: "List messages",
+		description: "List the hub message feed — diagnostics, notifications, and tool output entries with level, category, labels, and positions."
+	},
+	setup: (ctx) => ({ handler: async (since) => {
+		const host = getMessagesHost(ctx);
+		if (!host) return {
+			entries: [],
+			removedIds: [],
+			version: 0,
+			full: true
+		};
+		return host.listSince(since);
+	} })
+});
+//#endregion
+//#region src/rpc/functions/remove.ts
+/** Remove (dismiss) a single message entry by id. */
+const messagesRemove = defineMessagesRpc({
+	name: "devframes-plugin-messages:remove",
+	type: "action",
+	jsonSerializable: true,
+	setup: (ctx) => ({ handler: async (id) => {
+		await getMessagesHost(ctx)?.remove(id);
+	} })
+});
+//#endregion
+//#region src/rpc/index.ts
+/**
+* The message-feed RPC functions registered by the plugin — thin, typed
+* wrappers over the hub's `ctx.messages` host. Namespaced
+* `devframes-plugin-messages:*` per the plugin convention.
+*/
+const serverFunctions = [
+	messagesList,
+	messagesAdd,
+	defineMessagesRpc({
+		name: "devframes-plugin-messages:update",
+		type: "action",
+		jsonSerializable: true,
+		setup: (ctx) => ({ handler: async (id, patch) => {
+			const host = getMessagesHost(ctx);
+			if (!host) return null;
+			return await host.update(id, patch) ?? null;
+		} })
+	}),
+	messagesRemove,
+	messagesClear
+];
+//#endregion
+export { getMessagesHost as n, serverFunctions as t };