real-view 1.0.0

package/dist/vue.cjs

@@ -0,0 +1,150 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/vue.ts
+var vue_exports = {};
+__export(vue_exports, {
+  userealView: () => userealView
+});
+module.exports = __toCommonJS(vue_exports);
+var import_vue = require("vue");
+
+// src/core/utils.ts
+var isBrowser = () => {
+  return typeof window !== "undefined" && typeof window.document !== "undefined";
+};
+
+// src/core/engine.ts
+var realViewEngine = class _realViewEngine {
+  constructor() {
+    this.observer = null;
+    this.watchers = /* @__PURE__ */ new Map();
+    if (!isBrowser()) return;
+    this.initObserver();
+    this.initTabListener();
+  }
+  static get() {
+    if (!this.instance) this.instance = new _realViewEngine();
+    return this.instance;
+  }
+  initObserver() {
+    this.observer = new IntersectionObserver(this.handleIntersect.bind(this), {
+      threshold: 0
+    });
+  }
+  initTabListener() {
+    document.addEventListener("visibilitychange", () => {
+      const isHidden = document.hidden;
+      this.watchers.forEach((w) => {
+        if (w.opts.trackTab && isHidden) {
+          this.notify(w, false);
+        } else if (w.state.inViewport && !isHidden) {
+          this.checkOcclusion(w);
+        }
+      });
+    });
+  }
+  handleIntersect(entries) {
+    entries.forEach((entry) => {
+      const watcher = this.watchers.get(entry.target);
+      if (!watcher) return;
+      watcher.state.inViewport = entry.isIntersecting;
+      if (entry.isIntersecting) {
+        this.startPolling(watcher);
+      } else {
+        this.stopPolling(watcher);
+        this.notify(watcher, false);
+      }
+    });
+  }
+  checkOcclusion(w) {
+    if (w.opts.trackTab && document.hidden) return this.notify(w, false);
+    const rect = w.el.getBoundingClientRect();
+    if (rect.width === 0 || rect.height === 0) return this.notify(w, false);
+    const style = window.getComputedStyle(w.el);
+    if (style.opacity === "0" || style.visibility === "hidden") return this.notify(w, false);
+    const x = rect.left + rect.width / 2;
+    const y = rect.top + rect.height / 2;
+    const topEl = document.elementFromPoint(x, y);
+    const isVisible = topEl ? w.el.contains(topEl) || w.el === topEl : false;
+    this.notify(w, isVisible);
+  }
+  startPolling(w) {
+    if (w.state.timer) return;
+    const tick = () => {
+      if ("requestIdleCallback" in window) {
+        window.requestIdleCallback(() => this.checkOcclusion(w));
+      } else {
+        this.checkOcclusion(w);
+      }
+    };
+    tick();
+    w.state.timer = window.setInterval(tick, w.opts.pollInterval);
+  }
+  stopPolling(w) {
+    if (w.state.timer) {
+      clearInterval(w.state.timer);
+      w.state.timer = null;
+    }
+  }
+  notify(w, isVisible) {
+    if (w.state.isOccluded !== !isVisible) {
+      w.state.isOccluded = !isVisible;
+      w.cb(isVisible);
+    }
+  }
+  observe(el, cb, options = {}) {
+    if (!isBrowser()) return () => {
+    };
+    const opts = {
+      threshold: 0,
+      pollInterval: 1e3,
+      trackTab: true,
+      ...options
+    };
+    this.watchers.set(el, {
+      el,
+      cb,
+      opts,
+      state: { inViewport: false, isOccluded: false, timer: null }
+    });
+    this.observer?.observe(el);
+    return () => {
+      this.stopPolling(this.watchers.get(el));
+      this.observer?.unobserve(el);
+      this.watchers.delete(el);
+    };
+  }
+};
+
+// src/vue.ts
+function userealView(target, options) {
+  const isVisible = (0, import_vue.ref)(false);
+  let stop;
+  (0, import_vue.onMounted)(() => {
+    if (target.value) {
+      stop = realViewEngine.get().observe(target.value, (v) => isVisible.value = v, options);
+    }
+  });
+  (0, import_vue.onUnmounted)(() => stop?.());
+  return isVisible;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  userealView
+});

package/dist/vue.d.cts

@@ -0,0 +1,6 @@
+import { Ref } from 'vue';
+import { realViewOptions } from './index.cjs';
+
+declare function userealView(target: Ref<HTMLElement | null>, options?: realViewOptions): Ref<boolean, boolean>;
+
+export { userealView };

package/dist/vue.d.ts

@@ -0,0 +1,6 @@
+import { Ref } from 'vue';
+import { realViewOptions } from './index.js';
+
+declare function userealView(target: Ref<HTMLElement | null>, options?: realViewOptions): Ref<boolean, boolean>;
+
+export { userealView };

package/dist/vue.js

@@ -0,0 +1,20 @@
+import {
+  realViewEngine
+} from "./chunk-UW5FKFTH.js";
+
+// src/vue.ts
+import { ref, onMounted, onUnmounted } from "vue";
+function userealView(target, options) {
+  const isVisible = ref(false);
+  let stop;
+  onMounted(() => {
+    if (target.value) {
+      stop = realViewEngine.get().observe(target.value, (v) => isVisible.value = v, options);
+    }
+  });
+  onUnmounted(() => stop?.());
+  return isVisible;
+}
+export {
+  userealView
+};

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) AntonVoronezh <anton.voronezh.1990@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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.

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "real-view",
+  "version": "1.0.0",
+  "description": "Occlusion-aware visibility sensor. Combines IntersectionObserver with Raycasting to track real impressions in React, Vue, Svelte, Angular, and Solid.",
+  "author": {
+    "name": "AntonVoronezh",
+    "email": "anton.voronezh.1990@gmail.com",
+    "url": "https://github.com/AntonVoronezh"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AntonVoronezh/real-view.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AntonVoronezh/real-view/issues"
+  },
+  "homepage": "https://github.com/AntonVoronezh/real-view#readme",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts src/react.ts src/vue.ts src/svelte.ts src/solid.ts src/angular.ts --format cjs,esm --dts --clean",
+    "test": "vitest run",
+    "lint": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "visibility",
+    "viewport",
+    "intersection",
+    "occlusion" ,
+    "tracking",
+    "analytics",
+    "impression",
+    "react",
+    "vue",
+    "svelte",
+    "angular",
+    "solid",
+    "dom",
+    "monitor",
+    "viewability"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AntonVoronezh/real-view.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AntonVoronezh/real-view/issues"
+  },
+  "homepage": "https://github.com/AntonVoronezh/real-view#readme",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "vue": ">=3.0.0",
+    "svelte": ">=3.0.0",
+    "solid-js": ">=1.0.0",
+    "@angular/core": ">=14.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": { "optional": true },
+    "vue": { "optional": true },
+    "svelte": { "optional": true },
+    "solid-js": { "optional": true },
+    "@angular/core": { "optional": true }
+  },
+  "devDependencies": {
+    "@angular/core": "^17.0.0",
+    "@types/react": "^18.2.0",
+    "react": "^18.2.0",
+    "vue": "^3.3.0",
+    "svelte": "^4.0.0",
+    "solid-js": "^1.8.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0",
+    "jsdom": "^23.0.0"
+  }
+}