@playpilot/tpi 8.39.0 → 8.40.0-beta.1

package/package.json

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

package/src/lib/injection.ts

@@ -32,6 +32,7 @@ export function injectLinksInDocument(elements: HTMLElement[], injections: LinkI
   const foundInjections = validInjections.filter(i => fullText.includes(cleanPhrase(i.sentence)))
 
   const failedMessages: Record<string, string> = {}
+  const aiInjectionSidsCount: Record<string, number> = {}
 
   let injectionIndex = -1 // This index is used in Option 3 below.
   for (const injection of sortInjections(foundInjections)) {
@@ -40,9 +41,20 @@ export function injectLinksInDocument(elements: HTMLElement[], injections: LinkI
     // TODO: REMOVE ME. This is a temporary hack. Popularity should be on participant_details but currently it is only on the injection.
     if (injection.type === 'participant') injection.participant_details!.popularity ||= injection.popularity
 
-    if (injection.type === 'participant' && !injection.manual && !doesParticipantMeetThreshold(mergedInjections, injection.participant_details!)) {
-      failedMessages[injection.key] = 'Participant does not meet popularity threshold.'
-      continue
+    if (!injection.manual) {
+      const previousCount = aiInjectionSidsCount[injection.sid] || 0
+
+      if (previousCount >= (window.PlayPilotLinkInjections?.config?.unique_injection_count_limit || 10)) {
+        failedMessages[injection.key] = 'Injection was withheld because it exceeded the maximum unique count.'
+        continue
+      } else {
+        aiInjectionSidsCount[injection.sid] = previousCount + 1
+      }
+
+      if (injection.type === 'participant' && !doesParticipantMeetThreshold(mergedInjections, injection.participant_details!)) {
+        failedMessages[injection.key] = 'Participant does not meet popularity threshold.'
+        continue
+      }
     }
 
     const elementIndex = elements.findIndex(element => cleanPhrase(element.innerText).includes(cleanPhrase(injection.sentence)))
@@ -52,7 +64,6 @@ export function injectLinksInDocument(elements: HTMLElement[], injections: LinkI
 
     const nodeContainingText = findTextNodeContaining(injection.title, element, ['A'])
 
-    // Ignore if the found injection has no node or if it is inside a link.
     if (!nodeContainingText?.nodeValue || isNodeInLink(nodeContainingText)) {
       // We check once more where the text was found, this time without ignoring links
       // so we can determine if the failure was due to it being in a link
@@ -222,6 +233,7 @@ function createLinkInjectionElement(injection: LinkInjection): { injectionElemen
   // so that it is not directly inside of the link.
   const injectionElement = document.createElement('span')
   injectionElement.dataset.playpilotInjectionKey = injection.key
+  injectionElement.dataset.playpilotInjectionType = injection.type
 
   const openInExplore = !!window.PlayPilotLinkInjections?.config?.open_tpi_links_in_explore
 
@@ -491,10 +503,11 @@ export function doesParticipantMeetThreshold(injections: LinkInjection[], partic
   if (participant.popularity === null || participant.popularity === undefined) return true
 
   const useArticleAverage = window.PlayPilotLinkInjections?.config?.participant_injection_popularity_threshold_use_article_average ?? true
-  const defaultThreshold = useArticleAverage ? 25 : 1000
+  const defaultThreshold = 0
   const configThreshold = window.PlayPilotLinkInjections?.config?.participant_injection_popularity_threshold
   const threshold = configThreshold ?? defaultThreshold
 
+  if (threshold === 0) return true
   if (!useArticleAverage) return participant.popularity >= threshold
 
   const averagePopularity = injections

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

@@ -115,6 +115,11 @@ export type ConfigResponse = {
    */
   participant_injection_popularity_threshold_use_article_average?: boolean
 
+  /**
+   * Include a limit of how many times a single titles/participants may appear in one article.
+   */
+  unique_injection_count_limit?: number
+
   /**
    * 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_.

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

@@ -1038,6 +1038,22 @@ describe('injection.ts', () => {
 
         expect(document.querySelectorAll('[data-playpilot-injection-key]')).toHaveLength(2)
       })
+
+      it('Should include injection type on element', () => {
+        document.body.innerHTML = '<p>This is a sentence with an injection.</p>'
+
+        const elements = Array.from(document.body.querySelectorAll('p'))
+        const injections = [
+          { ...generateInjection('This is a sentence with an injection.', 'a sentence'), type: 'participant', participant_details: participants[0] },
+          { ...generateInjection('This is a sentence with an injection.', 'an injection'), type: 'title' },
+        ]
+
+        // @ts-ignore
+        injectLinksInDocument(elements, { aiInjections: injections, manualInjections: [] })
+
+        expect(/** @type {HTMLElement} */ (document.querySelectorAll('[data-playpilot-injection-key]')[0]).dataset.playpilotInjectionType).toBe('participant')
+        expect(/** @type {HTMLElement} */ (document.querySelectorAll('[data-playpilot-injection-key]')[1]).dataset.playpilotInjectionType).toBe('title')
+      })
     })
 
     describe('config.open_tpi_links_in_explore', () => {
@@ -1076,6 +1092,46 @@ describe('injection.ts', () => {
         expect(openModalForInjectedLink).not.toHaveBeenCalled()
       })
     })
+
+    describe('config.unique_injection_count_limit', () => {
+      it('Should not insert another link if the count for links of the same sid is met', () => {
+        window.PlayPilotLinkInjections.config = {
+          unique_injection_count_limit: 2,
+        }
+
+        document.body.innerHTML = '<p>This is a sentence with an injection.</p>'
+
+        const elements = Array.from(document.body.querySelectorAll('p'))
+        const injections = [
+          { ...generateInjection('This is a sentence with an injection.', 'This is'), sid: 'a' },
+          { ...generateInjection('This is a sentence with an injection.', 'a sentence'), sid: 'a' },
+          { ...generateInjection('This is a sentence with an injection.', 'an injection'), sid: 'a' },
+        ]
+
+        injectLinksInDocument(elements, { aiInjections: injections, manualInjections: [] })
+
+        expect(document.querySelectorAll('[data-playpilot-injection-key]')).toHaveLength(2)
+      })
+
+      it('Should disregard limit for manual injections', () => {
+        window.PlayPilotLinkInjections.config = {
+          unique_injection_count_limit: 2,
+        }
+
+        document.body.innerHTML = '<p>This is a sentence with an injection.</p>'
+
+        const elements = Array.from(document.body.querySelectorAll('p'))
+        const aiInjections = [
+          { ...generateInjection('This is a sentence with an injection.', 'This is'), sid: 'a' },
+          { ...generateInjection('This is a sentence with an injection.', 'a sentence'), sid: 'a' },
+        ]
+        const manualInjections = [{ ...generateInjection('This is a sentence with an injection.', 'an injection'), sid: 'a' }]
+
+        injectLinksInDocument(elements, { aiInjections, manualInjections })
+
+        expect(document.querySelectorAll('[data-playpilot-injection-key]')).toHaveLength(3)
+      })
+    })
   })
 
   describe('clearLinkInjections', () => {
@@ -1368,7 +1424,7 @@ describe('injection.ts', () => {
       expect(doesParticipantMeetThreshold(injections, falseyParticipant)).toBe(false)
     })
 
-    it('Should return true if threshold is 100, regardless of popularity', () => {
+    it('Should return true if threshold is 0, regardless of popularity', () => {
       window.PlayPilotLinkInjections.config = {
         participant_injection_popularity_threshold: 0,
       }
@@ -1384,5 +1440,18 @@ describe('injection.ts', () => {
       expect(doesParticipantMeetThreshold(injections, truthyParticipant)).toBe(true)
       expect(doesParticipantMeetThreshold(injections, truthyParticipant2)).toBe(true)
     })
+
+    it('Should use threshold of 0 by default', () => {
+      const truthyParticipant = { ...participants[0], popularity: 0 }
+      const truthyParticipant2 = { ...participants[0], popularity: 1 }
+
+      /** @type {import('$lib/types/injection').LinkInjection[]} */
+      const injections = [
+        { ...generateInjection('This is a sentence with an injection.', 'an injection'), type: 'participant', participant_details: truthyParticipant },
+      ]
+
+      expect(doesParticipantMeetThreshold(injections, truthyParticipant)).toBe(true)
+      expect(doesParticipantMeetThreshold(injections, truthyParticipant2)).toBe(true)
+    })
   })
 })