Merge pull request #110 from fingerprintjs/feat-INTER-88/reexport-default-endpoints

INTER-88 reexport default endpoints

Author: ilfa

.github/workflows/coverage-diff.yml

@@ -12,16 +12,26 @@ jobs:
       pull-requests: write
     steps:
       - uses: actions/checkout@v3
+      - name: Cache
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: nodemodules-${{ hashFiles('yarn.lock') }}
+          restore-keys: nodemodules-
+      - name: Install Node packages
+        run: yarn install
+      - name: Build
+        run: yarn build
+      - run: yarn test:coverage
+      - name: Read coverage text report
+        uses: fingerprintjs/action-coverage-report-md@v1
+        id: coverage-md
       - name: Jest coverage comment
         id: coverage
         uses: ArtiomTr/jest-coverage-report-action@df2b025553c31d68f84be6337843e277e2576844
         with:
           package-manager: yarn
           output: report-markdown
-      - run: yarn test:coverage
-      - name: Read coverage text report
-        uses: fingerprintjs/action-coverage-report-md@v1
-        id: coverage-md
       - uses: marocchino/sticky-pull-request-comment@adca94abcaf73c10466a71cc83ae561fd66d1a56
         with:
           message: |

README.md

@@ -30,9 +30,9 @@
 </a>
 
 
-# FingerprintJS Pro React
+# Fingerprint Pro React
 
