@ssa-ui-kit/utils 1.0.0 → 1.1.55-canary-dbf4f10-20250224

package/src/utils/dates/dates.spec.tsx

@@ -1,127 +0,0 @@
-import { dateFormatters } from './index';
-
-const { getTimeAgo } = dateFormatters;
-const date = Date.now();
-const timeValuesArr = [
-  {
-    input: date - 6000,
-    output: 'Just Now',
-  },
-  {
-    input: date - 60000,
-    output: '1 min ago',
-  },
-  {
-    input: date - 120000,
-    output: '2 mins ago',
-  },
-  {
-    input: date - 6000000,
-    output: '1 hour ago',
-  },
-  {
-    input: date - 8000000,
-    output: '2 hours ago',
-  },
-  {
-    input: date - 120000000,
-    output: '1 day ago',
-  },
-  {
-    input: date - 240000000,
-    output: '2 days ago',
-  },
-  {
-    input: date - 1200000000,
-    output: '1 week ago',
-  },
-  {
-    input: date - 1400000000,
-    output: '2 weeks ago',
-  },
-  {
-    input: date - 3000000000,
-    output: '1 month ago',
-  },
-  {
-    input: date - 6000000000,
-    output: '2 months ago',
-  },
-  {
-    input: date - 36000000000,
-    output: '1 year ago',
-  },
-  {
-    input: date - 64000000000,
-    output: '2 years ago',
-  },
-];
-
-describe('dates', () => {
-  describe('dateFormatters', () => {
-    const testDateMs = 1681228541711; // 2023-04-11 16:55 GMT+0
-
-    describe('formatTime()', () => {
-      it('formats epoch ms as a time string', () => {
-        const result = dateFormatters.formatTime(testDateMs);
-        expect(result).toEqual('04:55 PM');
-      });
-    });
-
-    describe('formatDayOfWeek()', () => {
-      it('formats epoch ms as a day of week string', () => {
-        const result = dateFormatters.formatDayOfWeek(testDateMs);
-        expect(result).toEqual('Tue');
-      });
-    });
-
-    describe('formatDate()', () => {
-      it('formats epoch ms as a date string', () => {
-        const result = dateFormatters.formatDate(testDateMs);
-        expect(result).toEqual('Apr 11');
-      });
-    });
-
-    describe('printDayOfTheWeek()', () => {
-      it('translate getDay() code to string', () => {
-        const sunday = dateFormatters.printDayOfTheWeek(0);
-        expect(sunday).toEqual('Sun');
-
-        const monday = dateFormatters.printDayOfTheWeek(1);
-        expect(monday).toEqual('Mon');
-
-        const tuesday = dateFormatters.printDayOfTheWeek(2);
-        expect(tuesday).toEqual('Tue');
-
-        const wednesday = dateFormatters.printDayOfTheWeek(3);
-        expect(wednesday).toEqual('Wed');
-
-        const thursday = dateFormatters.printDayOfTheWeek(4);
-        expect(thursday).toEqual('Thu');
-
-        const friday = dateFormatters.printDayOfTheWeek(5);
-        expect(friday).toEqual('Fri');
-
-        const saturday = dateFormatters.printDayOfTheWeek(6);
-        expect(saturday).toEqual('Sat');
-      });
-    });
-
-    describe('getTimeAgo()', () => {
-      it('Returns an error when passing an invalid time value', () => {
-        expect(() => getTimeAgo('Date')).toThrow(new Error('Invalid date'));
-        expect(() => getTimeAgo('20-20-23')).toThrow(new Error('Invalid date'));
-        expect(() => getTimeAgo('1618301456781')).toThrow(
-          new Error('Invalid date'),
-        );
-      });
-
-      timeValuesArr.forEach((item) => {
-        const periodName = item.output.replace(/[0-9] | ago/g, '');
-        it(`Returns the "${periodName}"`, () => {
-          expect(getTimeAgo(item.input)).toEqual(item.output);
-        });
-      });
-    });
-  });
-});

package/src/utils/dates/index.ts

