appwrite-cli 4.1.0 → 4.2.1

package/lib/commands/health.js

@@ -9,212 +9,635 @@ 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 health = new Command("health").description(commandDescriptions['health']).configureHelp({
     helpWidth: process.stdout.columns || 80
   })
 
-const healthGet = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetRequestParams} params
+ */
+const healthGet = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health';
     let payload = {};
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetAntivirus = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetAntivirusRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetAntivirusRequestParams} params
+ */
+const healthGetAntivirus = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/anti-virus';
     let payload = {};
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetCache = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetCacheRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetCacheRequestParams} params
+ */
+const healthGetCache = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/cache';
     let payload = {};
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetDB = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetDBRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetDBRequestParams} params
+ */
+const healthGetDB = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/db';
     let payload = {};
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetPubSub = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetPubSubRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetPubSubRequestParams} params
+ */
+const healthGetPubSub = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/pubsub';
     let payload = {};
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueue = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetQueueRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetQueueRequestParams} params
+ */
+const healthGetQueue = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/queue';
     let payload = {};
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueCertificates = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetQueueBuildsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueBuildsRequestParams} params
+ */
+const healthGetQueueBuilds = async ({ threshold, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    
+    let apiPath = '/health/queue/builds';
+    let payload = {};
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
 
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    
+    return response;
+}
+
+/**
+ * @typedef {Object} HealthGetQueueCertificatesRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueCertificatesRequestParams} params
+ */
+const healthGetQueueCertificates = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/queue/certificates';
     let payload = {};
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueFunctions = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetQueueDatabasesRequestParams
+ * @property {string} name Queue name for which to check the queue size
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueDatabasesRequestParams} params
+ */
+const healthGetQueueDatabases = async ({ name, threshold, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    
+    let apiPath = '/health/queue/databases';
+    let payload = {};
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
 
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    
+    return response;
+}
+
+/**
+ * @typedef {Object} HealthGetQueueDeletesRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueDeletesRequestParams} params
+ */
+const healthGetQueueDeletes = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    let apiPath = '/health/queue/functions';
+    
+    let apiPath = '/health/queue/deletes';
     let payload = {};
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueLogs = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetQueueFunctionsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueFunctionsRequestParams} params
+ */
+const healthGetQueueFunctions = async ({ threshold, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    
+    let apiPath = '/health/queue/functions';
+    let payload = {};
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
+
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    
+    return response;
+}
 
+/**
+ * @typedef {Object} HealthGetQueueLogsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueLogsRequestParams} params
+ */
+const healthGetQueueLogs = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/queue/logs';
     let payload = {};
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetQueueWebhooks = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetQueueMailsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueMailsRequestParams} params
+ */
+const healthGetQueueMails = async ({ threshold, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    
+    let apiPath = '/health/queue/mails';
+    let payload = {};
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
+
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    
+    return response;
+}
 
+/**
+ * @typedef {Object} HealthGetQueueMessagingRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueMessagingRequestParams} params
+ */
+const healthGetQueueMessaging = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
+    let apiPath = '/health/queue/messaging';
+    let payload = {};
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
+
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    
+    return response;
+}
+
+/**
+ * @typedef {Object} HealthGetQueueMigrationsRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueMigrationsRequestParams} params
+ */
+const healthGetQueueMigrations = async ({ threshold, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    
+    let apiPath = '/health/queue/migrations';
+    let payload = {};
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
+
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    
+    return response;
+}
+
+/**
+ * @typedef {Object} HealthGetQueueWebhooksRequestParams
+ * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetQueueWebhooksRequestParams} params
+ */
+const healthGetQueueWebhooks = async ({ threshold, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/queue/webhooks';
     let payload = {};
+    if (typeof threshold !== 'undefined') {
+        payload['threshold'] = threshold;
+    }
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetStorageLocal = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetStorageLocalRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetStorageLocalRequestParams} params
+ */
+const healthGetStorageLocal = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/storage/local';
     let payload = {};
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const healthGetTime = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} HealthGetTimeRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {HealthGetTimeRequestParams} params
+ */
+const healthGetTime = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/health/time';
     let payload = {};
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
@@ -249,24 +672,65 @@ health
     .description(`Check the Appwrite queue messaging servers are up and connection is successful.`)
     .action(actionRunner(healthGetQueue))
 
+health
+    .command(`getQueueBuilds`)
+    .description(`Get the number of builds that are waiting to be processed in the Appwrite internal queue server.`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
+    .action(actionRunner(healthGetQueueBuilds))
+
 health
     .command(`getQueueCertificates`)
     .description(`Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
     .action(actionRunner(healthGetQueueCertificates))
 
+health
+    .command(`getQueueDatabases`)
+    .description(`Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.`)
+    .option(`--name <name>`, `Queue name for which to check the queue size`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
+    .action(actionRunner(healthGetQueueDatabases))
+
+health
+    .command(`getQueueDeletes`)
+    .description(`Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
+    .action(actionRunner(healthGetQueueDeletes))
+
 health
     .command(`getQueueFunctions`)
     .description(``)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
     .action(actionRunner(healthGetQueueFunctions))
 
 health
     .command(`getQueueLogs`)
     .description(`Get the number of logs that are waiting to be processed in the Appwrite internal queue server.`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
     .action(actionRunner(healthGetQueueLogs))
 
+health
+    .command(`getQueueMails`)
+    .description(`Get the number of mails that are waiting to be processed in the Appwrite internal queue server.`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
+    .action(actionRunner(healthGetQueueMails))
+
+health
+    .command(`getQueueMessaging`)
+    .description(`Get the number of messages that are waiting to be processed in the Appwrite internal queue server.`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
+    .action(actionRunner(healthGetQueueMessaging))
+
+health
+    .command(`getQueueMigrations`)
+    .description(`Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
+    .action(actionRunner(healthGetQueueMigrations))
+
 health
     .command(`getQueueWebhooks`)
     .description(`Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
     .action(actionRunner(healthGetQueueWebhooks))
 
 health
@@ -282,16 +746,22 @@ health
 
 module.exports = {
     health,
-    healthGet,
-    healthGetAntivirus,
-    healthGetCache,
-    healthGetDB,
-    healthGetPubSub,
-    healthGetQueue,
-    healthGetQueueCertificates,
-    healthGetQueueFunctions,
-    healthGetQueueLogs,
-    healthGetQueueWebhooks,
-    healthGetStorageLocal,
-    healthGetTime
-};
+    healthGet,    
+    healthGetAntivirus,    
+    healthGetCache,    
+    healthGetDB,    
+    healthGetPubSub,    
+    healthGetQueue,    
+    healthGetQueueBuilds,    
+    healthGetQueueCertificates,    
+    healthGetQueueDatabases,    
+    healthGetQueueDeletes,    
+    healthGetQueueFunctions,    
+    healthGetQueueLogs,    
+    healthGetQueueMails,    
+    healthGetQueueMessaging,    
+    healthGetQueueMigrations,    
+    healthGetQueueWebhooks,    
+    healthGetStorageLocal,    
+    healthGetTime    
+};