roku-debug 0.20.6 → 0.20.7

package/dist/debugProtocol/DebugProtocolClientReplaySession.js

@@ -0,0 +1,278 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DebugProtocolClientReplaySession = void 0;
+const DebugProtocolClient_1 = require("./client/DebugProtocolClient");
+const util_1 = require("../util");
+const DebugProtocolServer_1 = require("./server/DebugProtocolServer");
+const Net = require("net");
+const ActionQueue_1 = require("../managers/ActionQueue");
+const IOPortOpenedUpdate_1 = require("./events/updates/IOPortOpenedUpdate");
+class DebugProtocolClientReplaySession {
+    constructor(options) {
+        this.disposables = Array();
+        this.entryIndex = 0;
+        this.result = [];
+        this.finished = (0, util_1.defer)();
+        this.clientSync = new BufferSync();
+        this.clientActionQueue = new ActionQueue_1.ActionQueue();
+        this.serverActionQueue = new ActionQueue_1.ActionQueue();
+        this.serverSync = new BufferSync();
+        this.serverProcessIdx = 0;
+        this.parseBufferLog(options === null || options === void 0 ? void 0 : options.bufferLog);
+    }
+    peekEntry() {
+        this.flushIO();
+        return this.entries[this.entryIndex];
+    }
+    advanceEntry() {
+        this.flushIO();
+        return this.entries[this.entryIndex++];
+    }
+    flushIO() {
+        var _a;
+        while (((_a = this.entries[this.entryIndex]) === null || _a === void 0 ? void 0 : _a.type) === 'io') {
+            const entry = this.entries[this.entryIndex++];
+            this.ioSocket.write(entry.buffer);
+        }
+    }
+    parseBufferLog(bufferLog) {
+        this.entries = bufferLog
+            .split(/\r?\n/g)
+            //only keep lines that include the `[[bufferLog]]` magic text
+            .filter(x => x.includes('[[bufferLog]]'))
+            //remove leading text, leaving only the raw bufferLog entry
+            .map(x => x.replace(/.*?\[\[bufferLog\]\]:/, '').trim())
+            .filter(x => !!x)
+            .map(line => {
+            const entry = JSON.parse(line);
+            entry.timestamp = new Date(entry.timestamp);
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+            entry.buffer = Buffer.from(entry.buffer);
+            return entry;
+        });
+        return this.entries;
+    }
+    async run() {
+        this.controlPort = await util_1.util.getPort();
+        this.ioPort = await util_1.util.getPort();
+        await this.createServer(this.controlPort);
+        this.createClient(this.controlPort);
+        //connect, but don't send the handshake. That'll be send through our first server-to-client entry (hopefully)
+        await this.client.connect(false);
+        void this.clientProcess();
+        await this.finished.promise;
+    }
+    createClient(controlPort) {
+        this.client = new DebugProtocolClient_1.DebugProtocolClient({
+            controlPort: controlPort,
+            host: 'localhost'
+        });
+        //store the responses in the result
+        this.client.on('response', (response) => {
+            this.result.push(response);
+            void this.clientProcess();
+        });
+        this.client.on('update', (update) => {
+            this.result.push(update);
+            void this.clientProcess();
+        });
+        this.client.on('io-output', (data) => {
+            console.log(data);
+            void this.clientProcess();
+        });
+        //anytime the client receives buffer data, we should try and process it
+        this.client.on('data', (data) => {
+            this.clientSync.pushActual(data);
+            void this.clientProcess();
+        });
+        this.client.plugins.add({
+            beforeHandleUpdate: async (event) => {
+                if ((0, IOPortOpenedUpdate_1.isIOPortOpenedUpdate)(event.update)) {
+                    //spin up an IO port before finishing this update
+                    await this.openIOPort();
+                    const update = IOPortOpenedUpdate_1.IOPortOpenedUpdate.fromJson(event.update.data);
+                    update.data.port = this.ioPort;
+                    //if we get an IO update, change the port and host to the local stuff (for testing purposes)
+                    event.update = update;
+                }
+            }
+        });
+        //stuff to run when the session is disposed
+        this.disposables.push(() => {
+            return this.client.destroy();
+        });
+    }
+    openIOPort() {
+        console.log(`Spinning up mock IO socket on port ${this.ioPort}`);
+        return new Promise((resolve) => {
+            const server = new Net.Server({});
+            //whenever a client makes a connection
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises
+            server.on('connection', (client) => {
+                this.ioSocket = client;
+                //anytime we receive incoming data from the client
+                client.on('data', (data) => {
+                    //TODO send IO data
+                });
+            });
+            server.listen({
+                port: this.ioPort,
+                hostName: 'localhost'
+            }, () => {
+                resolve();
+            });
+            //stuff to run when the session is disposed
+            this.disposables.push(() => {
+                server.close();
+            });
+            this.disposables.push(() => {
+                var _a;
+                (_a = this.ioSocket) === null || _a === void 0 ? void 0 : _a.destroy();
+            });
+        });
+    }
+    async clientProcess() {
+        await this.clientActionQueue.run(async () => {
+            var _a;
+            //build a single buffer of client data
+            while (((_a = this.peekEntry()) === null || _a === void 0 ? void 0 : _a.type) === 'client-to-server') {
+                //make sure it's been enough time since the last entry
+                await this.sleepForEntryGap();
+                const entry = this.advanceEntry();
+                const request = DebugProtocolServer_1.DebugProtocolServer.getRequest(entry.buffer, true);
+                //store this client data for our mock server to recognize and track
+                this.serverSync.pushExpected(request.toBuffer());
+                //store the request in the result
+                this.result.push(request);
+                //send the request
+                void this.client.processRequest(request);
+            }
+            this.finalizeIfDone();
+            return true;
+        });
+    }
+    finalizeIfDone() {
+        if (this.clientSync.areInSync && this.serverSync.areInSync && this.entryIndex >= this.entries.length) {
+            this.finished.resolve();
+        }
+    }
+    createServer(controlPort) {
+        return new Promise((resolve) => {
+            const server = new Net.Server({});
+            //Roku only allows 1 connection, so we should too.
+            server.maxConnections = 1;
+            //whenever a client makes a connection
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises
+            server.on('connection', (client) => {
+                this.server = client;
+                //anytime we receive incoming data from the client
+                client.on('data', (data) => {
+                    console.log('server got:', JSON.stringify(data.toJSON().data));
+                    void this.serverProcess(data);
+                });
+            });
+            server.listen({
+                port: controlPort,
+                hostName: 'localhost'
+            }, () => {
+                resolve();
+            });
+            //stuff to run when the session is disposed
+            this.disposables.push(() => {
+                server.close();
+            });
+            this.disposables.push(() => {
+                var _a;
+                (_a = this.client) === null || _a === void 0 ? void 0 : _a.destroy();
+            });
+        });
+    }
+    async serverProcess(data) {
+        let serverProcesIdx = this.serverProcessIdx++;
+        await this.serverActionQueue.run(async () => {
+            var _a;
+            try {
+                console.log(serverProcesIdx);
+                this.serverSync.pushActual(data);
+                if (this.serverSync.areInSync) {
+                    this.serverSync.clear();
+                    //send all the server messages, each delayed slightly to simulate the chunked buffer flushing that roku causes
+                    while (((_a = this.peekEntry()) === null || _a === void 0 ? void 0 : _a.type) === 'server-to-client') {
+                        //make sure enough time has passed since the last entry
+                        await this.sleepForEntryGap();
+                        const entry = this.advanceEntry();
+                        this.server.write(entry.buffer);
+                        this.clientSync.pushExpected(entry.buffer);
+                    }
+                }
+                this.finalizeIfDone();
+            }
+            catch (e) {
+                console.error('serverProcess failed to handle buffer', e);
+            }
+            return true;
+        });
+    }
+    /**
+     * Sleep for the amount of time between the two specified entries
+     */
+    async sleepForEntryGap() {
+        const currentEntry = this.entries[this.entryIndex];
+        const previousEntry = this.entries[this.entryIndex - 1];
+        let gap = 0;
+        if (currentEntry && previousEntry) {
+            gap = currentEntry.timestamp.getTime() - (previousEntry === null || previousEntry === void 0 ? void 0 : previousEntry.timestamp.getTime());
+            //if the gap is negative, then the time has already passed. Just timeout at zero
+            gap = gap > 0 ? gap : 0;
+        }
+        //longer delays make the test run slower, but don't really make the test any more accurate,
+        //so cap the delay at 100ms
+        if (gap > 100) {
+            gap = 100;
+        }
+        await util_1.util.sleep(gap);
+    }
+    async destroy() {
+        for (const dispose of this.disposables) {
+            try {
+                await Promise.resolve(dispose());
+            }
+            catch (_a) { }
+        }
+    }
+}
+exports.DebugProtocolClientReplaySession = DebugProtocolClientReplaySession;
+class BufferSync {
+    constructor() {
+        this.expected = Buffer.alloc(0);
+        this.actual = Buffer.alloc(0);
+    }
+    pushExpected(buffer) {
+        this.expected = Buffer.concat([this.expected, buffer]);
+    }
+    pushActual(buffer) {
+        this.actual = Buffer.concat([this.actual, buffer]);
+    }
+    /**
+     * Are the two buffers in sync?
+     */
+    get areInSync() {
+        return JSON.stringify(this.expected) === JSON.stringify(this.actual);
+    }
+    clear() {
+        this.expected = Buffer.alloc(0);
+        this.actual = Buffer.alloc(0);
+    }
+}
+function bufferStartsWith(subject, search) {
+    const subjectData = subject.toJSON().data;
+    const searchData = search.toJSON().data;
+    for (let i = 0; i < searchData.length; i++) {
+        if (subjectData[i] !== searchData[i]) {
+            return false;
+        }
+    }
+    //if we made it to the end of the search, then the subject fully starts with search
+    return true;
+}
+//# sourceMappingURL=DebugProtocolClientReplaySession.js.map

