@gjsify/devtools-protocol 0.36.0 → 0.37.0

package/lib/types/methods.d.ts

@@ -6,20 +6,16 @@
  */
 export type MethodKind = 'read-only' | 'presence' | 'mutating';
 /**
- * The generic, toolkit-neutral devtools methods and their kinds. Adapters
- * (DBus / WebSocket) implement the subset they support; the bridge
- * advertises only the implemented ones. App-specific methods are added via
- * extensions with their own kinds — the registry rejects an unclassified
- * method name, so a new method cannot bypass the pause policy unnoticed.
+ * The generic, toolkit-neutral devtools methods and their kinds. Adapters implement the
+ * subset they support and the bridge advertises only those; app-specific methods arrive
+ * through extensions with their own kinds, and the registry rejects an unclassified name
+ * so nothing can bypass the pause policy unnoticed.
  *
- * A NAME HERE IS A PROMISE, so nothing may be listed ahead of an adapter.
- * `SetProperty` and `EmitSignal` were classified `mutating` here and existed on
- * no wire at all: no `<method>` fragment in `GENERIC_METHODS_XML`, no handler
- * in `DevtoolsService`, no MCP tool. A caller reading this contract saw the
- * name and the kind, called it, and got `UnknownMethod` — the classification
- * made a method look supported and the pause policy look complete. Both were
- * removed rather than stubbed; add each back in the change that lands its
- * adapter, which is the only change that can prove the kind is right.
+ * A NAME HERE IS A PROMISE, so nothing may be listed ahead of an adapter. `SetProperty`
+ * and `EmitSignal` were once classified `mutating` here while existing on no wire at all
+ * — no XML fragment, no handler, no MCP tool — so a caller read the contract, called
+ * them and got `UnknownMethod`, while the pause policy looked complete. Add a method back
+ * in the change that lands its adapter, which is the only change that can prove the kind.
  */
 export declare const GENERIC_METHODS: {
     readonly GetStatus: "read-only";

package/lib/types/routing.d.ts

@@ -1,9 +1,7 @@
 /**
- * Coerce a free-form instance label into a valid app-id segment
- * (letter-led, lowercase alphanumeric). Shared by the in-app adapter and
- * the MCP bridge so both derive the SAME per-instance bus name — replacing
- * the byte-identical hand-maintained duplication the map-editor needed when
- * its bridge was dependency-free.
+ * Coerce a free-form instance label into a valid app-id segment (letter-led, lowercase
+ * alphanumeric). Shared by the in-app adapter and the MCP bridge, so both derive the
+ * SAME per-instance bus name.
  */
 export declare function sanitizeInstanceId(label: string): string;
 export interface BusAddress {
@@ -12,16 +10,14 @@ export interface BusAddress {
     instance: string;
 }
 /**
- * Resolve an instance label to its DBus bus name + devtools object path,
- * given the app's base id (e.g. `"org.example.App"`). The default instance
- * keeps the bare base; a named instance gets a `.<segment>` bus-name suffix
- * and a `/<segment>` path segment, so the bridge dials the right process
- * when several run side by side.
+ * Resolve an instance label to its DBus bus name + devtools object path, given the app's
+ * base id. The default instance keeps the bare base; a named instance gets a
+ * `.<segment>` bus-name suffix and a `/<segment>` path segment, so the bridge dials the
+ * right process when several run side by side.
  *
- * Mirrors `Gio.Application`'s own object-path derivation (id dots → slashes,
- * leading slash) plus a trailing `/devtools` leaf. The in-app adapter should
- * prefer the authoritative `app.get_dbus_object_path() + '/devtools'`; this
- * helper lets the bridge predict the same address for the dotted-id case.
+ * Mirrors `Gio.Application`'s own path derivation (id dots → slashes, leading slash) plus
+ * a `/devtools` leaf. The in-app adapter should prefer the authoritative
+ * `app.get_dbus_object_path() + '/devtools'`; this only lets the bridge PREDICT it.
  *
  * - `("org.example.App")` → `org.example.App` @ `/org/example/App/devtools`
  * - `("org.example.App", "host")` → `org.example.App.host` @ `/org/example/App/host/devtools`
@@ -32,10 +28,9 @@ export declare const DEVTOOLS_ENABLE_ENV = "GJSIFY_DEVTOOLS";
 /** Env var carrying the per-instance label for side-by-side apps. */
 export declare const DEVTOOLS_INSTANCE_ENV = "GJSIFY_DEVTOOLS_INSTANCE";
 /**
- * Env var carrying a D-Bus address for the BUS-LESS peer-to-peer transport.
- * On the app side it is the address to LISTEN on (`unix:tmpdir=/tmp`,
- * `unix:path=…`, `nonce-tcp:host=127.0.0.1`); on the bridge side it is the
- * address to DIAL. It exists because macOS and Windows have no session bus.
+ * D-Bus address for the BUS-LESS peer transport, which exists because macOS and Windows
+ * have no session bus. The app LISTENS on it (`unix:tmpdir=/tmp`, `unix:path=…`,
+ * `nonce-tcp:host=127.0.0.1`), the bridge DIALS it.
  */
 export declare const DEVTOOLS_ADDRESS_ENV = "GJSIFY_DEVTOOLS_ADDRESS";
 /** Whether a value read from {@link DEVTOOLS_ENABLE_ENV} turns devtools on. */
@@ -43,20 +38,18 @@ export declare function isDevtoolsEnabledValue(value: string | null | undefined)
 /** Directory (under the user's runtime dir) holding the per-app peer-address files. */
 export declare const DEVTOOLS_ADDRESS_DIR = "gjsify-devtools";
 /**
- * Path of the file an app on the peer transport writes its concrete CLIENT
- * address into, so a bridge can find it with no environment at all. This is the
- * bus-less analogue of `DBUS_SESSION_BUS_ADDRESS`: a peer socket has no
- * well-known name to look up, so the address itself has to be discoverable.
+ * Path of the file an app on the peer transport writes its concrete CLIENT address into,
+ * so a bridge can find it with no environment at all — the bus-less analogue of
+ * `DBUS_SESSION_BUS_ADDRESS`, since a peer socket has no well-known name to look up.
  *
- * `runtimeDir` is passed IN rather than probed, keeping this package free of
- * platform imports (both sides pass `GLib.get_user_runtime_dir()`).
- *
- * The name derives from the SAME bus name {@link resolveBusAddress} derives, so
- * an instance label routes both transports identically:
+ * `runtimeDir` is passed IN rather than probed, which keeps this package free of platform
+ * imports (both sides pass `GLib.get_user_runtime_dir()`). The name derives from the SAME
+ * bus name {@link resolveBusAddress} does, so one instance label routes both transports
+ * identically:
  * - `(dir, "org.example.App")` → `<dir>/gjsify-devtools/org.example.App.address`
  * - `(dir, "org.example.App", "host")` → `<dir>/gjsify-devtools/org.example.App.host.address`
  *
- * Forward slashes unconditionally: GLib/GIO accept them as separators on win32
- * too, and a per-platform separator would need a platform probe in a pure module.
+ * Forward slashes unconditionally: GLib/GIO accept them on win32 too, and a per-platform
+ * separator would need a platform probe in a pure module.
  */
 export declare function devtoolsAddressFilePath(runtimeDir: string, base: string, label?: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/devtools-protocol",
-    "version": "0.36.0",
+    "version": "0.37.0",
     "description": "Transport-agnostic devtools contract (methods, JSON envelope, method-kinds, transport interface) shared by every gjsify devtools adapter and the MCP bridge",
     "type": "module",
     "module": "lib/esm/index.js",
@@ -35,8 +35,8 @@
     ],
     "dependencies": {},
     "devDependencies": {
-        "@gjsify/cli": "^0.36.0",
-        "@gjsify/unit": "^0.36.0",
+        "@gjsify/cli": "^0.37.0",
+        "@gjsify/unit": "^0.37.0",
         "@types/node": "^25.9.2",
         "typescript": "^6.0.3"
     },