@overlayed/ads 0.2.1 → 1.0.0

package/dist/index.d.ts

@@ -1,3 +1,37 @@
+//#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.
+*
+* @example
+* ```ts
+* const script = getAdsScriptElement({
+* 	onError: () => {
+*    // Should never happen, but you should have some logging or observability here since it's a critical part of the ads setup
+*  }
+* });
+*
+* if(script) {
+* 	document.head.appendChild(script);
+* }
+* ```
+*
+* @returns The script element or undefined if the ads script could not be created
+*/
+declare function getAdsScriptElement({
+  onError
+}: {
+  onError: (event: Event | string) => void;
+}): HTMLScriptElement | undefined;
+/**
+* Gets the URL of the ads script
+*
+* @throws If the site URL is invalid - this should never happen
+* @throws If the overlayed instance is not ready
+* @returns The URL of the ads script
+*/
+declare function getAdsScriptUrl(): string;
+//#endregion
 //#region src/reviq.d.ts
 /**
 * Sets a key-value pair for optional targeting
@@ -61,4 +95,4 @@ declare function showConsent(): void;
 */
 declare function init(): void;
 //#endregion
-export { init, setAdsEnabled, setKv, setKvs, setUid, showConsent };
+export { getAdsScriptElement, getAdsScriptUrl, init, setAdsEnabled, setKv, setKvs, setUid, showConsent };

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(e,t){return e(),setInterval(e,t)}function i(){return typeof window>`u`?!1:!(`overlayed`in window)||!window.overlayed||!window.overlayed.getAppInfo?(e(`Could not find overlayed instance - did you import the preload script?`),!1):!0}function a(t,r){if(t===`app_id`){e(`[Overlayed] app_id is a reserved key`);return}n(e=>{e.setKv(t,r)})}function o(e,t){n(n=>{n.setKv(e,t)})}function s(t){if(t.app_id){e(`[Overlayed] app_id is a reserved key`);return}n(e=>{e.setKvs(t)})}function c(e){n(t=>{t.setAdsEnabled(e)})}function l(e){if(!i()||e.u){n(t=>{t.setUid(e)});return}window.overlayed.getAppInfo().then(t=>{n(n=>{n.setUid({...e,u:t.userId})})})}function u(){n(e=>{e.showConsent()})}let d=null;function f(){d&&clearInterval(d),d=r(()=>{t(`[Overlayed] Attempting to intiailize ads...`),i()&&(d&&clearInterval(d),p(window.overlayed))},1e3)}async function p(e){let n=await e.getAppInfo();o(`app_id`,n.slug),l({u:n.userId}),t(`[Overlayed] Ads initialized!`)}export{f as init,c as setAdsEnabled,a as setKv,s as setKvs,l as setUid,u as showConsent};
+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};

package/package.json

@@ -1,16 +1,19 @@
 {
   "name": "@overlayed/ads",
-  "author": "overlayed.gg",
-  "homepage": "https://overlayed.gg",
-  "version": "0.2.1",
+  "version": "1.0.0",
   "description": "Overlayed ads",
+  "keywords": [
+    "typescript"
+  ],
+  "homepage": "https://overlayed.gg",
   "license": "SEE LICENSE IN LICENSE.md",
+  "author": "overlayed.gg",
   "repository": {
-    "url": "https://github.com/overlayed-gg/overlayed-typescript",
-    "type": "git"
+    "type": "git",
+    "url": "https://github.com/overlayed-gg/overlayed-typescript"
   },
-  "keywords": [
-    "typescript"
+  "files": [
+    "dist/**/*"
   ],
   "type": "module",
   "main": "./dist/index.js",
@@ -23,17 +26,9 @@
       "default": "./dist/index.js"
     }
   },
-  "files": [
-    "dist/**/*"
-  ],
   "publishConfig": {
     "access": "public"
   },
-  "peerDependenciesMeta": {
-    "typescript": {
-      "optional": true
-    }
-  },
   "devDependencies": {
     "@ark/attest": "^0.49.0",
     "happy-dom": "^19.0.2",
@@ -41,6 +36,11 @@
     "typescript": "^5.9.3",
     "vitest": "^3.2.4"
   },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=20.10.0"
   }