@sparted/shared-library 1.2.0 → 1.2.2

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

@@ -1,150 +0,0 @@
-import {
-  createCdn,
-  imgixTransformationQueries,
-  twicpicsTransformationQueries,
-} from '../cdn.factory';
-import type { InstanceMapper } from '../types';
-import { getCdnFromS3UrlFactory } from '../utils/get-cdn-from-s3-url.util';
-import { getCdnUrlFactory } from '../utils/get-cdn-url.util';
-
-describe('TransformationQueries', () => {
-  it('Imgix - should handle imgix transformation', () => {
-    expect(
-      imgixTransformationQueries({
-        fit: 'crop',
-        width: 1,
-        height: 1,
-      }),
-    ).toBe('auto=compress%2Cformat&fit=crop&h=1&w=1');
-
-    expect(imgixTransformationQueries({ fit: 'crop', width: 1 })).toBe(
-      'auto=compress%2Cformat&fit=crop&w=1',
-    );
-
-    expect(imgixTransformationQueries({ fit: 'crop', height: 1 })).toBe(
-      'auto=compress%2Cformat&fit=crop&h=1',
-    );
-
-    expect(imgixTransformationQueries({ width: 1 })).toBe(
-      'auto=compress%2Cformat&w=1',
-    );
-
-    expect(imgixTransformationQueries({ height: 1 })).toBe(
-      'auto=compress%2Cformat&h=1',
-    );
-
-    expect(imgixTransformationQueries({ width: 1, height: 1 })).toBe(
-      'auto=compress%2Cformat&h=1&w=1',
-    );
-
-    expect(imgixTransformationQueries({ devicePixelRatio: 2 })).toBe(
-      'auto=compress%2Cformat&dpr=2',
-    );
-
-    expect(imgixTransformationQueries({ quality: 75 })).toBe(
-      'auto=compress%2Cformat&q=75',
-    );
-
-    expect(imgixTransformationQueries({ quality: 75, compress: false })).toBe(
-      'q=75',
-    );
-
-    expect(imgixTransformationQueries({ compress: false })).toStrictEqual('');
-  });
-
-  it('should handle twicpics transformation', () => {
-    const crop = twicpicsTransformationQueries({
-      fit: 'crop',
-      width: 1,
-      height: 1,
-    });
-
-    expect(crop).toBe('twic=v1/quality=70/crop=1x1');
-
-    const contain = twicpicsTransformationQueries({
-      fit: 'contain',
-      width: 1,
-      height: 1,
-    });
-
-    expect(contain).toBe('twic=v1/quality=70/contain=1x1');
-
-    const coverOnlyWidth = twicpicsTransformationQueries({ width: 1 });
-
-    expect(coverOnlyWidth).toBe('twic=v1/quality=70/cover=1x-');
-
-    const coverOnlyHeight = twicpicsTransformationQueries({ height: 1 });
-
-    expect(coverOnlyHeight).toBe('twic=v1/quality=70/cover=-x1');
-
-    const noSize = twicpicsTransformationQueries({
-      fit: 'contain',
-    });
-
-    expect(noSize).toBe('twic=v1/quality=70');
-
-    const quality = twicpicsTransformationQueries({
-      quality: 75,
-    });
-
-    expect(quality).toBe('twic=v1/quality=75');
-
-    const devicePixelRatio = twicpicsTransformationQueries({
-      height: 100,
-      width: 45,
-      devicePixelRatio: 2,
-    });
-
-    expect(devicePixelRatio).toBe('twic=v1/quality=70/cover=90x200');
-  });
-});
-
-describe('cdnFactory', () => {
-  it('Imgix - should instanciate the right cdn', () => {
-    const domain = 'https://sparted.imgix.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: imgixTransformationQueries,
-    });
-
-    const getCdnFromS3Url = getCdnFromS3UrlFactory({
-      getCdnUrl,
-    });
-
-    const cdn = createCdn({
-      type: 'imgix',
-      domain: 'https://sparted.imgix.fr/',
-      instanceMapper,
-    });
-
-    expect(cdn.getCdnUrl.toString()).toBe(getCdnUrl.toString());
-
-    expect(cdn.getCdnFromS3Url.toString()).toBe(getCdnFromS3Url.toString());
-  });
-
-  it('Twicpics - should instanciate the right cdn', () => {
-    const domain = 'https://sparted.twicpics.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: twicpicsTransformationQueries,
-    });
-
-    const getCdnFromS3Url = getCdnFromS3UrlFactory({
-      getCdnUrl,
-    });
-
-    const cdn = createCdn({
-      type: 'twicpics',
-      domain: 'https://sparted.twicpics.fr/',
-      instanceMapper: (instanceId) => instanceId,
-    });
-
-    expect(cdn.getCdnUrl.toString()).toBe(getCdnUrl.toString());
-
-    expect(cdn.getCdnFromS3Url.toString()).toBe(getCdnFromS3Url.toString());
-  });
-});

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

