dce-reactkit 4.3.4 → 5.0.0

package/src/helpers/extractProp.test.ts

@@ -1,34 +0,0 @@
-/**
- * Test file for the extractProp helper
- * @author Gabe Abrams
- */
-
-// Import main helper
-import extractProp from './extractProp';
-
-describe('extractProp', () => {
-  it('should return an empty array if the input array is empty', () => {
-    const result = extractProp([], 'age');
-    expect(result).toEqual([]);
-  });
-
-  it('should extract the correct property from each object in the array', () => {
-    const users = [
-      { name: 'Alice', age: 25 },
-      { name: 'Bob', age: 30 },
-      { name: 'Charlie', age: 35 },
-    ];
-    const result = extractProp(users, 'age');
-    expect(result).toEqual([25, 30, 35]);
-  });
-
-  it('should return undefined for objects that do not have the specified property', () => {
-    const users = [
-      { name: 'Alice', age: 25 },
-      { name: 'Bob' },
-      { name: 'Charlie', age: 35 },
-    ];
-    const result = extractProp(users, 'age');
-    expect(result).toEqual([25, undefined, 35]);
-  });
-});

package/src/helpers/extractProp.ts

@@ -1,17 +0,0 @@
-/**
- * For every element in an array, extract the value of a prop
- *   (e.g. for all user objects, extract their ages and put that into a new
- *   ages array)
- * @author Gabe Abrams
- * @param arr the array of objects to operate on
- * @param prop the property to extract from each object
- * @returns new array containing the corresponding values, in order, of each
- *   object in the original array
- */
-const extractProp = (arr: any[], prop: string) => {
-  return arr.map((item) => {
-    return item[prop];
-  });
-};
-
-export default extractProp;

package/src/helpers/floorToNumDecimals.test.ts

@@ -1,39 +0,0 @@
-/**
- * Test file for the floorToNumDecimals helper
- * @author Gabe Abrams
- */
-
-// Import main function
-import floorToNumDecimals from './floorToNumDecimals';
-
-describe('floorToNumDecimals', () => {
-  it('should return 0 for 0 with 0 decimals', () => {
-    const result = floorToNumDecimals(0, 0);
-    expect(result).toEqual(0);
-  });
-
-  it('should return 1 for 1 with 0 decimals', () => {
-    const result = floorToNumDecimals(1, 0);
-    expect(result).toEqual(1);
-  });
-
-  it('should return 1.23 for 1.234 with 2 decimals', () => {
-    const result = floorToNumDecimals(1.234, 2);
-    expect(result).toEqual(1.23);
-  });
-
-  it('should return -1.24 for -1.234 with 2 decimals', () => {
-    const result = floorToNumDecimals(-1.234, 2);
-    expect(result).toEqual(-1.24);
-  });
-
-  it('should return 1234 for 1234 with 0 decimals', () => {
-    const result = floorToNumDecimals(1234, 0);
-    expect(result).toEqual(1234);
-  });
-
-  it('should return 0.001 for 0.00123 with 3 decimals', () => {
-    const result = floorToNumDecimals(0.00123, 3);
-    expect(result).toEqual(0.001);
-  });
-});

package/src/helpers/floorToNumDecimals.ts

@@ -1,13 +0,0 @@
-/**
- * Round a number (floor) to a certain number of decimals
- * @author Gabe Abrams
- * @param num the number to round
- * @param numDecimals the number of decimals to round to
- * @returns rounded number
- */
-const floorToNumDecimals = (num: number, numDecimals: number): number => {
-  const rounder = 10 ** numDecimals;
-  return (Math.floor(num * rounder) / rounder);
-};
-
-export default floorToNumDecimals;

package/src/helpers/forceNumIntoBounds.test.ts

@@ -1,34 +0,0 @@
-/**
- * Test file for the forceNumIntoBounds helper
- * @author Gabe Abrams
- */
-
-// Import main helper
-import forceNumIntoBounds from './forceNumIntoBounds';
-
-describe('forceNumIntoBounds', () => {
-  it('should return the number if it is within the bounds', () => {
-    const result = forceNumIntoBounds(5, 0, 10);
-    expect(result).toEqual(5);
-  });
-
-  it('should return the minimum bound if the number is less than the minimum', () => {
-    const result = forceNumIntoBounds(-5, 0, 10);
-    expect(result).toEqual(0);
-  });
-
-  it('should return the maximum bound if the number is greater than the maximum', () => {
-    const result = forceNumIntoBounds(15, 0, 10);
-    expect(result).toEqual(10);
-  });
-
-  it('should return the minimum bound if the number is equal to the minimum', () => {
-    const result = forceNumIntoBounds(0, 0, 10);
-    expect(result).toEqual(0);
-  });
-
-  it('should return the maximum bound if the number is equal to the maximum', () => {
-    const result = forceNumIntoBounds(10, 0, 10);
-    expect(result).toEqual(10);
-  });
-});

