diff --git a/CHANGELOG.md b/CHANGELOG.md index 7903e1f..d47f915 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.25.1] - 2026-03-25 + +### Added + +- Enhance response payload explanation for nested keys in event `Version1.GET_SETTINGS` + ## [1.25.0] - 2026-03-25 ### Added diff --git a/docs/events.md b/docs/events.md index a76c71f..01c2d7e 100644 --- a/docs/events.md +++ b/docs/events.md @@ -298,6 +298,15 @@ Request permissions for specified object from the Shell } ``` + **Important:** When nested keys are used, the response key is returned as a dot-separated string (combining the individual parts). This approach was chosen to simplify comparison, as working with array-based keys in responses would be less practical: + + ```typescript + { + key: 'folder_2.folder_3.key_4', + value: 'value4' + } + ``` + - Listener ```typescript diff --git a/package-lock.json b/package-lock.json index 37f134b..3536cc0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "fsm-shell", - "version": "1.25.0", + "version": "1.25.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "fsm-shell", - "version": "1.25.0", + "version": "1.25.1", "license": "Apache-2.0", "devDependencies": { "@types/jasmine": "^3.5.12", diff --git a/package.json b/package.json index 5372163..bb7dba3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "fsm-shell", - "version": "1.25.0", + "version": "1.25.1", "description": "client library for FSM shell", "main": "release/fsm-shell-client.js", "module": "release/fsm-shell-client.es.js",