javonet-ruby-sdk 2.5.15 → 2.5.16

data/lib/javonet-ruby-sdk/Binaries/Nodejs/lib/sdk/InvocationContext.js

@@ -1,485 +0,0 @@
-const DelegatesCache = require('../core/delegatesCache/DelegatesCache')
-const Interpreter = require('../core/interpreter/Interpreter')
-const Command = require('../utils/Command')
-const CommandType = require('../utils/CommandType')
-const ConnectionType = require('../utils/ConnectionType')
-const ExceptionThrower = require('../utils/exception/ExceptionThrower')
-const RuntimeName = require('../utils/RuntimeName')
-
-/**
- * InvocationContext is a class that represents a context for invoking commands.
- * It implements several interfaces for different types of interactions.
- * This class is used to construct chains of invocations, representing expressions of interaction that have not yet been executed.
- * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/foundations/invocation-context)
- * @class
- */
-class InvocationContext {
-    #runtimeName
-    #connectionData
-    #currentCommand
-    #responseCommand
-    #interpreter
-    // eslint-disable-next-line no-unused-private-class-members
-    #isExecuted
-    #resultValue
-
-    constructor(runtimeName, connectionData, command, isExecuted = false) {
-        this.#runtimeName = runtimeName
-        this.#connectionData = connectionData
-        this.#currentCommand = command
-        this.#responseCommand = null
-        this.#isExecuted = isExecuted
-        this.#interpreter = null
-        this.#resultValue = null
-    }
-
-    #createInstanceContext(localCommand) {
-        if (this.#connectionData.connectionType === ConnectionType.WEB_SOCKET) {
-            return new InvocationWsContext(
-                this.#runtimeName,
-                this.#connectionData,
-                this.#buildCommand(localCommand)
-            )
-        }
-        return new InvocationContext(
-            this.#runtimeName,
-            this.#connectionData,
-            this.#buildCommand(localCommand)
-        )
-    }
-
-    get_current_command() {
-        return this.#currentCommand
-    }
-
-    //destructor() {
-    //    if (this.#currentCommand.commandType === CommandType.Reference) {
-    //        this.#currentCommand = new Command(
-    //            this.#runtimeName,
-    //            CommandType.DestructReference,
-    //            this.#currentCommand.payload
-    //        );
-    //        this.execute();
-    //    }
-    //}
-
-    [Symbol.iterator] = function () {
-        if (this.#currentCommand.commandType !== CommandType.Reference) {
-            throw new Error('Object is not iterable')
-        }
-        let position = -1
-        let arraySize = this.getSize().execute().getValue()
-
-        return {
-            next: () => ({
-                value: this.getIndex(++position),
-                done: position >= arraySize,
-            }),
-        }
-    }
-
-    /**
-     * Executes the current command.
-     * Because invocation context is building the intent of executing particular expression on target environment, we call the initial state of invocation context as non-materialized.
-     * The non-materialized context wraps either single command or chain of recursively nested commands.
-     * Commands are becoming nested through each invocation of methods on Invocation Context.
-     * Each invocation triggers the creation of new Invocation Context instance wrapping the current command with new parent command valid for invoked method.
-     * Developer can decide on any moment of the materialization for the context taking full control of the chunks of the expression being transferred and processed on target runtime.
-     * @returns {InvocationContext} the InvocationContext after executing the command.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/foundations/execute-method)
-     * @method
-     */
-    execute() {
-        this.#interpreter = new Interpreter()
-        this.#responseCommand = this.#interpreter.execute(this.#currentCommand, this.#connectionData)
-        if (this.#responseCommand === undefined) {
-            throw new Error('responseCommand is undefined in Invocation Context execute method')
-        }
-        if (this.#responseCommand.commandType === CommandType.Exception) {
-            throw ExceptionThrower.throwException(this.#responseCommand)
-        }
-
-        if (this.#responseCommand.commandType === CommandType.CreateClassInstance) {
-            this.#currentCommand = this.#responseCommand
-            this.#isExecuted = true
-            return this
-        }
-
-        return new InvocationContext(this.#runtimeName, this.#connectionData, this.#responseCommand, true)
-    }
-
-    /**
-     * Invokes a static method on the target runtime.
-     * @param {string} methodName - The name of the method to invoke.
-     * @param {...any} args - Method arguments.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to invoke the static method.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/calling-methods/invoking-static-method)
-     * @method
-     */
-    invokeStaticMethod(methodName, ...args) {
-        let localCommand = new Command(this.#runtimeName, CommandType.InvokeStaticMethod, [
-            methodName,
-            ...args,
-        ])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Retrieves the value of a static field from the target runtime.
-     * @param {string} fieldName - The name of the field to get.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to get the static field.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/fields-and-properties/getting-and-setting-values-for-static-fields-and-properties)
-     * @method
-     */
-    getStaticField(fieldName) {
-        let localCommand = new Command(this.#runtimeName, CommandType.GetStaticField, [fieldName])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Sets the value of a static field in the target runtime.
-     * @param {string} fieldName - The name of the field to set.
-     * @param {any} value - The new value of the field.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to set the static field.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/fields-and-properties/getting-and-setting-values-for-static-fields-and-properties)
-     * @method
-     */
-    setStaticField(fieldName, value) {
-        let localCommand = new Command(this.#runtimeName, CommandType.SetStaticField, [fieldName, value])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Creates a new instance of a class in the target runtime.
-     * @param {...any} args - The arguments to pass to the class constructor
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to create the instance.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/calling-methods/creating-instance-and-calling-instance-methods)
-     * @method
-     */
-    createInstance(...args) {
-        let localCommand = new Command(this.#runtimeName, CommandType.CreateClassInstance, args)
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Retrieves the value of an instance field from the target runtime.
-     * @param {string} fieldName - The name of the field to get.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to get the instance field.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/fields-and-properties/getting-and-setting-values-for-instance-fields-and-properties)
-     * @method
-     */
-    getInstanceField(fieldName) {
-        let localCommand = new Command(this.#runtimeName, CommandType.GetInstanceField, [fieldName])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Sets the value of an instance field in the target runtime.
-     * @param {string} fieldName - The name of the field to set.
-     * @param {any} value - The new value of the field.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to set the instance field.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/fields-and-properties/getting-and-setting-values-for-instance-fields-and-properties)
-     * @method
-     */
-    setInstanceField(fieldName, value) {
-        let localCommand = new Command(this.#runtimeName, CommandType.SetInstanceField, [fieldName, value])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Invokes an instance method on the target runtime.
-     * @param {string} methodName - The name of the method to invoke.
-     * @param {...any} args - Method arguments.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to invoke the instance method.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/calling-methods/invoking-instance-method)
-     * @method
-     */
-    invokeInstanceMethod(methodName, ...args) {
-        let localCommand = new Command(this.#runtimeName, CommandType.InvokeInstanceMethod, [
-            methodName,
-            ...args,
-        ])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Retrieves the value at a specific index in an array from the target runtime.
-     * @param {...any} indexes - the arguments to pass to the array getter. The first argument should be the index.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to get the index.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/arrays-and-collections/one-dimensional-arrays)
-     * @method
-     */
-    getIndex(...indexes) {
-        let localCommand = new Command(this.#runtimeName, CommandType.ArrayGetItem, indexes)
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Sets the value at a specific index in an array in the target runtime.
-     * @param {number[]} indexes - The index to set the value at.
-     * @param {any} value - The value to set at the index.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to set the index.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/arrays-and-collections/one-dimensional-arrays)
-     * @method
-     */
-    setIndex(indexes, value) {
-        let localCommand = new Command(this.#runtimeName, CommandType.ArraySetItem, [indexes, value])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Retrieves the size of an array from the target runtime.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to get the size.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/arrays-and-collections/one-dimensional-arrays)
-     * @method
-     */
-    getSize() {
-        let localCommand = new Command(this.#runtimeName, CommandType.ArrayGetSize, [])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Retrieves the rank of an array from the target runtime.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to get the rank.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/arrays-and-collections/one-dimensional-arrays)
-     * @method
-     */
-    getRank() {
-        let localCommand = new Command(this.#runtimeName, CommandType.ArrayGetRank, [])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Invokes a generic static method on the target runtime.
-     * @param {string} methodName - The name of the method to invoke.
-     * @param {...any} args - Method arguments.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to invoke the generic static method.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/generics/calling-generic-static-method)
-     * @method
-     */
-    invokeGenericStaticMethod(methodName, ...args) {
-        let localCommand = new Command(this.#runtimeName, CommandType.InvokeGenericStaticMethod, [
-            methodName,
-            ...args,
-        ])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Invokes a generic method on the target runtime.
-     * @param {string} methodName - The name of the method to invoke.
-     * @param {...any} args - Method arguments.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to invoke the generic method.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/generics/calling-generic-instance-method)
-     * @method
-     */
-    invokeGenericMethod(methodName, ...args) {
-        let localCommand = new Command(this.#runtimeName, CommandType.InvokeGenericMethod, [
-            methodName,
-            ...args,
-        ])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Retrieves the name of an enum from the target runtime.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to get the enum name.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/enums/using-enum-type)
-     * @method
-     */
-    getEnumName() {
-        let localCommand = new Command(this.#runtimeName, CommandType.GetEnumName, [])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Retrieves the value of an enum from the target runtime.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to get the enum value.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/enums/using-enum-type)
-     * @method
-     */
-    getEnumValue() {
-        let localCommand = new Command(this.#runtimeName, CommandType.GetEnumValue, [])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Retrieves the value of a reference from the target runtime.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to get the ref value.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/methods-arguments/passing-arguments-by-reference-with-ref-keyword)
-     * @method
-     */
-    getRefValue() {
-        let localCommand = new Command(this.#runtimeName, CommandType.GetRefValue, [])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Creates a null object of a specific type on the target runtime.
-     *
-     * @returns {InvocationContext} An InvocationContext instance with the command to create a null object.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/null-handling/create-null-object)
-     * @method
-     */
-    createNull() {
-        let localCommand = new Command(this.#runtimeName, CommandType.CreateNull, [])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Creates a null object of a specific type on the target runtime.
-     * @param {string} methodName - The name of the method to invoke.
-     * @param {...any} args - Method arguments.
-     * @returns {InvocationContext} An InvocationContext instance with the command to create a null object.
-     * TODO: connect documentation page url
-     * @see [Javonet Guides](https://www.javonet.com/guides/)
-     * @method
-     */
-    getStaticMethodAsDelegate(methodName, ...args) {
-        const localCommand = new Command(this.#runtimeName, CommandType.GetStaticMethodAsDelegate, [
-            methodName,
-            ...args,
-        ])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Creates a null object of a specific type on the target runtime.
-     * @param {string} methodName - The name of the method to invoke.
-     * @param {...any} args - Method arguments.
-     * @returns {InvocationContext} An InvocationContext instance with the command to create a null object.
-     * TODO: connect documentation page url
-     * @see [Javonet Guides](https://www.javonet.com/guides/)
-     * @method
-     */
-    getInstanceMethodAsDelegate(methodName, ...args) {
-        const localCommand = new Command(this.#runtimeName, CommandType.GetInstanceMethodAsDelegate, [
-            methodName,
-            ...args,
-        ])
-        return this.#createInstanceContext(localCommand)
-    }
-
-    /**
-     * Retrieves an array from the target runtime.
-     * @returns {InvocationContext} A new InvocationContext instance that wraps the command to retrieve the array.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/arrays-and-collections/retrieve-array)
-     * @method
-     */
-    retrieveArray() {
-        let localCommand = new Command(this.#runtimeName, CommandType.RetrieveArray, [])
-        let localInvCtx = new InvocationContext(
-            this.#runtimeName,
-            this.#connectionData,
-            this.#buildCommand(localCommand)
-        )
-        localInvCtx.execute()
-        return localInvCtx.#responseCommand.payload
-    }
-
-    /**
-     * Returns the primitive value from the target runtime. This could be any primitive type in JavaScript,
-     * such as int, boolean, byte, char, long, double, float, etc.
-     * @returns {Command} The value of the current command.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/foundations/execute-method)
-     * @method
-     */
-
-    getValue() {
-        this.#resultValue = this.#currentCommand.payload[0]
-        return this.#resultValue
-    }
-
-    #buildCommand = function (command) {
-        for (let i = 0; i < command.payload.length; i++) {
-            command.payload[i] = this.#encapsulatePayloadItem(command.payload[i])
-        }
-        return command.prependArgToPayload(this.#currentCommand)
-    }
-
-    #encapsulatePayloadItem = function (payloadItem) {
-        // eslint-disable-next-line valid-typeof
-        if (typeof payloadItem === 'Command' || payloadItem instanceof Command) {
-            for (let i = 0; i < payloadItem.payload.length; i++) {
-                payloadItem.payload[i] = this.#encapsulatePayloadItem(payloadItem.payload[i])
-            }
-            return payloadItem
-            // eslint-disable-next-line valid-typeof
-        } else if (typeof payloadItem === 'InvocationContext' || payloadItem instanceof InvocationContext) {
-            return payloadItem.get_current_command()
-        } else if (payloadItem instanceof Array) {
-            const copiedArray = payloadItem.map((item) => this.#encapsulatePayloadItem(item))
-            return new Command(this.runtimeName, CommandType.Array, copiedArray)
-        } else if (typeof payloadItem === 'function') {
-            let newArray = new Array(payloadItem.length + 1)
-            for (let i = 0; i < newArray.length; i++) {
-                newArray[i] = typeof Object
-            }
-            const args = [DelegatesCache.addDelegate(payloadItem), RuntimeName.Nodejs].push(...newArray)
-            return new Command(this.#runtimeName, CommandType.PassDelegate, args)
-        } else {
-            return new Command(this.runtimeName, CommandType.Value, [payloadItem])
-        }
-    }
-}
-
-class InvocationWsContext extends InvocationContext {
-    #runtimeName
-    #connectionData
-    #currentCommand
-    #responseCommand
-    #interpreter
-    // eslint-disable-next-line no-unused-private-class-members
-    #isExecuted
-    // eslint-disable-next-line no-unused-private-class-members
-    #resultValue
-
-    constructor(runtimeName, connectionData, command, isExecuted = false) {
-        super(runtimeName, connectionData, command, isExecuted)
-
-        this.#runtimeName = runtimeName
-        this.#connectionData = connectionData
-        this.#currentCommand = command
-        this.#responseCommand = null
-        this.#isExecuted = isExecuted
-        this.#interpreter = null
-        this.#resultValue = null
-    }
-
-    /**
-     * Executes the current command.
-     * Because invocation context is building the intent of executing particular expression on target environment, we call the initial state of invocation context as non-materialized.
-     * The non-materialized context wraps either single command or chain of recursively nested commands.
-     * Commands are becoming nested through each invocation of methods on Invocation Context.
-     * Each invocation triggers the creation of new Invocation Context instance wrapping the current command with new parent command valid for invoked method.
-     * Developer can decide on any moment of the materialization for the context taking full control of the chunks of the expression being transferred and processed on target runtime.
-     * @returns {InvocationContext} the InvocationContext after executing the command.
-     * @see [Javonet Guides](https://www.javonet.com/guides/v2/javascript/foundations/execute-method)
-     * @method
-     */
-    async execute() {
-        this.#interpreter = new Interpreter()
-        this.#responseCommand = await this.#interpreter.executeAsync(
-            this.#currentCommand,
-            this.#connectionData
-        )
-
-        if (this.#responseCommand === undefined) {
-            throw new Error('responseCommand is undefined in Invocation Context execute method')
-        }
-
-        if (this.#responseCommand.commandType === CommandType.Exception) {
-            throw ExceptionThrower.throwException(this.#responseCommand)
-        }
-
-        if (this.#responseCommand.commandType === CommandType.CreateClassInstance) {
-            this.#currentCommand = this.#responseCommand
-            this.#isExecuted = true
-            return this
-        }
-
-        return new InvocationWsContext(this.#runtimeName, this.#connectionData, this.#responseCommand, true)
-    }
-}
-
-module.exports = { InvocationContext, InvocationWsContext }