@posthog/wizard 0.2.2

package/LICENSE

@@ -0,0 +1,47 @@
+MIT License
+
+Copyright (c) 2025 PostHog
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+--------------------------------------------------------------------------------
+
+Portions of this software are derived from Sentry’s codebase located at https://github.com/getsentry/sentry-wizard and are used under the terms of the MIT License provided below:
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+
+<p align="center">
+  <img alt="posthoglogo" src="https://user-images.githubusercontent.com/65415371/205059737-c8a4f836-4889-4654-902e-f302b187b6a0.png">
+</p>
+
+> **⚠️ Experimental:** This wizard is still in an experimental phase. 
+> If you have any feedback, please drop an email to **joshua** [at] **posthog** [dot] **com**.
+
+<h1>PostHog Wizard</h1>
+<h4>The PostHog Wizard helps you quickly add PostHog to your project.</h4>
+
+# Usage
+
+To use the wizard, you can run it directly using:
+
+```bash
+npx @posthog/wizard
+```
+
+Currently the wizard can be used for Next.js only. If you have other platforms you would like the wizard to support, please open a [GitHub issue](https://github.com/posthog/wizard/issues)!
+
+# Options
+
+The following CLI arguments are available:
+
+| Option            | Description                                           | Type    | Default                         | Choices  | Environment Variable         |
+| ----------------- | ----------------------------------------------------- | ------- | ------------------------------- | -------- | ---------------------------- |
+| `--help`          | Show help                                             | boolean |                                 |          |                              |
+| `--version`       | Show version number                                   | boolean |                                 |          |                              |
+| `--debug`         | Enable verbose logging                                | boolean | `false`                         |          | `POSTHOG_WIZARD_DEBUG`       |
+| `--integration`   | Choose the integration to setup                       | choices | Select integration during setup | "nextjs" | `POSTHOG_WIZARD_INTEGRATION` |
+| `--force-install` | Force install the SDK NPM package (use with caution!) | boolean | `false`                         |          |                              |
+
+> Note: A large amount of the scaffolding for this came from the amazing Sentry wizard, which you can find [here](https://github.com/getsentry/sentry-wizard) 💖

package/dist/bin.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const semver_1 = require("semver");
+const logging_1 = require("./src/utils/logging");
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+const NODE_VERSION_RANGE = '>=18.20.0';
+// Have to run this above the other imports because they are importing clack that
+// has the problematic imports.
+if (!(0, semver_1.satisfies)(process.version, NODE_VERSION_RANGE)) {
+    (0, logging_1.red)(`PostHog Wizard requires Node.js ${NODE_VERSION_RANGE}. You are using Node.js ${process.version}. Please upgrade your Node.js version.`);
+    process.exit(1);
+}
+const run_1 = require("./src/run");
+// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv)).options({
+    debug: {
+        default: false,
+        describe: 'Enable verbose logging\nenv: POSTHOG_WIZARD_DEBUG',
+        type: 'boolean',
+    },
+}).argv;
+void (0, run_1.run)(argv);
+//# sourceMappingURL=bin.js.map

