@posthog/wizard 0.2.2

package/dist/src/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/run.ts"],"names":[],"mappings":";;;;;AAiBA,kBA0BC;AA3CD,qDAAuD;AAGvD,0DAAuE;AAEvE,+CAAyE;AAEzE,qCAAuC;AACvC,qDAAsD;AACtD,0DAAkC;AAQ3B,KAAK,UAAU,GAAG,CAAC,IAAU;IAClC,MAAM,SAAS,GAAG;QAChB,GAAG,IAAI;QACP,GAAG,IAAA,6BAAe,GAAE;KACrB,CAAC;IAGF,eAAK,CAAC,KAAK,CAAC,kBAAkB,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAEvD,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,IAAI,MAAM,sBAAsB,EAAE,CAAC;IAG5E,MAAM,aAAa,GAAkB;QACnC,KAAK,EAAE,SAAS,CAAC,KAAK,IAAI,KAAK;QAC/B,YAAY,EAAE,SAAS,CAAC,YAAY,IAAI,KAAK;QAC7C,gBAAgB,EAAE,KAAK;KACxB,CAAC;IAEF,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,uBAAW,CAAC,MAAM;YACrB,MAAM,IAAA,+BAAe,EAAC,aAAa,CAAC,CAAC;YACrC,MAAM;QAER;YACE,eAAK,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACjD,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB;IAC1B,IAAI,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAC9C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAC9B,IAAA,sBAAY,EAAC,iBAAiB,EAAE,OAAO,CAAC,CACvB,CAAC;YACpB,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;IACH,CAAC;IACD,OAAO,OAAO,IAAI,EAAE,CAAC;AACvB,CAAC;AAGD,KAAK,UAAU,iBAAiB;IAE9B,MAAM,SAAS,GAAG;QAChB,4BAAY;KACb,CAAA;IAED,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,WAAW,GAAG,MAAM,QAAQ,EAAE,CAAC;QACrC,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,WAAW,CAAC;QACrB,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,sBAAsB;IAEnC,MAAM,mBAAmB,GAAG,MAAM,iBAAiB,EAAE,CAAC;IAEtD,IAAI,mBAAmB,EAAE,CAAC;QACxB,eAAK,CAAC,GAAG,CAAC,OAAO,CAAC,yBAAyB,IAAA,qCAAyB,EAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAC7F,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED,MAAM,WAAW,GAAgB,MAAM,IAAA,8BAAgB,EACrD,eAAK,CAAC,MAAM,CAAC;QACX,OAAO,EAAE,6BAA6B;QACtC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,uBAAW,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;KAC3D,CAAC,CACH,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["import { abortIfCancelled } from './utils/clack-utils';\n\nimport type { WizardOptions } from './utils/types';\nimport { detectNextJs, runNextjsWizard } from './nextjs/nextjs-wizard';\n\nimport { getIntegrationDescription, Integration } from './lib/constants';\nimport type { PackageDotJson } from './utils/package-json';\nimport { readFileSync } from 'node:fs';\nimport { readEnvironment } from './utils/environment';\nimport clack from './utils/clack';\n\n\ntype Args = {\n  integration?: Integration;\n  debug?: boolean;\n  forceInstall?: boolean;\n};\nexport async function run(argv: Args) {\n  const finalArgs = {\n    ...argv,\n    ...readEnvironment(),\n  };\n\n\n  clack.intro(`PostHog Wizard ${tryGetWizardVersion()}`);\n\n  const integration = finalArgs.integration ?? await getIntegrationForSetup();\n\n\n  const wizardOptions: WizardOptions = {\n    debug: finalArgs.debug ?? false,\n    forceInstall: finalArgs.forceInstall ?? false,\n    telemetryEnabled: false,\n  };\n\n  switch (integration) {\n    case Integration.nextjs:\n      await runNextjsWizard(wizardOptions);\n      break;\n\n    default:\n      clack.log.error('No setup wizard selected!');\n  }\n}\n\nfunction tryGetWizardVersion(): string {\n  let version = process.env.npm_package_version;\n  if (!version) {\n    try {\n      const wizardPkgJson = JSON.parse(\n        readFileSync('../package.json', 'utf-8'),\n      ) as PackageDotJson;\n      version = wizardPkgJson.version;\n    } catch {\n      // ignore\n    }\n  }\n  return version ?? '';\n}\n\n\nasync function detectIntegration(): Promise<Integration | undefined> {\n\n  const detectors = [\n    detectNextJs\n  ]\n\n  for (const detector of detectors) {\n    const integration = await detector();\n    if (integration) {\n      return integration;\n    }\n  }\n}\n\nasync function getIntegrationForSetup() {\n\n  const detectedIntegration = await detectIntegration();\n\n  if (detectedIntegration) {\n    clack.log.success(`Detected integration: ${getIntegrationDescription(detectedIntegration)}`);\n    return detectedIntegration;\n  }\n\n  const integration: Integration = await abortIfCancelled(\n    clack.select({\n      message: 'What do you want to set up?',\n      options: [{ value: Integration.nextjs, label: 'Next.js' }],\n    }),\n  );\n\n  return integration;\n}\n"]}

