@streamlayer/feature-advertisement 1.0.0 → 1.1.1-rc.10.p6eb7304a

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-preload.d.ts

@@ -1,4 +1,4 @@
-import type { SsaiCreative } from './ssai-creative';
+import type { SsaiCreative } from './ssai-creative.js';
 /**
  * How long the overlay is willing to wait for artwork. A slow or dead image host
  * must never hold the bar back — the ad is already playing, and a bar that shows

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

@@ -1,4 +1,4 @@
-import type { SsaiCreative } from './ssai-creative';
+import type { SsaiCreative } from './ssai-creative.js';
 export declare const DEFAULT_CREATIVE_API_BASE = "https://hls.next.streamlayer.io/api/creatives/";
 /**
  * A creative provider encapsulates everything that differs between ad sources:

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/units/vast-tracker.d.ts

@@ -13,7 +13,7 @@
  * player) and they are billing-visible, so collapsing them here would silently change counts.
  */
 import { VASTTracker, VastAd, VastCompanionAd, VastCreativeCompanion, VastCreativeLinear, VastCreativeNonLinear, VastNonLinearAd } from '@dailymotion/vast-client';
-import type { AdCompanion, AdData } from './external-ad';
+import type { AdCompanion, AdData } from './external-ad.js';
 /** The creative (and, for non-linear creatives, the variation) a tracker reports through. */
 export type VastTrackerTarget = {
     ad: VastAd;

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,17 +1,18 @@
 {
   "name": "@streamlayer/feature-advertisement",
-  "version": "1.0.0",
+  "version": "1.1.1-rc.10.p6eb7304a",
   "peerDependencies": {
-    "@dailymotion/vast-client": "^6.4.2",
+    "@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.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.2-rc.10.p6eb7304a",
+    "@streamlayer/sdk-web-interfaces": "1.11.2-rc.10.p6eb7304a",
+    "@streamlayer/sdk-web-api": "1.18.2-rc.10.p6eb7304a",
+    "@streamlayer/sdk-web-types": "2.0.2-rc.10.p6eb7304a",
+    "@streamlayer/sdk-web-storage": "1.2.2-rc.10.p6eb7304a",
+    "@streamlayer/sdk-web-logger": "1.2.2-rc.10.p6eb7304a"
   },
   "devDependencies": {
     "@types/vast-client": "^3.0.4"
@@ -19,8 +20,40 @@
   "type": "module",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./lib/cjs/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      },
+      "module": "./lib/index.js",
+      "default": "./lib/index.js"
+    },
+    "./*": "./*",
+    "./classic": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/classic/index.js"
+      },
+      "require": {
+        "types": "./lib/cjs/index.d.ts",
+        "default": "./lib/classic/cjs/index.js"
+      },
+      "module": "./lib/classic/index.js",
+      "default": "./lib/classic/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "lib/",
+    "classic/",
     "package.json"
-  ]
-}
+  ],
+  "dependencies": {
+    "vmap": "^3.2.0"
+  }
+}