@@ -1,528 +0,0 @@
-import {
-  imgixTransformationQueries,
-  twicpicsTransformationQueries,
-} from '../cdn.factory';
-import { extractInfoFromUrl } from '../utils/extract-info-from-url.util';
-import { genCacheVersionQuery, 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?twic=v1/quality=70',
-    );
-  });
-
-  it('Imgix - should generate url with cache param', () => {
-    const domain = 'https://sparted.imgix.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: imgixTransformationQueries,
-      cacheVersion: 3,
-    });
-
-    expect(getCdnUrl('test', '/path/to/something')).toBe(
-      'https://sparted.imgix.fr/prod/test/path/to/something?auto=compress%2Cformat&v=3',
-    );
-  });
-
-  it('Twicpics - should generate url with cache param', () => {
-    const domain = 'https://sparted.twicpics.fr';
-    const instanceMapper: InstanceMapper = (instanceId) => `/prod/${instanceId}`;
-    const getCdnUrl = getCdnUrlFactory({
-      domain,
-      instanceMapper,
-      transformationQueries: twicpicsTransformationQueries,
-      cacheVersion: 3,
-    });
-
-    expect(getCdnUrl('test', '/path/to/something')).toBe(
-      'https://sparted.twicpics.fr/prod/test/path/to/something?twic=v1/quality=70&v=3',
-    );
-  });
-
-  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/quality=70/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/quality=70/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/quality=70/contain=1x1',
-    );
-
-    expect(
-      getCdnUrl('test', '/path/to/something', { transformation: { width: 1 } }),
-    ).toBe(
-      'https://sparted.twicpics.fr/prod/test/path/to/something?twic=v1/quality=70/cover=1x-',
-    );
-  });
-});
-
-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?twic=v1/quality=70');
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.amazonaws.com/path/to/something',
-      ),
-    ).toBe('https://sparted.twicpics.fr/prod/check/path/to/something?twic=v1/quality=70');
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.fr-par.scw.cloud/path/to/something',
-      ),
-    ).toBe('https://sparted.twicpics.fr/prod/check/path/to/something?twic=v1/quality=70');
-  });
-
-  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/quality=70/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/quality=70/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/quality=70/cover=1x-',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { width: 1, output: 'webp' },
-        },
-      ),
-    ).toBe(
-      'https://sparted.twicpics.fr/prod/check/path/to/something?twic=v1/quality=70/cover=1x-/output=webp',
-    );
-
-    expect(
-      getCdnFromS3Url(
-        'https://sparted-prod-check.s3.eu-west-1/path/to/something',
-        {
-          transformation: { fit: 'contain', height: 300, width: 200, output: 'png' },
-        },
-      ),
-    ).toBe(
-      'https://sparted.twicpics.fr/prod/check/path/to/something?twic=v1/quality=70/contain=200x300/output=png',
-    );
-  });
-});
-
-describe('cacheVersionQuery', () => {
-  it('should return cache version query', () => {
-    expect(genCacheVersionQuery(2)).toBe('v=2');
-  });
-
-  it('should return empty string if cache version is not provided', () => {
-    expect(genCacheVersionQuery()).toBe('');
-  });
-});