@guidelytech/nextjs 0.2.1 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +2 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@ export function Providers({ children }: { children: React.ReactNode }) {
|
|
|
29
29
|
| Export | Description |
|
|
30
30
|
|---|---|
|
|
31
31
|
| `GuidelyNavigationListener` | Client component using `usePathname`/`useSearchParams` (wrapped in `Suspense`) to call `client.page()` on every route change. sdk-core also detects History API navigation; this is the explicit bridge. |
|
|
32
|
-
| `guidelyEnv(env?)` | Reads `NEXT_PUBLIC_GUIDELY_PROJECT_ID`, `NEXT_PUBLIC_GUIDELY_ENV`, `NEXT_PUBLIC_GUIDELY_API_URL` into provider props. Note: Next.js inlines `process.env.NEXT_PUBLIC_*` only when referenced literally, so pass them explicitly in your own code as shown above. |
|
|
32
|
+
| `guidelyEnv(env?)` | Reads `NEXT_PUBLIC_GUIDELY_PROJECT_ID`, `NEXT_PUBLIC_GUIDELY_ENV`, `NEXT_PUBLIC_GUIDELY_API_URL`, `NEXT_PUBLIC_GUIDELY_RELEASE` into provider props (`release` selects the source maps uploaded with `@guidelytech/sourcemaps`). Note: Next.js inlines `process.env.NEXT_PUBLIC_*` only when referenced literally, so pass them explicitly in your own code as shown above. |
|
|
33
33
|
| everything from `@guidelytech/react` | `GuidelyProvider`, `useGuidely`, `useGuidelyReady`, `useGuidelyIdentify`, `useGuidelyEvent`, `useChecklistProgress`, `useGuideState`. |
|
|
34
34
|
|
|
35
35
|
The built output carries a `"use client"` banner; import it only from client components.
|
package/dist/index.cjs
CHANGED
|
@@ -53,7 +53,8 @@ function guidelyEnv(env = typeof process !== "undefined" ? process.env : {}) {
|
|
|
53
53
|
return {
|
|
54
54
|
projectId: env.NEXT_PUBLIC_GUIDELY_PROJECT_ID ?? "",
|
|
55
55
|
environment: env.NEXT_PUBLIC_GUIDELY_ENV ?? void 0,
|
|
56
|
-
apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || void 0
|
|
56
|
+
apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || void 0,
|
|
57
|
+
release: env.NEXT_PUBLIC_GUIDELY_RELEASE || void 0
|
|
57
58
|
};
|
|
58
59
|
}
|
|
59
60
|
// Annotate the CommonJS export names for ESM import in node:
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.tsx"],"sourcesContent":["import { useGuidely } from \"@guidelytech/react\";\nimport { usePathname, useSearchParams } from \"next/navigation\";\nimport { Suspense, useEffect, useRef } from \"react\";\n\nexport * from \"@guidelytech/react\";\n\nfunction Listener() {\n const client = useGuidely();\n const pathname = usePathname();\n const search = useSearchParams();\n const query = search?.toString() ?? \"\";\n const first = useRef(true);\n useEffect(() => {\n if (first.current) {\n first.current = false;\n return;\n }\n client.page(typeof window !== \"undefined\" ? window.location.href : pathname + (query ? `?${query}` : \"\"));\n }, [pathname, query]);\n return null;\n}\n\n/**\n * Explicit App Router navigation bridge: calls `client.page()` whenever the pathname or search\n * params change. Wrapped in `Suspense` because `useSearchParams` requires it. sdk-core also\n * detects navigation through the History API, so this is belt and braces.\n */\nexport function GuidelyNavigationListener() {\n return (\n <Suspense fallback={null}>\n <Listener />\n </Suspense>\n );\n}\n\n/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables into provider props. */\nexport function guidelyEnv(env: Record<string, string | undefined> = typeof process !== \"undefined\" ? process.env : {}) {\n return {\n projectId: env.NEXT_PUBLIC_GUIDELY_PROJECT_ID ?? \"\",\n environment: (env.NEXT_PUBLIC_GUIDELY_ENV as \"development\" | \"staging\" | \"production\" | undefined) ?? undefined,\n apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || undefined,\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAA2B;AAC3B,wBAA6C;AAC7C,IAAAA,gBAA4C;AAE5C,0BAAc,+BAJd;AA8BM;AAxBN,SAAS,WAAW;AAClB,QAAM,aAAS,yBAAW;AAC1B,QAAM,eAAW,+BAAY;AAC7B,QAAM,aAAS,mCAAgB;AAC/B,QAAM,QAAQ,QAAQ,SAAS,KAAK;AACpC,QAAM,YAAQ,sBAAO,IAAI;AACzB,+BAAU,MAAM;AACd,QAAI,MAAM,SAAS;AACjB,YAAM,UAAU;AAChB;AAAA,IACF;AACA,WAAO,KAAK,OAAO,WAAW,cAAc,OAAO,SAAS,OAAO,YAAY,QAAQ,IAAI,KAAK,KAAK,GAAG;AAAA,EAC1G,GAAG,CAAC,UAAU,KAAK,CAAC;AACpB,SAAO;AACT;AAOO,SAAS,4BAA4B;AAC1C,SACE,4CAAC,0BAAS,UAAU,MAClB,sDAAC,YAAS,GACZ;AAEJ;AAGO,SAAS,WAAW,MAA0C,OAAO,YAAY,cAAc,QAAQ,MAAM,CAAC,GAAG;AACtH,SAAO;AAAA,IACL,WAAW,IAAI,kCAAkC;AAAA,IACjD,aAAc,IAAI,2BAAoF;AAAA,IACtG,QAAQ,IAAI,+BAA+B;AAAA,
|
|
1
|
+
{"version":3,"sources":["../src/index.tsx"],"sourcesContent":["import { useGuidely } from \"@guidelytech/react\";\nimport { usePathname, useSearchParams } from \"next/navigation\";\nimport { Suspense, useEffect, useRef } from \"react\";\n\nexport * from \"@guidelytech/react\";\n\nfunction Listener() {\n const client = useGuidely();\n const pathname = usePathname();\n const search = useSearchParams();\n const query = search?.toString() ?? \"\";\n const first = useRef(true);\n useEffect(() => {\n if (first.current) {\n first.current = false;\n return;\n }\n client.page(typeof window !== \"undefined\" ? window.location.href : pathname + (query ? `?${query}` : \"\"));\n }, [pathname, query]);\n return null;\n}\n\n/**\n * Explicit App Router navigation bridge: calls `client.page()` whenever the pathname or search\n * params change. Wrapped in `Suspense` because `useSearchParams` requires it. sdk-core also\n * detects navigation through the History API, so this is belt and braces.\n */\nexport function GuidelyNavigationListener() {\n return (\n <Suspense fallback={null}>\n <Listener />\n </Suspense>\n );\n}\n\n/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables (project id, env, API URL, release) into provider props. */\nexport function guidelyEnv(env: Record<string, string | undefined> = typeof process !== \"undefined\" ? process.env : {}) {\n return {\n projectId: env.NEXT_PUBLIC_GUIDELY_PROJECT_ID ?? \"\",\n environment: (env.NEXT_PUBLIC_GUIDELY_ENV as \"development\" | \"staging\" | \"production\" | undefined) ?? undefined,\n apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || undefined,\n release: env.NEXT_PUBLIC_GUIDELY_RELEASE || undefined,\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAA2B;AAC3B,wBAA6C;AAC7C,IAAAA,gBAA4C;AAE5C,0BAAc,+BAJd;AA8BM;AAxBN,SAAS,WAAW;AAClB,QAAM,aAAS,yBAAW;AAC1B,QAAM,eAAW,+BAAY;AAC7B,QAAM,aAAS,mCAAgB;AAC/B,QAAM,QAAQ,QAAQ,SAAS,KAAK;AACpC,QAAM,YAAQ,sBAAO,IAAI;AACzB,+BAAU,MAAM;AACd,QAAI,MAAM,SAAS;AACjB,YAAM,UAAU;AAChB;AAAA,IACF;AACA,WAAO,KAAK,OAAO,WAAW,cAAc,OAAO,SAAS,OAAO,YAAY,QAAQ,IAAI,KAAK,KAAK,GAAG;AAAA,EAC1G,GAAG,CAAC,UAAU,KAAK,CAAC;AACpB,SAAO;AACT;AAOO,SAAS,4BAA4B;AAC1C,SACE,4CAAC,0BAAS,UAAU,MAClB,sDAAC,YAAS,GACZ;AAEJ;AAGO,SAAS,WAAW,MAA0C,OAAO,YAAY,cAAc,QAAQ,MAAM,CAAC,GAAG;AACtH,SAAO;AAAA,IACL,WAAW,IAAI,kCAAkC;AAAA,IACjD,aAAc,IAAI,2BAAoF;AAAA,IACtG,QAAQ,IAAI,+BAA+B;AAAA,IAC3C,SAAS,IAAI,+BAA+B;AAAA,EAC9C;AACF;","names":["import_react"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -7,11 +7,12 @@ export * from '@guidelytech/react';
|
|
|
7
7
|
* detects navigation through the History API, so this is belt and braces.
|
|
8
8
|
*/
|
|
9
9
|
declare function GuidelyNavigationListener(): react$1.JSX.Element;
|
|
10
|
-
/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables into provider props. */
|
|
10
|
+
/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables (project id, env, API URL, release) into provider props. */
|
|
11
11
|
declare function guidelyEnv(env?: Record<string, string | undefined>): {
|
|
12
12
|
projectId: string;
|
|
13
13
|
environment: "development" | "staging" | "production" | undefined;
|
|
14
14
|
apiUrl: string | undefined;
|
|
15
|
+
release: string | undefined;
|
|
15
16
|
};
|
|
16
17
|
|
|
17
18
|
export { GuidelyNavigationListener, guidelyEnv };
|
package/dist/index.d.ts
CHANGED
|
@@ -7,11 +7,12 @@ export * from '@guidelytech/react';
|
|
|
7
7
|
* detects navigation through the History API, so this is belt and braces.
|
|
8
8
|
*/
|
|
9
9
|
declare function GuidelyNavigationListener(): react$1.JSX.Element;
|
|
10
|
-
/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables into provider props. */
|
|
10
|
+
/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables (project id, env, API URL, release) into provider props. */
|
|
11
11
|
declare function guidelyEnv(env?: Record<string, string | undefined>): {
|
|
12
12
|
projectId: string;
|
|
13
13
|
environment: "development" | "staging" | "production" | undefined;
|
|
14
14
|
apiUrl: string | undefined;
|
|
15
|
+
release: string | undefined;
|
|
15
16
|
};
|
|
16
17
|
|
|
17
18
|
export { GuidelyNavigationListener, guidelyEnv };
|
package/dist/index.js
CHANGED
|
@@ -28,7 +28,8 @@ function guidelyEnv(env = typeof process !== "undefined" ? process.env : {}) {
|
|
|
28
28
|
return {
|
|
29
29
|
projectId: env.NEXT_PUBLIC_GUIDELY_PROJECT_ID ?? "",
|
|
30
30
|
environment: env.NEXT_PUBLIC_GUIDELY_ENV ?? void 0,
|
|
31
|
-
apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || void 0
|
|
31
|
+
apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || void 0,
|
|
32
|
+
release: env.NEXT_PUBLIC_GUIDELY_RELEASE || void 0
|
|
32
33
|
};
|
|
33
34
|
}
|
|
34
35
|
export {
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.tsx"],"sourcesContent":["import { useGuidely } from \"@guidelytech/react\";\nimport { usePathname, useSearchParams } from \"next/navigation\";\nimport { Suspense, useEffect, useRef } from \"react\";\n\nexport * from \"@guidelytech/react\";\n\nfunction Listener() {\n const client = useGuidely();\n const pathname = usePathname();\n const search = useSearchParams();\n const query = search?.toString() ?? \"\";\n const first = useRef(true);\n useEffect(() => {\n if (first.current) {\n first.current = false;\n return;\n }\n client.page(typeof window !== \"undefined\" ? window.location.href : pathname + (query ? `?${query}` : \"\"));\n }, [pathname, query]);\n return null;\n}\n\n/**\n * Explicit App Router navigation bridge: calls `client.page()` whenever the pathname or search\n * params change. Wrapped in `Suspense` because `useSearchParams` requires it. sdk-core also\n * detects navigation through the History API, so this is belt and braces.\n */\nexport function GuidelyNavigationListener() {\n return (\n <Suspense fallback={null}>\n <Listener />\n </Suspense>\n );\n}\n\n/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables into provider props. */\nexport function guidelyEnv(env: Record<string, string | undefined> = typeof process !== \"undefined\" ? process.env : {}) {\n return {\n projectId: env.NEXT_PUBLIC_GUIDELY_PROJECT_ID ?? \"\",\n environment: (env.NEXT_PUBLIC_GUIDELY_ENV as \"development\" | \"staging\" | \"production\" | undefined) ?? undefined,\n apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || undefined,\n };\n}\n"],"mappings":";;;AAAA,SAAS,kBAAkB;AAC3B,SAAS,aAAa,uBAAuB;AAC7C,SAAS,UAAU,WAAW,cAAc;AAE5C,cAAc;AA0BR;AAxBN,SAAS,WAAW;AAClB,QAAM,SAAS,WAAW;AAC1B,QAAM,WAAW,YAAY;AAC7B,QAAM,SAAS,gBAAgB;AAC/B,QAAM,QAAQ,QAAQ,SAAS,KAAK;AACpC,QAAM,QAAQ,OAAO,IAAI;AACzB,YAAU,MAAM;AACd,QAAI,MAAM,SAAS;AACjB,YAAM,UAAU;AAChB;AAAA,IACF;AACA,WAAO,KAAK,OAAO,WAAW,cAAc,OAAO,SAAS,OAAO,YAAY,QAAQ,IAAI,KAAK,KAAK,GAAG;AAAA,EAC1G,GAAG,CAAC,UAAU,KAAK,CAAC;AACpB,SAAO;AACT;AAOO,SAAS,4BAA4B;AAC1C,SACE,oBAAC,YAAS,UAAU,MAClB,8BAAC,YAAS,GACZ;AAEJ;AAGO,SAAS,WAAW,MAA0C,OAAO,YAAY,cAAc,QAAQ,MAAM,CAAC,GAAG;AACtH,SAAO;AAAA,IACL,WAAW,IAAI,kCAAkC;AAAA,IACjD,aAAc,IAAI,2BAAoF;AAAA,IACtG,QAAQ,IAAI,+BAA+B;AAAA,
|
|
1
|
+
{"version":3,"sources":["../src/index.tsx"],"sourcesContent":["import { useGuidely } from \"@guidelytech/react\";\nimport { usePathname, useSearchParams } from \"next/navigation\";\nimport { Suspense, useEffect, useRef } from \"react\";\n\nexport * from \"@guidelytech/react\";\n\nfunction Listener() {\n const client = useGuidely();\n const pathname = usePathname();\n const search = useSearchParams();\n const query = search?.toString() ?? \"\";\n const first = useRef(true);\n useEffect(() => {\n if (first.current) {\n first.current = false;\n return;\n }\n client.page(typeof window !== \"undefined\" ? window.location.href : pathname + (query ? `?${query}` : \"\"));\n }, [pathname, query]);\n return null;\n}\n\n/**\n * Explicit App Router navigation bridge: calls `client.page()` whenever the pathname or search\n * params change. Wrapped in `Suspense` because `useSearchParams` requires it. sdk-core also\n * detects navigation through the History API, so this is belt and braces.\n */\nexport function GuidelyNavigationListener() {\n return (\n <Suspense fallback={null}>\n <Listener />\n </Suspense>\n );\n}\n\n/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables (project id, env, API URL, release) into provider props. */\nexport function guidelyEnv(env: Record<string, string | undefined> = typeof process !== \"undefined\" ? process.env : {}) {\n return {\n projectId: env.NEXT_PUBLIC_GUIDELY_PROJECT_ID ?? \"\",\n environment: (env.NEXT_PUBLIC_GUIDELY_ENV as \"development\" | \"staging\" | \"production\" | undefined) ?? undefined,\n apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || undefined,\n release: env.NEXT_PUBLIC_GUIDELY_RELEASE || undefined,\n };\n}\n"],"mappings":";;;AAAA,SAAS,kBAAkB;AAC3B,SAAS,aAAa,uBAAuB;AAC7C,SAAS,UAAU,WAAW,cAAc;AAE5C,cAAc;AA0BR;AAxBN,SAAS,WAAW;AAClB,QAAM,SAAS,WAAW;AAC1B,QAAM,WAAW,YAAY;AAC7B,QAAM,SAAS,gBAAgB;AAC/B,QAAM,QAAQ,QAAQ,SAAS,KAAK;AACpC,QAAM,QAAQ,OAAO,IAAI;AACzB,YAAU,MAAM;AACd,QAAI,MAAM,SAAS;AACjB,YAAM,UAAU;AAChB;AAAA,IACF;AACA,WAAO,KAAK,OAAO,WAAW,cAAc,OAAO,SAAS,OAAO,YAAY,QAAQ,IAAI,KAAK,KAAK,GAAG;AAAA,EAC1G,GAAG,CAAC,UAAU,KAAK,CAAC;AACpB,SAAO;AACT;AAOO,SAAS,4BAA4B;AAC1C,SACE,oBAAC,YAAS,UAAU,MAClB,8BAAC,YAAS,GACZ;AAEJ;AAGO,SAAS,WAAW,MAA0C,OAAO,YAAY,cAAc,QAAQ,MAAM,CAAC,GAAG;AACtH,SAAO;AAAA,IACL,WAAW,IAAI,kCAAkC;AAAA,IACjD,aAAc,IAAI,2BAAoF;AAAA,IACtG,QAAQ,IAAI,+BAA+B;AAAA,IAC3C,SAAS,IAAI,+BAA+B;AAAA,EAC9C;AACF;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@guidelytech/nextjs",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "Next.js App Router helpers for Guidely",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -20,8 +20,8 @@
|
|
|
20
20
|
"README.md"
|
|
21
21
|
],
|
|
22
22
|
"dependencies": {
|
|
23
|
-
"@guidelytech/react": "0.
|
|
24
|
-
"@guidelytech/sdk-core": "0.
|
|
23
|
+
"@guidelytech/react": "0.4.1",
|
|
24
|
+
"@guidelytech/sdk-core": "0.4.1"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
27
|
"tsup": "^8.5.1",
|