npm - dce-reactkit - Versions diffs - 3.6.25 → 3.6.27 - Mend

dce-reactkit 3.6.25 → 3.6.27

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 (12) hide show

package/dist/cjs/index.js +107 -3
package/dist/cjs/index.js.map +1 -1
package/dist/cjs/types/helpers/genRouteHandler.d.ts +7 -1
package/dist/cjs/types/html/genInfoPage.d.ts +12 -0
package/dist/esm/index.js +107 -3
package/dist/esm/index.js.map +1 -1
package/dist/esm/types/helpers/genRouteHandler.d.ts +7 -1
package/dist/esm/types/html/genInfoPage.d.ts +12 -0
package/dist/index.d.ts +7 -1
package/package.json +1 -1
package/src/helpers/genRouteHandler.ts +30 -3
package/src/html/genInfoPage.ts +100 -0

package/dist/cjs/index.js CHANGED Viewed

@@ -42066,6 +42066,96 @@ const genErrorPage = (opts = {}) => {
   `;
 };
+/**
+ * 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
+ */
+const genInfoPage = (opts) => {
+    const { title, body, } = opts;
+    return `
+<head>
+  <!-- Metadata -->
+  <meta
+    name="viewport"
+    content="width=device-width, height=device-height, initial-scale=1.0, minimum-scale=1.0"
+  >
+  <!-- Title -->
+  <title>${title}</title>
+  <!-- Bootstrap -->
+  <link
+    rel="stylesheet"
+    href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.2.1/css/bootstrap.min.css"
+    integrity="sha512-siwe/oXMhSjGCwLn+scraPOWrJxHlUgMBMZXdPe2Tnk3I0x3ESCoLz7WZ5NTH6SZrywMY+PB1cjyqJ5jAluCOg=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer"
+  />
+  <script
+    src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.2.1/js/bootstrap.min.js"
+    integrity="sha512-vyRAVI0IEm6LI/fVSv/Wq/d0KUfrg3hJq2Qz5FlfER69sf3ZHlOrsLriNm49FxnpUGmhx+TaJKwJ+ByTLKT+Yg=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer"
+  ></script>
+  <!-- FontAwesome -->
+  <link
+    rel="stylesheet"
+    href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css"
+    integrity="sha512-xh6O/CkQoPOWDdYTDqeRdPCVd1SpvCA9XXcUnZS2FmJNp1coAFzvtCN9BmamE+4aHK8yyUHUSCcJHgXloTyT2A=="
+    crossorigin="anonymous"
+    referrerpolicy="no-referrer"
+  />
+  <!-- Style -->
+  <style>
+    .DCEReactKit-pop-in {
+      animation-name: DCEReactKit-pop-in;
+      animation-duration: 0.5s;
+      animation-iteration-count: 1;
+      animation-timing-function: ease-out;
+      animation-fill-mode: both;
+      transform-origin: center;
+    }
+    @keyframes DCEReactKit-pop-in {
+      0% {
+        opacity: 0;
+        transform: scale(0.9);
+      }
+      100% {
+        opacity: 1;
+        transform: scale(1);
+      }
+    }
+  </style>
+</head>
+<!-- Body -->
+<body class="bg-dark text-center pt-3 ps-3 pe-3">
+  <!-- Alert -->
+  <div
+    class="DCEReactKit-pop-in alert alert-info d-inline-block"
+    style="width: 50em; max-width: 100%"
+  >
+    <!-- Title -->
+    <h2>
+      <i class="me-1 fa-solid fa-circle-info"></i>
+      ${title}
+    </h2>
+    <!-- Body -->
+    <div>
+      ${body}
+    </div>
+  </div>
+</body>
+  `;
+};
 /**
  * Perform a rudimentary parsing of the user's browser agent string
  * @author Gabe Abrams
@@ -42187,10 +42277,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) => {
@@ -42440,7 +42532,7 @@ const genRouteHandler = (opts) => {
             }
         });
         /*----------------------------------------*/
-        /*       Require Course Consistency       */
+        /* ----- Require Course Consistency ----- */
         /*----------------------------------------*/
         // Make sure the user actually launched from the appropriate course
         if (output.courseId
@@ -42490,7 +42582,7 @@ const genRouteHandler = (opts) => {
             });
         }
         /*----------------------------------------*/
-        /*               Log Handler              */
+        /* ------------- Log Handler ------------ */
         /*----------------------------------------*/
         // Create a log handler function
         /**
@@ -42686,6 +42778,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 = genInfoPage(renderOpts);
+            send(html, 200);
+        };
         // Call the handler
         try {
             const results = yield opts.handler({
@@ -42698,6 +42801,7 @@ const genRouteHandler = (opts) => {
                 },
                 redirect,
                 renderErrorPage,
+                renderInfoPage,
                 logServerEvent,
             });
             // Send results to client (only if next wasn't called)