@stackframe/init-stack 2.5.9 → 2.5.11

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @stackframe/init-stack
 
+## 2.5.11
+
+## 2.5.10
+
+### Patch Changes
+
+- Facebook Business support
+
 ## 2.5.9
 
 ## 2.5.8

package/index.mjs

@@ -30,8 +30,39 @@ class UserError extends Error {
 
 let savedProjectPath = process.argv[2] || undefined;
 
+const isDryRun = process.argv.includes("--dry-run");
+
+const ansis = {
+  red: "\x1b[31m",
+  blue: "\x1b[34m",
+  green: "\x1b[32m",
+  yellow: "\x1b[33m",
+  clear: "\x1b[0m",
+  bold: "\x1b[1m",
+};
+
+const filesCreated = [];
+const filesModified = [];
+const commandsExecuted = [];
+
 async function main() {
-  console.log("Welcome to the Stack installation wizard! 🧙‍♂️");
+  console.log();
+  console.log(`
+       ██████            
+   ██████████████        
+████████████████████     
+████████████████████                WELCOME TO
+█████████████████        ╔═╗╔╦╗╔═╗╔═╗╦╔═  ┌─┐┬ ┬┌┬┐┬ ┬
+█████████████            ╚═╗ ║ ╠═╣║  ╠╩╗  ├─┤│ │ │ ├─┤
+█████████████   ████     ╚═╝ ╩ ╩ ╩╚═╝╩ ╩  ┴ ┴└─┘ ┴ ┴ ┴
+   █████████████████     
+       ██████     ██     
+████            ████     
+   █████    █████
+       ██████
+  `);
+  console.log();
+
 
   let projectPath = await getProjectPath();
   if (!fs.existsSync(projectPath)) {
@@ -44,6 +75,17 @@ async function main() {
       `The package.json file does not exist in the project path ${projectPath}. You must initialize a new project first before installing Stack.`
     );
   }
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
+  if (!packageJson.dependencies || !packageJson.dependencies["next"]) {
+    throw new UserError(
+      `The project at ${projectPath} does not appear to be a Next.js project, or does not have 'next' installed as a dependency. Only Next.js projects are currently supported.`
+    );
+  }
+  if (!packageJson.dependencies["next"].includes("14")) {
+    throw new UserError(
+      `The project at ${projectPath} is using an unsupported version of Next.js (found ${packageJson.dependencies["next"]}).\n\nOnly Next.js 14 projects are currently supported. See Next's upgrade guide: https://nextjs.org/docs/app/building-your-application/upgrading/version-14`
+    );
+  }
 
   const nextConfigPathWithoutExtension = path.join(projectPath, "next.config");
   const nextConfigFileExtension = await findJsExtension(
@@ -109,11 +151,11 @@ async function main() {
   if (stackAppContent) {
     if (!stackAppContent.includes("@stackframe/stack")) {
       throw new UserError(
-        `A file at the path ${stackAppPath} already exists. Stack uses the /src/stack-app file to initialize the Stack SDK. Please remove the existing file and try again.`
+        `A file at the path ${stackAppPath} already exists. Stack uses the /src/stack.ts file to initialize the Stack SDK. Please remove the existing file and try again.`
       );
     }
     throw new UserError(
-      `It seems that you've already installed Stack in this project.`
+      `It seems that you already installed Stack in this project.`
     );
   }
 
@@ -136,33 +178,41 @@ async function main() {
     (await findJsExtension(loadingPathWithoutExtension)) ?? defaultExtension;
   const loadingPath = loadingPathWithoutExtension + "." + loadingFileExtension;
 
-  console.log();
-  console.log("Found supported project at:", projectPath);
-  console.log("Installing now! 💃");
-
   const packageManager = await getPackageManager();
   const versionCommand = `${packageManager} --version`;
   const installCommand =
     packageManager === "yarn" ? "yarn add" : `${packageManager} install`;
 
-  process.stdout.write("\nChecking package manager version... ");
   try {
-    await shellNicelyFormatted(versionCommand, { shell: true });
+    await shellNicelyFormatted(versionCommand, { shell: true, quiet: true });
   } catch (err) {
     throw new UserError(
-      `Could not run the package manager command ${versionCommand}. Please make sure ${packageManager} is installed on your system.`
+      `Could not run the package manager command '${versionCommand}'. Please make sure ${packageManager} is installed on your system.`
     );
   }
 
+  const isReady = await inquirer.prompt([
+    {
+      type: "confirm",
+      name: "ready",
+      message: `Found a Next.js project at ${projectPath}. Ready to install Stack?`,
+      default: true,
+    },
+  ]);
+  if (!isReady.ready) {
+    throw new UserError("Installation aborted.");
+  }
+
   console.log();
-  console.log("Installing dependencies...");
+  console.log(`${ansis.bold}Installing dependencies...${ansis.clear}`);
   await shellNicelyFormatted(`${installCommand} @stackframe/stack`, {
     shell: true,
     cwd: projectPath,
   });
 
   console.log();
-  console.log("Writing files...");
+  console.log(`${ansis.bold}Writing files...${ansis.clear}`);
+  console.log();
   if (potentialEnvLocations.every((p) => !fs.existsSync(p))) {
     await writeFile(
       envLocalPath,
@@ -182,7 +232,25 @@ async function main() {
     `import "server-only";\n\nimport { StackServerApp } from "@stackframe/stack";\n\nexport const stackServerApp = new StackServerApp({\n${ind}tokenStore: "nextjs-cookie",\n});\n`
   );
   await writeFile(layoutPath, updatedLayoutContent);
-  console.log("Files written successfully!");
+  console.log(`${ansis.green}√${ansis.clear} Done writing files`);
+
+  console.log();
+  console.log();
+  console.log();
+  console.log(`${ansis.bold}${ansis.green}Installation succeeded!${ansis.clear}`);
+  console.log();
+  console.log("Commands executed:");
+  for (const command of commandsExecuted) {
+    console.log(`  ${ansis.blue}${command}${ansis.clear}`);
+  }
+  console.log();
+  console.log("Files written:");
+  for (const file of filesModified) {
+    console.log(`  ${ansis.yellow}${file}${ansis.clear}`);
+  }
+  for (const file of filesCreated) {
+    console.log(`  ${ansis.green}${file}${ansis.clear}`);
+  }
 }
 main()
   .then(async () => {
@@ -190,52 +258,54 @@ main()
     console.log();
     console.log();
     console.log();
-    console.log("===============================================");
+    console.log(`${ansis.green}===============================================${ansis.clear}`);
     console.log();
-    console.log("Successfully installed Stack! 🚀🚀🚀");
+    console.log(`${ansis.green}Successfully installed Stack! 🚀🚀🚀${ansis.clear}`);
     console.log();
-    console.log(
-      "Next up, please create an account on https://app.stack-auth.com to create a new project, and copy the Next.js environment variables from a new API key into your .env.local file."
-    );
+    console.log("Next steps:");
+    console.log("  1. Create an account and project on https://app.stack-auth.com");
+    console.log("  2. Copy the environment variables from the new API key into your .env.local file");
     console.log();
     console.log(
-      "Then, you will be able to access your sign-in page on http://your-website.example.com/handler/sign-in. Congratulations!"
+      "Then, you will be able to access your sign-in page on http://your-website.example.com/handler/sign-in. That's it!"
     );
     console.log();
+    console.log(`${ansis.green}===============================================${ansis.clear}`);
+    console.log();
     console.log(
       "For more information, please visit https://docs.stack-auth.com/docs/getting-started/setup"
     );
     console.log();
-    console.log("===============================================");
-    console.log();
     await open("https://app.stack-auth.com/wizard-congrats");
   })
   .catch((err) => {
-    console.error(err);
+    if (!(err instanceof UserError)) {
+      console.error(err);
+    }
     console.error();
     console.error();
     console.error();
     console.error();
-    console.error("===============================================");
+    console.error(`${ansis.red}===============================================${ansis.clear}`);
     console.error();
     if (err instanceof UserError) {
-      console.error("[ERR] Error: " + err.message);
+      console.error(`${ansis.red}ERROR!${ansis.clear} ${err.message}`);
     } else {
       console.error(
-        "[ERR] An error occurred during the initialization process."
+        "An error occurred during the initialization process."
       );
     }
-    console.error("[ERR]");
+    console.error();
+    console.error(`${ansis.red}===============================================${ansis.clear}`);
+    console.error();
     console.error(
-      "[ERR] If you need assistance, please try installing Slack manually as described in https://docs.stack-auth.com/docs/getting-started/setup or join our Discord where we're happy to help: https://discord.stack-auth.com"
+      "If you need assistance, please try installing Slack manually as described in https://docs.stack-auth.com/docs/getting-started/setup or join our Discord where we're happy to help: https://discord.stack-auth.com"
     );
     if (!(err instanceof UserError)) {
-      console.error("[ERR]");
-      console.error(`[ERR] Error message: ${err.message}`);
+      console.error("");
+      console.error(`Error message: ${err.message}`);
     }
     console.error();
-    console.error("===============================================");
-    console.error();
     process.exit(1);
   });
 
@@ -381,31 +451,55 @@ async function getPackageManager() {
   return answers.packageManager;
 }
 
-async function shellNicelyFormatted(command, options) {
+
+async function shellNicelyFormatted(command, { quiet, ...options }) {
   console.log();
   const ui = new inquirer.ui.BottomBar();
-  ui.updateBottomBar(`Running command: ${command}...`);
-  const child = child_process.spawn(command, options);
-  child.stdout.pipe(ui.log);
-  child.stderr.pipe(ui.log);
-
-  await new Promise((resolve, reject) => {
-    child.on("exit", (code) => {
-      if (code === 0) {
-        resolve();
-      } else {
-        reject(new Error(`Command ${command} failed with code ${code}`));
+  let dots = 4;
+  ui.updateBottomBar(`${ansis.blue}Running command: ${command}...${ansis.clear}`);
+  const interval = setInterval(() => {
+    if (!isDryRun) {
+      ui.updateBottomBar(
+        `${ansis.blue}Running command: ${command}${".".repeat(dots++ % 5)}${ansis.clear}`
+      );
+    }
+  }, 700);
+  try {
+    if (!isDryRun) {
+      const child = child_process.spawn(command, options);
+      if (!quiet) {
+        child.stdout.pipe(ui.log);
+        child.stderr.pipe(ui.log);
       }
-    });
-  });
 
-  ui.updateBottomBar(`Command ${command} finished successfully!\n`);
-  ui.close();
+      await new Promise((resolve, reject) => {
+        child.on("exit", (code) => {
+          if (code === 0) {
+            resolve();
+          } else {
+            reject(new Error(`Command ${command} failed with code ${code}`));
+          }
+        });
+      });
+    } else {
+      console.log(`[DRY-RUN] Would have run: ${command}`);
+    }
+
+    if (!quiet) {
+      commandsExecuted.push(command);
+    }
+  } finally {
+    clearTimeout(interval);
+    ui.updateBottomBar(quiet ? "" : `${ansis.green}√${ansis.clear} Command ${command} succeeded\n`);
+    ui.close();
+  }
 }
 
 async function readFile(fullPath) {
   try {
-    return fs.readFileSync(fullPath, "utf-8");
+    if (!isDryRun) {
+      return fs.readFileSync(fullPath, "utf-8");
+    }
   } catch (err) {
     if (err.code === "ENOENT") {
       return null;
@@ -415,8 +509,19 @@ async function readFile(fullPath) {
 }
 
 async function writeFile(fullPath, content) {
-  fs.mkdirSync(path.dirname(fullPath), { recursive: true });
-  fs.writeFileSync(fullPath, content);
+  let create = !fs.existsSync(fullPath);
+  if (!isDryRun) {
+    fs.mkdirSync(path.dirname(fullPath), { recursive: true });
+    fs.writeFileSync(fullPath, content);
+  } else {
+    console.log(`[DRY-RUN] Would have written to ${fullPath}`);
+  }
+  const relativeToProjectPath = path.relative(await getProjectPath(), fullPath);
+  if (!create) {
+    filesModified.push(relativeToProjectPath);
+  } else {
+    filesCreated.push(relativeToProjectPath);
+  }
 }
 
 async function writeFileIfNotExists(fullPath, content) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackframe/init-stack",
-  "version": "2.5.9",
+  "version": "2.5.11",
   "description": "The setup wizard for Stack. https://stack-auth.com",
   "main": "index.mjs",
   "bin": "./index.mjs",