dce-reactkit 4.0.0-beta.3 → 4.0.1

package/src/components/SimpleDateChooser.tsx

@@ -1,16 +1,23 @@
 /**
  * A very simple, lightweight date chooser
  * @author Gabe Abrams
+ * @author Gardenia Liu
  */
 
 // Import React
 import React from 'react';
-import getMonthName from '../helpers/getMonthName';
 
 // Import helpers
 import getOrdinal from '../helpers/getOrdinal';
+import getMonthName from '../helpers/getMonthName';
 import getTimeInfoInET from '../helpers/getTimeInfoInET';
 
+// Import classes
+import ErrorWithCode from '../errors/ErrorWithCode';
+
+// Import types
+import ReactKitErrorCode from '../types/ReactKitErrorCode';
+
 /*------------------------------------------------------------------------*/
 /* -------------------------------- Types ------------------------------- */
 /*------------------------------------------------------------------------*/
@@ -33,12 +40,14 @@ type Props = {
    * @param year new full year number
    */
   onChange: (month: number, day: number, year: number) => void,
-  // Number of months to allow the user to choose from
-  // (max is 12, default is 6)
+  // Number of months in either the past or future to allow the user to choose from
+  // If we aren't allowing the past or the future, we will throw an error
+  // (max is 12, default is 6 in the past and 6 in the future)
   numMonthsToShow?: number,
-  // If true, instead of showing numMonthsToShow months into the future,
-  // show numMonthsToShow months into the past
-  chooseFromPast?: boolean,
+  // If true, the user isn't allowed to select dates in the past
+  dontAllowPast?: boolean,
+  // If true, the user isn't allowed to select dates in the future
+  dontAllowFuture?: boolean,
 };
 
 /*------------------------------------------------------------------------*/
@@ -56,8 +65,9 @@ const SimpleDateChooser: React.FC<Props> = (props) => {
     ariaLabel,
     name,
     onChange,
-    chooseFromPast,
     numMonthsToShow = 6,
+    dontAllowFuture,
+    dontAllowPast,
   } = props;
 
   /*------------------------------------------------------------------------*/
@@ -76,16 +86,41 @@ const SimpleDateChooser: React.FC<Props> = (props) => {
     days: number[],
     year: number,
   }[] = [];
+
   let startYear = today.year;
   let startMonth = today.month;
