roku-debug 0.20.6 → 0.20.8

package/dist/debugProtocol/events/updates/BreakpointErrorUpdate.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BreakpointErrorUpdate = void 0;
+const smart_buffer_1 = require("smart-buffer");
+const Constants_1 = require("../../Constants");
+const ProtocolUtil_1 = require("../../ProtocolUtil");
+/**
+ * Data sent as the data segment of message type: BREAKPOINT_ERROR
+    ```
+    struct BreakpointErrorUpdateData {
+        uint32                    flags;              // Always 0, reserved for future use
+        uint32                    breakpoint_id;
+        uint32                    num_compile_errors;
+        utf8z[num_compile_errors] compile_errors;
+        uint32                    num_runtime_errors;
+        utf8z[num_runtime_errors] runtime_errors;
+        uint32                    num_other_errors;   // E.g., permissions errors
+        utf8z[num_other_errors]   other_errors;
+    }
+    ```
+*/
+class BreakpointErrorUpdate {
+    constructor() {
+        this.success = false;
+        /**
+         * How many bytes were read by the `fromBuffer` method. Only populated when constructed by `fromBuffer`
+         */
+        this.readOffset = undefined;
+        this.data = {
+            breakpointId: undefined,
+            compileErrors: undefined,
+            runtimeErrors: undefined,
+            otherErrors: undefined,
+            //common props
+            packetLength: undefined,
+            requestId: 0,
+            errorCode: Constants_1.ErrorCode.OK,
+            updateType: Constants_1.UpdateType.BreakpointError
+        };
+    }
+    static fromJson(data) {
+        var _a, _b, _c;
+        var _d, _e, _f;
+        const update = new BreakpointErrorUpdate();
+        ProtocolUtil_1.protocolUtil.loadJson(update, data);
+        (_a = (_d = update.data).compileErrors) !== null && _a !== void 0 ? _a : (_d.compileErrors = []);
+        (_b = (_e = update.data).runtimeErrors) !== null && _b !== void 0 ? _b : (_e.runtimeErrors = []);
+        (_c = (_f = update.data).otherErrors) !== null && _c !== void 0 ? _c : (_f.otherErrors = []);
+        return update;
+    }
+    static fromBuffer(buffer) {
+        const update = new BreakpointErrorUpdate();
+        ProtocolUtil_1.protocolUtil.bufferLoaderHelper(update, buffer, 20, (smartBuffer) => {
+            ProtocolUtil_1.protocolUtil.loadCommonUpdateFields(update, smartBuffer, update.data.updateType);
+            smartBuffer.readUInt32LE(); // flags - always 0, reserved for future use
+            update.data.breakpointId = smartBuffer.readUInt32LE(); // breakpoint_id
+            const compileErrorCount = smartBuffer.readUInt32LE(); // num_compile_errors
+            update.data.compileErrors = [];
+            for (let i = 0; i < compileErrorCount; i++) {
+                update.data.compileErrors.push(ProtocolUtil_1.protocolUtil.readStringNT(smartBuffer));
+            }
+            const runtimeErrorCount = smartBuffer.readUInt32LE(); // num_runtime_errors
+            update.data.runtimeErrors = [];
+            for (let i = 0; i < runtimeErrorCount; i++) {
+                update.data.runtimeErrors.push(ProtocolUtil_1.protocolUtil.readStringNT(smartBuffer));
+            }
+            const otherErrorCount = smartBuffer.readUInt32LE(); // num_other_errors
+            update.data.otherErrors = [];
+            for (let i = 0; i < otherErrorCount; i++) {
+                update.data.otherErrors.push(ProtocolUtil_1.protocolUtil.readStringNT(smartBuffer));
+            }
+        });
+        return update;
+    }
+    toBuffer() {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        let smartBuffer = new smart_buffer_1.SmartBuffer();
+        smartBuffer.writeInt32LE(0); // flags - always 0, reserved for future use
+        smartBuffer.writeUInt32LE(this.data.breakpointId); // breakpoint_id
+        smartBuffer.writeUInt32LE((_b = (_a = this.data.compileErrors) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0); // num_compile_errors
+        for (let error of (_c = this.data.compileErrors) !== null && _c !== void 0 ? _c : []) {
+            smartBuffer.writeStringNT(error);
+        }
+        smartBuffer.writeUInt32LE((_e = (_d = this.data.runtimeErrors) === null || _d === void 0 ? void 0 : _d.length) !== null && _e !== void 0 ? _e : 0); // num_runtime_errors
+        for (let error of (_f = this.data.runtimeErrors) !== null && _f !== void 0 ? _f : []) {
+            smartBuffer.writeStringNT(error);
+        }
+        smartBuffer.writeUInt32LE((_h = (_g = this.data.otherErrors) === null || _g === void 0 ? void 0 : _g.length) !== null && _h !== void 0 ? _h : 0); // num_other_errors
+        for (let error of (_j = this.data.otherErrors) !== null && _j !== void 0 ? _j : []) {
+            smartBuffer.writeStringNT(error);
+        }
+        ProtocolUtil_1.protocolUtil.insertCommonUpdateFields(this, smartBuffer);
+        return smartBuffer.toBuffer();
+    }
+}
+exports.BreakpointErrorUpdate = BreakpointErrorUpdate;
+//# sourceMappingURL=BreakpointErrorUpdate.js.map

package/dist/debugProtocol/events/updates/BreakpointErrorUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BreakpointErrorUpdate.js","sourceRoot":"","sources":["../../../../src/debugProtocol/events/updates/BreakpointErrorUpdate.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,+CAAwD;AACxD,qDAAkD;AAElD;;;;;;;;;;;;;;EAcE;AACF,MAAa,qBAAqB;IAAlC;QA6EW,YAAO,GAAG,KAAK,CAAC;QACvB;;WAEG;QACI,eAAU,GAAW,SAAS,CAAC;QAE/B,SAAI,GAAG;YACV,YAAY,EAAE,SAAmB;YACjC,aAAa,EAAE,SAAqB;YACpC,aAAa,EAAE,SAAqB;YACpC,WAAW,EAAE,SAAqB;YAElC,cAAc;YACd,YAAY,EAAE,SAAmB;YACjC,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,qBAAS,CAAC,EAAE;YACvB,UAAU,EAAE,sBAAU,CAAC,eAAe;SACzC,CAAC;IACN,CAAC;IA7FU,MAAM,CAAC,QAAQ,CAAC,IAKtB;;;QACG,MAAM,MAAM,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAC3C,2BAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpC,YAAA,MAAM,CAAC,IAAI,EAAC,aAAa,uCAAb,aAAa,GAAK,EAAE,EAAC;QACjC,YAAA,MAAM,CAAC,IAAI,EAAC,aAAa,uCAAb,aAAa,GAAK,EAAE,EAAC;QACjC,YAAA,MAAM,CAAC,IAAI,EAAC,WAAW,uCAAX,WAAW,GAAK,EAAE,EAAC;QAC/B,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,MAAc;QACnC,MAAM,MAAM,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAC3C,2BAAY,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,EAAE;YAChE,2BAAY,CAAC,sBAAsB,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAEjF,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,4CAA4C;YACxE,MAAM,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,gBAAgB;YAEvE,MAAM,iBAAiB,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,qBAAqB;YAC3E,MAAM,CAAC,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,EAAE,CAAC,EAAE,EAAE;gBACxC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAC1B,2BAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CACzC,CAAC;aACL;YAED,MAAM,iBAAiB,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,qBAAqB;YAC3E,MAAM,CAAC,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,EAAE,CAAC,EAAE,EAAE;gBACxC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAC1B,2BAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CACzC,CAAC;aACL;YAED,MAAM,eAAe,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,mBAAmB;YACvE,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,EAAE,CAAC,EAAE,EAAE;gBACtC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CACxB,2BAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CACzC,CAAC;aACL;QACL,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,QAAQ;;QACX,IAAI,WAAW,GAAG,IAAI,0BAAW,EAAE,CAAC;QAEpC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,4CAA4C;QACzE,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB;QAEnE,WAAW,CAAC,aAAa,CAAC,MAAA,MAAA,IAAI,CAAC,IAAI,CAAC,aAAa,0CAAE,MAAM,mCAAI,CAAC,CAAC,CAAC,CAAC,qBAAqB;QACtF,KAAK,IAAI,KAAK,IAAI,MAAA,IAAI,CAAC,IAAI,CAAC,aAAa,mCAAI,EAAE,EAAE;YAC7C,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACpC;QAED,WAAW,CAAC,aAAa,CAAC,MAAA,MAAA,IAAI,CAAC,IAAI,CAAC,aAAa,0CAAE,MAAM,mCAAI,CAAC,CAAC,CAAC,CAAC,qBAAqB;QACtF,KAAK,IAAI,KAAK,IAAI,MAAA,IAAI,CAAC,IAAI,CAAC,aAAa,mCAAI,EAAE,EAAE;YAC7C,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACpC;QAED,WAAW,CAAC,aAAa,CAAC,MAAA,MAAA,IAAI,CAAC,IAAI,CAAC,WAAW,0CAAE,MAAM,mCAAI,CAAC,CAAC,CAAC,CAAC,mBAAmB;QAClF,KAAK,IAAI,KAAK,IAAI,MAAA,IAAI,CAAC,IAAI,CAAC,WAAW,mCAAI,EAAE,EAAE;YAC3C,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACpC;QAED,2BAAY,CAAC,wBAAwB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAEzD,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;CAoBJ;AA/FD,sDA+FC"}

package/dist/debugProtocol/events/updates/BreakpointVerifiedUpdate.d.ts

@@ -0,0 +1,41 @@
+/// <reference types="node" />
+import { ErrorCode, UpdateType } from '../../Constants';
+/**
+```
+// Data sent as the data segment of message type: BREAKPOINT_VERIFIED
+struct BreakpointVerifiedUpdateData {
+    uint32 flags             // Always 0, reserved for future use
+    uint32 num_breakpoints
+    BreakpointVerifiedInfo[num_breakpoints] breakpoint_verified_info
+}
+
+struct BreakpointVerifiedInfo {
+    uint32 breakpoint_id
+}
+```
+*/
+export declare class BreakpointVerifiedUpdate {
+    static fromJson(data: {
+        breakpoints: VerifiedBreakpoint[];
+    }): BreakpointVerifiedUpdate;
+    static fromBuffer(buffer: Buffer): BreakpointVerifiedUpdate;
+    toBuffer(): Buffer;
+    success: boolean;
+    /**
+     * How many bytes were read by the `fromBuffer` method. Only populated when constructed by `fromBuffer`
+     */
+    readOffset: number;
+    data: {
+        /**
+         * The index of the primary thread that triggered the stop
+         */
+        breakpoints: VerifiedBreakpoint[];
+        packetLength: number;
+        requestId: number;
+        errorCode: ErrorCode;
+        updateType: UpdateType;
+    };
+}
+export interface VerifiedBreakpoint {
+    id: number;
+}

package/dist/debugProtocol/events/updates/BreakpointVerifiedUpdate.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BreakpointVerifiedUpdate = void 0;
+const smart_buffer_1 = require("smart-buffer");
+const Constants_1 = require("../../Constants");
+const ProtocolUtil_1 = require("../../ProtocolUtil");
+/**
+```
+// Data sent as the data segment of message type: BREAKPOINT_VERIFIED
+struct BreakpointVerifiedUpdateData {
+    uint32 flags             // Always 0, reserved for future use
+    uint32 num_breakpoints
+    BreakpointVerifiedInfo[num_breakpoints] breakpoint_verified_info
+}
+
+struct BreakpointVerifiedInfo {
+    uint32 breakpoint_id
+}
+```
+*/
+class BreakpointVerifiedUpdate {
+    constructor() {
+        this.success = false;
+        /**
+         * How many bytes were read by the `fromBuffer` method. Only populated when constructed by `fromBuffer`
+         */
+        this.readOffset = undefined;
+        this.data = {
+            /**
+             * The index of the primary thread that triggered the stop
+             */
+            breakpoints: undefined,
+            //common props
+            packetLength: undefined,
+            requestId: 0,
+            errorCode: Constants_1.ErrorCode.OK,
+            updateType: Constants_1.UpdateType.BreakpointVerified
+        };
+    }
+    static fromJson(data) {
+        const update = new BreakpointVerifiedUpdate();
+        ProtocolUtil_1.protocolUtil.loadJson(update, data);
+        return update;
+    }
+    static fromBuffer(buffer) {
+        const update = new BreakpointVerifiedUpdate();
+        ProtocolUtil_1.protocolUtil.bufferLoaderHelper(update, buffer, 16, (smartBuffer) => {
+            ProtocolUtil_1.protocolUtil.loadCommonUpdateFields(update, smartBuffer, update.data.updateType);
+            const flags = smartBuffer.readUInt32LE(); // Always 0, reserved for future use
+            const breakpointCount = smartBuffer.readUInt32LE(); // num_breakpoints
+            update.data.breakpoints = [];
+            for (let i = 0; i < breakpointCount; i++) {
+                update.data.breakpoints.push({
+                    id: smartBuffer.readUInt32LE() // uint32 breakpoint_id
+                });
+            }
+        });
+        return update;
+    }
+    toBuffer() {
+        var _a, _b, _c;
+        let smartBuffer = new smart_buffer_1.SmartBuffer();
+        smartBuffer.writeUInt32LE(0); // flags (Always 0, reserved for future use)
+        const breakpoints = (_b = (_a = this.data) === null || _a === void 0 ? void 0 : _a.breakpoints) !== null && _b !== void 0 ? _b : [];
+        smartBuffer.writeUInt32LE(breakpoints.length); // num_breakpoints
+        for (const breakpoint of breakpoints) {
+            smartBuffer.writeUInt32LE((_c = breakpoint.id) !== null && _c !== void 0 ? _c : 0); //breakpoint_id
+        }
+        ProtocolUtil_1.protocolUtil.insertCommonUpdateFields(this, smartBuffer);
+        return smartBuffer.toBuffer();
+    }
+}
+exports.BreakpointVerifiedUpdate = BreakpointVerifiedUpdate;
+//# sourceMappingURL=BreakpointVerifiedUpdate.js.map

package/dist/debugProtocol/events/updates/BreakpointVerifiedUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BreakpointVerifiedUpdate.js","sourceRoot":"","sources":["../../../../src/debugProtocol/events/updates/BreakpointVerifiedUpdate.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE3C,+CAAwE;AACxE,qDAAkD;AAGlD;;;;;;;;;;;;;EAaE;AACF,MAAa,wBAAwB;IAArC;QAyCW,YAAO,GAAG,KAAK,CAAC;QACvB;;WAEG;QACI,eAAU,GAAW,SAAS,CAAC;QAE/B,SAAI,GAAG;YACV;;eAEG;YACH,WAAW,EAAE,SAAiC;YAE9C,cAAc;YACd,YAAY,EAAE,SAAmB;YACjC,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,qBAAS,CAAC,EAAE;YACvB,UAAU,EAAE,sBAAU,CAAC,kBAAkB;SAC5C,CAAC;IACN,CAAC;IAzDU,MAAM,CAAC,QAAQ,CAAC,IAEtB;QACG,MAAM,MAAM,GAAG,IAAI,wBAAwB,EAAE,CAAC;QAC9C,2BAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,MAAc;QACnC,MAAM,MAAM,GAAG,IAAI,wBAAwB,EAAE,CAAC;QAC9C,2BAAY,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,EAAE;YAChE,2BAAY,CAAC,sBAAsB,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAEjF,MAAM,KAAK,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,oCAAoC;YAC9E,MAAM,eAAe,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,kBAAkB;YACtE,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,EAAE,CAAC,EAAE,EAAE;gBACtC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;oBACzB,EAAE,EAAE,WAAW,CAAC,YAAY,EAAE,CAAC,uBAAuB;iBACzD,CAAC,CAAC;aACN;QACL,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,QAAQ;;QACX,IAAI,WAAW,GAAG,IAAI,0BAAW,EAAE,CAAC;QAEpC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,4CAA4C;QAC1E,MAAM,WAAW,GAAG,MAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,WAAW,mCAAI,EAAE,CAAC;QACjD,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAkB;QACjE,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YAClC,WAAW,CAAC,aAAa,CAAC,MAAA,UAAU,CAAC,EAAE,mCAAI,CAAC,CAAC,CAAC,CAAC,eAAe;SACjE;QAED,2BAAY,CAAC,wBAAwB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACzD,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;CAoBJ;AA3DD,4DA2DC"}

package/dist/debugProtocol/events/updates/CompileErrorUpdate.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="node" />
+import { ErrorCode, UpdateType } from '../../Constants';
+/**
+ * A COMPILE_ERROR is sent if a compilation error occurs. In this case, the update_type field in a DebuggerUpdate message is set to
+ * COMPILE_ERROR, and the data field contains a structure named CompileErrorUpdateData that provides the reason for the error.
+ * The CompileErrorUpdateData structure has the following syntax:
+    ```
+    struct CompileErrorUpdateData {
+        uint32 flags;              // Always 0, reserved for future use
+        utf8z  error_string;
+        utf8z  file_spec;
+        uint32 line_number;
+        utf8z  library_name;
+    }
+    ```
+*/
+export declare class CompileErrorUpdate {
+    static fromJson(data: {
+        errorMessage: string;
+        filePath: string;
+        lineNumber: number;
+        libraryName: string;
+    }): CompileErrorUpdate;
+    static fromBuffer(buffer: Buffer): CompileErrorUpdate;
+    toBuffer(): Buffer;
+    success: boolean;
+    /**
+     * How many bytes were read by the `fromBuffer` method. Only populated when constructed by `fromBuffer`
+     */
+    readOffset: number;
+    data: {
+        flags: number;
+        /**
+         * A text message describing the compiler error.
+         *
+         * This is completely unrelated to the DebuggerUpdate.errorCode field.
+         */
+        errorMessage: string;
+        /**
+         * A simple file path indicating where the compiler error occurred. It maps to all matching file paths in the channel or its libraries
+         *
+         * `"pkg:/"` specifies a file in the channel
+         *
+         * `"lib:/<library_name>/"` specifies a file in a library.
+         */
+        filePath: string;
+        /**
+         * The 1-based line number where the compile error occurred.
+         */
+        lineNumber: number;
+        /**
+         * The name of the library where the compile error occurred.
+         */
+        libraryName: string;
+        packetLength: number;
+        requestId: number;
+        errorCode: ErrorCode;
+        updateType: UpdateType;
+    };
+}

package/dist/debugProtocol/events/updates/CompileErrorUpdate.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompileErrorUpdate = void 0;
+const smart_buffer_1 = require("smart-buffer");
+const Constants_1 = require("../../Constants");
+const ProtocolUtil_1 = require("../../ProtocolUtil");
+/**
+ * A COMPILE_ERROR is sent if a compilation error occurs. In this case, the update_type field in a DebuggerUpdate message is set to
+ * COMPILE_ERROR, and the data field contains a structure named CompileErrorUpdateData that provides the reason for the error.
+ * The CompileErrorUpdateData structure has the following syntax:
+    ```
+    struct CompileErrorUpdateData {
+        uint32 flags;              // Always 0, reserved for future use
+        utf8z  error_string;
+        utf8z  file_spec;
+        uint32 line_number;
+        utf8z  library_name;
+    }
+    ```
+*/
+class CompileErrorUpdate {
+    constructor() {
+        this.success = false;
+        /**
+         * How many bytes were read by the `fromBuffer` method. Only populated when constructed by `fromBuffer`
+         */
+        this.readOffset = undefined;
+        this.data = {
+            flags: undefined,
+            /**
+             * A text message describing the compiler error.
+             *
+             * This is completely unrelated to the DebuggerUpdate.errorCode field.
+             */
+            errorMessage: undefined,
+            /**
+             * A simple file path indicating where the compiler error occurred. It maps to all matching file paths in the channel or its libraries
+             *
+             * `"pkg:/"` specifies a file in the channel
+             *
+             * `"lib:/<library_name>/"` specifies a file in a library.
+             */
+            filePath: undefined,
+            /**
+             * The 1-based line number where the compile error occurred.
+             */
+            lineNumber: undefined,
+            /**
+             * The name of the library where the compile error occurred.
+             */
+            libraryName: undefined,
+            //common props
+            packetLength: undefined,
+            requestId: 0,
+            errorCode: Constants_1.ErrorCode.OK,
+            updateType: Constants_1.UpdateType.CompileError
+        };
+    }
+    static fromJson(data) {
+        const update = new CompileErrorUpdate();
+        ProtocolUtil_1.protocolUtil.loadJson(update, data);
+        return update;
+    }
+    static fromBuffer(buffer) {
+        const update = new CompileErrorUpdate();
+        ProtocolUtil_1.protocolUtil.bufferLoaderHelper(update, buffer, 20, (smartBuffer) => {
+            ProtocolUtil_1.protocolUtil.loadCommonUpdateFields(update, smartBuffer, update.data.updateType);
+            update.data.flags = smartBuffer.readUInt32LE(); // flags - always 0, reserved for future use
+            update.data.errorMessage = ProtocolUtil_1.protocolUtil.readStringNT(smartBuffer); // error_string
+            update.data.filePath = ProtocolUtil_1.protocolUtil.readStringNT(smartBuffer); // file_spec
+            update.data.lineNumber = smartBuffer.readUInt32LE(); // line_number
+            update.data.libraryName = ProtocolUtil_1.protocolUtil.readStringNT(smartBuffer); // library_name
+        });
+        return update;
+    }
+    toBuffer() {
+        var _a;
+        let smartBuffer = new smart_buffer_1.SmartBuffer();
+        smartBuffer.writeUInt32LE((_a = this.data.flags) !== null && _a !== void 0 ? _a : 0); // flags
+        smartBuffer.writeStringNT(this.data.errorMessage); // error_string
+        smartBuffer.writeStringNT(this.data.filePath); // file_spec
+        smartBuffer.writeUInt32LE(this.data.lineNumber); // line_number
+        smartBuffer.writeStringNT(this.data.libraryName); // library_name
+        ProtocolUtil_1.protocolUtil.insertCommonUpdateFields(this, smartBuffer);
+        return smartBuffer.toBuffer();
+    }
+}
+exports.CompileErrorUpdate = CompileErrorUpdate;
+//# sourceMappingURL=CompileErrorUpdate.js.map

package/dist/debugProtocol/events/updates/CompileErrorUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompileErrorUpdate.js","sourceRoot":"","sources":["../../../../src/debugProtocol/events/updates/CompileErrorUpdate.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,+CAAwD;AACxD,qDAAkD;AAElD;;;;;;;;;;;;;EAaE;AACF,MAAa,kBAAkB;IAA/B;QAwCW,YAAO,GAAG,KAAK,CAAC;QACvB;;WAEG;QACI,eAAU,GAAW,SAAS,CAAC;QAE/B,SAAI,GAAG;YACV,KAAK,EAAE,SAAmB;YAC1B;;;;eAIG;YACH,YAAY,EAAE,SAAmB;YACjC;;;;;;eAMG;YACH,QAAQ,EAAE,SAAmB;YAC7B;;eAEG;YACH,UAAU,EAAE,SAAmB;YAC/B;;eAEG;YACH,WAAW,EAAE,SAAmB;YAEhC,cAAc;YACd,YAAY,EAAE,SAAmB;YACjC,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,qBAAS,CAAC,EAAE;YACvB,UAAU,EAAE,sBAAU,CAAC,YAAY;SACtC,CAAC;IACN,CAAC;IA3EU,MAAM,CAAC,QAAQ,CAAC,IAKtB;QACG,MAAM,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACxC,2BAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,MAAc;QACnC,MAAM,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACxC,2BAAY,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,EAAE;YAChE,2BAAY,CAAC,sBAAsB,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACjF,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,4CAA4C;YAC5F,MAAM,CAAC,IAAI,CAAC,YAAY,GAAG,2BAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe;YAClF,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,2BAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY;YAC3E,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,cAAc;YACnE,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG,2BAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe;QACrF,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,QAAQ;;QACX,IAAI,WAAW,GAAG,IAAI,0BAAW,EAAE,CAAC;QAEpC,WAAW,CAAC,aAAa,CAAC,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,mCAAI,CAAC,CAAC,CAAC,CAAC,QAAQ;QACzD,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,eAAe;QAClE,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY;QAC3D,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc;QAC/D,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe;QAEjE,2BAAY,CAAC,wBAAwB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAEzD,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;CAuCJ;AA7ED,gDA6EC"}

package/dist/debugProtocol/events/updates/IOPortOpenedUpdate.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import { ErrorCode, UpdateType } from '../../Constants';
+import type { ProtocolUpdate, ProtocolResponse, ProtocolRequest } from '../ProtocolEvent';
+export declare class IOPortOpenedUpdate {
+    static fromJson(data: {
+        port: number;
+    }): IOPortOpenedUpdate;
+    static fromBuffer(buffer: Buffer): IOPortOpenedUpdate;
+    toBuffer(): Buffer;
+    success: boolean;
+    readOffset: number;
+    data: {
+        /**
+         * The port number to which the debugging client should connect to read the script's output
+         */
+        port: number;
+        packetLength: number;
+        requestId: number;
+        errorCode: ErrorCode;
+        updateType: UpdateType;
+    };
+}
+export declare function isIOPortOpenedUpdate(event: ProtocolRequest | ProtocolResponse | ProtocolUpdate): event is IOPortOpenedUpdate;

package/dist/debugProtocol/events/updates/IOPortOpenedUpdate.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isIOPortOpenedUpdate = exports.IOPortOpenedUpdate = void 0;
+const smart_buffer_1 = require("smart-buffer");
+const Constants_1 = require("../../Constants");
+const ProtocolUtil_1 = require("../../ProtocolUtil");
+class IOPortOpenedUpdate {
+    constructor() {
+        this.success = false;
+        this.readOffset = 0;
+        this.data = {
+            /**
+             * The port number to which the debugging client should connect to read the script's output
+             */
+            port: undefined,
+            //common props
+            packetLength: undefined,
+            requestId: 0,
+            errorCode: Constants_1.ErrorCode.OK,
+            updateType: Constants_1.UpdateType.IOPortOpened
+        };
+    }
+    static fromJson(data) {
+        const update = new IOPortOpenedUpdate();
+        ProtocolUtil_1.protocolUtil.loadJson(update, data);
+        return update;
+    }
+    static fromBuffer(buffer) {
+        const update = new IOPortOpenedUpdate();
+        ProtocolUtil_1.protocolUtil.bufferLoaderHelper(update, buffer, 16, (smartBuffer) => {
+            ProtocolUtil_1.protocolUtil.loadCommonUpdateFields(update, smartBuffer, update.data.updateType);
+            update.data.port = smartBuffer.readInt32LE();
+        });
+        return update;
+    }
+    toBuffer() {
+        let smartBuffer = new smart_buffer_1.SmartBuffer();
+        smartBuffer.writeInt32LE(this.data.port); // primary_thread_index
+        ProtocolUtil_1.protocolUtil.insertCommonUpdateFields(this, smartBuffer);
+        return smartBuffer.toBuffer();
+    }
+}
+exports.IOPortOpenedUpdate = IOPortOpenedUpdate;
+function isIOPortOpenedUpdate(event) {
+    var _a;
+    return ((_a = event === null || event === void 0 ? void 0 : event.constructor) === null || _a === void 0 ? void 0 : _a.name) === IOPortOpenedUpdate.name;
+}
+exports.isIOPortOpenedUpdate = isIOPortOpenedUpdate;
+//# sourceMappingURL=IOPortOpenedUpdate.js.map

package/dist/debugProtocol/events/updates/IOPortOpenedUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOPortOpenedUpdate.js","sourceRoot":"","sources":["../../../../src/debugProtocol/events/updates/IOPortOpenedUpdate.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,+CAAwD;AACxD,qDAAkD;AAGlD,MAAa,kBAAkB;IAA/B;QA6BW,YAAO,GAAG,KAAK,CAAC;QAEhB,eAAU,GAAG,CAAC,CAAC;QAEf,SAAI,GAAG;YACV;;eAEG;YACH,IAAI,EAAE,SAAmB;YAEzB,cAAc;YACd,YAAY,EAAE,SAAmB;YACjC,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,qBAAS,CAAC,EAAE;YACvB,UAAU,EAAE,sBAAU,CAAC,YAAY;SACtC,CAAC;IACN,CAAC;IA3CU,MAAM,CAAC,QAAQ,CAAC,IAEtB;QACG,MAAM,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACxC,2BAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,MAAc;QACnC,MAAM,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACxC,2BAAY,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,EAAE;YAChE,2BAAY,CAAC,sBAAsB,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAEjF,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,QAAQ;QACX,IAAI,WAAW,GAAG,IAAI,0BAAW,EAAE,CAAC;QAEpC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,uBAAuB;QAEjE,2BAAY,CAAC,wBAAwB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACzD,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;CAkBJ;AA7CD,gDA6CC;AAED,SAAgB,oBAAoB,CAAC,KAA0D;;IAC3F,OAAO,CAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,0CAAE,IAAI,MAAK,kBAAkB,CAAC,IAAI,CAAC;AAChE,CAAC;AAFD,oDAEC"}

package/dist/debugProtocol/events/updates/ThreadAttachedUpdate.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+import type { StopReason } from '../../Constants';
+import { ErrorCode, UpdateType } from '../../Constants';
+export declare class ThreadAttachedUpdate {
+    static fromJson(data: {
+        threadIndex: number;
+        stopReason: StopReason;
+        stopReasonDetail: string;
+    }): ThreadAttachedUpdate;
+    static fromBuffer(buffer: Buffer): ThreadAttachedUpdate;
+    toBuffer(): Buffer;
+    success: boolean;
+    readOffset: number;
+    data: {
+        /**
+         * The index of the thread that was just attached
+         */
+        threadIndex: number;
+        stopReason: StopReason;
+        stopReasonDetail: string;
+        packetLength: number;
+        requestId: number;
+        errorCode: ErrorCode;
+        updateType: UpdateType;
+    };
+}

package/dist/debugProtocol/events/updates/ThreadAttachedUpdate.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThreadAttachedUpdate = void 0;
+const smart_buffer_1 = require("smart-buffer");
+const Constants_1 = require("../../Constants");
+const ProtocolUtil_1 = require("../../ProtocolUtil");
+class ThreadAttachedUpdate {
+    constructor() {
+        this.success = false;
+        this.readOffset = 0;
+        this.data = {
+            /**
+             * The index of the thread that was just attached
+             */
+            threadIndex: undefined,
+            stopReason: undefined,
+            stopReasonDetail: undefined,
+            //common props
+            packetLength: undefined,
+            requestId: 0,
+            errorCode: Constants_1.ErrorCode.OK,
+            updateType: Constants_1.UpdateType.ThreadAttached
+        };
+    }
+    static fromJson(data) {
+        const update = new ThreadAttachedUpdate();
+        ProtocolUtil_1.protocolUtil.loadJson(update, data);
+        return update;
+    }
+    static fromBuffer(buffer) {
+        const update = new ThreadAttachedUpdate();
+        ProtocolUtil_1.protocolUtil.bufferLoaderHelper(update, buffer, 12, (smartBuffer) => {
+            ProtocolUtil_1.protocolUtil.loadCommonUpdateFields(update, smartBuffer, update.data.updateType);
+            update.data.threadIndex = smartBuffer.readInt32LE();
+            update.data.stopReason = Constants_1.StopReasonCode[smartBuffer.readUInt8()];
+            update.data.stopReasonDetail = ProtocolUtil_1.protocolUtil.readStringNT(smartBuffer);
+        });
+        return update;
+    }
+    toBuffer() {
+        const smartBuffer = new smart_buffer_1.SmartBuffer();
+        smartBuffer.writeInt32LE(this.data.threadIndex);
+        smartBuffer.writeUInt8(Constants_1.StopReasonCode[this.data.stopReason]);
+        smartBuffer.writeStringNT(this.data.stopReasonDetail);
+        ProtocolUtil_1.protocolUtil.insertCommonUpdateFields(this, smartBuffer);
+        return smartBuffer.toBuffer();
+    }
+}
+exports.ThreadAttachedUpdate = ThreadAttachedUpdate;
+//# sourceMappingURL=ThreadAttachedUpdate.js.map

package/dist/debugProtocol/events/updates/ThreadAttachedUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThreadAttachedUpdate.js","sourceRoot":"","sources":["../../../../src/debugProtocol/events/updates/ThreadAttachedUpdate.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE3C,+CAAwE;AACxE,qDAAkD;AAElD,MAAa,oBAAoB;IAAjC;QAmCW,YAAO,GAAG,KAAK,CAAC;QAChB,eAAU,GAAG,CAAC,CAAC;QAEf,SAAI,GAAG;YACV;;eAEG;YACH,WAAW,EAAE,SAAmB;YAChC,UAAU,EAAE,SAAuB;YACnC,gBAAgB,EAAE,SAAmB;YAErC,cAAc;YACd,YAAY,EAAE,SAAmB;YACjC,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,qBAAS,CAAC,EAAE;YACvB,UAAU,EAAE,sBAAU,CAAC,cAAc;SACxC,CAAC;IACN,CAAC;IAlDU,MAAM,CAAC,QAAQ,CAAC,IAItB;QACG,MAAM,MAAM,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC1C,2BAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,MAAc;QACnC,MAAM,MAAM,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC1C,2BAAY,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,EAAE;YAChE,2BAAY,CAAC,sBAAsB,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACjF,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;YACpD,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,0BAAc,CAAC,WAAW,CAAC,SAAS,EAAE,CAAe,CAAC;YAC/E,MAAM,CAAC,IAAI,CAAC,gBAAgB,GAAG,2BAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,QAAQ;QACX,MAAM,WAAW,GAAG,IAAI,0BAAW,EAAE,CAAC;QAEtC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChD,WAAW,CAAC,UAAU,CAAC,0BAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QAC7D,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEtD,2BAAY,CAAC,wBAAwB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAEzD,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;CAmBJ;AApDD,oDAoDC"}

package/dist/debugProtocol/server/DebugProtocolServer.d.ts

@@ -0,0 +1,110 @@
+/// <reference types="node" />
+import * as Net from 'net';
+import type { ProtocolRequest, ProtocolResponse } from '../events/ProtocolEvent';
+import PluginInterface from '../PluginInterface';
+import type { ProtocolServerPlugin } from './DebugProtocolServerPlugin';
+export declare const DEBUGGER_MAGIC = "bsdebug";
+/**
+ * A class that emulates the way a Roku's DebugProtocol debug session/server works. This is mostly useful for unit testing,
+ * but might eventually be helpful for an off-device emulator as well
+ */
+export declare class DebugProtocolServer {
+    options?: DebugProtocolServerOptions;
+    constructor(options?: DebugProtocolServerOptions);
+    private logger;
+    /**
+     * Indicates whether the client has sent the magic string to kick off the debug session.
+     */
+    private isHandshakeComplete;
+    private buffer;
+    /**
+     * The server
+     */
+    private server;
+    /**
+     * Once a client connects, this is a reference to that client
+     */
+    private client;
+    /**
+     * A collection of plugins that can interact with the server at lifecycle points
+     */
+    plugins: PluginInterface<ProtocolServerPlugin>;
+    /**
+     * A queue for processing the incoming buffer, every transmission at a time
+     */
+    private bufferQueue;
+    get controlPort(): number;
+    private _port;
+    /**
+     * Run the server. This opens a socket and listens for a connection.
+     * The promise resolves when the server has started listening. It does NOT wait for a client to connect
+     */
+    start(): Promise<unknown>;
+    stop(): Promise<void>;
+    destroy(): Promise<void>;
+    /**
+     * Given a buffer, find the request that matches it
+     */
+    static getRequest(buffer: Buffer, allowHandshake: boolean): ProtocolRequest;
+    private getResponse;
+    /**
+     * Process a single request.
+     * @returns true if successfully processed a request, and false if not
+     */
+    private process;
+    /**
+     * Send a response from the server to the client. This involves writing the response buffer to the client socket
+     */
+    private sendResponse;
+    /**
+     * Send an update from the server to the client. This can be things like ALL_THREADS_STOPPED
+     */
+    sendUpdate(update: ProtocolResponse): Promise<ProtocolResponse>;
+    /**
+     * An event emitter used for all of the events this server emitts
+     */
+    private emitter;
+    on<T = {
+        response: Response;
+    }>(eventName: 'before-send-response', callback: (event: T) => void): any;
+    on<T = {
+        response: Response;
+    }>(eventName: 'after-send-response', callback: (event: T) => void): any;
+    on<T = {
+        client: Net.Socket;
+    }>(eventName: 'client-connected', callback: (event: T) => void): any;
+    on<T = any>(eventName: string, callback: (data: T) => void): any;
+    /**
+     * Subscribe to an event exactly one time. This will fire the very next time an event happens,
+     * and then immediately unsubscribe
+     */
+    once<T>(eventName: string): Promise<T>;
+    emit<T = {
+        response: Response;
+    }>(eventName: 'before-send-response', event: T): T;
+    emit<T = {
+        response: Response;
+    }>(eventName: 'after-send-response', event: T): T;
+    emit<T = {
+        client: Net.Socket;
+    }>(eventName: 'client-connected', event: T): T;
+    /**
+     * The magic string used to kick off the debug session.
+     * @default "bsdebug"
+     */
+    private get magic();
+}
+export interface DebugProtocolServerOptions {
+    /**
+     * The magic that is sent as part of the handshake
+     */
+    magic?: string;
+    /**
+     * The port to use for the primary communication between this server and a client
+     */
+    controlPort?: number;
+    /**
+     * A specific host to listen on. If not specified, all hosts are used
+     */
+    host?: string;
+}