studiokit-scaffolding-js 4.5.12 → 4.6.0-next.1.2

package/lib/components/Error.d.ts

@@ -0,0 +1,4 @@
+import { FunctionComponent } from 'react';
+import { RouteComponentProps } from 'react-router';
+declare const Error: FunctionComponent<RouteComponentProps>;
+export default Error;

package/lib/components/Error.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var query_string_1 = require("query-string");
+var react_1 = __importDefault(require("react"));
+var react_bootstrap_1 = require("react-bootstrap");
+var react_helmet_1 = __importDefault(require("react-helmet"));
+var lockDownBrowser_1 = require("../utils/lockDownBrowser");
+var ExitButton_1 = require("./LockDownBrowser/ExitButton");
+var Error = function (props) {
+    var message = query_string_1.parse(props.location.search).message;
+    var lockDownBrowserInfo = lockDownBrowser_1.getLockDownBrowserInfo();
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement(react_helmet_1.default, { title: "Error" }),
+        react_1.default.createElement(react_bootstrap_1.Container, null,
+            react_1.default.createElement(react_bootstrap_1.Row, null,
+                react_1.default.createElement(react_bootstrap_1.Col, { md: 8 },
+                    react_1.default.createElement("h1", null, "Uh oh!"),
+                    message && react_1.default.createElement("blockquote", null, message),
+                    react_1.default.createElement("p", null, " Sorry, but it looks like something went wrong while processing your request."),
+                    react_1.default.createElement("p", null,
+                        "If you have any questions or concerns please contact us at",
+                        ' ',
+                        react_1.default.createElement("a", { href: "mailto:tlt@purdue.edu" }, "tlt@purdue.edu")),
+                    lockDownBrowserInfo.isClientLockDownBrowser && react_1.default.createElement(ExitButton_1.LockDownBrowserExitButton, null))))));
+};
+exports.default = Error;

package/lib/components/LockDownBrowser/Check.d.ts

@@ -0,0 +1,3 @@
+import { FunctionComponent } from 'react';
+declare const LockDownBrowserCheck: FunctionComponent;
+export default LockDownBrowserCheck;

package/lib/components/LockDownBrowser/Check.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Cancel_1 = __importDefault(require("@material-ui/icons/Cancel"));
+var CheckCircle_1 = __importDefault(require("@material-ui/icons/CheckCircle"));
+var react_1 = __importDefault(require("react"));
+var react_bootstrap_1 = require("react-bootstrap");
+var react_helmet_1 = require("react-helmet");
+var lockDownBrowser_1 = require("../../utils/lockDownBrowser");
+var ExitButton_1 = require("./ExitButton");
+var LockDownBrowserCheck = function () {
+    var lockDownBrowserInfo = lockDownBrowser_1.getLockDownBrowserInfo();
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement(react_helmet_1.Helmet, { title: "LockDown Browser Check" }),
+        react_1.default.createElement(react_bootstrap_1.Container, { className: "main-content" },
+            react_1.default.createElement(react_bootstrap_1.Row, null,
+                react_1.default.createElement(react_bootstrap_1.Col, { xs: 12 },
+                    react_1.default.createElement("h1", null, lockDownBrowserInfo.isClientLockDownBrowser ? (react_1.default.createElement(react_1.default.Fragment, null,
+                        react_1.default.createElement(CheckCircle_1.default, { className: "fill-green f1 mr2" }),
+                        " Success! You are using LockDown Browser.")) : (react_1.default.createElement(react_1.default.Fragment, null,
+                        react_1.default.createElement(Cancel_1.default, { className: "fill-red f1 mr2" }),
+                        "Oops! You are not using LockDown Browser."))),
+                    lockDownBrowserInfo.isClientLockDownBrowser && (react_1.default.createElement(react_1.default.Fragment, null,
+                        react_1.default.createElement("p", null, "You\u2019re all set to use LockDown Browser for your assessments. You can close LockDown Browser when you\u2019re ready."),
+                        react_1.default.createElement("dl", { className: "f6" },
+                            lockDownBrowserInfo.buildId && (react_1.default.createElement(react_1.default.Fragment, null,
+                                react_1.default.createElement("dt", null, "Build Id"),
+                                react_1.default.createElement("dd", null, lockDownBrowserInfo.buildId))),
+                            react_1.default.createElement("dt", null, "Platform"),
+                            react_1.default.createElement("dd", null, lockDownBrowserInfo.buildDateWindows
+                                ? 'Windows'
+                                : lockDownBrowserInfo.buildDateMac
+                                    ? 'macOS'
+                                    : 'iPad'),
+                            react_1.default.createElement("dt", null, "Build Date"),
+                            react_1.default.createElement("dd", null, lockDownBrowserInfo.buildDateWindows ||
+                                lockDownBrowserInfo.buildDateMac ||
+                                lockDownBrowserInfo.buildDateIpad)),
+                        react_1.default.createElement(ExitButton_1.LockDownBrowserExitButton, null))))))));
+};
+exports.default = LockDownBrowserCheck;