-  if (chooseFromPast) {
+
+  // Don't allow past or future dates
+  if (dontAllowPast && dontAllowFuture) {
+    throw new ErrorWithCode(
+      'No past or future dates allowed',
+      ReactKitErrorCode.SimpleDateChooserInvalidDateRange,
+    );
+  }
+
+  // Require numMonthsToShow to be positive
+  if (numMonthsToShow <= 0) {
+    throw new ErrorWithCode(
+      'numMonthsToShow must be positive',
+      ReactKitErrorCode.SimpleDateChooserInvalidNumMonths,
+    );
+  }
+
+  // Recalculate startMonth and startYear when allowing past dates
+  if (!dontAllowPast) {
     startMonth -= Math.max(0, numMonthsToShow - 1);
     while (startMonth <= 0) {
       startMonth += 12;
       startYear -= 1;
     }
   }
-  for (let i = 0; i < numMonthsToShow; i++) {
+  // Calculate total number of months to show
+  let totalMonthsToShow = numMonthsToShow;
+  if (!dontAllowPast && !dontAllowFuture) {
+    totalMonthsToShow = totalMonthsToShow * 2 - 1;
+  }
+
+  for (let i = 0; i < totalMonthsToShow; i++) {
     // Get month and year info
     const unmoddedMonth = (startMonth + i);
     let month = unmoddedMonth;
@@ -105,24 +140,25 @@ const SimpleDateChooser: React.FC<Props> = (props) => {
     // Figure out which days are allowed
     const days = [];
     const numDaysInMonth = (new Date(year, month, 0)).getDate();
-    if (chooseFromPast) {
-      // Past selection
-      const numDaysToAdd = (
-        (month === today.month)
-          ? today.day // Current month, only add up to today
-          : numDaysInMonth // Past month, add all days
-      );
-      for (let day = 1; day <= numDaysToAdd; day++) {
-        days.push(day);
+
+    // Current month
+    if (month === today.month && year === today.year) {
+      // Past selection: add all previous days of the month
+      if (!dontAllowPast) {
+        for (let day = 1; day < today.day; day++) {
+          days.push(day);
+        }
       }
-    } else {
+      days.push(today.day); // Add current day
       // Future selection: add all remaining days of the month
-      const firstDay = (
-        month === today.month
-          ? today.day // Current month: start at current date
-          : 1 // Future month: start at beginning of month
-      );
-      for (let day = firstDay; day <= numDaysInMonth; day++) {
+      if (!dontAllowFuture) {
+        for (let day = today.day + 1; day <= numDaysInMonth; day++) {
+          days.push(day);
+        }
+      }
+    } else { // Past or future month
+      // Include all days in the month
+      for (let day = 1; day <= numDaysInMonth; day++) {
         days.push(day);
       }
     }
@@ -158,8 +194,8 @@ const SimpleDateChooser: React.FC<Props> = (props) => {
       </option>,
     );
 
+    // This is the currently selected month
     if (month === choice.month) {
-      // This is the currently selected month
       // Create day options
       choice.days.forEach((dayChoice) => {
         const ordinal = getOrdinal(dayChoice);

package/src/components/SimpleTimeChooser.tsx

@@ -0,0 +1,196 @@
+/**
+ * A very simple, lightweight time chooser
+ * @author Gardenia Liu
+ */
+
+// Import React
+import React from 'react';
+
+// Import helpers
+import padZerosLeft from '../helpers/padZerosLeft';
+
+/*------------------------------------------------------------------------*/
+/* -------------------------------- Types ------------------------------- */
+/*------------------------------------------------------------------------*/
+
+type Props = {
+  // Aria label
+  ariaLabel: string,
+  // Name of the chooser (machine-readable, hyphenated)
+  name: string,
+  // Currently selected hour of the day (24hr)
+  hour: number,
+  // Currently selected minute within the hour
+  minute: number,
+  /**
+   * Handler for when time changes
+   * @param hour new 24hr hour number
+   * @param minute new minute number
+   */
+  onChange: (hour: number, minute: number) => void,
+  // Interval in minutes between each choice
+  // Allowed options: 15, 30, 60, defaults to 15
+  // If an unsupported interval is passed in, it will default to 15
+  intervalMin?: number,
+};
+
+/*------------------------------------------------------------------------*/
+/* ------------------------------ Constants ----------------------------- */
+/*------------------------------------------------------------------------*/
+
+// Allowed intervals between options
+const ALLOWED_INTERVALS = [15, 30, 60]; // min
+
+// Default interval to use if an unsupported interval is passed in
+const DEFAULT_INTERVAL = ALLOWED_INTERVALS[0]; // min
+
+/*------------------------------------------------------------------------*/
+/* ------------------------------ Component ----------------------------- */
+/*------------------------------------------------------------------------*/
+
+const SimpleTimeChooser: React.FC<Props> = (props) => {
+  /*------------------------------------------------------------------------*/
+  /* -------------------------------- Setup ------------------------------- */
+  /*------------------------------------------------------------------------*/
+
+  /* -------------- Props ------------- */
+
+  const {
+    ariaLabel,
+    name,
+    hour,
+    minute,
+    onChange,
+  } = props;
+  let {
+    intervalMin = DEFAULT_INTERVAL,
+  } = props;
+
+  // Use default interval if not supported
+  if (!ALLOWED_INTERVALS.includes(intervalMin)) {
+    intervalMin = DEFAULT_INTERVAL;
+  }
+
+  /*------------------------------------------------------------------------*/
+  /* ------------------------- Component Functions ------------------------ */
+  /*------------------------------------------------------------------------*/
+
+  /**
+   * Convert number of minutes since midnight into 24hour and minute format
+   * @author Gabe Abrams
+   * @param minSinceMidnight total minutes since midnight
+   * @returns hours (24) and minutes
+   */
+  const convertMinSinceMidnightToHoursAndMin = (minSinceMidnight: number): {
+    hours: number,
+    minutes: number,
+  } => {
+    return {
+      hours: Math.floor(minSinceMidnight / 60),
+      minutes: minSinceMidnight % 60,
+    };
+  };
+
+  /**
+   * Convert time in minutes into HH:MM format
+   * @author Gardenia Liu
+   * @param totalMinutes total minutes since midnight
+   * @returns formatted time string
+   */
+  const formatTime = (totalMinutes: number): string => {
+    // Handle special cases
+    if (totalMinutes === 0) {
+      return '12:00 Midnight';
+    }
+    if (totalMinutes === 12 * 60) {
+      return '12:00 Noon';
+    }
+
+    // All normal cases:
+    const timeInfo = convertMinSinceMidnightToHoursAndMin(totalMinutes);
+    let { hours } = timeInfo;
+    const { minutes } = timeInfo;
+
+    // Process 24hr -> 12hr
+    const isAM = (hours < 12);
+    if (hours === 0) {
+      hours = 12;
+    } else if (hours > 12) {
+      hours %= 12;
+    }
+
+    // Pad with zeros
+    const paddedMinutes = padZerosLeft(minutes, 2);
+
+    // Assemble time string
+    return `${hours}:${paddedMinutes} ${isAM ? 'AM' : 'PM'}`;
+  };
+
+  /*------------------------------------------------------------------------*/
+  /* ------------------------------- Render ------------------------------- */
+  /*------------------------------------------------------------------------*/
+
+  /*----------------------------------------*/
+  /* --------------- Main UI -------------- */
+  /*----------------------------------------*/
+
+  // Generate list of time options
+  const times: string[] = [];
+  for (let time = 0; time < 24 * 60; time += intervalMin) {
+    times.push(formatTime(time));
+  }
+
+  // Currently selected time in minutes since midnight
+  const selectedTimeMin = hour * 60 + minute;
+
+  // Create choice options
+  const timeOptions: React.ReactNode[] = times.map((timeString, timeIndex) => {
+    const numMinutesForChoice = timeIndex * intervalMin;
+
+    // Render the option
+    return (
+      <option
+        key={numMinutesForChoice}
+        value={numMinutesForChoice}
+        aria-label={`choose ${timeString}`}
+      >
+        {timeString}
+      </option>
+    );
+  });
+
+  return (
+    <div
+      className="SimpleTimeChooser-container"
+      aria-label={`time chooser with selected time: ${formatTime(selectedTimeMin)}`}
+    >
+      {/* Time Chooser */}
+      <select
+        aria-label={`time for ${ariaLabel}`}
+        className="custom-select d-inline-block"
+        style={{ width: 'auto' }}
+        id={`SimpleTimeChooser-${name}-time`}
+        value={selectedTimeMin}
+        onChange={(e) => {
+          // Parse selector value (string)
+          const newTime = Number.parseInt(e.target.value, 10);
+
+          // Convert minutes since midnight to hour and minute
+          const timeInfo = convertMinSinceMidnightToHoursAndMin(newTime);
+
+          // Notify parent
+          onChange(timeInfo.hours, timeInfo.minutes);
+        }}
+      >
+        {timeOptions}
+      </select>
+    </div>
+  );
+};
+
+/*------------------------------------------------------------------------*/
+/* ------------------------------- Wrap Up ------------------------------ */
+/*------------------------------------------------------------------------*/
+
+// Export component
+export default SimpleTimeChooser;

package/src/components/TabBox.tsx

@@ -15,6 +15,8 @@ type Props = {
   title: React.ReactNode,
   // Children/contents inside the box
   children: React.ReactNode,
+  // Children to display on the top right of the tab box
+  topRightChildren?: React.ReactNode,
   // If true, don't add margin below the tab box
   noBottomMargin?: boolean,
   // If true, don't add padding to bottom of tab box
@@ -49,7 +51,9 @@ const style = `
 
   /* Container for Title */
   .TabBox-title-container {
-    /* Place on Left */
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
     position: relative;
     left: 0;
     text-align: left;
@@ -82,6 +86,19 @@ const style = `
     background: #fdfdfd;
   }
 
+  .TabBox-title-right-container {
+    display: flex;
+    flex-direction: row;
+    align-items: bottom;
+    height: 2.4rem;
+    overflow: visible;
+  }
+
+  .TabBox-title-right-contents {
+    margin-right: 0.5rem;
+    margin-bottom: 0.2rem;
+  }
+
   /* Make the TabBox's Children Appear Above Title if Overlap Occurs */
   .TabBox-children {
     position: relative;
@@ -98,11 +115,10 @@ const TabBox: React.FC<Props> = (props) => {
   /* -------------------------------- Setup ------------------------------- */
   /*------------------------------------------------------------------------*/
 
-  /* -------------- Props ------------- */
-
   const {
     title,
     children,
+    topRightChildren,
     noBottomPadding,
     noBottomMargin,
   } = props;
@@ -111,21 +127,23 @@ const TabBox: React.FC<Props> = (props) => {
   /* ------------------------------- Render ------------------------------- */
   /*------------------------------------------------------------------------*/
 
-  /*----------------------------------------*/
-  /* --------------- Main UI -------------- */
-  /*----------------------------------------*/
-
-  // Full UI
   return (
     <div className={`TabBox-container ${noBottomMargin ? '' : 'mb-2'}`}>
       {/* Style */}
       <style>{style}</style>
 
-      {/* Title */}
+      {/* Title Row with Left and Right sections */}
       <div className="TabBox-title-container">
         <div className="TabBox-title">
           {title}
         </div>
+        {topRightChildren && (
+          <div className="TabBox-title-right-container">
+            <div className="TabBox-title-right-contents">
+              {topRightChildren}
+            </div>
+          </div>
+        )}
       </div>
 
       {/* Contents */}

package/src/helpers/getWordCount.ts

@@ -0,0 +1,26 @@
+const punctuationRegex = /[!@#$%^&*(),.?\/;:'"\-\[\]]/g;
+
+/**
+ * Get number of words in string 
+ * @author Gardenia Liu
+ * @author Allison Zhang
+ * @author Gabe Abrams
+ * @param text the string to check
+ * @returns number of words in the string
+ */
+const getWordCount = (text: string): number => {
+  const trimmedTextWithoutPunctuation = (
+    text
+      // Remove leading and trailing whitespace
+      .trim()
+      // Remove punctuation
+      .replace(punctuationRegex, '')
+  );
+  if (trimmedTextWithoutPunctuation.length === 0) {
+    return 0;
+  }
+
+  return trimmedTextWithoutPunctuation.split(/\s+/g).length;
+};
+
+export default getWordCount;

package/src/index.ts

@@ -15,6 +15,7 @@ import RadioButton from './components/RadioButton';
 import CheckboxButton from './components/CheckboxButton';
 import ButtonInputGroup from './components/ButtonInputGroup';
 import SimpleDateChooser from './components/SimpleDateChooser';
+import SimpleTimeChooser from './components/SimpleTimeChooser';
 import Drawer from './components/Drawer';
 import PopSuccessMark from './components/PopSuccessMark';
 import PopFailureMark from './components/PopFailureMark';
@@ -91,6 +92,7 @@ import mapAsync from './helpers/asyncArrayFunctions/mapAsync';
 import someAsync from './helpers/asyncArrayFunctions/someAsync';
 import capitalize from './helpers/capitalize';
 import shuffleArray from './helpers/shuffleArray';
+import getWordCount from './helpers/getWordCount';
 
 // Import types
 import ParamType from './types/ParamType';
@@ -132,6 +134,7 @@ export {
   CheckboxButton,
   ButtonInputGroup,
   SimpleDateChooser,
+  SimpleTimeChooser,
   Drawer,
   PopSuccessMark,
   PopFailureMark,
@@ -204,6 +207,7 @@ export {
   someAsync,
   capitalize,
   shuffleArray,
+  getWordCount,
   // Client helpers
   initClient,
   visitServerEndpoint,

package/src/types/LogSource.ts

@@ -7,6 +7,6 @@ enum LogSource {
   Client = 'client',
   // Server
   Server = 'server',
-};
+}
 
 export default LogSource;

package/src/types/ReactKitErrorCode.tsx

@@ -1,4 +1,4 @@
-// Highest error code = DRK34
+// Highest error code = DRK36
 
 /**
  * List of error codes built into the react kit
@@ -9,6 +9,8 @@ enum ReactKitErrorCode {
   NoCode = 'DRK2',
   SessionExpired = 'DRK3',
   NoCACCLSendRequestFunction = 'DRK7',
+  SimpleDateChooserInvalidDateRange = 'DRK35',
+  SimpleDateChooserInvalidNumMonths = 'DRK36',
 }
 
 export default ReactKitErrorCode;

package/genEncodedSecret.ts

@@ -1,84 +0,0 @@
-// Import crypto lib
-import crypto from 'crypto';
-
-const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-
-// Get args
-const REACTKIT_CRED_ENCODING_SALT = process.env.npm_config_salt;
-if (!REACTKIT_CRED_ENCODING_SALT) {
-  console.log('Encoding salt is required: --salt=...');
-  process.exit(1);
-}
-
-// Get the key
-let key = process.env.npm_config_key;
-if (!key) {
-  console.log('Key is required: --key=...');
-  process.exit(1);
-}
-
-// Get the description
-let description = process.env.npm_config_description;
-if (!description) {
-  console.log('Description is required: --description=...');
-  process.exit(1);
-}
-
-// Get secret
-let secret = process.env.npm_config_secret;
-if (!secret) {
-  // Generate a random secret
-  secret = '';
-  for (let i = 0; i < 32; i++) {
-    secret += chars.charAt(Math.floor(Math.random() * chars.length));
-  }
-  console.log('Generated a random secret. If you have one in mind, use --secret=...');
-}
-
-// Get the host name
-const host = process.env.npm_config_host;
-if (!host) {
-  console.log('Host of the receiving server is required: --host=...');
-  process.exit(1);
-}
-
-// Encryption process based on:
-// https://medium.com/@tony.infisical/guide-to-nodes-crypto-module-for-encryption-decryption-65c077176980
-
-// Create a random initialization vector
-const iv = crypto.randomBytes(12).toString('base64');
-
-// Create a cipher
-const cipher = crypto.createCipheriv(
-  'aes-256-gcm',
-  Buffer.from(secret, 'base64'),
-  Buffer.from(iv, 'base64'),
-);
-
-// Encrypt the string
-let ciphertext = cipher.update(secret, 'utf8', 'base64');
-
-// Finalize the encryption
-ciphertext += cipher.final('base64');
-
-// Get the authentication tag
-const tag = cipher.getAuthTag();
-
-// JSONify the encrypted data
-const encryptionPack = encodeURIComponent(JSON.stringify({
-  ciphertext,
-  iv,
-  tag,
-}));
-
-// Show the encrypted data
-console.log('\n\n');
-console.log('––––– Done! What\'s Next: –––––');
-console.log('');
-console.log('On the server *sending* the requests, append the following to the REACTKIT_CROSS_SERVER_CREDENTIALS env var:');
-console.log(`|${host}:${key}:${secret}|`);
-console.log('');
-console.log('On the server *receiving* the requests, add an entry to the "CrossServerCredential" collection:');
-console.log(`{ "description": "${description}", "key": "${key}", "encodedeSecret": "${encryptionPack}", "scopes": [] }`);
-console.log('');
-console.log('For all scopes that the server should have access to, add them to the "scopes" array.');