dce-reactkit 3.4.0 → 3.5.1-beta.1

package/dist/esm/types/helpers/getLocalTimeInfo.test.d.ts

@@ -1,6 +0,0 @@
-/**
- * Test for getLocalTimeInfo helper function
- *   NOTE: only works if this test is run on a machine in ET
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/getMonthName.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test for getMonthName helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/getOrdinal.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getOrdinal helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/getPartOfDay.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getPartOfDay helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/getTimeInfoInET.test.d.ts

@@ -1,5 +0,0 @@
-/**
- * Test file for the getTimeInfoInET helper
- * @author Gabe Abrams
- */
-export {};

package/dist/esm/types/helpers/validators/shared/constants/ERROR_MESSAGES.d.ts

@@ -1,10 +0,0 @@
-export declare const INVALID_REGEX_ERROR = "input does not follow the requested format";
-export declare const INVALID_EMAIL_ERROR = "Please provide a valid email address.";
-export declare const INVALID_PHONE_ERROR = "Please provide a valid phone number.";
-export declare const INVALID_STRING_ERRORS: {
-    MIN_LEN: (minLen: number) => string;
-    MAX_LEN: (maxLen: number) => string;
-    LETTERS_ONLY: string;
-    NUMBERS_ONLY: string;
-    MESSAGE_INTRO: string;
-};

package/dist/esm/types/helpers/validators/shared/helpers/validateRegex.d.ts

@@ -1,19 +0,0 @@
-import ValidationResult from '../types/ValidationResult';
-/**
- * Determines whether a given input string is considered valid based on
- *   the provided regex.
- * @author Austen Money
- * @param opts object containing all args
- * @param opts.input user-provided input to validate
- * @param opts.regex regular expression to check against input
- * @param [opts.regexDescription] description of what regexString is checking
- *   for, used to customize error message
- * @returns the unchanged input if valid, or a customized error message if
- *   invalid
- */
-declare const validateRegex: (opts: {
-    input: string;
-    regex: RegExp;
-    regexDescription?: string;
-}) => ValidationResult<string>;
-export default validateRegex;

package/dist/esm/types/helpers/validators/shared/types/ValidationResult.d.ts

@@ -1,12 +0,0 @@
-/**
- * Result of a validation function.
- * @author Austen Money
- */
-type ValidationResult<CleanedValueType> = ({
-    isValid: true;
-    cleanedValue: CleanedValueType;
-} | {
-    isValid: false;
-    errorMessage: string;
-});
-export default ValidationResult;

package/dist/esm/types/helpers/validators/validateEmail.d.ts

@@ -1,11 +0,0 @@
-import ValidationResult from './shared/types/ValidationResult';
-/**
- * Determines whether a given email address is valid.
- * @author Austen Money
- * @param email email address to validate
- * @returns whether email fulfills proper formatting requirements, includes a
- *   cleaned version of the address without leading or trailing
- *   whitespace if valid or an error message if invalid.
- */
-declare const validateEmail: (email: string) => ValidationResult<string>;
-export default validateEmail;

package/dist/esm/types/helpers/validators/validateEmail.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/helpers/validators/validatePhoneNumber.d.ts

@@ -1,11 +0,0 @@
-import ValidationResult from './shared/types/ValidationResult';
-/**
- * Determines whether a given phone number is valid.
- * @author Austen Money
- * @param phoneNumber phone number to validate
- * @returns whether phone number is considered valid - if valid, also returns
- *   a cleaned version of the number without any formatting. If invalid,
- *   returns an error message.
- */
-declare const validatePhoneNumber: (phoneNumber: string) => ValidationResult<string>;
-export default validatePhoneNumber;

package/dist/esm/types/helpers/validators/validatePhoneNumber.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/helpers/validators/validateString.d.ts

@@ -1,22 +0,0 @@
-import ValidationResult from './shared/types/ValidationResult';
-/**
- * Determines whether a given input string is considered valid based on
- *   the provided requirements.
- * @author Austen Money
- * @param input input string
- * @param opts options for validation
- * @returns whether input is considered valid according to reqs - if
- *   valid, returns a cleaned version of input; if invalid, returns
- *   a string containing error messages describing which requirements
- *   were not met.
- */
-declare const validateString: (input: string, opts: {
-    ignoreWhitespace?: boolean;
-    minLen?: number;
-    maxLen?: number;
-    lettersOnly?: boolean;
-    numbersOnly?: boolean;
-    regexTest?: RegExp;
-    regexDescription?: string;
-}) => ValidationResult<string>;
-export default validateString;

