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

package/lib/commands/services/vcs.ts

@@ -3,10 +3,15 @@ import { sdkForProject } from "../../sdks.js";
 import {
   actionRunner,
   commandDescriptions,
+  success,
+  parse,
   parseBool,
   parseInteger,
 } from "../../parser.js";
-import { Vcs, VCSDetectionType } from "@appwrite.io/console";
+import {
+  Vcs,
+  VCSDetectionType,
+} from "@appwrite.io/console";
 
 let vcsClient: Vcs | null = null;
 
@@ -26,208 +31,103 @@ export const vcs = new Command("vcs")
 
 vcs
   .command(`create-repository-detection`)
-  .description(
-    `Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.`,
-  )
+  .description(`Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
-  .requiredOption(
-    `--provider-repository-id <provider-repository-id>`,
-    `Repository Id`,
-  )
-  .requiredOption(
-    `--type <type>`,
-    `Detector type. Must be one of the following: runtime, framework`,
-  )
-  .option(
-    `--provider-root-directory <provider-root-directory>`,
-    `Path to Root Directory`,
-  )
+  .requiredOption(`--provider-repository-id <provider-repository-id>`, `Repository Id`)
+  .requiredOption(`--type <type>`, `Detector type. Must be one of the following: runtime, framework`)
+  .option(`--provider-root-directory <provider-root-directory>`, `Path to Root Directory`)
   .action(
     actionRunner(
-      async ({
-        installationId,
-        providerRepositoryId,
-        xType,
-        providerRootDirectory,
-      }) =>
-        await (
-          await getVcsClient()
-        ).createRepositoryDetection(
-          installationId,
-          providerRepositoryId,
-          xType as VCSDetectionType,
-          providerRootDirectory,
-        ),
+      async ({ installationId, providerRepositoryId, type, providerRootDirectory }) =>
+        parse(await (await getVcsClient()).createRepositoryDetection(installationId, providerRepositoryId, type as VCSDetectionType, providerRootDirectory)),
     ),
   );
 
 vcs
   .command(`list-repositories`)
-  .description(
-    `Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.`,
-  )
+  .description(`Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
-  .requiredOption(
-    `--type <type>`,
-    `Detector type. Must be one of the following: runtime, framework`,
-  )
-  .option(
-    `--search <search>`,
-    `Search term to filter your list results. Max length: 256 chars.`,
-  )
-  .option(
-    `--queries [queries...]`,
-    `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset`,
-  )
+  .requiredOption(`--type <type>`, `Detector type. Must be one of the following: runtime, framework`)
+  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
+  .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset`)
   .action(
     actionRunner(
-      async ({ installationId, xType, search, queries }) =>
-        await (
-          await getVcsClient()
-        ).listRepositories(
-          installationId,
-          xType as VCSDetectionType,
-          search,
-          queries,
-        ),
+      async ({ installationId, type, search, queries }) =>
+        parse(await (await getVcsClient()).listRepositories(installationId, type as VCSDetectionType, search, queries)),
     ),
   );
 
 vcs
   .command(`create-repository`)
-  .description(
-    `Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.`,
-  )
+  .description(`Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
   .requiredOption(`--name <name>`, `Repository name (slug)`)
-  .requiredOption(
-    `--private <private>`,
-    `Mark repository public or private`,
-    parseBool,
-  )
+  .requiredOption(`--xprivate <xprivate>`, `Mark repository public or private`, parseBool)
   .action(
     actionRunner(
-      async ({ installationId, name, xPrivate }) =>
-        await (
-          await getVcsClient()
-        ).createRepository(installationId, name, xPrivate),
+      async ({ installationId, name, xprivate }) =>
+        parse(await (await getVcsClient()).createRepository(installationId, name, xprivate)),
     ),
   );
 
 vcs
   .command(`get-repository`)
-  .description(
-    `Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.`,
-  )
+  .description(`Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
-  .requiredOption(
-    `--provider-repository-id <provider-repository-id>`,
-    `Repository Id`,
-  )
+  .requiredOption(`--provider-repository-id <provider-repository-id>`, `Repository Id`)
   .action(
     actionRunner(
       async ({ installationId, providerRepositoryId }) =>
-        await (
-          await getVcsClient()
-        ).getRepository(installationId, providerRepositoryId),
+        parse(await (await getVcsClient()).getRepository(installationId, providerRepositoryId)),
     ),
   );
 
 vcs
   .command(`list-repository-branches`)
-  .description(
-    `Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
-`,
-  )
+  .description(`Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
+`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
-  .requiredOption(
-    `--provider-repository-id <provider-repository-id>`,
-    `Repository Id`,
-  )
+  .requiredOption(`--provider-repository-id <provider-repository-id>`, `Repository Id`)
   .action(
     actionRunner(
       async ({ installationId, providerRepositoryId }) =>
-        await (
-          await getVcsClient()
-        ).listRepositoryBranches(installationId, providerRepositoryId),
+        parse(await (await getVcsClient()).listRepositoryBranches(installationId, providerRepositoryId)),
     ),
   );
 
 vcs
   .command(`get-repository-contents`)
-  .description(
-    `Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.`,
-  )
+  .description(`Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
-  .requiredOption(
-    `--provider-repository-id <provider-repository-id>`,
-    `Repository Id`,
-  )
-  .option(
-    `--provider-root-directory <provider-root-directory>`,
-    `Path to get contents of nested directory`,
-  )
-  .option(
-    `--provider-reference <provider-reference>`,
-    `Git reference (branch, tag, commit) to get contents from`,
-  )
+  .requiredOption(`--provider-repository-id <provider-repository-id>`, `Repository Id`)
+  .option(`--provider-root-directory <provider-root-directory>`, `Path to get contents of nested directory`)
+  .option(`--provider-reference <provider-reference>`, `Git reference (branch, tag, commit) to get contents from`)
   .action(
     actionRunner(
-      async ({
-        installationId,
-        providerRepositoryId,
-        providerRootDirectory,
-        providerReference,
-      }) =>
-        await (
-          await getVcsClient()
-        ).getRepositoryContents(
-          installationId,
-          providerRepositoryId,
-          providerRootDirectory,
-          providerReference,
-        ),
+      async ({ installationId, providerRepositoryId, providerRootDirectory, providerReference }) =>
+        parse(await (await getVcsClient()).getRepositoryContents(installationId, providerRepositoryId, providerRootDirectory, providerReference)),
     ),
   );
 
 vcs
   .command(`update-external-deployments`)
-  .description(
-    `Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.`,
-  )
+  .description(`Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
   .requiredOption(`--repository-id <repository-id>`, `VCS Repository Id`)
-  .requiredOption(
-    `--provider-pull-request-id <provider-pull-request-id>`,
-    `GitHub Pull Request Id`,
-  )
+  .requiredOption(`--provider-pull-request-id <provider-pull-request-id>`, `GitHub Pull Request Id`)
   .action(
     actionRunner(
       async ({ installationId, repositoryId, providerPullRequestId }) =>
-        await (
-          await getVcsClient()
-        ).updateExternalDeployments(
-          installationId,
-          repositoryId,
-          providerPullRequestId,
-        ),
+        parse(await (await getVcsClient()).updateExternalDeployments(installationId, repositoryId, providerPullRequestId)),
     ),
   );
 
 vcs
   .command(`list-installations`)
-  .description(
-    `List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
-`,
-  )
-  .option(
-    `--queries [queries...]`,
-    `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: provider, organization`,
-  )
-  .option(
-    `--search <search>`,
-    `Search term to filter your list results. Max length: 256 chars.`,
-  )
+  .description(`List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
+`)
+  .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: provider, organization`)
+  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
   .option(
     `--total [value]`,
     `When set to false, the total count returned will be 0 and will not be calculated.`,
@@ -237,32 +137,29 @@ vcs
   .action(
     actionRunner(
       async ({ queries, search, total }) =>
-        await (await getVcsClient()).listInstallations(queries, search, total),
+        parse(await (await getVcsClient()).listInstallations(queries, search, total)),
     ),
   );
 
 vcs
   .command(`get-installation`)
-  .description(
-    `Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. `,
-  )
+  .description(`Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. `)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
   .action(
     actionRunner(
       async ({ installationId }) =>
-        await (await getVcsClient()).getInstallation(installationId),
+        parse(await (await getVcsClient()).getInstallation(installationId)),
     ),
   );
 
 vcs
   .command(`delete-installation`)
-  .description(
-    `Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.`,
-  )
+  .description(`Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.`)
   .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
   .action(
     actionRunner(
       async ({ installationId }) =>
-        await (await getVcsClient()).deleteInstallation(installationId),
+        parse(await (await getVcsClient()).deleteInstallation(installationId)),
     ),
   );
+

package/lib/commands/types.ts

@@ -217,4 +217,4 @@ export const types = new Command("types")
   .addArgument(typesOutputArgument)
   .addOption(typesLanguageOption)
   .addOption(typesStrictOption)
-  .action(actionRunner(typesCommand));
+  .action(typesCommand);

package/lib/commands/update.ts

@@ -1,19 +1,14 @@
-import fs from "fs";
-import path from "path";
 import { spawn } from "child_process";
 import { Command } from "commander";
 import chalk from "chalk";
 import inquirer from "inquirer";
-import {
-  success,
-  log,
-  warn,
-  error,
-  hint,
-  actionRunner,
-  commandDescriptions,
-} from "../parser.js";
+import { success, log, warn, error, hint, actionRunner } from "../parser.js";
 import { getLatestVersion, compareVersions } from "../utils.js";
+import {
+  GITHUB_RELEASES_URL,
+  NPM_PACKAGE_NAME,
+  SDK_TITLE,
+} from "../constants.js";
 import packageJson from "../../package.json" with { type: "json" };
 const { version } = packageJson;
 
@@ -26,7 +21,7 @@ const isInstalledViaNpm = (): boolean => {
 
     if (
       scriptPath.includes("node_modules") &&
-      scriptPath.includes("appwrite-cli")
+      scriptPath.includes(NPM_PACKAGE_NAME)
     ) {
       return true;
     }
@@ -95,7 +90,7 @@ const execCommand = (
  */
 const updateViaNpm = async (): Promise<void> => {
   try {
-    await execCommand("npm", ["install", "-g", "appwrite-cli@latest"]);
+    await execCommand("npm", ["install", "-g", `${NPM_PACKAGE_NAME}@latest`]);
     console.log("");
     success("Updated to latest version via npm!");
     hint("Run 'appwrite --version' to verify the new version.");
@@ -110,7 +105,7 @@ const updateViaNpm = async (): Promise<void> => {
     } else {
       console.log("");
       error(`Failed to update via npm: ${e.message}`);
-      hint("Try running: npm install -g appwrite-cli@latest --force");
+      hint(`Try running: npm install -g ${NPM_PACKAGE_NAME}@latest --force`);
     }
   }
 };
@@ -148,7 +143,7 @@ const showManualInstructions = (latestVersion: string): void => {
   console.log("");
 
   log(`${chalk.bold("Option 1: NPM")}`);
-  console.log(`  npm install -g appwrite-cli@latest`);
+  console.log(`  npm install -g ${NPM_PACKAGE_NAME}@latest`);
   console.log("");
 
   log(`${chalk.bold("Option 2: Homebrew")}`);
@@ -156,9 +151,7 @@ const showManualInstructions = (latestVersion: string): void => {
   console.log("");
 
   log(`${chalk.bold("Option 3: Download Binary")}`);
-  console.log(
-    `  Visit: https://github.com/appwrite-cli/releases/tag/${latestVersion}`,
-  );
+  console.log(`  Visit: ${GITHUB_RELEASES_URL}/tag/${latestVersion}`);
 };
 
 /**
@@ -240,14 +233,12 @@ const updateCli = async ({ manual }: UpdateOptions = {}): Promise<void> => {
   } catch (e: any) {
     console.log("");
     error(`Failed to check for updates: ${e.message}`);
-    hint(
-      "You can manually check for updates at: https://github.com/appwrite-cli/releases",
-    );
+    hint(`You can manually check for updates at: ${GITHUB_RELEASES_URL}`);
   }
 };
 
 export const update = new Command("update")
-  .description("Update the Appwrite CLI to the latest version")
+  .description(`Update the ${SDK_TITLE} CLI to the latest version`)
   .option(
     "--manual",
     "Show manual update instructions instead of auto-updating",