@streamlayer/feature-advertisement 1.0.0 → 1.1.0

package/lib/index.d.ts

@@ -6,7 +6,8 @@ declare module '@streamlayer/sdk-web-interfaces' {
 }
 export { type ExternalAdStore, type ExternalPauseAdStore, type SsaiMonitorOptions } from './advertisement';
 export { type GAMStaticCore, type PauseAdTemplate, isFullbleedVideoTemplate } from './units/external-pause-ad';
-export { type PauseAdCard, type PauseAdStore } from './units/pause-ad';
+export { INSIGHT_BODY_MAX_LENGTH, type PauseAdCard, type PauseAdKind, type PauseAdMediaMode, } from './units/pause-ad-card';
+export { type PauseAdStore } from './units/pause-ad';
 export { type AdStore, type AdData, type AdCompanion, type AdNonLinear } from './units/external-ad';
 export { gam, type GamNonceResult, type PalNonceManager } from './units/gam';
 export { createCompanionTracker, createVastTracker, resolveVastTrackerTarget, type VastTrackerTarget, } from './units/vast-tracker';

package/lib/index.js

@@ -1,5 +1,11 @@
 import { Advertisement } from './advertisement';
 export { isFullbleedVideoTemplate } from './units/external-pause-ad';
+// Card shapes come straight from the pure module rather than through `units/pause-ad`. NOT a bundle
+// guarantee for barrel consumers — this file value-imports `Advertisement` on line 3, which imports
+// the store module anyway, and the package declares no `sideEffects: false`. What it does buy: the
+// unit spec and any deep importer get the card shapes without the store, and dropping the
+// `export *` keeps `units/pause-ad` from silently re-exporting `parsePauseAdCards`.
+export { INSIGHT_BODY_MAX_LENGTH, } from './units/pause-ad-card';
 export { gam } from './units/gam';
 export { createCompanionTracker, createVastTracker, resolveVastTrackerTarget, } from './units/vast-tracker';
 export { DEFAULT_CREATIVE_API_BASE, } from './units/ssai-creative';

package/lib/units/pause-ad-card.d.ts

@@ -0,0 +1,49 @@
+import { type Question } from '@streamlayer/sl-eslib/interactive/interactive.common_pb';
+export type PauseAdLayout = 'left' | 'center' | 'image';
+/**
+ * Which full-bleed renderer draws the card. Absent === `'standard'`.
+ *
+ * - `'standard'` — the Standard/Image pause ad (promotion card).
+ * - `'insight'` — the Insight Pause Ad (factoid card): sponsor logo, heading and a
+ *   single-column body beside an optional media image (SC-353).
+ */
+export type PauseAdKind = 'standard' | 'insight';
+/** How the Insight media image is cropped — mirrors Studio's Media switcher. */
+export type PauseAdMediaMode = 'image' | 'circle' | 'none';
+/**
+ * Insight body cap (SC-353). Studio enforces it on the Additional Content field; the
+ * SDK clamps as well so a card authored before the limit landed cannot overflow the
+ * screen — the format is explicitly designed to fit without scrolling.
+ */
+export declare const INSIGHT_BODY_MAX_LENGTH = 600;
+export type PauseAdCard = {
+    id: string;
+    parentId: string;
+    /** Optional: a video-only card (programmatic VAST, SC-322) has no image. */
+    backgroundImageSrc?: string;
+    /** Linear MP4 from VAST → renders full-bleed `<video>` instead of the image (SC-322). */
+    backgroundVideoSrc?: string;
+    layout: PauseAdLayout;
+    isInteractive: boolean;
+    logoSrc?: string;
+    title?: string;
+    description?: string;
+    ctaLabel?: string;
+    ctaUrl?: string;
+    qrCodeUrl?: string;
+    qrCodeLabel?: string;
+    /** Absent === `'standard'`. */
+    kind?: PauseAdKind;
+    /** Insight only: the Media image (`FactoidOptions.image`). */
+    mediaSrc?: string;
+    /** Insight only: how `mediaSrc` is cropped. */
+    mediaMode?: PauseAdMediaMode;
+};
+/**
+ * The `pauseAdList` response, shaped for the renderers: keep the cards the SDK has chrome for,
+ * turn each into a `PauseAdCard`, drop the ones that cannot be drawn.
+ *
+ * Pure on purpose — `pause-ad.ts` owns the store and the transport, this owns the card shapes,
+ * and only this half needs unit tests.
+ */
+export declare const parsePauseAdCards: (questions: Question[]) => PauseAdCard[];

package/lib/units/pause-ad-card.js

