@streamlayer/feature-advertisement 1.1.1-rc.1345 → 1.1.1-rc.2.pf58ff685

package/lib/units/sponsor-logo.js

@@ -0,0 +1,188 @@
+/**
+ * Sponsor-logo slot selection for a **feature** ad unit (Insight, Prediction and Trivia today;
+ * Poll is the same shape and is a separate ticket).
+ *
+ * Deliberately NOT `selectCompanions` (`./external-ad.ts`). That rule is the *display*-unit rule:
+ * it promotes a companion to the logo slot only when the tag ships an exact 300x75 `<Companion>`
+ * next to at least one other. A feature ad-unit tag is typically a **single** creative — often a
+ * lone NonLinear `<StaticResource>` — where the ad IS the logo, which is exactly the shape that
+ * rule returns nothing for. `selectCompanions` stays untouched: SC-335's three shipped units
+ * depend on its exact behaviour and impression counts are billing-visible.
+ *
+ * Mirrors iOS `SLRVASTSlotRole.logo` + `SLRVASTAssetPool`
+ * (`StreamLayerSDK/Frameworks/SLRGAMFramework/Sources/VASTSlotFiller/`):
+ *
+ * - **Images only.** A video-only tag yields no logo. `<Icon>` is never projected — icons hang off
+ *   the `<Linear>` creative, which this selector does not look at. A `<StaticResource>` the tag
+ *   declares as a non-image `creativeType` is skipped too, so a companion that lists a script
+ *   before its image still resolves to the image (see `isImageResource`).
+ * - **Origin-agnostic.** A lone NonLinear `<StaticResource>` is as valid as a `<Companion>`.
+ * - **Aspect-dominant** toward 1:1: the smallest `|log(assetAspect) - log(1)|` wins, ties broken by
+ *   larger area, then by higher pixel density. Aspect is a *preference, never a filter* — the only
+ *   hard constraint is the asset kind, so a badly shaped asset still wins if it is the only one.
+ * - Assets whose intrinsic size the tag never declared rank last, but still beat nothing.
+ *
+ * The module also hosts iOS's second logo role, `SLRVASTSlotRole.cardLogo` (`selectCardLogo`) —
+ * the same ranking narrowed to `<Companion>` origins, for the hero-card display units.
+ */
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="../module.d.ts" />
+/** `width`/`height` are XML attributes (strings at runtime); 0 and NaN both mean "not declared". */
+const toSize = (value) => {
+    const size = Number(value);
+    return size > 0 ? size : undefined;
+};
+/**
+ * VAST 4 `<CompanionAds pxratio>`; `@dailymotion/vast-client` defaults it to `'1'` and the
+ * `@types/vast-client` shim does not declare it, hence the loose read.
+ */
+const toPxRatio = (variation) => {
+    return Number(variation.pxratio) || 1;
+};
+/**
+ * `<StaticResource creativeType>`. The slot draws an `<img>`, so a resource the tag declares as
+ * anything else — the `application/x-shockwave-flash` or `application/javascript` creative a
+ * companion may list beside its image — must never fill it: it would swap the proto logo for a
+ * broken image AND still fire an impression for something nobody ever saw.
+ *
+ * An ABSENT type is not a rejection. VAST requires the attribute but real GAM image companions
+ * routinely omit it, and this module's only hard constraint is the asset kind, so an undeclared
+ * type stays a candidate. `@dailymotion/vast-client` writes `0` for a missing NonLinear
+ * `creativeType` and `null` for a missing companion one; both are falsy, hence the single guard.
+ */
+const isImageResource = (creativeType) => {
+    if (!creativeType) {
+        return true;
+    }
+    return String(creativeType).toLowerCase().indexOf('image/') === 0;
+};
+/**
+ * The first resource a `<Companion>` declares as an image (or leaves undeclared). NOT
+ * `staticResources[0]`: the order in the tag is the advertiser's, and a non-image resource listed
+ * first must not hide a usable image behind it.
+ */
+const pickCompanionImage = (variation) => {
+    const resources = variation.staticResources || [];
+    for (let i = 0; i < resources.length; i++) {
+        const resource = resources[i];
+        if (resource && resource.url && isImageResource(resource.creativeType)) {
+            return resource.url;
+        }
+    }
+    return undefined;
+};
+/** Distance from square on a log scale, so 2:1 and 1:2 are equally far from 1:1. */
+const aspectDistance = (asset) => {
+    if (!asset.width || !asset.height) {
+        // Unknown intrinsic size — rank last, but still a candidate.
+        return Infinity;
+    }
+    return Math.abs(Math.log(asset.width / asset.height));
+};
+const collectAssetsFrom = (ad) => {
+    const assets = [];
+    for (let i = 0; i < ad.creatives.length; i++) {
+        const creative = ad.creatives[i];
+        if (creative.type === 'companion') {
+            const companionCreative = creative;
+            const variations = companionCreative.variations || [];
+            for (let j = 0; j < variations.length; j++) {
+                const variation = variations[j];
+                const imageUrl = variation && pickCompanionImage(variation);
+                if (imageUrl) {
+                    assets.push({
+                        imageUrl,
+                        clickUrl: variation.companionClickThroughURLTemplate ?? undefined,
+                        width: toSize(variation.width),
+                        height: toSize(variation.height),
+                        origin: 'companion',
+                        creative: companionCreative,
+                        variation,
+                    });
+                }
+            }
+            continue;
+        }
+        if (creative.type === 'nonlinear') {
+            const nonLinearCreative = creative;
+            const variations = nonLinearCreative.variations || [];
+            for (let j = 0; j < variations.length; j++) {
+                const variation = variations[j];
+                // `type` is where the parser puts a `<NonLinear>`'s `creativeType`, and it is written last
+                // from the `<StaticResource>` element, so it describes `staticResource` whenever that is
+                // set. An HTML- or iframe-typed variation carries no `staticResource` and drops out here.
+                const imageUrl = variation && isImageResource(variation.type) ? variation.staticResource : undefined;
+                if (imageUrl) {
+                    assets.push({
+                        imageUrl,
+                        // 6.4.2 emits `nonlinearClickThroughURLTemplate` (lower-case `l`); the shim declares
+                        // the upper-case spelling. The runtime one is authoritative — see `getNonLinear`.
+                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                        // @ts-ignore
+                        clickUrl: variation.nonlinearClickThroughURLTemplate ?? undefined,
+                        width: toSize(variation.width),
+                        height: toSize(variation.height),
+                        origin: 'nonlinear',
+                        creative: nonLinearCreative,
+                        variation,
+                    });
+                }
+            }
+        }
+    }
+    return assets;
+};
+/**
+ * The shared ranking both roles use: aspect distance from 1:1, ties broken by larger area, then by
+ * higher pixel density. Aspect is a preference, never a filter — the best of a bad set still wins.
+ */
+const rankBest = (assets) => {
+    if (!assets.length) {
+        return undefined;
+    }
+    let best = assets[0];
+    let bestDistance = aspectDistance(best);
+    let bestArea = (best.width || 0) * (best.height || 0);
+    let bestPxRatio = toPxRatio(best.variation);
+    for (let i = 1; i < assets.length; i++) {
+        const asset = assets[i];
+        const distance = aspectDistance(asset);
+        const area = (asset.width || 0) * (asset.height || 0);
+        const pxRatio = toPxRatio(asset.variation);
+        const wins = distance !== bestDistance ? distance < bestDistance : area !== bestArea ? area > bestArea : pxRatio > bestPxRatio;
+        if (wins) {
+            best = asset;
+            bestDistance = distance;
+            bestArea = area;
+            bestPxRatio = pxRatio;
+        }
+    }
+    return best;
+};
+/**
+ * Pick the image a parsed VAST ad offers for a sponsor-logo slot, or `undefined` when it offers
+ * none (a video-only tag, or an empty response). A caller that gets `undefined` must fall back to
+ * its own proto/Studio logo rather than suppressing the card.
+ */
+export const collectAssets = (ad) => collectAssetsFrom(ad);
+export const selectSponsorLogo = (ad) => rankBest(collectAssetsFrom(ad));
+/**
+ * iOS `SLRVASTSlotRole.cardLogo` — the sponsor logo of a **hero card** (1:1 / 2:1 / Picture in
+ * Picture / Side-by-Side / Sponsor Frame). Same 1:1 aspect-dominant ranking as `.logo`, plus the
+ * one constraint that distinguishes the two roles:
+ *
+ * - **`requiredOrigin: .companion`.** A NonLinear image is a hero creative, never a logo. iOS's
+ *   reason: a leftover hero-type asset — a second `<NonLinear>` overlay, or a stray image still in
+ *   the pool after the hero role claimed its own — must never leak into the card's logo slot,
+ *   where it would render at logo size as an unreadable smudge of the advertiser's key art.
+ *   `nonlinear_full` is the fixture that pins it: `.logo` takes the 500x500 NonLinear, `.cardLogo`
+ *   must take the 200x200 `<Companion>`.
+ * - **`exclude`** mirrors iOS's **greedy** `pool.select([hero, .cardLogo])`: roles resolve in array
+ *   order and an asset a role claims is removed from the pool for every later role. We have no
+ *   pool object, so the caller passes the assets the hero already claimed and they are filtered
+ *   out here by `imageUrl`.
+ */
+export const selectCardLogo = (ad, exclude) => {
+    const claimed = (exclude || []).map((item) => item?.imageUrl).filter((url) => !!url);
+    return rankBest(collectAssetsFrom(ad).filter((asset) => asset.origin === 'companion' && claimed.indexOf(asset.imageUrl) === -1));
+};