package/src/helpers/forceNumIntoBounds.ts

@@ -1,19 +0,0 @@
-/**
- * Force a number to stay within specific bounds
- * @author Gabe Abrams
- * @param num the number to move into the bounds
- * @param min the minimum number in the bound
- * @param max the maximum number in the bound
- * @returns bounded number
- */
-const forceNumIntoBounds = (num: number, min: number, max: number): number => {
-  return Math.max(
-    min,
-    Math.min(
-      max,
-      num,
-    ),
-  );
-};
-
-export default forceNumIntoBounds;

package/src/helpers/genCSV.test.ts

@@ -1,75 +0,0 @@
-/**
- * Test file for the genCSV helper
- * @author Gabe Abrams
- */
-
-// Import main helper
-import genCSV from './genCSV';
-
-describe('genCSV', () => {
-  it('should return an empty string for empty data', () => {
-    const result = genCSV([], []);
-    expect(result).toEqual('');
-  });
-
-  it('should generate a CSV with the correct headers and data', () => {
-    const columns = [
-      { title: 'Name', param: 'name' },
-      { title: 'Age', param: 'age' },
-      { title: 'Email', param: 'email' },
-    ];
-    const data = [
-      { name: 'Alice', age: 25, email: 'alice@example.com' },
-      { name: 'Bob', age: 30, email: 'bob@example.com' },
-      { name: 'Charlie', age: 35, email: 'charlie@example.com' },
-    ];
-    const expected = 'Name,Age,Email\nAlice,25,alice@example.com\nBob,30,bob@example.com\nCharlie,35,charlie@example.com';
-    const result = genCSV(data, columns);
-    expect(result).toEqual(expected);
-  });
-
-  it('should handle undefined and null values correctly', () => {
-    const columns = [
-      { title: 'Name', param: 'name' },
-      { title: 'Age', param: 'age' },
-      { title: 'Email', param: 'email' },
-    ];
-    const data = [
-      { name: 'Alice', age: undefined, email: null },
-      { name: 'Bob', age: null, email: 'bob@example.com' },
-      { name: 'Charlie', age: 35, email: undefined },
-    ];
-    const expected = 'Name,Age,Email\nAlice,,\nBob,,bob@example.com\nCharlie,35,';
-    const result = genCSV(data, columns);
-    expect(result).toEqual(expected);
-  });
-
-  it('should handle objects in cells correctly', () => {
-    const columns = [
-      { title: 'Name', param: 'name' },
-      { title: 'Data', param: 'data' },
-    ];
-    const data = [
-      { name: 'Alice', data: { foo: 'bar' } },
-      { name: 'Bob', data: [1, 2, 3] },
-      { name: 'Charlie', data: null },
-    ];
-    const expected = 'Name,Data\nAlice,"{""foo"":""bar""}"\nBob,"[1,2,3]"\nCharlie,';
-    const result = genCSV(data, columns);
-    expect(result).toEqual(expected);
-  });
-
-  it('should use textIfUndefined for undefined values', () => {
-    const columns = [
-      { title: 'Name', param: 'name' },
-      { title: 'Age', param: 'age', textIfUndefined: 'N/A' },
-    ];
-    const data = [
-      { name: 'Alice', age: undefined },
-      { name: 'Bob', age: 30 },
-    ];
-    const expected = 'Name,Age\nAlice,N/A\nBob,30';
-    const result = genCSV(data, columns);
-    expect(result).toEqual(expected);
-  });
-});

package/src/helpers/genCSV.ts

