appwrite-utils-cli 0.10.66 → 0.10.67

package/README.md

@@ -72,6 +72,7 @@ Available options:
 - `--projectId`: Set the Appwrite project ID
 - `--apiKey`: Set the Appwrite API key
 - `--transfer`: Transfer data between databases or collections
+- `--transfer-users`: Transfer users between instances (will not overwrite)
 - `--fromDbId`: Set the source database ID for transfer
 - `--toDbId`: Set the destination database ID for transfer
 - `--fromCollectionId`: Set the source collection ID for transfer
@@ -147,6 +148,7 @@ This updated CLI ensures that developers have robust tools at their fingertips t
 
 ## Changelog
 
+- 0.10.67: Added `--transfer-users` boolean flag to also transfer users between projects
 - 0.10.66: Fixed `ignore` always being an empty array, if not set, so it properly ignores the defaults
 - 0.10.65: Fixed the stupid local functions not caring about the ignore string, and added `__pycache__` and `.venv` to default ignores
 - 0.10.64: Fixed `Deploy Function(s)` not ignoring things properly

package/dist/main.js

@@ -37,6 +37,10 @@ const argv = yargs(hideBin(process.argv))
     .option("wipeCollections", {
     type: "boolean",
     description: "Wipe collections, uses collectionIds option to get the collections to wipe",
+})
+    .option("transferUsers", {
+    type: "boolean",
+    description: "Transfer users between projects",
 })
     .option("generate", {
     type: "boolean",
@@ -171,6 +175,7 @@ async function main() {
             importData: parsedArgv.import,
             shouldWriteFile: parsedArgv.writeData,
             wipeCollections: parsedArgv.wipeCollections,
+            transferUsers: parsedArgv.transferUsers,
         };
         if (parsedArgv.updateFunctionSpec) {
             if (!parsedArgv.functionId || !parsedArgv.specification) {
@@ -309,7 +314,7 @@ async function main() {
                 }
             }
             // Validate that at least one transfer type is specified
-            if (!fromDb && !sourceBucket) {
+            if (!fromDb && !sourceBucket && !options.transferUsers) {
                 throw new Error("No source database or bucket specified for transfer");
             }
             const transferOptions = {
@@ -321,6 +326,7 @@ async function main() {
                 transferKey: parsedArgv.remoteApiKey,
                 sourceBucket: sourceBucket,
                 targetBucket: targetBucket,
+                transferUsers: options.transferUsers,
             };
             await controller.transferData(transferOptions);
         }

package/dist/migrations/transfer.d.ts

@@ -1,4 +1,4 @@
-import { Databases, Storage, type Models } from "node-appwrite";
+import { Databases, Storage, Users, type Models } from "node-appwrite";
 export interface TransferOptions {
     fromDb: Models.Database | undefined;
     targetDb: Models.Database | undefined;
@@ -9,6 +9,7 @@ export interface TransferOptions {
     transferKey?: string;
     sourceBucket?: Models.Bucket;
     targetBucket?: Models.Bucket;
+    transferUsers?: boolean;
 }
 export declare const transferStorageLocalToLocal: (storage: Storage, fromBucketId: string, toBucketId: string) => Promise<void>;
 export declare const transferStorageLocalToRemote: (localStorage: Storage, endpoint: string, projectId: string, apiKey: string, fromBucketId: string, toBucketId: string) => Promise<void>;
@@ -28,3 +29,7 @@ export declare const transferDocumentsBetweenDbsLocalToRemote: (localDb: Databas
  */
 export declare const transferDatabaseLocalToLocal: (localDb: Databases, fromDbId: string, targetDbId: string) => Promise<void>;
 export declare const transferDatabaseLocalToRemote: (localDb: Databases, endpoint: string, projectId: string, apiKey: string, fromDbId: string, toDbId: string) => Promise<void>;
+export declare const transferUsersLocalToRemote: (localUsers: Users, endpoint: string, projectId: string, apiKey: string, options?: {
+    limit?: number;
+    offset?: number;
+}) => Promise<void>;

package/dist/migrations/transfer.js

@@ -1,5 +1,5 @@
 import { tryAwaitWithRetry } from "appwrite-utils";
-import { Client, Databases, IndexType, Query, Storage, } from "node-appwrite";
+import { Client, Databases, IndexType, Query, Storage, Users, } from "node-appwrite";
 import { InputFile } from "node-appwrite/file";
 import { getAppwriteClient } from "../utils/helperFunctions.js";
 import { createOrUpdateAttribute, createUpdateCollectionAttributes, } from "../collections/attributes.js";
@@ -7,6 +7,7 @@ import { parseAttribute } from "appwrite-utils";
 import chalk from "chalk";
 import { fetchAllCollections } from "../collections/methods.js";
 import { createOrUpdateIndex, createOrUpdateIndexes, } from "../collections/indexes.js";
+import { getClient } from "src/utils/getClientFromConfig.js";
 export const transferStorageLocalToLocal = async (storage, fromBucketId, toBucketId) => {
     console.log(`Transferring files from ${fromBucketId} to ${toBucketId}`);
     let lastFileId;
@@ -377,3 +378,54 @@ export const transferDatabaseLocalToRemote = async (localDb, endpoint, projectId
         }
     }
 };
+export const transferUsersLocalToRemote = async (localUsers, endpoint, projectId, apiKey, options = {}) => {
+    console.log(chalk.blue("Starting user transfer to remote instance..."));
+    const client = getClient(endpoint, apiKey, projectId);
+    const remoteUsers = new Users(client);
+    let totalTransferred = 0;
+    let lastId;
+    while (true) {
+        const queries = [Query.limit(100)];
+        if (lastId) {
+            queries.push(Query.cursorAfter(lastId));
+        }
+        const usersList = await tryAwaitWithRetry(async () => localUsers.list(queries));
+        if (usersList.users.length === 0) {
+            break;
+        }
+        for (const user of usersList.users) {
+            try {
+                // Check if user already exists in remote
+                try {
+                    await tryAwaitWithRetry(async () => remoteUsers.get(user.$id));
+                    console.log(chalk.yellow(`User ${user.$id} already exists, skipping...`));
+                    continue;
+                }
+                catch (error) {
+                    // User doesn't exist, proceed with creation
+                }
+                await tryAwaitWithRetry(async () => remoteUsers.create(user.$id, user.email, user.phone, // phone - optional
+                user.password, // password - cannot transfer hashed passwords
+                user.name));
+                // Update user preferences and status
+                await tryAwaitWithRetry(async () => remoteUsers.updatePrefs(user.$id, user.prefs));
+                if (!user.emailVerification) {
+                    await tryAwaitWithRetry(async () => remoteUsers.updateEmailVerification(user.$id, false));
+                }
+                if (user.status === false) {
+                    await tryAwaitWithRetry(async () => remoteUsers.updateStatus(user.$id, false));
+                }
+                totalTransferred++;
+                console.log(chalk.green(`Transferred user ${user.$id}`));
+            }
+            catch (error) {
+                console.error(chalk.red(`Failed to transfer user ${user.$id}:`), error);
+            }
+        }
+        if (usersList.users.length < 100) {
+            break;
+        }
+        lastId = usersList.users[usersList.users.length - 1].$id;
+    }
+    console.log(chalk.green(`Successfully transferred ${totalTransferred} users`));
+};

package/dist/utilsController.d.ts

@@ -10,6 +10,7 @@ export interface SetupOptions {
     wipeCollections?: boolean;
     wipeDocumentStorage?: boolean;
     wipeUsers?: boolean;
+    transferUsers?: boolean;
     generateSchemas?: boolean;
     importData?: boolean;
     checkDuplicates?: boolean;

package/dist/utilsController.js

@@ -1,4 +1,4 @@
-import { Client, Databases, Query, Storage } from "node-appwrite";
+import { Client, Databases, Query, Storage, Users, } from "node-appwrite";
 import {} from "appwrite-utils";
 import { loadConfig, findAppwriteConfig, findFunctionsDir, } from "./utils/loadConfigs.js";
 import { UsersController } from "./migrations/users.js";
@@ -11,7 +11,7 @@ import { backupDatabase, ensureDatabaseConfigBucketsExist, initOrGetBackupStorag
 import path from "path";
 import { converterFunctions, validationRules, } from "appwrite-utils";
 import { afterImportActions } from "./migrations/afterImportActions.js";
-import { transferDatabaseLocalToLocal, transferDatabaseLocalToRemote, transferStorageLocalToLocal, transferStorageLocalToRemote, } from "./migrations/transfer.js";
+import { transferDatabaseLocalToLocal, transferDatabaseLocalToRemote, transferStorageLocalToLocal, transferStorageLocalToRemote, transferUsersLocalToRemote, } from "./migrations/transfer.js";
 import { getClient } from "./utils/getClientFromConfig.js";
 import { fetchAllDatabases } from "./migrations/databases.js";
 import { listFunctions, updateFunctionSpecifications, } from "./functions/methods.js";
@@ -321,6 +321,20 @@ export class UtilsController {
                 await transferDatabaseLocalToLocal(sourceClient, fromDb.$id, targetDb.$id);
             }
         }
+        if (options.transferUsers) {
+            if (!options.isRemote) {
+                console.log(chalk.yellow("User transfer is only supported for remote transfers. Skipping..."));
+            }
+            else if (!this.appwriteServer) {
+                throw new Error("Appwrite server not initialized");
+            }
+            else {
+                console.log(chalk.blue("Starting user transfer..."));
+                const localUsers = new Users(this.appwriteServer);
+                await transferUsersLocalToRemote(localUsers, options.transferEndpoint, options.transferProject, options.transferKey);
+                console.log(chalk.green("User transfer completed"));
+            }
+        }
         // Handle storage transfer
         if (this.storage && (options.sourceBucket || options.fromDb)) {
             const sourceBucketId = options.sourceBucket?.$id ||

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "appwrite-utils-cli",
   "description": "Appwrite Utility Functions to help with database management, data conversion, data import, migrations, and much more. Meant to be used as a CLI tool, I do not recommend installing this in frontend environments.",
-  "version": "0.10.66",
+  "version": "0.10.67",
   "main": "src/main.ts",
   "type": "module",
   "repository": {

package/src/main.ts

@@ -31,6 +31,7 @@ interface CliOptions {
   projectId?: string;
   apiKey?: string;
   transfer?: boolean;
+  transferUsers?: boolean;
   fromDbId?: string;
   toDbId?: string;
   fromCollectionId?: string;
@@ -77,6 +78,10 @@ const argv = yargs(hideBin(process.argv))
     description:
       "Wipe collections, uses collectionIds option to get the collections to wipe",
   })
+  .option("transferUsers", {
+    type: "boolean",
+    description: "Transfer users between projects",
+  })
   .option("generate", {
     type: "boolean",
     description: "Generate TypeScript schemas from database schemas",
@@ -216,6 +221,7 @@ async function main() {
       importData: parsedArgv.import,
       shouldWriteFile: parsedArgv.writeData,
       wipeCollections: parsedArgv.wipeCollections,
+      transferUsers: parsedArgv.transferUsers,
     };
 
     if (parsedArgv.updateFunctionSpec) {
@@ -415,7 +421,7 @@ async function main() {
       }
 
       // Validate that at least one transfer type is specified
-      if (!fromDb && !sourceBucket) {
+      if (!fromDb && !sourceBucket && !options.transferUsers) {
         throw new Error("No source database or bucket specified for transfer");
       }
 
@@ -428,6 +434,7 @@ async function main() {
         transferKey: parsedArgv.remoteApiKey,
         sourceBucket: sourceBucket,
         targetBucket: targetBucket,
+        transferUsers: options.transferUsers,
       };
 
       await controller.transferData(transferOptions);

package/src/migrations/transfer.ts

@@ -5,6 +5,7 @@ import {
   IndexType,
   Query,
   Storage,
+  Users,
   type Models,
 } from "node-appwrite";
 import { InputFile } from "node-appwrite/file";
@@ -20,6 +21,7 @@ import {
   createOrUpdateIndex,
   createOrUpdateIndexes,
 } from "../collections/indexes.js";
+import { getClient } from "src/utils/getClientFromConfig.js";
 
 export interface TransferOptions {
   fromDb: Models.Database | undefined;
@@ -31,6 +33,7 @@ export interface TransferOptions {
   transferKey?: string;
   sourceBucket?: Models.Bucket;
   targetBucket?: Models.Bucket;
+  transferUsers?: boolean;
 }
 
 export const transferStorageLocalToLocal = async (
@@ -766,3 +769,93 @@ export const transferDatabaseLocalToRemote = async (
     }
   }
 };
+
+export const transferUsersLocalToRemote = async (
+  localUsers: Users,
+  endpoint: string,
+  projectId: string,
+  apiKey: string,
+  options: {
+    limit?: number;
+    offset?: number;
+  } = {}
+) => {
+  console.log(chalk.blue("Starting user transfer to remote instance..."));
+
+  const client = getClient(endpoint, apiKey, projectId);
+  const remoteUsers = new Users(client);
+
+  let totalTransferred = 0;
+  let lastId: string | undefined;
+
+  while (true) {
+    const queries = [Query.limit(100)];
+    if (lastId) {
+      queries.push(Query.cursorAfter(lastId));
+    }
+
+    const usersList = await tryAwaitWithRetry(async () =>
+      localUsers.list(queries)
+    );
+
+    if (usersList.users.length === 0) {
+      break;
+    }
+
+    for (const user of usersList.users) {
+      try {
+        // Check if user already exists in remote
+        try {
+          await tryAwaitWithRetry(async () => remoteUsers.get(user.$id));
+          console.log(
+            chalk.yellow(`User ${user.$id} already exists, skipping...`)
+          );
+          continue;
+        } catch (error: any) {
+          // User doesn't exist, proceed with creation
+        }
+
+        await tryAwaitWithRetry(async () =>
+          remoteUsers.create(
+            user.$id,
+            user.email,
+            user.phone, // phone - optional
+            user.password, // password - cannot transfer hashed passwords
+            user.name
+          )
+        );
+
+        // Update user preferences and status
+        await tryAwaitWithRetry(async () =>
+          remoteUsers.updatePrefs(user.$id, user.prefs)
+        );
+
+        if (!user.emailVerification) {
+          await tryAwaitWithRetry(async () =>
+            remoteUsers.updateEmailVerification(user.$id, false)
+          );
+        }
+
+        if (user.status === false) {
+          await tryAwaitWithRetry(async () =>
+            remoteUsers.updateStatus(user.$id, false)
+          );
+        }
+
+        totalTransferred++;
+        console.log(chalk.green(`Transferred user ${user.$id}`));
+      } catch (error) {
+        console.error(chalk.red(`Failed to transfer user ${user.$id}:`), error);
+      }
+    }
+
+    if (usersList.users.length < 100) {
+      break;
+    }
+    lastId = usersList.users[usersList.users.length - 1].$id;
+  }
+
+  console.log(
+    chalk.green(`Successfully transferred ${totalTransferred} users`)
+  );
+};

package/src/utilsController.ts

@@ -1,4 +1,11 @@
-import { Client, Databases, Query, Storage, type Models } from "node-appwrite";
+import {
+  Client,
+  Databases,
+  Query,
+  Storage,
+  Users,
+  type Models,
+} from "node-appwrite";
 import {
   type AppwriteConfig,
   type AppwriteFunction,
@@ -46,6 +53,7 @@ import {
   transferDatabaseLocalToRemote,
   transferStorageLocalToLocal,
   transferStorageLocalToRemote,
+  transferUsersLocalToRemote,
   type TransferOptions,
 } from "./migrations/transfer.js";
 import { getClient } from "./utils/getClientFromConfig.js";
@@ -66,6 +74,7 @@ export interface SetupOptions {
   wipeCollections?: boolean;
   wipeDocumentStorage?: boolean;
   wipeUsers?: boolean;
+  transferUsers?: boolean;
   generateSchemas?: boolean;
   importData?: boolean;
   checkDuplicates?: boolean;
@@ -486,6 +495,28 @@ export class UtilsController {
       }
     }
 
+    if (options.transferUsers) {
+      if (!options.isRemote) {
+        console.log(
+          chalk.yellow(
+            "User transfer is only supported for remote transfers. Skipping..."
+          )
+        );
+      } else if (!this.appwriteServer) {
+        throw new Error("Appwrite server not initialized");
+      } else {
+        console.log(chalk.blue("Starting user transfer..."));
+        const localUsers = new Users(this.appwriteServer);
+        await transferUsersLocalToRemote(
+          localUsers,
+          options.transferEndpoint!,
+          options.transferProject!,
+          options.transferKey!
+        );
+        console.log(chalk.green("User transfer completed"));
+      }
+    }
+
     // Handle storage transfer
     if (this.storage && (options.sourceBucket || options.fromDb)) {
       const sourceBucketId =