package/dist/esm/types/helpers/validators/validateString.test.d.ts

@@ -1 +0,0 @@
-export {};

package/src/helpers/abbreviate.test.ts

@@ -1,26 +0,0 @@
-/**
- * Unit tests for abbreviate helper
- * @author Gabe Abrams
- */
-
-import abbreviate from './abbreviate';
-
-describe('helpers > abbreviate', () => {
-  it('should return the original text if it is shorter than the maxChars parameter', () => {
-      const text = 'Hello, world!';
-      const maxChars = 20;
-      expect(abbreviate(text, maxChars)).toEqual(text);
-  });
-
-  it('should abbreviate the text if it is longer than the maxChars parameter', () => {
-    const text = 'This is a really long string that needs to be abbreviated';
-    const maxChars = 20;
-    expect(abbreviate(text, maxChars)).toEqual('This is a really...');
-  });
-
-  it('should handle leading/trailing whitespace', () => {
-    const text = '   This is a string with leading/trailing whitespace   ';
-    const maxChars = 20;
-    expect(abbreviate(text, maxChars)).toEqual('This is a string...');
-  });
-});

package/src/helpers/avg.test.ts

@@ -1,24 +0,0 @@
-/**
- * Unit tests for avg helper
- * @author Gabe Abrams
- */
-
-import avg from './avg';
-
-describe('helpers > avg', () => {
-  it('should return 0 for an empty array', () => {
-    expect(avg([])).toEqual(0);
-  });
-
-  it('should return the correct average for an array of numbers', () => {
-    expect(avg([1, 2, 3, 4, 5])).toEqual(3);
-  });
-
-  it('should handle negative numbers', () => {
-    expect(avg([-1, 0, 1])).toEqual(0);
-  });
-
-  it('should handle decimal numbers', () => {
-    expect(avg([1.5, 2.5, 3.5])).toEqual(2.5);
-  });
-});

package/src/helpers/canReviewLogs.test.ts

@@ -1,67 +0,0 @@
-/**
- * Unit tests for canReviewLogs
- * @author Gabe Abrams
- */
-
-// Import dce-reactkit
-import stubServerEndpoint from './stubServerEndpoint';
-
-// Import main function
-import canReviewLogs, { resetCanReviewCache } from './canReviewLogs';
-
-// Import shared constants
-import LOG_REVIEW_STATUS_ROUTE from '../constants/LOG_REVIEW_STATUS_ROUTE';
-
-describe('helpers > canReviewLogs', () => {
-  beforeEach(() => {
-    // Reset the cache
-    resetCanReviewCache();
-  });
-
-  it('should return true if the server returns a truthy value', async () => {
-    stubServerEndpoint({
-      method: 'GET',
-      path: LOG_REVIEW_STATUS_ROUTE,
-      body: true,
-    });
-
-    const result = await canReviewLogs();
-    expect(result).toEqual(true);
-  });
-
-  it('should return false if the server returns a falsy value', async () => {
-    stubServerEndpoint({
-      method: 'GET',
-      path: LOG_REVIEW_STATUS_ROUTE,
-      body: false,
-    });
-
-    const result = await canReviewLogs();
-    expect(result).toEqual(false);
-  });
-
-  it('should return false if the server throws an error', async () => {
-    stubServerEndpoint({
-      method: 'GET',
-      path: LOG_REVIEW_STATUS_ROUTE,
-      errorMessage: 'Server error',
-      errorCode: 'C500',
-    });
-
-    const result = await canReviewLogs();
-    expect(result).toEqual(false);
-  });
-
-  it('should cache the server response and return it on subsequent calls', async () => {
-    stubServerEndpoint({
-      method: 'GET',
-      path: LOG_REVIEW_STATUS_ROUTE,
-      body: true,
-    });
-
-    const result1 = await canReviewLogs();
-    const result2 = await canReviewLogs();
-    expect(result1).toEqual(true);
-    expect(result2).toEqual(true);
-  });
-});

package/src/helpers/ceilToNumDecimals.test.ts

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

package/src/helpers/compareArraysByProp.test.ts