package/lib/components/LockDownBrowser/ExitButton.d.ts

@@ -0,0 +1,2 @@
+import { FunctionComponent } from 'react';
+export declare const LockDownBrowserExitButton: FunctionComponent;

package/lib/components/LockDownBrowser/ExitButton.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LockDownBrowserExitButton = void 0;
+var Button_1 = __importDefault(require("@material-ui/core/Button"));
+var react_1 = __importDefault(require("react"));
+var react_router_1 = require("react-router");
+var constants_1 = require("../../constants");
+var LockDownBrowserExitButton = function () {
+    var history = react_router_1.useHistory();
+    var location = react_router_1.useLocation();
+    return (react_1.default.createElement(Button_1.default, { className: "btn-primary mb4", onClick: function () {
+            return history.push({
+                pathname: location.pathname,
+                search: "?" + constants_1.LOCKDOWN_BROWSER_KEY.EXIT_BROWSER + "=" + constants_1.LOCKDOWN_BROWSER_TRUE
+            });
+        } }, "Close LockDown Browser"));
+};
+exports.LockDownBrowserExitButton = LockDownBrowserExitButton;

package/lib/components/LockDownBrowser/Launch.d.ts

@@ -0,0 +1,4 @@
+import { FunctionComponent } from 'react';
+import { RouteComponentProps } from 'react-router';
+declare const LockDownBrowserLaunch: FunctionComponent<RouteComponentProps>;
+export default LockDownBrowserLaunch;

package/lib/components/LockDownBrowser/Launch.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var query_string_1 = require("query-string");
+var react_1 = __importDefault(require("react"));
+var react_2 = require("react");
+var react_helmet_1 = require("react-helmet");
+var constants_1 = require("../../constants");
+var lockDownBrowser_1 = require("../../utils/lockDownBrowser");
+var Loading_1 = __importDefault(require("../Loading"));
+var errorPath = "/error?" + query_string_1.stringify({ message: constants_1.LOCKDOWN_BROWSER_LAUNCH_ERROR });
+var LockDownBrowserLaunch = function (props) {
+    var search = query_string_1.parse(props.location.search);
+    var redirectPath = search.redirectPath;
+    var reloadCount = search.reloadCount ? parseInt("" + search.reloadCount) : 0;
+    // this effect will run once after this component renders
+    // allow LockDown Browser to set its cookies
+    react_2.useEffect(function () {
+        var lockDownBrowserInfo = lockDownBrowser_1.getLockDownBrowserInfo();
+        // redirect path is required and must be a single string
+        if (!redirectPath || typeof redirectPath !== 'string') {
+            console.error('redirectPath is undefined');
+            window.location.href = errorPath;
+            return;
+        }
+        // if LDB cookies are set, redirect to the final path
+        if (lockDownBrowserInfo.isClientLockDownBrowser) {
+            window.location.href = redirectPath;
+            return;
+        }
+        // increment reloadCount and reload the current url fully
+        // try 3 times before going to the error route
+        if (reloadCount < 2) {
+            console.info('could not determine if client is LockDown Browser, reloading');
+            search.reloadCount = "" + reloadCount++;
+            window.location.href =
+                window.location.protocol +
+                    '//' +
+                    window.location.host +
+                    window.location.pathname +
+                    '?' +
+                    query_string_1.stringify(search);
+            return;
+        }
+        window.location.href = errorPath;
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement(react_helmet_1.Helmet, { title: "LockDown Browser Launch" }),
+        react_1.default.createElement(Loading_1.default, null)));
+};
+exports.default = LockDownBrowserLaunch;

