Merge pull request #56 from SolaceLabs/cli-params-cleanup

Updates in this release (0.0.82)

Author: gvensan

.gitignore

@@ -11,6 +11,7 @@ store
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+tests/*log
 
 # Editor directories and files
 .idea

README.md

@@ -89,7 +89,7 @@ apt-get install --only-upgrade stm
 
 
 #### Download the Archive
-For manual installation of the tool directly from archives, navigate to [Git Releases](https://github.com/SolaceLabs/solace-tryme-cli/releases), locate the latest release and review the zip files (approprietly named with the target OS name) under **Assets**. Download the right bundle based on your OS and extract the binary/executable. Move the binary/executable file to a folder that is in the *PATH* or update the path to contain the folder where the file is present.
+For manual installation of the tool directly from archives, navigate to [Git Releases](https://github.com/SolaceLabs/solace-tryme-cli/releases), locate the latest release and review the zip files (appropriately named with the target OS name) under **Assets**. Download the right bundle based on your OS and extract the binary/executable. Move the binary/executable file to a folder that is in the *PATH* or update the path to contain the folder where the file is present.
 
 | **For Windows**                                                                                                                                                                                                                                                                                                                        | **For Linux**                                                                                                                                                                                                                                                                                                                                    | **For Mac**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -140,9 +140,9 @@ stm
 │   ├── -he, --help-examples        /* display examples                               */
 │   ├── init                        /* initialize command configuration               */
 │   ├── list                        /* list command configurations                    */
-│   └── delete                      /* delete command configuratio                    */
-└── manage                          /* manage connection and resources                */
-│   └── -h, --help                  /* display help for command                       */
+│   └── delete                      /* delete command configuration                   */
+├── manage                          /* manage connection and resources                */
+│   ├── -h, --help                  /* display help for command                       */
 │   ├── -he, --help-examples        /* display examples                               */
 │   ├── connection                  /* manage VPN connection                          */
 │   ├── semp-connection             /* manage VPN SEMP connection                     */
@@ -159,6 +159,7 @@ stm
     ├── list                        /* List event feeds                               */
     ├── import                      /* Import an event feed                           */
     ├── export                      /* Export an event feed                           */
+    ├── download                    /* Download an event feed                         */
     └── contribute                  /* Contribute to community event feeds            */
 
 ```

documentation/DATAGENERATION_RULES.md

@@ -59,9 +59,9 @@
 |     | _**country**_  <br>Returns a random country name. |
 |     | _**countryCode**_  <br>Returns a random ISO\_3166-1 country code. |
 |     | _**latitude**_  <br>Generates a random latitude. | minimum \[default: -90\]  <br>maximum \[default: 90\]  <br>precision \[default: 4\] |
-|     | _**longitude**_  <br>Generates a random longitude. | minimum \[default: -90\]  <br>maximum \[default: 90\]  <br>precision \[default: 4\] |
-|     | _**timeZon**_  <br>Returns a random time zone. |
-| **InternetRules**  <br>Module to generate internet related entries | _**domainNam**_  <br>Generates a random domain name. | casing \[default: lower\] |
+|     | _**longitude**_  <br>Generates a random longitude. | minimum \[default: -180\]  <br>maximum \[default: 180\]  <br>precision \[default: 4\] |
+|     | _**timeZone**_  <br>Returns a random time zone. |
+| **InternetRules**  <br>Module to generate internet related entries | _**domainName**_  <br>Generates a random domain name. | casing \[default: lower\] |
 |     | _**domainWord**_ |     |
 |     | _**email**_  <br>Generates a random email address. | casing \[default: lower\]  <br>emoji  <br>Generates a random emoji. |
 |     | _**emoji**_ |
@@ -94,7 +94,7 @@
 |     | _**price**_  <br>Generates a random price between min and max. | minimum \[default: 1\]  <br>maximum \[default: 999\] |
 |     | _**product**_  <br>Returns a random short product name. |
 |     | _**productDescription**_  <br>Returns a random product description. |
-|     | _**productNam**_  <br>Generates a random descriptive product name. |     |
+|     | _**productName**_  <br>Generates a random descriptive product name. |     |
 
 ## Supported Regular Expression
 

documentation/EVENT_FEEDS.md

@@ -40,7 +40,7 @@ stm
     ├── list                        /* List event feeds                               */
     ├── import                      /* Import an event feed from archive file         */
     ├── export                      /* Export an event feed to Event Portal           */
-    ├── archive                     /* Archive an event feed                          */
+    ├── download                    /* Download an event feed as archive              */
     └── contribute                  /* Contribute to community event feeds            */
 ```
 
@@ -140,6 +140,19 @@ Generate a Feed| Validate the Feed
 
 The `configure` sub-command enables setting up data generation rules for *topic* and *payload* parameters. It also allows optional mapping of attributes (e.g., `topic parameter → payload attribute, payload attribute → another attribute`).
 