package/lib/units/ssai-detector.js

@@ -1,4 +1,5 @@
 import { createLogger } from '@streamlayer/sdk-web-logger';
+import { ssaiq } from './ssai-log.js';
 const log = createLogger('ssai:detector');
 const RANGE_EXPIRY_MS = 10 * 60 * 1000;
 const ACTIVE_POLL_MS = 250;
@@ -488,16 +489,32 @@ export const createSsaiDetector = (options) => {
         : videoRef && manifestUrl
             ? 'manifest-poll'
             : 'none';
-    const recordDebugEvent = (type, detail, programMs) => {
-        debugEvents.push({
-            wallMs: Date.now(),
-            programMs: programMs !== undefined ? programMs : currentProgramTimeMs(),
-            type,
-            detail,
-        });
+    /**
+     * The `[label]` a detector event's log line opens with — what KIND of thing
+     * happened, for a reader scanning a window: a manifest tag came in (`hls`), a
+     * break edge fired (`break`), or playback crossed a tracking marker (`beacon`).
+     */
+    const eventLabel = (type) => {
+        if (type.indexOf('progress:') === 0)
+            return 'beacon';
+        if (type.indexOf('discovered') !== -1 || type === 'range-dropped')
+            return 'hls';
+        return 'break';
+    };
+    /**
+     * One call per detector event, feeding both consumers at once: the capped
+     * ring buffer behind `getDebugSnapshot()` and the `ssaiq` narrative logger.
+     * `data` is whatever the detector already holds for the event — the parsed
+     * range, marker or break window — so a log reader sees exactly what the
+     * detector acted on, with no second parse of the manifest for its benefit.
+     */
+    const recordDebugEvent = (type, detail, programMs, data) => {
+        const at = programMs !== undefined ? programMs : currentProgramTimeMs();
+        debugEvents.push({ wallMs: Date.now(), programMs: at, type, detail });
         if (debugEvents.length > DEBUG_EVENTS_MAX) {
             debugEvents.splice(0, debugEvents.length - DEBUG_EVENTS_MAX);
         }
+        ssaiq.info({ ...data, programMs: at }, `[${eventLabel(type)}] ${type}${detail ? ` ${detail}` : ''}`);
     };
     const getVideo = () => player?.media ?? video ?? null;
     // Memoized view over the three marker maps. `updateActiveAd` polls 4×/s and
@@ -547,7 +564,6 @@ export const createSsaiDetector = (options) => {
                     }
                     seenDroppedKeys.add(entry.key);
                     recordDebugEvent('range-dropped', entry.detail);
-                    log.warn({ detail: entry.detail }, 'ssai DATERANGE dropped');
                 }
                 continue;
             }