package/lib/constants/index.d.ts

@@ -6,3 +6,4 @@ export * from './notificationType';
 export * from './baseRole';
 export * from './shard';
 export * from './tier';
+export * from './lockDownBrowser';

package/lib/constants/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./notificationType"), exports);
 __exportStar(require("./baseRole"), exports);
 __exportStar(require("./shard"), exports);
 __exportStar(require("./tier"), exports);
+__exportStar(require("./lockDownBrowser"), exports);

package/lib/constants/lockDownBrowser.d.ts

@@ -0,0 +1,20 @@
+export declare enum LOCKDOWN_BROWSER_KEY {
+    /** Cookie set by LDB to claim it is LDB. */
+    CLIENT_IS_LOCK_DOWN_BROWSER = "rldbci",
+    /** Cookie set by LDB containing the client build identifier. */
+    BUILD_ID = "rldbid",
+    /** Cookie set by LDB containing the build date, if the client is on windows. */
+    BUILD_DATE_WINDOWS = "rldbbdw",
+    /** Cookie set by LDB containing the build date, if the client is on mac. */
+    BUILD_DATE_MAC = "rldbbdm",
+    /** Cookie set by LDB containing the build date, if the client is on iPad. */
+    BUILD_DATE_IPAD = "rldbbdi",
+    /** Query param to direct LDB to close itself */
+    EXIT_BROWSER = "rldbxb"
+}
+export declare const LOCKDOWN_BROWSER_TRUE = "1";
+export declare enum LOCKDOWN_BROWSER_PATH {
+    LAUNCH = "ldb-launch",
+    CHECK = "ldb-check"
+}
+export declare const LOCKDOWN_BROWSER_LAUNCH_ERROR = "A LockDown Browser session could not be started. Please close the browser and try again.";

package/lib/constants/lockDownBrowser.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOCKDOWN_BROWSER_LAUNCH_ERROR = exports.LOCKDOWN_BROWSER_PATH = exports.LOCKDOWN_BROWSER_TRUE = exports.LOCKDOWN_BROWSER_KEY = void 0;
+var LOCKDOWN_BROWSER_KEY;
+(function (LOCKDOWN_BROWSER_KEY) {
+    /** Cookie set by LDB to claim it is LDB. */
+    LOCKDOWN_BROWSER_KEY["CLIENT_IS_LOCK_DOWN_BROWSER"] = "rldbci";
+    /** Cookie set by LDB containing the client build identifier. */
+    LOCKDOWN_BROWSER_KEY["BUILD_ID"] = "rldbid";
+    /** Cookie set by LDB containing the build date, if the client is on windows. */
+    LOCKDOWN_BROWSER_KEY["BUILD_DATE_WINDOWS"] = "rldbbdw";
+    /** Cookie set by LDB containing the build date, if the client is on mac. */
+    LOCKDOWN_BROWSER_KEY["BUILD_DATE_MAC"] = "rldbbdm";
+    /** Cookie set by LDB containing the build date, if the client is on iPad. */
+    LOCKDOWN_BROWSER_KEY["BUILD_DATE_IPAD"] = "rldbbdi";
+    /** Query param to direct LDB to close itself */
+    LOCKDOWN_BROWSER_KEY["EXIT_BROWSER"] = "rldbxb";
+})(LOCKDOWN_BROWSER_KEY = exports.LOCKDOWN_BROWSER_KEY || (exports.LOCKDOWN_BROWSER_KEY = {}));
+exports.LOCKDOWN_BROWSER_TRUE = '1';
+var LOCKDOWN_BROWSER_PATH;
+(function (LOCKDOWN_BROWSER_PATH) {
+    LOCKDOWN_BROWSER_PATH["LAUNCH"] = "ldb-launch";
+    LOCKDOWN_BROWSER_PATH["CHECK"] = "ldb-check";
+})(LOCKDOWN_BROWSER_PATH = exports.LOCKDOWN_BROWSER_PATH || (exports.LOCKDOWN_BROWSER_PATH = {}));
+exports.LOCKDOWN_BROWSER_LAUNCH_ERROR = 'A LockDown Browser session could not be started. Please close the browser and try again.';