package/dist/src/telemetry.d.ts

@@ -0,0 +1,2 @@
+export declare function traceStep<T>(step: string, callback: () => T): T;
+export declare function updateProgress(step: string): void;

package/dist/src/telemetry.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.traceStep = traceStep;
+exports.updateProgress = updateProgress;
+const analytics_1 = require("./utils/analytics");
+function traceStep(step, callback) {
+    updateProgress(step);
+    return callback();
+}
+function updateProgress(step) {
+    analytics_1.Analytics.setTag('progress', step);
+}
+//# sourceMappingURL=telemetry.js.map

package/dist/src/telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../../src/telemetry.ts"],"names":[],"mappings":";;AAMA,8BAMC;AAED,wCAEC;AAhBD,iDAA8C;AAM9C,SAAgB,SAAS,CACvB,IAAY,EACZ,QAAiB;IAEjB,cAAc,CAAC,IAAI,CAAC,CAAC;IACrB,OAAO,QAAQ,EAAE,CAAC;AACpB,CAAC;AAED,SAAgB,cAAc,CAAC,IAAY;IACzC,qBAAS,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;AACrC,CAAC","sourcesContent":["import { Analytics } from './utils/analytics';\n\n\n\n\n\nexport function traceStep<T>(\n  step: string,\n  callback: () => T,\n): T {\n  updateProgress(step);\n  return callback();\n}\n\nexport function updateProgress(step: string) {\n  Analytics.setTag('progress', step);\n}\n"]}

package/dist/src/utils/analytics.d.ts

@@ -0,0 +1,4 @@
+export declare class Analytics {
+    constructor();
+    static setTag(key: string, value: string | boolean | number | null | undefined): void;
+}

package/dist/src/utils/analytics.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = void 0;
+class Analytics {
+    constructor() { }
+    static setTag(key, value) {
+    }
+}
+exports.Analytics = Analytics;
+//# sourceMappingURL=analytics.js.map

package/dist/src/utils/analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../src/utils/analytics.ts"],"names":[],"mappings":";;;AAAA,MAAa,SAAS;IACpB,gBAAgB,CAAC;IAEjB,MAAM,CAAC,MAAM,CAAC,GAAW,EAAE,KAAmD;IAC9E,CAAC;CAGF;AAPD,8BAOC","sourcesContent":["export class Analytics {\n  constructor() { }\n\n  static setTag(key: string, value: string | boolean | number | null | undefined) {\n  }\n\n\n}"]}

package/dist/src/utils/bash.d.ts

@@ -0,0 +1,2 @@
+export declare function executeSync(command: string): string;
+export declare function execute(command: string): Promise<string>;

package/dist/src/utils/bash.js

@@ -0,0 +1,54 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeSync = executeSync;
+exports.execute = execute;
+const child_process = __importStar(require("child_process"));
+function executeSync(command) {
+    const output = child_process.execSync(command);
+    return output.toString();
+}
+function execute(command) {
+    return new Promise((resolve, reject) => {
+        child_process.exec(command, (error, stdout, _) => {
+            if (error) {
+                reject(error);
+                return;
+            }
+            resolve(stdout);
+        });
+    });
+}
+//# sourceMappingURL=bash.js.map

