dce-reactkit 2.0.3 → 2.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/lib/components/AppWrapper.d.ts +19 -0
  2. package/lib/components/AppWrapper.js +127 -0
  3. package/lib/components/AppWrapper.js.map +1 -0
  4. package/{src → lib}/components/AppWrapper.tsx +61 -7
  5. package/lib/components/ErrorBox.d.ts +12 -0
  6. package/lib/components/ErrorBox.js +65 -0
  7. package/lib/components/ErrorBox.js.map +1 -0
  8. package/{src → lib}/components/ErrorBox.tsx +4 -1
  9. package/{src → lib}/components/LoadingSpinner.tsx +0 -0
  10. package/{src → lib}/components/Modal.tsx +0 -0
  11. package/{src → lib}/errors/ErrorWithCode.tsx +0 -0
  12. package/{src → lib}/helpers/abbreviate.tsx +0 -0
  13. package/{src → lib}/helpers/avg.tsx +0 -0
  14. package/{src → lib}/helpers/ceilToNumDecimals.tsx +0 -0
  15. package/{src → lib}/helpers/floorToNumDecimals.tsx +0 -0
  16. package/{src → lib}/helpers/forceNumIntoBounds.tsx +0 -0
  17. package/lib/helpers/handleError.d.ts +14 -0
  18. package/lib/helpers/handleError.js +54 -0
  19. package/lib/helpers/handleError.js.map +1 -0
  20. package/lib/helpers/handleError.ts +65 -0
  21. package/lib/helpers/handleSuccess.d.ts +8 -0
  22. package/lib/helpers/handleSuccess.js +20 -0
  23. package/lib/helpers/handleSuccess.js.map +1 -0
  24. package/lib/helpers/handleSuccess.ts +18 -0
  25. package/{src → lib}/helpers/padDecimalZeros.tsx +0 -0
  26. package/{src → lib}/helpers/padZerosLeft.tsx +0 -0
  27. package/lib/helpers/parseRequest.d.ts +21 -0
  28. package/lib/helpers/parseRequest.js +240 -0
  29. package/lib/helpers/parseRequest.js.map +1 -0
  30. package/lib/helpers/parseRequest.ts +299 -0
  31. package/{src → lib}/helpers/roundToNumDecimals.tsx +0 -0
  32. package/lib/helpers/showFatalError.d.ts +2 -0
  33. package/lib/helpers/showFatalError.js +5 -0
  34. package/lib/helpers/showFatalError.js.map +1 -0
  35. package/{src → lib}/helpers/showFatalError.tsx +0 -0
  36. package/{src → lib}/helpers/sum.tsx +0 -0
  37. package/lib/helpers/visitServerEndpoint.d.ts +7 -1
  38. package/lib/helpers/visitServerEndpoint.js +57 -6
  39. package/lib/helpers/visitServerEndpoint.js.map +1 -1
  40. package/lib/helpers/visitServerEndpoint.tsx +110 -0
  41. package/{src → lib}/helpers/waitMs.tsx +0 -0
  42. package/lib/types/ParamType.d.ts +17 -0
  43. package/lib/types/ParamType.js +21 -0
  44. package/lib/types/ParamType.js.map +1 -0
  45. package/lib/types/ParamType.ts +18 -0
  46. package/lib/types/ReactKitErrorCode.d.ts +5 -1
  47. package/lib/types/ReactKitErrorCode.js +4 -0
  48. package/lib/types/ReactKitErrorCode.js.map +1 -1
  49. package/{src → lib}/types/ReactKitErrorCode.tsx +4 -0
  50. package/{src → lib}/types/Variant.tsx +0 -0
  51. package/package.json +5 -2
  52. package/tsconfig.json +1 -1
  53. package/src/helpers/visitServerEndpoint.tsx +0 -59
