@sparted/shared-library 1.2.0 → 1.2.2

package/src/cdn/cdn.factory.ts

@@ -1,70 +0,0 @@
-import { buildSearchParams } from '../http/build-search-params';
-import type { CdnConfig, CdnType, TransformationQueries, TwicpicsTransformationChain } from './types';
-import { getCdnFromS3UrlFactory } from './utils/get-cdn-from-s3-url.util';
-import { getCdnUrlFactory } from './utils/get-cdn-url.util';
-import { twicpicsTransformationChainToString } from './utils/twicpics-transformations.util';
-
-export const imgixTransformationQueries: TransformationQueries = ({
-  fit,
-  width,
-  height,
-  quality,
-  compress = true,
-  devicePixelRatio,
-}) => {
-  const params = {
-    auto: compress ? 'compress,format' : undefined,
-    fit: fit === 'crop' ? 'crop' : undefined,
-    dpr: Number.isFinite(devicePixelRatio) ? devicePixelRatio : undefined,
-    h: Number.isFinite(height) ? height : undefined,
-    w: Number.isFinite(width) ? width : undefined,
-    q: quality !== undefined && quality >= 0 && quality <= 100 ? quality : undefined,
-  };
-  const searchParams = buildSearchParams(params).toString();
-
-  return searchParams ? `${searchParams}` : '';
-};
-
-export const twicpicsTransformationQueries: TransformationQueries = (params) => {
-  const quality = params.quality || 70;
-  const transformations: TwicpicsTransformationChain = [['quality', quality]];
-  const dpr = params.devicePixelRatio || 1;
-
-  const width = params.width ? Math.round(params.width * dpr) : '-';
-  const height = params.height ? Math.round(params.height * dpr) : '-';
-  const fit = params.fit || 'cover';
-
-  if (params.width !== undefined || params.height !== undefined) {
-    transformations.push([fit, `${width}x${height}`]);
-  }
-
-  if (params.output !== undefined) {
-    transformations.push(['output', params.output]);
-  }
-
-  return twicpicsTransformationChainToString(transformations);
-};
-
-/**
- *
- * @param type cdn provider: 'twicpics' | 'imgix'
- * @param domain provider domain
- * @param instanceMapper domain + the result of the instanceMapper will form the base path
- * @param cacheVersion
- * @returns \{ getCdnUrl, transformationQueries \}
- */
-export const createCdn = <T extends CdnType>({ type, domain, instanceMapper, cacheVersion }: CdnConfig<T>) => {
-  const getCdnUrl = getCdnUrlFactory({
-    domain,
-    instanceMapper,
-    transformationQueries: type === 'imgix' ? imgixTransformationQueries : twicpicsTransformationQueries,
-    cacheVersion,
-  });
-
-  return {
-    getCdnUrl,
-    getCdnFromS3Url: getCdnFromS3UrlFactory({
-      getCdnUrl,
-    }),
-  };
-};

package/src/cdn/index.ts

@@ -1,2 +0,0 @@
-export { createCdn } from './cdn.factory';
-export * from './types';

package/src/cdn/types/cdn-factory.type.ts

@@ -1,49 +0,0 @@
-export type BaseUrlMapperFunc = (instanceId: string) => string;
-
-export type Transformation = {
-  fit?: 'crop' | 'contain';
-  width?: number;
-  height?: number;
-  devicePixelRatio?: number;
-  quality?: number;
-  /**
-   * Only for imgix transformations. Default is true.
-   */
-  compress?: boolean;
-  output?: 'jpeg' | 'png' | 'webp' | 'image';
-};
-
-export type CdnParams = {
-  asThumbnail?: boolean;
-  transformation?: Transformation;
-};
-
-export type TransformationQueries = (params: Transformation) => string;
-
-type TwicpicsOutputTransformation = ['output', Transformation['output']];
-
-type TwicpicsFitTransformation = ['cover' | 'crop' | 'contain', string] | ['quality', number];
-
-export type TwicpicsTransformation = TwicpicsOutputTransformation | TwicpicsFitTransformation;
-
-export type TwicpicsTransformationChain = TwicpicsTransformation[];
-
-export type GetCdnUrl = (instanceId: string, path: `/${string}`, params?: CdnParams) => string;
-
-export type GetCdnFromS3Url = (url: string, params?: CdnParams) => string;
-
-export type InstanceMapper = (instanceId: string) => string;
-
-export type CdnType = 'twicpics' | 'imgix';
-
-export type CdnConfig<T extends CdnType> = {
-  type: T;
-  domain: `https://${string}`;
-  instanceMapper: InstanceMapper;
-  cacheVersion?: T extends 'twicpics' ? number : undefined;
-};
-
-export type Cdn = {
-  getCdnUrl: GetCdnUrl;
-  getCdnFromS3Url: GetCdnFromS3Url;
-};

