@visitorquery/react 0.0.16 → 0.0.17

package/README.md

@@ -14,20 +14,5 @@ This plugin requires a valid api key (Public api key) and that you provision a s
 please visit our website
 at [visitorquery.com](https://visitorquery.com) and pick a suitable plan.
 
-Example usage on our own website (nextjs), on the checkout page, before openning the payment dialog:
-
-```typescript
-import {useVisitorQuery} from "@visitorquery/react";
-
-export default function LayoutComponent() {
-	// visitorquery should be loaded and your visitor assessed
-	// to check the result, issue a GET request from your backend
-	const visitorQuery = useVisitorQuery({
-		// use your project's !!PUBLIC!! api key here
-		ApiKey   : process.env.NEXT_PUBLIC_VISITOR_QUERY_API_KEY!,
-		SessionId: "unique-session-id-to-later-identify-the-visitor",
-	});
-}
-```
-
-For more info and up to date documentation, please visit our [official page](https://visitorquery.com/docs).
+For more info and up to date documentation, please visit
+our [official docs](https://docs.visitorquery.com/integrations/react) for this plugin.

package/dist/index.js

@@ -1,80 +1,81 @@
 import { jsx as f } from "react/jsx-runtime";
-import * as c from "react";
+import * as l from "react";
 import { createContext as v, useState as y, useEffect as E, useMemo as S, useContext as w } from "react";
-function V(t, u = {}) {
-  const [i, r] = c.useState("loading"), d = c.useRef(u);
-  return c.useEffect(() => {
+function V(t, i = {}) {
+  const [a, r] = l.useState("loading"), d = l.useRef(i);
+  return l.useEffect(() => {
     let e = document.querySelector(`script[src="${t}"]`);
-    const n = e == null ? void 0 : e.getAttribute("data-status");
-    if (n) {
-      r(n);
+    const o = e == null ? void 0 : e.getAttribute("data-status");
+    if (o) {
+      r(o);
       return;
     }
     if (e === null) {
       e = document.createElement("script"), e.src = t, e.async = !0, e.setAttribute("data-status", "loading"), document.body.appendChild(e);
-      const o = () => {
-        e == null || e.setAttribute("data-status", "ready"), r("ready"), s();
-      }, a = () => {
-        e == null || e.setAttribute("data-status", "error"), r("error"), s();
-      }, s = () => {
-        e == null || e.removeEventListener("load", o), e == null || e.removeEventListener("error", a);
+      const s = () => {
+        e == null || e.setAttribute("data-status", "ready"), r("ready"), u();
+      }, n = () => {
+        e == null || e.setAttribute("data-status", "error"), r("error"), u();
+      }, u = () => {
+        e == null || e.removeEventListener("load", s), e == null || e.removeEventListener("error", n);
       };
-      e.addEventListener("load", o), e.addEventListener("error", a);
-      const m = d.current.removeOnUnmount;
+      e.addEventListener("load", s), e.addEventListener("error", n);
+      const c = d.current.removeOnUnmount;
       return () => {
-        m === !0 && (e == null || e.remove(), s());
+        c === !0 && (e == null || e.remove(), u());
       };
     } else
       r("unknown");
-  }, [t]), i;
+  }, [t]), a;
 }
-const l = v(null);
+const m = v(null);
 function L({
   apiKey: t,
-  sessionId: u,
-  endpoint: i,
-  children: r
+  sessionId: i,
+  endpoint: a,
+  children: r,
+  trigger: d
 }) {
-  const d = "main.check.visitorquery.com", e = V("https://cdn.visitorquery.com/visitorquery.js", {
+  const e = "main.check.visitorquery.com", o = V("https://cdn.visitorquery.com/visitorquery.js", {
     removeOnUnmount: !1
-  }), [n, o] = y({
+  }), [s, n] = y({
     started: !1,
     ended: !1
   });
   E(() => {
     typeof window.VisitorQuery < "u" && window.VisitorQuery.run({
       ApiKey: t,
-      Endpoint: i || d,
-      SessionId: u,
+      Endpoint: a || e,
+      SessionId: i,
       onOpen: () => {
-        o({
+        n({
           started: !0,
           ended: !1
         });
       },
       onClose: () => {
-        o({
+        n({
           started: !0,
           ended: !0
         });
       },
-      onError: (s) => {
-        o({
+      onError: (c) => {
+        n({
           started: !0,
           ended: !0,
           errored: !0
-        }), console.error(s);
+        }), console.error(c);
       }
     });
-  }, [t, i, u, e]);
-  const a = S(() => ({
-    ...n,
-    isLoading: e === "loading"
-  }), [n, e]);
-  return /* @__PURE__ */ f(l.Provider, { value: a, children: r });
+  }, [t, a, i, o, d]);
+  const u = S(() => ({
+    ...s,
+    isLoading: o === "loading"
+  }), [s, o]);
+  return /* @__PURE__ */ f(m.Provider, { value: u, children: r });
 }
 function Q() {
-  const t = w(l);
+  const t = w(m);
   if (!t)
     throw new Error("useVisitorQuery must be used within a VisitorQueryProvider");
   return t;

package/dist/provider.d.ts

@@ -14,10 +14,24 @@ type VisitorQueryContextType = VisitorQueryState & {
 };
 type VisitorQueryProviderProps = {
     apiKey: string;
+    /**
+     * A unique identifier for the session. This is used in order to later
+     * pull results from the VisitorQuery API.
+     */
     sessionId: string;
+    /**
+     * The endpoint to use for the VisitorQuery script. Useful in cases when
+     * you are using custom/vanity domains
+     */
     endpoint?: string;
     children: React.ReactNode;
+    /**
+     * A trigger that can be used to re-run the VisitorQuery script.
+     * This could be a route change or any other event that you want to use to
+     * re-initialize the VisitorQuery script.
+     */
+    trigger?: string;
 };
-export declare function VisitorQueryProvider({ apiKey, sessionId, endpoint, children }: VisitorQueryProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function VisitorQueryProvider({ apiKey, sessionId, endpoint, children, trigger }: VisitorQueryProviderProps): import("react/jsx-runtime").JSX.Element;
 export declare function useVisitorQuery(): VisitorQueryContextType;
 export {};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.16",
+  "version": "0.0.17",
   "name": "@visitorquery/react",
   "module": "./dist/index.js",
   "type": "module",