@sparted/shared-library 1.1.2 → 1.1.3

package/src/array/__tests__/inner-join.test.ts

@@ -0,0 +1,55 @@
+import { innerJoin } from '../inner-join';
+
+describe('innerJoin', () => {
+  it('should return an inner join of simple arrays', () => {
+    const arr1 = [1, 2, 3];
+    const arr2 = [3, 4, 5];
+
+    const innerJoinedArr = innerJoin(
+      arr1,
+      arr2,
+      (item) => item,
+      (item) => item,
+    );
+
+    expect(innerJoinedArr).toEqual([3]);
+  });
+
+  it('should return an inner join of complex array', () => {
+    const arr1 = [
+      { id: 1, name: 'John' },
+      { id: 2, name: 'Doe' },
+      { id: 3, name: 'Jane' },
+      { id: 4, name: 'Jack' },
+      { id: 5, name: 'Jill' },
+      { id: 6, name: 'Maurice' },
+    ];
+    const arr2 = [
+      { id: 3, name: 'Jane' },
+      { id: 4, name: 'Jack' },
+      { id: 5, name: 'Jill' },
+    ];
+
+    const innerJoinedArr = innerJoin(
+      arr1,
+      arr2,
+      (item) => item.id,
+      (item) => item.id,
+    );
+
+    expect(innerJoinedArr).toEqual([
+      {
+        id: 3,
+        name: 'Jane',
+      },
+      {
+        id: 4,
+        name: 'Jack',
+      },
+      {
+        id: 5,
+        name: 'Jill',
+      },
+    ]);
+  });
+});

package/src/array/__tests__/left-outter-join.test.ts

@@ -0,0 +1,55 @@
+import { leftOutterJoin } from '../left-outter-join';
+
+describe('leftOutterJoin', () => {
+  it('should return left outter joined of simple arrays', () => {
+    const arr1 = [1, 2, 3];
+    const arr2 = [3, 4, 5];
+
+    const leftOutterJoinedArr = leftOutterJoin(
+      arr1,
+      arr2,
+      (item) => item,
+      (item) => item,
+    );
+
+    expect(leftOutterJoinedArr).toEqual([1, 2]);
+  });
+
+  it('should return left outter joined of complex array', () => {
+    const arr1 = [
+      { id: 1, name: 'John' },
+      { id: 2, name: 'Doe' },
+      { id: 3, name: 'Jane' },
+      { id: 4, name: 'Jack' },
+      { id: 5, name: 'Jill' },
+      { id: 6, name: 'Maurice' },
+    ];
+    const arr2 = [
+      { id: 3, name: 'Jane' },
+      { id: 4, name: 'Jack' },
+      { id: 5, name: 'Jill' },
+    ];
+
+    const leftOutterJoinedArr = leftOutterJoin(
+      arr1,
+      arr2,
+      (item) => item.id,
+      (item) => item.id,
+    );
+
+    expect(leftOutterJoinedArr).toEqual([
+      {
+        id: 1,
+        name: 'John',
+      },
+      {
+        id: 2,
+        name: 'Doe',
+      },
+      {
+        id: 6,
+        name: 'Maurice',
+      },
+    ]);
+  });
+});

package/src/array/array-to-map.ts

@@ -0,0 +1,32 @@
+export type ArrayToMapOptions<InitialValue, ModifiedValue = InitialValue> = {
+  /**
+   * Function to return the key used in the map.
+   */
+  selectKey: (value: InitialValue) => string,
+  /**
+   * Transform the initial data into another value
+   */
+  dataModifier?: (value: InitialValue, map: Readonly<Record<string, ModifiedValue>>) => ModifiedValue;
+};
+
+/**
+ * Transform an array to a map.
+ */
+export const arrayToMap = <InitialValue, ModifiedValue = InitialValue>(
+  array: ReadonlyArray<InitialValue>,
+  options: ArrayToMapOptions<InitialValue, ModifiedValue>,
+) => {
+  const { selectKey } = options;
+
+  return array.reduce<Record<string, ModifiedValue>>((acc, current) => {
+    const key = selectKey(current);
+    const value = options.dataModifier
+      ? options.dataModifier(current, acc)
+      : current;
+
+    return {
+      ...acc,
+      [key]: value as ModifiedValue,
+    };
+  }, {});
+};

package/src/array/get-values-from-keys.ts

@@ -0,0 +1,3 @@
+export const valuesFromKeys = <T>(keys: string[], map: Record<string, T>) => (
+  keys.map((key) => map[key])
+);

package/src/array/index.ts

