@picked/fingerprintjs 0.0.1-dev.1764710808992 → 0.0.1-dev.1764952778408

package/README.md

@@ -1,23 +1,18 @@
-# Fingerprintjs SDK
+# FingerprintJS
 
 ## 🚀 Quick Start
 
-Here's a basic example of how to use `Fingerprintjs` SDK.
+`@picked/fingerprintjs` is a plugin that automatically adds the FingerprintJS visitor ID to the analytics session, if it exists.
 
-## API
-
-**`fingerprintjsPlugin`**: A plugin factory that returns a `Plugin` which, when added to the `createClient` `plugins` array, will attempt to read `window.FingerprintJS` and store the resolved visitor id in the session store under an internal key. The plugin automatically polls for `window.FingerprintJS` for up to 10 seconds and saves the `visitorId` when available. Check below how to import and use it.
-
-**`getFingerprintVisitorId`**: Retrieves the stored FingerprintJS visitor id from the session store.
-  - **Returns**: `string | undefined` — returns the visitor id value (or `undefined` if `window` is not supported).
+When added to the `createClient` `plugins` array, it will attempt to read `window.FingerprintJS` and store the resolved visitor ID in the session store under an internal key. The plugin automatically polls for `window.FingerprintJS` for up to 10 seconds and saves the `visitorId` when available. See below for how to import and use it.
 
 ## Snowplow integration
 
-After the plugin is initialized via `createClient` (i.e. the plugin is included in the `plugins` array and the client is started), the FingerprintJS visitor id will be automatically added to the Snowplow session event. The visitor id is attached with the key `fingerprintjs_visitor_id` on the session event.
+After the plugin is initialized via `createClient` (i.e. the plugin is included in the `plugins` array and the client is started), the FingerprintJS visitor ID will be automatically added to the Snowplow session event as the `fingerprintjs_visitor_id` field.
 
 ## Using the `fingerprintjsPlugin`
 
-You should import the `fingerprintjsPlugin` from package `@picked/fingerprintjs` and add it to the `plugins` array passed to `createClient`.
+You should import the `fingerprintjsPlugin` from the package `@picked/fingerprintjs` and add it to the `plugins` array passed to `createClient`.
 
 Example usage:
 

package/dist/cjs/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("@picked/client"),o=n.createStorageKey("fingerprintjs","global"),g=()=>({name:"fingerprintjs-plugin",setup:()=>{n.supportsWindow()&&p(1e4).then(i=>{if(!i){n.sessionStore.set(o,void 0);return}i.load().then(({get:r})=>{r().then(({visitorId:e})=>{n.sessionStore.set(o,e)})})})}});function d(){var t;return n.supportsWindow()?((t=n.sessionStore.get(o))==null?void 0:t.text())??void 0:void 0}function p(i){return new Promise(t=>{if(!n.supportsWindow())return t(void 0);const r=100,e=Date.now(),s=()=>{const u=globalThis.window.FingerprintJS;if(u)return t(u);if(Date.now()-e>=i)return t(void 0);setTimeout(s,r)};s()})}exports.fingerprintjsPlugin=g;exports.getFingerprintVisitorId=d;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("@picked/client");o.createStorageKey("fingerprintjs","global");const g=()=>({name:"fingerprintjs-plugin",setup:n=>{if(!o.supportsWindow())return;(async()=>{var i,a;const r=await p(1e4);if(!r){(i=n.session)==null||i.removeIdentifier("fingerprintjs_visitor_id");return}const s=await r.load(),{visitorId:e}=await s.get();(a=n.session)==null||a.setIdentifier("fingerprintjs_visitor_id",e)})()}});function p(n){return new Promise(t=>{if(!o.supportsWindow()){t(void 0);return}const r=100,s=Date.now(),e=()=>{const i=globalThis.window.FingerprintJS;if(i)return t(i);if(Date.now()-s>=n)return t(void 0);setTimeout(e,r)};e()})}exports.fingerprintjsPlugin=g;

package/dist/esm/index.js

@@ -1,40 +1,39 @@
-import { createStorageKey as d, supportsWindow as s, sessionStore as e } from "@picked/client";
-const o = d("fingerprintjs", "global"), p = () => ({
+import { createStorageKey as p, supportsWindow as a } from "@picked/client";
+p("fingerprintjs", "global");
+const d = () => ({
   name: "fingerprintjs-plugin",
-  setup: () => {
-    s() && g(1e4).then((n) => {
-      if (!n) {
-        e.set(o, void 0);
+  setup: (n) => {
+    if (!a())
+      return;
+    (async () => {
+      var i, s;
+      const r = await f(1e4);
+      if (!r) {
+        (i = n.session) == null || i.removeIdentifier("fingerprintjs_visitor_id");
         return;
       }
-      n.load().then(({ get: i }) => {
-        i().then(({ visitorId: r }) => {
-          e.set(o, r);
-        });
-      });
-    });
+      const o = await r.load(), { visitorId: e } = await o.get();
+      (s = n.session) == null || s.setIdentifier("fingerprintjs_visitor_id", e);
+    })();
   }
 });
-function c() {
-  var t;
-  return s() ? ((t = e.get(o)) == null ? void 0 : t.text()) ?? void 0 : void 0;
-}
-function g(n) {
+function f(n) {
   return new Promise((t) => {
-    if (!s())
-      return t(void 0);
-    const i = 100, r = Date.now(), u = () => {
-      const a = globalThis.window.FingerprintJS;
-      if (a)
-        return t(a);
-      if (Date.now() - r >= n)
+    if (!a()) {
+      t(void 0);
+      return;
+    }
+    const r = 100, o = Date.now(), e = () => {
+      const i = globalThis.window.FingerprintJS;
+      if (i)
+        return t(i);
+      if (Date.now() - o >= n)
         return t(void 0);
-      setTimeout(u, i);
+      setTimeout(e, r);
     };
-    u();
+    e();
   });
 }
 export {
-  p as fingerprintjsPlugin,
-  c as getFingerprintVisitorId
+  d as fingerprintjsPlugin
 };

package/dist/types/index.d.ts

@@ -19,11 +19,5 @@ interface FingerprintJS {
  * @returns FingerprintJS plugin.
  */
 export declare const fingerprintjsPlugin: () => Plugin;
-/**
- * Retrieves the FingerprintJS visitorId from the session store.
- *
- * @returns StorageItem<string | undefined> The stored visitorId or undefined if not present.
- */
-export declare function getFingerprintVisitorId(): string | undefined;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,MAAM,EACZ,MAAM,gBAAgB,CAAA;AAEvB,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,aAAa,CAAC,EAAE,aAAa,CAAA;KAC9B;CACF;AAED,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,OAAO,CAAC;YAAE,SAAS,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC,CAAA;CACnE;AAID;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,QAAO,MAwBtC,CAAA;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAQ5D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkD,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAE5F,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,aAAa,CAAC,EAAE,aAAa,CAAA;KAC9B;CACF;AAED,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,OAAO,CAAC;YAAE,SAAS,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC,CAAA;CACnE;AAID;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,QAAO,MAyBtC,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@picked/fingerprintjs",
   "description": "Fingerprintjs plugin",
-  "version": "0.0.1-dev.1764710808992",
+  "version": "0.0.1-dev.1764952778408",
   "dependencies": {},
   "devDependencies": {
     "@picked/client": "workspace:*",
@@ -31,7 +31,7 @@
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "peerDependencies": {
-    "@picked/client": "0.0.1-dev.1764710808992"
+    "@picked/client": "0.0.1-dev.1764952778408"
   },
   "private": false,
   "scripts": {