infinispan 0.10.0 → 0.11.0

package/.eslintrc

@@ -0,0 +1,25 @@
+{
+  "root":true,
+  "env": {
+    "es6": true,
+    "node": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 2022,
+    "sourceType": "module"
+  },
+  "rules": {
+    "standard/no-callback-literal": "off",
+    "arrow-spacing": "error",
+    "arrow-parens": ["error", "as-needed"],
+    "arrow-body-style": ["error", "as-needed"],
+    "prefer-template": "error",
+    "no-unused-vars": ["warn", {
+      "argsIgnorePattern": "^_$|^e$|^reject$|^resolve$"
+    }],
+    "valid-jsdoc": "error",
+    "require-jsdoc": "warn",
+    "semi": ["error", "always"],
+    "quotes": ["error", "single", { "allowTemplateLiterals": true }]
+  }
+}

package/Jenkinsfile-release

@@ -24,7 +24,7 @@ pipeline {
 
         stage('Install release package') {
             steps {
-                nodejs(nodeJSInstallationName: 'Node 14') {
+                nodejs(nodeJSInstallationName: 'Node 18') {
                     sh 'rm -drf node_modules/'
                     sh 'npm config ls'
                     sh 'npm install'
@@ -35,10 +35,12 @@ pipeline {
 
         stage('Release') {
             steps {
-                nodejs(nodeJSInstallationName: 'Node 14') {
+                nodejs(nodeJSInstallationName: 'Node 18') {
                     withCredentials([string(credentialsId: 'npmauthtoken', variable: 'NPM_AUTH_TOKEN')]) {
                         sh './set-npm-auth-token.sh'
                     }
+                    sh "git status"
+                    sh "git diff"
                     sh "npm-release ${version}"
                 }
             }
@@ -46,7 +48,7 @@ pipeline {
 
         stage('Generate JS API docs and upload') {
             steps {
-                nodejs(nodeJSInstallationName: 'Node 14') {
+                nodejs(nodeJSInstallationName: 'Node 18') {
                     sh './node_modules/.bin/jsdoc lib/*.js'
                     sh 'mv out apidocs'
                     sh 'mkdir 1.0'

package/documentation/asciidoc/topics/attributes/community-attributes.adoc

@@ -6,3 +6,4 @@
 :node_docs: https://docs.jboss.org/infinispan/hotrod-clients/javascript/1.0/apidocs/
 :server_docs: https://infinispan.org/docs/stable/titles/server/server.html
 :code_tutorials: https://github.com/infinispan/infinispan-simple-tutorials/
+:query_docs: https://infinispan.org/docs/stable/titles/query/query.html

package/documentation/asciidoc/topics/code_examples/queries.js

@@ -0,0 +1,92 @@
+const infinispan = require('infinispan');
+const protobuf = require('protobufjs');
+// This example uses async/await paradigma
+(async function () {
+  // User data protobuf definition
+  const cacheValueProtoDef = `package awesomepackage;
+  /**
+   * @TypeId(1000044)
+   */
+  message AwesomeUser {
+      required string name = 1;
+      required int64 age = 2;
+      required bool isVerified =3;
+  }`
+  try {
+    // Creating clients for two caches:
+    // - ___protobuf_metadata for registering .proto file
+    // - queryCache for user data
+    const connectProp = { port: 11222, host: '127.0.0.1' };
+    const commonOpts = {
+      version: '3.0',
+      authentication: {
+        enabled: true,
+        saslMechanism: 'DIGEST-MD5',
+        userName: 'admin',
+        password: 'pass'
+      }
+    };
+    const protoMetaClientOps = {
+      cacheName: '___protobuf_metadata',
+      dataFormat: { keyType: "text/plain", valueType: "text/plain" }
+    }
+    const clientOps = {
+      dataFormat: { keyType: "text/plain", valueType: "application/x-protostream" },
+      cacheName: 'queryCache'
+    }
+    var protoMetaClient = await infinispan.client(connectProp, Object.assign(commonOpts, protoMetaClientOps));
+    var client = await infinispan.client(connectProp, Object.assign(commonOpts, clientOps));
+
+    // Registering protobuf definition on server
+    await protoMetaClient.put("awesomepackage/AwesomeUser.proto", cacheValueProtoDef);
+
+    // Registering protobuf definition on protobufjs
+    const root = protobuf.parse(cacheValueProtoDef).root;
+    const AwesomeUser = root.lookupType(".awesomepackage.AwesomeUser");
+    client.registerProtostreamRoot(root);
+    client.registerProtostreamType(".awesomepackage.AwesomeUser", 1000044);
+
+    // Cleanup and populating the cache
+    await client.clear();
+    for (let i = 0; i < 10; i++) {
+      const payload = { name: "AwesomeName" + i, age: i, isVerified: (Math.random() < 0.5) };
+      const message = AwesomeUser.create(payload);
+      console.log("Creating entry:", message);
+      await client.put(i.toString(), message)
+    }
+    // Run the query
+    const queryStr = `select u.name,u.age from awesomepackage.AwesomeUser u where u.age<20 order by u.name asc`;
+    console.log("Running query:", queryStr);
+    const query = await client.query({ queryString: queryStr });
+    console.log("Query result:");
+    console.log(query);
+  } catch (err) {
+    handleError(err);
+  } finally {
+    if (client) {
+      await client.disconnect();
+    }
+    if (protoMetaClient) {
+      await protoMetaClient.disconnect();
+    }
+  }
+})();
+
+function handleError(err) {
+  if (err.message.includes("'queryCache' not found")) {
+    console.log('*** ERROR ***');
+    console.log(`*** This example needs a cache 'queryCache' with the following config:
+    {
+      "local-cache": {
+        "statistics": true,
+        "encoding": {
+        "key": {
+          "media-type": "text/plain"
+        },
+        "value": {
+          "media-type": "application/x-protostream"
+}}}}`)
+  } else {
+    console.log(err);
+  }
+}

package/documentation/asciidoc/topics/proc_configuring_connections.adoc

@@ -2,7 +2,7 @@
 = Configuring {brandname} connections
 Configure {hr_js} clients to connect to {brandname} Server.
 
-If add multiple server addresses to the configuration, the {hr_js} client loops through them until it finds a node to which it can connect.
+If you add multiple server addresses to the configuration, the {hr_js} client loops through them until it finds a node to which it can connect.
 
 However, you only need to add one {brandname} Server address for the client to receive the entire cluster topology.
 If the {hr_js} client connects to a single server instance that is a member of a cluster, the client gets the address information for all nodes.

package/documentation/asciidoc/topics/ref_client_usage.adoc

@@ -114,3 +114,15 @@ Use the `getWithMetadata` and `size` methods expire cache entries.
 ----
 include::code_examples/ephemeral-data.js[]
 ----
+
+== Working with queries
+
+Use the `query` method to perform queries on your caches.
+You must configure {hr_js} client to have `application/x-protostream` data format for values in your caches.
+
+[source,javascript,options="nowrap",subs=attributes+]
+----
+include::code_examples/queries.js[]
+----
+
+See link:{query_docs}[Querying {brandname} caches] for more information.

package/lib/infinispan.js

@@ -134,7 +134,7 @@
         /**
          * Returns the next entry being iterated over.
          *
-         * @returns {module:promise.Promise.<IteratorNext>}
+         * @returns {Promise.<IteratorNext>}
          * It returns a Promise which will be completed with an instance that
          * provides the next element.
          * @memberof Iterator#
@@ -169,7 +169,7 @@
         /**
          * Close the iteration.
          *
-         * @returns {module:promise.Promise}
+         * @returns {Promise}
          * A Promise which will be completed once the iteration has been closed.
          * @memberof Iterator#
          * @since 0.3
@@ -201,7 +201,7 @@
       /**
        * Disconnect client from backend server(s).
        *
-       * @returns {module:promise.Promise}
+       * @returns {Promise<void>}
        * A promise that will be completed once client has
        * completed disconnection from server(s).
        * @memberof Client#
@@ -214,7 +214,7 @@
        * Get the value associated with the given key parameter.
        *
        * @param k {(String|Object)} Key to retrieve.
-       * @returns {module:promise.Promise.<?String>}
+       * @returns {Promise.<?String>}
        * A promise that will be completed with the value associated with
        * the key, or undefined if the value is not present.
        * @memberof Client#
@@ -230,7 +230,7 @@
        * Query the server with the given queryString.
        *
        * @param q {(Object)} query to retrieve.
-       * @returns {module:promise.Promise.<?Object[]>}
+       * @returns {Promise.<?Object[]>}
        * A promise that will be completed with the array of values associated with
        * the query, or empty array if the no values matches the query.
        * @memberof Client#
@@ -247,7 +247,7 @@
        * Check whether the given key is present.
        *
        * @param k {(String|Object)} Key to check for presence.
-       * @returns {module:promise.Promise.<boolean>}
+       * @returns {Promise.<boolean>}
        * A promise that will be completed with true if there is a value
        * associated with the key, or false otherwise.
        * @memberof Client#
@@ -274,7 +274,7 @@
        * Get the value and metadata associated with the given key parameter.
        *
        * @param k {(String|Object)} Key to retrieve.
-       * @returns {module:promise.Promise.<?MetadataValue>}
+       * @returns {Promise.<?MetadataValue>}
        * A promise that will be completed with the value and metadata
        * associated with the key, or undefined if the value is not present.
        * @memberof Client#
@@ -316,8 +316,8 @@
        *
        * @param k {(String|Object)} Key with which the specified value is to be associated.
        * @param v {(String|Object)} Value to be associated with the specified key.
-       * @param opts {?StoreOptions} Optional store options.
-       * @returns {module:promise.Promise.<?(String|Object)>}
+       * @param opts {StoreOptions=} Optional store options.
+       * @returns {Promise.<?(String|Object)>}
        * A promise that will be completed with undefined unless 'previous'
        * option has been enabled and a previous value exists, in which case it
        * would return the previous value.
@@ -345,8 +345,8 @@
        * Removes the mapping for a key if it is present.
        *
        * @param k {(String|Object)} Key whose mapping is to be removed.
-       * @param opts {?RemoveOptions} Optional remove options.
-       * @returns {module:promise.Promise.<(Boolean|String|Object)>}
+       * @param opts {RemoveOptions=} Optional remove options.
+       * @returns {Promise.<(Boolean|String|Object)>}
        * A promise that will be completed with true if the mapping was removed,
        * or false if the key did not exist.
        * If the 'previous' option is enabled, it returns the value
@@ -367,8 +367,8 @@
        *
        * @param k {(String|Object)} Key with which the specified value is to be associated.
        * @param v {(String|Object)} Value to be associated with the specified key.
-       * @param opts {?StoreOptions} Optional store options.
-       * @returns {module:promise.Promise.<(Boolean|String|Object)>}
+       * @param opts {StoreOptions=} Optional store options.
+       * @returns {Promise.<(Boolean|String|Object)>}
        * A promise that will be completed with true if the mapping was stored,
        * or false if the key is already present.
        * If the 'previous' option is enabled, it returns the existing value
@@ -389,8 +389,8 @@
        *
        * @param k {(String|Object)} Key with which the specified value is associated.
        * @param v {(String|Object)} Value expected to be associated with the specified key.
-       * @param opts {?StoreOptions} Optional store options.
-       * @returns {module:promise.Promise.<(Boolean|String|Object)>}
+       * @param opts {StoreOptions=} Optional store options.
+       * @returns {Promise.<(Boolean|String|Object)>}
        * A promise that will be completed with true if the mapping was replaced,
        * or false if the key does not exist.
        * If the 'previous' option is enabled, it returns the value that was
@@ -414,8 +414,8 @@
        * @param version {Buffer} binary buffer version that should match the
        * one in the server for the operation to succeed. Version information
        * can be retrieved with getWithMetadata method.
-       * @param opts {?StoreOptions} Optional store options.
-       * @returns {module:promise.Promise.<(Boolean|String|Object)>}
+       * @param opts {StoreOptions=} Optional store options.
+       * @returns {Promise.<(Boolean|String|Object)>}
        * A promise that will be completed with true if the version matches
        * and the mapping was replaced, otherwise it returns false if not
        * replaced because key does not exist or version sent does not match
@@ -442,8 +442,8 @@
        * @param version {Buffer} binary buffer version that should match the
        * one in the server for the operation to succeed. Version information
        * can be retrieved with getWithMetadata method.
-       * @param opts {?RemoveOptions} Optional remove options.
-       * @returns {module:promise.Promise.<(Boolean|String|Object)>}
+       * @param opts {RemoveOptions=} Optional remove options.
+       * @returns {Promise.<(Boolean|String|Object)>}
        * A promise that will be completed with true if the version matches
        * and the mapping was removed, otherwise it returns false if not
        * removed because key does not exist or version sent does not match
@@ -474,7 +474,7 @@
        * Retrieves all of the entries for the provided keys.
        *
        * @param keys {(String[]|Object[])} Keys to find values for.
-       * @returns {module:promise.Promise.<Entry[]>}
+       * @returns {Promise.<Entry[]>}
        * A promise that will be completed with an array of entries for all
        * keys found. If a key does not exist, there won't be an entry for that
        * key in the returned array.
@@ -502,9 +502,9 @@
        * Stores all of the mappings from the specified entry array.
        *
        * @param pairs {Entry[]} key/value pair mappings to be stored
-       * @param opts {MultiStoreOptions}
+       * @param opts {MultiStoreOptions=}
        * Optional storage options to apply to all entries.
-       * @returns {module:promise.Promise}
+       * @returns {Promise}
        * A promise that will be completed when all entries have been stored.
        * @memberof Client#
        * @since 0.3
@@ -530,8 +530,8 @@
        *
        * @param batchSize {Number}
        * The number of entries transferred from the server at a time.
-       * @param opts {?IteratorOptions} Optional iteration settings.
-       * @return {module:promise.Promise.<Iterator>}
+       * @param opts {IteratorOptions=} Optional iteration settings.
+       * @return {Promise.<Iterator>}
        * A promise that will be completed with an iterator that can be used
        * to retrieve stored elements.
        * @memberof Client#
@@ -548,7 +548,7 @@
       /**
        * Count of entries in the server(s).
        *
-       * @returns {module:promise.Promise.<Number>}
+       * @returns {Promise.<Number>}
        * A promise that will be completed with the number of entries stored.
        * @memberof Client#
        * @since 0.3
@@ -561,7 +561,7 @@
       /**
        * Clear all entries stored in server(s).
        *
-       * @returns {module:promise.Promise}
+       * @returns {Promise}
        * A promise that will be completed when the clear has been completed.
        * @memberof Client#
        * @since 0.3
@@ -574,7 +574,7 @@
       /**
        * Pings the server(s).
        *
-       * @returns {module:promise.Promise}
+       * @returns {Promise}
        * A promise that will be completed when ping response was received.
        * @memberof Client#
        * @since 0.3
@@ -598,7 +598,7 @@
       /**
        * Retrieve various statistics from server(s).
        *
-       * @returns {module:promise.Promise<StatsItem[]>}
+       * @returns {Promise<StatsItem[]>}
        * A promise that will be completed with an array of statistics, where
        * each element will have a single property. This single property will
        * have the statistic name as property name and statistic value as
@@ -632,8 +632,8 @@
        * entry version and listener id.
        * 'remove' and 'expiry' events callback the function with key
        * and listener id.
-       * @param opts {?ListenOptions} Options for adding listener.
-       * @returns {module:promise.Promise<String>}
+       * @param opts {ListenOptions=} Options for adding listener.
+       * @returns {Promise<String>}
        * A promise that will be completed with the identifier of the listener.
        * This identifier can be used to register multiple callbacks with the
        * same listener, or to remove the listener.
@@ -663,7 +663,7 @@
        *
        * @param {String} listenerId
        * Listener identifier to identify listener to remove.
-       * @return {module:promise.Promise}
+       * @return {Promise}
        * A promise that will be completed when the listener has been removed.
        * @memberof Client#
        * @since 0.3
@@ -690,7 +690,7 @@
        *
        * @param {String} scriptName Name of the script to store.
        * @param {String} script Script to store in server.
-       * @return {module:promise.Promise}
+       * @return {Promise}
        * A promise that will be completed when the script has been stored.
        * @memberof Client#
        * @since 0.3
@@ -718,9 +718,9 @@
        * Execute the named script passing in optional parameters.
        *
        * @param {String} scriptName Name of the script to execute.
-       * @param {?ExecParams[]} params
+       * @param {ExecParams[]} [params]
        * Optional array of named parameters to pass to script in server.
-       * @returns {module:promise.Promise<String|String[]>}
+       * @returns {Promise<String|String[]>}
        * A promise that will be completed with either the value returned by the
        * script after execution for local scripts, or an array of values
        * returned by the script when executed in multiple servers for
@@ -810,7 +810,7 @@
        * previously declared via configuration.
        *
        * @param clusterName name of the cluster to which to switch to
-       * @return {module:promise.Promise<Boolean>}
+       * @return {Promise<Boolean>}
        * A promise encapsulating a Boolean that indicates {@code true} if the
        * switch happened, or {@code false} otherwise.
        * @memberof Topology#
@@ -823,7 +823,7 @@
        * Switch remote cache manager to the default cluster,
        * previously declared via configuration.
        *
-       * @return {module:promise.Promise<Boolean>}
+       * @return {Promise<Boolean>}
        * A promise encapsulating a Boolean that indicates {@code true} if the
        * switch happened, or {@code false} otherwise.
        * @memberof Topology#
@@ -864,20 +864,18 @@
    * @param args {(ServerAddress|ServerAddress[])}
    * Optional single or multiple addresses to which to connect. If none
    * provided, the client will connect to localhost:11222 address by default.
-   * @param options {module:infinispan.ClientOptions}
+   * @param [options] {ClientOptions}
    * Optional configuration settings.
-   * @returns A promise that will be completed once the connection
-   * has been established. The promise will be completed with a client
-   * instance on which operations can invoked.
    * @constructs Client
+   * @returns {Promise<ReturnType<Client>>}
    * @since 0.3
    */
   exports.client = function client(args, options) {
     var merged = f.merge(Client.config, options);
     var c = new Client(u.normalizeAddresses(args), merged);
+
     return c.connect();
   };
-
   /**
    * Cluster information.
    *
@@ -894,26 +892,32 @@
    * @static
    * @typedef {Object} ClientOptions
    * @property {?(2.9|2.5|2.2)} [version=2.9] - Version of client/server protocol.
-   * @property {?String} cacheName - Optional cache name.
+   * @property {?String} [cacheName] - Optional cache name.
    * @property {?Number} [maxRetries=3] - Optional number of retries for operation.
+   * @property {?Object} [ssl] - TLS/SSL properties.
    * @property {?boolean} [ssl.enabled=false] - Optional flag to enable SSL support.
    * @property {?String} [ssl.secureProtocol=TLSv1_2_method] - Optional field with secure protocol in use.
-   * @property {?String[]} ssl.trustCerts - Optional paths of trusted SSL certificates.
-   * @property {?String} ssl.clientAuth.key - Optional path to client authentication key.
-   * @property {?String} ssl.clientAuth.passphrase - Optional password for client key.
-   * @property {?String} ssl.clientAuth.cert - Optional client certificate.
-   * @property {?String} ssl.sniHostName - Optional SNI host name.
-   * @property {?String} ssl.cryptoStore.path - Optional crypto store path.
-   * @property {?String} ssl.cryptoStore.passphrase - Optional password for crypto store.
-   * @property {?boolean} authentication.enabled - Enable authentication.
-   * @property {?String} authentication.saslMechanism - Select the SASL mechanism to use. Can be one of PLAIN, DIGEST-MD5, SCRAM-SHA-1, SCRAM-SHA-256, SCRAM-SHA-384, SCRAM-SHA-512, EXTERNAL, OAUTHBEARER
-   * @property {?String} authentication.userName - The authentication username. Required by the PLAIN, DIGEST and SCRAM mechanisms.
-   * @property {?String} authentication.password - The authentication password. Required by the PLAIN, DIGEST and SCRAM mechanisms.
-   * @property {?String} authentication.token - The OAuth token. Required by the OAUTHBEARER mechanism.
-   * @property {?String} authentication.authzid - The SASL authorization ID.
+   * @property {?String[]} [ssl.trustCerts] - Optional paths of trusted SSL certificates.
+   * @property {?String} [ssl.clientAuth.key] - Optional path to client authentication key.
+   * @property {?String} [ssl.clientAuth.passphrase] - Optional password for client key.
+   * @property {?String} [ssl.clientAuth.cert] - Optional client certificate.
+   * @property {?String} [ssl.sniHostName] - Optional SNI host name.
+   * @property {?String} [ssl.cryptoStore.path] - Optional crypto store path.
+   * @property {?String} [ssl.cryptoStore.passphrase] - Optional password for crypto store.
+   * @property {?Object} [authentication]- Authentication properties.
+   * @property {?boolean} [authentication.enabled]- Enable authentication.
+   * @property {?String} [authentication.saslMechanism] - Select the SASL mechanism to use. Can be one of PLAIN, DIGEST-MD5, SCRAM-SHA-1, SCRAM-SHA-256, SCRAM-SHA-384, SCRAM-SHA-512, EXTERNAL, OAUTHBEARER
+   * @property {?String} [authentication.userName] - The authentication username. Required by the PLAIN, DIGEST and SCRAM mechanisms.
+   * @property {?String} [authentication.password] - The authentication password. Required by the PLAIN, DIGEST and SCRAM mechanisms.
+   * @property {?String} [authentication.token] - The OAuth token. Required by the OAUTHBEARER mechanism.
+   * @property {?String} [authentication.authzid] - The SASL authorization ID.
+   * @property {?String} [authentication.authzid] - The SASL authorization ID.
+   * @property {?Object} [dataFormat] - Content-type for entry
+   * @property {?String} [dataFormat.keyType] - Content-type for key
+   * @property {?String} [dataFormat.valueType] - Content-type for value
    * @property {?boolean} [topologyUpdates=true] - Optional flag to controls whether the client deals with topology updates or not.
-   * @property {?(text/plain|application/json)} [mediaType=text/plain] - Media type of the cache contents.
-   * @property {?Cluster[]} clusters - Optional additional clusters for cross-site failovers.
+   * @property {?("text/plain"|"application/json")} [mediaType="text/plain"] - Media type of the cache contents.
+   * @property {?Cluster[]} [clusters] - Optional additional clusters for cross-site failovers.
    * @since 0.3
    */
   Client.config = {

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "infinispan",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Infinispan Javascript client",
   "main": "index",
+  "typings": "./types",
   "directories": {
     "test": "test"
   },
   "scripts": {
+    "lint": "eslint --ignore-path .gitignore .",
     "test": "./node_modules/.bin/jasmine-node spec"
   },
   "author": "Galder Zamarreño",
@@ -31,6 +33,7 @@
     "underscore": "^1.13.3"
   },
   "devDependencies": {
+    "eslint": "^8.26.0",
     "growl": "^1.10.5",
     "jasmine-node": "^3.0.0",
     "jsdoc": "^3.6.10",

package/smoke-tests.sh

@@ -15,6 +15,7 @@ node \
   spec/infinispan_ssl_spec.js \
   spec/infinispan_stress_spec.js \
   spec/protocols_spec.js \
+  spec/protostream_spec.js \
   spec/tests.js \
   spec/utils_spec.js \
   --captureExceptions --junitreport --forceexit

package/types/README.md

@@ -0,0 +1,91 @@
+This directory contains all the type definitions that are used in this libray.
+
+The below code can be used for testing the type support.
+
+```
+const protobuf = require("protobufjs");
+const infinispan = require("./lib/infinispan.js");
+
+
+var client = infinispan.client(
+  { port: 11222, host: "127.0.0.1" },
+  {
+    dataFormat: {
+      keyType: "application/x-protostream",
+      valueType: "application/x-protostream",
+    },
+    authentication: {
+      enabled: true,
+      saslMechanism: "DIGEST-MD5",
+      userName: "admin",
+      password: "pass",
+      serverName: "infinispan",
+    },
+    cacheName: "protoStreamCache",
+  }
+);
+
+var protoMetaClient = infinispan.client({ port: 11222, host: "127.0.0.1" }, {
+  authentication: {
+    enabled: true,
+    saslMechanism: "DIGEST-MD5",
+    userName: "admin",
+    password: "pass",
+    serverName: "infinispan",
+  },
+  cacheName: "___protobuf_metadata",
+  dataFormat: { keyType: "text/plain", valueType: "text/plain" },
+});
+
+protoMetaClient.then(async function (client) {
+  var myMsg2 = `package awesomepackage;
+  /**
+   * @TypeId(1000042)
+   */
+  message AwesomeMessages {
+      required string name = 1;
+      required int64 age = 2;
+  
+  }`
+  await client.put("awesomepackage/AwesomeMessage.proto", myMsg2);
+  await client.disconnect();
+})
+
+
+client.then(async function (client) {
+  var myMsg2 = `package awesomepackage;
+    /**
+     * @TypeId(1000042)
+     */
+    message AwesomeMessages {
+        required string name = 1;
+        required int64 age = 2;
+    
+    }`;
+
+
+  let root = protobuf.parse(myMsg2).root;
+  let user = root.lookupType('awesomepackage.AwesomeMessages');
+  client.registerProtostreamType('.awesomepackage.AwesomeMessages', 1000042);
+  client.registerProtostreamRoot(root);
+  try {
+    for (let i = 0; i < 10; i++) {
+      let payload = { name: "Neeraj" + i, age: 20 + i };
+      let buf = user.create(payload);
+      await client.put(i + 1, buf);
+      console.log(await client.getWithMetadata(1));
+    }
+    var decoded = await client.query({ queryString: `select u.name,u.age from awesomepackage.AwesomeMessages u where u.age>20` });
+    console.log(decoded);
+    await client.disconnect();
+  } catch (error) {
+    console.log(error);
+  }
+
+});
+```
+
+In the put method, if someone provides only one argument then the compiler will throw the error as below :
+`index.ts:70:18 - error TS2554: Expected 2-3 arguments, but got 1.`
+
+The same follows for all the operations. There is a validation on client config also.