@@ -1 +0,0 @@
-export * as dateFormatters from './dateFormatters';

package/src/utils/debounce/debounce.spec.ts

@@ -1,85 +0,0 @@
-import { debounce } from '.';
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const callNTimes = (fn: any, n: number) => {
-  for (let i = 0; i < n; i++) {
-    fn();
-  }
-};
-
-describe('debounce', () => {
-  beforeEach(() => {
-    jest.useFakeTimers();
-    jest.spyOn(global, 'setTimeout');
-    jest.spyOn(global, 'clearTimeout');
-  });
-
-  afterAll(() => {
-    jest.useRealTimers();
-    jest.restoreAllMocks();
-  });
-
-  it('should cancel immediately without executing', () => {
-    const fn = jest.fn();
-    const [debouncedFn, cancel] = debounce(fn, 100);
-
-    debouncedFn();
-    // Cancel should not execute any pending call
-    cancel();
-    jest.advanceTimersByTime(150);
-    expect(fn).toHaveBeenCalledTimes(0);
-  });
-
-  it('should execute deferred function on the second time, after cancelling for the first time', () => {
-    const fn = jest.fn();
-    const [debouncedFn, cancel] = debounce(fn, 100);
-
-    debouncedFn();
-    // Cancel should not execute any pending call
-    cancel();
-    jest.advanceTimersByTime(150);
-    expect(fn).toHaveBeenCalledTimes(0);
-
-    debouncedFn();
-    jest.advanceTimersByTime(150);
-    expect(fn).toHaveBeenCalledTimes(1);
-  });
-
-  it('delays a function call', () => {
-    const fn = jest.fn();
-    const [debouncedFn, cancel] = debounce(fn, 100);
-
-    // Subsequent calls within the throttle window should be throttled
-    callNTimes(debouncedFn, 3);
-    jest.advanceTimersByTime(50);
-    expect(fn).toHaveBeenCalledTimes(0);
-    jest.advanceTimersByTime(500);
-    expect(fn).toHaveBeenCalledTimes(1);
-
-    // After the throttle window, the next call should execute
-    debouncedFn();
-
-    // Wait for the throttle window to pass
-    jest.advanceTimersByTime(500);
-    expect(fn).toHaveBeenCalledTimes(2);
-
-    // Calling the throttled function after cancel should execute
-    debouncedFn();
-    // ...but cancelled by triggering the cancel function
-    cancel();
-    expect(fn).toHaveBeenCalledTimes(2);
-  });
-
-  it('should debounce and execute the last call within debounce window', () => {
-    const fn = jest.fn();
-    const [debouncedFn] = debounce(fn, 100);
-
-    callNTimes(debouncedFn, 3);
-    jest.advanceTimersByTime(100);
-    expect(fn).toHaveBeenCalledTimes(1);
-
-    debouncedFn();
-    jest.advanceTimersByTime(150);
-    expect(fn).toHaveBeenCalledTimes(2);
-  });
-});

package/src/utils/debounce/debounce.ts

@@ -1,24 +0,0 @@
-type UnknownFn = (...args: any[]) => unknown;
-
-export const debounce = (func: UnknownFn, wait = 200) => {
-  let timeoutId: NodeJS.Timeout | null = null;
-  const executedFunction = (...args: any[]) => {
-    const postponedFn = () => {
-      if (timeoutId) {
-        clearTimeout(timeoutId);
-      }
-      func(...args);
-    };
-    if (timeoutId) {
-      clearTimeout(timeoutId);
-    }
-    timeoutId = setTimeout(postponedFn, wait);
-  };
-
-  const cancel = function () {
-    if (timeoutId) {
-      clearTimeout(timeoutId);
-    }
-  };
-  return [executedFunction, cancel];
-};

package/src/utils/debounce/index.ts

@@ -1 +0,0 @@
-export { debounce } from './debounce';

package/src/utils/objects/assocPath.spec.tsx