@@ -0,0 +1,240 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ // Import caccl libs
7
+ var caccl_lti_1 = require("caccl-lti");
8
+ // Import shared types
9
+ var ReactKitErrorCode_1 = __importDefault(require("../types/ReactKitErrorCode"));
10
+ var ParamType_1 = __importDefault(require("../types/ParamType"));
11
+ // Import helpers
12
+ var handleError_1 = __importDefault(require("./handleError"));
13
+ /**
14
+ * Parse express request params and body
15
+ * @author Gabe Abrams
16
+ * @param opts object containing all arguments
17
+ * @param opts.req express request instance
18
+ * @param opts.res express response instance
19
+ * @param opts.params map of parameters that should be parsed out of the request
20
+ * @returns parsed params + user info from session (if it exists) or undefined
21
+ * if an error occurred
22
+ */
23
+ var parseRequest = function (opts) {
24
+ // Output
25
+ var output = {};
26
+ /*----------------------------------------*/
27
+ /* Parse Params */
28
+ /*----------------------------------------*/
29
+ // Process items one by one
30
+ var paramList = Object.entries(opts.params);
31
+ for (var i = 0; i < paramList.length; i++) {
32
+ var _a = paramList[i], name_1 = _a[0], type = _a[1];
33
+ // Find the value as a string
34
+ var value = (opts.req.params[name_1]
35
+ || opts.req.query[name_1]
36
+ || opts.req.body[name_1]);
37
+ // Parse
38
+ if (type === ParamType_1.default.Boolean || type === ParamType_1.default.BooleanOptional) {
39
+ // Boolean
40
+ // Handle case where value doesn't exist
41
+ if (value === undefined) {
42
+ if (type === ParamType_1.default.BooleanOptional) {
43
+ output[name_1] = undefined;
44
+ }
45
+ else {
46
+ return (0, handleError_1.default)(opts.res, {
47
+ message: "Parameter ".concat(name_1, " is required, but it was not included."),
48
+ code: ReactKitErrorCode_1.default.MissingParameter,
49
+ status: 422,
50
+ });
51
+ }
52
+ }
53
+ else {
54
+ // Value exists
55
+ // Simplify value
56
+ var simpleVal = (String(value)
57
+ .trim()
58
+ .toLowerCase());
59
+ // Parse
60
+ output[name_1] = ([
61
+ 'true',
62
+ 'yes',
63
+ 'y',
64
+ '1',
65
+ 't',
66
+ ].indexOf(simpleVal) >= 0);
67
+ }
68
+ }
69
+ else if (type === ParamType_1.default.Float || type === ParamType_1.default.FloatOptional) {
70
+ // Float
71
+ // Handle case where value doesn't exist
72
+ if (value === undefined) {
73
+ if (type === ParamType_1.default.FloatOptional) {
74
+ output[name_1] = undefined;
75
+ }
76
+ else {
77
+ return (0, handleError_1.default)(opts.res, {
78
+ message: "Parameter ".concat(name_1, " is required, but it was not included."),
79
+ code: ReactKitErrorCode_1.default.MissingParameter,
80
+ status: 422,
81
+ });
82
+ }
83
+ }
84
+ else if (!Number.isNaN(Number.parseFloat(String(value)))) {
85
+ // Value is a number
86
+ output[name_1] = Number.parseFloat(String(value));
87
+ }
88
+ else {
89
+ // Issue!
90
+ return (0, handleError_1.default)(opts.res, {
91
+ message: "Request data was malformed: ".concat(name_1, " was not a valid float."),
92
+ code: ReactKitErrorCode_1.default.InvalidParameter,
93
+ status: 422,
94
+ });
95
+ }
96
+ }
97
+ else if (type === ParamType_1.default.Int || type === ParamType_1.default.IntOptional) {
98
+ // Int
99
+ // Handle case where value doesn't exist
100
+ if (value === undefined) {
101
+ if (type === ParamType_1.default.IntOptional) {
102
+ output[name_1] = undefined;
103
+ }
104
+ else {
105
+ return (0, handleError_1.default)(opts.res, {
106
+ message: "Parameter ".concat(name_1, " is required, but it was not included."),
107
+ code: ReactKitErrorCode_1.default.MissingParameter,
108
+ status: 422,
109
+ });
110
+ }
111
+ }
112
+ else if (!Number.isNaN(Number.parseInt(String(value), 10))) {
113
+ // Value is a number
114
+ output[name_1] = Number.parseInt(String(value), 10);
115
+ }
116
+ else {
117
+ // Issue!
118
+ return (0, handleError_1.default)(opts.res, {
119
+ message: "Request data was malformed: ".concat(name_1, " was not a valid int."),
120
+ code: ReactKitErrorCode_1.default.InvalidParameter,
121
+ status: 422,
122
+ });
123
+ }
124
+ }
125
+ else if (type === ParamType_1.default.JSON || type === ParamType_1.default.JSONOptional) {
126
+ // Stringified JSON
127
+ // Handle case where value doesn't exist
128
+ if (value === undefined) {
129
+ if (type === ParamType_1.default.JSONOptional) {
130
+ output[name_1] = undefined;
131
+ }
132
+ else {
133
+ return (0, handleError_1.default)(opts.res, {
134
+ message: "Parameter ".concat(name_1, " is required, but it was not included."),
135
+ code: ReactKitErrorCode_1.default.MissingParameter,
136
+ status: 422,
137
+ });
138
+ }
139
+ }
140
+ else {
141
+ // Value exists
142
+ // Parse
143
+ try {
144
+ output[name_1] = JSON.parse(String(value));
145
+ }
146
+ catch (err) {
147
+ return (0, handleError_1.default)(opts.res, {
148
+ message: "Request data was malformed: ".concat(name_1, " was not a valid JSON payload."),
149
+ code: ReactKitErrorCode_1.default.InvalidParameter,
150
+ status: 422,
151
+ });
152
+ }
153
+ }
154
+ }
155
+ else if (type === ParamType_1.default.String || type === ParamType_1.default.StringOptional) {
156
+ // String
157
+ // Handle case where value doesn't exist
158
+ if (value === undefined) {
159
+ if (type === ParamType_1.default.StringOptional) {
160
+ output[name_1] = undefined;
161
+ }
162
+ else {
163
+ return (0, handleError_1.default)(opts.res, {
164
+ message: "Parameter ".concat(name_1, " is required, but it was not included."),
165
+ code: ReactKitErrorCode_1.default.MissingParameter,
166
+ status: 422,
167
+ });
168
+ }
169
+ }
170
+ else {
171
+ // Value exists
172
+ // Leave as is
173
+ output[name_1] = value;
174
+ }
175
+ }
176
+ else {
177
+ // No valid data type
178
+ return (0, handleError_1.default)(opts.res, {
179
+ message: "An internal error occurred: we could not determine the type of ".concat(name_1, "."),
180
+ code: ReactKitErrorCode_1.default.InvalidParameter,
181
+ status: 422,
182
+ });
183
+ }
184
+ }
185
+ /*----------------------------------------*/
186
+ /* Launch Info */
187
+ /*----------------------------------------*/
188
+ // Get launch info
189
+ var _b = (0, caccl_lti_1.getLaunchInfo)(opts.req), launched = _b.launched, launchInfo = _b.launchInfo;
190
+ if (!launched || !launchInfo) {
191
+ return (0, handleError_1.default)(opts.res, {
192
+ message: 'Your session has expired. Please refresh the page and try again.',
193
+ code: ReactKitErrorCode_1.default.SessionExpired,
194
+ status: 440,
195
+ });
196
+ }
197
+ // Error if user info cannot be found
198
+ if (!launchInfo.userId
199
+ || !launchInfo.userFirstName
200
+ || !launchInfo.userLastName
201
+ || (launchInfo.notInCourse
202
+ && !launchInfo.isAdmin)
203
+ || (!launchInfo.isTTM
204
+ && !launchInfo.isLearner
205
+ && !launchInfo.isAdmin)) {
206
+ return (0, handleError_1.default)(opts.res, {
207
+ message: 'Your session was invalid. Please refresh the page and try again.',
208
+ code: ReactKitErrorCode_1.default.SessionExpired,
209
+ status: 440,
210
+ });
211
+ }
212
+ // Add launch info to output
213
+ output.userId = launchInfo.userId;
214
+ output.userFirstName = launchInfo.userFirstName;
215
+ output.userLastName = launchInfo.userLastName;
216
+ output.isLearner = !!launchInfo.isLearner;
217
+ output.isTTM = !!launchInfo.isTTM;
218
+ output.isAdmin = !!launchInfo.isAdmin;
219
+ output.isWatchingInPrivate = !!(opts.req.session.isWatchingInPrivate);
220
+ /*----------------------------------------*/
221
+ /* Require Course Consistency */
222
+ /*----------------------------------------*/
223
+ // Make sure the user actually launched from the appropriate course
224
+ if (output.courseId
225
+ && launchInfo.courseId
226
+ && output.courseId !== launchInfo.courseId
227
+ && !output.isTTM
228
+ && !output.isAdmin) {
229
+ // Course of interest is not the launch course
230
+ return (0, handleError_1.default)(opts.res, {
231
+ message: 'You switched sessions by opening Immersive Classroom in another tab. Please refresh the page and try again.',
232
+ code: ReactKitErrorCode_1.default.WrongCourse,
233
+ status: 401,
234
+ });
235
+ }
236
+ // Return processed params
237
+ return output;
238
+ };
239
+ exports.default = parseRequest;
240
+ //# sourceMappingURL=parseRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"parseRequest.js","sourceRoot":"","sources":["../../src/helpers/parseRequest.ts"],"names":[],"mappings":";;;;;AAAA,oBAAoB;AACpB,uCAA0C;AAE1C,sBAAsB;AACtB,iFAA2D;AAC3D,iEAA2C;AAE3C,iBAAiB;AACjB,8DAAwC;AAExC;;;;;;;;;GASG;AACH,IAAM,YAAY,GAAG,UACnB,IAMC;IAED,SAAS;IAET,IAAM,MAAM,GAA2B,EAAE,CAAC;IAE1C,4CAA4C;IAC5C,4CAA4C;IAC5C,4CAA4C;IAE5C,2BAA2B;IAC3B,IAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACnC,IAAA,KAAe,SAAS,CAAC,CAAC,CAAC,EAA1B,MAAI,QAAA,EAAE,IAAI,QAAgB,CAAC;QAElC,6BAA6B;QAC7B,IAAM,KAAK,GAAG,CACZ,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAI,CAAC;eAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAI,CAAC;eACpB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAI,CAAC,CACvB,CAAC;QAEF,QAAQ;QACR,IAAI,IAAI,KAAK,mBAAS,CAAC,OAAO,IAAI,IAAI,KAAK,mBAAS,CAAC,eAAe,EAAE;YACpE,UAAU;YAEV,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,eAAe,EAAE;oBACtC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM;gBACL,eAAe;gBAEf,iBAAiB;gBACjB,IAAM,SAAS,GAAG,CAChB,MAAM,CAAC,KAAK,CAAC;qBACV,IAAI,EAAE;qBACN,WAAW,EAAE,CACjB,CAAC;gBAEF,QAAQ;gBACR,MAAM,CAAC,MAAI,CAAC,GAAG,CACb;oBACE,MAAM;oBACN,KAAK;oBACL,GAAG;oBACH,GAAG;oBACH,GAAG;iBACJ,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAC1B,CAAC;aACH;SACF;aAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,KAAK,IAAI,IAAI,KAAK,mBAAS,CAAC,aAAa,EAAE;YACvE,QAAQ;YAER,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,aAAa,EAAE;oBACpC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;gBAC1D,oBAAoB;gBACpB,MAAM,CAAC,MAAI,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;aACjD;iBAAM;gBACL,SAAS;gBACT,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;oBACE,OAAO,EAAE,sCAA+B,MAAI,4BAAyB;oBACrE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;oBACxC,MAAM,EAAE,GAAG;iBACZ,CACF,CAAC;aACH;SACF;aAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,GAAG,IAAI,IAAI,KAAK,mBAAS,CAAC,WAAW,EAAE;YACnE,MAAM;YAEN,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,WAAW,EAAE;oBAClC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE;gBAC5D,oBAAoB;gBACpB,MAAM,CAAC,MAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;aACnD;iBAAM;gBACL,SAAS;gBACT,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;oBACE,OAAO,EAAE,sCAA+B,MAAI,0BAAuB;oBACnE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;oBACxC,MAAM,EAAE,GAAG;iBACZ,CACF,CAAC;aACH;SACF;aAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,IAAI,IAAI,IAAI,KAAK,mBAAS,CAAC,YAAY,EAAE;YACrE,mBAAmB;YAEnB,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,YAAY,EAAE;oBACnC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM;gBACL,eAAe;gBAEf,QAAQ;gBACR,IAAI;oBACF,MAAM,CAAC,MAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;iBAC1C;gBAAC,OAAO,GAAG,EAAE;oBACZ,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,sCAA+B,MAAI,mCAAgC;wBAC5E,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;SACF;aAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,MAAM,IAAI,IAAI,KAAK,mBAAS,CAAC,cAAc,EAAE;YACzE,SAAS;YAET,wCAAwC;YACxC,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,IAAI,IAAI,KAAK,mBAAS,CAAC,cAAc,EAAE;oBACrC,MAAM,CAAC,MAAI,CAAC,GAAG,SAAS,CAAC;iBAC1B;qBAAM;oBACL,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;wBACE,OAAO,EAAE,oBAAa,MAAI,2CAAwC;wBAClE,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;wBACxC,MAAM,EAAE,GAAG;qBACZ,CACF,CAAC;iBACH;aACF;iBAAM;gBACL,eAAe;gBAEf,cAAc;gBACd,MAAM,CAAC,MAAI,CAAC,GAAG,KAAK,CAAC;aACtB;SACF;aAAM;YACL,qBAAqB;YACrB,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;gBACE,OAAO,EAAE,yEAAkE,MAAI,MAAG;gBAClF,IAAI,EAAE,2BAAiB,CAAC,gBAAgB;gBACxC,MAAM,EAAE,GAAG;aACZ,CACF,CAAC;SACH;KACF;IAED,4CAA4C;IAC5C,4CAA4C;IAC5C,4CAA4C;IAE5C,kBAAkB;IACZ,IAAA,KAA2B,IAAA,yBAAa,EAAC,IAAI,CAAC,GAAG,CAAC,EAAhD,QAAQ,cAAA,EAAE,UAAU,gBAA4B,CAAC;IACzD,IAAI,CAAC,QAAQ,IAAI,CAAC,UAAU,EAAE;QAC5B,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;YACE,OAAO,EAAE,kEAAkE;YAC3E,IAAI,EAAE,2BAAiB,CAAC,cAAc;YACtC,MAAM,EAAE,GAAG;SACZ,CACF,CAAC;KACH;IAED,qCAAqC;IACrC,IACE,CAAC,UAAU,CAAC,MAAM;WACf,CAAC,UAAU,CAAC,aAAa;WACzB,CAAC,UAAU,CAAC,YAAY;WACxB,CACD,UAAU,CAAC,WAAW;eACnB,CAAC,UAAU,CAAC,OAAO,CACvB;WACE,CACD,CAAC,UAAU,CAAC,KAAK;eACd,CAAC,UAAU,CAAC,SAAS;eACrB,CAAC,UAAU,CAAC,OAAO,CACvB,EACD;QACA,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;YACE,OAAO,EAAE,kEAAkE;YAC3E,IAAI,EAAE,2BAAiB,CAAC,cAAc;YACtC,MAAM,EAAE,GAAG;SACZ,CACF,CAAC;KACH;IAED,4BAA4B;IAC5B,MAAM,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;IAClC,MAAM,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;IAChD,MAAM,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;IAC9C,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC;IAC1C,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC;IAClC,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IACtC,MAAM,CAAC,mBAAmB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEtE,4CAA4C;IAC5C,4CAA4C;IAC5C,4CAA4C;IAE5C,mEAAmE;IACnE,IACE,MAAM,CAAC,QAAQ;WACZ,UAAU,CAAC,QAAQ;WACnB,MAAM,CAAC,QAAQ,KAAK,UAAU,CAAC,QAAQ;WACvC,CAAC,MAAM,CAAC,KAAK;WACb,CAAC,MAAM,CAAC,OAAO,EAClB;QACA,8CAA8C;QAC9C,OAAO,IAAA,qBAAW,EAChB,IAAI,CAAC,GAAG,EACR;YACE,OAAO,EAAE,6GAA6G;YACtH,IAAI,EAAE,2BAAiB,CAAC,WAAW;YACnC,MAAM,EAAE,GAAG;SACZ,CACF,CAAC;KACH;IAED,0BAA0B;IAC1B,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,kBAAe,YAAY,CAAC"}
@@ -0,0 +1,299 @@
1
+ // Import caccl libs
2
+ import { getLaunchInfo } from 'caccl-lti';
3
+
4
+ // Import shared types
5
+ import ReactKitErrorCode from '../types/ReactKitErrorCode';
6
+ import ParamType from '../types/ParamType';
7
+
8
+ // Import helpers
9
+ import handleError from './handleError';
10
+
11
+ /**
12
+ * Parse express request params and body
13
+ * @author Gabe Abrams
14
+ * @param opts object containing all arguments
15
+ * @param opts.req express request instance
16
+ * @param opts.res express response instance
17
+ * @param opts.params map of parameters that should be parsed out of the request
18
+ * @returns parsed params + user info from session (if it exists) or undefined
19
+ * if an error occurred
20
+ */
21
+ const parseRequest = (
22
+ opts: {
23
+ req: any,
24
+ res: any,
25
+ params: {
26
+ [k in string]: ParamType
27
+ },
28
+ },
29
+ ): ({ [k in string]: any } | undefined) => {
30
+ // Output
31
+
32
+ const output: { [k in string]: any } = {};
33
+
34
+ /*----------------------------------------*/
35
+ /* Parse Params */
36
+ /*----------------------------------------*/
37
+
38
+ // Process items one by one
39
+ const paramList = Object.entries(opts.params);
40
+ for (let i = 0; i < paramList.length; i++) {
41
+ const [name, type] = paramList[i];
42
+
43
+ // Find the value as a string
44
+ const value = (
45
+ opts.req.params[name]
46
+ || opts.req.query[name]
47
+ || opts.req.body[name]
48
+ );
49
+
50
+ // Parse
51
+ if (type === ParamType.Boolean || type === ParamType.BooleanOptional) {
52
+ // Boolean
53
+
54
+ // Handle case where value doesn't exist
55
+ if (value === undefined) {
56
+ if (type === ParamType.BooleanOptional) {
57
+ output[name] = undefined;
58
+ } else {
59
+ return handleError(
60
+ opts.res,
61
+ {
62
+ message: `Parameter ${name} is required, but it was not included.`,
63
+ code: ReactKitErrorCode.MissingParameter,
64
+ status: 422,
65
+ },
66
+ );
67
+ }
68
+ } else {
69
+ // Value exists
70
+
71
+ // Simplify value
72
+ const simpleVal = (
73
+ String(value)
74
+ .trim()
75
+ .toLowerCase()
76
+ );
77
+
78
+ // Parse
79
+ output[name] = (
80
+ [
81
+ 'true',
82
+ 'yes',
83
+ 'y',
84
+ '1',
85
+ 't',
86
+ ].indexOf(simpleVal) >= 0
87
+ );
88
+ }
89
+ } else if (type === ParamType.Float || type === ParamType.FloatOptional) {
90
+ // Float
91
+
92
+ // Handle case where value doesn't exist
93
+ if (value === undefined) {
94
+ if (type === ParamType.FloatOptional) {
95
+ output[name] = undefined;
96
+ } else {
97
+ return handleError(
98
+ opts.res,
99
+ {
100
+ message: `Parameter ${name} is required, but it was not included.`,
101
+ code: ReactKitErrorCode.MissingParameter,
102
+ status: 422,
103
+ },
104
+ );
105
+ }
106
+ } else if (!Number.isNaN(Number.parseFloat(String(value)))) {
107
+ // Value is a number
108
+ output[name] = Number.parseFloat(String(value));
109
+ } else {
110
+ // Issue!
111
+ return handleError(
112
+ opts.res,
113
+ {
114
+ message: `Request data was malformed: ${name} was not a valid float.`,
115
+ code: ReactKitErrorCode.InvalidParameter,
116
+ status: 422,
117
+ },
118
+ );
119
+ }
120
+ } else if (type === ParamType.Int || type === ParamType.IntOptional) {
121
+ // Int
122
+
123
+ // Handle case where value doesn't exist
124
+ if (value === undefined) {
125
+ if (type === ParamType.IntOptional) {
126
+ output[name] = undefined;
127
+ } else {
128
+ return handleError(
129
+ opts.res,
130
+ {
131
+ message: `Parameter ${name} is required, but it was not included.`,
132
+ code: ReactKitErrorCode.MissingParameter,
133
+ status: 422,
134
+ },
135
+ );
136
+ }
137
+ } else if (!Number.isNaN(Number.parseInt(String(value), 10))) {
138
+ // Value is a number
139
+ output[name] = Number.parseInt(String(value), 10);
140
+ } else {
141
+ // Issue!
142
+ return handleError(
143
+ opts.res,
144
+ {
145
+ message: `Request data was malformed: ${name} was not a valid int.`,
146
+ code: ReactKitErrorCode.InvalidParameter,
147
+ status: 422,
148
+ },
149
+ );
150
+ }
151
+ } else if (type === ParamType.JSON || type === ParamType.JSONOptional) {
152
+ // Stringified JSON
153
+
154
+ // Handle case where value doesn't exist
155
+ if (value === undefined) {
156
+ if (type === ParamType.JSONOptional) {
157
+ output[name] = undefined;
158
+ } else {
159
+ return handleError(
160
+ opts.res,
161
+ {
162
+ message: `Parameter ${name} is required, but it was not included.`,
163
+ code: ReactKitErrorCode.MissingParameter,
164
+ status: 422,
165
+ },
166
+ );
167
+ }
168
+ } else {
169
+ // Value exists
170
+
171
+ // Parse
172
+ try {
173
+ output[name] = JSON.parse(String(value));
174
+ } catch (err) {
175
+ return handleError(
176
+ opts.res,
177
+ {
178
+ message: `Request data was malformed: ${name} was not a valid JSON payload.`,
179
+ code: ReactKitErrorCode.InvalidParameter,
180
+ status: 422,
181
+ },
182
+ );
183
+ }
184
+ }
185
+ } else if (type === ParamType.String || type === ParamType.StringOptional) {
186
+ // String
187
+
188
+ // Handle case where value doesn't exist
189
+ if (value === undefined) {
190
+ if (type === ParamType.StringOptional) {
191
+ output[name] = undefined;
192
+ } else {
193
+ return handleError(
194
+ opts.res,
195
+ {
196
+ message: `Parameter ${name} is required, but it was not included.`,
197
+ code: ReactKitErrorCode.MissingParameter,
198
+ status: 422,
199
+ },
200
+ );
201
+ }
202
+ } else {
203
+ // Value exists
204
+
205
+ // Leave as is
206
+ output[name] = value;
207
+ }
208
+ } else {
209
+ // No valid data type
210
+ return handleError(
211
+ opts.res,
212
+ {
213
+ message: `An internal error occurred: we could not determine the type of ${name}.`,
214
+ code: ReactKitErrorCode.InvalidParameter,
215
+ status: 422,
216
+ },
217
+ );
218
+ }
219
+ }
220
+
221
+ /*----------------------------------------*/
222
+ /* Launch Info */
223
+ /*----------------------------------------*/
224
+
225
+ // Get launch info
226
+ const { launched, launchInfo } = getLaunchInfo(opts.req);
227
+ if (!launched || !launchInfo) {
228
+ return handleError(
229
+ opts.res,
230
+ {
231
+ message: 'Your session has expired. Please refresh the page and try again.',
232
+ code: ReactKitErrorCode.SessionExpired,
233
+ status: 440,
234
+ },
235
+ );
236
+ }
237
+
238
+ // Error if user info cannot be found
239
+ if (
240
+ !launchInfo.userId
241
+ || !launchInfo.userFirstName
242
+ || !launchInfo.userLastName
243
+ || (
244
+ launchInfo.notInCourse
245
+ && !launchInfo.isAdmin
246
+ )
247
+ || (
248
+ !launchInfo.isTTM
249
+ && !launchInfo.isLearner
250
+ && !launchInfo.isAdmin
251
+ )
252
+ ) {
253
+ return handleError(
254
+ opts.res,
255
+ {
256
+ message: 'Your session was invalid. Please refresh the page and try again.',
257
+ code: ReactKitErrorCode.SessionExpired,
258
+ status: 440,
259
+ },
260
+ );
261
+ }
262
+
263
+ // Add launch info to output
264
+ output.userId = launchInfo.userId;
265
+ output.userFirstName = launchInfo.userFirstName;
266
+ output.userLastName = launchInfo.userLastName;
267
+ output.isLearner = !!launchInfo.isLearner;
268
+ output.isTTM = !!launchInfo.isTTM;
269
+ output.isAdmin = !!launchInfo.isAdmin;
270
+ output.isWatchingInPrivate = !!(opts.req.session.isWatchingInPrivate);
271
+
272
+ /*----------------------------------------*/
273
+ /* Require Course Consistency */
274
+ /*----------------------------------------*/
275
+
276
+ // Make sure the user actually launched from the appropriate course
277
+ if (
278
+ output.courseId
279
+ && launchInfo.courseId
280
+ && output.courseId !== launchInfo.courseId
281
+ && !output.isTTM
282
+ && !output.isAdmin
283
+ ) {
284
+ // Course of interest is not the launch course
285
+ return handleError(
286
+ opts.res,
287
+ {
288
+ message: 'You switched sessions by opening Immersive Classroom in another tab. Please refresh the page and try again.',
289
+ code: ReactKitErrorCode.WrongCourse,
290
+ status: 401,
291
+ },
292
+ );
293
+ }
294
+
295
+ // Return processed params
296
+ return output;
297
+ };
298
+
299
+ export default parseRequest;
File without changes
@@ -0,0 +1,2 @@
1
+ import { showFatalError } from '../components/AppWrapper';
2
+ export default showFatalError;
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ var AppWrapper_1 = require("../components/AppWrapper");
4
+ exports.default = AppWrapper_1.showFatalError;
5
+ //# sourceMappingURL=showFatalError.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"showFatalError.js","sourceRoot":"","sources":["../../src/helpers/showFatalError.tsx"],"names":[],"mappings":";;AAAA,uDAA0D;AAE1D,kBAAe,2BAAc,CAAC"}
File without changes
File without changes
@@ -1,5 +1,11 @@
1
1
  /**
2
- * Visit an endpoint on the server
2
+ * Set the session expiry handler
3
+ * @author Gabe Abrams
4
+ * @param handler new handler to use when session expires
5
+ */
6
+ export declare const setSessionExpiryHandler: (handler: () => void) => void;
7
+ /**
8
+ * Visit an endpoint on the server [for client only]
3
9
  * @author Gabe Abrams
4
10
  * @param opts object containing all arguments
5
11
  * @param opts.path - the path of the server endpoint
@@ -39,13 +39,33 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
39
39
  return (mod && mod.__esModule) ? mod : { "default": mod };
40
40
  };
41
41
  Object.defineProperty(exports, "__esModule", { value: true });
42
+ exports.setSessionExpiryHandler = void 0;
42
43
  // Initialize caccl
43
44
  var client_1 = require("caccl/client");
44
45
  // Import custom error
45
46
  var ErrorWithCode_1 = __importDefault(require("../errors/ErrorWithCode"));
46
47
  var ReactKitErrorCode_1 = __importDefault(require("../types/ReactKitErrorCode"));
48
+ /*------------------------------------------------------------------------*/
49
+ /* Listener */
50
+ /*------------------------------------------------------------------------*/
51
+ // Handler for session expiry
52
+ var sessionExpiryHandler;
53
+ // Keep track of whether or not session expiry has already been handled
54
+ var sessionAlreadyExpired = false;
47
55
  /**
48
- * Visit an endpoint on the server
56
+ * Set the session expiry handler
57
+ * @author Gabe Abrams
58
+ * @param handler new handler to use when session expires
59
+ */
60
+ var setSessionExpiryHandler = function (handler) {
61
+ sessionExpiryHandler = handler;
62
+ };
63
+ exports.setSessionExpiryHandler = setSessionExpiryHandler;
64
+ /*------------------------------------------------------------------------*/
65
+ /* Main */
66
+ /*------------------------------------------------------------------------*/
67
+ /**
68
+ * Visit an endpoint on the server [for client only]
49
69
  * @author Gabe Abrams
50
70
  * @param opts object containing all arguments
51
71
  * @param opts.path - the path of the server endpoint
@@ -68,12 +88,43 @@ var visitServerEndpoint = function (opts) { return __awaiter(void 0, void 0, voi
68
88
  if (!response || !response.body) {
69
89
  throw new ErrorWithCode_1.default('We didn\'t get a response from the server. Please check your internet connection.', ReactKitErrorCode_1.default.NoResponse);
70
90
  }
71
- if (!response.body.success) {
72
- // Other errors
73
- throw new ErrorWithCode_1.default((response.body.message
74
- || 'An unknown error occurred. Please contact an admin.'), (response.body.code
75
- || ReactKitErrorCode_1.default.NoCode));
91
+ if (!!response.body.success) return [3 /*break*/, 6];
92
+ if (!(response.body.code === ReactKitErrorCode_1.default.SessionExpired)) return [3 /*break*/, 5];
93
+ if (!sessionAlreadyExpired) return [3 /*break*/, 3];
94
+ // Never return (browser is already reloading)
95
+ return [4 /*yield*/, new Promise(function () {
96
+ // Promise that never returns
97
+ })];
98
+ case 2:
99
+ // Never return (browser is already reloading)
100
+ _a.sent();
101
+ _a.label = 3;
102
+ case 3:
103
+ sessionAlreadyExpired = true;
104
+ // Show session expiration message
105
+ if (sessionExpiryHandler) {
106
+ // Use handler
107
+ sessionExpiryHandler();
108
+ }
109
+ else {
110
+ // Fallback to alert
111
+ // eslint-disable-next-line no-alert
112
+ alert('Your session has expired. Please start over.');
76
113
  }
