@overlayed/ads 0.1.1 → 0.1.3

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+//#region src/reviq.d.ts
+/**
+* Sets a key-value pair for optional targeting
+*
+* 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.
+* @returns void
+*/
+declare function setKv(key: string, value: 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.
+*
+* @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
+*
+* @returns void
+*/
+declare function showConsent(): 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.
+*/
+declare function init(): void;
+//#endregion
+export { init, setAdsEnabled, setKv, setKvs, setUid, showConsent };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["key: string","value: string","kvs: Record<string, string>","enabled: boolean","uid: {\n\tu?: string; // username\n\te?: string; // email\n\tp?: string; // phone\n}"],"sources":["../src/reviq.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;AAYA;AAyBA;AAgBA;AAqBA;AA4BA;;;;ACxFgB,iBDFA,KAAA,CCEA,GAAA,EAAA,MAAA,EAAA,KAAA,EAAA,MAAA,CAAA,EAAA,IAAA;;;;;;;;;iBDuBA,MAAA,MAAY;;;;;;;iBAgBZ,aAAA;;;;;;;;;;;;;;;;iBAqBA,MAAA;;;;;;;;;;iBA4BA,WAAA,CAAA;;;AA1FhB;AAyBA;AAgBA;AAqBA;AA4BA;;iBCxFgB,IAAA,CAAA"}

package/dist/index.js

@@ -0,0 +1,150 @@
+//#region src/log.ts
+function logError(message, ...args) {
+	console.error(`[Overlayed] ${message}`, ...args);
+}
+function logInfo(message, ...args) {
+	console.info(`[Overlayed] ${message}`, ...args);
+}
+
+//#endregion
+//#region src/utils.ts
+function useAdsCallback(command) {
+	globalThis.reviq = globalThis.reviq || [];
+	globalThis.reviq.push(command);
+}
+function setIntervalImmediate(callback, delay) {
+	callback();
+	return setInterval(callback, delay);
+}
+function isOverlayedReady() {
+	if (typeof window === "undefined") return false;
+	if (!("overlayed" in window) || !window.overlayed || !window.overlayed.getAppInfo) {
+		logError("Could not find overlayed instance - did you import the preload script?");
+		return false;
+	}
+	return true;
+}
+
+//#endregion
+//#region src/reviq.ts
+/**
+* Sets a key-value pair for optional targeting
+*
+* 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.
+* @returns void
+*/
+function setKv(key, value) {
+	if (key === "app_id") {
+		logError("[Overlayed] app_id is a reserved key");
+		return;
+	}
+	useAdsCallback((reviq) => {
+		reviq.setKv(key, value);
+	});
+}
+function _setKv(key, value) {
+	useAdsCallback((reviq) => {
+		reviq.setKv(key, value);
+	});
+}
+/**
+* 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.
+*
+* @param kvs - The key-value pairs to set.
+* @returns void
+*/
+function setKvs(kvs) {
+	if (kvs.app_id) {
+		logError("[Overlayed] app_id is a reserved key");
+		return;
+	}
+	useAdsCallback((reviq) => {
+		reviq.setKvs(kvs);
+	});
+}
+/**
+* Sets whether ads are enabled or not
+*
+* @param enabled - Whether ads are enabled or not.
+* @returns void
+*/
+function setAdsEnabled(enabled) {
+	useAdsCallback((reviq) => {
+		reviq.setAdsEnabled(enabled);
+	});
+}
+/**
+* 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
+*/
+function setUid(uid) {
+	if (!isOverlayedReady() || uid.u) {
+		useAdsCallback((reviq) => {
+			reviq.setUid(uid);
+		});
+		return;
+	}
+	window.overlayed.getAppInfo().then((appInfo) => {
+		useAdsCallback((reviq) => {
+			reviq.setUid({
+				...uid,
+				u: appInfo.userId
+			});
+		});
+	});
+}
+/**
+* Shows the consent dialog
+*
+* @returns void
+*/
+function showConsent() {
+	useAdsCallback((reviq) => {
+		reviq.showConsent();
+	});
+}
+
+//#endregion
+//#region src/index.ts
+let interval = null;
+/**
+* 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.
+*/
+function init() {
+	if (interval) clearInterval(interval);
+	interval = setIntervalImmediate(() => {
+		logInfo("[Overlayed] Attempting to intiailize ads...");
+		if (!isOverlayedReady()) return;
+		if (interval) clearInterval(interval);
+		initOverlayed(window.overlayed);
+	}, 1e3);
+}
+async function initOverlayed(overlayed) {
+	const appInfo = await overlayed.getAppInfo();
+	_setKv("app_id", appInfo.slug);
+	setUid({ u: appInfo.userId });
+	logInfo("[Overlayed] Ads initialized!");
+}
+
+//#endregion
+export { init, setAdsEnabled, setKv, setKvs, setUid, showConsent };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["message: string","command: (reviq: Reviq) => void","callback: () => void","delay: number","key: string","value: string","kvs: Record<string, string>","enabled: boolean","uid: {\n\tu?: string; // username\n\te?: string; // email\n\tp?: string; // phone\n}","interval: NodeJS.Timeout | null","overlayed: Overlayed"],"sources":["../src/log.ts","../src/utils.ts","../src/reviq.ts","../src/index.ts"],"sourcesContent":["export function logError(message: string, ...args: any[]) {\n\tconsole.error(`[Overlayed] ${message}`, ...args);\n}\n\nexport function logWarning(message: string, ...args: any[]) {\n\tconsole.warn(`[Overlayed] ${message}`, ...args);\n}\n\nexport function logInfo(message: string, ...args: any[]) {\n\tconsole.info(`[Overlayed] ${message}`, ...args);\n}\n","import { logError } from \"./log\";\nimport type { Reviq } from \"./types\";\n\nexport function useAdsCallback(command: (reviq: Reviq) => void) {\n\tglobalThis.reviq = globalThis.reviq || [];\n\tglobalThis.reviq.push(command);\n}\n\nexport function setIntervalImmediate(callback: () => void, delay: number): NodeJS.Timeout {\n\tcallback();\n\treturn setInterval(callback, delay);\n}\n\nexport function isOverlayedReady() {\n\t// SSR check\n\tif (typeof window === \"undefined\") {\n\t\treturn false;\n\t}\n\n\tif (!(\"overlayed\" in window) || !window.overlayed || !window.overlayed.getAppInfo) {\n\t\tlogError(\"Could not find overlayed instance - did you import the preload script?\");\n\t\treturn false;\n\t}\n\n\treturn true;\n}\n","import { logError } from \"./log\";\nimport { isOverlayedReady, useAdsCallback } from \"./utils\";\n\n/**\n * Sets a key-value pair for optional targeting\n *\n * WARNING: You may not pass any user-identifiable data (including names, addresses, or user IDs) in targeting.\n *\n * @param key - The key to set.\n * @param value - The value to set.\n * @returns void\n */\nexport function setKv(key: string, value: string): void {\n\tif (key === \"app_id\") {\n\t\tlogError(\"[Overlayed] app_id is a reserved key\");\n\t\treturn;\n\t}\n\n\tuseAdsCallback((reviq) => {\n\t\treviq.setKv(key, value);\n\t});\n}\n\nexport function _setKv(key: string, value: string): void {\n\tuseAdsCallback((reviq) => {\n\t\treviq.setKv(key, value);\n\t});\n}\n\n/**\n * Sets multiple key-value pairs for optional targeting\n *\n * WARNING: You may not pass any user-identifiable data (including names, addresses, or user IDs) in targeting.\n *\n * @param kvs - The key-value pairs to set.\n * @returns void\n */\nexport function setKvs(kvs: Record<string, string>): void {\n\tif (kvs.app_id) {\n\t\tlogError(\"[Overlayed] app_id is a reserved key\");\n\t\treturn;\n\t}\n\n\tuseAdsCallback((reviq) => {\n\t\treviq.setKvs(kvs);\n\t});\n}\n/**\n * Sets whether ads are enabled or not\n *\n * @param enabled - Whether ads are enabled or not.\n * @returns void\n */\nexport function setAdsEnabled(enabled: boolean): void {\n\tuseAdsCallback((reviq) => {\n\t\treviq.setAdsEnabled(enabled);\n\t});\n}\n\n/**\n * Provide a user ID (uid) for targeting. Variadic.\n *\n * Providing a UID significantly improves ad performance. As such, it is optional, but highly recommended.\n *\n * 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.\n *\n * 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.\n *\n * @param uid - The user ID to set.\n * @param uid.u - The username.\n * @param uid.e - The email.\n * @param uid.p - The phone.\n * @returns void\n */\nexport function setUid(uid: {\n\tu?: string; // username\n\te?: string; // email\n\tp?: string; // phone\n}): void {\n\tif (!isOverlayedReady() || uid.u) {\n\t\tuseAdsCallback((reviq) => {\n\t\t\treviq.setUid(uid);\n\t\t});\n\n\t\treturn;\n\t}\n\n\twindow.overlayed.getAppInfo().then((appInfo) => {\n\t\tuseAdsCallback((reviq) => {\n\t\t\treviq.setUid({\n\t\t\t\t...uid,\n\t\t\t\tu: appInfo.userId,\n\t\t\t});\n\t\t});\n\t});\n}\n\n/**\n * Shows the consent dialog\n *\n * @returns void\n */\nexport function showConsent(): void {\n\tuseAdsCallback((reviq) => {\n\t\treviq.showConsent();\n\t});\n}\n","import type { Overlayed } from \"./types\";\nimport { _setKv, setUid } from \"./reviq\";\nimport { isOverlayedReady, setIntervalImmediate } from \"./utils\";\nimport { logInfo } from \"./log\";\n\nexport { setKv, setKvs, setAdsEnabled, setUid, showConsent } from \"./reviq\";\n\nlet interval: NodeJS.Timeout | null = null;\n/**\n * Initializes the Overlayed Ads.\n * Overlayed must have been initialized on the electron side.\n *\n * This function only needs to be called once as it will retry initiailizing the ads until it succeeds.\n */\nexport function init(): void {\n\tif (interval) {\n\t\tclearInterval(interval);\n\t}\n\n\tinterval = setIntervalImmediate(() => {\n\t\tlogInfo(\"[Overlayed] Attempting to intiailize ads...\");\n\t\tif (!isOverlayedReady()) {\n\t\t\treturn;\n\t\t}\n\n\t\tif (interval) {\n\t\t\tclearInterval(interval);\n\t\t}\n\n\t\tinitOverlayed(window.overlayed);\n\t}, 1000);\n}\n\nasync function initOverlayed(overlayed: Overlayed) {\n\tconst appInfo = await overlayed.getAppInfo();\n\n\t_setKv(\"app_id\", appInfo.slug);\n\tsetUid({\n\t\tu: appInfo.userId,\n\t});\n\n\tlogInfo(\"[Overlayed] Ads initialized!\");\n}\n"],"mappings":";AAAA,SAAgB,SAASA,SAAiB,GAAG,MAAa;AACzD,SAAQ,MAAM,CAAC,YAAY,EAAE,SAAS,EAAE,GAAG,KAAK;AAChD;AAMD,SAAgB,QAAQA,SAAiB,GAAG,MAAa;AACxD,SAAQ,KAAK,CAAC,YAAY,EAAE,SAAS,EAAE,GAAG,KAAK;AAC/C;;;;ACPD,SAAgB,eAAeC,SAAiC;AAC/D,YAAW,QAAQ,WAAW,SAAS,CAAE;AACzC,YAAW,MAAM,KAAK,QAAQ;AAC9B;AAED,SAAgB,qBAAqBC,UAAsBC,OAA+B;AACzF,WAAU;AACV,QAAO,YAAY,UAAU,MAAM;AACnC;AAED,SAAgB,mBAAmB;AAElC,YAAW,WAAW,YACrB,QAAO;AAGR,OAAM,eAAe,YAAY,OAAO,cAAc,OAAO,UAAU,YAAY;AAClF,WAAS,yEAAyE;AAClF,SAAO;CACP;AAED,QAAO;AACP;;;;;;;;;;;;;ACbD,SAAgB,MAAMC,KAAaC,OAAqB;AACvD,KAAI,QAAQ,UAAU;AACrB,WAAS,uCAAuC;AAChD;CACA;AAED,gBAAe,CAAC,UAAU;AACzB,QAAM,MAAM,KAAK,MAAM;CACvB,EAAC;AACF;AAED,SAAgB,OAAOD,KAAaC,OAAqB;AACxD,gBAAe,CAAC,UAAU;AACzB,QAAM,MAAM,KAAK,MAAM;CACvB,EAAC;AACF;;;;;;;;;AAUD,SAAgB,OAAOC,KAAmC;AACzD,KAAI,IAAI,QAAQ;AACf,WAAS,uCAAuC;AAChD;CACA;AAED,gBAAe,CAAC,UAAU;AACzB,QAAM,OAAO,IAAI;CACjB,EAAC;AACF;;;;;;;AAOD,SAAgB,cAAcC,SAAwB;AACrD,gBAAe,CAAC,UAAU;AACzB,QAAM,cAAc,QAAQ;CAC5B,EAAC;AACF;;;;;;;;;;;;;;;;AAiBD,SAAgB,OAAOC,KAId;AACR,MAAK,kBAAkB,IAAI,IAAI,GAAG;AACjC,iBAAe,CAAC,UAAU;AACzB,SAAM,OAAO,IAAI;EACjB,EAAC;AAEF;CACA;AAED,QAAO,UAAU,YAAY,CAAC,KAAK,CAAC,YAAY;AAC/C,iBAAe,CAAC,UAAU;AACzB,SAAM,OAAO;IACZ,GAAG;IACH,GAAG,QAAQ;GACX,EAAC;EACF,EAAC;CACF,EAAC;AACF;;;;;;AAOD,SAAgB,cAAoB;AACnC,gBAAe,CAAC,UAAU;AACzB,QAAM,aAAa;CACnB,EAAC;AACF;;;;ACnGD,IAAIC,WAAkC;;;;;;;AAOtC,SAAgB,OAAa;AAC5B,KAAI,SACH,eAAc,SAAS;AAGxB,YAAW,qBAAqB,MAAM;AACrC,UAAQ,8CAA8C;AACtD,OAAK,kBAAkB,CACtB;AAGD,MAAI,SACH,eAAc,SAAS;AAGxB,gBAAc,OAAO,UAAU;CAC/B,GAAE,IAAK;AACR;AAED,eAAe,cAAcC,WAAsB;CAClD,MAAM,UAAU,MAAM,UAAU,YAAY;AAE5C,QAAO,UAAU,QAAQ,KAAK;AAC9B,QAAO,EACN,GAAG,QAAQ,OACX,EAAC;AAEF,SAAQ,+BAA+B;AACvC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@overlayed/ads",
   "author": "overlayed.gg",
   "homepage": "https://overlayed.gg",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Overlayed ads",
   "license": "BSD-3-Clause",
   "repository": {
@@ -36,11 +36,9 @@
   },
   "devDependencies": {
     "@ark/attest": "^0.45.0",
-    "rollup-plugin-node-externals": "^8.0.0",
+    "happy-dom": "^18.0.1",
+    "tsdown": "^0.12.9",
     "typescript": "^5.8.2",
-    "vite": "^6.2.6",
-    "vite-plugin-dts": "^4.5.3",
-    "vite-plugin-static-copy": "^2.3.1",
     "vitest": "^3.0.9"
   },
   "engines": {