package/dist/src/utils/bash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bash.js","sourceRoot":"","sources":["../../../src/utils/bash.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,kCAGC;AAED,0BAWC;AAlBD,6DAA+C;AAE/C,SAAgB,WAAW,CAAC,OAAe;IACzC,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC/C,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;AAC3B,CAAC;AAED,SAAgB,OAAO,CAAC,OAAe;IACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE;YAC/C,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,KAAK,CAAC,CAAC;gBACd,OAAO;YACT,CAAC;YAED,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import * as child_process from 'child_process';\n\nexport function executeSync(command: string): string {\n  const output = child_process.execSync(command);\n  return output.toString();\n}\n\nexport function execute(command: string): Promise<string> {\n  return new Promise((resolve, reject) => {\n    child_process.exec(command, (error, stdout, _) => {\n      if (error) {\n        reject(error);\n        return;\n      }\n\n      resolve(stdout);\n    });\n  });\n}\n"]}

package/dist/src/utils/clack-utils.d.ts

@@ -0,0 +1,177 @@
+import { type PackageDotJson } from './package-json';
+import { type PackageManager } from './package-manager';
+import type { Feature, WizardOptions } from './types';
+export interface CliSetupConfig {
+    filename: string;
+    name: string;
+    gitignore: boolean;
+    likelyAlreadyHasAuthToken(contents: string): boolean;
+    tokenContent(authToken: string): string;
+    likelyAlreadyHasOrgAndProject(contents: string): boolean;
+    orgAndProjContent(org: string, project: string): string;
+    likelyAlreadyHasUrl?(contents: string): boolean;
+    urlContent?(url: string): string;
+}
+export interface CliSetupConfigContent {
+    authToken: string;
+    org?: string;
+    project?: string;
+    url?: string;
+}
+export declare function abort(message?: string, status?: number): Promise<never>;
+export declare function abortIfCancelled<T>(input: T | Promise<T>): Promise<Exclude<T, symbol>>;
+export declare function printWelcome(options: {
+    wizardName: string;
+    message?: string;
+    telemetryEnabled?: boolean;
+}): void;
+export declare function confirmContinueIfNoOrDirtyGitRepo(): Promise<void>;
+export declare function isInGitRepo(): boolean;
+export declare function getUncommittedOrUntrackedFiles(): string[];
+export declare function askForItemSelection(items: string[], message: string): Promise<{
+    value: string;
+    index: number;
+}>;
+export declare function confirmContinueIfPackageVersionNotSupported({ packageId, packageName, packageVersion, acceptableVersions, note, }: {
+    packageId: string;
+    packageName: string;
+    packageVersion: string;
+    acceptableVersions: string;
+    note?: string;
+}): Promise<void>;
+/**
+ * Installs or updates a package with the user's package manager.
+ *
+ * IMPORTANT: This function modifies the `package.json`! Be sure to re-read
+ * it if you make additional modifications to it after calling this function!
+ */
+export declare function installPackage({ packageName, alreadyInstalled, askBeforeUpdating, packageNameDisplayLabel, packageManager, forceInstall, }: {
+    /** The string that is passed to the package manager CLI as identifier to install (e.g. `posthog-js`, or `posthog-js@^1.100.0`) */
+    packageName: string;
+    alreadyInstalled: boolean;
+    askBeforeUpdating?: boolean;
+    /** Overrides what is shown in the installation logs in place of the `packageName` option. Useful if the `packageName` is ugly */
+    packageNameDisplayLabel?: string;
+    packageManager?: PackageManager;
+    /** Add force install flag to command to skip install precondition fails */
+    forceInstall?: boolean;
+}): Promise<{
+    packageManager?: PackageManager;
+}>;
+export declare function runPrettierIfInstalled(): Promise<void>;
+/**
+ * Checks if @param packageId is listed as a dependency in @param packageJson.
+ * If not, it will ask users if they want to continue without the package.
+ *
+ * Use this function to check if e.g. a the framework of the SDK is installed
+ *
+ * @param packageJson the package.json object
+ * @param packageId the npm name of the package
+ * @param packageName a human readable name of the package
+ */
+export declare function ensurePackageIsInstalled(packageJson: PackageDotJson, packageId: string, packageName: string): Promise<void>;
+export declare function getPackageDotJson(): Promise<PackageDotJson>;
+export declare function updatePackageDotJson(packageDotJson: PackageDotJson): Promise<void>;
+export declare function getPackageManager(): Promise<PackageManager>;
+export declare function isUsingTypeScript(): boolean;
+/**
+ * Checks if we already got project data from a previous wizard invocation.
+ * If yes, this data is returned.
+ * Otherwise, we start the login flow and ask the user to select a project.
+ *
+ * Use this function to get project data for the wizard.
+ *
+ * @param options wizard options
+ * @returns project data (token, url)
+ */
+export declare function getOrAskForProjectData(_options: WizardOptions): Promise<{
+    wizardHash: string;
+    host: string;
+    projectApiKey: string;
+}>;
+/**
+ * Asks users if they have a config file for @param tool (e.g. Vite).
+ * If yes, asks users to specify the path to their config file.
+ *
+ * Use this helper function as a fallback mechanism if the lookup for
+ * a config file with its most usual location/name fails.
+ *
+ * @param toolName Name of the tool for which we're looking for the config file
+ * @param configFileName Name of the most common config file name (e.g. vite.config.js)
+ *
+ * @returns a user path to the config file or undefined if the user doesn't have a config file
+ */
+export declare function askForToolConfigPath(toolName: string, configFileName: string): Promise<string | undefined>;
+/**
+ * Prints copy/paste-able instructions to the console.
+ * Afterwards asks the user if they added the code snippet to their file.
+ *
+ * While there's no point in providing a "no" answer here, it gives users time to fulfill the
+ * task before the wizard continues with additional steps.
+ *
+ * Use this function if you want to show users instructions on how to add/modify
+ * code in their file. This is helpful if automatic insertion failed or is not possible/feasible.
+ *
+ * @param filename the name of the file to which the code snippet should be applied.
+ * If a path is provided, only the filename will be used.
+ *
+ * @param codeSnippet the snippet to be printed. Use {@link makeCodeSnippet}  to create the
+ * diff-like format for visually highlighting unchanged or modified lines of code.
+ *
+ * @param hint (optional) a hint to be printed after the main instruction to add
+ * the code from @param codeSnippet to their @param filename.
+ *
+ * TODO: refactor copy paste instructions across different wizards to use this function.
+ *       this might require adding a custom message parameter to the function
+ */
+export declare function showCopyPasteInstructions(filename: string, codeSnippet: string, hint?: string): Promise<void>;
+/**
+ * Callback that exposes formatting helpers for a code snippet.
+ * @param unchanged - Formats text as old code.
+ * @param plus - Formats text as new code.
+ * @param minus - Formats text as removed code.
+ */
+type CodeSnippetFormatter = (unchanged: (txt: string) => string, plus: (txt: string) => string, minus: (txt: string) => string) => string;
+/**
+ * Crafts a code snippet that can be used to e.g.
+ * - print copy/paste instructions to the console
+ * - create a new config file.
+ *
+ * @param colors set this to true if you want the final snippet to be colored.
+ * This is useful for printing the snippet to the console as part of copy/paste instructions.
+ *
+ * @param callback the callback that returns the formatted code snippet.
+ * It exposes takes the helper functions for marking code as unchanged, new or removed.
+ * These functions no-op if no special formatting should be applied
+ * and otherwise apply the appropriate formatting/coloring.
+ * (@see {@link CodeSnippetFormatter})
+ *
+ * @see {@link showCopyPasteInstructions} for the helper with which to display the snippet in the console.
+ *
+ * @returns a string containing the final, formatted code snippet.
+ */
+export declare function makeCodeSnippet(colors: boolean, callback: CodeSnippetFormatter): string;
+/**
+ * Creates a new config file with the given @param filepath and @param codeSnippet.
+ *
+ * Use this function to create a new config file for users. This is useful
+ * when users answered that they don't yet have a config file for a tool.
+ *
+ * (This doesn't mean that they don't yet have some other way of configuring
+ * their tool but we can leave it up to them to figure out how to merge configs
+ * here.)
+ *
+ * @param filepath absolute path to the new config file
+ * @param codeSnippet the snippet to be inserted into the file
+ * @param moreInformation (optional) the message to be printed after the file was created
+ * For example, this can be a link to more information about configuring the tool.
+ *
+ * @returns true on success, false otherwise
+ */
+export declare function createNewConfigFile(filepath: string, codeSnippet: string, moreInformation?: string): Promise<boolean>;
+export declare function featureSelectionPrompt<F extends ReadonlyArray<Feature>>(features: F): Promise<{
+    [key in F[number]['id']]: boolean;
+}>;
+export declare function askShouldInstallPackage(pkgName: string): Promise<boolean>;
+export declare function askShouldAddPackageOverride(pkgName: string, pkgVersion: string): Promise<boolean>;
+export {};