@playpilot/tpi 8.28.0-beta.1 → 8.28.1

package/eslint.config.js

@@ -69,7 +69,6 @@ export default [
   },
   {
     files: ['**/*.ts'],
-    ignores: ['**/*.d.ts'],
     languageOptions: {
       parser: tsParser,
     },

package/package.json

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

package/src/lib/explore.ts

@@ -44,7 +44,8 @@ export function insertExploreIntoNavigation(): boolean {
   if (!config) return false
 
   const { explore_navigation_selector: selector, explore_navigation_label: label, explore_navigation_path: path, explore_navigation_insert_position: insertPosition } = config
-  if (!selector) return false
+
+  if (!selector || !path) return false
 
   // Make sure to remove an element we created if it already exists. Should not be possible under normal circumstances.
   document.querySelector('[data-playpilot-explore-navigation-element]')?.remove()

package/src/lib/injection.ts

@@ -7,6 +7,7 @@ import { clearAfterArticlePlaylinks, insertAfterArticlePlaylinks } from './after
 import { clearInTextDisclaimer, insertInTextDisclaimer } from './disclaimer'
 import { exploreTitleUrl, titleUrl } from './routes'
 import { clearInTextWidgets, insertInTextWidgets } from './inTextWidgets'
+import { decodeHtmlEntities, encodeHtmlEntities } from './html'
 
 export const keyDataAttribute = 'data-playpilot-injection-key'
 export const keySelector = `[${keyDataAttribute}]`
@@ -84,9 +85,21 @@ export function injectLinksInDocument(elements: HTMLElement[], injections: LinkI
       // We insert the html here separately from below, where it's done with replacementIndex because we need to capture all html
       // that may have been inside of the match.
       if (replacementIndex === -1) {
-        const match = findShortestMatchBetweenPhrases(element.innerHTML, injection.title, phrase_before || '', phrase_after || '')
+        let match = findShortestMatchBetweenPhrases(element.innerHTML, injection.title, phrase_before || '', phrase_after || '')
 
         if (match) {
+          // This is a crude way of checking if a match contains HTML elements
+          // If the title is directly inside of an element we discard the rest.
+          // This happens sometimes in lists that consists of nothing but titles and may contain special characters
+          if (match.match.includes(">") && match.match.includes("<")) {
+            const encodedTitle = encodeHtmlEntities(injection.title)
+            const matchInsideHTMLIndex = match.match.search(new RegExp(`>\s*${encodedTitle}\s*<`)) + 1
+
+            if (matchInsideHTMLIndex > 0) {
+              match = { match: match.match.slice(matchInsideHTMLIndex, matchInsideHTMLIndex + encodedTitle.length), index: matchInsideHTMLIndex }
+            }
+          }
+
           const { leadingSpaces, trailingSpaces } = getNumberOfLeadingAndTrailingSpaces(match.match)
 
           linkElement.innerHTML = match.match.trim()

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

@@ -1,3 +1,5 @@
+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.

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

@@ -4,3 +4,5 @@ export type Position = {
 }
 
 export type Alignment = 'bottom' | 'center'
+
+export type InsertPosition = 'beforebegin' | 'afterbegin' | 'beforeend' | 'afterend' | ''

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

@@ -1,6 +1,8 @@
 import type { Campaign } from './campaign'
+import type { ConfigResponse } from './config'
 import type { ConsentOptions } from './consent'
 import type { LinkInjection, LinkInjectionResponse } from './injection'
+import type { InsertPosition } from './position'
 import type { TitleData } from './title'
 
 export type ScriptConfig = {
@@ -17,7 +19,7 @@ export type ScriptConfig = {
   // Selector for the after article playlinks. Will be placed _after_ the given selector.
   after_article_selector?: string
   // Selector to change the insert position of the after article playlinks. Should only be used if no viable selector can be given with `after_article_selector`.
-  after_article_insert_position?: InsertPosition | ''
+  after_article_insert_position?: InsertPosition
   // The language of the page will be inferred from the html `lang` attribute. Can be set manually using this option in the config object.
   language?: string | null
   // Set to the last success external-pages fetch.
@@ -25,7 +27,7 @@ export type ScriptConfig = {
   // Lists all tracked events through the `track()` function.
   tracked_events?: { event: string, payload: Record<string, any> }[]
   // Queued tracking events that were fired before consent was given. These might be fired later if the user consents.
-  queued_tracking_events?: { event: string, title: TitleData | null, payload: Record<strong, any> }[]
+  queued_tracking_events?: { event: string, title: TitleData | null, payload: Record<string, any> }[]
   // Lists all split test identifiers as created by each running split test. Identifiers are only created when a split test is fired.
   split_test_identifiers?: Record<string, number>
   // All link injections as returned from external-pages, with AI and manual injections merged.

package/src/routes/components/Debugger.svelte

@@ -181,7 +181,7 @@
     {#if !useExploreRouter()}
       <button onclick={(() => {
         destroyExplore()
-        window.PlayPilotLinkInjections.config.explore_use_router = !useExploreRouter()
+        window.PlayPilotLinkInjections.config!.explore_use_router = !useExploreRouter()
         insertExplore()
       })}>Toggle new explore</button>
     {/if}

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

@@ -2,9 +2,11 @@
   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 { getSplitTestVariantName, trackSplitTestView } from '$lib/splitTest'
   import type { TitleData } from '$lib/types/title'
+  import Modal from '../../Modals/Modal.svelte'
 
   interface Props {
     navigate?: (key: string, pushState?: boolean) => void
@@ -12,8 +14,6 @@
 
   const { navigate = () => null }: Props = $props()
 
-  openModalViaRoute()
-
   async function openModalViaRoute(): Promise<void> {
     const currentUrl = new URL(document.location.toString())
     const sid = currentUrl.searchParams.get('sid')
@@ -26,22 +26,73 @@
 
     if (isMobile) trackSplitTestView(SplitTest.Reels)
 
-    try {
-      const [title, railTitles] = (await Promise.allSettled([
-        fetchTitleBySid(sid),
-        fetchSimilarTitles({ sid } as unknown as TitleData)])
-      ).map(promise => (promise.status === 'fulfilled' ? promise.value : null))
-
-      openModal({
-        type,
-        data: [(title as TitleData), ...(railTitles as TitleData[])],
-        props: {
-          onclose: () => navigate('home'),
-          pushState: false,
-        },
-      })
-    } catch {
-      navigate('home')
-    }
+    const [title, railTitles] = (await Promise.allSettled([
+      fetchTitleBySid(sid),
+      fetchSimilarTitles({ sid } as unknown as TitleData)])
+    ).map(promise => (promise.status === 'fulfilled' ? promise.value : null))
+
+    openModal({
+      type,
+      data: [(title as TitleData), ...(railTitles as TitleData[])],
+      props: {
+        onclose: () => navigate('home'),
+        pushState: false,
+      },
+    })
   }
 </script>
+
+{#await openModalViaRoute()}
+  <Modal blur pushState={false}>
+    {#snippet dialog()}
+      <div class="loading">
+        <div class="bar"></div>
+        <div class="bar"></div>
+        <div class="bar"></div>
+      </div>
+    {/snippet}
+  </Modal>
+{:catch}
+  <Modal blur onclose={() => navigate('home')} pushState={false}>
+    <div class="error">
+      {t('An Error Occurred')}
+    </div>
+  </Modal>
+{/await}
+
+<style lang="scss">
+  .loading {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    height: 100%;
+    gap: margin(0.5);
+  }
+
+  @keyframes animate-bar {
+    to {
+      height: margin(3);
+      opacity: 0.5;
+    }
+  }
+
+  .bar {
+    height: margin(4);
+    width: margin(1);
+    border-radius: margin(0.25);
+    background: white;
+    animation: animate-bar 750ms infinite;
+
+    @for $i from 0 through 2 {
+      &:nth-child(#{$i}) {
+        animation-delay: $i * 250ms;
+      }
+    }
+  }
+
+  .error {
+    padding: margin(2);
+    font-size: 1.25em;
+    color: theme(text-color);
+  }
+</style>

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

@@ -59,6 +59,7 @@
 
   onMount(() => {
     const scrollElement = getScrollRoot()
+
     scrollElement.classList.add('playpilot-modal-open')
 
     hasPreviousModal = !!getPreviousModal()
@@ -70,7 +71,7 @@
     requestAnimationFrame(setInitialScrollPosition)
 
     return () => {
-      scrollElement.classList.remove('playpilot-modal-open')
+      if (!document.querySelector('.modal')) scrollElement.classList.remove('playpilot-modal-open')
 
       // Remove the modal entry from above from the browser history. This is done only once for the entire stack.
       // We check for getPreviousModal not because we really care about the previous modal, but to check if all

package/src/routes/explore/+page.svelte

@@ -35,7 +35,7 @@
 
 <button onclick={(() => {
   destroyExplore()
-  window.PlayPilotLinkInjections.config.explore_use_router = !useExploreRouter()
+  window.PlayPilotLinkInjections.config!.explore_use_router = !useExploreRouter()
   insertExplore()
 })}>Toggle new explore</button>
 
@@ -73,4 +73,3 @@
     background: theme(light);
   }
 </style>
-

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

@@ -120,7 +120,7 @@ describe('explore.js', () => {
 
     it('Should not insert if config object is present but explore_navigation_selector is not given', () => {
       window.PlayPilotLinkInjections.config = {
-        explore_navigation_selector: null,
+        explore_navigation_selector: '',
       }
 
       expect(insertExploreIntoNavigation()).toBe(false)
@@ -136,11 +136,12 @@ describe('explore.js', () => {
       expect(insertExploreIntoNavigation()).toBe(false)
     })
 
-    it('Should insert if explore_navigation_selector is given and selector is valid', () => {
+    it('Should insert if explore_navigation_selector is given and selector and path are valid', () => {
       document.body.innerHTML = '<nav><a></a></nav>'
 
       window.PlayPilotLinkInjections.config = {
         explore_navigation_selector: 'a',
+        explore_navigation_path: '/explore',
       }
 
       expect(insertExploreIntoNavigation()).toBe(true)
@@ -165,6 +166,7 @@ describe('explore.js', () => {
       window.PlayPilotLinkInjections.config = {
         explore_navigation_selector: 'a',
         explore_navigation_label: 'Some label',
+        explore_navigation_path: '/explore',
       }
 
       insertExploreIntoNavigation()

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

@@ -867,6 +867,26 @@ describe('injection.ts', () => {
       expect(document.querySelectorAll('a')).toHaveLength(4)
     })
 
+    it('Should properly inject into lists of titles that contain special characters', () => {
+      document.body.innerHTML = `<section>
+          <ul>
+            <li>Daisy Jones & The Six</li>
+            <li>Love & Death</li>
+          </ul>
+        </section>
+      `
+
+      const elements = getLinkInjectionElements(/** @type {HTMLElement} */ (document.querySelector('section')))
+      const injections = [
+        generateInjection('Daisy Jones & The Six', 'Daisy Jones & The Six'),
+        generateInjection('Love & Death', 'Love & Death'),
+      ]
+
+      injectLinksInDocument(elements, { aiInjections: [], manualInjections: injections })
+
+      expect(document.querySelectorAll('a')).toHaveLength(2)
+    })
+
     it('Should properly inject into titles that are split up by multiple elements when phrase_before and phrase_after are given', () => {
       document.body.innerHTML = '<section>Some text with a <strong>phra</strong><strong>se</strong> in it</section>'
 
@@ -984,7 +1004,7 @@ describe('injection.ts', () => {
         injectLinksInDocument(elements, { aiInjections: [injection], manualInjections: [] })
 
         const link = /** @type {HTMLAnchorElement} */ (document.querySelector('a'))
-        expect(link.href).toBe(window.PlayPilotLinkInjections.config.explore_navigation_path + `?route=modal&sid=${injection.title_details?.sid}`)
+        expect(link.href).toBe(window.PlayPilotLinkInjections.config?.explore_navigation_path + `?route=modal&sid=${injection.title_details?.sid}`)
         expect(link.target).not.toBeTruthy()
       })
 

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

@@ -26,6 +26,7 @@ describe('retargeting.ts', () => {
   describe('isPixelAllow', () => {
     it('Should return false if no config object is set', () => {
       vi.mocked(hasConsentedTo).mockImplementation(() => true)
+      // @ts-ignore
       window.PlayPilotLinkInjections.config = null
 
       expect(isRetargetingAllowed()).toBe(false)
@@ -33,6 +34,7 @@ describe('retargeting.ts', () => {
 
     it('Should return false if config object is without allow_retargeting_pixels', () => {
       vi.mocked(hasConsentedTo).mockImplementation(() => true)
+      // @ts-ignore
       window.PlayPilotLinkInjections.config = { something: true }
 
       expect(isRetargetingAllowed()).toBe(false)

package/src/tests/routes/components/Playlinks/Playlink.test.js

@@ -118,6 +118,7 @@ describe('Playlink.svelte', () => {
   })
 
   it('Should render as link when user has not consented to affiliate but require_affiliate_consent is false', () => {
+    // @ts-ignore
     window.PlayPilotLinkInjections.config.require_affiliate_consent = false
 
     vi.mocked(hasConsentedTo).mockImplementation(() => false)
@@ -129,6 +130,7 @@ describe('Playlink.svelte', () => {
   })
 
   it('Should render as link when user has not consented to affiliate and require_affiliate_consent is true', () => {
+    // @ts-ignore
     window.PlayPilotLinkInjections.config.require_affiliate_consent = true
 
     vi.mocked(hasConsentedTo).mockImplementation(() => false)