package/dist/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../bin.ts"],"names":[],"mappings":";;;;;;AACA,mCAAmC;AACnC,iDAA0C;AAE1C,kDAA0B;AAC1B,2CAAwC;AAExC,MAAM,kBAAkB,GAAG,WAAW,CAAC;AAEvC,iFAAiF;AACjF,+BAA+B;AAC/B,IAAI,CAAC,IAAA,kBAAS,EAAC,OAAO,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC;IACpD,IAAA,aAAG,EACD,mCAAmC,kBAAkB,2BAA2B,OAAO,CAAC,OAAO,wCAAwC,CACxI,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AACD,mCAAgC;AAEhC,kJAAkJ;AAClJ,MAAM,IAAI,GAAG,IAAA,eAAK,EAAC,IAAA,iBAAO,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;IAChD,KAAK,EAAE;QACL,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,mDAAmD;QAC7D,IAAI,EAAE,SAAS;KAChB;CACF,CAAC,CAAC,IAAI,CAAC;AAER,KAAK,IAAA,SAAG,EAAC,IAAI,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\nimport { satisfies } from 'semver';\nimport { red } from './src/utils/logging';\n\nimport yargs from 'yargs';\nimport { hideBin } from 'yargs/helpers';\n\nconst NODE_VERSION_RANGE = '>=18.20.0';\n\n// Have to run this above the other imports because they are importing clack that\n// has the problematic imports.\nif (!satisfies(process.version, NODE_VERSION_RANGE)) {\n  red(\n    `PostHog Wizard requires Node.js ${NODE_VERSION_RANGE}. You are using Node.js ${process.version}. Please upgrade your Node.js version.`,\n  );\n  process.exit(1);\n}\nimport { run } from './src/run';\n\n// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call\nconst argv = yargs(hideBin(process.argv)).options({\n  debug: {\n    default: false,\n    describe: 'Enable verbose logging\\nenv: POSTHOG_WIZARD_DEBUG',\n    type: 'boolean',\n  },\n}).argv;\n\nvoid run(argv);\n"]}

package/dist/src/lib/constants.d.ts

@@ -0,0 +1,20 @@
+export declare enum Integration {
+    nextjs = "nextjs"
+}
+export declare function getIntegrationDescription(type: string): string;
+type IntegrationChoice = {
+    name: string;
+    value: string;
+};
+export declare function getIntegrationChoices(): IntegrationChoice[];
+export interface Args {
+    debug: boolean;
+    integration: Integration;
+}
+export declare const DEFAULT_URL = "http://us.posthog.com";
+export declare const ISSUES_URL = "https://github.com/posthog/wizard/issues";
+export declare const INSTALL_DIR: string;
+export declare const CLOUD_URL = "https://us.posthog.com";
+export declare const DEFAULT_HOST_URL = "https://us.i.posthog.com";
+export declare const DUMMY_PROJECT_API_KEY = "_YOUR_POSTHOG_PROJECT_API_KEY_";
+export {};

package/dist/src/lib/constants.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DUMMY_PROJECT_API_KEY = exports.DEFAULT_HOST_URL = exports.CLOUD_URL = exports.INSTALL_DIR = exports.ISSUES_URL = exports.DEFAULT_URL = exports.Integration = void 0;
+exports.getIntegrationDescription = getIntegrationDescription;
+exports.getIntegrationChoices = getIntegrationChoices;
+const path_1 = __importDefault(require("path"));
+var Integration;
+(function (Integration) {
+    Integration["nextjs"] = "nextjs";
+})(Integration || (exports.Integration = Integration = {}));
+function getIntegrationDescription(type) {
+    switch (type) {
+        case Integration.nextjs:
+            return 'Next.js';
+        default:
+            throw new Error(`Unknown integration ${type}`);
+    }
+}
+function getIntegrationChoices() {
+    return Object.keys(Integration).map((type) => ({
+        name: getIntegrationDescription(type),
+        value: type,
+    }));
+}
+exports.DEFAULT_URL = 'http://us.posthog.com';
+exports.ISSUES_URL = 'https://github.com/posthog/wizard/issues';
+exports.INSTALL_DIR = path_1.default.join(process.cwd(), process.env.POSTHOG_WIZARD_INSTALL_DIR ?? '');
+exports.CLOUD_URL = 'https://us.posthog.com';
+exports.DEFAULT_HOST_URL = 'https://us.i.posthog.com';
+exports.DUMMY_PROJECT_API_KEY = '_YOUR_POSTHOG_PROJECT_API_KEY_';
+//# sourceMappingURL=constants.js.map

