dce-reactkit 3.7.12 → 3.7.15

package/dist/esm/types/components/ButtonInputGroup.d.ts

@@ -4,7 +4,7 @@
  */
 import React from 'react';
 type Props = {
-    label: string;
+    label: React.ReactNode;
     minLabelWidth?: string;
     children: React.ReactNode;
     className?: string;

package/dist/esm/types/helpers/genRouteHandler.d.ts

@@ -9,6 +9,14 @@ import LogFunction from '../types/LogFunction';
  * @param opts.handler function that processes the request
  * @param [opts.skipSessionCheck] if true, skip the session check (allow users
  *   to not be logged in and launched via LTI)
+ * @param [opts.unhandledErrorMessagePrefix] if included, when an error that
+ *   is not of type ErrorWithCode is thrown, the client will receive an error
+ *   where the error message is prefixed with this string. For example,
+ *   if unhandledErrorMessagePrefix is
+ *   'While saving progress, we encountered an error:'
+ *   and the error is 'progressInfo is not an object',
+ *   the client will receive an error with the message
+ *   'While saving progress, we encountered an error: progressInfo is not an object'
  * @returns express route handler that takes the following arguments:
  *   params (map: param name => value),
  *   req (express request object),
@@ -17,6 +25,7 @@ import LogFunction from '../types/LogFunction';
  *   redirect (takes a url and redirects the user to that url),
  *   renderErrorPage (shows a static error page to the user),
  *   renderInfoPage (shows a static info page to the user),
+ *   renderCustomHTML (renders custom html and sends it to the user),
  *   and returns the value to send to the client as a JSON API response, or
  *   calls next() or redirect(...) or send(...) or renderErrorPage(...).
  *   Note: params also has userId, userFirstName,
@@ -47,8 +56,13 @@ declare const genRouteHandler: (opts: {
             title: string;
             body: string;
         }) => void;
+        renderCustomHTML: (opts: {
+            html: string;
+            status?: number;
+        }) => void;
         logServerEvent: LogFunction;
     }) => any;
     skipSessionCheck?: boolean | undefined;
+    unhandledErrorMessagePrefix?: string | undefined;
 }) => (req: any, res: any, next: () => void) => Promise<undefined>;
 export default genRouteHandler;

package/dist/esm/types/html/genInfoPage.d.ts

@@ -4,6 +4,7 @@
  * @param opts object containing all arguments
  * @param opts.title title of the info box
  * @param opts.body a human-readable text body for the info alert
