@playpilot/tpi 8.41.0 → 8.42.0

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

@@ -1,147 +1,158 @@
-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
-
-  /**
-   * Similar to `exclude_urls_pattern` but limited to participant injections. Other injections will continue to function.
-   */
-  exclude_participants_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
-
-  /**
-   * Participants with a popularity score lower than this threshold will not be injected
-   */
-  participant_injection_popularity_threshold?: number
-
-  /**
-   * Whether or not to base the threshold on the article participants average popularity score.
-   * When enabled, this turns `participant_injection_popularity_threshold` into a percentage.
-   */
-  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
-
-  /**
-   * No more than this count of participant links will show on the entire article.
-   */
-  total_participant_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_.
-   * `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
-}
+import type { LinkInjection } from './injection'
+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
+
+  /**
+   * Similar to `exclude_urls_pattern` but limited to participant injections. Other injections will continue to function.
+   */
+  exclude_participants_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
+
+  /**
+   * Participants with a popularity score lower than this threshold will not be injected
+   */
+  participant_injection_popularity_threshold?: number
+
+  /**
+   * Whether or not to base the threshold on the article participants average popularity score.
+   * When enabled, this turns `participant_injection_popularity_threshold` into a percentage.
+   */
+  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
+
+  /**
+   * No more than this count of participant links will show on the entire article.
+   */
+  total_participant_injection_count_limit?: number
+
+  /**
+   * Exclude any injections that use one of the given anchors
+   */
+  exclude_injections_by_anchors?: LinkInjection['anchor'][]
+
+  /**
+   * Exclude any injections that use one of the given evidence
+   */
+  exclude_injections_by_evidence?: LinkInjection['evidence'][]
+
+  /**
+   * 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
+}

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

@@ -1,59 +1,65 @@
-import type { ParticipantData } from './participant'
-import type { TitleData } from './title'
-
-export type LinkInjectionDataType = 'title' | 'participant'
-
-export type LinkInjection = {
-  sid: string
-  title: string
-  sentence: string
-  playpilot_url: string
-  key: string
-  title_details?: TitleData
-  participant_details?: ParticipantData
-  phrase_before?: string | null
-  phrase_after?: string | null
-  inactive?: boolean
-  failed?: boolean
-  failed_message?: string
-  in_text?: boolean
-  after_article?: boolean
-  after_article_style?: 'modal_button' | 'playlinks' | null
-  manual?: boolean
-  removed?: boolean
-  duplicate?: boolean
-  matchingElement?: null | Element
-  popularity?: number | null
-  type: LinkInjectionDataType
-}
-
-export type LinkInjectionRanges = Record<string, { elementIndex: number, from: number, to: number }>
-
-export type LinkInjectionResponse = {
-  injections_ready: boolean
-  ai_enabled: boolean
-  injections_enabled: boolean
-  ai_running: boolean
-  ai_injections: LinkInjection[] | null
-  ai_progress_message: string
-  ai_progress_percentage: number
-  ai_last_run: string | null
-  manual_injections: LinkInjection[] | null
-  organization_sid?: string
-  domain_sid?: string
-  session_id?: string | null
-  session_last_ping?: string | null
-  content_modified_time?: string | null
-  pixels?: string[]
-}
-
-export type LinkInjectionTypes = {
-  aiInjections: LinkInjection[]
-  manualInjections: LinkInjection[]
-}
-
-export type ArticleMetaData = {
-  content_heading: string | null
-  content_modified_time: string | null
-  content_published_time: string | null
-}
+import type { ParticipantData } from './participant'
+import type { TitleData } from './title'
+
+export type LinkInjectionDataType = 'title' | 'participant'
+
+export type LinkInjection = {
+  sid: string
+  title: string
+  sentence: string
+  playpilot_url: string
+  key: string
+  title_details?: TitleData
+  participant_details?: ParticipantData
+  phrase_before?: string | null
+  phrase_after?: string | null
+  inactive?: boolean
+  failed?: boolean
+  failed_message?: string
+  in_text?: boolean
+  after_article?: boolean
+  after_article_style?: 'modal_button' | 'playlinks' | null
+  manual?: boolean
+  removed?: boolean
+  duplicate?: boolean
+  matchingElement?: null | Element
+  popularity?: number | null
+  anchor?: 'full' | 'attached' | 'bare' | null
+  evidence?: 'credited' | 'screen_work' | 'title_mention' | 'name_only' | null
+  type: LinkInjectionDataType
+}
+
+export type LinkInjectionRanges = Record<string, {
+  elementIndex: number
+  from: number
+  to: number
+}>
+
+export type LinkInjectionResponse = {
+  injections_ready: boolean
+  ai_enabled: boolean
+  injections_enabled: boolean
+  ai_running: boolean
+  ai_injections: LinkInjection[] | null
+  ai_progress_message: string
+  ai_progress_percentage: number
+  ai_last_run: string | null
+  manual_injections: LinkInjection[] | null
+  organization_sid?: string
+  domain_sid?: string
+  session_id?: string | null
+  session_last_ping?: string | null
+  content_modified_time?: string | null
+  pixels?: string[]
+}
+
+export type LinkInjectionTypes = {
+  aiInjections: LinkInjection[]
+  manualInjections: LinkInjection[]
+}
+
+export type ArticleMetaData = {
+  content_heading: string | null
+  content_modified_time: string | null
+  content_published_time: string | null
+}