@hahnpro/flow-sdk 9.6.5 → 2025.2.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/flow-sdk",
-  "version": "9.6.5",
+  "version": "2025.2.0-beta.2",
   "description": "SDK for building Flow Modules",
   "license": "MIT",
   "author": {
@@ -11,30 +11,23 @@
     "type": "git",
     "url": "git@github.com:hahnprojects/flow.git"
   },
-  "directories": {
-    "lib": "lib",
-    "test": "test"
-  },
-  "files": [
-    "dist"
-  ],
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@hahnpro/hpc-api": "2025.5.1",
+    "@hahnpro/hpc-api": "2025.6.0",
     "@nats-io/jetstream": "3.2.0",
     "@nats-io/nats-core": "3.2.0",
     "@nats-io/transport-node": "3.2.0",
     "amqp-connection-manager": "4.1.15",
     "amqplib": "0.10.9",
     "class-transformer": "0.5.1",
-    "class-validator": "~0.14.2",
+    "class-validator": "0.14.2",
     "cloudevents": "10.0.0",
     "lodash": "4.17.21",
-    "object-sizeof": "~2.6.5",
+    "object-sizeof": "2.6.5",
     "python-shell": "5.0.0",
     "reflect-metadata": "0.2.2",
     "rxjs": "7.8.2",
@@ -59,10 +52,5 @@
   "engines": {
     "node": ">=v22"
   },
-  "scripts": {
-    "build": "../../node_modules/.bin/tsc -p tsconfig.lib.json",
-    "build:nocomments": "../../node_modules/.bin/tsc -p tsconfig.nocomments.json",
-    "postbuild": "../../node_modules/.bin/copyfiles -u 1 lib/*.py dist",
-    "lint": "eslint '*/**/*.{js,ts}'"
-  }
+  "type": "commonjs"
 }

package/src/index.d.ts

@@ -0,0 +1,12 @@
+export * from '@hahnpro/hpc-api';
+export * from './lib/flow.interface';
+export * from './lib/utils';
+export * from './lib/FlowApplication';
+export * from './lib/FlowElement';
+export * from './lib/FlowEvent';
+export * from './lib/FlowLogger';
+export { FlowModule } from './lib/FlowModule';
+export * from './lib/TestModule';
+export * from './lib/unit-decorators';
+export * from './lib/ContextManager';
+export { IncompatableWith } from './lib/extra-validators';

package/src/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IncompatableWith = exports.FlowModule = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("@hahnpro/hpc-api"), exports);
+tslib_1.__exportStar(require("./lib/flow.interface"), exports);
+tslib_1.__exportStar(require("./lib/utils"), exports);
+tslib_1.__exportStar(require("./lib/FlowApplication"), exports);
+tslib_1.__exportStar(require("./lib/FlowElement"), exports);
+tslib_1.__exportStar(require("./lib/FlowEvent"), exports);
+tslib_1.__exportStar(require("./lib/FlowLogger"), exports);
+var FlowModule_1 = require("./lib/FlowModule");
+Object.defineProperty(exports, "FlowModule", { enumerable: true, get: function () { return FlowModule_1.FlowModule; } });
+tslib_1.__exportStar(require("./lib/TestModule"), exports);
+tslib_1.__exportStar(require("./lib/unit-decorators"), exports);
+tslib_1.__exportStar(require("./lib/ContextManager"), exports);
+var extra_validators_1 = require("./lib/extra-validators");
+Object.defineProperty(exports, "IncompatableWith", { enumerable: true, get: function () { return extra_validators_1.IncompatableWith; } });

package/{dist → src/lib}/ContextManager.js

@@ -5,20 +5,42 @@ exports.flowInterpolate = flowInterpolate;
 const tslib_1 = require("tslib");
 const lodash_1 = require("lodash");
 const string_interp_1 = tslib_1.__importDefault(require("string-interp"));
