javonet-nodejs-sdk 2.5.9 → 2.5.10

package/Binaries/Nodejs/lib/core/handler/InvokeDelegateHandler.js

@@ -0,0 +1,36 @@
+const { DelegatesCache } = require('../../..')
+const AbstractHandler = require('./AbstractHandler')
+
+/**
+ * Handles invoking a delegate by GUID.
+ */
+class InvokeDelegateHandler extends AbstractHandler {
+    constructor() {
+        super()
+        /** @type {number} */
+        this.requiredParametersCount = 1
+    }
+
+    /**
+     * Processes a command to invoke a delegate.
+     * @param {Command} command - The command containing payload data.
+     * @returns {*} The result of the delegate invocation.
+     * @throws {Error} If the parameters mismatch or the delegate cannot be found.
+     */
+    process(command) {
+        const payload = command.payload
+        if (payload.length < this.requiredParametersCount) {
+            throw new Error(`${this.constructor.name} parameters mismatch`)
+        }
+
+        const guid = payload[0]
+        const delegate = DelegatesCache.getDelegate(guid)
+        if (!delegate) {
+            throw new Error('Delegate not found in cache')
+        }
+
+        return delegate
+    }
+}
+
+module.exports = new InvokeDelegateHandler()

package/Binaries/Nodejs/lib/core/handler/PassDelegateHandler.js

@@ -0,0 +1,157 @@
+// eslint-disable-next-line no-unused-vars
+const { Interpreter, Command, CommandType, InMemoryConnectionData, DelegatesCache } = require('../../..')
+const AbstractHandler = require('./AbstractHandler')
+
+/**
+ * PassDelegateHandler class responsible for processing a command to create a delegate.
+ */
+class PassDelegateHandler extends AbstractHandler {
+    constructor() {
+        super()
+        /**
+         * Minimum required parameters count for the command.
+         * @type {number}
+         */
+        this.requiredParametersCount = 1
+        this.interpreter = new Interpreter()
+    }
+
+    /**
+     * Processes the given command to create and compile a delegate.
+     * @param {Command} command - The command to process.
+     * @returns {Function} The compiled delegate function.
+     */
+    process(command) {
+        this.validateCommand(command)
+
+        const delegateGuid = command.payload[0]
+        const delegate = DelegatesCache.getDelegate(delegateGuid)
+
+        return delegate
+    }
+
+    /**
+     * Validates the command to ensure it has enough parameters.
+     * @param {Command} command - The command to validate.
+     */
+    validateCommand(command) {
+        if (command.payload.length < this.requiredParametersCount) {
+            throw new Error('PassDelegateHandler parameters mismatch')
+        }
+    }
+
+    /**
+     * Retrieves the arguments from the command payload.
+     * @param {Command} command - The command containing the payload.
+     * @returns {Array} The extracted arguments.
+     */
+    getArguments(command) {
+        return command.payload.length > 2 ? command.payload.slice(2) : []
+    }
+
+    /**
+     * Extracts argument types from the arguments array.
+     * @param {Array} args - The arguments array.
+     * @returns {Array} The argument types.
+     */
+    getArgumentTypes(args) {
+        return args.slice(0, -1).map((arg) => arg.constructor)
+    }
+
+    /**
+     * Retrieves the return type from the arguments array.
+     * @param {Array} args - The arguments array.
+     * @returns {Function} The return type.
+     */
+    getReturnType(args) {
+        return args[args.length - 1].constructor
+    }
+
+    /**
+     * Creates parameter expressions from argument types.
+     * @param {Array} argsTypes - The argument types.
+     * @returns {Array} The parameter expressions.
+     */
+    createParameters(argsTypes) {
+        return argsTypes.map((type, index) => ({ name: `arg${index}`, type }))
+    }
+
+    /**
+     * Creates an array of arguments for the delegate.
+     * @param {string} delegateGuid - The delegate identifier.
+     * @param {Array} parameters - The parameter expressions.
+     * @returns {Array} The arguments array.
+     */
+    createArgsArray(delegateGuid, parameters) {
+        return [delegateGuid, ...parameters.map((param) => param.name)]
+    }
+
+    /**
+     * Creates a command expression.
+     * @param {string} callingRuntimeName - The runtime name.
+     * @param {Array} payload - The arguments array.
+     * @returns {Object} The command object.
+     */
+    createCommand(callingRuntimeName, payload) {
+        return {
+            runtimeName: callingRuntimeName,
+            type: CommandType.InvokeDelegate,
+            payload,
+        }
+    }
+
+    /**
+     * Creates a method call to execute the command.
+     * @param {Command} command - The command object.
+     * @returns {Object} The response object.
+     */
+    createExecuteCall(command) {
+        return this.interpreter.execute(command, new InMemoryConnectionData())
+    }
+
+    /**
+     * Retrieves the response payload from the execution call.
+     * @param {Object} executeCall - The execution call.
+     * @returns {Array} The response payload.
+     */
+    getResponse(executeCall) {
+        return executeCall.payload
+    }
+
+    /**
+     * Converts the first element of the response to the return type.
+     * @param {Array} response - The response payload.
+     * @param {Function} returnType - The return type.
+     * @returns {*} The converted first element.
+     */
+    convertFirstElement(response, returnType) {
+        return returnType(response[0])
+    }
+
+    /**
+     * Creates a block of expressions for the delegate.
+     * @param {Function} returnType - The return type.
+     * @param {*} convertedFirstElement - The converted first element.
+     * @returns {Object} The block expression.
+     */
+    createBlock(returnType, convertedFirstElement) {
+        return { returnType, body: convertedFirstElement }
+    }
+
+    /**
+     * Creates a delegate type.
+     * @param {Array} parameters - The parameter expressions.
+     * @param {Function} returnType - The return type.
+     * @returns {Function} The delegate type.
+     */
+    createDelegateType(parameters, returnType) {
+        return (...args) => {
+            if (args.length !== parameters.length) {
+                throw new Error('Invalid argument count.')
+            }
+            return returnType
+        }
+    }
+}
+
+module.exports = new PassDelegateHandler()

