appwrite-cli 0.14.0

package/lib/commands/teams.js

@@ -0,0 +1,435 @@
+const fs = require('fs');
+const { promisify } = require('util');
+const libClient = require('../client.js');
+const childProcess = require('child_process');
+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 teams = new Command("teams").description(commandDescriptions['teams'])
+
+const teamsList = async ({ search, limit, offset, cursor, cursorDirection, orderType, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} search */
+    /* @param {number} limit */
+    /* @param {number} offset */
+    /* @param {string} cursor */
+    /* @param {string} cursorDirection */
+    /* @param {string} orderType */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams';
+    let payload = {};
+
+    /** Query Params */
+    if (typeof search !== 'undefined') {
+        payload['search'] = search;
+    }
+    if (typeof limit !== 'undefined') {
+        payload['limit'] = limit;
+    }
+    if (typeof offset !== 'undefined') {
+        payload['offset'] = offset;
+    }
+    if (typeof cursor !== 'undefined') {
+        payload['cursor'] = cursor;
+    }
+    if (typeof cursorDirection !== 'undefined') {
+        payload['cursorDirection'] = cursorDirection;
+    }
+    if (typeof orderType !== 'undefined') {
+        payload['orderType'] = orderType;
+    }
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsCreate = async ({ teamId, name, roles, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {string} name */
+    /* @param {string[]} roles */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof teamId !== 'undefined') {
+        payload['teamId'] = teamId;
+    }
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
+    if (typeof roles !== 'undefined') {
+        payload['roles'] = roles;
+    }
+
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsGet = async ({ teamId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}'.replace('{teamId}', teamId);
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsUpdate = async ({ teamId, name, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {string} name */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}'.replace('{teamId}', teamId);
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
+    let response = undefined;
+    response = await client.call('put', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsDelete = async ({ teamId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}'.replace('{teamId}', teamId);
+    let payload = {};
+    let response = undefined;
+    response = await client.call('delete', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsGetMemberships = async ({ teamId, search, limit, offset, cursor, cursorDirection, orderType, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {string} search */
+    /* @param {number} limit */
+    /* @param {number} offset */
+    /* @param {string} cursor */
+    /* @param {string} cursorDirection */
+    /* @param {string} orderType */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
+    let payload = {};
+
+    /** Query Params */
+    if (typeof search !== 'undefined') {
+        payload['search'] = search;
+    }
+    if (typeof limit !== 'undefined') {
+        payload['limit'] = limit;
+    }
+    if (typeof offset !== 'undefined') {
+        payload['offset'] = offset;
+    }
+    if (typeof cursor !== 'undefined') {
+        payload['cursor'] = cursor;
+    }
+    if (typeof cursorDirection !== 'undefined') {
+        payload['cursorDirection'] = cursorDirection;
+    }
+    if (typeof orderType !== 'undefined') {
+        payload['orderType'] = orderType;
+    }
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsCreateMembership = async ({ teamId, email, roles, url, name, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {string} email */
+    /* @param {string[]} roles */
+    /* @param {string} url */
+    /* @param {string} name */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof email !== 'undefined') {
+        payload['email'] = email;
+    }
+
+    if (typeof roles !== 'undefined') {
+        payload['roles'] = roles;
+    }
+
+    if (typeof url !== 'undefined') {
+        payload['url'] = url;
+    }
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsGetMembership = async ({ teamId, membershipId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {string} membershipId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsUpdateMembershipRoles = async ({ teamId, membershipId, roles, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {string} membershipId */
+    /* @param {string[]} roles */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof roles !== 'undefined') {
+        payload['roles'] = roles;
+    }
+
+    let response = undefined;
+    response = await client.call('patch', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsDeleteMembership = async ({ teamId, membershipId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {string} membershipId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
+    let payload = {};
+    let response = undefined;
+    response = await client.call('delete', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsUpdateMembershipStatus = async ({ teamId, membershipId, userId, secret, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {string} membershipId */
+    /* @param {string} userId */
+    /* @param {string} secret */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}/memberships/{membershipId}/status'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
+    }
+
+    if (typeof secret !== 'undefined') {
+        payload['secret'] = secret;
+    }
+
+    let response = undefined;
+    response = await client.call('patch', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+
+teams
+    .command(`list`)
+    .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.
 
 In admin mode, this endpoint returns a list of all the teams in the current project. [Learn more about different API modes](/docs/admin).`)
+    .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
+    .option(`--limit <limit>`, `Maximum number of teams to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.`, parseInteger)
+    .option(`--offset <offset>`, `Offset value. The default value is 0. Use this param to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)`, parseInteger)
+    .option(`--cursor <cursor>`, `ID of the team used as the starting point for the query, excluding the team itself. Should be used for efficient pagination when working with large sets of data. [learn more about pagination](https://appwrite.io/docs/pagination)`)
+    .option(`--cursorDirection <cursorDirection>`, `Direction of the cursor.`)
+    .option(`--orderType <orderType>`, `Order result by ASC or DESC order.`)
+    .action(actionRunner(teamsList))
+
+teams
+    .command(`create`)
+    .description(`Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID. Choose your own unique ID or pass the string "unique()" to auto generate it. 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.`)
+    .requiredOption(`--name <name>`, `Team name. Max length: 128 chars.`)
+    .option(`--roles <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](/docs/permissions). Max length for each role is 32 chars.`)
+    .action(actionRunner(teamsCreate))
+
+teams
+    .command(`get`)
+    .description(`Get a team by its ID. All team members have read access for this resource.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .action(actionRunner(teamsGet))
+
+teams
+    .command(`update`)
+    .description(`Update a team using its ID. Only members with the owner role can update the team.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .requiredOption(`--name <name>`, `New team name. Max length: 128 chars.`)
+    .action(actionRunner(teamsUpdate))
+
+teams
+    .command(`delete`)
+    .description(`Delete a team using its ID. Only team members with the owner role can delete the team.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .action(actionRunner(teamsDelete))
+
+teams
+    .command(`getMemberships`)
+    .description(`Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
+    .option(`--limit <limit>`, `Maximum number of memberships to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.`, parseInteger)
+    .option(`--offset <offset>`, `Offset value. The default value is 0. Use this value to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)`, parseInteger)
+    .option(`--cursor <cursor>`, `ID of the membership used as the starting point for the query, excluding the membership itself. Should be used for efficient pagination when working with large sets of data. [learn more about pagination](https://appwrite.io/docs/pagination)`)
+    .option(`--cursorDirection <cursorDirection>`, `Direction of the cursor.`)
+    .option(`--orderType <orderType>`, `Order result by ASC or DESC order.`)
+    .action(actionRunner(teamsGetMemberships))
+
+teams
+    .command(`createMembership`)
+    .description(`Invite a new member to join your team. If initiated from the client SDK, an email with a link to join the team will be sent to the member's email address and an account will be created for them should they not be signed up already. If initiated from server-side SDKs, the new member will automatically be added to the team.  Use the 'url' parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the [Update Team Membership Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow the user to accept the invitation to the team.   Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URL's are the once from domains you have set when adding your platforms in the console interface.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .requiredOption(`--email <email>`, `Email of the new team member.`)
+    .requiredOption(`--roles <roles...>`, `Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Max length for each role is 32 chars.`)
+    .requiredOption(`--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(`--name <name>`, `Name of the new team member. Max length: 128 chars.`)
+    .action(actionRunner(teamsCreateMembership))
+
+teams
+    .command(`getMembership`)
+    .description(`Get a team member by the membership unique id. All team members have read access for this resource.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .requiredOption(`--membershipId <membershipId>`, `Membership ID.`)
+    .action(actionRunner(teamsGetMembership))
+
+teams
+    .command(`updateMembershipRoles`)
+    .description(`Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](/docs/permissions).`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .requiredOption(`--membershipId <membershipId>`, `Membership ID.`)
+    .requiredOption(`--roles <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). Max length for each role is 32 chars.`)
+    .action(actionRunner(teamsUpdateMembershipRoles))
+
+teams
+    .command(`deleteMembership`)
+    .description(`This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .requiredOption(`--membershipId <membershipId>`, `Membership ID.`)
+    .action(actionRunner(teamsDeleteMembership))
+
+teams
+    .command(`updateMembershipStatus`)
+    .description(`Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.  If the request is successful, a session for the user is automatically created. `)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .requiredOption(`--membershipId <membershipId>`, `Membership ID.`)
+    .requiredOption(`--userId <userId>`, `User ID.`)
+    .requiredOption(`--secret <secret>`, `Secret key.`)
+    .action(actionRunner(teamsUpdateMembershipStatus))
+
+
+module.exports = {
+    teams,
+    teamsList,
+    teamsCreate,
+    teamsGet,
+    teamsUpdate,
+    teamsDelete,
+    teamsGetMemberships,
+    teamsCreateMembership,
+    teamsGetMembership,
+    teamsUpdateMembershipRoles,
+    teamsDeleteMembership,
+    teamsUpdateMembershipStatus
+};