dce-reactkit 4.3.4 → 5.0.0

package/src/helpers/getOrdinal.test.ts

@@ -1,84 +0,0 @@
-/**
- * Test file for the getOrdinal helper
- * @author Gabe Abrams
- */
-
-// Import main function
-import getOrdinal from './getOrdinal';
-
-describe('getOrdinal', () => {
-  it('should return "th" for 0', () => {
-    const result = getOrdinal(0);
-    expect(result).toEqual('th');
-  });
-
-  it('should return "st" for 1', () => {
-    const result = getOrdinal(1);
-    expect(result).toEqual('st');
-  });
-
-  it('should return "nd" for 2', () => {
-    const result = getOrdinal(2);
-    expect(result).toEqual('nd');
-  });
-
-  it('should return "rd" for 3', () => {
-    const result = getOrdinal(3);
-    expect(result).toEqual('rd');
-  });
-
-  it('should return "th" for 4', () => {
-    const result = getOrdinal(4);
-    expect(result).toEqual('th');
-  });
-
-  it('should return "th" for 11', () => {
-    const result = getOrdinal(11);
-    expect(result).toEqual('th');
-  });
-
-  it('should return "st" for 21', () => {
-    const result = getOrdinal(21);
-    expect(result).toEqual('st');
-  });
-
-  it('should return "nd" for 22', () => {
-    const result = getOrdinal(22);
-    expect(result).toEqual('nd');
-  });
-
-  it('should return "rd" for 23', () => {
-    const result = getOrdinal(23);
-    expect(result).toEqual('rd');
-  });
-
-  it('should return "th" for 24', () => {
-    const result = getOrdinal(24);
-    expect(result).toEqual('th');
-  });
-
-  it('should return "th" for 100', () => {
-    const result = getOrdinal(100);
-    expect(result).toEqual('th');
-  });
-
-  it('should return "st" for 101', () => {
-    const result = getOrdinal(101);
-    expect(result).toEqual('st');
-  });
-
-  it('should return "nd" for 102', () => {
-    const result = getOrdinal(102);
-    expect(result).toEqual('nd');
-  });
-
-  it('should return "rd" for 103', () => {
-    const result = getOrdinal(103);
-    expect(result).toEqual('rd');
-  });
-
-  it('should return "th" for 104', () => {
-    const result = getOrdinal(104);
-    expect(result).toEqual('th');
-  });
-});

package/src/helpers/getOrdinal.ts

@@ -1,14 +0,0 @@
-// Constants
-const ORDINALS = ['th', 'st', 'nd', 'rd'];
-
-/**
- * Get a number's ordinal
- * @author Gabe Abrams
- * @param num the number being analyzed
- * @returns ordinal
- */
-const getOrdinal = (num: number): string => {
-  return (ORDINALS[(num - 20) % 10] ?? ORDINALS[num] ?? ORDINALS[0]);
-};
-
-export default getOrdinal;

package/src/helpers/getPartOfDay.test.ts

@@ -1,56 +0,0 @@
-/**
- * Test file for the getPartOfDay helper
- * @author Gabe Abrams
- */
-
-import getPartOfDay from './getPartOfDay';
-
-describe('getPartOfDay', () => {
-  it('should return "morning" if the current hour is less than 12', () => {
-    // Mock the current hour to be 9am
-    jest.spyOn(Date.prototype, 'getHours').mockReturnValue(9);
-
-    const result = getPartOfDay();
-    expect(result).toEqual('morning');
-  });
-
-  it('should return "afternoon" if the current hour is between 12 and 16 (inclusive)', () => {
-    // Mock the current hour to be 2pm
-    jest.spyOn(Date.prototype, 'getHours').mockReturnValue(14);
-
-    const result = getPartOfDay();
-    expect(result).toEqual('afternoon');
-  });
-
-  it('should return "evening" if the current hour is between 17 and 24 (inclusive)', () => {
-    // Mock the current hour to be 8pm
-    jest.spyOn(Date.prototype, 'getHours').mockReturnValue(20);
-
-    const result = getPartOfDay();
-    expect(result).toEqual('evening');
-  });
-
-  it('should return "evening" if the current hour is 17', () => {
-    // Mock the current hour to be 5pm
-    jest.spyOn(Date.prototype, 'getHours').mockReturnValue(17);
-
-    const result = getPartOfDay();
-    expect(result).toEqual('evening');
-  });
-
-  it('should return "evening" if the current hour is 24', () => {
-    // Mock the current hour to be midnight
-    jest.spyOn(Date.prototype, 'getHours').mockReturnValue(24);
-
-    const result = getPartOfDay();
-    expect(result).toEqual('evening');
-  });
-
-  it('should return "morning" if the current hour is 0', () => {
-    // Mock the current hour to be midnight
-    jest.spyOn(Date.prototype, 'getHours').mockReturnValue(0);
-
-    const result = getPartOfDay();
-    expect(result).toEqual('morning');
-  });
-});