package/src/cdn/types/index.ts

@@ -1 +0,0 @@
-export * from './cdn-factory.type';

package/src/cdn/utils/extract-info-from-url.util.ts

@@ -1,25 +0,0 @@
-type ExtractInfoFromUrl = (url: string) =>
-| {
-  instanceId: string;
-  path: `/${string}`;
-}
-| undefined;
-
-const S3_URL_RE = /https:\/\/sparted-prod-([^.]+)\.s3(\.eu-west-1)?(\.amazonaws\.com)?(\.fr-par\.scw\.cloud)?(\/[^?]+)/;
-
-export const extractInfoFromUrl: ExtractInfoFromUrl = (url) => {
-  if (typeof url !== 'string') {
-    return undefined;
-  }
-
-  const matchS3Url = url.match(S3_URL_RE);
-
-  if (!matchS3Url) {
-    return undefined;
-  }
-
-  const instanceId = matchS3Url[1];
-  const path = matchS3Url[5] as `/${string}`;
-
-  return { instanceId, path };
-};

package/src/cdn/utils/get-cdn-from-s3-url.util.ts

@@ -1,20 +0,0 @@
-import type { GetCdnFromS3Url, GetCdnUrl } from '../types';
-import { extractInfoFromUrl } from './extract-info-from-url.util';
-
-type FactoryConfig = {
-  getCdnUrl: GetCdnUrl;
-};
-
-export function getCdnFromS3UrlFactory(config: FactoryConfig): GetCdnFromS3Url {
-  return (url, params) => {
-    const { getCdnUrl } = config;
-
-    const info = extractInfoFromUrl(url);
-    if (info === undefined) {
-      return url;
-    }
-    const { instanceId, path } = info;
-
-    return getCdnUrl(instanceId, path, params);
-  };
-}

package/src/cdn/utils/get-cdn-url.util.ts

@@ -1,31 +0,0 @@
-import type { GetCdnUrl, InstanceMapper, Transformation, TransformationQueries } from '../types';
-
-const DEFAULT_THUMBNAIL_CONFIG: Transformation = {
-  width: 300,
-  height: 300,
-};
-
-type FactoryConfig = {
-  domain: `https://${string}`;
-  instanceMapper: InstanceMapper;
-  transformationQueries: TransformationQueries;
-  cacheVersion?: number;
-};
-
-export const genCacheVersionQuery = (cacheVersion?: number) => (cacheVersion ? `v=${cacheVersion}` : '');
-
-export const getCdnUrlFactory =
-  (config: FactoryConfig): GetCdnUrl =>
-  (instanceId, path, params = {}) => {
-    const { domain, instanceMapper, transformationQueries, cacheVersion } = config;
-
-    const { transformation = params.asThumbnail ? DEFAULT_THUMBNAIL_CONFIG : {} } = params;
-
-    const transformationQuery: string = transformationQueries(transformation);
-    const cacheVersionQuery = genCacheVersionQuery(cacheVersion);
-    const hasQueryParams = [transformationQuery, cacheVersionQuery].some((query) => query !== '');
-
-    return `${domain}${instanceMapper(instanceId)}${path}${hasQueryParams ? '?' : ''}${transformationQuery}${
-      cacheVersionQuery ? `&${cacheVersionQuery}` : ''
-    }`;
-  };

package/src/cdn/utils/twicpics-transformations.util.ts

@@ -1,9 +0,0 @@
-import { TwicpicsTransformationChain } from '../types';
-
-export const twicpicsTransformationChainToString = (transformationChain: TwicpicsTransformationChain): string => {
-  if (transformationChain.length === 0) return '';
-
-  const transformations = transformationChain.map(([key, value]) => `${key}=${value}`).join('/');
-
-  return `twic=v1/${transformations}`;
-};