@@ -1,102 +0,0 @@
-/**
- * Test file for the compareArraysByProp helper
- * @author Gabe Abrams
- */
-
-// Import main helper
-import compareArraysByProp from './compareArraysByProp';
-
-describe('compareArraysByProp', () => {
-  it('should return true for two empty arrays', () => {
-    const result = compareArraysByProp([], [], 'id');
-    expect(result).toEqual(true);
-  });
-
-  it('should return true for two arrays with the same objects in the same order', () => {
-    const a = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }, { id: 3, name: 'Charlie' }];
-    const b = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }, { id: 3, name: 'Charlie' }];
-    const result = compareArraysByProp(a, b, 'id');
-    expect(result).toEqual(true);
-  });
-
-  it('should return true for two arrays with the same objects in a different order', () => {
-    const a = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }, { id: 3, name: 'Charlie' }];
-    const b = [{ id: 3, name: 'Charlie' }, { id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
-    const result = compareArraysByProp(a, b, 'id');
-    expect(result).toEqual(true);
-  });
-
-  it('should return false for two arrays with different objects', () => {
-    const a = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }, { id: 3, name: 'Charlie' }];
-    const b = [{ id: 4, name: 'Dave' }, { id: 5, name: 'Eve' }, { id: 6, name: 'Frank' }];
-    const result = compareArraysByProp(a, b, 'id');
-    expect(result).toEqual(false);
-  });
-
-  it('should return false for two arrays with different objects and some shared objects', () => {
-    const a = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }, { id: 3, name: 'Charlie' }];
-    const b = [{ id: 2, name: 'Bob' }, { id: 3, name: 'Charlie' }, { id: 4, name: 'Dave' }];
-    const result = compareArraysByProp(a, b, 'id');
-    expect(result).toEqual(false);
-  });
-
-  it('should return true for two arrays with the same objects with multiple properties', () => {
-    const a = [
-      { id: 1, name: 'Alice', age: 25 },
-      { id: 2, name: 'Bob', age: 30 },
-      { id: 3, name: 'Charlie', age: 35 },
-    ];
-    const b = [
-      { id: 1, name: 'Alice', age: 25 },
-      { id: 2, name: 'Bob', age: 30 },
-      { id: 3, name: 'Charlie', age: 35 },
-    ];
-    const result = compareArraysByProp(a, b, 'id');
-    expect(result).toEqual(true);
-  });
-
-  it('should return true for two arrays with the same objects with multiple properties in a different order', () => {
-    const a = [
-      { id: 1, name: 'Alice', age: 25 },
-      { id: 2, name: 'Bob', age: 30 },
-      { id: 3, name: 'Charlie', age: 35 },
-    ];
-    const b = [
-      { id: 3, name: 'Charlie', age: 35 },
-      { id: 1, name: 'Alice', age: 25 },
-      { id: 2, name: 'Bob', age: 30 },
-    ];
-    const result = compareArraysByProp(a, b, 'id');
-    expect(result).toEqual(true);
-  });
-
-  it('should return false for two arrays with different objects with multiple properties', () => {
-    const a = [
-      { id: 1, name: 'Alice', age: 25 },
-      { id: 2, name: 'Bob', age: 30 },
-      { id: 3, name: 'Charlie', age: 35 },
-    ];
-    const b = [
-      { id: 4, name: 'Dave', age: 40 },
-      { id: 5, name: 'Eve', age: 45 },
-      { id: 6, name: 'Frank', age: 50 },
-    ];
-    const result = compareArraysByProp(a, b, 'id');
-    expect(result).toEqual(false);
-  });
-
-  it('should return false for two arrays with different objects with multiple properties and some shared objects', () => {
-    const a = [
-      { id: 1, name: 'Alice', age: 25 },
-      { id: 2, name: 'Bob', age: 30 },
-      { id: 3, name: 'Charlie', age: 35 },
-    ];
-    const b = [
-      { id: 2, name: 'Bob', age: 30 },
-      { id: 3, name: 'Charlie', age: 35 },
-      { id: 4, name: 'Dave', age: 40 },
-    ];
-    const result = compareArraysByProp(a, b, 'id');
-    expect(result).toEqual(false);
-  });
-});

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/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/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/genCSV.test.ts

@@ -1,61 +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);
-  });
-});

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;