appwrite-cli 4.2.1 → 5.0.0

package/lib/commands/migrations.js

@@ -37,11 +37,11 @@ function convertReadStreamToReadableStream(readStream) {
 
 const migrations = new Command("migrations").description(commandDescriptions['migrations']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
+})
 
 /**
  * @typedef {Object} MigrationsListRequestParams
- * @property {string} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, resources, statusCounters, resourceData, errors
+ * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, resources, statusCounters, resourceData, errors
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
@@ -52,7 +52,6 @@ const migrations = new Command("migrations").description(commandDescriptions['mi
  */
 const migrationsList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations';
     let payload = {};
     if (typeof queries !== 'undefined') {
@@ -62,14 +61,12 @@ const migrationsList = async ({ queries, search, parseOutput = true, sdk = undef
         payload['search'] = search;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -93,7 +90,6 @@ const migrationsList = async ({ queries, search, parseOutput = true, sdk = undef
  */
 const migrationsCreateAppwriteMigration = async ({ resources, endpoint, projectId, apiKey, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/appwrite';
     let payload = {};
     resources = resources === true ? [] : resources;
@@ -110,14 +106,12 @@ const migrationsCreateAppwriteMigration = async ({ resources, endpoint, projectI
         payload['apiKey'] = apiKey;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -141,7 +135,6 @@ const migrationsCreateAppwriteMigration = async ({ resources, endpoint, projectI
  */
 const migrationsGetAppwriteReport = async ({ resources, endpoint, projectID, key, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/appwrite/report';
     let payload = {};
     if (typeof resources !== 'undefined') {
@@ -157,14 +150,12 @@ const migrationsGetAppwriteReport = async ({ resources, endpoint, projectID, key
         payload['key'] = key;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -186,7 +177,6 @@ const migrationsGetAppwriteReport = async ({ resources, endpoint, projectID, key
  */
 const migrationsCreateFirebaseMigration = async ({ resources, serviceAccount, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/firebase';
     let payload = {};
     resources = resources === true ? [] : resources;
@@ -197,14 +187,12 @@ const migrationsCreateFirebaseMigration = async ({ resources, serviceAccount, pa
         payload['serviceAccount'] = serviceAccount;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -224,18 +212,15 @@ const migrationsCreateFirebaseMigration = async ({ resources, serviceAccount, pa
  */
 const migrationsDeleteFirebaseAuth = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/firebase/deauthorize';
     let payload = {};
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -257,7 +242,6 @@ const migrationsDeleteFirebaseAuth = async ({ parseOutput = true, sdk = undefine
  */
 const migrationsCreateFirebaseOAuthMigration = async ({ resources, projectId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/firebase/oauth';
     let payload = {};
     resources = resources === true ? [] : resources;
@@ -268,14 +252,12 @@ const migrationsCreateFirebaseOAuthMigration = async ({ resources, projectId, pa
         payload['projectId'] = projectId;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -295,18 +277,15 @@ const migrationsCreateFirebaseOAuthMigration = async ({ resources, projectId, pa
  */
 const migrationsListFirebaseProjects = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/firebase/projects';
     let payload = {};
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -328,7 +307,6 @@ const migrationsListFirebaseProjects = async ({ parseOutput = true, sdk = undefi
  */
 const migrationsGetFirebaseReport = async ({ resources, serviceAccount, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/firebase/report';
     let payload = {};
     if (typeof resources !== 'undefined') {
@@ -338,14 +316,12 @@ const migrationsGetFirebaseReport = async ({ resources, serviceAccount, parseOut
         payload['serviceAccount'] = serviceAccount;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -367,7 +343,6 @@ const migrationsGetFirebaseReport = async ({ resources, serviceAccount, parseOut
  */
 const migrationsGetFirebaseReportOAuth = async ({ resources, projectId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/firebase/report/oauth';
     let payload = {};
     if (typeof resources !== 'undefined') {
@@ -377,14 +352,12 @@ const migrationsGetFirebaseReportOAuth = async ({ resources, projectId, parseOut
         payload['projectId'] = projectId;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -412,7 +385,6 @@ const migrationsGetFirebaseReportOAuth = async ({ resources, projectId, parseOut
  */
 const migrationsCreateNHostMigration = async ({ resources, subdomain, region, adminSecret, database, username, password, port, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/nhost';
     let payload = {};
     resources = resources === true ? [] : resources;
@@ -441,14 +413,12 @@ const migrationsCreateNHostMigration = async ({ resources, subdomain, region, ad
         payload['port'] = port;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -476,7 +446,6 @@ const migrationsCreateNHostMigration = async ({ resources, subdomain, region, ad
  */
 const migrationsGetNHostReport = async ({ resources, subdomain, region, adminSecret, database, username, password, port, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/nhost/report';
     let payload = {};
     if (typeof resources !== 'undefined') {
@@ -504,14 +473,12 @@ const migrationsGetNHostReport = async ({ resources, subdomain, region, adminSec
         payload['port'] = port;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -538,7 +505,6 @@ const migrationsGetNHostReport = async ({ resources, subdomain, region, adminSec
  */
 const migrationsCreateSupabaseMigration = async ({ resources, endpoint, apiKey, databaseHost, username, password, port, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/supabase';
     let payload = {};
     resources = resources === true ? [] : resources;
@@ -564,14 +530,12 @@ const migrationsCreateSupabaseMigration = async ({ resources, endpoint, apiKey,
         payload['port'] = port;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -598,7 +562,6 @@ const migrationsCreateSupabaseMigration = async ({ resources, endpoint, apiKey,
  */
 const migrationsGetSupabaseReport = async ({ resources, endpoint, apiKey, databaseHost, username, password, port, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/supabase/report';
     let payload = {};
     if (typeof resources !== 'undefined') {
@@ -623,14 +586,12 @@ const migrationsGetSupabaseReport = async ({ resources, endpoint, apiKey, databa
         payload['port'] = port;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -651,18 +612,15 @@ const migrationsGetSupabaseReport = async ({ resources, endpoint, apiKey, databa
  */
 const migrationsGet = async ({ migrationId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
     let payload = {};
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -683,18 +641,15 @@ const migrationsGet = async ({ migrationId, parseOutput = true, sdk = undefined}
  */
 const migrationsRetry = async ({ migrationId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
     let payload = {};
 
-
     let response = undefined;
-    
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -715,18 +670,15 @@ const migrationsRetry = async ({ migrationId, parseOutput = true, sdk = undefine
  */
 const migrationsDelete = async ({ migrationId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
     let payload = {};
 
-
     let response = undefined;
-    
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -735,11 +687,10 @@ const migrationsDelete = async ({ migrationId, parseOutput = true, sdk = undefin
     return response;
 }
 
-
 migrations
     .command(`list`)
     .description(``)
-    .option(`--queries <queries>`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, resources, statusCounters, resourceData, errors`)
+    .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, resources, statusCounters, resourceData, errors`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
     .action(actionRunner(migrationsList))
 
@@ -867,23 +818,22 @@ migrations
     .requiredOption(`--migrationId <migrationId>`, `Migration ID.`)
     .action(actionRunner(migrationsDelete))
 
-
 module.exports = {
     migrations,
-    migrationsList,    
-    migrationsCreateAppwriteMigration,    
-    migrationsGetAppwriteReport,    
-    migrationsCreateFirebaseMigration,    
-    migrationsDeleteFirebaseAuth,    
-    migrationsCreateFirebaseOAuthMigration,    
-    migrationsListFirebaseProjects,    
-    migrationsGetFirebaseReport,    
-    migrationsGetFirebaseReportOAuth,    
-    migrationsCreateNHostMigration,    
-    migrationsGetNHostReport,    
-    migrationsCreateSupabaseMigration,    
-    migrationsGetSupabaseReport,    
-    migrationsGet,    
-    migrationsRetry,    
-    migrationsDelete    
+    migrationsList,
+    migrationsCreateAppwriteMigration,
+    migrationsGetAppwriteReport,
+    migrationsCreateFirebaseMigration,
+    migrationsDeleteFirebaseAuth,
+    migrationsCreateFirebaseOAuthMigration,
+    migrationsListFirebaseProjects,
+    migrationsGetFirebaseReport,
+    migrationsGetFirebaseReportOAuth,
+    migrationsCreateNHostMigration,
+    migrationsGetNHostReport,
+    migrationsCreateSupabaseMigration,
+    migrationsGetSupabaseReport,
+    migrationsGet,
+    migrationsRetry,
+    migrationsDelete
 };

package/lib/commands/project.js

@@ -37,11 +37,13 @@ function convertReadStreamToReadableStream(readStream) {
 
 const project = new Command("project").description(commandDescriptions['project']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
+})
 
 /**
  * @typedef {Object} ProjectGetUsageRequestParams
- * @property {string} range Date range.
+ * @property {string} startDate Starting date for the usage
+ * @property {string} endDate End date for the usage
+ * @property {ProjectUsageRange} period Period used
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -49,23 +51,26 @@ const project = new Command("project").description(commandDescriptions['project'
 /**
  * @param {ProjectGetUsageRequestParams} params
  */
-const projectGetUsage = async ({ range, parseOutput = true, sdk = undefined}) => {
+const projectGetUsage = async ({ startDate, endDate, period, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/project/usage';
     let payload = {};
-    if (typeof range !== 'undefined') {
-        payload['range'] = range;
+    if (typeof startDate !== 'undefined') {
+        payload['startDate'] = startDate;
+    }
+    if (typeof endDate !== 'undefined') {
+        payload['endDate'] = endDate;
+    }
+    if (typeof period !== 'undefined') {
+        payload['period'] = period;
     }
-
 
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -85,18 +90,15 @@ const projectGetUsage = async ({ range, parseOutput = true, sdk = undefined}) =>
  */
 const projectListVariables = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/project/variables';
     let payload = {};
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -118,7 +120,6 @@ const projectListVariables = async ({ parseOutput = true, sdk = undefined}) => {
  */
 const projectCreateVariable = async ({ key, value, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/project/variables';
     let payload = {};
     if (typeof key !== 'undefined') {
@@ -128,14 +129,12 @@ const projectCreateVariable = async ({ key, value, parseOutput = true, sdk = und
         payload['value'] = value;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -156,18 +155,15 @@ const projectCreateVariable = async ({ key, value, parseOutput = true, sdk = und
  */
 const projectGetVariable = async ({ variableId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/project/variables/{variableId}'.replace('{variableId}', variableId);
     let payload = {};
 
-
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -190,7 +186,6 @@ const projectGetVariable = async ({ variableId, parseOutput = true, sdk = undefi
  */
 const projectUpdateVariable = async ({ variableId, key, value, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/project/variables/{variableId}'.replace('{variableId}', variableId);
     let payload = {};
     if (typeof key !== 'undefined') {
@@ -200,14 +195,12 @@ const projectUpdateVariable = async ({ variableId, key, value, parseOutput = tru
         payload['value'] = value;
     }
 
-
     let response = undefined;
-    
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -228,18 +221,15 @@ const projectUpdateVariable = async ({ variableId, key, value, parseOutput = tru
  */
 const projectDeleteVariable = async ({ variableId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/project/variables/{variableId}'.replace('{variableId}', variableId);
     let payload = {};
 
-
     let response = undefined;
-    
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
 
-    
     if (parseOutput) {
         parse(response)
         success()
@@ -248,11 +238,12 @@ const projectDeleteVariable = async ({ variableId, parseOutput = true, sdk = und
     return response;
 }
 
-
 project
     .command(`getUsage`)
     .description(``)
-    .option(`--range <range>`, `Date range.`)
+    .requiredOption(`--startDate <startDate>`, `Starting date for the usage`)
+    .requiredOption(`--endDate <endDate>`, `End date for the usage`)
+    .option(`--period <period>`, `Period used`)
     .action(actionRunner(projectGetUsage))
 
 project
@@ -287,13 +278,12 @@ project
     .requiredOption(`--variableId <variableId>`, `Variable unique ID.`)
     .action(actionRunner(projectDeleteVariable))
 
-
 module.exports = {
     project,
-    projectGetUsage,    
-    projectListVariables,    
-    projectCreateVariable,    
-    projectGetVariable,    
-    projectUpdateVariable,    
-    projectDeleteVariable    
+    projectGetUsage,
+    projectListVariables,
+    projectCreateVariable,
+    projectGetVariable,
+    projectUpdateVariable,
+    projectDeleteVariable
 };