scoundrel-remote-eval 1.0.8 → 1.0.10

package/build/client/connections/web-socket/index.d.ts

@@ -0,0 +1,34 @@
+export default class WebSocket {
+    /**
+     * Creates a new WebSocket connection handler
+     * @param {WebSocket} ws The WebSocket instance
+     */
+    constructor(ws: WebSocket);
+    ws: WebSocket;
+    commands: {};
+    commandsCount: number;
+    close(): Promise<void>;
+    /**
+     * @param {(data: any) => void} callback
+     */
+    onCommand(callback: (data: any) => void): void;
+    onCommandCallback: (data: any) => void;
+    /**
+     * @param {Event} event
+     */
+    onSocketError: (event: Event) => void;
+    /**
+     * @param {MessageEvent} event
+     */
+    onSocketMessage: (event: MessageEvent) => void;
+    /**
+     * @param {Event} event
+     */
+    onSocketOpen: (event: Event) => void;
+    /**
+     * @param {Record<string, any>} data
+     */
+    send(data: Record<string, any>): void;
+    waitForOpened: () => Promise<any>;
+}
+//# sourceMappingURL=index.d.ts.map

package/build/client/connections/web-socket/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/client/connections/web-socket/index.js"],"names":[],"mappings":"AAQA;IACE;;;OAGG;IACH,gBAFW,SAAS,EAgBnB;IAbC,cAAY;IAWZ,aAAkB;IAClB,sBAAsB;IAGxB,uBAEC;IAED;;OAEG;IACH,oBAFW,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,QAI7B;IADC,0BAHgB,GAAG,KAAK,IAAI,CAGK;IAGnC;;OAEG;IACH,gBAAiB,OAFN,KAEW,UAErB;IAED;;OAEG;IACH,kBAAmB,OAFR,YAEa,UAUvB;IAED;;OAEG;IACH,eAAgB,OAFL,KAEU,UAEpB;IAED;;OAEG;IACH,WAFW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,QAQ7B;IAED,kCAME;CACH"}

package/build/client/connections/web-socket/index.js

@@ -0,0 +1,68 @@
+// @ts-check
+import Logger from "../../../logger.js";
+const logger = new Logger("Scoundrel WebSocket");
+// logger.setDebug(true)
+export default class WebSocket {
+    /**
+     * Creates a new WebSocket connection handler
+     * @param {WebSocket} ws The WebSocket instance
+     */
+    constructor(ws) {
+        /**
+         * @param {Event} event
+         */
+        this.onSocketError = (event) => {
+            logger.error(() => ["onSocketError", event]);
+        };
+        /**
+         * @param {MessageEvent} event
+         */
+        this.onSocketMessage = (event) => {
+            const data = JSON.parse(event.data);
+            logger.log(() => ["Client::Connections::WebSocket onSocketMessage", data]);
+            if (!this.onCommandCallback) {
+                throw new Error("No onCommand callback set, ignoring message");
+            }
+            this.onCommandCallback(data);
+        };
+        /**
+         * @param {Event} event
+         */
+        this.onSocketOpen = (event) => {
+            logger.log(() => ["onSocketOpen", event]);
+        };
+        this.waitForOpened = () => new Promise((resolve, reject) => {
+            // @ts-ignore
+            this.ws.addEventListener("open", resolve);
+            // @ts-ignore
+            this.ws.addEventListener("error", reject);
+        });
+        this.ws = ws;
+        // @ts-ignore
+        this.ws.addEventListener("error", this.onSocketError);
+        // @ts-ignore
+        this.ws.addEventListener("open", this.onSocketOpen);
+        // @ts-ignore
+        this.ws.addEventListener("message", this.onSocketMessage);
+        this.commands = {};
+        this.commandsCount = 0;
+    }
+    async close() {
+        await this.ws.close();
+    }
+    /**
+     * @param {(data: any) => void} callback
+     */
+    onCommand(callback) {
+        this.onCommandCallback = callback;
+    }
+    /**
+     * @param {Record<string, any>} data
+     */
+    send(data) {
+        const sendData = JSON.stringify(data);
+        logger.log(() => ["Sending", sendData]);
+        // @ts-ignore
+        this.ws.send(sendData);
+    }
+}

package/build/client/index.d.ts