@@ -0,0 +1,130 @@
+import { CardFormat, FactoidMediaMode, NotificationSponsorLogoMode, PauseAdLayout as PauseAdLayoutProto, PromotionButtonType, PromotionFormat, QRCode, UseGeneralLogo, UserAccountInfo, } from '@streamlayer/sl-eslib/interactive/interactive.common_pb';
+/**
+ * Insight body cap (SC-353). Studio enforces it on the Additional Content field; the
+ * SDK clamps as well so a card authored before the limit landed cannot overflow the
+ * screen — the format is explicitly designed to fit without scrolling.
+ */
+export const INSIGHT_BODY_MAX_LENGTH = 600;
+/**
+ * Sponsor logo for a factoid card. Same General-tab opt-in as the promotion path below,
+ * but the logo lives on `question.promotion.sponsor` (a factoid card carries no
+ * `PromotionOptions`) and Studio writes the uploaded file to `logo`, not `centerLogo`.
+ *
+ * `logo` therefore WINS over `centerLogo`: the latter is an optional field carried over from the
+ * notification/header surfaces, so a card that kept a stale `centerLogo` from an earlier revision
+ * would otherwise render it instead of the Insight logo the author just uploaded.
+ */
+const resolveInsightSponsorLogo = (question) => {
+    const sponsor = question.promotion?.sponsor;
+    if (sponsor?.logoPosition === NotificationSponsorLogoMode.NOTIFICATION_SPONSOR_LOGO_NONE) {
+        return undefined;
+    }
+    return sponsor?.useGeneralLogo === UseGeneralLogo.ENABLED
+        ? question.promotion?.generalTabMetadata?.advertiserTransparentLogo || undefined
+        : sponsor?.logo || sponsor?.centerLogo || undefined;
+};
+const MEDIA_MODE_BY_PROTO = {
+    [FactoidMediaMode.IMAGE]: 'image',
+    [FactoidMediaMode.CIRCLE]: 'circle',
+};
+/**
+ * Insight Pause Ad, Full Bleed (SC-353). A factoid card, so none of the promotion
+ * plumbing above applies: the heading is the question subject, the body is
+ * `FactoidOptions.body`, and the sponsor logo comes off `question.promotion.sponsor`.
+ *
+ * `FACTOID_MEDIA_MODE_VIDEO` is deliberately treated as "no media": the full-bleed
+ * format has no player chrome and no way to start playback, unlike the sidebar variant.
+ */
+const parseInsightPauseAdCard = (question) => {
+    const factoidOptions = question.options?.options.case === 'factoid' ? question.options.options.value : undefined;
+    if (!factoidOptions) {
+        return null;
+    }
+    const mediaMode = MEDIA_MODE_BY_PROTO[factoidOptions.mode] ?? 'none';
+    const body = factoidOptions.body.slice(0, INSIGHT_BODY_MAX_LENGTH);
+    return {
+        id: question.id,
+        parentId: question.eventId || question.id,
+        // `landscapeUrl` ONLY. `portraitUrl` keeps stale artwork from earlier revisions of the
+        // card that Studio no longer shows in its Background Image slot, so falling back to it
+        // paints a background the author has already removed. Unlike the standard card, an
+        // Insight one renders fine with no background at all — its copy is the ad.
+        backgroundImageSrc: question.backgroundImage?.landscapeUrl || undefined,
+        kind: 'insight',
+        layout: 'left',
+        isInteractive: false,
+        logoSrc: resolveInsightSponsorLogo(question),
+        title: question.subject || undefined,
+        description: body || undefined,
+        mediaSrc: mediaMode === 'none' ? undefined : factoidOptions.image || undefined,
+        mediaMode,
+    };
+};
+const parsePauseAdCard = (question) => {
+    if (question.options?.options.case === 'factoid') {
+        return parseInsightPauseAdCard(question);
+    }
+    const backgroundImageSrc = question.backgroundImage?.landscapeUrl;
+    if (!backgroundImageSrc) {
+        return null;
+    }
+    const promotionOptions = question.options?.options.case === 'promotion' ? question.options.options.value : undefined;
+    const pauseAdOptions = promotionOptions?.pauseAdOptions;
+    const optionsSponsor = promotionOptions?.sponsor;
+    const layoutProto = pauseAdOptions?.layout ?? PauseAdLayoutProto.UNSET;
+    const layout = layoutProto === PauseAdLayoutProto.CENTER ? 'center' : layoutProto === PauseAdLayoutProto.IMAGE ? 'image' : 'left';
+    const isInteractive = promotionOptions?.buttonType === PromotionButtonType.SEND_TO_USER;
+    const hasQr = pauseAdOptions?.qrCode === QRCode.QR_CODE_ENABLED && !!pauseAdOptions?.qrCodeUrl;
+    let ctaLabel;
+    let ctaUrl;
+    if (isInteractive && promotionOptions?.buttonOptions.case === 'sendToUserOptions') {
+        const accountInfo = promotionOptions.buttonOptions.value.userAccountInfo;
+        const isPhone = accountInfo === UserAccountInfo.PHONE;
+        ctaUrl = isPhone ? 'sendToPhone:' : 'sendToEmail:';
+        ctaLabel = isPhone ? 'Send info to account phone' : 'Send info to account email';
+    }
+    const logoSrc = optionsSponsor?.logoPosition === NotificationSponsorLogoMode.NOTIFICATION_SPONSOR_LOGO_NONE
+        ? undefined
+        : optionsSponsor?.useGeneralLogo === UseGeneralLogo.ENABLED
+            ? question.promotion?.generalTabMetadata?.advertiserTransparentLogo || undefined
+            : optionsSponsor?.centerLogo || undefined;
+    return {
+        id: question.id,
+        parentId: question.eventId || question.id,
+        backgroundImageSrc,
+        layout,
+        logoSrc,
+        title: promotionOptions?.banner?.title || undefined,
+        description: promotionOptions?.banner?.body || undefined,
+        isInteractive,
+        ctaLabel: ctaLabel || undefined,
+        ctaUrl: ctaUrl || undefined,
+        qrCodeUrl: hasQr ? (pauseAdOptions?.qrCodeUrl ?? undefined) : undefined,
+        qrCodeLabel: hasQr ? (pauseAdOptions?.qrCodeLabel ?? undefined) : undefined,
+    };
+};
+/**
+ * Which cards from `pauseAdList` the SDK can actually draw. Both renderers are full bleed; a
+ * Sidebar-format pause ad has no chrome yet and is skipped.
+ */
+const isFullBleedPauseAd = (question) => {
+    if (question.options?.options.case === 'factoid') {
+        // Insight Pause Ad (SC-353). Studio does not write `CardFormat` on these cards yet
+        // (SLW-7062), so an UNSET format is taken as Full Bleed — the only Insight pause-ad chrome
+        // the SDK has. An explicit Sidebar stays out. Drop the UNSET arm once Studio sets the field.
+        return question.format === CardFormat.FULL_BLEED || question.format === CardFormat.UNSET;
+    }
+    const promotionOptions = question.options?.options.case === 'promotion' ? question.options.options.value : undefined;
+    return promotionOptions?.format === PromotionFormat.FULL_BLEED || question.format === CardFormat.FULL_BLEED;
+};
+/**
+ * The `pauseAdList` response, shaped for the renderers: keep the cards the SDK has chrome for,
+ * turn each into a `PauseAdCard`, drop the ones that cannot be drawn.
+ *
+ * Pure on purpose — `pause-ad.ts` owns the store and the transport, this owns the card shapes,
+ * and only this half needs unit tests.
+ */
+export const parsePauseAdCards = (questions) => questions
+    .filter(isFullBleedPauseAd)
+    .map(parsePauseAdCard)
+    .filter((card) => card !== null);