@@ -555,7 +571,7 @@ export const createSsaiDetector = (options) => {
                 const existing = rangesById.get(entry.range.id);
                 if (!existing) {
                     changed = true;
-                    recordDebugEvent('range-discovered', `${entry.range.creativeId} ${debugClock(entry.range.startMs)}+${entry.range.durationSec}s`);
+                    recordDebugEvent('range-discovered', `${entry.range.creativeId} ${debugClock(entry.range.startMs)}+${entry.range.durationSec}s`, undefined, { range: entry.range });
                     notifyAdDiscovered(entry.range.creativeId);
                 }
                 else if (existing.startMs !== entry.range.startMs || existing.endMs !== entry.range.endMs) {
@@ -566,7 +582,7 @@ export const createSsaiDetector = (options) => {
             else if (entry.kind === 'marker') {
                 if (!seenMarkerAdIds.has(entry.marker.adId)) {
                     seenMarkerAdIds.add(entry.marker.adId);
-                    recordDebugEvent('marker-ad-discovered', `${entry.marker.adId} ${entry.marker.event}@${debugClock(entry.marker.timeMs)}`);
+                    recordDebugEvent('marker-ad-discovered', `${entry.marker.adId} ${entry.marker.event}@${debugClock(entry.marker.timeMs)}`, undefined, { marker: entry.marker });
                     notifyAdDiscovered(entry.marker.adId);
                 }
                 const existing = markersById.get(entry.marker.id);
@@ -579,7 +595,7 @@ export const createSsaiDetector = (options) => {
                 const existing = adBreaksById.get(entry.window.id);
                 if (!existing) {
                     changed = true;
-                    recordDebugEvent('adbreak-discovered', `${debugClock(entry.window.startMs)}-${debugClock(entry.window.endMs)}`);
+                    recordDebugEvent('adbreak-discovered', `${debugClock(entry.window.startMs)}-${debugClock(entry.window.endMs)}`, undefined, { window: entry.window });
                 }
                 else if (existing.startMs !== entry.window.startMs || existing.endMs !== entry.window.endMs) {
                     changed = true;

package/lib/units/ssai-log.d.ts

@@ -0,0 +1,16 @@
+import { type Logger } from '@streamlayer/sdk-web-logger';
+/**
+ * `ssaiq` — the SSAI ad NARRATIVE log: one line per thing that happens to a
+ * server-stitched ad, in the order it happens. The manifest tag the playout
+ * published, the metadata round trip it triggers, the break the SDK opens from
+ * it, and every beacon fired against it.
+ *
+ * Named for the Quortex/Synamedia DAI integration it was built for, but it is
+ * the path itself that is logged, so a StreamLayer-dialect stream tells the same
+ * story. Detector internals — clock sources, poll ticks, fold bookkeeping — stay
+ * on `ssai:*`, where `SL_DEBUG` can reach them without filling a demo window.
+ *
+ * A host publishes it to the page with `SL_LOG_EVENTS=ssaiq` (see
+ * `sdk-web-logger`); the demo's log window renders exactly that.
+ */
+export declare const ssaiq: Logger;

package/lib/units/ssai-log.js

@@ -0,0 +1,18 @@
+import { createLogger } from '@streamlayer/sdk-web-logger';
+/**
+ * `ssaiq` — the SSAI ad NARRATIVE log: one line per thing that happens to a
+ * server-stitched ad, in the order it happens. The manifest tag the playout
+ * published, the metadata round trip it triggers, the break the SDK opens from
+ * it, and every beacon fired against it.
+ *
+ * Named for the Quortex/Synamedia DAI integration it was built for, but it is
+ * the path itself that is logged, so a StreamLayer-dialect stream tells the same
+ * story. Detector internals — clock sources, poll ticks, fold bookkeeping — stay
+ * on `ssai:*`, where `SL_DEBUG` can reach them without filling a demo window.
+ *
+ * A host publishes it to the page with `SL_LOG_EVENTS=ssaiq` (see
+ * `sdk-web-logger`); the demo's log window renders exactly that.
+ */
+// Explicit type: the inferred pino type is not nameable across package
+// boundaries (TS2742) when this file is compiled on its own.
+export const ssaiq = createLogger('ssaiq');

package/lib/units/ssai-providers.js

@@ -1,7 +1,53 @@
 import { createLogger } from '@streamlayer/sdk-web-logger';
 import { VASTClient } from '@dailymotion/vast-client';
+import { ssaiq } from './ssai-log.js';
 const log = createLogger('ssai:provider');
 export const DEFAULT_CREATIVE_API_BASE = 'https://hls.next.streamlayer.io/api/creatives/';
+/**
+ * One creative-metadata round trip, on the narrative log: the request the SDK
+ * made and the body the ad service answered with, verbatim. This is the half of
+ * the story the manifest cannot tell — the ad's identity comes from the playout,
+ * its content comes from here.
+ */
+const fetchCreativeJson = async (providerId, url, signal) => {
+    // `adApiBase` is customer infrastructure and may carry a key in its query;
+    // the request uses the URL as given, the log gets it with such values masked.
+    const shown = maskUrlSecrets(url);
+    ssaiq.info({ provider: providerId, url: shown }, `[GET] → ${shown}`);
+    let response;
+    try {
+        response = await fetch(url, { signal });
+    }
+    catch (error) {
+        // An abort is the SDK cancelling its own request (break ended, creative
+        // changed) — a note, not a failure.
+        if (error?.name === 'AbortError') {
+            ssaiq.debug({ provider: providerId, url: shown }, `[GET] ✗ aborted ${shown}`);
+        }
+        else {
+            ssaiq.warn({ provider: providerId, url: shown, error: String(error) }, `[GET] ✗ ${shown}`);
+        }
+        throw error;
+    }
+    if (!response.ok) {
+        ssaiq.warn({ provider: providerId, url: shown, status: response.status }, `[GET] ✗ ${response.status} ${shown}`);
+        throw new Error(`${providerId} creative request failed: ${response.status}`);
+    }
+    let raw;
+    try {
+        raw = (await response.json());
+    }
+    catch (error) {
+        // A 200 with a body that is not JSON would otherwise leave the log looking
+        // like a request still in flight.
+        ssaiq.warn({ provider: providerId, url: shown, error: String(error) }, `[GET] ✗ ${response.status} ${shown} — not JSON`);
+        throw error;
+    }
+    ssaiq.info({ provider: providerId, status: response.status, body: raw }, `[GET] ← ${response.status} ad metadata — ${raw?.advertiser || raw?.title || raw?.creativeId || 'ad'}`);
+    return raw;
+};
+/** `?apiKey=…` → `?apiKey=«redacted»`, for URLs that go on a screen. Regex, not `URL`: this ships to 2016 TV engines. */
+const maskUrlSecrets = (url) => url.replace(/([?&][^=&]*(?:token|secret|password|key|authorization)[^=&]*=)[^&]*/gi, '$1«redacted»');
 /**
  * Shared low-level beacon helper. Prefers `navigator.sendBeacon` and falls back
  * to a no-cors `fetch`. Used by the default impression path and available to
@@ -100,12 +146,7 @@ export const createStreamLayerProvider = (config = {}) => {
     return {
         id: 'streamlayer',
         resolve: async (creativeId, signal) => {
-            const url = buildCreativeUrl(creativeApiBase, creativeId);
-            const response = await fetch(url, { signal });
-            if (!response.ok) {
-                throw new Error(`creative request failed: ${response.status}`);
-            }
-            const raw = (await response.json());
+            const raw = await fetchCreativeJson('streamlayer', buildCreativeUrl(creativeApiBase, creativeId), signal);
             return mapApiResponse({ ...raw, creativeId: raw.creativeId || creativeId });
         },
         fireImpression: fireDefaultImpression,
@@ -149,11 +190,7 @@ export const createQuortexProvider = (config = {}) => {
             if (!adApiBase) {
                 throw new Error('quortex provider is missing `adApiBase`');
             }
-            const response = await fetch(buildQuortexUrl(adApiBase, tenantName, adId), { signal });
-            if (!response.ok) {
-                throw new Error(`quortex creative request failed: ${response.status}`);
-            }
-            const raw = (await response.json());
+            const raw = await fetchCreativeJson('quortex', buildQuortexUrl(adApiBase, tenantName, adId), signal);
             return mapApiResponse({ ...raw, creativeId: raw.creativeId || adId });
         },
         fireImpression: fireDefaultImpression,

package/lib/vast-client.d.ts

@@ -0,0 +1,9 @@
+declare module '@dailymotion/vast-client' {
+  export interface VastAd {}
+  export interface VastCompanionAd {}
+  export interface VastCreativeCompanion {}
+  export interface VastCreativeLinear {}
+  export interface VastCreativeNonLinear {}
+  export interface VastNonLinearAd {}
+  export interface VastResponse {}
+}

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@streamlayer/feature-advertisement",
-  "version": "1.1.1-rc.1345",
+  "version": "1.1.1-rc.2.pf58ff685",
   "peerDependencies": {
     "@dailymotion/vast-client": "^6.4.5",
     "@streamlayer/sl-eslib": "^5.268.1",
     "core-js": "^3.50.0",
     "uuid": "^11.1.0",
     "nanostores": "^1.1.0",
-    "@streamlayer/sdk-web-core": "^1.23.2-rc.1345",
-    "@streamlayer/sdk-web-api": "^1.18.2-rc.1345",
-    "@streamlayer/sdk-web-interfaces": "^1.11.2-rc.1345",
-    "@streamlayer/sdk-web-types": "^2.0.2-rc.1345",
-    "@streamlayer/sdk-web-logger": "^1.2.2-rc.1345",
-    "@streamlayer/sdk-web-storage": "^1.2.2-rc.1345"
+    "@streamlayer/sdk-web-core": "1.23.2-rc.2.pf58ff685",
+    "@streamlayer/sdk-web-api": "1.18.2-rc.2.pf58ff685",
+    "@streamlayer/sdk-web-interfaces": "1.11.2-rc.2.pf58ff685",
+    "@streamlayer/sdk-web-types": "2.0.2-rc.2.pf58ff685",
+    "@streamlayer/sdk-web-logger": "1.2.2-rc.2.pf58ff685",
+    "@streamlayer/sdk-web-storage": "1.2.2-rc.2.pf58ff685"
   },
   "devDependencies": {
     "@types/vast-client": "^3.0.4"
@@ -56,4 +56,4 @@
   "dependencies": {
     "vmap": "^3.2.0"
   }
-}
+}