@sparted/shared-library 1.9.5 → 1.10.0

package/src/business/campaign/live-campaign.ts

@@ -1,133 +0,0 @@
-import { addDays, isSameDate } from '../../date';
-import { CampaignDetails, LiveCampaign } from '../types';
-
-export const computeIntenseCalendar = (card: LiveCampaign): Date[] => {
-  const { details } = card;
-
-  const startDate = new Date(details.utcStartDate);
-  const endDate = new Date(details.utcEndDate);
-
-  const calculateIntenseCalendarAux = (date: Date, calendar: Date[]): Date[] => {
-    if (date > endDate) {
-      return calendar;
-    }
-
-    const jsDay = date.getDay();
-    const day = jsDay === 0 ? 7 : jsDay;
-
-    if (details.enabledWeekDays.includes(day) && !details.disabledDates.includes(date.toISOString().slice(0, 10))) {
-      calendar.push(new Date(date));
-    }
-
-    date.setDate(date.getDate() + 1);
-
-    return calculateIntenseCalendarAux(date, calendar);
-  };
-
-  return calculateIntenseCalendarAux(startDate, []);
-};
-
-export const computeCurrentSession = (card: LiveCampaign, forceComputeCalendar?: boolean): number => {
-  const { details, achievement } = card;
-
-  if (details.type === 'flexible' && !forceComputeCalendar) {
-    return Math.min(achievement.lastSessionPlayed + 1, details.sessionCount);
-  }
-
-  const today = new Date();
-
-  if (today <= new Date(details.utcStartDate)) {
-    return 1;
-  }
-
-  if (today >= new Date(details.utcEndDate)) {
-    return details.sessionCount;
-  }
-
-  const calendar = computeIntenseCalendar(card);
-
-  const todayDate = today.toISOString().slice(0, 10);
-  const currentSession = calendar.findIndex((date) => date.toISOString().slice(0, 10) >= todayDate);
-
-  if (currentSession === -1) {
-    throw new Error('Current session not found');
-  }
-
-  return Math.min(currentSession + 1, details.sessionCount);
-};
-
-export const checkTodayPlayable = (card: LiveCampaign): boolean => {
-  const today = new Date();
-
-  const { details } = card;
-
-  const startDate = new Date(details.utcStartDate);
-  const endDate = new Date(details.utcEndDate);
-
-  if (today < startDate || today > endDate) {
-    return false;
-  }
-
-  const jsDay = today.getDay();
-  const day = jsDay === 0 ? 7 : jsDay;
-
-  if (!details.enabledWeekDays.includes(day)) {
-    return false;
-  }
-
-  if (details.disabledDates.includes(today.toISOString().slice(0, 10))) {
-    return false;
-  }
-
-  return true;
-};
-
-export const findNextAvailableDate = (
-  currentDate: Date,
-  enabledWeekDays: number[],
-  disabledDates: Date[],
-): Date | null => {
-  if (enabledWeekDays.length === 0) return null;
-  const dayofDate = currentDate.getDay();
-  const isEnabledDay = enabledWeekDays.includes(dayofDate === 0 ? 7 : dayofDate);
-  const isDisabledDate = disabledDates.some((d) => isSameDate(d, currentDate));
-
-  if (isEnabledDay && !isDisabledDate) {
-    return currentDate;
-  }
-
-  return findNextAvailableDate(addDays(currentDate, 1), enabledWeekDays, disabledDates);
-};
-
-type GetCalendarSessionDatesFromCampaignProps = Pick<
-  CampaignDetails,
-  'launchDate' | 'enabledWeekDays' | 'disabledDates' | 'nbSessions'
-> & {
-  extraDays?: number;
-};
-
-export const getCalendarSessionDatesFromCampaign = ({
-  launchDate,
-  enabledWeekDays,
-  disabledDates,
-  nbSessions,
-  extraDays = 0,
-}: GetCalendarSessionDatesFromCampaignProps): Record<number, Date> => {
-  const sessionCount = nbSessions + extraDays;
-
-  const calendarDatesBySession = Array.from({ length: sessionCount }).reduce((acc: Record<number, Date>, _, index) => {
-    const session = index + 1;
-    const lastDate = session > 1 ? addDays(new Date(acc[session - 1]), 1) : new Date(launchDate);
-
-    const nextSessionDate = findNextAvailableDate(lastDate, enabledWeekDays, disabledDates);
-
-    if (!nextSessionDate) return acc;
-
-    return {
-      ...acc,
-      [session]: nextSessionDate,
-    };
-  }, {});
-
-  return calendarDatesBySession;
-};

package/src/business/course/index.ts

@@ -1 +0,0 @@
-export * from './microknowledge-max-lengths';

package/src/business/course/microknowledge-max-lengths.ts

@@ -1,12 +0,0 @@
-export const MICROKNOWLEDGE_MAX_LENGTHS = {
-  IMAGE: {
-    MAX_TITLE_LENGTH: 40,
-    MAX_CONTENT_LENGTH: 500,
-  },
-  VIDEO: {
-    MAX_TITLE_LENGTH: 40,
-  },
-  CHAPTER: {
-    MAX_TITLE_LENGTH: 40,
-  },
-};

package/src/business/index.ts

@@ -1,4 +0,0 @@
-export * from './campaign';
-export * from './course';
-export * from './picture-spot';
-export * from './types';

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

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

package/src/business/types/achievement.ts

