dce-reactkit 3.6.25 → 3.6.26

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

@@ -16,10 +16,12 @@ import LogFunction from '../types/LogFunction';
  *   send (a function that sends a string to the client),
  *   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),
  *   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,
- *   userLastName, isLearner, isTTM, isAdmin, and any other variables that
+ *   userLastName, userEmail, userAvatarURL, isLearner, isTTM, isAdmin,
+ *   and any other variables that
  *   are directly added to the session, if the user does have a session.
  */
 declare const genRouteHandler: (opts: {
@@ -41,6 +43,10 @@ declare const genRouteHandler: (opts: {
             pageTitle?: string;
             status?: number;
         }) => void;
+        renderInfoPage: (opts: {
+            title: string;
+            body: string;
+        }) => void;
         logServerEvent: LogFunction;
     }) => any;
     skipSessionCheck?: boolean | undefined;

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

@@ -0,0 +1,12 @@
+/**
+ * Generate a static info page
+ * @author Gabe Abrams
+ * @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
+ */
+declare const genInfoPage: (opts: {
+    title: string;
+    body: string;
+}) => string;
+export default genInfoPage;

package/dist/esm/index.js

@@ -42161,10 +42161,12 @@ const parseUserAgent = (userAgent) => {
  *   send (a function that sends a string to the client),
  *   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),
  *   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,
- *   userLastName, isLearner, isTTM, isAdmin, and any other variables that
+ *   userLastName, userEmail, userAvatarURL, isLearner, isTTM, isAdmin,
+ *   and any other variables that
  *   are directly added to the session, if the user does have a session.
  */
 const genRouteHandler = (opts) => {
@@ -42660,6 +42662,17 @@ const genRouteHandler = (opts) => {
                 },
             });
         };
+        /**
+         * Render an info page
+         * @author Gabe Abrams
+         * @param renderOpts object containing all arguments
+         * @param renderOpts.title title of the info box
+         * @param renderOpts.body a human-readable text body for the info alert
+         */
+        const renderInfoPage = (renderOpts) => {
+            const html = genErrorPage(renderOpts);
+            send(html, 200);
+        };
         // Call the handler
         try {
             const results = yield opts.handler({
@@ -42672,6 +42685,7 @@ const genRouteHandler = (opts) => {
                 },
                 redirect,
                 renderErrorPage,
+                renderInfoPage,
                 logServerEvent,
             });
             // Send results to client (only if next wasn't called)