package/lib/redux/sagas/lockDownBrowserErrorSaga.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="connected-react-router" />
+export default function lockDownBrowserSaga(runIndefinitely?: boolean): Generator<import("redux-saga/effects").TakeEffect | import("redux-saga/effects").PutEffect<import("connected-react-router").CallHistoryMethodAction<[import("history").LocationDescriptorObject<unknown>]>>, void, unknown>;

package/lib/redux/sagas/lockDownBrowserErrorSaga.js

@@ -0,0 +1,81 @@
+"use strict";
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var connected_react_router_1 = require("connected-react-router");
+var query_string_1 = require("query-string");
+var effects_1 = require("redux-saga/effects");
+var studiokit_net_js_1 = require("studiokit-net-js");
+function lockDownBrowserSaga(runIndefinitely) {
+    var _loop_1;
+    if (runIndefinitely === void 0) { runIndefinitely = true; }
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                _loop_1 = function () {
+                    var message;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                message = '';
+                                // wait for any LDB error
+                                return [4 /*yield*/, effects_1.take(function (action) {
+                                        var _a;
+                                        message = (_a = action === null || action === void 0 ? void 0 : action.errorData) === null || _a === void 0 ? void 0 : _a.message;
+                                        return (action === null || action === void 0 ? void 0 : action.type) === studiokit_net_js_1.NET_ACTION.TRY_FETCH_FAILED && !!(message === null || message === void 0 ? void 0 : message.includes('LockDown Browser'));
+                                    })
+                                    // redirect to known LDB error route
+                                ];
+                            case 1:
+                                // wait for any LDB error
+                                _a.sent();
+                                // redirect to known LDB error route
+                                return [4 /*yield*/, effects_1.put(connected_react_router_1.push({
+                                        pathname: '/error',
+                                        search: query_string_1.stringify({ message: message })
+                                    }))];
+                            case 2:
+                                // redirect to known LDB error route
+                                _a.sent();
+                                return [2 /*return*/];
+                        }
+                    });
+                };
+                _a.label = 1;
+            case 1: return [5 /*yield**/, _loop_1()];
+            case 2:
+                _a.sent();
+                _a.label = 3;
+            case 3:
+                if (runIndefinitely) return [3 /*break*/, 1];
+                _a.label = 4;
+            case 4: return [2 /*return*/];
+        }
+    });
+}
+exports.default = lockDownBrowserSaga;

package/lib/redux/sagas/rootSaga.js

@@ -76,6 +76,7 @@ var configurationSaga_1 = __importDefault(require("./configurationSaga"));
 var errorSaga_1 = __importDefault(require("./errorSaga"));
 var identityProviderSaga_1 = __importDefault(require("./identityProviderSaga"));
 var initialDataLoadSaga_1 = __importDefault(require("./initialDataLoadSaga"));
+var lockDownBrowserErrorSaga_1 = __importDefault(require("./lockDownBrowserErrorSaga"));
 var postLoginDataSaga_1 = __importDefault(require("./postLoginDataSaga"));
 var postLoginRedirectSaga_1 = __importDefault(require("./postLoginRedirectSaga"));
 var sentrySaga_1 = __importDefault(require("./sentrySaga"));
