@overlayed/ads 0.0.1

package/LICENSE.md

@@ -0,0 +1,16 @@
+# Proprietary License
+
+Copyright (c) 2023-present OVERLAYED LLC. All rights reserved.
+
+This software and associated documentation files (the "Software") are the proprietary and confidential information of
+OVERLAYED LLC. You may not use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software
+without explicit written permission from OVERLAYED LLC.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Unauthorized copying, transfer, or reproduction of the contents of this Software, via any medium is strictly prohibited.
+
+All rights not expressly granted herein are reserved by OVERLAYED LLC.

package/dist/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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.
+ */
+export declare function init(): void;
+
+/**
+ * Sets whether ads are enabled or not
+ *
+ * @param enabled - Whether ads are enabled or not.
+ * @returns void
+ */
+export declare function setAdsEnabled(enabled: boolean): void;
+
+/**
+ * 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
+ */
+export 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
+ */
+export declare function setKvs(kvs: Record<string, string>): 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
+ */
+export declare function setUid(uid: {
+    u?: string;
+    e?: string;
+    p?: string;
+}): void;
+
+/**
+ * Shows the consent dialog
+ *
+ * @returns void
+ */
+export declare function showConsent(): void;
+
+export { }

package/dist/index.js

@@ -0,0 +1,70 @@
+function o(e, ...n) {
+  console.error(`[Overlayed] ${e}`, ...n);
+}
+function i(e) {
+  globalThis.reviq = globalThis.reviq || [], globalThis.reviq.push(e);
+}
+function s(e, n) {
+  return e(), setInterval(e, n);
+}
+function v(e, n) {
+  if (e === "app_id") {
+    o("[Overlayed] app_id is a reserved key");
+    return;
+  }
+  i((t) => {
+    t.setKv(e, n);
+  });
+}
+function l(e, n) {
+  i((t) => {
+    t.setKv(e, n);
+  });
+}
+function f(e) {
+  if (e.app_id) {
+    o("[Overlayed] app_id is a reserved key");
+    return;
+  }
+  i((n) => {
+    n.setKvs(e);
+  });
+}
+function c(e) {
+  i((n) => {
+    n.setAdsEnabled(e);
+  });
+}
+function a(e) {
+  i((n) => {
+    n.setUid(e);
+  });
+}
+function p() {
+  i((e) => {
+    e.showConsent();
+  });
+}
+let r = null;
+function y() {
+  r && clearInterval(r), r = s(() => {
+    console.log("[Overlayed] Attempting to intiailize ads..."), d() && (r && clearInterval(r), u(window.overlayed));
+  }, 1e3);
+}
+function d() {
+  return !(typeof window > "u" || !("overlayed" in window) || !window.overlayed);
+}
+function u(e) {
+  const { appSlug: n, userId: t } = e;
+  l("app_id", n), a({
+    u: t
+  }), console.log("[Overlayed] Ads initialized!");
+}
+export {
+  y as init,
+  c as setAdsEnabled,
+  v as setKv,
+  f as setKvs,
+  a as setUid,
+  p as showConsent
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+	"name": "@overlayed/ads",
+	"author": "overlayed.gg",
+	"homepage": "https://overlayed.gg",
+	"version": "0.0.1",
+	"description": "Overlayed ads",
+	"packageManager": "pnpm@10.6.3",
+	"license": "BSD-3-Clause",
+	"repository": {
+		"url": "https://github.com/overlayed-gg/overlayed-typescript",
+		"type": "git"
+	},
+	"keywords": [
+		"typescript"
+	],
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		"./package.json": "./package.json",
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"default": "./dist/index.js"
+		}
+	},
+	"files": [
+		"dist/**/*"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"peerDependenciesMeta": {
+		"typescript": {
+			"optional": true
+		}
+	},
+	"devDependencies": {
+		"@ark/attest": "catalog:",
+		"rollup-plugin-node-externals": "catalog:",
+		"typescript": "catalog:",
+		"vite": "catalog:",
+		"vite-plugin-dts": "catalog:",
+		"vite-plugin-static-copy": "catalog:",
+		"vitest": "catalog:"
+	},
+	"engines": {
+		"node": ">=20.10.0"
+	}
+}