@@ -0,0 +1,186 @@
+export default class Client {
+    /**
+     * Creates a new Scoundrel Client
+     *
+     * @param {any} backend The backend connection (e.g., WebSocket)
+     * @param {{enableServerControl?: boolean}} [options]
+     */
+    constructor(backend: any, options?: {
+        enableServerControl?: boolean;
+    });
+    backend: any;
+    /** @type {Record<number, any>} */
+    outgoingCommands: Record<number, any>;
+    incomingCommands: {};
+    outgoingCommandsCount: number;
+    /** @type {Record<string, any>} */
+    _classes: Record<string, any>;
+    /** @type {Record<string, any>} */
+    _objects: Record<string, any>;
+    /** @type {Record<string, Reference>} */
+    references: Record<string, Reference>;
+    /** @type {Record<number, any>} */
+    objects: Record<number, any>;
+    objectsCount: number;
+    /** @type {boolean} */
+    serverControlEnabled: boolean;
+    /**
+     * Closes the client connection
+     */
+    close(): Promise<void>;
+    /**
+     * Calls a method on a reference and returns the result directly
+     *
+     * @param {number} referenceId
+     * @param {string} methodName
+     * @param  {...any} args
+     * @returns {Promise<any>}
+     */
+    callMethodOnReference(referenceId: number, methodName: string, ...args: any[]): Promise<any>;
+    /**
+     * Calls a method on a reference and returns a new reference
+     *
+     * @param {number} referenceId
+     * @param {string} methodName
+     * @param  {...any} args
+     * @returns {Promise<Reference>}
+     */
+    callMethodOnReferenceWithReference(referenceId: number, methodName: string, ...args: any[]): Promise<Reference>;
+    /**
+     * Evaluates a string and returns a new reference
+     *
+     * @param {string} evalString
+     * @returns {Promise<Reference>}
+     */
+    evalWithReference(evalString: string): Promise<Reference>;
+    /**
+     * Imports a module and returns a reference to it
+     *
+     * @param {string} importName
+     * @returns {Promise<Reference>}
+     */
+    import(importName: string): Promise<Reference>;
+    /**
+     * Gets a registered object by name
+     *
+     * @param {string} objectName
+     * @returns {Promise<Reference>}
+     */
+    getObject(objectName: string): Promise<Reference>;
+    /**
+     * Spawns a new reference to an object
+     *
+     * @param {string} className
+     * @param  {...any} args
+     * @returns {Promise<Reference>}
+     */
+    newObjectWithReference(className: string, ...args: any[]): Promise<Reference>;
+    /**
+     * Checks if the input is a plain object
+     * @param {any} input
+     * @returns {boolean}
+     */
+    isPlainObject(input: any): boolean;
+    /**
+     * Handles an incoming command from the backend
+     * @param {object} args
+     * @param {string} args.command
+     * @param {number} args.command_id
+     * @param {any} args.data
+     * @param {string} [args.error]
+     * @param {string} [args.errorStack]
+     */
+    onCommand: ({ command, command_id: commandID, data, error, errorStack, ...restArgs }: {
+        command: string;
+        command_id: number;
+        data: any;
+        error?: string;
+        errorStack?: string;
+    }) => void;
+    /**
+     * Parases an argument for sending to the server
+     *
+     * @param {any} arg
+     * @returns {any}
+     */
+    parseArg(arg: any): any;
+    /**
+     * Reads an attribute on a reference and returns a new reference
+     *
+     * @param {number} referenceId
+     * @param {string} attributeName
+     * @returns {Promise<Reference>}
+     */
+    readAttributeOnReferenceWithReference(referenceId: number, attributeName: string): Promise<Reference>;
+    /**
+     * Reads an attribute on a reference and returns the result directly
+     *
+     * @param {number} referenceId
+     * @param {string} attributeName
+     * @returns {Promise<any>}
+     */
+    readAttributeOnReference(referenceId: number, attributeName: string): Promise<any>;
+    /**
+     * Registers a class by name
+     *
+     * @param {string} className
+     * @param {any} classInstance
+     */
+    registerClass(className: string, classInstance: any): void;
+    /**
+     * Gets a registered class by name
+     *
+     * @param {string} className
+     * @returns {any}
+     */
+    getClass(className: string): any;
+    /**
+     * Registers an object by name
+     *
+     * @param {string} objectName
+     * @param {any} objectInstance
+     */
+    registerObject(objectName: string, objectInstance: any): void;
+    /**
+     * Gets a registered object by name
+     *
+     * @param {string} objectName
+     * @returns {any}
+     */
+    _getRegisteredObject(objectName: string): any;
+    /**
+     * Responds to a command from the backend
+     * @param {number} commandId
+     * @param {any} data
+     */
+    respondToCommand(commandId: number, data: any): void;
+    /**
+     * Sends a command to the backend and returns a promise that resolves with the response
+     * @param {string} command
+     * @param {any} data
+     * @returns {Promise<any>}
+     */
+    sendCommand(command: string, data: any): Promise<any>;
+    /**
+     * Sends data to the backend
+     * @param {any} data
+     */
+    send(data: any): void;
+    /**
+     * Serializes a reference and returns the result directly
+     *
+     * @param {number} referenceId
+     * @returns {Promise<any>}
+     */
+    serializeReference(referenceId: number): Promise<any>;
+    /**
+     * Spawns a new reference to an object
+     *
+     * @param {string} id
+     * @returns {Reference}
+     */
+    spawnReference(id: string): Reference;
+    enableServerControl(): void;
+}
+import Reference from "./reference.js";
+//# sourceMappingURL=index.d.ts.map

