appwrite-cli 13.0.0-rc.2 → 13.0.0-rc.3

package/lib/emulation/docker.ts

@@ -10,7 +10,7 @@ import fs from "fs";
 import { log, error, success } from "../parser.js";
 import { openRuntimesVersion, systemTools, Queue } from "./utils.js";
 import { getAllFiles } from "../utils.js";
-import type { FunctionConfig } from "../types.js";
+import type { FunctionType } from "../commands/config.js";
 
 export async function dockerStop(id: string): Promise<void> {
   const stopProcess = childProcess.spawn("docker", ["rm", "--force", id], {
@@ -26,7 +26,7 @@ export async function dockerStop(id: string): Promise<void> {
   });
 }
 
-export async function dockerPull(func: FunctionConfig): Promise<void> {
+export async function dockerPull(func: FunctionType): Promise<void> {
   const runtimeChunks = func.runtime.split("-");
   const runtimeVersion = runtimeChunks.pop();
   const runtimeName = runtimeChunks.join("-");
@@ -48,7 +48,7 @@ export async function dockerPull(func: FunctionConfig): Promise<void> {
 }
 
 export async function dockerBuild(
-  func: FunctionConfig,
+  func: FunctionType,
   variables: Record<string, string>,
 ): Promise<void> {
   const runtimeChunks = func.runtime.split("-");
@@ -78,111 +78,125 @@ export async function dockerBuild(
     fs.mkdirSync(tmpBuildPath, { recursive: true });
   }
 
-  for (const f of files) {
-    const filePath = path.join(tmpBuildPath, f);
-    const fileDir = path.dirname(filePath);
-    if (!fs.existsSync(fileDir)) {
-      fs.mkdirSync(fileDir, { recursive: true });
+  let killInterval: ReturnType<typeof setInterval> | undefined;
+
+  try {
+    for (const f of files) {
+      const filePath = path.join(tmpBuildPath, f);
+      const fileDir = path.dirname(filePath);
+      if (!fs.existsSync(fileDir)) {
+        fs.mkdirSync(fileDir, { recursive: true });
+      }
+
+      const sourcePath = path.join(functionDir, f);
+      fs.copyFileSync(sourcePath, filePath);
     }
 
-    const sourcePath = path.join(functionDir, f);
-    fs.copyFileSync(sourcePath, filePath);
-  }
+    const params: string[] = ["run"];
+    params.push("--name", id);
+    params.push("-v", `${tmpBuildPath}/:/mnt/code:rw`);
+    params.push("-e", "OPEN_RUNTIMES_ENV=development");
+    params.push("-e", "OPEN_RUNTIMES_SECRET=");
+    params.push("-e", `OPEN_RUNTIMES_ENTRYPOINT=${func.entrypoint}`);
 
-  const params: string[] = ["run"];
-  params.push("--name", id);
-  params.push("-v", `${tmpBuildPath}/:/mnt/code:rw`);
-  params.push("-e", "OPEN_RUNTIMES_ENV=development");
-  params.push("-e", "OPEN_RUNTIMES_SECRET=");
-  params.push("-e", `OPEN_RUNTIMES_ENTRYPOINT=${func.entrypoint}`);
+    for (const k of Object.keys(variables)) {
+      params.push("-e", `${k}=${variables[k]}`);
+    }
 
-  for (const k of Object.keys(variables)) {
-    params.push("-e", `${k}=${variables[k]}`);
-  }
+    params.push(imageName, "sh", "-c", `helpers/build.sh "${func.commands}"`);
 
-  params.push(imageName, "sh", "-c", `helpers/build.sh "${func.commands}"`);
+    const buildProcess = childProcess.spawn("docker", params, {
+      stdio: "pipe",
+      cwd: functionDir,
+      env: {
+        ...process.env,
+        DOCKER_CLI_HINTS: "false",
+      },
+    });
 
-  const buildProcess = childProcess.spawn("docker", params, {
-    stdio: "pipe",
-    cwd: functionDir,
-    env: {
-      ...process.env,
-      DOCKER_CLI_HINTS: "false",
-    },
-  });
+    buildProcess.stdout.on("data", (data) => {
+      process.stdout.write(chalk.blackBright(`${data}\n`));
+    });
 
-  buildProcess.stdout.on("data", (data) => {
-    process.stdout.write(chalk.blackBright(`${data}\n`));
-  });
+    buildProcess.stderr.on("data", (data) => {
+      process.stderr.write(chalk.blackBright(`${data}\n`));
+    });
 
-  buildProcess.stderr.on("data", (data) => {
-    process.stderr.write(chalk.blackBright(`${data}\n`));
-  });
+    killInterval = setInterval(() => {
+      if (!Queue.isEmpty()) {
+        log("Cancelling build ...");
+        buildProcess.stdout.destroy();
+        buildProcess.stdin.destroy();
+        buildProcess.stderr.destroy();
+        buildProcess.kill("SIGKILL");
+        clearInterval(killInterval);
+      }
+    }, 100);
 
-  const killInterval = setInterval(() => {
-    if (!Queue.isEmpty()) {
-      log("Cancelling build ...");
-      buildProcess.stdout.destroy();
-      buildProcess.stdin.destroy();
-      buildProcess.stderr.destroy();
-      buildProcess.kill("SIGKILL");
-      clearInterval(killInterval);
-    }
-  }, 100);
+    await new Promise<void>((res) => {
+      buildProcess.on("close", res);
+    });
 
-  await new Promise<void>((res) => {
-    buildProcess.on("close", res);
-  });
+    clearInterval(killInterval);
+    killInterval = undefined;
 
-  clearInterval(killInterval);
-  if (!Queue.isEmpty()) {
-    return;
-  }
+    if (!Queue.isEmpty()) {
+      await dockerStop(id);
+      return;
+    }
 
-  const copyPath = path.join(
-    localConfig.getDirname(),
-    func.path,
-    ".appwrite",
-    "build.tar.gz",
-  );
-  const copyDir = path.dirname(copyPath);
-  if (!fs.existsSync(copyDir)) {
-    fs.mkdirSync(copyDir, { recursive: true });
-  }
+    const copyPath = path.join(
+      localConfig.getDirname(),
+      func.path,
+      ".appwrite",
+      "build.tar.gz",
+    );
+    const copyDir = path.dirname(copyPath);
+    if (!fs.existsSync(copyDir)) {
+      fs.mkdirSync(copyDir, { recursive: true });
+    }
 
-  const copyProcess = childProcess.spawn(
-    "docker",
-    ["cp", `${id}:/mnt/code/code.tar.gz`, copyPath],
-    {
-      stdio: "pipe",
-      cwd: functionDir,
-      env: {
-        ...process.env,
-        DOCKER_CLI_HINTS: "false",
+    const copyProcess = childProcess.spawn(
+      "docker",
+      ["cp", `${id}:/mnt/code/code.tar.gz`, copyPath],
+      {
+        stdio: "pipe",
+        cwd: functionDir,
+        env: {
+          ...process.env,
+          DOCKER_CLI_HINTS: "false",
+        },
       },
-    },
-  );
+    );
 
-  await new Promise<void>((res) => {
-    copyProcess.on("close", res);
-  });
+    await new Promise<void>((res) => {
+      copyProcess.on("close", res);
+    });
 
-  await dockerStop(id);
+    await dockerStop(id);
+  } finally {
+    // Clean up interval if still running
+    if (killInterval !== undefined) {
+      clearInterval(killInterval);
+    }
 
-  const tempPath = path.join(
-    localConfig.getDirname(),
-    func.path,
-    "code.tar.gz",
-  );
-  if (fs.existsSync(tempPath)) {
-    fs.rmSync(tempPath, { force: true });
-  }
+    // Clean up temp files
+    const tempPath = path.join(
+      localConfig.getDirname(),
+      func.path,
+      "code.tar.gz",
+    );
+    if (fs.existsSync(tempPath)) {
+      fs.rmSync(tempPath, { force: true });
+    }
 
-  fs.rmSync(tmpBuildPath, { recursive: true, force: true });
+    // Always clean up tmpBuildPath
+    fs.rmSync(tmpBuildPath, { recursive: true, force: true });
+  }
 }
 
 export async function dockerStart(
-  func: FunctionConfig,
+  func: FunctionType,
   variables: Record<string, string>,
   port: number,
 ): Promise<void> {

package/lib/parser.ts

@@ -8,6 +8,12 @@ import os from "os";
 import { Client } from "@appwrite.io/console";
 import { isCloud } from "./utils.js";
 import type { CliConfig } from "./types.js";
+import {
+  SDK_VERSION,
+  SDK_TITLE,
+  SDK_LOGO,
+  EXECUTABLE_NAME,
+} from "./constants.js";
 
 const cliConfig: CliConfig = {
   verbose: false,
@@ -128,8 +134,8 @@ export const parseError = (err: Error): void => {
         // Silently fail
       }
 
-      const version = "13.0.0-rc.2";
-      const stepsToReproduce = `Running \`appwrite ${(cliConfig.reportData as any).data.args.join(" ")}\``;
+      const version = SDK_VERSION;
+      const stepsToReproduce = `Running \`${EXECUTABLE_NAME} ${(cliConfig.reportData as any).data.args.join(" ")}\``;
       const yourEnvironment = `CLI version: ${version}\nOperation System: ${os.type()}\nAppwrite version: ${appwriteVersion}\nIs Cloud: ${isCloud()}`;
 
       const stack = "```\n" + (err.stack || err.message) + "\n```";
@@ -226,8 +232,7 @@ export const error = (message?: string): void => {
   console.error(`${chalk.red.bold("✗ Error:")} ${chalk.red(message ?? "")}`);
 };
 
-export const logo =
-  "\n    _                            _ _           ___   __   _____\n   \/_\\  _ __  _ ____      ___ __(_) |_ ___    \/ __\\ \/ \/   \\_   \\\n  \/\/_\\\\| '_ \\| '_ \\ \\ \/\\ \/ \/ '__| | __\/ _ \\  \/ \/   \/ \/     \/ \/\\\/\n \/  _  \\ |_) | |_) \\ V  V \/| |  | | ||  __\/ \/ \/___\/ \/___\/\\\/ \/_\n \\_\/ \\_\/ .__\/| .__\/ \\_\/\\_\/ |_|  |_|\\__\\___| \\____\/\\____\/\\____\/\n       |_|   |_|\n\n";
+export const logo = SDK_LOGO;
 
 export const commandDescriptions: Record<string, string> = {
   account: `The account command allows you to authenticate and manage a user account.`,
@@ -235,25 +240,25 @@ export const commandDescriptions: Record<string, string> = {
   avatars: `The avatars command aims to help you complete everyday tasks related to your app image, icons, and avatars.`,
   databases: `(Legacy) The databases command allows you to create structured collections of documents and query and filter lists of documents.`,
   "tables-db": `The tables-db command allows you to create structured tables of columns and query and filter lists of rows.`,
-  init: `The init command provides a convenient wrapper for creating and initializing projects, functions, collections, buckets, teams, and messaging-topics in  Appwrite.`,
+  init: `The init command provides a convenient wrapper for creating and initializing projects, functions, collections, buckets, teams, and messaging-topics in ${SDK_TITLE}.`,
   push: `The push command provides a convenient wrapper for pushing your functions, collections, buckets, teams, and messaging-topics.`,
   run: `The run command allows you to run the project locally to allow easy development and quick debugging.`,
   functions: `The functions command allows you to view, create, and manage your Cloud Functions.`,
-  health: `The health command allows you to both validate and monitor your Appwrite server's health.`,
-  pull: `The pull command helps you pull your Appwrite project, functions, collections, buckets, teams, and messaging-topics`,
+  health: `The health command allows you to both validate and monitor your ${SDK_TITLE} server's health.`,
+  pull: `The pull command helps you pull your ${SDK_TITLE} project, functions, collections, buckets, teams, and messaging-topics`,
   locale: `The locale command allows you to customize your app based on your users' location.`,
   sites: `The sites command allows you to view, create and manage your Appwrite Sites.`,
   storage: `The storage command allows you to manage your project files.`,
   teams: `The teams command allows you to group users of your project to enable them to share read and write access to your project resources.`,
-  update: `The update command allows you to update the Appwrite CLI to the latest version.`,
+  update: `The update command allows you to update the ${SDK_TITLE} CLI to the latest version.`,
   users: `The users command allows you to manage your project users.`,
   projects: `The projects command allows you to manage your projects, add platforms, manage API keys, Dev Keys etc.`,
   project: `The project command allows you to manage project related resources like usage, variables, etc.`,
   client: `The client command allows you to configure your CLI`,
   login: `The login command allows you to authenticate and manage a user account.`,
-  logout: `The logout command allows you to log out of your Appwrite account.`,
-  whoami: `The whomai command gives information about the currently logged-in user.`,
-  register: `Outputs the link to create an Appwrite account.`,
+  logout: `The logout command allows you to log out of your ${SDK_TITLE} account.`,
+  whoami: `The whoami command gives information about the currently logged-in user.`,
+  register: `Outputs the link to create an ${SDK_TITLE} account.`,
   console: `The console command gives you access to the APIs used by the Appwrite Console.`,
   messaging: `The messaging command allows you to manage topics and targets and send messages.`,
   migrations: `The migrations command allows you to migrate data between services.`,

package/lib/questions.ts

@@ -13,6 +13,7 @@ import {
   getSitesService,
   getDatabasesService,
 } from "./services.js";
+import { SDK_TITLE, DEFAULT_ENDPOINT, EXECUTABLE_NAME } from "./constants.js";
 
 interface Answers {
   override?: boolean;
@@ -48,9 +49,9 @@ const whenOverride = (answers: Answers): boolean =>
   answers.override === undefined ? true : answers.override;
 
 const getIgnores = (runtime: string): string[] => {
-  const languge = runtime.split("-").slice(0, -1).join("-");
+  const language = runtime.split("-").slice(0, -1).join("-");
 
-  switch (languge) {
+  switch (language) {
     case "cpp":
       return ["build", "CMakeFiles", "CMakeCaches.txt"];
     case "dart":
@@ -82,9 +83,9 @@ const getIgnores = (runtime: string): string[] => {
 };
 
 const getEntrypoint = (runtime: string): string | undefined => {
-  const languge = runtime.split("-").slice(0, -1).join("-");
+  const language = runtime.split("-").slice(0, -1).join("-");
 
-  switch (languge) {
+  switch (language) {
     case "dart":
       return "lib/main.dart";
     case "deno":
@@ -120,9 +121,9 @@ const getEntrypoint = (runtime: string): string | undefined => {
 };
 
 const getInstallCommand = (runtime: string): string | undefined => {
-  const languge = runtime.split("-").slice(0, -1).join("-");
+  const language = runtime.split("-").slice(0, -1).join("-");
 
-  switch (languge) {
+  switch (language) {
     case "dart":
       return "dart pub get";
     case "deno":
@@ -156,7 +157,7 @@ export const questionsInitProject: Question[] = [
   {
     type: "confirm",
     name: "override",
-    message: `An Appwrite project ( ${localConfig.getProject()["projectId"]} ) is already associated with the current directory. Would you like to override`,
+    message: `An ${SDK_TITLE} project ( ${localConfig.getProject()["projectId"]} ) is already associated with the current directory. Would you like to override it?`,
     when() {
       return Object.keys(localConfig.getProject()).length !== 0;
     },
@@ -233,7 +234,7 @@ export const questionsInitProject: Question[] = [
   {
     type: "search-list",
     name: "project",
-    message: "Choose your Appwrite project.",
+    message: `Choose your ${SDK_TITLE} project.`,
     choices: async (answers: Answers) => {
       const queries = [
         JSON.stringify({
@@ -273,11 +274,10 @@ export const questionsInitProject: Question[] = [
   {
     type: "list",
     name: "region",
-    message: "Select your Appwrite Cloud region",
+    message: `Select your ${SDK_TITLE} Cloud region`,
     choices: async () => {
       let client = await sdkForConsole(true);
-      const endpoint =
-        globalConfig.getEndpoint() || "https://cloud.appwrite.io/v1";
+      const endpoint = globalConfig.getEndpoint() || DEFAULT_ENDPOINT;
       let response = (await client.call(
         "GET",
         new URL(endpoint + "/console/regions"),
@@ -306,7 +306,7 @@ export const questionsInitProjectAutopull: Question[] = [
   {
     type: "confirm",
     name: "autopull",
-    message: `Would you like to pull all resources from project you just linked?`,
+    message: `Would you like to pull all resources from the project you just linked?`,
   },
 ];
 
@@ -348,7 +348,7 @@ export const questionsPullFunctions: Question[] = [
       );
 
       if (functions.length === 0) {
-        throw "We couldn't find any functions in your Appwrite project";
+        throw `We couldn't find any functions in your ${SDK_TITLE} project`;
       }
       return functions.map((func: any) => {
         return {
@@ -383,7 +383,7 @@ export const questionsPullSites: Question[] = [
       );
 
       if (sites.length === 0) {
-        throw "We couldn't find any sites in your Appwrite project";
+        throw `We couldn't find any sites in your ${SDK_TITLE} project`;
       }
       return sites.map((site: any) => {
         return {
@@ -502,7 +502,7 @@ export const questionsCreateBucket: Question[] = [
 export const questionsCreateTeam: Question[] = [
   {
     type: "input",
-    name: "bucket",
+    name: "team",
     message: "What would you like to name your team?",
     default: "My Awesome Team",
   },
@@ -703,7 +703,7 @@ export const questionsLogin: Question[] = [
   {
     type: "list",
     name: "method",
-    message: "What you like to do?",
+    message: "What would you like to do?",
     choices: [
       { name: "Login to an account", value: "login" },
       { name: "Switch to an account", value: "select" },
@@ -771,7 +771,7 @@ export const questionGetEndpoint: Question[] = [
   {
     type: "input",
     name: "endpoint",
-    message: "Enter the endpoint of your Appwrite server",
+    message: `Enter the endpoint of your ${SDK_TITLE} server`,
     default: "http://localhost/v1",
     async validate(value: string) {
       if (!value) {
@@ -1014,7 +1014,6 @@ export const questionsGetEntrypoint: Question[] = [
     type: "input",
     name: "entrypoint",
     message: "Enter the entrypoint",
-    default: null,
     validate(value: string) {
       if (!value) {
         return "Please enter your entrypoint";
@@ -1062,11 +1061,11 @@ export const questionsListFactors: Question[] = [
           value: "totp",
         },
         {
-          name: `Email (Get a security code at your Appwrite email address)`,
+          name: `Email (Get a security code at your ${SDK_TITLE} email address)`,
           value: "email",
         },
         {
-          name: `SMS (Get a security code on your Appwrite phone number)`,
+          name: `SMS (Get a security code on your ${SDK_TITLE} phone number)`,
           value: "phone",
         },
         {
@@ -1104,7 +1103,7 @@ export const questionsRunFunctions: Question[] = [
       let functions = localConfig.getFunctions();
       if (functions.length === 0) {
         throw new Error(
-          "No functions found. Use 'appwrite pull functions' to synchronize existing one, or use 'appwrite init function' to create a new one.",
+          `No functions found. Use '${EXECUTABLE_NAME} pull functions' to synchronize existing one, or use '${EXECUTABLE_NAME} init function' to create a new one.`,
         );
       }
       let choices = functions.map((func: any, idx: number) => {

package/lib/sdks.ts

@@ -1,18 +1,24 @@
 import { globalConfig, localConfig } from "./config.js";
 import { Client } from "@appwrite.io/console";
 import os from "os";
+import {
+  DEFAULT_ENDPOINT,
+  EXECUTABLE_NAME,
+  SDK_TITLE,
+  SDK_VERSION,
+} from "./constants.js";
 
 export const sdkForConsole = async (
   requiresAuth: boolean = true,
 ): Promise<Client> => {
   const client = new Client();
-  const endpoint = globalConfig.getEndpoint() || "https://cloud.appwrite.io/v1";
+  const endpoint = globalConfig.getEndpoint() || DEFAULT_ENDPOINT;
   const cookie = globalConfig.getCookie();
   const selfSigned = globalConfig.getSelfSigned();
 
   if (requiresAuth && cookie === "") {
     throw new Error(
-      "Session not found. Please run `appwrite login` to create a session",
+      `Session not found. Please run \`${EXECUTABLE_NAME} login\` to create a session`,
     );
   }
 
@@ -20,8 +26,8 @@ export const sdkForConsole = async (
     "x-sdk-name": "Command Line",
     "x-sdk-platform": "console",
     "x-sdk-language": "cli",
-    "x-sdk-version": "13.0.0-rc.2",
-    "user-agent": `AppwriteCLI/13.0.0-rc.2 (${os.type()} ${os.version()}; ${os.arch()})`,
+    "x-sdk-version": SDK_VERSION,
+    "user-agent": `AppwriteCLI/${SDK_VERSION} (${os.type()} ${os.version()}; ${os.arch()})`,
   };
 
   client
@@ -38,9 +44,7 @@ export const sdkForProject = async (): Promise<Client> => {
   const client = new Client();
 
   const endpoint =
-    localConfig.getEndpoint() ||
-    globalConfig.getEndpoint() ||
-    "https://cloud.appwrite.io/v1";
+    localConfig.getEndpoint() || globalConfig.getEndpoint() || DEFAULT_ENDPOINT;
 
   const project = localConfig.getProject().projectId
     ? localConfig.getProject().projectId
@@ -52,7 +56,7 @@ export const sdkForProject = async (): Promise<Client> => {
 
   if (!project) {
     throw new Error(
-      "Project is not set. Please run `appwrite init project` to initialize the current directory with an Appwrite project.",
+      `Project is not set. Please run \`${EXECUTABLE_NAME} init project\` to initialize the current directory with an ${SDK_TITLE} project.`,
     );
   }
 
@@ -60,8 +64,8 @@ export const sdkForProject = async (): Promise<Client> => {
     "x-sdk-name": "Command Line",
     "x-sdk-platform": "console",
     "x-sdk-language": "cli",
-    "x-sdk-version": "13.0.0-rc.2",
-    "user-agent": `AppwriteCLI/13.0.0-rc.2 (${os.type()} ${os.version()}; ${os.arch()})`,
+    "x-sdk-version": SDK_VERSION,
+    "user-agent": `AppwriteCLI/${SDK_VERSION} (${os.type()} ${os.version()}; ${os.arch()})`,
   };
 
   client
@@ -79,6 +83,6 @@ export const sdkForProject = async (): Promise<Client> => {
   }
 
   throw new Error(
-    "Session not found. Please run `appwrite login` to create a session.",
+    `Session not found. Please run \`${EXECUTABLE_NAME} login\` to create a session.`,
   );
 };