package/dist/debugProtocol/DebugProtocolClientReplaySession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DebugProtocolClientReplaySession.js","sourceRoot":"","sources":["../../src/debugProtocol/DebugProtocolClientReplaySession.ts"],"names":[],"mappings":";;;AAAA,sEAAmE;AACnE,kCAAsC;AAEtC,sEAAmE;AACnE,2BAA2B;AAC3B,yDAAsD;AACtD,4EAA+F;AAE/F,MAAa,gCAAgC;IACzC,YAAY,OAEX;QAIO,gBAAW,GAAG,KAAK,EAAc,CAAC;QAWlC,eAAU,GAAG,CAAC,CAAC;QAqChB,WAAM,GAA+D,EAAE,CAAC;QACvE,aAAQ,GAAG,IAAA,YAAK,GAAE,CAAC;QAiGnB,eAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QAE9B,sBAAiB,GAAG,IAAI,yBAAW,EAAE,CAAC;QAkEtC,sBAAiB,GAAG,IAAI,yBAAW,EAAE,CAAC;QAEtC,eAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QAC9B,qBAAgB,GAAG,CAAC,CAAC;QA5NzB,IAAI,CAAC,cAAc,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC,CAAC;IAC5C,CAAC;IAgBO,SAAS;QACb,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IACO,YAAY;QAChB,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAC3C,CAAC;IAEO,OAAO;;QACX,OAAO,CAAA,MAAA,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,0CAAE,IAAI,MAAK,IAAI,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAC9C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;SACrC;IACL,CAAC;IAEO,cAAc,CAAC,SAAiB;QACpC,IAAI,CAAC,OAAO,GAAG,SAAS;aACnB,KAAK,CAAC,QAAQ,CAAC;YAChB,6DAA6D;aAC5D,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YACzC,2DAA2D;aAC1D,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;aACvD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;aAChB,GAAG,CAAC,IAAI,CAAC,EAAE;YACR,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC/B,KAAK,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,SAAmB,CAAC,CAAC;YACtD,iEAAiE;YACjE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACzC,OAAO,KAAK,CAAC;QACjB,CAAC,CAAC,CAAC;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAOM,KAAK,CAAC,GAAG;QACZ,IAAI,CAAC,WAAW,GAAG,MAAM,WAAI,CAAC,OAAO,EAAE,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,MAAM,WAAI,CAAC,OAAO,EAAE,CAAC;QAEnC,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAE1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAEpC,6GAA6G;QAC7G,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEjC,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;IAChC,CAAC;IAEO,YAAY,CAAC,WAAmB;QACpC,IAAI,CAAC,MAAM,GAAG,IAAI,yCAAmB,CAAC;YAClC,WAAW,EAAE,WAAW;YACxB,IAAI,EAAE,WAAW;SACpB,CAAC,CAAC;QAEH,mCAAmC;QACnC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE;YACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3B,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE;YAChC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACzB,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE;YACjC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClB,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,uEAAuE;QACvE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5B,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACjC,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;YACpB,kBAAkB,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;gBAChC,IAAI,IAAA,yCAAoB,EAAC,KAAK,CAAC,MAAM,CAAC,EAAE;oBACpC,iDAAiD;oBACjD,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;oBAExB,MAAM,MAAM,GAAG,uCAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBAC9D,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;oBAC/B,4FAA4F;oBAC5F,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;iBACzB;YACL,CAAC;SACJ,CAAC,CAAC;QAEH,2CAA2C;QAC3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE;YACvB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACjC,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,UAAU;QACd,OAAO,CAAC,GAAG,CAAC,sCAAsC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACjC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAElC,sCAAsC;YACtC,kEAAkE;YAClE,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAkB,EAAE,EAAE;gBAC3C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC;gBACvB,kDAAkD;gBAClD,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;oBACvB,mBAAmB;gBACvB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC;gBACV,IAAI,EAAE,IAAI,CAAC,MAAM;gBACjB,QAAQ,EAAE,WAAW;aACxB,EAAE,GAAG,EAAE;gBACJ,OAAO,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;YAEH,2CAA2C;YAC3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvB,MAAM,CAAC,KAAK,EAAE,CAAC;YACnB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE;;gBACvB,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,EAAE,CAAC;YAC7B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAMO,KAAK,CAAC,aAAa;QACvB,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;;YACxC,sCAAsC;YACtC,OAAO,CAAA,MAAA,IAAI,CAAC,SAAS,EAAE,0CAAE,IAAI,MAAK,kBAAkB,EAAE;gBAClD,sDAAsD;gBACtD,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClC,MAAM,OAAO,GAAG,yCAAmB,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAEnE,mEAAmE;gBACnE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAEjD,iCAAiC;gBACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAE1B,kBAAkB;gBAClB,KAAK,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;aAE5C;YACD,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,cAAc;QAClB,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAClG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;SAC3B;IACL,CAAC;IAEO,YAAY,CAAC,WAAmB;QACpC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAEjC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAClC,kDAAkD;YAClD,MAAM,CAAC,cAAc,GAAG,CAAC,CAAC;YAE1B,sCAAsC;YACtC,kEAAkE;YAClE,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAkB,EAAE,EAAE;gBAC3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;gBACrB,kDAAkD;gBAClD,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;oBACvB,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC/D,KAAK,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;gBAClC,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC;gBACV,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,WAAW;aACxB,EAAE,GAAG,EAAE;gBACJ,OAAO,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;YAEH,2CAA2C;YAC3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvB,MAAM,CAAC,KAAK,EAAE,CAAC;YACnB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE;;gBACvB,MAAA,IAAI,CAAC,MAAM,0CAAE,OAAO,EAAE,CAAC;YAC3B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAMO,KAAK,CAAC,aAAa,CAAC,IAAY;QACpC,IAAI,eAAe,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9C,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;;YACxC,IAAI;gBACA,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAC7B,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBACjC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE;oBAC3B,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;oBACxB,8GAA8G;oBAC9G,OAAO,CAAA,MAAA,IAAI,CAAC,SAAS,EAAE,0CAAE,IAAI,MAAK,kBAAkB,EAAE;wBAClD,uDAAuD;wBACvD,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;wBAClC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;wBAChC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;qBAC9C;iBACJ;gBACD,IAAI,CAAC,cAAc,EAAE,CAAC;aACzB;YAAC,OAAO,CAAC,EAAE;gBACR,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,CAAC,CAAC,CAAC;aAC7D;YACD,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,gBAAgB;QAC1B,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QACxD,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,IAAI,YAAY,IAAI,aAAa,EAAE;YAC/B,GAAG,GAAG,YAAY,CAAC,SAAS,CAAC,OAAO,EAAE,IAAG,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,SAAS,CAAC,OAAO,EAAE,CAAA,CAAC;YAC5E,gFAAgF;YAChF,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;SAC3B;QACD,2FAA2F;QAC3F,2BAA2B;QAC3B,IAAI,GAAG,GAAG,GAAG,EAAE;YACX,GAAG,GAAG,GAAG,CAAC;SACb;QACD,MAAM,WAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,OAAO;QAChB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE;YACpC,IAAI;gBACA,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;aACpC;YAAC,WAAM,GAAG;SACd;IACL,CAAC;CACJ;AArRD,4EAqRC;AAED,MAAM,UAAU;IAAhB;QACY,aAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAK3B,WAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAgBrC,CAAC;IApBU,YAAY,CAAC,MAAc;QAC9B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3D,CAAC;IAGM,UAAU,CAAC,MAAc;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK;QACR,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;CACJ;AAED,SAAS,gBAAgB,CAAC,OAAe,EAAE,MAAc;IACrD,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;IAC1C,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;IACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACxC,IAAI,WAAW,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE;YAClC,OAAO,KAAK,CAAC;SAChB;KACJ;IACD,mFAAmF;IACnF,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/debugProtocol/PluginInterface.d.ts