@@ -1,41 +0,0 @@
-import type { MultilingualLabel } from './multilingual';
-import type { PlayerProfile } from './player';
-import type { Image } from './media';
-
-export type CampaignRanking = {
-  activityId: number;
-  playerProfile: PlayerProfile;
-  rank: number;
-  score: number;
-  numberSessionsPlayed: number;
-  lastPlayed: string;
-  favorite: boolean;
-};
-
-export type CampaignTeamRanking = {
-  activityId: number;
-  team: {
-    ambassadorId: number;
-    teamName: string | null;
-    ambassadorFirstName: string;
-    ambassadorLastName: string;
-  };
-  rank: number;
-  score: number;
-  image: Image | null;
-};
-
-export type MostFailedQuestion = {
-  title: MultilingualLabel;
-  correctAnswerRate: number;
-};
-
-export type CampaignStats = {
-  participationRate: number;
-  exposureRate: number;
-  masteryRate: number;
-  correctAnswerRate: number;
-  mostFailed: MostFailedQuestion[];
-  nbQuestions: number;
-  nbActivePlayers: number;
-};

package/src/business/types/activity.ts

@@ -1,64 +0,0 @@
-import type { AudienceInformation, Segment } from './audience';
-import type { BreakingNewsActivity } from './breaking-news';
-import type { Campaign } from './campaign';
-import type { Media } from './media';
-import type { LanguageCode, MultilingualLabel } from './multilingual';
-import type { EventSummary } from './user-engagement';
-
-export type ActivityAudience = {
-  groupId: number;
-  type: 'all' | 'segmentation' | 'magic-code' | 'email-list';
-  segments: Segment[];
-};
-
-export type ActivityStatus = (typeof ACTIVITY_STATUS)[number];
-
-export type SharedActivityMetadata = {
-  status: ActivityStatus;
-  languages?: LanguageCode[];
-  audiences?: ActivityAudience[];
-  userEngagement?: {
-    viewCount?: number;
-    likeCount?: number;
-  };
-};
-
-export type CampaignActivity = SharedActivityMetadata & Campaign;
-
-export type Activity = CampaignActivity | BreakingNewsActivity;
-
-export type BoActivityCardDetails = {
-  identifier: string;
-  cover: Media;
-  title: MultilingualLabel;
-  utcStartDate: string;
-  utcEndDate?: string;
-};
-
-export type BoActivityCard = {
-  id: number;
-  type: 'campaign' | 'breaking-news';
-  status: ActivityStatus;
-  details: BoActivityCardDetails;
-  language: LanguageCode[];
-  eventSummary: EventSummary;
-  audience: AudienceInformation;
-  audienceGroupNames: string[];
-};
-
-export const ACTIVITY_STATUS = [
-  'draft',
-  'inactive',
-  'archived',
-  'upcoming',
-  'live',
-  'celebration',
-  'finished',
-] as const;
-
-export const isActivityCampaign = (activity: unknown): activity is CampaignActivity =>
-  typeof activity === 'object' && activity !== null && 'type' in activity && activity.type === 'campaign';
-
-export const isActivityBreakingNews = (
-  activity: CampaignActivity | BreakingNewsActivity,
-): activity is BreakingNewsActivity => activity.type === 'breaking-news';

package/src/business/types/audience.ts

@@ -1,23 +0,0 @@
-export type Segment = {
-  id: number;
-  label: string;
-  dimensionId: number;
-};
-
-export type AudienceType = 'all' | 'segmentation' | 'magic-code' | 'email-list' | 'audience';
-
-export type AudienceInformation =
-  | {
-      type: 'all';
-    }
-  | {
-      type: 'segmentation';
-      segments: Segment[];
-    }
-  | {
-      type: 'magic-code';
-      code: string;
-    }
-  | {
-      type: 'email-list';
-    };

package/src/business/types/battle.ts

@@ -1,17 +0,0 @@
-import type { PlayerProfile } from './player';
-
-export type BattleStatus = 'ready-to-play' | 'awaiting-opponent' | 'watch-result' | 'finished' | 'declined';
-export type BattleWinningStatus = 'winner' | 'loser' | 'draw';
-
-export type BattleSummary = {
-  id: number;
-  player: PlayerProfile;
-  opponent: PlayerProfile;
-  isChallenged: boolean;
-  status: BattleStatus;
-  totalScores: {
-    player: number;
-    opponent: number;
-  };
-  winningStatus?: BattleWinningStatus;
-};

package/src/business/types/breaking-news.ts

@@ -1,43 +0,0 @@
-import type { Media } from './media';
-import type { MultilingualLabel } from './multilingual';
-import type { UserEngagement } from './user-engagement';
-
-export type BreakingNewsActivity = {
-  informations: {
-    name: MultilingualLabel;
-    description: MultilingualLabel;
-    isLongText: boolean;
-    text?: MultilingualLabel;
-    coverMedia?: Media;
-  };
-  notification: {
-    isRecurringNotification: boolean;
-    isNotificationActive: boolean;
-    notificationTime: string;
-  };
-  scheduling: {
-    startDate: string;
-    endDate: string;
-  };
-  userEngagement: UserEngagement;
-  id: number;
-  type: 'breaking-news';
-};
-
-export type BreakingNewsCardDetails = {
-  id: number;
-  coverMedia?: {
-    type: 'image' | 'video';
-    url: string;
-  };
-  name: MultilingualLabel;
-  description: MultilingualLabel;
-  text?: MultilingualLabel;
-  utcStartDate: string;
-  isRecurringNotification: boolean;
-};
-
-export type BreakingNewsCard = {
-  details: BreakingNewsCardDetails;
-  userEngagement: UserEngagement;
-};

package/src/business/types/campaign.ts

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