@@ -1,53 +0,0 @@
-import { assocPath } from '.';
-
-describe('utils => objects => assocPath', () => {
-  it('assocPath should work', () => {
-    const data = {
-      a: {
-        name: 'a',
-        value: 1,
-      },
-      b: {
-        name: 'b',
-        value: 2,
-      },
-    };
-    const result = assocPath(['c', 'name'], 'c')(data);
-    expect(result).toEqual({
-      a: {
-        name: 'a',
-        value: 1,
-      },
-      b: {
-        name: 'b',
-        value: 2,
-      },
-      c: {
-        name: 'c',
-      },
-    });
-  });
-  it('assocPath should not change source object', () => {
-    const data = {
-      a: {
-        name: 'a',
-        value: 1,
-      },
-      b: {
-        name: 'b',
-        value: 2,
-      },
-    };
-    assocPath(['c', 'name'], 'c')(data);
-    expect(data).toEqual({
-      a: {
-        name: 'a',
-        value: 1,
-      },
-      b: {
-        name: 'b',
-        value: 2,
-      },
-    });
-  });
-});

package/src/utils/objects/assocPath.ts

@@ -1,11 +0,0 @@
-export const assocPath =
-  <T>([first, ...rest]: string[], value: any) =>
-  (sourceObject: T): T =>
-    JSON.parse(
-      JSON.stringify({
-        ...sourceObject,
-        [first]: rest.length
-          ? assocPath(rest, value)((sourceObject as any)[first])
-          : value,
-      }),
-    ) as T;

package/src/utils/objects/dissocPath.spec.tsx

@@ -1,49 +0,0 @@
-import { dissocPath } from '.';
-
-describe('utils => objects => dissocPath', () => {
-  it('dissocPath should work', () => {
-    const data = {
-      a: {
-        name: 'a',
-        value: 1,
-      },
-      b: {
-        name: 'b',
-        value: 2,
-      },
-    };
-    const result = dissocPath(['a', 'name'])(data);
-    expect(result).toEqual({
-      a: {
-        value: 1,
-      },
-      b: {
-        name: 'b',
-        value: 2,
-      },
-    });
-  });
-  it('dissocPath should not change source object', () => {
-    const data = {
-      a: {
-        name: 'a',
-        value: 1,
-      },
-      b: {
-        name: 'b',
-        value: 2,
-      },
-    };
-    dissocPath(['a', 'name'])(data);
-    expect(data).toEqual({
-      a: {
-        name: 'a',
-        value: 1,
-      },
-      b: {
-        name: 'b',
-        value: 2,
-      },
-    });
-  });
-});

package/src/utils/objects/dissocPath.ts

@@ -1,14 +0,0 @@
-export const dissocPath =
-  <T>(path: string[]) =>
-  (sourceObject: T): T => {
-    const resultObject = JSON.parse(JSON.stringify(sourceObject));
-
-    path.reduce((acc: any, key, index) => {
-      if (index === path.length - 1) {
-        delete acc[key];
-      }
-      return acc[key];
-    }, resultObject);
-
-    return resultObject;
-  };

package/src/utils/objects/index.ts

@@ -1,7 +0,0 @@
-export * from './mapObjIndexed';
-export * from './assocPath';
-export * from './dissocPath';
-export * from './path';
-export * from './pathOr';
-export * from './prop';
-export * from './propOr';

package/src/utils/objects/mapObjIndexed.spec.tsx

@@ -1,33 +0,0 @@
-import { mapObjIndexed } from '.';
-
-describe('utils => objects => mapObjIndexed', () => {
-  it('mapObjIndexed should work', () => {
-    const data = {
-      a: {
-        name: 'a',
-        value: 1,
-      },
-      b: {
-        name: 'b',
-        value: 2,
-      },
-    };
-    const result = mapObjIndexed(
-      (item, key) => ({
-        name: key,
-        value: item.value + key,
-      }),
-      data,
-    );
-    expect(result).toEqual({
-      a: {
-        name: 'a',
-        value: '1a',
-      },
-      b: {
-        name: 'b',
-        value: '2b',
-      },
-    });
-  });
-});