package/build/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.js"],"names":[],"mappings":"AASA;IACE;;;;;OAKG;IACH,qBAHW,GAAG,YACH;QAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAAC,EA2BzC;IAxBC,aAAsB;IAGtB,kCAAkC;IAClC,kBADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACJ;IAC1B,qBAA0B;IAC1B,8BAA8B;IAE9B,kCAAkC;IAClC,UADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACZ;IAElB,kCAAkC;IAClC,UADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACZ;IAElB,wCAAwC;IACxC,YADW,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAChB;IAEpB,kCAAkC;IAClC,SADW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACb;IAEjB,qBAAqB;IAErB,sBAAsB;IACtB,sBADW,OAAO,CAC8C;IAGlE;;OAEG;IACH,uBAEC;IAED;;;;;;;OAOG;IACH,mCALW,MAAM,cACN,MAAM,WACF,GAAG,EAAA,GACL,OAAO,CAAC,GAAG,CAAC,CAWxB;IAED;;;;;;;OAOG;IACH,gDALW,MAAM,cACN,MAAM,WACF,GAAG,EAAA,GACL,OAAO,CAAC,SAAS,CAAC,CAY9B;IAED;;;;;OAKG;IACH,8BAHW,MAAM,GACJ,OAAO,CAAC,SAAS,CAAC,CAM9B;IAED;;;;;OAKG;IACH,mBAHW,MAAM,GACJ,OAAO,CAAC,SAAS,CAAC,CAe9B;IAED;;;;;OAKG;IACH,sBAHW,MAAM,GACJ,OAAO,CAAC,SAAS,CAAC,CAY9B;IAED;;;;;;OAMG;IACH,kCAJW,MAAM,WACF,GAAG,EAAA,GACL,OAAO,CAAC,SAAS,CAAC,CAe9B;IAED;;;;OAIG;IACH,qBAHW,GAAG,GACD,OAAO,CAQnB;IAED;;;;;;;;OAQG;IACH,YAAa,0EANV;QAAqB,OAAO,EAApB,MAAM;QACO,UAAU,EAAvB,MAAM;QACI,IAAI,EAAd,GAAG;QACW,KAAK,GAAnB,MAAM;QACQ,UAAU,GAAxB,MAAM;KAEkE,UAkJlF;IAED;;;;;OAKG;IACH,cAHW,GAAG,GACD,GAAG,CAwBf;IAED;;;;;;OAMG;IACH,mDAJW,MAAM,iBACN,MAAM,GACJ,OAAO,CAAC,SAAS,CAAC,CAW9B;IAED;;;;;;OAMG;IACH,sCAJW,MAAM,iBACN,MAAM,GACJ,OAAO,CAAC,GAAG,CAAC,CASxB;IAED;;;;;OAKG;IACH,yBAHW,MAAM,iBACN,GAAG,QAMb;IAED;;;;;OAKG;IACH,oBAHW,MAAM,GACJ,GAAG,CAIf;IAED;;;;;OAKG;IACH,2BAHW,MAAM,kBACN,GAAG,QAMb;IAED;;;;;OAKG;IACH,iCAHW,MAAM,GACJ,GAAG,CAIf;IAED;;;;OAIG;IACH,4BAHW,MAAM,QACN,GAAG,QAIb;IAED;;;;;OAKG;IACH,qBAJW,MAAM,QACN,GAAG,GACD,OAAO,CAAC,GAAG,CAAC,CAexB;IAED;;;OAGG;IACH,WAFW,GAAG,QAIb;IAED;;;;;OAKG;IACH,gCAHW,MAAM,GACJ,OAAO,CAAC,GAAG,CAAC,CAMxB;IAED;;;;;OAKG;IACH,mBAHW,MAAM,GACJ,SAAS,CAQrB;IAED,4BAEC;CACF;sBAxfqB,gBAAgB"}