+```
+Usage: stm feed configure [options]
+
+Configure event feed rules
+
+Options:
+  -feed, --feed-name <FEED_NAME>      the feed name
+  -port, --manage-port [PORT]         the port for the manager (default: 0)
+
+  /* HELP OPTIONS */
+  -h, --help                          display help for command
+```
+
 To learn about supported data generation rules, refer to the documentation: [Data Generation Rules](./DATAGENERATION_RULES.md)
 
 An Event Feed configuration exposes feed operations — send and receive events and their schemas. Under the *Messages* group, you can explore all exposed `messages` (events). Selecting a message reveals its details, including `name, schema`, and the `topics` it uses for send and receive operations.
@@ -212,7 +225,7 @@ Options:
   -feed, --feed-name <FEED_NAME>            the feed name
   -events, --event-names <EVENT_NAME...>    the event name(s) as space-separated values if listing more than one (e.g., "Loan_Applied" "Loan_Approved" )
   -community, --community-feed [BOOLEAN]    a community feed (default: false)
-  -c, --config <CONFIG_FILE>                the configuration file (default: "stm-cli-config.json")
+  --config <CONFIG_FILE>                the configuration file (default: "stm-cli-config.json")
 
   /* MESSAGE SETTINGS */
   --count <COUNT>                           the number of events to publish (default: 1)
@@ -226,6 +239,8 @@ Options:
   -hm, --help-more                          display more help for command with options not shown in basic help
   -h, --help                                display help for command
   ```
+
+> **NOTE**: The `stm feed run` command supports all the messaging parameters available in the `stm send` command, including advanced connection settings, message properties, session settings, and publish settings. For a complete list of all available options (including advanced ones), use the `--help-more` flag or refer to the [Messaging Parameters documentation](./MESSAGING_PARAMETERS.md).
   
   ### Streaming via Command-line
 

documentation/MESSAGING_EXAMPLES.md

@@ -50,6 +50,10 @@ stm send --topic solace/try/me --count 100 --interval 5000
 
 stm send --topic "stm/logistics/shipped" "stm/inventory/check"
 
+// publish to queue with user properties (important for message routing and metadata)
+
+stm send --queue order-queue --message "Order 123 processed" --user-properties "orderId:123" "priority:high"
+
 // deliver event with a default payload to queue
 
 stm send --queue MyQueue 
@@ -126,6 +130,10 @@ stm receive --queue my-queue
 
 stm receive --queue my-queue -t "stm/logistics/shipped"
 
+// receive with detailed output mode (useful for debugging and message inspection)
+
+stm receive --topic "orders/*" --output-mode FULL
+
 NOTE: You can override any of the receive parameters
 that are applied only for this instance of execution!
 
@@ -197,6 +205,10 @@ stm request --topic solace/try/me/request -f OrderCreated.json
 
 stm request --topic solace/try/me/request --stdin
 
+// request with timeout and multiple requests (essential for request-reply patterns)
+
+stm request --topic "api/status" --message "Check status" --timeout 10000 --count 3 --interval 2000
+
 NOTE: You can override any of the request parameters
 that are applied only for this instance of execution!
 
@@ -224,7 +236,7 @@ stm request  --name request --config cloud-broker --save request2
 
 // Duplicate the command setting with the specified command-line parameters
 
-stm request --topic "stm/logistics/sipped" --name request2 --config cloud-broker --save request4
+stm request --topic "stm/logistics/shipped" --name request2 --config cloud-broker --save request4
 
 HINT: You can verify the outcome by executing a config list command 'stm config list --config cloud-broker.json'!
 ```
@@ -268,6 +280,10 @@ stm reply --topic solace/try/me/request -f OrderCreated.json
 
 stm reply --topic solace/try/me/request --stdin
 
+// reply with user properties (important for response metadata and correlation)
+
+stm reply --topic "api/response" --message "Success" --user-properties "status:200" "responseTime:150ms"
+
 NOTE: You can override any of the reply parameters
 that are applied only for this instance of execution!
 
@@ -295,7 +311,7 @@ stm reply  --name reply --config cloud-broker --save reply2
 
 // Duplicate the command setting with the specified command-line parameters
 
-stm reply --topic "stm/logistics/sipped" --name reply2 --config cloud-broker --save reply4
+stm reply --topic "stm/logistics/shipped" --name reply2 --config cloud-broker --save reply4
 
 HINT: You can verify the outcome by executing a config list command 'stm config list --config cloud-broker.json'!
 ```
@@ -361,7 +377,7 @@ stm manage queue --name queue --config cloud-broker --save queue2
 
 // Duplicate the command setting with the specified command-line parameters
 
-stm manage queue --add-subscriptions "stm/logistics/sipped" --name queue2 --config cloud-broker --save queue4
+stm manage queue --add-subscriptions "stm/logistics/shipped" --name queue2 --config cloud-broker --save queue4
 
 HINT: You can verify the outcome by executing a config list command 'stm config list --config cloud-broker.json'!
 ```