package/dist/src/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/lib/constants.ts"],"names":[],"mappings":";;;;;;AAMA,8DAOC;AAOD,sDAKC;AAzBD,gDAAwB;AAExB,IAAY,WAEX;AAFD,WAAY,WAAW;IACrB,gCAAiB,CAAA;AACnB,CAAC,EAFW,WAAW,2BAAX,WAAW,QAEtB;AAED,SAAgB,yBAAyB,CAAC,IAAY;IACpD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,WAAW,CAAC,MAAM;YACrB,OAAO,SAAS,CAAC;QACnB;YACE,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,EAAE,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAOD,SAAgB,qBAAqB;IACnC,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC;QACrD,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;QACrC,KAAK,EAAE,IAAI;KACZ,CAAC,CAAC,CAAC;AACN,CAAC;AAOY,QAAA,WAAW,GAAG,uBAAuB,CAAC;AACtC,QAAA,UAAU,GAAG,0CAA0C,CAAC;AACxD,QAAA,WAAW,GAAG,cAAI,CAAC,IAAI,CAClC,OAAO,CAAC,GAAG,EAAE,EACb,OAAO,CAAC,GAAG,CAAC,0BAA0B,IAAI,EAAE,CAC7C,CAAC;AACW,QAAA,SAAS,GAAG,wBAAwB,CAAC;AACrC,QAAA,gBAAgB,GAAG,0BAA0B,CAAC;AAC9C,QAAA,qBAAqB,GAAG,gCAAgC,CAAC","sourcesContent":["import path from 'path';\n\nexport enum Integration {\n  nextjs = 'nextjs',\n}\n\nexport function getIntegrationDescription(type: string): string {\n  switch (type) {\n    case Integration.nextjs:\n      return 'Next.js';\n    default:\n      throw new Error(`Unknown integration ${type}`);\n  }\n}\n\ntype IntegrationChoice = {\n  name: string;\n  value: string;\n};\n\nexport function getIntegrationChoices(): IntegrationChoice[] {\n  return Object.keys(Integration).map((type: string) => ({\n    name: getIntegrationDescription(type),\n    value: type,\n  }));\n}\n\nexport interface Args {\n  debug: boolean;\n  integration: Integration;\n}\n\nexport const DEFAULT_URL = 'http://us.posthog.com';\nexport const ISSUES_URL = 'https://github.com/posthog/wizard/issues';\nexport const INSTALL_DIR = path.join(\n  process.cwd(),\n  process.env.POSTHOG_WIZARD_INSTALL_DIR ?? '',\n);\nexport const CLOUD_URL = 'https://us.posthog.com';\nexport const DEFAULT_HOST_URL = 'https://us.i.posthog.com';\nexport const DUMMY_PROJECT_API_KEY = '_YOUR_POSTHOG_PROJECT_API_KEY_';\n"]}

package/dist/src/nextjs/docs.d.ts

@@ -0,0 +1,8 @@
+export declare const getNextjsAppRouterDocs: ({ host, language, }: {
+    host: string;
+    language: "typescript" | "javascript";
+}) => string;
+export declare const getNextjsPagesRouterDocs: ({ host, language, }: {
+    host: string;
+    language: "typescript" | "javascript";
+}) => string;

package/dist/src/nextjs/docs.js

