Merge 2f719ac into 70d1b73

CHANGELOG.md

@@ -5,6 +5,13 @@ 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.3.1] - 2020-05-11
+
+### Added
+
+- Special rule to expose `key` value on `GET_STORAGE_ITEM` event, with legacy support.
+
 ## [1.3.0] - 2020-05-06
 
 ### Added

README.md

@@ -155,6 +155,16 @@
     }
     ```
 
+  - Listenner
+
+    To listen `GET_STORAGE_ITEM`, ShellSdk provide a different syntax for legacy reason. You can access `value` and `key`
+    as following:
+    ```typescript
+    sdk.on(SHELL_EVENTS.Version1.GET_STORAGE_ITEM, (value, key) => {
+     console.log(`${key} is now equal to ${value}`);
+    });
+    ```
+
 - #### V1.SET_STORAGE_ITEM
   Save value in cloud staorage under specified key
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fsm-shell",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "client library for FSM shell",
   "main": "release/fsm-shell-client.js",
   "module": "release/fsm-shell-client.es.js",

src/ShellSdk.spec.ts

@@ -289,4 +289,29 @@ describe('Shell Sdk', () => {
     requestContext.resetHistory();
   });
 
+  it('should have special syntax for GET_STORAGE_ITEM', (done) => {
+    const postMessageParent = sinon.spy();
+    sdk = ShellSdk.init({
+      postMessage: postMessageParent
+    } as any as Window, sdkOrigin, windowMock);
+
+    const requestContext = sinon.spy();
+
+    sdk.on(SHELL_EVENTS.Version1.GET_STORAGE_ITEM, (value, key) => {
+      expect(value).toBe('fr');
+      expect(key).toBe('Cockpit_SelectedLocale');
+      done();
+    });
+
+    windowMockCallback({
+      data: {
+        type: SHELL_EVENTS.Version1.GET_STORAGE_ITEM,
+        value: {
+          key: 'Cockpit_SelectedLocale',
+          value: 'fr'
+        }
+      }
+    });
+  });
+
 });

src/ShellSdk.ts

@@ -278,11 +278,21 @@ export class ShellSdk {
 
     if (!!subscribers) {
       for (const subscriber of subscribers) {
-        subscriber(
-          payload.value,
-          event.origin,
-          payload.type == SHELL_EVENTS.Version1.SET_VIEW_STATE ? null : payload.from
-        );
+        if (payload.type == SHELL_EVENTS.Version1.GET_STORAGE_ITEM) {
+          // different call for GET_STORAGE_ITEM to support legacy code (CPB-47059)
+          subscriber(
+            payload.value.value,
+            payload.value.key,
+            event.origin,
+            payload.from
+          );
+        } else {
+          subscriber(
+            payload.value,
+            event.origin,
+            payload.type == SHELL_EVENTS.Version1.SET_VIEW_STATE ? null : payload.from
+          );
+        }
       }
     }