@instructure/quiz-core 17.53.1-rc.8 → 17.54.0

package/CHANGELOG.md

@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [17.54.0](https://gerrit.instructure.com/quizzes-ui/compare/v17.53.0...v17.54.0) (2023-05-10)
+
+
+### Bug Fixes
+
+* **lti.scrollToTop:** revert scrollToTop message handler ([a66e0a8](https://gerrit.instructure.com/quizzes-ui/commits/a66e0a855347e33e996f4271b0e07b83a29299a8))
+* **postMessage:** Add origin for postMessage responses ([0683954](https://gerrit.instructure.com/quizzes-ui/commits/0683954467e1e2f12b08a4d7e1561963926a789e))
+
+
+### Features
+
+* **browser:** Add ability to forward messages to parent ([9153cb6](https://gerrit.instructure.com/quizzes-ui/commits/9153cb6ed29bdd8be90cd5550c1e258aefe32fe2))
+* **postMessage:** fetch window size message handler ([ddb9475](https://gerrit.instructure.com/quizzes-ui/commits/ddb9475ba46e701f3cdb2d80cb34a0713c0916c1))
+* **postMessage:** put data and get data message handlers ([c274b52](https://gerrit.instructure.com/quizzes-ui/commits/c274b52f39f9c15a3b739c884aca98a576586755))
+* **postMessage:** scroll to top handler ([95e89c4](https://gerrit.instructure.com/quizzes-ui/commits/95e89c485d521d802218f90909273009f03d62bf))
+* **requestFullWindowLaunch:** Added requestFullWindowLaunch to postMessage support ([8868408](https://gerrit.instructure.com/quizzes-ui/commits/886840868d59b49c84d49c1b201b84c1474e7c93))
+
+
+
+
+
 # [17.53.0](https://gerrit.instructure.com/quizzes-ui/compare/v17.52.0...v17.53.0) (2023-04-25)
 
 

package/es/messages/postMessageService.js

@@ -5,6 +5,8 @@ import handleCapabilities from './subjectHandlers/lti.capabilities';
 import forwardMessage from "./subjectHandlers/forwardMessage.js";
 import handlePutData from './subjectHandlers/lti.put_data';
 import handleGetData from './subjectHandlers/lti.get_data';
+import handleFetchWindowSize from './subjectHandlers/lti.fetchWindowSize';
+import handleRequestFullWindowLaunch from "./subjectHandlers/requestFullWindowLaunch.js";
 
 var PostMessageService = function PostMessageService() {
   var _this = this;
@@ -46,28 +48,28 @@ var PostMessageService = function PostMessageService() {
     window.removeEventListener('message', _this.messageHandlerDispatcher);
   };
 
-  this.sendResponse = function (subject, data, sourceWindow) {
+  this.sendResponse = function (subject, data, sourceWindow, origin) {
     sourceWindow.postMessage(_objectSpread({
       subject: subject + '.response'
-    }, data));
+    }, data), origin);
   };
 
-  this.sendSuccessPostMessageResponse = function (subject, message, sourceWindow) {
+  this.sendSuccessPostMessageResponse = function (subject, message, sourceWindow, origin) {
     _this.sendResponse(subject, {
       message: message
-    }, sourceWindow);
+    }, sourceWindow, origin);
   };
 
-  this.sendErrorPostMessageResponse = function (subject, message, code, sourceWindow) {
-    _this.sendResponse(subject, _this.buildError(code, message), sourceWindow);
+  this.sendErrorPostMessageResponse = function (subject, message, code, sourceWindow, origin) {
+    _this.sendResponse(subject, _this.buildError(code, message), sourceWindow, origin);
   };
 
-  this.sendBadRequestErrorPostMessageResponse = function (subject, errorMessage, sourceWindow) {
-    _this.sendErrorPostMessageResponse(subject, errorMessage, _this.BAD_REQUEST_ERROR_CODE, sourceWindow);
+  this.sendBadRequestErrorPostMessageResponse = function (subject, errorMessage, sourceWindow, origin) {
+    _this.sendErrorPostMessageResponse(subject, errorMessage, _this.BAD_REQUEST_ERROR_CODE, sourceWindow, origin);
   };
 
-  this.sendGenericErrorPostMessageResponse = function (subject, errorMessage, sourceWindow) {
-    _this.sendErrorPostMessageResponse(subject, errorMessage, _this.GENERIC_ERROR_CODE, sourceWindow);
+  this.sendGenericErrorPostMessageResponse = function (subject, errorMessage, sourceWindow, origin) {
+    _this.sendErrorPostMessageResponse(subject, errorMessage, _this.GENERIC_ERROR_CODE, sourceWindow, origin);
   };
 
   this.buildError = function (code, message) {
@@ -83,6 +85,7 @@ var PostMessageService = function PostMessageService() {
   };
 
   this.handlerMap = new Map();
+  this.handlerMap.set('lti.fetchWindowSize', handleFetchWindowSize);
   this.handlerMap.set('lti.frameResize', handleFrameResize);
   this.handlerMap.set('lti.capabilities', handleCapabilities);
   this.handlerMap.set('lti.setUnloadMessage', forwardMessage);
@@ -91,6 +94,7 @@ var PostMessageService = function PostMessageService() {
   this.handlerMap.set('lti.showAlert', forwardMessage);
   this.handlerMap.set('lti.put_data', handlePutData);
   this.handlerMap.set('lti.get_data', handleGetData);
+  this.handlerMap.set('requestFullWindowLaunch', handleRequestFullWindowLaunch);
 };
 
 export { PostMessageService as default };

package/es/messages/subjectHandlers/forwardMessage.js

@@ -1,6 +1,6 @@
 var forwardMessage = function forwardMessage(event, _) {
   if (window !== window.parent) {
-    window.parent.postMessage(event.data, '*');
+    window.parent.postMessage(event === null || event === void 0 ? void 0 : event.data, '*');
   }
 };
 

package/es/messages/subjectHandlers/lti.capabilities.js

@@ -4,7 +4,7 @@ var handleCapabilities = function handleCapabilities(event, postMessageService)
     var supported_messages = postMessageService.capabilities();
     postMessageService.sendResponse('lti.capabilities', {
       supported_messages: supported_messages
-    }, sourceWindow);
+    }, sourceWindow, event.origin);
     return true;
   } catch (_unused) {
     return false;

package/es/messages/subjectHandlers/lti.fetchWindowSize.js

@@ -0,0 +1,16 @@
+var handleFetchWindowSize = function handleFetchWindowSize(event, postMessageService) {
+  var height = window.innerHeight;
+  var width = window.innerWidth;
+  var scrollY = window.scrollY;
+  var offset = 0;
+  var footer = 0;
+  postMessageService.sendSuccessPostMessageResponse('lti.fetchWindowSize', {
+    height: height,
+    width: width,
+    footer: footer,
+    scrollY: scrollY,
+    offset: offset
+  }, event.source, event.origin);
+};
+
+export default handleFetchWindowSize;

package/es/messages/subjectHandlers/lti.frameResize.js

@@ -6,7 +6,7 @@ var handleFrameResize = function handleFrameResize(event, postMessageService) {
   if (ltiIframe && event.data.height > 0) {
     ltiIframe.height = event.data.height + 'px';
     ltiIframe.style.height = event.data.height + 'px';
-    postMessageService.sendSuccessPostMessageResponse('lti.frameResize', void 0, event.source);
+    postMessageService.sendSuccessPostMessageResponse('lti.frameResize', void 0, event.source, event.origin);
   }
 };
 

package/es/messages/subjectHandlers/lti.get_data.js

@@ -19,7 +19,7 @@ var handleGetData = function handleGetData(event, postMessageService) {
   postMessageService.sendSuccessPostMessageResponse('lti.get_data', {
     key: key,
     value: value
-  }, event.source);
+  }, event.source, event.origin);
 };
 
 export default handleGetData;

package/es/messages/subjectHandlers/lti.put_data.js

@@ -9,12 +9,12 @@ var handlePutData = function handlePutData(event, postMessageService) {
       message_id = _event$data.message_id;
 
   if (!key) {
-    postMessageService.sendBadRequestErrorPostMessageResponse(SUBJECT, "Missing required 'key' field", event.source);
+    postMessageService.sendBadRequestErrorPostMessageResponse(SUBJECT, "Missing required 'key' field", event.source, event.origin);
     return true;
   }
 
   if (!message_id) {
-    postMessageService.sendBadRequestErrorPostMessageResponse(SUBJECT, 'Missing required "message_id" field', event.source);
+    postMessageService.sendBadRequestErrorPostMessageResponse(SUBJECT, 'Missing required "message_id" field', event.source, event.origin);
     return true;
   }
 
@@ -24,19 +24,19 @@ var handlePutData = function handlePutData(event, postMessageService) {
       postMessageService.sendSuccessPostMessageResponse(SUBJECT, {
         key: key,
         value: value
-      }, event.source);
+      }, event.source, event.origin);
     } catch (e) {
       if (e instanceof StorageExhaustionError) {
         var code = e.code;
         var message = e.message;
-        postMessageService.sendErrorPostMessageResponse(SUBJECT, message, code, event.source);
+        postMessageService.sendErrorPostMessageResponse(SUBJECT, message, code, event.source, event.origin);
       }
     }
   } else {
     localStorageAdapter.clearData(event.origin, key);
     postMessageService.sendResponse(SUBJECT, {
       key: key
-    }, event.source);
+    }, event.source, event.origin);
   }
 };
 

package/es/messages/subjectHandlers/requestFullWindowLaunch.js

@@ -0,0 +1,14 @@
+import forwardMessage from "./forwardMessage.js";
+export var SAME_WINDOW_LAUNCH_TYPE = 'same_window';
+
+var handleRequestFullWindowLaunch = function handleRequestFullWindowLaunch(event) {
+  var _event$data, _event$data$data;
+
+  if ((event === null || event === void 0 ? void 0 : (_event$data = event.data) === null || _event$data === void 0 ? void 0 : (_event$data$data = _event$data.data) === null || _event$data$data === void 0 ? void 0 : _event$data$data.launchType) === SAME_WINDOW_LAUNCH_TYPE) {
+    return;
+  }
+
+  forwardMessage(event);
+};
+
+export default handleRequestFullWindowLaunch;

package/lib/messages/postMessageService.js

@@ -21,6 +21,10 @@ var _lti3 = _interopRequireDefault(require("./subjectHandlers/lti.put_data"));
 
 var _lti4 = _interopRequireDefault(require("./subjectHandlers/lti.get_data"));
 
+var _lti5 = _interopRequireDefault(require("./subjectHandlers/lti.fetchWindowSize"));
+
+var _requestFullWindowLaunch = _interopRequireDefault(require("./subjectHandlers/requestFullWindowLaunch.js"));
+
 var PostMessageService = function PostMessageService() {
   var _this = this;
 
@@ -60,28 +64,28 @@ var PostMessageService = function PostMessageService() {
     window.removeEventListener('message', _this.messageHandlerDispatcher);
   };
 
-  this.sendResponse = function (subject, data, sourceWindow) {
+  this.sendResponse = function (subject, data, sourceWindow, origin) {
     sourceWindow.postMessage((0, _objectSpread2.default)({
       subject: subject + '.response'
-    }, data));
+    }, data), origin);
   };
 
-  this.sendSuccessPostMessageResponse = function (subject, message, sourceWindow) {
+  this.sendSuccessPostMessageResponse = function (subject, message, sourceWindow, origin) {
     _this.sendResponse(subject, {
       message: message
-    }, sourceWindow);
+    }, sourceWindow, origin);
   };
 
-  this.sendErrorPostMessageResponse = function (subject, message, code, sourceWindow) {
-    _this.sendResponse(subject, _this.buildError(code, message), sourceWindow);
+  this.sendErrorPostMessageResponse = function (subject, message, code, sourceWindow, origin) {
+    _this.sendResponse(subject, _this.buildError(code, message), sourceWindow, origin);
   };
 
-  this.sendBadRequestErrorPostMessageResponse = function (subject, errorMessage, sourceWindow) {
-    _this.sendErrorPostMessageResponse(subject, errorMessage, _this.BAD_REQUEST_ERROR_CODE, sourceWindow);
+  this.sendBadRequestErrorPostMessageResponse = function (subject, errorMessage, sourceWindow, origin) {
+    _this.sendErrorPostMessageResponse(subject, errorMessage, _this.BAD_REQUEST_ERROR_CODE, sourceWindow, origin);
   };
 
-  this.sendGenericErrorPostMessageResponse = function (subject, errorMessage, sourceWindow) {
-    _this.sendErrorPostMessageResponse(subject, errorMessage, _this.GENERIC_ERROR_CODE, sourceWindow);
+  this.sendGenericErrorPostMessageResponse = function (subject, errorMessage, sourceWindow, origin) {
+    _this.sendErrorPostMessageResponse(subject, errorMessage, _this.GENERIC_ERROR_CODE, sourceWindow, origin);
   };
 
   this.buildError = function (code, message) {
@@ -97,6 +101,7 @@ var PostMessageService = function PostMessageService() {
   };
 
   this.handlerMap = new Map();
+  this.handlerMap.set('lti.fetchWindowSize', _lti5.default);
   this.handlerMap.set('lti.frameResize', _lti.default);
   this.handlerMap.set('lti.capabilities', _lti2.default);
   this.handlerMap.set('lti.setUnloadMessage', _forwardMessage.default);
@@ -105,6 +110,7 @@ var PostMessageService = function PostMessageService() {
   this.handlerMap.set('lti.showAlert', _forwardMessage.default);
   this.handlerMap.set('lti.put_data', _lti3.default);
   this.handlerMap.set('lti.get_data', _lti4.default);
+  this.handlerMap.set('requestFullWindowLaunch', _requestFullWindowLaunch.default);
 };
 
 exports.default = PostMessageService;

package/lib/messages/subjectHandlers/forwardMessage.js

@@ -7,7 +7,7 @@ exports.default = void 0;
 
 var forwardMessage = function forwardMessage(event, _) {
   if (window !== window.parent) {
-    window.parent.postMessage(event.data, '*');
+    window.parent.postMessage(event === null || event === void 0 ? void 0 : event.data, '*');
   }
 };
 

package/lib/messages/subjectHandlers/lti.capabilities.js

@@ -11,7 +11,7 @@ var handleCapabilities = function handleCapabilities(event, postMessageService)
     var supported_messages = postMessageService.capabilities();
     postMessageService.sendResponse('lti.capabilities', {
       supported_messages: supported_messages
-    }, sourceWindow);
+    }, sourceWindow, event.origin);
     return true;
   } catch (_unused) {
     return false;

package/lib/messages/subjectHandlers/lti.fetchWindowSize.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var handleFetchWindowSize = function handleFetchWindowSize(event, postMessageService) {
+  var height = window.innerHeight;
+  var width = window.innerWidth;
+  var scrollY = window.scrollY;
+  var offset = 0;
+  var footer = 0;
+  postMessageService.sendSuccessPostMessageResponse('lti.fetchWindowSize', {
+    height: height,
+    width: width,
+    footer: footer,
+    scrollY: scrollY,
+    offset: offset
+  }, event.source, event.origin);
+};
+
+var _default = handleFetchWindowSize;
+exports.default = _default;

package/lib/messages/subjectHandlers/lti.frameResize.js

@@ -13,7 +13,7 @@ var handleFrameResize = function handleFrameResize(event, postMessageService) {
   if (ltiIframe && event.data.height > 0) {
     ltiIframe.height = event.data.height + 'px';
     ltiIframe.style.height = event.data.height + 'px';
-    postMessageService.sendSuccessPostMessageResponse('lti.frameResize', void 0, event.source);
+    postMessageService.sendSuccessPostMessageResponse('lti.frameResize', void 0, event.source, event.origin);
   }
 };
 

package/lib/messages/subjectHandlers/lti.get_data.js

@@ -27,7 +27,7 @@ var handleGetData = function handleGetData(event, postMessageService) {
   postMessageService.sendSuccessPostMessageResponse('lti.get_data', {
     key: key,
     value: value
-  }, event.source);
+  }, event.source, event.origin);
 };
 
 var _default = handleGetData;

package/lib/messages/subjectHandlers/lti.put_data.js

@@ -20,12 +20,12 @@ var handlePutData = function handlePutData(event, postMessageService) {
       message_id = _event$data.message_id;
 
   if (!key) {
-    postMessageService.sendBadRequestErrorPostMessageResponse(SUBJECT, "Missing required 'key' field", event.source);
+    postMessageService.sendBadRequestErrorPostMessageResponse(SUBJECT, "Missing required 'key' field", event.source, event.origin);
     return true;
   }
 
   if (!message_id) {
-    postMessageService.sendBadRequestErrorPostMessageResponse(SUBJECT, 'Missing required "message_id" field', event.source);
+    postMessageService.sendBadRequestErrorPostMessageResponse(SUBJECT, 'Missing required "message_id" field', event.source, event.origin);
     return true;
   }
 
@@ -36,12 +36,12 @@ var handlePutData = function handlePutData(event, postMessageService) {
       postMessageService.sendSuccessPostMessageResponse(SUBJECT, {
         key: key,
         value: value
-      }, event.source);
+      }, event.source, event.origin);
     } catch (e) {
       if (e instanceof _StorageExhaustionError.default) {
         var code = e.code;
         var message = e.message;
-        postMessageService.sendErrorPostMessageResponse(SUBJECT, message, code, event.source);
+        postMessageService.sendErrorPostMessageResponse(SUBJECT, message, code, event.source, event.origin);
       }
     }
   } else {
@@ -49,7 +49,7 @@ var handlePutData = function handlePutData(event, postMessageService) {
 
     postMessageService.sendResponse(SUBJECT, {
       key: key
-    }, event.source);
+    }, event.source, event.origin);
   }
 };
 

package/lib/messages/subjectHandlers/requestFullWindowLaunch.js

@@ -0,0 +1,26 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.SAME_WINDOW_LAUNCH_TYPE = void 0;
+
+var _forwardMessage = _interopRequireDefault(require("./forwardMessage.js"));
+
+var SAME_WINDOW_LAUNCH_TYPE = 'same_window';
+exports.SAME_WINDOW_LAUNCH_TYPE = SAME_WINDOW_LAUNCH_TYPE;
+
+var handleRequestFullWindowLaunch = function handleRequestFullWindowLaunch(event) {
+  var _event$data, _event$data$data;
+
+  if ((event === null || event === void 0 ? void 0 : (_event$data = event.data) === null || _event$data === void 0 ? void 0 : (_event$data$data = _event$data.data) === null || _event$data$data === void 0 ? void 0 : _event$data$data.launchType) === SAME_WINDOW_LAUNCH_TYPE) {
+    return;
+  }
+
+  (0, _forwardMessage.default)(event);
+};
+
+var _default = handleRequestFullWindowLaunch;
+exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/quiz-core",
-  "version": "17.53.1-rc.8+a66e0a855",
+  "version": "17.54.0",
   "license": "MIT",
   "description": "The Quiz React SDK by Instructure Inc.",
   "author": "Instructure, Inc. Engineering and Product Design",
@@ -41,11 +41,11 @@
   ],
   "dependencies": {
     "@instructure/outcomes-ui": "^2.1.7",
-    "@instructure/quiz-common": "17.53.1-rc.8+a66e0a855",
-    "@instructure/quiz-i18n": "17.53.1-rc.8+a66e0a855",
-    "@instructure/quiz-interactions": "17.53.1-rc.8+a66e0a855",
-    "@instructure/quiz-number-input": "17.53.1-rc.8+a66e0a855",
-    "@instructure/quiz-rce": "17.53.1-rc.8+a66e0a855",
+    "@instructure/quiz-common": "^17.54.0",
+    "@instructure/quiz-i18n": "^17.54.0",
+    "@instructure/quiz-interactions": "^17.54.0",
+    "@instructure/quiz-number-input": "^17.54.0",
+    "@instructure/quiz-rce": "^17.54.0",
     "@instructure/ui-a11y-content": "^7.20.0",
     "@instructure/ui-alerts": "^7.20.0",
     "@instructure/ui-avatar": "^7.20.0",
@@ -106,7 +106,7 @@
     "eventemitter3": "^3.1.0",
     "humps": "^2.0.0",
     "immutable": "^3.8.1",
-    "instructure-validations": "17.53.1-rc.8+a66e0a855",
+    "instructure-validations": "^17.54.0",
     "ipaddr.js": "^1.5.4",
     "isomorphic-fetch": "^2.2.0",
     "isuuid": "^0.1.0",
@@ -137,7 +137,7 @@
     "uuid": "^3.2.1"
   },
   "devDependencies": {
-    "@instructure/quiz-scripts": "17.53.0",
+    "@instructure/quiz-scripts": "^17.54.0",
     "@instructure/ui-axe-check": "^7.20.0",
     "@instructure/ui-babel-preset": "^7.20.0",
     "@instructure/ui-karma-config": "^7.20.0",
@@ -156,7 +156,7 @@
     "intl": "^1.2.4",
     "jquery": "^2.2.3",
     "most-subject": "^5.3.0",
-    "quiz-presets": "17.53.1-rc.8+a66e0a855",
+    "quiz-presets": "^17.54.0",
     "react": "^16.8.6",
     "react-addons-test-utils": "^15.6.2",
     "react-dom": "^16.8.6",
@@ -172,5 +172,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a66e0a855347e33e996f4271b0e07b83a29299a8"
+  "gitHead": "139e5919b90ee02eaa3275f59e2229d6a43de22f"
 }