@@ -0,0 +1,235 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNextjsPagesRouterDocs = exports.getNextjsAppRouterDocs = void 0;
+const utils_1 = require("./utils");
+const getNextjsAppRouterDocs = ({ host, language, }) => {
+    return `
+==============================
+FILE: app/components/PostHogProvider.${language === 'typescript' ? 'tsx' : 'jsx'}
+==============================
+Changes:
+- Create a PostHogProvider component that will be imported into the layout file.
+
+Example:
+--------------------------------------------------
+'use client'
+
+import posthog from 'posthog-js'
+import { PostHogProvider as PHProvider, usePostHog } from 'posthog-js/react'
+import { Suspense, useEffect } from 'react'
+import { usePathname, useSearchParams } from "next/navigation"
+
+export function PostHogProvider({ children }: { children: React.ReactNode }) {
+  useEffect(() => {
+    posthog.init(process.env.NEXT_PUBLIC_POSTHOG_KEY!, {
+      api_host: "/ingest",
+      ui_host: process.env.NEXT_PUBLIC_POSTHOG_HOST,
+      capture_pageview: false, // We capture pageviews manually
+      capture_pageleave: true, // Enable pageleave capture
+    })
+  }, [])
+
+  return (
+    <PHProvider client={posthog}>
+      <SuspendedPostHogPageView />
+      {children}
+    </PHProvider>
+  )
+}
+
+
+function PostHogPageView() {
+  const pathname = usePathname()
+  const searchParams = useSearchParams()
+  const posthog = usePostHog()
+
+  useEffect(() => {
+    if (pathname && posthog) {
+      let url = window.origin + pathname
+      const search = searchParams.toString()
+      if (search) {
+        url += "?" + search
+      }
+      posthog.capture('$pageview', { '$current_url': url })
+    }
+  }, [pathname, searchParams, posthog])
+
+  return null
+}
+
+function SuspendedPostHogPageView() {
+  return (
+    <Suspense fallback={null}>
+      <PostHogPageView />
+    </Suspense>
+  )
+}
+--------------------------------------------------
+
+==============================
+FILE: app/layout.${language === 'typescript' ? 'tsx' : 'jsx'}
+==============================
+Changes:
+- Import the PostHogProvider from the providers file and wrap the app in it.
+
+Example:
+--------------------------------------------------
+// other imports
+import { PostHogProvider } from './components/providers'
+
+export default function RootLayout({ children }) {
+  return (
+    <html lang="en">
+      <body>
+        <PostHogProvider>
+          {/* other providers */}
+          {children}
+          {/* other providers */}
+        </PostHogProvider>
+      </body>
+    </html>
+  )
+}
+--------------------------------------------------
+
+==============================
+FILE: app/lib/server/posthog.${language === 'typescript' ? 'ts' : 'js'}
+==============================
+Changes:
+- Initialize the PostHog Node.js client
+
+Example:
+--------------------------------------------------
+import { PostHog } from 'posthog-node'
+
+export default function PostHogClient() {
+  const posthogClient = new PostHog(process.env.NEXT_PUBLIC_POSTHOG_KEY!, {
+    host: process.env.NEXT_PUBLIC_POSTHOG_HOST,
+    flushAt: 1,
+    flushInterval: 0,
+  })
+  return posthogClient
+}
+--------------------------------------------------
+
+==============================
+FILE: next.config.{js,ts,mjs,cjs}
+==============================
+Changes:
+- Add rewrites to the Next.js config to support PostHog, if there are existing rewrites, add the PostHog rewrites to them.
+- Add skipTrailingSlashRedirect to the Next.js config to support PostHog trailing slash API requests.
+- This can be of type js, ts, mjs, cjs etc. You should adapt the file according
+Example:
+--------------------------------------------------
+const nextConfig = {
+  // other config
+  async rewrites() {
+    return [
+      {
+        source: "/ingest/static/:path*",
+        destination: "${(0, utils_1.getAssetHostFromHost)(host)}/static/:path*",
+      },
+      {
+        source: "/ingest/:path*",
+        destination: "${host}/:path*",
+      },
+      {
+        source: "/ingest/decide",
+        destination: "${host}/decide",
+      },
+    ];
+  },
+  // This is required to support PostHog trailing slash API requests
+  skipTrailingSlashRedirect: true,
+}
+module.exports = nextConfig
+--------------------------------------------------`;
+};
+exports.getNextjsAppRouterDocs = getNextjsAppRouterDocs;
+const getNextjsPagesRouterDocs = ({ host, language, }) => {
+    return `
+==============================
+FILE: pages/_app.${language === 'typescript' ? 'tsx' : 'jsx'}
+==============================
+Changes:
+- Initialize PostHog in _app.js.
+- Wrap the application in PostHogProvider.
+- Manually capture $pageview events.
+
+Example:
+--------------------------------------------------
+import { useEffect } from 'react'
+import { Router } from 'next/router'
+import posthog from 'posthog-js'
+import { PostHogProvider } from 'posthog-js/react'
+
+export default function App({ Component, pageProps }) {
+  useEffect(() => {
+    posthog.init(process.env.NEXT_PUBLIC_POSTHOG_KEY, {
+      api_host: process.env.NEXT_PUBLIC_POSTHOG_HOST || 'https://us.i.posthog.com',
+      loaded: (posthog) => {
+        if (process.env.NODE_ENV === 'development') posthog.debug()
+      },
+    })
+
+    const handleRouteChange = () => posthog?.capture('$pageview')
+    Router.events.on('routeChangeComplete', handleRouteChange)
+
+    return () => {
+      Router.events.off('routeChangeComplete', handleRouteChange)
+    }
+  }, [])
+
+  return (
+    <PostHogProvider client={posthog}>
+      <Component {...pageProps} />
+    </PostHogProvider>
+  )
+}
+--------------------------------------------------
+
+==============================
+FILE: lib/server/posthog.${language === 'typescript' ? 'ts' : 'js'}
+==============================
+Changes:
+- Initialize the PostHog Node.js client for server-side tracking.
+
+Example:
+--------------------------------------------------
+import { PostHog } from 'posthog-node'
+
+export default function PostHogClient() {
+  return new PostHog(process.env.NEXT_PUBLIC_POSTHOG_KEY!, {
+    host: process.env.NEXT_PUBLIC_POSTHOG_HOST,
+    flushAt: 1,
+    flushInterval: 0,
+  })
+}
+--------------------------------------------------
+
+==============================
+FILE: next.config.{js,ts,mjs,cjs}
+==============================
+Changes:
+- Add rewrites to support PostHog tracking.
+- Enable support for PostHog API trailing slash requests.
+
+Example:
+--------------------------------------------------
+const nextConfig = {
+  async rewrites() {
+    return [
+      { source: "/ingest/static/:path*", destination: "${(0, utils_1.getAssetHostFromHost)(host)}/static/:path*" },
+      { source: "/ingest/:path*", destination: "${host}/:path*" },
+      { source: "/ingest/decide", destination: "${host}/decide" },
+    ]
+  },
+  skipTrailingSlashRedirect: true,
+}
+
+module.exports = nextConfig
+--------------------------------------------------
+`;
+};
+exports.getNextjsPagesRouterDocs = getNextjsPagesRouterDocs;
+//# sourceMappingURL=docs.js.map

