@playpilot/tpi 8.28.1 → 8.29.0-beta.10

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@playpilot/tpi",
-	"version": "8.28.1",
+	"version": "8.29.0-beta.10",
 	"type": "module",
 	"scripts": {
 		"dev": "vite dev",

package/src/lib/api/participants.ts

@@ -1,3 +1,4 @@
+import { participants } from '$lib/fakeData'
 import { getLanguage } from '$lib/language'
 import { getApiToken } from '$lib/token'
 import type { ParticipantData } from '$lib/types/participant'
@@ -25,3 +26,11 @@ export async function fetchParticipantsForTitle(title: TitleData): Promise<Parti
 
   return response.results
 }
+
+export async function fetchParticipantBySid(sid: string): Promise<ParticipantData> {
+  const participant = await api<ParticipantData>(`/participants/${sid}?api-token=${getApiToken()}`)
+
+  if (!participant) throw new Error('No participant was returned for sid: ' + sid)
+
+  return participant
+}

package/src/lib/injection.ts

@@ -5,9 +5,9 @@ import { destroyAllModals, openModalForInjectedLink } from './modal'
 import { clearCurrentlyHoveredInjection, destroyLinkPopover, destroyLinkPopoverOnMouseleave, isPopoverActive, openPopoverForInjectedLink } from './popover'
 import { clearAfterArticlePlaylinks, insertAfterArticlePlaylinks } from './afterArticle'
 import { clearInTextDisclaimer, insertInTextDisclaimer } from './disclaimer'
-import { exploreTitleUrl, titleUrl } from './routes'
+import { exploreModalUrl, participantUrl, titleUrl } from './routes'
 import { clearInTextWidgets, insertInTextWidgets } from './inTextWidgets'
-import { decodeHtmlEntities, encodeHtmlEntities } from './html'
+import { encodeHtmlEntities } from './html'
 
 export const keyDataAttribute = 'data-playpilot-injection-key'
 export const keySelector = `[${keyDataAttribute}]`