package/src/color/__tests__/get-contrast-color.test.ts

@@ -1,22 +0,0 @@
-import { getContrastColor } from '../get-contrast-color';
-
-describe('getContrastColor', () => {
-  const customLight = '#f18888';
-  const customDark = '#051831';
-
-  it('should return the default light color', () => {
-    expect(getContrastColor('#000000')).toBe('#FFFFFF');
-  });
-
-  it('should return the default dark color', () => {
-    expect(getContrastColor('#FFFFFF')).toBe('#000000');
-  });
-
-  it('should return a specified light color', () => {
-    expect(getContrastColor('#000000', customLight, customDark)).toBe(customLight);
-  });
-
-  it('should return a specified dark color', () => {
-    expect(getContrastColor('#FFFFFF', customLight, customDark)).toBe(customDark);
-  });
-});

package/src/color/get-contrast-color.ts

@@ -1,18 +0,0 @@
-const DEFAULT_LIGHT_COLOR = '#FFFFFF';
-const DEFAULT_DARK_COLOR = '#000000';
-
-// Based on https://stackoverflow.com/questions/11867545/change-text-color-based-on-brightness-of-the-covered-background-area
-export const getContrastColor = (bgColor: string, lightColor: string = DEFAULT_LIGHT_COLOR, darkColor: string = DEFAULT_DARK_COLOR): string => {
-  const color = bgColor.charAt(0) === '#' ? bgColor.substring(1, 7) : bgColor;
-
-  if (color.length !== 6) {
-    throw new Error(`Invalid HEX color "${bgColor}" in sparted mail manager.`);
-  }
-
-  const r = parseInt(color.substring(0, 2), 16); // hexToR
-  const g = parseInt(color.substring(2, 4), 16); // hexToG
-  const b = parseInt(color.substring(4, 6), 16); // hexToB
-
-  // Values from https://www.w3.org/TR/AERT/#color-contrast
-  return r * 0.299 + g * 0.587 + b * 0.114 > 186 ? darkColor : lightColor;
-};

package/src/color/index.ts

@@ -1 +0,0 @@
-export * from './get-contrast-color';

package/src/formatting/__tests__/format-number.test.ts

@@ -1,11 +0,0 @@
-import { formatNumber } from '../format-number';
-
-describe('formatNumber', () => {
-  it('should format numbers correctly', () => {
-    expect(formatNumber(48)).toBe('48');
-    expect(formatNumber(999)).toBe('999');
-    expect(formatNumber(1000)).toBe('1.0k');
-    expect(formatNumber(42869)).toBe('42.8k');
-    expect(formatNumber(992169)).toBe('992.1k');
-  });
-});

package/src/formatting/format-number.ts

@@ -1,14 +0,0 @@
-const DECIMAL_SEPARATOR = '.';
-const THOUSAND_UNIT = 'k';
-
-export const formatNumber = (n: number): string => {
-  const numString = String(n);
-  if (n < 1000) {
-    return numString;
-  }
-
-  const decimalsMinusLast = numString.slice(0, numString.length - 3);
-  const lastDecimal = numString.slice(numString.length - 3, numString.length - 2);
-
-  return `${decimalsMinusLast}${DECIMAL_SEPARATOR}${lastDecimal}${THOUSAND_UNIT}`;
-};

package/src/formatting/index.ts

@@ -1 +0,0 @@
-export * from './format-number';

package/src/fp/__tests__/run-while.test.ts

@@ -1,29 +0,0 @@
-import { runWhile } from '../run-while';
-
-describe('runWhile', () => {
-  it('should run while the predicate is true and return the right interation count', () => {
-    const { result, iterationCount } = runWhile({
-      predicate: (counter) => counter <= 9,
-      callback: (counter) => counter + 1,
-      initialValue: 0,
-    });
-
-    expect(result).toStrictEqual(10);
-    expect(iterationCount).toStrictEqual(10);
-  });
-
-  it('should throw an error when the iteration limit is reached', () => {
-    const predicateMock = jest.fn().mockReturnValue(true);
-
-    const { iterationCount } = runWhile({
-      predicate: predicateMock,
-      callback: (counter) => counter + 1,
-      initialValue: 0,
-      iterationLimit: 89,
-    });
-
-    // Called once outside the while loop
-    expect(predicateMock).toHaveBeenCalledTimes(90);
-    expect(iterationCount).toStrictEqual(89);
-  });
-});