+ * @returns the HTML for the info page
  */
 declare const genInfoPage: (opts: {
     title: string;

package/dist/index.d.ts

@@ -244,7 +244,7 @@ declare const CheckboxButton: React$1.FC<Props$g>;
  */
 
 type Props$f = {
-    label: string;
+    label: React$1.ReactNode;
     minLabelWidth?: string;
     children: React$1.ReactNode;
     className?: string;
@@ -1003,6 +1003,14 @@ type LogFunction = (opts: ({
  * @param opts.handler function that processes the request
  * @param [opts.skipSessionCheck] if true, skip the session check (allow users
  *   to not be logged in and launched via LTI)
+ * @param [opts.unhandledErrorMessagePrefix] if included, when an error that
+ *   is not of type ErrorWithCode is thrown, the client will receive an error
+ *   where the error message is prefixed with this string. For example,
+ *   if unhandledErrorMessagePrefix is
+ *   'While saving progress, we encountered an error:'
+ *   and the error is 'progressInfo is not an object',
+ *   the client will receive an error with the message
+ *   'While saving progress, we encountered an error: progressInfo is not an object'
  * @returns express route handler that takes the following arguments:
  *   params (map: param name => value),
  *   req (express request object),
@@ -1011,6 +1019,7 @@ type LogFunction = (opts: ({
  *   redirect (takes a url and redirects the user to that url),
  *   renderErrorPage (shows a static error page to the user),
  *   renderInfoPage (shows a static info page to the user),
+ *   renderCustomHTML (renders custom html and sends it to the user),
  *   and returns the value to send to the client as a JSON API response, or
  *   calls next() or redirect(...) or send(...) or renderErrorPage(...).
  *   Note: params also has userId, userFirstName,
@@ -1041,9 +1050,14 @@ declare const genRouteHandler: (opts: {
             title: string;
             body: string;
         }) => void;
+        renderCustomHTML: (opts: {
+            html: string;
+            status?: number;
+        }) => void;
         logServerEvent: LogFunction;
     }) => any;
     skipSessionCheck?: boolean | undefined;
+    unhandledErrorMessagePrefix?: string | undefined;
 }) => (req: any, res: any, next: () => void) => Promise<undefined>;
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.7.12",
+  "version": "3.7.15",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/components/ButtonInputGroup.tsx

@@ -13,7 +13,7 @@ import React from 'react';
 // Props definition
 type Props = {
   // Label text
-  label: string,
+  label: React.ReactNode,
   // Minimum width of the label (css units)
   minLabelWidth?: string,
   // Buttons

package/src/helpers/genRouteHandler.ts

@@ -39,6 +39,14 @@ import LogLevel from '../types/LogLevel';
  * @param opts.handler function that processes the request
  * @param [opts.skipSessionCheck] if true, skip the session check (allow users
  *   to not be logged in and launched via LTI)
+ * @param [opts.unhandledErrorMessagePrefix] if included, when an error that
+ *   is not of type ErrorWithCode is thrown, the client will receive an error
+ *   where the error message is prefixed with this string. For example,
+ *   if unhandledErrorMessagePrefix is
+ *   'While saving progress, we encountered an error:'
+ *   and the error is 'progressInfo is not an object',
+ *   the client will receive an error with the message
+ *   'While saving progress, we encountered an error: progressInfo is not an object'
  * @returns express route handler that takes the following arguments:
  *   params (map: param name => value),
  *   req (express request object),
@@ -47,6 +55,7 @@ import LogLevel from '../types/LogLevel';
  *   redirect (takes a url and redirects the user to that url),
  *   renderErrorPage (shows a static error page to the user),
  *   renderInfoPage (shows a static info page to the user),
+ *   renderCustomHTML (renders custom html and sends it to the user),
  *   and returns the value to send to the client as a JSON API response, or
  *   calls next() or redirect(...) or send(...) or renderErrorPage(...).
  *   Note: params also has userId, userFirstName,
@@ -83,10 +92,17 @@ const genRouteHandler = (
             body: string,
           },
         ) => void,
+        renderCustomHTML: (
+          opts: {
+            html: string,
+            status?: number,
+          },
+        ) => void,
         logServerEvent: LogFunction,
       },
     ) => any,
     skipSessionCheck?: boolean,
+    unhandledErrorMessagePrefix?: string,
   },
 ) => {
   // Return a route handler
@@ -756,6 +772,22 @@ const genRouteHandler = (
       send(html, 200);
     };
 
+    /**
+     * Render custom HTML
+     * @author Gabe Abrams
+     * @param htmlOpts object containing all arguments
+     * @param htmlOpts.html the HTML to send to the client
+     * @param [ejsOpts.status=200] the http status code to send
+     */
+    const renderCustomHTML = (
+      htmlOpts: {
+        html: string,
+        status?: number,
+      },
+    ) => {
+      send(htmlOpts.html, htmlOpts.status ?? 200);
+    };
+
     // Call the handler
     try {
       const results = await opts.handler({
@@ -769,6 +801,7 @@ const genRouteHandler = (
         redirect,
         renderErrorPage,
         renderInfoPage,
+        renderCustomHTML,
         logServerEvent,
       });
 
@@ -777,6 +810,16 @@ const genRouteHandler = (
         return handleSuccess(res, results ?? undefined);
       }
     } catch (err) {
+      // Prefix error message if needed
+      if (
+        opts.unhandledErrorMessagePrefix
+        && err instanceof Error
+        && err.message
+        && err.name !== 'ErrorWithCode'
+      ) {
+        err.message = `${opts.unhandledErrorMessagePrefix.trim()} ${err.message.trim()}`;
+      }
+
       // Send error to client (only if next wasn't called)
       if (!responseSent) {
         handleError(res, err);

package/src/html/genInfoPage.ts

@@ -4,6 +4,7 @@
  * @param opts object containing all arguments
  * @param opts.title title of the info box
  * @param opts.body a human-readable text body for the info alert
+ * @returns the HTML for the info page
  */
 const genInfoPage = (
   opts: {