@@ -0,0 +1,38 @@
+export declare type Arguments<T> = [T] extends [(...args: infer U) => any] ? U : [T] extends [void] ? [] : [T];
+export default class PluginInterface<TPlugin> {
+    constructor(plugins?: TPlugin[]);
+    private plugins;
+    /**
+     * Call `event` on plugins
+     */
+    emit<K extends keyof TPlugin & string>(eventName: K, event: Arguments<TPlugin[K]>[0]): Promise<Arguments<TPlugin[K]>[0]>;
+    /**
+     * Add a plugin to the end of the list of plugins
+     * @param plugin the plugin
+     * @param priority the priority for the plugin. Lower number means higher priority. (ex: 1 executes before 5)
+     */
+    add<T extends TPlugin = TPlugin>(plugin: T, priority?: number): T;
+    /**
+     * Adds a temporary plugin with a single event hook, and resolve a promise with the event from the next occurance of that event.
+     * Once the event fires for the first time, the plugin is unregistered.
+     * @param eventName the name of the event to subscribe to
+     * @param priority the priority for this event. Lower number means higher priority. (ex: 1 executes before 5)
+     */
+    once<TEventType>(eventName: keyof TPlugin, priority?: number): Promise<TEventType>;
+    /**
+     * Adds a temporary plugin with a single event hook, and resolve a promise with the event from the next occurance of that event.
+     * Once the event fires for the first time and the matcher evaluates to true, the plugin is unregistered.
+     * @param eventName the name of the event to subscribe to
+     * @param matcher a function to call that, when true, will deregister this hander and return the event
+     * @param priority the priority for this event. Lower number means higher priority. (ex: 1 executes before 5)
+     */
+    onceIf<TEventType>(eventName: keyof TPlugin, matcher: (TEventType: any) => boolean, priority?: number): Promise<TEventType>;
+    /**
+     * Remove the specified plugin
+     */
+    remove<T extends TPlugin = TPlugin>(plugin: T): void;
+    /**
+     * Remove all plugins
+     */
+    clear(): void;
+}

