@playpilot/tpi 8.28.0 → 8.29.0-beta.1

package/package.json

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

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

@@ -1,122 +1,122 @@
-import type { InsertPosition } from './position'
-
-export type ConfigResponse = {
-  /**
-   * Used to exclude URL matching a regex pattern. If a url matches, nothing is executed beyond fetching the config.
-   * The url should never be indexed.
-   */
-  exclude_urls_pattern?: string
-
-  /**
-   * Used to inject custom styling for the links, modal, and popover. All styling is done via CSS variables. The passed
-   * string should not contain a selector.
-   * For example:
-   * `--some-variable: some-value;`
-   *
-   * rather than:
-   * `body { --some-variable: some-value; }`
-   */
-  custom_style?: string
-
-  /**
-   * The primary selector for the entire article from which text will be selected. Should contain as little content as
-   * possible. Should match all pages. May contain multiple selectors like `.article, .listicle`.
-   */
-  html_selector?: string
-
-  /**
-   * Some pages contain elements that can't easily be excluded via the `html_selector`. These elements can instead be
-   * excluded via this property. May contain multiple selectors like `.footer, .ad`.
-   */
-  exclude_elements_selector?: string
-
-  /**
-   * Disable all injections from showing on pages without editorial mode enabled
-   */
-  disable_public_injections?: boolean
-
-  /**
-   * Region to fall back on if other methods of getting the region fail. This should be equal to the region most relevant
-   * to the partner. Should be lowercase.
-   */
-  fallback_region?: string
-
-  /**
-   * Disclaimer text that is shown above playlinks in title cards used to replace the default text
-   */
-  playlinks_disclaimer_text?: string
-
-  /**
-   * Some partners may want to display titles without affiliate links, which currently comes down to no playlinks.
-   * This can also be set via the config on the script itself.
-   */
-  no_affiliate?: boolean
-
-  /**
-   * Whether or not we can insert retargeting pixels. Not all third parties allow this and it is disabled by default
-   */
-  allow_retargeting_pixels?: boolean
-
-  /**
-   * By default affiliate links (playlinks) will render as links even without consent, as a disclaimer is given. Set to true to require explicit consent, rendering as static text without consent.
-   */
-  require_affiliate_consent?: boolean
-
-  /**
-   * Scroll reveal posters that show on mobile are enabled by default. Use this option to disable them.
-   */
-  disable_scroll_reveal_posters?: boolean
-
-  /**
-   * Playlinks are merged by default, when this option is enabled playlinks will instead be shown categorized.
-   */
-  categorize_playlinks?: boolean
-
-  /**
-   * By default no user identifiable data is tracked. This can be changed using this option. User ids are stored in localStorage and sent along with any tracking request.
-   */
-  allow_user_id_tracking?: boolean
-
-  /**
-   * The sid for the current domain, used for tracking
-   */
-  domain_sid?: string
-
-  /**
-   * The sid for the organization the domain belongs to, used for tracking. Can be empty.
-   */
-  organization_sid?: string
-
-  /**
-   * The following options are all relevant for in text disclaimers, which renders as a disclaimer text within the article,
-   * rather than only inside of title cards.
-   * Change the text content using `in_text_disclaimer_text`.
-   * Change where the element is inserted using `in_text_disclaimer_selector`, by default it will insert before the first text element.
-   * Change the insert position using `in_text_disclaimer_insert_position`, by default it will insert before the given selector.
-   */
-  in_text_disclaimer_enabled?: boolean
-  in_text_disclaimer_text?: string
-  in_text_disclaimer_selector?: string
-  in_text_disclaimer_insert_position?: InsertPosition
-
-  /**
-   * Open TPI links in explore rather than in modals in the article
-   */
-  open_tpi_links_in_explore?: boolean
-
-  /**
-   * These options are all relevant for the Explore component, which can be inserted as a widget on any page or as a modal.
-   * `explore_navigation_selector` is used to select the navigation element that should be copied and inserted _after_.
-   * `explore_navigation_label` will end up being the label of the navigation item, defaults to `Streaming Guide`.
-   * `explore_navigation_path` is the path that the navigation item will lead to, this will be set up by the third party.
-   * `explore_navigation_insert_position` is used to determine if the navigation item should be inserted before or after the given selector.
-   * `explore_insert_cta_in_tpi` is used to insert a call to action in modals which opens the explore page as a modal.
-   */
-  explore_navigation_selector?: string
-  explore_navigation_label?: string
-  explore_navigation_path?: string
-  explore_navigation_insert_position?: InsertPosition
-  explore_insert_cta_in_tpi?: boolean
-  explore_custom_style?: string
-  explore_use_router?: boolean
-}
+import type { InsertPosition } from './position'
+
+export type ConfigResponse = {
+  /**
+   * Used to exclude URL matching a regex pattern. If a url matches, nothing is executed beyond fetching the config.
+   * The url should never be indexed.
+   */
+  exclude_urls_pattern?: string
+
+  /**
+   * Used to inject custom styling for the links, modal, and popover. All styling is done via CSS variables. The passed
+   * string should not contain a selector.
+   * For example:
+   * `--some-variable: some-value;`
+   *
+   * rather than:
+   * `body { --some-variable: some-value; }`
+   */
+  custom_style?: string
+
+  /**
+   * The primary selector for the entire article from which text will be selected. Should contain as little content as
+   * possible. Should match all pages. May contain multiple selectors like `.article, .listicle`.
+   */
+  html_selector?: string
+
+  /**
+   * Some pages contain elements that can't easily be excluded via the `html_selector`. These elements can instead be
+   * excluded via this property. May contain multiple selectors like `.footer, .ad`.
+   */
+  exclude_elements_selector?: string
+
+  /**
+   * Disable all injections from showing on pages without editorial mode enabled
+   */
+  disable_public_injections?: boolean
+
+  /**
+   * Region to fall back on if other methods of getting the region fail. This should be equal to the region most relevant
+   * to the partner. Should be lowercase.
+   */
+  fallback_region?: string
+
+  /**
+   * Disclaimer text that is shown above playlinks in title cards used to replace the default text
+   */
+  playlinks_disclaimer_text?: string
+
+  /**
+   * Some partners may want to display titles without affiliate links, which currently comes down to no playlinks.
+   * This can also be set via the config on the script itself.
+   */
+  no_affiliate?: boolean
+
+  /**
+   * Whether or not we can insert retargeting pixels. Not all third parties allow this and it is disabled by default
+   */
+  allow_retargeting_pixels?: boolean
+
+  /**
+   * By default affiliate links (playlinks) will render as links even without consent, as a disclaimer is given. Set to true to require explicit consent, rendering as static text without consent.
+   */
+  require_affiliate_consent?: boolean
+
+  /**
+   * Scroll reveal posters that show on mobile are enabled by default. Use this option to disable them.
+   */
+  disable_scroll_reveal_posters?: boolean
+
+  /**
+   * Playlinks are merged by default, when this option is enabled playlinks will instead be shown categorized.
+   */
+  categorize_playlinks?: boolean
+
+  /**
+   * By default no user identifiable data is tracked. This can be changed using this option. User ids are stored in localStorage and sent along with any tracking request.
+   */
+  allow_user_id_tracking?: boolean
+
+  /**
+   * The sid for the current domain, used for tracking
+   */
+  domain_sid?: string
+
+  /**
+   * The sid for the organization the domain belongs to, used for tracking. Can be empty.
+   */
+  organization_sid?: string
+
+  /**
+   * The following options are all relevant for in text disclaimers, which renders as a disclaimer text within the article,
+   * rather than only inside of title cards.
+   * Change the text content using `in_text_disclaimer_text`.
+   * Change where the element is inserted using `in_text_disclaimer_selector`, by default it will insert before the first text element.
+   * Change the insert position using `in_text_disclaimer_insert_position`, by default it will insert before the given selector.
+   */
+  in_text_disclaimer_enabled?: boolean
+  in_text_disclaimer_text?: string
+  in_text_disclaimer_selector?: string
+  in_text_disclaimer_insert_position?: InsertPosition
+
+  /**
+   * Open TPI links in explore rather than in modals in the article
+   */
+  open_tpi_links_in_explore?: boolean
+
+  /**
+   * These options are all relevant for the Explore component, which can be inserted as a widget on any page or as a modal.
+   * `explore_navigation_selector` is used to select the navigation element that should be copied and inserted _after_.
+   * `explore_navigation_label` will end up being the label of the navigation item, defaults to `Streaming Guide`.
+   * `explore_navigation_path` is the path that the navigation item will lead to, this will be set up by the third party.
+   * `explore_navigation_insert_position` is used to determine if the navigation item should be inserted before or after the given selector.
+   * `explore_insert_cta_in_tpi` is used to insert a call to action in modals which opens the explore page as a modal.
+   */
+  explore_navigation_selector?: string
+  explore_navigation_label?: string
+  explore_navigation_path?: string
+  explore_navigation_insert_position?: InsertPosition
+  explore_insert_cta_in_tpi?: boolean
+  explore_custom_style?: string
+  explore_use_router?: boolean
+}

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/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'

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,13 +90,22 @@
 
 <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 {
       padding: margin(1);
     }
@@ -101,7 +115,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 +123,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/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)