appwrite-cli 6.2.2 → 7.0.0

package/lib/commands/generic.js

@@ -121,7 +121,7 @@ const whoami = new Command("whoami")
                 sdk: client,
                 parseOutput: false
             });
-        } catch (error) {
+        } catch (_) {
             error("No user is signed in. To sign in, run 'appwrite login'");
             return;
         }

package/lib/commands/health.js

@@ -58,7 +58,6 @@ const healthGet = async ({parseOutput = true, overrideForCli = false, sdk = unde
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -88,7 +87,6 @@ const healthGetAntivirus = async ({parseOutput = true, overrideForCli = false, s
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -118,7 +116,6 @@ const healthGetCache = async ({parseOutput = true, overrideForCli = false, sdk =
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -152,7 +149,6 @@ const healthGetCertificate = async ({domain,parseOutput = true, overrideForCli =
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -182,7 +178,6 @@ const healthGetDB = async ({parseOutput = true, overrideForCli = false, sdk = un
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -212,37 +207,6 @@ const healthGetPubSub = async ({parseOutput = true, overrideForCli = false, sdk
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
-    }, payload);
-
-    if (parseOutput) {
-        parse(response)
-    }
-
-    return response;
-
-}
-
-/**
- * @typedef {Object} HealthGetQueueRequestParams
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {HealthGetQueueRequestParams} params
- */
-const healthGetQueue = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() :
-    sdk;
-    let apiPath = '/health/queue';
-    let payload = {};
-
-    let response = undefined;
-
-    response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -276,7 +240,6 @@ const healthGetQueueBuilds = async ({threshold,parseOutput = true, overrideForCl
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -310,7 +273,6 @@ const healthGetQueueCertificates = async ({threshold,parseOutput = true, overrid
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -348,7 +310,6 @@ const healthGetQueueDatabases = async ({name,threshold,parseOutput = true, overr
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -382,7 +343,6 @@ const healthGetQueueDeletes = async ({threshold,parseOutput = true, overrideForC
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -417,7 +377,6 @@ const healthGetFailedJobs = async ({name,threshold,parseOutput = true, overrideF
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -451,7 +410,6 @@ const healthGetQueueFunctions = async ({threshold,parseOutput = true, overrideFo
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -485,7 +443,6 @@ const healthGetQueueLogs = async ({threshold,parseOutput = true, overrideForCli
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -519,7 +476,6 @@ const healthGetQueueMails = async ({threshold,parseOutput = true, overrideForCli
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -553,7 +509,6 @@ const healthGetQueueMessaging = async ({threshold,parseOutput = true, overrideFo
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -587,7 +542,6 @@ const healthGetQueueMigrations = async ({threshold,parseOutput = true, overrideF
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -599,7 +553,7 @@ const healthGetQueueMigrations = async ({threshold,parseOutput = true, overrideF
 }
 
 /**
- * @typedef {Object} HealthGetQueueUsageRequestParams
+ * @typedef {Object} HealthGetQueueStatsResourcesRequestParams
  * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
@@ -607,12 +561,12 @@ const healthGetQueueMigrations = async ({threshold,parseOutput = true, overrideF
  */
 
 /**
- * @param {HealthGetQueueUsageRequestParams} params
+ * @param {HealthGetQueueStatsResourcesRequestParams} params
  */
-const healthGetQueueUsage = async ({threshold,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+const healthGetQueueStatsResources = async ({threshold,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() :
     sdk;
-    let apiPath = '/health/queue/usage';
+    let apiPath = '/health/queue/stats-resources';
     let payload = {};
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
@@ -621,7 +575,6 @@ const healthGetQueueUsage = async ({threshold,parseOutput = true, overrideForCli
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -633,7 +586,7 @@ const healthGetQueueUsage = async ({threshold,parseOutput = true, overrideForCli
 }
 
 /**
- * @typedef {Object} HealthGetQueueUsageDumpRequestParams
+ * @typedef {Object} HealthGetQueueUsageRequestParams
  * @property {number} threshold Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
@@ -641,12 +594,12 @@ const healthGetQueueUsage = async ({threshold,parseOutput = true, overrideForCli
  */
 
 /**
- * @param {HealthGetQueueUsageDumpRequestParams} params
+ * @param {HealthGetQueueUsageRequestParams} params
  */
-const healthGetQueueUsageDump = async ({threshold,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+const healthGetQueueUsage = async ({threshold,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() :
     sdk;
-    let apiPath = '/health/queue/usage-dump';
+    let apiPath = '/health/queue/stats-usage';
     let payload = {};
     if (typeof threshold !== 'undefined') {
         payload['threshold'] = threshold;
@@ -655,7 +608,6 @@ const healthGetQueueUsageDump = async ({threshold,parseOutput = true, overrideFo
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -689,7 +641,6 @@ const healthGetQueueWebhooks = async ({threshold,parseOutput = true, overrideFor
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -719,7 +670,6 @@ const healthGetStorage = async ({parseOutput = true, overrideForCli = false, sdk
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -749,7 +699,6 @@ const healthGetStorageLocal = async ({parseOutput = true, overrideForCli = false
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -779,7 +728,6 @@ const healthGetTime = async ({parseOutput = true, overrideForCli = false, sdk =
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -821,11 +769,6 @@ health
     .description(`Check the Appwrite pub-sub servers are up and connection is successful.`)
     .action(actionRunner(healthGetPubSub))
 
-health
-    .command(`get-queue`)
-    .description(`Check the Appwrite queue messaging servers are up and connection is successful.`)
-    .action(actionRunner(healthGetQueue))
-
 health
     .command(`get-queue-builds`)
     .description(`Get the number of builds that are waiting to be processed in the Appwrite internal queue server.`)
@@ -889,16 +832,16 @@ health
     .action(actionRunner(healthGetQueueMigrations))
 
 health
-    .command(`get-queue-usage`)
-    .description(`Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.`)
+    .command(`get-queue-stats-resources`)
+    .description(`Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.`)
     .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
-    .action(actionRunner(healthGetQueueUsage))
+    .action(actionRunner(healthGetQueueStatsResources))
 
 health
-    .command(`get-queue-usage-dump`)
-    .description(`Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.`)
+    .command(`get-queue-usage`)
+    .description(`Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.`)
     .option(`--threshold <threshold>`, `Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.`, parseInteger)
-    .action(actionRunner(healthGetQueueUsageDump))
+    .action(actionRunner(healthGetQueueUsage))
 
 health
     .command(`get-queue-webhooks`)
@@ -929,7 +872,6 @@ module.exports = {
     healthGetCertificate,
     healthGetDB,
     healthGetPubSub,
-    healthGetQueue,
     healthGetQueueBuilds,
     healthGetQueueCertificates,
     healthGetQueueDatabases,
@@ -940,8 +882,8 @@ module.exports = {
     healthGetQueueMails,
     healthGetQueueMessaging,
     healthGetQueueMigrations,
+    healthGetQueueStatsResources,
     healthGetQueueUsage,
-    healthGetQueueUsageDump,
     healthGetQueueWebhooks,
     healthGetStorage,
     healthGetStorageLocal,

package/lib/commands/init.js

@@ -15,6 +15,7 @@ const { localConfig, globalConfig } = require("../config");
 const {
     questionsCreateFunction,
     questionsCreateFunctionSelectTemplate,
+    questionsCreateSite,
     questionsCreateBucket,
     questionsCreateMessagingTopic,
     questionsCreateCollection,
@@ -25,11 +26,13 @@ const {
 } = require("../questions");
 const { cliConfig, success, log, hint, error, actionRunner, commandDescriptions } = require("../parser");
 const { accountGet } = require("./account");
+const { sitesListTemplates } = require("./sites");
 const { sdkForConsole } = require("../sdks");
 
 const initResources = async () => {
     const actions = {
         function: initFunction,
+        site: initSite,
         collection: initCollection,
         bucket: initBucket,
         team: initTeam,
@@ -318,6 +321,188 @@ const initFunction = async () => {
     log("Next you can use 'appwrite run function' to develop a function locally. To deploy the function, use 'appwrite push function'");
 }
 
+const initSite = async () => {
+    process.chdir(localConfig.configDirectoryPath)
+
+    const answers = await inquirer.prompt(questionsCreateSite);
+    const siteFolder = path.join(process.cwd(), 'sites');
+
+    if (!fs.existsSync(siteFolder)) {
+        fs.mkdirSync(siteFolder, {
+            recursive: true
+        });
+    }
+
+    const siteId = answers.id === 'unique()' ? ID.unique() : answers.id;
+    const siteName = answers.name;
+    const siteDir = path.join(siteFolder, siteName);
+    const templatesDir = path.join(siteFolder, `${siteId}-templates`);
+
+    if (fs.existsSync(siteDir)) {
+        throw new Error(`( ${siteName} ) already exists in the current directory. Please choose another name.`);
+    }
+
+    let templateDetails;
+    try {
+        const response = await sitesListTemplates({
+            frameworks: [answers.framework.key],
+            useCases: ['starter'],
+            limit: 1,
+            parseOutput: false
+        });
+        if (response.total == 0) {
+            throw new Error(`No starter template found for framework ${answers.framework.key}`);
+        }
+        templateDetails = response.templates[0];
+    } catch (error) {
+        throw new Error(`Failed to fetch template for framework ${answers.framework.key}: ${error.message}`);
+    }
+
+    fs.mkdirSync(siteDir, "777");
+    fs.mkdirSync(templatesDir, "777");
+    const repo = `https://github.com/${templateDetails.providerOwner}/${templateDetails.providerRepositoryId}`;
+    let selected = { template: templateDetails.frameworks[0].providerRootDirectory };
+
+    let gitCloneCommands = '';
+
+    const sparse = selected.template.startsWith('./') ? selected.template.substring(2) : selected.template;
+
+    log('Fetching site code ...');
+
+    if(selected.template === './') {
+        gitCloneCommands = `
+            mkdir -p .
+            cd .
+            git init
+            git remote add origin ${repo}
+            git config --global init.defaultBranch main
+            git fetch --depth=1 origin refs/tags/$(git ls-remote --tags origin "${templateDetails.providerVersion}" | tail -n 1 | awk -F '/' '{print $3}')
+            git checkout FETCH_HEAD
+        `.trim();
+    } else {
+        gitCloneCommands = `
+            mkdir -p .
+            cd .
+            git init
+            git remote add origin ${repo}
+            git config --global init.defaultBranch main
+            git config core.sparseCheckout true
+            echo "${sparse}" >> .git/info/sparse-checkout
+            git config --add remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
+            git config remote.origin.tagopt --no-tags
+            git fetch --depth=1 origin refs/tags/$(git ls-remote --tags origin "${templateDetails.providerVersion}" | tail -n 1 | awk -F '/' '{print $3}')
+            git checkout FETCH_HEAD
+        `.trim();
+    }
+
+    /* Force use CMD as powershell does not support && */
+    if (process.platform === 'win32') {
+        gitCloneCommands = 'cmd /c "' + gitCloneCommands + '"';
+    }
+
+    /*  Execute the child process but do not print any std output */
+    try {
+        childProcess.execSync(gitCloneCommands, { stdio: 'pipe', cwd: templatesDir });
+    } catch (error) {
+        /* Specialised errors with recommended actions to take */
+        if (error.message.includes('error: unknown option')) {
+            throw new Error(`${error.message} \n\nSuggestion: Try updating your git to the latest version, then trying to run this command again.`)
+        } else if (error.message.includes('is not recognized as an internal or external command,') || error.message.includes('command not found')) {
+            throw new Error(`${error.message} \n\nSuggestion: It appears that git is not installed, try installing git then trying to run this command again.`)
+        } else {
+            throw error;
+        }
+    }
+
+    fs.rmSync(path.join(templatesDir, ".git"), { recursive: true });
+
+    const copyRecursiveSync = (src, dest) => {
+        let exists = fs.existsSync(src);
+        let stats = exists && fs.statSync(src);
+        let isDirectory = exists && stats.isDirectory();
+        if (isDirectory) {
+            if (!fs.existsSync(dest)) {
+                fs.mkdirSync(dest);
+            }
+
+            fs.readdirSync(src).forEach(function (childItemName) {
+                copyRecursiveSync(path.join(src, childItemName), path.join(dest, childItemName));
+            });
+        } else {
+            fs.copyFileSync(src, dest);
+        }
+    };
+    copyRecursiveSync(selected.template === './' ? templatesDir : path.join(templatesDir, selected.template), siteDir);
+
+    fs.rmSync(templatesDir, { recursive: true, force: true });
+
+    const readmePath = path.join(process.cwd(), 'sites', siteName, 'README.md');
+    const readmeFile = fs.readFileSync(readmePath).toString();
+    const newReadmeFile = readmeFile.split('\n');
+    newReadmeFile[0] = `# ${answers.key}`;
+    newReadmeFile.splice(1, 2);
+    fs.writeFileSync(readmePath, newReadmeFile.join('\n'));
+
+    let vars = (templateDetails.variables ?? []).map(variable => {
+        let value = variable.value;
+        const replacements = {
+            '{apiEndpoint}': globalConfig.getEndpoint(),
+            '{projectId}': localConfig.getProject().projectId,
+            '{projectName}': localConfig.getProject().projectName,
+        };
+
+        for (const placeholder in replacements) {
+            if (value?.includes(placeholder)) {
+                value = value.replace(placeholder, replacements[placeholder]);
+            }
+        }
+
+        return {
+            key: variable.name,
+            value: value
+        };
+    });
+    
+    let data = {
+        $id: siteId,
+        name: answers.name,
+        framework: answers.framework.key,
+        adapter: templateDetails.frameworks[0].adapter || '',
+        buildRuntime: templateDetails.frameworks[0].buildRuntime || '',
+        installCommand: templateDetails.frameworks[0].installCommand || '',
+        buildCommand: templateDetails.frameworks[0].buildCommand || '',
+        outputDirectory: templateDetails.frameworks[0].outputDirectory || '',
+        fallbackFile: templateDetails.frameworks[0].fallbackFile || '',
+        specification: answers.specification,
+        enabled: true,
+        timeout: 30,
+        logging: true,
+        ignore: answers.framework.ignore || null,
+        path: `sites/${siteName}`,
+        vars: vars
+    };
+
+    if (!data.buildRuntime) {
+        log(`Build runtime for this framework not found. You will be asked to configure build runtime when you first push the site.`);
+    }
+
+    if (!data.installCommand) {
+        log(`Installation command for this framework not found. You will be asked to configure the install command when you first push the site.`);
+    }
+
+    if (!data.buildCommand) {
+        log(`Build command for this framework not found. You will be asked to configure the build command when you first push the site.`);
+    }
+
+    if (!data.outputDirectory) {
+        log(`Output directory for this framework not found. You will be asked to configure the output directory when you first push the site.`);
+    }
+
+    localConfig.addSite(data);
+    success("Initializing site");
+    log("Next you can use 'appwrite push site' to deploy the changes.");
+};
+
 const init = new Command("init")
     .description(commandDescriptions['init'])
     .action(actionRunner(initResources));
@@ -336,6 +521,12 @@ init
     .description("Init a new Appwrite function")
     .action(actionRunner(initFunction));
 
+init
+    .command("site")
+    .alias("sites")
+    .description("Init a new Appwrite site")
+    .action(actionRunner(initSite));
+
 init
     .command("bucket")
     .alias("buckets")

package/lib/commands/locale.js

@@ -58,7 +58,6 @@ const localeGet = async ({parseOutput = true, overrideForCli = false, sdk = unde
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -88,7 +87,6 @@ const localeListCodes = async ({parseOutput = true, overrideForCli = false, sdk
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -118,7 +116,6 @@ const localeListContinents = async ({parseOutput = true, overrideForCli = false,
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -148,7 +145,6 @@ const localeListCountries = async ({parseOutput = true, overrideForCli = false,
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -178,7 +174,6 @@ const localeListCountriesEU = async ({parseOutput = true, overrideForCli = false
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -208,7 +203,6 @@ const localeListCountriesPhones = async ({parseOutput = true, overrideForCli = f
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -238,7 +232,6 @@ const localeListCurrencies = async ({parseOutput = true, overrideForCli = false,
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -268,7 +261,6 @@ const localeListLanguages = async ({parseOutput = true, overrideForCli = false,
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {