appwrite-cli 4.2.0 → 4.2.2

package/lib/commands/migrations.js

@@ -9,93 +9,134 @@ 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 migrations = new Command("migrations").description(commandDescriptions['migrations']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
-
+})
+
+/**
+ * @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} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsListRequestParams} params
+ */
 const migrationsList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} queries */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations';
     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} MigrationsCreateAppwriteMigrationRequestParams
+ * @property {string[]} resources List of resources to migrate
+ * @property {string} endpoint Source's Appwrite Endpoint
+ * @property {string} projectId Source's Project ID
+ * @property {string} apiKey Source's API Key
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsCreateAppwriteMigrationRequestParams} params
+ */
 const migrationsCreateAppwriteMigration = async ({ resources, endpoint, projectId, apiKey, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} endpoint */
-    /* @param {string} projectId */
-    /* @param {string} apiKey */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/appwrite';
     let payload = {};
-    
-    /** Body Params */
     resources = resources === true ? [] : resources;
-
     if (typeof resources !== 'undefined') {
         payload['resources'] = resources;
     }
-
-
     if (typeof endpoint !== 'undefined') {
         payload['endpoint'] = endpoint;
     }
-
-
     if (typeof projectId !== 'undefined') {
         payload['projectId'] = projectId;
     }
-
-
     if (typeof apiKey !== 'undefined') {
         payload['apiKey'] = apiKey;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} MigrationsGetAppwriteReportRequestParams
+ * @property {string[]} resources List of resources to migrate
+ * @property {string} endpoint Source's Appwrite Endpoint
+ * @property {string} projectID Source's Project ID
+ * @property {string} key Source's API Key
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsGetAppwriteReportRequestParams} params
+ */
 const migrationsGetAppwriteReport = async ({ resources, endpoint, projectID, key, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} endpoint */
-    /* @param {string} projectID */
-    /* @param {string} key */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/appwrite/report';
     let payload = {};
-
-    /** Query Params */
     if (typeof resources !== 'undefined') {
         payload['resources'] = resources;
     }
@@ -108,253 +149,305 @@ const migrationsGetAppwriteReport = async ({ resources, endpoint, projectID, key
     if (typeof key !== 'undefined') {
         payload['key'] = key;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} MigrationsCreateFirebaseMigrationRequestParams
+ * @property {string[]} resources List of resources to migrate
+ * @property {string} serviceAccount JSON of the Firebase service account credentials
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsCreateFirebaseMigrationRequestParams} params
+ */
 const migrationsCreateFirebaseMigration = async ({ resources, serviceAccount, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} serviceAccount */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/firebase';
     let payload = {};
-    
-    /** Body Params */
     resources = resources === true ? [] : resources;
-
     if (typeof resources !== 'undefined') {
         payload['resources'] = resources;
     }
-
-
     if (typeof serviceAccount !== 'undefined') {
         payload['serviceAccount'] = serviceAccount;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const migrationsDeleteFirebaseAuth = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} MigrationsDeleteFirebaseAuthRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {MigrationsDeleteFirebaseAuthRequestParams} params
+ */
+const migrationsDeleteFirebaseAuth = async ({ parseOutput = true, 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)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} MigrationsCreateFirebaseOAuthMigrationRequestParams
+ * @property {string[]} resources List of resources to migrate
+ * @property {string} projectId Project ID of the Firebase Project
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsCreateFirebaseOAuthMigrationRequestParams} params
+ */
 const migrationsCreateFirebaseOAuthMigration = async ({ resources, projectId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} projectId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/firebase/oauth';
     let payload = {};
-    
-    /** Body Params */
     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)
         success()
     }
+    
     return response;
 }
 
-const migrationsListFirebaseProjects = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} MigrationsListFirebaseProjectsRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {MigrationsListFirebaseProjectsRequestParams} params
+ */
+const migrationsListFirebaseProjects = async ({ parseOutput = true, 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)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} MigrationsGetFirebaseReportRequestParams
+ * @property {string[]} resources List of resources to migrate
+ * @property {string} serviceAccount JSON of the Firebase service account credentials
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsGetFirebaseReportRequestParams} params
+ */
 const migrationsGetFirebaseReport = async ({ resources, serviceAccount, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} serviceAccount */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/firebase/report';
     let payload = {};
-
-    /** Query Params */
     if (typeof resources !== 'undefined') {
         payload['resources'] = resources;
     }
     if (typeof serviceAccount !== 'undefined') {
         payload['serviceAccount'] = serviceAccount;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} MigrationsGetFirebaseReportOAuthRequestParams
+ * @property {string[]} resources List of resources to migrate
+ * @property {string} projectId Project ID
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsGetFirebaseReportOAuthRequestParams} params
+ */
 const migrationsGetFirebaseReportOAuth = async ({ resources, projectId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} projectId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/firebase/report/oauth';
     let payload = {};
-
-    /** Query Params */
     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)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} MigrationsCreateNHostMigrationRequestParams