package/src/helpers/getPartOfDay.ts

@@ -1,20 +0,0 @@
-/**
- * Get the current part of day (morning, evening, etc.)
- * @author Gabe Abrams
- * @returns the part of day (morning, evening, etc.)
- */
-const getPartOfDay = () => {
-  // Setup the post-it time of day
-  let partOfDay = 'day';
-  const hours = new Date().getHours();
-  if (hours < 12) {
-    partOfDay = 'morning';
-  } else if (hours >= 12 && hours <= 16) {
-    partOfDay = 'afternoon';
-  } else if (hours > 16 && hours <= 24) {
-    partOfDay = 'evening';
-  }
-  return partOfDay;
-};
-
-export default getPartOfDay;

package/src/helpers/getTimeInfoInET.test.ts

@@ -1,72 +0,0 @@
-/**
- * Test file for the getTimeInfoInET helper
- * @author Gabe Abrams
- */
-
-// Import main function
-import getTimeInfoInET from './getTimeInfoInET';
-
-describe('getTimeInfoInET', () => {
-  it('should return the current time info in ET if no argument is passed', () => {
-    const result = getTimeInfoInET();
-    const now = new Date();
-    const expectedTimestamp = now.getTime();
-    const expectedYear = now.getFullYear();
-    const expectedMonth = now.getMonth() + 1;
-    const expectedDay = now.getDate();
-    const expectedHour = now.getHours();
-    const expectedHour12 = expectedHour % 12 || 12;
-    const expectedMinute = now.getMinutes();
-    const expectedIsPM = expectedHour >= 12;
-    expect(result.timestamp).toBeCloseTo(expectedTimestamp, -2);
-    expect(result.year).toEqual(expectedYear);
-    expect(result.month).toEqual(expectedMonth);
-    expect(result.day).toEqual(expectedDay);
-    expect(result.hour).toEqual(expectedHour);
-    expect(result.hour12).toEqual(expectedHour12);
-    expect(result.minute).toEqual(expectedMinute);
-    expect(result.isPM).toEqual(expectedIsPM);
-  });
-
-  it('should return the time info in ET for a specified date', () => {
-    const date = new Date('2022-01-01T00:00:00Z');
-    const result = getTimeInfoInET(date);
-    const expectedTimestamp = date.getTime();
-    const expectedYear = 2021;
-    const expectedMonth = 12;
-    const expectedDay = 31;
-    const expectedHour = 19;
-    const expectedHour12 = 7;
-    const expectedMinute = 0;
-    const expectedIsPM = true;
-    expect(result.timestamp).toEqual(expectedTimestamp);
-    expect(result.year).toEqual(expectedYear);
-    expect(result.month).toEqual(expectedMonth);
-    expect(result.day).toEqual(expectedDay);
-    expect(result.hour).toEqual(expectedHour);
-    expect(result.hour12).toEqual(expectedHour12);
-    expect(result.minute).toEqual(expectedMinute);
-    expect(result.isPM).toEqual(expectedIsPM);
-  });
-
-  it('should return the time info in ET for a specified timestamp', () => {
-    const timestamp = 1640995200000; // 2022-01-01T00:00:00Z
-    const result = getTimeInfoInET(timestamp);
-    const expectedTimestamp = timestamp;
-    const expectedYear = 2021;
-    const expectedMonth = 12;
-    const expectedDay = 31;
-    const expectedHour = 19;
-    const expectedHour12 = 7;
-    const expectedMinute = 0;
-    const expectedIsPM = true;
-    expect(result.timestamp).toEqual(expectedTimestamp);
-    expect(result.year).toEqual(expectedYear);
-    expect(result.month).toEqual(expectedMonth);
-    expect(result.day).toEqual(expectedDay);
-    expect(result.hour).toEqual(expectedHour);
-    expect(result.hour12).toEqual(expectedHour12);
-    expect(result.minute).toEqual(expectedMinute);
-    expect(result.isPM).toEqual(expectedIsPM);
-  });
-});