package/lib/units/pause-ad.d.ts

@@ -1,24 +1,7 @@
 import { createSingleStore, StreamLayerContext } from '@streamlayer/sdk-web-interfaces';
 import '@streamlayer/sdk-web-api';
 import '@streamlayer/sdk-web-core/store';
-export type PauseAdLayout = 'left' | 'center' | 'image';
-export type PauseAdCard = {
-    id: string;
-    parentId: string;
-    /** Optional: a video-only card (programmatic VAST, SC-322) has no image. */
-    backgroundImageSrc?: string;
-    /** Linear MP4 from VAST → renders full-bleed `<video>` instead of the image (SC-322). */
-    backgroundVideoSrc?: string;
-    layout: PauseAdLayout;
-    isInteractive: boolean;
-    logoSrc?: string;
-    title?: string;
-    description?: string;
-    ctaLabel?: string;
-    ctaUrl?: string;
-    qrCodeUrl?: string;
-    qrCodeLabel?: string;
-};
+import { type PauseAdCard } from './pause-ad-card';
 export type PauseAdListOptions = {
     refetchInterval: number;
     $enabled: boolean;

package/lib/units/pause-ad.js

@@ -2,49 +2,9 @@ import { createLogger } from '@streamlayer/sdk-web-logger';
 import { atom } from 'nanostores';
 import '@streamlayer/sdk-web-api';
 import '@streamlayer/sdk-web-core/store';
-import { CardFormat, NotificationSponsorLogoMode, PauseAdLayout as PauseAdLayoutProto, PromotionButtonType, PromotionFormat, QRCode, UseGeneralLogo, UserAccountInfo, } from '@streamlayer/sl-eslib/interactive/interactive.common_pb';
 import { Feed } from '@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb';
+import { parsePauseAdCards } from './pause-ad-card';
 const log = createLogger('advertisement:pause-ad');
-const parsePauseAdCard = (question) => {
-    const backgroundImageSrc = question.backgroundImage?.landscapeUrl;
-    if (!backgroundImageSrc) {
-        return null;
-    }
-    const promotionOptions = question.options?.options.case === 'promotion' ? question.options.options.value : undefined;
-    const pauseAdOptions = promotionOptions?.pauseAdOptions;
-    const optionsSponsor = promotionOptions?.sponsor;
-    const layoutProto = pauseAdOptions?.layout ?? PauseAdLayoutProto.UNSET;
-    const layout = layoutProto === PauseAdLayoutProto.CENTER ? 'center' : layoutProto === PauseAdLayoutProto.IMAGE ? 'image' : 'left';
-    const isInteractive = promotionOptions?.buttonType === PromotionButtonType.SEND_TO_USER;
-    const hasQr = pauseAdOptions?.qrCode === QRCode.QR_CODE_ENABLED && !!pauseAdOptions?.qrCodeUrl;
-    let ctaLabel;
-    let ctaUrl;
-    if (isInteractive && promotionOptions?.buttonOptions.case === 'sendToUserOptions') {
-        const accountInfo = promotionOptions.buttonOptions.value.userAccountInfo;
-        const isPhone = accountInfo === UserAccountInfo.PHONE;
-        ctaUrl = isPhone ? 'sendToPhone:' : 'sendToEmail:';
-        ctaLabel = isPhone ? 'Send info to account phone' : 'Send info to account email';
-    }
-    const logoSrc = optionsSponsor?.logoPosition === NotificationSponsorLogoMode.NOTIFICATION_SPONSOR_LOGO_NONE
-        ? undefined
-        : optionsSponsor?.useGeneralLogo === UseGeneralLogo.ENABLED
-            ? question.promotion?.generalTabMetadata?.advertiserTransparentLogo || undefined
-            : optionsSponsor?.centerLogo || undefined;
-    return {
-        id: question.id,
-        parentId: question.eventId || question.id,
-        backgroundImageSrc,
-        layout,
-        logoSrc,
-        title: promotionOptions?.banner?.title || undefined,
-        description: promotionOptions?.banner?.body || undefined,
-        isInteractive,
-        ctaLabel: ctaLabel || undefined,
-        ctaUrl: ctaUrl || undefined,
-        qrCodeUrl: hasQr ? (pauseAdOptions?.qrCodeUrl ?? undefined) : undefined,
-        qrCodeLabel: hasQr ? (pauseAdOptions?.qrCodeLabel ?? undefined) : undefined,
-    };
-};
 export const pauseAdListStore = (instance) => {
     const $slStreamId = instance.stores.slStreamId.getAtomStore();
     return ($enabled, options) => {
@@ -61,14 +21,7 @@ export const pauseAdListStore = (instance) => {
                 }
                 log.debug({ eventId }, 'fetching pause ad list');
                 const res = await client.pauseAdList({ eventId });
-                const questions = res.data ?? [];
-                const cards = questions
-                    .filter((q) => {
-                    const opts = q.options?.options.case === 'promotion' ? q.options.options.value : undefined;
-                    return opts?.format === PromotionFormat.FULL_BLEED || q.format === CardFormat.FULL_BLEED;
-                })
-                    .map((q) => parsePauseAdCard(q))
-                    .filter((c) => c !== null);
+                const cards = parsePauseAdCards(res.data ?? []);
                 log.debug({ count: cards.length }, 'parsed %d fullbleed pause ad cards');
                 return cards;
             },

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@streamlayer/feature-advertisement",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "peerDependencies": {
-    "@dailymotion/vast-client": "^6.4.2",
+    "@dailymotion/vast-client": "^6.4.5",
     "@streamlayer/sl-eslib": "^5.268.1",
     "uuid": "^11.1.0",
     "nanostores": "^1.1.0",
-    "@streamlayer/sdk-web-core": "^1.23.0",
-    "@streamlayer/sdk-web-api": "^1.18.0",
-    "@streamlayer/sdk-web-interfaces": "^1.11.0",
-    "@streamlayer/sdk-web-types": "^2.0.0",
-    "@streamlayer/sdk-web-logger": "^1.2.0",
-    "@streamlayer/sdk-web-storage": "^1.2.0"
+    "@streamlayer/sdk-web-core": "^1.23.1",
+    "@streamlayer/sdk-web-api": "^1.18.1",
+    "@streamlayer/sdk-web-interfaces": "^1.11.1",
+    "@streamlayer/sdk-web-types": "^2.0.1",
+    "@streamlayer/sdk-web-logger": "^1.2.1",
+    "@streamlayer/sdk-web-storage": "^1.2.1"
   },
   "devDependencies": {
     "@types/vast-client": "^3.0.4"