@nexly/react-web 0.16.2 → 1.0.0

package/README.md

@@ -44,6 +44,7 @@ function App() {
 - **`appId`**, **`ingestKey`** — required strings (`ingestKey` is the ingest API token; not named `key` because that is reserved in React).
 - **`autoPageView`** (default `false`) — when a client exists, send one pageview on mount.
 - **`autoEngagement`** (default `false`) — when **`true`** and a client exists (all three strings non-empty after trim), attach engagement listeners; otherwise no-op. Cleanup on unmount or when the client or flag changes. The underlying `startEngagement()` is idempotent, so double-mounts (StrictMode, HMR) don't produce duplicate listeners.
+- **`privacyMode`** (default `false`) — never read or write `localStorage` for visitor / session identifiers. The Nexly collector derives a daily-rotating visit fingerprint server-side instead; supply your own IDs with `setVisitorId()` / `setSessionId()` from `@nexly/web` when you need stable cross-visit identity. See the [`@nexly/web` README](https://www.npmjs.com/package/@nexly/web) for details.
 
 ### Opting elements out of auto-capture
 

package/dist/nexly-provider.d.ts

@@ -26,9 +26,16 @@ export type NexlyProviderProps = {
      * change/unmount.
      */
     autoOutboundLinks?: boolean;
+    /**
+     * Privacy mode: never read or write `localStorage` for visitor / session
+     * identifiers. Without a manual `setVisitorId()` / `setSessionId()` the
+     * collector derives a daily-rotating visit fingerprint server-side.
+     * @default false
+     */
+    privacyMode?: boolean;
     children: ReactNode;
 };
-export declare function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView, autoEngagement, autoOutboundLinks, children, }: NexlyProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView, autoEngagement, autoOutboundLinks, privacyMode, children, }: NexlyProviderProps): import("react/jsx-runtime").JSX.Element;
 /** Returns the configured {@link Nexly} client, or `null` if credentials are incomplete. Must be used under {@link NexlyProvider}. */
 export declare function useNexlyClient(): Nexly | null;
 //# sourceMappingURL=nexly-provider.d.ts.map

package/dist/nexly-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nexly-provider.d.ts","sourceRoot":"","sources":["../src/nexly-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAiD,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AAIrF;;;;;;GAMG;AAEH,eAAO,MAAM,2BAA2B,sCAAgD,CAAA;AAExF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,8FAA8F;IAC9F,SAAS,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,+HAA+H;IAC/H,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,QAAQ,EAAE,SAAS,CAAA;CACpB,CAAA;AAED,wBAAgB,aAAa,CAAC,EAC5B,UAAU,EACV,KAAK,EACL,SAAS,EACT,YAAoB,EACpB,cAAsB,EACtB,iBAAyB,EACzB,QAAQ,GACT,EAAE,kBAAkB,2CAkCpB;AAED,sIAAsI;AACtI,wBAAgB,cAAc,IAAI,KAAK,GAAG,IAAI,CAE7C"}
+{"version":3,"file":"nexly-provider.d.ts","sourceRoot":"","sources":["../src/nexly-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAiD,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AAIrF;;;;;;GAMG;AAEH,eAAO,MAAM,2BAA2B,sCAAgD,CAAA;AAExF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,8FAA8F;IAC9F,SAAS,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,+HAA+H;IAC/H,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,EAAE,SAAS,CAAA;CACpB,CAAA;AAED,wBAAgB,aAAa,CAAC,EAC5B,UAAU,EACV,KAAK,EACL,SAAS,EACT,YAAoB,EACpB,cAAsB,EACtB,iBAAyB,EACzB,WAAmB,EACnB,QAAQ,GACT,EAAE,kBAAkB,2CAkCpB;AAED,sIAAsI;AACtI,wBAAgB,cAAc,IAAI,KAAK,GAAG,IAAI,CAE7C"}

package/dist/nexly-provider.js

@@ -12,7 +12,7 @@ const NexlyClientContext = createContext(null);
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const _NexlyClientIdentityContext = createContext(NexlyClient.React);
-export function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView = false, autoEngagement = false, autoOutboundLinks = false, children, }) {
+export function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView = false, autoEngagement = false, autoOutboundLinks = false, privacyMode = false, children, }) {
     const clientId = useContext(_NexlyClientIdentityContext);
     const nexly = useMemo(() => {
         const id = (appId ?? '').trim();
@@ -24,8 +24,8 @@ export function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView = fal
                 console.warn('[Nexly] Missing ingestKey — tracking is disabled.');
             return null;
         }
-        return Nexly.init({ collectUrl, appId: id, key: k, client: clientId });
-    }, [collectUrl, appId, ingestKey, clientId]);
+        return Nexly.init({ collectUrl, appId: id, key: k, client: clientId, privacyMode });
+    }, [collectUrl, appId, ingestKey, clientId, privacyMode]);
     useEffect(() => {
         if (autoPageView && nexly) {
             nexly.pageview();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexly/react-web",
-  "version": "0.16.2",
+  "version": "1.0.0",
   "description": "React bindings for Nexly (@nexly/web): provider, client hook, engagement, optional auto pageview",
   "license": "MIT",
   "keywords": [
@@ -39,7 +39,7 @@
     "react": "^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@nexly/web": "0.16.2"
+    "@nexly/web": "1.0.0"
   },
   "devDependencies": {
     "@types/react": "^19.2.14",