package/src/helpers/getTimeInfoInET.ts

@@ -1,79 +0,0 @@
-/**
- * Get current time info in US Boston Eastern Time, independent of machine
- *   timezone
- * @author Gabe Abrams
- * @param [dateOrTimestamp=now] the date to get info on or a ms since epoch timestamp
- * @returns object with timestamp (ms since epoch) and numbers
- *   corresponding to ET time values for year, month, day, hour, hour12, minute, second, isPM
- *   where hour is in 24hr time and hour12 is in 12hr time.
- */
-const getTimeInfoInET = (dateOrTimestamp?: Date | number): {
-  timestamp: number,
-  year: number,
-  month: number,
-  day: number,
-  hour: number,
-  hour12: number,
-  minute: number,
-  second: number,
-  isPM: boolean,
-} => {
-  // Create a time string
-  let d: Date;
-  if (!dateOrTimestamp) {
-    // Use now
-    d = new Date();
-  } else if (typeof dateOrTimestamp === 'number') {
-    // Convert to date
-    d = new Date(dateOrTimestamp);
-  } else {
-    // Already a date
-    d = dateOrTimestamp;
-  }
-  const str = d.toLocaleString(
-    'en-US', // Using US encoding (it's the only one installed on containers)
-    { timeZone: 'America/New_York' }, // Force EST timezone
-  );
-
-  // Parse the string for the date/time info
-  const [dateStr, timeStr] = str.split(', '); // Format: MM/DD/YYYY, HH:MM:SS AM
-  const [monthStr, dayStr, yearStr] = dateStr.split('/'); // Format: MM/DD/YYYY
-  const [hourStr, minStr, ending] = timeStr.split(':'); // Format: HH:MM:SS AM
-
-  // Create all time numbers
-  const timestamp = d.getTime();
-  const year = Number.parseInt(yearStr, 10);
-  const month = Number.parseInt(monthStr, 10);
-  const day = Number.parseInt(dayStr, 10);
-  const minute = Number.parseInt(minStr, 10);
-  const second = (
-    ending.split(' ')[0]
-      ? Number.parseInt(ending.split(' ')[0], 10)
-      : 0
-  );
-  const hour12 = Number.parseInt(hourStr, 10);
-  // Convert from am/pm to 24hr
-  const isAM = ending.toLowerCase().includes('am');
-  const isPM = !isAM;
-  let hour = hour12;
-  if (isPM && hour12 !== 12) {
-    hour += 12;
-  } else if (isAM && hour12 === 12) {
-    hour = 0;
-  }
-
-  // Return
-  return {
-    timestamp,
-    year,
-    month,
-    day,
-    hour,
-    hour12,
-    isPM,
-    minute,
-    second,
-  };
-};
-
-export default getTimeInfoInET;

package/src/helpers/getTimestampFromTimeInfoInET.ts

