Update dependencies & update documentation (#1428)

Author: srknzl

.mocharc.json

@@ -6,12 +6,6 @@
         "test/user_code/**",
         "scripts"
     ],
-    "reporter": "mocha-jenkins-reporter",
-    "reporter-option": [
-        "junit_report_name=Node.js Client Tests",
-        "junit_report_path=report.xml",
-        "junit_report_stack=1"
-    ],
     "require": ["source-map-support/register", "ts-node/register/transpile-only"],
     "recursive": true
 }

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to Hazelcast
 
-> **WARNING: Minimum Node version for development is 12.22.**
+> **WARNING: Minimum Node version for development is 14.14.**
 
 Hazelcast Node.js client is Open Source software, and licensed under the [Apache 2.0. license](LICENSE).
 The main benefit of Open Source is that you don't need to wait for a vendor to provide a fix or a feature.

package.json

@@ -9,24 +9,23 @@
         "lib/**/*.d.ts"
     ],
     "dependencies": {
-        "@types/long": "4.0.2",
+        "@types/long": "4.0.0",
         "long": "4.0.0"
     },
     "devDependencies": {
-        "@istanbuljs/nyc-config-typescript": "^1.0.2",
+        "@istanbuljs/nyc-config-typescript": "~1.0.2",
         "@types/node": "~10.17.60",
-        "@typescript-eslint/eslint-plugin": "~5.27.0",
-        "@typescript-eslint/parser": "~5.27.0",
+        "@typescript-eslint/eslint-plugin": "~5.45.0",
+        "@typescript-eslint/parser": "~5.45.0",
         "chai": "~4.3.6",
         "chai-as-promised": "~7.1.1",
-        "eslint": "~8.16.0",
+        "eslint": "~8.28.0",
         "eslint-plugin-mocha": "~9.0.0",
         "husky": "~6.0.0",
         "jsonschema": "~1.4.0",
         "markdown-link-check": "~3.10.2",
-        "markdownlint-cli": "~0.31.1",
+        "markdownlint-cli": "~0.32.2",
         "mocha": "~9.2.2",
-        "mocha-jenkins-reporter": "~0.4.7",
         "mousse": "~0.3.1",
         "nyc": "~15.1.0",
         "path-exists-cli": "~2.0.0",
@@ -35,10 +34,10 @@
         "sinon-chai": "~3.7.0",
         "source-map-support": "~0.5.21",
         "thrift": "~0.16.0",
-        "ts-node": "~10.7.0",
-        "typedoc": "~0.22.10",
-        "typescript": "~4.7.2",
-        "winston": "~3.7.2",
+        "ts-node": "~10.9.1",
+        "typedoc": "~0.22.18",
+        "typescript": "~4.7.4",
+        "winston": "~3.8.2",
         "yargs": "~17.5.1"
     },
     "engines": {

src/HazelcastClient.ts

@@ -20,7 +20,7 @@ import {
     DistributedObject,
     DistributedObjectListener,
     LoadBalancer,
-    IllegalStateError
+    IllegalStateError,
 } from './core';
 import {ClientGetDistributedObjectsCodec} from './codec/ClientGetDistributedObjectsCodec';
 import {ClientConfig, ClientConfigImpl} from './config/Config';
@@ -147,8 +147,8 @@ export class HazelcastClient {
             this.config.properties['hazelcast.logging.level'] as string);
         const logger = this.loggingService.getLogger();
         this.schemaService = new SchemaService(
-            this.config, 
-            () => this.clusterService, 
+            this.config,
+            () => this.clusterService,
             () => this.invocationService,
             logger
         );

src/config/SSLConfig.ts

@@ -32,10 +32,12 @@ export interface SSLConfig {
      * Default SSL options are empty which means the following default configuration
      * is used while connecting to the server.
      *
+     * ```json
      * {
      *   checkServerIdentity: (): any => null,
      *   rejectUnauthorized: true,
      * };
+     * ```
      *
      * If you want to override the default behavior, you can define your own options.
      */

src/serialization/compact/CompactReader.ts

@@ -40,9 +40,9 @@ export interface CompactReader {
      * Reads a boolean.
      *
      * This method can also read a nullable boolean, as long as it is not
-     * {@code null}. If a {@code null} value is read with this method,
+     * `null`. If a `null` value is read with this method,
      * {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -54,9 +54,9 @@ export interface CompactReader {
      * Reads an 8-bit two's complement signed integer.
      *
      * This method can also read a nullable int8, as long as it is not
-     * {@code null}. If a {@code null} value is read with this method,
+     * `null`. If a `null` value is read with this method,
      * {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -68,9 +68,9 @@ export interface CompactReader {
      * Reads a 16-bit two's complement signed integer.
      *
      * This method can also read a nullable int16, as long as it is not
-     * {@code null}. If a {@code null} value is read with this method,
+     * `null`. If a `null` value is read with this method,
      * {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -82,9 +82,9 @@ export interface CompactReader {
      * Reads a 32-bit two's complement signed integer.
      *
      * This method can also read a nullable int32, as long as it is not
-     * {@code null}. If a {@code null} value is read with this method,
+     * `null`. If a `null` value is read with this method,
      * {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -96,9 +96,9 @@ export interface CompactReader {
      * Reads a 64-bit two's complement signed integer.
      *
      * This method can also read a nullable int64, as long as it is not
-     * {@code null}. If a {@code null} value is read with this method,
+     * `null`. If a `null` value is read with this method,
      * {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -110,9 +110,9 @@ export interface CompactReader {
      * Reads a 32-bit IEEE 754 floating point number.
      *
      * This method can also read a nullable float32, as long as it is not
-     * {@code null}. If a {@code null} value is read with this method,
+     * `null`. If a `null` value is read with this method,
      * {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -124,9 +124,9 @@ export interface CompactReader {
      * Reads a 64-bit IEEE 754 floating point number.
      *
      * This method can also read a nullable float64, as long as it is not
-     * {@code null}. If a {@code null} value is read with this method,
+     * `null`. If a `null` value is read with this method,
      * {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -208,9 +208,9 @@ export interface CompactReader {
      * Reads an array of booleans.
      *
      * This method can also read an array of nullable booleans, as long as it
-     * does not contain {@code null} values. If a {@code null} array item is
+     * does not contain `null` values. If a `null` array item is
      * read with this method, {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -222,9 +222,9 @@ export interface CompactReader {
      * Reads an array of 8-bit two's complement signed integers.
      *
      * This method can also read an array of nullable int8s, as long as it
-     * does not contain {@code null} values. If a {@code null} array item is
+     * does not contain `null` values. If a `null` array item is
      * read with this method, {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -236,9 +236,9 @@ export interface CompactReader {
      * Reads an array of 16-bit two's complement signed integers.
      *
      * This method can also read an array of nullable int16s, as long as it
-     * does not contain {@code null} values. If a {@code null} array item is
+     * does not contain `null` values. If a `null` array item is
      * read with this method, {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -250,9 +250,9 @@ export interface CompactReader {
      * Reads an array of 32-bit two's complement signed integers.
      *
      * This method can also read an array of nullable int32s, as long as it
-     * does not contain {@code null} values. If a {@code null} array item is
+     * does not contain `null` values. If a `null` array item is
      * read with this method, {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -264,9 +264,9 @@ export interface CompactReader {
      * Reads an array of 64-bit two's complement signed integers.
      *
      * This method can also read an array of nullable int64s, as long as it
-     * does not contain {@code null} values. If a {@code null} array item is
+     * does not contain `null` values. If a `null` array item is
      * read with this method, {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -278,9 +278,9 @@ export interface CompactReader {
      * Reads an array of 32-bit IEEE 754 floating point numbers.
      *
      * This method can also read an array of nullable float32s, as long as it
-     * does not contain {@code null} values. If a {@code null} array item is
+     * does not contain `null` values. If a `null` array item is
      * read with this method, {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -292,9 +292,9 @@ export interface CompactReader {
      * Reads an array of 64-bit IEEE 754 floating point numbers.
      *
      * This method can also read an array of nullable float64s, as long as it
-     * does not contain {@code null} values. If a {@code null} array item is
+     * does not contain `null` values. If a `null` array item is
      * read with this method, {@link HazelcastSerializationError} is thrown.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -377,7 +377,7 @@ export interface CompactReader {
      * Reads a nullable boolean.
      *
      * This method can also read a non-nullable boolean.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -389,7 +389,7 @@ export interface CompactReader {
      * Reads a nullable 8-bit two's complement signed integer.
      *
      * This method can also read a non-nullable int8.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -401,7 +401,7 @@ export interface CompactReader {
      * Reads a nullable 16-bit two's complement signed integer.
      *
      * This method can also read a non-nullable int16.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -413,7 +413,7 @@ export interface CompactReader {
      * Reads a nullable 32-bit two's complement signed integer.
      *
      * This method can also read a non-nullable int32.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -425,7 +425,7 @@ export interface CompactReader {
      * Reads a nullable 64-bit two's complement signed integer.
      *
      * This method can also read a non-nullable int64.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -437,7 +437,7 @@ export interface CompactReader {
      * Reads a nullable 32-bit IEEE 754 floating point number.
      *
      * This method can also read a non-nullable float32.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -449,7 +449,7 @@ export interface CompactReader {
      * Reads a nullable 64-bit IEEE 754 floating point number.
      *
      * This method can also read a non-nullable float64.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -461,7 +461,7 @@ export interface CompactReader {
      * Reads a nullable array of nullable booleans.
      *
      * This method can also read array of non-nullable booleans.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -473,7 +473,7 @@ export interface CompactReader {
      * Reads a nullable array of nullable 8-bit two's complement signed integers.
      *
      * This method can also read array of non-nullable int8s.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -485,7 +485,7 @@ export interface CompactReader {
      * Reads a nullable array of nullable 16-bit two's complement signed integers.
      *
      * This method can also read array of non-nullable int16s.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -497,7 +497,7 @@ export interface CompactReader {
      * Reads a nullable array of nullable 32-bit two's complement signed integers.
      *
      * This method can also read array of non-nullable int32s.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -509,7 +509,7 @@ export interface CompactReader {
      * Reads a nullable array of nullable 64-bit two's complement signed integers.
      *
      * This method can also read array of non-nullable int64s.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -521,7 +521,7 @@ export interface CompactReader {
      * Reads a nullable array of nullable 32-bit IEEE 754 floating point numbers.
      *
      * This method can also read array of non-nullable float32s.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.
@@ -533,7 +533,7 @@ export interface CompactReader {
      * Reads a nullable array of nullable 64-bit IEEE 754 floating point numbers.
      *
      * This method can also read array of non-nullable float64s.
-     * 
+     *
      * @param fieldName name of the field.
      * @throws {@link HazelcastSerializationError} if the field does not exist in the
      * schema, or the type of the field does not match with the one defined in the schema.