appwrite-cli 4.2.1 → 5.0.0

package/lib/commands/health.js

@@ -37,7 +37,7 @@ function convertReadStreamToReadableStream(readStream) {
 
 const health = new Command("health").description(commandDescriptions['health']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
+})
 
 /**
  * @typedef {Object} HealthGetRequestParams
@@ -50,18 +50,15 @@ const health = new Command("health").description(commandDescriptions['health']).
  */
 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()
@@ -81,18 +78,15 @@ const healthGet = async ({ parseOutput = true, sdk = undefined}) => {
  */
 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()
@@ -112,18 +106,47 @@ const healthGetAntivirus = async ({ parseOutput = true, sdk = undefined}) => {
  */
 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;
+}
+
+/**
+ * @typedef {Object} HealthGetCertificateRequestParams
+ * @property {string} domain string
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetCertificateRequestParams} params
+ */
+const healthGetCertificate = async ({ domain, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/health/certificate';
+    let payload = {};
+    if (typeof domain !== 'undefined') {
+        payload['domain'] = domain;
+    }
+
+    let response = undefined;
+
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
     if (parseOutput) {
         parse(response)
         success()
@@ -143,18 +166,15 @@ const healthGetCache = async ({ parseOutput = true, sdk = undefined}) => {
  */
 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()
@@ -174,18 +194,15 @@ const healthGetDB = async ({ parseOutput = true, sdk = undefined}) => {
  */
 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()
@@ -205,18 +222,15 @@ const healthGetPubSub = async ({ parseOutput = true, sdk = undefined}) => {
  */
 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()
@@ -237,21 +251,18 @@ const healthGetQueue = async ({ parseOutput = true, sdk = undefined}) => {
  */
 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()
@@ -272,21 +283,18 @@ const healthGetQueueBuilds = async ({ threshold, parseOutput = true, sdk = undef
  */
 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()
@@ -308,7 +316,6 @@ const healthGetQueueCertificates = async ({ threshold, parseOutput = true, sdk =
  */
 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') {
@@ -318,14 +325,12 @@ const healthGetQueueDatabases = async ({ name, threshold, parseOutput = true, sd
         payload['threshold'] = threshold;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -346,21 +351,51 @@ const healthGetQueueDatabases = async ({ name, threshold, parseOutput = true, sd
  */
 const healthGetQueueDeletes = async ({ threshold, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     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;
+}
+
+/**
+ * @typedef {Object} HealthGetFailedJobsRequestParams
+ * @property {Name} name The name of the queue
+ * @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 {HealthGetFailedJobsRequestParams} params
+ */
+const healthGetFailedJobs = async ({ name, threshold, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/health/queue/failed/{name}'.replace('{name}', name);
+    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()
@@ -381,21 +416,18 @@ const healthGetQueueDeletes = async ({ threshold, parseOutput = true, sdk = unde
  */
 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()
@@ -416,21 +448,18 @@ const healthGetQueueFunctions = async ({ threshold, parseOutput = true, sdk = un
  */
 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()
@@ -451,21 +480,18 @@ const healthGetQueueLogs = async ({ threshold, parseOutput = true, sdk = undefin
  */
 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()
@@ -486,21 +512,18 @@ const healthGetQueueMails = async ({ threshold, parseOutput = true, sdk = undefi
  */
 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()
@@ -521,21 +544,82 @@ const healthGetQueueMessaging = async ({ threshold, parseOutput = true, sdk = un
  */
 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} HealthGetQueueUsageRequestParams
+ * @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 {HealthGetQueueUsageRequestParams} params
+ */
+const healthGetQueueUsage = async ({ threshold, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/health/queue/usage';
+    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} HealthGetQueueUsageDumpRequestParams
+ * @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 {HealthGetQueueUsageDumpRequestParams} params
+ */
+const healthGetQueueUsageDump = async ({ threshold, parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/health/queue/usage-dump';
+    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()
@@ -556,21 +640,46 @@ const healthGetQueueMigrations = async ({ threshold, parseOutput = true, sdk = u
  */
 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;
+}
+
+/**
+ * @typedef {Object} HealthGetStorageRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {HealthGetStorageRequestParams} params
+ */
+const healthGetStorage = async ({ parseOutput = true, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/health/storage';
+    let payload = {};
+
+    let response = undefined;
+
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
     if (parseOutput) {
         parse(response)
         success()
@@ -590,18 +699,15 @@ const healthGetQueueWebhooks = async ({ threshold, parseOutput = true, sdk = und
  */
 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()
@@ -621,18 +727,15 @@ const healthGetStorageLocal = async ({ parseOutput = true, sdk = undefined}) =>
  */
 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()
@@ -641,7 +744,6 @@ const healthGetTime = async ({ parseOutput = true, sdk = undefined}) => {
     return response;
 }
 
-
 health
     .command(`get`)
     .description(`Check the Appwrite HTTP server is up and responsive.`)
@@ -657,6 +759,12 @@ health
     .description(`Check the Appwrite in-memory cache servers are up and connection is successful.`)
     .action(actionRunner(healthGetCache))
 
+health
+    .command(`getCertificate`)
+    .description(`Get the SSL certificate for a domain`)
+    .option(`--domain <domain>`, `string`)
+    .action(actionRunner(healthGetCertificate))
+
 health
     .command(`getDB`)
     .description(`Check the Appwrite database servers are up and connection is successful.`)
@@ -697,9 +805,16 @@ health
     .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(`getFailedJobs`)
+    .description(`Returns the amount of failed jobs in a given queue. `)
+    .requiredOption(`--name <name>`, `The name of the queue`)
+    .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
+    .action(actionRunner(healthGetFailedJobs))
+
 health
     .command(`getQueueFunctions`)
-    .description(``)
+    .description(`Get the number of function executions 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(healthGetQueueFunctions))
 
@@ -727,12 +842,29 @@ health
     .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(`getQueueUsage`)
+    .description(`Get the number of metrics 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(healthGetQueueUsage))
+
+health
+    .command(`getQueueUsageDump`)
+    .description(`Get the number of projects containing metrics 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(healthGetQueueUsageDump))
+
 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
+    .command(`getStorage`)
+    .description(`Check the Appwrite storage device is up and connection is successful.`)
+    .action(actionRunner(healthGetStorage))
+
 health
     .command(`getStorageLocal`)
     .description(`Check the Appwrite local storage device is up and connection is successful.`)
@@ -743,25 +875,29 @@ health
     .description(`Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.`)
     .action(actionRunner(healthGetTime))
 
-
 module.exports = {
     health,
-    healthGet,    
-    healthGetAntivirus,    
-    healthGetCache,    
-    healthGetDB,    
-    healthGetPubSub,    
-    healthGetQueue,    
-    healthGetQueueBuilds,    
-    healthGetQueueCertificates,    
-    healthGetQueueDatabases,    
-    healthGetQueueDeletes,    
-    healthGetQueueFunctions,    
-    healthGetQueueLogs,    
-    healthGetQueueMails,    
-    healthGetQueueMessaging,    
-    healthGetQueueMigrations,    
-    healthGetQueueWebhooks,    
-    healthGetStorageLocal,    
-    healthGetTime    
+    healthGet,
+    healthGetAntivirus,
+    healthGetCache,
+    healthGetCertificate,
+    healthGetDB,
+    healthGetPubSub,
+    healthGetQueue,
+    healthGetQueueBuilds,
+    healthGetQueueCertificates,
+    healthGetQueueDatabases,
+    healthGetQueueDeletes,
+    healthGetFailedJobs,
+    healthGetQueueFunctions,
+    healthGetQueueLogs,
+    healthGetQueueMails,
+    healthGetQueueMessaging,
+    healthGetQueueMigrations,
+    healthGetQueueUsage,
+    healthGetQueueUsageDump,
+    healthGetQueueWebhooks,
+    healthGetStorage,
+    healthGetStorageLocal,
+    healthGetTime
 };