-FingerprintJS Pro React is an easy-to-use React library for **[FingerprintJS Pro](https://fingerprint.com/)**. It's also compatible with the Next.js framework. SPA and Next.js examples are located in the [examples](https://github.com/fingerprintjs/fingerprintjs-pro-react/tree/main/examples) folder.  **This package works with FingerprintJS Pro, it is not compatible with [open-source FingerprintJS](https://github.com/fingerprintjs/fingerprintjs).** You can learn more about the difference between FingerprintJS Pro and open-source FingerprintJS in the [official documentation](https://dev.fingerprint.com/docs/pro-vs-open-source).
+Fingerprint Pro React SDK is an easy way to integrate **[Fingerprint Pro](https://fingerprint.com/)** into your React application. It's also compatible with Next.js and Preact. See application demos in the [examples](https://github.com/fingerprintjs/fingerprintjs-pro-react/tree/main/examples) folder.  **This package works with Fingerprint Pro, it is not compatible with [open-source FingerprintJS](https://github.com/fingerprintjs/fingerprintjs).** You can learn more about the difference between Fingerprint Pro and open-source FingerprintJS in the [official documentation](https://dev.fingerprint.com/docs/pro-vs-open-source).
 
 ## Table of contents
 
@@ -60,33 +60,35 @@ yarn add @fingerprintjs/fingerprintjs-pro-react
 
 ## Getting started
 
-In order to identify visitors, you'll need a FingerprintJS Pro account (you can [sign up for free](https://dashboard.fingerprint.com/signup/)).
-You can learn more about API keys in the [official FingerprintJS Pro documentation](https://dev.fingerprint.com/docs/quick-start-guide).
+In order to identify visitors, you'll need a Fingerprint Pro account (you can [sign up for free](https://dashboard.fingerprint.com/signup/)).
+To get your API key and get started, see the [official Fingerprint Pro documentation](https://dev.fingerprint.com/docs/quick-start-guide).
 
-1. Wrap your application (or component) in `FpjsProvider`. You can specify multiple configuration options. \
-   Set a region if you have chosen a non-global region during registration. Please refer to the [Regions page](https://dev.fingerprint.com/docs/regions).
+1. Wrap your application (or component) in `FpjsProvider`. You can specify multiple configuration options. Set a region if you have chosen a non-global region during registration. See [Regions](https://dev.fingerprint.com/docs/regions) in our documentation. Set `endpoint` and `scriptUrlPattern` if you are using [one of our proxy integrations to increase accuracy](https://dev.fingerprint.com/docs/protecting-the-javascript-agent-from-adblockers) and effectiveness of visitor identification.
 
 ```jsx
 // src/index.js
 import React from 'react';
 import ReactDOM from 'react-dom/client';
-import { FpjsProvider } from '@fingerprintjs/fingerprintjs-pro-react';
+import { FpjsProvider, /* defaultEndpoint, defaultScriptUrlPattern */ } from '@fingerprintjs/fingerprintjs-pro-react';
 import App from './App';
 
 const root = ReactDOM.createRoot(document.getElementById('app'))
 
 root.render(
   <FpjsProvider
-    loadOptions = {{
-      apiKey: 'your-fpjs-public-api-key'
+    loadOptions={{
+      apiKey: 'your-fpjs-public-api-key',
+      // region: 'eu',
+      // endpoint: ['metrics.yourwebsite.com', defaultEndpoint],
+      // scriptUrlPattern: ['metrics.yourwebsite.com/agent-path', defaultScriptUrlPattern],
     }}
   >
     <App />
   </FpjsProvider>
 );
 ```
 
-2. Use the `useVisitorData` hook in your components to perform visitor identification and get the data. 
+2. Use the `useVisitorData` hook in your components to identify visitors and get the result data. 
 
 ```jsx
 // src/App.js
@@ -111,7 +113,7 @@ function App() {
     // perform some logic based on the visitor data
     return (
       <div>
-        Welcome {data.visitorFound ? 'back' : ''}!
+        Welcome {data.visitorFound ? 'back' : ''}, {data.visitorId}!
       </div>
     );
   } else {
@@ -122,7 +124,7 @@ function App() {
 export default App;
 ```
 
-The `useVisitorData` hook also returns a `getData` method which can make an API call on your command. 
+The `useVisitorData` hook also returns a `getData` method you can use to make an API call on command.
 
 ```jsx
 // src/App.js
@@ -179,26 +181,26 @@ function App() {
 export default App;
 ```
 
-See the full code example in the [examples folder](https://github.com/fingerprintjs/fingerprintjs-pro-react/tree/main/examples/spa).
+See the full code example in the [examples folder](https://github.com/fingerprintjs/fingerprintjs-pro-react/tree/main/examples/create-react-app).
 
 ## Caching strategy
 
-When you use FingerprintJS Pro, you pay for each API call. Our [best practices](https://dev.fingerprint.com/docs/caching-visitor-information) recommend using cache to reduce the API call rate. The Library uses the SessionStorage cache strategy by default.
+Fingerprint Pro usage is billed per API call. To reduce API calls, it is a good practice to [cache identification results](https://dev.fingerprint.com/docs/caching-visitor-information). The SDK uses SessionStorage to cache results by default.
 
-:warning: **WARNING** If you use data from `extendedResult`, please pay additional attention to caching strategy.
-
-Some fields from the [extendedResult](https://dev.fingerprint.com/docs/js-agent#extendedresult) (e.g `ip` or `lastSeenAt`) might change for the same visitor. If you need to get the current data, it is recommended to pass `ignoreCache=true` inside [getData](#returned-object) function.
+> :warning: **WARNING** If you use data from `extendedResult`, pay additional attention to caching strategy. 
+>
+> Some fields from the [extendedResult](https://dev.fingerprint.com/docs/js-agent#extendedresult) (e.g., `ip` or `lastSeenAt`) might change over time for the same visitor. If you need to get the latest results, pass `{ignoreCache: true}` to the `getData()` function.
 
 ## Error handling
 
-`getData` throws errors directly from our Pro Agent without changing them. [Read more about error handling.](https://dev.fingerprint.com/docs/js-agent#error-handling)
+The `getData` function throws errors directly from the JS Agent without changing them. See [JS Agent error handling](https://dev.fingerprint.com/docs/js-agent#error-handling) for more details.
 
 ## API Reference
 
-You can find API reference [here](https://fingerprintjs.github.io/fingerprintjs-pro-react/).
+See the full [generated API reference](https://fingerprintjs.github.io/fingerprintjs-pro-react/).
 
 ## Support and feedback
-For support or to provide feedback, please [raise an issue on our issue tracker](https://github.com/fingerprintjs/fingerprintjs-pro-react/issues). If you require private support, please email us at [email protected]. If you'd like to have a similar React wrapper for the [open-source FingerprintJS](https://github.com/fingerprintjs/fingerprintjs), consider [raising an issue in our issue tracker](https://github.com/fingerprintjs/fingerprintjs-pro-react/issues).
+To ask questions or provide feedback, use [Issues](https://github.com/fingerprintjs/fingerprintjs-pro-react/issues). If you need private support, please email us at `[email protected]`. If you'd like to have a similar React wrapper for the [open-source FingerprintJS](https://github.com/fingerprintjs/fingerprintjs), consider creating an issue in the main [FingerprintJS repository](https://github.com/fingerprintjs/fingerprintjs/issues).
 
 
 ## License

package.json

@@ -54,7 +54,7 @@
   },
   "homepage": "https://github.com/fingerprintjs/fingerprintjs-pro-react#readme",
   "dependencies": {
-    "@fingerprintjs/fingerprintjs-pro-spa": "^1.0.2",
+    "@fingerprintjs/fingerprintjs-pro-spa": "^1.1.0",
     "fast-deep-equal": "3.1.3"
   },
   "devDependencies": {
@@ -101,7 +101,7 @@
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "semantic-release": "19.0.3",
     "ts-jest": "^27.1.5",
-    "tslib": "2.5.0",
+    "tslib": "^2.5.0",
     "typedoc": "^0.24.8",
     "typescript": "^4.9.5"
   },

src/index.ts

@@ -16,6 +16,9 @@ export {
   InMemoryCache,
   LocalStorageCache,
   SessionStorageCache,
+  defaultEndpoint,
+  defaultScriptUrlPattern,
+  defaultTlsEndpoint,
 } from '@fingerprintjs/fingerprintjs-pro-spa'
 export type {
   Agent,

yarn.lock

@@ -827,18 +827,18 @@
     minimatch "^3.1.2"
     strip-json-comments "^3.1.1"
 
-"@fingerprintjs/fingerprintjs-pro-spa@^1.0.2":
-  version "1.0.2"
-  resolved "https://registry.yarnpkg.com/@fingerprintjs/fingerprintjs-pro-spa/-/fingerprintjs-pro-spa-1.0.2.tgz#6179ea58cd60a23d113d93ee363ac3ecfa46a15e"
-  integrity sha512-Lo95+PDzezG6FYuILKWl77hB7CfCKOai+GNm/IRbDhhVaATIyYPEPbFArsdv9aRiJD6rZKBEr56thC6CXGZNiQ==
+"@fingerprintjs/fingerprintjs-pro-spa@^1.1.0":
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/@fingerprintjs/fingerprintjs-pro-spa/-/fingerprintjs-pro-spa-1.1.0.tgz#3a1924c4bdc91599ecc41971d01b9e38ec1b18d5"
+  integrity sha512-mj+8zl70lwtibQYdZUN5yUO6Bhw8/MxhbzNolBOp8asCdsXCEEx5DYzRADijQ73vJgimb+ys5zrQ9sZ8O7W0iw==
   dependencies:
-    "@fingerprintjs/fingerprintjs-pro" "^3.8.2"
+    "@fingerprintjs/fingerprintjs-pro" "^3.8.4"
     tslib "^2.5.0"
 
-"@fingerprintjs/fingerprintjs-pro@^3.8.2":
-  version "3.8.2"
-  resolved "https://registry.yarnpkg.com/@fingerprintjs/fingerprintjs-pro/-/fingerprintjs-pro-3.8.2.tgz#91a642c7a8555157acdf7e30ed085e754d8879b2"
-  integrity sha512-cccPaHhzt2AnXbUEdpMW4/19eous5/WJhNlawq5BJKmmGSHJzjjb0kkNXgC0QlFll1YsoqLAxmGLOYRVVfmTBA==
+"@fingerprintjs/fingerprintjs-pro@^3.8.4":
+  version "3.8.4"
+  resolved "https://registry.yarnpkg.com/@fingerprintjs/fingerprintjs-pro/-/fingerprintjs-pro-3.8.4.tgz#d73f7d4da986bf0c10226464e87092e3b50ac0b8"
+  integrity sha512-6m2fTydRjuiM8y02AoUJcOXZuXblHCLmKH3Huu7sgmxDhogTAm1JO0QsF4rigM6hedlFRAejcozBEteqWRZWew==
   dependencies:
     tslib "^2.4.1"
 
@@ -8550,20 +8550,15 @@ tsconfig-paths@^3.14.1:
     minimist "^1.2.6"
     strip-bom "^3.0.0"
 
-[email protected], tslib@^2.4.0, tslib@^2.4.1, tslib@^2.5.0:
-  version "2.5.0"
-  resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.5.0.tgz#42bfed86f5787aeb41d031866c8f402429e0fddf"
-  integrity sha512-336iVw3rtn2BUK7ORdIAHTyxHGRIHVReokCR3XjbckJMK7ms8FysBfhLR8IXnAgy7T0PTPNBWKiH514FOW/WSg==
-
 tslib@^1.8.1, tslib@^1.9.0:
   version "1.14.1"
   resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00"
   integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==
 
-tslib@^2.1.0:
-  version "2.4.0"
-  resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.4.0.tgz#7cecaa7f073ce680a05847aa77be941098f36dc3"
-  integrity sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==
+tslib@^2.1.0, tslib@^2.4.0, tslib@^2.4.1, tslib@^2.5.0:
+  version "2.6.0"
+  resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.6.0.tgz#b295854684dbda164e181d259a22cd779dcd7bc3"
+  integrity sha512-7At1WUettjcSRHXCyYtTselblcHl9PJFFVKiCAy/bY97+BPZXSQ2wbq0P9s8tK2G7dFQfNnlJnPAiArVBVBsfA==
 
 tsutils@^3.21.0:
   version "3.21.0"