package/src/utils/objects/mapObjIndexed.ts

@@ -1,15 +0,0 @@
-type MapObjIndexedFn<T, U> = (
-  value: T,
-  key: string,
-  obj: Record<string, T>,
-) => U;
-
-export const mapObjIndexed = <T, U>(
-  fn: MapObjIndexedFn<T, U>,
-  obj: Record<string, T>,
-): Record<string, U> => {
-  return Object.keys(obj).reduce((result: Record<string, U>, key: string) => {
-    result[key] = fn(obj[key], key, obj);
-    return result;
-  }, {});
-};

package/src/utils/objects/path.spec.tsx

@@ -1,24 +0,0 @@
-import { path } from '.';
-
-describe('utils => objects => path', () => {
-  const data = {
-    a: {
-      name: 'a',
-      value: 1,
-    },
-    b: {
-      name: 'b',
-      value: 2,
-    },
-  };
-
-  it('path should work with correct path', () => {
-    const result = path(['a', 'name'])(data);
-    expect(result).toEqual('a');
-  });
-
-  it('path should work with incorrect path', () => {
-    const result = path(['a', 'name', 'value'])(data);
-    expect(result).toEqual(undefined);
-  });
-});

package/src/utils/objects/path.ts

@@ -1,4 +0,0 @@
-export const path =
-  <T extends Record<string | number, any>, R>(path: Array<string | number>) =>
-  (obj: T): unknown =>
-    path.reduce((prev, curr: string | number) => prev?.[curr], obj);

package/src/utils/objects/pathOr.spec.tsx

@@ -1,23 +0,0 @@
-import { pathOr } from '.';
-
-describe('utils => objects => pathOr', () => {
-  const data = {
-    a: {
-      name: 'a',
-      value: 1,
-    },
-    b: {
-      name: 'b',
-      value: 2,
-    },
-  };
-
-  it('should work with correct path', () => {
-    const result = pathOr('Default value', ['a', 'name'])(data);
-    expect(result).toEqual('a');
-  });
-  it('should work with incorrect path', () => {
-    const result = pathOr('Default value', ['a', 'name', 'value'])(data);
-    expect(result).toEqual('Default value');
-  });
-});

package/src/utils/objects/pathOr.ts

@@ -1,11 +0,0 @@
-import { path as originalPath } from './path';
-
-export const pathOr =
-  <T extends Record<string | number, any>, R>(
-    defaultValue: any,
-    path: Array<string | number>,
-  ) =>
-  (obj: T): R => {
-    const result = originalPath(path)(obj);
-    return result === null || result === undefined ? defaultValue : result;
-  };

package/src/utils/objects/prop.spec.tsx

@@ -1,17 +0,0 @@
-import { prop } from '.';
-
-describe('utils => objects => prop', () => {
-  const data = {
-    name: 'a',
-    value: 1,
-  };
-
-  it('should work with correct prop', () => {
-    const result = prop('name')(data);
-    expect(result).toEqual('a');
-  });
-  it('should work with incorrect prop', () => {
-    const result = prop('incorrect_prop')(data);
-    expect(result).toEqual(undefined);
-  });
-});

package/src/utils/objects/prop.ts

@@ -1,4 +0,0 @@
-export const prop =
-  <T extends Record<string | number, any>, R = any>(propName: string) =>
-  (obj: T): R =>
-    obj?.[propName];

package/src/utils/objects/propOr.spec.tsx

@@ -1,17 +0,0 @@
-import { propOr } from '.';
-
-describe('utils => objects => propOr', () => {
-  const data = {
-    name: 'a',
-    value: 1,
-  };
-
-  it('should work with correct prop', () => {
-    const result = propOr('Default value', 'name')(data);
-    expect(result).toEqual('a');
-  });
-  it('should work with incorrect prop', () => {
-    const result = propOr('Default value', 'incorrect_prop')(data);
-    expect(result).toEqual('Default value');
-  });
-});

package/src/utils/objects/propOr.ts

