@php-wasm/xdebug-bridge 2.0.0 → 2.0.2

package/README.md

@@ -13,24 +13,21 @@ npm install @php-wasm/xdebug-bridge
 ### Programmatic API
 
 ```typescript
-import { startXDebugBridge } from '@php-wasm/xdebug-bridge';
+import { startBridge } from './xdebug-bridge/src/start-bridge';
 
 // Start with default settings
-const server = startXDebugBridge();
+const server = startBridge();
 await server.start();
 
 // Start with custom configuration
-const server = startXDebugBridge({
-	protocol: 'cdp', // or 'dap'
-	xdebugServerPort: 9003, // XDebug connection port
-	xdebugServerHost: 'localhost',
-	verbose: false, // Silent mode
+const server = startBridge({
+	cdpHost: 'localhost', // CDP connection host
+	cdpPort: 9229, // CDP connection port
+	dbgpPort: 9003, // XDebug connection port
+	phpRoot: './', // Root to directory
 });
 
 await server.start();
-
-// Stop the server
-await server.stop();
 ```
 
 ### CLI Usage
@@ -42,29 +39,31 @@ npx xdebug-bridge
 # Custom port and verbose logging
 npx xdebug-bridge --port 9000 --verbose
 
-# DAP protocol, bind to all interfaces
-npx xdebug-bridge --protocol dap --host 0.0.0.0
-
 # Show help
 npx xdebug-bridge --help
 ```
 
 ## Configuration Options
 
--   `protocol`: Protocol to use ('cdp' or 'dap', default: 'cdp')
--   `xdebugServerPort`: Port to listen for XDebug connections (default: 9003)
--   `xdebugServerHost`: Host to bind to (default: 'localhost')
--   `verbose`: Enable verbose logging (default: false for API, true for CLI)
--   `logger`: Custom logger function
+-   `cdpPort`: Port to listen for CDP connections (default: 9229)
+-   `cdpHost`: Host to bind to (default: 'localhost')
+-   `dbgpPort`: Port to listen for XDebug connections (default: 9003)
+-   `phpRoot`: Root path for php files;
+-   `remoteRoot`: Remote root path for php files;
+-   `localRoot`: Local root path for php files;
+-   `phpInstance`: PHP instance
+-   `getPHPFile`: Custom file listing function
 
 ## Events
 
-The server emits events for monitoring connection activity:
+The bridge listens to events for monitoring connection activity:
+
+-   `connected`: Xdebug Server has started
+-   `close`: Xdebug Server has stopped
+-   `message`: Raw XDebug data received
+-   `error`: Xdebug Server error occurred
 
--   `started`: Server has started
--   `stopped`: Server has stopped
--   `connection`: New XDebug connection established
--   `disconnection`: XDebug connection closed
--   `xdebugData`: Raw XDebug data received
--   `error`: Server error occurred
--   `socketError`: Socket-level error occurred
+-   `clientConnected`: Devtools client connected
+-   `clientDisconnected`: Devtools client disconnected
+-   `message`: Raw Devtools data received
+-   `error`: Devtools client error occurred

package/cli.cjs

@@ -1,20 +1 @@
-#!/usr/bin/env node
-"use strict";const p=require("util"),g=require("./xdebug-bridge-Dc4daJ9d.cjs");var c=typeof document<"u"?document.currentScript:null;function a(){console.log(`
-XDebug Bridge Server CLI
-
-Usage: xdebug-bridge [options]
-
-Options:
-  --protocol <protocol>    Protocol to use: cdp, dap (default: cdp)
-  --port <port>           Port to listen on (default: 9003)
-  --host <host>           Host to bind to (default: localhost)
-  --verbose               Enable verbose logging
-  --help                  Show this help message
-
-Examples:
-  xdebug-bridge                                    # Start with default settings
-  xdebug-bridge --port 9000 --verbose            # Custom port with verbose logging
-  xdebug-bridge --protocol dap --host 0.0.0.0    # DAP protocol, bind to all interfaces
-`)}function d(){try{const{values:o}=p.parseArgs({args:process.argv.slice(2),options:{protocol:{type:"string",short:"p"},port:{type:"string",short:"P"},host:{type:"string",short:"h"},verbose:{type:"boolean",short:"v"},help:{type:"boolean"}},allowPositionals:!1}),t={};if(o.protocol){if(o.protocol!=="cdp"&&o.protocol!=="dap")throw new Error(`Invalid protocol: ${o.protocol}. Must be 'cdp' or 'dap'.`);t.protocol=o.protocol}if(o.port){const e=parseInt(o.port,10);if(isNaN(e)||e<1||e>65535)throw new Error(`Invalid port: ${o.port}. Must be a number between 1 and 65535.`);t.port=e}return o.host&&(t.host=o.host),o.verbose&&(t.verbose=!0),o.help&&(t.help=!0),t}catch(o){console.error(`Error parsing arguments: ${o instanceof Error?o.message:String(o)}`),process.exit(1)}}async function u(){const o=d();if(o.help){a();return}const t={protocol:o.protocol,xdebugServerPort:o.port,xdebugServerHost:o.host,verbose:o.verbose??!0};console.log("Starting XDebug Bridge Server...");const e=g.startXDebugBridge(t),i=async s=>{console.log(`
-Received ${s}, shutting down gracefully...`);try{await e.stop(),console.log("XDebug Bridge Server stopped."),process.exit(0)}catch(n){console.error(`Error during shutdown: ${n instanceof Error?n.message:String(n)}`),process.exit(1)}};process.on("SIGINT",()=>i("SIGINT")),process.on("SIGTERM",()=>i("SIGTERM"));try{await e.start();const s=e.getPort(),n=e.getHost();console.log(`✅ XDebug Bridge Server is running on ${n}:${s}`),console.log(`📡 Protocol: ${t.protocol||"cdp"}`),console.log("🔍 Waiting for XDebug connections..."),console.log("Press Ctrl+C to stop the server"),e.on("connection",r=>{console.log(`🔗 New XDebug connection established from ${r.remoteAddress}:${r.remotePort}`)}),e.on("disconnection",r=>{console.log(`❌ XDebug connection closed from ${r.remoteAddress}:${r.remotePort}`)}),e.on("error",r=>{console.error(`❌ Server error: ${r.message}`)}),e.on("socketError",({socket:r,error:l})=>{console.error(`❌ Socket error from ${r.remoteAddress}:${r.remotePort}: ${l.message}`)})}catch(s){console.error(`❌ Failed to start XDebug Bridge Server: ${s instanceof Error?s.message:String(s)}`),process.exit(1)}}(typeof document>"u"?require("url").pathToFileURL(__filename).href:c&&c.tagName.toUpperCase()==="SCRIPT"&&c.src||new URL("cli.cjs",document.baseURI).href)===`file://${process.argv[1]}`&&u().catch(o=>{console.error(`❌ Unexpected error: ${o instanceof Error?o.message:String(o)}`),process.exit(1)});
-//# sourceMappingURL=cli.cjs.map
+"use strict";const i=require("./run-cli-DpXpnvR3.cjs");i.main();

