appwrite-cli 4.2.0 → 4.2.2

package/lib/commands/teams.js

@@ -9,390 +9,523 @@ 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 { File } = require('undici');
+const { ReadableStream } = require('stream/web');
+
+/**
+ * @param {fs.ReadStream} readStream
+ * @returns {ReadableStream}
+ */
+function convertReadStreamToReadableStream(readStream) {
+  return new ReadableStream({
+    start(controller) {
+      readStream.on("data", (chunk) => {
+        controller.enqueue(chunk);
+      });
+      readStream.on("end", () => {
+        controller.close();
+      });
+      readStream.on("error", (err) => {
+        controller.error(err);
+      });
+    },
+    cancel() {
+      readStream.destroy();
+    },
+  });
+}
 
 const teams = new Command("teams").description(commandDescriptions['teams']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
-
+})
+
+/**
+ * @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
+ * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsListRequestParams} params
+ */
 const teamsList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} queries */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/teams';
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} TeamsCreateRequestParams
+ * @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} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsCreateRequestParams} params
+ */
 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 apiPath = '/teams';
     let payload = {};
-    
-    /** Body Params */
-
     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)
         success()
     }
+    
     return response;
 }
 
-const teamsGet = async ({ teamId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
+/**
+ * @typedef {Object} TeamsGetRequestParams
+ * @property {string} teamId Team ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {TeamsGetRequestParams} params
+ */
+const teamsGet = async ({ teamId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
     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} TeamsUpdateNameRequestParams
+ * @property {string} teamId Team ID.
+ * @property {string} name New team name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsUpdateNameRequestParams} params
+ */
 const teamsUpdateName = async ({ teamId, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
     let payload = {};
-    
-    /** Body Params */
-
     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)
         success()
     }
+    
     return response;
 }
 
-const teamsDelete = async ({ teamId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
+/**
+ * @typedef {Object} TeamsDeleteRequestParams
+ * @property {string} teamId Team ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {TeamsDeleteRequestParams} params
+ */
+const teamsDelete = async ({ teamId, parseOutput = true, sdk = undefined}) => {
     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)
         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} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsListLogsRequestParams} params
+ */
 const teamsListLogs = async ({ teamId, queries, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
-    /* @param {string[]} queries */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/teams/{teamId}/logs'.replace('{teamId}', teamId);
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} TeamsListMembershipsRequestParams
+ * @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} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsListMembershipsRequestParams} params
+ */
 const teamsListMemberships = async ({ teamId, queries, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
-    /* @param {string[]} queries */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} TeamsCreateMembershipRequestParams
+ * @property {string} teamId Team ID.
+ * @property {string[]} 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.
+ * @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} name Name of the new team member. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsCreateMembershipRequestParams} params
+ */
 const teamsCreateMembership = async ({ teamId, roles, email, userId, phone, url, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
-    /* @param {string[]} roles */
-    /* @param {string} email */
-    /* @param {string} userId */
-    /* @param {string} phone */
-    /* @param {string} url */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
     let payload = {};
-    
-    /** Body Params */
-
     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)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} TeamsGetMembershipRequestParams
+ * @property {string} teamId Team ID.
+ * @property {string} membershipId Membership ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsGetMembershipRequestParams} params
+ */
 const teamsGetMembership = async ({ teamId, membershipId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
-    /* @param {string} membershipId */
-
     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, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} TeamsUpdateMembershipRequestParams
+ * @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} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsUpdateMembershipRequestParams} params
+ */
 const teamsUpdateMembership = async ({ teamId, membershipId, roles, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
-    /* @param {string} membershipId */
-    /* @param {string[]} roles */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
     let payload = {};
-    
-    /** Body Params */
     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)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} TeamsDeleteMembershipRequestParams
+ * @property {string} teamId Team ID.
+ * @property {string} membershipId Membership ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsDeleteMembershipRequestParams} params
+ */
 const teamsDeleteMembership = async ({ teamId, membershipId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
-    /* @param {string} membershipId */
-
     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)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} TeamsUpdateMembershipStatusRequestParams
+ * @property {string} teamId Team ID.
+ * @property {string} membershipId Membership ID.
+ * @property {string} userId User ID.
+ * @property {string} secret Secret key.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsUpdateMembershipStatusRequestParams} params
+ */
 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 apiPath = '/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', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const teamsGetPrefs = async ({ teamId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
+/**
+ * @typedef {Object} TeamsGetPrefsRequestParams
+ * @property {string} teamId Team ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {TeamsGetPrefsRequestParams} params
+ */
+const teamsGetPrefs = async ({ teamId, parseOutput = true, sdk = undefined}) => {
     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, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} TeamsUpdatePrefsRequestParams
+ * @property {string} teamId Team ID.
+ * @property {object} prefs Prefs key-value JSON object.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {TeamsUpdatePrefsRequestParams} params
+ */
 const teamsUpdatePrefs = async ({ teamId, prefs, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} teamId */
-    /* @param {object} prefs */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
     let payload = {};
-    
-    /** Body Params */
     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)
         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.`)
@@ -498,7 +631,6 @@ teams
     .requiredOption(`--prefs <prefs>`, `Prefs key-value JSON object.`)
     .action(actionRunner(teamsUpdatePrefs))
 
-
 module.exports = {
     teams,
     teamsList,
@@ -515,4 +647,4 @@ module.exports = {
     teamsUpdateMembershipStatus,
     teamsGetPrefs,
     teamsUpdatePrefs
-};
+};