package/dist/src/nextjs/docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.js","sourceRoot":"","sources":["../../../src/nextjs/docs.ts"],"names":[],"mappings":";;;AAAA,mCAA+C;AAExC,MAAM,sBAAsB,GAAG,CAAC,EACrC,IAAI,EACJ,QAAQ,GAIT,EAAE,EAAE;IACH,OAAO;;uCAE8B,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KACvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA8De,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;+BA0B7B,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAkC9C,IAAA,4BAAoB,EAAC,IAAI,CAAC;;;;wBAI1B,IAAI;;;;wBAIJ,IAAI;;;;;;;;mDAQuB,CAAC;AACpD,CAAC,CAAC;AArJW,QAAA,sBAAsB,0BAqJjC;AAEK,MAAM,wBAAwB,GAAG,CAAC,EACvC,IAAI,EACJ,QAAQ,GAIT,EAAE,EAAE;IACH,OAAO;;mBAEU,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAwCjC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yDA8BT,IAAA,4BAAoB,EACzE,IAAI,CACL;kDAC+C,IAAI;kDACJ,IAAI;;;;;;;;CAQrD,CAAC;AACF,CAAC,CAAC;AA5FW,QAAA,wBAAwB,4BA4FnC","sourcesContent":["import { getAssetHostFromHost } from './utils';\n\nexport const getNextjsAppRouterDocs = ({\n  host,\n  language,\n}: {\n  host: string;\n  language: 'typescript' | 'javascript';\n}) => {\n  return `\n==============================\nFILE: app/components/PostHogProvider.${language === 'typescript' ? 'tsx' : 'jsx'\n    }\n==============================\nChanges:\n- Create a PostHogProvider component that will be imported into the layout file.\n\nExample:\n--------------------------------------------------\n'use client'\n\nimport posthog from 'posthog-js'\nimport { PostHogProvider as PHProvider, usePostHog } from 'posthog-js/react'\nimport { Suspense, useEffect } from 'react'\nimport { usePathname, useSearchParams } from \"next/navigation\"\n\nexport function PostHogProvider({ children }: { children: React.ReactNode }) {\n  useEffect(() => {\n    posthog.init(process.env.NEXT_PUBLIC_POSTHOG_KEY!, {\n      api_host: \"/ingest\",\n      ui_host: process.env.NEXT_PUBLIC_POSTHOG_HOST,\n      capture_pageview: false, // We capture pageviews manually\n      capture_pageleave: true, // Enable pageleave capture\n    })\n  }, [])\n\n  return (\n    <PHProvider client={posthog}>\n      <SuspendedPostHogPageView />\n      {children}\n    </PHProvider>\n  )\n}\n\n\nfunction PostHogPageView() {\n  const pathname = usePathname()\n  const searchParams = useSearchParams()\n  const posthog = usePostHog()\n\n  useEffect(() => {\n    if (pathname && posthog) {\n      let url = window.origin + pathname\n      const search = searchParams.toString()\n      if (search) {\n        url += \"?\" + search\n      }\n      posthog.capture('$pageview', { '$current_url': url })\n    }\n  }, [pathname, searchParams, posthog])\n\n  return null\n}\n\nfunction SuspendedPostHogPageView() {\n  return (\n    <Suspense fallback={null}>\n      <PostHogPageView />\n    </Suspense>\n  )\n}\n--------------------------------------------------\n\n==============================\nFILE: app/layout.${language === 'typescript' ? 'tsx' : 'jsx'}\n==============================\nChanges:\n- Import the PostHogProvider from the providers file and wrap the app in it.\n\nExample:\n--------------------------------------------------\n// other imports\nimport { PostHogProvider } from './components/providers'\n\nexport default function RootLayout({ children }) {\n  return (\n    <html lang=\"en\">\n      <body>\n        <PostHogProvider>\n          {/* other providers */}\n          {children}\n          {/* other providers */}\n        </PostHogProvider>\n      </body>\n    </html>\n  )\n}\n--------------------------------------------------\n\n==============================\nFILE: app/lib/server/posthog.${language === 'typescript' ? 'ts' : 'js'}\n==============================\nChanges:\n- Initialize the PostHog Node.js client\n\nExample:\n--------------------------------------------------\nimport { PostHog } from 'posthog-node'\n\nexport default function PostHogClient() {\n  const posthogClient = new PostHog(process.env.NEXT_PUBLIC_POSTHOG_KEY!, {\n    host: process.env.NEXT_PUBLIC_POSTHOG_HOST,\n    flushAt: 1,\n    flushInterval: 0,\n  })\n  return posthogClient\n}\n--------------------------------------------------\n\n==============================\nFILE: next.config.{js,ts,mjs,cjs}\n==============================\nChanges:\n- Add rewrites to the Next.js config to support PostHog, if there are existing rewrites, add the PostHog rewrites to them.\n- Add skipTrailingSlashRedirect to the Next.js config to support PostHog trailing slash API requests.\n- This can be of type js, ts, mjs, cjs etc. You should adapt the file according\nExample:\n--------------------------------------------------\nconst nextConfig = {\n  // other config\n  async rewrites() {\n    return [\n      {\n        source: \"/ingest/static/:path*\",\n        destination: \"${getAssetHostFromHost(host)}/static/:path*\",\n      },\n      {\n        source: \"/ingest/:path*\",\n        destination: \"${host}/:path*\",\n      },\n      {\n        source: \"/ingest/decide\",\n        destination: \"${host}/decide\",\n      },\n    ];\n  },\n  // This is required to support PostHog trailing slash API requests\n  skipTrailingSlashRedirect: true,\n}\nmodule.exports = nextConfig\n--------------------------------------------------`;\n};\n\nexport const getNextjsPagesRouterDocs = ({\n  host,\n  language,\n}: {\n  host: string;\n  language: 'typescript' | 'javascript';\n}) => {\n  return `\n==============================\nFILE: pages/_app.${language === 'typescript' ? 'tsx' : 'jsx'}\n==============================\nChanges:\n- Initialize PostHog in _app.js.\n- Wrap the application in PostHogProvider.\n- Manually capture $pageview events.\n\nExample:\n--------------------------------------------------\nimport { useEffect } from 'react'\nimport { Router } from 'next/router'\nimport posthog from 'posthog-js'\nimport { PostHogProvider } from 'posthog-js/react'\n\nexport default function App({ Component, pageProps }) {\n  useEffect(() => {\n    posthog.init(process.env.NEXT_PUBLIC_POSTHOG_KEY, {\n      api_host: process.env.NEXT_PUBLIC_POSTHOG_HOST || 'https://us.i.posthog.com',\n      loaded: (posthog) => {\n        if (process.env.NODE_ENV === 'development') posthog.debug()\n      },\n    })\n\n    const handleRouteChange = () => posthog?.capture('$pageview')\n    Router.events.on('routeChangeComplete', handleRouteChange)\n\n    return () => {\n      Router.events.off('routeChangeComplete', handleRouteChange)\n    }\n  }, [])\n\n  return (\n    <PostHogProvider client={posthog}>\n      <Component {...pageProps} />\n    </PostHogProvider>\n  )\n}\n--------------------------------------------------\n\n==============================\nFILE: lib/server/posthog.${language === 'typescript' ? 'ts' : 'js'}\n==============================\nChanges:\n- Initialize the PostHog Node.js client for server-side tracking.\n\nExample:\n--------------------------------------------------\nimport { PostHog } from 'posthog-node'\n\nexport default function PostHogClient() {\n  return new PostHog(process.env.NEXT_PUBLIC_POSTHOG_KEY!, {\n    host: process.env.NEXT_PUBLIC_POSTHOG_HOST,\n    flushAt: 1,\n    flushInterval: 0,\n  })\n}\n--------------------------------------------------\n\n==============================\nFILE: next.config.{js,ts,mjs,cjs}\n==============================\nChanges:\n- Add rewrites to support PostHog tracking.\n- Enable support for PostHog API trailing slash requests.\n\nExample:\n--------------------------------------------------\nconst nextConfig = {\n  async rewrites() {\n    return [\n      { source: \"/ingest/static/:path*\", destination: \"${getAssetHostFromHost(\n    host,\n  )}/static/:path*\" },\n      { source: \"/ingest/:path*\", destination: \"${host}/:path*\" },\n      { source: \"/ingest/decide\", destination: \"${host}/decide\" },\n    ]\n  },\n  skipTrailingSlashRedirect: true,\n}\n\nmodule.exports = nextConfig\n--------------------------------------------------\n`;\n};\n"]}

package/dist/src/nextjs/nextjs-wizard.d.ts

@@ -0,0 +1,9 @@
+import type { WizardOptions } from '../utils/types';
+import { Integration } from '../lib/constants';
+export declare function runNextjsWizard(options: WizardOptions): Promise<void>;
+export declare function detectNextJs(): Promise<Integration.nextjs | undefined>;
+export declare function addOrUpdateEnvironmentVariables({ projectApiKey, host, }: {
+    projectApiKey: string;
+    host: string;
+}): Promise<void>;
+export declare function getDotGitignore(): string | undefined;