package/Binaries/Nodejs/lib/sdk/InvocationContext.js

@@ -1,8 +1,10 @@
+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.
@@ -338,6 +340,40 @@ class InvocationContext {
         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.
@@ -390,6 +426,13 @@ class InvocationContext {
                 payloadItem[i] = this.#encapsulatePayloadItem(payloadItem[i])
             }
             return new Command(this.runtimeName, CommandType.Array, payloadItem)
+        } 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])
         }

package/Binaries/Nodejs/lib/sdk/RuntimeContext.js

@@ -5,6 +5,8 @@ const CommandType = require('../utils/CommandType')
 const { InvocationContext, InvocationWsContext } = require('./InvocationContext')
 const ConnectionType = require('../utils/ConnectionType')
 const ExceptionThrower = require('../utils/exception/ExceptionThrower')
+const DelegatesCache = require('../core/delegatesCache/DelegatesCache')
+const RuntimeName = require('../utils/RuntimeName')
 
 /**
  * Represents a single context which allows interaction with a selected technology.
@@ -251,6 +253,13 @@ class RuntimeContext {
                 payloadItem[i] = this.#encapsulatePayloadItem(payloadItem[i])
             }
             return new Command(this.runtimeName, CommandType.Array, payloadItem)
+        } else if (typeof payloadItem === 'function') {
+            let newArray = new Array(payloadItem.length + 1)
+            for (let i = 0; i < newArray.length; i++) {
+                newArray[i] = '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])
         }

package/Binaries/Nodejs/lib/utils/CommandType.js

@@ -37,7 +37,12 @@ const CommandType = /** @type {const} */ ({
     EnableNamespace: 34,
     EnableType: 35,
     CreateNull: 36,
-    InvokeStandaloneMethod: 37,
+    GetStaticMethodAsDelegate: 37,
+    GetInstanceMethodAsDelegate: 38,
+    PassDelegate: 39,
+    InvokeDelegate: 40,
+    ConvertType: 41,
+    InvokeStandaloneMethod: 42,
 })
 
 module.exports = CommandType