package/dist/debugProtocol/PluginInterface.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class PluginInterface {
+    constructor(plugins = []) {
+        this.plugins = [];
+        for (const plugin of plugins !== null && plugins !== void 0 ? plugins : []) {
+            this.add(plugin);
+        }
+    }
+    /**
+     * Call `event` on plugins
+     */
+    async emit(eventName, event) {
+        for (let { plugin } of this.plugins) {
+            if (plugin[eventName]) {
+                await Promise.resolve(plugin[eventName](event));
+            }
+        }
+        return event;
+    }
+    /**
+     * Add a plugin to the end of the list of plugins
+     * @param plugin the plugin
+     * @param priority the priority for the plugin. Lower number means higher priority. (ex: 1 executes before 5)
+     */
+    add(plugin, priority = 1) {
+        const container = {
+            plugin: plugin,
+            priority: priority
+        };
+        this.plugins.push(container);
+        //sort the plugins by priority
+        this.plugins.sort((a, b) => {
+            return a.priority - b.priority;
+        });
+        return plugin;
+    }
+    /**
+     * Adds a temporary plugin with a single event hook, and resolve a promise with the event from the next occurance of that event.
+     * Once the event fires for the first time, the plugin is unregistered.
+     * @param eventName the name of the event to subscribe to
+     * @param priority the priority for this event. Lower number means higher priority. (ex: 1 executes before 5)
+     */
+    once(eventName, priority = 1) {
+        return this.onceIf(eventName, () => true, priority);
+    }
+    /**
+     * Adds a temporary plugin with a single event hook, and resolve a promise with the event from the next occurance of that event.
+     * Once the event fires for the first time and the matcher evaluates to true, the plugin is unregistered.
+     * @param eventName the name of the event to subscribe to
+     * @param matcher a function to call that, when true, will deregister this hander and return the event
+     * @param priority the priority for this event. Lower number means higher priority. (ex: 1 executes before 5)
+     */
+    onceIf(eventName, matcher, priority = 1) {
+        return new Promise((resolve) => {
+            const tempPlugin = {};
+            tempPlugin[eventName] = (event) => {
+                if (matcher(event)) {
+                    //remove the temp plugin
+                    this.remove(tempPlugin);
+                    //resolve the promise with this event
+                    resolve(event);
+                }
+            };
+            this.add(tempPlugin, priority);
+        });
+    }
+    /**
+     * Remove the specified plugin
+     */
+    remove(plugin) {
+        for (let i = this.plugins.length - 1; i >= 0; i--) {
+            if (this.plugins[i].plugin === plugin) {
+                this.plugins.splice(i, 1);
+            }
+        }
+    }
+    /**
+     * Remove all plugins
+     */
+    clear() {
+        this.plugins = [];
+    }
+}
+exports.default = PluginInterface;
+//# sourceMappingURL=PluginInterface.js.map