+/**
+ * Class representing a context manager for handling properties.
+ */
 class ContextManager {
+    /**
+     * Constructor of the ContextManager.
+     * @param {Logger} logger - The logger instance for logging messages.
+     * @param {Record<string, any>} [flowProperties={}] - Initial properties to set.
+     */
     constructor(logger, flowProperties = {}) {
         this.logger = logger;
         this.properties = { flow: flowProperties };
     }
+    /**
+     * Init or overwrite all properties.
+     * @param properties
+     */
     overwriteAllProperties(properties = {}) {
         this.properties = { flow: properties };
     }
     updateFlowProperties(properties = {}) {
         this.properties.flow = properties;
     }
+    /**
+     * Get a copy of the current properties.
+     * @returns {Record<string, any>} A copy of the properties.
+     */
     getProperties() {
         return { ...this.properties };
     }
+    /**
+     * Set a property.
+     * A property key starting with "flow." is reserved for the properties set by in UI and so it is not allowed to be set.
+     * @param {string} keyOrPath - The key or the path of the property.
+     * @param {any} value - The value of the property.
+     */
     set(keyOrPath, value) {
         if (keyOrPath.startsWith('flow.')) {
             this.logger.error(`Set property of "${keyOrPath}" is not allowed, because it starts with "flow.", so it is reserved for the properties set by in UI.`);
@@ -27,6 +49,11 @@ class ContextManager {
             (0, lodash_1.set)(this.properties, keyOrPath, value);
         }
     }
+    /**
+     * Get a property value by key.
+     * @param {string} keyOrPath - The key or the path of the property.
+     * @returns {any} The value of the property.
+     */
     get(keyOrPath) {
         return (0, lodash_1.get)(this.properties, keyOrPath, undefined);
     }
@@ -52,6 +79,7 @@ function flowInterpolate(value, properties) {
         return value;
     }
     else if (value != null && typeof value === 'string' && value.startsWith('${')) {
+        // get ${...} blocks and replace the ones that start with flow. in a new string
         const blockRegEx = /\$\{\s*(\S+)\s*}/g;
         let newValue = value;
         let m;

package/{dist → src/lib}/FlowApplication.js

@@ -3,22 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowApplication = void 0;
 const tslib_1 = require("tslib");
 require("reflect-metadata");
+const perf_hooks_1 = require("perf_hooks");
 const hpc_api_1 = require("@hahnpro/hpc-api");
 const jetstream_1 = require("@nats-io/jetstream");
 const cloudevents_1 = require("cloudevents");
 const lodash_1 = require("lodash");
 const object_sizeof_1 = tslib_1.__importDefault(require("object-sizeof"));
-const perf_hooks_1 = require("perf_hooks");
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const amqp_1 = require("./amqp");
+const ContextManager_1 = require("./ContextManager");
 const flow_interface_1 = require("./flow.interface");
 const FlowLogger_1 = require("./FlowLogger");
+const nats_1 = require("./nats");
 const RpcClient_1 = require("./RpcClient");
 const utils_1 = require("./utils");
-const nats_1 = require("./nats");
-const ContextManager_1 = require("./ContextManager");
-const MAX_EVENT_SIZE_BYTES = +process.env.MAX_EVENT_SIZE_BYTES || 512 * 1024;
+const MAX_EVENT_SIZE_BYTES = +process.env.MAX_EVENT_SIZE_BYTES || 512 * 1024; // 512kb
 const WARN_EVENT_PROCESSING_SEC = +process.env.WARN_EVENT_PROCESSING_SEC || 60;
 const WARN_EVENT_QUEUE_SIZE = +process.env.WARN_EVENT_QUEUE_SIZE || 100;
 class FlowApplication {
@@ -88,6 +88,7 @@ class FlowApplication {
             }
         };
         this.emitPartial = (completeEvent, partialEvent) => {
+            // send complete event, log only partial event
             try {
                 if (completeEvent && this.outputStreamMap.has(completeEvent.getStreamId())) {
                     this.getOutputStream(completeEvent.getStreamId()).next(completeEvent);
@@ -167,9 +168,16 @@ class FlowApplication {
                 }
             }
             else if (cloudEvent.subject.endsWith('.destroy')) {
+                // TODO war com.flowstudio.deployment.destroy in RabbitMq: wo wird das jetzt wieder gesendet?
                 this.destroy();
             }
         };
+        /**
+         * Publish a flow event to the amqp flowlogs exchange.
+         * If the event size exceeds the limit it will be truncated
+         *
+         * TODO warum darf hier nicht false zurückgegeben werden? -> erzeugt loop
+         */
         this.publishNatsEventFlowlogs = async (event) => {
             if (!this._natsConnection || this._natsConnection.isClosed()) {
                 return true;
@@ -190,6 +198,7 @@ class FlowApplication {
             }
             catch (err) {
                 this.logger.error(err);
+                return false;
             }
         };
         if (baseLoggerOrConfig && !baseLoggerOrConfig.log) {
@@ -262,7 +271,7 @@ class FlowApplication {
                 }
                 catch (error) {
                     this.logger.error('Message is not a valid CloudEvent and will be discarded');
-                    msg.ack();
+                    msg.ack(); // Acknowledge the message to remove it from the queue
                     continue;
                 }
                 await this.onMessage(event);
@@ -283,6 +292,7 @@ class FlowApplication {
         try {
             if (!this.skipApi && !(this._api instanceof hpc_api_1.MockAPI)) {
                 const { owner } = this.context;
+                // only create real API if it should not be skipped and is not already a mock
                 this._api = new hpc_api_1.API(this.apiClient, { activeOrg: owner?.id });
             }
         }
@@ -307,15 +317,16 @@ class FlowApplication {
                     ...nats_1.defaultConsumerConfig,
                     name: `flow-deployment-${this.context.deploymentId}`,
                     filter_subject: `${nats_1.natsFlowsPrefixFlowDeployment}.${this.context.deploymentId}.*`,
-                    inactive_threshold: 10 * 60 * 1_000_000_000,
+                    inactive_threshold: 10 * 60 * 1000000000, //  10 mins
                     deliver_policy: jetstream_1.DeliverPolicy.New,
                 };
                 const consumer = await (0, nats_1.getOrCreateConsumer)(this.logger, this._natsConnection, nats_1.FLOWS_STREAM_NAME, consumerOptions.name, consumerOptions);
+                // Recreate consumers on reconnects: NO AWAIT, listen asynchronously
                 const handleNatsStatus = async () => {
                     try {
                         this.logger.debug('ConsumerService: Reconnected to Nats and re-creating non-durable consumers');
                         await (0, nats_1.getOrCreateConsumer)(this.logger, this._natsConnection, nats_1.FLOWS_STREAM_NAME, consumerOptions.name, consumerOptions);
-                        this.consumeNatsMessagesOfConsumer(consumer, { expires: 10 * 1_000_000_000 });
+                        this.consumeNatsMessagesOfConsumer(consumer, { expires: 10 * 1000000000 /* 10 seconds */ });
                     }
                     catch (e) {
                         this.logger.error('NATS Status-AsyncIterator is not available, cannot listen. Due to error:');
@@ -324,7 +335,8 @@ class FlowApplication {
                     }
                 };
                 (0, nats_1.natsEventListener)(this._natsConnection, this.logger, handleNatsStatus);
-                this.consumeNatsMessagesOfConsumer(consumer, { expires: 10 * 1_000_000_000 });
+                // NO AWAIT, listen for messages of the consumer asynchronously
+                this.consumeNatsMessagesOfConsumer(consumer, { expires: 10 * 1000000000 /* 10 seconds */ });
             }
             catch (e) {
                 await logErrorAndExit(`Could not set up consumer for deployment messages exchanges: ${e}`);
@@ -334,7 +346,7 @@ class FlowApplication {
             json: true,
             setup: async (channel) => {
                 try {
-                    await channel.assertExchange('flow', 'direct', { durable: true });
+                    await channel.assertExchange('flow', 'direct', { durable: true }); // TODO wieso weshalb warum: wo wird das gebraucht?
                 }
                 catch (e) {
                     await logErrorAndExit(`Could not assert exchanges: ${e}`);
@@ -364,7 +376,9 @@ class FlowApplication {
             const { id, name, properties, module, functionFqn } = element;
             try {
                 const context = { ...this.context, id, name, logger: this.baseLogger, app: this };
-                this.elements[id] = new this.declarations[`${module}.${functionFqn}`](context, this.contextManager.replaceAllPlaceholderProperties(properties));
+                this.elements[id] = new this.declarations[`${module}.${functionFqn}`](context, 
+                // run recursively through all properties and interpolate them / replace them with their explicit value
+                this.contextManager.replaceAllPlaceholderProperties(properties));
                 this.elements[id].setPropertiesWithPlaceholders((0, lodash_1.cloneDeep)(properties));
             }
             catch (err) {
@@ -430,6 +444,11 @@ class FlowApplication {
         this.initialized = true;
         this.logger.log('Flow Deployment is running');
     }
+    /**
+     * Calls onDestroy lifecycle method on all flow elements,
+     * closes amqp connection after allowing logs to be processed and published
+     * then exits process
+     */
     async destroy(exitCode = 0) {
         try {
             try {
@@ -443,10 +462,12 @@ class FlowApplication {
             catch (err) {
                 this.logger.error(err);
             }
+            // allow time for logs to be processed
             await (0, utils_1.delay)(250);
             if (this.amqpConnection) {
                 await this.amqpConnection.close();
             }
+            // Close all output streams
             for (const [id, stream] of this.outputStreamMap.entries()) {
                 try {
                     stream?.complete();
@@ -455,6 +476,7 @@ class FlowApplication {
                     this.logger.error(`Error completing output stream ${id}: ${err.message}`);
                 }
             }
+            // Nats: Delete consumer for flow deployment, stop message listening and close connection
             try {
                 await this.natsMessageIterator?.close();
                 await this._natsConnection?.drain();
@@ -475,11 +497,13 @@ class FlowApplication {
             catch (err) {
                 this.logger.error(err);
             }
+            // remove process listeners
             process.removeAllListeners('SIGTERM');
             process.removeAllListeners('uncaughtException');
             process.removeAllListeners('unhandledRejection');
         }
         catch (err) {
+            /* eslint-disable-next-line no-console */
             console.error(err);
         }
         finally {
@@ -488,6 +512,10 @@ class FlowApplication {
             }
         }
     }
+    /**
+     * Returns rxjs subject for the specified stream id.
+     * A new subject will be created if one doesn't exist yet.
+     */
     getOutputStream(id) {
         const stream = this.outputStreamMap.get(id);
         if (!stream) {

package/{dist → src/lib}/FlowElement.js

@@ -40,9 +40,16 @@ class FlowElement {
             this.setProperties(properties);
         }
     }
+    /**
+     * Sets the placeholder properties for this flow element
+     * @param propertiesWithPlaceholders
+     */
     setPropertiesWithPlaceholders(propertiesWithPlaceholders) {
         this.propertiesWithPlaceholders = propertiesWithPlaceholders;
     }
+    /**
+     * Returns the placeholder properties for this flow element
+     */
     getPropertiesWithPlaceholders() {
         return this.propertiesWithPlaceholders;
     }
@@ -52,12 +59,18 @@ class FlowElement {
     get natsConnection() {
         return this.app?.natsConnection;
     }
+    /**
+     * Replace all placeholder properties with their explicit updated value and set them as the properties of the element
+     */
     replacePlaceholderAndSetProperties() {
         const placeholderProperties = this.propertiesWithPlaceholders;
         if (this.propertiesWithPlaceholders) {
             this.setProperties(this.app.getContextManager?.()?.replaceAllPlaceholderProperties(placeholderProperties));
         }
     }
+    /**
+     * @deprecated since version 4.8.0, will be removed in 5.0.0, use emitEvent(...) instead
+     */
     emitOutput(data = {}, outputId = 'default', time = new Date()) {
         return this.emitEvent(data, null, outputId, time);
     }
@@ -135,6 +148,7 @@ function InputStream(id = 'default', options) {
             if (!this.stopPropagateStream.has(id)) {
                 this.stopPropagateStream.set(id, options?.stopPropagation ?? false);
             }
+            // add input stream to data to later determine if data should be propagated
             return method.call(this, new FlowEvent_1.FlowEvent({ id: event.getMetadata().elementId, ...event.getMetadata(), inputStreamId: id }, event.getData(), event.getType(), new Date(event.getTime())));
         };
     };
@@ -144,6 +158,7 @@ function FlowFunction(fqn) {
     if (!fqnRegExp.test(fqn)) {
         throw new Error(`Flow Function FQN (${fqn}) is not valid`);
     }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
     return (target) => {
         Reflect.defineMetadata('element:functionFqn', fqn, target);
         target.prototype.functionFqn = fqn;

package/{dist → src/lib}/FlowEvent.js

@@ -12,6 +12,7 @@ class FlowEvent {
                     event.data = JSON.parse(event.data);
                 }
                 catch (err) {
+                    /* ignore error */
                 }
             }
             return event;

package/{dist → src/lib}/FlowLogger.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowLogger = exports.STACK_TRACE = exports.defaultLogger = void 0;
 const FlowEvent_1 = require("./FlowEvent");
+/* eslint-disable no-console */
 exports.defaultLogger = {
     debug: (msg, metadata) => console.debug(msg),
     error: (msg, metadata) => console.error(msg),
@@ -9,6 +10,7 @@ exports.defaultLogger = {
     warn: (msg, metadata) => console.warn(msg),
     verbose: (msg, metadata) => console.log(msg, metadata),
 };
+/* eslint-enable no-console */
 var STACK_TRACE;
 (function (STACK_TRACE) {
     STACK_TRACE["FULL"] = "full";
@@ -16,6 +18,7 @@ var STACK_TRACE;
 })(STACK_TRACE || (exports.STACK_TRACE = STACK_TRACE = {}));
 class FlowLogger {
     static getStackTrace(stacktrace = STACK_TRACE.FULL) {
+        // get stacktrace without extra dependencies
         let stack;
         try {
             throw new Error('');
@@ -23,6 +26,7 @@ class FlowLogger {
         catch (error) {
             stack = error.stack || '';
         }
+        // cleanup stacktrace and remove calls within this file
         stack = stack
             .split('\n')
             .map((line) => line.trim())
@@ -45,6 +49,18 @@ class FlowLogger {
         this.warn = (message, options) => this.publish(message, 'warn', options);
         this.verbose = (message, options) => this.publish(message, 'verbose', options);
     }
+    /**
+     * Parses a message into a FlowLog object, including optional stack trace information.
+     *
+     * @details Requirements for the output format of messages:
+     * - Necessary for consistent logging and event publishing, because the OpenSearch index expects a specific structure: flat_object.
+     * - The current UI expects a `message` property to be present, so we ensure it is always set.
+     *
+     * @param {any} message - The message to be logged. Can be a string, an object with a `message` property, or any other type.
+     * @param {string} level - The log level (e.g., 'error', 'debug', 'warn', 'verbose').
+     * @param {LoggerOptions} options - Additional options for logging, such as whether to include a stack trace.
+     * @returns {FlowLog} - An object containing the parsed log message and optional stack trace.
+     */
     parseMessageToFlowLog(message, level, options) {
         let flowLogMessage;
         if (!message) {

package/{dist → src/lib}/FlowModule.js

@@ -6,6 +6,7 @@ function FlowModule(metadata) {
     if (!validateNameRegExp.test(metadata.name)) {
         throw new Error(`Flow Module name (${metadata.name}) is not valid. Name must be all lowercase and not contain any special characters except for hyphens. Can optionally start with a scope "@scopename/"`);
     }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
     return (target) => {
         Reflect.defineMetadata('module:name', metadata.name, target);
         Reflect.defineMetadata('module:declarations', metadata.declarations, target);

package/{dist → src/lib}/RpcClient.js

@@ -37,12 +37,16 @@ class RpcClient {
             }
             else {
                 const message = `received unexpected response correlationID: ${msg.properties.correlationId}`;
+                /* eslint-disable-next-line no-console */
                 console.warn(message);
             }
         };
         this.callFunction = (routingKey, functionName, ...args) => {
+            // in case remote returns error add this to the trace
             const stack = new Error('test').stack;
             return new Promise((resolve, reject) => {
+                // save to correlationId-> resolve/reject map
+                // on return resolve or reject promise
                 if (MAX_MSG_SIZE || WARN_MSG_SIZE) {
                     const messageSize = (0, object_sizeof_1.default)(args);
                     if (messageSize > MAX_MSG_SIZE) {

package/{dist → src/lib}/amqp.js

@@ -4,7 +4,7 @@ exports.createAmqpConnection = createAmqpConnection;
 const amqp_connection_manager_1 = require("amqp-connection-manager");
 function createAmqpConnection(config) {
     if (!config) {
-        return;
+        return null;
     }
     const { protocol = process.env.RABBIT_PROTOCOL || 'amqp', hostname = process.env.RABBIT_HOST || 'localhost', port = +process.env.RABBIT_PORT || 5672, user = process.env.RABBIT_USER || 'guest', password = process.env.RABBIT_PASSWORD || 'guest', vhost = process.env.RABBIT_VHOST || '', } = config;
     const uri = `${protocol}://${user}:${password}@${hostname}:${port}${vhost ? '/' + vhost : ''}`;

package/{dist → src/lib}/extra-validators.js

@@ -27,6 +27,7 @@ let IsNotSiblingOfConstraint = class IsNotSiblingOfConstraint {
 IsNotSiblingOfConstraint = tslib_1.__decorate([
     (0, class_validator_1.ValidatorConstraint)({ async: false })
 ], IsNotSiblingOfConstraint);
+// Create Decorator for the constraint that was just created
 function IsNotSiblingOf(props, validationOptions) {
     return (object, propertyName) => {
         (0, class_validator_1.registerDecorator)({
@@ -38,6 +39,7 @@ function IsNotSiblingOf(props, validationOptions) {
         });
     };
 }
+// Helper function for determining if a prop should be validated
 function incompatibleSiblingsNotPresent(incompatibleSiblings) {
     return (o, v) => Boolean((0, class_validator_1.isDefined)(v) || incompatibleSiblings.every((prop) => !(0, class_validator_1.isDefined)(o[prop])));
 }

package/{dist → src/lib}/nats.js

@@ -5,14 +5,15 @@ exports.getOrCreateConsumer = getOrCreateConsumer;
 exports.natsEventListener = natsEventListener;
 exports.publishNatsEvent = publishNatsEvent;
 exports.createNatsConnection = createNatsConnection;
+const jetstream_1 = require("@nats-io/jetstream");
 const transport_node_1 = require("@nats-io/transport-node");
 const cloudevents_1 = require("cloudevents");
-const jetstream_1 = require("@nats-io/jetstream");
 const lodash_1 = require("lodash");
 exports.natsFlowsPrefixFlowDeployment = `fs.flowdeployment`;
+// https://docs.nats.io/nats-concepts/jetstream/consumers#configuration
 exports.defaultConsumerConfig = {
     ack_policy: jetstream_1.AckPolicy.Explicit,
-    ack_wait: 30_000_000_000,
+    ack_wait: 30000000000, // 30 seconds
     deliver_policy: jetstream_1.DeliverPolicy.All,
     max_ack_pending: 1000,
     max_deliver: -1,
@@ -59,6 +60,7 @@ async function natsEventListener(nc, logger, reconnectHandler) {
         return;
     }
     for await (const status of statusAsyncIterator) {
+        // Handle reconnect: event is triggered when the NATS client reconnected to the server
         if (status.type === 'reconnect') {
             reconnectHandler();
         }
@@ -67,7 +69,7 @@ async function natsEventListener(nc, logger, reconnectHandler) {
 async function publishNatsEvent(logger, nc, event, subject) {
     if (!nc || nc.isClosed()) {
         logger.error('NATS connection is not available, cannot publish event');
-        return;
+        return null;
     }
     const cloudEvent = new cloudevents_1.CloudEvent({ datacontenttype: 'application/json', ...event });
     cloudEvent.validate();
@@ -79,19 +81,23 @@ async function publishNatsEvent(logger, nc, event, subject) {
     }
     else {
         logger.error(`Could not publish nats event, because jetstream is unavailable / undefined`);
+        return null;
     }
 }
 async function createNatsConnection(config) {
     const servers = config?.servers ?? process.env.NATS_SERVERS?.split(',') ?? [];
     const reconnect = config?.reconnect ?? (process.env.NATS_RECONNECT ?? 'true') === 'true';
+    // Default maxReconnectAttempts is 10
     let maxReconnectAttempts = config?.maxReconnectAttempts ?? parseInt(process.env.NATS_MAX_RECONNECT_ATTEMPTS ?? '-1', 10);
     if (isNaN(maxReconnectAttempts)) {
         maxReconnectAttempts = 10;
     }
+    // Default reconnectTimeWait is 2000ms
     let reconnectTimeWait = config?.reconnectTimeWait ?? parseInt(process.env.NATS_RECONNECT_TIME_WAIT ?? '2000', 10);
     if (isNaN(reconnectTimeWait)) {
         reconnectTimeWait = 2000;
     }
+    // Default timeout is 2000ms
     let timeout = config?.timeout ?? parseInt(process.env.NATS_TIMEOUT ?? '2000', 10);
     if (isNaN(timeout)) {
         timeout = 2000;
@@ -99,8 +105,8 @@ async function createNatsConnection(config) {
     const options = {
         servers,
         reconnect,
-        maxReconnectAttempts,
-        reconnectTimeWait,
+        maxReconnectAttempts, // <-- maxReconnectAttempts: -1 means infinite reconnect attempts
+        reconnectTimeWait, // <-- reconnectTimeWait: -1 means no wait time between reconnect attempts
         timeout,
         user: config?.user ?? process.env.NATS_USER,
         pass: config.pass ?? process.env.NATS_PASSWORD,

package/{dist → src/lib}/unit-utils.js

@@ -80,6 +80,7 @@ function verifyIndices(indices, unit) {
         .map((arr) => arr.filter((v) => v.index !== -1))
         .reduce((previousValue, currentValue) => {
         if (currentValue.length > 1) {
+            // copy existing arrays *length* times
             for (let j = 0; j < currentValue.length - 1; j++) {
                 previousValue.forEach((value) => previousValue.push([...value]));
             }

package/{dist → src/lib}/units.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.units = exports.dimensionToUnitMap = void 0;
 exports.dimensionToUnitMap = {
+    // SI dimensions
     T: 'time',
     L: 'length',
     M: 'mass',
@@ -9,6 +10,7 @@ exports.dimensionToUnitMap = {
     Θ: 'thermodynamicTemperature',
     N: 'amountOfSubstance',
     J: 'luminousIntensity',
+    // pseudo dimensions
     U: 'voltage',
     F: 'force',
     E: 'energy',