package/Binaries/Nodejs/lib/utils/TypesConverter.js

@@ -0,0 +1,91 @@
+/**
+ * ConvertTypeHandler class handles the conversion of JType to Type.
+ */
+class ConvertTypeHandler {
+    constructor() {
+        /**
+         * Minimum required parameters count for the command.
+         * @type {number}
+         */
+        this.requiredParametersCount = 1
+    }
+
+    /**
+     * Processes the given command to convert JType to Type.
+     * @param {Object} command - The command to process.
+     * @returns {any} The converted type.
+     */
+    process(command) {
+        this.validateCommand(command)
+        return TypesConverter.convertJTypeToType(command.payload[0])
+    }
+
+    /**
+     * Validates the command to ensure it has enough parameters.
+     * @param {Object} command - The command to validate.
+     */
+    validateCommand(command) {
+        if (command.payload.length < this.requiredParametersCount) {
+            throw new Error('ConvertTypeHandler parameters mismatch')
+        }
+    }
+}
+
+/**
+ * TypesConverter class provides utilities for converting between types.
+ */
+class TypesConverter {
+    /**
+     * Converts a JavaScript type to a JType equivalent.
+     * @param {Function} type - The JavaScript type.
+     * @returns {number} The corresponding JType.
+     */
+    static convertTypeToJType(type) {
+        switch (type) {
+            case Boolean:
+                return JType.Boolean
+            case Number:
+                return JType.Float // Assuming Number maps to Float
+            case String:
+                return JType.String
+            case Object:
+                return JType.Null // Assuming Object maps to Null
+            default:
+                return JType.Null
+        }
+    }
+
+    /**
+     * Converts a JType to a JavaScript type equivalent.
+     * @param {number} type - The JType to convert.
+     * @returns {Function} The corresponding JavaScript type.
+     */
+    static convertJTypeToType(type) {
+        switch (type) {
+            case JType.Boolean:
+                return Boolean
+            case JType.Float:
+                return Number
+            case JType.String:
+                return String
+            case JType.Null:
+                return null
+            default:
+                return null
+        }
+    }
+}
+
+/**
+ * Enum for JType mappings.
+ * @readonly
+ * @enum {number}
+ */
+const JType = {
+    Boolean: 1,
+    Float: 2,
+    String: 3,
+    Null: 4,
+}
+
+module.exports = { ConvertTypeHandler, TypesConverter, JType }

package/Binaries/Nodejs/lib/utils/guid/generateGuid.js

@@ -0,0 +1,9 @@
+function generateGUID() {
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+        const r = (Math.random() * 16) | 0
+        const v = c === 'x' ? r : (r & 0x3) | 0x8
+        return v.toString(16)
+    })
+}
+
+module.exports = generateGUID

package/Binaries/Perl/Linux/X64/deps/bin/yamlpp-events

