@knocklabs/react 0.9.2 → 0.9.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.9.3
+
+### Patch Changes
+
+- 79d7608: [guide] add KnockGuideLocationSensor helper component for Tanstack Router
+
 ## 0.9.2
 
 ### Patch Changes

package/dist/cjs/tanstack/KnockGuideLocationSensor.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("@knocklabs/react-core"),r=require("@tanstack/react-router"),i=require("react"),u=require("../modules/core/utils.js"),s=e=>e&&typeof e=="object"&&"default"in e?e:{default:e},n=s(i),a=()=>{const{href:e}=r.useLocation(),{client:t}=c.useGuideContext();return n.default.useEffect(()=>{t.removeLocationChangeEventListeners()},[t]),n.default.useEffect(()=>{const o=u.checkForWindow();o&&t.setLocation(o.location.origin+e)},[t,e]),null};exports.KnockGuideLocationSensor=a;
+//# sourceMappingURL=KnockGuideLocationSensor.js.map

package/dist/cjs/tanstack/KnockGuideLocationSensor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnockGuideLocationSensor.js","sources":["../../../src/tanstack/KnockGuideLocationSensor.tsx"],"sourcesContent":["import { useGuideContext } from \"@knocklabs/react-core\";\nimport { useLocation } from \"@tanstack/react-router\";\nimport React from \"react\";\n\nimport { checkForWindow } from \"../modules/core/utils\";\n\nexport const KnockGuideLocationSensor: React.FC = () => {\n  const { href } = useLocation();\n  const { client } = useGuideContext();\n\n  React.useEffect(() => {\n    client.removeLocationChangeEventListeners();\n  }, [client]);\n\n  React.useEffect(() => {\n    const win = checkForWindow();\n    if (!win) return;\n\n    // href here is the full path of the location, including pathname, search,\n    // and hash but does not include the origin.\n    client.setLocation(win.location.origin + href);\n  }, [client, href]);\n\n  return null;\n};\n"],"names":["KnockGuideLocationSensor","href","useLocation","client","useGuideContext","React","useEffect","removeLocationChangeEventListeners","win","checkForWindow","setLocation","location","origin"],"mappings":"qRAMaA,EAAqCA,IAAM,CAChD,KAAA,CAAEC,KAAAA,GAASC,cAAY,EACvB,CAAEC,OAAAA,GAAWC,kBAAgB,EAEnCC,OAAAA,EAAAA,QAAMC,UAAU,IAAM,CACpBH,EAAOI,mCAAmC,CAAA,EACzC,CAACJ,CAAM,CAAC,EAEXE,EAAAA,QAAMC,UAAU,IAAM,CACpB,MAAME,EAAMC,EAAAA,eAAe,EACtBD,GAILL,EAAOO,YAAYF,EAAIG,SAASC,OAASX,CAAI,CAAA,EAC5C,CAACE,EAAQF,CAAI,CAAC,EAEV,IACT"}

package/dist/cjs/tanstack.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("./tanstack/KnockGuideLocationSensor.js");exports.KnockGuideLocationSensor=o.KnockGuideLocationSensor;
+//# sourceMappingURL=tanstack.js.map

package/dist/cjs/tanstack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tanstack.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/esm/tanstack/KnockGuideLocationSensor.mjs

@@ -0,0 +1,21 @@
+import { useGuideContext as r } from "@knocklabs/react-core";
+import { useLocation as i } from "@tanstack/react-router";
+import n from "react";
+import { checkForWindow as c } from "../modules/core/utils.mjs";
+const a = () => {
+  const {
+    href: t
+  } = i(), {
+    client: o
+  } = r();
+  return n.useEffect(() => {
+    o.removeLocationChangeEventListeners();
+  }, [o]), n.useEffect(() => {
+    const e = c();
+    e && o.setLocation(e.location.origin + t);
+  }, [o, t]), null;
+};
+export {
+  a as KnockGuideLocationSensor
+};
+//# sourceMappingURL=KnockGuideLocationSensor.mjs.map

