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

package/lib/commands/services/migrations.ts

@@ -0,0 +1,421 @@
+import { Command } from "commander";
+import { sdkForProject } from "../../sdks.js";
+import {
+  actionRunner,
+  commandDescriptions,
+  parseBool,
+  parseInteger,
+} from "../../parser.js";
+import { Migrations } from "@appwrite.io/console";
+
+let migrationsClient: Migrations | null = null;
+
+const getMigrationsClient = async (): Promise<Migrations> => {
+  if (!migrationsClient) {
+    const sdkClient = await sdkForProject();
+    migrationsClient = new Migrations(sdkClient);
+  }
+  return migrationsClient;
+};
+
+export const migrations = new Command("migrations")
+  .description(commandDescriptions["migrations"] ?? "")
+  .configureHelp({
+    helpWidth: process.stdout.columns || 80,
+  });
+
+migrations
+  .command(`list`)
+  .description(
+    `List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.`,
+  )
+  .option(
+    `--queries [queries...]`,
+    `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors`,
+  )
+  .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(
+      async ({ queries, search, total }) =>
+        await (await getMigrationsClient()).list(queries, search, total),
+    ),
+  );
+
+migrations
+  .command(`create-appwrite-migration`)
+  .description(
+    `Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project. `,
+  )
+  .requiredOption(`--resources [resources...]`, `List of resources to migrate`)
+  .requiredOption(`--endpoint <endpoint>`, `Source Appwrite endpoint`)
+  .requiredOption(`--project-id <project-id>`, `Source Project ID`)
+  .requiredOption(`--api-key <api-key>`, `Source API Key`)
+  .action(
+    actionRunner(
+      async ({ resources, endpoint, projectId, apiKey }) =>
+        await (
+          await getMigrationsClient()
+        ).createAppwriteMigration(resources, endpoint, projectId, apiKey),
+    ),
+  );
+
+migrations
+  .command(`get-appwrite-report`)
+  .description(
+    `Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.`,
+  )
+  .requiredOption(`--resources [resources...]`, `List of resources to migrate`)
+  .requiredOption(`--endpoint <endpoint>`, `Source's Appwrite Endpoint`)
+  .requiredOption(`--project-id <project-id>`, `Source's Project ID`)
+  .requiredOption(`--key <key>`, `Source's API Key`)
+  .action(
+    actionRunner(
+      async ({ resources, endpoint, projectID, key }) =>
+        await (
+          await getMigrationsClient()
+        ).getAppwriteReport(resources, endpoint, projectID, key),
+    ),
+  );
+
+migrations
+  .command(`create-csvexport`)
+  .description(
+    `Export documents to a CSV file from your Appwrite database. This endpoint allows you to export documents to a CSV file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.`,
+  )
+  .requiredOption(
+    `--resource-id <resource-id>`,
+    `Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.`,
+  )
+  .requiredOption(
+    `--filename <filename>`,
+    `The name of the file to be created for the export, excluding the .csv extension.`,
+  )
+  .option(
+    `--columns [columns...]`,
+    `List of attributes to export. If empty, all attributes will be exported. You can use the \`*\` wildcard to export all attributes from the collection.`,
+  )
+  .option(
+    `--queries [queries...]`,
+    `Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.`,
+  )
+  .option(
+    `--delimiter <delimiter>`,
+    `The character that separates each column value. Default is comma.`,
+  )
+  .option(
+    `--enclosure <enclosure>`,
+    `The character that encloses each column value. Default is double quotes.`,
+  )
+  .option(
+    `--escape <escape>`,
+    `The escape character for the enclosure character. Default is double quotes.`,
+  )
+  .option(
+    `--header [value]`,
+    `Whether to include the header row with column names. Default is true.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
+  .option(
+    `--notify [value]`,
+    `Set to true to receive an email when the export is complete. Default is true.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
+  .action(
+    actionRunner(
+      async ({
+        resourceId,
+        filename,
+        columns,
+        queries,
+        delimiter,
+        enclosure,
+        escape,
+        header,
+        notify,
+      }) =>
+        await (
+          await getMigrationsClient()
+        ).createCSVExport(
+          resourceId,
+          filename,
+          columns,
+          queries,
+          delimiter,
+          enclosure,
+          escape,
+          header,
+          notify,
+        ),
+    ),
+  );
+
+migrations
+  .command(`create-csvimport`)
+  .description(
+    `Import documents from a CSV file into your Appwrite database. This endpoint allows you to import documents from a CSV file uploaded to Appwrite Storage bucket.`,
+  )
+  .requiredOption(
+    `--bucket-id <bucket-id>`,
+    `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`,
+  )
+  .requiredOption(`--file-id <file-id>`, `File ID.`)
+  .requiredOption(
+    `--resource-id <resource-id>`,
+    `Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.`,
+  )
+  .option(
+    `--internal-file [value]`,
+    `Is the file stored in an internal bucket?`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
+  .action(
+    actionRunner(
+      async ({ bucketId, fileId, resourceId, internalFile }) =>
+        await (
+          await getMigrationsClient()
+        ).createCSVImport(bucketId, fileId, resourceId, internalFile),
+    ),
+  );
+
+migrations
+  .command(`create-firebase-migration`)
+  .description(
+    `Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project. `,
+  )
+  .requiredOption(`--resources [resources...]`, `List of resources to migrate`)
+  .requiredOption(
+    `--service-account <service-account>`,
+    `JSON of the Firebase service account credentials`,
+  )
+  .action(
+    actionRunner(
+      async ({ resources, serviceAccount }) =>
+        await (
+          await getMigrationsClient()
+        ).createFirebaseMigration(resources, serviceAccount),
+    ),
+  );
+
+migrations
+  .command(`get-firebase-report`)
+  .description(
+    `Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.`,
+  )
+  .requiredOption(`--resources [resources...]`, `List of resources to migrate`)
+  .requiredOption(
+    `--service-account <service-account>`,
+    `JSON of the Firebase service account credentials`,
+  )
+  .action(
+    actionRunner(
+      async ({ resources, serviceAccount }) =>
+        await (
+          await getMigrationsClient()
+        ).getFirebaseReport(resources, serviceAccount),
+    ),
+  );
+
+migrations
+  .command(`create-nhost-migration`)
+  .description(
+    `Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project. `,
+  )
+  .requiredOption(`--resources [resources...]`, `List of resources to migrate`)
+  .requiredOption(`--subdomain <subdomain>`, `Source's Subdomain`)
+  .requiredOption(`--region <region>`, `Source's Region`)
+  .requiredOption(`--admin-secret <admin-secret>`, `Source's Admin Secret`)
+  .requiredOption(`--database <database>`, `Source's Database Name`)
+  .requiredOption(`--username <username>`, `Source's Database Username`)
+  .requiredOption(`--password <password>`, `Source's Database Password`)
+  .option(`--port <port>`, `Source's Database Port`, parseInteger)
+  .action(
+    actionRunner(
+      async ({
+        resources,
+        subdomain,
+        region,
+        adminSecret,
+        database,
+        username,
+        password,
+        port,
+      }) =>
+        await (
+          await getMigrationsClient()
+        ).createNHostMigration(
+          resources,
+          subdomain,
+          region,
+          adminSecret,
+          database,
+          username,
+          password,
+          port,
+        ),
+    ),
+  );
+
+migrations
+  .command(`get-nhost-report`)
+  .description(
+    `Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated. `,
+  )
+  .requiredOption(`--resources [resources...]`, `List of resources to migrate.`)
+  .requiredOption(`--subdomain <subdomain>`, `Source's Subdomain.`)
+  .requiredOption(`--region <region>`, `Source's Region.`)
+  .requiredOption(`--admin-secret <admin-secret>`, `Source's Admin Secret.`)
+  .requiredOption(`--database <database>`, `Source's Database Name.`)
+  .requiredOption(`--username <username>`, `Source's Database Username.`)
+  .requiredOption(`--password <password>`, `Source's Database Password.`)
+  .option(`--port <port>`, `Source's Database Port.`, parseInteger)
+  .action(
+    actionRunner(
+      async ({
+        resources,
+        subdomain,
+        region,
+        adminSecret,
+        database,
+        username,
+        password,
+        port,
+      }) =>
+        await (
+          await getMigrationsClient()
+        ).getNHostReport(
+          resources,
+          subdomain,
+          region,
+          adminSecret,
+          database,
+          username,
+          password,
+          port,
+        ),
+    ),
+  );
+
+migrations
+  .command(`create-supabase-migration`)
+  .description(
+    `Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project. `,
+  )
+  .requiredOption(`--resources [resources...]`, `List of resources to migrate`)
+  .requiredOption(`--endpoint <endpoint>`, `Source's Supabase Endpoint`)
+  .requiredOption(`--api-key <api-key>`, `Source's API Key`)
+  .requiredOption(`--database-host <database-host>`, `Source's Database Host`)
+  .requiredOption(`--username <username>`, `Source's Database Username`)
+  .requiredOption(`--password <password>`, `Source's Database Password`)
+  .option(`--port <port>`, `Source's Database Port`, parseInteger)
+  .action(
+    actionRunner(
+      async ({
+        resources,
+        endpoint,
+        apiKey,
+        databaseHost,
+        username,
+        password,
+        port,
+      }) =>
+        await (
+          await getMigrationsClient()
+        ).createSupabaseMigration(
+          resources,
+          endpoint,
+          apiKey,
+          databaseHost,
+          username,
+          password,
+          port,
+        ),
+    ),
+  );
+
+migrations
+  .command(`get-supabase-report`)
+  .description(
+    `Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated. `,
+  )
+  .requiredOption(`--resources [resources...]`, `List of resources to migrate`)
+  .requiredOption(`--endpoint <endpoint>`, `Source's Supabase Endpoint.`)
+  .requiredOption(`--api-key <api-key>`, `Source's API Key.`)
+  .requiredOption(`--database-host <database-host>`, `Source's Database Host.`)
+  .requiredOption(`--username <username>`, `Source's Database Username.`)
+  .requiredOption(`--password <password>`, `Source's Database Password.`)
+  .option(`--port <port>`, `Source's Database Port.`, parseInteger)
+  .action(
+    actionRunner(
+      async ({
+        resources,
+        endpoint,
+        apiKey,
+        databaseHost,
+        username,
+        password,
+        port,
+      }) =>
+        await (
+          await getMigrationsClient()
+        ).getSupabaseReport(
+          resources,
+          endpoint,
+          apiKey,
+          databaseHost,
+          username,
+          password,
+          port,
+        ),
+    ),
+  );
+
+migrations
+  .command(`get`)
+  .description(
+    `Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process. `,
+  )
+  .requiredOption(`--migration-id <migration-id>`, `Migration unique ID.`)
+  .action(
+    actionRunner(
+      async ({ migrationId }) =>
+        await (await getMigrationsClient()).get(migrationId),
+    ),
+  );
+
+migrations
+  .command(`retry`)
+  .description(
+    `Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.`,
+  )
+  .requiredOption(`--migration-id <migration-id>`, `Migration unique ID.`)
+  .action(
+    actionRunner(
+      async ({ migrationId }) =>
+        await (await getMigrationsClient()).retry(migrationId),
+    ),
+  );
+
+migrations
+  .command(`delete`)
+  .description(
+    `Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project's migration history. `,
+  )
+  .requiredOption(`--migration-id <migration-id>`, `Migration ID.`)
+  .action(
+    actionRunner(
+      async ({ migrationId }) =>
+        await (await getMigrationsClient()).delete(migrationId),
+    ),
+  );

package/lib/commands/services/project.ts

@@ -0,0 +1,116 @@
+import { Command } from "commander";
+import { sdkForProject } from "../../sdks.js";
+import {
+  actionRunner,
+  commandDescriptions,
+  parseBool,
+  parseInteger,
+} from "../../parser.js";
+import { Project, ProjectUsageRange } from "@appwrite.io/console";
+
+let projectClient: Project | null = null;
+
+const getProjectClient = async (): Promise<Project> => {
+  if (!projectClient) {
+    const sdkClient = await sdkForProject();
+    projectClient = new Project(sdkClient);
+  }
+  return projectClient;
+};
+
+export const project = new Command("project")
+  .description(commandDescriptions["project"] ?? "")
+  .configureHelp({
+    helpWidth: process.stdout.columns || 80,
+  });
+
+project
+  .command(`get-usage`)
+  .description(
+    `Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.`,
+  )
+  .requiredOption(`--start-date <start-date>`, `Starting date for the usage`)
+  .requiredOption(`--end-date <end-date>`, `End date for the usage`)
+  .option(`--period <period>`, `Period used`)
+  .action(
+    actionRunner(
+      async ({ startDate, endDate, period }) =>
+        await (
+          await getProjectClient()
+        ).getUsage(startDate, endDate, period as ProjectUsageRange),
+    ),
+  );
+
+project
+  .command(`list-variables`)
+  .description(
+    `Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.`,
+  )
+  .action(
+    actionRunner(async () => await (await getProjectClient()).listVariables()),
+  );
+
+project
+  .command(`create-variable`)
+  .description(
+    `Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.`,
+  )
+  .requiredOption(`--key <key>`, `Variable key. Max length: 255 chars.`)
+  .requiredOption(`--value <value>`, `Variable value. Max length: 8192 chars.`)
+  .option(
+    `--secret [value]`,
+    `Secret variables can be updated or deleted, but only projects can read them during build and runtime.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
+  .action(
+    actionRunner(
+      async ({ key, value, secret }) =>
+        await (await getProjectClient()).createVariable(key, value, secret),
+    ),
+  );
+
+project
+  .command(`get-variable`)
+  .description(`Get a project variable by its unique ID.`)
+  .requiredOption(`--variable-id <variable-id>`, `Variable unique ID.`)
+  .action(
+    actionRunner(
+      async ({ variableId }) =>
+        await (await getProjectClient()).getVariable(variableId),
+    ),
+  );
+
+project
+  .command(`update-variable`)
+  .description(
+    `Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.`,
+  )
+  .requiredOption(`--variable-id <variable-id>`, `Variable unique ID.`)
+  .requiredOption(`--key <key>`, `Variable key. Max length: 255 chars.`)
+  .option(`--value <value>`, `Variable value. Max length: 8192 chars.`)
+  .option(
+    `--secret [value]`,
+    `Secret variables can be updated or deleted, but only projects can read them during build and runtime.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
+  .action(
+    actionRunner(
+      async ({ variableId, key, value, secret }) =>
+        await (
+          await getProjectClient()
+        ).updateVariable(variableId, key, value, secret),
+    ),
+  );
+
+project
+  .command(`delete-variable`)
+  .description(`Delete a project variable by its unique ID. `)
+  .requiredOption(`--variable-id <variable-id>`, `Variable unique ID.`)
+  .action(
+    actionRunner(
+      async ({ variableId }) =>
+        await (await getProjectClient()).deleteVariable(variableId),
+    ),
+  );