@@ -1,179 +0,0 @@
-// Import shared types
-import ErrorWithCode from '../errors/ErrorWithCode';
-import ReactKitErrorCode from '../types/ReactKitErrorCode';
-
-// Import shared helpers
-import getTimeInfoInET from './getTimeInfoInET';
-import padZerosLeft from './padZerosLeft';
-
-/*----------------------------------------*/
-/* --------------- Helpers -------------- */
-/*----------------------------------------*/
-
-/**
- * Check if a timestamp is valid
- * @author Gabe Abrams
- * @author Gardenia Liu
- * @param opts object containing all arguments
- * @param opts.timestamp Timestamp in milliseconds since epoch
- * @param opts.expectedYear Expected year
- * @param opts.expectedMonth Expected month
- * @param opts.expectedDay Expected day
- * @param opts.expectedHour Expected hour
- * @param opts.expectedMinute Expected minute
- * @returns 1 if the timestamp needs to be increased, -1 if it needs to be decreased, 0 if it is valid
- */
-const checkTimestamp = (
-  opts: {
-    timestamp: number,
-    expectedYear: number,
-    expectedMonth: number,
-    expectedDay: number,
-    expectedHour: number,
-    expectedMinute: number,
-  },
-): number => {
-  const {
-    timestamp,
-    expectedYear,
-    expectedMonth,
-    expectedDay,
-    expectedHour,
-    expectedMinute,
-  } = opts;
-
-  const timeInfoInET = getTimeInfoInET(timestamp);
-  if (timeInfoInET.year < expectedYear) {
-    return 1;
-  }
-  if (timeInfoInET.year > expectedYear) {
-    return -1;
-  }
-  if (timeInfoInET.month < expectedMonth) {
-    return 1;
-  }
-  if (timeInfoInET.month > expectedMonth) {
-    return -1;
-  }
-  if (timeInfoInET.day < expectedDay) {
-    return 1;
-  }
-  if (timeInfoInET.day > expectedDay) {
-    return -1;
-  }
-  if (timeInfoInET.hour < expectedHour) {
-    return 1;
-  }
-  if (timeInfoInET.hour > expectedHour) {
-    return -1;
-  }
-  if (timeInfoInET.minute < expectedMinute) {
-    return 1;
-  }
-  if (timeInfoInET.minute > expectedMinute) {
-    return -1;
-  }
-  return 0;
-};
-
-/*----------------------------------------*/
-/* ---------------- Main ---------------- */
-/*----------------------------------------*/
-
-/**
- * Get a timestamp (ms since epoch) from time info (year, month, day, hour, minute, etc.) in Eastern Time (ET)
- * @author Gardenia Liu
- * @author Gabe Abrams
- * @param opts object containing all arguments
- * @param opts.year Year (e.g. 2023)
- * @param opts.month Month (1-12)
- * @param opts.day Day of the month (1-31)
- * @param opts.hour Hour (0-23)
- * @param opts.minute Minute (0-59)
- * @returns Timestamp in milliseconds since epoch
- */
-const getTimestampFromTimeInfoInET = (
-  opts: {
-    year: number,
-    month: number,
-    day: number,
-    hour: number,
-    minute: number,
-  },
-): number => {
-  // Destructure opts
-  const {
-    year,
-    month,
-    day,
-    hour,
-    minute,
-  } = opts;
-
-  // Determine if the date is in DST in Eastern Time
-  const tempDate = new Date(year, month - 1, day);
-  const janOffset = new Date(year, 0, 1).getTimezoneOffset();
-  const isDST = tempDate.getTimezoneOffset() < janOffset;
-  const etOffset = isDST ? '-04:00' : '-05:00';
-
-  // Format with leading zeroes
-  const mm = padZerosLeft(month, 2);
-  const dd = padZerosLeft(day, 2);
-  const hh = padZerosLeft(hour, 2);
-  const min = padZerosLeft(minute, 2);
-
-  // Build ET ISO string and convert to UTC timestamp
-  const etISOString = `${year}-${mm}-${dd}T${hh}:${min}:00${etOffset}`;
-  const baseTimestamp = (new Date(etISOString)).getTime();
-  let timestamp = baseTimestamp;
-
-  // Heat seek to get the right timestamp
-  const maxOffset = 24 * 60; // 24 hours in minutes
-  let currentOffset = 0; // minutes
-  const offsetIncrement = 15; // minutes
-  const offsetDirection = checkTimestamp({
-    timestamp,
-    expectedYear: year,
-    expectedMonth: month,
-    expectedDay: day,
-    expectedHour: hour,
-    expectedMinute: minute,
-  });
-  if (offsetDirection === 0) {
-    // Valid! Return the timestamp
-    return timestamp;
-  }
-
-  // Heat seek
-  while (Math.abs(currentOffset) < maxOffset) {
-    // Update offset
-    currentOffset += (offsetDirection * offsetIncrement);
-
-    // Update timestamp
-    const offsetMs = currentOffset * 60 * 1000;
-    timestamp = baseTimestamp + offsetMs;
-
-    // Check timestamp again
-    const newDirection = checkTimestamp({
-      timestamp,
-      expectedYear: year,
-      expectedMonth: month,
-      expectedDay: day,
-      expectedHour: hour,
-      expectedMinute: minute,
-    });
-    if (newDirection === 0) {
-      // Valid! Return the timestamp
-      return timestamp;
-    }
-
-    // Invalid. Keep looping.
-  }
-
-  throw new ErrorWithCode(
-    `Timestamp mismatch: expected ${year}-${mm}-${dd} ${hh}:${min}, seeked to offset ${currentOffset} minutes but could not find a valid timestamp.`,
-    ReactKitErrorCode.ETTimestampInvalid,
-  );
-};
-
-export default getTimestampFromTimeInfoInET;

package/src/helpers/getWordCount.ts

@@ -1,26 +0,0 @@
-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/helpers/idify.ts