@@ -0,0 +1,4 @@
+export * from './array-to-map';
+export * from './get-values-from-keys';
+export * from './left-outter-join';
+export * from './inner-join';

package/src/array/inner-join.ts

@@ -0,0 +1,10 @@
+export const innerJoin = <T, U>(
+  arr1: T[],
+  arr2: U[],
+  selectKey1: (item: T) => string | number,
+  selectKey2: (item: U) => string | number,
+) => {
+  const arr2Set = new Set(arr2.map(selectKey2));
+
+  return arr1.filter((item) => arr2Set.has(selectKey1(item)));
+};

package/src/array/left-outter-join.ts

@@ -0,0 +1,10 @@
+export const leftOutterJoin = <T, U>(
+  arr1: T[],
+  arr2: U[],
+  selectKey1: (item: T) => string | number,
+  selectKey2: (item: U) => string | number,
+) => {
+  const arr2Set = new Set(arr2.map(selectKey2));
+
+  return arr1.filter((item) => !arr2Set.has(selectKey1(item)));
+};

package/src/business/picture-spot/index.ts

@@ -0,0 +1,3 @@
+import { PictureSpot } from '../types';
+
+export const getQuestions = (content: PictureSpot) => content.items?.map(({ question }) => question);

package/src/business/types/content.ts

@@ -0,0 +1,135 @@
+import { LanguageCode, MultilingualLabel } from './multilingual';
+import { Image, Media } from './media';
+import { Thematic } from './thematic';
+
+export type ErrorText = {
+  type: 'error-text';
+  gameMedia?: Media;
+  explanationMedia?: Media;
+  explanation?: MultilingualLabel;
+  wrongText?: MultilingualLabel;
+  correctText?: MultilingualLabel;
+};
+
+export type MultipleChoiceQuestion = {
+  type: 'mcq';
+  gameMedia?: Media;
+  question?: MultilingualLabel;
+  explanation?: MultilingualLabel;
+  explanationMedia?: Media;
+  multiselect?: boolean;
+  choices?: {
+    correct: boolean;
+    text: MultilingualLabel;
+  }[];
+};
+
+export type NoInteraction = {
+  type: 'no-interaction';
+  firstMedia?: Media;
+  secondMedia?: Media;
+  title?: MultilingualLabel;
+  text?: MultilingualLabel;
+};
+
+export type OpenQuestion = {
+  type: 'open-question';
+  gameMedia?: Media;
+  question?: MultilingualLabel;
+  answer?: MultilingualLabel;
+  explanation?: MultilingualLabel;
+  explanationMedia?: Media;
+  levenshteinDistance?: number;
+};
+
+export type OrderingCards = {
+  type: 'ordering-cards';
+  explanation?: MultilingualLabel;
+  question?: MultilingualLabel;
+  topLabel?: MultilingualLabel;
+  bottomLabel?: MultilingualLabel;
+  cards: MultilingualLabel[];
+};
+
+export type PictureSpot = {
+  type: 'picture-spot';
+  image?: Image;
+  explanation?: MultilingualLabel;
+  items?: {
+    x: number;
+    y: number;
+    r: number;
+    question: MultilingualLabel;
+    description: MultilingualLabel;
+  }[];
+};
+
+export type SwipingCards = {
+  type: 'swiping-cards';
+  explanation?: MultilingualLabel;
+  question?: MultilingualLabel;
+  zones?: {
+    position: 'left' | 'right' | 'top' | 'bottom';
+    text: MultilingualLabel;
+  }[];
+  cards?: {
+    image?: Image;
+    text?: MultilingualLabel;
+    answer: 'left' | 'right' | 'top' | 'bottom';
+  }[];
+};
+
+export type Game =
+  | ErrorText
+  | MultipleChoiceQuestion
+  | NoInteraction
+  | OpenQuestion
+  | OrderingCards
+  | PictureSpot
+  | SwipingCards;
+
+export type GameType =
+  | 'error-text'
+  | 'mcq'
+  | 'open-question'
+  | 'no-interaction'
+  | 'picture-spot'
+  | 'swiping-cards'
+  | 'ordering-cards';
+
+export const GAME_TYPE: Record<string, GameType> = {
+  MCQ: 'mcq',
+  ERROR_TEXT: 'error-text',
+  OPEN_QUESTION: 'open-question',
+  NO_INTERACTION: 'no-interaction',
+  PICTURE_SPOT: 'picture-spot',
+  ORDERING_CARDS: 'ordering-cards',
+  SWIPING_CARDS: 'swiping-cards',
+};
+
+export type ContentStatuses = Partial<{
+  [languageCode in LanguageCode]: 'draft' | 'validated' | 'waiting-translation' | 'waiting-validation';
+}>;
+
+export type Content = {
+  archived: boolean;
+  id: number;
+  metadata: {
+    coverImage: Image;
+    identifier?: string;
+    name: MultilingualLabel;
+    thematic: Thematic;
+    explanation?: string;
+    knowMore?: string;
+  };
+  statuses: ContentStatuses;
+  game?: Game;
+};
+
+export const isGameMultipleChoiceQuestion = (game: Game): game is MultipleChoiceQuestion => game.type === GAME_TYPE.MCQ;
+export const isGameErrorText = (game: Game): game is ErrorText => game.type === GAME_TYPE.ERROR_TEXT;
+export const isGameOpenQuestion = (game: Game): game is OpenQuestion => game.type === GAME_TYPE.OPEN_QUESTION;
+export const isGameNoInteraction = (game: Game): game is NoInteraction => game.type === GAME_TYPE.NO_INTERACTION;
+export const isGamePictureSpot = (game: Game): game is PictureSpot => game.type === GAME_TYPE.PICTURE_SPOT;
+export const isGameOrderingCards = (game: Game): game is OrderingCards => game.type === GAME_TYPE.ORDERING_CARDS;
+export const isGameSwipingCards = (game: Game): game is SwipingCards => game.type === GAME_TYPE.SWIPING_CARDS;

