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

package/lib/commands/services/vcs.ts

@@ -0,0 +1,268 @@
+import { Command } from "commander";
+import { sdkForProject } from "../../sdks.js";
+import {
+  actionRunner,
+  commandDescriptions,
+  parseBool,
+  parseInteger,
+} from "../../parser.js";
+import { Vcs, VCSDetectionType } from "@appwrite.io/console";
+
+let vcsClient: Vcs | null = null;
+
+const getVcsClient = async (): Promise<Vcs> => {
+  if (!vcsClient) {
+    const sdkClient = await sdkForProject();
+    vcsClient = new Vcs(sdkClient);
+  }
+  return vcsClient;
+};
+
+export const vcs = new Command("vcs")
+  .description(commandDescriptions["vcs"] ?? "")
+  .configureHelp({
+    helpWidth: process.stdout.columns || 80,
+  });
+
+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.`,
+  )
+  .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`,
+  )
+  .action(
+    actionRunner(
+      async ({
+        installationId,
+        providerRepositoryId,
+        xType,
+        providerRootDirectory,
+      }) =>
+        await (
+          await getVcsClient()
+        ).createRepositoryDetection(
+          installationId,
+          providerRepositoryId,
+          xType 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.`,
+  )
+  .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`,
+  )
+  .action(
+    actionRunner(
+      async ({ installationId, xType, search, queries }) =>
+        await (
+          await getVcsClient()
+        ).listRepositories(
+          installationId,
+          xType 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.`,
+  )
+  .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
+  .requiredOption(`--name <name>`, `Repository name (slug)`)
+  .requiredOption(
+    `--private <private>`,
+    `Mark repository public or private`,
+    parseBool,
+  )
+  .action(
+    actionRunner(
+      async ({ installationId, name, xPrivate }) =>
+        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.`,
+  )
+  .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
+  .requiredOption(
+    `--provider-repository-id <provider-repository-id>`,
+    `Repository Id`,
+  )
+  .action(
+    actionRunner(
+      async ({ installationId, providerRepositoryId }) =>
+        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.
+`,
+  )
+  .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
+  .requiredOption(
+    `--provider-repository-id <provider-repository-id>`,
+    `Repository Id`,
+  )
+  .action(
+    actionRunner(
+      async ({ installationId, providerRepositoryId }) =>
+        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.`,
+  )
+  .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`,
+  )
+  .action(
+    actionRunner(
+      async ({
+        installationId,
+        providerRepositoryId,
+        providerRootDirectory,
+        providerReference,
+      }) =>
+        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.`,
+  )
+  .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`,
+  )
+  .action(
+    actionRunner(
+      async ({ installationId, repositoryId, providerPullRequestId }) =>
+        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.`,
+  )
+  .option(
+    `--total [value]`,
+    `When set to false, the total count returned will be 0 and will not be calculated.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
+  .action(
+    actionRunner(
+      async ({ queries, search, total }) =>
+        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. `,
+  )
+  .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
+  .action(
+    actionRunner(
+      async ({ installationId }) =>
+        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.`,
+  )
+  .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
+  .action(
+    actionRunner(
+      async ({ installationId }) =>
+        await (await getVcsClient()).deleteInstallation(installationId),
+    ),
+  );

package/lib/commands/types.ts

@@ -1,20 +1,32 @@
-import ejs = require('ejs');
-import fs = require('fs');
-import path = require('path');
-import { LanguageMeta, detectLanguage, Collection } from '../type-generation/languages/language';
-import { Command, Option, Argument } from 'commander';
-import { localConfig } from '../config';
-import { success, log, warn, actionRunner } from '../parser';
-import { PHP } from '../type-generation/languages/php';
-import { TypeScript } from '../type-generation/languages/typescript';
-import { Kotlin } from '../type-generation/languages/kotlin';
-import { Swift } from '../type-generation/languages/swift';
-import { Java } from '../type-generation/languages/java';
-import { Dart } from '../type-generation/languages/dart';
-import { JavaScript } from '../type-generation/languages/javascript';
-import { CSharp } from '../type-generation/languages/csharp';
-
-type SupportedLanguage = 'ts' | 'js' | 'php' | 'kotlin' | 'swift' | 'java' | 'dart' | 'cs';
+import ejs from "ejs";
+import fs from "fs";
+import path from "path";
+import {
+  LanguageMeta,
+  detectLanguage,
+  Collection,
+} from "../type-generation/languages/language.js";
+import { Command, Option, Argument } from "commander";
+import { localConfig } from "../config.js";
+import { success, log, warn, actionRunner } from "../parser.js";
+import { PHP } from "../type-generation/languages/php.js";
+import { TypeScript } from "../type-generation/languages/typescript.js";
+import { Kotlin } from "../type-generation/languages/kotlin.js";
+import { Swift } from "../type-generation/languages/swift.js";
+import { Java } from "../type-generation/languages/java.js";
+import { Dart } from "../type-generation/languages/dart.js";
+import { JavaScript } from "../type-generation/languages/javascript.js";
+import { CSharp } from "../type-generation/languages/csharp.js";
+
+type SupportedLanguage =
+  | "ts"
+  | "js"
+  | "php"
+  | "kotlin"
+  | "swift"
+  | "java"
+  | "dart"
+  | "cs";
 
 function createLanguageMeta(language: SupportedLanguage): LanguageMeta {
   switch (language) {
@@ -44,145 +56,161 @@ const templateHelpers = {
   toCamelCase: LanguageMeta.toCamelCase,
   toSnakeCase: LanguageMeta.toSnakeCase,
   toKebabCase: LanguageMeta.toKebabCase,
-  toUpperSnakeCase: LanguageMeta.toUpperSnakeCase
+  toUpperSnakeCase: LanguageMeta.toUpperSnakeCase,
 };
 
 const typesOutputArgument = new Argument(
   "<output-directory>",
-  "The directory to write the types to"
+  "The directory to write the types to",
 );
 
 const typesLanguageOption = new Option(
   "-l, --language <language>",
-  "The language of the types"
+  "The language of the types",
 )
   .choices(["auto", "ts", "js", "php", "kotlin", "swift", "java", "dart", "cs"])
   .default("auto");
 
 const typesStrictOption = new Option(
   "-s, --strict",
-  "Enable strict mode to automatically convert field names to follow language conventions"
-)
-  .default(false);
+  "Enable strict mode to automatically convert field names to follow language conventions",
+).default(false);
 
 interface TypesOptions {
   language: string;
   strict: boolean;
 }
 
-const typesCommand = actionRunner(async (rawOutputDirectory: string, {language, strict}: TypesOptions) => {
-  if (language === "auto") {
-    language = detectLanguage();
-    log(`Detected language: ${language}`);
-  }
-
-  if (strict) {
-    warn(`Strict mode enabled: Field names will be converted to follow ${language} conventions`);
-  }
-
-  const meta = createLanguageMeta(language as SupportedLanguage);
-
-  const rawOutputPath = rawOutputDirectory;
-  const outputExt = path.extname(rawOutputPath);
-  const isFileOutput = !!outputExt;
-  let outputDirectory = rawOutputPath;
-  let singleFileDestination: string | null = null;
-
-  if (isFileOutput) {
-    if (meta.isSingleFile()) {
-      // Use the file path directly for single file languages
-      outputDirectory = path.dirname(rawOutputPath);
-      singleFileDestination = rawOutputPath;
-    } else {
-      throw new Error(`Invalid output path: ${rawOutputPath}. Output path must be a directory for languages that generate multiple files.`);
+const typesCommand = actionRunner(
+  async (rawOutputDirectory: string, { language, strict }: TypesOptions) => {
+    if (language === "auto") {
+      language = detectLanguage();
+      log(`Detected language: ${language}`);
     }
-  }
 
-  if (!fs.existsSync(outputDirectory)) {
-    log(`Directory: ${outputDirectory} does not exist, creating...`);
-    fs.mkdirSync(outputDirectory, { recursive: true });
-  }
+    if (strict) {
+      warn(
+        `Strict mode enabled: Field names will be converted to follow ${language} conventions`,
+      );
+    }
 
-  // Try tables first, fallback to collections
-  let tables = localConfig.getTables();
-  let collections: any[] = [];
-  let dataSource = 'tables';
-  
-  if (tables.length === 0) {
-    collections = localConfig.getCollections();
-    dataSource = 'collections';
-    
-    if (collections.length === 0) {
-      const configFileName = path.basename(localConfig.path);
-      throw new Error(`No tables or collections found in configuration. Make sure ${configFileName} exists and contains tables or collections.`);
+    const meta = createLanguageMeta(language as SupportedLanguage);
+
+    const rawOutputPath = rawOutputDirectory;
+    const outputExt = path.extname(rawOutputPath);
+    const isFileOutput = !!outputExt;
+    let outputDirectory = rawOutputPath;
+    let singleFileDestination: string | null = null;
+
+    if (isFileOutput) {
+      if (meta.isSingleFile()) {
+        // Use the file path directly for single file languages
+        outputDirectory = path.dirname(rawOutputPath);
+        singleFileDestination = rawOutputPath;
+      } else {
+        throw new Error(
+          `Invalid output path: ${rawOutputPath}. Output path must be a directory for languages that generate multiple files.`,
+        );
+      }
     }
-  }
 
-  // Use tables if available, otherwise use collections
-  let dataItems: any[] = tables.length > 0 ? tables : collections;
-  const itemType = tables.length > 0 ? 'tables' : 'collections';
-
-  // Normalize tables data: rename 'columns' to 'attributes' for template compatibility
-  if (tables.length > 0) {
-    dataItems = dataItems.map(table => {
-      const { columns, ...rest } = table;
-      return {
-        ...rest,
-        attributes: (columns || []).map((column: any) => {
-          if (column.relatedTable) {
-            const { relatedTable, ...columnRest } = column;
-            return {
-              ...columnRest,
-              relatedCollection: relatedTable
-            };
-          }
-          return column;
-        })
-      };
-    });
-  }
+    if (!fs.existsSync(outputDirectory)) {
+      log(`Directory: ${outputDirectory} does not exist, creating...`);
+      fs.mkdirSync(outputDirectory, { recursive: true });
+    }
 
-  log(`Found ${dataItems.length} ${itemType}: ${dataItems.map((c: any) => c.name).join(", ")}`);
+    // Try tables first, fallback to collections
+    let tables = localConfig.getTables();
+    let collections: any[] = [];
+    let dataSource = "tables";
+
+    if (tables.length === 0) {
+      collections = localConfig.getCollections();
+      dataSource = "collections";
+
+      if (collections.length === 0) {
+        const configFileName = path.basename(localConfig.path);
+        throw new Error(
+          `No tables or collections found in configuration. Make sure ${configFileName} exists and contains tables or collections.`,
+        );
+      }
+    }
 
-  // Use columns if available, otherwise use attributes
-  const resourceType = tables.length > 0 ? 'columns' : 'attributes';
+    // Use tables if available, otherwise use collections
+    let dataItems: any[] = tables.length > 0 ? tables : collections;
+    const itemType = tables.length > 0 ? "tables" : "collections";
+
+    // Normalize tables data: rename 'columns' to 'attributes' for template compatibility
+    if (tables.length > 0) {
+      dataItems = dataItems.map((table) => {
+        const { columns, ...rest } = table;
+        return {
+          ...rest,
+          attributes: (columns || []).map((column: any) => {
+            if (column.relatedTable) {
+              const { relatedTable, ...columnRest } = column;
+              return {
+                ...columnRest,
+                relatedCollection: relatedTable,
+              };
+            }
+            return column;
+          }),
+        };
+      });
+    }
 
-  const totalAttributes = dataItems.reduce((count: number, item: any) => count + (item.attributes || []).length, 0);
-  log(`Found ${totalAttributes} ${resourceType} across all ${itemType}`);
+    log(
+      `Found ${dataItems.length} ${itemType}: ${dataItems.map((c: any) => c.name).join(", ")}`,
+    );
 
-  const templater = ejs.compile(meta.getTemplate());
+    // Use columns if available, otherwise use attributes
+    const resourceType = tables.length > 0 ? "columns" : "attributes";
 
-  if (meta.isSingleFile()) {
-    const content = templater({
-      collections: dataItems,
-      strict,
-      ...templateHelpers,
-      getType: meta.getType.bind(meta),
-    });
+    const totalAttributes = dataItems.reduce(
+      (count: number, item: any) => count + (item.attributes || []).length,
+      0,
+    );
+    log(`Found ${totalAttributes} ${resourceType} across all ${itemType}`);
 
-    const destination = singleFileDestination || path.join(outputDirectory, meta.getFileName());
+    const templater = ejs.compile(meta.getTemplate());
 
-    fs.writeFileSync(destination, content);
-    log(`Added types to ${destination}`);
-  } else {
-    for (const item of dataItems) {
+    if (meta.isSingleFile()) {
       const content = templater({
         collections: dataItems,
-        collection: item,
         strict,
         ...templateHelpers,
         getType: meta.getType.bind(meta),
       });
-  
-      const destination = path.join(outputDirectory, meta.getFileName(item as Collection));
-  
+
+      const destination =
+        singleFileDestination || path.join(outputDirectory, meta.getFileName());
+
       fs.writeFileSync(destination, content);
-      log(`Added types for ${item.name} to ${destination}`);
+      log(`Added types to ${destination}`);
+    } else {
+      for (const item of dataItems) {
+        const content = templater({
+          collections: dataItems,
+          collection: item,
+          strict,
+          ...templateHelpers,
+          getType: meta.getType.bind(meta),
+        });
+
+        const destination = path.join(
+          outputDirectory,
+          meta.getFileName(item as Collection),
+        );
+
+        fs.writeFileSync(destination, content);
+        log(`Added types for ${item.name} to ${destination}`);
+      }
     }
-  }
-  
-  success(`Generated types for all the listed ${itemType}`);
-});
+
+    success(`Generated types for all the listed ${itemType}`);
+  },
+);
 
 export const types = new Command("types")
   .description("Generate types for your Appwrite project")
@@ -190,4 +218,3 @@ export const types = new Command("types")
   .addOption(typesLanguageOption)
   .addOption(typesStrictOption)
   .action(actionRunner(typesCommand));
-