@overlayed/ads 1.0.1 → 3.0.1

package/dist/index.d.ts

@@ -1,5 +1,11 @@
+//#region src/types.d.ts
+type DivMapping = {
+  divId: string;
+  baseDivId: string;
+  targeting?: Record<string, string>;
+};
+//#endregion
 //#region src/utils.d.ts
-
 /**
 * Gets a new script element that when mounted, will load the ads script. You should append this to the document head.
 *
@@ -32,67 +38,35 @@ declare function getAdsScriptElement({
 */
 declare function getAdsScriptUrl(): string;
 //#endregion
-//#region src/reviq.d.ts
+//#region src/aditude.d.ts
 /**
-* Sets a key-value pair for optional targeting
+* Sets page-level targeting that is applied to subsequent ad requests.
 *
 * WARNING: You may not pass any user-identifiable data (including names, addresses, or user IDs) in targeting.
 *
-* @param key - The key to set.
-* @param value - The value to set.
+* @param targeting - Key-value targeting pairs for the page.
 * @returns void
 */
-declare function setKv(key: string, value: string): void;
+declare function setPageTargeting(targeting: Record<string, string>): void;
 /**
-* Sets multiple key-value pairs for optional targeting
-*
-* WARNING: You may not pass any user-identifiable data (including names, addresses, or user IDs) in targeting.
+* Requests ads for the given div mappings. Call this on initial mount and whenever
+* the page context changes (e.g. route navigation) to refresh ad fills.
 *
-* @param kvs - The key-value pairs to set.
-* @returns void
-*/
-declare function setKvs(kvs: Record<string, string>): void;
-/**
-* Sets whether ads are enabled or not
-*
-* @param enabled - Whether ads are enabled or not.
-* @returns void
-*/
-declare function setAdsEnabled(enabled: boolean): void;
-/**
-* Provide a user ID (uid) for targeting. Variadic.
-*
-* Providing a UID significantly improves ad performance. As such, it is optional, but highly recommended.
-*
-* We comply with all privacy regulations and do not store any user-identifiable data. Once passed to RevIQ, the UID is normalized and then hashed; we never store the original value.
-*
-* If the user has opted out of tracking, the UID will not be stored or transmitted. Thus it is safe to call this function regardless of the user’s tracking preferences.
-*
-* @param uid - The user ID to set.
-* @param uid.u - The username.
-* @param uid.e - The email.
-* @param uid.p - The phone.
-* @returns void
-*/
-declare function setUid(uid: {
-  u?: string;
-  e?: string;
-  p?: string;
-}): void;
-/**
-* Shows the consent dialog
+* WARNING: You may not pass any user-identifiable data in per-mapping targeting.
 *
+* @param mappings - Div mappings describing which ad slots to (re)fill and their targeting.
 * @returns void
 */
-declare function showConsent(): void;
+declare function refreshAdsViaDivMappings(mappings: DivMapping[]): void;
 //#endregion
 //#region src/index.d.ts
 /**
 * Initializes the Overlayed Ads.
 * Overlayed must have been initialized on the electron side.
 *
-* This function only needs to be called once as it will retry initiailizing the ads until it succeeds.
+* Sets the `app_id` page targeting. Safe to call before the ads script has loaded —
+* the command is queued and drained once the provider is ready.
 */
 declare function init(): void;
 //#endregion
-export { getAdsScriptElement, getAdsScriptUrl, init, setAdsEnabled, setKv, setKvs, setUid, showConsent };
+export { type DivMapping, getAdsScriptElement, getAdsScriptUrl, init, refreshAdsViaDivMappings, setPageTargeting };

package/dist/index.js