package/src/fp/index.ts

@@ -1 +0,0 @@
-export * from './run-while';

package/src/fp/run-while.ts

@@ -1,54 +0,0 @@
-export type RunWhileConfig<T> = {
-  /**
-   * Return a boolean to keep running the callback or not.
-   */
-  predicate: (current: T) => boolean,
-  /**
-   * The function to run while `predicate` returns `true`
-   */
-  callback: (current: T, iteractionCount: number) => T,
-  /**
-   * `callback` will not be run again if `iterationCount` exceeds this value.
-   * Default to `Infinity`
-   */
-  iterationLimit?: number,
-  /**
-   * The first value passed to the callback.
-   */
-  initialValue: T,
-};
-
-export type RunWhileFn = <T>(config: RunWhileConfig<T>) => {
-  /**
-   * The callback last result.
-   */
-  result: T,
-  iterationCount: number,
-};
-
-/**
- * Run the callback while the predicate return true. Throws an
- * error if the iteration count exceeds the iteration limit.
- */
-export const runWhile: RunWhileFn = ({ predicate, callback, initialValue, iterationLimit = Infinity }) => {
-  let counter = 0;
-  let currentValue = initialValue;
-  let shouldRun = predicate(currentValue);
-
-  while (shouldRun) {
-    if (counter >= iterationLimit) {
-      break;
-    }
-
-    const nextValue = callback(currentValue, counter);
-
-    counter += 1;
-    shouldRun = predicate(nextValue);
-    currentValue = nextValue;
-  }
-
-  return {
-    result: currentValue,
-    iterationCount: counter,
-  };
-};

package/src/http/__tests__/build-search-params.test.ts

@@ -1,17 +0,0 @@
-import { buildSearchParams } from '../build-search-params';
-
-describe('buildSearchParams', () => {
-  it('should remove undefined values', () => {
-    const params = {
-      param1: 'value1',
-      param2: undefined,
-      param3: 'value3',
-    };
-    const searchParams = buildSearchParams(params);
-
-    expect(searchParams.toString()).toStrictEqual('param1=value1&param3=value3');
-    expect(searchParams.get('param1')).toStrictEqual('value1');
-    expect(searchParams.get('param2')).toStrictEqual(null);
-    expect(searchParams.get('param3')).toStrictEqual('value3');
-  });
-});

package/src/http/__tests__/encode-search-object.test.ts

@@ -1,34 +0,0 @@
-import { encodeSearchObject } from '../encode-search-object';
-
-describe('encodeSearchObject', () => {
-  it('should not encode sort and query if undefined', () => {
-    const url = encodeSearchObject({
-      limit: 10,
-      offset: 15,
-    });
-
-    expect(url).toStrictEqual('offset=15&limit=10');
-  });
-
-  it('should encode sort and query twice', () => {
-    const url = encodeSearchObject({
-      limit: 10,
-      offset: 0,
-      sort: {
-        name: 'asc',
-        editionDate: 'desc',
-      },
-      query: {
-        name: 'The name of something',
-        status: 'published',
-      },
-    });
-
-    expect(url).toStrictEqual([
-      'offset=0',
-      'limit=10',
-      'sort=name%3Aasc%2BeditionDate%3Adesc',
-      'query=name%3AThe%2520name%2520of%2520something%2Bstatus%3Apublished',
-    ].join('&'));
-  });
-});

package/src/http/__tests__/fetch-with-timeout.test.ts

