@visitorquery/react 0.0.3

package/README.md

@@ -0,0 +1,35 @@
+# @visitorquery/react
+
+Use this package to prevent fraud and abuse by visitors hiding behind proxies and VPNs. With a simple call to `useVisitorQuery`  your website or app will be making a request to our servers which will respond with a boolean value indicating wether the current user is behind a proxy or VPN. 99.999% of the fraud online is done by individuals hiding behind proxies and VPNs.
+
+Our checks are not list based like other services who iterate over a database of known proxy IP addresses. We are using deep packet inspection to detect, in real time, such traffic which is why the api call must be originating from the client's device/browser.
+
+This plugin requires a valid api key (Public api key). To obtain one 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 CheckoutComponent() {
+    const visitorQuery = useVisitorQuery(
+        // use your project's PUBLIC api key here
+        process.env.NEXT_PUBLIC_VISITOR_QUERY_API_KEY!,
+    );
+
+    useEffect(() => {
+        if (visitorQuery.is === true && visitorQuery.confidence > 0.6) {
+            // decide what to do with the visitor
+            return;
+        }
+    }, [visitorQuery]);
+
+    return (
+        <div>
+            {visitorQuery.is &&(
+                <p>You are behind a proxy</p>
+            )}
+        </div>
+    )
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export type TResponse = {
+    is: boolean;
+    confidence: number;
+};
+export declare function useVisitorQuery(publicApiKey: string, endpoint?: string): TResponse;

package/dist/index.js

@@ -0,0 +1,26 @@
+// src/index.ts
+import { useState, useEffect } from "react";
+function useVisitorQuery(publicApiKey, endpoint = "https://main.check.visitorquery.com/") {
+  const [visitorQuery, setVisitorQuery] = useState({
+    is: false,
+    confidence: 0
+  });
+  useEffect(() => {
+    const fetchData = async () => {
+      try {
+        const response = await fetch(endpoint, {
+          headers: { "X-Api-Key": publicApiKey }
+        });
+        const data = await response.json();
+        setVisitorQuery(data);
+      } catch (error) {
+        console.error(`Error fetching visitorquery data: ${error}`);
+      }
+    };
+    fetchData().catch(console.error);
+  }, [publicApiKey, endpoint]);
+  return visitorQuery;
+}
+export {
+  useVisitorQuery
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "version": "0.0.3",
+  "name": "@visitorquery/react",
+  "module": "src/index.ts",
+  "type": "module",
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "access": "public",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "bun build --target=node ./src/index.ts --outfile=dist/index.js --external react --external react-dom && bun run build:declaration",
+    "build:declaration": "tsc --emitDeclarationOnly --project tsconfig.types.json",
+    "postbuild": "rimraf tsconfig.types.tsbuildinfo",
+    "release": "git fetch --tags -f && standard-version && git push --follow-tags origin master",
+    "publish": "npm publish --access public"
+  },
+  "peerDependencies": {
+    "@types/react": "^19.0.10",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "typescript": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/visitorquery/react-hook.git"
+  },
+  "keywords": [
+    "fraud",
+    "antifraud",
+    "chargeback",
+    "proxy",
+    "visitorquery",
+    "vpn",
+    "detect"
+  ],
+  "author": "VisitorQuery",
+  "license": "MIT",
+  "files": [
+    "dist/*.js",
+    "dist/*.d.ts"
+  ]
+}