@sparted/shared-library 1.9.5 → 1.10.0

package/src/business/types/content.ts

@@ -1,261 +0,0 @@
-import { DeepPartial } from 'ts-essentials';
-
-import { Image, Media } from './media';
-import { LanguageCode, MultilingualLabel } from './multilingual';
-import { Thematic } from './thematic';
-import { PlayerProfile } from './player';
-
-export type ContentStatuses = Partial<{
-  [languageCode in LanguageCode]: 'draft' | 'validated' | 'waiting-translation' | 'waiting-validation';
-}>;
-
-export type BOContentCard = {
-  id: number;
-  customId: string;
-  coverImage?: Image;
-  title: MultilingualLabel;
-  statuses: ContentStatuses;
-};
-
-export type ErrorText = {
-  id: number;
-  type: 'error-text';
-  gameMedia: Media;
-  wrongText: MultilingualLabel;
-  correctText: MultilingualLabel;
-  explanationMedia: Media;
-  explanation: MultilingualLabel;
-};
-
-export type ChoiceQuestion = {
-  text: MultilingualLabel;
-  correct: boolean;
-};
-
-export type MultipleChoiceQuestion = {
-  id: number;
-  type: 'mcq';
-  gameMedia: Media;
-  question: MultilingualLabel;
-  choices: ChoiceQuestion[];
-  explanationMedia: Media;
-  explanation: MultilingualLabel;
-};
-
-export type NoInteraction = {
-  id: number;
-  type: 'no-interaction';
-  firstMedia: Media;
-  title: MultilingualLabel;
-  text: MultilingualLabel;
-  secondMedia: Media;
-};
-
-export type OpenQuestion = {
-  id: number;
-  type: 'open-question';
-  gameMedia: Media;
-  question: MultilingualLabel;
-  answer: MultilingualLabel;
-  levenshteinDistance: number;
-  explanationMedia: Media;
-  explanation: MultilingualLabel;
-};
-
-export type OrderingCards = {
-  id: number;
-  type: 'ordering-cards';
-  question: MultilingualLabel;
-  topLabel: MultilingualLabel;
-  cards: MultilingualLabel[];
-  bottomLabel: MultilingualLabel;
-  explanation: MultilingualLabel;
-};
-
-export type Spot = {
-  id: number;
-  x: number;
-  y: number;
-  r: number;
-  question: MultilingualLabel;
-  description: MultilingualLabel;
-};
-
-export type PictureSpot = {
-  id: number;
-  type: 'picture-spot';
-  image: Image;
-  items: Spot[];
-  explanation: MultilingualLabel;
-};
-
-export type SwipingCardPosition = 'left' | 'right' | 'top' | 'bottom';
-
-export type SwipingCardZone = {
-  position: SwipingCardPosition;
-  text: MultilingualLabel;
-};
-
-export type SwipingCard = {
-  image?: Image;
-  text?: MultilingualLabel;
-  answer: SwipingCardPosition;
-};
-
-export type SwipingCards = {
-  id: number;
-  type: 'swiping-cards';
-  question: MultilingualLabel;
-  zones: SwipingCardZone[];
-  cards: SwipingCard[];
-  explanation: MultilingualLabel;
-};
-
-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 ContentMetadata = {
-  identifier: string;
-  coverImage?: Image;
-  name: MultilingualLabel;
-  knowMore: MultilingualLabel;
-  thematic: Thematic;
-  type: GameType;
-};
-
-export type ContributionType =
-  | 'validated'
-  | 'created'
-  | 'edited'
-  | 'deleted'
-  | 'translation-requested'
-  | 'translation-validated'
-  | 'translation-unvalidated'
-  | 'validation-requested'
-  | 'archived'
-  | 'unarchived';
-
-export type ContentContribution = {
-  id: number;
-  contributor: PlayerProfile;
-  type: ContributionType;
-  date: Date;
-};
-
-export type Content = {
-  id: number;
-  legacyKnowledgeId: number;
-  legacyContentIds: number[];
-  metadata: ContentMetadata;
-  game?: Game;
-  statuses: ContentStatuses;
-  contributions: ContentContribution[];
-  archived: boolean;
-};
-
-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;
-
-export const isPartialGameMultipleChoiceQuestion = (
-  game: DeepPartial<Game>,
-): game is DeepPartial<MultipleChoiceQuestion> => game.type === GAME_TYPE.MCQ;
-export const isPartialGameErrorText = (game: DeepPartial<Game>): game is DeepPartial<ErrorText> =>
-  game.type === GAME_TYPE.ERROR_TEXT;
-export const isPartialGameOpenQuestion = (game: DeepPartial<Game>): game is DeepPartial<OpenQuestion> =>
-  game.type === GAME_TYPE.OPEN_QUESTION;
-export const isPartialGameNoInteraction = (game: DeepPartial<Game>): game is DeepPartial<NoInteraction> =>
-  game.type === GAME_TYPE.NO_INTERACTION;
-export const isPartialGamePictureSpot = (game: DeepPartial<Game>): game is DeepPartial<PictureSpot> =>
-  game.type === GAME_TYPE.PICTURE_SPOT;
-export const isPartialGameOrderingCards = (game: DeepPartial<Game>): game is DeepPartial<OrderingCards> =>
-  game.type === GAME_TYPE.ORDERING_CARDS;
-export const isPartialGameSwipingCards = (game: DeepPartial<Game>): game is DeepPartial<SwipingCards> =>
-  game.type === GAME_TYPE.SWIPING_CARDS;
-
-export const extractGameExplanation = (game?: Game) => {
-  if (!game || game.type === 'no-interaction') {
-    return undefined;
-  }
-
-  return game.explanation;
-};
-
-export const extractExplanation = (content: Content) => {
-  return extractGameExplanation(content.game);
-};
-
-export const extractImages = (game: Game) => {
-  if (isGameOrderingCards(game)) {
-    return [];
-  }
-
-  if (isGameNoInteraction(game)) {
-    const images = [];
-
-    if (game.firstMedia.image?.url) {
-      images.push(game.firstMedia.image.url);
-    }
-
-    if (game.secondMedia?.image?.url) {
-      images.push(game.secondMedia.image.url);
-    }
-
-    return images;
-  }
-
-  if (isGamePictureSpot(game)) {
-    return [game.image.url];
-  }
-
-  if (isGameSwipingCards(game)) {
-    return game.cards.reduce<string[]>((acc, card) => {
-      if (card.image?.url) {
-        acc.push(card.image.url);
-      }
-
-      return acc;
-    }, []);
-  }
-
-  const images = [];
-
-  if (game.gameMedia.image?.url) {
-    images.push(game.gameMedia.image.url);
-  }
-
-  if (game.explanationMedia.image?.url) {
-    images.push(game.explanationMedia.image.url);
-  }
-
-  return images;
-};