@@ -1,24 +0,0 @@
-/**
- * Convert a string to hyphenated lowercase format with no space or
- *   non-alphanumeric characters
- * @author Gabe Abrams
- * @param str the string to convert
- * @returns the idified string
- */
-const idify = (str: string): string => {
-  return (
-    str
-      // Trim whitespace
-      .trim()
-      // Convert to lowercase
-      .toLowerCase()
-      // Replace non-alphanumeric characters with hyphens
-      .replace(/[^a-z0-9]+/g, '-')
-      // Change multiple hyphens in a row for a single hyphen
-      .replace(/-+/g, '-')
-      // Remove hyphens at the beginning and end of the string
-      .replace(/^-+|-+$/g, '')
-  );
-};
-
-export default idify;

package/src/helpers/onlyKeepLetters.ts

@@ -1,11 +0,0 @@
-/**
- * Given a string, only keep the letters inside it
- * @author Gabe Abrams
- * @param str the string to parse
- * @returns only the letters inside of the string
- */
-const onlyKeepLetters = (str: string): string => {
-  return str.replace(/[^a-zA-Z]+/g, '');
-};
-
-export default onlyKeepLetters;

package/src/helpers/padDecimalZeros.tsx

@@ -1,32 +0,0 @@
-/**
- * Pad a number's decimal with zeros on the right
- *   (e.g. 5.2 becomes 5.20 with 2 digit padding)
- * @author Gabe Abrams
- * @param num the number to pad
- * @param numDigits the minimum number of digits after the decimal
- * @returns padded number
- */
-const padDecimalZeros = (num: number, numDigits: number): string => {
-  // Skip if nothing to do
-  if (numDigits < 1) {
-    return String(num);
-  }
-
-  // Convert to string
-  let out = String(num);
-
-  // Add a decimal point if there isn't one
-  if (!out.includes('.')) {
-    out += '.';
-  }
-
-  // Add zeros
-  while (out.split('.')[1].length < numDigits) {
-    out = `${out}0`;
-  }
-
-  // Return
-  return out;
-};
-
-export default padDecimalZeros;

package/src/helpers/padZerosLeft.tsx

@@ -1,21 +0,0 @@
-/**
- * Pad a number with zeros on the left (e.g. 5 becomes 05 with 2 digit padding)
- * @author Gabe Abrams
- * @param num the number to pad
- * @param numDigits the minimum number of digits before the decimal
- * @returns padded number
- */
-const padZerosLeft = (num: number, numDigits: number): string => {
-  // Convert to string
-  let out = String(num);
-
-  // Add zeros
-  while (out.split('.')[0].length < numDigits) {
-    out = `0${out}`;
-  }
-
-  // Return
-  return out;
-};
-
-export default padZerosLeft;

package/src/helpers/parallelLimit.ts

@@ -1,63 +0,0 @@
-/**
- * Run tasks in parallel with a limit on how many tasks can execute at once.
- *   No guarantees are made about the order of task execution
- * @author Gabe Abrams
- * @param taskFunctions functions that start asynchronous tasks and optionally
- *   resolve with values
- * @param [limit=no limit] maximum number of asynchronous tasks to permit to run at
- *   once
- * @returns array of resolved values in the same order as the task functions
- */
-const parallelLimit = async (
-  taskFunctions: (() => Promise<any>)[],
-  limit?: number,
-): Promise<any[]> => {
-  const results: any[] = [];
-
-  // Wait until finished with all tasks
-  await new Promise<void>((resolve) => {
-    /* ------------- Helpers ------------ */
-
-    let nextTaskIndex = 0;
-    let numFinishedTasks = 0;
-    /**
-     * Start the next task
-     * @author Gabe Abrams
-     */
-    const startTask = async () => {
-      const taskIndex = nextTaskIndex++;
-
-      // Get the task
-      const taskFunction = taskFunctions[taskIndex];
-      if (!taskFunction) {
-        return;
-      }
-
-      // Execute task
-      const result = await taskFunction();
-
-      // Add results
-      results[taskIndex] = result;
-
-      // Tally and finish
-      if (++numFinishedTasks === taskFunctions.length) {
-        return resolve();
-      }
-
-      // Not finished! Start another task
-      startTask();
-    };
-
-    /* ----------- Start Tasks ---------- */
-    
-    // If no limit, start all tasks. At least start 1 task
-    const numTasks = Math.max((limit || taskFunctions.length), 1);
-    for (let i = 0; i < numTasks; i++) {
-      startTask();
-    }
-  });
-
-  return results;
-};
-
-export default parallelLimit;