@sparted/shared-library 1.0.1-O → 1.0.2

package/src/cdn/__tests__/utils.test.ts

@@ -1,466 +0,0 @@
-import {
-  imgixTransformationQueries,
-  twicpicsTransformationQueries,
-} from '../cdn.factory';
-import { extractInfoFromUrl } from '../utils/extract-info-from-url.util';
-import { getCdnUrlFactory } from '../utils/get-cdn-url.util';
-import { getCdnFromS3UrlFactory } from '../utils/get-cdn-from-s3-url.util';
-import type { InstanceMapper } from '../types';
-
-describe('extract-info-from-url', () => {
-  it('should handle non-aws s3 url', () => {
-    const info = extractInfoFromUrl('https://www.google.com');
-
-    expect(info).toBeUndefined();
-  });
-
-  it('should handle all aws s3 url', () => {
-    const { instanceId: instanceIdEW1, path: pathEW1 } = extractInfoFromUrl(
-      'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-    ) ?? {};
-
-    expect(instanceIdEW1).toBe('check');
-    expect(pathEW1).toBe('/path/to/something');
-
-    const { instanceId: instanceIdAmazonaws, path: pathAmazonaws } = extractInfoFromUrl(
-      'https://sparted-prod-check.s3.amazonaws.com/path/to/something',
-    ) ?? {};
-
-    expect(instanceIdAmazonaws).toBe('check');
-    expect(pathAmazonaws).toBe('/path/to/something');
-
-    const { instanceId: instanceIdCloud, path: pathCloud } = extractInfoFromUrl(
-      'https://sparted-prod-check.s3.fr-par.scw.cloud/path/to/something',
-    ) ?? {};
-
-    expect(instanceIdCloud).toBe('check');
-    expect(pathCloud).toBe('/path/to/something');
-  });
-
-  it('should handle any param and not crash', () => {
-    // @ts-ignore - Passing wrong param to fn in test
-    expect(extractInfoFromUrl()).toBeUndefined();
-    // @ts-ignore - Passing wrong param to fn in test
-    expect(extractInfoFromUrl([])).toBeUndefined();
-    // @ts-ignore - Passing wrong param to fn in test
-    expect(extractInfoFromUrl({})).toBeUndefined();
-    expect(extractInfoFromUrl('')).toBeUndefined();
-  });
-});
-
-describe('getCdnUrlFactory', () => {
-  it('Imgix - should generate url without params', () => {
-    const domain = 'https://sparted.imgix.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: imgixTransformationQueries,
-    });
-
-    expect(getCdnUrl('test', '/path/to/something')).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat',
-    );
-  });
-
-  it('Twicpics - should generate url without params', () => {
-    const domain = 'https://sparted.twicpics.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: twicpicsTransformationQueries,
-    });
-
-    expect(getCdnUrl('test', '/path/to/something')).toBe(
-      'https://sparted.twicpics.fr/prod/test/path/to/something',
-    );
-  });
-
-  it('Imgix - should generate url of image as thumbnail', () => {
-    const domain = 'https://sparted.imgix.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: imgixTransformationQueries,
-    });
-
-    expect(getCdnUrl('test', '/path/to/something', { asThumbnail: true })).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&h=300&w=300',
-    );
-  });
-
-  it('Twicpics - should generate url of image as thumbnail', () => {
-    const domain = 'https://sparted.twicpics.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: twicpicsTransformationQueries,
-    });
-
-    expect(getCdnUrl('test', '/path/to/something', { asThumbnail: true })).toBe(
-      'https://sparted.twicpics.fr/prod/test/path/to/something?twic=v1/cover=300x300',
-    );
-  });
-
-  it('Imgix - should generate url with params', () => {
-    const domain = 'https://sparted.imgix.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: imgixTransformationQueries,
-    });
-
-    expect(
-      getCdnUrl('test', '/path/to/something', {
-        transformation: { fit: 'crop', height: 1, width: 1 },
-      }),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&fit=crop&h=1&w=1',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', {
-        transformation: { fit: 'crop', width: 1 },
-      }),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&fit=crop&w=1',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', {
-        transformation: { fit: 'crop', height: 1 },
-      }),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&fit=crop&h=1',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', { transformation: { width: 1 } }),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&w=1',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', { transformation: { height: 1 } }),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&h=1',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', {
-        transformation: { height: 1, width: 1 },
-      }),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&h=1&w=1',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', {
-        transformation: { devicePixelRatio: 2 },
-      }),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&dpr=2',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', {
-        transformation: { quality: 75 },
-      }),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&q=75',
-    );
-  });
-
-  it('Twicpics - should generate url of image as thumbnail', () => {
-    const domain = 'https://sparted.twicpics.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: twicpicsTransformationQueries,
-    });
-
-    expect(
-      getCdnUrl('test', '/path/to/something', {
-        transformation: { fit: 'crop', height: 1, width: 1 },
-      }),
-    ).toBe(
-      'https://sparted.twicpics.fr/prod/test/path/to/something?twic=v1/crop=1x1',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', {
-        transformation: { fit: 'contain', height: 1, width: 1 },
-      }),
-    ).toBe(
-      'https://sparted.twicpics.fr/prod/test/path/to/something?twic=v1/contain=1x1',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', { transformation: { width: 1 } }),
-    ).toBe(
-      'https://sparted.twicpics.fr/prod/test/path/to/something?twic=v1/cover=1',
-    );
-  });
-});
-
-describe('getCdnFromS3UrlFactory', () => {
-  it('Imgix - should handle non-aws s3 url', () => {
-    const domain = 'https://sparted.imgix.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: imgixTransformationQueries,
-    });
-
-    const getCdnFromS3Url = getCdnFromS3UrlFactory({
-      getCdnUrl,
-    });
-
-    expect(getCdnFromS3Url('https://www.google.com')).toBe(
-      'https://www.google.com',
-    );
-  });
-
-  it('Twicpics - should handle non-aws s3 url', () => {
-    const domain = 'https://sparted.twicpics.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: twicpicsTransformationQueries,
-    });
-
-    const getCdnFromS3Url = getCdnFromS3UrlFactory({
-      getCdnUrl,
-    });
-
-    expect(getCdnFromS3Url('https://www.google.com')).toBe(
-      'https://www.google.com',
-    );
-  });
-
-  it('Imgix - should handle all aws s3 url with no params', () => {
-    const domain = 'https://sparted.imgix.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: imgixTransformationQueries,
-    });
-
-    const getCdnFromS3Url = getCdnFromS3UrlFactory({
-      getCdnUrl,
-    });
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.amazonaws.com/path/to/something',
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.fr-par.scw.cloud/path/to/something',
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat',
-    );
-  });
-
-  it('Twicpics - should handle all aws s3 url with no params', () => {
-    const domain = 'https://sparted.twicpics.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: twicpicsTransformationQueries,
-    });
-
-    const getCdnFromS3Url = getCdnFromS3UrlFactory({
-      getCdnUrl,
-    });
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-      ),
-    ).toBe('https://sparted.twicpics.fr/prod/check/path/to/something');
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.amazonaws.com/path/to/something',
-      ),
-    ).toBe('https://sparted.twicpics.fr/prod/check/path/to/something');
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.fr-par.scw.cloud/path/to/something',
-      ),
-    ).toBe('https://sparted.twicpics.fr/prod/check/path/to/something');
-  });
-
-  it('Imgix - should handle params', () => {
-    const domain = 'https://sparted.imgix.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: imgixTransformationQueries,
-    });
-
-    const getCdnFromS3Url = getCdnFromS3UrlFactory({
-      getCdnUrl,
-    });
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { fit: 'crop', height: 1, width: 1 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat&fit=crop&h=1&w=1',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { fit: 'crop', width: 1 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat&fit=crop&w=1',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { fit: 'crop', height: 1 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat&fit=crop&h=1',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { width: 1 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat&w=1',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { height: 1 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat&h=1',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { height: 1, width: 1 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat&h=1&w=1',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { devicePixelRatio: 2 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat&dpr=2',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { quality: 75 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.imgix.fr/prod/check/path/to/something?auto=compress%2Cformat&q=75',
-    );
-  });
-
-  it('Twicpics - should handle params', () => {
-    const domain = 'https://sparted.twicpics.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: twicpicsTransformationQueries,
-    });
-
-    const getCdnFromS3Url = getCdnFromS3UrlFactory({
-      getCdnUrl,
-    });
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { fit: 'crop', height: 1, width: 1 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.twicpics.fr/prod/check/path/to/something?twic=v1/crop=1x1',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { fit: 'contain', height: 1, width: 1 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.twicpics.fr/prod/check/path/to/something?twic=v1/contain=1x1',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { width: 1 },
-        },
-      ),
-    ).toBe(
-      'https://sparted.twicpics.fr/prod/check/path/to/something?twic=v1/cover=1',
-    );
-  });
-});