@@ -0,0 +1,62 @@
+#!/usr/bin/perl
+use strict;
+use warnings;
+
+use Encode;
+use YAML::PP::Parser;
+use YAML::PP::Common;
+use Getopt::Long;
+Getopt::Long::Configure('bundling');
+GetOptions(
+    'help|h' => \my $help,
+    'module|M=s' => \my $module,
+) or usage(1);
+
+usage(0) if $help;
+
+$module ||= 'YAML::PP';
+if ($module eq 'YAML::PP') {
+    $module = 'YAML::PP::Parser';
+}
+elsif ($module eq 'YAML::PP::LibYAML') {
+    require YAML::PP::LibYAML::Parser;
+    $module = 'YAML::PP::LibYAML::Parser';
+}
+elsif ($module eq 'YAML::PP::Ref') {
+    require YAML::PP::Ref;
+    $module = 'YAML::PP::Ref::Parser';
+}
+
+my ($file) = @ARGV;
+
+my $parser = $module->new(
+    receiver => sub {
+      my ($self, undef, $event) = @_;
+      print encode_utf8(YAML::PP::Common::event_to_test_suite($event, { flow => 1 })), "\n";
+    },
+    $file ? (reader => YAML::PP::Reader::File->new) : (),
+);
+if ($file) {
+    $parser->parse_file($file);
+}
+else {
+    my $yaml;
+    $yaml = do { local $/; <STDIN> };
+    $yaml = decode_utf8($yaml);
+    $parser->parse_string($yaml);
+}
+
+sub usage {
+    my ($rc) = @_;
+    print <<"EOM";
+Usage:
+
+    $0 [options] < file
+    $0 [options] file
+
+Options:
+    --module -M  Module to use for parsing. YAML::PP (default),
+                 YAML::PP::LibYAML or YAML::PP::Ref
+EOM
+    exit $rc;
+}

package/Binaries/Perl/Linux/X64/deps/bin/yamlpp-highlight

@@ -0,0 +1,54 @@
+#!/usr/bin/perl
+use strict;
+use warnings;
+
+use YAML::PP::Highlight;
+use Encode;
+use Getopt::Long;
+
+GetOptions(
+    'help|h' => \my $help,
+    'expand-tabs|et!' => \my $expand_tabs,
+) or usage(1);
+
+$expand_tabs = 1 unless defined $expand_tabs;
+
+usage(0) if $help;
+
+my ($file) = @ARGV;
+my $yaml;
+
+unless ($file) {
+    $yaml = do { local $/; <STDIN> };
+    $yaml = decode_utf8($yaml);
+}
+
+my $error;
+my $tokens;
+if (defined $file) {
+    ($error, $tokens) = YAML::PP::Parser->yaml_to_tokens( file => $file );
+}
+else {
+    ($error, $tokens) = YAML::PP::Parser->yaml_to_tokens( string => $yaml );
+}
+my $highlighted = YAML::PP::Highlight->ansicolored($tokens, expand_tabs => $expand_tabs);
+print encode_utf8 $highlighted;
+if ($error) {
+    die $error;
+}
+
+sub usage {
+    my ($rc) = @_;
+    print <<"EOM";
+Usage:
+
+    $0 [options] < file
+    $0 [options] file
+
+Options:
+    --expand-tabs    --et         Expand tabs to 8 spaces (default true)
+    --no-expand-tabs --no-et      Don't expand tabs
+EOM
+    exit $rc;
+}
+

package/Binaries/Perl/Linux/X64/deps/bin/yamlpp-load

