appwrite-cli 6.1.0 → 6.2.2

package/lib/commands/migrations.js

@@ -41,7 +41,7 @@ const migrations = new Command("migrations").description(commandDescriptions['mi
 
 /**
  * @typedef {Object} MigrationsListRequestParams
- * @property {string[]} 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, resources, statusCounters, resourceData, errors
+ * @property {string[]} 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
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
@@ -209,105 +209,6 @@ const migrationsCreateFirebaseMigration = async ({resources,serviceAccount,parse
 
 }
 
-/**
- * @typedef {Object} MigrationsDeleteFirebaseAuthRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {MigrationsDeleteFirebaseAuthRequestParams} params
- */
-const migrationsDeleteFirebaseAuth = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/migrations/firebase/deauthorize';
-    let payload = {};
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-
-/**
- * @typedef {Object} MigrationsCreateFirebaseOAuthMigrationRequestParams
- * @property {string[]} resources List of resources to migrate
- * @property {string} projectId Project ID of the Firebase Project
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {MigrationsCreateFirebaseOAuthMigrationRequestParams} params
- */
-const migrationsCreateFirebaseOAuthMigration = async ({resources,projectId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/migrations/firebase/oauth';
-    let payload = {};
-    resources = resources === true ? [] : resources;
-    if (typeof resources !== 'undefined') {
-        payload['resources'] = resources;
-    }
-    if (typeof projectId !== 'undefined') {
-        payload['projectId'] = projectId;
-    }
-
-    let response = undefined;
-
-    response = await client.call('post', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-
-/**
- * @typedef {Object} MigrationsListFirebaseProjectsRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {MigrationsListFirebaseProjectsRequestParams} params
- */
-const migrationsListFirebaseProjects = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/migrations/firebase/projects';
-    let payload = {};
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-
 /**
  * @typedef {Object} MigrationsGetFirebaseReportRequestParams
  * @property {string[]} resources List of resources to migrate
@@ -346,44 +247,6 @@ const migrationsGetFirebaseReport = async ({resources,serviceAccount,parseOutput
 
 }
 
-/**
- * @typedef {Object} MigrationsGetFirebaseReportOAuthRequestParams
- * @property {string[]} resources List of resources to migrate
- * @property {string} projectId Project ID
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {MigrationsGetFirebaseReportOAuthRequestParams} params
- */
-const migrationsGetFirebaseReportOAuth = async ({resources,projectId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/migrations/firebase/report/oauth';
-    let payload = {};
-    if (typeof resources !== 'undefined') {
-        payload['resources'] = resources;
-    }
-    if (typeof projectId !== 'undefined') {
-        payload['projectId'] = projectId;
-    }
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-
 /**
  * @typedef {Object} MigrationsCreateNHostMigrationRequestParams
  * @property {string[]} resources List of resources to migrate
@@ -721,14 +584,14 @@ const migrationsDelete = async ({migrationId,parseOutput = true, overrideForCli
 
 migrations
     .command(`list`)
-    .description(``)
-    .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, resources, statusCounters, resourceData, errors`)
+    .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.`)
     .action(actionRunner(migrationsList))
 
 migrations
     .command(`create-appwrite-migration`)
-    .description(``)
+    .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's Appwrite Endpoint`)
     .requiredOption(`--project-id <project-id>`, `Source's Project ID`)
@@ -737,7 +600,7 @@ migrations
 
 migrations
     .command(`get-appwrite-report`)
-    .description(``)
+    .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`)
@@ -746,45 +609,21 @@ migrations
 
 migrations
     .command(`create-firebase-migration`)
-    .description(``)
+    .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(migrationsCreateFirebaseMigration))
 
-migrations
-    .command(`delete-firebase-auth`)
-    .description(``)
-    .action(actionRunner(migrationsDeleteFirebaseAuth))
-
-migrations
-    .command(`create-firebase-o-auth-migration`)
-    .description(``)
-    .requiredOption(`--resources [resources...]`, `List of resources to migrate`)
-    .requiredOption(`--project-id <project-id>`, `Project ID of the Firebase Project`)
-    .action(actionRunner(migrationsCreateFirebaseOAuthMigration))
-
-migrations
-    .command(`list-firebase-projects`)
-    .description(``)
-    .action(actionRunner(migrationsListFirebaseProjects))
-
 migrations
     .command(`get-firebase-report`)
-    .description(``)
+    .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(migrationsGetFirebaseReport))
 
-migrations
-    .command(`get-firebase-report-o-auth`)
-    .description(``)
-    .requiredOption(`--resources [resources...]`, `List of resources to migrate`)
-    .requiredOption(`--project-id <project-id>`, `Project ID`)
-    .action(actionRunner(migrationsGetFirebaseReportOAuth))
-
 migrations
     .command(`create-n-host-migration`)
-    .description(``)
+    .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`)
@@ -797,7 +636,7 @@ migrations
 
 migrations
     .command(`get-n-host-report`)
-    .description(``)
+    .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.`)
@@ -810,7 +649,7 @@ migrations
 
 migrations
     .command(`create-supabase-migration`)
-    .description(``)
+    .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`)
@@ -822,7 +661,7 @@ migrations
 
 migrations
     .command(`get-supabase-report`)
-    .description(``)
+    .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.`)
@@ -834,19 +673,19 @@ migrations
 
 migrations
     .command(`get`)
-    .description(``)
+    .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(migrationsGet))
 
 migrations
     .command(`retry`)
-    .description(``)
+    .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(migrationsRetry))
 
 migrations
     .command(`delete`)
-    .description(``)
+    .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(migrationsDelete))
 
@@ -856,11 +695,7 @@ module.exports = {
     migrationsCreateAppwriteMigration,
     migrationsGetAppwriteReport,
     migrationsCreateFirebaseMigration,
-    migrationsDeleteFirebaseAuth,
-    migrationsCreateFirebaseOAuthMigration,
-    migrationsListFirebaseProjects,
     migrationsGetFirebaseReport,
-    migrationsGetFirebaseReportOAuth,
     migrationsCreateNHostMigration,
     migrationsGetNHostReport,
     migrationsCreateSupabaseMigration,

package/lib/commands/organizations.js

@@ -0,0 +1,48 @@
+const { sdkForProject } = require('../sdks')
+const { parse } = require('../parser')
+const { showConsoleLink } = require('../utils.js');
+
+/**
+ * @typedef {Object} OrganizationsListRequestParams
+ * @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, billingPlan
+ * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {OrganizationsListRequestParams} params
+ */
+const organizationsList = async ({queries, search, parseOutput = true, sdk = undefined, console}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/organizations';
+    let payload = {};
+    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) {
+        if(console) {
+            showConsoleLink('organizations', 'list');
+         } else {
+            parse(response)
+        }
+    }
+
+    return response;
+
+}
+
+module.exports = {
+    organizationsList
+}

package/lib/commands/project.js

@@ -252,7 +252,7 @@ const projectDeleteVariable = async ({variableId,parseOutput = true, overrideFor
 
 project
     .command(`get-usage`)
-    .description(``)
+    .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`)