@@ -1 +1 @@
-function e(e,...t){console.error(`[Overlayed] ${e}`,...t)}function t(e,...t){console.info(`[Overlayed] ${e}`,...t)}function n(e){globalThis.reviq=globalThis.reviq||[],globalThis.reviq.push(e)}function r(){return typeof window>`u`?!1:!(`__overlayed`in window)||!(`__overlayedRuntime`in window)||!window.__overlayed||!window.__overlayedRuntime?(e(`Could not find overlayed instance or runtime - did you import the preload script?`),!1):!0}function i({onError:e}){try{let t=a(),n=document.createElement(`script`);return n.type=`module`,n.src=t,n.onerror=n=>{e(n),console.error(`[Overlayed] Failed to load ads script: ${t}`,n)},n.onload=()=>{console.info(`[Overlayed] Ads script loaded successfully.`)},n}catch(e){console.error(`[Overlayed] Failed to create ads script element: ${e}`);return}}function a(){if(URL.canParse(window.__overlayed.application.siteUrl))return`//js.rev.iq/${new URL(window.__overlayed.application.siteUrl).hostname}`;throw Error(`Invalid site URL`)}function o(t,r){if(t===`app_id`){e(`[Overlayed] app_id is a reserved key`);return}n(e=>{e.setKv(t,r)})}function s(e,t){n(n=>{n.setKv(e,t)})}function c(t){if(t.app_id){e(`[Overlayed] app_id is a reserved key`);return}n(e=>{e.setKvs(t)})}function l(e){n(t=>{t.setAdsEnabled(e)})}function u(e){if(!r()||e.u){n(t=>{t.setUid(e)});return}n(t=>{t.setUid({...e,u:window.__overlayedRuntime?.userId})})}function d(){n(e=>{e.showConsent()})}function f(){if(typeof window>`u`)return;if(!window.__overlayed){e(`[Overlayed] Failed to initialize ads - could not find overlayed instance`);return}s(`app_id`,window.__overlayed.application.slug);let n=window.__overlayedRuntime?.userId;n===void 0?e(`[Overlayed] Could not find overlayed runtime - did you import the preload script?`):u({u:n}),t(`[Overlayed] Ads initialized!`)}export{i as getAdsScriptElement,a as getAdsScriptUrl,f as init,l as setAdsEnabled,o as setKv,c as setKvs,u as setUid,d as showConsent};
+function e(e,...t){console.error(`[Overlayed] ${e}`,...t)}function t(e,...t){console.info(`[Overlayed] ${e}`,...t)}function n(e){globalThis.tude=globalThis.tude||{cmd:[]},globalThis.tude.cmd=globalThis.tude.cmd||[],globalThis.tude.cmd.push(()=>e(globalThis.tude))}function r({onError:e}){try{let t=i(),n=document.createElement(`script`);return n.async=!0,n.src=t,n.onerror=n=>{e(n),console.error(`[Overlayed] Failed to load ads script: ${t}`,n)},n.onload=()=>{console.info(`[Overlayed] Ads script loaded successfully.`)},n}catch(e){console.error(`[Overlayed] Failed to create ads script element: ${String(e)}`);return}}function i(){if(URL.canParse(window.__overlayed.application.siteUrl))return`https://htlbid.com/v3/${new URL(window.__overlayed.application.siteUrl).hostname}/htlbid.js`;throw Error(`Invalid site URL`)}function a(e){n(t=>{t.setPageTargeting(e)})}function o(e){n(t=>{t.refreshAdsViaDivMappings(e)})}function s(){if(!(typeof window>`u`)){if(!window.__overlayed){e(`Failed to initialize ads - could not find overlayed instance`);return}a({app_id:window.__overlayed.application.slug}),t(`Ads initialized!`)}}export{r as getAdsScriptElement,i as getAdsScriptUrl,s as init,o as refreshAdsViaDivMappings,a as setPageTargeting};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@overlayed/ads",
-  "version": "1.0.1",
+  "version": "3.0.1",
   "description": "Overlayed ads",
   "keywords": [
     "typescript"
@@ -30,11 +30,9 @@
     "access": "public"
   },
   "devDependencies": {
-    "@ark/attest": "^0.49.0",
-    "happy-dom": "^19.0.2",
-    "tsdown": "0.18.1",
-    "typescript": "^5.9.3",
-    "vitest": "^3.2.4"
+    "@ark/attest": "^0.56.0",
+    "happy-dom": "^20.9.0",
+    "typescript": "^6.0.3"
   },
   "peerDependenciesMeta": {
     "typescript": {