package/dist/esm/tanstack/KnockGuideLocationSensor.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnockGuideLocationSensor.mjs","sources":["../../../src/tanstack/KnockGuideLocationSensor.tsx"],"sourcesContent":["import { useGuideContext } from \"@knocklabs/react-core\";\nimport { useLocation } from \"@tanstack/react-router\";\nimport React from \"react\";\n\nimport { checkForWindow } from \"../modules/core/utils\";\n\nexport const KnockGuideLocationSensor: React.FC = () => {\n  const { href } = useLocation();\n  const { client } = useGuideContext();\n\n  React.useEffect(() => {\n    client.removeLocationChangeEventListeners();\n  }, [client]);\n\n  React.useEffect(() => {\n    const win = checkForWindow();\n    if (!win) return;\n\n    // href here is the full path of the location, including pathname, search,\n    // and hash but does not include the origin.\n    client.setLocation(win.location.origin + href);\n  }, [client, href]);\n\n  return null;\n};\n"],"names":["KnockGuideLocationSensor","href","useLocation","client","useGuideContext","React","useEffect","removeLocationChangeEventListeners","win","checkForWindow","setLocation","location","origin"],"mappings":";;;;AAMO,MAAMA,IAAqCA,MAAM;AAChD,QAAA;AAAA,IAAEC,MAAAA;AAAAA,MAASC,EAAY,GACvB;AAAA,IAAEC,QAAAA;AAAAA,MAAWC,EAAgB;AAEnCC,SAAAA,EAAMC,UAAU,MAAM;AACpBH,IAAAA,EAAOI,mCAAmC;AAAA,EAAA,GACzC,CAACJ,CAAM,CAAC,GAEXE,EAAMC,UAAU,MAAM;AACpB,UAAME,IAAMC,EAAe;AAC3B,IAAKD,KAILL,EAAOO,YAAYF,EAAIG,SAASC,SAASX,CAAI;AAAA,EAAA,GAC5C,CAACE,GAAQF,CAAI,CAAC,GAEV;AACT;"}

package/dist/esm/tanstack.mjs

@@ -0,0 +1,5 @@
+import { KnockGuideLocationSensor as n } from "./tanstack/KnockGuideLocationSensor.mjs";
+export {
+  n as KnockGuideLocationSensor
+};
+//# sourceMappingURL=tanstack.mjs.map

package/dist/esm/tanstack.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tanstack.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/types/tanstack/KnockGuideLocationSensor.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+export declare const KnockGuideLocationSensor: React.FC;
+//# sourceMappingURL=KnockGuideLocationSensor.d.ts.map

package/dist/types/tanstack/KnockGuideLocationSensor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnockGuideLocationSensor.d.ts","sourceRoot":"","sources":["../../../src/tanstack/KnockGuideLocationSensor.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,eAAO,MAAM,wBAAwB,EAAE,KAAK,CAAC,EAkB5C,CAAC"}

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

@@ -0,0 +1,2 @@
+export { KnockGuideLocationSensor } from './KnockGuideLocationSensor';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tanstack/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@knocklabs/react",
   "description": "A set of React components to build notification experiences powered by Knock",
   "author": "@knocklabs",
-  "version": "0.9.2",
+  "version": "0.9.3",
   "license": "MIT",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.mjs",
@@ -22,6 +22,12 @@
       "types": "./dist/types/next/index.d.ts",
       "import": "./dist/esm/next.mjs",
       "default": "./dist/cjs/next.js"
+    },
+    "./tanstack": {
+      "require": "./dist/cjs/tanstack.js",
+      "types": "./dist/types/tanstack/index.d.ts",
+      "import": "./dist/esm/tanstack.mjs",
+      "default": "./dist/cjs/tanstack.js"
     }
   },
   "files": [
@@ -52,11 +58,15 @@
     "url": "https://github.com/knocklabs/javascript/issues"
   },
   "peerDependencies": {
+    "@tanstack/react-router": "^1.0.0",
     "next": "^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
     "react": "^16.11.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
     "react-dom": "^16.11.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
   },
   "peerDependenciesMeta": {
+    "@tanstack/react-router": {
+      "optional": true
+    },
     "next": {
       "optional": true
     }
@@ -76,7 +86,8 @@
   },
   "devDependencies": {
     "@codecov/vite-plugin": "^1.9.1",
-    "@testing-library/dom": "^10.4.0",
+    "@tanstack/react-router": "1.134.12",
+    "@testing-library/dom": "^10.4.1",
     "@testing-library/react": "^16.3.0",
     "@types/eslint-plugin-jsx-a11y": "^6",
     "@types/lodash.debounce": "^4.0.9",
@@ -90,7 +101,7 @@
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.14",
-    "jsdom": "^27.0.0",
+    "jsdom": "^27.1.0",
     "next": "15.3.3",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",