@@ -0,0 +1,144 @@
+#!/usr/bin/perl
+use strict;
+use warnings;
+
+use Data::Dumper;
+use YAML::PP;
+use YAML::PP::Common qw/ PRESERVE_ORDER /;
+use Encode;
+use Getopt::Long;
+Getopt::Long::Configure('bundling');
+
+GetOptions(
+    'help|h' => \my $help,
+    'boolean=s' => \my $boolean,
+    'cyclic' => \my $cyclic,
+    'merge' => \my $merge,
+    'perl' => \my $perl,
+    'module|M=s' => \my $module,
+    'yaml-version=s' => \my $yaml_version,
+) or usage(1);
+
+usage(0) if $help;
+
+$module ||= 'YAML::PP';
+$boolean ||= 'JSON::PP';
+$yaml_version ||= 1.2;
+my @yaml_versions = split m/,/, $yaml_version;
+my @schema = ('+');
+if ($merge) {
+    push @schema, 'Merge';
+}
+if ($perl) {
+    push @schema, 'Perl';
+}
+
+my ($file) = @ARGV;
+my $yaml;
+
+my $decode = 1;
+if ($module eq 'YAML::XS') {
+    $decode = 0;
+}
+if ($file) {
+    open my $fh, '<', $file or die "Can not open '$file'";
+    $yaml = do { local $/; <$fh> };
+    close $fh;
+}
+else {
+    $yaml = do { local $/; <STDIN> };
+}
+$yaml = decode_utf8($yaml) if $decode;
+
+my %codes = (
+    'YAML::PP' => \&yamlpp,
+    'YAML::PP::LibYAML' => \&yamlpplibyaml,
+    'YAML::PP::Ref' => \&yamlppref,
+    'YAML::XS' => \&yamlxs,
+    'YAML::Tiny' => \&yamltiny,
+    'YAML::Syck' => \&yamlsyck,
+    'YAML' => \&yaml,
+);
+
+my $code = $codes{ $module } or die "Module '$module' not supported";
+
+my @docs = $code->($yaml);
+
+sub _yamlpp {
+    my ($class, $yaml) = @_;
+    my $ypp = $class->new(
+        schema => \@schema,
+        boolean => $boolean,
+        cyclic_refs => $cyclic ? 'allow' : 'fatal',
+        preserve => PRESERVE_ORDER,
+        yaml_version => \@yaml_versions,
+    );
+    my @docs = $ypp->load_string($yaml);
+    return @docs;
+}
+sub yamlpp {
+    _yamlpp('YAML::PP' => $_[0]);
+}
+sub yamlpplibyaml {
+    eval { require YAML::PP::LibYAML };
+    _yamlpp('YAML::PP::LibYAML' => $_[0]);
+}
+sub yamlppref {
+    eval { require YAML::PP::Ref };
+    _yamlpp('YAML::PP::Ref' => $_[0]);
+}
+
+sub yamlxs {
+    eval { require YAML::XS };
+    my ($yaml) = @_;
+    no warnings 'once';
+    local $YAML::XS::LoadBlessed = $perl;
+    return YAML::XS::Load($yaml);
+}
+sub yamlsyck {
+    eval { require YAML::Syck };
+    my ($yaml) = @_;
+    no warnings 'once';
+    local $YAML::Syck::LoadBlessed = $perl;
+    local $YAML::Syck::ImplicitTyping = 1;
+    local $YAML::Syck::ImplicitUnicode = 1;
+    return YAML::Syck::Load($yaml);
+}
+sub yaml {
+    eval { require YAML };
+    my ($yaml) = @_;
+    no warnings 'once';
+    local $YAML::LoadBlessed = $perl;
+    return YAML::Load($yaml);
+}
+sub yamltiny {
+    eval { require YAML::Tiny };
+    my ($yaml) = @_;
+    return YAML::Tiny::Load($yaml);
+}
+
+local $Data::Dumper::Useqq = 1;
+local $Data::Dumper::Sortkeys = 1;
+print Data::Dumper->Dump([$docs[ $_ ]], ["doc$_"]) for 0 ..$#docs;
+
+
+sub usage {
+    my ($rc) = @_;
+    print <<"EOM";
+Usage:
+
+    $0 [options] < file
+    $0 [options] file
+
+Options:
+    --boolean=            'perl', 'JSON::PP', 'boolean'
+    --cyclic              Allow cyclic references
+    --merge               Enable loading merge keys '<<'
+    --perl                Enable loading perl types and objects (use only
+                          on trusted input!)
+    --module -M           YAML::PP (default), YAML, YAML::PP::LibYAML,
+                          YAML::Syck, YAML::Tiny, YAML::XS, YAML::PP::Ref
+    --yaml-version=       '1.2' (default), '1.1', '1.2,1.1', '1.1,1.2'
+EOM
+    exit $rc;
+}