package/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/cli.js

@@ -1,127 +1,2 @@
-#!/usr/bin/env node
-import { parseArgs as l } from "util";
-import { s as p } from "./xdebug-bridge-BeKwvQ65.js";
-function g() {
-  console.log(`
-XDebug Bridge Server CLI
-
-Usage: xdebug-bridge [options]
-
-Options:
-  --protocol <protocol>    Protocol to use: cdp, dap (default: cdp)
-  --port <port>           Port to listen on (default: 9003)
-  --host <host>           Host to bind to (default: localhost)
-  --verbose               Enable verbose logging
-  --help                  Show this help message
-
-Examples:
-  xdebug-bridge                                    # Start with default settings
-  xdebug-bridge --port 9000 --verbose            # Custom port with verbose logging
-  xdebug-bridge --protocol dap --host 0.0.0.0    # DAP protocol, bind to all interfaces
-`);
-}
-function a() {
-  try {
-    const { values: o } = l({
-      args: process.argv.slice(2),
-      options: {
-        protocol: {
-          type: "string",
-          short: "p"
-        },
-        port: {
-          type: "string",
-          short: "P"
-        },
-        host: {
-          type: "string",
-          short: "h"
-        },
-        verbose: {
-          type: "boolean",
-          short: "v"
-        },
-        help: {
-          type: "boolean"
-        }
-      },
-      allowPositionals: !1
-    }), t = {};
-    if (o.protocol) {
-      if (o.protocol !== "cdp" && o.protocol !== "dap")
-        throw new Error(
-          `Invalid protocol: ${o.protocol}. Must be 'cdp' or 'dap'.`
-        );
-      t.protocol = o.protocol;
-    }
-    if (o.port) {
-      const r = parseInt(o.port, 10);
-      if (isNaN(r) || r < 1 || r > 65535)
-        throw new Error(
-          `Invalid port: ${o.port}. Must be a number between 1 and 65535.`
-        );
-      t.port = r;
-    }
-    return o.host && (t.host = o.host), o.verbose && (t.verbose = !0), o.help && (t.help = !0), t;
-  } catch (o) {
-    console.error(
-      `Error parsing arguments: ${o instanceof Error ? o.message : String(o)}`
-    ), process.exit(1);
-  }
-}
-async function d() {
-  const o = a();
-  if (o.help) {
-    g();
-    return;
-  }
-  const t = {
-    protocol: o.protocol,
-    xdebugServerPort: o.port,
-    xdebugServerHost: o.host,
-    verbose: o.verbose ?? !0
-    // CLI defaults to verbose
-  };
-  console.log("Starting XDebug Bridge Server...");
-  const r = p(t), c = async (s) => {
-    console.log(`
-Received ${s}, shutting down gracefully...`);
-    try {
-      await r.stop(), console.log("XDebug Bridge Server stopped."), process.exit(0);
-    } catch (n) {
-      console.error(
-        `Error during shutdown: ${n instanceof Error ? n.message : String(n)}`
-      ), process.exit(1);
-    }
-  };
-  process.on("SIGINT", () => c("SIGINT")), process.on("SIGTERM", () => c("SIGTERM"));
-  try {
-    await r.start();
-    const s = r.getPort(), n = r.getHost();
-    console.log(`✅ XDebug Bridge Server is running on ${n}:${s}`), console.log(`📡 Protocol: ${t.protocol || "cdp"}`), console.log("🔍 Waiting for XDebug connections..."), console.log("Press Ctrl+C to stop the server"), r.on("connection", (e) => {
-      console.log(
-        `🔗 New XDebug connection established from ${e.remoteAddress}:${e.remotePort}`
-      );
-    }), r.on("disconnection", (e) => {
-      console.log(
-        `❌ XDebug connection closed from ${e.remoteAddress}:${e.remotePort}`
-      );
-    }), r.on("error", (e) => {
-      console.error(`❌ Server error: ${e.message}`);
-    }), r.on("socketError", ({ socket: e, error: i }) => {
-      console.error(
-        `❌ Socket error from ${e.remoteAddress}:${e.remotePort}: ${i.message}`
-      );
-    });
-  } catch (s) {
-    console.error(
-      `❌ Failed to start XDebug Bridge Server: ${s instanceof Error ? s.message : String(s)}`
-    ), process.exit(1);
-  }
-}
-import.meta.url === `file://${process.argv[1]}` && d().catch((o) => {
-  console.error(
-    `❌ Unexpected error: ${o instanceof Error ? o.message : String(o)}`
-  ), process.exit(1);
-});
-//# sourceMappingURL=cli.js.map
+import { m } from "./run-cli-II34aG2V.js";
+m();

