appwrite-cli 4.2.0 → 4.2.2

package/lib/commands/vcs.js

@@ -9,223 +9,328 @@ const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = 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) {
+  return new ReadableStream({
+    start(controller) {
+      readStream.on("data", (chunk) => {
+        controller.enqueue(chunk);
+      });
+      readStream.on("end", () => {
+        controller.close();
+      });
+      readStream.on("error", (err) => {
+        controller.error(err);
+      });
+    },
+    cancel() {
+      readStream.destroy();
+    },
+  });
+}
 
 const vcs = new Command("vcs").description(commandDescriptions['vcs']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
-
+})
+
+/**
+ * @typedef {Object} VcsListRepositoriesRequestParams
+ * @property {string} installationId Installation Id
+ * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {VcsListRepositoriesRequestParams} params
+ */
 const vcsListRepositories = async ({ installationId, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} installationId */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories'.replace('{installationId}', installationId);
     let payload = {};
-
-    /** Query Params */
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     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} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {VcsCreateRepositoryRequestParams} params
+ */
 const vcsCreateRepository = async ({ installationId, name, xprivate, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} installationId */
-    /* @param {string} name */
-    /* @param {boolean} xprivate */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories'.replace('{installationId}', installationId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
-
-
     if (typeof xprivate !== 'undefined') {
         payload['private'] = xprivate;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} VcsGetRepositoryRequestParams
+ * @property {string} installationId Installation Id
+ * @property {string} providerRepositoryId Repository Id
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {VcsGetRepositoryRequestParams} params
+ */
 const vcsGetRepository = async ({ installationId, providerRepositoryId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} installationId */
-    /* @param {string} providerRepositoryId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} VcsListRepositoryBranchesRequestParams
+ * @property {string} installationId Installation Id
+ * @property {string} providerRepositoryId Repository Id
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {VcsListRepositoryBranchesRequestParams} params
+ */
 const vcsListRepositoryBranches = async ({ installationId, providerRepositoryId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} installationId */
-    /* @param {string} providerRepositoryId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}/branches'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} VcsCreateRepositoryDetectionRequestParams
+ * @property {string} installationId Installation Id
+ * @property {string} providerRepositoryId Repository Id
+ * @property {string} providerRootDirectory Path to Root Directory
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {VcsCreateRepositoryDetectionRequestParams} params
+ */
 const vcsCreateRepositoryDetection = async ({ installationId, providerRepositoryId, providerRootDirectory, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} installationId */
-    /* @param {string} providerRepositoryId */
-    /* @param {string} providerRootDirectory */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}/detection'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof providerRootDirectory !== 'undefined') {
         payload['providerRootDirectory'] = providerRootDirectory;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     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} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {VcsUpdateExternalDeploymentsRequestParams} params
+ */
 const vcsUpdateExternalDeployments = async ({ installationId, repositoryId, providerPullRequestId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} installationId */
-    /* @param {string} repositoryId */
-    /* @param {string} providerPullRequestId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/vcs/github/installations/{installationId}/repositories/{repositoryId}'.replace('{installationId}', installationId).replace('{repositoryId}', repositoryId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof providerPullRequestId !== 'undefined') {
         payload['providerPullRequestId'] = providerPullRequestId;
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     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} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {VcsListInstallationsRequestParams} params
+ */
 const vcsListInstallations = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} queries */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/vcs/installations';
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const vcsGetInstallation = async ({ installationId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} installationId */
+/**
+ * @typedef {Object} VcsGetInstallationRequestParams
+ * @property {string} installationId Installation Id
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {VcsGetInstallationRequestParams} params
+ */
+const vcsGetInstallation = async ({ installationId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/vcs/installations/{installationId}'.replace('{installationId}', installationId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const vcsDeleteInstallation = async ({ installationId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} installationId */
+/**
+ * @typedef {Object} VcsDeleteInstallationRequestParams
+ * @property {string} installationId Installation Id
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {VcsDeleteInstallationRequestParams} params
+ */
+const vcsDeleteInstallation = async ({ installationId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/vcs/installations/{installationId}'.replace('{installationId}', installationId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-
 vcs
     .command(`listRepositories`)
     .description(``)
@@ -290,7 +395,6 @@ vcs
     .requiredOption(`--installationId <installationId>`, `Installation Id`)
     .action(actionRunner(vcsDeleteInstallation))
 
-
 module.exports = {
     vcs,
     vcsListRepositories,
@@ -302,4 +406,4 @@ module.exports = {
     vcsListInstallations,
     vcsGetInstallation,
     vcsDeleteInstallation
-};
+};

package/package.json

@@ -2,7 +2,7 @@
   "name": "appwrite-cli",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "4.2.0",
+  "version": "4.2.2",
   "license": "BSD-3-Clause",
   "main": "index.js",
   "bin": {
@@ -14,15 +14,15 @@
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "linux-x64": "pkg -t node16-linux-x64 -o build/appwrite-cli-linux-x64 package.json",
-    "linux-arm64": "pkg -t node16-linux-arm64 -o build/appwrite-cli-linux-arm64 package.json",
-    "mac-x64": "pkg -t node16-macos-x64 -o build/appwrite-cli-darwin-x64 package.json",
-    "mac-arm64": "pkg -t node16-macos-arm64 -o build/appwrite-cli-darwin-arm64 package.json",
-    "windows-x64": "pkg -t node16-win-x64 -o build/appwrite-cli-win-x64.exe package.json",
-    "windows-arm64": "pkg -t node16-win-arm64 -o build/appwrite-cli-win-arm64.exe package.json"
+    "linux-x64": "pkg -t node18-linux-x64 -o build/appwrite-cli-linux-x64 package.json",
+    "linux-arm64": "pkg -t node18-linux-arm64 -o build/appwrite-cli-linux-arm64 package.json",
+    "mac-x64": "pkg -t node18-macos-x64 -o build/appwrite-cli-darwin-x64 package.json",
+    "mac-arm64": "pkg -t node18-macos-arm64 -o build/appwrite-cli-darwin-arm64 package.json",
+    "windows-x64": "pkg -t node18-win-x64 -o build/appwrite-cli-win-x64.exe package.json",
+    "windows-arm64": "pkg -t node18-win-arm64 -o build/appwrite-cli-win-arm64.exe package.json"
   },
   "dependencies": {
-    "axios": "1.5.0",
+    "undici": "^5.28.2",
     "chalk": "4.1.2",
     "cli-table3": "^0.6.2",
     "commander": "^9.2.0",
@@ -33,7 +33,7 @@
     "ignore": "^5.2.0"
   },
   "devDependencies": {
-    "pkg": "5.5.1"
+    "pkg": "5.8.1"
   },
   "pkg": {
     "scripts": [

package/scoop/appwrite.json

@@ -1,12 +1,12 @@
 {
 	"$schema": "https://raw.githubusercontent.com/ScoopInstaller/Scoop/master/schema.json",
-	"version": "4.2.0",
+	"version": "4.2.2",
 	"description": "The Appwrite CLI is a command-line application that allows you to interact with Appwrite and perform server-side tasks using your terminal.",
 	"homepage": "https://github.com/appwrite/sdk-for-cli",
 	"license": "BSD-3-Clause",
 	"architecture": {
 		"64bit": {
-			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/4.2.0/appwrite-cli-win-x64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/4.2.2/appwrite-cli-win-x64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-x64.exe",
@@ -15,7 +15,7 @@
 			]
 		},
 		"arm64": {
-			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/4.2.0/appwrite-cli-win-arm64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/4.2.2/appwrite-cli-win-arm64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-arm64.exe",