@sparted/shared-library 1.9.4 → 1.9.5

package/src/business/types/campaign.ts

@@ -0,0 +1,163 @@
+import type { CampaignStats } from './achievement';
+import { ActivityStatus } from './activity';
+import type { Content, GameType } from './content';
+import type { Image } from './media';
+import type { MultilingualLabel } from './multilingual';
+import type { PlayerProfile, PlayerWithParticipation } from './player';
+import type { LiveCampaignPoints, Points, Stars, Streaks } from './score';
+
+export type WithCampaignContentId<T> = T & { campaignContentId: number };
+
+export type CampaignInformations = {
+  coverImage: Image;
+  name: MultilingualLabel;
+  description: MultilingualLabel;
+  disclaimer?: MultilingualLabel;
+  lastSave: Date;
+};
+
+export type BaseCampaignScheduling = {
+  type: 'flexible' | 'intense';
+  launchDate: string;
+  endDate?: string;
+  extraDays: number;
+  enabledWeekDays: number[];
+  disabledDates: string[];
+};
+
+export type ManualCampaignScheduling = BaseCampaignScheduling & {
+  mode: 'manual';
+  orderedSessions: Content[][];
+};
+
+export type RandomCampaignScheduling = BaseCampaignScheduling & {
+  mode: 'random';
+  nbSessions: number;
+  contents: Content[];
+};
+
+export type CampaignScheduling = ManualCampaignScheduling | RandomCampaignScheduling;
+
+export type Campaign = {
+  id: number;
+  informations: CampaignInformations;
+  scheduling: CampaignScheduling;
+  type: 'campaign';
+};
+
+export type BaseCampaignCardDetails = {
+  id: number;
+  status: ActivityStatus;
+  cover: string;
+  title: MultilingualLabel;
+  description: MultilingualLabel;
+  disclaimer?: MultilingualLabel;
+  utcStartDate: string;
+  utcEndDate: string;
+  contentCount: number;
+  contentStars?: number;
+  sessionContentDistribution: number[];
+  isRandom: boolean;
+  playableDays?: Date[];
+};
+
+export type WikiCardDetails = BaseCampaignCardDetails;
+
+export type WikiCardPlayerInteraction = {
+  contentPlayedIds: number[];
+  contentPlayerStars: number;
+  favorite: boolean;
+};
+
+export type WikiCard = {
+  details: WikiCardDetails;
+  playerInteraction: WikiCardPlayerInteraction;
+};
+
+export type WikiContentCardDetails = {
+  id: number;
+  campaignContentId: number;
+  coverImage: string;
+  title: MultilingualLabel;
+  explanation?: MultilingualLabel;
+  session: number;
+};
+
+export type WikiContentCard = {
+  contentDetails: WikiContentCardDetails;
+  points: Points;
+};
+
+export type LiveCampaignScheduling = {
+  type: 'flexible' | 'intense';
+  extraDays: number;
+  enabledWeekDays: number[];
+  disabledDates: string[];
+  sessionCount: number;
+};
+
+export type LiveCampaignDetails = BaseCampaignCardDetails & LiveCampaignScheduling;
+
+export type LiveCampaignAchievement = {
+  playedSessions: number[];
+  playedSessionsCount: number;
+  lastSessionPlayed: number;
+  lastPlayedAt: string | null;
+  stars: Stars;
+  points: LiveCampaignPoints;
+  streaks?: Streaks;
+};
+
+export type SessionInsight = {
+  sessionNumber: number;
+  gameTypes: GameType[];
+};
+
+export type StreakSession = {
+  day: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+  status: CalendarStatus;
+  streakCount?: number;
+};
+
+export type LiveCampaign = {
+  details: LiveCampaignDetails;
+  achievement: LiveCampaignAchievement;
+  /** @deprecated to avoid breaking changes */
+  sessionInsights: SessionInsight[];
+  leaderPlayer?: PlayerProfile;
+  streakSessions?: StreakSession[];
+};
+
+export type CalendarStatus = 'played' | 'playable' | 'pending' | 'missed';
+
+export type Calendar = {
+  order: number;
+  status: CalendarStatus;
+  date: Date;
+};
+
+export type CampaignDetails = {
+  id: number;
+  coverImage?: Image;
+  name: MultilingualLabel;
+  mode: 'manual' | 'random';
+  launchDate: string;
+  endDate: string;
+  enabledWeekDays: number[];
+  disabledDates: Date[];
+  lastNotificationDate: Date;
+  nbPlayers: number;
+  nbSessions: number;
+  nbQuestions: number;
+  players: PlayerWithParticipation[];
+  stats: CampaignStats;
+};
+
+export const isCampaignSchedulingRandom = (scheduling: CampaignScheduling): scheduling is RandomCampaignScheduling =>
+  scheduling.mode === 'random';
+
+export const isCampaignSchedulingManual = (scheduling: CampaignScheduling): scheduling is ManualCampaignScheduling =>
+  scheduling.mode === 'manual';
+
+export const isWikiCard = (item: unknown): item is WikiCard =>
+  typeof item === 'object' && item !== null && 'details' in item && 'playerInteraction' in item;

package/src/business/types/content.ts

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

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

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

@@ -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,47 @@
+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

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

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

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

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