@@ -1,87 +0,0 @@
-/**
- * Escape a CSV cell if needed
- * @author Gabe Abrams
- * @param text the cell contents
- * @returns escaped cell text
- */
-const escapeCellText = (text: string): string => {
-  if (
-    !String(text).includes(',')
-    && !String(text).includes('"')
-  ) {
-    // No need to escape
-    return String(text);
-  }
-
-  // Perform escape
-  return `"${String(text).replace(/"/g, '""')}"`;
-};
-
-/**
- * Generate a CSV file
- * @author Gabe Abrams
- * @param data list of row data in the form of json objects
- * @param columns list of columns to include in the csv where each column is an object with:
- * - title: the column title
- * - param: the key in the data object to use for this column
- * - textIfUndefined: optional text to use if the value is undefined (defaults to empty string)
- * @returns multiline csv string
- */
-const genCSV = (
-  data: {
-    [k: string]: any
-  }[],
-  columns: {
-    title: string,
-    param: string,
-    textIfUndefined?: string,
-  }[],
-): string => {
-  let csv = '';
-
-  // Add header
-  csv += (
-    columns
-      .map((column) => {
-        return escapeCellText(column.title);
-      })
-      .join(',')
-  );
-
-  // Add each row
-  data.forEach((datum) => {
-    csv += '\n';
-    csv += (
-      columns
-        .map((column) => {
-          let contents: string;
-          const cell = datum[column.param];
-          if (
-            typeof cell === 'string'
-            || typeof cell === 'number'
-            || typeof cell === 'boolean'
-          ) {
-            contents = String(cell);
-          } else if (cell === null) {
-            contents = '';
-          } else if (typeof cell === 'undefined') {
-            contents = (
-              column.textIfUndefined
-              ?? ''
-            );
-          } else if (typeof cell === 'object') {
-            contents = JSON.stringify(cell);
-          } else {
-            contents = '';
-          }
-          return escapeCellText(contents);
-        })
-        .join(',')
-    );
-  });
-
-  // Return
-  return csv;
-};
-
-export default genCSV;

package/src/helpers/genCommaList.test.ts

@@ -1,57 +0,0 @@
-// Import function
-import genCommaList from './genCommaList';
-
-test(
-  'Empty list.',
-  async () => {
-    const emptyList: string[] = [];
-    const emptyListResponse: string = '';
-
-    const result = genCommaList(emptyList);
-    expect(result).toStrictEqual(emptyListResponse);
-  },
-);
-
-test(
-  'One word list.',
-  async () => {
-    const oneList: string[] = ['apples'];
-    const oneListResponse: string = 'apples';
-
-    const result = genCommaList(oneList);
-    expect(result).toStrictEqual(oneListResponse);
-  },
-);
-
-test(
-  'Two word list.',
-  async () => {
-    const twoList: string[] = ['apples', 'oranges'];
-    const twoListResponse: string = 'apples and oranges';
-
-    const result = genCommaList(twoList);
-    expect(result).toStrictEqual(twoListResponse);
-  },
-);
-
-test(
-  'Three word list.',
-  async () => {
-    const threeList: string[] = ['apples', 'oranges', 'bananas'];
-    const threeListResponse: string = 'apples, oranges, and bananas';
-
-    const result = genCommaList(threeList);
-    expect(result).toStrictEqual(threeListResponse);
-  },
-);
-
-test(
-  'Four word list.',
-  async () => {
-    const fourList: string[] = ['apples', 'oranges', 'bananas', 'grapes'];
-    const fourListResponse: string = 'apples, oranges, bananas, and grapes';
-
-    const result = genCommaList(fourList);
-    expect(result).toStrictEqual(fourListResponse);
-  },
-);

package/src/helpers/genCommaList.ts

@@ -1,21 +0,0 @@
-/**
- * Given an array of strings, create a single comma-separated string that includes
- * 'and' as well as an oxford comma.
- *   Ex: ['apples'] => 'apples'
- *   Ex: ['apples', 'bananas'] => 'apples and bananas'
- *   Ex: ['apples', 'bananas', 'grapes'] => 'apples, bananas, and grapes'
- * @author Austen Money
- * @param list an array of elements to be made into a single comma-separated string.
- * @returns a comma-separated string.
- */
-const genCommaList = (list: string[]): string => {
-  const { length } = list;
-
-  return (
-    length < 2
-      ? list.join('')
-      : `${list.slice(0, length - 1).join(', ')}${length < 3 ? ' and ' : ', and '}${list[length - 1]}`
-  );
-};
-
-export default genCommaList;

package/src/helpers/getHumanReadableDate.test.ts