package/dist/debugProtocol/PluginInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginInterface.js","sourceRoot":"","sources":["../../src/debugProtocol/PluginInterface.ts"],"names":[],"mappings":";;AAKA,MAAqB,eAAe;IAChC,YACI,UAAU,EAAe;QAOrB,YAAO,GAAoC,EAAE,CAAC;QALlD,KAAK,MAAM,MAAM,IAAI,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;SACpB;IACL,CAAC;IAID;;OAEG;IACI,KAAK,CAAC,IAAI,CAAmC,SAAY,EAAE,KAA+B;QAC7F,KAAK,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE;YACjC,IAAK,MAAc,CAAC,SAAS,CAAC,EAAE;gBAC5B,MAAM,OAAO,CAAC,OAAO,CAAE,MAAc,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;aAC5D;SACJ;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,GAAG,CAA8B,MAAS,EAAE,QAAQ,GAAG,CAAC;QAC3D,MAAM,SAAS,GAAG;YACd,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;SACrB,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE7B,8BAA8B;QAC9B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACvB,OAAO,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAa,SAAwB,EAAE,QAAQ,GAAG,CAAC;QAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAa,SAAwB,EAAE,OAAgC,EAAE,QAAQ,GAAG,CAAC;QAC9F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3B,MAAM,UAAU,GAAG,EAAS,CAAC;YAC7B,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE;gBAC9B,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE;oBAChB,wBAAwB;oBACxB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;oBACxB,qCAAqC;oBACrC,OAAO,CAAC,KAAK,CAAC,CAAC;iBAClB;YACL,CAAC,CAAC;YACF,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACnC,CAAC,CAAQ,CAAC;IACd,CAAC;IAED;;OAEG;IACI,MAAM,CAA8B,MAAS;QAChD,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;YAC/C,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,EAAE;gBACnC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aAC7B;SACJ;IACL,CAAC;IAED;;OAEG;IACI,KAAK;QACR,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;IACtB,CAAC;CACJ;AA5FD,kCA4FC"}

package/dist/debugProtocol/ProtocolUtil.d.ts

@@ -0,0 +1,56 @@
+/// <reference types="node" />
+import { SmartBuffer } from 'smart-buffer';
+import type { UpdateType } from './Constants';
+import type { ProtocolRequest, ProtocolResponse, ProtocolUpdate } from './events/ProtocolEvent';
+export declare class ProtocolUtil {
+    /**
+     * Load json data onto an event, and mark it as successful
+     */
+    loadJson(event: {
+        data: any;
+        success: boolean;
+    }, data: any): void;
+    /**
+     * Helper function for buffer loading.
+     * Handles things like try/catch, setting buffer read offset, etc
+     */
+    bufferLoaderHelper(event: {
+        success: boolean;
+        readOffset: number;
+        data?: {
+            packetLength?: number;
+        };
+    }, buffer: Buffer, minByteLength: number, processor: (buffer: SmartBuffer) => boolean | void): {
+        success: boolean;
+        readOffset: number;
+        data?: {
+            packetLength?: number;
+        };
+    };
+    /**
+     * Load the common DebuggerRequest fields
+     */
+    loadCommonRequestFields(request: ProtocolRequest, smartBuffer: SmartBuffer): void;
+    /**
+     * Load the common DebuggerResponse
+     */
+    loadCommonResponseFields(response: ProtocolResponse, smartBuffer: SmartBuffer): void;
+    loadCommonUpdateFields(update: ProtocolUpdate, smartBuffer: SmartBuffer, updateType: UpdateType): boolean;
+    /**
+     * Inserts the common command fields to the beginning of the buffer, and computes
+     * the correct `packet_length` value.
+     */
+    insertCommonRequestFields(request: ProtocolRequest, smartBuffer: SmartBuffer): SmartBuffer;
+    insertCommonResponseFields(response: ProtocolResponse, smartBuffer: SmartBuffer): SmartBuffer;
+    /**
+     * Inserts the common response fields to the beginning of the buffer, and computes
+     * the correct `packet_length` value.
+     */
+    insertCommonUpdateFields(update: ProtocolUpdate, smartBuffer: SmartBuffer): SmartBuffer;
+    /**
+     * Tries to read a string from the buffer and will throw an error if there is no null terminator.
+     * @param {SmartBuffer} bufferReader
+     */
+    readStringNT(bufferReader: SmartBuffer): string;
+}
+export declare const protocolUtil: ProtocolUtil;

