create-acmekit-app 2.13.39 → 2.13.41

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 2.13.41
+
+### Patch Changes
+
+- changes
+
+- Updated dependencies []:
+  - @acmekit/telemetry@2.13.41
+  - @acmekit/deps@2.13.41
+
+## 2.13.40
+
+### Patch Changes
+
+- changes
+
+- Updated dependencies []:
+  - @acmekit/telemetry@2.13.40
+  - @acmekit/deps@2.13.40
+
 ## 2.13.39
 
 ### Patch Changes

package/dist/index.js

@@ -13,7 +13,6 @@ program
     .option("--no-migrations", "Skips running migrations, creating admin user, and seeding. If used, it's expected that you pass the --db-url option with a url of a database that has all necessary migrations. Otherwise, unexpected errors will occur.", true)
     .option("--no-browser", "Disables opening the browser at the end of the project creation and only shows success message.", true)
     .option("--directory-path <path>", "Specify the directory path to install the project in.")
-    .option("--with-nextjs-starter", "Install the Next.js starter along with the AcmeKit backend", false)
     .option("--verbose", "Show all logs of underlying commands. Useful for debugging.", false)
     .addOption(new Option("--use-npm", "Use npm as the package manager").conflicts([
     "usePnpm",

package/dist/utils/facts.js

@@ -10,11 +10,11 @@ const facts = [
     "Organize customers by customer groups and set special prices for them.",
     "Specify the inventory of products per location and sales channel.",
     "Publishable-API Keys allow you to send scoped requests to the server's client API routes.",
-    "API Routes expose business logic to clients, such as storefronts and admin customizations.",
+    "API Routes expose business logic to clients, such as custom frontends and admin customizations.",
     "Subscribers are asynchronous functions that are executed when an event is emitted.",
     "Data models represent tables in the database. They are created using AcmeKit's Data Modeling Language (DML).",
     "AcmeKit's client API routes are prefixed by /client. The admin API routes are prefixed by /admin.",
-    "The JS SDK allows you to send requests to the AcmeKit server from your storefront or admin customizations.",
+    "The JS SDK allows you to send requests to the AcmeKit server from your frontend or admin customizations.",
     "Modules are reusable packages of functionalities related to a single commerce domain or integration.",
     "Modules have a main service that provides data-management and integration functionalities.",
     "Modules allow you to replace an entire functionality with your custom logic.",

package/dist/utils/prepare-project.js

@@ -55,7 +55,7 @@ async function preparePlugin({ directory, projectName, spinner, processManager,
     });
     displayFactBox({ ...factBoxOptions, message: "Finished Preparation" });
 }
-async function prepareProject({ directory, projectName, dbName, dbConnectionString, seed, spinner, processManager, abortController, skipDb, migrations, onboardingType = "default", nextjsDirectory = "", client, verbose = false, packageManager, version, }) {
+async function prepareProject({ directory, projectName, dbName, dbConnectionString, seed, spinner, processManager, abortController, skipDb, migrations, client, verbose = false, packageManager, version, }) {
     // initialize execution options
     const execOptions = {
         cwd: directory,
@@ -94,7 +94,7 @@ async function prepareProject({ directory, projectName, dbName, dbConnectionStri
     // initialize the invite token to return
     let inviteToken = undefined;
     // add environment variables
-    let env = `MEDUSA_ADMIN_ONBOARDING_TYPE=${onboardingType}${EOL}CLIENT_CORS=${CLIENT_CORS}${EOL}ADMIN_CORS=${ADMIN_CORS}${EOL}AUTH_CORS=${AUTH_CORS}${EOL}REDIS_URL=${DEFAULT_REDIS_URL}${EOL}JWT_SECRET=supersecret${EOL}COOKIE_SECRET=supersecret`;
+    let env = `CLIENT_CORS=${CLIENT_CORS}${EOL}ADMIN_CORS=${ADMIN_CORS}${EOL}AUTH_CORS=${AUTH_CORS}${EOL}REDIS_URL=${DEFAULT_REDIS_URL}${EOL}JWT_SECRET=supersecret${EOL}COOKIE_SECRET=supersecret`;
     if (!skipDb) {
         if (dbName) {
             env += `${EOL}DB_NAME=${dbName}`;
@@ -102,9 +102,6 @@ async function prepareProject({ directory, projectName, dbName, dbConnectionStri
         }
         env += `${EOL}DATABASE_URL=${dbConnectionString}`;
     }
-    if (nextjsDirectory) {
-        env += `${EOL}MEDUSA_ADMIN_ONBOARDING_NEXTJS_DIRECTORY=${nextjsDirectory}`;
-    }
     fs.appendFileSync(path.join(directory, `.env`), env);
     factBoxOptions.interval = displayFactBox({
         ...factBoxOptions,
@@ -176,18 +173,6 @@ async function prepareProject({ directory, projectName, dbName, dbConnectionStri
             });
         }
     }
-    // if installation includes Next.js, retrieve the publishable API key
-    // from the backend and add it as an enviornment variable
-    if (nextjsDirectory && client) {
-        const apiKeys = await client.query(`SELECT * FROM "api_key" WHERE type = 'publishable'`);
-        if (apiKeys.rowCount) {
-            const nextjsEnvPath = path.join(nextjsDirectory, fs.existsSync(path.join(nextjsDirectory, ".env.local"))
-                ? ".env.local"
-                : ".env.template");
-            const originalContent = fs.readFileSync(nextjsEnvPath, "utf-8");
-            fs.writeFileSync(nextjsEnvPath, originalContent.replace("NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY=pk_test", `NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY=${apiKeys.rows[0].token}`));
-        }
-    }
     displayFactBox({ ...factBoxOptions, message: "Finished Preparation" });
     return inviteToken;
 }

package/dist/utils/project-creator/acmekit-project-creator.js

@@ -11,7 +11,6 @@ import { isAbortError } from "../create-abort-controller.js";
 import { getDbClientAndCredentials, runCreateDb } from "../create-db.js";
 import { displayFactBox } from "../facts.js";
 import logMessage from "../log-message.js";
-import { askForNextjsStarter, installNextjsStarter, startNextjsStarter, } from "../nextjs-utils.js";
 import prepareProject from "../prepare-project.js";
 import startAcmeKit from "../start-acmekit.js";
 import { BaseProjectCreator, } from "./creator.js";
@@ -22,7 +21,6 @@ export class AcmeKitProjectCreator extends BaseProjectCreator {
     client = null;
     dbConnectionString = "";
     isDbInitialized = false;
-    nextjsDirectory = "";
     inviteToken;
     constructor(projectName, options, args) {
         super(projectName, options, args);
@@ -40,7 +38,6 @@ export class AcmeKitProjectCreator extends BaseProjectCreator {
         }
     }
     async initializeProject() {
-        const installNextjs = this.options.withNextjsStarter || (await askForNextjsStarter());
         if (!this.options.skipDb) {
             await this.setupDatabase();
         }
@@ -63,16 +60,6 @@ export class AcmeKitProjectCreator extends BaseProjectCreator {
             ...this.factBoxOptions,
             message: "Created project directory",
         });
-        if (installNextjs) {
-            this.nextjsDirectory = await installNextjsStarter({
-                directoryName: this.projectPath,
-                abortController: this.abortController,
-                factBoxOptions: this.factBoxOptions,
-                verbose: this.options.verbose,
-                packageManager: this.packageManager,
-                version: this.options.version,
-            });
-        }
     }
     async setupDatabase() {
         let dbName = `acmekit-${slugify(this.projectName)}`;
@@ -114,8 +101,6 @@ export class AcmeKitProjectCreator extends BaseProjectCreator {
                 abortController: this.abortController,
                 skipDb: this.options.skipDb,
                 migrations: this.options.migrations,
-                onboardingType: this.nextjsDirectory ? "nextjs" : "default",
-                nextjsDirectory: this.nextjsDirectory,
                 client: this.client,
                 verbose: this.options.verbose,
                 packageManager: this.packageManager,
@@ -140,14 +125,6 @@ export class AcmeKitProjectCreator extends BaseProjectCreator {
             abortController: this.abortController,
             packageManager: this.packageManager,
         });
-        if (this.nextjsDirectory) {
-            startNextjsStarter({
-                directory: this.nextjsDirectory,
-                abortController: this.abortController,
-                verbose: this.options.verbose,
-                packageManager: this.packageManager,
-            });
-        }
         this.isProjectCreated = true;
         await this.openBrowser();
     }
@@ -175,8 +152,6 @@ export class AcmeKitProjectCreator extends BaseProjectCreator {
         logMessage({
             message: boxen(chalk.green(`Change to the \`${this.projectName}\` directory to explore your AcmeKit project.${EOL}${EOL}Start your AcmeKit application again with the following command:${EOL}${EOL}${commandStr}${EOL}${EOL}${this.inviteToken
                 ? `After you start the AcmeKit application, you can create an admin user with the URL http://localhost:9000/app/invite?token=${this.inviteToken}&first_run=true${EOL}${EOL}`
-                : ""}${this.nextjsDirectory?.length
-                ? `The Next.js Starter Storefront was installed in the \`${this.nextjsDirectory}\` directory. Change to that directory and start it with the following command:${EOL}${EOL}${commandStr}${EOL}${EOL}`
                 : ""}Check out the AcmeKit ${terminalLink("documentation", "https://docs.acmekit.com/")} to start your development:${EOL}${EOL}Star us on ${terminalLink("GitHub", "https://github.com/acmekit/acmekit/stargazers")} if you like what we're building.`), {
                 titleAlignment: "center",
                 textAlignment: "center",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-acmekit-app",
-  "version": "2.13.39",
+  "version": "2.13.41",
   "description": "Create a AcmeKit project using a single command.",
   "type": "module",
   "exports": "./dist/index.js",
@@ -14,8 +14,8 @@
     "test": "../../../node_modules/.bin/jest --passWithNoTests src"
   },
   "dependencies": {
-    "@acmekit/deps": "2.13.39",
-    "@acmekit/telemetry": "2.13.39",
+    "@acmekit/deps": "2.13.41",
+    "@acmekit/telemetry": "2.13.41",
     "boxen": "^5.0.1",
     "chalk": "^4.1.2",
     "commander": "^11.0.0",

package/src/index.ts

@@ -32,11 +32,6 @@ program
     "--directory-path <path>",
     "Specify the directory path to install the project in."
   )
-  .option(
-    "--with-nextjs-starter",
-    "Install the Next.js starter along with the AcmeKit backend",
-    false
-  )
   .option(
     "--verbose",
     "Show all logs of underlying commands. Useful for debugging.",

package/src/utils/facts.ts

@@ -22,11 +22,11 @@ const facts = [
   "Organize customers by customer groups and set special prices for them.",
   "Specify the inventory of products per location and sales channel.",
   "Publishable-API Keys allow you to send scoped requests to the server's client API routes.",
-  "API Routes expose business logic to clients, such as storefronts and admin customizations.",
+  "API Routes expose business logic to clients, such as custom frontends and admin customizations.",
   "Subscribers are asynchronous functions that are executed when an event is emitted.",
   "Data models represent tables in the database. They are created using AcmeKit's Data Modeling Language (DML).",
   "AcmeKit's client API routes are prefixed by /client. The admin API routes are prefixed by /admin.",
-  "The JS SDK allows you to send requests to the AcmeKit server from your storefront or admin customizations.",
+  "The JS SDK allows you to send requests to the AcmeKit server from your frontend or admin customizations.",
   "Modules are reusable packages of functionalities related to a single commerce domain or integration.",
   "Modules have a main service that provides data-management and integration functionalities.",
   "Modules allow you to replace an entire functionality with your custom logic.",

package/src/utils/prepare-project.ts

@@ -41,8 +41,6 @@ type PrepareProjectOptions = {
   abortController?: AbortController
   skipDb?: boolean
   migrations?: boolean
-  onboardingType?: "default" | "nextjs"
-  nextjsDirectory?: string
   client: Client | null
   verbose?: boolean
   packageManager: PackageManager
@@ -131,8 +129,6 @@ async function prepareProject({
   abortController,
   skipDb,
   migrations,
-  onboardingType = "default",
-  nextjsDirectory = "",
   client,
   verbose = false,
   packageManager,
@@ -185,7 +181,7 @@ async function prepareProject({
   let inviteToken: string | undefined = undefined
 
   // add environment variables
-  let env = `MEDUSA_ADMIN_ONBOARDING_TYPE=${onboardingType}${EOL}CLIENT_CORS=${CLIENT_CORS}${EOL}ADMIN_CORS=${ADMIN_CORS}${EOL}AUTH_CORS=${AUTH_CORS}${EOL}REDIS_URL=${DEFAULT_REDIS_URL}${EOL}JWT_SECRET=supersecret${EOL}COOKIE_SECRET=supersecret`
+  let env = `CLIENT_CORS=${CLIENT_CORS}${EOL}ADMIN_CORS=${ADMIN_CORS}${EOL}AUTH_CORS=${AUTH_CORS}${EOL}REDIS_URL=${DEFAULT_REDIS_URL}${EOL}JWT_SECRET=supersecret${EOL}COOKIE_SECRET=supersecret`
 
   if (!skipDb) {
     if (dbName) {
@@ -195,10 +191,6 @@ async function prepareProject({
     env += `${EOL}DATABASE_URL=${dbConnectionString}`
   }
 
-  if (nextjsDirectory) {
-    env += `${EOL}MEDUSA_ADMIN_ONBOARDING_NEXTJS_DIRECTORY=${nextjsDirectory}`
-  }
-
   fs.appendFileSync(path.join(directory, `.env`), env)
 
   factBoxOptions.interval = displayFactBox({
@@ -302,33 +294,6 @@ async function prepareProject({
     }
   }
 
-  // if installation includes Next.js, retrieve the publishable API key
-  // from the backend and add it as an enviornment variable
-  if (nextjsDirectory && client) {
-    const apiKeys = await client.query(
-      `SELECT * FROM "api_key" WHERE type = 'publishable'`
-    )
-
-    if (apiKeys.rowCount) {
-      const nextjsEnvPath = path.join(
-        nextjsDirectory,
-        fs.existsSync(path.join(nextjsDirectory, ".env.local"))
-          ? ".env.local"
-          : ".env.template"
-      )
-
-      const originalContent = fs.readFileSync(nextjsEnvPath, "utf-8")
-
-      fs.writeFileSync(
-        nextjsEnvPath,
-        originalContent.replace(
-          "NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY=pk_test",
-          `NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY=${apiKeys.rows[0].token}`
-        )
-      )
-    }
-  }
-
   displayFactBox({ ...factBoxOptions, message: "Finished Preparation" })
 
   return inviteToken

package/src/utils/project-creator/acmekit-project-creator.ts

@@ -11,11 +11,6 @@ import { isAbortError } from "../create-abort-controller.js"
 import { getDbClientAndCredentials, runCreateDb } from "../create-db.js"
 import { displayFactBox } from "../facts.js"
 import logMessage from "../log-message.js"
-import {
-  askForNextjsStarter,
-  installNextjsStarter,
-  startNextjsStarter,
-} from "../nextjs-utils.js"
 import prepareProject from "../prepare-project.js"
 import startAcmeKit from "../start-acmekit.js"
 import {
@@ -35,7 +30,6 @@ export class AcmeKitProjectCreator
   private client: any = null
   private dbConnectionString: string = ""
   private isDbInitialized: boolean = false
-  private nextjsDirectory: string = ""
   private inviteToken?: string
 
   constructor(projectName: string, options: ProjectOptions, args: string[]) {
@@ -56,9 +50,6 @@ export class AcmeKitProjectCreator
   }
 
   private async initializeProject(): Promise<void> {
-    const installNextjs =
-      this.options.withNextjsStarter || (await askForNextjsStarter())
-
     if (!this.options.skipDb) {
       await this.setupDatabase()
     }
@@ -88,17 +79,6 @@ export class AcmeKitProjectCreator
       ...this.factBoxOptions,
       message: "Created project directory",
     })
-
-    if (installNextjs) {
-      this.nextjsDirectory = await installNextjsStarter({
-        directoryName: this.projectPath,
-        abortController: this.abortController,
-        factBoxOptions: this.factBoxOptions,
-        verbose: this.options.verbose,
-        packageManager: this.packageManager,
-        version: this.options.version,
-      })
-    }
   }
 
   private async setupDatabase(): Promise<void> {
@@ -147,8 +127,6 @@ export class AcmeKitProjectCreator
         abortController: this.abortController,
         skipDb: this.options.skipDb,
         migrations: this.options.migrations,
-        onboardingType: this.nextjsDirectory ? "nextjs" : "default",
-        nextjsDirectory: this.nextjsDirectory,
         client: this.client,
         verbose: this.options.verbose,
         packageManager: this.packageManager,
@@ -177,15 +155,6 @@ export class AcmeKitProjectCreator
       packageManager: this.packageManager,
     })
 
-    if (this.nextjsDirectory) {
-      startNextjsStarter({
-        directory: this.nextjsDirectory,
-        abortController: this.abortController,
-        verbose: this.options.verbose,
-        packageManager: this.packageManager,
-      })
-    }
-
     this.isProjectCreated = true
 
     await this.openBrowser()
@@ -229,10 +198,6 @@ export class AcmeKitProjectCreator
             this.inviteToken
               ? `After you start the AcmeKit application, you can create an admin user with the URL http://localhost:9000/app/invite?token=${this.inviteToken}&first_run=true${EOL}${EOL}`
               : ""
-          }${
-            this.nextjsDirectory?.length
-              ? `The Next.js Starter Storefront was installed in the \`${this.nextjsDirectory}\` directory. Change to that directory and start it with the following command:${EOL}${EOL}${commandStr}${EOL}${EOL}`
-              : ""
           }Check out the AcmeKit ${terminalLink(
             "documentation",
             "https://docs.acmekit.com/"

package/src/utils/project-creator/creator.ts

@@ -13,7 +13,6 @@ export interface ProjectOptions {
   browser?: boolean
   migrations?: boolean
   directoryPath?: string
-  withNextjsStarter?: boolean
   verbose?: boolean
   plugin?: boolean
   version?: string

package/src/utils/nextjs-utils.ts

@@ -1,139 +0,0 @@
-import { exec } from "child_process"
-import fs from "fs"
-import inquirer from "inquirer"
-import { customAlphabet } from "nanoid"
-import path from "path"
-import { isAbortError } from "./create-abort-controller.js"
-import execute from "./execute.js"
-import { displayFactBox, FactBoxOptions } from "./facts.js"
-import logMessage from "./log-message.js"
-import { updatePackageVersions } from "./update-package-versions.js"
-import PackageManager from "./package-manager.js"
-
-const NEXTJS_REPO = "https://github.com/acmekit/nextjs-starter-acmekit"
-const NEXTJS_BRANCH = "main"
-
-export async function askForNextjsStarter(): Promise<boolean> {
-  const { installNextjs } = await inquirer.prompt([
-    {
-      type: "confirm",
-      name: "installNextjs",
-      message: `Would you like to install the Next.js Starter Storefront? You can also install it later.`,
-      default: false,
-    },
-  ])
-
-  return installNextjs
-}
-
-type InstallOptions = {
-  directoryName: string
-  abortController?: AbortController
-  factBoxOptions: FactBoxOptions
-  verbose?: boolean
-  packageManager: PackageManager
-  version?: string
-}
-
-export async function installNextjsStarter({
-  directoryName,
-  abortController,
-  factBoxOptions,
-  verbose = false,
-  packageManager,
-  version,
-}: InstallOptions): Promise<string> {
-  factBoxOptions.interval = displayFactBox({
-    ...factBoxOptions,
-    title: "Installing Next.js Starter Storefront...",
-  })
-
-  let nextjsDirectory = `${directoryName}-storefront`
-
-  if (
-    fs.existsSync(nextjsDirectory) &&
-    fs.lstatSync(nextjsDirectory).isDirectory()
-  ) {
-    // append a random number to the directory name
-    nextjsDirectory += `-${customAlphabet(
-      // npm throws an error if the directory name has an uppercase letter
-      "123456789abcdefghijklmnopqrstuvwxyz",
-      4
-    )()}`
-  }
-
-  try {
-    await execute(
-      [
-        `git clone ${NEXTJS_REPO} -b ${NEXTJS_BRANCH} ${nextjsDirectory} --depth 1`,
-        {
-          signal: abortController?.signal,
-          env: process.env,
-        },
-      ],
-      { verbose }
-    )
-
-    if (version) {
-      const packageJsonPath = path.join(nextjsDirectory, "package.json")
-      updatePackageVersions(packageJsonPath, version, { applyChanges: true })
-    }
-
-    const execOptions = {
-      signal: abortController?.signal,
-      cwd: nextjsDirectory,
-    }
-    await packageManager.installDependencies(execOptions)
-  } catch (e) {
-    if (isAbortError(e)) {
-      process.exit()
-    }
-
-    logMessage({
-      message: `An error occurred while installing Next.js Starter Storefront: ${e}`,
-      type: "error",
-    })
-  }
-
-  fs.rmSync(path.join(nextjsDirectory, ".git"), {
-    recursive: true,
-    force: true,
-  })
-
-  fs.renameSync(
-    path.join(nextjsDirectory, ".env.template"),
-    path.join(nextjsDirectory, ".env.local")
-  )
-
-  displayFactBox({
-    ...factBoxOptions,
-    message: `Installed Next.js Starter Storefront successfully in the ${nextjsDirectory} directory.`,
-  })
-
-  return nextjsDirectory
-}
-
-type StartOptions = {
-  directory: string
-  abortController?: AbortController
-  verbose?: boolean
-  packageManager: PackageManager
-}
-
-export function startNextjsStarter({
-  directory,
-  abortController,
-  verbose = false,
-  packageManager,
-}: StartOptions) {
-  const command = packageManager.getCommandStr(`dev`)
-  const childProcess = exec(command, {
-    cwd: directory,
-    signal: abortController?.signal,
-  })
-
-  if (verbose) {
-    childProcess.stdout?.pipe(process.stdout)
-    childProcess.stderr?.pipe(process.stderr)
-  }
-}