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

package/README.md

@@ -2,10 +2,42 @@
 
 ## 🚀 Quick Start
 
-Here's a basic example of how to use `Fingerprintjs` SDK:
+Here's a basic example of how to use `Fingerprintjs` SDK.
+
+## 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).
+
+## 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.
+
+## Using the `fingerprintjsPlugin`
+
+You should import the `fingerprintjsPlugin` from package `@picked/fingerprintjs` and add it to the `plugins` array passed to `createClient`.
+
+Example usage:
 
 ```typescript
-import { doSomething } from '@picked/fingerprintjs'
+import { createClient, fingerprintjsPlugin } from '@picked/fingerprintjs'
+
+function app() {
+  try {
+    const plugins: CreateClientOptions['plugins'] = [fingerprintjsPlugin()]
+
+    const client = createClient({
+      organizationId: 'organization-id',
+      projectId: 'project-id',
+      predicates: {},
+      plugins,
+    })
 
-doSomething()
+    client.start()
+  } catch (error) {
+    throw error
+  }
+}
 ```

package/dist/cjs/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("@picked/client"),i=n.createStorageKey("fingerprintjs","global"),p=()=>({name:"fingerprintjs-plugin",setup:()=>{if(console.log("====> [fingerprintjsPlugin] Setting up FingerprintJS plugin"),!n.supportsWindow()){console.log("====> [fingerprintjsPlugin] Window is not supported");return}d(1e4).then(t=>{if(!t){console.log("====> [fingerprintjsPlugin] FingerprintJS not found on window after retry"),n.sessionStore.set(i,void 0);return}t.load().then(({get:o})=>{o().then(({visitorId:e})=>{n.sessionStore.set(i,e),console.log("====> [fingerprintjsPlugin] FingerprintJS visitorId stored:",i,e)})})})}});function u(){if(!n.supportsWindow()){console.log("====> [getFingerprintVisitorId] Window is not supported");return}return console.log("====> [getFingerprintVisitorId] Retrieving FingerprintJS visitorId from session store:",i,n.sessionStore.get(i).text()),n.sessionStore.get(i)}function d(t){return new Promise(r=>{if(!n.supportsWindow())return r(void 0);const o=100,e=Date.now(),s=()=>{const g=globalThis.window.FingerprintJS;if(g)return r(g);if(Date.now()-e>=t)return r(void 0);setTimeout(s,o)};s()})}exports.fingerprintjsPlugin=p;exports.getFingerprintVisitorId=u;
+"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;

package/dist/esm/index.js

@@ -1,55 +1,40 @@
-import { createStorageKey as u, supportsWindow as s, sessionStore as o } from "@picked/client";
-const n = u("fingerprintjs", "global"), f = () => ({
+import { createStorageKey as d, supportsWindow as s, sessionStore as e } from "@picked/client";
+const o = d("fingerprintjs", "global"), p = () => ({
   name: "fingerprintjs-plugin",
   setup: () => {
-    if (console.log("====> [fingerprintjsPlugin] Setting up FingerprintJS plugin"), !s()) {
-      console.log("====> [fingerprintjsPlugin] Window is not supported");
-      return;
-    }
-    d(1e4).then((i) => {
-      if (!i) {
-        console.log("====> [fingerprintjsPlugin] FingerprintJS not found on window after retry"), o.set(n, void 0);
+    s() && g(1e4).then((n) => {
+      if (!n) {
+        e.set(o, void 0);
         return;
       }
-      i.load().then(({ get: e }) => {
-        e().then(({ visitorId: r }) => {
-          o.set(n, r), console.log(
-            "====> [fingerprintjsPlugin] FingerprintJS visitorId stored:",
-            n,
-            r
-          );
+      n.load().then(({ get: i }) => {
+        i().then(({ visitorId: r }) => {
+          e.set(o, r);
         });
       });
     });
   }
 });
 function c() {
-  if (!s()) {
-    console.log("====> [getFingerprintVisitorId] Window is not supported");
-    return;
-  }
-  return console.log(
-    "====> [getFingerprintVisitorId] Retrieving FingerprintJS visitorId from session store:",
-    n,
-    o.get(n).text()
-  ), o.get(n);
+  var t;
+  return s() ? ((t = e.get(o)) == null ? void 0 : t.text()) ?? void 0 : void 0;
 }
-function d(i) {
+function g(n) {
   return new Promise((t) => {
     if (!s())
       return t(void 0);
-    const e = 100, r = Date.now(), g = () => {
-      const p = globalThis.window.FingerprintJS;
-      if (p)
-        return t(p);
-      if (Date.now() - r >= i)
+    const i = 100, r = Date.now(), u = () => {
+      const a = globalThis.window.FingerprintJS;
+      if (a)
+        return t(a);
+      if (Date.now() - r >= n)
         return t(void 0);
-      setTimeout(g, e);
+      setTimeout(u, i);
     };
-    g();
+    u();
   });
 }
 export {
-  f as fingerprintjsPlugin,
+  p as fingerprintjsPlugin,
   c as getFingerprintVisitorId
 };

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-import { StorageItem, Plugin } from '@picked/client';
+import { Plugin } from '@picked/client';
 declare global {
     interface Window {
         FingerprintJS?: FingerprintJS;
@@ -24,6 +24,6 @@ export declare const fingerprintjsPlugin: () => Plugin;
  *
  * @returns StorageItem<string | undefined> The stored visitorId or undefined if not present.
  */
-export declare function getFingerprintVisitorId(): StorageItem<string | undefined> | undefined;
+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,EAGL,KAAK,WAAW,EAEhB,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,MAiCtC,CAAA;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,WAAW,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAYrF"}
+{"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"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@picked/fingerprintjs",
   "description": "Fingerprintjs plugin",
-  "version": "0.0.1-dev.1764699646503",
+  "version": "0.0.1-dev.1764710808992",
   "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.1764699646503"
+    "@picked/client": "0.0.1-dev.1764710808992"
   },
   "private": false,
   "scripts": {