package/dist/debugProtocol/ProtocolUtil.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.protocolUtil = exports.ProtocolUtil = void 0;
+const smart_buffer_1 = require("smart-buffer");
+const util_1 = require("../util");
+const Constants_1 = require("./Constants");
+class ProtocolUtil {
+    /**
+     * Load json data onto an event, and mark it as successful
+     */
+    loadJson(event, data) {
+        event.data = {
+            ...event.data,
+            ...(data !== null && data !== void 0 ? data : {})
+        };
+        event.success = true;
+    }
+    /**
+     * Helper function for buffer loading.
+     * Handles things like try/catch, setting buffer read offset, etc
+     */
+    bufferLoaderHelper(event, buffer, minByteLength, processor) {
+        var _a, _b;
+        // Required size of this processor
+        try {
+            if (buffer.byteLength >= minByteLength) {
+                let smartBuffer = smart_buffer_1.SmartBuffer.fromBuffer(buffer);
+                //have the processor consume the requred bytes.
+                event.success = ((_a = processor(smartBuffer)) !== null && _a !== void 0 ? _a : true);
+                //if the event has a packet length, use THAT as the read offset. Otherwise, set the offset to the end of the read position of the buffer
+                if (event.success) {
+                    if (!event.readOffset) {
+                        event.readOffset = (_b = event.data.packetLength) !== null && _b !== void 0 ? _b : smartBuffer.readOffset;
+                    }
+                }
+            }
+        }
+        catch (error) {
+            // Could not parse
+            event.readOffset = 0;
+            event.success = false;
+        }
+        return event;
+    }
+    /**
+     * Load the common DebuggerRequest fields
+     */
+    loadCommonRequestFields(request, smartBuffer) {
+        request.data.packetLength = smartBuffer.readUInt32LE(); // packet_length
+        request.data.requestId = smartBuffer.readUInt32LE(); // request_id
+        request.data.command = Constants_1.CommandCode[smartBuffer.readUInt32LE()]; // command_code
+    }
+    /**
+     * Load the common DebuggerResponse
+     */
+    loadCommonResponseFields(response, smartBuffer) {
+        response.data.packetLength = smartBuffer.readUInt32LE(); // packet_length
+        response.data.requestId = smartBuffer.readUInt32LE(); // request_id
+        response.data.errorCode = smartBuffer.readUInt32LE(); // error_code
+        //if the error code is non-zero, and we have more bytes, then there will be additional data about the error
+        if (response.data.errorCode !== Constants_1.ErrorCode.OK && response.data.packetLength > smartBuffer.readOffset) {
+            response.data.errorData = {};
+            const errorFlags = smartBuffer.readUInt32LE(); // error_flags
+            // eslint-disable-next-line no-bitwise
+            if (errorFlags & Constants_1.ErrorFlags.INVALID_VALUE_IN_PATH) {
+                response.data.errorData.invalidPathIndex = smartBuffer.readUInt32LE(); // invalid_path_index
+            }
+            // eslint-disable-next-line no-bitwise
+            if (errorFlags & Constants_1.ErrorFlags.MISSING_KEY_IN_PATH) {
+                response.data.errorData.missingKeyIndex = smartBuffer.readUInt32LE(); // missing_key_index
+            }
+        }
+    }
+    loadCommonUpdateFields(update, smartBuffer, updateType) {
+        update.data.packetLength = smartBuffer.readUInt32LE(); // packet_length
+        update.data.requestId = smartBuffer.readUInt32LE(); // request_id
+        update.data.errorCode = smartBuffer.readUInt32LE(); // error_code
+        // requestId 0 means this is an update.
+        if (update.data.requestId === 0) {
+            update.data.updateType = Constants_1.UpdateTypeCode[smartBuffer.readUInt32LE()];
+            //if this is not the update type we want, return false
+            if (update.data.updateType !== updateType) {
+                return false;
+            }
+        }
+        else {
+            //not an update. We should not proceed any further.
+            throw new Error('This is not an update');
+        }
+    }
+    /**
+     * Inserts the common command fields to the beginning of the buffer, and computes
+     * the correct `packet_length` value.
+     */
+    insertCommonRequestFields(request, smartBuffer) {
+        smartBuffer.insertUInt32LE(Constants_1.CommandCode[request.data.command], 0); // command_code - An enum representing the debugging command being sent. See the COMMANDS enum
+        smartBuffer.insertUInt32LE(request.data.requestId, 0); // request_id - The ID of the debugger request (must be >=1). This ID is included in the debugger response.
+        smartBuffer.insertUInt32LE(smartBuffer.writeOffset + 4, 0); // packet_length - The size of the packet to be sent.
+        request.data.packetLength = smartBuffer.writeOffset;
+        return smartBuffer;
+    }
+    insertCommonResponseFields(response, smartBuffer) {
+        var _a, _b, _c, _d, _e;
+        //insert error data
+        const flags = (
+        // eslint-disable-next-line no-bitwise
+        0 |
+            (util_1.util.isNullish((_b = (_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.errorData) === null || _b === void 0 ? void 0 : _b.invalidPathIndex) ? 0 : Constants_1.ErrorFlags.INVALID_VALUE_IN_PATH) |
+            (util_1.util.isNullish((_d = (_c = response === null || response === void 0 ? void 0 : response.data) === null || _c === void 0 ? void 0 : _c.errorData) === null || _d === void 0 ? void 0 : _d.missingKeyIndex) ? 0 : Constants_1.ErrorFlags.MISSING_KEY_IN_PATH));
+        if (response.data.errorCode !== Constants_1.ErrorCode.OK &&
+            //there's some error data
+            Object.values((_e = response.data.errorData) !== null && _e !== void 0 ? _e : {}).some(x => !util_1.util.isNullish(x))) {
+            //do these in reverse order since we're writing to the start of the buffer
+            if (!util_1.util.isNullish(response.data.errorData.missingKeyIndex)) {
+                smartBuffer.insertUInt32LE(response.data.errorData.missingKeyIndex, 0);
+            }
+            //write error data
+            if (!util_1.util.isNullish(response.data.errorData.invalidPathIndex)) {
+                smartBuffer.insertUInt32LE(response.data.errorData.invalidPathIndex, 0);
+            }
+            //write flags
+            smartBuffer.insertUInt32LE(flags, 0);
+        }
+        smartBuffer.insertUInt32LE(response.data.errorCode, 0); // error_code
+        smartBuffer.insertUInt32LE(response.data.requestId, 0); // request_id
+        smartBuffer.insertUInt32LE(smartBuffer.writeOffset + 4, 0); // packet_length
+        response.data.packetLength = smartBuffer.writeOffset;
+        return smartBuffer;
+    }
+    /**
+     * Inserts the common response fields to the beginning of the buffer, and computes
+     * the correct `packet_length` value.
+     */
+    insertCommonUpdateFields(update, smartBuffer) {
+        smartBuffer.insertUInt32LE(Constants_1.UpdateTypeCode[update.data.updateType], 0); // update_type
+        smartBuffer.insertUInt32LE(update.data.errorCode, 0); // error_code
+        smartBuffer.insertUInt32LE(update.data.requestId, 0); // request_id
+        smartBuffer.insertUInt32LE(smartBuffer.writeOffset + 4, 0); // packet_length
+        update.data.packetLength = smartBuffer.writeOffset;
+        return smartBuffer;
+    }
+    /**
+     * Tries to read a string from the buffer and will throw an error if there is no null terminator.
+     * @param {SmartBuffer} bufferReader
+     */
+    readStringNT(bufferReader) {
+        // Find next null character (if one is not found, throw)
+        let buffer = bufferReader.toBuffer();
+        let foundNullTerminator = false;
+        for (let i = bufferReader.readOffset; i < buffer.length; i++) {
+            if (buffer[i] === 0x00) {
+                foundNullTerminator = true;
+                break;
+            }
+        }
+        if (!foundNullTerminator) {
+            throw new Error('Could not read buffer string as there is no null terminator.');
+        }
+        return bufferReader.readStringNT();
+    }
+}
+exports.ProtocolUtil = ProtocolUtil;
+exports.protocolUtil = new ProtocolUtil();
+//# sourceMappingURL=ProtocolUtil.js.map

package/dist/debugProtocol/ProtocolUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProtocolUtil.js","sourceRoot":"","sources":["../../src/debugProtocol/ProtocolUtil.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,kCAA+B;AAE/B,2CAAiF;AAGjF,MAAa,YAAY;IAErB;;OAEG;IACI,QAAQ,CAAC,KAAsC,EAAE,IAAS;QAC7D,KAAK,CAAC,IAAI,GAAG;YACT,GAAG,KAAK,CAAC,IAAI;YACb,GAAG,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC;SAClB,CAAC;QACF,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,KAAiF,EAAE,MAAc,EAAE,aAAqB,EAAE,SAAkD;;QAClM,kCAAkC;QAClC,IAAI;YACA,IAAI,MAAM,CAAC,UAAU,IAAI,aAAa,EAAE;gBACpC,IAAI,WAAW,GAAG,0BAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;gBAEjD,+CAA+C;gBAC/C,KAAK,CAAC,OAAO,GAAG,CAAC,MAAA,SAAS,CAAC,WAAW,CAAC,mCAAI,IAAI,CAAY,CAAC;gBAE5D,wIAAwI;gBACxI,IAAI,KAAK,CAAC,OAAO,EAAE;oBACf,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;wBACnB,KAAK,CAAC,UAAU,GAAG,MAAA,KAAK,CAAC,IAAI,CAAC,YAAY,mCAAI,WAAW,CAAC,UAAU,CAAC;qBACxE;iBACJ;aACJ;SACJ;QAAC,OAAO,KAAK,EAAE;YACZ,kBAAkB;YAClB,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC;YACrB,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;SACzB;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,uBAAuB,CAAC,OAAwB,EAAE,WAAwB;QAC7E,OAAO,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,gBAAgB;QACxE,OAAO,CAAC,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,aAAa;QAClE,OAAO,CAAC,IAAI,CAAC,OAAO,GAAG,uBAAW,CAAC,WAAW,CAAC,YAAY,EAAE,CAAY,CAAC,CAAC,eAAe;IAC9F,CAAC;IAED;;OAEG;IACI,wBAAwB,CAAC,QAA0B,EAAE,WAAwB;QAChF,QAAQ,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,gBAAgB;QACzE,QAAQ,CAAC,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,aAAa;QACnE,QAAQ,CAAC,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,aAAa;QAEnE,2GAA2G;QAC3G,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,KAAK,qBAAS,CAAC,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,UAAU,EAAE;YACjG,QAAQ,CAAC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;YAC7B,MAAM,UAAU,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,cAAc;YAC7D,sCAAsC;YACtC,IAAI,UAAU,GAAG,sBAAU,CAAC,qBAAqB,EAAE;gBAC/C,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,qBAAqB;aAC/F;YACD,sCAAsC;YACtC,IAAI,UAAU,GAAG,sBAAU,CAAC,mBAAmB,EAAE;gBAC7C,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,oBAAoB;aAC7F;SACJ;IACL,CAAC;IAEM,sBAAsB,CAAC,MAAsB,EAAE,WAAwB,EAAE,UAAsB;QAClG,MAAM,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,gBAAgB;QACvE,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,aAAa;QACjE,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC,aAAa;QACjE,uCAAuC;QACvC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,EAAE;YAC7B,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,0BAAc,CAAC,WAAW,CAAC,YAAY,EAAE,CAAe,CAAC;YAElF,sDAAsD;YACtD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE;gBACvC,OAAO,KAAK,CAAC;aAChB;SAEJ;aAAM;YACH,mDAAmD;YACnD,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC5C;IACL,CAAC;IAED;;;OAGG;IACI,yBAAyB,CAAC,OAAwB,EAAE,WAAwB;QAC/E,WAAW,CAAC,cAAc,CAAC,uBAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,8FAA8F;QAChK,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,2GAA2G;QAClK,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,qDAAqD;QACjH,OAAO,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,WAAW,CAAC;QACpD,OAAO,WAAW,CAAC;IACvB,CAAC;IAEM,0BAA0B,CAAC,QAA0B,EAAE,WAAwB;;QAClF,mBAAmB;QACnB,MAAM,KAAK,GAAG;QACV,sCAAsC;QACtC,CAAC;YACD,CAAC,WAAI,CAAC,SAAS,CAAC,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,SAAS,0CAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,sBAAU,CAAC,qBAAqB,CAAC;YACpG,CAAC,WAAI,CAAC,SAAS,CAAC,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,SAAS,0CAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,sBAAU,CAAC,mBAAmB,CAAC,CACpG,CAAC;QACF,IACI,QAAQ,CAAC,IAAI,CAAC,SAAS,KAAK,qBAAS,CAAC,EAAE;YACxC,yBAAyB;YACzB,MAAM,CAAC,MAAM,CAAC,MAAA,QAAQ,CAAC,IAAI,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,WAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAC5E;YACE,0EAA0E;YAE1E,IAAI,CAAC,WAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE;gBAC1D,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;aAC1E;YACD,kBAAkB;YAClB,IAAI,CAAC,WAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE;gBAC3D,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;aAC3E;YAED,aAAa;YACb,WAAW,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACxC;QACD,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa;QACrE,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa;QACrE,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,gBAAgB;QAC5E,QAAQ,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,WAAW,CAAC;QACrD,OAAO,WAAW,CAAC;IACvB,CAAC;IAGD;;;OAGG;IACI,wBAAwB,CAAC,MAAsB,EAAE,WAAwB;QAC5E,WAAW,CAAC,cAAc,CAAC,0BAAc,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,cAAc;QACrF,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa;QACnE,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa;QACnE,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,gBAAgB;QAC5E,MAAM,CAAC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,WAAW,CAAC;QACnD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,YAAyB;QACzC,wDAAwD;QACxD,IAAI,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,mBAAmB,GAAG,KAAK,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC1D,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE;gBACpB,mBAAmB,GAAG,IAAI,CAAC;gBAC3B,MAAM;aACT;SACJ;QAED,IAAI,CAAC,mBAAmB,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;SACnF;QACD,OAAO,YAAY,CAAC,YAAY,EAAE,CAAC;IACvC,CAAC;CACJ;AA3KD,oCA2KC;AAEY,QAAA,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC"}