@@ -1,50 +0,0 @@
-/* eslint-disable import/first -- https://github.com/jefflau/jest-fetch-mock#to-setup-for-an-individual-test */
-
-import fetchMock, { enableFetchMocks } from 'jest-fetch-mock';
-
-// must appear before any other imports
-enableFetchMocks();
-
-import { fetchWithTimeout } from '../fetch-with-timeout';
-
-describe('fetchWithTimeout', () => {
-  beforeEach(() => {
-    fetchMock.resetMocks();
-  });
-
-  it('should call fetch with the same parameters', async () => {
-    const url = 'http://some/url';
-    const init = {
-      headers: {
-        some: 'header',
-      },
-    };
-
-    fetchMock.mockResponseOnce('mock response');
-    const response = await fetchWithTimeout(url, init);
-
-    expect(fetch as any).toHaveBeenNthCalledWith(1, url, expect.objectContaining(init));
-    expect(await response.text()).toBe('mock response');
-  });
-
-  it('should abort the request if timeout has elapsed', async () => {
-    jest.useFakeTimers();
-    const TIMEOUT = 3000;
-    const REQUEST_TIMEOUT = TIMEOUT * 2;
-
-    // This request will take too long
-    fetchMock.mockResponseOnce(async () => {
-      jest.advanceTimersByTime(REQUEST_TIMEOUT);
-      return 'mock response';
-    });
-
-    // https://github.com/jefflau/jest-fetch-mock/issues/159
-    (global as any).DOMException = Error;
-
-    const responsePromise = fetchWithTimeout('http://some/url', { timeout: TIMEOUT });
-
-    jest.advanceTimersByTime(TIMEOUT + 100);
-
-    await expect(responsePromise).rejects.toThrow('The operation was aborted. ');
-  });
-});

package/src/http/build-search-params.ts

@@ -1,18 +0,0 @@
-import type { Primitive } from '../types';
-
-export const buildSearchParams = (params: Record<string, Primitive | undefined>): URLSearchParams => {
-  const definedParams = Object
-    .entries(params)
-    .reduce((acc, [key, value]) => {
-      if (value !== undefined) {
-        return {
-          ...acc,
-          [key]: String(value),
-        };
-      }
-
-      return acc;
-    }, {} as Record<string, string>);
-
-  return new URLSearchParams(definedParams);
-};

package/src/http/encode-search-object.ts

@@ -1,39 +0,0 @@
-import { SearchObject } from '../types';
-
-export type EncodingConfig = {
-  keyValueDelimiter: string,
-  pairDelimiter: string,
-};
-
-const defaultEncodingConfig: EncodingConfig = {
-  keyValueDelimiter: ':',
-  pairDelimiter: '+',
-};
-
-export const encodeSearchValue = <T extends Record<string, string>>(
-  searchValue: T,
-  config: EncodingConfig = defaultEncodingConfig,
-) => {
-  const { pairDelimiter, keyValueDelimiter } = config;
-
-  return Object.entries(searchValue)
-    .map(([key, value]) => `${key}${keyValueDelimiter}${encodeURI(value)}`)
-    .join(pairDelimiter);
-};
-
-export const encodeSearchObject = (searchObject: SearchObject): string => {
-  const { sort, query, offset, limit } = searchObject;
-
-  const sortEncoded = sort ? encodeSearchValue(sort) : null;
-  const queryEncoded = query ? encodeSearchValue(query) : null;
-
-  const urlParams = new URLSearchParams({
-    offset: offset.toString(),
-    limit: limit.toString(),
-  });
-
-  if (sortEncoded) urlParams.append('sort', sortEncoded);
-  if (queryEncoded) urlParams.append('query', queryEncoded);
-
-  return urlParams.toString();
-};

package/src/http/fetch-with-timeout.ts

@@ -1,24 +0,0 @@
-export type RequestInitWithTimeout = RequestInit & {
-  timeout?: number
-};
-
-/**
- * Use fetch to perform an HTTP request
- * Add an optional timeout, that will abort the request if it has not returned before
- */
-export const fetchWithTimeout = (input: RequestInfo, init?: Omit<RequestInitWithTimeout, 'signal'> | undefined): Promise<Response> => {
-  const abortController = new AbortController();
-
-  const { timeout, ...rest } = init || {};
-
-  const params = {
-    ...rest,
-    signal: abortController.signal,
-  };
-
-  if (timeout !== undefined) {
-    setTimeout(() => abortController.abort(), timeout);
-  }
-
-  return fetch(input, params);
-};

package/src/http/index.ts

@@ -1,3 +0,0 @@
-export * from './encode-search-object';
-export * from './fetch-with-timeout';
-export * from './build-search-params';

package/src/index.ts

@@ -1,15 +0,0 @@
-export * from './array';
-export * from './cdn';
-export * from './time';
-export * from './formatting';
-export * from './fp';
-export * from './http';
-export * from './linked-list';
-export * from './math';
-export * from './object';
-export * from './parsing';
-export * from './predicates';
-export * from './promise';
-export * from './string';
-export * from './types';
-export * from './color';