package/src/business/types/index.ts

@@ -0,0 +1,4 @@
+export * from './content';
+export * from './media';
+export * from './thematic';
+export * from './multilingual';

package/src/business/types/media.ts

@@ -0,0 +1,18 @@
+export type Image = {
+  id: number;
+  url: string;
+  filename: string;
+  width: number;
+  height: number;
+};
+
+export type Video = {
+  id: number;
+  url: string;
+  type: 'Youtube' | 'api.video' | 'Kumullus';
+};
+
+export type Media = {
+  image?: Image;
+  video?: Video;
+};

package/src/business/types/multilingual.ts

@@ -0,0 +1,42 @@
+export const Languages = {
+  'en-US': 'us',
+  'fr-FR': 'fr',
+  'es-ES': 'es',
+  'it-IT': 'it',
+  'de-DE': 'de',
+  'ru-RU': 'ru',
+  'nl-NL': 'nl',
+  'pt-BR': 'br',
+  'zh-CN': 'cn',
+  'he-IL': 'il',
+  'cs-CZ': 'cz',
+  'ko-KR': 'kr',
+  'ja-JP': 'jp',
+  'zh-TW': 'tw',
+  'bg-BG': 'bg',
+  'hr-HR': 'hr',
+  'da-DK': 'dk',
+  'fi-FI': 'fi',
+  'el-GR': 'gr',
+  'hu-HU': 'hu',
+  'nb-NO': 'no',
+  'pl-PL': 'pl',
+  'pt-PT': 'pt',
+  'ro-RO': 'ro',
+  'sv-SE': 'se',
+  'tr-TR': 'tr',
+  sk: 'sk',
+  sl: 'sl',
+  'et-EE': 'ee',
+  'id-ID': 'id',
+  ar: 'ar',
+  lt: 'lt',
+  'lv-LV': 'lv',
+  'th-TH': 'th',
+};
+
+export type LanguageCode = keyof typeof Languages;
+
+export type MultilingualLabel = Partial<{
+  [languageCode in LanguageCode]: string;
+}>;

package/src/business/types/thematic.ts

@@ -0,0 +1,10 @@
+import type { MultilingualLabel } from './multilingual';
+
+export type Thematic = {
+  id: number;
+  name: string;
+  level: number;
+  label: MultilingualLabel;
+  icon?: string;
+  parentId?: number;
+};

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

@@ -0,0 +1,150 @@
+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=90/crop=1x1');
+
+    const contain = twicpicsTransformationQueries({
+      fit: 'contain',
+      width: 1,
+      height: 1,
+    });
+
+    expect(contain).toBe('twic=v1/quality=90/contain=1x1');
+
+    const coverOnlyWidth = twicpicsTransformationQueries({ width: 1 });
+
+    expect(coverOnlyWidth).toBe('twic=v1/quality=90/cover=1x-');
+
+    const coverOnlyHeight = twicpicsTransformationQueries({ height: 1 });
+
+    expect(coverOnlyHeight).toBe('twic=v1/quality=90/cover=-x1');
+
+    const noSize = twicpicsTransformationQueries({
+      fit: 'contain',
+    });
+
+    expect(noSize).toBe('twic=v1/quality=90');
+
+    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=90/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());
+  });
+});