package/src/business/types/document.ts

@@ -1,17 +0,0 @@
-export type Document = {
-  archived: boolean;
-  available: boolean;
-  categoryId: number;
-  createdAt: string;
-  id: number;
-  path: string;
-  size: number;
-  title: string;
-  type: string;
-  updatedAt: string;
-};
-
-export type Category = {
-  id: number;
-  label: string;
-};

package/src/business/types/index.ts

@@ -1,14 +0,0 @@
-export * from './achievement';
-export * from './activity';
-export * from './audience';
-export * from './battle';
-export * from './breaking-news';
-export * from './campaign';
-export * from './content';
-export * from './document';
-export * from './media';
-export * from './multilingual';
-export * from './player';
-export * from './score';
-export * from './thematic';
-export * from './user-engagement';

package/src/business/types/media.ts

@@ -1,18 +0,0 @@
-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

@@ -1,47 +0,0 @@
-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',
-  'vi-VN': 'vn',
-};
-
-export type LanguageCode = keyof typeof Languages;
-
-export type MultilingualLabel = { id: number } & Partial<{
-  [languageCode in LanguageCode]: string;
-}>;
-
-export function isLanguageCode(lang: string): lang is LanguageCode {
-  return !!Object.keys(Languages).includes(lang);
-}

package/src/business/types/player.ts

@@ -1,28 +0,0 @@
-import type { Calendar } from './campaign';
-
-export type PlayerProfile = {
-  id: number;
-  firstName: string;
-  lastName: string;
-  pseudo?: string;
-  profilePicture: string;
-};
-
-export type PlayerWithParticipation = PlayerProfile & {
-  calendar: Calendar[];
-  hasPlayedToday: boolean;
-  hasFinished: boolean;
-  lastPlayedDate?: Date;
-  nbPlayedSessions: number;
-};
-
-export type Opponent = {
-  id: number;
-  profile: PlayerProfile;
-  favorite: boolean;
-  scores: {
-    nbBattlesAgainstPlayer: number;
-    battleWonByPlayer: number;
-  };
-  challengeStatus: 'ready' | 'pending' | 'finished';
-};

package/src/business/types/score.ts

@@ -1,61 +0,0 @@
-export type Points = {
-  question: number;
-  chrono: number;
-  bonus: number;
-};
-
-export type LiveCampaignPoints = {
-  question: number;
-  chrono: number;
-  bonus: number;
-  adaptive: number | null;
-};
-
-export type Stars = {
-  question: number;
-  chrono: number;
-  bonus: number;
-};
-
-export type Streaks = {
-  totalPoints: number;
-  streaksCount: number;
-  streaksCountHistory: number[];
-};
-
-export type Timer = {
-  timespent: number;
-  timeout: boolean;
-};
-
-export type BaseScore = {
-  id?: number;
-  playerId: number;
-  contentId: number;
-  points: Points;
-  timer: Timer;
-  createdAt: Date;
-};
-
-export type CampaignScore = BaseScore & {
-  points: LiveCampaignPoints;
-  campaignId: number;
-  campaignContentId: number;
-  sessionNumber?: number; // TODO: should be required after conversion
-};
-
-export type WikiScore = BaseScore & {
-  wikiId: number;
-  campaignContentId: number;
-  sessionNumber?: number;
-};
-
-export type BattleScore = BaseScore & {
-  battleId: number;
-};
-
-export type Score = CampaignScore | WikiScore | BattleScore;
-
-export const isCampaignScore = (score: Score): score is CampaignScore => 'campaignId' in score;
-export const isWikiScore = (score: Score): score is WikiScore => 'wikiId' in score;
-export const isBattleScore = (score: Score): score is BattleScore => 'battleId' in score;

package/src/business/types/thematic.ts

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

package/src/business/types/user-engagement.ts

@@ -1,11 +0,0 @@
-export type UserEngagement = {
-  viewCount: number;
-  likeCount: number;
-  isLiked: boolean;
-  lastViewed: string | null;
-};
-
-export type EventSummary = {
-  viewCount: number;
-  likeCount: number;
-};

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());
-  });
-});