+ * @property {string[]} resources List of resources to migrate
+ * @property {string} subdomain Source's Subdomain
+ * @property {string} region Source's Region
+ * @property {string} adminSecret Source's Admin Secret
+ * @property {string} database Source's Database Name
+ * @property {string} username Source's Database Username
+ * @property {string} password Source's Database Password
+ * @property {number} port Source's Database Port
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsCreateNHostMigrationRequestParams} params
+ */
 const migrationsCreateNHostMigration = async ({ resources, subdomain, region, adminSecret, database, username, password, port, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} subdomain */
-    /* @param {string} region */
-    /* @param {string} adminSecret */
-    /* @param {string} database */
-    /* @param {string} username */
-    /* @param {string} password */
-    /* @param {number} port */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/nhost';
     let payload = {};
-    
-    /** Body Params */
     resources = resources === true ? [] : resources;
-
     if (typeof resources !== 'undefined') {
         payload['resources'] = resources;
     }
-
-
     if (typeof subdomain !== 'undefined') {
         payload['subdomain'] = subdomain;
     }
-
-
     if (typeof region !== 'undefined') {
         payload['region'] = region;
     }
-
-
     if (typeof adminSecret !== 'undefined') {
         payload['adminSecret'] = adminSecret;
     }
-
-
     if (typeof database !== 'undefined') {
         payload['database'] = database;
     }
-
-
     if (typeof username !== 'undefined') {
         payload['username'] = username;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof port !== 'undefined') {
         payload['port'] = port;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} MigrationsGetNHostReportRequestParams
+ * @property {string[]} resources List of resources to migrate.
+ * @property {string} subdomain Source's Subdomain.
+ * @property {string} region Source's Region.
+ * @property {string} adminSecret Source's Admin Secret.
+ * @property {string} database Source's Database Name.
+ * @property {string} username Source's Database Username.
+ * @property {string} password Source's Database Password.
+ * @property {number} port Source's Database Port.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsGetNHostReportRequestParams} params
+ */
 const migrationsGetNHostReport = async ({ resources, subdomain, region, adminSecret, database, username, password, port, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} subdomain */
-    /* @param {string} region */
-    /* @param {string} adminSecret */
-    /* @param {string} database */
-    /* @param {string} username */
-    /* @param {string} password */
-    /* @param {number} port */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/nhost/report';
     let payload = {};
-
-    /** Query Params */
     if (typeof resources !== 'undefined') {
         payload['resources'] = resources;
     }
@@ -379,94 +472,98 @@ const migrationsGetNHostReport = async ({ resources, subdomain, region, adminSec
     if (typeof port !== 'undefined') {
         payload['port'] = port;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} MigrationsCreateSupabaseMigrationRequestParams
+ * @property {string[]} resources List of resources to migrate
+ * @property {string} endpoint Source's Supabase Endpoint
+ * @property {string} apiKey Source's API Key
+ * @property {string} databaseHost Source's Database Host
+ * @property {string} username Source's Database Username
+ * @property {string} password Source's Database Password
+ * @property {number} port Source's Database Port
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsCreateSupabaseMigrationRequestParams} params
+ */
 const migrationsCreateSupabaseMigration = async ({ resources, endpoint, apiKey, databaseHost, username, password, port, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} endpoint */
-    /* @param {string} apiKey */
-    /* @param {string} databaseHost */
-    /* @param {string} username */
-    /* @param {string} password */
-    /* @param {number} port */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/supabase';
     let payload = {};
-    
-    /** Body Params */
     resources = resources === true ? [] : resources;
-
     if (typeof resources !== 'undefined') {
         payload['resources'] = resources;
     }
-
-
     if (typeof endpoint !== 'undefined') {
         payload['endpoint'] = endpoint;
     }
-
-
     if (typeof apiKey !== 'undefined') {
         payload['apiKey'] = apiKey;
     }
-
-
     if (typeof databaseHost !== 'undefined') {
         payload['databaseHost'] = databaseHost;
     }
-
-
     if (typeof username !== 'undefined') {
         payload['username'] = username;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof port !== 'undefined') {
         payload['port'] = port;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} MigrationsGetSupabaseReportRequestParams
+ * @property {string[]} resources List of resources to migrate
+ * @property {string} endpoint Source's Supabase Endpoint.
+ * @property {string} apiKey Source's API Key.
+ * @property {string} databaseHost Source's Database Host.
+ * @property {string} username Source's Database Username.
+ * @property {string} password Source's Database Password.
+ * @property {number} port Source's Database Port.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {MigrationsGetSupabaseReportRequestParams} params
+ */
 const migrationsGetSupabaseReport = async ({ resources, endpoint, apiKey, databaseHost, username, password, port, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} resources */
-    /* @param {string} endpoint */
-    /* @param {string} apiKey */
-    /* @param {string} databaseHost */
-    /* @param {string} username */
-    /* @param {string} password */
-    /* @param {number} port */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/supabase/report';
     let payload = {};
-
-    /** Query Params */
     if (typeof resources !== 'undefined') {
         payload['resources'] = resources;
     }
@@ -488,73 +585,108 @@ const migrationsGetSupabaseReport = async ({ resources, endpoint, apiKey, databa
     if (typeof port !== 'undefined') {
         payload['port'] = port;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const migrationsGet = async ({ migrationId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} migrationId */
+/**
+ * @typedef {Object} MigrationsGetRequestParams
+ * @property {string} migrationId Migration unique ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {MigrationsGetRequestParams} params
+ */
+const migrationsGet = async ({ migrationId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const migrationsRetry = async ({ migrationId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} migrationId */
+/**
+ * @typedef {Object} MigrationsRetryRequestParams
+ * @property {string} migrationId Migration unique ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {MigrationsRetryRequestParams} params
+ */
+const migrationsRetry = async ({ migrationId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const migrationsDelete = async ({ migrationId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} migrationId */
+/**
+ * @typedef {Object} MigrationsDeleteRequestParams
+ * @property {string} migrationId Migration ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {MigrationsDeleteRequestParams} params
+ */
+const migrationsDelete = async ({ migrationId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-
 migrations
     .command(`list`)
     .description(``)
@@ -686,7 +818,6 @@ migrations
     .requiredOption(`--migrationId <migrationId>`, `Migration ID.`)
     .action(actionRunner(migrationsDelete))
 
-
 module.exports = {
     migrations,
     migrationsList,
@@ -705,4 +836,4 @@ module.exports = {
     migrationsGet,
     migrationsRetry,
     migrationsDelete
-};
+};