package/src/cdn/cdn.factory.ts

@@ -1,73 +0,0 @@
-import { buildSearchParams } from '../http/build-search-params';
-import type { CreateCdn, TransformationQueries } from './types';
-import { getCdnFromS3UrlFactory } from './utils/get-cdn-from-s3-url.util';
-import { getCdnUrlFactory } from './utils/get-cdn-url.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,
-) => {
-  if (params.fit !== undefined) {
-    if (params.width === undefined || params.height === undefined) {
-      // eslint-disable-next-line no-console
-      console.error('⚠️  The Twicpics api needs a width and a height.');
-      return '';
-    }
-
-    return `?twic=v1/${params.fit}=${params.width}x${params.height}`;
-  }
-  if (params.width !== undefined) {
-    const resizeHeight = params.height !== undefined
-      ? `x${params.height}`
-      : '';
-
-    return `?twic=v1/cover=${params.width}${resizeHeight}`;
-  }
-
-  return '';
-};
-
-/**
- *
- * @param type cdn provider: 'twicpics' | 'imgix'
- * @param domain provider domain
- * @param instanceMapper domain + the result of the instanceMapper will form the base path
- * @returns \{ getCdnUrl, transformationQueries \}
- */
-export const createCdn: CreateCdn = ({ type, domain, instanceMapper }) => {
-  const getCdnUrl = getCdnUrlFactory({
-    domain,
-    instanceMapper,
-    transformationQueries:
-      type === 'imgix'
-        ? imgixTransformationQueries
-        : twicpicsTransformationQueries,
-  });
-
-  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,39 +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;
-};
-
-export type CdnParams = {
-  asThumbnail?: boolean;
-  transformation?: Transformation;
-};
-
-export type TransformationQueries = (params: Transformation) => string;
-
-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 CdnConfig = {
-  type: 'twicpics' | 'imgix';
-  domain: `https://${string}`;
-  instanceMapper: InstanceMapper;
-};
-
-export type Cdn = {
-  getCdnUrl: GetCdnUrl;
-  getCdnFromS3Url: GetCdnFromS3Url;
-};
-
-export type CreateCdn = (config: CdnConfig) => Cdn;

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,26 +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;
-};
-
-export const getCdnUrlFactory = (config: FactoryConfig): GetCdnUrl => (instanceId, path, params = {}) => {
-  const { domain, instanceMapper, transformationQueries } = config;
-
-  const {
-    transformation = params.asThumbnail ? DEFAULT_THUMBNAIL_CONFIG : {},
-  } = params;
-
-  return `${domain}${instanceMapper(
-    instanceId,
-  )}${path}${transformationQueries(transformation)}`;
-};

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';