@ssa-ui-kit/utils 0.0.1-alpha → 1.0.0

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

@@ -1,23 +1,23 @@
-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');
-  });
-});
+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 +1,11 @@
-import { path as originalPath } from './path';
-
-export const pathOr =
-  <T extends Record<string | number, any>, R>(
-    defaultValue: any,
-    path: string[],
-  ) =>
-  (obj: T): R => {
-    const result = originalPath(path)(obj);
-    return result === null || result === undefined ? defaultValue : result;
-  };
+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 +1,17 @@
-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);
-  });
-});
+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 +1,4 @@
-export const prop =
-  <T extends Record<string | number, any>, R = any>(propName: string) =>
-  (obj: T): R =>
-    obj?.[propName];
+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 +1,17 @@
-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');
-  });
-});
+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 +1,11 @@
-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;
-  };
+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 +1,100 @@
-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'),
-    );
-  });
-});
+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'),
+    );
+  });
+});

package/src/utils/pagination/generateRange.ts

@@ -1,91 +1,91 @@
-import { GenerateRangeFn } from './types';
-
-/**
- * The function that returns an array of page numbers to show in the pagination
- * component.
- *
- * Rules:
- * - To always show the 1st and the last page.
- * - To show one item before and one item after the selected page.
- * - To return "-1" for the skipped items. This is to be able to display "..." in
- * the pagination component.
- * */
-const SKIPPED_ITEMS_DELTA = 2;
-
-const getSelectedRange = (pagesCount: number, selectedPage: number) => {
-  const range: number[] = [];
-
-  if (selectedPage !== pagesCount) {
-    range.push(selectedPage);
-  }
-
-  if (selectedPage > 1) {
-    range.unshift(selectedPage - 1);
-  }
-
-  if (selectedPage + 1 < pagesCount) {
-    range.push(selectedPage + 1);
-  }
-
-  return range;
-};
-
-const fill = (range: number[], minValue: number, maxValue: number) => {
-  for (let i = minValue; i < maxValue; ++i) {
-    range.push(i);
-  }
-};
-
-const generateRange: GenerateRangeFn = (pagesCount, selectedPage) => {
-  if (pagesCount == null || !Number.isInteger(pagesCount)) {
-    throw new Error('Pages count should be an integer');
-  }
-
-  if (pagesCount <= 0) {
-    return [];
-  }
-
-  let range = [1];
-
-  if (pagesCount === 1) {
-    return range;
-  }
-
-  if (selectedPage != null && !Number.isInteger(selectedPage)) {
-    throw new Error('Selected page should be an integer');
-  }
-
-  if (selectedPage != null && (selectedPage < 1 || selectedPage > pagesCount)) {
-    throw new Error(`Selected page ${selectedPage} is out of range`);
-  }
-
-  if (selectedPage && selectedPage > 2) {
-    const selectedRange = getSelectedRange(pagesCount, selectedPage);
-
-    const [minSelectedRange, , maxSelectedRange] = selectedRange;
-
-    if (minSelectedRange - SKIPPED_ITEMS_DELTA > 1) {
-      range.push(-1);
-    } else {
-      fill(range, 2, minSelectedRange);
-    }
-
-    range = range.concat(selectedRange);
-
-    if (pagesCount - maxSelectedRange > SKIPPED_ITEMS_DELTA) {
-      range.push(-1);
-    } else {
-      fill(range, maxSelectedRange + 1, pagesCount);
-    }
-  } else if (pagesCount <= 5) {
-    fill(range, 2, pagesCount);
-  } else {
-    range.push(2, 3, -1);
-  }
-
-  range.push(pagesCount);
-
-  return range;
-};
-
-export default generateRange;
+import { GenerateRangeFn } from './types';
+
+/**
+ * The function that returns an array of page numbers to show in the pagination
+ * component.
+ *
+ * Rules:
+ * - To always show the 1st and the last page.
+ * - To show one item before and one item after the selected page.
+ * - To return "-1" for the skipped items. This is to be able to display "..." in
+ * the pagination component.
+ * */
+const SKIPPED_ITEMS_DELTA = 2;
+
+const getSelectedRange = (pagesCount: number, selectedPage: number) => {
+  const range: number[] = [];
+
+  if (selectedPage !== pagesCount) {
+    range.push(selectedPage);
+  }
+
+  if (selectedPage > 1) {
+    range.unshift(selectedPage - 1);
+  }
+
+  if (selectedPage + 1 < pagesCount) {
+    range.push(selectedPage + 1);
+  }
+
+  return range;
+};
+
+const fill = (range: number[], minValue: number, maxValue: number) => {
+  for (let i = minValue; i < maxValue; ++i) {
+    range.push(i);
+  }
+};
+
+const generateRange: GenerateRangeFn = (pagesCount, selectedPage) => {
+  if (pagesCount == null || !Number.isInteger(pagesCount)) {
+    throw new Error('Pages count should be an integer');
+  }
+
+  if (pagesCount <= 0) {
+    return [];
+  }
+
+  let range = [1];
+
+  if (pagesCount === 1) {
+    return range;
+  }
+
+  if (selectedPage != null && !Number.isInteger(selectedPage)) {
+    throw new Error('Selected page should be an integer');
+  }
+
+  if (selectedPage != null && (selectedPage < 1 || selectedPage > pagesCount)) {
+    throw new Error(`Selected page ${selectedPage} is out of range`);
+  }
+
+  if (selectedPage && selectedPage > 2) {
+    const selectedRange = getSelectedRange(pagesCount, selectedPage);
+
+    const [minSelectedRange, , maxSelectedRange] = selectedRange;
+
+    if (minSelectedRange - SKIPPED_ITEMS_DELTA > 1) {
+      range.push(-1);
+    } else {
+      fill(range, 2, minSelectedRange);
+    }
+
+    range = range.concat(selectedRange);
+
+    if (pagesCount - maxSelectedRange > SKIPPED_ITEMS_DELTA) {
+      range.push(-1);
+    } else {
+      fill(range, maxSelectedRange + 1, pagesCount);
+    }
+  } else if (pagesCount <= 5) {
+    fill(range, 2, pagesCount);
+  } else {
+    range.push(2, 3, -1);
+  }
+
+  range.push(pagesCount);
+
+  return range;
+};
+
+export default generateRange;

package/src/utils/pagination/index.ts

@@ -1 +1 @@
-export { default as generateRange } from './generateRange';
+export { default as generateRange } from './generateRange';

package/src/utils/pagination/types.ts

@@ -1,4 +1,4 @@
-export type GenerateRangeFn = (
-  pagesCount: number,
-  selectedPage?: number,
-) => Array<number>;
+export type GenerateRangeFn = (
+  pagesCount: number,
+  selectedPage?: number,
+) => Array<number>;

package/src/utils/throttle/index.ts

@@ -1 +1 @@
-export { throttle } from './throttle';
+export { throttle } from './throttle';