@@ -1,29 +0,0 @@
-/**
- * Test file for the getHumanReadableDate helper
- * @author Gabe Abrams
- */
-
-// Import helpers
-import getHumanReadableDate from './getHumanReadableDate';
-import getOrdinal from './getOrdinal';
-
-describe('getHumanReadableDate', () => {
-  it('should return the current date if no argument is passed', () => {
-    const result = getHumanReadableDate();
-    const now = new Date();
-    const expected = `${now.toLocaleString('default', { month: 'short' })} ${now.getDate()}${getOrdinal(now.getDate())}`;
-    expect(result).toEqual(expected);
-  });
-
-  it('should return the correct date for a given timestamp', () => {
-    const timestamp = 1629822000000; // 2021-08-24T12:20:00.000Z
-    const result = getHumanReadableDate(timestamp);
-    expect(result).toEqual('Aug 24th 2021');
-  });
-
-  it('should return the correct date for a given Date object', () => {
-    const date = new Date('2021-08-24T12:20:00.000Z');
-    const result = getHumanReadableDate(date);
-    expect(result).toEqual('Aug 24th 2021');
-  });
-});

package/src/helpers/getHumanReadableDate.ts

@@ -1,36 +0,0 @@
-// Import shared helpers
-import getTimeInfoInET from './getTimeInfoInET';
-import getOrdinal from './getOrdinal';
-import getMonthName from './getMonthName';
-
-/**
- * Get a human-readable description of a date (all in ET)
- * @author Gabe Abrams
- * @param [dateOrTimestamp=today] the date or timestamp for the date to describe
- * @returns human-readable description of the date
- */
-const getHumanReadableDate = (dateOrTimestamp?: Date | number) => {
-  // Get the date info
-  const {
-    month,
-    day,
-    year,
-  } = getTimeInfoInET(dateOrTimestamp);
-  const currYear = getTimeInfoInET().year;
-
-  // Get the short month description
-  const monthName = getMonthName(month).short;
-
-  // Create start of description
-  let description = `${monthName} ${day}${getOrdinal(day)}`;
-
-  // Add on year if it's different
-  if (year !== currYear) {
-    description += ` ${year}`;
-  }
-
-  // Return description
-  return description;
-};
-
-export default getHumanReadableDate;

package/src/helpers/getLocalTimeInfo.test.ts

@@ -1,48 +0,0 @@
-/**
- * Test for getLocalTimeInfo helper function
- *   NOTE: only works if this test is run on a machine in ET
- * @author Gabe Abrams
- */
-
-// Import main function
-import getLocalTimeInfo from './getLocalTimeInfo';
-
-describe('getLocalTimeInfo', () => {
-  it('should return current time info if no argument is passed', () => {
-    const result = getLocalTimeInfo();
-    const now = new Date();
-    expect(result.timestamp).toBeCloseTo(now.getTime(), -3);
-    expect(result.year).toEqual(now.getFullYear());
-    expect(result.month).toEqual(now.getMonth() + 1);
-    expect(result.day).toEqual(now.getDate());
-    expect(result.hour).toEqual(now.getHours());
-    expect(result.minute).toEqual(now.getMinutes());
-    expect(result.isPM).toEqual(now.getHours() >= 12);
-  });
-
-  it('should return correct time info for a given timestamp', () => {
-    const timestamp = 1629822000000; // 2021-08-24T12:20:00.000Z
-    const result = getLocalTimeInfo(timestamp);
-    expect(result.timestamp).toEqual(timestamp);
-    expect(result.year).toEqual(2021);
-    expect(result.month).toEqual(8);
-    expect(result.day).toEqual(24);
-    expect(result.hour).toEqual(12);
-    expect(result.hour12).toEqual(12);
-    expect(result.minute).toEqual(20);
-    expect(result.isPM).toEqual(true);
-  });
-
-  it('should return correct time info for a given Date object', () => {
-    const date = new Date('2021-08-24T12:20:00.000Z');
-    const result = getLocalTimeInfo(date);
-    expect(result.timestamp).toEqual(date.getTime());
-    expect(result.year).toEqual(2021);
-    expect(result.month).toEqual(8);
-    expect(result.day).toEqual(24);
-    expect(result.hour).toEqual(8);
-    expect(result.hour12).toEqual(8);
-    expect(result.minute).toEqual(20);
-    expect(result.isPM).toEqual(false);
-  });
-});

package/src/helpers/getLocalTimeInfo.ts

