appwrite-cli 12.0.0 → 13.0.0-rc.1

package/lib/commands/{vcs.js → vcs.ts}

@@ -1,31 +1,27 @@
-const fs = require('fs');
-const pathLib = require('path');
-const tar = require("tar");
-const ignore = require("ignore");
-const { promisify } = require('util');
-const libClient = require('../client.js');
-const { getAllFiles, showConsoleLink } = require('../utils.js');
-const { Command } = require('commander');
-const { sdkForProject, sdkForConsole } = require('../sdks')
-const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log, warn } = require('../parser')
-const { localConfig, globalConfig } = require("../config");
-const { File } = require('undici');
-const { ReadableStream } = require('stream/web');
-
-/**
- * @param {fs.ReadStream} readStream
- * @returns {ReadableStream}
- */
-function convertReadStreamToReadableStream(readStream) {
+import fs = require('fs');
+import pathLib = require('path');
+import tar = require('tar');
+import ignore = require('ignore');
+import { promisify } from 'util';
+import Client from '../client';
+import { getAllFiles, showConsoleLink } from '../utils';
+import { Command } from 'commander';
+import { sdkForProject, sdkForConsole } from '../sdks';
+import { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log, warn } from '../parser';
+import { localConfig, globalConfig } from '../config';
+import { File } from 'undici';
+import { ReadableStream } from 'stream/web';
+
+function convertReadStreamToReadableStream(readStream: fs.ReadStream): ReadableStream {
   return new ReadableStream({
     start(controller) {
-      readStream.on("data", (chunk) => {
+      readStream.on("data", (chunk: Buffer) => {
         controller.enqueue(chunk);
       });
       readStream.on("end", () => {
         controller.close();
       });
-      readStream.on("error", (err) => {
+      readStream.on("error", (err: Error) => {
         controller.error(err);
       });
     },
@@ -35,25 +31,21 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const vcs = new Command("vcs").description(commandDescriptions['vcs'] ?? '').configureHelp({
+export const vcs = new Command("vcs").description(commandDescriptions['vcs'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
-/**
- * @typedef {Object} VcsCreateRepositoryDetectionRequestParams
- * @property {string} installationId Installation Id
- * @property {string} providerRepositoryId Repository Id
- * @property {VCSDetectionType} type Detector type. Must be one of the following: runtime, framework
- * @property {string} providerRootDirectory Path to Root Directory
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsCreateRepositoryDetectionRequestParams} params
- */
-const vcsCreateRepositoryDetection = async ({installationId,providerRepositoryId,type,providerRootDirectory,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsCreateRepositoryDetectionRequestParams {
+    installationId: string;
+    providerRepositoryId: string;
+    type: VCSDetectionType;
+    providerRootDirectory?: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsCreateRepositoryDetection = async ({installationId,providerRepositoryId,type,providerRootDirectory,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsCreateRepositoryDetectionRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/github/installations/{installationId}/detections'.replace('{installationId}', installationId);
@@ -81,20 +73,17 @@ const vcsCreateRepositoryDetection = async ({installationId,providerRepositoryId
     return response;
 
 }
-/**
- * @typedef {Object} VcsListRepositoriesRequestParams
- * @property {string} installationId Installation Id
- * @property {VCSDetectionType} type Detector type. Must be one of the following: runtime, framework
- * @property {string} search Search term to filter your list results. Max length: 256 chars.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsListRepositoriesRequestParams} params
- */
-const vcsListRepositories = async ({installationId,type,search,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsListRepositoriesRequestParams {
+    installationId: string;
+    type: VCSDetectionType;
+    search?: string;
+    queries?: string[];
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsListRepositories = async ({installationId,type,search,queries,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsListRepositoriesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories'.replace('{installationId}', installationId);
@@ -105,6 +94,9 @@ const vcsListRepositories = async ({installationId,type,search,parseOutput = tru
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+    if (typeof queries !== 'undefined') {
+        payload['queries'] = queries;
+    }
 
     let response = undefined;
 
@@ -118,20 +110,16 @@ const vcsListRepositories = async ({installationId,type,search,parseOutput = tru
     return response;
 
 }
-/**
- * @typedef {Object} VcsCreateRepositoryRequestParams
- * @property {string} installationId Installation Id
- * @property {string} name Repository name (slug)
- * @property {boolean} xprivate Mark repository public or private
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsCreateRepositoryRequestParams} params
- */
-const vcsCreateRepository = async ({installationId,name,xprivate,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsCreateRepositoryRequestParams {
+    installationId: string;
+    name: string;
+    xprivate: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsCreateRepository = async ({installationId,name,xprivate,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsCreateRepositoryRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories'.replace('{installationId}', installationId);
@@ -156,19 +144,15 @@ const vcsCreateRepository = async ({installationId,name,xprivate,parseOutput = t
     return response;
 
 }
-/**
- * @typedef {Object} VcsGetRepositoryRequestParams
- * @property {string} installationId Installation Id
- * @property {string} providerRepositoryId Repository Id
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsGetRepositoryRequestParams} params
- */
-const vcsGetRepository = async ({installationId,providerRepositoryId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsGetRepositoryRequestParams {
+    installationId: string;
+    providerRepositoryId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsGetRepository = async ({installationId,providerRepositoryId,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsGetRepositoryRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
@@ -186,19 +170,15 @@ const vcsGetRepository = async ({installationId,providerRepositoryId,parseOutput
     return response;
 
 }
-/**
- * @typedef {Object} VcsListRepositoryBranchesRequestParams
- * @property {string} installationId Installation Id
- * @property {string} providerRepositoryId Repository Id
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsListRepositoryBranchesRequestParams} params
- */
-const vcsListRepositoryBranches = async ({installationId,providerRepositoryId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsListRepositoryBranchesRequestParams {
+    installationId: string;
+    providerRepositoryId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsListRepositoryBranches = async ({installationId,providerRepositoryId,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsListRepositoryBranchesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}/branches'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
@@ -216,21 +196,17 @@ const vcsListRepositoryBranches = async ({installationId,providerRepositoryId,pa
     return response;
 
 }
-/**
- * @typedef {Object} VcsGetRepositoryContentsRequestParams
- * @property {string} installationId Installation Id
- * @property {string} providerRepositoryId Repository Id
- * @property {string} providerRootDirectory Path to get contents of nested directory
- * @property {string} providerReference Git reference (branch, tag, commit) to get contents from
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsGetRepositoryContentsRequestParams} params
- */
-const vcsGetRepositoryContents = async ({installationId,providerRepositoryId,providerRootDirectory,providerReference,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsGetRepositoryContentsRequestParams {
+    installationId: string;
+    providerRepositoryId: string;
+    providerRootDirectory?: string;
+    providerReference?: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsGetRepositoryContents = async ({installationId,providerRepositoryId,providerRootDirectory,providerReference,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsGetRepositoryContentsRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}/contents'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
@@ -254,20 +230,16 @@ const vcsGetRepositoryContents = async ({installationId,providerRepositoryId,pro
     return response;
 
 }
-/**
- * @typedef {Object} VcsUpdateExternalDeploymentsRequestParams
- * @property {string} installationId Installation Id
- * @property {string} repositoryId VCS Repository Id
- * @property {string} providerPullRequestId GitHub Pull Request Id
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsUpdateExternalDeploymentsRequestParams} params
- */
-const vcsUpdateExternalDeployments = async ({installationId,repositoryId,providerPullRequestId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsUpdateExternalDeploymentsRequestParams {
+    installationId: string;
+    repositoryId: string;
+    providerPullRequestId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsUpdateExternalDeployments = async ({installationId,repositoryId,providerPullRequestId,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsUpdateExternalDeploymentsRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/github/installations/{installationId}/repositories/{repositoryId}'.replace('{installationId}', installationId).replace('{repositoryId}', repositoryId);
@@ -289,20 +261,16 @@ const vcsUpdateExternalDeployments = async ({installationId,repositoryId,provide
     return response;
 
 }
-/**
- * @typedef {Object} VcsListInstallationsRequestParams
- * @property {string[]} 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
- * @property {string} search Search term to filter your list results. Max length: 256 chars.
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsListInstallationsRequestParams} params
- */
-const vcsListInstallations = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsListInstallationsRequestParams {
+    queries?: string[];
+    search?: string;
+    total?: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsListInstallations = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsListInstallationsRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/installations';
@@ -329,18 +297,14 @@ const vcsListInstallations = async ({queries,search,total,parseOutput = true, ov
     return response;
 
 }
-/**
- * @typedef {Object} VcsGetInstallationRequestParams
- * @property {string} installationId Installation Id
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsGetInstallationRequestParams} params
- */
-const vcsGetInstallation = async ({installationId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsGetInstallationRequestParams {
+    installationId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsGetInstallation = async ({installationId,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsGetInstallationRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/installations/{installationId}'.replace('{installationId}', installationId);
@@ -358,18 +322,14 @@ const vcsGetInstallation = async ({installationId,parseOutput = true, overrideFo
     return response;
 
 }
-/**
- * @typedef {Object} VcsDeleteInstallationRequestParams
- * @property {string} installationId Installation Id
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {VcsDeleteInstallationRequestParams} params
- */
-const vcsDeleteInstallation = async ({installationId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface VcsDeleteInstallationRequestParams {
+    installationId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const vcsDeleteInstallation = async ({installationId,parseOutput = true, overrideForCli = false, sdk = undefined}: VcsDeleteInstallationRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/vcs/installations/{installationId}'.replace('{installationId}', installationId);
@@ -403,6 +363,7 @@ vcs
     .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(vcsListRepositories))
 
 vcs
@@ -410,7 +371,7 @@ vcs
     .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(`--xprivate [value]`, `Mark repository public or private`, (value) => value === undefined ? true : parseBool(value))
+    .requiredOption(`--xprivate [value]`, `Mark repository public or private`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .action(actionRunner(vcsCreateRepository))
 
 vcs
@@ -449,7 +410,7 @@ vcs
     .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) => value === undefined ? true : parseBool(value))
+    .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(vcsListInstallations))
 
 vcs
@@ -464,16 +425,4 @@ vcs
     .requiredOption(`--installation-id <installation-id>`, `Installation Id`)
     .action(actionRunner(vcsDeleteInstallation))
 
-module.exports = {
-    vcs,
-    vcsCreateRepositoryDetection,
-    vcsListRepositories,
-    vcsCreateRepository,
-    vcsGetRepository,
-    vcsListRepositoryBranches,
-    vcsGetRepositoryContents,
-    vcsUpdateExternalDeployments,
-    vcsListInstallations,
-    vcsGetInstallation,
-    vcsDeleteInstallation
-};
+