114
+ // Never return (don't continue execution)
115
+ return [4 /*yield*/, new Promise(function () {
116
+ // Promise that never returns
117
+ })];
118
+ case 4:
119
+ // Never return (don't continue execution)
120
+ _a.sent();
121
+ _a.label = 5;
122
+ case 5:
123
+ // Other errors
124
+ throw new ErrorWithCode_1.default((response.body.message
125
+ || 'An unknown error occurred. Please contact an admin.'), (response.body.code
126
+ || ReactKitErrorCode_1.default.NoCode));
127
+ case 6:
77
128
  body = response.body.body;
78
129
  // Return
79
130
  return [2 /*return*/, body];
@@ -1 +1 @@
1
- {"version":3,"file":"visitServerEndpoint.js","sourceRoot":"","sources":["../../src/helpers/visitServerEndpoint.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mBAAmB;AACnB,uCAA2C;AAE3C,sBAAsB;AACtB,0EAAoD;AACpD,iFAA2D;AAE3D;;;;;;;;GAQG;AACH,IAAM,mBAAmB,GAAG,UAC1B,IAIC;;;;oBAGgB,qBAAM,IAAA,oBAAW,EAAC;oBACjC,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;iBACpB,CAAC,EAAA;;gBAJI,QAAQ,GAAG,SAIf;gBAEF,oBAAoB;gBACpB,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;oBAC/B,MAAM,IAAI,uBAAa,CACrB,mFAAmF,EACnF,2BAAiB,CAAC,UAAU,CAC7B,CAAC;iBACH;gBACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE;oBAC1B,eAAe;oBACf,MAAM,IAAI,uBAAa,CACrB,CACE,QAAQ,CAAC,IAAI,CAAC,OAAO;2BAClB,qDAAqD,CACzD,EACD,CACE,QAAQ,CAAC,IAAI,CAAC,IAAI;2BACf,2BAAiB,CAAC,MAAM,CAC5B,CACF,CAAC;iBACH;gBAGO,IAAI,GAAK,QAAQ,CAAC,IAAI,KAAlB,CAAmB;gBAE/B,SAAS;gBACT,sBAAO,IAAI,EAAC;;;KACb,CAAC;AAEF,kBAAe,mBAAmB,CAAC"}
1
+ {"version":3,"file":"visitServerEndpoint.js","sourceRoot":"","sources":["../../src/helpers/visitServerEndpoint.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mBAAmB;AACnB,uCAA2C;AAE3C,sBAAsB;AACtB,0EAAoD;AACpD,iFAA2D;AAE3D,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,6BAA6B;AAC7B,IAAI,oBAAgC,CAAC;AAErC,uEAAuE;AACvE,IAAI,qBAAqB,GAAG,KAAK,CAAC;AAElC;;;;GAIG;AACI,IAAM,uBAAuB,GAAG,UAAC,OAAmB;IACzD,oBAAoB,GAAG,OAAO,CAAC;AACjC,CAAC,CAAC;AAFW,QAAA,uBAAuB,2BAElC;AAEF,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E;;;;;;;;GAQG;AACH,IAAM,mBAAmB,GAAG,UAC1B,IAIC;;;;oBAGgB,qBAAM,IAAA,oBAAW,EAAC;oBACjC,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,MAAM,EAAE,IAAI,CAAC,MAAM;iBACpB,CAAC,EAAA;;gBAJI,QAAQ,GAAG,SAIf;gBAEF,oBAAoB;gBACpB,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;oBAC/B,MAAM,IAAI,uBAAa,CACrB,mFAAmF,EACnF,2BAAiB,CAAC,UAAU,CAC7B,CAAC;iBACH;qBACG,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAtB,wBAAsB;qBAEpB,CAAA,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,2BAAiB,CAAC,cAAc,CAAA,EAAvD,wBAAuD;qBAErD,qBAAqB,EAArB,wBAAqB;gBACvB,8CAA8C;gBAC9C,qBAAM,IAAI,OAAO,CAA2B;wBAC1C,6BAA6B;oBAC/B,CAAC,CAAC,EAAA;;gBAHF,8CAA8C;gBAC9C,SAEE,CAAC;;;gBAEL,qBAAqB,GAAG,IAAI,CAAC;gBAE7B,kCAAkC;gBAClC,IAAI,oBAAoB,EAAE;oBACxB,cAAc;oBACd,oBAAoB,EAAE,CAAC;iBACxB;qBAAM;oBACL,oBAAoB;oBAEpB,oCAAoC;oBACpC,KAAK,CAAC,8CAA8C,CAAC,CAAC;iBACvD;gBAED,0CAA0C;gBAC1C,qBAAM,IAAI,OAAO,CAA2B;wBAC1C,6BAA6B;oBAC/B,CAAC,CAAC,EAAA;;gBAHF,0CAA0C;gBAC1C,SAEE,CAAC;;;YAGL,eAAe;YACf,MAAM,IAAI,uBAAa,CACrB,CACE,QAAQ,CAAC,IAAI,CAAC,OAAO;mBAClB,qDAAqD,CACzD,EACD,CACE,QAAQ,CAAC,IAAI,CAAC,IAAI;mBACf,2BAAiB,CAAC,MAAM,CAC5B,CACF,CAAC;;gBAII,IAAI,GAAK,QAAQ,CAAC,IAAI,KAAlB,CAAmB;gBAE/B,SAAS;gBACT,sBAAO,IAAI,EAAC;;;KACb,CAAC;AAEF,kBAAe,mBAAmB,CAAC"}