appwrite-cli 13.0.0-rc.1 → 13.0.0-rc.2

package/lib/commands/teams.ts

@@ -1,609 +0,0 @@
-import fs = require('fs');
-import pathLib = require('path');
-import tar = require('tar');
-import ignore = require('ignore');
-import { promisify } from 'util';
-import Client from '../client';
-import { getAllFiles, showConsoleLink } from '../utils';
-import { Command } from 'commander';
-import { sdkForProject, sdkForConsole } from '../sdks';
-import { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log, warn } from '../parser';
-import { localConfig, globalConfig } from '../config';
-import { File } from 'undici';
-import { ReadableStream } from 'stream/web';
-
-function convertReadStreamToReadableStream(readStream: fs.ReadStream): ReadableStream {
-  return new ReadableStream({
-    start(controller) {
-      readStream.on("data", (chunk: Buffer) => {
-        controller.enqueue(chunk);
-      });
-      readStream.on("end", () => {
-        controller.close();
-      });
-      readStream.on("error", (err: Error) => {
-        controller.error(err);
-      });
-    },
-    cancel() {
-      readStream.destroy();
-    },
-  });
-}
-
-export const teams = new Command("teams").description(commandDescriptions['teams'] ?? '').configureHelp({
-    helpWidth: process.stdout.columns || 80
-})
-
-interface TeamsListRequestParams {
-    queries?: string[];
-    search?: string;
-    total?: boolean;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-    console?: boolean;
-}
-
-export const teamsList = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console: showConsole}: TeamsListRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams';
-    let payload = {};
-    if (typeof queries !== 'undefined') {
-        payload['queries'] = queries;
-    }
-    if (typeof search !== 'undefined') {
-        payload['search'] = search;
-    }
-    if (typeof total !== 'undefined') {
-        payload['total'] = total;
-    }
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-    }, payload);
-
-    if (parseOutput) {
-        if(showConsole) {
-            showConsoleLink('teams', 'list');
-         } else {
-            parse(response)
-        }
-    }
-
-    return response;
-
-}
-interface TeamsCreateRequestParams {
-    teamId: string;
-    name: string;
-    roles?: string[];
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsCreate = async ({teamId,name,roles,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsCreateRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams';
-    let payload = {};
-    if (typeof teamId !== 'undefined') {
-        payload['teamId'] = teamId;
-    }
-    if (typeof name !== 'undefined') {
-        payload['name'] = name;
-    }
-    roles = roles === true ? [] : roles;
-    if (typeof roles !== 'undefined') {
-        payload['roles'] = roles;
-    }
-
-    let response = undefined;
-
-    response = await client.call('post', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsGetRequestParams {
-    teamId: string;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-    console?: boolean;
-}
-
-export const teamsGet = async ({teamId,parseOutput = true, overrideForCli = false, sdk = undefined, console: showConsole}: TeamsGetRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
-    let payload = {};
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-    }, payload);
-
-    if (parseOutput) {
-        if(showConsole) {
-            showConsoleLink('teams', 'get', teamId);
-         } else {
-            parse(response)
-        }
-    }
-
-    return response;
-
-}
-interface TeamsUpdateNameRequestParams {
-    teamId: string;
-    name: string;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsUpdateName = async ({teamId,name,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsUpdateNameRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
-    let payload = {};
-    if (typeof name !== 'undefined') {
-        payload['name'] = name;
-    }
-
-    let response = undefined;
-
-    response = await client.call('put', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsDeleteRequestParams {
-    teamId: string;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsDelete = async ({teamId,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsDeleteRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
-    let payload = {};
-
-    let response = undefined;
-
-    response = await client.call('delete', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsListLogsRequestParams {
-    teamId: string;
-    queries?: string[];
-    total?: boolean;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsListLogs = async ({teamId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsListLogsRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}/logs'.replace('{teamId}', teamId);
-    let payload = {};
-    if (typeof queries !== 'undefined') {
-        payload['queries'] = queries;
-    }
-    if (typeof total !== 'undefined') {
-        payload['total'] = total;
-    }
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsListMembershipsRequestParams {
-    teamId: string;
-    queries?: string[];
-    search?: string;
-    total?: boolean;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsListMemberships = async ({teamId,queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsListMembershipsRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
-    let payload = {};
-    if (typeof queries !== 'undefined') {
-        payload['queries'] = queries;
-    }
-    if (typeof search !== 'undefined') {
-        payload['search'] = search;
-    }
-    if (typeof total !== 'undefined') {
-        payload['total'] = total;
-    }
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsCreateMembershipRequestParams {
-    teamId: string;
-    roles: string[];
-    email?: string;
-    userId?: string;
-    phone?: string;
-    url?: string;
-    name?: string;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsCreateMembership = async ({teamId,roles,email,userId,phone,url,name,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsCreateMembershipRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
-    let payload = {};
-    if (typeof email !== 'undefined') {
-        payload['email'] = email;
-    }
-    if (typeof userId !== 'undefined') {
-        payload['userId'] = userId;
-    }
-    if (typeof phone !== 'undefined') {
-        payload['phone'] = phone;
-    }
-    roles = roles === true ? [] : roles;
-    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', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsGetMembershipRequestParams {
-    teamId: string;
-    membershipId: string;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsGetMembership = async ({teamId,membershipId,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsGetMembershipRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
-    let payload = {};
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsUpdateMembershipRequestParams {
-    teamId: string;
-    membershipId: string;
-    roles: string[];
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsUpdateMembership = async ({teamId,membershipId,roles,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsUpdateMembershipRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
-    let payload = {};
-    roles = roles === true ? [] : roles;
-    if (typeof roles !== 'undefined') {
-        payload['roles'] = roles;
-    }
-
-    let response = undefined;
-
-    response = await client.call('patch', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsDeleteMembershipRequestParams {
-    teamId: string;
-    membershipId: string;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsDeleteMembership = async ({teamId,membershipId,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsDeleteMembershipRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
-    let payload = {};
-
-    let response = undefined;
-
-    response = await client.call('delete', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsUpdateMembershipStatusRequestParams {
-    teamId: string;
-    membershipId: string;
-    userId: string;
-    secret: string;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsUpdateMembershipStatus = async ({teamId,membershipId,userId,secret,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsUpdateMembershipStatusRequestParams): Promise<any> => {
-    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') {
-        payload['userId'] = userId;
-    }
-    if (typeof secret !== 'undefined') {
-        payload['secret'] = secret;
-    }
-
-    let response = undefined;
-
-    response = await client.call('patch', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsGetPrefsRequestParams {
-    teamId: string;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsGetPrefs = async ({teamId,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsGetPrefsRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
-    let payload = {};
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-interface TeamsUpdatePrefsRequestParams {
-    teamId: string;
-    prefs: object;
-    overrideForCli?: boolean;
-    parseOutput?: boolean;
-    sdk?: Client;
-}
-
-export const teamsUpdatePrefs = async ({teamId,prefs,parseOutput = true, overrideForCli = false, sdk = undefined}: TeamsUpdatePrefsRequestParams): Promise<any> => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
-    let payload = {};
-    if (typeof prefs !== 'undefined') {
-        payload['prefs'] = JSON.parse(prefs);
-    }
-
-    let response = undefined;
-
-    response = await client.call('put', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    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.`)
-    .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(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
-    .option(`--console`, `Get the resource console url`)
-    .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(`--team-id <team-id>`, `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.`)
-    .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](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
-    .action(actionRunner(teamsCreate))
-
-teams
-    .command(`get`)
-    .description(`Get a team by its ID. All team members have read access for this resource.`)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .option(`--console`, `Get the resource console url`)
-    .action(actionRunner(teamsGet))
-
-teams
-    .command(`update-name`)
-    .description(`Update the team's name by its unique ID.`)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .requiredOption(`--name <name>`, `New team name. Max length: 128 chars.`)
-    .action(actionRunner(teamsUpdateName))
-
-teams
-    .command(`delete`)
-    .description(`Delete a team using its ID. Only team members with the owner role can delete the team.`)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .action(actionRunner(teamsDelete))
-
-teams
-    .command(`list-logs`)
-    .description(`Get the team activity logs list by its unique ID.`)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .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). Only supported methods are limit and offset`)
-    .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
-    .action(actionRunner(teamsListLogs))
-
-teams
-    .command(`list-memberships`)
-    .description(`Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.`)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .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: userId, teamId, invited, joined, confirm, roles`)
-    .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
-    .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
-    .action(actionRunner(teamsListMemberships))
-
-teams
-    .command(`create-membership`)
-    .description(`Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.  You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.  Use the 'url' parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) 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) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console. `)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .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](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
-    .option(`--email <email>`, `Email of the new team member.`)
-    .option(`--user-id <user-id>`, `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. 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))
-
-teams
-    .command(`get-membership`)
-    .description(`Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.`)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .requiredOption(`--membership-id <membership-id>`, `Membership ID.`)
-    .action(actionRunner(teamsGetMembership))
-
-teams
-    .command(`update-membership`)
-    .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](https://appwrite.io/docs/permissions). `)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .requiredOption(`--membership-id <membership-id>`, `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). Maximum of 100 roles are allowed, each 32 characters long.`)
-    .action(actionRunner(teamsUpdateMembership))
-
-teams
-    .command(`delete-membership`)
-    .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(`--team-id <team-id>`, `Team ID.`)
-    .requiredOption(`--membership-id <membership-id>`, `Membership ID.`)
-    .action(actionRunner(teamsDeleteMembership))
-
-teams
-    .command(`update-membership-status`)
-    .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(`--team-id <team-id>`, `Team ID.`)
-    .requiredOption(`--membership-id <membership-id>`, `Membership ID.`)
-    .requiredOption(`--user-id <user-id>`, `User ID.`)
-    .requiredOption(`--secret <secret>`, `Secret key.`)
-    .action(actionRunner(teamsUpdateMembershipStatus))
-
-teams
-    .command(`get-prefs`)
-    .description(`Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).`)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .action(actionRunner(teamsGetPrefs))
-
-teams
-    .command(`update-prefs`)
-    .description(`Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.`)
-    .requiredOption(`--team-id <team-id>`, `Team ID.`)
-    .requiredOption(`--prefs <prefs>`, `Prefs key-value JSON object.`)
-    .action(actionRunner(teamsUpdatePrefs))
-
-