appwrite-cli 5.0.5 → 6.0.0-rc.1

package/lib/commands/teams.js

@@ -4,7 +4,7 @@ const tar = require("tar");
 const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const { getAllFiles } = require('../utils.js');
+const { getAllFiles, showConsoleLink } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -43,6 +43,7 @@ const teams = new Command("teams").description(commandDescriptions['teams']).con
  * @typedef {Object} TeamsListRequestParams
  * @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: name, total, billingPlan
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -50,8 +51,9 @@ const teams = new Command("teams").description(commandDescriptions['teams']).con
 /**
  * @param {TeamsListRequestParams} params
  */
-const teamsList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsList = async ({queries,search,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams';
     let payload = {};
     if (typeof queries !== 'undefined') {
@@ -68,11 +70,16 @@ const teamsList = async ({ queries, search, parseOutput = true, sdk = undefined}
     }, payload);
 
     if (parseOutput) {
-        parse(response)
-        success()
+        if(console) {
+            showConsoleLink('teams', 'list');
+         } else {
+            parse(response)
+            success()
+        }
     }
-    
+
     return response;
+
 }
 
 /**
@@ -80,6 +87,7 @@ const teamsList = async ({ queries, search, parseOutput = true, sdk = undefined}
  * @property {string} teamId Team ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
  * @property {string} name Team name. Max length: 128 chars.
  * @property {string[]} roles Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -87,8 +95,9 @@ const teamsList = async ({ queries, search, parseOutput = true, sdk = undefined}
 /**
  * @param {TeamsCreateRequestParams} params
  */
-const teamsCreate = async ({ teamId, name, roles, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsCreate = async ({teamId,name,roles,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams';
     let payload = {};
     if (typeof teamId !== 'undefined') {
@@ -112,13 +121,15 @@ const teamsCreate = async ({ teamId, name, roles, parseOutput = true, sdk = unde
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} TeamsGetRequestParams
  * @property {string} teamId Team ID.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -126,8 +137,9 @@ const teamsCreate = async ({ teamId, name, roles, parseOutput = true, sdk = unde
 /**
  * @param {TeamsGetRequestParams} params
  */
-const teamsGet = async ({ teamId, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsGet = async ({teamId,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
     let payload = {};
 
@@ -138,17 +150,23 @@ const teamsGet = async ({ teamId, parseOutput = true, sdk = undefined}) => {
     }, payload);
 
     if (parseOutput) {
-        parse(response)
-        success()
+        if(console) {
+            showConsoleLink('teams', 'get', teamId);
+         } else {
+            parse(response)
+            success()
+        }
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} TeamsUpdateNameRequestParams
  * @property {string} teamId Team ID.
  * @property {string} name New team name. Max length: 128 chars.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -156,8 +174,9 @@ const teamsGet = async ({ teamId, parseOutput = true, sdk = undefined}) => {
 /**
  * @param {TeamsUpdateNameRequestParams} params
  */
-const teamsUpdateName = async ({ teamId, name, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsUpdateName = async ({teamId,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
     let payload = {};
     if (typeof name !== 'undefined') {
@@ -174,13 +193,15 @@ const teamsUpdateName = async ({ teamId, name, parseOutput = true, sdk = undefin
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} TeamsDeleteRequestParams
  * @property {string} teamId Team ID.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -188,8 +209,9 @@ const teamsUpdateName = async ({ teamId, name, parseOutput = true, sdk = undefin
 /**
  * @param {TeamsDeleteRequestParams} params
  */
-const teamsDelete = async ({ teamId, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsDelete = async ({teamId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
     let payload = {};
 
@@ -203,14 +225,16 @@ const teamsDelete = async ({ teamId, parseOutput = true, sdk = undefined}) => {
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} TeamsListLogsRequestParams
  * @property {string} teamId Team ID.
  * @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). Only supported methods are limit and offset
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -218,8 +242,9 @@ const teamsDelete = async ({ teamId, parseOutput = true, sdk = undefined}) => {
 /**
  * @param {TeamsListLogsRequestParams} params
  */
-const teamsListLogs = async ({ teamId, queries, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsListLogs = async ({teamId,queries,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}/logs'.replace('{teamId}', teamId);
     let payload = {};
     if (typeof queries !== 'undefined') {
@@ -236,8 +261,9 @@ const teamsListLogs = async ({ teamId, queries, parseOutput = true, sdk = undefi
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
@@ -245,6 +271,7 @@ const teamsListLogs = async ({ teamId, queries, parseOutput = true, sdk = undefi
  * @property {string} teamId Team ID.
  * @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: userId, teamId, invited, joined, confirm
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -252,8 +279,9 @@ const teamsListLogs = async ({ teamId, queries, parseOutput = true, sdk = undefi
 /**
  * @param {TeamsListMembershipsRequestParams} params
  */
-const teamsListMemberships = async ({ teamId, queries, search, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsListMemberships = async ({teamId,queries,search,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
     let payload = {};
     if (typeof queries !== 'undefined') {
@@ -273,8 +301,9 @@ const teamsListMemberships = async ({ teamId, queries, search, parseOutput = tru
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
@@ -284,8 +313,9 @@ const teamsListMemberships = async ({ teamId, queries, search, parseOutput = tru
  * @property {string} email Email of the new team member.
  * @property {string} userId ID of the user to be added to a team.
  * @property {string} phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
- * @property {string} url URL to redirect the user back to your app from the invitation email.  Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
+ * @property {string} url URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
  * @property {string} name Name of the new team member. Max length: 128 chars.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -293,8 +323,9 @@ const teamsListMemberships = async ({ teamId, queries, search, parseOutput = tru
 /**
  * @param {TeamsCreateMembershipRequestParams} params
  */
-const teamsCreateMembership = async ({ teamId, roles, email, userId, phone, url, name, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsCreateMembership = async ({teamId,roles,email,userId,phone,url,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
     let payload = {};
     if (typeof email !== 'undefined') {
@@ -327,14 +358,16 @@ const teamsCreateMembership = async ({ teamId, roles, email, userId, phone, url,
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} TeamsGetMembershipRequestParams
  * @property {string} teamId Team ID.
  * @property {string} membershipId Membership ID.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -342,8 +375,9 @@ const teamsCreateMembership = async ({ teamId, roles, email, userId, phone, url,
 /**
  * @param {TeamsGetMembershipRequestParams} params
  */
-const teamsGetMembership = async ({ teamId, membershipId, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsGetMembership = async ({teamId,membershipId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
     let payload = {};
 
@@ -357,8 +391,9 @@ const teamsGetMembership = async ({ teamId, membershipId, parseOutput = true, sd
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
@@ -366,6 +401,7 @@ const teamsGetMembership = async ({ teamId, membershipId, parseOutput = true, sd
  * @property {string} teamId Team ID.
  * @property {string} membershipId Membership ID.
  * @property {string[]} roles An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -373,8 +409,9 @@ const teamsGetMembership = async ({ teamId, membershipId, parseOutput = true, sd
 /**
  * @param {TeamsUpdateMembershipRequestParams} params
  */
-const teamsUpdateMembership = async ({ teamId, membershipId, roles, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsUpdateMembership = async ({teamId,membershipId,roles,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
     let payload = {};
     roles = roles === true ? [] : roles;
@@ -392,14 +429,16 @@ const teamsUpdateMembership = async ({ teamId, membershipId, roles, parseOutput
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} TeamsDeleteMembershipRequestParams
  * @property {string} teamId Team ID.
  * @property {string} membershipId Membership ID.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -407,8 +446,9 @@ const teamsUpdateMembership = async ({ teamId, membershipId, roles, parseOutput
 /**
  * @param {TeamsDeleteMembershipRequestParams} params
  */
-const teamsDeleteMembership = async ({ teamId, membershipId, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsDeleteMembership = async ({teamId,membershipId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
     let payload = {};
 
@@ -422,8 +462,9 @@ const teamsDeleteMembership = async ({ teamId, membershipId, parseOutput = true,
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
@@ -432,6 +473,7 @@ const teamsDeleteMembership = async ({ teamId, membershipId, parseOutput = true,
  * @property {string} membershipId Membership ID.
  * @property {string} userId User ID.
  * @property {string} secret Secret key.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -439,8 +481,9 @@ const teamsDeleteMembership = async ({ teamId, membershipId, parseOutput = true,
 /**
  * @param {TeamsUpdateMembershipStatusRequestParams} params
  */
-const teamsUpdateMembershipStatus = async ({ teamId, membershipId, userId, secret, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsUpdateMembershipStatus = async ({teamId,membershipId,userId,secret,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
     let payload = {};
     if (typeof userId !== 'undefined') {
@@ -460,13 +503,15 @@ const teamsUpdateMembershipStatus = async ({ teamId, membershipId, userId, secre
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} TeamsGetPrefsRequestParams
  * @property {string} teamId Team ID.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -474,8 +519,9 @@ const teamsUpdateMembershipStatus = async ({ teamId, membershipId, userId, secre
 /**
  * @param {TeamsGetPrefsRequestParams} params
  */
-const teamsGetPrefs = async ({ teamId, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsGetPrefs = async ({teamId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
     let payload = {};
 
@@ -489,14 +535,16 @@ const teamsGetPrefs = async ({ teamId, parseOutput = true, sdk = undefined}) =>
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} TeamsUpdatePrefsRequestParams
  * @property {string} teamId Team ID.
  * @property {object} prefs Prefs key-value JSON object.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -504,8 +552,9 @@ const teamsGetPrefs = async ({ teamId, parseOutput = true, sdk = undefined}) =>
 /**
  * @param {TeamsUpdatePrefsRequestParams} params
  */
-const teamsUpdatePrefs = async ({ teamId, prefs, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const teamsUpdatePrefs = async ({teamId,prefs,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
     let payload = {};
     if (typeof prefs !== 'undefined') {
@@ -522,8 +571,9 @@ const teamsUpdatePrefs = async ({ teamId, prefs, parseOutput = true, sdk = undef
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 teams
@@ -531,6 +581,7 @@ teams
     .description(`Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.`)
     .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: name, total, billingPlan`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
+    .option(`--console`, `Get the resource console url`)
     .action(actionRunner(teamsList))
 
 teams
@@ -545,6 +596,7 @@ teams
     .command(`get`)
     .description(`Get a team by its ID. All team members have read access for this resource.`)
     .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .option(`--console`, `Get the resource console url`)
     .action(actionRunner(teamsGet))
 
 teams
@@ -583,7 +635,7 @@ teams
     .option(`--email <email>`, `Email of the new team member.`)
     .option(`--userId <userId>`, `ID of the user to be added to a team.`)
     .option(`--phone <phone>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
-    .option(`--url <url>`, `URL to redirect the user back to your app from the invitation email.  Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
+    .option(`--url <url>`, `URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
     .option(`--name <name>`, `Name of the new team member. Max length: 128 chars.`)
     .action(actionRunner(teamsCreateMembership))
 
@@ -647,4 +699,4 @@ module.exports = {
     teamsUpdateMembershipStatus,
     teamsGetPrefs,
     teamsUpdatePrefs
-};
+};