package/index.cjs

@@ -1,2 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./xdebug-bridge-Dc4daJ9d.cjs");exports.startXDebugBridge=e.startXDebugBridge;
-//# sourceMappingURL=index.cjs.map
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./run-cli-DpXpnvR3.cjs");exports.CDPServer=e.CDPServer;exports.DbgpSession=e.DbgpSession;exports.XdebugCDPBridge=e.XdebugCDPBridge;exports.main=e.main;exports.startBridge=e.startBridge;

package/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/index.js

@@ -1,5 +1,8 @@
-import { s } from "./xdebug-bridge-BeKwvQ65.js";
+import { C as e, D as r, X as g, m as i, s as D } from "./run-cli-II34aG2V.js";
 export {
-  s as startXDebugBridge
+  e as CDPServer,
+  r as DbgpSession,
+  g as XdebugCDPBridge,
+  i as main,
+  D as startBridge
 };
-//# sourceMappingURL=index.js.map

package/lib/cdp-server.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+export declare class CDPServer extends EventEmitter {
+    private wss;
+    private ws;
+    constructor(port?: number);
+    sendMessage(message: any): void;
+}

package/lib/dbgp-session.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+export declare class DbgpSession extends EventEmitter {
+    private server;
+    private socket;
+    private buffer;
+    private expectedLength;
+    constructor(port?: number);
+    private onData;
+    sendCommand(command: string): void;
+}

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from './cdp-server';
+export * from './dbgp-session';
+export * from './run-cli';
+export * from './start-bridge';
+export * from './xdebug-cdp-bridge';

