@guidelytech/nextjs 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# @guidelytech/nextjs
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Next.js App Router helpers. Re-exports everything from `@guidelytech/react` and adds the explicit
+route-change bridge.
+
+```bash
+pnpm add @guidelytech/nextjs
+```
+
+```tsx
+// app/providers.tsx
+"use client";
+import { GuidelyProvider, GuidelyNavigationListener, guidelyEnv } from "@guidelytech/nextjs";
+
+export function Providers({ children }: { children: React.ReactNode }) {
+  return (
+    <GuidelyProvider
+      projectId={process.env.NEXT_PUBLIC_GUIDELY_PROJECT_ID!}
+      environment={process.env.NEXT_PUBLIC_GUIDELY_ENV as "development"}
+      apiUrl={process.env.NEXT_PUBLIC_GUIDELY_API_URL}
+    >
+      <GuidelyNavigationListener />
+      {children}
+    </GuidelyProvider>
+  );
+}
+```
+
+| Export | Description |
+|---|---|
+| `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. |
+| `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. |
+| everything from `@guidelytech/react` | `GuidelyProvider`, `useGuidely`, `useGuidelyReady`, `useGuidelyIdentify`, `useGuidelyEvent`, `useChecklistProgress`, `useGuideState`. |
+
+The built output carries a `"use client"` banner; import it only from client components.

package/dist/index.cjs

@@ -0,0 +1,65 @@
+"use client";
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.tsx
+var index_exports = {};
+__export(index_exports, {
+  GuidelyNavigationListener: () => GuidelyNavigationListener,
+  guidelyEnv: () => guidelyEnv
+});
+module.exports = __toCommonJS(index_exports);
+var import_react = require("@guidelytech/react");
+var import_navigation = require("next/navigation");
+var import_react2 = require("react");
+__reExport(index_exports, require("@guidelytech/react"), module.exports);
+var import_jsx_runtime = require("react/jsx-runtime");
+function Listener() {
+  const client = (0, import_react.useGuidely)();
+  const pathname = (0, import_navigation.usePathname)();
+  const search = (0, import_navigation.useSearchParams)();
+  const query = search?.toString() ?? "";
+  const first = (0, import_react2.useRef)(true);
+  (0, import_react2.useEffect)(() => {
+    if (first.current) {
+      first.current = false;
+      return;
+    }
+    client.page(typeof window !== "undefined" ? window.location.href : pathname + (query ? `?${query}` : ""));
+  }, [pathname, query]);
+  return null;
+}
+function GuidelyNavigationListener() {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_react2.Suspense, { fallback: null, children: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(Listener, {}) });
+}
+function guidelyEnv(env = typeof process !== "undefined" ? process.env : {}) {
+  return {
+    projectId: env.NEXT_PUBLIC_GUIDELY_PROJECT_ID ?? "",
+    environment: env.NEXT_PUBLIC_GUIDELY_ENV ?? void 0,
+    apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || void 0
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  GuidelyNavigationListener,
+  guidelyEnv,
+  ...require("@guidelytech/react")
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +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,EAC7C;AACF;","names":["import_react"]}

package/dist/index.d.cts

@@ -0,0 +1,17 @@
+import * as react$1 from 'react';
+export * from '@guidelytech/react';
+
+/**
+ * Explicit App Router navigation bridge: calls `client.page()` whenever the pathname or search
+ * params change. Wrapped in `Suspense` because `useSearchParams` requires it. sdk-core also
+ * detects navigation through the History API, so this is belt and braces.
+ */
+declare function GuidelyNavigationListener(): react$1.JSX.Element;
+/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables into provider props. */
+declare function guidelyEnv(env?: Record<string, string | undefined>): {
+    projectId: string;
+    environment: "development" | "staging" | "production" | undefined;
+    apiUrl: string | undefined;
+};
+
+export { GuidelyNavigationListener, guidelyEnv };

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import * as react$1 from 'react';
+export * from '@guidelytech/react';
+
+/**
+ * Explicit App Router navigation bridge: calls `client.page()` whenever the pathname or search
+ * params change. Wrapped in `Suspense` because `useSearchParams` requires it. sdk-core also
+ * detects navigation through the History API, so this is belt and braces.
+ */
+declare function GuidelyNavigationListener(): react$1.JSX.Element;
+/** Reads the public `NEXT_PUBLIC_GUIDELY_*` environment variables into provider props. */
+declare function guidelyEnv(env?: Record<string, string | undefined>): {
+    projectId: string;
+    environment: "development" | "staging" | "production" | undefined;
+    apiUrl: string | undefined;
+};
+
+export { GuidelyNavigationListener, guidelyEnv };

package/dist/index.js

@@ -0,0 +1,38 @@
+"use client";
+
+// src/index.tsx
+import { useGuidely } from "@guidelytech/react";
+import { usePathname, useSearchParams } from "next/navigation";
+import { Suspense, useEffect, useRef } from "react";
+export * from "@guidelytech/react";
+import { jsx } from "react/jsx-runtime";
+function Listener() {
+  const client = useGuidely();
+  const pathname = usePathname();
+  const search = useSearchParams();
+  const query = search?.toString() ?? "";
+  const first = useRef(true);
+  useEffect(() => {
+    if (first.current) {
+      first.current = false;
+      return;
+    }
+    client.page(typeof window !== "undefined" ? window.location.href : pathname + (query ? `?${query}` : ""));
+  }, [pathname, query]);
+  return null;
+}
+function GuidelyNavigationListener() {
+  return /* @__PURE__ */ jsx(Suspense, { fallback: null, children: /* @__PURE__ */ jsx(Listener, {}) });
+}
+function guidelyEnv(env = typeof process !== "undefined" ? process.env : {}) {
+  return {
+    projectId: env.NEXT_PUBLIC_GUIDELY_PROJECT_ID ?? "",
+    environment: env.NEXT_PUBLIC_GUIDELY_ENV ?? void 0,
+    apiUrl: env.NEXT_PUBLIC_GUIDELY_API_URL || void 0
+  };
+}
+export {
+  GuidelyNavigationListener,
+  guidelyEnv
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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,EAC7C;AACF;","names":[]}

package/package.json

@@ -1,6 +1,71 @@
 {
   "name": "@guidelytech/nextjs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "Next.js App Router helpers for Guidely",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@guidelytech/react": "0.2.0",
+    "@guidelytech/sdk-core": "0.2.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.7",
+    "happy-dom": "^17.6.3",
+    "eslint": "^9.39.5",
+    "@eslint/js": "^9.39.5",
+    "typescript-eslint": "^8.46.0",
+    "react": "19.1.10",
+    "react-dom": "19.1.10",
+    "@types/react": "^19.1.0",
+    "next": "15.5.28"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "next": ">=13.4.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/parmarg/Guidely.git",
+    "directory": "packages/nextjs"
+  },
+  "homepage": "https://github.com/parmarg/Guidely/tree/main/packages/nextjs#readme",
+  "bugs": {
+    "url": "https://github.com/parmarg/Guidely/issues"
+  },
+  "keywords": [
+    "guidely",
+    "product-adoption",
+    "onboarding",
+    "product-tour",
+    "in-app-guidance",
+    "nextjs"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "lint": "eslint src",
+    "clean": "rm -rf dist"
+  }
 }