@@ -1,58 +0,0 @@
-/**
- * Get current time info in local time
- * @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 time values for year, month, day, hour, hour12, minute, isPM
- *   where hour is in 24hr time and hour12 is in 12hr time.
- */
-const getLocalTimeInfo = (dateOrTimestamp?: Date | number): {
-  timestamp: number,
-  year: number,
-  month: number,
-  day: number,
-  hour: number,
-  hour12: number,
-  minute: 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;
-  }
-
-  // Create all time numbers
-  const timestamp = d.getTime();
-  const year = d.getFullYear();
-  const month = d.getMonth() + 1;
-  const day = d.getDate();
-  const hour = d.getHours();
-  const isPM = hour >= 12;
-  let hour12 = hour % 12;
-  if (hour12 === 0) {
-    hour12 = 12;
-  }
-  const minute = d.getMinutes();
-
-  // Return
-  return {
-    timestamp,
-    year,
-    month,
-    day,
-    hour,
-    hour12,
-    isPM,
-    minute,
-  };
-};
-
-export default getLocalTimeInfo;

package/src/helpers/getMonthName.test.ts

@@ -1,79 +0,0 @@
-/**
- * Test for getMonthName helper
- * @author Gabe Abrams
- */
-
-// Import main helper
-import getMonthName from './getMonthName';
-
-describe('getMonthName', () => {
-  it('should return January for 1', () => {
-    const result = getMonthName(1);
-    expect(result).toEqual({ short: 'Jan', full: 'January' });
-  });
-
-  it('should return February for 2', () => {
-    const result = getMonthName(2);
-    expect(result).toEqual({ short: 'Feb', full: 'February' });
-  });
-
-  it('should return March for 3', () => {
-    const result = getMonthName(3);
-    expect(result).toEqual({ short: 'Mar', full: 'March' });
-  });
-
-  it('should return April for 4', () => {
-    const result = getMonthName(4);
-    expect(result).toEqual({ short: 'Apr', full: 'April' });
-  });
-
-  it('should return May for 5', () => {
-    const result = getMonthName(5);
-    expect(result).toEqual({ short: 'May', full: 'May' });
-  });
-
-  it('should return June for 6', () => {
-    const result = getMonthName(6);
-    expect(result).toEqual({ short: 'Jun', full: 'June' });
-  });
-
-  it('should return July for 7', () => {
-    const result = getMonthName(7);
-    expect(result).toEqual({ short: 'Jul', full: 'July' });
-  });
-
-  it('should return August for 8', () => {
-    const result = getMonthName(8);
-    expect(result).toEqual({ short: 'Aug', full: 'August' });
-  });
-
-  it('should return September for 9', () => {
-    const result = getMonthName(9);
-    expect(result).toEqual({ short: 'Sep', full: 'September' });
-  });
-
-  it('should return October for 10', () => {
-    const result = getMonthName(10);
-    expect(result).toEqual({ short: 'Oct', full: 'October' });
-  });
-
-  it('should return November for 11', () => {
-    const result = getMonthName(11);
-    expect(result).toEqual({ short: 'Nov', full: 'November' });
-  });
-
-  it('should return December for 12', () => {
-    const result = getMonthName(12);
-    expect(result).toEqual({ short: 'Dec', full: 'December' });
-  });
-
-  it('should return January for 0', () => {
-    const result = getMonthName(0);
-    expect(result).toEqual({ short: 'Jan', full: 'January' });
-  });
-
-  it('should return January for 13', () => {
-    const result = getMonthName(13);
-    expect(result).toEqual({ short: 'Jan', full: 'January' });
-  });
-});

package/src/helpers/getMonthName.ts

@@ -1,29 +0,0 @@
-const monthNames = [
-  { short: 'Jan', full: 'January' },
-  { short: 'Feb', full: 'February' },
-  { short: 'Mar', full: 'March' },
-  { short: 'Apr', full: 'April' },
-  { short: 'May', full: 'May' },
-  { short: 'Jun', full: 'June' },
-  { short: 'Jul', full: 'July' },
-  { short: 'Aug', full: 'August' },
-  { short: 'Sep', full: 'September' },
-  { short: 'Oct', full: 'October' },
-  { short: 'Nov', full: 'November' },
-  { short: 'Dec', full: 'December' },
-];
-
-/**
- * Get the name of a month given the month number (1 = January, etc.)
- *   If an invalid number is provided, we will treat it like January
- * @author Gabe Abrams
- * @param month the number of the month
- * @returns object containing multiple month name formats:
- *   { short, full } where short will look like "Jan" and full will look like
- *   "January"
- */
-const getMonthName = (month: number) => {
-  return (monthNames[month - 1] ?? monthNames[0]);
-};
-
-export default getMonthName;