appwrite-cli 16.0.0 → 17.1.0

package/lib/commands/services/users.ts

@@ -29,7 +29,7 @@ export const users = new Command("users")
 users
   .command(`list`)
   .description(`Get a list of all the project's users. You can use the query params 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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels`)
+  .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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator`)
   .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
   .option(
     `--total [value]`,
@@ -241,6 +241,19 @@ users
     ),
   );
 
+users
+  .command(`update-impersonator`)
+  .description(`Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.
+`)
+  .requiredOption(`--user-id <user-id>`, `User ID.`)
+  .requiredOption(`--impersonator <impersonator>`, `Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.`, parseBool)
+  .action(
+    actionRunner(
+      async ({ userId, impersonator }) =>
+        parse(await (await getUsersClient()).updateImpersonator(userId, impersonator)),
+    ),
+  );
+
 users
   .command(`create-jwt`)
   .description(`Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.`)

package/lib/commands/services/vcs.ts

@@ -1,5 +1,5 @@
 import { Command } from "commander";
-import { sdkForProject } from "../../sdks.js";
+import { sdkForConsole } from "../../sdks.js";
 import {
   actionRunner,
   commandDescriptions,
@@ -14,7 +14,7 @@ let vcsClient: Vcs | null = null;
 
 const getVcsClient = async (): Promise<Vcs> => {
   if (!vcsClient) {
-    const sdkClient = await sdkForProject();
+    const sdkClient = await sdkForConsole();
     vcsClient = new Vcs(sdkClient);
   }
   return vcsClient;

package/lib/constants.ts

@@ -1,7 +1,7 @@
 // SDK
 export const SDK_TITLE = 'Appwrite';
 export const SDK_TITLE_LOWER = 'appwrite';
-export const SDK_VERSION = '16.0.0';
+export const SDK_VERSION = '17.1.0';
 export const SDK_NAME = 'Command Line';
 export const SDK_PLATFORM = 'console';
 export const SDK_LANGUAGE = 'cli';

package/lib/emulation/utils.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from "node:events";
 import { localConfig } from "../config.js";
 import { log } from "../parser.js";
-import { sdkForConsole } from "../sdks.js";
+import { sdkForConsole, sdkForProject } from "../sdks.js";
 import { Projects, Scopes, Users } from "@appwrite.io/console";
 
 export const openRuntimesVersion = "v4";
@@ -108,7 +108,6 @@ export const JwtManager = {
     projectScopes: Scopes[] = [],
   ): Promise<void> {
     const consoleClient = await sdkForConsole();
-    const usersClient = new Users(consoleClient);
     const projectsClient = new Projects(consoleClient);
 
     if (this.timerWarn) {
@@ -139,6 +138,8 @@ export const JwtManager = {
     ); // 60 mins
 
     if (userId) {
+      const projectClient = await sdkForProject();
+      const usersClient = new Users(projectClient);
       await usersClient.get({
         userId,
       });

package/lib/parser.ts

@@ -1,3 +1,6 @@
+// @ts-expect-error BigInt toJSON polyfill for JSON.stringify support
+BigInt.prototype.toJSON = function () { return this.toString(); };
+
 import chalk from "chalk";
 import { InvalidArgumentError } from "commander";
 import Table from "cli-table3";
@@ -18,6 +21,7 @@ import {
 const cliConfig: CliConfig = {
   verbose: false,
   json: false,
+  raw: false,
   force: false,
   all: false,
   ids: [],
@@ -54,36 +58,118 @@ const extractReportCommandArgs = (value: unknown): string[] => {
   return reportData.data.args;
 };
 
+const filterObject = (obj: JsonObject): JsonObject => {
+  const result: JsonObject = {};
+  for (const key of Object.keys(obj)) {
+    const value = obj[key];
+    if (typeof value === "function") continue;
+    if (value == null) continue;
+    if (value?.constructor?.name === "BigNumber") {
+      result[key] = String(value);
+      continue;
+    }
+    if (typeof value === "object") continue;
+    if (typeof value === "string" && value.trim() === "") continue;
+    result[key] = value;
+  }
+  return result;
+};
+
+const filterData = (data: JsonObject): JsonObject => {
+  const result: JsonObject = {};
+  for (const key of Object.keys(data)) {
+    const value = data[key];
+    if (typeof value === "function") continue;
+    if (value == null) continue;
+    if (value?.constructor?.name === "BigNumber") {
+      result[key] = String(value);
+      continue;
+    }
+    if (Array.isArray(value)) {
+      result[key] = value.map((item) => {
+        if (item?.constructor?.name === "BigNumber") return String(item);
+        return item && typeof item === "object" && !Array.isArray(item)
+          ? filterObject(item as JsonObject)
+          : item;
+      });
+    } else if (typeof value === "object") {
+      continue;
+    } else if (typeof value === "string" && value.trim() === "") {
+      continue;
+    } else {
+      result[key] = value;
+    }
+  }
+  return result;
+};
+
 export const parse = (data: JsonObject): void => {
-  if (cliConfig.json) {
+  if (cliConfig.raw) {
     drawJSON(data);
     return;
   }
 
-  for (const key in data) {
-    if (data[key] === null) {
+  if (cliConfig.json) {
+    drawJSON(filterData(data));
+    return;
+  }
+
+  const keys = Object.keys(data).filter((k) => typeof data[k] !== "function");
+  let printedScalar = false;
+
+  for (const key of keys) {
+    const value = data[key];
+    if (value === null) {
       console.log(`${chalk.yellow.bold(key)} : null`);
-    } else if (Array.isArray(data[key])) {
+      printedScalar = true;
+    } else if (Array.isArray(value)) {
+      if (printedScalar) console.log("");
       console.log(`${chalk.yellow.bold.underline(key)}`);
-      if (typeof data[key][0] === "object") {
-        drawTable(data[key]);
+      if (typeof value[0] === "object") {
+        drawTable(value);
       } else {
-        drawJSON(data[key]);
+        drawJSON(value);
       }
-    } else if (typeof data[key] === "object") {
-      if (data[key]?.constructor?.name === "BigNumber") {
-        console.log(`${chalk.yellow.bold(key)} : ${data[key]}`);
+      printedScalar = false;
+    } else if (typeof value === "object") {
+      if (printedScalar) console.log("");
+      if (value?.constructor?.name === "BigNumber") {
+        console.log(`${chalk.yellow.bold(key)} : ${value}`);
+        printedScalar = true;
       } else {
         console.log(`${chalk.yellow.bold.underline(key)}`);
-        const tableRow = toJsonObject(data[key]) ?? {};
+        const tableRow = toJsonObject(value) ?? {};
         drawTable([tableRow]);
+        printedScalar = false;
       }
     } else {
-      console.log(`${chalk.yellow.bold(key)} : ${data[key]}`);
+      console.log(`${chalk.yellow.bold(key)} : ${value}`);
+      printedScalar = true;
     }
   }
 };
 
+const MAX_COL_WIDTH = 40;
+
+const formatCellValue = (value: unknown): string => {
+  if (value == null) return "-";
+  if (Array.isArray(value)) {
+    if (value.length === 0) return "[]";
+    return `[${value.length} items]`;
+  }
+  if (typeof value === "object") {
+    if (value?.constructor?.name === "BigNumber") return String(value);
+    const keys = Object.keys(value as Record<string, unknown>);
+    if (keys.length === 0) return "{}";
+    return `{${keys.length} keys}`;
+  }
+  const str = String(value);
+  if (str.length > MAX_COL_WIDTH) {
+    return str.slice(0, MAX_COL_WIDTH - 1) + "…";
+  }
+  return str;
+};
+
 export const drawTable = (data: Array<JsonObject | null | undefined>): void => {
   if (data.length == 0) {
     console.log("[]");
@@ -95,23 +181,67 @@ export const drawTable = (data: Array<JsonObject | null | undefined>): void => {
   // Create an object with all the keys in it
   const obj = rows.reduce((res, item) => ({ ...res, ...item }), {});
   // Get those keys as an array
-  const keys = Object.keys(obj);
-  if (keys.length === 0) {
+  const allKeys = Object.keys(obj);
+  if (allKeys.length === 0) {
     drawJSON(data);
     return;
   }
+
+  // If too many columns, show condensed key-value output with only scalar, non-empty fields
+  const maxColumns = 6;
+  if (allKeys.length > maxColumns) {
+    // Collect visible entries per row to compute alignment
+    const rowEntries = rows.map((row) => {
+      const entries: Array<[string, string]> = [];
+      for (const key of Object.keys(row)) {
+        const value = row[key];
+        if (typeof value === "function") continue;
+        if (value == null) continue;
+        if (value?.constructor?.name === "BigNumber") {
+          entries.push([key, String(value)]);
+          continue;
+        }
+        if (typeof value === "object") continue;
+        if (typeof value === "string" && value.trim() === "") continue;
+        entries.push([key, String(value)]);
+      }
+      return entries;
+    });
+
+    const flatEntries = rowEntries.flat();
+    if (flatEntries.length === 0) {
+      drawJSON(data);
+      return;
+    }
+
+    const maxKeyLen = Math.max(...flatEntries.map(([key]) => key.length));
+
+    const separatorLen = Math.min(maxKeyLen + 2 + MAX_COL_WIDTH, process.stdout.columns || 80);
+
+    rowEntries.forEach((entries, idx) => {
+      if (idx > 0) console.log(chalk.cyan("─".repeat(separatorLen)));
+      for (const [key, value] of entries) {
+        const paddedKey = key.padEnd(maxKeyLen);
+        console.log(`${chalk.yellow.bold(paddedKey)}  ${value}`);
+      }
+    });
+    return;
+  }
+
+  const columns = allKeys;
+
   // Create an object with all keys set to the default value ''
-  const def = keys.reduce((result: Record<string, string>, key) => {
+  const def = allKeys.reduce((result: Record<string, string>, key) => {
     result[key] = "-";
     return result;
   }, {});
   // Use object destructuring to replace all default values with the ones we have
   const normalizedData = rows.map((item) => ({ ...def, ...item }));
 
-  const columns = Object.keys(normalizedData[0]);
-
   const table = new Table({
     head: columns.map((c) => chalk.cyan.italic.bold(c)),
+    colWidths: columns.map(() => null) as (number | null)[],
+    wordWrap: false,
     chars: {
       top: " ",
       "top-mid": " ",
@@ -134,15 +264,7 @@ export const drawTable = (data: Array<JsonObject | null | undefined>): void => {
   normalizedData.forEach((row) => {
     const rowValues: string[] = [];
     for (const key of columns) {
-      if (row[key] == null) {
-        rowValues.push("-");
-      } else if (Array.isArray(row[key])) {
-        rowValues.push(JSON.stringify(row[key]));
-      } else if (typeof row[key] === "object") {
-        rowValues.push(JSON.stringify(row[key]));
-      } else {
-        rowValues.push(String(row[key]));
-      }
+      rowValues.push(formatCellValue(row[key]));
     }
     table.push(rowValues);
   });
@@ -291,7 +413,7 @@ export const commandDescriptions: Record<string, string> = {
   locale: `The locale command allows you to customize your app based on your users' location.`,
   sites: `The sites command allows you to view, create and manage your Appwrite Sites.`,
   storage: `The storage command allows you to manage your project files.`,