package/lib/run-cli.d.ts

@@ -0,0 +1 @@
+export declare function main(): Promise<void>;

package/lib/start-bridge.d.ts

@@ -0,0 +1,13 @@
+import type { PHP } from '@php-wasm/universal';
+import { XdebugCDPBridge } from './xdebug-cdp-bridge';
+export type StartBridgeConfig = {
+    cdpPort?: number;
+    cdpHost?: string;
+    dbgpPort?: number;
+    phpRoot?: string;
+    remoteRoot?: string;
+    localRoot?: string;
+    phpInstance?: PHP;
+    getPHPFile?: (path: string) => string;
+};
+export declare function startBridge(config: StartBridgeConfig): Promise<XdebugCDPBridge>;

package/lib/xdebug-cdp-bridge.d.ts

@@ -0,0 +1,36 @@
+import type { DbgpSession } from './dbgp-session';
+import type { CDPServer } from './cdp-server';
+export interface XdebugCDPBridgeConfig {
+    knownScriptUrls: string[];
+    remoteRoot?: string;
+    localRoot?: string;
+    getPHPFile(path: string): string;
+}
+export declare class XdebugCDPBridge {
+    private dbgp;
+    cdp: CDPServer;
+    private nextTxnId;
+    private pendingCommands;
+    private breakpoints;
+    private scriptIdByUrl;
+    private nextScriptId;
+    private objectHandles;
+    private nextObjectId;
+    private callFramesMap;
+    private xdebugConnected;
+    private xdebugStatus;
+    private initFileUri;
+    private readPHPFile;
+    private remoteRoot;
+    private localRoot;
+    constructor(dbgp: DbgpSession, cdp: CDPServer, config: XdebugCDPBridgeConfig);
+    start(): void;
+    private sendInitialScripts;
+    private getOrCreateScriptId;
+    private formatPropertyFullName;
+    private sendDbgpCommand;
+    private handleCdpMessage;
+    private uriToRemotePath;
+    private remoteToLocal;
+    private handleDbgpMessage;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/xdebug-bridge",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "XDebug bridge server for PHP.wasm",
   "repository": {
     "type": "git",
@@ -26,7 +26,7 @@
   "type": "module",
   "main": "./index.cjs",
   "module": "./index.js",
-  "bin": "cli.js",
+  "bin": "xdebug-bridge.js",
   "typedoc": {
     "entryPoint": "./src/index.ts",
     "readmeFile": "./README.md",
@@ -39,11 +39,18 @@
   },
   "license": "GPL-2.0-or-later",
   "types": "index.d.ts",
-  "gitHead": "4aa6ec4f0fe23920f735c0050228a509d94ce077",
+  "gitHead": "8418e46be011a4a0f4d16d55fbf8e887476fea64",
   "engines": {
     "node": ">=20.18.3",
     "npm": ">=10.1.0"
   },
+  "dependencies": {
+    "ini": "4.1.2",
+    "ws": "8.18.1",
+    "xml2js": "0.6.2",
+    "yargs": "17.7.2",
+    "@php-wasm/universal": "2.0.2"
+  },
   "overrides": {
     "rollup": "^4.34.6",
     "react": "18.3.1",
@@ -51,5 +58,7 @@
     "typescript": "5.4.5",
     "ws": "^8.18.0"
   },
-  "dependencies": {}
+  "optionalDependencies": {
+    "fs-ext": "2.1.1"
+  }
 }