@@ -32,9 +32,7 @@ export function injectLinksInDocument(elements: HTMLElement[], injections: LinkI
 
   const failedMessages: Record<string, string> = {}
 
-  // Start at -1 so that we can add +1 right at the top of the loop, making it start at 0.
-  // This index is used in Option 3 below.
-  let injectionIndex = -1
+  let injectionIndex = -1 // This index is used in Option 3 below.
   for (const injection of sortInjections(foundInjections)) {
     injectionIndex++
 
@@ -218,15 +216,17 @@ function createLinkInjectionElement(injection: LinkInjection): { injectionElemen
 
   const openInExplore = !!window.PlayPilotLinkInjections?.config?.open_tpi_links_in_explore
 
-  const href = openInExplore ? exploreTitleUrl(injection.title_details!) : titleUrl(injection.title_details!)
+  const sid = injection.title_details?.sid || injection.participant_details?.sid
+  const href = openInExplore ? exploreModalUrl(sid!) : (injection.type === 'title' ? titleUrl(injection.title_details!) : participantUrl(injection.participant_details!))
 
   const linkElement = document.createElement('a')
-  linkElement.dataset.playpilotPosterUrl = injection.title_details?.standing_poster
   linkElement.innerText = injection.title
   linkElement.href = href
   linkElement.target = openInExplore ? '' : '_blank'
   linkElement.rel = 'noopener nofollow noreferrer'
 
+  if (injection.type === 'title') linkElement.dataset.playpilotPosterUrl = injection.title_details?.standing_poster
+
   injectionElement.insertAdjacentElement('beforeend', linkElement)
 
   return { injectionElement, linkElement }

package/src/lib/modal.ts

@@ -13,10 +13,12 @@ import { prefersReducedMotion } from 'svelte/motion'
 import TitlesRailModal from '../routes/components/Modals/TitlesRailModal.svelte'
 import TitlesReelModal from '../routes/components/Modals/TitlesReelModal.svelte'
 
+export type ModalType = 'title' | 'participant' | 'titles-rail' | 'titles-reel'
+
 type Modal = {
   injection?: LinkInjection | null
   component?: object
-  type: 'title' | 'participant' | 'titles-rail' | 'titles-reel'
+  type: ModalType
   data: TitleData | TitleData[] | ParticipantData | null
   scrollPosition?: number
 }

package/src/lib/routes.ts

@@ -1,10 +1,15 @@
 import { playPilotBaseUrl } from './constants'
+import type { ParticipantData } from './types/participant'
 import type { TitleData } from './types/title'
 
 export function titleUrl(title: TitleData): string {
   return `${playPilotBaseUrl}/${title.type}/${title.slug}/`
 }
 
-export function exploreTitleUrl(title: TitleData): string {
-  return window.PlayPilotLinkInjections?.config?.explore_navigation_path + `?route=modal&sid=${title.sid}`
+export function participantUrl(participant: ParticipantData): string {
+  return `${playPilotBaseUrl}/name/${participant.sid}/`
+}
+
+export function exploreModalUrl(sid: string): string {
+  return window.PlayPilotLinkInjections?.config?.explore_navigation_path + `?route=modal&sid=${sid}`
 }

package/src/lib/types/participant.d.ts

@@ -6,6 +6,14 @@ export type ParticipantData = {
   jobs: Job[]
   image: string | null
   image_uuid: string | null
+  image_metadata?: {
+    license_name: string
+    license_url: string
+    source_text: string
+    source_url: string
+    author_text: string
+    author_url: string
+  }
   gender: string
   character?: string | null
   bio?: string | null

package/src/routes/components/Explore/Routes/ExploreModal.svelte

@@ -1,9 +1,10 @@
 <script lang="ts">
+  import { fetchParticipantBySid } from '$lib/api/participants'
   import { fetchSimilarTitles, fetchTitleBySid } from '$lib/api/titles'
   import { mobileBreakpoint } from '$lib/constants'
   import { SplitTest } from '$lib/enums/SplitTest'
   import { t } from '$lib/localization'
-  import { openModal } from '$lib/modal'
+  import { openModal, type ModalType } from '$lib/modal'
   import { getSplitTestVariantName, trackSplitTestView } from '$lib/splitTest'
   import type { TitleData } from '$lib/types/title'
   import Modal from '../../Modals/Modal.svelte'
@@ -20,20 +21,27 @@
 
     if (!sid) return
 
-    const isMobile = window.innerWidth < mobileBreakpoint
-    const isInReelSplitTest = isMobile && getSplitTestVariantName(SplitTest.Reels) === 'Reel'
-    const type = isMobile && isInReelSplitTest ? 'titles-reel' : 'titles-rail'
+    let type: ModalType = sid.startsWith('pr') ? 'participant' : 'title' // Sids with with `pr` for participants, `ti` for titles
+    let data: any = null
 
-    if (isMobile) trackSplitTestView(SplitTest.Reels)
+    if (type === 'title') {
+      const isMobile = window.innerWidth < mobileBreakpoint
+      const isInReelSplitTest = isMobile && getSplitTestVariantName(SplitTest.Reels) === 'Reel'
 
-    const [title, railTitles] = (await Promise.allSettled([
-      fetchTitleBySid(sid),
-      fetchSimilarTitles({ sid } as unknown as TitleData)])
-    ).map(promise => (promise.status === 'fulfilled' ? promise.value : null))
+      if (isMobile) trackSplitTestView(SplitTest.Reels)
+
+      type = isMobile && isInReelSplitTest ? 'titles-reel' : 'titles-rail'
+
+      const [title, railTitles] = (await Promise.allSettled([fetchTitleBySid(sid), fetchSimilarTitles({ sid } as unknown as TitleData)])).map((promise) => promise.status === 'fulfilled' ? promise.value : null)
+
+      data = [title as TitleData, ...(railTitles as TitleData[])]
+    } else if (type === 'participant') {
+      data = await fetchParticipantBySid(sid)
+    }
 
     openModal({
       type,
-      data: [(title as TitleData), ...(railTitles as TitleData[])],
+      data,
       props: {
         onclose: () => navigate('home'),
         pushState: false,

package/src/routes/components/Icons/IconAttribution.svelte

@@ -0,0 +1,3 @@
+<svg height="24px" viewBox="0 -960 960 960" width="24px">
+  <path fill="currentColor" d="M430-200h100v-180h60v-184q0-27-28.5-41.5T480-620q-53 0-81.5 14.5T370-564v184h60v180Zm-105 88.5q-73-31.5-127.5-86t-86-127.5Q80-398 80-480.5t31.5-155q31.5-72.5 86-127t127.5-86Q398-880 480.5-880t155 31.5q72.5 31.5 127 86t86 127Q880-563 880-480.5T848.5-325q-31.5 73-86 127.5t-127 86Q563-80 480.5-80T325-111.5Zm381.5-142Q800-347 800-480t-93.5-226.5Q613-800 480-800t-226.5 93.5Q160-613 160-480t93.5 226.5Q347-160 480-160t226.5-93.5ZM523-657q17-17 17-43t-17-43q-17-17-43-17t-43 17q-17 17-17 43t17 43q17 17 43 17t43-17Zm-43 177Z"/>
+</svg>

package/src/routes/components/InjectionPopover.svelte

@@ -10,7 +10,7 @@
   import { trackViaPixel } from '@playpilot/retargeting-tracking'
   import Popover from './Popover.svelte'
   import Title from './Title.svelte'
-  import Participant from './Participant.svelte'
+  import Participant from './Participants/Participant.svelte'
   import TopScroll from './Ads/TopScroll.svelte'
   import Display from './Ads/Display.svelte'
 

package/src/routes/components/Modals/ParticipantModal.svelte

@@ -1,7 +1,7 @@
 
 <script lang="ts">
   import Modal from './Modal.svelte'
-  import Participant from '../Participant.svelte'
+  import Participant from '../Participants/Participant.svelte'
   import type { ParticipantData } from '$lib/types/participant'
   import { TrackingEvent } from '$lib/enums/TrackingEvent'
   import { track } from '$lib/tracking'
@@ -12,7 +12,7 @@
     initialScrollPosition?: number
   }
 
-  const { participant, initialScrollPosition = 0 }: Props = $props()
+  const { participant, initialScrollPosition = 0, ...restProps }: Props = $props()
 
   let windowWidth = $state(0)
 
@@ -27,6 +27,6 @@
 
 <svelte:window bind:innerWidth={windowWidth} />
 
-<Modal {initialScrollPosition} closeButtonStyle="flat" tall>
+<Modal {initialScrollPosition} {...restProps} closeButtonStyle="flat" tall>
   <Participant {participant} />
 </Modal>

package/src/routes/components/{Participant.svelte → Participants/Participant.svelte}

@@ -5,11 +5,12 @@
   import { openModal } from '$lib/modal'
   import type { ParticipantData } from '$lib/types/participant'
   import type { TitleData } from '$lib/types/title'
-  import ListTitle from './ListTitle.svelte'
   import { t } from '$lib/localization'
   import { isRetargetingAllowed } from '$lib/retargeting'
   import { trackViaPixel } from '@playpilot/retargeting-tracking'
   import { MetaEvent } from '$lib/enums/TrackingEvent'
+  import ParticipantImage from './ParticipantImage.svelte'
+  import ListTitle from '../ListTitle.svelte'
 
   interface Props {
     participant: ParticipantData
@@ -54,13 +55,17 @@
 </script>
 
 <div class="header" class:small>
-  <div class="heading" use:heading={2} id="heading">{name}</div>
+  <ParticipantImage {participant} />
 
-  {#if birth_date}
-    <p class="dates">
-      {t('Born On')} <strong>{formatDate(birth_date)}</strong>{#if death_date}, {t('Died On')} <strong>{formatDate(death_date)}</strong>{/if}
-    </p>
-  {/if}
+  <div>
+    <div class="heading" use:heading={2} id="heading">{name}</div>
+
+    {#if birth_date}
+      <p class="dates">
+        {t('Born On')} <strong>{formatDate(birth_date)}</strong>{#if death_date}, {t('Died On')} <strong>{formatDate(death_date)}</strong>{/if}
+      </p>
+    {/if}
+  </div>
 </div>
 
 <div class="content">
@@ -85,14 +90,24 @@
 
 <style lang="scss">
   .header {
-    padding: margin(4) margin(1) margin(2);
+    --participant-image-size: #{margin(6)};
+    display: grid;
+    grid-template-columns: calc(var(--participant-image-size)) auto;
+    align-items: center;
+    gap: margin(1);
+    padding: margin(3) margin(1) margin(2);
     font-family: theme(detail-font-family, font-family);
     font-weight: theme(detail-font-weight, normal);
     font-size: theme(detail-font-size, font-size-base);
     line-height: theme(participant-description-line-height, normal);
     color: theme(detail-text-color, text-color);
 
+    @include desktop {
+      --participant-image-size: #{margin(8)};
+    }
+
     &.small {
+      --participant-image-size: #{margin(6)};
       padding: margin(1);
     }
   }
@@ -101,7 +116,7 @@
     margin: 0;
     font-family: theme(detail-title-font-family, font-family);
     font-weight: theme(detail-title-font-weight, lighter);
-    font-size: theme(detail-title-font-size, margin(1.5));
+    font-size: clamp(1.25em, 5vw, 1.5em);
     line-height: normal;
     font-style: theme(detail-title-font-style, normal);
 
@@ -109,6 +124,10 @@
       margin: 0 0 margin(0.5);
       font-size: theme(detail-title-small-font-size, margin(1.25));
     }
+
+    .small & {
+      font-size: 1em;
+    }
   }
 
   .dates {

package/src/routes/components/Participants/ParticipantImage.svelte

@@ -0,0 +1,130 @@
+<script lang="ts">
+  import { t } from '$lib/localization'
+  import type { ParticipantData } from '$lib/types/participant'
+  import IconAttribution from '../Icons/IconAttribution.svelte'
+
+  interface Props {
+    participant?: ParticipantData | null
+  }
+
+  const { participant = null }: Props = $props()
+
+  const { image_metadata } = $derived(participant || { image_metadata: null })
+
+  let showAttribution = $state(false)
+
+  function toggleAttribution(event: MouseEvent): void {
+    event.stopImmediatePropagation()
+
+    if ((event.target as HTMLElement).nodeName === 'A') return
+
+    event.preventDefault()
+
+    showAttribution = !showAttribution
+  }
+</script>
+
+<div class="image">
+  {#if participant?.image}
+    <img loading="lazy" src={participant.image} alt="" />
+
+    {#if image_metadata}
+      <button class="attribution-icon" onclick={toggleAttribution}>
+        <IconAttribution />
+      </button>
+    {/if}
+  {/if}
+
+  {#if participant && image_metadata && showAttribution}
+    <!-- svelte-ignore a11y_click_events_have_key_events -->
+    <!-- svelte-ignore a11y_no_static_element_interactions -->
+    <div class="attribution-overlay" onclick={toggleAttribution}>
+      <a href={image_metadata.source_url} target="_blank" rel="external nofollow noreferrer">{image_metadata.source_text}</a>
+      {t('By')}
+      <a href={image_metadata.author_url} target="_blank" rel="external nofollow noreferrer">{image_metadata.author_text}</a>
+      /
+      <a href={image_metadata.license_url} target="_blank" rel="external nofollow noreferrer">{image_metadata.license_name}</a>
+    </div>
+  {/if}
+</div>
+
+<style lang="scss">
+  $item-width: #{var(--participant-image-size, margin(6))};
+
+  .image {
+    position: relative;
+    display: block;
+    width: $item-width;
+    height: $item-width;
+    border-radius: theme(border-radius);
+    overflow: hidden;
+    background: theme(cast-background, lighter);
+
+    &::before,
+    &::after {
+      content: '';
+      display: block;
+      position: absolute;
+      width: 50%;
+      height: 50%;
+      top: 50%;
+      left: 50%;
+      border-radius: 50%;
+      transform: translateX(-50%) translateY(-50%);
+      background: currentColor;
+      opacity: 0.1;
+    }
+
+    &::after {
+      top: 100%;
+      width: 75%;
+    }
+
+    img {
+      z-index: 1;
+      position: relative;
+      width: 100%;
+      height: auto;
+    }
+  }
+
+  .attribution-icon {
+    z-index: 2;
+    cursor: pointer;
+    position: absolute;
+    right: 0;
+    bottom: 0;
+    padding: margin(0.25);
+    margin: 0;
+    border: 0;
+    background: transparent;
+    color: rgba(255, 255, 255, 0.75);
+
+    &:hover {
+      color: white;
+    }
+
+    :global(svg) {
+      display: block;
+    }
+  }
+
+  .attribution-overlay {
+    z-index: 1;
+    position: absolute;
+    top: 0;
+    right: 0;
+    bottom: 0;
+    left: 0;
+    padding: margin(0.25);
+    background: rgba(0, 0, 0, 0.85);
+    font-size: 11px;
+    line-height: 1.25;
+    white-space: wrap;
+    text-align: left;
+
+    a {
+      color: currentColor;
+    }
+  }
+</style>

package/src/routes/components/Rails/ParticipantsRail.svelte

@@ -8,6 +8,7 @@
   import { track } from '$lib/tracking'
   import type { ParticipantData } from '$lib/types/participant'
   import type { TitleData } from '$lib/types/title'
+  import ParticipantImage from '../Participants/ParticipantImage.svelte'
   import Rail from './Rail.svelte'
 
   interface Props {
@@ -35,8 +36,6 @@
       participantsByOccurrence[participant.sid] = { participant, count }
     }
 
-    // Sort all participants by their occurrences. If a participant did not occur their positioned will be retained
-    // relative to where it was before
     const participantsSortedByCount = Object.values(participantsByOccurrence).sort((a, b) => b.count - a.count)
 
     return participantsSortedByCount.map(({ participant }) => participant)
@@ -51,7 +50,10 @@
 {#await fetchParticipantsForTitle(title)}
   <Rail {heading}>
     {#each { length: 5 }}
-      <div class="participant"></div>
+      <div class="participant">
+        <ParticipantImage />
+        <div class="name">&nbsp;</div>
+      </div>
     {/each}
   </Rail>
 {:then participants}
@@ -59,11 +61,9 @@
     <Rail {heading}>
       {#each orderParticipantsByPageTextOccurrence(participants).slice(0, 15) as participant}
         <button class="participant" data-testid="participant" onclick={event => onclick(event, participant)}>
-          <span class="truncate">{participant.name}</span>
+          <ParticipantImage {participant} />
 
-          {#if participant.character}
-            <div class="character truncate">{participant.character}</div>
-          {/if}
+          <div class="name">{participant.name}</div>
         </button>
       {/each}
     </Rail>
@@ -71,22 +71,25 @@
 {/await}
 
 <style lang="scss">
+  $item-width: #{theme(rail-size-default, margin(6))};
+
   .participant {
+    --participant-image-size: #{$item-width};
     display: flex;
     flex-direction: column;
-    flex: 0 0 10rem;
-    width: 10rem;
-    min-height: margin(3.375); // Matches 54 pixels, the height of a card with both name and character
-    padding: margin(0.5);
-    border: theme(cast-border, 0);
+    flex: 0 0 $item-width;
+    gap: margin(0.5);
+    width: $item-width;
+    padding: 0;
     border-radius: theme(cast-border-radius, border-radius);
-    background: theme(cast-background, lighter);
+    border: 0;
+    background: transparent;
     cursor: pointer;
-    font-family: inherit;
-    text-align: left;
     color: inherit;
+    font-family: inherit;
     font-size: theme(cast-font-size, font-size-small);
     line-height: normal;
+    text-align: center;
     white-space: nowrap;
 
     &:is(button):hover,
@@ -96,13 +99,10 @@
     }
   }
 
-  .character {
-    color: theme(cast-character-text-color, text-color-alt);
-    font-style: italic;
-  }
-
-  .truncate {
+  .name {
+    min-height: 1lh;
     overflow: hidden;
+    color: theme(participant-text-color, text-color-alt) !important;
     text-overflow: ellipsis;
     white-space: nowrap;
   }

package/src/routes/components/Rails/TitlesRail.svelte

@@ -5,7 +5,7 @@
   import Rail from './Rail.svelte'
   import type { TitleData } from '$lib/types/title'
   import { openModal } from '$lib/modal'
-  import { exploreTitleUrl } from '$lib/routes'
+  import { exploreModalUrl } from '$lib/routes'
   import { generateRandomHash } from '$lib/hash'
   import { getFirstTitleWithAvailableTrailer } from '$lib/trailer'
   import { useExploreRouter } from '$lib/explore'
@@ -88,7 +88,7 @@
     onclick(title)
 
     if (navigateToExplore) {
-      window.location.href = exploreTitleUrl(title)
+      window.location.href = exploreModalUrl(title.sid)
       return
     }
 

package/src/tests/lib/routes.test.js

@@ -1,7 +1,7 @@
 import { describe, it, expect } from 'vitest'
-import { exploreTitleUrl, titleUrl } from '$lib/routes'
+import { exploreModalUrl, participantUrl, titleUrl } from '$lib/routes'
 import { playPilotBaseUrl } from '$lib/constants'
-import { title } from '$lib/fakeData'
+import { participants, title } from '$lib/fakeData'
 
 describe('$lib/routes', () => {
   describe('titleUrl', () => {
@@ -14,14 +14,19 @@ describe('$lib/routes', () => {
     })
   })
 
-  describe('exploreTitleUrl', () => {
+  describe('participantUrl', () => {
+    it('Should return url for given title', () => {
+      expect(participantUrl(participants[0])).toBe(`${playPilotBaseUrl}/name/${participants[0].sid}/`)
+    })
+  })
+
+  describe('exploreModalUrl', () => {
     it('Should return url for given title', () => {
       window.PlayPilotLinkInjections.config = {
-        open_tpi_links_in_explore: true,
         explore_navigation_path: 'https://some-path.com/explore',
       }
 
-      expect(exploreTitleUrl(title)).toBe(`https://some-path.com/explore?route=modal&sid=${title.sid}`)
+      expect(exploreModalUrl(title.sid)).toBe(`https://some-path.com/explore?route=modal&sid=${title.sid}`)
     })
   })
 })

package/src/tests/routes/components/{Participant.test.js → Participants/Participant.test.js}

@@ -1,7 +1,7 @@
 import { fireEvent, render, waitFor  } from '@testing-library/svelte'
 import { describe, expect, it, vi, beforeEach } from 'vitest'
 
-import Participant from '../../../routes/components/Participant.svelte'
+import Participant from '../../../../routes/components/Participants/Participant.svelte'
 import { participants, title } from '$lib/fakeData'
 import { fetchTitlesForParticipant } from '$lib/api/participants'
 
@@ -80,4 +80,23 @@ describe('Participant.svelte', () => {
     expect(queryByText('Credits')).not.toBeTruthy()
     expect(container.querySelector('.small')).toBeTruthy()
   })
+
+  it('Should render image if given', async () => {
+    const participantWithImage = { ...participants[0], image: 'some-image.jpg' }
+
+    const { getByRole } = render(Participant, { participant: participantWithImage })
+
+    await waitFor(() => {
+      expect(getByRole('presentation')).toBeTruthy()
+    })
+  })
+
+  it('Should not render image if not given', async () => {
+
+    const { queryByRole } = render(Participant, { participant: participants[0] })
+
+    await waitFor(() => {
+      expect(queryByRole('presentation')).not.toBeTruthy()
+    })
+  })
 })

package/src/tests/routes/components/Rails/ParticipantsRail.test.js

@@ -36,6 +36,19 @@ describe('ParticipantsRail.svelte', () => {
     })
   })
 
+  it('Should render image only for participants with image', async () => {
+    const participantsWithImage = [...participants]
+    participantsWithImage[0].image = 'some-image.jpg'
+
+    vi.mocked(fetchParticipantsForTitle).mockResolvedValueOnce(participantsWithImage)
+
+    const { getAllByRole } = render(ParticipantsRail, { title })
+
+    await waitFor(() => {
+      expect(getAllByRole('presentation')).toHaveLength(1)
+    })
+  })
+
   it('Should order participants by their number of occurrences on the page', async () => {
     document.body.innerHTML = `<main>${participants[1].name}. ${participants[2].name}, ${participants[2].name}</main>`
     vi.mocked(fetchParticipantsForTitle).mockResolvedValueOnce(participants)