-  teams: `The teams command allows you to group users of your project to enable them to share read and write access to your project resources.`,
+  teams: `The teams command allows you to group users of your project to enable them to share read and write access to your project resources. Requires a linked project. To manage console-level teams, use the 'organizations' command instead.`,
   update: `The update command allows you to update the ${SDK_TITLE} CLI to the latest version.`,
   users: `The users command allows you to manage your project users.`,
   projects: `The projects command allows you to manage your projects, add platforms, manage API keys, Dev Keys etc.`,

package/lib/questions.ts

@@ -187,15 +187,19 @@ export const questionsInitProject: Question[] = [
       const client = await sdkForConsole(true);
       const { teams } = isCloud()
         ? await paginate(
-            async (opts: { sdk?: Client } = {}) =>
-              (await getOrganizationsService(opts.sdk)).list(),
+            async (args) =>
+              (await getOrganizationsService(args.sdk as Client)).list({
+                queries: args.queries as string[],
+              }),
             { sdk: client },
             100,
             "teams",
           )
         : await paginate(
-            async (opts: { sdk?: Client } = {}) =>
-              (await getTeamsService(opts.sdk)).list(),
+            async (args) =>
+              (await getTeamsService(args.sdk as Client)).list({
+                queries: args.queries as string[],
+              }),
             { parseOutput: false, sdk: client },
             100,
             "teams",
@@ -223,14 +227,14 @@ export const questionsInitProject: Question[] = [
     name: "project",
     message: "What would you like to name your project?",
     default: "My Awesome Project",
-    when: (answer: Answers) => answer.start !== "existing",
+    when: (answer: Answers) => whenOverride(answer) && answer.start !== "existing",
   },
   {
     type: "input",
     name: "id",
     message: "What ID would you like to have for your project?",
     default: "unique()",
-    when: (answer: Answers) => answer.start !== "existing",
+    when: (answer: Answers) => whenOverride(answer) && answer.start !== "existing",
   },
   {
     type: "search-list",
@@ -247,7 +251,7 @@ export const questionsInitProject: Question[] = [
       ];
 
       const { projects } = await paginate(
-        async () => (await getProjectsService()).list(queries),
+        async (args) => (await getProjectsService()).list(args.queries as string[]),
         { parseOutput: false },
         100,
         "projects",
@@ -342,7 +346,8 @@ export const questionsPullFunctions: Question[] = [
     validate: (value: any) => validateRequired("function", value),
     choices: async () => {
       const { functions } = await paginate(
-        async () => (await getFunctionsService()).list(),
+        async (args) =>
+          (await getFunctionsService()).list(args.queries as string[]),
         { parseOutput: false },
         100,
         "functions",
@@ -385,7 +390,8 @@ export const questionsPullSites: Question[] = [
     validate: (value: any) => validateRequired("site", value),
     choices: async () => {
       const { sites } = await paginate(
-        async () => (await getSitesService()).list(),
+        async (args) =>
+          (await getSitesService()).list(args.queries as string[]),
         { parseOutput: false },
         100,
         "sites",

package/lib/sdks.ts

@@ -88,3 +88,4 @@ export const sdkForProject = async (): Promise<Client> => {
     `Session not found. Please run \`${EXECUTABLE_NAME} login\` to create a session.`,
   );
 };
+

package/lib/types.ts

@@ -52,6 +52,7 @@ export interface CommandDescription {
 export interface CliConfig {
   verbose: boolean;
   json: boolean;
+  raw: boolean;
   force: boolean;
   all: boolean;
   ids: string[];

package/package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
-  "version": "16.0.0",
+  "version": "17.1.0",
   "license": "BSD-3-Clause",
   "main": "dist/index.cjs",
   "module": "dist/index.js",

package/scoop/appwrite.config.json

@@ -1,12 +1,12 @@
 {
 	"$schema": "https://raw.githubusercontent.com/ScoopInstaller/Scoop/master/schema.json",
-	"version": "16.0.0",
+	"version": "17.1.0",
 	"description": "The Appwrite CLI is a command-line application that allows you to interact with Appwrite and perform server-side tasks using your terminal.",
 	"homepage": "https://github.com/appwrite/sdk-for-cli",
 	"license": "BSD-3-Clause",
 	"architecture": {
 		"64bit": {
-			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/16.0.0/appwrite-cli-win-x64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/17.1.0/appwrite-cli-win-x64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-x64.exe",
@@ -15,7 +15,7 @@
 			]
 		},
 		"arm64": {
-			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/16.0.0/appwrite-cli-win-arm64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/17.1.0/appwrite-cli-win-arm64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-arm64.exe",