@@ -1,11 +0,0 @@
-import { prop } from './prop';
-
-export const propOr =
-  <T extends Record<string | number, any>, R = any>(
-    defaultValue: any,
-    propName: string,
-  ) =>
-  (obj: T): R => {
-    const result = prop(propName)(obj);
-    return result === null || result === undefined ? defaultValue : result;
-  };

package/src/utils/pagination/generateRange.spec.ts

@@ -1,100 +0,0 @@
-import generateRange from './generateRange';
-
-describe('generateRange', () => {
-  it('returns an empty array when 0 or negative pages count passed', () => {
-    let range = generateRange(0);
-    expect(range).toEqual([]);
-
-    range = generateRange(-1);
-    expect(range).toEqual([]);
-  });
-  describe('No page selected', () => {
-    const noSelectedItemTestCases = [
-      { pages: 1, expected: [1] },
-      { pages: 2, expected: [1, 2] },
-      { pages: 3, expected: [1, 2, 3] },
-      { pages: 4, expected: [1, 2, 3, 4] },
-      { pages: 5, expected: [1, 2, 3, 4, 5] },
-      { pages: 6, expected: [1, 2, 3, -1, 6] },
-      { pages: 7, expected: [1, 2, 3, -1, 7] },
-      { pages: 8, expected: [1, 2, 3, -1, 8] },
-      { pages: 9, expected: [1, 2, 3, -1, 9] },
-      { pages: 10, expected: [1, 2, 3, -1, 10] },
-    ];
-
-    it.each(noSelectedItemTestCases)(
-      'returns the range for $pages pages',
-      ({ pages, expected }) => {
-        const range = generateRange(pages);
-        expect(range).toEqual(expected);
-      },
-    );
-  });
-
-  describe('With a selected page', () => {
-    const selectedItemTestCases = [
-      { pages: 10, selected: 1, expected: [1, 2, 3, -1, 10] },
-      { pages: 10, selected: 2, expected: [1, 2, 3, -1, 10] },
-      { pages: 10, selected: 3, expected: [1, 2, 3, 4, -1, 10] },
-      { pages: 10, selected: 4, expected: [1, 2, 3, 4, 5, -1, 10] },
-      { pages: 10, selected: 5, expected: [1, -1, 4, 5, 6, -1, 10] },
-      { pages: 10, selected: 6, expected: [1, -1, 5, 6, 7, -1, 10] },
-      { pages: 10, selected: 7, expected: [1, -1, 6, 7, 8, 9, 10] },
-      { pages: 10, selected: 8, expected: [1, -1, 7, 8, 9, 10] },
-      { pages: 10, selected: 9, expected: [1, -1, 8, 9, 10] },
-      { pages: 10, selected: 10, expected: [1, -1, 9, 10] },
-    ];
-
-    it.each(selectedItemTestCases)(
-      'returns the range for $pages pages when selected item $selected',
-      ({ pages, selected, expected }) => {
-        const range = generateRange(pages, selected);
-        expect(range).toEqual(expected);
-      },
-    );
-  });
-
-  it('throws an error if the selected page is out of range', () => {
-    expect(() => generateRange(10, 0)).toThrow(
-      new Error('Selected page 0 is out of range'),
-    );
-
-    expect(() => generateRange(10, 11)).toThrow(
-      new Error('Selected page 11 is out of range'),
-    );
-  });
-
-  it('throws an error when the 1st argument is not an integer', () => {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    expect(() => generateRange('1')).toThrow(
-      new Error('Pages count should be an integer'),
-    );
-
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    expect(() => generateRange(null)).toThrow(
-      new Error('Pages count should be an integer'),
-    );
-
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    expect(() => generateRange(0.1)).toThrow(
-      new Error('Pages count should be an integer'),
-    );
-  });
-
-  it('throws an error when the 2nd argument is not an integer', () => {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    expect(() => generateRange(10, '1')).toThrow(
-      new Error('Selected page should be an integer'),
-    );
-
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    expect(() => generateRange(10, 0.1)).toThrow(
-      new Error('Selected page should be an integer'),
-    );
-  });
-});