@@ -89,7 +90,7 @@ exports.setOtherDependentSagas = setOtherDependentSagas;
 function dependentSagas() {
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, effects_1.all(__assign({ noStoreSaga: studiokit_net_js_1.sagas.noStoreSaga(), configurationSaga: configurationSaga_1.default(), caliperSaga: caliperSaga_1.default(), sentrySaga: sentrySaga_1.default(), initialDataLoadSaga: initialDataLoadSaga_1.default(), identityProviderSaga: identityProviderSaga_1.default(), postLoginRedirectSaga: postLoginRedirectSaga_1.default(), postLoginDataSaga: postLoginDataSaga_1.default(), clockOffsetSaga: clockOffsetSaga_1.default() }, otherDependentSagas))];
+            case 0: return [4 /*yield*/, effects_1.all(__assign({ noStoreSaga: studiokit_net_js_1.sagas.noStoreSaga(), configurationSaga: configurationSaga_1.default(), caliperSaga: caliperSaga_1.default(), sentrySaga: sentrySaga_1.default(), initialDataLoadSaga: initialDataLoadSaga_1.default(), identityProviderSaga: identityProviderSaga_1.default(), postLoginRedirectSaga: postLoginRedirectSaga_1.default(), postLoginDataSaga: postLoginDataSaga_1.default(), clockOffsetSaga: clockOffsetSaga_1.default(), lockDownBrowserErrorSaga: lockDownBrowserErrorSaga_1.default() }, otherDependentSagas))];
             case 1:
                 _a.sent();
                 return [2 /*return*/];

package/lib/utils/cookies.d.ts

@@ -0,0 +1,2 @@
+/** Get the contents of `document.cookie` as a Record with string keys and values. */
+export declare const getCookies: () => Record<string, string>;

package/lib/utils/cookies.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCookies = void 0;
+/** Get the contents of `document.cookie` as a Record with string keys and values. */
+var getCookies = function () {
+    var cookies = {};
+    if (document.cookie && document.cookie !== '') {
+        var cookieStrings = document.cookie.split(';');
+        cookieStrings.forEach(function (cookieString) {
+            var cookieParts = cookieString.split('=');
+            var name = decodeURIComponent(cookieParts[0].replace(/^ /, ''));
+            var value = decodeURIComponent(cookieParts[1]);
+            cookies[name] = value;
+        });
+    }
+    return cookies;
+};
+exports.getCookies = getCookies;

package/lib/utils/lockDownBrowser.d.ts

@@ -0,0 +1,8 @@
+export interface LockDownBrowserInfo {
+    isClientLockDownBrowser: boolean;
+    buildId?: string;
+    buildDateWindows?: string;
+    buildDateMac?: string;
+    buildDateIpad?: string;
+}
+export declare const getLockDownBrowserInfo: () => LockDownBrowserInfo;

package/lib/utils/lockDownBrowser.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLockDownBrowserInfo = void 0;
+var lockDownBrowser_1 = require("../constants/lockDownBrowser");
+var cookies_1 = require("./cookies");
+var getLockDownBrowserInfo = function () {
+    var cookies = cookies_1.getCookies();
+    return {
+        isClientLockDownBrowser: cookies[lockDownBrowser_1.LOCKDOWN_BROWSER_KEY.CLIENT_IS_LOCK_DOWN_BROWSER] === lockDownBrowser_1.LOCKDOWN_BROWSER_TRUE,
+        buildId: cookies[lockDownBrowser_1.LOCKDOWN_BROWSER_KEY.BUILD_ID],
+        buildDateWindows: cookies[lockDownBrowser_1.LOCKDOWN_BROWSER_KEY.BUILD_DATE_WINDOWS],
+        buildDateMac: cookies[lockDownBrowser_1.LOCKDOWN_BROWSER_KEY.BUILD_DATE_MAC],
+        buildDateIpad: cookies[lockDownBrowser_1.LOCKDOWN_BROWSER_KEY.BUILD_DATE_IPAD]
+    };
+};
+exports.getLockDownBrowserInfo = getLockDownBrowserInfo;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "studiokit-scaffolding-js",
-	"version": "4.5.12",
+	"version": "4.6.0-next.1.2",
 	"description": "Common scaffolding for Studio apps at Purdue",
 	"repository": "https://gitlab.com/purdue-informatics/studiokit/studiokit-scaffolding-js",
 	"license": "MIT",