@sparted/shared-library 1.0.29 → 1.1.0-rc0

package/src/business/types/content.ts

@@ -0,0 +1,110 @@
+import { 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 type BaseContent = {
+  id: number;
+  identifier: string;
+  name: MultilingualLabel;
+  thematic: Thematic;
+  coverImage?: Image;
+  status: string;
+};
+
+export type Content = BaseContent &
+  (ErrorText | MultipleChoiceQuestion | NoInteraction | OpenQuestion | OrderingCards | PictureSpot | SwipingCards);

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,3 @@
+export type MultilingualLabel = {
+  [languageCode: string]: 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());
+  });
+});